A class of MIDIOutputElements that read the analog input from a potentiometer or fader, and send out 14-bit MIDI Pitch Bend events. More...
#include <MIDI_Outputs/Bankable/PBSmartPotentiometer.hpp>
Public Types | |
enum | State |
State of the smart potentiometer. More... | |
using | Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type |
using | LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type |
Public Member Functions | |
PBSmartPotentiometer (BankConfig< NumBanks > config, pin_t analogPin, MIDIChannelCN address) | |
Create a new Bankable PBSmartPotentiometer object with the given analog pin and channel. More... | |
void | begin () override |
Initialize this updatable. More... | |
void | update () override |
Update this updatable. More... | |
State | getState () const |
Get the state of the smart potentiometer, to know whether the position has to be lower or higher in order to activate it. More... | |
void | activate () |
Activate the potentiometer in the current bank, regardless of its current and previous position. More... | |
void | map (MappingFunction fn) |
Specify a mapping function that is applied to the raw analog value before sending. More... | |
void | invert () |
Invert the analog value. More... | |
analog_t | getRawValue () const |
Get the raw value of the analog input (this is the value without applying the filter or the mapping function first). More... | |
analog_t | getValue () const |
Get the value of the analog input (this is the value after first applying the mapping function). More... | |
Static Public Member Functions | |
static Mutex & | getMutex () |
Public Attributes | |
PitchBendSender< 10 > | sender |
Protected Attributes | |
Updatable< NormalUpdatable, false > * | next |
Updatable< NormalUpdatable, false > * | previous |
Static Protected Attributes | |
static DoublyLinkedList< Updatable< NormalUpdatable, false > > | updatables |
static Mutex | mutex |
Private Attributes | |
SingleAddress | address |
AH::FilteredAnalog< Sender::precision()> | filteredAnalog |
AH::Array< analog_t, NumBanks > | previousValues |
State | state |
setting_t | previousBank |
Static Private Attributes | |
constexpr static analog_t | initial |
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... | |
A class of MIDIOutputElements that read the analog input from a potentiometer or fader, and send out 14-bit MIDI Pitch Bend events.
The analog input is filtered and hysteresis is applied for maximum stability.
The actual precision is "only" 10 bits, because this is the resolution of the built-in ADC, and this is the default resolution used by the Mackie Control Universal protocol.
This version can be banked, and when changing banks, it disables the potentiometer until you move it to the position where it was last time the current bank was active. This prevents the values changing when changing banks.
NumBanks | The number of banks. |
Definition at line 35 of file PBSmartPotentiometer.hpp.
|
inherited |
Definition at line 36 of file Updatable.hpp.
|
inherited |
Definition at line 38 of file Updatable.hpp.
|
inherited |
State of the smart potentiometer.
Definition at line 47 of file SmartMIDIFilteredAnalog.hpp.
|
inline |
Create a new Bankable PBSmartPotentiometer object with the given analog pin and channel.
config | The bank configuration to use: the bank to add this element to, and whether to the channel or cable number. |
analogPin | The analog input pin to read from. |
address | The MIDI address containing the channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16]. |
Definition at line 52 of file PBSmartPotentiometer.hpp.
|
inlineoverridevirtualinherited |
Initialize this updatable.
Implements Updatable<>.
Definition at line 61 of file SmartMIDIFilteredAnalog.hpp.
|
inlineoverridevirtualinherited |
Update this updatable.
Implements Updatable<>.
Definition at line 66 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Get the state of the smart potentiometer, to know whether the position has to be lower or higher in order to activate it.
Definition at line 99 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Activate the potentiometer in the current bank, regardless of its current and previous position.
Definition at line 105 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Specify a mapping function that is applied to the raw analog value before sending.
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. |
Definition at line 119 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Invert the analog value.
Definition at line 122 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Get the raw value of the analog input (this is the value without applying the filter or the mapping function first).
Definition at line 128 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Get the value of the analog input (this is the value after first applying the mapping function).
Definition at line 134 of file SmartMIDIFilteredAnalog.hpp.
|
inlinestaticinherited |
Begin all enabled instances of this class.
Definition at line 208 of file Updatable.hpp.
|
inlinestaticinherited |
Update all enabled instances of this class.
Definition at line 212 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 79 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 85 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 93 of file Updatable.hpp.
|
inlineinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 106 of file Updatable.hpp.
|
inlineinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 115 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 144 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 146 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 149 of file Updatable.hpp.
|
inlineinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 119 of file Updatable.hpp.
|
inlineinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 128 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 155 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 157 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 160 of file Updatable.hpp.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 136 of file Updatable.hpp.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 141 of file Updatable.hpp.
|
inlineinherited |
Move down this element in the list.
Definition at line 166 of file Updatable.hpp.
|
inlineinherited |
Move down this element in the list.
Definition at line 168 of file Updatable.hpp.
|
privateinherited |
Definition at line 137 of file SmartMIDIFilteredAnalog.hpp.
|
privateinherited |
Definition at line 138 of file SmartMIDIFilteredAnalog.hpp.
|
staticconstexprprivateinherited |
Definition at line 143 of file SmartMIDIFilteredAnalog.hpp.
|
privateinherited |
Definition at line 144 of file SmartMIDIFilteredAnalog.hpp.
|
privateinherited |
Definition at line 145 of file SmartMIDIFilteredAnalog.hpp.
|
privateinherited |
Definition at line 146 of file SmartMIDIFilteredAnalog.hpp.
|
inherited |
Definition at line 149 of file SmartMIDIFilteredAnalog.hpp.
|
staticprotectedinherited |
Definition at line 173 of file Updatable.hpp.
|
staticprotectedinherited |
Definition at line 174 of file Updatable.hpp.
|
protectedinherited |
Definition at line 323 of file LinkedList.hpp.
|
protectedinherited |
Definition at line 324 of file LinkedList.hpp.