b361f722fa39c4d12a10c490c8e7deb884338f0f
[libav.git] / libavutil / internal.h
1 /*
2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
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
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 /**
22 * @file
23 * common internal API header
24 */
25
26 #ifndef AVUTIL_INTERNAL_H
27 #define AVUTIL_INTERNAL_H
28
29 #if !defined(DEBUG) && !defined(NDEBUG)
30 # define NDEBUG
31 #endif
32
33 #include <limits.h>
34 #include <stdint.h>
35 #include <stddef.h>
36 #include <assert.h>
37 #include "config.h"
38 #include "attributes.h"
39 #include "timer.h"
40
41 #ifndef attribute_align_arg
42 #if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,2)
43 # define attribute_align_arg __attribute__((force_align_arg_pointer))
44 #else
45 # define attribute_align_arg
46 #endif
47 #endif
48
49 #ifndef attribute_used
50 #if AV_GCC_VERSION_AT_LEAST(3,1)
51 # define attribute_used __attribute__((used))
52 #else
53 # define attribute_used
54 #endif
55 #endif
56
57 #ifndef INT16_MIN
58 #define INT16_MIN (-0x7fff - 1)
59 #endif
60
61 #ifndef INT16_MAX
62 #define INT16_MAX 0x7fff
63 #endif
64
65 #ifndef INT32_MIN
66 #define INT32_MIN (-0x7fffffff - 1)
67 #endif
68
69 #ifndef INT32_MAX
70 #define INT32_MAX 0x7fffffff
71 #endif
72
73 #ifndef UINT32_MAX
74 #define UINT32_MAX 0xffffffff
75 #endif
76
77 #ifndef INT64_MIN
78 #define INT64_MIN (-0x7fffffffffffffffLL - 1)
79 #endif
80
81 #ifndef INT64_MAX
82 #define INT64_MAX INT64_C(9223372036854775807)
83 #endif
84
85 #ifndef UINT64_MAX
86 #define UINT64_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
87 #endif
88
89 #ifndef INT_BIT
90 # define INT_BIT (CHAR_BIT * sizeof(int))
91 #endif
92
93 #ifndef offsetof
94 # define offsetof(T, F) ((unsigned int)((char *)&((T *)0)->F))
95 #endif
96
97 /* Use to export labels from asm. */
98 #define LABEL_MANGLE(a) EXTERN_PREFIX #a
99
100 // Use rip-relative addressing if compiling PIC code on x86-64.
101 #if ARCH_X86_64 && defined(PIC)
102 # define LOCAL_MANGLE(a) #a "(%%rip)"
103 #else
104 # define LOCAL_MANGLE(a) #a
105 #endif
106
107 #define MANGLE(a) EXTERN_PREFIX LOCAL_MANGLE(a)
108
109 /* debug stuff */
110
111 /* dprintf macros */
112 #ifdef DEBUG
113 # define dprintf(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
114 #else
115 # define dprintf(pctx, ...)
116 #endif
117
118 #define av_abort() do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
119
120 /* math */
121
122 #if ARCH_X86
123 #define MASK_ABS(mask, level)\
124 __asm__ volatile(\
125 "cltd \n\t"\
126 "xorl %1, %0 \n\t"\
127 "subl %1, %0 \n\t"\
128 : "+a" (level), "=&d" (mask)\
129 );
130 #else
131 #define MASK_ABS(mask, level)\
132 mask = level >> 31;\
133 level = (level ^ mask) - mask;
134 #endif
135
136 /* avoid usage of dangerous/inappropriate system functions */
137 #undef malloc
138 #define malloc please_use_av_malloc
139 #undef free
140 #define free please_use_av_free
141 #undef realloc
142 #define realloc please_use_av_realloc
143 #undef time
144 #define time time_is_forbidden_due_to_security_issues
145 #undef rand
146 #define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
147 #undef srand
148 #define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
149 #undef random
150 #define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
151 #undef sprintf
152 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
153 #undef strcat
154 #define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
155 #undef exit
156 #define exit exit_is_forbidden
157 #ifndef LIBAVFORMAT_BUILD
158 #undef printf
159 #define printf please_use_av_log_instead_of_printf
160 #undef fprintf
161 #define fprintf please_use_av_log_instead_of_fprintf
162 #undef puts
163 #define puts please_use_av_log_instead_of_puts
164 #undef perror
165 #define perror please_use_av_log_instead_of_perror
166 #endif
167
168 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
169 {\
170 p = av_malloc(size);\
171 if (p == NULL && (size) != 0) {\
172 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
173 goto label;\
174 }\
175 }
176
177 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
178 {\
179 p = av_mallocz(size);\
180 if (p == NULL && (size) != 0) {\
181 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
182 goto label;\
183 }\
184 }
185
186 #include "libm.h"
187
188 /**
189 * Returns NULL if CONFIG_SMALL is true, otherwise the argument
190 * without modification. Used to disable the definition of strings
191 * (for example AVCodec long_names).
192 */
193 #if CONFIG_SMALL
194 # define NULL_IF_CONFIG_SMALL(x) NULL
195 #else
196 # define NULL_IF_CONFIG_SMALL(x) x
197 #endif
198
199 #if HAVE_SYMVER_ASM_LABEL
200 # define FF_SYMVER(type, name, args, ver) \
201 type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver); \
202 type ff_##name args
203 #elif HAVE_SYMVER_GNU_ASM
204 # define FF_SYMVER(type, name, args, ver) \
205 __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver); \
206 type ff_##name args; \
207 type ff_##name args
208 #endif
209
210 #endif /* AVUTIL_INTERNAL_H */