Update to MPlayer SVN rev 29978 and FFmpeg SVN rev 20757.
[vaapi:challenzhous-mplayer.git] / libavcodec / .svn / text-base / put_bits.h.svn-base
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 libavcodec/put_bits.h
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 "mathops.h"
37
38 //#define ALT_BITSTREAM_WRITER
39 //#define ALIGNED_BITSTREAM_WRITER
40
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;
45     int index;
46 #else
47     uint32_t bit_buf;
48     int bit_left;
49     uint8_t *buf, *buf_ptr, *buf_end;
50 #endif
51     int size_in_bits;
52 } PutBitContext;
53
54 /**
55  * Initializes the PutBitContext s.
56  *
57  * @param buffer the buffer where to put bits
58  * @param buffer_size the size in bytes of buffer
59  */
60 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
61 {
62     if(buffer_size < 0) {
63         buffer_size = 0;
64         buffer = NULL;
65     }
66
67     s->size_in_bits= 8*buffer_size;
68     s->buf = buffer;
69     s->buf_end = s->buf + buffer_size;
70 #ifdef ALT_BITSTREAM_WRITER
71     s->index=0;
72     ((uint32_t*)(s->buf))[0]=0;
73 //    memset(buffer, 0, buffer_size);
74 #else
75     s->buf_ptr = s->buf;
76     s->bit_left=32;
77     s->bit_buf=0;
78 #endif
79 }
80
81 /**
82  * Returns the total number of bits written to the bitstream.
83  */
84 static inline int put_bits_count(PutBitContext *s)
85 {
86 #ifdef ALT_BITSTREAM_WRITER
87     return s->index;
88 #else
89     return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
90 #endif
91 }
92
93 /**
94  * Pads the end of the output stream with zeros.
95  */
96 static inline void flush_put_bits(PutBitContext *s)
97 {
98 #ifdef ALT_BITSTREAM_WRITER
99     align_put_bits(s);
100 #else
101 #ifndef BITSTREAM_WRITER_LE
102     s->bit_buf<<= s->bit_left;
103 #endif
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;
108         s->bit_buf>>=8;
109 #else
110         *s->buf_ptr++=s->bit_buf >> 24;
111         s->bit_buf<<=8;
112 #endif
113         s->bit_left+=8;
114     }
115     s->bit_left=32;
116     s->bit_buf=0;
117 #endif
118 }
119
120 /**
121  * Pads the bitstream with zeros up to the next byte boundary.
122  */
123 void align_put_bits(PutBitContext *s);
124
125 /**
126  * Puts the string string in the bitstream.
127  *
128  * @param terminate_string 0-terminates the written string if value is 1
129  */
130 void ff_put_string(PutBitContext *pb, const char *string, int terminate_string);
131
132 /**
133  * Copies the content of src to the bitstream.
134  *
135  * @param length the number of bits of src to copy
136  */
137 void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
138
139 /**
140  * Writes up to 31 bits into a bitstream.
141  * Use put_bits32 to write 32 bits.
142  */
143 static inline void put_bits(PutBitContext *s, int n, unsigned int value)
144 #ifndef ALT_BITSTREAM_WRITER
145 {
146     unsigned int bit_buf;
147     int bit_left;
148
149     //    printf("put_bits=%d %x\n", n, value);
150     assert(n <= 31 && value < (1U << n));
151
152     bit_buf = s->bit_buf;
153     bit_left = s->bit_left;
154
155     //    printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
156     /* XXX: optimize */
157 #ifdef BITSTREAM_WRITER_LE
158     bit_buf |= value << (32 - bit_left);
159     if (n >= bit_left) {
160 #if !HAVE_FAST_UNALIGNED
161         if (3 & (intptr_t) s->buf_ptr) {
162             AV_WL32(s->buf_ptr, bit_buf);
163         } else
164 #endif
165         *(uint32_t *)s->buf_ptr = le2me_32(bit_buf);
166         s->buf_ptr+=4;
167         bit_buf = (bit_left==32)?0:value >> bit_left;
168         bit_left+=32;
169     }
170     bit_left-=n;
171 #else
172     if (n < bit_left) {
173         bit_buf = (bit_buf<<n) | value;
174         bit_left-=n;
175     } else {
176         bit_buf<<=bit_left;
177         bit_buf |= value >> (n - bit_left);
178 #if !HAVE_FAST_UNALIGNED
179         if (3 & (intptr_t) s->buf_ptr) {
180             AV_WB32(s->buf_ptr, bit_buf);
181         } else
182 #endif
183         *(uint32_t *)s->buf_ptr = be2me_32(bit_buf);
184         //printf("bitbuf = %08x\n", bit_buf);
185         s->buf_ptr+=4;
186         bit_left+=32 - n;
187         bit_buf = value;
188     }
189 #endif
190
191     s->bit_buf = bit_buf;
192     s->bit_left = bit_left;
193 }
194 #else  /* ALT_BITSTREAM_WRITER defined */
195 {
196 #    ifdef ALIGNED_BITSTREAM_WRITER
197 #        if ARCH_X86
198     __asm__ volatile(
199         "movl %0, %%ecx                 \n\t"
200         "xorl %%eax, %%eax              \n\t"
201         "shrdl %%cl, %1, %%eax          \n\t"
202         "shrl %%cl, %1                  \n\t"
203         "movl %0, %%ecx                 \n\t"
204         "shrl $3, %%ecx                 \n\t"
205         "andl $0xFFFFFFFC, %%ecx        \n\t"
206         "bswapl %1                      \n\t"
207         "orl %1, (%2, %%ecx)            \n\t"
208         "bswapl %%eax                   \n\t"
209         "addl %3, %0                    \n\t"
210         "movl %%eax, 4(%2, %%ecx)       \n\t"
211         : "=&r" (s->index), "=&r" (value)
212         : "r" (s->buf), "r" (n), "0" (s->index), "1" (value<<(-n))
213         : "%eax", "%ecx"
214     );
215 #        else
216     int index= s->index;
217     uint32_t *ptr= ((uint32_t *)s->buf)+(index>>5);
218
219     value<<= 32-n;
220
221     ptr[0] |= be2me_32(value>>(index&31));
222     ptr[1]  = be2me_32(value<<(32-(index&31)));
223 //if(n>24) printf("%d %d\n", n, value);
224     index+= n;
225     s->index= index;
226 #        endif
227 #    else //ALIGNED_BITSTREAM_WRITER
228 #        if ARCH_X86
229     __asm__ volatile(
230         "movl $7, %%ecx                 \n\t"
231         "andl %0, %%ecx                 \n\t"
232         "addl %3, %%ecx                 \n\t"
233         "negl %%ecx                     \n\t"
234         "shll %%cl, %1                  \n\t"
235         "bswapl %1                      \n\t"
236         "movl %0, %%ecx                 \n\t"
237         "shrl $3, %%ecx                 \n\t"
238         "orl %1, (%%ecx, %2)            \n\t"
239         "addl %3, %0                    \n\t"
240         "movl $0, 4(%%ecx, %2)          \n\t"
241         : "=&r" (s->index), "=&r" (value)
242         : "r" (s->buf), "r" (n), "0" (s->index), "1" (value)
243         : "%ecx"
244     );
245 #        else
246     int index= s->index;
247     uint32_t *ptr= (uint32_t*)(((uint8_t *)s->buf)+(index>>3));
248
249     ptr[0] |= be2me_32(value<<(32-n-(index&7) ));
250     ptr[1] = 0;
251 //if(n>24) printf("%d %d\n", n, value);
252     index+= n;
253     s->index= index;
254 #        endif
255 #    endif //!ALIGNED_BITSTREAM_WRITER
256 }
257 #endif
258
259 static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
260 {
261     assert(n >= 0 && n <= 31);
262
263     put_bits(pb, n, value & ((1<<n)-1));
264 }
265
266 /**
267  * Writes exactly 32 bits into a bitstream.
268  */
269 static void av_unused put_bits32(PutBitContext *s, uint32_t value)
270 {
271     int lo = value & 0xffff;
272     int hi = value >> 16;
273 #ifdef BITSTREAM_WRITER_LE
274     put_bits(s, 16, lo);
275     put_bits(s, 16, hi);
276 #else
277     put_bits(s, 16, hi);
278     put_bits(s, 16, lo);
279 #endif
280 }
281
282 /**
283  * Returns the pointer to the byte where the bitstream writer will put
284  * the next bit.
285  */
286 static inline uint8_t* put_bits_ptr(PutBitContext *s)
287 {
288 #ifdef ALT_BITSTREAM_WRITER
289         return s->buf + (s->index>>3);
290 #else
291         return s->buf_ptr;
292 #endif
293 }
294
295 /**
296  * Skips the given number of bytes.
297  * PutBitContext must be flushed & aligned to a byte boundary before calling this.
298  */
299 static inline void skip_put_bytes(PutBitContext *s, int n)
300 {
301         assert((put_bits_count(s)&7)==0);
302 #ifdef ALT_BITSTREAM_WRITER
303         FIXME may need some cleaning of the buffer
304         s->index += n<<3;
305 #else
306         assert(s->bit_left==32);
307         s->buf_ptr += n;
308 #endif
309 }
310
311 /**
312  * Skips the given number of bits.
313  * Must only be used if the actual values in the bitstream do not matter.
314  * If n is 0 the behavior is undefined.
315  */
316 static inline void skip_put_bits(PutBitContext *s, int n)
317 {
318 #ifdef ALT_BITSTREAM_WRITER
319     s->index += n;
320 #else
321     s->bit_left -= n;
322     s->buf_ptr-= 4*(s->bit_left>>5);
323     s->bit_left &= 31;
324 #endif
325 }
326
327 /**
328  * Changes the end of the buffer.
329  *
330  * @param size the new size in bytes of the buffer where to put bits
331  */
332 static inline void set_put_bits_buffer_size(PutBitContext *s, int size)
333 {
334     s->buf_end= s->buf + size;
335 }
336
337 #endif /* AVCODEC_PUT_BITS_H */