/*
********************************************************************************

NOTE - One of the two copyright statements below may be chosen
       that applies for the software.

********************************************************************************

This software module was originally developed by

Heiko Schwarz    (Fraunhofer HHI),
Tobias Hinz      (Fraunhofer HHI),
Karsten Suehring (Fraunhofer HHI)

in the course of development of the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video
Coding) for reference purposes and its performance may not have been optimized.
This software module is an implementation of one or more tools as specified by
the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding).

Those intending to use this software module in products are advised that its
use may infringe existing patents. ISO/IEC have no liability for use of this
software module or modifications thereof.

Assurance that the originally developed software module can be used
(1) in the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding) once the
ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding) has been adopted; and
(2) to develop the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding): 

To the extent that Fraunhofer HHI owns patent rights that would be required to
make, use, or sell the originally developed software module or portions thereof
included in the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding) in a
conforming product, Fraunhofer HHI will assure the ISO/IEC that it is willing
to negotiate licenses under reasonable and non-discriminatory terms and
conditions with applicants throughout the world.

Fraunhofer HHI retains full right to modify and use the code for its own
purpose, assign or donate the code to a third party and to inhibit third
parties from using the code for products that do not conform to MPEG-related
ITU Recommendations and/or ISO/IEC International Standards. 

This copyright notice must be included in all copies or derivative works.
Copyright (c) ISO/IEC 2005. 

********************************************************************************

COPYRIGHT AND WARRANTY INFORMATION

Copyright 2005, International Telecommunications Union, Geneva

The Fraunhofer HHI hereby donate this source code to the ITU, with the following
understanding:
    1. Fraunhofer HHI retain the right to do whatever they wish with the
       contributed source code, without limit.
    2. Fraunhofer HHI retain full patent rights (if any exist) in the technical
       content of techniques and algorithms herein.
    3. The ITU shall make this code available to anyone, free of license or
       royalty fees.

DISCLAIMER OF WARRANTY

These software programs are available to the user without any license fee or
royalty on an "as is" basis. The ITU disclaims any and all warranties, whether
express, implied, or statutory, including any implied warranties of
merchantability or of fitness for a particular purpose. In no event shall the
contributor or the ITU be liable for any incidental, punitive, or consequential
damages of any kind whatsoever arising from the use of these programs.

This disclaimer of warranty extends to the user of these programs and user's
customers, employees, agents, transferees, successors, and assigns.

The ITU does not represent or warrant that the programs furnished hereunder are
free of infringement of any third-party patents. Commercial implementations of
ITU-T Recommendations, including shareware, may be subject to royalty fees to
patent holders. Information regarding the ITU-T patent policy is available from 
the ITU Web site at http://www.itu.int.

THIS IS NOT A GRANT OF PATENT RIGHTS - SEE THE ITU-T PATENT POLICY.

********************************************************************************
*/




#if !defined(AFX_EXTRACTORPARAMETER_H__79149AEA_06A8_49CE_AB0A_7FC9ED7C05B5__INCLUDED_)
#define AFX_EXTRACTORPARAMETER_H__79149AEA_06A8_49CE_AB0A_7FC9ED7C05B5__INCLUDED_


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


class ExtractorParameter  
{
public:
  class Point
  {
  public:
    Point():uiWidth(0),uiHeight(0),dFrameRate(0.0),dBitRate(0.0)
    {
    }
    UInt    uiWidth;
    UInt    uiHeight;
    Double  dFrameRate;
    Double  dBitRate;

//--TEST DJ 0602
		UInt            uiROI[5];
  };

  //JVT-S043
  enum QLExtractionMode
  {
    QL_EXTRACTOR_MODE_ORDERED=0,
    QL_EXTRACTOR_MODE_JOINT
  };

public:
	ExtractorParameter          ();
	virtual ~ExtractorParameter ();

  const std::string&    getInFile           ()            const { return m_cInFile;         }
  const std::string&    getOutFile          ()            const { return m_cOutFile;        }
  Int                   getResult           ()            const { return m_iResult;         }
  Bool                  getAnalysisOnly     ()            const { return m_bAnalysisOnly;   }
  UInt                  getLayer            ()            const { return m_uiLayer;         }
  Void                  setLayer            (UInt layer)  { m_uiLayer = layer;        }
  UInt                  getLayerId            ()            const { return m_uiLayerId;         }
  Void                  setLayerId            (UInt layer)  { m_uiLayerId = layer;        }
  UInt                  getLevel            ()            const { return m_uiLevel;         }
  Double                getFGSLayer         ()            const { return m_dFGSLayer;       }
	Void                  setScalableLayer    (UInt sLayer)       { m_uiScalableLayer = sLayer; }
	UInt                  getScalableLayer    ()            const { return m_uiScalableLayer; }
	Void                  setBitrate          ( Double dBitrate  ) { m_dBitrate = dBitrate;   }
	Void                  setOutFileName      (std::string strName){ m_cOutFile = strName;    }
	std::string           getOutFileName      ()            const { return m_cOutFile;        } 
	Void					setMaxFGSLayerKept  (UInt fgs)    { m_uiMaxFGSLayerKept = fgs;		}
  UInt					getMaxFGSLayerKept  ()			  { return m_uiMaxFGSLayerKept;		}
  Double                getBitrate          ()            const { return m_dBitrate;        }
  const MyList<Point>&  getExtractionList   ()            const { return m_cExtractionList; }
  const MyList<UInt>&   getRemoveList       ()            const { return m_cRemoveList;     }

  // HS: packet trace
  Bool                  getTraceEnabled     ()            const { return m_bTraceFile;      }
  Bool                  getExtractTrace     ()            const { return m_bTraceExtract;   }
  const std::string&    getTraceFile        ()            const { return m_cTraceFile;      }
  const std::string&    getExtractTraceFile ()            const { return m_cExtractTrace;   }

  Void    setResult           ( Int     iResult )   { m_iResult = iResult;  }
  ErrVal  init                ( Int     argc,
                                Char**  argv );

  //{{Quality level estimation and modified truncation- JVTO044 and m12007
  //France Telecom R&D-(nathalie.cammas@francetelecom.com)
  Bool	getExtractDeadSubstream(UInt ui) { return m_bExtractDeadSubstream[ui];}
  Void	setLevel( UInt &uiLevel) { m_uiLevel = uiLevel;}
  Void  setTargetRate(Double d) { m_dTargetRate = d;}
  Double getTargetRate() { return m_dTargetRate;}
  //}}Quality level estimation and modified truncation- JVTO044 and m12007
  UInt	getExtractNonRequiredPics()	{ return	m_uiExtractNonRequiredPics;}
  Bool getExtractUsingQL() { return m_bExtractUsingQL;}


  //--TEST DJ 0602
  Bool	  getROIFlag		  ()  { return m_bROIFlag; };
  int     getExtractedNumROI  ()  { return iExtractedNumROI; };

//--TEST DJ 0602
   ErrVal  xParseFormatStringROI_Only	( Char*   pFormatString, Point&  rcSpatTempSNRPoint );

  //--TEST DJ 0602
  Bool  m_bROIFlag;
  int   iExtractedNumROI;

  //S051{
  Bool getUseSIP(){return m_bUseSIP;}
  UInt getSuffixUnitEnable(){return m_uiSuffixUnitEnable;}
  //S051}

  QLExtractionMode getQLExtractionMode() { return m_eQLExtractionMode; }
//JVT-T054{
  Bool  getKeepfExtraction() { return m_bKeepfExtraction;}
//JVT-T054}
protected:
  ErrVal  xPrintUsage         ( Char**  argv );
  ErrVal  xParseFormatString  ( Char*   pFormatString,
                                Point&  rcSpatTempSNRPoint );

protected:
  std::string     m_cInFile;
  std::string     m_cOutFile;
  Int             m_iResult;
	UInt            m_uiScalableLayer; 
	UInt            m_uiLayer;
  UInt			  m_uiLayerId;
  UInt            m_uiLevel;
  Double          m_dFGSLayer;
  UInt			  m_uiMaxFGSLayerKept;
  Double		  m_dBitrate;
  Bool            m_bAnalysisOnly;
  MyList<Point>   m_cExtractionList;
  MyList<UInt>    m_cRemoveList;

  // HS: packet trace
  Bool            m_bTraceFile;
  Bool            m_bTraceExtract;
  std::string     m_cTraceFile;
  std::string     m_cExtractTrace;

  //{{Quality level estimation and modified truncation- JVTO044 and m12007
  //France Telecom R&D-(nathalie.cammas@francetelecom.com)
  Bool			 m_bExtractDeadSubstream[MAX_LAYERS];
  Double	     m_dTargetRate;
  //}}Quality level estimation and modified truncation- JVTO044 and m12007
  UInt			 m_uiExtractNonRequiredPics;

  Bool           m_bExtractUsingQL;

  //S051{
  Bool			 m_bUseSIP;
   UInt			 m_uiSuffixUnitEnable;
  //S051}

  //JVT-S043
  QLExtractionMode m_eQLExtractionMode;
//JVT-T054{
  Bool      m_bKeepfExtraction; //used if extraction considering l AND f
//JVT-T054}
};

#endif // !defined(AFX_EXTRACTORPARAMETER_H__79149AEA_06A8_49CE_AB0A_7FC9ED7C05B5__INCLUDED_)