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

Last change on this file since 1606 was 313, checked in by suehring, 11 years ago

set svn:eol-style=native property on all source files to do proper
automatic line break conversion on check-out and check-in
  • Property svn:eol-style set to native
File size: 11.0 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-2013, 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#include "SEI.h"
47#if AVC_BASE || SYNTAX_OUTPUT
48#include <fstream>
49#endif
50
51//! \ingroup TLibCommon
52//! \{
53
54// ====================================================================================================================
55// Class definition
56// ====================================================================================================================
57
58/// picture class (symbol + YUV buffers)
59class TComPic
60{
61private:
62  UInt                  m_uiTLayer;               //  Temporal layer
63#if SVC_EXTENSION
64  UInt                  m_layerId;              //  Layer ID
65#endif
66  Bool                  m_bUsedByCurr;            //  Used by current picture
67  Bool                  m_bIsLongTerm;            //  IS long term picture
68  Bool                  m_bIsUsedAsLongTerm;      //  long term picture is used as reference before
69  TComPicSym*           m_apcPicSym;              //  Symbol
70 
71  TComPicYuv*           m_apcPicYuv[2];           //  Texture,  0:org / 1:rec
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  Int*                  m_pSliceSUMap;
79  Bool*                 m_pbValidSlice;
80  Int                   m_sliceGranularityForNDBFilter;
81  Bool                  m_bIndependentSliceBoundaryForNDBFilter;
82  Bool                  m_bIndependentTileBoundaryForNDBFilter;
83  TComPicYuv*           m_pNDBFilterYuvTmp;    //!< temporary picture buffer when non-cross slice/tile boundary in-loop filtering is enabled
84  Bool                  m_bCheckLTMSB;
85 
86  Int                   m_numReorderPics[MAX_TLAYER];
87  Window                m_conformanceWindow;
88  Window                m_defaultDisplayWindow;
89
90  std::vector<std::vector<TComDataCU*> > m_vSliceCUDataLink;
91
92  SEIMessages  m_SEIs; ///< Any SEI messages that have been received.  If !NULL we own the object.
93#if SVC_EXTENSION
94  Bool                  m_bSpatialEnhLayer[MAX_LAYERS];       // whether current layer is a spatial enhancement layer,
95  TComPicYuv*           m_pcFullPelBaseRec[MAX_LAYERS];    // upsampled base layer recontruction for difference domain inter prediction
96#endif
97
98public:
99  TComPic();
100  virtual ~TComPic();
101 
102#if SVC_UPSAMPLING
103  Void          create( Int iWidth, Int iHeight, UInt uiMaxWidth, UInt uiMaxHeight, UInt uiMaxDepth, Window &conformanceWindow, Window &defaultDisplayWindow, 
104                        Int *numReorderPics, TComSPS* pcSps = NULL, Bool bIsVirtual = false );
105#else
106  Void          create( Int iWidth, Int iHeight, UInt uiMaxWidth, UInt uiMaxHeight, UInt uiMaxDepth, Window &conformanceWindow, Window &defaultDisplayWindow, 
107                        Int *numReorderPics, Bool bIsVirtual = false );                       
108#endif
109  virtual Void  destroy();
110 
111  UInt          getTLayer()                { return m_uiTLayer;   }
112  Void          setTLayer( UInt uiTLayer ) { m_uiTLayer = uiTLayer; }
113#if SVC_EXTENSION
114  Void          setLayerId (UInt layerId) { m_layerId = layerId; }
115  UInt          getLayerId ()               { return m_layerId; }
116  Bool          isSpatialEnhLayer(UInt refLayerIdc)             { return m_bSpatialEnhLayer[refLayerIdc]; }
117  Void          setSpatialEnhLayerFlag (UInt refLayerIdc, Bool b) { m_bSpatialEnhLayer[refLayerIdc] = b; }
118  Void          setFullPelBaseRec   (UInt refLayerIdc, TComPicYuv* p) { m_pcFullPelBaseRec[refLayerIdc] = p; }
119  TComPicYuv*   getFullPelBaseRec   (UInt refLayerIdc)  { return  m_pcFullPelBaseRec[refLayerIdc];  }
120#endif
121#if REF_IDX_ME_ZEROMV || ENCODER_FAST_MODE || REF_IDX_MFM
122  Bool          isILR( UInt currLayerId )   { return ( getIsLongTerm() && m_layerId < currLayerId ); }
123#endif
124
125#if REF_IDX_MFM
126  Void          copyUpsampledMvField  ( UInt refLayerIdc, TComPic* pcPicBase );
127  Void          initUpsampledMvField  ();
128#endif
129
130  Bool          getUsedByCurr()             { return m_bUsedByCurr; }
131  Void          setUsedByCurr( Bool bUsed ) { m_bUsedByCurr = bUsed; }
132  Bool          getIsLongTerm()             { return m_bIsLongTerm; }
133  Void          setIsLongTerm( Bool lt ) { m_bIsLongTerm = lt; }
134  Void          setCheckLTMSBPresent     (Bool b ) {m_bCheckLTMSB=b;}
135  Bool          getCheckLTMSBPresent     () { return m_bCheckLTMSB;}
136
137  TComPicSym*   getPicSym()           { return  m_apcPicSym;    }
138  TComSlice*    getSlice(Int i)       { return  m_apcPicSym->getSlice(i);  }
139  Int           getPOC()              { return  m_apcPicSym->getSlice(m_uiCurrSliceIdx)->getPOC();  }
140  TComDataCU*&  getCU( UInt uiCUAddr )  { return  m_apcPicSym->getCU( uiCUAddr ); }
141 
142  TComPicYuv*   getPicYuvOrg()        { return  m_apcPicYuv[0]; }
143  TComPicYuv*   getPicYuvRec()        { return  m_apcPicYuv[1]; }
144 
145  TComPicYuv*   getPicYuvPred()       { return  m_pcPicYuvPred; }
146  TComPicYuv*   getPicYuvResi()       { return  m_pcPicYuvResi; }
147  Void          setPicYuvPred( TComPicYuv* pcPicYuv )       { m_pcPicYuvPred = pcPicYuv; }
148  Void          setPicYuvResi( TComPicYuv* pcPicYuv )       { m_pcPicYuvResi = pcPicYuv; }
149 
150  UInt          getNumCUsInFrame()      { return m_apcPicSym->getNumberOfCUsInFrame(); }
151  UInt          getNumPartInWidth()     { return m_apcPicSym->getNumPartInWidth();     }
152  UInt          getNumPartInHeight()    { return m_apcPicSym->getNumPartInHeight();    }
153  UInt          getNumPartInCU()        { return m_apcPicSym->getNumPartition();       }
154  UInt          getFrameWidthInCU()     { return m_apcPicSym->getFrameWidthInCU();     }
155  UInt          getFrameHeightInCU()    { return m_apcPicSym->getFrameHeightInCU();    }
156  UInt          getMinCUWidth()         { return m_apcPicSym->getMinCUWidth();         }
157  UInt          getMinCUHeight()        { return m_apcPicSym->getMinCUHeight();        }
158 
159  UInt          getParPelX(UChar uhPartIdx) { return getParPelX(uhPartIdx); }
160  UInt          getParPelY(UChar uhPartIdx) { return getParPelX(uhPartIdx); }
161 
162  Int           getStride()           { return m_apcPicYuv[1]->getStride(); }
163  Int           getCStride()          { return m_apcPicYuv[1]->getCStride(); }
164 
165  Void          setReconMark (Bool b) { m_bReconstructed = b;     }
166  Bool          getReconMark ()       { return m_bReconstructed;  }
167  Void          setOutputMark (Bool b) { m_bNeededForOutput = b;     }
168  Bool          getOutputMark ()       { return m_bNeededForOutput;  }
169 
170  Void          setNumReorderPics(Int i, UInt tlayer) { m_numReorderPics[tlayer] = i;    }
171  Int           getNumReorderPics(UInt tlayer)        { return m_numReorderPics[tlayer]; }
172
173  Void          compressMotion(); 
174  UInt          getCurrSliceIdx()            { return m_uiCurrSliceIdx;                }
175  Void          setCurrSliceIdx(UInt i)      { m_uiCurrSliceIdx = i;                   }
176  UInt          getNumAllocatedSlice()       {return m_apcPicSym->getNumAllocatedSlice();}
177  Void          allocateNewSlice()           {m_apcPicSym->allocateNewSlice();         }
178  Void          clearSliceBuffer()           {m_apcPicSym->clearSliceBuffer();         }
179
180  Window&       getConformanceWindow()  { return m_conformanceWindow; }
181  Window&       getDefDisplayWindow()   { return m_defaultDisplayWindow; }
182
183  Void          createNonDBFilterInfo   (std::vector<Int> sliceStartAddress, Int sliceGranularityDepth
184                                        ,std::vector<Bool>* LFCrossSliceBoundary
185                                        ,Int  numTiles = 1
186                                        ,Bool bNDBFilterCrossTileBoundary = true);
187  Void          createNonDBFilterInfoLCU(Int tileID, Int sliceID, TComDataCU* pcCU, UInt startSU, UInt endSU, Int sliceGranularyDepth, UInt picWidth, UInt picHeight);
188  Void          destroyNonDBFilterInfo();
189
190  Bool          getValidSlice                                  (Int sliceID)  {return m_pbValidSlice[sliceID];}
191  Bool          getIndependentSliceBoundaryForNDBFilter        ()             {return m_bIndependentSliceBoundaryForNDBFilter;}
192  Bool          getIndependentTileBoundaryForNDBFilter         ()             {return m_bIndependentTileBoundaryForNDBFilter; }
193  TComPicYuv*   getYuvPicBufferForIndependentBoundaryProcessing()             {return m_pNDBFilterYuvTmp;}
194  std::vector<TComDataCU*>& getOneSliceCUDataForNDBFilter      (Int sliceID) { return m_vSliceCUDataLink[sliceID];}
195
196  /** transfer ownership of seis to this picture */
197  void setSEIs(SEIMessages& seis) { m_SEIs = seis; }
198
199  /**
200   * return the current list of SEI messages associated with this picture.
201   * Pointer is valid until this->destroy() is called */
202  SEIMessages& getSEIs() { return m_SEIs; }
203
204  /**
205   * return the current list of SEI messages associated with this picture.
206   * Pointer is valid until this->destroy() is called */
207  const SEIMessages& getSEIs() const { return m_SEIs; }
208
209#if REF_IDX_FRAMEWORK
210  Void  copyUpsampledPictureYuv(TComPicYuv*   pcPicYuvIn, TComPicYuv*   pcPicYuvOut); 
211#endif
212#if AVC_SYNTAX
213  Void readBLSyntax( fstream* filestream, UInt numBytes );
214#endif
215#if SYNTAX_OUTPUT
216  Void wrireBLSyntax( fstream* filestream, UInt numBytes );
217#endif
218
219};// END CLASS DEFINITION TComPic
220
221//! \}
222
223#endif // __TCOMPIC__
Note: See TracBrowser for help on using the repository browser.