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