1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-23 08:28:36 -05:00
sdrangel/sdrbase/device/deviceapi.cpp
2019-05-09 17:27:12 +02:00

712 lines
22 KiB
C++

///////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2019 Edouard Griffiths, F4EXB //
// //
// 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 as 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 V3 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/>. //
///////////////////////////////////////////////////////////////////////////////////
#include "plugin/plugininstancegui.h"
#include "plugin/plugininterface.h"
#include "dsp/dspdevicesourceengine.h"
#include "dsp/dspdevicesinkengine.h"
#include "dsp/dspengine.h"
#include "dsp/devicesamplesource.h"
#include "dsp/devicesamplesink.h"
#include "settings/preset.h"
#include "channel/channelapi.h"
#include "deviceapi.h"
DeviceAPI::DeviceAPI(
StreamType streamType,
int deviceTabIndex,
DSPDeviceSourceEngine *deviceSourceEngine,
DSPDeviceSinkEngine *deviceSinkEngine
) :
m_streamType(streamType),
m_deviceTabIndex(deviceTabIndex),
m_nbItems(1),
m_itemIndex(0),
m_pluginInterface(0),
m_masterTimer(DSPEngine::instance()->getMasterTimer()),
m_samplingDeviceSequence(0),
m_samplingDevicePluginInstanceUI(0),
m_buddySharedPtr(0),
m_isBuddyLeader(false),
m_deviceSourceEngine(deviceSourceEngine),
m_deviceSinkEngine(deviceSinkEngine)
{
}
DeviceAPI::~DeviceAPI()
{
}
void DeviceAPI::addAncillarySink(BasebandSampleSink *sink)
{
if (m_deviceSourceEngine) {
m_deviceSourceEngine->addSink(sink);
} else if (m_deviceSinkEngine) {
m_deviceSinkEngine->addSpectrumSink(sink);
}
}
void DeviceAPI::removeAncillarySink(BasebandSampleSink* sink)
{
if (m_deviceSourceEngine) {
m_deviceSourceEngine->removeSink(sink);
} else if (m_deviceSinkEngine) {
m_deviceSinkEngine->removeSpectrumSink(sink);
}
}
void DeviceAPI::addChannelSink(ThreadedBasebandSampleSink* sink, int streamIndex)
{
(void) streamIndex;
if (m_deviceSourceEngine) {
m_deviceSourceEngine->addThreadedSink(sink);
}
}
void DeviceAPI::removeChannelSink(ThreadedBasebandSampleSink* sink, int streamIndex)
{
(void) streamIndex;
if (m_deviceSourceEngine) {
m_deviceSourceEngine->removeThreadedSink(sink);
}
}
void DeviceAPI::addChannelSource(ThreadedBasebandSampleSource* source, int streamIndex)
{
(void) streamIndex;
if (m_deviceSinkEngine) {
m_deviceSinkEngine->addThreadedSource(source);
}
}
void DeviceAPI::removeChannelSource(ThreadedBasebandSampleSource* source, int streamIndex)
{
(void) streamIndex;
if (m_deviceSinkEngine) {
m_deviceSinkEngine->removeThreadedSource(source);
}
}
void DeviceAPI::addChannelSinkAPI(ChannelAPI* channelAPI, int streamIndex)
{
(void) streamIndex;
m_channelSinkAPIs.append(channelAPI);
renumerateChannels();
}
void DeviceAPI::removeChannelSinkAPI(ChannelAPI* channelAPI, int streamIndex)
{
(void) streamIndex;
if (m_channelSinkAPIs.removeOne(channelAPI)) {
renumerateChannels();
}
channelAPI->setIndexInDeviceSet(-1);
}
void DeviceAPI::addChannelSourceAPI(ChannelAPI* channelAPI, int streamIndex)
{
(void) streamIndex;
m_channelSourceAPIs.append(channelAPI);
renumerateChannels();
}
void DeviceAPI::removeChannelSourceAPI(ChannelAPI* channelAPI, int streamIndex)
{
(void) streamIndex;
if (m_channelSourceAPIs.removeOne(channelAPI)) {
renumerateChannels();
}
channelAPI->setIndexInDeviceSet(-1);
}
void DeviceAPI::setSampleSource(DeviceSampleSource* source)
{
if (m_deviceSourceEngine) {
m_deviceSourceEngine->setSource(source);
}
}
void DeviceAPI::setSampleSink(DeviceSampleSink* sink)
{
if (m_deviceSinkEngine) {
m_deviceSinkEngine->setSink(sink);
}
}
DeviceSampleSource *DeviceAPI::getSampleSource()
{
if (m_deviceSourceEngine) {
return m_deviceSourceEngine->getSource();
} else {
return nullptr;
}
}
DeviceSampleSink *DeviceAPI::getSampleSink()
{
if (m_deviceSinkEngine) {
return m_deviceSinkEngine->getSink();
} else {
return nullptr;
}
}
bool DeviceAPI::initDeviceEngine()
{
if (m_deviceSourceEngine) {
return m_deviceSourceEngine->initAcquisition();
} else if (m_deviceSinkEngine) {
return m_deviceSinkEngine->initGeneration();
} else {
return false; // TODO: not implemented
}
}
bool DeviceAPI::startDeviceEngine()
{
if (m_deviceSourceEngine) {
return m_deviceSourceEngine->startAcquisition();
} else if (m_deviceSinkEngine) {
return m_deviceSinkEngine->startGeneration();
} else {
return false; // TODO: not implemented
}
}
void DeviceAPI::stopDeviceEngine()
{
if (m_deviceSourceEngine) {
m_deviceSourceEngine->stopAcquistion();
} else if (m_deviceSinkEngine) {
m_deviceSinkEngine->stopGeneration();
}
}
DeviceAPI::EngineState DeviceAPI::state() const
{
if (m_deviceSourceEngine) {
return (DeviceAPI::EngineState) m_deviceSourceEngine->state();
} else if (m_deviceSinkEngine) {
return (DeviceAPI::EngineState) m_deviceSinkEngine->state();
} else {
return StError; // TODO: not implemented
}
}
QString DeviceAPI::errorMessage()
{
if (m_deviceSourceEngine) {
return m_deviceSourceEngine->errorMessage();
} else if (m_deviceSinkEngine) {
return m_deviceSinkEngine->errorMessage();
} else {
return "Not implemented"; // TODO: not implemented
}
}
uint DeviceAPI::getDeviceUID() const
{
if (m_deviceSourceEngine) {
return m_deviceSourceEngine->getUID();
} else if (m_deviceSinkEngine) {
return m_deviceSinkEngine->getUID();
} else {
return 0; // TODO: not implemented
}
}
MessageQueue *DeviceAPI::getDeviceEngineInputMessageQueue()
{
if (m_deviceSourceEngine) {
return m_deviceSourceEngine->getInputMessageQueue();
} else if (m_deviceSinkEngine) {
return m_deviceSinkEngine->getInputMessageQueue();
} else {
return nullptr; // TODO: not implemented
}
}
MessageQueue *DeviceAPI::getSamplingDeviceInputMessageQueue()
{
if (m_deviceSourceEngine) {
return m_deviceSourceEngine->getSource()->getInputMessageQueue();
} else if (m_deviceSinkEngine) {
return m_deviceSinkEngine->getSink()->getInputMessageQueue();
} else {
return nullptr; // TODO: not implemented
}
}
MessageQueue *DeviceAPI::getSamplingDeviceGUIMessageQueue()
{
if (m_deviceSourceEngine) {
return m_deviceSourceEngine->getSource()->getMessageQueueToGUI();
} else if (m_deviceSinkEngine) {
return m_deviceSinkEngine->getSink()->getMessageQueueToGUI();
} else {
return nullptr; // TODO: not implemented
}
}
void DeviceAPI::configureCorrections(bool dcOffsetCorrection, bool iqImbalanceCorrection, int streamIndex)
{
(void) streamIndex;
if (m_deviceSourceEngine) {
m_deviceSourceEngine->configureCorrections(dcOffsetCorrection, iqImbalanceCorrection);
}
}
void DeviceAPI::setHardwareId(const QString& id)
{
m_hardwareId = id;
}
void DeviceAPI::setNbItems(uint32_t nbItems)
{
m_nbItems = nbItems;
}
void DeviceAPI::setItemIndex(uint32_t index)
{
m_itemIndex = index;
}
void DeviceAPI::setSamplingDevicePluginInterface(PluginInterface *iface)
{
m_pluginInterface = iface;
}
void DeviceAPI::setSamplingDevicePluginInstanceGUI(PluginInstanceGUI *gui)
{
m_samplingDevicePluginInstanceUI = gui;
}
void DeviceAPI::getDeviceEngineStateStr(QString& state)
{
if (m_deviceSourceEngine)
{
switch(m_deviceSourceEngine->state())
{
case DSPDeviceSourceEngine::StNotStarted:
state = "notStarted";
break;
case DSPDeviceSourceEngine::StIdle:
state = "idle";
break;
case DSPDeviceSourceEngine::StReady:
state = "ready";
break;
case DSPDeviceSourceEngine::StRunning:
state = "running";
break;
case DSPDeviceSourceEngine::StError:
state = "error";
break;
default:
state = "notStarted";
break;
}
}
else if (m_deviceSinkEngine)
{
switch(m_deviceSinkEngine->state())
{
case DSPDeviceSinkEngine::StNotStarted:
state = "notStarted";
break;
case DSPDeviceSinkEngine::StIdle:
state = "idle";
break;
case DSPDeviceSinkEngine::StReady:
state = "ready";
break;
case DSPDeviceSinkEngine::StRunning:
state = "running";
break;
case DSPDeviceSinkEngine::StError:
state = "error";
break;
default:
state = "notStarted";
break;
}
}
else
{
state = "notStarted";
}
}
ChannelAPI *DeviceAPI::getChanelSinkAPIAt(int index, int streamIndex)
{
(void) streamIndex;
if (m_streamType == StreamSingleRx)
{
if (index < m_channelSinkAPIs.size()) {
return m_channelSinkAPIs.at(index);
} else {
return nullptr;
}
}
else // TODO: not implemented
{
return nullptr;
}
}
ChannelAPI *DeviceAPI::getChanelSourceAPIAt(int index, int streamIndex)
{
(void) streamIndex;
if (m_streamType == StreamSingleTx)
{
if (index < m_channelSourceAPIs.size()) {
return m_channelSourceAPIs.at(index);
} else {
return nullptr;
}
}
else // TODO: not implemented
{
return nullptr;
}
}
void DeviceAPI::loadSamplingDeviceSettings(const Preset* preset)
{
if (m_deviceSourceEngine && (preset->isSourcePreset()))
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: Loading preset [%s | %s]", qPrintable(preset->getGroup()), qPrintable(preset->getDescription()));
const QByteArray* sourceConfig = preset->findBestDeviceConfig(m_samplingDeviceId, m_samplingDeviceSerial, m_samplingDeviceSequence);
qint64 centerFrequency = preset->getCenterFrequency();
qDebug("DeviceAPI::loadSamplingDeviceSettings: center frequency: %llu Hz", centerFrequency);
if (sourceConfig != 0)
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: deserializing source %s[%d]: %s",
qPrintable(m_samplingDeviceId), m_samplingDeviceSequence, qPrintable(m_samplingDeviceSerial));
if (m_samplingDevicePluginInstanceUI != 0) // GUI flavor
{
m_samplingDevicePluginInstanceUI->deserialize(*sourceConfig);
}
else if (m_deviceSourceEngine->getSource() != 0) // Server flavor
{
m_deviceSourceEngine->getSource()->deserialize(*sourceConfig);
}
else
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: deserializing no source");
}
}
else
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: source %s[%d]: %s not found",
qPrintable(m_samplingDeviceId), m_samplingDeviceSequence, qPrintable(m_samplingDeviceSerial));
}
// set center frequency anyway
if (m_samplingDevicePluginInstanceUI != 0) // GUI flavor
{
m_samplingDevicePluginInstanceUI->setCenterFrequency(centerFrequency);
}
else if (m_deviceSourceEngine->getSource() != 0) // Server flavor
{
m_deviceSourceEngine->getSource()->setCenterFrequency(centerFrequency);
}
else
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: no source");
}
}
else if (m_deviceSinkEngine && (!preset->isSourcePreset())) // TODO: refine preset stream type
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: Loading preset [%s | %s]", qPrintable(preset->getGroup()), qPrintable(preset->getDescription()));
const QByteArray* sinkConfig = preset->findBestDeviceConfig(m_samplingDeviceId, m_samplingDeviceSerial, m_samplingDeviceSequence);
qint64 centerFrequency = preset->getCenterFrequency();
qDebug("DeviceAPI::loadSamplingDeviceSettings: center frequency: %llu Hz", centerFrequency);
if (sinkConfig != 0)
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: deserializing sink %s[%d]: %s",
qPrintable(m_samplingDeviceId), m_samplingDeviceSequence, qPrintable(m_samplingDeviceSerial));
if (m_samplingDevicePluginInstanceUI != 0) // GUI flavor
{
m_samplingDevicePluginInstanceUI->deserialize(*sinkConfig);
m_samplingDevicePluginInstanceUI->setCenterFrequency(centerFrequency);
}
else if (m_deviceSinkEngine->getSink() != 0) // Server flavor
{
m_deviceSinkEngine->getSink()->deserialize(*sinkConfig);
m_deviceSinkEngine->getSink()->setCenterFrequency(centerFrequency);
}
else
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: no sink");
}
}
else
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: sink %s[%d]: %s not found",
qPrintable(m_samplingDeviceId), m_samplingDeviceSequence, qPrintable(m_samplingDeviceSerial));
}
}
else
{
qDebug("DeviceAPI::loadSamplingDeviceSettings: Loading preset [%s | %s] is not a suitable preset", qPrintable(preset->getGroup()), qPrintable(preset->getDescription()));
}
}
void DeviceAPI::saveSamplingDeviceSettings(Preset* preset)
{
if (m_deviceSourceEngine && (preset->isSourcePreset()))
{
qDebug("DeviceAPI::saveSamplingDeviceSettings: serializing source %s[%d]: %s",
qPrintable(m_samplingDeviceId), m_samplingDeviceSequence, qPrintable(m_samplingDeviceSerial));
if (m_samplingDevicePluginInstanceUI != 0)
{
preset->addOrUpdateDeviceConfig(m_samplingDeviceId, m_samplingDeviceSerial, m_samplingDeviceSequence, m_samplingDevicePluginInstanceUI->serialize());
preset->setCenterFrequency(m_samplingDevicePluginInstanceUI->getCenterFrequency());
}
else if (m_deviceSourceEngine->getSource() != 0)
{
preset->addOrUpdateDeviceConfig(m_samplingDeviceId, m_samplingDeviceSerial, m_samplingDeviceSequence, m_deviceSourceEngine->getSource()->serialize());
preset->setCenterFrequency(m_deviceSourceEngine->getSource()->getCenterFrequency());
}
else
{
qDebug("DeviceAPI::saveSamplingDeviceSettings: no source");
}
}
else if (m_deviceSinkEngine && (!preset->isSourcePreset())) // TODO: refine preset stream type
{
qDebug("DeviceAPI::saveSamplingDeviceSettings: serializing sink %s[%d]: %s",
qPrintable(m_samplingDeviceId), m_samplingDeviceSequence, qPrintable(m_samplingDeviceSerial));
if (m_samplingDevicePluginInstanceUI != 0) // GUI flavor
{
preset->addOrUpdateDeviceConfig(m_samplingDeviceId, m_samplingDeviceSerial, m_samplingDeviceSequence, m_deviceSinkEngine->getSink()->serialize());
preset->setCenterFrequency(m_deviceSinkEngine->getSink()->getCenterFrequency());
}
else if (m_deviceSinkEngine->getSink() != 0) // Server flavor
{
preset->addOrUpdateDeviceConfig(m_samplingDeviceId, m_samplingDeviceSerial, m_samplingDeviceSequence, m_deviceSinkEngine->getSink()->serialize());
preset->setCenterFrequency(m_deviceSinkEngine->getSink()->getCenterFrequency());
}
else
{
qDebug("DeviceAPI::saveSamplingDeviceSettings: no sink");
}
}
else
{
qDebug("DeviceAPI::saveSamplingDeviceSettings: not a suitable preset");
}
}
void DeviceAPI::addSourceBuddy(DeviceAPI* buddy)
{
if (buddy->m_streamType != StreamSingleRx)
{
qDebug("DeviceAPI::addSourceBuddy: buddy %s(%s) is not of single Rx type",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()));
return;
}
m_sourceBuddies.push_back(buddy);
if (m_streamType == StreamSingleRx) {
buddy->m_sourceBuddies.push_back(this); // this is a source
} else if (m_streamType == StreamSingleTx) {
buddy->m_sinkBuddies.push_back(this); // this is a sink
} else {
qDebug("DeviceAPI::addSourceBuddy: not relevant if this is not a single Rx or Tx");
return;
}
qDebug("DeviceAPI::addSourceBuddy: added buddy %s(%s) [%llu] <-> [%llu]",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()),
(quint64) buddy,
(quint64) this);
}
void DeviceAPI::addSinkBuddy(DeviceAPI* buddy)
{
if (buddy->m_streamType != StreamSingleTx)
{
qDebug("DeviceAPI::addSinkBuddy: buddy %s(%s) is not of single Tx type",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()));
return;
}
m_sinkBuddies.push_back(buddy);
if (m_streamType == StreamSingleRx) {
buddy->m_sourceBuddies.push_back(this); // this is a source
} else if (m_streamType == StreamSingleTx) {
buddy->m_sinkBuddies.push_back(this); // this is a sink
} else {
qDebug("DeviceAPI::addSinkBuddy: not relevant if this is not a single Rx or Tx");
return;
}
qDebug("DeviceAPI::addSinkBuddy: added buddy %s(%s) [%llu] <-> [%llu]",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()),
(quint64) buddy,
(quint64) this);
}
void DeviceAPI::removeSourceBuddy(DeviceAPI* buddy)
{
if (buddy->m_streamType != StreamSingleRx)
{
qDebug("DeviceAPI::removeSourceBuddy: buddy %s(%s) is not of single Rx type",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()));
return;
}
std::vector<DeviceAPI*>::iterator it = m_sourceBuddies.begin();
for (;it != m_sourceBuddies.end(); ++it)
{
if (*it == buddy)
{
qDebug("DeviceAPI::removeSourceBuddy: buddy %s(%s) [%llu] removed from the list of [%llu]",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()),
(quint64) (*it),
(quint64) this);
m_sourceBuddies.erase(it);
return;
}
}
qDebug("DeviceAPI::removeSourceBuddy: buddy %s(%s) [%llu] not found in the list of [%llu]",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()),
(quint64) buddy,
(quint64) this);
}
void DeviceAPI::removeSinkBuddy(DeviceAPI* buddy)
{
if (buddy->m_streamType != StreamSingleTx)
{
qDebug("DeviceAPI::removeSinkBuddy: buddy %s(%s) is not of single Tx type",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()));
return;
}
std::vector<DeviceAPI*>::iterator it = m_sinkBuddies.begin();
for (;it != m_sinkBuddies.end(); ++it)
{
if (*it == buddy)
{
qDebug("DeviceAPI::removeSinkBuddy: buddy %s(%s) [%llu] removed from the list of [%llu]",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()),
(quint64) (*it),
(quint64) this);
m_sourceBuddies.erase(it);
return;
}
}
qDebug("DeviceAPI::removeSourceBuddy: buddy %s(%s) [%llu] not found in the list of [%llu]",
qPrintable(buddy->getHardwareId()),
qPrintable(buddy->getSamplingDeviceSerial()),
(quint64) buddy,
(quint64) this);
}
void DeviceAPI::clearBuddiesLists()
{
std::vector<DeviceAPI*>::iterator itSource = m_sourceBuddies.begin();
std::vector<DeviceAPI*>::iterator itSink = m_sinkBuddies.begin();
bool leaderElected = false;
for (;itSource != m_sourceBuddies.end(); ++itSource)
{
if (isBuddyLeader() && !leaderElected)
{
(*itSource)->setBuddyLeader(true);
leaderElected = true;
}
(*itSource)->removeSinkBuddy(this);
}
m_sourceBuddies.clear();
for (;itSink != m_sinkBuddies.end(); ++itSink)
{
if (isBuddyLeader() && !leaderElected)
{
(*itSink)->setBuddyLeader(true);
leaderElected = true;
}
(*itSink)->removeSinkBuddy(this);
}
m_sinkBuddies.clear();
}
void DeviceAPI::renumerateChannels()
{
if (m_streamType == StreamSingleRx)
{
for (int i = 0; i < m_channelSinkAPIs.size(); ++i)
{
m_channelSinkAPIs.at(i)->setIndexInDeviceSet(i);
m_channelSinkAPIs.at(i)->setDeviceSetIndex(m_deviceTabIndex);
m_channelSinkAPIs.at(i)->setDeviceAPI(this);
}
}
else if (m_streamType == StreamSingleTx)
{
for (int i = 0; i < m_channelSourceAPIs.size(); ++i)
{
m_channelSourceAPIs.at(i)->setIndexInDeviceSet(i);
m_channelSourceAPIs.at(i)->setDeviceSetIndex(m_deviceTabIndex);
m_channelSourceAPIs.at(i)->setDeviceAPI(this);
}
}
}