avcodec/bitstream: Document the values supported for *_size in ff_init_vlc_sparse()
[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/atomic.h"
32 #include "libavutil/avassert.h"
33 #include "libavutil/qsort.h"
34 #include "avcodec.h"
35 #include "internal.h"
36 #include "mathops.h"
37 #include "put_bits.h"
38 #include "vlc.h"
39
40 const uint8_t ff_log2_run[41]={
41  0, 0, 0, 0, 1, 1, 1, 1,
42  2, 2, 2, 2, 3, 3, 3, 3,
43  4, 4, 5, 5, 6, 6, 7, 7,
44  8, 9,10,11,12,13,14,15,
45 16,17,18,19,20,21,22,23,
46 24,
47 };
48
49 void avpriv_align_put_bits(PutBitContext *s)
50 {
51     put_bits(s, s->bit_left & 7, 0);
52 }
53
54 void avpriv_put_string(PutBitContext *pb, const char *string,
55                        int terminate_string)
56 {
57     while (*string) {
58         put_bits(pb, 8, *string);
59         string++;
60     }
61     if (terminate_string)
62         put_bits(pb, 8, 0);
63 }
64
65 void avpriv_copy_bits(PutBitContext *pb, const uint8_t *src, int length)
66 {
67     int words = length >> 4;
68     int bits  = length & 15;
69     int i;
70
71     if (length == 0)
72         return;
73
74     av_assert0(length <= put_bits_left(pb));
75
76     if (CONFIG_SMALL || words < 16 || put_bits_count(pb) & 7) {
77         for (i = 0; i < words; i++)
78             put_bits(pb, 16, AV_RB16(src + 2 * i));
79     } else {
80         for (i = 0; put_bits_count(pb) & 31; i++)
81             put_bits(pb, 8, src[i]);
82         flush_put_bits(pb);
83         memcpy(put_bits_ptr(pb), src + i, 2 * words - i);
84         skip_put_bytes(pb, 2 * words - i);
85     }
86
87     put_bits(pb, bits, AV_RB16(src + 2 * words) >> (16 - bits));
88 }
89
90 /* VLC decoding */
91
92 #define GET_DATA(v, table, i, wrap, size)                   \
93 {                                                           \
94     const uint8_t *ptr = (const uint8_t *)table + i * wrap; \
95     switch(size) {                                          \
96     case 1:                                                 \
97         v = *(const uint8_t *)ptr;                          \
98         break;                                              \
99     case 2:                                                 \
100         v = *(const uint16_t *)ptr;                         \
101         break;                                              \
102     case 4:                                                 \
103         v = *(const uint32_t *)ptr;                         \
104         break;                                              \
105     default:                                                \
106         av_assert1(0);                                      \
107     }                                                       \
108 }
109
110
111 static int alloc_table(VLC *vlc, int size, int use_static)
112 {
113     int index = vlc->table_size;
114
115     vlc->table_size += size;
116     if (vlc->table_size > vlc->table_allocated) {
117         if (use_static)
118             abort(); // cannot do anything, init_vlc() is used with too little memory
119         vlc->table_allocated += (1 << vlc->bits);
120         vlc->table = av_realloc_f(vlc->table, vlc->table_allocated, sizeof(VLC_TYPE) * 2);
121         if (!vlc->table) {
122             vlc->table_allocated = 0;
123             vlc->table_size = 0;
124             return AVERROR(ENOMEM);
125         }
126         memset(vlc->table + vlc->table_allocated - (1 << vlc->bits), 0, sizeof(VLC_TYPE) * 2 << vlc->bits);
127     }
128     return index;
129 }
130
131 static av_always_inline uint32_t bitswap_32(uint32_t x)
132 {
133     return (uint32_t)ff_reverse[ x        & 0xFF] << 24 |
134            (uint32_t)ff_reverse[(x >> 8)  & 0xFF] << 16 |
135            (uint32_t)ff_reverse[(x >> 16) & 0xFF] << 8  |
136            (uint32_t)ff_reverse[ x >> 24];
137 }
138
139 typedef struct VLCcode {
140     uint8_t bits;
141     uint16_t symbol;
142     /** codeword, with the first bit-to-be-read in the msb
143      * (even if intended for a little-endian bitstream reader) */
144     uint32_t code;
145 } VLCcode;
146
147 static int compare_vlcspec(const void *a, const void *b)
148 {
149     const VLCcode *sa = a, *sb = b;
150     return (sa->code >> 1) - (sb->code >> 1);
151 }
152 /**
153  * Build VLC decoding tables suitable for use with get_vlc().
154  *
155  * @param vlc            the context to be initialized
156  *
157  * @param table_nb_bits  max length of vlc codes to store directly in this table
158  *                       (Longer codes are delegated to subtables.)
159  *
160  * @param nb_codes       number of elements in codes[]
161  *
162  * @param codes          descriptions of the vlc codes
163  *                       These must be ordered such that codes going into the same subtable are contiguous.
164  *                       Sorting by VLCcode.code is sufficient, though not necessary.
165  */
166 static int build_table(VLC *vlc, int table_nb_bits, int nb_codes,
167                        VLCcode *codes, int flags)
168 {
169     int table_size, table_index, index, code_prefix, symbol, subtable_bits;
170     int i, j, k, n, nb, inc;
171     uint32_t code;
172     volatile VLC_TYPE (* volatile table)[2]; // the double volatile is needed to prevent an internal compiler error in gcc 4.2
173
174     table_size = 1 << table_nb_bits;
175     if (table_nb_bits > 30)
176        return -1;
177     table_index = alloc_table(vlc, table_size, flags & INIT_VLC_USE_NEW_STATIC);
178     ff_dlog(NULL, "new table index=%d size=%d\n", table_index, table_size);
179     if (table_index < 0)
180         return table_index;
181     table = (volatile VLC_TYPE (*)[2])&vlc->table[table_index];
182
183     /* first pass: map codes and compute auxiliary table sizes */
184     for (i = 0; i < nb_codes; i++) {
185         n      = codes[i].bits;
186         code   = codes[i].code;
187         symbol = codes[i].symbol;
188         ff_dlog(NULL, "i=%d n=%d code=0x%x\n", i, n, code);
189         if (n <= table_nb_bits) {
190             /* no need to add another table */
191             j = code >> (32 - table_nb_bits);
192             nb = 1 << (table_nb_bits - n);
193             inc = 1;
194             if (flags & INIT_VLC_LE) {
195                 j = bitswap_32(code);
196                 inc = 1 << n;
197             }
198             for (k = 0; k < nb; k++) {
199                 int bits = table[j][1];
200                 ff_dlog(NULL, "%4x: code=%d n=%d\n", j, i, n);
201                 if (bits != 0 && bits != n) {
202                     av_log(NULL, AV_LOG_ERROR, "incorrect codes\n");
203                     return AVERROR_INVALIDDATA;
204                 }
205                 table[j][1] = n; //bits
206                 table[j][0] = symbol;
207                 j += inc;
208             }
209         } else {
210             /* fill auxiliary table recursively */
211             n -= table_nb_bits;
212             code_prefix = code >> (32 - table_nb_bits);
213             subtable_bits = n;
214             codes[i].bits = n;
215             codes[i].code = code << table_nb_bits;
216             for (k = i+1; k < nb_codes; k++) {
217                 n = codes[k].bits - table_nb_bits;
218                 if (n <= 0)
219                     break;
220                 code = codes[k].code;
221                 if (code >> (32 - table_nb_bits) != code_prefix)
222                     break;
223                 codes[k].bits = n;
224                 codes[k].code = code << table_nb_bits;
225                 subtable_bits = FFMAX(subtable_bits, n);
226             }
227             subtable_bits = FFMIN(subtable_bits, table_nb_bits);
228             j = (flags & INIT_VLC_LE) ? bitswap_32(code_prefix) >> (32 - table_nb_bits) : code_prefix;
229             table[j][1] = -subtable_bits;
230             ff_dlog(NULL, "%4x: n=%d (subtable)\n",
231                     j, codes[i].bits + table_nb_bits);
232             index = build_table(vlc, subtable_bits, k-i, codes+i, flags);
233             if (index < 0)
234                 return index;
235             /* note: realloc has been done, so reload tables */
236             table = (volatile VLC_TYPE (*)[2])&vlc->table[table_index];
237             table[j][0] = index; //code
238             i = k-1;
239         }
240     }
241
242     for (i = 0; i < table_size; i++) {
243         if (table[i][1] == 0) //bits
244             table[i][0] = -1; //codes
245     }
246
247     return table_index;
248 }
249
250
251 /* Build VLC decoding tables suitable for use with get_vlc().
252
253    'nb_bits' sets the decoding table size (2^nb_bits) entries. The
254    bigger it is, the faster is the decoding. But it should not be too
255    big to save memory and L1 cache. '9' is a good compromise.
256
257    'nb_codes' : number of vlcs codes
258
259    'bits' : table which gives the size (in bits) of each vlc code.
260
261    'codes' : table which gives the bit pattern of of each vlc code.
262
263    'symbols' : table which gives the values to be returned from get_vlc().
264
265    'xxx_wrap' : give the number of bytes between each entry of the
266    'bits' or 'codes' tables.
267
268    'xxx_size' : gives the number of bytes of each entry of the 'bits'
269    or 'codes' tables. Currently 1,2 and 4 are supported.
270
271    'wrap' and 'size' make it possible to use any memory configuration and types
272    (byte/word/long) to store the 'bits', 'codes', and 'symbols' tables.
273
274    'use_static' should be set to 1 for tables, which should be freed
275    with av_free_static(), 0 if ff_free_vlc() will be used.
276 */
277 int ff_init_vlc_sparse(VLC *vlc_arg, int nb_bits, int nb_codes,
278                        const void *bits, int bits_wrap, int bits_size,
279                        const void *codes, int codes_wrap, int codes_size,
280                        const void *symbols, int symbols_wrap, int symbols_size,
281                        int flags)
282 {
283     VLCcode *buf;
284     int i, j, ret;
285     VLCcode localbuf[1500]; // the maximum currently needed is 1296 by rv34
286     VLC localvlc, *vlc;
287
288     vlc = vlc_arg;
289     vlc->bits = nb_bits;
290     if (flags & INIT_VLC_USE_NEW_STATIC) {
291         av_assert0(nb_codes + 1 <= FF_ARRAY_ELEMS(localbuf));
292         buf = localbuf;
293         localvlc = *vlc_arg;
294         vlc = &localvlc;
295         vlc->table_size = 0;
296     } else {
297         vlc->table           = NULL;
298         vlc->table_allocated = 0;
299         vlc->table_size      = 0;
300
301         buf = av_malloc_array((nb_codes + 1), sizeof(VLCcode));
302         if (!buf)
303             return AVERROR(ENOMEM);
304     }
305
306
307     av_assert0(symbols_size <= 2 || !symbols);
308     j = 0;
309 #define COPY(condition)\
310     for (i = 0; i < nb_codes; i++) {                                        \
311         GET_DATA(buf[j].bits, bits, i, bits_wrap, bits_size);               \
312         if (!(condition))                                                   \
313             continue;                                                       \
314         if (buf[j].bits > 3*nb_bits || buf[j].bits>32) {                    \
315             av_log(NULL, AV_LOG_ERROR, "Too long VLC (%d) in init_vlc\n", buf[j].bits);\
316             if (!(flags & INIT_VLC_USE_NEW_STATIC))                         \
317                 av_free(buf);                                               \
318             return -1;                                                      \
319         }                                                                   \
320         GET_DATA(buf[j].code, codes, i, codes_wrap, codes_size);            \
321         if (buf[j].code >= (1LL<<buf[j].bits)) {                            \
322             av_log(NULL, AV_LOG_ERROR, "Invalid code %x for %d in init_vlc\n", buf[j].code, i);\
323             if (!(flags & INIT_VLC_USE_NEW_STATIC))                         \
324                 av_free(buf);                                               \
325             return -1;                                                      \
326         }                                                                   \
327         if (flags & INIT_VLC_LE)                                            \
328             buf[j].code = bitswap_32(buf[j].code);                          \
329         else                                                                \
330             buf[j].code <<= 32 - buf[j].bits;                               \
331         if (symbols)                                                        \
332             GET_DATA(buf[j].symbol, symbols, i, symbols_wrap, symbols_size) \
333         else                                                                \
334             buf[j].symbol = i;                                              \
335         j++;                                                                \
336     }
337     COPY(buf[j].bits > nb_bits);
338     // qsort is the slowest part of init_vlc, and could probably be improved or avoided
339     AV_QSORT(buf, j, struct VLCcode, compare_vlcspec);
340     COPY(buf[j].bits && buf[j].bits <= nb_bits);
341     nb_codes = j;
342
343     ret = build_table(vlc, nb_bits, nb_codes, buf, flags);
344
345     if (flags & INIT_VLC_USE_NEW_STATIC) {
346         if(vlc->table_size != vlc->table_allocated)
347             av_log(NULL, AV_LOG_ERROR, "needed %d had %d\n", vlc->table_size, vlc->table_allocated);
348
349         av_assert0(ret >= 0);
350         *vlc_arg = *vlc;
351     } else {
352         av_free(buf);
353         if (ret < 0) {
354             av_freep(&vlc->table);
355             return ret;
356         }
357     }
358     return 0;
359 }
360
361
362 void ff_free_vlc(VLC *vlc)
363 {
364     av_freep(&vlc->table);
365 }