Build audio applications and plugins with gen~
C++ C Objective-C++ Objective-C Max Java Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

BUILDING PLUGINS AND APPLICATIONS WITH GEN AND JUCE

This is an example project that should help you get started with building your own plugins and iOS apps with the help of the code-export feature of gen~, part of Max 7 made by Cycling '74.

It is based on the JUCE Framework. Please be aware that the Juce library has its own license terms (mostly GPL with the availability of commercial licenses). See their website for further details:

http://www.juce.com/

Some information about the structure of this example:

file/dir explanation
build-result/ this is where the result of the builds (the VST or AU plugins) are stored
exported-code the folder where gen~ will export the code to
CoreAudioUtilityClasses needed for building Audio Units - see below for more info
gen-example.maxpat a Max patcher outlining the process to build a plugin
Introjucer Introjucer files - define the plugin behavior
JUCE the Juce framework - do not touch
post-export.py post export script - triggered by code export, will build your plugin
README.md this file
Source-App/ the source for your iOS Application, feel free to edit those (includes sample UI)
Source-Plugin/ the source for your Audio Plugins, feel free to edit those

auto generated folders and files

file/dir explanation
App-Builds/ generated by Introjucer, will hold all iOS projects
AU-Builds/ generated by Introjucer, will hold all AudioIUnit projects
VST-Builds/ generated by Introjucer, will hold all VST projects
VST3-Builds/ generated by Introjucer, will hold all VST3 projects

Prerequisites

Mac OS X

  • download and install Xcode from the AppStore (this Readme has been made with Xcode 6.3)

  • to build AudioUnits you need to copy the folder CoreAudio (you find it inside of the folder CoreAudioUtilityClasses) into the directory /Applications/Xcode.app/Contents/Developer/Extras/ (create it if needed)

    it should look like:

    /Applications/Xcode.app/Contents/Developer/Extras/CoreAudio

  • building VSTs requires the VST SDK from http://www.steinberg.net/en/company/developers.html at the time of writing this is VST 3.6.5 which is capable of building VST2 and VST 3

    install it into ~/SDKs/VST3 SDK

Windows

Build

open the example patcher gen-example.maxpat included in this repository and follow the instructions in the patcher.

for more instructions on how to customize your plugin please visit: http://www.juce.com/

note: all provided projects have been created via the Introjucer, so it should be safe to use the Introjucer to edit them (for example, to add or change a UI).

Adding a GUI, changing settings etc.

plugin building is based on the JUCE Framework:

http://www.juce.com/

  • if you want to add or remove files from your Xcode or Visual Studio project, do not edit the projects directly (they will be rebuilt on each export), but use the Introjucer files in the root folder
  • in the folder Introjucer/ you will find a program called "Introjucer", this program is used to edit those ".jucer" files, for example "C74-Gen-VSTPlugin.jucer", which also offer more advanced ways of plugin configuration
  • you can also use the introjucer to add a UI, an example of this can be found in the Introjucer file "C74-Gen-Application.jucer" (the iOS Project). Find a quick introduction to the tool here: http://www.juce.com/learn/introjucer

Enjoy!

License

NOTE: This license does only cover the Cycling '74 provided part of this package, not the Juce library and not the Core Audio utility classes - please refer to the according webpages for further licensing details.

Copyright (c) 2015 Cycling '74

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.