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 FFmpeg.
6 *
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.
11 *
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.
16 *
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
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 <string.h>
30 #include <xvid.h>
31
39
45
46 #if HAVE_UNISTD_H
47 #include <unistd.h>
48 #endif
49
50 #if HAVE_IO_H
51 #include <io.h>
52 #endif
53
54 /**
55 * Buffer management macros.
56 */
57 #define BUFFER_SIZE 1024
58 #define BUFFER_REMAINING(x) (BUFFER_SIZE - strlen(x))
59 #define BUFFER_CAT(x) (&((x)[strlen(x)]))
60
61 /**
62 * Structure for the private Xvid context.
63 * This stores all the private context for the codec.
64 */
73 int qscale;
/**< Do we use constant scale? */
81 int lumi_aq;
/**< Lumi masking as an aq method */
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 */
88 };
89
90 /**
91 * Structure for the private first-pass plugin.
92 */
96 };
97
100 const AVFrame *picture,
int *got_packet);
101
102
103 /*
104 * Xvid 2-Pass Kludge Section
105 *
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.
111 */
112
113 /**
114 * Initialize the two-pass plugin and context.
115 *
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.
119 */
121 {
124
125 /* Do a quick bounds check */
127 return XVID_ERR_FAIL;
128
129 /* We use snprintf() */
130 /* This is because we can safely prevent a buffer overflow */
131 log[0] = 0;
133 "# ffmpeg 2-pass log file, using xvid codec\n");
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));
139
141 return 0;
142 }
143
144 /**
145 * Destroy the two-pass plugin context.
146 *
147 * @param ref Context pointer for the plugin
148 * @param param Destroy context
149 * @return Returns 0, success guaranteed
150 */
152 xvid_plg_destroy_t *param)
153 {
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;
158 return 0;
159 }
160
161 /**
162 * Enable fast encode mode during the first pass.
163 *
164 * @param ref Context pointer for the plugin
165 * @param param Frame data
166 * @return Returns 0, success guaranteed
167 */
169 xvid_plg_data_t *param)
170 {
171 int motion_remove;
172 int motion_replacements;
173 int vop_remove;
174
175 /* Nothing to do here, result is changed too much */
176 if (param->zone && param->zone->mode == XVID_ZONE_QUANT)
177 return 0;
178
179 /* We can implement a 'turbo' first pass mode here */
180 param->quant = 2;
181
182 /* Init values */
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 &
194 ~XVID_VOP_INTER4V &
195 ~XVID_VOP_HQACPRED;
196
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;
201
202 return 0;
203 }
204
205 /**
206 * Capture statistic data and write it during first pass.
207 *
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
211 */
213 xvid_plg_data_t *param)
214 {
215 char *log =
ref->twopassbuffer;
216 const char *frame_types = " ipbs";
218
219 /* Quick bounds check */
220 if (!log)
221 return XVID_ERR_FAIL;
222
223 /* Convert the type given to us into a character */
224 if (param->type < 5 && param->type > 0)
226 else
227 return XVID_ERR_FAIL;
228
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);
234
235 return 0;
236 }
237
238 /**
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.
242 *
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
248 */
250 {
251 switch (cmd) {
252 case XVID_PLG_INFO:
253 case XVID_PLG_FRAME:
254 return 0;
255 case XVID_PLG_BEFORE:
257 case XVID_PLG_CREATE:
259 case XVID_PLG_AFTER:
261 case XVID_PLG_DESTROY:
263 default:
264 return XVID_ERR_FAIL;
265 }
266 }
267
268 /**
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
273 * compliance.
274 *
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
280 */
282 unsigned int header_len,
283 unsigned int frame_len)
284 {
286
287 for (
i = 0;
i < header_len - 3;
i++) {
293 break;
294 }
295 }
296
297 if (vo_len > 0) {
298 /* We need to store the header, so extract it */
305 }
306 /* Less dangerous now, memmove properly copies the two
307 * chunks of overlapping data */
309 pkt->
size = frame_len - vo_len;
310 }
311 return 0;
312 }
313
314 /**
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
319 * the two presented.
320 *
321 * @param avctx Context that contains the framerate to correct.
322 */
324 {
325 int frate, fbase;
326 int est_frate, est_fbase;
327 int gcd;
328 float est_fps, fps;
329
332
333 gcd =
av_gcd(frate, fbase);
334 if (gcd > 1) {
335 frate /= gcd;
336 fbase /= gcd;
337 }
338
339 if (frate <= 65000 && fbase <= 65000) {
342 return;
343 }
344
345 fps = (float) frate / (float) fbase;
346 est_fps =
roundf(fps * 1000.0) / 1000.0;
347
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);
352 } else
353 est_fbase = 1;
354
355 gcd =
av_gcd(est_frate, est_fbase);
356 if (gcd > 1) {
357 est_frate /= gcd;
358 est_fbase /= gcd;
359 }
360
361 if (fbase > est_fbase) {
365 "Xvid: framerate re-estimated: %.2f, %.3f%% correction\n",
366 est_fps, (((est_fps - fps) / fps) * 100.0));
367 } else {
370 }
371 }
372
374 {
375 int xerr,
i,
ret = -1;
376 int xvid_flags = avctx->
flags;
378 uint16_t *intra, *inter;
379 int fd;
380
381 xvid_plugin_single_t single = { 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];
390
392
393 /* Bring in VOP flags from ffmpeg command-line */
394 x->
vop_flags = XVID_VOP_HALFPEL;
/* Bare minimum quality */
396 x->
vop_flags |= XVID_VOP_INTER4V;
/* Level 3 */
398 x->
vop_flags |= XVID_VOP_TRELLISQUANT;
/* Level 5 */
400 x->
vop_flags |= XVID_VOP_HQACPRED;
/* Level 6 */
403
404 /* Decide which ME quality setting to use */
407 case 6:
408 case 5:
409 x->
me_flags |= XVID_ME_EXTSEARCH16 |
410 XVID_ME_EXTSEARCH8;
411 case 4:
412 case 3:
413 x->
me_flags |= XVID_ME_ADVANCEDDIAMOND8 |
414 XVID_ME_HALFPELREFINE8 |
415 XVID_ME_CHROMA_PVOP |
416 XVID_ME_CHROMA_BVOP;
417 case 2:
418 case 1:
419 x->
me_flags |= XVID_ME_ADVANCEDDIAMOND16 |
420 XVID_ME_HALFPELREFINE16;
421 }
422
423 /* Decide how we should decide blocks */
425 case 2:
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;
431 case 1:
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;
436 default:
437 break;
438 }
439
440 /* Bring in VOL flags from ffmpeg command-line */
445 }
448 x->
me_flags |= XVID_ME_QUARTERPELREFINE16;
450 x->
me_flags |= XVID_ME_QUARTERPELREFINE8;
451 }
452
453 xvid_gbl_init.version = XVID_VERSION;
454 xvid_gbl_init.debug = 0;
455 xvid_gbl_init.cpu_flags = 0;
456
457 /* Initialize */
458 xvid_global(
NULL, XVID_GBL_INIT, &xvid_gbl_init,
NULL);
459
460 /* Create the encoder reference */
461 xvid_enc_create.version = XVID_VERSION;
462
463 /* Store the desired frame size */
464 xvid_enc_create.width =
466 xvid_enc_create.height =
468
469 /* Xvid can determine the proper profile to use */
470 /* xvid_enc_create.profile = XVID_PROFILE_S_L3; */
471
472 /* We don't use zones */
473 xvid_enc_create.zones =
NULL;
474 xvid_enc_create.num_zones = 0;
475
477 #if (XVID_VERSION <= 0x010303) && (XVID_VERSION >= 0x010300)
478 /* workaround for a bug in libxvidcore */
479 if (avctx->
height <= 16) {
481 xvid_enc_create.num_threads = 0;
482 } else {
484 "Too small height for threads > 1.");
486 }
487 }
488 #endif
489
490 xvid_enc_create.plugins = plugins;
491 xvid_enc_create.num_plugins = 0;
492
493 /* Initialize Buffers */
497
499 rc2pass1.
version = XVID_VERSION;
505 "Xvid: Cannot allocate 2-pass log buffers\n");
507 }
510
512 plugins[xvid_enc_create.num_plugins].param = &rc2pass1;
513 xvid_enc_create.num_plugins++;
515 rc2pass2.
version = XVID_VERSION;
517
519 if (fd < 0) {
521 return fd;
522 }
524
527 "Xvid: No 2-pass information loaded for second pass\n");
529 }
530
537 }
540
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++;
546 /* Single Pass Bitrate Control! */
547 single.version = XVID_VERSION;
549
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++;
553 }
554
557
558 /* Luminance Masking */
560 masking_l.method = 0;
561 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
562
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 =
567 xvid_enc_create.num_plugins++;
568 }
569
570 /* 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++;
576 }
577
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");
582
583 /* SSIM */
585 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_ssim;
586 ssim.b_printstat = x->
ssim == 2;
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++;
592 }
593
594 /* Frame Rate and Key Frames */
599 xvid_enc_create.max_key_interval = avctx->
gop_size;
600 else
601 xvid_enc_create.max_key_interval = 240; /* Xvid's best default */
602
603 /* Quants */
606 else
608
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;
615
616 /* Quant Matrices */
619
624
630 } else
637 } else
639
640 for (
i = 0;
i < 64;
i++) {
641 if (intra)
643 if (inter)
645 }
646 }
647
648 /* Misc Settings */
649 xvid_enc_create.frame_drop_ratio = 0;
650 xvid_enc_create.global = 0;
652 xvid_enc_create.global |= XVID_GLOBAL_CLOSED_GOP;
653
654 /* Determines which codec mode we are operating in */
658 /* In this case, we are claiming to be MPEG-4 */
661 } else {
662 /* We are claiming to be Xvid */
666 }
667
668 /* Bframes */
673 xvid_enc_create.global |= XVID_GLOBAL_PACKED;
674
676
677 /* Encode a dummy frame to get the extradata immediately */
681 int size, got_packet;
682
684 if (!packet)
686
688 if (!picture) {
691 }
692
693 xerr = xvid_encore(
NULL, XVID_ENC_CREATE, &xvid_enc_create,
NULL);
694 if( xerr ) {
699 }
703 if (!picture->
data[0]) {
707 }
711 memset(picture->
data[1], 128,
size / 2);
717 }
718
719 /* Create encoder context */
720 xerr = xvid_encore(
NULL, XVID_ENC_CREATE, &xvid_enc_create,
NULL);
721 if (xerr) {
724 }
725
727
728 return 0;
729 }
730
732 const AVFrame *picture,
int *got_packet)
733 {
736 int mb_width = (avctx->
width + 15) / 16;
737 int mb_height = (avctx->
height + 15) / 16;
739
740 xvid_enc_frame_t xvid_enc_frame = { 0 };
741 xvid_enc_stats_t xvid_enc_stats = { 0 };
742
745
746 /* Start setting up the frame */
747 xvid_enc_frame.version = XVID_VERSION;
748 xvid_enc_stats.version = XVID_VERSION;
749
750 /* Let Xvid know where to put the frame. */
751 xvid_enc_frame.bitstream =
pkt->
data;
752 xvid_enc_frame.length =
pkt->
size;
753
754 /* Initialize input image fields */
757 "Xvid: Color spaces other than 420P not supported\n");
759 }
760
761 xvid_enc_frame.input.csp = XVID_CSP_PLANAR; /* YUV420P */
762
763 for (
i = 0;
i < 4;
i++) {
764 xvid_enc_frame.input.plane[
i] = picture->
data[
i];
765 xvid_enc_frame.input.stride[
i] = picture->
linesize[
i];
766 }
767
768 /* Encoder Flags */
771 xvid_enc_frame.motion = x->
me_flags;
772 xvid_enc_frame.type =
776 XVID_TYPE_AUTO;
777
778 /* Pixel aspect ratio setting */
782 "Invalid pixel aspect ratio %i/%i, limit is 255/255 reducing\n",
786 }
787 xvid_enc_frame.par = XVID_PAR_EXT;
790
791 /* Quant Setting */
794 else
795 xvid_enc_frame.quant = 0;
796
797 /* Matrices */
800
801 /* Encode */
803 &xvid_enc_frame, &xvid_enc_stats);
804
805 /* Two-pass log buffer swapping */
814 }
815 }
816
817 if (xerr > 0) {
818 int pict_type;
819
820 *got_packet = 1;
821
822 if (xvid_enc_stats.type == XVID_TYPE_PVOP)
824 else if (xvid_enc_stats.type == XVID_TYPE_BVOP)
826 else if (xvid_enc_stats.type == XVID_TYPE_SVOP)
828 else
830
832
833 if (xvid_enc_frame.out_flags & XVID_KEYFRAME) {
837 xvid_enc_stats.hlength, xerr);
838 }
839
841
842 return 0;
843 } else {
844 if (!xerr)
845 return 0;
847 "Xvid: Encoding Error Occurred: %i\n", xerr);
849 }
850 }
851
853 {
855
859 }
860
865 }
870 }
874
875 return 0;
876 }
877
878 #define OFFSET(x) offsetof(struct xvid_context, x)
879 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
892 };
893
899 };
900
914 .wrapper_name = "libxvid",
915 };