#music #notation #abc

abc-parser

An ABC music notation parser. Turns ABC text into Rust data structures and back.

6 releases

Uses old Rust 2015

0.3.0 Jun 8, 2021
0.2.0 Aug 21, 2018
0.1.5 Aug 20, 2018

#130 in Parser implementations

29 downloads per month

MIT license

45KB
1.5K SLoC

rust-abc-2

ABC Parser written in rust using PEG.

Usage

Add the package to your cargo dependencies.

[dependencies]
abc-parser = "0.2"

Then you can use the PEG generated rules through the abc module.

extern crate abc_parser;

use abc_parser::datatypes::*;
use abc_parser::abc;

let parsed = abc::tune_book("X:1\nT:Example\nK:D\n").unwrap();
assert_eq!(
    parsed,
    TuneBook::new(None, vec![
        Tune::new(
            TuneHeader::new(vec![
                InfoField::new('X', "1".to_string()),
                InfoField::new('T', "Example".to_string()),
                InfoField::new('K', "D".to_string())
            ]),
            None
        )
    ])
)

There is a good chance that the dev branch may have more recently added features which arent complete but won't (probably) break the existing functionality. You can also tell cargo to install directly from the dev branch like this:

[dependencies]
abc-parser = { git = "https://gitlab.com/Askaholic/rust-abc-2", branch = "dev" }

Feature List

These are roughly taken in order from the abc standard.

  • Info fields
  • Field continuation
  • Notes
    • Pitch
    • Accidentals
    • Lengths
    • Ties
    • Broken Rhythm
  • Rests
  • Clefs and Transposition
  • Beams
  • Bars
  • Variant Endings
  • Slurs
  • Grace Notes
  • Tuplets
  • Decorations
  • Symbol Lines
  • Redefining Symbols
  • Chords and Unisons
  • Chord Symbols
  • Annotations
  • Lyrics
  • Multiple Voices
  • Text Strings
  • Macros
  • Stylesheet Directives
  • Dialects

History

The first version was an attempt to write the parser by hand, but using PEG is much more maintainable. The older repo is here: https://gitlab.com/Askaholic/rust-abc

Dependencies

~165KB