carbon_client.hpp

Go to the documentation of this file.

// Copyright (c) 2024-2025 Voyant Photonics, Inc.
// All rights reserved.
 
#pragma once
 
#include <carbon_client_ffi.hpp>
#include <carbon_config.hpp>
#include <csignal>
#include <cstdint>
#include <optional>
#include <sdl_types_generated.hpp>
#include <voyant_frame.hpp>
#include <voyant_types_ffi.hpp>

class CarbonClient
{
public:
    explicit CarbonClient(const CarbonConfig& config);
 
    ~CarbonClient();
 
    // Non-copyable, non-movable (owns async runtime)
    CarbonClient(const CarbonClient&)            = delete;
    CarbonClient& operator=(const CarbonClient&) = delete;
    CarbonClient(CarbonClient&&)                 = delete;
    CarbonClient& operator=(CarbonClient&&)      = delete;

    bool start();

    void stop();

    bool isRunning() const;

    std::optional<VoyantFrame> tryReceiveFrame();

    SensorState getSensorState() const;

    TimeSyncState getTimeSyncState() const;

    SdlStatus sendSdl(const SdlCommandParams& cmd);
    SdlStatus pollSdl();

    SdlStatus sendSdlBlocking(const SdlCommandParams& cmd);

    bool waitForHeartbeat();

    bool ensureIdleForCalibration();

    bool applyDefaultBackgroundNoise();

    bool refineBackgroundNoise(uint32_t iterations = 0);

    bool startDiagnosticCapture(const std::string& path, bool overwrite = false);

    void stopDiagnosticCapture();

    bool isDiagnosticCapturing() const;

    std::string diagnosticCaptureError() const;

    static void setupSignalHandling(int signal = SIGINT);

    static bool isTerminated();

    static void resetTerminationFlag();
 
private:
    CarbonClientHandleC* handle_; // opaque pointer — type defined in carbon_client_ffi.hpp
 
    static volatile std::sig_atomic_t terminated_;
    static void                       signalHandler(int);
};

SdlCommandParams toSdlCommand(const SensorState& state);

SdlCommandParams makeLinescanCommand(SdlState reqState, float rampBandwidthGhz, float hfovCenterDeg = 0.0f);