8a0076f9850587d838ff29fa52b62e484ca2a077
[ffmpeg.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 "mem.h"
42 #include "pixfmt.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)
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 // Some broken preprocessors need a second expansion
83 // to be forced to tokenize __VA_ARGS__
84 #define E1(x) x
85
86 /* Check if the hard coded offset of a struct member still matches reality.
87  * Induce a compilation failure if not.
88  */
89 #define AV_CHECK_OFFSET(s, m, o) struct check_##o {    \
90         int x_##o[offsetof(s, m) == o? 1: -1];         \
91     }
92
93 #define LOCAL_ALIGNED_A(a, t, v, s, o, ...)             \
94     uint8_t la_##v[sizeof(t s o) + (a)];                \
95     t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
96
97 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...)             \
98     DECLARE_ALIGNED(a, t, la_##v) s o;                  \
99     t (*v) o = la_##v
100
101 #define LOCAL_ALIGNED(a, t, v, ...) LOCAL_ALIGNED_##a(t, v, __VA_ARGS__)
102
103 #if HAVE_LOCAL_ALIGNED_8
104 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
105 #else
106 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_A(8, t, v, __VA_ARGS__,,))
107 #endif
108
109 #if HAVE_LOCAL_ALIGNED_16
110 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
111 #else
112 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_A(16, t, v, __VA_ARGS__,,))
113 #endif
114
115 #if HAVE_LOCAL_ALIGNED_32
116 #   define LOCAL_ALIGNED_32(t, v, ...) E1(LOCAL_ALIGNED_D(32, t, v, __VA_ARGS__,,))
117 #else
118 #   define LOCAL_ALIGNED_32(t, v, ...) E1(LOCAL_ALIGNED_A(32, t, v, __VA_ARGS__,,))
119 #endif
120
121 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
122 {\
123     p = av_malloc(size);\
124     if (!(p) && (size) != 0) {\
125         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
126         goto label;\
127     }\
128 }
129
130 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
131 {\
132     p = av_mallocz(size);\
133     if (!(p) && (size) != 0) {\
134         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
135         goto label;\
136     }\
137 }
138
139 #include "libm.h"
140
141 /**
142  * Return NULL if CONFIG_SMALL is true, otherwise the argument
143  * without modification. Used to disable the definition of strings
144  * (for example AVCodec long_names).
145  */
146 #if CONFIG_SMALL
147 #   define NULL_IF_CONFIG_SMALL(x) NULL
148 #else
149 #   define NULL_IF_CONFIG_SMALL(x) x
150 #endif
151
152
153 /**
154  * Define a function with only the non-default version specified.
155  *
156  * On systems with ELF shared libraries, all symbols exported from
157  * Libav libraries are tagged with the name and major version of the
158  * library to which they belong.  If a function is moved from one
159  * library to another, a wrapper must be retained in the original
160  * location to preserve binary compatibility.
161  *
162  * Functions defined with this macro will never be used to resolve
163  * symbols by the build-time linker.
164  *
165  * @param type return type of function
166  * @param name name of function
167  * @param args argument list of function
168  * @param ver  version tag to assign function
169  */
170 #if HAVE_SYMVER_ASM_LABEL
171 #   define FF_SYMVER(type, name, args, ver)                     \
172     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
173     type ff_##name args
174 #elif HAVE_SYMVER_GNU_ASM
175 #   define FF_SYMVER(type, name, args, ver)                             \
176     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
177     type ff_##name args;                                                \
178     type ff_##name args
179 #endif
180
181 /**
182  * Return NULL if a threading library has not been enabled.
183  * Used to disable threading functions in AVCodec definitions
184  * when not needed.
185  */
186 #if HAVE_THREADS
187 #   define ONLY_IF_THREADS_ENABLED(x) x
188 #else
189 #   define ONLY_IF_THREADS_ENABLED(x) NULL
190 #endif
191
192 /**
193  * Log a generic warning message about a missing feature.
194  *
195  * @param[in] avc a pointer to an arbitrary struct of which the first
196  *                field is a pointer to an AVClass struct
197  * @param[in] msg string containing the name of the missing feature
198  */
199 void avpriv_report_missing_feature(void *avc,
200                                    const char *msg, ...) av_printf_format(2, 3);
201
202 /**
203  * Log a generic warning message about a missing feature.
204  * Additionally request that a sample showcasing the feature be uploaded.
205  *
206  * @param[in] avc a pointer to an arbitrary struct of which the first field is
207  *                a pointer to an AVClass struct
208  * @param[in] msg string containing the name of the missing feature
209  */
210 void avpriv_request_sample(void *avc,
211                            const char *msg, ...) av_printf_format(2, 3);
212
213 #if HAVE_LIBC_MSVCRT
214 #include <crtversion.h>
215 #if defined(_VC_CRT_MAJOR_VERSION) && _VC_CRT_MAJOR_VERSION < 14
216 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_strtod")
217 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_snprintf")
218 #endif
219
220 #define avpriv_open ff_open
221 #endif
222
223 /**
224  * A wrapper for open() setting O_CLOEXEC.
225  */
226 int avpriv_open(const char *filename, int flags, ...);
227
228 int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt);
229
230 #endif /* AVUTIL_INTERNAL_H */