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