mlink/syntaloslink.h
mlink/syntaloslink.h
Namespaces
| Name |
|---|
| Syntalos |
Classes
| Name | |
|---|---|
| class | Syntalos::InputPortInfo Reference for an input port. |
| class | Syntalos::OutputPortInfo Reference for an output port. |
| class | Syntalos::SyntalosLink Connection to a Syntalos instance. |
Source code
/*
* Copyright (C) 2020-2026 Matthias Klumpp <matthias@tenstral.net>
*
* Licensed under the GNU Lesser General Public License Version 3
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include <QObject>
#include <datactl/syclock.h>
#include <datactl/datatypes.h>
#include <datactl/streammeta.h>
namespace Syntalos
{
class SyntalosLink;
struct OutputPortChangeRequest;
struct InputPortChangeRequest;
using LoadScriptFn = std::function<void(const std::string &script, const std::string &wdir)>;
using PrepareStartFn = std::function<void(const ByteVector &settings)>;
using StartFn = std::function<void()>;
using StopFn = std::function<void()>;
using ShutdownFn = std::function<void()>;
using NewDataRawFn = std::function<void(const void *data, size_t size)>;
using ShowSettingsFn = std::function<void(const ByteVector &settings)>;
using ShowDisplayFn = std::function<void(void)>;
class InputPortInfo
{
public:
std::string id() const;
int dataTypeId() const;
std::string title() const;
MetaStringMap metadata() const;
void setNewDataRawCallback(NewDataRawFn callback);
void setThrottleItemsPerSec(uint itemsPerSec);
[[nodiscard]] std::optional<MetaValue> metadataValue(const std::string &key) const;
[[nodiscard]] MetaValue metadataValueOr(const std::string &key, const MetaValue &defaultVal) const;
template<typename T>
[[nodiscard]] T metadataValueOr(const std::string &key, T fallback) const
{
return metadata().valueOr<T>(key, std::move(fallback));
}
private:
friend SyntalosLink;
explicit InputPortInfo(const InputPortChangeRequest &pc);
private:
class Private;
Q_DISABLE_COPY(InputPortInfo)
std::unique_ptr<Private> d;
};
class OutputPortInfo
{
public:
std::string id() const;
int dataTypeId() const;
void setMetadataVar(const std::string &key, const MetaValue &value);
private:
friend SyntalosLink;
explicit OutputPortInfo(const OutputPortChangeRequest &pc);
private:
class Private;
Q_DISABLE_COPY(OutputPortInfo)
std::unique_ptr<Private> d;
};
template<typename T>
requires std::derived_from<T, BaseDataType>
T streamDataFromRawMemory(const void *data, size_t size)
{
return T::fromMemory(data, size);
}
class SyntalosLink
{
public:
~SyntalosLink();
SyntalosLink(const SyntalosLink &) = delete;
SyntalosLink &operator=(const SyntalosLink &) = delete;
[[nodiscard]] std::string instanceId() const;
void raiseError(const std::string &message);
void raiseError(const std::string &title, const std::string &message);
void setLoadScriptCallback(LoadScriptFn callback);
void setPrepareStartCallback(PrepareStartFn callback);
void setStartCallback(StartFn callback);
void setStopCallback(StopFn callback);
void setShutdownCallback(ShutdownFn callback);
[[nodiscard]] SyncTimer *timer() const;
void awaitData(int timeoutUsec = -1, const std::function<void()> &eventFn = nullptr);
void awaitDataForever(const std::function<void()> &eventFn = nullptr, int intervalUsec = 125 * 1000);
[[nodiscard]] ModuleState state() const;
void setState(ModuleState state);
[[nodiscard]] bool isShutdownPending() const;
void setStatusMessage(const std::string &message);
int maxRealtimePriority() const;
void setSettingsData(const ByteVector &data);
void setShowSettingsCallback(ShowSettingsFn callback);
void setShowDisplayCallback(ShowDisplayFn callback);
[[nodiscard]] std::vector<std::shared_ptr<InputPortInfo>> inputPorts() const;
[[nodiscard]] std::vector<std::shared_ptr<OutputPortInfo>> outputPorts() const;
std::shared_ptr<InputPortInfo> registerInputPort(
const std::string &id,
const std::string &title,
const std::string &dataTypeName);
std::shared_ptr<OutputPortInfo> registerOutputPort(
const std::string &id,
const std::string &title,
const std::string &dataTypeName,
const MetaStringMap &metadata = {});
void updateInputPort(const std::shared_ptr<InputPortInfo> &iport);
void updateOutputPort(const std::shared_ptr<OutputPortInfo> &oport);
void removeInputPort(const std::shared_ptr<InputPortInfo> &iport);
void removeOutputPort(const std::shared_ptr<OutputPortInfo> &oport);
void resetPorts();
bool submitOutput(const std::shared_ptr<OutputPortInfo> &oport, const BaseDataType &data);
private:
explicit SyntalosLink(const std::string &instanceId);
friend std::unique_ptr<SyntalosLink> initSyntalosModuleLink();
private:
class Private;
std::unique_ptr<Private> d;
void processPendingControl();
};
std::unique_ptr<SyntalosLink> initSyntalosModuleLink();
} // namespace Syntalos
Updated on 2026-04-20 at 00:59:18 +0000