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