XDAIS 7.22.00.03 Release Notes

December 2011

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.

Primary packages in this XDAIS release are briefly described here. (There are others, see the Configuration Reference Guide documentation for a complete package list.)

• 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

7.22.00.03

• The following defects were resolved:

  ID	Headline
  SDOCM00084928	videnc2_copy's generated QualiTI script has incorrect interface name
  SDOCM00084933	XDAIS videnc1_copy example does not export its IDMA3 functions in header file
  SDOCM00084930	Add strasgi external reference to QualiTI approved symbols
  SDOCM00084573	QualiTI sometimes crashes when validating algs built with newer cgtools
  SDOCM00082876	QualiTI java.lang.Thread.yield() statement fails with xdctools 3.22
  SDOCM00084938	Alg generated using genalg incorrectly assigns outArgs->extendedError



• The following enhancements were resolved:

  ID	Headline
  SDOCM00084576	Eclipse plugin updates required for CCS 5.1

7.21.00.02

• The following defects were resolved:

  ID	Headline
  SDOCM00077137	QualiTI should check that the library file is valid
  SDOCM00081266	ELF and ARM RTSC Target Modules Fail to Load in GenAlg Wizard When Running Inside of Code Composer Studio
  SDOCM00076942	GenAlg should detect (and reject) module, vendor, and package names with spaces



• The following enhancements were resolved:

  ID	Headline
  SDOCM00070211	Add #include guards to genalg templates

7.20.00.07

• The following defects were resolved:

  ID	Headline
  SDOCM00072944	viddec3_copy example's getLibs() fails to return the 'release' library when asked for a profile it didn't build



• The following enhancements were resolved:

  ID	Headline
  SDOCM00073013	Add multiple target support to genalg

7.10.00.06

• New features
  • Updated GenAlg Templates
  • QualiTI enhancements
• The following defects were resolved:

  ID	Headline
  SDOCM00064940	QualiTI should check the minimal CG XML version is available
  SDOCM00067032	ti/xdais/qualiti/README.txt file refers to non-existent scripts
  SDOCM00064938	QualiTI crashes with older XDC versions

• The following enhancements were resolved:

  ID	Headline
  SDOCM00066690	Add 'producerId' to all packages, ensuring the marketing version follows the pre-built packages
  SDOCM00068943	Update GenAlg's templates based on IUNIVERSAL users feedback

7.00.00.27

• New features
  • Added IVIDDEC3 and IVIDENC2 Beta interfaces
• The following defects were resolved:

  ID

  Headline

• The following enhancements were resolved:

  ID	Headline
  SDOCM00060866	Add C64T support to QualiTI
  SDOCM00060336	Add IVIDEO_FRAME_OUTPUTSKIP value to IVIDEO_OutputFrameStatus
  SDOCM00060424	Add several new video formats to IVIDEO_Format enum
  SDOCM00050265	QualiTI (and XDAIS) needs updated for Cortex M3 (and friends)

6.25.00.07

• New features
  • Changed to 4-segment versioning
  • Minor example build updates
• The following defects were resolved:

  ID

  Headline

• The following enhancements were resolved:

  ID	Headline
  SDOCM00061294	Allow QualiTI to use relative paths (relative to the .qti file) to set basedir field
  SDOCM00046986	IALG::algInit status/return codes should be well-specified and allow extensions of error or success codes
  SDOCM00062286	Create a wizard to generate XDM algorithm packages
  SDOCM00061326	Add ".econst" and ".ebss" to QualiTI's Rule 13-based list of approved section names
  SDOCM00061304	IRES_RequestMode should also support the IRES_LATEACQUIRE mode for acquiring resources.

6.24

• New features
  • QualiTI improvements
  • Validated examples against WinCE targets
• The following defects were resolved:

  ID

  Headline

• The following enhancements were resolved:

  ID

  Headline

6.23

• 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

---

Upgrade Information

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 DVSDK, this can be done by setting the XDAIS_INSTALL_DIR variable in the Rules.make file at the top of the DVSDK distribution directory.

Compatibility Breaks!

None

Note, if you're upgrading from a release earlier than XDAIS 7.21.00.02, 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 table below describes each package's compatibility with the previous release (xdais_7_21_00_02). Compatibility keys highlighted in red are incompatible with the previous release.

Note, the Configuration Reference Guide contains further details about each package.

Package	xdais_7_21_00_02	xdais_7_22_00_03
ti.xdais	1, 2.0, 1	1, 2.0, 1
ti.xdais.dm	1, 0, 7	1, 0, 7
ti.xdais.dm.templates	1, 0, 0	1, 0, 0
ti.xdais.qualiti	1, 0, 0	1, 0, 0
ti.xdais.utils.trace.cio	1, 0, 0	1, 0, 0
ti.xdais.wizards.genalg	1, 0, 0	1, 0, 0

If migrating from a release prior to XDAIS 7.21.00.02, 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:

1. Enable tooling to identify incompatibilities between components, and
2. 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 built and validated against using the following software components:

• XDCtools 3.23.00.32
• 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.3.3
  • gnu.targets.arm.GCArmv6 - 4.3.2
  • gnu.targets.arm.GCArmv7A - 4.3.2
  • google.targets.arm.Bionic - 4.4.3
  • microsoft.targets.arm.WinCE - 14.01.60511
  • ti.targets.C28_large - 5.2.1
  • ti.targets.C64P - 7.0.0
  • ti.targets.C674 - 7.0.0
  • ti.targets.arm.elf.M3 - 4.9.0
  • ti.targets.elf.C64P - 7.2.0
  • ti.targets.elf.C64T - 7.2.0
  • ti.targets.elf.C66 - 7.2.0
  • ti.targets.elf.C674 - 7.2.0

---

Known Issues

• QualiTI
  • 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.
• The eclipse plugin is not signed. In recent releases of CCSv5, a dialog box will be presented informing you of this. To enable CCS integration, you will have to accept this and click OK.

See the MFP Known Issues wiki article for issues found after these release notes were compiled.

---

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 bb 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_7_22_00_03.

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

---

Technical Support

For technical support, contact softwaresupport@ti.com

Check the following web site for updates: http://software-dl.ti.com/dsps/dsps_public_sw/sdo_sb/targetcontent/xdais/index.html

---

Last updated: December 8, 2011