A class for controlling the volume of AudioMixer4 objects using a potentiometer. More...

#include <Audio/VolumeControl.hpp>

Inheritance diagram for VolumeControl< N >:

Collaboration diagram for VolumeControl< N >:

Public Types
using	Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

Public Member Functions
	VolumeControl (const Array< AudioMixer4 *, N > &mixers, pin_t analogPin, float maxGain=1.0)
	Create a new VolumeControl object. More...

void	update () override
	Read the potentiometer value, and adjust the gain of the mixers. More...

void	begin () override
	Initialize. More...

void	map (MappingFunction fn)
	Specify a mapping function that is applied to the raw analog value before setting the volume. More...

void	invert ()
	Invert the analog value. More...

Static Public Member Functions
static Mutex &	getMutex ()

Protected Attributes
Updatable< Potentiometer, false > *	next

Updatable< Potentiometer, false > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< Potentiometer, false > >	updatables

static Mutex	mutex

Private Attributes
Array< AudioMixer4 *, N >	mixers

AH::FilteredAnalog	filteredAnalog

const float	maxGain

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

Enabling and disabling updatables
void	enable (const LockGuard &lock)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

bool	isEnabled (const LockGuard &) const
	Check if this updatable is enabled. More...

bool	isEnabled ()
	Check if this updatable is enabled. More...

void	moveDown (const LockGuard &)
	Move down this element in the list. More...

void	moveDown ()
	Move down this element in the list. More...

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class. More...

static void	updateAll ()
	Update all enabled instances of this class. More...

Detailed Description

template<uint8_t N>
class VolumeControl< N >

A class for controlling the volume of AudioMixer4 objects using a potentiometer.

Template Parameters

N	The number of mixers.

Examples: 1.Volume-Controlled-USB-DAC.ino, and 2.VU-Meter-OLED-USB-DAC.ino.

Definition at line 23 of file VolumeControl.hpp.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ VolumeControl()

VolumeControl	(	const Array< AudioMixer4 *, N > &	mixers,
		pin_t	analogPin,
		float	maxGain = `1.0`
	)

inline

Create a new VolumeControl object.

Parameters

mixers	An array of pointers to audio mixers. Only the pointers are saved, so the mixers should outlive this object.
analogPin	The analog pin with the potentiometer connected.
maxGain	The maximum gain for the mixers.

Definition at line 37 of file VolumeControl.hpp.

Member Function Documentation

◆ update()

void update ( )

inlineoverridevirtual

Read the potentiometer value, and adjust the gain of the mixers.

Implements Updatable< Potentiometer >.

Definition at line 44 of file VolumeControl.hpp.

◆ begin()

void begin ( )

inlineoverridevirtual

Initialize.

Implements Updatable< Potentiometer >.

Definition at line 56 of file VolumeControl.hpp.

◆ map()

void map ( MappingFunction fn )

inline

Specify a mapping function that is applied to the raw analog value before setting the volume.

Parameters

fn	A function pointer to the mapping function. This function should take the filtered analog value of \( 16 - \mathrm{ANALOG\_FILTER\_SHIFT\_FACTOR} \) bits as a parameter, and should return a value in the same range.

See also: FilteredAnalog::map

Definition at line 70 of file VolumeControl.hpp.

◆ invert()

void invert ( )

inline

Invert the analog value.

Definition at line 73 of file VolumeControl.hpp.

◆ beginAll()

static void beginAll

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Examples: 2.VU-Meter-OLED-USB-DAC.ino.

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.