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