OpenRTX/openrtx/include/protocols/M17/M17Modulator.h

133 wiersze
4.4 KiB
C++

/***************************************************************************
* Copyright (C) 2021 - 2022 by Federico Amedeo Izzo IU2NUO, *
* Niccolò Izzo IU2KIN *
* Frederik Saraci IU2NRO *
* Silvano Seva IU2KWO *
* *
* 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 3 of the License, 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; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#ifndef M17_MODULATOR_H
#define M17_MODULATOR_H
#ifndef __cplusplus
#error This header is C++ only!
#endif
#include <interfaces/audio_stream.h>
#include <cstdint>
#include <array>
namespace M17
{
/**
* Modulator device for M17 protocol.
*/
class M17Modulator
{
public:
/**
* Constructor.
*/
M17Modulator();
/**
* Destructor.
*/
~M17Modulator();
/**
* Allocate buffers for baseband audio generation and initialise modulator.
*/
void init();
/**
* Shutdown modulator and deallocate data buffers.
*/
void terminate();
/**
* Generate and transmit the baseband signal obtained by 4FSK modulation of
* a given block of data. When called for the first time, this function
* starts baseband transmission.
*
* @param sync: synchronisation word to be prepended to data block.
* @param data: data block to be transmitted.
* @param isLast: flag signalling that current block is the last one being
* transmitted.
*/
void send(const std::array< uint8_t, 2 >& sync,
const std::array< uint8_t, 46 >& data,
const bool isLast = false);
private:
/**
* Generate baseband stream from symbol stream.
*/
void generateBaseband();
/**
* Emit the baseband stream towards the output stage, platform dependent.
*/
void emitBaseband();
/**
* Utility function to encode a given byte of data into 4FSK symbols. Each
* byte is encoded in four symbols.
*
* @param value: value to be encoded in 4FSK symbols.
* @return std::array containing the four symbols obtained by 4FSK encoding.
*/
inline std::array< int8_t, 4 > byteToSymbols(uint8_t value)
{
static constexpr int8_t LUT[] = { +1, +3, -1, -3};
std::array< int8_t, 4 > symbols;
symbols[3] = LUT[value & 0x03];
value >>= 2;
symbols[2] = LUT[value & 0x03];
value >>= 2;
symbols[1] = LUT[value & 0x03];
value >>= 2;
symbols[0] = LUT[value & 0x03];
return symbols;
}
static constexpr size_t M17_TX_SAMPLE_RATE = 48000;
static constexpr size_t M17_FRAME_SAMPLES_48K = 1920;
static constexpr size_t M17_FRAME_SYMBOLS = 192;
#ifdef PLATFORM_MOD17
static constexpr float M17_RRC_GAIN = 15000.0f;
static constexpr float M17_RRC_OFFSET = 11500.0f;
#else
static constexpr float M17_RRC_GAIN = 7168.0f;
static constexpr float M17_RRC_OFFSET = 0.0f;
#endif
std::array< int16_t, M17_FRAME_SYMBOLS > symbols;
stream_sample_t *baseband_buffer; ///< Buffer for baseband audio handling.
stream_sample_t *idleBuffer; ///< Half baseband buffer, free for processing.
streamId outStream; ///< Baseband output stream ID.
bool txRunning; ///< Transmission running.
bool stopTx; ///< Stop transmission request.
};
} /* M17 */
#endif /* M17_MODULATOR_H */