auddec1.h File Reference

---

Detailed Description

The AUDDEC1 audio decoder interface. Provides the user an interface to create and interact with XDAIS algorithms that are compliant with the XDM-defined IAUDDEC1 audio decoder interface.

#include <ti/xdais/dm/xdm.h>
#include <ti/xdais/dm/iauddec1.h>
#include <ti/sdo/ce/Engine.h>
#include <ti/sdo/ce/visa.h>
#include <ti/sdo/ce/skel.h>

Include dependency graph for auddec1.h:

Go to the source code of this file.

Macros
#define	AUDDEC1_EOK   IAUDDEC1_EOK
#define	AUDDEC1_EFAIL   IAUDDEC1_EFAIL
#define	AUDDEC1_EUNSUPPORTED   IAUDDEC1_EUNSUPPORTED
#define	AUDDEC1_ETIMEOUT   VISA_ETIMEOUT
	Timeout occurred.
#define	AUDDEC1_FOREVER   VISA_FOREVER
	Special value for timeout parameter indicating never timeout.
#define	AUDDEC1_VISATYPE   "ti.sdo.ce.audio1.IAUDDEC1"
	The VISA type.
#define	AUDDEC1_STUBSNAME   "AUDDEC1_STUBS"
	Name of stub functions. Use this name when registering the AUDDEC1_STUBS functions with Engine_addStubFxns.

Typedefs
typedef VISA_Handle	AUDDEC1_Handle
	Opaque handle to a AUDDEC1 codec.
typedef IAUDDEC1_Params	AUDDEC1_Params
	Defines the creation time parameters for all IAUDDEC1 instance objects.
typedef IAUDDEC1_InArgs	AUDDEC1_InArgs
	Defines the input arguments for all IAUDDEC1 instance process function.
typedef IAUDDEC1_OutArgs	AUDDEC1_OutArgs
	Defines the run time output arguments for all IAUDDEC1 instance objects.
typedef IAUDDEC1_Cmd	AUDDEC1_Cmd
	Defines the control commands for the IAUDDEC1 module.
typedef IAUDDEC1_DynamicParams	AUDDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef IAUDDEC1_Status	AUDDEC1_Status
	Defines instance status parameters (read-only).

Functions
Int32	AUDDEC1_control (AUDDEC1_Handle handle, AUDDEC1_Cmd id, AUDDEC1_DynamicParams *params, AUDDEC1_Status *status)
	Execute the control() method in this instance of an audio decoder algorithm.
AUDDEC1_Handle	AUDDEC1_create (Engine_Handle e, String name, AUDDEC1_Params *params)
	Create an instance of an audio decoder algorithm.
Void	AUDDEC1_delete (AUDDEC1_Handle handle)
	Delete the instance of an audio decoder algorithm.
Int32	AUDDEC1_process (AUDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDDEC1_InArgs *inArgs, AUDDEC1_OutArgs *outArgs)
	Execute the process() method in this instance of an audio decoder algorithm.
Int32	AUDDEC1_processAsync (AUDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDDEC1_InArgs *inArgs, AUDDEC1_OutArgs *outArgs)
	Perform asynchronous submission to this instance of a audio decoder algorithm.
Int32	AUDDEC1_processWait (AUDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDDEC1_InArgs *inArgs, AUDDEC1_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of AUDDEC1_processAsync() in this instance of an audio decoder algorithm.