Skip to content

Commit

Permalink
clarified readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Eero-Pekka Damskagg committed Mar 4, 2019
1 parent 753e252 commit d04cc2d
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# WaveNetVA

Feedforward WaveNet for black-box virtual analog modeling. This code is related to our SMC 2019 paper: https://link-to-pre.print
Feedforward WaveNet for black-box virtual analog modeling. This code is related to our paper submitted to [SMC 2019](http://smc2019.uma.es/): https://link-to-pre.print

A real-time implementation of the model built using JUCE. The code can be built as a standalone audio application or as an VST3, AU or AAX etc. plugin.

Audio samples are available on the [demopage](http://research.spa.aalto.fi/publications/papers/smc19-black-box/).
Audio samples are available on the [demo page](http://research.spa.aalto.fi/publications/papers/smc19-black-box/).

## Getting Started

Expand All @@ -14,17 +14,16 @@ Audio samples are available on the [demopage](http://research.spa.aalto.fi/publi
* Download and install [JUCE](https://juce.com/)
* The software has been tested with Juce version 5.4.2
* Download [Eigen](http://eigen.tuxfamily.org)
* Extract the Eigen folder to your home directory.
* Extract Eigen somewhere, e.g. your home directory.
* The software has been tested with Eigen version 3.3.7
* Open WaveNetVA.jucer file with Projucer
* Open and build project in XCode or Visual Studio.
* Add the Eigen folder to "Header Search Paths" in Exporters -> Debug/Release
* Open and build project in XCode or Visual Studio.

### Loading trained models

The trained models are stored as json files. The pre-trained models of the Ibanez Tube Screamer, Boss DS-1 and Electro-Harmonix Big Muff Pi described in the paper are included in the [Models](Models) directory.

Tensorflow code for training models and saving them to json files may be added later.

## License
This project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE) file for details.

0 comments on commit d04cc2d

Please sign in to comment.