midi_Defs.h

Go to the documentation of this file.

#pragma once

#include "midi_Namespace.h"

#if ARDUINO
#include <Arduino.h>
#else
#include <inttypes.h>
typedef uint8_t byte;
#endif

BEGIN_MIDI_NAMESPACE

#define MIDI_LIBRARY_VERSION        0x040300
#define MIDI_LIBRARY_VERSION_MAJOR  4
#define MIDI_LIBRARY_VERSION_MINOR  3
#define MIDI_LIBRARY_VERSION_PATCH  0

// -----------------------------------------------------------------------------

#define MIDI_CHANNEL_OMNI       0
#define MIDI_CHANNEL_OFF        17 // and over

#define MIDI_PITCHBEND_MIN      -8192
#define MIDI_PITCHBEND_MAX      8191

// -----------------------------------------------------------------------------
// Type definitions

typedef byte StatusByte;
typedef byte DataByte;
typedef byte Channel;
typedef byte FilterMode;

// -----------------------------------------------------------------------------

enum MidiType
{
    InvalidType           = 0x00,    
    NoteOff               = 0x80,    
    NoteOn                = 0x90,    
    AfterTouchPoly        = 0xA0,    
    ControlChange         = 0xB0,    
    ProgramChange         = 0xC0,    
    AfterTouchChannel     = 0xD0,    
    PitchBend             = 0xE0,    
    SystemExclusive       = 0xF0,    
    TimeCodeQuarterFrame  = 0xF1,    
    SongPosition          = 0xF2,    
    SongSelect            = 0xF3,    
    TuneRequest           = 0xF6,    
    Clock                 = 0xF8,    
    Start                 = 0xFA,    
    Continue              = 0xFB,    
    Stop                  = 0xFC,    
    ActiveSensing         = 0xFE,    
    SystemReset           = 0xFF,    
};

// -----------------------------------------------------------------------------

struct Thru
{
    enum Mode
    {
        Off                   = 0,  
        Full                  = 1,  
        SameChannel           = 2,  
        DifferentChannel      = 3,  
    };
};

enum __attribute__ ((deprecated)) MidiFilterMode
{
    Off                 = Thru::Off,
    Full                = Thru::Full,
    SameChannel         = Thru::SameChannel,
    DifferentChannel    = Thru::DifferentChannel,
};

// -----------------------------------------------------------------------------

enum MidiControlChangeNumber
{
    // High resolution Continuous Controllers MSB (+32 for LSB) ----------------
    BankSelect                  = 0,
    ModulationWheel             = 1,
    BreathController            = 2,
    // CC3 undefined
    FootController              = 4,
    PortamentoTime              = 5,
    DataEntryMSB                = 6,
    ChannelVolume               = 7,
    Balance                     = 8,
    // CC9 undefined
    Pan                         = 10,
    ExpressionController        = 11,
    EffectControl1              = 12,
    EffectControl2              = 13,
    // CC14 undefined
    // CC15 undefined
    GeneralPurposeController1   = 16,
    GeneralPurposeController2   = 17,
    GeneralPurposeController3   = 18,
    GeneralPurposeController4   = 19,

    DataEntryLSB                = 38,

    // Switches ----------------------------------------------------------------
    Sustain                     = 64,
    Portamento                  = 65,
    Sostenuto                   = 66,
    SoftPedal                   = 67,
    Legato                      = 68,
    Hold                        = 69,

    // Low resolution continuous controllers -----------------------------------
    SoundController1            = 70,   
    SoundController2            = 71,   
    SoundController3            = 72,   
    SoundController4            = 73,   
    SoundController5            = 74,   
    SoundController6            = 75,   
    SoundController7            = 76,   
    SoundController8            = 77,   
    SoundController9            = 78,   
    SoundController10           = 79,   
    GeneralPurposeController5   = 80,
    GeneralPurposeController6   = 81,
    GeneralPurposeController7   = 82,
    GeneralPurposeController8   = 83,
    PortamentoControl           = 84,
    // CC85 to CC90 undefined
    Effects1                    = 91,   
    Effects2                    = 92,   
    Effects3                    = 93,   
    Effects4                    = 94,   
    Effects5                    = 95,   
    DataIncrement               = 96,
    DataDecrement               = 97,
    NRPNLSB                     = 98,   
    NRPNMSB                     = 99,   
    RPNLSB                      = 100,  
    RPNMSB                      = 101,  

    // Channel Mode messages ---------------------------------------------------
    AllSoundOff                 = 120,
    ResetAllControllers         = 121,
    LocalControl                = 122,
    AllNotesOff                 = 123,
    OmniModeOff                 = 124,
    OmniModeOn                  = 125,
    MonoModeOn                  = 126,
    PolyModeOn                  = 127
};

struct RPN
{
    enum RegisteredParameterNumbers
    {
        PitchBendSensitivity    = 0x0000,
        ChannelFineTuning       = 0x0001,
        ChannelCoarseTuning     = 0x0002,
        SelectTuningProgram     = 0x0003,
        SelectTuningBank        = 0x0004,
        ModulationDepthRange    = 0x0005,
        NullFunction            = (0x7f << 7) + 0x7f,
    };
};

// -----------------------------------------------------------------------------

#define MIDI_CREATE_INSTANCE(Type, SerialPort, Name)                            \
    midi::MidiInterface<Type> Name((Type&)SerialPort);

#if defined(ARDUINO_SAM_DUE) || defined(USBCON)
    // Leonardo, Due and other USB boards use Serial1 by default.
    #define MIDI_CREATE_DEFAULT_INSTANCE()                                      \
        MIDI_CREATE_INSTANCE(HardwareSerial, Serial1, MIDI);
#else

    #define MIDI_CREATE_DEFAULT_INSTANCE()                                      \
        MIDI_CREATE_INSTANCE(HardwareSerial, Serial,  MIDI);
#endif

#define MIDI_CREATE_CUSTOM_INSTANCE(Type, SerialPort, Name, Settings)           \
    midi::MidiInterface<Type, Settings> Name((Type&)SerialPort);

END_MIDI_NAMESPACE