augmented_dsp_filters/lib.rs
1// Augmented Audio: Audio libraries and applications
2// Copyright (c) 2022 Pedro Tacla Yamada
3//
4// The MIT License (MIT)
5//
6// Permission is hereby granted, free of charge, to any person obtaining a copy
7// of this software and associated documentation files (the "Software"), to deal
8// in the Software without restriction, including without limitation the rights
9// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10// copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22// THE SOFTWARE.
23//! A partial port of [`vinniefalco/DSPFilters`](https://github.com/vinniefalco/DSPFilters/) to Rust.
24//!
25//! See [`rbj::FilterProcessor`] for a starting-point.
26//!
27//! Provides RBJ filters:
28//!
29//! * [`rbj::FilterType::LowPass`]
30//! * [`rbj::FilterType::HighPass`]
31//! * [`rbj::FilterType::BandPass1`]
32//! * [`rbj::FilterType::BandPass2`]
33//! * [`rbj::FilterType::BandStop`]
34//! * [`rbj::FilterType::LowShelf`]
35//! * [`rbj::FilterType::HighShelf`]
36
37/// RBJ filters
38pub mod rbj;
39
40/// Filter coefficient structs for internal or low-level use
41pub mod coefficients;
42/// Denormal prevention struct
43pub mod denormal_prevention;
44/// State struct
45pub mod state;