midi.h

Go to the documentation of this file.

/*
 *   NiCMidi - A C++ Class Library for MIDI
 *
 *   Copyright (C) 2004  J.D. Koftinoff Software, Ltd.
 *   www.jdkoftinoff.com jeffk@jdkoftinoff.com
 *   Copyright (C) 2021, 2022  Nicola Cassetta
 *   https://github.com/ncassetta/NiCMidi
 *
 *   This file is part of NiCMidi.
 *
 *   NiCMidi is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as
 *   published by the Free Software Foundation, either version 3 of
 *   the License, or (at your option) any later version.
 *
 *   NiCMidi is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *   GNU Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with NiCMidi. If not, see <http://www.gnu.org/licenses/>.
 */
 
 
 
 
#ifndef _NICMIDI_MIDI_H
#define _NICMIDI_MIDI_H
 
 
 
typedef unsigned long MIDIClockTime;
 
 
const MIDIClockTime TIME_INFINITE = 0xffffffff;
const unsigned int DEFAULT_CLKS_PER_BEAT = 120;
 
 
/* TODO: THIS IS EXPERIMENTAL; FOR NOW NOT IMPLEMENTED
enum {
    CHANS_FROM_1 = 1,
    MEAS_FROM_1 = 2,
    TRACKS_FROM_1 = 4,
    PORTS_FROM_1 = 8
};
 
static unsigned char From1Flag = 0;
 
void SetChansFrom1(bool f)      { (From1Flag &= (~CHANS_FROM_1)) |= (CHANS_FROM_1 * f); };
void SetMeasFrom1(bool f)       { (From1Flag &= (~MEAS_FROM_1)) |= (MEAS_FROM_1 * f); };
void SetTracksFrom1(bool f)     { (From1Flag &= (~TRACKS_FROM_1)) |= (TRACKS_FROM_1 * f); };
void SetPortsFrom1(bool f)      { (From1Flag &= (~PORTS_FROM_1)) |= (PORTS_FROM_1 * f); };
void SetFrom1(unsigned char c)  { From1Flag = c; }
int GetChansFrom1()             { return (From1Flag & CHANS_FROM_1) == CHANS_FROM_1; };
int GetMeasFrom1()              { return (From1Flag & MEAS_FROM_1) == MEAS_FROM_1; };
int GetTracksFrom1()            { return (From1Flag & TRACKS_FROM_1) == TRACKS_FROM_1; };
int GetPortsFrom1()             { return (From1Flag & PORTS_FROM_1) == PORTS_FROM_1; };
unsigned char GetFrom1Flag()    { return From1Flag; };
 
*/
 
 
 
 
enum : unsigned char {
    NOTE_OFF            =0x80,  
    NOTE_ON                     =0x90,  
    POLY_PRESSURE           =0xa0,  
    CONTROL_CHANGE          =0xb0,  
    PROGRAM_CHANGE          =0xc0,  
    CHANNEL_PRESSURE    =0xd0,  
    PITCH_BEND          =0xe0,  
    SYSEX_START         =0xf0,  
    MTC                     =0xf1,  
    SONG_POSITION           =0xf2,  
    SONG_SELECT         =0xf3,  
    TUNE_REQUEST            =0xf6,  
    SYSEX_END           =0xf7,  
    RESET                       =0xff,  
    META_EVENT          =0xff   
    // TODO: these should be merged with MIDI real time messages, but this should not retrocompatible
};
 
 
 
enum : unsigned char {
    RT_TIMING_CLOCK         =0xf8,  
    RT_MEASURE_END          =0xf9,      
    RT_START                =0xfa,  
    RT_CONTINUE         =0xfb,  
    RT_STOP                     =0xfc,  
    RT_ACTIVE_SENSE         =0xfe   
};
 
 
 
enum : unsigned char {
    C_LSB                       =0x20,  
    C_GM_BANK           =0x00,  
    C_MODULATION            =0x01,      
    C_BREATH            =0x02,  
    C_FOOT                      =0x04,  
    C_PORTA_TIME            =0x05,      
    C_DATA_ENTRY            =0x06,      
    C_MAIN_VOLUME           =0x07,      
    C_BALANCE           =0x08,  
    C_PAN                       =0x0a,  
    C_EXPRESSION            =0x0b,      
    C_GENERAL_1         =0x10,  
    C_GENERAL_2         =0x11,  
    C_GENERAL_3         =0x12,  
    C_GENERAL_4         =0x13,  
 
    C_DAMPER            =0x40,  
    C_PORTA                     =0x41,  
    C_SOSTENUTO         =0x42,  
    C_SOFT_PEDAL            =0x43,      
    C_HOLD_2            =0x45,  
 
    C_GENERAL_5         =0x50,  
    C_GENERAL_6         =0x51,  
    C_GENERAL_7         =0x52,  
    C_GENERAL_8         =0x53,  
 
    C_EFFECT_DEPTH          =0x5b,      
    C_TREMELO_DEPTH         =0x5c,      
    C_CHORUS_DEPTH          =0x5d,      
    C_CELESTE_DEPTH         =0x5e,      
    C_PHASER_DEPTH          =0x5f,      
 
    C_DATA_INC          =0x60,  
    C_DATA_DEC          =0x61,  
 
    C_NRPN_LSB          =0x62,  
    C_NRPN_MSB          =0x63,  
    C_RPN_LSB           =0x64,  
    C_RPN_MSB           =0x65,  
 
    C_ALL_SOUND_OFF     =0x78,  
    C_RESET                     =0x79,  
    C_LOCAL                     =0x7a,  
    C_ALL_NOTES_OFF         =0x7b,      
    C_OMNI_OFF          =0x7c,  
    C_OMNI_ON           =0x7d,  
    C_MONO                      =0x7e,  
    C_POLY                      =0x7f   
};
 
 
 
enum : unsigned char {
    RPN_BEND_WIDTH          =0x00,      
    RPN_FINE_TUNE           =0x01,      
    RPN_COARSE_TUNE     =0x02   
};
 
 
enum : unsigned char {
    META_SEQUENCE_NUMBER        = 0x00,
    META_GENERIC_TEXT       = 0x01,
    META_COPYRIGHT                  = 0x02, 
    META_TRACK_NAME             = 0x03, 
    META_INSTRUMENT_NAME        = 0x04, 
    META_LYRIC_TEXT                 = 0x05, 
    META_MARKER_TEXT        = 0x06, 
    META_CUE_TEXT                   = 0x07, 
    META_PROGRAM_NAME       = 0x08, 
    META_DEVICE_NAME        = 0x09, 
    META_GENERIC_TEXT_A     = 0x0A, 
    META_GENERIC_TEXT_B     = 0x0B, 
    META_GENERIC_TEXT_C     = 0x0C, 
    META_GENERIC_TEXT_D     = 0x0D, 
    META_GENERIC_TEXT_E     = 0x0E, 
    META_GENERIC_TEXT_F     = 0x0F, 
    META_CHANNEL_PREFIX     = 0x20,
    META_OUTPUT_CABLE       = 0x21,
    //META_TRACK_LOOP         = 0x2E, I found no documentation for this
    META_END_OF_TRACK       = 0x2F,
    META_TEMPO              = 0x51,
    META_SMPTE              = 0x54,
    META_TIMESIG            = 0x58,
    META_KEYSIG             = 0x59,
    META_SEQUENCER_SPECIFIC = 0x7F
};
 
 
// these are used by MIDIMessage class
extern const signed char        chan_msg_len[16];
extern const signed char        sys_msg_len[16];
 
 
 
const char*                 GetChanMsgName(unsigned char status);
const char*                 GetChanModeMsgName(unsigned char number);
const char*                 GetSysMsgName(unsigned char status);
const char*                 GetMetaMsgName(unsigned char type);
const char*                 GetGMProgramName(unsigned char number, int format = 0);
const char*                 GetGMDrumkitName(unsigned char number, int format = 0);
bool                        IsNoteWhite(unsigned char note);
bool                        IsNoteBlack(unsigned char note);
 
inline int GetNoteOctave(unsigned char note) {
    return (note/12)-1;
}
 
const char* KeyName (signed char sharp_flats, unsigned char major_minor, bool uppercase = true,
                     bool space = false, bool use_Mm = true);
 
// unsigned char NoteNumber(const char*name);
 
 
 
const int MIDI_DEFAULT_TIMESIG_NUMERATOR = 4;       
const int MIDI_DEFAULT_TIMESIG_DENOMINATOR = 4;     
const double MIDI_DEFAULT_TEMPO = 120.0;            
const int MIDI_DEFAULT_KEYSIG_KEY = 0;              
const int MIDI_DEFAULT_KEYSIG_MODE = 0;             
 
 
#endif