FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 #define FF_SANE_NB_CHANNELS 63U
37 
38 #if HAVE_AVX
39 # define STRIDE_ALIGN 32
40 #elif HAVE_NEON || ARCH_PPC || HAVE_MMX
41 # define STRIDE_ALIGN 16
42 #else
43 # define STRIDE_ALIGN 8
44 #endif
45 
46 typedef struct FramePool {
47  /**
48  * Pools for each data plane. For audio all the planes have the same size,
49  * so only pools[0] is used.
50  */
52 
53  /*
54  * Pool parameters
55  */
56  int format;
57  int width, height;
59  int linesize[4];
60  int planes;
61  int channels;
62  int samples;
63 } FramePool;
64 
65 typedef struct AVCodecInternal {
66  /**
67  * Whether the parent AVCodecContext is a copy of the context which had
68  * init() called on it.
69  * This is used by multithreading - shared tables and picture pointers
70  * should be freed from the original context only.
71  */
72  int is_copy;
73 
74  /**
75  * Whether to allocate progress for frame threading.
76  *
77  * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
78  * then progress will be allocated in ff_thread_get_buffer(). The frames
79  * then MUST be freed with ff_thread_release_buffer().
80  *
81  * If the codec does not need to call the progress functions (there are no
82  * dependencies between the frames), it should leave this at 0. Then it can
83  * decode straight to the user-provided frames (which the user will then
84  * free with av_frame_unref()), there is no need to call
85  * ff_thread_release_buffer().
86  */
88 
89 #if FF_API_OLD_ENCODE_AUDIO
90  /**
91  * Internal sample count used by avcodec_encode_audio() to fabricate pts.
92  * Can be removed along with avcodec_encode_audio().
93  */
94  int64_t sample_count;
95 #endif
96 
97  /**
98  * An audio frame with less than required samples has been submitted and
99  * padded with silence. Reject all subsequent frames.
100  */
102 
104 
106 
107  void *thread_ctx;
108 
109  /**
110  * Current packet as passed into the decoder, to avoid having to pass the
111  * packet into every function.
112  */
114 
115  /**
116  * temporary buffer used for encoders to store their bitstream
117  */
119  unsigned int byte_buffer_size;
120 
122 
123  /**
124  * Number of audio samples to skip at the start of the next decoded frame
125  */
127 
128  /**
129  * hwaccel-specific private data
130  */
133 
135  const uint8_t *key;
136  const uint8_t *value;
137 };
138 
139 extern const uint8_t ff_log2_run[41];
140 
141 /**
142  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
143  * If there is no such matching pair then size is returned.
144  */
145 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
146 
147 unsigned int avpriv_toupper4(unsigned int x);
148 
149 /**
150  * does needed setup of pkt_pts/pos and such for (re)get_buffer();
151  */
153 
154 
155 void avpriv_color_frame(AVFrame *frame, const int color[4]);
156 
157 extern volatile int ff_avcodec_locked;
158 int ff_lock_avcodec(AVCodecContext *log_ctx);
159 int ff_unlock_avcodec(void);
160 
161 int avpriv_lock_avformat(void);
162 int avpriv_unlock_avformat(void);
163 
164 /**
165  * Maximum size in bytes of extradata.
166  * This value was chosen such that every bit of the buffer is
167  * addressable by a 32-bit signed integer as used by get_bits.
168  */
169 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
170 
171 /**
172  * Check AVPacket size and/or allocate data.
173  *
174  * Encoders supporting AVCodec.encode2() can use this as a convenience to
175  * ensure the output packet data is large enough, whether provided by the user
176  * or allocated in this function.
177  *
178  * @param avctx the AVCodecContext of the encoder
179  * @param avpkt the AVPacket
180  * If avpkt->data is already set, avpkt->size is checked
181  * to ensure it is large enough.
182  * If avpkt->data is NULL, a new buffer is allocated.
183  * avpkt->size is set to the specified size.
184  * All other AVPacket fields will be reset with av_init_packet().
185  * @param size the minimum required packet size
186  * @return 0 on success, negative error code on failure
187  */
188 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size);
189 
190 int ff_alloc_packet(AVPacket *avpkt, int size);
191 
192 /**
193  * Rescale from sample rate to AVCodecContext.time_base.
194  */
196  int64_t samples)
197 {
198  if(samples == AV_NOPTS_VALUE)
199  return AV_NOPTS_VALUE;
200  return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
201  avctx->time_base);
202 }
203 
204 /**
205  * Get a buffer for a frame. This is a wrapper around
206  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
207  * directly.
208  */
209 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
210 
211 /**
212  * Identical in function to av_frame_make_writable(), except it uses
213  * ff_get_buffer() to allocate the buffer when needed.
214  */
216 
218 
220 
221 /**
222  * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
223  * calling the function and then restoring again. Assumes the mutex is
224  * already locked
225  */
227 
228 /**
229  * Finalize buf into extradata and set its size appropriately.
230  */
232 
233 const uint8_t *avpriv_find_start_code(const uint8_t *p,
234  const uint8_t *end,
235  uint32_t *state);
236 
237 /**
238  * Check that the provided frame dimensions are valid and set them on the codec
239  * context.
240  */
242 
243 /**
244  * Check that the provided sample aspect ratio is valid and set it on the codec
245  * context.
246  */
247 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
248 
249 /**
250  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
251  */
253  enum AVMatrixEncoding matrix_encoding);
254 
255 /**
256  * Select the (possibly hardware accelerated) pixel format.
257  * This is a wrapper around AVCodecContext.get_format() and should be used
258  * instead of calling get_format() directly.
259  */
260 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
261 
262 /**
263  * Set various frame properties from the codec context / packet data.
264  */
266 
267 #endif /* AVCODEC_INTERNAL_H */