From patchwork Wed Aug 10 00:29:05 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 17064 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 7BFA3C3275 for ; Wed, 10 Aug 2022 00:29:25 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 3231063331; Wed, 10 Aug 2022 02:29:25 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1660091365; bh=R2E0Hd9RKLSF/Cq39wA7EfTlovoHLZaj8snJm2/wYeE=; h=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=OFjl5PiTUTqmms1as/0ybPm8YVgTV2Ouz7sYgbFFmtVZzpAQTEGAVKKIhErhcGMY7 HiPL9oKf5pH4ESu+xaZ6hDT3wk19i1Iw2dKstsZjUPdPX9mVFykyIvm6r2llmc9PSw aHoRi8vCptC9AbucHZG3izO/95azR2gu3YXCrhoOf5dk8zW+QgMC5hvA0ozRazTYhH t+7tGPJw/a0htaJvh9NNzZko9cPZoUvfklMA5oXXTfBj2o7Tl0U73v1XZzoqRKffwb wpvfxllIXyFKs9JiCblqn3LubjcckJGxMywybP27wJoFT9lFQIMbFqqmiLFGm6Ayrv ESlZAKu7GGzwg== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 9128C63326 for ; Wed, 10 Aug 2022 02:29:22 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="fEp40fGT"; dkim-atps=neutral Received: from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi [62.78.145.57]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 2AC64481; Wed, 10 Aug 2022 02:29:22 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1660091362; bh=R2E0Hd9RKLSF/Cq39wA7EfTlovoHLZaj8snJm2/wYeE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=fEp40fGT57KJBcou0xErEhN4Ps/JA1Gs0OMcGWfwN6nLW1Giw+wh39AKB9dH6ZNVX p3yrozbM4kHmeRMO4n6JlEHjkowqghMMgFteQ7fmZSHCLR+U6PQ8atL9PnoTyQl/oj G2olVeOQ+w41ih7Hbf2pCdWPaB1gz1HiZOipY+Ys= To: libcamera-devel@lists.libcamera.org Date: Wed, 10 Aug 2022 03:29:05 +0300 Message-Id: <20220810002906.5406-4-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220810002906.5406-1-laurent.pinchart@ideasonboard.com> References: <20220810002906.5406-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 3/4] libcamera: controls: Store array control size in Control class X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Laurent Pinchart via libcamera-devel From: Laurent Pinchart Reply-To: Laurent Pinchart Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Baside just identifying a control, the Control class enables usage of the control type for metaprogramming. This is mainly used by the ControlList get() and set() functions to type-check and cast the control value automatically at compilation time. Extend this with a new Size template argument for the Control class that specifies the size of array controls. Use it already in the ControlList::set() overload that takes an std::initializer list to construct the Span with an explicit size, enabling usage of the function for fixed-size array controls. A possible future extension would be to pass the size to the ControlId constructor and store it internally, enabling access to the size at runtime, for instance to perform validity checks. Signed-off-by: Laurent Pinchart --- include/libcamera/controls.h | 20 +++++++++++-------- src/libcamera/controls.cpp | 37 +++++++++++++++++++++++++++--------- utils/gen-controls.py | 24 +++++++++++++++++++++-- 3 files changed, 62 insertions(+), 19 deletions(-) diff --git a/include/libcamera/controls.h b/include/libcamera/controls.h index ebc168fc28b7..dd474a807d68 100644 --- a/include/libcamera/controls.h +++ b/include/libcamera/controls.h @@ -8,6 +8,7 @@ #pragma once #include +#include #include #include #include @@ -213,6 +214,8 @@ private: class ControlId { public: + static constexpr size_t dynamic_size = std::numeric_limits::max(); + ControlId(unsigned int id, const std::string &name, ControlType type) : id_(id), name_(name), type_(type) { @@ -250,11 +253,12 @@ static inline bool operator!=(const ControlId &lhs, unsigned int rhs) return !(lhs == rhs); } -template +template class Control : public ControlId { public: using type = T; + static constexpr size_t size = Size; Control(unsigned int id, const char *name) : ControlId(id, name, details::control_type>::value) @@ -372,8 +376,8 @@ public: bool contains(unsigned int id) const; - template - std::optional get(const Control &ctrl) const + template + std::optional get(const Control &ctrl) const { const auto entry = controls_.find(ctrl.id()); if (entry == controls_.end()) @@ -383,8 +387,8 @@ public: return val.get(); } - template - void set(const Control &ctrl, const V &value) + template + void set(const Control &ctrl, const V &value) { ControlValue *val = find(ctrl.id()); if (!val) @@ -393,14 +397,14 @@ public: val->set(value); } - template - void set(const Control &ctrl, const std::initializer_list &value) + template + void set(const Control &ctrl, const std::initializer_list &value) { ControlValue *val = find(ctrl.id()); if (!val) return; - val->set(Span>{ value.begin(), value.size() }); + val->set(Span, Size>{ value.begin(), value.size() }); } const ControlValue &get(unsigned int id) const; diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp index bc3db4f69388..24c836382f10 100644 --- a/src/libcamera/controls.cpp +++ b/src/libcamera/controls.cpp @@ -384,6 +384,11 @@ void ControlValue::reserve(ControlType type, bool isArray, std::size_t numElemen * Control class for more information. */ +/** + * \var ControlId::dynamic_size + * \brief Size value for dynamic array controls + */ + /** * \fn ControlId::ControlId(unsigned int id, const std::string &name, ControlType type) * \brief Construct a ControlId instance @@ -431,12 +436,17 @@ void ControlValue::reserve(ControlType type, bool isArray, std::size_t numElemen /** * \class Control * \brief Describe a control and its intrinsic properties + * \tparam T The control data type + * \tparam Size The number of elements (for array controls only) * - * The Control class models a control exposed by an object. Its template type - * name T refers to the control data type, and allows functions that operate on - * control values to be defined as template functions using the same type T for - * the control value. See for instance how the ControlList::get() function - * returns a value corresponding to the type of the requested control. + * The Control class models a control exposed by an object. Its template + * paramter \a T refers to the control data type, and allows functions that + * operate on control values to be defined as template functions using the same + * type T for the control value. See for instance how the ControlList::get() + * function returns a value corresponding to the type of the requested control. + * + * Similarly, for array controls the template parameter \a Size indicates the + * number of elements in the array. * * While this class is the main means to refer to a control, the control * identifying information is stored in the non-template base ControlId class. @@ -469,6 +479,15 @@ void ControlValue::reserve(ControlType type, bool isArray, std::size_t numElemen * \brief The Control template type T */ +/** + * \var Control::size + * \brief The number of elements for array controls + * + * The \a size reports the number of elements stored by an array Control. It is + * equal to 0 for non-array controls, and to ControlId::dynamic_size for + * variable-size controls. + */ + /** * \class ControlInfo * \brief Describe the limits of valid values for a Control @@ -943,7 +962,7 @@ bool ControlList::contains(unsigned int id) const } /** - * \fn ControlList::get(const Control &ctrl) const + * \fn ControlList::get(const Control &ctrl) const * \brief Get the value of control \a ctrl * \param[in] ctrl The control * @@ -956,7 +975,7 @@ bool ControlList::contains(unsigned int id) const */ /** - * \fn ControlList::set(const Control &ctrl, const V &value) + * \fn ControlList::set(const Control &ctrl, const V &value) * \brief Set the control \a ctrl value to \a value * \param[in] ctrl The control * \param[in] value The control value @@ -970,8 +989,8 @@ bool ControlList::contains(unsigned int id) const */ /** - * \fn ControlList::set(const Control &ctrl, const std::initializer_list &value) - * \copydoc ControlList::set(const Control &ctrl, const V &value) + * \fn ControlList::set(const Control &ctrl, const std::initializer_list &value) + * \copydoc ControlList::set(const Control &ctrl, const V &value) */ /** diff --git a/utils/gen-controls.py b/utils/gen-controls.py index bcfbeb7f9f17..a3b9c58beec6 100755 --- a/utils/gen-controls.py +++ b/utils/gen-controls.py @@ -100,6 +100,10 @@ class Control(object): ns = 'draft::' if self.is_draft else '' return ns + self.__name + @property + def size(self): + return self.__size + @property def type(self): typ = self.__data.get('type') @@ -137,7 +141,7 @@ ${description}''') * \\var ${name} ${description} */''') - def_template = string.Template('extern const Control<${type}> ${name}(${id_name}, "${name}");') + def_template = string.Template('extern const Control<${type}${size}> ${name}(${id_name}, "${name}");') enum_values_doc = string.Template('''/** * \\var ${name}Values * \\brief List of all $name supported values @@ -154,9 +158,17 @@ ${description} for ctrl in controls: id_name = snake_case(ctrl.name).upper() + if ctrl.size is None: + size = '' + elif ctrl.size == 0: + size = ', ControlId::dynamic_size' + else: + size = f', {ctrl.size}' + info = { 'name': ctrl.name, 'type': ctrl.type, + 'size': size, 'description': format_description(ctrl.description), 'id_name': id_name, } @@ -216,7 +228,7 @@ def generate_h(controls): enum_template_start = string.Template('''enum ${name}Enum {''') enum_value_template = string.Template('''\t${name} = ${value},''') enum_values_template = string.Template('''extern const std::array ${name}Values;''') - template = string.Template('''extern const Control<${type}> ${name};''') + template = string.Template('''extern const Control<${type}${size}> ${name};''') ctrls = [] draft_ctrls = [] @@ -228,9 +240,17 @@ def generate_h(controls): ids.append('\t' + id_name + ' = ' + str(id_value) + ',') + if ctrl.size is None: + size = '' + elif ctrl.size == 0: + size = ', ControlId::dynamic_size' + else: + size = f', {ctrl.size}' + info = { 'name': ctrl.name, 'type': ctrl.type, + 'size': size, } target_ctrls = ctrls