FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
libxvid.c
Go to the documentation of this file.
1 /*
2  * Interface to xvidcore for mpeg4 encoding
3  * Copyright (c) 2004 Adam Thayer <krevnik@comcast.net>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file
24  * Interface to xvidcore for MPEG-4 compliant encoding.
25  * @author Adam Thayer (krevnik@comcast.net)
26  */
27 
28 #include <xvid.h>
29 #include <unistd.h>
30 #include "avcodec.h"
31 #include "internal.h"
32 #include "libavutil/file.h"
33 #include "libavutil/cpu.h"
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/mathematics.h"
36 #include "libxvid.h"
37 #include "mpegvideo.h"
38 
39 /**
40  * Buffer management macros.
41  */
42 #define BUFFER_SIZE 1024
43 #define BUFFER_REMAINING(x) (BUFFER_SIZE - strlen(x))
44 #define BUFFER_CAT(x) (&((x)[strlen(x)]))
45 
46 /**
47  * Structure for the private Xvid context.
48  * This stores all the private context for the codec.
49  */
50 struct xvid_context {
51  AVClass *class;
52  void *encoder_handle; /**< Handle for Xvid encoder */
53  int xsize; /**< Frame x size */
54  int ysize; /**< Frame y size */
55  int vop_flags; /**< VOP flags for Xvid encoder */
56  int vol_flags; /**< VOL flags for Xvid encoder */
57  int me_flags; /**< Motion Estimation flags */
58  int qscale; /**< Do we use constant scale? */
59  int quicktime_format; /**< Are we in a QT-based format? */
60  char *twopassbuffer; /**< Character buffer for two-pass */
61  char *old_twopassbuffer; /**< Old character buffer (two-pass) */
62  char *twopassfile; /**< second pass temp file name */
63  int twopassfd;
64  unsigned char *intra_matrix; /**< P-Frame Quant Matrix */
65  unsigned char *inter_matrix; /**< I-Frame Quant Matrix */
66  int lumi_aq; /**< Lumi masking as an aq method */
67  int variance_aq; /**< Variance adaptive quantization */
68  int ssim; /**< SSIM information display mode */
69  int ssim_acc; /**< SSIM accuracy. 0: accurate. 4: fast. */
70 };
71 
72 /**
73  * Structure for the private first-pass plugin.
74  */
75 struct xvid_ff_pass1 {
76  int version; /**< Xvid version */
77  struct xvid_context *context; /**< Pointer to private context */
78 };
79 
80 static int xvid_encode_close(AVCodecContext *avctx);
81 
82 /*
83  * Xvid 2-Pass Kludge Section
84  *
85  * Xvid's default 2-pass doesn't allow us to create data as we need to, so
86  * this section spends time replacing the first pass plugin so we can write
87  * statistic information as libavcodec requests in. We have another kludge
88  * that allows us to pass data to the second pass in Xvid without a custom
89  * rate-control plugin.
90  */
91 
92 /**
93  * Initialize the two-pass plugin and context.
94  *
95  * @param param Input construction parameter structure
96  * @param handle Private context handle
97  * @return Returns XVID_ERR_xxxx on failure, or 0 on success.
98  */
99 static int xvid_ff_2pass_create(xvid_plg_create_t * param,
100  void ** handle) {
101  struct xvid_ff_pass1 *x = (struct xvid_ff_pass1 *)param->param;
102  char *log = x->context->twopassbuffer;
103 
104  /* Do a quick bounds check */
105  if( log == NULL )
106  return XVID_ERR_FAIL;
107 
108  /* We use snprintf() */
109  /* This is because we can safely prevent a buffer overflow */
110  log[0] = 0;
111  snprintf(log, BUFFER_REMAINING(log),
112  "# ffmpeg 2-pass log file, using xvid codec\n");
114  "# Do not modify. libxvidcore version: %d.%d.%d\n\n",
115  XVID_VERSION_MAJOR(XVID_VERSION),
116  XVID_VERSION_MINOR(XVID_VERSION),
117  XVID_VERSION_PATCH(XVID_VERSION));
118 
119  *handle = x->context;
120  return 0;
121 }
122 
123 /**
124  * Destroy the two-pass plugin context.
125  *
126  * @param ref Context pointer for the plugin
127  * @param param Destrooy context
128  * @return Returns 0, success guaranteed
129  */
130 static int xvid_ff_2pass_destroy(struct xvid_context *ref,
131  xvid_plg_destroy_t *param) {
132  /* Currently cannot think of anything to do on destruction */
133  /* Still, the framework should be here for reference/use */
134  if( ref->twopassbuffer != NULL )
135  ref->twopassbuffer[0] = 0;
136  return 0;
137 }
138 
139 /**
140  * Enable fast encode mode during the first pass.
141  *
142  * @param ref Context pointer for the plugin
143  * @param param Frame data
144  * @return Returns 0, success guaranteed
145  */
146 static int xvid_ff_2pass_before(struct xvid_context *ref,
147  xvid_plg_data_t *param) {
148  int motion_remove;
149  int motion_replacements;
150  int vop_remove;
151 
152  /* Nothing to do here, result is changed too much */
153  if( param->zone && param->zone->mode == XVID_ZONE_QUANT )
154  return 0;
155 
156  /* We can implement a 'turbo' first pass mode here */
157  param->quant = 2;
158 
159  /* Init values */
160  motion_remove = ~XVID_ME_CHROMA_PVOP &
161  ~XVID_ME_CHROMA_BVOP &
162  ~XVID_ME_EXTSEARCH16 &
163  ~XVID_ME_ADVANCEDDIAMOND16;
164  motion_replacements = XVID_ME_FAST_MODEINTERPOLATE |
165  XVID_ME_SKIP_DELTASEARCH |
166  XVID_ME_FASTREFINE16 |
167  XVID_ME_BFRAME_EARLYSTOP;
168  vop_remove = ~XVID_VOP_MODEDECISION_RD &
169  ~XVID_VOP_FAST_MODEDECISION_RD &
170  ~XVID_VOP_TRELLISQUANT &
171  ~XVID_VOP_INTER4V &
172  ~XVID_VOP_HQACPRED;
173 
174  param->vol_flags &= ~XVID_VOL_GMC;
175  param->vop_flags &= vop_remove;
176  param->motion_flags &= motion_remove;
177  param->motion_flags |= motion_replacements;
178 
179  return 0;
180 }
181 
182 /**
183  * Capture statistic data and write it during first pass.
184  *
185  * @param ref Context pointer for the plugin
186  * @param param Statistic data
187  * @return Returns XVID_ERR_xxxx on failure, or 0 on success
188  */
189 static int xvid_ff_2pass_after(struct xvid_context *ref,
190  xvid_plg_data_t *param) {
191  char *log = ref->twopassbuffer;
192  const char *frame_types = " ipbs";
193  char frame_type;
194 
195  /* Quick bounds check */
196  if( log == NULL )
197  return XVID_ERR_FAIL;
198 
199  /* Convert the type given to us into a character */
200  if( param->type < 5 && param->type > 0 ) {
201  frame_type = frame_types[param->type];
202  } else {
203  return XVID_ERR_FAIL;
204  }
205 
207  "%c %d %d %d %d %d %d\n",
208  frame_type, param->stats.quant, param->stats.kblks, param->stats.mblks,
209  param->stats.ublks, param->stats.length, param->stats.hlength);
210 
211  return 0;
212 }
213 
214 /**
215  * Dispatch function for our custom plugin.
216  * This handles the dispatch for the Xvid plugin. It passes data
217  * on to other functions for actual processing.
218  *
219  * @param ref Context pointer for the plugin
220  * @param cmd The task given for us to complete
221  * @param p1 First parameter (varies)
222  * @param p2 Second parameter (varies)
223  * @return Returns XVID_ERR_xxxx on failure, or 0 on success
224  */
225 static int xvid_ff_2pass(void *ref, int cmd, void *p1, void *p2)
226 {
227  switch( cmd ) {
228  case XVID_PLG_INFO:
229  case XVID_PLG_FRAME:
230  return 0;
231 
232  case XVID_PLG_BEFORE:
233  return xvid_ff_2pass_before(ref, p1);
234 
235  case XVID_PLG_CREATE:
236  return xvid_ff_2pass_create(p1, p2);
237 
238  case XVID_PLG_AFTER:
239  return xvid_ff_2pass_after(ref, p1);
240 
241  case XVID_PLG_DESTROY:
242  return xvid_ff_2pass_destroy(ref, p1);
243 
244  default:
245  return XVID_ERR_FAIL;
246  }
247 }
248 
249 /**
250  * Routine to create a global VO/VOL header for MP4 container.
251  * What we do here is extract the header from the Xvid bitstream
252  * as it is encoded. We also strip the repeated headers from the
253  * bitstream when a global header is requested for MPEG-4 ISO
254  * compliance.
255  *
256  * @param avctx AVCodecContext pointer to context
257  * @param frame Pointer to encoded frame data
258  * @param header_len Length of header to search
259  * @param frame_len Length of encoded frame data
260  * @return Returns new length of frame data
261  */
263  AVPacket *pkt,
264  unsigned int header_len,
265  unsigned int frame_len) {
266  int vo_len = 0, i;
267 
268  for( i = 0; i < header_len - 3; i++ ) {
269  if( pkt->data[i] == 0x00 &&
270  pkt->data[i+1] == 0x00 &&
271  pkt->data[i+2] == 0x01 &&
272  pkt->data[i+3] == 0xB6 ) {
273  vo_len = i;
274  break;
275  }
276  }
277 
278  if( vo_len > 0 ) {
279  /* We need to store the header, so extract it */
280  if( avctx->extradata == NULL ) {
281  avctx->extradata = av_malloc(vo_len);
282  memcpy(avctx->extradata, pkt->data, vo_len);
283  avctx->extradata_size = vo_len;
284  }
285  /* Less dangerous now, memmove properly copies the two
286  chunks of overlapping data */
287  memmove(pkt->data, &pkt->data[vo_len], frame_len - vo_len);
288  pkt->size = frame_len - vo_len;
289  }
290  return 0;
291 }
292 
293 /**
294  * Routine to correct a possibly erroneous framerate being fed to us.
295  * Xvid currently chokes on framerates where the ticks per frame is
296  * extremely large. This function works to correct problems in this area
297  * by estimating a new framerate and taking the simpler fraction of
298  * the two presented.
299  *
300  * @param avctx Context that contains the framerate to correct.
301  */
303 {
304  int frate, fbase;
305  int est_frate, est_fbase;
306  int gcd;
307  float est_fps, fps;
308 
309  frate = avctx->time_base.den;
310  fbase = avctx->time_base.num;
311 
312  gcd = av_gcd(frate, fbase);
313  if( gcd > 1 ) {
314  frate /= gcd;
315  fbase /= gcd;
316  }
317 
318  if( frate <= 65000 && fbase <= 65000 ) {
319  avctx->time_base.den = frate;
320  avctx->time_base.num = fbase;
321  return;
322  }
323 
324  fps = (float)frate / (float)fbase;
325  est_fps = roundf(fps * 1000.0) / 1000.0;
326 
327  est_frate = (int)est_fps;
328  if( est_fps > (int)est_fps ) {
329  est_frate = (est_frate + 1) * 1000;
330  est_fbase = (int)roundf((float)est_frate / est_fps);
331  } else
332  est_fbase = 1;
333 
334  gcd = av_gcd(est_frate, est_fbase);
335  if( gcd > 1 ) {
336  est_frate /= gcd;
337  est_fbase /= gcd;
338  }
339 
340  if( fbase > est_fbase ) {
341  avctx->time_base.den = est_frate;
342  avctx->time_base.num = est_fbase;
343  av_log(avctx, AV_LOG_DEBUG,
344  "Xvid: framerate re-estimated: %.2f, %.3f%% correction\n",
345  est_fps, (((est_fps - fps)/fps) * 100.0));
346  } else {
347  avctx->time_base.den = frate;
348  avctx->time_base.num = fbase;
349  }
350 }
351 
353  int xerr, i;
354  int xvid_flags = avctx->flags;
355  struct xvid_context *x = avctx->priv_data;
356  uint16_t *intra, *inter;
357  int fd;
358 
359  xvid_plugin_single_t single = { 0 };
360  struct xvid_ff_pass1 rc2pass1 = { 0 };
361  xvid_plugin_2pass2_t rc2pass2 = { 0 };
362  xvid_plugin_lumimasking_t masking_l = { 0 }; /* For lumi masking */
363  xvid_plugin_lumimasking_t masking_v = { 0 }; /* For variance AQ */
364  xvid_plugin_ssim_t ssim = { 0 };
365  xvid_gbl_init_t xvid_gbl_init = { 0 };
366  xvid_enc_create_t xvid_enc_create = { 0 };
367  xvid_enc_plugin_t plugins[4];
368 
369  x->twopassfd = -1;
370 
371  /* Bring in VOP flags from ffmpeg command-line */
372  x->vop_flags = XVID_VOP_HALFPEL; /* Bare minimum quality */
373  if( xvid_flags & CODEC_FLAG_4MV )
374  x->vop_flags |= XVID_VOP_INTER4V; /* Level 3 */
375  if( avctx->trellis)
376  x->vop_flags |= XVID_VOP_TRELLISQUANT; /* Level 5 */
377  if( xvid_flags & CODEC_FLAG_AC_PRED )
378  x->vop_flags |= XVID_VOP_HQACPRED; /* Level 6 */
379  if( xvid_flags & CODEC_FLAG_GRAY )
380  x->vop_flags |= XVID_VOP_GREYSCALE;
381 
382  /* Decide which ME quality setting to use */
383  x->me_flags = 0;
384  switch( avctx->me_method ) {
385  case ME_FULL: /* Quality 6 */
386  x->me_flags |= XVID_ME_EXTSEARCH16
387  | XVID_ME_EXTSEARCH8;
388 
389  case ME_EPZS: /* Quality 4 */
390  x->me_flags |= XVID_ME_ADVANCEDDIAMOND8
391  | XVID_ME_HALFPELREFINE8
392  | XVID_ME_CHROMA_PVOP
393  | XVID_ME_CHROMA_BVOP;
394 
395  case ME_LOG: /* Quality 2 */
396  case ME_PHODS:
397  case ME_X1:
398  x->me_flags |= XVID_ME_ADVANCEDDIAMOND16
399  | XVID_ME_HALFPELREFINE16;
400 
401  case ME_ZERO: /* Quality 0 */
402  default:
403  break;
404  }
405 
406  /* Decide how we should decide blocks */
407  switch( avctx->mb_decision ) {
408  case 2:
409  x->vop_flags |= XVID_VOP_MODEDECISION_RD;
410  x->me_flags |= XVID_ME_HALFPELREFINE8_RD
411  | XVID_ME_QUARTERPELREFINE8_RD
412  | XVID_ME_EXTSEARCH_RD
413  | XVID_ME_CHECKPREDICTION_RD;
414  case 1:
415  if( !(x->vop_flags & XVID_VOP_MODEDECISION_RD) )
416  x->vop_flags |= XVID_VOP_FAST_MODEDECISION_RD;
417  x->me_flags |= XVID_ME_HALFPELREFINE16_RD
418  | XVID_ME_QUARTERPELREFINE16_RD;
419 
420  default:
421  break;
422  }
423 
424  /* Bring in VOL flags from ffmpeg command-line */
425  x->vol_flags = 0;
426  if( xvid_flags & CODEC_FLAG_GMC ) {
427  x->vol_flags |= XVID_VOL_GMC;
428  x->me_flags |= XVID_ME_GME_REFINE;
429  }
430  if( xvid_flags & CODEC_FLAG_QPEL ) {
431  x->vol_flags |= XVID_VOL_QUARTERPEL;
432  x->me_flags |= XVID_ME_QUARTERPELREFINE16;
433  if( x->vop_flags & XVID_VOP_INTER4V )
434  x->me_flags |= XVID_ME_QUARTERPELREFINE8;
435  }
436 
437  xvid_gbl_init.version = XVID_VERSION;
438  xvid_gbl_init.debug = 0;
439 
440 #if ARCH_PPC
441  /* Xvid's PPC support is borked, use libavcodec to detect */
442 #if HAVE_ALTIVEC
444  xvid_gbl_init.cpu_flags = XVID_CPU_FORCE | XVID_CPU_ALTIVEC;
445  } else
446 #endif
447  xvid_gbl_init.cpu_flags = XVID_CPU_FORCE;
448 #else
449  /* Xvid can detect on x86 */
450  xvid_gbl_init.cpu_flags = 0;
451 #endif
452 
453  /* Initialize */
454  xvid_global(NULL, XVID_GBL_INIT, &xvid_gbl_init, NULL);
455 
456  /* Create the encoder reference */
457  xvid_enc_create.version = XVID_VERSION;
458 
459  /* Store the desired frame size */
460  xvid_enc_create.width = x->xsize = avctx->width;
461  xvid_enc_create.height = x->ysize = avctx->height;
462 
463  /* Xvid can determine the proper profile to use */
464  /* xvid_enc_create.profile = XVID_PROFILE_S_L3; */
465 
466  /* We don't use zones */
467  xvid_enc_create.zones = NULL;
468  xvid_enc_create.num_zones = 0;
469 
470  xvid_enc_create.num_threads = avctx->thread_count;
471 
472  xvid_enc_create.plugins = plugins;
473  xvid_enc_create.num_plugins = 0;
474 
475  /* Initialize Buffers */
476  x->twopassbuffer = NULL;
477  x->old_twopassbuffer = NULL;
478  x->twopassfile = NULL;
479 
480  if( xvid_flags & CODEC_FLAG_PASS1 ) {
481  rc2pass1.version = XVID_VERSION;
482  rc2pass1.context = x;
485  if( x->twopassbuffer == NULL || x->old_twopassbuffer == NULL ) {
486  av_log(avctx, AV_LOG_ERROR,
487  "Xvid: Cannot allocate 2-pass log buffers\n");
488  goto fail;
489  }
490  x->twopassbuffer[0] = x->old_twopassbuffer[0] = 0;
491 
492  plugins[xvid_enc_create.num_plugins].func = xvid_ff_2pass;
493  plugins[xvid_enc_create.num_plugins].param = &rc2pass1;
494  xvid_enc_create.num_plugins++;
495  } else if( xvid_flags & CODEC_FLAG_PASS2 ) {
496  rc2pass2.version = XVID_VERSION;
497  rc2pass2.bitrate = avctx->bit_rate;
498 
499  fd = av_tempfile("xvidff.", &x->twopassfile, 0, avctx);
500  if( fd == -1 ) {
501  av_log(avctx, AV_LOG_ERROR,
502  "Xvid: Cannot write 2-pass pipe\n");
503  goto fail;
504  }
505  x->twopassfd = fd;
506 
507  if( avctx->stats_in == NULL ) {
508  av_log(avctx, AV_LOG_ERROR,
509  "Xvid: No 2-pass information loaded for second pass\n");
510  goto fail;
511  }
512 
513  if( strlen(avctx->stats_in) >
514  write(fd, avctx->stats_in, strlen(avctx->stats_in)) ) {
515  av_log(avctx, AV_LOG_ERROR,
516  "Xvid: Cannot write to 2-pass pipe\n");
517  goto fail;
518  }
519 
520  rc2pass2.filename = x->twopassfile;
521  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_2pass2;
522  plugins[xvid_enc_create.num_plugins].param = &rc2pass2;
523  xvid_enc_create.num_plugins++;
524  } else if( !(xvid_flags & CODEC_FLAG_QSCALE) ) {
525  /* Single Pass Bitrate Control! */
526  single.version = XVID_VERSION;
527  single.bitrate = avctx->bit_rate;
528 
529  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_single;
530  plugins[xvid_enc_create.num_plugins].param = &single;
531  xvid_enc_create.num_plugins++;
532  }
533 
534  if ( avctx->lumi_masking != 0.0)
535  x->lumi_aq = 1;
536 
537  /* Luminance Masking */
538  if( x->lumi_aq ) {
539  masking_l.method = 0;
540  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
541 
542  /* The old behavior is that when avctx->lumi_masking is specified,
543  * plugins[...].param = NULL. Trying to keep the old behavior here. */
544  plugins[xvid_enc_create.num_plugins].param = avctx->lumi_masking ? NULL : &masking_l ;
545  xvid_enc_create.num_plugins++;
546  }
547 
548  /* Variance AQ */
549  if( x->variance_aq ) {
550  masking_v.method = 1;
551  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
552  plugins[xvid_enc_create.num_plugins].param = &masking_v ;
553  xvid_enc_create.num_plugins++;
554  }
555 
556  if( x->lumi_aq && x->variance_aq )
557  av_log(avctx, AV_LOG_INFO,
558  "Both lumi_aq and variance_aq are enabled. The resulting quality"
559  "will be the worse one of the two effects made by the AQ.\n");
560 
561  /* SSIM */
562  if( x->ssim ) {
563  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_ssim;
564  ssim.b_printstat = ( x->ssim == 2 );
565  ssim.acc = x->ssim_acc;
566  ssim.cpu_flags = xvid_gbl_init.cpu_flags;
567  ssim.b_visualize = 0;
568  plugins[xvid_enc_create.num_plugins].param = &ssim;
569  xvid_enc_create.num_plugins++;
570  }
571 
572  /* Frame Rate and Key Frames */
573  xvid_correct_framerate(avctx);
574  xvid_enc_create.fincr = avctx->time_base.num;
575  xvid_enc_create.fbase = avctx->time_base.den;
576  if( avctx->gop_size > 0 )
577  xvid_enc_create.max_key_interval = avctx->gop_size;
578  else
579  xvid_enc_create.max_key_interval = 240; /* Xvid's best default */
580 
581  /* Quants */
582  if( xvid_flags & CODEC_FLAG_QSCALE ) x->qscale = 1;
583  else x->qscale = 0;
584 
585  xvid_enc_create.min_quant[0] = avctx->qmin;
586  xvid_enc_create.min_quant[1] = avctx->qmin;
587  xvid_enc_create.min_quant[2] = avctx->qmin;
588  xvid_enc_create.max_quant[0] = avctx->qmax;
589  xvid_enc_create.max_quant[1] = avctx->qmax;
590  xvid_enc_create.max_quant[2] = avctx->qmax;
591 
592  /* Quant Matrices */
593  x->intra_matrix = x->inter_matrix = NULL;
594  if( avctx->mpeg_quant )
595  x->vol_flags |= XVID_VOL_MPEGQUANT;
596  if( (avctx->intra_matrix || avctx->inter_matrix) ) {
597  x->vol_flags |= XVID_VOL_MPEGQUANT;
598 
599  if( avctx->intra_matrix ) {
600  intra = avctx->intra_matrix;
601  x->intra_matrix = av_malloc(sizeof(unsigned char) * 64);
602  } else
603  intra = NULL;
604  if( avctx->inter_matrix ) {
605  inter = avctx->inter_matrix;
606  x->inter_matrix = av_malloc(sizeof(unsigned char) * 64);
607  } else
608  inter = NULL;
609 
610  for( i = 0; i < 64; i++ ) {
611  if( intra )
612  x->intra_matrix[i] = (unsigned char)intra[i];
613  if( inter )
614  x->inter_matrix[i] = (unsigned char)inter[i];
615  }
616  }
617 
618  /* Misc Settings */
619  xvid_enc_create.frame_drop_ratio = 0;
620  xvid_enc_create.global = 0;
621  if( xvid_flags & CODEC_FLAG_CLOSED_GOP )
622  xvid_enc_create.global |= XVID_GLOBAL_CLOSED_GOP;
623 
624  /* Determines which codec mode we are operating in */
625  avctx->extradata = NULL;
626  avctx->extradata_size = 0;
627  if( xvid_flags & CODEC_FLAG_GLOBAL_HEADER ) {
628  /* In this case, we are claiming to be MPEG4 */
629  x->quicktime_format = 1;
630  avctx->codec_id = AV_CODEC_ID_MPEG4;
631  } else {
632  /* We are claiming to be Xvid */
633  x->quicktime_format = 0;
634  if(!avctx->codec_tag)
635  avctx->codec_tag = AV_RL32("xvid");
636  }
637 
638  /* Bframes */
639  xvid_enc_create.max_bframes = avctx->max_b_frames;
640  xvid_enc_create.bquant_offset = 100 * avctx->b_quant_offset;
641  xvid_enc_create.bquant_ratio = 100 * avctx->b_quant_factor;
642  if( avctx->max_b_frames > 0 && !x->quicktime_format ) xvid_enc_create.global |= XVID_GLOBAL_PACKED;
643 
644  av_assert0(xvid_enc_create.num_plugins + (!!x->ssim) + (!!x->variance_aq) + (!!x->lumi_aq) <= FF_ARRAY_ELEMS(plugins));
645 
646  /* Create encoder context */
647  xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
648  if( xerr ) {
649  av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
650  goto fail;
651  }
652 
653  x->encoder_handle = xvid_enc_create.handle;
654  avctx->coded_frame = av_frame_alloc();
655  if (!avctx->coded_frame)
656  return AVERROR(ENOMEM);
657 
658  return 0;
659 fail:
660  xvid_encode_close(avctx);
661  return -1;
662 }
663 
665  const AVFrame *picture, int *got_packet)
666 {
667  int xerr, i, ret, user_packet = !!pkt->data;
668  char *tmp;
669  struct xvid_context *x = avctx->priv_data;
670  AVFrame *p = avctx->coded_frame;
671  int mb_width = (avctx->width + 15) / 16;
672  int mb_height = (avctx->height + 15) / 16;
673 
674  xvid_enc_frame_t xvid_enc_frame = { 0 };
675  xvid_enc_stats_t xvid_enc_stats = { 0 };
676 
677  if ((ret = ff_alloc_packet2(avctx, pkt, mb_width*mb_height*MAX_MB_BYTES + FF_MIN_BUFFER_SIZE)) < 0)
678  return ret;
679 
680  /* Start setting up the frame */
681  xvid_enc_frame.version = XVID_VERSION;
682  xvid_enc_stats.version = XVID_VERSION;
683 
684  /* Let Xvid know where to put the frame. */
685  xvid_enc_frame.bitstream = pkt->data;
686  xvid_enc_frame.length = pkt->size;
687 
688  /* Initialize input image fields */
689  if( avctx->pix_fmt != AV_PIX_FMT_YUV420P ) {
690  av_log(avctx, AV_LOG_ERROR, "Xvid: Color spaces other than 420p not supported\n");
691  return -1;
692  }
693 
694  xvid_enc_frame.input.csp = XVID_CSP_PLANAR; /* YUV420P */
695 
696  for( i = 0; i < 4; i++ ) {
697  xvid_enc_frame.input.plane[i] = picture->data[i];
698  xvid_enc_frame.input.stride[i] = picture->linesize[i];
699  }
700 
701  /* Encoder Flags */
702  xvid_enc_frame.vop_flags = x->vop_flags;
703  xvid_enc_frame.vol_flags = x->vol_flags;
704  xvid_enc_frame.motion = x->me_flags;
705  xvid_enc_frame.type =
706  picture->pict_type == AV_PICTURE_TYPE_I ? XVID_TYPE_IVOP :
707  picture->pict_type == AV_PICTURE_TYPE_P ? XVID_TYPE_PVOP :
708  picture->pict_type == AV_PICTURE_TYPE_B ? XVID_TYPE_BVOP :
709  XVID_TYPE_AUTO;
710 
711  /* Pixel aspect ratio setting */
712  if (avctx->sample_aspect_ratio.num < 0 || avctx->sample_aspect_ratio.num > 255 ||
713  avctx->sample_aspect_ratio.den < 0 || avctx->sample_aspect_ratio.den > 255) {
714  av_log(avctx, AV_LOG_WARNING,
715  "Invalid pixel aspect ratio %i/%i, limit is 255/255 reducing\n",
718  avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den, 255);
719  }
720  xvid_enc_frame.par = XVID_PAR_EXT;
721  xvid_enc_frame.par_width = avctx->sample_aspect_ratio.num;
722  xvid_enc_frame.par_height = avctx->sample_aspect_ratio.den;
723 
724  /* Quant Setting */
725  if( x->qscale ) xvid_enc_frame.quant = picture->quality / FF_QP2LAMBDA;
726  else xvid_enc_frame.quant = 0;
727 
728  /* Matrices */
729  xvid_enc_frame.quant_intra_matrix = x->intra_matrix;
730  xvid_enc_frame.quant_inter_matrix = x->inter_matrix;
731 
732  /* Encode */
733  xerr = xvid_encore(x->encoder_handle, XVID_ENC_ENCODE,
734  &xvid_enc_frame, &xvid_enc_stats);
735 
736  /* Two-pass log buffer swapping */
737  avctx->stats_out = NULL;
738  if( x->twopassbuffer ) {
739  tmp = x->old_twopassbuffer;
741  x->twopassbuffer = tmp;
742  x->twopassbuffer[0] = 0;
743  if( x->old_twopassbuffer[0] != 0 ) {
744  avctx->stats_out = x->old_twopassbuffer;
745  }
746  }
747 
748  if (xerr > 0) {
749  *got_packet = 1;
750 
751  p->quality = xvid_enc_stats.quant * FF_QP2LAMBDA;
752  if( xvid_enc_stats.type == XVID_TYPE_PVOP )
754  else if( xvid_enc_stats.type == XVID_TYPE_BVOP )
756  else if( xvid_enc_stats.type == XVID_TYPE_SVOP )
758  else
760  if( xvid_enc_frame.out_flags & XVID_KEYFRAME ) {
761  p->key_frame = 1;
762  pkt->flags |= AV_PKT_FLAG_KEY;
763  if( x->quicktime_format )
764  return xvid_strip_vol_header(avctx, pkt,
765  xvid_enc_stats.hlength, xerr);
766  } else
767  p->key_frame = 0;
768 
769  pkt->size = xerr;
770 
771  return 0;
772  } else {
773  if (!user_packet)
774  av_free_packet(pkt);
775  if (!xerr)
776  return 0;
777  av_log(avctx, AV_LOG_ERROR, "Xvid: Encoding Error Occurred: %i\n", xerr);
778  return -1;
779  }
780 }
781 
783  struct xvid_context *x = avctx->priv_data;
784 
785  if(x->encoder_handle)
786  xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
787  x->encoder_handle = NULL;
788 
789  av_freep(&avctx->extradata);
790  if( x->twopassbuffer != NULL ) {
791  av_freep(&x->twopassbuffer);
793  avctx->stats_out = NULL;
794  }
795  if (x->twopassfd>=0) {
796  unlink(x->twopassfile);
797  close(x->twopassfd);
798  x->twopassfd = -1;
799  }
800  av_freep(&x->twopassfile);
801  av_freep(&x->intra_matrix);
802  av_freep(&x->inter_matrix);
803 
804  return 0;
805 }
806 
807 #define OFFSET(x) offsetof(struct xvid_context, x)
808 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
809 static const AVOption options[] = {
810  { "lumi_aq", "Luminance masking AQ", OFFSET(lumi_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
811  { "variance_aq", "Variance AQ", OFFSET(variance_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
812  { "ssim", "Show SSIM information to stdout", OFFSET(ssim), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 2, VE, "ssim" },
813  { "off", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, INT_MIN, INT_MAX, VE, "ssim" },
814  { "avg", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, INT_MIN, INT_MAX, VE, "ssim" },
815  { "frame", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 2 }, INT_MIN, INT_MAX, VE, "ssim" },
816  { "ssim_acc", "SSIM accuracy", OFFSET(ssim_acc), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, 4, VE },
817  { NULL },
818 };
819 
820 static const AVClass xvid_class = {
821  .class_name = "libxvid",
822  .item_name = av_default_item_name,
823  .option = options,
824  .version = LIBAVUTIL_VERSION_INT,
825 };
826 
828  .name = "libxvid",
829  .long_name = NULL_IF_CONFIG_SMALL("libxvidcore MPEG-4 part 2"),
830  .type = AVMEDIA_TYPE_VIDEO,
831  .id = AV_CODEC_ID_MPEG4,
832  .priv_data_size = sizeof(struct xvid_context),
833  .init = xvid_encode_init,
834  .encode2 = xvid_encode_frame,
835  .close = xvid_encode_close,
836  .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE },
837  .priv_class = &xvid_class,
838 };