view README @ 0:add35537fdbb tip

Initial import
author irh <ian.r.hobson@gmail.com>
date Thu, 25 Aug 2011 11:05:55 +0100
parents
children
line wrap: on
line source
--------------------------------------------------------------------------------
GPSynth (c) 2011 Ian Hobson - ian.r.hobson@gmail.com
--------------------------------------------------------------------------------

GPSynth is a program that uses genetic programming techniques to artificially 
evolve SuperCollider synthesizers towards the ability to emulate a target sound 
file.

GPSynth is open source software, released under a GPL license. 
See the COPYING file for information on how this software can be used.


--------------------------------------------------------------------------------
Requirements
--------------------------------------------------------------------------------

GPSynth has been tested on OS X 10.6.8. It should compile on Linux but has not
been tested yet. Support for Linux will be added soon.

GPSynth requires SuperCollider to be installed on your system. If you don't have
SuperCollider in /Applications/SuperCollider then you need to specify the path
to its location with the --scpath option.


--------------------------------------------------------------------------------
Usage
--------------------------------------------------------------------------------

In its most simple form, gpsynth takes a single argument, --target:

gpsynth --target test.wav

GPSynth uses Libsndfile to load audio file data, for a list of supported formats
see http://www.mega-nerd.com/libsndfile.

A timestamped folder will be created in the current path, use the --workfolder
option to change where the folder will be created. 

See gpsynth --help for a full list of options.


--------------------------------------------------------------------------------
Build instructions
--------------------------------------------------------------------------------

Building GPSynth has been tested on Mac OS X 10.6.8 with LLVM 3.0 and GCC 4.2.

You need the following libraries installed on your system to build GPSynth.
Boost (at least v1.44, tested against v1.47) with libraries compiled with 
multi-threading enabled.
LibSndFile
FFTW

If these libraries are not on your system, an easy way to get them is with 
Homebrew (http://mxcl.github.com/homebrew/). After installing homebrew the 
following commands should get your system ready to compile GPSynth:

brew install boost
brew install libsndfile
brew install fftw

An XCode 4 project is included with GPSynth for convenience, however the best
way to install GPSynth is by using the CMake build scripts. If you don't have 
CMake on your system then it can be installed with Homebrew:
brew install cmake

cd in to the root of the gpsynth source directory (where this README file is),
then perform the following commands:
mkdir build
cd build
cmake ..
sudo make install