brickworks/include/bw_osc_filt.h

117 lines
2.8 KiB
C
Raw Normal View History

2022-11-15 23:49:51 +00:00
/*
* Brickworks
*
* Copyright (C) 2022 Orastron Srl unipersonale
*
* Brickworks is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3 of the License.
*
* Brickworks is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
*
* File author: Stefano D'Angelo
*/
/*!
* module_type {{{ dsp }}}
* version {{{ 0.1.0 }}}
* requires {{{ bw_config bw_common }}}
* description {{{
* Post-filter to decolorate oscillator waveshapers when antialiasing is on.
*
* This filter can be added in series of oscillator waveshapers that use
* PolyBLEP antialiasing (i.e., [bw_osc_saw](bw_osc_saw),
* [bw_osc_pulse](bw_osc_pulse), [bw_osc_tri](bw_osc_tri)) to compensate for
* high-frequency attenuation.
* }}}
* changelog {{{
* <ul>
* <li>Version <strong>0.1.0</strong>:
* <ul>
* <li>First release.</li>
* </ul>
* </li>
* </ul>
* }}}
*/
#ifndef _BW_OSC_FILT_H
#define _BW_OSC_FILT_H
#ifdef __cplusplus
extern "C" {
#endif
/*! api {{{
* #### bw_osc_filt
* ```>>> */
typedef struct _bw_osc_filt *bw_osc_filt;
/*! <<<```
* Instance handle.
* >>> */
/*! ...
* #### bw_osc_filt_new()
* ```>>> */
bw_osc_filt bw_osc_filt_new();
/*! <<<```
* Creates a new instance.
*
* Returns the newly-created instance handle or `NULL` if there was not
* enough memory.
* >>> */
/*! ...
* #### bw_osc_filt_free()
* ```>>> */
void bw_osc_filt_free(bw_osc_filt instance);
/*! <<<```
* Destroys an `instance`.
* >>> */
/*! ...
* #### bw_osc_filt_set_sample_rate()
*
* There is none (not needed).
* >>> */
/*! ...
* #### bw_osc_filt_reset()
* ```>>> */
void bw_osc_filt_reset(bw_osc_filt instance);
/*! <<<```
* Resets the given `instance` to its initial state.
* >>> */
/*! ...
* #### bw_osc_filt_process()
* ```>>> */
void bw_osc_filt_process(bw_osc_filt instance, const float *x, float* y, int n_samples);
/*! <<<```
* Lets the given `instance` process `n_samples` samples from the input
* buffer `x` and fills the corresponding `n_samples` samples in the output
* buffer `y`.
* >>> */
/*! ...
* #### bw_osc_filt_set_enabled()
* ```>>> */
void bw_osc_filt_set_enabled(bw_osc_filt instance, char value);
/*! <<<```
* Sets whether the filter is enabled (`value` non-`0`) or bypassed (`0`)
* for the given `instance`.
*
* Default value: non-`0`.
* }}} */
#ifdef __cplusplus
}
#endif
#endif