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 /*!\file
13 * \brief Declares frame encoding functions.
14 */
15 #ifndef AOM_AV1_ENCODER_ENCODE_STRATEGY_H_
16 #define AOM_AV1_ENCODER_ENCODE_STRATEGY_H_
17
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21
22 #include <stdint.h>
23
24 #include "aom/aom_encoder.h"
25
26 #include "av1/encoder/encoder.h"
27 #include "av1/encoder/firstpass.h"
28
29 /*!\brief Implement high-level encode strategy
30 *
31 * \ingroup high_level_algo
32 * \callgraph
33 * \callergraph
34 * This function will implement high-level encode strategy, choosing frame type,
35 * frame placement, etc. It populates an EncodeFrameParams struct with the
36 * results of these decisions and then encodes the frame. The caller should use
37 * the output parameters *time_stamp and *time_end only when this function
38 * returns AOM_CODEC_OK.
39 *
40 * \param[in] cpi Top-level encoder structure
41 * \param[in] size Bitstream size
42 * \param[in] dest Bitstream output
43 * \param[in] frame_flags Flags to decide how to encoding the frame
44 * \param[out] time_stamp Time stamp of the frame
45 * \param[out] time_end Time end
46 * \param[in] timestamp_ratio Time base
47 * \param[in] pop_lookahead Decide to pop the source frame from queue
48 * \param[in] flush Decide to encode one frame or the rest of frames
49 *
50 * \return Returns a value to indicate if the encoding is done successfully.
51 * \retval #AOM_CODEC_OK
52 * \retval -1
53 * \retval #AOM_CODEC_ERROR
54 */
55 int av1_encode_strategy(AV1_COMP *const cpi, size_t *const size,
56 uint8_t *const dest, unsigned int *frame_flags,
57 int64_t *const time_stamp, int64_t *const time_end,
58 const aom_rational64_t *const timestamp_ratio,
59 int *const pop_lookahead, int flush);
60
61 /*!\cond */
62 // Set individual buffer update flags based on frame reference type.
63 // force_refresh_all is used when we have a KEY_FRAME or S_FRAME. It forces all
64 // refresh_*_frame flags to be set, because we refresh all buffers in this case.
65 void av1_configure_buffer_updates(
66 AV1_COMP *const cpi, RefreshFrameFlagsInfo *const refresh_frame_flags,
67 const FRAME_UPDATE_TYPE type, const REFBUF_STATE refbuf_state,
68 int force_refresh_all);
69
70 int av1_get_refresh_frame_flags(const AV1_COMP *const cpi,
71 const EncodeFrameParams *const frame_params,
72 FRAME_UPDATE_TYPE frame_update_type,
73 int gf_index,
74 #if CONFIG_FRAME_PARALLEL_ENCODE
75 int cur_disp_order,
76 RefFrameMapPair ref_frame_map_pairs[REF_FRAMES],
77 #endif // CONFIG_FRAME_PARALLEL_ENCODE
78 const RefBufferStack *const ref_buffer_stack);
79
80 int av1_get_refresh_ref_frame_map(int refresh_frame_flags);
81
82 void av1_update_ref_frame_map(const AV1_COMP *cpi,
83 FRAME_UPDATE_TYPE frame_update_type,
84 REFBUF_STATE refbuf_state, int ref_map_index,
85 RefBufferStack *ref_buffer_stack);
86
87 /*!\brief Obtain indices of reference frames from reference frame buffer stacks
88 *
89 * \callgraph
90 * \callergraph
91 *
92 * \param[in] ref_buffer_stack Data structure for reference frame buffer
93 * stacks.
94 * \param[out] remapped_ref_idx An array for storing indices of reference
95 * frames. The index is used to retrieve a
96 * reference frame buffer from ref_frame_map
97 * in AV1Common.
98 */
99 void av1_get_ref_frames(const RefBufferStack *ref_buffer_stack,
100 #if CONFIG_FRAME_PARALLEL_ENCODE
101 RefFrameMapPair ref_frame_map_pairs[REF_FRAMES],
102 int cur_frame_disp,
103 #if CONFIG_FRAME_PARALLEL_ENCODE_2
104 const AV1_COMP *cpi, int gf_index,
105 int is_parallel_encode,
106 #endif // CONFIG_FRAME_PARALLEL_ENCODE_2
107 #endif // CONFIG_FRAME_PARALLEL_ENCODE
108 int remapped_ref_idx[REF_FRAMES]);
109
110 int is_forced_keyframe_pending(struct lookahead_ctx *lookahead,
111 const int up_to_index,
112 const COMPRESSOR_STAGE compressor_stage);
113
is_frame_droppable(const SVC * const svc,const ExtRefreshFrameFlagsInfo * const ext_refresh_frame_flags)114 static AOM_INLINE int is_frame_droppable(
115 const SVC *const svc,
116 const ExtRefreshFrameFlagsInfo *const ext_refresh_frame_flags) {
117 // Droppable frame is only used by external refresh flags. VoD setting won't
118 // trigger its use case.
119 if (svc->set_ref_frame_config)
120 return svc->non_reference_frame;
121 else if (ext_refresh_frame_flags->update_pending)
122 return !(ext_refresh_frame_flags->alt_ref_frame ||
123 ext_refresh_frame_flags->alt2_ref_frame ||
124 ext_refresh_frame_flags->bwd_ref_frame ||
125 ext_refresh_frame_flags->golden_frame ||
126 ext_refresh_frame_flags->last_frame);
127 else
128 return 0;
129 }
130
get_current_frame_ref_type(const AV1_COMP * const cpi)131 static AOM_INLINE int get_current_frame_ref_type(const AV1_COMP *const cpi) {
132 // We choose the reference "type" of this frame from the flags which indicate
133 // which reference frames will be refreshed by it. More than one of these
134 // flags may be set, so the order here implies an order of precedence. This is
135 // just used to choose the primary_ref_frame (as the most recent reference
136 // buffer of the same reference-type as the current frame).
137
138 switch (cpi->ppi->gf_group.layer_depth[cpi->gf_frame_index]) {
139 case 0: return 0;
140 case 1: return 1;
141 case MAX_ARF_LAYERS:
142 case MAX_ARF_LAYERS + 1: return 4;
143 default: return 7;
144 }
145 }
146
147 #if CONFIG_FRAME_PARALLEL_ENCODE
148 #if CONFIG_FRAME_PARALLEL_ENCODE_2
149 int av1_calc_refresh_idx_for_intnl_arf(
150 AV1_COMP *cpi, RefFrameMapPair ref_frame_map_pairs[REF_FRAMES],
151 int gf_index);
152 #endif // CONFIG_FRAME_PARALLEL_ENCODE_2
153 #endif // CONFIG_FRAME_PARALLEL_ENCODE
154 /*!\endcond */
155 #ifdef __cplusplus
156 } // extern "C"
157 #endif
158
159 #endif // AOM_AV1_ENCODER_ENCODE_STRATEGY_H_
160