#include <MIDI_Inputs/MCU/VU.hpp>

Detailed Description

template<uint8_t BankSize>
class MCU::Bankable::VU< BankSize >

A MIDI input element that represents a Mackie Control Universal VU meter.

This version can be banked.

Template Parameters

BankSize The number of banks.

Examples: MCU-OLED-SSD1306-x2.ino, and MCU-OLED-SSD1306.ino.

Definition at line 290 of file VU.hpp.

Inheritance diagram for VU< BankSize >:

Collaboration diagram for VU< BankSize >:

Data access
uint8_t	getValue (uint8_t bank) const
	Get the most recent VU position that was received for the given bank.

bool	getOverload (uint8_t bank) const
	Get the status of the overload indicator for the given bank.

float	getFloatValue (uint8_t bank) const
	Get the most recent VU position for the given bank as a value between 0 and 1.

uint8_t	getValue () override
	Get the most recent VU position that was received for the active bank.

bool	getOverload () override
	Get the status of the overload indicator for the active bank.

float	getFloatValue () override
	Get the most recent VU position for the active bank as a value between 0 and 1.

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

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

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

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

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

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

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

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

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

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

Detecting changes
bool	getDirty () const
	Check if the value was updated since the last time the dirty flag was cleared.

void	clearDirty ()
	Clear the dirty flag.

Public Types
using	Matcher = BankableVUMatcher<BankSize>

using	Parent

using	MessageType = typename MIDIInputElement<Type>::MessageType

Public Member Functions
	VU (BankConfig< BankSize > config, uint8_t track, MIDIChannelCable channelCN, unsigned int decayTime=VUDecay::Default)
	Constructor.

	VU (BankConfig< BankSize > config, uint8_t track, unsigned int decayTime=VUDecay::Default)
	Constructor.

void	reset () override
	Reset all values to zero.

void	update () override
	Decay the VU meter.

bool	updateWith (MessageType midimsg) override
	Receive a new MIDI message and update the internal state.

virtual void	handleUpdate (typename Matcher::Result match)=0

virtual void	begin ()
	Initialize the input element.

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

Static Public Member Functions
static bool	updateAllWith (MessageType midimsg)
	Update all.

static void	updateAll ()
	Update all.

static void	beginAll ()
	Begin all.

static void	resetAll ()
	Reset all.

Protected Member Functions
bool	handleUpdateImpl (typename Matcher::Result match)

void	handleUpdate (typename Matcher::Result match) override

bool	decay ()

void	onBankSettingChange () override
	A function to be executed each time the bank setting changes.

uint8_t	getActiveBank () const

Protected Attributes
Matcher	matcher

Node *	next = nullptr

BankSettingChangeCallback *	next

Node *	previous = nullptr

BankSettingChangeCallback *	previous

uint8_t	max

bool	alwaysDirty

bool	dirty = true

Static Protected Attributes
static DoublyLinkedList< MIDIInputElement< Type > >	updatables

Private Attributes
AH::Array< VUState, BankSize >	states = {{}}

AH::Timer< millis >	decayTimer

Member Typedef Documentation

◆ Matcher

template<uint8_t BankSize>

using Matcher = BankableVUMatcher<BankSize>

Definition at line 295 of file VU.hpp.

◆ Parent

template<uint8_t BankSize>

using Parent

Initial value:

 
        BankableMatchingMIDIInputElement<MIDIMessageType::ChannelPressure,
                                         Matcher>

Definition at line 296 of file VU.hpp.

◆ MessageType

template<MIDIMessageType Type, class Matcher >

using MessageType = typename MIDIInputElement<Type>::MessageType

inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ VU() [1/2]

template<uint8_t BankSize>

VU	(	BankConfig< BankSize >	config,
		uint8_t	track,
		MIDIChannelCable	channelCN,
		unsigned int	decayTime = VUDecay::Default )

inline

Constructor.

Parameters

config	The bank configuration to use.
track	The track of the VU meter. [1, 8]
channelCN	The MIDI channel [Channel_1, Channel_16] and Cable Number [Cable_1, Cable_16].
decayTime	The time in milliseconds it takes for the value to decay one step. The MCU protocol uses 300 ms per division, and two steps per division, so the default is 150 ms per step. Some software doesn't work if the VU meter decays automatically, in that case, you can set the decay time to zero to disable the decay.

See also: MCU::VUDecay

Definition at line 320 of file VU.hpp.

◆ VU() [2/2]

template<uint8_t BankSize>

VU	(	BankConfig< BankSize >	config,
		uint8_t	track,
		unsigned int	decayTime = VUDecay::Default )

inline

Constructor.

Parameters

config	The bank configuration to use.
track	The track of the VU meter. [1, 8]
decayTime	The time in milliseconds it takes for the value to decay one step. The MCU protocol uses 300 ms per division, and two steps per division, so the default is 150 ms per step. Some software doesn't work if the VU meter decays automatically, in that case, you can set the decay time to zero to disable the decay.

See also: MCU::VUDecay

Definition at line 342 of file VU.hpp.

Member Function Documentation

◆ handleUpdateImpl()

template<uint8_t BankSize>

bool handleUpdateImpl ( typename Matcher::Result match )

inlineprotected

Definition at line 347 of file VU.hpp.

◆ handleUpdate() [1/2]

template<uint8_t BankSize>

void handleUpdate ( typename Matcher::Result match )

inlineoverrideprotected

Definition at line 359 of file VU.hpp.

◆ decay()

template<uint8_t BankSize>

bool decay ( )

inlineprotected

Definition at line 363 of file VU.hpp.

◆ reset()

template<uint8_t BankSize>

void reset ( )

inlineoverridevirtual

Reset all values to zero.

Reimplemented from MIDIInputElement< Type >.

Reimplemented in VULEDs< BankSize, NumLEDs >.

Definition at line 374 of file VU.hpp.

◆ update()

template<uint8_t BankSize>

void update ( )

inlineoverridevirtual

Decay the VU meter.

Reimplemented from MIDIInputElement< Type >.

Reimplemented in VULEDs< BankSize, NumLEDs >.

Definition at line 380 of file VU.hpp.

◆ onBankSettingChange()

template<uint8_t BankSize>

void onBankSettingChange ( )

inlineoverrideprotectedvirtual

A function to be executed each time the bank setting changes.

Think of an LED that indicates whether a track is muted or not. If this LED is bankable, let's say with 4 tracks per bank, 2 banks, and a base address of 3, then this LED object keeps the state of tracks 3 and 7. When the bank setting is 0, the LED displays the state of track 3, when the bank setting is 1, the LED displays the state of track 7. To know when to update the LED, this callback is used.

Reimplemented from BankSettingChangeCallback.

Reimplemented in VULEDs< BankSize, NumLEDs >.

Definition at line 383 of file VU.hpp.

◆ getValue() [1/2]

template<uint8_t BankSize>

uint8_t getValue ( uint8_t bank ) const

inline

Get the most recent VU position that was received for the given bank.

Definition at line 390 of file VU.hpp.

◆ getOverload() [1/2]

template<uint8_t BankSize>

bool getOverload ( uint8_t bank ) const

inline

Get the status of the overload indicator for the given bank.

Definition at line 392 of file VU.hpp.

◆ getFloatValue() [1/2]

template<uint8_t BankSize>

float getFloatValue ( uint8_t bank ) const

inline

Get the most recent VU position for the given bank as a value between 0 and 1.

Definition at line 395 of file VU.hpp.

◆ getValue() [2/2]

template<uint8_t BankSize>

uint8_t getValue ( )

inlineoverridevirtual

Get the most recent VU position that was received for the active bank.

Implements IVU.

Definition at line 398 of file VU.hpp.

◆ getOverload() [2/2]

template<uint8_t BankSize>

bool getOverload ( )

inlineoverridevirtual

Get the status of the overload indicator for the active bank.

Implements IVU.

Definition at line 400 of file VU.hpp.

◆ getFloatValue() [2/2]

template<uint8_t BankSize>

float getFloatValue ( )

inlineoverridevirtual

Get the most recent VU position for the active bank as a value between 0 and 1.

Reimplemented from IVU.

Definition at line 403 of file VU.hpp.

◆ getActiveBank()

uint8_t getActiveBank ( ) const

inlineprotectedinherited

Definition at line 126 of file MIDIInputElement.hpp.

◆ updateWith()

template<MIDIMessageType Type, class Matcher >

bool updateWith ( MessageType midimsg )

inlineoverridevirtualinherited

Receive a new MIDI message and update the internal state.

Implements MIDIInputElement< Type >.

Definition at line 95 of file MIDIInputElement.hpp.

◆ handleUpdate() [2/2]

template<MIDIMessageType Type, class Matcher >

virtual void handleUpdate ( typename Matcher::Result match )

pure virtualinherited

Implemented in VPotRingLEDs< BankSize >, VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, NoteCCKPLED< Type, BankSize >, NoteCCKPLEDBar< Type, BankSize, NumLEDs >, NoteCCKPLEDPWM< Type, BankSize >, NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, and NoteCCKPRangeLEDs< Type, BankSize, RangeLen >.

Examples: Custom-MIDI-Input-Element.ino, Custom-Note-LED-Input-Element-Callback-FastLED.ino, and Custom-Note-LED-Input-Element-Callback.ino.

◆ begin()

template<MIDIMessageType Type>

virtual void begin ( )

inlinevirtualinherited

Initialize the input element.

Reimplemented in VPotRingLEDs, VPotRingLEDs< BankSize >, VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, NoteCCKPLED< Type >, NoteCCKPLED< Type, BankSize >, NoteCCKPLEDBar< Type, NumLEDs >, NoteCCKPLEDBar< Type, BankSize, NumLEDs >, NoteCCKPLEDPWM< Type >, NoteCCKPLEDPWM< Type, BankSize >, NoteCCKPRangeFastLED< Type, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, NoteCCKPRangeLEDs< Type, RangeLen >, NoteCCKPRangeLEDs< Type, BankSize, RangeLen >, LCD< BufferSize >, GenericProgramChangeSelector< N, Callback >, and GenericProgramChangeSelector< N, SelectorLEDsCallback< N > >.

Examples: Custom-MIDI-Input-Element.ino, Custom-Note-LED-Input-Element-Callback-FastLED.ino, and Custom-Note-LED-Input-Element-Callback.ino.

Definition at line 34 of file MIDIInputElement.hpp.

◆ updateAllWith()

template<MIDIMessageType Type>

static bool updateAllWith ( MessageType midimsg )

inlinestaticinherited

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ updateAll()

template<MIDIMessageType Type>

static void updateAll ( )

inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ beginAll()

template<MIDIMessageType Type>

static void beginAll ( )

inlinestaticinherited

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ resetAll()

template<MIDIMessageType Type>

static void resetAll ( )

inlinestaticinherited

Reset all.

Definition at line 67 of file MIDIInputElement.hpp.

◆ enable() [1/4]

void enable ( )

inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 96 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( UpdatableCRTP< MIDIInputElement< Type > > * element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 125 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< MIDIInputElement< Type > > & element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 127 of file Updatable.hpp.

◆ enable() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 130 of file Updatable.hpp.

◆ disable() [1/4]

void disable ( )

inlineinherited

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

Definition at line 106 of file Updatable.hpp.

◆ disable() [2/4]

static void disable ( UpdatableCRTP< MIDIInputElement< Type > > * element )

inlinestaticinherited

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

Definition at line 136 of file Updatable.hpp.

◆ disable() [3/4]

static void disable ( UpdatableCRTP< MIDIInputElement< Type > > & element )

inlinestaticinherited

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

Definition at line 138 of file Updatable.hpp.

◆ disable() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

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

Definition at line 141 of file Updatable.hpp.

◆ isEnabled()

bool isEnabled ( ) const

inlineinherited

Check if this updatable is enabled.

Note: Assumes that the updatable is not added to a different linked list by the user.

Definition at line 120 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

◆ getDirty()

bool getDirty ( ) const

inlineinherited

Check if the value was updated since the last time the dirty flag was cleared.

Definition at line 94 of file InterfaceMIDIInputElements.hpp.

◆ clearDirty()

void clearDirty ( )

inlineinherited

Clear the dirty flag.

Definition at line 96 of file InterfaceMIDIInputElements.hpp.

◆ getMax()

uint8_t getMax ( ) const

inlineinherited

Get the maximum value that this VU meter can return.

Definition at line 107 of file InterfaceMIDIInputElements.hpp.

Member Data Documentation

◆ states

template<uint8_t BankSize>

AH::Array<VUState, BankSize> states = {{}}

private

Definition at line 408 of file VU.hpp.

◆ decayTimer

template<uint8_t BankSize>

AH::Timer<millis> decayTimer

private

Definition at line 409 of file VU.hpp.

◆ matcher

template<MIDIMessageType Type, class Matcher >

Matcher matcher

protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.

◆ updatables

DoublyLinkedList< MIDIInputElement< Type > > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next [1/2]

template<class Node >

Node* next = nullptr

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ next [2/2]

BankSettingChangeCallback * next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous [1/2]

template<class Node >

Node* previous = nullptr

protectedinherited

Definition at line 321 of file LinkedList.hpp.

◆ previous [2/2]

BankSettingChangeCallback * previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

◆ max

uint8_t max

protectedinherited

Definition at line 110 of file InterfaceMIDIInputElements.hpp.

◆ alwaysDirty

bool alwaysDirty

protectedinherited

Definition at line 111 of file InterfaceMIDIInputElements.hpp.

◆ dirty

bool dirty = true

protectedinherited

Definition at line 112 of file InterfaceMIDIInputElements.hpp.

The documentation for this class was generated from the following file:

VU.hpp

Detailed Description

Data access

Enabling and disabling updatables

Detecting changes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Member Typedef Documentation

◆ Matcher

◆ Parent

◆ MessageType

Constructor & Destructor Documentation

◆ VU() [1/2]

◆ VU() [2/2]

Member Function Documentation

◆ handleUpdateImpl()

◆ handleUpdate() [1/2]

◆ decay()

◆ reset()

◆ update()

◆ onBankSettingChange()

◆ getValue() [1/2]

◆ getOverload() [1/2]

◆ getFloatValue() [1/2]

◆ getValue() [2/2]

◆ getOverload() [2/2]

◆ getFloatValue() [2/2]

◆ getActiveBank()

◆ updateWith()

◆ handleUpdate() [2/2]

◆ begin()

◆ updateAllWith()

◆ updateAll()

◆ beginAll()

◆ resetAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

◆ getDirty()

◆ clearDirty()

◆ getMax()

Member Data Documentation

◆ states

◆ decayTimer

◆ matcher

◆ updatables

◆ next [1/2]

◆ next [2/2]

◆ previous [1/2]

◆ previous [2/2]

◆ max

◆ alwaysDirty

◆ dirty