12228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
22228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/* -----------------------------------------------------------------------------------------------------------
32228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectSoftware License for The Fraunhofer FDK AAC Codec Library for Android
42228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
54f0d97057c5c640b25518358886f8c47da9fc052Jean-Michel Trivi� Copyright  1995 - 2013 Fraunhofer-Gesellschaft zur F�rderung der angewandten Forschung e.V.
62228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  All rights reserved.
72228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
82228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project 1.    INTRODUCTION
92228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectThe Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
102228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectthe MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
112228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectThis FDK AAC Codec software is intended to be used on a wide variety of Android devices.
122228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
132228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectAAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
142228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectaudio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
152228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectindependent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
162228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectof the MPEG specifications.
172228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
182228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectPatent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
192228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectmay be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
202228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectindividually for the purpose of encoding or decoding bit streams in products that are compliant with
212228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectthe ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
222228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectthese patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
232228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectsoftware may already be covered under those patent licenses when it is used for those licensed purposes only.
242228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
252228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectCommercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
262228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectare also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
272228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectapplications information and documentation.
282228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
292228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project2.    COPYRIGHT LICENSE
302228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
312228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectRedistribution and use in source and binary forms, with or without modification, are permitted without
322228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectpayment of copyright license fees provided that you satisfy the following conditions:
332228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
342228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectYou must retain the complete text of this software license in redistributions of the FDK AAC Codec or
352228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectyour modifications thereto in source code form.
362228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
372228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectYou must retain the complete text of this software license in the documentation and/or other materials
382228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectprovided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
392228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectYou must make available free of charge copies of the complete source code of the FDK AAC Codec and your
402228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectmodifications thereto to recipients of copies in binary form.
412228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
422228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectThe name of Fraunhofer may not be used to endorse or promote products derived from this library without
432228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectprior written permission.
442228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
452228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectYou may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
462228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectsoftware or your modifications thereto.
472228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
482228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectYour modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
492228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectand the date of any change. For modified versions of the FDK AAC Codec, the term
502228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project"Fraunhofer FDK AAC Codec Library for Android" must be replaced by the term
512228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project"Third-Party Modified Version of the Fraunhofer FDK AAC Codec Library for Android."
522228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
532228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project3.    NO PATENT LICENSE
542228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
552228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectNO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
562228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
572228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectrespect to this software.
582228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
592228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectYou may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
602228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectby appropriate patent licenses.
612228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
622228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project4.    DISCLAIMER
632228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
642228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectThis FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright holders and contributors
652228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project"AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, including but not limited to the implied warranties
662228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectof merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
672228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectCONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
682228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectincluding but not limited to procurement of substitute goods or services; loss of use, data, or profits,
692228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projector business interruption, however caused and on any theory of liability, whether in contract, strict
702228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectliability, or tort (including negligence), arising in any way out of the use of this software, even if
712228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectadvised of the possibility of such damage.
722228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
732228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project5.    CONTACT INFORMATION
742228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
752228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFraunhofer Institute for Integrated Circuits IIS
762228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectAttention: Audio and Multimedia Departments - FDK AAC LL
772228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectAm Wolfsmantel 33
782228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project91058 Erlangen, Germany
792228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
802228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectwww.iis.fraunhofer.de/amm
812228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectamm-info@iis.fraunhofer.de
822228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project----------------------------------------------------------------------------------------------------------- */
832228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
842228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/***************************  Fraunhofer IIS FDK Tools  ***********************
852228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
862228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project   Author(s):   M. Lohwasser
872228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project   Description: bitstream interface to bitbuffer routines
882228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
892228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project******************************************************************************/
902228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
912228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#ifndef __FDK_BITSTREAM_H__
922228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#define __FDK_BITSTREAM_H__
932228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
942228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
952228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
962228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#include "FDK_bitbuffer.h"
972228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#include "machine_type.h"
982228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
992228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#include "genericStds.h"
1002228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1012228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#define CACHE_BITS 32
1022228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1032228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projecttypedef enum {
1042228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    BS_READER,
1052228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    BS_WRITER
1062228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project} FDK_BS_CFG;
1072228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1082228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1092228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projecttypedef struct
1102228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
1112228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  UINT       CacheWord ;
1122228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  UINT       BitsInCache ;
1132228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_BITBUF hBitBuf;
1142228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  UINT       ConfigCache ;
1152228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project} FDK_BITSTREAM;
1162228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1172228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projecttypedef FDK_BITSTREAM* HANDLE_FDK_BITSTREAM;
1182228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1192228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
1202228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief CreateBitStream Function.
1212228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
1222228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * Create and initialize bitstream with extern allocated buffer.
1232228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
1242228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param pBuffer  Pointer to BitBuffer array.
1252228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param bufSize  Length of BitBuffer array. (awaits size 2^n)
1262228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param config   Initialize BitStream as Reader or Writer.
1272228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
1282228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE
1292228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectHANDLE_FDK_BITSTREAM FDKcreateBitStream (UCHAR *pBuffer,
1302228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                                      UINT bufSize,
1312228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                                      FDK_BS_CFG config = BS_READER)
1322228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
1332228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  HANDLE_FDK_BITSTREAM hBitStream = (HANDLE_FDK_BITSTREAM) FDKcalloc(1, sizeof(FDK_BITSTREAM));
1342228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_InitBitBuffer(&hBitStream->hBitBuf, pBuffer, bufSize, 0) ;
1352228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1362228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  /* init cache */
1372228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->CacheWord = hBitStream->BitsInCache = 0 ;
1382228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->ConfigCache = config ;
1392228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1402228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  return hBitStream ;
1412228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
1422228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1432228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1442228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
1452228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief Initialize BistreamBuffer. BitBuffer can point to filled BitBuffer array .
1462228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
1472228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
1482228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param pBuffer    Pointer to BitBuffer array.
1492228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param bufSize    Length of BitBuffer array. (awaits size 2^n)
1502228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param validBits  Number of valid BitBuffer filled Bits.
1512228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param config     Initialize BitStream as Reader or Writer.
1522228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
1532228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
1542228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE
1552228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectvoid FDKinitBitStream (HANDLE_FDK_BITSTREAM hBitStream,
1562228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                       UCHAR *pBuffer,
1572228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                       UINT bufSize,
1582228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                       UINT validBits,
1592228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                       FDK_BS_CFG config = BS_READER)
1602228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
1612228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_InitBitBuffer(&hBitStream->hBitBuf, pBuffer, bufSize, validBits) ;
1622228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1632228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  /* init cache */
1642228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->CacheWord = hBitStream->BitsInCache = 0 ;
1652228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->ConfigCache = config ;
1662228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
1672228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1682228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1692228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
1702228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief ResetBitbuffer Function. Reset states in BitBuffer and Cache.
1712228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
1722228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
1732228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param config     Initialize BitStream as Reader or Writer.
1742228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
1752228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
1762228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKresetBitbuffer( HANDLE_FDK_BITSTREAM hBitStream, FDK_BS_CFG config = BS_READER)
1772228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
1782228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_ResetBitBuffer( &hBitStream->hBitBuf ) ;
1792228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1802228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  /* init cache */
1812228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->CacheWord = hBitStream->BitsInCache = 0 ;
1822228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->ConfigCache = config ;
1832228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
1842228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1852228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1862228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/** DeleteBitStream.
1872228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1882228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    Deletes the in Create Bitstream allocated BitStream and BitBuffer.
1892228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project*/
1902228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKdeleteBitStream (HANDLE_FDK_BITSTREAM hBitStream)
1912228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
1922228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_DeleteBitBuffer(&hBitStream->hBitBuf) ;
1932228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDKfree(hBitStream) ;
1942228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
1952228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1962228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
1972228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
1982228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief ReadBits Function (forward). This function returns a number of sequential
1992228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        bits from the input bitstream.
2002228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
2012228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
2022228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param numberOfBits  The number of bits to be retrieved.
2032228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return the requested bits, right aligned
2042228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return
2052228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
2062228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#define OPTIMIZE_FDKREADBITS
2072228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2082228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE UINT FDKreadBits(HANDLE_FDK_BITSTREAM hBitStream,
2092228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                        const UINT numberOfBits)
2102228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
2112228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#ifdef noOPTIMIZE_FDKREADBITS
2122228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  INT missingBits = numberOfBits - hBitStream->BitsInCache;
2132228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if (missingBits > 0)
2142228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  {
2152228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    UINT bits = hBitStream->CacheWord << missingBits;
2162228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->CacheWord = FDK_get32 (&hBitStream->hBitBuf) ;
2172228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache = CACHE_BITS - missingBits;
2182228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    return ( bits | (hBitStream->CacheWord >> hBitStream->BitsInCache)) & BitMask[numberOfBits];
2192228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
2202228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2212228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->BitsInCache -= numberOfBits;
2222228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  return ( hBitStream->CacheWord >> hBitStream->BitsInCache) & BitMask[numberOfBits];
2232228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2242228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#else
2252228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  const UINT validMask = BitMask [numberOfBits] ;
2262228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2272228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if (hBitStream->BitsInCache <= numberOfBits)
2282228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  {
2292228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    const INT freeBits = (CACHE_BITS-1) - hBitStream->BitsInCache ;
2302228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2312228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->CacheWord = (hBitStream->CacheWord << freeBits) | FDK_get (&hBitStream->hBitBuf,freeBits) ;
2322228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache += freeBits ;
2332228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
2342228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2352228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->BitsInCache -= numberOfBits ;
2362228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2372228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  return (hBitStream->CacheWord >> hBitStream->BitsInCache) & validMask ;
2382228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#endif
2392228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
2402228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2412228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE UINT FDKreadBit(HANDLE_FDK_BITSTREAM hBitStream)
2422228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
2432228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#ifdef OPTIMIZE_FDKREADBITS
2442228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if (!hBitStream->BitsInCache)
2452228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  {
2462228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->CacheWord = FDK_get32 (&hBitStream->hBitBuf);
2472228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache = CACHE_BITS;
2482228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
2492228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->BitsInCache--;
2502228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2512228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  return (hBitStream->CacheWord >> hBitStream->BitsInCache) & 1;
2522228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#else
2532228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project return FDKreadBits(hBitStream,1);
2542228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#endif
2552228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
2562228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2572228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
2582228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief Read2Bits Function (forward). This function 2 sequential
2592228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        bits from the input bitstream. It is the optimized version
2602228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project          of FDKreadBits() for readign 2 bits.
2612228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
2622228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
2632228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return the requested bits, right aligned
2642228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return
2652228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
2662228e360595641dd906bf1773307f43d304f5b2The Android Open Source Projectinline UINT FDKread2Bits(HANDLE_FDK_BITSTREAM hBitStream)
2672228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
2682228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  UINT BitsInCache = hBitStream->BitsInCache;
2692228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if (BitsInCache < 2)  /* Comparison changed from 'less-equal' to 'less' */
2702228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  {
2712228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    const INT freeBits = (CACHE_BITS-1) - BitsInCache ;
2722228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2732228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->CacheWord = (hBitStream->CacheWord << freeBits) | FDK_get (&hBitStream->hBitBuf,freeBits) ;
2742228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    BitsInCache += freeBits;
2752228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
2762228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->BitsInCache = BitsInCache - 2;
2772228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  return (hBitStream->CacheWord >> hBitStream->BitsInCache) & 0x3;
2782228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
2792228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2802228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
2812228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief ReadBits Function (backward). This function returns a number of sequential bits
2822228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        from the input bitstream.
2832228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
2842228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
2852228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param numberOfBits  The number of bits to be retrieved.
2862228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return the requested bits, right aligned
2872228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
2882228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE UINT FDKreadBitsBwd(HANDLE_FDK_BITSTREAM hBitStream,
2892228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                           const UINT numberOfBits)
2902228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
2912228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  const UINT validMask = BitMask [numberOfBits] ;
2922228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2932228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if (hBitStream->BitsInCache <= numberOfBits)
2942228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  {
2952228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    const INT freeBits = (CACHE_BITS-1) - hBitStream->BitsInCache ;
2962228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
2972228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->CacheWord = (hBitStream->CacheWord << freeBits) | FDK_getBwd (&hBitStream->hBitBuf,freeBits) ;
2982228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache += freeBits ;
2992228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
3002228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3012228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->BitsInCache -= numberOfBits ;
3022228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3032228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  return (hBitStream->CacheWord >> hBitStream->BitsInCache) & validMask ;
3042228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
3052228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3062228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3072228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
3082228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief return a number of bits from the bitBuffer.
3092228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        You have to know what you do! Cache has to be synchronized before using this
3102228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        function.
3112228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
3122228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
3132228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param numBits The number of bits to be retrieved.
3142228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return the requested bits, right aligned
3152228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
3162228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE UINT FDKgetBits (HANDLE_FDK_BITSTREAM hBitStream, UINT numBits)
3172228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
3182228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    return FDK_get (&hBitStream->hBitBuf, numBits) ;
3192228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
3202228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3212228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3222228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
3232228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief WriteBits Function. This function writes numberOfBits of value into bitstream.
3242228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
3252228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
3262228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param value         Variable holds data to be written.
3272228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param numberOfBits  The number of bits to be written.
3282228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return number of bits written
3292228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
3302228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE UCHAR FDKwriteBits(HANDLE_FDK_BITSTREAM hBitStream, UINT value,
3312228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                     const UINT numberOfBits)
3322228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
3332228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  const UINT validMask = BitMask [numberOfBits] ;
3342228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3352228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if ((hBitStream->BitsInCache+numberOfBits) < CACHE_BITS)
3362228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  {
3372228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache += numberOfBits ;
3382228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->CacheWord   =  (hBitStream->CacheWord << numberOfBits) | (value & validMask);
3392228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
3402228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  else
3412228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  {
3422228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_put(&hBitStream->hBitBuf, hBitStream->CacheWord, hBitStream->BitsInCache) ;
3432228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache = numberOfBits ;
3442228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->CacheWord   = (value & validMask) ;
3452228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
3462228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3472228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project return numberOfBits;
3482228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
3492228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3502228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3512228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
3522228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief WriteBits Function (backward). This function writes numberOfBits of value into bitstream.
3532228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
3542228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
3552228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param value         Variable holds data to be written.
3562228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param numberOfBits  The number of bits to be written.
3572228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return number of bits written
3582228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
3592228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE UCHAR FDKwriteBitsBwd(HANDLE_FDK_BITSTREAM hBitStream, UINT value,
3602228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                                 const UINT numberOfBits)
3612228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
3622228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  const UINT validMask = BitMask [numberOfBits] ;
3632228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3642228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if ((hBitStream->BitsInCache+numberOfBits) <= CACHE_BITS)
3652228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  {
3662228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache += numberOfBits ;
3672228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->CacheWord   =  (hBitStream->CacheWord << numberOfBits) | (value & validMask);
3682228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
3692228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  else
3702228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  {
3712228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_putBwd(&hBitStream->hBitBuf, hBitStream->CacheWord, hBitStream->BitsInCache) ;
3722228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache = numberOfBits ;
3732228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->CacheWord   = (value & validMask) ;
3742228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
3752228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3762228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project return numberOfBits;
3772228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
3782228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3792228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3802228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
3812228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief SyncCache Function. Clear cache after read forward.
3822228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
3832228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
3842228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
3852228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
3862228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKsyncCache (HANDLE_FDK_BITSTREAM hBitStream)
3872228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
3882228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if (hBitStream->ConfigCache == BS_READER)
3892228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_pushBack (&hBitStream->hBitBuf,hBitStream->BitsInCache,hBitStream->ConfigCache) ;
3902228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  else                        /* BS_WRITER */
3912228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_put(&hBitStream->hBitBuf, hBitStream->CacheWord, hBitStream->BitsInCache) ;
3922228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3932228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->BitsInCache = 0 ;
3942228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->CacheWord   = 0 ;
3952228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
3962228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3972228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
3982228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
3992228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief SyncCache Function. Clear cache after read backwards.
4002228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
4012228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param  hBitStream HANDLE_FDK_BITSTREAM handle
4022228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
4032228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
4042228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKsyncCacheBwd (HANDLE_FDK_BITSTREAM hBitStream)
4052228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
4062228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if (hBitStream->ConfigCache == BS_READER) {
4072228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_pushForward (&hBitStream->hBitBuf,hBitStream->BitsInCache,hBitStream->ConfigCache) ;
4082228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  } else {                      /* BS_WRITER */
4092228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_putBwd (&hBitStream->hBitBuf, hBitStream->CacheWord, hBitStream->BitsInCache) ;
4102228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
4112228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
4122228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->BitsInCache = 0 ;
4132228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->CacheWord   = 0 ;
4142228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
4152228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
4162228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
4172228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
4182228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief Byte Alignment Function.
4192228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        This function performs the byte_alignment() syntactic function on the input stream,
4202228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        i.e. some bits will be discarded/padded so that the next bits to be read/written will
4212228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        be aligned on a byte boundary with respect to the bit position 0.
4222228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
4232228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param  hBitStream HANDLE_FDK_BITSTREAM handle
4242228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
4252228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
4262228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKbyteAlign (HANDLE_FDK_BITSTREAM hBitStream)
4272228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
4282228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDKsyncCache (hBitStream) ;
4292228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_byteAlign (&hBitStream->hBitBuf, (UCHAR)hBitStream->ConfigCache) ;
4302228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
4312228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
4322228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
4332228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
4342228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief Byte Alignment Function with anchor
4352228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        This function performs the byte_alignment() syntactic function on the input stream,
4362228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        i.e. some bits will be discarded so that the next bits to be read/written would be aligned
4372228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        on a byte boundary with respect to the given alignment anchor.
4382228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
4392228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
4402228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param alignmentAnchor bit position to be considered as origin for byte alignment
4412228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
4422228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
4432228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKbyteAlign (HANDLE_FDK_BITSTREAM hBitStream, UINT alignmentAnchor)
4442228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
4452228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDKsyncCache (hBitStream) ;
4462228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if (hBitStream->ConfigCache == BS_READER) {
4472228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_pushForward (&hBitStream->hBitBuf,
4482228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                     (8 - ((alignmentAnchor - FDK_getValidBits(&hBitStream->hBitBuf)) & 0x07)) & 0x07,
4492228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project                     hBitStream->ConfigCache) ;
4502228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
4512228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  else {
4522228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_put (&hBitStream->hBitBuf,
4532228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project             0,
4542228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project             (8 - ((FDK_getValidBits(&hBitStream->hBitBuf)-alignmentAnchor) & 0x07)) & 0x07 );
4552228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
4562228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
4572228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
4582228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
4592228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
4602228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief Push Back(Cache) / For / BiDirectional Function.
4612228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        PushBackCache function ungets a number of bits erroneously read/written by the last Get() call.
4622228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *       NB: The number of bits to be stuffed back into the stream may never exceed the
4632228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *       number of bits returned by the immediately preceding Get() call.
4642228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
4652228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *       PushBack function ungets a number of bits (combines cache and bitbuffer indices)
4662228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *       PushFor  function gets a number of bits (combines cache and bitbuffer indices)
4672228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *       PushBiDirectional gets/ungets number of bits as defined in PusBack/For function
4682228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *       NB: The sign of bits is not known, so the function checks direction and calls
4692228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        appropriate function. (positive sign pushFor, negative sign pushBack )
4702228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
4712228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
4722228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param numberOfBits  The number of bits to be pushed back/for.
4732228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
4742228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
4752228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKpushBackCache (HANDLE_FDK_BITSTREAM hBitStream, const UINT numberOfBits)
4762228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
4772228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_ASSERT ((hBitStream->BitsInCache+numberOfBits)<=CACHE_BITS);
4782228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  hBitStream->BitsInCache += numberOfBits ;
4792228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
4802228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
4812228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKpushBack (HANDLE_FDK_BITSTREAM hBitStream, const UINT numberOfBits)
4822228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
4832228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if ((hBitStream->BitsInCache+numberOfBits)<CACHE_BITS && (hBitStream->ConfigCache == BS_READER) ) {
4842228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache += numberOfBits ;
4852228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDKsyncCache(hBitStream) ; /* sync cache to avoid invalid cache */
4862228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
4872228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  else {
4882228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDKsyncCache(hBitStream) ;
4892228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_pushBack(&hBitStream->hBitBuf,numberOfBits,hBitStream->ConfigCache);
4902228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
4912228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
4922228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
4932228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKpushFor (HANDLE_FDK_BITSTREAM hBitStream, const UINT numberOfBits)
4942228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
4952228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if ( (hBitStream->BitsInCache>numberOfBits) && (hBitStream->ConfigCache == BS_READER) ) {
4962228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    hBitStream->BitsInCache -= numberOfBits;
4972228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
4982228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  else {
4992228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDKsyncCache(hBitStream) ;
5002228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_pushForward(&hBitStream->hBitBuf,numberOfBits,hBitStream->ConfigCache);
5012228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  }
5022228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
5032228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5042228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKpushBiDirectional (HANDLE_FDK_BITSTREAM hBitStream, const INT numberOfBits)
5052228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
5062228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  if(numberOfBits>=0)  FDKpushFor(hBitStream, numberOfBits) ;
5072228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  else                 FDKpushBack(hBitStream, -numberOfBits) ;
5082228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
5092228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5102228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5112228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
5122228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief GetValidBits Function.  Clear cache and return valid Bits from Bitbuffer.
5132228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
5142228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return amount of valid bits that still can be read or were already written.
5152228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
5162228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
5172228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE UINT FDKgetValidBits (HANDLE_FDK_BITSTREAM hBitStream)
5182228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
5192228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDKsyncCache(hBitStream) ;
5202228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  return FDK_getValidBits(&hBitStream->hBitBuf) ;
5212228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
5222228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5232228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5242228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
5252228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief return amount of unused Bits from Bitbuffer.
5262228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
5272228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return amount of free bits that still can be written into the bitstream
5282228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
5292228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE INT FDKgetFreeBits (HANDLE_FDK_BITSTREAM hBitStream)
5302228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
5312228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project   return FDK_getFreeBits (&hBitStream->hBitBuf) ;
5322228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
5332228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5342228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
5352228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief reset bitcounter in bitBuffer to zero.
5362228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
5372228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
5382228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
5392228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKresetBitCnt (HANDLE_FDK_BITSTREAM hBitStream)
5402228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
5412228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDKsyncCache (hBitStream) ;
5422228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_setBitCnt (&hBitStream->hBitBuf, 0) ;
5432228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
5442228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5452228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
5462228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief set bitcoutner in bitBuffer to given value.
5472228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
5482228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param value new value to be assigned to the bit counter
5492228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
5502228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
5512228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKsetBitCnt (HANDLE_FDK_BITSTREAM hBitStream, UINT value)
5522228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
5532228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDKsyncCache (hBitStream) ;
5542228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDK_setBitCnt (&hBitStream->hBitBuf, value) ;
5552228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
5562228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5572228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
5582228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief get bitcounter state from bitBuffer.
5592228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream HANDLE_FDK_BITSTREAM handle
5602228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return current bit counter value
5612228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
5622228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE INT  FDKgetBitCnt (HANDLE_FDK_BITSTREAM hBitStream)
5632228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
5642228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    FDKsyncCache(hBitStream) ;
5652228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project    return FDK_getBitCnt(&hBitStream->hBitBuf) ;
5662228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
5672228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5682228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5692228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
5702228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief Fill the BitBuffer with a number of input bytes from  external source.
5712228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        The bytesValid variable returns the number of ramaining valid bytes in extern inputBuffer.
5722228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
5732228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream  HANDLE_FDK_BITSTREAM handle
5742228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param inputBuffer Pointer to input buffer with bitstream data.
5752228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param bufferSize  Total size of inputBuffer array.
5762228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param bytesValid  Input: number of valid bytes in inputBuffer. Output: bytes still left unread in inputBuffer.
5772228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
5782228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
5792228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKfeedBuffer (HANDLE_FDK_BITSTREAM hBitStream, const UCHAR inputBuffer [], const UINT bufferSize, UINT *bytesValid)
5802228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
5812228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDKsyncCache (hBitStream) ;
5822228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_Feed(&hBitStream->hBitBuf, (UCHAR*)inputBuffer, bufferSize, bytesValid  ) ;
5832228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
5842228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5852228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
5862228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
5872228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief fill destination BitBuffer with a number of bytes from source BitBuffer. The
5882228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        bytesValid variable returns the number of ramaining valid bytes in source BitBuffer.
5892228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
5902228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBSDst            HANDLE_FDK_BITSTREAM handle to write data into
5912228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBSSrc            HANDLE_FDK_BITSTREAM handle to read data from
5922228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param bytesValid        Input: number of valid bytes in inputBuffer. Output: bytes still left unread in inputBuffer.
5932228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
5942228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
5952228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKcopyBuffer (HANDLE_FDK_BITSTREAM hBSDst, HANDLE_FDK_BITSTREAM hBSSrc, UINT *bytesValid)
5962228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
5972228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDKsyncCache (hBSSrc) ;
5982228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_Copy (&hBSDst->hBitBuf, &hBSSrc->hBitBuf, bytesValid) ;
5992228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
6002228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
6012228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
6022228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project/**
6032228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \brief fill the outputBuffer with all valid bytes hold in BitBuffer. The WriteBytes
6042228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *        variable returns the number of written Bytes.
6052228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project *
6062228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param hBitStream    HANDLE_FDK_BITSTREAM handle
6072228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param outputBuffer  Pointer to output buffer.
6082228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \param writeBytes    Number of bytes write to output buffer.
6092228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project * \return void
6102228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project */
6112228e360595641dd906bf1773307f43d304f5b2The Android Open Source ProjectFDK_INLINE void FDKfetchBuffer(HANDLE_FDK_BITSTREAM hBitStream, UCHAR *outputBuffer, UINT *writeBytes)
6122228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project{
6132228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDKsyncCache (hBitStream) ;
6142228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project  FDK_Fetch(&hBitStream->hBitBuf, outputBuffer, writeBytes);
6152228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project}
6162228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
6172228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project
6182228e360595641dd906bf1773307f43d304f5b2The Android Open Source Project#endif
619