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