source: 3DVCSoftware/trunk/source/Lib/TLibCommon/TComPicYuv.h @ 1327

Last change on this file since 1327 was 1321, checked in by tech, 9 years ago

Merged 15.0-dev0@1320.
  • Property svn:eol-style set to native
File size: 10.2 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     TComPicYuv.h
35    \brief    picture YUV buffer class (header)
36*/
37
38#ifndef __TCOMPICYUV__
39#define __TCOMPICYUV__
40
41#include <stdio.h>
42#include "CommonDef.h"
43#include "TComRom.h"
44#include "TComChromaFormat.h"
45#include "SEI.h"
46
47//! \ingroup TLibCommon
48//! \{
49
50// ====================================================================================================================
51// Class definition
52// ====================================================================================================================
53
54/// picture YUV buffer class
55class TComPicYuv
56{
57private:
58
59  // ------------------------------------------------------------------------------------------------
60  //  YUV buffer
61  // ------------------------------------------------------------------------------------------------
62
63  Pel*  m_apiPicBuf[MAX_NUM_COMPONENT];             ///< Buffer (including margin)
64
65  Pel*  m_piPicOrg[MAX_NUM_COMPONENT];              ///< m_apiPicBufY + m_iMarginLuma*getStride() + m_iMarginLuma
66
67  // ------------------------------------------------------------------------------------------------
68  //  Parameter for general YUV buffer usage
69  // ------------------------------------------------------------------------------------------------
70
71  Int   m_iPicWidth;                                ///< Width of picture in pixels
72  Int   m_iPicHeight;                               ///< Height of picture in pixels
73  ChromaFormat m_chromaFormatIDC;                   ///< Chroma Format
74
75  Int*  m_ctuOffsetInBuffer[MAX_NUM_CHANNEL_TYPE];  ///< Gives an offset in the buffer for a given CTU (and channel)
76  Int*  m_subCuOffsetInBuffer[MAX_NUM_CHANNEL_TYPE];///< Gives an offset in the buffer for a given sub-CU (and channel), relative to start of CTU
77
78  Int   m_iMarginX;                                 ///< margin of Luma channel (chroma's may be smaller, depending on ratio)
79  Int   m_iMarginY;                                 ///< margin of Luma channel (chroma's may be smaller, depending on ratio)
80
81  Bool  m_bIsBorderExtended;
82#if NH_3D_IV_MERGE
83  Int   m_iBaseUnitWidth;       ///< Width of Base Unit (with maximum depth or minimum size, m_iCuWidth >> Max. Depth)
84  Int   m_iBaseUnitHeight;      ///< Height of Base Unit (with maximum depth or minimum size, m_iCuHeight >> Max. Depth)
85  Int   m_iNumCuInWidth;
86  Int   m_iCuWidth;             ///< Width of Coding Unit (CU)
87  Int   m_iCuHeight;            ///< Height of Coding Unit (CU)
88#endif
89
90#if NH_3D_VSO
91  Void  xSetPels( Pel* piPelSource , Int iSourceStride, Int iWidth, Int iHeight, Pel iVal );
92#endif
93
94public:
95               TComPicYuv         ();
96  virtual     ~TComPicYuv         ();
97
98  // ------------------------------------------------------------------------------------------------
99  //  Memory management
100  // ------------------------------------------------------------------------------------------------
101
102  Void          create            (const Int iPicWidth,
103                                   const Int iPicHeight,
104                                   const ChromaFormat chromaFormatIDC,
105                                   const UInt uiMaxCUWidth,  ///< used for generating offsets to CUs. Can use iPicWidth if no offsets are required
106                                   const UInt uiMaxCUHeight, ///< used for generating offsets to CUs. Can use iPicHeight if no offsets are required
107                                   const UInt uiMaxCUDepth,  ///< used for generating offsets to CUs. Can use 0 if no offsets are required
108                                   const Bool bUseMargin);   ///< if true, then a margin of uiMaxCUWidth+16 and uiMaxCUHeight+16 is created around the image.
109
110  Void          destroy           ();
111
112  // The following have been removed - Use CHROMA_400 in the above function call.
113  //Void  createLuma  ( Int iPicWidth, Int iPicHeight, UInt uiMaxCUWidth, UInt uiMaxCUHeight, UInt uhMaxCUDepth );
114  //Void  destroyLuma ();
115
116  // ------------------------------------------------------------------------------------------------
117  //  Get information of picture
118  // ------------------------------------------------------------------------------------------------
119
120  Int           getWidth          (const ComponentID id) const { return  m_iPicWidth >> getComponentScaleX(id);   }
121  Int           getHeight         (const ComponentID id) const { return  m_iPicHeight >> getComponentScaleY(id);  }
122  ChromaFormat  getChromaFormat   ()                     const { return m_chromaFormatIDC; }
123  UInt          getNumberValidComponents() const { return ::getNumberValidComponents(m_chromaFormatIDC); }
124
125  Int           getStride         (const ComponentID id) const { return ((m_iPicWidth     ) + (m_iMarginX  <<1)) >> getComponentScaleX(id); }
126  Int           getTotalHeight    (const ComponentID id) const { return ((m_iPicHeight    ) + (m_iMarginY  <<1)) >> getComponentScaleY(id); }
127
128  Int           getMarginX        (const ComponentID id) const { return m_iMarginX >> getComponentScaleX(id);  }
129  Int           getMarginY        (const ComponentID id) const { return m_iMarginY >> getComponentScaleY(id);  }
130
131  // ------------------------------------------------------------------------------------------------
132  //  Access function for picture buffer
133  // ------------------------------------------------------------------------------------------------
134
135  //  Access starting position of picture buffer with margin
136  Pel*          getBuf            (const ComponentID ch)       { return  m_apiPicBuf[ch];   }
137
138  //  Access starting position of original picture
139  Pel*          getAddr           (const ComponentID ch)       { return  m_piPicOrg[ch];   }
140  const Pel*    getAddr           (const ComponentID ch) const { return  m_piPicOrg[ch];   }
141
142  //  Access starting position of original picture for specific coding unit (CU) or partition unit (PU)
143  Pel*          getAddr           (const ComponentID ch, const Int ctuRSAddr )       { return m_piPicOrg[ch] + m_ctuOffsetInBuffer[ch==0?0:1][ ctuRSAddr ]; }
144  const Pel*    getAddr           (const ComponentID ch, const Int ctuRSAddr ) const { return m_piPicOrg[ch] + m_ctuOffsetInBuffer[ch==0?0:1][ ctuRSAddr ]; }
145  Pel*          getAddr           (const ComponentID ch, const Int ctuRSAddr, const Int uiAbsZorderIdx )
146                                     { return m_piPicOrg[ch] + m_ctuOffsetInBuffer[ch==0?0:1][ctuRSAddr] + m_subCuOffsetInBuffer[ch==0?0:1][g_auiZscanToRaster[uiAbsZorderIdx]]; }
147  const Pel*    getAddr           (const ComponentID ch, const Int ctuRSAddr, const Int uiAbsZorderIdx ) const
148                                     { return m_piPicOrg[ch] + m_ctuOffsetInBuffer[ch==0?0:1][ctuRSAddr] + m_subCuOffsetInBuffer[ch==0?0:1][g_auiZscanToRaster[uiAbsZorderIdx]]; }
149
150  UInt          getComponentScaleX(const ComponentID id) const { return ::getComponentScaleX(id, m_chromaFormatIDC); }
151  UInt          getComponentScaleY(const ComponentID id) const { return ::getComponentScaleY(id, m_chromaFormatIDC); }
152
153  // ------------------------------------------------------------------------------------------------
154  //  Miscellaneous
155  // ------------------------------------------------------------------------------------------------
156
157  //  Copy function to picture
158  Void          copyToPic         ( TComPicYuv*  pcPicYuvDst ) const ;
159
160  //  Extend function of picture buffer
161  Void          extendPicBorder   ();
162
163  //  Dump picture
164  Void          dump              (const Char* pFileName, const BitDepths &bitDepths, Bool bAdd = false) const ;
165
166  // Set border extension flag
167  Void          setBorderExtension(Bool b) { m_bIsBorderExtended = b; }
168#if NH_MV
169  Bool          getBorderExtension( )     { return m_bIsBorderExtended; }
170#endif
171#if NH_3D
172  // Set Function
173  Void  setLumaTo    ( Pel pVal ); 
174  Void  setChromaTo  ( Pel pVal ); 
175#if NH_3D_IV_MERGE
176  // sample to block and block to sample conversion
177  Void  getTopLeftSamplePos( Int iCuAddr, Int iAbsZorderIdx, Int& riX, Int& riY );
178  Void  getCUAddrAndPartIdx( Int iX, Int iY, Int& riCuAddr, Int& riAbsZorderIdx );
179#endif
180#endif
181
182};// END CLASS DEFINITION TComPicYuv
183
184
185// These functions now return the length of the digest strings.
186UInt calcChecksum(const TComPicYuv& pic, TComPictureHash &digest, const BitDepths &bitDepths);
187UInt calcCRC     (const TComPicYuv& pic, TComPictureHash &digest, const BitDepths &bitDepths);
188UInt calcMD5     (const TComPicYuv& pic, TComPictureHash &digest, const BitDepths &bitDepths);
189std::string hashToString(const TComPictureHash &digest, Int numChar);
190//! \}
191
192#endif // __TCOMPICYUV__
Note: See TracBrowser for help on using the repository browser.