commit dd109646973fd4af2e2cc11b60eb6a1fcd4c9411
parent 512a5e299f8b7e1cd95f283f016d09178436b278
Author: Keith Bloemer <[email protected]>
Date: Sun, 23 May 2021 14:27:14 -0500
Update README.md
Diffstat:
1 file changed, 7 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ There are four main components to the guitar pedal:
The bare bones pedal can be built for around $120.
+This is the normal VST3 plugin, which can be compiled for Windows/Mac/Linux using JUCE. It includes a model import feature, dropdown menu, and gain/level controls. The plugin compiled for Elk Audio OS is headless, meaning there is no GUI.
## Installing the plugin
@@ -23,6 +24,12 @@ For the cross-compiled Raspberry Pi / Elk Audio OS compatible VST3 plugin, downl
WARNING: The audio output of the NeuralPi is at line level. Guitar amplifiers expect a low level electric guitar signal (instrument level). When using the NeuralPi with a guitar amp, start with the master volume at 0 and SLOWLY increase from there.
+## To Do
+
+Currently, the NeuralPi plugin has no user controls. It runs a single model that can be swapped out before running the plugin. The next step is to add user controls via OSC messages, so that a remote instance of the plugin can control the NeuralPi over Wifi. These controls will include Gain/Volume, EQ, and model selection.
+
+Elk Audio OS also supports physical controls through [Sensei](https://github.com/elk-audio/sensei). Gain/Volume and EQ knobs can be added, as well as a LCD screen for selecting different models. One could build an actual guitar pedal with NeuralPi and any number of other digital effects and controls.
+
## Info
The neural network is a re-creation of the LSTM inference model from [Real-Time Guitar Amplifier Emulation with Deep Learning](https://www.mdpi.com/2076-3417/10/3/766/htm)
