summaryrefslogtreecommitdiff
path: root/utils/gen-controls.py
diff options
context:
space:
mode:
authorKieran Bingham <kieran.bingham@ideasonboard.com>2020-09-03 11:36:57 +0100
committerKieran Bingham <kieran.bingham@ideasonboard.com>2020-09-24 10:55:49 +0100
commitc09626cd6306239bc473aaf73a2030d5e56699b8 (patch)
tree02df57c50c9e1730cadc2def8b5d86ee005ada9b /utils/gen-controls.py
parentd6b6ad950d73b21dd6dc58ddedd4c2cfd4b638ef (diff)
libcamera: Move Header generation utilities to utils
Move the GPL2 utilities which handle generation of controls, formats and the top level libcamera header to the utils subtree. Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
Diffstat (limited to 'utils/gen-controls.py')
-rwxr-xr-xutils/gen-controls.py173
1 files changed, 173 insertions, 0 deletions
diff --git a/utils/gen-controls.py b/utils/gen-controls.py
new file mode 100755
index 00000000..87c3d52a
--- /dev/null
+++ b/utils/gen-controls.py
@@ -0,0 +1,173 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: GPL-2.0-or-later
+# Copyright (C) 2019, Google Inc.
+#
+# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
+#
+# gen-controls.py - Generate control definitions from YAML
+
+import argparse
+import string
+import sys
+import yaml
+
+
+def snake_case(s):
+ return ''.join([c.isupper() and ('_' + c) or c for c in s]).strip('_')
+
+
+def format_description(description):
+ description = description.strip('\n').split('\n')
+ description[0] = '\\brief ' + description[0]
+ return '\n'.join([(line and ' * ' or ' *') + line for line in description])
+
+
+def generate_cpp(controls):
+ enum_doc_start_template = string.Template('''/**
+ * \\enum ${name}Values
+ * \\brief Supported ${name} values''')
+ enum_doc_value_template = string.Template(''' * \\var ${name}Values::${value}
+${description}''')
+ doc_template = string.Template('''/**
+ * \\var ${name}
+${description}
+ */''')
+ def_template = string.Template('extern const Control<${type}> ${name}(${id_name}, "${name}");')
+
+ ctrls_doc = []
+ ctrls_def = []
+ ctrls_map = []
+
+ for ctrl in controls:
+ name, ctrl = ctrl.popitem()
+ id_name = snake_case(name).upper()
+
+ ctrl_type = ctrl['type']
+ if ctrl_type == 'string':
+ ctrl_type = 'std::string'
+ elif ctrl.get('size'):
+ ctrl_type = 'Span<const %s>' % ctrl_type
+
+ info = {
+ 'name': name,
+ 'type': ctrl_type,
+ 'description': format_description(ctrl['description']),
+ 'id_name': id_name,
+ }
+
+ enum = ctrl.get('enum')
+ if enum:
+ enum_doc = []
+ enum_doc.append(enum_doc_start_template.substitute(info))
+
+ for entry in enum:
+ value_info = {
+ 'name' : name,
+ 'value': entry['name'],
+ 'description': format_description(entry['description']),
+ }
+ enum_doc.append(enum_doc_value_template.substitute(value_info))
+
+ enum_doc = '\n *\n'.join(enum_doc)
+ enum_doc += '\n */'
+ ctrls_doc.append(enum_doc)
+
+ ctrls_doc.append(doc_template.substitute(info))
+ ctrls_def.append(def_template.substitute(info))
+ ctrls_map.append('\t{ ' + id_name + ', &' + name + ' },')
+
+ return {
+ 'controls_doc': '\n\n'.join(ctrls_doc),
+ 'controls_def': '\n'.join(ctrls_def),
+ 'controls_map': '\n'.join(ctrls_map),
+ }
+
+
+def generate_h(controls):
+ enum_template_start = string.Template('''enum ${name}Values {''')
+ enum_value_template = string.Template('''\t${name} = ${value},''')
+ template = string.Template('''extern const Control<${type}> ${name};''')
+
+ ctrls = []
+ ids = []
+ id_value = 1
+
+ for ctrl in controls:
+ name, ctrl = ctrl.popitem()
+ id_name = snake_case(name).upper()
+
+ ids.append('\t' + id_name + ' = ' + str(id_value) + ',')
+
+ ctrl_type = ctrl['type']
+ if ctrl_type == 'string':
+ ctrl_type = 'std::string'
+ elif ctrl.get('size'):
+ ctrl_type = 'Span<const %s>' % ctrl_type
+
+ info = {
+ 'name': name,
+ 'type': ctrl_type,
+ }
+
+ enum = ctrl.get('enum')
+ if enum:
+ ctrls.append(enum_template_start.substitute(info))
+
+ for entry in enum:
+ value_info = {
+ 'name': entry['name'],
+ 'value': entry['value'],
+ }
+ ctrls.append(enum_value_template.substitute(value_info))
+ ctrls.append("};")
+
+ ctrls.append(template.substitute(info))
+ id_value += 1
+
+ return {'ids': '\n'.join(ids), 'controls': '\n'.join(ctrls)}
+
+
+def fill_template(template, data):
+
+ template = open(template, 'rb').read()
+ template = template.decode('utf-8')
+ template = string.Template(template)
+ return template.substitute(data)
+
+
+def main(argv):
+
+ # Parse command line arguments
+ parser = argparse.ArgumentParser()
+ parser.add_argument('-o', dest='output', metavar='file', type=str,
+ help='Output file name. Defaults to standard output if not specified.')
+ parser.add_argument('input', type=str,
+ help='Input file name.')
+ parser.add_argument('template', type=str,
+ help='Template file name.')
+ args = parser.parse_args(argv[1:])
+
+ data = open(args.input, 'rb').read()
+ controls = yaml.safe_load(data)['controls']
+
+ if args.template.endswith('.cpp.in'):
+ data = generate_cpp(controls)
+ elif args.template.endswith('.h.in'):
+ data = generate_h(controls)
+ else:
+ raise RuntimeError('Unknown template type')
+
+ data = fill_template(args.template, data)
+
+ if args.output:
+ output = open(args.output, 'wb')
+ output.write(data.encode('utf-8'))
+ output.close()
+ else:
+ sys.stdout.write(data)
+
+ return 0
+
+
+if __name__ == '__main__':
+ sys.exit(main(sys.argv))