mirror of
https://github.com/portapack-mayhem/mayhem-firmware.git
synced 2026-08-20 14:39:01 +00:00
VasylSamoilov
dd006b4830
RX: fix address/batch-boundary handling, add numeric continuation, add heuristic type detection toggle, pass inverted polarity flag, stream decoded messages over USB serial. TX: rename phase to polarity (Standard/Inverted), fix function validation (&&→||), fix serial shell payload read (offset tracking, 31-byte cap, preserve msglen). Decoder: remove color escapes from output (plain text for all consumers), guard count_alpha_fill against empty string, keep numeric_len across continuation batches. Serial format: POCSAG <baud> <addr> <func> <pol> <type> "<msg>" hex:<hex> Quote escaping for embedded " and \\ in alpha messages.
139 lines
4.3 KiB
C++
139 lines
4.3 KiB
C++
/*
|
|
* Copyright (C) 2015 Jared Boone, ShareBrained Technology, Inc.
|
|
* Copyright (C) 2016 Furrtek
|
|
*
|
|
* This file is part of PortaPack.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2, or (at your option)
|
|
* any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; see the file COPYING. If not, write to
|
|
* the Free Software Foundation, Inc., 51 Franklin Street,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef __POCSAG_H__
|
|
#define __POCSAG_H__
|
|
|
|
#define POCSAG_PREAMBLE_LENGTH 576
|
|
#define POCSAG_TIMEOUT (576 * 2) // Preamble length * 2
|
|
#define POCSAG_SYNCWORD 0x7CD215D8
|
|
#define POCSAG_IDLEWORD 0x7A89C197
|
|
#define POCSAG_AUDIO_RATE 24000
|
|
#define POCSAG_BATCH_LENGTH (17 * 32)
|
|
|
|
#include "pocsag_packet.hpp"
|
|
#include "bch_code.hpp"
|
|
|
|
namespace pocsag {
|
|
|
|
// TODO: these enums suck, make a better decode_batch
|
|
|
|
enum Mode : uint32_t {
|
|
STATE_CLEAR,
|
|
STATE_HAVE_ADDRESS,
|
|
STATE_GETTING_MSG
|
|
};
|
|
|
|
enum OutputType : uint32_t {
|
|
EMPTY,
|
|
IDLE,
|
|
ADDRESS,
|
|
MESSAGE
|
|
};
|
|
|
|
enum MessageType : uint32_t {
|
|
ADDRESS_ONLY,
|
|
NUMERIC_ONLY,
|
|
ALPHANUMERIC
|
|
};
|
|
|
|
/* Holds error correction arrays. This allows the arrays to
|
|
* be freed when POCSAG is not running, saving ~4kb of RAM. */
|
|
class EccContainer {
|
|
public:
|
|
EccContainer();
|
|
|
|
EccContainer(const EccContainer&) = delete;
|
|
EccContainer(EccContainer&&) = delete;
|
|
EccContainer& operator=(const EccContainer&) = delete;
|
|
EccContainer& operator=(EccContainer&&) = delete;
|
|
|
|
int error_correct(uint32_t& val);
|
|
|
|
private:
|
|
void setup_ecc();
|
|
|
|
/* error correction sequence */
|
|
uint32_t ecs[32];
|
|
uint32_t bch[1025];
|
|
};
|
|
|
|
/* Detected message type from heuristic scoring. */
|
|
enum DetectedType : uint8_t {
|
|
DET_UNKNOWN,
|
|
DET_TONE,
|
|
DET_ALPHA,
|
|
DET_NUMERIC
|
|
};
|
|
|
|
/* Max numeric nibbles per batch: 16 codewords * 5 nibbles. */
|
|
constexpr uint8_t max_batch_nibbles = 80;
|
|
|
|
struct POCSAGState {
|
|
EccContainer* ecc = nullptr;
|
|
uint8_t codeword_index = 0;
|
|
uint32_t function = 0;
|
|
uint32_t address = 0;
|
|
Mode mode = STATE_CLEAR;
|
|
OutputType out_type = EMPTY;
|
|
uint64_t ascii_data = 0; // Was uint32_t — fixed overflow for long messages.
|
|
uint32_t ascii_idx = 0;
|
|
uint32_t errors = 0;
|
|
uint8_t prev_cw_err = 0; // Error level of previous codeword (for chars spanning boundary).
|
|
uint8_t cur_cw_err = 0; // Error level of current codeword being decoded.
|
|
bool new_message = false; // True when decoder starts a new address.
|
|
bool type_decided = false; // True after first-batch heuristic runs.
|
|
DetectedType detected = DET_UNKNOWN;
|
|
uint8_t msg_codewords = 0; // Message codewords in current batch (for heuristic).
|
|
std::string output{}; // Alpha decode (always populated, with color escapes).
|
|
// Numeric output is built into a separate local in pocsag_decode_batch
|
|
// and stored here only when heuristic detects numeric.
|
|
// Using a fixed buffer to avoid std::string overhead in external apps
|
|
// that embed POCSAGState (e.g. battleship).
|
|
char numeric_buf[80]{};
|
|
uint8_t numeric_len = 0;
|
|
};
|
|
|
|
const pocsag::BitRate pocsag_bitrates[3] = {
|
|
pocsag::BitRate::FSK512,
|
|
pocsag::BitRate::FSK1200,
|
|
pocsag::BitRate::FSK2400,
|
|
};
|
|
|
|
std::string bitrate_str(BitRate bitrate);
|
|
std::string flag_str(PacketFlag packetflag);
|
|
|
|
void insert_BCH(BCHCode& BCH_code, uint32_t* codeword);
|
|
uint32_t get_digit_code(char code);
|
|
void pocsag_encode(const MessageType type, BCHCode& BCH_code, const uint32_t function, const std::string message, const uint32_t address, std::vector<uint32_t>& codewords);
|
|
|
|
// Returns true if the batch has more to process.
|
|
bool pocsag_decode_batch(const POCSAGPacket& batch, POCSAGState& state);
|
|
|
|
// Heuristic: detect whether message content is numeric or alpha.
|
|
// Called once after first batch of a new message.
|
|
DetectedType detect_message_type(const std::string& alpha, const uint8_t* nibbles, uint8_t nibble_count, uint8_t msg_codewords);
|
|
|
|
} /* namespace pocsag */
|
|
|
|
#endif /*__POCSAG_H__*/
|