1 /*
2 * Interface to xvidcore for mpeg4 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 <xvid.h>
29 #include <unistd.h>
38
39 /**
40 * Buffer management macros.
41 */
42 #define BUFFER_SIZE 1024
43 #define BUFFER_REMAINING(x) (BUFFER_SIZE - strlen(x))
44 #define BUFFER_CAT(x) (&((x)[strlen(x)]))
45
46 /**
47 * Structure for the private Xvid context.
48 * This stores all the private context for the codec.
49 */
57 int qscale;
/**< Do we use constant scale? */
66 };
67
68 /**
69 * Structure for the private first-pass plugin.
70 */
74 };
75
77
78 /*
79 * Xvid 2-Pass Kludge Section
80 *
81 * Xvid's default 2-pass doesn't allow us to create data as we need to, so
82 * this section spends time replacing the first pass plugin so we can write
83 * statistic information as libavcodec requests in. We have another kludge
84 * that allows us to pass data to the second pass in Xvid without a custom
85 * rate-control plugin.
86 */
87
88 /**
89 * Initialize the two-pass plugin and context.
90 *
91 * @param param Input construction parameter structure
92 * @param handle Private context handle
93 * @return Returns XVID_ERR_xxxx on failure, or 0 on success.
94 */
96 void ** handle) {
99
100 /* Do a quick bounds check */
101 if( log == NULL )
102 return XVID_ERR_FAIL;
103
104 /* We use snprintf() */
105 /* This is because we can safely prevent a buffer overflow */
106 log[0] = 0;
108 "# ffmpeg 2-pass log file, using xvid codec\n");
110 "# Do not modify. libxvidcore version: %d.%d.%d\n\n",
111 XVID_VERSION_MAJOR(XVID_VERSION),
112 XVID_VERSION_MINOR(XVID_VERSION),
113 XVID_VERSION_PATCH(XVID_VERSION));
114
116 return 0;
117 }
118
119 /**
120 * Destroy the two-pass plugin context.
121 *
122 * @param ref Context pointer for the plugin
123 * @param param Destrooy context
124 * @return Returns 0, success guaranteed
125 */
127 xvid_plg_destroy_t *param) {
128 /* Currently cannot think of anything to do on destruction */
129 /* Still, the framework should be here for reference/use */
132 return 0;
133 }
134
135 /**
136 * Enable fast encode mode during the first pass.
137 *
138 * @param ref Context pointer for the plugin
139 * @param param Frame data
140 * @return Returns 0, success guaranteed
141 */
143 xvid_plg_data_t *param) {
144 int motion_remove;
145 int motion_replacements;
146 int vop_remove;
147
148 /* Nothing to do here, result is changed too much */
149 if( param->zone && param->zone->mode == XVID_ZONE_QUANT )
150 return 0;
151
152 /* We can implement a 'turbo' first pass mode here */
153 param->quant = 2;
154
155 /* Init values */
156 motion_remove = ~XVID_ME_CHROMA_PVOP &
157 ~XVID_ME_CHROMA_BVOP &
158 ~XVID_ME_EXTSEARCH16 &
159 ~XVID_ME_ADVANCEDDIAMOND16;
160 motion_replacements = XVID_ME_FAST_MODEINTERPOLATE |
161 XVID_ME_SKIP_DELTASEARCH |
162 XVID_ME_FASTREFINE16 |
163 XVID_ME_BFRAME_EARLYSTOP;
164 vop_remove = ~XVID_VOP_MODEDECISION_RD &
165 ~XVID_VOP_FAST_MODEDECISION_RD &
166 ~XVID_VOP_TRELLISQUANT &
167 ~XVID_VOP_INTER4V &
168 ~XVID_VOP_HQACPRED;
169
170 param->vol_flags &= ~XVID_VOL_GMC;
171 param->vop_flags &= vop_remove;
172 param->motion_flags &= motion_remove;
173 param->motion_flags |= motion_replacements;
174
175 return 0;
176 }
177
178 /**
179 * Capture statistic data and write it during first pass.
180 *
181 * @param ref Context pointer for the plugin
182 * @param param Statistic data
183 * @return Returns XVID_ERR_xxxx on failure, or 0 on success
184 */
186 xvid_plg_data_t *param) {
188 const char *frame_types = " ipbs";
189 char frame_type;
190
191 /* Quick bounds check */
192 if( log == NULL )
193 return XVID_ERR_FAIL;
194
195 /* Convert the type given to us into a character */
196 if( param->type < 5 && param->type > 0 ) {
197 frame_type = frame_types[param->type];
198 } else {
199 return XVID_ERR_FAIL;
200 }
201
203 "%c %d %d %d %d %d %d\n",
204 frame_type, param->stats.quant, param->stats.kblks, param->stats.mblks,
205 param->stats.ublks, param->stats.length, param->stats.hlength);
206
207 return 0;
208 }
209
210 /**
211 * Dispatch function for our custom plugin.
212 * This handles the dispatch for the Xvid plugin. It passes data
213 * on to other functions for actual processing.
214 *
215 * @param ref Context pointer for the plugin
216 * @param cmd The task given for us to complete
217 * @param p1 First parameter (varies)
218 * @param p2 Second parameter (varies)
219 * @return Returns XVID_ERR_xxxx on failure, or 0 on success
220 */
222 {
223 switch( cmd ) {
224 case XVID_PLG_INFO:
225 case XVID_PLG_FRAME:
226 return 0;
227
228 case XVID_PLG_BEFORE:
230
231 case XVID_PLG_CREATE:
233
234 case XVID_PLG_AFTER:
236
237 case XVID_PLG_DESTROY:
239
240 default:
241 return XVID_ERR_FAIL;
242 }
243 }
244
245 /**
246 * Routine to create a global VO/VOL header for MP4 container.
247 * What we do here is extract the header from the Xvid bitstream
248 * as it is encoded. We also strip the repeated headers from the
249 * bitstream when a global header is requested for MPEG-4 ISO
250 * compliance.
251 *
252 * @param avctx AVCodecContext pointer to context
253 * @param frame Pointer to encoded frame data
254 * @param header_len Length of header to search
255 * @param frame_len Length of encoded frame data
256 * @return Returns new length of frame data
257 */
260 unsigned int header_len,
261 unsigned int frame_len) {
262 int vo_len = 0, i;
263
264 for( i = 0; i < header_len - 3; i++ ) {
265 if( pkt->
data[i] == 0x00 &&
266 pkt->
data[i+1] == 0x00 &&
267 pkt->
data[i+2] == 0x01 &&
268 pkt->
data[i+3] == 0xB6 ) {
269 vo_len = i;
270 break;
271 }
272 }
273
274 if( vo_len > 0 ) {
275 /* We need to store the header, so extract it */
280 }
281 /* Less dangerous now, memmove properly copies the two
282 chunks of overlapping data */
283 memmove(pkt->
data, &pkt->
data[vo_len], frame_len - vo_len);
284 pkt->
size = frame_len - vo_len;
285 }
286 return 0;
287 }
288
289 /**
290 * Routine to correct a possibly erroneous framerate being fed to us.
291 * Xvid currently chokes on framerates where the ticks per frame is
292 * extremely large. This function works to correct problems in this area
293 * by estimating a new framerate and taking the simpler fraction of
294 * the two presented.
295 *
296 * @param avctx Context that contains the framerate to correct.
297 */
299 {
300 int frate, fbase;
301 int est_frate, est_fbase;
302 int gcd;
303 float est_fps, fps;
304
307
308 gcd =
av_gcd(frate, fbase);
309 if( gcd > 1 ) {
310 frate /= gcd;
311 fbase /= gcd;
312 }
313
314 if( frate <= 65000 && fbase <= 65000 ) {
317 return;
318 }
319
320 fps = (float)frate / (float)fbase;
321 est_fps =
roundf(fps * 1000.0) / 1000.0;
322
323 est_frate = (int)est_fps;
324 if( est_fps > (int)est_fps ) {
325 est_frate = (est_frate + 1) * 1000;
326 est_fbase = (int)
roundf((
float)est_frate / est_fps);
327 } else
328 est_fbase = 1;
329
330 gcd =
av_gcd(est_frate, est_fbase);
331 if( gcd > 1 ) {
332 est_frate /= gcd;
333 est_fbase /= gcd;
334 }
335
336 if( fbase > est_fbase ) {
340 "Xvid: framerate re-estimated: %.2f, %.3f%% correction\n",
341 est_fps, (((est_fps - fps)/fps) * 100.0));
342 } else {
345 }
346 }
347
349 int xerr, i;
350 int xvid_flags = avctx->
flags;
352 uint16_t *intra, *inter;
353 int fd;
354
355 xvid_plugin_single_t single = { 0 };
357 xvid_plugin_2pass2_t rc2pass2 = { 0 };
358 xvid_gbl_init_t xvid_gbl_init = { 0 };
359 xvid_enc_create_t xvid_enc_create = { 0 };
360 xvid_enc_plugin_t plugins[7];
361
363
364 /* Bring in VOP flags from ffmpeg command-line */
365 x->
vop_flags = XVID_VOP_HALFPEL;
/* Bare minimum quality */
367 x->
vop_flags |= XVID_VOP_INTER4V;
/* Level 3 */
369 )
370 x->
vop_flags |= XVID_VOP_TRELLISQUANT;
/* Level 5 */
372 x->
vop_flags |= XVID_VOP_HQACPRED;
/* Level 6 */
375
376 /* Decide which ME quality setting to use */
381 | XVID_ME_EXTSEARCH8;
382
384 x->
me_flags |= XVID_ME_ADVANCEDDIAMOND8
385 | XVID_ME_HALFPELREFINE8
386 | XVID_ME_CHROMA_PVOP
387 | XVID_ME_CHROMA_BVOP;
388
389 case ME_LOG:
/* Quality 2 */
392 x->
me_flags |= XVID_ME_ADVANCEDDIAMOND16
393 | XVID_ME_HALFPELREFINE16;
394
396 default:
397 break;
398 }
399
400 /* Decide how we should decide blocks */
402 case 2:
403 x->
vop_flags |= XVID_VOP_MODEDECISION_RD;
404 x->
me_flags |= XVID_ME_HALFPELREFINE8_RD
405 | XVID_ME_QUARTERPELREFINE8_RD
406 | XVID_ME_EXTSEARCH_RD
407 | XVID_ME_CHECKPREDICTION_RD;
408 case 1:
409 if( !(x->
vop_flags & XVID_VOP_MODEDECISION_RD) )
410 x->
vop_flags |= XVID_VOP_FAST_MODEDECISION_RD;
411 x->
me_flags |= XVID_ME_HALFPELREFINE16_RD
412 | XVID_ME_QUARTERPELREFINE16_RD;
413
414 default:
415 break;
416 }
417
418 /* Bring in VOL flags from ffmpeg command-line */
423 }
426 x->
me_flags |= XVID_ME_QUARTERPELREFINE16;
428 x->
me_flags |= XVID_ME_QUARTERPELREFINE8;
429 }
430
431 xvid_gbl_init.version = XVID_VERSION;
432 xvid_gbl_init.debug = 0;
433
434 #if ARCH_PPC
435 /* Xvid's PPC support is borked, use libavcodec to detect */
436 #if HAVE_ALTIVEC
438 xvid_gbl_init.cpu_flags = XVID_CPU_FORCE | XVID_CPU_ALTIVEC;
439 } else
440 #endif
441 xvid_gbl_init.cpu_flags = XVID_CPU_FORCE;
442 #else
443 /* Xvid can detect on x86 */
444 xvid_gbl_init.cpu_flags = 0;
445 #endif
446
447 /* Initialize */
448 xvid_global(NULL, XVID_GBL_INIT, &xvid_gbl_init, NULL);
449
450 /* Create the encoder reference */
451 xvid_enc_create.version = XVID_VERSION;
452
453 /* Store the desired frame size */
454 xvid_enc_create.width = x->
xsize = avctx->
width;
456
457 /* Xvid can determine the proper profile to use */
458 /* xvid_enc_create.profile = XVID_PROFILE_S_L3; */
459
460 /* We don't use zones */
461 xvid_enc_create.zones = NULL;
462 xvid_enc_create.num_zones = 0;
463
465
466 xvid_enc_create.plugins = plugins;
467 xvid_enc_create.num_plugins = 0;
468
469 /* Initialize Buffers */
473
475 rc2pass1.
version = XVID_VERSION;
481 "Xvid: Cannot allocate 2-pass log buffers\n");
482 goto fail;
483 }
485
487 plugins[xvid_enc_create.num_plugins].param = &rc2pass1;
488 xvid_enc_create.num_plugins++;
490 rc2pass2.
version = XVID_VERSION;
492
494 if( fd == -1 ) {
496 "Xvid: Cannot write 2-pass pipe\n");
497 goto fail;
498 }
500
503 "Xvid: No 2-pass information loaded for second pass\n");
504 goto fail;
505 }
506
510 "Xvid: Cannot write to 2-pass pipe\n");
511 goto fail;
512 }
513
515 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_2pass2;
516 plugins[xvid_enc_create.num_plugins].param = &rc2pass2;
517 xvid_enc_create.num_plugins++;
519 /* Single Pass Bitrate Control! */
520 single.version = XVID_VERSION;
522
523 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_single;
524 plugins[xvid_enc_create.num_plugins].param = &single;
525 xvid_enc_create.num_plugins++;
526 }
527
528 /* Luminance Masking */
530 plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
531 plugins[xvid_enc_create.num_plugins].param = NULL;
532 xvid_enc_create.num_plugins++;
533 }
534
535 /* Frame Rate and Key Frames */
540 xvid_enc_create.max_key_interval = avctx->
gop_size;
541 else
542 xvid_enc_create.max_key_interval = 240; /* Xvid's best default */
543
544 /* Quants */
545 if( xvid_flags & CODEC_FLAG_QSCALE ) x->
qscale = 1;
547
548 xvid_enc_create.min_quant[0] = avctx->
qmin;
549 xvid_enc_create.min_quant[1] = avctx->
qmin;
550 xvid_enc_create.min_quant[2] = avctx->
qmin;
551 xvid_enc_create.max_quant[0] = avctx->
qmax;
552 xvid_enc_create.max_quant[1] = avctx->
qmax;
553 xvid_enc_create.max_quant[2] = avctx->
qmax;
554
555 /* Quant Matrices */
561
565 } else
566 intra = NULL;
570 } else
571 inter = NULL;
572
573 for( i = 0; i < 64; i++ ) {
574 if( intra )
576 if( inter )
578 }
579 }
580
581 /* Misc Settings */
582 xvid_enc_create.frame_drop_ratio = 0;
583 xvid_enc_create.global = 0;
585 xvid_enc_create.global |= XVID_GLOBAL_CLOSED_GOP;
586
587 /* Determines which codec mode we are operating in */
591 /* In this case, we are claiming to be MPEG4 */
594 } else {
595 /* We are claiming to be Xvid */
599 }
600
601 /* Bframes */
606
607 /* Create encoder context */
608 xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
609 if( xerr ) {
611 goto fail;
612 }
613
616
617 return 0;
618 fail:
620 return -1;
621 }
622
624 const AVFrame *picture,
int *got_packet)
625 {
626 int xerr, i,
ret, user_packet = !!pkt->
data;
627 char *tmp;
630 int mb_width = (avctx->
width + 15) / 16;
631 int mb_height = (avctx->
height + 15) / 16;
632
633 xvid_enc_frame_t xvid_enc_frame = { 0 };
634 xvid_enc_stats_t xvid_enc_stats = { 0 };
635
638
639 /* Start setting up the frame */
640 xvid_enc_frame.version = XVID_VERSION;
641 xvid_enc_stats.version = XVID_VERSION;
642 *p = *picture;
643
644 /* Let Xvid know where to put the frame. */
645 xvid_enc_frame.bitstream = pkt->
data;
646 xvid_enc_frame.length = pkt->
size;
647
648 /* Initialize input image fields */
651 return -1;
652 }
653
654 xvid_enc_frame.input.csp = XVID_CSP_PLANAR; /* YUV420P */
655
656 for( i = 0; i < 4; i++ ) {
657 xvid_enc_frame.input.plane[i] = picture->
data[i];
658 xvid_enc_frame.input.stride[i] = picture->
linesize[i];
659 }
660
661 /* Encoder Flags */
664 xvid_enc_frame.motion = x->
me_flags;
665 xvid_enc_frame.type =
669 XVID_TYPE_AUTO;
670
671 /* Pixel aspect ratio setting */
676 return -1;
677 }
678 xvid_enc_frame.par = XVID_PAR_EXT;
681
682 /* Quant Setting */
684 else xvid_enc_frame.quant = 0;
685
686 /* Matrices */
689
690 /* Encode */
692 &xvid_enc_frame, &xvid_enc_stats);
693
694 /* Two-pass log buffer swapping */
703 }
704 }
705
706 if (xerr > 0) {
707 *got_packet = 1;
708
710 if( xvid_enc_stats.type == XVID_TYPE_PVOP )
712 else if( xvid_enc_stats.type == XVID_TYPE_BVOP )
714 else if( xvid_enc_stats.type == XVID_TYPE_SVOP )
716 else
718 if( xvid_enc_frame.out_flags & XVID_KEYFRAME ) {
723 xvid_enc_stats.hlength, xerr);
724 } else
726
728
729 return 0;
730 } else {
731 if (!user_packet)
733 if (!xerr)
734 return 0;
736 return -1;
737 }
738 }
739
742
746
752 }
757 }
761
762 return 0;
763 }
764
775 };