Merge remote-tracking branch 'qatar/master'
[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 #ifndef attribute_align_arg
44 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
45 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
46 #else
47 #    define attribute_align_arg
48 #endif
49 #endif
50
51 #if defined(_MSC_VER) && CONFIG_SHARED
52 #    define av_export __declspec(dllimport)
53 #else
54 #    define av_export
55 #endif
56
57 #ifndef INT_BIT
58 #    define INT_BIT (CHAR_BIT * sizeof(int))
59 #endif
60
61 // Some broken preprocessors need a second expansion
62 // to be forced to tokenize __VA_ARGS__
63 #define E1(x) x
64
65 #define LOCAL_ALIGNED_A(a, t, v, s, o, ...)             \
66     uint8_t la_##v[sizeof(t s o) + (a)];                \
67     t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
68
69 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...)             \
70     DECLARE_ALIGNED(a, t, la_##v) s o;                  \
71     t (*v) o = la_##v
72
73 #define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
74
75 #if HAVE_LOCAL_ALIGNED_8
76 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
77 #else
78 #   define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
79 #endif
80
81 #if HAVE_LOCAL_ALIGNED_16
82 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
83 #else
84 #   define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
85 #endif
86
87 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
88 {\
89     p = av_malloc(size);\
90     if (p == NULL && (size) != 0) {\
91         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
92         goto label;\
93     }\
94 }
95
96 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
97 {\
98     p = av_mallocz(size);\
99     if (p == NULL && (size) != 0) {\
100         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
101         goto label;\
102     }\
103 }
104
105 #include "libm.h"
106
107 /**
108  * Return NULL if CONFIG_SMALL is true, otherwise the argument
109  * without modification. Used to disable the definition of strings
110  * (for example AVCodec long_names).
111  */
112 #if CONFIG_SMALL
113 #   define NULL_IF_CONFIG_SMALL(x) NULL
114 #else
115 #   define NULL_IF_CONFIG_SMALL(x) x
116 #endif
117
118 /**
119  * Define a function with only the non-default version specified.
120  *
121  * On systems with ELF shared libraries, all symbols exported from
122  * FFmpeg libraries are tagged with the name and major version of the
123  * library to which they belong.  If a function is moved from one
124  * library to another, a wrapper must be retained in the original
125  * location to preserve binary compatibility.
126  *
127  * Functions defined with this macro will never be used to resolve
128  * symbols by the build-time linker.
129  *
130  * @param type return type of function
131  * @param name name of function
132  * @param args argument list of function
133  * @param ver  version tag to assign function
134  */
135 #if HAVE_SYMVER_ASM_LABEL
136 #   define FF_SYMVER(type, name, args, ver)                     \
137     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
138     type ff_##name args
139 #elif HAVE_SYMVER_GNU_ASM
140 #   define FF_SYMVER(type, name, args, ver)                             \
141     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
142     type ff_##name args;                                                \
143     type ff_##name args
144 #endif
145
146 /**
147  * Return NULL if a threading library has not been enabled.
148  * Used to disable threading functions in AVCodec definitions
149  * when not needed.
150  */
151 #if HAVE_THREADS
152 #   define ONLY_IF_THREADS_ENABLED(x) x
153 #else
154 #   define ONLY_IF_THREADS_ENABLED(x) NULL
155 #endif
156
157 #if HAVE_MMX_INLINE
158 /**
159  * Empty mmx state.
160  * this must be called between any dsp function and float/double code.
161  * for example sin(); dsp->idct_put(); emms_c(); cos()
162  */
163 static av_always_inline void emms_c(void)
164 {
165     if(av_get_cpu_flags() & AV_CPU_FLAG_MMX)
166         __asm__ volatile ("emms" ::: "memory");
167 }
168 #elif HAVE_MMX && HAVE_MM_EMPTY
169 #   include <mmintrin.h>
170 #   define emms_c _mm_empty
171 #elif HAVE_MMX && HAVE_YASM
172 #   include "libavutil/x86/emms.h"
173 #   define emms_c avpriv_emms_yasm
174 #else
175 #   define emms_c()
176 #endif /* HAVE_MMX_INLINE */
177
178 #endif /* AVUTIL_INTERNAL_H */