Add assert that the avcodec lock is held when initializing static VLC tables.
[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  * Copyright (c) 2010 Loren Merritt
6  *
7  * alternative bitstream reader & writer by Michael Niedermayer <michaelni@gmx.at>
8  *
9  * This file is part of FFmpeg.
10  *
11  * FFmpeg is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * FFmpeg is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with FFmpeg; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24  */
25
26 /**
27  * @file
28  * bitstream api.
29  */
30
31 #include "libavutil/avassert.h"
32 #include "avcodec.h"
33 #include "internal.h"
34 #include "mathops.h"
35 #include "get_bits.h"
36 #include "put_bits.h"
37
38 const uint8_t ff_log2_run[41]={
39  0, 0, 0, 0, 1, 1, 1, 1,
40  2, 2, 2, 2, 3, 3, 3, 3,
41  4, 4, 5, 5, 6, 6, 7, 7,
42  8, 9,10,11,12,13,14,15,
43 16,17,18,19,20,21,22,23,
44 24,
45 };
46
47 void avpriv_align_put_bits(PutBitContext *s)
48 {
49     put_bits(s,s->bit_left & 7,0);
50 }
51
52 void avpriv_put_string(PutBitContext *pb, const char *string, int terminate_string)
53 {
54     while(*string){
55         put_bits(pb, 8, *string);
56         string++;
57     }
58     if(terminate_string)
59         put_bits(pb, 8, 0);
60 }
61
62 void avpriv_copy_bits(PutBitContext *pb, const uint8_t *src, int length)
63 {
64     int words= length>>4;
65     int bits= length&15;
66     int i;
67
68     if(length==0) return;
69
70     if(CONFIG_SMALL || words < 16 || put_bits_count(pb)&7){
71         for(i=0; i<words; i++) put_bits(pb, 16, AV_RB16(src + 2*i));
72     }else{
73         for(i=0; put_bits_count(pb)&31; i++)
74             put_bits(pb, 8, src[i]);
75         flush_put_bits(pb);
76         memcpy(put_bits_ptr(pb), src+i, 2*words-i);
77         skip_put_bytes(pb, 2*words-i);
78     }
79
80     put_bits(pb, bits, AV_RB16(src + 2*words)>>(16-bits));
81 }
82
83 /* VLC decoding */
84
85 #define GET_DATA(v, table, i, wrap, size) \
86 {\
87     const uint8_t *ptr = (const uint8_t *)table + i * wrap;\
88     switch(size) {\
89     case 1:\
90         v = *(const uint8_t *)ptr;\
91         break;\
92     case 2:\
93         v = *(const uint16_t *)ptr;\
94         break;\
95     default:\
96         v = *(const uint32_t *)ptr;\
97         break;\
98     }\
99 }
100
101
102 static int alloc_table(VLC *vlc, int size, int use_static)
103 {
104     int index;
105     index = vlc->table_size;
106     vlc->table_size += size;
107     if (vlc->table_size > vlc->table_allocated) {
108         if(use_static)
109             abort(); // cannot do anything, init_vlc() is used with too little memory
110         vlc->table_allocated += (1 << vlc->bits);
111         vlc->table = av_realloc_f(vlc->table,
112                                   vlc->table_allocated, sizeof(VLC_TYPE) * 2);
113         if (!vlc->table)
114             return -1;
115     }
116     return index;
117 }
118
119 static av_always_inline uint32_t bitswap_32(uint32_t x) {
120     return (uint32_t)ff_reverse[x&0xFF]<<24
121          | (uint32_t)ff_reverse[(x>>8)&0xFF]<<16
122          | (uint32_t)ff_reverse[(x>>16)&0xFF]<<8
123          | (uint32_t)ff_reverse[x>>24];
124 }
125
126 typedef struct {
127     uint8_t bits;
128     uint16_t symbol;
129     /** codeword, with the first bit-to-be-read in the msb
130      * (even if intended for a little-endian bitstream reader) */
131     uint32_t code;
132 } VLCcode;
133
134 static int compare_vlcspec(const void *a, const void *b)
135 {
136     const VLCcode *sa=a, *sb=b;
137     return (sa->code >> 1) - (sb->code >> 1);
138 }
139
140 /**
141  * Build VLC decoding tables suitable for use with get_vlc().
142  *
143  * @param vlc            the context to be initted
144  *
145  * @param table_nb_bits  max length of vlc codes to store directly in this table
146  *                       (Longer codes are delegated to subtables.)
147  *
148  * @param nb_codes       number of elements in codes[]
149  *
150  * @param codes          descriptions of the vlc codes
151  *                       These must be ordered such that codes going into the same subtable are contiguous.
152  *                       Sorting by VLCcode.code is sufficient, though not necessary.
153  */
154 static int build_table(VLC *vlc, int table_nb_bits, int nb_codes,
155                        VLCcode *codes, int flags)
156 {
157     int table_size, table_index, index, code_prefix, symbol, subtable_bits;
158     int i, j, k, n, nb, inc;
159     uint32_t code;
160     VLC_TYPE (*table)[2];
161
162     table_size = 1 << table_nb_bits;
163     if (table_nb_bits > 30)
164        return -1;
165     table_index = alloc_table(vlc, table_size, flags & INIT_VLC_USE_NEW_STATIC);
166     av_dlog(NULL, "new table index=%d size=%d\n", table_index, table_size);
167     if (table_index < 0)
168         return -1;
169     table = &vlc->table[table_index];
170
171     for (i = 0; i < table_size; i++) {
172         table[i][1] = 0; //bits
173         table[i][0] = -1; //codes
174     }
175
176     /* first pass: map codes and compute auxillary table sizes */
177     for (i = 0; i < nb_codes; i++) {
178         n = codes[i].bits;
179         code = codes[i].code;
180         symbol = codes[i].symbol;
181         av_dlog(NULL, "i=%d n=%d code=0x%x\n", i, n, code);
182         if (n <= table_nb_bits) {
183             /* no need to add another table */
184             j = code >> (32 - table_nb_bits);
185             nb = 1 << (table_nb_bits - n);
186             inc = 1;
187             if (flags & INIT_VLC_LE) {
188                 j = bitswap_32(code);
189                 inc = 1 << n;
190             }
191             for (k = 0; k < nb; k++) {
192                 av_dlog(NULL, "%4x: code=%d n=%d\n", j, i, n);
193                 if (table[j][1] /*bits*/ != 0) {
194                     av_log(NULL, AV_LOG_ERROR, "incorrect codes\n");
195                     return -1;
196                 }
197                 table[j][1] = n; //bits
198                 table[j][0] = symbol;
199                 j += inc;
200             }
201         } else {
202             /* fill auxiliary table recursively */
203             n -= table_nb_bits;
204             code_prefix = code >> (32 - table_nb_bits);
205             subtable_bits = n;
206             codes[i].bits = n;
207             codes[i].code = code << table_nb_bits;
208             for (k = i+1; k < nb_codes; k++) {
209                 n = codes[k].bits - table_nb_bits;
210                 if (n <= 0)
211                     break;
212                 code = codes[k].code;
213                 if (code >> (32 - table_nb_bits) != code_prefix)
214                     break;
215                 codes[k].bits = n;
216                 codes[k].code = code << table_nb_bits;
217                 subtable_bits = FFMAX(subtable_bits, n);
218             }
219             subtable_bits = FFMIN(subtable_bits, table_nb_bits);
220             j = (flags & INIT_VLC_LE) ? bitswap_32(code_prefix) >> (32 - table_nb_bits) : code_prefix;
221             table[j][1] = -subtable_bits;
222             av_dlog(NULL, "%4x: n=%d (subtable)\n",
223                     j, codes[i].bits + table_nb_bits);
224             index = build_table(vlc, subtable_bits, k-i, codes+i, flags);
225             if (index < 0)
226                 return -1;
227             /* note: realloc has been done, so reload tables */
228             table = &vlc->table[table_index];
229             table[j][0] = index; //code
230             i = k-1;
231         }
232     }
233     return table_index;
234 }
235
236
237 /* Build VLC decoding tables suitable for use with get_vlc().
238
239    'nb_bits' set thee decoding table size (2^nb_bits) entries. The
240    bigger it is, the faster is the decoding. But it should not be too
241    big to save memory and L1 cache. '9' is a good compromise.
242
243    'nb_codes' : number of vlcs codes
244
245    'bits' : table which gives the size (in bits) of each vlc code.
246
247    'codes' : table which gives the bit pattern of of each vlc code.
248
249    'symbols' : table which gives the values to be returned from get_vlc().
250
251    'xxx_wrap' : give the number of bytes between each entry of the
252    'bits' or 'codes' tables.
253
254    'xxx_size' : gives the number of bytes of each entry of the 'bits'
255    or 'codes' tables.
256
257    'wrap' and 'size' allows to use any memory configuration and types
258    (byte/word/long) to store the 'bits', 'codes', and 'symbols' tables.
259
260    'use_static' should be set to 1 for tables, which should be freed
261    with av_free_static(), 0 if ff_free_vlc() will be used.
262 */
263 int ff_init_vlc_sparse(VLC *vlc, int nb_bits, int nb_codes,
264              const void *bits, int bits_wrap, int bits_size,
265              const void *codes, int codes_wrap, int codes_size,
266              const void *symbols, int symbols_wrap, int symbols_size,
267              int flags)
268 {
269     VLCcode *buf;
270     int i, j, ret;
271
272     vlc->bits = nb_bits;
273     if(flags & INIT_VLC_USE_NEW_STATIC){
274         if(vlc->table_size && vlc->table_size == vlc->table_allocated){
275             return 0;
276         }else if(vlc->table_size){
277             abort(); // fatal error, we are called on a partially initialized table
278         }
279         av_assert0(ff_avcodec_locked);
280     }else {
281         vlc->table = NULL;
282         vlc->table_allocated = 0;
283         vlc->table_size = 0;
284     }
285
286     av_dlog(NULL, "build table nb_codes=%d\n", nb_codes);
287
288     buf = av_malloc((nb_codes+1)*sizeof(VLCcode));
289
290     av_assert0(symbols_size <= 2 || !symbols);
291     j = 0;
292 #define COPY(condition)\
293     for (i = 0; i < nb_codes; i++) {\
294         GET_DATA(buf[j].bits, bits, i, bits_wrap, bits_size);\
295         if (!(condition))\
296             continue;\
297         GET_DATA(buf[j].code, codes, i, codes_wrap, codes_size);\
298         if (flags & INIT_VLC_LE)\
299             buf[j].code = bitswap_32(buf[j].code);\
300         else\
301             buf[j].code <<= 32 - buf[j].bits;\
302         if (symbols)\
303             GET_DATA(buf[j].symbol, symbols, i, symbols_wrap, symbols_size)\
304         else\
305             buf[j].symbol = i;\
306         j++;\
307     }
308     COPY(buf[j].bits > nb_bits);
309     // qsort is the slowest part of init_vlc, and could probably be improved or avoided
310     qsort(buf, j, sizeof(VLCcode), compare_vlcspec);
311     COPY(buf[j].bits && buf[j].bits <= nb_bits);
312     nb_codes = j;
313
314     ret = build_table(vlc, nb_bits, nb_codes, buf, flags);
315
316     av_free(buf);
317     if (ret < 0) {
318         av_freep(&vlc->table);
319         return -1;
320     }
321     if((flags & INIT_VLC_USE_NEW_STATIC) && vlc->table_size != vlc->table_allocated)
322         av_log(NULL, AV_LOG_ERROR, "needed %d had %d\n", vlc->table_size, vlc->table_allocated);
323     return 0;
324 }
325
326
327 void ff_free_vlc(VLC *vlc)
328 {
329     av_freep(&vlc->table);
330 }