2 * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
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.
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.
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
23 * bitstream writer API
26 #ifndef AVCODEC_PUT_BITS_H
27 #define AVCODEC_PUT_BITS_H
32 #include "libavutil/bswap.h"
33 #include "libavutil/common.h"
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/log.h"
38 //#define ALT_BITSTREAM_WRITER
39 //#define ALIGNED_BITSTREAM_WRITER
41 /* buf and buf_end must be present and used by every alternative writer. */
42 typedef struct PutBitContext {
43 #ifdef ALT_BITSTREAM_WRITER
44 uint8_t *buf, *buf_end;
49 uint8_t *buf, *buf_ptr, *buf_end;
55 * Initialize the PutBitContext s.
57 * @param buffer the buffer where to put bits
58 * @param buffer_size the size in bytes of buffer
60 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
67 s->size_in_bits= 8*buffer_size;
69 s->buf_end = s->buf + buffer_size;
70 #ifdef ALT_BITSTREAM_WRITER
72 ((uint32_t*)(s->buf))[0]=0;
73 // memset(buffer, 0, buffer_size);
82 * @return the total number of bits written to the bitstream.
84 static inline int put_bits_count(PutBitContext *s)
86 #ifdef ALT_BITSTREAM_WRITER
89 return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
94 * Pad the end of the output stream with zeros.
96 static inline void flush_put_bits(PutBitContext *s)
98 #ifdef ALT_BITSTREAM_WRITER
101 #ifndef BITSTREAM_WRITER_LE
102 s->bit_buf<<= s->bit_left;
104 while (s->bit_left < 32) {
105 /* XXX: should test end of buffer */
106 #ifdef BITSTREAM_WRITER_LE
107 *s->buf_ptr++=s->bit_buf;
110 *s->buf_ptr++=s->bit_buf >> 24;
120 #if defined(ALT_BITSTREAM_WRITER) || defined(BITSTREAM_WRITER_LE)
121 #define align_put_bits align_put_bits_unsupported_here
122 #define ff_put_string ff_put_string_unsupported_here
123 #define ff_copy_bits ff_copy_bits_unsupported_here
126 * Pad the bitstream with zeros up to the next byte boundary.
128 void align_put_bits(PutBitContext *s);
131 * Put the string string in the bitstream.
133 * @param terminate_string 0-terminates the written string if value is 1
135 void ff_put_string(PutBitContext *pb, const char *string, int terminate_string);
138 * Copy the content of src to the bitstream.
140 * @param length the number of bits of src to copy
142 void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
146 * Write up to 31 bits into a bitstream.
147 * Use put_bits32 to write 32 bits.
149 static inline void put_bits(PutBitContext *s, int n, unsigned int value)
150 #ifndef ALT_BITSTREAM_WRITER
152 unsigned int bit_buf;
155 // printf("put_bits=%d %x\n", n, value);
156 assert(n <= 31 && value < (1U << n));
158 bit_buf = s->bit_buf;
159 bit_left = s->bit_left;
161 // printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
163 #ifdef BITSTREAM_WRITER_LE
164 bit_buf |= value << (32 - bit_left);
166 #if !HAVE_FAST_UNALIGNED
167 if (3 & (intptr_t) s->buf_ptr) {
168 AV_WL32(s->buf_ptr, bit_buf);
171 *(uint32_t *)s->buf_ptr = av_le2ne32(bit_buf);
173 bit_buf = (bit_left==32)?0:value >> bit_left;
179 bit_buf = (bit_buf<<n) | value;
183 bit_buf |= value >> (n - bit_left);
184 #if !HAVE_FAST_UNALIGNED
185 if (3 & (intptr_t) s->buf_ptr) {
186 AV_WB32(s->buf_ptr, bit_buf);
189 *(uint32_t *)s->buf_ptr = av_be2ne32(bit_buf);
190 //printf("bitbuf = %08x\n", bit_buf);
197 s->bit_buf = bit_buf;
198 s->bit_left = bit_left;
200 #else /* ALT_BITSTREAM_WRITER defined */
202 # ifdef ALIGNED_BITSTREAM_WRITER
205 "movl %0, %%ecx \n\t"
206 "xorl %%eax, %%eax \n\t"
207 "shrdl %%cl, %1, %%eax \n\t"
209 "movl %0, %%ecx \n\t"
210 "shrl $3, %%ecx \n\t"
211 "andl $0xFFFFFFFC, %%ecx \n\t"
213 "orl %1, (%2, %%ecx) \n\t"
216 "movl %%eax, 4(%2, %%ecx) \n\t"
217 : "=&r" (s->index), "=&r" (value)
218 : "r" (s->buf), "r" (n), "0" (s->index), "1" (value<<(-n))
223 uint32_t *ptr= ((uint32_t *)s->buf)+(index>>5);
227 ptr[0] |= av_be2ne32(value>>(index&31));
228 ptr[1] = av_be2ne32(value<<(32-(index&31)));
229 //if(n>24) printf("%d %d\n", n, value);
233 # else //ALIGNED_BITSTREAM_WRITER
236 "movl $7, %%ecx \n\t"
237 "andl %0, %%ecx \n\t"
238 "addl %3, %%ecx \n\t"
242 "movl %0, %%ecx \n\t"
243 "shrl $3, %%ecx \n\t"
244 "orl %1, (%%ecx, %2) \n\t"
246 "movl $0, 4(%%ecx, %2) \n\t"
247 : "=&r" (s->index), "=&r" (value)
248 : "r" (s->buf), "r" (n), "0" (s->index), "1" (value)
253 uint32_t *ptr= (uint32_t*)(((uint8_t *)s->buf)+(index>>3));
255 ptr[0] |= av_be2ne32(value<<(32-n-(index&7) ));
257 //if(n>24) printf("%d %d\n", n, value);
261 # endif //!ALIGNED_BITSTREAM_WRITER
265 static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
267 assert(n >= 0 && n <= 31);
269 put_bits(pb, n, value & ((1<<n)-1));
273 * Write exactly 32 bits into a bitstream.
275 static void av_unused put_bits32(PutBitContext *s, uint32_t value)
277 int lo = value & 0xffff;
278 int hi = value >> 16;
279 #ifdef BITSTREAM_WRITER_LE
289 * Return the pointer to the byte where the bitstream writer will put
292 static inline uint8_t* put_bits_ptr(PutBitContext *s)
294 #ifdef ALT_BITSTREAM_WRITER
295 return s->buf + (s->index>>3);
302 * Skip the given number of bytes.
303 * PutBitContext must be flushed & aligned to a byte boundary before calling this.
305 static inline void skip_put_bytes(PutBitContext *s, int n)
307 assert((put_bits_count(s)&7)==0);
308 #ifdef ALT_BITSTREAM_WRITER
309 FIXME may need some cleaning of the buffer
312 assert(s->bit_left==32);
318 * Skip the given number of bits.
319 * Must only be used if the actual values in the bitstream do not matter.
320 * If n is 0 the behavior is undefined.
322 static inline void skip_put_bits(PutBitContext *s, int n)
324 #ifdef ALT_BITSTREAM_WRITER
328 s->buf_ptr-= 4*(s->bit_left>>5);
334 * Change the end of the buffer.
336 * @param size the new size in bytes of the buffer where to put bits
338 static inline void set_put_bits_buffer_size(PutBitContext *s, int size)
340 s->buf_end= s->buf + size;
343 #endif /* AVCODEC_PUT_BITS_H */