2 * Interface to xvidcore for MPEG-4 encoding
3 * Copyright (c) 2004 Adam Thayer <krevnik@comcast.net>
5 * This file is part of FFmpeg.
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.
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.
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
24 * Interface to xvidcore for MPEG-4 compliant encoding.
25 * @author Adam Thayer (krevnik@comcast.net)
32 #include "libavutil/avassert.h"
33 #include "libavutil/cpu.h"
34 #include "libavutil/file.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"
44 #include "mpegutils.h"
55 * Buffer management macros.
57 #define BUFFER_SIZE 1024
58 #define BUFFER_REMAINING(x) (BUFFER_SIZE - strlen(x))
59 #define BUFFER_CAT(x) (&((x)[strlen(x)]))
62 * Structure for the private Xvid context.
63 * This stores all the private context for the codec.
67 void *encoder_handle; /**< Handle for Xvid encoder */
68 int xsize; /**< Frame x size */
69 int ysize; /**< Frame y size */
70 int vop_flags; /**< VOP flags for Xvid encoder */
71 int vol_flags; /**< VOL flags for Xvid encoder */
72 int me_flags; /**< Motion Estimation flags */
73 int qscale; /**< Do we use constant scale? */
74 int quicktime_format; /**< Are we in a QT-based format? */
75 char *twopassbuffer; /**< Character buffer for two-pass */
76 char *old_twopassbuffer; /**< Old character buffer (two-pass) */
77 char *twopassfile; /**< second pass temp file name */
79 unsigned char *intra_matrix; /**< P-Frame Quant Matrix */
80 unsigned char *inter_matrix; /**< I-Frame Quant Matrix */
81 int lumi_aq; /**< Lumi masking as an aq method */
82 int variance_aq; /**< Variance adaptive quantization */
83 int ssim; /**< SSIM information display mode */
84 int ssim_acc; /**< SSIM accuracy. 0: accurate. 4: fast. */
86 int me_quality; /**< Motion estimation quality. 0: fast 6: best. */
87 int mpeg_quant; /**< Quantization type. 0: H.263, 1: MPEG */
91 * Structure for the private first-pass plugin.
93 struct xvid_ff_pass1 {
94 int version; /**< Xvid version */
95 struct xvid_context *context; /**< Pointer to private context */
98 static int xvid_encode_close(AVCodecContext *avctx);
99 static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
100 const AVFrame *picture, int *got_packet);
104 * Xvid 2-Pass Kludge Section
106 * Xvid's default 2-pass doesn't allow us to create data as we need to, so
107 * this section spends time replacing the first pass plugin so we can write
108 * statistic information as libavcodec requests in. We have another kludge
109 * that allows us to pass data to the second pass in Xvid without a custom
110 * rate-control plugin.
114 * Initialize the two-pass plugin and context.
116 * @param param Input construction parameter structure
117 * @param handle Private context handle
118 * @return Returns XVID_ERR_xxxx on failure, or 0 on success.
120 static int xvid_ff_2pass_create(xvid_plg_create_t *param, void **handle)
122 struct xvid_ff_pass1 *x = (struct xvid_ff_pass1 *) param->param;
123 char *log = x->context->twopassbuffer;
125 /* Do a quick bounds check */
127 return XVID_ERR_FAIL;
129 /* We use snprintf() */
130 /* This is because we can safely prevent a buffer overflow */
132 snprintf(log, BUFFER_REMAINING(log),
133 "# ffmpeg 2-pass log file, using xvid codec\n");
134 snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
135 "# Do not modify. libxvidcore version: %d.%d.%d\n\n",
136 XVID_VERSION_MAJOR(XVID_VERSION),
137 XVID_VERSION_MINOR(XVID_VERSION),
138 XVID_VERSION_PATCH(XVID_VERSION));
140 *handle = x->context;
145 * Destroy the two-pass plugin context.
147 * @param ref Context pointer for the plugin
148 * @param param Destroy context
149 * @return Returns 0, success guaranteed
151 static int xvid_ff_2pass_destroy(struct xvid_context *ref,
152 xvid_plg_destroy_t *param)
154 /* Currently cannot think of anything to do on destruction */
155 /* Still, the framework should be here for reference/use */
156 if (ref->twopassbuffer)
157 ref->twopassbuffer[0] = 0;
162 * Enable fast encode mode during the first pass.
164 * @param ref Context pointer for the plugin
165 * @param param Frame data
166 * @return Returns 0, success guaranteed
168 static int xvid_ff_2pass_before(struct xvid_context *ref,
169 xvid_plg_data_t *param)
172 int motion_replacements;
175 /* Nothing to do here, result is changed too much */
176 if (param->zone && param->zone->mode == XVID_ZONE_QUANT)
179 /* We can implement a 'turbo' first pass mode here */
183 motion_remove = ~XVID_ME_CHROMA_PVOP &
184 ~XVID_ME_CHROMA_BVOP &
185 ~XVID_ME_EXTSEARCH16 &
186 ~XVID_ME_ADVANCEDDIAMOND16;
187 motion_replacements = XVID_ME_FAST_MODEINTERPOLATE |
188 XVID_ME_SKIP_DELTASEARCH |
189 XVID_ME_FASTREFINE16 |
190 XVID_ME_BFRAME_EARLYSTOP;
191 vop_remove = ~XVID_VOP_MODEDECISION_RD &
192 ~XVID_VOP_FAST_MODEDECISION_RD &
193 ~XVID_VOP_TRELLISQUANT &
197 param->vol_flags &= ~XVID_VOL_GMC;
198 param->vop_flags &= vop_remove;
199 param->motion_flags &= motion_remove;
200 param->motion_flags |= motion_replacements;
206 * Capture statistic data and write it during first pass.
208 * @param ref Context pointer for the plugin
209 * @param param Statistic data
210 * @return Returns XVID_ERR_xxxx on failure, or 0 on success
212 static int xvid_ff_2pass_after(struct xvid_context *ref,
213 xvid_plg_data_t *param)
215 char *log = ref->twopassbuffer;
216 const char *frame_types = " ipbs";
219 /* Quick bounds check */
221 return XVID_ERR_FAIL;
223 /* Convert the type given to us into a character */
224 if (param->type < 5 && param->type > 0)
225 frame_type = frame_types[param->type];
227 return XVID_ERR_FAIL;
229 snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
230 "%c %d %d %d %d %d %d\n",
231 frame_type, param->stats.quant, param->stats.kblks,
232 param->stats.mblks, param->stats.ublks,
233 param->stats.length, param->stats.hlength);
239 * Dispatch function for our custom plugin.
240 * This handles the dispatch for the Xvid plugin. It passes data
241 * on to other functions for actual processing.
243 * @param ref Context pointer for the plugin
244 * @param cmd The task given for us to complete
245 * @param p1 First parameter (varies)
246 * @param p2 Second parameter (varies)
247 * @return Returns XVID_ERR_xxxx on failure, or 0 on success
249 static int xvid_ff_2pass(void *ref, int cmd, void *p1, void *p2)
255 case XVID_PLG_BEFORE:
256 return xvid_ff_2pass_before(ref, p1);
257 case XVID_PLG_CREATE:
258 return xvid_ff_2pass_create(p1, p2);
260 return xvid_ff_2pass_after(ref, p1);
261 case XVID_PLG_DESTROY:
262 return xvid_ff_2pass_destroy(ref, p1);
264 return XVID_ERR_FAIL;
269 * Routine to create a global VO/VOL header for MP4 container.
270 * What we do here is extract the header from the Xvid bitstream
271 * as it is encoded. We also strip the repeated headers from the
272 * bitstream when a global header is requested for MPEG-4 ISO
275 * @param avctx AVCodecContext pointer to context
276 * @param frame Pointer to encoded frame data
277 * @param header_len Length of header to search
278 * @param frame_len Length of encoded frame data
279 * @return Returns new length of frame data
281 static int xvid_strip_vol_header(AVCodecContext *avctx, AVPacket *pkt,
282 unsigned int header_len,
283 unsigned int frame_len)
287 for (i = 0; i < header_len - 3; i++) {
288 if (pkt->data[i] == 0x00 &&
289 pkt->data[i + 1] == 0x00 &&
290 pkt->data[i + 2] == 0x01 &&
291 pkt->data[i + 3] == 0xB6) {
298 /* We need to store the header, so extract it */
299 if (!avctx->extradata) {
300 avctx->extradata = av_malloc(vo_len);
301 if (!avctx->extradata)
302 return AVERROR(ENOMEM);
303 memcpy(avctx->extradata, pkt->data, vo_len);
304 avctx->extradata_size = vo_len;
306 /* Less dangerous now, memmove properly copies the two
307 * chunks of overlapping data */
308 memmove(pkt->data, &pkt->data[vo_len], frame_len - vo_len);
309 pkt->size = frame_len - vo_len;
315 * Routine to correct a possibly erroneous framerate being fed to us.
316 * Xvid currently chokes on framerates where the ticks per frame is
317 * extremely large. This function works to correct problems in this area
318 * by estimating a new framerate and taking the simpler fraction of
321 * @param avctx Context that contains the framerate to correct.
323 static void xvid_correct_framerate(AVCodecContext *avctx)
326 int est_frate, est_fbase;
330 frate = avctx->time_base.den;
331 fbase = avctx->time_base.num;
333 gcd = av_gcd(frate, fbase);
339 if (frate <= 65000 && fbase <= 65000) {
340 avctx->time_base.den = frate;
341 avctx->time_base.num = fbase;
345 fps = (float) frate / (float) fbase;
346 est_fps = roundf(fps * 1000.0) / 1000.0;
348 est_frate = (int) est_fps;
349 if (est_fps > (int) est_fps) {
350 est_frate = (est_frate + 1) * 1000;
351 est_fbase = (int) roundf((float) est_frate / est_fps);
355 gcd = av_gcd(est_frate, est_fbase);
361 if (fbase > est_fbase) {
362 avctx->time_base.den = est_frate;
363 avctx->time_base.num = est_fbase;
364 av_log(avctx, AV_LOG_DEBUG,
365 "Xvid: framerate re-estimated: %.2f, %.3f%% correction\n",
366 est_fps, (((est_fps - fps) / fps) * 100.0));
368 avctx->time_base.den = frate;
369 avctx->time_base.num = fbase;
373 static av_cold int xvid_encode_init(AVCodecContext *avctx)
375 int xerr, i, ret = -1;
376 int xvid_flags = avctx->flags;
377 struct xvid_context *x = avctx->priv_data;
378 uint16_t *intra, *inter;
381 xvid_plugin_single_t single = { 0 };
382 struct xvid_ff_pass1 rc2pass1 = { 0 };
383 xvid_plugin_2pass2_t rc2pass2 = { 0 };
384 xvid_plugin_lumimasking_t masking_l = { 0 }; /* For lumi masking */
385 xvid_plugin_lumimasking_t masking_v = { 0 }; /* For variance AQ */
386 xvid_plugin_ssim_t ssim = { 0 };
387 xvid_gbl_init_t xvid_gbl_init = { 0 };
388 xvid_enc_create_t xvid_enc_create = { 0 };
389 xvid_enc_plugin_t plugins[4];
393 /* Bring in VOP flags from ffmpeg command-line */
394 x->vop_flags = XVID_VOP_HALFPEL; /* Bare minimum quality */
395 if (xvid_flags & AV_CODEC_FLAG_4MV)
396 x->vop_flags |= XVID_VOP_INTER4V; /* Level 3 */
398 x->vop_flags |= XVID_VOP_TRELLISQUANT; /* Level 5 */
399 if (xvid_flags & AV_CODEC_FLAG_AC_PRED)
400 x->vop_flags |= XVID_VOP_HQACPRED; /* Level 6 */
401 if (xvid_flags & AV_CODEC_FLAG_GRAY)
402 x->vop_flags |= XVID_VOP_GREYSCALE;
404 /* Decide which ME quality setting to use */
406 switch (x->me_quality) {
409 x->me_flags |= XVID_ME_EXTSEARCH16 |
413 x->me_flags |= XVID_ME_ADVANCEDDIAMOND8 |
414 XVID_ME_HALFPELREFINE8 |
415 XVID_ME_CHROMA_PVOP |
419 x->me_flags |= XVID_ME_ADVANCEDDIAMOND16 |
420 XVID_ME_HALFPELREFINE16;
423 /* Decide how we should decide blocks */
424 switch (avctx->mb_decision) {
426 x->vop_flags |= XVID_VOP_MODEDECISION_RD;
427 x->me_flags |= XVID_ME_HALFPELREFINE8_RD |
428 XVID_ME_QUARTERPELREFINE8_RD |
429 XVID_ME_EXTSEARCH_RD |
430 XVID_ME_CHECKPREDICTION_RD;
432 if (!(x->vop_flags & XVID_VOP_MODEDECISION_RD))
433 x->vop_flags |= XVID_VOP_FAST_MODEDECISION_RD;
434 x->me_flags |= XVID_ME_HALFPELREFINE16_RD |
435 XVID_ME_QUARTERPELREFINE16_RD;
440 /* Bring in VOL flags from ffmpeg command-line */
443 x->vol_flags |= XVID_VOL_GMC;
444 x->me_flags |= XVID_ME_GME_REFINE;
446 if (xvid_flags & AV_CODEC_FLAG_QPEL) {
447 x->vol_flags |= XVID_VOL_QUARTERPEL;
448 x->me_flags |= XVID_ME_QUARTERPELREFINE16;
449 if (x->vop_flags & XVID_VOP_INTER4V)
450 x->me_flags |= XVID_ME_QUARTERPELREFINE8;
453 xvid_gbl_init.version = XVID_VERSION;
454 xvid_gbl_init.debug = 0;
455 xvid_gbl_init.cpu_flags = 0;
458 xvid_global(NULL, XVID_GBL_INIT, &xvid_gbl_init, NULL);
460 /* Create the encoder reference */
461 xvid_enc_create.version = XVID_VERSION;
463 /* Store the desired frame size */
464 xvid_enc_create.width =
465 x->xsize = avctx->width;
466 xvid_enc_create.height =
467 x->ysize = avctx->height;
469 /* Xvid can determine the proper profile to use */
470 /* xvid_enc_create.profile = XVID_PROFILE_S_L3; */
472 /* We don't use zones */
473 xvid_enc_create.zones = NULL;
474 xvid_enc_create.num_zones = 0;
476 xvid_enc_create.num_threads = avctx->thread_count;
477 #if (XVID_VERSION <= 0x010303) && (XVID_VERSION >= 0x010300)
478 /* workaround for a bug in libxvidcore */
479 if (avctx->height <= 16) {
480 if (avctx->thread_count < 2) {
481 xvid_enc_create.num_threads = 0;
483 av_log(avctx, AV_LOG_ERROR,
484 "Too small height for threads > 1.");
485 return AVERROR(EINVAL);
490 xvid_enc_create.plugins = plugins;
491 xvid_enc_create.num_plugins = 0;
493 /* Initialize Buffers */
494 x->twopassbuffer = NULL;
495 x->old_twopassbuffer = NULL;
496 x->twopassfile = NULL;
498 if (xvid_flags & AV_CODEC_FLAG_PASS1) {
499 rc2pass1.version = XVID_VERSION;
500 rc2pass1.context = x;
501 x->twopassbuffer = av_malloc(BUFFER_SIZE);
502 x->old_twopassbuffer = av_malloc(BUFFER_SIZE);
503 if (!x->twopassbuffer || !x->old_twopassbuffer) {
504 av_log(avctx, AV_LOG_ERROR,
505 "Xvid: Cannot allocate 2-pass log buffers\n");
506 return AVERROR(ENOMEM);
508 x->twopassbuffer[0] =
509 x->old_twopassbuffer[0] = 0;
511 plugins[xvid_enc_create.num_plugins].func = xvid_ff_2pass;
512 plugins[xvid_enc_create.num_plugins].param = &rc2pass1;
513 xvid_enc_create.num_plugins++;
514 } else if (xvid_flags & AV_CODEC_FLAG_PASS2) {
515 rc2pass2.version = XVID_VERSION;
516 rc2pass2.bitrate = avctx->bit_rate;
518 fd = avpriv_tempfile("xvidff.", &x->twopassfile, 0, avctx);
520 av_log(avctx, AV_LOG_ERROR, "Xvid: Cannot write 2-pass pipe\n");
525 if (!avctx->stats_in) {
526 av_log(avctx, AV_LOG_ERROR,
527 "Xvid: No 2-pass information loaded for second pass\n");
528 return AVERROR(EINVAL);
531 ret = write(fd, avctx->stats_in, strlen(avctx->stats_in));
533 ret = AVERROR(errno);
534 else if (strlen(avctx->stats_in) > ret) {
535 av_log(avctx, AV_LOG_ERROR, "Xvid: Cannot write to 2-pass pipe\n");
541 rc2pass2.filename = x->twopassfile;
542 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_2pass2;
543 plugins[xvid_enc_create.num_plugins].param = &rc2pass2;
544 xvid_enc_create.num_plugins++;
545 } else if (!(xvid_flags & AV_CODEC_FLAG_QSCALE)) {
546 /* Single Pass Bitrate Control! */
547 single.version = XVID_VERSION;
548 single.bitrate = avctx->bit_rate;
550 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_single;
551 plugins[xvid_enc_create.num_plugins].param = &single;
552 xvid_enc_create.num_plugins++;
555 if (avctx->lumi_masking != 0.0)
558 /* Luminance Masking */
560 masking_l.method = 0;
561 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
563 /* The old behavior is that when avctx->lumi_masking is specified,
564 * plugins[...].param = NULL. Trying to keep the old behavior here. */
565 plugins[xvid_enc_create.num_plugins].param =
566 avctx->lumi_masking ? NULL : &masking_l;
567 xvid_enc_create.num_plugins++;
571 if (x->variance_aq) {
572 masking_v.method = 1;
573 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
574 plugins[xvid_enc_create.num_plugins].param = &masking_v;
575 xvid_enc_create.num_plugins++;
578 if (x->lumi_aq && x->variance_aq )
579 av_log(avctx, AV_LOG_INFO,
580 "Both lumi_aq and variance_aq are enabled. The resulting quality"
581 "will be the worse one of the two effects made by the AQ.\n");
585 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_ssim;
586 ssim.b_printstat = x->ssim == 2;
587 ssim.acc = x->ssim_acc;
588 ssim.cpu_flags = xvid_gbl_init.cpu_flags;
589 ssim.b_visualize = 0;
590 plugins[xvid_enc_create.num_plugins].param = &ssim;
591 xvid_enc_create.num_plugins++;
594 /* Frame Rate and Key Frames */
595 xvid_correct_framerate(avctx);
596 xvid_enc_create.fincr = avctx->time_base.num;
597 xvid_enc_create.fbase = avctx->time_base.den;
598 if (avctx->gop_size > 0)
599 xvid_enc_create.max_key_interval = avctx->gop_size;
601 xvid_enc_create.max_key_interval = 240; /* Xvid's best default */
604 if (xvid_flags & AV_CODEC_FLAG_QSCALE)
609 xvid_enc_create.min_quant[0] = avctx->qmin;
610 xvid_enc_create.min_quant[1] = avctx->qmin;
611 xvid_enc_create.min_quant[2] = avctx->qmin;
612 xvid_enc_create.max_quant[0] = avctx->qmax;
613 xvid_enc_create.max_quant[1] = avctx->qmax;
614 xvid_enc_create.max_quant[2] = avctx->qmax;
618 x->inter_matrix = NULL;
620 #if FF_API_PRIVATE_OPT
621 FF_DISABLE_DEPRECATION_WARNINGS
622 if (avctx->mpeg_quant)
623 x->mpeg_quant = avctx->mpeg_quant;
624 FF_ENABLE_DEPRECATION_WARNINGS
628 x->vol_flags |= XVID_VOL_MPEGQUANT;
629 if ((avctx->intra_matrix || avctx->inter_matrix)) {
630 x->vol_flags |= XVID_VOL_MPEGQUANT;
632 if (avctx->intra_matrix) {
633 intra = avctx->intra_matrix;
634 x->intra_matrix = av_malloc(sizeof(unsigned char) * 64);
635 if (!x->intra_matrix)
636 return AVERROR(ENOMEM);
639 if (avctx->inter_matrix) {
640 inter = avctx->inter_matrix;
641 x->inter_matrix = av_malloc(sizeof(unsigned char) * 64);
642 if (!x->inter_matrix)
643 return AVERROR(ENOMEM);
647 for (i = 0; i < 64; i++) {
649 x->intra_matrix[i] = (unsigned char) intra[i];
651 x->inter_matrix[i] = (unsigned char) inter[i];
656 xvid_enc_create.frame_drop_ratio = 0;
657 xvid_enc_create.global = 0;
658 if (xvid_flags & AV_CODEC_FLAG_CLOSED_GOP)
659 xvid_enc_create.global |= XVID_GLOBAL_CLOSED_GOP;
661 /* Determines which codec mode we are operating in */
662 avctx->extradata = NULL;
663 avctx->extradata_size = 0;
664 if (xvid_flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
665 /* In this case, we are claiming to be MPEG-4 */
666 x->quicktime_format = 1;
667 avctx->codec_id = AV_CODEC_ID_MPEG4;
669 /* We are claiming to be Xvid */
670 x->quicktime_format = 0;
671 if (!avctx->codec_tag)
672 avctx->codec_tag = AV_RL32("xvid");
676 xvid_enc_create.max_bframes = avctx->max_b_frames;
677 xvid_enc_create.bquant_offset = 100 * avctx->b_quant_offset;
678 xvid_enc_create.bquant_ratio = 100 * avctx->b_quant_factor;
679 if (avctx->max_b_frames > 0 && !x->quicktime_format)
680 xvid_enc_create.global |= XVID_GLOBAL_PACKED;
682 av_assert0(xvid_enc_create.num_plugins + (!!x->ssim) + (!!x->variance_aq) + (!!x->lumi_aq) <= FF_ARRAY_ELEMS(plugins));
684 /* Encode a dummy frame to get the extradata immediately */
685 if (x->quicktime_format) {
687 AVPacket packet = {0};
688 int size, got_packet, ret;
690 av_init_packet(&packet);
692 picture = av_frame_alloc();
694 return AVERROR(ENOMEM);
696 xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
698 av_frame_free(&picture);
699 av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
700 return AVERROR_EXTERNAL;
702 x->encoder_handle = xvid_enc_create.handle;
703 size = ((avctx->width + 1) & ~1) * ((avctx->height + 1) & ~1);
704 picture->data[0] = av_malloc(size + size / 2);
705 if (!picture->data[0]) {
706 av_frame_free(&picture);
707 return AVERROR(ENOMEM);
709 picture->data[1] = picture->data[0] + size;
710 picture->data[2] = picture->data[1] + size / 4;
711 memset(picture->data[0], 0, size);
712 memset(picture->data[1], 128, size / 2);
713 ret = xvid_encode_frame(avctx, &packet, picture, &got_packet);
714 if (!ret && got_packet)
715 av_packet_unref(&packet);
716 av_free(picture->data[0]);
717 av_frame_free(&picture);
718 xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
721 /* Create encoder context */
722 xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
724 av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
725 return AVERROR_EXTERNAL;
728 x->encoder_handle = xvid_enc_create.handle;
733 static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
734 const AVFrame *picture, int *got_packet)
736 int xerr, i, ret, user_packet = !!pkt->data;
737 struct xvid_context *x = avctx->priv_data;
738 int mb_width = (avctx->width + 15) / 16;
739 int mb_height = (avctx->height + 15) / 16;
742 xvid_enc_frame_t xvid_enc_frame = { 0 };
743 xvid_enc_stats_t xvid_enc_stats = { 0 };
745 if ((ret = ff_alloc_packet2(avctx, pkt, mb_width*(int64_t)mb_height*MAX_MB_BYTES + AV_INPUT_BUFFER_MIN_SIZE, 0)) < 0)
748 /* Start setting up the frame */
749 xvid_enc_frame.version = XVID_VERSION;
750 xvid_enc_stats.version = XVID_VERSION;
752 /* Let Xvid know where to put the frame. */
753 xvid_enc_frame.bitstream = pkt->data;
754 xvid_enc_frame.length = pkt->size;
756 /* Initialize input image fields */
757 if (avctx->pix_fmt != AV_PIX_FMT_YUV420P) {
758 av_log(avctx, AV_LOG_ERROR,
759 "Xvid: Color spaces other than 420P not supported\n");
760 return AVERROR(EINVAL);
763 xvid_enc_frame.input.csp = XVID_CSP_PLANAR; /* YUV420P */
765 for (i = 0; i < 4; i++) {
766 xvid_enc_frame.input.plane[i] = picture->data[i];
767 xvid_enc_frame.input.stride[i] = picture->linesize[i];
771 xvid_enc_frame.vop_flags = x->vop_flags;
772 xvid_enc_frame.vol_flags = x->vol_flags;
773 xvid_enc_frame.motion = x->me_flags;
774 xvid_enc_frame.type =
775 picture->pict_type == AV_PICTURE_TYPE_I ? XVID_TYPE_IVOP :
776 picture->pict_type == AV_PICTURE_TYPE_P ? XVID_TYPE_PVOP :
777 picture->pict_type == AV_PICTURE_TYPE_B ? XVID_TYPE_BVOP :
780 /* Pixel aspect ratio setting */
781 if (avctx->sample_aspect_ratio.num < 0 || avctx->sample_aspect_ratio.num > 255 ||
782 avctx->sample_aspect_ratio.den < 0 || avctx->sample_aspect_ratio.den > 255) {
783 av_log(avctx, AV_LOG_WARNING,
784 "Invalid pixel aspect ratio %i/%i, limit is 255/255 reducing\n",
785 avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den);
786 av_reduce(&avctx->sample_aspect_ratio.num, &avctx->sample_aspect_ratio.den,
787 avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den, 255);
789 xvid_enc_frame.par = XVID_PAR_EXT;
790 xvid_enc_frame.par_width = avctx->sample_aspect_ratio.num;
791 xvid_enc_frame.par_height = avctx->sample_aspect_ratio.den;
795 xvid_enc_frame.quant = picture->quality / FF_QP2LAMBDA;
797 xvid_enc_frame.quant = 0;
800 xvid_enc_frame.quant_intra_matrix = x->intra_matrix;
801 xvid_enc_frame.quant_inter_matrix = x->inter_matrix;
804 xerr = xvid_encore(x->encoder_handle, XVID_ENC_ENCODE,
805 &xvid_enc_frame, &xvid_enc_stats);
807 /* Two-pass log buffer swapping */
808 avctx->stats_out = NULL;
809 if (x->twopassbuffer) {
810 tmp = x->old_twopassbuffer;
811 x->old_twopassbuffer = x->twopassbuffer;
812 x->twopassbuffer = tmp;
813 x->twopassbuffer[0] = 0;
814 if (x->old_twopassbuffer[0] != 0) {
815 avctx->stats_out = x->old_twopassbuffer;
824 if (xvid_enc_stats.type == XVID_TYPE_PVOP)
825 pict_type = AV_PICTURE_TYPE_P;
826 else if (xvid_enc_stats.type == XVID_TYPE_BVOP)
827 pict_type = AV_PICTURE_TYPE_B;
828 else if (xvid_enc_stats.type == XVID_TYPE_SVOP)
829 pict_type = AV_PICTURE_TYPE_S;
831 pict_type = AV_PICTURE_TYPE_I;
833 #if FF_API_CODED_FRAME
834 FF_DISABLE_DEPRECATION_WARNINGS
835 avctx->coded_frame->pict_type = pict_type;
836 avctx->coded_frame->quality = xvid_enc_stats.quant * FF_QP2LAMBDA;
837 FF_ENABLE_DEPRECATION_WARNINGS
840 ff_side_data_set_encoder_stats(pkt, xvid_enc_stats.quant * FF_QP2LAMBDA, NULL, 0, pict_type);
842 if (xvid_enc_frame.out_flags & XVID_KEYFRAME) {
843 #if FF_API_CODED_FRAME
844 FF_DISABLE_DEPRECATION_WARNINGS
845 avctx->coded_frame->key_frame = 1;
846 FF_ENABLE_DEPRECATION_WARNINGS
848 pkt->flags |= AV_PKT_FLAG_KEY;
849 if (x->quicktime_format)
850 return xvid_strip_vol_header(avctx, pkt,
851 xvid_enc_stats.hlength, xerr);
853 #if FF_API_CODED_FRAME
854 FF_DISABLE_DEPRECATION_WARNINGS
855 avctx->coded_frame->key_frame = 0;
856 FF_ENABLE_DEPRECATION_WARNINGS
865 av_packet_unref(pkt);
868 av_log(avctx, AV_LOG_ERROR,
869 "Xvid: Encoding Error Occurred: %i\n", xerr);
870 return AVERROR_EXTERNAL;
874 static av_cold int xvid_encode_close(AVCodecContext *avctx)
876 struct xvid_context *x = avctx->priv_data;
878 if (x->encoder_handle) {
879 xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
880 x->encoder_handle = NULL;
883 av_freep(&avctx->extradata);
884 if (x->twopassbuffer) {
885 av_freep(&x->twopassbuffer);
886 av_freep(&x->old_twopassbuffer);
887 avctx->stats_out = NULL;
889 if (x->twopassfd>=0) {
890 unlink(x->twopassfile);
894 av_freep(&x->twopassfile);
895 av_freep(&x->intra_matrix);
896 av_freep(&x->inter_matrix);
901 #define OFFSET(x) offsetof(struct xvid_context, x)
902 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
903 static const AVOption options[] = {
904 { "lumi_aq", "Luminance masking AQ", OFFSET(lumi_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
905 { "variance_aq", "Variance AQ", OFFSET(variance_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
906 { "ssim", "Show SSIM information to stdout", OFFSET(ssim), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 2, VE, "ssim" },
907 { "off", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, INT_MIN, INT_MAX, VE, "ssim" },
908 { "avg", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, INT_MIN, INT_MAX, VE, "ssim" },
909 { "frame", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 2 }, INT_MIN, INT_MAX, VE, "ssim" },
910 { "ssim_acc", "SSIM accuracy", OFFSET(ssim_acc), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, 4, VE },
911 { "gmc", "use GMC", OFFSET(gmc), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
912 { "me_quality", "Motion estimation quality", OFFSET(me_quality), AV_OPT_TYPE_INT, { .i64 = 4 }, 0, 6, VE },
913 { "mpeg_quant", "Use MPEG quantizers instead of H.263", OFFSET(mpeg_quant), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
917 static const AVClass xvid_class = {
918 .class_name = "libxvid",
919 .item_name = av_default_item_name,
921 .version = LIBAVUTIL_VERSION_INT,
924 AVCodec ff_libxvid_encoder = {
926 .long_name = NULL_IF_CONFIG_SMALL("libxvidcore MPEG-4 part 2"),
927 .type = AVMEDIA_TYPE_VIDEO,
928 .id = AV_CODEC_ID_MPEG4,
929 .priv_data_size = sizeof(struct xvid_context),
930 .init = xvid_encode_init,
931 .encode2 = xvid_encode_frame,
932 .close = xvid_encode_close,
933 .pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE },
934 .priv_class = &xvid_class,
935 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
936 FF_CODEC_CAP_INIT_CLEANUP,