Merge commit '33237123c83bf4f8345e6ac889ad2e7dbd303d0e'
[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
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 #    define FF_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
67 #    define FF_ENABLE_DEPRECATION_WARNINGS  _Pragma("GCC diagnostic warning \"-Wdeprecated-declarations\"")
68 #else
69 #    define FF_DISABLE_DEPRECATION_WARNINGS
70 #    define FF_ENABLE_DEPRECATION_WARNINGS
71 #endif
72
73 #ifndef INT_BIT
74 #    define INT_BIT (CHAR_BIT * sizeof(int))
75 #endif
76
77 #define FF_MEMORY_POISON 0x2a
78
79 #define MAKE_ACCESSORS(str, name, type, field) \
80     type av_##name##_get_##field(const str *s) { return s->field; } \
81     void av_##name##_set_##field(str *s, type v) { s->field = v; }
82
83 // Some broken preprocessors need a second expansion
84 // to be forced to tokenize __VA_ARGS__
85 #define E1(x) x
86
87 #define LOCAL_ALIGNED_A(a, t, v, s, o, ...)             \
88     uint8_t la_##v[sizeof(t s o) + (a)];                \
89     t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
90
91 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...)             \
92     DECLARE_ALIGNED(a, t, la_##v) s o;                  \
93     t (*v) o = la_##v
94
95 #define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
96
97 #if HAVE_LOCAL_ALIGNED_8
98 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
99 #else
100 #   define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
101 #endif
102
103 #if HAVE_LOCAL_ALIGNED_16
104 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
105 #else
106 #   define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
107 #endif
108
109 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
110 {\
111     p = av_malloc(size);\
112     if (p == NULL && (size) != 0) {\
113         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
114         goto label;\
115     }\
116 }
117
118 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
119 {\
120     p = av_mallocz(size);\
121     if (p == NULL && (size) != 0) {\
122         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
123         goto label;\
124     }\
125 }
126
127 #include "libm.h"
128
129 #if defined(_MSC_VER)
130 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_strtod")
131 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_snprintf")
132 #endif
133
134 /**
135  * Return NULL if CONFIG_SMALL is true, otherwise the argument
136  * without modification. Used to disable the definition of strings
137  * (for example AVCodec long_names).
138  */
139 #if CONFIG_SMALL
140 #   define NULL_IF_CONFIG_SMALL(x) NULL
141 #else
142 #   define NULL_IF_CONFIG_SMALL(x) x
143 #endif
144
145 /**
146  * Define a function with only the non-default version specified.
147  *
148  * On systems with ELF shared libraries, all symbols exported from
149  * FFmpeg libraries are tagged with the name and major version of the
150  * library to which they belong.  If a function is moved from one
151  * library to another, a wrapper must be retained in the original
152  * location to preserve binary compatibility.
153  *
154  * Functions defined with this macro will never be used to resolve
155  * symbols by the build-time linker.
156  *
157  * @param type return type of function
158  * @param name name of function
159  * @param args argument list of function
160  * @param ver  version tag to assign function
161  */
162 #if HAVE_SYMVER_ASM_LABEL
163 #   define FF_SYMVER(type, name, args, ver)                     \
164     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
165     type ff_##name args
166 #elif HAVE_SYMVER_GNU_ASM
167 #   define FF_SYMVER(type, name, args, ver)                             \
168     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
169     type ff_##name args;                                                \
170     type ff_##name args
171 #endif
172
173 /**
174  * Return NULL if a threading library has not been enabled.
175  * Used to disable threading functions in AVCodec definitions
176  * when not needed.
177  */
178 #if HAVE_THREADS
179 #   define ONLY_IF_THREADS_ENABLED(x) x
180 #else
181 #   define ONLY_IF_THREADS_ENABLED(x) NULL
182 #endif
183
184 /**
185  * Log a generic warning message about a missing feature.
186  *
187  * @param[in] avc a pointer to an arbitrary struct of which the first
188  *                field is a pointer to an AVClass struct
189  * @param[in] msg string containing the name of the missing feature
190  */
191 void avpriv_report_missing_feature(void *avc,
192                                    const char *msg, ...) av_printf_format(2, 3);
193
194 /**
195  * Log a generic warning message about a missing feature.
196  * Additionally request that a sample showcasing the feature be uploaded.
197  *
198  * @param[in] avc a pointer to an arbitrary struct of which the first field is
199  *                a pointer to an AVClass struct
200  * @param[in] msg string containing the name of the missing feature
201  */
202 void avpriv_request_sample(void *avc,
203                            const char *msg, ...) av_printf_format(2, 3);
204
205 /**
206  * A wrapper for open() setting O_CLOEXEC.
207  */
208 int avpriv_open(const char *filename, int flags, ...);
209
210 #endif /* AVUTIL_INTERNAL_H */