Git Product home page Git Product logo

osmd-audio-player's Introduction

โ„น๏ธ 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

Browserstack

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

osmd-audio-player's People

Contributors

jimutt avatar dependabot[bot] avatar csantero avatar joshstovall avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.