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