Skip to main content

sva_engine/
lib.rs

1// Concern: resolves a graph into instances a caller can ask about, and keeps their buffers | Non-concern: parsing (sva-ast), CLI framing (sva-cli) | IO: (&Graph, root) -> Instances, Traced
2
3mod arguments;
4mod bindings;
5mod cache;
6mod cast;
7mod error;
8mod index;
9pub mod instantiate;
10mod loops;
11mod lower;
12mod meaning;
13pub mod overload;
14pub mod query;
15mod recent;
16mod refs;
17pub mod render;
18mod schedule;
19mod steps;
20mod threads;
21mod time;
22mod trace;
23mod typing;
24mod vocabulary;
25
26pub use arguments::{Argument, Arguments, Called, Chosen};
27pub use bindings::Binding;
28pub use cache::log::cache_log;
29pub use cache::{
30    Backend, Boot, BootPhase, CacheStats, Call, CallStats, Counters, Cut, DEFAULT_CACHE_BYTES,
31    DEFAULT_MARK_EVERY, DEFAULT_STORE_BYTES, EngineStats, FETCH_READS, Gauge, Hash, INDEX_NAME,
32    Kind, Lookup, Nothing, Opening, Outcome, PayloadKind, Persisted, Phase, Progress, STORE_FORMAT,
33    Store, StoreBoot, Stored, Tally, Tier, Typed, Worked,
34};
35pub use cast::Cast;
36pub use error::{BindingFault, Diagnostic, EngineError, Located, REGISTRY};
37pub use meaning::{Meaning, meaning};
38pub use query::{
39    Answer, Arg, Ask, Atom, DEFAULT_BUFFER_SECS, DEFAULT_CELL_SECS, DEFAULT_FLOOR_DB,
40    DEFAULT_FRAME_SECS, DEFAULT_LEDGER_DEPTH, DEFAULT_LOUDNESS_WINDOW_SECS, DEFAULT_MAX_PAIRS,
41    DEFAULT_MAX_PEAKS, DEFAULT_MODULATION_WINDOW_SECS, DEFAULT_NOVELTY_WINDOW_SECS,
42    DEFAULT_OVERSAMPLE, DEFAULT_PARTIALS_FLOOR_DB, DEFAULT_PARTIALS_FRAME_SECS,
43    DEFAULT_PARTIALS_HOP_SECS, DEFAULT_PARTIALS_TRACKS, DEFAULT_PARTIALS_WINDOW_SECS,
44    DEFAULT_PERIODICITY_WINDOW_SECS, DEFAULT_SMOOTH_SECS, Given, Harmonic, Output, READINGS,
45    Reading, Reads, Representation,
46};
47pub use refs::{identity, nodes_in, spectral_sum_of};
48pub use render::until::{Cmp, Term};
49pub use render::{
50    Abandon, Built, Change, Changed, Counts, Handle, Hear, LATEST, NOTES, Never, Out, Placed,
51    Range, Render, RenderConfig, STREAMED, Session, Stream, StreamConfig, Until, Work, answer,
52    answer_buffer, atoms_of, change, ends, fetch, plan, render, render_called, render_in,
53    render_over, supports,
54};
55pub use schedule::{Order, Schedule, schedule_from};
56pub use sva_formula::{C64, Codomain, Held, Line, NodeId, SpectralSum, Ty, Var};
57pub use sva_samples::measure::{
58    bands, harmony, modulation, partials, periodicity, pitch, self_similarity, sliding, spectrum,
59};
60pub use sva_samples::resample;
61pub use sva_samples::{
62    Alias, AliasBand, BAND_COUNT, BandCrest, BandTrack, Bands, Buffer, Crest,
63    CuttingBelowSilenceThreshold, Detail, EnvelopeFrame, Extent, FormantFrame, Frames, IoiBucket,
64    Label, LedgerEntry, Loudness, LoudnessFrame, MAX_PINNED_FRAME, Note, Onset, Onsets, PEAK_NOTE,
65    PSYCHOACOUSTIC_V1, PitchFrame, Profile, Resampled, Rule, SignalKind, Source, Spectrum,
66    StereoFrame, StereoImage, fitted_frame, measure_alias, pinned_frame,
67};
68pub use threads::default_threads;
69pub use trace::{Traced, Up, trace};
70pub use typing::{Typing, Value, When};
71pub use vocabulary::{MAX_WIDTH, named_may_move, recognized_named, shape, shape_name};
72
73use sva_ast::Graph;
74
75pub const DEFAULT_SAMPLE_RATE: u32 = 44_100;
76
77/// One inference, so a lint and a render refuse identically.
78pub fn check_structure(graph: &Graph, root: &str) -> Result<(), EngineError> {
79    types(graph, root).map(|_| ())
80}
81
82/// One `Ty` per node, across refs, over the instances `root` reaches.
83pub fn types(graph: &Graph, root: &str) -> Result<Typing, EngineError> {
84    types_at(graph, root, DEFAULT_SAMPLE_RATE)
85}
86
87/// At `rate`, whose step each `sp` is.
88pub fn types_at(graph: &Graph, root: &str, rate: u32) -> Result<Typing, EngineError> {
89    let instances = instantiate::instantiate(graph, root, rate)?;
90    // A root names the instance its own defaults resolved to, as `render` asks for.
91    let held = instances.instance_of(root)?;
92    let order = schedule::schedule_from(&instances, std::slice::from_ref(&held))?;
93    typing::infer_all(&instances, &order)
94}