git.sesse.net Git - x264/blob - encoder/ratecontrol.c

   1 /*****************************************************************************
   2  * ratecontrol.c: ratecontrol
   3  *****************************************************************************
   4  * Copyright (C) 2005-2012 x264 project
   5  *
   6  * Authors: Loren Merritt <lorenm@u.washington.edu>
   7  *          Michael Niedermayer <michaelni@gmx.at>
   8  *          Gabriel Bouvigne <gabriel.bouvigne@joost.com>
   9  *          Fiona Glaser <fiona@x264.com>
  10  *          Måns Rullgård <mru@mru.ath.cx>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
  25  *
  26  * This program is also available under a commercial proprietary license.
  27  * For more information, contact us at licensing@x264.com.
  28  *****************************************************************************/
  29
  30 #define _ISOC99_SOURCE
  31 #undef NDEBUG // always check asserts, the speed effect is far too small to disable them
  32
  33 #include "common/common.h"
  34 #include "ratecontrol.h"
  35 #include "me.h"
  36
  37 typedef struct
  38 {
  39     int pict_type;
  40     int frame_type;
  41     int kept_as_ref;
  42     double qscale;
  43     int mv_bits;
  44     int tex_bits;
  45     int misc_bits;
  46     uint64_t expected_bits; /*total expected bits up to the current frame (current one excluded)*/
  47     double expected_vbv;
  48     double new_qscale;
  49     int new_qp;
  50     int i_count;
  51     int p_count;
  52     int s_count;
  53     float blurred_complexity;
  54     char direct_mode;
  55     int16_t weight[3][2];
  56     int16_t i_weight_denom[2];
  57     int refcount[16];
  58     int refs;
  59     int64_t i_duration;
  60     int64_t i_cpb_duration;
  61 } ratecontrol_entry_t;
  62
  63 typedef struct
  64 {
  65     float coeff_min;
  66     float coeff;
  67     float count;
  68     float decay;
  69     float offset;
  70 } predictor_t;
  71
  72 struct x264_ratecontrol_t
  73 {
  74     /* constants */
  75     int b_abr;
  76     int b_2pass;
  77     int b_vbv;
  78     int b_vbv_min_rate;
  79     double fps;
  80     double bitrate;
  81     double rate_tolerance;
  82     double qcompress;
  83     int nmb;                    /* number of macroblocks in a frame */
  84     int qp_constant[3];
  85
  86     /* current frame */
  87     ratecontrol_entry_t *rce;
  88     int qp;                     /* qp for current frame */
  89     float qpm;                  /* qp for current macroblock: precise float for AQ */
  90     float qpa_rc;               /* average of macroblocks' qp before aq */
  91     float qpa_rc_prev;
  92     int   qpa_aq;               /* average of macroblocks' qp after aq */
  93     int   qpa_aq_prev;
  94     float qp_novbv;             /* QP for the current frame if 1-pass VBV was disabled. */
  95
  96     /* VBV stuff */
  97     double buffer_size;
  98     int64_t buffer_fill_final;
  99     double buffer_fill;         /* planned buffer, if all in-progress frames hit their bit budget */
 100     double buffer_rate;         /* # of bits added to buffer_fill after each frame */
 101     double vbv_max_rate;        /* # of bits added to buffer_fill per second */
 102     predictor_t *pred;          /* predict frame size from satd */
 103     int single_frame_vbv;
 104     double rate_factor_max_increment; /* Don't allow RF above (CRF + this value). */
 105
 106     /* ABR stuff */
 107     int    last_satd;
 108     double last_rceq;
 109     double cplxr_sum;           /* sum of bits*qscale/rceq */
 110     double expected_bits_sum;   /* sum of qscale2bits after rceq, ratefactor, and overflow, only includes finished frames */
 111     int64_t filler_bits_sum;    /* sum in bits of finished frames' filler data */
 112     double wanted_bits_window;  /* target bitrate * window */
 113     double cbr_decay;
 114     double short_term_cplxsum;
 115     double short_term_cplxcount;
 116     double rate_factor_constant;
 117     double ip_offset;
 118     double pb_offset;
 119
 120     /* 2pass stuff */
 121     FILE *p_stat_file_out;
 122     char *psz_stat_file_tmpname;
 123     FILE *p_mbtree_stat_file_out;
 124     char *psz_mbtree_stat_file_tmpname;
 125     char *psz_mbtree_stat_file_name;
 126     FILE *p_mbtree_stat_file_in;
 127
 128     int num_entries;            /* number of ratecontrol_entry_ts */
 129     ratecontrol_entry_t *entry; /* FIXME: copy needed data and free this once init is done */
 130     double last_qscale;
 131     double last_qscale_for[3];  /* last qscale for a specific pict type, used for max_diff & ipb factor stuff */
 132     int last_non_b_pict_type;
 133     double accum_p_qp;          /* for determining I-frame quant */
 134     double accum_p_norm;
 135     double last_accum_p_norm;
 136     double lmin[3];             /* min qscale by frame type */
 137     double lmax[3];
 138     double lstep;               /* max change (multiply) in qscale per frame */
 139     uint16_t *qp_buffer[2];     /* Global buffers for converting MB-tree quantizer data. */
 140     int qpbuf_pos;              /* In order to handle pyramid reordering, QP buffer acts as a stack.
 141                                  * This value is the current position (0 or 1). */
 142
 143     /* MBRC stuff */
 144     float frame_size_estimated; /* Access to this variable must be atomic: double is
 145                                  * not atomic on all arches we care about */
 146     double frame_size_maximum;  /* Maximum frame size due to MinCR */
 147     double frame_size_planned;
 148     double slice_size_planned;
 149     predictor_t (*row_pred)[2];
 150     predictor_t row_preds[3][2];
 151     predictor_t *pred_b_from_p; /* predict B-frame size from P-frame satd */
 152     int bframes;                /* # consecutive B-frames before this P-frame */
 153     int bframe_bits;            /* total cost of those frames */
 154
 155     int i_zones;
 156     x264_zone_t *zones;
 157     x264_zone_t *prev_zone;
 158
 159     /* hrd stuff */
 160     int initial_cpb_removal_delay;
 161     int initial_cpb_removal_delay_offset;
 162     double nrt_first_access_unit; /* nominal removal time */
 163     double previous_cpb_final_arrival_time;
 164     uint64_t hrd_multiply_denom;
 165 };
 166
 167
 168 static int parse_zones( x264_t *h );
 169 static int init_pass2(x264_t *);
 170 static float rate_estimate_qscale( x264_t *h );
 171 static int update_vbv( x264_t *h, int bits );
 172 static void update_vbv_plan( x264_t *h, int overhead );
 173 static float predict_size( predictor_t *p, float q, float var );
 174 static void update_predictor( predictor_t *p, float q, float var, float bits );
 175
 176 #define CMP_OPT_FIRST_PASS( opt, param_val )\
 177 {\
 178     if( ( p = strstr( opts, opt "=" ) ) && sscanf( p, opt "=%d" , &i ) && param_val != i )\
 179     {\
 180         x264_log( h, X264_LOG_ERROR, "different " opt " setting than first pass (%d vs %d)\n", param_val, i );\
 181         return -1;\
 182     }\
 183 }
 184
 185 /* Terminology:
 186  * qp = h.264's quantizer
 187  * qscale = linearized quantizer = Lagrange multiplier
 188  */
 189 static inline float qp2qscale( float qp )
 190 {
 191     return 0.85f * powf( 2.0f, ( qp - 12.0f ) / 6.0f );
 192 }
 193 static inline float qscale2qp( float qscale )
 194 {
 195     return 12.0f + 6.0f * log2f( qscale/0.85f );
 196 }
 197
 198 /* Texture bitrate is not quite inversely proportional to qscale,
 199  * probably due the the changing number of SKIP blocks.
 200  * MV bits level off at about qp<=12, because the lambda used
 201  * for motion estimation is constant there. */
 202 static inline double qscale2bits( ratecontrol_entry_t *rce, double qscale )
 203 {
 204     if( qscale<0.1 )
 205         qscale = 0.1;
 206     return (rce->tex_bits + .1) * pow( rce->qscale / qscale, 1.1 )
 207            + rce->mv_bits * pow( X264_MAX(rce->qscale, 1) / X264_MAX(qscale, 1), 0.5 )
 208            + rce->misc_bits;
 209 }
 210
 211 static ALWAYS_INLINE uint32_t ac_energy_var( uint64_t sum_ssd, int shift, x264_frame_t *frame, int i, int b_store )
 212 {
 213     uint32_t sum = sum_ssd;
 214     uint32_t ssd = sum_ssd >> 32;
 215     if( b_store )
 216     {
 217         frame->i_pixel_sum[i] += sum;
 218         frame->i_pixel_ssd[i] += ssd;
 219     }
 220     return ssd - ((uint64_t)sum * sum >> shift);
 221 }
 222
 223 static ALWAYS_INLINE uint32_t ac_energy_plane( x264_t *h, int mb_x, int mb_y, x264_frame_t *frame, int i, int b_chroma, int b_field, int b_store )
 224 {
 225     int height = b_chroma ? 16>>CHROMA_V_SHIFT : 16;
 226     int stride = frame->i_stride[i];
 227     int offset = b_field
 228         ? 16 * mb_x + height * (mb_y&~1) * stride + (mb_y&1) * stride
 229         : 16 * mb_x + height * mb_y * stride;
 230     stride <<= b_field;
 231     if( b_chroma )
 232     {
 233         ALIGNED_ARRAY_16( pixel, pix,[FENC_STRIDE*16] );
 234         int chromapix = h->luma2chroma_pixel[PIXEL_16x16];
 235         int shift = 7 - CHROMA_V_SHIFT;
 236
 237         h->mc.load_deinterleave_chroma_fenc( pix, frame->plane[1] + offset, stride, height );
 238         return ac_energy_var( h->pixf.var[chromapix]( pix,               FENC_STRIDE ), shift, frame, 1, b_store )
 239              + ac_energy_var( h->pixf.var[chromapix]( pix+FENC_STRIDE/2, FENC_STRIDE ), shift, frame, 2, b_store );
 240     }
 241     else
 242         return ac_energy_var( h->pixf.var[PIXEL_16x16]( frame->plane[i] + offset, stride ), 8, frame, i, b_store );
 243 }
 244
 245 // Find the total AC energy of the block in all planes.
 246 static NOINLINE uint32_t x264_ac_energy_mb( x264_t *h, int mb_x, int mb_y, x264_frame_t *frame )
 247 {
 248     /* This function contains annoying hacks because GCC has a habit of reordering emms
 249      * and putting it after floating point ops.  As a result, we put the emms at the end of the
 250      * function and make sure that its always called before the float math.  Noinline makes
 251      * sure no reordering goes on. */
 252     uint32_t var;
 253     x264_prefetch_fenc( h, frame, mb_x, mb_y );
 254     if( h->mb.b_adaptive_mbaff )
 255     {
 256         /* We don't know the super-MB mode we're going to pick yet, so
 257          * simply try both and pick the lower of the two. */
 258         uint32_t var_interlaced, var_progressive;
 259         var_interlaced   = ac_energy_plane( h, mb_x, mb_y, frame, 0, 0, 1, 1 );
 260         var_progressive  = ac_energy_plane( h, mb_x, mb_y, frame, 0, 0, 0, 0 );
 261         if( CHROMA444 )
 262         {
 263             var_interlaced  += ac_energy_plane( h, mb_x, mb_y, frame, 1, 0, 1, 1 );
 264             var_progressive += ac_energy_plane( h, mb_x, mb_y, frame, 1, 0, 0, 0 );
 265             var_interlaced  += ac_energy_plane( h, mb_x, mb_y, frame, 2, 0, 1, 1 );
 266             var_progressive += ac_energy_plane( h, mb_x, mb_y, frame, 2, 0, 0, 0 );
 267         }
 268         else
 269         {
 270             var_interlaced  += ac_energy_plane( h, mb_x, mb_y, frame, 1, 1, 1, 1 );
 271             var_progressive += ac_energy_plane( h, mb_x, mb_y, frame, 1, 1, 0, 0 );
 272         }
 273         var = X264_MIN( var_interlaced, var_progressive );
 274     }
 275     else
 276     {
 277         var  = ac_energy_plane( h, mb_x, mb_y, frame, 0, 0, PARAM_INTERLACED, 1 );
 278         if( CHROMA444 )
 279         {
 280             var += ac_energy_plane( h, mb_x, mb_y, frame, 1, 0, PARAM_INTERLACED, 1 );
 281             var += ac_energy_plane( h, mb_x, mb_y, frame, 2, 0, PARAM_INTERLACED, 1 );
 282         }
 283         else
 284             var += ac_energy_plane( h, mb_x, mb_y, frame, 1, 1, PARAM_INTERLACED, 1 );
 285     }
 286     x264_emms();
 287     return var;
 288 }
 289
 290 void x264_adaptive_quant_frame( x264_t *h, x264_frame_t *frame, float *quant_offsets )
 291 {
 292     /* constants chosen to result in approximately the same overall bitrate as without AQ.
 293      * FIXME: while they're written in 5 significant digits, they're only tuned to 2. */
 294     float strength;
 295     float avg_adj = 0.f;
 296     /* Initialize frame stats */
 297     for( int i = 0; i < 3; i++ )
 298     {
 299         frame->i_pixel_sum[i] = 0;
 300         frame->i_pixel_ssd[i] = 0;
 301     }
 302
 303     /* Degenerate cases */
 304     if( h->param.rc.i_aq_mode == X264_AQ_NONE || h->param.rc.f_aq_strength == 0 )
 305     {
 306         /* Need to init it anyways for MB tree */
 307         if( h->param.rc.i_aq_mode && h->param.rc.f_aq_strength == 0 )
 308         {
 309             if( quant_offsets )
 310             {
 311                 for( int mb_xy = 0; mb_xy < h->mb.i_mb_count; mb_xy++ )
 312                     frame->f_qp_offset[mb_xy] = frame->f_qp_offset_aq[mb_xy] = quant_offsets[mb_xy];
 313                 if( h->frames.b_have_lowres )
 314                     for( int mb_xy = 0; mb_xy < h->mb.i_mb_count; mb_xy++ )
 315                         frame->i_inv_qscale_factor[mb_xy] = x264_exp2fix8( frame->f_qp_offset[mb_xy] );
 316             }
 317             else
 318             {
 319                 memset( frame->f_qp_offset, 0, h->mb.i_mb_count * sizeof(float) );
 320                 memset( frame->f_qp_offset_aq, 0, h->mb.i_mb_count * sizeof(float) );
 321                 if( h->frames.b_have_lowres )
 322                     for( int mb_xy = 0; mb_xy < h->mb.i_mb_count; mb_xy++ )
 323                         frame->i_inv_qscale_factor[mb_xy] = 256;
 324             }
 325         }
 326         /* Need variance data for weighted prediction */
 327         if( h->param.analyse.i_weighted_pred )
 328         {
 329             for( int mb_y = 0; mb_y < h->mb.i_mb_height; mb_y++ )
 330                 for( int mb_x = 0; mb_x < h->mb.i_mb_width; mb_x++ )
 331                     x264_ac_energy_mb( h, mb_x, mb_y, frame );
 332         }
 333         else
 334             return;
 335     }
 336     /* Actual adaptive quantization */
 337     else
 338     {
 339         if( h->param.rc.i_aq_mode == X264_AQ_AUTOVARIANCE )
 340         {
 341             float bit_depth_correction = powf(1 << (BIT_DEPTH-8), 0.5f);
 342             float avg_adj_pow2 = 0.f;
 343             for( int mb_y = 0; mb_y < h->mb.i_mb_height; mb_y++ )
 344                 for( int mb_x = 0; mb_x < h->mb.i_mb_width; mb_x++ )
 345                 {
 346                     uint32_t energy = x264_ac_energy_mb( h, mb_x, mb_y, frame );
 347                     float qp_adj = powf( energy + 1, 0.125f );
 348                     frame->f_qp_offset[mb_x + mb_y*h->mb.i_mb_stride] = qp_adj;
 349                     avg_adj += qp_adj;
 350                     avg_adj_pow2 += qp_adj * qp_adj;
 351                 }
 352             avg_adj /= h->mb.i_mb_count;
 353             avg_adj_pow2 /= h->mb.i_mb_count;
 354             strength = h->param.rc.f_aq_strength * avg_adj / bit_depth_correction;
 355             avg_adj = avg_adj - 0.5f * (avg_adj_pow2 - (14.f * bit_depth_correction)) / avg_adj;
 356         }
 357         else
 358             strength = h->param.rc.f_aq_strength * 1.0397f;
 359
 360         for( int mb_y = 0; mb_y < h->mb.i_mb_height; mb_y++ )
 361             for( int mb_x = 0; mb_x < h->mb.i_mb_width; mb_x++ )
 362             {
 363                 float qp_adj;
 364                 int mb_xy = mb_x + mb_y*h->mb.i_mb_stride;
 365                 if( h->param.rc.i_aq_mode == X264_AQ_AUTOVARIANCE )
 366                 {
 367                     qp_adj = frame->f_qp_offset[mb_xy];
 368                     qp_adj = strength * (qp_adj - avg_adj);
 369                 }
 370                 else
 371                 {
 372                     uint32_t energy = x264_ac_energy_mb( h, mb_x, mb_y, frame );
 373                     qp_adj = strength * (x264_log2( X264_MAX(energy, 1) ) - (14.427f + 2*(BIT_DEPTH-8)));
 374                 }
 375                 if( quant_offsets )
 376                     qp_adj += quant_offsets[mb_xy];
 377                 frame->f_qp_offset[mb_xy] =
 378                 frame->f_qp_offset_aq[mb_xy] = qp_adj;
 379                 if( h->frames.b_have_lowres )
 380                     frame->i_inv_qscale_factor[mb_xy] = x264_exp2fix8(qp_adj);
 381             }
 382     }
 383
 384     /* Remove mean from SSD calculation */
 385     for( int i = 0; i < 3; i++ )
 386     {
 387         uint64_t ssd = frame->i_pixel_ssd[i];
 388         uint64_t sum = frame->i_pixel_sum[i];
 389         int width  = 16*h->mb.i_mb_width  >> (i && CHROMA_H_SHIFT);
 390         int height = 16*h->mb.i_mb_height >> (i && CHROMA_V_SHIFT);
 391         frame->i_pixel_ssd[i] = ssd - (sum * sum + width * height / 2) / (width * height);
 392     }
 393 }
 394
 395 int x264_macroblock_tree_read( x264_t *h, x264_frame_t *frame, float *quant_offsets )
 396 {
 397     x264_ratecontrol_t *rc = h->rc;
 398     uint8_t i_type_actual = rc->entry[frame->i_frame].pict_type;
 399
 400     if( rc->entry[frame->i_frame].kept_as_ref )
 401     {
 402         uint8_t i_type;
 403         if( rc->qpbuf_pos < 0 )
 404         {
 405             do
 406             {
 407                 rc->qpbuf_pos++;
 408
 409                 if( !fread( &i_type, 1, 1, rc->p_mbtree_stat_file_in ) )
 410                     goto fail;
 411                 if( fread( rc->qp_buffer[rc->qpbuf_pos], sizeof(uint16_t), h->mb.i_mb_count, rc->p_mbtree_stat_file_in ) != h->mb.i_mb_count )
 412                     goto fail;
 413
 414                 if( i_type != i_type_actual && rc->qpbuf_pos == 1 )
 415                 {
 416                     x264_log( h, X264_LOG_ERROR, "MB-tree frametype %d doesn't match actual frametype %d.\n", i_type, i_type_actual );
 417                     return -1;
 418                 }
 419             } while( i_type != i_type_actual );
 420         }
 421
 422         for( int i = 0; i < h->mb.i_mb_count; i++ )
 423         {
 424             frame->f_qp_offset[i] = ((float)(int16_t)endian_fix16( rc->qp_buffer[rc->qpbuf_pos][i] )) * (1/256.0);
 425             if( h->frames.b_have_lowres )
 426                 frame->i_inv_qscale_factor[i] = x264_exp2fix8(frame->f_qp_offset[i]);
 427         }
 428         rc->qpbuf_pos--;
 429     }
 430     else
 431         x264_stack_align( x264_adaptive_quant_frame, h, frame, quant_offsets );
 432     return 0;
 433 fail:
 434     x264_log( h, X264_LOG_ERROR, "Incomplete MB-tree stats file.\n" );
 435     return -1;
 436 }
 437
 438 int x264_reference_build_list_optimal( x264_t *h )
 439 {
 440     ratecontrol_entry_t *rce = h->rc->rce;
 441     x264_frame_t *frames[16];
 442     x264_weight_t weights[16][3];
 443     int refcount[16];
 444
 445     if( rce->refs != h->i_ref[0] )
 446         return -1;
 447
 448     memcpy( frames, h->fref[0], sizeof(frames) );
 449     memcpy( refcount, rce->refcount, sizeof(refcount) );
 450     memcpy( weights, h->fenc->weight, sizeof(weights) );
 451     memset( &h->fenc->weight[1][0], 0, sizeof(x264_weight_t[15][3]) );
 452
 453     /* For now don't reorder ref 0; it seems to lower quality
 454        in most cases due to skips. */
 455     for( int ref = 1; ref < h->i_ref[0]; ref++ )
 456     {
 457         int max = -1;
 458         int bestref = 1;
 459
 460         for( int i = 1; i < h->i_ref[0]; i++ )
 461             /* Favor lower POC as a tiebreaker. */
 462             COPY2_IF_GT( max, refcount[i], bestref, i );
 463
 464         /* FIXME: If there are duplicates from frames other than ref0 then it is possible
 465          * that the optimal ordering doesnt place every duplicate. */
 466
 467         refcount[bestref] = -1;
 468         h->fref[0][ref] = frames[bestref];
 469         memcpy( h->fenc->weight[ref], weights[bestref], sizeof(weights[bestref]) );
 470     }
 471
 472     return 0;
 473 }
 474
 475 static char *x264_strcat_filename( char *input, char *suffix )
 476 {
 477     char *output = x264_malloc( strlen( input ) + strlen( suffix ) + 1 );
 478     if( !output )
 479         return NULL;
 480     strcpy( output, input );
 481     strcat( output, suffix );
 482     return output;
 483 }
 484
 485 void x264_ratecontrol_init_reconfigurable( x264_t *h, int b_init )
 486 {
 487     x264_ratecontrol_t *rc = h->rc;
 488     if( !b_init && rc->b_2pass )
 489         return;
 490
 491     if( h->param.rc.i_rc_method == X264_RC_CRF )
 492     {
 493         /* Arbitrary rescaling to make CRF somewhat similar to QP.
 494          * Try to compensate for MB-tree's effects as well. */
 495         double base_cplx = h->mb.i_mb_count * (h->param.i_bframe ? 120 : 80);
 496         double mbtree_offset = h->param.rc.b_mb_tree ? (1.0-h->param.rc.f_qcompress)*13.5 : 0;
 497         rc->rate_factor_constant = pow( base_cplx, 1 - rc->qcompress )
 498                                  / qp2qscale( h->param.rc.f_rf_constant + mbtree_offset + QP_BD_OFFSET );
 499     }
 500
 501     if( h->param.rc.i_vbv_max_bitrate > 0 && h->param.rc.i_vbv_buffer_size > 0 )
 502     {
 503         /* We don't support changing the ABR bitrate right now,
 504            so if the stream starts as CBR, keep it CBR. */
 505         if( rc->b_vbv_min_rate )
 506             h->param.rc.i_vbv_max_bitrate = h->param.rc.i_bitrate;
 507
 508         if( h->param.rc.i_vbv_buffer_size < (int)(h->param.rc.i_vbv_max_bitrate / rc->fps) )
 509         {
 510             h->param.rc.i_vbv_buffer_size = h->param.rc.i_vbv_max_bitrate / rc->fps;
 511             x264_log( h, X264_LOG_WARNING, "VBV buffer size cannot be smaller than one frame, using %d kbit\n",
 512                       h->param.rc.i_vbv_buffer_size );
 513         }
 514
 515         int vbv_buffer_size = h->param.rc.i_vbv_buffer_size * 1000;
 516         int vbv_max_bitrate = h->param.rc.i_vbv_max_bitrate * 1000;
 517
 518         /* Init HRD */
 519         if( h->param.i_nal_hrd && b_init )
 520         {
 521             h->sps->vui.hrd.i_cpb_cnt = 1;
 522             h->sps->vui.hrd.b_cbr_hrd = h->param.i_nal_hrd == X264_NAL_HRD_CBR;
 523             h->sps->vui.hrd.i_time_offset_length = 0;
 524
 525             #define BR_SHIFT  6
 526             #define CPB_SHIFT 4
 527
 528             int bitrate = 1000*h->param.rc.i_vbv_max_bitrate;
 529             int bufsize = 1000*h->param.rc.i_vbv_buffer_size;
 530
 531             // normalize HRD size and rate to the value / scale notation
 532             h->sps->vui.hrd.i_bit_rate_scale = x264_clip3( x264_ctz( bitrate ) - BR_SHIFT, 0, 15 );
 533             h->sps->vui.hrd.i_bit_rate_value = bitrate >> ( h->sps->vui.hrd.i_bit_rate_scale + BR_SHIFT );
 534             h->sps->vui.hrd.i_bit_rate_unscaled = h->sps->vui.hrd.i_bit_rate_value << ( h->sps->vui.hrd.i_bit_rate_scale + BR_SHIFT );
 535             h->sps->vui.hrd.i_cpb_size_scale = x264_clip3( x264_ctz( bufsize ) - CPB_SHIFT, 0, 15 );
 536             h->sps->vui.hrd.i_cpb_size_value = bufsize >> ( h->sps->vui.hrd.i_cpb_size_scale + CPB_SHIFT );
 537             h->sps->vui.hrd.i_cpb_size_unscaled = h->sps->vui.hrd.i_cpb_size_value << ( h->sps->vui.hrd.i_cpb_size_scale + CPB_SHIFT );
 538
 539             #undef CPB_SHIFT
 540             #undef BR_SHIFT
 541
 542             // arbitrary
 543             #define MAX_DURATION 0.5
 544
 545             int max_cpb_output_delay = X264_MIN( h->param.i_keyint_max * MAX_DURATION * h->sps->vui.i_time_scale / h->sps->vui.i_num_units_in_tick, INT_MAX );
 546             int max_dpb_output_delay = h->sps->vui.i_max_dec_frame_buffering * MAX_DURATION * h->sps->vui.i_time_scale / h->sps->vui.i_num_units_in_tick;
 547             int max_delay = (int)(90000.0 * (double)h->sps->vui.hrd.i_cpb_size_unscaled / h->sps->vui.hrd.i_bit_rate_unscaled + 0.5);
 548
 549             h->sps->vui.hrd.i_initial_cpb_removal_delay_length = 2 + x264_clip3( 32 - x264_clz( max_delay ), 4, 22 );
 550             h->sps->vui.hrd.i_cpb_removal_delay_length = x264_clip3( 32 - x264_clz( max_cpb_output_delay ), 4, 31 );
 551             h->sps->vui.hrd.i_dpb_output_delay_length  = x264_clip3( 32 - x264_clz( max_dpb_output_delay ), 4, 31 );
 552
 553             #undef MAX_DURATION
 554
 555             vbv_buffer_size = h->sps->vui.hrd.i_cpb_size_unscaled;
 556             vbv_max_bitrate = h->sps->vui.hrd.i_bit_rate_unscaled;
 557         }
 558         else if( h->param.i_nal_hrd && !b_init )
 559         {
 560             x264_log( h, X264_LOG_WARNING, "VBV parameters cannot be changed when NAL HRD is in use\n" );
 561             return;
 562         }
 563         h->sps->vui.hrd.i_bit_rate_unscaled = vbv_max_bitrate;
 564         h->sps->vui.hrd.i_cpb_size_unscaled = vbv_buffer_size;
 565
 566         if( rc->b_vbv_min_rate )
 567             rc->bitrate = h->param.rc.i_bitrate * 1000.;
 568         rc->buffer_rate = vbv_max_bitrate / rc->fps;
 569         rc->vbv_max_rate = vbv_max_bitrate;
 570         rc->buffer_size = vbv_buffer_size;
 571         rc->single_frame_vbv = rc->buffer_rate * 1.1 > rc->buffer_size;
 572         rc->cbr_decay = 1.0 - rc->buffer_rate / rc->buffer_size
 573                       * 0.5 * X264_MAX(0, 1.5 - rc->buffer_rate * rc->fps / rc->bitrate);
 574         if( h->param.rc.i_rc_method == X264_RC_CRF && h->param.rc.f_rf_constant_max )
 575         {
 576             rc->rate_factor_max_increment = h->param.rc.f_rf_constant_max - h->param.rc.f_rf_constant;
 577             if( rc->rate_factor_max_increment <= 0 )
 578             {
 579                 x264_log( h, X264_LOG_WARNING, "CRF max must be greater than CRF\n" );
 580                 rc->rate_factor_max_increment = 0;
 581             }
 582         }
 583         if( b_init )
 584         {
 585             if( h->param.rc.f_vbv_buffer_init > 1. )
 586                 h->param.rc.f_vbv_buffer_init = x264_clip3f( h->param.rc.f_vbv_buffer_init / h->param.rc.i_vbv_buffer_size, 0, 1 );
 587             h->param.rc.f_vbv_buffer_init = x264_clip3f( X264_MAX( h->param.rc.f_vbv_buffer_init, rc->buffer_rate / rc->buffer_size ), 0, 1);
 588             rc->buffer_fill_final = rc->buffer_size * h->param.rc.f_vbv_buffer_init * h->sps->vui.i_time_scale;
 589             rc->b_vbv = 1;
 590             rc->b_vbv_min_rate = !rc->b_2pass
 591                           && h->param.rc.i_rc_method == X264_RC_ABR
 592                           && h->param.rc.i_vbv_max_bitrate <= h->param.rc.i_bitrate;
 593         }
 594     }
 595 }
 596
 597 int x264_ratecontrol_new( x264_t *h )
 598 {
 599     x264_ratecontrol_t *rc;
 600
 601     x264_emms();
 602
 603     CHECKED_MALLOCZERO( h->rc, h->param.i_threads * sizeof(x264_ratecontrol_t) );
 604     rc = h->rc;
 605
 606     rc->b_abr = h->param.rc.i_rc_method != X264_RC_CQP && !h->param.rc.b_stat_read;
 607     rc->b_2pass = h->param.rc.i_rc_method == X264_RC_ABR && h->param.rc.b_stat_read;
 608
 609     /* FIXME: use integers */
 610     if( h->param.i_fps_num > 0 && h->param.i_fps_den > 0 )
 611         rc->fps = (float) h->param.i_fps_num / h->param.i_fps_den;
 612     else
 613         rc->fps = 25.0;
 614
 615     if( h->param.rc.b_mb_tree )
 616     {
 617         h->param.rc.f_pb_factor = 1;
 618         rc->qcompress = 1;
 619     }
 620     else
 621         rc->qcompress = h->param.rc.f_qcompress;
 622
 623     rc->bitrate = h->param.rc.i_bitrate * 1000.;
 624     rc->rate_tolerance = h->param.rc.f_rate_tolerance;
 625     rc->nmb = h->mb.i_mb_count;
 626     rc->last_non_b_pict_type = -1;
 627     rc->cbr_decay = 1.0;
 628
 629     if( h->param.rc.i_rc_method == X264_RC_CRF && h->param.rc.b_stat_read )
 630     {
 631         x264_log( h, X264_LOG_ERROR, "constant rate-factor is incompatible with 2pass.\n" );
 632         return -1;
 633     }
 634
 635     x264_ratecontrol_init_reconfigurable( h, 1 );
 636
 637     if( h->param.i_nal_hrd )
 638     {
 639         uint64_t denom = (uint64_t)h->sps->vui.hrd.i_bit_rate_unscaled * h->sps->vui.i_time_scale;
 640         uint64_t num = 180000;
 641         x264_reduce_fraction64( &num, &denom );
 642         rc->hrd_multiply_denom = 180000 / num;
 643
 644         double bits_required = log2( 180000 / rc->hrd_multiply_denom )
 645                              + log2( h->sps->vui.i_time_scale )
 646                              + log2( h->sps->vui.hrd.i_cpb_size_unscaled );
 647         if( bits_required >= 63 )
 648         {
 649             x264_log( h, X264_LOG_ERROR, "HRD with very large timescale and bufsize not supported\n" );
 650             return -1;
 651         }
 652     }
 653
 654     if( rc->rate_tolerance < 0.01 )
 655     {
 656         x264_log( h, X264_LOG_WARNING, "bitrate tolerance too small, using .01\n" );
 657         rc->rate_tolerance = 0.01;
 658     }
 659
 660     h->mb.b_variable_qp = rc->b_vbv || h->param.rc.i_aq_mode;
 661
 662     if( rc->b_abr )
 663     {
 664         /* FIXME ABR_INIT_QP is actually used only in CRF */
 665 #define ABR_INIT_QP (( h->param.rc.i_rc_method == X264_RC_CRF ? h->param.rc.f_rf_constant : 24 ) + QP_BD_OFFSET)
 666         rc->accum_p_norm = .01;
 667         rc->accum_p_qp = ABR_INIT_QP * rc->accum_p_norm;
 668         /* estimated ratio that produces a reasonable QP for the first I-frame */
 669         rc->cplxr_sum = .01 * pow( 7.0e5, rc->qcompress ) * pow( h->mb.i_mb_count, 0.5 );
 670         rc->wanted_bits_window = 1.0 * rc->bitrate / rc->fps;
 671         rc->last_non_b_pict_type = SLICE_TYPE_I;
 672     }
 673
 674     rc->ip_offset = 6.0 * log2f( h->param.rc.f_ip_factor );
 675     rc->pb_offset = 6.0 * log2f( h->param.rc.f_pb_factor );
 676     rc->qp_constant[SLICE_TYPE_P] = h->param.rc.i_qp_constant;
 677     rc->qp_constant[SLICE_TYPE_I] = x264_clip3( h->param.rc.i_qp_constant - rc->ip_offset + 0.5, 0, QP_MAX );
 678     rc->qp_constant[SLICE_TYPE_B] = x264_clip3( h->param.rc.i_qp_constant + rc->pb_offset + 0.5, 0, QP_MAX );
 679     h->mb.ip_offset = rc->ip_offset + 0.5;
 680
 681     rc->lstep = pow( 2, h->param.rc.i_qp_step / 6.0 );
 682     rc->last_qscale = qp2qscale( 26 );
 683     int num_preds = h->param.b_sliced_threads * h->param.i_threads + 1;
 684     CHECKED_MALLOC( rc->pred, 5 * sizeof(predictor_t) * num_preds );
 685     CHECKED_MALLOC( rc->pred_b_from_p, sizeof(predictor_t) );
 686     for( int i = 0; i < 3; i++ )
 687     {
 688         rc->last_qscale_for[i] = qp2qscale( ABR_INIT_QP );
 689         rc->lmin[i] = qp2qscale( h->param.rc.i_qp_min );
 690         rc->lmax[i] = qp2qscale( h->param.rc.i_qp_max );
 691         for( int j = 0; j < num_preds; j++ )
 692         {
 693             rc->pred[i+j*5].coeff_min = 2.0 / 4;
 694             rc->pred[i+j*5].coeff = 2.0;
 695             rc->pred[i+j*5].count = 1.0;
 696             rc->pred[i+j*5].decay = 0.5;
 697             rc->pred[i+j*5].offset = 0.0;
 698         }
 699         for( int j = 0; j < 2; j++ )
 700         {
 701             rc->row_preds[i][j].coeff_min = .25 / 4;
 702             rc->row_preds[i][j].coeff = .25;
 703             rc->row_preds[i][j].count = 1.0;
 704             rc->row_preds[i][j].decay = 0.5;
 705             rc->row_preds[i][j].offset = 0.0;
 706         }
 707     }
 708     *rc->pred_b_from_p = rc->pred[0];
 709
 710     if( parse_zones( h ) < 0 )
 711     {
 712         x264_log( h, X264_LOG_ERROR, "failed to parse zones\n" );
 713         return -1;
 714     }
 715
 716     /* Load stat file and init 2pass algo */
 717     if( h->param.rc.b_stat_read )
 718     {
 719         char *p, *stats_in, *stats_buf;
 720
 721         /* read 1st pass stats */
 722         assert( h->param.rc.psz_stat_in );
 723         stats_buf = stats_in = x264_slurp_file( h->param.rc.psz_stat_in );
 724         if( !stats_buf )
 725         {
 726             x264_log( h, X264_LOG_ERROR, "ratecontrol_init: can't open stats file\n" );
 727             return -1;
 728         }
 729         if( h->param.rc.b_mb_tree )
 730         {
 731             char *mbtree_stats_in = x264_strcat_filename( h->param.rc.psz_stat_in, ".mbtree" );
 732             if( !mbtree_stats_in )
 733                 return -1;
 734             rc->p_mbtree_stat_file_in = fopen( mbtree_stats_in, "rb" );
 735             x264_free( mbtree_stats_in );
 736             if( !rc->p_mbtree_stat_file_in )
 737             {
 738                 x264_log( h, X264_LOG_ERROR, "ratecontrol_init: can't open mbtree stats file\n" );
 739                 return -1;
 740             }
 741         }
 742
 743         /* check whether 1st pass options were compatible with current options */
 744         if( strncmp( stats_buf, "#options:", 9 ) )
 745         {
 746             x264_log( h, X264_LOG_ERROR, "options list in stats file not valid\n" );
 747             return -1;
 748         }
 749
 750         float res_factor, res_factor_bits;
 751         {
 752             int i, j;
 753             uint32_t k, l;
 754             char *opts = stats_buf;
 755             stats_in = strchr( stats_buf, '\n' );
 756             if( !stats_in )
 757                 return -1;
 758             *stats_in = '\0';
 759             stats_in++;
 760             if( sscanf( opts, "#options: %dx%d", &i, &j ) != 2 )
 761             {
 762                 x264_log( h, X264_LOG_ERROR, "resolution specified in stats file not valid\n" );
 763                 return -1;
 764             }
 765             else if( h->param.rc.b_mb_tree && (i != h->param.i_width || j != h->param.i_height)  )
 766             {
 767                 x264_log( h, X264_LOG_ERROR, "MB-tree doesn't support different resolution than 1st pass (%dx%d vs %dx%d)\n",
 768                           h->param.i_width, h->param.i_height, i, j );
 769                 return -1;
 770             }
 771             res_factor = (float)h->param.i_width * h->param.i_height / (i*j);
 772             /* Change in bits relative to resolution isn't quite linear on typical sources,
 773              * so we'll at least try to roughly approximate this effect. */
 774             res_factor_bits = powf( res_factor, 0.7 );
 775
 776             if( ( p = strstr( opts, "timebase=" ) ) && sscanf( p, "timebase=%u/%u", &k, &l ) != 2 )
 777             {
 778                 x264_log( h, X264_LOG_ERROR, "timebase specified in stats file not valid\n" );
 779                 return -1;
 780             }
 781             if( k != h->param.i_timebase_num || l != h->param.i_timebase_den )
 782             {
 783                 x264_log( h, X264_LOG_ERROR, "timebase mismatch with 1st pass (%u/%u vs %u/%u)\n",
 784                           h->param.i_timebase_num, h->param.i_timebase_den, k, l );
 785                 return -1;
 786             }
 787
 788             CMP_OPT_FIRST_PASS( "bitdepth", BIT_DEPTH );
 789             CMP_OPT_FIRST_PASS( "weightp", X264_MAX( 0, h->param.analyse.i_weighted_pred ) );
 790             CMP_OPT_FIRST_PASS( "bframes", h->param.i_bframe );
 791             CMP_OPT_FIRST_PASS( "b_pyramid", h->param.i_bframe_pyramid );
 792             CMP_OPT_FIRST_PASS( "intra_refresh", h->param.b_intra_refresh );
 793             CMP_OPT_FIRST_PASS( "open_gop", h->param.b_open_gop );
 794             CMP_OPT_FIRST_PASS( "bluray_compat", h->param.b_bluray_compat );
 795
 796             if( (p = strstr( opts, "interlaced=" )) )
 797             {
 798                 char *current = h->param.b_interlaced ? h->param.b_tff ? "tff" : "bff" : h->param.b_fake_interlaced ? "fake" : "0";
 799                 char buf[5];
 800                 sscanf( p, "interlaced=%4s", buf );
 801                 if( strcmp( current, buf ) )
 802                 {
 803                     x264_log( h, X264_LOG_ERROR, "different interlaced setting than first pass (%s vs %s)\n", current, buf );
 804                     return -1;
 805                 }
 806             }
 807
 808             if( (p = strstr( opts, "keyint=" )) )
 809             {
 810                 p += 7;
 811                 char buf[13] = "infinite ";
 812                 if( h->param.i_keyint_max != X264_KEYINT_MAX_INFINITE )
 813                     sprintf( buf, "%d ", h->param.i_keyint_max );
 814                 if( strncmp( p, buf, strlen(buf) ) )
 815                 {
 816                     x264_log( h, X264_LOG_ERROR, "different keyint setting than first pass (%.*s vs %.*s)\n",
 817                               strlen(buf)-1, buf, strcspn(p, " "), p );
 818                     return -1;
 819                 }
 820             }
 821
 822             if( strstr( opts, "qp=0" ) && h->param.rc.i_rc_method == X264_RC_ABR )
 823                 x264_log( h, X264_LOG_WARNING, "1st pass was lossless, bitrate prediction will be inaccurate\n" );
 824
 825             if( !strstr( opts, "direct=3" ) && h->param.analyse.i_direct_mv_pred == X264_DIRECT_PRED_AUTO )
 826             {
 827                 x264_log( h, X264_LOG_WARNING, "direct=auto not used on the first pass\n" );
 828                 h->mb.b_direct_auto_write = 1;
 829             }
 830
 831             if( ( p = strstr( opts, "b_adapt=" ) ) && sscanf( p, "b_adapt=%d", &i ) && i >= X264_B_ADAPT_NONE && i <= X264_B_ADAPT_TRELLIS )
 832                 h->param.i_bframe_adaptive = i;
 833             else if( h->param.i_bframe )
 834             {
 835                 x264_log( h, X264_LOG_ERROR, "b_adapt method specified in stats file not valid\n" );
 836                 return -1;
 837             }
 838
 839             if( (h->param.rc.b_mb_tree || h->param.rc.i_vbv_buffer_size) && ( p = strstr( opts, "rc_lookahead=" ) ) && sscanf( p, "rc_lookahead=%d", &i ) )
 840                 h->param.rc.i_lookahead = i;
 841         }
 842
 843         /* find number of pics */
 844         p = stats_in;
 845         int num_entries;
 846         for( num_entries = -1; p; num_entries++ )
 847             p = strchr( p + 1, ';' );
 848         if( !num_entries )
 849         {
 850             x264_log( h, X264_LOG_ERROR, "empty stats file\n" );
 851             return -1;
 852         }
 853         rc->num_entries = num_entries;
 854
 855         if( h->param.i_frame_total < rc->num_entries && h->param.i_frame_total > 0 )
 856         {
 857             x264_log( h, X264_LOG_WARNING, "2nd pass has fewer frames than 1st pass (%d vs %d)\n",
 858                       h->param.i_frame_total, rc->num_entries );
 859         }
 860         if( h->param.i_frame_total > rc->num_entries )
 861         {
 862             x264_log( h, X264_LOG_ERROR, "2nd pass has more frames than 1st pass (%d vs %d)\n",
 863                       h->param.i_frame_total, rc->num_entries );
 864             return -1;
 865         }
 866
 867         CHECKED_MALLOCZERO( rc->entry, rc->num_entries * sizeof(ratecontrol_entry_t) );
 868
 869         /* init all to skipped p frames */
 870         for( int i = 0; i < rc->num_entries; i++ )
 871         {
 872             ratecontrol_entry_t *rce = &rc->entry[i];
 873             rce->pict_type = SLICE_TYPE_P;
 874             rce->qscale = rce->new_qscale = qp2qscale( 20 );
 875             rce->misc_bits = rc->nmb + 10;
 876             rce->new_qp = 0;
 877         }
 878
 879         /* read stats */
 880         p = stats_in;
 881         for( int i = 0; i < rc->num_entries; i++ )
 882         {
 883             ratecontrol_entry_t *rce;
 884             int frame_number;
 885             char pict_type;
 886             int e;
 887             char *next;
 888             float qp;
 889             int ref;
 890
 891             next= strchr(p, ';');
 892             if( next )
 893                 *next++ = 0; //sscanf is unbelievably slow on long strings
 894             e = sscanf( p, " in:%d ", &frame_number );
 895
 896             if( frame_number < 0 || frame_number >= rc->num_entries )
 897             {
 898                 x264_log( h, X264_LOG_ERROR, "bad frame number (%d) at stats line %d\n", frame_number, i );
 899                 return -1;
 900             }
 901             rce = &rc->entry[frame_number];
 902             rce->direct_mode = 0;
 903
 904             e += sscanf( p, " in:%*d out:%*d type:%c dur:%"SCNd64" cpbdur:%"SCNd64" q:%f tex:%d mv:%d misc:%d imb:%d pmb:%d smb:%d d:%c",
 905                    &pict_type, &rce->i_duration, &rce->i_cpb_duration, &qp, &rce->tex_bits,
 906                    &rce->mv_bits, &rce->misc_bits, &rce->i_count, &rce->p_count,
 907                    &rce->s_count, &rce->direct_mode );
 908             rce->tex_bits  *= res_factor_bits;
 909             rce->mv_bits   *= res_factor_bits;
 910             rce->misc_bits *= res_factor_bits;
 911             rce->i_count   *= res_factor;
 912             rce->p_count   *= res_factor;
 913             rce->s_count   *= res_factor;
 914
 915             p = strstr( p, "ref:" );
 916             if( !p )
 917                 goto parse_error;
 918             p += 4;
 919             for( ref = 0; ref < 16; ref++ )
 920             {
 921                 if( sscanf( p, " %d", &rce->refcount[ref] ) != 1 )
 922                     break;
 923                 p = strchr( p+1, ' ' );
 924                 if( !p )
 925                     goto parse_error;
 926             }
 927             rce->refs = ref;
 928
 929             /* find weights */
 930             rce->i_weight_denom[0] = rce->i_weight_denom[1] = -1;
 931             char *w = strchr( p, 'w' );
 932             if( w )
 933             {
 934                 int count = sscanf( w, "w:%hd,%hd,%hd,%hd,%hd,%hd,%hd,%hd",
 935                                     &rce->i_weight_denom[0], &rce->weight[0][0], &rce->weight[0][1],
 936                                     &rce->i_weight_denom[1], &rce->weight[1][0], &rce->weight[1][1],
 937                                     &rce->weight[2][0], &rce->weight[2][1] );
 938                 if( count == 3 )
 939                     rce->i_weight_denom[1] = -1;
 940                 else if ( count != 8 )
 941                     rce->i_weight_denom[0] = rce->i_weight_denom[1] = -1;
 942             }
 943
 944             if( pict_type != 'b' )
 945                 rce->kept_as_ref = 1;
 946             switch( pict_type )
 947             {
 948                 case 'I':
 949                     rce->frame_type = X264_TYPE_IDR;
 950                     rce->pict_type  = SLICE_TYPE_I;
 951                     break;
 952                 case 'i':
 953                     rce->frame_type = X264_TYPE_I;
 954                     rce->pict_type  = SLICE_TYPE_I;
 955                     break;
 956                 case 'P':
 957                     rce->frame_type = X264_TYPE_P;
 958                     rce->pict_type  = SLICE_TYPE_P;
 959                     break;
 960                 case 'B':
 961                     rce->frame_type = X264_TYPE_BREF;
 962                     rce->pict_type  = SLICE_TYPE_B;
 963                     break;
 964                 case 'b':
 965                     rce->frame_type = X264_TYPE_B;
 966                     rce->pict_type  = SLICE_TYPE_B;
 967                     break;
 968                 default:  e = -1; break;
 969             }
 970             if( e < 12 )
 971             {
 972 parse_error:
 973                 x264_log( h, X264_LOG_ERROR, "statistics are damaged at line %d, parser out=%d\n", i, e );
 974                 return -1;
 975             }
 976             rce->qscale = qp2qscale( qp );
 977             p = next;
 978         }
 979
 980         x264_free( stats_buf );
 981
 982         if( h->param.rc.i_rc_method == X264_RC_ABR )
 983         {
 984             if( init_pass2( h ) < 0 )
 985                 return -1;
 986         } /* else we're using constant quant, so no need to run the bitrate allocation */
 987     }
 988
 989     /* Open output file */
 990     /* If input and output files are the same, output to a temp file
 991      * and move it to the real name only when it's complete */
 992     if( h->param.rc.b_stat_write )
 993     {
 994         char *p;
 995         rc->psz_stat_file_tmpname = x264_strcat_filename( h->param.rc.psz_stat_out, ".temp" );
 996         if( !rc->psz_stat_file_tmpname )
 997             return -1;
 998
 999         rc->p_stat_file_out = fopen( rc->psz_stat_file_tmpname, "wb" );
1000         if( rc->p_stat_file_out == NULL )
1001         {
1002             x264_log( h, X264_LOG_ERROR, "ratecontrol_init: can't open stats file\n" );
1003             return -1;
1004         }
1005
1006         p = x264_param2string( &h->param, 1 );
1007         if( p )
1008             fprintf( rc->p_stat_file_out, "#options: %s\n", p );
1009         x264_free( p );
1010         if( h->param.rc.b_mb_tree && !h->param.rc.b_stat_read )
1011         {
1012             rc->psz_mbtree_stat_file_tmpname = x264_strcat_filename( h->param.rc.psz_stat_out, ".mbtree.temp" );
1013             rc->psz_mbtree_stat_file_name = x264_strcat_filename( h->param.rc.psz_stat_out, ".mbtree" );
1014             if( !rc->psz_mbtree_stat_file_tmpname || !rc->psz_mbtree_stat_file_name )
1015                 return -1;
1016
1017             rc->p_mbtree_stat_file_out = fopen( rc->psz_mbtree_stat_file_tmpname, "wb" );
1018             if( rc->p_mbtree_stat_file_out == NULL )
1019             {
1020                 x264_log( h, X264_LOG_ERROR, "ratecontrol_init: can't open mbtree stats file\n" );
1021                 return -1;
1022             }
1023         }
1024     }
1025
1026     if( h->param.rc.b_mb_tree && (h->param.rc.b_stat_read || h->param.rc.b_stat_write) )
1027     {
1028         CHECKED_MALLOC( rc->qp_buffer[0], h->mb.i_mb_count * sizeof(uint16_t) );
1029         if( h->param.i_bframe_pyramid && h->param.rc.b_stat_read )
1030             CHECKED_MALLOC( rc->qp_buffer[1], h->mb.i_mb_count * sizeof(uint16_t) );
1031         rc->qpbuf_pos = -1;
1032     }
1033
1034     for( int i = 0; i<h->param.i_threads; i++ )
1035     {
1036         h->thread[i]->rc = rc+i;
1037         if( i )
1038         {
1039             rc[i] = rc[0];
1040             h->thread[i]->param = h->param;
1041             h->thread[i]->mb.b_variable_qp = h->mb.b_variable_qp;
1042             h->thread[i]->mb.ip_offset = h->mb.ip_offset;
1043         }
1044     }
1045
1046     return 0;
1047 fail:
1048     return -1;
1049 }
1050
1051 static int parse_zone( x264_t *h, x264_zone_t *z, char *p )
1052 {
1053     int len = 0;
1054     char *tok, UNUSED *saveptr=NULL;
1055     z->param = NULL;
1056     z->f_bitrate_factor = 1;
1057     if( 3 <= sscanf(p, "%d,%d,q=%d%n", &z->i_start, &z->i_end, &z->i_qp, &len) )
1058         z->b_force_qp = 1;
1059     else if( 3 <= sscanf(p, "%d,%d,b=%f%n", &z->i_start, &z->i_end, &z->f_bitrate_factor, &len) )
1060         z->b_force_qp = 0;
1061     else if( 2 <= sscanf(p, "%d,%d%n", &z->i_start, &z->i_end, &len) )
1062         z->b_force_qp = 0;
1063     else
1064     {
1065         x264_log( h, X264_LOG_ERROR, "invalid zone: \"%s\"\n", p );
1066         return -1;
1067     }
1068     p += len;
1069     if( !*p )
1070         return 0;
1071     CHECKED_MALLOC( z->param, sizeof(x264_param_t) );
1072     memcpy( z->param, &h->param, sizeof(x264_param_t) );
1073     z->param->param_free = x264_free;
1074     while( (tok = strtok_r( p, ",", &saveptr )) )
1075     {
1076         char *val = strchr( tok, '=' );
1077         if( val )
1078         {
1079             *val = '\0';
1080             val++;
1081         }
1082         if( x264_param_parse( z->param, tok, val ) )
1083         {
1084             x264_log( h, X264_LOG_ERROR, "invalid zone param: %s = %s\n", tok, val );
1085             return -1;
1086         }
1087         p = NULL;
1088     }
1089     return 0;
1090 fail:
1091     return -1;
1092 }
1093
1094 static int parse_zones( x264_t *h )
1095 {
1096     x264_ratecontrol_t *rc = h->rc;
1097     if( h->param.rc.psz_zones && !h->param.rc.i_zones )
1098     {
1099         char *psz_zones, *p;
1100         CHECKED_MALLOC( psz_zones, strlen( h->param.rc.psz_zones )+1 );
1101         strcpy( psz_zones, h->param.rc.psz_zones );
1102         h->param.rc.i_zones = 1;
1103         for( p = psz_zones; *p; p++ )
1104             h->param.rc.i_zones += (*p == '/');
1105         CHECKED_MALLOC( h->param.rc.zones, h->param.rc.i_zones * sizeof(x264_zone_t) );
1106         p = psz_zones;
1107         for( int i = 0; i < h->param.rc.i_zones; i++ )
1108         {
1109             int i_tok = strcspn( p, "/" );
1110             p[i_tok] = 0;
1111             if( parse_zone( h, &h->param.rc.zones[i], p ) )
1112                 return -1;
1113             p += i_tok + 1;
1114         }
1115         x264_free( psz_zones );
1116     }
1117
1118     if( h->param.rc.i_zones > 0 )
1119     {
1120         for( int i = 0; i < h->param.rc.i_zones; i++ )
1121         {
1122             x264_zone_t z = h->param.rc.zones[i];
1123             if( z.i_start < 0 || z.i_start > z.i_end )
1124             {
1125                 x264_log( h, X264_LOG_ERROR, "invalid zone: start=%d end=%d\n",
1126                           z.i_start, z.i_end );
1127                 return -1;
1128             }
1129             else if( !z.b_force_qp && z.f_bitrate_factor <= 0 )
1130             {
1131                 x264_log( h, X264_LOG_ERROR, "invalid zone: bitrate_factor=%f\n",
1132                           z.f_bitrate_factor );
1133                 return -1;
1134             }
1135         }
1136
1137         rc->i_zones = h->param.rc.i_zones + 1;
1138         CHECKED_MALLOC( rc->zones, rc->i_zones * sizeof(x264_zone_t) );
1139         memcpy( rc->zones+1, h->param.rc.zones, (rc->i_zones-1) * sizeof(x264_zone_t) );
1140
1141         // default zone to fall back to if none of the others match
1142         rc->zones[0].i_start = 0;
1143         rc->zones[0].i_end = INT_MAX;
1144         rc->zones[0].b_force_qp = 0;
1145         rc->zones[0].f_bitrate_factor = 1;
1146         CHECKED_MALLOC( rc->zones[0].param, sizeof(x264_param_t) );
1147         memcpy( rc->zones[0].param, &h->param, sizeof(x264_param_t) );
1148         for( int i = 1; i < rc->i_zones; i++ )
1149         {
1150             if( !rc->zones[i].param )
1151                 rc->zones[i].param = rc->zones[0].param;
1152         }
1153     }
1154
1155     return 0;
1156 fail:
1157     return -1;
1158 }
1159
1160 static x264_zone_t *get_zone( x264_t *h, int frame_num )
1161 {
1162     for( int i = h->rc->i_zones - 1; i >= 0; i-- )
1163     {
1164         x264_zone_t *z = &h->rc->zones[i];
1165         if( frame_num >= z->i_start && frame_num <= z->i_end )
1166             return z;
1167     }
1168     return NULL;
1169 }
1170
1171 void x264_ratecontrol_summary( x264_t *h )
1172 {
1173     x264_ratecontrol_t *rc = h->rc;
1174     if( rc->b_abr && h->param.rc.i_rc_method == X264_RC_ABR && rc->cbr_decay > .9999 )
1175     {
1176         double base_cplx = h->mb.i_mb_count * (h->param.i_bframe ? 120 : 80);
1177         double mbtree_offset = h->param.rc.b_mb_tree ? (1.0-h->param.rc.f_qcompress)*13.5 : 0;
1178         x264_log( h, X264_LOG_INFO, "final ratefactor: %.2f\n",
1179                   qscale2qp( pow( base_cplx, 1 - rc->qcompress )
1180                              * rc->cplxr_sum / rc->wanted_bits_window ) - mbtree_offset - QP_BD_OFFSET );
1181     }
1182 }
1183
1184 void x264_ratecontrol_delete( x264_t *h )
1185 {
1186     x264_ratecontrol_t *rc = h->rc;
1187     int b_regular_file;
1188
1189     if( rc->p_stat_file_out )
1190     {
1191         b_regular_file = x264_is_regular_file( rc->p_stat_file_out );
1192         fclose( rc->p_stat_file_out );
1193         if( h->i_frame >= rc->num_entries && b_regular_file )
1194             if( rename( rc->psz_stat_file_tmpname, h->param.rc.psz_stat_out ) != 0 )
1195             {
1196                 x264_log( h, X264_LOG_ERROR, "failed to rename \"%s\" to \"%s\"\n",
1197                           rc->psz_stat_file_tmpname, h->param.rc.psz_stat_out );
1198             }
1199         x264_free( rc->psz_stat_file_tmpname );
1200     }
1201     if( rc->p_mbtree_stat_file_out )
1202     {
1203         b_regular_file = x264_is_regular_file( rc->p_mbtree_stat_file_out );
1204         fclose( rc->p_mbtree_stat_file_out );
1205         if( h->i_frame >= rc->num_entries && b_regular_file )
1206             if( rename( rc->psz_mbtree_stat_file_tmpname, rc->psz_mbtree_stat_file_name ) != 0 )
1207             {
1208                 x264_log( h, X264_LOG_ERROR, "failed to rename \"%s\" to \"%s\"\n",
1209                           rc->psz_mbtree_stat_file_tmpname, rc->psz_mbtree_stat_file_name );
1210             }
1211         x264_free( rc->psz_mbtree_stat_file_tmpname );
1212         x264_free( rc->psz_mbtree_stat_file_name );
1213     }
1214     if( rc->p_mbtree_stat_file_in )
1215         fclose( rc->p_mbtree_stat_file_in );
1216     x264_free( rc->pred );
1217     x264_free( rc->pred_b_from_p );
1218     x264_free( rc->entry );
1219     x264_free( rc->qp_buffer[0] );
1220     x264_free( rc->qp_buffer[1] );
1221     if( rc->zones )
1222     {
1223         x264_free( rc->zones[0].param );
1224         for( int i = 1; i < rc->i_zones; i++ )
1225             if( rc->zones[i].param != rc->zones[0].param && rc->zones[i].param->param_free )
1226                 rc->zones[i].param->param_free( rc->zones[i].param );
1227         x264_free( rc->zones );
1228     }
1229     x264_free( rc );
1230 }
1231
1232 static void accum_p_qp_update( x264_t *h, float qp )
1233 {
1234     x264_ratecontrol_t *rc = h->rc;
1235     rc->accum_p_qp   *= .95;
1236     rc->accum_p_norm *= .95;
1237     rc->accum_p_norm += 1;
1238     if( h->sh.i_type == SLICE_TYPE_I )
1239         rc->accum_p_qp += qp + rc->ip_offset;
1240     else
1241         rc->accum_p_qp += qp;
1242 }
1243
1244 /* Before encoding a frame, choose a QP for it */
1245 void x264_ratecontrol_start( x264_t *h, int i_force_qp, int overhead )
1246 {
1247     x264_ratecontrol_t *rc = h->rc;
1248     ratecontrol_entry_t *rce = NULL;
1249     x264_zone_t *zone = get_zone( h, h->fenc->i_frame );
1250     float q;
1251
1252     x264_emms();
1253
1254     if( zone && (!rc->prev_zone || zone->param != rc->prev_zone->param) )
1255         x264_encoder_reconfig( h, zone->param );
1256     rc->prev_zone = zone;
1257
1258     if( h->param.rc.b_stat_read )
1259     {
1260         int frame = h->fenc->i_frame;
1261         assert( frame >= 0 && frame < rc->num_entries );
1262         rce = h->rc->rce = &h->rc->entry[frame];
1263
1264         if( h->sh.i_type == SLICE_TYPE_B
1265             && h->param.analyse.i_direct_mv_pred == X264_DIRECT_PRED_AUTO )
1266         {
1267             h->sh.b_direct_spatial_mv_pred = ( rce->direct_mode == 's' );
1268             h->mb.b_direct_auto_read = ( rce->direct_mode == 's' || rce->direct_mode == 't' );
1269         }
1270     }
1271
1272     if( rc->b_vbv )
1273     {
1274         memset( h->fdec->i_row_bits, 0, h->mb.i_mb_height * sizeof(int) );
1275         memset( h->fdec->f_row_qp, 0, h->mb.i_mb_height * sizeof(float) );
1276         memset( h->fdec->f_row_qscale, 0, h->mb.i_mb_height * sizeof(float) );
1277         rc->row_pred = &rc->row_preds[h->sh.i_type];
1278         rc->buffer_rate = h->fenc->i_cpb_duration * rc->vbv_max_rate * h->sps->vui.i_num_units_in_tick / h->sps->vui.i_time_scale;
1279         update_vbv_plan( h, overhead );
1280
1281         const x264_level_t *l = x264_levels;
1282         while( l->level_idc != 0 && l->level_idc != h->param.i_level_idc )
1283             l++;
1284
1285         int mincr = l->mincr;
1286
1287         if( h->param.b_bluray_compat )
1288             mincr = 4;
1289
1290         /* Profiles above High don't require minCR, so just set the maximum to a large value. */
1291         if( h->sps->i_profile_idc > PROFILE_HIGH )
1292             rc->frame_size_maximum = 1e9;
1293         else
1294         {
1295             /* The spec has a bizarre special case for the first frame. */
1296             if( h->i_frame == 0 )
1297             {
1298                 //384 * ( Max( PicSizeInMbs, fR * MaxMBPS ) + MaxMBPS * ( tr( 0 ) - tr,n( 0 ) ) ) / MinCR
1299                 double fr = 1. / 172;
1300                 int pic_size_in_mbs = h->mb.i_mb_width * h->mb.i_mb_height;
1301                 rc->frame_size_maximum = 384 * BIT_DEPTH * X264_MAX( pic_size_in_mbs, fr*l->mbps ) / mincr;
1302             }
1303             else
1304             {
1305                 //384 * MaxMBPS * ( tr( n ) - tr( n - 1 ) ) / MinCR
1306                 rc->frame_size_maximum = 384 * BIT_DEPTH * ((double)h->fenc->i_cpb_duration * h->sps->vui.i_num_units_in_tick / h->sps->vui.i_time_scale) * l->mbps / mincr;
1307             }
1308         }
1309     }
1310
1311     if( h->sh.i_type != SLICE_TYPE_B )
1312         rc->bframes = h->fenc->i_bframes;
1313
1314     if( rc->b_abr )
1315     {
1316         q = qscale2qp( rate_estimate_qscale( h ) );
1317     }
1318     else if( rc->b_2pass )
1319     {
1320         rce->new_qscale = rate_estimate_qscale( h );
1321         q = qscale2qp( rce->new_qscale );
1322     }
1323     else /* CQP */
1324     {
1325         if( h->sh.i_type == SLICE_TYPE_B && h->fdec->b_kept_as_ref )
1326             q = ( rc->qp_constant[ SLICE_TYPE_B ] + rc->qp_constant[ SLICE_TYPE_P ] ) / 2;
1327         else
1328             q = rc->qp_constant[ h->sh.i_type ];
1329
1330         if( zone )
1331         {
1332             if( zone->b_force_qp )
1333                 q += zone->i_qp - rc->qp_constant[SLICE_TYPE_P];
1334             else
1335                 q -= 6*log2f( zone->f_bitrate_factor );
1336         }
1337     }
1338     if( i_force_qp != X264_QP_AUTO )
1339         q = i_force_qp - 1;
1340
1341     q = x264_clip3f( q, h->param.rc.i_qp_min, h->param.rc.i_qp_max );
1342
1343     rc->qpa_rc = rc->qpa_rc_prev =
1344     rc->qpa_aq = rc->qpa_aq_prev = 0;
1345     rc->qp = x264_clip3( q + 0.5f, 0, QP_MAX );
1346     h->fdec->f_qp_avg_rc =
1347     h->fdec->f_qp_avg_aq =
1348     rc->qpm = q;
1349     if( rce )
1350         rce->new_qp = rc->qp;
1351
1352     accum_p_qp_update( h, rc->qpm );
1353
1354     if( h->sh.i_type != SLICE_TYPE_B )
1355         rc->last_non_b_pict_type = h->sh.i_type;
1356 }
1357
1358 static float predict_row_size( x264_t *h, int y, float qscale )
1359 {
1360     /* average between two predictors:
1361      * absolute SATD, and scaled bit cost of the colocated row in the previous frame */
1362     x264_ratecontrol_t *rc = h->rc;
1363     float pred_s = predict_size( rc->row_pred[0], qscale, h->fdec->i_row_satd[y] );
1364     if( h->sh.i_type == SLICE_TYPE_I || qscale >= h->fref[0][0]->f_row_qscale[y] )
1365     {
1366         if( h->sh.i_type == SLICE_TYPE_P
1367             && h->fref[0][0]->i_type == h->fdec->i_type
1368             && h->fref[0][0]->f_row_qscale[y] > 0
1369             && h->fref[0][0]->i_row_satd[y] > 0
1370             && (abs(h->fref[0][0]->i_row_satd[y] - h->fdec->i_row_satd[y]) < h->fdec->i_row_satd[y]/2))
1371         {
1372             float pred_t = h->fref[0][0]->i_row_bits[y] * h->fdec->i_row_satd[y] / h->fref[0][0]->i_row_satd[y]
1373                          * h->fref[0][0]->f_row_qscale[y] / qscale;
1374             return (pred_s + pred_t) * 0.5f;
1375         }
1376         return pred_s;
1377     }
1378     /* Our QP is lower than the reference! */
1379     else
1380     {
1381         float pred_intra = predict_size( rc->row_pred[1], qscale, h->fdec->i_row_satds[0][0][y] );
1382         /* Sum: better to overestimate than underestimate by using only one of the two predictors. */
1383         return pred_intra + pred_s;
1384     }
1385 }
1386
1387 static int row_bits_so_far( x264_t *h, int y )
1388 {
1389     int bits = 0;
1390     for( int i = h->i_threadslice_start; i <= y; i++ )
1391         bits += h->fdec->i_row_bits[i];
1392     return bits;
1393 }
1394
1395 static float predict_row_size_sum( x264_t *h, int y, float qp )
1396 {
1397     float qscale = qp2qscale( qp );
1398     float bits = row_bits_so_far( h, y );
1399     for( int i = y+1; i < h->i_threadslice_end; i++ )
1400         bits += predict_row_size( h, i, qscale );
1401     return bits;
1402 }
1403
1404 /* TODO:
1405  *  eliminate all use of qp in row ratecontrol: make it entirely qscale-based.
1406  *  make this function stop being needlessly O(N^2)
1407  *  update more often than once per row? */
1408 int x264_ratecontrol_mb( x264_t *h, int bits )
1409 {
1410     x264_ratecontrol_t *rc = h->rc;
1411     const int y = h->mb.i_mb_y;
1412
1413     h->fdec->i_row_bits[y] += bits;
1414     rc->qpa_aq += h->mb.i_qp;
1415
1416     if( h->mb.i_mb_x != h->mb.i_mb_width - 1 )
1417         return 0;
1418
1419     x264_emms();
1420     rc->qpa_rc += rc->qpm * h->mb.i_mb_width;
1421
1422     if( !rc->b_vbv )
1423         return 0;
1424
1425     float qscale = qp2qscale( rc->qpm );
1426     h->fdec->f_row_qp[y] = rc->qpm;
1427     h->fdec->f_row_qscale[y] = qscale;
1428
1429     update_predictor( rc->row_pred[0], qscale, h->fdec->i_row_satd[y], h->fdec->i_row_bits[y] );
1430     if( h->sh.i_type == SLICE_TYPE_P && rc->qpm < h->fref[0][0]->f_row_qp[y] )
1431         update_predictor( rc->row_pred[1], qscale, h->fdec->i_row_satds[0][0][y], h->fdec->i_row_bits[y] );
1432
1433     /* update ratecontrol per-mbpair in MBAFF */
1434     if( SLICE_MBAFF && !(y&1) )
1435         return 0;
1436
1437     /* FIXME: We don't currently support the case where there's a slice
1438      * boundary in between. */
1439     int can_reencode_row = h->sh.i_first_mb <= ((h->mb.i_mb_y - SLICE_MBAFF) * h->mb.i_mb_stride);
1440
1441     /* tweak quality based on difference from predicted size */
1442     float prev_row_qp = h->fdec->f_row_qp[y];
1443     float qp_absolute_max = h->param.rc.i_qp_max;
1444     if( rc->rate_factor_max_increment )
1445         qp_absolute_max = X264_MIN( qp_absolute_max, rc->qp_novbv + rc->rate_factor_max_increment );
1446     float qp_max = X264_MIN( prev_row_qp + h->param.rc.i_qp_step, qp_absolute_max );
1447     float qp_min = X264_MAX( prev_row_qp - h->param.rc.i_qp_step, h->param.rc.i_qp_min );
1448     float step_size = 0.5f;
1449     float buffer_left_planned = rc->buffer_fill - rc->frame_size_planned;
1450     float slice_size_planned = h->param.b_sliced_threads ? rc->slice_size_planned : rc->frame_size_planned;
1451     float max_frame_error = X264_MAX( 0.05f, 1.0f / h->mb.i_mb_height );
1452     float size_of_other_slices = 0;
1453     if( h->param.b_sliced_threads )
1454     {
1455         float size_of_other_slices_planned = 0;
1456         for( int i = 0; i < h->param.i_threads; i++ )
1457             if( h != h->thread[i] )
1458             {
1459                 size_of_other_slices += h->thread[i]->rc->frame_size_estimated;
1460                 size_of_other_slices_planned += h->thread[i]->rc->slice_size_planned;
1461             }
1462         float weight = rc->slice_size_planned / rc->frame_size_planned;
1463         size_of_other_slices = (size_of_other_slices - size_of_other_slices_planned) * weight + size_of_other_slices_planned;
1464     }
1465     if( y < h->i_threadslice_end-1 )
1466     {
1467         /* B-frames shouldn't use lower QP than their reference frames. */
1468         if( h->sh.i_type == SLICE_TYPE_B )
1469         {
1470             qp_min = X264_MAX( qp_min, X264_MAX( h->fref[0][0]->f_row_qp[y+1], h->fref[1][0]->f_row_qp[y+1] ) );
1471             rc->qpm = X264_MAX( rc->qpm, qp_min );
1472         }
1473
1474         /* More threads means we have to be more cautious in letting ratecontrol use up extra bits. */
1475         float rc_tol = buffer_left_planned / h->param.i_threads * rc->rate_tolerance;
1476         float b1 = predict_row_size_sum( h, y, rc->qpm ) + size_of_other_slices;
1477
1478         /* Don't increase the row QPs until a sufficent amount of the bits of the frame have been processed, in case a flat */
1479         /* area at the top of the frame was measured inaccurately. */
1480         if( row_bits_so_far( h, y ) < 0.05f * slice_size_planned )
1481             qp_max = qp_absolute_max = prev_row_qp;
1482
1483         if( h->sh.i_type != SLICE_TYPE_I )
1484             rc_tol *= 0.5f;
1485
1486         if( !rc->b_vbv_min_rate )
1487             qp_min = X264_MAX( qp_min, rc->qp_novbv );
1488
1489         while( rc->qpm < qp_max
1490                && ((b1 > rc->frame_size_planned + rc_tol) ||
1491                    (rc->buffer_fill - b1 < buffer_left_planned * 0.5f) ||
1492                    (b1 > rc->frame_size_planned && rc->qpm < rc->qp_novbv)) )
1493         {
1494             rc->qpm += step_size;
1495             b1 = predict_row_size_sum( h, y, rc->qpm ) + size_of_other_slices;
1496         }
1497
1498         while( rc->qpm > qp_min
1499                && (rc->qpm > h->fdec->f_row_qp[0] || rc->single_frame_vbv)
1500                && ((b1 < rc->frame_size_planned * 0.8f && rc->qpm <= prev_row_qp)
1501                || b1 < (rc->buffer_fill - rc->buffer_size + rc->buffer_rate) * 1.1f) )
1502         {
1503             rc->qpm -= step_size;
1504             b1 = predict_row_size_sum( h, y, rc->qpm ) + size_of_other_slices;
1505         }
1506
1507         /* avoid VBV underflow or MinCR violation */
1508         while( (rc->qpm < qp_absolute_max)
1509                && ((rc->buffer_fill - b1 < rc->buffer_rate * max_frame_error) ||
1510                    (rc->frame_size_maximum - b1 < rc->frame_size_maximum * max_frame_error)))
1511         {
1512             rc->qpm += step_size;
1513             b1 = predict_row_size_sum( h, y, rc->qpm ) + size_of_other_slices;
1514         }
1515
1516         h->rc->frame_size_estimated = b1 - size_of_other_slices;
1517
1518         /* If the current row was large enough to cause a large QP jump, try re-encoding it. */
1519         if( rc->qpm > qp_max && prev_row_qp < qp_max && can_reencode_row )
1520         {
1521             /* Bump QP to halfway in between... close enough. */
1522             rc->qpm = x264_clip3f( (prev_row_qp + rc->qpm)*0.5f, prev_row_qp + 1.0f, qp_max );
1523             rc->qpa_rc = rc->qpa_rc_prev;
1524             rc->qpa_aq = rc->qpa_aq_prev;
1525             h->fdec->i_row_bits[y] = h->fdec->i_row_bits[y-SLICE_MBAFF] = 0;
1526             return -1;
1527         }
1528     }
1529     else
1530     {
1531         h->rc->frame_size_estimated = predict_row_size_sum( h, y, rc->qpm );
1532
1533         /* Last-ditch attempt: if the last row of the frame underflowed the VBV,
1534          * try again. */
1535         if( (h->rc->frame_size_estimated + size_of_other_slices) > (rc->buffer_fill - rc->buffer_rate * max_frame_error) &&
1536              rc->qpm < qp_max && can_reencode_row )
1537         {
1538             rc->qpm = qp_max;
1539             rc->qpa_rc = rc->qpa_rc_prev;
1540             rc->qpa_aq = rc->qpa_aq_prev;
1541             h->fdec->i_row_bits[y] = h->fdec->i_row_bits[y-SLICE_MBAFF] = 0;
1542             return -1;
1543         }
1544     }
1545
1546     rc->qpa_rc_prev = rc->qpa_rc;
1547     rc->qpa_aq_prev = rc->qpa_aq;
1548
1549     return 0;
1550 }
1551
1552 int x264_ratecontrol_qp( x264_t *h )
1553 {
1554     x264_emms();
1555     return x264_clip3( h->rc->qpm + 0.5f, h->param.rc.i_qp_min, h->param.rc.i_qp_max );
1556 }
1557
1558 int x264_ratecontrol_mb_qp( x264_t *h )
1559 {
1560     x264_emms();
1561     float qp = h->rc->qpm;
1562     if( h->param.rc.i_aq_mode )
1563     {
1564          /* MB-tree currently doesn't adjust quantizers in unreferenced frames. */
1565         float qp_offset = h->fdec->b_kept_as_ref ? h->fenc->f_qp_offset[h->mb.i_mb_xy] : h->fenc->f_qp_offset_aq[h->mb.i_mb_xy];
1566         /* Scale AQ's effect towards zero in emergency mode. */
1567         if( qp > QP_MAX_SPEC )
1568             qp_offset *= (QP_MAX - qp) / (QP_MAX - QP_MAX_SPEC);
1569         qp += qp_offset;
1570     }
1571     return x264_clip3( qp + 0.5f, h->param.rc.i_qp_min, h->param.rc.i_qp_max );
1572 }
1573
1574 /* In 2pass, force the same frame types as in the 1st pass */
1575 int x264_ratecontrol_slice_type( x264_t *h, int frame_num )
1576 {
1577     x264_ratecontrol_t *rc = h->rc;
1578     if( h->param.rc.b_stat_read )
1579     {
1580         if( frame_num >= rc->num_entries )
1581         {
1582             /* We could try to initialize everything required for ABR and
1583              * adaptive B-frames, but that would be complicated.
1584              * So just calculate the average QP used so far. */
1585             h->param.rc.i_qp_constant = (h->stat.i_frame_count[SLICE_TYPE_P] == 0) ? 24 + QP_BD_OFFSET
1586                                       : 1 + h->stat.f_frame_qp[SLICE_TYPE_P] / h->stat.i_frame_count[SLICE_TYPE_P];
1587             rc->qp_constant[SLICE_TYPE_P] = x264_clip3( h->param.rc.i_qp_constant, 0, QP_MAX );
1588             rc->qp_constant[SLICE_TYPE_I] = x264_clip3( (int)( qscale2qp( qp2qscale( h->param.rc.i_qp_constant ) / fabs( h->param.rc.f_ip_factor )) + 0.5 ), 0, QP_MAX );
1589             rc->qp_constant[SLICE_TYPE_B] = x264_clip3( (int)( qscale2qp( qp2qscale( h->param.rc.i_qp_constant ) * fabs( h->param.rc.f_pb_factor )) + 0.5 ), 0, QP_MAX );
1590
1591             x264_log( h, X264_LOG_ERROR, "2nd pass has more frames than 1st pass (%d)\n", rc->num_entries );
1592             x264_log( h, X264_LOG_ERROR, "continuing anyway, at constant QP=%d\n", h->param.rc.i_qp_constant );
1593             if( h->param.i_bframe_adaptive )
1594                 x264_log( h, X264_LOG_ERROR, "disabling adaptive B-frames\n" );
1595
1596             for( int i = 0; i < h->param.i_threads; i++ )
1597             {
1598                 h->thread[i]->rc->b_abr = 0;
1599                 h->thread[i]->rc->b_2pass = 0;
1600                 h->thread[i]->param.rc.i_rc_method = X264_RC_CQP;
1601                 h->thread[i]->param.rc.b_stat_read = 0;
1602                 h->thread[i]->param.i_bframe_adaptive = 0;
1603                 h->thread[i]->param.i_scenecut_threshold = 0;
1604                 h->thread[i]->param.rc.b_mb_tree = 0;
1605                 if( h->thread[i]->param.i_bframe > 1 )
1606                     h->thread[i]->param.i_bframe = 1;
1607             }
1608             return X264_TYPE_AUTO;
1609         }
1610         return rc->entry[frame_num].frame_type;
1611     }
1612     else
1613         return X264_TYPE_AUTO;
1614 }
1615
1616 void x264_ratecontrol_set_weights( x264_t *h, x264_frame_t *frm )
1617 {
1618     ratecontrol_entry_t *rce = &h->rc->entry[frm->i_frame];
1619     if( h->param.analyse.i_weighted_pred <= 0 )
1620         return;
1621
1622     if( rce->i_weight_denom[0] >= 0 )
1623         SET_WEIGHT( frm->weight[0][0], 1, rce->weight[0][0], rce->i_weight_denom[0], rce->weight[0][1] );
1624
1625     if( rce->i_weight_denom[1] >= 0 )
1626     {
1627         SET_WEIGHT( frm->weight[0][1], 1, rce->weight[1][0], rce->i_weight_denom[1], rce->weight[1][1] );
1628         SET_WEIGHT( frm->weight[0][2], 1, rce->weight[2][0], rce->i_weight_denom[1], rce->weight[2][1] );
1629     }
1630 }
1631
1632 /* After encoding one frame, save stats and update ratecontrol state */
1633 int x264_ratecontrol_end( x264_t *h, int bits, int *filler )
1634 {
1635     x264_ratecontrol_t *rc = h->rc;
1636     const int *mbs = h->stat.frame.i_mb_count;
1637
1638     x264_emms();
1639
1640     h->stat.frame.i_mb_count_skip = mbs[P_SKIP] + mbs[B_SKIP];
1641     h->stat.frame.i_mb_count_i = mbs[I_16x16] + mbs[I_8x8] + mbs[I_4x4];
1642     h->stat.frame.i_mb_count_p = mbs[P_L0] + mbs[P_8x8];
1643     for( int i = B_DIRECT; i < B_8x8; i++ )
1644         h->stat.frame.i_mb_count_p += mbs[i];
1645
1646     h->fdec->f_qp_avg_rc = rc->qpa_rc /= h->mb.i_mb_count;
1647     h->fdec->f_qp_avg_aq = (float)rc->qpa_aq / h->mb.i_mb_count;
1648
1649     if( h->param.rc.b_stat_write )
1650     {
1651         char c_type = h->sh.i_type==SLICE_TYPE_I ? (h->fenc->i_poc==0 ? 'I' : 'i')
1652                     : h->sh.i_type==SLICE_TYPE_P ? 'P'
1653                     : h->fenc->b_kept_as_ref ? 'B' : 'b';
1654         int dir_frame = h->stat.frame.i_direct_score[1] - h->stat.frame.i_direct_score[0];
1655         int dir_avg = h->stat.i_direct_score[1] - h->stat.i_direct_score[0];
1656         char c_direct = h->mb.b_direct_auto_write ?
1657                         ( dir_frame>0 ? 's' : dir_frame<0 ? 't' :
1658                           dir_avg>0 ? 's' : dir_avg<0 ? 't' : '-' )
1659                         : '-';
1660         if( fprintf( rc->p_stat_file_out,
1661                  "in:%d out:%d type:%c dur:%"PRId64" cpbdur:%"PRId64" q:%.2f tex:%d mv:%d misc:%d imb:%d pmb:%d smb:%d d:%c ref:",
1662                  h->fenc->i_frame, h->i_frame,
1663                  c_type, h->fenc->i_duration,
1664                  h->fenc->i_cpb_duration, rc->qpa_rc,
1665                  h->stat.frame.i_tex_bits,
1666                  h->stat.frame.i_mv_bits,
1667                  h->stat.frame.i_misc_bits,
1668                  h->stat.frame.i_mb_count_i,
1669                  h->stat.frame.i_mb_count_p,
1670                  h->stat.frame.i_mb_count_skip,
1671                  c_direct) < 0 )
1672             goto fail;
1673
1674         /* Only write information for reference reordering once. */
1675         int use_old_stats = h->param.rc.b_stat_read && rc->rce->refs > 1;
1676         for( int i = 0; i < (use_old_stats ? rc->rce->refs : h->i_ref[0]); i++ )
1677         {
1678             int refcount = use_old_stats         ? rc->rce->refcount[i]
1679                          : PARAM_INTERLACED      ? h->stat.frame.i_mb_count_ref[0][i*2]
1680                                                  + h->stat.frame.i_mb_count_ref[0][i*2+1]
1681                          :                         h->stat.frame.i_mb_count_ref[0][i];
1682             if( fprintf( rc->p_stat_file_out, "%d ", refcount ) < 0 )
1683                 goto fail;
1684         }
1685
1686         if( h->param.analyse.i_weighted_pred >= X264_WEIGHTP_SIMPLE && h->sh.weight[0][0].weightfn )
1687         {
1688             if( fprintf( rc->p_stat_file_out, "w:%d,%d,%d",
1689                          h->sh.weight[0][0].i_denom, h->sh.weight[0][0].i_scale, h->sh.weight[0][0].i_offset ) < 0 )
1690                 goto fail;
1691             if( h->sh.weight[0][1].weightfn || h->sh.weight[0][2].weightfn )
1692             {
1693                 if( fprintf( rc->p_stat_file_out, ",%d,%d,%d,%d,%d ",
1694                              h->sh.weight[0][1].i_denom, h->sh.weight[0][1].i_scale, h->sh.weight[0][1].i_offset,
1695                              h->sh.weight[0][2].i_scale, h->sh.weight[0][2].i_offset ) < 0 )
1696                     goto fail;
1697             }
1698             else if( fprintf( rc->p_stat_file_out, " " ) < 0 )
1699                 goto fail;
1700         }
1701
1702         if( fprintf( rc->p_stat_file_out, ";\n") < 0 )
1703             goto fail;
1704
1705         /* Don't re-write the data in multi-pass mode. */
1706         if( h->param.rc.b_mb_tree && h->fenc->b_kept_as_ref && !h->param.rc.b_stat_read )
1707         {
1708             uint8_t i_type = h->sh.i_type;
1709             /* Values are stored as big-endian FIX8.8 */
1710             for( int i = 0; i < h->mb.i_mb_count; i++ )
1711                 rc->qp_buffer[0][i] = endian_fix16( h->fenc->f_qp_offset[i]*256.0 );
1712             if( fwrite( &i_type, 1, 1, rc->p_mbtree_stat_file_out ) < 1 )
1713                 goto fail;
1714             if( fwrite( rc->qp_buffer[0], sizeof(uint16_t), h->mb.i_mb_count, rc->p_mbtree_stat_file_out ) < h->mb.i_mb_count )
1715                 goto fail;
1716         }
1717     }
1718
1719     if( rc->b_abr )
1720     {
1721         if( h->sh.i_type != SLICE_TYPE_B )
1722             rc->cplxr_sum += bits * qp2qscale( rc->qpa_rc ) / rc->last_rceq;
1723         else
1724         {
1725             /* Depends on the fact that B-frame's QP is an offset from the following P-frame's.
1726              * Not perfectly accurate with B-refs, but good enough. */
1727             rc->cplxr_sum += bits * qp2qscale( rc->qpa_rc ) / (rc->last_rceq * fabs( h->param.rc.f_pb_factor ));
1728         }
1729         rc->cplxr_sum *= rc->cbr_decay;
1730         rc->wanted_bits_window += h->fenc->f_duration * rc->bitrate;
1731         rc->wanted_bits_window *= rc->cbr_decay;
1732     }
1733
1734     if( rc->b_2pass )
1735         rc->expected_bits_sum += qscale2bits( rc->rce, qp2qscale( rc->rce->new_qp ) );
1736
1737     if( h->mb.b_variable_qp )
1738     {
1739         if( h->sh.i_type == SLICE_TYPE_B )
1740         {
1741             rc->bframe_bits += bits;
1742             if( h->fenc->b_last_minigop_bframe )
1743             {
1744                 update_predictor( rc->pred_b_from_p, qp2qscale( rc->qpa_rc ),
1745                                   h->fref[1][h->i_ref[1]-1]->i_satd, rc->bframe_bits / rc->bframes );
1746                 rc->bframe_bits = 0;
1747             }
1748         }
1749     }
1750
1751     *filler = update_vbv( h, bits );
1752     rc->filler_bits_sum += *filler * 8;
1753
1754     if( h->sps->vui.b_nal_hrd_parameters_present )
1755     {
1756         if( h->fenc->i_frame == 0 )
1757         {
1758             // access unit initialises the HRD
1759             h->fenc->hrd_timing.cpb_initial_arrival_time = 0;
1760             rc->initial_cpb_removal_delay = h->initial_cpb_removal_delay;
1761             rc->initial_cpb_removal_delay_offset = h->initial_cpb_removal_delay_offset;
1762             h->fenc->hrd_timing.cpb_removal_time = rc->nrt_first_access_unit = (double)rc->initial_cpb_removal_delay / 90000;
1763         }
1764         else
1765         {
1766             h->fenc->hrd_timing.cpb_removal_time = rc->nrt_first_access_unit + (double)(h->fenc->i_cpb_delay - h->i_cpb_delay_pir_offset) *
1767                                                    h->sps->vui.i_num_units_in_tick / h->sps->vui.i_time_scale;
1768
1769             double cpb_earliest_arrival_time = h->fenc->hrd_timing.cpb_removal_time - (double)rc->initial_cpb_removal_delay / 90000;
1770             if( h->fenc->b_keyframe )
1771             {
1772                  rc->nrt_first_access_unit = h->fenc->hrd_timing.cpb_removal_time;
1773                  rc->initial_cpb_removal_delay = h->initial_cpb_removal_delay;
1774                  rc->initial_cpb_removal_delay_offset = h->initial_cpb_removal_delay_offset;
1775             }
1776             else
1777                  cpb_earliest_arrival_time -= (double)rc->initial_cpb_removal_delay_offset / 90000;
1778
1779             if( h->sps->vui.hrd.b_cbr_hrd )
1780                 h->fenc->hrd_timing.cpb_initial_arrival_time = rc->previous_cpb_final_arrival_time;
1781             else
1782                 h->fenc->hrd_timing.cpb_initial_arrival_time = X264_MAX( rc->previous_cpb_final_arrival_time, cpb_earliest_arrival_time );
1783         }
1784         int filler_bits = *filler ? X264_MAX( (FILLER_OVERHEAD - h->param.b_annexb), *filler )*8 : 0;
1785         // Equation C-6
1786         h->fenc->hrd_timing.cpb_final_arrival_time = rc->previous_cpb_final_arrival_time = h->fenc->hrd_timing.cpb_initial_arrival_time +
1787                                                      (double)(bits + filler_bits) / h->sps->vui.hrd.i_bit_rate_unscaled;
1788
1789         h->fenc->hrd_timing.dpb_output_time = (double)h->fenc->i_dpb_output_delay * h->sps->vui.i_num_units_in_tick / h->sps->vui.i_time_scale +
1790                                               h->fenc->hrd_timing.cpb_removal_time;
1791     }
1792
1793     return 0;
1794 fail:
1795     x264_log( h, X264_LOG_ERROR, "ratecontrol_end: stats file could not be written to\n" );
1796     return -1;
1797 }
1798
1799 /****************************************************************************
1800  * 2 pass functions
1801  ***************************************************************************/
1802
1803 /**
1804  * modify the bitrate curve from pass1 for one frame
1805  */
1806 static double get_qscale(x264_t *h, ratecontrol_entry_t *rce, double rate_factor, int frame_num)
1807 {
1808     x264_ratecontrol_t *rcc= h->rc;
1809     x264_zone_t *zone = get_zone( h, frame_num );
1810     double q;
1811     if( h->param.rc.b_mb_tree )
1812     {
1813         double timescale = (double)h->sps->vui.i_num_units_in_tick / h->sps->vui.i_time_scale;
1814         q = pow( BASE_FRAME_DURATION / CLIP_DURATION(rce->i_duration * timescale), 1 - h->param.rc.f_qcompress );
1815     }
1816     else
1817         q = pow( rce->blurred_complexity, 1 - rcc->qcompress );
1818
1819     // avoid NaN's in the rc_eq
1820     if( !isfinite(q) || rce->tex_bits + rce->mv_bits == 0 )
1821         q = rcc->last_qscale_for[rce->pict_type];
1822     else
1823     {
1824         rcc->last_rceq = q;
1825         q /= rate_factor;
1826         rcc->last_qscale = q;
1827     }
1828
1829     if( zone )
1830     {
1831         if( zone->b_force_qp )
1832             q = qp2qscale( zone->i_qp );
1833         else
1834             q /= zone->f_bitrate_factor;
1835     }
1836
1837     return q;
1838 }
1839
1840 static double get_diff_limited_q(x264_t *h, ratecontrol_entry_t *rce, double q, int frame_num)
1841 {
1842     x264_ratecontrol_t *rcc = h->rc;
1843     const int pict_type = rce->pict_type;
1844     x264_zone_t *zone = get_zone( h, frame_num );
1845
1846     // force I/B quants as a function of P quants
1847     const double last_p_q    = rcc->last_qscale_for[SLICE_TYPE_P];
1848     const double last_non_b_q= rcc->last_qscale_for[rcc->last_non_b_pict_type];
1849     if( pict_type == SLICE_TYPE_I )
1850     {
1851         double iq = q;
1852         double pq = qp2qscale( rcc->accum_p_qp / rcc->accum_p_norm );
1853         double ip_factor = fabs( h->param.rc.f_ip_factor );
1854         /* don't apply ip_factor if the following frame is also I */
1855         if( rcc->accum_p_norm <= 0 )
1856             q = iq;
1857         else if( h->param.rc.f_ip_factor < 0 )
1858             q = iq / ip_factor;
1859         else if( rcc->accum_p_norm >= 1 )
1860             q = pq / ip_factor;
1861         else
1862             q = rcc->accum_p_norm * pq / ip_factor + (1 - rcc->accum_p_norm) * iq;
1863     }
1864     else if( pict_type == SLICE_TYPE_B )
1865     {
1866         if( h->param.rc.f_pb_factor > 0 )
1867             q = last_non_b_q;
1868         if( !rce->kept_as_ref )
1869             q *= fabs( h->param.rc.f_pb_factor );
1870     }
1871     else if( pict_type == SLICE_TYPE_P
1872              && rcc->last_non_b_pict_type == SLICE_TYPE_P
1873              && rce->tex_bits == 0 )
1874     {
1875         q = last_p_q;
1876     }
1877
1878     /* last qscale / qdiff stuff */
1879     if( rcc->last_non_b_pict_type == pict_type &&
1880         (pict_type!=SLICE_TYPE_I || rcc->last_accum_p_norm < 1) )
1881     {
1882         double last_q = rcc->last_qscale_for[pict_type];
1883         double max_qscale = last_q * rcc->lstep;
1884         double min_qscale = last_q / rcc->lstep;
1885
1886         if     ( q > max_qscale ) q = max_qscale;
1887         else if( q < min_qscale ) q = min_qscale;
1888     }
1889
1890     rcc->last_qscale_for[pict_type] = q;
1891     if( pict_type != SLICE_TYPE_B )
1892         rcc->last_non_b_pict_type = pict_type;
1893     if( pict_type == SLICE_TYPE_I )
1894     {
1895         rcc->last_accum_p_norm = rcc->accum_p_norm;
1896         rcc->accum_p_norm = 0;
1897         rcc->accum_p_qp = 0;
1898     }
1899     if( pict_type == SLICE_TYPE_P )
1900     {
1901         float mask = 1 - pow( (float)rce->i_count / rcc->nmb, 2 );
1902         rcc->accum_p_qp   = mask * (qscale2qp( q ) + rcc->accum_p_qp);
1903         rcc->accum_p_norm = mask * (1 + rcc->accum_p_norm);
1904     }
1905
1906     if( zone )
1907     {
1908         if( zone->b_force_qp )
1909             q = qp2qscale( zone->i_qp );
1910         else
1911             q /= zone->f_bitrate_factor;
1912     }
1913
1914     return q;
1915 }
1916
1917 static float predict_size( predictor_t *p, float q, float var )
1918 {
1919     return (p->coeff*var + p->offset) / (q*p->count);
1920 }
1921
1922 static void update_predictor( predictor_t *p, float q, float var, float bits )
1923 {
1924     float range = 1.5;
1925     if( var < 10 )
1926         return;
1927     float old_coeff = p->coeff / p->count;
1928     float new_coeff = X264_MAX( bits*q / var, p->coeff_min );
1929     float new_coeff_clipped = x264_clip3f( new_coeff, old_coeff/range, old_coeff*range );
1930     float new_offset = bits*q - new_coeff_clipped * var;
1931     if( new_offset >= 0 )
1932         new_coeff = new_coeff_clipped;
1933     else
1934         new_offset = 0;
1935     p->count  *= p->decay;
1936     p->coeff  *= p->decay;
1937     p->offset *= p->decay;
1938     p->count  ++;
1939     p->coeff  += new_coeff;
1940     p->offset += new_offset;
1941 }
1942
1943 // update VBV after encoding a frame
1944 static int update_vbv( x264_t *h, int bits )
1945 {
1946     int filler = 0;
1947     int bitrate = h->sps->vui.hrd.i_bit_rate_unscaled;
1948     x264_ratecontrol_t *rcc = h->rc;
1949     x264_ratecontrol_t *rct = h->thread[0]->rc;
1950     uint64_t buffer_size = (uint64_t)h->sps->vui.hrd.i_cpb_size_unscaled * h->sps->vui.i_time_scale;
1951
1952     if( rcc->last_satd >= h->mb.i_mb_count )
1953         update_predictor( &rct->pred[h->sh.i_type], qp2qscale( rcc->qpa_rc ), rcc->last_satd, bits );
1954
1955     if( !rcc->b_vbv )
1956         return filler;
1957
1958     rct->buffer_fill_final -= (uint64_t)bits * h->sps->vui.i_time_scale;
1959
1960     if( rct->buffer_fill_final < 0 )
1961         x264_log( h, X264_LOG_WARNING, "VBV underflow (frame %d, %.0f bits)\n", h->i_frame, (double)rct->buffer_fill_final / h->sps->vui.i_time_scale );
1962     rct->buffer_fill_final = X264_MAX( rct->buffer_fill_final, 0 );
1963     rct->buffer_fill_final += (uint64_t)bitrate * h->sps->vui.i_num_units_in_tick * h->fenc->i_cpb_duration;
1964
1965     if( h->sps->vui.hrd.b_cbr_hrd && rct->buffer_fill_final > buffer_size )
1966     {
1967         int64_t scale = (int64_t)h->sps->vui.i_time_scale * 8;
1968         filler = (rct->buffer_fill_final - buffer_size + scale - 1) / scale;
1969         bits = X264_MAX( (FILLER_OVERHEAD - h->param.b_annexb), filler ) * 8;
1970         rct->buffer_fill_final -= (uint64_t)bits * h->sps->vui.i_time_scale;
1971     }
1972     else
1973         rct->buffer_fill_final = X264_MIN( rct->buffer_fill_final, buffer_size );
1974
1975     return filler;
1976 }
1977
1978 void x264_hrd_fullness( x264_t *h )
1979 {
1980     x264_ratecontrol_t *rct = h->thread[0]->rc;
1981     uint64_t denom = (uint64_t)h->sps->vui.hrd.i_bit_rate_unscaled * h->sps->vui.i_time_scale / rct->hrd_multiply_denom;
1982     uint64_t cpb_state = rct->buffer_fill_final;
1983     uint64_t cpb_size = (uint64_t)h->sps->vui.hrd.i_cpb_size_unscaled * h->sps->vui.i_time_scale;
1984     uint64_t multiply_factor = 180000 / rct->hrd_multiply_denom;
1985
1986     if( rct->buffer_fill_final < 0 || rct->buffer_fill_final > cpb_size )
1987     {
1988          x264_log( h, X264_LOG_WARNING, "CPB %s: %.0lf bits in a %.0lf-bit buffer\n",
1989                    rct->buffer_fill_final < 0 ? "underflow" : "overflow", (float)rct->buffer_fill_final/denom, (float)cpb_size/denom );
1990     }
1991
1992     h->initial_cpb_removal_delay = (multiply_factor * cpb_state + denom) / (2*denom);
1993     h->initial_cpb_removal_delay_offset = (multiply_factor * cpb_size + denom) / (2*denom) - h->initial_cpb_removal_delay;
1994 }
1995
1996 // provisionally update VBV according to the planned size of all frames currently in progress
1997 static void update_vbv_plan( x264_t *h, int overhead )
1998 {
1999     x264_ratecontrol_t *rcc = h->rc;
2000     rcc->buffer_fill = h->thread[0]->rc->buffer_fill_final / h->sps->vui.i_time_scale;
2001     if( h->i_thread_frames > 1 )
2002     {
2003         int j = h->rc - h->thread[0]->rc;
2004         for( int i = 1; i < h->i_thread_frames; i++ )
2005         {
2006             x264_t *t = h->thread[ (j+i)%h->i_thread_frames ];
2007             double bits = t->rc->frame_size_planned;
2008             if( !t->b_thread_active )
2009                 continue;
2010             bits = X264_MAX(bits, t->rc->frame_size_estimated);
2011             rcc->buffer_fill -= bits;
2012             rcc->buffer_fill = X264_MAX( rcc->buffer_fill, 0 );
2013             rcc->buffer_fill += t->rc->buffer_rate;
2014             rcc->buffer_fill = X264_MIN( rcc->buffer_fill, rcc->buffer_size );
2015         }
2016     }
2017     rcc->buffer_fill = X264_MIN( rcc->buffer_fill, rcc->buffer_size );
2018     rcc->buffer_fill -= overhead;
2019 }
2020
2021 // apply VBV constraints and clip qscale to between lmin and lmax
2022 static double clip_qscale( x264_t *h, int pict_type, double q )
2023 {
2024     x264_ratecontrol_t *rcc = h->rc;
2025     double lmin = rcc->lmin[pict_type];
2026     double lmax = rcc->lmax[pict_type];
2027     if( rcc->rate_factor_max_increment )
2028         lmax = X264_MIN( lmax, qp2qscale( rcc->qp_novbv + rcc->rate_factor_max_increment ) );
2029     double q0 = q;
2030
2031     /* B-frames are not directly subject to VBV,
2032      * since they are controlled by the P-frames' QPs. */
2033
2034     if( rcc->b_vbv && rcc->last_satd > 0 )
2035     {
2036         /* Lookahead VBV: raise the quantizer as necessary such that no frames in
2037          * the lookahead overflow and such that the buffer is in a reasonable state
2038          * by the end of the lookahead. */
2039         if( h->param.rc.i_lookahead )
2040         {
2041             int terminate = 0;
2042
2043             /* Avoid an infinite loop. */
2044             for( int iterations = 0; iterations < 1000 && terminate != 3; iterations++ )
2045             {
2046                 double frame_q[3];
2047                 double cur_bits = predict_size( &rcc->pred[h->sh.i_type], q, rcc->last_satd );
2048                 double buffer_fill_cur = rcc->buffer_fill - cur_bits;
2049                 double target_fill;
2050                 double total_duration = 0;
2051                 frame_q[0] = h->sh.i_type == SLICE_TYPE_I ? q * h->param.rc.f_ip_factor : q;
2052                 frame_q[1] = frame_q[0] * h->param.rc.f_pb_factor;
2053                 frame_q[2] = frame_q[0] / h->param.rc.f_ip_factor;
2054
2055                 /* Loop over the planned future frames. */
2056                 for( int j = 0; buffer_fill_cur >= 0 && buffer_fill_cur <= rcc->buffer_size; j++ )
2057                 {
2058                     total_duration += h->fenc->f_planned_cpb_duration[j];
2059                     buffer_fill_cur += rcc->vbv_max_rate * h->fenc->f_planned_cpb_duration[j];
2060                     int i_type = h->fenc->i_planned_type[j];
2061                     int i_satd = h->fenc->i_planned_satd[j];
2062                     if( i_type == X264_TYPE_AUTO )
2063                         break;
2064                     i_type = IS_X264_TYPE_I( i_type ) ? SLICE_TYPE_I : IS_X264_TYPE_B( i_type ) ? SLICE_TYPE_B : SLICE_TYPE_P;
2065                     cur_bits = predict_size( &rcc->pred[i_type], frame_q[i_type], i_satd );
2066                     buffer_fill_cur -= cur_bits;
2067                 }
2068                 /* Try to get to get the buffer at least 50% filled, but don't set an impossible goal. */
2069                 target_fill = X264_MIN( rcc->buffer_fill + total_duration * rcc->vbv_max_rate * 0.5, rcc->buffer_size * 0.5 );
2070                 if( buffer_fill_cur < target_fill )
2071                 {
2072                     q *= 1.01;
2073                     terminate |= 1;
2074                     continue;
2075                 }
2076                 /* Try to get the buffer no more than 80% filled, but don't set an impossible goal. */
2077                 target_fill = x264_clip3f( rcc->buffer_fill - total_duration * rcc->vbv_max_rate * 0.5, rcc->buffer_size * 0.8, rcc->buffer_size );
2078                 if( rcc->b_vbv_min_rate && buffer_fill_cur > target_fill )
2079                 {
2080                     q /= 1.01;
2081                     terminate |= 2;
2082                     continue;
2083                 }
2084                 break;
2085             }
2086         }
2087         /* Fallback to old purely-reactive algorithm: no lookahead. */
2088         else
2089         {
2090             if( ( pict_type == SLICE_TYPE_P ||
2091                 ( pict_type == SLICE_TYPE_I && rcc->last_non_b_pict_type == SLICE_TYPE_I ) ) &&
2092                 rcc->buffer_fill/rcc->buffer_size < 0.5 )
2093             {
2094                 q /= x264_clip3f( 2.0*rcc->buffer_fill/rcc->buffer_size, 0.5, 1.0 );
2095             }
2096
2097             /* Now a hard threshold to make sure the frame fits in VBV.
2098              * This one is mostly for I-frames. */
2099             double bits = predict_size( &rcc->pred[h->sh.i_type], q, rcc->last_satd );
2100             double qf = 1.0;
2101             /* For small VBVs, allow the frame to use up the entire VBV. */
2102             double max_fill_factor = h->param.rc.i_vbv_buffer_size >= 5*h->param.rc.i_vbv_max_bitrate / rcc->fps ? 2 : 1;
2103             /* For single-frame VBVs, request that the frame use up the entire VBV. */
2104             double min_fill_factor = rcc->single_frame_vbv ? 1 : 2;
2105
2106             if( bits > rcc->buffer_fill/max_fill_factor )
2107                 qf = x264_clip3f( rcc->buffer_fill/(max_fill_factor*bits), 0.2, 1.0 );
2108             q /= qf;
2109             bits *= qf;
2110             if( bits < rcc->buffer_rate/min_fill_factor )
2111                 q *= bits*min_fill_factor/rcc->buffer_rate;
2112             q = X264_MAX( q0, q );
2113         }
2114
2115         /* Apply MinCR restrictions */
2116         double bits = predict_size( &rcc->pred[h->sh.i_type], q, rcc->last_satd );
2117         if( bits > rcc->frame_size_maximum )
2118             q *= bits / rcc->frame_size_maximum;
2119         bits = predict_size( &rcc->pred[h->sh.i_type], q, rcc->last_satd );
2120
2121         /* Check B-frame complexity, and use up any bits that would
2122          * overflow before the next P-frame. */
2123         if( h->sh.i_type == SLICE_TYPE_P && !rcc->single_frame_vbv )
2124         {
2125             int nb = rcc->bframes;
2126             double pbbits = bits;
2127             double bbits = predict_size( rcc->pred_b_from_p, q * h->param.rc.f_pb_factor, rcc->last_satd );
2128             double space;
2129             double bframe_cpb_duration = 0;
2130             double minigop_cpb_duration;
2131             for( int i = 0; i < nb; i++ )
2132                 bframe_cpb_duration += h->fenc->f_planned_cpb_duration[1+i];
2133
2134             if( bbits * nb > bframe_cpb_duration * rcc->vbv_max_rate )
2135                 nb = 0;
2136             pbbits += nb * bbits;
2137
2138             minigop_cpb_duration = bframe_cpb_duration + h->fenc->f_planned_cpb_duration[0];
2139             space = rcc->buffer_fill + minigop_cpb_duration*rcc->vbv_max_rate - rcc->buffer_size;
2140             if( pbbits < space )
2141             {
2142                 q *= X264_MAX( pbbits / space, bits / (0.5 * rcc->buffer_size) );
2143             }
2144             q = X264_MAX( q0/2, q );
2145         }
2146
2147         if( !rcc->b_vbv_min_rate )
2148             q = X264_MAX( q0, q );
2149     }
2150
2151     if( lmin==lmax )
2152         return lmin;
2153     else if( rcc->b_2pass )
2154     {
2155         double min2 = log( lmin );
2156         double max2 = log( lmax );
2157         q = (log(q) - min2)/(max2-min2) - 0.5;
2158         q = 1.0/(1.0 + exp( -4*q ));
2159         q = q*(max2-min2) + min2;
2160         return exp( q );
2161     }
2162     else
2163         return x264_clip3f( q, lmin, lmax );
2164 }
2165
2166 // update qscale for 1 frame based on actual bits used so far
2167 static float rate_estimate_qscale( x264_t *h )
2168 {
2169     float q;
2170     x264_ratecontrol_t *rcc = h->rc;
2171     ratecontrol_entry_t UNINIT(rce);
2172     int pict_type = h->sh.i_type;
2173     int64_t total_bits = 8*(h->stat.i_frame_size[SLICE_TYPE_I]
2174                           + h->stat.i_frame_size[SLICE_TYPE_P]
2175                           + h->stat.i_frame_size[SLICE_TYPE_B])
2176                        - rcc->filler_bits_sum;
2177
2178     if( rcc->b_2pass )
2179     {
2180         rce = *rcc->rce;
2181         if( pict_type != rce.pict_type )
2182         {
2183             x264_log( h, X264_LOG_ERROR, "slice=%c but 2pass stats say %c\n",
2184                       slice_type_to_char[pict_type], slice_type_to_char[rce.pict_type] );
2185         }
2186     }
2187
2188     if( pict_type == SLICE_TYPE_B )
2189     {
2190         /* B-frames don't have independent ratecontrol, but rather get the
2191          * average QP of the two adjacent P-frames + an offset */
2192
2193         int i0 = IS_X264_TYPE_I(h->fref_nearest[0]->i_type);
2194         int i1 = IS_X264_TYPE_I(h->fref_nearest[1]->i_type);
2195         int dt0 = abs(h->fenc->i_poc - h->fref_nearest[0]->i_poc);
2196         int dt1 = abs(h->fenc->i_poc - h->fref_nearest[1]->i_poc);
2197         float q0 = h->fref_nearest[0]->f_qp_avg_rc;
2198         float q1 = h->fref_nearest[1]->f_qp_avg_rc;
2199
2200         if( h->fref_nearest[0]->i_type == X264_TYPE_BREF )
2201             q0 -= rcc->pb_offset/2;
2202         if( h->fref_nearest[1]->i_type == X264_TYPE_BREF )
2203             q1 -= rcc->pb_offset/2;
2204
2205         if( i0 && i1 )
2206             q = (q0 + q1) / 2 + rcc->ip_offset;
2207         else if( i0 )
2208             q = q1;
2209         else if( i1 )
2210             q = q0;
2211         else
2212             q = (q0*dt1 + q1*dt0) / (dt0 + dt1);
2213
2214         if( h->fenc->b_kept_as_ref )
2215             q += rcc->pb_offset/2;
2216         else
2217             q += rcc->pb_offset;
2218
2219         if( rcc->b_2pass && rcc->b_vbv )
2220             rcc->frame_size_planned = qscale2bits( &rce, qp2qscale( q ) );
2221         else
2222             rcc->frame_size_planned = predict_size( rcc->pred_b_from_p, qp2qscale( q ), h->fref[1][h->i_ref[1]-1]->i_satd );
2223         /* Limit planned size by MinCR */
2224         if( rcc->b_vbv )
2225             rcc->frame_size_planned = X264_MIN( rcc->frame_size_planned, rcc->frame_size_maximum );
2226         h->rc->frame_size_estimated = rcc->frame_size_planned;
2227
2228         /* For row SATDs */
2229         if( rcc->b_vbv )
2230             rcc->last_satd = x264_rc_analyse_slice( h );
2231         rcc->qp_novbv = q;
2232         return qp2qscale( q );
2233     }
2234     else
2235     {
2236         double abr_buffer = 2 * rcc->rate_tolerance * rcc->bitrate;
2237
2238         if( rcc->b_2pass )
2239         {
2240             double lmin = rcc->lmin[pict_type];
2241             double lmax = rcc->lmax[pict_type];
2242             int64_t diff;
2243             int64_t predicted_bits = total_bits;
2244
2245             if( rcc->b_vbv )
2246             {
2247                 if( h->i_thread_frames > 1 )
2248                 {
2249                     int j = h->rc - h->thread[0]->rc;
2250                     for( int i = 1; i < h->i_thread_frames; i++ )
2251                     {
2252                         x264_t *t = h->thread[ (j+i)%h->i_thread_frames ];
2253                         double bits = t->rc->frame_size_planned;
2254                         if( !t->b_thread_active )
2255                             continue;
2256                         bits = X264_MAX(bits, t->rc->frame_size_estimated);
2257                         predicted_bits += (int64_t)bits;
2258                     }
2259                 }
2260             }
2261             else
2262             {
2263                 if( h->i_frame < h->i_thread_frames )
2264                     predicted_bits += (int64_t)h->i_frame * rcc->bitrate / rcc->fps;
2265                 else
2266                     predicted_bits += (int64_t)(h->i_thread_frames - 1) * rcc->bitrate / rcc->fps;
2267             }
2268
2269             /* Adjust ABR buffer based on distance to the end of the video. */
2270             if( rcc->num_entries > h->i_frame )
2271             {
2272                 double final_bits = rcc->entry[rcc->num_entries-1].expected_bits;
2273                 double video_pos = rce.expected_bits / final_bits;
2274                 double scale_factor = sqrt( (1 - video_pos) * rcc->num_entries );
2275                 abr_buffer *= 0.5 * X264_MAX( scale_factor, 0.5 );
2276             }
2277
2278             diff = predicted_bits - (int64_t)rce.expected_bits;
2279             q = rce.new_qscale;
2280             q /= x264_clip3f((double)(abr_buffer - diff) / abr_buffer, .5, 2);
2281             if( ((h->i_frame + 1 - h->i_thread_frames) >= rcc->fps) &&
2282                 (rcc->expected_bits_sum > 0))
2283             {
2284                 /* Adjust quant based on the difference between
2285                  * achieved and expected bitrate so far */
2286                 double cur_time = (double)h->i_frame / rcc->num_entries;
2287                 double w = x264_clip3f( cur_time*100, 0.0, 1.0 );
2288                 q *= pow( (double)total_bits / rcc->expected_bits_sum, w );
2289             }
2290             if( rcc->b_vbv )
2291             {
2292                 /* Do not overflow vbv */
2293                 double expected_size = qscale2bits( &rce, q );
2294                 double expected_vbv = rcc->buffer_fill + rcc->buffer_rate - expected_size;
2295                 double expected_fullness = rce.expected_vbv / rcc->buffer_size;
2296                 double qmax = q*(2 - expected_fullness);
2297                 double size_constraint = 1 + expected_fullness;
2298                 qmax = X264_MAX( qmax, rce.new_qscale );
2299                 if( expected_fullness < .05 )
2300                     qmax = lmax;
2301                 qmax = X264_MIN(qmax, lmax);
2302                 while( ((expected_vbv < rce.expected_vbv/size_constraint) && (q < qmax)) ||
2303                         ((expected_vbv < 0) && (q < lmax)))
2304                 {
2305                     q *= 1.05;
2306                     expected_size = qscale2bits(&rce, q);
2307                     expected_vbv = rcc->buffer_fill + rcc->buffer_rate - expected_size;
2308                 }
2309                 rcc->last_satd = x264_rc_analyse_slice( h );
2310             }
2311             q = x264_clip3f( q, lmin, lmax );
2312         }
2313         else /* 1pass ABR */
2314         {
2315             /* Calculate the quantizer which would have produced the desired
2316              * average bitrate if it had been applied to all frames so far.
2317              * Then modulate that quant based on the current frame's complexity
2318              * relative to the average complexity so far (using the 2pass RCEQ).
2319              * Then bias the quant up or down if total size so far was far from
2320              * the target.
2321              * Result: Depending on the value of rate_tolerance, there is a
2322              * tradeoff between quality and bitrate precision. But at large
2323              * tolerances, the bit distribution approaches that of 2pass. */
2324
2325             double wanted_bits, overflow = 1;
2326
2327             rcc->last_satd = x264_rc_analyse_slice( h );
2328             rcc->short_term_cplxsum *= 0.5;
2329             rcc->short_term_cplxcount *= 0.5;
2330             rcc->short_term_cplxsum += rcc->last_satd / (CLIP_DURATION(h->fenc->f_duration) / BASE_FRAME_DURATION);
2331             rcc->short_term_cplxcount ++;
2332
2333             rce.tex_bits = rcc->last_satd;
2334             rce.blurred_complexity = rcc->short_term_cplxsum / rcc->short_term_cplxcount;
2335             rce.mv_bits = 0;
2336             rce.p_count = rcc->nmb;
2337             rce.i_count = 0;
2338             rce.s_count = 0;
2339             rce.qscale = 1;
2340             rce.pict_type = pict_type;
2341             rce.i_duration = h->fenc->i_duration;
2342
2343             if( h->param.rc.i_rc_method == X264_RC_CRF )
2344             {
2345                 q = get_qscale( h, &rce, rcc->rate_factor_constant, h->fenc->i_frame );
2346             }
2347             else
2348             {
2349                 q = get_qscale( h, &rce, rcc->wanted_bits_window / rcc->cplxr_sum, h->fenc->i_frame );
2350
2351                 /* ABR code can potentially be counterproductive in CBR, so just don't bother.
2352                  * Don't run it if the frame complexity is zero either. */
2353                 if( !rcc->b_vbv_min_rate && rcc->last_satd )
2354                 {
2355                     // FIXME is it simpler to keep track of wanted_bits in ratecontrol_end?
2356                     int i_frame_done = h->i_frame + 1 - h->i_thread_frames;
2357                     double time_done = i_frame_done / rcc->fps;
2358                     if( h->param.b_vfr_input && i_frame_done > 0 )
2359                         time_done = ((double)(h->fenc->i_reordered_pts - h->i_reordered_pts_delay)) * h->param.i_timebase_num / h->param.i_timebase_den;
2360                     wanted_bits = time_done * rcc->bitrate;
2361                     if( wanted_bits > 0 )
2362                     {
2363                         abr_buffer *= X264_MAX( 1, sqrt( time_done ) );
2364                         overflow = x264_clip3f( 1.0 + (total_bits - wanted_bits) / abr_buffer, .5, 2 );
2365                         q *= overflow;
2366                     }
2367                 }
2368             }
2369
2370             if( pict_type == SLICE_TYPE_I && h->param.i_keyint_max > 1
2371                 /* should test _next_ pict type, but that isn't decided yet */
2372                 && rcc->last_non_b_pict_type != SLICE_TYPE_I )
2373             {
2374                 q = qp2qscale( rcc->accum_p_qp / rcc->accum_p_norm );
2375                 q /= fabs( h->param.rc.f_ip_factor );
2376             }
2377             else if( h->i_frame > 0 )
2378             {
2379                 if( h->param.rc.i_rc_method != X264_RC_CRF )
2380                 {
2381                     /* Asymmetric clipping, because symmetric would prevent
2382                      * overflow control in areas of rapidly oscillating complexity */
2383                     double lmin = rcc->last_qscale_for[pict_type] / rcc->lstep;
2384                     double lmax = rcc->last_qscale_for[pict_type] * rcc->lstep;
2385                     if( overflow > 1.1 && h->i_frame > 3 )
2386                         lmax *= rcc->lstep;
2387                     else if( overflow < 0.9 )
2388                         lmin /= rcc->lstep;
2389
2390                     q = x264_clip3f(q, lmin, lmax);
2391                 }
2392             }
2393             else if( h->param.rc.i_rc_method == X264_RC_CRF && rcc->qcompress != 1 )
2394             {
2395                 q = qp2qscale( ABR_INIT_QP ) / fabs( h->param.rc.f_ip_factor );
2396             }
2397             rcc->qp_novbv = qscale2qp( q );
2398
2399             //FIXME use get_diff_limited_q() ?
2400             q = clip_qscale( h, pict_type, q );
2401         }
2402
2403         rcc->last_qscale_for[pict_type] =
2404         rcc->last_qscale = q;
2405
2406         if( !(rcc->b_2pass && !rcc->b_vbv) && h->fenc->i_frame == 0 )
2407             rcc->last_qscale_for[SLICE_TYPE_P] = q * fabs( h->param.rc.f_ip_factor );
2408
2409         if( rcc->b_2pass && rcc->b_vbv )
2410             rcc->frame_size_planned = qscale2bits(&rce, q);
2411         else
2412             rcc->frame_size_planned = predict_size( &rcc->pred[h->sh.i_type], q, rcc->last_satd );
2413
2414         /* Always use up the whole VBV in this case. */
2415         if( rcc->single_frame_vbv )
2416             rcc->frame_size_planned = rcc->buffer_rate;
2417         /* Limit planned size by MinCR */
2418         if( rcc->b_vbv )
2419             rcc->frame_size_planned = X264_MIN( rcc->frame_size_planned, rcc->frame_size_maximum );
2420         h->rc->frame_size_estimated = rcc->frame_size_planned;
2421         return q;
2422     }
2423 }
2424
2425 static void x264_threads_normalize_predictors( x264_t *h )
2426 {
2427     double totalsize = 0;
2428     for( int i = 0; i < h->param.i_threads; i++ )
2429         totalsize += h->thread[i]->rc->slice_size_planned;
2430     double factor = h->rc->frame_size_planned / totalsize;
2431     for( int i = 0; i < h->param.i_threads; i++ )
2432         h->thread[i]->rc->slice_size_planned *= factor;
2433 }
2434
2435 void x264_threads_distribute_ratecontrol( x264_t *h )
2436 {
2437     int row;
2438     x264_ratecontrol_t *rc = h->rc;
2439     x264_emms();
2440     float qscale = qp2qscale( rc->qpm );
2441
2442     /* Initialize row predictors */
2443     if( h->i_frame == 0 )
2444         for( int i = 0; i < h->param.i_threads; i++ )
2445         {
2446             x264_ratecontrol_t *t = h->thread[i]->rc;
2447             memcpy( t->row_preds, rc->row_preds, sizeof(rc->row_preds) );
2448         }
2449
2450     for( int i = 0; i < h->param.i_threads; i++ )
2451     {
2452         x264_t *t = h->thread[i];
2453         memcpy( t->rc, rc, offsetof(x264_ratecontrol_t, row_pred) );
2454         t->rc->row_pred = &t->rc->row_preds[h->sh.i_type];
2455         /* Calculate the planned slice size. */
2456         if( rc->b_vbv && rc->frame_size_planned )
2457         {
2458             int size = 0;
2459             for( row = t->i_threadslice_start; row < t->i_threadslice_end; row++ )
2460                 size += h->fdec->i_row_satd[row];
2461             t->rc->slice_size_planned = predict_size( &rc->pred[h->sh.i_type + (i+1)*5], qscale, size );
2462         }
2463         else
2464             t->rc->slice_size_planned = 0;
2465     }
2466     if( rc->b_vbv && rc->frame_size_planned )
2467     {
2468         x264_threads_normalize_predictors( h );
2469
2470         if( rc->single_frame_vbv )
2471         {
2472             /* Compensate for our max frame error threshold: give more bits (proportionally) to smaller slices. */
2473             for( int i = 0; i < h->param.i_threads; i++ )
2474             {
2475                 x264_t *t = h->thread[i];
2476                 float max_frame_error = X264_MAX( 0.05, 1.0 / (t->i_threadslice_end - t->i_threadslice_start) );
2477                 t->rc->slice_size_planned += 2 * max_frame_error * rc->frame_size_planned;
2478             }
2479             x264_threads_normalize_predictors( h );
2480         }
2481
2482         for( int i = 0; i < h->param.i_threads; i++ )
2483             h->thread[i]->rc->frame_size_estimated = h->thread[i]->rc->slice_size_planned;
2484     }
2485 }
2486
2487 void x264_threads_merge_ratecontrol( x264_t *h )
2488 {
2489     x264_ratecontrol_t *rc = h->rc;
2490     x264_emms();
2491
2492     for( int i = 0; i < h->param.i_threads; i++ )
2493     {
2494         x264_t *t = h->thread[i];
2495         x264_ratecontrol_t *rct = h->thread[i]->rc;
2496         if( h->param.rc.i_vbv_buffer_size )
2497         {
2498             int size = 0;
2499             for( int row = t->i_threadslice_start; row < t->i_threadslice_end; row++ )
2500                 size += h->fdec->i_row_satd[row];
2501             int bits = t->stat.frame.i_mv_bits + t->stat.frame.i_tex_bits + t->stat.frame.i_misc_bits;
2502             int mb_count = (t->i_threadslice_end - t->i_threadslice_start) * h->mb.i_mb_width;
2503             update_predictor( &rc->pred[h->sh.i_type+(i+1)*5], qp2qscale( rct->qpa_rc/mb_count ), size, bits );
2504         }
2505         if( !i )
2506             continue;
2507         rc->qpa_rc += rct->qpa_rc;
2508         rc->qpa_aq += rct->qpa_aq;
2509     }
2510 }
2511
2512 void x264_thread_sync_ratecontrol( x264_t *cur, x264_t *prev, x264_t *next )
2513 {
2514     if( cur != prev )
2515     {
2516 #define COPY(var) memcpy(&cur->rc->var, &prev->rc->var, sizeof(cur->rc->var))
2517         /* these vars are updated in x264_ratecontrol_start()
2518          * so copy them from the context that most recently started (prev)
2519          * to the context that's about to start (cur). */
2520         COPY(accum_p_qp);
2521         COPY(accum_p_norm);
2522         COPY(last_satd);
2523         COPY(last_rceq);
2524         COPY(last_qscale_for);
2525         COPY(last_non_b_pict_type);
2526         COPY(short_term_cplxsum);
2527         COPY(short_term_cplxcount);
2528         COPY(bframes);
2529         COPY(prev_zone);
2530         COPY(qpbuf_pos);
2531         /* these vars can be updated by x264_ratecontrol_init_reconfigurable */
2532         COPY(bitrate);
2533         COPY(buffer_size);
2534         COPY(buffer_rate);
2535         COPY(vbv_max_rate);
2536         COPY(single_frame_vbv);
2537         COPY(cbr_decay);
2538         COPY(rate_factor_constant);
2539         COPY(rate_factor_max_increment);
2540 #undef COPY
2541     }
2542     if( cur != next )
2543     {
2544 #define COPY(var) next->rc->var = cur->rc->var
2545         /* these vars are updated in x264_ratecontrol_end()
2546          * so copy them from the context that most recently ended (cur)
2547          * to the context that's about to end (next) */
2548         COPY(cplxr_sum);
2549         COPY(expected_bits_sum);
2550         COPY(filler_bits_sum);
2551         COPY(wanted_bits_window);
2552         COPY(bframe_bits);
2553         COPY(initial_cpb_removal_delay);
2554         COPY(initial_cpb_removal_delay_offset);
2555         COPY(nrt_first_access_unit);
2556         COPY(previous_cpb_final_arrival_time);
2557 #undef COPY
2558     }
2559     //FIXME row_preds[] (not strictly necessary, but would improve prediction)
2560     /* the rest of the variables are either constant or thread-local */
2561 }
2562
2563 static int find_underflow( x264_t *h, double *fills, int *t0, int *t1, int over )
2564 {
2565     /* find an interval ending on an overflow or underflow (depending on whether
2566      * we're adding or removing bits), and starting on the earliest frame that
2567      * can influence the buffer fill of that end frame. */
2568     x264_ratecontrol_t *rcc = h->rc;
2569     const double buffer_min = (over ? .1 : .1) * rcc->buffer_size;
2570     const double buffer_max = .9 * rcc->buffer_size;
2571     double fill = fills[*t0-1];
2572     double parity = over ? 1. : -1.;
2573     int start = -1, end = -1;
2574     for( int i = *t0; i < rcc->num_entries; i++ )
2575     {
2576         fill += (rcc->entry[i].i_cpb_duration * rcc->vbv_max_rate * h->sps->vui.i_num_units_in_tick / h->sps->vui.i_time_scale -
2577                  qscale2bits( &rcc->entry[i], rcc->entry[i].new_qscale )) * parity;
2578         fill = x264_clip3f(fill, 0, rcc->buffer_size);
2579         fills[i] = fill;
2580         if( fill <= buffer_min || i == 0 )
2581         {
2582             if( end >= 0 )
2583                 break;
2584             start = i;
2585         }
2586         else if( fill >= buffer_max && start >= 0 )
2587             end = i;
2588     }
2589     *t0 = start;
2590     *t1 = end;
2591     return start >= 0 && end >= 0;
2592 }
2593
2594 static int fix_underflow( x264_t *h, int t0, int t1, double adjustment, double qscale_min, double qscale_max)
2595 {
2596     x264_ratecontrol_t *rcc = h->rc;
2597     double qscale_orig, qscale_new;
2598     int adjusted = 0;
2599     if( t0 > 0 )
2600         t0++;
2601     for( int i = t0; i <= t1; i++ )
2602     {
2603         qscale_orig = rcc->entry[i].new_qscale;
2604         qscale_orig = x264_clip3f( qscale_orig, qscale_min, qscale_max );
2605         qscale_new  = qscale_orig * adjustment;
2606         qscale_new  = x264_clip3f( qscale_new, qscale_min, qscale_max );
2607         rcc->entry[i].new_qscale = qscale_new;
2608         adjusted = adjusted || (qscale_new != qscale_orig);
2609     }
2610     return adjusted;
2611 }
2612
2613 static double count_expected_bits( x264_t *h )
2614 {
2615     x264_ratecontrol_t *rcc = h->rc;
2616     double expected_bits = 0;
2617     for( int i = 0; i < rcc->num_entries; i++ )
2618     {
2619         ratecontrol_entry_t *rce = &rcc->entry[i];
2620         rce->expected_bits = expected_bits;
2621         expected_bits += qscale2bits( rce, rce->new_qscale );
2622     }
2623     return expected_bits;
2624 }
2625
2626 static int vbv_pass2( x264_t *h, double all_available_bits )
2627 {
2628     /* for each interval of buffer_full .. underflow, uniformly increase the qp of all
2629      * frames in the interval until either buffer is full at some intermediate frame or the
2630      * last frame in the interval no longer underflows.  Recompute intervals and repeat.
2631      * Then do the converse to put bits back into overflow areas until target size is met */
2632
2633     x264_ratecontrol_t *rcc = h->rc;
2634     double *fills;
2635     double expected_bits = 0;
2636     double adjustment;
2637     double prev_bits = 0;
2638     int t0, t1;
2639     double qscale_min = qp2qscale( h->param.rc.i_qp_min );
2640     double qscale_max = qp2qscale( h->param.rc.i_qp_max );
2641     int iterations = 0;
2642     int adj_min, adj_max;
2643     CHECKED_MALLOC( fills, (rcc->num_entries+1)*sizeof(double) );
2644
2645     fills++;
2646
2647     /* adjust overall stream size */
2648     do
2649     {
2650         iterations++;
2651         prev_bits = expected_bits;
2652
2653         if( expected_bits )
2654         {   /* not first iteration */
2655             adjustment = X264_MAX(X264_MIN(expected_bits / all_available_bits, 0.999), 0.9);
2656             fills[-1] = rcc->buffer_size * h->param.rc.f_vbv_buffer_init;
2657             t0 = 0;
2658             /* fix overflows */
2659             adj_min = 1;
2660             while(adj_min && find_underflow( h, fills, &t0, &t1, 1 ))
2661             {
2662                 adj_min = fix_underflow( h, t0, t1, adjustment, qscale_min, qscale_max );
2663                 t0 = t1;
2664             }
2665         }
2666
2667         fills[-1] = rcc->buffer_size * (1. - h->param.rc.f_vbv_buffer_init);
2668         t0 = 0;
2669         /* fix underflows -- should be done after overflow, as we'd better undersize target than underflowing VBV */
2670         adj_max = 1;
2671         while( adj_max && find_underflow( h, fills, &t0, &t1, 0 ) )
2672             adj_max = fix_underflow( h, t0, t1, 1.001, qscale_min, qscale_max );
2673
2674         expected_bits = count_expected_bits( h );
2675     } while( (expected_bits < .995*all_available_bits) && ((int64_t)(expected_bits+.5) > (int64_t)(prev_bits+.5)) );
2676
2677     if( !adj_max )
2678         x264_log( h, X264_LOG_WARNING, "vbv-maxrate issue, qpmax or vbv-maxrate too low\n");
2679
2680     /* store expected vbv filling values for tracking when encoding */
2681     for( int i = 0; i < rcc->num_entries; i++ )
2682         rcc->entry[i].expected_vbv = rcc->buffer_size - fills[i];
2683
2684     x264_free( fills-1 );
2685     return 0;
2686 fail:
2687     return -1;
2688 }
2689
2690 static int init_pass2( x264_t *h )
2691 {
2692     x264_ratecontrol_t *rcc = h->rc;
2693     uint64_t all_const_bits = 0;
2694     double timescale = (double)h->sps->vui.i_num_units_in_tick / h->sps->vui.i_time_scale;
2695     double duration = 0;
2696     for( int i = 0; i < rcc->num_entries; i++ )
2697         duration += rcc->entry[i].i_duration;
2698     duration *= timescale;
2699     uint64_t all_available_bits = h->param.rc.i_bitrate * 1000. * duration;
2700     double rate_factor, step_mult;
2701     double qblur = h->param.rc.f_qblur;
2702     double cplxblur = h->param.rc.f_complexity_blur;
2703     const int filter_size = (int)(qblur*4) | 1;
2704     double expected_bits;
2705     double *qscale, *blurred_qscale;
2706     double base_cplx = h->mb.i_mb_count * (h->param.i_bframe ? 120 : 80);
2707
2708     /* find total/average complexity & const_bits */
2709     for( int i = 0; i < rcc->num_entries; i++ )
2710     {
2711         ratecontrol_entry_t *rce = &rcc->entry[i];
2712         all_const_bits += rce->misc_bits;
2713     }
2714
2715     if( all_available_bits < all_const_bits)
2716     {
2717         x264_log( h, X264_LOG_ERROR, "requested bitrate is too low. estimated minimum is %d kbps\n",
2718                  (int)(all_const_bits * rcc->fps / (rcc->num_entries * 1000.)) );
2719         return -1;
2720     }
2721
2722     /* Blur complexities, to reduce local fluctuation of QP.
2723      * We don't blur the QPs directly, because then one very simple frame
2724      * could drag down the QP of a nearby complex frame and give it more
2725      * bits than intended. */
2726     for( int i = 0; i < rcc->num_entries; i++ )
2727     {
2728         ratecontrol_entry_t *rce = &rcc->entry[i];
2729         double weight_sum = 0;
2730         double cplx_sum = 0;
2731         double weight = 1.0;
2732         double gaussian_weight;
2733         /* weighted average of cplx of future frames */
2734         for( int j = 1; j < cplxblur*2 && j < rcc->num_entries-i; j++ )
2735         {
2736             ratecontrol_entry_t *rcj = &rcc->entry[i+j];
2737             double frame_duration = CLIP_DURATION(rcj->i_duration * timescale) / BASE_FRAME_DURATION;
2738             weight *= 1 - pow( (float)rcj->i_count / rcc->nmb, 2 );
2739             if( weight < .0001 )
2740                 break;
2741             gaussian_weight = weight * exp( -j*j/200.0 );
2742             weight_sum += gaussian_weight;
2743             cplx_sum += gaussian_weight * (qscale2bits( rcj, 1 ) - rcj->misc_bits) / frame_duration;
2744         }
2745         /* weighted average of cplx of past frames */
2746         weight = 1.0;
2747         for( int j = 0; j <= cplxblur*2 && j <= i; j++ )
2748         {
2749             ratecontrol_entry_t *rcj = &rcc->entry[i-j];
2750             double frame_duration = CLIP_DURATION(rcj->i_duration * timescale) / BASE_FRAME_DURATION;
2751             gaussian_weight = weight * exp( -j*j/200.0 );
2752             weight_sum += gaussian_weight;
2753             cplx_sum += gaussian_weight * (qscale2bits( rcj, 1 ) - rcj->misc_bits) / frame_duration;
2754             weight *= 1 - pow( (float)rcj->i_count / rcc->nmb, 2 );
2755             if( weight < .0001 )
2756                 break;
2757         }
2758         rce->blurred_complexity = cplx_sum / weight_sum;
2759     }
2760
2761     CHECKED_MALLOC( qscale, sizeof(double)*rcc->num_entries );
2762     if( filter_size > 1 )
2763         CHECKED_MALLOC( blurred_qscale, sizeof(double)*rcc->num_entries );
2764     else
2765         blurred_qscale = qscale;
2766
2767     /* Search for a factor which, when multiplied by the RCEQ values from
2768      * each frame, adds up to the desired total size.
2769      * There is no exact closed-form solution because of VBV constraints and
2770      * because qscale2bits is not invertible, but we can start with the simple
2771      * approximation of scaling the 1st pass by the ratio of bitrates.
2772      * The search range is probably overkill, but speed doesn't matter here. */
2773
2774     expected_bits = 1;
2775     for( int i = 0; i < rcc->num_entries; i++ )
2776     {
2777         double q = get_qscale(h, &rcc->entry[i], 1.0, i);
2778         expected_bits += qscale2bits(&rcc->entry[i], q);
2779         rcc->last_qscale_for[rcc->entry[i].pict_type] = q;
2780     }
2781     step_mult = all_available_bits / expected_bits;
2782
2783     rate_factor = 0;
2784     for( double step = 1E4 * step_mult; step > 1E-7 * step_mult; step *= 0.5)
2785     {
2786         expected_bits = 0;
2787         rate_factor += step;
2788
2789         rcc->last_non_b_pict_type = -1;
2790         rcc->last_accum_p_norm = 1;
2791         rcc->accum_p_norm = 0;
2792
2793         rcc->last_qscale_for[0] =
2794         rcc->last_qscale_for[1] =
2795         rcc->last_qscale_for[2] = pow( base_cplx, 1 - rcc->qcompress ) / rate_factor;
2796
2797         /* find qscale */
2798         for( int i = 0; i < rcc->num_entries; i++ )
2799         {
2800             qscale[i] = get_qscale( h, &rcc->entry[i], rate_factor, -1 );
2801             rcc->last_qscale_for[rcc->entry[i].pict_type] = qscale[i];
2802         }
2803
2804         /* fixed I/B qscale relative to P */
2805         for( int i = rcc->num_entries-1; i >= 0; i-- )
2806         {
2807             qscale[i] = get_diff_limited_q( h, &rcc->entry[i], qscale[i], i );
2808             assert(qscale[i] >= 0);
2809         }
2810
2811         /* smooth curve */
2812         if( filter_size > 1 )
2813         {
2814             assert( filter_size%2 == 1 );
2815             for( int i = 0; i < rcc->num_entries; i++ )
2816             {
2817                 ratecontrol_entry_t *rce = &rcc->entry[i];
2818                 double q = 0.0, sum = 0.0;
2819
2820                 for( int j = 0; j < filter_size; j++ )
2821                 {
2822                     int idx = i+j-filter_size/2;
2823                     double d = idx-i;
2824                     double coeff = qblur==0 ? 1.0 : exp( -d*d/(qblur*qblur) );
2825                     if( idx < 0 || idx >= rcc->num_entries )
2826                         continue;
2827                     if( rce->pict_type != rcc->entry[idx].pict_type )
2828                         continue;
2829                     q += qscale[idx] * coeff;
2830                     sum += coeff;
2831                 }
2832                 blurred_qscale[i] = q/sum;
2833             }
2834         }
2835
2836         /* find expected bits */
2837         for( int i = 0; i < rcc->num_entries; i++ )
2838         {
2839             ratecontrol_entry_t *rce = &rcc->entry[i];
2840             rce->new_qscale = clip_qscale( h, rce->pict_type, blurred_qscale[i] );
2841             assert(rce->new_qscale >= 0);
2842             expected_bits += qscale2bits( rce, rce->new_qscale );
2843         }
2844
2845         if( expected_bits > all_available_bits )
2846             rate_factor -= step;
2847     }
2848
2849     x264_free( qscale );
2850     if( filter_size > 1 )
2851         x264_free( blurred_qscale );
2852
2853     if( rcc->b_vbv )
2854         if( vbv_pass2( h, all_available_bits ) )
2855             return -1;
2856     expected_bits = count_expected_bits( h );
2857
2858     if( fabs( expected_bits/all_available_bits - 1.0 ) > 0.01 )
2859     {
2860         double avgq = 0;
2861         for( int i = 0; i < rcc->num_entries; i++ )
2862             avgq += rcc->entry[i].new_qscale;
2863         avgq = qscale2qp( avgq / rcc->num_entries );
2864
2865         if( expected_bits > all_available_bits || !rcc->b_vbv )
2866             x264_log( h, X264_LOG_WARNING, "Error: 2pass curve failed to converge\n" );
2867         x264_log( h, X264_LOG_WARNING, "target: %.2f kbit/s, expected: %.2f kbit/s, avg QP: %.4f\n",
2868                   (float)h->param.rc.i_bitrate,
2869                   expected_bits * rcc->fps / (rcc->num_entries * 1000.),
2870                   avgq );
2871         if( expected_bits < all_available_bits && avgq < h->param.rc.i_qp_min + 2 )
2872         {
2873             if( h->param.rc.i_qp_min > 0 )
2874                 x264_log( h, X264_LOG_WARNING, "try reducing target bitrate or reducing qp_min (currently %d)\n", h->param.rc.i_qp_min );
2875             else
2876                 x264_log( h, X264_LOG_WARNING, "try reducing target bitrate\n" );
2877         }
2878         else if( expected_bits > all_available_bits && avgq > h->param.rc.i_qp_max - 2 )
2879         {
2880             if( h->param.rc.i_qp_max < QP_MAX )
2881                 x264_log( h, X264_LOG_WARNING, "try increasing target bitrate or increasing qp_max (currently %d)\n", h->param.rc.i_qp_max );
2882             else
2883                 x264_log( h, X264_LOG_WARNING, "try increasing target bitrate\n");
2884         }
2885         else if( !(rcc->b_2pass && rcc->b_vbv) )
2886             x264_log( h, X264_LOG_WARNING, "internal error\n" );
2887     }
2888
2889     return 0;
2890 fail:
2891     return -1;
2892 }