1 |
/****************************************************************************** |
/***************************************************************************** |
2 |
* * |
* |
3 |
* This file is part of XviD, a free MPEG-4 video encoder/decoder * |
* XVID MPEG-4 VIDEO CODEC |
4 |
* * |
* - Bitstream reader/writer inlined functions and constants- |
5 |
* XviD is an implementation of a part of one or more MPEG-4 Video tools * |
* |
6 |
* as specified in ISO/IEC 14496-2 standard. Those intending to use this * |
* Copyright (C) 2001-2002 - Peter Ross <pross@xvid.org> |
7 |
* software module in hardware or software products are advised that its * |
* |
8 |
* use may infringe existing patents or copyrights, and any such use * |
* This file is part of XviD, a free MPEG-4 video encoder/decoder |
9 |
* would be at such party's own risk. The original developer of this * |
* |
10 |
* software module and his/her company, and subsequent editors and their * |
* XviD is free software; you can redistribute it and/or modify it |
11 |
* companies, will have no liability for use of this software or * |
* under the terms of the GNU General Public License as published by |
12 |
* modifications or derivatives thereof. * |
* the Free Software Foundation; either version 2 of the License, or |
13 |
* * |
* (at your option) any later version. |
14 |
* XviD is free software; you can redistribute it and/or modify it * |
* |
15 |
* under the terms of the GNU General Public License as published by * |
* This program is distributed in the hope that it will be useful, |
16 |
* the Free Software Foundation; either version 2 of the License, or * |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
17 |
* (at your option) any later version. * |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
18 |
* * |
* GNU General Public License for more details. |
19 |
* XviD is distributed in the hope that it will be useful, but * |
* |
20 |
* WITHOUT ANY WARRANTY; without even the implied warranty of * |
* You should have received a copy of the GNU General Public License |
21 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * |
* along with this program; if not, write to the Free Software |
22 |
* GNU General Public License for more details. * |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
23 |
* * |
* |
24 |
* You should have received a copy of the GNU General Public License * |
* Under section 8 of the GNU General Public License, the copyright |
25 |
* along with this program; if not, write to the Free Software * |
* holders of XVID explicitly forbid distribution in the following |
26 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * |
* countries: |
27 |
* * |
* |
28 |
******************************************************************************/ |
* - Japan |
29 |
|
* - United States of America |
30 |
/****************************************************************************** |
* |
31 |
* * |
* Linking XviD statically or dynamically with other modules is making a |
32 |
* bitstream.h * |
* combined work based on XviD. Thus, the terms and conditions of the |
33 |
* * |
* GNU General Public License cover the whole combination. |
34 |
* Copyright (C) 2001 - Peter Ross <pross@cs.rmit.edu.au> * |
* |
35 |
* * |
* As a special exception, the copyright holders of XviD give you |
36 |
* For more information visit the XviD homepage: http://www.xvid.org * |
* permission to link XviD with independent modules that communicate with |
37 |
* * |
* XviD solely through the VFW1.1 and DShow interfaces, regardless of the |
38 |
******************************************************************************/ |
* license terms of these independent modules, and to copy and distribute |
39 |
|
* the resulting combined work under terms of your choice, provided that |
40 |
/****************************************************************************** |
* every copy of the combined work is accompanied by a complete copy of |
41 |
* * |
* the source code of XviD (the version of XviD used to produce the |
42 |
* Revision history: * |
* combined work), being distributed under the terms of the GNU General |
43 |
* * |
* Public License plus this exception. An independent module is a module |
44 |
* 26.03.2002 interlacing support - modified putvol/vopheaders paramters |
* which is not derived from or based on XviD. |
45 |
* 04.03.2002 putbits speedup (Isibaar) * |
* |
46 |
* 03.03.2002 merged BITREADER and BITWRITER (Isibaar) * |
* Note that people who make modified versions of XviD are not obligated |
47 |
* 16.12.2001 inital version * |
* to grant this special exception for their modified versions; it is |
48 |
* * |
* their choice whether to do so. The GNU General Public License gives |
49 |
******************************************************************************/ |
* permission to release a modified version without this exception; this |
50 |
|
* exception also makes it possible to release a modified version which |
51 |
|
* carries forward this exception. |
52 |
|
* |
53 |
|
* $Id$ |
54 |
|
* |
55 |
|
****************************************************************************/ |
56 |
|
|
57 |
#ifndef _BITSTREAM_H_ |
#ifndef _BITSTREAM_H_ |
58 |
#define _BITSTREAM_H_ |
#define _BITSTREAM_H_ |
59 |
|
|
60 |
|
#include <stdio.h> |
61 |
|
|
62 |
#include "../portab.h" |
#include "../portab.h" |
63 |
#include "../decoder.h" |
#include "../decoder.h" |
64 |
#include "../encoder.h" |
#include "../encoder.h" |
65 |
|
|
66 |
// comment any #defs we dont use |
|
67 |
|
/***************************************************************************** |
68 |
|
* Constants |
69 |
|
****************************************************************************/ |
70 |
|
|
71 |
|
/* comment any #defs we dont use */ |
72 |
|
|
73 |
#define VIDOBJ_START_CODE 0x00000100 /* ..0x0000011f */ |
#define VIDOBJ_START_CODE 0x00000100 /* ..0x0000011f */ |
74 |
#define VIDOBJLAY_START_CODE 0x00000120 /* ..0x0000012f */ |
#define VIDOBJLAY_START_CODE 0x00000120 /* ..0x0000012f */ |
76 |
#define VISOBJSEQ_STOP_CODE 0x000001b1 /* ??? */ |
#define VISOBJSEQ_STOP_CODE 0x000001b1 /* ??? */ |
77 |
#define USERDATA_START_CODE 0x000001b2 |
#define USERDATA_START_CODE 0x000001b2 |
78 |
#define GRPOFVOP_START_CODE 0x000001b3 |
#define GRPOFVOP_START_CODE 0x000001b3 |
79 |
//#define VIDSESERR_ERROR_CODE 0x000001b4 |
/*#define VIDSESERR_ERROR_CODE 0x000001b4 */ |
80 |
#define VISOBJ_START_CODE 0x000001b5 |
#define VISOBJ_START_CODE 0x000001b5 |
81 |
//#define SLICE_START_CODE 0x000001b7 |
/*#define SLICE_START_CODE 0x000001b7 */ |
82 |
//#define EXT_START_CODE 0x000001b8 |
/*#define EXT_START_CODE 0x000001b8 */ |
83 |
|
|
84 |
|
|
85 |
#define VISOBJ_TYPE_VIDEO 1 |
#define VISOBJ_TYPE_VIDEO 1 |
86 |
//#define VISOBJ_TYPE_STILLTEXTURE 2 |
/*#define VISOBJ_TYPE_STILLTEXTURE 2 */ |
87 |
//#define VISOBJ_TYPE_MESH 3 |
/*#define VISOBJ_TYPE_MESH 3 */ |
88 |
//#define VISOBJ_TYPE_FBA 4 |
/*#define VISOBJ_TYPE_FBA 4 */ |
89 |
//#define VISOBJ_TYPE_3DMESH 5 |
/*#define VISOBJ_TYPE_3DMESH 5 */ |
90 |
|
|
91 |
|
|
92 |
#define VIDOBJLAY_TYPE_SIMPLE 1 |
#define VIDOBJLAY_TYPE_SIMPLE 1 |
93 |
//#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE 2 |
/*#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE 2 */ |
94 |
#define VIDOBJLAY_TYPE_CORE 3 |
#define VIDOBJLAY_TYPE_CORE 3 |
95 |
#define VIDOBJLAY_TYPE_MAIN 4 |
#define VIDOBJLAY_TYPE_MAIN 4 |
96 |
|
|
97 |
|
|
98 |
//#define VIDOBJLAY_AR_SQUARE 1 |
/*#define VIDOBJLAY_AR_SQUARE 1 */ |
99 |
//#define VIDOBJLAY_AR_625TYPE_43 2 |
/*#define VIDOBJLAY_AR_625TYPE_43 2 */ |
100 |
//#define VIDOBJLAY_AR_525TYPE_43 3 |
/*#define VIDOBJLAY_AR_525TYPE_43 3 */ |
101 |
//#define VIDOBJLAY_AR_625TYPE_169 8 |
/*#define VIDOBJLAY_AR_625TYPE_169 8 */ |
102 |
//#define VIDOBJLAY_AR_525TYPE_169 9 |
/*#define VIDOBJLAY_AR_525TYPE_169 9 */ |
103 |
#define VIDOBJLAY_AR_EXTPAR 15 |
#define VIDOBJLAY_AR_EXTPAR 15 |
104 |
|
|
105 |
|
|
115 |
#define READ_MARKER() BitstreamSkip(bs, 1) |
#define READ_MARKER() BitstreamSkip(bs, 1) |
116 |
#define WRITE_MARKER() BitstreamPutBit(bs, 1) |
#define WRITE_MARKER() BitstreamPutBit(bs, 1) |
117 |
|
|
118 |
// vop coding types |
/* vop coding types */ |
119 |
// intra, prediction, backward, sprite, not_coded |
/* intra, prediction, backward, sprite, not_coded */ |
120 |
#define I_VOP 0 |
#define I_VOP 0 |
121 |
#define P_VOP 1 |
#define P_VOP 1 |
122 |
#define B_VOP 2 |
#define B_VOP 2 |
123 |
#define S_VOP 3 |
#define S_VOP 3 |
124 |
#define N_VOP 4 |
#define N_VOP 4 |
125 |
|
|
126 |
|
/* resync-specific */ |
127 |
// header stuff |
#define NUMBITS_VP_RESYNC_MARKER 17 |
128 |
int BitstreamReadHeaders(Bitstream * bs, DECODER * dec, uint32_t * rounding, |
#define RESYNC_MARKER 1 |
129 |
uint32_t * quant, uint32_t * fcode, uint32_t * intra_dc_threshold); |
|
130 |
|
|
131 |
|
/***************************************************************************** |
132 |
|
* Prototypes |
133 |
|
****************************************************************************/ |
134 |
|
|
135 |
|
int |
136 |
|
read_video_packet_header(Bitstream *bs, const int addbits, int * quant); |
137 |
|
|
138 |
|
|
139 |
|
/* header stuff */ |
140 |
|
int BitstreamReadHeaders(Bitstream * bs, |
141 |
|
DECODER * dec, |
142 |
|
uint32_t * rounding, |
143 |
|
uint32_t * quant, |
144 |
|
uint32_t * fcode_forward, |
145 |
|
uint32_t * fcode_backward, |
146 |
|
uint32_t * intra_dc_threshold); |
147 |
|
|
148 |
|
|
149 |
void BitstreamWriteVolHeader(Bitstream * const bs, |
void BitstreamWriteVolHeader(Bitstream * const bs, |
150 |
const MBParam * pParam); |
const MBParam * pParam, |
151 |
|
const FRAMEINFO * frame); |
152 |
|
|
153 |
void BitstreamWriteVopHeader(Bitstream * const bs, |
void BitstreamWriteVopHeader(Bitstream * const bs, |
154 |
const MBParam * pParam); |
const MBParam * pParam, |
155 |
|
const FRAMEINFO * frame, |
156 |
|
int vop_coded); |
157 |
|
|
158 |
|
/***************************************************************************** |
159 |
|
* Inlined functions |
160 |
|
****************************************************************************/ |
161 |
|
|
162 |
/* initialise bitstream structure */ |
/* initialise bitstream structure */ |
163 |
|
|
164 |
static void __inline BitstreamInit(Bitstream * const bs, |
static void __inline |
165 |
|
BitstreamInit(Bitstream * const bs, |
166 |
void * const bitstream, |
void * const bitstream, |
167 |
uint32_t length) |
uint32_t length) |
168 |
{ |
{ |
169 |
uint32_t tmp; |
uint32_t tmp; |
170 |
|
size_t bitpos; |
171 |
|
ptr_t adjbitstream = (ptr_t)bitstream; |
172 |
|
|
173 |
bs->start = bs->tail = (uint32_t*)bitstream; |
/* |
174 |
|
* Start the stream on a uint32_t boundary, by rounding down to the |
175 |
|
* previous uint32_t and skipping the intervening bytes. |
176 |
|
*/ |
177 |
|
bitpos = ((sizeof(uint32_t)-1) & (size_t)bitstream); |
178 |
|
adjbitstream = adjbitstream - bitpos; |
179 |
|
bs->start = bs->tail = (uint32_t *) adjbitstream; |
180 |
|
|
181 |
tmp = *(uint32_t *)bitstream; |
tmp = *bs->start; |
182 |
#ifndef ARCH_IS_BIG_ENDIAN |
#ifndef ARCH_IS_BIG_ENDIAN |
183 |
BSWAP(tmp); |
BSWAP(tmp); |
184 |
#endif |
#endif |
185 |
bs->bufa = tmp; |
bs->bufa = tmp; |
186 |
|
|
187 |
tmp = *((uint32_t *)bitstream + 1); |
tmp = *(bs->start + 1); |
188 |
#ifndef ARCH_IS_BIG_ENDIAN |
#ifndef ARCH_IS_BIG_ENDIAN |
189 |
BSWAP(tmp); |
BSWAP(tmp); |
190 |
#endif |
#endif |
191 |
bs->bufb = tmp; |
bs->bufb = tmp; |
192 |
|
|
193 |
bs->buf = 0; |
bs->buf = 0; |
194 |
bs->pos = 0; |
bs->pos = bs->initpos = bitpos*8; |
195 |
bs->length = length; |
bs->length = length; |
196 |
} |
} |
197 |
|
|
198 |
|
|
199 |
/* reset bitstream state */ |
/* reset bitstream state */ |
200 |
|
|
201 |
static void __inline BitstreamReset(Bitstream * const bs) |
static void __inline |
202 |
|
BitstreamReset(Bitstream * const bs) |
203 |
{ |
{ |
204 |
uint32_t tmp; |
uint32_t tmp; |
205 |
|
|
218 |
bs->bufb = tmp; |
bs->bufb = tmp; |
219 |
|
|
220 |
bs->buf = 0; |
bs->buf = 0; |
221 |
bs->pos = 0; |
bs->pos = bs->initpos; |
222 |
} |
} |
223 |
|
|
224 |
|
|
225 |
/* reads n bits from bitstream without changing the stream pos */ |
/* reads n bits from bitstream without changing the stream pos */ |
226 |
|
|
227 |
static uint32_t __inline BitstreamShowBits(Bitstream * const bs, |
static uint32_t __inline |
228 |
|
BitstreamShowBits(Bitstream * const bs, |
229 |
const uint32_t bits) |
const uint32_t bits) |
230 |
{ |
{ |
231 |
int nbit = (bits + bs->pos) - 32; |
int nbit = (bits + bs->pos) - 32; |
232 |
if (nbit > 0) |
|
233 |
{ |
if (nbit > 0) { |
234 |
return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | |
return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs-> |
235 |
(bs->bufb >> (32 - nbit)); |
bufb >> (32 - |
236 |
} |
nbit)); |
237 |
else |
} else { |
|
{ |
|
238 |
return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits); |
return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits); |
239 |
} |
} |
240 |
} |
} |
242 |
|
|
243 |
/* skip n bits forward in bitstream */ |
/* skip n bits forward in bitstream */ |
244 |
|
|
245 |
static __inline void BitstreamSkip(Bitstream * const bs, const uint32_t bits) |
static void __inline |
246 |
|
BitstreamSkip(Bitstream * const bs, |
247 |
|
const uint32_t bits) |
248 |
{ |
{ |
249 |
bs->pos += bits; |
bs->pos += bits; |
250 |
|
|
251 |
if (bs->pos >= 32) |
if (bs->pos >= 32) { |
|
{ |
|
252 |
uint32_t tmp; |
uint32_t tmp; |
253 |
|
|
254 |
bs->bufa = bs->bufb; |
bs->bufa = bs->bufb; |
263 |
} |
} |
264 |
|
|
265 |
|
|
266 |
|
/* number of bits to next byte alignment */ |
267 |
|
static uint32_t __inline |
268 |
|
BitstreamNumBitsToByteAlign(Bitstream *bs) |
269 |
|
{ |
270 |
|
uint32_t n = (32 - bs->pos) % 8; |
271 |
|
return n == 0 ? 8 : n; |
272 |
|
} |
273 |
|
|
274 |
|
|
275 |
|
/* show nbits from next byte alignment */ |
276 |
|
static uint32_t __inline |
277 |
|
BitstreamShowBitsFromByteAlign(Bitstream *bs, int bits) |
278 |
|
{ |
279 |
|
int bspos = bs->pos + BitstreamNumBitsToByteAlign(bs); |
280 |
|
int nbit = (bits + bspos) - 32; |
281 |
|
|
282 |
|
if (bspos >= 32) { |
283 |
|
return bs->bufb >> (32 - nbit); |
284 |
|
} else if (nbit > 0) { |
285 |
|
return ((bs->bufa & (0xffffffff >> bspos)) << nbit) | (bs-> |
286 |
|
bufb >> (32 - |
287 |
|
nbit)); |
288 |
|
} else { |
289 |
|
return (bs->bufa & (0xffffffff >> bspos)) >> (32 - bspos - bits); |
290 |
|
} |
291 |
|
|
292 |
|
} |
293 |
|
|
294 |
|
|
295 |
|
|
296 |
/* move forward to the next byte boundary */ |
/* move forward to the next byte boundary */ |
297 |
|
|
298 |
static __inline void BitstreamByteAlign(Bitstream * const bs) |
static void __inline |
299 |
|
BitstreamByteAlign(Bitstream * const bs) |
300 |
{ |
{ |
301 |
uint32_t remainder = bs->pos % 8; |
uint32_t remainder = bs->pos % 8; |
302 |
if (remainder) |
|
303 |
{ |
if (remainder) { |
304 |
BitstreamSkip(bs, 8 - remainder); |
BitstreamSkip(bs, 8 - remainder); |
305 |
} |
} |
306 |
} |
} |
308 |
|
|
309 |
/* bitstream length (unit bits) */ |
/* bitstream length (unit bits) */ |
310 |
|
|
311 |
static uint32_t __inline BitstreamPos(const Bitstream * const bs) |
static uint32_t __inline |
312 |
|
BitstreamPos(const Bitstream * const bs) |
313 |
{ |
{ |
314 |
return 8 * ((uint32_t)bs->tail - (uint32_t)bs->start) + bs->pos; |
return((uint32_t)(8*((ptr_t)bs->tail - (ptr_t)bs->start) + bs->pos - bs->initpos)); |
315 |
} |
} |
316 |
|
|
317 |
|
|
319 |
NOTE: assumes no futher bitstream functions will be called. |
NOTE: assumes no futher bitstream functions will be called. |
320 |
*/ |
*/ |
321 |
|
|
322 |
static uint32_t __inline BitstreamLength(Bitstream * const bs) |
static uint32_t __inline |
323 |
|
BitstreamLength(Bitstream * const bs) |
324 |
{ |
{ |
325 |
uint32_t len = (uint32_t) bs->tail - (uint32_t) bs->start; |
uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start); |
326 |
|
|
327 |
if (bs->pos) |
if (bs->pos) { |
|
{ |
|
328 |
uint32_t b = bs->buf; |
uint32_t b = bs->buf; |
329 |
|
|
330 |
#ifndef ARCH_IS_BIG_ENDIAN |
#ifndef ARCH_IS_BIG_ENDIAN |
331 |
BSWAP(b); |
BSWAP(b); |
332 |
#endif |
#endif |
335 |
len += (bs->pos + 7) / 8; |
len += (bs->pos + 7) / 8; |
336 |
} |
} |
337 |
|
|
338 |
|
/* initpos is always on a byte boundary */ |
339 |
|
if (bs->initpos) |
340 |
|
len -= bs->initpos/8; |
341 |
|
|
342 |
return len; |
return len; |
343 |
} |
} |
344 |
|
|
345 |
|
|
346 |
/* move bitstream position forward by n bits and write out buffer if needed */ |
/* move bitstream position forward by n bits and write out buffer if needed */ |
347 |
|
|
348 |
static void __inline BitstreamForward(Bitstream * const bs, const uint32_t bits) |
static void __inline |
349 |
|
BitstreamForward(Bitstream * const bs, |
350 |
|
const uint32_t bits) |
351 |
{ |
{ |
352 |
bs->pos += bits; |
bs->pos += bits; |
353 |
|
|
354 |
if (bs->pos >= 32) |
if (bs->pos >= 32) { |
|
{ |
|
355 |
uint32_t b = bs->buf; |
uint32_t b = bs->buf; |
356 |
|
|
357 |
#ifndef ARCH_IS_BIG_ENDIAN |
#ifndef ARCH_IS_BIG_ENDIAN |
358 |
BSWAP(b); |
BSWAP(b); |
359 |
#endif |
#endif |
366 |
|
|
367 |
/* pad bitstream to the next byte boundary */ |
/* pad bitstream to the next byte boundary */ |
368 |
|
|
369 |
static void __inline BitstreamPad(Bitstream * const bs) |
static void __inline |
370 |
|
BitstreamPad(Bitstream * const bs) |
371 |
{ |
{ |
372 |
uint32_t remainder = bs->pos % 8; |
uint32_t remainder = bs->pos % 8; |
373 |
|
|
374 |
if (remainder) |
if (remainder) { |
|
{ |
|
375 |
BitstreamForward(bs, 8 - remainder); |
BitstreamForward(bs, 8 - remainder); |
376 |
} |
} |
377 |
} |
} |
379 |
|
|
380 |
/* read n bits from bitstream */ |
/* read n bits from bitstream */ |
381 |
|
|
382 |
static uint32_t __inline BitstreamGetBits(Bitstream * const bs, |
static uint32_t __inline |
383 |
|
BitstreamGetBits(Bitstream * const bs, |
384 |
const uint32_t n) |
const uint32_t n) |
385 |
{ |
{ |
386 |
uint32_t ret = BitstreamShowBits(bs, n); |
uint32_t ret = BitstreamShowBits(bs, n); |
387 |
|
|
388 |
BitstreamSkip(bs, n); |
BitstreamSkip(bs, n); |
389 |
return ret; |
return ret; |
390 |
} |
} |
392 |
|
|
393 |
/* read single bit from bitstream */ |
/* read single bit from bitstream */ |
394 |
|
|
395 |
static uint32_t __inline BitstreamGetBit(Bitstream * const bs) |
static uint32_t __inline |
396 |
|
BitstreamGetBit(Bitstream * const bs) |
397 |
{ |
{ |
398 |
return BitstreamGetBits(bs, 1); |
return BitstreamGetBits(bs, 1); |
399 |
} |
} |
401 |
|
|
402 |
/* write single bit to bitstream */ |
/* write single bit to bitstream */ |
403 |
|
|
404 |
static void __inline BitstreamPutBit(Bitstream * const bs, |
static void __inline |
405 |
|
BitstreamPutBit(Bitstream * const bs, |
406 |
const uint32_t bit) |
const uint32_t bit) |
407 |
{ |
{ |
408 |
if (bit) |
if (bit) |
414 |
|
|
415 |
/* write n bits to bitstream */ |
/* write n bits to bitstream */ |
416 |
|
|
417 |
static void __inline BitstreamPutBits(Bitstream * const bs, |
static void __inline |
418 |
|
BitstreamPutBits(Bitstream * const bs, |
419 |
const uint32_t value, |
const uint32_t value, |
420 |
const uint32_t size) |
const uint32_t size) |
421 |
{ |
{ |