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