lavc: Add an internal wrapper around get_format()
[libav.git] / libavcodec / internal.h
CommitLineData
dbbec0c2 1/*
2912e87a 2 * This file is part of Libav.
dbbec0c2 3 *
2912e87a 4 * Libav is free software; you can redistribute it and/or
dbbec0c2
SS
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 *
2912e87a 9 * Libav is distributed in the hope that it will be useful,
dbbec0c2
SS
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
2912e87a 15 * License along with Libav; if not, write to the Free Software
dbbec0c2
SS
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19/**
ba87f080 20 * @file
dbbec0c2
SS
21 * common internal api header.
22 */
23
24#ifndef AVCODEC_INTERNAL_H
25#define AVCODEC_INTERNAL_H
26
a05aa821 27#include <stdint.h>
f3a29b75 28
759001c5 29#include "libavutil/buffer.h"
5b4797a2 30#include "libavutil/channel_layout.h"
91a28b0e 31#include "libavutil/mathematics.h"
f3a29b75 32#include "libavutil/pixfmt.h"
a05aa821 33#include "avcodec.h"
f1e93986 34#include "config.h"
a05aa821 35
192f1984 36#define FF_SANE_NB_CHANNELS 63U
bb6941af 37
759001c5 38typedef struct FramePool {
f3a29b75 39 /**
759001c5
AK
40 * Pools for each data plane. For audio all the planes have the same size,
41 * so only pools[0] is used.
f3a29b75 42 */
759001c5 43 AVBufferPool *pools[4];
f3a29b75 44
759001c5
AK
45 /*
46 * Pool parameters
f3a29b75 47 */
759001c5
AK
48 int format;
49 int width, height;
50 int stride_align[AV_NUM_DATA_POINTERS];
51 int linesize[4];
52 int planes;
53 int channels;
54 int samples;
55} FramePool;
f3a29b75 56
759001c5 57typedef struct AVCodecInternal {
f3a29b75
JR
58 /**
59 * Whether the parent AVCodecContext is a copy of the context which had
60 * init() called on it.
61 * This is used by multithreading - shared tables and picture pointers
62 * should be freed from the original context only.
63 */
64 int is_copy;
b2c75b6e 65
759001c5
AK
66 /**
67 * Whether to allocate progress for frame threading.
68 *
69 * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
70 * then progress will be allocated in ff_thread_get_buffer(). The frames
71 * then MUST be freed with ff_thread_release_buffer().
72 *
73 * If the codec does not need to call the progress functions (there are no
74 * dependencies between the frames), it should leave this at 0. Then it can
75 * decode straight to the user-provided frames (which the user will then
76 * free with av_frame_unref()), there is no need to call
77 * ff_thread_release_buffer().
78 */
79 int allocate_progress;
80
a5117a24
AK
81 /**
82 * An audio frame with less than required samples has been submitted and
83 * padded with silence. Reject all subsequent frames.
84 */
85 int last_audio_frame;
e57c4706 86
37a74901 87 AVFrame *to_free;
759001c5
AK
88
89 FramePool *pool;
38ecc370
AK
90
91 void *thread_ctx;
da6506c6
AK
92
93 /**
94 * Current packet as passed into the decoder, to avoid having to pass the
95 * packet into every function.
96 */
97 AVPacket *pkt;
f3a29b75
JR
98} AVCodecInternal;
99
84626b36
AK
100struct AVCodecDefault {
101 const uint8_t *key;
102 const uint8_t *value;
103};
104
dbbec0c2 105/**
49bd8e4b 106 * Return the hardware accelerated codec for codec codec_id and
bf7e799c 107 * pixel format pix_fmt.
a05aa821 108 *
08303d77 109 * @param avctx The codec context containing the codec_id and pixel format.
a05aa821
MN
110 * @return the hardware accelerated codec, or NULL if none was found.
111 */
08303d77 112AVHWAccel *ff_find_hwaccel(AVCodecContext *avctx);
a05aa821 113
9e2e8214
MN
114/**
115 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
116 * If there is no such matching pair then size is returned.
117 */
6c060b55
MN
118int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
119
0842d589 120unsigned int avpriv_toupper4(unsigned int x);
603a5f04 121
2d1b6fb7
MS
122int avpriv_lock_avformat(void);
123int avpriv_unlock_avformat(void);
124
4df30f71
AC
125/**
126 * Maximum size in bytes of extradata.
127 * This value was chosen such that every bit of the buffer is
128 * addressable by a 32-bit signed integer as used by get_bits.
129 */
130#define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
131
b2c75b6e
JR
132/**
133 * Check AVPacket size and/or allocate data.
134 *
135 * Encoders supporting AVCodec.encode2() can use this as a convenience to
136 * ensure the output packet data is large enough, whether provided by the user
137 * or allocated in this function.
138 *
139 * @param avpkt the AVPacket
140 * If avpkt->data is already set, avpkt->size is checked
141 * to ensure it is large enough.
142 * If avpkt->data is NULL, a new buffer is allocated.
1a670973 143 * avpkt->size is set to the specified size.
b2c75b6e
JR
144 * All other AVPacket fields will be reset with av_init_packet().
145 * @param size the minimum required packet size
146 * @return 0 on success, negative error code on failure
147 */
148int ff_alloc_packet(AVPacket *avpkt, int size);
149
91a28b0e
JR
150/**
151 * Rescale from sample rate to AVCodecContext.time_base.
152 */
153static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
154 int64_t samples)
155{
156 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
157 avctx->time_base);
158}
159
594d4d5d
AK
160/**
161 * Get a buffer for a frame. This is a wrapper around
162 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
163 * directly.
164 */
759001c5
AK
165int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
166
167/**
168 * Identical in function to av_frame_make_writable(), except it uses
169 * ff_get_buffer() to allocate the buffer when needed.
170 */
171int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
594d4d5d 172
f1e93986
MS
173const uint8_t *avpriv_find_start_code(const uint8_t *restrict p,
174 const uint8_t *end,
175 uint32_t *restrict state);
176
7644f5a8
AK
177/**
178 * Check that the provided frame dimensions are valid and set them on the codec
179 * context.
180 */
181int ff_set_dimensions(AVCodecContext *s, int width, int height);
182
5b4797a2
TW
183/**
184 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
185 */
186int ff_side_data_update_matrix_encoding(AVFrame *frame,
187 enum AVMatrixEncoding matrix_encoding);
188
4a0f6651 189/**
632ad224
AK
190 * Select the (possibly hardware accelerated) pixel format.
191 * This is a wrapper around AVCodecContext.get_format() and should be used
192 * instead of calling get_format() directly.
193 */
194int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
195
196/**
4a0f6651
AK
197 * Set various frame properties from the codec context / packet data.
198 */
199int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
200
dbbec0c2 201#endif /* AVCODEC_INTERNAL_H */