git.sesse.net Git - ffmpeg/blob - libavcodec/common.c

   1 /*
   2  * Common bit i/o utils
   3  * Copyright (c) 2000, 2001 Fabrice Bellard.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  *
  19  * alternative bitstream reader & writer by Michael Niedermayer <michaelni@gmx.at>
  20  */
  21
  22 /**
  23  * @file common.c
  24  * common internal api.
  25  */
  26
  27 #include "avcodec.h"
  28
  29 const uint8_t ff_sqrt_tab[128]={
  30         0, 1, 1, 1, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5, 5, 5, 5, 5,
  31         5, 5, 5, 5, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
  32         8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9,
  33         9, 9, 9, 9,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,11,11,11,11,11,11,11
  34 };
  35
  36 const uint8_t ff_log2_tab[256]={
  37         0,0,1,1,2,2,2,2,3,3,3,3,3,3,3,3,4,4,4,4,4,4,4,4,4,4,4,4,4,4,4,4,
  38         5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,
  39         6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,
  40         6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,
  41         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
  42         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
  43         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
  44         7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7
  45 };
  46
  47 void init_put_bits(PutBitContext *s,
  48                    uint8_t *buffer, int buffer_size,
  49                    void *opaque,
  50                    void (*write_data)(void *, uint8_t *, int))
  51 {
  52     s->buf = buffer;
  53     s->buf_end = s->buf + buffer_size;
  54     s->data_out_size = 0;
  55     if(write_data!=NULL)
  56     {
  57         fprintf(stderr, "write Data callback is not supported\n");
  58     }
  59 #ifdef ALT_BITSTREAM_WRITER
  60     s->index=0;
  61     ((uint32_t*)(s->buf))[0]=0;
  62 //    memset(buffer, 0, buffer_size);
  63 #else
  64     s->buf_ptr = s->buf;
  65     s->bit_left=32;
  66     s->bit_buf=0;
  67 #endif
  68 }
  69
  70 #ifdef CONFIG_ENCODERS
  71
  72 /* return the number of bits output */
  73 int64_t get_bit_count(PutBitContext *s)
  74 {
  75 #ifdef ALT_BITSTREAM_WRITER
  76     return s->data_out_size * 8 + s->index;
  77 #else
  78     return (s->buf_ptr - s->buf + s->data_out_size) * 8 + 32 - (int64_t)s->bit_left;
  79 #endif
  80 }
  81
  82 void align_put_bits(PutBitContext *s)
  83 {
  84 #ifdef ALT_BITSTREAM_WRITER
  85     put_bits(s,(  - s->index) & 7,0);
  86 #else
  87     put_bits(s,s->bit_left & 7,0);
  88 #endif
  89 }
  90
  91 #endif //CONFIG_ENCODERS
  92
  93 /* pad the end of the output stream with zeros */
  94 void flush_put_bits(PutBitContext *s)
  95 {
  96 #ifdef ALT_BITSTREAM_WRITER
  97     align_put_bits(s);
  98 #else
  99     s->bit_buf<<= s->bit_left;
 100     while (s->bit_left < 32) {
 101         /* XXX: should test end of buffer */
 102         *s->buf_ptr++=s->bit_buf >> 24;
 103         s->bit_buf<<=8;
 104         s->bit_left+=8;
 105     }
 106     s->bit_left=32;
 107     s->bit_buf=0;
 108 #endif
 109 }
 110
 111 #ifdef CONFIG_ENCODERS
 112
 113 void put_string(PutBitContext * pbc, char *s)
 114 {
 115     while(*s){
 116         put_bits(pbc, 8, *s);
 117         s++;
 118     }
 119     put_bits(pbc, 8, 0);
 120 }
 121
 122 /* bit input functions */
 123
 124 #endif //CONFIG_ENCODERS
 125
 126 /**
 127  * init GetBitContext.
 128  * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes larger then the actual read bits
 129  * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
 130  * @param bit_size the size of the buffer in bits
 131  */
 132 void init_get_bits(GetBitContext *s,
 133                    const uint8_t *buffer, int bit_size)
 134 {
 135     const int buffer_size= (bit_size+7)>>3;
 136
 137     s->buffer= buffer;
 138     s->size_in_bits= bit_size;
 139     s->buffer_end= buffer + buffer_size;
 140 #ifdef ALT_BITSTREAM_READER
 141     s->index=0;
 142 #elif defined LIBMPEG2_BITSTREAM_READER
 143     s->buffer_ptr = buffer;
 144     s->bit_count = 16;
 145     s->cache = 0;
 146 #elif defined A32_BITSTREAM_READER
 147     s->buffer_ptr = (uint32_t*)buffer;
 148     s->bit_count = 32;
 149     s->cache0 = 0;
 150     s->cache1 = 0;
 151 #endif
 152     {
 153         OPEN_READER(re, s)
 154         UPDATE_CACHE(re, s)
 155 //        UPDATE_CACHE(re, s)
 156         CLOSE_READER(re, s)
 157     }
 158 #ifdef A32_BITSTREAM_READER
 159     s->cache1 = 0;
 160 #endif
 161 }
 162
 163 void align_get_bits(GetBitContext *s)
 164 {
 165     int n= (-get_bits_count(s)) & 7;
 166     if(n) skip_bits(s, n);
 167 }
 168
 169 int check_marker(GetBitContext *s, const char *msg)
 170 {
 171     int bit= get_bits1(s);
 172     if(!bit) printf("Marker bit missing %s\n", msg);
 173
 174     return bit;
 175 }
 176
 177 /* VLC decoding */
 178
 179 //#define DEBUG_VLC
 180
 181 #define GET_DATA(v, table, i, wrap, size) \
 182 {\
 183     const uint8_t *ptr = (const uint8_t *)table + i * wrap;\
 184     switch(size) {\
 185     case 1:\
 186         v = *(const uint8_t *)ptr;\
 187         break;\
 188     case 2:\
 189         v = *(const uint16_t *)ptr;\
 190         break;\
 191     default:\
 192         v = *(const uint32_t *)ptr;\
 193         break;\
 194     }\
 195 }
 196
 197
 198 static int alloc_table(VLC *vlc, int size)
 199 {
 200     int index;
 201     index = vlc->table_size;
 202     vlc->table_size += size;
 203     if (vlc->table_size > vlc->table_allocated) {
 204         vlc->table_allocated += (1 << vlc->bits);
 205         vlc->table = av_realloc(vlc->table,
 206                                 sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
 207         if (!vlc->table)
 208             return -1;
 209     }
 210     return index;
 211 }
 212
 213 static int build_table(VLC *vlc, int table_nb_bits,
 214                        int nb_codes,
 215                        const void *bits, int bits_wrap, int bits_size,
 216                        const void *codes, int codes_wrap, int codes_size,
 217                        uint32_t code_prefix, int n_prefix)
 218 {
 219     int i, j, k, n, table_size, table_index, nb, n1, index;
 220     uint32_t code;
 221     VLC_TYPE (*table)[2];
 222
 223     table_size = 1 << table_nb_bits;
 224     table_index = alloc_table(vlc, table_size);
 225 #ifdef DEBUG_VLC
 226     printf("new table index=%d size=%d code_prefix=%x n=%d\n",
 227            table_index, table_size, code_prefix, n_prefix);
 228 #endif
 229     if (table_index < 0)
 230         return -1;
 231     table = &vlc->table[table_index];
 232
 233     for(i=0;i<table_size;i++) {
 234         table[i][1] = 0; //bits
 235         table[i][0] = -1; //codes
 236     }
 237
 238     /* first pass: map codes and compute auxillary table sizes */
 239     for(i=0;i<nb_codes;i++) {
 240         GET_DATA(n, bits, i, bits_wrap, bits_size);
 241         GET_DATA(code, codes, i, codes_wrap, codes_size);
 242         /* we accept tables with holes */
 243         if (n <= 0)
 244             continue;
 245 #if defined(DEBUG_VLC) && 0
 246         printf("i=%d n=%d code=0x%x\n", i, n, code);
 247 #endif
 248         /* if code matches the prefix, it is in the table */
 249         n -= n_prefix;
 250         if (n > 0 && (code >> n) == code_prefix) {
 251             if (n <= table_nb_bits) {
 252                 /* no need to add another table */
 253                 j = (code << (table_nb_bits - n)) & (table_size - 1);
 254                 nb = 1 << (table_nb_bits - n);
 255                 for(k=0;k<nb;k++) {
 256 #ifdef DEBUG_VLC
 257                     printf("%4x: code=%d n=%d\n",
 258                            j, i, n);
 259 #endif
 260                     if (table[j][1] /*bits*/ != 0) {
 261                         fprintf(stderr, "incorrect codes\n");
 262                         exit(1);
 263                     }
 264                     table[j][1] = n; //bits
 265                     table[j][0] = i; //code
 266                     j++;
 267                 }
 268             } else {
 269                 n -= table_nb_bits;
 270                 j = (code >> n) & ((1 << table_nb_bits) - 1);
 271 #ifdef DEBUG_VLC
 272                 printf("%4x: n=%d (subtable)\n",
 273                        j, n);
 274 #endif
 275                 /* compute table size */
 276                 n1 = -table[j][1]; //bits
 277                 if (n > n1)
 278                     n1 = n;
 279                 table[j][1] = -n1; //bits
 280             }
 281         }
 282     }
 283
 284     /* second pass : fill auxillary tables recursively */
 285     for(i=0;i<table_size;i++) {
 286         n = table[i][1]; //bits
 287         if (n < 0) {
 288             n = -n;
 289             if (n > table_nb_bits) {
 290                 n = table_nb_bits;
 291                 table[i][1] = -n; //bits
 292             }
 293             index = build_table(vlc, n, nb_codes,
 294                                 bits, bits_wrap, bits_size,
 295                                 codes, codes_wrap, codes_size,
 296                                 (code_prefix << table_nb_bits) | i,
 297                                 n_prefix + table_nb_bits);
 298             if (index < 0)
 299                 return -1;
 300             /* note: realloc has been done, so reload tables */
 301             table = &vlc->table[table_index];
 302             table[i][0] = index; //code
 303         }
 304     }
 305     return table_index;
 306 }
 307
 308
 309 /* Build VLC decoding tables suitable for use with get_vlc().
 310
 311    'nb_bits' set thee decoding table size (2^nb_bits) entries. The
 312    bigger it is, the faster is the decoding. But it should not be too
 313    big to save memory and L1 cache. '9' is a good compromise.
 314
 315    'nb_codes' : number of vlcs codes
 316
 317    'bits' : table which gives the size (in bits) of each vlc code.
 318
 319    'codes' : table which gives the bit pattern of of each vlc code.
 320
 321    'xxx_wrap' : give the number of bytes between each entry of the
 322    'bits' or 'codes' tables.
 323
 324    'xxx_size' : gives the number of bytes of each entry of the 'bits'
 325    or 'codes' tables.
 326
 327    'wrap' and 'size' allows to use any memory configuration and types
 328    (byte/word/long) to store the 'bits' and 'codes' tables.
 329 */
 330 int init_vlc(VLC *vlc, int nb_bits, int nb_codes,
 331              const void *bits, int bits_wrap, int bits_size,
 332              const void *codes, int codes_wrap, int codes_size)
 333 {
 334     vlc->bits = nb_bits;
 335     vlc->table = NULL;
 336     vlc->table_allocated = 0;
 337     vlc->table_size = 0;
 338 #ifdef DEBUG_VLC
 339     printf("build table nb_codes=%d\n", nb_codes);
 340 #endif
 341
 342     if (build_table(vlc, nb_bits, nb_codes,
 343                     bits, bits_wrap, bits_size,
 344                     codes, codes_wrap, codes_size,
 345                     0, 0) < 0) {
 346         av_free(vlc->table);
 347         return -1;
 348     }
 349     return 0;
 350 }
 351
 352
 353 void free_vlc(VLC *vlc)
 354 {
 355     av_free(vlc->table);
 356 }
 357
 358 int64_t ff_gcd(int64_t a, int64_t b){
 359     if(b) return ff_gcd(b, a%b);
 360     else  return a;
 361 }
 362
 363 void ff_float2fraction(int *nom_arg, int *denom_arg, double f, int max){
 364     double best_diff=1E10, diff;
 365     int best_denom=1, best_nom=1;
 366     int nom, denom, gcd;
 367
 368     //brute force here, perhaps we should try continued fractions if we need large max ...
 369     for(denom=1; denom<=max; denom++){
 370         nom= (int)(f*denom + 0.5);
 371         if(nom<=0 || nom>max) continue;
 372
 373         diff= ABS( f - (double)nom / (double)denom );
 374         if(diff < best_diff){
 375             best_diff= diff;
 376             best_nom= nom;
 377             best_denom= denom;
 378         }
 379     }
 380
 381     gcd= ff_gcd(best_nom, best_denom);
 382     best_nom   /= gcd;
 383     best_denom /= gcd;
 384
 385     *nom_arg= best_nom;
 386     *denom_arg= best_denom;
 387 }