descriptor_validation.hpp

Go to the documentation of this file.

#pragma once
 
// PluginDescriptor validation.
//
// Runs at plugin registration / test time — NEVER on the audio thread.
// Catches the common descriptor mistakes that otherwise surface as
// mysterious host-side "plugin did not appear" / "factory returned
// null" failures:
//   - empty name / manufacturer / bundle_id / version
//   - bundle_id that doesn't look like reverse-DNS
//   - no output bus declared, or invalid main bus channel counts
//   - instrument category with 0-channel output
//   - accepts_midi / supports_mpe / supports_ump on effect category
//     without any MIDI capability setup (legal but usually a mistake)
//
// Errors are returned as a vector — callers (test harnesses, registry
// loaders, `pulp validate`) format them. Pure function, no allocation
// beyond the result vector.
 
#include <pulp/format/processor.hpp>
 
#include <string>
#include <vector>
 
namespace pulp::format {
 
enum class DescriptorIssueSeverity {
    Error,     
    Warning,   
};
 
struct DescriptorIssue {
    DescriptorIssueSeverity severity;
    std::string field;       
    std::string message;
};

std::vector<DescriptorIssue> validate_descriptor(const PluginDescriptor& d);

bool descriptor_is_valid(const std::vector<DescriptorIssue>& issues);
 
}  // namespace pulp::format