aac: Wait to know the channels before allocating frame
[libav.git] / libavutil / internal.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3 *
2912e87a 4 * This file is part of Libav.
b78e7197 5 *
2912e87a 6 * Libav is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
2912e87a 11 * Libav is distributed in the hope that it will be useful,
04d7f601
DB
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
2912e87a 17 * License along with Libav; if not, write to the Free Software
04d7f601
DB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
05020c89 21/**
ba87f080 22 * @file
89c9ff50 23 * common internal API header
05020c89
RD
24 */
25
98790382
SS
26#ifndef AVUTIL_INTERNAL_H
27#define AVUTIL_INTERNAL_H
05020c89 28
318049b8
MR
29#if !defined(DEBUG) && !defined(NDEBUG)
30# define NDEBUG
31#endif
32
ed0fd852 33#include <limits.h>
99545457 34#include <stdint.h>
318049b8
MR
35#include <stddef.h>
36#include <assert.h>
dbef3f46 37#include "config.h"
2ed6f399 38#include "attributes.h"
d9f80ea2 39#include "dict.h"
bb41115d 40#include "pixfmt.h"
d9f80ea2 41
ab441e20
DB
42#if ARCH_X86
43# include "x86/emms.h"
44#endif
45
4db96649
DB
46#ifndef emms_c
47# define emms_c()
48#endif
49
5e4c7ca2 50#ifndef attribute_align_arg
820818a3 51#if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
5e4c7ca2
RP
52# define attribute_align_arg __attribute__((force_align_arg_pointer))
53#else
54# define attribute_align_arg
55#endif
56#endif
57
d66c52c2
MS
58#if defined(_MSC_VER) && CONFIG_SHARED
59# define av_export __declspec(dllimport)
60#else
61# define av_export
62#endif
63
3a7050ff 64#if HAVE_PRAGMA_DEPRECATED
09f2581d
AS
65# if defined(__ICL)
66# define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:1478))
67# define FF_ENABLE_DEPRECATION_WARNINGS __pragma(warning(pop))
68# elif defined(_MSC_VER)
69# define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:4996))
70# define FF_ENABLE_DEPRECATION_WARNINGS __pragma(warning(pop))
71# else
72# define FF_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
73# define FF_ENABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic warning \"-Wdeprecated-declarations\"")
74# endif
3a7050ff
DB
75#else
76# define FF_DISABLE_DEPRECATION_WARNINGS
77# define FF_ENABLE_DEPRECATION_WARNINGS
78#endif
79
218aefce
DB
80// Some broken preprocessors need a second expansion
81// to be forced to tokenize __VA_ARGS__
fd1abf42 82#define E1(x) x
a88e1d1c
JG
83
84/* Check if the hard coded offset of a struct member still matches reality.
85 * Induce a compilation failure if not.
86 */
87#define AV_CHECK_OFFSET(s, m, o) struct check_##o { \
88 int x_##o[offsetof(s, m) == o? 1: -1]; \
89 }
218aefce
DB
90
91#define LOCAL_ALIGNED_A(a, t, v, s, o, ...) \
92 uint8_t la_##v[sizeof(t s o) + (a)]; \
93 t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
94
95#define LOCAL_ALIGNED_D(a, t, v, s, o, ...) \
96 DECLARE_ALIGNED(a, t, la_##v) s o; \
97 t (*v) o = la_##v
98
fd1abf42 99#define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
218aefce
DB
100
101#if HAVE_LOCAL_ALIGNED_8
fd1abf42 102# define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
218aefce
DB
103#else
104# define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
105#endif
106
107#if HAVE_LOCAL_ALIGNED_16
fd1abf42 108# define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
218aefce
DB
109#else
110# define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
111#endif
112
d31dbec3 113#define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
e48a0966 114{\
ee155011 115 p = av_malloc(size);\
f929ab05 116 if (!(p) && (size) != 0) {\
d31dbec3
RP
117 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
118 goto label;\
e48a0966
RP
119 }\
120}
121
d31dbec3 122#define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
05020c89 123{\
ee155011 124 p = av_mallocz(size);\
f929ab05 125 if (!(p) && (size) != 0) {\
d31dbec3
RP
126 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
127 goto label;\
05020c89
RD
128 }\
129}
130
335ee1aa 131#include "libm.h"
7b04b8a0 132
33237123 133#if defined(_MSC_VER)
06122c25
MS
134#pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_strtod")
135#pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_snprintf")
136#endif
137
d80a7fe5 138/**
49bd8e4b 139 * Return NULL if CONFIG_SMALL is true, otherwise the argument
bfe3676f 140 * without modification. Used to disable the definition of strings
d80a7fe5
AJ
141 * (for example AVCodec long_names).
142 */
143#if CONFIG_SMALL
144# define NULL_IF_CONFIG_SMALL(x) NULL
145#else
146# define NULL_IF_CONFIG_SMALL(x) x
147#endif
148
33586ee7
MN
149
150/**
cae70f99
MR
151 * Define a function with only the non-default version specified.
152 *
153 * On systems with ELF shared libraries, all symbols exported from
2912e87a 154 * Libav libraries are tagged with the name and major version of the
cae70f99
MR
155 * library to which they belong. If a function is moved from one
156 * library to another, a wrapper must be retained in the original
157 * location to preserve binary compatibility.
158 *
159 * Functions defined with this macro will never be used to resolve
160 * symbols by the build-time linker.
161 *
162 * @param type return type of function
163 * @param name name of function
164 * @param args argument list of function
165 * @param ver version tag to assign function
33586ee7 166 */
b462d132 167#if HAVE_SYMVER_ASM_LABEL
ccc87908
MR
168# define FF_SYMVER(type, name, args, ver) \
169 type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver); \
b462d132
MR
170 type ff_##name args
171#elif HAVE_SYMVER_GNU_ASM
ccc87908
MR
172# define FF_SYMVER(type, name, args, ver) \
173 __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver); \
174 type ff_##name args; \
b462d132
MR
175 type ff_##name args
176#endif
177
37b00b47 178/**
58c42af7 179 * Return NULL if a threading library has not been enabled.
37b00b47
AS
180 * Used to disable threading functions in AVCodec definitions
181 * when not needed.
182 */
183#if HAVE_THREADS
184# define ONLY_IF_THREADS_ENABLED(x) x
185#else
186# define ONLY_IF_THREADS_ENABLED(x) NULL
187#endif
188
f099d3d1
DB
189/**
190 * Log a generic warning message about a missing feature.
191 *
192 * @param[in] avc a pointer to an arbitrary struct of which the first
193 * field is a pointer to an AVClass struct
194 * @param[in] msg string containing the name of the missing feature
195 */
196void avpriv_report_missing_feature(void *avc,
197 const char *msg, ...) av_printf_format(2, 3);
198
199/**
200 * Log a generic warning message about a missing feature.
201 * Additionally request that a sample showcasing the feature be uploaded.
202 *
203 * @param[in] avc a pointer to an arbitrary struct of which the first field is
204 * a pointer to an AVClass struct
205 * @param[in] msg string containing the name of the missing feature
206 */
207void avpriv_request_sample(void *avc,
208 const char *msg, ...) av_printf_format(2, 3);
209
d64341e4 210#if HAVE_LIBC_MSVCRT
e743e7ae
MS
211#define avpriv_open ff_open
212#endif
213
869b04e8
RDC
214/**
215 * A wrapper for open() setting O_CLOEXEC.
216 */
217int avpriv_open(const char *filename, int flags, ...);
218
bb41115d
DB
219int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt);
220
98790382 221#endif /* AVUTIL_INTERNAL_H */