module_descriptor.hpp

Go to the documentation of this file.

#pragma once

 
#include <cmath>
#include <cstdint>
#include <string>
#include <vector>
 
namespace pulp::format::rack {

inline constexpr double kHpMm = 5.08;
inline constexpr double kPanelHeightMm = 380.0 / 75.0 * 25.4;  // 128.69333…
inline constexpr double kRackDpi = 75.0;
 
inline constexpr double hp_to_mm(int hp) { return hp * kHpMm; }
inline constexpr double mm_to_px(double mm) { return mm / 25.4 * kRackDpi; }

namespace volts {
inline constexpr float kAudioPeak = 5.0f;     
inline constexpr float kCvUnipolar = 10.0f;   
inline constexpr float kCvBipolar = 5.0f;     
inline constexpr float kGateHigh = 10.0f;     
inline constexpr float kSchmittLow = 0.1f;    
inline constexpr float kSchmittHigh = 1.0f;
inline constexpr float kPitchRefHz = 261.6256f;
inline constexpr float kLfoRefHz = 2.0f;
inline float voct_to_hz(float volts, float ref_hz = kPitchRefHz) {
    return ref_hz * std::pow(2.0f, volts);
}
}  // namespace volts

enum class ControlKind {
    KnobLarge,   
    Knob,        
    KnobSmall,   
    Trimpot,     
    Toggle,      
    Button,      
};

enum class PortRole {
    Audio,    
    Cv,       
    Pitch,    
    Gate,     
    Trigger,  
    Clock,    
};

inline constexpr double control_radius_mm(ControlKind k) {
    switch (k) {
        case ControlKind::KnobLarge: return 9.15;   // 54 px / 2
        case ControlKind::Knob:      return 6.10;   // 36 px / 2
        case ControlKind::KnobSmall: return 4.32;   // 25.5 px / 2
        case ControlKind::Trimpot:   return 2.88;   // 17 px / 2
        case ControlKind::Toggle:    return 3.49;   // 20.6 px / 2 (tall axis)
        case ControlKind::Button:    return 3.05;
    }
    return 6.10;
}

inline constexpr double kJackRadiusMm = 4.11;
inline constexpr double kLightRadiusMm = 1.39;

inline const char* widget_class(ControlKind k) {
    switch (k) {
        case ControlKind::KnobLarge: return "RoundBigBlackKnob";
        case ControlKind::Knob:      return "RoundBlackKnob";
        case ControlKind::KnobSmall: return "RoundSmallBlackKnob";
        case ControlKind::Trimpot:   return "Trimpot";
        case ControlKind::Toggle:    return "CKSS";
        case ControlKind::Button:    return "VCVButton";
    }
    return "RoundBlackKnob";
}
 
struct ParamSpec {
    int id = 0;
    std::string ident;             
    std::string name;              
    std::string label;             
    std::string unit;              
    float min_value = 0.0f;
    float max_value = 1.0f;
    float default_value = 0.0f;
    ControlKind kind = ControlKind::Knob;
    double x_mm = 0.0;
    double y_mm = 0.0;
    float display_base = 0.0f;
    float display_multiplier = 1.0f;
    bool snap = false;             
};
 
struct PortSpec {
    int id = 0;
    std::string ident;             
    std::string name;              
    std::string label;             
    PortRole role = PortRole::Audio;
    double x_mm = 0.0;
    double y_mm = 0.0;
};
 
struct LightSpec {
    int id = 0;
    std::string ident;
    std::string name;
    std::string label;
    double x_mm = 0.0;
    double y_mm = 0.0;
};

struct ModuleDescriptor {
    std::string slug;              
    std::string name;              
    std::string description;
    std::vector<std::string> tags; 
    int hp = 8;
    std::vector<ParamSpec> params;
    std::vector<PortSpec> inputs;
    std::vector<PortSpec> outputs;
    std::vector<LightSpec> lights;
 
    double width_mm() const { return hp_to_mm(hp); }
};

struct PluginManifest {
    std::string slug;              
    std::string name;
    std::string brand;             
    std::string version = "2.0.0"; 
    std::string license = "MIT";
    std::string author;
    std::string author_email;
    std::string author_url;
    std::string plugin_url;
    std::string manual_url;
    std::string source_url;
    std::vector<ModuleDescriptor> modules;
};
 
}  // namespace pulp::format::rack