Changeset 1260 in SHVCSoftware


Ignore:
Timestamp:
14 Jul 2015, 03:24:13 (10 years ago)
Author:
seregin
Message:

port rev 4257

Location:
branches/SHM-dev/source
Files:
33 edited

Legend:

Unmodified
Added
Removed

  • branches/SHM-dev/source/App/TAppDecoder/TAppDecTop.cpp

    r1259 r1260  
    694694
    695695/** \param pcListPic list of pictures to be written to file
     696    \param tId       temporal sub-layer ID
    696697    \todo            DYN_REF_FREE should be revised
    697698 */

  • branches/SHM-dev/source/App/TAppEncoder/TAppEncTop.cpp

    r1259 r1260  
    23242324}
    23252325
    2326 /** \param iNumEncoded  number of encoded frames
     2326/**
     2327  Write access units to output file.
     2328  \param bitstreamFile  target bitstream file
     2329  \param iNumEncoded    number of encoded frames
     2330  \param accessUnits    list of access units to be written
    23272331 */
    23282332Void TAppEncTop::xWriteOutput(std::ostream& bitstreamFile, Int iNumEncoded, const std::list<AccessUnit>& accessUnits)

  • branches/SHM-dev/source/App/utils/BitrateTargeting/GuessLambdaModifiers.h

    r1246 r1260  
    44 * granted under this license.
    55 *
    6  * Copyright (c) 2010-2014, ITU/ISO/IEC
     6 * Copyright (c) 2010-2015, ITU/ISO/IEC
    77 * All rights reserved.
    88 *
    … …  
    9494
    9595/// Performs interpolation/extrapolation to guess a single Lambda-modifier
    96 /// \param target The target bitrate value that this Lambda-modifier is trying to reach
     96/// \param targetBitrate The target bitrate value that this Lambda-modifier is trying to reach
    9797/// \param point1 One of the two previously tried points where first is the Lambda-modifier and second is the obtained bitrate
    9898/// \param point2 One of the two previously tried points where first is the Lambda-modifier and second is the obtained bitrate
    … …  
    134134/// \param o The output stream to write the guessed Lambda-modifiers to
    135135/// \param initialAdjustmentParameterIstream The input stream that contains the initial adjustment parameter
    136 /// \param targetIstream The input stream that contains the target bitrates
     136/// \param targetsIstream The input stream that contains the target bitrates
    137137/// \param metaLogIstream The input stream that contains the meta-log
    138138/// \throw InitialAdjustmentParameterParseException if there is an error parsing the initial adjustment parameter

  • branches/SHM-dev/source/Lib/TLibCommon/ContextModel3DBuffer.cpp

    r1259 r1260  
    6060
    6161/**
    62  * Initialize 3D buffer with respect to slicetype, QP and given initial probability table
     62 * Initialize 3D buffer with respect to slice type, QP and given initial probability table
    6363 *
    64  * \param  eSliceType      slice type
    65  * \param  iQp             input QP value
    66  * \param  psCtxModel      given probability table
     64 * \param  sliceType      slice type
     65 * \param  qp             input QP value
     66 * \param  ctxModel       given probability table
    6767 */
    6868Void ContextModel3DBuffer::initBuffer( SliceType sliceType, Int qp, UChar* ctxModel )

  • branches/SHM-dev/source/Lib/TLibCommon/NAL.h

    r1259 r1260  
    107107
    108108  /**
    109    * convert the OutputNALUnit #nalu# into EBSP format by writing out
     109   * convert the OutputNALUnit nalu into EBSP format by writing out
    110110   * the NALUnit header, then the rbsp_bytes including any
    111111   * emulation_prevention_three_byte symbols.

  • branches/SHM-dev/source/Lib/TLibCommon/TComBitStream.cpp

    r1259 r1260  
    215215
    216216/**
    217  * read #uiNumberOfBits# from bitstream without updating the bitstream
    218  * state, storing the result in #ruiBits#.
    219  *
    220  * If reading #uiNumberOfBits# would overrun the bitstream buffer,
    221  * the bitsream is effectively padded with sufficient zero-bits to
     217 * read uiNumberOfBits from bitstream without updating the bitstream
     218 * state, storing the result in ruiBits.
     219 *
     220 * If reading uiNumberOfBits would overrun the bitstream buffer,
     221 * the bitstream is effectively padded with sufficient zero-bits to
    222222 * avoid the overrun.
    223223 */
    … …  
    344344
    345345/**
    346  - extract substream from the current bitstream
    347  .
    348  \param  pcBitstream  bitstream which contains substreams
     346 Extract substream from the current bitstream.
     347
    349348 \param  uiNumBits    number of bits to transfer
    350349 */

  • branches/SHM-dev/source/Lib/TLibCommon/TComBitStream.h

    r1259 r1260  
    176176public:
    177177  /**
    178    * Create a new bitstream reader object that reads from #buf#.  Ownership
    179    * of #buf# remains with the callee, although the constructed object
    180    * will hold a reference to #buf#
     178   * Create a new bitstream reader object that reads from buf.  Ownership
     179   * of buf remains with the callee, although the constructed object
     180   * will hold a reference to buf
    181181   */
    182182  TComInputBitstream(std::vector<uint8_t>* buf);

  • branches/SHM-dev/source/Lib/TLibCommon/TComDataCU.cpp

    r1259 r1260  
    15331533*\param   uiAbsPartIdx    partition index
    15341534*\param   uiIntraDirPred  pointer to the array for MPM storage
    1535 *\param   compID          color component ID
     1535*\param   compID          colour component ID
    15361536*\param   piMode          it is set with MPM mode in case both MPM are equal. It is used to restrict RD search at encode side.
    15371537*\returns Number of MPM
    … …  
    17261726
    17271727/** Sets a coded block flag for all sub-partitions of a partition
    1728  * \param uiCbf The value of the coded block flag to be set
    1729  * \param eTType
     1728 * \param uiCbf          The value of the coded block flag to be set
     1729 * \param compID
    17301730 * \param uiAbsPartIdx
    17311731 * \param uiPartIdx
    17321732 * \param uiDepth
    1733  * \returns Void
    17341733 */
    17351734Void TComDataCU::setCbfSubParts ( UInt uiCbf, ComponentID compID, UInt uiAbsPartIdx, UInt uiPartIdx, UInt uiDepth )

  • branches/SHM-dev/source/Lib/TLibCommon/TComInterpolationFilter.cpp

    r1259 r1260  
    288288 *
    289289 * \tparam N          Number of taps
     290 * \param  bitDepth   Bit depth
    290291 * \param  src        Pointer to source samples
    291292 * \param  srcStride  Stride of source samples
    … …  
    326327 * \brief Filter a block of Luma/Chroma samples (horizontal)
    327328 *
     329 * \param  compID     Chroma component ID
    328330 * \param  src        Pointer to source samples
    329331 * \param  srcStride  Stride of source samples
    … …  
    334336 * \param  frac       Fractional sample offset
    335337 * \param  isLast     Flag indicating whether it is the last filtering operation
     338 * \param  fmt        Chroma format
    336339 */
    337340Void TComInterpolationFilter::filterHor(const ComponentID compID, Pel *src, Int srcStride, Pel *dst, Int dstStride, Int width, Int height, Int frac, Bool isLast, const ChromaFormat fmt )
    … …  
    358361 * \brief Filter a block of Luma/Chroma samples (vertical)
    359362 *
     363 * \param  compID     Colour component ID
    360364 * \param  src        Pointer to source samples
    361365 * \param  srcStride  Stride of source samples
    … …  
    367371 * \param  isFirst    Flag indicating whether it is the first filtering operation
    368372 * \param  isLast     Flag indicating whether it is the last filtering operation
     373 * \param  fmt        Chroma format
    369374 */
    370375Void TComInterpolationFilter::filterVer(const ComponentID compID, Pel *src, Int srcStride, Pel *dst, Int dstStride, Int width, Int height, Int frac, Bool isFirst, Bool isLast, const ChromaFormat fmt )

  • branches/SHM-dev/source/Lib/TLibCommon/TComLoopFilter.cpp

    r1259 r1260  
    161161
    162162/**
    163  - Deblocking filter process in CU-based (the same function as conventional's)
    164  .
    165  \param Edge          the direction of the edge in block boundary (horizonta/vertical), which is added newly
     163 Deblocking filter process in CU-based (the same function as conventional's)
     164
     165 \param pcCU             Pointer to CTU/CU structure
     166 \param uiAbsZorderIdx   Position in CU
     167 \param uiDepth          Depth in CU
     168 \param edgeDir          the direction of the edge in block boundary (horizontal/vertical), which is added newly
    166169*/
    167170Void TComLoopFilter::xDeblockCU( TComDataCU* pcCU, UInt uiAbsZorderIdx, UInt uiDepth, DeblockEdgeDir edgeDir )

  • branches/SHM-dev/source/Lib/TLibCommon/TComPattern.cpp

    r1259 r1260  
    7070// ====================================================================================================================
    7171
    72 /** \param  piTexture     pixel data
     72/**
     73 \param  piTexture     pixel data
    7374 \param  iRoiWidth     pattern width
    7475 \param  iRoiHeight    pattern height
    7576 \param  iStride       buffer stride
    76  \param  iOffsetLeft   neighbour offset (left)
    77  \param  iOffsetRight  neighbour offset (right)
    78  \param  iOffsetAbove  neighbour offset (above)
    79  \param  iOffsetBottom neighbour offset (bottom)
    8077 */
    8178Void TComPatternParam::setPatternParamPel ( Pel* piTexture,
    … …  
    524521}
    525522
    526 /** Get pointer to reference samples for intra prediction
    527  * \param uiDirMode   prediction mode index
    528  * \param log2BlkSize size of block (2 = 4x4, 3 = 8x8, 4 = 16x16, 5 = 32x32, 6 = 64x64)
    529  * \param piAdiBuf    pointer to unfiltered reference samples
    530  * \return            pointer to (possibly filtered) reference samples
    531  *
    532  * The prediction mode index is used to determine whether a smoothed reference sample buffer is returned.
    533  */
    534 
    535523Bool TComPrediction::filteringIntraReferenceSamples(const ComponentID compID, UInt uiDirMode, UInt uiTuChWidth, UInt uiTuChHeight, const ChromaFormat chFmt, const Bool intraReferenceSmoothingDisabled)
    536524{

  • branches/SHM-dev/source/Lib/TLibCommon/TComPrediction.cpp

    r1259 r1260  
    224224
    225225/** Function for deriving the simplified angular intra predictions.
    226  * \param pSrc pointer to reconstructed sample array
    227  * \param srcStride the stride of the reconstructed sample array
    228  * \param rpDst reference to pointer for the prediction sample array
    229  * \param dstStride the stride of the prediction sample array
    230  * \param width the width of the block
    231  * \param height the height of the block
    232  * \param dirMode the intra prediction mode index
    233  * \param blkAboveAvailable boolean indication if the block above is available
    234  * \param blkLeftAvailable boolean indication if the block to the left is available
     226 * \param bitDepth           bit depth
     227 * \param pSrc               pointer to reconstructed sample array
     228 * \param srcStride          the stride of the reconstructed sample array
     229 * \param pTrueDst           reference to pointer for the prediction sample array
     230 * \param dstStrideTrue      the stride of the prediction sample array
     231 * \param uiWidth            the width of the block
     232 * \param uiHeight           the height of the block
     233 * \param channelType        type of pel array (luma/chroma)
     234 * \param format             chroma format
     235 * \param dirMode            the intra prediction mode index
     236 * \param blkAboveAvailable  boolean indication if the block above is available
     237 * \param blkLeftAvailable   boolean indication if the block to the left is available
     238 * \param bEnableEdgeFilters indication whether to enable edge filters
    235239 *
    236240 * This function derives the prediction samples for the angular mode based on the prediction direction indicated by
    … …  
    491495}
    492496
    493 /** Function for checking identical motion.
    494  * \param TComDataCU* pcCU
    495  * \param UInt PartAddr
     497/** Check for identical motion in both motion vector direction of a bi-directional predicted CU
     498  * \returns true, if motion vectors and reference pictures match
    496499 */
    497500Bool TComPrediction::xCheckIdenticalMotion ( TComDataCU* pcCU, UInt PartAddr )
    … …  
    669672 * \brief Generate motion-compensated block
    670673 *
     674 * \param compID   Colour component ID
    671675 * \param cu       Pointer to current CU
    672676 * \param refPic   Pointer to reference picture
    … …  
    756760
    757761/** Function for deriving planar intra prediction.
    758  * \param pSrc pointer to reconstructed sample array
    759  * \param srcStride the stride of the reconstructed sample array
    760  * \param rpDst reference to pointer for the prediction sample array
    761  * \param dstStride the stride of the prediction sample array
    762  * \param width the width of the block
    763  * \param height the height of the block
     762 * \param pSrc        pointer to reconstructed sample array
     763 * \param srcStride   the stride of the reconstructed sample array
     764 * \param rpDst       reference to pointer for the prediction sample array
     765 * \param dstStride   the stride of the prediction sample array
     766 * \param width       the width of the block
     767 * \param height      the height of the block
     768 * \param channelType type of pel array (luma, chroma)
     769 * \param format      chroma format
    764770 *
    765771 * This function derives the prediction samples for planar mode (intra coding).
    … …  
    821827 * \param pSrc pointer to reconstructed sample array
    822828 * \param iSrcStride the stride of the reconstructed sample array
    823  * \param rpDst reference to pointer for the prediction sample array
     829 * \param pDst reference to pointer for the prediction sample array
    824830 * \param iDstStride the stride of the prediction sample array
    825831 * \param iWidth the width of the block
    826832 * \param iHeight the height of the block
     833 * \param channelType type of pel array (luma, chroma)
    827834 *
    828835 * This function performs filtering left and top edges of the prediction samples for DC mode (intra coding).

  • branches/SHM-dev/source/Lib/TLibCommon/TComSampleAdaptiveOffset.cpp

    r1259 r1260  
    649649/** PCM LF disable process.
    650650 * \param pcPic picture (TComPic) pointer
    651  * \returns Void
    652651 *
    653652 * \note Replace filtered sample values of PCM mode blocks with the transmitted and reconstructed ones.
    … …  
    660659/** Picture-level PCM restoration.
    661660 * \param pcPic picture (TComPic) pointer
    662  * \returns Void
    663661 */
    664662Void TComSampleAdaptiveOffset::xPCMRestoration(TComPic* pcPic)
    … …  
    678676
    679677/** PCM CU restoration.
    680  * \param pcCU pointer to current CU
    681  * \param uiAbsPartIdx part index
    682  * \param uiDepth CU depth
    683  * \returns Void
     678 * \param pcCU            pointer to current CU
     679 * \param uiAbsZorderIdx  part index
     680 * \param uiDepth         CU depth
    684681 */
    685682Void TComSampleAdaptiveOffset::xPCMCURestoration ( TComDataCU* pcCU, UInt uiAbsZorderIdx, UInt uiDepth )
    … …  
    720717
    721718/** PCM sample restoration.
    722  * \param pcCU pointer to current CU
    723  * \param uiAbsPartIdx part index
    724  * \param uiDepth CU depth
    725  * \param ttText texture component type
    726  * \returns Void
     719 * \param pcCU           pointer to current CU
     720 * \param uiAbsZorderIdx part index
     721 * \param uiDepth        CU depth
     722 * \param compID         texture component type
    727723 */
    728724Void TComSampleAdaptiveOffset::xPCMSampleRestoration (TComDataCU* pcCU, UInt uiAbsZorderIdx, UInt uiDepth, const ComponentID compID)

  • branches/SHM-dev/source/Lib/TLibCommon/TComSampleAdaptiveOffset.h

    r1259 r1260  
    8686  Void xPCMRestoration(TComPic* pcPic);
    8787  Void xPCMCURestoration ( TComDataCU* pcCU, UInt uiAbsZorderIdx, UInt uiDepth );
    88   Void xPCMSampleRestoration (TComDataCU* pcCU, UInt uiAbsZorderIdx, UInt uiDepth, ComponentID component);
     88  Void xPCMSampleRestoration (TComDataCU* pcCU, UInt uiAbsZorderIdx, UInt uiDepth, const ComponentID compID);
    8989protected:
    9090  UInt m_offsetStepLog2[MAX_NUM_COMPONENT]; //offset step

  • branches/SHM-dev/source/Lib/TLibCommon/TComSlice.cpp

    r1259 r1260  
    18211821}
    18221822
    1823 /** get AC and DC values for weighted pred
    1824  * \param *wp
    1825  * \returns Void
    1826  */
     1823//! get AC and DC values for weighted pred
    18271824Void  TComSlice::getWpAcDcParam(WPACDCParam *&wp)
    18281825{
    … …  
    18301827}
    18311828
    1832 /** init AC and DC values for weighted pred
    1833  * \returns Void
    1834  */
     1829//! init AC and DC values for weighted pred
    18351830Void  TComSlice::initWpAcDcParam()
    18361831{
    … …  
    18421837}
    18431838
    1844 /** get WP tables for weighted pred
    1845  * \param RefPicList
    1846  * \param iRefIdx
    1847  * \param *&WPScalingParam
    1848  * \returns Void
    1849  */
     1839//! get tables for weighted prediction
    18501840Void  TComSlice::getWpScaling( RefPicList e, Int iRefIdx, WPScalingParam *&wp )
    18511841{
    … …  
    18541844}
    18551845
    1856 /** reset Default WP tables settings : no weight.
    1857  * \param WPScalingParam
    1858  * \returns Void
    1859  */
     1846//! reset Default WP tables settings : no weight.
    18601847Void  TComSlice::resetWpScaling()
    18611848{
    … …  
    18771864}
    18781865
    1879 /** init WP table
    1880  * \returns Void
    1881  */
     1866//! init WP table
    18821867Void  TComSlice::initWpScaling(const TComSPS *sps)
    18831868{
    … …  
    23972382}
    23982383
    2399 /** set the reference idc value at uiBufferNum entry to the value of iRefIdc
    2400  * \param uiBufferNum
    2401  * \param iRefIdc
    2402  * \returns Void
    2403  */
     2384//! set the reference idc value at uiBufferNum entry to the value of iRefIdc
    24042385Void TComReferencePictureSet::setRefIdc(Int bufferNum, Int refIdc)
    24052386{
    … …  
    24072388}
    24082389
    2409 /** get the reference idc value at uiBufferNum
    2410  * \param uiBufferNum
    2411  * \returns Int
    2412  */
     2390//! get the reference idc value at uiBufferNum
    24132391Int  TComReferencePictureSet::getRefIdc(Int bufferNum) const
    24142392{
    … …  
    25332511
    25342512/** get scaling matrix from RefMatrixID
    2535  * \param sizeId size index
    2536  * \param Index of input matrix
    2537  * \param Index of reference matrix
     2513 * \param sizeId    size index
     2514 * \param listId    index of input matrix
     2515 * \param refListId index of reference matrix
    25382516 */
    25392517Void TComScalingList::processRefMatrix( UInt sizeId, UInt listId , UInt refListId )
    … …  
    27712749/** process of default matrix
    27722750 * \param sizeId size index
    2773  * \param Index of input matrix
     2751 * \param listId index of input matrix
    27742752 */
    27752753Void TComScalingList::processDefaultMatrix(UInt sizeId, UInt listId)

  • branches/SHM-dev/source/Lib/TLibCommon/TComTrQuant.cpp

    r1259 r1260  
    392392 *  \param dst   output data (transform coefficients)
    393393 *  \param shift specifies right shift after 1D transform
     394 *  \param line
    394395 */
    395396Void partialButterfly4(TCoeff *src, TCoeff *dst, Int shift, Int line)
    … …  
    477478 *  \param dst   output data (residual)
    478479 *  \param shift specifies right shift after 1D transform
     480 *  \param line
     481 *  \param outputMinimum  minimum for clipping
     482 *  \param outputMaximum  maximum for clipping
    479483 */
    480484Void partialButterflyInverse4(TCoeff *src, TCoeff *dst, Int shift, Int line, const TCoeff outputMinimum, const TCoeff outputMaximum)
    … …  
    507511 *  \param dst   output data (transform coefficients)
    508512 *  \param shift specifies right shift after 1D transform
     513 *  \param line
    509514 */
    510515Void partialButterfly8(TCoeff *src, TCoeff *dst, Int shift, Int line)
    … …  
    548553 *  \param dst   output data (residual)
    549554 *  \param shift specifies right shift after 1D transform
     555 *  \param line
     556 *  \param outputMinimum  minimum for clipping
     557 *  \param outputMaximum  maximum for clipping
    550558 */
    551559Void partialButterflyInverse8(TCoeff *src, TCoeff *dst, Int shift, Int line, const TCoeff outputMinimum, const TCoeff outputMaximum)
    … …  
    589597 *  \param dst   output data (transform coefficients)
    590598 *  \param shift specifies right shift after 1D transform
     599 *  \param line
    591600 */
    592601Void partialButterfly16(TCoeff *src, TCoeff *dst, Int shift, Int line)
    … …  
    644653
    645654/** 16x16 inverse transform implemented using partial butterfly structure (1D)
    646  *  \param src   input data (transform coefficients)
    647  *  \param dst   output data (residual)
    648  *  \param shift specifies right shift after 1D transform
     655 *  \param src            input data (transform coefficients)
     656 *  \param dst            output data (residual)
     657 *  \param shift          specifies right shift after 1D transform
     658 *  \param line
     659 *  \param outputMinimum  minimum for clipping
     660 *  \param outputMaximum  maximum for clipping
    649661 */
    650662Void partialButterflyInverse16(TCoeff *src, TCoeff *dst, Int shift, Int line, const TCoeff outputMinimum, const TCoeff outputMaximum)
    … …  
    701713 *  \param dst   output data (transform coefficients)
    702714 *  \param shift specifies right shift after 1D transform
     715 *  \param line
    703716 */
    704717Void partialButterfly32(TCoeff *src, TCoeff *dst, Int shift, Int line)
    … …  
    774787 *  \param dst   output data (residual)
    775788 *  \param shift specifies right shift after 1D transform
     789 *  \param line
     790 *  \param outputMinimum  minimum for clipping
     791 *  \param outputMaximum  maximum for clipping
    776792 */
    777793Void partialButterflyInverse32(TCoeff *src, TCoeff *dst, Int shift, Int line, const TCoeff outputMinimum, const TCoeff outputMaximum)
    … …  
    841857
    842858/** MxN forward transform (2D)
    843 *  \param block input data (residual)
    844 *  \param coeff output data (transform coefficients)
    845 *  \param iWidth input data (width of transform)
    846 *  \param iHeight input data (height of transform)
     859*  \param bitDepth          [in]  bit depth
     860*  \param block             [in]  residual block
     861*  \param coeff             [out] transform coefficients
     862*  \param iWidth            [in]  width of transform
     863*  \param iHeight           [in]  height of transform
     864*  \param useDST            [in]
     865*  \param maxTrDynamicRange [in]
     866
    847867*/
    848868Void xTrMxN(Int bitDepth, TCoeff *block, TCoeff *coeff, Int iWidth, Int iHeight, Bool useDST, const Int maxTrDynamicRange)
    … …  
    905925
    906926/** MxN inverse transform (2D)
    907 *  \param coeff input data (transform coefficients)
    908 *  \param block output data (residual)
    909 *  \param iWidth input data (width of transform)
    910 *  \param iHeight input data (height of transform)
     927*  \param bitDepth          [in]  bit depth
     928*  \param coeff             [in]  transform coefficients
     929*  \param block             [out] residual block
     930*  \param iWidth            [in]  width of transform
     931*  \param iHeight           [in]  height of transform
     932*  \param useDST            [in]
     933*  \param maxTrDynamicRange [in]
    911934*/
    912935Void xITrMxN(Int bitDepth, TCoeff *coeff, TCoeff *block, Int iWidth, Int iHeight, Bool useDST, const Int maxTrDynamicRange)
    … …  
    18321855
    18331856/** Wrapper function between HM interface and core NxN forward transform (2D)
     1857 *  \param compID colour component ID
     1858 *  \param useDST
    18341859 *  \param piBlkResi input data (residual)
     1860 *  \param uiStride stride of input residual data
    18351861 *  \param psCoeff output data (transform coefficients)
    1836  *  \param uiStride stride of input residual data
    1837  *  \param iSize transform size (iSize x iSize)
    1838  *  \param uiMode is Intra Prediction mode used in Mode-Dependent DCT/DST only
     1862 *  \param iWidth transform width
     1863 *  \param iHeight transform height
    18391864 */
    18401865Void TComTrQuant::xT( const ComponentID compID, Bool useDST, Pel* piBlkResi, UInt uiStride, TCoeff* psCoeff, Int iWidth, Int iHeight )
    … …  
    18651890
    18661891/** Wrapper function between HM interface and core NxN inverse transform (2D)
     1892 *  \param compID colour component ID
     1893 *  \param useDST
    18671894 *  \param plCoef input data (transform coefficients)
    18681895 *  \param pResidual output data (residual)
    18691896 *  \param uiStride stride of input residual data
    1870  *  \param iSize transform size (iSize x iSize)
    1871  *  \param uiMode is Intra Prediction mode used in Mode-Dependent DCT/DST only
     1897 *  \param iWidth transform width
     1898 *  \param iHeight transform height
    18721899 */
    18731900Void TComTrQuant::xIT( const ComponentID compID, Bool useDST, TCoeff* plCoef, Pel* pResidual, UInt uiStride, Int iWidth, Int iHeight )
    … …  
    19071934/** Wrapper function between HM interface and core 4x4 transform skipping
    19081935 *  \param piBlkResi input data (residual)
     1936 *  \param uiStride stride of input residual data
    19091937 *  \param psCoeff output data (transform coefficients)
    1910  *  \param uiStride stride of input residual data
    1911  *  \param iSize transform size (iSize x iSize)
     1938 *  \param rTu reference to transform data
     1939 *  \param component colour component
    19121940 */
    19131941Void TComTrQuant::xTransformSkip( Pel* piBlkResi, UInt uiStride, TCoeff* psCoeff, TComTU &rTu, const ComponentID component )
    … …  
    19551983 *  \param pResidual output data (residual)
    19561984 *  \param uiStride stride of input residual data
    1957  *  \param iSize transform size (iSize x iSize)
     1985 *  \param rTu reference to transform data
     1986 *  \param component colour component ID
    19581987 */
    19591988Void TComTrQuant::xITransformSkip( TCoeff* plCoef, Pel* pResidual, UInt uiStride, TComTU &rTu, const ComponentID component )
    … …  
    19992028
    20002029/** RDOQ with CABAC
    2001  * \param pcCU pointer to coding unit structure
     2030 * \param rTu reference to transform data
    20022031 * \param plSrcCoeff pointer to input buffer
    20032032 * \param piDstCoeff reference to pointer to output buffer
    2004  * \param uiWidth block width
    2005  * \param uiHeight block height
     2033 * \param piArlDstCoeff
    20062034 * \param uiAbsSum reference to absolute sum of quantized transform coefficient
    2007  * \param eTType plane type / luminance or chrominance
    2008  * \param uiAbsPartIdx absolute partition index
    2009  * \returns Void
     2035 * \param compID colour component ID
     2036 * \param cQP reference to quantization parameters
     2037
    20102038 * Rate distortion optimized quantization for entropy
    20112039 * coding engines using probability models like CABAC
    … …  
    25582586 * \param uiCGPosX column of current coefficient group
    25592587 * \param uiCGPosY row of current coefficient group
    2560  * \param width width of the block
    2561  * \param height height of the block
     2588 * \param widthInGroups width of the block
     2589 * \param heightInGroups height of the block
    25622590 * \returns pattern for current coefficient group
    25632591 */
    … …  
    25902618/** Context derivation process of coeff_abs_significant_flag
    25912619 * \param patternSigCtx pattern for current coefficient group
    2592  * \param codingParameters coding parmeters for the TU (includes the scan)
     2620 * \param codingParameters coding parameters for the TU (includes the scan)
    25932621 * \param scanPosition current position in scan order
    25942622 * \param log2BlockWidth log2 width of the block
    25952623 * \param log2BlockHeight log2 height of the block
    2596  * \param ChannelType channel type (CHANNEL_TYPE_LUMA/CHROMA)
     2624 * \param chanType channel type (CHANNEL_TYPE_LUMA/CHROMA)
    25972625 * \returns ctxInc for current scan position
    25982626 */
    … …  
    27062734 * \param ui16CtxNumAbs current ctxInc for coeff_abs_level_greater2 (remaining bins of coeff_abs_level_minus1 in AVC)
    27072735 * \param ui16AbsGoRice current Rice parameter for coeff_abs_level_minus3
     2736 * \param c1Idx
     2737 * \param c2Idx
    27082738 * \param iQBits quantization step size
    2709  * \param dTemp correction factor
     2739 * \param errorScale
    27102740 * \param bLast indicates if the coefficient is the last significant
     2741 * \param useLimitedPrefixLength
     2742 * \param channelType  texture channel type (luma/chroma)
    27112743 * \returns best quantized transform level for given scan position
    27122744 * This method calculates the best quantized transform level for a given scan position.
    … …  
    27752807 * \param ui16CtxNumAbs current ctxInc for coeff_abs_level_greater2 (remaining bins of coeff_abs_level_minus1 in AVC)
    27762808 * \param ui16AbsGoRice Rice parameter for coeff_abs_level_minus3
     2809 * \param c1Idx
     2810 * \param c2Idx
     2811 * \param useLimitedPrefixLength
     2812 * \param channelType  texture channel type (luma/chroma)
    27772813 * \returns cost of given absolute transform level
    27782814 */
    … …  
    28622898 * \param uiPosX X coordinate of the last significant coefficient
    28632899 * \param uiPosY Y coordinate of the last significant coefficient
     2900 * \param component colour component ID
    28642901 * \returns cost of last significant coefficient
    28652902 */
    … …  
    28872924}
    28882925
    2889  /** Calculates the cost for specific absolute transform level
    2890  * \param uiAbsLevel scaled quantized level
    2891  * \param ui16CtxNumOne current ctxInc for coeff_abs_level_greater1 (1st bin of coeff_abs_level_minus1 in AVC)
    2892  * \param ui16CtxNumAbs current ctxInc for coeff_abs_level_greater2 (remaining bins of coeff_abs_level_minus1 in AVC)
    2893  * \param ui16CtxBase current global offset for coeff_abs_level_greater1 and coeff_abs_level_greater2
    2894  * \returns cost of given absolute transform level
    2895  */
    28962926__inline Double TComTrQuant::xGetRateSigCoef  ( UShort                          uiSignificance,
    28972927                                                UShort                          ui16CtxNumSig ) const
    … …  
    29192949/** Context derivation process of coeff_abs_significant_flag
    29202950 * \param uiSigCoeffGroupFlag significance map of L1
    2921  * \param uiBlkX column of current scan position
    2922  * \param uiBlkY row of current scan position
    2923  * \param uiLog2BlkSize log2 value of block size
     2951 * \param uiCGPosX column of current scan position
     2952 * \param uiCGPosY row of current scan position
     2953 * \param widthInGroups width of the block
     2954 * \param heightInGroups height of the block
    29242955 * \returns ctxInc for current scan position
    29252956 */
    … …  
    29472978
    29482979/** set quantized matrix coefficient for encode
    2949  * \param scalingList quantaized matrix address
     2980 * \param scalingList quantized matrix address
     2981 * \param format      chroma format
    29502982 */
    29512983Void TComTrQuant::setScalingList(TComScalingList *scalingList, const ChromaFormat format)
    … …  
    29683000}
    29693001/** set quantized matrix coefficient for decode
    2970  * \param scalingList quantaized matrix address
     3002 * \param scalingList quantized matrix address
     3003 * \param format      chroma format
    29713004 */
    29723005Void TComTrQuant::setScalingListDec(const TComScalingList &scalingList, const ChromaFormat format)
    … …  
    29883021/** set error scale coefficients
    29893022 * \param list List ID
    2990  * \param uiSize Size
    2991  * \param uiQP Quantization parameter
     3023 * \param size Size
     3024 * \param qp  Quantization parameter
    29923025 */
    29933026Void TComTrQuant::setErrScaleCoeff(UInt list, UInt size, Int qp)
    … …  
    30163049
    30173050/** set quantized matrix coefficient for encode
    3018  * \param scalingList quantaized matrix address
     3051 * \param scalingList quantized matrix address
    30193052 * \param listId List index
    30203053 * \param sizeId size index
    3021  * \param uiQP Quantization parameter
     3054 * \param qp Quantization parameter
     3055 * \param format chroma format
    30223056 */
    30233057Void TComTrQuant::xSetScalingListEnc(TComScalingList *scalingList, UInt listId, UInt sizeId, Int qp, const ChromaFormat format)
    … …  
    30423076/** set quantized matrix coefficient for decode
    30433077 * \param scalingList quantaized matrix address
    3044  * \param list List index
    3045  * \param size size index
    3046  * \param uiQP Quantization parameter
     3078 * \param listId List index
     3079 * \param sizeId size index
     3080 * \param qp Quantization parameter
     3081 * \param format chroma format
    30473082 */
    30483083Void TComTrQuant::xSetScalingListDec(const TComScalingList &scalingList, UInt listId, UInt sizeId, Int qp, const ChromaFormat format)
    … …  
    30883123/** set flat matrix value to quantized coefficient
    30893124 * \param list List ID
    3090  * \param uiQP Quantization parameter
    3091  * \param uiSize Size
     3125 * \param size size index
     3126 * \param qp Quantization parameter
     3127 * \param format chroma format
    30923128 */
    30933129Void TComTrQuant::xsetFlatScalingList(UInt list, UInt size, Int qp, const ChromaFormat format)

  • branches/SHM-dev/source/Lib/TLibCommon/TComWeightPrediction.cpp

    r1259 r1260  
    6262
    6363
    64 /** weighted averaging for bi-pred
    65  * \param TComYuv* pcYuvSrc0
    66  * \param TComYuv* pcYuvSrc1
    67  * \param iPartUnitIdx
    68  * \param iWidth
    69  * \param iHeight
    70  * \param WPScalingParam *wp0
    71  * \param WPScalingParam *wp1
    72  * \param TComYuv* rpcYuvDst
    73  * \returns Void
    74  */
     64//! weighted averaging for bi-pred
    7565Void TComWeightPrediction::addWeightBi( const TComYuv              *pcYuvSrc0,
    7666                                        const TComYuv              *pcYuvSrc1,
    … …  
    137127
    138128
    139 /** weighted averaging for uni-pred
    140  * \param TComYuv* pcYuvSrc0
    141  * \param iPartUnitIdx
    142  * \param iWidth
    143  * \param iHeight
    144  * \param WPScalingParam *wp0
    145  * \param TComYuv* rpcYuvDst
    146  * \returns Void
    147  */
     129//! weighted averaging for uni-pred
    148130Void TComWeightPrediction::addWeightUni( const TComYuv        *const pcYuvSrc0,
    149131                                         const UInt                  iPartUnitIdx,
    … …  
    200182//  getWpScaling()
    201183//=======================================================
    202 /** derivation of wp tables
    203  * \param TComDataCU* pcCU
    204  * \param iRefIdx0
    205  * \param iRefIdx1
    206  * \param WPScalingParam *&wp0
    207  * \param WPScalingParam *&wp1
    208  * \param ibdi
    209  * \returns Void
    210  */
     184//! derivation of wp tables
    211185Void TComWeightPrediction::getWpScaling(       TComDataCU *const pcCU,
    212186                                         const Int               iRefIdx0,
    … …  
    287261
    288262
    289 /** weighted prediction for bi-pred
    290  * \param TComDataCU* pcCU
    291  * \param TComYuv* pcYuvSrc0
    292  * \param TComYuv* pcYuvSrc1
    293  * \param iRefIdx0
    294  * \param iRefIdx1
    295  * \param uiPartIdx
    296  * \param iWidth
    297  * \param iHeight
    298  * \param TComYuv* rpcYuvDst
    299  * \returns Void
    300  */
     263//! weighted prediction for bi-pred
    301264Void TComWeightPrediction::xWeightedPredictionBi(       TComDataCU *const pcCU,
    302265                                                  const TComYuv    *const pcYuvSrc0,
    … …  
    335298
    336299
    337 /** weighted prediction for uni-pred
    338  * \param TComDataCU* pcCU
    339  * \param TComYuv* pcYuvSrc
    340  * \param uiPartAddr
    341  * \param iWidth
    342  * \param iHeight
    343  * \param eRefPicList
    344  * \param TComYuv* pcYuvPred
    345  * \param iPartIdx
    346  * \param iRefIdx
    347  * \returns Void
    348  */
     300//! weighted prediction for uni-pred
    349301Void TComWeightPrediction::xWeightedPredictionUni(       TComDataCU *const pcCU,
    350302                                                   const TComYuv    *const pcYuvSrc,

  • branches/SHM-dev/source/Lib/TLibDecoder/TDecCAVLC.cpp

    r1259 r1260  
    24082408// ====================================================================================================================
    24092409
    2410 /** parse explicit wp tables
    2411 * \param TComSlice* pcSlice
    2412 * \returns Void
    2413 */
     2410//! parse explicit wp tables
    24142411Void TDecCavlc::xParsePredWeightTable( TComSlice* pcSlice, const TComSPS *sps )
    24152412{

  • branches/SHM-dev/source/Lib/TLibDecoder/TDecCu.cpp

    r1259 r1260  
    9292
    9393/**
    94  \param    uiMaxDepth    total number of allowable depth
    95  \param    uiMaxWidth    largest CU width
    96  \param    uiMaxHeight   largest CU height
     94 \param    uiMaxDepth      total number of allowable depth
     95 \param    uiMaxWidth      largest CU width
     96 \param    uiMaxHeight     largest CU height
     97 \param    chromaFormatIDC chroma format
    9798 */
    9899Void TDecCu::create( UInt uiMaxDepth, UInt uiMaxWidth, UInt uiMaxHeight, ChromaFormat chromaFormatIDC )
    … …  
    146147// ====================================================================================================================
    147148
    148 /** \param    pcCU        pointer of CU data
    149  \param    ruiIsLast   last data?
     149/**
     150 Parse a CTU.
     151 \param    pCtu                      [in/out] pointer to CTU data structure
     152 \param    isLastCtuOfSliceSegment   [out]    true, if last CTU of the slice segment
    150153 */
    151154Void TDecCu::decodeCtu( TComDataCU* pCtu, Bool& isLastCtuOfSliceSegment )
    … …  
    169172}
    170173
    171 /** \param    pcCU        pointer of CU data
     174/**
     175 Decoding process for a CTU.
     176 \param    pCtu                      [in/out] pointer to CTU data structure
    172177 */
    173178Void TDecCu::decompressCtu( TComDataCU* pCtu )
    … …  
    180185// ====================================================================================================================
    181186
    182 /**decode end-of-slice flag
    183  * \param pcCU
    184  * \param uiAbsPartIdx
    185  * \param uiDepth
    186  * \returns Bool
    187  */
     187//! decode end-of-slice flag
    188188Bool TDecCu::xDecodeSliceEnd( TComDataCU* pcCU, UInt uiAbsPartIdx )
    189189{
    … …  
    202202}
    203203
    204 /** decode CU block recursively
    205  * \param pcCU
    206  * \param uiAbsPartIdx
    207  * \param uiDepth
    208  * \returns Void
    209  */
    210 
     204//! decode CU block recursively
    211205Void TDecCu::xDecodeCU( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth, Bool &isLastCtuOfSliceSegment)
    212206{
    … …  
    744738
    745739
    746 /** Function for deriving recontructed PU/CU chroma samples with QTree structure
    747  * \param pcCU pointer of current CU
    748  * \param uiTrDepth current tranform split depth
    749  * \param uiAbsPartIdx  part index
     740/** Function for deriving reconstructed PU/CU chroma samples with QTree structure
    750741 * \param pcRecoYuv pointer to reconstructed sample arrays
    751742 * \param pcPredYuv pointer to prediction sample arrays
    752743 * \param pcResiYuv pointer to residue sample arrays
     744 * \param chType    texture channel type (luma/chroma)
     745 * \param rTu       reference to transform data
    753746 *
    754  \ This function dervies recontructed PU/CU chroma samples with QTree recursive structure
     747 \ This function derives reconstructed PU/CU chroma samples with QTree recursive structure
    755748 */
    756749
    … …  
    824817 * \param uiWidth CU width
    825818 * \param uiHeight CU height
    826  * \param ttText texture component type
     819 * \param compID colour component ID
    827820 * \returns Void
    828821 */
    … …  
    866859
    867860/** Function for filling the PCM buffer of a CU using its reconstructed sample array
    868  * \param pcCU pointer to current CU
    869  * \param uiDepth CU Depth
    870  * \returns Void
     861 * \param pCU   pointer to current CU
     862 * \param depth CU Depth
    871863 */
    872864Void TDecCu::xFillPCMBuffer(TComDataCU* pCU, UInt depth)

  • branches/SHM-dev/source/Lib/TLibDecoder/TDecEntropy.cpp

    r1259 r1260  
    610610
    611611
    612 /** decode coefficients
    613  * \param pcCU
    614  * \param uiAbsPartIdx
    615  * \param uiDepth
    616  * \param uiWidth
    617  * \param uiHeight
    618  * \returns Void
    619  */
     612//! decode coefficients
    620613Void TDecEntropy::decodeCoeff( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth, Bool& bCodeDQP, Bool& isChromaQpAdjCoded )
    621614{

  • branches/SHM-dev/source/Lib/TLibDecoder/TDecSbac.cpp

    r1259 r1260  
    292292
    293293/** Parsing of coeff_abs_level_remaing
    294  * \param ruiSymbol reference to coeff_abs_level_remaing
    295  * \param ruiParam reference to parameter
    296  * \returns Void
     294 * \param rSymbol                 reference to coeff_abs_level_remaing
     295 * \param rParam                  reference to parameter
     296 * \param useLimitedPrefixLength
     297 * \param channelType
    297298 */
    298299#if RExt__DECODER_DEBUG_BIT_STATISTICS
    … …  
    11381139 * \param width  Block width
    11391140 * \param height Block height
    1140  * \param eTType plane type / luminance or chrominance
     1141 * \param component chroma compinent ID
    11411142 * \param uiScanIdx scan type (zig-zag, hor, ver)
    11421143 *

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncCavlc.cpp

    r1259 r1260  
    14571457
    14581458/**
    1459  - write tiles and wavefront substreams sizes for the slice header.
    1460  .
    1461  \param pcSlice Where we find the substream size information.
     1459 * Write tiles and wavefront substreams sizes for the slice header (entry points).
     1460 *
     1461 * \param pSlice TComSlice structure that contains the substream size information.
    14621462 */
    14631463Void  TEncCavlc::codeTilesWPPEntryPoint( TComSlice* pSlice )
    … …  
    16551655// ====================================================================================================================
    16561656
    1657 /** code explicit wp tables
    1658  * \param TComSlice* pcSlice
    1659  * \returns Void
    1660  */
     1657//! Code weighted prediction tables
    16611658Void TEncCavlc::xCodePredWeightTable( TComSlice* pcSlice )
    16621659{
    … …  
    17811778/** code DPCM
    17821779 * \param scalingList quantization matrix information
    1783  * \param sizeIdc size index
    1784  * \param listIdc list index
     1780 * \param sizeId      size index
     1781 * \param listId      list index
    17851782 */
    17861783Void TEncCavlc::xCodeScalingList(const TComScalingList* scalingList, UInt sizeId, UInt listId)

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncCu.cpp

    r1259 r1260  
    5555
    5656/**
    57  \param    uiTotalDepth  total number of allowable depth
     57 \param    uhTotalDepth  total number of allowable depth
    5858 \param    uiMaxWidth    largest CU width
    5959 \param    uiMaxHeight   largest CU height
     60 \param    chromaFormat  chroma format
    6061 */
    6162Void TEncCu::create(UChar uhTotalDepth, UInt uiMaxWidth, UInt uiMaxHeight, ChromaFormat chromaFormat)
    … …  
    231232// ====================================================================================================================
    232233
    233 /** \param  rpcCU pointer of CU data class
     234/**
     235 \param  pCtu pointer of CU data class
    234236 */
    235237Void TEncCu::compressCtu( TComDataCU* pCtu )
    … …  
    264266#endif
    265267}
    266 /** \param  pcCU  pointer of CU data class
     268/** \param  pCtu  pointer of CU data class
    267269 */
    268270Void TEncCu::encodeCtu ( TComDataCU* pCtu )
    … …  
    285287// Protected member functions
    286288// ====================================================================================================================
    287 /** Derive small set of test modes for AMP encoder speed-up
    288  *\param   rpcBestCU
    289  *\param   eParentPartSize
    290  *\param   bTestAMP_Hor
    291  *\param   bTestAMP_Ver
    292  *\param   bTestMergeAMP_Hor
    293  *\param   bTestMergeAMP_Ver
    294  *\returns Void
    295 */
     289//! Derive small set of test modes for AMP encoder speed-up
    296290#if AMP_ENC_SPEEDUP
    297291#if AMP_MRG
    … …  
    368362// ====================================================================================================================
    369363/** Compress a CU block recursively with enabling sub-CTU-level delta QP
    370  *\param   rpcBestCU
    371  *\param   rpcTempCU
    372  *\param   uiDepth
    373  *\returns Void
    374  *
    375  *- for loop of QP value to compress the current CU with all possible QP
     364 *  - for loop of QP value to compress the current CU with all possible QP
    376365*/
    377366#if AMP_ENC_SPEEDUP
    … …  
    12851274 * \param rpcBestCU
    12861275 * \param rpcTempCU
    1287  * \returns Void
     1276 * \param earlyDetectionSkipMode
    12881277 */
    12891278#if HIGHER_LAYER_IRAP_SKIP_FLAG
    … …  
    16001589 * \param rpcBestCU
    16011590 * \param rpcTempCU
    1602  * \returns Void
     1591 * \param uiDepth
    16031592 */
    16041593Void TEncCu::xCheckBestMode( TComDataCU*& rpcBestCU, TComDataCU*& rpcTempCU, UInt uiDepth DEBUG_STRING_FN_DECLARE(sParent) DEBUG_STRING_FN_DECLARE(sTest) DEBUG_STRING_PASS_INTO(Bool bAddSizeInfo) )
    … …  
    16941683
    16951684/** Function for filling the PCM buffer of a CU using its original sample array
    1696  * \param pcCU pointer to current CU
    1697  * \param pcOrgYuv pointer to original sample array
    1698  * \returns Void
     1685 * \param pCU pointer to current CU
     1686 * \param pOrgYuv pointer to original sample array
    16991687 */
    17001688Void TEncCu::xFillPCMBuffer     ( TComDataCU* pCU, TComYuv* pOrgYuv )
    … …  
    17551743}
    17561744
    1757 /** Collect ARL statistics from one CTU
    1758  * \param pcCU
    1759  */
     1745//! Collect ARL statistics from one CTU
    17601746Void TEncCu::xCtuCollectARLStats(TComDataCU* pCtu )
    17611747{
    1762   Double cSum[ LEVEL_RANGE + 1 ];     //: the sum of DCT coefficients corresponding to datatype and quantization output
    1763   UInt numSamples[ LEVEL_RANGE + 1 ]; //: the number of coefficients corresponding to datatype and quantization output
     1748  Double cSum[ LEVEL_RANGE + 1 ];     //: the sum of DCT coefficients corresponding to data type and quantization output
     1749  UInt numSamples[ LEVEL_RANGE + 1 ]; //: the number of coefficients corresponding to data type and quantization output
    17641750
    17651751  TCoeff* pCoeffY = pCtu->getCoeff(COMPONENT_Y);

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncEntropy.cpp

    r1259 r1260  
    126126}
    127127
    128 /** encode merge flag
    129  * \param pcCU
    130  * \param uiAbsPartIdx
    131  * \returns Void
    132  */
     128//! encode merge flag
    133129Void TEncEntropy::encodeMergeFlag( TComDataCU* pcCU, UInt uiAbsPartIdx )
    134130{
    … …  
    137133}
    138134
    139 /** encode merge index
    140  * \param pcCU
    141  * \param uiAbsPartIdx
    142  * \param bRD
    143  * \returns Void
    144  */
     135//! encode merge index
    145136Void TEncEntropy::encodeMergeIndex( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD )
    146137{
    … …  
    154145
    155146
    156 /** encode prediction mode
    157  * \param pcCU
    158  * \param uiAbsPartIdx
    159  * \param bRD
    160  * \returns Void
    161  */
     147//! encode prediction mode
    162148Void TEncEntropy::encodePredMode( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD )
    163149{
    … …  
    175161}
    176162
    177 // Split mode
     163//! encode split flag
    178164Void TEncEntropy::encodeSplitFlag( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth, Bool bRD )
    179165{
    … …  
    186172}
    187173
    188 /** encode partition size
    189  * \param pcCU
    190  * \param uiAbsPartIdx
    191  * \param uiDepth
    192  * \param bRD
    193  * \returns Void
    194  */
     174//! encode partition size
    195175Void TEncEntropy::encodePartSize( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth, Bool bRD )
    196176{
    … …  
    205185
    206186/** Encode I_PCM information.
    207  * \param pcCU pointer to CU
    208  * \param uiAbsPartIdx CU index
    209  * \param bRD flag indicating estimation or encoding
    210  * \returns Void
     187 * \param pcCU          pointer to CU
     188 * \param uiAbsPartIdx  CU index
     189 * \param bRD           flag indicating estimation or encoding
    211190 */
    212191Void TEncEntropy::encodeIPCMInfo( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD )
    … …  
    429408
    430409
    431 // Intra direction for Luma
     410//! encode intra direction for luma
    432411Void TEncEntropy::encodeIntraDirModeLuma  ( TComDataCU* pcCU, UInt absPartIdx, Bool isMultiplePU )
    433412{
    … …  
    436415
    437416
    438 // Intra direction for Chroma
     417//! encode intra direction for chroma
    439418Void TEncEntropy::encodeIntraDirModeChroma( TComDataCU* pcCU, UInt uiAbsPartIdx )
    440419{
    … …  
    484463}
    485464
    486 /** encode motion information for every PU block
    487  * \param pcCU
    488  * \param uiAbsPartIdx
    489  * \param bRD
    490  * \returns Void
    491  */
     465//! encode motion information for every PU block
    492466Void TEncEntropy::encodePUWise( TComDataCU* pcCU, UInt uiAbsPartIdx )
    493467{
    … …  
    555529}
    556530
    557 /** encode reference frame index for a PU block
    558  * \param pcCU
    559  * \param uiAbsPartIdx
    560  * \param eRefList
    561  * \returns Void
    562  */
     531//! encode reference frame index for a PU block
    563532Void TEncEntropy::encodeRefFrmIdxPU( TComDataCU* pcCU, UInt uiAbsPartIdx, RefPicList eRefList )
    564533{
    … …  
    578547}
    579548
    580 /** encode motion vector difference for a PU block
    581  * \param pcCU
    582  * \param uiAbsPartIdx
    583  * \param eRefList
    584  * \returns Void
    585  */
     549//! encode motion vector difference for a PU block
    586550Void TEncEntropy::encodeMvdPU( TComDataCU* pcCU, UInt uiAbsPartIdx, RefPicList eRefList )
    587551{
    … …  
    644608}
    645609
    646 /** encode chroma qp adjustment
    647  * \returns Void
    648  */
     610//! encode chroma qp adjustment
    649611Void TEncEntropy::encodeChromaQpAdjustment( TComDataCU* cu, UInt absPartIdx, Bool inRd )
    650612{
    … …  
    659621// texture
    660622
    661 /** encode coefficients
    662  * \param pcCU
    663  * \param uiAbsPartIdx
    664  * \param uiDepth
    665  * \param uiWidth
    666  * \param uiHeight
    667  */
     623//! encode coefficients
    668624Void TEncEntropy::encodeCoeff( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth, Bool& bCodeDQP, Bool& codeChromaQpAdj )
    669625{

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncGOP.cpp

    r1259 r1260  
    37613761/** Function for deciding the nal_unit_type.
    37623762 * \param pocCurr POC of the current picture
    3763  * \returns the nal unit type of the picture
     3763 * \param lastIDR  POC of the last IDR picture
     3764 * \param isField  true to indicate field coding
     3765 * \returns the NAL unit type of the picture
    37643766 * This function checks the configuration and returns the appropriate nal_unit_type for the picture.
    37653767 */

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncPic.cpp

    r1259 r1260  
    117117
    118118/** Initialize member variables
    119  * \param iWidth Picture width
    120  * \param iHeight Picture height
     119 * \param sps reference to used SPS
     120 * \param pps reference to used PPS
    121121 * \param uiMaxWidth Maximum CU width
    122122 * \param uiMaxHeight Maximum CU height
    … …  
    124124 * \param uiMaxAQDepth Maximum depth of unit block for assigning QP adaptive to local image characteristics
    125125 * \param bIsVirtual
    126  * \return Void
    127126 */
    128127
    129128#if SVC_EXTENSION
     129// * \param vps reference to used VPS
    130130Void TEncPic::create( const TComVPS& vps, const TComSPS &sps, const TComPPS &pps, UInt uiMaxWidth, UInt uiMaxHeight, UInt uiMaxDepth, UInt uiMaxAQDepth, Bool bIsVirtual, const UInt layerId )
    131131{
    … …  
    138138{
    139139  TComPic::create( sps, pps, uiMaxWidth, uiMaxHeight, uiMaxDepth, bIsVirtual );
    140 
    141140  const Int iWidth  = sps.getPicWidthInLumaSamples();
    142141  const Int iHeight = sps.getPicHeightInLumaSamples();
    … …  
    153152}
    154153
    155 /** Clean up
    156  * \return Void
    157  */
     154//! Clean up
    158155Void TEncPic::destroy()
    159156{

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncSampleAdaptiveOffset.cpp

    r1259 r1260  
    4646
    4747
    48 /** rounding with IBDI
    49  * \param  x
    50  */
     48//! rounding with IBDI
    5149inline Double xRoundIbdi2(Int bitDepth, Double x)
    5250{

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncSbac.cpp

    r1259 r1260  
    335335
    336336/** Coding of coeff_abs_level_minus3
    337  * \param uiSymbol value of coeff_abs_level_minus3
    338  * \param ruiGoRiceParam reference to Rice parameter
    339  * \returns Void
     337 * \param symbol                  value of coeff_abs_level_minus3
     338 * \param rParam                  reference to Rice parameter
     339 * \param useLimitedPrefixLength
     340 * \param channelType             plane type (luma/chroma)
    340341 */
    341342Void TEncSbac::xWriteCoefRemainExGolomb ( UInt symbol, UInt &rParam, const Bool useLimitedPrefixLength, const ChannelType channelType )
    … …  
    11121113
    11131114/** Encode (X,Y) position of the last significant coefficient
    1114  * \param uiPosX X component of last coefficient
    1115  * \param uiPosY Y component of last coefficient
    1116  * \param width  Block width
    1117  * \param height Block height
    1118  * \param eTType plane type / luminance or chrominance
    1119  * \param uiScanIdx scan type (zig-zag, hor, ver)
     1115 * \param uiPosX     X component of last coefficient
     1116 * \param uiPosY     Y component of last coefficient
     1117 * \param width      Block width
     1118 * \param height     Block height
     1119 * \param component  chroma component ID
     1120 * \param uiScanIdx  scan type (zig-zag, hor, ver)
    11201121 * This method encodes the X and Y component within a block of the last significant coefficient.
    11211122 */
    … …  
    15791580
    15801581/** Code SAO EO class or BO band position
    1581  * \param uiLength
    1582  * \param uiCode
    15831582 */
    15841583Void TEncSbac::codeSaoUflc       ( UInt uiLength, UInt uiCode )
    … …  
    15881587
    15891588/** Code SAO merge flags
    1590  * \param uiCode
    1591  * \param uiCompIdx
    15921589 */
    15931590Void TEncSbac::codeSaoMerge       ( UInt uiCode )
    … …  
    15971594
    15981595/** Code SAO type index
    1599  * \param uiCode
    16001596 */
    16011597Void TEncSbac::codeSaoTypeIdx       ( UInt uiCode)

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncSearch.cpp

    r1259 r1260  
    27482748 * \param pcCU pointer to current CU
    27492749 * \param uiAbsPartIdx part index
    2750  * \param piOrg pointer to original sample arrays
    2751  * \param piPCM pointer to PCM code arrays
    2752  * \param piPred pointer to prediction signal arrays
    2753  * \param piResi pointer to residual signal arrays
    2754  * \param piReco pointer to reconstructed sample arrays
     2750 * \param pOrg pointer to original sample arrays
     2751 * \param pPCM pointer to PCM code arrays
     2752 * \param pPred pointer to prediction signal arrays
     2753 * \param pResi pointer to residual signal arrays
     2754 * \param pReco pointer to reconstructed sample arrays
    27552755 * \param uiStride stride of the original/prediction/residual sample arrays
    27562756 * \param uiWidth block width
    27572757 * \param uiHeight block height
    2758  * \param ttText texture component type
    2759  * \returns Void
     2758 * \param compID texture component type
    27602759 */
    27612760Void TEncSearch::xEncPCM (TComDataCU* pcCU, UInt uiAbsPartIdx, Pel* pOrg, Pel* pPCM, Pel* pPred, Pel* pResi, Pel* pReco, UInt uiStride, UInt uiWidth, UInt uiHeight, const ComponentID compID )
    … …  
    27922791
    27932792
    2794 /**  Function for PCM mode estimation.
    2795  * \param pcCU
    2796  * \param pcOrgYuv
    2797  * \param rpcPredYuv
    2798  * \param rpcResiYuv
    2799  * \param rpcRecoYuv
    2800  * \returns Void
    2801  */
     2793//!  Function for PCM mode estimation.
    28022794Void TEncSearch::IPCMSearch( TComDataCU* pcCU, TComYuv* pcOrgYuv, TComYuv* pcPredYuv, TComYuv* pcResiYuv, TComYuv* pcRecoYuv )
    28032795{
    … …  
    28652857}
    28662858
    2867 /** estimation of best merge coding
    2868  * \param pcCU
    2869  * \param pcYuvOrg
    2870  * \param iPUIdx
    2871  * \param uiInterDir
    2872  * \param pacMvField
    2873  * \param uiMergeIndex
    2874  * \param ruiCost
    2875  * \param ruiBits
    2876  * \param puhNeighCands
    2877  * \param bValid
    2878  * \returns Void
    2879  */
     2859//! estimation of best merge coding
    28802860Void TEncSearch::xMergeEstimation( TComDataCU* pcCU, TComYuv* pcYuvOrg, Int iPUIdx, UInt& uiInterDir, TComMvField* pacMvField, UInt& uiMergeIndex, Distortion& ruiCost, TComMvField* cMvFieldNeighbours, UChar* uhInterDirNeighbours, Int& numValidMergeCand )
    28812861{
    … …  
    29712951}
    29722952
    2973 /** search of the best candidate for inter prediction
    2974  * \param pcCU
    2975  * \param pcOrgYuv
    2976  * \param rpcPredYuv
    2977  * \param rpcResiYuv
    2978  * \param rpcRecoYuv
    2979  * \param bUseRes
    2980  * \returns Void
    2981  */
     2953//! search of the best candidate for inter prediction
    29822954#if SVC_EXTENSION
    29832955#if AMP_MRG
    … …  
    44874459
    44884460
    4489 /** encode residual and calculate rate-distortion for a CU block
    4490  * \param pcCU
    4491  * \param pcYuvOrg
    4492  * \param pcYuvPred
    4493  * \param rpcYuvResi
    4494  * \param rpcYuvResiBest
    4495  * \param rpcYuvRec
    4496  * \param bSkipRes
    4497  * \returns Void
    4498  */
     4461//! encode residual and calculate rate-distortion for a CU block
    44994462Void TEncSearch::encodeResAndCalcRdInterCU( TComDataCU* pcCU, TComYuv* pcYuvOrg, TComYuv* pcYuvPred,
    45004463                                            TComYuv* pcYuvResi, TComYuv* pcYuvResiBest, TComYuv* pcYuvRec,
    … …  
    57535716
    57545717
    5755 /** set wp tables
    5756  * \param TComDataCU* pcCU
    5757  * \param iRefIdx
    5758  * \param eRefPicListCur
    5759  * \returns Void
    5760  */
     5718//! set wp tables
    57615719Void  TEncSearch::setWpScalingDistParam( TComDataCU* pcCU, Int iRefIdx, RefPicList eRefPicListCur )
    57625720{

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncSlice.cpp

    r1259 r1260  
    4848
    4949TEncSlice::TEncSlice()
    50 : m_encCABACTableIdx(I_SLICE)
     50 : m_encCABACTableIdx(I_SLICE)
    5151{
    5252  m_apcPicYuvPred = NULL;
    … …  
    222222 .
    223223 \param pcPic         picture class
    224  \param pocLast      POC of last picture
    225  \param pocCurr     current POC
     224 \param pocLast       POC of last picture
     225 \param pocCurr       current POC
    226226 \param iNumPicRcvd   number of received pictures
    227  \param iTimeOffset   POC offset for hierarchical structure
    228  \param iDepth        temporal layer depth
     227 \param iGOPid        POC offset for hierarchical structure
    229228 \param rpcSlice      slice header class
    230229 \param pSPS          SPS associated with the slice
    231230 \param pPPS          PPS associated with the slice
     231 \param isField       true for field coding
    232232 */
    233233#if SVC_EXTENSION
    234 //\param vps          VPS associated with the slice
    235234Void TEncSlice::initEncSlice( TComPic* pcPic, Int pocLast, Int pocCurr, Int iNumPicRcvd, Int iGOPid, TComSlice*& rpcSlice, Bool isField )
    236235#else
    … …  
    621620
    622621/**
    623  - multi-loop slice encoding for different slice QP
    624  .
    625  \param rpcPic    picture class
     622 Multi-loop slice encoding for different slice QP
     623
     624 \param pcPic    picture class
    626625 */
    627626Void TEncSlice::precompressSlice( TComPic* pcPic )
    … …  
    742741}
    743742
    744 /** \param rpcPic   picture class
     743/** \param pcPic   picture class
    745744 */
    746745Void TEncSlice::compressSlice( TComPic* pcPic )
    … …  
    10321031}
    10331032
    1034 /**
    1035  \param  rpcPic        picture class
    1036  \retval rpcBitstream  bitstream class
    1037  */
    10381033Void TEncSlice::encodeSlice   ( TComPic* pcPic, TComOutputBitstream* pcSubstreams, UInt &numBinsCoded )
    10391034{
    … …  
    13131308
    13141309/** Determines the starting and bounding CTU address of current slice / dependent slice
    1315  * \param bEncodeSlice Identifies if the calling function is compressSlice() [false] or encodeSlice() [true]
    1316  * \returns Updates startCtuTsAddr, boundingCtuTsAddr with appropriate CTU address
     1310 * \param [out] startCtuTsAddr
     1311 * \param [out] boundingCtuTsAddr
     1312 * \param [in] pcPic
     1313 * \param encodingSlice Identifies, if the calling function is compressSlice() [false] or encodeSlice() [true]
     1314
     1315 * Updates startCtuTsAddr, boundingCtuTsAddr with appropriate CTU address
    13171316 */
    13181317Void TEncSlice::xDetermineStartAndBoundingCtuTsAddr  ( UInt& startCtuTsAddr, UInt& boundingCtuTsAddr, TComPic* pcPic, const Bool encodingSlice ) // TODO: this is now only ever called with encodingSlice=false

  • branches/SHM-dev/source/Lib/TLibEncoder/TEncTop.cpp

    r1259 r1260  
    395395 \param   flush               cause encoder to encode a partial GOP
    396396 \param   pcPicYuvOrg         original YUV picture
     397 \param   pcPicYuvTrueOrg     
     398 \param   snrCSC
    397399 \retval  rcListPicYuvRecOut  list of reconstruction YUV pictures
    398  \retval  rcListBitstreamOut  list of output bitstreams
     400 \retval  accessUnitsOut      list of output access units
    399401 \retval  iNumEncoded         number of encoded pictures
    400402 */

  • branches/SHM-dev/source/Lib/TLibEncoder/WeightPredAnalysis.cpp

    r1259 r1260  
    6464
    6565
    66 /** calculate AC and DC values for current original image
    67  * \param TComSlice *slice
    68  * \returns Void
    69  */
     66//! calculate AC and DC values for current original image
    7067Void WeightPredAnalysis::xCalcACDCParamSlice(TComSlice *const slice)
    7168{
    … …  
    127124
    128125
    129 /** check weighted pred or non-weighted pred
    130  * \param TComSlice *slice
    131  * \returns Void
    132  */
     126//! check weighted pred or non-weighted pred
    133127Void  WeightPredAnalysis::xCheckWPEnable(TComSlice *const slice)
    134128{
    … …  
    178172
    179173
    180 /** estimate wp tables for explicit wp
    181  * \param TComSlice *slice
    182  */
     174//! estimate wp tables for explicit wp
    183175Void WeightPredAnalysis::xEstimateWPParamSlice(TComSlice *const slice)
    184176{
    … …  
    208200
    209201
    210 /** update wp tables for explicit wp w.r.t ramge limitation
    211  * \param TComSlice *slice
    212  * \returns Bool
    213  */
     202//! update wp tables for explicit wp w.r.t range limitation
    214203Bool WeightPredAnalysis::xUpdatingWPParameters(TComSlice *const slice, const Int log2Denom)
    215204{
    … …  
    329318
    330319
    331 /** select whether weighted pred enables or not.
    332  * \param TComSlice *slice
    333  * \param log2Denom
    334  * \returns Bool
    335  */
     320//! select whether weighted pred enables or not.
    336321Bool WeightPredAnalysis::xSelectWP(TComSlice *const slice, const Int log2Denom)
    337322{
    … …  
    385370
    386371
    387 /** calculate SAD values for both WP version and non-WP version.
    388  * \param Pel *pOrgPel
    389  * \param Pel *pRefPel
    390  * \param Int iWidth
    391  * \param Int iHeight
    392  * \param Int iOrgStride
    393  * \param Int iRefStride
    394  * \param Int iLog2Denom
    395  * \param Int iWeight
    396  * \param Int iOffset
    397  * \returns Int64
    398  */
     372//! calculate SAD values for both WP version and non-WP version.
    399373Int64 WeightPredAnalysis::xCalcSADvalueWP(const Int   bitDepth,
    400374                                          const Pel  *pOrgPel,

  • branches/SHM-dev/source/Lib/TLibVideoIO/TVideoIOYuv.cpp

    r1259 r1260  
    113113 * \param bWriteMode       file open mode: true=read, false=write
    114114 * \param fileBitDepth     bit-depth array of input/output file data.
     115 * \param MSBExtendedBitDepth
    115116 * \param internalBitDepth bit-depth array to scale image data to/from when reading/writing.
    116117 */
    … …  
    670671 * file had been provided at the lower-bitdepth compliant to Rec601/709.
    671672 *
    672  * @param pPicYuv      input picture YUV buffer class pointer
    673  * @param aiPad        source padding size, aiPad[0] = horizontal, aiPad[1] = vertical
     673 * @param pPicYuvUser      input picture YUV buffer class pointer
     674 * @param pPicYuvTrueOrg
     675 * @param ipcsc
     676 * @param aiPad            source padding size, aiPad[0] = horizontal, aiPad[1] = vertical
     677 * @param format           chroma format
    674678 * @return true for success, false in case of error
    675679 */
    … …  
    752756 * assumed to be at TVideoIO::m_fileBitdepth depth.
    753757 *
    754  * @param pPicYuv     input picture YUV buffer class pointer
    755  * @param aiPad       source padding size, aiPad[0] = horizontal, aiPad[1] = vertical
     758 * @param pPicYuvUser      input picture YUV buffer class pointer
     759 * @param ipCSC
     760 * @param confLeft         conformance window left border
     761 * @param confRight        conformance window right border
     762 * @param confTop          conformance window top border
     763 * @param confBottom       conformance window bottom border
     764 * @param format           chroma format
    756765 * @return true for success, false in case of error
    757766 */
Note: See TracChangeset for help on using the changeset viewer.