mkmidilibrary 0.2.1

Music scoring and MIDI library for Rust
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

//! Music analysis tools
//!
//! This module provides tools for analyzing musical content:
//! - Chord identification and analysis
//! - Key detection
//! - Harmonic analysis

mod chord_analysis;
mod discrete;
mod floating_key;
mod melody;
mod reduce_chords;

pub use chord_analysis::{ChordAnalyzer, ChordQuality, RomanNumeral, roman_numeral_from_chord};
pub use discrete::{
    KeyAnalysisResult, KeyFindingAlgorithm, analyze_part, analyze_part_with_certainty, find_key,
    pitch_class_distribution, tonal_certainty,
};
pub use floating_key::{WindowedKeyResult, analyze_floating_key, detect_modulations};
pub use melody::{ambitus, melodic_interval_diversity};
pub use reduce_chords::ChordReducer;

/// The result of `Part::analyze`'s string-dispatched analysis methods.
#[derive(Debug, Clone, PartialEq)]
pub enum PartAnalysisResult {
    Key(KeyAnalysisResult),
    Ambitus(Option<crate::core::Interval>),
    MelodicIntervalDiversity(f64),
}

/// Backing implementation for `Part::analyze(method)`: dispatches on a
/// method name to the matching analysis routine. Mirrors music21's
/// `Stream.analyze` dispatcher for the analyses implemented in this
/// crate (`"key"`, `"ambitus"`/`"range"`, `"melodicIntervalDiversity"`).
pub fn analyze_part_by_method(
    part: &crate::stream::Part,
    method: &str,
) -> Option<PartAnalysisResult> {
    match method {
        "key" => Some(PartAnalysisResult::Key(analyze_part(
            part,
            KeyFindingAlgorithm::KrumhanslSchmuckler,
        ))),
        "ambitus" | "range" => Some(PartAnalysisResult::Ambitus(ambitus(part))),
        "melodicIntervalDiversity" => Some(PartAnalysisResult::MelodicIntervalDiversity(
            melodic_interval_diversity(part),
        )),
        _ => None,
    }
}