tracktion_LaunchHandle.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
{
 
//==============================================================================
//==============================================================================
class LaunchHandle
{
public:
    //==============================================================================
    enum class PlayState
    {
        stopped,
        playing
    };
 
    enum class QueueState
    {
        stopQueued,
        playQueued
    };
 
    //==============================================================================
    LaunchHandle() = default;
 
    PlayState getPlayingStatus() const;
 
    std::optional<QueueState> getQueuedStatus() const;
 
    std::optional<MonotonicBeat> getQueuedEventPosition() const;
 
    void play (std::optional<MonotonicBeat>);
 
    void stop (std::optional<MonotonicBeat>);
 
    //==============================================================================
    struct SplitStatus
    {
        bool playing1 = false, playing2 = false;
        BeatRange range1, range2;
 
        bool isSplit = false;
        std::optional<BeatPosition> playStartTime1, playStartTime2;
    };
 
    SplitStatus advance (const SyncRange&);
 
    //==============================================================================
    std::optional<BeatRange> getPlayedRange() const;
 
    std::optional<MonotonicBeatRange> getPlayedMonotonicRange() const;
 
    std::optional<BeatRange> getLastPlayedRange() const;
 
private:
    //==============================================================================
    struct State
    {
        State();
 
        PlayState status = PlayState::stopped;
        std::optional<BeatRange> playedRange, lastPlayedRange;
        std::optional<MonotonicBeatRange> playedMonotonicRange;
 
        std::optional<QueueState> nextStatus;
        std::optional<MonotonicBeat> nextEventTime;
    };
 
    static_assert (std::is_trivially_copyable_v<State>);
 
    MultipleWriterSeqLock<State> state;
 
    State getState() const      { return state.load(); }
    void setState (State s)     { state.store (std::move (s)); }
};
 
}} // namespace tracktion { inline namespace engine