tracktion_ClipOwner.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 ClipOwner
{
public:
    ClipOwner();
 
    virtual ~ClipOwner();
 
    virtual juce::ValueTree& getClipOwnerState() = 0;
 
    virtual EditItemID getClipOwnerID() = 0;
 
    virtual Selectable* getClipOwnerSelectable() = 0;
 
    virtual Edit& getClipOwnerEdit() = 0;
 
    const juce::Array<Clip*>& getClips() const;
 
protected:
    void initialiseClipOwner (Edit&, juce::ValueTree clipParentState);
 
    virtual void clipCreated (Clip&) = 0;
 
    virtual void clipAddedOrRemoved() = 0;
 
    virtual void clipOrderChanged() = 0;
 
    virtual void clipPositionChanged() = 0;
 
private:
    struct ClipList;
    std::unique_ptr<ClipList> clipList;
};
 
//==============================================================================
Clip* findClipForState (ClipOwner&, const juce::ValueTree&);
 
Clip* findClipForID (ClipOwner&, EditItemID);
 
 
//==============================================================================
//==============================================================================
enum class DeleteExistingClips
{
    no, /*<< Don't remove existing clips. */
    yes /*<< Replace existing clips with new ones. */
};
 
Clip* insertClipWithState (ClipOwner&, juce::ValueTree);
 
Clip* insertClipWithState (ClipOwner&,
                           const juce::ValueTree& stateToUse, const juce::String& name, TrackItem::Type,
                           ClipPosition, DeleteExistingClips, bool allowSpottingAdjustment);
 
//==============================================================================
Clip* insertNewClip (ClipOwner&, TrackItem::Type, EditTimeRange);
 
Clip* insertNewClip (ClipOwner&, TrackItem::Type, const juce::String& name, EditTimeRange);
 
Clip* insertNewClip (ClipOwner&, TrackItem::Type, const juce::String& name, ClipPosition);
 
//==============================================================================
juce::ReferenceCountedObjectPtr<WaveAudioClip> insertWaveClip (ClipOwner&, const juce::String& name, const juce::File& sourceFile,
                                                               ClipPosition, DeleteExistingClips);
 
juce::ReferenceCountedObjectPtr<WaveAudioClip> insertWaveClip (ClipOwner&, const juce::String& name, ProjectItemID sourceID,
                                                               ClipPosition, DeleteExistingClips);
 
juce::ReferenceCountedObjectPtr<MidiClip> insertMIDIClip (ClipOwner&, const juce::String& name, TimeRange);
 
juce::ReferenceCountedObjectPtr<MidiClip> insertMIDIClip (ClipOwner&, TimeRange);
 
juce::ReferenceCountedObjectPtr<EditClip> insertEditClip (ClipOwner&, TimeRange, ProjectItemID);
 
//==============================================================================
juce::Array<Clip*> deleteRegion (ClipOwner&, TimeRange);
 
juce::Array<Clip*> deleteRegion (Clip&, TimeRange);
 
juce::Array<Clip*> split (ClipOwner&, TimePosition);
 
Clip* split (Clip&, TimePosition);
 
[[ nodiscard ]] bool containsAnyMIDIClips (const ClipOwner&);
 
template<typename ClipType>
[[ nodiscard ]] juce::Array<ClipType*> getClipsOfType (const ClipOwner&);
 
template<typename ClipType>
[[ nodiscard ]] juce::Array<ClipType*> getClipsOfTypeRecursive (const ClipOwner&);
 
 
//==============================================================================
//==============================================================================
bool isMasterTrack (const Track&);
 
bool isTempoTrack (const Track&);
 
bool isAutomationTrack (const Track&);
 
bool isAudioTrack (const Track&);
 
bool isFolderTrack (const Track&);
 
bool isMarkerTrack (const Track&);
 
bool isChordTrack (const Track&);
 
bool isArrangerTrack (const Track&);
 
bool isAudioTrack (const ClipOwner&);
 
bool isFolderTrack (const ClipOwner&);
 
bool isMarkerTrack (const ClipOwner&);
 
bool isChordTrack (const ClipOwner&);
 
bool isArrangerTrack (const ClipOwner&);
 
//==============================================================================
bool canContainMIDI (const ClipOwner&);
 
bool canContainAudio (const ClipOwner&);
 
bool isMovable (const Track&);
 
bool isOnTop (const Track&);
 
//==============================================================================
//        _        _           _  _
//     __| |  ___ | |_   __ _ (_)| | ___
//    / _` | / _ \| __| / _` || || |/ __|
//   | (_| ||  __/| |_ | (_| || || |\__ \ _  _  _
//    \__,_| \___| \__| \__,_||_||_||___/(_)(_)(_)
//
//   Code beyond this point is implementation detail...
//
//==============================================================================
 
template<typename ClipType>
inline juce::Array<ClipType*> getClipsOfType (const ClipOwner& parent)
{
    juce::Array<ClipType*> clips;
 
    for (auto clip : parent.getClips())
        if (auto typedClip = dynamic_cast<ClipType*> (clip))
            clips.add (typedClip);
 
    return clips;
}
 
template<typename ClipType>
inline juce::Array<ClipType*> getClipsOfTypeRecursive (const ClipOwner& parent)
{
    juce::Array<ClipType*> results;
 
    results.addArray (getClipsOfType<ClipType> (parent));
 
    for (auto clip : parent.getClips())
        if (auto clipOwner = dynamic_cast<ClipOwner*> (clip))
            results.addArray (getClipsOfTypeRecursive<ClipType> (*clipOwner));
 
    return results;
}
 
}} // namespace tracktion { inline namespace engine