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