CMMFFormatEncode Class Reference

#include <mmf/server/mmfformat.h>

Link against: mmfserverbaseclasses.lib

class CMMFFormatEncode : public CBase

Inherits from

CMMFFormatEncode

Protected Attributes
MDataSink *	iClip
MDataSource *	iDataPath

Public Member Functions
virtual	~CMMFFormatEncode()
virtual void	AddMetaDataEntryL(const CMMFMetaDataEntry &)
virtual TUint	BitRate()
virtual void	BufferEmptiedL(CMMFBuffer *)
virtual void	BufferFilledL(CMMFBuffer *)
virtual TInt64	BytesPerSecond()
virtual TBool	CanCreateSinkBuffer()
virtual TBool	CanCreateSourceBuffer()
pure virtual CMMFBuffer *	CreateSinkBufferL(TMediaId, TBool &)
virtual CMMFBuffer *	CreateSourceBufferL(TMediaId, TBool &)
virtual void	CropL(TTimeIntervalMicroSeconds, TBool)
pure virtual TTimeIntervalMicroSeconds	Duration(TMediaId)
pure virtual void	EmptyBufferL(CMMFBuffer , MDataSource , TMediaId)
virtual void	FillBufferL(CMMFBuffer , MDataSink , TMediaId)
pure virtual TTimeIntervalMicroSeconds	FrameTimeInterval(TMediaId)
virtual TUint	GetDefaultSampleRate()
virtual void	GetNumberOfMetaDataEntriesL(TInt &)
virtual void	GetSupportedBitRatesL(RArray< TUint > &)
virtual void	GetSupportedDataTypesL(TMediaId, RArray< TFourCC > &)
virtual void	GetSupportedNumChannelsL(RArray< TUint > &)
virtual void	GetSupportedSampleRatesL(RArray< TUint > &)
TUid	ImplementationUid()
virtual TInt	MaximumClipSize()
virtual CMMFMetaDataEntry *	MetaDataEntryL(TInt)
IMPORT_C CMMFFormatEncode *	NewL(TUid, MDataSink *)
IMPORT_C CMMFFormatEncode *	NewL(const TDesC &, MDataSink *, const TDesC &)
IMPORT_C CMMFFormatEncode *	NewL(const TDesC8 &, MDataSink *, const TDesC &)
IMPORT_C CMMFFormatEncode *	NewL(MDataSink *, const TDesC &)
virtual TUint	NumChannels()
virtual TTimeIntervalMicroSeconds	PositionL()
virtual TInt	RemoveMetaDataEntry(TInt)
virtual void	ReplaceMetaDataEntryL(TInt, const CMMFMetaDataEntry &)
virtual TUint	SampleRate()
virtual TInt	SetBitRate(TUint)
virtual void	SetMaximumClipSizeL(TInt)
virtual TInt	SetNumChannels(TUint)
virtual void	SetPositionL(const TTimeIntervalMicroSeconds &)
virtual TInt	SetSampleRate(TUint)
pure virtual TFourCC	SinkDataTypeCode(TMediaId)
virtual TFourCC	SourceDataTypeCode(TMediaId)

Protected Member Functions
	CMMFFormatEncode()
virtual void	ConstructSinkL(const TDesC8 &)
virtual void	ConstructSourceL(const TDesC8 &)
CMMFFormatEncode *	CreateFormatL(TUid, MDataSink *)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Base class from which sink formats can be derived from.

The intended usage is for controllers that can support more than one type of format. The class is an MDataSink as far as the data path is concerned but is an MDataSource to the clip that is the sink of the actual data. All CMMFFormatEncode plugin DLLs must include interface_uid = KMmfUidPluginInterfaceFormatEncode in their .rss files.

Member Attribute Documentation

iClip

MDataSink *

iClip

[protected]

The clip is the sink for the encode format.

iDataPath

MDataSource *

iDataPath

[protected]

The Data path is the source for the encode format.

Constructor & Destructor Documentation

CMMFFormatEncode ( )

CMMFFormatEncode

(

)

[protected, inline]

Default constructor

~CMMFFormatEncode ( )

~CMMFFormatEncode

(

)

[inline, virtual]

Destructor.

Member Function Documentation

AddMetaDataEntryL ( const CMMFMetaDataEntry & )

void

AddMetaDataEntryL

(

const CMMFMetaDataEntry &

aNewEntry

)

[inline, virtual]

Adds the specified meta data entry to the clip.

The default implementation leaves with KErrNotSupported.

Parameter	Description
aNewEntry	The meta data entry to add.

BitRate ( )

TUint

BitRate

(

)

[inline, virtual]

Returns the bit rate.

The default returns 0.

Returns: The bit rate.

BufferEmptiedL ( CMMFBuffer * )

void

BufferEmptiedL

(

CMMFBuffer *

aBuffer

)

[inline, virtual]

Called by the clip when it has added the data to the file.

Parameter	Description
aBuffer	The emptied buffer.

BufferFilledL ( CMMFBuffer * )

void

BufferFilledL

(

CMMFBuffer *

aBuffer

)

[inline, virtual]

Called by the CMMFDataPath's MDataSource when it has filled the buffer.

Parameter	Description
aBuffer	The buffer that has been filled.

BytesPerSecond ( )

TInt64

BytesPerSecond

(

)

[inline, virtual]

Returns the bytes per second.

The default returns 0.

Returns: The bytes per second.

CanCreateSinkBuffer ( )

TBool

CanCreateSinkBuffer

(

)

[inline, virtual]

Tests whether a sink buffer can be created.

Format would normally pass its own buffer onto the CMMFClip, so this may not be required. The default returns ETrue.

Returns: A boolean indicating if the buffer can be created. ETrue if buffer can be created, EFalse otherwise.

CanCreateSourceBuffer ( )

TBool

CanCreateSourceBuffer

(

)

[inline, virtual]

Tests whether a source buffer can be created.

The default implementation returns EFalse.

Returns: A boolean indicating if the buffer can be created. ETrue if buffer can be created, EFalse otherwise.

ConstructSinkL ( const TDesC8 & )

void

ConstructSinkL

(

const TDesC8 &

)

[protected, inline, virtual]

ConstructSourceL ( const TDesC8 & )

void

ConstructSourceL

(

const TDesC8 &

)

[protected, inline, virtual]

CreateFormatL ( TUid, MDataSink * )

CMMFFormatEncode *	CreateFormatL	(	TUid	aImplementationUid,
			MDataSink *	aSink
		)	[protected, static]

CreateSinkBufferL ( TMediaId, TBool & )

CMMFBuffer *	CreateSinkBufferL	(	TMediaId	aMediaId,
			TBool &	aReference
		)	[pure virtual]

Creates a sink buffer for the specified media ID.

This is a virtual function that each derived class must implement.

Parameter	Description
aMediaId	The media type ID.
aReference	If ETrue then MDataSink owns the buffer. If EFalse, then the caller owns the buffer.

Returns: A pointer to the CMMFBuffer sink buffer.

CreateSourceBufferL ( TMediaId, TBool & )

CMMFBuffer *	CreateSourceBufferL	(	TMediaId	aMediaId,
			TBool &	aReference
		)	[inline, virtual]

Creates a source buffer. The default returns NULL.

Parameter	Description
aMediaId	The media type id.
aReference	If ETrue the MDataSource owns the buffer. If EFalse, then the caller owns the buffer.

Returns: Source buffer.

CropL ( TTimeIntervalMicroSeconds, TBool )

void	CropL	(	TTimeIntervalMicroSeconds	aPosition,
			TBool	aToEnd = ETrue
		)	[inline, virtual]

This function is used to truncate the sink ie. a CMMFClip,

If aToEnd = ETrue the sink is cropped from the aPosition to the end of the clip. If aToEnd = EFalse then the sink is cropped from the start of the clip to aPosition.

This function would be called by the CMMFController. The default implementation leaves with KErrNotSupported.

Parameter	Description
aPosition	The position within the clip.
aToEnd	Flag to determine which part of the clip to delete.

Duration ( TMediaId )

TTimeIntervalMicroSeconds

Duration

(

TMediaId

aMediaType

)

const [pure virtual]

Returns the duration of the sink clip for the specified media type.

This is a virtual function that each derived class must implement.

Parameter	Description
aMediaType	The media type ID.

Returns: The duration of the sink clip.

EmptyBufferL ( CMMFBuffer , MDataSource , TMediaId )

void	EmptyBufferL	(	CMMFBuffer *	aBuffer,
			MDataSource *	aSupplier,
			TMediaId	aMediaId
		)	[pure virtual]

Adds a buffer to a clip.

Called by CMMFDataPath. (from MDataSink - CMMFFormatEncode is a MDataSink to a CMMFDataPath)

This is a virtual function that each derived class must implement.

Parameter	Description
aBuffer	The buffer to which the clip is added.
aSupplier	The data source.
aMediaId	The media type ID.

FillBufferL ( CMMFBuffer , MDataSink , TMediaId )

void	FillBufferL	(	CMMFBuffer *	aBuffer,
			MDataSink *	aConsumer,
			TMediaId	aMediaId
		)	[inline, virtual]

Request from CMMFDataPath to fill the specified buffer.

Parameter	Description
aBuffer	The buffer to fill.
aConsumer	The consumer.
aMediaId	The media ID.

FrameTimeInterval ( TMediaId )

TTimeIntervalMicroSeconds

FrameTimeInterval

(

TMediaId

aMediaType

)

const [pure virtual]

Returns the time interval for one frame for the specified media type.

This is a virtual function that each derived class must implement.

Parameter	Description
aMediaType	The media type ID.

Returns: The frame time interval in microseconds.

GetDefaultSampleRate ( )

TUint

GetDefaultSampleRate

(

)

[inline, virtual]

Returns the default sample rate.

The default returns 0.

Returns: The default sample rate.

GetNumberOfMetaDataEntriesL ( TInt & )

void

GetNumberOfMetaDataEntriesL

(

TInt &

aNumberOfEntries

)

[inline, virtual]

Gets the number of meta data entries.

The encode format is capable of reading and writing meta data to the clip.

The default implementation leaves with KErrNotSupported.

Parameter	Description
aNumberOfEntries	On return, contains the number of meta data entries.

GetSupportedBitRatesL ( RArray< TUint > & )

void

GetSupportedBitRatesL

(

RArray< TUint > &

aBitRates

)

[inline, virtual]

Gets the supported bit rates.

The default implementation leaves with KErrNotSupported.

Parameter	Description
aBitRates	A reference to an array of supported bit rates.

GetSupportedDataTypesL ( TMediaId, RArray< TFourCC > & )

void	GetSupportedDataTypesL	(	TMediaId	aMediaId,
			RArray< TFourCC > &	aDataTypes
		)	[inline, virtual]

Gets the supported data types for the given media type ID.

The default implementation leaves with KErrNotSupported.

Parameter	Description
aMediaId	The media type id.
aDataTypes	A reference to an array of supported data types.

GetSupportedNumChannelsL ( RArray< TUint > & )

void

GetSupportedNumChannelsL

(

RArray< TUint > &

aNumChannels

)

[inline, virtual]

Gets the supported number of channels.

The default implementation leaves with KErrNotSupported.

Parameter	Description
aNumChannels	A reference to an array of supported number of channels.

GetSupportedSampleRatesL ( RArray< TUint > & )

void

GetSupportedSampleRatesL

(

RArray< TUint > &

aSampleRates

)

[inline, virtual]

Gets the supported sample rates.

The default implementation leaves with KErrNotSupported.

Parameter	Description
aSampleRates	A reference to an array of supported sample rates.

ImplementationUid ( )

TUid

ImplementationUid

(

)

const [inline]

Gets the ECom plugin UID of this format.

Returns: The plugin UID.

MaximumClipSize ( )

TInt

MaximumClipSize

(

)

[inline, virtual]

Returns the maximum clip size.

The default returns 0.

Returns: The maximum clip size.

MetaDataEntryL ( TInt )

CMMFMetaDataEntry *

MetaDataEntryL

(

TInt

aIndex

)

[inline, virtual]

Returns the specified meta data entry.

The default implementation leaves with KErrNotSupported.

Parameter	Description
aIndex	The zero based meta data entry index to retrieve.

Returns: The meta data entry.

NewL ( TUid, MDataSink * )

IMPORT_C CMMFFormatEncode *	NewL	(	TUid	aUid,
			MDataSink *	aSink
		)	[static]

Allocates and constructs an ECom format encode object.

Parameter	Description
aUid	The implementation UID.
aSink	The data sink.

Returns: If successful, returns the address of the format decode plugin object created. If not successful, leaves with KErrNotFound.

NewL ( const TDesC &, MDataSink *, const TDesC & )

IMPORT_C CMMFFormatEncode *	NewL	(	const TDesC &	aFileName,
			MDataSink *	aSink,
			const TDesC &	aPreferredSupplier
		)	[static]

Attempts to locate and instantiate a CMMFFormatEncode using a filename or an extension.

Only the extension of the supplied file name is used. If no extension is supplied (ie. no dot is present) the whole of the filename will be treated as the extension.

Parameter	Description
aFileName	File name of target file. May be extension only or may include the full path.
aSink	The data source.
aPreferredSupplier	If this is provided, the list of matching plugins will be further searched for the latest version of a plugin supplied by supplier named.

Returns: If successful, returns the address of the format decode plugin object created. If not successful, leaves with KErrNotFound.

NewL ( const TDesC8 &, MDataSink *, const TDesC & )

IMPORT_C CMMFFormatEncode *	NewL	(	const TDesC8 &	aSourceHeader,
			MDataSink *	aSink,
			const TDesC &	aPreferredSupplier
		)	[static]

Attempts to locate and instantiate a CMMFFormatEncode using data in the specified buffer.

The buffer is expected to contain header data (from a file, stream or descriptor). Signatures (supplied by the plugin registry information) are sought in aSourceHeader.

Parameter	Description
aSourceHeader	The data which is searched for matching signatures.
aSink	The data sink.
aPreferredSupplier	If this is provided the list of matching plugins will be further searched for the latest version of a plugin supplied by supplier named.

Returns: If successful, returns the address of the format decode plugin object created. If not successful, leaves with KErrNotFound.

NewL ( MDataSink *, const TDesC & )

IMPORT_C CMMFFormatEncode *	NewL	(	MDataSink *	aSink,
			const TDesC &	aPreferredSupplier
		)	[static]

Attempts to locate and instantiate a CMMFFormatEncode using data from aSink.

The data is expected to contain header data (from a file, stream or descriptor). Signatures (supplied by the plugin registry information) are sought in the source header.

Parameter	Description
aSink	The header data. Must be derived from CMMFClip.
aPreferredSupplier	If this is provided, the list of matching plugins will be further searched for the latest version of a plugin supplied by supplier specified.

Returns: If successful, returns the address of the format decode plugin object created. If not successful, leaves with KErrNotFound.

NumChannels ( )

TUint

NumChannels

(

)

[inline, virtual]

Returns the number of channels.

The default implementation returns 0.

Returns: The number of channels.

PositionL ( )

TTimeIntervalMicroSeconds

PositionL

(

)

[inline, virtual]

Supplies the current position.

Subsequent data reads will commence from this position.

Returns: The current position in microseconds.

RemoveMetaDataEntry ( TInt )

TInt

RemoveMetaDataEntry

(

TInt

aIndex

)

[inline, virtual]

Removes the specified meta data entry.

The default implementation returns KErrNotSupported.

Parameter	Description
aIndex	The zero based meta data entry index to remove.

Returns: An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

ReplaceMetaDataEntryL ( TInt, const CMMFMetaDataEntry & )

void	ReplaceMetaDataEntryL	(	TInt	aIndex,
			const CMMFMetaDataEntry &	aNewEntry
		)	[inline, virtual]

Replaces the specified meta data entry with the entry supplied in aNewEntry.

The default implementation leaves with KErrNotSupported.

Parameter	Description
aIndex	The zero based meta data entry index to replace.
aNewEntry	The meta data entry to replace.

SampleRate ( )

TUint

SampleRate

(

)

[inline, virtual]

Returns the sample rate.

The default implementation returns 0.

Returns: The sample rate.

SetBitRate ( TUint )

TInt

SetBitRate

(

TUint

aBitRate

)

[inline, virtual]

Sets the bit rate.

The default implementation returns KErrNotSupported.

Parameter	Description
aBitRate	The bit rate.

Returns: An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

SetMaximumClipSizeL ( TInt )

void

SetMaximumClipSizeL

(

TInt

aBytes

)

[inline, virtual]

Sets the maximum clip size.

The default implementation leaves with KErrNotSupported.

Parameter	Description
aBytes	The maximum clip size.

SetNumChannels ( TUint )

TInt

SetNumChannels

(

TUint

aChannels

)

[inline, virtual]

Sets the number of channels.

The default implementation returns KErrNotSupported.

Parameter	Description
aChannels	The number of channels.

Returns: An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

SetPositionL ( const TTimeIntervalMicroSeconds & )

void

SetPositionL

(

const TTimeIntervalMicroSeconds &

aPosition

)

[inline, virtual]

Used to set the format's position.

Subsequent data reads should ignore the FrameNumber in the CMMFBuffer and use this setting to determine what data to provide.

The actual position the format sets itself may vary to this setting to ensure that it is aligned to the sample boundaries ensuring consistent data output.

If not supported, positional information should be extracted from the FrameNumber in CMMFBuffer

Parameter	Description
aPosition	The position the format should use.

SetSampleRate ( TUint )

TInt

SetSampleRate

(

TUint

aSampleRate

)

[inline, virtual]

Sets the sample rate.

The default implementation returns KErrNotSupported.

Parameter	Description
aSampleRate	The sample rate.

Returns: An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

SinkDataTypeCode ( TMediaId )

TFourCC

SinkDataTypeCode

(

TMediaId

aMediaId

)

[pure virtual]

Returns the sink data type code for the specified media type ID.

This would be the same as the source data type four CC although the clip is not going to need this info.

This is a virtual function that each derived class must implement.

Parameter	Description
aMediaId	The media type ID.

Returns: The sink data type code.

SourceDataTypeCode ( TMediaId )

TFourCC

SourceDataTypeCode

(

TMediaId

aMediaId

)

[inline, virtual]

Returns the source data type code for the specified media type ID.

This is a virtual function that each derived class must implement.

Parameter	Description
aMediaId	The media type id.

Returns: The source data type code.

CMMFFormatEncode Class Reference

Inherits from

Detailed Description

Member Attribute Documentation

iClip

iDataPath

Constructor & Destructor Documentation

CMMFFormatEncode ( )

~CMMFFormatEncode ( )

Member Function Documentation

AddMetaDataEntryL ( const CMMFMetaDataEntry & )

BitRate ( )

BufferEmptiedL ( CMMFBuffer * )

BufferFilledL ( CMMFBuffer * )

BytesPerSecond ( )

CanCreateSinkBuffer ( )

CanCreateSourceBuffer ( )

ConstructSinkL ( const TDesC8 & )

ConstructSourceL ( const TDesC8 & )

CreateFormatL ( TUid, MDataSink * )

CreateSinkBufferL ( TMediaId, TBool & )

CreateSourceBufferL ( TMediaId, TBool & )

CropL ( TTimeIntervalMicroSeconds, TBool )

Duration ( TMediaId )

EmptyBufferL ( CMMFBuffer *, MDataSource *, TMediaId )

FillBufferL ( CMMFBuffer *, MDataSink *, TMediaId )

FrameTimeInterval ( TMediaId )

GetDefaultSampleRate ( )

GetNumberOfMetaDataEntriesL ( TInt & )

GetSupportedBitRatesL ( RArray< TUint > & )

GetSupportedDataTypesL ( TMediaId, RArray< TFourCC > & )

GetSupportedNumChannelsL ( RArray< TUint > & )

GetSupportedSampleRatesL ( RArray< TUint > & )

ImplementationUid ( )

MaximumClipSize ( )

MetaDataEntryL ( TInt )

NewL ( TUid, MDataSink * )

NewL ( const TDesC &, MDataSink *, const TDesC & )

NewL ( const TDesC8 &, MDataSink *, const TDesC & )

NewL ( MDataSink *, const TDesC & )

NumChannels ( )

PositionL ( )

RemoveMetaDataEntry ( TInt )

ReplaceMetaDataEntryL ( TInt, const CMMFMetaDataEntry & )

SampleRate ( )

SetBitRate ( TUint )

SetMaximumClipSizeL ( TInt )

SetNumChannels ( TUint )

SetPositionL ( const TTimeIntervalMicroSeconds & )

SetSampleRate ( TUint )

SinkDataTypeCode ( TMediaId )

SourceDataTypeCode ( TMediaId )

EmptyBufferL ( CMMFBuffer , MDataSource , TMediaId )

FillBufferL ( CMMFBuffer , MDataSink , TMediaId )