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

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