[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.22.2.2 - (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 : Isibaar 1.22.2.2 * $Id: bitstream.h,v 1.22.2.1 2006/07/10 15:05:30 Isibaar 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 : Skal 1.22 const char *data,
150 :     const unsigned int length);
151 :    
152 : Skal 1.21 void
153 :     BitstreamWriteEndOfSequence(Bitstream * const bs);
154 :    
155 :     void
156 :     BitstreamWriteGroupOfVopHeader(Bitstream * const bs,
157 :     const MBParam * pParam,
158 :     uint32_t is_closed_gov);
159 :    
160 :     void write_video_packet_header(Bitstream * const bs,
161 :     const MBParam * pParam,
162 :     const FRAMEINFO * const frame,
163 :     int mbnum);
164 : edgomez 1.11
165 : Isibaar 1.22.2.2 /*****************************************************************************
166 :     * Bitstream
167 :     ****************************************************************************/
168 :    
169 :     /* Input buffer should be readable as full chunks of 8bytes, including
170 :     the end of the buffer. Padding might be appropriate. If only chunks
171 :     of 4bytes are applicable, define XVID_SAFE_BS_TAIL. Note that this will
172 :     slow decoding, so consider this as a last-resort solution */
173 :     /* #define XVID_SAFE_BS_TAIL */
174 :    
175 : Isibaar 1.1 /* initialise bitstream structure */
176 :    
177 : edgomez 1.6 static void __inline
178 :     BitstreamInit(Bitstream * const bs,
179 :     void *const bitstream,
180 :     uint32_t length)
181 : Isibaar 1.1 {
182 :     uint32_t tmp;
183 : edgomez 1.18 size_t bitpos;
184 :     ptr_t adjbitstream = (ptr_t)bitstream;
185 : Isibaar 1.1
186 : edgomez 1.18 /*
187 :     * Start the stream on a uint32_t boundary, by rounding down to the
188 :     * previous uint32_t and skipping the intervening bytes.
189 :     */
190 :     bitpos = ((sizeof(uint32_t)-1) & (size_t)bitstream);
191 :     adjbitstream = adjbitstream - bitpos;
192 :     bs->start = bs->tail = (uint32_t *) adjbitstream;
193 : Isibaar 1.1
194 : edgomez 1.18 tmp = *bs->start;
195 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
196 :     BSWAP(tmp);
197 :     #endif
198 :     bs->bufa = tmp;
199 :    
200 : edgomez 1.18 tmp = *(bs->start + 1);
201 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
202 :     BSWAP(tmp);
203 :     #endif
204 :     bs->bufb = tmp;
205 :    
206 : edgomez 1.18 bs->pos = bs->initpos = bitpos*8;
207 : Isibaar 1.22.2.2 /* preserve the intervening bytes */
208 :     if (bs->initpos > 0)
209 :     bs->buf = bs->bufa & (0xffffffff << (32 - bs->initpos));
210 :     else
211 :     bs->buf = 0;
212 : Isibaar 1.1 bs->length = length;
213 :     }
214 :    
215 :    
216 :     /* reset bitstream state */
217 :    
218 : edgomez 1.6 static void __inline
219 :     BitstreamReset(Bitstream * const bs)
220 : Isibaar 1.1 {
221 :     uint32_t tmp;
222 :    
223 :     bs->tail = bs->start;
224 :    
225 :     tmp = *bs->start;
226 :     #ifndef ARCH_IS_BIG_ENDIAN
227 :     BSWAP(tmp);
228 :     #endif
229 :     bs->bufa = tmp;
230 :    
231 :     tmp = *(bs->start + 1);
232 :     #ifndef ARCH_IS_BIG_ENDIAN
233 :     BSWAP(tmp);
234 :     #endif
235 :     bs->bufb = tmp;
236 :    
237 : Isibaar 1.22.2.2 /* preserve the intervening bytes */
238 :     if (bs->initpos > 0)
239 :     bs->buf = bs->bufa & (0xffffffff << (32 - bs->initpos));
240 :     else
241 :     bs->buf = 0;
242 : edgomez 1.18 bs->pos = bs->initpos;
243 : Isibaar 1.1 }
244 :    
245 :    
246 :     /* reads n bits from bitstream without changing the stream pos */
247 :    
248 : edgomez 1.6 static uint32_t __inline
249 :     BitstreamShowBits(Bitstream * const bs,
250 :     const uint32_t bits)
251 : Isibaar 1.1 {
252 :     int nbit = (bits + bs->pos) - 32;
253 : edgomez 1.6
254 :     if (nbit > 0) {
255 :     return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs->
256 :     bufb >> (32 -
257 :     nbit));
258 :     } else {
259 : Isibaar 1.1 return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);
260 :     }
261 :     }
262 :    
263 :    
264 :     /* skip n bits forward in bitstream */
265 :    
266 : edgomez 1.17 static __inline void
267 : edgomez 1.6 BitstreamSkip(Bitstream * const bs,
268 :     const uint32_t bits)
269 : Isibaar 1.1 {
270 :     bs->pos += bits;
271 :    
272 : edgomez 1.6 if (bs->pos >= 32) {
273 : Isibaar 1.1 uint32_t tmp;
274 :    
275 :     bs->bufa = bs->bufb;
276 : Isibaar 1.22.2.2 #if defined(XVID_SAFE_BS_TAIL)
277 :     if (bs->tail<(bs->start+((bs->length+3)>>2)))
278 :     #endif
279 :     {
280 :     tmp = *((uint32_t *) bs->tail + 2);
281 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
282 : Isibaar 1.22.2.2 BSWAP(tmp);
283 :     #endif
284 :     bs->bufb = tmp;
285 :     bs->tail++;
286 :     }
287 :     #if defined(XVID_SAFE_BS_TAIL)
288 :     else {
289 :     bs->bufb = 0;
290 :     }
291 : Isibaar 1.1 #endif
292 :     bs->pos -= 32;
293 :     }
294 :     }
295 : suxen_drol 1.9
296 :    
297 : edgomez 1.18 /* number of bits to next byte alignment */
298 : edgomez 1.19 static __inline uint32_t
299 : suxen_drol 1.9 BitstreamNumBitsToByteAlign(Bitstream *bs)
300 :     {
301 :     uint32_t n = (32 - bs->pos) % 8;
302 :     return n == 0 ? 8 : n;
303 :     }
304 :    
305 :    
306 : edgomez 1.18 /* show nbits from next byte alignment */
307 : edgomez 1.17 static __inline uint32_t
308 : suxen_drol 1.9 BitstreamShowBitsFromByteAlign(Bitstream *bs, int bits)
309 :     {
310 :     int bspos = bs->pos + BitstreamNumBitsToByteAlign(bs);
311 :     int nbit = (bits + bspos) - 32;
312 :    
313 :     if (bspos >= 32) {
314 :     return bs->bufb >> (32 - nbit);
315 :     } else if (nbit > 0) {
316 :     return ((bs->bufa & (0xffffffff >> bspos)) << nbit) | (bs->
317 :     bufb >> (32 -
318 :     nbit));
319 :     } else {
320 :     return (bs->bufa & (0xffffffff >> bspos)) >> (32 - bspos - bits);
321 :     }
322 :    
323 :     }
324 :    
325 : Isibaar 1.1
326 :    
327 :     /* move forward to the next byte boundary */
328 :    
329 : edgomez 1.17 static __inline void
330 : edgomez 1.6 BitstreamByteAlign(Bitstream * const bs)
331 : Isibaar 1.1 {
332 :     uint32_t remainder = bs->pos % 8;
333 : edgomez 1.6
334 :     if (remainder) {
335 : Isibaar 1.1 BitstreamSkip(bs, 8 - remainder);
336 :     }
337 :     }
338 :    
339 :    
340 :     /* bitstream length (unit bits) */
341 :    
342 : edgomez 1.6 static uint32_t __inline
343 :     BitstreamPos(const Bitstream * const bs)
344 : Isibaar 1.1 {
345 : edgomez 1.18 return((uint32_t)(8*((ptr_t)bs->tail - (ptr_t)bs->start) + bs->pos - bs->initpos));
346 : Isibaar 1.1 }
347 :    
348 :    
349 : edgomez 1.18 /*
350 :     * flush the bitstream & return length (unit bytes)
351 :     * NOTE: assumes no futher bitstream functions will be called.
352 : Isibaar 1.1 */
353 :    
354 : edgomez 1.6 static uint32_t __inline
355 :     BitstreamLength(Bitstream * const bs)
356 : Isibaar 1.1 {
357 : edgomez 1.18 uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start);
358 : Isibaar 1.1
359 : edgomez 1.6 if (bs->pos) {
360 : Isibaar 1.1 uint32_t b = bs->buf;
361 : edgomez 1.6
362 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
363 :     BSWAP(b);
364 :     #endif
365 :     *bs->tail = b;
366 :    
367 :     len += (bs->pos + 7) / 8;
368 : edgomez 1.6 }
369 : Isibaar 1.1
370 : edgomez 1.18 /* initpos is always on a byte boundary */
371 :     if (bs->initpos)
372 :     len -= bs->initpos/8;
373 :    
374 : Isibaar 1.1 return len;
375 :     }
376 :    
377 :    
378 :     /* move bitstream position forward by n bits and write out buffer if needed */
379 :    
380 : edgomez 1.6 static void __inline
381 :     BitstreamForward(Bitstream * const bs,
382 :     const uint32_t bits)
383 : Isibaar 1.1 {
384 : edgomez 1.6 bs->pos += bits;
385 : Isibaar 1.1
386 : edgomez 1.6 if (bs->pos >= 32) {
387 : Isibaar 1.1 uint32_t b = bs->buf;
388 : edgomez 1.6
389 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
390 :     BSWAP(b);
391 :     #endif
392 :     *bs->tail++ = b;
393 :     bs->buf = 0;
394 :     bs->pos -= 32;
395 : edgomez 1.6 }
396 : Isibaar 1.1 }
397 :    
398 :     /* read n bits from bitstream */
399 :    
400 : edgomez 1.6 static uint32_t __inline
401 :     BitstreamGetBits(Bitstream * const bs,
402 :     const uint32_t n)
403 : Isibaar 1.1 {
404 :     uint32_t ret = BitstreamShowBits(bs, n);
405 : edgomez 1.6
406 : Isibaar 1.1 BitstreamSkip(bs, n);
407 :     return ret;
408 :     }
409 :    
410 :    
411 :     /* read single bit from bitstream */
412 :    
413 : edgomez 1.6 static uint32_t __inline
414 :     BitstreamGetBit(Bitstream * const bs)
415 : Isibaar 1.1 {
416 :     return BitstreamGetBits(bs, 1);
417 :     }
418 :    
419 :    
420 :     /* write single bit to bitstream */
421 :    
422 : edgomez 1.6 static void __inline
423 :     BitstreamPutBit(Bitstream * const bs,
424 :     const uint32_t bit)
425 : Isibaar 1.1 {
426 : edgomez 1.6 if (bit)
427 : Isibaar 1.1 bs->buf |= (0x80000000 >> bs->pos);
428 :    
429 : edgomez 1.6 BitstreamForward(bs, 1);
430 : Isibaar 1.1 }
431 :    
432 :    
433 :     /* write n bits to bitstream */
434 :    
435 : edgomez 1.6 static void __inline
436 :     BitstreamPutBits(Bitstream * const bs,
437 :     const uint32_t value,
438 :     const uint32_t size)
439 : Isibaar 1.1 {
440 :     uint32_t shift = 32 - bs->pos - size;
441 :    
442 :     if (shift <= 32) {
443 :     bs->buf |= value << shift;
444 :     BitstreamForward(bs, size);
445 :     } else {
446 :     uint32_t remainder;
447 :    
448 :     shift = size - (32 - bs->pos);
449 :     bs->buf |= value >> shift;
450 :     BitstreamForward(bs, size - shift);
451 :     remainder = shift;
452 :    
453 :     shift = 32 - shift;
454 : edgomez 1.6
455 : Isibaar 1.1 bs->buf |= value << shift;
456 :     BitstreamForward(bs, remainder);
457 :     }
458 :     }
459 :    
460 : edgomez 1.17 static const int stuffing_codes[8] =
461 :     {
462 :     /* nbits stuffing code */
463 :     0, /* 1 0 */
464 :     1, /* 2 01 */
465 :     3, /* 3 011 */
466 :     7, /* 4 0111 */
467 :     0xf, /* 5 01111 */
468 :     0x1f, /* 6 011111 */
469 :     0x3f, /* 7 0111111 */
470 :     0x7f, /* 8 01111111 */
471 :     };
472 :    
473 :     /* pad bitstream to the next byte boundary */
474 :    
475 :     static void __inline
476 :     BitstreamPad(Bitstream * const bs)
477 :     {
478 :     int bits = 8 - (bs->pos % 8);
479 :     if (bits < 8)
480 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
481 :     }
482 :    
483 :    
484 : edgomez 1.18 /*
485 : edgomez 1.19 * pad bitstream to the next byte boundary
486 : edgomez 1.18 * alway pad: even if currently at the byte boundary
487 :     */
488 : edgomez 1.17
489 :     static void __inline
490 :     BitstreamPadAlways(Bitstream * const bs)
491 :     {
492 :     int bits = 8 - (bs->pos % 8);
493 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
494 :     }
495 :    
496 : edgomez 1.18 #endif /* _BITSTREAM_H_ */

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