• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2016, Alliance for Open Media. All rights reserved
3  *
4  * This source code is subject to the terms of the BSD 2 Clause License and
5  * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6  * was not distributed with this source code in the LICENSE file, you can
7  * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8  * Media Patent License 1.0 was not distributed with this source code in the
9  * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10  */
11 
12 #ifndef AOM_AV1_ENCODER_RATECTRL_H_
13 #define AOM_AV1_ENCODER_RATECTRL_H_
14 
15 #include "aom/aom_codec.h"
16 #include "aom/aom_integer.h"
17 
18 #include "aom_ports/mem.h"
19 
20 #include "av1/common/av1_common_int.h"
21 #include "av1/common/blockd.h"
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /*!\cond */
28 
29 // Bits Per MB at different Q (Multiplied by 512)
30 #define BPER_MB_NORMBITS 9
31 
32 // Use this macro to turn on/off use of alt-refs in one-pass mode.
33 #define USE_ALTREF_FOR_ONE_PASS 1
34 
35 // Threshold used to define if a KF group is static (e.g. a slide show).
36 // Essentially, this means that no frame in the group has more than 1% of MBs
37 // that are not marked as coded with 0,0 motion in the first pass.
38 #define STATIC_KF_GROUP_THRESH 99
39 #define STATIC_KF_GROUP_FLOAT_THRESH 0.99
40 
41 // The maximum duration of a GF group that is static (e.g. a slide show).
42 #define MAX_STATIC_GF_GROUP_LENGTH 250
43 
44 #define MIN_GF_INTERVAL 4
45 #define MAX_GF_INTERVAL 32
46 #define FIXED_GF_INTERVAL 16
47 #define MAX_GF_LENGTH_LAP 16
48 
49 #define FIXED_GF_INTERVAL_RT 80
50 #define MAX_GF_INTERVAL_RT 160
51 
52 #define MAX_NUM_GF_INTERVALS 15
53 
54 #define MAX_ARF_LAYERS 6
55 // #define STRICT_RC
56 
57 #define DEFAULT_KF_BOOST_RT 2300
58 #define DEFAULT_GF_BOOST_RT 2000
59 
60 // A passive rate control strategy for screen content type in real-time mode.
61 // When it is turned on, the compression performance is improved by
62 // 7.8% (overall_psnr), 5.0% (VMAF) on average. Some clips see gains
63 // over 20% on metric.
64 // The downside is that it does not guarantee frame size.
65 // Since RT mode has a tight restriction on buffer overflow control, we
66 // turn it off by default.
67 #define RT_PASSIVE_STRATEGY 0
68 #define MAX_Q_HISTORY 1000
69 
70 typedef struct {
71   int resize_width;
72   int resize_height;
73   uint8_t superres_denom;
74 } size_params_type;
75 
76 enum {
77   INTER_NORMAL,
78   GF_ARF_LOW,
79   GF_ARF_STD,
80   KF_STD,
81   RATE_FACTOR_LEVELS
82 } UENUM1BYTE(RATE_FACTOR_LEVEL);
83 
84 enum {
85   KF_UPDATE,
86   LF_UPDATE,
87   GF_UPDATE,
88   ARF_UPDATE,
89   OVERLAY_UPDATE,
90   INTNL_OVERLAY_UPDATE,  // Internal Overlay Frame
91   INTNL_ARF_UPDATE,      // Internal Altref Frame
92   FRAME_UPDATE_TYPES
93 } UENUM1BYTE(FRAME_UPDATE_TYPE);
94 
95 enum {
96   REFBUF_RESET,   // Clear reference frame buffer
97   REFBUF_UPDATE,  // Refresh reference frame buffer
98   REFBUF_STATES
99 } UENUM1BYTE(REFBUF_STATE);
100 
101 typedef enum {
102   NO_RESIZE = 0,
103   DOWN_THREEFOUR = 1,  // From orig to 3/4.
104   DOWN_ONEHALF = 2,    // From orig or 3/4 to 1/2.
105   UP_THREEFOUR = -1,   // From 1/2 to 3/4.
106   UP_ORIG = -2,        // From 1/2 or 3/4 to orig.
107 } RESIZE_ACTION;
108 
109 typedef enum { ORIG = 0, THREE_QUARTER = 1, ONE_HALF = 2 } RESIZE_STATE;
110 
111 #define MAX_FIRSTPASS_ANALYSIS_FRAMES 150
112 typedef enum region_types {
113   STABLE_REGION = 0,
114   HIGH_VAR_REGION = 1,
115   SCENECUT_REGION = 2,
116   BLENDING_REGION = 3,
117 } REGION_TYPES;
118 
119 typedef struct regions {
120   int start;
121   int last;
122   double avg_noise_var;
123   double avg_cor_coeff;
124   double avg_sr_fr_ratio;
125   double avg_intra_err;
126   double avg_coded_err;
127   REGION_TYPES type;
128 } REGIONS;
129 
130 /*!\endcond */
131 /*!
132  * \brief  Rate Control parameters and status
133  */
134 typedef struct {
135   // Rate targetting variables
136 
137   /*!
138    * Baseline target rate for frame before adjustment for previous under or
139    * over shoot.
140    */
141   int base_frame_target;
142   /*!
143    * Target rate for frame after adjustment for previous under or over shoot.
144    */
145   int this_frame_target;  // Actual frame target after rc adjustment.
146 
147   /*!
148    * Projected size for current frame
149    */
150   int projected_frame_size;
151 
152   /*!
153    * Bit size of transform coefficient for current frame.
154    */
155   int coefficient_size;
156 
157   /*!
158    * Super block rate target used with some adaptive quantization strategies.
159    */
160   int sb64_target_rate;
161 
162   /*!
163    * Number of frames since the last ARF / GF.
164    */
165   int frames_since_golden;
166 
167   /*!
168    * Number of frames till the next ARF / GF is due.
169    */
170   int frames_till_gf_update_due;
171 
172   /*!
173    * Number of determined gf groups left
174    */
175   int intervals_till_gf_calculate_due;
176 
177   /*!\cond */
178   int min_gf_interval;
179   int max_gf_interval;
180   int static_scene_max_gf_interval;
181   /*!\endcond */
182   /*!
183    * Frames before the next key frame
184    */
185   int frames_to_key;
186   /*!\cond */
187   int frames_since_key;
188   int frames_to_fwd_kf;
189   int is_src_frame_alt_ref;
190   int sframe_due;
191 
192   int high_source_sad;
193   uint64_t avg_source_sad;
194   uint64_t prev_avg_source_sad;
195   uint64_t frame_source_sad;
196 
197   int avg_frame_bandwidth;  // Average frame size target for clip
198   int min_frame_bandwidth;  // Minimum allocation used for any frame
199   int max_frame_bandwidth;  // Maximum burst rate allowed for a frame.
200   int prev_avg_frame_bandwidth;
201 
202   int ni_av_qi;
203   int ni_tot_qi;
204 
205   int decimation_factor;
206   int decimation_count;
207   int prev_frame_is_dropped;
208   int drop_count_consec;
209   int max_consec_drop;
210 
211   /*!
212    * Frame number for encoded frames (non-dropped).
213    * Use for setting the rtc reference structure.
214    */
215   unsigned int frame_number_encoded;
216 
217   /*!\endcond */
218   /*!
219    * User specified maximum Q allowed for current frame
220    */
221   int worst_quality;
222   /*!
223    * User specified minimum Q allowed for current frame
224    */
225   int best_quality;
226 
227   /*!\cond */
228 
229   // rate control history for last frame(1) and the frame before(2).
230   // -1: overshoot
231   //  1: undershoot
232   //  0: not initialized.
233   int rc_1_frame;
234   int rc_2_frame;
235   int q_1_frame;
236   int q_2_frame;
237 
238   /*!\endcond */
239   /*!
240    * Proposed maximum allowed Q for current frame
241    */
242   int active_worst_quality;
243 
244   /*!\cond */
245   // Track amount of low motion in scene
246   int avg_frame_low_motion;
247   int cnt_zeromv;
248 
249   // signals if number of blocks with motion is high
250   int percent_blocks_with_motion;
251 
252   // signals percentge of 16x16 blocks that are inactive, via active_maps
253   int percent_blocks_inactive;
254 
255   // Maximum value of source sad across all blocks of frame.
256   uint64_t max_block_source_sad;
257 
258   // For dynamic resize, 1 pass cbr.
259   RESIZE_STATE resize_state;
260   int resize_avg_qp;
261   int resize_buffer_underflow;
262   int resize_count;
263 
264   // Flag to disable content related qp adjustment.
265   int rtc_external_ratectrl;
266 
267   // Stores fast_extra_bits of the current frame.
268   int frame_level_fast_extra_bits;
269 
270   double frame_level_rate_correction_factors[RATE_FACTOR_LEVELS];
271 
272   int frame_num_last_gf_refresh;
273 
274   int prev_coded_width;
275   int prev_coded_height;
276 
277   // The ratio used for inter frames in bit estimation.
278   // TODO(yunqing): if golden frame is treated differently (e.g. gf_cbr_boost_
279   // pct > THR), consider to add bit_est_ratio_g for golden frames.
280   int bit_est_ratio;
281 
282   // Whether to use a fixed qp for the frame, bypassing internal rate control.
283   // This flag will reset to 0 after every frame.
284   int use_external_qp_one_pass;
285   /*!\endcond */
286 } RATE_CONTROL;
287 
288 /*!
289  * \brief  Primary Rate Control parameters and status
290  */
291 typedef struct {
292   // Sub-gop level Rate targetting variables
293 
294   /*!
295    * Target bit budget for the current GF / ARF group of frame.
296    */
297   int64_t gf_group_bits;
298 
299   /*!
300    * Boost factor used to calculate the extra bits allocated to the key frame
301    */
302   int kf_boost;
303 
304   /*!
305    * Boost factor used to calculate the extra bits allocated to ARFs and GFs
306    */
307   int gfu_boost;
308 
309   /*!
310    * Stores the determined gf group lengths for a set of gf groups
311    */
312   int gf_intervals[MAX_NUM_GF_INTERVALS];
313 
314   /*!
315    * The current group's index into gf_intervals[]
316    */
317   int cur_gf_index;
318 
319   /*!\cond */
320   int num_regions;
321 
322   REGIONS regions[MAX_FIRSTPASS_ANALYSIS_FRAMES];
323   int regions_offset;  // offset of regions from the last keyframe
324   int frames_till_regions_update;
325 
326   int baseline_gf_interval;
327 
328   int constrained_gf_group;
329 
330   int this_key_frame_forced;
331 
332   int next_key_frame_forced;
333   /*!\endcond */
334 
335   /*!
336    * Initial buffuer level in ms for CBR / low delay encoding
337    */
338   int64_t starting_buffer_level;
339 
340   /*!
341    * Optimum / target buffuer level in ms for CBR / low delay encoding
342    */
343   int64_t optimal_buffer_level;
344 
345   /*!
346    * Maximum target buffuer level in ms for CBR / low delay encoding
347    */
348   int64_t maximum_buffer_size;
349 
350   /*!
351    * Q index used for ALT frame
352    */
353   int arf_q;
354 
355   /*!\cond */
356   float_t arf_boost_factor;
357 
358   int base_layer_qp;
359 
360   // Total number of stats used only for kf_boost calculation.
361   int num_stats_used_for_kf_boost;
362 
363   // Total number of stats used only for gfu_boost calculation.
364   int num_stats_used_for_gfu_boost;
365 
366   // Total number of stats required by gfu_boost calculation.
367   int num_stats_required_for_gfu_boost;
368 
369   int enable_scenecut_detection;
370 
371   int use_arf_in_this_kf_group;
372 
373   int ni_frames;
374 
375   double tot_q;
376   /*!\endcond */
377 
378   /*!
379    * Q used for last boosted (non leaf) frame
380    */
381   int last_kf_qindex;
382 
383   /*!
384    * Average of q index of previous encoded frames in a sequence.
385    */
386   int avg_frame_qindex[FRAME_TYPES];
387 
388 #if CONFIG_FPMT_TEST
389   /*!
390    * Temporary variable used in simulating the delayed update of
391    * active_best_quality.
392    */
393   int temp_active_best_quality[MAX_ARF_LAYERS + 1];
394 
395   /*!
396    * Temporary variable used in simulating the delayed update of
397    * last_boosted_qindex.
398    */
399   int temp_last_boosted_qindex;
400 
401   /*!
402    * Temporary variable used in simulating the delayed update of
403    * avg_q.
404    */
405   double temp_avg_q;
406 
407   /*!
408    * Temporary variable used in simulating the delayed update of
409    * last_q.
410    */
411   int temp_last_q[FRAME_TYPES];
412 
413   /*!
414    * Temporary variable used in simulating the delayed update of
415    * projected_frame_size.
416    */
417   int temp_projected_frame_size;
418 
419   /*!
420    * Temporary variable used in simulating the delayed update of
421    * total_actual_bits.
422    */
423   int64_t temp_total_actual_bits;
424 
425   /*!
426    * Temporary variable used in simulating the delayed update of
427    * buffer_level.
428    */
429   int64_t temp_buffer_level;
430 
431   /*!
432    * Temporary variable used in simulating the delayed update of
433    * vbr_bits_off_target.
434    */
435   int64_t temp_vbr_bits_off_target;
436 
437   /*!
438    * Temporary variable used in simulating the delayed update of
439    * vbr_bits_off_target_fast.
440    */
441   int64_t temp_vbr_bits_off_target_fast;
442 
443   /*!
444    * Temporary variable used in simulating the delayed update of
445    * rate_correction_factors.
446    */
447   double temp_rate_correction_factors[RATE_FACTOR_LEVELS];
448 
449   /*!
450    * Temporary variable used in simulating the delayed update of
451    * rate_error_estimate.
452    */
453   int temp_rate_error_estimate;
454 
455   /*!
456    * Temporary variable used in simulating the delayed update of
457    * rolling_arf_group_target_bits.
458    */
459   int temp_rolling_arf_group_target_bits;
460 
461   /*!
462    * Temporary variable used in simulating the delayed update of
463    * rolling_arf_group_actual_bits;.
464    */
465   int temp_rolling_arf_group_actual_bits;
466 
467   /*!
468    * Temporary variable used in simulating the delayed update of
469    * bits_left;.
470    */
471   int64_t temp_bits_left;
472 
473   /*!
474    * Temporary variable used in simulating the delayed update of
475    * extend_minq.
476    */
477   int temp_extend_minq;
478 
479   /*!
480    * Temporary variable used in simulating the delayed update of
481    * extend_maxq.
482    */
483   int temp_extend_maxq;
484 
485 #endif
486   /*!
487    * Proposed minimum allowed Q different layers in a coding pyramid
488    */
489   int active_best_quality[MAX_ARF_LAYERS + 1];
490 
491   /*!
492    * Q used for last boosted (non leaf) frame (GF/KF/ARF)
493    */
494   int last_boosted_qindex;
495 
496   /*!
497    * Average Q value of previous inter frames
498    */
499   double avg_q;
500 
501   /*!
502    * Q used on last encoded frame of the given type.
503    */
504   int last_q[FRAME_TYPES];
505 
506   /*!
507    * Correction factors used to adjust the q estimate for a given target rate
508    * in the encode loop.
509    */
510   double rate_correction_factors[RATE_FACTOR_LEVELS];
511 
512   /*!
513    * Current total consumed bits.
514    */
515   int64_t total_actual_bits;
516 
517   /*!
518    * Current total target bits.
519    */
520   int64_t total_target_bits;
521 
522   /*!
523    * Current buffer level.
524    */
525   int64_t buffer_level;
526 
527   /*!
528    * PCT rc error.
529    */
530   int rate_error_estimate;
531 
532   /*!
533    * Error bits available from previously encoded frames.
534    */
535   int64_t vbr_bits_off_target;
536 
537   /*!
538    * Error bits available from previously encoded frames undershoot.
539    */
540   int64_t vbr_bits_off_target_fast;
541 
542   /*!
543    * Total bits deviated from the average frame target, from previously
544    * encoded frames.
545    */
546   int64_t bits_off_target;
547 
548   /*!
549    * Rolling monitor target bits updated based on current frame target size.
550    */
551   int rolling_target_bits;
552 
553   /*!
554    * Rolling monitor actual bits updated based on current frame final projected
555    * size.
556    */
557   int rolling_actual_bits;
558 
559   /*!
560    * The history of qindex for each frame.
561    * Only used when RT_PASSIVE_STRATEGY = 1.
562    */
563   int q_history[MAX_Q_HISTORY];
564 } PRIMARY_RATE_CONTROL;
565 
566 /*!\cond */
567 
568 struct AV1_COMP;
569 struct AV1EncoderConfig;
570 struct GF_GROUP;
571 
572 void av1_primary_rc_init(const struct AV1EncoderConfig *oxcf,
573                          PRIMARY_RATE_CONTROL *p_rc);
574 
575 void av1_rc_init(const struct AV1EncoderConfig *oxcf, RATE_CONTROL *rc);
576 
577 int av1_estimate_bits_at_q(const struct AV1_COMP *cpi, int q,
578                            double correction_factor);
579 
580 double av1_convert_qindex_to_q(int qindex, aom_bit_depth_t bit_depth);
581 
582 void av1_rc_init_minq_luts(void);
583 
584 int av1_rc_get_default_min_gf_interval(int width, int height, double framerate);
585 // Note av1_rc_get_default_max_gf_interval() requires the min_gf_interval to
586 // be passed in to ensure that the max_gf_interval returned is at least as bis
587 // as that.
588 int av1_rc_get_default_max_gf_interval(double framerate, int min_gf_interval);
589 
590 // Generally at the high level, the following flow is expected
591 // to be enforced for rate control:
592 // First call per frame, one of:
593 //   av1_get_one_pass_rt_params()
594 //   av1_get_second_pass_params()
595 // depending on the usage to set the rate control encode parameters desired.
596 //
597 // Then, call encode_frame_to_data_rate() to perform the
598 // actual encode. This function will in turn call encode_frame()
599 // one or more times, followed by:
600 //   av1_rc_postencode_update_drop_frame()
601 //
602 // The majority of rate control parameters are only expected
603 // to be set in the av1_get_..._params() functions and
604 // updated during the av1_rc_postencode_update...() functions.
605 // The only exceptions are av1_rc_drop_frame() and
606 // av1_rc_update_rate_correction_factors() functions.
607 
608 // Functions to set parameters for encoding before the actual
609 // encode_frame_to_data_rate() function.
610 struct EncodeFrameInput;
611 
612 // Post encode update of the rate control parameters based
613 // on bytes used
614 void av1_rc_postencode_update(struct AV1_COMP *cpi, uint64_t bytes_used);
615 // Post encode update of the rate control parameters for dropped frames
616 void av1_rc_postencode_update_drop_frame(struct AV1_COMP *cpi);
617 
618 /*!\endcond */
619 /*!\brief Updates the rate correction factor linking Q to output bits
620  *
621  * This function updates the Q rate correction factor after an encode
622  * cycle depending on whether we overshot or undershot the target rate.
623  *
624  * \ingroup rate_control
625  * \param[in]   cpi                   Top level encoder instance structure
626  * \param[in]   is_encode_stage       Indicates if recode loop or post-encode
627  * \param[in]   width                 Frame width
628  * \param[in]   height                Frame height
629  *
630  * \remark Updates the relevant rate correction factor in cpi->rc
631  */
632 void av1_rc_update_rate_correction_factors(struct AV1_COMP *cpi,
633                                            int is_encode_stage, int width,
634                                            int height);
635 /*!\cond */
636 
637 // Decide if we should drop this frame: For 1-pass CBR.
638 // Changes only the decimation count in the rate control structure
639 int av1_rc_drop_frame(struct AV1_COMP *cpi);
640 
641 // Computes frame size bounds.
642 void av1_rc_compute_frame_size_bounds(const struct AV1_COMP *cpi,
643                                       int this_frame_target,
644                                       int *frame_under_shoot_limit,
645                                       int *frame_over_shoot_limit);
646 
647 /*!\endcond */
648 
649 /*!\brief Picks q and q bounds given the rate control parameters in \c cpi->rc.
650  *
651  * \ingroup rate_control
652  * \param[in]       cpi          Top level encoder structure
653  * \param[in]       width        Coded frame width
654  * \param[in]       height       Coded frame height
655  * \param[in]       gf_index     Index of this frame in the golden frame group
656  * \param[out]      bottom_index Bottom bound for q index (best quality)
657  * \param[out]      top_index    Top bound for q index (worst quality)
658  * \return Returns selected q index to be used for encoding this frame.
659  * Also, updates \c rc->arf_q.
660  */
661 int av1_rc_pick_q_and_bounds(struct AV1_COMP *cpi, int width, int height,
662                              int gf_index, int *bottom_index, int *top_index);
663 
664 /*!\brief Estimates q to achieve a target bits per frame
665  *
666  * \ingroup rate_control
667  * \param[in]   cpi                   Top level encoder instance structure
668  * \param[in]   target_bits_per_frame Frame rate target
669  * \param[in]   active_worst_quality  Max Q allowed
670  * \param[in]   active_best_quality   Min Q allowed
671  * \param[in]   width                 Frame width
672  * \param[in]   height                Frame height
673  *
674  * \return Returns a q index value
675  */
676 int av1_rc_regulate_q(const struct AV1_COMP *cpi, int target_bits_per_frame,
677                       int active_best_quality, int active_worst_quality,
678                       int width, int height);
679 
680 /*!\cond */
681 // Gets the appropriate bpmb ennumerator based on the frame and content type
682 int av1_get_bpmb_enumerator(FRAME_TYPE frame_type,
683                             const int is_screen_content_type);
684 
685 // Estimates bits per mb for a given qindex and correction factor.
686 int av1_rc_bits_per_mb(const struct AV1_COMP *cpi, FRAME_TYPE frame_type,
687                        int qindex, double correction_factor,
688                        int accurate_estimate);
689 
690 // Clamping utilities for bitrate targets for iframes and pframes.
691 int av1_rc_clamp_iframe_target_size(const struct AV1_COMP *const cpi,
692                                     int64_t target);
693 int av1_rc_clamp_pframe_target_size(const struct AV1_COMP *const cpi,
694                                     int target, uint8_t frame_update_type);
695 
696 // Find q_index corresponding to desired_q, within [best_qindex, worst_qindex].
697 // To be precise, 'q_index' is the smallest integer, for which the corresponding
698 // q >= desired_q.
699 // If no such q index is found, returns 'worst_qindex'.
700 int av1_find_qindex(double desired_q, aom_bit_depth_t bit_depth,
701                     int best_qindex, int worst_qindex);
702 
703 // Computes a q delta (in "q index" terms) to get from a starting q value
704 // to a target q value
705 int av1_compute_qdelta(const RATE_CONTROL *rc, double qstart, double qtarget,
706                        aom_bit_depth_t bit_depth);
707 
708 // Computes a q delta (in "q index" terms) to get from a starting q value
709 // to a value that should equate to the given rate ratio.
710 int av1_compute_qdelta_by_rate(const struct AV1_COMP *cpi,
711                                FRAME_TYPE frame_type, int qindex,
712                                double rate_target_ratio);
713 
714 int av1_frame_type_qdelta(const struct AV1_COMP *cpi, int q);
715 
716 void av1_rc_update_framerate(struct AV1_COMP *cpi, int width, int height);
717 
718 void av1_rc_set_gf_interval_range(const struct AV1_COMP *const cpi,
719                                   RATE_CONTROL *const rc);
720 
721 void av1_set_target_rate(struct AV1_COMP *cpi, int width, int height);
722 
723 int av1_resize_one_pass_cbr(struct AV1_COMP *cpi);
724 
725 void av1_rc_set_frame_target(struct AV1_COMP *cpi, int target, int width,
726                              int height);
727 
728 void av1_adjust_gf_refresh_qp_one_pass_rt(struct AV1_COMP *cpi);
729 
730 void av1_set_rtc_reference_structure_one_layer(struct AV1_COMP *cpi,
731                                                int gf_update);
732 
733 /*!\endcond */
734 /*!\brief Calculates how many bits to use for a P frame in one pass vbr
735  *
736  * \ingroup rate_control
737  * \callgraph
738  * \callergraph
739  *
740  * \param[in]       cpi                 Top level encoder structure
741  * \param[in]       frame_update_type   Type of frame
742  *
743  * \return	Returns the target number of bits for this frame.
744  */
745 int av1_calc_pframe_target_size_one_pass_vbr(
746     const struct AV1_COMP *const cpi, FRAME_UPDATE_TYPE frame_update_type);
747 
748 /*!\brief Calculates how many bits to use for an i frame in one pass vbr
749  *
750  * \ingroup rate_control
751  * \callgraph
752  * \callergraph
753  *
754  * \param[in]       cpi  Top level encoder structure
755  *
756  * \return	Returns the target number of bits for this frame.
757  */
758 int av1_calc_iframe_target_size_one_pass_vbr(const struct AV1_COMP *const cpi);
759 
760 /*!\brief Calculates how many bits to use for a P frame in one pass cbr
761  *
762  * \ingroup rate_control
763  * \callgraph
764  * \callergraph
765  *
766  * \param[in]       cpi                 Top level encoder structure
767  * \param[in]       frame_update_type   Type of frame
768  *
769  * \return  Returns the target number of bits for this frame.
770  */
771 int av1_calc_pframe_target_size_one_pass_cbr(
772     const struct AV1_COMP *cpi, FRAME_UPDATE_TYPE frame_update_type);
773 
774 /*!\brief Calculates how many bits to use for an i frame in one pass cbr
775  *
776  * \ingroup rate_control
777  * \callgraph
778  * \callergraph
779  *
780  * \param[in]       cpi  Top level encoder structure
781  *
782  * \return  Returns the target number of bits for this frame.
783  */
784 int av1_calc_iframe_target_size_one_pass_cbr(const struct AV1_COMP *cpi);
785 
786 /*!\brief Setup the rate control parameters for 1 pass real-time mode.
787  *
788  * - Sets the frame type and target frame size.
789  * - Sets the GF update.
790  * - Checks for scene change.
791  * - Sets the reference prediction structure for 1 layers (non-SVC).
792  * - Resets and updates are done for SVC.
793  *
794  * \ingroup rate_control
795  * \param[in]       cpi          Top level encoder structure
796  * \param[in]       frame_type   Encoder frame type
797  * \param[in]       frame_input  Current and last input source frames
798  * \param[in]       frame_flags  Encoder frame flags
799  *
800  * \remark Nothing is returned. Instead the settings computed in this
801  * function are set in: \c frame_params, \c cpi->common, \c cpi->rc,
802  * \c cpi->svc.
803  */
804 void av1_get_one_pass_rt_params(struct AV1_COMP *cpi,
805                                 FRAME_TYPE *const frame_type,
806                                 const struct EncodeFrameInput *frame_input,
807                                 unsigned int frame_flags);
808 
809 /*!\brief Increase q on expected encoder overshoot, for CBR mode.
810  *
811  *  Handles the case when encoder is expected to create a large frame:
812  *  - q is increased to value closer to \c cpi->rc.worst_quality
813  *  - avg_frame_qindex is reset
814  *  - buffer levels are reset
815  *  - rate correction factor is adjusted
816  *
817  * \ingroup rate_control
818  * \param[in]       cpi          Top level encoder structure
819  * \param[in]        q           Current q index
820  *
821  * \return q is returned, and updates are done to \c cpi->rc.
822  */
823 int av1_encodedframe_overshoot_cbr(struct AV1_COMP *cpi, int *q);
824 
825 /*!\brief Compute the q_indices for a single frame.
826  *
827  * Intended to be used with AOM_Q mode.
828  *
829  * \param[in]       base_q_index      Base q index
830  * \param[in]       gf_update_type    GOP update type
831  * \param[in]       gf_pyramid_level  GOP level of the current frame
832  * \param[in]       arf_q             ARF q_index
833  *
834  * \return Returns the q_index for the current frame.
835  */
836 int av1_q_mode_get_q_index(int base_q_index, int gf_update_type,
837                            int gf_pyramid_level, int arf_q);
838 
839 /*!\brief Compute the q_indices for the ARF of a GOP.
840  *
841  * \param[in]       base_q_index      Base q index
842  * \param[in]       gfu_boost         GFU boost
843  * \param[in]       bit_depth         Bit depth
844  * \param[in]       arf_boost_factor  ARF boost factor
845  *
846  * \return Returns the q_index for the ARF frame.
847  */
848 int av1_get_arf_q_index(int base_q_index, int gfu_boost, int bit_depth,
849                         double arf_boost_factor);
850 
851 #if !CONFIG_REALTIME_ONLY
852 struct TplDepFrame;
853 /*!\brief Compute the q_indices for the ARF of a GOP in Q mode.
854  *
855  * \param[in]       cpi               Top level encoder structure
856  * \param[in]       tpl_frame         Tpl Frame stats
857  *
858  * \return Returns the q_index for the ARF frame.
859  */
860 int av1_get_arf_q_index_q_mode(struct AV1_COMP *cpi,
861                                struct TplDepFrame *tpl_frame);
862 #endif
863 #ifdef __cplusplus
864 }  // extern "C"
865 #endif
866 
867 #endif  // AOM_AV1_ENCODER_RATECTRL_H_
868