[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.4 - (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 :     * Copyright (C) 2001-2003 - Peter Ross <pross@xvid.org>
7 :     *
8 :     * This file is part of XviD, a free MPEG-4 video encoder/decoder
9 :     *
10 :     * XviD is free software; you can redistribute it and/or modify it
11 :     * under the terms of the GNU General Public License as published by
12 :     * the Free Software Foundation; either version 2 of the License, or
13 :     * (at your option) any later version.
14 :     *
15 :     * This program is distributed in the hope that it will be useful,
16 :     * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 :     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 :     * GNU General Public License for more details.
19 :     *
20 :     * You should have received a copy of the GNU General Public License
21 :     * along with this program; if not, write to the Free Software
22 :     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 :     *
24 : suxen_drol 1.17.2.4 * $Id: bitstream.h,v 1.17.2.3 2003/04/04 22:13:35 edgomez Exp $
25 : edgomez 1.17.2.3 *
26 :     ****************************************************************************/
27 : Isibaar 1.1
28 :     #ifndef _BITSTREAM_H_
29 :     #define _BITSTREAM_H_
30 :    
31 :     #include "../portab.h"
32 :     #include "../decoder.h"
33 :     #include "../encoder.h"
34 :    
35 : edgomez 1.11
36 : edgomez 1.17.2.3 /*****************************************************************************
37 :     * Constants
38 :     ****************************************************************************/
39 :    
40 :     /* comment any #defs we dont use */
41 : Isibaar 1.1
42 :     #define VIDOBJ_START_CODE 0x00000100 /* ..0x0000011f */
43 :     #define VIDOBJLAY_START_CODE 0x00000120 /* ..0x0000012f */
44 :     #define VISOBJSEQ_START_CODE 0x000001b0
45 :     #define VISOBJSEQ_STOP_CODE 0x000001b1 /* ??? */
46 :     #define USERDATA_START_CODE 0x000001b2
47 :     #define GRPOFVOP_START_CODE 0x000001b3
48 : edgomez 1.17.2.3 /*#define VIDSESERR_ERROR_CODE 0x000001b4 */
49 : Isibaar 1.1 #define VISOBJ_START_CODE 0x000001b5
50 : edgomez 1.17 #define VOP_START_CODE 0x000001b6
51 : edgomez 1.17.2.3 /*#define STUFFING_START_CODE 0x000001c3 */
52 : Isibaar 1.1
53 :    
54 :     #define VISOBJ_TYPE_VIDEO 1
55 : edgomez 1.17.2.3 /*#define VISOBJ_TYPE_STILLTEXTURE 2 */
56 :     /*#define VISOBJ_TYPE_MESH 3 */
57 :     /*#define VISOBJ_TYPE_FBA 4 */
58 :     /*#define VISOBJ_TYPE_3DMESH 5 */
59 : Isibaar 1.1
60 :    
61 :     #define VIDOBJLAY_TYPE_SIMPLE 1
62 : edgomez 1.17.2.3 /*#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE 2 */
63 : suxen_drol 1.17.2.4 /*#define VIDOBJLAY_TYPE_CORE 3 */
64 :     /*#define VIDOBJLAY_TYPE_MAIN 4 */
65 : edgomez 1.17.2.3 /*#define VIDOBJLAY_TYPE_NBIT 5 */
66 :     /*#define VIDOBJLAY_TYPE_ANIM_TEXT 6 */
67 :     /*#define VIDOBJLAY_TYPE_ANIM_MESH 7 */
68 :     /*#define VIDOBJLAY_TYPE_SIMPLE_FACE 8 */
69 :     /*#define VIDOBJLAY_TYPE_STILL_SCALABLE 9 */
70 : edgomez 1.17 #define VIDOBJLAY_TYPE_ART_SIMPLE 10
71 : edgomez 1.17.2.3 /*#define VIDOBJLAY_TYPE_CORE_SCALABLE 11 */
72 : suxen_drol 1.17.2.4 /*#define VIDOBJLAY_TYPE_ACE 12 */
73 :     /*#define VIDOBJLAY_TYPE_ADVANCED_SCALABLE_TEXTURE 13 */
74 :     /*#define VIDOBJLAY_TYPE_SIMPLE_FBA 14 */
75 :     /*#define VIDEOJLAY_TYPE_SIMPLE_STUDIO 15*/
76 :     /*#define VIDEOJLAY_TYPE_CORE_STUDIO 16*/
77 : suxen_drol 1.17.2.2 #define VIDOBJLAY_TYPE_ASP 17
78 : suxen_drol 1.17.2.4 /*#define VIDOBJLAY_TYPE_FGS 18*/
79 : edgomez 1.17
80 :    
81 : edgomez 1.17.2.3 /*#define VIDOBJLAY_AR_SQUARE 1 */
82 :     /*#define VIDOBJLAY_AR_625TYPE_43 2 */
83 :     /*#define VIDOBJLAY_AR_525TYPE_43 3 */
84 :     /*#define VIDOBJLAY_AR_625TYPE_169 8 */
85 :     /*#define VIDOBJLAY_AR_525TYPE_169 9 */
86 : Isibaar 1.1 #define VIDOBJLAY_AR_EXTPAR 15
87 :    
88 :    
89 :     #define VIDOBJLAY_SHAPE_RECTANGULAR 0
90 :     #define VIDOBJLAY_SHAPE_BINARY 1
91 :     #define VIDOBJLAY_SHAPE_BINARY_ONLY 2
92 :     #define VIDOBJLAY_SHAPE_GRAYSCALE 3
93 :    
94 : edgomez 1.17
95 :     #define SPRITE_NONE 0
96 :     #define SPRITE_STATIC 1
97 :     #define SPRITE_GMC 2
98 :    
99 :    
100 : Isibaar 1.1
101 :     #define READ_MARKER() BitstreamSkip(bs, 1)
102 :     #define WRITE_MARKER() BitstreamPutBit(bs, 1)
103 :    
104 : edgomez 1.17.2.3 /* vop coding types */
105 :     /* intra, prediction, backward, sprite, not_coded */
106 : Isibaar 1.1 #define I_VOP 0
107 :     #define P_VOP 1
108 :     #define B_VOP 2
109 :     #define S_VOP 3
110 :     #define N_VOP 4
111 :    
112 : edgomez 1.17.2.3 /* resync-specific */
113 : suxen_drol 1.9 #define NUMBITS_VP_RESYNC_MARKER 17
114 :     #define RESYNC_MARKER 1
115 :    
116 :    
117 : edgomez 1.17.2.3 /*****************************************************************************
118 :     * Prototypes
119 :     ****************************************************************************/
120 : edgomez 1.11
121 : edgomez 1.17.2.3 int read_video_packet_header(Bitstream *bs,
122 :     DECODER * dec,
123 :     const int addbits,
124 :     int *quant,
125 :     int *fcode_forward,
126 :     int *fcode_backward,
127 :     int *intra_dc_threshold);
128 : suxen_drol 1.9
129 : edgomez 1.17.2.3 /* header stuff */
130 : edgomez 1.6 int BitstreamReadHeaders(Bitstream * bs,
131 :     DECODER * dec,
132 :     uint32_t * rounding,
133 : edgomez 1.17 uint32_t * reduced_resolution,
134 : edgomez 1.6 uint32_t * quant,
135 :     uint32_t * fcode_forward,
136 :     uint32_t * fcode_backward,
137 : edgomez 1.17 uint32_t * intra_dc_threshold,
138 :     WARPPOINTS * gmc_warp);
139 : Isibaar 1.1
140 :    
141 :     void BitstreamWriteVolHeader(Bitstream * const bs,
142 : suxen_drol 1.17.2.1 const MBParam * pParam);
143 : Isibaar 1.1
144 :     void BitstreamWriteVopHeader(Bitstream * const bs,
145 : edgomez 1.6 const MBParam * pParam,
146 : edgomez 1.17 const FRAMEINFO * const frame,
147 : suxen_drol 1.8 int vop_coded);
148 : Isibaar 1.1
149 : edgomez 1.17 void BitstreamWriteUserData(Bitstream * const bs,
150 :     uint8_t * data,
151 :     const int length);
152 : edgomez 1.11
153 : Isibaar 1.1 /* initialise bitstream structure */
154 :    
155 : edgomez 1.6 static void __inline
156 :     BitstreamInit(Bitstream * const bs,
157 :     void *const bitstream,
158 :     uint32_t length)
159 : Isibaar 1.1 {
160 :     uint32_t tmp;
161 : edgomez 1.17.2.3 size_t bitpos;
162 :     ptr_t adjbitstream = (ptr_t)bitstream;
163 : Isibaar 1.1
164 : edgomez 1.17.2.3 /*
165 :     * Start the stream on a uint32_t boundary, by rounding down to the
166 :     * previous uint32_t and skipping the intervening bytes.
167 :     */
168 :     bitpos = ((sizeof(uint32_t)-1) & (size_t)bitstream);
169 :     adjbitstream = adjbitstream - bitpos;
170 :     bs->start = bs->tail = (uint32_t *) adjbitstream;
171 : Isibaar 1.1
172 : edgomez 1.17.2.3 tmp = *bs->start;
173 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
174 :     BSWAP(tmp);
175 :     #endif
176 :     bs->bufa = tmp;
177 :    
178 : edgomez 1.17.2.3 tmp = *(bs->start + 1);
179 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
180 :     BSWAP(tmp);
181 :     #endif
182 :     bs->bufb = tmp;
183 :    
184 :     bs->buf = 0;
185 : edgomez 1.17.2.3 bs->pos = bs->initpos = bitpos*8;
186 : Isibaar 1.1 bs->length = length;
187 :     }
188 :    
189 :    
190 :     /* reset bitstream state */
191 :    
192 : edgomez 1.6 static void __inline
193 :     BitstreamReset(Bitstream * const bs)
194 : Isibaar 1.1 {
195 :     uint32_t tmp;
196 :    
197 :     bs->tail = bs->start;
198 :    
199 :     tmp = *bs->start;
200 :     #ifndef ARCH_IS_BIG_ENDIAN
201 :     BSWAP(tmp);
202 :     #endif
203 :     bs->bufa = tmp;
204 :    
205 :     tmp = *(bs->start + 1);
206 :     #ifndef ARCH_IS_BIG_ENDIAN
207 :     BSWAP(tmp);
208 :     #endif
209 :     bs->bufb = tmp;
210 :    
211 :     bs->buf = 0;
212 : edgomez 1.17.2.3 bs->pos = bs->initpos;
213 : Isibaar 1.1 }
214 :    
215 :    
216 :     /* reads n bits from bitstream without changing the stream pos */
217 :    
218 : edgomez 1.6 static uint32_t __inline
219 :     BitstreamShowBits(Bitstream * const bs,
220 :     const uint32_t bits)
221 : Isibaar 1.1 {
222 :     int nbit = (bits + bs->pos) - 32;
223 : edgomez 1.6
224 :     if (nbit > 0) {
225 :     return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs->
226 :     bufb >> (32 -
227 :     nbit));
228 :     } else {
229 : Isibaar 1.1 return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);
230 :     }
231 :     }
232 :    
233 :    
234 :     /* skip n bits forward in bitstream */
235 :    
236 : edgomez 1.17 static __inline void
237 : edgomez 1.6 BitstreamSkip(Bitstream * const bs,
238 :     const uint32_t bits)
239 : Isibaar 1.1 {
240 :     bs->pos += bits;
241 :    
242 : edgomez 1.6 if (bs->pos >= 32) {
243 : Isibaar 1.1 uint32_t tmp;
244 :    
245 :     bs->bufa = bs->bufb;
246 : edgomez 1.6 tmp = *((uint32_t *) bs->tail + 2);
247 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
248 :     BSWAP(tmp);
249 :     #endif
250 :     bs->bufb = tmp;
251 :     bs->tail++;
252 :     bs->pos -= 32;
253 :     }
254 :     }
255 : suxen_drol 1.9
256 :    
257 : edgomez 1.17.2.3 /* number of bits to next byte alignment */
258 : edgomez 1.17 static __inline uint32_t
259 : suxen_drol 1.9 BitstreamNumBitsToByteAlign(Bitstream *bs)
260 :     {
261 :     uint32_t n = (32 - bs->pos) % 8;
262 :     return n == 0 ? 8 : n;
263 :     }
264 :    
265 :    
266 : edgomez 1.17.2.3 /* show nbits from next byte alignment */
267 : edgomez 1.17 static __inline uint32_t
268 : suxen_drol 1.9 BitstreamShowBitsFromByteAlign(Bitstream *bs, int bits)
269 :     {
270 :     int bspos = bs->pos + BitstreamNumBitsToByteAlign(bs);
271 :     int nbit = (bits + bspos) - 32;
272 :    
273 :     if (bspos >= 32) {
274 :     return bs->bufb >> (32 - nbit);
275 :     } else if (nbit > 0) {
276 :     return ((bs->bufa & (0xffffffff >> bspos)) << nbit) | (bs->
277 :     bufb >> (32 -
278 :     nbit));
279 :     } else {
280 :     return (bs->bufa & (0xffffffff >> bspos)) >> (32 - bspos - bits);
281 :     }
282 :    
283 :     }
284 :    
285 : Isibaar 1.1
286 :    
287 :     /* move forward to the next byte boundary */
288 :    
289 : edgomez 1.17 static __inline void
290 : edgomez 1.6 BitstreamByteAlign(Bitstream * const bs)
291 : Isibaar 1.1 {
292 :     uint32_t remainder = bs->pos % 8;
293 : edgomez 1.6
294 :     if (remainder) {
295 : Isibaar 1.1 BitstreamSkip(bs, 8 - remainder);
296 :     }
297 :     }
298 :    
299 :    
300 :     /* bitstream length (unit bits) */
301 :    
302 : edgomez 1.6 static uint32_t __inline
303 :     BitstreamPos(const Bitstream * const bs)
304 : Isibaar 1.1 {
305 : edgomez 1.17.2.3 return((uint32_t)(8*((ptr_t)bs->tail - (ptr_t)bs->start) + bs->pos - bs->initpos));
306 : Isibaar 1.1 }
307 :    
308 :    
309 : edgomez 1.17.2.3 /*
310 :     * flush the bitstream & return length (unit bytes)
311 :     * NOTE: assumes no futher bitstream functions will be called.
312 : Isibaar 1.1 */
313 :    
314 : edgomez 1.6 static uint32_t __inline
315 :     BitstreamLength(Bitstream * const bs)
316 : Isibaar 1.1 {
317 : edgomez 1.17.2.3 uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start);
318 : Isibaar 1.1
319 : edgomez 1.6 if (bs->pos) {
320 : Isibaar 1.1 uint32_t b = bs->buf;
321 : edgomez 1.6
322 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
323 :     BSWAP(b);
324 :     #endif
325 :     *bs->tail = b;
326 :    
327 :     len += (bs->pos + 7) / 8;
328 : edgomez 1.6 }
329 : Isibaar 1.1
330 : edgomez 1.17.2.3 /* initpos is always on a byte boundary */
331 :     if (bs->initpos)
332 :     len -= bs->initpos/8;
333 :    
334 : Isibaar 1.1 return len;
335 :     }
336 :    
337 :    
338 :     /* move bitstream position forward by n bits and write out buffer if needed */
339 :    
340 : edgomez 1.6 static void __inline
341 :     BitstreamForward(Bitstream * const bs,
342 :     const uint32_t bits)
343 : Isibaar 1.1 {
344 : edgomez 1.6 bs->pos += bits;
345 : Isibaar 1.1
346 : edgomez 1.6 if (bs->pos >= 32) {
347 : Isibaar 1.1 uint32_t b = bs->buf;
348 : edgomez 1.6
349 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
350 :     BSWAP(b);
351 :     #endif
352 :     *bs->tail++ = b;
353 :     bs->buf = 0;
354 :     bs->pos -= 32;
355 : edgomez 1.6 }
356 : Isibaar 1.1 }
357 :    
358 :     /* read n bits from bitstream */
359 :    
360 : edgomez 1.6 static uint32_t __inline
361 :     BitstreamGetBits(Bitstream * const bs,
362 :     const uint32_t n)
363 : Isibaar 1.1 {
364 :     uint32_t ret = BitstreamShowBits(bs, n);
365 : edgomez 1.6
366 : Isibaar 1.1 BitstreamSkip(bs, n);
367 :     return ret;
368 :     }
369 :    
370 :    
371 :     /* read single bit from bitstream */
372 :    
373 : edgomez 1.6 static uint32_t __inline
374 :     BitstreamGetBit(Bitstream * const bs)
375 : Isibaar 1.1 {
376 :     return BitstreamGetBits(bs, 1);
377 :     }
378 :    
379 :    
380 :     /* write single bit to bitstream */
381 :    
382 : edgomez 1.6 static void __inline
383 :     BitstreamPutBit(Bitstream * const bs,
384 :     const uint32_t bit)
385 : Isibaar 1.1 {
386 : edgomez 1.6 if (bit)
387 : Isibaar 1.1 bs->buf |= (0x80000000 >> bs->pos);
388 :    
389 : edgomez 1.6 BitstreamForward(bs, 1);
390 : Isibaar 1.1 }
391 :    
392 :    
393 :     /* write n bits to bitstream */
394 :    
395 : edgomez 1.6 static void __inline
396 :     BitstreamPutBits(Bitstream * const bs,
397 :     const uint32_t value,
398 :     const uint32_t size)
399 : Isibaar 1.1 {
400 :     uint32_t shift = 32 - bs->pos - size;
401 :    
402 :     if (shift <= 32) {
403 :     bs->buf |= value << shift;
404 :     BitstreamForward(bs, size);
405 :     } else {
406 :     uint32_t remainder;
407 :    
408 :     shift = size - (32 - bs->pos);
409 :     bs->buf |= value >> shift;
410 :     BitstreamForward(bs, size - shift);
411 :     remainder = shift;
412 :    
413 :     shift = 32 - shift;
414 : edgomez 1.6
415 : Isibaar 1.1 bs->buf |= value << shift;
416 :     BitstreamForward(bs, remainder);
417 :     }
418 :     }
419 :    
420 : edgomez 1.17 static const int stuffing_codes[8] =
421 :     {
422 :     /* nbits stuffing code */
423 :     0, /* 1 0 */
424 :     1, /* 2 01 */
425 :     3, /* 3 011 */
426 :     7, /* 4 0111 */
427 :     0xf, /* 5 01111 */
428 :     0x1f, /* 6 011111 */
429 :     0x3f, /* 7 0111111 */
430 :     0x7f, /* 8 01111111 */
431 :     };
432 :    
433 :     /* pad bitstream to the next byte boundary */
434 :    
435 :     static void __inline
436 :     BitstreamPad(Bitstream * const bs)
437 :     {
438 :     int bits = 8 - (bs->pos % 8);
439 :     if (bits < 8)
440 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
441 :     }
442 :    
443 :    
444 : edgomez 1.17.2.3 /*
445 :     * pad bitstream to the next byte boundary
446 :     * alway pad: even if currently at the byte boundary
447 :     */
448 : edgomez 1.17
449 :     static void __inline
450 :     BitstreamPadAlways(Bitstream * const bs)
451 :     {
452 :     int bits = 8 - (bs->pos % 8);
453 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
454 :     }
455 :    
456 : edgomez 1.17.2.3 #endif /* _BITSTREAM_H_ */
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4