symusic 0.2.4

A high performance MIDI file parser with comprehensible interface.

symusic

Symusic("Sybolic Music") is a cross-platform note level midi decoding library with lightening speed, which is over 100 times faster than mido, the main midi parsing library in python.

The library is written in cpp and based on minimidi. It offers a python binding using pybind11.

Here, we have added a tutorial.ipynb for you to learn about how to use the library.

Tutorial and Benchmark:

Features

• You can just read a midi file like score = symusic.Score("path to midi", ttype="tick")
• Writing back to midi is now supported! score.dump_midi("path")
• Multiple time unit (ttype) is now supported (currently tick and quarter)
• The tempo attribute in the tempo event represents quarter per minute (qpm)
• We offer some batch operation functions for both Score and Track class:
  • shift_pitch(offset: int)
  • shift_velocity(offset: int)
  • shift_time(offset: float)
  • sort(key, reverse)
• You can operate each note just like you did before in python (like PrettyMidi)
• Extremely fast pickle is now supported

TODO

Notice that this library is under development:

• Re-implement filter_notes and Note Array.

Installation

Use pre-compiled version

pip install symusic

Build from source

Make sure that your system has cmake and c++ compilers

git clone --recursive https://github.com/Yikai-Liao/symusic
pip install ./symusic

Benchmark

Parsing MIDI

• test using mahler.mid from minimidi/example in colab
• mido is writen in pure python, and only parses midi files to event level
• pretty_midi and miditoolkit is based on mido, and parse midi files to note level

library	time
symusic	21.8 ms ± 11.7 ms
MIDI.jl	128.024 ms
mido	5.68 s ± 2 s
pretty_midi	5.59 s ± 844 ms
miditoolkit	6.27 s ± 1.79 s
music21	8.59 s ± 1.2 s

Acknowledgement

• minimidi : A fast and lightweight midi parsing library written in cpp, which is the foundation of this project.
• pybind11 : A great header-only library to help you create python binding for your cpp code.
• pybind11-stubgen A nice tool to generate stub files for pybind11 projects.
• zpp_bits : An extraordinary fast and lightweight single header library for serialization and deserialization. I use it to support pickle.
• geek_time_cpp The example code of the book "Modern C++ Programming Practice". We use the metamacro.h in it for shortening the code.