tracktion_TrackItem.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 TrackItem   : public EditItem,
                    public Selectable,
                    public juce::ReferenceCountedObject
{
public:
    enum class Type
    {
        unknown,    
        wave,       
        midi,       
        edit,       
        step,       
        marker,     
        pitch,      
        timeSig,    
        collection, 
        video,      
        recording,  
        chord,      
        arranger,   
        container   
    };
 
    TrackItem (Edit&, EditItemID, Type);
 
    ~TrackItem();
 
    //==============================================================================
    static const char* typeToString (Type);
 
    static juce::Identifier clipTypeToXMLType (Type);
 
    static TrackItem::Type xmlTagToType (juce::StringRef);
 
    static TrackItem::Type stringToType (const juce::String&);
 
    static juce::String getSuggestedNameForNewItem (Type);
 
    //==============================================================================
    virtual Track* getTrack() const = 0;
 
    virtual bool isGrouped() const                      { return false; }
 
    virtual TrackItem* getGroupParent() const           { return {}; }
 
    //==============================================================================
    virtual ClipPosition getPosition() const = 0;
 
    TimeRange getEditTimeRange() const                  { return getPosition().time; }
 
    BeatRange getEditBeatRange() const;
 
    BeatPosition getStartBeat() const;
 
    BeatPosition getContentStartBeat() const;
 
    BeatPosition getEndBeat() const;
 
    BeatDuration getLengthInBeats() const;
 
    TimePosition getTimeOfRelativeBeat (BeatDuration) const;
 
    BeatPosition getBeatOfRelativeTime (TimeDuration) const;
 
    BeatDuration getOffsetInBeats() const;
 
    //==============================================================================
    EditItemID getTrackID() const;
 
    const Type type; 
    //==============================================================================
    template <typename ArrayType>
    static void sortByTime (ArrayType& items)
    {
        std::sort (items.begin(), items.end(),
                   [] (const TrackItem* a, const TrackItem* b) { return a->getPosition().time.getStart() < b->getPosition().time.getStart(); });
    }
 
    template <typename ArrayType>
    static void stableSortByTime (ArrayType& items)
    {
        std::stable_sort (items.begin(), items.end(),
                          [] (const TrackItem* a, const TrackItem* b) { return a->getPosition().time.getStart() < b->getPosition().time.getStart(); });
    }
 
private:
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TrackItem)
};
 
 
}} // namespace tracktion { inline namespace engine