Symbian^3 Application 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 TInt Configure (const TPuConfig &)
IMPORT_C TInt Create (const MMdfProcessingUnitObserver &)
IMPORT_C TInt CreateCustomInterface ( TUid )
IMPORT_C TAny * CustomInterface ( TUid )
IMPORT_C void Execute ()
IMPORT_C TInt GetConfig ( TPuConfig &)
IMPORT_C TInt GetInputPorts ( RPointerArray < MMdfInputPort > &)
IMPORT_C TInt GetOutputPorts ( RPointerArray < MMdfOutputPort > &)
IMPORT_C void Initialize ()
IMPORT_C TInt MopcEventHandler ( OMX_HANDLETYPE , OMX_EVENTTYPE , TUint32 , TUint32 , TAny *)
IMPORT_C CMMFBuffer * OmxAllocateBufferL ( TUint32 , TUint32 )
IMPORT_C TInt OmxComponentTunnelRequest ( TUint32 , OMX_HANDLETYPE , TUint32 , OMX_TUNNELSETUPTYPE *)
IMPORT_C TInt OmxEmptyThisBuffer (const CMMFBuffer *, MOmxInputPortCallbacks *)
IMPORT_C TInt OmxFillThisBuffer ( CMMFBuffer *, MOmxOutputPortCallbacks *)
IMPORT_C TInt OmxFreeBuffer ( CMMFBuffer *)
IMPORT_C TInt OmxGetComponentVersion (const TDesC8 &, OMX_VERSIONTYPE *, OMX_VERSIONTYPE *, OMX_UUIDTYPE *)
IMPORT_C TInt OmxGetConfig ( OMX_INDEXTYPE , TAny *)
IMPORT_C TInt OmxGetExtensionIndex (const TDesC8 &, OMX_INDEXTYPE *)
IMPORT_C TInt OmxGetParameter ( OMX_INDEXTYPE , TAny *)
IMPORT_C TInt OmxGetState ( OMX_STATETYPE *)
IMPORT_C TInt OmxSendCommand ( OMX_COMMANDTYPE , TUint32 , TAny *)
IMPORT_C TInt OmxSetCallbacks ( MOmxPuCallbacks &)
IMPORT_C TInt OmxSetConfig ( OMX_INDEXTYPE , TAny *)
IMPORT_C TInt OmxSetParameter ( OMX_INDEXTYPE , TAny *)
IMPORT_C TInt OmxUseBuffer ( CMMFBuffer *, TUint32 )
IMPORT_C TInt Pause ()
IMPORT_C TProcessingUnitState State ()
IMPORT_C void Stop ()
Protected Member Functions
COmxProcessingUnit ()
IMPORT_C TInt AddInputPort ( MMdfInputPort *)
IMPORT_C TInt AddOutputPort ( MMdfOutputPort *)
IMPORT_C void ConstructL (const TDesC8 &, const MMdfProcessingUnitObserver &)
IMPORT_C const MMdfProcessingUnitObserver * Observer ()
IMPORT_C void SetPuState ( 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_C COmxProcessingUnit ( ) [protected]

Default constructor.

~COmxProcessingUnit()

IMPORT_C ~COmxProcessingUnit ( )

Destructor.

Member Functions Documentation

AddInputPort(MMdfInputPort *)

IMPORT_C TInt AddInputPort ( MMdfInputPort * aInputPort ) [protected]

Add an input port to the component

Parameters

MMdfInputPort * aInputPort A pointer to the input port

AddOutputPort(MMdfOutputPort *)

IMPORT_C TInt AddOutputPort ( MMdfOutputPort * aOutputPort ) [protected]

Add an output port to the component

Parameters

MMdfOutputPort * aOutputPort A pointer to the output port

Configure(const TPuConfig &)

IMPORT_C TInt Configure ( const TPuConfig & aConfigurationSetup ) [virtual]

CMdfProcessingUnit::Configure

Parameters

const TPuConfig & aConfigurationSetup

ConstructL(const TDesC8 &, const MMdfProcessingUnitObserver &)

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

Safe constructing method.

Parameters

const TDesC8 & aComponentName The name of the component to be contructed.
const MMdfProcessingUnitObserver & aProcessingUnitObserver Reference to the obsever for this Processing Unit.

Create(const MMdfProcessingUnitObserver &)

IMPORT_C TInt Create ( const MMdfProcessingUnitObserver & aProcessingUnitObserver ) [virtual]

CMdfProcessingUnit::Create

Parameters

const MMdfProcessingUnitObserver & aProcessingUnitObserver

CreateCustomInterface(TUid)

IMPORT_C TInt CreateCustomInterface ( TUid aUid ) [virtual]

CMdfProcessingUnit::CreateCustomInterface

Parameters

TUid aUid

CustomInterface(TUid)

IMPORT_C TAny * CustomInterface ( TUid aUid ) [virtual]

CMdfProcessingUnit::CustomInterface

Parameters

TUid aUid

Execute()

IMPORT_C void Execute ( ) [virtual]

CMdfProcessingUnit::Execute

GetConfig(TPuConfig &)

IMPORT_C TInt GetConfig ( TPuConfig & aConfigurationSetup ) [virtual]

CMdfProcessingUnit::GetConfig

Parameters

TPuConfig & aConfigurationSetup

GetInputPorts(RPointerArray< MMdfInputPort > &)

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

CMdfProcessingUnit::GetInputPorts

Parameters

RPointerArray < MMdfInputPort > & aComponentInputPorts

GetOutputPorts(RPointerArray< MMdfOutputPort > &)

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

CMdfProcessingUnit::GetOutputPorts

Parameters

RPointerArray < MMdfOutputPort > & aComponentOutputPorts

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

IMPORT_C TInt MopcEventHandler ( OMX_HANDLETYPE aComponent,
OMX_EVENTTYPE aEvent,
TUint32 aData1,
TUint32 aData2,
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 ( TUint32 aPortIndex,
TUint32 aSizeBytes
)

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

Parameters

TUint32 aPortIndex The Port Index that the new buffer is associated with.
TUint32 aSizeBytes The size of the buffer to be allocated, in bytes.

OmxComponentTunnelRequest(TUint32, OMX_HANDLETYPE, TUint32, OMX_TUNNELSETUPTYPE *)

IMPORT_C TInt OmxComponentTunnelRequest ( TUint32 aPortInput,
OMX_HANDLETYPE aOutput,
TUint32 aPortOutput,
OMX_TUNNELSETUPTYPE * aTunnelSetup
)

Parameters

TUint32 aPortInput
OMX_HANDLETYPE aOutput
TUint32 aPortOutput
OMX_TUNNELSETUPTYPE * aTunnelSetup

OmxEmptyThisBuffer(const CMMFBuffer *, MOmxInputPortCallbacks *)

IMPORT_C TInt OmxEmptyThisBuffer ( const CMMFBuffer * aBuffer,
MOmxInputPortCallbacks * aObserver
)

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

Parameters

const CMMFBuffer * aBuffer The buffer to be emptied.
MOmxInputPortCallbacks * aObserver The observer of the input port that is to be notified.

OmxFillThisBuffer(CMMFBuffer *, MOmxOutputPortCallbacks *)

IMPORT_C TInt OmxFillThisBuffer ( CMMFBuffer * aBuffer,
MOmxOutputPortCallbacks * aObserver
)

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

Parameters

CMMFBuffer * aBuffer The buffer to be filled.
MOmxOutputPortCallbacks * aObserver The observer of the output port that is to be notified.

OmxFreeBuffer(CMMFBuffer *)

IMPORT_C TInt OmxFreeBuffer ( CMMFBuffer * aBuffer )

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

Parameters

CMMFBuffer * aBuffer The buffer to be freed

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

IMPORT_C TInt OmxGetComponentVersion ( 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 TInt OmxGetConfig ( OMX_INDEXTYPE aIndex,
TAny * aValue
)

Parameters

OMX_INDEXTYPE aIndex
TAny * aValue

OmxGetExtensionIndex(const TDesC8 &, OMX_INDEXTYPE *)

IMPORT_C TInt OmxGetExtensionIndex ( const TDesC8 & aParameterName,
OMX_INDEXTYPE * aIndexType
)

Parameters

const TDesC8 & aParameterName
OMX_INDEXTYPE * aIndexType

OmxGetParameter(OMX_INDEXTYPE, TAny *)

IMPORT_C TInt OmxGetParameter ( OMX_INDEXTYPE aParamIndex,
TAny * aComponentParameterStructure
)

Requests a current parameter from the OpenMAX Processing Unit.

Parameters

OMX_INDEXTYPE aParamIndex The index of the structure to be filled.
TAny * aComponentParameterStructure A pointer to structure to be filled by the component.

OmxGetState(OMX_STATETYPE *)

IMPORT_C TInt OmxGetState ( OMX_STATETYPE * aState )

Parameters

OMX_STATETYPE * aState

OmxSendCommand(OMX_COMMANDTYPE, TUint32, TAny *)

IMPORT_C TInt OmxSendCommand ( OMX_COMMANDTYPE aCmd,
TUint32 aParam1,
TAny * aCmdData
)

Sends a command to the OpenMAX Processing Unit.

Parameters

OMX_COMMANDTYPE aCmd The command for the component to execute.
TUint32 aParam1 The parameter for the command to be executed.
TAny * aCmdData A pointer to the data for the command.

OmxSetCallbacks(MOmxPuCallbacks &)

IMPORT_C TInt OmxSetCallbacks ( MOmxPuCallbacks & aPuCallbacks )

Parameters

MOmxPuCallbacks & aPuCallbacks

OmxSetConfig(OMX_INDEXTYPE, TAny *)

IMPORT_C TInt OmxSetConfig ( OMX_INDEXTYPE aIndex,
TAny * aValue
)

Parameters

OMX_INDEXTYPE aIndex
TAny * aValue

OmxSetParameter(OMX_INDEXTYPE, TAny *)

IMPORT_C TInt OmxSetParameter ( OMX_INDEXTYPE aIndex,
TAny * aComponentParameterStructure
)

Sends a parameter from the OpenMAX Processing Unit.

Parameters

OMX_INDEXTYPE aIndex The index of the structure to be sent.
TAny * aComponentParameterStructure A pointer to structure to be used by the component.

OmxUseBuffer(CMMFBuffer *, TUint32)

IMPORT_C TInt OmxUseBuffer ( CMMFBuffer * aBuffer,
TUint32 aPortIndex
)

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

Parameters

CMMFBuffer * aBuffer The buffer to be used.
TUint32 aPortIndex The port that the given buffer should be associated with.

Pause()

IMPORT_C TInt Pause ( ) [virtual]

CMdfProcessingUnit::Pause

SetPuState(TProcessingUnitState)

IMPORT_C void SetPuState ( TProcessingUnitState aState ) [protected]

Sets the internal PU State

Parameters

TProcessingUnitState aState The internal state of the component

State()

IMPORT_C TProcessingUnitState State ( ) [virtual]

CMdfProcessingUnit::State

Stop()

IMPORT_C void Stop ( ) [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.