sim-lib-music-serial 0.1.1

Immutable serial plans with stable row and event identity, explicit provenance, and validated partial temporal order.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

//! Open serial realizer registry.

use std::collections::BTreeMap;
use std::sync::Arc;

use crate::{
    ChromaticSerialRealizer, MarkedChromaticInflectionRealizer, ModalDegreeCycleRealizer,
    NearestScaleToneRealizer, NonPitchSpineRealizer, RealizationContext, RealizerId, SerialPlan,
    SerialRealization, SerialRealizer, StrictRealizationError,
};

/// Id-addressed registry of serial realizers with stable sorted listing.
#[derive(Clone, Default)]
pub struct SerialRealizerRegistry {
    entries: BTreeMap<RealizerId, Arc<dyn SerialRealizer>>,
}

impl SerialRealizerRegistry {
    /// Creates an empty registry.
    pub fn new() -> Self {
        Self::default()
    }

    /// Inserts one realizer, rejecting duplicate ids unless the caller uses `replace`.
    pub fn register(&mut self, realizer: Arc<dyn SerialRealizer>) -> Result<(), RealizerId> {
        if self.entries.contains_key(realizer.id()) {
            return Err(realizer.id().clone());
        }
        self.entries.insert(realizer.id().clone(), realizer);
        Ok(())
    }

    /// Inserts one realizer and returns the replaced registration, if any.
    pub fn replace(
        &mut self,
        realizer: Arc<dyn SerialRealizer>,
    ) -> Option<Arc<dyn SerialRealizer>> {
        self.entries.insert(realizer.id().clone(), realizer)
    }

    /// Returns one registered realizer by id.
    pub fn get(&self, id: &RealizerId) -> Option<&Arc<dyn SerialRealizer>> {
        self.entries.get(id)
    }

    /// Returns all registered ids in stable sorted order.
    pub fn ids(&self) -> Vec<RealizerId> {
        self.entries.keys().cloned().collect()
    }

    /// Realizes one plan through the registered realizer named by `id`.
    pub fn realize(
        &self,
        id: &RealizerId,
        plan: &SerialPlan,
        context: &RealizationContext,
    ) -> Result<SerialRealization, StrictRealizationError> {
        let Some(realizer) = self.get(id) else {
            return Err(StrictRealizationError::UnknownRealizer(id.clone()));
        };
        realizer.realize(plan, context)
    }

    /// Realizes one plan through the registered realizer named by a stable string id.
    pub fn realize_named(
        &self,
        id: &str,
        plan: &SerialPlan,
        context: &RealizationContext,
    ) -> Result<SerialRealization, StrictRealizationError> {
        let id = RealizerId::new(id)
            .map_err(|error| StrictRealizationError::PitchMap(error.to_string()))?;
        self.realize(&id, plan, context)
    }
}

/// Returns the built-in registry with the strict chromatic realizer installed.
pub fn default_realizer_registry() -> SerialRealizerRegistry {
    let mut registry = SerialRealizerRegistry::new();
    registry.replace(Arc::new(ChromaticSerialRealizer::default()));
    registry.replace(Arc::new(ModalDegreeCycleRealizer::default()));
    registry.replace(Arc::new(NearestScaleToneRealizer::default()));
    registry.replace(Arc::new(MarkedChromaticInflectionRealizer::default()));
    registry.replace(Arc::new(NonPitchSpineRealizer::default()));
    registry
}