ℹ️ This project is no longer in active development. I still keep an eye on it and it's open for contributions/PRs but I am not actively working on new feature implementations. The main reason being that there is an official early access audio player to be found (currently only available for donors): https://github.com/sponsors/opensheetmusicdisplay

🎵 OSMD Audio player

Unoffical audio playback engine for OpenSheetMusicDisplay. Successor meant to replace my previous proof of concept player & demo at https://github.com/jimutt/osmd-playback-demo.

This player is still in a very early state and lots of breaking and non-breaking changes will most likely be introduced before the first major release. Use at your own risk!

Install

npm install osmd-audio-player

Demos / usage

Basic

Basic no-framework demo with only play, pause & stop functionality.

Live demo: https://osmd-audio-player-demo-basic.netlify.com/ Source: https://github.com/jimutt/osmd-audio-player/tree/master/demos/basic

Vue JS + Vuetify

A more full-featured demo featuring configurable instruments, level control, switching scores & changing tempo.

Live demo: https://osmd-audio-player-demo-vue.netlify.com/ Source: https://github.com/jimutt/osmd-audio-player/tree/master/demos/vue-player-demo

You might notice that there's currently a quite large delay when switching instruments. It's due to the in-advance scheduling to prevent interruptions & timing issues in the audio playback, and there's currently no clearing/reset of the buffer when an instrument change takes place. Some improvements in that area are planned.

Basic (React)

Barebones React example, contribution by @joshstovall.

Source: https://github.com/jimutt/osmd-audio-player/tree/master/demos/react-demo

Basic (UMD build)

Same functionality as the basic demo but without any Node.js requirements. Uses the UMD build of OSMD and the audio player for simple plug and play functionality in any web page.

Source: https://github.com/jimutt/osmd-audio-player/tree/master/demos/umd-web

The minified UMD build can be referenced from JSDelivr: https://cdn.jsdelivr.net/npm/osmd-audio-player/umd/OsmdAudioPlayer.min.js

Features

• Framework agnostic, not tied to a specific front end Framework
• Multi-instrument support
• Individual level controls
• Automatic tempo detection from score
• Automatic instrument assignment

Roadmap

• Repeat support
• Dynamics support
• Grace note support
• Click to set playback position
• Updated & properly structured Vue demo
• Quickstart guide & more extensive Readme
• Custom audio stack for playing soundfonts
• Stricter typing
• Unit tests

Credits

Thank you Browserstack for offering me your Open Source license for cross browser testing.