remove 'restrict' definition, it is always #defined in config.h
[libav.git] / libavutil / common.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 common.h
23 * common internal and external api header.
24 */
25
26 #ifndef COMMON_H
27 #define COMMON_H
28
29 #ifndef M_PI
30 #define M_PI 3.14159265358979323846
31 #endif
32
33 #ifdef HAVE_AV_CONFIG_H
34 /* only include the following when compiling package */
35 # include "config.h"
36
37 # include <stdlib.h>
38 # include <stdio.h>
39 # include <string.h>
40 # include <ctype.h>
41 # include <limits.h>
42 # ifndef __BEOS__
43 # include <errno.h>
44 # else
45 # include "berrno.h"
46 # endif
47 # include <math.h>
48 #endif /* HAVE_AV_CONFIG_H */
49
50 #ifndef always_inline
51 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
52 # define always_inline __attribute__((always_inline)) inline
53 #else
54 # define always_inline inline
55 #endif
56 #endif
57
58 #ifndef attribute_used
59 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
60 # define attribute_used __attribute__((used))
61 #else
62 # define attribute_used
63 #endif
64 #endif
65
66 #ifndef attribute_unused
67 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
68 # define attribute_unused __attribute__((unused))
69 #else
70 # define attribute_unused
71 #endif
72 #endif
73
74 #ifndef attribute_deprecated
75 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
76 # define attribute_deprecated __attribute__((deprecated))
77 #else
78 # define attribute_deprecated
79 #endif
80 #endif
81
82 # include <inttypes.h>
83
84 #ifndef PRId64
85 #define PRId64 "lld"
86 #endif
87
88 #ifndef PRIu64
89 #define PRIu64 "llu"
90 #endif
91
92 #ifndef PRIx64
93 #define PRIx64 "llx"
94 #endif
95
96 #ifndef PRIX64
97 #define PRIX64 "llX"
98 #endif
99
100 #ifndef PRId32
101 #define PRId32 "d"
102 #endif
103
104 #ifndef PRIdFAST16
105 #define PRIdFAST16 PRId32
106 #endif
107
108 #ifndef PRIdFAST32
109 #define PRIdFAST32 PRId32
110 #endif
111
112 #ifndef INT16_MIN
113 #define INT16_MIN (-0x7fff-1)
114 #endif
115
116 #ifndef INT16_MAX
117 #define INT16_MAX 0x7fff
118 #endif
119
120 #ifndef INT32_MIN
121 #define INT32_MIN (-0x7fffffff-1)
122 #endif
123
124 #ifndef INT32_MAX
125 #define INT32_MAX 0x7fffffff
126 #endif
127
128 #ifndef UINT32_MAX
129 #define UINT32_MAX 0xffffffff
130 #endif
131
132 #ifndef INT64_MIN
133 #define INT64_MIN (-0x7fffffffffffffffLL-1)
134 #endif
135
136 #ifndef INT64_MAX
137 #define INT64_MAX int64_t_C(9223372036854775807)
138 #endif
139
140 #ifndef UINT64_MAX
141 #define UINT64_MAX uint64_t_C(0xFFFFFFFFFFFFFFFF)
142 #endif
143
144 #ifndef INT_BIT
145 # if INT_MAX != 2147483647
146 # define INT_BIT 64
147 # else
148 # define INT_BIT 32
149 # endif
150 #endif
151
152 #ifndef int64_t_C
153 #define int64_t_C(c) (c ## LL)
154 #define uint64_t_C(c) (c ## ULL)
155 #endif
156
157 #if defined(__MINGW32__) && !defined(BUILD_AVUTIL) && defined(BUILD_SHARED_AV)
158 # define FF_IMPORT_ATTR __declspec(dllimport)
159 #else
160 # define FF_IMPORT_ATTR
161 #endif
162
163
164 #ifdef HAVE_AV_CONFIG_H
165 /* only include the following when compiling package */
166 # include "internal.h"
167 #endif
168
169 //rounded divison & shift
170 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
171 /* assume b>0 */
172 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
173 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
174 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
175
176 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
177 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
178
179 #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
180
181 /* misc math functions */
182 extern FF_IMPORT_ATTR const uint8_t ff_log2_tab[256];
183
184 static inline int av_log2(unsigned int v)
185 {
186 int n;
187
188 n = 0;
189 if (v & 0xffff0000) {
190 v >>= 16;
191 n += 16;
192 }
193 if (v & 0xff00) {
194 v >>= 8;
195 n += 8;
196 }
197 n += ff_log2_tab[v];
198
199 return n;
200 }
201
202 static inline int av_log2_16bit(unsigned int v)
203 {
204 int n;
205
206 n = 0;
207 if (v & 0xff00) {
208 v >>= 8;
209 n += 8;
210 }
211 n += ff_log2_tab[v];
212
213 return n;
214 }
215
216 /* median of 3 */
217 static inline int mid_pred(int a, int b, int c)
218 {
219 #if HAVE_CMOV
220 int i=b;
221 asm volatile(
222 "cmp %2, %1 \n\t"
223 "cmovg %1, %0 \n\t"
224 "cmovg %2, %1 \n\t"
225 "cmp %3, %1 \n\t"
226 "cmovl %3, %1 \n\t"
227 "cmp %1, %0 \n\t"
228 "cmovg %1, %0 \n\t"
229 :"+&r"(i), "+&r"(a)
230 :"r"(b), "r"(c)
231 );
232 return i;
233 #elif 0
234 int t= (a-b)&((a-b)>>31);
235 a-=t;
236 b+=t;
237 b-= (b-c)&((b-c)>>31);
238 b+= (a-b)&((a-b)>>31);
239
240 return b;
241 #else
242 if(a>b){
243 if(c>b){
244 if(c>a) b=a;
245 else b=c;
246 }
247 }else{
248 if(b>c){
249 if(c>a) b=c;
250 else b=a;
251 }
252 }
253 return b;
254 #endif
255 }
256
257 /**
258 * clip a signed integer value into the amin-amax range
259 * @param a value to clip
260 * @param amin minimum value of the clip range
261 * @param amax maximum value of the clip range
262 * @return clipped value
263 */
264 static inline int clip(int a, int amin, int amax)
265 {
266 if (a < amin) return amin;
267 else if (a > amax) return amax;
268 else return a;
269 }
270
271 /**
272 * clip a signed integer value into the 0-255 range
273 * @param a value to clip
274 * @return clipped value
275 */
276 static inline uint8_t clip_uint8(int a)
277 {
278 if (a&(~255)) return (-a)>>31;
279 else return a;
280 }
281
282 /* math */
283 int64_t ff_gcd(int64_t a, int64_t b);
284
285 /**
286 * converts fourcc string to int
287 */
288 static inline int ff_get_fourcc(const char *s){
289 #ifdef HAVE_AV_CONFIG_H
290 assert( strlen(s)==4 );
291 #endif
292
293 return (s[0]) + (s[1]<<8) + (s[2]<<16) + (s[3]<<24);
294 }
295
296 #define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
297 #define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
298
299 /*!
300 * \def GET_UTF8(val, GET_BYTE, ERROR)
301 * converts a utf-8 character (up to 4 bytes long) to its 32-bit ucs-4 encoded form
302 * \param val is the output and should be of type uint32_t. It holds the converted
303 * ucs-4 character and should be a left value.
304 * \param GET_BYTE gets utf-8 encoded bytes from any proper source. It can be
305 * a function or a statement whose return value or evaluated value is of type
306 * uint8_t. It will be executed up to 4 times for values in the valid utf-8 range,
307 * and up to 7 times in the general case.
308 * \param ERROR action that should be taken when an invalid utf-8 byte is returned
309 * from GET_BYTE. It should be a statement that jumps out of the macro,
310 * like exit(), goto, return, break, or continue.
311 */
312 #define GET_UTF8(val, GET_BYTE, ERROR)\
313 val= GET_BYTE;\
314 {\
315 int ones= 7 - av_log2(val ^ 255);\
316 if(ones==1)\
317 ERROR\
318 val&= 127>>ones;\
319 while(--ones > 0){\
320 int tmp= GET_BYTE - 128;\
321 if(tmp>>6)\
322 ERROR\
323 val= (val<<6) + tmp;\
324 }\
325 }
326
327 /*!
328 * \def PUT_UTF8(val, tmp, PUT_BYTE)
329 * converts a 32-bit unicode character to its utf-8 encoded form (up to 4 bytes long).
330 * \param val is an input only argument and should be of type uint32_t. It holds
331 * a ucs4 encoded unicode character that is to be converted to utf-8. If
332 * val is given as a function it's executed only once.
333 * \param tmp is a temporary variable and should be of type uint8_t. It
334 * represents an intermediate value during conversion that is to be
335 * outputted by PUT_BYTE.
336 * \param PUT_BYTE writes the converted utf-8 bytes to any proper destination.
337 * It could be a function or a statement, and uses tmp as the input byte.
338 * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
339 * executed up to 4 times for values in the valid utf-8 range and up to
340 * 7 times in the general case, depending on the length of the converted
341 * unicode character.
342 */
343 #define PUT_UTF8(val, tmp, PUT_BYTE)\
344 {\
345 int bytes, shift;\
346 uint32_t in = val;\
347 if (in < 0x80) {\
348 tmp = in;\
349 PUT_BYTE\
350 } else {\
351 bytes = (av_log2(in) + 4) / 5;\
352 shift = (bytes - 1) * 6;\
353 tmp = (256 - (256 >> bytes)) | (in >> shift);\
354 PUT_BYTE\
355 while (shift >= 6) {\
356 shift -= 6;\
357 tmp = 0x80 | ((in >> shift) & 0x3f);\
358 PUT_BYTE\
359 }\
360 }\
361 }
362
363 #if defined(ARCH_X86) || defined(ARCH_POWERPC)
364 #if defined(ARCH_X86_64)
365 static inline uint64_t read_time(void)
366 {
367 uint64_t a, d;
368 asm volatile( "rdtsc\n\t"
369 : "=a" (a), "=d" (d)
370 );
371 return (d << 32) | (a & 0xffffffff);
372 }
373 #elif defined(ARCH_X86_32)
374 static inline long long read_time(void)
375 {
376 long long l;
377 asm volatile( "rdtsc\n\t"
378 : "=A" (l)
379 );
380 return l;
381 }
382 #else //FIXME check ppc64
383 static inline uint64_t read_time(void)
384 {
385 uint32_t tbu, tbl, temp;
386
387 /* from section 2.2.1 of the 32-bit PowerPC PEM */
388 __asm__ __volatile__(
389 "1:\n"
390 "mftbu %2\n"
391 "mftb %0\n"
392 "mftbu %1\n"
393 "cmpw %2,%1\n"
394 "bne 1b\n"
395 : "=r"(tbl), "=r"(tbu), "=r"(temp)
396 :
397 : "cc");
398
399 return (((uint64_t)tbu)<<32) | (uint64_t)tbl;
400 }
401 #endif
402
403 #define START_TIMER \
404 uint64_t tend;\
405 uint64_t tstart= read_time();\
406
407 #define STOP_TIMER(id) \
408 tend= read_time();\
409 {\
410 static uint64_t tsum=0;\
411 static int tcount=0;\
412 static int tskip_count=0;\
413 if(tcount<2 || tend - tstart < 8*tsum/tcount){\
414 tsum+= tend - tstart;\
415 tcount++;\
416 }else\
417 tskip_count++;\
418 if(((tcount+tskip_count)&(tcount+tskip_count-1))==0){\
419 av_log(NULL, AV_LOG_DEBUG, "%"PRIu64" dezicycles in %s, %d runs, %d skips\n", tsum*10/tcount, id, tcount, tskip_count);\
420 }\
421 }
422 #else
423 #define START_TIMER
424 #define STOP_TIMER(id) {}
425 #endif
426
427 /* memory */
428
429 #ifdef __GNUC__
430 #define DECLARE_ALIGNED(n,t,v) t v __attribute__ ((aligned (n)))
431 #else
432 #define DECLARE_ALIGNED(n,t,v) __declspec(align(n)) t v
433 #endif
434
435 /* memory */
436 void *av_malloc(unsigned int size);
437 void *av_realloc(void *ptr, unsigned int size);
438 void av_free(void *ptr);
439
440 void *av_mallocz(unsigned int size);
441 char *av_strdup(const char *s);
442 void av_freep(void *ptr);
443
444 #endif /* COMMON_H */