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  *
   6  * This file is part of FFmpeg.
   7  *
   8  * FFmpeg is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * FFmpeg is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with FFmpeg; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  *
  22  * alternative bitstream reader & writer by Michael Niedermayer <michaelni@gmx.at>
  23  */
  24
  25 /**
  26  * @file bitstream.c
  27  * bitstream api.
  28  */
  29
  30 #include "avcodec.h"
  31 #include "bitstream.h"
  32
  33 void align_put_bits(PutBitContext *s)
  34 {
  35 #ifdef ALT_BITSTREAM_WRITER
  36     put_bits(s,(  - s->index) & 7,0);
  37 #else
  38     put_bits(s,s->bit_left & 7,0);
  39 #endif
  40 }
  41
  42 void ff_put_string(PutBitContext * pbc, char *s, int put_zero)
  43 {
  44     while(*s){
  45         put_bits(pbc, 8, *s);
  46         s++;
  47     }
  48     if(put_zero)
  49         put_bits(pbc, 8, 0);
  50 }
  51
  52 /* VLC decoding */
  53
  54 //#define DEBUG_VLC
  55
  56 #define GET_DATA(v, table, i, wrap, size) \
  57 {\
  58     const uint8_t *ptr = (const uint8_t *)table + i * wrap;\
  59     switch(size) {\
  60     case 1:\
  61         v = *(const uint8_t *)ptr;\
  62         break;\
  63     case 2:\
  64         v = *(const uint16_t *)ptr;\
  65         break;\
  66     default:\
  67         v = *(const uint32_t *)ptr;\
  68         break;\
  69     }\
  70 }
  71
  72
  73 static int alloc_table(VLC *vlc, int size, int use_static)
  74 {
  75     int index;
  76     index = vlc->table_size;
  77     vlc->table_size += size;
  78     if (vlc->table_size > vlc->table_allocated) {
  79         vlc->table_allocated += (1 << vlc->bits);
  80         if(use_static)
  81             vlc->table = av_realloc_static(vlc->table,
  82                                            sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
  83         else
  84             vlc->table = av_realloc(vlc->table,
  85                                     sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
  86         if (!vlc->table)
  87             return -1;
  88     }
  89     return index;
  90 }
  91
  92 static int build_table(VLC *vlc, int table_nb_bits,
  93                        int nb_codes,
  94                        const void *bits, int bits_wrap, int bits_size,
  95                        const void *codes, int codes_wrap, int codes_size,
  96                        uint32_t code_prefix, int n_prefix, int flags)
  97 {
  98     int i, j, k, n, table_size, table_index, nb, n1, index, code_prefix2;
  99     uint32_t code;
 100     VLC_TYPE (*table)[2];
 101
 102     table_size = 1 << table_nb_bits;
 103     table_index = alloc_table(vlc, table_size, flags & INIT_VLC_USE_STATIC);
 104 #ifdef DEBUG_VLC
 105     printf("new table index=%d size=%d code_prefix=%x n=%d\n",
 106            table_index, table_size, code_prefix, n_prefix);
 107 #endif
 108     if (table_index < 0)
 109         return -1;
 110     table = &vlc->table[table_index];
 111
 112     for(i=0;i<table_size;i++) {
 113         table[i][1] = 0; //bits
 114         table[i][0] = -1; //codes
 115     }
 116
 117     /* first pass: map codes and compute auxillary table sizes */
 118     for(i=0;i<nb_codes;i++) {
 119         GET_DATA(n, bits, i, bits_wrap, bits_size);
 120         GET_DATA(code, codes, i, codes_wrap, codes_size);
 121         /* we accept tables with holes */
 122         if (n <= 0)
 123             continue;
 124 #if defined(DEBUG_VLC) && 0
 125         printf("i=%d n=%d code=0x%x\n", i, n, code);
 126 #endif
 127         /* if code matches the prefix, it is in the table */
 128         n -= n_prefix;
 129         if(flags & INIT_VLC_LE)
 130             code_prefix2= code & (n_prefix>=32 ? 0xffffffff : (1 << n_prefix)-1);
 131         else
 132             code_prefix2= code >> n;
 133         if (n > 0 && code_prefix2 == code_prefix) {
 134             if (n <= table_nb_bits) {
 135                 /* no need to add another table */
 136                 j = (code << (table_nb_bits - n)) & (table_size - 1);
 137                 nb = 1 << (table_nb_bits - n);
 138                 for(k=0;k<nb;k++) {
 139                     if(flags & INIT_VLC_LE)
 140                         j = (code >> n_prefix) + (k<<n);
 141 #ifdef DEBUG_VLC
 142                     av_log(NULL, AV_LOG_DEBUG, "%4x: code=%d n=%d\n",
 143                            j, i, n);
 144 #endif
 145                     if (table[j][1] /*bits*/ != 0) {
 146                         av_log(NULL, AV_LOG_ERROR, "incorrect codes\n");
 147                         return -1;
 148                     }
 149                     table[j][1] = n; //bits
 150                     table[j][0] = i; //code
 151                     j++;
 152                 }
 153             } else {
 154                 n -= table_nb_bits;
 155                 j = (code >> ((flags & INIT_VLC_LE) ? n_prefix : n)) & ((1 << table_nb_bits) - 1);
 156 #ifdef DEBUG_VLC
 157                 printf("%4x: n=%d (subtable)\n",
 158                        j, n);
 159 #endif
 160                 /* compute table size */
 161                 n1 = -table[j][1]; //bits
 162                 if (n > n1)
 163                     n1 = n;
 164                 table[j][1] = -n1; //bits
 165             }
 166         }
 167     }
 168
 169     /* second pass : fill auxillary tables recursively */
 170     for(i=0;i<table_size;i++) {
 171         n = table[i][1]; //bits
 172         if (n < 0) {
 173             n = -n;
 174             if (n > table_nb_bits) {
 175                 n = table_nb_bits;
 176                 table[i][1] = -n; //bits
 177             }
 178             index = build_table(vlc, n, nb_codes,
 179                                 bits, bits_wrap, bits_size,
 180                                 codes, codes_wrap, codes_size,
 181                                 (flags & INIT_VLC_LE) ? (code_prefix | (i << n_prefix)) : ((code_prefix << table_nb_bits) | i),
 182                                 n_prefix + table_nb_bits, flags);
 183             if (index < 0)
 184                 return -1;
 185             /* note: realloc has been done, so reload tables */
 186             table = &vlc->table[table_index];
 187             table[i][0] = index; //code
 188         }
 189     }
 190     return table_index;
 191 }
 192
 193
 194 /* Build VLC decoding tables suitable for use with get_vlc().
 195
 196    'nb_bits' set thee decoding table size (2^nb_bits) entries. The
 197    bigger it is, the faster is the decoding. But it should not be too
 198    big to save memory and L1 cache. '9' is a good compromise.
 199
 200    'nb_codes' : number of vlcs codes
 201
 202    'bits' : table which gives the size (in bits) of each vlc code.
 203
 204    'codes' : table which gives the bit pattern of of each vlc code.
 205
 206    'xxx_wrap' : give the number of bytes between each entry of the
 207    'bits' or 'codes' tables.
 208
 209    'xxx_size' : gives the number of bytes of each entry of the 'bits'
 210    or 'codes' tables.
 211
 212    'wrap' and 'size' allows to use any memory configuration and types
 213    (byte/word/long) to store the 'bits' and 'codes' tables.
 214
 215    'use_static' should be set to 1 for tables, which should be freed
 216    with av_free_static(), 0 if free_vlc() will be used.
 217 */
 218 int init_vlc(VLC *vlc, int nb_bits, int nb_codes,
 219              const void *bits, int bits_wrap, int bits_size,
 220              const void *codes, int codes_wrap, int codes_size,
 221              int use_static)
 222 {
 223     vlc->bits = nb_bits;
 224     if(!use_static) {
 225         vlc->table = NULL;
 226         vlc->table_allocated = 0;
 227         vlc->table_size = 0;
 228     } else {
 229         /* Static tables are initially always NULL, return
 230            if vlc->table != NULL to avoid double allocation */
 231         if(vlc->table)
 232             return 0;
 233     }
 234
 235 #ifdef DEBUG_VLC
 236     printf("build table nb_codes=%d\n", nb_codes);
 237 #endif
 238
 239     if (build_table(vlc, nb_bits, nb_codes,
 240                     bits, bits_wrap, bits_size,
 241                     codes, codes_wrap, codes_size,
 242                     0, 0, use_static) < 0) {
 243         av_free(vlc->table);
 244         return -1;
 245     }
 246     return 0;
 247 }
 248
 249
 250 void free_vlc(VLC *vlc)
 251 {
 252     av_free(vlc->table);
 253 }
 254