voyant_data_recorder.hpp

Go to the documentation of this file.

// Copyright (c) 2024-2025 Voyant Photonics, Inc.
// All rights reserved.
 
#pragma once
 
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include <voyant_frame_wrapper.hpp>
#include <voyant_recorder_ffi.hpp>
 
enum class RecordResult
{
    Unknown = 0, 
    Ok,          
    Split,       
    Finished,    
    Error        
};
 
struct VoyantRecorderConfig
{
 
    explicit VoyantRecorderConfig(const std::string& path)
        : outputPath(path)
    {
    }
 
    std::string outputPath;
 
    bool timestampFilename = true;
 
    uint32_t framesPerFile = 0;
 
    uint64_t durationPerFile = 0;
 
    uint64_t sizePerFileMb = 0;
 
    uint32_t maxTotalFrames = 0;
 
    uint64_t maxTotalDuration = 0;
 
    uint64_t maxTotalSizeMb = 0;
 
    uint64_t bufferSizeMb = 4;
};
 
class VoyantRecorder
{
public:
    explicit VoyantRecorder(const VoyantRecorderConfig& config);
 
    ~VoyantRecorder();
 
    VoyantRecorder(const VoyantRecorder&)            = delete;
    VoyantRecorder& operator=(const VoyantRecorder&) = delete;
 
    RecordResult recordFrame(const VoyantFrameWrapper& frame);
 
    bool finalize();
 
    std::optional<size_t> getTotalFramesRecorded() const;
 
    std::optional<size_t> getSplitCount() const;
 
    bool isValid() const;
 
private:
    VoyantRecorderC* recorderHandle_;
    bool             finalized_;
    std::string      lastErrorMsg_;
 
    std::vector<uint8_t> buffer_;
};