From ace50f75a4d4c10c0deb90fc857525b565cdd8c9 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Sat, 28 Sep 2019 16:22:24 +0300 Subject: libcamera: controls: Rename ControlInfo to ControlRange MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Niklas Söderlund --- include/libcamera/controls.h | 8 +++---- src/libcamera/controls.cpp | 28 +++++++++++----------- test/controls/control_info.cpp | 51 ----------------------------------------- test/controls/control_range.cpp | 51 +++++++++++++++++++++++++++++++++++++++++ test/controls/meson.build | 2 +- 5 files changed, 70 insertions(+), 70 deletions(-) delete mode 100644 test/controls/control_info.cpp create mode 100644 test/controls/control_range.cpp diff --git a/include/libcamera/controls.h b/include/libcamera/controls.h index 854ea3b8..d3eea643 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 526b7755..a7e9d069 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_info.cpp deleted file mode 100644 index 9cf59185..00000000 --- a/test/controls/control_info.cpp +++ /dev/null @@ -1,51 +0,0 @@ -/* SPDX-License-Identifier: GPL-2.0-or-later */ -/* - * Copyright (C) 2019, Google Inc. - * - * control_info.cpp - ControlInfo tests - */ - -#include - -#include -#include - -#include "test.h" - -using namespace std; -using namespace libcamera; - -class ControlInfoTest : public Test -{ -protected: - int run() - { - /* - * Test information retrieval from a control with no minimum - * and maximum. - */ - ControlInfo brightness; - - if (brightness.min().get() != 0 || - brightness.max().get() != 0) { - cout << "Invalid control range for Brightness" << endl; - return TestFail; - } - - /* - * Test information retrieval from a control with a minimum and - * a maximum value. - */ - ControlInfo contrast(10, 200); - - if (contrast.min().get() != 10 || - contrast.max().get() != 200) { - cout << "Invalid control range for Contrast" << endl; - return TestFail; - } - - return TestPass; - } -}; - -TEST_REGISTER(ControlInfoTest) diff --git a/test/controls/control_range.cpp b/test/controls/control_range.cpp new file mode 100644 index 00000000..06ec3506 --- /dev/null +++ b/test/controls/control_range.cpp @@ -0,0 +1,51 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/* + * Copyright (C) 2019, Google Inc. + * + * control_range.cpp - ControlRange tests + */ + +#include + +#include +#include + +#include "test.h" + +using namespace std; +using namespace libcamera; + +class ControlRangeTest : public Test +{ +protected: + int run() + { + /* + * Test information retrieval from a range with no minimum and + * maximum. + */ + ControlRange brightness; + + if (brightness.min().get() != 0 || + brightness.max().get() != 0) { + cout << "Invalid control range for Brightness" << endl; + return TestFail; + } + + /* + * Test information retrieval from a control with a minimum and + * a maximum value. + */ + ControlRange contrast(10, 200); + + if (contrast.min().get() != 10 || + contrast.max().get() != 200) { + cout << "Invalid control range for Contrast" << endl; + return TestFail; + } + + return TestPass; + } +}; + +TEST_REGISTER(ControlRangeTest) diff --git a/test/controls/meson.build b/test/controls/meson.build index f4fc7b94..9f0f005a 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' ], ] -- cgit v1.2.1