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