[libcamera-devel] [RFC 3/6] libcamera: properties: Generate Properties

Jacopo Mondi jacopo at jmondi.org
Tue Nov 19 17:44:18 CET 2019


Re-use the ControlIDs generation infrastructure to define ids and values
for libcamera properties.

This generates two additional files, on that enumerates the properties ids
(include/libcamera/property_ids.h) and one the defines Control instances
for each property (src/libcamera/property_ids.cpp)

Signed-off-by: Jacopo Mondi <jacopo at jmondi.org>
---
 include/libcamera/meson.build       |  9 ++++++
 include/libcamera/property_ids.h.in | 33 ++++++++++++++++++++++
 src/libcamera/meson.build           |  6 ++++
 src/libcamera/property_ids.cpp.in   | 43 +++++++++++++++++++++++++++++
 src/libcamera/property_ids.yaml     | 32 +++++++++++++++++++++
 5 files changed, 123 insertions(+)
 create mode 100644 include/libcamera/property_ids.h.in
 create mode 100644 src/libcamera/property_ids.cpp.in
 create mode 100644 src/libcamera/property_ids.yaml

diff --git a/include/libcamera/meson.build b/include/libcamera/meson.build
index 99abf0609940..795cc00f97c6 100644
--- a/include/libcamera/meson.build
+++ b/include/libcamera/meson.build
@@ -31,7 +31,16 @@ control_ids_h = custom_target('control_ids_h',
                               install : true,
                               install_dir : join_paths('include', include_dir))
 
+property_ids_h = custom_target('property_ids_h',
+                              input : files('../../src/libcamera/property_ids.yaml', 'property_ids.h.in'),
+                              output : 'property_ids.h',
+                              depend_files : gen_controls,
+                              command : [gen_controls, '-o', '@OUTPUT@', '@INPUT@'],
+                              install : true,
+                              install_dir : join_paths('include', include_dir))
+
 libcamera_api += control_ids_h
+libcamera_api += property_ids_h
 
 gen_header = files('gen-header.sh')
 
diff --git a/include/libcamera/property_ids.h.in b/include/libcamera/property_ids.h.in
new file mode 100644
index 000000000000..25fa52cdfd17
--- /dev/null
+++ b/include/libcamera/property_ids.h.in
@@ -0,0 +1,33 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
+/*
+ * Copyright (C) 2019, Google Inc.
+ *
+ * property_ids.h : Property ID list
+ *
+ * This file is auto-generated. Do not edit.
+ */
+
+#ifndef __LIBCAMERA_PROPERTY_IDS_H__
+#define __LIBCAMERA_PROPERTY_IDS_H__
+
+#include <stdint.h>
+
+#include <libcamera/controls.h>
+
+namespace libcamera {
+
+namespace properties {
+
+enum {
+${ids}
+};
+
+${controls}
+
+extern const ControlIdMap properties;
+
+} /* namespace propertiess */
+
+} /* namespace libcamera */
+
+#endif // __LIBCAMERA_property_IDS_H__
diff --git a/src/libcamera/meson.build b/src/libcamera/meson.build
index c4f965bd7413..0f85414e672f 100644
--- a/src/libcamera/meson.build
+++ b/src/libcamera/meson.build
@@ -73,7 +73,13 @@ control_ids_cpp = custom_target('control_ids_cpp',
                                 depend_files : gen_controls,
                                 command : [gen_controls, '-o', '@OUTPUT@', '@INPUT@'])
 
+property_ids_cpp = custom_target('property_ids_cpp',
+                                input : files('property_ids.yaml', 'property_ids.cpp.in'),
+                                output : 'property_ids.cpp',
+                                depend_files : gen_controls,
+                                command : [gen_controls, '-o', '@OUTPUT@', '@INPUT@'])
 libcamera_sources += control_ids_cpp
+libcamera_sources += property_ids_cpp
 libcamera_sources += control_ids_h
 
 gen_version = join_paths(meson.source_root(), 'utils', 'gen-version.sh')
diff --git a/src/libcamera/property_ids.cpp.in b/src/libcamera/property_ids.cpp.in
new file mode 100644
index 000000000000..1e9ff33f1ec7
--- /dev/null
+++ b/src/libcamera/property_ids.cpp.in
@@ -0,0 +1,43 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
+/*
+ * Copyright (C) 2019, Google Inc.
+ *
+ * property_ids.cpp : Property ID list
+ *
+ * This file is auto-generated. Do not edit.
+ */
+
+#include <libcamera/property_ids.h>
+
+/**
+ * \file property_ids.h
+ * \brief Camera property identifiers
+ */
+
+namespace libcamera {
+
+/**
+ * \brief Namespace for libcamera controls
+ */
+namespace properties {
+
+${controls_doc}
+
+#ifndef __DOXYGEN__
+/*
+ * Keep the controls definitions hidden from doxygen as it incorrectly parses
+ * them as functions.
+ */
+${controls_def}
+#endif
+
+/**
+ * \brief List of all supported libcamera properties
+ */
+extern const ControlIdMap properties {
+${controls_map}
+};
+
+} /* namespace properties */
+
+} /* namespace libcamera */
diff --git a/src/libcamera/property_ids.yaml b/src/libcamera/property_ids.yaml
new file mode 100644
index 000000000000..829f7886d94d
--- /dev/null
+++ b/src/libcamera/property_ids.yaml
@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+#
+# Copyright (C) 2019, Google Inc.
+#
+%YAML 1.2
+---
+controls:
+  - Location:
+      type: int32_t
+      description: |
+        Camera mounting location
+      values:
+        - name: "CAMERA_LOCATION_FRONT"
+          value: 0
+          description: |
+            The camera is mounted on the front side of the device, facing the
+            user
+        - name: "CAMERA_LOCATION_BACK"
+          value: 1
+          description: |
+            The camera is mounted on the back facing side of the device
+        - name: "CAMERA_LOCATION_EXTERNAL"
+          value: 2
+          description: |
+            The camera attached to the device in a way that allows it to
+            move freely
+
+  - Rotation:
+      type: int32_t
+      description: |
+        Camera mounting rotation
+...
-- 
2.23.0



More information about the libcamera-devel mailing list