juce_MidiKeyboardComponent.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.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   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
{
 
//==============================================================================
class JUCE_API  MidiKeyboardComponent  : public KeyboardComponentBase,
                                         private MidiKeyboardState::Listener,
                                         private Timer
{
public:
    //==============================================================================
    MidiKeyboardComponent (MidiKeyboardState& state, Orientation orientation);
 
    ~MidiKeyboardComponent() override;
 
    //==============================================================================
    void setVelocity (float velocity, bool useMousePositionForVelocity);
 
    //==============================================================================
    void setMidiChannel (int midiChannelNumber);
 
    int getMidiChannel() const noexcept            { return midiChannel; }
 
    void setMidiChannelsToDisplay (int midiChannelMask);
 
    int getMidiChannelsToDisplay() const noexcept  { return midiInChannelMask; }
 
    //==============================================================================
    void clearKeyMappings();
 
    void setKeyPressForNote (const KeyPress& key, int midiNoteOffsetFromC);
 
    void removeKeyPressForNote (int midiNoteOffsetFromC);
 
    void setKeyPressBaseOctave (int newOctaveNumber);
 
    //==============================================================================
    enum ColourIds
    {
        whiteNoteColourId               = 0x1005000,
        blackNoteColourId               = 0x1005001,
        keySeparatorLineColourId        = 0x1005002,
        mouseOverKeyOverlayColourId     = 0x1005003,  
        keyDownOverlayColourId          = 0x1005004,  
        textLabelColourId               = 0x1005005,
        shadowColourId                  = 0x1005006
    };
 
    //==============================================================================
    virtual void drawWhiteNote (int midiNoteNumber, Graphics& g, Rectangle<float> area,
                                bool isDown, bool isOver, Colour lineColour, Colour textColour);
 
    virtual void drawBlackNote (int midiNoteNumber, Graphics& g, Rectangle<float> area,
                                bool isDown, bool isOver, Colour noteFillColour);
 
    virtual bool mouseDownOnKey (int midiNoteNumber, const MouseEvent& e);
 
    virtual bool mouseDraggedToKey (int midiNoteNumber, const MouseEvent& e);
 
    virtual void mouseUpOnKey (int midiNoteNumber, const MouseEvent& e);
 
    virtual String getWhiteNoteText (int midiNoteNumber);
 
    //==============================================================================
    void mouseMove (const MouseEvent&) override;
    void mouseDrag (const MouseEvent&) override;
    void mouseDown (const MouseEvent&) override;
    void mouseUp (const MouseEvent&) override;
    void mouseEnter (const MouseEvent&) override;
    void mouseExit (const MouseEvent&) override;
    void timerCallback() override;
    bool keyStateChanged (bool isKeyDown) override;
    bool keyPressed (const KeyPress&) override;
    void focusLost (FocusChangeType) override;
    void colourChanged() override;
 
private:
    //==============================================================================
    void drawKeyboardBackground (Graphics& g, Rectangle<float> area) override final;
    void drawWhiteKey (int midiNoteNumber, Graphics& g, Rectangle<float> area) override final;
    void drawBlackKey (int midiNoteNumber, Graphics& g, Rectangle<float> area) override final;
 
    void handleNoteOn  (MidiKeyboardState*, int, int, float) override;
    void handleNoteOff (MidiKeyboardState*, int, int, float) override;
 
    //==============================================================================
    void resetAnyKeysInUse();
    void updateNoteUnderMouse (Point<float>, bool isDown, int fingerNum);
    void updateNoteUnderMouse (const MouseEvent&, bool isDown);
    void repaintNote (int midiNoteNumber);
 
    //==============================================================================
    MidiKeyboardState& state;
    int midiChannel = 1, midiInChannelMask = 0xffff;
    int keyMappingOctave = 6;
 
    float velocity = 1.0f;
    bool useMousePositionForVelocity = true;
 
    Array<int> mouseOverNotes, mouseDownNotes;
    Array<KeyPress> keyPresses;
    Array<int> keyPressNotes;
    BigInteger keysPressed, keysCurrentlyDrawnDown;
 
    std::atomic<bool> noPendingUpdates { true };
 
    //==============================================================================
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (MidiKeyboardComponent)
};
 
} // namespace juce