curve.hpp

Go to the documentation of this file.

#pragma once
 
#include <ossia/detail/config.hpp>
 
#include <ossia/detail/flat_map.hpp>
#include <ossia/detail/optional.hpp>
#include <ossia/detail/ptr_container.hpp>
#include <ossia/editor/curve/curve_abstract.hpp>
#include <ossia/editor/curve/curve_segment.hpp>
#include <ossia/editor/curve/curve_segment/easing.hpp>
#include <ossia/network/base/node.hpp>
#include <ossia/network/base/parameter.hpp>
#include <ossia/network/value/destination.hpp>
#include <ossia/network/value/value.hpp>
 
#include <functional>
#include <memory>
#include <utility>
#include <vector>

 
namespace ossia
{
class destination;
 
template <typename T>
static constexpr auto curve_segment_type_map()
{
  if constexpr(std::is_same_v<T, int>)
    return ossia::curve_segment_type::INT;
  else if constexpr(std::is_same_v<T, int64_t>)
    return ossia::curve_segment_type::INT64;
  else if constexpr(std::is_same_v<T, float>)
    return ossia::curve_segment_type::FLOAT;
  else if constexpr(std::is_same_v<T, double>)
    return ossia::curve_segment_type::DOUBLE;
  else if constexpr(std::is_same_v<T, bool>)
    return ossia::curve_segment_type::BOOL;
  else if constexpr(std::is_same_v<T, ossia::value>)
    return ossia::curve_segment_type::ANY;
  else
    return nullptr;
}
 
template <typename K, typename V>
using curve_map = ossia::flat_map<K, V>;
 
template <typename X, typename Y>
class OSSIA_TEST_EXPORT curve final : public curve_abstract
{
public:
  using abscissa_type = X;
  using ordinate_type = Y;
  using curve_type = curve<X, Y>;
  using map_type = curve_map<X, std::pair<Y, ossia::curve_segment<Y>>>;
 
  curve() = default;
  curve(const curve& other)
  {
    m_x0 = other.m_x0;
    m_y0 = other.m_y0;
    m_y0_destination = other.m_y0_destination;
 
    m_points = other.m_points;
 
    m_y0_cacheUsed = false;
  }
 
  curve(curve&& other) noexcept
  {
    m_x0 = other.m_x0;
    m_y0 = other.m_y0;
    m_y0_destination = std::move(other.m_y0_destination);
 
    m_points = std::move(other.m_points);
 
    m_y0_cacheUsed = false;
  }
 
  curve& operator=(const curve& other)
  {
    m_x0 = other.m_x0;
    m_y0 = other.m_y0;
    m_y0_destination = other.m_y0_destination;
 
    m_points = other.m_points;
 
    m_y0_cacheUsed = false;
    return *this;
  }
  curve& operator=(curve&& other) noexcept
  {
    m_x0 = other.m_x0;
    m_y0 = other.m_y0;
    m_y0_destination = std::move(other.m_y0_destination);
 
    m_points = std::move(other.m_points);
 
    m_y0_cacheUsed = false;
    return *this;
  }
  virtual ~curve() = default;
 
  void reset() override;

  bool add_point(ossia::curve_segment<Y>&& segment, X abscissa, Y value);

  bool remove_point(X abscissa);

  Y value_at(X abscissa) const;
 
  ossia::curve_type get_type() const override;

  X get_x0() const;

  Y get_y0() const;

  void set_x0(X value);

  void set_y0(Y value);

  std::optional<destination> get_y0_destination() const;

  void set_y0_destination(const ossia::destination& destination);

  map_type get_points() const;
 
  static Y convert_to_template_type_value(
      const ossia::value& value, ossia::destination_index::const_iterator idx);
 
  void reserve(std::size_t count) { m_points.reserve(count); }
 
private:
  mutable X m_x0;
  mutable Y m_y0;
  mutable std::optional<ossia::destination> m_y0_destination;
 
  mutable map_type m_points;
 
  mutable Y m_y0_cache;
 
  mutable bool m_y0_cacheUsed = false;
};
 
template <typename X, typename Y>
inline void curve<X, Y>::reset()
{
  m_y0_cacheUsed = false;
}
 
template <typename X, typename Y>
inline bool
curve<X, Y>::add_point(ossia::curve_segment<Y>&& segment, X abscissa, Y value)
{
  // Curves are built in increasing abscissa: the hint makes that O(1).
  m_points.emplace_hint(
      m_points.end(), abscissa, std::make_pair(value, std::move(segment)));
 
  return true;
}
 
template <typename X, typename Y>
inline bool curve<X, Y>::remove_point(X abscissa)
{
  return m_points.erase(abscissa) > 0;
}
 
template <typename X, typename Y>
inline Y curve<X, Y>::value_at(X abscissa) const
{
  // Runs on the audio thread on every tick.
  const X x0 = get_x0();
  // Always read: with a destination, the first call captures the start value.
  const Y y0 = get_y0();
  if(!(abscissa > x0))
    return y0;
 
  // The first point at or after abscissa, and the one before it.
  auto it = m_points.lower_bound(abscissa);
  if(it == m_points.end())
    return m_points.empty() ? y0 : std::prev(it)->second.first;
 
  X lastAbscissa = x0;
  Y lastValue = y0;
  if(it != m_points.begin())
  {
    auto prev = std::prev(it);
    if(prev->first >= x0)
    {
      lastAbscissa = prev->first;
      lastValue = prev->second.first;
    }
  }
 
  return it->second.second(
      ((double)abscissa - (double)lastAbscissa)
          / ((double)it->first - (double)lastAbscissa),
      lastValue, it->second.first);
}
 
template <typename X, typename Y>
inline curve_type curve<X, Y>::get_type() const
{
  static constexpr auto type
      = std::make_pair(curve_segment_type_map<X>(), curve_segment_type_map<Y>());
  return type;
}
 
template <typename X, typename Y>
inline X curve<X, Y>::get_x0() const
{
  return m_x0;
}
 
template <typename X, typename Y>
inline Y curve<X, Y>::get_y0() const
{
  if(!m_y0_destination)
    return m_y0;
  else
  {
    if(m_y0_cacheUsed)
      return m_y0_cache;
 
    const destination& dest = *m_y0_destination;
    m_y0_cacheUsed = true;
    m_y0_cache = convert_to_template_type_value(
        dest.address().fetch_value(), dest.index.begin());
 
    return m_y0_cache;
  }
}
 
template <typename X, typename Y>
inline void curve<X, Y>::set_x0(X value)
{
  m_x0 = value;
}
 
template <typename X, typename Y>
inline void curve<X, Y>::set_y0(Y value)
{
  m_y0 = value;
}
 
template <typename X, typename Y>
inline std::optional<destination> curve<X, Y>::get_y0_destination() const
{
  return m_y0_destination;
}
 
template <typename X, typename Y>
inline void curve<X, Y>::set_y0_destination(const destination& destination)
{
  m_y0_destination = destination;
}
 
template <typename X, typename Y>
inline typename curve<X, Y>::map_type curve<X, Y>::get_points() const
{
  return m_points;
}
 
template <typename X, typename Y>
inline Y curve<X, Y>::convert_to_template_type_value(
    const value& v, ossia::destination_index::const_iterator idx)
{
  using namespace ossia;
  using namespace std;
  struct visitor
  {
    destination_index::const_iterator index;
    Y operator()(int32_t i) const { return i; }
    Y operator()(float f) const { return f; }
    Y operator()(bool b) const { return b; }
    Y operator()(char c) const { return c; }
    Y operator()(vec2f vec) const { return vec[*index]; }
    Y operator()(vec3f vec) const { return vec[*index]; }
    Y operator()(vec4f vec) const { return vec[*index]; }
    Y operator()(const std::vector<ossia::value>& t) const
    {
      auto& val = t[*index];
      return convert_to_template_type_value(val, index + 1);
    }
    Y operator()(const value_map_type& t) const
    {
#if defined(__cpp_exceptions)
      throw invalid_value_type_error(
          "curve_impl::convertToTemplateTypeValue: "
          "Cannot convert Map to a numeric type");
#endif
      return {};
    }
 
    Y operator()(impulse) const
    {
#if defined(__cpp_exceptions)
      throw invalid_value_type_error(
          "curve_impl::convertToTemplateTypeValue: "
          "Cannot convert Impulse to a numeric type");
#endif
      return {};
    }
    Y operator()(const std::string& str) const
    {
#if defined(__cpp_exceptions)
      throw invalid_value_type_error(
          "curve_impl::convertToTemplateTypeValue: "
          "Cannot convert String to a numeric type");
#endif
      return {};
    }
    Y operator()() const
    {
#if defined(__cpp_exceptions)
      throw invalid_value_type_error(
          "curve_impl::convertToTemplateTypeValue: "
          "No type provided");
#endif
      return {};
    }
  } vis{idx};
 
  return v.apply(vis);
}

class OSSIA_EXPORT constant_curve final : public curve_abstract
{
public:
  constant_curve(ossia::value v)
      : mValue{std::move(v)}
  {
  }
  ~constant_curve() override;
  constant_curve() = default;
  constant_curve(const constant_curve&) = delete;
  constant_curve(constant_curve&&) = delete;
  constant_curve& operator=(const constant_curve&) = delete;
  constant_curve& operator=(constant_curve&&) = delete;
 
  [[nodiscard]] ossia::value value() const { return mValue; }
 
  [[nodiscard]] curve_type get_type() const override
  {
    return std::make_pair(
        ossia::curve_segment_type::DOUBLE, ossia::curve_segment_type::ANY);
  }
 
  void reset() override { }
 
private:
  const ossia::value mValue;
};
}