diff --git a/CHANGELOG.md b/CHANGELOG.md index a4a901b5..252a91a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,6 +31,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 diff --git a/include/api/JsonAPI.h b/include/api/JsonAPI.h index a5a54065..7b267e4a 100644 --- a/include/api/JsonAPI.h +++ b/include/api/JsonAPI.h @@ -285,6 +285,25 @@ private: /// 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: // The JsonCallbacks instance which handles data subscription/notifications QSharedPointer _jsonCB; + + }; diff --git a/include/api/JsonApiCommand.h b/include/api/JsonApiCommand.h index 4345b56a..9d31d5f7 100644 --- a/include/api/JsonApiCommand.h +++ b/include/api/JsonApiCommand.h @@ -23,6 +23,7 @@ public: Image, InputSource, Instance, + InstanceData, LedColors, LedDevice, Logging, @@ -53,6 +54,7 @@ public: 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 @@ public: Discover, GetConfig, GetConfigOld, + GetImageSnapshot, GetInfo, + GetLedSnapshot, GetPendingTokenRequests, GetProperties, GetSchema, @@ -136,7 +140,9 @@ public: 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,9 @@ public: { {"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", ""}, { Command::InstanceData, SubCommand::Empty, Authorization::Yes, InstanceCmd::Yes, 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} }, diff --git a/libsrc/api/JSONRPC_schema/schema-instancedata.json b/libsrc/api/JSONRPC_schema/schema-instancedata.json new file mode 100644 index 00000000..a49f0348 --- /dev/null +++ b/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 + }, + "filetype" : { + "type" : "string", + "enum" : ["BMP","JPG","PNG"] + }, + "tan" : { + "type" : "integer" + } + }, + "additionalProperties": false +} diff --git a/libsrc/api/JSONRPC_schema/schema.json b/libsrc/api/JSONRPC_schema/schema.json index 4f742b2b..327f18b8 100644 --- a/libsrc/api/JSONRPC_schema/schema.json +++ b/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" ] } } } diff --git a/libsrc/api/JSONRPC_schemas.qrc b/libsrc/api/JSONRPC_schemas.qrc index 60e1c171..c36b76ac 100644 --- a/libsrc/api/JSONRPC_schemas.qrc +++ b/libsrc/api/JSONRPC_schemas.qrc @@ -20,6 +20,7 @@ JSONRPC_schema/schema-videomode.json JSONRPC_schema/schema-authorize.json JSONRPC_schema/schema-instance.json + JSONRPC_schema/schema-instancedata.json JSONRPC_schema/schema-leddevice.json JSONRPC_schema/schema-inputsource.json JSONRPC_schema/schema-service.json diff --git a/libsrc/api/JsonAPI.cpp b/libsrc/api/JsonAPI.cpp index 96dc365d..8e54729d 100644 --- a/libsrc/api/JsonAPI.cpp +++ b/libsrc/api/JsonAPI.cpp @@ -386,6 +386,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 +401,74 @@ void JsonAPI::handleCommand(const JsonApiCommand& cmd, const QJsonObject &messag } } +void JsonAPI::handleGetImageSnapshotCommand(const QJsonObject &message, const JsonApiCommand &cmd) +{ + QString replyMsg; + QString filetype = message["filetype"].toString(); + const PriorityMuxer::InputInfo priorityInfo = _hyperion->getPriorityInfo(_hyperion->getCurrentPriority()); + Image image = priorityInfo.image; + QImage snapshot(reinterpret_cast(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, filetype.toUtf8().constData())) + { + replyMsg = QString("Failed to create snapshot of the current image in %1 format").arg(filetype); + sendErrorReply(replyMsg, cmd); + return; + } + QByteArray base64Image = byteArray.toBase64(); + + QJsonObject info; + info["format"] = filetype; + info["width"] = image.width(); + info["height"] = image.height(); + info["data"] = QString::fromLatin1(base64Image.data()); + sendSuccessDataReply(info, cmd); +} + +void JsonAPI::handleGetLedSnapshotCommand(const QJsonObject &message, const JsonApiCommand &cmd) +{ + QString replyMsg; + const PriorityMuxer::InputInfo priorityInfo = _hyperion->getPriorityInfo(_hyperion->getCurrentPriority()); + const std::vector ledColors = _hyperion->getImageProcessor()->process(priorityInfo.image); + if (ledColors.empty()) + { + replyMsg = "No led colors available"; + sendErrorReply(replyMsg, cmd); + return; + } + QJsonArray ledColorsArray; + for (const auto &color : ledColors) + { + QJsonArray rgbArray; + rgbArray.append(color.red); + rgbArray.append(color.green); + rgbArray.append(color.blue); + ledColorsArray.append(rgbArray); + } + QJsonObject info; + info["leds"] = ledColorsArray; + sendSuccessDataReply(info, cmd); +} + +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);