Soundry

Soundry is an experimental parser for the SFZ file format, written in Rust that intends to be capable of handling both SFZ versions. As well, it intends to implement the full set of opcodes for various headers, and ideally, parse SFZ files programmatically depending on the tools that would use the parser. For example, Meadlowlark is a Rust based DAW, for which someone could use Soundry to develop a synthesizer plugin that provides instruments, synths, and the like.

Features

• Efficient Parsing: Utilizes the nom crate for fast and accurate parsing of SFZ files.
• Value Refinement: Uses the refinement crate to guarantee that all opcode values are within the ranges defined in the specification(s).
• Flexibility: Allows for handling both SFZ versions and whatever set of headers/opcodes are supported by a given player.

Getting Started

Installing

Bringing Soundry into your project is as simple as adding the following to your Cargo.toml file:

[dependencies]
soundry = "0.1.0"

Alternatively, if you'd like to build it from source, run the following in the directory of your choosing:

git clone https://github.com/arcnemesys/soundry.git
cd soundry && cargo

Usage

A simple placeholder example of using Soundry is given below..

use soundry::control::parse_control_header;

fn main() {

  let control_header = r#"<control>
    default_path=Samples\
    #define $EXT wav
    #include \"data\control.sfz\"
    #include \"data\multiout.sfz\"
    #include \"data\global.sfz\"
    #include \"data\kick.sfz\"
    #include \"data\snare.sfz\"
    #include \"data\tom1.sfz\"
    #include \"data\tom2.sfz\"
    #include \"data\hihat.sfz\"
    #include \"data\ride.sfz\"
    #include \"data\crash.sfz\"#;

    match parse_control_header(control_header) {
        Ok((_, control)) => {
            let expected_control_header = Control { 
              header_type: Control, 
              define_directives: {"EXT": "wav"},
              include_directives: [
                "data\\control.sfz",
                "data\\multiout.sfz",
                "data\\global.sfz",
                "data\\kick.sfz",
                "data\\snare.sfz",
                "data\\tom1.sfz",
                "data\\tom2.sfz",
                "data\\hihat.sfz",
                "data\\ride.sfz",
                "data\\crash.sfz"
              ],
              default_path: "Samples\\", 
              note_offset: 0, 
              octave_offset: 0, 
              label_ccn: [], 
              set_ccn: [] 
              };
            assert_eq!(control, expected_control_header);
            println!("Successfully parsed control header: {:?}", control);
        },
        Err(e) => eprintln!("Failed to parse SFZ control header: {}", e),
    }
}

Dependencies

• Nom.
• Refinement.

Acknowledgments

• Nom author(s)
• Refinement authors(s)
• Anders Danhielson

Inspirations

• Meadowlark
• Hound
• Rodio
• Dasp
• Fundsp
• Glicol
• Reaper-rs

Reference Material

• http://drealm.info/sfz/plj-sfz.xhtml

• https://sfzformat.com/headers/

• Opcode List: https://www.linuxsampler.org/sfz/

• https://sfzformat.com/legacy/

• SFZ Tutorial/Intro: https://sfzformat.com/tutorials/basics/

• MIDI CC Message List: https://atherproducer.com/online-tools-for-musicians/midi-cc-list/

• https://www.sustainable-music.org/demystifying-sfz-a-guide-to-understanding-the-sfz-format-for-sound-libraries/

• https://github.com/sfz/tests/tree/master

• https://sfzlab.github.io/sfz-website/

• https://edrums.github.io/en/linuxsampler/sfz/#Effects

• https://raw.githubusercontent.com/sfzinstruments/mappings/master/Pettinhouse/Yamaha%209000/Yamaha%209000.sfz

• https://github.com/sfzinstruments/mappings/blob/master/PastToFuture%20Disco%20Drums/Disco%20Drums%20-%20Multiout.sfz

TODOS

• TODO: Dedupe EG/LFO variants to be defined once and reused.

• TODO [in progress]: Explore refinement types.

• TODO [in progress]: Implement parsing with nom.

• TODO: Add Cakewalk specific codes.

• TODO: Add v2 opcodes for

  • Sample Playback

  • Voice LifeCycle

  • Midi Conditions

  • Internal Conditions

  • Triggers

  • Amplifier

  • EQ

  • Filter

  • Pitch

  • LFO

  • Curves

  • Effects

  • Loading

  • Wavetable Oscillator

• TODO: Figure out how to parse whatever this is: label_cc$RELEASE=Release ($RELEASE)