mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-04-12 07:15:34 +08:00
416 lines
18 KiB
C++
416 lines
18 KiB
C++
/* 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_CLIENTS_AFVCLIENT_H
|
|
#define BLACKCORE_AFV_CLIENTS_AFVCLIENT_H
|
|
|
|
#include "blackcore/context/contextownaircraft.h"
|
|
#include "blackcore/afv/connection/clientconnection.h"
|
|
#include "blackcore/afv/audio/input.h"
|
|
#include "blackcore/afv/audio/output.h"
|
|
#include "blackcore/afv/audio/soundcardsampleprovider.h"
|
|
#include "blackcore/afv/dto.h"
|
|
#include "blackcore/blackcoreexport.h"
|
|
|
|
#include "blacksound/sampleprovider/volumesampleprovider.h"
|
|
#include "blackmisc/aviation/comsystem.h"
|
|
#include "blackmisc/audio/audiosettings.h"
|
|
#include "blackmisc/audio/ptt.h"
|
|
#include "blackmisc/audio/audiodeviceinfo.h"
|
|
#include "blackmisc/logcategorylist.h"
|
|
#include "blackmisc/identifiable.h"
|
|
#include "blackmisc/settingscache.h"
|
|
#include "blackmisc/worker.h"
|
|
|
|
#include <QDateTime>
|
|
#include <QAudioInput>
|
|
#include <QAudioOutput>
|
|
#include <QObject>
|
|
#include <QString>
|
|
#include <QVector>
|
|
|
|
#include <atomic>
|
|
|
|
namespace BlackCore
|
|
{
|
|
namespace Afv
|
|
{
|
|
namespace Clients
|
|
{
|
|
//! AFV client
|
|
class BLACKCORE_EXPORT CAfvClient final : public BlackMisc::CContinuousWorker
|
|
{
|
|
Q_OBJECT
|
|
|
|
//! AFV client properties @{
|
|
Q_PROPERTY(double inputVolumePeakVU READ getInputVolumePeakVU NOTIFY inputVolumePeakVU)
|
|
Q_PROPERTY(double outputVolumePeakVU READ getOutputVolumePeakVU NOTIFY outputVolumePeakVU)
|
|
Q_PROPERTY(BlackCore::Afv::Clients::CAfvClient::ConnectionStatus connectionStatus READ getConnectionStatus NOTIFY connectionStatusChanged)
|
|
Q_PROPERTY(QString receivingCallsignsCom1 READ getReceivingCallsignsStringCom1 NOTIFY receivingCallsignsChanged)
|
|
Q_PROPERTY(QString receivingCallsignsCom2 READ getReceivingCallsignsStringCom2 NOTIFY receivingCallsignsChanged)
|
|
//! @}
|
|
|
|
public:
|
|
//! Categories
|
|
static const BlackMisc::CLogCategoryList &getLogCategories();
|
|
|
|
//! Connection status
|
|
enum ConnectionStatus { Disconnected, Connected };
|
|
Q_ENUM(ConnectionStatus)
|
|
|
|
//! Ctor
|
|
CAfvClient(const QString &apiServer, QObject *owner);
|
|
|
|
//! Dtor
|
|
virtual ~CAfvClient() override { this->stopAudio(); }
|
|
|
|
//! Corresponding callsign
|
|
//! \threadsafe
|
|
//! @{
|
|
QString getCallsign() const;
|
|
void setCallsign(const QString &getCallsign);
|
|
//! @}
|
|
|
|
//! Is connected to network?
|
|
//! \threadsafe
|
|
bool isConnected() const;
|
|
|
|
//! Connection status
|
|
//! \threadsafe
|
|
ConnectionStatus getConnectionStatus() const;
|
|
|
|
//! Connect to network
|
|
//! \threadsafe
|
|
//! \remark runs in thread of CAfvClient object and is ASYNC when called from another thread
|
|
Q_INVOKABLE void connectTo(const QString &cid, const QString &password, const QString &callsign, const QString &client);
|
|
|
|
//! Disconnect from network
|
|
//! \threadsafe
|
|
//! \remark runs in thread of CAfvClient object and is ASYNC when called from another thread
|
|
//! @{
|
|
void disconnectFrom(bool stop);
|
|
Q_INVOKABLE void disconnectFrom() { this->disconnectFrom(false); }
|
|
void disconnectFromAndStop() { this->disconnectFrom(true); }
|
|
//! @}
|
|
|
|
//! Audio devices @{
|
|
Q_INVOKABLE QStringList availableInputDevices() const;
|
|
Q_INVOKABLE QStringList availableOutputDevices() const;
|
|
//! @}
|
|
|
|
//! Enable/disable VHF simulation, true means effects are NOT used
|
|
Q_INVOKABLE void setBypassEffects(bool value);
|
|
|
|
//! Client started?
|
|
bool isStarted() const { return m_isStarted; }
|
|
|
|
//! When started
|
|
const QDateTime &getStartDateTimeUtc() const { return m_startDateTimeUtc; }
|
|
|
|
//! Muted
|
|
//! \threadsafe
|
|
//! @{
|
|
bool isMuted() const;
|
|
void setMuted(bool mute);
|
|
//! @}
|
|
|
|
//! Start/stop client @{
|
|
void startAudio();
|
|
void startAudio(const BlackMisc::Audio::CAudioDeviceInfo &inputDevice, const BlackMisc::Audio::CAudioDeviceInfo &outputDevice);
|
|
Q_INVOKABLE void startAudio(const QString &inputDeviceName, const QString &outputDeviceName);
|
|
void stopAudio();
|
|
void restartAudio();
|
|
//! @}
|
|
|
|
//! Is integrated with COM unit
|
|
//! \threadsafe
|
|
bool isComUnitIntegrated() const { return m_integratedComUnit; }
|
|
|
|
//! The device's volume 0..1 @{
|
|
double getDeviceInputVolume() const;
|
|
bool setDeviceInputVolume(double volume);
|
|
double getDeviceOutputVolume() const;
|
|
bool setDeviceOutputVolume(double volume);
|
|
//! @}
|
|
|
|
//! Receive audio
|
|
//! \threadsafe
|
|
void setReceiveAudio(bool receive);
|
|
|
|
//! Enable COM unit/transceiver
|
|
//! \threadsafe
|
|
//! @{
|
|
Q_INVOKABLE void enableTransceiver(quint16 id, bool enable);
|
|
void enableComUnit(BlackMisc::Aviation::CComSystem::ComUnit comUnit, bool enable);
|
|
bool isEnabledTransceiver(quint16 id) const;
|
|
bool isEnabledComUnit(BlackMisc::Aviation::CComSystem::ComUnit comUnit) const;
|
|
//! @}
|
|
|
|
//! Set transmitting transceivers
|
|
//! \threadsafe
|
|
//! @{
|
|
void setTransmittingTransceiver(quint16 transceiverID);
|
|
void setTransmittingComUnit(BlackMisc::Aviation::CComSystem::ComUnit comUnit);
|
|
void setTransmittingTransceivers(const QVector<TxTransceiverDto> &transceivers);
|
|
//! @}
|
|
|
|
//! Transmitting transceiver/COM unit
|
|
//! \threadsafe
|
|
//! @{
|
|
bool isTransmittingTransceiver(quint16 id) const;
|
|
bool isTransmittingdComUnit(BlackMisc::Aviation::CComSystem::ComUnit comUnit) const;
|
|
//! @}
|
|
|
|
//! Simplified enable/disable
|
|
//! \threadsafe
|
|
//! @{
|
|
void setRxTx(bool rx1, bool tx1, bool rx2, bool tx2);
|
|
void getRxTx(bool &rx1, bool &tx1, bool &rx2, bool &tx2) const;
|
|
//! @}
|
|
|
|
//! Get transceivers
|
|
//! \threadsafe
|
|
//! @{
|
|
QVector<TransceiverDto> getTransceivers() const;
|
|
QVector<TxTransceiverDto> getTransmittingTransceivers() const;
|
|
QSet<quint16> getEnabledTransceivers() const;
|
|
//! @}
|
|
|
|
//! Aliased stations enabled?
|
|
//! \threadsafe
|
|
//! @{
|
|
bool isAliasedStationsEnabled() const { return m_enableAliased; }
|
|
void enableAliasedStations(bool enabled) { m_enableAliased = enabled; }
|
|
//! @}
|
|
|
|
//! Update frequency
|
|
//! \threadsafe
|
|
//! @{
|
|
Q_INVOKABLE void updateComFrequency(quint16 id, quint32 frequencyHz);
|
|
void updateComFrequency(BlackMisc::Aviation::CComSystem::ComUnit comUnit, const BlackMisc::PhysicalQuantities::CFrequency &comFrequency);
|
|
void updateComFrequency(BlackMisc::Aviation::CComSystem::ComUnit comUnit, const BlackMisc::Aviation::CComSystem &comSystem);
|
|
//! @}
|
|
|
|
//! Update own aircraft position
|
|
//! \threadsafe
|
|
Q_INVOKABLE void updatePosition(double latitudeDeg, double longitudeDeg, double heightMeters);
|
|
|
|
//! Update from own aircraft
|
|
//! \remark full update of frequency, position and enabled transceivers in one step
|
|
//! \threadsafe
|
|
void updateFromOwnAircraft(const BlackMisc::Simulation::CSimulatedAircraft &aircraft, bool withSignals = true);
|
|
|
|
//! Push to talk
|
|
//! \threadsafe
|
|
//! @{
|
|
Q_INVOKABLE void setPtt(bool active);
|
|
void setPttForCom(bool active, BlackMisc::Audio::PTTCOM com);
|
|
//! @}
|
|
|
|
//! Loopback
|
|
//! \threadsafe
|
|
//! @{
|
|
Q_INVOKABLE void setLoopBack(bool on) { m_loopbackOn = on; }
|
|
Q_INVOKABLE bool isLoopback() const { return m_loopbackOn; }
|
|
//! @}
|
|
|
|
//! Input volume in dB, +-18dB
|
|
//! \threadsafe
|
|
//! @{
|
|
double getInputVolumeDb() const;
|
|
Q_INVOKABLE bool setInputVolumeDb(double valueDb);
|
|
//! @}
|
|
|
|
//! Output volume in dB, +-18dB
|
|
//! \threadsafe
|
|
//! @{
|
|
double getOutputVolumeDb() const;
|
|
double getOutputVolume() const;
|
|
Q_INVOKABLE bool setOutputVolumeDb(double valueDb);
|
|
//! @}
|
|
|
|
//! Normalized volumes 0..100
|
|
//! \threadsafe
|
|
//! @{
|
|
int getNormalizedInputVolume() const;
|
|
int getNormalizedOutputVolume() const;
|
|
bool setNormalizedInputVolume(int volume);
|
|
void setNormalizedOutputVolume(int volume);
|
|
//! @}
|
|
|
|
//! VU values, 0..1
|
|
//! \threadsafe
|
|
//! @{
|
|
double getInputVolumePeakVU() const;
|
|
double getOutputVolumePeakVU() const;
|
|
//! @}
|
|
|
|
//! Recently used device
|
|
//! \threadsafe
|
|
//! @{
|
|
const BlackMisc::Audio::CAudioDeviceInfo &getInputDevice() const;
|
|
const BlackMisc::Audio::CAudioDeviceInfo &getOutputDevice() const;
|
|
bool usesSameDevices(const BlackMisc::Audio::CAudioDeviceInfo &inputDevice, const BlackMisc::Audio::CAudioDeviceInfo &outputDevice);
|
|
//! @}
|
|
|
|
//! Callsigns currently received
|
|
//! \threadsafe
|
|
//! @{
|
|
QString getReceivingCallsignsStringCom1() const;
|
|
QString getReceivingCallsignsStringCom2() const;
|
|
BlackMisc::Aviation::CCallsignSet getReceivingCallsignsCom1() const;
|
|
BlackMisc::Aviation::CCallsignSet getReceivingCallsignsCom2() const;
|
|
QStringList getReceivingCallsignsStringCom1Com2() const;
|
|
//! @}
|
|
|
|
//! Update the voice server URL
|
|
bool updateVoiceServerUrl(const QString &url);
|
|
|
|
//! Gracefully shut down AFV client
|
|
void gracefulShutdown();
|
|
|
|
signals:
|
|
//! Receiving callsigns have been changed
|
|
//! \remark callsigns I do receive
|
|
void receivingCallsignsChanged(const BlackCore::Afv::Audio::TransceiverReceivingCallsignsChangedArgs &args);
|
|
|
|
//! Received callsigns have been changed
|
|
//! \remark swift style per com units
|
|
void receivedCallsignsChanged(const BlackMisc::Aviation::CCallsignSet &com1Callsigns, const BlackMisc::Aviation::CCallsignSet &com2Callsigns);
|
|
|
|
//! Connection status has been changed
|
|
void connectionStatusChanged(ConnectionStatus status);
|
|
|
|
//! Client updated from own aicraft data
|
|
void updatedFromOwnAircraftCockpit();
|
|
|
|
//! PTT status in this particular AFV client
|
|
void ptt(bool active, BlackMisc::Audio::PTTCOM pttcom, const BlackMisc::CIdentifier &identifier);
|
|
|
|
//! VU levels @{
|
|
void inputVolumePeakVU(double value);
|
|
void outputVolumePeakVU(double value);
|
|
//! @}
|
|
|
|
//! Started audio with devices
|
|
void startedAudio(const BlackMisc::Audio::CAudioDeviceInfo &inputDevice, const BlackMisc::Audio::CAudioDeviceInfo &outputDevice);
|
|
|
|
//! Audio has been stopped
|
|
void stoppedAudio();
|
|
|
|
protected:
|
|
//! \copydoc BlackMisc::CContinuousWorker::initialize
|
|
virtual void initialize() override;
|
|
|
|
//! \copydoc BlackMisc::CContinuousWorker::cleanup
|
|
virtual void cleanup() override;
|
|
|
|
private:
|
|
void opusDataAvailable(const Audio::OpusDataAvailableArgs &args); // threadsafe
|
|
void audioOutDataAvailable(const AudioRxOnTransceiversDto &dto); // threadsafe
|
|
void inputVolumeStream(const Audio::InputVolumeStreamArgs &args);
|
|
void outputVolumeStream(const Audio::OutputVolumeStreamArgs &args);
|
|
void inputOpusDataAvailable();
|
|
|
|
void onTimerUpdate();
|
|
void onSettingsChanged();
|
|
void autoLogoffWithoutFsdNetwork();
|
|
|
|
void updateTransceivers(bool updateFrequencies = true);
|
|
void onUpdateTransceiversFromContext(const BlackMisc::Simulation::CSimulatedAircraft &aircraft, const BlackMisc::CIdentifier &originator);
|
|
void onReceivingCallsignsChanged(const BlackCore::Afv::Audio::TransceiverReceivingCallsignsChangedArgs &args);
|
|
|
|
//! All aliased stations
|
|
//! \threadsafe
|
|
//! @{
|
|
QVector<StationDto> getAliasedStations() const;
|
|
void setAliasedStations(const QVector<StationDto> &stations);
|
|
//! @}
|
|
|
|
//! Frequency from aliased stations
|
|
//! \threadsafe
|
|
quint32 getAliasFrequencyHz(quint32 frequencyHz) const;
|
|
|
|
bool fuzzyMatchCallsign(const QString &callsign, const QString &compareTo) const;
|
|
void getPrefixSuffix(const QString &callsign, QString &prefix, QString &suffix) const;
|
|
|
|
static constexpr int PositionUpdatesMs = 20000; //!< position timer
|
|
static constexpr int SampleRate = 48000;
|
|
static constexpr int FrameSize = static_cast<int>(SampleRate * 0.02); //!< 20ms
|
|
static constexpr double MinDbIn = -18.0;
|
|
static constexpr double MaxDbIn = 18.0;
|
|
static constexpr double MinDbOut = -60.0;
|
|
static constexpr double MaxDbOut = 18.0;
|
|
static constexpr quint32 UniCom = 122800000;
|
|
|
|
static quint16 comUnitToTransceiverId(BlackMisc::Aviation::CComSystem::ComUnit comUnit);
|
|
static BlackMisc::Aviation::CComSystem::ComUnit transceiverIdToComUnit(quint16 id);
|
|
|
|
Connection::CClientConnection *m_connection = nullptr;
|
|
BlackMisc::CSetting<BlackMisc::Audio::TSettings> m_audioSettings { this, &CAfvClient::onSettingsChanged };
|
|
QString m_callsign;
|
|
|
|
Audio::CInput *m_input = nullptr;
|
|
Audio::COutput *m_output = nullptr;
|
|
|
|
Audio::CSoundcardSampleProvider *m_soundcardSampleProvider = nullptr;
|
|
BlackSound::SampleProvider::CVolumeSampleProvider *m_outputSampleProvider = nullptr;
|
|
|
|
std::atomic_bool m_transmit { false };
|
|
std::atomic_bool m_transmitHistory { false };
|
|
QVector<TxTransceiverDto> m_transmittingTransceivers;
|
|
QVector<TransceiverDto> m_transceivers;
|
|
QSet<quint16> m_enabledTransceivers;
|
|
static const QVector<quint16> &allTransceiverIds() { static const QVector<quint16> transceiverIds{0, 1}; return transceiverIds; }
|
|
|
|
std::atomic_int m_connectMismatches { 0 };
|
|
std::atomic_bool m_isStarted { false };
|
|
std::atomic_bool m_loopbackOn { false };
|
|
std::atomic_bool m_enableAliased { true };
|
|
std::atomic_bool m_winCoInitialized { false }; //!< Windows only CoInitializeEx
|
|
std::atomic_bool m_integratedComUnit { false }; //!< is COM unit sychronized, integrated?
|
|
|
|
QDateTime m_startDateTimeUtc;
|
|
|
|
double m_inputVolumeDb = 0.0;
|
|
double m_outputVolumeDb = 0.0;
|
|
double m_outputVolume = 1.0;
|
|
double m_maxDbReadingInPTTInterval = -100;
|
|
|
|
QTimer *m_voiceServerTimer = nullptr;
|
|
QVector<StationDto> m_aliasedStations;
|
|
|
|
Audio::InputVolumeStreamArgs m_inputVolumeStream;
|
|
Audio::OutputVolumeStreamArgs m_outputVolumeStream;
|
|
|
|
void deferredInit();
|
|
void initTransceivers();
|
|
void connectWithContexts();
|
|
void fetchSimulatorSettings();
|
|
static bool hasContexts();
|
|
|
|
std::atomic_bool m_connectedWithContext { false };
|
|
|
|
mutable QMutex m_mutex { QMutex::Recursive };
|
|
mutable QMutex m_mutexInputStream { QMutex::Recursive };
|
|
mutable QMutex m_mutexOutputStream { QMutex::Recursive };
|
|
mutable QMutex m_mutexTransceivers { QMutex::Recursive };
|
|
mutable QMutex m_mutexCallsign { QMutex::Recursive };
|
|
mutable QMutex m_mutexConnection { QMutex::Recursive };
|
|
mutable QMutex m_mutexVolume { QMutex::Recursive };
|
|
mutable QMutex m_mutexSampleProviders { QMutex::Recursive };
|
|
|
|
};
|
|
} // ns
|
|
} // ns
|
|
} // ns
|
|
|
|
#endif
|