Skip to content

Commit

Permalink
Improve mod-host doc
Browse files Browse the repository at this point in the history
  • Loading branch information
SrMouraSilva committed Apr 1, 2017
1 parent 02adeb8 commit 04b8736
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CHANGES
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Version 0.2.0 -- released 3/30/17
Version 0.2.0 -- released 3/31/17
=================================
- Initial release
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Include the license file
include LICENSE
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ Example

This examples uses `Calf`_ and `Guitarix`_ audio plugins

Download and install `mod-host`_. For more information: :class:`Mod-host`
Download and install `mod-host`_. For more information, check the `ModHost` section.

Start audio process

.. code-block:: bash
# In this example, is starting a Zoom g3 series audio interface
jackd -R -P70 -t2000 -dalsa -dhw:Series -p256 -n3 -r44100 -s &
mod-host &
mod-host
Play!

Expand Down Expand Up @@ -113,7 +113,7 @@ Add effects in the pedalboard
# or
# pedalboard.effects.append(reverb2)
For obtains automatically the sound card inputs and outputs, use :class:`SystemEffectBuilder`. It requires `JACK-Client`_.
For obtains automatically the sound card inputs and outputs, use `SystemEffectBuilder`. It requires `JACK-Client`_.

.. _JACK-Client: https://jackclient-python.readthedocs.io/

Expand Down
51 changes: 51 additions & 0 deletions docs/source/mod_host.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,57 @@
PedalPi - PluginsManager - ModHost
==================================

About `mod-host`
----------------

`mod-host`_ is a LV2 host for Jack controllable via socket or command line.
With it you can load audio plugins, connect, manage plugins.

For your use, is necessary download it

.. code-block:: bash
git clone https://github.com/moddevices/mod-host
cd mod-host
make
make install
Then boot the JACK process and start the `mod-host`.
Details about "JACK" can be found at https://help.ubuntu.com/community/What%20is%20JACK

.. code-block:: bash
# In this example, is starting a Zoom g3 series audio interface
jackd -R -P70 -t2000 -dalsa -dhw:Series -p256 -n3 -r44100 -s &
mod-host
You can now connect to the mod-host through the Plugins Manager API.
Create a ModHost object with the address that is running the `mod-host` process.
Being in the same machine, it should be `'localhost'`

.. code-block:: python
mod_host = ModHost('localhost')
mod_host.connect()
Finally, register the mod-host in your BanksManager.
Changes made to the current pedalboard will be applied to `mod-host`

.. code-block:: python
manager = BanksManager()
# ...
manager.register(mod_host)
To change the current pedalboard, change the `pedalboard` parameter to `mod_host`.
Remember that for changes to occur in `mod-host`, the `pedalboard` must belong to some `bank` of `banks_manager`.

.. code-block:: python
mod_host.pedalboard = my_awesome_pedalboard
.. _mod-host: https://github.com/moddevices/mod-host

ModHost
-------
.. autoclass:: pluginsmanager.mod_host.mod_host.ModHost
Expand Down
1 change: 0 additions & 1 deletion pluginsmanager/model/lv2/lv2_output.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ class Lv2Output(Output):
For general input use, see :class:`Output` class documentation.
.. _output audio port: http://lv2plug.in/ns/lv2core/#OutputPort
http://lv2plug.in/ns/lv2core/#Parameter
:param Lv2Effect effect:
:param dict effect_output: *output audio port* json representation
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ def readme():
'pluginsmanager/util',
],
package_data={
'pluginsmanager/': ['LICENSE'],
'pluginsmanager/model/lv2': ['plugins.json']
},
test_suite='test',
install_requires=['JACK-Client'],

test_suite='test',
tests_require=['JACK-Client'],

classifiers=[
Expand Down

0 comments on commit 04b8736

Please sign in to comment.