WaveShaper.h

/*
 * WaveShaper.h
 *
 * This file is part of Mozzi.
 *
 * Copyright 2012-2024 Tim Barrass and the Mozzi Team
 *
 * Mozzi is licensed under the GNU Lesser General Public Licence (LGPL) Version 2.1 or later.
 *
 */

#ifndef WAVESHAPER_H_
#define WAVESHAPER_H_

#include "Arduino.h"

/** WaveShaper maps values from its input to values in a table, which are returned as output.
@tparam T the type of numbers being input to be shaped, chosen to match the table.
*/

template <class T>
class WaveShaper
	{}
;


/** int8_t specialisation of WaveShaper template*/
template <>
class WaveShaper <char>
{

public:
	/** Constructor. Use the template parameter to set type of numbers being mapped. For
	example, WaveShaper <int> myWaveShaper; makes a WaveShaper which uses ints.
	@tparam T the type of numbers being input to be shaped, chosen to match the table.
	@param TABLE_NAME the name of the table being used, which can be found in the
	".h" file containing the table. */
	WaveShaper(const int8_t  * TABLE_NAME):table(TABLE_NAME)
	{
		;
	}


	/** Maps input to output, transforming it according to the table being used.
	@param in the input signal. For flexibility, it's up to you to give the correct offset
	to your input signal. So if you're mapping a signed 8-bit signal (such as the output of
	an Oscil) into a 256 cell table centred around cell 128, add 128 to offset the
	input value.
	@return the shaped signal.
	 */
	inline
	int8_t next(byte in)
	{
		return FLASH_OR_RAM_READ<const int8_t>(table + in);
	}

private:
	const int8_t  * table;
};



/** int specialisation of WaveShaper template*/
template <>
class WaveShaper <int>
{

public:
	/** Constructor. Use the template parameter to set type of numbers being mapped. For
	example, WaveShaper <int> myWaveShaper; makes a WaveShaper which uses ints.
	@tparam T the type of numbers being input to be shaped, chosen to match the table.
	@param TABLE_NAME the name of the table being used, which can be found in the
	".h" file containing the table. */
	WaveShaper(const int16_t * TABLE_NAME):table(TABLE_NAME)
	{
		;
	}


	/** Maps input to output, transforming it according to the table being used.
	@param in the input signal. For flexibility, it's up to you to give the
	correct offset to your input signal. So if you're mapping a signed 9-bit signal
	(such as the sum of 2 8-bit Oscils) into a 512 cell table centred around
	cell 256, add 256 to offset the input value. With a sigmoid table, this
	may be useful for compressing a bigger signal into the -244 to 243
	output range of Mozzi, rather than dividing the signal and returning a
	int8_t from updateAudio().
	@return the shaped signal.
	 */
	inline
	int next(int in)
	{
		return FLASH_OR_RAM_READ<const int16_t>(table + in);
	}

private:
	const int16_t * table;
};

/** @example 06.Synthesis/WaveShaper/WaveShaper.ino
This is an example of how to use the WaveShaper class.
*/
#endif /* WAVESHAPER_H_ */