From Texas Instruments Embedded Processors Wiki

Contents 1 Getting Started 1.1 Introduction 1.2 Bottom's Up 1.3 Top Down 2 Now what?

Getting Started

Introduction

As Codec Engine is relatively new technology, we often get requests for "where do I start!" This topic serves as that starting point.

Two viewpoints are taken, a bottoms up view and a top-down view. Depending on whether you're an algorithm developer or a system integrator, you can choose your path.

Note, to ensure others benefit from this topic, please feel free to add and update the pointers with details about what you found valuable in coming up to speed.

Bottom's Up

We work from the bottom up, starting from the algorithm developer and ending with pointers to the DVSDK, a complete, complex system with "real world" multimedia applications.

• Start with the XDAIS and XDM products, which define a consistent set of algorithm interfaces, and enable the software stack above.
  • If you're already familiar with XDAIS, you might start with the XDM Users Guide.
• Stepping up the stack, there is Framework Components (FC). FC provides libraries/APIs to grant resources (e.g. memory and DMA resources) to algorithms using the interfaces (IALG, IDMA3) defined in XDAIS. These FC docs are provided:
  • DSKT2 User's Guide - this DSKT2 library can be used to create and manage algorithms.
  • Using DMA with FC App Note
  • Framework Components API Reference Guide
• Then, we step up into Codec Engine (CE)
  • CE enables applications to easily invoke these algorithms (using FC under the covers). It exposes XDM-like interfaces (a.k.a. "VISA" interfaces) to the apps. Codec Engine users fall into one of four roles, as described in the Codec Engine Roles article. These roles are also used to structure the documentation. From bottom up, you might read:
    • Algorithm Creator User's Guide
    • Codec Engine Application Developer's Guide and Codec Engine API Reference Guide
    • And finally, for those using heterogeneous devices, the Server Integrator's Guide.
• And finally, the big one, the DVSDK. This bundles all of the above and more, and provides examples of fully running applications - real codecs, real I/O, etc. The DVSDK Getting Started Guide is here.

Top Down

Looking from the top down, you start with the DVSDK, and ultimately progress into products for creating algorithms.

• The DVSDK integrates Codec Engine and many other subcomponents into a complete, complex system with "real world" multimedia applications. The DVSDK Getting Started Guide is here
• Then, we step up into Codec Engine (CE):
  • CE enables applications to easily create and work with algorithms using a common API. Codec Engine users fall into one of four roles, as described in the Codec Engine Roles article. These roles are also used to structure the documentation. From the top down, you might read:
    • Codec Engine Application Developer's Guide and Codec Engine API Reference Guide
    • Algorithm Creator User's Guide
    • And finally, for those using heterogeneous devices, the Server Integrator's Guide.
• Looking further down the stack is Framework Components (FC)
  • The Codec Engine and other frameworks utilize FC provided libraries/APIs to grant resources (e.g. memory and DMA resources) to algorithms using the interfaces (IALG, IDMA3) defined in XDAIS.
  • DSKT2 User's Guide - this DSKT2 library can be used to create and manage algorithms.
  • Using DMA with FC App Note
  • Framework Components API Reference Guide
• And finally, FC fundamentally operates on algorithms which comply with the XDAIS and XDM standard. This XDAIS standard is agnostic of algorithm, but has been extended to include the XDM standard, which defines interfaces for multimedia algorithms.
  • If you're already familiar with XDAIS, you might start with the XDM Users Guide.

Now what?

Okay, you get it, there's lots to read. But you're a developer and want to get your hands dirty, so where do you go when you're tired of reading and want to start playing? Download one of the products from the links above - each includes docs, examples and instructions for building and running on supported devices.

There's also a mailing list which you're encouraged to subscribe to and post questions to when you have them. There's a good community there just waiting to help!

Leave a Comment

Comments

Generally, we need to have a strategy for updating doc links as new versions of the products come out. The SPRU/SPRA docs links will always automatically link to the latest published versions of these docs, but the API Reference Guides are links to a specific release's generated documentation. Open to advice from any mediawiki experts on how to manage that.  :) Maybe create hidden variables at the top of the topic that can be set to which release to use?

Thanks.

ChrisRing 09:50, 3 October 2007 (MDT)