source: SHVCSoftware/branches/SHM-dev/source/App/TAppDecoder/TAppDecCfg.h @ 1497

/* 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-2015, 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:
  std::string   m_bitstreamFileName;                    ///< input bitstream file name
#if SVC_EXTENSION
  std::string   m_reconFileName[MAX_LAYERS];            ///< output reconstruction file name
#else
  std::string   m_reconFileName;                        ///< output reconstruction file name
#endif
  Int           m_iSkipFrame;                           ///< counter for frames prior to the random access point to skip
#if SVC_EXTENSION
  Int           m_outputBitDepth[MAX_LAYERS][MAX_NUM_CHANNEL_TYPE]; ///< bit depth used for writing output
#else
  Int           m_outputBitDepth[MAX_NUM_CHANNEL_TYPE]; ///< bit depth used for writing output
#endif
  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
  std::string   m_colourRemapSEIFileName;             ///< output Colour Remapping file name
  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.
  Bool          m_bClipOutputVideoToRec709Range;      ///< If true, clip the output video to the Rec 709 range on saving.

#if SVC_EXTENSION
#if AVC_BASE
  std::string   m_reconFileNameBL;                     ///< input BL reconstruction file name
#endif
  CommonDecoderParams             m_commonDecoderParams;
#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
#endif

public:
  TAppDecCfg()
  : m_bitstreamFileName()
#if !SVC_EXTENSION
  , m_reconFileName()
#endif
  , m_iSkipFrame(0)
  // m_outputBitDepth array initialised below
  , m_outputColourSpaceConvert(IPCOLOURSPACE_UNCHANGED)
  , m_iMaxTemporalLayer(-1)
  , m_decodedPictureHashSEIEnabled(0)
  , m_decodedNoDisplaySEIEnabled(false)
  , m_colourRemapSEIFileName()
  , m_targetDecLayerIdSet()
  , m_respectDefDispWindow(0)
#if O0043_BEST_EFFORT_DECODING
  , m_forceDecodeBitDepth(0)
#endif
  , m_outputDecodedSEIMessagesFilename()
  , m_bClipOutputVideoToRec709Range(false)
  {
#if SVC_EXTENSION
    for( Int layerId = 0; layerId < MAX_LAYERS; layerId++ )
    {
      for( UInt channelTypeIndex = 0; channelTypeIndex < MAX_NUM_CHANNEL_TYPE; channelTypeIndex++ )
      {
        m_outputBitDepth[layerId][channelTypeIndex] = 0;
      }
    }
#else
    for (UInt channelTypeIndex = 0; channelTypeIndex < MAX_NUM_CHANNEL_TYPE; channelTypeIndex++)
    {
      m_outputBitDepth[channelTypeIndex] = 0;
    }
#endif
  }

  virtual ~TAppDecCfg() {}

  Bool  parseCfg        ( Int argc, TChar* argv[] );   ///< initialize option class from configuration

#if SVC_EXTENSION
  CommonDecoderParams* getCommonDecoderParams() {return &m_commonDecoderParams;}

#if CONFORMANCE_BITSTREAM_MODE
  Bool        getConfModeFlag() const        { return m_confModeFlag;       }
  std::string getConfPrefix() const          { return m_confPrefix;         }
  std::string getMetadataFileName() const    { return m_metadataFileName;   }
  Bool        getMetadataFileRefresh() const {return m_metadataFileRefresh; }

  std::string getDecodedYuvLayerFileName(Int layerId) const        { return m_decodedYuvLayerFileName[layerId]; }
  Bool        getDecodedYuvLayerRefresh(const Int layerId) const   { return m_decodedYuvLayerRefresh[layerId];  }

  Void setMetadataFileRefresh(const Bool x)                        { m_metadataFileRefresh = x;              }
  Void setDecodedYuvLayerFileName(Int layerId, std::string x)      { m_decodedYuvLayerFileName[layerId] = x; }
  Void setDecodedYuvLayerRefresh(const Int layerId, const Bool x)  { m_decodedYuvLayerRefresh[layerId] = x;  }
#endif
#endif

};

//! \}

#endif