Move COPY3_IF_LT to lavc/mathops.h
[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 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 /* avoid usage of dangerous/inappropriate system functions */
160 #undef  malloc
161 #define malloc please_use_av_malloc
162 #undef  free
163 #define free please_use_av_free
164 #undef  realloc
165 #define realloc please_use_av_realloc
166 #undef  time
167 #define time time_is_forbidden_due_to_security_issues
168 #undef  rand
169 #define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
170 #undef  srand
171 #define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
172 #undef  random
173 #define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
174 #undef  sprintf
175 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
176 #undef  strcat
177 #define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
178 #undef  exit
179 #define exit exit_is_forbidden
180 #ifndef LIBAVFORMAT_BUILD
181 #undef  printf
182 #define printf please_use_av_log_instead_of_printf
183 #undef  fprintf
184 #define fprintf please_use_av_log_instead_of_fprintf
185 #undef  puts
186 #define puts please_use_av_log_instead_of_puts
187 #undef  perror
188 #define perror please_use_av_log_instead_of_perror
189 #endif
190
191 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
192 {\
193     p = av_malloc(size);\
194     if (p == NULL && (size) != 0) {\
195         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
196         goto label;\
197     }\
198 }
199
200 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
201 {\
202     p = av_mallocz(size);\
203     if (p == NULL && (size) != 0) {\
204         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
205         goto label;\
206     }\
207 }
208
209 #if !HAVE_EXP2
210 #undef exp2
211 #define exp2(x) exp((x) * 0.693147180559945)
212 #endif /* HAVE_EXP2 */
213
214 #if !HAVE_EXP2F
215 #undef exp2f
216 #define exp2f(x) exp2(x)
217 #endif /* HAVE_EXP2F */
218
219 #if !HAVE_LLRINT
220 static av_always_inline av_const long long llrint(double x)
221 {
222     return rint(x);
223 }
224 #endif /* HAVE_LLRINT */
225
226 #if !HAVE_LOG2
227 #undef log2
228 #define log2(x) (log(x) * 1.44269504088896340736)
229 #endif /* HAVE_LOG2 */
230
231 #if !HAVE_LOG2F
232 #undef log2f
233 #define log2f(x) log2(x)
234 #endif /* HAVE_LOG2F */
235
236 #if !HAVE_LRINT
237 static av_always_inline av_const long int lrint(double x)
238 {
239     return rint(x);
240 }
241 #endif /* HAVE_LRINT */
242
243 #if !HAVE_LRINTF
244 static av_always_inline av_const long int lrintf(float x)
245 {
246     return (int)(rint(x));
247 }
248 #endif /* HAVE_LRINTF */
249
250 #if !HAVE_ROUND
251 static av_always_inline av_const double round(double x)
252 {
253     return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
254 }
255 #endif /* HAVE_ROUND */
256
257 #if !HAVE_ROUNDF
258 static av_always_inline av_const float roundf(float x)
259 {
260     return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
261 }
262 #endif /* HAVE_ROUNDF */
263
264 #if !HAVE_TRUNCF
265 static av_always_inline av_const float truncf(float x)
266 {
267     return (x > 0) ? floor(x) : ceil(x);
268 }
269 #endif /* HAVE_TRUNCF */
270
271 /**
272  * Returns NULL if CONFIG_SMALL is true, otherwise the argument
273  * without modification. Used to disable the definition of strings
274  * (for example AVCodec long_names).
275  */
276 #if CONFIG_SMALL
277 #   define NULL_IF_CONFIG_SMALL(x) NULL
278 #else
279 #   define NULL_IF_CONFIG_SMALL(x) x
280 #endif
281
282 #endif /* AVUTIL_INTERNAL_H */