put_bits: switch assert to av_assert2()
[ffmpeg.git] / 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 "libavutil/avassert.h"
37 #include "mathops.h"
38 #include "config.h"
39
40 typedef struct PutBitContext {
41     uint32_t bit_buf;
42     int bit_left;
43     uint8_t *buf, *buf_ptr, *buf_end;
44     int size_in_bits;
45 } PutBitContext;
46
47 /**
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 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
54 {
55     if(buffer_size < 0) {
56         buffer_size = 0;
57         buffer = NULL;
58     }
59
60     s->size_in_bits= 8*buffer_size;
61     s->buf = buffer;
62     s->buf_end = s->buf + buffer_size;
63     s->buf_ptr = s->buf;
64     s->bit_left=32;
65     s->bit_buf=0;
66 }
67
68 /**
69  * @return the total number of bits written to the bitstream.
70  */
71 static inline int put_bits_count(PutBitContext *s)
72 {
73     return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
74 }
75
76 /**
77  * Pad the end of the output stream with zeros.
78  */
79 static inline void flush_put_bits(PutBitContext *s)
80 {
81 #ifndef BITSTREAM_WRITER_LE
82     if (s->bit_left < 32)
83         s->bit_buf<<= s->bit_left;
84 #endif
85     while (s->bit_left < 32) {
86         /* XXX: should test end of buffer */
87 #ifdef BITSTREAM_WRITER_LE
88         *s->buf_ptr++=s->bit_buf;
89         s->bit_buf>>=8;
90 #else
91         *s->buf_ptr++=s->bit_buf >> 24;
92         s->bit_buf<<=8;
93 #endif
94         s->bit_left+=8;
95     }
96     s->bit_left=32;
97     s->bit_buf=0;
98 }
99
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  * @param terminate_string 0-terminates the written string if value is 1
114  */
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  * Use put_bits32 to write 32 bits.
128  */
129 static inline void put_bits(PutBitContext *s, int n, unsigned int value)
130 {
131     unsigned int bit_buf;
132     int bit_left;
133
134     //    printf("put_bits=%d %x\n", n, value);
135     av_assert2(n <= 31 && value < (1U << n));
136
137     bit_buf = s->bit_buf;
138     bit_left = s->bit_left;
139
140     //    printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
141     /* XXX: optimize */
142 #ifdef BITSTREAM_WRITER_LE
143     bit_buf |= value << (32 - bit_left);
144     if (n >= bit_left) {
145         AV_WL32(s->buf_ptr, bit_buf);
146         s->buf_ptr+=4;
147         bit_buf = (bit_left==32)?0:value >> bit_left;
148         bit_left+=32;
149     }
150     bit_left-=n;
151 #else
152     if (n < bit_left) {
153         bit_buf = (bit_buf<<n) | value;
154         bit_left-=n;
155     } else {
156         bit_buf<<=bit_left;
157         bit_buf |= value >> (n - bit_left);
158         AV_WB32(s->buf_ptr, bit_buf);
159         //printf("bitbuf = %08x\n", bit_buf);
160         s->buf_ptr+=4;
161         bit_left+=32 - n;
162         bit_buf = value;
163     }
164 #endif
165
166     s->bit_buf = bit_buf;
167     s->bit_left = bit_left;
168 }
169
170 static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
171 {
172     assert(n >= 0 && n <= 31);
173
174     put_bits(pb, n, value & ((1<<n)-1));
175 }
176
177 /**
178  * Write exactly 32 bits into a bitstream.
179  */
180 static void av_unused put_bits32(PutBitContext *s, uint32_t value)
181 {
182     int lo = value & 0xffff;
183     int hi = value >> 16;
184 #ifdef BITSTREAM_WRITER_LE
185     put_bits(s, 16, lo);
186     put_bits(s, 16, hi);
187 #else
188     put_bits(s, 16, hi);
189     put_bits(s, 16, lo);
190 #endif
191 }
192
193 /**
194  * Return the pointer to the byte where the bitstream writer will put
195  * the next bit.
196  */
197 static inline uint8_t* put_bits_ptr(PutBitContext *s)
198 {
199         return s->buf_ptr;
200 }
201
202 /**
203  * Skip the given number of bytes.
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         assert((put_bits_count(s)&7)==0);
209         assert(s->bit_left==32);
210         s->buf_ptr += n;
211 }
212
213 /**
214  * Skip the given number of bits.
215  * Must only be used if the actual values in the bitstream do not matter.
216  * If n is 0 the behavior is undefined.
217  */
218 static inline void skip_put_bits(PutBitContext *s, int n)
219 {
220     s->bit_left -= n;
221     s->buf_ptr-= 4*(s->bit_left>>5);
222     s->bit_left &= 31;
223 }
224
225 /**
226  * Change the end of the buffer.
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 {
232     s->buf_end= s->buf + size;
233 }
234
235 #endif /* AVCODEC_PUT_BITS_H */