Add missing git revision hask.
[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/**
ba87f080 22 * @file
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"
2ed6f399 38#include "attributes.h"
2f5421d5 39#include "timer.h"
99545457 40
5e4c7ca2 41#ifndef attribute_align_arg
086e997e 42#if ARCH_X86_32 && (!defined(__ICC) || __ICC > 1200) && AV_GCC_VERSION_AT_LEAST(4,2)
5e4c7ca2
RP
43# define attribute_align_arg __attribute__((force_align_arg_pointer))
44#else
45# define attribute_align_arg
46#endif
47#endif
48
cd107896 49#ifndef INT16_MIN
ee155011 50#define INT16_MIN (-0x7fff - 1)
cd107896
MR
51#endif
52
53#ifndef INT16_MAX
54#define INT16_MAX 0x7fff
55#endif
56
57#ifndef INT32_MIN
ee155011 58#define INT32_MIN (-0x7fffffff - 1)
cd107896
MR
59#endif
60
61#ifndef INT32_MAX
62#define INT32_MAX 0x7fffffff
63#endif
64
65#ifndef UINT32_MAX
66#define UINT32_MAX 0xffffffff
67#endif
68
69#ifndef INT64_MIN
ee155011 70#define INT64_MIN (-0x7fffffffffffffffLL - 1)
cd107896
MR
71#endif
72
73#ifndef INT64_MAX
8da9266c 74#define INT64_MAX INT64_C(9223372036854775807)
cd107896
MR
75#endif
76
77#ifndef UINT64_MAX
8da9266c 78#define UINT64_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
cd107896
MR
79#endif
80
81#ifndef INT_BIT
28499cc8 82# define INT_BIT (CHAR_BIT * sizeof(int))
cd107896
MR
83#endif
84
05020c89 85#ifndef offsetof
ee155011 86# define offsetof(T, F) ((unsigned int)((char *)&((T *)0)->F))
05020c89
RD
87#endif
88
7d9beec7
RP
89/* Use to export labels from asm. */
90#define LABEL_MANGLE(a) EXTERN_PREFIX #a
91
05020c89 92// Use rip-relative addressing if compiling PIC code on x86-64.
b250f9c6 93#if ARCH_X86_64 && defined(PIC)
df22c35d 94# define LOCAL_MANGLE(a) #a "(%%rip)"
edfd6975 95#else
df22c35d 96# define LOCAL_MANGLE(a) #a
635eb0cc 97#endif
05020c89 98
df22c35d
AS
99#define MANGLE(a) EXTERN_PREFIX LOCAL_MANGLE(a)
100
05020c89
RD
101/* debug stuff */
102
635eb0cc 103#define av_abort() do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
05020c89 104
7e5f82dc
MR
105/* math */
106
b250f9c6 107#if ARCH_X86
05020c89 108#define MASK_ABS(mask, level)\
be449fca 109 __asm__ volatile(\
7e14b808 110 "cltd \n\t"\
05020c89
RD
111 "xorl %1, %0 \n\t"\
112 "subl %1, %0 \n\t"\
113 : "+a" (level), "=&d" (mask)\
114 );
115#else
116#define MASK_ABS(mask, level)\
ee155011
DB
117 mask = level >> 31;\
118 level = (level ^ mask) - mask;
05020c89
RD
119#endif
120
7d685b48 121/* avoid usage of dangerous/inappropriate system functions */
84662c01 122#undef malloc
05020c89 123#define malloc please_use_av_malloc
84662c01 124#undef free
05020c89 125#define free please_use_av_free
84662c01 126#undef realloc
05020c89 127#define realloc please_use_av_realloc
84662c01 128#undef time
05020c89 129#define time time_is_forbidden_due_to_security_issues
84662c01 130#undef rand
9f5da4d1 131#define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
84662c01 132#undef srand
9f5da4d1 133#define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
84662c01 134#undef random
9f5da4d1 135#define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
84662c01 136#undef sprintf
05020c89 137#define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
84662c01 138#undef strcat
272605c7 139#define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
84662c01 140#undef exit
c367d067 141#define exit exit_is_forbidden
6123abad 142#ifndef LIBAVFORMAT_BUILD
84662c01 143#undef printf
b58f29a1 144#define printf please_use_av_log_instead_of_printf
84662c01 145#undef fprintf
b58f29a1 146#define fprintf please_use_av_log_instead_of_fprintf
59ec6991 147#undef puts
b58f29a1 148#define puts please_use_av_log_instead_of_puts
c5a2fe8f
LA
149#undef perror
150#define perror please_use_av_log_instead_of_perror
05020c89
RD
151#endif
152
d31dbec3 153#define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
e48a0966 154{\
ee155011
DB
155 p = av_malloc(size);\
156 if (p == NULL && (size) != 0) {\
d31dbec3
RP
157 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
158 goto label;\
e48a0966
RP
159 }\
160}
161
d31dbec3 162#define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
05020c89 163{\
ee155011
DB
164 p = av_mallocz(size);\
165 if (p == NULL && (size) != 0) {\
d31dbec3
RP
166 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
167 goto label;\
05020c89
RD
168 }\
169}
170
335ee1aa 171#include "libm.h"
7b04b8a0 172
d80a7fe5 173/**
49bd8e4b 174 * Return NULL if CONFIG_SMALL is true, otherwise the argument
bfe3676f 175 * without modification. Used to disable the definition of strings
d80a7fe5
AJ
176 * (for example AVCodec long_names).
177 */
178#if CONFIG_SMALL
179# define NULL_IF_CONFIG_SMALL(x) NULL
180#else
181# define NULL_IF_CONFIG_SMALL(x) x
182#endif
183
33586ee7
MN
184
185/**
cae70f99
MR
186 * Define a function with only the non-default version specified.
187 *
188 * On systems with ELF shared libraries, all symbols exported from
189 * FFmpeg libraries are tagged with the name and major version of the
190 * library to which they belong. If a function is moved from one
191 * library to another, a wrapper must be retained in the original
192 * location to preserve binary compatibility.
193 *
194 * Functions defined with this macro will never be used to resolve
195 * symbols by the build-time linker.
196 *
197 * @param type return type of function
198 * @param name name of function
199 * @param args argument list of function
200 * @param ver version tag to assign function
33586ee7 201 */
b462d132 202#if HAVE_SYMVER_ASM_LABEL
ccc87908
MR
203# define FF_SYMVER(type, name, args, ver) \
204 type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver); \
b462d132
MR
205 type ff_##name args
206#elif HAVE_SYMVER_GNU_ASM
ccc87908
MR
207# define FF_SYMVER(type, name, args, ver) \
208 __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver); \
209 type ff_##name args; \
b462d132
MR
210 type ff_##name args
211#endif
212
98790382 213#endif /* AVUTIL_INTERNAL_H */