voyant_playback.hpp

Go to the documentation of this file.

// Copyright (c) 2024-2025 Voyant Photonics, Inc.
// All rights reserved.
 
#pragma once
 
#include <chrono>
#include <string>
#include <voyant_frame.hpp>
#include <voyant_playback_base_ffi.hpp>

class VoyantPlayback
{
private:
    void*                                 playbackHandle;
    double                                playbackRate;
    bool                                  looping;
    uint64_t                              prevTimestamp;
    std::chrono::steady_clock::time_point startTime;
    uint64_t                              firstFrameTimestamp;
    bool                                  firstFrame;
    size_t                                framesProcessed;
    size_t                                loopsCompleted;
    std::string                           lastErrorMsg;
 
    // Reused across frames so the point vector's capacity carries over
    VoyantFrame currentFrameData;
 
public:
    VoyantPlayback(double rate = 1.0, bool loop = false, bool keep_invalid_points = false);

    ~VoyantPlayback();

    VoyantPlayback(const VoyantPlayback&)            = delete;
    VoyantPlayback& operator=(const VoyantPlayback&) = delete;

    bool openFile(const std::string& filePath);

    bool nextFrame();

    const VoyantFrame& currentFrame() const;

    VoyantFrame& currentFrame();

    uint64_t currentFrameTimestamp();

    size_t currentFrameIndex();

    std::string apiVersion();

    size_t getFramesProcessed() const;

    size_t getLoopsCompleted() const;

    bool isValid() const;

    std::string getLastError() const;
 
private:
    void applyTiming(uint64_t currentTimestamp);

    void resetTiming();

    bool parseCurrentFrame();

    void setError(const std::string& message);
};