tracktion_TempoSequence.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
{
 
//==============================================================================
//==============================================================================
tempo::Sequence::Position createPosition (const TempoSequence&);
 
 
//==============================================================================
//==============================================================================
class TempoSequence  : public Selectable,
                       private juce::AsyncUpdater
{
public:
    //==============================================================================
    TempoSequence (Edit&);
 
    ~TempoSequence() override;
 
    Edit& getEdit() const                           { return edit; }
 
    const juce::ValueTree& getState() const         { return state; }
 
    void setState (const juce::ValueTree&, bool remapEdit);
 
    void createEmptyState();
 
    void copyFrom (const TempoSequence&);
 
    //==============================================================================
    const juce::Array<TimeSigSetting*>& getTimeSigs() const;
 
    int getNumTimeSigs() const;
 
    TimeSigSetting* getTimeSig (int index) const;
 
    TimeSigSetting& getTimeSigAt (TimePosition) const;
 
    TimeSigSetting& getTimeSigAt (BeatPosition) const;
 
    int indexOfTimeSigAt (TimePosition) const;
 
    int indexOfTimeSig (const TimeSigSetting*) const;
 
    //==============================================================================
    const juce::Array<TempoSetting*>& getTempos() const;
 
    int getNumTempos() const;
 
    TempoSetting* getTempo (int index) const;
 
    TempoSetting& getTempoAt (TimePosition) const;
 
    TempoSetting& getTempoAt (BeatPosition) const;
 
    double getBpmAt (TimePosition) const; // takes ramping into account
 
    double getBeatsPerSecondAt (TimePosition, bool lengthOfOneBeatDependsOnTimeSignature = false) const;
 
    bool isTripletsAtTime (TimePosition) const;
 
    int indexOfTempoAt (TimePosition) const;
 
    int indexOfNextTempoAt (TimePosition) const;
 
    int indexOfTempo (const TempoSetting*) const;
 
    int countTemposInRegion (TimeRange) const;
 
    //==============================================================================
    TempoSetting::Ptr insertTempo (TimePosition);
 
    TempoSetting::Ptr insertTempo (BeatPosition, double bpm, float curve);
 
    TimeSigSetting::Ptr insertTimeSig (TimePosition);
 
    TimeSigSetting::Ptr insertTimeSig (BeatPosition);
 
    void removeTempo (int index, bool remapEdit);
 
    void removeTemposBetween (TimeRange, bool remapEdit);
 
    void removeTimeSig (int index);
 
    void removeTimeSigsBetween (TimeRange);
 
    void moveTempoStart (int index, BeatDuration deltaBeats, bool snapToBeat);
 
    void moveTimeSigStart (int index, BeatDuration deltaBeats, bool snapToBeat);
 
    void insertSpaceIntoSequence (TimePosition time, TimeDuration amountOfSpaceInSeconds, bool snapToBeat);
 
    void deleteRegion (TimeRange);
 
    //==============================================================================
    BeatPosition toBeats (TimePosition) const;
 
    BeatRange toBeats (TimeRange) const;
 
    BeatPosition toBeats (tempo::BarsAndBeats) const;
 
    TimePosition toTime (BeatPosition) const;
 
    TimeRange toTime (BeatRange) const;
 
    TimePosition toTime (tempo::BarsAndBeats) const;
 
    tempo::BarsAndBeats toBarsAndBeats (TimePosition) const;
 
    //==============================================================================
    const tempo::Sequence& getInternalSequence() const;
 
    //==============================================================================
    Edit& edit; 
    //==============================================================================
    [[ deprecated ("Use new overload set above") ]] tempo::BarsAndBeats timeToBarsBeats (TimePosition) const;
    [[ deprecated ("Use new overload set above") ]] TimePosition barsBeatsToTime (tempo::BarsAndBeats) const;
    [[ deprecated ("Use new overload set above") ]] BeatPosition barsBeatsToBeats (tempo::BarsAndBeats) const;
    [[ deprecated ("Use new overload set above") ]] BeatPosition timeToBeats (TimePosition time) const;
    [[ deprecated ("Use new overload set above") ]] BeatRange timeToBeats (TimeRange range) const;
    [[ deprecated ("Use new overload set above") ]] TimePosition beatsToTime (BeatPosition beats) const;
    [[ deprecated ("Use new overload set above") ]] TimeRange beatsToTime (BeatRange range) const;
    [[ deprecated ("Use new overload set above") ]] TimeSigSetting& getTimeSigAtBeat (BeatPosition) const;
    [[ deprecated ("Use new overload set above") ]] TempoSetting& getTempoAtBeat (BeatPosition) const;
 
    juce::UndoManager* getUndoManager() const noexcept;
    juce::String getSelectableDescription() override;
    void freeResources();
    void updateTempoData();
 
private:
    //==============================================================================
    friend class TempoSetting;
    friend class TimeSigSetting;
 
    //==============================================================================
    juce::ValueTree state;
 
    struct TempoSettingList;
    struct TimeSigList;
    std::unique_ptr<TempoSettingList> tempos;
    std::unique_ptr<TimeSigList> timeSigs;
 
    tempo::Sequence internalSequence { {{ BeatPosition(), 120.0, 0.0f }},
                                       {{ BeatPosition(), 4, 4, false }},
                                       tempo::LengthOfOneBeat::dependsOnTimeSignature };
 
    //==============================================================================
    void updateTempoDataIfNeeded() const;
    void handleAsyncUpdate() override;
 
    TempoSetting::Ptr insertTempo (BeatPosition, double bpm, float curve, juce::UndoManager*);
    TempoSetting::Ptr insertTempo (TimePosition, juce::UndoManager*);
    TimeSigSetting::Ptr insertTimeSig (TimePosition, juce::UndoManager*);
    HashCode createHashForTemposInRange (TimeRange) const;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TempoSequence)
};
 
 
//==============================================================================
struct EditTimecodeRemapperSnapshot
{
    void savePreChangeState (Edit&);
    void remapEdit (Edit&);
 
private:
    struct ClipPos
    {
        SafeSelectable<Clip> clip;
        BeatPosition startBeat, endBeat;
        BeatDuration contentStartBeat;
    };
 
    struct AutomationPos
    {
        AutomationCurve& curve;
        juce::Array<BeatPosition> beats;
    };
 
    juce::Array<ClipPos> clips;
    juce::Array<AutomationPos> automation;
    BeatRange loopPositionBeats;
    BeatPosition startPositionBeats;
};
 
 
}} // namespace tracktion { inline namespace engine