Move ff_sqrt() to libavutil/intmath.h
[libav.git] / libavutil / internal.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3 *
b78e7197
DB
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
b78e7197 11 * FFmpeg is distributed in the hope that it will be useful,
04d7f601
DB
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
b78e7197 17 * License along with FFmpeg; if not, write to the Free Software
04d7f601
DB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
05020c89 21/**
bad5537e 22 * @file libavutil/internal.h
89c9ff50 23 * common internal API header
05020c89
RD
24 */
25
98790382
SS
26#ifndef AVUTIL_INTERNAL_H
27#define AVUTIL_INTERNAL_H
05020c89 28
318049b8
MR
29#if !defined(DEBUG) && !defined(NDEBUG)
30# define NDEBUG
31#endif
32
ed0fd852 33#include <limits.h>
99545457 34#include <stdint.h>
318049b8
MR
35#include <stddef.h>
36#include <assert.h>
dbef3f46 37#include "config.h"
52476c1b 38#include "common.h"
9d52d54d 39#include "mem.h"
2f5421d5 40#include "timer.h"
99545457 41
5e4c7ca2 42#ifndef attribute_align_arg
06be9d9d 43#if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,2)
5e4c7ca2
RP
44# define attribute_align_arg __attribute__((force_align_arg_pointer))
45#else
46# define attribute_align_arg
47#endif
48#endif
49
5403f857 50#ifndef attribute_used
52476c1b 51#if AV_GCC_VERSION_AT_LEAST(3,1)
5403f857
MR
52# define attribute_used __attribute__((used))
53#else
54# define attribute_used
55#endif
56#endif
57
788627de 58#ifndef av_alias
8e339d4a 59#if HAVE_ATTRIBUTE_MAY_ALIAS && (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(3,3)
788627de
MR
60# define av_alias __attribute__((may_alias))
61#else
62# define av_alias
63#endif
64#endif
65
cd107896 66#ifndef INT16_MIN
ee155011 67#define INT16_MIN (-0x7fff - 1)
cd107896
MR
68#endif
69
70#ifndef INT16_MAX
71#define INT16_MAX 0x7fff
72#endif
73
74#ifndef INT32_MIN
ee155011 75#define INT32_MIN (-0x7fffffff - 1)
cd107896
MR
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
ee155011 87#define INT64_MIN (-0x7fffffffffffffffLL - 1)
cd107896
MR
88#endif
89
90#ifndef INT64_MAX
8da9266c 91#define INT64_MAX INT64_C(9223372036854775807)
cd107896
MR
92#endif
93
94#ifndef UINT64_MAX
8da9266c 95#define UINT64_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
cd107896
MR
96#endif
97
98#ifndef INT_BIT
28499cc8 99# define INT_BIT (CHAR_BIT * sizeof(int))
cd107896
MR
100#endif
101
05020c89 102#ifndef offsetof
ee155011 103# define offsetof(T, F) ((unsigned int)((char *)&((T *)0)->F))
05020c89
RD
104#endif
105
7d9beec7
RP
106/* Use to export labels from asm. */
107#define LABEL_MANGLE(a) EXTERN_PREFIX #a
108
05020c89 109// Use rip-relative addressing if compiling PIC code on x86-64.
b250f9c6 110#if ARCH_X86_64 && defined(PIC)
df22c35d 111# define LOCAL_MANGLE(a) #a "(%%rip)"
edfd6975 112#else
df22c35d 113# define LOCAL_MANGLE(a) #a
635eb0cc 114#endif
05020c89 115
df22c35d
AS
116#define MANGLE(a) EXTERN_PREFIX LOCAL_MANGLE(a)
117
05020c89
RD
118/* debug stuff */
119
05020c89 120/* dprintf macros */
635eb0cc 121#ifdef DEBUG
318c5e05 122# define dprintf(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
635eb0cc 123#else
318c5e05 124# define dprintf(pctx, ...)
635eb0cc 125#endif
05020c89 126
635eb0cc 127#define av_abort() do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
05020c89 128
7e5f82dc
MR
129/* math */
130
b250f9c6 131#if ARCH_X86
05020c89 132#define MASK_ABS(mask, level)\
be449fca 133 __asm__ volatile(\
7e14b808 134 "cltd \n\t"\
05020c89
RD
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)\
ee155011
DB
141 mask = level >> 31;\
142 level = (level ^ mask) - mask;
05020c89
RD
143#endif
144
7d685b48 145/* avoid usage of dangerous/inappropriate system functions */
84662c01 146#undef malloc
05020c89 147#define malloc please_use_av_malloc
84662c01 148#undef free
05020c89 149#define free please_use_av_free
84662c01 150#undef realloc
05020c89 151#define realloc please_use_av_realloc
84662c01 152#undef time
05020c89 153#define time time_is_forbidden_due_to_security_issues
84662c01 154#undef rand
9f5da4d1 155#define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
84662c01 156#undef srand
9f5da4d1 157#define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
84662c01 158#undef random
9f5da4d1 159#define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
84662c01 160#undef sprintf
05020c89 161#define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
84662c01 162#undef strcat
272605c7 163#define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
84662c01 164#undef exit
c367d067 165#define exit exit_is_forbidden
6123abad 166#ifndef LIBAVFORMAT_BUILD
84662c01 167#undef printf
b58f29a1 168#define printf please_use_av_log_instead_of_printf
84662c01 169#undef fprintf
b58f29a1 170#define fprintf please_use_av_log_instead_of_fprintf
59ec6991 171#undef puts
b58f29a1 172#define puts please_use_av_log_instead_of_puts
c5a2fe8f
LA
173#undef perror
174#define perror please_use_av_log_instead_of_perror
05020c89
RD
175#endif
176
d31dbec3 177#define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
e48a0966 178{\
ee155011
DB
179 p = av_malloc(size);\
180 if (p == NULL && (size) != 0) {\
d31dbec3
RP
181 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
182 goto label;\
e48a0966
RP
183 }\
184}
185
d31dbec3 186#define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
05020c89 187{\
ee155011
DB
188 p = av_mallocz(size);\
189 if (p == NULL && (size) != 0) {\
d31dbec3
RP
190 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
191 goto label;\
05020c89
RD
192 }\
193}
194
6b7c7703 195#if !HAVE_EXP2
06cb7a1c
VS
196#undef exp2
197#define exp2(x) exp((x) * 0.693147180559945)
6b7c7703
VS
198#endif /* HAVE_EXP2 */
199
200#if !HAVE_EXP2F
06cb7a1c 201#undef exp2f
7ed63ca2 202#define exp2f(x) ((float)exp2(x))
6b7c7703
VS
203#endif /* HAVE_EXP2F */
204
b250f9c6 205#if !HAVE_LLRINT
8e05f069 206#undef llrint
7ed63ca2 207#define llrint(x) ((long long)rint(x))
a33cab3a 208#endif /* HAVE_LLRINT */
291fd18a
AC
209
210#if !HAVE_LOG2
06cb7a1c
VS
211#undef log2
212#define log2(x) (log(x) * 1.44269504088896340736)
291fd18a 213#endif /* HAVE_LOG2 */
6b7c7703
VS
214
215#if !HAVE_LOG2F
06cb7a1c 216#undef log2f
7ed63ca2 217#define log2f(x) ((float)log2(x))
6b7c7703 218#endif /* HAVE_LOG2F */
a33cab3a 219
b250f9c6 220#if !HAVE_LRINT
85074d3c 221static av_always_inline av_const long int lrint(double x)
a33cab3a
MK
222{
223 return rint(x);
224}
225#endif /* HAVE_LRINT */
226
b250f9c6 227#if !HAVE_LRINTF
85074d3c 228static av_always_inline av_const long int lrintf(float x)
05020c89 229{
05020c89 230 return (int)(rint(x));
05020c89
RD
231}
232#endif /* HAVE_LRINTF */
233
b250f9c6 234#if !HAVE_ROUND
85074d3c 235static av_always_inline av_const double round(double x)
a33cab3a
MK
236{
237 return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
238}
239#endif /* HAVE_ROUND */
240
b250f9c6 241#if !HAVE_ROUNDF
85074d3c 242static av_always_inline av_const float roundf(float x)
a33cab3a
MK
243{
244 return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
245}
246#endif /* HAVE_ROUNDF */
247
b250f9c6 248#if !HAVE_TRUNCF
7b04b8a0
MK
249static av_always_inline av_const float truncf(float x)
250{
251 return (x > 0) ? floor(x) : ceil(x);
252}
253#endif /* HAVE_TRUNCF */
254
d80a7fe5 255/**
bfe3676f
DB
256 * Returns NULL if CONFIG_SMALL is true, otherwise the argument
257 * without modification. Used to disable the definition of strings
d80a7fe5
AJ
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
98790382 266#endif /* AVUTIL_INTERNAL_H */