This library is under active development as of 2018.
This library is under active development as of 2018.
**REQUIREMENTS**
This library uses a forked (modified) version of [DmaSpi](https://github.com/Blackaddr/DmaSpi) for Teensy, a library that extends SPI functionality to support DMA. This allows audio programs to use external SPI RAM with very little processor overhead.
**YOU MUST DOWNLOAD AND INSTALL THE DMA SPI LIBRARY FROM THE LINK ABOVE SEPARATELY TO USE THIS BAGUITAR LIBRARY. IT IS NOT AUTOMATICALLY INSTALLED AS PART OF THE BAGUITAR LIBRARY**
Last tested with:
Last tested with:
Arduino IDE: v1.8.5
Arduino IDE: v1.8.5
Teensyduino: v1.41*
Teensyduino: v1.41*
@ -20,20 +15,22 @@ Teensyduino provides a realtime Audio library that makes it very easy for musici
BAGuitar adds to this by providing features and building blocks that are of particular interest to guitarists. In a nutshell, guitarists want digital audio to work similar to their guitar pedals and amps. Basically, a chain of self-contained audio processors with switches and knobs to control them. The good news is we can do this digitally with virtual patch cables (called AudioConnections) and MIDI control.
BAGuitar adds to this by providing features and building blocks that are of particular interest to guitarists. In a nutshell, guitarists want digital audio to work similar to their guitar pedals and amps. Basically, a chain of self-contained audio processors with switches and knobs to control them. The good news is we can do this digitally with virtual patch cables (called AudioConnections) and MIDI control.
**INSTALLATION**
**INSTALLATION**
In order to use BAGuitar, you should:
In order to use BALibrary, you should:
1. Install the Arduino IDE. This is where you write and compile your software, called 'sketches'. See [here](https://www.arduino.cc/en/Main/Software).
1. Install the Arduino IDE. This is where you write and compile your software, called 'sketches'. See [here](https://www.arduino.cc/en/Main/Software).
2. Install the Teensyduino plugin for the Arduino IDE. This provides support for programming Teensy boards over USB, as well as access to the plethora of helpful libraries and examples it provides. See [here](https://www.pjrc.com/teensy/td_download.html).
2. Install the Teensyduino plugin for the Arduino IDE. This provides support for programming Teensy boards over USB, as well as access to the plethora of helpful libraries and examples it provides. See [here](https://www.pjrc.com/teensy/td_download.html).
3. Download the BAGuitar library, and use the Library Manager in the Arduino IDE to install it. See [here](https://www.arduino.cc/en/Guide/Libraries) for details..
3. Download the BALibrary library, and use the Library Manager in the Arduino IDE to install it. See [here](https://www.arduino.cc/en/Guide/Libraries) for details..
4. Include "BAGuitar.h" in your sketch.
4. Include "BALibrary.h" for access to general purpose classes.
5. Include "BAEffects.h" for access to Blackaddr Audio custom audio effect classes.
**HARDWARE**
**HARDWARE**
The audio primitives and effects provided in the BAGuitar library require no special hardware other than a Teensy 3.x series board. However, in order to use the external RAM features provided in some effects, the SPI pins used must be the same as those used on the Blackaddr [TGA-Pro audio shield](http://blackaddr.com/products/).
The audio primitives and effects provided in the BALibrary library require no special hardware other than a Teensy 3.x series board. However, in order to use the external RAM features provided in some effects, the SPI pins used must be the same as those used on the Blackaddr [TGA-Pro audio shield](http://blackaddr.com/products/).
Blackaddr Audio
6 years ago
committed by
GitHub