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

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

port rev 4597
  • Property svn:eol-style set to native
File size: 12.5 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
87#if SVC_EXTENSION
88  UInt                  m_layerId;              //  Layer ID
89  Bool                  m_bSpatialEnhLayer[MAX_LAYERS];       // whether current layer is a spatial enhancement layer,
90  TComPicYuv*           m_pcFullPelBaseRec[MAX_LAYERS];    // upsampled base layer recontruction for difference domain inter prediction
91  Bool                  m_equalPictureSizeAndOffsetFlag[MAX_LAYERS];
92  Int*                  m_mvScalingFactor[2];
93  Int*                  m_posScalingFactor[2];
94#if CGS_3D_ASYMLUT
95  Int                   m_nFrameBit;
96#endif
97  Bool                  m_currAuFlag;
98#endif
99public:
100  TComPic();
101  virtual ~TComPic();
102
103#if SVC_EXTENSION
104  Void          create( const TComVPS& vps, const TComSPS &sps, const TComPPS &pps, const Bool bIsVirtual /*= false*/, const UInt layerId );
105#else
106  Void          create( const TComSPS &sps, const TComPPS &pps, const Bool bIsVirtual /*= false*/ );
107#endif
108
109  virtual Void  destroy();
110
111  UInt          getTLayer() const               { return m_uiTLayer;   }
112  Void          setTLayer( UInt uiTLayer ) { m_uiTLayer = uiTLayer; }
113
114  Bool          getUsedByCurr() const            { return m_bUsedByCurr; }
115  Void          setUsedByCurr( Bool bUsed ) { m_bUsedByCurr = bUsed; }
116  Bool          getIsLongTerm() const            { return m_bIsLongTerm; }
117  Void          setIsLongTerm( Bool lt ) { m_bIsLongTerm = lt; }
118  Void          setCheckLTMSBPresent     (Bool b ) {m_bCheckLTMSB=b;}
119  Bool          getCheckLTMSBPresent     () { return m_bCheckLTMSB;}
120
121  TComPicSym*   getPicSym()           { return  &m_picSym;    }
122  const TComPicSym* getPicSym() const { return  &m_picSym;    }
123  TComSlice*    getSlice(Int i)       { return  m_picSym.getSlice(i);  }
124  Int           getPOC() const        { return  m_picSym.getSlice(m_uiCurrSliceIdx)->getPOC();  }
125  TComDataCU*   getCtu( UInt ctuRsAddr )           { return  m_picSym.getCtu( ctuRsAddr ); }
126  const TComDataCU* getCtu( UInt ctuRsAddr ) const { return  m_picSym.getCtu( ctuRsAddr ); }
127
128  TComPicYuv*   getPicYuvOrg()        { return  m_apcPicYuv[PIC_YUV_ORG]; }
129  TComPicYuv*   getPicYuvRec()        { return  m_apcPicYuv[PIC_YUV_REC]; }
130
131  TComPicYuv*   getPicYuvPred()       { return  m_pcPicYuvPred; }
132  TComPicYuv*   getPicYuvResi()       { return  m_pcPicYuvResi; }
133  Void          setPicYuvPred( TComPicYuv* pcPicYuv )       { m_pcPicYuvPred = pcPicYuv; }
134  Void          setPicYuvResi( TComPicYuv* pcPicYuv )       { m_pcPicYuvResi = pcPicYuv; }
135
136  UInt          getNumberOfCtusInFrame() const     { return m_picSym.getNumberOfCtusInFrame(); }
137  UInt          getNumPartInCtuWidth() const       { return m_picSym.getNumPartInCtuWidth();   }
138  UInt          getNumPartInCtuHeight() const      { return m_picSym.getNumPartInCtuHeight();  }
139  UInt          getNumPartitionsInCtu() const      { return m_picSym.getNumPartitionsInCtu();  }
140  UInt          getFrameWidthInCtus() const        { return m_picSym.getFrameWidthInCtus();    }
141  UInt          getFrameHeightInCtus() const       { return m_picSym.getFrameHeightInCtus();   }
142  UInt          getMinCUWidth() const              { return m_picSym.getMinCUWidth();          }
143  UInt          getMinCUHeight() const             { return m_picSym.getMinCUHeight();         }
144
145  Int           getStride(const ComponentID id) const          { return m_apcPicYuv[PIC_YUV_REC]->getStride(id); }
146  Int           getComponentScaleX(const ComponentID id) const    { return m_apcPicYuv[PIC_YUV_REC]->getComponentScaleX(id); }
147  Int           getComponentScaleY(const ComponentID id) const    { return m_apcPicYuv[PIC_YUV_REC]->getComponentScaleY(id); }
148  ChromaFormat  getChromaFormat() const                           { return m_apcPicYuv[PIC_YUV_REC]->getChromaFormat(); }
149  Int           getNumberValidComponents() const                  { return m_apcPicYuv[PIC_YUV_REC]->getNumberValidComponents(); }
150
151  Void          setReconMark (Bool b) { m_bReconstructed = b;     }
152  Bool          getReconMark () const      { return m_bReconstructed;  }
153  Void          setOutputMark (Bool b) { m_bNeededForOutput = b;     }
154  Bool          getOutputMark () const      { return m_bNeededForOutput;  }
155
156  Void          compressMotion();
157  UInt          getCurrSliceIdx() const           { return m_uiCurrSliceIdx;                }
158  Void          setCurrSliceIdx(UInt i)      { m_uiCurrSliceIdx = i;                   }
159  UInt          getNumAllocatedSlice() const      {return m_picSym.getNumAllocatedSlice();}
160  Void          allocateNewSlice()           {m_picSym.allocateNewSlice();         }
161  Void          clearSliceBuffer()           {m_picSym.clearSliceBuffer();         }
162
163#if SVC_EXTENSION
164  const Window& getConformanceWindow() const { return m_picSym.getSlice(0)->getConformanceWindow(); }
165#else
166  const Window& getConformanceWindow() const { return m_picSym.getSPS().getConformanceWindow(); }
167#endif
168  Window        getDefDisplayWindow() const  { return m_picSym.getSPS().getVuiParametersPresentFlag() ? m_picSym.getSPS().getVuiParameters()->getDefaultDisplayWindow() : Window(); }
169
170  Bool          getSAOMergeAvailability(Int currAddr, Int mergeAddr);
171
172  UInt          getSubstreamForCtuAddr(const UInt ctuAddr, const Bool bAddressInRaster, TComSlice *pcSlice);
173
174  /* field coding parameters*/
175
176   Void              setTopField(Bool b)                  {m_isTop = b;}
177   Bool              isTopField()                         {return m_isTop;}
178   Void              setField(Bool b)                     {m_isField = b;}
179   Bool              isField()                            {return m_isField;}
180
181  /** transfer ownership of seis to this picture */
182  Void setSEIs(SEIMessages& seis) { m_SEIs = seis; }
183
184  /**
185   * return the current list of SEI messages associated with this picture.
186   * Pointer is valid until this->destroy() is called */
187  SEIMessages& getSEIs() { return m_SEIs; }
188
189  /**
190   * return the current list of SEI messages associated with this picture.
191   * Pointer is valid until this->destroy() is called */
192  const SEIMessages& getSEIs() const { return m_SEIs; }
193
194#if SVC_EXTENSION
195  Void          setLayerId(UInt layerId)                                    { m_layerId = layerId;                                       }
196  UInt          getLayerId() const                                          { return m_layerId;                                          }
197  UInt          getLayerIdx() const                                         { return m_picSym.getSlice(0)->getVPS()->getLayerIdxInVps(m_layerId);     }
198  Bool          isSpatialEnhLayer(UInt refLayerIdc) const                   { return m_bSpatialEnhLayer[refLayerIdc];                    }
199  Void          setSpatialEnhLayerFlag (UInt refLayerIdc, Bool b)           { m_bSpatialEnhLayer[refLayerIdc] = b;                       }
200  Void          setFullPelBaseRec   (UInt refLayerIdc, TComPicYuv* p)       { m_pcFullPelBaseRec[refLayerIdc] = p;                       }
201  TComPicYuv*   getFullPelBaseRec   (UInt refLayerIdc) const                { return  m_pcFullPelBaseRec[refLayerIdc];                   }
202  Bool          isILR( UInt currLayerId ) const                             { return ( m_bIsLongTerm && m_layerId < currLayerId );       }
203  Bool          equalPictureSizeAndOffsetFlag(UInt refLayerIdc) const       { return m_equalPictureSizeAndOffsetFlag[refLayerIdc];       }
204  Void          setEqualPictureSizeAndOffsetFlag(UInt refLayerIdc, Bool b)  { m_equalPictureSizeAndOffsetFlag[refLayerIdc] = b;          }
205  Void          copyUpsampledMvField(UInt refLayerIdc, Int** mvScalingFactor, Int** posScalingFactor);
206  Void          initUpsampledMvField();
207  Bool          checkSameRefInfo();
208  Void          copyUpsampledPictureYuv(TComPicYuv* pcPicYuvIn, TComPicYuv* pcPicYuvOut); 
209  Void          setMvScalingFactor(UInt refLayerIdc, Int compX, Int compY)  { m_mvScalingFactor[0][refLayerIdc] = compX; m_mvScalingFactor[1][refLayerIdc] = compY;   }
210  Void          setPosScalingFactor(UInt refLayerIdc, Int compX, Int compY) { m_posScalingFactor[0][refLayerIdc] = compX; m_posScalingFactor[1][refLayerIdc] = compY; }
211  Int           getMvScalingFactor(UInt refLayerIdc, UChar comp) const      { return m_mvScalingFactor[comp][refLayerIdc];  }
212  Int           getPosScalingFactor(UInt refLayerIdc, UChar comp) const     { return m_posScalingFactor[comp][refLayerIdc]; }
213  Int**         getPosScalingFactor()                                       { return m_posScalingFactor; }
214  Int**         getMvScalingFactor()                                        { return m_mvScalingFactor;  }
215  Void          createMvScalingFactor(UInt numOfILRPs);
216  Void          createPosScalingFactor(UInt numOfILRPs);
217#if CGS_3D_ASYMLUT
218  Void          setFrameBit( Int n )                                        { m_nFrameBit = n;     }
219  Int           getFrameBit() const                                         { return m_nFrameBit;  }
220#endif
221  Bool          isCurrAu() const                                            { return m_currAuFlag; }
222  Void          setCurrAuFlag(Bool x)                                       { m_currAuFlag = x;    }
223#endif //SVC_EXTENSION
224};// END CLASS DEFINITION TComPic
225
226//! \}
227
228#endif // __TCOMPIC__
Note: See TracBrowser for help on using the repository browser.