git.sesse.net Git - ffmpeg/blob - libavcodec/put_bits.h

   1 /*
   2  * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * bitstream writer API
  24  */
  25
  26 #ifndef AVCODEC_PUT_BITS_H
  27 #define AVCODEC_PUT_BITS_H
  28
  29 #include <stdint.h>
  30 #include <stdlib.h>
  31 #include <assert.h>
  32 #include "libavutil/bswap.h"
  33 #include "libavutil/common.h"
  34 #include "libavutil/intreadwrite.h"
  35 #include "libavutil/log.h"
  36 #include "mathops.h"
  37 #include "config.h"
  38
  39 //#define ALT_BITSTREAM_WRITER
  40 //#define ALIGNED_BITSTREAM_WRITER
  41
  42 /* buf and buf_end must be present and used by every alternative writer. */
  43 typedef struct PutBitContext {
  44 #ifdef ALT_BITSTREAM_WRITER
  45     uint8_t *buf, *buf_end;
  46     int index;
  47 #else
  48     uint32_t bit_buf;
  49     int bit_left;
  50     uint8_t *buf, *buf_ptr, *buf_end;
  51 #endif
  52     int size_in_bits;
  53 } PutBitContext;
  54
  55 /**
  56  * Initialize the PutBitContext s.
  57  *
  58  * @param buffer the buffer where to put bits
  59  * @param buffer_size the size in bytes of buffer
  60  */
  61 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
  62 {
  63     if(buffer_size < 0) {
  64         buffer_size = 0;
  65         buffer = NULL;
  66     }
  67
  68     s->size_in_bits= 8*buffer_size;
  69     s->buf = buffer;
  70     s->buf_end = s->buf + buffer_size;
  71 #ifdef ALT_BITSTREAM_WRITER
  72     s->index=0;
  73     ((uint32_t*)(s->buf))[0]=0;
  74 //    memset(buffer, 0, buffer_size);
  75 #else
  76     s->buf_ptr = s->buf;
  77     s->bit_left=32;
  78     s->bit_buf=0;
  79 #endif
  80 }
  81
  82 /**
  83  * @return the total number of bits written to the bitstream.
  84  */
  85 static inline int put_bits_count(PutBitContext *s)
  86 {
  87 #ifdef ALT_BITSTREAM_WRITER
  88     return s->index;
  89 #else
  90     return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
  91 #endif
  92 }
  93
  94 /**
  95  * Pad the end of the output stream with zeros.
  96  */
  97 static inline void flush_put_bits(PutBitContext *s)
  98 {
  99 #ifdef ALT_BITSTREAM_WRITER
 100     align_put_bits(s);
 101 #else
 102 #ifndef BITSTREAM_WRITER_LE
 103     s->bit_buf<<= s->bit_left;
 104 #endif
 105     while (s->bit_left < 32) {
 106         /* XXX: should test end of buffer */
 107 #ifdef BITSTREAM_WRITER_LE
 108         *s->buf_ptr++=s->bit_buf;
 109         s->bit_buf>>=8;
 110 #else
 111         *s->buf_ptr++=s->bit_buf >> 24;
 112         s->bit_buf<<=8;
 113 #endif
 114         s->bit_left+=8;
 115     }
 116     s->bit_left=32;
 117     s->bit_buf=0;
 118 #endif
 119 }
 120
 121 #if defined(ALT_BITSTREAM_WRITER) || defined(BITSTREAM_WRITER_LE)
 122 #define align_put_bits align_put_bits_unsupported_here
 123 #define ff_put_string ff_put_string_unsupported_here
 124 #define ff_copy_bits ff_copy_bits_unsupported_here
 125 #else
 126 /**
 127  * Pad the bitstream with zeros up to the next byte boundary.
 128  */
 129 void align_put_bits(PutBitContext *s);
 130
 131 /**
 132  * Put the string string in the bitstream.
 133  *
 134  * @param terminate_string 0-terminates the written string if value is 1
 135  */
 136 void ff_put_string(PutBitContext *pb, const char *string, int terminate_string);
 137
 138 /**
 139  * Copy the content of src to the bitstream.
 140  *
 141  * @param length the number of bits of src to copy
 142  */
 143 void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
 144 #endif
 145
 146 /**
 147  * Write up to 31 bits into a bitstream.
 148  * Use put_bits32 to write 32 bits.
 149  */
 150 static inline void put_bits(PutBitContext *s, int n, unsigned int value)
 151 #ifndef ALT_BITSTREAM_WRITER
 152 {
 153     unsigned int bit_buf;
 154     int bit_left;
 155
 156     //    printf("put_bits=%d %x\n", n, value);
 157     assert(n <= 31 && value < (1U << n));
 158
 159     bit_buf = s->bit_buf;
 160     bit_left = s->bit_left;
 161
 162     //    printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
 163     /* XXX: optimize */
 164 #ifdef BITSTREAM_WRITER_LE
 165     bit_buf |= value << (32 - bit_left);
 166     if (n >= bit_left) {
 167 #if !HAVE_FAST_UNALIGNED
 168         if (3 & (intptr_t) s->buf_ptr) {
 169             AV_WL32(s->buf_ptr, bit_buf);
 170         } else
 171 #endif
 172         *(uint32_t *)s->buf_ptr = av_le2ne32(bit_buf);
 173         s->buf_ptr+=4;
 174         bit_buf = (bit_left==32)?0:value >> bit_left;
 175         bit_left+=32;
 176     }
 177     bit_left-=n;
 178 #else
 179     if (n < bit_left) {
 180         bit_buf = (bit_buf<<n) | value;
 181         bit_left-=n;
 182     } else {
 183         bit_buf<<=bit_left;
 184         bit_buf |= value >> (n - bit_left);
 185 #if !HAVE_FAST_UNALIGNED
 186         if (3 & (intptr_t) s->buf_ptr) {
 187             AV_WB32(s->buf_ptr, bit_buf);
 188         } else
 189 #endif
 190         *(uint32_t *)s->buf_ptr = av_be2ne32(bit_buf);
 191         //printf("bitbuf = %08x\n", bit_buf);
 192         s->buf_ptr+=4;
 193         bit_left+=32 - n;
 194         bit_buf = value;
 195     }
 196 #endif
 197
 198     s->bit_buf = bit_buf;
 199     s->bit_left = bit_left;
 200 }
 201 #else  /* ALT_BITSTREAM_WRITER defined */
 202 {
 203 #    ifdef ALIGNED_BITSTREAM_WRITER
 204 #        if ARCH_X86
 205     __asm__ volatile(
 206         "movl %0, %%ecx                 \n\t"
 207         "xorl %%eax, %%eax              \n\t"
 208         "shrdl %%cl, %1, %%eax          \n\t"
 209         "shrl %%cl, %1                  \n\t"
 210         "movl %0, %%ecx                 \n\t"
 211         "shrl $3, %%ecx                 \n\t"
 212         "andl $0xFFFFFFFC, %%ecx        \n\t"
 213         "bswapl %1                      \n\t"
 214         "orl %1, (%2, %%ecx)            \n\t"
 215         "bswapl %%eax                   \n\t"
 216         "addl %3, %0                    \n\t"
 217         "movl %%eax, 4(%2, %%ecx)       \n\t"
 218         : "=&r" (s->index), "=&r" (value)
 219         : "r" (s->buf), "r" (n), "0" (s->index), "1" (value<<(-n))
 220         : "%eax", "%ecx"
 221     );
 222 #        else
 223     int index= s->index;
 224     uint32_t *ptr= ((uint32_t *)s->buf)+(index>>5);
 225
 226     value<<= 32-n;
 227
 228     ptr[0] |= av_be2ne32(value>>(index&31));
 229     ptr[1]  = av_be2ne32(value<<(32-(index&31)));
 230 //if(n>24) printf("%d %d\n", n, value);
 231     index+= n;
 232     s->index= index;
 233 #        endif
 234 #    else //ALIGNED_BITSTREAM_WRITER
 235 #        if ARCH_X86
 236     __asm__ volatile(
 237         "movl $7, %%ecx                 \n\t"
 238         "andl %0, %%ecx                 \n\t"
 239         "addl %3, %%ecx                 \n\t"
 240         "negl %%ecx                     \n\t"
 241         "shll %%cl, %1                  \n\t"
 242         "bswapl %1                      \n\t"
 243         "movl %0, %%ecx                 \n\t"
 244         "shrl $3, %%ecx                 \n\t"
 245         "orl %1, (%%ecx, %2)            \n\t"
 246         "addl %3, %0                    \n\t"
 247         "movl $0, 4(%%ecx, %2)          \n\t"
 248         : "=&r" (s->index), "=&r" (value)
 249         : "r" (s->buf), "r" (n), "0" (s->index), "1" (value)
 250         : "%ecx"
 251     );
 252 #        else
 253     int index= s->index;
 254     uint32_t *ptr= (uint32_t*)(((uint8_t *)s->buf)+(index>>3));
 255
 256     ptr[0] |= av_be2ne32(value<<(32-n-(index&7) ));
 257     ptr[1] = 0;
 258 //if(n>24) printf("%d %d\n", n, value);
 259     index+= n;
 260     s->index= index;
 261 #        endif
 262 #    endif //!ALIGNED_BITSTREAM_WRITER
 263 }
 264 #endif
 265
 266 static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
 267 {
 268     assert(n >= 0 && n <= 31);
 269
 270     put_bits(pb, n, value & ((1<<n)-1));
 271 }
 272
 273 /**
 274  * Write exactly 32 bits into a bitstream.
 275  */
 276 static void av_unused put_bits32(PutBitContext *s, uint32_t value)
 277 {
 278     int lo = value & 0xffff;
 279     int hi = value >> 16;
 280 #ifdef BITSTREAM_WRITER_LE
 281     put_bits(s, 16, lo);
 282     put_bits(s, 16, hi);
 283 #else
 284     put_bits(s, 16, hi);
 285     put_bits(s, 16, lo);
 286 #endif
 287 }
 288
 289 /**
 290  * Return the pointer to the byte where the bitstream writer will put
 291  * the next bit.
 292  */
 293 static inline uint8_t* put_bits_ptr(PutBitContext *s)
 294 {
 295 #ifdef ALT_BITSTREAM_WRITER
 296         return s->buf + (s->index>>3);
 297 #else
 298         return s->buf_ptr;
 299 #endif
 300 }
 301
 302 /**
 303  * Skip the given number of bytes.
 304  * PutBitContext must be flushed & aligned to a byte boundary before calling this.
 305  */
 306 static inline void skip_put_bytes(PutBitContext *s, int n)
 307 {
 308         assert((put_bits_count(s)&7)==0);
 309 #ifdef ALT_BITSTREAM_WRITER
 310         FIXME may need some cleaning of the buffer
 311         s->index += n<<3;
 312 #else
 313         assert(s->bit_left==32);
 314         s->buf_ptr += n;
 315 #endif
 316 }
 317
 318 /**
 319  * Skip the given number of bits.
 320  * Must only be used if the actual values in the bitstream do not matter.
 321  * If n is 0 the behavior is undefined.
 322  */
 323 static inline void skip_put_bits(PutBitContext *s, int n)
 324 {
 325 #ifdef ALT_BITSTREAM_WRITER
 326     s->index += n;
 327 #else
 328     s->bit_left -= n;
 329     s->buf_ptr-= 4*(s->bit_left>>5);
 330     s->bit_left &= 31;
 331 #endif
 332 }
 333
 334 /**
 335  * Change the end of the buffer.
 336  *
 337  * @param size the new size in bytes of the buffer where to put bits
 338  */
 339 static inline void set_put_bits_buffer_size(PutBitContext *s, int size)
 340 {
 341     s->buf_end= s->buf + size;
 342 }
 343
 344 #endif /* AVCODEC_PUT_BITS_H */