modulation_matrix.hpp

Go to the documentation of this file.

#pragma once
 
// Modulation-matrix data model.
//
// Pure data layer — stores a set of source→destination modulation routes
// with per-route depth / bipolar / curve. The canvas widget owns drag-connect,
// depth sliders, and bipolar toggles elsewhere; this header keeps the data
// model reusable by code paths that aren't UI (e.g. batch preset tools) and
// lets the audio engine read routes without pulling in view/ headers.
//
// IDs are plugin-supplied opaque integers. By convention sources use
// Processor parameter IDs or MPE expression tags, and destinations use
// parameter IDs. The matrix does not mint or validate them.
 
#include <cstddef>
#include <cstdint>
#include <optional>
#include <vector>
 
namespace pulp::view {
 
using ModSourceId      = uint32_t;
using ModDestinationId = uint32_t;
 
enum class ModCurve : uint8_t {
    Linear     = 0,
    Exponential = 1,
    Logarithmic = 2,
    Quadratic   = 3,
    SCurve      = 4,
};
 
struct ModRoute {
    ModSourceId source = 0;
    ModDestinationId destination = 0;
    float depth = 0.0f;   
    bool bipolar = false; 
    ModCurve curve = ModCurve::Linear;
 
    bool operator==(const ModRoute& other) const {
        return source == other.source
            && destination == other.destination
            && depth == other.depth
            && bipolar == other.bipolar
            && curve == other.curve;
    }
};
 
class ModulationMatrix {
public:
    std::size_t add(const ModRoute& route);

    void remove(std::size_t index);

    void remove_by_destination(ModDestinationId destination);

    std::optional<std::size_t> find(ModSourceId source,
                                    ModDestinationId destination) const;
 
    std::size_t size() const { return routes_.size(); }
    bool empty() const { return routes_.empty(); }
    void clear() { routes_.clear(); }
 
    const std::vector<ModRoute>& routes() const { return routes_; }

    std::vector<uint8_t> serialize() const;

    bool deserialize(const uint8_t* data, std::size_t size);
 
private:
    std::vector<ModRoute> routes_;
};
 
}  // namespace pulp::view