Add JSON-API support for requesting image snapshots (#1839)

* Implemented a method to receive and store a snapshot of the current image via JSON.

* Updated changelog for the implemented method to receive a snapshot of the current image via JSON-API

* Updated behaviour of the API to handle instance data requests such as getImageSnapshot and getLedSnapshot.

* fix formatting of JsonApi.cpp

* removed unnecessary filetype checks

* clean up code

* Update CHANGELOG.md

* Update JsonAPI.cpp

* Update schema-instancedata.json

* Update JsonApiCommand.h

---------

Co-authored-by: LordGrey <[email protected]>

Author: xIronic

CHANGELOG.md

@@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support direct or multiple instance addressing via single requests (#809)
 - Support of `serverinfo` subcommands: `getInfo, subscribe, unsubscribe, getSubscriptions, getSubscriptionCommands`
 - [Overview](https://github.com/hyperion-project/hyperion.ng/blob/API_Auth/doc/development/JSON-API%20_Commands_Overview.md) of API commands and subscription updates
+- Support for requesting instance-data via JSON-API. Implemented requesting the current image in different formats or led colors.
 
 ### Changed
 

include/api/JsonAPI.h

@@ -285,6 +285,25 @@ private slots:
 	///
 	void handleSystemCommand(const QJsonObject &message, const JsonApiCommand& cmd);
 
+	///  Handle an incoming data request message
+	/// 
+	/// @param message the incoming message
+	/// 
+	void handleInstanceDataCommand(const QJsonObject &message, const JsonApiCommand& cmd);
+
+	/// Handle an incoming JSON message to request the current image
+	///
+	/// @param message the incoming message
+	///
+	void handleGetImageSnapshotCommand(const QJsonObject &message, const JsonApiCommand& cmd);
+
+	/// Handle an incoming JSON message to request the current led colors
+	///
+	/// @param message the incoming message
+	///
+	void handleGetLedSnapshotCommand(const QJsonObject &message, const JsonApiCommand& cmd);
+
+
 	void applyColorAdjustments(const QJsonObject &adjustment, ColorAdjustment *colorAdjustment);
 	void applyColorAdjustment(const QString &colorName, const QJsonObject &adjustment, RgbChannelAdjustment &rgbAdjustment);
 	void applyGammaTransform(const QString &transformName, const QJsonObject &adjustment, RgbTransform &rgbTransform, char channel);
@@ -404,4 +423,6 @@ private slots:
 	// The JsonCallbacks instance which handles data subscription/notifications
 	QSharedPointer<JsonCallbacks> _jsonCB;
 
+
+
 };

include/api/JsonApiCommand.h

@@ -23,6 +23,7 @@ class Command {
 		Image,
 		InputSource,
 		Instance,
+		InstanceData,
 		LedColors,
 		LedDevice,
 		Logging,
@@ -53,6 +54,7 @@ class Command {
 		case Image: return "image";
 		case InputSource: return "inputsource";
 		case Instance: return "instance";
+		case InstanceData: return "instance-data";
 		case LedColors: return "ledcolors";
 		case LedDevice: return "leddevice";
 		case Logging: return "logging";
@@ -85,7 +87,9 @@ class SubCommand {
 		Discover,
 		GetConfig,
 		GetConfigOld,
+		GetImageSnapshot,
 		GetInfo,
+		GetLedSnapshot,
 		GetPendingTokenRequests,
 		GetProperties,
 		GetSchema,
@@ -136,7 +140,9 @@ class SubCommand {
 		case Discover: return "discover";
 		case GetConfig: return "getconfig";
 		case GetConfigOld: return "getconfig-old";
+		case GetImageSnapshot: return "getImageSnapshot";
 		case GetInfo: return "getInfo";
+		case GetLedSnapshot: return "getLedSnapshot";
 		case GetPendingTokenRequests: return "getPendingTokenRequests";
 		case GetProperties: return "getProperties";
 		case GetSchema: return "getschema";
@@ -294,6 +300,8 @@ class ApiCommandRegister {
 			{ {"instance", "startInstance"}, { Command::Instance, SubCommand::StartInstance, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} },
 			{ {"instance", "stopInstance"}, { Command::Instance, SubCommand::StopInstance, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} },
 			{ {"instance", "switchTo"}, { Command::Instance, SubCommand::SwitchTo, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} },
+			{ {"instance-data", "getImageSnapshot"}, { Command::InstanceData, SubCommand::GetImageSnapshot, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} },
+			{ {"instance-data", "getLedSnapshot"}, { Command::InstanceData, SubCommand::GetLedSnapshot, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes } },
 			{ {"ledcolors", "imagestream-start"}, { Command::LedColors, SubCommand::ImageStreamStart, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} },
 			{ {"ledcolors", "imagestream-stop"}, { Command::LedColors, SubCommand::ImageStreamStop, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} },
 			{ {"ledcolors", "ledstream-start"}, { Command::LedColors, SubCommand::LedStreamStart, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} },

libsrc/api/JSONRPC_schema/schema-instancedata.json

@@ -0,0 +1,29 @@
+{
+	"type":"object",
+	"required":true,
+	"properties":{
+		"command": {
+			"type" : "string",
+			"required" : true,
+			"enum" : ["instance-data"]
+		},
+		"subcommand" : {
+			"type" : "string",
+			"required" : true,
+			"enum" : ["getImageSnapshot","getLedSnapshot"]
+		},
+		"instance" : {
+			"type": "integer",
+			"minimum": 0,
+			"maximum": 255
+		},
+		"format" : {
+			"type" : "string",
+			"enum" : ["BMP","JPG","PNG"]
+		},
+		"tan" : {
+			"type" : "integer"
+		}
+	},
+	"additionalProperties": false
+}

libsrc/api/JSONRPC_schema/schema.json

@@ -5,7 +5,7 @@
 		"command": {
 			"type" : "string",
 			"required" : true,
-			"enum": [ "color", "image", "effect", "create-effect", "delete-effect", "serverinfo", "clear", "clearall", "adjustment", "sourceselect", "config", "componentstate", "ledcolors", "logging", "processing", "sysinfo", "videomode", "authorize", "instance", "leddevice", "inputsource", "service", "system", "transform", "correction", "temperature" ]
+			"enum": [ "color", "image", "effect", "create-effect", "delete-effect", "serverinfo", "clear", "clearall", "adjustment", "sourceselect", "config", "componentstate", "ledcolors", "logging", "processing", "sysinfo", "videomode", "authorize", "instance", "instance-data", "leddevice", "inputsource", "service", "system", "transform", "correction", "temperature" ]
 		}
 	}
 }

libsrc/api/JSONRPC_schemas.qrc

@@ -20,6 +20,7 @@
         <file alias="schema-videomode">JSONRPC_schema/schema-videomode.json</file>
         <file alias="schema-authorize">JSONRPC_schema/schema-authorize.json</file>
         <file alias="schema-instance">JSONRPC_schema/schema-instance.json</file>
+        <file alias="schema-instance-data">JSONRPC_schema/schema-instancedata.json</file>
         <file alias="schema-leddevice">JSONRPC_schema/schema-leddevice.json</file>
         <file alias="schema-inputsource">JSONRPC_schema/schema-inputsource.json</file>
         <file alias="schema-service">JSONRPC_schema/schema-service.json</file>

libsrc/api/JsonAPI.cpp

@@ -13,6 +13,7 @@
 #include <QMultiMap>
 #include <QRegularExpression>
 #include <QStringList>
+#include <QEventLoop>
 
 // hyperion includes
 #include <leddevice/LedDeviceWrapper.h>
@@ -60,6 +61,7 @@ using namespace hyperion;
 namespace {
 
 constexpr std::chrono::milliseconds NEW_TOKEN_REQUEST_TIMEOUT{ 180000 };
+constexpr std::chrono::milliseconds LED_DATA_TIMEOUT { 1000 };
 
 const char TOKEN_TAG[] = "token";
 constexpr int TOKEN_TAG_LENGTH = sizeof(TOKEN_TAG) - 1;
@@ -386,6 +388,9 @@ void JsonAPI::handleCommand(const JsonApiCommand& cmd, const QJsonObject &messag
 	case Command::ClearAll:
 		handleClearallCommand(message, cmd);
 	break;
+	case Command::InstanceData:
+		handleInstanceDataCommand(message, cmd);
+		break;
 		// BEGIN | The following commands are deprecated but used to ensure backward compatibility with Hyperion Classic remote control
 	case Command::Transform:
 	case Command::Correction:
@@ -398,6 +403,99 @@ void JsonAPI::handleCommand(const JsonApiCommand& cmd, const QJsonObject &messag
 	}
 }
 
+void JsonAPI::handleGetImageSnapshotCommand(const QJsonObject &message, const JsonApiCommand &cmd)
+{
+	QString replyMsg;
+	QString imageFormat = message["format"].toString("PNG");
+	const PriorityMuxer::InputInfo priorityInfo = _hyperion->getPriorityInfo(_hyperion->getCurrentPriority());
+	Image<ColorRgb> image = priorityInfo.image;
+	QImage snapshot(reinterpret_cast<const uchar *>(image.memptr()), image.width(), image.height(), qsizetype(3) * image.width(), QImage::Format_RGB888);
+	QByteArray byteArray;
+
+	QBuffer buffer{&byteArray};
+	buffer.open(QIODevice::WriteOnly);
+	if (!snapshot.save(&buffer, imageFormat.toUtf8().constData()))
+	{
+		replyMsg = QString("Failed to create snapshot of the current image in %1 format").arg(imageFormat);
+		sendErrorReply(replyMsg, cmd);
+		return;
+	}
+	QByteArray base64Image = byteArray.toBase64();
+
+	QJsonObject info;
+	info["format"] = imageFormat;
+	info["width"] = image.width();
+	info["height"] = image.height();
+	info["data"] = base64Image.constData();
+	sendSuccessDataReply(info, cmd);
+}
+
+void JsonAPI::handleGetLedSnapshotCommand(const QJsonObject& /*message*/, const JsonApiCommand &cmd)
+{
+	std::vector<ColorRgb> ledColors;
+	QEventLoop loop;
+	QTimer timer;
+
+	// Timeout handling (ensuring loop quits on timeout)
+	timer.setSingleShot(true);
+	connect(&timer, &QTimer::timeout, this, [&loop]() {
+		loop.quit();  // Stop waiting if timeout occurs
+	});
+
+	// Capture LED colors when the LED data signal is emitted (execute only once)
+	std::unique_ptr<QObject> context{new QObject};
+	QObject* pcontext = context.get();
+	connect(_hyperion, &Hyperion::ledDeviceData, pcontext,
+			[this, &loop, context = std::move(context), &ledColors, cmd](std::vector<ColorRgb> ledColorsUpdate) mutable {
+		ledColors = ledColorsUpdate;
+		loop.quit();  // ✅ Ensure the event loop quits immediately when data is received
+
+		QJsonArray ledRgbColorsArray;
+		for (const auto &color : ledColors)
+		{
+			QJsonArray rgbArray;
+			rgbArray.append(color.red);
+			rgbArray.append(color.green);
+			rgbArray.append(color.blue);
+			ledRgbColorsArray.append(rgbArray);
+		}
+		QJsonObject info;
+		info["leds"] = ledRgbColorsArray;
+
+		sendSuccessDataReply(info, cmd);
+		context.reset();
+	}
+	);
+
+	// Start the timer and wait for either the signal or timeout
+	timer.start(LED_DATA_TIMEOUT);
+	loop.exec();
+
+	// If no data was received, return an error
+	if (ledColors.empty())
+	{
+		QString replyMsg = QString("No LED color data available, i.e.no LED update was done within the last %1 ms").arg(LED_DATA_TIMEOUT.count());
+		sendErrorReply(replyMsg, cmd);
+		return;
+	}
+}
+
+void JsonAPI::handleInstanceDataCommand(const QJsonObject &message, const JsonApiCommand &cmd)
+{
+
+	switch (cmd.subCommand)
+	{
+	case SubCommand::GetImageSnapshot:
+		handleGetImageSnapshotCommand(message, cmd);
+		break;
+	case SubCommand::GetLedSnapshot:
+		handleGetLedSnapshotCommand(message, cmd);
+		break;
+	default:
+	break;
+	}
+}
+
 void JsonAPI::handleColorCommand(const QJsonObject &message, const JsonApiCommand& cmd)
 {
 	emit forwardJsonMessage(message);