{"id":16022,"url":"https://patchwork.libcamera.org/api/patches/16022/?format=json","web_url":"https://patchwork.libcamera.org/patch/16022/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20220524114610.41848-17-tomi.valkeinen@ideasonboard.com>","date":"2022-05-24T11:46:07","name":"[libcamera-devel,v2,16/19] py: Re-structure the controls API","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"45c19671ad5306a3c224858a8a611051cc345c59","submitter":{"id":109,"url":"https://patchwork.libcamera.org/api/people/109/?format=json","name":"Tomi Valkeinen","email":"tomi.valkeinen@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/16022/mbox/","series":[{"id":3134,"url":"https://patchwork.libcamera.org/api/series/3134/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=3134","date":"2022-05-24T11:45:51","name":"More misc Python patches","version":2,"mbox":"https://patchwork.libcamera.org/series/3134/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/16022/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/16022/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 30E1CC3275\n\tfor ;\n\tTue, 24 May 2022 11:46:54 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B9F4A6568C;\n\tTue, 24 May 2022 13:46:53 +0200 (CEST)","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 711026566F\n\tfor ;\n\tTue, 24 May 2022 13:46:38 +0200 (CEST)","from deskari.lan (91-156-85-209.elisa-laajakaista.fi\n\t[91.156.85.209])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id D9CBDAEC;\n\tTue, 24 May 2022 13:46:37 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1653392813;\n\tbh=rvVo0pPc2hl0ogBe7KG8c/TLUjfwH2Z5UiVRR07Nt7c=;\n\th=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=wlt6/kRg4zu8MFPHRVdDAtbFXwSnky1MRJDUK5Ofyax5ce8zqb3/Q7B3jo617ajLs\n\tisQQ85lLlL4LY6BTq4zzjtHk50rFUGA8JYQR1NzI0DIU127i3mvEM99saL/DuRwmoe\n\t1kiu8T8fCm8nnZqFK92BbpsgHP+awaLXMre/5h3gsvj/NooWwn67jofS7oenBWvXQS\n\t6w1Nocn29r3nHTRUfHzsrrVSmP2PBm1Yu9vyrSM+uMiSTFi4rXQHWqjOOb5MjWm73e\n\tQy41NGmHgkqlSBauzesC6vOuuRw2gUiCrMBiDjJQU8szk4dH4isfUjs7baFiRKplwr\n\tcaDvwU4dWrKMQ==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1653392798;\n\tbh=rvVo0pPc2hl0ogBe7KG8c/TLUjfwH2Z5UiVRR07Nt7c=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=Enqe3ILlTNbfA/TIobVXNrN/D0vpHlgoTr0BVADYR49bPaecpyFSZu3BtlWse1nC+\n\tWvRauKmsO0rbmQ/uNvLLfpSaU+/qKbIWZUerXw/CWno9zqIHHCjO7cfcr8pRh/+Ral\n\taonaQWfOKeOa3z0I6gyYFIvJuQskNG4PZnNoLrck="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"Enqe3ILl\"; dkim-atps=neutral","To":"libcamera-devel@lists.libcamera.org,\n\tDavid Plowman ,\n\tKieran Bingham ,\n\tLaurent Pinchart ,\n\tJacopo Mondi ","Date":"Tue, 24 May 2022 14:46:07 +0300","Message-Id":"<20220524114610.41848-17-tomi.valkeinen@ideasonboard.com>","X-Mailer":"git-send-email 2.34.1","In-Reply-To":"<20220524114610.41848-1-tomi.valkeinen@ideasonboard.com>","References":"<20220524114610.41848-1-tomi.valkeinen@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v2 16/19] py: Re-structure the controls API","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","From":"Tomi Valkeinen via libcamera-devel\n\t","Reply-To":"Tomi Valkeinen ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Add ControlInfo class and change the controls related methods to\nresemble the C++ API (e.g. no more string based control methods).\n\nWe don't implement ControlList or ControlInfoMap but just expose the\nsame data via standard Python dict.\n\nSigned-off-by: Tomi Valkeinen \n---\n src/py/cam/cam.py | 8 +--\n src/py/cam/cam_qt.py | 9 ++--\n src/py/libcamera/py_main.cpp | 100 ++++++++++++++++++-----------------\n 3 files changed, 61 insertions(+), 56 deletions(-)","diff":"diff --git a/src/py/cam/cam.py b/src/py/cam/cam.py\nindex f6e8232c..f464bd01 100755\n--- a/src/py/cam/cam.py\n+++ b/src/py/cam/cam.py\n@@ -48,16 +48,16 @@ class CameraContext:\n \n print('Properties for', self.id)\n \n- for name, prop in camera.properties.items():\n- print('\\t{}: {}'.format(name, prop))\n+ for cid, val in camera.properties.items():\n+ print('\\t{}: {}'.format(cid, val))\n \n def do_cmd_list_controls(self):\n camera = self.camera\n \n print('Controls for', self.id)\n \n- for name, prop in camera.controls.items():\n- print('\\t{}: {}'.format(name, prop))\n+ for cid, info in camera.controls.items():\n+ print('\\t{}: {}'.format(cid, info))\n \n def do_cmd_info(self):\n camera = self.camera\ndiff --git a/src/py/cam/cam_qt.py b/src/py/cam/cam_qt.py\nindex d638e9cc..739e9749 100644\n--- a/src/py/cam/cam_qt.py\n+++ b/src/py/cam/cam_qt.py\n@@ -267,9 +267,9 @@ class MainWindow(QtWidgets.QWidget):\n \n camera = ctx.camera\n \n- for k, v in camera.properties.items():\n+ for cid, cv in camera.properties.items():\n lab = QtWidgets.QLabel()\n- lab.setText(k + ' = ' + str(v))\n+ lab.setText(\"{} = {}\".format(cid, cv))\n groupLayout.addWidget(lab)\n \n group = QtWidgets.QGroupBox('Controls')\n@@ -277,9 +277,10 @@ class MainWindow(QtWidgets.QWidget):\n group.setLayout(groupLayout)\n controlsLayout.addWidget(group)\n \n- for k, (min, max, default) in camera.controls.items():\n+ for cid, cinfo in camera.controls.items():\n lab = QtWidgets.QLabel()\n- lab.setText('{} = {}/{}/{}'.format(k, min, max, default))\n+ lab.setText('{} = {}/{}/{}'\n+ .format(cid, cinfo.min, cinfo.max, cinfo.default))\n groupLayout.addWidget(lab)\n \n controlsLayout.addStretch()\ndiff --git a/src/py/libcamera/py_main.cpp b/src/py/libcamera/py_main.cpp\nindex 33ecc1cd..80f26c12 100644\n--- a/src/py/libcamera/py_main.cpp\n+++ b/src/py/libcamera/py_main.cpp\n@@ -159,6 +159,7 @@ PYBIND11_MODULE(_libcamera, m)\n \tauto pyFrameBuffer = py::class_(m, \"FrameBuffer\");\n \tauto pyStream = py::class_(m, \"Stream\");\n \tauto pyControlId = py::class_(m, \"ControlId\");\n+\tauto pyControlInfo = py::class_(m, \"ControlInfo\");\n \tauto pyRequest = py::class_(m, \"Request\");\n \tauto pyRequestStatus = py::enum_(pyRequest, \"Status\");\n \tauto pyRequestReuse = py::enum_(pyRequest, \"Reuse\");\n@@ -260,28 +261,17 @@ PYBIND11_MODULE(_libcamera, m)\n \t\t.def_property_readonly(\"id\", &Camera::id)\n \t\t.def(\"acquire\", &Camera::acquire)\n \t\t.def(\"release\", &Camera::release)\n-\t\t.def(\"start\", [](Camera &self, py::dict controls) {\n+\t\t.def(\"start\", [](Camera &self,\n+\t\t const std::unordered_map &controls) {\n \t\t\t/* \\todo What happens if someone calls start() multiple times? */\n \n \t\t\tself.requestCompleted.connect(handleRequestCompleted);\n \n-\t\t\tconst ControlInfoMap &controlMap = self.controls();\n-\t\t\tControlList controlList(controlMap);\n-\t\t\tfor (const auto& [hkey, hval]: controls) {\n-\t\t\t\tauto key = hkey.cast();\n+\t\t\tControlList controlList(self.controls());\n \n-\t\t\t\tauto it = std::find_if(controlMap.begin(), controlMap.end(),\n-\t\t\t\t\t\t [&key](const auto &kvp) {\n-\t\t\t\t\t\t\t\treturn kvp.first->name() == key;\n-\t\t\t\t\t\t });\n-\n-\t\t\t\tif (it == controlMap.end())\n-\t\t\t\t\tthrow std::runtime_error(\"Control \" + key + \" not found\");\n-\n-\t\t\t\tconst auto &id = it->first;\n-\t\t\t\tauto obj = py::cast(hval);\n-\n-\t\t\t\tcontrolList.set(id->id(), pyToControlValue(obj, id->type()));\n+\t\t\tfor (const auto& [id, obj]: controls) {\n+\t\t\t\tauto val = pyToControlValue(obj, id->type());\n+\t\t\t\tcontrolList.set(id->id(), val);\n \t\t\t}\n \n \t\t\tint ret = self.start(&controlList);\n@@ -291,7 +281,7 @@ PYBIND11_MODULE(_libcamera, m)\n \t\t\t}\n \n \t\t\treturn 0;\n-\t\t}, py::arg(\"controls\") = py::dict())\n+\t\t}, py::arg(\"controls\") = std::unordered_map())\n \n \t\t.def(\"stop\", [](Camera &self) {\n \t\t\tint ret = self.stop();\n@@ -341,40 +331,26 @@ PYBIND11_MODULE(_libcamera, m)\n \t\t\treturn set;\n \t\t})\n \n-\t\t.def(\"find_control\", [](Camera &self, const std::string &name) {\n-\t\t\tconst auto &controls = self.controls();\n-\n-\t\t\tauto it = std::find_if(controls.begin(), controls.end(),\n-\t\t\t\t\t [&name](const auto &kvp) {\n-\t\t\t\t\t\t\treturn kvp.first->name() == name;\n-\t\t\t\t\t });\n-\n-\t\t\tif (it == controls.end())\n-\t\t\t\tthrow std::runtime_error(\"Control '\" + name + \"' not found\");\n-\n-\t\t\treturn it->first;\n-\t\t}, py::return_value_policy::reference_internal)\n-\n \t\t.def_property_readonly(\"controls\", [](Camera &self) {\n-\t\t\tpy::dict ret;\n+\t\t\t/* Convert ControlInfoMap to std container */\n \n-\t\t\tfor (const auto &[id, ci] : self.controls()) {\n-\t\t\t\tret[id->name().c_str()] = std::make_tuple(controlValueToPy(ci.min()),\n-\t\t\t\t\t\t\t\t\t\t controlValueToPy(ci.max()),\n-\t\t\t\t\t\t\t\t\t\t controlValueToPy(ci.def()));\n-\t\t\t}\n+\t\t\tstd::unordered_map ret;\n+\n+\t\t\tfor (const auto &[k, cv] : self.controls())\n+\t\t\t\tret[k] = cv;\n \n \t\t\treturn ret;\n \t\t})\n \n \t\t.def_property_readonly(\"properties\", [](Camera &self) {\n-\t\t\tpy::dict ret;\n+\t\t\t/* Convert ControlList to std container */\n \n-\t\t\tfor (const auto &[key, cv] : self.properties()) {\n-\t\t\t\tconst ControlId *id = properties::properties.at(key);\n-\t\t\t\tpy::object ob = controlValueToPy(cv);\n+\t\t\tstd::unordered_map ret;\n \n-\t\t\t\tret[id->name().c_str()] = ob;\n+\t\t\tfor (const auto &[k, cv] : self.properties()) {\n+\t\t\t\tconst ControlId *id = properties::properties.at(k);\n+\t\t\t\tpy::object ob = controlValueToPy(cv);\n+\t\t\t\tret[id] = ob;\n \t\t\t}\n \n \t\t\treturn ret;\n@@ -464,7 +440,34 @@ PYBIND11_MODULE(_libcamera, m)\n \tpyControlId\n \t\t.def_property_readonly(\"id\", &ControlId::id)\n \t\t.def_property_readonly(\"name\", &ControlId::name)\n-\t\t.def_property_readonly(\"type\", &ControlId::type);\n+\t\t.def_property_readonly(\"type\", &ControlId::type)\n+\t\t.def(\"__str__\", [](const ControlId &self) { return self.name(); })\n+\t\t.def(\"__repr__\", [](const ControlId &self) {\n+\t\t\treturn py::str(\"libcamera.ControlId({}, {}, {})\")\n+\t\t\t\t.format(self.id(), self.name(), self.type());\n+\t\t});\n+\n+\tpyControlInfo\n+\t\t.def_property_readonly(\"min\", [](const ControlInfo& self) {\n+\t\t\treturn controlValueToPy(self.min());\n+\t\t})\n+\t\t.def_property_readonly(\"max\", [](const ControlInfo& self) {\n+\t\t\treturn controlValueToPy(self.max());\n+\t\t})\n+\t\t.def_property_readonly(\"default\", [](const ControlInfo& self) {\n+\t\t\treturn controlValueToPy(self.def());\n+\t\t})\n+\t\t.def_property_readonly(\"values\", [](const ControlInfo& self) {\n+\t\t\tpy::list l;\n+\t\t\tfor (const auto &v : self.values())\n+\t\t\t\tl.append(controlValueToPy(v));\n+\t\t\treturn l;\n+\t\t})\n+\t\t.def(\"__str__\", &ControlInfo::toString)\n+\t\t.def(\"__repr__\", [](const ControlInfo& self) {\n+\t\t\treturn py::str(\"libcamera.ControlInfo({})\")\n+\t\t\t\t.format(self.toString());\n+\t\t});\n \n \tpyRequest\n \t\t/* \\todo Fence is not supported, so we cannot expose addBuffer() directly */\n@@ -475,17 +478,18 @@ PYBIND11_MODULE(_libcamera, m)\n \t\t.def_property_readonly(\"buffers\", &Request::buffers)\n \t\t.def_property_readonly(\"cookie\", &Request::cookie)\n \t\t.def_property_readonly(\"has_pending_buffers\", &Request::hasPendingBuffers)\n-\t\t.def(\"set_control\", [](Request &self, ControlId &id, py::object value) {\n+\t\t.def(\"set_control\", [](Request &self, const ControlId &id, py::object value) {\n \t\t\tself.controls().set(id.id(), pyToControlValue(value, id.type()));\n \t\t})\n \t\t.def_property_readonly(\"metadata\", [](Request &self) {\n-\t\t\tpy::dict ret;\n+\t\t\t/* Convert ControlList to std container */\n+\n+\t\t\tstd::unordered_map ret;\n \n \t\t\tfor (const auto &[key, cv] : self.metadata()) {\n \t\t\t\tconst ControlId *id = controls::controls.at(key);\n \t\t\t\tpy::object ob = controlValueToPy(cv);\n-\n-\t\t\t\tret[id->name().c_str()] = ob;\n+\t\t\t\tret[id] = ob;\n \t\t\t}\n \n \t\t\treturn ret;\n","prefixes":["libcamera-devel","v2","16/19"]}