Merge branch 'main' of https://github.com/rerdavies/pipedal into main
This commit is contained in:
Robin Davies
@@ -1,15 +1,15 @@
|
||||
# PiPedal
|
||||
|
||||
PiPedal is a multi-effect guitar pedal that provides a clean compact web interface that's suitable for use on small-format devices
|
||||
like phones and tablets, although it works gloriously with desktop browers as well.
|
||||
PiPedal is a multi-effect guitar pedal for Raspberry Pi devices. You will need a suitable audio input/output device to use PiPedal, which can be either an external USB audio adapter, or a Raspberry Pi ADC/DAC hat, providing at least one input and one output audio channel.
|
||||
|
||||
PiPedal uses LV2 audio plugins. There are currently a wide variety of sources for excellent LV2 guitar plugins. You can add as many
|
||||
plugins to your patch as your CPU will support (well over a dozen on a Raspberry Pi 4+). Audio signal chains
|
||||
PiPedal is controlled via a clean compact web app that's suitable for use on small-form devices, like phones and tablets, although it works gloriously with desktop browers as well. You should not have to carry around a laptop to control your PiPedal when you're out gigging; and the web interface for PiPedal has been designed with that scenario specifically in mind. PiPedal has been designed with compact display formats, and touch user-interfaces in mind. Just connect to the PiPedal Wi-Fi access point with your phone, and you have complete control over your PiPedal.
|
||||
|
||||
PiPedal effects are LV2 audio plugins. There are currently a wide variety of sources for excellent LV2 guitar plugins.
|
||||
|
||||
You can add as many plugins to your patch as your CPU will support (well over a dozen on a Raspberry Pi 4+). Signal chains
|
||||
can have an arbitrary number of split chains, which maybe A/B-selected or mixed if you wish.
|
||||
|
||||
If you have a USB Midi Controller, you can bind Midi controls and notes to LV2 plugin controls using the Midi Bindings dialog.
|
||||
This particularly useful if you have a USB Midi footccontroller or a small USB Midi controller such as the Korg Nano or AKAI \
|
||||
midi controllers.
|
||||
PiPedal allows you to easily bind Midi controls and notes to LV2 plugin controls using the Midi Bindings dialog. USB micro controllers such as the Korg nano series of MIDI controllers, or the AKAI pad controllers are perfectly suited for selecting and tweaking patches while performing; or you can connect regular MIDI controllers and pedalboards via the MIDI ports on your USB Audio device, if it supports MIDI.
|
||||
|
||||
## Configuring PiPedal After Installation
|
||||
|
||||
@@ -19,71 +19,81 @@ Raspberry Pi, if you are connected from an Android device (which does not curren
|
||||
|
||||
To complete the initial configuration, you must either connect an Ethernet cable to your Raspberry pi so you can connect to the Web App (after which you should be able to connect to http://pipedal.local); or you must launch a web browser on your Raspberry pi device while logged in interactively.
|
||||
|
||||
Once connected, you can activate a WiFi hotspot on your Rasberry Pi which can be used to connect to PiPedal while it is not connected to an Ethernet network.
|
||||
Once connected, select the Settings menu item on the Hamburger menu at the top left corner of the display. Click on Audio Device Settings to select and configure the audio device you want to use.
|
||||
|
||||
You can also activate PiPedal's Wi-Fi hotspot connection from the Settings dialog. Click on the Wifi Hotspot menu item in the Settings dialog.
|
||||
|
||||
IMPORTANT NOTE: Activating the WiFi hotspot will DISABLE outbound Wi-Fi connections from the Raspberry Pi.
|
||||
You will be able to access the PiPedal web interface through the hotspot connection, and make ssh and VNC
|
||||
connections to the Raspberry Pi through the hotspot connection; but your Raspberry Pi will not have outbound access
|
||||
to the Internet.
|
||||
connections to the Raspberry Pi through the hotspot connection; but your Raspberry Pi will not have
|
||||
outbound access to the Internet, unless an Ethernet cable is connected to the Raspberry Pi.
|
||||
|
||||
If you need access to the internet once the hotspot has been enabled, connect an Ethernet cable to
|
||||
the Raspberry Pi.
|
||||
|
||||
Settings to configure the WiFi hotspot are available in the hamburger menu/Settings dialog.
|
||||
|
||||
There are a number of other useful settings in the hamburger menu/Settings dialog. For example, most USB audio devices route instrument
|
||||
input onto the right channel of the USB audio inputs. So you probably want to configure PiPedal to use only the right USB audio input channel.
|
||||
input onto the right channel of the USB audio inputs. So you probably want to configure PiPedal to use only the right USB audio input channel.
|
||||
You can choose how to bind USB audio input and output channels (stereo, left only, right only) in the settings dialog. If you are using a Audio
|
||||
device that has more than two channels, you will be offered a list of channels to choose from instead.
|
||||
|
||||
|
||||
You can choose how to bind USB audio input and output channels (stereo, left only, right only) in the settings dialog.
|
||||
|
||||
## Command Line Configuration of PiPedal
|
||||
|
||||
The pipedalconfig program can be used to modify configuration of PiPedal from a shell command line. Run 'pipedalconfig --help' to view
|
||||
available configuration commands, some of which are not avaialbe from the web interface. (For example, you can change the port number
|
||||
of the Web App HTTP server if you need to, uusing pipedalconfig).
|
||||
available configuration commands, some of which are not avaialbe from the web interface. For example, you can change the port number
|
||||
of the Web App HTTP server if you need to, using pipedalconfig.
|
||||
|
||||
|
||||
## LV2 PLugins
|
||||
|
||||
PiPedal uses standard LV2 audio plugins for effects. There are currently a wide variety of available LV2 guitar effect plugins, foremost of
|
||||
which is the Guitarix plugin collection: https://guitarix.org/
|
||||
PiPedal uses standard LV2 audio plugins for effects. There are currently a wide variety of available LV2 guitar effect plugins, and among
|
||||
these are a number of LV2 plugin collections that are specifically meant for use as guitar effects.
|
||||
|
||||
To get started, install the Guitarix LV2 plugin collection.
|
||||
Foremost among these is the Guitarix plugin collection: https://guitarix.org/. You should definitely install Guitarix:
|
||||
|
||||
sudo apt install guitarix-lv2
|
||||
|
||||
The Guitarix amp modelling plugins are on par with the best amp modelling effects anywhere.
|
||||
|
||||
Other highly recommended guitar effect collections:L
|
||||
|
||||
sudo apt install zam-plugins # http://www.zamaudio.com/
|
||||
|
||||
sudo apt install mda-lv2 # http://drobilla.net/software/mda-lv2/
|
||||
|
||||
sudo apt install calf-plugins # http://calf-studio-gear.org/
|
||||
|
||||
sudo apt install fomp # http://drobilla.net/software/fomp/
|
||||
|
||||
sudo apt install jackd
|
||||
sudo apt install guitarix-lv2
|
||||
sudo apt install zam-plugins
|
||||
sudo apt install mda-lv2
|
||||
sudo apt install fomp
|
||||
|
||||
But there are hundreds of other high-quality LV2 plugins that are suitable for use with PiPedal.
|
||||
|
||||
- Zam Plugins. http://www.zamaudio.com/
|
||||
Visit https://lv2plug.in/pages/projects.html for a more suggestions.
|
||||
|
||||
- Calf Plugins. http://calf-studio-gear.org/
|
||||
|
||||
Or visit https://lv2plug.in/pages/projects.html for a more complete list.
|
||||
|
||||
There is also a set of supplementary Gx effect plugins which did not make it into the main Guitarix distribution. You
|
||||
have to build these plugins yourself, but the effort is well worthwhile.
|
||||
There is also a set of supplementary Gx effect plugins which did not make it into the main Guitarix distribution. You will
|
||||
have to compile these plugins yourself, as they are not currently avaiable via apt. But if you are comfortable building
|
||||
packages on Raspbian, the effort is well worthwhile. The GxPlugins collection provides a number of boutique amp emulations,
|
||||
as well as emulations of famous distortion effect pedals.
|
||||
|
||||
- https://github.com/brummer10/GxPlugins.lv2
|
||||
|
||||
|
||||
PiPedal will automatically detect installed LV2 plugins and make them selectable from the web app interface, as long as they meet the
|
||||
following conditions:
|
||||
|
||||
- Must have mono or stereo audio inputs and outputs.
|
||||
|
||||
- Must not have MIDI or CV inputs.
|
||||
- Must not be MIDI instruments or have CV (Control Voltage) inputs or outputs.
|
||||
|
||||
- Must be remotely controllable (no hard dependency on GUI-only controls), which is true of the vast majority of LV2 plugins.
|
||||
- Must be remotely controllable (no hard dependency on GUI-only controls), which is true of the vast majority of LV2 plugins).
|
||||
|
||||
Most LV2 plugins have GUI interfaces, which are not used by PiPedal; but the LV2 plugin standard allows almost all LV2 plugins to
|
||||
be controlled via PiPedal's web interface.
|
||||
Althouhg most LV2 plugins provide GUI interfaces, when running on a LINUX desktop, the LV2 plugin standard is specifically designed to allow remote control
|
||||
without using the provided desktop GUI interface. And all but a tiny minority of LV2 plugins support this.
|
||||
|
||||
### Building and Installing PiPedal
|
||||
## Building and Installing PiPedal
|
||||
|
||||
PiPedal has only been tested on Raspbian. But we will gladly accept pull requests to correct problems with other versions of Linux.
|
||||
PiPedal has only been tested on Raspbian. But we pull requests to correct problems with building PiPedal on other versions of Linux are welcome.
|
||||
|
||||
To build PiPedal, a Raspberry Pi 4B, with at least 4GB of memory is recommended. You should be able to cross-compile PiPedal easily enough,
|
||||
but we do not currently provide support for this. Consult CMake documentation on how to cross-compile source.
|
||||
@@ -99,7 +109,7 @@ Run the following commands to install build tools required by the PiPedal build.
|
||||
sudo apt-get install -y nodejs
|
||||
|
||||
|
||||
Run the following commands to install dependent components required by the PiPedal build.
|
||||
Run the following commands to install dependent libraries required by the PiPedal build.
|
||||
|
||||
sudo apt update
|
||||
sudo apt install liblilv-dev libboost-dev libjack-jackd2-dev libnl-3-dev libnl-genl-3-dev libsystemd-dev catch
|
||||
@@ -112,21 +122,32 @@ of `node.js` installed already. Otherwise run the following commands as root to
|
||||
apt-get install -y nodejs
|
||||
|
||||
|
||||
### Building PiPedal.ini
|
||||
### Building PiPedal
|
||||
|
||||
PiPedal was developed using Visual Studio Code. If you open the PiPedal project as a folder in VS Code, Code will
|
||||
detect the CMake configuration files, and automatically configure itself. Once the VS Code CMake plugin has configured
|
||||
itself, build commands should appear on the bottom line of the Visual Studio Code interface.
|
||||
detect the CMake configuration files, and automatically configure itself. Once the VS Code CMake plugin (written by Microsoft,
|
||||
available through the plugins store) has configured itself, build commands should appear on the bottom line of Visual Studio
|
||||
Code. Visual Studio Code will take care of automatically configuring the project.
|
||||
|
||||
To install PiPedal, run a full non-debug build using Visual Studio Code, and then run the following command
|
||||
in the root project directory:
|
||||
If you are not using Visual Studio Code, you can configure, build and install PiPedal using CMake build tools. For your convenience,
|
||||
the following shell scripts have been provided in the root of the project.
|
||||
|
||||
sudo ,./init
|
||||
sudo ./init # Configure the CMake build
|
||||
|
||||
If you are using a different development environment, you can build the project by running the following
|
||||
command in the root project directory.
|
||||
./mk # Build all targets.
|
||||
|
||||
sudo ./install # Deploy all targets
|
||||
|
||||
./pkg # Build a .deb file for distribution.
|
||||
|
||||
If you are using a development environment other than Visual Studio Code, it should be fairly straightforward to figure out how
|
||||
to incorporate the PiPedal build procedure into your IDE workflow by examining the contents of the build shell scripts.
|
||||
|
||||
./mk
|
||||
The CMake toolchain can be used to generate build scripts for other build environments as well (e.g. Visuual Studio .csproj files, Ant, or Linux
|
||||
Makefiles); and can be configured to perform cross-compiled builds as well. Consult documentation for CMake for instructions on how to
|
||||
do that if you're interested. Visual Studio Code also provides quite painless procedures for cross-compiling CMake projects, and for
|
||||
remote building, and debugging. If you need to build for platforms other than Raspbian, or build on platforms other than Rasbian,
|
||||
you make want to investigate what Visual Studio Code's CMake integration provides in that regard.
|
||||
|
||||
### How to Debug PiPedal.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user