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 * This field is set to 1 when frame threading is being used and the parent
58 * AVCodecContext of this AVCodecInternal is a worker-thread context (i.e.
59 * one of those actually doing the decoding), 0 otherwise.
60 */
62
63 /**
64 * Audio encoders can set this flag during init to indicate that they
65 * want the small last frame to be padded to a multiple of pad_samples.
66 */
68
70
72
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 */
85
86 /**
87 * Properties (timestamps+side data) extracted from the last packet passed
88 * for decoding.
89 */
91
92 /**
93 * temporary buffer used for encoders to store their bitstream
94 */
97
99
100 /**
101 * The input frame is stored here for encoders implementing the simple
102 * encode API.
103 *
104 * Not allocated in other cases.
105 */
107
108 /**
109 * When the AV_CODEC_FLAG_RECON_FRAME flag is used. the encoder should store
110 * here the reconstructed frame corresponding to the last returned packet.
111 *
112 * Not allocated in other cases.
113 */
115
116 /**
117 * If this is set, then FFCodec->close (if existing) needs to be called
118 * for the parent AVCodecContext.
119 */
121
122 /**
123 * Number of audio samples to skip at the start of the next decoded frame
124 */
126
127 /**
128 * hwaccel-specific private data
129 */
131
132 /**
133 * decoding: AVERROR_EOF has been returned from ff_decode_get_packet(); must
134 * not be used by decoders that use the decode() callback, as they
135 * do not call ff_decode_get_packet() directly.
136 *
137 * encoding: a flush frame has been submitted to avcodec_send_frame().
138 */
140
141 /**
142 * Temporary buffers for newly received or not yet output packets/frames.
143 */
147
148 #if CONFIG_LCMS2
149 FFIccContext icc;
/* used to read and write embedded ICC profiles */
150 #endif
151
152 /**
153 * Set when the user has been warned about a failed allocation from
154 * a fixed frame pool.
155 */
158
159 /**
160 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
161 * If there is no such matching pair then size is returned.
162 */
164
166
168
170
171 /**
172 * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
173 *
174 * @param frame Raw frame to get S12M timecode side data from
175 * @param rate The frame rate
176 * @param prefix_len Number of bytes to allocate before SEI message
177 * @param data Pointer to a variable to store allocated memory
178 * Upon return the variable will hold NULL on error or if frame has no S12M timecode info.
179 * Otherwise it will point to prefix_len uninitialized bytes followed by
180 * *sei_size SEI message
181 * @param sei_size Pointer to a variable to store generated SEI message length
182 * @return Zero on success, negative error code on failure
183 */
185 void **
data,
size_t *sei_size);
186
187 /**
188 * Get an estimated video bitrate based on frame size, frame rate and coded
189 * bits per pixel.
190 */
192
193 #endif /* AVCODEC_INTERNAL_H */