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