1 /* 2 * Copyright (c) 2019, 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_GOP_STRUCTURE_H_ 13 #define AOM_AV1_ENCODER_GOP_STRUCTURE_H_ 14 15 #include "av1/common/av1_common_int.h" 16 #include "av1/encoder/ratectrl.h" 17 18 #ifdef __cplusplus 19 extern "C" { 20 #endif 21 /*!\cond */ 22 struct AV1_COMP; 23 struct EncodeFrameParams; 24 25 #define MIN_ARF_GF_BOOST 240 26 #define NORMAL_BOOST 100 27 28 /*!\endcond */ 29 30 /*!\brief Set up the Group-Of-Pictures structure for this GF_GROUP. 31 * 32 *\ingroup rate_control 33 * 34 * This function defines the Group-Of-Pictures structure for this GF_GROUP. 35 * This involves deciding where to place the various FRAME_UPDATE_TYPEs in 36 * the group. It does this primarily by updateing entries in 37 * cpi->twopass.gf_group.update_type[]. 38 * 39 * \param[in] cpi Top - level encoder instance structure 40 * 41 * \remark No return value but this function updates group data structures. 42 */ 43 void av1_gop_setup_structure(struct AV1_COMP *cpi); 44 45 /*!\brief Distributes bits to frames in a group 46 * 47 *\ingroup rate_control 48 * 49 * This function decides on the allocation of bits between the different 50 * frames and types of frame in a GF/ARF group. 51 * 52 * \param[in] cpi Top - level encoder instance structure 53 * \param[in] rc Rate control data 54 * \param[in] gf_group GF/ARF group data structure 55 * \param[in] is_key_frame Indicates if the first frame in the group is 56 * also a key frame. 57 * \param[in] use_arf Are ARF frames enabled or is this a GF only 58 * uni-directional group. 59 * \param[in] gf_group_bits Bits available to be allocated. 60 * 61 * \remark No return but updates the rate control and group data structures 62 * to reflect the allocation of bits. 63 */ 64 void av1_gop_bit_allocation(const AV1_COMP *cpi, RATE_CONTROL *const rc, 65 GF_GROUP *gf_group, int is_key_frame, int use_arf, 66 int64_t gf_group_bits); 67 68 /*!\brief Check whether a frame in the GOP is a forward key frame 69 * 70 *\ingroup rate_control 71 * 72 * \param[in] gf_group GF/ARF group data structure 73 * \param[in] gf_frame_index GOP index 74 * 75 * \return Return 1 if it is a forward key frame, otherwise return 0 76 */ 77 int av1_gop_check_forward_keyframe(const GF_GROUP *gf_group, 78 int gf_frame_index); 79 80 /*!\brief Check whether a frame in the GOP is the second arf 81 * 82 *\ingroup rate_control 83 * 84 * \param[in] gf_group GF/ARF group data structure 85 * \param[in] gf_frame_index GOP index 86 * 87 * \return Return 1 if it is the second arf 88 */ 89 int av1_gop_is_second_arf(const GF_GROUP *gf_group, int gf_frame_index); 90 91 #ifdef __cplusplus 92 } // extern "C" 93 #endif 94 95 #endif // AOM_AV1_ENCODER_GOP_STRUCTURE_H_ 96