Aloe Waveshaper

Aloe Waveshaper is a Rust crate designed for signal processing, particularly applying waveshaping techniques to audio signals. Waveshaping is a form of nonlinear distortion used in sound synthesis and audio effects processing, allowing for the transformation of input audio signals into a new form by applying a mathematical function.

Overview

The core functionality of this crate revolves around the WaveShaper struct, which can process individual audio samples or blocks of audio using a customizable shaping function. The crate also provides demonstration components to showcase its applications in digital signal processing (DSP).

Features

• Parametric Waveshaping: Customize the waveshaping function using any function that adheres to the Fn(FloatType) -> FloatType signature.
• DSP Components: Contains demo DSP components for showcasing the use and functionality of the waveshaping algorithms.
• Sample Processing: Enables the application of nonlinear transformations to single samples or blocks of audio data.

Usage

To use the crate, import it in your Cargo.toml:

[dependencies]
aloe-waveshaper = "0.1.0"

In your code, create a WaveShaper instance:

use aloe_waveshaper::create_wave_shaper;

fn custom_shape(x: f32) -> f32 {
    x.tanh()  // Example shaping function
}

let wave_shaper = create_wave_shaper(custom_shape);

You can process single samples or entire audio blocks using process_sample or process, respectively.

License

This project is licensed under the GPL-3.0 License.

Contribution and Support

For contributions or issues, please refer to the GitHub repository.

This README.md file was generated by an AI model and may not be 100% accurate; however, it should be a reliable resource.

This crate is a translation of the JUCE module.

JUCE is a c++ software framework for developing high performance audio applications.

Usage falls under the GPLv3 as well as the JUCE commercial license.

See github.com/juce-framework/JUCE and the JUCE license page for details.

This crate is in the process of being translated from c++ to rust. For progress updates, please see the workspacer rust project. designed specifically for rust projects.