Skip to main content

skenion_runtime/
lib.rs

1mod audio_backend;
2mod clock;
3mod collaboration;
4mod contract;
5mod control_state;
6mod control_value;
7mod conversion;
8mod dsp;
9mod extension_manager;
10mod io_device_manager;
11mod log_store;
12#[cfg(not(test))]
13mod midi_input;
14mod planner;
15mod preview_control_state;
16mod preview_manager;
17#[allow(dead_code)]
18mod project;
19mod project_current;
20#[allow(dead_code)]
21mod registry;
22mod render;
23mod runtime_time;
24mod scheduler;
25mod serve;
26mod server;
27mod session;
28mod session_registry;
29mod sidecar;
30mod telemetry;
31#[allow(dead_code, unused_imports)]
32mod validation;
33mod visual;
34
35pub use audio_backend::{
36    AudioBackendConfig, AudioBackendError, AudioBackendInfo, RunningAudioBackend,
37    start_default_audio_output_backend,
38};
39pub use clock::{
40    MidiClockAdapter, MidiClockFixtureError, MidiSongPositionSource,
41    RUNTIME_MIDI_CLOCK_FIXTURE_SCHEMA, RUNTIME_MIDI_CLOCK_FIXTURE_SCHEMA_VERSION,
42    RuntimeClockDiagnostic, RuntimeClockDiagnosticSeverity, RuntimeMidiClockFixture,
43    RuntimeMidiClockFixtureEvent, RuntimeMidiClockFixtureReport, RuntimeMidiClockSourceId,
44    RuntimeMidiClockSourceKind, RuntimeMidiClockStateSnapshot, RuntimeMidiClockTimeline,
45    TimestampedMidiMessage, format_midi_clock_fixture_report_text, run_midi_clock_fixture,
46    run_midi_clock_fixture_file,
47};
48pub use collaboration::{
49    COLLABORATION_EVENT_REPLAY_LIMIT, RuntimeCollaborationLog, RuntimeCollaborationReplay,
50    collaboration_broadcast_event_after_high_water, collaboration_event,
51};
52#[allow(unused_imports)]
53pub(crate) use contract::{
54    ApplyPatchError, AudioClockBridgeMethod, AudioClockBridgePlan, AudioClockDomain,
55    AudioClockDomainAuthority, AudioDeviceDescriptor, AudioDevicePreference, AudioEndpoint,
56    AudioEndpointDirection, AudioGraphPartition, AudioResamplerPlan, AudioStreamConfigRequest,
57    AudioStreamConfigResolved, ClockAuthority, ClockCapability, ClockField, ClockSourceKind,
58    ClockState, ClockTimeSignature, DataFlow, DataType, Edge, ExecutionModel, ExtensionKind,
59    ExtensionManifest, ExtensionNativeArtifact, ExtensionNativeBinding, ExtensionProvides,
60    GraphDocument, GraphNode, GraphPatch, GraphPatchOperation, InvertPatchError,
61    MIDI_CLOCK_TICKS_PER_QUARTER, MIDI_CLOCK_TICKS_PER_SIXTEENTH, MidiClockApplyResult,
62    MidiClockDiagnostic, MidiClockDiagnosticSeverity, MidiClockMessage, MidiClockMessageKind,
63    MidiClockSnapshot, NodeDefinition, NodeExecution, NodeState, NumberRange, Port, PortActivation,
64    PortDirection, PortRef, ShaderInterface, ShaderInterfaceDiagnostic, ShaderUniform,
65    StringOrStrings, analyze_shader_interface_v01, apply_midi_clock_message,
66    midi_clock_snapshot_to_clock_state, parse_midi_clock_message, plan_audio_clock_bridge,
67    shader_interface_to_ports_v01,
68};
69pub use contract::{
70    CanvasNodeView, CanvasViewState, CanvasViewport, CycleValidationCurrent, EdgeEndpointCurrent,
71    EdgeSpecCurrent, ExecutionModelCurrent, FanOutPolicyCurrent, FeedbackBoundaryCurrent,
72    FeedbackPolicyCurrent, GraphDocumentCurrent, GraphFragmentCurrent,
73    GraphFragmentOutsideEndpointPolicyCurrent, GraphNodeCurrent, GraphTargetRef,
74    GraphValidationResultCurrent, IdConflictPolicy, IdRemapResult, MergePolicyCurrent,
75    NodeDefinitionCurrent, PasteGraphFragmentRequest, PasteGraphFragmentResponse, PastePlacement,
76    PatchContractCurrent, PatchContractPortCurrent, PatchDefinitionCurrent, PatchPath,
77    PortDirectionCurrent, PortRateCurrent, PortSpecCurrent, ProjectDocumentCurrent,
78    ProjectMetadataCurrent, RuntimeCollaborationAck, RuntimeCollaborationAuthSubject,
79    RuntimeCollaborationCausalMetadata, RuntimeCollaborationChange, RuntimeCollaborationConflict,
80    RuntimeCollaborationEventEnvelope, RuntimeCollaborationEventKind,
81    RuntimeCollaborationEventPayload, RuntimeCollaborationNack, RuntimeCollaborationNackReason,
82    RuntimeCollaborationOperationBatch, RuntimeCollaborationOperationBatchResult,
83    RuntimeCollaborationOperationDiagnostic, RuntimeCollaborationOperationEnvelope,
84    RuntimeCollaborationOperationPayload, RuntimeCollaborationOperationResult,
85    RuntimeCollaborationOperationStatus, RuntimeCollaborationPresenceEnvelope,
86    RuntimeCollaborationRebase, RuntimeCollaborationRebaseStrategy,
87    RuntimeCollaborationSelectionEnvelope, RuntimeCollaborationServerClock,
88    RuntimeCollaborationUndoRedoAction, RuntimeCollaborationUndoScope,
89    RuntimeCollaborationUndoScopeKind, RuntimeOperationAttribution, RuntimeOperationDiagnostic,
90    RuntimeOperationEnvelope, ViewState, validate_runtime_collaboration_event_envelope,
91    validate_runtime_collaboration_operation_batch,
92    validate_runtime_collaboration_operation_batch_result,
93    validate_runtime_collaboration_operation_envelope,
94    validate_runtime_collaboration_operation_result,
95    validate_runtime_collaboration_presence_envelope,
96    validate_runtime_collaboration_selection_envelope,
97};
98pub use control_state::{
99    ControlState, RuntimeControlEmission, RuntimeControlEventRequest, RuntimeControlEventResponse,
100    RuntimeControlReadRequest, RuntimeControlReadResponse, RuntimeControlReadTarget,
101    RuntimeControlStateResponse,
102};
103pub(crate) use control_state::{read_graph_param, read_graph_port};
104pub use control_value::{ControlMessage, ControlValue};
105pub use conversion::{convert_control_value_to_data_kind, convert_control_value_to_stored};
106pub use dsp::{
107    AudioDspBlockReport, AudioDspBuffer, AudioDspControlInput, AudioDspPlan, AudioDspPlanEdge,
108    AudioDspPlanError, AudioDspPlanNode, AudioDspPlanOptions, AudioDspRenderedBuffer,
109    AudioDspSignalInput, AudioDspSignalOutput, AudioDspSnapshot, AudioEndpointPlanNode,
110    AudioOfflineDspError, AudioOfflineDspOptions, AudioOfflineDspReport, AudioRealtimeDspError,
111    AudioRealtimeDspExecutor, AudioRealtimeDspOptions, build_audio_dsp_plan_current,
112    run_offline_audio_dsp_current,
113};
114pub use extension_manager::{
115    RUNTIME_EXTENSION_ABI_VERSION, RUNTIME_EXTENSION_MANIFEST_FILE, RuntimeExtensionDescriptor,
116    RuntimeExtensionListResponse, RuntimeExtensionManager, RuntimeExtensionStatus,
117    SKENION_EXTENSION_PATH_ENV,
118};
119pub use io_device_manager::{
120    RuntimeIoBindingConfig, RuntimeIoDeviceDescriptor, RuntimeIoDeviceListResponse,
121    RuntimeIoDeviceManager, RuntimeIoDiagnostic, RuntimeIoDiagnosticSeverity, RuntimeIoDirection,
122    RuntimeIoInlineFrame, RuntimeIoTransportKind,
123};
124pub use log_store::{
125    DEFAULT_RUNTIME_LOG_BACKLOG_LIMIT, RUNTIME_LOG_SCHEMA, RUNTIME_LOG_SCHEMA_VERSION,
126    RuntimeLogEvent, RuntimeLogRetention, RuntimeLogSnapshotResponse, RuntimeLogSource,
127    RuntimeLogStore,
128};
129pub(crate) use planner::build_execution_plan;
130pub(crate) use planner::{ExecutionGroup, PlanEdge, PlanEdgeMetadata, PlanError, PlanNode};
131pub use planner::{ExecutionPlan, format_plan_text};
132pub use preview_control_state::{
133    PREVIEW_CONTROL_STATE_SCHEMA, PREVIEW_CONTROL_STATE_SCHEMA_VERSION,
134    PreviewControlStateSnapshot, preview_control_state_path, read_preview_control_state_snapshot,
135    write_preview_control_state_snapshot,
136};
137pub(crate) use preview_manager::PreviewContext;
138pub use preview_manager::{
139    PreviewManager, PreviewState, RuntimePreviewStartRequest, RuntimePreviewStatusResponse,
140};
141pub(crate) use project::{ProjectValidationReport, validate_project};
142pub use project_current::{
143    CURRENT_SCHEMA_VERSION, ProjectRequestCurrent, RunProjectRequestCurrent,
144    build_execution_plan_current, build_execution_plan_request_current,
145    build_execution_plan_run_request_current, expand_project_graph_current,
146    project_document_payload_schema_diagnostics, project_document_validation_diagnostics_current,
147    schema_version_diagnostic, validate_project_current, validate_project_request_current,
148};
149pub(crate) use registry::NodeRegistry;
150pub use render::{
151    ClearColorScene, DEFAULT_CLEAR_COLOR, FullscreenShaderScene, GeneratedShaderResponse,
152    GeneratedShaderSource, GeneratedShaderSourceMap, RENDER_CLEAR_COLOR_KIND,
153    RENDER_FULLSCREEN_SHADER_KIND, RENDER_OUTPUT_KIND, RenderScene, RenderSceneBuildError,
154    ShaderLanguage, ShaderUniformBinding, ShaderUniformValue, run_render_preview_document_file,
155};
156pub(crate) use render::{PreviewDocument, generated_shader_response_from_preview_document};
157pub use scheduler::{
158    DummyExecutionReport, DummyFrameReport, DummyNodeExecution, format_dummy_execution_text,
159    run_dummy_execution,
160};
161pub use serve::{ServeRuntimeOptions, serve_runtime, serve_runtime_with_options};
162pub use server::{
163    DEFAULT_HOST, DEFAULT_PORT, DiagnosticSeverity, HealthResponse, RUNTIME_API_VERSION,
164    RuntimeApiResponse, RuntimeDiagnostic, RuntimeInfoResponse, RuntimeServerState, runtime_router,
165    runtime_router_with_state,
166};
167pub use session::{
168    RuntimeHistory, RuntimeHistoryEntry, RuntimeHistoryEntryKind, RuntimeMutationRequest,
169    RuntimePatchResponse, RuntimeSession, RuntimeSessionResponse, RuntimeSessionSnapshot,
170    RuntimeViewPatch, RuntimeViewPatchOperation, SessionRunRequest,
171};
172pub use session_registry::{
173    DEFAULT_SESSION_ID, RuntimeSessionEvent, RuntimeSessionEventKind, RuntimeSessionRecord,
174    RuntimeSessionRegistry, SessionEventsQuery,
175};
176pub use sidecar::{
177    RuntimeEndpointConfig, RuntimeSidecarHealthResponse, RuntimeSidecarShutdownInfo,
178    RuntimeSidecarShutdownRequest, RuntimeSidecarShutdownResponse, RuntimeSidecarStartupResponse,
179    RuntimeSidecarTokenInfo,
180};
181pub use telemetry::{
182    PREVIEW_TELEMETRY_SCHEMA, PREVIEW_TELEMETRY_SCHEMA_VERSION, PreviewTelemetryHeartbeat,
183    PreviewTelemetryWriter, RuntimeTelemetryPreview, RuntimeTelemetryProcess,
184    RuntimeTelemetryRender, RuntimeTelemetrySession, RuntimeTelemetrySnapshot, ShaderDiagnostic,
185    ShaderDiagnosticPhase, ShaderDiagnosticSeverity, ShaderDiagnosticSource, TELEMETRY_SCHEMA,
186    TELEMETRY_SCHEMA_VERSION, preview_telemetry_path, read_preview_telemetry, unix_ms_timestamp,
187    write_preview_telemetry_heartbeat,
188};
189pub(crate) use validation::{
190    ValidationReport, compatible_data_types, type_label, validate_graph_document,
191    validate_node_definition,
192};
193pub use visual::{PreviewFrameLimit, run_preview_window};