This library makes it easy to incorporate sheet music into your websites. You can also turn visible ABC text into sheet music on websites that you don't own using a greasemonkey script, or change your own website that contains ABC text with no other changes than the addition of one javascript file. You can also generate MIDI files or play them directly in your browser.
Full documentation is here: abcjs documentation
If you are using an octave clef (for instance K:C clef=treble-8
) it will now sound an octave different. The octave calculation was happening twice.
The file abcjs version supporting midi.js is the last version of the old style of sound production that will receive updates.
The default branch is now named main
. If you have cloned this repo previously, you can change it with:
git branch -m master main
git fetch origin
git branch -u origin/main main
Be sure to download the latest abcjs-audio.css file if you are using it. If you are styling the audio control with your own css, add the rule:
.abcjs-css-warning {
display: none;
}
Old versions of abcjs have been removed from this repo. If you are looking for them, you can find them here: Historical Versions
The midi.js package is no longer a direct dependency, it is now a peerDependency so it is not included by default. That way, users who aren't using the old style of sound generation won't need to load the package. If you are using the old style that uses midi.js, include this line in your package.json
file:
"midi": "https://github.com/paulrosen/MIDI.js.git#abcjs"
Note that if you are using the minified version of the library with a <script>
tag this does not apply to you.
There have been some tweaks to the way wrapping is calculated. Hopefully this will make your music layout a little better. If you start seeing odd results, let me know.
The files in /bin
are being phased out. You can get the executables from /dist
and the file names will not have the version number attached.
Many of the old versions that were in /bin
are no longer kept in the active branches. If you need a particular old version then you can go to the branch with that tag to get it.
The last version in each major version number is still available in the active branch as well as many recent versions.
In this beta the default soundfont was changed to https://paulrosen.github.io/midi-js-soundfonts/abcjs/ Hopefully you will find that sounds better. If you set the soundfont directly then you won't notice any change. If you prefer the old soundfont, use the soundFontUrl: "https://paulrosen.github.io/midi-js-soundfonts/FluidR3_GM/"
option when calling the synth functions.
I'm trying to get all the issues that will create breaking changes done before releasing 6.0.0. There will still be a few beta versions to come.
I am going to try to release new beta versions regularly with a few improvements in each.
The two changes that are coming soon that might affect your code are:
- Break apart the paths in the SVG so that parts of the note can be targeted. (For instance, just the flag, or one note in a chord.)
- Be able to set the minimum spacing for notes when there are lots of notes on a line.
There will also be a number of the open issues considered for each beta version.
If you have a particular issue that is impeding your usage of this library, please mention it in the issue.
Thanks, Paul
For most users of abcjs there probably won't be any more breaking changes in this beta.
There will probably still be some changes to the structure of the SVG that is created but if you aren't doing post-processing you won't notice except for better layout of the music.
There might be a few changes to the data that is returned from the callbacks, both the click listener and timing callbacks. Hopefully that will just be added data and won't affect any code.
Thanks so much for the bug reports and feature requests that are pouring into the issues. I appreciate you taking the time to help improve abcjs. This is not a full time project, though, so I can't promise a quick turn around on the issues. I am going to attempt to be caught up on responding once a week at least.
And I would love some help on this project, including documentation, bug fixes, testing, refactoring, modernizing tools, and adding features. If you are so inclined, please get in touch.
If you aren't using the same browser and machine that I use, you can thank BrowserStack for their support of this open-source project.