|
|
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" 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>
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_DllAlgDesc |
| Discriptor for a dynamically loaded codec. A dynamic library for a codec must export a function that fills in a structure of this type. More... | |
| struct | Engine_DllAlgParams |
This structure is passed to Engine_addAlg(), and contains parameters to create a dynamic codec with. More... | |
Defines | |
| #define | Engine_MODNAME "ti.sdo.ce.Engine" |
| Name to pass to Diags_setMask() to enable logging for Engine functions. For example, Diags_setMask(Engine_MODNAME"+EX1234567"); turns on all Log statements in this module. Diags_setMask() must be called after initialization to take effect. | |
| #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 |
| #define | Engine_GETALGDESCFXN "GetEngineAlgDesc" |
| Name of function that a dynamically loaded codec must supply. | |
Typedefs | |
| typedef struct Engine_Obj * | Engine_Handle |
| Opaque handle to an engine. | |
| typedef Int | Engine_Error |
| Engine error code. | |
| typedef struct Engine_Attrs | Engine_Attrs |
| Attributes of an Engine. | |
| typedef struct Engine_AlgInfo | Engine_AlgInfo |
| Properties of an Engine algorithm. | |
| typedef struct Engine_DllAlgDesc | Engine_DllAlgDesc |
| Discriptor for a dynamically loaded codec. A dynamic library for a codec must export a function that fills in a structure of this type. | |
| typedef Int(* | Engine_GetAlgDescFxn )(Engine_DllAlgDesc *dllAlgDesc) |
Prototype of function that must be supplied by a dynamic codec library to fill in a Engine_DllAlgDesc structure. | |
| typedef struct Engine_DllAlgParams | Engine_DllAlgParams |
This structure is passed to Engine_addAlg(), and contains parameters to create a dynamic codec with. | |
Functions | |
| Engine_Error | Engine_add (String engineName, String remoteName) |
| Add an Engine to the database of engines that can be opened with Engine_open() | |
| Engine_Error | Engine_addAlg (Engine_Handle engine, String location, Engine_DllAlgParams *pAlgParams) |
| Dynamically add an algorithm to an Engine instance. | |
| Engine_Error | Engine_removeAlg (Engine_Handle engine, String name) |
| Dynamically remove an algorithm from an Engine instance. | |
| 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. | |
| 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. | |
| 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. | |
| Engine_Error | Engine_remove (String engineName) |
| Remove an engine from the list of engines that can be opened. | |
| Int | Engine_setTrace (Engine_Handle engine, String mask) |
| Set Server's trace mask. | |
Variables | |
| Engine_Attrs | Engine_ATTRS |
| Default engine attributes. | |