FFmpeg
internal.h
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
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.
8  *
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.
13  *
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
17  */
18 
19 /**
20  * @file
21  * common internal api header.
22  */
23 
24 #ifndef AVCODEC_INTERNAL_H
25 #define AVCODEC_INTERNAL_H
26 
27 #include <stdint.h>
28 
29 #include "libavutil/buffer.h"
31 #include "libavutil/mathematics.h"
32 #include "libavutil/pixfmt.h"
33 #include "avcodec.h"
34 #include "config.h"
35 
36 #if CONFIG_LCMS2
37 # include "fflcms2.h"
38 #endif
39 
40 #define FF_SANE_NB_CHANNELS 512U
41 
42 #if HAVE_SIMD_ALIGN_64
43 # define STRIDE_ALIGN 64 /* AVX-512 */
44 #elif HAVE_SIMD_ALIGN_32
45 # define STRIDE_ALIGN 32
46 #elif HAVE_SIMD_ALIGN_16
47 # define STRIDE_ALIGN 16
48 #else
49 # define STRIDE_ALIGN 8
50 #endif
51 
52 typedef struct AVCodecInternal {
53  /**
54  * When using frame-threaded decoding, this field is set for the first
55  * worker thread (e.g. to decode extradata just once).
56  */
57  int is_copy;
58 
59  /**
60  * An audio frame with less than required samples has been submitted (and
61  * potentially padded with silence). Reject all subsequent frames.
62  */
64 
65  /**
66  * Audio encoders can set this flag during init to indicate that they
67  * want the small last frame to be padded to a multiple of pad_samples.
68  */
70 
72 
73  void *thread_ctx;
74 
75  /**
76  * This packet is used to hold the packet given to decoders
77  * implementing the .decode API; it is unused by the generic
78  * code for decoders implementing the .receive_frame API and
79  * may be freely used (but not freed) by them with the caveat
80  * that the packet will be unreferenced generically in
81  * avcodec_flush_buffers().
82  */
84  struct AVBSFContext *bsf;
85 
86  /**
87  * Properties (timestamps+side data) extracted from the last packet passed
88  * for decoding.
89  */
91  struct AVFifo *pkt_props;
92 
93  /**
94  * temporary buffer used for encoders to store their bitstream
95  */
96  uint8_t *byte_buffer;
97  unsigned int byte_buffer_size;
98 
99  /**
100  * This is set to AV_PKT_FLAG_KEY for encoders that encode intra-only
101  * formats (i.e. whose codec descriptor has AV_CODEC_PROP_INTRA_ONLY set).
102  * This is used to set said flag generically for said encoders.
103  */
105 
107 
108  /**
109  * The input frame is stored here for encoders implementing the simple
110  * encode API.
111  *
112  * Not allocated in other cases.
113  */
115 
116  /**
117  * When the AV_CODEC_FLAG_RECON_FRAME flag is used. the encoder should store
118  * here the reconstructed frame corresponding to the last returned packet.
119  *
120  * Not allocated in other cases.
121  */
123 
124  /**
125  * If this is set, then FFCodec->close (if existing) needs to be called
126  * for the parent AVCodecContext.
127  */
129 
130  /**
131  * Number of audio samples to skip at the start of the next decoded frame
132  */
134 
135  /**
136  * hwaccel-specific private data
137  */
139 
140  /**
141  * checks API usage: after codec draining, flush is required to resume operation
142  */
143  int draining;
144 
145  /**
146  * Temporary buffers for newly received or not yet output packets/frames.
147  */
151 
153 
154  /* to prevent infinite loop on errors when draining */
156 
157  /* used when avctx flag AV_CODEC_FLAG_DROPCHANGED is set */
163 
164 #if CONFIG_LCMS2
165  FFIccContext icc; /* used to read and write embedded ICC profiles */
166 #endif
168 
169 /**
170  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
171  * If there is no such matching pair then size is returned.
172  */
173 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
174 
175 unsigned int ff_toupper4(unsigned int x);
176 
177 void ff_color_frame(AVFrame *frame, const int color[4]);
178 
179 /**
180  * Maximum size in bytes of extradata.
181  * This value was chosen such that every bit of the buffer is
182  * addressable by a 32-bit signed integer as used by get_bits.
183  */
184 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
185 
186 /**
187  * 2^(x) for integer x
188  * @return correctly rounded float
189  */
190 static av_always_inline float ff_exp2fi(int x) {
191  /* Normal range */
192  if (-126 <= x && x <= 128)
193  return av_int2float((x+127) << 23);
194  /* Too large */
195  else if (x > 128)
196  return INFINITY;
197  /* Subnormal numbers */
198  else if (x > -150)
199  return av_int2float(1 << (x+149));
200  /* Negligibly small */
201  else
202  return 0;
203 }
204 
206 
208 
209 /**
210  * Add a CPB properties side data to an encoding context.
211  */
213 
214 /**
215  * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
216  *
217  * @param frame Raw frame to get S12M timecode side data from
218  * @param rate The frame rate
219  * @param prefix_len Number of bytes to allocate before SEI message
220  * @param data Pointer to a variable to store allocated memory
221  * Upon return the variable will hold NULL on error or if frame has no S12M timecode info.
222  * Otherwise it will point to prefix_len uninitialized bytes followed by
223  * *sei_size SEI message
224  * @param sei_size Pointer to a variable to store generated SEI message length
225  * @return Zero on success, negative error code on failure
226  */
227 int ff_alloc_timecode_sei(const AVFrame *frame, AVRational rate, size_t prefix_len,
228  void **data, size_t *sei_size);
229 
230 /**
231  * Get an estimated video bitrate based on frame size, frame rate and coded
232  * bits per pixel.
233  */
234 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
235 
236 /**
237  * Check if a value is in the list. If not, return the default value
238  *
239  * @param ctx Context for the log msg
240  * @param val_name Name of the checked value, for log msg
241  * @param array_valid_values Array of valid int, ended with INT_MAX
242  * @param default_value Value return if checked value is not in the array
243  * @return Value or default_value.
244  */
245 int ff_int_from_list_or_default(void *ctx, const char * val_name, int val,
246  const int * array_valid_values, int default_value);
247 
248 #endif /* AVCODEC_INTERNAL_H */
ff_guess_coded_bitrate
int64_t ff_guess_coded_bitrate(AVCodecContext *avctx)
Get an estimated video bitrate based on frame size, frame rate and coded bits per pixel.
Definition: utils.c:1126
AVCodecInternal::initial_sample_rate
int initial_sample_rate
Definition: internal.h:161
AVCodec
AVCodec.
Definition: codec.h:204
INFINITY
#define INFINITY
Definition: mathematics.h:67
color
Definition: vf_paletteuse.c:601
AVCodecInternal::skip_samples
int skip_samples
Number of audio samples to skip at the start of the next decoded frame.
Definition: internal.h:133
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
AVCodecInternal::frame_thread_encoder
void * frame_thread_encoder
Definition: internal.h:106
AVCodecInternal::in_frame
AVFrame * in_frame
The input frame is stored here for encoders implementing the simple encode API.
Definition: internal.h:114
b
#define b
Definition: input.c:41
data
const char data[16]
Definition: mxf.c:146
ff_toupper4
unsigned int ff_toupper4(unsigned int x)
Definition: to_upper4.h:29
mathematics.h
ff_add_cpb_side_data
AVCPBProperties * ff_add_cpb_side_data(AVCodecContext *avctx)
Add a CPB properties side data to an encoding context.
Definition: utils.c:1022
AVBSFContext
The bitstream filter state.
Definition: bsf.h:68
AVCodecInternal::pool
AVBufferRef * pool
Definition: internal.h:71
AVCodecInternal::is_copy
int is_copy
When using frame-threaded decoding, this field is set for the first worker thread (e....
Definition: internal.h:57
ff_match_2uint16
int ff_match_2uint16(const uint16_t(*tab)[2], int size, int a, int b)
Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
Definition: utils.c:866
AVCodecInternal::showed_multi_packet_warning
int showed_multi_packet_warning
Definition: internal.h:152
av_int2float
static av_always_inline float av_int2float(uint32_t i)
Reinterpret a 32-bit integer as a float.
Definition: intfloat.h:40
tab
static const struct twinvq_data tab
Definition: twinvq_data.h:10345
val
static double val(void *priv, double ch)
Definition: aeval.c:77
ff_exp2fi
static av_always_inline float ff_exp2fi(int x)
2^(x) for integer x
Definition: internal.h:190
ff_color_frame
void ff_color_frame(AVFrame *frame, const int color[4])
Definition: utils.c:403
AVCodecInternal::buffer_pkt
AVPacket * buffer_pkt
Temporary buffers for newly received or not yet output packets/frames.
Definition: internal.h:148
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AVCPBProperties
This structure describes the bitrate properties of an encoded bitstream.
Definition: defs.h:126
AVCodecInternal::changed_frames_dropped
int changed_frames_dropped
Definition: internal.h:158
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVCodecInternal::initial_height
int initial_height
Definition: internal.h:160
AVCodecInternal::draining_done
int draining_done
Definition: internal.h:150
AVCodecInternal::last_pkt_props
AVPacket * last_pkt_props
Properties (timestamps+side data) extracted from the last packet passed for decoding.
Definition: internal.h:90
AVFifo
Definition: fifo.c:35
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:293
AVCodecInternal::hwaccel_priv_data
void * hwaccel_priv_data
hwaccel-specific private data
Definition: internal.h:138
ff_alloc_timecode_sei
int ff_alloc_timecode_sei(const AVFrame *frame, AVRational rate, size_t prefix_len, void **data, size_t *sei_size)
Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info.
Definition: utils.c:1062
AVCodecInternal::initial_format
int initial_format
Definition: internal.h:159
AVCodecInternal::bsf
struct AVBSFContext * bsf
Definition: internal.h:84
size
int size
Definition: twinvq_data.h:10344
AVCodecInternal::byte_buffer
uint8_t * byte_buffer
temporary buffer used for encoders to store their bitstream
Definition: internal.h:96
buffer.h
a
The reader does not expect b to be semantically here and if the code is changed by maybe adding a a division or other the signedness will almost certainly be mistaken To avoid this confusion a new type was SUINT is the C unsigned type but it holds a signed int to use the same example SUINT a
Definition: undefined.txt:41
AVCodecInternal
Definition: internal.h:52
AVCodecInternal::byte_buffer_size
unsigned int byte_buffer_size
Definition: internal.h:97
AVCodecInternal::pkt_props
struct AVFifo * pkt_props
Definition: internal.h:91
FFIccContext
Definition: fflcms2.h:34
AVCodecInternal::initial_width
int initial_width
Definition: internal.h:160
AVCodecInternal::in_pkt
AVPacket * in_pkt
This packet is used to hold the packet given to decoders implementing the .decode API; it is unused b...
Definition: internal.h:83
av_always_inline
#define av_always_inline
Definition: attributes.h:49
AVCodecInternal::nb_draining_errors
int nb_draining_errors
Definition: internal.h:155
AVCodecInternal::last_audio_frame
int last_audio_frame
An audio frame with less than required samples has been submitted (and potentially padded with silenc...
Definition: internal.h:63
avcodec.h
pixfmt.h
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AVCodecInternal::recon_frame
AVFrame * recon_frame
When the AV_CODEC_FLAG_RECON_FRAME flag is used.
Definition: internal.h:122
AVCodecInternal::needs_close
int needs_close
If this is set, then FFCodec->close (if existing) needs to be called for the parent AVCodecContext.
Definition: internal.h:128
AVCodecContext
main external API structure.
Definition: avcodec.h:398
channel_layout.h
AVCodecInternal::pad_samples
int pad_samples
Audio encoders can set this flag during init to indicate that they want the small last frame to be pa...
Definition: internal.h:69
AVCodecInternal::buffer_frame
AVFrame * buffer_frame
Definition: internal.h:149
AVCodecInternal::draining
int draining
checks API usage: after codec draining, flush is required to resume operation
Definition: internal.h:143
AVCodecInternal::intra_only_flag
int intra_only_flag
This is set to AV_PKT_FLAG_KEY for encoders that encode intra-only formats (i.e.
Definition: internal.h:104
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
AVCodecInternal::initial_ch_layout
AVChannelLayout initial_ch_layout
Definition: internal.h:162
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecInternal::thread_ctx
void * thread_ctx
Definition: internal.h:73
avpriv_h264_has_num_reorder_frames
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx)
Definition: h264dec.c:57
avpriv_codec_get_cap_skip_frame_fill_param
int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec)
Definition: utils.c:432
ff_int_from_list_or_default
int ff_int_from_list_or_default(void *ctx, const char *val_name, int val, const int *array_valid_values, int default_value)
Check if a value is in the list.
Definition: utils.c:1147