1use sva_core::DEFAULT_STORE_BYTES;
4use sva_core::solve;
5use sva_engine::resample;
6use sva_engine::{
7 DEFAULT_BUFFER_SECS, DEFAULT_CELL_SECS, DEFAULT_FLOOR_DB, DEFAULT_FRAME_SECS,
8 DEFAULT_LEDGER_DEPTH, DEFAULT_LOUDNESS_WINDOW_SECS, DEFAULT_MAX_PAIRS, DEFAULT_MAX_PEAKS,
9 DEFAULT_MODULATION_WINDOW_SECS, DEFAULT_NOVELTY_WINDOW_SECS, DEFAULT_OVERSAMPLE,
10 DEFAULT_PERIODICITY_WINDOW_SECS, DEFAULT_SAMPLE_RATE, DEFAULT_SMOOTH_SECS, PSYCHOACOUSTIC_V1,
11 READINGS, Reads, self_similarity::MAX_CELLS, spectrum,
12};
13
14pub fn help_text() -> String {
17 let bits = PSYCHOACOUSTIC_V1.precision_bits;
18 let store_gb = DEFAULT_STORE_BYTES >> 30;
19 let body_chars = crate::lint::BODY_CHARS;
20 let representations = representations();
21 let (min_frame, max_frame) = (spectrum::MIN_FRAME, spectrum::MAX_FRAME);
22 let rules = solve_rules();
23 let floor = solve::FLOOR_DB;
24 let (max_renders, step_tol, cost_tol) = (
25 solve::DEFAULT_MAX_RENDERS,
26 solve::DEFAULT_STEP_TOL,
27 solve::DEFAULT_COST_TOL,
28 );
29 let (passband, stopband) = (resample::PASSBAND, resample::STOPBAND);
30 let bound = format!("{} dB", 20.0 * resample::BOUND.log10());
31 let formats = crate::recording::READS
32 .map(|e| format!("`.{e}`"))
33 .join(", ");
34 let unreadable = crate::recording::UNREADABLE;
35 format!(
36 r#"USAGE:
37 sva-cli (render | analyze | solve | lint | trace | builtins | outline | new) [arguments]
38
39DESCRIPTION:
40 A composition is a directory of node files, each one closed-form expression in
41 `t` or `f` on one line, or a score placing notes in time. sva-cli reads that
42 composition and prints what it is and what it sounds like, as JSON on stdout.
43 `render`, `solve`, `lint` and `trace` read the current directory; `new` writes
44 beside it and `analyze` reads a file. `solve` fits variables to a reference.
45
46SCORES:
47 A score is a `.jsonl` file: JSON Lines, one object per line, sorted by `at`;
48 `@score/drop` reads `score/drop.jsonl`, and a ref never writes `.jsonl`. A
49 file with no extension opening with `{{` refuses with the rename. Line 1 is
50 its annotation, the doc comment's four fields, which `lint` holds it to:
51 {{"annotation": "Models: ... | Neglects: ... | IO: (t) -> amplitude | Tags: ..."}}
52 Every other line is one kind, told by its keys, and may add `"comment"`:
53 event "at", "node", "deg", "len" and the node's parameters: plays it
54 mark "at", "mark": a point `mark(name)` reads in this file's times
55 comment "at", "comment": a note to the reader at a time
56 move "at", "lane", "to", and "node", "len", "shape" where written
57 A score lowers to equations, the sum of its events in written order, each
58 its node shifted to its `at`; marks, comments and moves sound nothing.
59 at a time string, "0.25b" or "0.5s", or arithmetic over times, "2b +
60 1b/3" for a triplet; a bare number has no unit and refuses. A file
61 counts every time in bars or every one in seconds. "mark(verse) -
62 2b" is a position, "mark(drop) - mark(build)" a duration.
63 node an `@ref` from the score's own directory: a sound, an equation or
64 another score. On a line placing a score `len` crops it there and
65 nothing else binds; a `node` list mixing scores and sounds refuses
66 `len`.
67 deg a whole scale degree counted from 1, the tonic: sugar for "f0":
68 "deg(n)". In a seven-row scale 8 is the tonic an octave up, 0 the
69 seventh below and -6 the tonic an octave down. A chromatic note
70 binds "f0": "deg(7)*1st"; a line writing both refuses.
71 len a time as `at` takes, bound as the node's `len`.
72 other binds the node's parameter of that name: a number, or a constant in
73 a string, "0.03s", "-6db", "900hz", "A1", "0.8*0.9", "deg(5)/2".
74 Any field but `comment` may be a list. A line listing N items is N events,
75 moves or marks, item i of every list going to the i-th and a single value to
76 all; lists of different lengths refuse. A chord is a `deg` list on one `at`:
77 {{"at": "0b", "node": "@../instruments/keys", "deg": [1, 3, 5],
78 "vel": [0.8, 0.5, 0.6]}}
79 `deg(n)` is the tonic in `variables/key` times degree n's ratio in the scale
80 `variables/scale` names, read where the line sits, in a score or in any
81 equation. A scale is one the language names, as `minor` or `dorian` (`sva-cli
82 builtins` lists each with its cents), or a file of one row per degree in cents
83 above the tonic, ascending, the last the period, named by a ref: a file
84 `scales/custom` holding 200 400 500 700 900 1100 1200 is the major scale. A
85 value reading `t` or a `@ref`, a field the node does not read, a parameter it
86 reads that nothing binds, and a `deg` with no scale refuse before any audio,
87 each naming the score's file, line and column.
88
89 A lane is one value moving through the song: a node's parameter, a move
90 naming "node" and "lane": "cutoff", or a variable under `variables/`, a move
91 naming "lane" alone: "energy", "key", "scale", "bpm" (never "meter"). A move
92 with no `len` sets the lane at `at`; with "len" and "shape", `lin` or `exp`,
93 it ramps there from the value it holds:
94 {{"at": "24b", "node": "@../instruments/saw", "lane": "cutoff",
95 "to": "9khz", "len": "8b", "shape": "exp"}}
96 {{"at": "72b", "lane": "key", "to": "key*2st", "comment": "a tone up"}}
97 {{"at": "92b", "lane": "bpm", "to": "bpm*8/9", "len": "4b", "shape": "lin"}}
98 A `to` naming the lane means its home value, the node's default or the
99 variable's file, so it follows `--set`. A lane reaches every instance of its
100 node, from a score or an equation, inside a wrapper too, unless the line or
101 an invoking equation passes that parameter, which wins. Where it holds one
102 value over an instance's span it binds that number; where it moves there the
103 instance reads it at its song time, and where the engine refuses a moving
104 value, such as `sat`'s `drive`, the move refuses as `bad-lane`: pass a
105 constant, move the lane between notes, or close the sound's tail with a crop.
106 A score's times ride the tempo curve the `bpm` lane draws; `b` in an equation
107 stays a bar of `variables/bpm`. A song places its sections at marks:
108 {{"at": "0b", "mark": "intro"}}
109 {{"at": "mark(intro)", "node": "@intro"}}
110 {{"at": "mark(intro) + 8b", "mark": "verse"}}
111 {{"at": "mark(verse)", "node": "@verse"}}
112 `concat` and `repeat` place parts on the curve too: `repeat(@score/riff-1b, 4)`.
113 An equation reading a score at `t - d`, an echo or a send, hears the song as
114 it was d earlier: its lines keep their song time, and a move however many
115 reads reach it is one move.
116 A control score is one no sounding score places, read by an equation as a
117 signal: `@score/song(t) * (1 - @score/pump(t))` ducks the song under it.
118 `sva-cli outline @score/song` prints a song's marks, tempo, lanes, events and
119 size. Lint and render warn of a line passing a parameter whose lane ramps
120 under it (`line-overrides-lane`), and of a lane no instance reads
121 (`lane-reaches-nothing`).
122
123RESERVED VARIABLES:
124 Four nodes under `variables/` are reserved: a ref reads one like any node,
125 and a bar or a degree reads one by name:
126 variables/bpm a number, the beats per minute: 120
127 variables/meter beats per bar over the note: 4/4
128 variables/key the tonic `deg` counts from, a note or hertz: C3
129 variables/scale the scale `deg` counts in, a built-in's name: major, or a
130 ref to a scale file: @../scales/custom
131 A `b` literal or a file's `-2b` span reads bpm and meter; a `deg(n)` reads key
132 and scale. Before anything renders, each read is replaced by its value, by one
133 pass for all four: a bar becomes `n*(beats*60/bpm)` seconds and `deg(n)`
134 becomes `@variables/key` times degree n's ratio, the tonic still a ref. A
135 read with no value to replace it refuses as `bad-tempo` or `bad-scale`, as
136 does a variable holding no such value, such as bpm without meter, or a
137 scale name no built-in has, which refuses listing every built-in. A stream's
138 edit to a variable, or to the scale file it names, replaces every read of it
139 again. A node elsewhere named `bpm` is an ordinary node. Any other file under
140 `variables/`, as `variables/energy` holding 0.5, is a variable of the
141 composition's own: a ref reads it, `--set` sets it, and a score's moves move
142 it, as they move the reserved ones but `meter` (SCORES).
143
144RENDER:
145 sva-cli render '<expression>' --representation <list> [--until '<condition>']
146 [--bits <n>] [--rate <hz>] [--threads <n>] [--cache <path|none>]
147 [--set <name>=<text>]... [--confirm]
148
149 Renders one expression, in the grammar a node file's body uses, and prints one
150 reading per representation under `data.representations`. `@path` reads a node
151 from the current directory and `@/abs/path` one anywhere; there is no default
152 target. Every reading states what it was read with: `representation`, its
153 name, and `args`, every argument it takes as it used it, a plain number as a
154 number and the rest as `--representation` spells them (`pitch` alone prints
155 `"peaks": 16, "frame": "50ms"`), a default written out and a `spectrum`
156 frame left to fit the range as the frame it fitted. Null is an argument that
157 did not apply: a frame read exactly off the math, `modulation`'s unwritten
158 `bpm`, `samples`' `buffer` with no device. Its `args` written back as
159 `name(key=value, ...)`, nulls left out, ask the same reading. It states its
160 `source` (exact or measured), the conformance profile it ran under, and its
161 rate; `analyze` prints the same.
162
163 The target's own ref may read an interval: `@piano4([0, 2b], f0=C4,
164 vel=0.5, release=1s)`, where `release` is the instrument's own parameter. Its ends are the language's literals (`s`, `ms`, `b`,
165 `sp`, or a bare `0`); `[a, inf)` and `[a,)` leave the end open; the other
166 arguments are the node's own named ones. The start trims the output alone:
167 history before it is still computed, so a loop or a filter carries the state
168 it had there. With no interval the render starts at 0, earlier only where a
169 crop reaches before it, and its end is open. Inside an expression a window is
170 a `crop`. A target that samples its one ref read, `sample(@piano4([0, 2b],
171 f0=C4))`, reads that ref's interval and binds and the same node values.
172
173 `sample("<path>")` is a recording: a file relative to the directory sva-cli
174 runs in, or absolute, read as `analyze` reads one (ANALYZE); keep it outside
175 the composition, where it would be read as a node. It is the file's samples
176 at the render's rate, one component per channel as `join` makes them, silent
177 outside the file's span. At its own rate every sample passes unchanged. At
178 another a cos^16-windowed sinc reads it: a tone up to {passband} of the lower
179 rate reads within {bound} of itself, and one from {stopband} of it at most
180 {bound} of its level, a bound proven for the kernel that the label states
181 under `resampled` beside the rate it came from. The path is the language's
182 one string, in double quotes and only as `sample`'s one argument; one naming
183 no file refuses as `not_found`, and one `analyze` cannot read as
184 `{unreadable}`. A store keys a recording by its samples and rate, never its
185 path.
186
187 Every node is computed over its support met with what reads it, and nowhere
188 else: outside its support a node is exactly zero. A closed interval renders
189 exactly its length, nothing cut. An open one ends where the root's support
190 does: a crop's end, the exact underflow of an `exp`, a clamp holding a factor
191 at zero; or earlier, where a proven upper bound on the root's magnitude stays
192 under the profile's silence threshold (-120 dBFS) from a sample on. A root
193 with no such bound (a held sine, a loop) is never cut. The label's `pruned`
194 states the threshold as `db` and the root's cut, `from` the sample the render
195 is treated as silent from. A stream's term leaves `@notes` where its support
196 ends. An open interval over a root whose support never ends and is never cut
197 (a held sine, a physical solver) refuses as `render.no_end`. A short-time
198 transform reads its input whole, and refuses one with no end as
199 `engine.unbounded_extent`. A form in `f` with no dual in `t` has no samples
200 and refuses as its dual does, `cast.left_algebra`.
201
202 A render is a stream pulled to its end: a closed form, a short-time
203 transform and what either reads are computed over their whole extent first,
204 and every other node block by block. `--until '<condition>'` stops the render
205 at the first sample the condition holds at, or at the interval's end,
206 whichever is first. It is checked as each block is pulled, so no node driven
207 block by block runs past the block it holds in. A condition compares (`<`,
208 `<=`, `>`, `>=`) `t`, `envelope(t)` (the RMS over every channel of the
209 `envelope` representation's frame holding `t`, framed by its own `frame`
210 where one is asked) and literals, joined by `and`/`or`.
211
212 `--representation <list>` takes a comma list of readings and may repeat. Each
213 is a call in the language's own syntax, its options its named arguments:
214 `spectrum(peaks=8, frame=50ms)`, `ledger(depth=3, brief=1)`. A `frame`,
215 `window`, `cell` or `smooth` is a time as a score writes one, in seconds,
216 `50ms`, or in bars, `1b/8` (`1/8b` is one over eight bars), a bar lasting
217 what the render's tempo says; where none is known, as in `analyze`, bars
218 refuse as `tempo.invalid_bpm_meter`. An entry
219 followed by `=<path>` writes a file instead, listed under `written`:
220 `samples=<path>.wav` writes audio, encoded as `--bits` says; any other path
221 takes the reading's JSON, uncapped. A path that already holds a file refuses
222 unless `--confirm` is written. `samples=alsa:<device>` plays the samples on
223 that ALSA device (`alsa:default`, `alsa:hw:1`, `alsa:plughw:1,0`) as each
224 block is pulled, in real time, through `aplay` from alsa-utils; Linux only,
225 anywhere else it refuses as `destination.unsupported_platform`. It sends
226 32-bit floats, or integer PCM where `--bits` is 16 or under. A device that
227 cannot take the format refuses with aplay's reason, and one aplay says plays
228 another rate than the render's stops there as `destination.rate_inexact`.
229 `samples(buffer=<t>)` is how much the device holds ahead of what it plays.
230 Once it has played out, `data.played` states the device, its seconds, rate,
231 channels, format, the buffer asked and the one granted, and every underrun
232 aplay reported, with what it cannot see.
233 `lines`, `atoms`, `derivative`, `bindings`, `arguments`, and a closed form's
234 `spectrum`, `envelope` and `pitch`, read the expression and ignore the range.
235
236 A closed form's `spectrum` and `pitch` are its exact lines, so a term under a
237 crop or an envelope, which has a width and is no line, refuses them; so do
238 `spectrum(frame=)` and `envelope(frame=)`, as a closed form has no frames. To
239 measure any of them frame by frame, a reader samples the target's ref,
240 `sample(@x([0, 1s]))`, and an author writes `sample(...)` inside the node.
241 A closed form with no exact envelope, such as a crop of a decay, refuses
242 `envelope` with the reason rather than measuring it unasked; `sample(...)`
243 asks for the measured one. A knot table, `pwl(t, 0s, 0, 5ms, 1, 0.4s, 0)`,
244 is the straight lines through its knots, and `pwl_integral` with the same
245 knots that curve's integral from the first, so `cos(2*pi*pwl_integral(t, 0s,
246 440hz, 1s, 880hz))` glides an octave with an exact phase; either is exact at
247 every instant and holds any number of knots at no cost per sample, but has no
248 atoms, so these exact readings refuse it as `cast.left_algebra` and read it
249 measured off `sample(...)`. `sva-cli builtins` states both.
250 A measured `spectrum` is one spectrum: whole
251 windows across the range, averaged, the first at its first sample and the last
252 ending at its last, evenly at most half a window apart; a window is `frame`
253 rounded up to a power of two samples, at least {min_frame}, or without `frame`
254 the range's length so rounded, at most {max_frame}. `pitch` is framed, one entry
255 per `frame`; for the spectrum at one instant, read a range one frame long.
256 A measured `envelope` is framed too, and reads every channel: a frame's
257 `rms` is the root mean square of all its channels' samples together, its
258 `peak` the largest magnitude in any channel. `onsets` reads every channel
259 as well: a frame's flux is the sum of each channel's, and a strike's energy
260 that of all channels' samples together, so opposite phases cancel nothing.
261 Every other measured reading but `stereo` reads every channel in power, as
262 `envelope` reads a level: a spectrum's power per bin (`spectrum`, `pitch`,
263 the partials `dissonance`, `voice_leading`, `tonal_distance`,
264 `inharmonicity` and `self_similarity` pick), a formant frame's
265 autocorrelation and each auditory band's energy (`bands`, `periodicity`,
266 `modulation`, `self_similarity`) are each channel's averaged, so a channel
267 copied to two reads as itself; `crest` sets any channel's peak against the
268 RMS of all of them together. A closed form's exact readings read every
269 channel in power too: a partial's squared amplitude (`pitch`, `dissonance`,
270 `voice_leading`, `tonal_distance`, `inharmonicity`) is summed over the
271 channels at its frequency and divided by their count, and a spectrum of more
272 than one channel lists each frequency once, its amplitude the root of that
273 mean power, real, as channels share no phase.
274
275 `--bits <n>` is the precision every sample is written to, from 2 to 52: the
276 point where a series is truncated, and the encoding of a `.wav`, integer PCM
277 at n bits up to 16 and 32-bit float above. `--rate <hz>` (default
278 {DEFAULT_SAMPLE_RATE}) is the one rate a render samples at: the target is read
279 at its instants, and every node at the instants its reader asks for. A
280 closed form is exact at any instant, and so is a continuous loop, one
281 constant delay at a gain under 1 over a closed form such as
282 `x + 0.5*self(t - 17ms)`, which is its series. A filter, a discrete loop, a
283 solver and `rand` step at the rate asked for, where `1sp` is one step, so an
284 `sp` count or `self[idx(t) - 1]` means one sample at whatever rate is asked.
285 `rand` draws once per step, keyed by that step's index; a key between steps
286 reads the step nearest it, ties to even.
287
288 `--set <name>=<text>` renders as if the variable `variables/<name>` held
289 `<text>`, and writes no file: `--set key=G3` transposes every degree to G3,
290 `--set scale=dorian` changes mode (a scale file is a ref written from
291 `variables/`, as the file holds it: `--set scale=@../scales/custom`), `--set
292 bpm=140` moves every bar, `--set meter=3/4` regroups them and `--set
293 energy=0.8` sets a variable of the composition's own. It sets a lane's home
294 value: a move whose `to` names it follows. It may repeat, once per variable: a
295 variable set twice refuses as `render.set_twice`, a name with no file under
296 `variables/` that is no reserved one as `render.set_unreserved`, listing the
297 variables there, and the file's path, `variables/key=G3`, as
298 `render.set_path`, naming the short form.
299
300 `--threads <n>` (default: every core the machine reports) is the most
301 threads a render computes on; `1` computes every value in turn on one.
302 Values none of the others reads, and the blocks of a value that holds no
303 state, compute apart, to the same bits on any number of threads.
304
305 A discrete loop reads its own past only by index; `self(t - d)` in one
306 refuses as `type.discrete_self_at_time`, naming what made it discrete. A
307 read `@x(k*t - d)` steps `x` at `k` times the step, every input it reads,
308 `sp` and `idx` with it, and rounds `d` to the nearest sample of that step,
309 ties to even: shifts are rounded to the nearest sample so placements share
310 one cached value; timing is exact to half a sample, and the label's
311 `moved_s` states the most any read moved. A node is computed once
312 per step however many reads ask for it. A node that holds state read at a
313 time that moves refuses as `type.stateful_warp`, naming what
314 holds its state; `@x[idx(...)]` reads its nearest step instead, as `p[idx(...)]`
315 does a signal passed in as parameter `p`, and any `idx`, as
316 `idx(t - 5ms - 2ms*sin(2*pi*t))`, is read sample by sample. An edit to a
317 stream plays from the next sample on.
318
319 A render keeps in a store on disk its target and, under it, each node of
320 samples that holds state (a filter, a discrete loop or a solver in it) or
321 that two or more nodes read. Nothing else is kept. A closed form, `sample`
322 of one and `rand` have a value at any instant and are computed where read.
323 A node without state that one node alone reads, however many times, is
324 computed again by that reader from what the node itself reads: no other
325 reader could ask for it, and without state it restarts at any sample, where
326 a filter or a loop must run from its start. So a stage worth keeping is a
327 node of its own that ends in a filter or a loop, or one two nodes read. A
328 kept value is named by what it computes: never its file's name, directory,
329 comments, spacing, or the order its named arguments are written in, so a
330 renamed or moved copy, a constant lifted into a default, an expression split
331 into a file of its own or written back inline, and two addends swapped all
332 read one entry. The next render of anything that reads the same value reads
333 it back, bit for bit, and computes nothing under it. The store is on by
334 default, at `$XDG_CACHE_HOME/sva`, else `~/.cache/sva`; `--cache <path>`
335 moves it (a `/dev/shm` path keeps it in memory) and `--cache none` turns it
336 off. It holds at most {store_gb} GB, the least recently used values going
337 first, and a store another build of sva-cli wrote is emptied when opened. A
338 render stages what it computes beside the store as it goes, and the store
339 itself is written once, when the render ends, fails, or is stopped by SIGINT
340 or SIGTERM.
341
342 `ledger` prints one row per node under the target. A row's `share` is the
343 part of its reader's own energy that row accounts for, so one reader's refs
344 sum to 1; a ref no addend isolates, such as one factor of a product, and
345 every row under a silent reader, which has no energy to share out, print
346 `null`. A ref carrying a share reads as the addend it gave its reader, its
347 `rms`, `peak` and `clipped` too: in `2*@a`, `a`'s row is `a` doubled, and in
348 `@a - @a` it is silence. Each ref carrying a share is collapsed once on its
349 own, so a ledger costs one collapse per attributed ref beyond the render,
350 and `depth` bounds how many, counted in refs from one file to another. Every
351 row is computed whole over the range, however late a reader reads it.
352 `brief=1` keeps only the rows that clipped, `skim=1` drops the wider fields.
353
354 `arguments` renders nothing: for every instance under the target it prints
355 each builtin call's named arguments as the numbers the call was lowered
356 with, a solver's whole parameter set with `written: false` on each default
357 it filled in, and the operand each `min`/`max` `chosen` where a call folds
358 one to a number: in named arguments and a solver's, modal bank's or
359 `noise`'s positionals. One inside a filter's or cast's positional or
360 `rand`'s key or seed is not listed. `at` spans are bytes of the instance's
361 own body, as `sva-cli outline` counts them.
362
363REPRESENTATIONS:
364 Each one a `--representation` call, its arguments in parentheses, every
365 default under DEFAULTS. `exact` is read off the written math, `measured` off
366 samples.
367
368{representations}
369
370SOLVE:
371 sva-cli solve ('<cost>' | @fits/<name>) --vary <name>=<lo>..<hi>[/<step>][,log]...
372 [--max-renders <n>] [--step-tol <x>] [--cost-tol <x>]
373 [--set <name>=<text>]... [--rate <hz>] [--threads <n>]
374 [--cache <path|none>] [--write [--confirm]]
375
376 Fits variables under `variables/` so the targets a cost reads match a
377 reference, and prints the values it found. It edits no file unless `--write
378 --confirm` says so.
379
380 The cost is one expression typing to one number. Its leaves are
381 `repr.<reading>(<target>, <args>)`: `<reading>` spelled as `--representation`
382 spells it, `<target>` any render target with its interval as render writes
383 one, `<args>` the reading's own: `repr.pitch(@lead([0, 2s], f0=C4),
384 frame=50ms)`. Every leaf is measured off its target's samples, as `analyze`
385 reads a file, so a recording and a render are read alike. Two leaves of one
386 reading with one set of arguments subtract to a residual vector:
387{rules}
388 A level is floored at {floor} dB before it subtracts. A residual inside both
389 sides' stated bounds counts as zero; of these readings only `onsets` states
390 one. Then `norm(v)` (the root of the sum of squares), `sum(v)`, `max(v)`,
391 `abs(x)` (each value's magnitude), `dot([w1, w2, ...], v)` (one literal
392 weight per value), numbers, `+`, `-`, `*` and `/` make one number. A reading
393 left unsubtracted, a vector left unreduced and a leaf of any other reading
394 refuse before anything renders. In a node, `repr` and `load_json` are names
395 the language does not know and refuse as any such name does, with a help
396 naming `solve`.
397
398 `load_json("<file>", "<jq path>")` is a leaf read off a JSON file instead of
399 a render: plain JSON, so a `.json.gz` is unpacked first (`gunzip -k`). The
400 path is relative to the directory sva-cli runs in, or absolute, as
401 `sample("<path>")`'s is. The jq path is steps only, none of jq's filters:
402 `.name`, `[3]`, and a key that is not a plain name in single quotes,
403 `['envelope(frame=10ms)']`, so it needs no escaping in the cost's double
404 quotes: `load_json("../crop.json", ".readings['periodicity(window=5.08s)']")`.
405 A number there loads as a number and a list of numbers as a vector, both
406 usable as weights and in reducers. An object loads only as the other side of
407 a subtraction from a `repr.` leaf, and is a reading as `analyze` prints its
408 `data` (the object holding `interval` and `representations`): from a bench
409 download `.readings['<call>']`, from `analyze ref.wav --representation
410 bands=ref.json` the path `.data`. The leaf's reading reads it, and refuses
411 before the first render where its kind, its arguments, its rate, its
412 profile or its interval's length differ from what the leaf renders, or
413 where a list in it was cut short (`has_more: true`; a reading written to a
414 file is whole). Its arguments are its `args`, compared one by one with the
415 leaf's, each resolved at the solve's rate, so `frame=0.05` matches
416 `frame=50ms`; a mismatch names the argument and both values, and a reading
417 with no `representation` and `args` refuses. Each file is read once per
418 solve.
419
420 `@fits/<name>` reads the cost from the file `fits/<name>` of the
421 composition, written as a node is: an annotation line `; Models: ... |
422 Neglects: ... | IO: ... | Tags: ...`, then the cost, over as many lines as
423 it needs, every `;` comment dropped. Its quotes need no shell escaping, and
424 a cost that does not parse refuses at its line and byte in that file. No
425 node lives under `fits/`, and `lint` reads nothing there. `--vary` and the
426 other flags stay on the command line:
427 ; Models: the lead's bands against the bench crop | Neglects: pitch | IO: (cutoff) -> cost | Tags: fit
428 norm(repr.bands(@lead([0, 5.083291666666667s]))
429 - load_json("../crop.json", ".readings.bands"))
430
431 `--vary <name>=<lo>..<hi>[/<step>][,log]`, once per variable, names a file
432 `variables/<name>` holding one number and the box it moves in, both bounds in
433 one unit: none, `hz`, `khz`, `s`, `ms`, `db`, `ct` or `st`. The search starts
434 at the file's value read in that unit (`0.5` is `-6.02db` under `db` bounds).
435 `/<step>` is the first step and the grid values land on, counted from `<lo>`;
436 without it the first step is a quarter of the bounds' span. `,log` moves it on
437 a log scale, where `/<step>` is the ratio a step multiplies by, a bare number
438 above 1, as `/1.25`. A name with no file, a file holding no number in that
439 unit, and a variable no target of the cost reads each refuse before the first
440 render. `--set <name>=<text>` holds a variable at `<text>`, as render takes
441 it; a name both set and varied refuses.
442
443 The search is a deterministic compass search: from its best point it renders
444 each variable one step up and one down, in the order the `--vary`s are
445 written, and moves to the best of them that improves; where none does, every
446 step halves. A point already rendered is not rendered again. One render
447 renders every target of the cost once, through render's own path, and takes
448 every reading. A target no variable reaches, such as the reference, is read
449 back from the store on every render after its first, and `trace` shows it
450 computing no samples. A solve stops `converged` once every step is under
451 `--step-tol` of its first step or the cost is at most `--cost-tol`, `budget`
452 after `--max-renders` renders, and `cancelled` on SIGINT or SIGTERM. The
453 budget is a result, warned as `solve.budget`, not an error. Each render
454 prints one JSON line on stderr:
455 {{"render": 3, "values": {{"gain": "0.4"}}, "cost": 1.25, "best": 0.98}}
456
457 `--write` writes each fitted value to its `variables/` file, its comment line
458 kept. A file it would change refuses as `conflict` unless `--confirm` is
459 written too; that refusal still carries the fit, and `would_write`, nothing
460 written. A cancelled solve writes nothing.
461
462 Its `data`:
463 {{"cost_expression": "...", "values": {{"gain": {{"value": 0.5, "text": "0.5",
464 "unit": "", "start": "0.3", "on_bound": false}}}}, "cost": {{"total": 0.09,
465 "terms": {{"items": [{{"term": "norm(...)", "value": 0.08}}], ...}}}},
466 "renders": 49, "stopped_by": "converged", "resampled": {{"items": []}},
467 "trace": {{"items": [{{"render": 1, "values": {{"gain": {{"value": 0.3,
468 "text": "0.3"}}}}, "cost": 52.1, "computed_samples": {{"@tone": 44100,
469 "sample(\"../ref.wav\")": 44101}}}}]}}}}
470 `values` is the best point, each `text` as `--set` and a file take it; `cost`
471 its total and each top-level `+` or `-` term's signed share; `trace` every
472 render in order. A value `on_bound` sat on a bound, warned as
473 `solve.on_bound`: widen it, or the model lacks what the reference holds.
474 `--write` adds `written`, each path with its `from` and `to`. Stopped by a
475 signal, the answer is the error `cancelled`, exit 130, its `data` the best so
476 far.
477
478ANALYZE:
479 sva-cli analyze <file> --representation <list> [--confirm]
480
481 Runs the same readings over a whole recording at its own rate, never
482 resampled. It reads these formats:
483 {formats}
484 `.wav` is read exactly as written; the rest decode in sva-cli itself, an
485 MP4's encoder delay and padding trimmed as its edit list states (a bare
486 `.aac` keeps them). A lossy decode may differ slightly from a browser's
487 decoding of the same file, so its readings may differ slightly from a page's
488 readings of it. Any other format, or a file that does not decode, refuses
489 as `{unreadable}`, naming the formats it reads. Only the readings a
490 buffer answers alone apply, each listed under REPRESENTATIONS as `measured` or
491 `exact off a closed form, measured off samples`; the rest need the graph
492 behind it. Each reading states its `representation` and `args` as
493 `render`'s do, a time in seconds.
494
495LINT:
496 sva-cli lint ['<expression>'] [--format <json|text>] [--body-chars <n>]
497
498 Checks the current directory without rendering a sample. With no target it
499 checks every file under its own rules, and types every entry point, which
500 types every file it reaches. With a target, in render's grammar, it checks
501 the files that target reaches, and prints the interval a render of it reads.
502 Either refuses a type error as `render` does.
503
504 A score's annotation is its doc comment, under the same codes, and its lines
505 no body, so the length checks pass it by; a file of two or more lines that is
506 neither a score nor a scale refuses as `multiline-body` before any check
507 runs. Each song lint types prints its warnings beside the findings.
508
509 Every check prints one `data.diagnostics` item. `warning` exits 0, `error`
510 exits non-zero, so branch on the verdict and never on whether the array is
511 empty. No flag downgrades an error.
512
513 error missing-comment no `;` comment line
514 multiline-comment more than one
515 malformed-comment not four ` | ` fields, `Models:` `Neglects:`
516 `IO: <in> -> <out>` `Tags: <tag>[, <tag>...]`
517 long-comment-block a `;` block over 1000 characters, the line-1
518 doc comment's own run exempted
519 long-expression-body a body over `--body-chars` characters, a
520 backstop rather than a complexity budget; a
521 knot table's literals, its data, count none
522 literal-sample-rate a written rate where `sp` belongs
523 arity a builtin called without an argument it reads,
524 or with one it does not, as `rand(seed=k)`
525 warning key-is-not-a-pitch `variables/key` holds neither a note name nor
526 a number of hertz
527 parameter-has-no-default
528 a node reads a parameter no `name = value` line
529 binds, so a bare `@node` cannot play
530 support-never-ends a node's support, cut where its bound falls
531 under the silence threshold, has no end for a
532 bare render to stop at
533
534TRACE:
535 sva-cli trace <node|expression>
536
537 Prints one node's position without rendering audio: what it reads (`down`, one
538 hop), everything that reads it (`up`, transitively to an entry point), each
539 beside the expression doing the reading, the node that made it discrete, and
540 the feedback loop it sits in, if any. A score is shown as its line count, its
541 first and last `at` and the nodes it plays, never the sum it lowers to; every
542 entry point's song is lowered first, each at song time 0. An interval the
543 target reads is ignored.
544
545BUILTINS:
546 sva-cli builtins
547
548 Prints the whole callable and syntactic vocabulary: every builtin with its
549 arity and named arguments, each argument's `meaning`, `unit`, the model
550 `part` it sets and whether it `moves` with `t` (a filter's cutoff, q and gain;
551 every other named argument is one number, refused when it names none), each
552 positional's meaning where the model states one, unit suffixes, the note-name
553 grammar, the scales `variables/scale` may name with their cents, reserved
554 identifiers, special call shapes, and what has no operator at all.
555
556OUTLINE:
557 sva-cli outline <expression>
558
559 Prints the parse tree the engine builds from one expression, each node with
560 the byte `span` it was written in: calls by `name` with positional and named
561 `args`, operators by `op`, refs by `path` with their `binds`, refs and `self`
562 by how they `read`, `time` or `index`, literals by `value` and `unit`, names
563 by `name`. A node the parser supplies itself, the `0` of a prefix minus or the
564 `t` of a bare `@ref`, has `written: false`. Reads no composition. Score text,
565 JSON opening with `{{`, prints `score` instead of `outline`: one item per item
566 a line lists, with its `kind`, `line`, `span`, `at` with marks resolved, and
567 its `node`, `deg`, `args`, `mark` or `lane`, `to`, `len` and `shape`.
568
569 sva-cli outline @score/song
570
571 Run in a composition, outlines that score as the song a render of it is:
572 `marks` in bars and seconds, the `tempo` curve's pieces, each lane with its
573 home and every move resolved with its placement chain, how many instances it
574 reaches and how many see it move, and each placed event once, however many
575 reads reach it: its song time `at` (where it reads lanes, key and scale), when
576 it first `sounds` (later by the least, over the reads reaching it, of the
577 delays of the `t - d` reads of a score above it), its `len` in song time where
578 its line writes one, node, pitch in hertz and where each parameter comes from
579 (`line`, `lane` or `default`), and the `size`: placed events and the engine's
580 instances beside its limit.
581
582NEW:
583 sva-cli new <name> [--idempotency-key <key>]
584
585 Writes a starter composition at ./<name>, and refuses if that directory
586 exists. `--idempotency-key <key>` records the key beside the composition, so a
587 retry under the same key succeeds identically while the tree still holds what
588 was written. Any other key, or an edited tree, refuses.
589
590EXAMPLES:
591 sva-cli new song1 && cd song1
592 sva-cli render '@master' --representation samples=/tmp/song1.wav
593 sva-cli render '@master([0, 8b])' --representation 'ledger(depth=2),loudness'
594 sva-cli render '@voice/note([0, inf), f0=C4, len=2s)' \
595 --until 'envelope(t) < -60db and t > 1s' --representation samples=/tmp/note.wav
596 sva-cli render 'sample(@chord/home)' --representation 'spectrum(peaks=8)' --rate 48000
597 sva-cli render 'sample(@voice/note([0, 2s], f0=C4))' --representation pitch
598 sva-cli render '@master' --set key=G3 --set bpm=140 --set scale=dorian \
599 --representation samples=/tmp/song1-g.wav
600 sva-cli render '@master' \
601 --representation 'samples(buffer=100ms)=alsa:default,loudness'
602 sva-cli solve 'norm(repr.bands(@master([0, 4s])) - repr.bands(sample("../ref.wav")))
603 + 0.5*norm(repr.loudness(@master([0, 4s])) - repr.loudness(sample("../ref.wav")))' \
604 --vary gain=0..2/0.25 --vary cutoff=200hz..8000hz/1.25,log --rate 48000
605 sva-cli solve 'sum(abs(repr.onsets(@score/song([0, 8s]))
606 - repr.onsets(sample("/tmp/take.wav"))))' \
607 --vary bpm=100..140/2 --set key=D3 --max-renders 60 --write --confirm
608 sva-cli solve 'norm(repr.pitch(@lead([0, 2s])) - load_json("../ref.json", ".data"))' \
609 --vary detune=-50ct..50ct/10ct
610 sva-cli solve @fits/lead --vary cutoff=200hz..8000hz/1.25,log --rate 48000
611 sva-cli lint
612 sva-cli lint '@master'
613 sva-cli trace score/phrase
614 sva-cli outline @score/phrase
615 sva-cli builtins
616
617OUTPUT:
618 {{"status": "success", "data": {{"target": "@master([0, 8b])", "sample_rate":
619 {DEFAULT_SAMPLE_RATE}, "bits": {bits}, "profile": "psychoacoustic-v1",
620 "interval": {{"start_secs":
621 0, "end_secs": 16}}, "label": {{...}}, "written": {{"items": [...]}},
622 "representations": {{"ledger": {{...}}}}, "diagnostics": {{"items": []}}}},
623 "meta": {{"request_id": "req_...", "timestamp": 1700000000}}}}
624
625 `interval` is null where no reading read samples. An error adds "error":
626 {{"code", "message", "details": {{"count", "codes"}}}}. Success or error,
627 every response carries every finding in full at "data": {{"diagnostics":
628 {{"items": [{{"code", "severity", "message", "location", "help"}}],
629 "pagination": {{"count", "has_more", "next_cursor"}}}}}}, empty where it found
630 none.
631
632 Every collection carries that same {{items, pagination}} pair. `count` is the
633 whole reading's, `has_more` says `items` holds less than that, and
634 `next_cursor` is the interval start, as `0.5s`, the rest is read from. A
635 reading written to a file is written whole, uncapped. This page is an
636 envelope of its own, at "data": {{"help"}}.
637
638DEFAULTS:
639 --rate <hz> the one rate a render samples at, and `1sp`.
640 Default {DEFAULT_SAMPLE_RATE}.
641 --bits <n> the precision every sample is written to. Default {bits},
642 the `psychoacoustic-v1` profile's own.
643 ledger(depth=<n>) how deep below its target a `ledger` walks.
644 Default {DEFAULT_LEDGER_DEPTH}.
645 (peaks=<n>) peaks a `spectrum` keeps, notes a `pitch`, formants a
646 `formants`, stripes and novelty peaks a `self_similarity`
647 lists per view. Default {DEFAULT_MAX_PEAKS}.
648 alias(oversample=<n>) the multiple `alias` re-renders at to hear what folded.
649 Default {DEFAULT_OVERSAMPLE}.
650 (frame=<t>) the step a framed reading advances by, in seconds.
651 Default {DEFAULT_FRAME_SECS}, except `spectrum`, which sizes
652 its own transform to the range unless it is set.
653 (floor=<db>) the amplitude, as `-40db`, under which a harmonic reading
654 or `self_similarity` drops a partial, and under which
655 `self_similarity` counts a band level as zero.
656 Default {DEFAULT_FLOOR_DB}db.
657 voice_leading(norm=<l1|l2>) how a voice leading's moves add up. Default l1.
658 dissonance(pairs=<n>) the most partial pairs one frame sums before it refuses.
659 Default {DEFAULT_MAX_PAIRS}.
660 loudness(window=<t>) the length of one momentary block, in seconds, each a
661 quarter of one after the last, the integrated loudness
662 gated over them; both are whole samples, at least 4 in
663 a block, and the reading states them as `momentary_secs`
664 and `hop_secs`. A window under the default reads a sound
665 shorter than the default, whose integrated is null there.
666 Default {DEFAULT_LOUDNESS_WINDOW_SECS}.
667 periodicity(window=<t>) the span of onset strength one window autocorrelates,
668 in seconds, at least twice the shortest period it reads;
669 it reads periods up to half its span.
670 Default {DEFAULT_PERIODICITY_WINDOW_SECS}.
671 periodicity(curve=<0|1>) `1` adds every window's height at every lag.
672 Default 0.
673 modulation(window=<t>) the span of band envelope one window transforms, in
674 seconds, at least twice the fastest rate's period; it
675 reads rates down to two periods per span.
676 Default {DEFAULT_MODULATION_WINDOW_SECS}.
677 modulation(bpm=<n>) a tempo, as `140`, adding each rate's period in beats.
678 Default none.
679 self_similarity(cell=<t>) the side of one matrix cell, in seconds, a whole
680 number of frames holding a sample of the band
681 envelopes; the target may span at most
682 {MAX_CELLS} cells. Default {DEFAULT_CELL_SECS}.
683 self_similarity(smooth=<t>) the length each diagonal is averaged over
684 before stripes are picked, in seconds.
685 Default {DEFAULT_SMOOTH_SECS}.
686 self_similarity(window=<t>) the whole width of the novelty kernel, in
687 seconds, at most {MAX_CELLS} cells a side.
688 Default {DEFAULT_NOVELTY_WINDOW_SECS}.
689 self_similarity(curve=<0|1>) `1` adds every cell's chroma and band levels and
690 each view's matrix. Default 0.
691 bindings(node=@<path>) the instance whose bindings are read; required. An
692 instance is named exactly as the render spells it; any
693 other spelling refuses, listing its file's instances.
694 samples(buffer=<t>) how much an `alsa:` device holds ahead of what it plays,
695 in seconds. Default {DEFAULT_BUFFER_SECS}; only a device
696 has one.
697 ledger(brief, skim) `0` unless set `1`.
698 --format <json|text> how `lint` prints its findings: the envelope, or one
699 terminal line each, colored where stdout is a terminal.
700 The same objects either way. Default json.
701 --body-chars <n> the most characters a body's expression holds before
702 `long-expression-body` refuses it, a knot table's literals
703 apart. Default {body_chars}.
704 --cache <path|none> where the store lives. Default `$XDG_CACHE_HOME/sva`, else
705 `~/.cache/sva`, holding at most {store_gb} GB; `none` keeps
706 no store. A store that fails fails no render: it answers
707 as without one, warned why in `diagnostics`.
708 --set <name>=<text> a variable read as `<text>` for this render, or held for
709 a solve. Default none: each is read off its file.
710 --max-renders <n> the most renders a solve takes. Default {max_renders}.
711 --step-tol <x> the fraction of each variable's first step under which a
712 solve's search stops. Default {step_tol}.
713 --cost-tol <x> the cost at or under which a solve stops. Default {cost_tol}.
714 --write a solve writes its fitted values to their `variables/`
715 files, with `--confirm`. Default off.
716 --confirm replaces a destination that already holds a file. Without
717 it a path already taken refuses as `conflict` and nothing
718 is written.
719
720ENVIRONMENT:
721 SVA_LOG=debug `render` logs, once it ends, what it asked of each value
722 to stderr; stdout and the samples are unchanged. Any
723 other value, or none, logs nothing. One line per second
724 of output, then one per node and a total:
725 sva-cache pass hit=0 miss=190 ... reused=0 cum-hit=0.0%
726 sva-cache t=1.022s hit=1 miss=2 ... cum-hit=0.5%
727 sva-cache node hit=1 miss=0 ... reused=3 <node>
728 sva-cache total hit=1 miss=198 ... hit-rate=0.5% ...
729 `pass` is what was looked up before the first block.
730 Each value is looked up once: a `hit` was answered by
731 the store, `prefix` found a stored run up to a switch,
732 `miss` computed it, `new` held it in memory, where the
733 store takes what it keeps from. Each read of a value
734 past its first is `reused`.
735
736EXIT CODES:
737 0 success (error.code absent)
738 1 internal_error (a destination could not be written)
739 3 validation_error (bad arguments, a composition that failed to parse, or a
740 render the engine refused)
741 4 conflict (a name `new` would overwrite, a destination already holding a
742 file, or a variable file `solve --write` would change, without `--confirm`)
743 24 not_found (a `.wav` file, a `sample("<path>")` naming no file, or a node
744 this composition does not define)
745 130 cancelled (a solve stopped by SIGINT or SIGTERM, `data` the best so far)
746
747VERB ALIASES:
748 validate = lint, list = builtins, create = new, show = trace, from the `cli`
749 standard's own verb list. `render` and `analyze` take a reading, which that
750 list has no word for, so they keep their own names.
751
752SEE ALSO:
753 sva-cli --version Show version information"#
754 )
755}
756
757fn solve_rules() -> String {
759 let mut out = Vec::new();
760 for (name, rule) in solve::RULES {
761 let mut line = format!(" {name:<10}");
762 if name.len() >= 10 {
763 out.push(line);
764 line = " ".repeat(14);
765 }
766 for word in rule.split(' ') {
767 if line.len() + 1 + word.len() > 80 {
768 out.push(line);
769 line = " ".repeat(15);
770 } else {
771 line.push(' ');
772 }
773 line.push_str(word);
774 }
775 out.push(line);
776 }
777 out.join("\n")
778}
779
780fn representations() -> String {
782 READINGS
783 .iter()
784 .map(|row| {
785 let keys: Vec<&str> = row.takes.iter().map(|arg| arg.key()).collect();
786 let call = match keys[..] {
787 [] => row.name.to_string(),
788 _ => format!("{}({})", row.name, keys.join(", ")),
789 };
790 let source = match row.reads {
791 Reads::ClosedForm | Reads::Structure => "exact",
792 Reads::Either => "exact off a closed form, measured off samples",
793 Reads::Samples => "measured",
794 Reads::Graph => "measured, and the graph behind the samples",
795 };
796 format!(" {call:<26} {source}\n {}", row.help)
797 })
798 .collect::<Vec<_>>()
799 .join("\n")
800}