Sensory Effect Media Player (SEMP) v0.12 - INSTALLATION
-------------------------------------------------------
(c) 2009 - 2012 Markus Waltl (Alpen-Adria-Universitt Klagenfurt)

Note: currently the player supports 3 lights (N, NW, NE (each with everyheight)), 2 fans (NE, NW (each with everyheight)) and 1 rumbler (everywhere and everyheight)

Requirements:
-------------
* Windows XP or higher
* Windows SDK v7.0 or higher (http://www.microsoft.com/download/en/details.aspx?id=8279)
* Visual C++ 2008 or higher (Express or full) (e.g., http://www.microsoft.com/express)
* Codec Pack (e.g., K-lite codec pack) (http://www.codecguide.com/)

Optional:
* amBX system (optional, but else no sensory effects are shown)
* DaleAir Vortex Activ (optional, but else no scent feature available)


The following DLLs are required for running SEMP:
* iconv.dll
* libxml2.dll
* zlib1.dll

The following DDLs are optional (only required if compiled with additional features):
* ambxrt.dll (amBX system)
* FTD2XX.dll (Vortex Activ)


INSTALLATION/COMPILATION
------------------------
The package comes without the amBX SDK (i.e., headers, lib and dll). To get the SDK register at http://developer.ambx.com and download the SDK.
For using Vortex Activ you will receive the required DLL and header files with the examples.

NORMAL COMPILATION
******************
Start Visual Studio/C++ and set the output configuration to "Release" or "Debug" and
compile.

First the "baseclasses" will be compiled and afterwards SEMP. After compilation you
will find a folder "Release" or "Debug" in which all necessary files are stored.

Note: this compilation provides a simple movie player based on DirectShow with
no special features.


COMPILATION WITH SENSORY EFFECTS
********************************
This compilation provides additional sensory effects. Before you are able to compile
you need some files and preparations. In the following the steps are split up
into amBX system compilation and Vortex Activ compilation.

Note: if you have both sensory devices you should/could perform both compilation together.


amBX system
-----------
First you need the amBX SDK available at http://developer.ambx.com.

- extract/install the SDK
- copy the amBX header files to SEMP\SEMP\3rdParties\ambx
  The files are (not necessary the full list):
  * amBX_Types.h
  * IamBX.h
  * IamBX_Event.h
  * IamBX_Fan.h
  * IamBX_Light.h
  * IamBX_Movie.h
  * IamBX_Rumble.h
- copy the libraries to SEMP\SEMP\3rdParties\libs
  The files are (note the files have to be renamed to match):
  * ambxrt.dll
  * ambxrt.lib
- open the project
- open the file stdafx.h
- replace the line
      #define __USEAMBX__ 0
  with
      #define __USEAMBX__ 1
- compile and run
  
Your player should now have options for sensory effects available and can handle
Sensory Effect Metadata (SEM) descriptions. Furthermore, it can automatically
calculate light effects from the currently playing video if enabled.


Vortex Activ
------------
First you need the examples file from Vortex Activ.

- extract the examples file
- copy the FTD2XX.h files to SEMP\SEMP\3rdParties\ftd2xx
- copy the libraries to SEMP\SEMP\3rdParties\libs
  The files are:
  * FTD2XX.dll
  * FTD2XX.lib
- open the project
- open the file stdafx.h
- replace the line
      #define __USEVORTEX__ 0
  with
      #define __USEVORTEX__ 1
- compile and run

Your player should now have options for sensory effects available and can handle
Sensory Effect Metadata (SEM) descriptions. Note now only scent effects are available.

For handling specific scents you need to edit the file scentconfig.dat or create
your own. The cartridges of the Vortex Activ are mapped for left (0) to right (3).
Update the scent name for the corresponding cartridge and load a SEM description
(e.g., scent_test.xml). Note scent_test.xml also needs to be updated with the
desired cartridge.

Note: for testing you can simply use the current scentconfig.dat and scent_test.xml
to see the fans activating and deactivating.


COMPONENTS AND LICENSES
-----------------------
SEMP - GNU Lesser General Public License 3.0 or later
libxml2 2.6.28 - MIT license (iconv and zlib are needed by libxml2)
zlib 1.2.5 - zlib license
iconv 1.9.2 - GNU Lesser General Public License 2.1 or later
baseclasses - Microsoft SDK license


CONTACT
-------
For problems please visit our web site:

http://selab.itec.aau.at

and submit a ticket (if there is not already one)

