swscale: fix gbrap to gbrap alpha scaling
[ffmpeg.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/channel_layout.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 #define FF_SIGNBIT(x) (x >> CHAR_BIT * sizeof(x) - 1)
39
40 typedef struct FramePool {
41     /**
42      * Pools for each data plane. For audio all the planes have the same size,
43      * so only pools[0] is used.
44      */
45     AVBufferPool *pools[4];
46
47     /*
48      * Pool parameters
49      */
50     int format;
51     int width, height;
52     int stride_align[AV_NUM_DATA_POINTERS];
53     int linesize[4];
54     int planes;
55     int channels;
56     int samples;
57 } FramePool;
58
59 typedef struct AVCodecInternal {
60     /**
61      * Whether the parent AVCodecContext is a copy of the context which had
62      * init() called on it.
63      * This is used by multithreading - shared tables and picture pointers
64      * should be freed from the original context only.
65      */
66     int is_copy;
67
68     /**
69      * Whether to allocate progress for frame threading.
70      *
71      * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
72      * then progress will be allocated in ff_thread_get_buffer(). The frames
73      * then MUST be freed with ff_thread_release_buffer().
74      *
75      * If the codec does not need to call the progress functions (there are no
76      * dependencies between the frames), it should leave this at 0. Then it can
77      * decode straight to the user-provided frames (which the user will then
78      * free with av_frame_unref()), there is no need to call
79      * ff_thread_release_buffer().
80      */
81     int allocate_progress;
82
83     /**
84      * An audio frame with less than required samples has been submitted and
85      * padded with silence. Reject all subsequent frames.
86      */
87     int last_audio_frame;
88
89     AVFrame *to_free;
90
91     FramePool *pool;
92
93     void *thread_ctx;
94
95     /**
96      * Current packet as passed into the decoder, to avoid having to pass the
97      * packet into every function.
98      */
99     AVPacket *pkt;
100
101     /**
102      * hwaccel-specific private data
103      */
104     void *hwaccel_priv_data;
105 } AVCodecInternal;
106
107 struct AVCodecDefault {
108     const uint8_t *key;
109     const uint8_t *value;
110 };
111
112 /**
113  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
114  * If there is no such matching pair then size is returned.
115  */
116 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
117
118 unsigned int avpriv_toupper4(unsigned int x);
119
120 int avpriv_lock_avformat(void);
121 int avpriv_unlock_avformat(void);
122
123 /**
124  * Maximum size in bytes of extradata.
125  * This value was chosen such that every bit of the buffer is
126  * addressable by a 32-bit signed integer as used by get_bits.
127  */
128 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
129
130 /**
131  * Check AVPacket size and/or allocate data.
132  *
133  * Encoders supporting AVCodec.encode2() can use this as a convenience to
134  * ensure the output packet data is large enough, whether provided by the user
135  * or allocated in this function.
136  *
137  * @param avpkt   the AVPacket
138  *                If avpkt->data is already set, avpkt->size is checked
139  *                to ensure it is large enough.
140  *                If avpkt->data is NULL, a new buffer is allocated.
141  *                avpkt->size is set to the specified size.
142  *                All other AVPacket fields will be reset with av_init_packet().
143  * @param size    the minimum required packet size
144  * @return        0 on success, negative error code on failure
145  */
146 int ff_alloc_packet(AVPacket *avpkt, int size);
147
148 /**
149  * Rescale from sample rate to AVCodecContext.time_base.
150  */
151 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
152                                                         int64_t samples)
153 {
154     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
155                         avctx->time_base);
156 }
157
158 /**
159  * Get a buffer for a frame. This is a wrapper around
160  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
161  * directly.
162  */
163 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
164
165 /**
166  * Identical in function to av_frame_make_writable(), except it uses
167  * ff_get_buffer() to allocate the buffer when needed.
168  */
169 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
170
171 const uint8_t *avpriv_find_start_code(const uint8_t *restrict p,
172                                       const uint8_t *end,
173                                       uint32_t *restrict state);
174
175 /**
176  * Check that the provided frame dimensions are valid and set them on the codec
177  * context.
178  */
179 int ff_set_dimensions(AVCodecContext *s, int width, int height);
180
181 /**
182  * Check that the provided sample aspect ratio is valid and set it on the codec
183  * context.
184  */
185 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
186
187 /**
188  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
189  */
190 int ff_side_data_update_matrix_encoding(AVFrame *frame,
191                                         enum AVMatrixEncoding matrix_encoding);
192
193 /**
194  * Select the (possibly hardware accelerated) pixel format.
195  * This is a wrapper around AVCodecContext.get_format() and should be used
196  * instead of calling get_format() directly.
197  */
198 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
199
200 /**
201  * Set various frame properties from the codec context / packet data.
202  */
203 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
204
205 #endif /* AVCODEC_INTERNAL_H */