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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2177 - (view) (download)

1 : edgomez 972 /*****************************************************************************
2 :     *
3 :     * XVID MPEG-4 VIDEO CODEC
4 :     * - Bitstream reader/writer inlined functions and constants-
5 :     *
6 : edgomez 1382 * Copyright (C) 2001-2003 Peter Ross <pross@xvid.org>
7 : edgomez 972 *
8 : edgomez 1382 * 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 972 * (at your option) any later version.
12 :     *
13 :     * This program is distributed in the hope that it will be useful,
14 : edgomez 1382 * but WITHOUT ANY WARRANTY ; without even the implied warranty of
15 : edgomez 972 * 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 1382 * along with this program ; if not, write to the Free Software
20 : edgomez 972 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 :     *
22 : Isibaar 1988 * $Id$
23 : edgomez 972 *
24 :     ****************************************************************************/
25 : Isibaar 3
26 :     #ifndef _BITSTREAM_H_
27 :     #define _BITSTREAM_H_
28 :    
29 :     #include "../portab.h"
30 :     #include "../decoder.h"
31 :     #include "../encoder.h"
32 :    
33 : edgomez 466
34 : edgomez 972 /*****************************************************************************
35 :     * Constants
36 :     ****************************************************************************/
37 : edgomez 466
38 : edgomez 972 /* comment any #defs we dont use */
39 :    
40 : Isibaar 3 #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 972 /*#define VIDSESERR_ERROR_CODE 0x000001b4 */
47 : Isibaar 3 #define VISOBJ_START_CODE 0x000001b5
48 : edgomez 851 #define VOP_START_CODE 0x000001b6
49 : edgomez 972 /*#define STUFFING_START_CODE 0x000001c3 */
50 : Isibaar 3
51 :    
52 :     #define VISOBJ_TYPE_VIDEO 1
53 : edgomez 972 /*#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 3
58 :    
59 :     #define VIDOBJLAY_TYPE_SIMPLE 1
60 : edgomez 972 /*#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE 2 */
61 : edgomez 1382 /*#define VIDOBJLAY_TYPE_CORE 3 */
62 :     /*#define VIDOBJLAY_TYPE_MAIN 4 */
63 : edgomez 972 /*#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 851 #define VIDOBJLAY_TYPE_ART_SIMPLE 10
69 : edgomez 972 /*#define VIDOBJLAY_TYPE_CORE_SCALABLE 11 */
70 : edgomez 1382 /*#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 : Isibaar 3
78 :    
79 : edgomez 972 /*#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 3 #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 :    
93 : edgomez 851 #define SPRITE_NONE 0
94 :     #define SPRITE_STATIC 1
95 :     #define SPRITE_GMC 2
96 :    
97 :    
98 :    
99 : Isibaar 3 #define READ_MARKER() BitstreamSkip(bs, 1)
100 :     #define WRITE_MARKER() BitstreamPutBit(bs, 1)
101 :    
102 : edgomez 972 /* vop coding types */
103 :     /* intra, prediction, backward, sprite, not_coded */
104 : Isibaar 3 #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 972 /* resync-specific */
111 : suxen_drol 248 #define NUMBITS_VP_RESYNC_MARKER 17
112 :     #define RESYNC_MARKER 1
113 : Isibaar 3
114 : suxen_drol 248
115 : edgomez 972 /*****************************************************************************
116 :     * Prototypes
117 :     ****************************************************************************/
118 :    
119 : edgomez 1382 int read_video_packet_header(Bitstream *bs,
120 :     DECODER * dec,
121 :     const int addbits,
122 :     int *quant,
123 : edgomez 972 int *fcode_forward,
124 :     int *fcode_backward,
125 :     int *intra_dc_threshold);
126 : edgomez 466
127 : edgomez 972 /* header stuff */
128 : edgomez 195 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 851 uint32_t * intra_dc_threshold,
135 :     WARPPOINTS * gmc_warp);
136 : Isibaar 3
137 :    
138 :     void BitstreamWriteVolHeader(Bitstream * const bs,
139 : edgomez 195 const MBParam * pParam,
140 : Isibaar 1913 const FRAMEINFO * const frame,
141 :     const int num_slices);
142 : Isibaar 3
143 :     void BitstreamWriteVopHeader(Bitstream * const bs,
144 : edgomez 195 const MBParam * pParam,
145 : edgomez 851 const FRAMEINFO * const frame,
146 : edgomez 1382 int vop_coded,
147 :     unsigned int quant);
148 : Isibaar 3
149 : edgomez 1382 void BitstreamWriteUserData(Bitstream * const bs,
150 : Skal 1617 const char *data,
151 :     const unsigned int length);
152 :    
153 : Skal 1616 void
154 :     BitstreamWriteEndOfSequence(Bitstream * const bs);
155 : edgomez 466
156 : Skal 1616 void
157 :     BitstreamWriteGroupOfVopHeader(Bitstream * const bs,
158 :     const MBParam * pParam,
159 :     uint32_t is_closed_gov);
160 :    
161 :     void write_video_packet_header(Bitstream * const bs,
162 :     const MBParam * pParam,
163 :     const FRAMEINFO * const frame,
164 :     int mbnum);
165 :    
166 : Skal 1726 /*****************************************************************************
167 :     * Bitstream
168 :     ****************************************************************************/
169 :    
170 :     /* Input buffer should be readable as full chunks of 8bytes, including
171 :     the end of the buffer. Padding might be appropriate. If only chunks
172 :     of 4bytes are applicable, define XVID_SAFE_BS_TAIL. Note that this will
173 :     slow decoding, so consider this as a last-resort solution */
174 : Isibaar 2177 #ifndef XVID_HAVE_PADDED_BS_BUFFER
175 :     #define XVID_SAFE_BS_TAIL
176 :     #endif
177 : Skal 1726
178 : Isibaar 3 /* initialise bitstream structure */
179 :    
180 : edgomez 195 static void __inline
181 :     BitstreamInit(Bitstream * const bs,
182 :     void *const bitstream,
183 :     uint32_t length)
184 : Isibaar 3 {
185 :     uint32_t tmp;
186 : edgomez 972 size_t bitpos;
187 :     ptr_t adjbitstream = (ptr_t)bitstream;
188 : Isibaar 3
189 : edgomez 972 /*
190 :     * Start the stream on a uint32_t boundary, by rounding down to the
191 :     * previous uint32_t and skipping the intervening bytes.
192 :     */
193 :     bitpos = ((sizeof(uint32_t)-1) & (size_t)bitstream);
194 :     adjbitstream = adjbitstream - bitpos;
195 :     bs->start = bs->tail = (uint32_t *) adjbitstream;
196 : Isibaar 3
197 : edgomez 972 tmp = *bs->start;
198 : Isibaar 3 #ifndef ARCH_IS_BIG_ENDIAN
199 :     BSWAP(tmp);
200 :     #endif
201 :     bs->bufa = tmp;
202 :    
203 : edgomez 972 tmp = *(bs->start + 1);
204 : Isibaar 3 #ifndef ARCH_IS_BIG_ENDIAN
205 :     BSWAP(tmp);
206 :     #endif
207 :     bs->bufb = tmp;
208 :    
209 : Isibaar 1928 bs->pos = bs->initpos = (uint32_t) bitpos*8;
210 : Skal 1699 /* preserve the intervening bytes */
211 :     if (bs->initpos > 0)
212 :     bs->buf = bs->bufa & (0xffffffff << (32 - bs->initpos));
213 :     else
214 :     bs->buf = 0;
215 : Isibaar 3 bs->length = length;
216 :     }
217 :    
218 :    
219 :     /* reset bitstream state */
220 :    
221 : edgomez 195 static void __inline
222 :     BitstreamReset(Bitstream * const bs)
223 : Isibaar 3 {
224 :     uint32_t tmp;
225 :    
226 :     bs->tail = bs->start;
227 :    
228 :     tmp = *bs->start;
229 :     #ifndef ARCH_IS_BIG_ENDIAN
230 :     BSWAP(tmp);
231 :     #endif
232 :     bs->bufa = tmp;
233 :    
234 :     tmp = *(bs->start + 1);
235 :     #ifndef ARCH_IS_BIG_ENDIAN
236 :     BSWAP(tmp);
237 :     #endif
238 :     bs->bufb = tmp;
239 :    
240 : Skal 1699 /* preserve the intervening bytes */
241 :     if (bs->initpos > 0)
242 :     bs->buf = bs->bufa & (0xffffffff << (32 - bs->initpos));
243 :     else
244 :     bs->buf = 0;
245 : edgomez 972 bs->pos = bs->initpos;
246 : Isibaar 3 }
247 :    
248 :    
249 :     /* reads n bits from bitstream without changing the stream pos */
250 :    
251 : edgomez 195 static uint32_t __inline
252 :     BitstreamShowBits(Bitstream * const bs,
253 :     const uint32_t bits)
254 : Isibaar 3 {
255 :     int nbit = (bits + bs->pos) - 32;
256 : edgomez 195
257 :     if (nbit > 0) {
258 :     return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs->
259 :     bufb >> (32 -
260 :     nbit));
261 :     } else {
262 : Isibaar 3 return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);
263 :     }
264 :     }
265 :    
266 :    
267 :     /* skip n bits forward in bitstream */
268 :    
269 : edgomez 851 static __inline void
270 : edgomez 195 BitstreamSkip(Bitstream * const bs,
271 :     const uint32_t bits)
272 : Isibaar 3 {
273 :     bs->pos += bits;
274 :    
275 : edgomez 195 if (bs->pos >= 32) {
276 : Isibaar 3 uint32_t tmp;
277 :    
278 :     bs->bufa = bs->bufb;
279 : Skal 1726 #if defined(XVID_SAFE_BS_TAIL)
280 :     if (bs->tail<(bs->start+((bs->length+3)>>2)))
281 :     #endif
282 :     {
283 :     tmp = *((uint32_t *) bs->tail + 2);
284 : Isibaar 3 #ifndef ARCH_IS_BIG_ENDIAN
285 : Skal 1726 BSWAP(tmp);
286 : Isibaar 3 #endif
287 : Skal 1726 bs->bufb = tmp;
288 :     bs->tail++;
289 :     }
290 :     #if defined(XVID_SAFE_BS_TAIL)
291 :     else {
292 :     bs->bufb = 0;
293 :     }
294 :     #endif
295 : Isibaar 3 bs->pos -= 32;
296 :     }
297 :     }
298 :    
299 :    
300 : edgomez 972 /* number of bits to next byte alignment */
301 : edgomez 1382 static __inline uint32_t
302 : suxen_drol 248 BitstreamNumBitsToByteAlign(Bitstream *bs)
303 :     {
304 :     uint32_t n = (32 - bs->pos) % 8;
305 :     return n == 0 ? 8 : n;
306 :     }
307 :    
308 :    
309 : edgomez 972 /* show nbits from next byte alignment */
310 : edgomez 851 static __inline uint32_t
311 : suxen_drol 248 BitstreamShowBitsFromByteAlign(Bitstream *bs, int bits)
312 :     {
313 :     int bspos = bs->pos + BitstreamNumBitsToByteAlign(bs);
314 :     int nbit = (bits + bspos) - 32;
315 :    
316 :     if (bspos >= 32) {
317 :     return bs->bufb >> (32 - nbit);
318 :     } else if (nbit > 0) {
319 :     return ((bs->bufa & (0xffffffff >> bspos)) << nbit) | (bs->
320 :     bufb >> (32 -
321 :     nbit));
322 :     } else {
323 :     return (bs->bufa & (0xffffffff >> bspos)) >> (32 - bspos - bits);
324 :     }
325 :    
326 :     }
327 :    
328 :    
329 :    
330 : Isibaar 3 /* move forward to the next byte boundary */
331 :    
332 : edgomez 851 static __inline void
333 : edgomez 195 BitstreamByteAlign(Bitstream * const bs)
334 : Isibaar 3 {
335 :     uint32_t remainder = bs->pos % 8;
336 : edgomez 195
337 :     if (remainder) {
338 : Isibaar 3 BitstreamSkip(bs, 8 - remainder);
339 :     }
340 :     }
341 :    
342 :    
343 :     /* bitstream length (unit bits) */
344 :    
345 : edgomez 195 static uint32_t __inline
346 :     BitstreamPos(const Bitstream * const bs)
347 : Isibaar 3 {
348 : edgomez 972 return((uint32_t)(8*((ptr_t)bs->tail - (ptr_t)bs->start) + bs->pos - bs->initpos));
349 : Isibaar 3 }
350 :    
351 :    
352 : edgomez 972 /*
353 :     * flush the bitstream & return length (unit bytes)
354 :     * NOTE: assumes no futher bitstream functions will be called.
355 : Isibaar 3 */
356 :    
357 : edgomez 195 static uint32_t __inline
358 :     BitstreamLength(Bitstream * const bs)
359 : Isibaar 3 {
360 : edgomez 972 uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start);
361 : Isibaar 3
362 : edgomez 195 if (bs->pos) {
363 : Isibaar 3 uint32_t b = bs->buf;
364 : edgomez 195
365 : Isibaar 3 #ifndef ARCH_IS_BIG_ENDIAN
366 :     BSWAP(b);
367 :     #endif
368 :     *bs->tail = b;
369 :    
370 :     len += (bs->pos + 7) / 8;
371 : edgomez 195 }
372 : Isibaar 3
373 : edgomez 972 /* initpos is always on a byte boundary */
374 :     if (bs->initpos)
375 :     len -= bs->initpos/8;
376 :    
377 : Isibaar 3 return len;
378 :     }
379 :    
380 :    
381 :     /* move bitstream position forward by n bits and write out buffer if needed */
382 :    
383 : edgomez 195 static void __inline
384 :     BitstreamForward(Bitstream * const bs,
385 :     const uint32_t bits)
386 : Isibaar 3 {
387 : edgomez 195 bs->pos += bits;
388 : Isibaar 3
389 : edgomez 195 if (bs->pos >= 32) {
390 : Isibaar 3 uint32_t b = bs->buf;
391 : edgomez 195
392 : Isibaar 3 #ifndef ARCH_IS_BIG_ENDIAN
393 :     BSWAP(b);
394 :     #endif
395 :     *bs->tail++ = b;
396 :     bs->buf = 0;
397 :     bs->pos -= 32;
398 : edgomez 195 }
399 : Isibaar 3 }
400 :    
401 :     /* read n bits from bitstream */
402 :    
403 : edgomez 195 static uint32_t __inline
404 :     BitstreamGetBits(Bitstream * const bs,
405 :     const uint32_t n)
406 : Isibaar 3 {
407 :     uint32_t ret = BitstreamShowBits(bs, n);
408 : edgomez 195
409 : Isibaar 3 BitstreamSkip(bs, n);
410 :     return ret;
411 :     }
412 :    
413 :    
414 :     /* read single bit from bitstream */
415 :    
416 : edgomez 195 static uint32_t __inline
417 :     BitstreamGetBit(Bitstream * const bs)
418 : Isibaar 3 {
419 :     return BitstreamGetBits(bs, 1);
420 :     }
421 :    
422 :    
423 :     /* write single bit to bitstream */
424 :    
425 : edgomez 195 static void __inline
426 :     BitstreamPutBit(Bitstream * const bs,
427 :     const uint32_t bit)
428 : Isibaar 3 {
429 : edgomez 195 if (bit)
430 : Isibaar 3 bs->buf |= (0x80000000 >> bs->pos);
431 :    
432 : edgomez 195 BitstreamForward(bs, 1);
433 : Isibaar 3 }
434 :    
435 :    
436 :     /* write n bits to bitstream */
437 :    
438 : edgomez 195 static void __inline
439 :     BitstreamPutBits(Bitstream * const bs,
440 :     const uint32_t value,
441 :     const uint32_t size)
442 : Isibaar 3 {
443 :     uint32_t shift = 32 - bs->pos - size;
444 :    
445 :     if (shift <= 32) {
446 :     bs->buf |= value << shift;
447 :     BitstreamForward(bs, size);
448 :     } else {
449 :     uint32_t remainder;
450 :    
451 :     shift = size - (32 - bs->pos);
452 :     bs->buf |= value >> shift;
453 :     BitstreamForward(bs, size - shift);
454 :     remainder = shift;
455 :    
456 :     shift = 32 - shift;
457 : edgomez 195
458 : Isibaar 3 bs->buf |= value << shift;
459 :     BitstreamForward(bs, remainder);
460 :     }
461 :     }
462 :    
463 : edgomez 851 static const int stuffing_codes[8] =
464 :     {
465 :     /* nbits stuffing code */
466 :     0, /* 1 0 */
467 :     1, /* 2 01 */
468 :     3, /* 3 011 */
469 :     7, /* 4 0111 */
470 :     0xf, /* 5 01111 */
471 :     0x1f, /* 6 011111 */
472 :     0x3f, /* 7 0111111 */
473 :     0x7f, /* 8 01111111 */
474 :     };
475 :    
476 :     /* pad bitstream to the next byte boundary */
477 :    
478 :     static void __inline
479 :     BitstreamPad(Bitstream * const bs)
480 :     {
481 :     int bits = 8 - (bs->pos % 8);
482 :     if (bits < 8)
483 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
484 :     }
485 :    
486 :    
487 : edgomez 972 /*
488 : edgomez 1382 * pad bitstream to the next byte boundary
489 : edgomez 972 * alway pad: even if currently at the byte boundary
490 :     */
491 : edgomez 851
492 :     static void __inline
493 :     BitstreamPadAlways(Bitstream * const bs)
494 :     {
495 :     int bits = 8 - (bs->pos % 8);
496 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
497 :     }
498 :    
499 : edgomez 972 #endif /* _BITSTREAM_H_ */

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