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