Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/mmfexdes_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/MmfExSinkSource/mmfexdes.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/MmfExSinkSource/mmfexdes.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2001-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">// MMFDes.h</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __MMFDES_H_</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __MMFDES_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#include <mmf/server/mmfclip.h></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <mmf/common/mmfutilities.h></span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="comment">//Panic codes for MMFDescriptor</span>
<a name="l00025"></a>00025 <span class="keyword">enum</span> TMMFExDescriptorPanicCode
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 EMMFDescriptorPanicBufferEmptiedLNotSupported = 1,
<a name="l00028"></a>00028 EMMFDescriptorPanicBufferFilledLNotSupported
<a name="l00029"></a>00029 };
<a name="l00030"></a>00030
<a name="l00031"></a><a class="code" href="class_t_m_m_f_ex_descriptor_params.html">00031</a> <span class="keyword">class </span><a class="code" href="class_t_m_m_f_ex_descriptor_params.html">TMMFExDescriptorParams</a>
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 <span class="keyword">public</span>:
<a name="l00034"></a>00034 TAny* iDes ; <span class="comment">// Address of TPtr8 describing source Descriptor</span>
<a name="l00035"></a>00035 TThreadId iDesThreadId ;
<a name="l00036"></a>00036 } ;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">typedef</span> TPckgBuf<TMMFExDescriptorParams> TMMFDescriptorConfig ;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">// Defines a MMF sink and source plug-in that can write and read media data</span>
<a name="l00041"></a>00041 <span class="comment">// to a descriptor</span>
<a name="l00042"></a>00042 <span class="comment">// Implements CMMFClip, which itself derives from MDataSource and MDataSink</span>
<a name="l00043"></a><a class="code" href="class_c_m_m_f_ex_descriptor.html">00043</a> <span class="keyword">class </span><a class="code" href="class_c_m_m_f_ex_descriptor.html">CMMFExDescriptor</a> : <span class="keyword">public</span> CMMFClip
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00046"></a>00046 <span class="comment">// Data source factory</span>
<a name="l00047"></a>00047 <span class="keyword">static</span> MDataSource* NewSourceL() ;
<a name="l00048"></a>00048 <span class="comment">// Data sink factory</span>
<a name="l00049"></a>00049 <span class="keyword">static</span> MDataSink* NewSinkL() ;
<a name="l00050"></a>00050 ~<a class="code" href="class_c_m_m_f_ex_descriptor.html">CMMFExDescriptor</a>() ;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">private</span>:
<a name="l00053"></a>00053 <span class="comment">// From MDataSource</span>
<a name="l00054"></a>00054 TFourCC SourceDataTypeCode( TMediaId <span class="comment">/*aMediaId*/</span>) ;
<a name="l00055"></a>00055 <span class="keywordtype">void</span> FillBufferL(CMMFBuffer* aBuffer, MDataSink* aConsumer,TMediaId <span class="comment">/*aMediaId*/</span>) ;<span class="comment">//called by a MDataSink to request buffer fill</span>
<a name="l00056"></a>00056 <span class="keywordtype">void</span> BufferEmptiedL( CMMFBuffer* aBuffer ) ;
<a name="l00057"></a>00057 TBool CanCreateSourceBuffer() ;
<a name="l00058"></a>00058 CMMFBuffer* CreateSourceBufferL(TMediaId <span class="comment">/*aMediaId*/</span>, TBool &aReference) ;
<a name="l00059"></a>00059 <span class="keywordtype">void</span> ConstructSourceL( <span class="keyword">const</span> TDesC8& aInitData ) ;
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="comment">// From MDataSink</span>
<a name="l00062"></a>00062 TFourCC SinkDataTypeCode(TMediaId <span class="comment">/*aMediaId*/</span>) ; <span class="comment">//used by data path MDataSource/Sink for codec matching</span>
<a name="l00063"></a>00063 <span class="keywordtype">void</span> EmptyBufferL( CMMFBuffer* aBuffer, MDataSource* aSupplier, TMediaId <span class="comment">/*aMediaId*/</span> ) ;
<a name="l00064"></a>00064 <span class="keywordtype">void</span> BufferFilledL( CMMFBuffer* aBuffer ) ;
<a name="l00065"></a>00065 TBool CanCreateSinkBuffer() ;
<a name="l00066"></a>00066 CMMFBuffer* CreateSinkBufferL( TMediaId <span class="comment">/*aMediaId*/</span> , TBool &aReference) ;
<a name="l00067"></a>00067 <span class="keywordtype">void</span> ConstructSinkL( <span class="keyword">const</span> TDesC8& aInitData ) ;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">// From CMMFClip</span>
<a name="l00070"></a>00070 <span class="keywordtype">void</span> ReadBufferL( TInt aLength, CMMFBuffer* aBuffer, TInt aPosition, MDataSink* aConsumer);
<a name="l00071"></a>00071 <span class="keywordtype">void</span> WriteBufferL( TInt aLength, CMMFBuffer* aBuffer, TInt aPosition, MDataSource* aSupplier);
<a name="l00072"></a>00072 <span class="keywordtype">void</span> ReadBufferL( CMMFBuffer* aBuffer, TInt aPosition, MDataSink* aConsumer) ;
<a name="l00073"></a>00073 <span class="keywordtype">void</span> WriteBufferL( CMMFBuffer* aBuffer, TInt aPosition, MDataSource* aSupplier) ;
<a name="l00074"></a>00074 <span class="keywordtype">void</span> ReadBufferL( CMMFBuffer* aBuffer, TInt aPosition) ;
<a name="l00075"></a>00075 <span class="keywordtype">void</span> WriteBufferL( CMMFBuffer* aBuffer, TInt aPosition) ;
<a name="l00076"></a>00076 TInt64 BytesFree() ; <span class="comment">// amount of space available for the clip</span>
<a name="l00077"></a>00077 TInt Size() ; <span class="comment">// length of clip</span>
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">// Construction</span>
<a name="l00080"></a>00080 <span class="keywordtype">void</span> ConstructL( <span class="keyword">const</span> TDesC8& aInitData ) ;
<a name="l00081"></a>00081 <a class="code" href="class_c_m_m_f_ex_descriptor.html">CMMFExDescriptor</a>();
<a name="l00082"></a>00082 <span class="comment">// Helpers</span>
<a name="l00083"></a>00083 <span class="keywordtype">void</span> Reset() { iOffset = 0 ; };
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">private</span>:
<a name="l00086"></a>00086 <span class="comment">// Need to know about the thread that the descriptor is in</span>
<a name="l00087"></a>00087 RThread iDesThread;
<a name="l00088"></a>00088 TDes8* iDes ;
<a name="l00089"></a>00089 TInt iOffset;
<a name="l00090"></a>00090 TFourCC iSinkFourCC;
<a name="l00091"></a>00091 TFourCC iSourceFourCC;
<a name="l00092"></a>00092 TBool iUseTransferBuffer;
<a name="l00093"></a>00093 } ;
<a name="l00094"></a>00094
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="preprocessor">#endif</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>