tracktion_TracktionEngineNode.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.
*/
 
#pragma once
 
namespace tracktion { inline namespace engine
{
 
struct ProcessState
{
    ProcessState (tracktion::graph::PlayHeadState&);
 
    ProcessState (tracktion::graph::PlayHeadState&, const TempoSequence&);
 
    ProcessState (tracktion::graph::PlayHeadState&, const tempo::Sequence&);
 
    enum class UpdateContinuityFlags { no, yes };
 
    void update (double sampleRate, juce::Range<int64_t> referenceSampleRange, UpdateContinuityFlags);
 
    void setPlaybackSpeedRatio (double newRatio);
 
    void setTempoSequence (const tempo::Sequence*);
 
    const tempo::Sequence* getTempoSequence() const;
 
    const tempo::Sequence::Position* getTempoSequencePosition() const;
 
    SyncRange getSyncRange() const;
 
    SyncPoint getSyncPoint() const;
 
    std::function<void()> onContinuityUpdated;
 
    void setSyncRange (SyncRange);
 
    tracktion::graph::PlayHeadState& playHeadState;
    double sampleRate = 44100.0, playbackSpeedRatio = 1.0;
    int numSamples = 0;
    juce::Range<int64_t> referenceSampleRange, timelineSampleRange;
    TimeRange editTimeRange;
    BeatRange editBeatRange;
 
private:
    const tempo::Sequence* tempoSequence = nullptr;
    std::unique_ptr<tempo::Sequence::Position> tempoPosition;
    crill::seqlock_object<SyncRange> syncRange { SyncRange() };
};
 
 
//==============================================================================
//==============================================================================
class TracktionEngineNode
{
public:
    //==============================================================================
    TracktionEngineNode (ProcessState&);
 
    virtual ~TracktionEngineNode() = default;
 
    //==============================================================================
    int getNumSamples() const                               { return processState->numSamples; }
 
    double getSampleRate() const                            { return processState->sampleRate; }
 
    juce::Range<int64_t> getTimelineSampleRange() const     { return processState->timelineSampleRange; }
 
    TimeRange getEditTimeRange() const                      { return processState->editTimeRange; }
 
    BeatRange getEditBeatRange() const                      { return processState->editBeatRange; }
 
    juce::Range<int64_t> getReferenceSampleRange() const    { return processState->referenceSampleRange; }
 
    tempo::Key getKey() const;
 
    double getPlaybackSpeedRatio() const;
 
    //==============================================================================
    std::optional<TimePosition> getTimeOfNextChange() const;
 
    std::optional<BeatPosition> getBeatOfNextChange() const;
 
    //==============================================================================
    tracktion::graph::PlayHeadState& getPlayHeadState()      { return processState->playHeadState; }
 
    tracktion::graph::PlayHead& getPlayHead()                { return getPlayHeadState().playHead; }
 
    ProcessState& getProcessState()                          { return *processState; }
 
    //==============================================================================
    void setProcessState (ProcessState&);
 
private:
    //==============================================================================
    ProcessState* processState; // Must never be nullptr
};
 
 
//==============================================================================
//==============================================================================
class DynamicallyOffsettableNodeBase
{
public:
    DynamicallyOffsettableNodeBase() = default;
    virtual ~DynamicallyOffsettableNodeBase() = default;
 
    virtual void setDynamicOffsetBeats (BeatDuration) {}
 
    virtual void setDynamicOffsetTime (TimeDuration) {}
};
 
 
}} // namespace tracktion { inline namespace engine