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