Engine.h File Reference


Detailed Description

The Codec Engine Runtime. Provides the user an inteface to open and manipulate an Engine which can instantiate and communicate with XDAIS algorithms that run either on the local CPU or on a "remote" DSP Server.

#include <ti/sdo/ce/Server.h>
#include <ti/sdo/ce/ipc/Comm.h>
#include <ti/xdais/ialg.h>
#include <ti/sdo/ce/node/node.h>
#include <stddef.h>
#include <stdio.h>
Include dependency graph for Engine.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  Engine_Attrs
 Attributes of an Engine. More...
struct  Engine_AlgInfo
 Properties of an Engine algorithm. More...
struct  Engine_AlgInfo2
 Properties of an Engine algorithm. This structure is identical to Engine_AlgInfo except that the typeTab array of strings is replaced by a singie string called types. The string, types, represents a ';' separated list of inheritance hierarchies of the algorithm, for example, "ti.sdo.ce.video.IVIDDEC;ti.sdo.ce.test.xvideo.IVIDE". More...

Defines

#define Engine_GTNAME   "CE"
 Trace name for the Engine module.
#define Engine_EOK   0
#define Engine_EEXIST   1
#define Engine_ENOMEM   2
#define Engine_EDSPLOAD   3
#define Engine_ENOCOMM   4
#define Engine_ENOSERVER   5
#define Engine_ECOMALLOC   6
#define Engine_ERUNTIME   7
#define Engine_ECODECCREATE   8
#define Engine_ECODECSTART   9
#define Engine_EINVAL   10
#define Engine_EBADSERVER   11
#define Engine_ENOTAVAIL   12
#define Engine_EWRONGSTATE   13
#define Engine_EINUSE   14
#define Engine_ENOTFOUND   15
#define Engine_ETIMEOUT   16

Typedefs

typedef struct Engine_Obj * Engine_Handle
 Opaque handle to an engine.
typedef Int Engine_Error
 Engine error code.

Functions

Void Engine_close (Engine_Handle engine)
 Close an Engine.
Engine_Handle Engine_open (String name, Engine_Attrs *attrs, Engine_Error *ec)
 Open an Engine.
Int Engine_fwriteTrace (Engine_Handle engine, String prefix, FILE *out)
 Write Server's trace buffer to specifed file stream.
Engine_Error Engine_getAlgInfo (String name, Engine_AlgInfo *algInfo, Int index)
 Get details of an algorithm configured into an engine.
Engine_Error Engine_getAlgInfo2 (String name, Engine_Handle engine, Engine_AlgInfo2 *algInfo2, Int index)
 Get details of an algorithm that is configured into an engine, or has been added to an opened engine. If the engine has not been opened yet, the name of the engine is used to get the statically configured alg. If the engine has been opened, the engine handle can be used to get either information for a statically configured alg, or a remote alg that was added when the server was queried during Engine_open().
Int Engine_getCpuLoad (Engine_Handle engine)
 Get Server's cpu usage in percent.
Engine_Error Engine_getLastError (Engine_Handle engine)
 Get error code of the last failed operation.
String Engine_getName (Engine_Handle engine)
 Get the name of an opened engine.
Engine_Error Engine_getNumAlgs (String name, Int *numAlgs)
 Get the number of algorithms configured into an engine.
Engine_Error Engine_getNumAlgs2 (String name, Engine_Handle engine, Int *numAlgs)
 Get the number of algorithms statically configured into an engine or the total number of algorithms both statically configured and dynamically added through server information when the engine was opened.
Server_Handle Engine_getServer (Engine_Handle engine)
 Get handle to an Engine's server.
UInt32 Engine_getUsedMem (Engine_Handle engine)
 Get Server's total memory usage.
Int Engine_setTrace (Engine_Handle engine, String mask)
 Set Server's trace mask.

Variables

Engine_Attrs Engine_ATTRS
 Default engine attributes.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Copyright 2010, Texas Instruments Incorporated