brickworks/include/bw_bd_reduce.h

/*
 * Brickworks
 *
 * Copyright (C) 2022, 2023 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.0.0 }}}
 *  requires {{{ bw_common bw_math }}}
 *  description {{{
 *    Bit depth reducer.
 *
 *    This is purely an audio effect, it doesn't actually produce an output
 *    signal with a different encoding. The algorithm is deliberately crude to
 *    obtain the characteristic noise due to lo-fi A/D quantization.
 *  }}}
 *  changelog {{{
 *    <ul>
 *      <li>Version <strong>1.0.0</strong>:
 *        <ul>
 *          <li><code>bw_bd_reduce_process()</code> and
 *              <code>bw_bd_reduce_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>
 *        </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_bd_reduce_process_multi()</code>.</li>
 *          <li>Added C++ wrapper.</li>
 *        </ul>
 *      </li>
 *      <li>Version <strong>0.4.0</strong>:
 *        <ul>
 *          <li>Fixed unused parameter warnings.</li>
 *        </ul>
 *      </li>
 *      <li>Version <strong>0.3.0</strong>:
 *        <ul>
 *          <li>First release.</li>
 *        </ul>
 *      </li>
 *    </ul>
 *  }}}
 */

#ifndef BW_BD_REDUCE_H
#define BW_BD_REDUCE_H

#include <bw_common.h>

#ifdef __cplusplus
extern "C" {
#endif

/*! api {{{
 *    #### bw_bd_reduce_coeffs
 *  ```>>> */
typedef struct bw_bd_reduce_coeffs bw_bd_reduce_coeffs;
/*! <<<```
 *    Coefficients and related.
 *
 *    #### bw_bd_reduce_init()
 *  ```>>> */
static inline void bw_bd_reduce_init(bw_bd_reduce_coeffs *BW_RESTRICT coeffs);
/*! <<<```
 *    Initializes input parameter values in `coeffs`.
 *
 *    #### bw_bd_reduce_reset_coeffs()
 *  ```>>> */
static inline void bw_bd_reduce_reset_coeffs(bw_bd_reduce_coeffs *BW_RESTRICT coeffs);
/*! <<<```
 *    Resets coefficients in `coeffs` to assume their target values.
 *
 *    #### bw_bd_reduce_update_coeffs_ctrl()
 *  ```>>> */
static inline void bw_bd_reduce_update_coeffs_ctrl(bw_bd_reduce_coeffs *BW_RESTRICT coeffs);
/*! <<<```
 *    Triggers control-rate update of coefficients in `coeffs`.
 *
 *    #### bw_bd_reduce_update_coeffs_audio()
 *  ```>>> */
static inline void bw_bd_reduce_update_coeffs_audio(bw_bd_reduce_coeffs *BW_RESTRICT coeffs);
/*! <<<```
 *    Triggers audio-rate update of coefficients in `coeffs`.
 *
 *    #### bw_bd_reduce_process1()
 *  ```>>> */
static inline float bw_bd_reduce_process1(const bw_bd_reduce_coeffs *BW_RESTRICT coeffs, float x);
/*! <<<```
 *    Processes one input sample `x` using `coeffs`. Returns the corresponding
 *    output sample.
 *
 *    #### bw_bd_reduce_process()
 *  ```>>> */
static inline void bw_bd_reduce_process(bw_bd_reduce_coeffs *BW_RESTRICT coeffs, const float *x, float *y, size_t n_samples);
/*! <<<```
 *    Processes the first `n_samples` of the input buffer `x` and fills the
 *    first `n_samples` of the output buffer `y`, while using and updating
 *    `coeffs` (control and audio rate).
 *
 *    #### bw_bd_reduce_process_multi()
 *  ```>>> */
static inline void bw_bd_reduce_process_multi(bw_bd_reduce_coeffs *BW_RESTRICT coeffs, const float * const *x, float * const *y, 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`, while
 *    using and updating the common `coeffs` (control and audio rate).
 *
 *    #### bw_bd_reduce_set_bit_depth()
 *  ```>>> */
static inline void bw_bd_reduce_set_bit_depth(bw_bd_reduce_coeffs *BW_RESTRICT coeffs, char value);
/*! <<<```
 *    Sets the output bit depth `value` in `coeffs`. `value` must be strictly positive.
 *
 *    Default value: `16`.
 *  }}} */

#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>

#ifdef __cplusplus
extern "C" {
#endif

struct bw_bd_reduce_coeffs {
	// Coefficients
	float	ki;
	float	k;
	float	max;
	
	// Parameters
	char	bit_depth;
	char	bit_depth_prev;
};

static inline void bw_bd_reduce_init(bw_bd_reduce_coeffs *BW_RESTRICT coeffs) {
	coeffs->bit_depth = 16;
}

static inline void bw_bd_reduce_reset_coeffs(bw_bd_reduce_coeffs *BW_RESTRICT coeffs) {
	coeffs->bit_depth_prev = 0;
	bw_bd_reduce_update_coeffs_ctrl(coeffs);
}

static inline void bw_bd_reduce_update_coeffs_ctrl(bw_bd_reduce_coeffs *BW_RESTRICT coeffs) {
	if (coeffs->bit_depth_prev != coeffs->bit_depth) {
		coeffs->k = bw_pow2f(coeffs->bit_depth - 1);
		coeffs->ki = bw_rcpf(coeffs->k);
		coeffs->max = 1.f - 0.5f * coeffs->ki;
		coeffs->bit_depth_prev = coeffs->bit_depth;
	}
}

static inline void bw_bd_reduce_update_coeffs_audio(bw_bd_reduce_coeffs *BW_RESTRICT coeffs) {
	(void)coeffs;
}

static inline float bw_bd_reduce_process1(const bw_bd_reduce_coeffs *BW_RESTRICT coeffs, float x) {
	return coeffs->ki * (bw_floorf(coeffs->k * bw_clipf(x, -coeffs->max, coeffs->max)) + 0.5f);
}

static inline void bw_bd_reduce_process(bw_bd_reduce_coeffs *BW_RESTRICT coeffs, const float *x, float *y, size_t n_samples) {
	bw_bd_reduce_update_coeffs_ctrl(coeffs);
	for (size_t i = 0; i < n_samples; i++)
		y[i] = bw_bd_reduce_process1(coeffs, x[i]);
}

static inline void bw_bd_reduce_process_multi(bw_bd_reduce_coeffs *BW_RESTRICT coeffs, const float * const *x, float * const *y, size_t n_channels, size_t n_samples) {
	bw_bd_reduce_update_coeffs_ctrl(coeffs);
	for (size_t i = 0; i < n_samples; i++)
		for (size_t j = 0; j < n_channels; j++)
			y[j][i] = bw_bd_reduce_process1(coeffs, x[j][i]);
}

static inline void bw_bd_reduce_set_bit_depth(bw_bd_reduce_coeffs *BW_RESTRICT coeffs, char value) {
	coeffs->bit_depth = value;
}

#ifdef __cplusplus
}

#include <array>

namespace Brickworks {

/*** Public C++ API ***/

/*! api_cpp {{{
 *    ##### Brickworks::BDReduce
 *  ```>>> */
template<size_t N_CHANNELS>
class BDReduce {
public:
	BDReduce();
	
	void reset();
	void process(
		const float * const *x,
		float * const *y,
		size_t nSamples);
	void process(
		const std::array<const float *, N_CHANNELS> x,
		const std::array<float *, N_CHANNELS> y,
		size_t nSamples);

	void setBitDepth(char 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_bd_reduce_coeffs	 coeffs;
};

template<size_t N_CHANNELS>
inline BDReduce<N_CHANNELS>::BDReduce() {
	bw_bd_reduce_init(&coeffs);
}

template<size_t N_CHANNELS>
inline void BDReduce<N_CHANNELS>::reset() {
	bw_bd_reduce_reset_coeffs(&coeffs);
}

template<size_t N_CHANNELS>
inline void BDReduce<N_CHANNELS>::process(
		const float * const *x,
		float * const *y,
		size_t nSamples) {
	bw_bd_reduce_process_multi(&coeffs, x, y, N_CHANNELS, nSamples);
}

template<size_t N_CHANNELS>
inline void BDReduce<N_CHANNELS>::process(
		const std::array<const float *, N_CHANNELS> x,
		const std::array<float *, N_CHANNELS> y,
		size_t nSamples) {
	process(x.data(), y.data(), nSamples);
}

template<size_t N_CHANNELS>
inline void BDReduce<N_CHANNELS>::setBitDepth(char value) {
	bw_bd_reduce_set_bit_depth(&coeffs, value);
}

}
#endif

#endif