cargo add redact-composer

如果使用serde 功能，则需要typetag

cargo add typetag

基本功能可以通过创建一个简单的I-IV-V-I和弦作曲家来演示。完整的代码示例位于redact-composer/examples/simple.rs。

构建模块

此示例作曲家将使用一些库提供的元素（Chord、Part、PlayNote）和两个新元素

#[derive(Element, Serialize, Deserialize, Debug)]
pub struct CompositionRoot;

#[derive(Element, Serialize, Deserialize, Debug)]
struct PlayChords;

在继续前进之前，先介绍一下背景：一个组合是一个n元树结构，它从根元素Element开始，通过调用其关联的Renderer生成额外的Element作为子节点。然后，这些子节点将调用它们的Renderer，这个过程一直持续到到达树叶（即不再生成更多子节点的元素）。

此作曲家将使用CompositionRoot元素作为根。为该元素定义一个Renderer看起来像这样：

struct CompositionRenderer;
impl Renderer for CompositionRenderer {
    type Element = CompositionRoot;

    fn render(
        &self, composition: SegmentRef<CompositionRoot>, context: CompositionContext,
    ) -> Result<Vec<Segment>> {
        let chords: [Chord; 4] = [
            (C, maj).into(),
            (F, maj).into(),
            (G, maj).into(),
            (C, maj).into(),
        ];

        Ok(
            // Repeat the four chords over the composition -- one every two beats
            Rhythm::from([2 * context.beat_length()])
                .iter_over(composition)
                .zip(chords.into_iter().cycle())
                .map(|(subdivision, chord)| chord.over(subdivision))
                .chain([
                    // Also include the new component, spanning the whole composition
                    Part::instrument(PlayChords).over(composition),
                ])
                .collect(),
        )
    }
}

注意：Part::instrument(...)只是另一个元素的包装，表示在包装元素内生成的音符将一次由一个乐器演奏。

此Renderer接收一个CompositionRoot元素（通过一个SegmentRef），生成包括Chord元素（在组合中每两拍有一个节奏）和新生成的PlayChords元素在内的多个子节点。这些子节点作为Segment返回，定义了它们在组合时间线中的位置。

在这个阶段，Chord和PlayChords元素只是抽象概念，需要生成一些具体的内容。这是通过另一个Renderer为PlayChords完成的。

struct PlayChordsRenderer;
impl Renderer for PlayChordsRenderer {
    type Element = PlayChords;

    fn render(
        &self, play_chords: SegmentRef<PlayChords>, context: CompositionContext,
    ) -> Result<Vec<Segment>> {
        // `CompositionContext` enables finding previously rendered elements
        let chord_segments = context.find::<Chord>()
            .with_timing(Within, play_chords)
            .require_all()?;
        // As well as random number generation
        let mut rng = context.rng();

        // Map Chord notes to PlayNote elements, forming a triad
        let notes = chord_segments
            .iter()
            .flat_map(|chord| {
                chord.element
                    .iter_notes_in_range(Note::from((C, 4))..Note::from((C, 5)))
                    .map(|note|
                        // Add subtle nuance striking the notes with different velocities
                        note.play(rng.gen_range(80..110) /* velocity */)
                            .over(chord))
                    .collect::<Vec<_>>()
            })
            .collect();

        Ok(notes)
    }
}

在这里，使用CompositionContext引用先前创建的Chord段。然后，在八度范围内的每个Chord中的Note都会在Chord段的节奏上play。

创建作曲家

本质上，一个Composer只是一组Renderer，只需要一点粘合剂就可以构建。

let composer = Composer::from(
    RenderEngine::new() + CompositionRenderer + PlayChordsRenderer,
);

最后，通过将根Segment传递给其compose方法，魔法就开始展开了。

// Create a 16-beat length composition
let composition_length = composer.options.ticks_per_beat * 16;
let composition = composer.compose(CompositionRoot.over(0..composition_length));

// Convert it to a MIDI file and save it
MidiConverter::convert(&composition).save("./composition.mid").unwrap();

// And/or synthesize it to audio with a SoundFont
let synth = SF2Synthesizer::new("./sounds/sound_font.sf2").unwrap();
synth.synthesize(&composition).to_file("./composition.wav").unwrap();

注意：SF2Synthesizer没有默认/内嵌的SoundFont，所以您需要提供自己的。Frank Wen创建的FluidR3是一个很好的通用、高质量、MIT许可的选项。

输出应该听起来像这样

https://github.com/dousto/redact-composer/assets/5882189/aeed4e7a-5543-4cf1-839d-d5f62c55fea9

此外，组合输出支持序列化/反序列化（使用默认启用的serde功能）。

// Write the composition output in json format
fs::write("./composition.json", serde_json::to_string_pretty(&composition).unwrap()).unwrap();

查看此存储库以获取更深入示例，该示例利用了额外的功能来创建完整的组合。

对于较大的组合，调试组合输出可能会很快变得难以控制。redact-composer-inspector是一个简单的网络工具，可以帮助可视化并导航Composition输出的结构（目前仅与json输出兼容）。

例如，这里是在检查器中加载的简单示例：简单示例。

默认

derive，musical，midi，synthesis，serde

derive _默认

启用针对 Element 的 derive 宏。

musical _默认

包含 musical 领域模块。（Key，Chord，Rhythm 等..）。

midi _默认

包含包含 MIDI 相关 Element 和 MIDI 转换器 Composition 的 midi 模块。

synthesis _默认

包含将 Composition 合成到音频的 synthesis 模块。

serde _默认

启用通过（如你所猜）serde 对 Composition 输出的序列化和反序列化。