git.sesse.net Git - ffmpeg/blob - 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 Libav.
  10  *
  11  * Libav 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  * Libav 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 Libav; 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 "avcodec.h"
  32 #include "mathops.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,
  51                        int terminate_string)
  52 {
  53     while (*string) {
  54         put_bits(pb, 8, *string);
  55         string++;
  56     }
  57     if (terminate_string)
  58         put_bits(pb, 8, 0);
  59 }
  60
  61 void avpriv_copy_bits(PutBitContext *pb, const uint8_t *src, int length)
  62 {
  63     int words = length >> 4;
  64     int bits  = length & 15;
  65     int i;
  66
  67     if (length == 0)
  68         return;
  69
  70     if (CONFIG_SMALL || words < 16 || put_bits_count(pb) & 7) {
  71         for (i = 0; i < words; i++)
  72             put_bits(pb, 16, AV_RB16(src + 2 * i));
  73     } else {
  74         for (i = 0; put_bits_count(pb) & 31; i++)
  75             put_bits(pb, 8, src[i]);
  76         flush_put_bits(pb);
  77         memcpy(put_bits_ptr(pb), src + i, 2 * words - i);
  78         skip_put_bytes(pb, 2 * words - i);
  79     }
  80
  81     put_bits(pb, bits, AV_RB16(src + 2 * words) >> (16 - bits));
  82 }
  83
  84 /* VLC decoding */
  85
  86 #define GET_DATA(v, table, i, wrap, size)                   \
  87 {                                                           \
  88     const uint8_t *ptr = (const uint8_t *)table + i * wrap; \
  89     switch(size) {                                          \
  90     case 1:                                                 \
  91         v = *(const uint8_t *)ptr;                          \
  92         break;                                              \
  93     case 2:                                                 \
  94         v = *(const uint16_t *)ptr;                         \
  95         break;                                              \
  96     default:                                                \
  97         v = *(const uint32_t *)ptr;                         \
  98         break;                                              \
  99     }                                                       \
 100 }
 101
 102
 103 static int alloc_table(VLC *vlc, int size, int use_static)
 104 {
 105     int index = vlc->table_size;
 106
 107     vlc->table_size += size;
 108     if (vlc->table_size > vlc->table_allocated) {
 109         if (use_static)
 110             return AVERROR_BUG;
 111         vlc->table_allocated += (1 << vlc->bits);
 112         vlc->table = av_realloc(vlc->table, sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
 113         if (!vlc->table)
 114             return AVERROR(ENOMEM);
 115     }
 116     return index;
 117 }
 118
 119 static av_always_inline uint32_t bitswap_32(uint32_t x)
 120 {
 121     return (uint32_t)ff_reverse[ x        & 0xFF] << 24 |
 122            (uint32_t)ff_reverse[(x >> 8)  & 0xFF] << 16 |
 123            (uint32_t)ff_reverse[(x >> 16) & 0xFF] << 8  |
 124            (uint32_t)ff_reverse[ x >> 24];
 125 }
 126
 127 typedef struct {
 128     uint8_t bits;
 129     uint16_t symbol;
 130     /** codeword, with the first bit-to-be-read in the msb
 131      * (even if intended for a little-endian bitstream reader) */
 132     uint32_t code;
 133 } VLCcode;
 134
 135 static int compare_vlcspec(const void *a, const void *b)
 136 {
 137     const VLCcode *sa = a, *sb = b;
 138     return (sa->code >> 1) - (sb->code >> 1);
 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     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 table_index;
 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 auxiliary 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 AVERROR_INVALIDDATA;
 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 index;
 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             return AVERROR_BUG;
 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     if (!buf)
 287         return AVERROR(ENOMEM);
 288
 289     assert(symbols_size <= 2 || !symbols);
 290     j = 0;
 291 #define COPY(condition)                                                     \
 292     for (i = 0; i < nb_codes; i++) {                                        \
 293         GET_DATA(buf[j].bits, bits, i, bits_wrap, bits_size);               \
 294         if (!(condition))                                                   \
 295             continue;                                                       \
 296         GET_DATA(buf[j].code, codes, i, codes_wrap, codes_size);            \
 297         if (flags & INIT_VLC_LE)                                            \
 298             buf[j].code = bitswap_32(buf[j].code);                          \
 299         else                                                                \
 300             buf[j].code <<= 32 - buf[j].bits;                               \
 301         if (symbols)                                                        \
 302             GET_DATA(buf[j].symbol, symbols, i, symbols_wrap, symbols_size) \
 303             else                                                            \
 304                 buf[j].symbol = i;                                          \
 305         j++;                                                                \
 306     }
 307     COPY(buf[j].bits > nb_bits);
 308     // qsort is the slowest part of init_vlc, and could probably be improved or avoided
 309     qsort(buf, j, sizeof(VLCcode), compare_vlcspec);
 310     COPY(buf[j].bits && buf[j].bits <= nb_bits);
 311     nb_codes = j;
 312
 313     ret = build_table(vlc, nb_bits, nb_codes, buf, flags);
 314
 315     av_free(buf);
 316     if (ret < 0) {
 317         av_freep(&vlc->table);
 318         return ret;
 319     }
 320     if ((flags & INIT_VLC_USE_NEW_STATIC) &&
 321         vlc->table_size != vlc->table_allocated)
 322         av_log(NULL, AV_LOG_ERROR, "needed %d had %d\n",
 323                vlc->table_size, vlc->table_allocated);
 324     return 0;
 325 }
 326
 327
 328 void ff_free_vlc(VLC *vlc)
 329 {
 330     av_freep(&vlc->table);
 331 }