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
//! # [Overview](#overview)
//! ChordParser is a library for parsing musical chords from a human readable string representation.
//! It is inspired by chordSymbol: <https://www.npmjs.com/package/chord-symbol.>
//! Said that, it implements its own rules and conventions, which can change in the future since this it is a work in progress project.
//! For now, the scope of the library is to parse chords from Pop, Rock, and Jazz music in _relatively standard_ English notation.
//! Classical notation, as well as Latin or German notation, is not supported.
//!
//! # [Chord struct](#chord_struct)
//! Once parsed the [Chord](chord/struct.Chord.html) struct can be used to get information about the chord.
//! This includes:
//! - Root note of the chord
//! - Bass note of the chord if any
//! - Parsed descriptor of the chord
//! - A normalized version of the input
//! - Note literals
//! - Intervals relative to root note
//! - Semitones relative to root note
//!
//! The [Chord](chord/struct.Chord.html) is also serializable into JSON, can generate MIDI codes for its notes, and allows transposition from one key to another.
//!
//!
//! # [Parser rules](#parsing_rules)
//! Since there isn't a full consensus on how chords should be written, any chord parser is by definition opinionated.
//! We try to get a good balance between rejecting all invalid notations and accept any possible chord representation.
//! Check the test cases in the `test` folder to have a grasp of what chords can and cannot be parsed.
//!
//! # [Voicing generation](#voicing_generation)
//! The voicings module exposes a function to generate a set of MIDI notes from a [Chord](chord/struct.Chord.html) representing a voicing for it.
//! The voicing is generated in a range from C1 to G4. The generator function accepts a lead note to generate the voicings around it, which allows chaining distinct chords smoothly.
//!
//!
//! # [Limitations](#limitations)
//! - Root notes with Double/Triple Flats/Sharps are not supported.
//!
//! # [Examples](#examples)
//! ```rust
//! use chordparser::parsing::Parser;
//!
//! let mut parser = Parser::new();
//! let result = parser.parse("AbMaj7#11");
//! match result {
//! Ok(chord) => {
//! dbg!(&chord);
//! dbg!(&chord.to_json());
//! }
//! Err(e) => {
//! dbg!(e);
//! }
//! }
//!
//! ```