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

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