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