Honey Badger

ImageImage

What is Honey Badger?

The UA Honey Badger platform is a collection of libraries and tools for audio plugin development on Universal Audio's line of embedded Linux audio devices.

Where To Start

Quick Start

Dependencies

  • CMake >= 2.8 (for building)
  • Boost >= 1.64.0 (for unit tests only)

Building

CMake is used to build the SDK and its unit tests.

Here is the procedure to build with command-line make. Type this into a terminal:

# also applies for any of the individual Examples directories
cd plugin-sdk

# "build" dir can be named anything
mkdir build
cd build

# Generate the makefiles (can also generate Xcode projects; see below)
cmake ..

# build the sdk
make

# run unit tests; only works when building the entire SDK
make test

# install all examples to /opt/uad/plugins
sudo make install

Notes:

  • Building from the top level builds all examples and unit tests and requires Boost. Alternatively, you can just run these build steps from within an example directory (such as Examples/UA_Gain) and you will just build/install that one example
  • The command "cmake .." runs the CMakeLists.txt which produces the Makefile.
  • The command "make" builds the plugin
  • You can, alternatively (or in addition), give the command make install which installs the plugin (and builds it if it's not already built).
  • make clean will clean the plugin (but not the cmake output.)
  • To completely clean the cmake output, you just delete the build directory.
  • The install step copies the plugin's dylib (or .so on ARM) to /opt/uad/plugins/<plugin_name>/bin and the manifest.json file to /opt/uad/plugins/<plugin_name>

You can also build with an IDE by specifying a different cmake "generator".
For example, to build on Mac OSX with Xcode:

# using UA_Gain as an example
cd UA_Gain
mkdir build
cd build
cmake -G Xcode ..

Then you open Project.xcode in Xcode. You can select the "install" target to do the installation.

If you use an IDE, you will see the files grouped in 'folders' in the same hierarchy as the file system on disk. That means that you will see:

Examples/<particularExample>
Implementation
Interface

The latter two are the Honey Badger SDK directories.

Contact

For UAD3 SDK support or documentation inquiries:

Legal

Find the posted open source licenses for HB tools and SDK on the Open Source Licenses page.