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