/* The copyright in this software is being made available under the BSD
 * License, included below. This software may be subject to other third party
 * and contributor rights, including patent rights, and no such rights are
 * granted under this license.  
 *
 * Copyright (c) 2010-2012, ITU/ISO/IEC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  * Neither the name of the ITU/ISO/IEC nor the names of its contributors may
 *    be used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

/** \file     TDecBinCoderCABAC.h
    \brief    binary entropy decoder of CABAC
*/

#ifndef __TDEC_BIN_CODER_CABAC__
#define __TDEC_BIN_CODER_CABAC__

#include "TLibCommon/TComCABACTables.h"
#include "TDecBinCoder.h"

//! \ingroup TLibDecoder
//! \{

class TDecBinCABAC : public TDecBinIf
{
public:
  TDecBinCABAC ();
  virtual ~TDecBinCABAC();
  
  Void  init              ( TComInputBitstream* pcTComBitstream );
  Void  uninit            ();
  
  Void  start             ();
  Void  finish            ();
#if OL_FLUSH
  Void  flush             ();
#endif
  
  Void  decodeBin         ( UInt& ruiBin, ContextModel& rcCtxModel );
  Void  decodeBinEP       ( UInt& ruiBin                           );
  Void  decodeBinsEP      ( UInt& ruiBin, Int numBins              );
  Void  decodeBinTrm      ( UInt& ruiBin                           );
  
  Void  resetBac          ();
#if BURST_IPCM
  Void  decodeNumSubseqIPCM( Int& numSubseqIPCM ) ;
#endif
  Void  decodePCMAlignBits();
  Void  xReadPCMCode      ( UInt uiLength, UInt& ruiCode );
  
  Void  copyState         ( TDecBinIf* pcTDecBinIf );
  TDecBinCABAC* getTDecBinCABAC()  { return this; }
#if !OL_FLUSH_ALIGN
  Int   getBitsReadAhead() { return -m_bitsNeeded; }
#endif

private:
  TComInputBitstream* m_pcTComBitstream;
  UInt                m_uiRange;
  UInt                m_uiValue;
#if OL_FLUSH && !OL_FLUSH_ALIGN
  UInt                m_uiLastByte;
#endif
  Int                 m_bitsNeeded;
};

//! \}

#endif