As *_static are not deallocated anymore except on program termination
[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  * alternative bitstream reader & writer by Michael Niedermayer <michaelni@gmx.at>
7  *
8  * This file is part of FFmpeg.
9  *
10  * FFmpeg is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * FFmpeg is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with FFmpeg; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
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  * @deprecated. Code which uses ff_realloc_static is broken/misdesigned
40  * and should correctly use static arrays
41  */
42 attribute_deprecated av_alloc_size(2)
43 static void *ff_realloc_static(void *ptr, unsigned int size);
44
45 static void *av_mallocz_static(unsigned int size)
46 {
47     return av_mallocz(size);
48 }
49
50 static void *ff_realloc_static(void *ptr, unsigned int size)
51 {
52     return av_realloc(ptr, size);
53 }
54
55 void align_put_bits(PutBitContext *s)
56 {
57 #ifdef ALT_BITSTREAM_WRITER
58     put_bits(s,(  - s->index) & 7,0);
59 #else
60     put_bits(s,s->bit_left & 7,0);
61 #endif
62 }
63
64 void ff_put_string(PutBitContext * pbc, const char *s, int put_zero)
65 {
66     while(*s){
67         put_bits(pbc, 8, *s);
68         s++;
69     }
70     if(put_zero)
71         put_bits(pbc, 8, 0);
72 }
73
74 void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length)
75 {
76     const uint16_t *srcw= (const uint16_t*)src;
77     int words= length>>4;
78     int bits= length&15;
79     int i;
80
81     if(length==0) return;
82
83     if(ENABLE_SMALL || words < 16 || put_bits_count(pb)&7){
84         for(i=0; i<words; i++) put_bits(pb, 16, be2me_16(srcw[i]));
85     }else{
86         for(i=0; put_bits_count(pb)&31; i++)
87             put_bits(pb, 8, src[i]);
88         flush_put_bits(pb);
89         memcpy(pbBufPtr(pb), src+i, 2*words-i);
90         skip_put_bytes(pb, 2*words-i);
91     }
92
93     put_bits(pb, bits, be2me_16(srcw[words])>>(16-bits));
94 }
95
96 /* VLC decoding */
97
98 //#define DEBUG_VLC
99
100 #define GET_DATA(v, table, i, wrap, size) \
101 {\
102     const uint8_t *ptr = (const uint8_t *)table + i * wrap;\
103     switch(size) {\
104     case 1:\
105         v = *(const uint8_t *)ptr;\
106         break;\
107     case 2:\
108         v = *(const uint16_t *)ptr;\
109         break;\
110     default:\
111         v = *(const uint32_t *)ptr;\
112         break;\
113     }\
114 }
115
116
117 static int alloc_table(VLC *vlc, int size, int use_static)
118 {
119     int index;
120     index = vlc->table_size;
121     vlc->table_size += size;
122     if (vlc->table_size > vlc->table_allocated) {
123         if(use_static>1)
124             abort(); //cant do anything, init_vlc() is used with too little memory
125         vlc->table_allocated += (1 << vlc->bits);
126         if(use_static)
127             vlc->table = ff_realloc_static(vlc->table,
128                                            sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
129         else
130             vlc->table = av_realloc(vlc->table,
131                                     sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
132         if (!vlc->table)
133             return -1;
134     }
135     return index;
136 }
137
138 static int build_table(VLC *vlc, int table_nb_bits,
139                        int nb_codes,
140                        const void *bits, int bits_wrap, int bits_size,
141                        const void *codes, int codes_wrap, int codes_size,
142                        const void *symbols, int symbols_wrap, int symbols_size,
143                        uint32_t code_prefix, int n_prefix, int flags)
144 {
145     int i, j, k, n, table_size, table_index, nb, n1, index, code_prefix2, symbol;
146     uint32_t code;
147     VLC_TYPE (*table)[2];
148
149     table_size = 1 << table_nb_bits;
150     table_index = alloc_table(vlc, table_size, flags & (INIT_VLC_USE_STATIC|INIT_VLC_USE_NEW_STATIC));
151 #ifdef DEBUG_VLC
152     av_log(NULL,AV_LOG_DEBUG,"new table index=%d size=%d code_prefix=%x n=%d\n",
153            table_index, table_size, code_prefix, n_prefix);
154 #endif
155     if (table_index < 0)
156         return -1;
157     table = &vlc->table[table_index];
158
159     for(i=0;i<table_size;i++) {
160         table[i][1] = 0; //bits
161         table[i][0] = -1; //codes
162     }
163
164     /* first pass: map codes and compute auxillary table sizes */
165     for(i=0;i<nb_codes;i++) {
166         GET_DATA(n, bits, i, bits_wrap, bits_size);
167         GET_DATA(code, codes, i, codes_wrap, codes_size);
168         /* we accept tables with holes */
169         if (n <= 0)
170             continue;
171         if (!symbols)
172             symbol = i;
173         else
174             GET_DATA(symbol, symbols, i, symbols_wrap, symbols_size);
175 #if defined(DEBUG_VLC) && 0
176         av_log(NULL,AV_LOG_DEBUG,"i=%d n=%d code=0x%x\n", i, n, code);
177 #endif
178         /* if code matches the prefix, it is in the table */
179         n -= n_prefix;
180         if(flags & INIT_VLC_LE)
181             code_prefix2= code & (n_prefix>=32 ? 0xffffffff : (1 << n_prefix)-1);
182         else
183             code_prefix2= code >> n;
184         if (n > 0 && code_prefix2 == code_prefix) {
185             if (n <= table_nb_bits) {
186                 /* no need to add another table */
187                 j = (code << (table_nb_bits - n)) & (table_size - 1);
188                 nb = 1 << (table_nb_bits - n);
189                 for(k=0;k<nb;k++) {
190                     if(flags & INIT_VLC_LE)
191                         j = (code >> n_prefix) + (k<<n);
192 #ifdef DEBUG_VLC
193                     av_log(NULL, AV_LOG_DEBUG, "%4x: code=%d n=%d\n",
194                            j, i, n);
195 #endif
196                     if (table[j][1] /*bits*/ != 0) {
197                         av_log(NULL, AV_LOG_ERROR, "incorrect codes\n");
198                         return -1;
199                     }
200                     table[j][1] = n; //bits
201                     table[j][0] = symbol;
202                     j++;
203                 }
204             } else {
205                 n -= table_nb_bits;
206                 j = (code >> ((flags & INIT_VLC_LE) ? n_prefix : n)) & ((1 << table_nb_bits) - 1);
207 #ifdef DEBUG_VLC
208                 av_log(NULL,AV_LOG_DEBUG,"%4x: n=%d (subtable)\n",
209                        j, n);
210 #endif
211                 /* compute table size */
212                 n1 = -table[j][1]; //bits
213                 if (n > n1)
214                     n1 = n;
215                 table[j][1] = -n1; //bits
216             }
217         }
218     }
219
220     /* second pass : fill auxillary tables recursively */
221     for(i=0;i<table_size;i++) {
222         n = table[i][1]; //bits
223         if (n < 0) {
224             n = -n;
225             if (n > table_nb_bits) {
226                 n = table_nb_bits;
227                 table[i][1] = -n; //bits
228             }
229             index = build_table(vlc, n, nb_codes,
230                                 bits, bits_wrap, bits_size,
231                                 codes, codes_wrap, codes_size,
232                                 symbols, symbols_wrap, symbols_size,
233                                 (flags & INIT_VLC_LE) ? (code_prefix | (i << n_prefix)) : ((code_prefix << table_nb_bits) | i),
234                                 n_prefix + table_nb_bits, flags);
235             if (index < 0)
236                 return -1;
237             /* note: realloc has been done, so reload tables */
238             table = &vlc->table[table_index];
239             table[i][0] = index; //code
240         }
241     }
242     return table_index;
243 }
244
245
246 /* Build VLC decoding tables suitable for use with get_vlc().
247
248    'nb_bits' set thee decoding table size (2^nb_bits) entries. The
249    bigger it is, the faster is the decoding. But it should not be too
250    big to save memory and L1 cache. '9' is a good compromise.
251
252    'nb_codes' : number of vlcs codes
253
254    'bits' : table which gives the size (in bits) of each vlc code.
255
256    'codes' : table which gives the bit pattern of of each vlc code.
257
258    'symbols' : table which gives the values to be returned from get_vlc().
259
260    'xxx_wrap' : give the number of bytes between each entry of the
261    'bits' or 'codes' tables.
262
263    'xxx_size' : gives the number of bytes of each entry of the 'bits'
264    or 'codes' tables.
265
266    'wrap' and 'size' allows to use any memory configuration and types
267    (byte/word/long) to store the 'bits', 'codes', and 'symbols' tables.
268
269    'use_static' should be set to 1 for tables, which should be freed
270    with av_free_static(), 0 if free_vlc() will be used.
271 */
272 int init_vlc_sparse(VLC *vlc, int nb_bits, int nb_codes,
273              const void *bits, int bits_wrap, int bits_size,
274              const void *codes, int codes_wrap, int codes_size,
275              const void *symbols, int symbols_wrap, int symbols_size,
276              int flags)
277 {
278     vlc->bits = nb_bits;
279     if(flags & INIT_VLC_USE_NEW_STATIC){
280         if(vlc->table_size && vlc->table_size == vlc->table_allocated){
281             return 0;
282         }else if(vlc->table_size){
283             abort(); // fatal error, we are called on a partially initialized table
284         }
285     }else if(!(flags & INIT_VLC_USE_STATIC)) {
286         vlc->table = NULL;
287         vlc->table_allocated = 0;
288         vlc->table_size = 0;
289     } else {
290         /* Static tables are initially always NULL, return
291            if vlc->table != NULL to avoid double allocation */
292         if(vlc->table)
293             return 0;
294     }
295
296 #ifdef DEBUG_VLC
297     av_log(NULL,AV_LOG_DEBUG,"build table nb_codes=%d\n", nb_codes);
298 #endif
299
300     if (build_table(vlc, nb_bits, nb_codes,
301                     bits, bits_wrap, bits_size,
302                     codes, codes_wrap, codes_size,
303                     symbols, symbols_wrap, symbols_size,
304                     0, 0, flags) < 0) {
305         av_freep(&vlc->table);
306         return -1;
307     }
308     if((flags & INIT_VLC_USE_NEW_STATIC) && vlc->table_size != vlc->table_allocated)
309         av_log(NULL, AV_LOG_ERROR, "needed %d had %d\n", vlc->table_size, vlc->table_allocated);
310     return 0;
311 }
312
313
314 void free_vlc(VLC *vlc)
315 {
316     av_freep(&vlc->table);
317 }
318