carbon_client_ffi.hpp

Go to the documentation of this file.

// Copyright (c) 2024-2025 Voyant Photonics, Inc.
// All rights reserved.
 
#pragma once
 
#include <cstdarg>
#include <cstdint>
#include <cstdlib>
#include <ostream>
#include <new>
#include <voyant_types_ffi.hpp>
 
struct CarbonClientHandleC;
 
struct CarbonConfigC;
 
struct SdlCommandParams {
  uint8_t req_state;
  float hfov_deg;
  float hfov_center_deg;
  float frame_rate_fps;
  float ramp_bandwidth_ghz;
  uint8_t ramp_length;
};
 
extern "C" {
 
CarbonClientHandleC *carbon_client_new(const CarbonConfigC *config);
 
bool carbon_client_start(CarbonClientHandleC *handle);
 
void carbon_client_stop(CarbonClientHandleC *handle);
 
bool carbon_client_is_running(const CarbonClientHandleC *handle);
 
int32_t carbon_client_copy_latest_into(CarbonClientHandleC *handle, uint8_t *dest, uintptr_t len);
 
bool carbon_client_get_sensor_state(const CarbonClientHandleC *handle, SensorState *out);
 
uint8_t carbon_client_send_sdl(CarbonClientHandleC *handle, const SdlCommandParams *params);
 
uint8_t carbon_client_poll_sdl(CarbonClientHandleC *handle);
 
void carbon_client_free(CarbonClientHandleC *handle);
 
CarbonConfigC *carbon_config_new();
 
CarbonConfigC *carbon_config_from_json(const char *path);
 
void carbon_config_free(CarbonConfigC *cfg);
 
void carbon_config_set_bind_addr(CarbonConfigC *cfg, const char *v);
 
void carbon_config_set_group_addr(CarbonConfigC *cfg, const char *v);
 
void carbon_config_set_interface_addr(CarbonConfigC *cfg, const char *v);
 
void carbon_config_set_use_msg_timestamp(CarbonConfigC *cfg, bool v);
 
void carbon_config_set_batch_size(CarbonConfigC *cfg, uintptr_t v);
 
void carbon_config_set_recv_buffer_size(CarbonConfigC *cfg, uintptr_t v);
 
void carbon_config_set_receiver_channel_capacity(CarbonConfigC *cfg, uintptr_t v);
 
void carbon_config_set_pfa(CarbonConfigC *cfg, float v);
 
void carbon_config_set_vel_corr_factor(CarbonConfigC *cfg, float v);
 
void carbon_config_set_bandwidth_hz(CarbonConfigC *cfg, float v);
 
void carbon_config_set_elevation_fov_deg(CarbonConfigC *cfg, float v);
 
void carbon_config_set_keep_invalid_points(CarbonConfigC *cfg, bool v);
 
void carbon_config_set_range_min(CarbonConfigC *cfg, float v);
 
void carbon_config_set_range_max(CarbonConfigC *cfg, float v);
 
void carbon_config_set_doppler_min(CarbonConfigC *cfg, float v);
 
void carbon_config_set_doppler_max(CarbonConfigC *cfg, float v);
 
void carbon_config_set_azimuth_deg_min(CarbonConfigC *cfg, float v);
 
void carbon_config_set_azimuth_deg_max(CarbonConfigC *cfg, float v);
 
void carbon_config_set_elevation_deg_min(CarbonConfigC *cfg, float v);
 
void carbon_config_set_elevation_deg_max(CarbonConfigC *cfg, float v);
 
void carbon_config_set_spatial_range_threshold(CarbonConfigC *cfg, float v);
 
void carbon_config_set_spatial_doppler_threshold(CarbonConfigC *cfg, float v);
 
void carbon_config_set_spatial_min_neighbors(CarbonConfigC *cfg, uint8_t v);
 
void carbon_config_set_interp_range_threshold(CarbonConfigC *cfg, float v);
 
void carbon_config_set_interp_doppler_threshold(CarbonConfigC *cfg, float v);
 
void carbon_config_set_missing_elevations(CarbonConfigC *cfg,
                                          const uint8_t *elevations,
                                          uintptr_t len);
 
void carbon_config_set_mirror_peaks(CarbonConfigC *cfg, bool v);
 
void carbon_config_set_mirror_group_addr(CarbonConfigC *cfg, const char *v);
 
void carbon_config_set_mirror_bind_addr(CarbonConfigC *cfg, const char *v);
 
void carbon_config_set_eval_mode(CarbonConfigC *cfg, bool v);
 
void carbon_config_set_report_dir(CarbonConfigC *cfg, const char *v);
 
void carbon_config_set_fpga_target_addr(CarbonConfigC *cfg, const char *v);
 
void carbon_config_set_sdl_timeout_sec(CarbonConfigC *cfg, float v);
 
void carbon_config_set_sdl_max_retries(CarbonConfigC *cfg, uint8_t v);
 
}  // extern "C"