put_bits.h 5.65 KB
Newer Older
1 2 3
/*
 * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
 *
4
 * This file is part of Libav.
5
 *
6
 * Libav is free software; you can redistribute it and/or
7 8 9 10
 * 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.
 *
11
 * Libav is distributed in the hope that it will be useful,
12 13 14 15 16
 * 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
17
 * License along with Libav; if not, write to the Free Software
18 19 20 21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
22
 * @file
23 24 25 26 27 28 29 30 31
 * bitstream writer API
 */

#ifndef AVCODEC_PUT_BITS_H
#define AVCODEC_PUT_BITS_H

#include <stdint.h>
#include <stdlib.h>
#include <assert.h>
32

33 34 35 36 37
#include "libavutil/bswap.h"
#include "libavutil/common.h"
#include "libavutil/intreadwrite.h"
#include "libavutil/log.h"
#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
static inline void init_put_bits(PutBitContext *s, uint8_t *buffer,
                                 int buffer_size)
55
{
56
    if (buffer_size < 0) {
57
        buffer_size = 0;
58
        buffer      = NULL;
59 60
    }

61 62 63 64 65 66
    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;
67 68 69
}

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

/**
78
 * Pad the end of the output stream with zeros.
79 80 81 82
 */
static inline void flush_put_bits(PutBitContext *s)
{
#ifndef BITSTREAM_WRITER_LE
83
    if (s->bit_left < 32)
84
        s->bit_buf <<= s->bit_left;
85 86 87 88
#endif
    while (s->bit_left < 32) {
        /* XXX: should test end of buffer */
#ifdef BITSTREAM_WRITER_LE
89 90
        *s->buf_ptr++ = s->bit_buf;
        s->bit_buf  >>= 8;
91
#else
92 93
        *s->buf_ptr++ = s->bit_buf >> 24;
        s->bit_buf  <<= 8;
94
#endif
95
        s->bit_left  += 8;
96
    }
97 98
    s->bit_left = 32;
    s->bit_buf  = 0;
99 100
}

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

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

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

127
/**
128
 * Write up to 31 bits into a bitstream.
129 130
 * Use put_bits32 to write 32 bits.
 */
131 132 133 134 135
static inline void put_bits(PutBitContext *s, int n, unsigned int value)
{
    unsigned int bit_buf;
    int bit_left;

136
    assert(n <= 31 && value < (1U << n));
137

138
    bit_buf  = s->bit_buf;
139 140 141 142 143 144
    bit_left = s->bit_left;

    /* XXX: optimize */
#ifdef BITSTREAM_WRITER_LE
    bit_buf |= value << (32 - bit_left);
    if (n >= bit_left) {
145
        AV_WL32(s->buf_ptr, bit_buf);
146 147 148
        s->buf_ptr += 4;
        bit_buf     = (bit_left == 32) ? 0 : value >> bit_left;
        bit_left   += 32;
149
    }
150
    bit_left -= n;
151 152
#else
    if (n < bit_left) {
153 154
        bit_buf     = (bit_buf << n) | value;
        bit_left   -= n;
155
    } else {
156 157
        bit_buf   <<= bit_left;
        bit_buf    |= value >> (n - bit_left);
158
        AV_WB32(s->buf_ptr, bit_buf);
159 160 161
        s->buf_ptr += 4;
        bit_left   += 32 - n;
        bit_buf     = value;
162 163 164
    }
#endif

165
    s->bit_buf  = bit_buf;
166 167 168
    s->bit_left = bit_left;
}

169
static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
170
{
171
    assert(n >= 0 && n <= 31);
172

173
    put_bits(pb, n, value & ((1 << n) - 1));
174 175
}

176
/**
177
 * Write exactly 32 bits into a bitstream.
178 179 180 181 182
 */
static void av_unused put_bits32(PutBitContext *s, uint32_t value)
{
    int lo = value & 0xffff;
    int hi = value >> 16;
183
#ifdef BITSTREAM_WRITER_LE
184 185 186 187 188 189 190 191
    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
192
/**
193
 * Return the pointer to the byte where the bitstream writer will put
Stefano Sabatini's avatar
Stefano Sabatini committed
194 195
 * the next bit.
 */
196
static inline uint8_t *put_bits_ptr(PutBitContext *s)
197
{
198
    return s->buf_ptr;
199 200 201
}

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

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

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

#endif /* AVCODEC_PUT_BITS_H */