source: SHVCSoftware/branches/SHM-upgrade/source/App/TAppDecoder/TAppDecCfg.h @ 1311

/* 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-2014, 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     TAppDecCfg.h
    \brief    Decoder configuration class (header)
*/

#ifndef __TAPPDECCFG__
#define __TAPPDECCFG__

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#include "TLibCommon/CommonDef.h"
#include <vector>

//! \ingroup TAppDecoder
//! \{

// ====================================================================================================================
// Class definition
// ====================================================================================================================

/// Decoder configuration class
class TAppDecCfg
{
protected:
  Char*         m_pchBitstreamFile;                     ///< input bitstream file name
#if SVC_EXTENSION
  Char*         m_pchReconFile [MAX_LAYERS];          ///< output reconstruction file name
#else
  Char*         m_pchReconFile;                         ///< output reconstruction file name
#endif
  Int           m_iSkipFrame;                           ///< counter for frames prior to the random access point to skip
  Int           m_outputBitDepth[MAX_NUM_CHANNEL_TYPE]; ///< bit depth used for writing output
  InputColourSpaceConversion m_outputColourSpaceConvert;

  Int           m_iMaxTemporalLayer;                  ///< maximum temporal layer to be decoded
  Int           m_decodedPictureHashSEIEnabled;       ///< Checksum(3)/CRC(2)/MD5(1)/disable(0) acting on decoded picture hash SEI message
  Bool          m_decodedNoDisplaySEIEnabled;         ///< Enable(true)/disable(false) writing only pictures that get displayed based on the no display SEI message
#if Q0074_COLOUR_REMAPPING_SEI
  Bool          m_colourRemapSEIEnabled;              ///< Enable the Colour Remapping Information SEI message if available (remapping decoded pictures)
#endif

#if SVC_EXTENSION
  Int           m_tgtLayerId;                        ///< target layer ID
#if AVC_BASE
  Char*         m_pchBLReconFile;                     ///< input BL reconstruction file name
#if !REPN_FORMAT_IN_VPS
  Int           m_iBLSourceWidth;
  Int           m_iBLSourceHeight;
#endif
#endif
#endif

  std::vector<Int> m_targetDecLayerIdSet;             ///< set of LayerIds to be included in the sub-bitstream extraction process.
  Int           m_respectDefDispWindow;               ///< Only output content inside the default display window
#if O0043_BEST_EFFORT_DECODING
  UInt          m_forceDecodeBitDepth;                ///< if non-zero, force the bit depth at the decoder (best effort decoding)
#endif
  std::string   m_outputDecodedSEIMessagesFilename;   ///< filename to output decoded SEI messages to. If '-', then use stdout. If empty, do not output details.
#if OUTPUT_LAYER_SET_INDEX
  CommonDecoderParams             m_commonDecoderParams;
#endif
#if CONFORMANCE_BITSTREAM_MODE
  Bool          m_confModeFlag;
  std::string   m_confPrefix;
  std::string   m_metadataFileName;
  Bool          m_metadataFileRefresh;
  std::string   m_decodedYuvLayerFileName[63];
  Bool          m_decodedYuvLayerRefresh[63];
#endif

public:
  TAppDecCfg()
  : m_pchBitstreamFile(NULL)
#if !SVC_EXTENSION
  , m_pchReconFile(NULL)
#endif
  , m_iSkipFrame(0)
  , m_outputColourSpaceConvert(IPCOLOURSPACE_UNCHANGED)
  , m_iMaxTemporalLayer(-1)
  , m_decodedPictureHashSEIEnabled(0)
  , m_decodedNoDisplaySEIEnabled(false)
#if Q0074_COLOUR_REMAPPING_SEI
  , m_colourRemapSEIEnabled(0)
#endif
#if SVC_EXTENSION
  , m_tgtLayerId(0)
#if AVC_BASE && !REPN_FORMAT_IN_VPS
  , m_iBLSourceWidth(0)
  , m_iBLSourceHeight(0)
#endif
#endif
  , m_respectDefDispWindow(0)
#if O0043_BEST_EFFORT_DECODING
  , m_forceDecodeBitDepth(0)
#endif
  {
    for (UInt channelTypeIndex = 0; channelTypeIndex < MAX_NUM_CHANNEL_TYPE; channelTypeIndex++)
      m_outputBitDepth[channelTypeIndex] = 0;
  }

  virtual ~TAppDecCfg() {}

  Bool  parseCfg        ( Int argc, Char* argv[] );   ///< initialize option class from configuration
#if OUTPUT_LAYER_SET_INDEX
  CommonDecoderParams* getCommonDecoderParams() {return &m_commonDecoderParams;}
#endif
#if CONFORMANCE_BITSTREAM_MODE
  Bool const getConfModeFlag() { return m_confModeFlag;  }
  std::string const getConfPrefix() { return m_confPrefix;}
  std::string const getMetadataFileName() { return m_metadataFileName; }
  Bool const getMetadataFileRefresh() {return m_metadataFileRefresh; }
  Void setMetadataFileRefresh(Bool const x) {m_metadataFileRefresh = x; }
  Void setDecodedYuvLayerFileName(Int layerId, std::string x) {  m_decodedYuvLayerFileName[layerId] = x; }
  std::string const getDecodedYuvLayerFileName(Int layerId) {  return m_decodedYuvLayerFileName[layerId]; }
  Bool const getDecodedYuvLayerRefresh(Int const layerId) {return m_decodedYuvLayerRefresh[layerId]; }
  Void setDecodedYuvLayerRefresh(Int const layerId, Bool const x) {m_decodedYuvLayerRefresh[layerId] = x; }
#endif
};

//! \}

#endif