[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.3 - (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 :     * $Id: bitstream.h,v 1.16 2003/02/09 19:32:52 edgomez Exp $
25 :     *
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 : Isibaar 1.1 #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 : edgomez 1.17 #define VIDOBJLAY_TYPE_ACE 12
73 : edgomez 1.17.2.3 /*#define VIDOBJLAY_TYPE_SIMPLE_FBA 13 */
74 : suxen_drol 1.17.2.2 #define VIDOBJLAY_TYPE_ASP 17
75 : edgomez 1.17
76 :    
77 : edgomez 1.17.2.3 /*#define VIDOBJLAY_AR_SQUARE 1 */
78 :     /*#define VIDOBJLAY_AR_625TYPE_43 2 */
79 :     /*#define VIDOBJLAY_AR_525TYPE_43 3 */
80 :     /*#define VIDOBJLAY_AR_625TYPE_169 8 */
81 :     /*#define VIDOBJLAY_AR_525TYPE_169 9 */
82 : Isibaar 1.1 #define VIDOBJLAY_AR_EXTPAR 15
83 :    
84 :    
85 :     #define VIDOBJLAY_SHAPE_RECTANGULAR 0
86 :     #define VIDOBJLAY_SHAPE_BINARY 1
87 :     #define VIDOBJLAY_SHAPE_BINARY_ONLY 2
88 :     #define VIDOBJLAY_SHAPE_GRAYSCALE 3
89 :    
90 : edgomez 1.17
91 :     #define SPRITE_NONE 0
92 :     #define SPRITE_STATIC 1
93 :     #define SPRITE_GMC 2
94 :    
95 :    
96 : Isibaar 1.1
97 :     #define READ_MARKER() BitstreamSkip(bs, 1)
98 :     #define WRITE_MARKER() BitstreamPutBit(bs, 1)
99 :    
100 : edgomez 1.17.2.3 /* vop coding types */
101 :     /* intra, prediction, backward, sprite, not_coded */
102 : Isibaar 1.1 #define I_VOP 0
103 :     #define P_VOP 1
104 :     #define B_VOP 2
105 :     #define S_VOP 3
106 :     #define N_VOP 4
107 :    
108 : edgomez 1.17.2.3 /* resync-specific */
109 : suxen_drol 1.9 #define NUMBITS_VP_RESYNC_MARKER 17
110 :     #define RESYNC_MARKER 1
111 :    
112 :    
113 : edgomez 1.17.2.3 /*****************************************************************************
114 :     * Prototypes
115 :     ****************************************************************************/
116 : edgomez 1.11
117 : edgomez 1.17.2.3 int read_video_packet_header(Bitstream *bs,
118 :     DECODER * dec,
119 :     const int addbits,
120 :     int *quant,
121 :     int *fcode_forward,
122 :     int *fcode_backward,
123 :     int *intra_dc_threshold);
124 : suxen_drol 1.9
125 : edgomez 1.17.2.3 /* header stuff */
126 : edgomez 1.6 int BitstreamReadHeaders(Bitstream * bs,
127 :     DECODER * dec,
128 :     uint32_t * rounding,
129 : edgomez 1.17 uint32_t * reduced_resolution,
130 : edgomez 1.6 uint32_t * quant,
131 :     uint32_t * fcode_forward,
132 :     uint32_t * fcode_backward,
133 : edgomez 1.17 uint32_t * intra_dc_threshold,
134 :     WARPPOINTS * gmc_warp);
135 : Isibaar 1.1
136 :    
137 :     void BitstreamWriteVolHeader(Bitstream * const bs,
138 : suxen_drol 1.17.2.1 const MBParam * pParam);
139 : Isibaar 1.1
140 :     void BitstreamWriteVopHeader(Bitstream * const bs,
141 : edgomez 1.6 const MBParam * pParam,
142 : edgomez 1.17 const FRAMEINFO * const frame,
143 : suxen_drol 1.8 int vop_coded);
144 : Isibaar 1.1
145 : edgomez 1.17 void BitstreamWriteUserData(Bitstream * const bs,
146 :     uint8_t * data,
147 :     const int length);
148 : edgomez 1.11
149 : Isibaar 1.1 /* initialise bitstream structure */
150 :    
151 : edgomez 1.6 static void __inline
152 :     BitstreamInit(Bitstream * const bs,
153 :     void *const bitstream,
154 :     uint32_t length)
155 : Isibaar 1.1 {
156 :     uint32_t tmp;
157 : edgomez 1.17.2.3 size_t bitpos;
158 :     ptr_t adjbitstream = (ptr_t)bitstream;
159 : Isibaar 1.1
160 : edgomez 1.17.2.3 /*
161 :     * Start the stream on a uint32_t boundary, by rounding down to the
162 :     * previous uint32_t and skipping the intervening bytes.
163 :     */
164 :     bitpos = ((sizeof(uint32_t)-1) & (size_t)bitstream);
165 :     adjbitstream = adjbitstream - bitpos;
166 :     bs->start = bs->tail = (uint32_t *) adjbitstream;
167 : Isibaar 1.1
168 : edgomez 1.17.2.3 tmp = *bs->start;
169 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
170 :     BSWAP(tmp);
171 :     #endif
172 :     bs->bufa = tmp;
173 :    
174 : edgomez 1.17.2.3 tmp = *(bs->start + 1);
175 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
176 :     BSWAP(tmp);
177 :     #endif
178 :     bs->bufb = tmp;
179 :    
180 :     bs->buf = 0;
181 : edgomez 1.17.2.3 bs->pos = bs->initpos = bitpos*8;
182 : Isibaar 1.1 bs->length = length;
183 :     }
184 :    
185 :    
186 :     /* reset bitstream state */
187 :    
188 : edgomez 1.6 static void __inline
189 :     BitstreamReset(Bitstream * const bs)
190 : Isibaar 1.1 {
191 :     uint32_t tmp;
192 :    
193 :     bs->tail = bs->start;
194 :    
195 :     tmp = *bs->start;
196 :     #ifndef ARCH_IS_BIG_ENDIAN
197 :     BSWAP(tmp);
198 :     #endif
199 :     bs->bufa = tmp;
200 :    
201 :     tmp = *(bs->start + 1);
202 :     #ifndef ARCH_IS_BIG_ENDIAN
203 :     BSWAP(tmp);
204 :     #endif
205 :     bs->bufb = tmp;
206 :    
207 :     bs->buf = 0;
208 : edgomez 1.17.2.3 bs->pos = bs->initpos;
209 : Isibaar 1.1 }
210 :    
211 :    
212 :     /* reads n bits from bitstream without changing the stream pos */
213 :    
214 : edgomez 1.6 static uint32_t __inline
215 :     BitstreamShowBits(Bitstream * const bs,
216 :     const uint32_t bits)
217 : Isibaar 1.1 {
218 :     int nbit = (bits + bs->pos) - 32;
219 : edgomez 1.6
220 :     if (nbit > 0) {
221 :     return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs->
222 :     bufb >> (32 -
223 :     nbit));
224 :     } else {
225 : Isibaar 1.1 return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);
226 :     }
227 :     }
228 :    
229 :    
230 :     /* skip n bits forward in bitstream */
231 :    
232 : edgomez 1.17 static __inline void
233 : edgomez 1.6 BitstreamSkip(Bitstream * const bs,
234 :     const uint32_t bits)
235 : Isibaar 1.1 {
236 :     bs->pos += bits;
237 :    
238 : edgomez 1.6 if (bs->pos >= 32) {
239 : Isibaar 1.1 uint32_t tmp;
240 :    
241 :     bs->bufa = bs->bufb;
242 : edgomez 1.6 tmp = *((uint32_t *) bs->tail + 2);
243 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
244 :     BSWAP(tmp);
245 :     #endif
246 :     bs->bufb = tmp;
247 :     bs->tail++;
248 :     bs->pos -= 32;
249 :     }
250 :     }
251 : suxen_drol 1.9
252 :    
253 : edgomez 1.17.2.3 /* number of bits to next byte alignment */
254 : edgomez 1.17 static __inline uint32_t
255 : suxen_drol 1.9 BitstreamNumBitsToByteAlign(Bitstream *bs)
256 :     {
257 :     uint32_t n = (32 - bs->pos) % 8;
258 :     return n == 0 ? 8 : n;
259 :     }
260 :    
261 :    
262 : edgomez 1.17.2.3 /* show nbits from next byte alignment */
263 : edgomez 1.17 static __inline uint32_t
264 : suxen_drol 1.9 BitstreamShowBitsFromByteAlign(Bitstream *bs, int bits)
265 :     {
266 :     int bspos = bs->pos + BitstreamNumBitsToByteAlign(bs);
267 :     int nbit = (bits + bspos) - 32;
268 :    
269 :     if (bspos >= 32) {
270 :     return bs->bufb >> (32 - nbit);
271 :     } else if (nbit > 0) {
272 :     return ((bs->bufa & (0xffffffff >> bspos)) << nbit) | (bs->
273 :     bufb >> (32 -
274 :     nbit));
275 :     } else {
276 :     return (bs->bufa & (0xffffffff >> bspos)) >> (32 - bspos - bits);
277 :     }
278 :    
279 :     }
280 :    
281 : Isibaar 1.1
282 :    
283 :     /* move forward to the next byte boundary */
284 :    
285 : edgomez 1.17 static __inline void
286 : edgomez 1.6 BitstreamByteAlign(Bitstream * const bs)
287 : Isibaar 1.1 {
288 :     uint32_t remainder = bs->pos % 8;
289 : edgomez 1.6
290 :     if (remainder) {
291 : Isibaar 1.1 BitstreamSkip(bs, 8 - remainder);
292 :     }
293 :     }
294 :    
295 :    
296 :     /* bitstream length (unit bits) */
297 :    
298 : edgomez 1.6 static uint32_t __inline
299 :     BitstreamPos(const Bitstream * const bs)
300 : Isibaar 1.1 {
301 : edgomez 1.17.2.3 return((uint32_t)(8*((ptr_t)bs->tail - (ptr_t)bs->start) + bs->pos - bs->initpos));
302 : Isibaar 1.1 }
303 :    
304 :    
305 : edgomez 1.17.2.3 /*
306 :     * flush the bitstream & return length (unit bytes)
307 :     * NOTE: assumes no futher bitstream functions will be called.
308 : Isibaar 1.1 */
309 :    
310 : edgomez 1.6 static uint32_t __inline
311 :     BitstreamLength(Bitstream * const bs)
312 : Isibaar 1.1 {
313 : edgomez 1.17.2.3 uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start);
314 : Isibaar 1.1
315 : edgomez 1.6 if (bs->pos) {
316 : Isibaar 1.1 uint32_t b = bs->buf;
317 : edgomez 1.6
318 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
319 :     BSWAP(b);
320 :     #endif
321 :     *bs->tail = b;
322 :    
323 :     len += (bs->pos + 7) / 8;
324 : edgomez 1.6 }
325 : Isibaar 1.1
326 : edgomez 1.17.2.3 /* initpos is always on a byte boundary */
327 :     if (bs->initpos)
328 :     len -= bs->initpos/8;
329 :    
330 : Isibaar 1.1 return len;
331 :     }
332 :    
333 :    
334 :     /* move bitstream position forward by n bits and write out buffer if needed */
335 :    
336 : edgomez 1.6 static void __inline
337 :     BitstreamForward(Bitstream * const bs,
338 :     const uint32_t bits)
339 : Isibaar 1.1 {
340 : edgomez 1.6 bs->pos += bits;
341 : Isibaar 1.1
342 : edgomez 1.6 if (bs->pos >= 32) {
343 : Isibaar 1.1 uint32_t b = bs->buf;
344 : edgomez 1.6
345 : Isibaar 1.1 #ifndef ARCH_IS_BIG_ENDIAN
346 :     BSWAP(b);
347 :     #endif
348 :     *bs->tail++ = b;
349 :     bs->buf = 0;
350 :     bs->pos -= 32;
351 : edgomez 1.6 }
352 : Isibaar 1.1 }
353 :    
354 :     /* read n bits from bitstream */
355 :    
356 : edgomez 1.6 static uint32_t __inline
357 :     BitstreamGetBits(Bitstream * const bs,
358 :     const uint32_t n)
359 : Isibaar 1.1 {
360 :     uint32_t ret = BitstreamShowBits(bs, n);
361 : edgomez 1.6
362 : Isibaar 1.1 BitstreamSkip(bs, n);
363 :     return ret;
364 :     }
365 :    
366 :    
367 :     /* read single bit from bitstream */
368 :    
369 : edgomez 1.6 static uint32_t __inline
370 :     BitstreamGetBit(Bitstream * const bs)
371 : Isibaar 1.1 {
372 :     return BitstreamGetBits(bs, 1);
373 :     }
374 :    
375 :    
376 :     /* write single bit to bitstream */
377 :    
378 : edgomez 1.6 static void __inline
379 :     BitstreamPutBit(Bitstream * const bs,
380 :     const uint32_t bit)
381 : Isibaar 1.1 {
382 : edgomez 1.6 if (bit)
383 : Isibaar 1.1 bs->buf |= (0x80000000 >> bs->pos);
384 :    
385 : edgomez 1.6 BitstreamForward(bs, 1);
386 : Isibaar 1.1 }
387 :    
388 :    
389 :     /* write n bits to bitstream */
390 :    
391 : edgomez 1.6 static void __inline
392 :     BitstreamPutBits(Bitstream * const bs,
393 :     const uint32_t value,
394 :     const uint32_t size)
395 : Isibaar 1.1 {
396 :     uint32_t shift = 32 - bs->pos - size;
397 :    
398 :     if (shift <= 32) {
399 :     bs->buf |= value << shift;
400 :     BitstreamForward(bs, size);
401 :     } else {
402 :     uint32_t remainder;
403 :    
404 :     shift = size - (32 - bs->pos);
405 :     bs->buf |= value >> shift;
406 :     BitstreamForward(bs, size - shift);
407 :     remainder = shift;
408 :    
409 :     shift = 32 - shift;
410 : edgomez 1.6
411 : Isibaar 1.1 bs->buf |= value << shift;
412 :     BitstreamForward(bs, remainder);
413 :     }
414 :     }
415 :    
416 : edgomez 1.17 static const int stuffing_codes[8] =
417 :     {
418 :     /* nbits stuffing code */
419 :     0, /* 1 0 */
420 :     1, /* 2 01 */
421 :     3, /* 3 011 */
422 :     7, /* 4 0111 */
423 :     0xf, /* 5 01111 */
424 :     0x1f, /* 6 011111 */
425 :     0x3f, /* 7 0111111 */
426 :     0x7f, /* 8 01111111 */
427 :     };
428 :    
429 :     /* pad bitstream to the next byte boundary */
430 :    
431 :     static void __inline
432 :     BitstreamPad(Bitstream * const bs)
433 :     {
434 :     int bits = 8 - (bs->pos % 8);
435 :     if (bits < 8)
436 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
437 :     }
438 :    
439 :    
440 : edgomez 1.17.2.3 /*
441 :     * pad bitstream to the next byte boundary
442 :     * alway pad: even if currently at the byte boundary
443 :     */
444 : edgomez 1.17
445 :     static void __inline
446 :     BitstreamPadAlways(Bitstream * const bs)
447 :     {
448 :     int bits = 8 - (bs->pos % 8);
449 :     BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
450 :     }
451 :    
452 : edgomez 1.17.2.3 #endif /* _BITSTREAM_H_ */
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4