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