Check for may_alias gcc attribute support
[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
cd107896 58#ifndef INT16_MIN
ee155011 59#define INT16_MIN (-0x7fff - 1)
cd107896
MR
60#endif
61
62#ifndef INT16_MAX
63#define INT16_MAX 0x7fff
64#endif
65
66#ifndef INT32_MIN
ee155011 67#define INT32_MIN (-0x7fffffff - 1)
cd107896
MR
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
ee155011 79#define INT64_MIN (-0x7fffffffffffffffLL - 1)
cd107896
MR
80#endif
81
82#ifndef INT64_MAX
8da9266c 83#define INT64_MAX INT64_C(9223372036854775807)
cd107896
MR
84#endif
85
86#ifndef UINT64_MAX
8da9266c 87#define UINT64_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
cd107896
MR
88#endif
89
90#ifndef INT_BIT
28499cc8 91# define INT_BIT (CHAR_BIT * sizeof(int))
cd107896
MR
92#endif
93
05020c89 94#ifndef offsetof
ee155011 95# define offsetof(T, F) ((unsigned int)((char *)&((T *)0)->F))
05020c89
RD
96#endif
97
7d9beec7
RP
98/* Use to export labels from asm. */
99#define LABEL_MANGLE(a) EXTERN_PREFIX #a
100
05020c89 101// Use rip-relative addressing if compiling PIC code on x86-64.
b250f9c6 102#if ARCH_X86_64 && defined(PIC)
df22c35d 103# define LOCAL_MANGLE(a) #a "(%%rip)"
edfd6975 104#else
df22c35d 105# define LOCAL_MANGLE(a) #a
635eb0cc 106#endif
05020c89 107
df22c35d
AS
108#define MANGLE(a) EXTERN_PREFIX LOCAL_MANGLE(a)
109
05020c89
RD
110/* debug stuff */
111
05020c89 112/* dprintf macros */
635eb0cc 113#ifdef DEBUG
318c5e05 114# define dprintf(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
635eb0cc 115#else
318c5e05 116# define dprintf(pctx, ...)
635eb0cc 117#endif
05020c89 118
635eb0cc 119#define av_abort() do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
05020c89 120
7e5f82dc
MR
121/* math */
122
c448a096 123extern const uint8_t ff_sqrt_tab[256];
05020c89 124
85074d3c 125static inline av_const unsigned int ff_sqrt(unsigned int a)
05020c89 126{
c448a096
MN
127 unsigned int b;
128
ee155011
DB
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;
b250f9c6 131#if !CONFIG_SMALL
ee155011
DB
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] ;
c448a096 134#endif
ee155011
DB
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);
05020c89 140 }
c448a096 141
ee155011 142 return b - (a < b * b);
05020c89
RD
143}
144
b250f9c6 145#if ARCH_X86
05020c89 146#define MASK_ABS(mask, level)\
be449fca 147 __asm__ volatile(\
7e14b808 148 "cltd \n\t"\
05020c89
RD
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)\
ee155011
DB
155 mask = level >> 31;\
156 level = (level ^ mask) - mask;
05020c89
RD
157#endif
158
7d685b48 159/* avoid usage of dangerous/inappropriate system functions */
84662c01 160#undef malloc
05020c89 161#define malloc please_use_av_malloc
84662c01 162#undef free
05020c89 163#define free please_use_av_free
84662c01 164#undef realloc
05020c89 165#define realloc please_use_av_realloc
84662c01 166#undef time
05020c89 167#define time time_is_forbidden_due_to_security_issues
84662c01 168#undef rand
9f5da4d1 169#define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
84662c01 170#undef srand
9f5da4d1 171#define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
84662c01 172#undef random
9f5da4d1 173#define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
84662c01 174#undef sprintf
05020c89 175#define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
84662c01 176#undef strcat
272605c7 177#define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
84662c01 178#undef exit
c367d067 179#define exit exit_is_forbidden
6123abad 180#ifndef LIBAVFORMAT_BUILD
84662c01 181#undef printf
b58f29a1 182#define printf please_use_av_log_instead_of_printf
84662c01 183#undef fprintf
b58f29a1 184#define fprintf please_use_av_log_instead_of_fprintf
59ec6991 185#undef puts
b58f29a1 186#define puts please_use_av_log_instead_of_puts
c5a2fe8f
LA
187#undef perror
188#define perror please_use_av_log_instead_of_perror
05020c89
RD
189#endif
190
d31dbec3 191#define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
e48a0966 192{\
ee155011
DB
193 p = av_malloc(size);\
194 if (p == NULL && (size) != 0) {\
d31dbec3
RP
195 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
196 goto label;\
e48a0966
RP
197 }\
198}
199
d31dbec3 200#define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
05020c89 201{\
ee155011
DB
202 p = av_mallocz(size);\
203 if (p == NULL && (size) != 0) {\
d31dbec3
RP
204 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
205 goto label;\
05020c89
RD
206 }\
207}
208
6b7c7703 209#if !HAVE_EXP2
06cb7a1c
VS
210#undef exp2
211#define exp2(x) exp((x) * 0.693147180559945)
6b7c7703
VS
212#endif /* HAVE_EXP2 */
213
214#if !HAVE_EXP2F
06cb7a1c
VS
215#undef exp2f
216#define exp2f(x) exp2(x)
6b7c7703
VS
217#endif /* HAVE_EXP2F */
218
b250f9c6 219#if !HAVE_LLRINT
85074d3c 220static av_always_inline av_const long long llrint(double x)
a33cab3a
MK
221{
222 return rint(x);
223}
224#endif /* HAVE_LLRINT */
291fd18a
AC
225
226#if !HAVE_LOG2
06cb7a1c
VS
227#undef log2
228#define log2(x) (log(x) * 1.44269504088896340736)
291fd18a 229#endif /* HAVE_LOG2 */
6b7c7703
VS
230
231#if !HAVE_LOG2F
06cb7a1c
VS
232#undef log2f
233#define log2f(x) log2(x)
6b7c7703 234#endif /* HAVE_LOG2F */
a33cab3a 235
b250f9c6 236#if !HAVE_LRINT
85074d3c 237static av_always_inline av_const long int lrint(double x)
a33cab3a
MK
238{
239 return rint(x);
240}
241#endif /* HAVE_LRINT */
242
b250f9c6 243#if !HAVE_LRINTF
85074d3c 244static av_always_inline av_const long int lrintf(float x)
05020c89 245{
05020c89 246 return (int)(rint(x));
05020c89
RD
247}
248#endif /* HAVE_LRINTF */
249
b250f9c6 250#if !HAVE_ROUND
85074d3c 251static av_always_inline av_const double round(double x)
a33cab3a
MK
252{
253 return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
254}
255#endif /* HAVE_ROUND */
256
b250f9c6 257#if !HAVE_ROUNDF
85074d3c 258static av_always_inline av_const float roundf(float x)
a33cab3a
MK
259{
260 return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
261}
262#endif /* HAVE_ROUNDF */
263
b250f9c6 264#if !HAVE_TRUNCF
7b04b8a0
MK
265static av_always_inline av_const float truncf(float x)
266{
267 return (x > 0) ? floor(x) : ceil(x);
268}
269#endif /* HAVE_TRUNCF */
270
d80a7fe5 271/**
bfe3676f
DB
272 * Returns NULL if CONFIG_SMALL is true, otherwise the argument
273 * without modification. Used to disable the definition of strings
d80a7fe5
AJ
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
98790382 282#endif /* AVUTIL_INTERNAL_H */