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