Symbian^3 Product Developer Library >

COmxProcessingUnit Class Reference

class COmxProcessingUnit : public CMdfProcessingUnit

OpenMAX Processing Unit class.

Inherits from

Nested Classes and Structures

Public Member Functions
~COmxProcessingUnit()
IMPORT_C TIntConfigure(const TPuConfig &)
IMPORT_C TIntCreate(const MMdfProcessingUnitObserver &)
IMPORT_C TIntCreateCustomInterface(TUid)
IMPORT_C TAny *CustomInterface(TUid)
IMPORT_C voidExecute()
IMPORT_C TIntGetConfig(TPuConfig &)
IMPORT_C TIntGetInputPorts(RPointerArray< MMdfInputPort > &)
IMPORT_C TIntGetOutputPorts(RPointerArray< MMdfOutputPort > &)
IMPORT_C voidInitialize()
IMPORT_C TIntMopcEventHandler(OMX_HANDLETYPE, OMX_EVENTTYPE, TUint32, TUint32, TAny *)
IMPORT_C CMMFBuffer *OmxAllocateBufferL(TUint32, TUint32)
IMPORT_C TIntOmxComponentTunnelRequest(TUint32, OMX_HANDLETYPE, TUint32, OMX_TUNNELSETUPTYPE *)
IMPORT_C TIntOmxEmptyThisBuffer(const CMMFBuffer *, MOmxInputPortCallbacks *)
IMPORT_C TIntOmxFillThisBuffer(CMMFBuffer *, MOmxOutputPortCallbacks *)
IMPORT_C TIntOmxFreeBuffer(CMMFBuffer *)
IMPORT_C TIntOmxGetComponentVersion(const TDesC8 &, OMX_VERSIONTYPE *, OMX_VERSIONTYPE *, OMX_UUIDTYPE *)
IMPORT_C TIntOmxGetConfig(OMX_INDEXTYPE, TAny *)
IMPORT_C TIntOmxGetExtensionIndex(const TDesC8 &, OMX_INDEXTYPE *)
IMPORT_C TIntOmxGetParameter(OMX_INDEXTYPE, TAny *)
IMPORT_C TIntOmxGetState(OMX_STATETYPE *)
IMPORT_C TIntOmxSendCommand(OMX_COMMANDTYPE, TUint32, TAny *)
IMPORT_C TIntOmxSetCallbacks(MOmxPuCallbacks &)
IMPORT_C TIntOmxSetConfig(OMX_INDEXTYPE, TAny *)
IMPORT_C TIntOmxSetParameter(OMX_INDEXTYPE, TAny *)
IMPORT_C TIntOmxUseBuffer(CMMFBuffer *, TUint32)
IMPORT_C TIntPause()
IMPORT_C TProcessingUnitStateState()
IMPORT_C voidStop()
Protected Member Functions
COmxProcessingUnit()
IMPORT_C TIntAddInputPort(MMdfInputPort *)
IMPORT_C TIntAddOutputPort(MMdfOutputPort *)
IMPORT_C voidConstructL(const TDesC8 &, const MMdfProcessingUnitObserver &)
IMPORT_C const MMdfProcessingUnitObserver *Observer()
IMPORT_C voidSetPuState(TProcessingUnitState)
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()
CMdfProcessingUnit::NewL(TUid)
CMdfProcessingUnit::~CMdfProcessingUnit()
Private Attributes
CBody *iBody

Constructor & Destructor Documentation

COmxProcessingUnit()

IMPORT_CCOmxProcessingUnit()[protected]

Default constructor.

~COmxProcessingUnit()

IMPORT_C~COmxProcessingUnit()

Destructor.

Member Functions Documentation

AddInputPort(MMdfInputPort *)

IMPORT_C TIntAddInputPort(MMdfInputPort *aInputPort)[protected]

Add an input port to the component

Parameters

MMdfInputPort * aInputPortA pointer to the input port

AddOutputPort(MMdfOutputPort *)

IMPORT_C TIntAddOutputPort(MMdfOutputPort *aOutputPort)[protected]

Add an output port to the component

Parameters

MMdfOutputPort * aOutputPortA pointer to the output port

Configure(const TPuConfig &)

IMPORT_C TIntConfigure(const TPuConfig &aConfigurationSetup)[virtual]

CMdfProcessingUnit::Configure

Parameters

const TPuConfig & aConfigurationSetup

ConstructL(const TDesC8 &, const MMdfProcessingUnitObserver &)

IMPORT_C voidConstructL(const TDesC8 &aComponentName,
const MMdfProcessingUnitObserver &aProcessingUnitObserver
)[protected]

Safe constructing method.

Parameters

const TDesC8 & aComponentNameThe name of the component to be contructed.
const MMdfProcessingUnitObserver & aProcessingUnitObserverReference to the obsever for this Processing Unit.

Create(const MMdfProcessingUnitObserver &)

IMPORT_C TIntCreate(const MMdfProcessingUnitObserver &aProcessingUnitObserver)[virtual]

CMdfProcessingUnit::Create

Parameters

const MMdfProcessingUnitObserver & aProcessingUnitObserver

CreateCustomInterface(TUid)

IMPORT_C TIntCreateCustomInterface(TUidaUid)[virtual]

CMdfProcessingUnit::CreateCustomInterface

Parameters

TUid aUid

CustomInterface(TUid)

IMPORT_C TAny *CustomInterface(TUidaUid)[virtual]

CMdfProcessingUnit::CustomInterface

Parameters

TUid aUid

Execute()

IMPORT_C voidExecute()[virtual]

CMdfProcessingUnit::Execute

GetConfig(TPuConfig &)

IMPORT_C TIntGetConfig(TPuConfig &aConfigurationSetup)[virtual]

CMdfProcessingUnit::GetConfig

Parameters

TPuConfig & aConfigurationSetup

GetInputPorts(RPointerArray< MMdfInputPort > &)

IMPORT_C TIntGetInputPorts(RPointerArray< MMdfInputPort > &aComponentInputPorts)[virtual]

CMdfProcessingUnit::GetInputPorts

Parameters

RPointerArray< MMdfInputPort > & aComponentInputPorts

GetOutputPorts(RPointerArray< MMdfOutputPort > &)

IMPORT_C TIntGetOutputPorts(RPointerArray< MMdfOutputPort > &aComponentOutputPorts)[virtual]

CMdfProcessingUnit::GetOutputPorts

Parameters

RPointerArray< MMdfOutputPort > & aComponentOutputPorts

MopcEventHandler(OMX_HANDLETYPE, OMX_EVENTTYPE, TUint32, TUint32, TAny *)

IMPORT_C TIntMopcEventHandler(OMX_HANDLETYPEaComponent,
OMX_EVENTTYPEaEvent,
TUint32aData1,
TUint32aData2,
TAny *aExtraInfo
)

Parameters

OMX_HANDLETYPE aComponent
OMX_EVENTTYPE aEvent
TUint32 aData1
TUint32 aData2
TAny * aExtraInfo

Observer()

IMPORT_C const MMdfProcessingUnitObserver *Observer()[protected]

Return the observer interface for the component

OmxAllocateBufferL(TUint32, TUint32)

IMPORT_C CMMFBuffer *OmxAllocateBufferL(TUint32aPortIndex,
TUint32aSizeBytes
)

Instructs the OpenMAX Processing Unit to allocate a buffer. Ownership is transferred to the caller.

Parameters

TUint32 aPortIndexThe Port Index that the new buffer is associated with.
TUint32 aSizeBytesThe size of the buffer to be allocated, in bytes.

OmxComponentTunnelRequest(TUint32, OMX_HANDLETYPE, TUint32, OMX_TUNNELSETUPTYPE *)

IMPORT_C TIntOmxComponentTunnelRequest(TUint32aPortInput,
OMX_HANDLETYPEaOutput,
TUint32aPortOutput,
OMX_TUNNELSETUPTYPE *aTunnelSetup
)

Parameters

TUint32 aPortInput
OMX_HANDLETYPE aOutput
TUint32 aPortOutput
OMX_TUNNELSETUPTYPE * aTunnelSetup

OmxEmptyThisBuffer(const CMMFBuffer *, MOmxInputPortCallbacks *)

IMPORT_C TIntOmxEmptyThisBuffer(const CMMFBuffer *aBuffer,
MOmxInputPortCallbacks *aObserver
)

Sends an full buffer to an input port of a component.

Parameters

const CMMFBuffer * aBufferThe buffer to be emptied.
MOmxInputPortCallbacks * aObserverThe observer of the input port that is to be notified.

OmxFillThisBuffer(CMMFBuffer *, MOmxOutputPortCallbacks *)

IMPORT_C TIntOmxFillThisBuffer(CMMFBuffer *aBuffer,
MOmxOutputPortCallbacks *aObserver
)

Sends an empty buffer to an output port of a component.

Parameters

CMMFBuffer * aBufferThe buffer to be filled.
MOmxOutputPortCallbacks * aObserverThe observer of the output port that is to be notified.

OmxFreeBuffer(CMMFBuffer *)

IMPORT_C TIntOmxFreeBuffer(CMMFBuffer *aBuffer)

Instructs the OpenMAX Processing Unit to free the buffer passed in the function's argument.

Parameters

CMMFBuffer * aBufferThe buffer to be freed

OmxGetComponentVersion(const TDesC8 &, OMX_VERSIONTYPE *, OMX_VERSIONTYPE *, OMX_UUIDTYPE *)

IMPORT_C TIntOmxGetComponentVersion(const TDesC8 &aComponentName,
OMX_VERSIONTYPE *aComponentVersion,
OMX_VERSIONTYPE *aSpecVersion,
OMX_UUIDTYPE *aComponentUUID
)

Parameters

const TDesC8 & aComponentName
OMX_VERSIONTYPE * aComponentVersion
OMX_VERSIONTYPE * aSpecVersion
OMX_UUIDTYPE * aComponentUUID

OmxGetConfig(OMX_INDEXTYPE, TAny *)

IMPORT_C TIntOmxGetConfig(OMX_INDEXTYPEaIndex,
TAny *aValue
)

Parameters

OMX_INDEXTYPE aIndex
TAny * aValue

OmxGetExtensionIndex(const TDesC8 &, OMX_INDEXTYPE *)

IMPORT_C TIntOmxGetExtensionIndex(const TDesC8 &aParameterName,
OMX_INDEXTYPE *aIndexType
)

Parameters

const TDesC8 & aParameterName
OMX_INDEXTYPE * aIndexType

OmxGetParameter(OMX_INDEXTYPE, TAny *)

IMPORT_C TIntOmxGetParameter(OMX_INDEXTYPEaParamIndex,
TAny *aComponentParameterStructure
)

Requests a current parameter from the OpenMAX Processing Unit.

Parameters

OMX_INDEXTYPE aParamIndexThe index of the structure to be filled.
TAny * aComponentParameterStructureA pointer to structure to be filled by the component.

OmxGetState(OMX_STATETYPE *)

IMPORT_C TIntOmxGetState(OMX_STATETYPE *aState)

Parameters

OMX_STATETYPE * aState

OmxSendCommand(OMX_COMMANDTYPE, TUint32, TAny *)

IMPORT_C TIntOmxSendCommand(OMX_COMMANDTYPEaCmd,
TUint32aParam1,
TAny *aCmdData
)

Sends a command to the OpenMAX Processing Unit.

Parameters

OMX_COMMANDTYPE aCmdThe command for the component to execute.
TUint32 aParam1The parameter for the command to be executed.
TAny * aCmdDataA pointer to the data for the command.

OmxSetCallbacks(MOmxPuCallbacks &)

IMPORT_C TIntOmxSetCallbacks(MOmxPuCallbacks &aPuCallbacks)

Parameters

MOmxPuCallbacks & aPuCallbacks

OmxSetConfig(OMX_INDEXTYPE, TAny *)

IMPORT_C TIntOmxSetConfig(OMX_INDEXTYPEaIndex,
TAny *aValue
)

Parameters

OMX_INDEXTYPE aIndex
TAny * aValue

OmxSetParameter(OMX_INDEXTYPE, TAny *)

IMPORT_C TIntOmxSetParameter(OMX_INDEXTYPEaIndex,
TAny *aComponentParameterStructure
)

Sends a parameter from the OpenMAX Processing Unit.

Parameters

OMX_INDEXTYPE aIndexThe index of the structure to be sent.
TAny * aComponentParameterStructureA pointer to structure to be used by the component.

OmxUseBuffer(CMMFBuffer *, TUint32)

IMPORT_C TIntOmxUseBuffer(CMMFBuffer *aBuffer,
TUint32aPortIndex
)

Instructs the OpenMAX Processing Unit to use the buffer passed in the function's argument.

Parameters

CMMFBuffer * aBufferThe buffer to be used.
TUint32 aPortIndexThe port that the given buffer should be associated with.

Pause()

IMPORT_C TIntPause()[virtual]

CMdfProcessingUnit::Pause

SetPuState(TProcessingUnitState)

IMPORT_C voidSetPuState(TProcessingUnitStateaState)[protected]

Sets the internal PU State

Parameters

TProcessingUnitState aStateThe internal state of the component

State()

IMPORT_C TProcessingUnitStateState()[virtual]

CMdfProcessingUnit::State

Stop()

IMPORT_C voidStop()[virtual]

CMdfProcessingUnit::Stop

Member Data Documentation

CBody * iBody

CBody *iBody[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.