Difference between revisions of "Developer Images"

From MOD Wiki
Jump to navigation Jump to search
(Created page with "This page contains links to the latest developer images.<br/> They are useful for developers and plugin creators, as they contain a few extra things not present on the default...")
 
Line 16: Line 16:
 
==== Carla ====
 
==== Carla ====
  
Carla runs by default as internal JACK client with OSC enabled.
+
Carla runs by default as internal JACK client with OSC enabled.<br/>
 
This makes it possible to connect remotely over OSC, using Carla-Control.
 
This makes it possible to connect remotely over OSC, using Carla-Control.
  
Note that at this point in time Carla-Control does not fetch the plugin list from the remote instance, so the available plugins shown in the add-plugin dialog will your local ones, not the MOD ones.
+
Note that at this point in time Carla-Control does not fetch the plugin list from the remote instance, so the available plugins shown in the add-plugin dialog will your local ones, not the MOD ones.<br/>
 
It is still useful as a way to visualize the entire internal JACK connections.
 
It is still useful as a way to visualize the entire internal JACK connections.
  
 
==== MOD-SDK ====
 
==== MOD-SDK ====
  
MOD-SDK runs at port 9000, so you can access it using http://192.168.51.1:9000/
+
MOD-SDK runs at port 9000, so you can access it using http://192.168.51.1:9000/<br/>
 
The deploy tab is pretty useless there, as the bundles are always running locally.
 
The deploy tab is pretty useless there, as the bundles are always running locally.
  
Note that MOD-SDK is a few releases behind in terms of plugin-supported features compared to MOD-UI (our webserver and session management tool).
+
Note that MOD-SDK is a few releases behind in terms of plugin-supported features compared to MOD-UI (our webserver and session management tool).<br/>
The preview of a few plugins will not look identical to their actual view on the pedalboard.
+
The preview of a few plugins will not look identical to their actual view on the pedalboard.<br/>
 
And LV2 patch parameters are not supported yet.
 
And LV2 patch parameters are not supported yet.
  
Line 35: Line 35:
 
Valgrind is available to debug plugins more easily, in terms of memory issues at least.
 
Valgrind is available to debug plugins more easily, in terms of memory issues at least.
  
In order to make this useful we need to stop the main audio server and host and run it manually within valgrind, so we catch any errors.
+
In order to make this useful we need to stop the main audio server and host and run it manually within valgrind, so we catch any errors.<br/>
We need to increase the buffer size as valgrind makes things run much slower, 128 frames is too fast for it.
+
We need to increase the buffer size as valgrind makes things run much slower, 128 frames is too fast for it.<br/>
 
Note that not all plugins work reliably with higher buffer sizes, so try to limit the amount of plugins in use during this mode.
 
Note that not all plugins work reliably with higher buffer sizes, so try to limit the amount of plugins in use during this mode.
  
Line 56: Line 56:
  
 
There will be a few warnings/errors regarding epoll_ctl which comes from ableton link, ignore them.
 
There will be a few warnings/errors regarding epoll_ctl which comes from ableton link, ignore them.
 
  
 
=== Manual update ===
 
=== Manual update ===

Revision as of 08:04, 9 September 2021

This page contains links to the latest developer images.
They are useful for developers and plugin creators, as they contain a few extra things not present on the default builds.
These include:

  • Carla
  • MOD-SDK
  • Valgrind

Release links

MOD Duo X: modduox-v1.10.4.2398.tar
MOD Dwarf: moddwarf-v1.10.4.2397.tar

Instructions

Carla

Carla runs by default as internal JACK client with OSC enabled.
This makes it possible to connect remotely over OSC, using Carla-Control.

Note that at this point in time Carla-Control does not fetch the plugin list from the remote instance, so the available plugins shown in the add-plugin dialog will your local ones, not the MOD ones.
It is still useful as a way to visualize the entire internal JACK connections.

MOD-SDK

MOD-SDK runs at port 9000, so you can access it using http://192.168.51.1:9000/
The deploy tab is pretty useless there, as the bundles are always running locally.

Note that MOD-SDK is a few releases behind in terms of plugin-supported features compared to MOD-UI (our webserver and session management tool).
The preview of a few plugins will not look identical to their actual view on the pedalboard.
And LV2 patch parameters are not supported yet.

Valgrind

Valgrind is available to debug plugins more easily, in terms of memory issues at least.

In order to make this useful we need to stop the main audio server and host and run it manually within valgrind, so we catch any errors.
We need to increase the buffer size as valgrind makes things run much slower, 128 frames is too fast for it.
Note that not all plugins work reliably with higher buffer sizes, so try to limit the amount of plugins in use during this mode.

Stopping and starting audio server + plugin host using valgrind can be done with:

```

  1. stopping jack2, run it a few times if jackd complains server already active

systemctl stop jack2

  1. setting up environment

source /etc/mod-hardware-descriptor.env export MOD_MIDI_SERIAL_PORT=${MIDI_SERIAL_PORT} export MOD_PEAKMETER_BUS_NUMBER=${I2C_MAIN_BUS} export MOD_PEAKMETER_GPIO_PATH=${PCA9685_OE_GPIO_PATH}

  1. starting jackd with the typical JACK clients

valgrind jackd -r -t 500 -C /etc/jack-internal-session.conf -d alsa -d hw:0 -r 48000 -p 1024 ```

There will be a few warnings/errors regarding epoll_ctl which comes from ableton link, ignore them.

Manual update

If you want to do a manual factory reset, follow these steps:

  1. Turn on your MOD
  2. Let it boot until you see "Knob 1" etc.
  3. Press and hold the left knob until a menu appears in the display
  4. Turn the knob in order to select "System Upgrade"
    1. Note -> In newer devices, turn the left knob to the "System" option and then the right knob to "System upgrade"
  5. Select 'YES' and while holding the left footswitch (Duo) or bottom left square button (DuoX), click on the right knob
  6. Let go of the footswitch and knob and wait
  7. The MOD will now enter restore mode. Please wait.
  8. Connect the MOD to your PC if not done yet and wait for a new mass storage drive to appear
  9. Copy the tar file onto the new drive and use your OS option to safely remove the drive
  10. Remove the USB cable connecting your PC to the MOD