simscene/python

h1. SimScene.py - An acoustic pattern generation tool

Copyright (c) Emmanouil Theofanis Chourdakis <e.t.chourdakis@qmul.ac.uk>

SimScene.py is a collection of tools to synthesize an audio scene from independent sound events. 

It is inspired by Lagrange et al. simScene (https://bitbucket.org/mlagrange/simscene) but takes

a different direction. The goal of simScene.py is to (1) have a python implementation of such a 

system since python is the platform of choice for developers accustomed with deep learning packages

or other python package candy and (2) to allow generating audio scenes from graph-based patterns.

*Currently it can only batch-generate acoustic scenes with target EBRs*

Please direct any comments, suggestions, etc. to Emmanouil Chourdakis <e.t.chourdakis@qmul.ac.uk>

This code is licensed under GPLv3. Please see LICENSE for more info.

h2. Usage

The best way to show usage of the tool is through an example of generating 10 scenes of bird sounds in the forest.  First, clone this repository in a directory (requires mercurial):

@hg clone https://code.soundsoftware.ac.uk/hg/simscene-py@

Then install the necessary libraries

@pip install -r requirements.txt@

Then open the files _forest_backgrounds.xls_ and _forest_events.xls_ in the _examples_ folder which contain information about the event and background tracks (for now do not change them, just see that you can open them). Note that you can view the same files as _.txt_ files in the same directory. SimScene.py allows both formats. 

Here is a preview of the _forest_backgrounds.xls_ in Calc:

!forest_backgrounds.png!

An explanation of the fields follows:

*  *label* - The name of the track

*  *sampleid* - Prefix of the filename the track uses. If there are many files with _sampleid_ as their prefix, one as random is picked and used for generation.

*  *snr* - For the first row, it is just the amplitude of that track. For the second row and below, it is the SNR (not dB) of the track of that row, relative to the sum of the other tracks.