Remove the inclusion of unneeded headers
[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 libavutil/internal.h
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 "common.h"
39 #include "mem.h"
40 #include "timer.h"
41
42 #ifndef attribute_align_arg
43 #if (!defined(__ICC) || __ICC > 1110) && 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 #ifndef attribute_used
51 #if AV_GCC_VERSION_AT_LEAST(3,1)
52 #    define attribute_used __attribute__((used))
53 #else
54 #    define attribute_used
55 #endif
56 #endif
57
58 #ifndef INT16_MIN
59 #define INT16_MIN       (-0x7fff - 1)
60 #endif
61
62 #ifndef INT16_MAX
63 #define INT16_MAX       0x7fff
64 #endif
65
66 #ifndef INT32_MIN
67 #define INT32_MIN       (-0x7fffffff - 1)
68 #endif
69
70 #ifndef INT32_MAX
71 #define INT32_MAX       0x7fffffff
72 #endif
73
74 #ifndef UINT32_MAX
75 #define UINT32_MAX      0xffffffff
76 #endif
77
78 #ifndef INT64_MIN
79 #define INT64_MIN       (-0x7fffffffffffffffLL - 1)
80 #endif
81
82 #ifndef INT64_MAX
83 #define INT64_MAX INT64_C(9223372036854775807)
84 #endif
85
86 #ifndef UINT64_MAX
87 #define UINT64_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
88 #endif
89
90 #ifndef INT_BIT
91 #    define INT_BIT (CHAR_BIT * sizeof(int))
92 #endif
93
94 #ifndef offsetof
95 #    define offsetof(T, F) ((unsigned int)((char *)&((T *)0)->F))
96 #endif
97
98 /* Use to export labels from asm. */
99 #define LABEL_MANGLE(a) EXTERN_PREFIX #a
100
101 // Use rip-relative addressing if compiling PIC code on x86-64.
102 #if ARCH_X86_64 && defined(PIC)
103 #    define LOCAL_MANGLE(a) #a "(%%rip)"
104 #else
105 #    define LOCAL_MANGLE(a) #a
106 #endif
107
108 #define MANGLE(a) EXTERN_PREFIX LOCAL_MANGLE(a)
109
110 /* debug stuff */
111
112 /* dprintf macros */
113 #ifdef DEBUG
114 #    define dprintf(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
115 #else
116 #    define dprintf(pctx, ...)
117 #endif
118
119 #define av_abort()      do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
120
121 /* math */
122
123 extern const uint32_t ff_inverse[257];
124
125 #if ARCH_X86
126 #    define FASTDIV(a,b) \
127     ({\
128         int ret, dmy;\
129         __asm__ volatile(\
130             "mull %3"\
131             :"=d"(ret), "=a"(dmy)\
132             :"1"(a), "g"(ff_inverse[b])\
133             );\
134         ret;\
135     })
136 #elif HAVE_ARMV6 && HAVE_INLINE_ASM
137 static inline av_const int FASTDIV(int a, int b)
138 {
139     int r, t;
140     __asm__ volatile("cmp     %3, #2               \n\t"
141                      "ldr     %1, [%4, %3, lsl #2] \n\t"
142                      "lsrle   %0, %2, #1           \n\t"
143                      "smmulgt %0, %1, %2           \n\t"
144                      : "=&r"(r), "=&r"(t) : "r"(a), "r"(b), "r"(ff_inverse));
145     return r;
146 }
147 #elif ARCH_ARM && HAVE_INLINE_ASM
148 static inline av_const int FASTDIV(int a, int b)
149 {
150     int r, t;
151     __asm__ volatile("umull %1, %0, %2, %3"
152                      : "=&r"(r), "=&r"(t) : "r"(a), "r"(ff_inverse[b]));
153     return r;
154 }
155 #elif CONFIG_FASTDIV
156 #    define FASTDIV(a,b)   ((uint32_t)((((uint64_t)a) * ff_inverse[b]) >> 32))
157 #else
158 #    define FASTDIV(a,b)   ((a) / (b))
159 #endif
160
161 extern const uint8_t ff_sqrt_tab[256];
162
163 static inline av_const unsigned int ff_sqrt(unsigned int a)
164 {
165     unsigned int b;
166
167     if (a < 255) return (ff_sqrt_tab[a + 1] - 1) >> 4;
168     else if (a < (1 << 12)) b = ff_sqrt_tab[a >> 4] >> 2;
169 #if !CONFIG_SMALL
170     else if (a < (1 << 14)) b = ff_sqrt_tab[a >> 6] >> 1;
171     else if (a < (1 << 16)) b = ff_sqrt_tab[a >> 8]   ;
172 #endif
173     else {
174         int s = av_log2_16bit(a >> 16) >> 1;
175         unsigned int c = a >> (s + 2);
176         b = ff_sqrt_tab[c >> (s + 8)];
177         b = FASTDIV(c,b) + (b << s);
178     }
179
180     return b - (a < b * b);
181 }
182
183 #if ARCH_X86
184 #define MASK_ABS(mask, level)\
185             __asm__ volatile(\
186                 "cltd                   \n\t"\
187                 "xorl %1, %0            \n\t"\
188                 "subl %1, %0            \n\t"\
189                 : "+a" (level), "=&d" (mask)\
190             );
191 #else
192 #define MASK_ABS(mask, level)\
193             mask  = level >> 31;\
194             level = (level ^ mask) - mask;
195 #endif
196
197 #if HAVE_CMOV
198 #define COPY3_IF_LT(x, y, a, b, c, d)\
199 __asm__ volatile(\
200     "cmpl  %0, %3       \n\t"\
201     "cmovl %3, %0       \n\t"\
202     "cmovl %4, %1       \n\t"\
203     "cmovl %5, %2       \n\t"\
204     : "+&r" (x), "+&r" (a), "+r" (c)\
205     : "r" (y), "r" (b), "r" (d)\
206 );
207 #else
208 #define COPY3_IF_LT(x, y, a, b, c, d)\
209 if ((y) < (x)) {\
210     (x) = (y);\
211     (a) = (b);\
212     (c) = (d);\
213 }
214 #endif
215
216 /* avoid usage of dangerous/inappropriate system functions */
217 #undef  malloc
218 #define malloc please_use_av_malloc
219 #undef  free
220 #define free please_use_av_free
221 #undef  realloc
222 #define realloc please_use_av_realloc
223 #undef  time
224 #define time time_is_forbidden_due_to_security_issues
225 #undef  rand
226 #define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
227 #undef  srand
228 #define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
229 #undef  random
230 #define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
231 #undef  sprintf
232 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
233 #undef  strcat
234 #define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
235 #undef  exit
236 #define exit exit_is_forbidden
237 #ifndef LIBAVFORMAT_BUILD
238 #undef  printf
239 #define printf please_use_av_log_instead_of_printf
240 #undef  fprintf
241 #define fprintf please_use_av_log_instead_of_fprintf
242 #undef  puts
243 #define puts please_use_av_log_instead_of_puts
244 #undef  perror
245 #define perror please_use_av_log_instead_of_perror
246 #endif
247
248 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
249 {\
250     p = av_malloc(size);\
251     if (p == NULL && (size) != 0) {\
252         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
253         goto label;\
254     }\
255 }
256
257 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
258 {\
259     p = av_mallocz(size);\
260     if (p == NULL && (size) != 0) {\
261         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
262         goto label;\
263     }\
264 }
265
266 #if !HAVE_EXP2
267 static av_always_inline av_const double exp2(double x)
268 {
269     return exp(x * 0.693147180559945);
270 }
271 #endif /* HAVE_EXP2 */
272
273 #if !HAVE_EXP2F
274 static av_always_inline av_const float exp2f(float x)
275 {
276     return exp2(x);
277 }
278 #endif /* HAVE_EXP2F */
279
280 #if !HAVE_LLRINT
281 static av_always_inline av_const long long llrint(double x)
282 {
283     return rint(x);
284 }
285 #endif /* HAVE_LLRINT */
286
287 #if !HAVE_LOG2
288 static av_always_inline av_const double log2(double x)
289 {
290     return log(x) * 1.44269504088896340736;
291 }
292 #endif /* HAVE_LOG2 */
293
294 #if !HAVE_LOG2F
295 static av_always_inline av_const float log2f(float x)
296 {
297     return log2(x);
298 }
299 #endif /* HAVE_LOG2F */
300
301 #if !HAVE_LRINT
302 static av_always_inline av_const long int lrint(double x)
303 {
304     return rint(x);
305 }
306 #endif /* HAVE_LRINT */
307
308 #if !HAVE_LRINTF
309 static av_always_inline av_const long int lrintf(float x)
310 {
311     return (int)(rint(x));
312 }
313 #endif /* HAVE_LRINTF */
314
315 #if !HAVE_ROUND
316 static av_always_inline av_const double round(double x)
317 {
318     return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
319 }
320 #endif /* HAVE_ROUND */
321
322 #if !HAVE_ROUNDF
323 static av_always_inline av_const float roundf(float x)
324 {
325     return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
326 }
327 #endif /* HAVE_ROUNDF */
328
329 #if !HAVE_TRUNCF
330 static av_always_inline av_const float truncf(float x)
331 {
332     return (x > 0) ? floor(x) : ceil(x);
333 }
334 #endif /* HAVE_TRUNCF */
335
336 /**
337  * Returns NULL if CONFIG_SMALL is true, otherwise the argument
338  * without modification. Used to disable the definition of strings
339  * (for example AVCodec long_names).
340  */
341 #if CONFIG_SMALL
342 #   define NULL_IF_CONFIG_SMALL(x) NULL
343 #else
344 #   define NULL_IF_CONFIG_SMALL(x) x
345 #endif
346
347 #endif /* AVUTIL_INTERNAL_H */