epoc32/include/mmf/server/mmfdes.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __MMFDES_H_
williamr@2
    17
#define __MMFDES_H_
williamr@2
    18
williamr@2
    19
williamr@2
    20
#include <mmf/server/mmfclip.h>
williamr@2
    21
#include <mmf/common/mmfutilities.h>
williamr@2
    22
williamr@2
    23
williamr@2
    24
/**
williamr@2
    25
@publishedAll
williamr@2
    26
@released
williamr@2
    27
williamr@2
    28
Descriptor parameters.
williamr@2
    29
williamr@2
    30
Used by CMMFDescriptor::ConstructL().
williamr@2
    31
*/
williamr@2
    32
class TMMFDescriptorParams
williamr@2
    33
	{
williamr@2
    34
public:
williamr@2
    35
	/**
williamr@2
    36
    Address of TPr8 describing source descriptor.
williamr@2
    37
	*/
williamr@2
    38
	TAny* iDes ; // Address of TPr8 describing source Descriptor
williamr@2
    39
	/**
williamr@2
    40
	Descriptor thread.
williamr@2
    41
	*/
williamr@2
    42
	TThreadId iDesThreadId ;
williamr@2
    43
private:
williamr@2
    44
	/**
williamr@2
    45
	This member is internal and not intended for use.
williamr@2
    46
	*/
williamr@2
    47
	TInt iReserved1;
williamr@2
    48
	} ;
williamr@2
    49
williamr@2
    50
/**
williamr@2
    51
@publishedAll
williamr@2
    52
@released
williamr@2
    53
*/
williamr@2
    54
typedef TPckgBuf<TMMFDescriptorParams>  TMMFDescriptorConfig ;
williamr@2
    55
williamr@2
    56
/**
williamr@2
    57
@publishedAll
williamr@2
    58
@released
williamr@2
    59
williamr@2
    60
MultiMedia framework class.  Represents a client side descriptor.
williamr@2
    61
May be source descriptor from which data is read or destination to which data is written
williamr@2
    62
*/
williamr@2
    63
class CMMFDescriptor : public CMMFClip
williamr@2
    64
	{
williamr@2
    65
public :
williamr@2
    66
williamr@2
    67
	// From MDataSource
williamr@2
    68
	virtual TFourCC SourceDataTypeCode( TMediaId aMediaId) ;
williamr@2
    69
	virtual void FillBufferL(CMMFBuffer* aBuffer, MDataSink* aConsumer,TMediaId aMediaId) ;//called by a MDataSink to request buffer fill
williamr@2
    70
	virtual void BufferEmptiedL( CMMFBuffer* aBuffer ) ;
williamr@2
    71
	virtual TBool CanCreateSourceBuffer() ;
williamr@2
    72
	virtual CMMFBuffer* CreateSourceBufferL(TMediaId aMediaId, TBool &aReference) ;
williamr@2
    73
	
williamr@2
    74
	// From MDataSink
williamr@2
    75
	virtual TFourCC SinkDataTypeCode(TMediaId aMediaId) ; //used by data path MDataSource/Sink for codec matching
williamr@2
    76
	virtual void EmptyBufferL( CMMFBuffer* aBuffer, MDataSource* aSupplier, TMediaId aMediaId ) ;
williamr@2
    77
	virtual void BufferFilledL( CMMFBuffer* aBuffer ) ;
williamr@2
    78
	virtual TBool CanCreateSinkBuffer() ;
williamr@2
    79
	virtual CMMFBuffer* CreateSinkBufferL( TMediaId aMediaId , TBool &aReference) ;
williamr@2
    80
williamr@2
    81
	// From CMMFClip
williamr@2
    82
	virtual void ReadBufferL( TInt aLength, CMMFBuffer* aBuffer, TInt aPosition, MDataSink* aConsumer);
williamr@2
    83
	virtual void WriteBufferL( TInt aLength, CMMFBuffer* aBuffer, TInt aPosition, MDataSource* aSupplier);
williamr@2
    84
	virtual void ReadBufferL( CMMFBuffer* aBuffer, TInt aPosition, MDataSink* aConsumer) ;
williamr@2
    85
	virtual void WriteBufferL( CMMFBuffer* aBuffer, TInt aPosition, MDataSource* aSupplier) ;
williamr@2
    86
	virtual void ReadBufferL( CMMFBuffer* aBuffer, TInt aPosition) ;
williamr@2
    87
	virtual void WriteBufferL( CMMFBuffer* aBuffer, TInt aPosition) ;
williamr@2
    88
	virtual TInt64 BytesFree() ;  // amount of space available for the clip
williamr@2
    89
	virtual TInt Size() ;  // length of clip
williamr@2
    90
	virtual TInt SetSize( TInt aSize ); // sets the size of the clip (used mainly by crop)
williamr@2
    91
williamr@2
    92
	// CMMFDescriptor
williamr@2
    93
	virtual ~CMMFDescriptor() ;
williamr@2
    94
	static MDataSource* NewSourceL() ; 
williamr@2
    95
	static MDataSink* NewSinkL() ; 
williamr@2
    96
williamr@2
    97
	void SetTransferBuffer (TBool aTBuffer) ;
williamr@2
    98
	TBool CanUseTransferBuffer () ;
williamr@2
    99
williamr@2
   100
protected :
williamr@2
   101
	virtual void ConstructSinkL( const TDesC8& aInitData ) ;
williamr@2
   102
	virtual void ConstructSourceL(  const TDesC8& aInitData ) ;
williamr@2
   103
	void ConstructL( const TDesC8& aInitData ) ;
williamr@2
   104
	CMMFDescriptor( ) ;
williamr@2
   105
williamr@2
   106
private :
williamr@2
   107
	// returns the Maximum length of the descriptor
williamr@2
   108
	inline TInt MaxLength() { ASSERT( iDes ); return iDes->MaxLength(); }
williamr@2
   109
williamr@2
   110
	// Need to know about the thread that the descriptor is in.
williamr@2
   111
	RThread iDesThread ;
williamr@2
   112
williamr@2
   113
	TDes8* iDes ;
williamr@2
   114
	TInt iOffset ;
williamr@2
   115
williamr@2
   116
	TFourCC  iSinkFourCC ;
williamr@2
   117
	TFourCC  iSourceFourCC ;
williamr@2
   118
williamr@2
   119
	TBool iUseTransferBuffer ;
williamr@2
   120
williamr@2
   121
	
williamr@2
   122
	} ;
williamr@2
   123
williamr@2
   124
williamr@2
   125
#endif