Move MASK_ABS macro to libavcodec/mathops.h
[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 struct AVDictionary {
43     int count;
44     AVDictionaryEntry *elems;
45 };
46
47 #ifndef attribute_align_arg
48 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
49 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
50 #else
51 #    define attribute_align_arg
52 #endif
53 #endif
54
55 #ifndef INT16_MIN
56 #define INT16_MIN       (-0x7fff - 1)
57 #endif
58
59 #ifndef INT16_MAX
60 #define INT16_MAX       0x7fff
61 #endif
62
63 #ifndef INT32_MIN
64 #define INT32_MIN       (-0x7fffffff - 1)
65 #endif
66
67 #ifndef INT32_MAX
68 #define INT32_MAX       0x7fffffff
69 #endif
70
71 #ifndef UINT32_MAX
72 #define UINT32_MAX      0xffffffff
73 #endif
74
75 #ifndef INT64_MIN
76 #define INT64_MIN       (-0x7fffffffffffffffLL - 1)
77 #endif
78
79 #ifndef INT64_MAX
80 #define INT64_MAX INT64_C(9223372036854775807)
81 #endif
82
83 #ifndef UINT64_MAX
84 #define UINT64_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
85 #endif
86
87 #ifndef INT_BIT
88 #    define INT_BIT (CHAR_BIT * sizeof(int))
89 #endif
90
91 #ifndef offsetof
92 #    define offsetof(T, F) ((unsigned int)((char *)&((T *)0)->F))
93 #endif
94
95 /* debug stuff */
96
97 #define av_abort()      do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
98
99 /* avoid usage of dangerous/inappropriate system functions */
100 #undef  malloc
101 #define malloc please_use_av_malloc
102 #undef  free
103 #define free please_use_av_free
104 #undef  realloc
105 #define realloc please_use_av_realloc
106 #undef  time
107 #define time time_is_forbidden_due_to_security_issues
108 #undef  rand
109 #define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
110 #undef  srand
111 #define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
112 #undef  random
113 #define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
114 #undef  sprintf
115 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
116 #undef  strcat
117 #define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
118 #undef  strncpy
119 #define strncpy strncpy_is_forbidden_due_to_security_issues_use_av_strlcpy
120 #undef  exit
121 #define exit exit_is_forbidden
122 #undef  printf
123 #define printf please_use_av_log_instead_of_printf
124 #undef  fprintf
125 #define fprintf please_use_av_log_instead_of_fprintf
126 #undef  puts
127 #define puts please_use_av_log_instead_of_puts
128 #undef  perror
129 #define perror please_use_av_log_instead_of_perror
130 #undef strcasecmp
131 #define strcasecmp please_use_av_strcasecmp
132 #undef strncasecmp
133 #define strncasecmp please_use_av_strncasecmp
134
135 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
136 {\
137     p = av_malloc(size);\
138     if (p == NULL && (size) != 0) {\
139         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
140         goto label;\
141     }\
142 }
143
144 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
145 {\
146     p = av_mallocz(size);\
147     if (p == NULL && (size) != 0) {\
148         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
149         goto label;\
150     }\
151 }
152
153 #include "libm.h"
154
155 /**
156  * Return NULL if CONFIG_SMALL is true, otherwise the argument
157  * without modification. Used to disable the definition of strings
158  * (for example AVCodec long_names).
159  */
160 #if CONFIG_SMALL
161 #   define NULL_IF_CONFIG_SMALL(x) NULL
162 #else
163 #   define NULL_IF_CONFIG_SMALL(x) x
164 #endif
165
166
167 /**
168  * Define a function with only the non-default version specified.
169  *
170  * On systems with ELF shared libraries, all symbols exported from
171  * Libav libraries are tagged with the name and major version of the
172  * library to which they belong.  If a function is moved from one
173  * library to another, a wrapper must be retained in the original
174  * location to preserve binary compatibility.
175  *
176  * Functions defined with this macro will never be used to resolve
177  * symbols by the build-time linker.
178  *
179  * @param type return type of function
180  * @param name name of function
181  * @param args argument list of function
182  * @param ver  version tag to assign function
183  */
184 #if HAVE_SYMVER_ASM_LABEL
185 #   define FF_SYMVER(type, name, args, ver)                     \
186     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
187     type ff_##name args
188 #elif HAVE_SYMVER_GNU_ASM
189 #   define FF_SYMVER(type, name, args, ver)                             \
190     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
191     type ff_##name args;                                                \
192     type ff_##name args
193 #endif
194
195 /**
196  * Return NULL if a threading library has not been enabled.
197  * Used to disable threading functions in AVCodec definitions
198  * when not needed.
199  */
200 #if HAVE_THREADS
201 #   define ONLY_IF_THREADS_ENABLED(x) x
202 #else
203 #   define ONLY_IF_THREADS_ENABLED(x) NULL
204 #endif
205
206 #if HAVE_MMX && HAVE_INLINE_ASM
207 /**
208  * Empty mmx state.
209  * this must be called between any dsp function and float/double code.
210  * for example sin(); dsp->idct_put(); emms_c(); cos()
211  */
212 static av_always_inline void emms_c(void)
213 {
214     __asm__ volatile ("emms" ::: "memory");
215 }
216 #elif HAVE_MMX && HAVE_MM_EMPTY
217 #   include <mmintrin.h>
218 #   define emms_c _mm_empty
219 #else /* HAVE_MMX */
220 #   define emms_c()
221 #endif /* HAVE_MMX */
222
223 #endif /* AVUTIL_INTERNAL_H */