Line data    Source code

       1              : #pragma once
       2              : 
       3              : #include <Banks/BankAddresses.hpp>
       4              : #include <MIDI_Outputs/Bankable/Abstract/MIDIButton.hpp>
       5              : #include <MIDI_Senders/DigitalNoteSender.hpp>
       6              : 
       7              : BEGIN_CS_NAMESPACE
       8              : 
       9              : namespace Bankable {
      10              : 
      11              : /**
      12              :  * @brief   A class of MIDIOutputElement%s that read the input of a **momentary
      13              :  *          push button or switch**, and send out MIDI **Note** events.
      14              :  * 
      15              :  * A Note On event is sent when the button is pressed, and a Note Off
      16              :  * event is sent when the button is released.  
      17              :  * The button is debounced in software.  
      18              :  * This version can be banked.  
      19              :  *
      20              :  * @ingroup BankableMIDIOutputElements
      21              :  */
      22              : class NoteButton : public MIDIButton<SingleAddress, DigitalNoteSender> {
      23              :   public:
      24              :     /**
      25              :      * @brief   Create a new Bankable NoteButton object with the given pin, note
      26              :      *          number and channel.
      27              :      * 
      28              :      * @param   config
      29              :      *          The bank configuration to use: the bank to add this element to,
      30              :      *          and whether to change the address, channel or cable number.
      31              :      * @param   pin
      32              :      *          The digital input pin to read from.  
      33              :      *          The internal pull-up resistor will be enabled.
      34              :      * @param   address
      35              :      *          The MIDI address containing the note number [0, 127], 
      36              :      *          channel [Channel_1, Channel_16], and optional cable number 
      37              :      *          [Cable_1, Cable_16].
      38              :      * @param   velocity
      39              :      *          The velocity of the MIDI Note events.
      40              :      */
      41            4 :     NoteButton(OutputBankConfig<> config, pin_t pin, MIDIAddress address,
      42              :                uint8_t velocity = 0x7F)
      43            4 :         : MIDIButton<SingleAddress, DigitalNoteSender> {
      44              :               {config, address},
      45              :               pin,
      46              :               {velocity},
      47            4 :           } {}
      48              : 
      49              :     /// Set the velocity of the MIDI Note events.
      50              :     void setVelocity(uint8_t velocity) { this->sender.setVelocity(velocity); }
      51              :     /// Get the velocity of the MIDI Note events.
      52              :     uint8_t getVelocity() const { return this->sender.getVelocity(); }
      53              : };
      54              : 
      55              : } // namespace Bankable
      56              : 
      57              : END_CS_NAMESPACE