[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.4, Thu Apr 25 06:55:00 2002 UTC revision 1.18, Fri Apr 4 22:16:15 2003 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 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         *   * $Id$
25    *  along with this program; if not, write to the Free Software               *   *
26    *  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                                                     *  
   *                                                                                                                                                        *  
   ******************************************************************************/  
27    
28  #ifndef _BITSTREAM_H_  #ifndef _BITSTREAM_H_
29  #define _BITSTREAM_H_  #define _BITSTREAM_H_
# Line 55  Line 32 
32  #include "../decoder.h"  #include "../decoder.h"
33  #include "../encoder.h"  #include "../encoder.h"
34    
35  // comment any #defs we dont use  
36    /*****************************************************************************
37     * Constants
38     ****************************************************************************/
39    
40    /* comment any #defs we dont use */
41    
42  #define VIDOBJ_START_CODE               0x00000100      /* ..0x0000011f  */  #define VIDOBJ_START_CODE               0x00000100      /* ..0x0000011f  */
43  #define VIDOBJLAY_START_CODE    0x00000120      /* ..0x0000012f */  #define VIDOBJLAY_START_CODE    0x00000120      /* ..0x0000012f */
# Line 63  Line 45 
45  #define VISOBJSEQ_STOP_CODE             0x000001b1      /* ??? */  #define VISOBJSEQ_STOP_CODE             0x000001b1      /* ??? */
46  #define USERDATA_START_CODE             0x000001b2  #define USERDATA_START_CODE             0x000001b2
47  #define GRPOFVOP_START_CODE             0x000001b3  #define GRPOFVOP_START_CODE             0x000001b3
48  //#define VIDSESERR_ERROR_CODE  0x000001b4  /*#define VIDSESERR_ERROR_CODE  0x000001b4 */
49  #define VISOBJ_START_CODE               0x000001b5  #define VISOBJ_START_CODE               0x000001b5
50  //#define SLICE_START_CODE              0x000001b7  #define VOP_START_CODE                  0x000001b6
51  //#define EXT_START_CODE                0x000001b8  /*#define STUFFING_START_CODE   0x000001c3 */
52    
53    
54  #define VISOBJ_TYPE_VIDEO                               1  #define VISOBJ_TYPE_VIDEO                               1
55  //#define VISOBJ_TYPE_STILLTEXTURE              2  /*#define VISOBJ_TYPE_STILLTEXTURE      2 */
56  //#define VISOBJ_TYPE_MESH                              3  /*#define VISOBJ_TYPE_MESH              3 */
57  //#define VISOBJ_TYPE_FBA                               4  /*#define VISOBJ_TYPE_FBA               4 */
58  //#define VISOBJ_TYPE_3DMESH                    5  /*#define VISOBJ_TYPE_3DMESH            5 */
59    
60    
61  #define VIDOBJLAY_TYPE_SIMPLE                   1  #define VIDOBJLAY_TYPE_SIMPLE                   1
62  //#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE        2  /*#define VIDOBJLAY_TYPE_SIMPLE_SCALABLE    2 */
63  #define VIDOBJLAY_TYPE_CORE                             3  #define VIDOBJLAY_TYPE_CORE                             3
64  #define VIDOBJLAY_TYPE_MAIN                             4  #define VIDOBJLAY_TYPE_MAIN                             4
65    /*#define VIDOBJLAY_TYPE_NBIT                           5 */
66    /*#define VIDOBJLAY_TYPE_ANIM_TEXT                      6 */
67  //#define VIDOBJLAY_AR_SQUARE                   1  /*#define VIDOBJLAY_TYPE_ANIM_MESH                      7 */
68  //#define VIDOBJLAY_AR_625TYPE_43               2  /*#define VIDOBJLAY_TYPE_SIMPLE_FACE            8 */
69  //#define VIDOBJLAY_AR_525TYPE_43               3  /*#define VIDOBJLAY_TYPE_STILL_SCALABLE         9 */
70  //#define VIDOBJLAY_AR_625TYPE_169              8  #define VIDOBJLAY_TYPE_ART_SIMPLE               10
71  //#define VIDOBJLAY_AR_525TYPE_169              9  /*#define VIDOBJLAY_TYPE_CORE_SCALABLE          11 */
72    #define VIDOBJLAY_TYPE_ACE                              12
73    /*#define VIDOBJLAY_TYPE_SIMPLE_FBA                     13 */
74    
75    
76    /*#define VIDOBJLAY_AR_SQUARE           1 */
77    /*#define VIDOBJLAY_AR_625TYPE_43       2 */
78    /*#define VIDOBJLAY_AR_525TYPE_43       3 */
79    /*#define VIDOBJLAY_AR_625TYPE_169      8 */
80    /*#define VIDOBJLAY_AR_525TYPE_169      9 */
81  #define VIDOBJLAY_AR_EXTPAR                             15  #define VIDOBJLAY_AR_EXTPAR                             15
82    
83    
# Line 95  Line 86 
86  #define VIDOBJLAY_SHAPE_BINARY_ONLY             2  #define VIDOBJLAY_SHAPE_BINARY_ONLY             2
87  #define VIDOBJLAY_SHAPE_GRAYSCALE               3  #define VIDOBJLAY_SHAPE_GRAYSCALE               3
88    
89  #define VO_START_CODE   0x8  
90  #define VOL_START_CODE  0x12  #define SPRITE_NONE             0
91  #define VOP_START_CODE  0x1b6  #define SPRITE_STATIC   1
92    #define SPRITE_GMC              2
93    
94    
95    
96  #define READ_MARKER()   BitstreamSkip(bs, 1)  #define READ_MARKER()   BitstreamSkip(bs, 1)
97  #define WRITE_MARKER()  BitstreamPutBit(bs, 1)  #define WRITE_MARKER()  BitstreamPutBit(bs, 1)
98    
99  // vop coding types  /* vop coding types  */
100  // intra, prediction, backward, sprite, not_coded  /* intra, prediction, backward, sprite, not_coded */
101  #define I_VOP   0  #define I_VOP   0
102  #define P_VOP   1  #define P_VOP   1
103  #define B_VOP   2  #define B_VOP   2
104  #define S_VOP   3  #define S_VOP   3
105  #define N_VOP   4  #define N_VOP   4
106    
107    /* resync-specific */
108  // header stuff  #define NUMBITS_VP_RESYNC_MARKER  17
109  int BitstreamReadHeaders(Bitstream * bs, DECODER * dec, uint32_t * rounding,  #define RESYNC_MARKER 1
110                                                   uint32_t * quant, uint32_t * fcode, uint32_t * intra_dc_threshold);  
111    
112    /*****************************************************************************
113     * Prototypes
114     ****************************************************************************/
115    
116    int read_video_packet_header(Bitstream *bs,
117                                                             DECODER * dec,
118                                                             const int addbits,
119                                                             int *quant,
120                                                             int *fcode_forward,
121                                                             int *fcode_backward,
122                                                             int *intra_dc_threshold);
123    
124    /* header stuff */
125    int BitstreamReadHeaders(Bitstream * bs,
126                                                     DECODER * dec,
127                                                     uint32_t * rounding,
128                                                     uint32_t * reduced_resolution,
129                                                     uint32_t * quant,
130                                                     uint32_t * fcode_forward,
131                                                     uint32_t * fcode_backward,
132                                                     uint32_t * intra_dc_threshold,
133                                                     WARPPOINTS * gmc_warp);
134    
135    
136  void BitstreamWriteVolHeader(Bitstream * const bs,  void BitstreamWriteVolHeader(Bitstream * const bs,
137                                                  const MBParam * pParam,                                                  const MBParam * pParam,
138                                                  const FRAMEINFO * frame);                                                           const FRAMEINFO * const frame);
139    
140  void BitstreamWriteVopHeader(Bitstream * const bs,  void BitstreamWriteVopHeader(Bitstream * const bs,
141                                                  const MBParam * pParam,                                                  const MBParam * pParam,
142                                                  const FRAMEINFO * frame);                                                           const FRAMEINFO * const frame,
143                                                             int vop_coded);
144    
145    void BitstreamWriteUserData(Bitstream * const bs,
146                                                            uint8_t * data,
147                                                            const int length);
148    
149  /* initialise bitstream structure */  /* initialise bitstream structure */
150    
151  static void __inline BitstreamInit(Bitstream * const bs,  static void __inline
152    BitstreamInit(Bitstream * const bs,
153                                                                     void * const bitstream,                                                                     void * const bitstream,
154                                                                     uint32_t length)                                                                     uint32_t length)
155  {  {
156          uint32_t tmp;          uint32_t tmp;
157            size_t bitpos;
158            ptr_t adjbitstream = (ptr_t)bitstream;
159    
160          bs->start = bs->tail = (uint32_t*)bitstream;          /*
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    
168          tmp = *(uint32_t *)bitstream;          tmp = *bs->start;
169  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
170          BSWAP(tmp);          BSWAP(tmp);
171  #endif  #endif
172          bs->bufa = tmp;          bs->bufa = tmp;
173    
174          tmp = *((uint32_t *)bitstream + 1);          tmp = *(bs->start + 1);
175  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
176          BSWAP(tmp);          BSWAP(tmp);
177  #endif  #endif
178          bs->bufb = tmp;          bs->bufb = tmp;
179    
180          bs->buf = 0;          bs->buf = 0;
181          bs->pos = 0;          bs->pos = bs->initpos = bitpos*8;
182          bs->length = length;          bs->length = length;
183  }  }
184    
185    
186  /* reset bitstream state */  /* reset bitstream state */
187    
188  static void __inline BitstreamReset(Bitstream * const bs)  static void __inline
189    BitstreamReset(Bitstream * const bs)
190  {  {
191          uint32_t tmp;          uint32_t tmp;
192    
# Line 173  Line 205 
205          bs->bufb = tmp;          bs->bufb = tmp;
206    
207          bs->buf = 0;          bs->buf = 0;
208      bs->pos = 0;          bs->pos = bs->initpos;
209  }  }
210    
211    
212  /* reads n bits from bitstream without changing the stream pos */  /* reads n bits from bitstream without changing the stream pos */
213    
214  static uint32_t __inline BitstreamShowBits(Bitstream * const bs,  static uint32_t __inline
215    BitstreamShowBits(Bitstream * const bs,
216                                                                                     const uint32_t bits)                                                                                     const uint32_t bits)
217  {  {
218          int nbit = (bits + bs->pos) - 32;          int nbit = (bits + bs->pos) - 32;
219          if (nbit > 0)  
220          {          if (nbit > 0) {
221                  return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) |                  return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs->
222                                  (bs->bufb >> (32 - nbit));                                                                                                                                   bufb >> (32 -
223          }                                                                                                                                                    nbit));
224          else          } else {
         {  
225                  return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);                  return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);
226          }          }
227  }  }
# Line 197  Line 229 
229    
230  /* skip n bits forward in bitstream */  /* skip n bits forward in bitstream */
231    
232  static __inline void BitstreamSkip(Bitstream * const bs, const uint32_t bits)  static __inline void
233    BitstreamSkip(Bitstream * const bs,
234                              const uint32_t bits)
235  {  {
236          bs->pos += bits;          bs->pos += bits;
237    
238          if (bs->pos >= 32)          if (bs->pos >= 32) {
         {  
239                  uint32_t tmp;                  uint32_t tmp;
240    
241                  bs->bufa = bs->bufb;                  bs->bufa = bs->bufb;
# Line 217  Line 250 
250  }  }
251    
252    
253    /* number of bits to next byte alignment */
254    static __inline uint32_t
255    BitstreamNumBitsToByteAlign(Bitstream *bs)
256    {
257            uint32_t n = (32 - bs->pos) % 8;
258            return n == 0 ? 8 : n;
259    }
260    
261    
262    /* show nbits from next byte alignment */
263    static __inline uint32_t
264    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    
282    
283  /* move forward to the next byte boundary */  /* move forward to the next byte boundary */
284    
285  static __inline void BitstreamByteAlign(Bitstream * const bs)  static __inline void
286    BitstreamByteAlign(Bitstream * const bs)
287  {  {
288          uint32_t remainder = bs->pos % 8;          uint32_t remainder = bs->pos % 8;
289          if (remainder)  
290          {          if (remainder) {
291                  BitstreamSkip(bs, 8 - remainder);                  BitstreamSkip(bs, 8 - remainder);
292          }          }
293  }  }
# Line 231  Line 295 
295    
296  /* bitstream length (unit bits) */  /* bitstream length (unit bits) */
297    
298  static uint32_t __inline BitstreamPos(const Bitstream * const bs)  static uint32_t __inline
299    BitstreamPos(const Bitstream * const bs)
300  {  {
301      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));
302  }  }
303    
304    
305  /*      flush the bitstream & return length (unit bytes)  /*
306          NOTE: assumes no futher bitstream functions will be called.   * flush the bitstream & return length (unit bytes)
307     * NOTE: assumes no futher bitstream functions will be called.
308   */   */
309    
310  static uint32_t __inline BitstreamLength(Bitstream * const bs)  static uint32_t __inline
311    BitstreamLength(Bitstream * const bs)
312  {  {
313          uint32_t len = (uint32_t) bs->tail - (uint32_t) bs->start;          uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start);
314    
315      if (bs->pos)          if (bs->pos) {
     {  
316                  uint32_t b = bs->buf;                  uint32_t b = bs->buf;
317    
318  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
319                  BSWAP(b);                  BSWAP(b);
320  #endif  #endif
# Line 256  Line 323 
323                  len += (bs->pos + 7) / 8;                  len += (bs->pos + 7) / 8;
324      }      }
325    
326            /* initpos is always on a byte boundary */
327            if (bs->initpos)
328                    len -= bs->initpos/8;
329    
330          return len;          return len;
331  }  }
332    
333    
334  /* 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 */
335    
336  static void __inline BitstreamForward(Bitstream * const bs, const uint32_t bits)  static void __inline
337    BitstreamForward(Bitstream * const bs,
338                                     const uint32_t bits)
339  {  {
340      bs->pos += bits;      bs->pos += bits;
341    
342      if (bs->pos >= 32)          if (bs->pos >= 32) {
     {  
343                  uint32_t b = bs->buf;                  uint32_t b = bs->buf;
344    
345  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
346                  BSWAP(b);                  BSWAP(b);
347  #endif  #endif
# Line 278  Line 351 
351      }      }
352  }  }
353    
   
 /* 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);  
     }  
 }  
   
   
354  /* read n bits from bitstream */  /* read n bits from bitstream */
355    
356  static uint32_t __inline BitstreamGetBits(Bitstream * const bs,  static uint32_t __inline
357    BitstreamGetBits(Bitstream * const bs,
358                                                                                    const uint32_t n)                                                                                    const uint32_t n)
359  {  {
360          uint32_t ret = BitstreamShowBits(bs, n);          uint32_t ret = BitstreamShowBits(bs, n);
361    
362          BitstreamSkip(bs, n);          BitstreamSkip(bs, n);
363          return ret;          return ret;
364  }  }
# Line 305  Line 366 
366    
367  /* read single bit from bitstream */  /* read single bit from bitstream */
368    
369  static uint32_t __inline BitstreamGetBit(Bitstream * const bs)  static uint32_t __inline
370    BitstreamGetBit(Bitstream * const bs)
371  {  {
372          return BitstreamGetBits(bs, 1);          return BitstreamGetBits(bs, 1);
373  }  }
# Line 313  Line 375 
375    
376  /* write single bit to bitstream */  /* write single bit to bitstream */
377    
378  static void __inline BitstreamPutBit(Bitstream * const bs,  static void __inline
379    BitstreamPutBit(Bitstream * const bs,
380                                                                          const uint32_t bit)                                                                          const uint32_t bit)
381  {  {
382      if (bit)      if (bit)
# Line 325  Line 388 
388    
389  /* write n bits to bitstream */  /* write n bits to bitstream */
390    
391  static void __inline BitstreamPutBits(Bitstream * const bs,  static void __inline
392    BitstreamPutBits(Bitstream * const bs,
393                                                                          const uint32_t value,                                                                          const uint32_t value,
394                                                                          const uint32_t size)                                                                          const uint32_t size)
395  {  {
# Line 349  Line 413 
413          }          }
414  }  }
415    
416    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    /*
441     * pad bitstream to the next byte boundary
442     * alway pad: even if currently at the byte boundary
443     */
444    
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  #endif /* _BITSTREAM_H_ */  #endif /* _BITSTREAM_H_ */

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.18

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