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