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 #ifdef LIBMPEG2_BITSTREAM_HACK
 144   if ((int)buffer&1) {
 145      /* word alignment */
 146     s->cache = (*buffer++)<<24;
 147     s->buffer_ptr = buffer;
 148     s->bit_count = 16-8;
 149   } else
 150 #endif
 151   {
 152     s->buffer_ptr = buffer;
 153     s->bit_count = 16;
 154     s->cache = 0;
 155   }
 156 #elif defined A32_BITSTREAM_READER
 157     s->buffer_ptr = (uint32_t*)buffer;
 158     s->bit_count = 32;
 159     s->cache0 = 0;
 160     s->cache1 = 0;
 161 #endif
 162     {
 163         OPEN_READER(re, s)
 164         UPDATE_CACHE(re, s)
 165 //        UPDATE_CACHE(re, s)
 166         CLOSE_READER(re, s)
 167     }
 168 #ifdef A32_BITSTREAM_READER
 169     s->cache1 = 0;
 170 #endif
 171 }
 172
 173 void align_get_bits(GetBitContext *s)
 174 {
 175     int n= (-get_bits_count(s)) & 7;
 176     if(n) skip_bits(s, n);
 177 }
 178
 179 int check_marker(GetBitContext *s, const char *msg)
 180 {
 181     int bit= get_bits1(s);
 182     if(!bit) printf("Marker bit missing %s\n", msg);
 183
 184     return bit;
 185 }
 186
 187 /* VLC decoding */
 188
 189 //#define DEBUG_VLC
 190
 191 #define GET_DATA(v, table, i, wrap, size) \
 192 {\
 193     const uint8_t *ptr = (const uint8_t *)table + i * wrap;\
 194     switch(size) {\
 195     case 1:\
 196         v = *(const uint8_t *)ptr;\
 197         break;\
 198     case 2:\
 199         v = *(const uint16_t *)ptr;\
 200         break;\
 201     default:\
 202         v = *(const uint32_t *)ptr;\
 203         break;\
 204     }\
 205 }
 206
 207
 208 static int alloc_table(VLC *vlc, int size)
 209 {
 210     int index;
 211     index = vlc->table_size;
 212     vlc->table_size += size;
 213     if (vlc->table_size > vlc->table_allocated) {
 214         vlc->table_allocated += (1 << vlc->bits);
 215         vlc->table = av_realloc(vlc->table,
 216                                 sizeof(VLC_TYPE) * 2 * vlc->table_allocated);
 217         if (!vlc->table)
 218             return -1;
 219     }
 220     return index;
 221 }
 222
 223 static int build_table(VLC *vlc, int table_nb_bits,
 224                        int nb_codes,
 225                        const void *bits, int bits_wrap, int bits_size,
 226                        const void *codes, int codes_wrap, int codes_size,
 227                        uint32_t code_prefix, int n_prefix)
 228 {
 229     int i, j, k, n, table_size, table_index, nb, n1, index;
 230     uint32_t code;
 231     VLC_TYPE (*table)[2];
 232
 233     table_size = 1 << table_nb_bits;
 234     table_index = alloc_table(vlc, table_size);
 235 #ifdef DEBUG_VLC
 236     printf("new table index=%d size=%d code_prefix=%x n=%d\n",
 237            table_index, table_size, code_prefix, n_prefix);
 238 #endif
 239     if (table_index < 0)
 240         return -1;
 241     table = &vlc->table[table_index];
 242
 243     for(i=0;i<table_size;i++) {
 244         table[i][1] = 0; //bits
 245         table[i][0] = -1; //codes
 246     }
 247
 248     /* first pass: map codes and compute auxillary table sizes */
 249     for(i=0;i<nb_codes;i++) {
 250         GET_DATA(n, bits, i, bits_wrap, bits_size);
 251         GET_DATA(code, codes, i, codes_wrap, codes_size);
 252         /* we accept tables with holes */
 253         if (n <= 0)
 254             continue;
 255 #if defined(DEBUG_VLC) && 0
 256         printf("i=%d n=%d code=0x%x\n", i, n, code);
 257 #endif
 258         /* if code matches the prefix, it is in the table */
 259         n -= n_prefix;
 260         if (n > 0 && (code >> n) == code_prefix) {
 261             if (n <= table_nb_bits) {
 262                 /* no need to add another table */
 263                 j = (code << (table_nb_bits - n)) & (table_size - 1);
 264                 nb = 1 << (table_nb_bits - n);
 265                 for(k=0;k<nb;k++) {
 266 #ifdef DEBUG_VLC
 267                     printf("%4x: code=%d n=%d\n",
 268                            j, i, n);
 269 #endif
 270                     if (table[j][1] /*bits*/ != 0) {
 271                         fprintf(stderr, "incorrect codes\n");
 272                         exit(1);
 273                     }
 274                     table[j][1] = n; //bits
 275                     table[j][0] = i; //code
 276                     j++;
 277                 }
 278             } else {
 279                 n -= table_nb_bits;
 280                 j = (code >> n) & ((1 << table_nb_bits) - 1);
 281 #ifdef DEBUG_VLC
 282                 printf("%4x: n=%d (subtable)\n",
 283                        j, n);
 284 #endif
 285                 /* compute table size */
 286                 n1 = -table[j][1]; //bits
 287                 if (n > n1)
 288                     n1 = n;
 289                 table[j][1] = -n1; //bits
 290             }
 291         }
 292     }
 293
 294     /* second pass : fill auxillary tables recursively */
 295     for(i=0;i<table_size;i++) {
 296         n = table[i][1]; //bits
 297         if (n < 0) {
 298             n = -n;
 299             if (n > table_nb_bits) {
 300                 n = table_nb_bits;
 301                 table[i][1] = -n; //bits
 302             }
 303             index = build_table(vlc, n, nb_codes,
 304                                 bits, bits_wrap, bits_size,
 305                                 codes, codes_wrap, codes_size,
 306                                 (code_prefix << table_nb_bits) | i,
 307                                 n_prefix + table_nb_bits);
 308             if (index < 0)
 309                 return -1;
 310             /* note: realloc has been done, so reload tables */
 311             table = &vlc->table[table_index];
 312             table[i][0] = index; //code
 313         }
 314     }
 315     return table_index;
 316 }
 317
 318
 319 /* Build VLC decoding tables suitable for use with get_vlc().
 320
 321    'nb_bits' set thee decoding table size (2^nb_bits) entries. The
 322    bigger it is, the faster is the decoding. But it should not be too
 323    big to save memory and L1 cache. '9' is a good compromise.
 324
 325    'nb_codes' : number of vlcs codes
 326
 327    'bits' : table which gives the size (in bits) of each vlc code.
 328
 329    'codes' : table which gives the bit pattern of of each vlc code.
 330
 331    'xxx_wrap' : give the number of bytes between each entry of the
 332    'bits' or 'codes' tables.
 333
 334    'xxx_size' : gives the number of bytes of each entry of the 'bits'
 335    or 'codes' tables.
 336
 337    'wrap' and 'size' allows to use any memory configuration and types
 338    (byte/word/long) to store the 'bits' and 'codes' tables.
 339 */
 340 int init_vlc(VLC *vlc, int nb_bits, int nb_codes,
 341              const void *bits, int bits_wrap, int bits_size,
 342              const void *codes, int codes_wrap, int codes_size)
 343 {
 344     vlc->bits = nb_bits;
 345     vlc->table = NULL;
 346     vlc->table_allocated = 0;
 347     vlc->table_size = 0;
 348 #ifdef DEBUG_VLC
 349     printf("build table nb_codes=%d\n", nb_codes);
 350 #endif
 351
 352     if (build_table(vlc, nb_bits, nb_codes,
 353                     bits, bits_wrap, bits_size,
 354                     codes, codes_wrap, codes_size,
 355                     0, 0) < 0) {
 356         av_free(vlc->table);
 357         return -1;
 358     }
 359     return 0;
 360 }
 361
 362
 363 void free_vlc(VLC *vlc)
 364 {
 365     av_free(vlc->table);
 366 }
 367
 368 int64_t ff_gcd(int64_t a, int64_t b){
 369     if(b) return ff_gcd(b, a%b);
 370     else  return a;
 371 }
 372
 373 void ff_float2fraction(int *nom_arg, int *denom_arg, double f, int max){
 374     double best_diff=1E10, diff;
 375     int best_denom=1, best_nom=1;
 376     int nom, denom, gcd;
 377
 378     //brute force here, perhaps we should try continued fractions if we need large max ...
 379     for(denom=1; denom<=max; denom++){
 380         nom= (int)(f*denom + 0.5);
 381         if(nom<=0 || nom>max) continue;
 382
 383         diff= ABS( f - (double)nom / (double)denom );
 384         if(diff < best_diff){
 385             best_diff= diff;
 386             best_nom= nom;
 387             best_denom= denom;
 388         }
 389     }
 390
 391     gcd= ff_gcd(best_nom, best_denom);
 392     best_nom   /= gcd;
 393     best_denom /= gcd;
 394
 395     *nom_arg= best_nom;
 396     *denom_arg= best_denom;
 397 }