kopia lustrzana https://github.com/kgoba/ft8_lib
803 wiersze
27 KiB
C
803 wiersze
27 KiB
C
#include "ft8.h"
|
||
#include "constants.h"
|
||
#include "crc.h"
|
||
#include "ldpc.h"
|
||
#include "unpack.h"
|
||
|
||
#include "common/debug.h"
|
||
#include "fft/kiss_fftr.h"
|
||
|
||
#include <stdbool.h>
|
||
#include <math.h>
|
||
#include <string.h>
|
||
|
||
const int kMin_score = 10; // Minimum sync score threshold for candidates
|
||
const int kMax_candidates = 120;
|
||
const int kLDPC_iterations = 20;
|
||
|
||
const int kMax_decoded_messages = 50;
|
||
|
||
const int kFreq_osr = 2; // Frequency oversampling rate (bin subdivision)
|
||
const int kTime_osr = 2; // Time oversampling rate (symbol subdivision)
|
||
|
||
/// Input structure to ft8_find_sync() function. This structure describes stored waterfall data over the whole message slot.
|
||
/// Fields time_osr and freq_osr specify additional oversampling rate for time and frequency resolution.
|
||
/// If time_osr=1, FFT magnitude data is collected once for every symbol transmitted, i.e. every 1/6.25 = 0.16 seconds.
|
||
/// Values time_osr > 1 mean each symbol is further subdivided in time.
|
||
/// If freq_osr=1, each bin in the FFT magnitude data corresponds to 6.25 Hz, which is the tone spacing.
|
||
/// Values freq_osr > 1 mean the tone spacing is further subdivided by FFT analysis.
|
||
typedef struct
|
||
{
|
||
int max_blocks; ///< number of blocks (symbols) allocated in the mag array
|
||
int num_blocks; ///< number of blocks (symbols) stored in the mag array
|
||
int num_bins; ///< number of FFT bins in terms of 6.25 Hz
|
||
int time_osr; ///< number of time subdivisions
|
||
int freq_osr; ///< number of frequency subdivisions
|
||
uint8_t *mag; ///< FFT magnitudes stored as uint8_t[blocks][time_osr][freq_osr][num_bins]
|
||
int block_stride; ///< Helper value = time_osr * freq_osr * num_bins
|
||
ftx_protocol_t protocol; ///< Indicate if using FT4 or FT8
|
||
} waterfall_t;
|
||
|
||
/// Output structure of ft8_find_sync() and input structure of ft8_decode().
|
||
/// Holds the position of potential start of a message in time and frequency.
|
||
typedef struct
|
||
{
|
||
int score; ///< Candidate score (non-negative number; higher score means higher likelihood)
|
||
int time_offset; ///< Index of the time block
|
||
int freq_offset; ///< Index of the frequency bin
|
||
int time_sub; ///< Index of the time subdivision used
|
||
int freq_sub; ///< Index of the frequency subdivision used
|
||
} candidate_t;
|
||
|
||
/// Structure that holds the decoded message
|
||
typedef struct
|
||
{
|
||
// TODO: check again that this size is enough
|
||
char text[32]; ///< Plain text
|
||
uint16_t hash; ///< Hash value to be used in hash table and quick checking for duplicates
|
||
} message_t;
|
||
|
||
/// Structure that contains the status of various steps during decoding of a message
|
||
typedef struct
|
||
{
|
||
int ldpc_errors; ///< Number of LDPC errors during decoding
|
||
uint16_t crc_extracted; ///< CRC value recovered from the message
|
||
uint16_t crc_calculated; ///< CRC value calculated over the payload
|
||
int unpack_status; ///< Return value of the unpack routine
|
||
} decode_status_t;
|
||
|
||
/// Configuration options for FT4/FT8 monitor
|
||
typedef struct
|
||
{
|
||
float f_min; ///< Lower frequency bound for analysis
|
||
float f_max; ///< Upper frequency bound for analysis
|
||
int sample_rate; ///< Sample rate in Hertz
|
||
int time_osr; ///< Number of time subdivisions
|
||
int freq_osr; ///< Number of frequency subdivisions
|
||
ftx_protocol_t protocol; ///< Protocol: FT4 or FT8
|
||
} monitor_config_t;
|
||
|
||
/// FT4/FT8 monitor object that manages DSP processing of incoming audio data
|
||
/// and prepares a waterfall object
|
||
typedef struct
|
||
{
|
||
float symbol_period; ///< FT4/FT8 symbol period in seconds
|
||
int block_size; ///< Number of samples per symbol (block)
|
||
int subblock_size; ///< Analysis shift size (number of samples)
|
||
int nfft; ///< FFT size
|
||
float fft_norm; ///< FFT normalization factor
|
||
float* window; ///< Window function for STFT analysis (nfft samples)
|
||
float* last_frame; ///< Current STFT analysis frame (nfft samples)
|
||
waterfall_t wf; ///< Waterfall object
|
||
float max_mag; ///< Maximum detected magnitude (debug stats)
|
||
|
||
// KISS FFT housekeeping variables
|
||
void* fft_work; ///< Work area required by Kiss FFT
|
||
kiss_fftr_cfg fft_cfg; ///< Kiss FFT housekeeping object
|
||
} monitor_t;
|
||
|
||
static float max2(float a, float b);
|
||
static float max4(float a, float b, float c, float d);
|
||
static void heapify_down(candidate_t heap[], int heap_size);
|
||
static void heapify_up(candidate_t heap[], int heap_size);
|
||
|
||
static void ftx_normalize_logl(float* log174);
|
||
static void ft4_extract_symbol(const uint8_t* wf, float* logl);
|
||
static void ft8_extract_symbol(const uint8_t* wf, float* logl);
|
||
|
||
static void waterfall_init(waterfall_t* me, int max_blocks, int num_bins, int time_osr, int freq_osr)
|
||
{
|
||
me->max_blocks = max_blocks;
|
||
me->num_blocks = 0;
|
||
me->num_bins = num_bins;
|
||
me->time_osr = time_osr;
|
||
me->freq_osr = freq_osr;
|
||
me->block_stride = (time_osr * freq_osr * num_bins);
|
||
me->mag = calloc(max_blocks * time_osr * freq_osr * num_bins, sizeof(me->mag[0]));
|
||
}
|
||
|
||
static void waterfall_free(waterfall_t* me)
|
||
{
|
||
free(me->mag);
|
||
}
|
||
|
||
static void monitor_init(monitor_t* me, const monitor_config_t* cfg)
|
||
{
|
||
float slot_time = (cfg->protocol == PROTO_FT4) ? FT4_SLOT_TIME : FT8_SLOT_TIME;
|
||
float symbol_period = (cfg->protocol == PROTO_FT4) ? FT4_SYMBOL_PERIOD : FT8_SYMBOL_PERIOD;
|
||
// Compute DSP parameters that depend on the sample rate
|
||
me->block_size = (int)(cfg->sample_rate * symbol_period); // samples corresponding to one FSK symbol
|
||
me->subblock_size = me->block_size / cfg->time_osr;
|
||
me->nfft = me->block_size * cfg->freq_osr;
|
||
me->fft_norm = 2.0f / me->nfft;
|
||
// const int len_window = 1.8f * me->block_size; // hand-picked and optimized
|
||
|
||
me->window = calloc(me->nfft, sizeof(me->window[0]));
|
||
for (int i = 0; i < me->nfft; ++i)
|
||
{
|
||
// hann window
|
||
me->window[i] = powf(sinf(M_PI * i / me->nfft), 2.0);
|
||
}
|
||
me->last_frame = calloc(me->nfft, sizeof(me->last_frame[0]));
|
||
|
||
size_t fft_work_size;
|
||
kiss_fftr_alloc(me->nfft, 0, 0, &fft_work_size);
|
||
|
||
LOG(LOG_INFO, "Block size = %d\n", me->block_size);
|
||
LOG(LOG_INFO, "Subblock size = %d\n", me->subblock_size);
|
||
LOG(LOG_INFO, "N_FFT = %d\n", me->nfft);
|
||
LOG(LOG_DEBUG, "FFT work area = %zu\n", fft_work_size);
|
||
|
||
me->fft_work = calloc(1, fft_work_size);
|
||
me->fft_cfg = kiss_fftr_alloc(me->nfft, 0, me->fft_work, &fft_work_size);
|
||
|
||
const int max_blocks = (int)(slot_time / symbol_period);
|
||
const int num_bins = (int)(cfg->sample_rate * symbol_period / 2);
|
||
waterfall_init(&me->wf, max_blocks, num_bins, cfg->time_osr, cfg->freq_osr);
|
||
me->wf.protocol = cfg->protocol;
|
||
me->symbol_period = symbol_period;
|
||
|
||
me->max_mag = -120.0f;
|
||
}
|
||
|
||
static void monitor_free(monitor_t* me)
|
||
{
|
||
waterfall_free(&me->wf);
|
||
free(me->fft_work);
|
||
free(me->last_frame);
|
||
free(me->window);
|
||
}
|
||
|
||
// Compute FFT magnitudes (log wf) for a frame in the signal and update waterfall data
|
||
static void monitor_process(monitor_t* me, const float* frame)
|
||
{
|
||
// Check if we can still store more waterfall data
|
||
if (me->wf.num_blocks >= me->wf.max_blocks)
|
||
return;
|
||
|
||
int offset = me->wf.num_blocks * me->wf.block_stride;
|
||
int frame_pos = 0;
|
||
|
||
// Loop over block subdivisions
|
||
for (int time_sub = 0; time_sub < me->wf.time_osr; ++time_sub)
|
||
{
|
||
kiss_fft_scalar timedata[me->nfft];
|
||
kiss_fft_cpx freqdata[me->nfft / 2 + 1];
|
||
|
||
// Shift the new data into analysis frame
|
||
for (int pos = 0; pos < me->nfft - me->subblock_size; ++pos)
|
||
{
|
||
me->last_frame[pos] = me->last_frame[pos + me->subblock_size];
|
||
}
|
||
for (int pos = me->nfft - me->subblock_size; pos < me->nfft; ++pos)
|
||
{
|
||
me->last_frame[pos] = frame[frame_pos];
|
||
++frame_pos;
|
||
}
|
||
|
||
// Compute windowed analysis frame
|
||
for (int pos = 0; pos < me->nfft; ++pos)
|
||
{
|
||
timedata[pos] = me->fft_norm * me->window[pos] * me->last_frame[pos];
|
||
}
|
||
|
||
kiss_fftr(me->fft_cfg, timedata, freqdata);
|
||
|
||
// Loop over two possible frequency bin offsets (for averaging)
|
||
for (int freq_sub = 0; freq_sub < me->wf.freq_osr; ++freq_sub)
|
||
{
|
||
for (int bin = 0; bin < me->wf.num_bins; ++bin)
|
||
{
|
||
int src_bin = (bin * me->wf.freq_osr) + freq_sub;
|
||
float mag2 = (freqdata[src_bin].i * freqdata[src_bin].i) + (freqdata[src_bin].r * freqdata[src_bin].r);
|
||
float db = 10.0f * log10f(1E-12f + mag2);
|
||
// Scale decibels to unsigned 8-bit range and clamp the value
|
||
// Range 0-240 covers -120..0 dB in 0.5 dB steps
|
||
int scaled = (int)(2 * db + 240);
|
||
|
||
me->wf.mag[offset] = (scaled < 0) ? 0 : ((scaled > 255) ? 255 : scaled);
|
||
++offset;
|
||
|
||
if (db > me->max_mag)
|
||
me->max_mag = db;
|
||
}
|
||
}
|
||
}
|
||
|
||
++me->wf.num_blocks;
|
||
}
|
||
|
||
static int get_index(const waterfall_t* wf, const candidate_t* candidate)
|
||
{
|
||
int offset = candidate->time_offset;
|
||
offset = (offset * wf->time_osr) + candidate->time_sub;
|
||
offset = (offset * wf->freq_osr) + candidate->freq_sub;
|
||
offset = (offset * wf->num_bins) + candidate->freq_offset;
|
||
return offset;
|
||
}
|
||
|
||
// Packs a string of bits each represented as a zero/non-zero byte in plain[],
|
||
// as a string of packed bits starting from the MSB of the first byte of packed[]
|
||
static void pack_bits(const uint8_t bit_array[], int num_bits, uint8_t packed[])
|
||
{
|
||
int num_bytes = (num_bits + 7) / 8;
|
||
for (int i = 0; i < num_bytes; ++i)
|
||
{
|
||
packed[i] = 0;
|
||
}
|
||
|
||
uint8_t mask = 0x80;
|
||
int byte_idx = 0;
|
||
for (int i = 0; i < num_bits; ++i)
|
||
{
|
||
if (bit_array[i])
|
||
{
|
||
packed[byte_idx] |= mask;
|
||
}
|
||
mask >>= 1;
|
||
if (!mask)
|
||
{
|
||
mask = 0x80;
|
||
++byte_idx;
|
||
}
|
||
}
|
||
}
|
||
|
||
static int ft8_sync_score(const waterfall_t* wf, const candidate_t* candidate)
|
||
{
|
||
int score = 0;
|
||
int num_average = 0;
|
||
|
||
// Get the pointer to symbol 0 of the candidate
|
||
const uint8_t* mag_cand = wf->mag + get_index(wf, candidate);
|
||
|
||
// Compute average score over sync symbols (m+k = 0-7, 36-43, 72-79)
|
||
for (int m = 0; m < FT8_NUM_SYNC; ++m)
|
||
{
|
||
for (int k = 0; k < FT8_LENGTH_SYNC; ++k)
|
||
{
|
||
int block = (FT8_SYNC_OFFSET * m) + k; // relative to the message
|
||
int block_abs = candidate->time_offset + block; // relative to the captured signal
|
||
// Check for time boundaries
|
||
if (block_abs < 0)
|
||
continue;
|
||
if (block_abs >= wf->num_blocks)
|
||
break;
|
||
|
||
// Get the pointer to symbol 'block' of the candidate
|
||
const uint8_t *p8 = mag_cand + (block * wf->block_stride);
|
||
|
||
#if 0
|
||
// Weighted difference between the expected and all other symbols
|
||
// Does not work as well as the alternative score below
|
||
score += 8 * p8[kFT8_Costas_pattern[k]] -
|
||
p8[0] - p8[1] - p8[2] - p8[3] -
|
||
p8[4] - p8[5] - p8[6] - p8[7];
|
||
++num_average;
|
||
|
||
// Check only the neighbors of the expected symbol frequency- and time-wise
|
||
#else
|
||
int sm = kFT8_Costas_pattern[k]; // Index of the expected bin
|
||
if (sm > 0)
|
||
{
|
||
// look at one frequency bin lower
|
||
score += p8[sm] - p8[sm - 1];
|
||
++num_average;
|
||
}
|
||
if (sm < 7)
|
||
{
|
||
// look at one frequency bin higher
|
||
score += p8[sm] - p8[sm + 1];
|
||
++num_average;
|
||
}
|
||
if ((k > 0) && (block_abs > 0))
|
||
{
|
||
// look one symbol back in time
|
||
score += p8[sm] - p8[sm - wf->block_stride];
|
||
++num_average;
|
||
}
|
||
if (((k + 1) < FT8_LENGTH_SYNC) && ((block_abs + 1) < wf->num_blocks))
|
||
{
|
||
// look one symbol forward in time
|
||
score += p8[sm] - p8[sm + wf->block_stride];
|
||
++num_average;
|
||
}
|
||
#endif
|
||
}
|
||
}
|
||
|
||
if (num_average > 0)
|
||
score /= num_average;
|
||
|
||
return score;
|
||
}
|
||
|
||
static int ft4_sync_score(const waterfall_t* wf, const candidate_t* candidate)
|
||
{
|
||
int score = 0;
|
||
int num_average = 0;
|
||
|
||
// Get the pointer to symbol 0 of the candidate
|
||
const uint8_t* mag_cand = wf->mag + get_index(wf, candidate);
|
||
|
||
// Compute average score over sync symbols (block = 1-4, 34-37, 67-70, 100-103)
|
||
for (int m = 0; m < FT4_NUM_SYNC; ++m)
|
||
{
|
||
for (int k = 0; k < FT4_LENGTH_SYNC; ++k)
|
||
{
|
||
int block = 1 + (FT4_SYNC_OFFSET * m) + k;
|
||
int block_abs = candidate->time_offset + block;
|
||
// Check for time boundaries
|
||
if (block_abs < 0)
|
||
continue;
|
||
if (block_abs >= wf->num_blocks)
|
||
break;
|
||
|
||
// Get the pointer to symbol 'block' of the candidate
|
||
const uint8_t* p4 = mag_cand + (block * wf->block_stride);
|
||
|
||
int sm = kFT4_Costas_pattern[m][k]; // Index of the expected bin
|
||
|
||
// score += (4 * p4[sm]) - p4[0] - p4[1] - p4[2] - p4[3];
|
||
// num_average += 4;
|
||
|
||
// Check only the neighbors of the expected symbol frequency- and time-wise
|
||
if (sm > 0)
|
||
{
|
||
// look at one frequency bin lower
|
||
score += p4[sm] - p4[sm - 1];
|
||
++num_average;
|
||
}
|
||
if (sm < 3)
|
||
{
|
||
// look at one frequency bin higher
|
||
score += p4[sm] - p4[sm + 1];
|
||
++num_average;
|
||
}
|
||
if ((k > 0) && (block_abs > 0))
|
||
{
|
||
// look one symbol back in time
|
||
score += p4[sm] - p4[sm - wf->block_stride];
|
||
++num_average;
|
||
}
|
||
if (((k + 1) < FT4_LENGTH_SYNC) && ((block_abs + 1) < wf->num_blocks))
|
||
{
|
||
// look one symbol forward in time
|
||
score += p4[sm] - p4[sm + wf->block_stride];
|
||
++num_average;
|
||
}
|
||
}
|
||
}
|
||
|
||
if (num_average > 0)
|
||
score /= num_average;
|
||
|
||
return score;
|
||
}
|
||
|
||
int ft8_find_sync(const waterfall_t* wf, int num_candidates, candidate_t heap[], int min_score)
|
||
{
|
||
int heap_size = 0;
|
||
candidate_t candidate;
|
||
|
||
// Here we allow time offsets that exceed signal boundaries, as long as we still have all data bits.
|
||
// I.e. we can afford to skip the first 7 or the last 7 Costas symbols, as long as we track how many
|
||
// sync symbols we included in the score, so the score is averaged.
|
||
for (candidate.time_sub = 0; candidate.time_sub < wf->time_osr; ++candidate.time_sub)
|
||
{
|
||
for (candidate.freq_sub = 0; candidate.freq_sub < wf->freq_osr; ++candidate.freq_sub)
|
||
{
|
||
for (candidate.time_offset = -12; candidate.time_offset < 24; ++candidate.time_offset)
|
||
{
|
||
for (candidate.freq_offset = 0; (candidate.freq_offset + 7) < wf->num_bins; ++candidate.freq_offset)
|
||
{
|
||
if (wf->protocol == PROTO_FT4)
|
||
{
|
||
candidate.score = ft4_sync_score(wf, &candidate);
|
||
}
|
||
else
|
||
{
|
||
candidate.score = ft8_sync_score(wf, &candidate);
|
||
}
|
||
|
||
if (candidate.score < min_score)
|
||
continue;
|
||
|
||
// If the heap is full AND the current candidate is better than
|
||
// the worst in the heap, we remove the worst and make space
|
||
if (heap_size == num_candidates && candidate.score > heap[0].score)
|
||
{
|
||
heap[0] = heap[heap_size - 1];
|
||
--heap_size;
|
||
heapify_down(heap, heap_size);
|
||
}
|
||
|
||
// If there's free space in the heap, we add the current candidate
|
||
if (heap_size < num_candidates)
|
||
{
|
||
heap[heap_size] = candidate;
|
||
++heap_size;
|
||
heapify_up(heap, heap_size);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
// Sort the candidates by sync strength - here we benefit from the heap structure
|
||
int len_unsorted = heap_size;
|
||
while (len_unsorted > 1)
|
||
{
|
||
candidate_t tmp = heap[len_unsorted - 1];
|
||
heap[len_unsorted - 1] = heap[0];
|
||
heap[0] = tmp;
|
||
len_unsorted--;
|
||
heapify_down(heap, len_unsorted);
|
||
}
|
||
|
||
return heap_size;
|
||
}
|
||
|
||
static void ft4_extract_likelihood(const waterfall_t* wf, const candidate_t* cand, float* log174)
|
||
{
|
||
const uint8_t* mag_cand = wf->mag + get_index(wf, cand);
|
||
|
||
// Go over FSK tones and skip Costas sync symbols
|
||
for (int k = 0; k < FT4_ND; ++k)
|
||
{
|
||
// Skip either 5, 9 or 13 sync symbols
|
||
// TODO: replace magic numbers with constants
|
||
int sym_idx = k + ((k < 29) ? 5 : ((k < 58) ? 9 : 13));
|
||
int bit_idx = 2 * k;
|
||
|
||
// Check for time boundaries
|
||
int block = cand->time_offset + sym_idx;
|
||
if ((block < 0) || (block >= wf->num_blocks))
|
||
{
|
||
log174[bit_idx + 0] = 0;
|
||
log174[bit_idx + 1] = 0;
|
||
}
|
||
else
|
||
{
|
||
// Pointer to 4 bins of the current symbol
|
||
const uint8_t* ps = mag_cand + (sym_idx * wf->block_stride);
|
||
|
||
ft4_extract_symbol(ps, log174 + bit_idx);
|
||
}
|
||
}
|
||
}
|
||
|
||
static void ft8_extract_likelihood(const waterfall_t* wf, const candidate_t* cand, float* log174)
|
||
{
|
||
const uint8_t* mag_cand = wf->mag + get_index(wf, cand);
|
||
|
||
// Go over FSK tones and skip Costas sync symbols
|
||
for (int k = 0; k < FT8_ND; ++k)
|
||
{
|
||
// Skip either 7 or 14 sync symbols
|
||
// TODO: replace magic numbers with constants
|
||
int sym_idx = k + ((k < 29) ? 7 : 14);
|
||
int bit_idx = 3 * k;
|
||
|
||
// Check for time boundaries
|
||
int block = cand->time_offset + sym_idx;
|
||
if ((block < 0) || (block >= wf->num_blocks))
|
||
{
|
||
log174[bit_idx + 0] = 0;
|
||
log174[bit_idx + 1] = 0;
|
||
log174[bit_idx + 2] = 0;
|
||
}
|
||
else
|
||
{
|
||
// Pointer to 8 bins of the current symbol
|
||
const uint8_t* ps = mag_cand + (sym_idx * wf->block_stride);
|
||
|
||
ft8_extract_symbol(ps, log174 + bit_idx);
|
||
}
|
||
}
|
||
}
|
||
|
||
static void ftx_normalize_logl(float* log174)
|
||
{
|
||
// Compute the variance of log174
|
||
float sum = 0;
|
||
float sum2 = 0;
|
||
for (int i = 0; i < FTX_LDPC_N; ++i)
|
||
{
|
||
sum += log174[i];
|
||
sum2 += log174[i] * log174[i];
|
||
}
|
||
float inv_n = 1.0f / FTX_LDPC_N;
|
||
float variance = (sum2 - (sum * sum * inv_n)) * inv_n;
|
||
|
||
// Normalize log174 distribution and scale it with experimentally found coefficient
|
||
float norm_factor = sqrtf(24.0f / variance);
|
||
for (int i = 0; i < FTX_LDPC_N; ++i)
|
||
{
|
||
log174[i] *= norm_factor;
|
||
}
|
||
}
|
||
|
||
bool ft8_decode(const waterfall_t* wf, const candidate_t* cand, message_t* message, int max_iterations, decode_status_t* status)
|
||
{
|
||
float log174[FTX_LDPC_N]; // message bits encoded as likelihood
|
||
if (wf->protocol == PROTO_FT4)
|
||
{
|
||
ft4_extract_likelihood(wf, cand, log174);
|
||
}
|
||
else
|
||
{
|
||
ft8_extract_likelihood(wf, cand, log174);
|
||
}
|
||
|
||
ftx_normalize_logl(log174);
|
||
|
||
uint8_t plain174[FTX_LDPC_N]; // message bits (0/1)
|
||
bp_decode(log174, max_iterations, plain174, &status->ldpc_errors);
|
||
// ldpc_decode(log174, max_iterations, plain174, &status->ldpc_errors);
|
||
|
||
if (status->ldpc_errors > 0)
|
||
{
|
||
return false;
|
||
}
|
||
|
||
// Extract payload + CRC (first FTX_LDPC_K bits) packed into a byte array
|
||
uint8_t a91[FTX_LDPC_K_BYTES];
|
||
pack_bits(plain174, FTX_LDPC_K, a91);
|
||
|
||
// Extract CRC and check it
|
||
status->crc_extracted = ftx_extract_crc(a91);
|
||
// [1]: 'The CRC is calculated on the source-encoded message, zero-extended from 77 to 82 bits.'
|
||
a91[9] &= 0xF8;
|
||
a91[10] &= 0x00;
|
||
status->crc_calculated = ftx_compute_crc(a91, 96 - 14);
|
||
|
||
if (status->crc_extracted != status->crc_calculated)
|
||
{
|
||
return false;
|
||
}
|
||
|
||
if (wf->protocol == PROTO_FT4)
|
||
{
|
||
// '[..] for FT4 only, in order to avoid transmitting a long string of zeros when sending CQ messages,
|
||
// the assembled 77-bit message is bitwise exclusive-OR’ed with [a] pseudorandom sequence before computing the CRC and FEC parity bits'
|
||
for (int i = 0; i < 10; ++i)
|
||
{
|
||
a91[i] ^= kFT4_XOR_sequence[i];
|
||
}
|
||
}
|
||
|
||
status->unpack_status = unpack77(a91, message->text);
|
||
|
||
if (status->unpack_status < 0)
|
||
{
|
||
return false;
|
||
}
|
||
|
||
// Reuse binary message CRC as hash value for the message
|
||
message->hash = status->crc_extracted;
|
||
|
||
return true;
|
||
}
|
||
|
||
static float max2(float a, float b)
|
||
{
|
||
return (a >= b) ? a : b;
|
||
}
|
||
|
||
static float max4(float a, float b, float c, float d)
|
||
{
|
||
return max2(max2(a, b), max2(c, d));
|
||
}
|
||
|
||
static void heapify_down(candidate_t heap[], int heap_size)
|
||
{
|
||
// heapify from the root down
|
||
int current = 0;
|
||
while (true)
|
||
{
|
||
int largest = current;
|
||
int left = 2 * current + 1;
|
||
int right = left + 1;
|
||
|
||
if (left < heap_size && heap[left].score < heap[largest].score)
|
||
{
|
||
largest = left;
|
||
}
|
||
if (right < heap_size && heap[right].score < heap[largest].score)
|
||
{
|
||
largest = right;
|
||
}
|
||
if (largest == current)
|
||
{
|
||
break;
|
||
}
|
||
|
||
candidate_t tmp = heap[largest];
|
||
heap[largest] = heap[current];
|
||
heap[current] = tmp;
|
||
current = largest;
|
||
}
|
||
}
|
||
|
||
static void heapify_up(candidate_t heap[], int heap_size)
|
||
{
|
||
// heapify from the last node up
|
||
int current = heap_size - 1;
|
||
while (current > 0)
|
||
{
|
||
int parent = (current - 1) / 2;
|
||
if (heap[current].score >= heap[parent].score)
|
||
{
|
||
break;
|
||
}
|
||
|
||
candidate_t tmp = heap[parent];
|
||
heap[parent] = heap[current];
|
||
heap[current] = tmp;
|
||
current = parent;
|
||
}
|
||
}
|
||
|
||
// Compute unnormalized log likelihood log(p(1) / p(0)) of 2 message bits (1 FSK symbol)
|
||
static void ft4_extract_symbol(const uint8_t* wf, float* logl)
|
||
{
|
||
// Cleaned up code for the simple case of n_syms==1
|
||
float s2[4];
|
||
|
||
for (int j = 0; j < 4; ++j)
|
||
{
|
||
s2[j] = (float)wf[kFT4_Gray_map[j]];
|
||
}
|
||
|
||
logl[0] = max2(s2[2], s2[3]) - max2(s2[0], s2[1]);
|
||
logl[1] = max2(s2[1], s2[3]) - max2(s2[0], s2[2]);
|
||
}
|
||
|
||
// Compute unnormalized log likelihood log(p(1) / p(0)) of 3 message bits (1 FSK symbol)
|
||
static void ft8_extract_symbol(const uint8_t* wf, float* logl)
|
||
{
|
||
// Cleaned up code for the simple case of n_syms==1
|
||
float s2[8];
|
||
|
||
for (int j = 0; j < 8; ++j)
|
||
{
|
||
s2[j] = (float)wf[kFT8_Gray_map[j]];
|
||
}
|
||
|
||
logl[0] = max4(s2[4], s2[5], s2[6], s2[7]) - max4(s2[0], s2[1], s2[2], s2[3]);
|
||
logl[1] = max4(s2[2], s2[3], s2[6], s2[7]) - max4(s2[0], s2[1], s2[4], s2[5]);
|
||
logl[2] = max4(s2[1], s2[3], s2[5], s2[7]) - max4(s2[0], s2[2], s2[4], s2[6]);
|
||
}
|
||
|
||
// decode FT4 or FT8 signal, call callback for every decoded message
|
||
int ftx_decode(float *signal, int num_samples, int sample_rate, ftx_protocol_t protocol, ftx_decode_callback_t callback, void *ctx)
|
||
{
|
||
bool is_ft8 = false;
|
||
|
||
// Compute FFT over the whole signal and store it
|
||
monitor_t mon;
|
||
monitor_config_t mon_cfg = {
|
||
.f_min = 0.0,
|
||
.f_max = 4000.0,
|
||
.sample_rate = sample_rate,
|
||
.time_osr = kTime_osr,
|
||
.freq_osr = kFreq_osr,
|
||
.protocol = protocol
|
||
};
|
||
monitor_init(&mon, &mon_cfg);
|
||
LOG(LOG_DEBUG, "Waterfall allocated %d symbols\n", mon.wf.max_blocks);
|
||
for (int frame_pos = 0; frame_pos + mon.block_size <= num_samples; frame_pos += mon.block_size)
|
||
{
|
||
// Process the waveform data frame by frame - you could have a live loop here with data from an audio device
|
||
monitor_process(&mon, signal + frame_pos);
|
||
}
|
||
LOG(LOG_DEBUG, "Waterfall accumulated %d symbols\n", mon.wf.num_blocks);
|
||
LOG(LOG_INFO, "Max magnitude: %.1f dB\n", mon.max_mag);
|
||
|
||
// Find top candidates by Costas sync score and localize them in time and frequency
|
||
candidate_t candidate_list[kMax_candidates];
|
||
int num_candidates = ft8_find_sync(&mon.wf, kMax_candidates, candidate_list, kMin_score);
|
||
|
||
// Hash table for decoded messages (to check for duplicates)
|
||
int num_decoded = 0;
|
||
message_t decoded[kMax_decoded_messages];
|
||
message_t* decoded_hashtable[kMax_decoded_messages];
|
||
|
||
// Initialize hash table pointers
|
||
for (int i = 0; i < kMax_decoded_messages; ++i)
|
||
{
|
||
decoded_hashtable[i] = NULL;
|
||
}
|
||
|
||
// Go over candidates and attempt to decode messages
|
||
for (int idx = 0; idx < num_candidates; ++idx)
|
||
{
|
||
const candidate_t* cand = &candidate_list[idx];
|
||
|
||
float freq_hz = (cand->freq_offset + (float)cand->freq_sub / mon.wf.freq_osr) / mon.symbol_period;
|
||
float time_sec = (cand->time_offset + (float)cand->time_sub / mon.wf.time_osr) * mon.symbol_period;
|
||
|
||
message_t message;
|
||
decode_status_t status;
|
||
if (!ft8_decode(&mon.wf, cand, &message, kLDPC_iterations, &status))
|
||
{
|
||
// printf("000000 %3d %+4.2f %4.0f ~ ---\n", cand->score, time_sec, freq_hz);
|
||
if (status.ldpc_errors > 0)
|
||
{
|
||
LOG(LOG_DEBUG, "LDPC decode: %d errors\n", status.ldpc_errors);
|
||
}
|
||
else if (status.crc_calculated != status.crc_extracted)
|
||
{
|
||
LOG(LOG_DEBUG, "CRC mismatch!\n");
|
||
}
|
||
else if (status.unpack_status != 0)
|
||
{
|
||
LOG(LOG_DEBUG, "Error while unpacking!\n");
|
||
}
|
||
continue;
|
||
}
|
||
|
||
LOG(LOG_DEBUG, "Checking hash table for %4.1fs / %4.1fHz [%d]...\n", time_sec, freq_hz, cand->score);
|
||
int idx_hash = message.hash % kMax_decoded_messages;
|
||
bool found_empty_slot = false;
|
||
bool found_duplicate = false;
|
||
do
|
||
{
|
||
if (decoded_hashtable[idx_hash] == NULL)
|
||
{
|
||
LOG(LOG_DEBUG, "Found an empty slot\n");
|
||
found_empty_slot = true;
|
||
}
|
||
else if ((decoded_hashtable[idx_hash]->hash == message.hash) && (0 == strcmp(decoded_hashtable[idx_hash]->text, message.text)))
|
||
{
|
||
LOG(LOG_DEBUG, "Found a duplicate [%s]\n", message.text);
|
||
found_duplicate = true;
|
||
}
|
||
else
|
||
{
|
||
LOG(LOG_DEBUG, "Hash table clash!\n");
|
||
// Move on to check the next entry in hash table
|
||
idx_hash = (idx_hash + 1) % kMax_decoded_messages;
|
||
}
|
||
} while (!found_empty_slot && !found_duplicate);
|
||
|
||
if (found_empty_slot)
|
||
{
|
||
// Fill the empty hashtable slot
|
||
memcpy(&decoded[idx_hash], &message, sizeof(message));
|
||
decoded_hashtable[idx_hash] = &decoded[idx_hash];
|
||
++num_decoded;
|
||
|
||
float signal = 1.0, noise = 1.0;
|
||
|
||
// report message through callback
|
||
callback(message.text, freq_hz, time_sec, 10.0 * log10f(signal / noise), cand->score, ctx);
|
||
}
|
||
}
|
||
|
||
monitor_free(&mon);
|
||
|
||
return num_decoded;
|
||
}
|