Patch Detail
Show a patch.
GET /api/1.1/patches/22138/?format=api
{ "id": 22138, "url": "https://patchwork.libcamera.org/api/1.1/patches/22138/?format=api", "web_url": "https://patchwork.libcamera.org/patch/22138/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20241129091916.298359-4-paul.elder@ideasonboard.com>", "date": "2024-11-29T09:19:15", "name": "[v3,3/4] libcamera: controls: Add support for querying direction information", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "6ad2dfb1350eff8d776fb194d66dc6414158f879", "submitter": { "id": 17, "url": "https://patchwork.libcamera.org/api/1.1/people/17/?format=api", "name": "Paul Elder", "email": "paul.elder@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/22138/mbox/", "series": [ { "id": 4833, "url": "https://patchwork.libcamera.org/api/1.1/series/4833/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4833", "date": "2024-11-29T09:19:12", "name": "Add direction field to ControlId", "version": 3, "mbox": "https://patchwork.libcamera.org/series/4833/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/22138/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/22138/checks/", "tags": {}, "headers": { "Return-Path": "<libcamera-devel-bounces@lists.libcamera.org>", "X-Original-To": "parsemail@patchwork.libcamera.org", "Delivered-To": "parsemail@patchwork.libcamera.org", "Received": [ "from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id D5940C3220\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 29 Nov 2024 09:19:35 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id EBAF266031;\n\tFri, 29 Nov 2024 10:19:34 +0100 (CET)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 1FC5C66010\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 29 Nov 2024 10:19:31 +0100 (CET)", "from neptunite.flets-east.jp (unknown\n\t[IPv6:2404:7a81:160:2100:b147:f3c:c4e8:a42a])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id D201214A4;\n\tFri, 29 Nov 2024 10:19:05 +0100 (CET)" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"vKROprbO\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1732871946;\n\tbh=+pwAB2z14/zqTUFrMkZmz9mf+035Fvb/f8KojWT59G0=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=vKROprbOstQmKTlw6U7yPxmTRojS7OdvLt4FB8SFqj9Aa2Cn/bzjaCu2oilukbmrH\n\t5ag7P0Nvry0wm59u0Ex4RPK8S3lwQr0ENhiK9SUywOiPcAd/zSw2V1u5tUowFAM8JK\n\tvaE63Fz8jYQHnuqhHQX+jCUfZqFyNMEZNbBxpQ44=", "From": "Paul Elder <paul.elder@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Paul Elder <paul.elder@ideasonboard.com>", "Subject": "[PATCH v3 3/4] libcamera: controls: Add support for querying\n\tdirection information", "Date": "Fri, 29 Nov 2024 18:19:15 +0900", "Message-Id": "<20241129091916.298359-4-paul.elder@ideasonboard.com>", "X-Mailer": "git-send-email 2.39.2", "In-Reply-To": "<20241129091916.298359-1-paul.elder@ideasonboard.com>", "References": "<20241129091916.298359-1-paul.elder@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "libcamera-devel@lists.libcamera.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "<libcamera-devel.lists.libcamera.org>", "List-Unsubscribe": "<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>", "List-Archive": "<https://lists.libcamera.org/pipermail/libcamera-devel/>", "List-Post": "<mailto:libcamera-devel@lists.libcamera.org>", "List-Help": "<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>", "List-Subscribe": "<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>", "Errors-To": "libcamera-devel-bounces@lists.libcamera.org", "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>" }, "content": "Add support to ControlId for querying direction information. This allows\napplications to query whether a ControlId is meant for being set in\ncontrols or to be returned in metadata or both. This also has a side\neffect of properly encoding this information, as previously it was only\nmentioned losely and inconsistently in the control id definition.\n\nSigned-off-by: Paul Elder <paul.elder@ideasonboard.com>\n\n---\nChanges in v3:\n- make direction parameter to ControlId and Control consutrctors\n mandatory\n - this entails expanding the control serializer/deserializer for\n V4L2Device and ControlSerializer to properly handle the direction\n - also the constructor parameters have to be reordered, compared to\n the last vesrion at least\n\nChanges in v2:\n- simplify code\n---\n include/libcamera/controls.h | 19 ++++++++++--\n include/libcamera/ipa/ipa_controls.h | 3 +-\n src/libcamera/control_ids.cpp.in | 4 +--\n src/libcamera/control_serializer.cpp | 11 ++++++-\n src/libcamera/controls.cpp | 45 ++++++++++++++++++++++++++--\n src/libcamera/v4l2_device.cpp | 10 ++++++-\n 6 files changed, 82 insertions(+), 10 deletions(-)", "diff": "diff --git a/include/libcamera/controls.h b/include/libcamera/controls.h\nindex 3cfe2de5973c..13bb914badbf 100644\n--- a/include/libcamera/controls.h\n+++ b/include/libcamera/controls.h\n@@ -17,6 +17,7 @@\n #include <vector>\n \n #include <libcamera/base/class.h>\n+#include <libcamera/base/flags.h>\n #include <libcamera/base/span.h>\n \n #include <libcamera/geometry.h>\n@@ -235,14 +236,24 @@ private:\n class ControlId\n {\n public:\n+\tenum class Direction {\n+\t\tIn = (1 << 0),\n+\t\tOut = (1 << 1),\n+\t};\n+\n+\tusing DirectionFlags = Flags<Direction>;\n+\n \tControlId(unsigned int id, const std::string &name, const std::string &vendor,\n-\t\t ControlType type, std::size_t size = 0,\n+\t\t ControlType type, DirectionFlags direction,\n+\t\t std::size_t size = 0,\n \t\t const std::map<std::string, int32_t> &enumStrMap = {});\n \n \tunsigned int id() const { return id_; }\n \tconst std::string &name() const { return name_; }\n \tconst std::string &vendor() const { return vendor_; }\n \tControlType type() const { return type_; }\n+\tbool isInput() const { return !!(direction_ & Direction::In); }\n+\tbool isOutput() const { return !!(direction_ & Direction::Out); }\n \tbool isArray() const { return size_ > 0; }\n \tstd::size_t size() const { return size_; }\n \tconst std::map<int32_t, std::string> &enumerators() const { return reverseMap_; }\n@@ -254,11 +265,14 @@ private:\n \tstd::string name_;\n \tstd::string vendor_;\n \tControlType type_;\n+\tDirectionFlags direction_;\n \tstd::size_t size_;\n \tstd::map<std::string, int32_t> enumStrMap_;\n \tstd::map<int32_t, std::string> reverseMap_;\n };\n \n+LIBCAMERA_FLAGS_ENABLE_OPERATORS(ControlId::Direction)\n+\n static inline bool operator==(unsigned int lhs, const ControlId &rhs)\n {\n \treturn lhs == rhs.id();\n@@ -286,9 +300,10 @@ public:\n \tusing type = T;\n \n \tControl(unsigned int id, const char *name, const char *vendor,\n+\t\tControlId::DirectionFlags direction,\n \t\tconst std::map<std::string, int32_t> &enumStrMap = {})\n \t\t: ControlId(id, name, vendor, details::control_type<std::remove_cv_t<T>>::value,\n-\t\t\t details::control_type<std::remove_cv_t<T>>::size, enumStrMap)\n+\t\t\t direction, details::control_type<std::remove_cv_t<T>>::size, enumStrMap)\n \t{\n \t}\n \ndiff --git a/include/libcamera/ipa/ipa_controls.h b/include/libcamera/ipa/ipa_controls.h\nindex 5fd13394fcef..980668c86bcc 100644\n--- a/include/libcamera/ipa/ipa_controls.h\n+++ b/include/libcamera/ipa/ipa_controls.h\n@@ -46,7 +46,8 @@ struct ipa_control_info_entry {\n \tuint32_t id;\n \tuint32_t type;\n \tuint32_t offset;\n-\tuint32_t padding[1];\n+\tuint8_t direction;\n+\tuint8_t padding[3];\n };\n \n #ifdef __cplusplus\ndiff --git a/src/libcamera/control_ids.cpp.in b/src/libcamera/control_ids.cpp.in\nindex afe9e2c96610..65668d486dbc 100644\n--- a/src/libcamera/control_ids.cpp.in\n+++ b/src/libcamera/control_ids.cpp.in\n@@ -89,9 +89,9 @@ extern const std::map<std::string, {{ctrl.type}}> {{ctrl.name}}NameValueMap = {\n \t{ \"{{enum.name}}\", {{enum.name}} },\n {%- endfor %}\n };\n-extern const Control<{{ctrl.type}}> {{ctrl.name}}({{ctrl.name|snake_case|upper}}, \"{{ctrl.name}}\", \"{{vendor}}\", {{ctrl.name}}NameValueMap);\n+extern const Control<{{ctrl.type}}> {{ctrl.name}}({{ctrl.name|snake_case|upper}}, \"{{ctrl.name}}\", \"{{vendor}}\", {{ctrl.direction}}, {{ctrl.name}}NameValueMap);\n {% else -%}\n-extern const Control<{{ctrl.type}}> {{ctrl.name}}({{ctrl.name|snake_case|upper}}, \"{{ctrl.name}}\", \"{{vendor}}\");\n+extern const Control<{{ctrl.type}}> {{ctrl.name}}({{ctrl.name|snake_case|upper}}, \"{{ctrl.name}}\", \"{{vendor}}\", {{ctrl.direction}});\n {% endif -%}\n {%- endfor %}\n \ndiff --git a/src/libcamera/control_serializer.cpp b/src/libcamera/control_serializer.cpp\nindex 0a5e8220a0ff..0804c178f0d4 100644\n--- a/src/libcamera/control_serializer.cpp\n+++ b/src/libcamera/control_serializer.cpp\n@@ -281,6 +281,9 @@ int ControlSerializer::serialize(const ControlInfoMap &infoMap,\n \t\tentry.id = id->id();\n \t\tentry.type = id->type();\n \t\tentry.offset = values.offset();\n+\t\tentry.direction =\n+\t\t\t(id->isInput() ? static_cast<uint8_t>(ControlId::Direction::In) : 0) |\n+\t\t\t(id->isOutput() ? static_cast<uint8_t>(ControlId::Direction::Out) : 0);\n \t\tentries.write(&entry);\n \n \t\tstore(info, values);\n@@ -493,12 +496,18 @@ ControlInfoMap ControlSerializer::deserialize<ControlInfoMap>(ByteStreamBuffer &\n \n \t\t/* If we're using a local id map, populate it. */\n \t\tif (localIdMap) {\n+\t\t\tControlId::DirectionFlags flags;\n+\t\t\tif (entry->direction & static_cast<uint8_t>(ControlId::Direction::In))\n+\t\t\t\tflags |= ControlId::Direction::In;\n+\t\t\tif (entry->direction & static_cast<uint8_t>(ControlId::Direction::Out))\n+\t\t\t\tflags |= ControlId::Direction::Out;\n \t\t\t/**\n \t\t\t * \\todo Find a way to preserve the control name for\n \t\t\t * debugging purpose.\n \t\t\t */\n \t\t\tcontrolIds_.emplace_back(std::make_unique<ControlId>(entry->id,\n-\t\t\t\t\t\t\t\t\t \"\", \"local\", type));\n+\t\t\t\t\t\t\t\t\t \"\", \"local\", type,\n+\t\t\t\t\t\t\t\t\t flags));\n \t\t\t(*localIdMap)[entry->id] = controlIds_.back().get();\n \t\t}\n \ndiff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp\nindex 2efecf0fc52b..23b71fac8e84 100644\n--- a/src/libcamera/controls.cpp\n+++ b/src/libcamera/controls.cpp\n@@ -396,15 +396,16 @@ void ControlValue::reserve(ControlType type, bool isArray, std::size_t numElemen\n * \\param[in] name The control name\n * \\param[in] vendor The vendor name\n * \\param[in] type The control data type\n+ * \\param[in] direction The direction of the control, if it can be used in Controls or Metadata\n * \\param[in] size The size of the array control, or 0 if scalar control\n * \\param[in] enumStrMap The map from enum names to values (optional)\n */\n ControlId::ControlId(unsigned int id, const std::string &name,\n \t\t const std::string &vendor, ControlType type,\n-\t\t std::size_t size,\n+\t\t DirectionFlags direction, std::size_t size,\n \t\t const std::map<std::string, int32_t> &enumStrMap)\n-\t: id_(id), name_(name), vendor_(vendor), type_(type), size_(size),\n-\t enumStrMap_(enumStrMap)\n+\t: id_(id), name_(name), vendor_(vendor), type_(type),\n+\t direction_(direction), size_(size), enumStrMap_(enumStrMap)\n {\n \tfor (const auto &pair : enumStrMap_)\n \t\treverseMap_[pair.second] = pair.first;\n@@ -434,6 +435,26 @@ ControlId::ControlId(unsigned int id, const std::string &name,\n * \\return The control data type\n */\n \n+/**\n+ * \\fn bool ControlId::isInput() const\n+ * \\brief Determine if the control is available to be used as an input control\n+ *\n+ * Controls can be used either as input in controls, or as output in metadata.\n+ * This function checks if the control is allowed to be used as the former.\n+ *\n+ * \\return True if the control can be used as an input control, false otherwise\n+ */\n+\n+/**\n+ * \\fn bool ControlId::isOutput() const\n+ * \\brief Determine if the control is available to be used in output metadata\n+ *\n+ * Controls can be used either as input in controls, or as output in metadata.\n+ * This function checks if the control is allowed to be used as the latter.\n+ *\n+ * \\return True if the control can be returned in output metadata, false otherwise\n+ */\n+\n /**\n * \\fn bool ControlId::isArray() const\n * \\brief Determine if the control is an array control\n@@ -471,6 +492,22 @@ ControlId::ControlId(unsigned int id, const std::string &name,\n * \\return True if \\a lhs.id() is equal to \\a rhs, false otherwise\n */\n \n+/**\n+ * \\enum ControlId::Direction\n+ * \\brief The direction the control is capable of being passed from/to\n+ *\n+ * \\var ControlId::Direction::In\n+ * \\brief The control can be passed as input in controls\n+ *\n+ * \\var ControlId::Direction::Out\n+ * \\brief The control can be returned as output in metadata\n+ */\n+\n+/**\n+ * \\typedef ControlId::DirectionFlags\n+ * \\brief A wrapper for ControlId::Direction so that it can be used as flags\n+ */\n+\n /**\n * \\class Control\n * \\brief Describe a control and its intrinsic properties\n@@ -504,6 +541,8 @@ ControlId::ControlId(unsigned int id, const std::string &name,\n * \\param[in] id The control numerical ID\n * \\param[in] name The control name\n * \\param[in] vendor The vendor name\n+ * \\param[in] direction The direction of the control, if it can be used in\n+ * Controls or Metadata\n * \\param[in] enumStrMap The map from enum names to values (optional)\n *\n * The control data type is automatically deduced from the template type T.\ndiff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp\nindex 7d21cf15fec1..4634ccc392b6 100644\n--- a/src/libcamera/v4l2_device.cpp\n+++ b/src/libcamera/v4l2_device.cpp\n@@ -520,7 +520,15 @@ std::unique_ptr<ControlId> V4L2Device::v4l2ControlId(const v4l2_query_ext_ctrl &\n \tconst std::string name(static_cast<const char *>(ctrl.name), len);\n \tconst ControlType type = v4l2CtrlType(ctrl.type);\n \n-\treturn std::make_unique<ControlId>(ctrl.id, name, \"v4l2\", type);\n+\tControlId::DirectionFlags flags;\n+\tif (ctrl.flags & V4L2_CTRL_FLAG_READ_ONLY)\n+\t\tflags |= ControlId::Direction::Out;\n+\telse if (ctrl.flags & V4L2_CTRL_FLAG_WRITE_ONLY)\n+\t\tflags |= ControlId::Direction::In;\n+\telse\n+\t\tflags |= ControlId::Direction::In | ControlId::Direction::Out;\n+\n+\treturn std::make_unique<ControlId>(ctrl.id, name, \"v4l2\", type, flags);\n }\n \n /**\n", "prefixes": [ "v3", "3/4" ] }