2 * Interface to xvidcore for mpeg4 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: H263, 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);
101 * Xvid 2-Pass Kludge Section
103 * Xvid's default 2-pass doesn't allow us to create data as we need to, so
104 * this section spends time replacing the first pass plugin so we can write
105 * statistic information as libavcodec requests in. We have another kludge
106 * that allows us to pass data to the second pass in Xvid without a custom
107 * rate-control plugin.
111 * Initialize the two-pass plugin and context.
113 * @param param Input construction parameter structure
114 * @param handle Private context handle
115 * @return Returns XVID_ERR_xxxx on failure, or 0 on success.
117 static int xvid_ff_2pass_create(xvid_plg_create_t *param, void **handle)
119 struct xvid_ff_pass1 *x = (struct xvid_ff_pass1 *) param->param;
120 char *log = x->context->twopassbuffer;
122 /* Do a quick bounds check */
124 return XVID_ERR_FAIL;
126 /* We use snprintf() */
127 /* This is because we can safely prevent a buffer overflow */
129 snprintf(log, BUFFER_REMAINING(log),
130 "# ffmpeg 2-pass log file, using xvid codec\n");
131 snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
132 "# Do not modify. libxvidcore version: %d.%d.%d\n\n",
133 XVID_VERSION_MAJOR(XVID_VERSION),
134 XVID_VERSION_MINOR(XVID_VERSION),
135 XVID_VERSION_PATCH(XVID_VERSION));
137 *handle = x->context;
142 * Destroy the two-pass plugin context.
144 * @param ref Context pointer for the plugin
145 * @param param Destrooy context
146 * @return Returns 0, success guaranteed
148 static int xvid_ff_2pass_destroy(struct xvid_context *ref,
149 xvid_plg_destroy_t *param)
151 /* Currently cannot think of anything to do on destruction */
152 /* Still, the framework should be here for reference/use */
153 if (ref->twopassbuffer)
154 ref->twopassbuffer[0] = 0;
159 * Enable fast encode mode during the first pass.
161 * @param ref Context pointer for the plugin
162 * @param param Frame data
163 * @return Returns 0, success guaranteed
165 static int xvid_ff_2pass_before(struct xvid_context *ref,
166 xvid_plg_data_t *param)
169 int motion_replacements;
172 /* Nothing to do here, result is changed too much */
173 if (param->zone && param->zone->mode == XVID_ZONE_QUANT)
176 /* We can implement a 'turbo' first pass mode here */
180 motion_remove = ~XVID_ME_CHROMA_PVOP &
181 ~XVID_ME_CHROMA_BVOP &
182 ~XVID_ME_EXTSEARCH16 &
183 ~XVID_ME_ADVANCEDDIAMOND16;
184 motion_replacements = XVID_ME_FAST_MODEINTERPOLATE |
185 XVID_ME_SKIP_DELTASEARCH |
186 XVID_ME_FASTREFINE16 |
187 XVID_ME_BFRAME_EARLYSTOP;
188 vop_remove = ~XVID_VOP_MODEDECISION_RD &
189 ~XVID_VOP_FAST_MODEDECISION_RD &
190 ~XVID_VOP_TRELLISQUANT &
194 param->vol_flags &= ~XVID_VOL_GMC;
195 param->vop_flags &= vop_remove;
196 param->motion_flags &= motion_remove;
197 param->motion_flags |= motion_replacements;
203 * Capture statistic data and write it during first pass.
205 * @param ref Context pointer for the plugin
206 * @param param Statistic data
207 * @return Returns XVID_ERR_xxxx on failure, or 0 on success
209 static int xvid_ff_2pass_after(struct xvid_context *ref,
210 xvid_plg_data_t *param)
212 char *log = ref->twopassbuffer;
213 const char *frame_types = " ipbs";
216 /* Quick bounds check */
218 return XVID_ERR_FAIL;
220 /* Convert the type given to us into a character */
221 if (param->type < 5 && param->type > 0)
222 frame_type = frame_types[param->type];
224 return XVID_ERR_FAIL;
226 snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
227 "%c %d %d %d %d %d %d\n",
228 frame_type, param->stats.quant, param->stats.kblks,
229 param->stats.mblks, param->stats.ublks,
230 param->stats.length, param->stats.hlength);
236 * Dispatch function for our custom plugin.
237 * This handles the dispatch for the Xvid plugin. It passes data
238 * on to other functions for actual processing.
240 * @param ref Context pointer for the plugin
241 * @param cmd The task given for us to complete
242 * @param p1 First parameter (varies)
243 * @param p2 Second parameter (varies)
244 * @return Returns XVID_ERR_xxxx on failure, or 0 on success
246 static int xvid_ff_2pass(void *ref, int cmd, void *p1, void *p2)
252 case XVID_PLG_BEFORE:
253 return xvid_ff_2pass_before(ref, p1);
254 case XVID_PLG_CREATE:
255 return xvid_ff_2pass_create(p1, p2);
257 return xvid_ff_2pass_after(ref, p1);
258 case XVID_PLG_DESTROY:
259 return xvid_ff_2pass_destroy(ref, p1);
261 return XVID_ERR_FAIL;
266 * Routine to create a global VO/VOL header for MP4 container.
267 * What we do here is extract the header from the Xvid bitstream
268 * as it is encoded. We also strip the repeated headers from the
269 * bitstream when a global header is requested for MPEG-4 ISO
272 * @param avctx AVCodecContext pointer to context
273 * @param frame Pointer to encoded frame data
274 * @param header_len Length of header to search
275 * @param frame_len Length of encoded frame data
276 * @return Returns new length of frame data
278 static int xvid_strip_vol_header(AVCodecContext *avctx, AVPacket *pkt,
279 unsigned int header_len,
280 unsigned int frame_len)
284 for (i = 0; i < header_len - 3; i++) {
285 if (pkt->data[i] == 0x00 &&
286 pkt->data[i + 1] == 0x00 &&
287 pkt->data[i + 2] == 0x01 &&
288 pkt->data[i + 3] == 0xB6) {
295 /* We need to store the header, so extract it */
296 if (!avctx->extradata) {
297 avctx->extradata = av_malloc(vo_len);
298 if (!avctx->extradata)
299 return AVERROR(ENOMEM);
300 memcpy(avctx->extradata, pkt->data, vo_len);
301 avctx->extradata_size = vo_len;
303 /* Less dangerous now, memmove properly copies the two
304 * chunks of overlapping data */
305 memmove(pkt->data, &pkt->data[vo_len], frame_len - vo_len);
306 pkt->size = frame_len - vo_len;
312 * Routine to correct a possibly erroneous framerate being fed to us.
313 * Xvid currently chokes on framerates where the ticks per frame is
314 * extremely large. This function works to correct problems in this area
315 * by estimating a new framerate and taking the simpler fraction of
318 * @param avctx Context that contains the framerate to correct.
320 static void xvid_correct_framerate(AVCodecContext *avctx)
323 int est_frate, est_fbase;
327 frate = avctx->time_base.den;
328 fbase = avctx->time_base.num;
330 gcd = av_gcd(frate, fbase);
336 if (frate <= 65000 && fbase <= 65000) {
337 avctx->time_base.den = frate;
338 avctx->time_base.num = fbase;
342 fps = (float) frate / (float) fbase;
343 est_fps = roundf(fps * 1000.0) / 1000.0;
345 est_frate = (int) est_fps;
346 if (est_fps > (int) est_fps) {
347 est_frate = (est_frate + 1) * 1000;
348 est_fbase = (int) roundf((float) est_frate / est_fps);
352 gcd = av_gcd(est_frate, est_fbase);
358 if (fbase > est_fbase) {
359 avctx->time_base.den = est_frate;
360 avctx->time_base.num = est_fbase;
361 av_log(avctx, AV_LOG_DEBUG,
362 "Xvid: framerate re-estimated: %.2f, %.3f%% correction\n",
363 est_fps, (((est_fps - fps) / fps) * 100.0));
365 avctx->time_base.den = frate;
366 avctx->time_base.num = fbase;
370 static av_cold int xvid_encode_init(AVCodecContext *avctx)
372 int xerr, i, ret = -1;
373 int xvid_flags = avctx->flags;
374 struct xvid_context *x = avctx->priv_data;
375 uint16_t *intra, *inter;
378 xvid_plugin_single_t single = { 0 };
379 struct xvid_ff_pass1 rc2pass1 = { 0 };
380 xvid_plugin_2pass2_t rc2pass2 = { 0 };
381 xvid_plugin_lumimasking_t masking_l = { 0 }; /* For lumi masking */
382 xvid_plugin_lumimasking_t masking_v = { 0 }; /* For variance AQ */
383 xvid_plugin_ssim_t ssim = { 0 };
384 xvid_gbl_init_t xvid_gbl_init = { 0 };
385 xvid_enc_create_t xvid_enc_create = { 0 };
386 xvid_enc_plugin_t plugins[4];
390 /* Bring in VOP flags from ffmpeg command-line */
391 x->vop_flags = XVID_VOP_HALFPEL; /* Bare minimum quality */
392 if (xvid_flags & AV_CODEC_FLAG_4MV)
393 x->vop_flags |= XVID_VOP_INTER4V; /* Level 3 */
395 x->vop_flags |= XVID_VOP_TRELLISQUANT; /* Level 5 */
396 if (xvid_flags & AV_CODEC_FLAG_AC_PRED)
397 x->vop_flags |= XVID_VOP_HQACPRED; /* Level 6 */
398 if (xvid_flags & AV_CODEC_FLAG_GRAY)
399 x->vop_flags |= XVID_VOP_GREYSCALE;
401 /* Decide which ME quality setting to use */
403 switch (x->me_quality) {
406 x->me_flags |= XVID_ME_EXTSEARCH16 |
410 x->me_flags |= XVID_ME_ADVANCEDDIAMOND8 |
411 XVID_ME_HALFPELREFINE8 |
412 XVID_ME_CHROMA_PVOP |
416 x->me_flags |= XVID_ME_ADVANCEDDIAMOND16 |
417 XVID_ME_HALFPELREFINE16;
418 #if FF_API_MOTION_EST
419 FF_DISABLE_DEPRECATION_WARNINGS
422 switch (avctx->me_method) {
423 case ME_FULL: /* Quality 6 */
424 x->me_flags |= XVID_ME_EXTSEARCH16 |
426 case ME_EPZS: /* Quality 4 */
427 x->me_flags |= XVID_ME_ADVANCEDDIAMOND8 |
428 XVID_ME_HALFPELREFINE8 |
429 XVID_ME_CHROMA_PVOP |
431 case ME_LOG: /* Quality 2 */
434 x->me_flags |= XVID_ME_ADVANCEDDIAMOND16 |
435 XVID_ME_HALFPELREFINE16;
436 case ME_ZERO: /* Quality 0 */
440 FF_ENABLE_DEPRECATION_WARNINGS
444 /* Decide how we should decide blocks */
445 switch (avctx->mb_decision) {
447 x->vop_flags |= XVID_VOP_MODEDECISION_RD;
448 x->me_flags |= XVID_ME_HALFPELREFINE8_RD |
449 XVID_ME_QUARTERPELREFINE8_RD |
450 XVID_ME_EXTSEARCH_RD |
451 XVID_ME_CHECKPREDICTION_RD;
453 if (!(x->vop_flags & XVID_VOP_MODEDECISION_RD))
454 x->vop_flags |= XVID_VOP_FAST_MODEDECISION_RD;
455 x->me_flags |= XVID_ME_HALFPELREFINE16_RD |
456 XVID_ME_QUARTERPELREFINE16_RD;
461 /* Bring in VOL flags from ffmpeg command-line */
463 if (avctx->flags & CODEC_FLAG_GMC)
469 x->vol_flags |= XVID_VOL_GMC;
470 x->me_flags |= XVID_ME_GME_REFINE;
472 if (xvid_flags & AV_CODEC_FLAG_QPEL) {
473 x->vol_flags |= XVID_VOL_QUARTERPEL;
474 x->me_flags |= XVID_ME_QUARTERPELREFINE16;
475 if (x->vop_flags & XVID_VOP_INTER4V)
476 x->me_flags |= XVID_ME_QUARTERPELREFINE8;
479 xvid_gbl_init.version = XVID_VERSION;
480 xvid_gbl_init.debug = 0;
481 xvid_gbl_init.cpu_flags = 0;
484 xvid_global(NULL, XVID_GBL_INIT, &xvid_gbl_init, NULL);
486 /* Create the encoder reference */
487 xvid_enc_create.version = XVID_VERSION;
489 /* Store the desired frame size */
490 xvid_enc_create.width =
491 x->xsize = avctx->width;
492 xvid_enc_create.height =
493 x->ysize = avctx->height;
495 /* Xvid can determine the proper profile to use */
496 /* xvid_enc_create.profile = XVID_PROFILE_S_L3; */
498 /* We don't use zones */
499 xvid_enc_create.zones = NULL;
500 xvid_enc_create.num_zones = 0;
502 xvid_enc_create.num_threads = avctx->thread_count;
503 #if (XVID_VERSION <= 0x010303) && (XVID_VERSION >= 0x010300)
504 /* workaround for a bug in libxvidcore */
505 if (avctx->height <= 16) {
506 if (avctx->thread_count < 2) {
507 xvid_enc_create.num_threads = 0;
509 av_log(avctx, AV_LOG_ERROR,
510 "Too small height for threads > 1.");
511 return AVERROR(EINVAL);
516 xvid_enc_create.plugins = plugins;
517 xvid_enc_create.num_plugins = 0;
519 /* Initialize Buffers */
520 x->twopassbuffer = NULL;
521 x->old_twopassbuffer = NULL;
522 x->twopassfile = NULL;
524 if (xvid_flags & AV_CODEC_FLAG_PASS1) {
525 rc2pass1.version = XVID_VERSION;
526 rc2pass1.context = x;
527 x->twopassbuffer = av_malloc(BUFFER_SIZE);
528 x->old_twopassbuffer = av_malloc(BUFFER_SIZE);
529 if (!x->twopassbuffer || !x->old_twopassbuffer) {
530 av_log(avctx, AV_LOG_ERROR,
531 "Xvid: Cannot allocate 2-pass log buffers\n");
532 return AVERROR(ENOMEM);
534 x->twopassbuffer[0] =
535 x->old_twopassbuffer[0] = 0;
537 plugins[xvid_enc_create.num_plugins].func = xvid_ff_2pass;
538 plugins[xvid_enc_create.num_plugins].param = &rc2pass1;
539 xvid_enc_create.num_plugins++;
540 } else if (xvid_flags & AV_CODEC_FLAG_PASS2) {
541 rc2pass2.version = XVID_VERSION;
542 rc2pass2.bitrate = avctx->bit_rate;
544 fd = av_tempfile("xvidff.", &x->twopassfile, 0, avctx);
546 av_log(avctx, AV_LOG_ERROR, "Xvid: Cannot write 2-pass pipe\n");
551 if (!avctx->stats_in) {
552 av_log(avctx, AV_LOG_ERROR,
553 "Xvid: No 2-pass information loaded for second pass\n");
554 return AVERROR(EINVAL);
557 ret = write(fd, avctx->stats_in, strlen(avctx->stats_in));
559 ret = AVERROR(errno);
560 else if (strlen(avctx->stats_in) > ret) {
561 av_log(avctx, AV_LOG_ERROR, "Xvid: Cannot write to 2-pass pipe\n");
567 rc2pass2.filename = x->twopassfile;
568 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_2pass2;
569 plugins[xvid_enc_create.num_plugins].param = &rc2pass2;
570 xvid_enc_create.num_plugins++;
571 } else if (!(xvid_flags & AV_CODEC_FLAG_QSCALE)) {
572 /* Single Pass Bitrate Control! */
573 single.version = XVID_VERSION;
574 single.bitrate = avctx->bit_rate;
576 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_single;
577 plugins[xvid_enc_create.num_plugins].param = &single;
578 xvid_enc_create.num_plugins++;
581 if (avctx->lumi_masking != 0.0)
584 /* Luminance Masking */
586 masking_l.method = 0;
587 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
589 /* The old behavior is that when avctx->lumi_masking is specified,
590 * plugins[...].param = NULL. Trying to keep the old behavior here. */
591 plugins[xvid_enc_create.num_plugins].param =
592 avctx->lumi_masking ? NULL : &masking_l;
593 xvid_enc_create.num_plugins++;
597 if (x->variance_aq) {
598 masking_v.method = 1;
599 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
600 plugins[xvid_enc_create.num_plugins].param = &masking_v;
601 xvid_enc_create.num_plugins++;
604 if (x->lumi_aq && x->variance_aq )
605 av_log(avctx, AV_LOG_INFO,
606 "Both lumi_aq and variance_aq are enabled. The resulting quality"
607 "will be the worse one of the two effects made by the AQ.\n");
611 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_ssim;
612 ssim.b_printstat = x->ssim == 2;
613 ssim.acc = x->ssim_acc;
614 ssim.cpu_flags = xvid_gbl_init.cpu_flags;
615 ssim.b_visualize = 0;
616 plugins[xvid_enc_create.num_plugins].param = &ssim;
617 xvid_enc_create.num_plugins++;
620 /* Frame Rate and Key Frames */
621 xvid_correct_framerate(avctx);
622 xvid_enc_create.fincr = avctx->time_base.num;
623 xvid_enc_create.fbase = avctx->time_base.den;
624 if (avctx->gop_size > 0)
625 xvid_enc_create.max_key_interval = avctx->gop_size;
627 xvid_enc_create.max_key_interval = 240; /* Xvid's best default */
630 if (xvid_flags & AV_CODEC_FLAG_QSCALE)
635 xvid_enc_create.min_quant[0] = avctx->qmin;
636 xvid_enc_create.min_quant[1] = avctx->qmin;
637 xvid_enc_create.min_quant[2] = avctx->qmin;
638 xvid_enc_create.max_quant[0] = avctx->qmax;
639 xvid_enc_create.max_quant[1] = avctx->qmax;
640 xvid_enc_create.max_quant[2] = avctx->qmax;
644 x->inter_matrix = NULL;
646 #if FF_API_PRIVATE_OPT
647 FF_DISABLE_DEPRECATION_WARNINGS
648 if (avctx->mpeg_quant)
649 x->mpeg_quant = avctx->mpeg_quant;
650 FF_ENABLE_DEPRECATION_WARNINGS
654 x->vol_flags |= XVID_VOL_MPEGQUANT;
655 if ((avctx->intra_matrix || avctx->inter_matrix)) {
656 x->vol_flags |= XVID_VOL_MPEGQUANT;
658 if (avctx->intra_matrix) {
659 intra = avctx->intra_matrix;
660 x->intra_matrix = av_malloc(sizeof(unsigned char) * 64);
661 if (!x->intra_matrix)
662 return AVERROR(ENOMEM);
665 if (avctx->inter_matrix) {
666 inter = avctx->inter_matrix;
667 x->inter_matrix = av_malloc(sizeof(unsigned char) * 64);
668 if (!x->inter_matrix)
669 return AVERROR(ENOMEM);
673 for (i = 0; i < 64; i++) {
675 x->intra_matrix[i] = (unsigned char) intra[i];
677 x->inter_matrix[i] = (unsigned char) inter[i];
682 xvid_enc_create.frame_drop_ratio = 0;
683 xvid_enc_create.global = 0;
684 if (xvid_flags & AV_CODEC_FLAG_CLOSED_GOP)
685 xvid_enc_create.global |= XVID_GLOBAL_CLOSED_GOP;
687 /* Determines which codec mode we are operating in */
688 avctx->extradata = NULL;
689 avctx->extradata_size = 0;
690 if (xvid_flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
691 /* In this case, we are claiming to be MPEG4 */
692 x->quicktime_format = 1;
693 avctx->codec_id = AV_CODEC_ID_MPEG4;
695 /* We are claiming to be Xvid */
696 x->quicktime_format = 0;
697 if (!avctx->codec_tag)
698 avctx->codec_tag = AV_RL32("xvid");
702 xvid_enc_create.max_bframes = avctx->max_b_frames;
703 xvid_enc_create.bquant_offset = 100 * avctx->b_quant_offset;
704 xvid_enc_create.bquant_ratio = 100 * avctx->b_quant_factor;
705 if (avctx->max_b_frames > 0 && !x->quicktime_format)
706 xvid_enc_create.global |= XVID_GLOBAL_PACKED;
708 av_assert0(xvid_enc_create.num_plugins + (!!x->ssim) + (!!x->variance_aq) + (!!x->lumi_aq) <= FF_ARRAY_ELEMS(plugins));
710 /* Create encoder context */
711 xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
713 av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
714 return AVERROR_EXTERNAL;
717 x->encoder_handle = xvid_enc_create.handle;
722 static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
723 const AVFrame *picture, int *got_packet)
725 int xerr, i, ret, user_packet = !!pkt->data;
726 struct xvid_context *x = avctx->priv_data;
727 int mb_width = (avctx->width + 15) / 16;
728 int mb_height = (avctx->height + 15) / 16;
731 xvid_enc_frame_t xvid_enc_frame = { 0 };
732 xvid_enc_stats_t xvid_enc_stats = { 0 };
734 if ((ret = ff_alloc_packet2(avctx, pkt, mb_width*(int64_t)mb_height*MAX_MB_BYTES + AV_INPUT_BUFFER_MIN_SIZE, 0)) < 0)
737 /* Start setting up the frame */
738 xvid_enc_frame.version = XVID_VERSION;
739 xvid_enc_stats.version = XVID_VERSION;
741 /* Let Xvid know where to put the frame. */
742 xvid_enc_frame.bitstream = pkt->data;
743 xvid_enc_frame.length = pkt->size;
745 /* Initialize input image fields */
746 if (avctx->pix_fmt != AV_PIX_FMT_YUV420P) {
747 av_log(avctx, AV_LOG_ERROR,
748 "Xvid: Color spaces other than 420P not supported\n");
749 return AVERROR(EINVAL);
752 xvid_enc_frame.input.csp = XVID_CSP_PLANAR; /* YUV420P */
754 for (i = 0; i < 4; i++) {
755 xvid_enc_frame.input.plane[i] = picture->data[i];
756 xvid_enc_frame.input.stride[i] = picture->linesize[i];
760 xvid_enc_frame.vop_flags = x->vop_flags;
761 xvid_enc_frame.vol_flags = x->vol_flags;
762 xvid_enc_frame.motion = x->me_flags;
763 xvid_enc_frame.type =
764 picture->pict_type == AV_PICTURE_TYPE_I ? XVID_TYPE_IVOP :
765 picture->pict_type == AV_PICTURE_TYPE_P ? XVID_TYPE_PVOP :
766 picture->pict_type == AV_PICTURE_TYPE_B ? XVID_TYPE_BVOP :
769 /* Pixel aspect ratio setting */
770 if (avctx->sample_aspect_ratio.num < 0 || avctx->sample_aspect_ratio.num > 255 ||
771 avctx->sample_aspect_ratio.den < 0 || avctx->sample_aspect_ratio.den > 255) {
772 av_log(avctx, AV_LOG_WARNING,
773 "Invalid pixel aspect ratio %i/%i, limit is 255/255 reducing\n",
774 avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den);
775 av_reduce(&avctx->sample_aspect_ratio.num, &avctx->sample_aspect_ratio.den,
776 avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den, 255);
778 xvid_enc_frame.par = XVID_PAR_EXT;
779 xvid_enc_frame.par_width = avctx->sample_aspect_ratio.num;
780 xvid_enc_frame.par_height = avctx->sample_aspect_ratio.den;
784 xvid_enc_frame.quant = picture->quality / FF_QP2LAMBDA;
786 xvid_enc_frame.quant = 0;
789 xvid_enc_frame.quant_intra_matrix = x->intra_matrix;
790 xvid_enc_frame.quant_inter_matrix = x->inter_matrix;
793 xerr = xvid_encore(x->encoder_handle, XVID_ENC_ENCODE,
794 &xvid_enc_frame, &xvid_enc_stats);
796 /* Two-pass log buffer swapping */
797 avctx->stats_out = NULL;
798 if (x->twopassbuffer) {
799 tmp = x->old_twopassbuffer;
800 x->old_twopassbuffer = x->twopassbuffer;
801 x->twopassbuffer = tmp;
802 x->twopassbuffer[0] = 0;
803 if (x->old_twopassbuffer[0] != 0) {
804 avctx->stats_out = x->old_twopassbuffer;
813 if (xvid_enc_stats.type == XVID_TYPE_PVOP)
814 pict_type = AV_PICTURE_TYPE_P;
815 else if (xvid_enc_stats.type == XVID_TYPE_BVOP)
816 pict_type = AV_PICTURE_TYPE_B;
817 else if (xvid_enc_stats.type == XVID_TYPE_SVOP)
818 pict_type = AV_PICTURE_TYPE_S;
820 pict_type = AV_PICTURE_TYPE_I;
822 #if FF_API_CODED_FRAME
823 FF_DISABLE_DEPRECATION_WARNINGS
824 avctx->coded_frame->pict_type = pict_type;
825 avctx->coded_frame->quality = xvid_enc_stats.quant * FF_QP2LAMBDA;
826 FF_ENABLE_DEPRECATION_WARNINGS
829 ff_side_data_set_encoder_stats(pkt, xvid_enc_stats.quant * FF_QP2LAMBDA, NULL, 0, pict_type);
831 if (xvid_enc_frame.out_flags & XVID_KEYFRAME) {
832 #if FF_API_CODED_FRAME
833 FF_DISABLE_DEPRECATION_WARNINGS
834 avctx->coded_frame->key_frame = 1;
835 FF_ENABLE_DEPRECATION_WARNINGS
837 pkt->flags |= AV_PKT_FLAG_KEY;
838 if (x->quicktime_format)
839 return xvid_strip_vol_header(avctx, pkt,
840 xvid_enc_stats.hlength, xerr);
842 #if FF_API_CODED_FRAME
843 FF_DISABLE_DEPRECATION_WARNINGS
844 avctx->coded_frame->key_frame = 0;
845 FF_ENABLE_DEPRECATION_WARNINGS
854 av_packet_unref(pkt);
857 av_log(avctx, AV_LOG_ERROR,
858 "Xvid: Encoding Error Occurred: %i\n", xerr);
859 return AVERROR_EXTERNAL;
863 static av_cold int xvid_encode_close(AVCodecContext *avctx)
865 struct xvid_context *x = avctx->priv_data;
867 if (x->encoder_handle) {
868 xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
869 x->encoder_handle = NULL;
872 av_freep(&avctx->extradata);
873 if (x->twopassbuffer) {
874 av_freep(&x->twopassbuffer);
875 av_freep(&x->old_twopassbuffer);
876 avctx->stats_out = NULL;
878 if (x->twopassfd>=0) {
879 unlink(x->twopassfile);
883 av_freep(&x->twopassfile);
884 av_freep(&x->intra_matrix);
885 av_freep(&x->inter_matrix);
890 #define OFFSET(x) offsetof(struct xvid_context, x)
891 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
892 static const AVOption options[] = {
893 { "lumi_aq", "Luminance masking AQ", OFFSET(lumi_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
894 { "variance_aq", "Variance AQ", OFFSET(variance_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
895 { "ssim", "Show SSIM information to stdout", OFFSET(ssim), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 2, VE, "ssim" },
896 { "off", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, INT_MIN, INT_MAX, VE, "ssim" },
897 { "avg", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, INT_MIN, INT_MAX, VE, "ssim" },
898 { "frame", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 2 }, INT_MIN, INT_MAX, VE, "ssim" },
899 { "ssim_acc", "SSIM accuracy", OFFSET(ssim_acc), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, 4, VE },
900 { "gmc", "use GMC", OFFSET(gmc), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
901 { "me_quality", "Motion estimation quality", OFFSET(me_quality), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 6, VE },
902 { "mpeg_quant", "Use MPEG quantizers instead of H.263", OFFSET(mpeg_quant), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
906 static const AVClass xvid_class = {
907 .class_name = "libxvid",
908 .item_name = av_default_item_name,
910 .version = LIBAVUTIL_VERSION_INT,
913 AVCodec ff_libxvid_encoder = {
915 .long_name = NULL_IF_CONFIG_SMALL("libxvidcore MPEG-4 part 2"),
916 .type = AVMEDIA_TYPE_VIDEO,
917 .id = AV_CODEC_ID_MPEG4,
918 .priv_data_size = sizeof(struct xvid_context),
919 .init = xvid_encode_init,
920 .encode2 = xvid_encode_frame,
921 .close = xvid_encode_close,
922 .pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE },
923 .priv_class = &xvid_class,
924 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
925 FF_CODEC_CAP_INIT_CLEANUP,