brickworks/include/bw_pan.h

557 lines
16 KiB
C++

/*
* Brickworks
*
* Copyright (C) 2023, 2024 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
* along with Brickworks. If not, see <http://www.gnu.org/licenses/>.
*
* File author: Stefano D'Angelo
*/
/*!
* module_type {{{ dsp }}}
* version {{{ 1.1.1 }}}
* requires {{{ bw_common bw_gain bw_math bw_one_pole }}}
* description {{{
* Stereo panner with -3 dB center pan law.
* }}}
* changelog {{{
* <ul>
* <li>Version <strong>1.1.1</strong>:
* <ul>
* <li>Added debugging check in <code>bw_pan_process_multi()</code> to
* ensure that buffers used for both input and output appear at the
* same channel indices.</li>
* </ul>
* </li>
* <li>Version <strong>1.1.0</strong>:
* <ul>
* <li>Now using <code>BW_NULL</code> and
* <code>BW_CXX_NO_ARRAY</code>.</li>
* </ul>
* </li>
* <li>Version <strong>1.0.0</strong>:
* <ul>
* <li>Now using parabolic curves instead of trigonometric ones.</li>
* <li><code>bw_pan_process()</code> and
* <code>bw_pan_process_multi()</code> now use <code>size_t</code>
* to count samples and channels.</li>
* <li>Added more <code>const</code> specifiers to input
* arguments.</li>
* <li>Moved C++ code to C header.</li>
* <li>Added overloaded C++ <code>process()</code> function taking
* C-style arrays as arguments.</li>
* <li>Removed usage of reserved identifiers.</li>
* <li>Clearly specified parameter validity ranges.</li>
* <li>Added debugging code.</li>
* </ul>
* </li>
* <li>Version <strong>0.6.0</strong>:
* <ul>
* <li>Removed dependency on bw_config.</li>
* </ul>
* </li>
* <li>Version <strong>0.5.0</strong>:
* <ul>
* <li>Added <code>bw_pan_process_multi()</code>.</li>
* <li><code>bw_pan_process()</code> does not accept <code>NULL</code>
* buffers anymore.</li>
* <li>Added C++ wrapper.</li>
* </ul>
* </li>
* <li>Version <strong>0.3.0</strong>:
* <ul>
* <li>First release.</li>
* </ul>
* </li>
* </ul>
* }}}
*/
#ifndef BW_PAN_H
#define BW_PAN_H
#include <bw_common.h>
#ifdef __cplusplus
extern "C" {
#endif
/*! api {{{
* #### bw_pan_coeffs
* ```>>> */
typedef struct bw_pan_coeffs bw_pan_coeffs;
/*! <<<```
* Coefficients and related.
*
* #### bw_pan_init()
* ```>>> */
static inline void bw_pan_init(
bw_pan_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Initializes input parameter values in `coeffs`.
*
* #### bw_pan_set_sample_rate()
* ```>>> */
static inline void bw_pan_set_sample_rate(
bw_pan_coeffs * BW_RESTRICT coeffs,
float sample_rate);
/*! <<<```
* Sets the `sample_rate` (Hz) value in `coeffs`.
*
* #### bw_pan_reset_coeffs()
* ```>>> */
static inline void bw_pan_reset_coeffs(
bw_pan_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Resets coefficients in `coeffs` to assume their target values.
*
* #### bw_pan_update_coeffs_ctrl()
* ```>>> */
static inline void bw_pan_update_coeffs_ctrl(
bw_pan_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Triggers control-rate update of coefficients in `coeffs`.
*
* #### bw_pan_update_coeffs_audio()
* ```>>> */
static inline void bw_pan_update_coeffs_audio(
bw_pan_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Triggers audio-rate update of coefficients in `coeffs`.
*
* #### bw_pan_process1()
* ```>>> */
static inline void bw_pan_process1(
const bw_pan_coeffs * BW_RESTRICT coeffs,
float x,
float * BW_RESTRICT y_l,
float * BW_RESTRICT y_r);
/*! <<<```
* Processes one input sample `x` using `coeffs`, while using and updating
* `state`. The left and right output samples are put into `y_l` (left) and
* `y_r` (right) respectively.
*
* #### bw_pan_process()
* ```>>> */
static inline void bw_pan_process(
bw_pan_coeffs * BW_RESTRICT coeffs,
const float * x,
float * y_l,
float * y_r,
size_t n_samples);
/*! <<<```
* Processes the first `n_samples` of the input buffer `x` and fills the
* first `n_samples` of the output buffers `y_l` (left) and `y_r` (right),
* while using and updating `coeffs` (control and audio rate).
*
* #### bw_pan_process_multi()
* ```>>> */
static inline void bw_pan_process_multi(
bw_pan_coeffs * BW_RESTRICT coeffs,
const float * const * x,
float * const * y_l,
float * const * y_r,
size_t n_channels,
size_t n_samples);
/*! <<<```
* Processes the first `n_samples` of the `n_channels` input buffers `x` and
* fills the first `n_samples` of the `n_channels` output buffers `y_l`
* (left) and `y_r` (right), while using and updating the common `coeffs`
* (control and audio rate).
*
* #### bw_pan_set_pan()
* ```>>> */
static inline void bw_pan_set_pan(
bw_pan_coeffs * BW_RESTRICT coeffs,
float value);
/*! <<<```
* Sets the panning `value`, where `-1.f` corresponds to hard left pan, `0.f`
* to center pan, and `1.f` to hard right pan.
*
* Valid range: [`-1.f` (hard left pan), `1.f` (hard right pan)].
*
* Default value: `0.f`.
*
* #### bw_pan_coeffs_is_valid()
* ```>>> */
static inline char bw_pan_coeffs_is_valid(
const bw_pan_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Tries to determine whether `coeffs` is valid and returns non-`0` if it
* seems to be the case and `0` if it is certainly not. False positives are
* possible, false negatives are not.
*
* `coeffs` must at least point to a readable memory block of size greater
* than or equal to that of `bw_pan_coeffs`.
* }}} */
#ifdef __cplusplus
}
#endif
/*** Implementation ***/
/* WARNING: This part of the file is not part of the public API. Its content may
* change at any time in future versions. Please, do not use it directly. */
#include <bw_math.h>
#include <bw_gain.h>
#ifdef __cplusplus
extern "C" {
#endif
#ifdef BW_DEBUG_DEEP
enum bw_pan_coeffs_state {
bw_pan_coeffs_state_invalid,
bw_pan_coeffs_state_init,
bw_pan_coeffs_state_set_sample_rate,
bw_pan_coeffs_state_reset_coeffs
};
#endif
struct bw_pan_coeffs {
#ifdef BW_DEBUG_DEEP
uint32_t hash;
enum bw_pan_coeffs_state state;
#endif
// Sub-components
bw_gain_coeffs l_coeffs;
bw_gain_coeffs r_coeffs;
// Parameters
float pan;
float pan_prev;
};
static inline void bw_pan_init(
bw_pan_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != BW_NULL);
bw_gain_init(&coeffs->l_coeffs);
bw_gain_init(&coeffs->r_coeffs);
coeffs->pan = 0.f;
#ifdef BW_DEBUG_DEEP
coeffs->hash = bw_hash_sdbm("bw_pan_coeffs");
coeffs->state = bw_pan_coeffs_state_init;
#endif
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state == bw_pan_coeffs_state_init);
}
static inline void bw_pan_set_sample_rate(
bw_pan_coeffs * BW_RESTRICT coeffs,
float sample_rate) {
BW_ASSERT(coeffs != BW_NULL);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_init);
BW_ASSERT(bw_is_finite(sample_rate) && sample_rate > 0.f);
bw_gain_set_sample_rate(&coeffs->l_coeffs, sample_rate);
bw_gain_set_sample_rate(&coeffs->r_coeffs, sample_rate);
#ifdef BW_DEBUG_DEEP
coeffs->state = bw_pan_coeffs_state_set_sample_rate;
#endif
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state == bw_pan_coeffs_state_set_sample_rate);
}
static inline void bw_pan_do_update_coeffs(
bw_pan_coeffs * BW_RESTRICT coeffs,
char force) {
if (force || coeffs->pan != coeffs->pan_prev) {
const float l = 0.7071067811865477f + coeffs->pan * (-0.5f + coeffs->pan * -0.20710678118654768f);
bw_gain_set_gain_lin(&coeffs->l_coeffs, l);
bw_gain_set_gain_lin(&coeffs->r_coeffs, l + coeffs->pan);
coeffs->pan_prev = coeffs->pan;
}
}
static inline void bw_pan_reset_coeffs(
bw_pan_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != BW_NULL);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_set_sample_rate);
bw_pan_do_update_coeffs(coeffs, 1);
bw_gain_reset_coeffs(&coeffs->l_coeffs);
bw_gain_reset_coeffs(&coeffs->r_coeffs);
#ifdef BW_DEBUG_DEEP
coeffs->state = bw_pan_coeffs_state_reset_coeffs;
#endif
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state == bw_pan_coeffs_state_reset_coeffs);
}
static inline void bw_pan_update_coeffs_ctrl(
bw_pan_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != BW_NULL);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
bw_pan_do_update_coeffs(coeffs, 0);
bw_gain_update_coeffs_ctrl(&coeffs->l_coeffs);
bw_gain_update_coeffs_ctrl(&coeffs->r_coeffs);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
}
static inline void bw_pan_update_coeffs_audio(
bw_pan_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != BW_NULL);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
bw_gain_update_coeffs_audio(&coeffs->l_coeffs);
bw_gain_update_coeffs_audio(&coeffs->r_coeffs);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
}
static inline void bw_pan_process1(
const bw_pan_coeffs * BW_RESTRICT coeffs,
float x,
float * BW_RESTRICT y_l,
float * BW_RESTRICT y_r) {
BW_ASSERT(coeffs != BW_NULL);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
BW_ASSERT(bw_is_finite(x));
BW_ASSERT(y_l != BW_NULL);
BW_ASSERT(y_r != BW_NULL);
BW_ASSERT(y_l != y_r);
*y_l = bw_gain_process1(&coeffs->l_coeffs, x);
*y_r = bw_gain_process1(&coeffs->r_coeffs, x);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
BW_ASSERT(bw_is_finite(*y_l));
BW_ASSERT(bw_is_finite(*y_r));
}
static inline void bw_pan_process(
bw_pan_coeffs * BW_RESTRICT coeffs,
const float * x,
float * y_l,
float * y_r,
size_t n_samples) {
BW_ASSERT(coeffs != BW_NULL);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
BW_ASSERT(x != BW_NULL);
BW_ASSERT_DEEP(bw_has_only_finite(x, n_samples));
BW_ASSERT(y_l != BW_NULL);
BW_ASSERT(y_r != BW_NULL);
BW_ASSERT(y_l != y_r);
bw_pan_update_coeffs_ctrl(coeffs);
for (size_t i = 0; i < n_samples; i++) {
bw_pan_update_coeffs_audio(coeffs);
bw_pan_process1(coeffs, x[i], y_l + i, y_r + i);
}
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(bw_has_only_finite(y_l, n_samples));
BW_ASSERT_DEEP(bw_has_only_finite(y_r, n_samples));
}
static inline void bw_pan_process_multi(
bw_pan_coeffs * BW_RESTRICT coeffs,
const float * const * x,
float * const * y_l,
float * const * y_r,
size_t n_channels,
size_t n_samples) {
BW_ASSERT(coeffs != BW_NULL);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
BW_ASSERT(x != BW_NULL);
BW_ASSERT(y_l != BW_NULL);
BW_ASSERT(y_r != BW_NULL);
BW_ASSERT(y_l != y_r);
#ifndef BW_NO_DEBUG
for (size_t i = 0; i < n_channels; i++)
for (size_t j = i + 1; j < n_channels; j++) {
BW_ASSERT(y_l[i] != y_l[j]);
BW_ASSERT(y_r[i] != y_r[j]);
}
for (size_t i = 0; i < n_channels; i++)
for (size_t j = 0; j < n_channels; j++)
BW_ASSERT(y_l[i] != y_r[j]);
for (size_t i = 0; i < n_channels; i++)
for (size_t j = 0; j < n_channels; j++) {
BW_ASSERT(i == j || x[i] != y_l[j]);
BW_ASSERT(i == j || x[i] != y_r[j]);
}
#endif
bw_pan_update_coeffs_ctrl(coeffs);
for (size_t i = 0; i < n_samples; i++) {
bw_pan_update_coeffs_audio(coeffs);
for (size_t j = 0; j < n_channels; j++)
bw_pan_process1(coeffs, x[j][i], y_l[j] + i, y_r[j] + i);
}
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_reset_coeffs);
}
static inline void bw_pan_set_pan(
bw_pan_coeffs * BW_RESTRICT coeffs,
float value) {
BW_ASSERT(coeffs != BW_NULL);
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_init);
BW_ASSERT(bw_is_finite(value));
BW_ASSERT(value >= -1.f && value <= 1.f);
coeffs->pan = value;
BW_ASSERT_DEEP(bw_pan_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_pan_coeffs_state_init);
}
static inline char bw_pan_coeffs_is_valid(
const bw_pan_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != BW_NULL);
#ifdef BW_DEBUG_DEEP
if (coeffs->hash != bw_hash_sdbm("bw_pan_coeffs"))
return 0;
if (coeffs->state < bw_pan_coeffs_state_init || coeffs->state > bw_pan_coeffs_state_reset_coeffs)
return 0;
#endif
if (!bw_is_finite(coeffs->pan) || coeffs->pan < -1.f || coeffs->pan > 1.f)
return 0;
#ifdef BW_DEBUG_DEEP
if (coeffs->state >= bw_pan_coeffs_state_reset_coeffs) {
if (!bw_is_finite(coeffs->pan_prev) || coeffs->pan_prev < -1.f || coeffs->pan_prev > 1.f)
return 0;
}
#endif
return bw_gain_coeffs_is_valid(&coeffs->l_coeffs) && bw_gain_coeffs_is_valid(&coeffs->r_coeffs);
}
#ifdef __cplusplus
}
#ifndef BW_CXX_NO_ARRAY
# include <array>
#endif
namespace Brickworks {
/*** Public C++ API ***/
/*! api_cpp {{{
* ##### Brickworks::Pan
* ```>>> */
template<size_t N_CHANNELS>
class Pan {
public:
Pan();
void setSampleRate(
float sampleRate);
void reset();
void process(
const float * const * x,
float * const * yL,
float * const * yR,
size_t nSamples);
#ifndef BW_CXX_NO_ARRAY
void process(
std::array<const float *, N_CHANNELS> x,
std::array<float *, N_CHANNELS> yL,
std::array<float *, N_CHANNELS> yR,
size_t nSamples);
#endif
void setPan(
float value);
/*! <<<...
* }
* ```
* }}} */
/*** Implementation ***/
/* WARNING: This part of the file is not part of the public API. Its content may
* change at any time in future versions. Please, do not use it directly. */
private:
bw_pan_coeffs coeffs;
};
template<size_t N_CHANNELS>
inline Pan<N_CHANNELS>::Pan() {
bw_pan_init(&coeffs);
}
template<size_t N_CHANNELS>
inline void Pan<N_CHANNELS>::setSampleRate(
float sampleRate) {
bw_pan_set_sample_rate(&coeffs, sampleRate);
}
template<size_t N_CHANNELS>
inline void Pan<N_CHANNELS>::reset() {
bw_pan_reset_coeffs(&coeffs);
}
template<size_t N_CHANNELS>
inline void Pan<N_CHANNELS>::process(
const float * const * x,
float * const * yL,
float * const * yR,
size_t nSamples) {
bw_pan_process_multi(&coeffs, x, yL, yR, N_CHANNELS, nSamples);
}
#ifndef BW_CXX_NO_ARRAY
template<size_t N_CHANNELS>
inline void Pan<N_CHANNELS>::process(
std::array<const float *, N_CHANNELS> x,
std::array<float *, N_CHANNELS> yL,
std::array<float *, N_CHANNELS> yR,
size_t nSamples) {
process(x.data(), yL.data(), yR.data(), nSamples);
}
#endif
template<size_t N_CHANNELS>
inline void Pan<N_CHANNELS>::setPan(
float value) {
bw_pan_set_pan(&coeffs, value);
}
}
#endif
#endif