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