remove #defines to prevent use of discouraged external functions
[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 #ifndef attribute_align_arg
43 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
44 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
45 #else
46 #    define attribute_align_arg
47 #endif
48 #endif
49
50 #if defined(_MSC_VER) && CONFIG_SHARED
51 #    define av_export __declspec(dllimport)
52 #else
53 #    define av_export
54 #endif
55
56 #ifndef INT_BIT
57 #    define INT_BIT (CHAR_BIT * sizeof(int))
58 #endif
59
60 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
61 {\
62     p = av_malloc(size);\
63     if (p == NULL && (size) != 0) {\
64         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
65         goto label;\
66     }\
67 }
68
69 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
70 {\
71     p = av_mallocz(size);\
72     if (p == NULL && (size) != 0) {\
73         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
74         goto label;\
75     }\
76 }
77
78 #include "libm.h"
79
80 /**
81  * Return NULL if CONFIG_SMALL is true, otherwise the argument
82  * without modification. Used to disable the definition of strings
83  * (for example AVCodec long_names).
84  */
85 #if CONFIG_SMALL
86 #   define NULL_IF_CONFIG_SMALL(x) NULL
87 #else
88 #   define NULL_IF_CONFIG_SMALL(x) x
89 #endif
90
91
92 /**
93  * Define a function with only the non-default version specified.
94  *
95  * On systems with ELF shared libraries, all symbols exported from
96  * Libav libraries are tagged with the name and major version of the
97  * library to which they belong.  If a function is moved from one
98  * library to another, a wrapper must be retained in the original
99  * location to preserve binary compatibility.
100  *
101  * Functions defined with this macro will never be used to resolve
102  * symbols by the build-time linker.
103  *
104  * @param type return type of function
105  * @param name name of function
106  * @param args argument list of function
107  * @param ver  version tag to assign function
108  */
109 #if HAVE_SYMVER_ASM_LABEL
110 #   define FF_SYMVER(type, name, args, ver)                     \
111     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
112     type ff_##name args
113 #elif HAVE_SYMVER_GNU_ASM
114 #   define FF_SYMVER(type, name, args, ver)                             \
115     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
116     type ff_##name args;                                                \
117     type ff_##name args
118 #endif
119
120 /**
121  * Return NULL if a threading library has not been enabled.
122  * Used to disable threading functions in AVCodec definitions
123  * when not needed.
124  */
125 #if HAVE_THREADS
126 #   define ONLY_IF_THREADS_ENABLED(x) x
127 #else
128 #   define ONLY_IF_THREADS_ENABLED(x) NULL
129 #endif
130
131 #if HAVE_MMX_INLINE
132 /**
133  * Empty mmx state.
134  * this must be called between any dsp function and float/double code.
135  * for example sin(); dsp->idct_put(); emms_c(); cos()
136  */
137 static av_always_inline void emms_c(void)
138 {
139     __asm__ volatile ("emms" ::: "memory");
140 }
141 #elif HAVE_MMX && HAVE_MM_EMPTY
142 #   include <mmintrin.h>
143 #   define emms_c _mm_empty
144 #else
145 #   define emms_c()
146 #endif /* HAVE_MMX_INLINE */
147
148 #endif /* AVUTIL_INTERNAL_H */