AAX_MIDIUtilities.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *  Copyright 2015, 2023-2024 Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  This file is part of the Avid AAX SDK.
 *  
 *  The AAX SDK is subject to commercial or open-source licensing.
 *  
 *  By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
 *  Agreement and Avid Privacy Policy.
 *  
 *  AAX SDK License: https://developer.avid.com/aax
 *  Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
 *  
 *  Or: You may also use this code under the terms of the GPL v3 (see
 *  www.gnu.org/licenses).
 *  
 *  THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
 *  EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
 *  DISCLAIMED.
 */
 
/*================================================================================================*/
#ifndef AAX_MIDIUtilities_h
#define AAX_MIDIUtilities_h
 
// AAX Includes
#include "AAX.h"
 
namespace AAX
{
    //
    // Some MIDI defines
    //
    
    enum EStatusNibble
    {
         eStatusNibble_NoteOff = 0x80
        ,eStatusNibble_NoteOn = 0x90
        ,eStatusNibble_KeyPressure = 0xA0
        ,eStatusNibble_ControlChange = 0xB0
        ,eStatusNibble_ChannelMode = 0xB0
        ,eStatusNibble_ProgramChange = 0xC0
        ,eStatusNibble_ChannelPressure = 0xD0
        ,eStatusNibble_PitchBend = 0xE0
        ,eStatusNibble_SystemCommon = 0xF0
        ,eStatusNibble_SystemRealTime = 0xF0
    };
    
    enum EStatusByte
    {
         eStatusByte_SysExBegin = 0xF0
        ,eStatusByte_MTCQuarterFrame = 0xF1
        ,eStatusByte_SongPosition = 0xF2
        ,eStatusByte_SongSelect = 0xF3
        ,eStatusByte_TuneRequest = 0xF6
        ,eStatusByte_SysExEnd = 0xF7
        ,eStatusByte_TimingClock = 0xF8
        ,eStatusByte_Start = 0xFA
        ,eStatusByte_Continue = 0xFB
        ,eStatusByte_Stop = 0xFC
        ,eStatusByte_ActiveSensing = 0xFE
        ,eStatusByte_Reset = 0xFF
    };
    
    enum EChannelModeData
    {
         eChannelModeData_AllSoundOff = 120
        ,eChannelModeData_ResetControllers = 121
        ,eChannelModeData_LocalControl = 122
        ,eChannelModeData_AllNotesOff = 123
        ,eChannelModeData_OmniOff = 124
        ,eChannelModeData_OmniOn = 125
        ,eChannelModeData_PolyOff = 126
        ,eChannelModeData_PolyOn = 127
    };
    
    enum ESpecialData
    {
         eSpecialData_AccentedClick = 0x00 
        ,eSpecialData_UnaccentedClick = 0x01 
    };
    
    
    //
    // Basic MIDI utility functions
    //
    
    inline bool IsNoteOn(const AAX_CMidiPacket* inPacket)
    {
        if (!inPacket) { return false; }
        const uint8_t sn = (inPacket->mData[0] & 0xF0); // status nibble
        const uint8_t data2 = inPacket->mData[2];
        return ((eStatusNibble_NoteOn == sn) &&
                (0x00 != data2));
    }
    
    inline bool IsNoteOff(const AAX_CMidiPacket* inPacket)
    {
        if (!inPacket) { return false; }
        const uint8_t sn = (inPacket->mData[0] & 0xF0); // status nibble
        const uint8_t data2 = inPacket->mData[2];
        return ((eStatusNibble_NoteOff == sn) || ((eStatusNibble_NoteOn == sn) && (0x00 == data2)));
    }
    
    inline bool IsAllNotesOff(const AAX_CMidiPacket* inPacket)
    {
        if (!inPacket) { return false; }
        const uint8_t sn = (inPacket->mData[0] & 0xF0); // status nibble
        const uint8_t data1 = inPacket->mData[1];
        const uint8_t data2 = inPacket->mData[2];
        if (eStatusNibble_ChannelMode == sn)
        {
            if (eChannelModeData_PolyOff == data1)
            {
                return true;
            }
            else if ((eChannelModeData_AllSoundOff == data1) ||
                     (eChannelModeData_AllNotesOff == data1) ||
                     (eChannelModeData_OmniOff == data1) ||
                     (eChannelModeData_OmniOn == data1) ||
                     (eChannelModeData_PolyOn == data1))
            {
                return (0x00 == data2);
            }
        }
        
        return false;
    }
    
    inline bool IsAccentedClick(const AAX_CMidiPacket* inPacket)
    {
        return ((inPacket) &&
                (eStatusNibble_NoteOn == (inPacket->mData[0] & 0xF0)) &&
                (0x00 == (inPacket->mData[0] & 0x0F)) &&
                (eSpecialData_AccentedClick == inPacket->mData[1]));
    }
    
    inline bool IsUnaccentedClick(const AAX_CMidiPacket* inPacket)
    {
        return ((inPacket) &&
                (eStatusNibble_NoteOn == (inPacket->mData[0] & 0xF0)) &&
                (0x00 == (inPacket->mData[0] & 0x0F)) &&
                (eSpecialData_UnaccentedClick == inPacket->mData[1]));
    }
    
    inline bool IsClick(const AAX_CMidiPacket* inPacket)
    {
        return (IsAccentedClick(inPacket) || IsUnaccentedClick(inPacket));
    }
} // namespace AAX
 
#endif // AAX_MIDIUtilities_h