Difference between revisions of "How To Build and Deploy LV2 Plugin to MOD Duo"

From MOD Wiki
Jump to navigation Jump to search
Line 6: Line 6:
 
# Create a new LV2 plugin
 
# Create a new LV2 plugin
 
# Get the build tools
 
# Get the build tools
# Bootstrap your project
+
# Create your project make files
 
# Compile it
 
# Compile it
 
# Deploy it
 
# Deploy it
Line 25: Line 25:
 
== Get the build tools ==
 
== Get the build tools ==
  
A LV2 plugin is just a binary. However to run in a MOD Device it must be compiled for that particular hardware and software (libraries).
+
A LV2 plugin is just a binary. However to run in a MOD Device it must be compiled using a cross-compiler targeting that particular hardware and software (libraries).
This mean you'll have to use a custom compiler called [https://github.com/moddevices/mod-plugin-builder MOD Plugin Builder] which takes care of that process for you.
+
Luckily this process has been made easy. All you need is to clone [https://github.com/moddevices/mod-plugin-builder MOD Plugin Builder] and follow the [https://github.com/moddevices/mod-plugin-builder/blob/master/README.md instructions].
  
Just follow the [https://github.com/moddevices/mod-plugin-builder/blob/master/README.md instructions] to get it installed and running.
+
<source lang="console">
 +
$ git clone https://github.com/moddevices/mod-plugin-builder
 +
$ ./bootstrap.sh
 +
</source>
  
A few notable packages that are neede:
+
A few notable packages that you'll need:
 
* gperf
 
* gperf
 
* makeinfo
 
* makeinfo
Line 37: Line 40:
 
* automake
 
* automake
 
* libncurses5-dev
 
* libncurses5-dev
 +
 +
Once finished you should have the cross compiler installed in <code>~/mod-workdir</code>.
 +
 +
<source lang="console">
 +
$ ls ~/mod-workdir
 +
$ build download toolchain
 +
</source>
 +
 +
 +
== Create your project make files ==
 +
 +
mod-plugin-builder is based on [https://buildroot.org/ Buildroot] which requires you to create make files that indicate how you plugin should be built.
 +
You must have a <code>{projectname}.mk</code> file in <code>mod-plugin-builder/plugins/package/{projectname}</code> folder.

Revision as of 05:54, 4 May 2016

Introduction

In order to have a LV2 plugin running in a MOD Device you'll need the following:

  1. Understand the very basics of LV2
  2. Create a new LV2 plugin
  3. Get the build tools
  4. Create your project make files
  5. Compile it
  6. Deploy it
  7. Publish it

Let's dive in.

Basics of LV2

Create a new LV2 plugin

TODO: add samples

Get the build tools

A LV2 plugin is just a binary. However to run in a MOD Device it must be compiled using a cross-compiler targeting that particular hardware and software (libraries). Luckily this process has been made easy. All you need is to clone MOD Plugin Builder and follow the instructions.

$ git clone https://github.com/moddevices/mod-plugin-builder
$ ./bootstrap.sh

A few notable packages that you'll need:

  • gperf
  • makeinfo
  • texinfo
  • libtool
  • automake
  • libncurses5-dev

Once finished you should have the cross compiler installed in ~/mod-workdir.

$ ls ~/mod-workdir
$ build download toolchain


Create your project make files

mod-plugin-builder is based on Buildroot which requires you to create make files that indicate how you plugin should be built. You must have a {projectname}.mk file in mod-plugin-builder/plugins/package/{projectname} folder.