Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_image_utils_8h_source.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/Multimedia/ICL/ICLCodec/ImageUtils.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<h1>examples/Multimedia/ICL/ICLCodec/ImageUtils.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// ImageUtils.h</span>
<a name="l00003"></a>00003 <span class="comment">//</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00005"></a>00005 <span class="comment">// All rights reserved.</span>
<a name="l00006"></a>00006 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00007"></a>00007 <span class="comment">// under the terms of &quot;Eclipse Public License v1.0&quot;</span>
<a name="l00008"></a>00008 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00009"></a>00009 <span class="comment">// at the URL &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Initial Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00013"></a>00013 <span class="comment">//</span>
<a name="l00014"></a>00014 <span class="comment">// Contributors:</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016 <span class="comment">// Description:</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <span class="comment">//</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __ImageUtils_h</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __ImageUtils_h</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 
<a name="l00024"></a>00024 <span class="comment">//</span>
<a name="l00025"></a>00025 <span class="comment">// PtrReadUtil - utility class with methods for standard </span>
<a name="l00026"></a>00026 <span class="comment">// reading data from a TUint8* string</span>
<a name="l00027"></a>00027 <span class="comment">//</span>
<a name="l00028"></a>00028 
<a name="l00029"></a><a class="code" href="class_ptr_read_util.html">00029</a> <span class="keyword">class </span><a class="code" href="class_ptr_read_util.html">PtrReadUtil</a>
<a name="l00030"></a>00030         {
<a name="l00031"></a>00031 <span class="keyword">public</span>:
<a name="l00032"></a>00032         <span class="comment">// This calls decode from TUint8*</span>
<a name="l00033"></a>00033         <span class="keyword">static</span> TInt8 ReadInt8(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00034"></a>00034         <span class="keyword">static</span> TUint8 ReadUint8(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00035"></a>00035         <span class="keyword">static</span> TInt16 ReadInt16(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00036"></a>00036         <span class="keyword">static</span> TInt16 ReadBigEndianInt16(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00037"></a>00037         <span class="keyword">static</span> TUint16 ReadUint16(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00038"></a>00038         <span class="keyword">static</span> TUint16 ReadBigEndianUint16(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00039"></a>00039         <span class="keyword">static</span> TInt32 ReadInt32(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00040"></a>00040         <span class="keyword">static</span> TInt32 ReadBigEndianInt32(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00041"></a>00041         <span class="keyword">static</span> TUint32 ReadUint32(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00042"></a>00042         <span class="keyword">static</span> TUint32 ReadBigEndianUint32(<span class="keyword">const</span> TUint8* aPtr);
<a name="l00043"></a>00043         <span class="comment">// these calls also increment the pointer</span>
<a name="l00044"></a>00044         <span class="keyword">static</span> TInt8 ReadInt8Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00045"></a>00045         <span class="keyword">static</span> TUint8 ReadUint8Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00046"></a>00046         <span class="keyword">static</span> TInt16 ReadInt16Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00047"></a>00047         <span class="keyword">static</span> TInt16 ReadBigEndianInt16Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00048"></a>00048         <span class="keyword">static</span> TUint16 ReadUint16Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00049"></a>00049         <span class="keyword">static</span> TUint16 ReadBigEndianUint16Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00050"></a>00050         <span class="keyword">static</span> TInt32 ReadInt32Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00051"></a>00051         <span class="keyword">static</span> TInt32 ReadBigEndianInt32Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00052"></a>00052         <span class="keyword">static</span> TUint32 ReadUint32Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00053"></a>00053         <span class="keyword">static</span> TUint32 ReadBigEndianUint32Inc(<span class="keyword">const</span> TUint8*&amp; aPtr);
<a name="l00054"></a>00054         };
<a name="l00055"></a>00055 
<a name="l00056"></a>00056 <span class="keyword">inline</span> TUint8 PtrReadUtil::ReadUint8(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00057"></a>00057         {
<a name="l00058"></a>00058         <span class="keywordflow">return</span> *aPtr ;
<a name="l00059"></a>00059         }
<a name="l00060"></a>00060 
<a name="l00061"></a>00061 <span class="keyword">inline</span> TInt8 PtrReadUtil::ReadInt8(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00062"></a>00062         {
<a name="l00063"></a>00063         <span class="keywordflow">return</span> TInt8(ReadUint8(aPtr));
<a name="l00064"></a>00064         }
<a name="l00065"></a>00065 
<a name="l00066"></a>00066 <span class="keyword">inline</span> TUint16 PtrReadUtil::ReadUint16(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00067"></a>00067         {
<a name="l00068"></a>00068         <span class="keywordflow">return</span> TUint16(aPtr[0] | (aPtr[1]&lt;&lt;8));
<a name="l00069"></a>00069         }
<a name="l00070"></a>00070 
<a name="l00071"></a>00071 <span class="keyword">inline</span> TInt16 PtrReadUtil::ReadInt16(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00072"></a>00072         {
<a name="l00073"></a>00073         <span class="keywordflow">return</span> TInt16(ReadUint16(aPtr));
<a name="l00074"></a>00074         }
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="keyword">inline</span> TUint32 PtrReadUtil::ReadUint32(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00077"></a>00077         {
<a name="l00078"></a>00078         <span class="keywordflow">return</span> TUint32(aPtr[0] | (aPtr[1]&lt;&lt;8) | (aPtr[2]&lt;&lt;16) | (aPtr[3]&lt;&lt;24));
<a name="l00079"></a>00079         }
<a name="l00080"></a>00080 
<a name="l00081"></a>00081 <span class="keyword">inline</span> TInt32 PtrReadUtil::ReadInt32(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00082"></a>00082         {
<a name="l00083"></a>00083         <span class="keywordflow">return</span> TInt32(ReadUint32(aPtr));
<a name="l00084"></a>00084         }
<a name="l00085"></a>00085 
<a name="l00086"></a>00086 <span class="keyword">inline</span> TUint16 PtrReadUtil::ReadBigEndianUint16(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00087"></a>00087         {
<a name="l00088"></a>00088         <span class="keywordflow">return</span> TUint16((aPtr[0]&lt;&lt;8) | aPtr[1]);
<a name="l00089"></a>00089         }
<a name="l00090"></a>00090 
<a name="l00091"></a>00091 <span class="keyword">inline</span> TInt16 PtrReadUtil::ReadBigEndianInt16(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00092"></a>00092         {
<a name="l00093"></a>00093         <span class="keywordflow">return</span> TInt16(ReadBigEndianInt16(aPtr));
<a name="l00094"></a>00094         }
<a name="l00095"></a>00095 
<a name="l00096"></a>00096 <span class="keyword">inline</span> TUint32 PtrReadUtil::ReadBigEndianUint32(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00097"></a>00097         {
<a name="l00098"></a>00098         <span class="keywordflow">return</span> TUint32((aPtr[0]&lt;&lt;24) | (aPtr[1]&lt;&lt;16) | (aPtr[2]&lt;&lt;8) | aPtr[3]);
<a name="l00099"></a>00099         }
<a name="l00100"></a>00100 
<a name="l00101"></a>00101 <span class="keyword">inline</span> TInt32 PtrReadUtil::ReadBigEndianInt32(<span class="keyword">const</span> TUint8* aPtr)
<a name="l00102"></a>00102         {
<a name="l00103"></a>00103         <span class="keywordflow">return</span> TInt32(ReadBigEndianInt32(aPtr));
<a name="l00104"></a>00104         }
<a name="l00105"></a>00105 
<a name="l00106"></a>00106 <span class="keyword">inline</span> TInt8 PtrReadUtil::ReadInt8Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00107"></a>00107         {
<a name="l00108"></a>00108         TInt8 result = ReadInt8(aPtr);
<a name="l00109"></a>00109         aPtr += 1;
<a name="l00110"></a>00110         <span class="keywordflow">return</span> result;
<a name="l00111"></a>00111         }
<a name="l00112"></a>00112 
<a name="l00113"></a>00113 <span class="keyword">inline</span> TUint8 PtrReadUtil::ReadUint8Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00114"></a>00114         {
<a name="l00115"></a>00115         TUint8 result = ReadUint8(aPtr);
<a name="l00116"></a>00116         aPtr += 1;
<a name="l00117"></a>00117         <span class="keywordflow">return</span> result;
<a name="l00118"></a>00118         }
<a name="l00119"></a>00119 
<a name="l00120"></a>00120 <span class="keyword">inline</span> TInt16 PtrReadUtil::ReadInt16Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00121"></a>00121         {
<a name="l00122"></a>00122         TInt16 result = ReadInt16(aPtr);
<a name="l00123"></a>00123         aPtr += 2;
<a name="l00124"></a>00124         <span class="keywordflow">return</span> result;
<a name="l00125"></a>00125         }
<a name="l00126"></a>00126 
<a name="l00127"></a>00127 <span class="keyword">inline</span> TUint16 PtrReadUtil::ReadUint16Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00128"></a>00128         {
<a name="l00129"></a>00129         TUint16 result = ReadUint16(aPtr);
<a name="l00130"></a>00130         aPtr += 2;
<a name="l00131"></a>00131         <span class="keywordflow">return</span> result;
<a name="l00132"></a>00132         }
<a name="l00133"></a>00133 
<a name="l00134"></a>00134 <span class="keyword">inline</span> TInt16 PtrReadUtil::ReadBigEndianInt16Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00135"></a>00135         {
<a name="l00136"></a>00136         TInt16 result = ReadBigEndianInt16(aPtr);
<a name="l00137"></a>00137         aPtr += 2;
<a name="l00138"></a>00138         <span class="keywordflow">return</span> result;
<a name="l00139"></a>00139         }
<a name="l00140"></a>00140 
<a name="l00141"></a>00141 <span class="keyword">inline</span> TUint16 PtrReadUtil::ReadBigEndianUint16Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00142"></a>00142         {
<a name="l00143"></a>00143         TUint16 result = ReadBigEndianUint16(aPtr);
<a name="l00144"></a>00144         aPtr += 2;
<a name="l00145"></a>00145         <span class="keywordflow">return</span> result;
<a name="l00146"></a>00146         }
<a name="l00147"></a>00147 
<a name="l00148"></a>00148 <span class="keyword">inline</span> TInt32 PtrReadUtil::ReadInt32Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00149"></a>00149         {
<a name="l00150"></a>00150         TInt32 result = ReadInt32(aPtr);
<a name="l00151"></a>00151         aPtr += 4;
<a name="l00152"></a>00152         <span class="keywordflow">return</span> result;
<a name="l00153"></a>00153         }
<a name="l00154"></a>00154 
<a name="l00155"></a>00155 <span class="keyword">inline</span> TUint32 PtrReadUtil::ReadUint32Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00156"></a>00156         {
<a name="l00157"></a>00157         TUint32 result = ReadUint32(aPtr);
<a name="l00158"></a>00158         aPtr += 4;
<a name="l00159"></a>00159         <span class="keywordflow">return</span> result;
<a name="l00160"></a>00160         }
<a name="l00161"></a>00161 
<a name="l00162"></a>00162 <span class="keyword">inline</span> TInt32 PtrReadUtil::ReadBigEndianInt32Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00163"></a>00163         {
<a name="l00164"></a>00164         TInt32 result = ReadBigEndianInt32(aPtr);
<a name="l00165"></a>00165         aPtr += 4;
<a name="l00166"></a>00166         <span class="keywordflow">return</span> result;
<a name="l00167"></a>00167         }
<a name="l00168"></a>00168 
<a name="l00169"></a>00169 <span class="keyword">inline</span> TUint32 PtrReadUtil::ReadBigEndianUint32Inc(<span class="keyword">const</span> TUint8*&amp; aPtr)
<a name="l00170"></a>00170         {
<a name="l00171"></a>00171         TUint32 result = ReadBigEndianUint32(aPtr);
<a name="l00172"></a>00172         aPtr += 4;
<a name="l00173"></a>00173         <span class="keywordflow">return</span> result;
<a name="l00174"></a>00174         }
<a name="l00175"></a>00175 
<a name="l00176"></a><a class="code" href="class_ptr_write_util.html">00176</a> <span class="keyword">class </span><a class="code" href="class_ptr_write_util.html">PtrWriteUtil</a>
<a name="l00177"></a>00177         {
<a name="l00178"></a>00178 <span class="keyword">public</span>:
<a name="l00179"></a>00179         <span class="keyword">static</span> <span class="keywordtype">void</span> WriteInt8(TUint8* aPtr, TInt aData);
<a name="l00180"></a>00180         <span class="keyword">static</span> <span class="keywordtype">void</span> WriteInt16(TUint8* aPtr, TInt aData);
<a name="l00181"></a>00181         <span class="keyword">static</span> <span class="keywordtype">void</span> WriteInt32(TUint8* aPtr, TInt aData);
<a name="l00182"></a>00182         <span class="comment">// Big endian version</span>
<a name="l00183"></a>00183         <span class="keyword">static</span> <span class="keywordtype">void</span> WriteBigEndianInt32(TUint8* aPtr, TInt32 aData);
<a name="l00184"></a>00184         };
<a name="l00185"></a>00185 
<a name="l00186"></a>00186 <span class="keyword">inline</span> <span class="keywordtype">void</span> PtrWriteUtil::WriteInt8(TUint8* aPtr, TInt aData)
<a name="l00187"></a>00187         {
<a name="l00188"></a>00188         aPtr[0] = TUint8(aData);
<a name="l00189"></a>00189         }
<a name="l00190"></a>00190 
<a name="l00191"></a>00191 <span class="keyword">inline</span> <span class="keywordtype">void</span> PtrWriteUtil::WriteInt16(TUint8* aPtr, TInt aData)
<a name="l00192"></a>00192         {
<a name="l00193"></a>00193         aPtr[0] = TUint8(aData);
<a name="l00194"></a>00194         aPtr[1] = TUint8(aData&gt;&gt;8);
<a name="l00195"></a>00195         }
<a name="l00196"></a>00196 
<a name="l00197"></a>00197 <span class="keyword">inline</span> <span class="keywordtype">void</span> PtrWriteUtil::WriteInt32(TUint8* aPtr, TInt aData)
<a name="l00198"></a>00198         {
<a name="l00199"></a>00199         aPtr[0] = TUint8(aData);
<a name="l00200"></a>00200         aPtr[1] = TUint8(aData&gt;&gt;8);
<a name="l00201"></a>00201         aPtr[2] = TUint8(aData&gt;&gt;16);
<a name="l00202"></a>00202         aPtr[3] = TUint8(aData&gt;&gt;24);
<a name="l00203"></a>00203         }
<a name="l00204"></a>00204 
<a name="l00205"></a>00205 <span class="keyword">inline</span> <span class="keywordtype">void</span> PtrWriteUtil::WriteBigEndianInt32(TUint8* aPtr, TInt32 aData)
<a name="l00206"></a>00206         {
<a name="l00207"></a>00207         aPtr[0] = TUint8(aData&gt;&gt;24);
<a name="l00208"></a>00208         aPtr[1] = TUint8(aData&gt;&gt;16);
<a name="l00209"></a>00209         aPtr[2] = TUint8(aData&gt;&gt;8);
<a name="l00210"></a>00210         aPtr[3] = TUint8(aData);
<a name="l00211"></a>00211         }
<a name="l00212"></a>00212 
<a name="l00213"></a>00213 <span class="preprocessor">#endif // __ImageUtils_h</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>