Rename attribute_used to av_used and move it to attributes.h
[ffmpeg.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 ARCH_X86_32 && (!defined(__ICC) || __ICC > 1200) && 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 INT16_MIN
50 #define INT16_MIN       (-0x7fff - 1)
51 #endif
52
53 #ifndef INT16_MAX
54 #define INT16_MAX       0x7fff
55 #endif
56
57 #ifndef INT32_MIN
58 #define INT32_MIN       (-0x7fffffff - 1)
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
70 #define INT64_MIN       (-0x7fffffffffffffffLL - 1)
71 #endif
72
73 #ifndef INT64_MAX
74 #define INT64_MAX INT64_C(9223372036854775807)
75 #endif
76
77 #ifndef UINT64_MAX
78 #define UINT64_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
79 #endif
80
81 #ifndef INT_BIT
82 #    define INT_BIT (CHAR_BIT * sizeof(int))
83 #endif
84
85 #ifndef offsetof
86 #    define offsetof(T, F) ((unsigned int)((char *)&((T *)0)->F))
87 #endif
88
89 /* Use to export labels from asm. */
90 #define LABEL_MANGLE(a) EXTERN_PREFIX #a
91
92 // Use rip-relative addressing if compiling PIC code on x86-64.
93 #if ARCH_X86_64 && defined(PIC)
94 #    define LOCAL_MANGLE(a) #a "(%%rip)"
95 #else
96 #    define LOCAL_MANGLE(a) #a
97 #endif
98
99 #define MANGLE(a) EXTERN_PREFIX LOCAL_MANGLE(a)
100
101 /* debug stuff */
102
103 #define av_abort()      do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
104
105 /* math */
106
107 #if ARCH_X86
108 #define MASK_ABS(mask, level)\
109             __asm__ volatile(\
110                 "cltd                   \n\t"\
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)\
117             mask  = level >> 31;\
118             level = (level ^ mask) - mask;
119 #endif
120
121 /* avoid usage of dangerous/inappropriate system functions */
122 #undef  malloc
123 #define malloc please_use_av_malloc
124 #undef  free
125 #define free please_use_av_free
126 #undef  realloc
127 #define realloc please_use_av_realloc
128 #undef  time
129 #define time time_is_forbidden_due_to_security_issues
130 #undef  rand
131 #define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
132 #undef  srand
133 #define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
134 #undef  random
135 #define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
136 #undef  sprintf
137 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
138 #undef  strcat
139 #define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
140 #undef  exit
141 #define exit exit_is_forbidden
142 #ifndef LIBAVFORMAT_BUILD
143 #undef  printf
144 #define printf please_use_av_log_instead_of_printf
145 #undef  fprintf
146 #define fprintf please_use_av_log_instead_of_fprintf
147 #undef  puts
148 #define puts please_use_av_log_instead_of_puts
149 #undef  perror
150 #define perror please_use_av_log_instead_of_perror
151 #endif
152
153 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
154 {\
155     p = av_malloc(size);\
156     if (p == NULL && (size) != 0) {\
157         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
158         goto label;\
159     }\
160 }
161
162 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
163 {\
164     p = av_mallocz(size);\
165     if (p == NULL && (size) != 0) {\
166         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
167         goto label;\
168     }\
169 }
170
171 #include "libm.h"
172
173 /**
174  * Return NULL if CONFIG_SMALL is true, otherwise the argument
175  * without modification. Used to disable the definition of strings
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
184
185 /**
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
201  */
202 #if HAVE_SYMVER_ASM_LABEL
203 #   define FF_SYMVER(type, name, args, ver)                     \
204     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
205     type ff_##name args
206 #elif HAVE_SYMVER_GNU_ASM
207 #   define FF_SYMVER(type, name, args, ver)                             \
208     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
209     type ff_##name args;                                                \
210     type ff_##name args
211 #endif
212
213 #endif /* AVUTIL_INTERNAL_H */