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

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