move some functions to bitstream.h to avoid conflicts
[ffmpeg.git] / libavcodec / bitstream.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  *
20  * alternative bitstream reader & writer by Michael Niedermayer <michaelni@gmx.at>
21  */
22
23 /**
24  * @file bitstream.c
25  * bitstream api.
26  */
27
28 #include "avcodec.h"
29 #include "bitstream.h"
30
31 void align_put_bits(PutBitContext *s)
32 {
33 #ifdef ALT_BITSTREAM_WRITER
34     put_bits(s,(  - s->index) & 7,0);
35 #else
36     put_bits(s,s->bit_left & 7,0);
37 #endif
38 }
39
40 void ff_put_string(PutBitContext * pbc, char *s, int put_zero)
41 {
42     while(*s){
43         put_bits(pbc, 8, *s);
44         s++;
45     }
46     if(put_zero)
47         put_bits(pbc, 8, 0);
48 }
49
50 /* VLC decoding */
51
52 //#define DEBUG_VLC
53
54 #define GET_DATA(v, table, i, wrap, size) \
55 {\
56     const uint8_t *ptr = (const uint8_t *)table + i * wrap;\
57     switch(size) {\
58     case 1:\
59         v = *(const uint8_t *)ptr;\
60         break;\
61     case 2:\
62         v = *(const uint16_t *)ptr;\
63         break;\
64     default:\
65         v = *(const uint32_t *)ptr;\
66         break;\
67     }\
68 }
69
70
71 static int alloc_table(VLC *vlc, int size, int use_static)
72 {
73     int index;
74     index = vlc->table_size;
75     vlc->table_size += size;
76     if (vlc->table_size > vlc->table_allocated) {
77         vlc->table_allocated += (1 << vlc->bits);
78         if(use_static)
79             vlc->table = av_realloc_static(vlc->table,
80                                            sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
81         else
82             vlc->table = av_realloc(vlc->table,
83                                     sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
84         if (!vlc->table)
85             return -1;
86     }
87     return index;
88 }
89
90 static int build_table(VLC *vlc, int table_nb_bits,
91                        int nb_codes,
92                        const void *bits, int bits_wrap, int bits_size,
93                        const void *codes, int codes_wrap, int codes_size,
94                        uint32_t code_prefix, int n_prefix, int flags)
95 {
96     int i, j, k, n, table_size, table_index, nb, n1, index, code_prefix2;
97     uint32_t code;
98     VLC_TYPE (*table)[2];
99
100     table_size = 1 << table_nb_bits;
101     table_index = alloc_table(vlc, table_size, flags & INIT_VLC_USE_STATIC);
102 #ifdef DEBUG_VLC
103     printf("new table index=%d size=%d code_prefix=%x n=%d\n",
104            table_index, table_size, code_prefix, n_prefix);
105 #endif
106     if (table_index < 0)
107         return -1;
108     table = &vlc->table[table_index];
109
110     for(i=0;i<table_size;i++) {
111         table[i][1] = 0; //bits
112         table[i][0] = -1; //codes
113     }
114
115     /* first pass: map codes and compute auxillary table sizes */
116     for(i=0;i<nb_codes;i++) {
117         GET_DATA(n, bits, i, bits_wrap, bits_size);
118         GET_DATA(code, codes, i, codes_wrap, codes_size);
119         /* we accept tables with holes */
120         if (n <= 0)
121             continue;
122 #if defined(DEBUG_VLC) && 0
123         printf("i=%d n=%d code=0x%x\n", i, n, code);
124 #endif
125         /* if code matches the prefix, it is in the table */
126         n -= n_prefix;
127         if(flags & INIT_VLC_LE)
128             code_prefix2= code & (n_prefix>=32 ? 0xffffffff : (1 << n_prefix)-1);
129         else
130             code_prefix2= code >> n;
131         if (n > 0 && code_prefix2 == code_prefix) {
132             if (n <= table_nb_bits) {
133                 /* no need to add another table */
134                 j = (code << (table_nb_bits - n)) & (table_size - 1);
135                 nb = 1 << (table_nb_bits - n);
136                 for(k=0;k<nb;k++) {
137                     if(flags & INIT_VLC_LE)
138                         j = (code >> n_prefix) + (k<<n);
139 #ifdef DEBUG_VLC
140                     av_log(NULL, AV_LOG_DEBUG, "%4x: code=%d n=%d\n",
141                            j, i, n);
142 #endif
143                     if (table[j][1] /*bits*/ != 0) {
144                         av_log(NULL, AV_LOG_ERROR, "incorrect codes\n");
145                         return -1;
146                     }
147                     table[j][1] = n; //bits
148                     table[j][0] = i; //code
149                     j++;
150                 }
151             } else {
152                 n -= table_nb_bits;
153                 j = (code >> ((flags & INIT_VLC_LE) ? n_prefix : n)) & ((1 << table_nb_bits) - 1);
154 #ifdef DEBUG_VLC
155                 printf("%4x: n=%d (subtable)\n",
156                        j, n);
157 #endif
158                 /* compute table size */
159                 n1 = -table[j][1]; //bits
160                 if (n > n1)
161                     n1 = n;
162                 table[j][1] = -n1; //bits
163             }
164         }
165     }
166
167     /* second pass : fill auxillary tables recursively */
168     for(i=0;i<table_size;i++) {
169         n = table[i][1]; //bits
170         if (n < 0) {
171             n = -n;
172             if (n > table_nb_bits) {
173                 n = table_nb_bits;
174                 table[i][1] = -n; //bits
175             }
176             index = build_table(vlc, n, nb_codes,
177                                 bits, bits_wrap, bits_size,
178                                 codes, codes_wrap, codes_size,
179                                 (flags & INIT_VLC_LE) ? (code_prefix | (i << n_prefix)) : ((code_prefix << table_nb_bits) | i),
180                                 n_prefix + table_nb_bits, flags);
181             if (index < 0)
182                 return -1;
183             /* note: realloc has been done, so reload tables */
184             table = &vlc->table[table_index];
185             table[i][0] = index; //code
186         }
187     }
188     return table_index;
189 }
190
191
192 /* Build VLC decoding tables suitable for use with get_vlc().
193
194    'nb_bits' set thee decoding table size (2^nb_bits) entries. The
195    bigger it is, the faster is the decoding. But it should not be too
196    big to save memory and L1 cache. '9' is a good compromise.
197
198    'nb_codes' : number of vlcs codes
199
200    'bits' : table which gives the size (in bits) of each vlc code.
201
202    'codes' : table which gives the bit pattern of of each vlc code.
203
204    'xxx_wrap' : give the number of bytes between each entry of the
205    'bits' or 'codes' tables.
206
207    'xxx_size' : gives the number of bytes of each entry of the 'bits'
208    or 'codes' tables.
209
210    'wrap' and 'size' allows to use any memory configuration and types
211    (byte/word/long) to store the 'bits' and 'codes' tables.
212
213    'use_static' should be set to 1 for tables, which should be freed
214    with av_free_static(), 0 if free_vlc() will be used.
215 */
216 int init_vlc(VLC *vlc, int nb_bits, int nb_codes,
217              const void *bits, int bits_wrap, int bits_size,
218              const void *codes, int codes_wrap, int codes_size,
219              int use_static)
220 {
221     vlc->bits = nb_bits;
222     if(!use_static) {
223         vlc->table = NULL;
224         vlc->table_allocated = 0;
225         vlc->table_size = 0;
226     } else {
227         /* Static tables are initially always NULL, return
228            if vlc->table != NULL to avoid double allocation */
229         if(vlc->table)
230             return 0;
231     }
232
233 #ifdef DEBUG_VLC
234     printf("build table nb_codes=%d\n", nb_codes);
235 #endif
236
237     if (build_table(vlc, nb_bits, nb_codes,
238                     bits, bits_wrap, bits_size,
239                     codes, codes_wrap, codes_size,
240                     0, 0, use_static) < 0) {
241         av_free(vlc->table);
242         return -1;
243     }
244     return 0;
245 }
246
247
248 void free_vlc(VLC *vlc)
249 {
250     av_free(vlc->table);
251 }
252