tracktion_Scene.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 SceneList;
 
//==============================================================================
class Scene : public Selectable,
              private juce::ValueTree::Listener
{
public:
    Scene (const juce::ValueTree&, SceneList&);
 
    ~Scene() override;
 
    int getIndex();
 
    juce::ValueTree state;
    Edit& edit;
 
    juce::CachedValue<juce::String> name;
    juce::CachedValue<juce::Colour> colour;
 
    SceneList& sceneList;
 
    juce::String getSelectableDescription() override;
 
private:
    void valueTreePropertyChanged (juce::ValueTree&, const juce::Identifier&) override;
};
 
//==============================================================================
//==============================================================================
class SceneWatcher : private juce::ValueTree::Listener,
                     private juce::Timer
{
public:
    SceneWatcher (const juce::ValueTree& scenesState, Edit&);
 
    struct Listener
    {
        virtual ~Listener() = default;
 
        virtual void slotUpdated (int audioTrackIndex, int slotIndex) = 0;
    };
 
    void addListener (Listener*);
 
    void removeListener (Listener*);
 
private:
    juce::ValueTree scenesState;
    Edit& edit;
    uint32_t callback = 0;
 
    enum class RecordingState
    {
        none,
        pending,
        recording,
    };
 
    struct Value
    {
        uint32_t lastSeen = 0;
        LaunchHandle::PlayState playState;
        std::optional<LaunchHandle::QueueState> queueState;
        RecordingState recordingState = RecordingState::none;
    };
 
    std::map<std::pair<int, int>, Value> lastStates;
 
    juce::ListenerList<Listener> listeners;
 
    void checkForScenes();
    RecordingState getRecordingState (ClipSlot& slot);
 
    void timerCallback() override;
 
    void valueTreeChildAdded (juce::ValueTree&, juce::ValueTree&) override;
    void valueTreeChildRemoved (juce::ValueTree&, juce::ValueTree&, int) override;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(SceneWatcher)
};
 
//==============================================================================
//==============================================================================
class SceneList : private ValueTreeObjectList<Scene>
{
public:
    SceneList (const juce::ValueTree&, Edit&);
 
    ~SceneList() override;
 
    int getNumScenes() { return size(); }
 
    juce::Array<Scene*> getScenes();
 
    //==============================================================================
    void ensureNumberOfScenes (int numScenes);
 
    Scene* insertScene (int index);
 
    void deleteScene (Scene&);
 
    juce::ValueTree state;  
    Edit& edit;             
    SceneWatcher sceneWatcher { state, edit };
 
private:
    //==============================================================================
    bool isSuitableType (const juce::ValueTree&) const override;
    Scene* createNewObject (const juce::ValueTree&) override;
    void deleteObject (Scene*) override;
 
    void newObjectAdded (Scene*) override;
    void objectRemoved (Scene*) override;
    void objectOrderChanged() override;
};
 
}} // namespace tracktion { inline namespace engine