concepts.hpp

Go to the documentation of this file.

// Generated by core/interchange/tools/capability_emit.py -- do not edit.
// Source of truth: core/interchange/capabilities/*.json
#pragma once
 
#include <cstddef>
#include <cstdint>
#include <string_view>
 
namespace pulp::interchange {

enum class Concept : std::uint16_t {
    Unknown = 0,
    TrackFlat = 1,
    TrackGroup = 2,
    TrackVideo = 3,
    ClipMusical = 4,
    ClipAbsolute = 5,
    ClipNote = 6,
    ClipMedia = 7,
    ClipGain = 8,
    ClipFades = 9,
    ClipCrossfade = 10,
    ClipWarp = 11,
    ClipLaunch = 12,
    GapExplicit = 13,
    TempoSingle = 14,
    TempoMap = 15,
    MeterSingle = 16,
    MeterMap = 17,
    Marker = 18,
    TimecodeOrigin = 19,
    MediaProvenance = 20,
    MixerTrackGain = 21,
    MixerTrackPan = 22,
    MixerSends = 23,
    AutomationDeviceParam = 24,
    AutomationTrackGain = 25,
    AutomationTrackPan = 26,
    DevicePlacement = 27,
    DevicePayload = 28,
    EffectTimewarp = 29,
    TakeLane = 30,
    TakeComp = 31,
    TrackFreeze = 32,
    AssetSealedHash = 33,
    AssetEmbeddedMedia = 34,
    AssetReferencedMedia = 35,
    SequenceMultiple = 36,
    SequenceNested = 37,
    ContentRegistered = 38,
    ContentOpaque = 39,
    EditRateNonAudio = 40,
    ContextChordScale = 41,
    ContextGroove = 42,
    ClipNoteModifier = 43,
    ClipEmpty = 44,
    TempoRamp = 45,
    ClipNoteVelocityQuantized = 46,
    TempoValueQuantized = 47,
    ClipMediaWindow = 48,
    ClipFadeShape = 49,
    ClipMidiExpressionLane = 50,
    SequenceSectionRole = 51,
    ContextChordBass = 52,
    ContextChordExtension = 53,
    ContextChordVoicing = 54,
    TuningProject = 55,
    TuningInstrument = 56,
    ModulationModulator = 57,
    ModulationMacro = 58,
    ModulationRouteDeviceParam = 59,
    ModulationRouteTrackMixer = 60,
};
 
inline constexpr std::size_t kConceptCount = 61;
 
namespace detail {
struct ConceptRecord {
    std::string_view id;
    std::string_view summary;
    bool detectable_in_model;
};
 
inline constexpr ConceptRecord kConceptRecords[kConceptCount] = {
    {"unknown", "A construct the reader could not classify. No format lists it, so it always refuses.", false},
    {"track.flat", "A track holding clips directly, with no children.", true},
    {"track.group", "A track that contains other tracks (folder/group/nested scope).", false},
    {"track.video", "A track whose content is picture rather than audio or notes.", false},
    {"clip.musical", "A clip anchored to musical time (canonical ticks).", true},
    {"clip.absolute", "A clip anchored to absolute time (samples at a rational rate).", true},
    {"clip.note", "Clip content that is a set of note events.", true},
    {"clip.media", "Clip content that references a media asset.", true},
    {"clip.gain", "Per-clip gain applied to the clip's content.", true},
    {"clip.fades", "Per-clip fade in and fade out durations.", true},
    {"clip.crossfade", "An overlap between two adjacent clips authored as one transition item.", false},
    {"clip.warp", "A time-warp map deforming clip content against timeline time.", false},
    {"clip.launch", "Non-arrangement clip playback (scenes, launcher grids).", true},
    {"gap.explicit", "A gap between clips authored as a first-class item rather than absence.", false},
    {"tempo.single", "One tempo governing the whole document.", true},
    {"tempo.map", "Tempo changing over the document at more than one point.", true},
    {"meter.single", "One time signature governing the whole document.", true},
    {"meter.map", "Time signature changing over the document at more than one point.", true},
    {"marker", "A named point or range on the timeline.", true},
    {"timecode.origin", "The wall-clock timecode the document's zero position represents.", true},
    {"media.provenance", "Where a media asset came from: source timecode, reel or tape name, original locator.", false},
    {"mixer.track-gain", "Static per-track gain.", true},
    {"mixer.track-pan", "Static per-track pan position.", true},
    {"mixer.sends", "Track routing to busses and auxiliary sends.", false},
    {"automation.device-param", "An automation lane targeting a device parameter.", true},
    {"automation.track-gain", "An automation lane targeting a track's gain.", true},
    {"automation.track-pan", "An automation lane targeting a track's pan.", true},
    {"device.placement", "A device occupying a slot in a track's chain, by identity.", true},
    {"device.payload", "A device's type and saved parameter state.", true},
    {"effect.timewarp", "An effect that remaps time rather than processing content.", false},
    {"take.lane", "An alternate recording lane holding takes alongside the arrangement.", true},
    {"take.comp", "A composite assembled by selecting segments across takes.", true},
    {"track.freeze", "A sealed offline render standing in for a track's live output.", true},
    {"asset.sealed-hash", "Media identity derived from a content hash of the actual bytes.", true},
    {"asset.embedded-media", "Media bytes carried inside the document package.", true},
    {"asset.referenced-media", "Media referenced by locator, stored outside the document.", true},
    {"sequence.multiple", "More than one sequence in the document.", true},
    {"sequence.nested", "A clip whose content is another sequence.", true},
    {"content.registered", "Typed extension clip content serialized through the schema registry.", true},
    {"content.opaque", "Uninterpreted clip content carried in a validated envelope.", true},
    {"edit-rate.non-audio", "Positions at a rate that does not convert exactly to the document's rate.", false},
    {"context.chord-scale", "A sequence-owned lane of chord and scale statements that other items read while compiling.", true},
    {"context.groove", "A sequence-owned groove: a swing setting and a repeating table of per-step timing and accent that other items read while compiling.", true},
    {"clip.note-modifier", "Per-note playback modifiers: probability, pass condition, and ratchet.", true},
    {"clip.empty", "A positioned clip with no note, media, registered, opaque, or nested-sequence content.", true},
    {"tempo.ramp", "A continuous tempo curve between two tempo-map points.", true},
    {"clip.note-velocity-quantized", "A note velocity that cannot be encoded as a sounding nonzero 7-bit Standard MIDI Note On without changing value.", true},
    {"tempo.value-quantized", "A tempo value that cannot round-trip exactly through an integer-microseconds-per-quarter representation.", true},
    {"clip.media-window", "A media clip that plays a source subrange rather than the referenced asset's complete frame range.", true},
    {"clip.fade-shape", "A fade whose gain curve is not the linear ramp, so a format carrying only fade durations changes what the transition sounds like.", true},
    {"clip.midi-expression-lane", "A continuous controller stream authored alongside a clip's notes -- control change, pitch bend, channel or poly pressure, program change, or a registered or assignable parameter -- carrying its own points independently of any note.", true},
    {"sequence.section-role", "A region that names the structural part it spans, beyond its free-text name.", true},
    {"context.chord-bass", "A chord statement naming the pitch class in the bass, rather than sounding root position.", true},
    {"context.chord-extension", "A chord statement carrying added scale degrees beyond its quality.", true},
    {"context.chord-voicing", "A chord statement carrying a hint for how a generator should spread its tones.", true},
    {"tuning.project", "A document-wide statement of the tuning every instrument plays in.", true},
    {"tuning.instrument", "One instrument overriding the document-wide tuning with its own.", true},
    {"modulation.modulator", "A track-owned generator of modulation signal, by identity and declared kind.", true},
    {"modulation.macro", "A track-owned named performer control that drives parameters through modulation routes.", true},
    {"modulation.route-device-param", "A modulation route contributing a depth-scaled offset to a device parameter, on top of whatever base value is in force.", true},
    {"modulation.route-track-mixer", "A modulation route contributing a depth-scaled offset to a track's own gain or pan.", true},
};
} // namespace detail

constexpr std::string_view concept_id(Concept concept_value) noexcept {
    return detail::kConceptRecords[static_cast<std::size_t>(concept_value)].id;
}

constexpr std::string_view concept_summary(Concept concept_value) noexcept {
    return detail::kConceptRecords[static_cast<std::size_t>(concept_value)].summary;
}

constexpr bool concept_detectable_in_model(Concept concept_value) noexcept {
    return detail::kConceptRecords[static_cast<std::size_t>(concept_value)]
        .detectable_in_model;
}

constexpr Concept concept_from_id(std::string_view id) noexcept {
    for (std::size_t index = 0; index < kConceptCount; ++index) {
        if (detail::kConceptRecords[index].id == id)
            return static_cast<Concept>(index);
    }
    return Concept::Unknown;
}
 
} // namespace pulp::interchange