]> git.sesse.net Git - x264/blob - encoder/ratecontrol.c
b0ee384a5f16cf016460a7f10b9fb45155da1c27
[x264] / encoder / ratecontrol.c
1 /***************************************************-*- coding: iso-8859-1 -*-
2  * ratecontrol.c: h264 encoder library (Rate Control)
3  *****************************************************************************
4  * Copyright (C) 2005-2008 x264 project
5  *
6  * Authors: Loren Merritt <lorenm@u.washington.edu>
7  *          Michael Niedermayer <michaelni@gmx.at>
8  *          Gabriel Bouvigne <gabriel.bouvigne@joost.com>
9  *          Fiona Glaser <fiona@x264.com>
10  *          Måns Rullgård <mru@mru.ath.cx>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
25  *****************************************************************************/
26
27 #define _ISOC99_SOURCE
28 #undef NDEBUG // always check asserts, the speed effect is far too small to disable them
29 #include <math.h>
30 #include <limits.h>
31 #include <assert.h>
32
33 #include "common/common.h"
34 #include "common/cpu.h"
35 #include "ratecontrol.h"
36
37 typedef struct
38 {
39     int pict_type;
40     int kept_as_ref;
41     float qscale;
42     int mv_bits;
43     int tex_bits;
44     int misc_bits;
45     uint64_t expected_bits; /*total expected bits up to the current frame (current one excluded)*/
46     double expected_vbv;
47     float new_qscale;
48     int new_qp;
49     int i_count;
50     int p_count;
51     int s_count;
52     float blurred_complexity;
53     char direct_mode;
54 } ratecontrol_entry_t;
55
56 typedef struct
57 {
58     double coeff;
59     double count;
60     double decay;
61 } predictor_t;
62
63 struct x264_ratecontrol_t
64 {
65     /* constants */
66     int b_abr;
67     int b_2pass;
68     int b_vbv;
69     int b_vbv_min_rate;
70     double fps;
71     double bitrate;
72     double rate_tolerance;
73     int nmb;                    /* number of macroblocks in a frame */
74     int qp_constant[5];
75
76     /* current frame */
77     ratecontrol_entry_t *rce;
78     int qp;                     /* qp for current frame */
79     int qpm;                    /* qp for current macroblock */
80     float f_qpm;                /* qp for current macroblock: precise float for AQ */
81     float qpa_rc;               /* average of macroblocks' qp before aq */
82     float qpa_aq;               /* average of macroblocks' qp after aq */
83     int qp_force;
84
85     /* VBV stuff */
86     double buffer_size;
87     double buffer_fill_final;   /* real buffer as of the last finished frame */
88     double buffer_fill;         /* planned buffer, if all in-progress frames hit their bit budget */
89     double buffer_rate;         /* # of bits added to buffer_fill after each frame */
90     predictor_t *pred;          /* predict frame size from satd */
91
92     /* ABR stuff */
93     int    last_satd;
94     double last_rceq;
95     double cplxr_sum;           /* sum of bits*qscale/rceq */
96     double expected_bits_sum;   /* sum of qscale2bits after rceq, ratefactor, and overflow, only includes finished frames */
97     double wanted_bits_window;  /* target bitrate * window */
98     double cbr_decay;
99     double short_term_cplxsum;
100     double short_term_cplxcount;
101     double rate_factor_constant;
102     double ip_offset;
103     double pb_offset;
104
105     /* 2pass stuff */
106     FILE *p_stat_file_out;
107     char *psz_stat_file_tmpname;
108
109     int num_entries;            /* number of ratecontrol_entry_ts */
110     ratecontrol_entry_t *entry; /* FIXME: copy needed data and free this once init is done */
111     double last_qscale;
112     double last_qscale_for[5];  /* last qscale for a specific pict type, used for max_diff & ipb factor stuff  */
113     int last_non_b_pict_type;
114     double accum_p_qp;          /* for determining I-frame quant */
115     double accum_p_norm;
116     double last_accum_p_norm;
117     double lmin[5];             /* min qscale by frame type */
118     double lmax[5];
119     double lstep;               /* max change (multiply) in qscale per frame */
120
121     /* MBRC stuff */
122     double frame_size_estimated;
123     double frame_size_planned;
124     predictor_t *row_pred;
125     predictor_t row_preds[5];
126     predictor_t *pred_b_from_p; /* predict B-frame size from P-frame satd */
127     int bframes;                /* # consecutive B-frames before this P-frame */
128     int bframe_bits;            /* total cost of those frames */
129
130     int i_zones;
131     x264_zone_t *zones;
132     x264_zone_t *prev_zone;
133 };
134
135
136 static int parse_zones( x264_t *h );
137 static int init_pass2(x264_t *);
138 static float rate_estimate_qscale( x264_t *h );
139 static void update_vbv( x264_t *h, int bits );
140 static void update_vbv_plan( x264_t *h );
141 static double predict_size( predictor_t *p, double q, double var );
142 static void update_predictor( predictor_t *p, double q, double var, double bits );
143
144 /* Terminology:
145  * qp = h.264's quantizer
146  * qscale = linearized quantizer = Lagrange multiplier
147  */
148 static inline double qp2qscale(double qp)
149 {
150     return 0.85 * pow(2.0, ( qp - 12.0 ) / 6.0);
151 }
152 static inline double qscale2qp(double qscale)
153 {
154     return 12.0 + 6.0 * log(qscale/0.85) / log(2.0);
155 }
156
157 /* Texture bitrate is not quite inversely proportional to qscale,
158  * probably due the the changing number of SKIP blocks.
159  * MV bits level off at about qp<=12, because the lambda used
160  * for motion estimation is constant there. */
161 static inline double qscale2bits(ratecontrol_entry_t *rce, double qscale)
162 {
163     if(qscale<0.1)
164         qscale = 0.1;
165     return (rce->tex_bits + .1) * pow( rce->qscale / qscale, 1.1 )
166            + rce->mv_bits * pow( X264_MAX(rce->qscale, 1) / X264_MAX(qscale, 1), 0.5 )
167            + rce->misc_bits;
168 }
169
170 // Find the total AC energy of the block in all planes.
171 static NOINLINE int ac_energy_mb( x264_t *h, int mb_x, int mb_y, x264_frame_t *frame )
172 {
173     /* This function contains annoying hacks because GCC has a habit of reordering emms
174      * and putting it after floating point ops.  As a result, we put the emms at the end of the
175      * function and make sure that its always called before the float math.  Noinline makes
176      * sure no reordering goes on. */
177     unsigned int var=0, sad, i;
178     for( i=0; i<3; i++ )
179     {
180         int w = i ? 8 : 16;
181         int stride = frame->i_stride[i];
182         int offset = h->mb.b_interlaced
183             ? w * (mb_x + (mb_y&~1) * stride) + (mb_y&1) * stride
184             : w * (mb_x + mb_y * stride);
185         int pix = i ? PIXEL_8x8 : PIXEL_16x16;
186         stride <<= h->mb.b_interlaced;
187         var += h->pixf.var[pix]( frame->plane[i]+offset, stride, &sad );
188     }
189     var = X264_MAX(var,1);
190     x264_emms();
191     return var;
192 }
193
194 void x264_adaptive_quant_frame( x264_t *h, x264_frame_t *frame )
195 {
196     int mb_x, mb_y;
197     for( mb_y=0; mb_y<h->sps->i_mb_height; mb_y++ )
198         for( mb_x=0; mb_x<h->sps->i_mb_width; mb_x++ )
199         {
200             int energy = ac_energy_mb( h, mb_x, mb_y, frame );
201             /* 10 constant chosen to result in approximately the same overall bitrate as without AQ. */
202             float qp_adj = h->param.rc.f_aq_strength * 1.5 * (logf(energy) - 10.0);
203             frame->f_qp_offset[mb_x + mb_y*h->mb.i_mb_stride] = qp_adj;
204             if( h->frames.b_have_lowres )
205                 frame->i_inv_qscale_factor[mb_x+mb_y*h->mb.i_mb_stride] = FIX8(pow(2.0,-qp_adj/6.0));
206         }
207 }
208
209 /*****************************************************************************
210 * x264_adaptive_quant:
211  * adjust macroblock QP based on variance (AC energy) of the MB.
212  * high variance  = higher QP
213  * low variance = lower QP
214  * This generally increases SSIM and lowers PSNR.
215 *****************************************************************************/
216 void x264_adaptive_quant( x264_t *h )
217 {
218     float qp, qp_adj;
219     x264_emms();
220     qp = h->rc->f_qpm;
221     qp_adj = h->fenc->f_qp_offset[h->mb.i_mb_x + h->mb.i_mb_y*h->mb.i_mb_stride];
222     h->mb.i_qp = x264_clip3( qp + qp_adj + .5, h->param.rc.i_qp_min, h->param.rc.i_qp_max );
223     /* If the QP of this MB is within 1 of the previous MB, code the same QP as the previous MB,
224      * to lower the bit cost of the qp_delta. */
225     if( abs(h->mb.i_qp - h->mb.i_last_qp) == 1 )
226         h->mb.i_qp = h->mb.i_last_qp;
227     h->mb.i_chroma_qp = h->chroma_qp_table[h->mb.i_qp];
228 }
229
230 int x264_ratecontrol_new( x264_t *h )
231 {
232     x264_ratecontrol_t *rc;
233     int i;
234
235     x264_emms();
236
237     rc = h->rc = x264_malloc( h->param.i_threads * sizeof(x264_ratecontrol_t) );
238     memset( rc, 0, h->param.i_threads * sizeof(x264_ratecontrol_t) );
239
240     rc->b_abr = h->param.rc.i_rc_method != X264_RC_CQP && !h->param.rc.b_stat_read;
241     rc->b_2pass = h->param.rc.i_rc_method == X264_RC_ABR && h->param.rc.b_stat_read;
242
243     /* FIXME: use integers */
244     if(h->param.i_fps_num > 0 && h->param.i_fps_den > 0)
245         rc->fps = (float) h->param.i_fps_num / h->param.i_fps_den;
246     else
247         rc->fps = 25.0;
248
249     rc->bitrate = h->param.rc.i_bitrate * 1000.;
250     rc->rate_tolerance = h->param.rc.f_rate_tolerance;
251     rc->nmb = h->mb.i_mb_count;
252     rc->last_non_b_pict_type = -1;
253     rc->cbr_decay = 1.0;
254
255     if( h->param.rc.i_rc_method == X264_RC_CRF && h->param.rc.b_stat_read )
256     {
257         x264_log(h, X264_LOG_ERROR, "constant rate-factor is incompatible with 2pass.\n");
258         return -1;
259     }
260     if( h->param.rc.i_vbv_buffer_size )
261     {
262         if( h->param.rc.i_rc_method == X264_RC_CQP )
263             x264_log(h, X264_LOG_WARNING, "VBV is incompatible with constant QP, ignored.\n");
264         else if( h->param.rc.i_vbv_max_bitrate == 0 )
265         {
266             x264_log( h, X264_LOG_DEBUG, "VBV maxrate unspecified, assuming CBR\n" );
267             h->param.rc.i_vbv_max_bitrate = h->param.rc.i_bitrate;
268         }
269     }
270     if( h->param.rc.i_vbv_max_bitrate < h->param.rc.i_bitrate &&
271         h->param.rc.i_vbv_max_bitrate > 0)
272         x264_log(h, X264_LOG_WARNING, "max bitrate less than average bitrate, ignored.\n");
273     else if( h->param.rc.i_vbv_max_bitrate > 0 &&
274              h->param.rc.i_vbv_buffer_size > 0 )
275     {
276         if( h->param.rc.i_vbv_buffer_size < 3 * h->param.rc.i_vbv_max_bitrate / rc->fps )
277         {
278             h->param.rc.i_vbv_buffer_size = 3 * h->param.rc.i_vbv_max_bitrate / rc->fps;
279             x264_log( h, X264_LOG_WARNING, "VBV buffer size too small, using %d kbit\n",
280                       h->param.rc.i_vbv_buffer_size );
281         }
282         if( h->param.rc.f_vbv_buffer_init > 1. )
283             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 );
284         rc->buffer_rate = h->param.rc.i_vbv_max_bitrate * 1000. / rc->fps;
285         rc->buffer_size = h->param.rc.i_vbv_buffer_size * 1000.;
286         rc->buffer_fill_final = rc->buffer_size * h->param.rc.f_vbv_buffer_init;
287         rc->cbr_decay = 1.0 - rc->buffer_rate / rc->buffer_size
288                       * 0.5 * X264_MAX(0, 1.5 - rc->buffer_rate * rc->fps / rc->bitrate);
289         rc->b_vbv = 1;
290         rc->b_vbv_min_rate = !rc->b_2pass
291                           && h->param.rc.i_rc_method == X264_RC_ABR
292                           && h->param.rc.i_vbv_max_bitrate <= h->param.rc.i_bitrate;
293     }
294     else if( h->param.rc.i_vbv_max_bitrate )
295     {
296         x264_log(h, X264_LOG_WARNING, "VBV maxrate specified, but no bufsize.\n");
297         h->param.rc.i_vbv_max_bitrate = 0;
298     }
299     if(rc->rate_tolerance < 0.01)
300     {
301         x264_log(h, X264_LOG_WARNING, "bitrate tolerance too small, using .01\n");
302         rc->rate_tolerance = 0.01;
303     }
304
305     h->mb.b_variable_qp = rc->b_vbv || h->param.rc.i_aq_mode;
306
307     if( rc->b_abr )
308     {
309         /* FIXME ABR_INIT_QP is actually used only in CRF */
310 #define ABR_INIT_QP ( h->param.rc.i_rc_method == X264_RC_CRF ? h->param.rc.f_rf_constant : 24 )
311         rc->accum_p_norm = .01;
312         rc->accum_p_qp = ABR_INIT_QP * rc->accum_p_norm;
313         /* estimated ratio that produces a reasonable QP for the first I-frame */
314         rc->cplxr_sum = .01 * pow( 7.0e5, h->param.rc.f_qcompress ) * pow( h->mb.i_mb_count, 0.5 );
315         rc->wanted_bits_window = 1.0 * rc->bitrate / rc->fps;
316         rc->last_non_b_pict_type = SLICE_TYPE_I;
317     }
318
319     if( h->param.rc.i_rc_method == X264_RC_CRF )
320     {
321         /* arbitrary rescaling to make CRF somewhat similar to QP */
322         double base_cplx = h->mb.i_mb_count * (h->param.i_bframe ? 120 : 80);
323         rc->rate_factor_constant = pow( base_cplx, 1 - h->param.rc.f_qcompress )
324                                  / qp2qscale( h->param.rc.f_rf_constant );
325     }
326
327     rc->ip_offset = 6.0 * log(h->param.rc.f_ip_factor) / log(2.0);
328     rc->pb_offset = 6.0 * log(h->param.rc.f_pb_factor) / log(2.0);
329     rc->qp_constant[SLICE_TYPE_P] = h->param.rc.i_qp_constant;
330     rc->qp_constant[SLICE_TYPE_I] = x264_clip3( h->param.rc.i_qp_constant - rc->ip_offset + 0.5, 0, 51 );
331     rc->qp_constant[SLICE_TYPE_B] = x264_clip3( h->param.rc.i_qp_constant + rc->pb_offset + 0.5, 0, 51 );
332
333     rc->lstep = pow( 2, h->param.rc.i_qp_step / 6.0 );
334     rc->last_qscale = qp2qscale(26);
335     rc->pred = x264_malloc( 5*sizeof(predictor_t) );
336     rc->pred_b_from_p = x264_malloc( sizeof(predictor_t) );
337     for( i = 0; i < 5; i++ )
338     {
339         rc->last_qscale_for[i] = qp2qscale( ABR_INIT_QP );
340         rc->lmin[i] = qp2qscale( h->param.rc.i_qp_min );
341         rc->lmax[i] = qp2qscale( h->param.rc.i_qp_max );
342         rc->pred[i].coeff= 2.0;
343         rc->pred[i].count= 1.0;
344         rc->pred[i].decay= 0.5;
345         rc->row_preds[i].coeff= .25;
346         rc->row_preds[i].count= 1.0;
347         rc->row_preds[i].decay= 0.5;
348     }
349     *rc->pred_b_from_p = rc->pred[0];
350
351     if( parse_zones( h ) < 0 )
352     {
353         x264_log( h, X264_LOG_ERROR, "failed to parse zones\n" );
354         return -1;
355     }
356
357     /* Load stat file and init 2pass algo */
358     if( h->param.rc.b_stat_read )
359     {
360         char *p, *stats_in, *stats_buf;
361
362         /* read 1st pass stats */
363         assert( h->param.rc.psz_stat_in );
364         stats_buf = stats_in = x264_slurp_file( h->param.rc.psz_stat_in );
365         if( !stats_buf )
366         {
367             x264_log(h, X264_LOG_ERROR, "ratecontrol_init: can't open stats file\n");
368             return -1;
369         }
370
371         /* check whether 1st pass options were compatible with current options */
372         if( !strncmp( stats_buf, "#options:", 9 ) )
373         {
374             int i;
375             char *opts = stats_buf;
376             stats_in = strchr( stats_buf, '\n' );
377             if( !stats_in )
378                 return -1;
379             *stats_in = '\0';
380             stats_in++;
381
382             if( ( p = strstr( opts, "bframes=" ) ) && sscanf( p, "bframes=%d", &i )
383                 && h->param.i_bframe != i )
384             {
385                 x264_log( h, X264_LOG_ERROR, "different number of B-frames than 1st pass (%d vs %d)\n",
386                           h->param.i_bframe, i );
387                 return -1;
388             }
389
390             /* since B-adapt doesn't (yet) take into account B-pyramid,
391              * the converse is not a problem */
392             if( strstr( opts, "b_pyramid=1" ) && !h->param.b_bframe_pyramid )
393                 x264_log( h, X264_LOG_WARNING, "1st pass used B-pyramid, 2nd doesn't\n" );
394
395             if( ( p = strstr( opts, "keyint=" ) ) && sscanf( p, "keyint=%d", &i )
396                 && h->param.i_keyint_max != i )
397                 x264_log( h, X264_LOG_WARNING, "different keyint than 1st pass (%d vs %d)\n",
398                           h->param.i_keyint_max, i );
399
400             if( strstr( opts, "qp=0" ) && h->param.rc.i_rc_method == X264_RC_ABR )
401                 x264_log( h, X264_LOG_WARNING, "1st pass was lossless, bitrate prediction will be inaccurate\n" );
402
403             if( ( p = strstr( opts, "b_adapt=" ) ) && sscanf( p, "b_adapt=%d", &i ) && i >= X264_B_ADAPT_NONE && i <= X264_B_ADAPT_TRELLIS )
404                 h->param.i_bframe_adaptive = i;
405             else if( h->param.i_bframe )
406             {
407                 x264_log( h, X264_LOG_ERROR, "b_adapt method specified in stats file not valid\n" );
408                 return -1;
409             }
410
411             if( ( p = strstr( opts, "scenecut=" ) ) && sscanf( p, "scenecut=%d", &i ) && i >= -1 && i <= 100 )
412             {
413                 h->param.i_scenecut_threshold = i;
414                 h->param.b_pre_scenecut = !!strstr( p, "(pre)" );
415             }
416             else
417             {
418                 x264_log( h, X264_LOG_ERROR, "scenecut method specified in stats file not valid\n" );
419                 return -1;
420             }
421         }
422
423         /* find number of pics */
424         p = stats_in;
425         for(i=-1; p; i++)
426             p = strchr(p+1, ';');
427         if(i==0)
428         {
429             x264_log(h, X264_LOG_ERROR, "empty stats file\n");
430             return -1;
431         }
432         rc->num_entries = i;
433
434         if( h->param.i_frame_total < rc->num_entries && h->param.i_frame_total > 0 )
435         {
436             x264_log( h, X264_LOG_WARNING, "2nd pass has fewer frames than 1st pass (%d vs %d)\n",
437                       h->param.i_frame_total, rc->num_entries );
438         }
439         if( h->param.i_frame_total > rc->num_entries + h->param.i_bframe )
440         {
441             x264_log( h, X264_LOG_ERROR, "2nd pass has more frames than 1st pass (%d vs %d)\n",
442                       h->param.i_frame_total, rc->num_entries );
443             return -1;
444         }
445
446         rc->entry = (ratecontrol_entry_t*) x264_malloc(rc->num_entries * sizeof(ratecontrol_entry_t));
447         memset(rc->entry, 0, rc->num_entries * sizeof(ratecontrol_entry_t));
448
449         /* init all to skipped p frames */
450         for(i=0; i<rc->num_entries; i++)
451         {
452             ratecontrol_entry_t *rce = &rc->entry[i];
453             rce->pict_type = SLICE_TYPE_P;
454             rce->qscale = rce->new_qscale = qp2qscale(20);
455             rce->misc_bits = rc->nmb + 10;
456             rce->new_qp = 0;
457         }
458
459         /* read stats */
460         p = stats_in;
461         for(i=0; i < rc->num_entries - h->param.i_bframe; i++)
462         {
463             ratecontrol_entry_t *rce;
464             int frame_number;
465             char pict_type;
466             int e;
467             char *next;
468             float qp;
469
470             next= strchr(p, ';');
471             if(next)
472             {
473                 (*next)=0; //sscanf is unbelievably slow on long strings
474                 next++;
475             }
476             e = sscanf(p, " in:%d ", &frame_number);
477
478             if(frame_number < 0 || frame_number >= rc->num_entries)
479             {
480                 x264_log(h, X264_LOG_ERROR, "bad frame number (%d) at stats line %d\n", frame_number, i);
481                 return -1;
482             }
483             rce = &rc->entry[frame_number];
484             rce->direct_mode = 0;
485
486             e += sscanf(p, " in:%*d out:%*d type:%c q:%f tex:%d mv:%d misc:%d imb:%d pmb:%d smb:%d d:%c",
487                    &pict_type, &qp, &rce->tex_bits,
488                    &rce->mv_bits, &rce->misc_bits, &rce->i_count, &rce->p_count,
489                    &rce->s_count, &rce->direct_mode);
490
491             switch(pict_type)
492             {
493                 case 'I': rce->kept_as_ref = 1;
494                 case 'i': rce->pict_type = SLICE_TYPE_I; break;
495                 case 'P': rce->pict_type = SLICE_TYPE_P; break;
496                 case 'B': rce->kept_as_ref = 1;
497                 case 'b': rce->pict_type = SLICE_TYPE_B; break;
498                 default:  e = -1; break;
499             }
500             if(e < 10)
501             {
502                 x264_log(h, X264_LOG_ERROR, "statistics are damaged at line %d, parser out=%d\n", i, e);
503                 return -1;
504             }
505             rce->qscale = qp2qscale(qp);
506             p = next;
507         }
508
509         x264_free(stats_buf);
510
511         if(h->param.rc.i_rc_method == X264_RC_ABR)
512         {
513             if(init_pass2(h) < 0) return -1;
514         } /* else we're using constant quant, so no need to run the bitrate allocation */
515     }
516
517     /* Open output file */
518     /* If input and output files are the same, output to a temp file
519      * and move it to the real name only when it's complete */
520     if( h->param.rc.b_stat_write )
521     {
522         char *p;
523
524         rc->psz_stat_file_tmpname = x264_malloc( strlen(h->param.rc.psz_stat_out) + 6 );
525         strcpy( rc->psz_stat_file_tmpname, h->param.rc.psz_stat_out );
526         strcat( rc->psz_stat_file_tmpname, ".temp" );
527
528         rc->p_stat_file_out = fopen( rc->psz_stat_file_tmpname, "wb" );
529         if( rc->p_stat_file_out == NULL )
530         {
531             x264_log(h, X264_LOG_ERROR, "ratecontrol_init: can't open stats file\n");
532             return -1;
533         }
534
535         p = x264_param2string( &h->param, 1 );
536         fprintf( rc->p_stat_file_out, "#options: %s\n", p );
537         x264_free( p );
538     }
539
540     for( i=0; i<h->param.i_threads; i++ )
541     {
542         h->thread[i]->rc = rc+i;
543         if( i )
544         {
545             rc[i] = rc[0];
546             memcpy( &h->thread[i]->param, &h->param, sizeof( x264_param_t ) );
547             h->thread[i]->mb.b_variable_qp = h->mb.b_variable_qp;
548         }
549     }
550
551     return 0;
552 }
553
554 static int parse_zone( x264_t *h, x264_zone_t *z, char *p )
555 {
556     int len = 0;
557     char *tok, *saveptr;
558     z->param = NULL;
559     z->f_bitrate_factor = 1;
560     if( 3 <= sscanf(p, "%u,%u,q=%u%n", &z->i_start, &z->i_end, &z->i_qp, &len) )
561         z->b_force_qp = 1;
562     else if( 3 <= sscanf(p, "%u,%u,b=%f%n", &z->i_start, &z->i_end, &z->f_bitrate_factor, &len) )
563         z->b_force_qp = 0;
564     else if( 2 <= sscanf(p, "%u,%u%n", &z->i_start, &z->i_end, &len) )
565         z->b_force_qp = 0;
566     else
567     {
568         x264_log( h, X264_LOG_ERROR, "invalid zone: \"%s\"\n", p );
569         return -1;
570     }
571     p += len;
572     if( !*p )
573         return 0;
574     z->param = malloc( sizeof(x264_param_t) );
575     memcpy( z->param, &h->param, sizeof(x264_param_t) );
576     while( (tok = strtok_r( p, ",", &saveptr )) )
577     {
578         char *val = strchr( tok, '=' );
579         if( val )
580         {
581             *val = '\0';
582             val++;
583         }
584         if( x264_param_parse( z->param, tok, val ) )
585         {
586             x264_log( h, X264_LOG_ERROR, "invalid zone param: %s = %s\n", tok, val );
587             return -1;
588         }
589         p = NULL;
590     }
591     return 0;
592 }
593
594 static int parse_zones( x264_t *h )
595 {
596     x264_ratecontrol_t *rc = h->rc;
597     int i;
598     if( h->param.rc.psz_zones && !h->param.rc.i_zones )
599     {
600         char *p, *tok, *saveptr;
601         char *psz_zones = x264_malloc( strlen(h->param.rc.psz_zones)+1 );
602         strcpy( psz_zones, h->param.rc.psz_zones );
603         h->param.rc.i_zones = 1;
604         for( p = psz_zones; *p; p++ )
605             h->param.rc.i_zones += (*p == '/');
606         h->param.rc.zones = x264_malloc( h->param.rc.i_zones * sizeof(x264_zone_t) );
607         p = psz_zones;
608         for( i = 0; i < h->param.rc.i_zones; i++ )
609         {
610             tok = strtok_r( p, "/", &saveptr );
611             if( !tok || parse_zone( h, &h->param.rc.zones[i], tok ) )
612                 return -1;
613             p = NULL;
614         }
615         x264_free( psz_zones );
616     }
617
618     if( h->param.rc.i_zones > 0 )
619     {
620         for( i = 0; i < h->param.rc.i_zones; i++ )
621         {
622             x264_zone_t z = h->param.rc.zones[i];
623             if( z.i_start < 0 || z.i_start > z.i_end )
624             {
625                 x264_log( h, X264_LOG_ERROR, "invalid zone: start=%d end=%d\n",
626                           z.i_start, z.i_end );
627                 return -1;
628             }
629             else if( !z.b_force_qp && z.f_bitrate_factor <= 0 )
630             {
631                 x264_log( h, X264_LOG_ERROR, "invalid zone: bitrate_factor=%f\n",
632                           z.f_bitrate_factor );
633                 return -1;
634             }
635         }
636
637         rc->i_zones = h->param.rc.i_zones + 1;
638         rc->zones = x264_malloc( rc->i_zones * sizeof(x264_zone_t) );
639         memcpy( rc->zones+1, h->param.rc.zones, (rc->i_zones-1) * sizeof(x264_zone_t) );
640
641         // default zone to fall back to if none of the others match
642         rc->zones[0].i_start = 0;
643         rc->zones[0].i_end = INT_MAX;
644         rc->zones[0].b_force_qp = 0;
645         rc->zones[0].f_bitrate_factor = 1;
646         rc->zones[0].param = x264_malloc( sizeof(x264_param_t) );
647         memcpy( rc->zones[0].param, &h->param, sizeof(x264_param_t) );
648         for( i = 1; i < rc->i_zones; i++ )
649         {
650             if( !rc->zones[i].param )
651                 rc->zones[i].param = rc->zones[0].param;
652         }
653     }
654
655     return 0;
656 }
657
658 static x264_zone_t *get_zone( x264_t *h, int frame_num )
659 {
660     int i;
661     for( i = h->rc->i_zones-1; i >= 0; i-- )
662     {
663         x264_zone_t *z = &h->rc->zones[i];
664         if( frame_num >= z->i_start && frame_num <= z->i_end )
665             return z;
666     }
667     return NULL;
668 }
669
670 void x264_ratecontrol_summary( x264_t *h )
671 {
672     x264_ratecontrol_t *rc = h->rc;
673     if( rc->b_abr && h->param.rc.i_rc_method == X264_RC_ABR && rc->cbr_decay > .9999 )
674     {
675         double base_cplx = h->mb.i_mb_count * (h->param.i_bframe ? 120 : 80);
676         x264_log( h, X264_LOG_INFO, "final ratefactor: %.2f\n",
677                   qscale2qp( pow( base_cplx, 1 - h->param.rc.f_qcompress )
678                              * rc->cplxr_sum / rc->wanted_bits_window ) );
679     }
680 }
681
682 void x264_ratecontrol_delete( x264_t *h )
683 {
684     x264_ratecontrol_t *rc = h->rc;
685     int i;
686
687     if( rc->p_stat_file_out )
688     {
689         fclose( rc->p_stat_file_out );
690         if( h->i_frame >= rc->num_entries - h->param.i_bframe )
691             if( rename( rc->psz_stat_file_tmpname, h->param.rc.psz_stat_out ) != 0 )
692             {
693                 x264_log( h, X264_LOG_ERROR, "failed to rename \"%s\" to \"%s\"\n",
694                           rc->psz_stat_file_tmpname, h->param.rc.psz_stat_out );
695             }
696         x264_free( rc->psz_stat_file_tmpname );
697     }
698     x264_free( rc->pred );
699     x264_free( rc->pred_b_from_p );
700     x264_free( rc->entry );
701     if( rc->zones )
702     {
703         x264_free( rc->zones[0].param );
704         if( h->param.rc.psz_zones )
705             for( i=1; i<rc->i_zones; i++ )
706                 if( rc->zones[i].param != rc->zones[0].param )
707                     x264_free( rc->zones[i].param );
708         x264_free( rc->zones );
709     }
710     x264_free( rc );
711 }
712
713 void x264_ratecontrol_set_estimated_size( x264_t *h, int bits )
714 {
715     x264_pthread_mutex_lock( &h->fenc->mutex );
716     h->rc->frame_size_estimated = bits;
717     x264_pthread_mutex_unlock( &h->fenc->mutex );
718 }
719
720 int x264_ratecontrol_get_estimated_size( x264_t const *h)
721 {
722     int size;
723     x264_pthread_mutex_lock( &h->fenc->mutex );
724     size = h->rc->frame_size_estimated;
725     x264_pthread_mutex_unlock( &h->fenc->mutex );
726     return size;
727 }
728
729 static void accum_p_qp_update( x264_t *h, float qp )
730 {
731     x264_ratecontrol_t *rc = h->rc;
732     rc->accum_p_qp   *= .95;
733     rc->accum_p_norm *= .95;
734     rc->accum_p_norm += 1;
735     if( h->sh.i_type == SLICE_TYPE_I )
736         rc->accum_p_qp += qp + rc->ip_offset;
737     else
738         rc->accum_p_qp += qp;
739 }
740
741 /* Before encoding a frame, choose a QP for it */
742 void x264_ratecontrol_start( x264_t *h, int i_force_qp )
743 {
744     x264_ratecontrol_t *rc = h->rc;
745     ratecontrol_entry_t *rce = NULL;
746     x264_zone_t *zone = get_zone( h, h->fenc->i_frame );
747     float q;
748
749     x264_emms();
750
751     if( zone && (!rc->prev_zone || zone->param != rc->prev_zone->param) )
752         x264_encoder_reconfig( h, zone->param );
753     rc->prev_zone = zone;
754
755     rc->qp_force = i_force_qp;
756
757     if( h->param.rc.b_stat_read )
758     {
759         int frame = h->fenc->i_frame;
760         assert( frame >= 0 && frame < rc->num_entries );
761         rce = h->rc->rce = &h->rc->entry[frame];
762
763         if( h->sh.i_type == SLICE_TYPE_B
764             && h->param.analyse.i_direct_mv_pred == X264_DIRECT_PRED_AUTO )
765         {
766             h->sh.b_direct_spatial_mv_pred = ( rce->direct_mode == 's' );
767             h->mb.b_direct_auto_read = ( rce->direct_mode == 's' || rce->direct_mode == 't' );
768         }
769     }
770
771     if( rc->b_vbv )
772     {
773         memset( h->fdec->i_row_bits, 0, h->sps->i_mb_height * sizeof(int) );
774         rc->row_pred = &rc->row_preds[h->sh.i_type];
775         update_vbv_plan( h );
776     }
777
778     if( h->sh.i_type != SLICE_TYPE_B )
779     {
780         rc->bframes = 0;
781         while( h->frames.current[rc->bframes] && IS_X264_TYPE_B(h->frames.current[rc->bframes]->i_type) )
782             rc->bframes++;
783     }
784
785     if( i_force_qp )
786     {
787         q = i_force_qp - 1;
788     }
789     else if( rc->b_abr )
790     {
791         q = qscale2qp( rate_estimate_qscale( h ) );
792     }
793     else if( rc->b_2pass )
794     {
795         rce->new_qscale = rate_estimate_qscale( h );
796         q = qscale2qp( rce->new_qscale );
797     }
798     else /* CQP */
799     {
800         if( h->sh.i_type == SLICE_TYPE_B && h->fdec->b_kept_as_ref )
801             q = ( rc->qp_constant[ SLICE_TYPE_B ] + rc->qp_constant[ SLICE_TYPE_P ] ) / 2;
802         else
803             q = rc->qp_constant[ h->sh.i_type ];
804
805         if( zone )
806         {
807             if( zone->b_force_qp )
808                 q += zone->i_qp - rc->qp_constant[SLICE_TYPE_P];
809             else
810                 q -= 6*log(zone->f_bitrate_factor)/log(2);
811         }
812     }
813
814     rc->qpa_rc =
815     rc->qpa_aq = 0;
816     h->fdec->f_qp_avg_rc =
817     h->fdec->f_qp_avg_aq =
818     rc->qpm =
819     rc->qp = x264_clip3( (int)(q + 0.5), 0, 51 );
820     rc->f_qpm = q;
821     if( rce )
822         rce->new_qp = rc->qp;
823
824     /* accum_p_qp needs to be here so that future frames can benefit from the
825      * data before this frame is done. but this only works because threading
826      * guarantees to not re-encode any frames. so the non-threaded case does
827      * accum_p_qp later. */
828     if( h->param.i_threads > 1 )
829         accum_p_qp_update( h, rc->qp );
830
831     if( h->sh.i_type != SLICE_TYPE_B )
832         rc->last_non_b_pict_type = h->sh.i_type;
833 }
834
835 static double predict_row_size( x264_t *h, int y, int qp )
836 {
837     /* average between two predictors:
838      * absolute SATD, and scaled bit cost of the colocated row in the previous frame */
839     x264_ratecontrol_t *rc = h->rc;
840     double pred_s = predict_size( rc->row_pred, qp2qscale(qp), h->fdec->i_row_satd[y] );
841     double pred_t = 0;
842     if( h->sh.i_type != SLICE_TYPE_I
843         && h->fref0[0]->i_type == h->fdec->i_type
844         && h->fref0[0]->i_row_satd[y] > 0
845         && (abs(h->fref0[0]->i_row_satd[y] - h->fdec->i_row_satd[y]) < h->fdec->i_row_satd[y]/2))
846     {
847         pred_t = h->fref0[0]->i_row_bits[y] * h->fdec->i_row_satd[y] / h->fref0[0]->i_row_satd[y]
848                  * qp2qscale(h->fref0[0]->i_row_qp[y]) / qp2qscale(qp);
849     }
850     if( pred_t == 0 )
851         pred_t = pred_s;
852
853     return (pred_s + pred_t) / 2;
854 }
855
856 static double row_bits_so_far( x264_t *h, int y )
857 {
858     int i;
859     double bits = 0;
860     for( i = 0; i <= y; i++ )
861         bits += h->fdec->i_row_bits[i];
862     return bits;
863 }
864
865 static double predict_row_size_sum( x264_t *h, int y, int qp )
866 {
867     int i;
868     double bits = row_bits_so_far(h, y);
869     for( i = y+1; i < h->sps->i_mb_height; i++ )
870         bits += predict_row_size( h, i, qp );
871     return bits;
872 }
873
874
875 void x264_ratecontrol_mb( x264_t *h, int bits )
876 {
877     x264_ratecontrol_t *rc = h->rc;
878     const int y = h->mb.i_mb_y;
879
880     x264_emms();
881
882     h->fdec->i_row_bits[y] += bits;
883     rc->qpa_rc += rc->f_qpm;
884     rc->qpa_aq += h->mb.i_qp;
885
886     if( h->mb.i_mb_x != h->sps->i_mb_width - 1 || !rc->b_vbv)
887         return;
888
889     h->fdec->i_row_qp[y] = rc->qpm;
890
891     if( h->sh.i_type == SLICE_TYPE_B )
892     {
893         /* B-frames shouldn't use lower QP than their reference frames.
894          * This code is a bit overzealous in limiting B-frame quantizers, but it helps avoid
895          * underflows due to the fact that B-frames are not explicitly covered by VBV. */
896         if( y < h->sps->i_mb_height-1 )
897         {
898             int i_estimated;
899             int avg_qp = X264_MAX(h->fref0[0]->i_row_qp[y+1], h->fref1[0]->i_row_qp[y+1])
900                        + rc->pb_offset * ((h->fenc->i_type == X264_TYPE_BREF) ? 0.5 : 1);
901             rc->qpm = X264_MIN(X264_MAX( rc->qp, avg_qp), 51); //avg_qp could go higher than 51 due to pb_offset
902             i_estimated = row_bits_so_far(h, y); //FIXME: compute full estimated size
903             if (i_estimated > h->rc->frame_size_planned)
904                 x264_ratecontrol_set_estimated_size(h, i_estimated);
905         }
906     }
907     else
908     {
909         update_predictor( rc->row_pred, qp2qscale(rc->qpm), h->fdec->i_row_satd[y], h->fdec->i_row_bits[y] );
910
911         /* tweak quality based on difference from predicted size */
912         if( y < h->sps->i_mb_height-1 && h->stat.i_slice_count[h->sh.i_type] > 0 )
913         {
914             int prev_row_qp = h->fdec->i_row_qp[y];
915             int b0 = predict_row_size_sum( h, y, rc->qpm );
916             int b1 = b0;
917             int i_qp_max = X264_MIN( prev_row_qp + h->param.rc.i_qp_step, h->param.rc.i_qp_max );
918             int i_qp_min = X264_MAX( prev_row_qp - h->param.rc.i_qp_step, h->param.rc.i_qp_min );
919             float buffer_left_planned = rc->buffer_fill - rc->frame_size_planned;
920             float rc_tol = 1;
921             float headroom = 0;
922
923             /* Don't modify the row QPs until a sufficent amount of the bits of the frame have been processed, in case a flat */
924             /* area at the top of the frame was measured inaccurately. */
925             if(row_bits_so_far(h,y) < 0.05 * rc->frame_size_planned)
926                 return;
927
928             headroom = buffer_left_planned/rc->buffer_size;
929             if(h->sh.i_type != SLICE_TYPE_I)
930                 headroom /= 2;
931             rc_tol += headroom;
932
933             if( !rc->b_vbv_min_rate )
934                 i_qp_min = X264_MAX( i_qp_min, h->sh.i_qp );
935
936             while( rc->qpm < i_qp_max
937                    && (b1 > rc->frame_size_planned * rc_tol
938                     || (rc->buffer_fill - b1 < buffer_left_planned * 0.5)))
939             {
940                 rc->qpm ++;
941                 b1 = predict_row_size_sum( h, y, rc->qpm );
942             }
943
944             /* avoid VBV underflow */
945             while( (rc->qpm < h->param.rc.i_qp_max)
946                    && (rc->buffer_fill - b1 < rc->buffer_size * 0.005))
947             {
948                 rc->qpm ++;
949                 b1 = predict_row_size_sum( h, y, rc->qpm );
950             }
951
952             while( rc->qpm > i_qp_min
953                    && rc->qpm > h->fdec->i_row_qp[0]
954                    && ((b1 < rc->frame_size_planned * 0.8 && rc->qpm <= prev_row_qp)
955                      || b1 < (rc->buffer_fill - rc->buffer_size + rc->buffer_rate) * 1.1) )
956             {
957                 rc->qpm --;
958                 b1 = predict_row_size_sum( h, y, rc->qpm );
959             }
960             x264_ratecontrol_set_estimated_size(h, b1);
961         }
962     }
963     /* loses the fractional part of the frame-wise qp */
964     rc->f_qpm = rc->qpm;
965 }
966
967 int x264_ratecontrol_qp( x264_t *h )
968 {
969     return h->rc->qpm;
970 }
971
972 /* In 2pass, force the same frame types as in the 1st pass */
973 int x264_ratecontrol_slice_type( x264_t *h, int frame_num )
974 {
975     x264_ratecontrol_t *rc = h->rc;
976     if( h->param.rc.b_stat_read )
977     {
978         if( frame_num >= rc->num_entries )
979         {
980             /* We could try to initialize everything required for ABR and
981              * adaptive B-frames, but that would be complicated.
982              * So just calculate the average QP used so far. */
983             int i;
984
985             h->param.rc.i_qp_constant = (h->stat.i_slice_count[SLICE_TYPE_P] == 0) ? 24
986                                       : 1 + h->stat.f_slice_qp[SLICE_TYPE_P] / h->stat.i_slice_count[SLICE_TYPE_P];
987             rc->qp_constant[SLICE_TYPE_P] = x264_clip3( h->param.rc.i_qp_constant, 0, 51 );
988             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, 51 );
989             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, 51 );
990
991             x264_log(h, X264_LOG_ERROR, "2nd pass has more frames than 1st pass (%d)\n", rc->num_entries);
992             x264_log(h, X264_LOG_ERROR, "continuing anyway, at constant QP=%d\n", h->param.rc.i_qp_constant);
993             if( h->param.i_bframe_adaptive )
994                 x264_log(h, X264_LOG_ERROR, "disabling adaptive B-frames\n");
995
996             for( i = 0; i < h->param.i_threads; i++ )
997             {
998                 h->thread[i]->rc->b_abr = 0;
999                 h->thread[i]->rc->b_2pass = 0;
1000                 h->thread[i]->param.rc.i_rc_method = X264_RC_CQP;
1001                 h->thread[i]->param.rc.b_stat_read = 0;
1002                 h->thread[i]->param.i_bframe_adaptive = 0;
1003                 h->thread[i]->param.b_pre_scenecut = 0;
1004                 h->thread[i]->param.i_scenecut_threshold = -1;
1005                 if( h->thread[i]->param.i_bframe > 1 )
1006                     h->thread[i]->param.i_bframe = 1;
1007             }
1008             return X264_TYPE_AUTO;
1009         }
1010         switch( rc->entry[frame_num].pict_type )
1011         {
1012             case SLICE_TYPE_I:
1013                 return rc->entry[frame_num].kept_as_ref ? X264_TYPE_IDR : X264_TYPE_I;
1014
1015             case SLICE_TYPE_B:
1016                 return rc->entry[frame_num].kept_as_ref ? X264_TYPE_BREF : X264_TYPE_B;
1017
1018             case SLICE_TYPE_P:
1019             default:
1020                 return X264_TYPE_P;
1021         }
1022     }
1023     else
1024     {
1025         return X264_TYPE_AUTO;
1026     }
1027 }
1028
1029 /* After encoding one frame, save stats and update ratecontrol state */
1030 void x264_ratecontrol_end( x264_t *h, int bits )
1031 {
1032     x264_ratecontrol_t *rc = h->rc;
1033     const int *mbs = h->stat.frame.i_mb_count;
1034     int i;
1035
1036     x264_emms();
1037
1038     h->stat.frame.i_mb_count_skip = mbs[P_SKIP] + mbs[B_SKIP];
1039     h->stat.frame.i_mb_count_i = mbs[I_16x16] + mbs[I_8x8] + mbs[I_4x4];
1040     h->stat.frame.i_mb_count_p = mbs[P_L0] + mbs[P_8x8];
1041     for( i = B_DIRECT; i < B_8x8; i++ )
1042         h->stat.frame.i_mb_count_p += mbs[i];
1043
1044     h->fdec->f_qp_avg_rc = rc->qpa_rc /= h->mb.i_mb_count;
1045     h->fdec->f_qp_avg_aq = rc->qpa_aq /= h->mb.i_mb_count;
1046
1047     if( h->param.rc.b_stat_write )
1048     {
1049         char c_type = h->sh.i_type==SLICE_TYPE_I ? (h->fenc->i_poc==0 ? 'I' : 'i')
1050                     : h->sh.i_type==SLICE_TYPE_P ? 'P'
1051                     : h->fenc->b_kept_as_ref ? 'B' : 'b';
1052         int dir_frame = h->stat.frame.i_direct_score[1] - h->stat.frame.i_direct_score[0];
1053         int dir_avg = h->stat.i_direct_score[1] - h->stat.i_direct_score[0];
1054         char c_direct = h->mb.b_direct_auto_write ?
1055                         ( dir_frame>0 ? 's' : dir_frame<0 ? 't' :
1056                           dir_avg>0 ? 's' : dir_avg<0 ? 't' : '-' )
1057                         : '-';
1058         fprintf( rc->p_stat_file_out,
1059                  "in:%d out:%d type:%c q:%.2f tex:%d mv:%d misc:%d imb:%d pmb:%d smb:%d d:%c;\n",
1060                  h->fenc->i_frame, h->i_frame,
1061                  c_type, rc->qpa_rc,
1062                  h->stat.frame.i_tex_bits,
1063                  h->stat.frame.i_mv_bits,
1064                  h->stat.frame.i_misc_bits,
1065                  h->stat.frame.i_mb_count_i,
1066                  h->stat.frame.i_mb_count_p,
1067                  h->stat.frame.i_mb_count_skip,
1068                  c_direct);
1069     }
1070
1071     if( rc->b_abr )
1072     {
1073         if( h->sh.i_type != SLICE_TYPE_B )
1074             rc->cplxr_sum += bits * qp2qscale(rc->qpa_rc) / rc->last_rceq;
1075         else
1076         {
1077             /* Depends on the fact that B-frame's QP is an offset from the following P-frame's.
1078              * Not perfectly accurate with B-refs, but good enough. */
1079             rc->cplxr_sum += bits * qp2qscale(rc->qpa_rc) / (rc->last_rceq * fabs(h->param.rc.f_pb_factor));
1080         }
1081         rc->cplxr_sum *= rc->cbr_decay;
1082         rc->wanted_bits_window += rc->bitrate / rc->fps;
1083         rc->wanted_bits_window *= rc->cbr_decay;
1084
1085         if( h->param.i_threads == 1 )
1086             accum_p_qp_update( h, rc->qpa_rc );
1087     }
1088
1089     if( rc->b_2pass )
1090     {
1091         rc->expected_bits_sum += qscale2bits( rc->rce, qp2qscale(rc->rce->new_qp) );
1092     }
1093
1094     if( h->mb.b_variable_qp )
1095     {
1096         if( h->sh.i_type == SLICE_TYPE_B )
1097         {
1098             rc->bframe_bits += bits;
1099             if( !h->frames.current[0] || !IS_X264_TYPE_B(h->frames.current[0]->i_type) )
1100             {
1101                 update_predictor( rc->pred_b_from_p, qp2qscale(rc->qpa_rc),
1102                                   h->fref1[h->i_ref1-1]->i_satd, rc->bframe_bits / rc->bframes );
1103                 rc->bframe_bits = 0;
1104             }
1105         }
1106     }
1107
1108     update_vbv( h, bits );
1109 }
1110
1111 /****************************************************************************
1112  * 2 pass functions
1113  ***************************************************************************/
1114
1115 /**
1116  * modify the bitrate curve from pass1 for one frame
1117  */
1118 static double get_qscale(x264_t *h, ratecontrol_entry_t *rce, double rate_factor, int frame_num)
1119 {
1120     x264_ratecontrol_t *rcc= h->rc;
1121     double q;
1122     x264_zone_t *zone = get_zone( h, frame_num );
1123
1124     q = pow( rce->blurred_complexity, 1 - h->param.rc.f_qcompress );
1125
1126     // avoid NaN's in the rc_eq
1127     if(!isfinite(q) || rce->tex_bits + rce->mv_bits == 0)
1128         q = rcc->last_qscale;
1129     else
1130     {
1131         rcc->last_rceq = q;
1132         q /= rate_factor;
1133         rcc->last_qscale = q;
1134     }
1135
1136     if( zone )
1137     {
1138         if( zone->b_force_qp )
1139             q = qp2qscale(zone->i_qp);
1140         else
1141             q /= zone->f_bitrate_factor;
1142     }
1143
1144     return q;
1145 }
1146
1147 static double get_diff_limited_q(x264_t *h, ratecontrol_entry_t *rce, double q)
1148 {
1149     x264_ratecontrol_t *rcc = h->rc;
1150     const int pict_type = rce->pict_type;
1151
1152     // force I/B quants as a function of P quants
1153     const double last_p_q    = rcc->last_qscale_for[SLICE_TYPE_P];
1154     const double last_non_b_q= rcc->last_qscale_for[rcc->last_non_b_pict_type];
1155     if( pict_type == SLICE_TYPE_I )
1156     {
1157         double iq = q;
1158         double pq = qp2qscale( rcc->accum_p_qp / rcc->accum_p_norm );
1159         double ip_factor = fabs( h->param.rc.f_ip_factor );
1160         /* don't apply ip_factor if the following frame is also I */
1161         if( rcc->accum_p_norm <= 0 )
1162             q = iq;
1163         else if( h->param.rc.f_ip_factor < 0 )
1164             q = iq / ip_factor;
1165         else if( rcc->accum_p_norm >= 1 )
1166             q = pq / ip_factor;
1167         else
1168             q = rcc->accum_p_norm * pq / ip_factor + (1 - rcc->accum_p_norm) * iq;
1169     }
1170     else if( pict_type == SLICE_TYPE_B )
1171     {
1172         if( h->param.rc.f_pb_factor > 0 )
1173             q = last_non_b_q;
1174         if( !rce->kept_as_ref )
1175             q *= fabs( h->param.rc.f_pb_factor );
1176     }
1177     else if( pict_type == SLICE_TYPE_P
1178              && rcc->last_non_b_pict_type == SLICE_TYPE_P
1179              && rce->tex_bits == 0 )
1180     {
1181         q = last_p_q;
1182     }
1183
1184     /* last qscale / qdiff stuff */
1185     if(rcc->last_non_b_pict_type==pict_type
1186        && (pict_type!=SLICE_TYPE_I || rcc->last_accum_p_norm < 1))
1187     {
1188         double last_q = rcc->last_qscale_for[pict_type];
1189         double max_qscale = last_q * rcc->lstep;
1190         double min_qscale = last_q / rcc->lstep;
1191
1192         if     (q > max_qscale) q = max_qscale;
1193         else if(q < min_qscale) q = min_qscale;
1194     }
1195
1196     rcc->last_qscale_for[pict_type] = q;
1197     if(pict_type!=SLICE_TYPE_B)
1198         rcc->last_non_b_pict_type = pict_type;
1199     if(pict_type==SLICE_TYPE_I)
1200     {
1201         rcc->last_accum_p_norm = rcc->accum_p_norm;
1202         rcc->accum_p_norm = 0;
1203         rcc->accum_p_qp = 0;
1204     }
1205     if(pict_type==SLICE_TYPE_P)
1206     {
1207         float mask = 1 - pow( (float)rce->i_count / rcc->nmb, 2 );
1208         rcc->accum_p_qp   = mask * (qscale2qp(q) + rcc->accum_p_qp);
1209         rcc->accum_p_norm = mask * (1 + rcc->accum_p_norm);
1210     }
1211     return q;
1212 }
1213
1214 static double predict_size( predictor_t *p, double q, double var )
1215 {
1216      return p->coeff*var / (q*p->count);
1217 }
1218
1219 static void update_predictor( predictor_t *p, double q, double var, double bits )
1220 {
1221     if( var < 10 )
1222         return;
1223     p->count *= p->decay;
1224     p->coeff *= p->decay;
1225     p->count ++;
1226     p->coeff += bits*q / var;
1227 }
1228
1229 // update VBV after encoding a frame
1230 static void update_vbv( x264_t *h, int bits )
1231 {
1232     x264_ratecontrol_t *rcc = h->rc;
1233     x264_ratecontrol_t *rct = h->thread[0]->rc;
1234
1235     if( rcc->last_satd >= h->mb.i_mb_count )
1236         update_predictor( &rct->pred[h->sh.i_type], qp2qscale(rcc->qpa_rc), rcc->last_satd, bits );
1237
1238     if( !rcc->b_vbv )
1239         return;
1240
1241     rct->buffer_fill_final += rct->buffer_rate - bits;
1242     if( rct->buffer_fill_final < 0 )
1243         x264_log( h, X264_LOG_WARNING, "VBV underflow (%.0f bits)\n", rct->buffer_fill_final );
1244     rct->buffer_fill_final = x264_clip3f( rct->buffer_fill_final, 0, rct->buffer_size );
1245 }
1246
1247 // provisionally update VBV according to the planned size of all frames currently in progress
1248 static void update_vbv_plan( x264_t *h )
1249 {
1250     x264_ratecontrol_t *rcc = h->rc;
1251     rcc->buffer_fill = h->thread[0]->rc->buffer_fill_final;
1252     if( h->param.i_threads > 1 )
1253     {
1254         int j = h->rc - h->thread[0]->rc;
1255         int i;
1256         for( i=1; i<h->param.i_threads; i++ )
1257         {
1258             x264_t *t = h->thread[ (j+i)%h->param.i_threads ];
1259             double bits = t->rc->frame_size_planned;
1260             if( !t->b_thread_active )
1261                 continue;
1262             bits  = X264_MAX(bits, x264_ratecontrol_get_estimated_size(t));
1263             rcc->buffer_fill += rcc->buffer_rate - bits;
1264             rcc->buffer_fill = x264_clip3( rcc->buffer_fill, 0, rcc->buffer_size );
1265         }
1266     }
1267 }
1268
1269 // apply VBV constraints and clip qscale to between lmin and lmax
1270 static double clip_qscale( x264_t *h, int pict_type, double q )
1271 {
1272     x264_ratecontrol_t *rcc = h->rc;
1273     double lmin = rcc->lmin[pict_type];
1274     double lmax = rcc->lmax[pict_type];
1275     double q0 = q;
1276
1277     /* B-frames are not directly subject to VBV,
1278      * since they are controlled by the P-frames' QPs.
1279      * FIXME: in 2pass we could modify previous frames' QP too,
1280      *        instead of waiting for the buffer to fill */
1281     if( rcc->b_vbv &&
1282         ( pict_type == SLICE_TYPE_P ||
1283           ( pict_type == SLICE_TYPE_I && rcc->last_non_b_pict_type == SLICE_TYPE_I ) ) )
1284     {
1285         if( rcc->buffer_fill/rcc->buffer_size < 0.5 )
1286             q /= x264_clip3f( 2.0*rcc->buffer_fill/rcc->buffer_size, 0.5, 1.0 );
1287     }
1288
1289     if( rcc->b_vbv && rcc->last_satd > 0 )
1290     {
1291         /* Now a hard threshold to make sure the frame fits in VBV.
1292          * This one is mostly for I-frames. */
1293         double bits = predict_size( &rcc->pred[h->sh.i_type], q, rcc->last_satd );
1294         double qf = 1.0;
1295         if( bits > rcc->buffer_fill/2 )
1296             qf = x264_clip3f( rcc->buffer_fill/(2*bits), 0.2, 1.0 );
1297         q /= qf;
1298         bits *= qf;
1299         if( bits < rcc->buffer_rate/2 )
1300             q *= bits*2/rcc->buffer_rate;
1301         q = X264_MAX( q0, q );
1302
1303         /* Check B-frame complexity, and use up any bits that would
1304          * overflow before the next P-frame. */
1305         if( h->sh.i_type == SLICE_TYPE_P )
1306         {
1307             int nb = rcc->bframes;
1308             double pbbits = bits;
1309             double bbits = predict_size( rcc->pred_b_from_p, q * h->param.rc.f_pb_factor, rcc->last_satd );
1310             double space;
1311
1312             if( bbits > rcc->buffer_rate )
1313                 nb = 0;
1314             pbbits += nb * bbits;
1315
1316             space = rcc->buffer_fill + (1+nb)*rcc->buffer_rate - rcc->buffer_size;
1317             if( pbbits < space )
1318             {
1319                 q *= X264_MAX( pbbits / space,
1320                                bits / (0.5 * rcc->buffer_size) );
1321             }
1322             q = X264_MAX( q0-5, q );
1323         }
1324
1325         if( !rcc->b_vbv_min_rate )
1326             q = X264_MAX( q0, q );
1327     }
1328
1329     if(lmin==lmax)
1330         return lmin;
1331     else if(rcc->b_2pass)
1332     {
1333         double min2 = log(lmin);
1334         double max2 = log(lmax);
1335         q = (log(q) - min2)/(max2-min2) - 0.5;
1336         q = 1.0/(1.0 + exp(-4*q));
1337         q = q*(max2-min2) + min2;
1338         return exp(q);
1339     }
1340     else
1341         return x264_clip3f(q, lmin, lmax);
1342 }
1343
1344 // update qscale for 1 frame based on actual bits used so far
1345 static float rate_estimate_qscale( x264_t *h )
1346 {
1347     float q;
1348     x264_ratecontrol_t *rcc = h->rc;
1349     ratecontrol_entry_t rce;
1350     int pict_type = h->sh.i_type;
1351     double lmin = rcc->lmin[pict_type];
1352     double lmax = rcc->lmax[pict_type];
1353     int64_t total_bits = 8*(h->stat.i_slice_size[SLICE_TYPE_I]
1354                           + h->stat.i_slice_size[SLICE_TYPE_P]
1355                           + h->stat.i_slice_size[SLICE_TYPE_B]);
1356
1357     if( rcc->b_2pass )
1358     {
1359         rce = *rcc->rce;
1360         if(pict_type != rce.pict_type)
1361         {
1362             x264_log(h, X264_LOG_ERROR, "slice=%c but 2pass stats say %c\n",
1363                      slice_type_to_char[pict_type], slice_type_to_char[rce.pict_type]);
1364         }
1365     }
1366
1367     if( pict_type == SLICE_TYPE_B )
1368     {
1369         /* B-frames don't have independent ratecontrol, but rather get the
1370          * average QP of the two adjacent P-frames + an offset */
1371
1372         int i0 = IS_X264_TYPE_I(h->fref0[0]->i_type);
1373         int i1 = IS_X264_TYPE_I(h->fref1[0]->i_type);
1374         int dt0 = abs(h->fenc->i_poc - h->fref0[0]->i_poc);
1375         int dt1 = abs(h->fenc->i_poc - h->fref1[0]->i_poc);
1376         float q0 = h->fref0[0]->f_qp_avg_rc;
1377         float q1 = h->fref1[0]->f_qp_avg_rc;
1378
1379         if( h->fref0[0]->i_type == X264_TYPE_BREF )
1380             q0 -= rcc->pb_offset/2;
1381         if( h->fref1[0]->i_type == X264_TYPE_BREF )
1382             q1 -= rcc->pb_offset/2;
1383
1384         if(i0 && i1)
1385             q = (q0 + q1) / 2 + rcc->ip_offset;
1386         else if(i0)
1387             q = q1;
1388         else if(i1)
1389             q = q0;
1390         else
1391             q = (q0*dt1 + q1*dt0) / (dt0 + dt1);
1392
1393         if(h->fenc->b_kept_as_ref)
1394             q += rcc->pb_offset/2;
1395         else
1396             q += rcc->pb_offset;
1397
1398         rcc->frame_size_planned = predict_size( rcc->pred_b_from_p, q, h->fref1[h->i_ref1-1]->i_satd );
1399         x264_ratecontrol_set_estimated_size(h, rcc->frame_size_planned);
1400         rcc->last_satd = 0;
1401         return qp2qscale(q);
1402     }
1403     else
1404     {
1405         double abr_buffer = 2 * rcc->rate_tolerance * rcc->bitrate;
1406
1407         if( rcc->b_2pass )
1408         {
1409             //FIXME adjust abr_buffer based on distance to the end of the video
1410             int64_t diff;
1411             int64_t predicted_bits = total_bits;
1412
1413             if( rcc->b_vbv )
1414             {
1415                 if( h->param.i_threads > 1 )
1416                 {
1417                     int j = h->rc - h->thread[0]->rc;
1418                     int i;
1419                     for( i=1; i<h->param.i_threads; i++ )
1420                     {
1421                         x264_t *t = h->thread[ (j+i)%h->param.i_threads ];
1422                         double bits = t->rc->frame_size_planned;
1423                         if( !t->b_thread_active )
1424                             continue;
1425                         bits  = X264_MAX(bits, x264_ratecontrol_get_estimated_size(t));
1426                         predicted_bits += (int64_t)bits;
1427                     }
1428                 }
1429             }
1430             else
1431             {
1432                 if( h->fenc->i_frame < h->param.i_threads )
1433                     predicted_bits += (int64_t)h->fenc->i_frame * rcc->bitrate / rcc->fps;
1434                 else
1435                     predicted_bits += (int64_t)(h->param.i_threads - 1) * rcc->bitrate / rcc->fps;
1436             }
1437
1438             diff = predicted_bits - (int64_t)rce.expected_bits;
1439             q = rce.new_qscale;
1440             q /= x264_clip3f((double)(abr_buffer - diff) / abr_buffer, .5, 2);
1441             if( ((h->fenc->i_frame + 1 - h->param.i_threads) >= rcc->fps) &&
1442                 (rcc->expected_bits_sum > 0))
1443             {
1444                 /* Adjust quant based on the difference between
1445                  * achieved and expected bitrate so far */
1446                 double time = (double)h->fenc->i_frame / rcc->num_entries;
1447                 double w = x264_clip3f( time*100, 0.0, 1.0 );
1448                 q *= pow( (double)total_bits / rcc->expected_bits_sum, w );
1449             }
1450             if( rcc->b_vbv )
1451             {
1452                 /* Do not overflow vbv */
1453                 double expected_size = qscale2bits(&rce, q);
1454                 double expected_vbv = rcc->buffer_fill + rcc->buffer_rate - expected_size;
1455                 double expected_fullness =  rce.expected_vbv / rcc->buffer_size;
1456                 double qmax = q*(2 - expected_fullness);
1457                 double size_constraint = 1 + expected_fullness;
1458                 qmax = X264_MAX(qmax, rce.new_qscale);
1459                 if (expected_fullness < .05)
1460                     qmax = lmax;
1461                 qmax = X264_MIN(qmax, lmax);
1462                 while( ((expected_vbv < rce.expected_vbv/size_constraint) && (q < qmax)) ||
1463                         ((expected_vbv < 0) && (q < lmax)))
1464                 {
1465                     q *= 1.05;
1466                     expected_size = qscale2bits(&rce, q);
1467                     expected_vbv = rcc->buffer_fill + rcc->buffer_rate - expected_size;
1468                 }
1469                 rcc->last_satd = x264_rc_analyse_slice( h );
1470             }
1471             q = x264_clip3f( q, lmin, lmax );
1472         }
1473         else /* 1pass ABR */
1474         {
1475             /* Calculate the quantizer which would have produced the desired
1476              * average bitrate if it had been applied to all frames so far.
1477              * Then modulate that quant based on the current frame's complexity
1478              * relative to the average complexity so far (using the 2pass RCEQ).
1479              * Then bias the quant up or down if total size so far was far from
1480              * the target.
1481              * Result: Depending on the value of rate_tolerance, there is a
1482              * tradeoff between quality and bitrate precision. But at large
1483              * tolerances, the bit distribution approaches that of 2pass. */
1484
1485             double wanted_bits, overflow=1, lmin, lmax;
1486
1487             rcc->last_satd = x264_rc_analyse_slice( h );
1488             rcc->short_term_cplxsum *= 0.5;
1489             rcc->short_term_cplxcount *= 0.5;
1490             rcc->short_term_cplxsum += rcc->last_satd;
1491             rcc->short_term_cplxcount ++;
1492
1493             rce.tex_bits = rcc->last_satd;
1494             rce.blurred_complexity = rcc->short_term_cplxsum / rcc->short_term_cplxcount;
1495             rce.mv_bits = 0;
1496             rce.p_count = rcc->nmb;
1497             rce.i_count = 0;
1498             rce.s_count = 0;
1499             rce.qscale = 1;
1500             rce.pict_type = pict_type;
1501
1502             if( h->param.rc.i_rc_method == X264_RC_CRF )
1503             {
1504                 q = get_qscale( h, &rce, rcc->rate_factor_constant, h->fenc->i_frame );
1505             }
1506             else
1507             {
1508                 int i_frame_done = h->fenc->i_frame + 1 - h->param.i_threads;
1509
1510                 q = get_qscale( h, &rce, rcc->wanted_bits_window / rcc->cplxr_sum, h->fenc->i_frame );
1511
1512                 // FIXME is it simpler to keep track of wanted_bits in ratecontrol_end?
1513                 wanted_bits = i_frame_done * rcc->bitrate / rcc->fps;
1514                 if( wanted_bits > 0 )
1515                 {
1516                     abr_buffer *= X264_MAX( 1, sqrt(i_frame_done/25) );
1517                     overflow = x264_clip3f( 1.0 + (total_bits - wanted_bits) / abr_buffer, .5, 2 );
1518                     q *= overflow;
1519                 }
1520             }
1521
1522             if( pict_type == SLICE_TYPE_I && h->param.i_keyint_max > 1
1523                 /* should test _next_ pict type, but that isn't decided yet */
1524                 && rcc->last_non_b_pict_type != SLICE_TYPE_I )
1525             {
1526                 q = qp2qscale( rcc->accum_p_qp / rcc->accum_p_norm );
1527                 q /= fabs( h->param.rc.f_ip_factor );
1528             }
1529             else if( h->i_frame > 0 )
1530             {
1531                 /* Asymmetric clipping, because symmetric would prevent
1532                  * overflow control in areas of rapidly oscillating complexity */
1533                 lmin = rcc->last_qscale_for[pict_type] / rcc->lstep;
1534                 lmax = rcc->last_qscale_for[pict_type] * rcc->lstep;
1535                 if( overflow > 1.1 && h->i_frame > 3 )
1536                     lmax *= rcc->lstep;
1537                 else if( overflow < 0.9 )
1538                     lmin /= rcc->lstep;
1539
1540                 q = x264_clip3f(q, lmin, lmax);
1541             }
1542             else if( h->param.rc.i_rc_method == X264_RC_CRF )
1543             {
1544                 q = qp2qscale( ABR_INIT_QP ) / fabs( h->param.rc.f_ip_factor );
1545             }
1546
1547             //FIXME use get_diff_limited_q() ?
1548             q = clip_qscale( h, pict_type, q );
1549         }
1550
1551         rcc->last_qscale_for[pict_type] =
1552         rcc->last_qscale = q;
1553
1554         if( !(rcc->b_2pass && !rcc->b_vbv) && h->fenc->i_frame == 0 )
1555             rcc->last_qscale_for[SLICE_TYPE_P] = q;
1556
1557         if( rcc->b_2pass && rcc->b_vbv)
1558             rcc->frame_size_planned = qscale2bits(&rce, q);
1559         else
1560             rcc->frame_size_planned = predict_size( &rcc->pred[h->sh.i_type], q, rcc->last_satd );
1561         x264_ratecontrol_set_estimated_size(h, rcc->frame_size_planned);
1562         return q;
1563     }
1564 }
1565
1566 void x264_thread_sync_ratecontrol( x264_t *cur, x264_t *prev, x264_t *next )
1567 {
1568     if( cur != prev )
1569     {
1570 #define COPY(var) memcpy(&cur->rc->var, &prev->rc->var, sizeof(cur->rc->var))
1571         /* these vars are updated in x264_ratecontrol_start()
1572          * so copy them from the context that most recently started (prev)
1573          * to the context that's about to start (cur).
1574          */
1575         COPY(accum_p_qp);
1576         COPY(accum_p_norm);
1577         COPY(last_satd);
1578         COPY(last_rceq);
1579         COPY(last_qscale_for);
1580         COPY(last_non_b_pict_type);
1581         COPY(short_term_cplxsum);
1582         COPY(short_term_cplxcount);
1583         COPY(bframes);
1584         COPY(prev_zone);
1585 #undef COPY
1586     }
1587     if( cur != next )
1588     {
1589 #define COPY(var) next->rc->var = cur->rc->var
1590         /* these vars are updated in x264_ratecontrol_end()
1591          * so copy them from the context that most recently ended (cur)
1592          * to the context that's about to end (next)
1593          */
1594         COPY(cplxr_sum);
1595         COPY(expected_bits_sum);
1596         COPY(wanted_bits_window);
1597         COPY(bframe_bits);
1598 #undef COPY
1599     }
1600     //FIXME row_preds[] (not strictly necessary, but would improve prediction)
1601     /* the rest of the variables are either constant or thread-local */
1602 }
1603
1604 static int find_underflow( x264_t *h, double *fills, int *t0, int *t1, int over )
1605 {
1606     /* find an interval ending on an overflow or underflow (depending on whether
1607      * we're adding or removing bits), and starting on the earliest frame that
1608      * can influence the buffer fill of that end frame. */
1609     x264_ratecontrol_t *rcc = h->rc;
1610     const double buffer_min = (over ? .1 : .1) * rcc->buffer_size;
1611     const double buffer_max = .9 * rcc->buffer_size;
1612     double fill = fills[*t0-1];
1613     double parity = over ? 1. : -1.;
1614     int i, start=-1, end=-1;
1615     for(i = *t0; i < rcc->num_entries; i++)
1616     {
1617         fill += (rcc->buffer_rate - qscale2bits(&rcc->entry[i], rcc->entry[i].new_qscale)) * parity;
1618         fill = x264_clip3f(fill, 0, rcc->buffer_size);
1619         fills[i] = fill;
1620         if(fill <= buffer_min || i == 0)
1621         {
1622             if(end >= 0)
1623                 break;
1624             start = i;
1625         }
1626         else if(fill >= buffer_max && start >= 0)
1627             end = i;
1628     }
1629     *t0 = start;
1630     *t1 = end;
1631     return start>=0 && end>=0;
1632 }
1633
1634 static int fix_underflow( x264_t *h, int t0, int t1, double adjustment, double qscale_min, double qscale_max)
1635 {
1636     x264_ratecontrol_t *rcc = h->rc;
1637     double qscale_orig, qscale_new;
1638     int i;
1639     int adjusted = 0;
1640     if(t0 > 0)
1641         t0++;
1642     for(i = t0; i <= t1; i++)
1643     {
1644         qscale_orig = rcc->entry[i].new_qscale;
1645         qscale_orig = x264_clip3f(qscale_orig, qscale_min, qscale_max);
1646         qscale_new  = qscale_orig * adjustment;
1647         qscale_new  = x264_clip3f(qscale_new, qscale_min, qscale_max);
1648         rcc->entry[i].new_qscale = qscale_new;
1649         adjusted = adjusted || (qscale_new != qscale_orig);
1650     }
1651     return adjusted;
1652 }
1653
1654 static double count_expected_bits( x264_t *h )
1655 {
1656     x264_ratecontrol_t *rcc = h->rc;
1657     double expected_bits = 0;
1658     int i;
1659     for(i = 0; i < rcc->num_entries; i++)
1660     {
1661         ratecontrol_entry_t *rce = &rcc->entry[i];
1662         rce->expected_bits = expected_bits;
1663         expected_bits += qscale2bits(rce, rce->new_qscale);
1664     }
1665     return expected_bits;
1666 }
1667
1668 static void vbv_pass2( x264_t *h )
1669 {
1670     /* for each interval of buffer_full .. underflow, uniformly increase the qp of all
1671      * frames in the interval until either buffer is full at some intermediate frame or the
1672      * last frame in the interval no longer underflows.  Recompute intervals and repeat.
1673      * Then do the converse to put bits back into overflow areas until target size is met */
1674
1675     x264_ratecontrol_t *rcc = h->rc;
1676     double *fills = x264_malloc((rcc->num_entries+1)*sizeof(double));
1677     double all_available_bits = h->param.rc.i_bitrate * 1000. * rcc->num_entries / rcc->fps;
1678     double expected_bits = 0;
1679     double adjustment;
1680     double prev_bits = 0;
1681     int i, t0, t1;
1682     double qscale_min = qp2qscale(h->param.rc.i_qp_min);
1683     double qscale_max = qp2qscale(h->param.rc.i_qp_max);
1684     int iterations = 0;
1685     int adj_min, adj_max;
1686
1687     fills++;
1688
1689     /* adjust overall stream size */
1690     do
1691     {
1692         iterations++;
1693         prev_bits = expected_bits;
1694
1695         if(expected_bits != 0)
1696         {   /* not first iteration */
1697             adjustment = X264_MAX(X264_MIN(expected_bits / all_available_bits, 0.999), 0.9);
1698             fills[-1] = rcc->buffer_size * h->param.rc.f_vbv_buffer_init;
1699             t0 = 0;
1700             /* fix overflows */
1701             adj_min = 1;
1702             while(adj_min && find_underflow(h, fills, &t0, &t1, 1))
1703             {
1704                 adj_min = fix_underflow(h, t0, t1, adjustment, qscale_min, qscale_max);
1705                 t0 = t1;
1706             }
1707         }
1708
1709         fills[-1] = rcc->buffer_size * (1. - h->param.rc.f_vbv_buffer_init);
1710         t0 = 0;
1711         /* fix underflows -- should be done after overflow, as we'd better undersize target than underflowing VBV */
1712         adj_max = 1;
1713         while(adj_max && find_underflow(h, fills, &t0, &t1, 0))
1714             adj_max = fix_underflow(h, t0, t1, 1.001, qscale_min, qscale_max);
1715
1716         expected_bits = count_expected_bits(h);
1717     } while((expected_bits < .995*all_available_bits) && ((int)(expected_bits+.5) > (int)(prev_bits+.5)) );
1718
1719     if (!adj_max)
1720         x264_log( h, X264_LOG_WARNING, "vbv-maxrate issue, qpmax or vbv-maxrate too low\n");
1721
1722     /* store expected vbv filling values for tracking when encoding */
1723     for(i = 0; i < rcc->num_entries; i++)
1724         rcc->entry[i].expected_vbv = rcc->buffer_size - fills[i];
1725
1726     x264_free(fills-1);
1727 }
1728
1729 static int init_pass2( x264_t *h )
1730 {
1731     x264_ratecontrol_t *rcc = h->rc;
1732     uint64_t all_const_bits = 0;
1733     uint64_t all_available_bits = (uint64_t)(h->param.rc.i_bitrate * 1000. * rcc->num_entries / rcc->fps);
1734     double rate_factor, step, step_mult;
1735     double qblur = h->param.rc.f_qblur;
1736     double cplxblur = h->param.rc.f_complexity_blur;
1737     const int filter_size = (int)(qblur*4) | 1;
1738     double expected_bits;
1739     double *qscale, *blurred_qscale;
1740     int i;
1741
1742     /* find total/average complexity & const_bits */
1743     for(i=0; i<rcc->num_entries; i++)
1744     {
1745         ratecontrol_entry_t *rce = &rcc->entry[i];
1746         all_const_bits += rce->misc_bits;
1747     }
1748
1749     if( all_available_bits < all_const_bits)
1750     {
1751         x264_log(h, X264_LOG_ERROR, "requested bitrate is too low. estimated minimum is %d kbps\n",
1752                  (int)(all_const_bits * rcc->fps / (rcc->num_entries * 1000.)));
1753         return -1;
1754     }
1755
1756     /* Blur complexities, to reduce local fluctuation of QP.
1757      * We don't blur the QPs directly, because then one very simple frame
1758      * could drag down the QP of a nearby complex frame and give it more
1759      * bits than intended. */
1760     for(i=0; i<rcc->num_entries; i++)
1761     {
1762         ratecontrol_entry_t *rce = &rcc->entry[i];
1763         double weight_sum = 0;
1764         double cplx_sum = 0;
1765         double weight = 1.0;
1766         double gaussian_weight;
1767         int j;
1768         /* weighted average of cplx of future frames */
1769         for(j=1; j<cplxblur*2 && j<rcc->num_entries-i; j++)
1770         {
1771             ratecontrol_entry_t *rcj = &rcc->entry[i+j];
1772             weight *= 1 - pow( (float)rcj->i_count / rcc->nmb, 2 );
1773             if(weight < .0001)
1774                 break;
1775             gaussian_weight = weight * exp(-j*j/200.0);
1776             weight_sum += gaussian_weight;
1777             cplx_sum += gaussian_weight * (qscale2bits(rcj, 1) - rcj->misc_bits);
1778         }
1779         /* weighted average of cplx of past frames */
1780         weight = 1.0;
1781         for(j=0; j<=cplxblur*2 && j<=i; j++)
1782         {
1783             ratecontrol_entry_t *rcj = &rcc->entry[i-j];
1784             gaussian_weight = weight * exp(-j*j/200.0);
1785             weight_sum += gaussian_weight;
1786             cplx_sum += gaussian_weight * (qscale2bits(rcj, 1) - rcj->misc_bits);
1787             weight *= 1 - pow( (float)rcj->i_count / rcc->nmb, 2 );
1788             if(weight < .0001)
1789                 break;
1790         }
1791         rce->blurred_complexity = cplx_sum / weight_sum;
1792     }
1793
1794     qscale = x264_malloc(sizeof(double)*rcc->num_entries);
1795     if(filter_size > 1)
1796         blurred_qscale = x264_malloc(sizeof(double)*rcc->num_entries);
1797     else
1798         blurred_qscale = qscale;
1799
1800     /* Search for a factor which, when multiplied by the RCEQ values from
1801      * each frame, adds up to the desired total size.
1802      * There is no exact closed-form solution because of VBV constraints and
1803      * because qscale2bits is not invertible, but we can start with the simple
1804      * approximation of scaling the 1st pass by the ratio of bitrates.
1805      * The search range is probably overkill, but speed doesn't matter here. */
1806
1807     expected_bits = 1;
1808     for(i=0; i<rcc->num_entries; i++)
1809         expected_bits += qscale2bits(&rcc->entry[i], get_qscale(h, &rcc->entry[i], 1.0, i));
1810     step_mult = all_available_bits / expected_bits;
1811
1812     rate_factor = 0;
1813     for(step = 1E4 * step_mult; step > 1E-7 * step_mult; step *= 0.5)
1814     {
1815         expected_bits = 0;
1816         rate_factor += step;
1817
1818         rcc->last_non_b_pict_type = -1;
1819         rcc->last_accum_p_norm = 1;
1820         rcc->accum_p_norm = 0;
1821
1822         /* find qscale */
1823         for(i=0; i<rcc->num_entries; i++)
1824         {
1825             qscale[i] = get_qscale(h, &rcc->entry[i], rate_factor, i);
1826         }
1827
1828         /* fixed I/B qscale relative to P */
1829         for(i=rcc->num_entries-1; i>=0; i--)
1830         {
1831             qscale[i] = get_diff_limited_q(h, &rcc->entry[i], qscale[i]);
1832             assert(qscale[i] >= 0);
1833         }
1834
1835         /* smooth curve */
1836         if(filter_size > 1)
1837         {
1838             assert(filter_size%2==1);
1839             for(i=0; i<rcc->num_entries; i++)
1840             {
1841                 ratecontrol_entry_t *rce = &rcc->entry[i];
1842                 int j;
1843                 double q=0.0, sum=0.0;
1844
1845                 for(j=0; j<filter_size; j++)
1846                 {
1847                     int index = i+j-filter_size/2;
1848                     double d = index-i;
1849                     double coeff = qblur==0 ? 1.0 : exp(-d*d/(qblur*qblur));
1850                     if(index < 0 || index >= rcc->num_entries)
1851                         continue;
1852                     if(rce->pict_type != rcc->entry[index].pict_type)
1853                         continue;
1854                     q += qscale[index] * coeff;
1855                     sum += coeff;
1856                 }
1857                 blurred_qscale[i] = q/sum;
1858             }
1859         }
1860
1861         /* find expected bits */
1862         for(i=0; i<rcc->num_entries; i++)
1863         {
1864             ratecontrol_entry_t *rce = &rcc->entry[i];
1865             rce->new_qscale = clip_qscale(h, rce->pict_type, blurred_qscale[i]);
1866             assert(rce->new_qscale >= 0);
1867             expected_bits += qscale2bits(rce, rce->new_qscale);
1868         }
1869
1870         if(expected_bits > all_available_bits) rate_factor -= step;
1871     }
1872
1873     x264_free(qscale);
1874     if(filter_size > 1)
1875         x264_free(blurred_qscale);
1876
1877     if(rcc->b_vbv)
1878         vbv_pass2(h);
1879     expected_bits = count_expected_bits(h);
1880
1881     if(fabs(expected_bits/all_available_bits - 1.0) > 0.01)
1882     {
1883         double avgq = 0;
1884         for(i=0; i<rcc->num_entries; i++)
1885             avgq += rcc->entry[i].new_qscale;
1886         avgq = qscale2qp(avgq / rcc->num_entries);
1887
1888         if ((expected_bits > all_available_bits) || (!rcc->b_vbv))
1889             x264_log(h, X264_LOG_WARNING, "Error: 2pass curve failed to converge\n");
1890         x264_log(h, X264_LOG_WARNING, "target: %.2f kbit/s, expected: %.2f kbit/s, avg QP: %.4f\n",
1891                  (float)h->param.rc.i_bitrate,
1892                  expected_bits * rcc->fps / (rcc->num_entries * 1000.),
1893                  avgq);
1894         if(expected_bits < all_available_bits && avgq < h->param.rc.i_qp_min + 2)
1895         {
1896             if(h->param.rc.i_qp_min > 0)
1897                 x264_log(h, X264_LOG_WARNING, "try reducing target bitrate or reducing qp_min (currently %d)\n", h->param.rc.i_qp_min);
1898             else
1899                 x264_log(h, X264_LOG_WARNING, "try reducing target bitrate\n");
1900         }
1901         else if(expected_bits > all_available_bits && avgq > h->param.rc.i_qp_max - 2)
1902         {
1903             if(h->param.rc.i_qp_max < 51)
1904                 x264_log(h, X264_LOG_WARNING, "try increasing target bitrate or increasing qp_max (currently %d)\n", h->param.rc.i_qp_max);
1905             else
1906                 x264_log(h, X264_LOG_WARNING, "try increasing target bitrate\n");
1907         }
1908         else if(!(rcc->b_2pass && rcc->b_vbv))
1909             x264_log(h, X264_LOG_WARNING, "internal error\n");
1910     }
1911
1912     return 0;
1913 }
1914
1915