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