music_xml

A Dart package to parse and serialize MusicXML 4.0.

Features

• Parse MusicXML documents into typed Dart objects
• Support for both uncompressed .xml and compressed .mxl files
• All elements extend XmlElement for XML roundtripping (parse and serialize)
• Supports: notes, pitches, unpitched (percussion), grace notes, chords, lyrics, ties, key/time/clef signatures, tempo, dynamics, chord symbols, barlines, and more
• Follows the MusicXML 4.0 element hierarchy

Getting started

Add music_xml to your pubspec.yaml:

dependencies:
  music_xml: ^2.0.0

Usage

import 'package:music_xml/music_xml.dart';

// Parse uncompressed XML string
final document = MusicXmlDocument.parse(xmlString);

// Parse compressed .mxl file bytes
final mxlDocument = MusicXmlDocument.parseMxl(mxlBytes);

// Access score structure
final parts = document.score.parts;
final measures = parts.first.measures;
final notes = measures.first.notes;

// Access typed elements
final pitch = notes.first.pitch;
print(pitch?.toPitchString()); // "C4"
print(pitch?.toMidiPitch());   // 60

MIDI volume, pan, mute, and solo

MusicXML supports <volume> and <pan> as children of <midi-instrument>. Mixer-style mute and solo are not part of the standard. Apps can store them as namespaced extension attributes. See example/assets/mute-solo.xml and example/lib/mute_solo_extension.dart.

<midi-instrument
    id="P1-I1"
    xmlns:mute-solo="https://example.com/musicxml/mute-solo"
    mute-solo:mute="yes"
    mute-solo:solo="no">
  <volume>80</volume>
  <pan>0</pan>
</midi-instrument>

The library keeps these extension attributes when it parses and writes the file. You can read them through the XmlElement API:

const muteSoloNamespace = 'https://example.com/musicxml/mute-solo';
final instrument = scorePart.midiInstruments.first;

final volume = instrument.volume?.content.value;
final pan = instrument.pan?.content.value;
final isMuted =
    instrument.getAttribute('mute', namespaceUri: muteSoloNamespace) == 'yes';
final isSolo =
    instrument.getAttribute('solo', namespaceUri: muteSoloNamespace) == 'yes';

Use your own namespace URL instead of the example URL above.

Deployment

Run the publish command in dry-run mode to see if everything passes analysis:

flutter pub publish --dry-run

Publish to pub.dev:

flutter pub publish

Additional information

Originally inspired by Google's Magenta musicxml_parser.py, now restructured as a standalone MusicXML 4.0 library.