Move FASTDIV macro to intmath.h
[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 > 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 uint8_t ff_sqrt_tab[256];
124
125 static inline av_const unsigned int ff_sqrt(unsigned int a)
126 {
127 unsigned int b;
128
129 if (a < 255) return (ff_sqrt_tab[a + 1] - 1) >> 4;
130 else if (a < (1 << 12)) b = ff_sqrt_tab[a >> 4] >> 2;
131 #if !CONFIG_SMALL
132 else if (a < (1 << 14)) b = ff_sqrt_tab[a >> 6] >> 1;
133 else if (a < (1 << 16)) b = ff_sqrt_tab[a >> 8] ;
134 #endif
135 else {
136 int s = av_log2_16bit(a >> 16) >> 1;
137 unsigned int c = a >> (s + 2);
138 b = ff_sqrt_tab[c >> (s + 8)];
139 b = FASTDIV(c,b) + (b << s);
140 }
141
142 return b - (a < b * b);
143 }
144
145 #if ARCH_X86
146 #define MASK_ABS(mask, level)\
147 __asm__ volatile(\
148 "cltd \n\t"\
149 "xorl %1, %0 \n\t"\
150 "subl %1, %0 \n\t"\
151 : "+a" (level), "=&d" (mask)\
152 );
153 #else
154 #define MASK_ABS(mask, level)\
155 mask = level >> 31;\
156 level = (level ^ mask) - mask;
157 #endif
158
159 #if HAVE_CMOV
160 #define COPY3_IF_LT(x, y, a, b, c, d)\
161 __asm__ volatile(\
162 "cmpl %0, %3 \n\t"\
163 "cmovl %3, %0 \n\t"\
164 "cmovl %4, %1 \n\t"\
165 "cmovl %5, %2 \n\t"\
166 : "+&r" (x), "+&r" (a), "+r" (c)\
167 : "r" (y), "r" (b), "r" (d)\
168 );
169 #else
170 #define COPY3_IF_LT(x, y, a, b, c, d)\
171 if ((y) < (x)) {\
172 (x) = (y);\
173 (a) = (b);\
174 (c) = (d);\
175 }
176 #endif
177
178 /* avoid usage of dangerous/inappropriate system functions */
179 #undef malloc
180 #define malloc please_use_av_malloc
181 #undef free
182 #define free please_use_av_free
183 #undef realloc
184 #define realloc please_use_av_realloc
185 #undef time
186 #define time time_is_forbidden_due_to_security_issues
187 #undef rand
188 #define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
189 #undef srand
190 #define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
191 #undef random
192 #define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
193 #undef sprintf
194 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
195 #undef strcat
196 #define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
197 #undef exit
198 #define exit exit_is_forbidden
199 #ifndef LIBAVFORMAT_BUILD
200 #undef printf
201 #define printf please_use_av_log_instead_of_printf
202 #undef fprintf
203 #define fprintf please_use_av_log_instead_of_fprintf
204 #undef puts
205 #define puts please_use_av_log_instead_of_puts
206 #undef perror
207 #define perror please_use_av_log_instead_of_perror
208 #endif
209
210 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
211 {\
212 p = av_malloc(size);\
213 if (p == NULL && (size) != 0) {\
214 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
215 goto label;\
216 }\
217 }
218
219 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
220 {\
221 p = av_mallocz(size);\
222 if (p == NULL && (size) != 0) {\
223 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
224 goto label;\
225 }\
226 }
227
228 #if !HAVE_EXP2
229 #undef exp2
230 #define exp2(x) exp((x) * 0.693147180559945)
231 #endif /* HAVE_EXP2 */
232
233 #if !HAVE_EXP2F
234 #undef exp2f
235 #define exp2f(x) exp2(x)
236 #endif /* HAVE_EXP2F */
237
238 #if !HAVE_LLRINT
239 static av_always_inline av_const long long llrint(double x)
240 {
241 return rint(x);
242 }
243 #endif /* HAVE_LLRINT */
244
245 #if !HAVE_LOG2
246 #undef log2
247 #define log2(x) (log(x) * 1.44269504088896340736)
248 #endif /* HAVE_LOG2 */
249
250 #if !HAVE_LOG2F
251 #undef log2f
252 #define log2f(x) log2(x)
253 #endif /* HAVE_LOG2F */
254
255 #if !HAVE_LRINT
256 static av_always_inline av_const long int lrint(double x)
257 {
258 return rint(x);
259 }
260 #endif /* HAVE_LRINT */
261
262 #if !HAVE_LRINTF
263 static av_always_inline av_const long int lrintf(float x)
264 {
265 return (int)(rint(x));
266 }
267 #endif /* HAVE_LRINTF */
268
269 #if !HAVE_ROUND
270 static av_always_inline av_const double round(double x)
271 {
272 return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
273 }
274 #endif /* HAVE_ROUND */
275
276 #if !HAVE_ROUNDF
277 static av_always_inline av_const float roundf(float x)
278 {
279 return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
280 }
281 #endif /* HAVE_ROUNDF */
282
283 #if !HAVE_TRUNCF
284 static av_always_inline av_const float truncf(float x)
285 {
286 return (x > 0) ? floor(x) : ceil(x);
287 }
288 #endif /* HAVE_TRUNCF */
289
290 /**
291 * Returns NULL if CONFIG_SMALL is true, otherwise the argument
292 * without modification. Used to disable the definition of strings
293 * (for example AVCodec long_names).
294 */
295 #if CONFIG_SMALL
296 # define NULL_IF_CONFIG_SMALL(x) NULL
297 #else
298 # define NULL_IF_CONFIG_SMALL(x) x
299 #endif
300
301 #endif /* AVUTIL_INTERNAL_H */