module ti.sdo.ce.Engine

local — If true, the algorithm should be instantiated on the "local" CPU; otherwise the server will create an instance of the algorithm identifed by mod.

groupId — This id specifies which resource sharing group this codec will be placed into. This 'group' concept is used by the framework to ensure algorithms in the same group don't pre-empt each other and corrupt the shared resources.

Note that this parameter is ignored if local is not TRUE.

DETAILS

Each engine "contains" multiple algorithms described by AlgDesc structures.

Engine.createFromServer( ) // module-wide

index URL

Create an Engine from a Server package

XDCscript usage meta-domain

Engine.createFromServer( Any engineName, Any serverExecutable, Any serverPackage ) returns Any

ARGUMENTS

engineName — Name to be used for the engine created

serverExecutable — Path to the server executable (including the executable), relative from server package

serverPackage — Name of the server package

DETAILS

Given a Server package and an executable in that package, this method creates an Engine instance and initializes it from details in the Server provided.

An Engine instance created this way has all the codecs that exist in the Server executable - with codec names matching the names configured into the Server, and is configured to use an appropriate memory map and other DSP-specific info.

Example usage:

  var myEngine = Engine.createFromServer("video_copy",
                     "./video_copy.x64P",
                     "ti.sdo.ce.examples.servers.video_copy");

RETURNS

An Engine instance of the same type as if create() were called.

Engine.getDspMemTableFromServer( ) // module-wide

index URL

Get a remote processor's memory table from a Server package

XDCscript usage meta-domain

Engine.getDspMemTableFromServer( Any serverExecutable, Any serverPackage ) returns Any

ARGUMENTS

serverExecutable — Path to the server executable (including the executable), relative from server package

serverPackage — Name of the server package

DETAILS

Given a Server package and an executable in that package, this method returns an object that contains the Server's memory map details.

For example:

  myEngine.armDspLinkConfig.memTable =
      Engine.getDspMemTableFromServer(
                     "./video_copy.x64P",
                     "ti.sdo.ce.examples.servers.video_copy" );

There is no need to use this method when the preferred createFromServer() method is used first.

RETURNS

A DSP memory table "map" object, of type ti.sdo.ce.osal.Global. ArmDspLinkConfigMemTableEntry[string]

SEE

createFromServer

per-instance config parameters

index URL

XDCscript usage meta-domain

var params = new Engine.Params;

// Instance config-params object

params.algs = Engine.AlgDesc[] undefined;

// Array of algorithms available in an Engine

params.armDspLinkConfig = IIpc.ArmDspLinkConfig undefined;

// ARM-side DSP Link configuration

params.linkCfg = String undefined;

// Optional name of DSP Link configuration

params.name = String undefined;

// Name of this engine

params.server = String undefined;

// Optional name of the remote server

config Engine.algs // per-instance

index URL

Array of algorithms available in an Engine

XDCscript usage meta-domain

var params = new Engine.Params;

...

params.algs = Engine.AlgDesc[] undefined;

DETAILS

An array of algorithms which this Engine instance provides. A mix of local and remote algorithms can be specified in this array.

createFromServer() can be used to populate this array with algorithms configured into a remote Server.

SEE

createFromServer

config Engine.armDspLinkConfig // per-instance

index URL

ARM-side DSP Link configuration

XDCscript usage meta-domain

var params = new Engine.Params;

...

params.armDspLinkConfig = IIpc.ArmDspLinkConfig undefined;

DETAILS

The ARM-side DSP Link configuration. If left undefined will revert to ti.sdo.ce.ipc.DEFAULT_ARMDSPLINKCONFIG, but with a warning

Applies only to CE configurations where osal.Global.runtimeEnv == DSPLINK_LINUX

There is no need to use this method when the preferred createFromServer() method is used first.

SEE

createFromServer

config Engine.linkCfg // per-instance

index URL

Optional name of DSP Link configuration

XDCscript usage meta-domain

var params = new Engine.Params;

...

params.linkCfg = String undefined;

DETAILS

This parameter is only needed when LAD is used to arbitrate control of the DSP server

config Engine.name // per-instance

index URL

Name of this engine

XDCscript usage meta-domain

var params = new Engine.Params;

...

params.name = String undefined;

DETAILS

This string provided by the application in the Engine_open() call.

config Engine.server // per-instance

index URL

Optional name of the remote server

XDCscript usage meta-domain

var params = new Engine.Params;

...

params.server = String undefined;

DETAILS

This parameter is only necessary when there are algorithms configured to run remotely - i.e., their local field is set to false.

Engines containing these remote algorithms will need to set this server parameter to the name of the binary which should be loaded on the remote processor.

per-instance creation

index URL

XDCscript usage meta-domain

var params = new Engine.Params;

// Allocate instance config-params

params.config = ...

// Assign individual configs

var inst = Engine.create( String name, Engine.AlgDesc[] algs, params );

// Create an instance-object

DETAILS

Parameters:

name: Name of this engine; this name is used by clients via the Engine_open() API to identify the collection of algorithms available.
algs: Array of algorithms this engine supports
server: Optional name of the DSP Server; this name is used (if necessary) to load and start any associated DSP CPUs required to support this Engine instance

generated on Thu, 02 Dec 2010 05:35:36 GMT