XDAIS 6.23 Release Notes

March 2009

Introduction, Documentation, What's New, Upgrade Info, Compatibility Information, Validation Info, Known Issues, Examples, Version Information, Technical Support.

Introduction

This XDAIS product contains the DSP Algorithm Interface Standard specification and related documentation and examples.

The following packages are included in this release:

ti.xdais - XDAIS interface and documentation
ti.xdais.dm - XDAIS-DM (XDM) interface and documentation.
ti.xdais.qualiti - XDAIS compliancy checking tool

In addition several example packages are also provided.

Documentation

The following documentation is available:

XDAIS documentation list
XDM Users Guide (local | latest)
XDAIS API Reference Guide (HTML | CHM) - Includes XDM APIs
What's new in XDM 1.00
Package Reference Guide

In addition, users are encouraged to monitor (and contribute to!) the TI Embedded Processors Wiki.

Release notes from previous releases are also available in the relnotes_archive directory.

What's New

The following significant changes have been made since 5.00

6.23 (This Release)

New features
- QualiTI enhancements to include ARM support

The following defects were resolved:

ID	Headline
SDOCM00053259	chm API Reference Guide search doesn't work
SDOCM00054295	QualiTI fails on Windows if the tool paths contain spaces

The following enhancements were resolved:

ID	Headline
SDOCM00054214	Add 674 target support to QualiTI
SDOCM00054216	Add QualiTI -g option to support launching GUI with a given filename

6.22

New features
- Added new chroma formats to XDM_ChromaFormat enum
The following enhancements were resolved:

ID Headline

SDSCM00050966 Add more Chroma format enums

6.21

New features
- BSD Licensing
The following enhancements were resolved:

ID Headline

SDOCM00049826 Change Licensing to BSD

SDOCM00050452 Add the ability for extending XDM-defined enums

6.20

New features
- Documentation updates, including error resiliency clarifications in IVIDDEC2.
- Minor bug fixes in QualiTI.
- Changes to IVIDANALYTICS API in response to customer feedback. This breaks compatibility with previous releases of IVIDANALYTICS, but the API continues to be in Beta form and therefore changable.

The following defects were resolved:

ID	Headline
SDSCM00024690	QualiTI doesn't catch not-an-archive Rule 15 if in an XDC package
SDSCM00025188	QualiTI needs to handle _IALG symbols when they're const
SDSCM00025559	viddec2_copy example has incorrect symbol in header

The following enhancements were resolved:

ID	Headline
SDSCM00024172	Examples which use package.bld should have explicit Build and Pkg assignments
SDSCM00025558	IVIDDEC2 spec should state that valid bufs can be returned when non-fatal EFAIL is returned from process()
SDSCM00026170	Add IUNIVERSAL to XDM spec

6.10

Introduction of IVIDDEC2 interfaces.
Introduction of QualiTI XDAIS compliancy validation tool.
Updated all examples to pass qualiTI compliance, and added .qti workspace files.

6.00

Introduction of IRES interfaces.
Introduction of the video transcoder APIs (IVIDTRANSCODE)
Introduction of video analytics Beta APIs (IVIDANALYTICS). These APIs are available for review, and will be replaced with the final interfaces in a future release.
Deprecated XDM 0.9 interfaces. These interfaces are fully supported in this release, but support will be removed in a future release. XDM algorithm producers are strongly encouraged to migrate to the XDM 1.00 interfaces.
Updated ti.xdais.dm.examples.g711 codec package to include G.711 decode support and both u-law and a-law transforms.

5.21

Official release of XDM 1.00. Examples and API Reference Guides have been updated accordingly.

And the following MRs were resolved:

ID	Headline
SDSCM00014553	Remove dependency on BIOS types in idma3.h
SDSCM00013817	Deprecate XDM_ERUNTIME for XDM 1.00
SDSCM00013698	Add bitrate fields to several speech1 structs and more frame types
SDSCM00013621	XDM 1.0 speech inArgs should have "size" field for extensibility
SDSCM00013568	XDM user guide needs to discuss extension of parameter ad argument structions
SDSCM00013537	ISPHENC1_FrameType enums have inconsistant prefix
SDSCM00011273	When including public header files in XDAIS, one needs to use "full qualified package path"
SDSCM00005724	XDAIS Documentation needs to be update to support IDMA3

5.10

Introduction of XDM 1.00 Beta.
- The Reference Guide has been updated to include these Beta APIs.
- Added "What's New in XDM 1.00" documentation, describing the high-level changes in the XDM 1.00 Beta specification.
- This XDM 1.00 Beta spec addresses the following items:
  - SDSCM00004685 - XDM speech enc and dec OutArgs should have extendedError field for consistency
  - SDSCM00005009 - IIMGDEC_OutArgs bytesconsumed should be camelCase
  - SDSCM00005245 - Video enc interface needs to reconsider reconBufs conventions for RPCs
Addition of example "copy" codecs, conforming with XDM 1.00 Beta interfaces.
Addition of example G.711 algorithm, conforming with XDM 0.90 speech encoder interface. This example shows how to wrap an XDM interface around an existing algorithm.
Addition of example "extended" video encoder copy codec. This example shows how an algorithm can extend the XDM interface to implement codec-specific features.
SDSCM00005726 - Add doxygen comments to ialg.h
SDSCM00005728 - IDMA3 channel object documentation needs to include scratch environment support
SDSCM00010925 - XDM User's manual uses XMI in places
SDSCM00011274 - XDAIS header files for c55 need to include fully qualified package files

The XDAIS packages are available in the "packages/" subdirectory of the product. If you have a previous release of the XDAIS product, you can install this release next to it, and modify your builds to use this newer release.

If you're using the DVEVM, this can be done by setting the XDAIS_INSTALL_DIR variable in the Rules.make file at the top of the DVEVM distribution directory.

Compatibility Breaks!

None

Note, if you're upgrading from a release earlier than XDAIS 6.21, be sure to review the Upgrade section for each of the releases between your current XDAIS release and this one. Previous release notes are available in the relnotes_archive directory.

Compatibility Information

The details provided below describe each package's compatibility with the previous release (6.21).

ti.xdais - This package is compatible with the previous release. (Compatibility key: 1,2.0,1 -> 1,2.0,1)
ti.xdais.dm - This package is compatible with the previous release. (Compatibility key: 1,0,5 -> 1,0,5)
Compatibility with previous releases is not currently managed in the examples.

If migrating from a release prior to XDAIS 6.21, consult previous releases available in the relnotes_archive directory.

Compatibility Key Definitions

Compatibility keys are intentionally independent of Marketing product numbers and are intended to:

Enable tooling to identify incompatibilities between components, and
Convey a level of compatibility between different releases to set end user expectations.

Compatibility keys are composed of 3 comma-delimited numbers - M,S,R - where:

M = Major. A difference in M indicates a break in compatibility.
S = Source. A difference in S indicates source compability. That is, the user's source doesn't require change, but does require rebuilding.
R = Radix. A difference in R indicates an introduction of new features, but compatibility with previous interfaces has not broken. If libraries are provided by the package, an application must re-link with the new libraries, but not rebuild from source.

Validation

This release was validated against using the following components:

XDC Tools 3.10.04
The examples were built with the following toolchains. Note that, in general, nothing prevents them from being built with a different version of tools, nor for other devices - they are intentionally written in generic C):
- gnu.targets.Linux86 - 4.1.0
- gnu.targets.UCArm9 - 4.2.1
- gnu.targets.arm.GCArmv5T - 4.2.1
- ti.targets.C28_large - 5.0.0
- ti.targets.C55P_byte - 4.0.0
- ti.targets.C55_huge - 3.2.2
- ti.targets.C55_large - 3.2.2
- ti.targets.C64P - 6.0.16
- ti.targets.C674 - 6.1.5

Known Issues

QualiTI
- When running QualiTI on an ARM codec, Rule 26 - All C6x algorithms must access all static and global data as far data - will run (and pass!). This test is not appropriate for ARM codecs.
- Rule 15 - Each XDAIS-compliant algorithm must be packaged in an archive which has a name that follows a uniform naming convention - has been disabled.

Examples

XDAIS examples and instructions are located in the "examples" directory.

Example Build Instructions

Version Information

This product's version follows a version format, M.mm.pp.bb, where M is a single digit Major number, mm is 2 digit minor number, pp is a 2 digit patch number, and b is an unrestricted set of digits used as an incrementing build counter.

To support multiple side-by-side installations of the product, the product version is encoded in the top level directory, ex. xdais_6_23.

Subsequent releases of patch upgrades will be identified by the patch number, ex. XDAIS 6.22.01 with directory xdais_6_22_01. Typically, these patches only include critical bug fixes.

Technical Support

For technical support, contact softwaresupport@ti.com

Check the following web site for updates: https://www-a.ti.com/downloads/sds_support/targetcontent/XDAIS/index.html

Last updated: March 13, 2009

ID	Headline
SDOCM00049826	Change Licensing to BSD
SDOCM00050452	Add the ability for extending XDM-defined enums