tracktion_ClipTrack.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 ClipTrack   : public Track,
                    public ClipOwner
{
public:
    ClipTrack (Edit&, const juce::ValueTree&, bool hasModifierList);
    ~ClipTrack() override;
 
    using Ptr   = juce::ReferenceCountedObjectPtr<ClipTrack>;
 
    void initialise() override;
    void flushStateToValueTree() override;
 
    //==============================================================================
    Clip* findClipForID (EditItemID) const override;
 
    //==============================================================================
    CollectionClip* getCollectionClip (int index) const noexcept;
    CollectionClip* getCollectionClip (Clip*) const;
    int getNumCollectionClips() const noexcept;
    int indexOfCollectionClip (CollectionClip*) const;
    int getIndexOfNextCollectionClipAt (TimePosition);
    CollectionClip* getNextCollectionClipAt (TimePosition);
    bool contains (CollectionClip*) const;
    void addCollectionClip (CollectionClip*);
    void removeCollectionClip (CollectionClip*);
 
    //==============================================================================
    int getNumTrackItems() const override;
    TrackItem* getTrackItem (int idx) const override;
    int indexOfTrackItem (TrackItem*) const override;
    int getIndexOfNextTrackItemAt (TimePosition) override;
    TrackItem* getNextTrackItemAt (TimePosition) override;
 
    void insertSpaceIntoTrack (TimePosition, TimeDuration) override;
 
    //==============================================================================
    TimeDuration getLength() const;
    TimeDuration getLengthIncludingInputTracks() const;
    TimeRange getTotalRange() const;
 
    //==============================================================================
    bool addClip (const Clip::Ptr&);
 
    Clip* insertClipWithState (juce::ValueTree);
 
    Clip* insertClipWithState (const juce::ValueTree& stateToUse,
                               const juce::String& name, TrackItem::Type type,
                               ClipPosition position,
                               bool deleteExistingClips,
                               bool allowSpottingAdjustment);
 
    Clip* insertNewClip (TrackItem::Type, TimeRange position, SelectionManager* selectionManagerToSelectWith);
    Clip* insertNewClip (TrackItem::Type, const juce::String& name, TimeRange position, SelectionManager* selectionManagerToSelectWith);
    Clip* insertNewClip (TrackItem::Type, const juce::String& name, ClipPosition position, SelectionManager* selectionManagerToSelectWith);
 
    juce::ReferenceCountedObjectPtr<WaveAudioClip> insertWaveClip (const juce::String& name, const juce::File& sourceFile,
                                                                   ClipPosition position, bool deleteExistingClips);
 
    juce::ReferenceCountedObjectPtr<WaveAudioClip> insertWaveClip (const juce::String& name, ProjectItemID sourceID,
                                                                   ClipPosition position, bool deleteExistingClips);
 
    juce::ReferenceCountedObjectPtr<MidiClip> insertMIDIClip (TimeRange position,
                                                              SelectionManager* selectionManagerToSelectWith);
 
    juce::ReferenceCountedObjectPtr<MidiClip> insertMIDIClip (const juce::String& name, TimeRange position,
                                                              SelectionManager* selectionManagerToSelectWith);
 
    juce::ReferenceCountedObjectPtr<EditClip> insertEditClip (TimeRange position, ProjectItemID sourceID);
 
    void deleteRegion (TimeRange, SelectionManager*);
    void deleteRegionOfClip (Clip::Ptr, TimeRange, SelectionManager*);
 
    Clip* splitClip (Clip&, TimePosition);
 
    void splitAt (TimePosition);
 
    TimePosition getNextTimeOfInterest (TimePosition afterThisTime);
    TimePosition getPreviousTimeOfInterest (TimePosition beforeThisTime);
 
    bool containsPlugin (const Plugin*) const override;
    Plugin::Array getAllPlugins() const override;
    void sendMirrorUpdateToAllPlugins (Plugin&) const override;
 
    bool areAnyClipsUsingFile (const AudioFile&);
    bool containsAnyMIDIClips() const;
 
    juce::ValueTree& getClipOwnerState() override;
    EditItemID getClipOwnerID() override;
    Selectable* getClipOwnerSelectable() override;
    Edit& getClipOwnerEdit() override;
    void clipCreated (Clip&) override;
    void clipAddedOrRemoved() override;
    void clipOrderChanged() override;
    void clipPositionChanged() override;
 
protected:
    friend class Clip;
 
    juce::Array<TimePosition> findAllTimesOfInterest();
 
    struct CollectionClipList;
    friend struct CollectionClipList;
    std::unique_ptr<CollectionClipList> collectionClipList;
 
    void refreshTrackItems() const;
 
    mutable bool trackItemsDirty = false;
    mutable juce::Array<TrackItem*> trackItems;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ClipTrack)
};
 
}} // namespace tracktion { inline namespace engine