Welcome to the GoatMix repository! Please keep in mind that audio plugins are extremely fickle and complex things when it comes to building, due to the massive number of dependencies, SDKs, and build gymnastics needed to compile them and make them run. That said, this document will attempt to explain as clearly and concisely as possible how to get started.
MobileMix is tested to build using Xcode 9.1 under macOS High Sierra (10.13). Tested plugin hosts/targets are:
- Garageband as an AUv3 plugin (iOS)
- Logic Pro X (10.3.2) as an AUv2 plugin (macOS)
- Ableton Live 9.7.5 as a VST2 plugin (macOS)
If you do a simple git clone, the code will not work! You must clone recursively to also pull in the many dependencies. Note that downloading a .zip of master from the repository will not download any of the submodules. To clone recursively, use git clone --recursive https://github.com/jonathonracz/GoatMix.git
It will take a while to clone everything. Once complete, open GoatMix/Builds/<platform of choice>/<IDE Project>.
This is where things will either go without a hitch or crash and burn, mostly due to paths to SDKs (which are included as submodules) are not referenced correctly for whatever reason. In the case of simply building and side-loading the app onto a device, there shouldn't be any issues so long as you're on one of the supported platforms.
This will build GoatMix in iOS' native plugin format, Audio Unit version 3 (AUv3) for use with any iOS plugin host. To build, pick the "AUv3 AppExtension" build target. Make sure it's the iOS deployment version, as there are two! You can tell by looking at the popup menu to see if the target refers to "My Mac" or an iOS device.
To load the built plugin into Garageband, follow Apple's Instructions under "Add an Audio Units Effect".
Note that depending on the age or style of your device (iPhone vs. iPad, etc.), GUI performance under Garageband may be dismal - which is why most mobile plugins are simply an array of labeled sliders rather than an slew of animation like GoatMix. Audio processing will almost definitely be handled without issue, however.
This will build GoatMix in a standalone "dummy" mode which is mostly useful for smoke testing or checking out GUI behaviors, as no audio can be routed through it since there is no host to provide audio. This target is the "Standalone Plugin" iOS deployment option in the build targets menu.
I've lumped the macOS build instructions into one category because they're almost completely analagous to the iOS instructions - just choose the target which deploys to "My Mac" rather than to an iOS device. Note that no host on macOS currently works with AUv3, so stick to AUv2 (supported by any first party host on macOS, such as Logic or Garageband) or VST (supported by any third party host, such as Ableton Live, Reaper, Cubase, etc.).
The "actual" source code, i.e. all the app's code, can be found in /GoatMix/Source. External meta-project dependencies for the project are in /External. Statically linked dependencies are in /GoatMix/Source/External.
