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