pilotclient/src/blackcore/afv/dto.h

/* Copyright (C) 2019
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 */

//! \file

#ifndef BLACKCORE_AFV_DTO_H
#define BLACKCORE_AFV_DTO_H

#include "msgpack.hpp"

#include <QByteArray>
#include <QJsonObject>
#include <QString>
#include <QUuid>

namespace BlackCore
{
    namespace Afv
    {
        // struct IMsgPack { };

        //! Channel config DTO
        struct CryptoDtoChannelConfigDto
        {
            //! Properties @{
            QString channelTag;
            QByteArray aeadReceiveKey;
            QByteArray aeadTransmitKey;
            QByteArray hmacKey;
            //! @}

            //! To JSON
            QJsonObject toJson() const
            {
                QJsonObject json;
                json["channelTag"] = channelTag;
                json["aeadReceiveKey"] = QString(aeadReceiveKey);
                json["aeadTransmitKey"] = QString(aeadTransmitKey);
                json["hmacKey"] = QString(hmacKey);
                return json;
            }

            //! From JSON
            static CryptoDtoChannelConfigDto fromJson(const QJsonObject &json)
            {
                CryptoDtoChannelConfigDto dto;

                dto.channelTag = json.value("channelTag").toString();
                dto.aeadReceiveKey  = QByteArray::fromBase64(json.value("aeadReceiveKey").toString().toLocal8Bit());
                dto.aeadTransmitKey = QByteArray::fromBase64(json.value("aeadTransmitKey").toString().toLocal8Bit());
                dto.hmacKey = QByteArray::fromBase64(json.value("hmacKey").toString().toLocal8Bit());
                return dto;
            }
        };

        //! Voice server DTO
        struct VoiceServerConnectionDataDto
        {
            //! Properties @{
            QString addressIpV4;    // Example: 123.123.123.123:50000
            QString addressIpV6;    // Example: 123.123.123.123:50000
            CryptoDtoChannelConfigDto channelConfig;
            //! @}

            //! To JSON
            QJsonObject toJson() const
            {
                QJsonObject json;
                json["addressIpV4"] = addressIpV4;
                json["addressIpV6"] = addressIpV6;
                json["channelConfig"] = channelConfig.toJson();
                return json;
            }

            //! From JSON
            static VoiceServerConnectionDataDto fromJson(const QJsonObject &json)
            {
                VoiceServerConnectionDataDto dto;
                dto.addressIpV4 = json.value("addressIpV4").toString();
                dto.addressIpV6 = json.value("addressIpV6").toString();
                dto.channelConfig = CryptoDtoChannelConfigDto::fromJson(json.value("channelConfig").toObject());
                return dto;
            }
        };

        //! Callsign DTO
        struct PostCallsignResponseDto
        {
            //! Properties @{
            // DataServerConnectionDataDto DataServer;
            VoiceServerConnectionDataDto VoiceServer;
            bool isValid = false;
            //! @}

            //! To JSON
            QJsonObject toJson() const
            {
                QJsonObject json;
                json["voiceserverauthdatadto"] = VoiceServer.toJson();
                // json["dataserverauthdatadto"] = DataServer.toJson();
                return json;
            }

            //! From JSON
            static PostCallsignResponseDto fromJson(const QJsonObject &json)
            {
                PostCallsignResponseDto dto;
                dto.VoiceServer = VoiceServerConnectionDataDto::fromJson(json.value("voiceServer").toObject());
                // dto.DataServer = DataServerConnectionDataDto::fromJson(json.value("dataServer").toObject());
                dto.isValid = true;
                return dto;
            }
        };

        //! Transceiver DTO
        struct TransceiverDto
        {
            //! Properties @{
            quint16 id;
            quint32 frequencyHz;
            double LatDeg = 0.0;
            double LonDeg = 0.0;
            double HeightMslM = 0.0;
            double HeightAglM = 0.0;
            //! @}
            MSGPACK_DEFINE(id, frequencyHz, LatDeg, LonDeg, HeightMslM, HeightAglM)

            //! To JSON
            QJsonObject toJson() const
            {
                QJsonObject json;
                json["ID"] = id;
                json["Frequency"] = static_cast<int>(frequencyHz);
                json["LatDeg"] = LatDeg;
                json["LonDeg"] = LonDeg;
                json["HeightMslM"] = HeightMslM;
                json["HeightAglM"] = HeightAglM;
                return json;
            }

            //! From JSON
            static TransceiverDto fromJson(const QJsonObject &json)
            {
                TransceiverDto dto;
                dto.id = static_cast<quint16>(json.value("id").toInt());
                dto.frequencyHz = static_cast<quint32>(json.value("frequency").toInt());
                dto.LatDeg = json.value("latDeg").toDouble();
                dto.LonDeg = json.value("lonDeg").toDouble();
                dto.HeightMslM = json.value("heightMslM").toDouble();
                dto.HeightAglM = json.value("heightAglM").toDouble();
                return dto;
            }
        };

        //! Station DTO
        struct StationDto
        {
            //! Properties @{
            QUuid id;
            QString name;
            quint32 frequencyHz;
            quint32 frequencyAliasHz;
            //! @}

            //! From JSON
            static StationDto fromJson(const QJsonObject &json)
            {
                StationDto dto;
                dto.id = json.value("id").toString();
                dto.name = json.value("name").toString();
                dto.frequencyHz      = static_cast<quint32>(json.value("frequency").toInt());
                dto.frequencyAliasHz = static_cast<quint32>(json.value("frequencyAlias").toInt());
                return dto;
            }
        };

        //! Heartbeat DTO
        struct HeartbeatDto
        {
            //! Name @{
            static QByteArray getDtoName() { return "HeartbeatDto"; }
            static QByteArray getShortDtoName() { return "H"; }
            //! @}

            std::string callsign; //!< callsign
            MSGPACK_DEFINE(callsign)
        };

        //! Heartbeat DTO
        struct HeartbeatAckDto
        {
            //! Name @{
            static QByteArray getDtoName() { return "HeartbeatAckDto"; }
            static QByteArray getShortDtoName() { return "HA"; }
            //! @}

            MSGPACK_DEFINE()
        };

        //! Receive transceiver DTO
        struct RxTransceiverDto
        {
            //! Properties @{
            uint16_t id;
            uint32_t frequency;
            float distanceRatio;
            // std::string RelayCallsign;
            //! @}

            MSGPACK_DEFINE(id, frequency, distanceRatio/*, RelayCallsign*/)
        };

        //! Transmit transceiver DTO
        struct TxTransceiverDto
        {
            //! Ctor
            TxTransceiverDto() {}

            //! Ctor
            TxTransceiverDto(const TransceiverDto &dto)
            {
                id = dto.id;
            }

            //! Ctor
            TxTransceiverDto(uint16_t value)
            {
                id = value;
            }

            uint16_t id; //!< id
            MSGPACK_DEFINE(id)
        };

        //! AudioTxOnTransceiversDto
        struct AudioTxOnTransceiversDto
        {
            //! Names @{
            static QByteArray getDtoName() { return "AudioTxOnTransceiversDto"; }
            static QByteArray getShortDtoName() { return "AT"; }
            //! @}

            //! Properties @{
            std::string callsign;
            uint sequenceCounter;
            std::vector<char> audio;
            bool lastPacket;
            std::vector<TxTransceiverDto> transceivers;
            //! @}
            MSGPACK_DEFINE(callsign, sequenceCounter, audio, lastPacket, transceivers)
        };

        //! AudioRxOnTransceiversDto
        struct AudioRxOnTransceiversDto
        {
            //! Names @{
            static QByteArray getDtoName() { return "AudioRxOnTransceiversDto"; }
            static QByteArray getShortDtoName() { return "AR"; }
            //! @}

            //! Properties @{
            std::string callsign;
            uint sequenceCounter;
            std::vector<char> audio;
            bool lastPacket;
            std::vector<RxTransceiverDto> transceivers;
            //! @}
            MSGPACK_DEFINE(callsign, sequenceCounter, audio, lastPacket, transceivers)
        };

        //! Audio DTO
        struct IAudioDto
        {
            QString callsign;      //!< Callsign that audio originates from
            uint sequenceCounter;  //!< Receiver optionally uses this in reordering algorithm/gap detection
            QByteArray audio;      //!< Opus compressed audio
            bool lastPacket;       //!< Used to indicate to receiver that the sender has stopped sending
        };
    } // ns
} // ns

#endif // guard