65437edc548e84a0a8d80453de2d2aed02fdb149
[libav.git] / libavcodec / internal.h
1 /*
2 * This file is part of Libav.
3 *
4 * Libav 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 * Libav 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 Libav; 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"
30 #include "libavutil/mathematics.h"
31 #include "libavutil/pixfmt.h"
32 #include "avcodec.h"
33
34 #define FF_SANE_NB_CHANNELS 63U
35
36 typedef struct FramePool {
37 /**
38 * Pools for each data plane. For audio all the planes have the same size,
39 * so only pools[0] is used.
40 */
41 AVBufferPool *pools[4];
42
43 /*
44 * Pool parameters
45 */
46 int format;
47 int width, height;
48 int stride_align[AV_NUM_DATA_POINTERS];
49 int linesize[4];
50 int planes;
51 int channels;
52 int samples;
53 } FramePool;
54
55 typedef struct AVCodecInternal {
56 /**
57 * Whether the parent AVCodecContext is a copy of the context which had
58 * init() called on it.
59 * This is used by multithreading - shared tables and picture pointers
60 * should be freed from the original context only.
61 */
62 int is_copy;
63
64 /**
65 * Whether to allocate progress for frame threading.
66 *
67 * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
68 * then progress will be allocated in ff_thread_get_buffer(). The frames
69 * then MUST be freed with ff_thread_release_buffer().
70 *
71 * If the codec does not need to call the progress functions (there are no
72 * dependencies between the frames), it should leave this at 0. Then it can
73 * decode straight to the user-provided frames (which the user will then
74 * free with av_frame_unref()), there is no need to call
75 * ff_thread_release_buffer().
76 */
77 int allocate_progress;
78
79 /**
80 * An audio frame with less than required samples has been submitted and
81 * padded with silence. Reject all subsequent frames.
82 */
83 int last_audio_frame;
84
85 AVFrame to_free;
86
87 FramePool *pool;
88 } AVCodecInternal;
89
90 struct AVCodecDefault {
91 const uint8_t *key;
92 const uint8_t *value;
93 };
94
95 /**
96 * Return the hardware accelerated codec for codec codec_id and
97 * pixel format pix_fmt.
98 *
99 * @param codec_id the codec to match
100 * @param pix_fmt the pixel format to match
101 * @return the hardware accelerated codec, or NULL if none was found.
102 */
103 AVHWAccel *ff_find_hwaccel(enum AVCodecID codec_id, enum AVPixelFormat pix_fmt);
104
105 /**
106 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
107 * If there is no such matching pair then size is returned.
108 */
109 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
110
111 unsigned int avpriv_toupper4(unsigned int x);
112
113 int avpriv_lock_avformat(void);
114 int avpriv_unlock_avformat(void);
115
116 /**
117 * Maximum size in bytes of extradata.
118 * This value was chosen such that every bit of the buffer is
119 * addressable by a 32-bit signed integer as used by get_bits.
120 */
121 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
122
123 /**
124 * Check AVPacket size and/or allocate data.
125 *
126 * Encoders supporting AVCodec.encode2() can use this as a convenience to
127 * ensure the output packet data is large enough, whether provided by the user
128 * or allocated in this function.
129 *
130 * @param avpkt the AVPacket
131 * If avpkt->data is already set, avpkt->size is checked
132 * to ensure it is large enough.
133 * If avpkt->data is NULL, a new buffer is allocated.
134 * avpkt->size is set to the specified size.
135 * All other AVPacket fields will be reset with av_init_packet().
136 * @param size the minimum required packet size
137 * @return 0 on success, negative error code on failure
138 */
139 int ff_alloc_packet(AVPacket *avpkt, int size);
140
141 /**
142 * Rescale from sample rate to AVCodecContext.time_base.
143 */
144 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
145 int64_t samples)
146 {
147 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
148 avctx->time_base);
149 }
150
151 /**
152 * Get a buffer for a frame. This is a wrapper around
153 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
154 * directly.
155 */
156 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
157
158 /**
159 * Identical in function to av_frame_make_writable(), except it uses
160 * ff_get_buffer() to allocate the buffer when needed.
161 */
162 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
163
164 #endif /* AVCODEC_INTERNAL_H */