Skip to main content

qualia_core_db/audio/qac/profiles/
registry.rs

1//! Comprehensive `DomainRegistry` implementation covering QAC v1 schemas 200–210.
2//!
3//! Bridges the metadata admission gap left by `audio/qac/metadata/registry.rs`
4//! (which only implements schemas 201, 202, 205, 210 and omits `descriptor_target_schema(4)`).
5//! All unit validation, schema field rules, reference schema targets, and medium/model invariants
6//! are enforced fail-closed during `q42::field_semantics::admit_shared`.
7
8use crate::q42::{
9    field_envelope::{Block, Field},
10    field_semantics as sem,
11};
12
13use super::types::{gcd_u64, has_control_chars, MAX_CLOCK_DEN, MAX_CLOCK_NUM};
14
15#[path = "registry_helpers.rs"]
16mod registry_helpers;
17use registry_helpers::*;
18
19const fn r(key: u16, type_tag: u8, count: Option<u32>, required: bool) -> sem::FieldRule {
20    sem::FieldRule {
21        key,
22        type_tag,
23        count,
24        required,
25    }
26}
27
28// Schema 200: Medium
29const S200: &[sem::FieldRule] = &[
30    r(1, 6, None, true),      // model
31    r(2, 5, Some(1), false),  // density_kg_m3
32    r(3, 5, Some(1), false),  // bulk_modulus_pa
33    r(4, 5, Some(1), false),  // shear_modulus_pa
34    r(5, 5, Some(1), false),  // temperature_k
35    r(6, 5, Some(1), false),  // ambient_pressure_pa
36    r(7, 5, Some(3), false),  // flow_m_s
37    r(8, 7, Some(32), false), // matter_digest
38    r(9, 7, Some(32), false), // material_table_digest
39    r(10, 2, Some(1), false), // material_table_epoch
40    r(11, 2, None, false),    // material_ids
41    r(12, 8, Some(1), false), // constitutive_extension
42    r(13, 9, Some(1), false), // domain_mask
43];
44
45// Schema 201: Transform
46const S201: &[sem::FieldRule] = &[
47    r(1, 6, None, true),     // kind
48    r(2, 1, Some(1), false), // fft_size
49    r(3, 1, Some(1), false), // hop_samples
50    r(4, 6, None, false),    // window_name
51    r(5, 9, Some(1), false), // window_coefficients
52    r(6, 6, None, false),    // normalization
53    r(7, 1, Some(1), false), // one_sided
54    r(8, 9, Some(1), false), // bin_centers_hz
55    r(9, 6, None, false),    // phase_convention
56    r(10, 3, Some(1), false),// frame_origin_samples
57    r(11, 6, None, false),   // padding_policy
58    r(12, 6, None, false),   // channel_order
59    r(13, 1, Some(1), true), // bins
60    r(14, 2, Some(1), false),// input_sample_rate_num
61    r(15, 2, Some(1), false),// input_sample_rate_den
62    r(16, 4, None, false),   // window_coefficients_inline
63    r(17, 6, None, false),   // origin_basis
64];
65
66// Schema 202: Calibration
67const S202: &[sem::FieldRule] = &[
68    r(1, 6, None, true),      // input_quantity
69    r(2, 6, None, true),      // output_units
70    r(3, 5, Some(1), true),   // scale
71    r(4, 5, Some(1), true),   // offset
72    r(5, 5, Some(1), false),  // reference_pressure_pa
73    r(6, 9, Some(1), false),  // response
74    r(7, 9, Some(1), false),  // uncertainty
75    r(8, 7, Some(32), false), // calibration_digest
76    r(9, 8, Some(1), false),  // valid_from (Schema 5)
77    r(10, 8, Some(1), false), // valid_until (Schema 5)
78];
79
80// Schema 203: FilterbankFeatures
81const S203: &[sem::FieldRule] = &[
82    r(1, 6, None, true),     // algorithm_URI
83    r(2, 6, None, true),     // algorithm_version
84    r(3, 1, Some(1), true),  // bands
85    r(4, 6, None, true),     // scale
86    r(5, 9, Some(1), false), // centers_hz
87    r(6, 9, Some(1), false), // coefficients
88    r(7, 8, Some(1), false), // window
89    r(8, 5, Some(1), false), // reference_pressure_pa
90    r(9, 9, Some(1), false), // channel_weights
91    r(10, 6, None, false),   // gating_profile
92    r(11, 6, None, false),   // feature_names
93];
94
95// Schema 204: SpatialHrir
96const S204: &[sem::FieldRule] = &[
97    r(1, 6, None, true),     // representation ('HOA', 'HRIR', 'RIR')
98    r(2, 1, Some(1), false), // hoa_order
99    r(3, 6, None, false),    // hoa_ordering
100    r(4, 6, None, false),    // normalization
101    r(5, 9, Some(1), false), // receiver_positions
102    r(6, 9, Some(1), false), // source_positions
103    r(7, 9, Some(1), false), // delays_samples
104    r(8, 1, Some(1), false), // taps
105    r(9, 1, Some(1), false), // receivers
106    r(10, 1, Some(1), false),// measurements
107    r(11, 9, Some(1), false),// sofa_original
108    r(12, 6, None, false),   // sofa_convention
109    r(13, 8, Some(1), false),// listener_frame (Schema 2)
110    r(14, 9, Some(1), false),// pose_times
111    r(15, 9, Some(1), false),// RT60_bands_s
112    r(16, 9, Some(1), false),// portal_metadata
113    r(17, 2, Some(1), false),// impulse_sample_rate_num
114    r(18, 2, Some(1), false),// impulse_sample_rate_den
115    r(19, 6, None, false),   // delay_reference
116];
117
118// Schema 205: ModelGrid
119const S205: &[sem::FieldRule] = &[
120    r(1, 6, None, true),     // model_URI
121    r(2, 6, None, true),     // model_version
122    r(3, 6, None, false),    // discretization
123    r(4, 5, None, false),    // component_offsets_xyz
124    r(5, 3, None, false),    // component_time_offset_num
125    r(6, 9, Some(1), false), // boundary_conditions
126    r(7, 9, Some(1), false), // source_terms
127    r(8, 9, Some(1), false), // internal_state
128    r(9, 9, Some(1), false), // constitutive_state
129    r(10, 2, Some(1), false),// timestep_num
130    r(11, 2, Some(1), false),// timestep_den
131    r(12, 5, Some(1), false),// tolerance_abs
132    r(13, 5, Some(1), false),// tolerance_rel
133    r(14, 2, None, true),    // tensor_shape
134    r(15, 6, None, true),    // component_names
135    r(16, 2, None, false),   // component_time_offset_den
136];
137
138// Schema 206: RayModal
139const S206: &[sem::FieldRule] = &[
140    r(1, 6, None, true),      // kind
141    r(2, 9, Some(1), false),  // band_centers_hz
142    r(3, 6, None, false),     // gain_quantity
143    r(4, 5, Some(1), false),  // reference_distance_m
144    r(5, 8, Some(1), false),  // launch_time (Schema 5)
145    r(6, 7, Some(32), false), // geometry_digest
146    r(7, 7, Some(32), false), // material_digest
147    r(8, 9, Some(1), false),  // excitation
148    r(9, 9, Some(1), false),  // mode_shapes
149    r(10, 6, None, false),    // diffraction_model
150    r(11, 9, Some(1), false), // ray_weights
151    r(12, 9, Some(1), false), // band_values
152];
153
154// Schema 207: Haptic
155const S207: &[sem::FieldRule] = &[
156    r(1, 6, None, true),      // role
157    r(2, 8, Some(1), true),   // contact_frame (Schema 2)
158    r(3, 5, Some(1), false),  // contact_area_m2
159    r(4, 6, None, false),     // receptor_model_URI
160    r(5, 7, Some(32), false), // device_profile_digest
161    r(6, 7, Some(32), false), // authority_receipt_digest
162    r(7, 8, Some(1), false),  // command_expiry (Schema 5)
163    r(8, 8, Some(1), false),  // calibration (Schema 202)
164    r(9, 9, Some(1), false),  // estimated_receptor_output
165];
166
167// Schema 208: UltrasoundAcquisition
168const S208: &[sem::FieldRule] = &[
169    r(1, 6, None, true),      // role
170    r(2, 5, Some(1), false),  // center_frequency_hz
171    r(3, 9, Some(1), false),  // element_positions
172    r(4, 9, Some(1), false),  // channel_map
173    r(5, 9, Some(1), false),  // transmit_delays_s
174    r(6, 5, Some(1), false),  // demodulation_phase_rad
175    r(7, 2, Some(1), false),  // PRF_num
176    r(8, 2, Some(1), false),  // PRF_den
177    r(9, 9, Some(1), false),  // pulse_definition
178    r(10, 6, None, false),    // derating_model_URI
179    r(11, 6, None, false),    // exposure_context
180    r(12, 6, None, false),    // thermal_model_URI
181    r(13, 9, Some(1), false), // uncertainty
182    r(14, 7, Some(32), false),// instrument_digest
183    r(15, 7, Some(32), false),// authority_receipt_digest
184    r(16, 8, Some(1), false), // target_frame (Schema 2)
185    r(17, 9, Some(1), false), // raw_source
186];
187
188// Schema 209: LegacyRetention
189const S209: &[sem::FieldRule] = &[
190    r(1, 6, None, true),     // original_family ('Q4AU')
191    r(2, 1, Some(1), true),  // original_version (1..=3)
192    r(3, 9, Some(1), true),  // original_bytes (mode 0x0104)
193    r(4, 7, Some(32), true), // original_digest
194    r(5, 6, None, true),     // migration_algorithm
195    r(6, 6, None, true),     // migration_version
196    r(7, 6, None, false),    // interpreted_fields
197    r(8, 6, None, false),    // unknown_fields
198];
199
200// Schema 210: SignalEncoding
201const S210: &[sem::FieldRule] = &[
202    r(1, 6, None, true),    // channel_order
203    r(2, 5, Some(1), true), // units_per_stored_sample
204    r(3, 5, Some(1), true), // stored_offset
205    r(4, 6, None, true),    // purpose
206    r(5, 6, None, true),    // relation
207];
208
209/// Full QAC v1 schema registry for all acoustic/continuum/spatial/modal/perceptual/haptic/ultrasound profiles.
210#[derive(Debug, Default, Clone, Copy)]
211pub struct QacProfileRegistry;
212
213impl sem::DomainRegistry for QacProfileRegistry {
214    fn rules(&self, schema: u16, revision: u16) -> Option<&'static [sem::FieldRule]> {
215        if revision != 1 {
216            return None;
217        }
218        match schema {
219            200 => Some(S200),
220            201 => Some(S201),
221            202 => Some(S202),
222            203 => Some(S203),
223            204 => Some(S204),
224            205 => Some(S205),
225            206 => Some(S206),
226            207 => Some(S207),
227            208 => Some(S208),
228            209 => Some(S209),
229            210 => Some(S210),
230            _ => None,
231        }
232    }
233
234    fn descriptor_target_schema(&self, key: u16) -> Option<u16> {
235        match key {
236            4 => Some(200),
237            5 => Some(201),
238            6 => Some(202),
239            _ => None,
240        }
241    }
242
243    fn validate_units(&self, units: &str, _ctx: &sem::Context<'_, '_>) -> Result<(), sem::Error> {
244        if has_control_chars(units) {
245            return Err(sem::Error::Value);
246        }
247        match units {
248            "Pa"
249            | "m/s"
250            | "Pa*m/s"
251            | "W/m^2"
252            | "W m^-2"
253            | "W/m2"
254            | "J/m^3"
255            | "J/m3"
256            | "N"
257            | "N*m"
258            | "m"
259            | "m^2"
260            | "Hz"
261            | "s"
262            | "1"
263            | "dB-SPL"
264            | "sone"
265            | "LUFS"
266            | "mel"
267            | "Pa/Pa"
268            | "raw_counts"
269            | "mixed:mode-registry"
270            | "complex_digital_spectrum"
271            | "complex_pressure_spectrum" => Ok(()),
272            _ => Err(sem::Error::Value),
273        }
274    }
275
276    fn validate_block(
277        &self,
278        block: Block<'_>,
279        ctx: &sem::Context<'_, '_>,
280    ) -> Result<(), sem::Error> {
281        match block.schema_type() {
282            200 => validate_medium(block, ctx),
283            201 => validate_transform(block),
284            202 => validate_calibration(block, ctx),
285            203 => validate_filterbank(block),
286            204 => validate_spatial_hrir(block, ctx),
287            205 => validate_model_grid(block),
288            206 => validate_ray_modal(block, ctx),
289            207 => validate_haptic(block, ctx),
290            208 => validate_ultrasound(block, ctx),
291            209 => validate_legacy_retention(block, ctx),
292            210 => validate_signal_encoding(block),
293            _ => Ok(()),
294        }
295    }
296}
297
298// ---------------------------------------------------------------------------
299// Schema block helpers & validators
300// ---------------------------------------------------------------------------
301
302pub(crate) fn field<'a>(block: Block<'a>, key: u16) -> Option<Field<'a>> {
303    block.fields().find(|f| f.key() == key)
304}
305
306pub(crate) fn text_val<'a>(f: Field<'a>) -> Result<&'a str, sem::Error> {
307    let s = std::str::from_utf8(f.value()).map_err(|_| sem::Error::Value)?;
308    if has_control_chars(s) {
309        return Err(sem::Error::Value);
310    }
311    Ok(s)
312}
313
314pub(crate) fn u32_val(f: Field<'_>) -> Result<u32, sem::Error> {
315    let b = f.value();
316    if b.len() != 4 {
317        return Err(sem::Error::FieldType);
318    }
319    Ok(u32::from_le_bytes([b[0], b[1], b[2], b[3]]))
320}
321
322pub(crate) fn u64_val(f: Field<'_>) -> Result<u64, sem::Error> {
323    let b = f.value();
324    if b.len() != 8 {
325        return Err(sem::Error::FieldType);
326    }
327    Ok(u64::from_le_bytes([
328        b[0], b[1], b[2], b[3], b[4], b[5], b[6], b[7],
329    ]))
330}
331
332pub(crate) fn f64_val(f: Field<'_>) -> Result<f64, sem::Error> {
333    let b = f.value();
334    if b.len() != 8 {
335        return Err(sem::Error::FieldType);
336    }
337    let v = f64::from_le_bytes([b[0], b[1], b[2], b[3], b[4], b[5], b[6], b[7]]);
338    if !v.is_finite() {
339        return Err(sem::Error::Value);
340    }
341    Ok(v)
342}
343
344pub(crate) fn find_block_by_schema<'a>(
345    ctx: &sem::Context<'_, 'a>,
346    id: u32,
347    expected_schema: u16,
348) -> Result<Block<'a>, sem::Error> {
349    for b in ctx.blocks() {
350        let block = b?;
351        if block.id() == id {
352            if block.schema_type() != expected_schema {
353                return Err(sem::Error::ReferenceSchema);
354            }
355            return Ok(block);
356        }
357    }
358    Err(sem::Error::Reference)
359}
360
361pub(crate) fn validate_reduced_rate(num: u64, den: u64) -> Result<(), sem::Error> {
362    if num == 0 || den == 0 || gcd_u64(num, den) != 1 || num > MAX_CLOCK_NUM || den > MAX_CLOCK_DEN {
363        return Err(sem::Error::Time);
364    }
365    Ok(())
366}