Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::timeline Namespace Reference

Namespaces

namespace  detail
namespace  follow_detail

Classes

class  ContentHash
 Durable SHA-256 identity for sealed media bytes. More...
struct  AssetLocator
 Non-authoritative location hint for resolving content by hash. More...
struct  AssetRepresentation
 Alternate fidelity, analysis, or cache form of the same logical asset. More...
struct  AudioLoopPoint
 Frame position at which sealed audio may loop. More...
struct  AudioFrameRange
 Half-open frame interval [start_frame, end_frame). More...
struct  AudioLoopInfo
 Typed musical metadata attached to sealed audio content. More...
struct  AutomationPoint
 One identity-bearing automation value at a canonical musical tick. More...
struct  AutomationPointPositionLess
 Canonical ordering for authored automation points and curve storage. More...
struct  AutomationCurveError
 Automation curve failure with the offending and, when relevant, conflicting identities. More...
class  AutomationCurve
 Immutable, position-ordered automation points. More...
struct  AutomationTargetCases
 Overload set for visiting an AutomationTarget with no generic fallback. More...
struct  AutomationLaneError
 Automation lane failure with the lane and related target identity. More...
class  AutomationLane
 Immutable ownership of one authored automation curve and its logical target. More...
struct  ModelError
 Model failure with the offending and, when relevant, conflicting identity. More...
struct  SchemaIdentity
 Versioned extension-schema identity. More...
class  ItemIdAllocator
 Monotonic allocator for non-zero document ItemIds. More...
struct  EmptyContent
 Clip content that intentionally carries no media, notes, or extension value. More...
struct  MediaAsset
 Project-owned sealed media metadata. More...
struct  MediaRef
 Borrowed range of frames from a project-owned MediaAsset. More...
struct  SequenceRef
 Reference to a sibling sequence in the same Project pool. More...
struct  MusicalTimeRange
 Musical clip placement in canonical ticks. More...
struct  AbsoluteTimeRange
 Absolute clip placement in samples at an explicit rational rate. More...
struct  AbsoluteTimelineDuration
 Sequence duration in absolute samples at an explicit rational rate. More...
struct  ClipPlaybackProperties
 Clip-level audio controls. More...
struct  NoteEvent
 One identity-bearing MIDI-style note in canonical musical ticks. More...
class  MidiContent
 Immutable MIDI clip content: start-then-identity-ordered notes with sparse deterministic modifiers, beside the controller and expression streams those notes sound against. More...
class  RegisteredContent
 Extension-defined typed C++ content admitted by a SchemaRegistry. More...
struct  OpaqueContentLimits
 Parser bounds retained with an opaque extension envelope. More...
class  OpaqueContent
 Exact validated JSON for an unavailable extension schema. More...
struct  ClipContentCases
 Overload set for visiting a ClipContent with no generic fallback. More...
class  Clip
 Immutable identity-bearing placement of one ClipContent value. More...
struct  LaunchQuantize
 Musical-boundary quantization for one launch. More...
struct  FollowAction
 One weighted follow-action candidate. More...
struct  FollowActionSet
 Bounded weighted follow behavior attached to a slot. More...
struct  Slot
 One authored launch slot. More...
class  SlotList
 Immutable authored slot order with persistent structural sharing. More...
struct  Scene
 Authored grouping of slots presented as one launchable column. More...
struct  FollowDraw
 Stable identity of one reproducible follow-action decision. More...
struct  FollowResolution
 Deterministic outcome and optional target slot of follow resolution. More...
struct  WriterId
 Stable non-zero identity of a document writer. More...
struct  CommandId
 Writer-scoped, monotonically assigned command identity. More...
struct  TransactionId
 Writer-scoped, monotonically assigned transaction identity. More...
struct  DocumentRevision
 Monotonic document snapshot revision used for optimistic admission. More...
struct  UndoGroupId
 Writer-scoped identity joining gesture transactions into one undo unit. More...
struct  InsertClip
 Inserts an identity-bearing clip into a track. More...
struct  RemoveClip
 Removes a clip by its owning coordinates and identity. More...
struct  InsertAutomationLane
 Inserts an automation lane into a track. More...
struct  RemoveAutomationLane
 Removes an automation lane by identity. More...
struct  MoveClip
 Replaces a clip's time range under an exact optimistic-value gate. More...
struct  SetNoteVelocity
 Replaces one note velocity under an exact optimistic-value gate. More...
struct  ReplaceNoteContent
 Replaces the complete note event set of one note clip. More...
struct  SetNoteEvents
 Replaces the values of a named subset of one note clip's notes. More...
struct  InsertNotes
 Inserts a set of identity-bearing notes into one MIDI clip. More...
struct  RemoveNotes
 Removes a named set of notes under an exact optimistic-value gate. More...
struct  SetClipPlaybackProperties
 Replaces clip-level gain and fade controls under an exact value gate. More...
struct  SetTempoMap
 Replaces the complete project tempo map under an exact value gate. More...
struct  SetMeterMap
 Replaces the complete project meter map under an exact value gate. More...
struct  CreateAsset
 Adds one sealed recorded or imported media asset. More...
struct  RemoveAsset
 Removes a project-owned media asset by identity. More...
struct  InsertTakeLane
 Inserts one take lane and its owned take-identity subtree. More...
struct  RemoveTakeLane
 Removes a take lane and its owned take identities. More...
struct  InsertTake
 Inserts one take into an existing take lane. More...
struct  RemoveTake
 Removes one take from an existing take lane. More...
struct  SetRecordArm
 Replaces record-arm document intent under an exact optimistic-value gate. More...
struct  SetActiveTakeLane
 Selects the arrangement or an existing take lane under an exact value gate. More...
struct  SetTakeComp
 Replaces a take lane's canonical comp segments under an exact value gate. More...
struct  SetTrackFreeze
 Publishes or clears a pre-rendered track artifact under an exact value gate. More...
struct  SetChordScaleLane
 Replaces a sequence's complete chord/scale lane under an exact value gate. More...
struct  SetDynamicsLane
 Replaces a sequence's complete dynamics lane under an exact value gate. More...
struct  InsertMarker
 Inserts a sequence-owned marker identity. More...
struct  RemoveMarker
 Removes a sequence-owned marker by identity. More...
struct  InsertRegion
 Inserts a sequence-owned region identity. More...
struct  RemoveRegion
 Removes a sequence-owned region by identity. More...
struct  SetGroove
 Replaces a sequence's complete groove under an exact value gate. More...
struct  InsertScene
 Inserts a scene at an authored position in a sequence. More...
struct  RemoveScene
 Removes a scene and its owned slots by identity. More...
struct  InsertSlot
 Inserts a slot at an authored position in a scene. More...
struct  RemoveSlot
 Removes a slot from a scene by identity. More...
struct  InsertSequence
 Inserts a complete sequence and its owned identity subtree. More...
struct  CloneSequence
 Clones a sequence using an explicit, complete owned-identity mapping. More...
struct  RemoveSequence
 Removes a sequence and its owned identity subtree. More...
struct  SetClipSequenceRef
 Retargets a sequence-reference clip under an exact optimistic-value gate. More...
struct  SetTrackMixer
 Replaces track gain and pan under an exact optimistic-value gate. More...
struct  InsertTrack
 Inserts a track and its complete owned identity subtree at an authored position. More...
struct  RemoveTrack
 Removes a track and its complete owned identity subtree by identity. More...
struct  SetTrackName
 Replaces a track's authored name under an exact optimistic-value gate. More...
struct  MoveTrack
 Moves a track in authored order under an exact optimistic-position gate. More...
struct  InsertDevice
 Inserts a typed device declaration into a track's authored chain. More...
struct  RemoveDevice
 Removes a device declaration by identity. More...
struct  MoveDevice
 Moves a device under an exact optimistic authored-position gate. More...
struct  RetargetDevice
 Replaces device kind, binding, slot, stage, bypass, and wet/dry atomically. More...
struct  SetDeviceState
 Replaces the optional content-addressed opaque state reference. More...
struct  InsertMidiExpressionLane
 Inserts a controller/expression lane into a MIDI clip. More...
struct  RemoveMidiExpressionLane
 Removes a controller/expression lane from a MIDI clip by identity. More...
struct  SetMidiExpressionLanePoints
 Replaces one lane's authored points under an exact optimistic-value gate. More...
struct  SetProjectTuning
 Replaces the project-wide tuning statement under an exact value gate. More...
struct  SetTrackTuning
 Replaces one track's tuning override under an exact value gate. More...
struct  SetRegion
 Replaces one sequence-owned region under an exact value gate. More...
struct  InsertModulator
 Inserts a track-owned modulation source. More...
struct  RemoveModulator
 Removes a track-owned modulation source by identity. More...
struct  SetModulator
 Replaces a modulation source's declaration under an exact value gate. More...
struct  InsertMacro
 Inserts a track-owned macro control. More...
struct  RemoveMacro
 Removes a track-owned macro control by identity. More...
struct  SetMacro
 Replaces a macro control's declaration under an exact value gate. More...
struct  SetMacroValue
 Replaces only a macro's authored position under an exact value gate. More...
struct  InsertModulationRoute
 Inserts one authored source-to-parameter connection. More...
struct  RemoveModulationRoute
 Removes one authored connection by identity. More...
struct  SetModulationRoute
 Replaces a route's source, target, depth, and bypass under an exact gate. More...
struct  CommandEnvelope
 One command paired with its writer-scoped idempotency identity. More...
struct  Transaction
 Atomically admitted ordered command batch. More...
class  CompileContextSubscriptions
 The declared set of context kinds one content renderer reads. More...
class  CompileContextView
 The read side of the contract: a read-only window onto one pinned snapshot's context, narrowed to what its owner declared. More...
struct  DawProjectImportError
 Diagnostic returned when an import rejects the whole document. More...
struct  DawProjectImportLimits
 Hard resource ceilings for one import. More...
struct  DeviceConfiguration
 Authored device configuration excluding placement identity and opaque state. More...
struct  DevicePlacement
 Durable declaration for one logical placement in a Track device chain. More...
struct  SessionLimits
 Resource ceilings for one mutable document session. More...
struct  CommandAuthority
 The authority one command requires, as a class and intent pair. More...
struct  WriterCapabilityMask
 Fixed authority of one writer over command classes and retained size. More...
class  WriterToken
 Move-only authority for submitting transactions to one DocumentSession. More...
struct  DocumentView
 Atomically observed immutable project snapshot and its matching revision. More...
class  DocumentSession
 Thread-safe owner of a revisioned Timeline document. More...
struct  FileJournalError
 File-journal failure with the offending byte and nested JSON error. More...
struct  FileJournalLimits
 File size, record size, and nested decode ceilings. More...
struct  FileJournalOpenResult
 Result of opening or recovering a native Timeline journal. More...
class  FileJournal
 Native, crash-consistent Timeline persistence sink. More...
struct  ItemId
 Nonzero monotonic identity for a Timeline-owned object. More...
struct  JournalLimits
 In-memory command-journal quotas. More...
struct  JournalEntry
 One contiguous revision transition retained by the command journal. More...
class  JournalSink
 Synchronous durability boundary used by DocumentSession. More...
class  CommandJournal
 Bounded, replayable in-memory log of contiguous document revisions. More...
struct  MidiLaneAddress
 Address of one continuous controller stream within a MidiContent. More...
struct  MidiLanePoint
 One authored value on a controller lane, positioned in canonical ticks. More...
struct  MidiExpressionLane
 One controller stream's authored points, ordered by (position, id). More...
struct  TrackIndexStats
 Diagnostic counters for persistent track clip-index allocation. More...
struct  LauncherIndexStats
 Diagnostic counters for persistent launcher-index allocation. More...
struct  TrackInput
 Complete input for constructing a Track and its owned collections. More...
class  Track
 Immutable identity-bearing arrangement track. More...
struct  ChordScaleEvent
 Harmonic statement in force from position until the next event. More...
class  ChordScaleLane
 Immutable chord/scale context lane owned by a sequence. More...
struct  DynamicsEvent
 Intensity statement in force from position until the next event. More...
class  DynamicsLane
 Immutable intensity context lane owned by a sequence. More...
struct  SequenceMarker
 Named point on a sequence's musical timeline. More...
struct  SequenceRegion
 Named positive-duration span on a sequence's musical timeline. More...
struct  GrooveStep
 One timing offset and per-mille accent in a repeating groove table. More...
struct  GrooveTemplateInput
 Complete validated construction input for a GrooveTemplate. More...
class  GrooveTemplate
 Immutable sequence-owned swing, timing-offset, and accent context. More...
struct  SequenceInput
 Complete construction input for a Sequence and its owned collections. More...
class  Sequence
 Immutable identity-bearing arrangement with tracks, annotations, context, and launch scenes. More...
struct  SessionStart
 Absolute source/house-clock position corresponding to project time zero. More...
struct  ProjectInput
 Complete input for constructing a Project and its identity domain. More...
struct  ItemLocation
 Canonical ownership and ancestor coordinates for one project identity. More...
struct  IdentityMutation
 Planned identity-index transition accompanying an immutable model edit. More...
struct  ProjectIdentityStats
 Diagnostic counters for persistent project identity-index allocation. More...
class  SequenceCompileStructureToken
 Opaque, process-local identity for the part of a Project snapshot that determines nested-sequence and registered-content compile subscribers. More...
class  Project
 Immutable root of a Timeline document and its monotonic identity domain. More...
class  IdRemapTable
 Canonically ordered mapping from source identities to remapped identities. More...
struct  ExternalIdFixup
 Optional non-throwing translation for an externally referenced identity. More...
struct  RemapIdFixups
 Independent external-reference fixups for media assets and sequences. More...
struct  RemappedClip
 Remapped clip snapshot and its complete owned-identity table. More...
struct  RemappedTrack
 Remapped track snapshot and its complete owned-identity table. More...
struct  RemappedSequence
 Remapped sequence snapshot and its complete owned-identity table. More...
struct  RemappedProject
 Remapped project snapshot and complete source-to-destination identity table. More...
struct  ModulationTargetCases
 Overload set for visiting a ModulationTarget with no generic fallback. More...
struct  Modulator
 A track-owned generator of modulation signal. More...
struct  MacroControl
 A track-owned named control that a performer sets and that drives parameters through ordinary modulation routes. More...
struct  ModulationSourceRef
 Reference to the track-owned source a route reads. More...
struct  ModulationRoute
 One authored source-to-parameter connection. More...
struct  NoteModifier
 Sparse playback modifier attached to one note identity. More...
struct  NoteModifierDraw
 One deterministic probability draw for a note key and loop pass. More...
struct  NoteTransformCallbackFailure
 Failure returned directly by a registered note-transform callback. More...
struct  NoteTransformRegistration
 Immutable registration for one versioned transform implementation. More...
struct  NoteTransformError
 Transform failure with nested callback, persistence, model, or transaction detail. More...
struct  ApplyNoteTransform
 A typed, apply-time request. More...
struct  NoteTransformPreview
 Prepared durable transaction and resulting immutable document snapshot. More...
class  NoteTransformRegistry
 Control-thread registry for pure note transforms. More...
struct  DeviceParameterTarget
 Format-neutral document target for a placed device parameter. More...
struct  TrackMixerTarget
 Format-neutral document target for one of the owning track's own mixer controls. More...
struct  ProductionDeclaration
 What a piece of content declares about its own production. More...
class  Take
 Immutable sample-anchored recording take referencing a project media asset. More...
struct  TakeCompSegment
 Exact absolute-time selection from one take for a comp. More...
struct  TrackFreeze
 Sealed offline-rendered track artifact and its source-plan identity. More...
class  TakeLane
 Immutable alternate recording lane owned by a Track. More...
struct  TrackMixer
 Track-owned linear gain and stereo balance. More...
struct  PersistenceError
 Structured persistence failure. More...
struct  DecodeLimits
 Parser, migration, opaque-payload, and Timeline structure quotas. More...
struct  JsonValue
 Owning JSON DOM node with source byte bounds. More...
struct  JsonObjectMember
 Pair-like owning member of a JSON object. More...
class  ParsedJson
 Parsed JSON tree that owns the source bytes referenced by node offsets. More...
struct  StructuralPreflightSuccess
 Empty success value returned by structural preflight. More...
struct  SchemaWriteSuccess
 Empty success value returned by bounded schema writers. More...
class  BoundedJsonSink
 Append-only JSON output sink with an enforced byte ceiling. More...
struct  FieldSchema
 Public field metadata for one registered schema type. More...
struct  SchemaCodec
 Immutable callback bundle and shared context for a registered type. More...
struct  MigrationStep
 One adjacent version transition for a schema type. More...
struct  TypeSchema
 Complete registration contract for one domain-qualified schema type. More...
struct  SchemaError
 Schema-registration failure with the affected type and version. More...
struct  SchemaRegistration
 Empty success value returned after registering a schema. More...
class  SchemaRegistry
 Immutable, shareable registry of Timeline schema contracts. More...
class  SchemaRegistryBuilder
 Mutable, single-owner accumulator for constructing a SchemaRegistry. More...
struct  SchemaVersionTarget
 Target version for one schema identity in a release projection. More...
struct  SchemaReleaseMap
 Immutable set of schema-version targets identified by a release label. More...
struct  SerializeOptions
 Output quota for project serialization. More...
struct  SerializedSnapshot
 Canonical serialized project plus extension-preservation status. More...
struct  ProjectSnapshotCounts
 Structural item counts extracted from a serialized project. More...
struct  ProjectSnapshotSummary
 Allocation-light metadata view for project browsers and admission checks. More...
struct  SmfError
 Diagnostic returned when an SMF operation rejects the whole conversion. More...
struct  SmfImportLimits
 Hard resource ceilings for one SMF import. More...
struct  SmfImportOptions
 Caller-selected resource and unsupported-event policy for SMF import. More...
struct  SmfImport
 Imported immutable Project plus tick-conversion fidelity metadata. More...
struct  SmfExportOptions
 Tick-grid, loss policy, and work bound for SMF export. More...
struct  SmfExport
 Encoded SMF bytes plus tick-conversion fidelity metadata. More...
struct  DirtyItem
 Canonical invalidation record for one item and its owning location. More...
struct  DirtyContext
 One sequence-owned context kind a transaction changed. More...
class  DirtySet
 Owned canonical collection of incremental invalidations. More...
struct  TransactionError
 Structured transaction rejection. More...
struct  ReducedTransaction
 Pure reduction result before revision publication. More...
struct  CommitResult
 Immutable state published by a successful session commit. More...
struct  TuningReference
 Durable statement of the tuning a project or one instrument plays in. More...
struct  UndoLimits
 Bounds the number and retained memory of undo groups in a session. More...

Typedefs

using AutomationTarget = ParameterTarget
 Exhaustive authored-target set.
using ClipTimeRange = std::variant<MusicalTimeRange, AbsoluteTimeRange>
 Exhaustive authored clip-placement domains.
using ClipContent
 Exhaustive set of immutable payloads a Clip can own or reference.
using Command
 Exhaustive set of durable Timeline document mutations.
using DawProjectMediaResolver
 Resolves a safe package-relative path to complete media bytes.
using ModulationTarget = ParameterTarget
 Exhaustive authored target set for a modulation route.
using NoteTransformFunction
 Pure, non-throwing note-transform callback.
using ParameterTarget = std::variant<DeviceParameterTarget, TrackMixerTarget>
 Exhaustive set of document parameters an authored control can address.
using SchemaDecodeFn
 Decodes schema data into an immutable type-erased value.
using SchemaEncodeFn
 Encodes a type-erased value into a quota-enforcing JSON sink.
using SchemaRetainedSizeFn
 Estimates bytes retained by a decoded type-erased value.
using SchemaMigrationFn
 Rewrites one exact schema envelope into a quota-enforcing sink.

Enumerations

enum class  AssetStoragePolicy : std::uint8_t { AssetStoragePolicy::External , AssetStoragePolicy::Embedded , AssetStoragePolicy::PreferEmbedded }
 Preferred storage relationship between a project and an asset's bytes. More...
enum class  AssetLocatorKind : std::uint8_t { AssetLocatorKind::PackageRelative , AssetLocatorKind::ExternalUri }
 Namespace in which an asset locator hint is interpreted. More...
enum class  AudioLoopPointKind : std::uint8_t { AudioLoopPointKind::Manual , AudioLoopPointKind::Automatic }
 Provenance of a suggested audio loop point. More...
enum class  AutomationInterpolation : std::uint8_t { AutomationInterpolation::Hold , AutomationInterpolation::Continuous }
 Interpolation applied from an automation point to its successor. More...
enum class  AutomationCurveErrorCode : std::uint8_t {
  AutomationCurveErrorCode::InvalidPointId , AutomationCurveErrorCode::DuplicatePointId , AutomationCurveErrorCode::DuplicatePosition , AutomationCurveErrorCode::InvalidInterpolation ,
  AutomationCurveErrorCode::NonFiniteValue , AutomationCurveErrorCode::InvalidCurvature , AutomationCurveErrorCode::MissingPoint
}
 Validation failures returned by AutomationCurve factories and edits. More...
enum class  AutomationLaneErrorCode : std::uint8_t { AutomationLaneErrorCode::InvalidLaneId , AutomationLaneErrorCode::InvalidDevicePlacementId , AutomationLaneErrorCode::InvalidDeviceId = InvalidDevicePlacementId }
 Validation failures returned when constructing an AutomationLane. More...
enum class  ModelErrorCode : std::uint8_t {
  ModelErrorCode::InvalidItemId , ModelErrorCode::DuplicateItemId , ModelErrorCode::ItemIdExhausted , ModelErrorCode::InvalidDuration ,
  ModelErrorCode::InvalidMediaRange , ModelErrorCode::InvalidSampleRate , ModelErrorCode::InvalidNote , ModelErrorCode::OverlappingClips ,
  ModelErrorCode::MissingAsset , ModelErrorCode::MissingRootSequence , ModelErrorCode::NextItemIdNotMonotonic , ModelErrorCode::MixedTimeAnchors ,
  ModelErrorCode::IncompatibleSampleRate , ModelErrorCode::MissingItem , ModelErrorCode::IdentityConflict , ModelErrorCode::InvalidIdentityTransition ,
  ModelErrorCode::InvalidSchemaIdentity , ModelErrorCode::InvalidContentHash , ModelErrorCode::InvalidAssetLocator , ModelErrorCode::DuplicateAssetRepresentation ,
  ModelErrorCode::InvalidOpaqueContent , ModelErrorCode::OpaqueContentLimitExceeded , ModelErrorCode::OpaqueContentCannotRemap , ModelErrorCode::InvalidClipPlaybackProperties ,
  ModelErrorCode::MissingAutomationTarget , ModelErrorCode::DuplicateAutomationTarget , ModelErrorCode::InvalidTake , ModelErrorCode::DuplicateTake ,
  ModelErrorCode::ActiveTakeLaneRemoval , ModelErrorCode::InvalidTakeComp , ModelErrorCode::OverlappingTakeComp , ModelErrorCode::ActiveCompTakeRemoval ,
  ModelErrorCode::InvalidAudioLoopInfo , ModelErrorCode::InvalidAssetStoragePolicy , ModelErrorCode::InvalidMarker , ModelErrorCode::InvalidRegion ,
  ModelErrorCode::InvalidSessionStart , ModelErrorCode::InvalidChordScaleEvent , ModelErrorCode::UnorderedChordScaleLane , ModelErrorCode::InvalidDynamicsEvent ,
  ModelErrorCode::UnorderedDynamicsLane , ModelErrorCode::InvalidGrooveTemplate , ModelErrorCode::InvalidNoteModifier , ModelErrorCode::InvalidMidiLane ,
  ModelErrorCode::DuplicateMidiLaneAddress , ModelErrorCode::MissingSequenceReference , ModelErrorCode::SequenceReferenceCycle , ModelErrorCode::SequenceNestingTooDeep ,
  ModelErrorCode::InvalidTrackMixer , ModelErrorCode::InvalidTimeConform , ModelErrorCode::InvalidTuningReference , ModelErrorCode::InvalidModulator ,
  ModelErrorCode::InvalidMacroControl , ModelErrorCode::InvalidModulationRoute , ModelErrorCode::MissingModulationSource , ModelErrorCode::MissingModulationTarget
}
 Validation and identity failures returned by immutable Timeline model edits. More...
enum class  ClipTimeAnchor : std::uint8_t { ClipTimeAnchor::Musical , ClipTimeAnchor::Absolute }
 Time domain in which a clip's placement remains anchored. More...
enum class  TimeConform : std::uint8_t { TimeConform::None , TimeConform::Resample , TimeConform::Stretch }
 Authored policy for adapting a musical media clip when its duration and source duration differ. More...
enum class  ClipFadeShape : std::uint8_t { ClipFadeShape::Linear , ClipFadeShape::EqualPower }
 Gain curve traversed across a clip's fade region, in both directions. More...
enum class  FollowActionKind : std::uint8_t {
  FollowActionKind::None , FollowActionKind::Stop , FollowActionKind::Again , FollowActionKind::Previous ,
  FollowActionKind::Next , FollowActionKind::First , FollowActionKind::Last , FollowActionKind::Any ,
  FollowActionKind::Other , FollowActionKind::Jump
}
 Action applied when a slot's follow timer elapses. More...
enum class  FollowOutcome : std::uint8_t { FollowOutcome::None , FollowOutcome::Stop , FollowOutcome::Play }
 Runtime request produced by resolving an authored follow action. More...
enum class  GesturePhase : std::uint8_t {
  GesturePhase::Single , GesturePhase::Begin , GesturePhase::Update , GesturePhase::End ,
  GesturePhase::Cancel
}
 Lifecycle position of a transaction within an interactive gesture. More...
enum class  CompileContextKind : std::uint8_t {
  CompileContextKind::ChordScale , CompileContextKind::Groove , CompileContextKind::Dynamics , CompileContextKind::CrossTrackRhythm ,
  CompileContextKind::EnsembleSkeleton
}
 A kind of timeline context a renderer's compile hook may read beyond its own clip's content. More...
enum class  DawProjectImportErrorCode : std::uint8_t {
  DawProjectImportErrorCode::ParseError , DawProjectImportErrorCode::MissingRoot , DawProjectImportErrorCode::UnsupportedVersion , DawProjectImportErrorCode::UnsupportedFeature ,
  DawProjectImportErrorCode::MissingAttribute , DawProjectImportErrorCode::InvalidValue , DawProjectImportErrorCode::MissingMediaBytes , DawProjectImportErrorCode::DuplicateTrackId ,
  DawProjectImportErrorCode::DanglingTrackReference , DawProjectImportErrorCode::ModelRejected , DawProjectImportErrorCode::LimitExceeded
}
 Stable category for a DAWproject import failure. More...
enum class  DeviceChainPosition : std::uint8_t { DeviceChainPosition::PreFader , DeviceChainPosition::PostFader }
 Authored position of a device relative to the track fader. More...
enum class  DeviceSlotKind : std::uint8_t { DeviceSlotKind::EventToEvent , DeviceSlotKind::EventToAudio , DeviceSlotKind::AudioToAudio }
 Static signal-domain contract of one device slot. More...
enum class  DeviceKind : std::uint8_t { DeviceKind::Unresolved , DeviceKind::BuiltIn , DeviceKind::External , DeviceKind::Generated }
 Format-neutral namespace of a durable device binding key. More...
enum class  CommandClass : std::uint8_t {
  CommandClass::Clip , CommandClass::Note , CommandClass::Automation , CommandClass::Track ,
  CommandClass::Take , CommandClass::Scene , CommandClass::Sequence , CommandClass::Device ,
  CommandClass::Annotation , CommandClass::Timing , CommandClass::Asset
}
 The part of the document one command governs. More...
enum class  CommandIntent : std::uint8_t { CommandIntent::Create , CommandIntent::Modify , CommandIntent::Remove }
 What a command does to the entity its class names. More...
enum class  FileJournalErrorCode : std::uint8_t {
  FileJournalErrorCode::IoError , FileJournalErrorCode::InvalidFormat , FileJournalErrorCode::UnsupportedVersion , FileJournalErrorCode::CorruptRecord ,
  FileJournalErrorCode::RevisionMismatch , FileJournalErrorCode::LimitExceeded , FileJournalErrorCode::PersistenceError , FileJournalErrorCode::AlreadyOpen ,
  FileJournalErrorCode::AliasedPath , FileJournalErrorCode::DurabilityUncertain
}
 File-journal open or recovery failure category. More...
enum class  JournalEntryKind : std::uint8_t { JournalEntryKind::Ordinary , JournalEntryKind::History }
 Distinguishes user submissions from generated undo/redo transactions. More...
enum class  JournalSinkError : std::uint8_t { JournalSinkError::Closed , JournalSinkError::IoError , JournalSinkError::InvalidState , JournalSinkError::DurabilityUncertain }
 Failure category returned by a durable JournalSink. More...
enum class  ChordQuality : std::uint8_t {
  ChordQuality::Major = 0 , ChordQuality::Minor = 1 , ChordQuality::Diminished = 2 , ChordQuality::Augmented = 3 ,
  ChordQuality::Dominant7 = 4 , ChordQuality::Major7 = 5 , ChordQuality::Minor7 = 6 , ChordQuality::HalfDiminished7 = 7 ,
  ChordQuality::Suspended2 = 8 , ChordQuality::Suspended4 = 9
}
 Harmonic quality of a chord statement. More...
enum class  ScaleMode : std::uint8_t {
  ScaleMode::Major = 0 , ScaleMode::NaturalMinor = 1 , ScaleMode::HarmonicMinor = 2 , ScaleMode::MelodicMinor = 3 ,
  ScaleMode::Dorian = 4 , ScaleMode::Phrygian = 5 , ScaleMode::Lydian = 6 , ScaleMode::Mixolydian = 7 ,
  ScaleMode::Locrian = 8 , ScaleMode::Chromatic = 9
}
 Scale mode associated with a harmonic context event. More...
enum  ChordExtension : std::uint16_t {
  kChordExtensionNinth = 1u << 0 , kChordExtensionFlatNinth = 1u << 1 , kChordExtensionSharpNinth = 1u << 2 , kChordExtensionEleventh = 1u << 3 ,
  kChordExtensionSharpEleventh = 1u << 4 , kChordExtensionThirteenth = 1u << 5 , kChordExtensionFlatThirteenth = 1u << 6
}
 Added scale degree a chord statement carries above its quality. More...
enum class  ChordVoicing : std::uint8_t {
  ChordVoicing::Close , ChordVoicing::Open , ChordVoicing::Drop2 , ChordVoicing::Drop3 ,
  ChordVoicing::Rootless , ChordVoicing::Shell
}
 Non-binding hint for how a generator should spread a chord's tones. More...
enum class  SectionRole : std::uint8_t {
  SectionRole::Unspecified , SectionRole::Intro , SectionRole::Verse , SectionRole::PreChorus ,
  SectionRole::Chorus , SectionRole::Bridge , SectionRole::Breakdown , SectionRole::Drop ,
  SectionRole::Solo , SectionRole::Interlude , SectionRole::Outro
}
 Structural part a region names, independent of what the region is called. More...
enum class  ItemKind : std::uint8_t {
  ItemKind::Project , ItemKind::Asset , ItemKind::Sequence , ItemKind::Track ,
  ItemKind::Clip , ItemKind::Note , ItemKind::MidiLane , ItemKind::MidiLanePoint ,
  ItemKind::DevicePlacement , ItemKind::AutomationLane , ItemKind::AutomationPoint , ItemKind::Modulator ,
  ItemKind::MacroControl , ItemKind::ModulationRoute , ItemKind::TakeLane , ItemKind::Take ,
  ItemKind::Marker , ItemKind::Region , ItemKind::Scene , ItemKind::Slot
}
 Kind of an identity-bearing item in a Project. More...
enum class  IdentityMutationKind : std::uint8_t { IdentityMutationKind::Insert , IdentityMutationKind::Deactivate , IdentityMutationKind::Reactivate }
 Allowed transition applied to one identity-index entry. More...
enum class  ModulatorKind : std::uint8_t { ModulatorKind::Lfo , ModulatorKind::Envelope , ModulatorKind::Random , ModulatorKind::StepSequence }
 The signal shape a modulator produces. More...
enum class  ModulationSourceKind : std::uint8_t { ModulationSourceKind::Modulator , ModulationSourceKind::Macro }
 Which track-owned entity a route draws its signal from. More...
enum class  NoteConditionKind : std::uint8_t { NoteConditionKind::Always , NoteConditionKind::EveryNth , NoteConditionKind::First , NoteConditionKind::Fill }
 Pass-relative condition controlling when a note may sound. More...
enum class  NoteTransformCallbackError : std::uint8_t { NoteTransformCallbackError::InvalidParameters , NoteTransformCallbackError::Refused }
 Extension callback failures that are safe to persist in transform diagnostics. More...
enum class  NoteTransformErrorCode : std::uint8_t {
  NoteTransformErrorCode::InvalidRegistration , NoteTransformErrorCode::DuplicateRegistration , NoteTransformErrorCode::CapacityExceeded , NoteTransformErrorCode::TransformNotFound ,
  NoteTransformErrorCode::InvalidView , NoteTransformErrorCode::InvalidParameters , NoteTransformErrorCode::TargetMissing , NoteTransformErrorCode::WrongTargetKind ,
  NoteTransformErrorCode::CallbackFailed , NoteTransformErrorCode::InvalidOutput , NoteTransformErrorCode::ForeignOutputIdentity , NoteTransformErrorCode::DuplicateOutputIdentity ,
  NoteTransformErrorCode::OutputLimitExceeded , NoteTransformErrorCode::ItemIdExhausted , NoteTransformErrorCode::TransactionRejected
}
 Validation and execution failures reported by NoteTransformRegistry. More...
enum class  TrackMixerParameter : std::uint8_t { TrackMixerParameter::Gain , TrackMixerParameter::Pan }
 The mixer controls a track owns directly, independent of any device it hosts. More...
enum class  ProductionMode : std::uint8_t { ProductionMode::Synchronous , ProductionMode::Buffered }
 Where content is produced relative to the audio callback that consumes it. More...
enum class  ReproducibilityClass : std::uint8_t { ReproducibilityClass::Deterministic , ReproducibilityClass::Tolerance , ReproducibilityClass::Materialized , ReproducibilityClass::BestEffort }
 What a second render of the same document may claim about the first. More...
enum class  ProductionDeclarationErrorCode : std::uint8_t { ProductionDeclarationErrorCode::None , ProductionDeclarationErrorCode::SynchronousDeclaresLookahead , ProductionDeclarationErrorCode::BufferedDeclaresNoLookahead , ProductionDeclarationErrorCode::LookaheadExceedsLimit }
 Validation result for a ProductionDeclaration. More...
enum class  PersistenceErrorCode : std::uint8_t {
  PersistenceErrorCode::InvalidJson , PersistenceErrorCode::InvalidUtf8 , PersistenceErrorCode::DuplicateKey , PersistenceErrorCode::LimitExceeded ,
  PersistenceErrorCode::MissingField , PersistenceErrorCode::UnexpectedType , PersistenceErrorCode::InvalidNumber , PersistenceErrorCode::InvalidSchema ,
  PersistenceErrorCode::UnsupportedStructuralType , PersistenceErrorCode::UnsupportedSchemaVersion , PersistenceErrorCode::MigrationPathMissing , PersistenceErrorCode::MigrationFailed ,
  PersistenceErrorCode::ModelRejected , PersistenceErrorCode::OutputLimitExceeded
}
 Stable category for a JSON, schema, quota, migration, or model rejection. More...
enum class  SchemaDomain : std::uint8_t {
  SchemaDomain::Document , SchemaDomain::Content , SchemaDomain::AssetRepresentation , SchemaDomain::Command ,
  SchemaDomain::Diagnostic
}
 Namespace in which a schema type name is unique. More...
enum class  SchemaValueKind : std::uint8_t {
  SchemaValueKind::Boolean , SchemaValueKind::U32 , SchemaValueKind::I64String , SchemaValueKind::U64String ,
  SchemaValueKind::String , SchemaValueKind::Object , SchemaValueKind::Array
}
 JSON representation declared for a registered field. More...
enum class  SchemaErrorCode : std::uint8_t {
  SchemaErrorCode::InvalidIdentity , SchemaErrorCode::DuplicateType , SchemaErrorCode::DuplicateField , SchemaErrorCode::InvalidCodec ,
  SchemaErrorCode::InvalidMigration , SchemaErrorCode::DuplicateMigration
}
 Reason a TypeSchema cannot be registered. More...
enum class  SmfErrorCode : std::uint8_t {
  SmfErrorCode::Truncated , SmfErrorCode::MissingHeader , SmfErrorCode::InvalidHeader , SmfErrorCode::UnsupportedFormat ,
  SmfErrorCode::UnsupportedDivision , SmfErrorCode::UnsupportedFeature , SmfErrorCode::MalformedEvent , SmfErrorCode::UnbalancedNote ,
  SmfErrorCode::InvalidValue , SmfErrorCode::InexactTickConversion , SmfErrorCode::TickRangeExceeded , SmfErrorCode::LimitExceeded ,
  SmfErrorCode::TempoMapRejected , SmfErrorCode::MeterMapRejected , SmfErrorCode::ModelRejected
}
 Stable category for an SMF import or export failure. More...
enum class  SmfUnsupportedEventPolicy : std::uint8_t { SmfUnsupportedEventPolicy::Reject , SmfUnsupportedEventPolicy::IgnoreNonNote }
 Policy for a well-formed event outside the documented import subset. More...
enum class  DirtyFlags : std::uint16_t {
  DirtyFlags::None = 0 , DirtyFlags::Structure = 1 << 0 , DirtyFlags::Timing = 1 << 1 , DirtyFlags::Content = 1 << 2 ,
  DirtyFlags::Notes = 1 << 3 , DirtyFlags::Added = 1 << 4 , DirtyFlags::Removed = 1 << 5 , DirtyFlags::Automation = 1 << 6 ,
  DirtyFlags::Take = 1 << 7 , DirtyFlags::Freeze = 1 << 8 , DirtyFlags::Marker = 1 << 9 , DirtyFlags::Context = 1 << 10 ,
  DirtyFlags::Mixer = 1 << 11
}
 Bitmask describing which interpretation of an item became stale. More...
enum class  ConflictCode : std::uint8_t {
  ConflictCode::InvalidIdentifier , ConflictCode::EmptyTransaction , ConflictCode::StaleRevision , ConflictCode::TransactionIdCollision ,
  ConflictCode::CommandIdCollision , ConflictCode::AlreadyAppliedResultExpired , ConflictCode::TargetMissing , ConflictCode::WrongTargetKind ,
  ConflictCode::InactiveTarget , ConflictCode::GestureState , ConflictCode::ParentMismatch , ConflictCode::ExpectedValueMismatch ,
  ConflictCode::IdentityNotAvailable , ConflictCode::JournalFull , ConflictCode::UndoFull , ConflictCode::NothingToUndo ,
  ConflictCode::NothingToRedo , ConflictCode::WriterLimit , ConflictCode::SequenceExhausted , ConflictCode::ModelInvariant ,
  ConflictCode::JournalDurability , ConflictCode::CheckpointMismatch , ConflictCode::ReplayDivergence , ConflictCode::Unspecified ,
  ConflictCode::CapabilityDenied , ConflictCode::WriterQuotaExhausted
}
 Stable reason a transaction cannot be reduced or committed. More...
enum class  TuningSystem : std::uint8_t { TuningSystem::EqualTemperament , TuningSystem::MtsEsp , TuningSystem::Scala }
 How a document states the mapping from note number to pitch. More...

Functions

bool package_relative_path_is_lexically_safe (std::string_view path) noexcept
 Returns whether a persisted package-relative locator preserves Timeline's historical lexical contract: relative, NUL-free, and without parent traversal.
bool package_relative_path_is_portable (std::string_view path) noexcept
 Returns whether a new package-publication path is portable across supported filesystems and cannot be reinterpreted as a device or alternate data stream.
float evaluate_continuous_automation_segment (timebase::TickPosition position, timebase::TickPosition start, timebase::TickPosition end, float start_value, float end_value, float curvature) noexcept
 Evaluates one continuous segment and clamps outside it.
template<class... Fs>
 AutomationTargetCases (Fs...) -> AutomationTargetCases< Fs... >
template<class... Fs>
 ClipContentCases (Fs...) -> ClipContentCases< Fs... >
constexpr LaunchQuantize launch_immediate () noexcept
 Returns an immediate, phase-zero launch policy.
constexpr LaunchQuantize launch_every_quarters (std::int64_t count) noexcept
 Returns a phase-zero grid spanning count quarter notes.
constexpr LaunchQuantize launch_every_bars (std::int64_t count, timebase::MeterSignature meter) noexcept
 Returns a phase-zero grid spanning count bars under meter.
constexpr FollowActionSet follow_action (FollowActionKind kind, timebase::TickDuration grid, std::uint32_t repetitions=1) noexcept
 Builds a one-candidate follow set with unit weight.
constexpr std::uint64_t follow_action_mix (std::uint64_t value) noexcept
 Applies the deterministic SplitMix64 finalizer used by follow draws.
constexpr std::size_t select_follow_action (const FollowActionSet &set, FollowDraw draw) noexcept
 Selects one active candidate by relative weight.
constexpr FollowResolution resolve_follow_action (std::span< const Slot > lane, std::size_t self_index, FollowDraw draw) noexcept
 Resolves the successor of self_index under that slot's follow-action set.
runtime::Result< Transaction, ModelError > build_diverge_transaction (const Project &project, ItemLocation clip, TransactionId transaction_id, DocumentRevision expected_revision, CommandId clone_command_id, CommandId retarget_command_id, std::optional< UndoGroupId > undo_group=std::nullopt)
 Builds the atomic clone-and-retarget transaction used to diverge a sequence reference.
bool equivalent (const ClipTimeRange &lhs, const ClipTimeRange &rhs) noexcept
 Compares time ranges by authored value rather than storage representation.
bool equivalent (const Clip &lhs, const Clip &rhs) noexcept
 Compares complete authored clip state.
bool equivalent (const AutomationLane &lhs, const AutomationLane &rhs) noexcept
 Compares complete authored automation-lane state.
bool equivalent (const TakeLane &lhs, const TakeLane &rhs) noexcept
 Compares complete authored take-lane state.
bool equivalent (const Command &lhs, const Command &rhs) noexcept
 Compares command alternatives and all authored fields.
bool equivalent (const Transaction &lhs, const Transaction &rhs) noexcept
 Compares transaction identity, admission metadata, and commands.
std::size_t retained_size (const Command &command) noexcept
 Returns the retained heap-byte estimate used for command/journal limits.
std::size_t retained_size (const Transaction &transaction) noexcept
 Returns the retained heap-byte estimate of a transaction and its commands.
runtime::Result< Project, DawProjectImportError > import_dawproject_xml (std::string_view project_xml)
 Parses a DAWproject project.xml document without resolving audio media.
runtime::Result< Project, DawProjectImportError > import_dawproject_xml (std::string_view project_xml, DawProjectMediaResolver media_resolver)
 Parses a DAWproject project.xml document using media_resolver.
runtime::Result< Project, DawProjectImportError > import_dawproject_xml (std::string_view project_xml, DawProjectMediaResolver media_resolver, const DawProjectImportLimits &limits)
 Parses a DAWproject project.xml document under explicit resource limits.
template<class T>
constexpr CommandAuthority command_authority_of () noexcept
 Returns the primary authority command type T requires.
CommandAuthority command_authority (const Command &command) noexcept
 Returns the primary authority command requires.
constexpr std::uint64_t capability_bit (CommandAuthority authority) noexcept
 Returns the single mask bit representing authority.
constexpr bool allows (const WriterCapabilityMask &mask, CommandAuthority authority) noexcept
 Reports whether mask permits authority.
constexpr WriterCapabilityMask deny (WriterCapabilityMask mask, CommandClass command_class, CommandIntent intent) noexcept
 Returns mask with one class/intent pair denied.
constexpr WriterCapabilityMask allow (WriterCapabilityMask mask, CommandClass command_class, CommandIntent intent) noexcept
 Returns mask with one class/intent pair permitted.
constexpr WriterCapabilityMask unrestricted_capabilities () noexcept
 Returns the legacy authority carried by writers registered without a mask.
constexpr WriterCapabilityMask non_destructive_capabilities () noexcept
 Returns a mask permitting every class but denying every destructive intent.
std::size_t retained_size (const JournalEntry &entry) noexcept
 Returns a saturated retained-memory estimate for one journal entry.
constexpr bool midi_lane_address_well_formed (const MidiLaneAddress &address) noexcept
 Returns whether every address component fits the width the wire gives it.
std::optional< ModelError > validate_sequence_graph (std::span< const Sequence > sequences)
 Validates all SequenceRef targets, cycles, and maximum graph depth.
std::optional< ModelError > validate_sequence_edge (std::span< const Sequence > sequences, ItemId parent_id, ItemId child_id)
 Validates one prospective parent-to-child edge against a sequence pool.
constexpr ItemId immediate_parent_id (ItemKind kind, ItemId project_id, ItemId sequence_id, ItemId track_id, ItemId clip_id, ItemId lane_id={}) noexcept
 Derives the canonical immediate owner from an item's kind and coordinates.
runtime::Result< RemappedClip, ModelError > remap_ids (const Clip &clip, ItemIdAllocator &allocator, ExternalIdFixup external={})
 Remaps a clip's owned identities, optionally translating asset references.
runtime::Result< RemappedClip, ModelError > remap_ids (const Clip &clip, ItemIdAllocator &allocator, RemapIdFixups fixups)
 Remaps a clip with independent asset and sequence reference fixups.
runtime::Result< RemappedTrack, ModelError > remap_ids (const Track &track, ItemIdAllocator &allocator, ExternalIdFixup external={})
 Remaps a track's owned subtree, optionally translating asset references.
runtime::Result< RemappedTrack, ModelError > remap_ids (const Track &track, ItemIdAllocator &allocator, RemapIdFixups fixups)
 Remaps a track with independent asset and sequence reference fixups.
runtime::Result< RemappedSequence, ModelError > remap_ids (const Sequence &sequence, ItemIdAllocator &allocator, ExternalIdFixup external={})
 Remaps a sequence's owned subtree, optionally translating asset references.
runtime::Result< RemappedSequence, ModelError > remap_ids (const Sequence &sequence, ItemIdAllocator &allocator, RemapIdFixups fixups)
 Remaps a sequence with independent asset and sequence reference fixups.
runtime::Result< RemappedSequence, ModelError > remap_ids (const Sequence &sequence, std::span< const std::pair< ItemId, ItemId > > carried_ids, RemapIdFixups fixups={})
 Rebuilds a sequence from an explicit carried identity table and reference fixups.
runtime::Result< RemappedProject, ModelError > remap_ids (const Project &project, std::uint64_t first_id)
 Remaps every project-owned identity starting at first_id.
template<class... Fs>
 ModulationTargetCases (Fs...) -> ModulationTargetCases< Fs... >
constexpr std::string_view modulator_kind_name (ModulatorKind value) noexcept
 The canonical persisted spelling of a modulator kind, shared by the encoder, the decoder, and every interchange reader so no surface invents its own.
constexpr bool known_modulator_kind (ModulatorKind value) noexcept
 Returns whether value names a declared modulator kind.
constexpr std::optional< ModulatorKind > modulator_kind_from_name (std::string_view name) noexcept
 Parses the canonical persisted modulator-kind spelling.
constexpr std::string_view modulation_source_kind_name (ModulationSourceKind value) noexcept
 The canonical persisted spelling of a modulation source kind.
constexpr std::optional< ModulationSourceKind > modulation_source_kind_from_name (std::string_view name) noexcept
 Parses the canonical persisted modulation-source-kind spelling.
constexpr std::uint64_t note_modifier_mix (std::uint64_t value) noexcept
 Mixes one 64-bit value with the stable note-modifier avalanche function.
constexpr std::string_view note_condition_name (NoteConditionKind condition) noexcept
 Returns the canonical persisted spelling of condition.
constexpr bool parse_note_condition (std::string_view name, NoteConditionKind &out) noexcept
 Parses a canonical condition name into out.
constexpr bool note_modifier_is_neutral (const NoteModifier &modifier) noexcept
 Returns whether modifier encodes unconditional, single-play behavior.
constexpr bool note_modifier_well_formed (const NoteModifier &modifier) noexcept
 Checks structural validity independently of whether the note identity exists.
constexpr std::uint64_t note_modifier_draw_key (std::uint64_t seed, ItemId note_id) noexcept
 Derives the deterministic draw key for one authored seed and note identity.
constexpr bool note_probability_sounds (std::uint16_t probability, NoteModifierDraw draw) noexcept
 Tests an authored probability against draw.
constexpr bool note_condition_holds (NoteConditionKind condition, std::uint16_t period, std::uint16_t offset, std::uint64_t pass_index) noexcept
 Returns whether a pass-relative condition admits pass_index.
constexpr bool note_modifier_sounds (const NoteModifier &modifier, std::uint64_t draw_key, std::uint64_t pass_index) noexcept
 Applies both the modifier's condition and deterministic probability gate.
constexpr std::string_view track_mixer_parameter_name (TrackMixerParameter value) noexcept
 The canonical persisted spelling of a mixer parameter, shared by the encoder, the decoder, and every interchange reader so no surface invents its own.
constexpr std::optional< TrackMixerParameter > track_mixer_parameter_from_name (std::string_view name) noexcept
 Parses the canonical persisted mixer-parameter spelling.
std::string_view production_mode_name (ProductionMode mode) noexcept
 Canonical wire name, stable across builds and safe to persist.
std::string_view reproducibility_class_name (ReproducibilityClass reproducibility) noexcept
 Canonical persisted name for a reproducibility class.
std::optional< ProductionMode > production_mode_from_name (std::string_view name) noexcept
 Parse a canonical wire name.
std::optional< ReproducibilityClass > reproducibility_class_from_name (std::string_view name) noexcept
 Parses a canonical reproducibility-class name and rejects unknown names.
std::uint8_t replay_strength (ReproducibilityClass reproducibility) noexcept
 Replay strength, ascending: BestEffort < Tolerance < Materialized < Deterministic.
ReproducibilityClass weakest (ReproducibilityClass left, ReproducibilityClass right) noexcept
 The weaker of two claims — the only correct way to aggregate a render that spans several classes.
bool is_bit_reproducible (ReproducibilityClass reproducibility) noexcept
 True when a second render is entitled to claim bit-equality with the first.
ProductionDeclarationErrorCode validate_production_declaration (const ProductionDeclaration &declaration) noexcept
 Validate a declaration. Returns None when the declaration is coherent.
runtime::Result< std::string, PersistenceError > emit_schema_manifest (const SchemaRegistry &registry, std::size_t maximum_bytes=8ull *1024ull *1024ull)
 Emits a deterministic JSON-Schema projection of a SchemaRegistry.
runtime::Result< std::shared_ptr< const ParsedJson >, PersistenceError > parse_json (std::string_view json, const DecodeLimits &limits={})
 Parses one complete UTF-8 JSON value into an owning immutable document.
runtime::Result< const JsonValue *, PersistenceError > validate_exact_envelope (const JsonValue &value, std::string_view expected_type, std::uint32_t expected_version, std::string path={}, PersistenceErrorCode failure_code=PersistenceErrorCode::InvalidSchema)
 Validates an exact extension or migration envelope.
runtime::Result< StructuralPreflightSuccess, PersistenceError > preflight_timeline_structure (std::string_view json, const DecodeLimits &limits)
 Performs an allocation-light, schema-aware Timeline quota scan.
runtime::Result< std::string, PersistenceError > canonicalize_json (const JsonValue &value)
 Serializes a DOM value as deterministic JSON with sorted object keys.
std::string quote_json_string (std::string_view value)
 Quotes and escapes a byte sequence as a JSON string token.
runtime::Result< std::uint64_t, PersistenceError > parse_canonical_u64_string (const JsonValue &value, std::string path={})
 Parses a canonical decimal unsigned integer stored as a JSON string.
runtime::Result< std::int64_t, PersistenceError > parse_canonical_i64_string (const JsonValue &value, std::string path={})
 Parses a canonical decimal signed integer stored as a JSON string.
runtime::Result< std::uint32_t, PersistenceError > parse_u32_number (const JsonValue &value, std::string path={})
 Parses an integral JSON number representable as uint32_t.
runtime::Result< SchemaRegistration, SchemaError > register_builtin_timeline_schemas (SchemaRegistryBuilder &builder)
 Registers the built-in document, content, command, and diagnostic schemas.
runtime::Result< SchemaRegistry, SchemaError > make_builtin_timeline_registry ()
 Constructs a registry containing exactly the built-in Timeline schemas.
std::span< const SchemaReleaseMap > builtin_timeline_schema_releases () noexcept
 Returns every built-in release projection in stable static storage.
const SchemaReleaseMap * find_builtin_timeline_schema_release (std::string_view release_label) noexcept
 Finds a built-in release projection by exact label.
runtime::Result< SerializedSnapshot, PersistenceError > serialize_project (const Project &project, const SchemaRegistry &registry, const SerializeOptions &options={})
 Serializes a model-valid project as canonical UTF-8 JSON.
runtime::Result< SerializedSnapshot, PersistenceError > serialize_project_for_release (const Project &project, const SchemaRegistry &registry, const SchemaReleaseMap &release, const SerializeOptions &options={})
 Serializes a project using the schema versions pinned by a release map.
runtime::Result< ProjectSnapshotSummary, PersistenceError > peek_project_summary (std::string_view json, const SchemaRegistry &registry, const DecodeLimits &limits={})
 Scans project metadata and structural counts without constructing Project.
runtime::Result< Project, PersistenceError > deserialize_project (std::string_view json, const SchemaRegistry &registry, const DecodeLimits &limits={})
 Decodes canonical Timeline JSON into a validated Project.
runtime::Result< std::vector< Command >, PersistenceError > deserialize_commands (std::string_view json, const SchemaRegistry &registry, const DecodeLimits &limits={})
 Decodes a JSON command array through the supplied schema registry.
runtime::Result< SmfImport, SmfError > import_smf (std::span< const std::uint8_t > file_bytes)
 Decodes SMF bytes into a Project using default limits and strict event policy.
runtime::Result< SmfImport, SmfError > import_smf (std::span< const std::uint8_t > file_bytes, const SmfImportOptions &options)
 Decodes SMF bytes into a Project under explicit import options.
runtime::Result< SmfExport, SmfError > export_smf (const Project &project)
 Encodes a Project's root sequence as a format-1 SMF with strict defaults.
runtime::Result< SmfExport, SmfError > export_smf (const Project &project, const SmfExportOptions &options)
 Encodes a Project's root sequence as a format-1 SMF under explicit options.
constexpr DirtyFlags operator| (DirtyFlags lhs, DirtyFlags rhs) noexcept
 Combines independent dirty reasons.
runtime::Result< ReducedTransaction, TransactionError > reduce_transaction (const Project &project, const Transaction &transaction)
 Purely applies a transaction to a project without session publication.
constexpr bool valid_tuning_reference (const TuningReference &tuning) noexcept
 Returns whether a tuning reference is internally consistent.
std::size_t retained_size (std::span< const Command > commands) noexcept
 Returns a saturated retained-memory estimate for a command sequence.
bool is_valid_utf8 (std::string_view value) noexcept
 Validates a complete byte sequence as UTF-8 without throwing.

Variables

constexpr std::size_t kAutomationTargetAlternativeCount
 Guard for code that can only be correct for a known set of alternatives — chiefly std::get<T> on a target, which under this module's -fno-exceptions build calls std::terminate rather than throwing when the alternative does not match.
constexpr std::size_t kClipContentAlternativeCount = std::variant_size_v<ClipContent>
 Guard for code that can only be correct while ClipContent holds exactly the alternatives it does today — a decoder keyed on envelope type names, a referential-integrity scan that assumes MediaRef is the only alternative naming an asset, an audio path that assumes MediaRef is the only alternative carrying samples.
constexpr std::size_t kCompileContextKindCount = 5
 Number of CompileContextKind values represented by the subscription bitset.
constexpr std::size_t kMaximumDeviceBindingKeyBytes = 1024
 Maximum UTF-8 byte length of a durable binding key.
constexpr std::size_t kCommandClassCount = 11
 Number of distinct command classes.
constexpr std::size_t kCommandIntentCount = 3
 Number of distinct command intents.
constexpr std::uint64_t kAllCommandAuthorities
 Every class/intent pair set.
constexpr std::uint8_t midi_lane_address_maximum = 15u
 Largest admitted UMP group and channel address component.
constexpr std::uint16_t kChordExtensionMask
 Every extension bit the vocabulary defines; anything outside is rejected.
constexpr std::int32_t kGrooveUnitScale = 1000
 Per-mille identity scale for deterministic groove strengths and velocity.
constexpr std::int32_t kMaxGrooveVelocityScale = 4000
 Largest admitted per-step groove velocity multiplier, in per-mille.
constexpr std::size_t kMaxGrooveSteps = 1024
 Largest admitted number of entries in a repeating groove table.
constexpr std::size_t kMaxSequenceNestingDepth = 8
 Maximum admitted depth of an acyclic SequenceRef graph.
constexpr std::size_t kModulationTargetAlternativeCount
 Number of alternatives a route target may take.
constexpr float kMaximumModulationDepth = 1.0f
 Largest magnitude a route depth may carry.
constexpr std::uint16_t note_probability_certain = 0xffffu
 Denominator and exact "always sounds" value for authored note probability.
constexpr std::uint16_t note_ratchet_maximum = 64u
 Largest admitted authored retrigger count.
constexpr std::size_t kParameterTargetAlternativeCount
 Number of alternatives in ParameterTarget.
constexpr std::uint64_t kMaxProductionLookaheadMs = 60'000
 Upper bound on a declared lookahead.
constexpr float kMaximumTrackGainLinear = 64.0f
 Largest admitted authored linear track gain.
constexpr std::uint32_t schema_manifest_version = 1
 Manifest-shape version consumed by Timeline surface generators.
constexpr std::uint32_t kDefaultReferencePitchMillihertz = 440'000
 Reference pitch for A4 that a document states when it states nothing else.
constexpr std::uint32_t kMinReferencePitchMillihertz = 20'000
 Lowest reference pitch a document may state, in millihertz.
constexpr std::uint32_t kMaxReferencePitchMillihertz = 20'000'000
 Highest reference pitch a document may state, in millihertz.

Function Documentation

◆ is_valid_utf8()

bool pulp::timeline::is_valid_utf8 ( std::string_view value)
noexcept

Validates a complete byte sequence as UTF-8 without throwing.

Parameters
valueBytes to validate.
Returns
Whether the complete sequence is valid UTF-8.