git.sesse.net Git - ffmpeg/blob - libavcodec/libxvidff.c

   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 /* needed for mkstemp() */
  29 #define _XOPEN_SOURCE 600
  30
  31 #include <xvid.h>
  32 #include <unistd.h>
  33 #include "avcodec.h"
  34 #include "libavutil/intreadwrite.h"
  35 #include "libxvid_internal.h"
  36 #if !HAVE_MKSTEMP
  37 #include <fcntl.h>
  38 #endif
  39
  40 /**
  41  * Buffer management macros.
  42  */
  43 #define BUFFER_SIZE                 1024
  44 #define BUFFER_REMAINING(x)         (BUFFER_SIZE - strlen(x))
  45 #define BUFFER_CAT(x)               (&((x)[strlen(x)]))
  46
  47 /* For PPC Use */
  48 int has_altivec(void);
  49
  50 /**
  51  * Structure for the private Xvid context.
  52  * This stores all the private context for the codec.
  53  */
  54 struct xvid_context {
  55     void *encoder_handle;          /** Handle for Xvid encoder */
  56     int xsize, ysize;              /** Frame size */
  57     int vop_flags;                 /** VOP flags for Xvid encoder */
  58     int vol_flags;                 /** VOL flags for Xvid encoder */
  59     int me_flags;                  /** Motion Estimation flags */
  60     int qscale;                    /** Do we use constant scale? */
  61     int quicktime_format;          /** Are we in a QT-based format? */
  62     AVFrame encoded_picture;       /** Encoded frame information */
  63     char *twopassbuffer;           /** Character buffer for two-pass */
  64     char *old_twopassbuffer;       /** Old character buffer (two-pass) */
  65     char *twopassfile;             /** second pass temp file name */
  66     unsigned char *intra_matrix;   /** P-Frame Quant Matrix */
  67     unsigned char *inter_matrix;   /** I-Frame Quant Matrix */
  68 };
  69
  70 /**
  71  * Structure for the private first-pass plugin.
  72  */
  73 struct xvid_ff_pass1 {
  74     int     version;                /** Xvid version */
  75     struct xvid_context *context;        /** Pointer to private context */
  76 };
  77
  78 /* Prototypes - See function implementation for details */
  79 int xvid_strip_vol_header(AVCodecContext *avctx, unsigned char *frame, unsigned int header_len, unsigned int frame_len);
  80 int xvid_ff_2pass(void *ref, int opt, void *p1, void *p2);
  81 void xvid_correct_framerate(AVCodecContext *avctx);
  82
  83 /* Wrapper to work around the lack of mkstemp() on mingw.
  84  * Also, tries to create file in /tmp first, if possible.
  85  * *prefix can be a character constant; *filename will be allocated internally.
  86  * @return file descriptor of opened file (or -1 on error)
  87  * and opened file name in **filename. */
  88 int ff_tempfile(const char *prefix, char **filename) {
  89     int fd=-1;
  90 #if !HAVE_MKSTEMP
  91     *filename = tempnam(".", prefix);
  92 #else
  93     size_t len = strlen(prefix) + 12; /* room for "/tmp/" and "XXXXXX\0" */
  94     *filename = av_malloc(len);
  95 #endif
  96     /* -----common section-----*/
  97     if (*filename == NULL) {
  98         av_log(NULL, AV_LOG_ERROR, "ff_tempfile: Cannot allocate file name\n");
  99         return -1;
 100     }
 101 #if !HAVE_MKSTEMP
 102     fd = open(*filename, O_RDWR | O_BINARY | O_CREAT, 0444);
 103 #else
 104     snprintf(*filename, len, "/tmp/%sXXXXXX", prefix);
 105     fd = mkstemp(*filename);
 106     if (fd < 0) {
 107         snprintf(*filename, len, "./%sXXXXXX", prefix);
 108         fd = mkstemp(*filename);
 109     }
 110 #endif
 111     /* -----common section-----*/
 112     if (fd < 0) {
 113         av_log(NULL, AV_LOG_ERROR, "ff_tempfile: Cannot open temporary file %s\n", *filename);
 114         return -1;
 115     }
 116     return fd; /* success */
 117 }
 118
 119 #if CONFIG_LIBXVID_ENCODER
 120
 121 /**
 122  * Create the private context for the encoder.
 123  * All buffers are allocated, settings are loaded from the user,
 124  * and the encoder context created.
 125  *
 126  * @param avctx AVCodecContext pointer to context
 127  * @return Returns 0 on success, -1 on failure
 128  */
 129 static av_cold int xvid_encode_init(AVCodecContext *avctx)  {
 130     int xerr, i;
 131     int xvid_flags = avctx->flags;
 132     struct xvid_context *x = avctx->priv_data;
 133     uint16_t *intra, *inter;
 134     int fd;
 135
 136     xvid_plugin_single_t single;
 137     struct xvid_ff_pass1 rc2pass1;
 138     xvid_plugin_2pass2_t rc2pass2;
 139     xvid_gbl_init_t xvid_gbl_init;
 140     xvid_enc_create_t xvid_enc_create;
 141     xvid_enc_plugin_t plugins[7];
 142
 143     /* Bring in VOP flags from ffmpeg command-line */
 144     x->vop_flags = XVID_VOP_HALFPEL; /* Bare minimum quality */
 145     if( xvid_flags & CODEC_FLAG_4MV )
 146         x->vop_flags |= XVID_VOP_INTER4V; /* Level 3 */
 147     if( avctx->trellis
 148         )
 149         x->vop_flags |= XVID_VOP_TRELLISQUANT; /* Level 5 */
 150     if( xvid_flags & CODEC_FLAG_AC_PRED )
 151         x->vop_flags |= XVID_VOP_HQACPRED; /* Level 6 */
 152     if( xvid_flags & CODEC_FLAG_GRAY )
 153         x->vop_flags |= XVID_VOP_GREYSCALE;
 154
 155     /* Decide which ME quality setting to use */
 156     x->me_flags = 0;
 157     switch( avctx->me_method ) {
 158        case ME_FULL:   /* Quality 6 */
 159            x->me_flags |=  XVID_ME_EXTSEARCH16
 160                        |   XVID_ME_EXTSEARCH8;
 161
 162        case ME_EPZS:   /* Quality 4 */
 163            x->me_flags |=  XVID_ME_ADVANCEDDIAMOND8
 164                        |   XVID_ME_HALFPELREFINE8
 165                        |   XVID_ME_CHROMA_PVOP
 166                        |   XVID_ME_CHROMA_BVOP;
 167
 168        case ME_LOG:    /* Quality 2 */
 169        case ME_PHODS:
 170        case ME_X1:
 171            x->me_flags |=  XVID_ME_ADVANCEDDIAMOND16
 172                        |   XVID_ME_HALFPELREFINE16;
 173
 174        case ME_ZERO:   /* Quality 0 */
 175        default:
 176            break;
 177     }
 178
 179     /* Decide how we should decide blocks */
 180     switch( avctx->mb_decision ) {
 181        case 2:
 182            x->vop_flags |= XVID_VOP_MODEDECISION_RD;
 183            x->me_flags |=  XVID_ME_HALFPELREFINE8_RD
 184                        |   XVID_ME_QUARTERPELREFINE8_RD
 185                        |   XVID_ME_EXTSEARCH_RD
 186                        |   XVID_ME_CHECKPREDICTION_RD;
 187        case 1:
 188            if( !(x->vop_flags & XVID_VOP_MODEDECISION_RD) )
 189                x->vop_flags |= XVID_VOP_FAST_MODEDECISION_RD;
 190            x->me_flags |=  XVID_ME_HALFPELREFINE16_RD
 191                        |   XVID_ME_QUARTERPELREFINE16_RD;
 192
 193        default:
 194            break;
 195     }
 196
 197     /* Bring in VOL flags from ffmpeg command-line */
 198     x->vol_flags = 0;
 199     if( xvid_flags & CODEC_FLAG_GMC ) {
 200         x->vol_flags |= XVID_VOL_GMC;
 201         x->me_flags |= XVID_ME_GME_REFINE;
 202     }
 203     if( xvid_flags & CODEC_FLAG_QPEL ) {
 204         x->vol_flags |= XVID_VOL_QUARTERPEL;
 205         x->me_flags |= XVID_ME_QUARTERPELREFINE16;
 206         if( x->vop_flags & XVID_VOP_INTER4V )
 207             x->me_flags |= XVID_ME_QUARTERPELREFINE8;
 208     }
 209
 210     memset(&xvid_gbl_init, 0, sizeof(xvid_gbl_init));
 211     xvid_gbl_init.version = XVID_VERSION;
 212     xvid_gbl_init.debug = 0;
 213
 214 #if ARCH_PPC
 215     /* Xvid's PPC support is borked, use libavcodec to detect */
 216 #if HAVE_ALTIVEC
 217     if( has_altivec() ) {
 218         xvid_gbl_init.cpu_flags = XVID_CPU_FORCE | XVID_CPU_ALTIVEC;
 219     } else
 220 #endif
 221         xvid_gbl_init.cpu_flags = XVID_CPU_FORCE;
 222 #else
 223     /* Xvid can detect on x86 */
 224     xvid_gbl_init.cpu_flags = 0;
 225 #endif
 226
 227     /* Initialize */
 228     xvid_global(NULL, XVID_GBL_INIT, &xvid_gbl_init, NULL);
 229
 230     /* Create the encoder reference */
 231     memset(&xvid_enc_create, 0, sizeof(xvid_enc_create));
 232     xvid_enc_create.version = XVID_VERSION;
 233
 234     /* Store the desired frame size */
 235     xvid_enc_create.width = x->xsize = avctx->width;
 236     xvid_enc_create.height = x->ysize = avctx->height;
 237
 238     /* Xvid can determine the proper profile to use */
 239     /* xvid_enc_create.profile = XVID_PROFILE_S_L3; */
 240
 241     /* We don't use zones */
 242     xvid_enc_create.zones = NULL;
 243     xvid_enc_create.num_zones = 0;
 244
 245     xvid_enc_create.num_threads = avctx->thread_count;
 246
 247     xvid_enc_create.plugins = plugins;
 248     xvid_enc_create.num_plugins = 0;
 249
 250     /* Initialize Buffers */
 251     x->twopassbuffer = NULL;
 252     x->old_twopassbuffer = NULL;
 253     x->twopassfile = NULL;
 254
 255     if( xvid_flags & CODEC_FLAG_PASS1 ) {
 256         memset(&rc2pass1, 0, sizeof(struct xvid_ff_pass1));
 257         rc2pass1.version = XVID_VERSION;
 258         rc2pass1.context = x;
 259         x->twopassbuffer = av_malloc(BUFFER_SIZE);
 260         x->old_twopassbuffer = av_malloc(BUFFER_SIZE);
 261         if( x->twopassbuffer == NULL || x->old_twopassbuffer == NULL ) {
 262             av_log(avctx, AV_LOG_ERROR,
 263                 "Xvid: Cannot allocate 2-pass log buffers\n");
 264             return -1;
 265         }
 266         x->twopassbuffer[0] = x->old_twopassbuffer[0] = 0;
 267
 268         plugins[xvid_enc_create.num_plugins].func = xvid_ff_2pass;
 269         plugins[xvid_enc_create.num_plugins].param = &rc2pass1;
 270         xvid_enc_create.num_plugins++;
 271     } else if( xvid_flags & CODEC_FLAG_PASS2 ) {
 272         memset(&rc2pass2, 0, sizeof(xvid_plugin_2pass2_t));
 273         rc2pass2.version = XVID_VERSION;
 274         rc2pass2.bitrate = avctx->bit_rate;
 275
 276         fd = ff_tempfile("xvidff.", &(x->twopassfile));
 277         if( fd == -1 ) {
 278             av_log(avctx, AV_LOG_ERROR,
 279                 "Xvid: Cannot write 2-pass pipe\n");
 280             return -1;
 281         }
 282
 283         if( avctx->stats_in == NULL ) {
 284             av_log(avctx, AV_LOG_ERROR,
 285                 "Xvid: No 2-pass information loaded for second pass\n");
 286             return -1;
 287         }
 288
 289         if( strlen(avctx->stats_in) >
 290               write(fd, avctx->stats_in, strlen(avctx->stats_in)) ) {
 291             close(fd);
 292             av_log(avctx, AV_LOG_ERROR,
 293                 "Xvid: Cannot write to 2-pass pipe\n");
 294             return -1;
 295         }
 296
 297         close(fd);
 298         rc2pass2.filename = x->twopassfile;
 299         plugins[xvid_enc_create.num_plugins].func = xvid_plugin_2pass2;
 300         plugins[xvid_enc_create.num_plugins].param = &rc2pass2;
 301         xvid_enc_create.num_plugins++;
 302     } else if( !(xvid_flags & CODEC_FLAG_QSCALE) ) {
 303         /* Single Pass Bitrate Control! */
 304         memset(&single, 0, sizeof(xvid_plugin_single_t));
 305         single.version = XVID_VERSION;
 306         single.bitrate = avctx->bit_rate;
 307
 308         plugins[xvid_enc_create.num_plugins].func = xvid_plugin_single;
 309         plugins[xvid_enc_create.num_plugins].param = &single;
 310         xvid_enc_create.num_plugins++;
 311     }
 312
 313     /* Luminance Masking */
 314     if( 0.0 != avctx->lumi_masking ) {
 315         plugins[xvid_enc_create.num_plugins].func = xvid_plugin_lumimasking;
 316         plugins[xvid_enc_create.num_plugins].param = NULL;
 317         xvid_enc_create.num_plugins++;
 318     }
 319
 320     /* Frame Rate and Key Frames */
 321     xvid_correct_framerate(avctx);
 322     xvid_enc_create.fincr = avctx->time_base.num;
 323     xvid_enc_create.fbase = avctx->time_base.den;
 324     if( avctx->gop_size > 0 )
 325         xvid_enc_create.max_key_interval = avctx->gop_size;
 326     else
 327         xvid_enc_create.max_key_interval = 240; /* Xvid's best default */
 328
 329     /* Quants */
 330     if( xvid_flags & CODEC_FLAG_QSCALE ) x->qscale = 1;
 331     else x->qscale = 0;
 332
 333     xvid_enc_create.min_quant[0] = avctx->qmin;
 334     xvid_enc_create.min_quant[1] = avctx->qmin;
 335     xvid_enc_create.min_quant[2] = avctx->qmin;
 336     xvid_enc_create.max_quant[0] = avctx->qmax;
 337     xvid_enc_create.max_quant[1] = avctx->qmax;
 338     xvid_enc_create.max_quant[2] = avctx->qmax;
 339
 340     /* Quant Matrices */
 341     x->intra_matrix = x->inter_matrix = NULL;
 342     if( avctx->mpeg_quant )
 343        x->vol_flags |= XVID_VOL_MPEGQUANT;
 344     if( (avctx->intra_matrix || avctx->inter_matrix) ) {
 345        x->vol_flags |= XVID_VOL_MPEGQUANT;
 346
 347        if( avctx->intra_matrix ) {
 348            intra = avctx->intra_matrix;
 349            x->intra_matrix = av_malloc(sizeof(unsigned char) * 64);
 350        } else
 351            intra = NULL;
 352        if( avctx->inter_matrix ) {
 353            inter = avctx->inter_matrix;
 354            x->inter_matrix = av_malloc(sizeof(unsigned char) * 64);
 355        } else
 356            inter = NULL;
 357
 358        for( i = 0; i < 64; i++ ) {
 359            if( intra )
 360                x->intra_matrix[i] = (unsigned char)intra[i];
 361            if( inter )
 362                x->inter_matrix[i] = (unsigned char)inter[i];
 363        }
 364     }
 365
 366     /* Misc Settings */
 367     xvid_enc_create.frame_drop_ratio = 0;
 368     xvid_enc_create.global = 0;
 369     if( xvid_flags & CODEC_FLAG_CLOSED_GOP )
 370         xvid_enc_create.global |= XVID_GLOBAL_CLOSED_GOP;
 371
 372     /* Determines which codec mode we are operating in */
 373     avctx->extradata = NULL;
 374     avctx->extradata_size = 0;
 375     if( xvid_flags & CODEC_FLAG_GLOBAL_HEADER ) {
 376         /* In this case, we are claiming to be MPEG4 */
 377         x->quicktime_format = 1;
 378         avctx->codec_id = CODEC_ID_MPEG4;
 379     } else {
 380         /* We are claiming to be Xvid */
 381         x->quicktime_format = 0;
 382         if(!avctx->codec_tag)
 383             avctx->codec_tag = AV_RL32("xvid");
 384     }
 385
 386     /* Bframes */
 387     xvid_enc_create.max_bframes = avctx->max_b_frames;
 388     xvid_enc_create.bquant_offset = 100 * avctx->b_quant_offset;
 389     xvid_enc_create.bquant_ratio = 100 * avctx->b_quant_factor;
 390     if( avctx->max_b_frames > 0  && !x->quicktime_format ) xvid_enc_create.global |= XVID_GLOBAL_PACKED;
 391
 392     /* Create encoder context */
 393     xerr = xvid_encore(NULL, XVID_ENC_CREATE, &xvid_enc_create, NULL);
 394     if( xerr ) {
 395         av_log(avctx, AV_LOG_ERROR, "Xvid: Could not create encoder reference\n");
 396         return -1;
 397     }
 398
 399     x->encoder_handle = xvid_enc_create.handle;
 400     avctx->coded_frame = &x->encoded_picture;
 401
 402     return 0;
 403 }
 404
 405 /**
 406  * Encode a single frame.
 407  *
 408  * @param avctx AVCodecContext pointer to context
 409  * @param frame Pointer to encoded frame buffer
 410  * @param buf_size Size of encoded frame buffer
 411  * @param data Pointer to AVFrame of unencoded frame
 412  * @return Returns 0 on success, -1 on failure
 413  */
 414 static int xvid_encode_frame(AVCodecContext *avctx,
 415                          unsigned char *frame, int buf_size, void *data) {
 416     int xerr, i;
 417     char *tmp;
 418     struct xvid_context *x = avctx->priv_data;
 419     AVFrame *picture = data;
 420     AVFrame *p = &(x->encoded_picture);
 421
 422     xvid_enc_frame_t xvid_enc_frame;
 423     xvid_enc_stats_t xvid_enc_stats;
 424
 425     /* Start setting up the frame */
 426     memset(&xvid_enc_frame, 0, sizeof(xvid_enc_frame));
 427     xvid_enc_frame.version = XVID_VERSION;
 428     memset(&xvid_enc_stats, 0, sizeof(xvid_enc_stats));
 429     xvid_enc_stats.version = XVID_VERSION;
 430     *p = *picture;
 431
 432     /* Let Xvid know where to put the frame. */
 433     xvid_enc_frame.bitstream = frame;
 434     xvid_enc_frame.length = buf_size;
 435
 436     /* Initialize input image fields */
 437     if( avctx->pix_fmt != PIX_FMT_YUV420P ) {
 438         av_log(avctx, AV_LOG_ERROR, "Xvid: Color spaces other than 420p not supported\n");
 439         return -1;
 440     }
 441
 442     xvid_enc_frame.input.csp = XVID_CSP_PLANAR; /* YUV420P */
 443
 444     for( i = 0; i < 4; i++ ) {
 445         xvid_enc_frame.input.plane[i] = picture->data[i];
 446         xvid_enc_frame.input.stride[i] = picture->linesize[i];
 447     }
 448
 449     /* Encoder Flags */
 450     xvid_enc_frame.vop_flags = x->vop_flags;
 451     xvid_enc_frame.vol_flags = x->vol_flags;
 452     xvid_enc_frame.motion = x->me_flags;
 453     xvid_enc_frame.type = XVID_TYPE_AUTO;
 454
 455     /* Pixel aspect ratio setting */
 456     if (avctx->sample_aspect_ratio.num < 1 || avctx->sample_aspect_ratio.num > 255 ||
 457         avctx->sample_aspect_ratio.den < 1 || avctx->sample_aspect_ratio.den > 255) {
 458         av_log(avctx, AV_LOG_ERROR, "Invalid pixel aspect ratio %i/%i\n",
 459                avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den);
 460         return -1;
 461     }
 462     xvid_enc_frame.par = XVID_PAR_EXT;
 463     xvid_enc_frame.par_width  = avctx->sample_aspect_ratio.num;
 464     xvid_enc_frame.par_height = avctx->sample_aspect_ratio.den;
 465
 466     /* Quant Setting */
 467     if( x->qscale ) xvid_enc_frame.quant = picture->quality / FF_QP2LAMBDA;
 468     else xvid_enc_frame.quant = 0;
 469
 470     /* Matrices */
 471     xvid_enc_frame.quant_intra_matrix = x->intra_matrix;
 472     xvid_enc_frame.quant_inter_matrix = x->inter_matrix;
 473
 474     /* Encode */
 475     xerr = xvid_encore(x->encoder_handle, XVID_ENC_ENCODE,
 476         &xvid_enc_frame, &xvid_enc_stats);
 477
 478     /* Two-pass log buffer swapping */
 479     avctx->stats_out = NULL;
 480     if( x->twopassbuffer ) {
 481         tmp = x->old_twopassbuffer;
 482         x->old_twopassbuffer = x->twopassbuffer;
 483         x->twopassbuffer = tmp;
 484         x->twopassbuffer[0] = 0;
 485         if( x->old_twopassbuffer[0] != 0 ) {
 486             avctx->stats_out = x->old_twopassbuffer;
 487         }
 488     }
 489
 490     if( 0 <= xerr ) {
 491         p->quality = xvid_enc_stats.quant * FF_QP2LAMBDA;
 492         if( xvid_enc_stats.type == XVID_TYPE_PVOP )
 493             p->pict_type = FF_P_TYPE;
 494         else if( xvid_enc_stats.type == XVID_TYPE_BVOP )
 495             p->pict_type = FF_B_TYPE;
 496         else if( xvid_enc_stats.type == XVID_TYPE_SVOP )
 497             p->pict_type = FF_S_TYPE;
 498         else
 499             p->pict_type = FF_I_TYPE;
 500         if( xvid_enc_frame.out_flags & XVID_KEYFRAME ) {
 501             p->key_frame = 1;
 502             if( x->quicktime_format )
 503                 return xvid_strip_vol_header(avctx, frame,
 504                     xvid_enc_stats.hlength, xerr);
 505          } else
 506             p->key_frame = 0;
 507
 508         return xerr;
 509     } else {
 510         av_log(avctx, AV_LOG_ERROR, "Xvid: Encoding Error Occurred: %i\n", xerr);
 511         return -1;
 512     }
 513 }
 514
 515 /**
 516  * Destroy the private context for the encoder.
 517  * All buffers are freed, and the Xvid encoder context is destroyed.
 518  *
 519  * @param avctx AVCodecContext pointer to context
 520  * @return Returns 0, success guaranteed
 521  */
 522 static av_cold int xvid_encode_close(AVCodecContext *avctx) {
 523     struct xvid_context *x = avctx->priv_data;
 524
 525     xvid_encore(x->encoder_handle, XVID_ENC_DESTROY, NULL, NULL);
 526
 527     if( avctx->extradata != NULL )
 528         av_freep(&avctx->extradata);
 529     if( x->twopassbuffer != NULL ) {
 530         av_free(x->twopassbuffer);
 531         av_free(x->old_twopassbuffer);
 532     }
 533     if( x->twopassfile != NULL )
 534         av_free(x->twopassfile);
 535     if( x->intra_matrix != NULL )
 536         av_free(x->intra_matrix);
 537     if( x->inter_matrix != NULL )
 538         av_free(x->inter_matrix);
 539
 540     return 0;
 541 }
 542
 543 /**
 544  * Routine to create a global VO/VOL header for MP4 container.
 545  * What we do here is extract the header from the Xvid bitstream
 546  * as it is encoded. We also strip the repeated headers from the
 547  * bitstream when a global header is requested for MPEG-4 ISO
 548  * compliance.
 549  *
 550  * @param avctx AVCodecContext pointer to context
 551  * @param frame Pointer to encoded frame data
 552  * @param header_len Length of header to search
 553  * @param frame_len Length of encoded frame data
 554  * @return Returns new length of frame data
 555  */
 556 int xvid_strip_vol_header(AVCodecContext *avctx,
 557                   unsigned char *frame,
 558                   unsigned int header_len,
 559                   unsigned int frame_len) {
 560     int vo_len = 0, i;
 561
 562     for( i = 0; i < header_len - 3; i++ ) {
 563         if( frame[i] == 0x00 &&
 564             frame[i+1] == 0x00 &&
 565             frame[i+2] == 0x01 &&
 566             frame[i+3] == 0xB6 ) {
 567             vo_len = i;
 568             break;
 569         }
 570     }
 571
 572     if( vo_len > 0 ) {
 573         /* We need to store the header, so extract it */
 574         if( avctx->extradata == NULL ) {
 575             avctx->extradata = av_malloc(vo_len);
 576             memcpy(avctx->extradata, frame, vo_len);
 577             avctx->extradata_size = vo_len;
 578         }
 579         /* Less dangerous now, memmove properly copies the two
 580            chunks of overlapping data */
 581         memmove(frame, &(frame[vo_len]), frame_len - vo_len);
 582         return frame_len - vo_len;
 583     } else
 584         return frame_len;
 585 }
 586
 587 /**
 588  * Routine to correct a possibly erroneous framerate being fed to us.
 589  * Xvid currently chokes on framerates where the ticks per frame is
 590  * extremely large. This function works to correct problems in this area
 591  * by estimating a new framerate and taking the simpler fraction of
 592  * the two presented.
 593  *
 594  * @param avctx Context that contains the framerate to correct.
 595  */
 596 void xvid_correct_framerate(AVCodecContext *avctx) {
 597     int frate, fbase;
 598     int est_frate, est_fbase;
 599     int gcd;
 600     float est_fps, fps;
 601
 602     frate = avctx->time_base.den;
 603     fbase = avctx->time_base.num;
 604
 605     gcd = av_gcd(frate, fbase);
 606     if( gcd > 1 ) {
 607         frate /= gcd;
 608         fbase /= gcd;
 609     }
 610
 611     if( frate <= 65000 && fbase <= 65000 ) {
 612         avctx->time_base.den = frate;
 613         avctx->time_base.num = fbase;
 614         return;
 615     }
 616
 617     fps = (float)frate / (float)fbase;
 618     est_fps = roundf(fps * 1000.0) / 1000.0;
 619
 620     est_frate = (int)est_fps;
 621     if( est_fps > (int)est_fps ) {
 622         est_frate = (est_frate + 1) * 1000;
 623         est_fbase = (int)roundf((float)est_frate / est_fps);
 624     } else
 625         est_fbase = 1;
 626
 627     gcd = av_gcd(est_frate, est_fbase);
 628     if( gcd > 1 ) {
 629         est_frate /= gcd;
 630         est_fbase /= gcd;
 631     }
 632
 633     if( fbase > est_fbase ) {
 634         avctx->time_base.den = est_frate;
 635         avctx->time_base.num = est_fbase;
 636         av_log(avctx, AV_LOG_DEBUG,
 637             "Xvid: framerate re-estimated: %.2f, %.3f%% correction\n",
 638             est_fps, (((est_fps - fps)/fps) * 100.0));
 639     } else {
 640         avctx->time_base.den = frate;
 641         avctx->time_base.num = fbase;
 642     }
 643 }
 644
 645 /*
 646  * Xvid 2-Pass Kludge Section
 647  *
 648  * Xvid's default 2-pass doesn't allow us to create data as we need to, so
 649  * this section spends time replacing the first pass plugin so we can write
 650  * statistic information as libavcodec requests in. We have another kludge
 651  * that allows us to pass data to the second pass in Xvid without a custom
 652  * rate-control plugin.
 653  */
 654
 655 /**
 656  * Initialize the two-pass plugin and context.
 657  *
 658  * @param param Input construction parameter structure
 659  * @param handle Private context handle
 660  * @return Returns XVID_ERR_xxxx on failure, or 0 on success.
 661  */
 662 static int xvid_ff_2pass_create(xvid_plg_create_t * param,
 663                                 void ** handle) {
 664     struct xvid_ff_pass1 *x = (struct xvid_ff_pass1 *)param->param;
 665     char *log = x->context->twopassbuffer;
 666
 667     /* Do a quick bounds check */
 668     if( log == NULL )
 669         return XVID_ERR_FAIL;
 670
 671     /* We use snprintf() */
 672     /* This is because we can safely prevent a buffer overflow */
 673     log[0] = 0;
 674     snprintf(log, BUFFER_REMAINING(log),
 675         "# ffmpeg 2-pass log file, using xvid codec\n");
 676     snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
 677         "# Do not modify. libxvidcore version: %d.%d.%d\n\n",
 678         XVID_VERSION_MAJOR(XVID_VERSION),
 679         XVID_VERSION_MINOR(XVID_VERSION),
 680         XVID_VERSION_PATCH(XVID_VERSION));
 681
 682     *handle = x->context;
 683     return 0;
 684 }
 685
 686 /**
 687  * Destroy the two-pass plugin context.
 688  *
 689  * @param ref Context pointer for the plugin
 690  * @param param Destrooy context
 691  * @return Returns 0, success guaranteed
 692  */
 693 static int xvid_ff_2pass_destroy(struct xvid_context *ref,
 694                                 xvid_plg_destroy_t *param) {
 695     /* Currently cannot think of anything to do on destruction */
 696     /* Still, the framework should be here for reference/use */
 697     if( ref->twopassbuffer != NULL )
 698         ref->twopassbuffer[0] = 0;
 699     return 0;
 700 }
 701
 702 /**
 703  * Enable fast encode mode during the first pass.
 704  *
 705  * @param ref Context pointer for the plugin
 706  * @param param Frame data
 707  * @return Returns 0, success guaranteed
 708  */
 709 static int xvid_ff_2pass_before(struct xvid_context *ref,
 710                                 xvid_plg_data_t *param) {
 711     int motion_remove;
 712     int motion_replacements;
 713     int vop_remove;
 714
 715     /* Nothing to do here, result is changed too much */
 716     if( param->zone && param->zone->mode == XVID_ZONE_QUANT )
 717         return 0;
 718
 719     /* We can implement a 'turbo' first pass mode here */
 720     param->quant = 2;
 721
 722     /* Init values */
 723     motion_remove = ~XVID_ME_CHROMA_PVOP &
 724                     ~XVID_ME_CHROMA_BVOP &
 725                     ~XVID_ME_EXTSEARCH16 &
 726                     ~XVID_ME_ADVANCEDDIAMOND16;
 727     motion_replacements = XVID_ME_FAST_MODEINTERPOLATE |
 728                           XVID_ME_SKIP_DELTASEARCH |
 729                           XVID_ME_FASTREFINE16 |
 730                           XVID_ME_BFRAME_EARLYSTOP;
 731     vop_remove = ~XVID_VOP_MODEDECISION_RD &
 732                  ~XVID_VOP_FAST_MODEDECISION_RD &
 733                  ~XVID_VOP_TRELLISQUANT &
 734                  ~XVID_VOP_INTER4V &
 735                  ~XVID_VOP_HQACPRED;
 736
 737     param->vol_flags &= ~XVID_VOL_GMC;
 738     param->vop_flags &= vop_remove;
 739     param->motion_flags &= motion_remove;
 740     param->motion_flags |= motion_replacements;
 741
 742     return 0;
 743 }
 744
 745 /**
 746  * Capture statistic data and write it during first pass.
 747  *
 748  * @param ref Context pointer for the plugin
 749  * @param param Statistic data
 750  * @return Returns XVID_ERR_xxxx on failure, or 0 on success
 751  */
 752 static int xvid_ff_2pass_after(struct xvid_context *ref,
 753                                 xvid_plg_data_t *param) {
 754     char *log = ref->twopassbuffer;
 755     char *frame_types = " ipbs";
 756     char frame_type;
 757
 758     /* Quick bounds check */
 759     if( log == NULL )
 760         return XVID_ERR_FAIL;
 761
 762     /* Convert the type given to us into a character */
 763     if( param->type < 5 && param->type > 0 ) {
 764         frame_type = frame_types[param->type];
 765     } else {
 766         return XVID_ERR_FAIL;
 767     }
 768
 769     snprintf(BUFFER_CAT(log), BUFFER_REMAINING(log),
 770         "%c %d %d %d %d %d %d\n",
 771         frame_type, param->stats.quant, param->stats.kblks, param->stats.mblks,
 772         param->stats.ublks, param->stats.length, param->stats.hlength);
 773
 774     return 0;
 775 }
 776
 777 /**
 778  * Dispatch function for our custom plugin.
 779  * This handles the dispatch for the Xvid plugin. It passes data
 780  * on to other functions for actual processing.
 781  *
 782  * @param ref Context pointer for the plugin
 783  * @param cmd The task given for us to complete
 784  * @param p1 First parameter (varies)
 785  * @param p2 Second parameter (varies)
 786  * @return Returns XVID_ERR_xxxx on failure, or 0 on success
 787  */
 788 int xvid_ff_2pass(void *ref, int cmd, void *p1, void *p2) {
 789     switch( cmd ) {
 790         case XVID_PLG_INFO:
 791         case XVID_PLG_FRAME:
 792             return 0;
 793
 794         case XVID_PLG_BEFORE:
 795             return xvid_ff_2pass_before(ref, p1);
 796
 797         case XVID_PLG_CREATE:
 798             return xvid_ff_2pass_create(p1, p2);
 799
 800         case XVID_PLG_AFTER:
 801             return xvid_ff_2pass_after(ref, p1);
 802
 803         case XVID_PLG_DESTROY:
 804             return xvid_ff_2pass_destroy(ref, p1);
 805
 806         default:
 807             return XVID_ERR_FAIL;
 808     }
 809 }
 810
 811 /**
 812  * Xvid codec definition for libavcodec.
 813  */
 814 AVCodec libxvid_encoder = {
 815     "libxvid",
 816     AVMEDIA_TYPE_VIDEO,
 817     CODEC_ID_MPEG4,
 818     sizeof(struct xvid_context),
 819     xvid_encode_init,
 820     xvid_encode_frame,
 821     xvid_encode_close,
 822     .pix_fmts= (const enum PixelFormat[]){PIX_FMT_YUV420P, PIX_FMT_NONE},
 823     .long_name= NULL_IF_CONFIG_SMALL("libxvidcore MPEG-4 part 2"),
 824 };
 825
 826 #endif /* CONFIG_LIBXVID_ENCODER */