{"id":22079,"url":"https://patchwork.libcamera.org/api/1.1/patches/22079/?format=json","web_url":"https://patchwork.libcamera.org/patch/22079/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20241125153003.3309066-4-paul.elder@ideasonboard.com>","date":"2024-11-25T15:30:02","name":"[3/4] libcamera: controls: Add support for querying direction information","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"ac1ba18fe76c215c3ef15f5e23eb01c939ffc022","submitter":{"id":17,"url":"https://patchwork.libcamera.org/api/1.1/people/17/?format=json","name":"Paul Elder","email":"paul.elder@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/22079/mbox/","series":[{"id":4819,"url":"https://patchwork.libcamera.org/api/1.1/series/4819/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4819","date":"2024-11-25T15:29:59","name":"Add direction field to ControlId","version":1,"mbox":"https://patchwork.libcamera.org/series/4819/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/22079/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/22079/checks/","tags":{},"headers":{"Return-Path":"","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 0FB6DC32A3\n\tfor ;\n\tMon, 25 Nov 2024 15:30:24 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B59CE65F73;\n\tMon, 25 Nov 2024 16:30:23 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id EC68365F7F\n\tfor ;\n\tMon, 25 Nov 2024 16:30:18 +0100 (CET)","from neptunite.flets-east.jp (unknown\n\t[IPv6:2404:7a81:160:2100:9d06:dcbb:7303:4be6])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 1DEF66B5;\n\tMon, 25 Nov 2024 16:29:55 +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=\"WwnU7YZH\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1732548597;\n\tbh=rAdDTPZva8Km2A/oF3v15Pi4d9Ow6Kp9wLi+0UlRADc=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=WwnU7YZHuerViwBeIRMKuFZOKHsUrzK5CYBzE0RcKzNdS1HG2kKsLY+bkxS55t/av\n\tkRaXPIqw9Rj4DqcImRpgNka3q/faly0MQ2OPUHfo5tVioDIvd9qjGSrcRTRsPYwiHs\n\t+yPI2MvXEEhedlEtpQQJ6XdbDQHYAKGRVZ1ij25k=","From":"Paul Elder ","To":"libcamera-devel@lists.libcamera.org","Cc":"Paul Elder ","Subject":"[PATCH 3/4] libcamera: controls: Add support for querying direction\n\tinformation","Date":"Tue, 26 Nov 2024 00:30:02 +0900","Message-Id":"<20241125153003.3309066-4-paul.elder@ideasonboard.com>","X-Mailer":"git-send-email 2.39.2","In-Reply-To":"<20241125153003.3309066-1-paul.elder@ideasonboard.com>","References":"<20241125153003.3309066-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":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"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 \n---\n include/libcamera/controls.h | 27 +++++++++++++++++++-\n src/libcamera/control_ids.cpp.in | 4 +--\n src/libcamera/controls.cpp | 42 ++++++++++++++++++++++++++++++--\n 3 files changed, 68 insertions(+), 5 deletions(-)","diff":"diff --git a/include/libcamera/controls.h b/include/libcamera/controls.h\nindex 3cfe2de5973c..cd338ac0d653 100644\n--- a/include/libcamera/controls.h\n+++ b/include/libcamera/controls.h\n@@ -17,6 +17,7 @@\n #include \n \n #include \n+#include \n #include \n \n #include \n@@ -235,8 +236,18 @@ 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;\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 const DirectionFlags &direction =\n+\t\t\t static_cast(Direction::In) |\n+\t\t\t static_cast(Direction::Out),\n \t\t const std::map &enumStrMap = {});\n \n \tunsigned int id() const { return id_; }\n@@ -245,6 +256,16 @@ public:\n \tControlType type() const { return type_; }\n \tbool isArray() const { return size_ > 0; }\n \tstd::size_t size() const { return size_; }\n+\tbool isInput() const\n+\t{\n+\t\treturn static_cast(\n+\t\t\tdirection_ & static_cast(Direction::In));\n+\t}\n+\tbool isOutput() const\n+\t{\n+\t\treturn static_cast(\n+\t\t\tdirection_ & static_cast(Direction::Out));\n+\t}\n \tconst std::map &enumerators() const { return reverseMap_; }\n \n private:\n@@ -255,6 +276,7 @@ private:\n \tstd::string vendor_;\n \tControlType type_;\n \tstd::size_t size_;\n+\tDirectionFlags direction_;\n \tstd::map enumStrMap_;\n \tstd::map reverseMap_;\n };\n@@ -286,9 +308,12 @@ public:\n \tusing type = T;\n \n \tControl(unsigned int id, const char *name, const char *vendor,\n+\t\tconst ControlId::DirectionFlags &direction =\n+\t\t\tstatic_cast(ControlId::Direction::In) |\n+\t\t\tstatic_cast(ControlId::Direction::Out),\n \t\tconst std::map &enumStrMap = {})\n \t\t: ControlId(id, name, vendor, details::control_type>::value,\n-\t\t\t details::control_type>::size, enumStrMap)\n+\t\t\t details::control_type>::size, direction, enumStrMap)\n \t{\n \t}\n \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 {{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/controls.cpp b/src/libcamera/controls.cpp\nindex 2efecf0fc52b..30eb17e7f064 100644\n--- a/src/libcamera/controls.cpp\n+++ b/src/libcamera/controls.cpp\n@@ -397,14 +397,15 @@ void ControlValue::reserve(ControlType type, bool isArray, std::size_t numElemen\n * \\param[in] vendor The vendor name\n * \\param[in] type The control data type\n * \\param[in] size The size of the array control, or 0 if scalar control\n+ * \\param[in] direction The direction of the control, if it can be used in Controls or Metadata\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 std::size_t size, const DirectionFlags &direction,\n \t\t const std::map &enumStrMap)\n \t: id_(id), name_(name), vendor_(vendor), type_(type), size_(size),\n-\t enumStrMap_(enumStrMap)\n+\t direction_(direction), enumStrMap_(enumStrMap)\n {\n \tfor (const auto &pair : enumStrMap_)\n \t\treverseMap_[pair.second] = pair.first;\n@@ -440,6 +441,26 @@ ControlId::ControlId(unsigned int id, const std::string &name,\n * \\return True if the control is an array control, false otherwise\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 as a control, 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 as a control, 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 std::size_t ControlId::size() const\n * \\brief Retrieve the size of the control if it 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 that a control of the ControlId is capable of being passed from/to\n+ *\n+ * \\var ControlId::Direction::In\n+ * \\brief The control can be passed in controls as input\n+ *\n+ * \\var ControlId::Direction::Out\n+ * \\brief The control can be returned in output as 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,7 @@ 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 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.\n","prefixes":["3/4"]}