Build Instructions for XDAIS Examples

General Information

This page explains how to build the examples provided in the XDAIS product.

Examples currently contain the simple pass-through (copy) codecs, implemented in the XDM algorithm standard.

Requirements

See the release notes for the specific software and hardware components this release of XDAIS has been validated against.

Directory Structure

This section describes the layout under the examples directory. In most cases, these examples are XDC packages, and there are links to the autogenerated XDC documentation.

examples
    +---ti
        +---xdais
            +---dm
                +---examples
                    +---auddec_copy
                    +---auddec1_copy
                    +---audenc1_copy
                    +---g711
                    +---imgdec1_copy
                    +---imgenc1_copy
                    +---sphdec1_copy
                    +---sphenc1_copy
                    +---universal_copy
                    +---vidanalytics_copy
                    +---viddec1_copy
                    +---viddec2_copy
                    +---viddec3_copy
                    +---videnc1_copy
                    +---videnc2_copy
                    `---vidtranscode_copy

Preparing to Build the Examples

Create a working directory

Create a working directory (e.g. c:/myPackages) and copy the contents of the examples directory into it. This will be where you build and modify the XDAIS examples.

Doing this will ensure you have a backup copy of the original examples, as provided by the XDAIS product.

Important: throughout the rest of this document, we will use the following notation:

• <XDAIS_EXAMPLES_INSTALL_DIR> - absolute path of the repository you made, containing the example packages. e.g. /usr/work/examples
• <XDAIS_INSTALL_DIR> - root directory of your XDAIS installation. The original examples are in <XDAIS_INSTALL_DIR>/examples.
• <XDC_INSTALL_DIR> - root directory of your xdctools installation.
• directory/file - position of the file relative to the examples directory; for examples, Makefile refers to <XDAIS_EXAMPLES_INSTALL_DIR>/Makefile.

Build with XDCtools

1. Manage config.bld

The XDAIS examples are also provided with XDC build scripts. The master build configuration script, config.bld, is used to define the targets and environment in which the example XDC packages will be built.

At the root of the Examples directory, there is a config.bld.default config script which can be used to start from. Simply rename it to config.bld, and open this file in a text editor.

Build.targets

• The XDAIS examples are very portable and run in many different environments. The Build.targets array specifies which targets you want to build for. By default, the C64P target is enabled.

Toolchain roots - rootDir

• C64P.rootDir - Specify where your C64 tools are
  Edit the string (directory name) assigned to the C64P.rootDir variable. Note that both Windows and Linux builds are supported. This is the directory that contains bin/, include/, and lib/ subdirectory. (Note also that this is only necessary if "C64P" is included in your "Build.targets" array)

2. Edit Makefile to define the necessary variables

The Makefile file, located at the root of the examples/ directory, defines where the XDAIS product is installed, and where the XDCtools are. Open this file in a text editor.

• Specify where your XDAIS product is installed:
  Set XDAIS_INSTALL_DIR to the absolute path to your XDAIS installation directory.
• Specify where your XDC tools are installed:
  Set XDC_INSTALL_DIR to the absolute path to your XDCtools installation directory.

3. Build examples

From the base of your working directory, type

    gmake clean
    gmake

Last updated: June 14, 2011