sva_cli/
render.rs

1// Concern: runs one render or one file analysis and routes every reading it answered | Non-concern: argv (args/), the JSON shape (sva-core) | IO: (RenderArgs or AnalyzeArgs) -> JSON or CliError
2
3use std::path::Path;
4
5use sva_core::{
6    Answer, Asked, CliError, Destination, Diagnostic, Hear, Job, Output, Printed, Report,
7    SAMPLE_LIMIT, Session, Tier, cwd, execute_over, query_data,
8};
9use sva_engine::{Buffer, PSYCHOACOUSTIC_V1, answer_buffer, cache_log};
10
11use crate::args::{AnalyzeArgs, RenderArgs};
12use crate::destination::{Framing, refuse_inside, refuse_replacing, write};
13use crate::device::Hearing;
14use crate::directory::Directory;
15use crate::store::wait;
16use crate::wav::{SampleEncoding, read_channels};
17use sva_core::success_envelope;
18
19/// Only the nodes the target reaches are read; its interval and `--until` decide its range.
20pub fn render(args: &RenderArgs) -> Result<String, CliError> {
21    let here = crate::composition::composition()?;
22    let (dir, target) = crate::composition::located(&here, &args.target)?;
23    // Judged before the first is opened: a refusal on the last leaves none of them on disk.
24    for dest in args.asked.iter().filter_map(Asked::path) {
25        refuse_inside(&dir, dest)?;
26        refuse_replacing(dest, args.confirm)?;
27    }
28    let mut warnings = Vec::new();
29    let tier = crate::store::opened(&args.cache, &mut warnings)?;
30    let answered = answered(args, &dir, &target, tier, &mut warnings);
31    crate::store::persisted(tier, &mut warnings);
32    answered.map(|data| success_envelope(&data, &warnings))
33}
34
35/// The render's `data`.
36fn answered(
37    args: &RenderArgs,
38    dir: &Path,
39    target: &str,
40    tier: &Tier<Directory>,
41    warnings: &mut Vec<Diagnostic>,
42) -> Result<String, CliError> {
43    let files = sva_ast::Dir::at(dir);
44    let source = sva_core::overlaid(&files, &args.sets)?;
45    let logs = std::env::var("SVA_LOG").is_ok_and(|level| level == "debug");
46    let hearing = hearing(args)?;
47    let job = Job {
48        until: args.until.as_deref(),
49        rate: args.rate,
50        bits: args.bits,
51        asked: &args.asked,
52        threads: args.threads,
53        hear: hearing.as_ref().map(|hearing| hearing as &dyn Hear),
54        ..Job::over(&source, target)
55    };
56    let rendered = wait(execute_over(job, tier, &mut Session::default()));
57    let stopped = hearing.as_ref().and_then(Hearing::stopped);
58    let rendered = match (rendered, stopped) {
59        (_, Some(why)) => return Err(why),
60        (rendered, None) => rendered?,
61    };
62    let played = hearing.map(Hearing::finish).transpose()?;
63
64    let rate = rendered.config.rate;
65    let stats = rendered.render.cache_stats.as_ref();
66    if let Some(why) = stats.and_then(|stats| stats.unstaged.as_deref()) {
67        let message = format!("this render stopped writing what it computed: {why}");
68        warnings.push(crate::store::warning("store.unstaged", message));
69    }
70    if let (true, Some(stats)) = (logs, stats) {
71        eprint!("{}", cache_log(stats, rate));
72    }
73    let bits = rendered.config.profile.precision_bits;
74    let interval = rendered
75        .render
76        .range
77        .map(|r| (r.start_secs(rate), r.end as f64 / f64::from(rate)));
78    let framing = Framing {
79        target: args.target.clone(),
80        rate,
81        bits: Some(bits),
82        interval,
83        profile: rendered.config.profile.name,
84        encoding: SampleEncoding::of(bits),
85        replace: args.confirm,
86    };
87
88    let kept: Vec<&Asked> = args.asked.iter().filter(|a| !plays(a)).collect();
89    let mut taken = Vec::with_capacity(kept.len());
90    for asked in &kept {
91        let node = asked.node.as_deref().unwrap_or(&rendered.target);
92        let answer = rendered.answer(node, asked.representation)?;
93        taken.push(match asked.brief {
94            true => briefed(answer),
95            false => answer,
96        });
97    }
98    let (answers, written) = routed(&kept, taken, &framing)?;
99
100    Ok(query_data(&Report {
101        target: &args.target,
102        rate,
103        bits: Some(bits),
104        interval,
105        profile: rendered.config.profile.name,
106        label: rendered.label(),
107        written: &written,
108        played: played.as_ref(),
109        answers: &answers,
110        limit: Some(SAMPLE_LIMIT),
111    }))
112}
113
114fn plays(asked: &Asked) -> bool {
115    matches!(asked.dest, Some(Destination::Alsa { .. }))
116}
117
118/// The device the render's `samples` plays on, opened before the render so a missing player
119/// refuses before anything is computed.
120fn hearing(args: &RenderArgs) -> Result<Option<Hearing>, CliError> {
121    let alsa = args.asked.iter().find_map(|a| match &a.dest {
122        Some(Destination::Alsa {
123            device,
124            buffer_secs,
125        }) => Some((a.name.as_str(), device, *buffer_secs)),
126        _ => None,
127    });
128    let Some((name, device, buffer_secs)) = alsa else {
129        return Ok(None);
130    };
131    let encoding = SampleEncoding::of(sva_core::precision_bits(args.bits)?);
132    let named = (name, args.target.as_str());
133    Hearing::open(device, buffer_secs, encoding, named).map(Some)
134}
135
136/// What stays in the envelope, and what left it for a file.
137type Routed<'a> = (Vec<Printed>, Vec<(String, &'a Path)>);
138
139/// Every reading is taken before any file is opened, so a later refusal writes nothing. A
140/// reading a device played was heard as the render pulled it, and is none of these.
141fn routed<'a>(
142    asked: &[&'a Asked],
143    taken: Vec<Answer>,
144    framing: &Framing,
145) -> Result<Routed<'a>, CliError> {
146    let mut answers = Vec::new();
147    let mut written = Vec::new();
148    for (one, answer) in asked.iter().zip(taken) {
149        let printed = Printed {
150            name: one.name.clone(),
151            answer,
152            skim: one.skim,
153        };
154        match &one.dest {
155            None => answers.push(printed),
156            Some(Destination::File(dest)) => {
157                write(&printed, dest, framing)?;
158                written.push((one.name.clone(), dest.as_path()));
159            }
160            Some(Destination::Alsa { .. }) => {
161                unreachable!("a device heard its reading as it rendered")
162            }
163        }
164    }
165    Ok((answers, written))
166}
167
168/// `ledger(brief=1)`: a node that did not clip is not news, so a ledger keeps only the ones
169/// that did.
170fn briefed(answer: Answer) -> Answer {
171    let Output::Ledger(entries) = answer.value else {
172        return answer;
173    };
174    Answer {
175        value: Output::Ledger(
176            entries
177                .into_iter()
178                .filter(|e| e.clipped == Some(true))
179                .collect(),
180        ),
181        ..answer
182    }
183}
184
185/// The same routing over a decoded external WAV instead of a rendered graph: the file's own
186/// rate stands, and it is read whole.
187pub fn analyze(args: &AnalyzeArgs) -> Result<String, CliError> {
188    let dir = cwd()?;
189    let composition = is_composition(&dir);
190    for dest in args.asked.iter().filter_map(Asked::path) {
191        if composition {
192            refuse_inside(&dir, dest)?;
193        }
194        refuse_replacing(dest, args.confirm)?;
195    }
196    let (planes, rate) = read_channels(&args.path)?;
197    let target = args.path.display().to_string();
198    let held = Buffer::of_planes(
199        rate,
200        planes
201            .iter()
202            .map(|p| p.iter().map(|v| f64::from(*v)).collect())
203            .collect(),
204    );
205    crate::args::check_frame(&args.asked, rate)?;
206    let buffer = held;
207    let interval = Some((0.0, buffer.len() as f64 / f64::from(rate)));
208    let framing = Framing {
209        target: target.clone(),
210        rate,
211        bits: None,
212        interval,
213        profile: PSYCHOACOUSTIC_V1.name,
214        encoding: SampleEncoding::Float,
215        replace: args.confirm,
216    };
217
218    let mut taken = Vec::with_capacity(args.asked.len());
219    for asked in &args.asked {
220        taken.push(
221            answer_buffer(
222                &target,
223                &buffer,
224                asked.representation,
225                PSYCHOACOUSTIC_V1.name,
226            )
227            .map_err(CliError::Engine)?,
228        );
229    }
230    let (answers, written) = routed(&args.asked.iter().collect::<Vec<_>>(), taken, &framing)?;
231    Ok(success_envelope(
232        &query_data(&Report {
233            target: &target,
234            rate,
235            bits: None,
236            interval,
237            profile: PSYCHOACOUSTIC_V1.name,
238            label: None,
239            written: &written,
240            played: None,
241            answers: &answers,
242            limit: Some(SAMPLE_LIMIT),
243        }),
244        &[],
245    ))
246}
247
248/// Whether the next parse would walk this directory, not whether it parses cleanly today.
249fn is_composition(dir: &Path) -> bool {
250    dir.join(sva_core::ROOT).is_file() || dir.join(sva_ast::VARIABLES).is_dir()
251}
sva_cli/render.rs

sva_cli/
render.rs
