Rename CHECKED_ALLOC(Z) to FF_ALLOC(Z)_OR_GOTO and add context and label
[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
RD
94#if ( defined(__PIC__) || defined(__pic__) ) && ! defined(PIC)
95# define PIC
96#endif
97
05020c89 98#ifndef offsetof
ee155011 99# define offsetof(T, F) ((unsigned int)((char *)&((T *)0)->F))
05020c89
RD
100#endif
101
7d9beec7
RP
102/* Use to export labels from asm. */
103#define LABEL_MANGLE(a) EXTERN_PREFIX #a
104
05020c89 105// Use rip-relative addressing if compiling PIC code on x86-64.
b250f9c6 106#if ARCH_X86_64 && defined(PIC)
df22c35d 107# define LOCAL_MANGLE(a) #a "(%%rip)"
edfd6975 108#else
df22c35d 109# define LOCAL_MANGLE(a) #a
635eb0cc 110#endif
05020c89 111
df22c35d
AS
112#define MANGLE(a) EXTERN_PREFIX LOCAL_MANGLE(a)
113
05020c89
RD
114/* debug stuff */
115
05020c89 116/* dprintf macros */
635eb0cc 117#ifdef DEBUG
318c5e05 118# define dprintf(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
635eb0cc 119#else
318c5e05 120# define dprintf(pctx, ...)
635eb0cc 121#endif
05020c89 122
635eb0cc 123#define av_abort() do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
05020c89 124
7e5f82dc
MR
125/* math */
126
36cd3069 127extern const uint32_t ff_inverse[256];
05020c89 128
b250f9c6 129#if ARCH_X86
05020c89
RD
130# define FASTDIV(a,b) \
131 ({\
ee155011 132 int ret, dmy;\
be449fca 133 __asm__ volatile(\
05020c89 134 "mull %3"\
ee155011
DB
135 :"=d"(ret), "=a"(dmy)\
136 :"1"(a), "g"(ff_inverse[b])\
05020c89
RD
137 );\
138 ret;\
139 })
35690321 140#elif HAVE_ARMV6 && HAVE_INLINE_ASM
6651ce17
MR
141static inline av_const int FASTDIV(int a, int b)
142{
b98f10c0
MR
143 int r, t;
144 __asm__ volatile("cmp %3, #2 \n\t"
145 "ldr %1, [%4, %3, lsl #2] \n\t"
146 "lsrle %0, %2, #1 \n\t"
147 "smmulgt %0, %1, %2 \n\t"
148 : "=&r"(r), "=&r"(t) : "r"(a), "r"(b), "r"(ff_inverse));
6651ce17
MR
149 return r;
150}
35690321 151#elif ARCH_ARM && HAVE_INLINE_ASM
f8c5adaf
MR
152static inline av_const int FASTDIV(int a, int b)
153{
154 int r, t;
ee155011
DB
155 __asm__ volatile("umull %1, %0, %2, %3"
156 : "=&r"(r), "=&r"(t) : "r"(a), "r"(ff_inverse[b]));
f8c5adaf
MR
157 return r;
158}
b250f9c6 159#elif CONFIG_FASTDIV
ee155011 160# define FASTDIV(a,b) ((uint32_t)((((uint64_t)a) * ff_inverse[b]) >> 32))
05020c89 161#else
ee155011 162# define FASTDIV(a,b) ((a) / (b))
05020c89
RD
163#endif
164
c448a096 165extern const uint8_t ff_sqrt_tab[256];
05020c89 166
85074d3c 167static inline av_const unsigned int ff_sqrt(unsigned int a)
05020c89 168{
c448a096
MN
169 unsigned int b;
170
ee155011
DB
171 if (a < 255) return (ff_sqrt_tab[a + 1] - 1) >> 4;
172 else if (a < (1 << 12)) b = ff_sqrt_tab[a >> 4] >> 2;
b250f9c6 173#if !CONFIG_SMALL
ee155011
DB
174 else if (a < (1 << 14)) b = ff_sqrt_tab[a >> 6] >> 1;
175 else if (a < (1 << 16)) b = ff_sqrt_tab[a >> 8] ;
c448a096 176#endif
ee155011
DB
177 else {
178 int s = av_log2_16bit(a >> 16) >> 1;
179 unsigned int c = a >> (s + 2);
180 b = ff_sqrt_tab[c >> (s + 8)];
181 b = FASTDIV(c,b) + (b << s);
05020c89 182 }
c448a096 183
ee155011 184 return b - (a < b * b);
05020c89
RD
185}
186
b250f9c6 187#if ARCH_X86
05020c89 188#define MASK_ABS(mask, level)\
be449fca 189 __asm__ volatile(\
7e14b808 190 "cltd \n\t"\
05020c89
RD
191 "xorl %1, %0 \n\t"\
192 "subl %1, %0 \n\t"\
193 : "+a" (level), "=&d" (mask)\
194 );
195#else
196#define MASK_ABS(mask, level)\
ee155011
DB
197 mask = level >> 31;\
198 level = (level ^ mask) - mask;
05020c89
RD
199#endif
200
b250f9c6 201#if HAVE_CMOV
ee155011
DB
202#define COPY3_IF_LT(x, y, a, b, c, d)\
203__asm__ volatile(\
204 "cmpl %0, %3 \n\t"\
05020c89
RD
205 "cmovl %3, %0 \n\t"\
206 "cmovl %4, %1 \n\t"\
207 "cmovl %5, %2 \n\t"\
8c2e2040 208 : "+&r" (x), "+&r" (a), "+r" (c)\
05020c89
RD
209 : "r" (y), "r" (b), "r" (d)\
210);
211#else
ee155011
DB
212#define COPY3_IF_LT(x, y, a, b, c, d)\
213if ((y) < (x)) {\
214 (x) = (y);\
215 (a) = (b);\
216 (c) = (d);\
05020c89
RD
217}
218#endif
219
7d685b48 220/* avoid usage of dangerous/inappropriate system functions */
84662c01 221#undef malloc
05020c89 222#define malloc please_use_av_malloc
84662c01 223#undef free
05020c89 224#define free please_use_av_free
84662c01 225#undef realloc
05020c89 226#define realloc please_use_av_realloc
84662c01 227#undef time
05020c89 228#define time time_is_forbidden_due_to_security_issues
84662c01 229#undef rand
9f5da4d1 230#define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
84662c01 231#undef srand
9f5da4d1 232#define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
84662c01 233#undef random
9f5da4d1 234#define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
84662c01 235#undef sprintf
05020c89 236#define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
84662c01 237#undef strcat
272605c7 238#define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
84662c01 239#undef exit
c367d067 240#define exit exit_is_forbidden
6123abad 241#ifndef LIBAVFORMAT_BUILD
84662c01 242#undef printf
b58f29a1 243#define printf please_use_av_log_instead_of_printf
84662c01 244#undef fprintf
b58f29a1 245#define fprintf please_use_av_log_instead_of_fprintf
59ec6991 246#undef puts
b58f29a1 247#define puts please_use_av_log_instead_of_puts
c5a2fe8f
LA
248#undef perror
249#define perror please_use_av_log_instead_of_perror
05020c89
RD
250#endif
251
e48a0966
RP
252#define CHECKED_ALLOC(p, size)\
253{\
ee155011
DB
254 p = av_malloc(size);\
255 if (p == NULL && (size) != 0) {\
5ce6934e 256 av_log(NULL, AV_LOG_ERROR, "Cannot allocate memory.\n");\
e48a0966
RP
257 goto fail;\
258 }\
259}
260
05020c89
RD
261#define CHECKED_ALLOCZ(p, size)\
262{\
ee155011
DB
263 p = av_mallocz(size);\
264 if (p == NULL && (size) != 0) {\
5ce6934e 265 av_log(NULL, AV_LOG_ERROR, "Cannot allocate memory.\n");\
05020c89
RD
266 goto fail;\
267 }\
268}
269
b250f9c6 270#if !HAVE_LLRINT
85074d3c 271static av_always_inline av_const long long llrint(double x)
a33cab3a
MK
272{
273 return rint(x);
274}
275#endif /* HAVE_LLRINT */
291fd18a
AC
276
277#if !HAVE_LOG2
278static av_always_inline av_const double log2(double x)
279{
280 return log(x) * 1.44269504088896340736;
281}
282#endif /* HAVE_LOG2 */
a33cab3a 283
b250f9c6 284#if !HAVE_LRINT
85074d3c 285static av_always_inline av_const long int lrint(double x)
a33cab3a
MK
286{
287 return rint(x);
288}
289#endif /* HAVE_LRINT */
290
b250f9c6 291#if !HAVE_LRINTF
85074d3c 292static av_always_inline av_const long int lrintf(float x)
05020c89 293{
05020c89 294 return (int)(rint(x));
05020c89
RD
295}
296#endif /* HAVE_LRINTF */
297
b250f9c6 298#if !HAVE_ROUND
85074d3c 299static av_always_inline av_const double round(double x)
a33cab3a
MK
300{
301 return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
302}
303#endif /* HAVE_ROUND */
304
b250f9c6 305#if !HAVE_ROUNDF
85074d3c 306static av_always_inline av_const float roundf(float x)
a33cab3a
MK
307{
308 return (x > 0) ? floor(x + 0.5) : ceil(x - 0.5);
309}
310#endif /* HAVE_ROUNDF */
311
b250f9c6 312#if !HAVE_TRUNCF
7b04b8a0
MK
313static av_always_inline av_const float truncf(float x)
314{
315 return (x > 0) ? floor(x) : ceil(x);
316}
317#endif /* HAVE_TRUNCF */
318
d80a7fe5 319/**
bfe3676f
DB
320 * Returns NULL if CONFIG_SMALL is true, otherwise the argument
321 * without modification. Used to disable the definition of strings
d80a7fe5
AJ
322 * (for example AVCodec long_names).
323 */
324#if CONFIG_SMALL
325# define NULL_IF_CONFIG_SMALL(x) NULL
326#else
327# define NULL_IF_CONFIG_SMALL(x) x
328#endif
329
98790382 330#endif /* AVUTIL_INTERNAL_H */