]> git.sesse.net Git - ffmpeg/blob - libavcodec/common.c
* declare av_free
[ffmpeg] / libavcodec / common.c
1 /*
2  * Common bit i/o utils
3  * Copyright (c) 2000, 2001 Fabrice Bellard.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  *
19  * alternative bitstream reader & writer by Michael Niedermayer <michaelni@gmx.at>
20  */
21 #include "avcodec.h"
22
23 void init_put_bits(PutBitContext *s, 
24                    UINT8 *buffer, int buffer_size,
25                    void *opaque,
26                    void (*write_data)(void *, UINT8 *, int))
27 {
28     s->buf = buffer;
29     s->buf_end = s->buf + buffer_size;
30     s->data_out_size = 0;
31     if(write_data!=NULL) 
32     {
33         fprintf(stderr, "write Data callback is not supported\n");
34     }
35 #ifdef ALT_BITSTREAM_WRITER
36     s->index=0;
37     ((uint32_t*)(s->buf))[0]=0;
38 //    memset(buffer, 0, buffer_size);
39 #else
40     s->buf_ptr = s->buf;
41     s->bit_left=32;
42     s->bit_buf=0;
43 #endif
44 }
45
46 /* return the number of bits output */
47 INT64 get_bit_count(PutBitContext *s)
48 {
49 #ifdef ALT_BITSTREAM_WRITER
50     return s->data_out_size * 8 + s->index;
51 #else
52     return (s->buf_ptr - s->buf + s->data_out_size) * 8 + 32 - (INT64)s->bit_left;
53 #endif
54 }
55
56 void align_put_bits(PutBitContext *s)
57 {
58 #ifdef ALT_BITSTREAM_WRITER
59     put_bits(s,(  - s->index) & 7,0);
60 #else
61     put_bits(s,s->bit_left & 7,0);
62 #endif
63 }
64
65 /* pad the end of the output stream with zeros */
66 void flush_put_bits(PutBitContext *s)
67 {
68 #ifdef ALT_BITSTREAM_WRITER
69     align_put_bits(s);
70 #else
71     s->bit_buf<<= s->bit_left;
72     while (s->bit_left < 32) {
73         /* XXX: should test end of buffer */
74         *s->buf_ptr++=s->bit_buf >> 24;
75         s->bit_buf<<=8;
76         s->bit_left+=8;
77     }
78     s->bit_left=32;
79     s->bit_buf=0;
80 #endif
81 }
82
83 /* pad the end of the output stream with zeros */
84 #ifndef ALT_BITSTREAM_WRITER
85 void jflush_put_bits(PutBitContext *s)
86 {
87     unsigned int b;
88     s->bit_buf<<= s->bit_left;
89     s->bit_buf |= ~1U >> (32 - s->bit_left); /* set all the unused bits to one */
90
91     while (s->bit_left < 32) {
92         b = s->bit_buf >> 24;
93         *s->buf_ptr++ = b;
94         if (b == 0xff)
95             *s->buf_ptr++ = 0;
96         s->bit_buf<<=8;
97         s->bit_left+=8;
98     }
99     s->bit_left=32;
100     s->bit_buf=0;
101 }
102 #else
103 void jflush_put_bits(PutBitContext *s)
104 {
105     int num= (  - s->index) & 7;
106     jput_bits(s, num,0xFF>>(8-num));
107 }
108 #endif
109
110 void put_string(PutBitContext * pbc, char *s)
111 {
112     while(*s){
113         put_bits(pbc, 8, *s);
114         s++;
115     }
116     put_bits(pbc, 8, 0);
117 }
118
119 /* bit input functions */
120
121 void init_get_bits(GetBitContext *s,
122                    UINT8 *buffer, int buffer_size)
123 {
124     s->buffer= buffer;
125     s->size= buffer_size;
126     s->buffer_end= buffer + buffer_size;
127 #ifdef ALT_BITSTREAM_READER
128     s->index=0;
129 #elif defined LIBMPEG2_BITSTREAM_READER
130     s->buffer_ptr = buffer;
131     s->bit_count = 16;
132     s->cache = 0;
133 #elif defined A32_BITSTREAM_READER
134     s->buffer_ptr = (uint32_t*)buffer;
135     s->bit_count = 32;
136     s->cache0 = 0;
137     s->cache1 = 0;
138 #endif
139     {
140         OPEN_READER(re, s)
141         UPDATE_CACHE(re, s)
142 //        UPDATE_CACHE(re, s)
143         CLOSE_READER(re, s)
144     }
145 #ifdef A32_BITSTREAM_READER
146     s->cache1 = 0;
147 #endif
148 }
149
150 void align_get_bits(GetBitContext *s)
151 {
152     int n= (-get_bits_count(s)) & 7;
153     if(n) skip_bits(s, n);
154 }
155
156 int check_marker(GetBitContext *s, char *msg)
157 {
158     int bit= get_bits1(s);
159     if(!bit) printf("Marker bit missing %s\n", msg);
160
161     return bit;
162 }
163
164 /* VLC decoding */
165
166 //#define DEBUG_VLC
167
168 #define GET_DATA(v, table, i, wrap, size) \
169 {\
170     UINT8 *ptr = (UINT8 *)table + i * wrap;\
171     switch(size) {\
172     case 1:\
173         v = *(UINT8 *)ptr;\
174         break;\
175     case 2:\
176         v = *(UINT16 *)ptr;\
177         break;\
178     default:\
179         v = *(UINT32 *)ptr;\
180         break;\
181     }\
182 }
183
184
185 static int alloc_table(VLC *vlc, int size)
186 {
187     int index;
188     index = vlc->table_size;
189     vlc->table_size += size;
190     if (vlc->table_size > vlc->table_allocated) {
191         vlc->table_allocated += (1 << vlc->bits);
192         vlc->table = realloc(vlc->table,
193                              sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
194         if (!vlc->table)
195             return -1;
196     }
197     return index;
198 }
199
200 static int build_table(VLC *vlc, int table_nb_bits,
201                        int nb_codes,
202                        const void *bits, int bits_wrap, int bits_size,
203                        const void *codes, int codes_wrap, int codes_size,
204                        UINT32 code_prefix, int n_prefix)
205 {
206     int i, j, k, n, table_size, table_index, nb, n1, index;
207     UINT32 code;
208     VLC_TYPE (*table)[2];
209
210     table_size = 1 << table_nb_bits;
211     table_index = alloc_table(vlc, table_size);
212 #ifdef DEBUG_VLC
213     printf("new table index=%d size=%d code_prefix=%x n=%d\n",
214            table_index, table_size, code_prefix, n_prefix);
215 #endif
216     if (table_index < 0)
217         return -1;
218     table = &vlc->table[table_index];
219
220     for(i=0;i<table_size;i++) {
221         table[i][1] = 0; //bits
222         table[i][0] = -1; //codes
223     }
224
225     /* first pass: map codes and compute auxillary table sizes */
226     for(i=0;i<nb_codes;i++) {
227         GET_DATA(n, bits, i, bits_wrap, bits_size);
228         GET_DATA(code, codes, i, codes_wrap, codes_size);
229         /* we accept tables with holes */
230         if (n <= 0)
231             continue;
232 #if defined(DEBUG_VLC) && 0
233         printf("i=%d n=%d code=0x%x\n", i, n, code);
234 #endif
235         /* if code matches the prefix, it is in the table */
236         n -= n_prefix;
237         if (n > 0 && (code >> n) == code_prefix) {
238             if (n <= table_nb_bits) {
239                 /* no need to add another table */
240                 j = (code << (table_nb_bits - n)) & (table_size - 1);
241                 nb = 1 << (table_nb_bits - n);
242                 for(k=0;k<nb;k++) {
243 #ifdef DEBUG_VLC
244                     printf("%4x: code=%d n=%d\n",
245                            j, i, n);
246 #endif
247                     if (table[j][1] /*bits*/ != 0) {
248                         fprintf(stderr, "incorrect codes\n");
249                         exit(1);
250                     }
251                     table[j][1] = n; //bits
252                     table[j][0] = i; //code
253                     j++;
254                 }
255             } else {
256                 n -= table_nb_bits;
257                 j = (code >> n) & ((1 << table_nb_bits) - 1);
258 #ifdef DEBUG_VLC
259                 printf("%4x: n=%d (subtable)\n",
260                        j, n);
261 #endif
262                 /* compute table size */
263                 n1 = -table[j][1]; //bits
264                 if (n > n1)
265                     n1 = n;
266                 table[j][1] = -n1; //bits
267             }
268         }
269     }
270
271     /* second pass : fill auxillary tables recursively */
272     for(i=0;i<table_size;i++) {
273         n = table[i][1]; //bits
274         if (n < 0) {
275             n = -n;
276             if (n > table_nb_bits) {
277                 n = table_nb_bits;
278                 table[i][1] = -n; //bits
279             }
280             index = build_table(vlc, n, nb_codes,
281                                 bits, bits_wrap, bits_size,
282                                 codes, codes_wrap, codes_size,
283                                 (code_prefix << table_nb_bits) | i,
284                                 n_prefix + table_nb_bits);
285             if (index < 0)
286                 return -1;
287             /* note: realloc has been done, so reload tables */
288             table = &vlc->table[table_index];
289             table[i][0] = index; //code
290         }
291     }
292     return table_index;
293 }
294
295
296 /* Build VLC decoding tables suitable for use with get_vlc().
297
298    'nb_bits' set thee decoding table size (2^nb_bits) entries. The
299    bigger it is, the faster is the decoding. But it should not be too
300    big to save memory and L1 cache. '9' is a good compromise.
301    
302    'nb_codes' : number of vlcs codes
303
304    'bits' : table which gives the size (in bits) of each vlc code.
305
306    'codes' : table which gives the bit pattern of of each vlc code.
307
308    'xxx_wrap' : give the number of bytes between each entry of the
309    'bits' or 'codes' tables.
310
311    'xxx_size' : gives the number of bytes of each entry of the 'bits'
312    or 'codes' tables.
313
314    'wrap' and 'size' allows to use any memory configuration and types
315    (byte/word/long) to store the 'bits' and 'codes' tables.  
316 */
317 int init_vlc(VLC *vlc, int nb_bits, int nb_codes,
318              const void *bits, int bits_wrap, int bits_size,
319              const void *codes, int codes_wrap, int codes_size)
320 {
321     vlc->bits = nb_bits;
322     vlc->table = NULL;
323     vlc->table_allocated = 0;
324     vlc->table_size = 0;
325 #ifdef DEBUG_VLC
326     printf("build table nb_codes=%d\n", nb_codes);
327 #endif
328
329     if (build_table(vlc, nb_bits, nb_codes,
330                     bits, bits_wrap, bits_size,
331                     codes, codes_wrap, codes_size,
332                     0, 0) < 0) {
333         av_free(vlc->table);
334         return -1;
335     }
336     return 0;
337 }
338
339
340 void free_vlc(VLC *vlc)
341 {
342     av_free(vlc->table);
343 }
344
345 int ff_gcd(int a, int b){
346     if(b) return ff_gcd(b, a%b);
347     else  return a;
348 }