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