XDM GenAlg Wizard FAQ

From Texas Instruments Embedded Processors Wiki

Jump to: navigation, search

Translate this page to

1 General Questions
- 1.1 What does the wizard do? What does it generate?
- 1.2 Does the generated codec require Codec Engine?
2 Installation
- 2.1 How do I install the Wizard?
3 Running the Wizard
4 The Wizard GUI
- 4.1 What if I need help using the GUI version?
  - 4.1.1 Basic Algorithm Information
- 4.2 What is the templates directory?
5 After the Wizard
- 5.1 How do I build my algorithm package?
- 5.2 Can I use Code Composer Studio 4.x to build my algorithm?
6 How can I check that my generated algorithm is XDAIS compliant?
7 See also
8 Other FAQs

General Questions

What does the wizard do? What does it generate?

The GenAlg Wizard creates a XDC package with all the files necessary to build and distribute an XDM-compliant algorithm.

Does the generated codec require Codec Engine?

No. The generated XDC package builds with the XDC tools (using package.bld), but there are no bindings to Codec Engine. You can integrate the generated codec in any framework (including Codec Engine).

Installation

How do I install the Wizard?

The Wizard is delivered with XDAIS 6.25 or greater, and is provided with CCS Eclipse. The latest XDAIS releases are available here.

Requirements

XDCtools 3.16 or greater

Running the Wizard

From CCS Eclipse

GenAlg In CCS Menu

(Note that in CCS v5.1, the Tools menu only appears when CCS is in Debug Perspective.)

Batch File/Shell Script

There are scripts at the root of the XDAIS product that demonstrate how to start the wizard. See the ti.xdais.wizards.genalg.bat for Windows, or ti.xdais.wizards.genalg.sh on Linux. (Under the covers, they run the command "$XDC_INSTALL_DIR/xs ti.xdais.wizards.genalg" with an appropriate XDCPATH set.)

What if I need help on the command line?

See XDM GenAlg Wizard help by: xs ti.xdais.wizards.genalg --help

The Wizard GUI

What if I need help using the GUI version?

Here is a description of the wizard:

Basic Algorithm Information

Module

The name of the algorithm you're creating

Vendor

Your company name

Interface

Has the form I<Vendor>. This field will be automatically filled after naming the module.

Base Interface

The ti.xdais.dm interface that is being implemented

Package Name

The algorithm's globally unique Package Name. Defaults to <Vendor>.<Module>

Targets

Build targets. The generated makefile will build a library for each target selected.

Add IRES Interface

When checked, a generic implementation of the IRES interface will be added to the algorithm in <Module>_<Vendor>_ires.c. All IRES references will be inside #ifdef ADD_IRES_RESOURCE blocks. The generated source files will have to be modified to implement a specific resource manager.

Destination Directory

The location that the algorithm package files will be output to. For example, if the output directory is c:/output, and the algorithm package name is ti.viddec_copy, the files will be output to c:/output/ti/viddec_copy

'cgtools' Directories

The location of CodeGen tools required to build for the selected targets.

Expert Mode

When left unchecked, the Interface and Package Name fields will be read-only and will be automatically generated based on Module and Vendor

What is the templates directory?

The templates directory contains subdirectories of XDC templates. Each template generates an XDM algorithm package that implements an XDM interface. The name of each subdirectory is the name of the XDM interface, and is displayed in the 'Base Interface' combo box. For more information, see: XDCScript Templates

After the Wizard

How do I build my algorithm package?

Run gmake all from the output directory (output directory + algorithm.package.name.with.dots.turned.into.forward.slashes).

Can I use Code Composer Studio 4.x to build my algorithm?

Yes. When you check the "Generate CCSv4 Project" box, a project will be created that can be imported into CCSv4 and built. See GenCodecPkg Code Composer Studio 4.x for details.