tracktion_MidiLearn.h

Go to the documentation of this file.

 /*
    ,--.                     ,--.     ,--.  ,--.
  ,-'  '-.,--.--.,--,--.,---.|  |,-.,-'  '-.`--' ,---. ,--,--,      Copyright 2024
  '-.  .-'|  .--' ,-.  | .--'|     /'-.  .-',--.| .-. ||      \   Tracktion Software
    |  |  |  |  \ '-'  \ `--.|  \  \  |  |  |  |' '-' '|  ||  |       Corporation
    `---' `--'   `--`--'`---'`--'`--' `---' `--' `---' `--''--'    www.tracktion.com
 
    Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
*/
 
namespace tracktion { inline namespace engine
{
 
class MidiLearnState
{
public:
    MidiLearnState (Engine&);
    ~MidiLearnState();
 
    void setActive (bool shouldBeActive);
    bool isActive()                             { return learnActive; }
 
    enum ChangeType
    {
        added,
        removed
    };
 
    void assignmentChanged (ChangeType t);
 
    struct ScopedChangeCaller
    {
        ScopedChangeCaller (MidiLearnState&, ChangeType);
        ~ScopedChangeCaller();
 
        MidiLearnState& state;
        ChangeType type;
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ScopedChangeCaller)
    };
 
    //==============================================================================
    struct Listener
    {
        Listener (MidiLearnState&);
        virtual ~Listener();
 
        virtual void midiLearnStatusChanged (bool isActive) = 0;
        virtual void midiLearnAssignmentChanged (ChangeType) {}
 
        MidiLearnState& ownerState;
    };
 
    Engine& engine;
 
private:
    juce::ListenerList<Listener> listeners;
    bool learnActive = false;
 
    void addListener (Listener* l)      { listeners.add (l); }
    void removeListener (Listener* l)   { listeners.remove (l); }
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (MidiLearnState)
};
 
//==============================================================================
class MidiAssignable
{
public:
    //==============================================================================
    struct Assignment
    {
        Assignment() : id (CustomControlSurface::none) {}
        Assignment (juce::String n, CustomControlSurface::ActionID i) : name (n), id (i) {}
 
        juce::String name;
        CustomControlSurface::ActionID id;
    };
 
    //==============================================================================
    MidiAssignable (Engine&);
    virtual ~MidiAssignable() {}
 
    void addAssignent (Assignment);
 
    juce::Array<Assignment>& getAssignments()       { return assignemnts; }
 
    bool isSingleAssignment() const noexcept        { return assignemnts.size() == 1; }
 
    void buildMenu (juce::PopupMenu&);
 
    void handleMenuResult (int menuResult);
 
    int getFaderIndex();
 
    //==============================================================================
    virtual bool isAssignable() = 0;
 
    virtual juce::String getDescription() = 0;
 
    virtual Track::Ptr getControlledTrack()            { return {}; }
 
    Engine& engine;
 
private:
    juce::Array<Assignment> assignemnts;
};
 
}} // namespace tracktion { inline namespace engine