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
31 #include "config.h"
32
33 #if CONFIG_LCMS2
34 # include "fflcms2.h"
35 #endif
36
37 #define FF_SANE_NB_CHANNELS 512U
38
39 #if HAVE_SIMD_ALIGN_64
40 # define STRIDE_ALIGN 64 /* AVX-512 */
41 #elif HAVE_SIMD_ALIGN_32
42 # define STRIDE_ALIGN 32
43 #elif HAVE_SIMD_ALIGN_16
44 # define STRIDE_ALIGN 16
45 #else
46 # define STRIDE_ALIGN 8
47 #endif
48
50 /**
51 * When using frame-threaded decoding, this field is set for the first
52 * worker thread (e.g. to decode extradata just once).
53 */
55
56 /**
57 * Audio encoders can set this flag during init to indicate that they
58 * want the small last frame to be padded to a multiple of pad_samples.
59 */
61
63
65
66 /**
67 * This packet is used to hold the packet given to decoders
68 * implementing the .decode API; it is unused by the generic
69 * code for decoders implementing the .receive_frame API and
70 * may be freely used (but not freed) by them with the caveat
71 * that the packet will be unreferenced generically in
72 * avcodec_flush_buffers().
73 */
76
77 /**
78 * Properties (timestamps+side data) extracted from the last packet passed
79 * for decoding.
80 */
82
83 /**
84 * temporary buffer used for encoders to store their bitstream
85 */
88
90
91 /**
92 * The input frame is stored here for encoders implementing the simple
93 * encode API.
94 *
95 * Not allocated in other cases.
96 */
98
99 /**
100 * When the AV_CODEC_FLAG_RECON_FRAME flag is used. the encoder should store
101 * here the reconstructed frame corresponding to the last returned packet.
102 *
103 * Not allocated in other cases.
104 */
106
107 /**
108 * If this is set, then FFCodec->close (if existing) needs to be called
109 * for the parent AVCodecContext.
110 */
112
113 /**
114 * Number of audio samples to skip at the start of the next decoded frame
115 */
117
118 /**
119 * hwaccel-specific private data
120 */
122
123 /**
124 * checks API usage: after codec draining, flush is required to resume operation
125 */
127
128 /**
129 * Temporary buffers for newly received or not yet output packets/frames.
130 */
134
135 #if FF_API_DROPCHANGED
136 /* used when avctx flag AV_CODEC_FLAG_DROPCHANGED is set */
142 #endif
143
144 #if CONFIG_LCMS2
145 FFIccContext icc;
/* used to read and write embedded ICC profiles */
146 #endif
147
148 /**
149 * Set when the user has been warned about a failed allocation from
150 * a fixed frame pool.
151 */
154
155 /**
156 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
157 * If there is no such matching pair then size is returned.
158 */
160
162
164
166
167 /**
168 * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
169 *
170 * @param frame Raw frame to get S12M timecode side data from
171 * @param rate The frame rate
172 * @param prefix_len Number of bytes to allocate before SEI message
173 * @param data Pointer to a variable to store allocated memory
174 * Upon return the variable will hold NULL on error or if frame has no S12M timecode info.
175 * Otherwise it will point to prefix_len uninitialized bytes followed by
176 * *sei_size SEI message
177 * @param sei_size Pointer to a variable to store generated SEI message length
178 * @return Zero on success, negative error code on failure
179 */
181 void **
data,
size_t *sei_size);
182
183 /**
184 * Get an estimated video bitrate based on frame size, frame rate and coded
185 * bits per pixel.
186 */
188
189 #endif /* AVCODEC_INTERNAL_H */