OMX Directory structure changes

Overview

Starting with EZSDK version 5.03.00.xx (OMX version 5.2.0.20), the directory structure within OMX directory has changed. This topic describes the motive and details of the changes.

Motive

OMX directory structure prior to EZSDK version 5.03.00.xx (prior to OMX version 5.2.0.20) had examples/demos inside the source tree. Also these were under a directory called packages, which was not intuitive enough for an integrator consuming OMX components or for a developer modifying them.

The changes were done with a focus on ease of use. The directory structure now is more intuitive and top level directories within OMX should be self explanatory.

Details

Old Directory structure

The following is the directory structure found with EZSDK versions prior to 5.03.00.xx (prior to OMX version 5.2.0.20)

<$OMX_INSTALL_DIR>
  |
  +---- packages 
           |
           +---- makerules (contains common set of make rules)
           |
           +---- ti
                 |
                 +---- omx
                        |
                        +---- demos
                        |
                        +---- comp
                        |
                        +---- domx
                        |
                        :
                        :

New Directory Structure

The following is the new directory structure

<$OMX_INSTALL_DIR>
  |
  +---- examples (All examples/demos are under this)
  |        |
  |        +---- ti
  |              |
  |              +---- omx
  |                     |
  |                     +---- demos
  |
  +---- makerules (contains common set of make rules)
  |
  +---- src (Source code and rest of the contents are here)
         |
         +---- ti
               |
               +---- omx
                      |
                      +---- comp
                      |
                      +---- domx
                      |
                      :
                      :

The new directory structure has ti/omx/demos under the top-level examples directory. The examples directory also has makefile that can be used to build the examples/demos.

Common set of make rules are in the directory makerules under the top level directory.

Source code and rest of the contents are under src directory under the OMX installation directory. This contains all the files and directories (except for ti/omx/demos and makerules) that used to be under packages directory in the older OMX releases.

Build Argument Changes

Top level Makefile of the EZSDK installation takes care of supplying the correct build arguments for OMX and one needs to just make omx. On the other hand, if one needs to build OMX examples/demos from within the OMX installation directory (normally found under component-sources), then please read through the rest of the section.

Since the directory structure has changed, the following aspects are different as compared with previous OMX versions:

• Change directory to <$OMX_INSTALL_DIR>/examples (instead of to <$OMX_INSTALL_DIR>/packages, that we used earlier)
• ROOTDIR should be set to the top-level OMX installation directory (eg: <absolute_path>/omx_05_02_00_20)
• INTERNAL_SW_ROOT should be set to <$OMX_INSTALL_DIR>/src
• EXAMPLES_ROOT should be set to <$OMX_INSTALL_DIR>/examples

NOTE: It is optional to set INTERNAL_SW_ROOT and EXAMPLES_ROOT, if they are under OMX installation directory (pointed to by $ROOTDIR). This is because, the locations are set to $(ROOTDIR)/src and $(ROOTDIR)/examples respectively, by default in makerules/env.mk.

Sample build command

Shown below is a sample build command to build decode_display IL Client.

Following command shows only relevant portions of earlier and new build command/arguments:

$ cd <OMX_INSTALL_DIR>/packagesexamples

$ make decode_display ROOTDIR=<OMX_INSTALL_DIR>/packages INTERNAL_SW_ROOT=<OMX_INSTALL_DIR>/packagessrc EXAMPLES_ROOT=<OMX_INSTALL_DIR>/packagesexamples . . .

More Descriptions Of Build Arguments

The descriptions of following build arguments are just to reiterate how they are interpreted; there are no changes in how they are interpreted as compared with older releases.

• ROOTDIR should be set to the directory that contains makerules directory.
• INTERNAL_SW_ROOT should be set to the directory that contains the source tree (where ti of ti/omx/comp is found, etc). This directory also contains component.mk that defines make related settings for all the OMX components.
• EXAMPLES_ROOT should be set to the directory that contains the examples/demos tree (where ti of ti/omx/demos is found).

---