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