From patchwork Sat Sep 28 15:22:33 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 2049 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id A0DD661922 for ; Sat, 28 Sep 2019 17:22:58 +0200 (CEST) Received: from pendragon.bb.dnainternet.fi (dfj612yhrgyx302h3jwwy-3.rev.dnainternet.fi [IPv6:2001:14ba:21f5:5b00:ce28:277f:58d7:3ca4]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 0EDD0593 for ; Sat, 28 Sep 2019 17:22:58 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1569684178; bh=w1HYYrMv2/Y7NiDNksCrSYGbKaMwSvl8dho8PDQBM1Y=; h=From:To:Subject:Date:In-Reply-To:References:From; b=aRb2tnPCUOLUZD++xbQsUs5oW+EkjJ5YmOdvXPrfsvH//B76R4D4ar/mzWgGvss8P 3Ppb2gVxte6vKfV0u+lDxKV1gPKNbWs6Ww7kr3vu00CvbP2tbbzit9ZpPXCOOWPRXo NmdPrvoCwc8eeAHlueHGK3e58JCEgwDe5q5lxdoI= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Sat, 28 Sep 2019 18:22:33 +0300 Message-Id: <20190928152238.23752-8-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190928152238.23752-1-laurent.pinchart@ideasonboard.com> References: <20190928152238.23752-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 07/12] libcamera: controls: Rename ControlInfo to ControlRange 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-List-Received-Date: Sat, 28 Sep 2019 15:22:59 -0000 The ControlInfo class stores a range of valid values for a control. Its name is vague, as "info" has multiple meanings. Rename it to ControlRange. Signed-off-by: Laurent Pinchart Reviewed-by: Jacopo Mondi --- include/libcamera/controls.h | 8 +++--- src/libcamera/controls.cpp | 28 +++++++++---------- .../{control_info.cpp => control_range.cpp} | 14 +++++----- test/controls/meson.build | 2 +- 4 files changed, 26 insertions(+), 26 deletions(-) rename test/controls/{control_info.cpp => control_range.cpp} (75%) diff --git a/include/libcamera/controls.h b/include/libcamera/controls.h index 854ea3b84267..d3eea643c0ec 100644 --- a/include/libcamera/controls.h +++ b/include/libcamera/controls.h @@ -95,11 +95,11 @@ private: Control &operator=(const Control &) = delete; }; -class ControlInfo +class ControlRange { public: - explicit ControlInfo(const ControlValue &min = 0, - const ControlValue &max = 0); + explicit ControlRange(const ControlValue &min = 0, + const ControlValue &max = 0); const ControlValue &min() const { return min_; } const ControlValue &max() const { return max_; } @@ -111,7 +111,7 @@ private: ControlValue max_; }; -using ControlInfoMap = std::unordered_map; +using ControlInfoMap = std::unordered_map; class ControlList { diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp index 6a3bb353792d..51abb4ea7f6f 100644 --- a/src/libcamera/controls.cpp +++ b/src/libcamera/controls.cpp @@ -312,42 +312,42 @@ Control::Control(unsigned int id, const char *name) #endif /* __DOXYGEN__ */ /** - * \class ControlInfo - * \brief Describe the information and capabilities of a Control + * \class ControlRange + * \brief Describe the limits of valid values for a Control * - * The ControlInfo represents control specific meta-data which is constant on a - * per camera basis. ControlInfo classes are constructed by pipeline handlers - * to expose the controls they support and the metadata needed to utilise those - * controls. + * The ControlRange expresses the constraints on valid values for a control. + * The constraints depend on the object the control applies to, and are + * constant for the lifetime of that object. They are typically constructed by + * pipeline handlers to describe the controls they support. */ /** - * \brief Construct a ControlInfo with minimum and maximum range parameters + * \brief Construct a ControlRange with minimum and maximum range parameters * \param[in] min The control minimum value * \param[in] max The control maximum value */ -ControlInfo::ControlInfo(const ControlValue &min, - const ControlValue &max) +ControlRange::ControlRange(const ControlValue &min, + const ControlValue &max) : min_(min), max_(max) { } /** - * \fn ControlInfo::min() + * \fn ControlRange::min() * \brief Retrieve the minimum value of the control * \return A ControlValue with the minimum value for the control */ /** - * \fn ControlInfo::max() + * \fn ControlRange::max() * \brief Retrieve the maximum value of the control * \return A ControlValue with the maximum value for the control */ /** - * \brief Provide a string representation of the ControlInfo + * \brief Provide a string representation of the ControlRange */ -std::string ControlInfo::toString() const +std::string ControlRange::toString() const { std::stringstream ss; @@ -358,7 +358,7 @@ std::string ControlInfo::toString() const /** * \typedef ControlInfoMap - * \brief A map of ControlId to ControlInfo + * \brief A map of ControlId to ControlRange */ /** diff --git a/test/controls/control_info.cpp b/test/controls/control_range.cpp similarity index 75% rename from test/controls/control_info.cpp rename to test/controls/control_range.cpp index 9cf59185e459..06ec3506ee62 100644 --- a/test/controls/control_info.cpp +++ b/test/controls/control_range.cpp @@ -2,7 +2,7 @@ /* * Copyright (C) 2019, Google Inc. * - * control_info.cpp - ControlInfo tests + * control_range.cpp - ControlRange tests */ #include @@ -15,16 +15,16 @@ using namespace std; using namespace libcamera; -class ControlInfoTest : public Test +class ControlRangeTest : public Test { protected: int run() { /* - * Test information retrieval from a control with no minimum - * and maximum. + * Test information retrieval from a range with no minimum and + * maximum. */ - ControlInfo brightness; + ControlRange brightness; if (brightness.min().get() != 0 || brightness.max().get() != 0) { @@ -36,7 +36,7 @@ protected: * Test information retrieval from a control with a minimum and * a maximum value. */ - ControlInfo contrast(10, 200); + ControlRange contrast(10, 200); if (contrast.min().get() != 10 || contrast.max().get() != 200) { @@ -48,4 +48,4 @@ protected: } }; -TEST_REGISTER(ControlInfoTest) +TEST_REGISTER(ControlRangeTest) diff --git a/test/controls/meson.build b/test/controls/meson.build index f4fc7b947dd9..9f0f005a2759 100644 --- a/test/controls/meson.build +++ b/test/controls/meson.build @@ -1,6 +1,6 @@ control_tests = [ - [ 'control_info', 'control_info.cpp' ], [ 'control_list', 'control_list.cpp' ], + [ 'control_range', 'control_range.cpp' ], [ 'control_value', 'control_value.cpp' ], ]