Difference between revisions of "Max gen~"
m |
(Edits for the Max-package) |
||
| Line 5: | Line 5: | ||
Gen~ objects are normally used in Max as a way to write low-level code that is run at signal-rate, using (if you want to) the same visual approach Max is known for.<br> | Gen~ objects are normally used in Max as a way to write low-level code that is run at signal-rate, using (if you want to) the same visual approach Max is known for.<br> | ||
| − | Therefore the insides of a gen~ object can be seen as a pedal schematic, perfect for designing audio effects. <br> | + | Therefore the insides of a gen~ object can be seen as a pedal schematic, perfect for designing audio effects.<br> |
The SHIRO plugins are an example of audio effects made using this very method. | The SHIRO plugins are an example of audio effects made using this very method. | ||
| Line 11: | Line 11: | ||
* [https://docs.cycling74.com/max7/vignettes/gen_overview Gen Overview] | * [https://docs.cycling74.com/max7/vignettes/gen_overview Gen Overview] | ||
| − | * [http://blog.moddevices.com/2017/01/ | + | * [http://blog.moddevices.com/2017/01/08/create-a-gen-based-plugin-for-the-mod-duo Tutorial: Create a Gen-based plugin for the MOD Duo] |
== Designing your effect in Gen == | == Designing your effect in Gen == | ||
* To get your gen~ object working on the MOD Duo, you'll first need to design one using only Gen's internal objects, without referring to objects outside the gen~ object. Only the objects inside will make it to the final LV2-plugin. | * To get your gen~ object working on the MOD Duo, you'll first need to design one using only Gen's internal objects, without referring to objects outside the gen~ object. Only the objects inside will make it to the final LV2-plugin. | ||
| − | * If you want controllable parameters, define the minimum | + | * If you want controllable parameters, define the default, minimum and maximum arguments in the "param" object. |
* While designing your gen~ object, remember that the MOD Duo's samplerate is running at 48 kHz. | * While designing your gen~ object, remember that the MOD Duo's samplerate is running at 48 kHz. | ||
| − | + | If you download the MOD Duo-package from the Package Manager in Max and click on Launch, you'll find some example-plugins. | |
== Getting your Gen-based plugin to the MOD Duo == | == Getting your Gen-based plugin to the MOD Duo == | ||
| − | At this point you should have the | + | At this point you should have met the requirements specified above. If so, follow the steps below to get your plugin on the MOD Duo.<br> |
| − | If | + | In order to run Gen-based plugins on the MOD Duo they must be converted into LV2 plugins and compiled using a custom MOD cloud build system.<br> |
| + | All the heavy work has already been done by the MOD Team and Cycling '74. | ||
| + | |||
| + | * Go to or install the MOD Duo-package in the Package Manager in Max if you haven't, and click on Launch. | ||
| + | * Make sure your MOD Duo is connected, then start the MODwatcher from the popped-up screen. | ||
| + | * If you want your plugin to have a name on the MOD Duo, copy your gen~ objects contents to a gen~ object with a patcher-name argument.<br> NAMING YOUR ORIGINAL GEN~ OBJECT WILL INITIALIZE IT'S CONTENTS | ||
| + | * Finally send a message containing "exportnotifier MODwatcher, exportcode" (without the quotation marks) to the gen~ object. | ||
| + | |||
| + | Your plugin will now be transferred to the MOD Duo, within a few minutes the MODwatcher will tell you if the upload succeeded.<br> | ||
| + | If all goes well, your Gen-based plugin should now be inside the MOD Duo, ready to be played! | ||
| + | |||
| + | == Additional features (advanced) == | ||
| + | |||
| + | Optionally you can edit your plugin to, for example, add units, knob behavior, a description or even a GUI.<br> | ||
| + | This process is different from the process described above. It doesn't use the MOD Duo-package in Max. | ||
=== Compiling the plugin === | === Compiling the plugin === | ||
| − | |||
| − | |||
| − | |||
First, download http://download.moddevices.com/releases/max-gen/max-gen-deploy_v4.tar.gz and extract it. <br> | First, download http://download.moddevices.com/releases/max-gen/max-gen-deploy_v4.tar.gz and extract it. <br> | ||
| + | Send an "exportcode" message to the gen~ object in your main Max-patcher to get the gen_exported.cpp and gen_exported.h files.<br> | ||
Copy the gen_exported.cpp and gen_exported.h files into the extracted max-gen-deploy folder, and run: | Copy the gen_exported.cpp and gen_exported.h files into the extracted max-gen-deploy folder, and run: | ||
| Line 41: | Line 53: | ||
You'll be asked for a plugin name, and after providing one the cloud should give you back a tar.gz file within a few minutes. | You'll be asked for a plugin name, and after providing one the cloud should give you back a tar.gz file within a few minutes. | ||
| − | === | + | === Editing the plugin === |
| − | + | To add [http://lv2plug.in/ns/extensions/units/units.html units], [http://lv2plug.in/ns/ext/port-props/port-props.html knob behavior] or a description, you'll have to edit the .ttl file. | |
| + | If you do so, make sure everything is correct,<br> otherwise the plugin won't work and you might have to SSH into the MOD Duo to get the corrupt plugin out.<br> | ||
| + | To prevent this from happening, you can [http://lv2plug.in/pages/validating-lv2-data.html validate the lv2-data]. | ||
| − | + | The other option is to include a GUI, you can make one with the [https://github.com/moddevices/mod-sdk MOD SDK].<br> | |
| − | + | Have a look [http://github.com/moddevices/mod-v2-data/tree/master/plugins-fixed here] how a GUI affects the .ttl structure.<br> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<source lang="console"> | <source lang="console"> | ||
| Line 67: | Line 71: | ||
</source> | </source> | ||
| − | + | === Deploying the plugin === | |
| − | + | ||
| − | + | Make sure the MOD Duo is connected to your computer via USB before proceeding. Then run: | |
| + | |||
| + | <source lang="console"> | ||
| + | $ cd /path/to/max-gen-deploy/ | ||
| + | $ ./mod-deploy.sh | ||
| + | </source> | ||
Revision as of 19:35, 26 July 2017
Apart from programming LV2-plugins in a "traditional" way, it's also possible to generate LV2-plugins for the MOD Duo from gen~ objects created in Cycling '74 Max.
This page will tell you the how and why of programming audio effects for the MOD Duo using this very different approach.
Contents
Gen Basics
Gen~ objects are normally used in Max as a way to write low-level code that is run at signal-rate, using (if you want to) the same visual approach Max is known for.
Therefore the insides of a gen~ object can be seen as a pedal schematic, perfect for designing audio effects.
The SHIRO plugins are an example of audio effects made using this very method.
If you're not familiar with Gen, and this sounds all like gibberish to you, have a look at the links below.
Designing your effect in Gen
- To get your gen~ object working on the MOD Duo, you'll first need to design one using only Gen's internal objects, without referring to objects outside the gen~ object. Only the objects inside will make it to the final LV2-plugin.
- If you want controllable parameters, define the default, minimum and maximum arguments in the "param" object.
- While designing your gen~ object, remember that the MOD Duo's samplerate is running at 48 kHz.
If you download the MOD Duo-package from the Package Manager in Max and click on Launch, you'll find some example-plugins.
Getting your Gen-based plugin to the MOD Duo
At this point you should have met the requirements specified above. If so, follow the steps below to get your plugin on the MOD Duo.
In order to run Gen-based plugins on the MOD Duo they must be converted into LV2 plugins and compiled using a custom MOD cloud build system.
All the heavy work has already been done by the MOD Team and Cycling '74.
- Go to or install the MOD Duo-package in the Package Manager in Max if you haven't, and click on Launch.
- Make sure your MOD Duo is connected, then start the MODwatcher from the popped-up screen.
- If you want your plugin to have a name on the MOD Duo, copy your gen~ objects contents to a gen~ object with a patcher-name argument.
NAMING YOUR ORIGINAL GEN~ OBJECT WILL INITIALIZE IT'S CONTENTS - Finally send a message containing "exportnotifier MODwatcher, exportcode" (without the quotation marks) to the gen~ object.
Your plugin will now be transferred to the MOD Duo, within a few minutes the MODwatcher will tell you if the upload succeeded.
If all goes well, your Gen-based plugin should now be inside the MOD Duo, ready to be played!
Additional features (advanced)
Optionally you can edit your plugin to, for example, add units, knob behavior, a description or even a GUI.
This process is different from the process described above. It doesn't use the MOD Duo-package in Max.
Compiling the plugin
First, download http://download.moddevices.com/releases/max-gen/max-gen-deploy_v4.tar.gz and extract it.
Send an "exportcode" message to the gen~ object in your main Max-patcher to get the gen_exported.cpp and gen_exported.h files.
Copy the gen_exported.cpp and gen_exported.h files into the extracted max-gen-deploy folder, and run:
$ cd /path/to/max-gen-deploy/
$ ./mod-build.shYou'll be asked for a plugin name, and after providing one the cloud should give you back a tar.gz file within a few minutes.
Editing the plugin
To add units, knob behavior or a description, you'll have to edit the .ttl file.
If you do so, make sure everything is correct,
otherwise the plugin won't work and you might have to SSH into the MOD Duo to get the corrupt plugin out.
To prevent this from happening, you can validate the lv2-data.
The other option is to include a GUI, you can make one with the MOD SDK.
Have a look here how a GUI affects the .ttl structure.
OPTIONAL
$ gunzip Plugin.lv2-duo.tar.gz
$ tar -xvf Plugin.lv2-duo.tar
make edits in Plugin.lv2/Plugin_dsp.ttl or include a GUI
$ rm Plugin.lv2-duo.tar.gz
$ tar -cvzf Plugin.lv2-duo.tar.gz Plugin.lv2/Deploying the plugin
Make sure the MOD Duo is connected to your computer via USB before proceeding. Then run:
$ cd /path/to/max-gen-deploy/
$ ./mod-deploy.sh
