2 * This file is part of FFmpeg.
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 #ifndef AVUTIL_VIDEO_ENC_PARAMS_H
20 #define AVUTIL_VIDEO_ENC_PARAMS_H
25 #include "libavutil/avassert.h"
26 #include "libavutil/frame.h"
28 enum AVVideoEncParamsType {
29 AV_VIDEO_ENC_PARAMS_NONE = -1,
32 * - per-frame base (luma AC) quantizer index, exported as AVVideoEncParams.qp
33 * - deltas for luma DC, chroma AC and chroma DC, exported in the
34 * corresponding entries in AVVideoEncParams.delta_qp
35 * - per-segment delta, exported as for each block as AVVideoBlockParams.delta_qp
37 * To compute the resulting quantizer index for a block:
38 * - for luma AC, add the base qp and the per-block delta_qp, saturating to
40 * - for luma DC and chroma AC/DC, add the corresponding
41 * AVVideoBlockParams.delta_qp to the luma AC index, again saturating to
44 AV_VIDEO_ENC_PARAMS_VP9,
48 * Video encoding parameters for a given frame. This struct is allocated along
49 * with an optional array of per-block AVVideoBlockParams descriptors.
50 * Must be allocated with av_video_enc_params_alloc().
52 typedef struct AVVideoEncParams {
54 * Number of blocks in the array.
56 * May be 0, in which case no per-block information is present. In this case
57 * the values of blocks_offset / block_size are unspecified and should not
60 unsigned int nb_blocks;
62 * Offset in bytes from the beginning of this structure at which the array
67 * Size of each block in bytes. May not match sizeof(AVVideoBlockParams).
72 * Type of the parameters (the codec they are used with).
74 enum AVVideoEncParamsType type;
77 * Base quantisation parameter for the frame. The final quantiser for a
78 * given block in a given plane is obtained from this value, possibly
79 * combined with {@code delta_qp} and the per-block delta in a manner
80 * documented for each type.
85 * Quantisation parameter offset from the base (per-frame) qp for a given
86 * plane (first index) and AC/DC coefficients (second index).
88 int32_t delta_qp[4][2];
92 * Data structure for storing block-level encoding information.
93 * It is allocated as a part of AVVideoEncParams and should be retrieved with
94 * av_video_enc_params_block().
96 * sizeof(AVVideoBlockParams) is not a part of the ABI and new fields may be
99 typedef struct AVVideoBlockParams {
101 * Distance in luma pixels from the top-left corner of the visible frame
102 * to the top-left corner of the block.
103 * Can be negative if top/right padding is present on the coded frame.
107 * Width and height of the block in luma pixels.
112 * Difference between this block's final quantization parameter and the
113 * corresponding per-frame value.
116 } AVVideoBlockParams;
119 * Get the block at the specified {@code idx}. Must be between 0 and nb_blocks.
121 static av_always_inline AVVideoBlockParams*
122 av_video_enc_params_block(AVVideoEncParams *par, unsigned int idx)
124 av_assert0(idx < par->nb_blocks);
125 return (AVVideoBlockParams *)((uint8_t *)par + par->blocks_offset +
126 idx * par->block_size);
130 * Allocates memory for AVVideoEncParams of the given type, plus an array of
131 * {@code nb_blocks} AVVideoBlockParams and initializes the variables. Can be
132 * freed with a normal av_free() call.
134 * @param out_size if non-NULL, the size in bytes of the resulting data array is
137 AVVideoEncParams *av_video_enc_params_alloc(enum AVVideoEncParamsType type,
138 unsigned int nb_blocks, size_t *out_size);
141 * Allocates memory for AVEncodeInfoFrame plus an array of
142 * {@code nb_blocks} AVEncodeInfoBlock in the given AVFrame {@code frame}
143 * as AVFrameSideData of type AV_FRAME_DATA_ENCODE_INFO
144 * and initializes the variables.
147 av_video_enc_params_create_side_data(AVFrame *frame, enum AVVideoEncParamsType type,
148 unsigned int nb_blocks);
150 #endif /* AVUTIL_VIDEO_ENC_PARAMS_H */