rename attribute_unused to av_unused and moves its declaration to common.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 internal.h
23  * common internal api header.
24  */
25
26 #ifndef INTERNAL_H
27 #define INTERNAL_H
28
29 #ifndef attribute_used
30 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
31 #    define attribute_used __attribute__((used))
32 #else
33 #    define attribute_used
34 #endif
35 #endif
36
37 #ifndef M_PI
38 #define M_PI    3.14159265358979323846
39 #endif
40
41 #ifndef INT16_MIN
42 #define INT16_MIN       (-0x7fff-1)
43 #endif
44
45 #ifndef INT16_MAX
46 #define INT16_MAX       0x7fff
47 #endif
48
49 #ifndef INT32_MIN
50 #define INT32_MIN       (-0x7fffffff-1)
51 #endif
52
53 #ifndef INT32_MAX
54 #define INT32_MAX       0x7fffffff
55 #endif
56
57 #ifndef UINT32_MAX
58 #define UINT32_MAX      0xffffffff
59 #endif
60
61 #ifndef INT64_MIN
62 #define INT64_MIN       (-0x7fffffffffffffffLL-1)
63 #endif
64
65 #ifndef INT64_MAX
66 #define INT64_MAX INT64_C(9223372036854775807)
67 #endif
68
69 #ifndef UINT64_MAX
70 #define UINT64_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
71 #endif
72
73 #ifndef INT_BIT
74 #    if INT_MAX != 2147483647
75 #        define INT_BIT 64
76 #    else
77 #        define INT_BIT 32
78 #    endif
79 #endif
80
81 #if ( defined(__PIC__) || defined(__pic__) ) && ! defined(PIC)
82 #    define PIC
83 #endif
84
85 #include "intreadwrite.h"
86 #include "bswap.h"
87
88 #include <stddef.h>
89 #ifndef offsetof
90 #    define offsetof(T,F) ((unsigned int)((char *)&((T *)0)->F))
91 #endif
92
93 #ifdef __MINGW32__
94 #    ifdef _DEBUG
95 #        define DEBUG
96 #    endif
97
98 #    define snprintf _snprintf
99 #    define vsnprintf _vsnprintf
100
101 /* __MINGW32__ end */
102 #elif defined (CONFIG_OS2)
103 /* OS/2 EMX */
104
105 #    include <float.h>
106
107 #endif /* !__MINGW32__ && CONFIG_OS2 */
108
109 #ifdef USE_FASTMEMCPY
110 #    include "libvo/fastmemcpy.h"
111 #endif
112
113 // Use rip-relative addressing if compiling PIC code on x86-64.
114 #if defined(__MINGW32__) || defined(__CYGWIN__) || \
115     defined(__OS2__) || (defined (__OpenBSD__) && !defined(__ELF__))
116 #    if defined(ARCH_X86_64) && defined(PIC)
117 #        define MANGLE(a) "_" #a"(%%rip)"
118 #    else
119 #        define MANGLE(a) "_" #a
120 #    endif
121 #else
122 #    if defined(ARCH_X86_64) && defined(PIC)
123 #        define MANGLE(a) #a"(%%rip)"
124 #    elif defined(CONFIG_DARWIN)
125 #        define MANGLE(a) "_" #a
126 #    else
127 #        define MANGLE(a) #a
128 #    endif
129 #endif
130
131 /* debug stuff */
132
133 #if !defined(DEBUG) && !defined(NDEBUG)
134 #    define NDEBUG
135 #endif
136 #include <assert.h>
137
138 /* dprintf macros */
139 #ifdef DEBUG
140 #    define dprintf(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
141 #else
142 #    define dprintf(pctx, ...)
143 #endif
144
145 #define av_abort()      do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
146
147 /* math */
148
149 extern const uint32_t ff_inverse[256];
150
151 #if defined(ARCH_X86)
152 #    define FASTDIV(a,b) \
153     ({\
154         int ret,dmy;\
155         asm volatile(\
156             "mull %3"\
157             :"=d"(ret),"=a"(dmy)\
158             :"1"(a),"g"(ff_inverse[b])\
159             );\
160         ret;\
161     })
162 #elif defined(ARCH_ARMV4L)
163 #    define FASTDIV(a,b) \
164     ({\
165         int ret,dmy;\
166         asm volatile(\
167             "umull %1, %0, %2, %3"\
168             :"=&r"(ret),"=&r"(dmy)\
169             :"r"(a),"r"(ff_inverse[b])\
170             );\
171         ret;\
172     })
173 #elif defined(CONFIG_FASTDIV)
174 #    define FASTDIV(a,b)   ((uint32_t)((((uint64_t)a)*ff_inverse[b])>>32))
175 #else
176 #    define FASTDIV(a,b)   ((a)/(b))
177 #endif
178
179 extern const uint8_t ff_sqrt_tab[128];
180
181 static inline int ff_sqrt(int a)
182 {
183     int ret=0;
184     int s, b;
185
186     if(a<128) return ff_sqrt_tab[a];
187
188     for(s=30; s>=0; s-=2){
189         ret+=ret;
190         b= (1+2*ret)<<s;
191         if(b<=a){
192             a-=b;
193             ret++;
194         }
195     }
196     return ret;
197 }
198
199 #if defined(ARCH_X86)
200 #define MASK_ABS(mask, level)\
201             asm volatile(\
202                 "cdq                    \n\t"\
203                 "xorl %1, %0            \n\t"\
204                 "subl %1, %0            \n\t"\
205                 : "+a" (level), "=&d" (mask)\
206             );
207 #else
208 #define MASK_ABS(mask, level)\
209             mask= level>>31;\
210             level= (level^mask)-mask;
211 #endif
212
213 #ifdef HAVE_CMOV
214 #define COPY3_IF_LT(x,y,a,b,c,d)\
215 asm volatile (\
216     "cmpl %0, %3        \n\t"\
217     "cmovl %3, %0       \n\t"\
218     "cmovl %4, %1       \n\t"\
219     "cmovl %5, %2       \n\t"\
220     : "+&r" (x), "+&r" (a), "+r" (c)\
221     : "r" (y), "r" (b), "r" (d)\
222 );
223 #else
224 #define COPY3_IF_LT(x,y,a,b,c,d)\
225 if((y)<(x)){\
226      (x)=(y);\
227      (a)=(b);\
228      (c)=(d);\
229 }
230 #endif
231
232 /* avoid usage of various functions */
233 #define malloc please_use_av_malloc
234 #define free please_use_av_free
235 #define realloc please_use_av_realloc
236 #define time time_is_forbidden_due_to_security_issues
237 #define rand rand_is_forbidden_due_to_state_trashing
238 #define srand srand_is_forbidden_due_to_state_trashing
239 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
240 #define strcat strcat_is_forbidden_due_to_security_issues_use_pstrcat
241 #define exit exit_is_forbidden
242 #if !(defined(LIBAVFORMAT_BUILD) || defined(_FRAMEHOOK_H))
243 #define printf please_use_av_log
244 #define fprintf please_use_av_log
245 #endif
246
247 #define CHECKED_ALLOCZ(p, size)\
248 {\
249     p= av_mallocz(size);\
250     if(p==NULL && (size)!=0){\
251         perror("malloc");\
252         goto fail;\
253     }\
254 }
255
256 #ifndef HAVE_LRINTF
257 /* XXX: add ISOC specific test to avoid specific BSD testing. */
258 /* better than nothing implementation. */
259 /* btw, rintf() is existing on fbsd too -- alex */
260 static av_always_inline long int lrintf(float x)
261 {
262 #ifdef __MINGW32__
263 #  ifdef ARCH_X86_32
264     int32_t i;
265     asm volatile(
266         "fistpl %0\n\t"
267         : "=m" (i) : "t" (x) : "st"
268     );
269     return i;
270 #  else
271     /* XXX: incorrect, but make it compile */
272     return (int)(x + (x < 0 ? -0.5 : 0.5));
273 #  endif /* ARCH_X86_32 */
274 #else
275     return (int)(rint(x));
276 #endif /* __MINGW32__ */
277 }
278 #endif /* HAVE_LRINTF */
279
280 #endif /* INTERNAL_H */