libavcodec/put_bits.h
b2755007
 /*
  * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
ba87f080
  * @file
b2755007
  * bitstream writer API
  */
 
 #ifndef AVCODEC_PUT_BITS_H
 #define AVCODEC_PUT_BITS_H
 
 #include <stdint.h>
 #include <stdlib.h>
 #include <assert.h>
 #include "libavutil/bswap.h"
 #include "libavutil/common.h"
 #include "libavutil/intreadwrite.h"
 #include "libavutil/log.h"
 #include "mathops.h"
8d459acc
 #include "config.h"
b2755007
 
 typedef struct PutBitContext {
     uint32_t bit_buf;
     int bit_left;
     uint8_t *buf, *buf_ptr, *buf_end;
     int size_in_bits;
 } PutBitContext;
 
 /**
49bd8e4b
  * Initialize the PutBitContext s.
b2755007
  *
  * @param buffer the buffer where to put bits
bf7e799c
  * @param buffer_size the size in bytes of buffer
b2755007
  */
 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
 {
     if(buffer_size < 0) {
         buffer_size = 0;
         buffer = NULL;
     }
 
     s->size_in_bits= 8*buffer_size;
     s->buf = buffer;
     s->buf_end = s->buf + buffer_size;
     s->buf_ptr = s->buf;
     s->bit_left=32;
     s->bit_buf=0;
 }
 
 /**
49bd8e4b
  * @return the total number of bits written to the bitstream.
b2755007
  */
 static inline int put_bits_count(PutBitContext *s)
 {
     return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
 }
 
 /**
49bd8e4b
  * Pad the end of the output stream with zeros.
b2755007
  */
 static inline void flush_put_bits(PutBitContext *s)
 {
 #ifndef BITSTREAM_WRITER_LE
ac6eab14
     if (s->bit_left < 32)
         s->bit_buf<<= s->bit_left;
b2755007
 #endif
     while (s->bit_left < 32) {
         /* XXX: should test end of buffer */
 #ifdef BITSTREAM_WRITER_LE
         *s->buf_ptr++=s->bit_buf;
         s->bit_buf>>=8;
 #else
         *s->buf_ptr++=s->bit_buf >> 24;
         s->bit_buf<<=8;
 #endif
         s->bit_left+=8;
     }
     s->bit_left=32;
     s->bit_buf=0;
 }
 
0d5c349a
 #ifdef BITSTREAM_WRITER_LE
9f51c682
 #define avpriv_align_put_bits align_put_bits_unsupported_here
7f6458a7
 #define ff_put_string ff_put_string_unsupported_here
9f51c682
 #define avpriv_copy_bits avpriv_copy_bits_unsupported_here
7f6458a7
 #else
b2755007
 /**
49bd8e4b
  * Pad the bitstream with zeros up to the next byte boundary.
b2755007
  */
9f51c682
 void avpriv_align_put_bits(PutBitContext *s);
b2755007
 
 /**
49bd8e4b
  * Put the string string in the bitstream.
b2755007
  *
  * @param terminate_string 0-terminates the written string if value is 1
  */
587edd6a
 void ff_put_string(PutBitContext *pb, const char *string, int terminate_string);
b2755007
 
 /**
49bd8e4b
  * Copy the content of src to the bitstream.
b2755007
  *
bf7e799c
  * @param length the number of bits of src to copy
b2755007
  */
9f51c682
 void avpriv_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
7f6458a7
 #endif
b2755007
 
43d7c611
 /**
49bd8e4b
  * Write up to 31 bits into a bitstream.
43d7c611
  * Use put_bits32 to write 32 bits.
  */
b2755007
 static inline void put_bits(PutBitContext *s, int n, unsigned int value)
 {
     unsigned int bit_buf;
     int bit_left;
 
     //    printf("put_bits=%d %x\n", n, value);
43d7c611
     assert(n <= 31 && value < (1U << n));
b2755007
 
     bit_buf = s->bit_buf;
     bit_left = s->bit_left;
 
     //    printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
     /* XXX: optimize */
 #ifdef BITSTREAM_WRITER_LE
     bit_buf |= value << (32 - bit_left);
     if (n >= bit_left) {
30b05520
         AV_WL32(s->buf_ptr, bit_buf);
b2755007
         s->buf_ptr+=4;
         bit_buf = (bit_left==32)?0:value >> bit_left;
         bit_left+=32;
     }
     bit_left-=n;
 #else
     if (n < bit_left) {
         bit_buf = (bit_buf<<n) | value;
         bit_left-=n;
     } else {
         bit_buf<<=bit_left;
         bit_buf |= value >> (n - bit_left);
30b05520
         AV_WB32(s->buf_ptr, bit_buf);
b2755007
         //printf("bitbuf = %08x\n", bit_buf);
         s->buf_ptr+=4;
         bit_left+=32 - n;
         bit_buf = value;
     }
 #endif
 
     s->bit_buf = bit_buf;
     s->bit_left = bit_left;
 }
 
5f1836a7
 static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
b2755007
 {
5f1836a7
     assert(n >= 0 && n <= 31);
b2755007
 
5f1836a7
     put_bits(pb, n, value & ((1<<n)-1));
b2755007
 }
 
53bd67ec
 /**
49bd8e4b
  * Write exactly 32 bits into a bitstream.
43d7c611
  */
 static void av_unused put_bits32(PutBitContext *s, uint32_t value)
 {
     int lo = value & 0xffff;
     int hi = value >> 16;
28f2db96
 #ifdef BITSTREAM_WRITER_LE
43d7c611
     put_bits(s, 16, lo);
     put_bits(s, 16, hi);
 #else
     put_bits(s, 16, hi);
     put_bits(s, 16, lo);
 #endif
 }
 
 /**
49bd8e4b
  * Return the pointer to the byte where the bitstream writer will put
53bd67ec
  * the next bit.
  */
fb53b4a0
 static inline uint8_t* put_bits_ptr(PutBitContext *s)
b2755007
 {
         return s->buf_ptr;
 }
 
 /**
49bd8e4b
  * Skip the given number of bytes.
b2755007
  * PutBitContext must be flushed & aligned to a byte boundary before calling this.
  */
643570d6
 static inline void skip_put_bytes(PutBitContext *s, int n)
 {
b2755007
         assert((put_bits_count(s)&7)==0);
         assert(s->bit_left==32);
         s->buf_ptr += n;
 }
 
 /**
49bd8e4b
  * Skip the given number of bits.
b2755007
  * Must only be used if the actual values in the bitstream do not matter.
bf7e799c
  * If n is 0 the behavior is undefined.
b2755007
  */
643570d6
 static inline void skip_put_bits(PutBitContext *s, int n)
 {
b2755007
     s->bit_left -= n;
ad25b954
     s->buf_ptr-= 4*(s->bit_left>>5);
b2755007
     s->bit_left &= 31;
 }
 
 /**
49bd8e4b
  * Change the end of the buffer.
b2755007
  *
  * @param size the new size in bytes of the buffer where to put bits
  */
643570d6
 static inline void set_put_bits_buffer_size(PutBitContext *s, int size)
 {
b2755007
     s->buf_end= s->buf + size;
 }
 
 #endif /* AVCODEC_PUT_BITS_H */