/* * Copyright (c) 2021-2022, kleines Filmröllchen * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include namespace DSP { using ParameterFixedPoint = FixedPoint<8, i64>; // Identifies the different kinds of parameters. // Note that achieving parameter type identification is NOT possible with typeid(). enum class ParameterType : u8 { Invalid = 0, Range, Enum, Boolean, }; enum class Logarithmic : bool { No, Yes }; // Processors have modifiable parameters that should be presented to the UI in a uniform way without requiring the processor itself to implement custom interfaces. class ProcessorParameter { public: ProcessorParameter(String name, ParameterType type) : m_name(move(name)) , m_type(type) { } String const& name() const { return m_name; } ParameterType type() const { return m_type; } private: String const m_name; ParameterType const m_type; }; namespace Detail { struct ProcessorParameterSetValueTag { explicit ProcessorParameterSetValueTag() = default; }; template class ProcessorParameterSingleValue : public ProcessorParameter { public: ProcessorParameterSingleValue(String name, ParameterType type, ParameterT initial_value) : ProcessorParameter(move(name), type) , m_value(move(initial_value)) { } operator ParameterT() const { return value(); } operator double() const requires(IsSame) { return static_cast(value()); } ParameterT value() const { return m_value; }; void set_value(ParameterT value) { set_value_sneaky(value, DSP::Detail::ProcessorParameterSetValueTag {}); for (auto const& did_change_value : m_change_value_listeners) did_change_value(value); } // Use of this function is discouraged. It doesn't notify the value listener. void set_value_sneaky(ParameterT value, [[maybe_unused]] Detail::ProcessorParameterSetValueTag) { if (value != m_value) m_value = value; } // FIXME: Devise a good API for unregistering listeners. void register_change_listener(Function listener) { m_change_value_listeners.append(move(listener)); } protected: ParameterT m_value; Vector> m_change_value_listeners; }; } class ProcessorBooleanParameter final : public Detail::ProcessorParameterSingleValue { public: ProcessorBooleanParameter(String name, bool initial_value) : Detail::ProcessorParameterSingleValue(move(name), ParameterType::Boolean, move(initial_value)) { } }; class ProcessorRangeParameter final : public Detail::ProcessorParameterSingleValue { public: ProcessorRangeParameter(String name, ParameterFixedPoint min_value, ParameterFixedPoint max_value, ParameterFixedPoint initial_value, Logarithmic logarithmic) : Detail::ProcessorParameterSingleValue(move(name), ParameterType::Range, move(initial_value)) , m_min_value(move(min_value)) , m_max_value(move(max_value)) , m_default_value(move(initial_value)) , m_logarithmic(logarithmic) { VERIFY(initial_value <= max_value && initial_value >= min_value); } ProcessorRangeParameter(ProcessorRangeParameter const& to_copy) : ProcessorRangeParameter(to_copy.name(), to_copy.min_value(), to_copy.max_value(), to_copy.value(), to_copy.is_logarithmic()) { } ParameterFixedPoint min_value() const { return m_min_value; } ParameterFixedPoint max_value() const { return m_max_value; } ParameterFixedPoint range() const { return m_max_value - m_min_value; } constexpr Logarithmic is_logarithmic() const { return m_logarithmic; } ParameterFixedPoint default_value() const { return m_default_value; } void set_value(ParameterFixedPoint value) { VERIFY(value <= m_max_value && value >= m_min_value); Detail::ProcessorParameterSingleValue::set_value(value); } private: double const m_min_value; double const m_max_value; double const m_default_value; Logarithmic const m_logarithmic; }; template requires(IsEnum) class ProcessorEnumParameter final : public Detail::ProcessorParameterSingleValue { public: ProcessorEnumParameter(String name, EnumT initial_value) : Detail::ProcessorParameterSingleValue(move(name), ParameterType::Enum, initial_value) { } }; } template<> struct AK::Formatter : AK::StandardFormatter { Formatter() = default; explicit Formatter(StandardFormatter formatter) : StandardFormatter(formatter) { } ErrorOr format(FormatBuilder& builder, DSP::ProcessorRangeParameter value) { if (m_mode == Mode::Pointer) { Formatter formatter { *this }; return formatter.format(builder, reinterpret_cast(&value)); } if (m_sign_mode != FormatBuilder::SignMode::Default) VERIFY_NOT_REACHED(); if (m_alternative_form) VERIFY_NOT_REACHED(); if (m_zero_pad) VERIFY_NOT_REACHED(); if (m_mode != Mode::Default) VERIFY_NOT_REACHED(); if (m_width.has_value() && m_precision.has_value()) VERIFY_NOT_REACHED(); m_width = m_width.value_or(0); m_precision = m_precision.value_or(NumericLimits::max()); TRY(builder.put_literal(String::formatted("[{} - {}]: {}", value.min_value(), value.max_value(), value.value()))); return {}; } };