Prepare first Windows Release

CMakeLists.txt

@@ -264,7 +264,7 @@ set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -Wall -fomit-frame-point
 
 # Compile
 add_executable(ssr-binaural src/ssr_binaural.cpp ${SOURCE_FILES})
-# add_executable(ssr-wfs src/ssr_wfs.cpp ${SOURCE_FILES})
+add_executable(ssr-wfs src/ssr_wfs.cpp ${SOURCE_FILES})
 
 
 # Link
@@ -275,8 +275,8 @@ endif(WIN32)
 message(STATUS "Linking: "  ${LINKLIBS} ${QT5PLATFORMSUPPORT_LIBS})
 
 target_link_libraries(ssr-binaural Threads::Threads ${LINKLIBS})
-# target_link_libraries(ssr-wfs Threads::Threads ${LINKLIBS})
+target_link_libraries(ssr-wfs Threads::Threads ${LINKLIBS})
 if(GUI)
   target_link_libraries(ssr-binaural Qt5::Gui Qt5::Core Qt5::Widgets Qt5::OpenGL ${QT5PLATFORMSUPPORT_LIBS})
-# target_link_libraries(ssr-wfs Qt5::Widgets Qt5::OpenGL)
+  target_link_libraries(ssr-wfs Qt5::Gui Qt5::Core Qt5::Widgets Qt5::OpenGL ${QT5PLATFORMSUPPORT_LIBS})
 endif(GUI)

README

@@ -1,6 +1,35 @@
+This is a fork of the SoundScape Renderer (SSR), which aims at porting the source code to Windows.
+
+The basic idea is to cross-compile on a linux machine an executable (.exe) for Windows.
+We use the M cross environment ([MXE](http://mxe.cc/)), which provides cross-compilation scripts for the dependencies and the MinGW64 (GCC) compiler.
+
+Getting started
+---------------
+* Install Jack Audio for Windows (64bit) from [Jack Audio Downloads](http://www.jackaudio.org/downloads/)
+* Get it running by following the [Installation and Configuration](http://jackaudio.org/faq/jack_on_windows.html).
+  Hint: If you plan on using other (ASIO) Audio-software with Jack, don't forget to register the 64-bit JackRouter.
+* Download and extract the latest [Release](https://github.com/chris-hld/ssr/releases). It contains everything you need, including the cross-compiled executables `ssr-binaural.exe` and `ssr-wfs.exe`.
+* Adapt the configuration file `ssr.conf.windows` to your needs. Replace the paths (`Z:\SSR`) to yours. For now, please only use absolute paths.
+
+Running the SSR on Windows
+--------------------------
+* Have a look at the (Documentation)[http://ssr.readthedocs.io/en/latest/operation.html#running-the-ssr]
+* First, start Jack audio, e.g. with the `qjackctl.exe`.
+* Start the SSR. There is a simple example script `start-ssr.cmd`.
+* Optional: Start your ASIO playback Software.
+* Connect everything using Jack Connection.
+
+This could look like this:
+
+![Jack](doc/manual/images/screenshot_jack.png)
+![SSR-Windows](doc/manual/images/screenshot_ssr-windows.png)
+
+
+---
+
 This is the source distribution of SoundScape Renderer (SSR) licensed under the
 GPLv3+. Please consult the file COPYING for more information about this license.
- 
+
 The user manual in the doc/ directory contains relevant informations about the
 SSR, including installation instructions. Additional (very detailed)
 installation instructions can be found in the file INSTALL.
@@ -12,7 +41,7 @@ Website: http://spatialaudio.net/ssr/
 
 Copyright (c) 2016 Division of Applied Acoustics
                    Chalmers University of Technology
-                        
+
 Copyright (c) 2012-2014 Institut für Nachrichtentechnik, Universität Rostock
 
 Copyright (c) 2006-2012 Quality & Usability Lab

data/ssr.conf.windows

@@ -0,0 +1,113 @@
+################################################################################
+# Example configuration file for the SoundScape Renderer (SSR)                 #
+#                                                                              #
+# Configuration files are processed in this order:                             #
+# 1) /Library/SoundScapeRenderer/ssr.conf                                      #
+# 2) /etc/ssr.conf                                                             #
+# 3) $HOME/Library/SoundScapeRenderer/ssr.conf                                 #
+# 4) $HOME/.ssr/ssr.conf                                                       #
+# 5) anything specified on the command line with "ssr --config=my_conf.file"   #
+#                                                                              #
+# If a parameter is specified more than once, the last occurrence counts!      #
+################################################################################
+
+# Correction of master volume in dB
+#MASTER_VOLUME_CORRECTION = 6
+
+# Exponent exp that determines the amplitude decay in virtual space ( 1/r^exp )
+#DECAY_EXPONENT = 0
+
+# Distance in m of equal level for plane waves and point sources
+#STANDARD_AMPLITUDE_REFERENCE_DISTANCE = 3
+
+# Switch off auto-rotation of sound sources toward the reference
+#AUTO_ROTATION = off
+
+# Default Scene file name 
+#SCENE_FILE_NAME = Z:\SSR\data\scenes\live_input.asd
+
+# GUI scene shortcuts
+#SCENE_MENU = scene_menu.conf
+
+# Default playback setup file
+PLAYBACK_SETUP_FILE_NAME = Z:\SSR\data\reproduction_setups\circle.asd
+
+# XML Schema file name to validate XML scene and reproduction setup files
+XML_SCHEMA_FILE_NAME = Z:\SSR\data\asdf.xsd
+
+# audio recorder file name
+#AUDIO_RECORDER_FILE_NAME = test07.wav
+
+# renderer type: WFS, binaural, BRS, VBAP, AAP, generic
+#RENDERER_TYPE = WFS
+
+########################## JACK settings #######################################
+
+# alsa input port prefix
+#INPUT_PREFIX = "alsa_pcm:capture_"
+
+# alsa output port prefix
+#OUTPUT_PREFIX = "alsa_pcm:playback_"
+
+########################## Renderer type settings ##############################
+
+# WFS:
+WFS_PREFILTER = Z:\SSR\data\impulse_responses\wfs_prefilters\wfs_prefilter_120_1500_44100.wav
+#DELAYLINE_SIZE = 100000
+#INITIAL_DELAY = 1000
+
+# binaural
+HRIR_FILE_NAME = Z:\SSR\data\impulse_responses\hrirs\hrirs_fabian_min_phase_eq.wav
+#HRIR_SIZE = 512
+
+# Ambisonics
+#AMBISONICS_ORDER = 3
+#IN_PHASE_RENDERING = TRUE # "true" works as well
+
+################################# GUI settings #################################
+
+# location of images for GUI
+PATH_TO_GUI_IMAGES = Z:\SSR\data\images
+
+# Enable GUI
+#GUI = on
+
+############################# head tracker settings ############################
+
+# select head tracker
+#TRACKER = fastrak
+#TRACKER = patriot
+#TRACKER = intersense
+TRACKER = razor
+
+# space separated list of serial ports which are tried for Polhemus Fastrak
+TRACKER_PORTS = "COM4"
+
+############################ IP Interface configuration ########################
+
+# ENABLE IP Server Interface
+NETWORK_INTERFACE = on
+
+# Listening server port
+SERVER_PORT = 4711
+
+# ASCII code of character to end messages with (binary zero: 0; new line: 10; 
+# carriage return: 13)
+END_OF_MESSAGE_CHARACTER = 10
+
+############################## Verbosity Level #################################
+
+# Set the level of system information
+#
+# Level 0: Only errors and warnings are shown.
+# Level 1: A few more messages are shown.
+# Level 2: Quite a lot messages are shown.
+# Level 3: Even messages which can repeat many times per second are shown.
+#	    This is a lot of messages!
+#
+VERBOSE = "3"
+
+################################################################################
+
+# Loop audio files (individually, not synchronized!)
+#LOOP = yes