Class CMMFDescriptorBuffer

class CMMFDescriptorBuffer : public CMMFDataBuffer;

Description

This class is a wrapper class to give a descriptor the same API as a CMMFDataBuffer.

The purpose of this class is that components such as codecs can use CMMFDataBuffers transparently without having to be concerned with whether the buffer is a descriptor buffer or a transfer buffer.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CMMFBuffer - Abstract representation of a buffer to contain multimedia data.

• CMMFDataBuffer - ...

• CMMFDescriptorBuffer - ...

Members

Defined in CMMFDescriptorBuffer:

• BufferSize()constReturns the actual data size (ie. not the maximum length) of the data contained ...
• Data()Returns a descriptor to the data contained in the CMMFDescriptorBuffer.
• Data()constReturns a descriptor to the data contained in the CMMFDescriptorBuffer.
• NewL()Method to instantiate a CMMFDescriptorBuffer.
• NewL(TInt)Method to instantiate a CMMFDescriptorBuffer. This NewL creates a CMMFDescriptor...
• ReAllocBufferL(TInt)Reallocates the max size in bytes of a CMMFDescriptorBuffer.
• SetPosition(TUint)Sets the position.
• SetRequestSizeL(TInt)Sets the request size.
• SetStatus(TBufferStatus)Overriden method to set the status and resets the data size to 0 when the buffer...
• ~CMMFDescriptorBuffer()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CMMFBuffer:

• CMMFBuffer(TUid)
• FrameNumber()constReturns the frame number.
• IsFileServerSafe(TUid)Static method which returns ETrue if the buffer UID is a buffer that is safe to ...
• IsSupportedDataBuffer(TUid)Static method which returns ETrue if the buffer UID is a supported CMMFDataBuffe...
• LastBuffer()constTests whether the buffer is the last buffer.
• NextFrame()Sets the buffer as the next frame.
• Position()constReturns the current buffer read/write position. Used as read/write position on a...
• RequestSize()constReturns the size of data processed by sink or data needed by source.
• SetFrameNumber(TUint)Sets the frame number. This is used for repositioning.
• SetLastBuffer(TBool)Sets the buffer as the last buffer.
• SetTimeToPlay(TTimeIntervalMicroSeconds)Sets the buffer timestamp, in microseconds.
• Status()Returns the buffer's status.
• TimeToPlay()constReturns the buffer timestamp, in microseconds.
• Type()constReturns the buffer type.
• iFrameNumberThe frame number.
• iLastBufferIndicates if this is the last buffer. ETrue if it is.
• iPositionUsed to store the current read/write position. Required when the codec and data ...
• iRequestSizeStores Request size, needed for dynamic buffer length.
• iStatusThe current buffer status.
• iTimeToPlayThe buffer timestamp, in microseconds.
• iTypeThe buffer type.

Inherited from CMMFDataBuffer:

• CMMFDataBuffer(TUid)Protected constructor.

IMPORT_C static CMMFDescriptorBuffer* NewL();

Description

Method to instantiate a CMMFDescriptorBuffer.

Defaults to a CMMFDescriptorBuffer automatically. This NewL creates a CMMFDescriptorBuffer with a default size of 32 bytes.

Return value

CMMFDescriptorBuffer * A pointer to a new CMMFDescriptorBuffer.

IMPORT_C static CMMFDescriptorBuffer* NewL(TInt aMaxBufferSize);

Description

Method to instantiate a CMMFDescriptorBuffer. This NewL creates a CMMFDescriptorBuffer with a size of aMaxBufferSize bytes.

Parameters

TInt aMaxBufferSize The size in bytes of the descriptor buffer to be created.

Return value

CMMFDescriptorBuffer * A pointer to a new CMMFDescriptorBuffer.

IMPORT_C ~CMMFDescriptorBuffer();

Description

Destructor.

Destructor also deletes the buffer contained in the CMMFDescriptorBuffer.

IMPORT_C void ReAllocBufferL(TInt aMaxBufferSize);

Description

Reallocates the max size in bytes of a CMMFDescriptorBuffer.

Parameters

TInt aMaxBufferSize The new size in bytes of the descriptor buffer.

virtual TDes8& Data();

Description

Returns a descriptor to the data contained in the CMMFDescriptorBuffer.

Return value

TDes8 & A reference to a TPtr containing the CMMFDescriptorBuffer data.

virtual const TDesC8& Data() const;

Description

Returns a descriptor to the data contained in the CMMFDescriptorBuffer.

Return value

const TDesC8 & A const reference to a TPtr containing the CMMFDescriptorBuffer data.

virtual void SetStatus(TBufferStatus aStatus);

Description

Overriden method to set the status and resets the data size to 0 when the buffer becomes available.

Parameters

TBufferStatus aStatus The buffer status. See TBufferStatus for possible options.

virtual void SetRequestSizeL(TInt aSize);

Description

Sets the request size.

This function is used in cases where a component (eg a data source) may not be able or be desirable to write to the entire max length of the buffer (eg variable bit rate codecs). In which case the CMMFDescriptorBuffer::SetRequestSizeL(TInt) can be set which can be read by the CMMFBuffer::RequestSize()const function in the component so that it knows to only write data upto the request size and not fill the buffer up to its max length.

Parameters

TInt aSize The request size.

virtual TUint BufferSize() const;

Description

Returns the actual data size (ie. not the maximum length) of the data contained in the CMMFDescriptorBuffer.

Return value

TUint The size in bytes of the data contained in the CMMFDescriptorBuffer.

virtual void SetPosition(TUint aPosition);

Description

Sets the position.

This method is used by components (eg codecs) which read data from a buffer and wish to store a read position marker for further reads. Note: The position cannot exceed the size of the actual data not the max length.

Parameters

TUint aPosition The position.