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