external_libcamera/include/libcamera/controls.h

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2019, Google Inc.
 *
 * controls.h - Control handling
 */

#ifndef __LIBCAMERA_CONTROLS_H__
#define __LIBCAMERA_CONTROLS_H__

#include <string>
#include <unordered_map>

namespace libcamera {

class ControlValidator;

enum ControlType {
	ControlTypeNone,
	ControlTypeBool,
	ControlTypeInteger32,
	ControlTypeInteger64,
};

class ControlValue
{
public:
	ControlValue();
	ControlValue(bool value);
	ControlValue(int32_t value);
	ControlValue(int64_t value);

	ControlType type() const { return type_; };
	bool isNone() const { return type_ == ControlTypeNone; };

	template<typename T>
	const T &get() const;
	template<typename T>
	void set(const T &value);

	std::string toString() const;

	bool operator==(const ControlValue &other) const;
	bool operator!=(const ControlValue &other) const
	{
		return !(*this == other);
	}

private:
	ControlType type_;

	union {
		bool bool_;
		int32_t integer32_;
		int64_t integer64_;
	};
};

class ControlId
{
public:
	unsigned int id() const { return id_; }
	const std::string &name() const { return name_; }
	ControlType type() const { return type_; }

protected:
	ControlId(unsigned int id, const std::string &name, ControlType type)
		: id_(id), name_(name), type_(type)
	{
	}
#ifndef __DOXYGEN__
	ControlId &operator=(const ControlId &) = default;
	ControlId(const ControlId &) = default;
#endif

private:
	unsigned int id_;
	std::string name_;
	ControlType type_;
};

static inline bool operator==(const ControlId &lhs, const ControlId &rhs)
{
	return lhs.id() == rhs.id();
}

static inline bool operator!=(const ControlId &lhs, const ControlId &rhs)
{
	return !(lhs == rhs);
}

template<typename T>
class Control : public ControlId
{
public:
	using type = T;

	Control(unsigned int id, const char *name);

private:
	Control(const Control &) = delete;
	Control &operator=(const Control &) = delete;
};

class ControlRange
{
public:
	explicit ControlRange(const ControlValue &min = 0,
			      const ControlValue &max = 0);

	const ControlValue &min() const { return min_; }
	const ControlValue &max() const { return max_; }

	std::string toString() const;

private:
	ControlValue min_;
	ControlValue max_;
};

using ControlIdMap = std::unordered_map<unsigned int, const ControlId *>;
using ControlInfoMap = std::unordered_map<const ControlId *, ControlRange>;

class ControlList
{
private:
	using ControlListMap = std::unordered_map<const ControlId *, ControlValue>;

public:
	ControlList(const ControlIdMap &idmap, ControlValidator *validator = nullptr);

	using iterator = ControlListMap::iterator;
	using const_iterator = ControlListMap::const_iterator;

	iterator begin() { return controls_.begin(); }
	iterator end() { return controls_.end(); }
	const_iterator begin() const { return controls_.begin(); }
	const_iterator end() const { return controls_.end(); }

	bool empty() const { return controls_.empty(); }
	std::size_t size() const { return controls_.size(); }
	void clear() { controls_.clear(); }

	bool contains(const ControlId &id) const;
	bool contains(unsigned int id) const;

	template<typename T>
	const T &get(const Control<T> &ctrl) const
	{
		const ControlValue *val = find(ctrl);
		if (!val) {
			static T t(0);
			return t;
		}

		return val->get<T>();
	}

	template<typename T>
	void set(const Control<T> &ctrl, const T &value)
	{
		ControlValue *val = find(ctrl);
		if (!val)
			return;

		val->set<T>(value);
	}

	const ControlValue &get(unsigned int id) const;
	void set(unsigned int id, const ControlValue &value);

private:
	const ControlValue *find(const ControlId &id) const;
	ControlValue *find(const ControlId &id);

	ControlValidator *validator_;
	const ControlIdMap *idmap_;
	ControlListMap controls_;
};

} /* namespace libcamera */

#endif /* __LIBCAMERA_CONTROLS_H__ */