imagingmodules/jp2kcodec/Inc/JP2KSubband.inl
changeset 0 469c91dae73b
equal deleted inserted replaced
-1:000000000000 0:469c91dae73b
       
     1 /*
       
     2 * Copyright (c) 2003, 2004 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  JP2KSubband class used to collect the subband related
       
    15 *                information such as list of packets and list of subbands.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef __JP2KSUBBAND_INL__
       
    22 #define __JP2KSUBBAND_INL__
       
    23 
       
    24 // ============================ MEMBER FUNCTIONS ===============================
       
    25 
       
    26 // -----------------------------------------------------------------------------
       
    27 // CJ2kSubband::Parent
       
    28 // Get the parent subband of the current subband
       
    29 // (other items were commented in a header).
       
    30 // -----------------------------------------------------------------------------
       
    31 //
       
    32 inline CJ2kSubband* CJ2kSubband::Parent()
       
    33     {
       
    34     return iParent;
       
    35     }
       
    36 
       
    37 // -----------------------------------------------------------------------------
       
    38 // CJ2kSubband::SetParent
       
    39 // Set the parent subband of the current subband
       
    40 // (other items were commented in a header).
       
    41 // -----------------------------------------------------------------------------
       
    42 //
       
    43 inline void CJ2kSubband::SetParent( CJ2kSubband* aParent )
       
    44     {
       
    45     iParent = aParent;
       
    46     }
       
    47 
       
    48 // -----------------------------------------------------------------------------
       
    49 // CJ2kSubband::SetSubbandLevel
       
    50 // Set the subband level
       
    51 // (other items were commented in a header).
       
    52 // -----------------------------------------------------------------------------
       
    53 //
       
    54 inline void CJ2kSubband::SetSubbandLevel( TUint8 aLevel )
       
    55     {
       
    56     iLevel = aLevel;
       
    57     }
       
    58 
       
    59 
       
    60 // -----------------------------------------------------------------------------
       
    61 // CJ2kSubband::SubbandType
       
    62 // Get the subband type
       
    63 // (other items were commented in a header).
       
    64 // -----------------------------------------------------------------------------
       
    65 //
       
    66 inline CJ2kSubband::TSubbandType CJ2kSubband::SubbandType() const
       
    67     {
       
    68     return iType;
       
    69     }
       
    70 
       
    71 // -----------------------------------------------------------------------------
       
    72 // CJ2kSubband::SubbandLevel
       
    73 // Get the subband level
       
    74 // (other items were commented in a header).
       
    75 // -----------------------------------------------------------------------------
       
    76 //
       
    77 inline TUint8 CJ2kSubband::SubbandLevel() const
       
    78     {
       
    79     return iLevel;
       
    80     }
       
    81 
       
    82 // -----------------------------------------------------------------------------
       
    83 // CJ2kSubband::SubbandResLevel
       
    84 // Get the subband resolution level
       
    85 // (other items were commented in a header).
       
    86 // -----------------------------------------------------------------------------
       
    87 //
       
    88 inline TUint8 CJ2kSubband::SubbandResLevel() const
       
    89     {
       
    90     return iResLevel;
       
    91     }
       
    92 
       
    93 // -----------------------------------------------------------------------------
       
    94 // CJ2kSubband::SubbandGain
       
    95 // Get the subband gain
       
    96 // (other items were commented in a header).
       
    97 // -----------------------------------------------------------------------------
       
    98 //
       
    99 inline TUint8 CJ2kSubband::SubbandGain() const
       
   100     {
       
   101     return iGain;
       
   102     }
       
   103 
       
   104 // -----------------------------------------------------------------------------
       
   105 // CJ2kSubband::HighPassFirst
       
   106 // Get the subband high pass first
       
   107 // (other items were commented in a header).
       
   108 // -----------------------------------------------------------------------------
       
   109 //
       
   110 inline const TPoint& CJ2kSubband::HighPassFirst() const
       
   111     {
       
   112     return iHighPassFirst;
       
   113     }
       
   114 
       
   115 // -----------------------------------------------------------------------------
       
   116 // CJ2kSubband::SubbandOrigin
       
   117 // Get the subband origin
       
   118 // (other items were commented in a header).
       
   119 // -----------------------------------------------------------------------------
       
   120 //
       
   121 inline const TPoint& CJ2kSubband::SubbandOrigin() const
       
   122     {
       
   123     return iSubbandOrigin;
       
   124     }
       
   125 
       
   126 // -----------------------------------------------------------------------------
       
   127 // CJ2kSubband::SubbandCanvas
       
   128 // Get the subband canvas
       
   129 // (other items were commented in a header).
       
   130 // -----------------------------------------------------------------------------
       
   131 //
       
   132 inline const TRect& CJ2kSubband::SubbandCanvas() const
       
   133     {
       
   134     return iSubbandCanvas;
       
   135     }
       
   136 
       
   137 // -----------------------------------------------------------------------------
       
   138 // CJ2kSubband::SubbandCanvasSize
       
   139 // Get the subband canvas size
       
   140 // (other items were commented in a header).
       
   141 // -----------------------------------------------------------------------------
       
   142 //
       
   143 inline TSize CJ2kSubband::SubbandCanvasSize() const
       
   144     {
       
   145     return iSubbandCanvas.Size();
       
   146     }
       
   147 
       
   148 // -----------------------------------------------------------------------------
       
   149 // CJ2kSubband::PacketList
       
   150 // Get the list of packets
       
   151 // (other items were commented in a header).
       
   152 // -----------------------------------------------------------------------------
       
   153 //
       
   154 inline const RPointerArray<CJ2kPacket>& CJ2kSubband::PacketList() const
       
   155     {
       
   156     return iPacketList;
       
   157     }
       
   158 
       
   159 // -----------------------------------------------------------------------------
       
   160 // CJ2kSubband::LastPacketProcessed
       
   161 // Get the last packet processed
       
   162 // (other items were commented in a header).
       
   163 // -----------------------------------------------------------------------------
       
   164 //
       
   165 inline TUint16 CJ2kSubband::LastPacketProcessed() const
       
   166     {
       
   167     return iLastPacket;
       
   168     }
       
   169 
       
   170 // -----------------------------------------------------------------------------
       
   171 // CJ2kSubband::ResetLastPacketProcessed
       
   172 // Reset the last packet processed to 0
       
   173 // (other items were commented in a header).
       
   174 // -----------------------------------------------------------------------------
       
   175 //
       
   176 inline void CJ2kSubband::ResetLastPacketProcessed()
       
   177     {
       
   178     iLastPacket = 0;
       
   179     }
       
   180 
       
   181 // -----------------------------------------------------------------------------
       
   182 // CJ2kSubband::SetLastSubbandProcessed
       
   183 // Set the last subband processed
       
   184 // (other items were commented in a header).
       
   185 // -----------------------------------------------------------------------------
       
   186 //
       
   187 inline void CJ2kSubband::SetLastSubbandProcessed( TUint8 aSubbandType )
       
   188     {
       
   189     iLastSubband = aSubbandType;
       
   190     }
       
   191 
       
   192 // -----------------------------------------------------------------------------
       
   193 // CJ2kSubband::LastSubbandProcessed
       
   194 // Get the last subband processed
       
   195 // (other items were commented in a header).
       
   196 // -----------------------------------------------------------------------------
       
   197 //
       
   198 inline TUint8 CJ2kSubband::LastSubbandProcessed() const
       
   199     {
       
   200     return iLastSubband;
       
   201     }
       
   202 
       
   203 // -----------------------------------------------------------------------------
       
   204 // CJ2kSubband::PacketAt
       
   205 // Get the packet at specific location
       
   206 // (other items were commented in a header).
       
   207 // -----------------------------------------------------------------------------
       
   208 //
       
   209 inline const CJ2kPacket& CJ2kSubband::PacketAt( TUint16 aIndex ) const
       
   210     {
       
   211     return *iPacketList[aIndex];
       
   212     }
       
   213 
       
   214 #endif // __JP2KSUBBAND_INL__