#include <MIDI_Inputs/LEDs/NoteCCRangeLEDs.hpp>

Inheritance diagram for CCValueLED< BankSize >:

Collaboration diagram for CCValueLED< BankSize >:

Public Member Functions
	CCValueLED (const BankConfig< BankSize > &config, pin_t ledPin, const MIDICNChannelAddress &address)

uint8_t	getBankIndex (const MIDICNChannelAddress &target, const MIDICNChannelAddress &base) const
	Calculate the bank setting of a given MIDI address, relative to a base address. More...

uint8_t	getValue (uint8_t index) const final override

virtual uint8_t	getValue (uint8_t index) const =0
	Get the velocity or controller value for the given index in the range. More...

uint8_t	getValue () const
	Get the velocity or controller value of the first or only note or controller. More...

uint8_t	getValue () const
	Get the velocity or controller value of the first or only note or controller. More...

void	begin () override
	Initialize. More...

void	reset () override
	Reset all values to zero. More...

uint8_t	length () const
	Get the length of the range of note/CC addresses. More...

virtual void	update ()
	Update the value of the input element. Used for decaying VU meters etc. More...

bool	updateWith (const ChannelMessageMatcher &midimsg)
	Receive a new MIDI message and update the internal state. More...

Static Public Member Functions
constexpr static uint8_t	length ()
	Get the length of the range. More...

static void	beginAll ()
	Initialize all MIDIInputElementCC elements. More...

static void	updateAll ()
	Update all MIDIInputElementCC elements. More...

static void	resetAll ()
	Reset all MIDIInputElementCC elements to their initial state. More...

static void	updateAllWith (const ChannelMessageMatcher &midimsg)
	Update all MIDIInputElementCC elements with a new MIDI message. More...

Public Attributes
NoteCCLED< 1 >	callback
	Callback that is called when a value in the active bank changes. More...

Protected Member Functions
uint8_t	getRangeIndex (MIDICNChannelAddress target, MIDICNChannelAddress base) const
	If matchBankableAddressInRange returned true, get the index of the message in the range. More...

bool	matchBankable (uint8_t toMatch, uint8_t base) const
	Check if the given address is part of the bank relative to the base address. More...

bool	matchBankable (const MIDICNChannelAddress &toMatch, const MIDICNChannelAddress &base) const
	Check whether a given address is part of the bank relative to the base address. More...

bool	matchBankableInRange (uint8_t toMatch, uint8_t base, uint8_t length) const
	Check if the given address is part of the bank relative to the base address. More...

bool	matchBankableAddressInRange (const MIDICNChannelAddress &toMatch, const MIDICNChannelAddress &base, uint8_t length) const
	Check whether a given address is part of the bank relative to the base address and within a range with a given length. More...

Static Protected Member Functions
static bool	inRange (uint8_t toMatch, uint8_t base, uint8_t length)
	Check whether a given address is within a range of given length starting from the given base address. More...

Protected Attributes
const MIDICNChannelAddress	address

MIDIInputElementCC *	next

BankableMIDIInput< N > *	next

MIDIInputElementCC *	previous

BankableMIDIInput< N > *	previous

Private Member Functions
bool	match (const MIDICNChannelAddress &target) const override
	Check if the address of the incoming MIDI message is within the range of addresses and in one of the banks of this element. More...

setting_t	getSelection () const override
	Get the active bank selection. More...

uint8_t	getBankIndex (MIDICNChannelAddress target) const override
	Get the bank index from a MIDI address. More...

uint8_t	getRangeIndex (MIDICNChannelAddress target) const override
	Get the index of the given MIDI address in the range. More...

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

bool	updateImpl (const ChannelMessageMatcher &midimsg, const MIDICNChannelAddress &target) override

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

virtual MIDICNChannelAddress	getTarget (const ChannelMessageMatcher &midimsg) const
	Extract the target address from a MIDI message. More...

Static Private Member Functions
static uint8_t	getValueFromMIDIMessage (const ChannelMessageMatcher &midimsg)
	Extract the "value" from a MIDI Note or Control Change message. More...

Private Attributes
Array< Array< uint8_t, RangeLen >, NumBanks >	values
	A 2D array for saving all values of the range, for all banks. More...

uint8_t	rangeLength

Bank< N > &	bank

const BankType	type

Static Private Attributes
static DoublyLinkedList< MIDIInputElementCC >	elements

Detailed Description

template<uint8_t BankSize>
class Bankable::CCValueLED< BankSize >

Definition at line 248 of file NoteCCRangeLEDs.hpp.

Constructor & Destructor Documentation

◆ CCValueLED()

CCValueLED	(	const BankConfig< BankSize > &	config,
		pin_t	ledPin,
		const MIDICNChannelAddress &	address
	)

inline

Definition at line 251 of file NoteCCRangeLEDs.hpp.

Member Function Documentation

◆ match()

bool match ( const MIDICNChannelAddress & target ) const

inlineoverrideprivatevirtualinherited

Check if the address of the incoming MIDI message is within the range of addresses and in one of the banks of this element.

Reimplemented from MIDIInputElement.

Definition at line 262 of file NoteCCRange.hpp.

◆ getSelection()

setting_t getSelection ( ) const

inlineoverrideprivatevirtualinherited

Get the active bank selection.

Reimplemented from NoteCCRange< MIDIInputElementCC, RangeLen, NumBanks, NoteCCLED< 1 > >.

Definition at line 267 of file NoteCCRange.hpp.

◆ getBankIndex() [1/2]

uint8_t getBankIndex ( MIDICNChannelAddress target ) const

inlineoverrideprivatevirtualinherited

Get the bank index from a MIDI address.

Reimplemented from NoteCCRange< MIDIInputElementCC, RangeLen, NumBanks, NoteCCLED< 1 > >.

Definition at line 271 of file NoteCCRange.hpp.

◆ getBankIndex() [2/2]

uint8_t getBankIndex	(	const MIDICNChannelAddress &	target,
		const MIDICNChannelAddress &	base
	)		const

inlineinherited

Calculate the bank setting of a given MIDI address, relative to a base address.

Parameters

target	The MIDI address to calculate the bank setting of.
base	The base address to compare it to (the address of bank setting 0).

Definition at line 71 of file BankableMIDIInput.hpp.

◆ getRangeIndex() [1/2]

uint8_t getRangeIndex ( MIDICNChannelAddress target ) const

inlineoverrideprivatevirtualinherited

Get the index of the given MIDI address in the range.

Reimplemented from NoteCCRange< MIDIInputElementCC, RangeLen, NumBanks, NoteCCLED< 1 > >.

Definition at line 275 of file NoteCCRange.hpp.

◆ getRangeIndex() [2/2]

uint8_t getRangeIndex	(	MIDICNChannelAddress	target,
		MIDICNChannelAddress	base
	)		const

inlineprotectedinherited

If matchBankableAddressInRange returned true, get the index of the message in the range.

Definition at line 143 of file BankableMIDIInput.hpp.

◆ onBankSettingChange()

void onBankSettingChange ( )

inlineoverrideprivatevirtualinherited

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 BankableMIDIInput< NumBanks >.

Definition at line 280 of file NoteCCRange.hpp.

◆ getValue() [1/4]

uint8_t getValue ( uint8_t index ) const

inlinefinaloverridevirtualinherited

Todo:: check index bounds

Implements INoteCCValue.

Definition at line 79 of file NoteCCRange.hpp.

◆ getValue() [2/4]

virtual uint8_t getValue

inherited

Get the velocity or controller value for the given index in the range.

◆ getValue() [3/4]

uint8_t getValue

inlineinherited

Get the velocity or controller value of the first or only note or controller.

Definition at line 24 of file NoteCCRange.hpp.

◆ getValue() [4/4]

uint8_t getValue ( ) const

inlineinherited

Get the velocity or controller value of the first or only note or controller.

Definition at line 24 of file NoteCCRange.hpp.

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize.

Reimplemented from MIDIInputElement.

Definition at line 85 of file NoteCCRange.hpp.

◆ reset()

void reset ( )

inlineoverridevirtualinherited

Reset all values to zero.

Reimplemented from MIDIInputElement.

Definition at line 87 of file NoteCCRange.hpp.

◆ updateImpl()

bool updateImpl	(	const ChannelMessageMatcher &	midimsg,
		const MIDICNChannelAddress &	target
	)

inlineoverrideprivatevirtualinherited

Implements MIDIInputElement.

Definition at line 95 of file NoteCCRange.hpp.

◆ getValueFromMIDIMessage()

static uint8_t getValueFromMIDIMessage ( const ChannelMessageMatcher & midimsg )

inlinestaticprivateinherited

Extract the "value" from a MIDI Note or Control Change message.

For Note On and Control Change, this is simply the second data byte, for Note Off, it's zero.

Definition at line 120 of file NoteCCRange.hpp.

◆ length() [1/2]

constexpr static uint8_t length ( )

inlinestaticconstexprinherited

Get the length of the range.

Definition at line 148 of file NoteCCRange.hpp.

◆ length() [2/2]

uint8_t length ( ) const

inlineinherited

Get the length of the range of note/CC addresses.

Definition at line 19 of file NoteCCRange.hpp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Initialize all MIDIInputElementCC elements.

See also: MIDIInputElementCC::begin

Definition at line 50 of file MIDIInputElementCC.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all MIDIInputElementCC elements.

See also: MIDIInputElementCC::update

Definition at line 58 of file MIDIInputElementCC.hpp.

◆ resetAll()

static void resetAll ( )

inlinestaticinherited

Reset all MIDIInputElementCC elements to their initial state.

See also: MIDIInputElementCC::reset

Definition at line 66 of file MIDIInputElementCC.hpp.

◆ updateAllWith()

static void updateAllWith ( const ChannelMessageMatcher & midimsg )

inlinestaticinherited

Update all MIDIInputElementCC elements with a new MIDI message.

See also: MIDIInputElementCC::updateWith

Definition at line 74 of file MIDIInputElementCC.hpp.

◆ moveDown()

void moveDown ( )

inlineprivateinherited

Move down this element in the linked list of elements.

This means that the element will be checked earlier on the next iteration.

Definition at line 92 of file MIDIInputElementCC.hpp.

◆ update()

virtual void update ( )

inlinevirtualinherited

Update the value of the input element. Used for decaying VU meters etc.

Reimplemented in VU_Base< NumValues, Callback >, VU_Base< NumBanks, Callback >, VU_Base< NumBanks, VULEDsCallback< NumLEDs > >, VU_Base< NumBanks, VUEmptyCallback >, VU_Base< 1, VUEmptyCallback >, VU_Base< 1, VULEDsCallback< NumLEDs > >, and VU_Base< 1, Callback >.

Definition at line 36 of file MIDIInputElement.hpp.

◆ updateWith()

bool updateWith ( const ChannelMessageMatcher & midimsg )

inlineinherited

Receive a new MIDI message and update the internal state.

Definition at line 39 of file MIDIInputElement.hpp.

◆ getTarget()

virtual MIDICNChannelAddress getTarget ( const ChannelMessageMatcher & midimsg ) const

inlineprivatevirtualinherited

Extract the target address from a MIDI message.

Note: This base version of the function is only valid for messages that use data1 as an address (i.e. Note On, Note Off, Polyphonic Key Pressure and Control Change), because it assumes that the target address consists of the address (data 1), the MIDI channel and the cable number.

Reimplemented in VU_Base< NumValues, Callback >, VU_Base< NumBanks, Callback >, VU_Base< NumBanks, VULEDsCallback< NumLEDs > >, VU_Base< NumBanks, VUEmptyCallback >, VU_Base< 1, VUEmptyCallback >, VU_Base< 1, VULEDsCallback< NumLEDs > >, VU_Base< 1, Callback >, MIDIInputElementChannelPressure, and MIDIInputElementPC.

Definition at line 64 of file MIDIInputElement.hpp.

◆ matchBankable() [1/2]

bool matchBankable	(	uint8_t	toMatch,
		uint8_t	base
	)		const

inlineprotectedinherited

Check if the given address is part of the bank relative to the base address.

Consider the following example:
A Bank with 4 tracks per bank (T), 2 bank settings (N), and a base address of 3.

0 1 2 3 4 5 6 7 8 9 10 11 12 ...

F F F T F F F T F F F F F ...

Addresses before the base adddress are not matched (0, 1, 2).
Addresses after N * T are not matched (8, 9, 10, 11, 12).
Addresses with a distance to the base address that is not a multiple of N are not matched (4, 5, 6).

Parameters

toMatch	The address to check.
base	The base address (the address of bank setting 0).

Note: Equivalent to matchBankableInRange(toMatch, base, 1).

Definition at line 113 of file BankableMIDIInput.hpp.

◆ matchBankable() [2/2]

bool matchBankable	(	const MIDICNChannelAddress &	toMatch,
		const MIDICNChannelAddress &	base
	)		const

inlineprotectedinherited

Check whether a given address is part of the bank relative to the base address.

Parameters

toMatch	The address to check.
base	The base address (the address of bank setting 0).

Definition at line 175 of file BankableMIDIInput.hpp.

◆ matchBankableInRange()

bool matchBankableInRange	(	uint8_t	toMatch,
		uint8_t	base,
		uint8_t	length
	)		const

inlineprotectedinherited

Check if the given address is part of the bank relative to the base address.

Todo:: This is very hard to explain without a specific example ...

Parameters

toMatch	The address to check.
base	The base address (the address of bank setting 0).
length	The length of the range.

Definition at line 132 of file BankableMIDIInput.hpp.

◆ inRange()

static bool inRange	(	uint8_t	toMatch,
		uint8_t	base,
		uint8_t	length
	)

inlinestaticprotectedinherited

Check whether a given address is within a range of given length starting from the given base address.

Parameters

toMatch	The address to check
base	The base address, start of the range.
length	The length of the range.

Definition at line 162 of file BankableMIDIInput.hpp.

◆ matchBankableAddressInRange()

bool matchBankableAddressInRange	(	const MIDICNChannelAddress &	toMatch,
		const MIDICNChannelAddress &	base,
		uint8_t	length
	)		const

inlineprotectedinherited

Check whether a given address is part of the bank relative to the base address and within a range with a given length.

Parameters

toMatch	The address to check.
base	The base address (the address of bank setting 0).
length	The length of the range.

Definition at line 212 of file BankableMIDIInput.hpp.

Member Data Documentation

◆ values

Array<Array<uint8_t, RangeLen>, NumBanks> values

privateinherited

A 2D array for saving all values of the range, for all banks.

Definition at line 142 of file NoteCCRange.hpp.

◆ callback

NoteCCLED< 1 > callback

inherited

Callback that is called when a value in the active bank changes.

Definition at line 146 of file NoteCCRange.hpp.

◆ elements

DoublyLinkedList< MIDIInputElementCC > elements

staticprivateinherited

Definition at line 97 of file MIDIInputElementCC.hpp.

◆ address

const MIDICNChannelAddress address

protectedinherited

Definition at line 80 of file MIDIInputElement.hpp.

◆ next [1/2]

MIDIInputElementCC * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ next [2/2]

BankableMIDIInput< N > * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous [1/2]

MIDIInputElementCC * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

◆ previous [2/2]

BankableMIDIInput< N > * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

◆ rangeLength

uint8_t rangeLength

privateinherited

Definition at line 27 of file NoteCCRange.hpp.

◆ bank

Bank<N>& bank

privateinherited

Definition at line 242 of file BankableMIDIInput.hpp.

◆ type

const BankType type

privateinherited

Definition at line 243 of file BankableMIDIInput.hpp.

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

NoteCCRangeLEDs.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

template<uint8_t BankSize> class Bankable::CCValueLED< BankSize >

Constructor & Destructor Documentation

◆ CCValueLED()

Member Function Documentation

◆ match()

◆ getSelection()

◆ getBankIndex() [1/2]

◆ getBankIndex() [2/2]

◆ getRangeIndex() [1/2]

◆ getRangeIndex() [2/2]

◆ onBankSettingChange()

◆ getValue() [1/4]

◆ getValue() [2/4]

◆ getValue() [3/4]

◆ getValue() [4/4]

◆ begin()

◆ reset()

◆ updateImpl()

◆ getValueFromMIDIMessage()

◆ length() [1/2]

◆ length() [2/2]

◆ beginAll()

◆ updateAll()

◆ resetAll()

◆ updateAllWith()

◆ moveDown()

◆ update()

◆ updateWith()

◆ getTarget()

◆ matchBankable() [1/2]

◆ matchBankable() [2/2]

◆ matchBankableInRange()

◆ inRange()

◆ matchBankableAddressInRange()

Member Data Documentation

◆ values

◆ callback

◆ elements

◆ address

◆ next [1/2]

◆ next [2/2]

◆ previous [1/2]

◆ previous [2/2]

◆ rangeLength

◆ bank

◆ type

template<uint8_t BankSize>
class Bankable::CCValueLED< BankSize >