------------------------
timesys-theatre README
Timesys Corporation 2012
------------------------

ABOUT THE DEMOS
---------------

The timesys-theatre demos are intended to show the 
capabilities of the graphics processing units on Freescale(TM) i.MX5X
boards and beyond.

These demos showcase a number of features, depending on your board:
1. Graphical acceleration with Freescale codecs
2. Multi-core CPU usage statistics
3. Enabling and disabling individual cores
4. Qt graphical desktop environment
5. GPU performance with and without CPU stress from worker threads
 
To execute the demo on your board, run
timesys-theater-1080p -qws

A startup script is built in the factory for this binary which prepares the
Qt environment to adequately run this program.
 

CROSS-COMPILING WITHOUT FACTORY
-------------------------------

To compile the program by hand, follow the following instructions. Note that
this has only been tested with the Timesys toolchain, and that Qt and gstreamer
must both be installed to the toolchain for these instructions to be successful.

cd /full/path/to/factory/build_*/timesys-theatre-1080p-1.2/timesys-theatre-1080p-1.2/

/full/path/to/factory/build_*/toolchain/bin/cross_qmake
/full/path/to/factory/build_*/toolchain/bin/cross_make
/full/path/to/factory/build_*/toolchain/bin/cross_make install INSTALL_ROOT=/path/to/my/rfs


RUNNING SMOOTHLY
----------------

A couple of steps can be taken to improve the performance of your demo:

- Store your rfs and video on an SD card or USb drive
	instead of booting over NFS
	
- Display to a screen that is close to the aspect ratio 
	of the 720p or 1080p demo video you selected


CONFIGURABLE FILES
------------------

The gstreamer video pipelines created for this demo can be modified, using 
the following files that are installed to the RFS:

1. /etc/timesys-theatre.conf:
    - pipeline: a video play gstreamer pipeline format is <description>;<gstreamer pipeline>
    			<description> will show in dropdown. (sorry - no ";" allowed in description)
    - pipeline_camera: No description allowed. pipeline to use to show camera input
    - cores: No description allowed number of cores to control and monitor
    - # in first col is comment
Note: if you leave out any of these 'pipeline' parameters, that button in the
    theatre GUI will be disabled

2. /home/media/<video-file>
    - Timesys installs your media file to this location. You can play a video
        from anywhere in your RFS as long as you appropriately direct
        /etc/timesys-theatre.conf to this location with the 'piepline'
        parameters described above

        
 ANOMALIES
 ---------
 1. If screen is clicked too soon after the "Camera" demo is started, the
 	program will stall indefinitely. Try to leave a few seconds between
 	starting the camera demo and clicking on the screen
