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