About JUCE_ARA

This repository is an experimental fork of the JUCE develop branch with additions that enable it to generate ARA plug-ins in the VST3 or AudioUnit format. It is currently being maintained by Celemony and SoundRadix, with the goal of being picked up eventually for main line JUCE once the code is stable.

There are two active branches: develop and condensed. They are intended to be sync code-wise (develop might be slightly ahead at times), but have a different history and a different use case: while develop is constantly progressing and JUCE changes are merged in, condensed is rebased regularly to always show the shortest path from the original JUCE release to the current state of JUCE_ARA. If you are using a custom fork of JUCE already, then you should be able to rebase the condensed branch on top of your custom branch with little to no conflicts. This rebase can be repeated as needed if your custom branch or condensed are updated.

Note that Celemony is not endorsing the use of JUCE by providing this fork. JUCE_ARA is a fairly thin adapter to integrate ARA into JUCE, it does not provide any features that would be relevant when using ARA with a different framework. Consequently, the decision whether or not to use JUCE for any given project should be made independently of JUCE_ARA.

The ARA related changes are described in detail in JUCE_ARA.md. For feedback and questions, please contact Celemony via [email protected].

Original JUCE documentation

JUCE is an open-source cross-platform C++ application framework for creating high quality desktop and mobile applications, including VST, VST3, AU, AUv3, RTAS and AAX audio plug-ins. JUCE can be easily integrated with existing projects via CMake, or can be used as a project generation tool via the Projucer, which supports exporting projects for Xcode (macOS and iOS), Visual Studio, Android Studio, Code::Blocks and Linux Makefiles as well as containing a source code editor.

Getting Started

The JUCE repository contains a master and develop branch. The develop branch contains the latest bugfixes and features and is periodically merged into the master branch in stable tagged releases (the latest release containing pre-built binaries can be also downloaded from the JUCE website).

JUCE projects can be managed with either the Projucer (JUCE's own project-configuration tool) or with CMake.

The Projucer

The repository doesn't contain a pre-built Projucer so you will need to build it for your platform - Xcode, Visual Studio and Linux Makefile projects are located in extras/Projucer/Builds (the minumum system requirements are listed in the System Requirements section below). The Projucer can then be used to create new JUCE projects, view tutorials and run examples. It is also possible to include the JUCE modules source code in an existing project directly, or build them into a static or dynamic library which can be linked into a project.

For further help getting started, please refer to the JUCE documentation and tutorials.

CMake

Version 3.15 or higher is required. To use CMake, you will need to install it, either from your system package manager or from the official download page. For comprehensive documentation on JUCE's CMake API, see the JUCE CMake documentation. For examples which may be useful as starting points for new CMake projects, see the CMake examples directory.

Building Examples

To use CMake to build the examples and extras bundled with JUCE, simply clone JUCE and then run the following commands, replacing "DemoRunner" with the name of the target you wish to build.

cd /path/to/JUCE
cmake . -B cmake-build -DJUCE_BUILD_EXAMPLES=ON -DJUCE_BUILD_EXTRAS=ON
cmake --build cmake-build --target DemoRunner

Minimum System Requirements

Building JUCE Projects

• macOS/iOS: Xcode 9.2 (macOS 10.12.6)
• Windows: Windows 8.1 and Visual Studio 2015 Update 3 64-bit
• Linux: g++ 5.0 or Clang 3.4 (for a full list of dependencies, see here).
• Android: Android Studio on Windows, macOS or Linux

Deployment Targets

• macOS: macOS 10.7
• Windows: Windows Vista
• Linux: Mainstream Linux distributions
• iOS: iOS 9.0
• Android: Jelly Bean (API 16)

Contributing

For bug reports and features requests, please visit the JUCE Forum - the JUCE developers are active there and will read every post and respond accordingly. When submitting a bug report, please ensure that it follows the issue template. We don't accept third party GitHub pull requests directly due to copyright restrictions but if you would like to contribute any changes please contact us.

License

The core JUCE modules (juce_audio_basics, juce_audio_devices, juce_core and juce_events) are permissively licensed under the terms of the ISC license. Other modules are covered by a GPL/Commercial license.

There are multiple commercial licensing tiers for JUCE, with different terms for each:

• JUCE Personal (developers or startup businesses with revenue under 50K USD) - free
• JUCE Indie (small businesses with revenue under 500K USD) - $40/month
• JUCE Pro (no revenue limit) - $130/month
• JUCE Educational (no revenue limit) - free for bona fide educational institutes

For full terms see LICENSE.md.