[cvs] / xvidcore / src / bitstream / bitstream.h Repository:
ViewVC logotype

Diff of /xvidcore/src/bitstream/bitstream.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.2, Tue Mar 26 11:16:08 2002 UTC revision 1.20, Sun Dec 5 13:56:13 2004 UTC
# Line 1  Line 1 
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-2003 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 program is free software ; you can redistribute it and/or modify
9    *  would be at such party's own risk.  The original developer of this        *   *  it under the terms of the GNU General Public License as published by
10    *  software module and his/her company, and subsequent editors and their     *   *  the Free Software Foundation ; either version 2 of the License, or
11    *  companies, will have no liability for use of this software or             *   *  (at your option) any later version.
12    *  modifications or derivatives thereof.                                     *   *
13    *                                                                            *   *  This program is distributed in the hope that it will be useful,
14    *  XviD is free software; you can redistribute it and/or modify it           *   *  but WITHOUT ANY WARRANTY ; without even the implied warranty of
15    *  under the terms of the GNU General Public License as published by         *   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    *  the Free Software Foundation; either version 2 of the License, or         *   *  GNU General Public License for more details.
17    *  (at your option) any later version.                                       *   *
18    *                                                                            *   *  You should have received a copy of the GNU General Public License
19    *  XviD is distributed in the hope that it will be useful, but               *   *  along with this program ; if not, write to the Free Software
20    *  WITHOUT ANY WARRANTY; without even the implied warranty of                *   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21    *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *   *
22    *  GNU General Public License for more details.                              *   * $Id$
23    *                                                                            *   *
24    *  You should have received a copy of the GNU General Public License         *   ****************************************************************************/
   *  along with this program; if not, write to the Free Software               *  
   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA  *  
   *                                                                            *  
   ******************************************************************************/  
   
  /******************************************************************************  
   *                                                                            *  
   *  bitstream.h                                                               *  
   *                                                                            *  
   *  Copyright (C) 2001 - Peter Ross <pross@cs.rmit.edu.au>                    *  
   *                                                                            *  
   *  For more information visit the XviD homepage: http://www.xvid.org         *  
   *                                                                            *  
   ******************************************************************************/  
   
  /******************************************************************************  
   *                                                                                                                                                        *  
   *  Revision history:                                                         *  
   *                                                                            *  
   *  26.03.2002 interlacing support - modified putvol/vopheaders paramters  
   *  04.03.2002 putbits speedup (Isibaar)                                      *  
   *  03.03.2002 merged BITREADER and BITWRITER (Isibaar)                       *  
   *      16.12.2001     inital version                                                     *  
   *                                                                                                                                                        *  
   ******************************************************************************/  
25    
26  #ifndef _BITSTREAM_H_  #ifndef _BITSTREAM_H_
27  #define _BITSTREAM_H_  #define _BITSTREAM_H_
# Line 55  Line 30 
30  #include "../decoder.h"  #include "../decoder.h"
31  #include "../encoder.h"  #include "../encoder.h"
32    
33  // comment any #defs we dont use  
34    /*****************************************************************************
35     * Constants
36     ****************************************************************************/
37    
38    /* comment any #defs we dont use */
39    
40  #define VIDOBJ_START_CODE               0x00000100      /* ..0x0000011f  */  #define VIDOBJ_START_CODE               0x00000100      /* ..0x0000011f  */
41  #define VIDOBJLAY_START_CODE    0x00000120      /* ..0x0000012f */  #define VIDOBJLAY_START_CODE    0x00000120      /* ..0x0000012f */
# Line 63  Line 43 
43  #define VISOBJSEQ_STOP_CODE             0x000001b1      /* ??? */  #define VISOBJSEQ_STOP_CODE             0x000001b1      /* ??? */
44  #define USERDATA_START_CODE             0x000001b2  #define USERDATA_START_CODE             0x000001b2
45  #define GRPOFVOP_START_CODE             0x000001b3  #define GRPOFVOP_START_CODE             0x000001b3
46  //#define VIDSESERR_ERROR_CODE  0x000001b4  /*#define VIDSESERR_ERROR_CODE  0x000001b4 */
47  #define VISOBJ_START_CODE               0x000001b5  #define VISOBJ_START_CODE               0x000001b5
48  //#define SLICE_START_CODE              0x000001b7  #define VOP_START_CODE                  0x000001b6
49  //#define EXT_START_CODE                0x000001b8  /*#define STUFFING_START_CODE   0x000001c3 */
50    
51    
52  #define VISOBJ_TYPE_VIDEO                               1  #define VISOBJ_TYPE_VIDEO                               1
53  //#define VISOBJ_TYPE_STILLTEXTURE              2  /*#define VISOBJ_TYPE_STILLTEXTURE      2 */
54  //#define VISOBJ_TYPE_MESH                              3  /*#define VISOBJ_TYPE_MESH              3 */
55  //#define VISOBJ_TYPE_FBA                               4  /*#define VISOBJ_TYPE_FBA               4 */
56  //#define VISOBJ_TYPE_3DMESH                    5  /*#define VISOBJ_TYPE_3DMESH            5 */
57    
58    
59  #define VIDOBJLAY_TYPE_SIMPLE                   1  #define VIDOBJLAY_TYPE_SIMPLE                   1
60  //#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE        2  /*#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE    2 */
61  #define VIDOBJLAY_TYPE_CORE                             3  /*#define VIDOBJLAY_TYPE_CORE                           3 */
62  #define VIDOBJLAY_TYPE_MAIN                             4  /*#define VIDOBJLAY_TYPE_MAIN                           4 */
63    /*#define VIDOBJLAY_TYPE_NBIT                           5 */
64    /*#define VIDOBJLAY_TYPE_ANIM_TEXT                      6 */
65  //#define VIDOBJLAY_AR_SQUARE                   1  /*#define VIDOBJLAY_TYPE_ANIM_MESH                      7 */
66  //#define VIDOBJLAY_AR_625TYPE_43               2  /*#define VIDOBJLAY_TYPE_SIMPLE_FACE            8 */
67  //#define VIDOBJLAY_AR_525TYPE_43               3  /*#define VIDOBJLAY_TYPE_STILL_SCALABLE         9 */
68  //#define VIDOBJLAY_AR_625TYPE_169              8  #define VIDOBJLAY_TYPE_ART_SIMPLE               10
69  //#define VIDOBJLAY_AR_525TYPE_169              9  /*#define VIDOBJLAY_TYPE_CORE_SCALABLE          11 */
70    /*#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    
78    
79    /*#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  #define VIDOBJLAY_AR_EXTPAR                             15  #define VIDOBJLAY_AR_EXTPAR                             15
85    
86    
# Line 95  Line 89 
89  #define VIDOBJLAY_SHAPE_BINARY_ONLY             2  #define VIDOBJLAY_SHAPE_BINARY_ONLY             2
90  #define VIDOBJLAY_SHAPE_GRAYSCALE               3  #define VIDOBJLAY_SHAPE_GRAYSCALE               3
91    
92  #define VO_START_CODE   0x8  
93  #define VOL_START_CODE  0x12  #define SPRITE_NONE             0
94  #define VOP_START_CODE  0x1b6  #define SPRITE_STATIC   1
95    #define SPRITE_GMC              2
96    
97    
98    
99  #define READ_MARKER()   BitstreamSkip(bs, 1)  #define READ_MARKER()   BitstreamSkip(bs, 1)
100  #define WRITE_MARKER()  BitstreamPutBit(bs, 1)  #define WRITE_MARKER()  BitstreamPutBit(bs, 1)
101    
102  // vop coding types  /* vop coding types  */
103  // intra, prediction, backward, sprite, not_coded  /* intra, prediction, backward, sprite, not_coded */
104  #define I_VOP   0  #define I_VOP   0
105  #define P_VOP   1  #define P_VOP   1
106  #define B_VOP   2  #define B_VOP   2
107  #define S_VOP   3  #define S_VOP   3
108  #define N_VOP   4  #define N_VOP   4
109    
110    /* resync-specific */
111  typedef struct  #define NUMBITS_VP_RESYNC_MARKER  17
112  {  #define RESYNC_MARKER 1
113          uint32_t bufa;  
114          uint32_t bufb;  
115          uint32_t buf;  /*****************************************************************************
116          uint32_t pos;   * Prototypes
117          uint32_t *tail;   ****************************************************************************/
118          uint32_t *start;  
119          uint32_t length;  int read_video_packet_header(Bitstream *bs,
120  }                                                           DECODER * dec,
121  Bitstream;                                                           const int addbits,
122                                                             int *quant,
123                                                             int *fcode_forward,
124  // header stuff                                                           int *fcode_backward,
125  int BitstreamReadHeaders(Bitstream * bs, DECODER * dec, uint32_t * rounding,                                                           int *intra_dc_threshold);
126                                                   uint32_t * quant, uint32_t * fcode, uint32_t * intra_dc_threshold);  
127    /* header stuff */
128    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                                                     uint32_t * intra_dc_threshold,
135                                                     WARPPOINTS * gmc_warp);
136    
137    
138  void BitstreamWriteVolHeader(Bitstream * const bs,  void BitstreamWriteVolHeader(Bitstream * const bs,
139                                                  const MBParam * pParam);                                                           const MBParam * pParam,
140                                                             const FRAMEINFO * const frame);
141    
142  void BitstreamWriteVopHeader(Bitstream * const bs,  void BitstreamWriteVopHeader(Bitstream * const bs,
143                                                  const MBParam * pParam);                                                           const MBParam * pParam,
144                                                             const FRAMEINFO * const frame,
145                                                             int vop_coded,
146                                                             unsigned int quant);
147    
148    void BitstreamWriteUserData(Bitstream * const bs,
149                                                            uint8_t * data,
150                                                            const int length);
151    
152  /* initialise bitstream structure */  /* initialise bitstream structure */
153    
154  static void __inline BitstreamInit(Bitstream * const bs,  static void __inline
155    BitstreamInit(Bitstream * const bs,
156                                                                     void * const bitstream,                                                                     void * const bitstream,
157                                                                     uint32_t length)                                                                     uint32_t length)
158  {  {
159          uint32_t tmp;          uint32_t tmp;
160            size_t bitpos;
161            ptr_t adjbitstream = (ptr_t)bitstream;
162    
163          bs->start = bs->tail = (uint32_t*)bitstream;          /*
164             * Start the stream on a uint32_t boundary, by rounding down to the
165             * previous uint32_t and skipping the intervening bytes.
166             */
167            bitpos = ((sizeof(uint32_t)-1) & (size_t)bitstream);
168            adjbitstream = adjbitstream - bitpos;
169            bs->start = bs->tail = (uint32_t *) adjbitstream;
170    
171          tmp = *(uint32_t *)bitstream;          tmp = *bs->start;
172  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
173          BSWAP(tmp);          BSWAP(tmp);
174  #endif  #endif
175          bs->bufa = tmp;          bs->bufa = tmp;
176    
177          tmp = *((uint32_t *)bitstream + 1);          tmp = *(bs->start + 1);
178  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
179          BSWAP(tmp);          BSWAP(tmp);
180  #endif  #endif
181          bs->bufb = tmp;          bs->bufb = tmp;
182    
183          bs->buf = 0;          bs->buf = 0;
184          bs->pos = 0;          bs->pos = bs->initpos = bitpos*8;
185          bs->length = length;          bs->length = length;
186  }  }
187    
188    
189  /* reset bitstream state */  /* reset bitstream state */
190    
191  static void __inline BitstreamReset(Bitstream * const bs)  static void __inline
192    BitstreamReset(Bitstream * const bs)
193  {  {
194          uint32_t tmp;          uint32_t tmp;
195    
# Line 186  Line 208 
208          bs->bufb = tmp;          bs->bufb = tmp;
209    
210          bs->buf = 0;          bs->buf = 0;
211      bs->pos = 0;          bs->pos = bs->initpos;
212  }  }
213    
214    
215  /* reads n bits from bitstream without changing the stream pos */  /* reads n bits from bitstream without changing the stream pos */
216    
217  static uint32_t __inline BitstreamShowBits(Bitstream * const bs,  static uint32_t __inline
218    BitstreamShowBits(Bitstream * const bs,
219                                                                                     const uint32_t bits)                                                                                     const uint32_t bits)
220  {  {
221          int nbit = (bits + bs->pos) - 32;          int nbit = (bits + bs->pos) - 32;
222          if (nbit > 0)  
223          {          if (nbit > 0) {
224                  return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) |                  return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs->
225                                  (bs->bufb >> (32 - nbit));                                                                                                                                   bufb >> (32 -
226          }                                                                                                                                                    nbit));
227          else          } else {
         {  
228                  return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);                  return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);
229          }          }
230  }  }
# Line 210  Line 232 
232    
233  /* skip n bits forward in bitstream */  /* skip n bits forward in bitstream */
234    
235  static __inline void BitstreamSkip(Bitstream * const bs, const uint32_t bits)  static __inline void
236    BitstreamSkip(Bitstream * const bs,
237                              const uint32_t bits)
238  {  {
239          bs->pos += bits;          bs->pos += bits;
240    
241          if (bs->pos >= 32)          if (bs->pos >= 32) {
         {  
242                  uint32_t tmp;                  uint32_t tmp;
243    
244                  bs->bufa = bs->bufb;                  bs->bufa = bs->bufb;
# Line 230  Line 253 
253  }  }
254    
255    
256    /* number of bits to next byte alignment */
257    static __inline uint32_t
258    BitstreamNumBitsToByteAlign(Bitstream *bs)
259    {
260            uint32_t n = (32 - bs->pos) % 8;
261            return n == 0 ? 8 : n;
262    }
263    
264    
265    /* show nbits from next byte alignment */
266    static __inline uint32_t
267    BitstreamShowBitsFromByteAlign(Bitstream *bs, int bits)
268    {
269            int bspos = bs->pos + BitstreamNumBitsToByteAlign(bs);
270            int nbit = (bits + bspos) - 32;
271    
272            if (bspos >= 32) {
273                    return bs->bufb >> (32 - nbit);
274            } else  if (nbit > 0) {
275                    return ((bs->bufa & (0xffffffff >> bspos)) << nbit) | (bs->
276                                                                                                                                     bufb >> (32 -
277                                                                                                                                                      nbit));
278            } else {
279                    return (bs->bufa & (0xffffffff >> bspos)) >> (32 - bspos - bits);
280            }
281    
282    }
283    
284    
285    
286  /* move forward to the next byte boundary */  /* move forward to the next byte boundary */
287    
288  static __inline void BitstreamByteAlign(Bitstream * const bs)  static __inline void
289    BitstreamByteAlign(Bitstream * const bs)
290  {  {
291          uint32_t remainder = bs->pos % 8;          uint32_t remainder = bs->pos % 8;
292          if (remainder)  
293          {          if (remainder) {
294                  BitstreamSkip(bs, 8 - remainder);                  BitstreamSkip(bs, 8 - remainder);
295          }          }
296  }  }
# Line 244  Line 298 
298    
299  /* bitstream length (unit bits) */  /* bitstream length (unit bits) */
300    
301  static uint32_t __inline BitstreamPos(const Bitstream * const bs)  static uint32_t __inline
302    BitstreamPos(const Bitstream * const bs)
303  {  {
304      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));
305  }  }
306    
307    
308  /*      flush the bitstream & return length (unit bytes)  /*
309          NOTE: assumes no futher bitstream functions will be called.   * flush the bitstream & return length (unit bytes)
310     * NOTE: assumes no futher bitstream functions will be called.
311   */   */
312    
313  static uint32_t __inline BitstreamLength(Bitstream * const bs)  static uint32_t __inline
314    BitstreamLength(Bitstream * const bs)
315  {  {
316          uint32_t len = (uint32_t) bs->tail - (uint32_t) bs->start;          uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start);
317    
318      if (bs->pos)          if (bs->pos) {
     {  
319                  uint32_t b = bs->buf;                  uint32_t b = bs->buf;
320    
321  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
322                  BSWAP(b);                  BSWAP(b);
323  #endif  #endif
# Line 269  Line 326 
326                  len += (bs->pos + 7) / 8;                  len += (bs->pos + 7) / 8;
327      }      }
328    
329            /* initpos is always on a byte boundary */
330            if (bs->initpos)
331                    len -= bs->initpos/8;
332    
333          return len;          return len;
334  }  }
335    
336    
337  /* 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 */
338    
339  static void __inline BitstreamForward(Bitstream * const bs, const uint32_t bits)  static void __inline
340    BitstreamForward(Bitstream * const bs,
341                                     const uint32_t bits)
342  {  {
343      bs->pos += bits;      bs->pos += bits;
344    
345      if (bs->pos >= 32)          if (bs->pos >= 32) {
     {  
346                  uint32_t b = bs->buf;                  uint32_t b = bs->buf;
347    
348  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
349                  BSWAP(b);                  BSWAP(b);
350  #endif  #endif
# Line 291  Line 354 
354      }      }
355  }  }
356    
   
 /* pad bitstream to the next byte boundary */  
   
 static void __inline BitstreamPad(Bitstream * const bs)  
 {  
         uint32_t remainder = bs->pos % 8;  
   
     if (remainder)  
     {  
                 BitstreamForward(bs, 8 - remainder);  
     }  
 }  
   
   
357  /* read n bits from bitstream */  /* read n bits from bitstream */
358    
359  static uint32_t __inline BitstreamGetBits(Bitstream * const bs,  static uint32_t __inline
360    BitstreamGetBits(Bitstream * const bs,
361                                                                                    const uint32_t n)                                                                                    const uint32_t n)
362  {  {
363          uint32_t ret = BitstreamShowBits(bs, n);          uint32_t ret = BitstreamShowBits(bs, n);
364    
365          BitstreamSkip(bs, n);          BitstreamSkip(bs, n);
366          return ret;          return ret;
367  }  }
# Line 318  Line 369 
369    
370  /* read single bit from bitstream */  /* read single bit from bitstream */
371    
372  static uint32_t __inline BitstreamGetBit(Bitstream * const bs)  static uint32_t __inline
373    BitstreamGetBit(Bitstream * const bs)
374  {  {
375          return BitstreamGetBits(bs, 1);          return BitstreamGetBits(bs, 1);
376  }  }
# Line 326  Line 378 
378    
379  /* write single bit to bitstream */  /* write single bit to bitstream */
380    
381  static void __inline BitstreamPutBit(Bitstream * const bs,  static void __inline
382    BitstreamPutBit(Bitstream * const bs,
383                                                                          const uint32_t bit)                                                                          const uint32_t bit)
384  {  {
385      if (bit)      if (bit)
# Line 338  Line 391 
391    
392  /* write n bits to bitstream */  /* write n bits to bitstream */
393    
394  static void __inline BitstreamPutBits(Bitstream * const bs,  static void __inline
395    BitstreamPutBits(Bitstream * const bs,
396                                                                          const uint32_t value,                                                                          const uint32_t value,
397                                                                          const uint32_t size)                                                                          const uint32_t size)
398  {  {
# Line 362  Line 416 
416          }          }
417  }  }
418    
419    static const int stuffing_codes[8] =
420    {
421                    /* nbits     stuffing code */
422            0,              /* 1          0 */
423            1,              /* 2          01 */
424            3,              /* 3          011 */
425            7,              /* 4          0111 */
426            0xf,    /* 5          01111 */
427            0x1f,   /* 6          011111 */
428            0x3f,   /* 7          0111111 */
429            0x7f,   /* 8          01111111 */
430    };
431    
432    /* pad bitstream to the next byte boundary */
433    
434    static void __inline
435    BitstreamPad(Bitstream * const bs)
436    {
437            int bits = 8 - (bs->pos % 8);
438            if (bits < 8)
439                    BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
440    }
441    
442    
443    /*
444     * pad bitstream to the next byte boundary
445     * alway pad: even if currently at the byte boundary
446     */
447    
448    static void __inline
449    BitstreamPadAlways(Bitstream * const bs)
450    {
451            int bits = 8 - (bs->pos % 8);
452            BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
453    }
454    
455  #endif /* _BITSTREAM_H_ */  #endif /* _BITSTREAM_H_ */

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.20

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