CE SPI (common)

Detailed Description

Codec Engine System Programming Interface (SPI) shared definitions.


Defines

#define VISA_EOK   0
 Success.
#define VISA_ERUNTIME   -1
 Internal runtime error.
#define VISA_EFAIL   -2
 General system error.
#define VISA_ETIMEOUT   -100
 VISA_wait() timed out.
#define VISA_FOREVER   Engine_FOREVER
 Special value for timeout parameter of VISA_wait().

Typedefs

typedef Int VISA_Status
 VISA result data type.

Functions

Void VISA_getContext (VISA_Handle visa, UInt32 *pContext)
 Get optional context parameter.
Ptr VISA_getCodecClassConfig (VISA_Handle visa)
 Get codec-specific values for the VISA class-specific (or codec-specific if the codec doesn't extend VISA) stub-and/ or-skeleton configuration data (that some classes have).
Void VISA_setContext (VISA_Handle visa, UInt32 context)
 Set optional context parameter.
Bool VISA_isLocal (VISA_Handle visa)
 Indicates whether VISA codecs run on a remote or local CPU.

Define Documentation

#define VISA_EOK   0

Success.

#define VISA_ERUNTIME   -1

Internal runtime error.

#define VISA_EFAIL   -2

General system error.

#define VISA_ETIMEOUT   -100

VISA_wait() timed out.

#define VISA_FOREVER   Engine_FOREVER

Special value for timeout parameter of VISA_wait().

Typedef Documentation

typedef Int VISA_Status

VISA result data type.

Function Documentation

Void VISA_getContext ( VISA_Handle  visa,
UInt32 *  pContext 
)

Get optional context parameter.

Parameters:
[in] visa Handle to an algorithm instance.
[out] pContext Location to store context.
Precondition:
visa must be a valid algorithm instance handle.

pContext must be a valid pointer.

Remarks:
The VISA_setContext() / VISA_getContext() pair does not work across processors. That is, the context can only be stored and retrieved on the local processor.
See also:
VISA_setContext()

Ptr VISA_getCodecClassConfig ( VISA_Handle  visa  ) 

Get codec-specific values for the VISA class-specific (or codec-specific if the codec doesn't extend VISA) stub-and/ or-skeleton configuration data (that some classes have).

Parameters:
[in] visa Handle to an algorithm instance.
Return values:
address of the codec class config data structure, or NULL if codec class config data not defined for the codec; the format of the structure is class-specific, and the data in it is codec- specific
Precondition:
visa must be a valid algorithm instance handle.

Void VISA_setContext ( VISA_Handle  visa,
UInt32  context 
)

Set optional context parameter.

Parameters:
[in] visa Handle to an algorithm instance.
[in] context Context.
Precondition:
visa must be a valid algorithm instance handle.
Remarks:
The VISA_setContext() / VISA_getContext() pair does not work across processors. That is, the context can only be stored and retrieved on the local processor.
See also:
VISA_getContext()

Bool VISA_isLocal ( VISA_Handle  visa  ) 

Indicates whether VISA codecs run on a remote or local CPU.

Return values:
false VISA codecs run on remote CPU
true VISA codecs run on local CPU
Remarks:
This is typically called by an algorithm class' stub.

Copyright 2008, Texas Instruments Incorporated