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