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