[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.21, Tue May 17 21:03:32 2005 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    void
152    BitstreamWriteEndOfSequence(Bitstream * const bs);
153    
154    void
155    BitstreamWriteGroupOfVopHeader(Bitstream * const bs,
156                                   const MBParam * pParam,
157                                   uint32_t is_closed_gov);
158    
159    void write_video_packet_header(Bitstream * const bs,
160                                   const MBParam * pParam,
161                                   const FRAMEINFO * const frame,
162                                   int mbnum);
163    
164  /* initialise bitstream structure */  /* initialise bitstream structure */
165    
166  static void __inline BitstreamInit(Bitstream * const bs,  static void __inline
167    BitstreamInit(Bitstream * const bs,
168                                                                     void * const bitstream,                                                                     void * const bitstream,
169                                                                     uint32_t length)                                                                     uint32_t length)
170  {  {
171          uint32_t tmp;          uint32_t tmp;
172            size_t bitpos;
173            ptr_t adjbitstream = (ptr_t)bitstream;
174    
175          bs->start = bs->tail = (uint32_t*)bitstream;          /*
176             * Start the stream on a uint32_t boundary, by rounding down to the
177             * previous uint32_t and skipping the intervening bytes.
178             */
179            bitpos = ((sizeof(uint32_t)-1) & (size_t)bitstream);
180            adjbitstream = adjbitstream - bitpos;
181            bs->start = bs->tail = (uint32_t *) adjbitstream;
182    
183          tmp = *(uint32_t *)bitstream;          tmp = *bs->start;
184  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
185          BSWAP(tmp);          BSWAP(tmp);
186  #endif  #endif
187          bs->bufa = tmp;          bs->bufa = tmp;
188    
189          tmp = *((uint32_t *)bitstream + 1);          tmp = *(bs->start + 1);
190  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
191          BSWAP(tmp);          BSWAP(tmp);
192  #endif  #endif
193          bs->bufb = tmp;          bs->bufb = tmp;
194    
195          bs->buf = 0;          bs->buf = 0;
196          bs->pos = 0;          bs->pos = bs->initpos = bitpos*8;
197          bs->length = length;          bs->length = length;
198  }  }
199    
200    
201  /* reset bitstream state */  /* reset bitstream state */
202    
203  static void __inline BitstreamReset(Bitstream * const bs)  static void __inline
204    BitstreamReset(Bitstream * const bs)
205  {  {
206          uint32_t tmp;          uint32_t tmp;
207    
# Line 186  Line 220 
220          bs->bufb = tmp;          bs->bufb = tmp;
221    
222          bs->buf = 0;          bs->buf = 0;
223      bs->pos = 0;          bs->pos = bs->initpos;
224  }  }
225    
226    
227  /* reads n bits from bitstream without changing the stream pos */  /* reads n bits from bitstream without changing the stream pos */
228    
229  static uint32_t __inline BitstreamShowBits(Bitstream * const bs,  static uint32_t __inline
230    BitstreamShowBits(Bitstream * const bs,
231                                                                                     const uint32_t bits)                                                                                     const uint32_t bits)
232  {  {
233          int nbit = (bits + bs->pos) - 32;          int nbit = (bits + bs->pos) - 32;
234          if (nbit > 0)  
235          {          if (nbit > 0) {
236                  return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) |                  return ((bs->bufa & (0xffffffff >> bs->pos)) << nbit) | (bs->
237                                  (bs->bufb >> (32 - nbit));                                                                                                                                   bufb >> (32 -
238          }                                                                                                                                                    nbit));
239          else          } else {
         {  
240                  return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);                  return (bs->bufa & (0xffffffff >> bs->pos)) >> (32 - bs->pos - bits);
241          }          }
242  }  }
# Line 210  Line 244 
244    
245  /* skip n bits forward in bitstream */  /* skip n bits forward in bitstream */
246    
247  static __inline void BitstreamSkip(Bitstream * const bs, const uint32_t bits)  static __inline void
248    BitstreamSkip(Bitstream * const bs,
249                              const uint32_t bits)
250  {  {
251          bs->pos += bits;          bs->pos += bits;
252    
253          if (bs->pos >= 32)          if (bs->pos >= 32) {
         {  
254                  uint32_t tmp;                  uint32_t tmp;
255    
256                  bs->bufa = bs->bufb;                  bs->bufa = bs->bufb;
# Line 230  Line 265 
265  }  }
266    
267    
268    /* number of bits to next byte alignment */
269    static __inline uint32_t
270    BitstreamNumBitsToByteAlign(Bitstream *bs)
271    {
272            uint32_t n = (32 - bs->pos) % 8;
273            return n == 0 ? 8 : n;
274    }
275    
276    
277    /* show nbits from next byte alignment */
278    static __inline uint32_t
279    BitstreamShowBitsFromByteAlign(Bitstream *bs, int bits)
280    {
281            int bspos = bs->pos + BitstreamNumBitsToByteAlign(bs);
282            int nbit = (bits + bspos) - 32;
283    
284            if (bspos >= 32) {
285                    return bs->bufb >> (32 - nbit);
286            } else  if (nbit > 0) {
287                    return ((bs->bufa & (0xffffffff >> bspos)) << nbit) | (bs->
288                                                                                                                                     bufb >> (32 -
289                                                                                                                                                      nbit));
290            } else {
291                    return (bs->bufa & (0xffffffff >> bspos)) >> (32 - bspos - bits);
292            }
293    
294    }
295    
296    
297    
298  /* move forward to the next byte boundary */  /* move forward to the next byte boundary */
299    
300  static __inline void BitstreamByteAlign(Bitstream * const bs)  static __inline void
301    BitstreamByteAlign(Bitstream * const bs)
302  {  {
303          uint32_t remainder = bs->pos % 8;          uint32_t remainder = bs->pos % 8;
304          if (remainder)  
305          {          if (remainder) {
306                  BitstreamSkip(bs, 8 - remainder);                  BitstreamSkip(bs, 8 - remainder);
307          }          }
308  }  }
# Line 244  Line 310 
310    
311  /* bitstream length (unit bits) */  /* bitstream length (unit bits) */
312    
313  static uint32_t __inline BitstreamPos(const Bitstream * const bs)  static uint32_t __inline
314    BitstreamPos(const Bitstream * const bs)
315  {  {
316      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));
317  }  }
318    
319    
320  /*      flush the bitstream & return length (unit bytes)  /*
321          NOTE: assumes no futher bitstream functions will be called.   * flush the bitstream & return length (unit bytes)
322     * NOTE: assumes no futher bitstream functions will be called.
323   */   */
324    
325  static uint32_t __inline BitstreamLength(Bitstream * const bs)  static uint32_t __inline
326    BitstreamLength(Bitstream * const bs)
327  {  {
328          uint32_t len = (uint32_t) bs->tail - (uint32_t) bs->start;          uint32_t len = (uint32_t)((ptr_t)bs->tail - (ptr_t)bs->start);
329    
330      if (bs->pos)          if (bs->pos) {
     {  
331                  uint32_t b = bs->buf;                  uint32_t b = bs->buf;
332    
333  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
334                  BSWAP(b);                  BSWAP(b);
335  #endif  #endif
# Line 269  Line 338 
338                  len += (bs->pos + 7) / 8;                  len += (bs->pos + 7) / 8;
339      }      }
340    
341            /* initpos is always on a byte boundary */
342            if (bs->initpos)
343                    len -= bs->initpos/8;
344    
345          return len;          return len;
346  }  }
347    
348    
349  /* 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 */
350    
351  static void __inline BitstreamForward(Bitstream * const bs, const uint32_t bits)  static void __inline
352    BitstreamForward(Bitstream * const bs,
353                                     const uint32_t bits)
354  {  {
355      bs->pos += bits;      bs->pos += bits;
356    
357      if (bs->pos >= 32)          if (bs->pos >= 32) {
     {  
358                  uint32_t b = bs->buf;                  uint32_t b = bs->buf;
359    
360  #ifndef ARCH_IS_BIG_ENDIAN  #ifndef ARCH_IS_BIG_ENDIAN
361                  BSWAP(b);                  BSWAP(b);
362  #endif  #endif
# Line 291  Line 366 
366      }      }
367  }  }
368    
   
 /* 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);  
     }  
 }  
   
   
369  /* read n bits from bitstream */  /* read n bits from bitstream */
370    
371  static uint32_t __inline BitstreamGetBits(Bitstream * const bs,  static uint32_t __inline
372    BitstreamGetBits(Bitstream * const bs,
373                                                                                    const uint32_t n)                                                                                    const uint32_t n)
374  {  {
375          uint32_t ret = BitstreamShowBits(bs, n);          uint32_t ret = BitstreamShowBits(bs, n);
376    
377          BitstreamSkip(bs, n);          BitstreamSkip(bs, n);
378          return ret;          return ret;
379  }  }
# Line 318  Line 381 
381    
382  /* read single bit from bitstream */  /* read single bit from bitstream */
383    
384  static uint32_t __inline BitstreamGetBit(Bitstream * const bs)  static uint32_t __inline
385    BitstreamGetBit(Bitstream * const bs)
386  {  {
387          return BitstreamGetBits(bs, 1);          return BitstreamGetBits(bs, 1);
388  }  }
# Line 326  Line 390 
390    
391  /* write single bit to bitstream */  /* write single bit to bitstream */
392    
393  static void __inline BitstreamPutBit(Bitstream * const bs,  static void __inline
394    BitstreamPutBit(Bitstream * const bs,
395                                                                          const uint32_t bit)                                                                          const uint32_t bit)
396  {  {
397      if (bit)      if (bit)
# Line 338  Line 403 
403    
404  /* write n bits to bitstream */  /* write n bits to bitstream */
405    
406  static void __inline BitstreamPutBits(Bitstream * const bs,  static void __inline
407    BitstreamPutBits(Bitstream * const bs,
408                                                                          const uint32_t value,                                                                          const uint32_t value,
409                                                                          const uint32_t size)                                                                          const uint32_t size)
410  {  {
# Line 362  Line 428 
428          }          }
429  }  }
430    
431    static const int stuffing_codes[8] =
432    {
433                    /* nbits     stuffing code */
434            0,              /* 1          0 */
435            1,              /* 2          01 */
436            3,              /* 3          011 */
437            7,              /* 4          0111 */
438            0xf,    /* 5          01111 */
439            0x1f,   /* 6          011111 */
440            0x3f,   /* 7          0111111 */
441            0x7f,   /* 8          01111111 */
442    };
443    
444    /* pad bitstream to the next byte boundary */
445    
446    static void __inline
447    BitstreamPad(Bitstream * const bs)
448    {
449            int bits = 8 - (bs->pos % 8);
450            if (bits < 8)
451                    BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
452    }
453    
454    
455    /*
456     * pad bitstream to the next byte boundary
457     * alway pad: even if currently at the byte boundary
458     */
459    
460    static void __inline
461    BitstreamPadAlways(Bitstream * const bs)
462    {
463            int bits = 8 - (bs->pos % 8);
464            BitstreamPutBits(bs, stuffing_codes[bits - 1], bits);
465    }
466    
467  #endif /* _BITSTREAM_H_ */  #endif /* _BITSTREAM_H_ */

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

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