A VU meter that reads from an Audio stream using the AudioAnalyzePeak class, and displays it on an LED bar graph. More...

#include <Audio/AudioVULEDs.hpp>

Inheritance diagram for AudioVULEDs< N >:

Collaboration diagram for AudioVULEDs< 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
	AudioVULEDs (const AH::DotBarDisplayLEDs< N > &vuleds, AudioAnalyzePeak &level, float gain=1.0)
	Create a new AudioVULEDs object. More...

void	begin () override
	Initialize. More...

void	update () override
	Update the LEDs with the latest level. More...

void	setMode (AH::DotBarMode mode)
	Set the mode to either dot or bar mode. More...

void	dotMode ()
	Set the mode to dot mode. More...

void	barMode ()
	Set the mode to bar mode. More...

uint8_t	getValue () override
	Get the value of the VU meter. More...

float	getFloatValue () override
	Get the value of the VU meter. More...

bool	getOverload () override

void	setGain (float gain)
	Set the gain for the VU meter. More...

uint8_t	getMax () const
	Get the maximum value that this VU meter can return. More...

Static Public Member Functions
static Mutex &	getMutex ()

Protected Attributes
const uint8_t	max

Updatable< AudioVU, false > *	next

Updatable< AudioVU, false > *	previous

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

static Mutex	mutex

Private Attributes
AH::DotBarDisplayLEDs< N >	vuleds

uint8_t	previousValue = 0

MovingCoilBallistics	ballistics = MovingCoilBallistics::responsiveVU()

class AudioVU::Analyzer	level

float	gain

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 AudioVULEDs< N >

A VU meter that reads from an Audio stream using the AudioAnalyzePeak class, and displays it on an LED bar graph.

Template Parameters

N	The number of LEDs.

Definition at line 21 of file AudioVULEDs.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

◆ AudioVULEDs()

AudioVULEDs	(	const AH::DotBarDisplayLEDs< N > &	vuleds,
		AudioAnalyzePeak &	level,
		float	gain = `1.0`
	)

inline

Create a new AudioVULEDs object.

Parameters

vuleds	The LEDs to display the VU meter to.
level	The Teensy Audio peak analyzer object. Note that it is kept by reference, so it must outlive the AudioVU instance.
gain	A multiplier to calibrate the VU meter.

Definition at line 35 of file AudioVULEDs.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtual

Initialize.

Implements Updatable< AudioVU >.

Definition at line 42 of file AudioVULEDs.hpp.

◆ update()

void update ( )

inlineoverridevirtual

Update the LEDs with the latest level.

Implements Updatable< AudioVU >.

Definition at line 47 of file AudioVULEDs.hpp.

◆ setMode()

void setMode ( AH::DotBarMode mode )

inline

Set the mode to either dot or bar mode.

Parameters

mode The mode.

Definition at line 61 of file AudioVULEDs.hpp.

◆ dotMode()

void dotMode ( )

inline

Set the mode to dot mode.

Definition at line 66 of file AudioVULEDs.hpp.

◆ barMode()

void barMode ( )

inline

Set the mode to bar mode.

Definition at line 71 of file AudioVULEDs.hpp.

◆ getValue()

uint8_t getValue ( )

inlineoverridevirtualinherited

Get the value of the VU meter.

Returns: A value in [0, max]

Implements IVU.

Definition at line 60 of file AudioVU.hpp.

◆ getFloatValue()

float getFloatValue ( )

inlineoverridevirtualinherited

Get the value of the VU meter.

Returns: A value in [0.0, 1.0]

Reimplemented from IVU.

Definition at line 70 of file AudioVU.hpp.

◆ getOverload()

bool getOverload ( )

inlineoverridevirtualinherited

Note: This function will always return false for an AudioVU.

Implements IVU.

Definition at line 83 of file AudioVU.hpp.

◆ setGain()

void setGain ( float gain )

inlineinherited

Set the gain for the VU meter.

Parameters

gain	The new gain.

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

Definition at line 90 of file AudioVU.hpp.

◆ getMax()

uint8_t getMax ( ) const

inlineinherited

Get the maximum value that this VU meter can return.

Definition at line 30 of file VU.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.