48db2611558591808434af22fe6e3ebeca8b14f6
[ffmpeg.git] / libavcodec / 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 //#define ALT_BITSTREAM_WRITER
14 //#define ALIGNED_BITSTREAM_WRITER
15
16 #define ALT_BITSTREAM_READER
17 //#define LIBMPEG2_BITSTREAM_READER
18 //#define A32_BITSTREAM_READER
19 #define LIBMPEG2_BITSTREAM_READER_HACK //add BERO
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 #    ifndef __BEOS__
29 #        include <errno.h>
30 #    else
31 #        include "berrno.h"
32 #    endif
33 #    include <math.h>
34
35 #    ifndef ENODATA
36 #        define ENODATA  61
37 #    endif
38
39 #ifndef M_PI
40 #define M_PI    3.14159265358979323846
41 #endif
42
43 #include <stddef.h>
44 #ifndef offsetof
45 # define offsetof(T,F) ((unsigned int)((char *)&((T *)0)->F))
46 #endif
47
48 #define AVOPTION_CODEC_BOOL(name, help, field) \
49     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_BOOL }
50 #define AVOPTION_CODEC_DOUBLE(name, help, field, minv, maxv, defval) \
51     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_DOUBLE, minv, maxv, defval }
52 #define AVOPTION_CODEC_FLAG(name, help, field, flag, defval) \
53     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_FLAG, flag, 0, defval }
54 #define AVOPTION_CODEC_INT(name, help, field, minv, maxv, defval) \
55     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_INT, minv, maxv, defval }
56 #define AVOPTION_CODEC_STRING(name, help, field, str, val) \
57     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_STRING, .defval = val, .defstr = str }
58 #define AVOPTION_CODEC_RCOVERRIDE(name, help, field) \
59     { name, help, offsetof(AVCodecContext, field), FF_OPT_TYPE_RCOVERRIDE, .defval = 0, .defstr = NULL }
60 #define AVOPTION_SUB(ptr) { .name = NULL, .help = (const char*)ptr }
61 #define AVOPTION_END() AVOPTION_SUB(NULL)
62
63 struct AVOption;
64 #ifdef HAVE_MMX
65 extern const struct AVOption avoptions_common[3 + 5];
66 #else
67 extern const struct AVOption avoptions_common[3];
68 #endif
69 extern const struct AVOption avoptions_workaround_bug[11];
70
71 #endif /* HAVE_AV_CONFIG_H */
72
73 /* Suppress restrict if it was not defined in config.h.  */
74 #ifndef restrict
75 #    define restrict
76 #endif
77
78 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
79 #    define always_inline __attribute__((always_inline)) inline
80 #else
81 #    define always_inline inline
82 #endif
83
84 #ifdef CONFIG_WIN32
85
86 /* windows */
87
88 typedef unsigned short uint16_t;
89 typedef signed short int16_t;
90 typedef unsigned char uint8_t;
91 typedef unsigned int uint32_t;
92 typedef unsigned __int64 uint64_t;
93 typedef signed char int8_t;
94 typedef signed int int32_t;
95 typedef signed __int64 int64_t;
96
97 #    ifndef __MINGW32__
98 #        define int64_t_C(c)     (c ## i64)
99 #        define uint64_t_C(c)    (c ## i64)
100
101 #        define inline __inline
102
103 #    else
104 #        define int64_t_C(c)     (c ## LL)
105 #        define uint64_t_C(c)    (c ## ULL)
106 #    endif /* __MINGW32__ */
107
108 #    ifdef _DEBUG
109 #        define DEBUG
110 #    endif
111
112 #    define snprintf _snprintf
113 #    define vsnprintf _vsnprintf
114
115 /* CONFIG_WIN32 end */
116 #elif defined (CONFIG_OS2)
117 /* OS/2 EMX */
118
119 #include <inttypes.h>
120
121 #ifndef int64_t_C
122 #define int64_t_C(c)     (c ## LL)
123 #define uint64_t_C(c)    (c ## ULL)
124 #endif
125
126 #ifdef HAVE_AV_CONFIG_H
127
128 #ifdef USE_FASTMEMCPY
129 #include "fastmemcpy.h"
130 #endif
131
132 #include <float.h>
133
134 #endif /* HAVE_AV_CONFIG_H */
135
136 /* CONFIG_OS2 end */
137 #else
138
139 /* unix */
140
141 #include <inttypes.h>
142
143 #ifndef int64_t_C
144 #define int64_t_C(c)     (c ## LL)
145 #define uint64_t_C(c)    (c ## ULL)
146 #endif
147
148 #ifdef HAVE_AV_CONFIG_H
149
150 #        ifdef USE_FASTMEMCPY
151 #            include "fastmemcpy.h"
152 #        endif
153 #    endif /* HAVE_AV_CONFIG_H */
154
155 #endif /* !CONFIG_WIN32 && !CONFIG_OS2 */
156
157 #ifdef HAVE_AV_CONFIG_H
158
159 #    include "bswap.h"
160
161 #    if defined(__MINGW32__) || defined(__CYGWIN__) || \
162         defined(__OS2__) || (defined (__OpenBSD__) && !defined(__ELF__))
163 #        define MANGLE(a) "_" #a
164 #    else
165 #        define MANGLE(a) #a
166 #    endif
167
168 /* debug stuff */
169
170 #    ifndef DEBUG
171 #        define NDEBUG
172 #    endif
173 #    include <assert.h>
174
175 /* dprintf macros */
176 #    if defined(CONFIG_WIN32) && !defined(__MINGW32__)
177
178 inline void dprintf(const char* fmt,...) {}
179
180 #    else
181
182 #        ifdef DEBUG
183 #            define dprintf(fmt,args...) printf(fmt, ## args)
184 #        else
185 #            define dprintf(fmt,args...)
186 #        endif
187
188 #    endif /* !CONFIG_WIN32 */
189
190 #    define av_abort()      do { fprintf(stderr, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
191
192 //rounded divison & shift
193 #define RSHIFT(a,b) ((a) > 0 ? ((a) + (1<<((b)-1)))>>(b) : ((a) + (1<<((b)-1))-1)>>(b))
194 /* assume b>0 */
195 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
196 #define ABS(a) ((a) >= 0 ? (a) : (-(a)))
197
198 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
199 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
200
201 extern const uint32_t inverse[256];
202
203 #ifdef ARCH_X86
204 #    define FASTDIV(a,b) \
205     ({\
206         int ret,dmy;\
207         asm volatile(\
208             "mull %3"\
209             :"=d"(ret),"=a"(dmy)\
210             :"1"(a),"g"(inverse[b])\
211             );\
212         ret;\
213     })
214 #elif defined(CONFIG_FASTDIV)
215 #    define FASTDIV(a,b)   ((uint32_t)((((uint64_t)a)*inverse[b])>>32))
216 #else
217 #    define FASTDIV(a,b)   ((a)/(b))
218 #endif
219  
220 #ifdef ARCH_X86
221 // avoid +32 for shift optimization (gcc should do that ...)
222 static inline  int32_t NEG_SSR32( int32_t a, int8_t s){
223     asm ("sarl %1, %0\n\t"
224          : "+r" (a)
225          : "ic" ((uint8_t)(-s))
226     );
227     return a;
228 }
229 static inline uint32_t NEG_USR32(uint32_t a, int8_t s){
230     asm ("shrl %1, %0\n\t"
231          : "+r" (a)
232          : "ic" ((uint8_t)(-s))
233     );
234     return a;
235 }
236 #else
237 #    define NEG_SSR32(a,s) ((( int32_t)(a))>>(32-(s)))
238 #    define NEG_USR32(a,s) (((uint32_t)(a))>>(32-(s)))
239 #endif
240
241 /* bit output */
242
243 struct PutBitContext;
244
245 typedef void (*WriteDataFunc)(void *, uint8_t *, int);
246
247 typedef struct PutBitContext {
248 #ifdef ALT_BITSTREAM_WRITER
249     uint8_t *buf, *buf_end;
250     int index;
251 #else
252     uint32_t bit_buf;
253     int bit_left;
254     uint8_t *buf, *buf_ptr, *buf_end;
255 #endif
256     int64_t data_out_size; /* in bytes */
257 } PutBitContext;
258
259 void init_put_bits(PutBitContext *s, 
260                    uint8_t *buffer, int buffer_size,
261                    void *opaque,
262                    void (*write_data)(void *, uint8_t *, int));
263
264 int64_t get_bit_count(PutBitContext *s); /* XXX: change function name */
265 void align_put_bits(PutBitContext *s);
266 void flush_put_bits(PutBitContext *s);
267 void put_string(PutBitContext * pbc, char *s);
268
269 /* bit input */
270
271 typedef struct GetBitContext {
272     const uint8_t *buffer, *buffer_end;
273 #ifdef ALT_BITSTREAM_READER
274     int index;
275 #elif defined LIBMPEG2_BITSTREAM_READER
276     uint8_t *buffer_ptr;
277     uint32_t cache;
278     int bit_count;
279 #elif defined A32_BITSTREAM_READER
280     uint32_t *buffer_ptr;
281     uint32_t cache0;
282     uint32_t cache1;
283     int bit_count;
284 #endif
285     int size_in_bits;
286 } GetBitContext;
287
288 static inline int get_bits_count(GetBitContext *s);
289
290 #define VLC_TYPE int16_t
291
292 typedef struct VLC {
293     int bits;
294     VLC_TYPE (*table)[2]; ///< code, bits
295     int table_size, table_allocated;
296 } VLC;
297
298 typedef struct RL_VLC_ELEM {
299     int16_t level;
300     int8_t len;
301     uint8_t run;
302 } RL_VLC_ELEM;
303
304 #ifdef ARCH_SPARC64
305 #define UNALIGNED_STORES_ARE_BAD
306 #endif
307
308 /* used to avoid missaligned exceptions on some archs (alpha, ...) */
309 #ifdef ARCH_X86
310 #    define unaligned32(a) (*(uint32_t*)(a))
311 #else
312 #    ifdef __GNUC__
313 static inline uint32_t unaligned32(const void *v) {
314     struct Unaligned {
315         uint32_t i;
316     } __attribute__((packed));
317
318     return ((const struct Unaligned *) v)->i;
319 }
320 #    elif defined(__DECC)
321 static inline uint32_t unaligned32(const void *v) {
322     return *(const __unaligned uint32_t *) v;
323 }
324 #    else
325 static inline uint32_t unaligned32(const void *v) {
326     return *(const uint32_t *) v;
327 }
328 #    endif
329 #endif //!ARCH_X86
330
331 #ifndef ALT_BITSTREAM_WRITER
332 static inline void put_bits(PutBitContext *s, int n, unsigned int value)
333 {
334     unsigned int bit_buf;
335     int bit_left;
336
337 #ifdef STATS
338     st_out_bit_counts[st_current_index] += n;
339 #endif
340     //    printf("put_bits=%d %x\n", n, value);
341     assert(n == 32 || value < (1U << n));
342     
343     bit_buf = s->bit_buf;
344     bit_left = s->bit_left;
345
346     //    printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
347     /* XXX: optimize */
348     if (n < bit_left) {
349         bit_buf = (bit_buf<<n) | value;
350         bit_left-=n;
351     } else {
352         bit_buf<<=bit_left;
353         bit_buf |= value >> (n - bit_left);
354 #ifdef UNALIGNED_STORES_ARE_BAD
355         if (3 & (int) s->buf_ptr) {
356             s->buf_ptr[0] = bit_buf >> 24;
357             s->buf_ptr[1] = bit_buf >> 16;
358             s->buf_ptr[2] = bit_buf >>  8;
359             s->buf_ptr[3] = bit_buf      ;
360         } else
361 #endif
362         *(uint32_t *)s->buf_ptr = be2me_32(bit_buf);
363         //printf("bitbuf = %08x\n", bit_buf);
364         s->buf_ptr+=4;
365         bit_left+=32 - n;
366         bit_buf = value;
367     }
368
369     s->bit_buf = bit_buf;
370     s->bit_left = bit_left;
371 }
372 #endif
373
374
375 #ifdef ALT_BITSTREAM_WRITER
376 static inline void put_bits(PutBitContext *s, int n, unsigned int value)
377 {
378 #    ifdef ALIGNED_BITSTREAM_WRITER
379 #        ifdef ARCH_X86
380     asm volatile(
381         "movl %0, %%ecx                 \n\t"
382         "xorl %%eax, %%eax              \n\t"
383         "shrdl %%cl, %1, %%eax          \n\t"
384         "shrl %%cl, %1                  \n\t"
385         "movl %0, %%ecx                 \n\t"
386         "shrl $3, %%ecx                 \n\t"
387         "andl $0xFFFFFFFC, %%ecx        \n\t"
388         "bswapl %1                      \n\t"
389         "orl %1, (%2, %%ecx)            \n\t"
390         "bswapl %%eax                   \n\t"
391         "addl %3, %0                    \n\t"
392         "movl %%eax, 4(%2, %%ecx)       \n\t"
393         : "=&r" (s->index), "=&r" (value)
394         : "r" (s->buf), "r" (n), "0" (s->index), "1" (value<<(-n))
395         : "%eax", "%ecx"
396     );
397 #        else
398     int index= s->index;
399     uint32_t *ptr= ((uint32_t *)s->buf)+(index>>5);
400     
401     value<<= 32-n; 
402     
403     ptr[0] |= be2me_32(value>>(index&31));
404     ptr[1]  = be2me_32(value<<(32-(index&31)));
405 //if(n>24) printf("%d %d\n", n, value);
406     index+= n;
407     s->index= index;
408 #        endif
409 #    else //ALIGNED_BITSTREAM_WRITER
410 #        ifdef ARCH_X86
411     asm volatile(
412         "movl $7, %%ecx                 \n\t"
413         "andl %0, %%ecx                 \n\t"
414         "addl %3, %%ecx                 \n\t"
415         "negl %%ecx                     \n\t"
416         "shll %%cl, %1                  \n\t"
417         "bswapl %1                      \n\t"
418         "movl %0, %%ecx                 \n\t"
419         "shrl $3, %%ecx                 \n\t"
420         "orl %1, (%%ecx, %2)            \n\t"
421         "addl %3, %0                    \n\t"
422         "movl $0, 4(%%ecx, %2)          \n\t"
423         : "=&r" (s->index), "=&r" (value)
424         : "r" (s->buf), "r" (n), "0" (s->index), "1" (value)
425         : "%ecx"
426     );
427 #        else
428     int index= s->index;
429     uint32_t *ptr= (uint32_t*)(((uint8_t *)s->buf)+(index>>3));
430     
431     ptr[0] |= be2me_32(value<<(32-n-(index&7) ));
432     ptr[1] = 0;
433 //if(n>24) printf("%d %d\n", n, value);
434     index+= n;
435     s->index= index;
436 #        endif
437 #    endif //!ALIGNED_BITSTREAM_WRITER
438 }
439 #endif
440
441
442 static inline uint8_t* pbBufPtr(PutBitContext *s)
443 {
444 #ifdef ALT_BITSTREAM_WRITER
445         return s->buf + (s->index>>3);
446 #else
447         return s->buf_ptr;
448 #endif
449 }
450
451 /* Bitstream reader API docs:
452 name
453     abritary name which is used as prefix for the internal variables
454
455 gb
456     getbitcontext
457
458 OPEN_READER(name, gb)
459     loads gb into local variables
460
461 CLOSE_READER(name, gb)
462     stores local vars in gb
463
464 UPDATE_CACHE(name, gb)
465     refills the internal cache from the bitstream
466     after this call at least MIN_CACHE_BITS will be available,
467
468 GET_CACHE(name, gb)
469     will output the contents of the internal cache, next bit is MSB of 32 or 64 bit (FIXME 64bit)
470
471 SHOW_UBITS(name, gb, num)
472     will return the nest num bits
473
474 SHOW_SBITS(name, gb, num)
475     will return the nest num bits and do sign extension
476
477 SKIP_BITS(name, gb, num)
478     will skip over the next num bits
479     note, this is equinvalent to SKIP_CACHE; SKIP_COUNTER
480
481 SKIP_CACHE(name, gb, num)
482     will remove the next num bits from the cache (note SKIP_COUNTER MUST be called before UPDATE_CACHE / CLOSE_READER)
483
484 SKIP_COUNTER(name, gb, num)
485     will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS)
486
487 LAST_SKIP_CACHE(name, gb, num)
488     will remove the next num bits from the cache if it is needed for UPDATE_CACHE otherwise it will do nothing
489
490 LAST_SKIP_BITS(name, gb, num)
491     is equinvalent to SKIP_LAST_CACHE; SKIP_COUNTER
492
493 for examples see get_bits, show_bits, skip_bits, get_vlc
494 */
495
496 static inline int unaligned32_be(const void *v)
497 {
498 #ifdef CONFIG_ALIGN
499         const uint8_t *p=v;
500         return (((p[0]<<8) | p[1])<<16) | (p[2]<<8) | (p[3]);
501 #else
502         return be2me_32( unaligned32(v)); //original
503 #endif
504 }
505
506 #ifdef ALT_BITSTREAM_READER
507 #   define MIN_CACHE_BITS 25
508
509 #   define OPEN_READER(name, gb)\
510         int name##_index= (gb)->index;\
511         int name##_cache= 0;\
512
513 #   define CLOSE_READER(name, gb)\
514         (gb)->index= name##_index;\
515
516 #   define UPDATE_CACHE(name, gb)\
517         name##_cache= unaligned32_be( ((uint8_t *)(gb)->buffer)+(name##_index>>3) ) << (name##_index&0x07);\
518
519 #   define SKIP_CACHE(name, gb, num)\
520         name##_cache <<= (num);\
521
522 // FIXME name?
523 #   define SKIP_COUNTER(name, gb, num)\
524         name##_index += (num);\
525
526 #   define SKIP_BITS(name, gb, num)\
527         {\
528             SKIP_CACHE(name, gb, num)\
529             SKIP_COUNTER(name, gb, num)\
530         }\
531
532 #   define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
533 #   define LAST_SKIP_CACHE(name, gb, num) ;
534
535 #   define SHOW_UBITS(name, gb, num)\
536         NEG_USR32(name##_cache, num)
537
538 #   define SHOW_SBITS(name, gb, num)\
539         NEG_SSR32(name##_cache, num)
540
541 #   define GET_CACHE(name, gb)\
542         ((uint32_t)name##_cache)
543
544 static inline int get_bits_count(GetBitContext *s){
545     return s->index;
546 }
547 #elif defined LIBMPEG2_BITSTREAM_READER
548 //libmpeg2 like reader
549
550 #   define MIN_CACHE_BITS 17
551
552 #   define OPEN_READER(name, gb)\
553         int name##_bit_count=(gb)->bit_count;\
554         int name##_cache= (gb)->cache;\
555         uint8_t * name##_buffer_ptr=(gb)->buffer_ptr;\
556
557 #   define CLOSE_READER(name, gb)\
558         (gb)->bit_count= name##_bit_count;\
559         (gb)->cache= name##_cache;\
560         (gb)->buffer_ptr= name##_buffer_ptr;\
561
562 #ifdef LIBMPEG2_BITSTREAM_READER_HACK
563
564 #   define UPDATE_CACHE(name, gb)\
565     if(name##_bit_count >= 0){\
566         name##_cache+= (int)be2me_16(*(uint16_t*)name##_buffer_ptr) << name##_bit_count;\
567         ((uint16_t*)name##_buffer_ptr)++;\
568         name##_bit_count-= 16;\
569     }\
570
571 #else
572
573 #   define UPDATE_CACHE(name, gb)\
574     if(name##_bit_count >= 0){\
575         name##_cache+= ((name##_buffer_ptr[0]<<8) + name##_buffer_ptr[1]) << name##_bit_count;\
576         name##_buffer_ptr+=2;\
577         name##_bit_count-= 16;\
578     }\
579
580 #endif
581
582 #   define SKIP_CACHE(name, gb, num)\
583         name##_cache <<= (num);\
584
585 #   define SKIP_COUNTER(name, gb, num)\
586         name##_bit_count += (num);\
587
588 #   define SKIP_BITS(name, gb, num)\
589         {\
590             SKIP_CACHE(name, gb, num)\
591             SKIP_COUNTER(name, gb, num)\
592         }\
593
594 #   define LAST_SKIP_BITS(name, gb, num) SKIP_BITS(name, gb, num)
595 #   define LAST_SKIP_CACHE(name, gb, num) SKIP_CACHE(name, gb, num)
596
597 #   define SHOW_UBITS(name, gb, num)\
598         NEG_USR32(name##_cache, num)
599
600 #   define SHOW_SBITS(name, gb, num)\
601         NEG_SSR32(name##_cache, num)
602
603 #   define GET_CACHE(name, gb)\
604         ((uint32_t)name##_cache)
605
606 static inline int get_bits_count(GetBitContext *s){
607     return (s->buffer_ptr - s->buffer)*8 - 16 + s->bit_count;
608 }
609
610 #elif defined A32_BITSTREAM_READER
611
612 #   define MIN_CACHE_BITS 32
613
614 #   define OPEN_READER(name, gb)\
615         int name##_bit_count=(gb)->bit_count;\
616         uint32_t name##_cache0= (gb)->cache0;\
617         uint32_t name##_cache1= (gb)->cache1;\
618         uint32_t * name##_buffer_ptr=(gb)->buffer_ptr;\
619
620 #   define CLOSE_READER(name, gb)\
621         (gb)->bit_count= name##_bit_count;\
622         (gb)->cache0= name##_cache0;\
623         (gb)->cache1= name##_cache1;\
624         (gb)->buffer_ptr= name##_buffer_ptr;\
625
626 #   define UPDATE_CACHE(name, gb)\
627     if(name##_bit_count > 0){\
628         const uint32_t next= be2me_32( *name##_buffer_ptr );\
629         name##_cache0 |= NEG_USR32(next,name##_bit_count);\
630         name##_cache1 |= next<<name##_bit_count;\
631         name##_buffer_ptr++;\
632         name##_bit_count-= 32;\
633     }\
634
635 #ifdef ARCH_X86
636 #   define SKIP_CACHE(name, gb, num)\
637         asm(\
638             "shldl %2, %1, %0           \n\t"\
639             "shll %2, %1                \n\t"\
640             : "+r" (name##_cache0), "+r" (name##_cache1)\
641             : "Ic" ((uint8_t)num)\
642            );
643 #else
644 #   define SKIP_CACHE(name, gb, num)\
645         name##_cache0 <<= (num);\
646         name##_cache0 |= NEG_USR32(name##_cache1,num);\
647         name##_cache1 <<= (num);
648 #endif
649
650 #   define SKIP_COUNTER(name, gb, num)\
651         name##_bit_count += (num);\
652
653 #   define SKIP_BITS(name, gb, num)\
654         {\
655             SKIP_CACHE(name, gb, num)\
656             SKIP_COUNTER(name, gb, num)\
657         }\
658
659 #   define LAST_SKIP_BITS(name, gb, num) SKIP_BITS(name, gb, num)
660 #   define LAST_SKIP_CACHE(name, gb, num) SKIP_CACHE(name, gb, num)
661
662 #   define SHOW_UBITS(name, gb, num)\
663         NEG_USR32(name##_cache0, num)
664
665 #   define SHOW_SBITS(name, gb, num)\
666         NEG_SSR32(name##_cache0, num)
667
668 #   define GET_CACHE(name, gb)\
669         (name##_cache0)
670
671 static inline int get_bits_count(GetBitContext *s){
672     return ((uint8_t*)s->buffer_ptr - s->buffer)*8 - 32 + s->bit_count;
673 }
674
675 #endif
676
677 /**
678  * read mpeg1 dc style vlc (sign bit + mantisse with no MSB).
679  * if MSB not set it is negative 
680  * @param n length in bits
681  * @author BERO  
682  */
683 static inline int get_xbits(GetBitContext *s, int n){
684     register int tmp;
685     register int32_t cache;
686     OPEN_READER(re, s)
687     UPDATE_CACHE(re, s)
688     cache = GET_CACHE(re,s);
689     if ((int32_t)cache<0) { //MSB=1
690         tmp = NEG_USR32(cache,n);
691     } else {
692     //   tmp = (-1<<n) | NEG_USR32(cache,n) + 1; mpeg12.c algo
693     //   tmp = - (NEG_USR32(cache,n) ^ ((1 << n) - 1)); h263.c algo
694         tmp = - NEG_USR32(~cache,n);
695     }
696     LAST_SKIP_BITS(re, s, n)
697     CLOSE_READER(re, s)
698     return tmp;
699 }
700
701 static inline int get_sbits(GetBitContext *s, int n){
702     register int tmp;
703     OPEN_READER(re, s)
704     UPDATE_CACHE(re, s)
705     tmp= SHOW_SBITS(re, s, n);
706     LAST_SKIP_BITS(re, s, n)
707     CLOSE_READER(re, s)
708     return tmp;
709 }
710
711 /**
712  * reads 0-17 bits.
713  * Note, the alt bitstream reader can read upto 25 bits, but the libmpeg2 reader cant
714  */
715 static inline unsigned int get_bits(GetBitContext *s, int n){
716     register int tmp;
717     OPEN_READER(re, s)
718     UPDATE_CACHE(re, s)
719     tmp= SHOW_UBITS(re, s, n);
720     LAST_SKIP_BITS(re, s, n)
721     CLOSE_READER(re, s)
722     return tmp;
723 }
724
725 unsigned int get_bits_long(GetBitContext *s, int n);
726
727 /**
728  * shows 0-17 bits.
729  * Note, the alt bitstream reader can read upto 25 bits, but the libmpeg2 reader cant
730  */
731 static inline unsigned int show_bits(GetBitContext *s, int n){
732     register int tmp;
733     OPEN_READER(re, s)
734     UPDATE_CACHE(re, s)
735     tmp= SHOW_UBITS(re, s, n);
736 //    CLOSE_READER(re, s)
737     return tmp;
738 }
739
740 unsigned int show_bits_long(GetBitContext *s, int n);
741
742 static inline void skip_bits(GetBitContext *s, int n){
743  //Note gcc seems to optimize this to s->index+=n for the ALT_READER :))
744     OPEN_READER(re, s)
745     UPDATE_CACHE(re, s)
746     LAST_SKIP_BITS(re, s, n)
747     CLOSE_READER(re, s)
748 }
749
750 static inline unsigned int get_bits1(GetBitContext *s){
751 #ifdef ALT_BITSTREAM_READER
752     int index= s->index;
753     uint8_t result= s->buffer[ index>>3 ];
754     result<<= (index&0x07);
755     result>>= 8 - 1;
756     index++;
757     s->index= index;
758
759     return result;
760 #else
761     return get_bits(s, 1);
762 #endif
763 }
764
765 static inline unsigned int show_bits1(GetBitContext *s){
766     return show_bits(s, 1);
767 }
768
769 static inline void skip_bits1(GetBitContext *s){
770     skip_bits(s, 1);
771 }
772
773 void init_get_bits(GetBitContext *s,
774                    const uint8_t *buffer, int buffer_size);
775
776 int check_marker(GetBitContext *s, const char *msg);
777 void align_get_bits(GetBitContext *s);
778 int init_vlc(VLC *vlc, int nb_bits, int nb_codes,
779              const void *bits, int bits_wrap, int bits_size,
780              const void *codes, int codes_wrap, int codes_size);
781 void free_vlc(VLC *vlc);
782
783 /**
784  *
785  * if the vlc code is invalid and max_depth=1 than no bits will be removed
786  * if the vlc code is invalid and max_depth>1 than the number of bits removed
787  * is undefined
788  */
789 #define GET_VLC(code, name, gb, table, bits, max_depth)\
790 {\
791     int n, index, nb_bits;\
792 \
793     index= SHOW_UBITS(name, gb, bits);\
794     code = table[index][0];\
795     n    = table[index][1];\
796 \
797     if(max_depth > 1 && n < 0){\
798         LAST_SKIP_BITS(name, gb, bits)\
799         UPDATE_CACHE(name, gb)\
800 \
801         nb_bits = -n;\
802 \
803         index= SHOW_UBITS(name, gb, nb_bits) + code;\
804         code = table[index][0];\
805         n    = table[index][1];\
806         if(max_depth > 2 && n < 0){\
807             LAST_SKIP_BITS(name, gb, nb_bits)\
808             UPDATE_CACHE(name, gb)\
809 \
810             nb_bits = -n;\
811 \
812             index= SHOW_UBITS(name, gb, nb_bits) + code;\
813             code = table[index][0];\
814             n    = table[index][1];\
815         }\
816     }\
817     SKIP_BITS(name, gb, n)\
818 }
819
820 #define GET_RL_VLC(level, run, name, gb, table, bits, max_depth)\
821 {\
822     int n, index, nb_bits;\
823 \
824     index= SHOW_UBITS(name, gb, bits);\
825     level = table[index].level;\
826     n     = table[index].len;\
827 \
828     if(max_depth > 1 && n < 0){\
829         LAST_SKIP_BITS(name, gb, bits)\
830         UPDATE_CACHE(name, gb)\
831 \
832         nb_bits = -n;\
833 \
834         index= SHOW_UBITS(name, gb, nb_bits) + level;\
835         level = table[index].level;\
836         n     = table[index].len;\
837     }\
838     run= table[index].run;\
839     SKIP_BITS(name, gb, n)\
840 }
841
842 // deprecated, dont use get_vlc for new code, use get_vlc2 instead or use GET_VLC directly
843 static inline int get_vlc(GetBitContext *s, VLC *vlc)
844 {
845     int code;
846     VLC_TYPE (*table)[2]= vlc->table;
847     
848     OPEN_READER(re, s)
849     UPDATE_CACHE(re, s)
850
851     GET_VLC(code, re, s, table, vlc->bits, 3)    
852
853     CLOSE_READER(re, s)
854     return code;
855 }
856
857 /**
858  * parses a vlc code, faster then get_vlc()
859  * @param bits is the number of bits which will be read at once, must be 
860  *             identical to nb_bits in init_vlc()
861  * @param max_depth is the number of times bits bits must be readed to completly
862  *                  read the longest vlc code 
863  *                  = (max_vlc_length + bits - 1) / bits
864  */
865 static always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
866                                   int bits, int max_depth)
867 {
868     int code;
869     
870     OPEN_READER(re, s)
871     UPDATE_CACHE(re, s)
872
873     GET_VLC(code, re, s, table, bits, max_depth)
874
875     CLOSE_READER(re, s)
876     return code;
877 }
878
879 //#define TRACE
880
881 #ifdef TRACE
882
883 static inline void print_bin(int bits, int n){
884     int i;
885     
886     for(i=n-1; i>=0; i--){
887         printf("%d", (bits>>i)&1);
888     }
889     for(i=n; i<24; i++)
890         printf(" ");
891 }
892
893 static inline int get_bits_trace(GetBitContext *s, int n, char *file, char *func, int line){
894     int r= get_bits(s, n);
895     
896     print_bin(r, n);
897     printf("%5d %2d %3d bit @%5d in %s %s:%d\n", r, n, r, get_bits_count(s)-n, file, func, line);
898     return r;
899 }
900 static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2], int bits, int max_depth, char *file, char *func, int line){
901     int show= show_bits(s, 24);
902     int pos= get_bits_count(s);
903     int r= get_vlc2(s, table, bits, max_depth);
904     int len= get_bits_count(s) - pos;
905     int bits2= show>>(24-len);
906     
907     print_bin(bits2, len);
908     
909     printf("%5d %2d %3d vlc @%5d in %s %s:%d\n", bits2, len, r, pos, file, func, line);
910     return r;
911 }
912 static inline int get_xbits_trace(GetBitContext *s, int n, char *file, char *func, int line){
913     int show= show_bits(s, n);
914     int r= get_xbits(s, n);
915     
916     print_bin(show, n);
917     printf("%5d %2d %3d xbt @%5d in %s %s:%d\n", show, n, r, get_bits_count(s)-n, file, func, line);
918     return r;
919 }
920
921 #define get_bits(s, n)  get_bits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
922 #define get_bits1(s)    get_bits_trace(s, 1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
923 #define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
924 #define get_vlc(s, vlc)            get_vlc_trace(s, (vlc)->table, (vlc)->bits, 3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
925 #define get_vlc2(s, tab, bits, max) get_vlc_trace(s, tab, bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)
926
927 #define tprintf printf
928
929 #else //TRACE
930 #define tprintf(_arg...) {}
931 #endif
932
933 /* define it to include statistics code (useful only for optimizing
934    codec efficiency */
935 //#define STATS
936
937 #ifdef STATS
938
939 enum {
940     ST_UNKNOWN,
941     ST_DC,
942     ST_INTRA_AC,
943     ST_INTER_AC,
944     ST_INTRA_MB,
945     ST_INTER_MB,
946     ST_MV,
947     ST_NB,
948 };
949
950 extern int st_current_index;
951 extern unsigned int st_bit_counts[ST_NB];
952 extern unsigned int st_out_bit_counts[ST_NB];
953
954 void print_stats(void);
955 #endif
956
957 /* misc math functions */
958 extern const uint8_t ff_log2_tab[256];
959
960 static inline int av_log2(unsigned int v)
961 {
962     int n;
963
964     n = 0;
965     if (v & 0xffff0000) {
966         v >>= 16;
967         n += 16;
968     }
969     if (v & 0xff00) {
970         v >>= 8;
971         n += 8;
972     }
973     n += ff_log2_tab[v];
974
975     return n;
976 }
977
978 static inline int av_log2_16bit(unsigned int v)
979 {
980     int n;
981
982     n = 0;
983     if (v & 0xff00) {
984         v >>= 8;
985         n += 8;
986     }
987     n += ff_log2_tab[v];
988
989     return n;
990 }
991
992
993 /* median of 3 */
994 static inline int mid_pred(int a, int b, int c)
995 {
996     int vmin, vmax;
997     vmax = vmin = a;
998     if (b < vmin)
999         vmin = b;
1000     else
1001         vmax = b;
1002
1003     if (c < vmin)
1004         vmin = c;
1005     else if (c > vmax)
1006         vmax = c;
1007
1008     return a + b + c - vmin - vmax;
1009 }
1010
1011 static inline int clip(int a, int amin, int amax)
1012 {
1013     if (a < amin)
1014         return amin;
1015     else if (a > amax)
1016         return amax;
1017     else
1018         return a;
1019 }
1020
1021 /* math */
1022 extern const uint8_t ff_sqrt_tab[128];
1023
1024 int64_t ff_gcd(int64_t a, int64_t b);
1025
1026 static inline int ff_sqrt(int a)
1027 {
1028     int ret=0;
1029     int s;
1030     int ret_sq=0;
1031     
1032     if(a<128) return ff_sqrt_tab[a];
1033     
1034     for(s=15; s>=0; s--){
1035         int b= ret_sq + (1<<(s*2)) + (ret<<s)*2;
1036         if(b<=a){
1037             ret_sq=b;
1038             ret+= 1<<s;
1039         }
1040     }
1041     return ret;
1042 }
1043
1044 /**
1045  * converts fourcc string to int
1046  */
1047 static inline int ff_get_fourcc(const char *s){
1048     assert( strlen(s)==4 );
1049
1050     return (s[0]) + (s[1]<<8) + (s[2]<<16) + (s[3]<<24);
1051 }
1052
1053 #define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
1054 #define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
1055
1056
1057 void ff_float2fraction(int *nom_arg, int *denom_arg, double f, int max);
1058
1059
1060 #ifdef ARCH_X86
1061 #define MASK_ABS(mask, level)\
1062             asm volatile(\
1063                 "cdq                    \n\t"\
1064                 "xorl %1, %0            \n\t"\
1065                 "subl %1, %0            \n\t"\
1066                 : "+a" (level), "=&d" (mask)\
1067             );
1068 #else
1069 #define MASK_ABS(mask, level)\
1070             mask= level>>31;\
1071             level= (level^mask)-mask;
1072 #endif
1073
1074
1075 #if __CPU__ >= 686 && !defined(RUNTIME_CPUDETECT)
1076 #define COPY3_IF_LT(x,y,a,b,c,d)\
1077 asm volatile (\
1078     "cmpl %0, %3        \n\t"\
1079     "cmovl %3, %0       \n\t"\
1080     "cmovl %4, %1       \n\t"\
1081     "cmovl %5, %2       \n\t"\
1082     : "+r" (x), "+r" (a), "+r" (c)\
1083     : "r" (y), "r" (b), "r" (d)\
1084 );
1085 #else
1086 #define COPY3_IF_LT(x,y,a,b,c,d)\
1087 if((y)<(x)){\
1088      (x)=(y);\
1089      (a)=(b);\
1090      (c)=(d);\
1091 }
1092 #endif
1093
1094 #ifdef ARCH_X86
1095 static inline long long rdtsc()
1096 {
1097         long long l;
1098         asm volatile(   "rdtsc\n\t"
1099                 : "=A" (l)
1100         );
1101         return l;
1102 }
1103
1104 #define START_TIMER \
1105 static uint64_t tsum=0;\
1106 static int tcount=0;\
1107 static int tskip_count=0;\
1108 uint64_t tend;\
1109 uint64_t tstart= rdtsc();\
1110
1111 #define STOP_TIMER(id) \
1112 tend= rdtsc();\
1113 if(tcount<2 || tend - tstart < 4*tsum/tcount){\
1114     tsum+= tend - tstart;\
1115     tcount++;\
1116 }else\
1117     tskip_count++;\
1118 if(256*256*256*64%(tcount+tskip_count)==0){\
1119     fprintf(stderr, "%Ld dezicycles in %s, %d runs, %d skips\n", tsum*10/tcount, id, tcount, tskip_count);\
1120 }
1121 #endif
1122
1123 #define CLAMP_TO_8BIT(d) ((d > 0xff) ? 0xff : (d < 0) ? 0 : d)
1124
1125 /* avoid usage of various functions */
1126 #define malloc please_use_av_malloc
1127 #define free please_use_av_free
1128 #define realloc please_use_av_realloc
1129
1130 #define CHECKED_ALLOCZ(p, size)\
1131 {\
1132     p= av_mallocz(size);\
1133     if(p==NULL && (size)!=0){\
1134         perror("malloc");\
1135         goto fail;\
1136     }\
1137 }
1138
1139 #endif /* HAVE_AV_CONFIG_H */
1140
1141 #endif /* COMMON_H */