sim-lib-music-transform 0.1.4

Pitch, time, pattern, and diagnostic transforms over canonical SIM music objects.
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

use sim_lib_music_core::{Music, MusicObject};

use crate::{PatternMutatorConfig, TransformError};

/// Player that applies a [`PatternMutatorConfig`] to incoming material.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct PatternMutatorPlayer {
    /// Mutator configuration this player applies.
    pub config: PatternMutatorConfig,
}

impl PatternMutatorPlayer {
    /// Wraps a mutator configuration in a player.
    pub fn new(config: PatternMutatorConfig) -> Self {
        Self { config }
    }

    /// Applies the configured mutation to the input and returns the result.
    pub fn play(&self, input: &dyn MusicObject) -> Result<Music, TransformError> {
        self.config.apply(input)
    }

    /// Serializes the underlying configuration to its wire string.
    pub fn to_wire(&self) -> String {
        self.config.to_wire()
    }
}

/// Builds a [`PatternMutatorPlayer`] from a mutator configuration.
pub fn player_mutator(config: PatternMutatorConfig) -> PatternMutatorPlayer {
    PatternMutatorPlayer::new(config)
}