7a89293347f5261d66f27a0e7dfebbc90217198e
[ffmpeg.git] / libavcodec / ratecontrol.c
1 /*
2  * Rate control for video encoders
3  *
4  * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * Rate control for video encoders.
26  */
27
28 #include "libavutil/intmath.h"
29 #include "avcodec.h"
30 #include "dsputil.h"
31 #include "ratecontrol.h"
32 #include "mpegvideo.h"
33 #include "libavutil/eval.h"
34
35 #undef NDEBUG // Always check asserts, the speed effect is far too small to disable them.
36 #include <assert.h>
37
38 #ifndef M_E
39 #define M_E 2.718281828
40 #endif
41
42 static int init_pass2(MpegEncContext *s);
43 static double get_qscale(MpegEncContext *s, RateControlEntry *rce,
44                          double rate_factor, int frame_num);
45
46 void ff_write_pass1_stats(MpegEncContext *s)
47 {
48     snprintf(s->avctx->stats_out, 256,
49              "in:%d out:%d type:%d q:%d itex:%d ptex:%d mv:%d misc:%d "
50              "fcode:%d bcode:%d mc-var:%d var:%d icount:%d skipcount:%d hbits:%d;\n",
51              s->current_picture_ptr->f.display_picture_number,
52              s->current_picture_ptr->f.coded_picture_number,
53              s->pict_type,
54              s->current_picture.f.quality,
55              s->i_tex_bits,
56              s->p_tex_bits,
57              s->mv_bits,
58              s->misc_bits,
59              s->f_code,
60              s->b_code,
61              s->current_picture.mc_mb_var_sum,
62              s->current_picture.mb_var_sum,
63              s->i_count, s->skip_count,
64              s->header_bits);
65 }
66
67 static double get_fps(AVCodecContext *avctx)
68 {
69     return 1.0 / av_q2d(avctx->time_base) / FFMAX(avctx->ticks_per_frame, 1);
70 }
71
72 static inline double qp2bits(RateControlEntry *rce, double qp)
73 {
74     if (qp <= 0.0) {
75         av_log(NULL, AV_LOG_ERROR, "qp<=0.0\n");
76     }
77     return rce->qscale * (double)(rce->i_tex_bits + rce->p_tex_bits + 1) / qp;
78 }
79
80 static inline double bits2qp(RateControlEntry *rce, double bits)
81 {
82     if (bits < 0.9) {
83         av_log(NULL, AV_LOG_ERROR, "bits<0.9\n");
84     }
85     return rce->qscale * (double)(rce->i_tex_bits + rce->p_tex_bits + 1) / bits;
86 }
87
88 int ff_rate_control_init(MpegEncContext *s)
89 {
90     RateControlContext *rcc = &s->rc_context;
91     int i, res;
92     static const char * const const_names[] = {
93         "PI",
94         "E",
95         "iTex",
96         "pTex",
97         "tex",
98         "mv",
99         "fCode",
100         "iCount",
101         "mcVar",
102         "var",
103         "isI",
104         "isP",
105         "isB",
106         "avgQP",
107         "qComp",
108 #if 0
109         "lastIQP",
110         "lastPQP",
111         "lastBQP",
112         "nextNonBQP",
113 #endif
114         "avgIITex",
115         "avgPITex",
116         "avgPPTex",
117         "avgBPTex",
118         "avgTex",
119         NULL
120     };
121     static double (* const func1[])(void *, double) = {
122         (void *)bits2qp,
123         (void *)qp2bits,
124         NULL
125     };
126     static const char * const func1_names[] = {
127         "bits2qp",
128         "qp2bits",
129         NULL
130     };
131     emms_c();
132
133     if (!s->avctx->rc_max_available_vbv_use && s->avctx->rc_buffer_size) {
134         if (s->avctx->rc_max_rate) {
135             s->avctx->rc_max_available_vbv_use = av_clipf(s->avctx->rc_max_rate/(s->avctx->rc_buffer_size*get_fps(s->avctx)), 1.0/3, 1.0);
136         } else
137             s->avctx->rc_max_available_vbv_use = 1.0;
138     }
139
140     res = av_expr_parse(&rcc->rc_eq_eval,
141                         s->avctx->rc_eq ? s->avctx->rc_eq : "tex^qComp",
142                         const_names, func1_names, func1,
143                         NULL, NULL, 0, s->avctx);
144     if (res < 0) {
145         av_log(s->avctx, AV_LOG_ERROR, "Error parsing rc_eq \"%s\"\n", s->avctx->rc_eq);
146         return res;
147     }
148
149     for (i = 0; i < 5; i++) {
150         rcc->pred[i].coeff = FF_QP2LAMBDA * 7.0;
151         rcc->pred[i].count = 1.0;
152         rcc->pred[i].decay = 0.4;
153
154         rcc->i_cplx_sum [i] =
155         rcc->p_cplx_sum [i] =
156         rcc->mv_bits_sum[i] =
157         rcc->qscale_sum [i] =
158         rcc->frame_count[i] = 1; // 1 is better because of 1/0 and such
159
160         rcc->last_qscale_for[i] = FF_QP2LAMBDA * 5;
161     }
162     rcc->buffer_index = s->avctx->rc_initial_buffer_occupancy;
163     if (!rcc->buffer_index)
164         rcc->buffer_index = s->avctx->rc_buffer_size * 3 / 4;
165
166     if (s->flags & CODEC_FLAG_PASS2) {
167         int i;
168         char *p;
169
170         /* find number of pics */
171         p = s->avctx->stats_in;
172         for (i = -1; p; i++)
173             p = strchr(p + 1, ';');
174         i += s->max_b_frames;
175         if (i <= 0 || i >= INT_MAX / sizeof(RateControlEntry))
176             return -1;
177         rcc->entry       = av_mallocz(i * sizeof(RateControlEntry));
178         rcc->num_entries = i;
179
180         /* init all to skipped p frames
181          * (with b frames we might have a not encoded frame at the end FIXME) */
182         for (i = 0; i < rcc->num_entries; i++) {
183             RateControlEntry *rce = &rcc->entry[i];
184
185             rce->pict_type  = rce->new_pict_type = AV_PICTURE_TYPE_P;
186             rce->qscale     = rce->new_qscale    = FF_QP2LAMBDA * 2;
187             rce->misc_bits  = s->mb_num + 10;
188             rce->mb_var_sum = s->mb_num * 100;
189         }
190
191         /* read stats */
192         p = s->avctx->stats_in;
193         for (i = 0; i < rcc->num_entries - s->max_b_frames; i++) {
194             RateControlEntry *rce;
195             int picture_number;
196             int e;
197             char *next;
198
199             next = strchr(p, ';');
200             if (next) {
201                 (*next) = 0; // sscanf in unbelievably slow on looong strings // FIXME copy / do not write
202                 next++;
203             }
204             e = sscanf(p, " in:%d ", &picture_number);
205
206             assert(picture_number >= 0);
207             assert(picture_number < rcc->num_entries);
208             rce = &rcc->entry[picture_number];
209
210             e += sscanf(p, " in:%*d out:%*d type:%d q:%f itex:%d ptex:%d mv:%d misc:%d fcode:%d bcode:%d mc-var:%d var:%d icount:%d skipcount:%d hbits:%d",
211                         &rce->pict_type, &rce->qscale, &rce->i_tex_bits, &rce->p_tex_bits,
212                         &rce->mv_bits, &rce->misc_bits,
213                         &rce->f_code, &rce->b_code,
214                         &rce->mc_mb_var_sum, &rce->mb_var_sum,
215                         &rce->i_count, &rce->skip_count, &rce->header_bits);
216             if (e != 14) {
217                 av_log(s->avctx, AV_LOG_ERROR,
218                        "statistics are damaged at line %d, parser out=%d\n",
219                        i, e);
220                 return -1;
221             }
222
223             p = next;
224         }
225
226         if (init_pass2(s) < 0)
227             return -1;
228
229         // FIXME maybe move to end
230         if ((s->flags & CODEC_FLAG_PASS2) && s->avctx->rc_strategy == FF_RC_STRATEGY_XVID) {
231 #if CONFIG_LIBXVID
232             return ff_xvid_rate_control_init(s);
233 #else
234             av_log(s->avctx, AV_LOG_ERROR,
235                    "Xvid ratecontrol requires libavcodec compiled with Xvid support.\n");
236             return -1;
237 #endif
238         }
239     }
240
241     if (!(s->flags & CODEC_FLAG_PASS2)) {
242         rcc->short_term_qsum   = 0.001;
243         rcc->short_term_qcount = 0.001;
244
245         rcc->pass1_rc_eq_output_sum = 0.001;
246         rcc->pass1_wanted_bits      = 0.001;
247
248         if (s->avctx->qblur > 1.0) {
249             av_log(s->avctx, AV_LOG_ERROR, "qblur too large\n");
250             return -1;
251         }
252         /* init stuff with the user specified complexity */
253         if (s->avctx->rc_initial_cplx) {
254             for (i = 0; i < 60 * 30; i++) {
255                 double bits = s->avctx->rc_initial_cplx * (i / 10000.0 + 1.0) * s->mb_num;
256                 RateControlEntry rce;
257
258                 if (i % ((s->gop_size + 3) / 4) == 0)
259                     rce.pict_type = AV_PICTURE_TYPE_I;
260                 else if (i % (s->max_b_frames + 1))
261                     rce.pict_type = AV_PICTURE_TYPE_B;
262                 else
263                     rce.pict_type = AV_PICTURE_TYPE_P;
264
265                 rce.new_pict_type = rce.pict_type;
266                 rce.mc_mb_var_sum = bits * s->mb_num / 100000;
267                 rce.mb_var_sum    = s->mb_num;
268
269                 rce.qscale    = FF_QP2LAMBDA * 2;
270                 rce.f_code    = 2;
271                 rce.b_code    = 1;
272                 rce.misc_bits = 1;
273
274                 if (s->pict_type == AV_PICTURE_TYPE_I) {
275                     rce.i_count    = s->mb_num;
276                     rce.i_tex_bits = bits;
277                     rce.p_tex_bits = 0;
278                     rce.mv_bits    = 0;
279                 } else {
280                     rce.i_count    = 0; // FIXME we do know this approx
281                     rce.i_tex_bits = 0;
282                     rce.p_tex_bits = bits * 0.9;
283                     rce.mv_bits    = bits * 0.1;
284                 }
285                 rcc->i_cplx_sum[rce.pict_type]  += rce.i_tex_bits * rce.qscale;
286                 rcc->p_cplx_sum[rce.pict_type]  += rce.p_tex_bits * rce.qscale;
287                 rcc->mv_bits_sum[rce.pict_type] += rce.mv_bits;
288                 rcc->frame_count[rce.pict_type]++;
289
290                 get_qscale(s, &rce, rcc->pass1_wanted_bits / rcc->pass1_rc_eq_output_sum, i);
291
292                 // FIXME misbehaves a little for variable fps
293                 rcc->pass1_wanted_bits += s->bit_rate / get_fps(s->avctx);
294             }
295         }
296     }
297
298     return 0;
299 }
300
301 void ff_rate_control_uninit(MpegEncContext *s)
302 {
303     RateControlContext *rcc = &s->rc_context;
304     emms_c();
305
306     av_expr_free(rcc->rc_eq_eval);
307     av_freep(&rcc->entry);
308
309 #if CONFIG_LIBXVID
310     if ((s->flags & CODEC_FLAG_PASS2) && s->avctx->rc_strategy == FF_RC_STRATEGY_XVID)
311         ff_xvid_rate_control_uninit(s);
312 #endif
313 }
314
315 int ff_vbv_update(MpegEncContext *s, int frame_size)
316 {
317     RateControlContext *rcc = &s->rc_context;
318     const double fps        = get_fps(s->avctx);
319     const int buffer_size   = s->avctx->rc_buffer_size;
320     const double min_rate   = s->avctx->rc_min_rate / fps;
321     const double max_rate   = s->avctx->rc_max_rate / fps;
322
323     av_dlog(s, "%d %f %d %f %f\n",
324             buffer_size, rcc->buffer_index, frame_size, min_rate, max_rate);
325
326     if (buffer_size) {
327         int left;
328
329         rcc->buffer_index -= frame_size;
330         if (rcc->buffer_index < 0) {
331             av_log(s->avctx, AV_LOG_ERROR, "rc buffer underflow\n");
332             rcc->buffer_index = 0;
333         }
334
335         left = buffer_size - rcc->buffer_index - 1;
336         rcc->buffer_index += av_clip(left, min_rate, max_rate);
337
338         if (rcc->buffer_index > buffer_size) {
339             int stuffing = ceil((rcc->buffer_index - buffer_size) / 8);
340
341             if (stuffing < 4 && s->codec_id == AV_CODEC_ID_MPEG4)
342                 stuffing = 4;
343             rcc->buffer_index -= 8 * stuffing;
344
345             if (s->avctx->debug & FF_DEBUG_RC)
346                 av_log(s->avctx, AV_LOG_DEBUG, "stuffing %d bytes\n", stuffing);
347
348             return stuffing;
349         }
350     }
351     return 0;
352 }
353
354 /**
355  * Modify the bitrate curve from pass1 for one frame.
356  */
357 static double get_qscale(MpegEncContext *s, RateControlEntry *rce,
358                          double rate_factor, int frame_num)
359 {
360     RateControlContext *rcc = &s->rc_context;
361     AVCodecContext *a       = s->avctx;
362     const int pict_type     = rce->new_pict_type;
363     const double mb_num     = s->mb_num;
364     double q, bits;
365     int i;
366
367     double const_values[] = {
368         M_PI,
369         M_E,
370         rce->i_tex_bits * rce->qscale,
371         rce->p_tex_bits * rce->qscale,
372         (rce->i_tex_bits + rce->p_tex_bits) * (double)rce->qscale,
373         rce->mv_bits / mb_num,
374         rce->pict_type == AV_PICTURE_TYPE_B ? (rce->f_code + rce->b_code) * 0.5 : rce->f_code,
375         rce->i_count / mb_num,
376         rce->mc_mb_var_sum / mb_num,
377         rce->mb_var_sum / mb_num,
378         rce->pict_type == AV_PICTURE_TYPE_I,
379         rce->pict_type == AV_PICTURE_TYPE_P,
380         rce->pict_type == AV_PICTURE_TYPE_B,
381         rcc->qscale_sum[pict_type] / (double)rcc->frame_count[pict_type],
382         a->qcompress,
383 #if 0
384         rcc->last_qscale_for[AV_PICTURE_TYPE_I],
385         rcc->last_qscale_for[AV_PICTURE_TYPE_P],
386         rcc->last_qscale_for[AV_PICTURE_TYPE_B],
387         rcc->next_non_b_qscale,
388 #endif
389         rcc->i_cplx_sum[AV_PICTURE_TYPE_I] / (double)rcc->frame_count[AV_PICTURE_TYPE_I],
390         rcc->i_cplx_sum[AV_PICTURE_TYPE_P] / (double)rcc->frame_count[AV_PICTURE_TYPE_P],
391         rcc->p_cplx_sum[AV_PICTURE_TYPE_P] / (double)rcc->frame_count[AV_PICTURE_TYPE_P],
392         rcc->p_cplx_sum[AV_PICTURE_TYPE_B] / (double)rcc->frame_count[AV_PICTURE_TYPE_B],
393         (rcc->i_cplx_sum[pict_type] + rcc->p_cplx_sum[pict_type]) / (double)rcc->frame_count[pict_type],
394         0
395     };
396
397     bits = av_expr_eval(rcc->rc_eq_eval, const_values, rce);
398     if (isnan(bits)) {
399         av_log(s->avctx, AV_LOG_ERROR, "Error evaluating rc_eq \"%s\"\n", s->avctx->rc_eq);
400         return -1;
401     }
402
403     rcc->pass1_rc_eq_output_sum += bits;
404     bits *= rate_factor;
405     if (bits < 0.0)
406         bits = 0.0;
407     bits += 1.0; // avoid 1/0 issues
408
409     /* user override */
410     for (i = 0; i < s->avctx->rc_override_count; i++) {
411         RcOverride *rco = s->avctx->rc_override;
412         if (rco[i].start_frame > frame_num)
413             continue;
414         if (rco[i].end_frame < frame_num)
415             continue;
416
417         if (rco[i].qscale)
418             bits = qp2bits(rce, rco[i].qscale);  // FIXME move at end to really force it?
419         else
420             bits *= rco[i].quality_factor;
421     }
422
423     q = bits2qp(rce, bits);
424
425     /* I/B difference */
426     if (pict_type == AV_PICTURE_TYPE_I && s->avctx->i_quant_factor < 0.0)
427         q = -q * s->avctx->i_quant_factor + s->avctx->i_quant_offset;
428     else if (pict_type == AV_PICTURE_TYPE_B && s->avctx->b_quant_factor < 0.0)
429         q = -q * s->avctx->b_quant_factor + s->avctx->b_quant_offset;
430     if (q < 1)
431         q = 1;
432
433     return q;
434 }
435
436 static double get_diff_limited_q(MpegEncContext *s, RateControlEntry *rce, double q)
437 {
438     RateControlContext *rcc   = &s->rc_context;
439     AVCodecContext *a         = s->avctx;
440     const int pict_type       = rce->new_pict_type;
441     const double last_p_q     = rcc->last_qscale_for[AV_PICTURE_TYPE_P];
442     const double last_non_b_q = rcc->last_qscale_for[rcc->last_non_b_pict_type];
443
444     if (pict_type == AV_PICTURE_TYPE_I &&
445         (a->i_quant_factor > 0.0 || rcc->last_non_b_pict_type == AV_PICTURE_TYPE_P))
446         q = last_p_q * FFABS(a->i_quant_factor) + a->i_quant_offset;
447     else if (pict_type == AV_PICTURE_TYPE_B &&
448              a->b_quant_factor > 0.0)
449         q = last_non_b_q * a->b_quant_factor + a->b_quant_offset;
450     if (q < 1)
451         q = 1;
452
453     /* last qscale / qdiff stuff */
454     if (rcc->last_non_b_pict_type == pict_type || pict_type != AV_PICTURE_TYPE_I) {
455         double last_q     = rcc->last_qscale_for[pict_type];
456         const int maxdiff = FF_QP2LAMBDA * a->max_qdiff;
457
458         if (q > last_q + maxdiff)
459             q = last_q + maxdiff;
460         else if (q < last_q - maxdiff)
461             q = last_q - maxdiff;
462     }
463
464     rcc->last_qscale_for[pict_type] = q; // Note we cannot do that after blurring
465
466     if (pict_type != AV_PICTURE_TYPE_B)
467         rcc->last_non_b_pict_type = pict_type;
468
469     return q;
470 }
471
472 /**
473  * Get the qmin & qmax for pict_type.
474  */
475 static void get_qminmax(int *qmin_ret, int *qmax_ret, MpegEncContext *s, int pict_type)
476 {
477     int qmin = s->avctx->lmin;
478     int qmax = s->avctx->lmax;
479
480     assert(qmin <= qmax);
481
482     switch (pict_type) {
483     case AV_PICTURE_TYPE_B:
484         qmin = (int)(qmin * FFABS(s->avctx->b_quant_factor) + s->avctx->b_quant_offset + 0.5);
485         qmax = (int)(qmax * FFABS(s->avctx->b_quant_factor) + s->avctx->b_quant_offset + 0.5);
486         break;
487     case AV_PICTURE_TYPE_I:
488         qmin = (int)(qmin * FFABS(s->avctx->i_quant_factor) + s->avctx->i_quant_offset + 0.5);
489         qmax = (int)(qmax * FFABS(s->avctx->i_quant_factor) + s->avctx->i_quant_offset + 0.5);
490         break;
491     }
492
493     qmin = av_clip(qmin, 1, FF_LAMBDA_MAX);
494     qmax = av_clip(qmax, 1, FF_LAMBDA_MAX);
495
496     if (qmax < qmin)
497         qmax = qmin;
498
499     *qmin_ret = qmin;
500     *qmax_ret = qmax;
501 }
502
503 static double modify_qscale(MpegEncContext *s, RateControlEntry *rce,
504                             double q, int frame_num)
505 {
506     RateControlContext *rcc  = &s->rc_context;
507     const double buffer_size = s->avctx->rc_buffer_size;
508     const double fps         = get_fps(s->avctx);
509     const double min_rate    = s->avctx->rc_min_rate / fps;
510     const double max_rate    = s->avctx->rc_max_rate / fps;
511     const int pict_type      = rce->new_pict_type;
512     int qmin, qmax;
513
514     get_qminmax(&qmin, &qmax, s, pict_type);
515
516     /* modulation */
517     if (s->avctx->rc_qmod_freq &&
518         frame_num % s->avctx->rc_qmod_freq == 0 &&
519         pict_type == AV_PICTURE_TYPE_P)
520         q *= s->avctx->rc_qmod_amp;
521
522     /* buffer overflow/underflow protection */
523     if (buffer_size) {
524         double expected_size = rcc->buffer_index;
525         double q_limit;
526
527         if (min_rate) {
528             double d = 2 * (buffer_size - expected_size) / buffer_size;
529             if (d > 1.0)
530                 d = 1.0;
531             else if (d < 0.0001)
532                 d = 0.0001;
533             q *= pow(d, 1.0 / s->avctx->rc_buffer_aggressivity);
534
535             q_limit = bits2qp(rce,
536                               FFMAX((min_rate - buffer_size + rcc->buffer_index) *
537                                     s->avctx->rc_min_vbv_overflow_use, 1));
538
539             if (q > q_limit) {
540                 if (s->avctx->debug & FF_DEBUG_RC)
541                     av_log(s->avctx, AV_LOG_DEBUG,
542                            "limiting QP %f -> %f\n", q, q_limit);
543                 q = q_limit;
544             }
545         }
546
547         if (max_rate) {
548             double d = 2 * expected_size / buffer_size;
549             if (d > 1.0)
550                 d = 1.0;
551             else if (d < 0.0001)
552                 d = 0.0001;
553             q /= pow(d, 1.0 / s->avctx->rc_buffer_aggressivity);
554
555             q_limit = bits2qp(rce,
556                               FFMAX(rcc->buffer_index *
557                                     s->avctx->rc_max_available_vbv_use,
558                                     1));
559             if (q < q_limit) {
560                 if (s->avctx->debug & FF_DEBUG_RC)
561                     av_log(s->avctx, AV_LOG_DEBUG,
562                            "limiting QP %f -> %f\n", q, q_limit);
563                 q = q_limit;
564             }
565         }
566     }
567     av_dlog(s, "q:%f max:%f min:%f size:%f index:%f agr:%f\n",
568             q, max_rate, min_rate, buffer_size, rcc->buffer_index,
569             s->avctx->rc_buffer_aggressivity);
570     if (s->avctx->rc_qsquish == 0.0 || qmin == qmax) {
571         if (q < qmin)
572             q = qmin;
573         else if (q > qmax)
574             q = qmax;
575     } else {
576         double min2 = log(qmin);
577         double max2 = log(qmax);
578
579         q  = log(q);
580         q  = (q - min2) / (max2 - min2) - 0.5;
581         q *= -4.0;
582         q  = 1.0 / (1.0 + exp(q));
583         q  = q * (max2 - min2) + min2;
584
585         q = exp(q);
586     }
587
588     return q;
589 }
590
591 // ----------------------------------
592 // 1 Pass Code
593
594 static double predict_size(Predictor *p, double q, double var)
595 {
596     return p->coeff * var / (q * p->count);
597 }
598
599 static void update_predictor(Predictor *p, double q, double var, double size)
600 {
601     double new_coeff = size * q / (var + 1);
602     if (var < 10)
603         return;
604
605     p->count *= p->decay;
606     p->coeff *= p->decay;
607     p->count++;
608     p->coeff += new_coeff;
609 }
610
611 static void adaptive_quantization(MpegEncContext *s, double q)
612 {
613     int i;
614     const float lumi_masking         = s->avctx->lumi_masking / (128.0 * 128.0);
615     const float dark_masking         = s->avctx->dark_masking / (128.0 * 128.0);
616     const float temp_cplx_masking    = s->avctx->temporal_cplx_masking;
617     const float spatial_cplx_masking = s->avctx->spatial_cplx_masking;
618     const float p_masking            = s->avctx->p_masking;
619     const float border_masking       = s->avctx->border_masking;
620     float bits_sum                   = 0.0;
621     float cplx_sum                   = 0.0;
622     float *cplx_tab                  = s->cplx_tab;
623     float *bits_tab                  = s->bits_tab;
624     const int qmin                   = s->avctx->mb_lmin;
625     const int qmax                   = s->avctx->mb_lmax;
626     Picture *const pic               = &s->current_picture;
627     const int mb_width               = s->mb_width;
628     const int mb_height              = s->mb_height;
629
630     for (i = 0; i < s->mb_num; i++) {
631         const int mb_xy = s->mb_index2xy[i];
632         float temp_cplx = sqrt(pic->mc_mb_var[mb_xy]); // FIXME merge in pow()
633         float spat_cplx = sqrt(pic->mb_var[mb_xy]);
634         const int lumi  = pic->mb_mean[mb_xy];
635         float bits, cplx, factor;
636         int mb_x = mb_xy % s->mb_stride;
637         int mb_y = mb_xy / s->mb_stride;
638         int mb_distance;
639         float mb_factor = 0.0;
640         if (spat_cplx < 4)
641             spat_cplx = 4;              // FIXME finetune
642         if (temp_cplx < 4)
643             temp_cplx = 4;              // FIXME finetune
644
645         if ((s->mb_type[mb_xy] & CANDIDATE_MB_TYPE_INTRA)) { // FIXME hq mode
646             cplx   = spat_cplx;
647             factor = 1.0 + p_masking;
648         } else {
649             cplx   = temp_cplx;
650             factor = pow(temp_cplx, -temp_cplx_masking);
651         }
652         factor *= pow(spat_cplx, -spatial_cplx_masking);
653
654         if (lumi > 127)
655             factor *= (1.0 - (lumi - 128) * (lumi - 128) * lumi_masking);
656         else
657             factor *= (1.0 - (lumi - 128) * (lumi - 128) * dark_masking);
658
659         if (mb_x < mb_width / 5) {
660             mb_distance = mb_width / 5 - mb_x;
661             mb_factor   = (float)mb_distance / (float)(mb_width / 5);
662         } else if (mb_x > 4 * mb_width / 5) {
663             mb_distance = mb_x - 4 * mb_width / 5;
664             mb_factor   = (float)mb_distance / (float)(mb_width / 5);
665         }
666         if (mb_y < mb_height / 5) {
667             mb_distance = mb_height / 5 - mb_y;
668             mb_factor   = FFMAX(mb_factor,
669                                 (float)mb_distance / (float)(mb_height / 5));
670         } else if (mb_y > 4 * mb_height / 5) {
671             mb_distance = mb_y - 4 * mb_height / 5;
672             mb_factor   = FFMAX(mb_factor,
673                                 (float)mb_distance / (float)(mb_height / 5));
674         }
675
676         factor *= 1.0 - border_masking * mb_factor;
677
678         if (factor < 0.00001)
679             factor = 0.00001;
680
681         bits        = cplx * factor;
682         cplx_sum   += cplx;
683         bits_sum   += bits;
684         cplx_tab[i] = cplx;
685         bits_tab[i] = bits;
686     }
687
688     /* handle qmin/qmax clipping */
689     if (s->flags & CODEC_FLAG_NORMALIZE_AQP) {
690         float factor = bits_sum / cplx_sum;
691         for (i = 0; i < s->mb_num; i++) {
692             float newq = q * cplx_tab[i] / bits_tab[i];
693             newq *= factor;
694
695             if (newq > qmax) {
696                 bits_sum -= bits_tab[i];
697                 cplx_sum -= cplx_tab[i] * q / qmax;
698             } else if (newq < qmin) {
699                 bits_sum -= bits_tab[i];
700                 cplx_sum -= cplx_tab[i] * q / qmin;
701             }
702         }
703         if (bits_sum < 0.001)
704             bits_sum = 0.001;
705         if (cplx_sum < 0.001)
706             cplx_sum = 0.001;
707     }
708
709     for (i = 0; i < s->mb_num; i++) {
710         const int mb_xy = s->mb_index2xy[i];
711         float newq      = q * cplx_tab[i] / bits_tab[i];
712         int intq;
713
714         if (s->flags & CODEC_FLAG_NORMALIZE_AQP) {
715             newq *= bits_sum / cplx_sum;
716         }
717
718         intq = (int)(newq + 0.5);
719
720         if (intq > qmax)
721             intq = qmax;
722         else if (intq < qmin)
723             intq = qmin;
724         s->lambda_table[mb_xy] = intq;
725     }
726 }
727
728 void ff_get_2pass_fcode(MpegEncContext *s)
729 {
730     RateControlContext *rcc = &s->rc_context;
731     RateControlEntry *rce   = &rcc->entry[s->picture_number];
732
733     s->f_code = rce->f_code;
734     s->b_code = rce->b_code;
735 }
736
737 // FIXME rd or at least approx for dquant
738
739 float ff_rate_estimate_qscale(MpegEncContext *s, int dry_run)
740 {
741     float q;
742     int qmin, qmax;
743     float br_compensation;
744     double diff;
745     double short_term_q;
746     double fps;
747     int picture_number = s->picture_number;
748     int64_t wanted_bits;
749     RateControlContext *rcc = &s->rc_context;
750     AVCodecContext *a       = s->avctx;
751     RateControlEntry local_rce, *rce;
752     double bits;
753     double rate_factor;
754     int var;
755     const int pict_type = s->pict_type;
756     Picture * const pic = &s->current_picture;
757     emms_c();
758
759 #if CONFIG_LIBXVID
760     if ((s->flags & CODEC_FLAG_PASS2) &&
761         s->avctx->rc_strategy == FF_RC_STRATEGY_XVID)
762         return ff_xvid_rate_estimate_qscale(s, dry_run);
763 #endif
764
765     get_qminmax(&qmin, &qmax, s, pict_type);
766
767     fps = get_fps(s->avctx);
768     /* update predictors */
769     if (picture_number > 2 && !dry_run) {
770         const int last_var = s->last_pict_type == AV_PICTURE_TYPE_I ? rcc->last_mb_var_sum
771                                                                     : rcc->last_mc_mb_var_sum;
772         av_assert1(s->frame_bits >= s->stuffing_bits);
773         update_predictor(&rcc->pred[s->last_pict_type],
774                          rcc->last_qscale,
775                          sqrt(last_var),
776                          s->frame_bits - s->stuffing_bits);
777     }
778
779     if (s->flags & CODEC_FLAG_PASS2) {
780         assert(picture_number >= 0);
781         if (picture_number >= rcc->num_entries) {
782             av_log(s, AV_LOG_ERROR, "Input is longer than 2-pass log file\n");
783             return -1;
784         }
785         rce         = &rcc->entry[picture_number];
786         wanted_bits = rce->expected_bits;
787     } else {
788         Picture *dts_pic;
789         rce = &local_rce;
790
791         /* FIXME add a dts field to AVFrame and ensure it is set and use it
792          * here instead of reordering but the reordering is simpler for now
793          * until H.264 B-pyramid must be handled. */
794         if (s->pict_type == AV_PICTURE_TYPE_B || s->low_delay)
795             dts_pic = s->current_picture_ptr;
796         else
797             dts_pic = s->last_picture_ptr;
798
799         if (!dts_pic || dts_pic->f.pts == AV_NOPTS_VALUE)
800             wanted_bits = (uint64_t)(s->bit_rate * (double)picture_number / fps);
801         else
802             wanted_bits = (uint64_t)(s->bit_rate * (double)dts_pic->f.pts / fps);
803     }
804
805     diff = s->total_bits - wanted_bits;
806     br_compensation = (a->bit_rate_tolerance - diff) / a->bit_rate_tolerance;
807     if (br_compensation <= 0.0)
808         br_compensation = 0.001;
809
810     var = pict_type == AV_PICTURE_TYPE_I ? pic->mb_var_sum : pic->mc_mb_var_sum;
811
812     short_term_q = 0; /* avoid warning */
813     if (s->flags & CODEC_FLAG_PASS2) {
814         if (pict_type != AV_PICTURE_TYPE_I)
815             assert(pict_type == rce->new_pict_type);
816
817         q = rce->new_qscale / br_compensation;
818         av_dlog(s, "%f %f %f last:%d var:%d type:%d//\n", q, rce->new_qscale,
819                 br_compensation, s->frame_bits, var, pict_type);
820     } else {
821         rce->pict_type     =
822         rce->new_pict_type = pict_type;
823         rce->mc_mb_var_sum = pic->mc_mb_var_sum;
824         rce->mb_var_sum    = pic->mb_var_sum;
825         rce->qscale        = FF_QP2LAMBDA * 2;
826         rce->f_code        = s->f_code;
827         rce->b_code        = s->b_code;
828         rce->misc_bits     = 1;
829
830         bits = predict_size(&rcc->pred[pict_type], rce->qscale, sqrt(var));
831         if (pict_type == AV_PICTURE_TYPE_I) {
832             rce->i_count    = s->mb_num;
833             rce->i_tex_bits = bits;
834             rce->p_tex_bits = 0;
835             rce->mv_bits    = 0;
836         } else {
837             rce->i_count    = 0;    // FIXME we do know this approx
838             rce->i_tex_bits = 0;
839             rce->p_tex_bits = bits * 0.9;
840             rce->mv_bits    = bits * 0.1;
841         }
842         rcc->i_cplx_sum[pict_type]  += rce->i_tex_bits * rce->qscale;
843         rcc->p_cplx_sum[pict_type]  += rce->p_tex_bits * rce->qscale;
844         rcc->mv_bits_sum[pict_type] += rce->mv_bits;
845         rcc->frame_count[pict_type]++;
846
847         bits        = rce->i_tex_bits + rce->p_tex_bits;
848         rate_factor = rcc->pass1_wanted_bits /
849                       rcc->pass1_rc_eq_output_sum * br_compensation;
850
851         q = get_qscale(s, rce, rate_factor, picture_number);
852         if (q < 0)
853             return -1;
854
855         assert(q > 0.0);
856         q = get_diff_limited_q(s, rce, q);
857         assert(q > 0.0);
858
859         // FIXME type dependent blur like in 2-pass
860         if (pict_type == AV_PICTURE_TYPE_P || s->intra_only) {
861             rcc->short_term_qsum   *= a->qblur;
862             rcc->short_term_qcount *= a->qblur;
863
864             rcc->short_term_qsum += q;
865             rcc->short_term_qcount++;
866             q = short_term_q = rcc->short_term_qsum / rcc->short_term_qcount;
867         }
868         assert(q > 0.0);
869
870         q = modify_qscale(s, rce, q, picture_number);
871
872         rcc->pass1_wanted_bits += s->bit_rate / fps;
873
874         assert(q > 0.0);
875     }
876
877     if (s->avctx->debug & FF_DEBUG_RC) {
878         av_log(s->avctx, AV_LOG_DEBUG,
879                "%c qp:%d<%2.1f<%d %d want:%d total:%d comp:%f st_q:%2.2f "
880                "size:%d var:%d/%d br:%d fps:%d\n",
881                av_get_picture_type_char(pict_type),
882                qmin, q, qmax, picture_number,
883                (int)wanted_bits / 1000, (int)s->total_bits / 1000,
884                br_compensation, short_term_q, s->frame_bits,
885                pic->mb_var_sum, pic->mc_mb_var_sum,
886                s->bit_rate / 1000, (int)fps);
887     }
888
889     if (q < qmin)
890         q = qmin;
891     else if (q > qmax)
892         q = qmax;
893
894     if (s->adaptive_quant)
895         adaptive_quantization(s, q);
896     else
897         q = (int)(q + 0.5);
898
899     if (!dry_run) {
900         rcc->last_qscale        = q;
901         rcc->last_mc_mb_var_sum = pic->mc_mb_var_sum;
902         rcc->last_mb_var_sum    = pic->mb_var_sum;
903     }
904     return q;
905 }
906
907 // ----------------------------------------------
908 // 2-Pass code
909
910 static int init_pass2(MpegEncContext *s)
911 {
912     RateControlContext *rcc = &s->rc_context;
913     AVCodecContext *a       = s->avctx;
914     int i, toobig;
915     double fps             = get_fps(s->avctx);
916     double complexity[5]   = { 0 }; // approximate bits at quant=1
917     uint64_t const_bits[5] = { 0 }; // quantizer independent bits
918     uint64_t all_const_bits;
919     uint64_t all_available_bits = (uint64_t)(s->bit_rate *
920                                              (double)rcc->num_entries / fps);
921     double rate_factor          = 0;
922     double step;
923     const int filter_size = (int)(a->qblur * 4) | 1;
924     double expected_bits;
925     double *qscale, *blurred_qscale, qscale_sum;
926
927     /* find complexity & const_bits & decide the pict_types */
928     for (i = 0; i < rcc->num_entries; i++) {
929         RateControlEntry *rce = &rcc->entry[i];
930
931         rce->new_pict_type                = rce->pict_type;
932         rcc->i_cplx_sum[rce->pict_type]  += rce->i_tex_bits * rce->qscale;
933         rcc->p_cplx_sum[rce->pict_type]  += rce->p_tex_bits * rce->qscale;
934         rcc->mv_bits_sum[rce->pict_type] += rce->mv_bits;
935         rcc->frame_count[rce->pict_type]++;
936
937         complexity[rce->new_pict_type] += (rce->i_tex_bits + rce->p_tex_bits) *
938                                           (double)rce->qscale;
939         const_bits[rce->new_pict_type] += rce->mv_bits + rce->misc_bits;
940     }
941
942     all_const_bits = const_bits[AV_PICTURE_TYPE_I] +
943                      const_bits[AV_PICTURE_TYPE_P] +
944                      const_bits[AV_PICTURE_TYPE_B];
945
946     if (all_available_bits < all_const_bits) {
947         av_log(s->avctx, AV_LOG_ERROR, "requested bitrate is too low\n");
948         return -1;
949     }
950
951     qscale         = av_malloc(sizeof(double) * rcc->num_entries);
952     blurred_qscale = av_malloc(sizeof(double) * rcc->num_entries);
953     toobig = 0;
954
955     for (step = 256 * 256; step > 0.0000001; step *= 0.5) {
956         expected_bits = 0;
957         rate_factor  += step;
958
959         rcc->buffer_index = s->avctx->rc_buffer_size / 2;
960
961         /* find qscale */
962         for (i = 0; i < rcc->num_entries; i++) {
963             RateControlEntry *rce = &rcc->entry[i];
964
965             qscale[i] = get_qscale(s, &rcc->entry[i], rate_factor, i);
966             rcc->last_qscale_for[rce->pict_type] = qscale[i];
967         }
968         assert(filter_size % 2 == 1);
969
970         /* fixed I/B QP relative to P mode */
971         for (i = FFMAX(0, rcc->num_entries - 300); i < rcc->num_entries; i++) {
972             RateControlEntry *rce = &rcc->entry[i];
973
974             qscale[i] = get_diff_limited_q(s, rce, qscale[i]);
975         }
976
977         for (i = rcc->num_entries - 1; i >= 0; i--) {
978             RateControlEntry *rce = &rcc->entry[i];
979
980             qscale[i] = get_diff_limited_q(s, rce, qscale[i]);
981         }
982
983         /* smooth curve */
984         for (i = 0; i < rcc->num_entries; i++) {
985             RateControlEntry *rce = &rcc->entry[i];
986             const int pict_type   = rce->new_pict_type;
987             int j;
988             double q = 0.0, sum = 0.0;
989
990             for (j = 0; j < filter_size; j++) {
991                 int index    = i + j - filter_size / 2;
992                 double d     = index - i;
993                 double coeff = a->qblur == 0 ? 1.0 : exp(-d * d / (a->qblur * a->qblur));
994
995                 if (index < 0 || index >= rcc->num_entries)
996                     continue;
997                 if (pict_type != rcc->entry[index].new_pict_type)
998                     continue;
999                 q   += qscale[index] * coeff;
1000                 sum += coeff;
1001             }
1002             blurred_qscale[i] = q / sum;
1003         }
1004
1005         /* find expected bits */
1006         for (i = 0; i < rcc->num_entries; i++) {
1007             RateControlEntry *rce = &rcc->entry[i];
1008             double bits;
1009
1010             rce->new_qscale = modify_qscale(s, rce, blurred_qscale[i], i);
1011
1012             bits  = qp2bits(rce, rce->new_qscale) + rce->mv_bits + rce->misc_bits;
1013             bits += 8 * ff_vbv_update(s, bits);
1014
1015             rce->expected_bits = expected_bits;
1016             expected_bits     += bits;
1017         }
1018
1019         av_dlog(s->avctx,
1020                 "expected_bits: %f all_available_bits: %d rate_factor: %f\n",
1021                 expected_bits, (int)all_available_bits, rate_factor);
1022         if (expected_bits > all_available_bits) {
1023             rate_factor -= step;
1024             ++toobig;
1025         }
1026     }
1027     av_free(qscale);
1028     av_free(blurred_qscale);
1029
1030     /* check bitrate calculations and print info */
1031     qscale_sum = 0.0;
1032     for (i = 0; i < rcc->num_entries; i++) {
1033         av_dlog(s, "[lavc rc] entry[%d].new_qscale = %.3f  qp = %.3f\n",
1034                 i,
1035                 rcc->entry[i].new_qscale,
1036                 rcc->entry[i].new_qscale / FF_QP2LAMBDA);
1037         qscale_sum += av_clip(rcc->entry[i].new_qscale / FF_QP2LAMBDA,
1038                               s->avctx->qmin, s->avctx->qmax);
1039     }
1040     assert(toobig <= 40);
1041     av_log(s->avctx, AV_LOG_DEBUG,
1042            "[lavc rc] requested bitrate: %d bps  expected bitrate: %d bps\n",
1043            s->bit_rate,
1044            (int)(expected_bits / ((double)all_available_bits / s->bit_rate)));
1045     av_log(s->avctx, AV_LOG_DEBUG,
1046            "[lavc rc] estimated target average qp: %.3f\n",
1047            (float)qscale_sum / rcc->num_entries);
1048     if (toobig == 0) {
1049         av_log(s->avctx, AV_LOG_INFO,
1050                "[lavc rc] Using all of requested bitrate is not "
1051                "necessary for this video with these parameters.\n");
1052     } else if (toobig == 40) {
1053         av_log(s->avctx, AV_LOG_ERROR,
1054                "[lavc rc] Error: bitrate too low for this video "
1055                "with these parameters.\n");
1056         return -1;
1057     } else if (fabs(expected_bits / all_available_bits - 1.0) > 0.01) {
1058         av_log(s->avctx, AV_LOG_ERROR,
1059                "[lavc rc] Error: 2pass curve failed to converge\n");
1060         return -1;
1061     }
1062
1063     return 0;
1064 }