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