bitstream.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:5k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. /* bitstream reader functions. No checking for end-of-bits included! */
  36. #ifndef _BITSTREAM_H_
  37. #define _BITSTREAM_H_
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. /** The bitstream structure.
  42.  *  The idea of the bitstream reader is to keep a cache word that has the machine's
  43.  *  largest native size. This word keeps the next-to-read bits left-aligned so that
  44.  *  on a read, one shift suffices.
  45.  *  The cache word is only refilled if it does not contain enough bits to satisy a
  46.  *  a read request. Because the refill only happens in multiple of 8 bits, the maximum
  47.  *  read size that is guaranteed to be always fulfilled is the number of bits in a long
  48.  *  minus 8 (or the number of bits in a byte).
  49.  */
  50. struct BITSTREAM ;
  51. /** read nBits bits from bitstream
  52.   * @param pBitstream the bitstream to read from
  53.   * @param nBits the number of bits to read. nBits must be <= 32, currently.
  54.   * @return the bits read, right-justified
  55.   */
  56. unsigned int readBits(struct BITSTREAM *pBitstream, int nBits) ;
  57. /** push bits back into the bitstream.
  58.   * This call is here to make look-ahead possible, where after reading the client
  59.   * may realize it has read too far ahead. It is guaranteed to succeed as long as
  60.   * you don't push more bits back than have been read in the last readBits() call.
  61.   * @param pBitstream the bitstream to push back into
  62.   * @param bits the bits to push back
  63.   * @param nBits the number of bits to push back.
  64.   * @return an error code, signalling success or failure.
  65.   */
  66. int unreadBits(struct BITSTREAM *pBitstream, int bits, int nBits) ;
  67. /** byte-align the bitstream read pointer. */
  68. void byteAlign(struct BITSTREAM *pBitstream) ;
  69. /** allocate memory for a new bitstream structure.
  70.   * @param ppBitstream a pointer to a bitstream handle, to be initialized on
  71.   *        successfull return
  72.   * @param nBits the maximum number of bits this bitstream must be able to hold.
  73.   *        nBits must be divisible by 32.
  74.   * @return an error code, signalling success or failure.
  75.   * @see reverseBitstream
  76.   */
  77. int newBitstream(struct BITSTREAM **ppBitstream, int nBits) ;
  78. /** free memory associated with a bitstream structure.
  79.   * @param pBitstream a bitstream handle
  80.   */
  81. void deleteBitstream(struct BITSTREAM *pBitstream) ;
  82. /** feed nbits bits to the bitstream, byte-wise.
  83.   * @param pBitstream the bitstream into which to feed the bytes
  84.   * @param input the input from which to read the bytes
  85.   * @param nbits the number of bits in the input. nbits must be divisible by 32
  86.   *  for reverseBitstream() to work.
  87.   * @return an error code, signalling success or failure.
  88.   * @see reverseBitstream
  89.   */
  90. int feedBitstream(struct BITSTREAM *pBitstream, const unsigned char *input, int nbits) ;
  91. /** set bitstream position, relative to origin defined through feedBitstream().
  92.   * @param pBitstream the bitstream
  93.   * @param position the position in bits (must be multiple of 8, currently).
  94.   * Always measured from beginning, regardless of direction.
  95.   * @param direction the direction of reading (+1/-1)
  96.   */
  97. int setAtBitstream(struct BITSTREAM *pBitstream, int position, int direction) ;
  98. /** return the number of bits left until end-of-stream.
  99.   * @param pBitstream the bitstream
  100.   * @return the number of bits left
  101.   */
  102. int bitsLeftInBitstream(struct BITSTREAM *pBitstream) ;
  103. #ifdef __cplusplus
  104. }
  105. #endif
  106. #endif /* _BITSTREAM_H_ */