2 byte shorter userdata for mpeg4
[ffmpeg.git] / libavcodec / common.c
1 /*
2  * Common bit i/o utils
3  * Copyright (c) 2000, 2001 Fabrice Bellard.
4  * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
5  *
6  * This library 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 of the License, or (at your option) any later version.
10  *
11  * This library 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 this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * alternative bitstream reader & writer by Michael Niedermayer <michaelni@gmx.at>
21  */
22
23 /**
24  * @file common.c
25  * common internal api.
26  */
27
28 #include "avcodec.h"
29
30 const uint8_t ff_sqrt_tab[128]={
31         0, 1, 1, 1, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5, 5, 5, 5, 5,
32         5, 5, 5, 5, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
33         8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9,
34         9, 9, 9, 9,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,11,11,11,11,11,11,11
35 };
36
37 const uint8_t ff_log2_tab[256]={
38         0,0,1,1,2,2,2,2,3,3,3,3,3,3,3,3,4,4,4,4,4,4,4,4,4,4,4,4,4,4,4,4,
39         5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,
40         6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,
41         6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,
42         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
43         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
44         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
45         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7
46 };
47
48 void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
49 {
50     s->buf = buffer;
51     s->buf_end = s->buf + buffer_size;
52 #ifdef ALT_BITSTREAM_WRITER
53     s->index=0;
54     ((uint32_t*)(s->buf))[0]=0;
55 //    memset(buffer, 0, buffer_size);
56 #else
57     s->buf_ptr = s->buf;
58     s->bit_left=32;
59     s->bit_buf=0;
60 #endif
61 }
62
63 //#ifdef CONFIG_ENCODERS
64 #if 1
65
66 /* return the number of bits output */
67 int put_bits_count(PutBitContext *s)
68 {
69 #ifdef ALT_BITSTREAM_WRITER
70     return s->index;
71 #else
72     return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
73 #endif
74 }
75
76 void align_put_bits(PutBitContext *s)
77 {
78 #ifdef ALT_BITSTREAM_WRITER
79     put_bits(s,(  - s->index) & 7,0);
80 #else
81     put_bits(s,s->bit_left & 7,0);
82 #endif
83 }
84
85 #endif //CONFIG_ENCODERS
86
87 /* pad the end of the output stream with zeros */
88 void flush_put_bits(PutBitContext *s)
89 {
90 #ifdef ALT_BITSTREAM_WRITER
91     align_put_bits(s);
92 #else
93     s->bit_buf<<= s->bit_left;
94     while (s->bit_left < 32) {
95         /* XXX: should test end of buffer */
96         *s->buf_ptr++=s->bit_buf >> 24;
97         s->bit_buf<<=8;
98         s->bit_left+=8;
99     }
100     s->bit_left=32;
101     s->bit_buf=0;
102 #endif
103 }
104
105 #ifdef CONFIG_ENCODERS
106
107 void put_string(PutBitContext * pbc, char *s, int put_zero)
108 {
109     while(*s){
110         put_bits(pbc, 8, *s);
111         s++;
112     }
113     if(put_zero)
114         put_bits(pbc, 8, 0);
115 }
116
117 /* bit input functions */
118
119 #endif //CONFIG_ENCODERS
120
121 /**
122  * init GetBitContext.
123  * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes larger then the actual read bits
124  * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
125  * @param bit_size the size of the buffer in bits
126  */
127 void init_get_bits(GetBitContext *s,
128                    const uint8_t *buffer, int bit_size)
129 {
130     const int buffer_size= (bit_size+7)>>3;
131
132     s->buffer= buffer;
133     s->size_in_bits= bit_size;
134     s->buffer_end= buffer + buffer_size;
135 #ifdef ALT_BITSTREAM_READER
136     s->index=0;
137 #elif defined LIBMPEG2_BITSTREAM_READER
138 #ifdef LIBMPEG2_BITSTREAM_READER_HACK
139   if ((int)buffer&1) {
140      /* word alignment */
141     s->cache = (*buffer++)<<24;
142     s->buffer_ptr = buffer;
143     s->bit_count = 16-8;
144   } else
145 #endif
146   {
147     s->buffer_ptr = buffer;
148     s->bit_count = 16;
149     s->cache = 0;
150   }
151 #elif defined A32_BITSTREAM_READER
152     s->buffer_ptr = (uint32_t*)buffer;
153     s->bit_count = 32;
154     s->cache0 = 0;
155     s->cache1 = 0;
156 #endif
157     {
158         OPEN_READER(re, s)
159         UPDATE_CACHE(re, s)
160         UPDATE_CACHE(re, s)
161         CLOSE_READER(re, s)
162     }
163 #ifdef A32_BITSTREAM_READER
164     s->cache1 = 0;
165 #endif
166 }
167
168 /** 
169  * reads 0-32 bits.
170  */
171 unsigned int get_bits_long(GetBitContext *s, int n){
172     if(n<=17) return get_bits(s, n);
173     else{
174         int ret= get_bits(s, 16) << (n-16);
175         return ret | get_bits(s, n-16);
176     }
177 }
178
179 /** 
180  * shows 0-32 bits.
181  */
182 unsigned int show_bits_long(GetBitContext *s, int n){
183     if(n<=17) return show_bits(s, n);
184     else{
185         GetBitContext gb= *s;
186         int ret= get_bits_long(s, n);
187         *s= gb;
188         return ret;
189     }
190 }
191
192 void align_get_bits(GetBitContext *s)
193 {
194     int n= (-get_bits_count(s)) & 7;
195     if(n) skip_bits(s, n);
196 }
197
198 int check_marker(GetBitContext *s, const char *msg)
199 {
200     int bit= get_bits1(s);
201     if(!bit)
202             av_log(NULL, AV_LOG_INFO, "Marker bit missing %s\n", msg);
203
204     return bit;
205 }
206
207 /* VLC decoding */
208
209 //#define DEBUG_VLC
210
211 #define GET_DATA(v, table, i, wrap, size) \
212 {\
213     const uint8_t *ptr = (const uint8_t *)table + i * wrap;\
214     switch(size) {\
215     case 1:\
216         v = *(const uint8_t *)ptr;\
217         break;\
218     case 2:\
219         v = *(const uint16_t *)ptr;\
220         break;\
221     default:\
222         v = *(const uint32_t *)ptr;\
223         break;\
224     }\
225 }
226
227
228 static int alloc_table(VLC *vlc, int size)
229 {
230     int index;
231     index = vlc->table_size;
232     vlc->table_size += size;
233     if (vlc->table_size > vlc->table_allocated) {
234         vlc->table_allocated += (1 << vlc->bits);
235         vlc->table = av_realloc(vlc->table,
236                                 sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
237         if (!vlc->table)
238             return -1;
239     }
240     return index;
241 }
242
243 static int build_table(VLC *vlc, int table_nb_bits,
244                        int nb_codes,
245                        const void *bits, int bits_wrap, int bits_size,
246                        const void *codes, int codes_wrap, int codes_size,
247                        uint32_t code_prefix, int n_prefix)
248 {
249     int i, j, k, n, table_size, table_index, nb, n1, index;
250     uint32_t code;
251     VLC_TYPE (*table)[2];
252
253     table_size = 1 << table_nb_bits;
254     table_index = alloc_table(vlc, table_size);
255 #ifdef DEBUG_VLC
256     printf("new table index=%d size=%d code_prefix=%x n=%d\n",
257            table_index, table_size, code_prefix, n_prefix);
258 #endif
259     if (table_index < 0)
260         return -1;
261     table = &vlc->table[table_index];
262
263     for(i=0;i<table_size;i++) {
264         table[i][1] = 0; //bits
265         table[i][0] = -1; //codes
266     }
267
268     /* first pass: map codes and compute auxillary table sizes */
269     for(i=0;i<nb_codes;i++) {
270         GET_DATA(n, bits, i, bits_wrap, bits_size);
271         GET_DATA(code, codes, i, codes_wrap, codes_size);
272         /* we accept tables with holes */
273         if (n <= 0)
274             continue;
275 #if defined(DEBUG_VLC) && 0
276         printf("i=%d n=%d code=0x%x\n", i, n, code);
277 #endif
278         /* if code matches the prefix, it is in the table */
279         n -= n_prefix;
280         if (n > 0 && (code >> n) == code_prefix) {
281             if (n <= table_nb_bits) {
282                 /* no need to add another table */
283                 j = (code << (table_nb_bits - n)) & (table_size - 1);
284                 nb = 1 << (table_nb_bits - n);
285                 for(k=0;k<nb;k++) {
286 #ifdef DEBUG_VLC
287                     av_log(NULL, AV_LOG_DEBUG, "%4x: code=%d n=%d\n",
288                            j, i, n);
289 #endif
290                     if (table[j][1] /*bits*/ != 0) {
291                         av_log(NULL, AV_LOG_ERROR, "incorrect codes\n");
292                         av_abort();
293                     }
294                     table[j][1] = n; //bits
295                     table[j][0] = i; //code
296                     j++;
297                 }
298             } else {
299                 n -= table_nb_bits;
300                 j = (code >> n) & ((1 << table_nb_bits) - 1);
301 #ifdef DEBUG_VLC
302                 printf("%4x: n=%d (subtable)\n",
303                        j, n);
304 #endif
305                 /* compute table size */
306                 n1 = -table[j][1]; //bits
307                 if (n > n1)
308                     n1 = n;
309                 table[j][1] = -n1; //bits
310             }
311         }
312     }
313
314     /* second pass : fill auxillary tables recursively */
315     for(i=0;i<table_size;i++) {
316         n = table[i][1]; //bits
317         if (n < 0) {
318             n = -n;
319             if (n > table_nb_bits) {
320                 n = table_nb_bits;
321                 table[i][1] = -n; //bits
322             }
323             index = build_table(vlc, n, nb_codes,
324                                 bits, bits_wrap, bits_size,
325                                 codes, codes_wrap, codes_size,
326                                 (code_prefix << table_nb_bits) | i,
327                                 n_prefix + table_nb_bits);
328             if (index < 0)
329                 return -1;
330             /* note: realloc has been done, so reload tables */
331             table = &vlc->table[table_index];
332             table[i][0] = index; //code
333         }
334     }
335     return table_index;
336 }
337
338
339 /* Build VLC decoding tables suitable for use with get_vlc().
340
341    'nb_bits' set thee decoding table size (2^nb_bits) entries. The
342    bigger it is, the faster is the decoding. But it should not be too
343    big to save memory and L1 cache. '9' is a good compromise.
344    
345    'nb_codes' : number of vlcs codes
346
347    'bits' : table which gives the size (in bits) of each vlc code.
348
349    'codes' : table which gives the bit pattern of of each vlc code.
350
351    'xxx_wrap' : give the number of bytes between each entry of the
352    'bits' or 'codes' tables.
353
354    'xxx_size' : gives the number of bytes of each entry of the 'bits'
355    or 'codes' tables.
356
357    'wrap' and 'size' allows to use any memory configuration and types
358    (byte/word/long) to store the 'bits' and 'codes' tables.  
359 */
360 int init_vlc(VLC *vlc, int nb_bits, int nb_codes,
361              const void *bits, int bits_wrap, int bits_size,
362              const void *codes, int codes_wrap, int codes_size)
363 {
364     vlc->bits = nb_bits;
365     vlc->table = NULL;
366     vlc->table_allocated = 0;
367     vlc->table_size = 0;
368 #ifdef DEBUG_VLC
369     printf("build table nb_codes=%d\n", nb_codes);
370 #endif
371
372     if (build_table(vlc, nb_bits, nb_codes,
373                     bits, bits_wrap, bits_size,
374                     codes, codes_wrap, codes_size,
375                     0, 0) < 0) {
376         av_free(vlc->table);
377         return -1;
378     }
379     return 0;
380 }
381
382
383 void free_vlc(VLC *vlc)
384 {
385     av_free(vlc->table);
386 }
387
388 int64_t ff_gcd(int64_t a, int64_t b){
389     if(b) return ff_gcd(b, a%b);
390     else  return a;
391 }