source/includes/CarlaMIDI.h

   1 /*
   2  * Carla common MIDI code
   3  * Copyright (C) 2012-2014 Filipe Coelho <falktx@falktx.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of
   8  * the License, or any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16  */
  17
  18 #ifndef CARLA_MIDI_H_INCLUDED
  19 #define CARLA_MIDI_H_INCLUDED
  20
  21 #define MAX_MIDI_CHANNELS 16
  22 #define MAX_MIDI_NOTE     128
  23 #define MAX_MIDI_VALUE    128
  24 #define MAX_MIDI_CONTROL  120 /* 0x77 + 1 */
  25
  26 #define MIDI_STATUS_BIT  0xF0
  27 #define MIDI_CHANNEL_BIT 0x0F
  28
  29 /** MIDI Messages List */
  30 #define MIDI_STATUS_NOTE_OFF                           0x80 /* note (0-127), velocity (0-127)     */
  31 #define MIDI_STATUS_NOTE_ON                            0x90 /* note (0-127), velocity (0-127)     */
  32 #define MIDI_STATUS_POLYPHONIC_AFTERTOUCH              0xA0 /* note (0-127), pressure (0-127)     */
  33 #define MIDI_STATUS_CONTROL_CHANGE                     0xB0 /* see 'Control Change Messages List' */
  34 #define MIDI_STATUS_PROGRAM_CHANGE                     0xC0 /* program (0-127), none              */
  35 #define MIDI_STATUS_CHANNEL_PRESSURE                   0xD0 /* pressure (0-127), none             */
  36 #define MIDI_STATUS_PITCH_WHEEL_CONTROL                0xE0 /* LSB (0-127), MSB (0-127)           */
  37
  38 /** MIDI Message type */
  39 #define MIDI_IS_CHANNEL_MESSAGE(status) ((status) >= MIDI_STATUS_NOTE_OFF && (status) <  MIDI_STATUS_BIT)
  40 #define MIDI_IS_SYSTEM_MESSAGE(status)  ((status) >= MIDI_STATUS_BIT      && (status) <= 0xFF)
  41 #define MIDI_IS_OSC_MESSAGE(status)     ((status) == '/'                  || (status) == '#')
  42
  43 /** MIDI Channel message type */
  44 #define MIDI_IS_STATUS_NOTE_OFF(status)                (MIDI_IS_CHANNEL_MESSAGE(status) && ((status) & MIDI_STATUS_BIT) == MIDI_STATUS_NOTE_OFF)
  45 #define MIDI_IS_STATUS_NOTE_ON(status)                 (MIDI_IS_CHANNEL_MESSAGE(status) && ((status) & MIDI_STATUS_BIT) == MIDI_STATUS_NOTE_ON)
  46 #define MIDI_IS_STATUS_POLYPHONIC_AFTERTOUCH(status)   (MIDI_IS_CHANNEL_MESSAGE(status) && ((status) & MIDI_STATUS_BIT) == MIDI_STATUS_POLYPHONIC_AFTERTOUCH)
  47 #define MIDI_IS_STATUS_CONTROL_CHANGE(status)          (MIDI_IS_CHANNEL_MESSAGE(status) && ((status) & MIDI_STATUS_BIT) == MIDI_STATUS_CONTROL_CHANGE)
  48 #define MIDI_IS_STATUS_PROGRAM_CHANGE(status)          (MIDI_IS_CHANNEL_MESSAGE(status) && ((status) & MIDI_STATUS_BIT) == MIDI_STATUS_PROGRAM_CHANGE)
  49 #define MIDI_IS_STATUS_CHANNEL_PRESSURE(status)        (MIDI_IS_CHANNEL_MESSAGE(status) && ((status) & MIDI_STATUS_BIT) == MIDI_STATUS_CHANNEL_PRESSURE)
  50 #define MIDI_IS_STATUS_PITCH_WHEEL_CONTROL(status)     (MIDI_IS_CHANNEL_MESSAGE(status) && ((status) & MIDI_STATUS_BIT) == MIDI_STATUS_PITCH_WHEEL_CONTROL)
  51
  52 /** MIDI Utils */
  53 #define MIDI_GET_STATUS_FROM_DATA(data)                (MIDI_IS_CHANNEL_MESSAGE(data[0]) ? data[0] & MIDI_STATUS_BIT  : data[0])
  54 #define MIDI_GET_CHANNEL_FROM_DATA(data)               (MIDI_IS_CHANNEL_MESSAGE(data[0]) ? data[0] & MIDI_CHANNEL_BIT : 0)
  55
  56 /** Control Change Messages List */
  57 #define MIDI_CONTROL_BANK_SELECT                       0x00 /* 0-127, MSB                 */
  58 #define MIDI_CONTROL_MODULATION_WHEEL                  0x01 /* 0-127, MSB                 */
  59 #define MIDI_CONTROL_BREATH_CONTROLLER                 0x02 /* 0-127, MSB                 */
  60 #define MIDI_CONTROL_FOOT_CONTROLLER                   0x04 /* 0-127, MSB                 */
  61 #define MIDI_CONTROL_PORTAMENTO_TIME                   0x05 /* 0-127, MSB                 */
  62 #define MIDI_CONTROL_DATA_ENTRY                        0x06 /* 0-127, MSB                 */
  63 #define MIDI_CONTROL_CHANNEL_VOLUME                    0x07 /* 0-127, MSB                 */
  64 #define MIDI_CONTROL_BALANCE                           0x08 /* 0-127, MSB                 */
  65 #define MIDI_CONTROL_PAN                               0x0A /* 0-127, MSB                 */
  66 #define MIDI_CONTROL_EXPRESSION_CONTROLLER             0x0B /* 0-127, MSB                 */
  67 #define MIDI_CONTROL_EFFECT_CONTROL_1                  0x0C /* 0-127, MSB                 */
  68 #define MIDI_CONTROL_EFFECT_CONTROL_2                  0x0D /* 0-127, MSB                 */
  69 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_1      0x10 /* 0-127, MSB                 */
  70 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_2      0x11 /* 0-127, MSB                 */
  71 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_3      0x12 /* 0-127, MSB                 */
  72 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_4      0x13 /* 0-127, MSB                 */
  73 #define MIDI_CONTROL_BANK_SELECT__LSB                  0x20 /* 0-127, LSB                 */
  74 #define MIDI_CONTROL_MODULATION_WHEEL__LSB             0x21 /* 0-127, LSB                 */
  75 #define MIDI_CONTROL_BREATH_CONTROLLER__LSB            0x22 /* 0-127, LSB                 */
  76 #define MIDI_CONTROL_FOOT_CONTROLLER__LSB              0x24 /* 0-127, LSB                 */
  77 #define MIDI_CONTROL_PORTAMENTO_TIME__LSB              0x25 /* 0-127, LSB                 */
  78 #define MIDI_CONTROL_DATA_ENTRY__LSB                   0x26 /* 0-127, LSB                 */
  79 #define MIDI_CONTROL_CHANNEL_VOLUME__LSB               0x27 /* 0-127, LSB                 */
  80 #define MIDI_CONTROL_BALANCE__LSB                      0x28 /* 0-127, LSB                 */
  81 #define MIDI_CONTROL_PAN__LSB                          0x2A /* 0-127, LSB                 */
  82 #define MIDI_CONTROL_EXPRESSION_CONTROLLER__LSB        0x2B /* 0-127, LSB                 */
  83 #define MIDI_CONTROL_EFFECT_CONTROL_1__LSB             0x2C /* 0-127, LSB                 */
  84 #define MIDI_CONTROL_EFFECT_CONTROL_2__LSB             0x3D /* 0-127, LSB                 */
  85 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_1__LSB 0x30 /* 0-127, LSB                 */
  86 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_2__LSB 0x31 /* 0-127, LSB                 */
  87 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_3__LSB 0x32 /* 0-127, LSB                 */
  88 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_4__LSB 0x33 /* 0-127, LSB                 */
  89 #define MIDI_CONTROL_DAMPER_PEDAL                      0x40 /* <= 63 off, >= 64 off       */
  90 #define MIDI_CONTROL_PORTAMENTO                        0x41 /* <= 63 off, >= 64 off       */
  91 #define MIDI_CONTROL_SOSTENUDO                         0x42 /* <= 63 off, >= 64 off       */
  92 #define MIDI_CONTROL_SOFT_PEDAL                        0x43 /* <= 63 off, >= 64 off       */
  93 #define MIDI_CONTROL_LEGAL_FOOTSWITCH                  0x44 /* <= 63 normal, >= 64 legato */
  94 #define MIDI_CONTROL_HOLD_2                            0x45 /* <= 63 off, >= 64 off       */
  95 #define MIDI_CONTROL_SOUND_CONTROLLER_1                0x46 /* 0-127, LSB                 */
  96 #define MIDI_CONTROL_SOUND_CONTROLLER_2                0x47 /* 0-127, LSB                 */
  97 #define MIDI_CONTROL_SOUND_CONTROLLER_3                0x48 /* 0-127, LSB                 */
  98 #define MIDI_CONTROL_SOUND_CONTROLLER_4                0x49 /* 0-127, LSB                 */
  99 #define MIDI_CONTROL_SOUND_CONTROLLER_5                0x4A /* 0-127, LSB                 */
 100 #define MIDI_CONTROL_SOUND_CONTROLLER_6                0x4B /* 0-127, LSB                 */
 101 #define MIDI_CONTROL_SOUND_CONTROLLER_7                0x4C /* 0-127, LSB                 */
 102 #define MIDI_CONTROL_SOUND_CONTROLLER_8                0x4D /* 0-127, LSB                 */
 103 #define MIDI_CONTROL_SOUND_CONTROLLER_9                0x4E /* 0-127, LSB                 */
 104 #define MIDI_CONTROL_SOUND_CONTROLLER_10               0x4F /* 0-127, LSB                 */
 105 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_5      0x50 /* 0-127, LSB                 */
 106 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_6      0x51 /* 0-127, LSB                 */
 107 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_7      0x52 /* 0-127, LSB                 */
 108 #define MIDI_CONTROL_GENERAL_PURPOSE_CONTROLLER_8      0x53 /* 0-127, LSB                 */
 109 #define MIDI_CONTROL_PORTAMENTO_CONTROL                0x54 /* 0-127, LSB                 */
 110 #define MIDI_CONTROL_HIGH_RESOLUTION_VELOCITY_PREFIX   0x58 /* 0-127, LSB                 */
 111 #define MIDI_CONTROL_EFFECTS_1_DEPTH                   0x5B /* 0-127                      */
 112 #define MIDI_CONTROL_EFFECTS_2_DEPTH                   0x5C /* 0-127                      */
 113 #define MIDI_CONTROL_EFFECTS_3_DEPTH                   0x5D /* 0-127                      */
 114 #define MIDI_CONTROL_EFFECTS_4_DEPTH                   0x5E /* 0-127                      */
 115 #define MIDI_CONTROL_EFFECTS_5_DEPTH                   0x5F /* 0-127                      */
 116
 117 #define MIDI_CONTROL_ALL_SOUND_OFF                     0x78 /* 0                               */
 118 #define MIDI_CONTROL_RESET_ALL_CONTROLLERS             0x79 /* 0                               */
 119 #define MIDI_CONTROL_LOCAL_CONTROL                     0x7A /* 0 off, 127 on                   */
 120 #define MIDI_CONTROL_ALL_NOTES_OFF                     0x7B /* 0                               */
 121 #define MIDI_CONTROL_OMNI_MODE_OFF                     0x7C /* 0 (+ all notes off)             */
 122 #define MIDI_CONTROL_OMNI_MODE_ON                      0x7D /* 0 (+ all notes off)             */
 123 #define MIDI_CONTROL_MONO_MODE_ON                      0x7E /* ...                             */
 124 #define MIDI_CONTROL_POLY_MODE_ON                      0x7F /* 0 (+ mono off, + all notes off) */
 125
 126 #define MIDI_CONTROL_SOUND_VARIATION                   MIDI_CONTROL_SOUND_CONTROLLER_1
 127 #define MIDI_CONTROL_TIMBRE                            MIDI_CONTROL_SOUND_CONTROLLER_2
 128 #define MIDI_CONTROL_RELEASE_TIME                      MIDI_CONTROL_SOUND_CONTROLLER_3
 129 #define MIDI_CONTROL_ATTACK_TIME                       MIDI_CONTROL_SOUND_CONTROLLER_4
 130 #define MIDI_CONTROL_BRIGHTNESS                        MIDI_CONTROL_SOUND_CONTROLLER_5
 131 #define MIDI_CONTROL_DECAY_TIME                        MIDI_CONTROL_SOUND_CONTROLLER_6
 132 #define MIDI_CONTROL_VIBRATO_RATE                      MIDI_CONTROL_SOUND_CONTROLLER_7
 133 #define MIDI_CONTROL_VIBRATO_DEPTH                     MIDI_CONTROL_SOUND_CONTROLLER_8
 134 #define MIDI_CONTROL_VIBRATO_DELAY                     MIDI_CONTROL_SOUND_CONTROLLER_9
 135 #define MIDI_CONTROL_REVERB_SEND_LEVEL                 MIDI_CONTROL_EFFECTS_1_DEPTH
 136 #define MIDI_CONTROL_TREMOLO_DEPTH                     MIDI_CONTROL_EFFECTS_2_DEPTH
 137 #define MIDI_CONTROL_CHORUS_SEND_LEVEL                 MIDI_CONTROL_EFFECTS_3_DEPTH
 138 #define MIDI_CONTROL_DETUNE_DEPTH                      MIDI_CONTROL_EFFECTS_4_DEPTH
 139 #define MIDI_CONTROL_PHASER_DEPTH                      MIDI_CONTROL_EFFECTS_5_DEPTH
 140
 141 #define MIDI_IS_CONTROL_BANK_SELECT(control)           ((control) == MIDI_CONTROL_BANK_SELECT           || (control) == MIDI_CONTROL_BANK_SELECT__LSB)
 142 #define MIDI_IS_CONTROL_MODULATION_WHEEL(control)      ((control) == MIDI_CONTROL_MODULATION_WHEEL      || (control) == MIDI_CONTROL_MODULATION_WHEEL__LSB)
 143 #define MIDI_IS_CONTROL_BREATH_CONTROLLER(control)     ((control) == MIDI_CONTROL_BREATH_CONTROLLER     || (control) == MIDI_CONTROL_BREATH_CONTROLLER__LSB)
 144 #define MIDI_IS_CONTROL_FOOT_CONTROLLER(control)       ((control) == MIDI_CONTROL_FOOT_CONTROLLER       || (control) == MIDI_CONTROL_FOOT_CONTROLLER__LSB)
 145 #define MIDI_IS_CONTROL_PORTAMENTO_TIME(control)       ((control) == MIDI_CONTROL_PORTAMENTO_TIME       || (control) == MIDI_CONTROL_PORTAMENTO_TIME__LSB)
 146 #define MIDI_IS_CONTROL_DATA_ENTRY(control)            ((control) == MIDI_CONTROL_DATA_ENTRY            || (control) == MIDI_CONTROL_DATA_ENTRY__LSB)
 147 #define MIDI_IS_CONTROL_CHANNEL_VOLUME(control)        ((control) == MIDI_CONTROL_CHANNEL_VOLUME        || (control) == MIDI_CONTROL_CHANNEL_VOLUME__LSB)
 148 #define MIDI_IS_CONTROL_BALANCE(control)               ((control) == MIDI_CONTROL_BALANCE               || (control) == MIDI_CONTROL_BALANCE__LSB)
 149 #define MIDI_IS_CONTROL_PAN(control)                   ((control) == MIDI_CONTROL_PAN                   || (control) == MIDI_CONTROL_PAN__LSB)
 150 #define MIDI_IS_CONTROL_EXPRESSION_CONTROLLER(control) ((control) == MIDI_CONTROL_EXPRESSION_CONTROLLER || (control) == MIDI_CONTROL_EXPRESSION_CONTROLLER__LSB)
 151 #define MIDI_IS_CONTROL_EFFECT_CONTROL_1(control)      ((control) == MIDI_CONTROL_EFFECT_CONTROL_1      || (control) == MIDI_CONTROL_EFFECT_CONTROL_1__LSB)
 152 #define MIDI_IS_CONTROL_EFFECT_CONTROL_2(control)      ((control) == MIDI_CONTROL_EFFECT_CONTROL_2      || (control) == MIDI_CONTROL_EFFECT_CONTROL_2__LSB)
 153
 154 #endif /* CARLA_MIDI_H_INCLUDED */