automation_curve.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/runtime/result.hpp>
#include <pulp/timebase/tick.hpp>
#include <pulp/timeline/item_id.hpp>
 
#include <cstdint>
#include <memory>
#include <optional>
#include <span>
#include <vector>
 
namespace pulp::timeline {


enum class AutomationInterpolation : std::uint8_t {
    Hold,
    Continuous,
};

struct AutomationPoint {
    ItemId id;
    timebase::TickPosition position;
    float value = 0.0f;
    AutomationInterpolation interpolation = AutomationInterpolation::Continuous;
    float curvature = 0.0f;
 
    constexpr bool operator==(const AutomationPoint&) const = default;
};

struct AutomationPointPositionLess {
    constexpr bool operator()(const AutomationPoint& lhs,
                              const AutomationPoint& rhs) const noexcept {
        if (lhs.position != rhs.position)
            return lhs.position < rhs.position;
        return lhs.id < rhs.id;
    }
};

float evaluate_continuous_automation_segment(timebase::TickPosition position,
                                             timebase::TickPosition start,
                                             timebase::TickPosition end, float start_value,
                                             float end_value, float curvature) noexcept;

enum class AutomationCurveErrorCode : std::uint8_t {
    InvalidPointId,
    DuplicatePointId,
    DuplicatePosition,
    InvalidInterpolation,
    NonFiniteValue,
    InvalidCurvature,
    MissingPoint,
};

struct AutomationCurveError {
    AutomationCurveErrorCode code = AutomationCurveErrorCode::InvalidPointId;
    ItemId point;
    ItemId related_point;
};

class AutomationCurve {
  public:
    static runtime::Result<AutomationCurve, AutomationCurveError>
    create(std::vector<AutomationPoint> points);

    std::span<const AutomationPoint> points() const noexcept {
        return *points_;
    }

    const AutomationPoint* find_point(ItemId id) const noexcept;

    std::optional<float> value_at(timebase::TickPosition position) const noexcept;

    runtime::Result<AutomationCurve, AutomationCurveError>
    insert_point(AutomationPoint point) const;
    runtime::Result<AutomationCurve, AutomationCurveError>
    replace_point(AutomationPoint point) const;
    runtime::Result<AutomationCurve, AutomationCurveError> erase_point(ItemId id) const;
 
  private:
    explicit AutomationCurve(std::shared_ptr<const std::vector<AutomationPoint>> points)
        : points_(std::move(points)) {}
 
    std::shared_ptr<const std::vector<AutomationPoint>> points_;
};

 
} // namespace pulp::timeline