put_bits.h 5.79 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * 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
 */

/**
22
 * @file
23 24 25 26 27 28 29 30 31 32 33 34 35
 * 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"
36
#include "libavutil/avassert.h"
37
#include "mathops.h"
38
#include "config.h"
39 40 41 42 43 44 45 46 47

typedef struct PutBitContext {
    uint32_t bit_buf;
    int bit_left;
    uint8_t *buf, *buf_ptr, *buf_end;
    int size_in_bits;
} PutBitContext;

/**
48
 * Initialize the PutBitContext s.
49 50
 *
 * @param buffer the buffer where to put bits
51
 * @param buffer_size the size in bytes of buffer
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
 */
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;
}

/**
69
 * @return the total number of bits written to the bitstream.
70 71 72 73 74 75 76
 */
static inline int put_bits_count(PutBitContext *s)
{
    return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
}

/**
77
 * Pad the end of the output stream with zeros.
78 79 80 81
 */
static inline void flush_put_bits(PutBitContext *s)
{
#ifndef BITSTREAM_WRITER_LE
82 83
    if (s->bit_left < 32)
        s->bit_buf<<= s->bit_left;
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
#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;
}

100
#ifdef BITSTREAM_WRITER_LE
101
#define avpriv_align_put_bits align_put_bits_unsupported_here
102
#define ff_put_string ff_put_string_unsupported_here
103
#define avpriv_copy_bits avpriv_copy_bits_unsupported_here
104
#else
105
/**
106
 * Pad the bitstream with zeros up to the next byte boundary.
107
 */
108
void avpriv_align_put_bits(PutBitContext *s);
109 110

/**
111
 * Put the string string in the bitstream.
112 113 114
 *
 * @param terminate_string 0-terminates the written string if value is 1
 */
115
void ff_put_string(PutBitContext *pb, const char *string, int terminate_string);
116 117

/**
118
 * Copy the content of src to the bitstream.
119
 *
120
 * @param length the number of bits of src to copy
121
 */
122
void avpriv_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
123
#endif
124

125
/**
126
 * Write up to 31 bits into a bitstream.
127 128
 * Use put_bits32 to write 32 bits.
 */
129 130 131 132 133 134
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);
135
    av_assert2(n <= 31 && value < (1U << n));
136 137 138 139 140 141 142 143 144

    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) {
145
        av_assert2(s->buf_ptr+3<s->buf_end);
146
        AV_WL32(s->buf_ptr, bit_buf);
147 148 149 150 151 152 153 154 155 156 157 158
        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);
159
        av_assert2(s->buf_ptr+3<s->buf_end);
160
        AV_WB32(s->buf_ptr, bit_buf);
161 162 163 164 165 166 167 168 169 170 171
        //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;
}

172
static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
173
{
174
    av_assert2(n >= 0 && n <= 31);
175

176
    put_bits(pb, n, value & ((1<<n)-1));
177 178
}

179
/**
180
 * Write exactly 32 bits into a bitstream.
181 182 183 184 185
 */
static void av_unused put_bits32(PutBitContext *s, uint32_t value)
{
    int lo = value & 0xffff;
    int hi = value >> 16;
186
#ifdef BITSTREAM_WRITER_LE
187 188 189 190 191 192 193 194
    put_bits(s, 16, lo);
    put_bits(s, 16, hi);
#else
    put_bits(s, 16, hi);
    put_bits(s, 16, lo);
#endif
}

Stefano Sabatini's avatar
Stefano Sabatini committed
195
/**
196
 * Return the pointer to the byte where the bitstream writer will put
Stefano Sabatini's avatar
Stefano Sabatini committed
197 198
 * the next bit.
 */
199
static inline uint8_t* put_bits_ptr(PutBitContext *s)
200 201 202 203 204
{
        return s->buf_ptr;
}

/**
205
 * Skip the given number of bytes.
206 207
 * PutBitContext must be flushed & aligned to a byte boundary before calling this.
 */
208 209
static inline void skip_put_bytes(PutBitContext *s, int n)
{
210 211
        av_assert2((put_bits_count(s)&7)==0);
        av_assert2(s->bit_left==32);
212 213 214 215
        s->buf_ptr += n;
}

/**
216
 * Skip the given number of bits.
217
 * Must only be used if the actual values in the bitstream do not matter.
218
 * If n is 0 the behavior is undefined.
219
 */
220 221
static inline void skip_put_bits(PutBitContext *s, int n)
{
222
    s->bit_left -= n;
223
    s->buf_ptr-= 4*(s->bit_left>>5);
224 225 226 227
    s->bit_left &= 31;
}

/**
228
 * Change the end of the buffer.
229 230 231
 *
 * @param size the new size in bytes of the buffer where to put bits
 */
232 233
static inline void set_put_bits_buffer_size(PutBitContext *s, int size)
{
234 235 236 237
    s->buf_end= s->buf + size;
}

#endif /* AVCODEC_PUT_BITS_H */