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  void *encoder_handle; /**< Handle for Xvid encoder */
52  int xsize; /**< Frame x size */
53  int ysize; /**< Frame y size */
54  int vop_flags; /**< VOP flags for Xvid encoder */
55  int vol_flags; /**< VOL flags for Xvid encoder */
56  int me_flags; /**< Motion Estimation flags */
57  int qscale; /**< Do we use constant scale? */
58  int quicktime_format; /**< Are we in a QT-based format? */
59  AVFrame encoded_picture; /**< Encoded frame information */
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 };
67 
68 /**
69  * Structure for the private first-pass plugin.
70  */
71 struct xvid_ff_pass1 {
72  int version; /**< Xvid version */
73  struct xvid_context *context; /**< Pointer to private context */
74 };
75 
76 static int xvid_encode_close(AVCodecContext *avctx);
77 
78 /*
79  * Xvid 2-Pass Kludge Section
80  *
81  * Xvid's default 2-pass doesn't allow us to create data as we need to, so
82  * this section spends time replacing the first pass plugin so we can write
83  * statistic information as libavcodec requests in. We have another kludge
84  * that allows us to pass data to the second pass in Xvid without a custom
85  * rate-control plugin.
86  */
87 
88 /**
89  * Initialize the two-pass plugin and context.
90  *
91  * @param param Input construction parameter structure
92  * @param handle Private context handle
93  * @return Returns XVID_ERR_xxxx on failure, or 0 on success.
94  */
95 static int xvid_ff_2pass_create(xvid_plg_create_t * param,
96  void ** handle) {
97  struct xvid_ff_pass1 *x = (struct xvid_ff_pass1 *)param->param;
98  char *log = x->context->twopassbuffer;
99 
100  /* Do a quick bounds check */
101  if( log == NULL )
102  return XVID_ERR_FAIL;
103 
104  /* We use snprintf() */
105  /* This is because we can safely prevent a buffer overflow */
106  log[0] = 0;
107  snprintf(log, BUFFER_REMAINING(log),
108  "# ffmpeg 2-pass log file, using xvid codec\n");
110  "# Do not modify. libxvidcore version: %d.%d.%d\n\n",
111  XVID_VERSION_MAJOR(XVID_VERSION),
112  XVID_VERSION_MINOR(XVID_VERSION),
113  XVID_VERSION_PATCH(XVID_VERSION));
114 
115  *handle = x->context;
116  return 0;
117 }
118 
119 /**
120  * Destroy the two-pass plugin context.
121  *
122  * @param ref Context pointer for the plugin
123  * @param param Destrooy context
124  * @return Returns 0, success guaranteed
125  */
127  xvid_plg_destroy_t *param) {
128  /* Currently cannot think of anything to do on destruction */
129  /* Still, the framework should be here for reference/use */
130  if( ref->twopassbuffer != NULL )
131  ref->twopassbuffer[0] = 0;
132  return 0;
133 }
134 
135 /**
136  * Enable fast encode mode during the first pass.
137  *
138  * @param ref Context pointer for the plugin
139  * @param param Frame data
140  * @return Returns 0, success guaranteed
141  */
143  xvid_plg_data_t *param) {
144  int motion_remove;
145  int motion_replacements;
146  int vop_remove;
147 
148  /* Nothing to do here, result is changed too much */
149  if( param->zone && param->zone->mode == XVID_ZONE_QUANT )
150  return 0;
151 
152  /* We can implement a 'turbo' first pass mode here */
153  param->quant = 2;
154 
155  /* Init values */
156  motion_remove = ~XVID_ME_CHROMA_PVOP &
157  ~XVID_ME_CHROMA_BVOP &
158  ~XVID_ME_EXTSEARCH16 &
159  ~XVID_ME_ADVANCEDDIAMOND16;
160  motion_replacements = XVID_ME_FAST_MODEINTERPOLATE |
161  XVID_ME_SKIP_DELTASEARCH |
162  XVID_ME_FASTREFINE16 |
163  XVID_ME_BFRAME_EARLYSTOP;
164  vop_remove = ~XVID_VOP_MODEDECISION_RD &
165  ~XVID_VOP_FAST_MODEDECISION_RD &
166  ~XVID_VOP_TRELLISQUANT &
167  ~XVID_VOP_INTER4V &
168  ~XVID_VOP_HQACPRED;
169 
170  param->vol_flags &= ~XVID_VOL_GMC;
171  param->vop_flags &= vop_remove;
172  param->motion_flags &= motion_remove;
173  param->motion_flags |= motion_replacements;
174 
175  return 0;
176 }
177 
178 /**
179  * Capture statistic data and write it during first pass.
180  *
181  * @param ref Context pointer for the plugin
182  * @param param Statistic data
183  * @return Returns XVID_ERR_xxxx on failure, or 0 on success
184  */
186  xvid_plg_data_t *param) {
187  char *log = ref->twopassbuffer;
188  const char *frame_types = " ipbs";
189  char frame_type;
190 
191  /* Quick bounds check */
192  if( log == NULL )
193  return XVID_ERR_FAIL;
194 
195  /* Convert the type given to us into a character */
196  if( param->type < 5 && param->type > 0 ) {
197  frame_type = frame_types[param->type];
198  } else {
199  return XVID_ERR_FAIL;
200  }
201 
203  "%c %d %d %d %d %d %d\n",
204  frame_type, param->stats.quant, param->stats.kblks, param->stats.mblks,
205  param->stats.ublks, param->stats.length, param->stats.hlength);
206 
207  return 0;
208 }
209 
210 /**
211  * Dispatch function for our custom plugin.
212  * This handles the dispatch for the Xvid plugin. It passes data
213  * on to other functions for actual processing.
214  *
215  * @param ref Context pointer for the plugin
216  * @param cmd The task given for us to complete
217  * @param p1 First parameter (varies)
218  * @param p2 Second parameter (varies)
219  * @return Returns XVID_ERR_xxxx on failure, or 0 on success
220  */
221 static int xvid_ff_2pass(void *ref, int cmd, void *p1, void *p2)
222 {
223  switch( cmd ) {
224  case XVID_PLG_INFO:
225  case XVID_PLG_FRAME:
226  return 0;
227 
228  case XVID_PLG_BEFORE:
229  return xvid_ff_2pass_before(ref, p1);
230 
231  case XVID_PLG_CREATE:
232  return xvid_ff_2pass_create(p1, p2);
233 
234  case XVID_PLG_AFTER:
235  return xvid_ff_2pass_after(ref, p1);
236 
237  case XVID_PLG_DESTROY:
238  return xvid_ff_2pass_destroy(ref, p1);
239 
240  default:
241  return XVID_ERR_FAIL;
242  }
243 }
244 
245 /**
246  * Routine to create a global VO/VOL header for MP4 container.
247  * What we do here is extract the header from the Xvid bitstream
248  * as it is encoded. We also strip the repeated headers from the
249  * bitstream when a global header is requested for MPEG-4 ISO
250  * compliance.
251  *
252  * @param avctx AVCodecContext pointer to context
253  * @param frame Pointer to encoded frame data
254  * @param header_len Length of header to search
255  * @param frame_len Length of encoded frame data
256  * @return Returns new length of frame data
257  */
259  AVPacket *pkt,
260  unsigned int header_len,
261  unsigned int frame_len) {
262  int vo_len = 0, i;
263 
264  for( i = 0; i < header_len - 3; i++ ) {
265  if( pkt->data[i] == 0x00 &&
266  pkt->data[i+1] == 0x00 &&
267  pkt->data[i+2] == 0x01 &&
268  pkt->data[i+3] == 0xB6 ) {
269  vo_len = i;
270  break;
271  }
272  }
273 
274  if( vo_len > 0 ) {
275  /* We need to store the header, so extract it */
276  if( avctx->extradata == NULL ) {
277  avctx->extradata = av_malloc(vo_len);
278  memcpy(avctx->extradata, pkt->data, vo_len);
279  avctx->extradata_size = vo_len;
280  }
281  /* Less dangerous now, memmove properly copies the two
282  chunks of overlapping data */
283  memmove(pkt->data, &pkt->data[vo_len], frame_len - vo_len);
284  pkt->size = frame_len - vo_len;
285  }
286  return 0;
287 }
288 
289 /**
290  * Routine to correct a possibly erroneous framerate being fed to us.
291  * Xvid currently chokes on framerates where the ticks per frame is
292  * extremely large. This function works to correct problems in this area
293  * by estimating a new framerate and taking the simpler fraction of
294  * the two presented.
295  *
296  * @param avctx Context that contains the framerate to correct.
297  */
299 {
300  int frate, fbase;
301  int est_frate, est_fbase;
302  int gcd;
303  float est_fps, fps;
304 
305  frate = avctx->time_base.den;
306  fbase = avctx->time_base.num;
307 
308  gcd = av_gcd(frate, fbase);
309  if( gcd > 1 ) {
310  frate /= gcd;
311  fbase /= gcd;
312  }
313 
314  if( frate <= 65000 && fbase <= 65000 ) {
315  avctx->time_base.den = frate;
316  avctx->time_base.num = fbase;
317  return;
318  }
319 
320  fps = (float)frate / (float)fbase;
321  est_fps = roundf(fps * 1000.0) / 1000.0;
322 
323  est_frate = (int)est_fps;
324  if( est_fps > (int)est_fps ) {
325  est_frate = (est_frate + 1) * 1000;
326  est_fbase = (int)roundf((float)est_frate / est_fps);
327  } else
328  est_fbase = 1;
329 
330  gcd = av_gcd(est_frate, est_fbase);
331  if( gcd > 1 ) {
332  est_frate /= gcd;
333  est_fbase /= gcd;
334  }
335 
336  if( fbase > est_fbase ) {
337  avctx->time_base.den = est_frate;
338  avctx->time_base.num = est_fbase;
339  av_log(avctx, AV_LOG_DEBUG,
340  "Xvid: framerate re-estimated: %.2f, %.3f%% correction\n",
341  est_fps, (((est_fps - fps)/fps) * 100.0));
342  } else {
343  avctx->time_base.den = frate;
344  avctx->time_base.num = fbase;
345  }
346 }
347 
349  int xerr, i;
350  int xvid_flags = avctx->flags;
351  struct xvid_context *x = avctx->priv_data;
352  uint16_t *intra, *inter;
353  int fd;
354 
355  xvid_plugin_single_t single = { 0 };
356  struct xvid_ff_pass1 rc2pass1 = { 0 };
357  xvid_plugin_2pass2_t rc2pass2 = { 0 };
358  xvid_gbl_init_t xvid_gbl_init = { 0 };
359  xvid_enc_create_t xvid_enc_create = { 0 };
360  xvid_enc_plugin_t plugins[7];
361 
362  x->twopassfd = -1;
363 
364  /* Bring in VOP flags from ffmpeg command-line */
365  x->vop_flags = XVID_VOP_HALFPEL; /* Bare minimum quality */
366  if( xvid_flags & CODEC_FLAG_4MV )
367  x->vop_flags |= XVID_VOP_INTER4V; /* Level 3 */
368  if( avctx->trellis
369  )
370  x->vop_flags |= XVID_VOP_TRELLISQUANT; /* Level 5 */
371  if( xvid_flags & CODEC_FLAG_AC_PRED )
372  x->vop_flags |= XVID_VOP_HQACPRED; /* Level 6 */
373  if( xvid_flags & CODEC_FLAG_GRAY )
374  x->vop_flags |= XVID_VOP_GREYSCALE;
375 
376  /* Decide which ME quality setting to use */
377  x->me_flags = 0;
378  switch( avctx->me_method ) {
379  case ME_FULL: /* Quality 6 */
380  x->me_flags |= XVID_ME_EXTSEARCH16
381  | XVID_ME_EXTSEARCH8;
382 
383  case ME_EPZS: /* Quality 4 */
384  x->me_flags |= XVID_ME_ADVANCEDDIAMOND8
385  | XVID_ME_HALFPELREFINE8
386  | XVID_ME_CHROMA_PVOP
387  | XVID_ME_CHROMA_BVOP;
388 
389  case ME_LOG: /* Quality 2 */
390  case ME_PHODS:
391  case ME_X1:
392  x->me_flags |= XVID_ME_ADVANCEDDIAMOND16
393  | XVID_ME_HALFPELREFINE16;
394 
395  case ME_ZERO: /* Quality 0 */
396  default:
397  break;
398  }
399 
400  /* Decide how we should decide blocks */
401  switch( avctx->mb_decision ) {
402  case 2:
403  x->vop_flags |= XVID_VOP_MODEDECISION_RD;
404  x->me_flags |= XVID_ME_HALFPELREFINE8_RD
405  | XVID_ME_QUARTERPELREFINE8_RD
406  | XVID_ME_EXTSEARCH_RD
407  | XVID_ME_CHECKPREDICTION_RD;
408  case 1:
409  if( !(x->vop_flags & XVID_VOP_MODEDECISION_RD) )
410  x->vop_flags |= XVID_VOP_FAST_MODEDECISION_RD;
411  x->me_flags |= XVID_ME_HALFPELREFINE16_RD
412  | XVID_ME_QUARTERPELREFINE16_RD;
413 
414  default:
415  break;
416  }
417 
418  /* Bring in VOL flags from ffmpeg command-line */
419  x->vol_flags = 0;
420  if( xvid_flags & CODEC_FLAG_GMC ) {
421  x->vol_flags |= XVID_VOL_GMC;
422  x->me_flags |= XVID_ME_GME_REFINE;
423  }
424  if( xvid_flags & CODEC_FLAG_QPEL ) {
425  x->vol_flags |= XVID_VOL_QUARTERPEL;
426  x->me_flags |= XVID_ME_QUARTERPELREFINE16;
427  if( x->vop_flags & XVID_VOP_INTER4V )
428  x->me_flags |= XVID_ME_QUARTERPELREFINE8;
429  }
430 
431  xvid_gbl_init.version = XVID_VERSION;
432  xvid_gbl_init.debug = 0;
433 
434 #if ARCH_PPC
435  /* Xvid's PPC support is borked, use libavcodec to detect */
436 #if HAVE_ALTIVEC
438  xvid_gbl_init.cpu_flags = XVID_CPU_FORCE | XVID_CPU_ALTIVEC;
439  } else
440 #endif
441  xvid_gbl_init.cpu_flags = XVID_CPU_FORCE;
442 #else
443  /* Xvid can detect on x86 */
444  xvid_gbl_init.cpu_flags = 0;
445 #endif
446 
447  /* Initialize */
448  xvid_global(NULL, XVID_GBL_INIT, &xvid_gbl_init, NULL);
449 
450  /* Create the encoder reference */
451  xvid_enc_create.version = XVID_VERSION;
452 
453  /* Store the desired frame size */
454  xvid_enc_create.width = x->xsize = avctx->width;
455  xvid_enc_create.height = x->ysize = avctx->height;
456 
457  /* Xvid can determine the proper profile to use */
458  /* xvid_enc_create.profile = XVID_PROFILE_S_L3; */
459 
460  /* We don't use zones */
461  xvid_enc_create.zones = NULL;
462  xvid_enc_create.num_zones = 0;
463 
464  xvid_enc_create.num_threads = avctx->thread_count;
465 
466  xvid_enc_create.plugins = plugins;
467  xvid_enc_create.num_plugins = 0;
468 
469  /* Initialize Buffers */
470  x->twopassbuffer = NULL;
471  x->old_twopassbuffer = NULL;
472  x->twopassfile = NULL;
473 
474  if( xvid_flags & CODEC_FLAG_PASS1 ) {
475  rc2pass1.version = XVID_VERSION;
476  rc2pass1.context = x;
479  if( x->twopassbuffer == NULL || x->old_twopassbuffer == NULL ) {
480  av_log(avctx, AV_LOG_ERROR,
481  "Xvid: Cannot allocate 2-pass log buffers\n");
482  goto fail;
483  }
484  x->twopassbuffer[0] = x->old_twopassbuffer[0] = 0;
485 
486  plugins[xvid_enc_create.num_plugins].func = xvid_ff_2pass;
487  plugins[xvid_enc_create.num_plugins].param = &rc2pass1;
488  xvid_enc_create.num_plugins++;
489  } else if( xvid_flags & CODEC_FLAG_PASS2 ) {
490  rc2pass2.version = XVID_VERSION;
491  rc2pass2.bitrate = avctx->bit_rate;
492 
493  fd = av_tempfile("xvidff.", &x->twopassfile, 0, avctx);
494  if( fd == -1 ) {
495  av_log(avctx, AV_LOG_ERROR,
496  "Xvid: Cannot write 2-pass pipe\n");
497  goto fail;
498  }
499  x->twopassfd = fd;
500 
501  if( avctx->stats_in == NULL ) {
502  av_log(avctx, AV_LOG_ERROR,
503  "Xvid: No 2-pass information loaded for second pass\n");
504  goto fail;
505  }
506 
507  if( strlen(avctx->stats_in) >
508  write(fd, avctx->stats_in, strlen(avctx->stats_in)) ) {
509  av_log(avctx, AV_LOG_ERROR,
510  "Xvid: Cannot write to 2-pass pipe\n");
511  goto fail;
512  }
513 
514  rc2pass2.filename = x->twopassfile;
515  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_2pass2;
516  plugins[xvid_enc_create.num_plugins].param = &rc2pass2;
517  xvid_enc_create.num_plugins++;
518  } else if( !(xvid_flags & CODEC_FLAG_QSCALE) ) {
519  /* Single Pass Bitrate Control! */
520  single.version = XVID_VERSION;
521  single.bitrate = avctx->bit_rate;
522 
523  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_single;
524  plugins[xvid_enc_create.num_plugins].param = &single;
525  xvid_enc_create.num_plugins++;
526  }
527 
528  /* Luminance Masking */
529  if( 0.0 != avctx->lumi_masking ) {
530  plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
531  plugins[xvid_enc_create.num_plugins].param = NULL;
532  xvid_enc_create.num_plugins++;
533  }
534 
535  /* Frame Rate and Key Frames */
536  xvid_correct_framerate(avctx);
537  xvid_enc_create.fincr = avctx->time_base.num;
538  xvid_enc_create.fbase = avctx->time_base.den;
539  if( avctx->gop_size > 0 )
540  xvid_enc_create.max_key_interval = avctx->gop_size;
541  else
542  xvid_enc_create.max_key_interval = 240; /* Xvid's best default */
543 
544  /* Quants */
545  if( xvid_flags & CODEC_FLAG_QSCALE ) x->qscale = 1;
546  else x->qscale = 0;
547 
548  xvid_enc_create.min_quant[0] = avctx->qmin;
549  xvid_enc_create.min_quant[1] = avctx->qmin;
550  xvid_enc_create.min_quant[2] = avctx->qmin;
551  xvid_enc_create.max_quant[0] = avctx->qmax;
552  xvid_enc_create.max_quant[1] = avctx->qmax;
553  xvid_enc_create.max_quant[2] = avctx->qmax;
554 
555  /* Quant Matrices */
556  x->intra_matrix = x->inter_matrix = NULL;
557  if( avctx->mpeg_quant )
558  x->vol_flags |= XVID_VOL_MPEGQUANT;
559  if( (avctx->intra_matrix || avctx->inter_matrix) ) {
560  x->vol_flags |= XVID_VOL_MPEGQUANT;
561 
562  if( avctx->intra_matrix ) {
563  intra = avctx->intra_matrix;
564  x->intra_matrix = av_malloc(sizeof(unsigned char) * 64);
565  } else
566  intra = NULL;
567  if( avctx->inter_matrix ) {
568  inter = avctx->inter_matrix;
569  x->inter_matrix = av_malloc(sizeof(unsigned char) * 64);
570  } else
571  inter = NULL;
572 
573  for( i = 0; i < 64; i++ ) {
574  if( intra )
575  x->intra_matrix[i] = (unsigned char)intra[i];
576  if( inter )
577  x->inter_matrix[i] = (unsigned char)inter[i];
578  }
579  }
580 
581  /* Misc Settings */
582  xvid_enc_create.frame_drop_ratio = 0;
583  xvid_enc_create.global = 0;
584  if( xvid_flags & CODEC_FLAG_CLOSED_GOP )
585  xvid_enc_create.global |= XVID_GLOBAL_CLOSED_GOP;
586 
587  /* Determines which codec mode we are operating in */
588  avctx->extradata = NULL;
589  avctx->extradata_size = 0;
590  if( xvid_flags & CODEC_FLAG_GLOBAL_HEADER ) {
591  /* In this case, we are claiming to be MPEG4 */
592  x->quicktime_format = 1;
593  avctx->codec_id = AV_CODEC_ID_MPEG4;
594  } else {
595  /* We are claiming to be Xvid */
596  x->quicktime_format = 0;
597  if(!avctx->codec_tag)
598  avctx->codec_tag = AV_RL32("xvid");
599  }
600 
601  /* Bframes */
602  xvid_enc_create.max_bframes = avctx->max_b_frames;
603  xvid_enc_create.bquant_offset = 100 * avctx->b_quant_offset;
604  xvid_enc_create.bquant_ratio = 100 * avctx->b_quant_factor;
605  if( avctx->max_b_frames > 0 && !x->quicktime_format ) xvid_enc_create.global |= XVID_GLOBAL_PACKED;
606 
607  /* Create encoder context */
608  xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
609  if( xerr ) {
610  av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
611  goto fail;
612  }
613 
614  x->encoder_handle = xvid_enc_create.handle;
615  avctx->coded_frame = &x->encoded_picture;
616 
617  return 0;
618 fail:
619  xvid_encode_close(avctx);
620  return -1;
621 }
622 
624  const AVFrame *picture, int *got_packet)
625 {
626  int xerr, i, ret, user_packet = !!pkt->data;
627  char *tmp;
628  struct xvid_context *x = avctx->priv_data;
629  AVFrame *p = &x->encoded_picture;
630  int mb_width = (avctx->width + 15) / 16;
631  int mb_height = (avctx->height + 15) / 16;
632 
633  xvid_enc_frame_t xvid_enc_frame = { 0 };
634  xvid_enc_stats_t xvid_enc_stats = { 0 };
635 
636  if ((ret = ff_alloc_packet2(avctx, pkt, mb_width*mb_height*MAX_MB_BYTES + FF_MIN_BUFFER_SIZE)) < 0)
637  return ret;
638 
639  /* Start setting up the frame */
640  xvid_enc_frame.version = XVID_VERSION;
641  xvid_enc_stats.version = XVID_VERSION;
642  *p = *picture;
643 
644  /* Let Xvid know where to put the frame. */
645  xvid_enc_frame.bitstream = pkt->data;
646  xvid_enc_frame.length = pkt->size;
647 
648  /* Initialize input image fields */
649  if( avctx->pix_fmt != AV_PIX_FMT_YUV420P ) {
650  av_log(avctx, AV_LOG_ERROR, "Xvid: Color spaces other than 420p not supported\n");
651  return -1;
652  }
653 
654  xvid_enc_frame.input.csp = XVID_CSP_PLANAR; /* YUV420P */
655 
656  for( i = 0; i < 4; i++ ) {
657  xvid_enc_frame.input.plane[i] = picture->data[i];
658  xvid_enc_frame.input.stride[i] = picture->linesize[i];
659  }
660 
661  /* Encoder Flags */
662  xvid_enc_frame.vop_flags = x->vop_flags;
663  xvid_enc_frame.vol_flags = x->vol_flags;
664  xvid_enc_frame.motion = x->me_flags;
665  xvid_enc_frame.type =
666  picture->pict_type == AV_PICTURE_TYPE_I ? XVID_TYPE_IVOP :
667  picture->pict_type == AV_PICTURE_TYPE_P ? XVID_TYPE_PVOP :
668  picture->pict_type == AV_PICTURE_TYPE_B ? XVID_TYPE_BVOP :
669  XVID_TYPE_AUTO;
670 
671  /* Pixel aspect ratio setting */
672  if (avctx->sample_aspect_ratio.num < 0 || avctx->sample_aspect_ratio.num > 255 ||
673  avctx->sample_aspect_ratio.den < 0 || avctx->sample_aspect_ratio.den > 255) {
674  av_log(avctx, AV_LOG_ERROR, "Invalid pixel aspect ratio %i/%i\n",
676  return -1;
677  }
678  xvid_enc_frame.par = XVID_PAR_EXT;
679  xvid_enc_frame.par_width = avctx->sample_aspect_ratio.num;
680  xvid_enc_frame.par_height = avctx->sample_aspect_ratio.den;
681 
682  /* Quant Setting */
683  if( x->qscale ) xvid_enc_frame.quant = picture->quality / FF_QP2LAMBDA;
684  else xvid_enc_frame.quant = 0;
685 
686  /* Matrices */
687  xvid_enc_frame.quant_intra_matrix = x->intra_matrix;
688  xvid_enc_frame.quant_inter_matrix = x->inter_matrix;
689 
690  /* Encode */
691  xerr = xvid_encore(x->encoder_handle, XVID_ENC_ENCODE,
692  &xvid_enc_frame, &xvid_enc_stats);
693 
694  /* Two-pass log buffer swapping */
695  avctx->stats_out = NULL;
696  if( x->twopassbuffer ) {
697  tmp = x->old_twopassbuffer;
699  x->twopassbuffer = tmp;
700  x->twopassbuffer[0] = 0;
701  if( x->old_twopassbuffer[0] != 0 ) {
702  avctx->stats_out = x->old_twopassbuffer;
703  }
704  }
705 
706  if (xerr > 0) {
707  *got_packet = 1;
708 
709  p->quality = xvid_enc_stats.quant * FF_QP2LAMBDA;
710  if( xvid_enc_stats.type == XVID_TYPE_PVOP )
712  else if( xvid_enc_stats.type == XVID_TYPE_BVOP )
714  else if( xvid_enc_stats.type == XVID_TYPE_SVOP )
716  else
718  if( xvid_enc_frame.out_flags & XVID_KEYFRAME ) {
719  p->key_frame = 1;
720  pkt->flags |= AV_PKT_FLAG_KEY;
721  if( x->quicktime_format )
722  return xvid_strip_vol_header(avctx, pkt,
723  xvid_enc_stats.hlength, xerr);
724  } else
725  p->key_frame = 0;
726 
727  pkt->size = xerr;
728 
729  return 0;
730  } else {
731  if (!user_packet)
732  av_free_packet(pkt);
733  if (!xerr)
734  return 0;
735  av_log(avctx, AV_LOG_ERROR, "Xvid: Encoding Error Occurred: %i\n", xerr);
736  return -1;
737  }
738 }
739 
741  struct xvid_context *x = avctx->priv_data;
742 
743  if(x->encoder_handle)
744  xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
745  x->encoder_handle = NULL;
746 
747  av_freep(&avctx->extradata);
748  if( x->twopassbuffer != NULL ) {
749  av_freep(&x->twopassbuffer);
751  avctx->stats_out = NULL;
752  }
753  if (x->twopassfd>=0) {
754  unlink(x->twopassfile);
755  close(x->twopassfd);
756  x->twopassfd = -1;
757  }
758  av_freep(&x->twopassfile);
759  av_freep(&x->intra_matrix);
760  av_freep(&x->inter_matrix);
761 
762  return 0;
763 }
764 
766  .name = "libxvid",
767  .type = AVMEDIA_TYPE_VIDEO,
768  .id = AV_CODEC_ID_MPEG4,
769  .priv_data_size = sizeof(struct xvid_context),
770  .init = xvid_encode_init,
771  .encode2 = xvid_encode_frame,
772  .close = xvid_encode_close,
773  .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE },
774  .long_name = NULL_IF_CONFIG_SMALL("libxvidcore MPEG-4 part 2"),
775 };
#define AV_CPU_FLAG_ALTIVEC
standard
Definition: cpu.h:52
S(GMC)-VOP MPEG4.
Definition: avutil.h:219
void av_free_packet(AVPacket *pkt)
Free a packet.
Definition: avpacket.c:242
This structure describes decoded (raw) audio or video data.
Definition: frame.h:76
FIXME Range Coding of cr are ref
Definition: snow.txt:367
int mpeg_quant
0-> h263 quant 1-> mpeg quant
char * old_twopassbuffer
Old character buffer (two-pass)
Definition: libxvid.c:61
#define CODEC_FLAG_PASS2
Use internal 2pass ratecontrol in second pass mode.
AVCodec ff_libxvid_encoder
Definition: libxvid.c:765
#define CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
AVFrame * coded_frame
the picture in the bitstream
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...
#define BUFFER_REMAINING(x)
Definition: libxvid.c:43
int num
numerator
Definition: rational.h:44
enhanced predictive zonal search
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown) That is the width of a pixel divided by the height of the pixel...
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
char * stats_in
pass2 encoding statistics input buffer Concatenated stuff from stats_out of pass1 should be placed he...
mpegvideo header.
unsigned char * intra_matrix
P-Frame Quant Matrix.
Definition: libxvid.c:64
int ysize
Frame y size.
Definition: libxvid.c:53
int me_flags
Motion Estimation flags.
Definition: libxvid.c:56
#define CODEC_FLAG_QPEL
Use qpel MC.
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...
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:198
int xsize
Frame x size.
Definition: libxvid.c:52
#define av_cold
Definition: attributes.h:78
#define CODEC_FLAG_GLOBAL_HEADER
Place global headers in extradata instead of every keyframe.
static AVPacket pkt
Definition: demuxing.c:56
static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *picture, int *got_packet)
Definition: libxvid.c:623
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...
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
int quicktime_format
Are we in a QT-based format?
Definition: libxvid.c:58
Misc file utilities.
uint8_t * data
struct xvid_context * context
Pointer to private context.
Definition: libxvid.c:73
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:258
float lumi_masking
luminance masking (0-> disabled)
char * stats_out
pass1 encoding statistics output buffer
#define CODEC_FLAG_AC_PRED
H.263 advanced intra coding / MPEG-4 AC prediction.
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
static int xvid_ff_2pass(void *ref, int cmd, void *p1, void *p2)
Dispatch function for our custom plugin.
Definition: libxvid.c:221
Discrete Time axis x
no search, that is use 0,0 vector whenever one is needed
reserved for experiments
int twopassfd
Definition: libxvid.c:63
int qmax
maximum quantizer
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
int flags
CODEC_FLAG_*.
#define CODEC_FLAG_QSCALE
Use fixed qscale.
int64_t av_gcd(int64_t a, int64_t b)
Return the greatest common divisor of a and b.
Definition: mathematics.c:55
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:246
const char * name
Name of the codec implementation.
external API header
int flags
A combination of AV_PKT_FLAG values.
static int xvid_encode_close(AVCodecContext *avctx)
Definition: libxvid.c:740
char * twopassfile
second pass temp file name
Definition: libxvid.c:62
AVFrame encoded_picture
Encoded frame information.
Definition: libxvid.c:59
#define BUFFER_SIZE
Buffer management macros.
Definition: libxvid.c:42
int vop_flags
VOP flags for Xvid encoder.
Definition: libxvid.c:54
int bit_rate
the average bitrate
Structure for the private first-pass plugin.
Definition: libxvid.c:71
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:144
#define FF_MIN_BUFFER_SIZE
minimum encoding buffer size Used to avoid some checks during header writing.
#define MAX_MB_BYTES
Definition: mpegvideo.h:72
Structure for the private Xvid context.
Definition: libxvid.c:50
ret
Definition: avfilter.c:821
int width
picture width / height.
unsigned char * inter_matrix
I-Frame Quant Matrix.
Definition: libxvid.c:65
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:185
#define AV_RL32
int mb_decision
macroblock decision mode
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int size)
Check AVPacket size and/or allocate data.
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
int av_tempfile(const char *prefix, char **filename, int log_offset, void *log_ctx)
Wrapper to work around the lack of mkstemp() on mingw.
NULL
Definition: eval.c:55
#define BUFFER_CAT(x)
Definition: libxvid.c:44
enum AVCodecID codec_id
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:101
main external API structure.
static void close(AVCodecParserContext *s)
Definition: h264_parser.c:375
int qmin
minimum quantizer
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:148
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> (&#39;D&#39;<<24) + (&#39;C&#39;<<16) + (&#39;B&#39;<<8) + &#39;A&#39;).
uint16_t * intra_matrix
custom intra quantization matrix
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:73
synthesis window for stochastic i
char * twopassbuffer
Character buffer for two-pass.
Definition: libxvid.c:60
float b_quant_offset
qscale offset between IP and B-frames
#define snprintf
Definition: snprintf.h:34
int av_get_cpu_flags(void)
Return the flags which specify extensions supported by the CPU.
Definition: cpu.c:30
static av_cold int xvid_encode_init(AVCodecContext *avctx)
Definition: libxvid.c:348
int version
Xvid version.
Definition: libxvid.c:72
#define CODEC_FLAG_CLOSED_GOP
static av_always_inline av_const float roundf(float x)
Definition: libm.h:169
uint16_t * inter_matrix
custom inter quantization matrix
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:87
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:68
common internal api header.
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:162
#define CODEC_FLAG_GRAY
Only decode/encode grayscale.
int vol_flags
VOL flags for Xvid encoder.
Definition: libxvid.c:55
Bi-dir predicted.
Definition: avutil.h:218
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:95
int trellis
trellis RD quantization
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:142
void * encoder_handle
Handle for Xvid encoder.
Definition: libxvid.c:51
#define CODEC_FLAG_GMC
Use GMC.
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:185
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:139
#define FF_QP2LAMBDA
factor to convert from H.263 QP to lambda
Definition: avutil.h:169
static int xvid_ff_2pass_destroy(struct xvid_context *ref, xvid_plg_destroy_t *param)
Destroy the two-pass plugin context.
Definition: libxvid.c:126
static void xvid_correct_framerate(AVCodecContext *avctx)
Routine to correct a possibly erroneous framerate being fed to us.
Definition: libxvid.c:298
int me_method
Motion estimation algorithm used for video coding.
int qscale
Do we use constant scale?
Definition: libxvid.c:57
#define CODEC_FLAG_4MV
4 MV per MB allowed / advanced prediction for H.263.
AVPixelFormat
Pixel format.
Definition: pixfmt.h:66
This structure stores compressed data.
Predicted.
Definition: avutil.h:217