{"id":15816,"url":"https://patchwork.libcamera.org/api/patches/15816/?format=json","web_url":"https://patchwork.libcamera.org/patch/15816/","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":"<20220506145414.99039-6-tomi.valkeinen@ideasonboard.com>","date":"2022-05-06T14:54:12","name":"[libcamera-devel,v8,5/7] py: generate control enums from yaml","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"62ba47e91e6c31108481bbb8b5bc1f92fca55746","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/15816/mbox/","series":[{"id":3098,"url":"https://patchwork.libcamera.org/api/series/3098/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=3098","date":"2022-05-06T14:54:07","name":"Python bindings","version":8,"mbox":"https://patchwork.libcamera.org/series/3098/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/15816/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/15816/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 6792AC326D\n\tfor ;\n\tFri, 6 May 2022 14:55:18 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 162B46564E;\n\tFri, 6 May 2022 16:55:17 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 9A49E6564C\n\tfor ;\n\tFri, 6 May 2022 16:55:12 +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 EEE86A43;\n\tFri, 6 May 2022 16:55:11 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1651848917;\n\tbh=DvgvXWPQWbX4CVyUuHozOyb5aagpwZHR4TxH96i+zlM=;\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=MijnuOqVDieHLv2JkfNoGyLf56FrjiIuLHnLdVrdmn5gZZeo3iHggYZwVvRD2CQ82\n\tH4ojju2MzR256hhjjkazL67Wj1guQDwQfFMc6640JrAtnREoQa2lHqd/9ql6rAaxSk\n\tv/5XOxTBNLaHXcmlWgkEuKel0bEYWxPt9G1chV9GmS+LVToAlh3r1huWi6hFlw9cd5\n\tVcq+lbO53eyERiB8NxLNuqrx5NAu1L3/p0tiI14Kp+rYjuFcylWLJaAfpOxiKuZNm3\n\tqSUQtTEc2LETKKDn0SgqZkbYJdR/1B2PghwZeTVOTkVFxaLuK7JEfYRLN4+CyiunQu\n\tIjrVl1xsckP6Q==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1651848912;\n\tbh=DvgvXWPQWbX4CVyUuHozOyb5aagpwZHR4TxH96i+zlM=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=vqxMTxUQ3qM4hcK9ebbea/j5uxXsSUhx5pwW0yqDnP1AA7OCgH3MThhmEB5j2afXZ\n\tCecxzwj2JKZEWOTfDilt6Vqqilo/j+ucZa3ayWz1IqT7Ul7vxl1niJ7ssk/hQxwUEf\n\tsZGN1RuQX0x1I+JvZYCVa0XmoU147DqCmHmS6cec="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"vqxMTxUQ\"; dkim-atps=neutral","To":"libcamera-devel@lists.libcamera.org,\n\tDavid Plowman ,\n\tKieran Bingham ,\n\tLaurent Pinchart ,\n\tJacopo Mondi ","Date":"Fri, 6 May 2022 17:54:12 +0300","Message-Id":"<20220506145414.99039-6-tomi.valkeinen@ideasonboard.com>","X-Mailer":"git-send-email 2.34.1","In-Reply-To":"<20220506145414.99039-1-tomi.valkeinen@ideasonboard.com>","References":"<20220506145414.99039-1-tomi.valkeinen@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v8 5/7] py: generate control enums from\n\tyaml","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":"Generate enums for controls from control_ids.yaml. The generator script\nhas some heuristics to generate nicer enum names. E.g. instead of having\n\"LensShadingMapMode.LensShadingMapModeOff\" we get\n\"LensShadingMapMode.Off\". This heuristics may need to be updated when\nthe yaml file is changed or new controls are added.\n\nSigned-off-by: Tomi Valkeinen \nReviewed-by: Kieran Bingham \nReviewed-by: Laurent Pinchart \n---\n src/py/libcamera/gen-py-control-enums.py | 95 +++++++++++++++++++++++\n src/py/libcamera/meson.build | 12 +++\n src/py/libcamera/pyenums_generated.cpp.in | 21 +++++\n src/py/libcamera/pymain.cpp | 2 +\n 4 files changed, 130 insertions(+)\n create mode 100755 src/py/libcamera/gen-py-control-enums.py\n create mode 100644 src/py/libcamera/pyenums_generated.cpp.in","diff":"diff --git a/src/py/libcamera/gen-py-control-enums.py b/src/py/libcamera/gen-py-control-enums.py\nnew file mode 100755\nindex 00000000..dcc28b1a\n--- /dev/null\n+++ b/src/py/libcamera/gen-py-control-enums.py\n@@ -0,0 +1,95 @@\n+#!/usr/bin/env python3\n+# SPDX-License-Identifier: GPL-2.0-or-later\n+#\n+# Generate Python bindings enums for controls from YAML\n+\n+import argparse\n+import string\n+import sys\n+import yaml\n+\n+\n+def find_common_prefix(strings):\n+ prefix = strings[0]\n+\n+ for string in strings[1:]:\n+ while string[:len(prefix)] != prefix and prefix:\n+ prefix = prefix[:len(prefix) - 1]\n+ if not prefix:\n+ break\n+\n+ return prefix\n+\n+\n+def generate_py(controls):\n+ out = ''\n+\n+ for ctrl in controls:\n+ name, ctrl = ctrl.popitem()\n+\n+ enum = ctrl.get('enum')\n+ if not enum:\n+ continue\n+\n+ if ctrl.get('draft'):\n+ ns = 'libcamera::controls::draft::'\n+ else:\n+ ns = 'libcamera::controls::'\n+\n+ cpp_enum = name + 'Enum'\n+\n+ out += '\\tpy::enum_<{}{}>(m, \\\"{}\\\")\\n'.format(ns, cpp_enum, name)\n+\n+ if name == 'LensShadingMapMode':\n+ prefix = 'LensShadingMapMode'\n+ else:\n+ prefix = find_common_prefix([e['name'] for e in enum])\n+\n+ for entry in enum:\n+ cpp_enum = entry['name']\n+ py_enum = entry['name'][len(prefix):]\n+\n+ out += '\\t\\t.value(\\\"{}\\\", {}{})\\n'.format(py_enum, ns, cpp_enum)\n+\n+ out += '\\t;\\n'\n+\n+ return {'enums': out}\n+\n+\n+def fill_template(template, data):\n+ template = open(template, 'rb').read()\n+ template = template.decode('utf-8')\n+ template = string.Template(template)\n+ return template.substitute(data)\n+\n+\n+def main(argv):\n+ # Parse command line arguments\n+ parser = argparse.ArgumentParser()\n+ parser.add_argument('-o', dest='output', metavar='file', type=str,\n+ help='Output file name. Defaults to standard output if not specified.')\n+ parser.add_argument('input', type=str,\n+ help='Input file name.')\n+ parser.add_argument('template', type=str,\n+ help='Template file name.')\n+ args = parser.parse_args(argv[1:])\n+\n+ data = open(args.input, 'rb').read()\n+ controls = yaml.safe_load(data)['controls']\n+\n+ data = generate_py(controls)\n+\n+ data = fill_template(args.template, data)\n+\n+ if args.output:\n+ output = open(args.output, 'wb')\n+ output.write(data.encode('utf-8'))\n+ output.close()\n+ else:\n+ sys.stdout.write(data)\n+\n+ return 0\n+\n+\n+if __name__ == '__main__':\n+ sys.exit(main(sys.argv))\ndiff --git a/src/py/libcamera/meson.build b/src/py/libcamera/meson.build\nindex e4abc34a..f4c7590c 100644\n--- a/src/py/libcamera/meson.build\n+++ b/src/py/libcamera/meson.build\n@@ -17,6 +17,18 @@ pycamera_sources = files([\n 'pymain.cpp',\n ])\n \n+gen_input_files = [\n+ meson.project_source_root() / 'src' / 'libcamera' / 'control_ids.yaml',\n+ 'pyenums_generated.cpp.in'\n+]\n+\n+generated_sources = custom_target('py_gen_controls',\n+ input : gen_input_files,\n+ output : ['pyenums_generated.cpp'],\n+ command : ['gen-py-control-enums.py', '-o', '@OUTPUT@', '@INPUT@'])\n+\n+pycamera_sources += generated_sources\n+\n pycamera_deps = [\n libcamera_public,\n py3_dep,\ndiff --git a/src/py/libcamera/pyenums_generated.cpp.in b/src/py/libcamera/pyenums_generated.cpp.in\nnew file mode 100644\nindex 00000000..96daf257\n--- /dev/null\n+++ b/src/py/libcamera/pyenums_generated.cpp.in\n@@ -0,0 +1,21 @@\n+/* SPDX-License-Identifier: LGPL-2.1-or-later */\n+/*\n+ * Copyright (C) 2021, Tomi Valkeinen \n+ *\n+ * Python bindings\n+ *\n+ * This file is auto-generated. Do not edit.\n+ */\n+\n+#include \n+\n+#include \n+\n+namespace py = pybind11;\n+\n+using namespace libcamera;\n+\n+void init_pyenums_generated(py::module& m)\n+{\n+${enums}\n+}\ndiff --git a/src/py/libcamera/pymain.cpp b/src/py/libcamera/pymain.cpp\nindex 8c3be8f4..aff672aa 100644\n--- a/src/py/libcamera/pymain.cpp\n+++ b/src/py/libcamera/pymain.cpp\n@@ -131,10 +131,12 @@ static void handleRequestCompleted(Request *req)\n }\n \n void init_pyenums(py::module &m);\n+void init_pyenums_generated(py::module &m);\n \n PYBIND11_MODULE(_libcamera, m)\n {\n \tinit_pyenums(m);\n+\tinit_pyenums_generated(m);\n \n \t/* Forward declarations */\n \n","prefixes":["libcamera-devel","v8","5/7"]}