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"
45 #include "packet_internal.h"
56 * Buffer management macros.
58 #define BUFFER_SIZE 1024
59 #define BUFFER_REMAINING(x) (BUFFER_SIZE - strlen(x))
60 #define BUFFER_CAT(x) (&((x)[strlen(x)]))
63 * Structure for the private Xvid context.
64 * This stores all the private context for the codec.
68 void *encoder_handle; /**< Handle for Xvid encoder */
69 int xsize; /**< Frame x size */
70 int ysize; /**< Frame y size */
71 int vop_flags; /**< VOP flags for Xvid encoder */
72 int vol_flags; /**< VOL flags for Xvid encoder */
73 int me_flags; /**< Motion Estimation flags */
74 int qscale; /**< Do we use constant scale? */
75 int quicktime_format; /**< Are we in a QT-based format? */
76 char *twopassbuffer; /**< Character buffer for two-pass */
77 char *old_twopassbuffer; /**< Old character buffer (two-pass) */
78 char *twopassfile; /**< second pass temp file name */
80 unsigned char *intra_matrix; /**< P-Frame Quant Matrix */
81 unsigned char *inter_matrix; /**< I-Frame Quant Matrix */
82 int lumi_aq; /**< Lumi masking as an aq method */
83 int variance_aq; /**< Variance adaptive quantization */
84 int ssim; /**< SSIM information display mode */
85 int ssim_acc; /**< SSIM accuracy. 0: accurate. 4: fast. */
87 int me_quality; /**< Motion estimation quality. 0: fast 6: best. */
88 int mpeg_quant; /**< Quantization type. 0: H.263, 1: MPEG */
92 * Structure for the private first-pass plugin.
94 struct xvid_ff_pass1 {
95 int version; /**< Xvid version */
96 struct xvid_context *context; /**< Pointer to private context */
99 static int xvid_encode_close(AVCodecContext *avctx);
100 static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
101 const AVFrame *picture, int *got_packet);
105 * Xvid 2-Pass Kludge Section
107 * Xvid's default 2-pass doesn't allow us to create data as we need to, so
108 * this section spends time replacing the first pass plugin so we can write
109 * statistic information as libavcodec requests in. We have another kludge
110 * that allows us to pass data to the second pass in Xvid without a custom
111 * rate-control plugin.
115 * Initialize the two-pass plugin and context.
117 * @param param Input construction parameter structure
118 * @param handle Private context handle
119 * @return Returns XVID_ERR_xxxx on failure, or 0 on success.
121 static int xvid_ff_2pass_create(xvid_plg_create_t *param, void **handle)
123 struct xvid_ff_pass1 *x = (struct xvid_ff_pass1 *) param->param;
124 char *log = x->context->twopassbuffer;
126 /* Do a quick bounds check */
128 return XVID_ERR_FAIL;
130 /* We use snprintf() */
131 /* This is because we can safely prevent a buffer overflow */
133 snprintf(log, BUFFER_REMAINING(log),
134 "# ffmpeg 2-pass log file, using xvid codec\n");
135 snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
136 "# Do not modify. libxvidcore version: %d.%d.%d\n\n",
137 XVID_VERSION_MAJOR(XVID_VERSION),
138 XVID_VERSION_MINOR(XVID_VERSION),
139 XVID_VERSION_PATCH(XVID_VERSION));
141 *handle = x->context;
146 * Destroy the two-pass plugin context.
148 * @param ref Context pointer for the plugin
149 * @param param Destroy context
150 * @return Returns 0, success guaranteed
152 static int xvid_ff_2pass_destroy(struct xvid_context *ref,
153 xvid_plg_destroy_t *param)
155 /* Currently cannot think of anything to do on destruction */
156 /* Still, the framework should be here for reference/use */
157 if (ref->twopassbuffer)
158 ref->twopassbuffer[0] = 0;
163 * Enable fast encode mode during the first pass.
165 * @param ref Context pointer for the plugin
166 * @param param Frame data
167 * @return Returns 0, success guaranteed
169 static int xvid_ff_2pass_before(struct xvid_context *ref,
170 xvid_plg_data_t *param)
173 int motion_replacements;
176 /* Nothing to do here, result is changed too much */
177 if (param->zone && param->zone->mode == XVID_ZONE_QUANT)
180 /* We can implement a 'turbo' first pass mode here */
184 motion_remove = ~XVID_ME_CHROMA_PVOP &
185 ~XVID_ME_CHROMA_BVOP &
186 ~XVID_ME_EXTSEARCH16 &
187 ~XVID_ME_ADVANCEDDIAMOND16;
188 motion_replacements = XVID_ME_FAST_MODEINTERPOLATE |
189 XVID_ME_SKIP_DELTASEARCH |
190 XVID_ME_FASTREFINE16 |
191 XVID_ME_BFRAME_EARLYSTOP;
192 vop_remove = ~XVID_VOP_MODEDECISION_RD &
193 ~XVID_VOP_FAST_MODEDECISION_RD &
194 ~XVID_VOP_TRELLISQUANT &
198 param->vol_flags &= ~XVID_VOL_GMC;
199 param->vop_flags &= vop_remove;
200 param->motion_flags &= motion_remove;
201 param->motion_flags |= motion_replacements;
207 * Capture statistic data and write it during first pass.
209 * @param ref Context pointer for the plugin
210 * @param param Statistic data
211 * @return Returns XVID_ERR_xxxx on failure, or 0 on success
213 static int xvid_ff_2pass_after(struct xvid_context *ref,
214 xvid_plg_data_t *param)
216 char *log = ref->twopassbuffer;
217 const char *frame_types = " ipbs";
220 /* Quick bounds check */
222 return XVID_ERR_FAIL;
224 /* Convert the type given to us into a character */
225 if (param->type < 5 && param->type > 0)
226 frame_type = frame_types[param->type];
228 return XVID_ERR_FAIL;
230 snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
231 "%c %d %d %d %d %d %d\n",
232 frame_type, param->stats.quant, param->stats.kblks,
233 param->stats.mblks, param->stats.ublks,
234 param->stats.length, param->stats.hlength);
240 * Dispatch function for our custom plugin.
241 * This handles the dispatch for the Xvid plugin. It passes data
242 * on to other functions for actual processing.
244 * @param ref Context pointer for the plugin
245 * @param cmd The task given for us to complete
246 * @param p1 First parameter (varies)
247 * @param p2 Second parameter (varies)
248 * @return Returns XVID_ERR_xxxx on failure, or 0 on success
250 static int xvid_ff_2pass(void *ref, int cmd, void *p1, void *p2)
256 case XVID_PLG_BEFORE:
257 return xvid_ff_2pass_before(ref, p1);
258 case XVID_PLG_CREATE:
259 return xvid_ff_2pass_create(p1, p2);
261 return xvid_ff_2pass_after(ref, p1);
262 case XVID_PLG_DESTROY:
263 return xvid_ff_2pass_destroy(ref, p1);
265 return XVID_ERR_FAIL;
270 * Routine to create a global VO/VOL header for MP4 container.
271 * What we do here is extract the header from the Xvid bitstream
272 * as it is encoded. We also strip the repeated headers from the
273 * bitstream when a global header is requested for MPEG-4 ISO
276 * @param avctx AVCodecContext pointer to context
277 * @param frame Pointer to encoded frame data
278 * @param header_len Length of header to search
279 * @param frame_len Length of encoded frame data
280 * @return Returns new length of frame data
282 static int xvid_strip_vol_header(AVCodecContext *avctx, AVPacket *pkt,
283 unsigned int header_len,
284 unsigned int frame_len)
288 for (i = 0; i < header_len - 3; i++) {
289 if (pkt->data[i] == 0x00 &&
290 pkt->data[i + 1] == 0x00 &&
291 pkt->data[i + 2] == 0x01 &&
292 pkt->data[i + 3] == 0xB6) {
299 /* We need to store the header, so extract it */
300 if (!avctx->extradata) {
301 avctx->extradata = av_malloc(vo_len);
302 if (!avctx->extradata)
303 return AVERROR(ENOMEM);
304 memcpy(avctx->extradata, pkt->data, vo_len);
305 avctx->extradata_size = vo_len;
307 /* Less dangerous now, memmove properly copies the two
308 * chunks of overlapping data */
309 memmove(pkt->data, &pkt->data[vo_len], frame_len - vo_len);
310 pkt->size = frame_len - vo_len;
316 * Routine to correct a possibly erroneous framerate being fed to us.
317 * Xvid currently chokes on framerates where the ticks per frame is
318 * extremely large. This function works to correct problems in this area
319 * by estimating a new framerate and taking the simpler fraction of
322 * @param avctx Context that contains the framerate to correct.
324 static void xvid_correct_framerate(AVCodecContext *avctx)
327 int est_frate, est_fbase;
331 frate = avctx->time_base.den;
332 fbase = avctx->time_base.num;
334 gcd = av_gcd(frate, fbase);
340 if (frate <= 65000 && fbase <= 65000) {
341 avctx->time_base.den = frate;
342 avctx->time_base.num = fbase;
346 fps = (float) frate / (float) fbase;
347 est_fps = roundf(fps * 1000.0) / 1000.0;
349 est_frate = (int) est_fps;
350 if (est_fps > (int) est_fps) {
351 est_frate = (est_frate + 1) * 1000;
352 est_fbase = (int) roundf((float) est_frate / est_fps);
356 gcd = av_gcd(est_frate, est_fbase);
362 if (fbase > est_fbase) {
363 avctx->time_base.den = est_frate;
364 avctx->time_base.num = est_fbase;
365 av_log(avctx, AV_LOG_DEBUG,
366 "Xvid: framerate re-estimated: %.2f, %.3f%% correction\n",
367 est_fps, (((est_fps - fps) / fps) * 100.0));
369 avctx->time_base.den = frate;
370 avctx->time_base.num = fbase;
374 static av_cold int xvid_encode_init(AVCodecContext *avctx)
376 int xerr, i, ret = -1;
377 int xvid_flags = avctx->flags;
378 struct xvid_context *x = avctx->priv_data;
379 uint16_t *intra, *inter;
382 xvid_plugin_single_t single = { 0 };
383 struct xvid_ff_pass1 rc2pass1 = { 0 };
384 xvid_plugin_2pass2_t rc2pass2 = { 0 };
385 xvid_plugin_lumimasking_t masking_l = { 0 }; /* For lumi masking */
386 xvid_plugin_lumimasking_t masking_v = { 0 }; /* For variance AQ */
387 xvid_plugin_ssim_t ssim = { 0 };
388 xvid_gbl_init_t xvid_gbl_init = { 0 };
389 xvid_enc_create_t xvid_enc_create = { 0 };
390 xvid_enc_plugin_t plugins[4];
394 /* Bring in VOP flags from ffmpeg command-line */
395 x->vop_flags = XVID_VOP_HALFPEL; /* Bare minimum quality */
396 if (xvid_flags & AV_CODEC_FLAG_4MV)
397 x->vop_flags |= XVID_VOP_INTER4V; /* Level 3 */
399 x->vop_flags |= XVID_VOP_TRELLISQUANT; /* Level 5 */
400 if (xvid_flags & AV_CODEC_FLAG_AC_PRED)
401 x->vop_flags |= XVID_VOP_HQACPRED; /* Level 6 */
402 if (xvid_flags & AV_CODEC_FLAG_GRAY)
403 x->vop_flags |= XVID_VOP_GREYSCALE;
405 /* Decide which ME quality setting to use */
407 switch (x->me_quality) {
410 x->me_flags |= XVID_ME_EXTSEARCH16 |
414 x->me_flags |= XVID_ME_ADVANCEDDIAMOND8 |
415 XVID_ME_HALFPELREFINE8 |
416 XVID_ME_CHROMA_PVOP |
420 x->me_flags |= XVID_ME_ADVANCEDDIAMOND16 |
421 XVID_ME_HALFPELREFINE16;
424 /* Decide how we should decide blocks */
425 switch (avctx->mb_decision) {
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;
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;
441 /* Bring in VOL flags from ffmpeg command-line */
444 x->vol_flags |= XVID_VOL_GMC;
445 x->me_flags |= XVID_ME_GME_REFINE;
447 if (xvid_flags & AV_CODEC_FLAG_QPEL) {
448 x->vol_flags |= XVID_VOL_QUARTERPEL;
449 x->me_flags |= XVID_ME_QUARTERPELREFINE16;
450 if (x->vop_flags & XVID_VOP_INTER4V)
451 x->me_flags |= XVID_ME_QUARTERPELREFINE8;
454 xvid_gbl_init.version = XVID_VERSION;
455 xvid_gbl_init.debug = 0;
456 xvid_gbl_init.cpu_flags = 0;
459 xvid_global(NULL, XVID_GBL_INIT, &xvid_gbl_init, NULL);
461 /* Create the encoder reference */
462 xvid_enc_create.version = XVID_VERSION;
464 /* Store the desired frame size */
465 xvid_enc_create.width =
466 x->xsize = avctx->width;
467 xvid_enc_create.height =
468 x->ysize = avctx->height;
470 /* Xvid can determine the proper profile to use */
471 /* xvid_enc_create.profile = XVID_PROFILE_S_L3; */
473 /* We don't use zones */
474 xvid_enc_create.zones = NULL;
475 xvid_enc_create.num_zones = 0;
477 xvid_enc_create.num_threads = avctx->thread_count;
478 #if (XVID_VERSION <= 0x010303) && (XVID_VERSION >= 0x010300)
479 /* workaround for a bug in libxvidcore */
480 if (avctx->height <= 16) {
481 if (avctx->thread_count < 2) {
482 xvid_enc_create.num_threads = 0;
484 av_log(avctx, AV_LOG_ERROR,
485 "Too small height for threads > 1.");
486 return AVERROR(EINVAL);
491 xvid_enc_create.plugins = plugins;
492 xvid_enc_create.num_plugins = 0;
494 /* Initialize Buffers */
495 x->twopassbuffer = NULL;
496 x->old_twopassbuffer = NULL;
497 x->twopassfile = NULL;
499 if (xvid_flags & AV_CODEC_FLAG_PASS1) {
500 rc2pass1.version = XVID_VERSION;
501 rc2pass1.context = x;
502 x->twopassbuffer = av_malloc(BUFFER_SIZE);
503 x->old_twopassbuffer = av_malloc(BUFFER_SIZE);
504 if (!x->twopassbuffer || !x->old_twopassbuffer) {
505 av_log(avctx, AV_LOG_ERROR,
506 "Xvid: Cannot allocate 2-pass log buffers\n");
507 return AVERROR(ENOMEM);
509 x->twopassbuffer[0] =
510 x->old_twopassbuffer[0] = 0;
512 plugins[xvid_enc_create.num_plugins].func = xvid_ff_2pass;
513 plugins[xvid_enc_create.num_plugins].param = &rc2pass1;
514 xvid_enc_create.num_plugins++;
515 } else if (xvid_flags & AV_CODEC_FLAG_PASS2) {
516 rc2pass2.version = XVID_VERSION;
517 rc2pass2.bitrate = avctx->bit_rate;
519 fd = avpriv_tempfile("xvidff.", &x->twopassfile, 0, avctx);
521 av_log(avctx, AV_LOG_ERROR, "Xvid: Cannot write 2-pass pipe\n");
526 if (!avctx->stats_in) {
527 av_log(avctx, AV_LOG_ERROR,
528 "Xvid: No 2-pass information loaded for second pass\n");
529 return AVERROR(EINVAL);
532 ret = write(fd, avctx->stats_in, strlen(avctx->stats_in));
534 ret = AVERROR(errno);
535 else if (strlen(avctx->stats_in) > ret) {
536 av_log(avctx, AV_LOG_ERROR, "Xvid: Cannot write to 2-pass pipe\n");
542 rc2pass2.filename = x->twopassfile;
543 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_2pass2;
544 plugins[xvid_enc_create.num_plugins].param = &rc2pass2;
545 xvid_enc_create.num_plugins++;
546 } else if (!(xvid_flags & AV_CODEC_FLAG_QSCALE)) {
547 /* Single Pass Bitrate Control! */
548 single.version = XVID_VERSION;
549 single.bitrate = avctx->bit_rate;
551 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_single;
552 plugins[xvid_enc_create.num_plugins].param = &single;
553 xvid_enc_create.num_plugins++;
556 if (avctx->lumi_masking != 0.0)
559 /* Luminance Masking */
561 masking_l.method = 0;
562 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
564 /* The old behavior is that when avctx->lumi_masking is specified,
565 * plugins[...].param = NULL. Trying to keep the old behavior here. */
566 plugins[xvid_enc_create.num_plugins].param =
567 avctx->lumi_masking ? NULL : &masking_l;
568 xvid_enc_create.num_plugins++;
572 if (x->variance_aq) {
573 masking_v.method = 1;
574 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
575 plugins[xvid_enc_create.num_plugins].param = &masking_v;
576 xvid_enc_create.num_plugins++;
579 if (x->lumi_aq && x->variance_aq )
580 av_log(avctx, AV_LOG_INFO,
581 "Both lumi_aq and variance_aq are enabled. The resulting quality"
582 "will be the worse one of the two effects made by the AQ.\n");
586 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_ssim;
587 ssim.b_printstat = x->ssim == 2;
588 ssim.acc = x->ssim_acc;
589 ssim.cpu_flags = xvid_gbl_init.cpu_flags;
590 ssim.b_visualize = 0;
591 plugins[xvid_enc_create.num_plugins].param = &ssim;
592 xvid_enc_create.num_plugins++;
595 /* Frame Rate and Key Frames */
596 xvid_correct_framerate(avctx);
597 xvid_enc_create.fincr = avctx->time_base.num;
598 xvid_enc_create.fbase = avctx->time_base.den;
599 if (avctx->gop_size > 0)
600 xvid_enc_create.max_key_interval = avctx->gop_size;
602 xvid_enc_create.max_key_interval = 240; /* Xvid's best default */
605 if (xvid_flags & AV_CODEC_FLAG_QSCALE)
610 xvid_enc_create.min_quant[0] = avctx->qmin;
611 xvid_enc_create.min_quant[1] = avctx->qmin;
612 xvid_enc_create.min_quant[2] = avctx->qmin;
613 xvid_enc_create.max_quant[0] = avctx->qmax;
614 xvid_enc_create.max_quant[1] = avctx->qmax;
615 xvid_enc_create.max_quant[2] = avctx->qmax;
619 x->inter_matrix = NULL;
621 #if FF_API_PRIVATE_OPT
622 FF_DISABLE_DEPRECATION_WARNINGS
623 if (avctx->mpeg_quant)
624 x->mpeg_quant = avctx->mpeg_quant;
625 FF_ENABLE_DEPRECATION_WARNINGS
629 x->vol_flags |= XVID_VOL_MPEGQUANT;
630 if ((avctx->intra_matrix || avctx->inter_matrix)) {
631 x->vol_flags |= XVID_VOL_MPEGQUANT;
633 if (avctx->intra_matrix) {
634 intra = avctx->intra_matrix;
635 x->intra_matrix = av_malloc(sizeof(unsigned char) * 64);
636 if (!x->intra_matrix)
637 return AVERROR(ENOMEM);
640 if (avctx->inter_matrix) {
641 inter = avctx->inter_matrix;
642 x->inter_matrix = av_malloc(sizeof(unsigned char) * 64);
643 if (!x->inter_matrix)
644 return AVERROR(ENOMEM);
648 for (i = 0; i < 64; i++) {
650 x->intra_matrix[i] = (unsigned char) intra[i];
652 x->inter_matrix[i] = (unsigned char) inter[i];
657 xvid_enc_create.frame_drop_ratio = 0;
658 xvid_enc_create.global = 0;
659 if (xvid_flags & AV_CODEC_FLAG_CLOSED_GOP)
660 xvid_enc_create.global |= XVID_GLOBAL_CLOSED_GOP;
662 /* Determines which codec mode we are operating in */
663 avctx->extradata = NULL;
664 avctx->extradata_size = 0;
665 if (xvid_flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
666 /* In this case, we are claiming to be MPEG-4 */
667 x->quicktime_format = 1;
668 avctx->codec_id = AV_CODEC_ID_MPEG4;
670 /* We are claiming to be Xvid */
671 x->quicktime_format = 0;
672 if (!avctx->codec_tag)
673 avctx->codec_tag = AV_RL32("xvid");
677 xvid_enc_create.max_bframes = avctx->max_b_frames;
678 xvid_enc_create.bquant_offset = 100 * avctx->b_quant_offset;
679 xvid_enc_create.bquant_ratio = 100 * avctx->b_quant_factor;
680 if (avctx->max_b_frames > 0 && !x->quicktime_format)
681 xvid_enc_create.global |= XVID_GLOBAL_PACKED;
683 av_assert0(xvid_enc_create.num_plugins + (!!x->ssim) + (!!x->variance_aq) + (!!x->lumi_aq) <= FF_ARRAY_ELEMS(plugins));
685 /* Encode a dummy frame to get the extradata immediately */
686 if (x->quicktime_format) {
688 AVPacket packet = {0};
689 int size, got_packet, ret;
691 av_init_packet(&packet);
693 picture = av_frame_alloc();
695 return AVERROR(ENOMEM);
697 xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
699 av_frame_free(&picture);
700 av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
701 return AVERROR_EXTERNAL;
703 x->encoder_handle = xvid_enc_create.handle;
704 size = ((avctx->width + 1) & ~1) * ((avctx->height + 1) & ~1);
705 picture->data[0] = av_malloc(size + size / 2);
706 if (!picture->data[0]) {
707 av_frame_free(&picture);
708 return AVERROR(ENOMEM);
710 picture->data[1] = picture->data[0] + size;
711 picture->data[2] = picture->data[1] + size / 4;
712 memset(picture->data[0], 0, size);
713 memset(picture->data[1], 128, size / 2);
714 ret = xvid_encode_frame(avctx, &packet, picture, &got_packet);
715 if (!ret && got_packet)
716 av_packet_unref(&packet);
717 av_free(picture->data[0]);
718 av_frame_free(&picture);
719 xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
722 /* Create encoder context */
723 xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
725 av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
726 return AVERROR_EXTERNAL;
729 x->encoder_handle = xvid_enc_create.handle;
734 static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
735 const AVFrame *picture, int *got_packet)
737 int xerr, i, ret, user_packet = !!pkt->data;
738 struct xvid_context *x = avctx->priv_data;
739 int mb_width = (avctx->width + 15) / 16;
740 int mb_height = (avctx->height + 15) / 16;
743 xvid_enc_frame_t xvid_enc_frame = { 0 };
744 xvid_enc_stats_t xvid_enc_stats = { 0 };
746 if ((ret = ff_alloc_packet2(avctx, pkt, mb_width*(int64_t)mb_height*MAX_MB_BYTES + AV_INPUT_BUFFER_MIN_SIZE, 0)) < 0)
749 /* Start setting up the frame */
750 xvid_enc_frame.version = XVID_VERSION;
751 xvid_enc_stats.version = XVID_VERSION;
753 /* Let Xvid know where to put the frame. */
754 xvid_enc_frame.bitstream = pkt->data;
755 xvid_enc_frame.length = pkt->size;
757 /* Initialize input image fields */
758 if (avctx->pix_fmt != AV_PIX_FMT_YUV420P) {
759 av_log(avctx, AV_LOG_ERROR,
760 "Xvid: Color spaces other than 420P not supported\n");
761 return AVERROR(EINVAL);
764 xvid_enc_frame.input.csp = XVID_CSP_PLANAR; /* YUV420P */
766 for (i = 0; i < 4; i++) {
767 xvid_enc_frame.input.plane[i] = picture->data[i];
768 xvid_enc_frame.input.stride[i] = picture->linesize[i];
772 xvid_enc_frame.vop_flags = x->vop_flags;
773 xvid_enc_frame.vol_flags = x->vol_flags;
774 xvid_enc_frame.motion = x->me_flags;
775 xvid_enc_frame.type =
776 picture->pict_type == AV_PICTURE_TYPE_I ? XVID_TYPE_IVOP :
777 picture->pict_type == AV_PICTURE_TYPE_P ? XVID_TYPE_PVOP :
778 picture->pict_type == AV_PICTURE_TYPE_B ? XVID_TYPE_BVOP :
781 /* Pixel aspect ratio setting */
782 if (avctx->sample_aspect_ratio.num < 0 || avctx->sample_aspect_ratio.num > 255 ||
783 avctx->sample_aspect_ratio.den < 0 || avctx->sample_aspect_ratio.den > 255) {
784 av_log(avctx, AV_LOG_WARNING,
785 "Invalid pixel aspect ratio %i/%i, limit is 255/255 reducing\n",
786 avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den);
787 av_reduce(&avctx->sample_aspect_ratio.num, &avctx->sample_aspect_ratio.den,
788 avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den, 255);
790 xvid_enc_frame.par = XVID_PAR_EXT;
791 xvid_enc_frame.par_width = avctx->sample_aspect_ratio.num;
792 xvid_enc_frame.par_height = avctx->sample_aspect_ratio.den;
796 xvid_enc_frame.quant = picture->quality / FF_QP2LAMBDA;
798 xvid_enc_frame.quant = 0;
801 xvid_enc_frame.quant_intra_matrix = x->intra_matrix;
802 xvid_enc_frame.quant_inter_matrix = x->inter_matrix;
805 xerr = xvid_encore(x->encoder_handle, XVID_ENC_ENCODE,
806 &xvid_enc_frame, &xvid_enc_stats);
808 /* Two-pass log buffer swapping */
809 avctx->stats_out = NULL;
810 if (x->twopassbuffer) {
811 tmp = x->old_twopassbuffer;
812 x->old_twopassbuffer = x->twopassbuffer;
813 x->twopassbuffer = tmp;
814 x->twopassbuffer[0] = 0;
815 if (x->old_twopassbuffer[0] != 0) {
816 avctx->stats_out = x->old_twopassbuffer;
825 if (xvid_enc_stats.type == XVID_TYPE_PVOP)
826 pict_type = AV_PICTURE_TYPE_P;
827 else if (xvid_enc_stats.type == XVID_TYPE_BVOP)
828 pict_type = AV_PICTURE_TYPE_B;
829 else if (xvid_enc_stats.type == XVID_TYPE_SVOP)
830 pict_type = AV_PICTURE_TYPE_S;
832 pict_type = AV_PICTURE_TYPE_I;
834 #if FF_API_CODED_FRAME
835 FF_DISABLE_DEPRECATION_WARNINGS
836 avctx->coded_frame->pict_type = pict_type;
837 avctx->coded_frame->quality = xvid_enc_stats.quant * FF_QP2LAMBDA;
838 FF_ENABLE_DEPRECATION_WARNINGS
841 ff_side_data_set_encoder_stats(pkt, xvid_enc_stats.quant * FF_QP2LAMBDA, NULL, 0, pict_type);
843 if (xvid_enc_frame.out_flags & XVID_KEYFRAME) {
844 #if FF_API_CODED_FRAME
845 FF_DISABLE_DEPRECATION_WARNINGS
846 avctx->coded_frame->key_frame = 1;
847 FF_ENABLE_DEPRECATION_WARNINGS
849 pkt->flags |= AV_PKT_FLAG_KEY;
850 if (x->quicktime_format)
851 return xvid_strip_vol_header(avctx, pkt,
852 xvid_enc_stats.hlength, xerr);
854 #if FF_API_CODED_FRAME
855 FF_DISABLE_DEPRECATION_WARNINGS
856 avctx->coded_frame->key_frame = 0;
857 FF_ENABLE_DEPRECATION_WARNINGS
866 av_packet_unref(pkt);
869 av_log(avctx, AV_LOG_ERROR,
870 "Xvid: Encoding Error Occurred: %i\n", xerr);
871 return AVERROR_EXTERNAL;
875 static av_cold int xvid_encode_close(AVCodecContext *avctx)
877 struct xvid_context *x = avctx->priv_data;
879 if (x->encoder_handle) {
880 xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
881 x->encoder_handle = NULL;
884 av_freep(&avctx->extradata);
885 if (x->twopassbuffer) {
886 av_freep(&x->twopassbuffer);
887 av_freep(&x->old_twopassbuffer);
888 avctx->stats_out = NULL;
890 if (x->twopassfd>=0) {
891 unlink(x->twopassfile);
895 av_freep(&x->twopassfile);
896 av_freep(&x->intra_matrix);
897 av_freep(&x->inter_matrix);
902 #define OFFSET(x) offsetof(struct xvid_context, x)
903 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
904 static const AVOption options[] = {
905 { "lumi_aq", "Luminance masking AQ", OFFSET(lumi_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
906 { "variance_aq", "Variance AQ", OFFSET(variance_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
907 { "ssim", "Show SSIM information to stdout", OFFSET(ssim), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 2, VE, "ssim" },
908 { "off", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, INT_MIN, INT_MAX, VE, "ssim" },
909 { "avg", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, INT_MIN, INT_MAX, VE, "ssim" },
910 { "frame", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 2 }, INT_MIN, INT_MAX, VE, "ssim" },
911 { "ssim_acc", "SSIM accuracy", OFFSET(ssim_acc), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, 4, VE },
912 { "gmc", "use GMC", OFFSET(gmc), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
913 { "me_quality", "Motion estimation quality", OFFSET(me_quality), AV_OPT_TYPE_INT, { .i64 = 4 }, 0, 6, VE },
914 { "mpeg_quant", "Use MPEG quantizers instead of H.263", OFFSET(mpeg_quant), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
918 static const AVClass xvid_class = {
919 .class_name = "libxvid",
920 .item_name = av_default_item_name,
922 .version = LIBAVUTIL_VERSION_INT,
925 AVCodec ff_libxvid_encoder = {
927 .long_name = NULL_IF_CONFIG_SMALL("libxvidcore MPEG-4 part 2"),
928 .type = AVMEDIA_TYPE_VIDEO,
929 .id = AV_CODEC_ID_MPEG4,
930 .priv_data_size = sizeof(struct xvid_context),
931 .init = xvid_encode_init,
932 .encode2 = xvid_encode_frame,
933 .close = xvid_encode_close,
934 .pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE },
935 .priv_class = &xvid_class,
936 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
937 FF_CODEC_CAP_INIT_CLEANUP,
938 .wrapper_name = "libxvid",