source: SHVCSoftware/branches/SHM-dev/source/Lib/TLibCommon/TComPic.h @ 1312

Last change on this file since 1312 was 1290, checked in by seregin, 9 years ago

port rev 4324 (g_uiMaxDepth, g_uiAddDepth)
  • Property svn:eol-style set to native
File size: 11.3 KB
Line 
1/* The copyright in this software is being made available under the BSD
2 * License, included below. This software may be subject to other third party
3 * and contributor rights, including patent rights, and no such rights are
4 * granted under this license.
5 *
6 * Copyright (c) 2010-2015, ITU/ISO/IEC
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 *  * Redistributions of source code must retain the above copyright notice,
13 *    this list of conditions and the following disclaimer.
14 *  * Redistributions in binary form must reproduce the above copyright notice,
15 *    this list of conditions and the following disclaimer in the documentation
16 *    and/or other materials provided with the distribution.
17 *  * Neither the name of the ITU/ISO/IEC nor the names of its contributors may
18 *    be used to endorse or promote products derived from this software without
19 *    specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31 * THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34/** \file     TComPic.h
35    \brief    picture class (header)
36*/
37
38#ifndef __TCOMPIC__
39#define __TCOMPIC__
40
41// Include files
42#include "CommonDef.h"
43#include "TComPicSym.h"
44#include "TComPicYuv.h"
45#include "TComBitStream.h"
46#if AVC_BASE
47#include <fstream>
48#endif
49
50//! \ingroup TLibCommon
51//! \{
52
53// ====================================================================================================================
54// Class definition
55// ====================================================================================================================
56
57/// picture class (symbol + YUV buffers)
58
59class TComPic
60{
61public:
62  typedef enum { PIC_YUV_ORG=0, PIC_YUV_REC=1, PIC_YUV_TRUE_ORG=2, NUM_PIC_YUV=3 } PIC_YUV_T;
63     // TRUE_ORG is the input file without any pre-encoder colour space conversion (but with possible bit depth increment)
64  TComPicYuv*   getPicYuvTrueOrg()        { return  m_apcPicYuv[PIC_YUV_TRUE_ORG]; }
65
66private:
67  UInt                  m_uiTLayer;               //  Temporal layer
68  Bool                  m_bUsedByCurr;            //  Used by current picture
69  Bool                  m_bIsLongTerm;            //  IS long term picture
70  TComPicSym            m_picSym;                 //  Symbol
71  TComPicYuv*           m_apcPicYuv[NUM_PIC_YUV];
72
73  TComPicYuv*           m_pcPicYuvPred;           //  Prediction
74  TComPicYuv*           m_pcPicYuvResi;           //  Residual
75  Bool                  m_bReconstructed;
76  Bool                  m_bNeededForOutput;
77  UInt                  m_uiCurrSliceIdx;         // Index of current slice
78  Bool                  m_bCheckLTMSB;
79
80  Bool                  m_isTop;
81  Bool                  m_isField;
82
83  std::vector<std::vector<TComDataCU*> > m_vSliceCUDataLink;
84
85  SEIMessages  m_SEIs; ///< Any SEI messages that have been received.  If !NULL we own the object.
86#if SVC_EXTENSION
87  UInt                  m_layerId;              //  Layer ID
88  Bool                  m_bSpatialEnhLayer[MAX_LAYERS];       // whether current layer is a spatial enhancement layer,
89  TComPicYuv*           m_pcFullPelBaseRec[MAX_LAYERS];    // upsampled base layer recontruction for difference domain inter prediction
90  Bool                  m_equalPictureSizeAndOffsetFlag[MAX_LAYERS]; 
91#if CGS_3D_ASYMLUT
92  Int                   m_nFrameBit;
93#endif
94  Bool                  m_currAuFlag;
95#endif
96public:
97  TComPic();
98  virtual ~TComPic();
99
100#if SVC_EXTENSION
101  Void          create( const TComVPS& vps, const TComSPS &sps, const TComPPS &pps, const Bool bIsVirtual /*= false*/, const UInt layerId );
102#else
103  Void          create( const TComSPS &sps, const TComPPS &pps, const Bool bIsVirtual /*= false*/ );
104#endif
105
106  virtual Void  destroy();
107
108  UInt          getTLayer() const               { return m_uiTLayer;   }
109  Void          setTLayer( UInt uiTLayer ) { m_uiTLayer = uiTLayer; }
110
111  Bool          getUsedByCurr() const            { return m_bUsedByCurr; }
112  Void          setUsedByCurr( Bool bUsed ) { m_bUsedByCurr = bUsed; }
113  Bool          getIsLongTerm() const            { return m_bIsLongTerm; }
114  Void          setIsLongTerm( Bool lt ) { m_bIsLongTerm = lt; }
115  Void          setCheckLTMSBPresent     (Bool b ) {m_bCheckLTMSB=b;}
116  Bool          getCheckLTMSBPresent     () { return m_bCheckLTMSB;}
117
118  TComPicSym*   getPicSym()           { return  &m_picSym;    }
119  TComSlice*    getSlice(Int i)       { return  m_picSym.getSlice(i);  }
120  Int           getPOC() const        { return  m_picSym.getSlice(m_uiCurrSliceIdx)->getPOC();  }
121  TComDataCU*   getCtu( UInt ctuRsAddr )           { return  m_picSym.getCtu( ctuRsAddr ); }
122  const TComDataCU* getCtu( UInt ctuRsAddr ) const { return  m_picSym.getCtu( ctuRsAddr ); }
123
124  TComPicYuv*   getPicYuvOrg()        { return  m_apcPicYuv[PIC_YUV_ORG]; }
125  TComPicYuv*   getPicYuvRec()        { return  m_apcPicYuv[PIC_YUV_REC]; }
126
127  TComPicYuv*   getPicYuvPred()       { return  m_pcPicYuvPred; }
128  TComPicYuv*   getPicYuvResi()       { return  m_pcPicYuvResi; }
129  Void          setPicYuvPred( TComPicYuv* pcPicYuv )       { m_pcPicYuvPred = pcPicYuv; }
130  Void          setPicYuvResi( TComPicYuv* pcPicYuv )       { m_pcPicYuvResi = pcPicYuv; }
131
132  UInt          getNumberOfCtusInFrame() const     { return m_picSym.getNumberOfCtusInFrame(); }
133  UInt          getNumPartInCtuWidth() const       { return m_picSym.getNumPartInCtuWidth();   }
134  UInt          getNumPartInCtuHeight() const      { return m_picSym.getNumPartInCtuHeight();  }
135  UInt          getNumPartitionsInCtu() const      { return m_picSym.getNumPartitionsInCtu();  }
136  UInt          getFrameWidthInCtus() const        { return m_picSym.getFrameWidthInCtus();    }
137  UInt          getFrameHeightInCtus() const       { return m_picSym.getFrameHeightInCtus();   }
138  UInt          getMinCUWidth() const              { return m_picSym.getMinCUWidth();          }
139  UInt          getMinCUHeight() const             { return m_picSym.getMinCUHeight();         }
140
141  Int           getStride(const ComponentID id) const          { return m_apcPicYuv[PIC_YUV_REC]->getStride(id); }
142  Int           getComponentScaleX(const ComponentID id) const    { return m_apcPicYuv[PIC_YUV_REC]->getComponentScaleX(id); }
143  Int           getComponentScaleY(const ComponentID id) const    { return m_apcPicYuv[PIC_YUV_REC]->getComponentScaleY(id); }
144  ChromaFormat  getChromaFormat() const                           { return m_apcPicYuv[PIC_YUV_REC]->getChromaFormat(); }
145  Int           getNumberValidComponents() const                  { return m_apcPicYuv[PIC_YUV_REC]->getNumberValidComponents(); }
146
147  Void          setReconMark (Bool b) { m_bReconstructed = b;     }
148  Bool          getReconMark () const      { return m_bReconstructed;  }
149  Void          setOutputMark (Bool b) { m_bNeededForOutput = b;     }
150  Bool          getOutputMark () const      { return m_bNeededForOutput;  }
151
152  Void          compressMotion();
153  UInt          getCurrSliceIdx() const           { return m_uiCurrSliceIdx;                }
154  Void          setCurrSliceIdx(UInt i)      { m_uiCurrSliceIdx = i;                   }
155  UInt          getNumAllocatedSlice() const      {return m_picSym.getNumAllocatedSlice();}
156  Void          allocateNewSlice()           {m_picSym.allocateNewSlice();         }
157  Void          clearSliceBuffer()           {m_picSym.clearSliceBuffer();         }
158
159  const Window& getConformanceWindow() const { return m_picSym.getSPS().getConformanceWindow(); }
160  Window        getDefDisplayWindow() const  { return m_picSym.getSPS().getVuiParametersPresentFlag() ? m_picSym.getSPS().getVuiParameters()->getDefaultDisplayWindow() : Window(); }
161
162  Bool          getSAOMergeAvailability(Int currAddr, Int mergeAddr);
163
164  UInt          getSubstreamForCtuAddr(const UInt ctuAddr, const Bool bAddressInRaster, TComSlice *pcSlice);
165
166  /* field coding parameters*/
167
168   Void              setTopField(Bool b)                  {m_isTop = b;}
169   Bool              isTopField()                         {return m_isTop;}
170   Void              setField(Bool b)                     {m_isField = b;}
171   Bool              isField()                            {return m_isField;}
172
173  /** transfer ownership of seis to this picture */
174  Void setSEIs(SEIMessages& seis) { m_SEIs = seis; }
175
176  /**
177   * return the current list of SEI messages associated with this picture.
178   * Pointer is valid until this->destroy() is called */
179  SEIMessages& getSEIs() { return m_SEIs; }
180
181  /**
182   * return the current list of SEI messages associated with this picture.
183   * Pointer is valid until this->destroy() is called */
184  const SEIMessages& getSEIs() const { return m_SEIs; }
185
186#if SVC_EXTENSION
187  Void          setLayerId(UInt layerId)                                    { m_layerId = layerId;                                       }
188  UInt          getLayerId()                                                { return m_layerId;                                          }
189  UInt          getLayerIdx()                                               { return getSlice(0)->getVPS()->getLayerIdxInVps(m_layerId); }
190  Bool          isSpatialEnhLayer(UInt refLayerIdc)                         { return m_bSpatialEnhLayer[refLayerIdc];                    }
191  Void          setSpatialEnhLayerFlag (UInt refLayerIdc, Bool b)           { m_bSpatialEnhLayer[refLayerIdc] = b;                       }
192  Void          setFullPelBaseRec   (UInt refLayerIdc, TComPicYuv* p)       { m_pcFullPelBaseRec[refLayerIdc] = p;                       }
193  TComPicYuv*   getFullPelBaseRec   (UInt refLayerIdc)                      { return  m_pcFullPelBaseRec[refLayerIdc];                   }
194  Bool          isILR( UInt currLayerId )                                   { return ( m_bIsLongTerm && m_layerId < currLayerId );       }
195  Bool          equalPictureSizeAndOffsetFlag(UInt refLayerIdc)             { return m_equalPictureSizeAndOffsetFlag[refLayerIdc];       }
196  Void          setEqualPictureSizeAndOffsetFlag(UInt refLayerIdc, Bool b)  { m_equalPictureSizeAndOffsetFlag[refLayerIdc] = b;          }
197  Void          copyUpsampledMvField(UInt refLayerIdc);
198  Void          initUpsampledMvField();
199  Bool          checkSameRefInfo();
200  Void          copyUpsampledPictureYuv(TComPicYuv*   pcPicYuvIn, TComPicYuv*   pcPicYuvOut); 
201#if CGS_3D_ASYMLUT
202  Void          setFrameBit( Int n )                                        { m_nFrameBit = n;     }
203  Int           getFrameBit()                                               { return m_nFrameBit;  }
204#endif
205  Bool          isCurrAu()                                                  { return m_currAuFlag; }
206  Void          setCurrAuFlag(Bool x)                                       { m_currAuFlag = x;    }
207#endif //SVC_EXTENSION
208};// END CLASS DEFINITION TComPic
209
210//! \}
211
212#endif // __TCOMPIC__
Note: See TracBrowser for help on using the repository browser.