The Codec Engine Runtime.
#include <ti/sdo/ce/ServerDefs.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_AlgInfo2 |
Properties of an Engine algorithm. More... | |
struct | Engine_AlgDesc |
Descriptor for an alg. This object can be passed to Engine_addAlg() , to dynamically add an alg to an engine. More... | |
struct | Engine_DllAlgDesc |
Descriptor for a dynamically loaded alg. A dynamic library for a codec must export a function that fills in a structure of this type. More... | |
struct | Engine_Desc |
This structure is passed to Engine_add() , and contains parameters to specify an engine. More... | |
Defines | |
#define | Engine_MODNAME "ti.sdo.ce.Engine" |
Name to pass to Diags_setMask() to enable logging for Engine functions. | |
#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_AlgInfo2 | Engine_AlgInfo2 |
Properties of an Engine algorithm. | |
typedef enum Engine_CachedMemType | Engine_CachedMemType |
Engine Cacheable Memory types. | |
typedef struct Engine_AlgDesc | Engine_AlgDesc |
Descriptor for an alg. This object can be passed to Engine_addAlg() , to dynamically add an alg to an engine. | |
typedef struct Engine_DllAlgDesc | Engine_DllAlgDesc |
Descriptor for a dynamically loaded alg. 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_Desc | Engine_Desc |
This structure is passed to Engine_add() , and contains parameters to specify an engine. | |
Enumerations | |
enum | Engine_CachedMemType { Engine_USECACHEDMEM_DEFAULT = -1, Engine_USECACHEDMEM_NONCACHED = 0, Engine_USECACHEDMEM_CACHED = 1 } |
Engine Cacheable Memory types. More... | |
Functions | |
Engine_Error | Engine_addStubFxns (String fxnsName, IALG_Fxns *fxns) |
Register stub functions through which a remote algorithm can be called. | |
Engine_Error | Engine_add (Engine_Desc *pDesc) |
Add an Engine to the database of engines that can be opened with Engine_open() | |
Engine_Error | Engine_addAlg (String name, Engine_Handle engine, String location, Engine_AlgDesc *pAlgDesc) |
Dynamically add an algorithm to an Engine. | |
Engine_Error | Engine_removeAlg (String name, Engine_Handle engine, String algName) |
Dynamically remove an algorithm that was added to an Engine with Engine_addAlg(). | |
Void | Engine_close (Engine_Handle engine) |
Close an Engine. | |
Void | Engine_initAlgDesc (Engine_AlgDesc *pAlgDesc) |
Initialize an Engine_AlgDesc structure with default values. | |
Void | Engine_initAttrs (Engine_Attrs *pAttrs) |
Initialize an Engine_Attrs structure with default values. | |
Void | Engine_initDesc (Engine_Desc *pDesc) |
Initialize an Engine_Desc structure with default values. | |
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. | |
Engine_Error | Engine_getDesc (String name, Engine_Desc *desc) |
Fill in an Engine_Desc structure with the values of the Engine descriptor for an Engine. | |
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. | |
Engine_Error | Engine_remove (String engineName) |
Remove an engine from the list of engines that can be opened. | |
Engine_Error | Engine_setDesc (String name, Engine_Desc *desc) |
Set values for an Engine's descriptor. This function should only be called when the Engine has not yet been opened. | |
Int | Engine_setTrace (Engine_Handle engine, String mask) |
Set Server's trace mask. | |
Variables | |
Engine_Attrs | Engine_ATTRS |
Default engine attributes. |