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