[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.17.2.5 - (view) (download)

1 : edgomez 1.17.2.3 /*****************************************************************************
2 :     *
3 :     * XVID MPEG-4 VIDEO CODEC
4 :     * - Bitstream reader/writer inlined functions and constants-
5 :     *
6 : edgomez 1.17.2.5 * Copyright (C) 2001-2003 Peter Ross <pross@xvid.org>
7 : edgomez 1.17.2.3 *
8 : edgomez 1.17.2.5 * 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.17.2.3 * (at your option) any later version.
12 :     *
13 :     * This program is distributed in the hope that it will be useful,
14 : edgomez 1.17.2.5 * but WITHOUT ANY WARRANTY ; without even the implied warranty of
15 : edgomez 1.17.2.3 * 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.17.2.5 * along with this program ; if not, write to the Free Software
20 : edgomez 1.17.2.3 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 :     *
22 : edgomez 1.17.2.5 * $Id$
23 : edgomez 1.17.2.3 *
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.17.2.3 /*****************************************************************************
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.17.2.3 /*#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.17.2.3 /*#define STUFFING_START_CODE 0x000001c3 */
50 : Isibaar 1.1
51 :    
52 :     #define VISOBJ_TYPE_VIDEO 1
53 : edgomez 1.17.2.3 /*#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.17.2.3 /*#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE 2 */
61 : suxen_drol 1.17.2.4 /*#define VIDOBJLAY_TYPE_CORE 3 */
62 :     /*#define VIDOBJLAY_TYPE_MAIN 4 */
63 : edgomez 1.17.2.3 /*#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.17.2.3 /*#define VIDOBJLAY_TYPE_CORE_SCALABLE 11 */
70 : suxen_drol 1.17.2.4 /*#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 : suxen_drol 1.17.2.2 #define VIDOBJLAY_TYPE_ASP 17
76 : suxen_drol 1.17.2.4 /*#define VIDOBJLAY_TYPE_FGS 18*/
77 : edgomez 1.17
78 :    
79 : edgomez 1.17.2.3 /*#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.17.2.3 /* 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.17.2.3 /* resync-specific */
111 : suxen_drol 1.9 #define NUMBITS_VP_RESYNC_MARKER 17
112 :     #define RESYNC_MARKER 1
113 :    
114 :    
115 : edgomez 1.17.2.3 /*****************************************************************************
116 :     * Prototypes
117 :     ****************************************************************************/
118 : edgomez 1.11
119 : edgomez 1.17.2.3 int read_video_packet_header(Bitstream *bs,
120 :     DECODER * dec,
121 :     const int addbits,
122 :     int *quant,
123 :     int *fcode_forward,
124 :     int *fcode_backward,
125 :     int *intra_dc_threshold);
126 : suxen_drol 1.9
127 : edgomez 1.17.2.3 /* header stuff */
128 : edgomez 1.6 int BitstreamReadHeaders(Bitstream * bs,
129 :     DECODER * dec,
130 :     uint32_t * rounding,
131 : edgomez 1.17 uint32_t * reduced_resolution,
132 : edgomez 1.6 uint32_t * quant,
133 :     uint32_t * fcode_forward,
134 :     uint32_t * fcode_backward,
135 : edgomez 1.17 uint32_t * intra_dc_threshold,
136 :     WARPPOINTS * gmc_warp);
137 : Isibaar 1.1
138 :    
139 :     void BitstreamWriteVolHeader(Bitstream * const bs,
140 : suxen_drol 1.17.2.1 const MBParam * pParam);
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 : suxen_drol 1.8 int vop_coded);
146 : Isibaar 1.1
147 : edgomez 1.17 void BitstreamWriteUserData(Bitstream * const bs,
148 :     uint8_t * data,
149 :     const int length);
150 : edgomez 1.11
151 : Isibaar 1.1 /* initialise bitstream structure */
152 :    
153 : edgomez 1.6 static void __inline
154 :     BitstreamInit(Bitstream * const bs,
155 :     void *const bitstream,
156 :     uint32_t length)
157 : Isibaar 1.1 {
158 :     uint32_t tmp;
159 : edgomez 1.17.2.3 size_t bitpos;
160 :     ptr_t adjbitstream = (ptr_t)bitstream;
161 : Isibaar 1.1
162 : edgomez 1.17.2.3 /*
163 :     * Start the stream on a uint32_t boundary, by rounding down to the
164 :     * previous uint32_t and skipping the intervening bytes.
165 :     */
166 :     bitpos = ((sizeof(uint32_t)-1) & (size_t)bitstream);
167 :     adjbitstream = adjbitstream - bitpos;
168 :     bs->start = bs->tail = (uint32_t *) adjbitstream;
169 : Isibaar 1.1
170 : edgomez 1.17.2.3 tmp = *bs->start;
171 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
172 :     BSWAP(tmp);
173 :     #endif
174 :     bs->bufa = tmp;
175 :    
176 : edgomez 1.17.2.3 tmp = *(bs->start + 1);
177 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
178 :     BSWAP(tmp);
179 :     #endif
180 :     bs->bufb = tmp;
181 :    
182 :     bs->buf = 0;
183 : edgomez 1.17.2.3 bs->pos = bs->initpos = bitpos*8;
184 : Isibaar 1.1 bs->length = length;
185 :     }
186 :    
187 :    
188 :     /* reset bitstream state */
189 :    
190 : edgomez 1.6 static void __inline
191 :     BitstreamReset(Bitstream * const bs)
192 : Isibaar 1.1 {
193 :     uint32_t tmp;
194 :    
195 :     bs->tail = bs->start;
196 :    
197 :     tmp = *bs->start;
198 :     #ifndef ARCH_IS_BIG_ENDIAN
199 :     BSWAP(tmp);
200 :     #endif
201 :     bs->bufa = tmp;
202 :    
203 :     tmp = *(bs->start + 1);
204 :     #ifndef ARCH_IS_BIG_ENDIAN
205 :     BSWAP(tmp);
206 :     #endif
207 :     bs->bufb = tmp;
208 :    
209 :     bs->buf = 0;
210 : edgomez 1.17.2.3 bs->pos = bs->initpos;
211 : Isibaar 1.1 }
212 :    
213 :    
214 :     /* reads n bits from bitstream without changing the stream pos */
215 :    
216 : edgomez 1.6 static uint32_t __inline
217 :     BitstreamShowBits(Bitstream * const bs,
218 :     const uint32_t bits)
219 : Isibaar 1.1 {
220 :     int nbit = (bits + bs->pos) - 32;
221 : edgomez 1.6
222 :     if (nbit > 0) {
223 :     return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs->
224 :     bufb >> (32 -
225 :     nbit));
226 :     } else {
227 : Isibaar 1.1 return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);
228 :     }
229 :     }
230 :    
231 :    
232 :     /* skip n bits forward in bitstream */
233 :    
234 : edgomez 1.17 static __inline void
235 : edgomez 1.6 BitstreamSkip(Bitstream * const bs,
236 :     const uint32_t bits)
237 : Isibaar 1.1 {
238 :     bs->pos += bits;
239 :    
240 : edgomez 1.6 if (bs->pos >= 32) {
241 : Isibaar 1.1 uint32_t tmp;
242 :    
243 :     bs->bufa = bs->bufb;
244 : edgomez 1.6 tmp = *((uint32_t *) bs->tail + 2);
245 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
246 :     BSWAP(tmp);
247 :     #endif
248 :     bs->bufb = tmp;
249 :     bs->tail++;
250 :     bs->pos -= 32;
251 :     }
252 :     }
253 : suxen_drol 1.9
254 :    
255 : edgomez 1.17.2.3 /* number of bits to next byte alignment */
256 : edgomez 1.17 static __inline uint32_t
257 : suxen_drol 1.9 BitstreamNumBitsToByteAlign(Bitstream *bs)
258 :     {
259 :     uint32_t n = (32 - bs->pos) % 8;
260 :     return n == 0 ? 8 : n;
261 :     }
262 :    
263 :    
264 : edgomez 1.17.2.3 /* show nbits from next byte alignment */
265 : edgomez 1.17 static __inline uint32_t
266 : suxen_drol 1.9 BitstreamShowBitsFromByteAlign(Bitstream *bs, int bits)
267 :     {
268 :     int bspos = bs->pos + BitstreamNumBitsToByteAlign(bs);
269 :     int nbit = (bits + bspos) - 32;
270 :    
271 :     if (bspos >= 32) {
272 :     return bs->bufb >> (32 - nbit);
273 :     } else if (nbit > 0) {
274 :     return ((bs->bufa & (0xffffffff >> bspos)) << nbit) | (bs->
275 :     bufb >> (32 -
276 :     nbit));
277 :     } else {
278 :     return (bs->bufa & (0xffffffff >> bspos)) >> (32 - bspos - bits);
279 :     }
280 :    
281 :     }
282 :    
283 : Isibaar 1.1
284 :    
285 :     /* move forward to the next byte boundary */
286 :    
287 : edgomez 1.17 static __inline void
288 : edgomez 1.6 BitstreamByteAlign(Bitstream * const bs)
289 : Isibaar 1.1 {
290 :     uint32_t remainder = bs->pos % 8;
291 : edgomez 1.6
292 :     if (remainder) {
293 : Isibaar 1.1 BitstreamSkip(bs, 8 - remainder);
294 :     }
295 :     }
296 :    
297 :    
298 :     /* bitstream length (unit bits) */
299 :    
300 : edgomez 1.6 static uint32_t __inline
301 :     BitstreamPos(const Bitstream * const bs)
302 : Isibaar 1.1 {
303 : edgomez 1.17.2.3 return((uint32_t)(8*((ptr_t)bs->tail - (ptr_t)bs->start) + bs->pos - bs->initpos));
304 : Isibaar 1.1 }
305 :    
306 :    
307 : edgomez 1.17.2.3 /*
308 :     * flush the bitstream & return length (unit bytes)
309 :     * NOTE: assumes no futher bitstream functions will be called.
310 : Isibaar 1.1 */
311 :    
312 : edgomez 1.6 static uint32_t __inline
313 :     BitstreamLength(Bitstream * const bs)
314 : Isibaar 1.1 {
315 : edgomez 1.17.2.3 uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start);
316 : Isibaar 1.1
317 : edgomez 1.6 if (bs->pos) {
318 : Isibaar 1.1 uint32_t b = bs->buf;
319 : edgomez 1.6
320 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
321 :     BSWAP(b);
322 :     #endif
323 :     *bs->tail = b;
324 :    
325 :     len += (bs->pos + 7) / 8;
326 : edgomez 1.6 }
327 : Isibaar 1.1
328 : edgomez 1.17.2.3 /* initpos is always on a byte boundary */
329 :     if (bs->initpos)
330 :     len -= bs->initpos/8;
331 :    
332 : Isibaar 1.1 return len;
333 :     }
334 :    
335 :    
336 :     /* move bitstream position forward by n bits and write out buffer if needed */
337 :    
338 : edgomez 1.6 static void __inline
339 :     BitstreamForward(Bitstream * const bs,
340 :     const uint32_t bits)
341 : Isibaar 1.1 {
342 : edgomez 1.6 bs->pos += bits;
343 : Isibaar 1.1
344 : edgomez 1.6 if (bs->pos >= 32) {
345 : Isibaar 1.1 uint32_t b = bs->buf;
346 : edgomez 1.6
347 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
348 :     BSWAP(b);
349 :     #endif
350 :     *bs->tail++ = b;
351 :     bs->buf = 0;
352 :     bs->pos -= 32;
353 : edgomez 1.6 }
354 : Isibaar 1.1 }
355 :    
356 :     /* read n bits from bitstream */
357 :    
358 : edgomez 1.6 static uint32_t __inline
359 :     BitstreamGetBits(Bitstream * const bs,
360 :     const uint32_t n)
361 : Isibaar 1.1 {
362 :     uint32_t ret = BitstreamShowBits(bs, n);
363 : edgomez 1.6
364 : Isibaar 1.1 BitstreamSkip(bs, n);
365 :     return ret;
366 :     }
367 :    
368 :    
369 :     /* read single bit from bitstream */
370 :    
371 : edgomez 1.6 static uint32_t __inline
372 :     BitstreamGetBit(Bitstream * const bs)
373 : Isibaar 1.1 {
374 :     return BitstreamGetBits(bs, 1);
375 :     }
376 :    
377 :    
378 :     /* write single bit to bitstream */
379 :    
380 : edgomez 1.6 static void __inline
381 :     BitstreamPutBit(Bitstream * const bs,
382 :     const uint32_t bit)
383 : Isibaar 1.1 {
384 : edgomez 1.6 if (bit)
385 : Isibaar 1.1 bs->buf |= (0x80000000 >> bs->pos);
386 :    
387 : edgomez 1.6 BitstreamForward(bs, 1);
388 : Isibaar 1.1 }
389 :    
390 :    
391 :     /* write n bits to bitstream */
392 :    
393 : edgomez 1.6 static void __inline
394 :     BitstreamPutBits(Bitstream * const bs,
395 :     const uint32_t value,
396 :     const uint32_t size)
397 : Isibaar 1.1 {
398 :     uint32_t shift = 32 - bs->pos - size;
399 :    
400 :     if (shift <= 32) {
401 :     bs->buf |= value << shift;
402 :     BitstreamForward(bs, size);
403 :     } else {
404 :     uint32_t remainder;
405 :    
406 :     shift = size - (32 - bs->pos);
407 :     bs->buf |= value >> shift;
408 :     BitstreamForward(bs, size - shift);
409 :     remainder = shift;
410 :    
411 :     shift = 32 - shift;
412 : edgomez 1.6
413 : Isibaar 1.1 bs->buf |= value << shift;
414 :     BitstreamForward(bs, remainder);
415 :     }
416 :     }
417 :    
418 : edgomez 1.17 static const int stuffing_codes[8] =
419 :     {
420 :     /* nbits stuffing code */
421 :     0, /* 1 0 */
422 :     1, /* 2 01 */
423 :     3, /* 3 011 */
424 :     7, /* 4 0111 */
425 :     0xf, /* 5 01111 */
426 :     0x1f, /* 6 011111 */
427 :     0x3f, /* 7 0111111 */
428 :     0x7f, /* 8 01111111 */
429 :     };
430 :    
431 :     /* pad bitstream to the next byte boundary */
432 :    
433 :     static void __inline
434 :     BitstreamPad(Bitstream * const bs)
435 :     {
436 :     int bits = 8 - (bs->pos % 8);
437 :     if (bits < 8)
438 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
439 :     }
440 :    
441 :    
442 : edgomez 1.17.2.3 /*
443 :     * pad bitstream to the next byte boundary
444 :     * alway pad: even if currently at the byte boundary
445 :     */
446 : edgomez 1.17
447 :     static void __inline
448 :     BitstreamPadAlways(Bitstream * const bs)
449 :     {
450 :     int bits = 8 - (bs->pos % 8);
451 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
452 :     }
453 :    
454 : edgomez 1.17.2.3 #endif /* _BITSTREAM_H_ */

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