PedalPi - PluginsManager¶
Pythonic management of LV2 audio plugins with mod-host.
- Documentation:
- http://pedalpi-pluginsmanager.readthedocs.io/
- Code:
- https://github.com/PedalPi/PluginsManager
- Python Package Index:
- https://pypi.org/project/PedalPi-PluginsManager
- License:
- Apache License 2.0
Install¶
Plugin Manager has dependencies that must be installed before installing the library. Among the dependencies are lv2ls to check the installed audio plugins and PortAudio for information on the audio interfaces through PyAudio.
On Debian-based systems, run:
sudo apt-get install -y portaudio19-dev python-all-dev lilv-utils --no-install-recommends
Of course, for PluginsManager to manage Lv2 audio plugins, it is necessary that they have installed audio plugins to be managed. The Guitarix and Calf Studio projects provide some audio plugins. To install them:
.. code-block:: bash
pip install PedalPi-PluginsManager
Example¶
Note
Other examples are in the examples folder in the repository.
This examples uses Calf and Guitarix audio plugins.
Download and install mod-host. For more information, check the ModHost section.
Start audio process
# In this example, is starting a Zoom g3 series audio interface
jackd -R -P70 -t2000 -dalsa -dhw:Series -p256 -n3 -r44100 -s &
mod-host
Play!
from pluginsmanager.banks_manager import BanksManager
from pluginsmanager.observer.mod_host.mod_host import ModHost
from pluginsmanager.model.bank import Bank
from pluginsmanager.model.pedalboard import Pedalboard
from pluginsmanager.model.connection import Connection
from pluginsmanager.model.lv2.lv2_effect_builder import Lv2EffectBuilder
from pluginsmanager.model.system.system_effect import SystemEffect
Creating a bank
# BanksManager manager the banks
manager = BanksManager()
bank = Bank('Bank 1')
manager.append(bank)
Connecting with mod_host. Is necessary that the mod_host process already running
mod_host = ModHost('localhost')
mod_host.connect()
manager.register(mod_host)
Creating pedalboard
pedalboard = Pedalboard('Rocksmith')
bank.append(pedalboard)
# or
# bank.pedalboards.append(pedalboard)
Loads pedalboard. All changes in pedalboard are reproduced in mod_host
mod_host.pedalboard = pedalboard
Add effects in the pedalboard
builder = Lv2EffectBuilder()
reverb = builder.build('http://calf.sourceforge.net/plugins/Reverb')
fuzz = builder.build('http://guitarix.sourceforge.net/plugins/gx_fuzz_#fuzz_')
reverb2 = builder.build('http://calf.sourceforge.net/plugins/Reverb')
pedalboard.append(reverb)
pedalboard.append(fuzz)
pedalboard.append(reverb2)
# or
# pedalboard.effects.append(reverb2)
For obtains automatically the sound card inputs and outputs, use SystemEffectBuilder. It requires a JackClient instance, that uses JACK-Client.
from pluginsmanager.jack.jack_client import JackClient
client = JackClient()
from pluginsmanager.model.system.system_effect_builder import SystemEffectBuilder
sys_effect = SystemEffectBuilder(client)
For manual input and output sound card definition, use:
sys_effect = SystemEffect('system', ['capture_1', 'capture_2'], ['playback_1', 'playback_2'])
Note
NOT ADD sys_effect in any Pedalboard
Connecting mode one:
sys_effect.outputs[0].connect(reverb.inputs[0])
reverb.outputs[0].connect(fuzz.inputs[0])
reverb.outputs[1].connect(fuzz.inputs[0])
fuzz.outputs[0].connect(reverb2.inputs[0])
reverb.outputs[0].connect(reverb2.inputs[0])
reverb2.outputs[0].connect(sys_effect.inputs[0])
reverb2.outputs[0].connect(sys_effect.inputs[1])
Connecting mode two:
pedalboard.connections.append(Connection(sys_effect.outputs[0], reverb.inputs[0]))
pedalboard.connections.append(Connection(reverb.outputs[0], fuzz.inputs[0]))
pedalboard.connections.append(Connection(reverb.outputs[1], fuzz.inputs[0]))
pedalboard.connections.append(Connection(fuzz.outputs[0], reverb2.inputs[0]))
pedalboard.connections.append(Connection(reverb.outputs[0], reverb2.inputs[0]))
pedalboard.connections.append(Connection(reverb2.outputs[0], sys_effect.inputs[0]))
pedalboard.connections.append(Connection(reverb2.outputs[0], sys_effect.inputs[1]))
Warning
If you need connect system_output with system_input directly (for a bypass, as example), only the second mode will works:
pedalboard.connections.append(Connection(sys_effect.outputs[0], sys_effect.inputs[0]))
Set effect status (enable/disable bypass) and param value
fuzz.toggle()
# or
# fuzz.active = not fuzz.active
fuzz.params[0].value = fuzz.params[0].minimum / fuzz.params[0].maximum
fuzz.outputs[0].disconnect(reverb2.inputs[0])
# or
# pedalboard.connections.remove(Connection(fuzz.outputs[0], reverb2.inputs[0]))
# or
# index = pedalboard.connections.index(Connection(fuzz.outputs[0], reverb2.inputs[0]))
# del pedalboard.connections[index]
reverb.toggle()
Removing effects and connections:
pedalboard.effects.remove(fuzz)
for connection in list(pedalboard.connections):
pedalboard.connections.remove(connection)
for effect in list(pedalboard.effects):
pedalboard.effects.remove(effect)
# or
# for index in reversed(range(len(pedalboard.effects))):
# del pedalboard.effects[index]
Observer¶
ModHost
is an observer (see UpdatesObserver
).
It is informed about all changes that
occur in some model instance (BanksManager
, Bank
,
Pedalboard
, Effect
, Param
, ...),
allowing it to communicate with the mod-host
process transparently.
It is possible to create observers! Some ideas are:
- Allow the use of other hosts (such as Carla);
- Automatically persist changes;
- Automatically update a human-machine interface (such as LEDs and displays that inform the state of the effects).
How to implement and the list of Observers implemented by this library can be accessed in the Observer section.
Changelog¶
..include:: ../../CHANGES
Maintenance¶
Test¶
It is not necessary for the mod_host process to be running
coverage3 run --source=pluginsmanager setup.py test
coverage3 report
coverage3 html
firefox htmlcov/index.html
Generate documentation¶
This project uses Sphinx + Read the Docs.
You can generate the documentation in your local machine:
pip3 install sphinx
cd docs
make html
firefox build/html/index.html