sdr_observer.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_SDR_OBSERVER_H
#define OAKFIELD_SDR_OBSERVER_H
 
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimSdrObserverDemod {
    SIM_SDR_OBSERVER_DEMOD_RAW = 0, 
    SIM_SDR_OBSERVER_DEMOD_AM,      
    SIM_SDR_OBSERVER_DEMOD_FM,      
    SIM_SDR_OBSERVER_DEMOD_PM,      
} SimSdrObserverDemod;
 
typedef enum SimSdrObserverBackendMode {
    SIM_SDR_OBSERVER_BACKEND_UNKNOWN = 0, 
    SIM_SDR_OBSERVER_BACKEND_SYNTHETIC,   
    SIM_SDR_OBSERVER_BACKEND_RTL_SDR,     
} SimSdrObserverBackendMode;
 
typedef enum SimSdrObserverFallbackReason {
    SIM_SDR_OBSERVER_FALLBACK_NONE = 0,        
    SIM_SDR_OBSERVER_FALLBACK_RTLSDR_DISABLED, 
    SIM_SDR_OBSERVER_FALLBACK_DEVICE_OPEN_FAILED,       
    SIM_SDR_OBSERVER_FALLBACK_DEVICE_CONFIG_FAILED,     
    SIM_SDR_OBSERVER_FALLBACK_BUFFER_ALLOCATION_FAILED, 
    SIM_SDR_OBSERVER_FALLBACK_READ_FAILED,              
} SimSdrObserverFallbackReason;
 
#define SIM_SDR_OBSERVER_STATUS_MESSAGE_MAX 159U
 
typedef struct SimSdrObserverConfig {
    size_t field_index;        
    double center_freq;        
    double sample_rate;        
    double gain;               
    SimSdrObserverDemod demod; 
    double freq_offset;        
    double bandwidth;          
    double amplitude;          
    bool normalize;            
    bool accumulate;           
    bool scale_by_dt;          
    int device_index;          
} SimSdrObserverConfig;
 
typedef struct SimSdrObserverStatus {
    SimSdrObserverBackendMode active_backend;          
    SimSdrObserverFallbackReason last_fallback_reason; 
    bool rtl_sdr_enabled;                              
    bool device_open;                                  
    bool using_synthetic;                              
    bool has_successful_read;                          
    bool has_last_error;                               
    double effective_tuned_freq;  
    size_t successful_read_count; 
    size_t fallback_count;        
    size_t last_read_iq_bytes;    
    SimResult last_error_code;    
    int last_backend_error;       
    char last_error_message[SIM_SDR_OBSERVER_STATUS_MESSAGE_MAX +
                            1U]; 
} SimSdrObserverStatus;
 
const char *sim_sdr_observer_backend_mode_name(SimSdrObserverBackendMode mode);
 
const char *sim_sdr_observer_fallback_reason_name(SimSdrObserverFallbackReason reason);
 
SimResult sim_add_sdr_observer_operator(struct SimContext *context,
                                        const SimSdrObserverConfig *config, size_t *out_index);
 
SimResult sim_sdr_observer_config(struct SimContext *context, size_t operator_index,
                                  SimSdrObserverConfig *out_config);
 
SimResult sim_sdr_observer_status(struct SimContext *context, size_t operator_index,
                                  SimSdrObserverStatus *out_status);
 
SimResult sim_sdr_observer_update(struct SimContext *context, size_t operator_index,
                                  const SimSdrObserverConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_SDR_OBSERVER_H */