scorelib

A safe, modular Rust library to parse and write Guitar Pro files.

Usage

Add this to your Cargo.toml:

[dependencies]
scorelib = { path = "../lib" }

Basic usage:

use scorelib::model::song::Song;
use scorelib::model::track::SongTrackOps;

fn main() {
    let data = std::fs::read("my_awesome_song.gp5").expect("Unable to read file");
    
    let mut song = Song::default();
    // Use the trait-based reader (e.g., SongTrackOps is needed for internal track reading)
    song.read_gp5(&data);
    
    println!("Song Title: {}", song.name);
    for track in &song.tracks {
        println!("Track: {}", track.name);
    }
}

Features

• GP3, GP4, GP5: High-fidelity reading and writing support.
• GP6/GP7 (.gp, .gpx): Initial experimental reading support.
• MuseScore (.mscz): Basic XML/ZIP parsing.
• Modular Design: Separated into model, io (low-level primitives), and audio (MIDI).
• Extensible: Uses Rust traits to add format-specific functionality to the core Song model.

Roadmap

• Refactor into model, io, and audio modules.
• Convert impl Song blocks into specialized traits.
• Improve GP5 parsing (better handling of complex directions).
• Stabilize GP6/7 support.
• Support for chords and rhythm details in GP6/7.
• Write support for newer formats.
• Comprehensive documentation of the data model.
• Better error management (remove use of expect, unwrap) using crathe thiserror
• Change model for MNX (or separate in a legacy mod)