types.hpp

Go to the documentation of this file.

#pragma once
 
// ARA 2.x core type layer.
//
// SDK-independent mirrors of the ARA concepts a Pulp plugin needs to author
// against. The companion factory layer translates between these types and the
// Celemony ARA SDK's C interface for VST3, AU, and CLAP. Plugin authors only
// ever see the Pulp types; the SDK header is never re-exported from a Pulp
// public header so that PULP_HAS_ARA gating stays invisible to consumers.
//
// All identifiers are opaque integer handles (ARAObjectRef-like): they are
// minted by the host and Pulp passes them back through callbacks. Pulp
// never inspects them.
 
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
 
namespace pulp::format::ara {
 
// ── Opaque host-minted identifiers ───────────────────────────────────────
 
using AudioSourceId       = uint64_t;
using AudioModificationId = uint64_t;
using MusicalContextId    = uint64_t;
using RegionSequenceId    = uint64_t;
using PlaybackRegionId    = uint64_t;
 
// ── Audio source ─────────────────────────────────────────────────────────

struct AraAudioSource {
    AudioSourceId id = 0;
    std::string name;            
    std::string persistent_id;   
    int64_t sample_count = 0;    
    double sample_rate = 0.0;    
    int channel_count = 0;
    bool merits_content_based_processing = false;
};
 
// ── Audio modification ───────────────────────────────────────────────────

struct AraAudioModification {
    AudioModificationId id = 0;
    AudioSourceId source_id = 0;
    std::string name;
    std::string persistent_id;
};
 
// ── Musical context ──────────────────────────────────────────────────────

struct AraTempoEntry {
    double position_seconds = 0.0;
    double position_quarters = 0.0;
};
 
struct AraMusicalContext {
    MusicalContextId id = 0;
    std::string name;
    std::vector<AraTempoEntry> tempo_map;   
    int time_signature_numerator = 4;
    int time_signature_denominator = 4;
};
 
// ── Region sequence + playback region ────────────────────────────────────

struct AraRegionSequence {
    RegionSequenceId id = 0;
    MusicalContextId musical_context_id = 0;
    std::string name;
    int colour_argb = 0;          
};

struct AraPlaybackRegion {
    PlaybackRegionId id = 0;
    AudioModificationId modification_id = 0;
    RegionSequenceId region_sequence_id = 0;
    double start_in_playback_time = 0.0;        // seconds
    double duration_in_playback_time = 0.0;     // seconds
    double start_in_modification_time = 0.0;    // seconds
    double duration_in_modification_time = 0.0; // seconds
    std::string name;
    int colour_argb = 0;
};
 
// ── Content-changed flags ────────────────────────────────────────────────

enum class AudioSourceContentChange : uint32_t {
    None       = 0,
    Notes      = 1u << 0,
    Tempo      = 1u << 1,
    Tuning     = 1u << 2,
    KeySignatures = 1u << 3,
    Samples    = 1u << 4,   
};
 
inline AudioSourceContentChange operator|(AudioSourceContentChange a,
                                          AudioSourceContentChange b) {
    return static_cast<AudioSourceContentChange>(
        static_cast<uint32_t>(a) | static_cast<uint32_t>(b));
}
inline bool any(AudioSourceContentChange flags) {
    return static_cast<uint32_t>(flags) != 0;
}
inline bool has(AudioSourceContentChange flags, AudioSourceContentChange bit) {
    return (static_cast<uint32_t>(flags) & static_cast<uint32_t>(bit)) != 0;
}
 
} // namespace pulp::format::ara