tracktion_EditSnapshot.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 EditSnapshot  : public juce::ReferenceCountedObject
{
public:
    //==============================================================================
    using Ptr = juce::ReferenceCountedObjectPtr<EditSnapshot>;
 
    static Ptr getEditSnapshot (Engine&, ProjectItemID);
 
    //==============================================================================
    struct Marker
    {
        juce::String name;
        juce::Colour colour;
        TimeRange time;
    };
 
    //==============================================================================
    ~EditSnapshot();
 
    ProjectItemID getID() const noexcept                { return itemID; }
 
    juce::File getFile() const                          { return sourceFile; }
 
    juce::ValueTree getState() noexcept                 { return state; }
 
    void setState (juce::ValueTree, TimeDuration editLength);
 
    bool isValid() const;
 
    void refreshFromProjectManager();
 
    void refreshCacheAndNotifyListeners();
 
    juce::ReferenceCountedArray<EditSnapshot> getNestedEditObjects();
 
    //==============================================================================
    // Set of cached properties of the last saved state
    juce::String getName() const                                        { return name; }
    int getNumTracks() const                                            { return numTracks; }
    int getNumAudioTracks() const                                       { return numAudioTracks; }
    int getIndexOfTrackID (EditItemID trackID) const                    { return trackIDs.indexOf (trackID); }
    juce::String getTrackName (int index) const                         { return trackNames[index]; }
    juce::String getTrackNameFromID (EditItemID trackID) const          { return trackNames[getIndexOfTrackID(trackID)]; }
    bool isAudioTrack (int trackIndex) const                            { return audioTracks[trackIndex]; }
    bool isTrackMuted (int trackIndex) const                            { return mutedTracks[trackIndex]; }
    bool isTrackSoloed (int trackIndex) const                           { return soloedTracks[trackIndex]; }
    bool isTrackSoloIsolated (int trackIndex) const                     { return soloIsolatedTracks[trackIndex]; }
    int audioToGlobalTrackIndex (int audioIndex) const;
 
    TimeDuration getLength() const                                       { return TimeDuration::fromSeconds (length); }
    TimePosition getMarkIn() const                                       { return TimePosition::fromSeconds (markIn); }
    TimePosition getMarkOut() const                                      { return TimePosition::fromSeconds (markOut); }
    bool areMarksActive() const                                          { return marksActive; }
 
    double getTempo() const                                             { return tempo; }
    int getTimeSigNumerator() const                                     { return timeSigNumerator; }
    int getTimeSigDenominator() const                                   { return timeSigDenominator; }
    int getPitch() const                                                { return pitch; }
 
    const juce::Array<Marker>& getMarkers() const                       { return markers; }
    const juce::Array<EditItemID>& getTracks() const                    { return trackIDs; }
    const juce::Array<ProjectItemID>& getEditClips() const              { return editClipIDs; }
    const juce::Array<ProjectItemID>& getClipsSourceIDs() const         { return clipSourceIDs; }
    HashCode getHash() const                                            { return lastSaveTime.toMilliseconds(); }
 
    //==============================================================================
    struct Listener
    {
        virtual ~Listener() = default;
        virtual void editChanged (EditSnapshot&) = 0;
    };
 
    void addListener (Listener* l)          { listeners.add (l); }
    void removeListener (Listener* l)       { listeners.remove (l); }
 
    Engine& engine;
 
private:
    //==============================================================================
    struct ListHolder;
    std::unique_ptr<ListHolder> listHolder;
 
    ProjectItemID itemID;
    juce::File sourceFile;
    juce::ValueTree state;
    juce::Time lastSaveTime;
 
    juce::String name;
    int numTracks, numAudioTracks;
    juce::StringArray trackNames;
    juce::BigInteger audioTracks, mutedTracks, soloedTracks, soloIsolatedTracks;
 
    juce::Array<EditItemID> trackIDs;
    juce::Array<ProjectItemID> editClipIDs, clipSourceIDs;
    double length = 0.0, markIn = 0.0, markOut = 0.0, tempo = 0.0;
    bool marksActive = false;
    int timeSigNumerator = 4, timeSigDenominator = 4, pitch = 60;
    juce::Array<Marker> markers;
 
    juce::ListenerList<Listener> listeners;
 
    //==============================================================================
    EditSnapshot (Engine&, ProjectItemID);
    void refreshFromProjectItem (ProjectItem::Ptr);
    void refreshFromXml (const juce::XmlElement&, const juce::String&, double newLength);
    void refreshFromState();
    void clear();
    void addEditClips (const juce::XmlElement& track);
    void addClipSources (const juce::XmlElement& track);
    void addMarkers (const juce::XmlElement& track);
    void addSubTracksRecursively (const juce::XmlElement& parent, int& audioTrackNameNumber);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (EditSnapshot)
};
 
}} // namespace tracktion { inline namespace engine