juce_MPENote.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license. Permission
   To use, copy, modify, and/or distribute this software for any purpose with or
   without fee is hereby granted provided that the above copyright notice and
   this permission notice appear in all copies.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
struct JUCE_API  MPENote
{
    //==============================================================================
    enum KeyState
    {
        off                  = 0, 
        keyDown              = 1, 
        sustained            = 2, 
        keyDownAndSustained  = 3  
    };
 
    //==============================================================================
    MPENote (int midiChannel,
             int initialNote,
             MPEValue velocity,
             MPEValue pitchbend,
             MPEValue pressure,
             MPEValue timbre,
             KeyState keyState = MPENote::keyDown) noexcept;

    MPENote() noexcept;

    bool isValid() const noexcept;
 
    //==============================================================================
    // Invariants that define the note.

    uint16 noteID = 0;

    uint8 midiChannel = 0;

    uint8 initialNote = 0;
 
    //==============================================================================
    // The five dimensions of continuous expressive control

    MPEValue noteOnVelocity  { MPEValue::minValue() };

    MPEValue pitchbend       { MPEValue::centreValue() };

    MPEValue pressure        { MPEValue::centreValue() };

    MPEValue initialTimbre   { MPEValue::centreValue() };

    MPEValue timbre          { MPEValue::centreValue() };

    MPEValue noteOffVelocity { MPEValue::minValue() };
 
    //==============================================================================
    double totalPitchbendInSemitones;

    KeyState keyState        { MPENote::off };
 
    //==============================================================================
    double getFrequencyInHertz (double frequencyOfA = 440.0) const noexcept;

    bool operator== (const MPENote& other) const noexcept;

    bool operator!= (const MPENote& other) const noexcept;
};
 
} // namespace juce