Merge remote-tracking branch 'cehoyos/master'
[ffmpeg.git] / libavutil / internal.h
1 /*
2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 "timer.h"
40 #include "cpu.h"
41 #include "dict.h"
42 #include "version.h"
43
44 #if ARCH_X86
45 #   include "x86/emms.h"
46 #endif
47
48 #ifndef emms_c
49 #   define emms_c()
50 #endif
51
52 #ifndef attribute_align_arg
53 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
54 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
55 #else
56 #    define attribute_align_arg
57 #endif
58 #endif
59
60 #if defined(_MSC_VER) && CONFIG_SHARED
61 #    define av_export __declspec(dllimport)
62 #else
63 #    define av_export
64 #endif
65
66 #if HAVE_PRAGMA_DEPRECATED
67 #    if defined(__ICL) || defined (__INTEL_COMPILER)
68 #        define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:1478))
69 #        define FF_ENABLE_DEPRECATION_WARNINGS  __pragma(warning(pop))
70 #    elif defined(_MSC_VER)
71 #        define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:4996))
72 #        define FF_ENABLE_DEPRECATION_WARNINGS  __pragma(warning(pop))
73 #    else
74 #        define FF_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
75 #        define FF_ENABLE_DEPRECATION_WARNINGS  _Pragma("GCC diagnostic warning \"-Wdeprecated-declarations\"")
76 #    endif
77 #else
78 #    define FF_DISABLE_DEPRECATION_WARNINGS
79 #    define FF_ENABLE_DEPRECATION_WARNINGS
80 #endif
81
82 #ifndef INT_BIT
83 #    define INT_BIT (CHAR_BIT * sizeof(int))
84 #endif
85
86 #define FF_MEMORY_POISON 0x2a
87
88 #define MAKE_ACCESSORS(str, name, type, field) \
89     type av_##name##_get_##field(const str *s) { return s->field; } \
90     void av_##name##_set_##field(str *s, type v) { s->field = v; }
91
92 // Some broken preprocessors need a second expansion
93 // to be forced to tokenize __VA_ARGS__
94 #define E1(x) x
95
96 /* Check if the hard coded offset of a struct member still matches reality.
97  * Induce a compilation failure if not.
98  */
99 #define AV_CHECK_OFFSET(s, m, o) struct check_##o {    \
100         int x_##o[offsetof(s, m) == o? 1: -1];         \
101     }
102
103 #define LOCAL_ALIGNED_A(a, t, v, s, o, ...)             \
104     uint8_t la_##v[sizeof(t s o) + (a)];                \
105     t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
106
107 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...)             \
108     DECLARE_ALIGNED(a, t, la_##v) s o;                  \
109     t (*v) o = la_##v
110
111 #define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
112
113 #if HAVE_LOCAL_ALIGNED_8
114 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
115 #else
116 #   define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
117 #endif
118
119 #if HAVE_LOCAL_ALIGNED_16
120 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
121 #else
122 #   define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
123 #endif
124
125 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
126 {\
127     p = av_malloc(size);\
128     if (p == NULL && (size) != 0) {\
129         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
130         goto label;\
131     }\
132 }
133
134 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
135 {\
136     p = av_mallocz(size);\
137     if (p == NULL && (size) != 0) {\
138         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
139         goto label;\
140     }\
141 }
142
143 #define FF_ALLOC_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)\
144 {\
145     p = av_malloc_array(nelem, elsize);\
146     if (p == NULL) {\
147         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
148         goto label;\
149     }\
150 }
151
152 #define FF_ALLOCZ_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)\
153 {\
154     p = av_mallocz_array(nelem, elsize);\
155     if (p == NULL) {\
156         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
157         goto label;\
158     }\
159 }
160
161 #include "libm.h"
162
163 #if defined(_MSC_VER)
164 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_strtod")
165 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_snprintf")
166 #endif
167
168 /**
169  * Return NULL if CONFIG_SMALL is true, otherwise the argument
170  * without modification. Used to disable the definition of strings
171  * (for example AVCodec long_names).
172  */
173 #if CONFIG_SMALL
174 #   define NULL_IF_CONFIG_SMALL(x) NULL
175 #else
176 #   define NULL_IF_CONFIG_SMALL(x) x
177 #endif
178
179 /**
180  * Define a function with only the non-default version specified.
181  *
182  * On systems with ELF shared libraries, all symbols exported from
183  * FFmpeg libraries are tagged with the name and major version of the
184  * library to which they belong.  If a function is moved from one
185  * library to another, a wrapper must be retained in the original
186  * location to preserve binary compatibility.
187  *
188  * Functions defined with this macro will never be used to resolve
189  * symbols by the build-time linker.
190  *
191  * @param type return type of function
192  * @param name name of function
193  * @param args argument list of function
194  * @param ver  version tag to assign function
195  */
196 #if HAVE_SYMVER_ASM_LABEL
197 #   define FF_SYMVER(type, name, args, ver)                     \
198     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
199     type ff_##name args
200 #elif HAVE_SYMVER_GNU_ASM
201 #   define FF_SYMVER(type, name, args, ver)                             \
202     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
203     type ff_##name args;                                                \
204     type ff_##name args
205 #endif
206
207 /**
208  * Return NULL if a threading library has not been enabled.
209  * Used to disable threading functions in AVCodec definitions
210  * when not needed.
211  */
212 #if HAVE_THREADS
213 #   define ONLY_IF_THREADS_ENABLED(x) x
214 #else
215 #   define ONLY_IF_THREADS_ENABLED(x) NULL
216 #endif
217
218 /**
219  * Log a generic warning message about a missing feature.
220  *
221  * @param[in] avc a pointer to an arbitrary struct of which the first
222  *                field is a pointer to an AVClass struct
223  * @param[in] msg string containing the name of the missing feature
224  */
225 void avpriv_report_missing_feature(void *avc,
226                                    const char *msg, ...) av_printf_format(2, 3);
227
228 /**
229  * Log a generic warning message about a missing feature.
230  * Additionally request that a sample showcasing the feature be uploaded.
231  *
232  * @param[in] avc a pointer to an arbitrary struct of which the first field is
233  *                a pointer to an AVClass struct
234  * @param[in] msg string containing the name of the missing feature
235  */
236 void avpriv_request_sample(void *avc,
237                            const char *msg, ...) av_printf_format(2, 3);
238
239 #if HAVE_LIBC_MSVCRT
240 #define avpriv_open ff_open
241 #define PTRDIFF_SPECIFIER "Id"
242 #define SIZE_SPECIFIER "Iu"
243 #else
244 #define PTRDIFF_SPECIFIER "td"
245 #define SIZE_SPECIFIER "zu"
246 #endif
247
248 /**
249  * A wrapper for open() setting O_CLOEXEC.
250  */
251 int avpriv_open(const char *filename, int flags, ...);
252
253 #if FF_API_GET_CHANNEL_LAYOUT_COMPAT
254 uint64_t ff_get_channel_layout(const char *name, int compat);
255 #endif
256
257 #endif /* AVUTIL_INTERNAL_H */