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