6ef2a132960eb267eab80395e2b7a470ddfc1489
[ffmpeg.git] / libavutil / common.h
1 /**
2  * @file common.h
3  * common internal api header.
4  */
5
6 #ifndef COMMON_H
7 #define COMMON_H
8
9 #if defined(WIN32) && !defined(__MINGW32__) && !defined(__CYGWIN__)
10 #    define CONFIG_WIN32
11 #endif
12
13 #if defined(WIN32) && !defined(__MINGW32__) && !defined(__CYGWIN__) && !defined(EMULATE_INTTYPES)
14 #    define EMULATE_INTTYPES
15 #endif
16
17 #ifndef M_PI
18 #define M_PI    3.14159265358979323846
19 #endif
20
21 #ifdef HAVE_AV_CONFIG_H
22 /* only include the following when compiling package */
23 #    include "config.h"
24
25 #    include <stdlib.h>
26 #    include <stdio.h>
27 #    include <string.h>
28 #    include <ctype.h>
29 #    include <limits.h>
30 #    ifndef __BEOS__
31 #        include <errno.h>
32 #    else
33 #        include "berrno.h"
34 #    endif
35 #    include <math.h>
36
37 #    ifndef ENODATA
38 #        define ENODATA  61
39 #    endif
40
41 #include <stddef.h>
42 #ifndef offsetof
43 # define offsetof(T,F) ((unsigned int)((char *)&((T *)0)->F))
44 #endif
45
46 #define AVOPTION_CODEC_BOOL(name, help, field) \
47     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_BOOL }
48 #define AVOPTION_CODEC_DOUBLE(name, help, field, minv, maxv, defval) \
49     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_DOUBLE, minv, maxv, defval }
50 #define AVOPTION_CODEC_FLAG(name, help, field, flag, defval) \
51     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_FLAG, flag, 0, defval }
52 #define AVOPTION_CODEC_INT(name, help, field, minv, maxv, defval) \
53     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_INT, minv, maxv, defval }
54 #define AVOPTION_CODEC_STRING(name, help, field, str, val) \
55     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_STRING, .defval = val, .defstr = str }
56 #define AVOPTION_CODEC_RCOVERRIDE(name, help, field) \
57     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_RCOVERRIDE, .defval = 0, .defstr = NULL }
58 #define AVOPTION_SUB(ptr) { .name = NULL, .help = (const char*)ptr }
59 #define AVOPTION_END() AVOPTION_SUB(NULL)
60
61 #endif /* HAVE_AV_CONFIG_H */
62
63 /* Suppress restrict if it was not defined in config.h.  */
64 #ifndef restrict
65 #    define restrict
66 #endif
67
68 #ifndef always_inline
69 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
70 #    define always_inline __attribute__((always_inline)) inline
71 #else
72 #    define always_inline inline
73 #endif
74 #endif
75
76 #ifndef attribute_used
77 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
78 #    define attribute_used __attribute__((used))
79 #else
80 #    define attribute_used
81 #endif
82 #endif
83
84 #ifndef attribute_unused
85 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
86 #    define attribute_unused __attribute__((unused))
87 #else
88 #    define attribute_unused
89 #endif
90 #endif
91
92 #ifndef EMULATE_INTTYPES
93 #   include <inttypes.h>
94 #else
95     typedef signed char  int8_t;
96     typedef signed short int16_t;
97     typedef signed int   int32_t;
98     typedef unsigned char  uint8_t;
99     typedef unsigned short uint16_t;
100     typedef unsigned int   uint32_t;
101
102 #   ifdef CONFIG_WIN32
103         typedef signed __int64   int64_t;
104         typedef unsigned __int64 uint64_t;
105 #   else /* other OS */
106         typedef signed long long   int64_t;
107         typedef unsigned long long uint64_t;
108 #   endif /* other OS */
109 #endif /* EMULATE_INTTYPES */
110
111 #ifndef PRId64
112 #define PRId64 "lld"
113 #endif
114
115 #ifndef PRIu64
116 #define PRIu64 "llu"
117 #endif
118
119 #ifndef PRIx64
120 #define PRIx64 "llx"
121 #endif
122
123 #ifndef PRId32
124 #define PRId32 "d"
125 #endif
126
127 #ifndef PRIdFAST16
128 #define PRIdFAST16 PRId32
129 #endif
130
131 #ifndef PRIdFAST32
132 #define PRIdFAST32 PRId32
133 #endif
134
135 #ifndef INT16_MIN
136 #define INT16_MIN       (-0x7fff-1)
137 #endif
138
139 #ifndef INT16_MAX
140 #define INT16_MAX       0x7fff
141 #endif
142
143 #ifndef INT32_MIN
144 #define INT32_MIN       (-0x7fffffff-1)
145 #endif
146
147 #ifndef INT32_MAX
148 #define INT32_MAX       0x7fffffff
149 #endif
150
151 #ifndef UINT32_MAX
152 #define UINT32_MAX      0xffffffff
153 #endif
154
155 #ifndef INT64_MIN
156 #define INT64_MIN       (-0x7fffffffffffffffLL-1)
157 #endif
158
159 #ifndef INT64_MAX
160 #define INT64_MAX int64_t_C(9223372036854775807)
161 #endif
162
163 #ifndef UINT64_MAX
164 #define UINT64_MAX uint64_t_C(0xFFFFFFFFFFFFFFFF)
165 #endif
166
167 #ifdef EMULATE_FAST_INT
168 typedef signed char int_fast8_t;
169 typedef signed int  int_fast16_t;
170 typedef signed int  int_fast32_t;
171 typedef unsigned char uint_fast8_t;
172 typedef unsigned int  uint_fast16_t;
173 typedef unsigned int  uint_fast32_t;
174 typedef uint64_t      uint_fast64_t;
175 #endif
176
177 #ifndef INT_BIT
178 #    if INT_MAX != 2147483647
179 #        define INT_BIT 64
180 #    else
181 #        define INT_BIT 32
182 #    endif
183 #endif
184
185 #ifdef CONFIG_WIN32
186
187 /* windows */
188
189 #    if !defined(__MINGW32__) && !defined(__CYGWIN__)
190 #        define int64_t_C(c)     (c ## i64)
191 #        define uint64_t_C(c)    (c ## i64)
192
193 #    ifdef HAVE_AV_CONFIG_H
194 #            define inline __inline
195 #    endif
196
197 #    else
198 #        define int64_t_C(c)     (c ## LL)
199 #        define uint64_t_C(c)    (c ## ULL)
200 #    endif /* __MINGW32__ */
201
202 #    ifdef HAVE_AV_CONFIG_H
203 #        ifdef _DEBUG
204 #            define DEBUG
205 #        endif
206
207 #        define snprintf _snprintf
208 #        define vsnprintf _vsnprintf
209
210 #        ifdef CONFIG_WINCE
211 #            define perror(a)
212 #        endif
213
214 #    endif
215
216 /* CONFIG_WIN32 end */
217 #elif defined (CONFIG_OS2)
218 /* OS/2 EMX */
219
220 #ifndef int64_t_C
221 #define int64_t_C(c)     (c ## LL)
222 #define uint64_t_C(c)    (c ## ULL)
223 #endif
224
225 #ifdef HAVE_AV_CONFIG_H
226
227 #ifdef USE_FASTMEMCPY
228 #include "fastmemcpy.h"
229 #endif
230
231 #include <float.h>
232
233 #endif /* HAVE_AV_CONFIG_H */
234
235 /* CONFIG_OS2 end */
236 #else
237
238 /* unix */
239
240 #ifndef int64_t_C
241 #define int64_t_C(c)     (c ## LL)
242 #define uint64_t_C(c)    (c ## ULL)
243 #endif
244
245 #ifdef HAVE_AV_CONFIG_H
246
247 #        ifdef USE_FASTMEMCPY
248 #            include "fastmemcpy.h"
249 #        endif
250 #    endif /* HAVE_AV_CONFIG_H */
251
252 #endif /* !CONFIG_WIN32 && !CONFIG_OS2 */
253
254 #ifdef HAVE_AV_CONFIG_H
255
256 #if defined(__MINGW32__) && !defined(BUILD_AVUTIL) && defined(BUILD_SHARED_AV)
257 #  define FF_IMPORT_ATTR __declspec(dllimport)
258 #else
259 #  define FF_IMPORT_ATTR
260 #endif
261
262
263 #    include "bswap.h"
264
265 // Use rip-relative addressing if compiling PIC code on x86-64.
266 #    if defined(__MINGW32__) || defined(__CYGWIN__) || \
267         defined(__OS2__) || (defined (__OpenBSD__) && !defined(__ELF__))
268 #        if defined(ARCH_X86_64) && defined(PIC)
269 #            define MANGLE(a) "_" #a"(%%rip)"
270 #        else
271 #            define MANGLE(a) "_" #a
272 #        endif
273 #    else
274 #        if defined(ARCH_X86_64) && defined(PIC)
275 #            define MANGLE(a) #a"(%%rip)"
276 #        elif defined(CONFIG_DARWIN)
277 #            define MANGLE(a) "_" #a
278 #        else
279 #            define MANGLE(a) #a
280 #        endif
281 #    endif
282
283 /* debug stuff */
284
285 #    if !defined(DEBUG) && !defined(NDEBUG)
286 #        define NDEBUG
287 #    endif
288 #    include <assert.h>
289
290 /* dprintf macros */
291 #    if defined(CONFIG_WIN32) && !defined(__MINGW32__) && !defined(__CYGWIN__)
292
293 inline void dprintf(const char* fmt,...) {}
294
295 #    else
296
297 #        ifdef DEBUG
298 #            define dprintf(fmt,...) av_log(NULL, AV_LOG_DEBUG, fmt, __VA_ARGS__)
299 #        else
300 #            define dprintf(fmt,...)
301 #        endif
302
303 #    endif /* !CONFIG_WIN32 */
304 #    ifdef CONFIG_WINCE
305 #            define abort()
306 #    endif
307
308 #    define av_abort()      do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
309
310 //rounded divison & shift
311 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
312 /* assume b>0 */
313 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
314 #define ABS(a) ((a) >= 0 ? (a) : (-(a)))
315
316 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
317 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
318
319 extern const uint32_t inverse[256];
320
321 #if defined(ARCH_X86) || defined(ARCH_X86_64)
322 #    define FASTDIV(a,b) \
323     ({\
324         int ret,dmy;\
325         asm volatile(\
326             "mull %3"\
327             :"=d"(ret),"=a"(dmy)\
328             :"1"(a),"g"(inverse[b])\
329             );\
330         ret;\
331     })
332 #elif defined(CONFIG_FASTDIV)
333 #    define FASTDIV(a,b)   ((uint32_t)((((uint64_t)a)*inverse[b])>>32))
334 #else
335 #    define FASTDIV(a,b)   ((a)/(b))
336 #endif
337
338 /* define it to include statistics code (useful only for optimizing
339    codec efficiency */
340 //#define STATS
341
342 #ifdef STATS
343
344 enum {
345     ST_UNKNOWN,
346     ST_DC,
347     ST_INTRA_AC,
348     ST_INTER_AC,
349     ST_INTRA_MB,
350     ST_INTER_MB,
351     ST_MV,
352     ST_NB,
353 };
354
355 extern int st_current_index;
356 extern unsigned int st_bit_counts[ST_NB];
357 extern unsigned int st_out_bit_counts[ST_NB];
358
359 void print_stats(void);
360 #endif
361
362 /* misc math functions */
363 extern FF_IMPORT_ATTR const uint8_t ff_log2_tab[256];
364
365 static inline int av_log2(unsigned int v)
366 {
367     int n;
368
369     n = 0;
370     if (v & 0xffff0000) {
371         v >>= 16;
372         n += 16;
373     }
374     if (v & 0xff00) {
375         v >>= 8;
376         n += 8;
377     }
378     n += ff_log2_tab[v];
379
380     return n;
381 }
382
383 static inline int av_log2_16bit(unsigned int v)
384 {
385     int n;
386
387     n = 0;
388     if (v & 0xff00) {
389         v >>= 8;
390         n += 8;
391     }
392     n += ff_log2_tab[v];
393
394     return n;
395 }
396
397 /* median of 3 */
398 static inline int mid_pred(int a, int b, int c)
399 {
400 #if 0
401     int t= (a-b)&((a-b)>>31);
402     a-=t;
403     b+=t;
404     b-= (b-c)&((b-c)>>31);
405     b+= (a-b)&((a-b)>>31);
406
407     return b;
408 #else
409     if(a>b){
410         if(c>b){
411             if(c>a) b=a;
412             else    b=c;
413         }
414     }else{
415         if(b>c){
416             if(c>a) b=c;
417             else    b=a;
418         }
419     }
420     return b;
421 #endif
422 }
423
424 /**
425  * clip a signed integer value into the amin-amax range
426  * @param a value to clip
427  * @param amin minimum value of the clip range
428  * @param amax maximum value of the clip range
429  * @return cliped value
430  */
431 static inline int clip(int a, int amin, int amax)
432 {
433     if (a < amin)
434         return amin;
435     else if (a > amax)
436         return amax;
437     else
438         return a;
439 }
440
441 /**
442  * clip a signed integer value into the 0-255 range
443  * @param a value to clip
444  * @return cliped value
445  */
446 static inline uint8_t clip_uint8(int a)
447 {
448     if (a&(~255)) return (-a)>>31;
449     else          return a;
450 }
451
452 /* math */
453 extern FF_IMPORT_ATTR const uint8_t ff_sqrt_tab[128];
454
455 int64_t ff_gcd(int64_t a, int64_t b);
456
457 static inline int ff_sqrt(int a)
458 {
459     int ret=0;
460     int s;
461     int ret_sq=0;
462
463     if(a<128) return ff_sqrt_tab[a];
464
465     for(s=15; s>=0; s--){
466         int b= ret_sq + (1<<(s*2)) + (ret<<s)*2;
467         if(b<=a){
468             ret_sq=b;
469             ret+= 1<<s;
470         }
471     }
472     return ret;
473 }
474
475 /**
476  * converts fourcc string to int
477  */
478 static inline int ff_get_fourcc(const char *s){
479     assert( strlen(s)==4 );
480
481     return (s[0]) + (s[1]<<8) + (s[2]<<16) + (s[3]<<24);
482 }
483
484 #define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
485 #define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
486
487
488 #if defined(ARCH_X86) || defined(ARCH_X86_64)
489 #define MASK_ABS(mask, level)\
490             asm volatile(\
491                 "cdq                    \n\t"\
492                 "xorl %1, %0            \n\t"\
493                 "subl %1, %0            \n\t"\
494                 : "+a" (level), "=&d" (mask)\
495             );
496 #else
497 #define MASK_ABS(mask, level)\
498             mask= level>>31;\
499             level= (level^mask)-mask;
500 #endif
501
502
503 #if __CPU__ >= 686 && !defined(RUNTIME_CPUDETECT)
504 #define COPY3_IF_LT(x,y,a,b,c,d)\
505 asm volatile (\
506     "cmpl %0, %3        \n\t"\
507     "cmovl %3, %0       \n\t"\
508     "cmovl %4, %1       \n\t"\
509     "cmovl %5, %2       \n\t"\
510     : "+r" (x), "+r" (a), "+r" (c)\
511     : "r" (y), "r" (b), "r" (d)\
512 );
513 #else
514 #define COPY3_IF_LT(x,y,a,b,c,d)\
515 if((y)<(x)){\
516      (x)=(y);\
517      (a)=(b);\
518      (c)=(d);\
519 }
520 #endif
521
522 #if defined(ARCH_X86) || defined(ARCH_X86_64) || defined(ARCH_POWERPC)
523 #if defined(ARCH_X86_64)
524 static inline uint64_t read_time(void)
525 {
526         uint64_t a, d;
527         asm volatile(   "rdtsc\n\t"
528                 : "=a" (a), "=d" (d)
529         );
530         return (d << 32) | (a & 0xffffffff);
531 }
532 #elif defined(ARCH_X86)
533 static inline long long read_time(void)
534 {
535         long long l;
536         asm volatile(   "rdtsc\n\t"
537                 : "=A" (l)
538         );
539         return l;
540 }
541 #else //FIXME check ppc64
542 static inline uint64_t read_time(void)
543 {
544     uint32_t tbu, tbl, temp;
545
546      /* from section 2.2.1 of the 32-bit PowerPC PEM */
547      __asm__ __volatile__(
548          "1:\n"
549          "mftbu  %2\n"
550          "mftb   %0\n"
551          "mftbu  %1\n"
552          "cmpw   %2,%1\n"
553          "bne    1b\n"
554      : "=r"(tbl), "=r"(tbu), "=r"(temp)
555      :
556      : "cc");
557
558      return (((uint64_t)tbu)<<32) | (uint64_t)tbl;
559 }
560 #endif
561
562 #define START_TIMER \
563 uint64_t tend;\
564 uint64_t tstart= read_time();\
565
566 #define STOP_TIMER(id) \
567 tend= read_time();\
568 {\
569   static uint64_t tsum=0;\
570   static int tcount=0;\
571   static int tskip_count=0;\
572   if(tcount<2 || tend - tstart < 8*tsum/tcount){\
573       tsum+= tend - tstart;\
574       tcount++;\
575   }else\
576       tskip_count++;\
577   if(256*256*256*64%(tcount+tskip_count)==0){\
578       av_log(NULL, AV_LOG_DEBUG, "%"PRIu64" dezicycles in %s, %d runs, %d skips\n", tsum*10/tcount, id, tcount, tskip_count);\
579   }\
580 }
581 #else
582 #define START_TIMER
583 #define STOP_TIMER(id) {}
584 #endif
585
586 /* avoid usage of various functions */
587 #define malloc please_use_av_malloc
588 #define free please_use_av_free
589 #define realloc please_use_av_realloc
590 #define time time_is_forbidden_due_to_security_issues
591 #define rand rand_is_forbidden_due_to_state_trashing
592 #define srand srand_is_forbidden_due_to_state_trashing
593 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
594 #define strcat strcat_is_forbidden_due_to_security_issues_use_pstrcat
595 #if !(defined(LIBAVFORMAT_BUILD) || defined(_FRAMEHOOK_H))
596 #define printf please_use_av_log
597 #define fprintf please_use_av_log
598 #endif
599
600 #define CHECKED_ALLOCZ(p, size)\
601 {\
602     p= av_mallocz(size);\
603     if(p==NULL && (size)!=0){\
604         perror("malloc");\
605         goto fail;\
606     }\
607 }
608
609 #ifndef HAVE_LRINTF
610 /* XXX: add ISOC specific test to avoid specific BSD testing. */
611 /* better than nothing implementation. */
612 /* btw, rintf() is existing on fbsd too -- alex */
613 static always_inline long int lrintf(float x)
614 {
615 #ifdef CONFIG_WIN32
616 #  ifdef ARCH_X86
617     int32_t i;
618     asm volatile(
619         "fistpl %0\n\t"
620         : "=m" (i) : "t" (x) : "st"
621     );
622     return i;
623 #  else
624     /* XXX: incorrect, but make it compile */
625     return (int)(x + (x < 0 ? -0.5 : 0.5));
626 #  endif /* ARCH_X86 */
627 #else
628     return (int)(rint(x));
629 #endif /* CONFIG_WIN32 */
630 }
631 #else
632 #ifndef _ISOC9X_SOURCE
633 #define _ISOC9X_SOURCE
634 #endif
635 #include <math.h>
636 #endif /* HAVE_LRINTF */
637
638 #endif /* HAVE_AV_CONFIG_H */
639
640 #endif /* COMMON_H */