#include "decode.h" #include "constants.h" #include "crc.h" #include "ldpc.h" #include "unpack.h" #include #include /// Compute log likelihood log(p(1) / p(0)) of 174 message bits for later use in soft-decision LDPC decoding /// @param[in] wf Waterfall data collected during message slot /// @param[in] cand Candidate to extract the message from /// @param[in] code_map Symbol encoding map /// @param[out] log174 Output of decoded log likelihoods for each of the 174 message bits static void ft4_extract_likelihood(const waterfall_t* wf, const candidate_t* cand, float* log174); static void ft8_extract_likelihood(const waterfall_t* wf, const candidate_t* cand, float* log174); /// Packs a string of bits each represented as a zero/non-zero byte in bit_array[], /// as a string of packed bits starting from the MSB of the first byte of packed[] /// @param[in] plain Array of bits (0 and nonzero values) with num_bits entires /// @param[in] num_bits Number of bits (entries) passed in bit_array /// @param[out] packed Byte-packed bits representing the data in bit_array static void pack_bits(const uint8_t bit_array[], int num_bits, uint8_t packed[]); 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 ft8_decode_multi_symbols(const uint8_t* wf, int num_bins, int n_syms, int bit_idx, float* log174); 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; } 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); // 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 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; } } } 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]); } // Compute unnormalized log likelihood log(p(1) / p(0)) of bits corresponding to several FSK symbols at once static void ft8_decode_multi_symbols(const uint8_t* wf, int num_bins, int n_syms, int bit_idx, float* log174) { const int n_bits = 3 * n_syms; const int n_tones = (1 << n_bits); float s2[n_tones]; for (int j = 0; j < n_tones; ++j) { int j1 = j & 0x07; if (n_syms == 1) { s2[j] = (float)wf[kFT8_Gray_map[j1]]; continue; } int j2 = (j >> 3) & 0x07; if (n_syms == 2) { s2[j] = (float)wf[kFT8_Gray_map[j2]]; s2[j] += (float)wf[kFT8_Gray_map[j1] + 4 * num_bins]; continue; } int j3 = (j >> 6) & 0x07; s2[j] = (float)wf[kFT8_Gray_map[j3]]; s2[j] += (float)wf[kFT8_Gray_map[j2] + 4 * num_bins]; s2[j] += (float)wf[kFT8_Gray_map[j1] + 8 * num_bins]; } // Extract bit significance (and convert them to float) // 8 FSK tones = 3 bits for (int i = 0; i < n_bits; ++i) { if (bit_idx + i >= FTX_LDPC_N) { // Respect array size break; } uint16_t mask = (n_tones >> (i + 1)); float max_zero = -1000, max_one = -1000; for (int n = 0; n < n_tones; ++n) { if (n & mask) { max_one = max2(max_one, s2[n]); } else { max_zero = max2(max_zero, s2[n]); } } log174[bit_idx + i] = max_one - max_zero; } } // 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; } } }