VISA - Alg-independent user APIs

Defines
#define	VISA_EOK   0
	Success.
#define	VISA_ERUNTIME   -1
	Internal runtime error.
#define	VISA_EFAIL   -2
	General system error.
#define	VISA_EUNSUPPORTED   -3
	The API is not suported for the given system configuration.
#define	VISA_ETIMEOUT   -100
	Timeout occurred.
#define	VISA_FOREVER   Engine_FOREVER
	Special value for timeout parameter indicating never timeout.
Typedefs
typedef Int	VISA_Status
	VISA result data type.
Functions
VISA_Status	VISA_getAlgMemRecs (VISA_Handle visa, IALG_MemRec *memTab, Int size, Int *numRecs)
	Get the IALG_MemRec memory assigned to an algorithm instance.
VISA_Status	VISA_getAlgNumRecs (VISA_Handle visa, Int *numRecs)
	Get the number of IALG_MemRecs assigned to an algorithm.
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)
UInt	VISA_getMaxMsgSize (VISA_Handle visa)
	Returns max size of messages allocated by VISA_allocMsg()
Void	_VISA_init (Void)
	Ininitilize VISA module.
Void	_VISA_exit (Void)
	Exit VISA module.
Bool	VISA_isLocal (VISA_Handle visa)
	Indicates whether VISA codecs run on a remote or local CPU.

---

Detailed Description

Codec Engine Algorithm-independent shared definitions and services.

---

Define Documentation

#define VISA_EOK   0

Success.

#define VISA_ERUNTIME   -1

Internal runtime error.

#define VISA_EFAIL   -2

General system error.

#define VISA_EUNSUPPORTED   -3

The API is not suported for the given system configuration.

#define VISA_ETIMEOUT   -100

Timeout occurred.

#define VISA_FOREVER   Engine_FOREVER

Special value for timeout parameter indicating never timeout.

---

Typedef Documentation

typedef Int VISA_Status

VISA result data type.

---

Function Documentation

VISA_Status VISA_getAlgMemRecs	(	VISA_Handle	visa,
		IALG_MemRec *	memTab,
		Int	size,
		Int *	numRecs
	)

Get the IALG_MemRec memory assigned to an algorithm instance.

Parameters:

[in]	visa	Handle to an algorithm instance.
[out]	memTab	Location to store the IALG_MemRecs.
[in]	size	Maximum number of IALG_MemRecs to put in memTab array.
[out]	numRecs	Actual number of IALG_MemRecs copied into memTab array.

Remarks:

Any algorithm instance handle (e.g. VIDDEC2_Handle, AUDDEC1_Handle, etc), can be cast to a visa handle.

Example:

      AUDDEC1_Handle decoder;

      decoder = AUDDEC1_create(...);

      ... likely use VISA_getAlgNumRecs() to alloc enough mem...

      VISA_getAlgMemRecs((VISA_Handle)decoder, ...);

Return values:

VISA_EOK	Success.
VISA_EFAIL	Failure.

See also:

VISA_getAlgNumRecs()

VISA_Status VISA_getAlgNumRecs	(	VISA_Handle	visa,
		Int *	numRecs
	)

Get the number of IALG_MemRecs assigned to an algorithm.

Parameters:

[in]	visa	Handle to an algorithm instance.
[out]	numRecs	Location to store the number of IALG_MemRecs used.

Remarks:

Any algorithm instance handle (e.g. VIDDEC2_Handle, AUDDEC1_Handle, etc), can be cast to a visa handle.

Example:

      Int numRecs;
      AUDDEC1_Handle decoder;

      decoder = AUDDEC1_create(...);

      VISA_getAlgNumRecs((VISA_Handle)decoder, &numRecs);

Return values:

VISA_EOK	Success.
VISA_EFAIL	Failure.

See also:

VISA_getAlgMemRecs()

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.

UInt VISA_getMaxMsgSize

(

VISA_Handle

visa )

Returns max size of messages allocated by VISA_allocMsg()

Return values:

maxMsgSize

Max size of messages allocated by VISA_allocMsg()

Remarks:

This is typically called by an algorithm class' stub.

See also:

VISA_allocMsg()

Void _VISA_init

(

Void

)

Ininitilize VISA module.

Remarks:

This is typically called by CERuntime_init().

See also:

_VISA_exit()

Void _VISA_exit

(

Void

)

Exit VISA module.

Remarks:

This is typically called by CERuntime_exit().

See also:

_VISA_init()

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.