Libav
libxvid.c
Go to the documentation of this file.
1 /*
2  * Interface to xvidcore for MPEG-4 encoding
3  * Copyright (c) 2004 Adam Thayer <krevnik@comcast.net>
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
28 #include <stdio.h>
29 #include <string.h>
30 #include <unistd.h>
31 #include <xvid.h>
32 
33 #include "libavutil/cpu.h"
34 #include "libavutil/internal.h"
35 #include "libavutil/intreadwrite.h"
36 #include "libavutil/mathematics.h"
37 #include "libavutil/mem.h"
38 #include "libavutil/opt.h"
39 
40 #include "avcodec.h"
41 #include "internal.h"
42 #include "libxvid.h"
43 #include "mpegutils.h"
44 
48 #define BUFFER_SIZE 1024
49 #define BUFFER_REMAINING(x) (BUFFER_SIZE - strlen(x))
50 #define BUFFER_CAT(x) (&((x)[strlen(x)]))
51 
56 struct xvid_context {
57  AVClass *class;
59  int xsize;
60  int ysize;
61  int vop_flags;
62  int vol_flags;
63  int me_flags;
64  int qscale;
66  char *twopassbuffer;
68  char *twopassfile;
69  unsigned char *intra_matrix;
70  unsigned char *inter_matrix;
71  int lumi_aq;
73  int ssim;
74  int ssim_acc;
75  int gmc;
76  int me_quality;
77  int mpeg_quant;
78 };
79 
83 struct xvid_ff_pass1 {
84  int version;
86 };
87 
88 static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
89  const AVFrame *picture, int *got_packet);
90 
91 
92 /*
93  * Xvid 2-Pass Kludge Section
94  *
95  * Xvid's default 2-pass doesn't allow us to create data as we need to, so
96  * this section spends time replacing the first pass plugin so we can write
97  * statistic information as libavcodec requests in. We have another kludge
98  * that allows us to pass data to the second pass in Xvid without a custom
99  * rate-control plugin.
100  */
101 
109 static int xvid_ff_2pass_create(xvid_plg_create_t *param, void **handle)
110 {
111  struct xvid_ff_pass1 *x = (struct xvid_ff_pass1 *) param->param;
112  char *log = x->context->twopassbuffer;
113 
114  /* Do a quick bounds check */
115  if (!log)
116  return XVID_ERR_FAIL;
117 
118  /* We use snprintf() */
119  /* This is because we can safely prevent a buffer overflow */
120  log[0] = 0;
121  snprintf(log, BUFFER_REMAINING(log),
122  "# avconv 2-pass log file, using xvid codec\n");
123  snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
124  "# Do not modify. libxvidcore version: %d.%d.%d\n\n",
125  XVID_VERSION_MAJOR(XVID_VERSION),
126  XVID_VERSION_MINOR(XVID_VERSION),
127  XVID_VERSION_PATCH(XVID_VERSION));
128 
129  *handle = x->context;
130  return 0;
131 }
132 
140 static int xvid_ff_2pass_destroy(struct xvid_context *ref,
141  xvid_plg_destroy_t *param)
142 {
143  /* Currently cannot think of anything to do on destruction */
144  /* Still, the framework should be here for reference/use */
145  if (ref->twopassbuffer)
146  ref->twopassbuffer[0] = 0;
147  return 0;
148 }
149 
157 static int xvid_ff_2pass_before(struct xvid_context *ref,
158  xvid_plg_data_t *param)
159 {
160  int motion_remove;
161  int motion_replacements;
162  int vop_remove;
163 
164  /* Nothing to do here, result is changed too much */
165  if (param->zone && param->zone->mode == XVID_ZONE_QUANT)
166  return 0;
167 
168  /* We can implement a 'turbo' first pass mode here */
169  param->quant = 2;
170 
171  /* Init values */
172  motion_remove = ~XVID_ME_CHROMA_PVOP &
173  ~XVID_ME_CHROMA_BVOP &
174  ~XVID_ME_EXTSEARCH16 &
175  ~XVID_ME_ADVANCEDDIAMOND16;
176  motion_replacements = XVID_ME_FAST_MODEINTERPOLATE |
177  XVID_ME_SKIP_DELTASEARCH |
178  XVID_ME_FASTREFINE16 |
179  XVID_ME_BFRAME_EARLYSTOP;
180  vop_remove = ~XVID_VOP_MODEDECISION_RD &
181  ~XVID_VOP_FAST_MODEDECISION_RD &
182  ~XVID_VOP_TRELLISQUANT &
183  ~XVID_VOP_INTER4V &
184  ~XVID_VOP_HQACPRED;
185 
186  param->vol_flags &= ~XVID_VOL_GMC;
187  param->vop_flags &= vop_remove;
188  param->motion_flags &= motion_remove;
189  param->motion_flags |= motion_replacements;
190 
191  return 0;
192 }
193 
201 static int xvid_ff_2pass_after(struct xvid_context *ref,
202  xvid_plg_data_t *param)
203 {
204  char *log = ref->twopassbuffer;
205  const char *frame_types = " ipbs";
206  char frame_type;
207 
208  /* Quick bounds check */
209  if (!log)
210  return XVID_ERR_FAIL;
211 
212  /* Convert the type given to us into a character */
213  if (param->type < 5 && param->type > 0)
214  frame_type = frame_types[param->type];
215  else
216  return XVID_ERR_FAIL;
217 
218  snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
219  "%c %d %d %d %d %d %d\n",
220  frame_type, param->stats.quant, param->stats.kblks,
221  param->stats.mblks, param->stats.ublks,
222  param->stats.length, param->stats.hlength);
223 
224  return 0;
225 }
226 
238 static int xvid_ff_2pass(void *ref, int cmd, void *p1, void *p2)
239 {
240  switch (cmd) {
241  case XVID_PLG_INFO:
242  case XVID_PLG_FRAME:
243  return 0;
244  case XVID_PLG_BEFORE:
245  return xvid_ff_2pass_before(ref, p1);
246  case XVID_PLG_CREATE:
247  return xvid_ff_2pass_create(p1, p2);
248  case XVID_PLG_AFTER:
249  return xvid_ff_2pass_after(ref, p1);
250  case XVID_PLG_DESTROY:
251  return xvid_ff_2pass_destroy(ref, p1);
252  default:
253  return XVID_ERR_FAIL;
254  }
255 }
256 
271  unsigned int header_len,
272  unsigned int frame_len)
273 {
274  int vo_len = 0, i;
275 
276  for (i = 0; i < header_len - 3; i++) {
277  if (pkt->data[i] == 0x00 &&
278  pkt->data[i + 1] == 0x00 &&
279  pkt->data[i + 2] == 0x01 &&
280  pkt->data[i + 3] == 0xB6) {
281  vo_len = i;
282  break;
283  }
284  }
285 
286  if (vo_len > 0) {
287  /* We need to store the header, so extract it */
288  if (!avctx->extradata) {
289  avctx->extradata = av_malloc(vo_len);
290  if (!avctx->extradata)
291  return AVERROR(ENOMEM);
292  memcpy(avctx->extradata, pkt->data, vo_len);
293  avctx->extradata_size = vo_len;
294  }
295  /* Less dangerous now, memmove properly copies the two
296  * chunks of overlapping data */
297  memmove(pkt->data, &pkt->data[vo_len], frame_len - vo_len);
298  pkt->size = frame_len - vo_len;
299  }
300  return 0;
301 }
302 
313 {
314  int frate, fbase;
315  int est_frate, est_fbase;
316  int gcd;
317  float est_fps, fps;
318 
319  frate = avctx->time_base.den;
320  fbase = avctx->time_base.num;
321 
322  gcd = av_gcd(frate, fbase);
323  if (gcd > 1) {
324  frate /= gcd;
325  fbase /= gcd;
326  }
327 
328  if (frate <= 65000 && fbase <= 65000) {
329  avctx->time_base.den = frate;
330  avctx->time_base.num = fbase;
331  return;
332  }
333 
334  fps = (float) frate / (float) fbase;
335  est_fps = roundf(fps * 1000.0) / 1000.0;
336 
337  est_frate = (int) est_fps;
338  if (est_fps > (int) est_fps) {
339  est_frate = (est_frate + 1) * 1000;
340  est_fbase = (int) roundf((float) est_frate / est_fps);
341  } else
342  est_fbase = 1;
343 
344  gcd = av_gcd(est_frate, est_fbase);
345  if (gcd > 1) {
346  est_frate /= gcd;
347  est_fbase /= gcd;
348  }
349 
350  if (fbase > est_fbase) {
351  avctx->time_base.den = est_frate;
352  avctx->time_base.num = est_fbase;
353  av_log(avctx, AV_LOG_DEBUG,
354  "Xvid: framerate re-estimated: %.2f, %.3f%% correction\n",
355  est_fps, (((est_fps - fps) / fps) * 100.0));
356  } else {
357  avctx->time_base.den = frate;
358  avctx->time_base.num = fbase;
359  }
360 }
361 
363 {
364  int xerr, i;
365  int xvid_flags = avctx->flags;
366  struct xvid_context *x = avctx->priv_data;
367  uint16_t *intra, *inter;
368  int fd;
369 
370  xvid_plugin_single_t single = { 0 };
371  struct xvid_ff_pass1 rc2pass1 = { 0 };
372  xvid_plugin_2pass2_t rc2pass2 = { 0 };
373  xvid_plugin_lumimasking_t masking_l = { 0 }; /* For lumi masking */
374  xvid_plugin_lumimasking_t masking_v = { 0 }; /* For variance AQ */
375  xvid_plugin_ssim_t ssim = { 0 };
376  xvid_gbl_init_t xvid_gbl_init = { 0 };
377  xvid_enc_create_t xvid_enc_create = { 0 };
378  xvid_enc_plugin_t plugins[7];
379 
380  /* Bring in VOP flags from avconv command-line */
381  x->vop_flags = XVID_VOP_HALFPEL; /* Bare minimum quality */
382  if (xvid_flags & AV_CODEC_FLAG_4MV)
383  x->vop_flags |= XVID_VOP_INTER4V; /* Level 3 */
384  if (avctx->trellis)
385  x->vop_flags |= XVID_VOP_TRELLISQUANT; /* Level 5 */
386  if (xvid_flags & AV_CODEC_FLAG_AC_PRED)
387  x->vop_flags |= XVID_VOP_HQACPRED; /* Level 6 */
388  if (xvid_flags & AV_CODEC_FLAG_GRAY)
389  x->vop_flags |= XVID_VOP_GREYSCALE;
390 
391  /* Decide which ME quality setting to use */
392  x->me_flags = 0;
393  switch (x->me_quality) {
394  case 6:
395  case 5:
396  x->me_flags |= XVID_ME_EXTSEARCH16 |
397  XVID_ME_EXTSEARCH8;
398  case 4:
399  case 3:
400  x->me_flags |= XVID_ME_ADVANCEDDIAMOND8 |
401  XVID_ME_HALFPELREFINE8 |
402  XVID_ME_CHROMA_PVOP |
403  XVID_ME_CHROMA_BVOP;
404  case 2:
405  case 1:
406  x->me_flags |= XVID_ME_ADVANCEDDIAMOND16 |
407  XVID_ME_HALFPELREFINE16;
408 #if FF_API_MOTION_EST
410  break;
411  default:
412  switch (avctx->me_method) {
413  case ME_FULL: /* Quality 6 */
414  x->me_flags |= XVID_ME_EXTSEARCH16 |
415  XVID_ME_EXTSEARCH8;
416  case ME_EPZS: /* Quality 4 */
417  x->me_flags |= XVID_ME_ADVANCEDDIAMOND8 |
418  XVID_ME_HALFPELREFINE8 |
419  XVID_ME_CHROMA_PVOP |
420  XVID_ME_CHROMA_BVOP;
421  case ME_LOG: /* Quality 2 */
422  case ME_PHODS:
423  case ME_X1:
424  x->me_flags |= XVID_ME_ADVANCEDDIAMOND16 |
425  XVID_ME_HALFPELREFINE16;
426  case ME_ZERO: /* Quality 0 */
427  default:
428  break;
429  }
431 #endif
432  }
433 
434  /* Decide how we should decide blocks */
435  switch (avctx->mb_decision) {
436  case 2:
437  x->vop_flags |= XVID_VOP_MODEDECISION_RD;
438  x->me_flags |= XVID_ME_HALFPELREFINE8_RD |
439  XVID_ME_QUARTERPELREFINE8_RD |
440  XVID_ME_EXTSEARCH_RD |
441  XVID_ME_CHECKPREDICTION_RD;
442  case 1:
443  if (!(x->vop_flags & XVID_VOP_MODEDECISION_RD))
444  x->vop_flags |= XVID_VOP_FAST_MODEDECISION_RD;
445  x->me_flags |= XVID_ME_HALFPELREFINE16_RD |
446  XVID_ME_QUARTERPELREFINE16_RD;
447  default:
448  break;
449  }
450 
451  /* Bring in VOL flags from avconv command-line */
452 #if FF_API_GMC
453  if (avctx->flags & CODEC_FLAG_GMC)
454  x->gmc = 1;
455 #endif
456 
457  x->vol_flags = 0;
458  if (x->gmc) {
459  x->vol_flags |= XVID_VOL_GMC;
460  x->me_flags |= XVID_ME_GME_REFINE;
461  }
462  if (xvid_flags & AV_CODEC_FLAG_QPEL) {
463  x->vol_flags |= XVID_VOL_QUARTERPEL;
464  x->me_flags |= XVID_ME_QUARTERPELREFINE16;
465  if (x->vop_flags & XVID_VOP_INTER4V)
466  x->me_flags |= XVID_ME_QUARTERPELREFINE8;
467  }
468 
469  xvid_gbl_init.version = XVID_VERSION;
470  xvid_gbl_init.debug = 0;
471  xvid_gbl_init.cpu_flags = 0;
472 
473  /* Initialize */
474  xvid_global(NULL, XVID_GBL_INIT, &xvid_gbl_init, NULL);
475 
476  /* Create the encoder reference */
477  xvid_enc_create.version = XVID_VERSION;
478 
479  /* Store the desired frame size */
480  xvid_enc_create.width =
481  x->xsize = avctx->width;
482  xvid_enc_create.height =
483  x->ysize = avctx->height;
484 
485  /* Xvid can determine the proper profile to use */
486  /* xvid_enc_create.profile = XVID_PROFILE_S_L3; */
487 
488  /* We don't use zones */
489  xvid_enc_create.zones = NULL;
490  xvid_enc_create.num_zones = 0;
491 
492  xvid_enc_create.num_threads = avctx->thread_count;
493 
494  xvid_enc_create.plugins = plugins;
495  xvid_enc_create.num_plugins = 0;
496 
497  /* Initialize Buffers */
498  x->twopassbuffer = NULL;
499  x->old_twopassbuffer = NULL;
500  x->twopassfile = NULL;
501 
502  if (xvid_flags & AV_CODEC_FLAG_PASS1) {
503  rc2pass1.version = XVID_VERSION;
504  rc2pass1.context = x;
507  if (!x->twopassbuffer || !x->old_twopassbuffer) {
508  av_log(avctx, AV_LOG_ERROR,
509  "Xvid: Cannot allocate 2-pass log buffers\n");
510  return AVERROR(ENOMEM);
511  }
512  x->twopassbuffer[0] =
513  x->old_twopassbuffer[0] = 0;
514 
515  plugins[xvid_enc_create.num_plugins].func = xvid_ff_2pass;
516  plugins[xvid_enc_create.num_plugins].param = &rc2pass1;
517  xvid_enc_create.num_plugins++;
518  } else if (xvid_flags & AV_CODEC_FLAG_PASS2) {
519  rc2pass2.version = XVID_VERSION;
520  rc2pass2.bitrate = avctx->bit_rate;
521 
522  fd = ff_tempfile("xvidff.", &x->twopassfile);
523  if (fd < 0) {
524  av_log(avctx, AV_LOG_ERROR, "Xvid: Cannot write 2-pass pipe\n");
525  return fd;
526  }
527 
528  if (!avctx->stats_in) {
529  av_log(avctx, AV_LOG_ERROR,
530  "Xvid: No 2-pass information loaded for second pass\n");
531  return AVERROR_INVALIDDATA;
532  }
533 
534  if (strlen(avctx->stats_in) >
535  write(fd, avctx->stats_in, strlen(avctx->stats_in))) {
536  close(fd);
537  av_log(avctx, AV_LOG_ERROR, "Xvid: Cannot write to 2-pass pipe\n");
538  return AVERROR(EIO);
539  }
540 
541  close(fd);
542  rc2pass2.filename = x->twopassfile;
543  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_2pass2;
544  plugins[xvid_enc_create.num_plugins].param = &rc2pass2;
545  xvid_enc_create.num_plugins++;
546  } else if (!(xvid_flags & AV_CODEC_FLAG_QSCALE)) {
547  /* Single Pass Bitrate Control! */
548  single.version = XVID_VERSION;
549  single.bitrate = avctx->bit_rate;
550 
551  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_single;
552  plugins[xvid_enc_create.num_plugins].param = &single;
553  xvid_enc_create.num_plugins++;
554  }
555 
556  if (avctx->lumi_masking != 0.0)
557  x->lumi_aq = 1;
558 
559  if (x->lumi_aq && x->variance_aq) {
560  x->variance_aq = 0;
561  av_log(avctx, AV_LOG_WARNING,
562  "variance_aq is ignored when lumi_aq is set.\n");
563  }
564 
565  /* Luminance Masking */
566  if (x->lumi_aq) {
567  masking_l.method = 0;
568  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
569 
570  /* The old behavior is that when avctx->lumi_masking is specified,
571  * plugins[...].param = NULL. Trying to keep the old behavior here. */
572  plugins[xvid_enc_create.num_plugins].param =
573  avctx->lumi_masking ? NULL : &masking_l;
574  xvid_enc_create.num_plugins++;
575  }
576 
577  /* Variance AQ */
578  if (x->variance_aq) {
579  masking_v.method = 1;
580  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
581  plugins[xvid_enc_create.num_plugins].param = &masking_v;
582  xvid_enc_create.num_plugins++;
583  }
584 
585  /* SSIM */
586  if (x->ssim) {
587  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_ssim;
588  ssim.b_printstat = x->ssim == 2;
589  ssim.acc = x->ssim_acc;
590  ssim.cpu_flags = xvid_gbl_init.cpu_flags;
591  ssim.b_visualize = 0;
592  plugins[xvid_enc_create.num_plugins].param = &ssim;
593  xvid_enc_create.num_plugins++;
594  }
595 
596  /* Frame Rate and Key Frames */
597  xvid_correct_framerate(avctx);
598  xvid_enc_create.fincr = avctx->time_base.num;
599  xvid_enc_create.fbase = avctx->time_base.den;
600  if (avctx->gop_size > 0)
601  xvid_enc_create.max_key_interval = avctx->gop_size;
602  else
603  xvid_enc_create.max_key_interval = 240; /* Xvid's best default */
604 
605  /* Quants */
606  if (xvid_flags & AV_CODEC_FLAG_QSCALE)
607  x->qscale = 1;
608  else
609  x->qscale = 0;
610 
611  xvid_enc_create.min_quant[0] = avctx->qmin;
612  xvid_enc_create.min_quant[1] = avctx->qmin;
613  xvid_enc_create.min_quant[2] = avctx->qmin;
614  xvid_enc_create.max_quant[0] = avctx->qmax;
615  xvid_enc_create.max_quant[1] = avctx->qmax;
616  xvid_enc_create.max_quant[2] = avctx->qmax;
617 
618  /* Quant Matrices */
619  x->intra_matrix =
620  x->inter_matrix = NULL;
621 
622 #if FF_API_PRIVATE_OPT
624  if (avctx->mpeg_quant)
625  x->mpeg_quant = avctx->mpeg_quant;
627 #endif
628 
629  if (x->mpeg_quant)
630  x->vol_flags |= XVID_VOL_MPEGQUANT;
631  if ((avctx->intra_matrix || avctx->inter_matrix)) {
632  x->vol_flags |= XVID_VOL_MPEGQUANT;
633 
634  if (avctx->intra_matrix) {
635  intra = avctx->intra_matrix;
636  x->intra_matrix = av_malloc(sizeof(unsigned char) * 64);
637  if (!x->intra_matrix)
638  return AVERROR(ENOMEM);
639  } else
640  intra = NULL;
641  if (avctx->inter_matrix) {
642  inter = avctx->inter_matrix;
643  x->inter_matrix = av_malloc(sizeof(unsigned char) * 64);
644  if (!x->inter_matrix)
645  return AVERROR(ENOMEM);
646  } else
647  inter = NULL;
648 
649  for (i = 0; i < 64; i++) {
650  if (intra)
651  x->intra_matrix[i] = (unsigned char) intra[i];
652  if (inter)
653  x->inter_matrix[i] = (unsigned char) inter[i];
654  }
655  }
656 
657  /* Misc Settings */
658  xvid_enc_create.frame_drop_ratio = 0;
659  xvid_enc_create.global = 0;
660  if (xvid_flags & AV_CODEC_FLAG_CLOSED_GOP)
661  xvid_enc_create.global |= XVID_GLOBAL_CLOSED_GOP;
662 
663  /* Determines which codec mode we are operating in */
664  avctx->extradata = NULL;
665  avctx->extradata_size = 0;
666  if (xvid_flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
667  /* In this case, we are claiming to be MPEG-4 */
668  x->quicktime_format = 1;
669  avctx->codec_id = AV_CODEC_ID_MPEG4;
670  } else {
671  /* We are claiming to be Xvid */
672  x->quicktime_format = 0;
673  if (!avctx->codec_tag)
674  avctx->codec_tag = AV_RL32("xvid");
675  }
676 
677  /* Bframes */
678  xvid_enc_create.max_bframes = avctx->max_b_frames;
679  xvid_enc_create.bquant_offset = 100 * avctx->b_quant_offset;
680  xvid_enc_create.bquant_ratio = 100 * avctx->b_quant_factor;
681  if (avctx->max_b_frames > 0 && !x->quicktime_format)
682  xvid_enc_create.global |= XVID_GLOBAL_PACKED;
683 
684  /* Encode a dummy frame to get the extradata immediately */
685  if (x->quicktime_format) {
686  AVFrame *picture;
687  AVPacket packet;
688  int got_packet, ret;
689 
690  av_init_packet(&packet);
691 
692  picture = av_frame_alloc();
693  if (!picture)
694  return AVERROR(ENOMEM);
695 
696  xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
697  if (xerr) {
698  av_frame_free(&picture);
699  av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
700  return AVERROR_UNKNOWN;
701  }
702  x->encoder_handle = xvid_enc_create.handle;
703 
704  picture->width = avctx->width;
705  picture->height = avctx->height;
706  picture->format = avctx->pix_fmt;
707 
708  if ((ret = av_frame_get_buffer(picture, 32)) < 0) {
709  xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
710  av_frame_free(&picture);
711  return ret;
712  }
713 
714  ret = xvid_encode_frame(avctx, &packet, picture, &got_packet);
715  if (!ret && got_packet)
716  av_packet_unref(&packet);
717  av_frame_free(&picture);
718  xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
719  }
720 
721  /* Create encoder context */
722  xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
723  if (xerr) {
724  av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
725  return -1;
726  }
727 
728  x->encoder_handle = xvid_enc_create.handle;
729 
730  return 0;
731 }
732 
733 static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
734  const AVFrame *picture, int *got_packet)
735 {
736  int xerr, i, ret, user_packet = !!pkt->data;
737  struct xvid_context *x = avctx->priv_data;
738  int mb_width = (avctx->width + 15) / 16;
739  int mb_height = (avctx->height + 15) / 16;
740  char *tmp;
741 
742  xvid_enc_frame_t xvid_enc_frame = { 0 };
743  xvid_enc_stats_t xvid_enc_stats = { 0 };
744 
745  if (!user_packet &&
746  (ret = av_new_packet(pkt, mb_width * mb_height * MAX_MB_BYTES + AV_INPUT_BUFFER_MIN_SIZE)) < 0) {
747  av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
748  return ret;
749  }
750 
751  /* Start setting up the frame */
752  xvid_enc_frame.version = XVID_VERSION;
753  xvid_enc_stats.version = XVID_VERSION;
754 
755  /* Let Xvid know where to put the frame. */
756  xvid_enc_frame.bitstream = pkt->data;
757  xvid_enc_frame.length = pkt->size;
758 
759  /* Initialize input image fields */
760  if (avctx->pix_fmt != AV_PIX_FMT_YUV420P) {
761  av_log(avctx, AV_LOG_ERROR,
762  "Xvid: Color spaces other than 420P not supported\n");
763  return -1;
764  }
765 
766  xvid_enc_frame.input.csp = XVID_CSP_PLANAR; /* YUV420P */
767 
768  for (i = 0; i < 4; i++) {
769  xvid_enc_frame.input.plane[i] = picture->data[i];
770  xvid_enc_frame.input.stride[i] = picture->linesize[i];
771  }
772 
773  /* Encoder Flags */
774  xvid_enc_frame.vop_flags = x->vop_flags;
775  xvid_enc_frame.vol_flags = x->vol_flags;
776  xvid_enc_frame.motion = x->me_flags;
777  xvid_enc_frame.type =
778  picture->pict_type == AV_PICTURE_TYPE_I ? XVID_TYPE_IVOP :
779  picture->pict_type == AV_PICTURE_TYPE_P ? XVID_TYPE_PVOP :
780  picture->pict_type == AV_PICTURE_TYPE_B ? XVID_TYPE_BVOP :
781  XVID_TYPE_AUTO;
782 
783  /* Pixel aspect ratio setting */
784  if (avctx->sample_aspect_ratio.num < 1 || avctx->sample_aspect_ratio.num > 255 ||
785  avctx->sample_aspect_ratio.den < 1 || avctx->sample_aspect_ratio.den > 255) {
786  av_log(avctx, AV_LOG_ERROR, "Invalid pixel aspect ratio %i/%i\n",
788  return -1;
789  }
790  xvid_enc_frame.par = XVID_PAR_EXT;
791  xvid_enc_frame.par_width = avctx->sample_aspect_ratio.num;
792  xvid_enc_frame.par_height = avctx->sample_aspect_ratio.den;
793 
794  /* Quant Setting */
795  if (x->qscale)
796  xvid_enc_frame.quant = picture->quality / FF_QP2LAMBDA;
797  else
798  xvid_enc_frame.quant = 0;
799 
800  /* Matrices */
801  xvid_enc_frame.quant_intra_matrix = x->intra_matrix;
802  xvid_enc_frame.quant_inter_matrix = x->inter_matrix;
803 
804  /* Encode */
805  xerr = xvid_encore(x->encoder_handle, XVID_ENC_ENCODE,
806  &xvid_enc_frame, &xvid_enc_stats);
807 
808  /* Two-pass log buffer swapping */
809  avctx->stats_out = NULL;
810  if (x->twopassbuffer) {
811  tmp = x->old_twopassbuffer;
813  x->twopassbuffer = tmp;
814  x->twopassbuffer[0] = 0;
815  if (x->old_twopassbuffer[0] != 0) {
816  avctx->stats_out = x->old_twopassbuffer;
817  }
818  }
819 
820  if (xerr > 0) {
822  sizeof(int));
823  if (!sd)
824  return AVERROR(ENOMEM);
825  *(int *)sd = xvid_enc_stats.quant * FF_QP2LAMBDA;
826 
827  *got_packet = 1;
828 
831  avctx->coded_frame->quality = xvid_enc_stats.quant * FF_QP2LAMBDA;
832  if (xvid_enc_stats.type == XVID_TYPE_PVOP)
834  else if (xvid_enc_stats.type == XVID_TYPE_BVOP)
836  else if (xvid_enc_stats.type == XVID_TYPE_SVOP)
838  else
841 #endif
842  if (xvid_enc_frame.out_flags & XVID_KEYFRAME) {
843 #if FF_API_CODED_FRAME
845  avctx->coded_frame->key_frame = 1;
847 #endif
848  pkt->flags |= AV_PKT_FLAG_KEY;
849  if (x->quicktime_format)
850  return xvid_strip_vol_header(avctx, pkt,
851  xvid_enc_stats.hlength, xerr);
852  } else {
853 #if FF_API_CODED_FRAME
855  avctx->coded_frame->key_frame = 0;
857 #endif
858  }
859 
860  pkt->size = xerr;
861 
862  return 0;
863  } else {
864  if (!user_packet)
865  av_packet_unref(pkt);
866  if (!xerr)
867  return 0;
868  av_log(avctx, AV_LOG_ERROR,
869  "Xvid: Encoding Error Occurred: %i\n", xerr);
870  return xerr;
871  }
872 }
873 
875 {
876  struct xvid_context *x = avctx->priv_data;
877 
878  if (x->encoder_handle) {
879  xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
880  x->encoder_handle = NULL;
881  }
882 
883  av_freep(&avctx->extradata);
884  if (x->twopassbuffer) {
887  }
888  av_free(x->twopassfile);
889  av_free(x->intra_matrix);
890  av_free(x->inter_matrix);
891 
892  return 0;
893 }
894 
895 #define OFFSET(x) offsetof(struct xvid_context, x)
896 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
897 static const AVOption options[] = {
898  { "lumi_aq", "Luminance masking AQ", OFFSET(lumi_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
899  { "variance_aq", "Variance AQ", OFFSET(variance_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
900  { "ssim", "Show SSIM information to stdout", OFFSET(ssim), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 2, VE, "ssim" },
901  { "off", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, INT_MIN, INT_MAX, VE, "ssim" },
902  { "avg", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, INT_MIN, INT_MAX, VE, "ssim" },
903  { "frame", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 2 }, INT_MIN, INT_MAX, VE, "ssim" },
904  { "ssim_acc", "SSIM accuracy", OFFSET(ssim_acc), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, 4, VE },
905  { "gmc", "use GMC", OFFSET(gmc), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
906  { "me_quality", "Motion estimation quality", OFFSET(me_quality), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 6, VE },
907  { "mpeg_quant", "Use MPEG quantizers instead of H.263", OFFSET(mpeg_quant), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
908  { NULL },
909 };
910 
911 static const AVClass xvid_class = {
912  .class_name = "libxvid",
913  .item_name = av_default_item_name,
914  .option = options,
915  .version = LIBAVUTIL_VERSION_INT,
916 };
917 
919  .name = "libxvid",
920  .long_name = NULL_IF_CONFIG_SMALL("libxvidcore MPEG-4 part 2"),
921  .type = AVMEDIA_TYPE_VIDEO,
922  .id = AV_CODEC_ID_MPEG4,
923  .priv_data_size = sizeof(struct xvid_context),
924  .init = xvid_encode_init,
925  .encode2 = xvid_encode_frame,
926  .close = xvid_encode_close,
927  .pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE },
928  .priv_class = &xvid_class,
929  .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
931 };
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: internal.h:48
void * av_malloc(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:62
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:54
S(GMC)-VOP MPEG-4.
Definition: avutil.h:263
This structure describes decoded (raw) audio or video data.
Definition: frame.h:140
AVOption.
Definition: opt.h:234
char * old_twopassbuffer
Old character buffer (two-pass)
Definition: libxvid.c:67
AVCodec ff_libxvid_encoder
Definition: libxvid.c:918
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:130
memory handling functions
int max_b_frames
maximum number of B-frames between non-B-frames Note: The output will be delayed by max_b_frames+1 re...
Definition: avcodec.h:1679
#define BUFFER_REMAINING(x)
Definition: libxvid.c:49
int num
numerator
Definition: rational.h:44
int size
Definition: avcodec.h:1347
av_log(ac->avr, AV_LOG_TRACE, "%d samples - audio_convert: %s to %s (%s)\, len, av_get_sample_fmt_name(ac->in_fmt), av_get_sample_fmt_name(ac->out_fmt), use_generic ? ac->func_descr_generic :ac->func_descr)
enhanced predictive zonal search
Definition: avcodec.h:670
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown) That is the width of a pixel divided by the height of the pixel...
Definition: avcodec.h:1804
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1621
#define FF_API_CODED_FRAME
Definition: version.h:159
char * stats_in
pass2 encoding statistics input buffer Concatenated stuff from stats_out of pass1 should be placed he...
Definition: avcodec.h:2564
unsigned char * intra_matrix
P-Frame Quant Matrix.
Definition: libxvid.c:69
int ysize
Frame y size.
Definition: libxvid.c:60
AVCodec.
Definition: avcodec.h:3120
int me_flags
Motion Estimation flags.
Definition: libxvid.c:63
attribute_deprecated int me_method
This option does nothing.
Definition: avcodec.h:1628
common functions for use with the Xvid wrappers
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:1535
void av_freep(void *arg)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc() and set the pointer ...
Definition: mem.c:202
int xsize
Frame x size.
Definition: libxvid.c:59
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:39
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: internal.h:40
uint8_t
#define av_cold
Definition: attributes.h:66
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:68
AVOptions.
static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *picture, int *got_packet)
Definition: libxvid.c:733
float b_quant_factor
qscale factor between IP and B-frames If > 0 then the last P-frame quantizer will be used (q= lastp_q...
Definition: avcodec.h:1688
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1523
int quicktime_format
Are we in a QT-based format?
Definition: libxvid.c:65
uint8_t * data
Definition: avcodec.h:1346
struct xvid_context * context
Pointer to private context.
Definition: libxvid.c:85
static int xvid_strip_vol_header(AVCodecContext *avctx, AVPacket *pkt, unsigned int header_len, unsigned int frame_len)
Routine to create a global VO/VOL header for MP4 container.
Definition: libxvid.c:270
float lumi_masking
luminance masking (0-> disabled)
Definition: avcodec.h:1744
char * stats_out
pass1 encoding statistics output buffer
Definition: avcodec.h:2556
#define AV_CODEC_FLAG_GRAY
Only decode/encode grayscale.
Definition: avcodec.h:763
#define AV_INPUT_BUFFER_MIN_SIZE
minimum encoding buffer size Used to avoid some checks during header writing.
Definition: avcodec.h:645
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1378
static int xvid_ff_2pass(void *ref, int cmd, void *p1, void *p2)
Dispatch function for our custom plugin.
Definition: libxvid.c:238
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:84
no search, that is use 0,0 vector whenever one is needed
Definition: avcodec.h:666
reserved for experiments
Definition: avcodec.h:671
int width
width and height of the video frame
Definition: frame.h:179
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:124
void av_free(void *ptr)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc(). ...
Definition: mem.c:190
#define AV_CODEC_FLAG_4MV
4 MV per MB allowed / advanced prediction for H.263.
Definition: avcodec.h:739
#define MAX_MB_BYTES
Definition: mpegutils.h:47
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:80
int qmax
maximum quantizer
Definition: avcodec.h:2337
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:148
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:145
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:1503
int64_t av_gcd(int64_t a, int64_t b)
Return the greatest common divisor of a and b.
Definition: mathematics.c:32
const char * name
Name of the codec implementation.
Definition: avcodec.h:3127
int me_quality
Motion estimation quality.
Definition: libxvid.c:76
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1352
#define OFFSET(x)
Definition: libxvid.c:895
static av_cold int xvid_encode_close(AVCodecContext *avctx)
Definition: libxvid.c:874
char * twopassfile
second pass temp file name
Definition: libxvid.c:68
common internal API header
static const AVOption options[]
Definition: libxvid.c:897
#define BUFFER_SIZE
Buffer management macros.
Definition: libxvid.c:48
int vop_flags
VOP flags for Xvid encoder.
Definition: libxvid.c:61
int bit_rate
the average bitrate
Definition: avcodec.h:1473
Structure for the private first-pass plugin.
Definition: libxvid.c:83
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:201
#define AV_CODEC_FLAG_QSCALE
Use fixed qscale.
Definition: avcodec.h:735
int variance_aq
Variance adaptive quantization.
Definition: libxvid.c:72
#define AV_CODEC_FLAG_AC_PRED
H.263 advanced intra coding / MPEG-4 AC prediction.
Definition: avcodec.h:793
Structure for the private Xvid context.
Definition: libxvid.c:56
int width
picture width / height.
Definition: avcodec.h:1580
static const AVClass xvid_class
Definition: libxvid.c:911
unsigned char * inter_matrix
I-Frame Quant Matrix.
Definition: libxvid.c:70
#define AV_CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
Definition: avcodec.h:751
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:239
#define AV_RL32
Definition: intreadwrite.h:146
int mb_decision
macroblock decision mode
Definition: avcodec.h:1953
LIBAVUTIL_VERSION_INT
Definition: eval.c:55
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:2806
if(ac->has_optimized_func)
int ssim_acc
SSIM accuracy.
Definition: libxvid.c:74
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames...
Definition: frame.h:191
NULL
Definition: eval.c:55
Libavcodec external API header.
attribute_deprecated int mpeg_quant
Definition: avcodec.h:1720
#define BUFFER_CAT(x)
Definition: libxvid.c:50
enum AVCodecID codec_id
Definition: avcodec.h:1426
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:158
av_default_item_name
Definition: dnxhdenc.c:55
main external API structure.
Definition: avcodec.h:1409
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:347
int qmin
minimum quantizer
Definition: avcodec.h:2330
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> (&#39;D&#39;<<24) + (&#39;C&#39;<<16) + (&#39;B&#39;<<8) + &#39;A&#39;).
Definition: avcodec.h:1441
int extradata_size
Definition: avcodec.h:1524
uint16_t * intra_matrix
custom intra quantization matrix
Definition: avcodec.h:1963
Describe the class of an AVClass context structure.
Definition: log.h:34
char * twopassbuffer
Character buffer for two-pass.
Definition: libxvid.c:66
float b_quant_offset
qscale offset between IP and B-frames
Definition: avcodec.h:1707
static av_cold int xvid_encode_init(AVCodecContext *avctx)
Definition: libxvid.c:362
int version
Xvid version.
Definition: libxvid.c:84
static av_always_inline av_const float roundf(float x)
Definition: libm.h:158
uint16_t * inter_matrix
custom inter quantization matrix
Definition: avcodec.h:1970
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:186
This side data contains an integer value representing the quality factor of the compressed frame...
Definition: avcodec.h:1273
#define AV_CODEC_FLAG_QPEL
Use qpel MC.
Definition: avcodec.h:747
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:146
#define AV_CODEC_FLAG_GLOBAL_HEADER
Place global headers in extradata instead of every keyframe.
Definition: avcodec.h:784
int mpeg_quant
Quantization type.
Definition: libxvid.c:77
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
Definition: avcodec.h:1606
int ssim
SSIM information display mode.
Definition: libxvid.c:73
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:59
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:77
common internal api header.
int vol_flags
VOL flags for Xvid encoder.
Definition: libxvid.c:62
Bi-dir predicted.
Definition: avutil.h:262
attribute_deprecated AVFrame * coded_frame
the picture in the bitstream
Definition: avcodec.h:2797
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
Definition: avpacket.c:31
int ff_tempfile(const char *prefix, char **filename)
Definition: libxvid_rc.c:43
int den
denominator
Definition: rational.h:45
static int xvid_ff_2pass_create(xvid_plg_create_t *param, void **handle)
Initialize the two-pass plugin and context.
Definition: libxvid.c:109
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:61
int trellis
trellis RD quantization
Definition: avcodec.h:2486
static int xvid_ff_2pass_before(struct xvid_context *ref, xvid_plg_data_t *param)
Enable fast encode mode during the first pass.
Definition: libxvid.c:157
#define AV_CODEC_FLAG_PASS2
Use internal 2pass ratecontrol in second pass mode.
Definition: avcodec.h:755
void * encoder_handle
Handle for Xvid encoder.
Definition: libxvid.c:58
void * priv_data
Definition: avcodec.h:1451
#define CODEC_FLAG_GMC
Definition: avcodec.h:925
static int xvid_ff_2pass_after(struct xvid_context *ref, xvid_plg_data_t *param)
Capture statistic data and write it during first pass.
Definition: libxvid.c:201
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:78
static uint8_t tmp[8]
Definition: des.c:38
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:196
#define VE
Definition: libxvid.c:896
#define FF_QP2LAMBDA
factor to convert from H.263 QP to lambda
Definition: avutil.h:214
static int xvid_ff_2pass_destroy(struct xvid_context *ref, xvid_plg_destroy_t *param)
Destroy the two-pass plugin context.
Definition: libxvid.c:140
static void xvid_correct_framerate(AVCodecContext *avctx)
Routine to correct a possibly erroneous framerate being fed to us.
Definition: libxvid.c:312
int height
Definition: frame.h:179
#define AV_CODEC_FLAG_CLOSED_GOP
Definition: avcodec.h:798
uint8_t * av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int size)
Allocate new information of a packet.
Definition: avpacket.c:263
int qscale
Do we use constant scale?
Definition: libxvid.c:64
AVPixelFormat
Pixel format.
Definition: pixfmt.h:57
This structure stores compressed data.
Definition: avcodec.h:1323
Predicted.
Definition: avutil.h:261
int lumi_aq
Lumi masking as an aq method.
Definition: libxvid.c:71