Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/mmfrawformat_8h_source.html
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/MmfExFormatPlugin/mmfrawformat.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/MmfExFormatPlugin/mmfrawformat.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="preprocessor">#ifndef __MMF_RAW_FORMAT_H__</span>
<a name="l00017"></a>00017 <span class="preprocessor"></span><span class="preprocessor">#define __MMF_RAW_FORMAT_H__</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span>
<a name="l00019"></a>00019 <span class="comment">// MMF framework headers</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <mmfformat.h></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <mmfdatabuffer.h></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <mmfclip.h></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <implementationproxy.h></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <mmfutilities.h></span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="comment">/* Audio decoder plug-in to read .RAW audio.</span>
<a name="l00027"></a>00027 <span class="comment"> It implements MDataSource to pass data to the controller, and MDataSink to read data from </span>
<a name="l00028"></a>00028 <span class="comment"> the source clip.</span>
<a name="l00029"></a>00029 <span class="comment"> Also implements MAsyncEventHandler to send an event to the client */</span>
<a name="l00030"></a><a class="code" href="class_c_m_m_f_raw_format_read.html">00030</a> <span class="keyword">class </span><a class="code" href="class_c_m_m_f_raw_format_read.html">CMMFRawFormatRead</a> : <span class="keyword">public</span> CMMFFormatDecode, <span class="keyword">public</span> MAsyncEventHandler
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032 <span class="keyword">public</span>:
<a name="l00033"></a>00033 <span class="comment">// Factory function</span>
<a name="l00034"></a>00034 <span class="keyword">static</span> CMMFFormatDecode* NewL(MDataSource* aSource);
<a name="l00035"></a>00035 ~<a class="code" href="class_c_m_m_f_raw_format_read.html">CMMFRawFormatRead</a>();
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">//from MDataSource</span>
<a name="l00038"></a>00038 <span class="keywordtype">void</span> FillBufferL(CMMFBuffer* aBuffer, MDataSink* aConsumer, TMediaId aMediaId);
<a name="l00039"></a>00039 CMMFBuffer* CreateSourceBufferL(TMediaId aMediaId, TBool &aReference);
<a name="l00040"></a>00040 CMMFBuffer* CreateSourceBufferL(TMediaId aMediaId, CMMFBuffer& aSinkBuffer, TBool &aReference);
<a name="l00041"></a>00041 TFourCC SourceDataTypeCode(TMediaId aMediaId);
<a name="l00042"></a>00042 TInt SetSourceDataTypeCode(TFourCC aSourceFourCC, TMediaId aMediaId);
<a name="l00043"></a>00043 TInt SourceThreadLogon(MAsyncEventHandler& aEventHandler);
<a name="l00044"></a>00044 <span class="keywordtype">void</span> SourceThreadLogoff();
<a name="l00045"></a>00045 <span class="keywordtype">void</span> SourcePrimeL();
<a name="l00046"></a>00046 <span class="keywordtype">void</span> SourcePlayL();
<a name="l00047"></a>00047 <span class="keywordtype">void</span> SourcePauseL();
<a name="l00048"></a>00048 <span class="keywordtype">void</span> SourceStopL();
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="comment">//from MDataSink</span>
<a name="l00051"></a>00051 <span class="keywordtype">void</span> BufferFilledL(CMMFBuffer* aBuffer);
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="comment">// from CMMFFormatDecode</span>
<a name="l00054"></a>00054 TUint Streams(TUid aMediaType) <span class="keyword">const</span>;
<a name="l00055"></a>00055 TTimeIntervalMicroSeconds FrameTimeInterval(TMediaId aMediaType) <span class="keyword">const</span>;
<a name="l00056"></a>00056 TTimeIntervalMicroSeconds Duration(TMediaId aMediaType) <span class="keyword">const</span>;
<a name="l00057"></a>00057 TUint NumChannels() {<span class="keywordflow">return</span> iChannels;};
<a name="l00058"></a>00058 TUint SampleRate() {<span class="keywordflow">return</span> iSampleRate;};
<a name="l00059"></a>00059 TUint BitRate() {<span class="keywordflow">return</span> iSampleRate * iBitsPerSample;};
<a name="l00060"></a>00060 TInt SetNumChannels(TUint aChannels);
<a name="l00061"></a>00061 TInt SetSampleRate(TUint aSampleRate);
<a name="l00062"></a>00062 <span class="keywordtype">void</span> GetSupportedSampleRatesL(RArray<TUint>& aSampleRates);
<a name="l00063"></a>00063 <span class="keywordtype">void</span> GetSupportedNumChannelsL(RArray<TUint>& aNumChannels);
<a name="l00064"></a>00064 <span class="keywordtype">void</span> GetSupportedDataTypesL(TMediaId aMediaId, RArray<TFourCC>& aDataTypes);
<a name="l00065"></a>00065 <span class="keywordtype">void</span> SuggestSourceBufferSize(TUint aSuggestedBufferSize);
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">//from MAsyncEventHandler</span>
<a name="l00068"></a>00068 TInt SendEventToClient(<span class="keyword">const</span> TMMFEvent& <span class="comment">/*aEvent*/</span>) {<span class="keywordflow">return</span> KErrNone;}
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keyword">private</span>:
<a name="l00071"></a>00071 <span class="comment">// Construction</span>
<a name="l00072"></a>00072 <span class="keywordtype">void</span> ConstructL(MDataSource* aSource);
<a name="l00073"></a>00073 <span class="comment">// Helper functions</span>
<a name="l00074"></a>00074 CMMFDataBuffer* CreateSourceBufferOfSizeL(TUint aSize);
<a name="l00075"></a>00075 <span class="keywordtype">void</span> DoReadL(TInt aReadPosition);
<a name="l00076"></a>00076 <span class="keywordtype">void</span> NegotiateSourceBufferL(CMMFBuffer& aBuffer);
<a name="l00077"></a>00077 <span class="keywordtype">void</span> CalculateFrameTimeInterval();
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keyword">protected</span>:
<a name="l00080"></a>00080 MDataSource* iClip; <span class="comment">//for decode format MDatasource; for encode format MDataSink</span>
<a name="l00081"></a>00081 MDataSink* iDataPath; <span class="comment">//for decode format MDataSink; for encode format MDataSource</span>
<a name="l00082"></a>00082 TFourCC iFourCC;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">private</span>:
<a name="l00085"></a>00085 CMMFDataBuffer* iBuffer;
<a name="l00086"></a>00086 TUint iStartPosition;
<a name="l00087"></a>00087 TUint iPos;
<a name="l00088"></a>00088 TUint iChannels;
<a name="l00089"></a>00089 TUint iSampleRate;
<a name="l00090"></a>00090 TUint iBitsPerSample;
<a name="l00091"></a>00091 TTimeIntervalMicroSeconds iFrameTimeInterval;
<a name="l00092"></a>00092 TUint iFrameSize;
<a name="l00093"></a>00093 TUint iClipLength;
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">/* Audio encoder plug-in to write .RAW audio.</span>
<a name="l00098"></a>00098 <span class="comment"> It implements MDataSink to get data from the controller, and MDataSource to write data to </span>
<a name="l00099"></a>00099 <span class="comment"> the target clip.</span>
<a name="l00100"></a>00100 <span class="comment"> Also implements MAsyncEventHandler to send an event to the client */</span>
<a name="l00101"></a><a class="code" href="class_c_m_m_f_raw_format_write.html">00101</a> <span class="keyword">class </span><a class="code" href="class_c_m_m_f_raw_format_write.html">CMMFRawFormatWrite</a> : <span class="keyword">public</span> CMMFFormatEncode, <span class="keyword">public</span> MAsyncEventHandler
<a name="l00102"></a>00102 {
<a name="l00103"></a>00103 <span class="keyword">public</span>:
<a name="l00104"></a>00104 <span class="comment">// Factory function</span>
<a name="l00105"></a>00105 <span class="keyword">static</span> CMMFFormatEncode* NewL(MDataSink* aSink);
<a name="l00106"></a>00106 ~<a class="code" href="class_c_m_m_f_raw_format_write.html">CMMFRawFormatWrite</a>();
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">//from MDataSink</span>
<a name="l00109"></a>00109 CMMFBuffer* CreateSinkBufferL(TMediaId aMediaId, TBool &aReference);
<a name="l00110"></a>00110 TFourCC SinkDataTypeCode(TMediaId aMediaId); <span class="comment">//returns FourCC code for the mediaId</span>
<a name="l00111"></a>00111 TInt SetSinkDataTypeCode(TFourCC aSinkFourCC, TMediaId aMediaId);
<a name="l00112"></a>00112 TInt SinkThreadLogon(MAsyncEventHandler& aEventHandler);
<a name="l00113"></a>00113 <span class="keywordtype">void</span> SinkThreadLogoff();
<a name="l00114"></a>00114 <span class="keywordtype">void</span> Negotiate(MDataSource& aSource);
<a name="l00115"></a>00115 <span class="keywordtype">void</span> SinkPrimeL();
<a name="l00116"></a>00116 <span class="keywordtype">void</span> SinkPlayL();
<a name="l00117"></a>00117 <span class="keywordtype">void</span> SinkPauseL();
<a name="l00118"></a>00118 <span class="keywordtype">void</span> SinkStopL();
<a name="l00119"></a>00119 <span class="keywordtype">void</span> EmptyBufferL(CMMFBuffer* aBuffer, MDataSource* aSupplier, TMediaId aMediaId);
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="comment">//from MDataSource</span>
<a name="l00122"></a>00122 <span class="keywordtype">void</span> BufferEmptiedL(CMMFBuffer* aBuffer);
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="comment">// from CMMFFormatEncode</span>
<a name="l00125"></a>00125 TTimeIntervalMicroSeconds FrameTimeInterval(TMediaId aMediaType) <span class="keyword">const</span>;
<a name="l00126"></a>00126 TTimeIntervalMicroSeconds Duration(TMediaId aMediaType) <span class="keyword">const</span>;
<a name="l00127"></a>00127 TInt SetNumChannels(TUint aChannels);
<a name="l00128"></a>00128 TInt SetSampleRate(TUint aSampleRate);
<a name="l00129"></a>00129 TUint NumChannels() {<span class="keywordflow">return</span> iChannels;};
<a name="l00130"></a>00130 TUint SampleRate() {<span class="keywordflow">return</span> iSampleRate;};
<a name="l00131"></a>00131 TUint BitRate() {<span class="keywordflow">return</span> iSampleRate * iBitsPerSample;};
<a name="l00132"></a>00132 TInt64 BytesPerSecond() ;
<a name="l00133"></a>00133 <span class="keywordtype">void</span> GetSupportedSampleRatesL(RArray<TUint>& aSampleRates);
<a name="l00134"></a>00134 <span class="keywordtype">void</span> GetSupportedNumChannelsL(RArray<TUint>& aNumChannels);
<a name="l00135"></a>00135 <span class="keywordtype">void</span> GetSupportedDataTypesL(TMediaId aMediaId, RArray<TFourCC>& aDataTypes);
<a name="l00136"></a>00136 <span class="keywordtype">void</span> SetMaximumClipSize(TInt aBytes);
<a name="l00137"></a>00137 <span class="keywordtype">void</span> CropL(TTimeIntervalMicroSeconds aPosition, TBool aToEnd ) ;
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">//from MAsyncEventHandler</span>
<a name="l00140"></a>00140 TInt SendEventToClient(<span class="keyword">const</span> TMMFEvent& <span class="comment">/*aEvent*/</span>) {<span class="keywordflow">return</span> KErrNone;}
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keyword">private</span>:
<a name="l00143"></a>00143 <span class="comment">// construction</span>
<a name="l00144"></a>00144 <span class="keywordtype">void</span> ConstructL(MDataSink* aSink);
<a name="l00145"></a>00145 <span class="comment">// helper functions</span>
<a name="l00146"></a>00146 CMMFDataBuffer* CreateSinkBufferOfSizeL(TUint aSize);
<a name="l00147"></a>00147 <span class="keywordtype">void</span> CalculateFrameTimeInterval();
<a name="l00148"></a>00148 <span class="keywordtype">void</span> DoReadL(TInt aReadPosition);
<a name="l00149"></a>00149 <span class="keywordtype">void</span> DoWriteL(TInt aWritePosition);
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="keyword">private</span>:
<a name="l00152"></a>00152 MDataSink* iClip; <span class="comment">//for decode format MDatasource; for encode format MDataSink</span>
<a name="l00153"></a>00153 MDataSource* iDataPath; <span class="comment">//for decode format MDataSink; for encode format MDataSource</span>
<a name="l00154"></a>00154 TFourCC iFourCC;
<a name="l00155"></a>00155 CMMFDataBuffer* iBuffer;
<a name="l00156"></a>00156 TBool iClipAlreadyExists;
<a name="l00157"></a>00157 TBool iBufferCreated;
<a name="l00158"></a>00158 TBool iFileHasChanged;
<a name="l00159"></a>00159 TUint iStartPosition;
<a name="l00160"></a>00160 TUint iDataLength;
<a name="l00161"></a>00161 TUint iPos;
<a name="l00162"></a>00162 TUint iMaxPos;
<a name="l00163"></a>00163 TUint iChannels;
<a name="l00164"></a>00164 TUint iSampleRate;
<a name="l00165"></a>00165 TUint iSourceChannels;
<a name="l00166"></a>00166 TUint iSourceSampleRate;
<a name="l00167"></a>00167 TFourCC iSourceFourCC;
<a name="l00168"></a>00168 TUint iBitsPerSample;
<a name="l00169"></a>00169 TTimeIntervalMicroSeconds iFrameTimeInterval;
<a name="l00170"></a>00170 TUint iFrameSize;
<a name="l00171"></a>00171 TUint iClipLength;
<a name="l00172"></a>00172 TUint iDataSize;
<a name="l00173"></a>00173 CMMFChannelAndSampleRateConverterFactory* iChannelAndSampleRateConverterFactory;
<a name="l00174"></a>00174 CMMFChannelAndSampleRateConverter* iChannelAndSampleRateConverter;
<a name="l00175"></a>00175 CMMFDataBuffer* iConvertBuffer;
<a name="l00176"></a>00176 CMMFBuffer* iBufferToEmpty; <span class="comment">//pointer to store buffr to empty - needed if buffer passed to clip is different</span>
<a name="l00177"></a>00177 TBool iSourceWillSampleConvert;
<a name="l00178"></a>00178 TInt iMaximumClipSize;
<a name="l00179"></a>00179 };
<a name="l00180"></a>00180
<a name="l00181"></a>00181 <span class="preprocessor">#endif</span>
<a name="l00182"></a>00182 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>