# cxx-juce 🧃

[![Build Status](https://github.com/JamesHallowell/cxx-juce/actions/workflows/ci.yml/badge.svg)](https://github.com/JamesHallowell/cxx-juce/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/cxx-juce.svg)](https://crates.io/crates/cxx-juce)
[![Docs.rs](https://docs.rs/cxx-juce/badge.svg)](https://docs.rs/cxx-juce)

**Rust bindings for [JUCE](https://juce.com/) using [cxx](https://github.com/dtolnay/cxx).**

## Overview

JUCE is something of an industry standard for audio applications, so it would be nice to be able to make use of it from
Rust.

Providing bindings for the entirety of JUCE would be a huge undertaking, and much of it would be duplicating
functionality already available to Rust in the standard library or via crates.io.

The goal for this crate is to provide bindings for a subset of JUCE, in particular the mature and thoroughly
battle-tested audio modules.

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
cxx-juce = "0.7"
```

## Dependencies

Refer to the [JUCE documentation](https://github.com/juce-framework/JUCE#building-juce-projects) for the dependencies
required to build JUCE on your platform.

## Crate Features

#### `asio`

To build with ASIO support:

1. Agree to Steinberg's licensing terms and download the ASIO SDK.
2. Enable the `asio` feature for this crate.
3. Set the `CXX_JUCE_ASIO_SDK_DIR` environment variable to the path of the extracted ASIO SDK.

## License

Licensed under either of

* Apache License, Version 2.0
  ([LICENSE-APACHE](LICENSE-APACHE))
* MIT license
  ([LICENSE-MIT](LICENSE-MIT))

at your option.

The juce_audio_basics, juce_audio_devices, juce_core and juce_events modules are permissively licensed under the terms
of the [ISC license](https://www.isc.org/licenses/).

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.