Read Me

ROOMSIM v1.0a

Contents
========
This windows binaries package contains the room simulator in two forms:
  * a stand-alone version, ROOMSIM.EXE
  * a MATLAB based version, ROOMSIM.MEXW32
Both versions depend on the DLL libfftw3-3.dll for the FFT computations.

To use either room simulator, extract the content of the zip-file to 
a desired folder. No other installation is required. 

Using the stand-alone version
=============================
For the stand-alone version, direct a command prompt to the folder containing
ROOMSIM.EXE, and run the simulator by using the command

   ROOMSIM setupfile

where setupfile specifies the file that contains the room setup to be
simulated. An documented example setup file, SAMPLEROOMSETUP.M, is
provided. The format of the setup file follows a simplified MATLAB syntax,
so that the file is easily readable by both the stand-alone simulator,
as well as the MATLAB based simulator. The room impulse response generated
by the stand-alone simulator is saved to a file called OUTPUT.BRIR by
default, but a different output filename can be provided on the command-line
as follows:

   ROOMSIM setupfile outputfile

Finally, the output of the room simulator can be read into MATLAB using
the READBRIR function in MATLAB. To read the data into another program,
see the READBRIR.M file for the file format of the output file, or 
download the source code to access the ROOMSIM API.

Using the MATLAB based version
==============================
For the MATLAB based room simulator, direct MATLAB to the folder containing
ROOMSIM.MEXW32, and run the simulator by using the commands

   >> par = readsetup('sampleroomsetup');
   >> H = roomsim(par);

where 'sampleroomsetup' specifies the room setup to be used (in this case
the provided sample room setup). The readsetup command reads the specified
room setup into a parameter structure, which is then passed to the room
simulator.

Other tools
===========
There are also a few MATLAB tools provided for visualization of the room
setup and the generated room impulse response. See the documentation of 
the individual MATLAB files for details.