diff options
Diffstat (limited to 'src/freedv_api.h')
| -rw-r--r-- | src/freedv_api.h | 318 |
1 files changed, 174 insertions, 144 deletions
diff --git a/src/freedv_api.h b/src/freedv_api.h index add15d4..eda0777 100644 --- a/src/freedv_api.h +++ b/src/freedv_api.h @@ -34,54 +34,56 @@ #ifndef __FREEDV_API__ #define __FREEDV_API__ -#include <sys/types.h> #include <stdbool.h> +#include <sys/types.h> // This declares a single-precision (float) complex number #include "comp.h" #ifdef __cplusplus - extern "C" { +extern "C" { #endif // available speech modes -#define FREEDV_MODE_1600 0 -#define FREEDV_MODE_2400A 3 -#define FREEDV_MODE_2400B 4 -#define FREEDV_MODE_800XA 5 -#define FREEDV_MODE_700C 6 -#define FREEDV_MODE_700D 7 -#define FREEDV_MODE_700E 13 -#define FREEDV_MODE_2020 8 -#define FREEDV_MODE_2020B 16 -#define FREEDV_MODE_2020C 17 +#define FREEDV_MODE_1600 0 +#define FREEDV_MODE_2400A 3 +#define FREEDV_MODE_2400B 4 +#define FREEDV_MODE_800XA 5 +#define FREEDV_MODE_700C 6 +#define FREEDV_MODE_700D 7 +#define FREEDV_MODE_700E 13 +#define FREEDV_MODE_2020 8 +#define FREEDV_MODE_2020B 16 +#define FREEDV_MODE_2020C 17 // available data modes -#define FREEDV_MODE_FSK_LDPC 9 -#define FREEDV_MODE_DATAC1 10 -#define FREEDV_MODE_DATAC3 12 -#define FREEDV_MODE_DATAC0 14 -#define FREEDV_MODE_DATAC4 18 -#define FREEDV_MODE_DATAC13 19 +#define FREEDV_MODE_FSK_LDPC 9 +#define FREEDV_MODE_DATAC1 10 +#define FREEDV_MODE_DATAC3 12 +#define FREEDV_MODE_DATAC0 14 +#define FREEDV_MODE_DATAC4 18 +#define FREEDV_MODE_DATAC13 19 // Sample rates used -#define FREEDV_FS_8000 8000 -#define FREEDV_FS_16000 16000 +#define FREEDV_FS_8000 8000 +#define FREEDV_FS_16000 16000 // peak (complex) sample value from Tx modulator -#define FREEDV_PEAK 16384 +#define FREEDV_PEAK 16384 // Return code flags for freedv_get_rx_status() function -#define FREEDV_RX_TRIAL_SYNC 0x1 // demodulator has trial sync -#define FREEDV_RX_SYNC 0x2 // demodulator has sync -#define FREEDV_RX_BITS 0x4 // data bits have been returned -#define FREEDV_RX_BIT_ERRORS 0x8 // FEC may not have corrected all bit errors (not all parity checks OK) +#define FREEDV_RX_TRIAL_SYNC 0x1 // demodulator has trial sync +#define FREEDV_RX_SYNC 0x2 // demodulator has sync +#define FREEDV_RX_BITS 0x4 // data bits have been returned +#define FREEDV_RX_BIT_ERRORS \ + 0x8 // FEC may not have corrected all bit errors (not all parity checks OK) // optional operator control of OFDM modem state machine -#define FREEDV_SYNC_UNSYNC 0 // force sync state machine to lose sync, and search for new sync -#define FREEDV_SYNC_AUTO 1 // falls out of sync automatically -#define FREEDV_SYNC_MANUAL 2 // fall out of sync only under operator control +#define FREEDV_SYNC_UNSYNC \ + 0 // force sync state machine to lose sync, and search for new sync +#define FREEDV_SYNC_AUTO 1 // falls out of sync automatically +#define FREEDV_SYNC_MANUAL 2 // fall out of sync only under operator control -#define FREEDV_VARICODE_MAX_BITS 12 // max bits for each ASCII character +#define FREEDV_VARICODE_MAX_BITS 12 // max bits for each ASCII character // These macros allow us to disable unwanted modes at compile tine, for example // to save memory on embedded systems or the remove need to link other @@ -95,78 +97,81 @@ #endif #if !defined(FREEDV_MODE_1600_EN) - #define FREEDV_MODE_1600_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_1600_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_700C_EN) - #define FREEDV_MODE_700C_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_700C_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_700D_EN) - #define FREEDV_MODE_700D_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_700D_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_700E_EN) - #define FREEDV_MODE_700E_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_700E_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_2400A_EN) - #define FREEDV_MODE_2400A_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_2400A_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_2400B_EN) - #define FREEDV_MODE_2400B_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_2400B_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_800XA_EN) - #define FREEDV_MODE_800XA_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_800XA_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_2020_EN) - #define FREEDV_MODE_2020_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_2020_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_2020B_EN) - #define FREEDV_MODE_2020B_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_2020B_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_2020C_EN) - #define FREEDV_MODE_2020C_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_2020C_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_FSK_LDPC_EN) - #define FREEDV_MODE_FSK_LDPC_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_FSK_LDPC_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_DATAC0_EN) - #define FREEDV_MODE_DATAC0_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_DATAC0_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_DATAC1_EN) - #define FREEDV_MODE_DATAC1_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_DATAC1_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_DATAC3_EN) - #define FREEDV_MODE_DATAC3_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_DATAC3_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_DATAC4_EN) - #define FREEDV_MODE_DATAC4_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_DATAC4_EN FREEDV_MODE_EN_DEFAULT #endif #if !defined(FREEDV_MODE_DATAC13_EN) - #define FREEDV_MODE_DATAC13_EN FREEDV_MODE_EN_DEFAULT +#define FREEDV_MODE_DATAC13_EN FREEDV_MODE_EN_DEFAULT #endif -#define FDV_MODE_ACTIVE(mode_name, var) ((mode_name##_EN) == 0 ? 0: (var) == mode_name) +#define FDV_MODE_ACTIVE(mode_name, var) \ + ((mode_name##_EN) == 0 ? 0 : (var) == mode_name) // struct that hold state information for one freedv instance struct freedv; // Some modes allow extra configuration parameters struct freedv_advanced { - int interleave_frames; // now unused but remains to prevent breaking API for legacy apps - - // parameters for FREEDV_MODE_FSK_LDPC - int M; // 2 or 4 FSK - int Rs; // Symbol rate Hz - int Fs; // Sample rate Hz - int first_tone; // Freq of first tone Hz - int tone_spacing; // Spacing between tones Hz - char *codename; // LDPC codename, from codes listed in ldpc_codes.c + int interleave_frames; // now unused but remains to prevent breaking API for + // legacy apps + + // parameters for FREEDV_MODE_FSK_LDPC + int M; // 2 or 4 FSK + int Rs; // Symbol rate Hz + int Fs; // Sample rate Hz + int first_tone; // Freq of first tone Hz + int tone_spacing; // Spacing between tones Hz + char *codename; // LDPC codename, from codes listed in ldpc_codes.c }; // Called when text message char is decoded typedef void (*freedv_callback_rx)(void *, char); // Called when new text message char is needed typedef char (*freedv_callback_tx)(void *); -typedef void (*freedv_calback_error_pattern) - (void *error_pattern_callback_state, short error_pattern[], int sz_error_pattern); +typedef void (*freedv_calback_error_pattern)(void *error_pattern_callback_state, + short error_pattern[], + int sz_error_pattern); // Protocol bits are packed MSB-first // Called when a frame containing protocol data is decoded @@ -176,10 +181,11 @@ typedef void (*freedv_callback_prototx)(void *, char *); // Data packet callbacks // Called when a packet has been received -typedef void (*freedv_callback_datarx)(void *, unsigned char *packet, size_t size); +typedef void (*freedv_callback_datarx)(void *, unsigned char *packet, + size_t size); // Called when a new packet can be send -typedef void (*freedv_callback_datatx)(void *, unsigned char *packet, size_t *size); - +typedef void (*freedv_callback_datatx)(void *, unsigned char *packet, + size_t *size); /*---------------------------------------------------------------------------*\ @@ -191,36 +197,46 @@ typedef void (*freedv_callback_datatx)(void *, unsigned char *packet, size_t *si struct freedv *freedv_open_advanced(int mode, struct freedv_advanced *adv); struct freedv *freedv_open(int mode); -void freedv_close (struct freedv *freedv); +void freedv_close(struct freedv *freedv); // Transmit ------------------------------------------------------------------- -void freedv_tx (struct freedv *freedv, short mod_out[], short speech_in[]); -void freedv_comptx (struct freedv *freedv, COMP mod_out[], short speech_in[]); -void freedv_datatx (struct freedv *f, short mod_out[]); -int freedv_data_ntxframes (struct freedv *freedv); -void freedv_rawdatatx (struct freedv *f, short mod_out[], unsigned char *packed_payload_bits); -void freedv_rawdatacomptx (struct freedv *f, COMP mod_out[], unsigned char *packed_payload_bits); -int freedv_rawdatapreambletx (struct freedv *f, short mod_out[]); -int freedv_rawdatapreamblecomptx (struct freedv *f, COMP mod_out[]); -int freedv_rawdatapostambletx (struct freedv *f, short mod_out[]); -int freedv_rawdatapostamblecomptx (struct freedv *f, COMP mod_out[]); +void freedv_tx(struct freedv *freedv, short mod_out[], short speech_in[]); +void freedv_comptx(struct freedv *freedv, COMP mod_out[], short speech_in[]); +void freedv_datatx(struct freedv *f, short mod_out[]); +int freedv_data_ntxframes(struct freedv *freedv); +void freedv_rawdatatx(struct freedv *f, short mod_out[], + unsigned char *packed_payload_bits); +void freedv_rawdatacomptx(struct freedv *f, COMP mod_out[], + unsigned char *packed_payload_bits); +int freedv_rawdatapreambletx(struct freedv *f, short mod_out[]); +int freedv_rawdatapreamblecomptx(struct freedv *f, COMP mod_out[]); +int freedv_rawdatapostambletx(struct freedv *f, short mod_out[]); +int freedv_rawdatapostamblecomptx(struct freedv *f, COMP mod_out[]); // Receive ------------------------------------------------------------------- -int freedv_nin (struct freedv *freedv); -int freedv_rx (struct freedv *freedv, short speech_out[], short demod_in[]); -int freedv_shortrx (struct freedv *freedv, short speech_out[], short demod_in[], float gain); -int freedv_floatrx (struct freedv *freedv, short speech_out[], float demod_in[]); -int freedv_comprx (struct freedv *freedv, short speech_out[], COMP demod_in[]); -int freedv_rawdatarx (struct freedv *freedv, unsigned char *packed_payload_bits, short demod_in[]); -int freedv_rawdatacomprx (struct freedv *freedv, unsigned char *packed_payload_bits, COMP demod_in[]); - -// Helper functions ------------------------------------------------------------------- - -int freedv_codec_frames_from_rawdata(struct freedv *freedv, unsigned char *codec_frames, unsigned char *rawdata); -int freedv_rawdata_from_codec_frames(struct freedv *freedv, unsigned char *rawdata, unsigned char *codec_frames); -unsigned short freedv_gen_crc16(unsigned char* bytes, int nbytes); +int freedv_nin(struct freedv *freedv); +int freedv_rx(struct freedv *freedv, short speech_out[], short demod_in[]); +int freedv_shortrx(struct freedv *freedv, short speech_out[], short demod_in[], + float gain); +int freedv_floatrx(struct freedv *freedv, short speech_out[], float demod_in[]); +int freedv_comprx(struct freedv *freedv, short speech_out[], COMP demod_in[]); +int freedv_rawdatarx(struct freedv *freedv, unsigned char *packed_payload_bits, + short demod_in[]); +int freedv_rawdatacomprx(struct freedv *freedv, + unsigned char *packed_payload_bits, COMP demod_in[]); + +// Helper functions +// ------------------------------------------------------------------- + +int freedv_codec_frames_from_rawdata(struct freedv *freedv, + unsigned char *codec_frames, + unsigned char *rawdata); +int freedv_rawdata_from_codec_frames(struct freedv *freedv, + unsigned char *rawdata, + unsigned char *codec_frames); +unsigned short freedv_gen_crc16(unsigned char *bytes, int nbytes); void freedv_pack(unsigned char *bytes, unsigned char *bits, int nbits); void freedv_unpack(unsigned char *bits, unsigned char *bytes, int nbits); unsigned short freedv_crc16_unpacked(unsigned char *bits, int nbits); @@ -228,84 +244,98 @@ int freedv_check_crc16_unpacked(unsigned char *unpacked_bits, int nbits); // Set parameters ------------------------------------------------------------ -void freedv_set_callback_txt (struct freedv *freedv, freedv_callback_rx rx, freedv_callback_tx tx, void *callback_state); -void freedv_set_callback_protocol (struct freedv *freedv, freedv_callback_protorx rx, freedv_callback_prototx tx, void *callback_state); -void freedv_set_callback_data (struct freedv *freedv, freedv_callback_datarx datarx, freedv_callback_datatx datatx, void *callback_state); -void freedv_set_test_frames (struct freedv *freedv, int test_frames); -void freedv_set_test_frames_diversity (struct freedv *freedv, int test_frames_diversity); -void freedv_set_smooth_symbols (struct freedv *freedv, int smooth_symbols); -void freedv_set_squelch_en (struct freedv *freedv, bool squelch_en); -void freedv_set_snr_squelch_thresh (struct freedv *freedv, float snr_squelch_thresh); -void freedv_set_clip (struct freedv *freedv, bool val); -void freedv_set_total_bit_errors (struct freedv *freedv, int val); -void freedv_set_total_bits (struct freedv *freedv, int val); -void freedv_set_total_bit_errors_coded (struct freedv *freedv, int val); -void freedv_set_total_bits_coded (struct freedv *freedv, int val); -void freedv_set_total_packets (struct freedv *freedv, int val); -void freedv_set_total_packet_errors (struct freedv *freedv, int val); -void freedv_set_callback_error_pattern (struct freedv *freedv, freedv_calback_error_pattern cb, void *state); -void freedv_set_varicode_code_num (struct freedv *freedv, int val); -void freedv_set_data_header (struct freedv *freedv, unsigned char *header); -void freedv_set_carrier_ampl (struct freedv *freedv, int c, float ampl); -void freedv_set_sync (struct freedv *freedv, int sync_cmd); -void freedv_set_verbose (struct freedv *freedv, int verbosity); -void freedv_set_tx_bpf (struct freedv *freedv, int val); -void freedv_set_tx_amp (struct freedv *freedv, float amp); -void freedv_set_ext_vco (struct freedv *f, int val); +void freedv_set_callback_txt(struct freedv *freedv, freedv_callback_rx rx, + freedv_callback_tx tx, void *callback_state); +void freedv_set_callback_protocol(struct freedv *freedv, + freedv_callback_protorx rx, + freedv_callback_prototx tx, + void *callback_state); +void freedv_set_callback_data(struct freedv *freedv, + freedv_callback_datarx datarx, + freedv_callback_datatx datatx, + void *callback_state); +void freedv_set_test_frames(struct freedv *freedv, int test_frames); +void freedv_set_test_frames_diversity(struct freedv *freedv, + int test_frames_diversity); +void freedv_set_smooth_symbols(struct freedv *freedv, int smooth_symbols); +void freedv_set_squelch_en(struct freedv *freedv, bool squelch_en); +void freedv_set_snr_squelch_thresh(struct freedv *freedv, + float snr_squelch_thresh); +void freedv_set_clip(struct freedv *freedv, bool val); +void freedv_set_total_bit_errors(struct freedv *freedv, int val); +void freedv_set_total_bits(struct freedv *freedv, int val); +void freedv_set_total_bit_errors_coded(struct freedv *freedv, int val); +void freedv_set_total_bits_coded(struct freedv *freedv, int val); +void freedv_set_total_packets(struct freedv *freedv, int val); +void freedv_set_total_packet_errors(struct freedv *freedv, int val); +void freedv_set_callback_error_pattern(struct freedv *freedv, + freedv_calback_error_pattern cb, + void *state); +void freedv_set_varicode_code_num(struct freedv *freedv, int val); +void freedv_set_data_header(struct freedv *freedv, unsigned char *header); +void freedv_set_carrier_ampl(struct freedv *freedv, int c, float ampl); +void freedv_set_sync(struct freedv *freedv, int sync_cmd); +void freedv_set_verbose(struct freedv *freedv, int verbosity); +void freedv_set_tx_bpf(struct freedv *freedv, int val); +void freedv_set_tx_amp(struct freedv *freedv, float amp); +void freedv_set_ext_vco(struct freedv *f, int val); void freedv_set_phase_est_bandwidth_mode(struct freedv *f, int val); -void freedv_set_eq (struct freedv *f, bool val); -void freedv_set_frames_per_burst (struct freedv *f, int framesperburst); -void freedv_passthrough_gain (struct freedv *f, float g); -int freedv_set_tuning_range (struct freedv *freedv, float val_fmin, float val_fmax); +void freedv_set_eq(struct freedv *f, bool val); +void freedv_set_frames_per_burst(struct freedv *f, int framesperburst); +void freedv_passthrough_gain(struct freedv *f, float g); +int freedv_set_tuning_range(struct freedv *freedv, float val_fmin, + float val_fmax); -// Get parameters ------------------------------------------------------------------------- +// Get parameters +// ------------------------------------------------------------------------- struct MODEM_STATS; int freedv_get_version(void); char *freedv_get_hash(void); -int freedv_get_mode (struct freedv *freedv); -void freedv_get_modem_stats (struct freedv *freedv, int *sync, float *snr_est); -void freedv_get_modem_extended_stats(struct freedv *freedv, struct MODEM_STATS *stats); -int freedv_get_test_frames (struct freedv *freedv); - -int freedv_get_speech_sample_rate (struct freedv *freedv); -int freedv_get_n_speech_samples (struct freedv *freedv); -int freedv_get_n_max_speech_samples (struct freedv *freedv); - -int freedv_get_modem_sample_rate (struct freedv *freedv); -int freedv_get_modem_symbol_rate (struct freedv *freedv); -int freedv_get_n_max_modem_samples (struct freedv *freedv); -int freedv_get_n_nom_modem_samples (struct freedv *freedv); -int freedv_get_n_tx_modem_samples (struct freedv *freedv); +int freedv_get_mode(struct freedv *freedv); +void freedv_get_modem_stats(struct freedv *freedv, int *sync, float *snr_est); +void freedv_get_modem_extended_stats(struct freedv *freedv, + struct MODEM_STATS *stats); +int freedv_get_test_frames(struct freedv *freedv); + +int freedv_get_speech_sample_rate(struct freedv *freedv); +int freedv_get_n_speech_samples(struct freedv *freedv); +int freedv_get_n_max_speech_samples(struct freedv *freedv); + +int freedv_get_modem_sample_rate(struct freedv *freedv); +int freedv_get_modem_symbol_rate(struct freedv *freedv); +int freedv_get_n_max_modem_samples(struct freedv *freedv); +int freedv_get_n_nom_modem_samples(struct freedv *freedv); +int freedv_get_n_tx_modem_samples(struct freedv *freedv); int freedv_get_n_tx_preamble_modem_samples(struct freedv *freedv); int freedv_get_n_tx_postamble_modem_samples(struct freedv *freedv); // bit error rate stats -int freedv_get_total_bits (struct freedv *freedv); -int freedv_get_total_bit_errors (struct freedv *freedv); -int freedv_get_total_bits_coded (struct freedv *freedv); -int freedv_get_total_bit_errors_coded (struct freedv *freedv); -int freedv_get_total_packets (struct freedv *freedv); -int freedv_get_total_packet_errors (struct freedv *freedv); +int freedv_get_total_bits(struct freedv *freedv); +int freedv_get_total_bit_errors(struct freedv *freedv); +int freedv_get_total_bits_coded(struct freedv *freedv); +int freedv_get_total_bit_errors_coded(struct freedv *freedv); +int freedv_get_total_packets(struct freedv *freedv); +int freedv_get_total_packet_errors(struct freedv *freedv); -int freedv_get_rx_status (struct freedv *freedv); -void freedv_get_fsk_S_and_N (struct freedv *freedv, float *S, float *N); +int freedv_get_rx_status(struct freedv *freedv); +void freedv_get_fsk_S_and_N(struct freedv *freedv, float *S, float *N); -int freedv_get_sync (struct freedv *freedv); -int freedv_get_sync_interleaver (struct freedv *freedv); +int freedv_get_sync(struct freedv *freedv); +int freedv_get_sync_interleaver(struct freedv *freedv); // access to speech codec states -struct FSK * freedv_get_fsk (struct freedv *f); -struct CODEC2 *freedv_get_codec2 (struct freedv *freedv); +struct FSK *freedv_get_fsk(struct freedv *f); +struct CODEC2 *freedv_get_codec2(struct freedv *freedv); -int freedv_get_bits_per_codec_frame (struct freedv *freedv); -int freedv_get_bits_per_modem_frame (struct freedv *freedv); -int freedv_get_sz_error_pattern (struct freedv *freedv); -int freedv_get_protocol_bits (struct freedv *freedv); +int freedv_get_bits_per_codec_frame(struct freedv *freedv); +int freedv_get_bits_per_modem_frame(struct freedv *freedv); +int freedv_get_sz_error_pattern(struct freedv *freedv); +int freedv_get_protocol_bits(struct freedv *freedv); #ifdef __cplusplus } #endif -#endif //__FREEDV_API__ +#endif //__FREEDV_API__ |