SmartGuitarAmp

Guitar plugin made with JUCE that uses neural networks to emulate a tube amplifier
Log | Files | Refs | Submodules | README

README.md (2546B)

      1 # SmartGuitarAmp
      2 
      3 [![Downloads](https://img.shields.io/github/downloads/GuitarML/SmartGuitarAmp/total)](https://somsubhra.github.io/github-release-stats/?username=GuitarML&repository=SmartGuitarAmp&page=1&per_page=30) [![CI](https://github.com/GuitarML/SmartGuitarAmp/actions/workflows/cmake.yml/badge.svg)](https://github.com/GuitarML/SmartGuitarAmp/actions/workflows/cmake.yml)
      4 
      5 Guitar plugin made with JUCE that uses neural network models to emulate real world hardware.
      6 
      7 See video demo on [YouTube](https://youtu.be/I9DElOaZvHos)
      8 
      9 This plugin uses a WaveNet model to recreate the sound of real world hardware. The current version
     10 models a small tube amp at clean and overdriven settings. Gain and EQ knobs were added to 
     11 modulate the modeled sound.
     12 
     13 ![app](https://github.com/GuitarML/SmartGuitarAmp/blob/main/resources/amp_pic.jpg)
     14 
     15 You can create your own models and load them in SmartGuitarAmp with minor code modifications.
     16 To train your own models, use [PedalNetRT](https://github.com/GuitarML/PedalNetRT)
     17 
     18 Model training is done using PyTorch on pre recorded .wav samples. More info in the above repository.
     19 To share your best models, email the json files to smartguitarml@gmail.com and they may be included 
     20 in the latest release as a downloadable zip.
     21 
     22 Also see companion plugin, the [SmartGuitarPedal](https://github.com/GuitarML/SmartGuitarPedal)<br>
     23 Note: As of SmartAmp version 1.3, the custom model load was removed to simplify the plugin. To load user
     24 trained models, use the SmartGuitarPedal, which plays all models trained with PedalNetRT.
     25 
     26 ## Installing the plugin
     27 
     28 1. Download the appropriate plugin installer (Windows, Mac, Linux) from the [Releases](https://github.com/GuitarML/SmartGuitarAmp/releases) page.
     29 2. Run the installer and follow the instructions. May need to reboot to allow your DAW to recognize the new plugin.
     30 
     31 ## Build Instructions
     32 
     33 ### Build with Cmake
     34 
     35 ```bash
     36 # Clone the repository
     37 $ git clone https://github.com/GuitarML/SmartGuitarAmp.git
     38 $ cd SmartGuitarAmp
     39 
     40 # initialize and set up submodules
     41 $ git submodule update --init --recursive
     42 
     43 # build with CMake
     44 $ cmake -Bbuild
     45 $ cmake --build build --config Release
     46 ```
     47 The binaries will be located in `SmartAmp/build/SmartAmp_artefacts/`
     48 
     49 ## License
     50 This project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE) file for details.
     51 
     52 This project builds off the work done in [WaveNetVA](https://github.com/damskaggep/WaveNetVA)
     53 
     54 The EQ code used in this plugin is based on the work done by Michael Gruhn in 4BandEQ algorithm.