[cvs] / xvidcore / src / bitstream / bitstream.h Repository:
ViewVC logotype

Annotation of /xvidcore/src/bitstream/bitstream.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.20 - (view) (download)

1 : edgomez 1.18 /*****************************************************************************
2 :     *
3 :     * XVID MPEG-4 VIDEO CODEC
4 :     * - Bitstream reader/writer inlined functions and constants-
5 :     *
6 : edgomez 1.19 * Copyright (C) 2001-2003 Peter Ross <pross@xvid.org>
7 : edgomez 1.18 *
8 : edgomez 1.19 * This program is free software ; you can redistribute it and/or modify
9 :     * it under the terms of the GNU General Public License as published by
10 :     * the Free Software Foundation ; either version 2 of the License, or
11 : edgomez 1.18 * (at your option) any later version.
12 :     *
13 :     * This program is distributed in the hope that it will be useful,
14 : edgomez 1.19 * but WITHOUT ANY WARRANTY ; without even the implied warranty of
15 : edgomez 1.18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 :     * GNU General Public License for more details.
17 :     *
18 :     * You should have received a copy of the GNU General Public License
19 : edgomez 1.19 * along with this program ; if not, write to the Free Software
20 : edgomez 1.18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 :     *
22 : syskin 1.20 * $Id: bitstream.h,v 1.19 2004/03/22 22:36:23 edgomez Exp $
23 : edgomez 1.18 *
24 :     ****************************************************************************/
25 : Isibaar 1.1
26 :     #ifndef _BITSTREAM_H_
27 :     #define _BITSTREAM_H_
28 :    
29 :     #include "../portab.h"
30 :     #include "../decoder.h"
31 :     #include "../encoder.h"
32 :    
33 : edgomez 1.11
34 : edgomez 1.18 /*****************************************************************************
35 :     * Constants
36 :     ****************************************************************************/
37 :    
38 :     /* comment any #defs we dont use */
39 : Isibaar 1.1
40 :     #define VIDOBJ_START_CODE 0x00000100 /* ..0x0000011f */
41 :     #define VIDOBJLAY_START_CODE 0x00000120 /* ..0x0000012f */
42 :     #define VISOBJSEQ_START_CODE 0x000001b0
43 :     #define VISOBJSEQ_STOP_CODE 0x000001b1 /* ??? */
44 :     #define USERDATA_START_CODE 0x000001b2
45 :     #define GRPOFVOP_START_CODE 0x000001b3
46 : edgomez 1.18 /*#define VIDSESERR_ERROR_CODE 0x000001b4 */
47 : Isibaar 1.1 #define VISOBJ_START_CODE 0x000001b5
48 : edgomez 1.17 #define VOP_START_CODE 0x000001b6
49 : edgomez 1.18 /*#define STUFFING_START_CODE 0x000001c3 */
50 : Isibaar 1.1
51 :    
52 :     #define VISOBJ_TYPE_VIDEO 1
53 : edgomez 1.18 /*#define VISOBJ_TYPE_STILLTEXTURE 2 */
54 :     /*#define VISOBJ_TYPE_MESH 3 */
55 :     /*#define VISOBJ_TYPE_FBA 4 */
56 :     /*#define VISOBJ_TYPE_3DMESH 5 */
57 : Isibaar 1.1
58 :    
59 :     #define VIDOBJLAY_TYPE_SIMPLE 1
60 : edgomez 1.18 /*#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE 2 */
61 : edgomez 1.19 /*#define VIDOBJLAY_TYPE_CORE 3 */
62 :     /*#define VIDOBJLAY_TYPE_MAIN 4 */
63 : edgomez 1.18 /*#define VIDOBJLAY_TYPE_NBIT 5 */
64 :     /*#define VIDOBJLAY_TYPE_ANIM_TEXT 6 */
65 :     /*#define VIDOBJLAY_TYPE_ANIM_MESH 7 */
66 :     /*#define VIDOBJLAY_TYPE_SIMPLE_FACE 8 */
67 :     /*#define VIDOBJLAY_TYPE_STILL_SCALABLE 9 */
68 : edgomez 1.17 #define VIDOBJLAY_TYPE_ART_SIMPLE 10
69 : edgomez 1.18 /*#define VIDOBJLAY_TYPE_CORE_SCALABLE 11 */
70 : edgomez 1.19 /*#define VIDOBJLAY_TYPE_ACE 12 */
71 :     /*#define VIDOBJLAY_TYPE_ADVANCED_SCALABLE_TEXTURE 13 */
72 :     /*#define VIDOBJLAY_TYPE_SIMPLE_FBA 14 */
73 :     /*#define VIDEOJLAY_TYPE_SIMPLE_STUDIO 15*/
74 :     /*#define VIDEOJLAY_TYPE_CORE_STUDIO 16*/
75 :     #define VIDOBJLAY_TYPE_ASP 17
76 :     /*#define VIDOBJLAY_TYPE_FGS 18*/
77 : edgomez 1.17
78 :    
79 : edgomez 1.18 /*#define VIDOBJLAY_AR_SQUARE 1 */
80 :     /*#define VIDOBJLAY_AR_625TYPE_43 2 */
81 :     /*#define VIDOBJLAY_AR_525TYPE_43 3 */
82 :     /*#define VIDOBJLAY_AR_625TYPE_169 8 */
83 :     /*#define VIDOBJLAY_AR_525TYPE_169 9 */
84 : Isibaar 1.1 #define VIDOBJLAY_AR_EXTPAR 15
85 :    
86 :    
87 :     #define VIDOBJLAY_SHAPE_RECTANGULAR 0
88 :     #define VIDOBJLAY_SHAPE_BINARY 1
89 :     #define VIDOBJLAY_SHAPE_BINARY_ONLY 2
90 :     #define VIDOBJLAY_SHAPE_GRAYSCALE 3
91 :    
92 : edgomez 1.17
93 :     #define SPRITE_NONE 0
94 :     #define SPRITE_STATIC 1
95 :     #define SPRITE_GMC 2
96 :    
97 :    
98 : Isibaar 1.1
99 :     #define READ_MARKER() BitstreamSkip(bs, 1)
100 :     #define WRITE_MARKER() BitstreamPutBit(bs, 1)
101 :    
102 : edgomez 1.18 /* vop coding types */
103 :     /* intra, prediction, backward, sprite, not_coded */
104 : Isibaar 1.1 #define I_VOP 0
105 :     #define P_VOP 1
106 :     #define B_VOP 2
107 :     #define S_VOP 3
108 :     #define N_VOP 4
109 :    
110 : edgomez 1.18 /* resync-specific */
111 : suxen_drol 1.9 #define NUMBITS_VP_RESYNC_MARKER 17
112 :     #define RESYNC_MARKER 1
113 :    
114 :    
115 : edgomez 1.18 /*****************************************************************************
116 :     * Prototypes
117 :     ****************************************************************************/
118 :    
119 : edgomez 1.19 int read_video_packet_header(Bitstream *bs,
120 :     DECODER * dec,
121 :     const int addbits,
122 :     int *quant,
123 : edgomez 1.18 int *fcode_forward,
124 :     int *fcode_backward,
125 :     int *intra_dc_threshold);
126 : suxen_drol 1.9
127 : edgomez 1.18 /* header stuff */
128 : edgomez 1.6 int BitstreamReadHeaders(Bitstream * bs,
129 :     DECODER * dec,
130 :     uint32_t * rounding,
131 :     uint32_t * quant,
132 :     uint32_t * fcode_forward,
133 :     uint32_t * fcode_backward,
134 : edgomez 1.17 uint32_t * intra_dc_threshold,
135 :     WARPPOINTS * gmc_warp);
136 : Isibaar 1.1
137 :    
138 :     void BitstreamWriteVolHeader(Bitstream * const bs,
139 : edgomez 1.6 const MBParam * pParam,
140 : edgomez 1.17 const FRAMEINFO * const frame);
141 : Isibaar 1.1
142 :     void BitstreamWriteVopHeader(Bitstream * const bs,
143 : edgomez 1.6 const MBParam * pParam,
144 : edgomez 1.17 const FRAMEINFO * const frame,
145 : edgomez 1.19 int vop_coded,
146 :     unsigned int quant);
147 : Isibaar 1.1
148 : edgomez 1.19 void BitstreamWriteUserData(Bitstream * const bs,
149 :     uint8_t * data,
150 : edgomez 1.17 const int length);
151 : edgomez 1.11
152 : Isibaar 1.1 /* initialise bitstream structure */
153 :    
154 : edgomez 1.6 static void __inline
155 :     BitstreamInit(Bitstream * const bs,
156 :     void *const bitstream,
157 :     uint32_t length)
158 : Isibaar 1.1 {
159 :     uint32_t tmp;
160 : edgomez 1.18 size_t bitpos;
161 :     ptr_t adjbitstream = (ptr_t)bitstream;
162 : Isibaar 1.1
163 : edgomez 1.18 /*
164 :     * Start the stream on a uint32_t boundary, by rounding down to the
165 :     * previous uint32_t and skipping the intervening bytes.
166 :     */
167 :     bitpos = ((sizeof(uint32_t)-1) & (size_t)bitstream);
168 :     adjbitstream = adjbitstream - bitpos;
169 :     bs->start = bs->tail = (uint32_t *) adjbitstream;
170 : Isibaar 1.1
171 : edgomez 1.18 tmp = *bs->start;
172 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
173 :     BSWAP(tmp);
174 :     #endif
175 :     bs->bufa = tmp;
176 :    
177 : edgomez 1.18 tmp = *(bs->start + 1);
178 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
179 :     BSWAP(tmp);
180 :     #endif
181 :     bs->bufb = tmp;
182 :    
183 :     bs->buf = 0;
184 : edgomez 1.18 bs->pos = bs->initpos = bitpos*8;
185 : Isibaar 1.1 bs->length = length;
186 :     }
187 :    
188 :    
189 :     /* reset bitstream state */
190 :    
191 : edgomez 1.6 static void __inline
192 :     BitstreamReset(Bitstream * const bs)
193 : Isibaar 1.1 {
194 :     uint32_t tmp;
195 :    
196 :     bs->tail = bs->start;
197 :    
198 :     tmp = *bs->start;
199 :     #ifndef ARCH_IS_BIG_ENDIAN
200 :     BSWAP(tmp);
201 :     #endif
202 :     bs->bufa = tmp;
203 :    
204 :     tmp = *(bs->start + 1);
205 :     #ifndef ARCH_IS_BIG_ENDIAN
206 :     BSWAP(tmp);
207 :     #endif
208 :     bs->bufb = tmp;
209 :    
210 :     bs->buf = 0;
211 : edgomez 1.18 bs->pos = bs->initpos;
212 : Isibaar 1.1 }
213 :    
214 :    
215 :     /* reads n bits from bitstream without changing the stream pos */
216 :    
217 : edgomez 1.6 static uint32_t __inline
218 :     BitstreamShowBits(Bitstream * const bs,
219 :     const uint32_t bits)
220 : Isibaar 1.1 {
221 :     int nbit = (bits + bs->pos) - 32;
222 : edgomez 1.6
223 :     if (nbit > 0) {
224 :     return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs->
225 :     bufb >> (32 -
226 :     nbit));
227 :     } else {
228 : Isibaar 1.1 return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);
229 :     }
230 :     }
231 :    
232 :    
233 :     /* skip n bits forward in bitstream */
234 :    
235 : edgomez 1.17 static __inline void
236 : edgomez 1.6 BitstreamSkip(Bitstream * const bs,
237 :     const uint32_t bits)
238 : Isibaar 1.1 {
239 :     bs->pos += bits;
240 :    
241 : edgomez 1.6 if (bs->pos >= 32) {
242 : Isibaar 1.1 uint32_t tmp;
243 :    
244 :     bs->bufa = bs->bufb;
245 : edgomez 1.6 tmp = *((uint32_t *) bs->tail + 2);
246 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
247 :     BSWAP(tmp);
248 :     #endif
249 :     bs->bufb = tmp;
250 :     bs->tail++;
251 :     bs->pos -= 32;
252 :     }
253 :     }
254 : suxen_drol 1.9
255 :    
256 : edgomez 1.18 /* number of bits to next byte alignment */
257 : edgomez 1.19 static __inline uint32_t
258 : suxen_drol 1.9 BitstreamNumBitsToByteAlign(Bitstream *bs)
259 :     {
260 :     uint32_t n = (32 - bs->pos) % 8;
261 :     return n == 0 ? 8 : n;
262 :     }
263 :    
264 :    
265 : edgomez 1.18 /* show nbits from next byte alignment */
266 : edgomez 1.17 static __inline uint32_t
267 : suxen_drol 1.9 BitstreamShowBitsFromByteAlign(Bitstream *bs, int bits)
268 :     {
269 :     int bspos = bs->pos + BitstreamNumBitsToByteAlign(bs);
270 :     int nbit = (bits + bspos) - 32;
271 :    
272 :     if (bspos >= 32) {
273 :     return bs->bufb >> (32 - nbit);
274 :     } else if (nbit > 0) {
275 :     return ((bs->bufa & (0xffffffff >> bspos)) << nbit) | (bs->
276 :     bufb >> (32 -
277 :     nbit));
278 :     } else {
279 :     return (bs->bufa & (0xffffffff >> bspos)) >> (32 - bspos - bits);
280 :     }
281 :    
282 :     }
283 :    
284 : Isibaar 1.1
285 :    
286 :     /* move forward to the next byte boundary */
287 :    
288 : edgomez 1.17 static __inline void
289 : edgomez 1.6 BitstreamByteAlign(Bitstream * const bs)
290 : Isibaar 1.1 {
291 :     uint32_t remainder = bs->pos % 8;
292 : edgomez 1.6
293 :     if (remainder) {
294 : Isibaar 1.1 BitstreamSkip(bs, 8 - remainder);
295 :     }
296 :     }
297 :    
298 :    
299 :     /* bitstream length (unit bits) */
300 :    
301 : edgomez 1.6 static uint32_t __inline
302 :     BitstreamPos(const Bitstream * const bs)
303 : Isibaar 1.1 {
304 : edgomez 1.18 return((uint32_t)(8*((ptr_t)bs->tail - (ptr_t)bs->start) + bs->pos - bs->initpos));
305 : Isibaar 1.1 }
306 :    
307 :    
308 : edgomez 1.18 /*
309 :     * flush the bitstream & return length (unit bytes)
310 :     * NOTE: assumes no futher bitstream functions will be called.
311 : Isibaar 1.1 */
312 :    
313 : edgomez 1.6 static uint32_t __inline
314 :     BitstreamLength(Bitstream * const bs)
315 : Isibaar 1.1 {
316 : edgomez 1.18 uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start);
317 : Isibaar 1.1
318 : edgomez 1.6 if (bs->pos) {
319 : Isibaar 1.1 uint32_t b = bs->buf;
320 : edgomez 1.6
321 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
322 :     BSWAP(b);
323 :     #endif
324 :     *bs->tail = b;
325 :    
326 :     len += (bs->pos + 7) / 8;
327 : edgomez 1.6 }
328 : Isibaar 1.1
329 : edgomez 1.18 /* initpos is always on a byte boundary */
330 :     if (bs->initpos)
331 :     len -= bs->initpos/8;
332 :    
333 : Isibaar 1.1 return len;
334 :     }
335 :    
336 :    
337 :     /* move bitstream position forward by n bits and write out buffer if needed */
338 :    
339 : edgomez 1.6 static void __inline
340 :     BitstreamForward(Bitstream * const bs,
341 :     const uint32_t bits)
342 : Isibaar 1.1 {
343 : edgomez 1.6 bs->pos += bits;
344 : Isibaar 1.1
345 : edgomez 1.6 if (bs->pos >= 32) {
346 : Isibaar 1.1 uint32_t b = bs->buf;
347 : edgomez 1.6
348 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
349 :     BSWAP(b);
350 :     #endif
351 :     *bs->tail++ = b;
352 :     bs->buf = 0;
353 :     bs->pos -= 32;
354 : edgomez 1.6 }
355 : Isibaar 1.1 }
356 :    
357 :     /* read n bits from bitstream */
358 :    
359 : edgomez 1.6 static uint32_t __inline
360 :     BitstreamGetBits(Bitstream * const bs,
361 :     const uint32_t n)
362 : Isibaar 1.1 {
363 :     uint32_t ret = BitstreamShowBits(bs, n);
364 : edgomez 1.6
365 : Isibaar 1.1 BitstreamSkip(bs, n);
366 :     return ret;
367 :     }
368 :    
369 :    
370 :     /* read single bit from bitstream */
371 :    
372 : edgomez 1.6 static uint32_t __inline
373 :     BitstreamGetBit(Bitstream * const bs)
374 : Isibaar 1.1 {
375 :     return BitstreamGetBits(bs, 1);
376 :     }
377 :    
378 :    
379 :     /* write single bit to bitstream */
380 :    
381 : edgomez 1.6 static void __inline
382 :     BitstreamPutBit(Bitstream * const bs,
383 :     const uint32_t bit)
384 : Isibaar 1.1 {
385 : edgomez 1.6 if (bit)
386 : Isibaar 1.1 bs->buf |= (0x80000000 >> bs->pos);
387 :    
388 : edgomez 1.6 BitstreamForward(bs, 1);
389 : Isibaar 1.1 }
390 :    
391 :    
392 :     /* write n bits to bitstream */
393 :    
394 : edgomez 1.6 static void __inline
395 :     BitstreamPutBits(Bitstream * const bs,
396 :     const uint32_t value,
397 :     const uint32_t size)
398 : Isibaar 1.1 {
399 :     uint32_t shift = 32 - bs->pos - size;
400 :    
401 :     if (shift <= 32) {
402 :     bs->buf |= value << shift;
403 :     BitstreamForward(bs, size);
404 :     } else {
405 :     uint32_t remainder;
406 :    
407 :     shift = size - (32 - bs->pos);
408 :     bs->buf |= value >> shift;
409 :     BitstreamForward(bs, size - shift);
410 :     remainder = shift;
411 :    
412 :     shift = 32 - shift;
413 : edgomez 1.6
414 : Isibaar 1.1 bs->buf |= value << shift;
415 :     BitstreamForward(bs, remainder);
416 :     }
417 :     }
418 :    
419 : edgomez 1.17 static const int stuffing_codes[8] =
420 :     {
421 :     /* nbits stuffing code */
422 :     0, /* 1 0 */
423 :     1, /* 2 01 */
424 :     3, /* 3 011 */
425 :     7, /* 4 0111 */
426 :     0xf, /* 5 01111 */
427 :     0x1f, /* 6 011111 */
428 :     0x3f, /* 7 0111111 */
429 :     0x7f, /* 8 01111111 */
430 :     };
431 :    
432 :     /* pad bitstream to the next byte boundary */
433 :    
434 :     static void __inline
435 :     BitstreamPad(Bitstream * const bs)
436 :     {
437 :     int bits = 8 - (bs->pos % 8);
438 :     if (bits < 8)
439 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
440 :     }
441 :    
442 :    
443 : edgomez 1.18 /*
444 : edgomez 1.19 * pad bitstream to the next byte boundary
445 : edgomez 1.18 * alway pad: even if currently at the byte boundary
446 :     */
447 : edgomez 1.17
448 :     static void __inline
449 :     BitstreamPadAlways(Bitstream * const bs)
450 :     {
451 :     int bits = 8 - (bs->pos % 8);
452 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
453 :     }
454 :    
455 : edgomez 1.18 #endif /* _BITSTREAM_H_ */

No admin address has been configured
ViewVC Help
Powered by ViewVC 1.0.4