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(AV1_COMP *const cpi,
66 RefreshFrameInfo *const refresh_frame,
67 const FRAME_UPDATE_TYPE type,
68 const REFBUF_STATE refbuf_state,
69 int force_refresh_all);
70
71 int av1_get_refresh_frame_flags(
72 const AV1_COMP *const cpi, const EncodeFrameParams *const frame_params,
73 FRAME_UPDATE_TYPE frame_update_type, int gf_index, int cur_disp_order,
74 RefFrameMapPair ref_frame_map_pairs[REF_FRAMES]);
75
76 int av1_get_refresh_ref_frame_map(int refresh_frame_flags);
77
78 /*!\brief Obtain indices of reference frames in ref_frame_map
79 *
80 * \callgraph
81 * \callergraph
82 *
83 * \param[out] remapped_ref_idx An array for storing indices of reference
84 * frames. The index is used to retrieve a
85 * reference frame buffer from ref_frame_map
86 * in AV1Common.
87 */
88 void av1_get_ref_frames(RefFrameMapPair ref_frame_map_pairs[REF_FRAMES],
89 int cur_frame_disp, const AV1_COMP *cpi, int gf_index,
90 int is_parallel_encode,
91 int remapped_ref_idx[REF_FRAMES]);
92
93 int is_forced_keyframe_pending(struct lookahead_ctx *lookahead,
94 const int up_to_index,
95 const COMPRESSOR_STAGE compressor_stage);
96
is_frame_droppable(const RTC_REF * const rtc_ref,const ExtRefreshFrameFlagsInfo * const ext_refresh_frame_flags)97 static AOM_INLINE int is_frame_droppable(
98 const RTC_REF *const rtc_ref,
99 const ExtRefreshFrameFlagsInfo *const ext_refresh_frame_flags) {
100 // Droppable frame is only used by external refresh flags. VoD setting won't
101 // trigger its use case.
102 if (rtc_ref->set_ref_frame_config)
103 return rtc_ref->non_reference_frame;
104 else if (ext_refresh_frame_flags->update_pending)
105 return !(ext_refresh_frame_flags->alt_ref_frame ||
106 ext_refresh_frame_flags->alt2_ref_frame ||
107 ext_refresh_frame_flags->bwd_ref_frame ||
108 ext_refresh_frame_flags->golden_frame ||
109 ext_refresh_frame_flags->last_frame);
110 else
111 return 0;
112 }
113
get_current_frame_ref_type(const AV1_COMP * const cpi)114 static AOM_INLINE int get_current_frame_ref_type(const AV1_COMP *const cpi) {
115 // We choose the reference "type" of this frame from the flags which indicate
116 // which reference frames will be refreshed by it. More than one of these
117 // flags may be set, so the order here implies an order of precedence. This is
118 // just used to choose the primary_ref_frame (as the most recent reference
119 // buffer of the same reference-type as the current frame).
120
121 switch (cpi->ppi->gf_group.layer_depth[cpi->gf_frame_index]) {
122 case 0: return 0;
123 case 1: return 1;
124 case MAX_ARF_LAYERS:
125 case MAX_ARF_LAYERS + 1: return 4;
126 default: return 7;
127 }
128 }
129
130 int av1_calc_refresh_idx_for_intnl_arf(
131 AV1_COMP *cpi, RefFrameMapPair ref_frame_map_pairs[REF_FRAMES],
132 int gf_index);
133 /*!\endcond */
134 #ifdef __cplusplus
135 } // extern "C"
136 #endif
137
138 #endif // AOM_AV1_ENCODER_ENCODE_STRATEGY_H_
139