I'm proud to release v8 of music21, the toolkit for computer-aided music analysis, score manipulation, computational musicology, etc. This release (technically 8.1) builds on 12.5 months of work from v7, and like all new big number releases has a few backwards incompatible changes from before, in exchange for cool new features.
Version 8 supports Python 3.8+, if you need Python 3.7 (such as on Google Colab which is now 3+ Python versions behind) stick to music21 v7. V8 is the first to fully support Python 3.10 and will receive patches to support Python 3.11 in the future. As Python 3.11 is due to be released any day now, keeping with the m21 policy of supporting three versions of Python, music21 v9 (work starts tomorrow!) will support Python 3.9 and above only.
- The biggest new improvement in v8 is an all new Dublin-Core / MARC based metadata system that allows for encoding a huge amount of information about a score. Look at the new docs for music21.metadata for more information. Thanks to Greg Chapman for the big amount of work on this. (@gregchapman-dev in #1266)
- Modern installation system, based on Hatch. If you have problems, please let me know -- I expect some growing pains on this.
- ArpeggioMark and ArpeggioMarkSpanner classes. by @gregchapman-dev in #1337
- Adding DCML v2 parsing to tsvConverter.py by @malcolmsailor in #1267
- Explicit Keywords on all music21 objects by @mscuthbert in #1377
- Continued Major improvements in Typing across music21. by @mscuthbert and @jacobtylerwalls. If you are using a modern IDE, you will find the number of music21-related bugs you create will go down hugely.
- Ever more docs and more relevant (and diverse examples)
Other changes/fixes since v7.3
- opFrac speedup by @mscuthbert in #1278
- Fix MIDI in Google Colab Notebooks (v8) by @mscuthbert in #1281
- Use more classes in getElementsByClass by @mscuthbert in #1283
- Improve graphing docs and options by @mscuthbert in #1285
- Accidentals never and if-absolutely-necessary by @mscuthbert in #1148
- Add typing to key.py by @mscuthbert in #1289
- makeRests(inPlace=True) returns None for scores by @jacobtylerwalls in #1288
- StreamCore is now a Music21Object; Iterator improvements by @mscuthbert in #1295
<forward>tags from expressions out of measure bounds by @jacobtylerwalls in #1261
- Avoid writing empty
<creator />tags when title and author have no defaults by @jacobtylerwalls in #1248
- harmonicFunction. maps between RN figures and function labels by @MarkGotham in #1130
- Make cautionaryPitchClass=True work with chords by @jacobtylerwalls in #1299
- Export Unpitched to MIDI by @jacobtylerwalls in #1315
getPitches(direction=DESCENDING)returning ascending scales by @jacobtylerwalls in #1311
Keyinstances compare equal regardless of tonic octave by @jacobtylerwalls in #1316
- optimize opFrac by @mscuthbert in #1322
- Fix midmeasure clef export regression involving voices by @jacobtylerwalls in #1330
- Fix a bug in musicxml/partStaffExporter.py where a clef-octave-change… by @gregchapman-dev in #1334
- [Musicxml export] Preserve whitespace in TextBox by @jacobtylerwalls in #1331
- Fix bug in Capella parsing. by @mscuthbert in #1342
- Patch duration linked bugs by @mscuthbert in #1341
- deprecate gcd in favor of C math by @mscuthbert in #1343
- makeTies within makeNotation; getTimeSignatures recurse by @mscuthbert in #1346
- First docs and improvements to trees by @mscuthbert in #1312
- Fix shiftElements docs by @jacobtylerwalls in #1326
- SixthMinor carries to secondary dominants @mscuthbert in #1354
- Add makeNotation routines for completing or consolidating tuplets by @jacobtylerwalls in #1242
- Demonstrate ties in
splitElementsToCompleteTupletsdoctest by @jacobtylerwalls in #1362
- MusicXML export: Make rests before making notation by @jacobtylerwalls in #1361
- Validate figures provided to
RomanNumeral()by @jacobtylerwalls in #1340
- Clear cache when adding notes w/o sort by @mscuthbert in #1357
- match d43, d65, etc. by @malcolmsailor in #1363
- Use requests lib. for URL getting by @mscuthbert in #1367
- Allow iterables of qualified class names in
Stream.__getitem__searches by @jacobtylerwalls in #1359
- Fix problem with add#7 by @mscuthbert in #1373
makeNotationargument to test utility by @jacobtylerwalls in #1376
- Prevent too large
<backup>values in PartStaffExporter by @jacobtylerwalls in #1375
- Prevent zero-duration ChordSymbols from matching stripTies algorithm by @jacobtylerwalls in #1381
- fixed up romanText repeats by @malcolmsailor in #1378
- Remove *arguments where not used by @mscuthbert in #1394
- Standardize DatePrimitive -> Date interaction by @mscuthbert in #1395
- Emphasize Pitches in Interval classes by @mscuthbert in #1396
- Fix issue #1335: voice numbers written in MusicXML must be unique… by @gregchapman-dev in #1336
- Parse double flats in RomanText by @malcolmsailor in #1405
- Fix (and test) writing of multi-measure RepeatBrackets to MusicXML. by @gregchapman-dev in #1401
- romanText write to file-like objects by @malcolmsailor in #1416
- Closing too many states should be a TNException by @mscuthbert in #1421
- Fix loss of forward repeat marks when exporting PartStaffs by @jacobtylerwalls in #1420
- Add typing for contextSites, yieldSites by @mscuthbert in #1423
- Get rid of imp / load_source() by @mscuthbert in #1424
- Remove tons of unnecessary imports in doctests by @mscuthbert in #1425
- Clarify copyright entities by @mscuthbert in #1430
- Use hatch for building by @mscuthbert in #1429
Significant Improvements and bugs Fixed from 7.1 to 7.3.3
- Fix improper call to locale library in multiprocess test text output by @jacobtylerwalls
stripTies()crash in certain scenario with matchByPitch=False by @jacobtylerwalls
- Support multiple figures in single lyric (e.g "64") in
- Add safety and more characters to
- Fix accentSequence for 3/8 by @jacobtylerwalls
- Use matchByPitch=True in MIDI export by @jacobtylerwalls
- Cleanup chord.tables by @mscuthbert
- Prevent some superfluous naturals when updating accidental displayStatus by @jacobtylerwalls
- MusicXML import: Stop duplicating MetronomeMarks in multi-staff parts by @jacobtylerwalls
- Clear previous result of attachIntervalsBetweenStreams() by @jacobtylerwalls
- Documentation and improvements to tree by @mscuthbert
- Export style attributes from chord members by @jacobtylerwalls
- Fix zero-duration chords and coreInsert crash in reduceChordsOld by @jacobtylerwalls
- Braille: export bowing symbols by @jacobtylerwalls
- Import/export unpitched percussion instruments <--> MusicXML by @jacobtylerwalls
- Explict imports in init.py; support 3.10 by @mscuthbert
- Replace bèmol with bemol in Spanish translation of flat by @yaph
- Fix dissonance score for compound intervals by @jacobtylerwalls
- Fix parsing of add, alter, omit, and subtract in chord symbol figures by @jacobtylerwalls
- Respect Accidental.displayType option 'never' by @jacobtylerwalls
- Clean up temporary attributes set by braille translator by @jacobtylerwalls
- allow classes in getSpannerSites by @mscuthbert
- Small style upgrades and beams by @mscuthbert
- Fix accidental status overriding for initial diatonic naturals by @jacobtylerwalls
- Fix accidental display af...
Music21 v7.3.3 - Google Colab MIDI
Music21 7.3.3 adds support for showing MIDI inside a Google Colaboratory (colab) notebook, via music21j. Since m21 v8 will be Python 3.8+ only, and Google Colab is still on Python 3.7, a back-port to v7 was needed.
7.3.2 was internal development only and not released
7.3.1 fixed a bug that made some installations of v7.3.0 fail, and fully replaced the 7.3.0 branch, which, as Apple would say, is now "unsigned".
Music21 version 7.3 is released. This is the second and probably final release on the v7 line. I begin work on version 8 today.
Version 7.3 is a bug-fix, improvement, and maintenance release of music21. Aside from a few obscure corners of the code, it is designed to be fully backwards compatible with the previous v7 releases (7.1). It represents half a year's work since the original v7.1 release.
Thanks go especially to Jacob Tyler Walls who really steered the contributions to this release.
Among the major improvements in this branch are:
- Full support for Python 3.10.
- I've been doing all my recent dev on 3.10 taking advantage of new features, and it's great, and plays well with numpy, tensorflow, and so many other cutting edge analysis tools.
- In keeping with music21's policy of supporting the last three versions of Python, music21 v7.3 will be the last version of music21 to support Python 3.7. A decision on whether 3.8 or 3.9 will be the minimum version for music21 v8 will come later, depending on its release date; we may also update policy somewhat and raise the minimum version to 3.9 during the v8 cycle.
- MIDI and MusicXML import/export will create and use Unpitched and PercussionChord objects. (slight incompatibility but worth it).
- The stripTies method's "matchByPitch" setting is improved.
- Slight incompatibility: 3/8 is default configured to one beat with two sub beats (like 6/8)
- Lots more typing improvements. mypy is now being run on a subset of the music21 code to ensure that our docs match our work.
- Individual notes in Chords can be styled more easily and robustly.
- The tree module is slightly better documented, for anyone who wants to work with insane speed (and complexity)
- Some superfluous natural signs no longer appear after running makeNotation; makeAccidentals improvements throughout. displayType="never" is now respected.
- Improvements in instrument names and lookup (Thanks Mark Gotham)
- Music21 gives better introspection in more developer environments. Music21 now imports its own modules individually. The former way of doing its own imports while "legal" was preventing code analysis on some IDEs.
- Dissonance score on certain compound intervals has been improved.
- ChordSymbol constructor has been improved
- Metronome marks only appear on the top staff of piano and other PartStaff scores. Other superfluous meters and key signatures on various outputs (especially MIDI) have been fixed.
- Braille exports voices properly; full scores including piano (PartStaff) export to Braille.
- Ottava objects import better from musicxml
- Bug fixes on changing RomanNumeral objects, or round-tripping chordFromFigure(romanNumeralFromChord(ch).figure), especially with bracketed alterations and on minor
- GarageBand is now set as the default MIDI player on MacOS. It's a bit of overkill to be sure, but it's the only MIDI player that comes with the system, and to be honest, it sounds really good.
- More .commonName improvements for enharmonic respellings of common chords.
- TempoText preserves styles even if the text changes (thanks Greg Chapman)
- RomanNumerals now treat common ways of inputting suspensions (V54, etc.) as suspensions rather than obscure 11th chords, etc. Note, however, that RomanNumerals are not a fully consistent/comprehensive chord description format, so there will always be some gaps in coverage.
Smaller improvements and features include:
- Root position Neapolitan chords can be written as "N53"
- Better support for output on systems where UTF-8 is not the default.
- Time Signatures export to MIDI
- Instruments that normally have a certain transposition (Trumpet = Bb, etc.) now respect part parsing of "Trumpet in C"
- More gaps in streams export to MusicXML as "forward" tags.
- Braille output supports more technical indications beyond fingerings, such as bowings.
- Hidden features in chord.tables are now exposed and documented.
chordReduction (beta) crashes less often.
- Figured bass input supports notation like "64" (same as RomanNumeral) in addition to the older "6, 4" syntax.
- Date metadata supports error ranges better.
- attachIntervalsBetweenStreams is now more robust on subsequent runs if the streams are being edited.
- Some edge cases of ChordSymbol's with add/subtract/alter/omit have been fixed.
- A corpus file with an offensive name has been renamed and edited. It came from a bulk import of an existing collection that was never closely scrutinized. There are files in the corpus from minstrel show traditions that would never been added today; however, because so many existing tutorials etc. rely on these files being in the corpus, they have not been removed now. They may be in the future.
- ChordSymbols with realized durations are exported properly.
- Up to 2048th notes can now be beamed.
- getSpannerSites can now take classes.
- Correct spelling of "bemol" in Spanish.
- localCorpus.removePath fixed.
- harmony.NoChord improvements.
- Faster MIDI import/export
- Crescendo and Decrescendo wedges have correct and sane id numbers in musicxml output.
- el.next(activeSiteOnly=True) no longer occasionally finds things in other streams.
- .show('musicxml') on a single measure is improved (and works well in Finale 27).
- Users who choose to skip makeNotation on musicxml writing (in general don't!) will have exceptions thrown if notation that cannot appear in musicxml gets through, rather than just corrupt musicxml. This does not affect the 99.9% of us who let music21 change notation to reflect what can be written in a score.
- TimeSignature.loadRatio() deprecated. Use TimeSignature.load() [same] or TimeSignature.ratioString = '4/4'
- Score.flattenParts() -- just iterate over .parts and call flatten() on that.
- Duration.fill() -- this was a testing routine that got exposed.
Goals for the upcoming v.8 include support for MusicXML 4.0 and SMuFL and better round-tripping between various formats, cleaner typing, improved docs and faster operations. Improved support for IDEs including Jupyter notebook and Colab will also be prioritized.
There are other new features, such as improving OMR post-processing, restoring the web/VexFlow 4.0 connection, etc., but (as people who have proposed major new features on GitHub will be aware), I'm planning on considering the core music21 largely "feature complete" and encouraging people to make external libraries (now that pip + GitHub makes this so much easier) rather than stuffing more into music21. I'd rather focus music21 on being the core system for so much else than putting more into it. I don't plan on removing anything currently in music21 in the next version, but you may find that they're being imported from other libraries instead. This will let the community move at the pace some people there want while letting me guide the core project as 15 years of development on it has taught me.
As ever, music21 would not have been possible without support from the Seaver Institute, the National Endowment for the Humanities and the multinational Digging into Data challenge, and the support of MIT/SHASS/Music & Theater Arts.
(7.3.0 had an installation bug -- replacing with 7.3.1)
Version 7 (technically 7.1.0) of music21, a toolkit for computational musicology, music theory, composition, etc. is released! A substantial revision and set of improvements for music21 that will make it easier to analyze, explore, and compose music. As with all new major version releases, there are some incompatibilities with earlier versions that should make developers test their own software before upgrading.
When you can now type:
Or if you want to find the first Key object in the piece, don't type:
...which will walk through the entire score, even though you just want something at the beginning. You can instead do:
in a millionth of the time. Streams and StreamIterators get the .first() and .last() methods, though only .first() is currently a major speedup. When we figure out how to walk an iterator quickly backwards, though, one day, .last() will also magically become faster.
Making a stream from notes could take a lot of space:
c = note.Note('C') d = note.Note('D') m = stream.Measure() m.append(c) m.append(d) p = stream.Part() p.append(m)
So why not:
c = note.Note('C') d = note.Note('D') p = stream.Part(stream.Measure([c, d]))
now if a list of elements are passed into the stream constructor, they are appended one after another, not all inserted at position 0.
If a stream is passed to another Stream's constructor it is put into the Stream itself, not its elements. This was a common mistake in v6 and earlier:
c = note.Note('C') m = stream.Measure(c) p = stream.Part(m) sc = stream.Score(p)
Before, since Streams are list-like, the only thing in the Score would have been the single note C with no parts or measures at all!
In v7, the code above will create a perfectly well-formed score (well, except the lack of TimeSignature, etc., but music21 can figure that out for you.
Oh, and if you put multiple Measures into a Part constructor, they're all appended as they should be. Put put multiple Parts into a Score constructor or multiple Voices into a Measure constructor and they're all at offset 0, like they should be. Smart is better than inflexible.
Because of this change, there's now much more incentive to create proper Part, Measure, etc. objects than just making everything a general Stream.
Streams can now retrieve a single element with recursive search by id:
or easily iterate over all elements recursively by group:
for n in sc['.myGroup']: ...
If it looks like CSS querySelectors, it's for a reason. And we're just getting started with showing the power of these elements.
Stream.flat has become Stream.flatten() -- why? (a) it's a verb, and should be a verb. (b) it takes a long time to generate and alters the .sites on the contained notes, so it shouldn't be a property, which implies that it's fast and has no side-effects. (c) it is now no longer shorter and faster to type than Stream.recurse() which is what you want to do 90% of the time anyhow. Stream.flat will stick around for at least 2 more versions, becoming deprecated in v8 or 9 and removed in v9 or 10. I know it's our version of "print(a)" replacing "print a" and it'll take some time to get used to. But it was a mistaken choice in 2008 and it's just as much of a mistake in 2021.
(For .semiFlat, just use Stream.flatten(retainContainers=True) which is much clearer)
New Core Developer: Jacob!
Jacob Tyler Walls has joined the commit/core development group of music21 and can now review your pull requests etc. He has made MAJOR contributions to v7 and it would not be out without him! Please send him your thanks when you use music21. Because he's on the core team now, I won't single out his contributions separately from my own (for the most part. When it's big, I'll say so).
Other substantial improvements
- I hope you're editing your own files in a modern IDE like PyCharm or VSCode. We've added tons of typing information to help you find bugs before you run.
- Significant improvement in MIDI Quantization. We still recommend converting MIDI to MusicXML (or Humdrum/MEI/etc.) in a dedicated MIDI processor, but many more MIDI files will work "out of the box" in music21 v7.
- Go ahead and parse a large piano score from musicxml. But don't go get your customary cup of coffee. Jacob made it very fast now! Lots of speedups!
- PercussionChords or chords containing a mixture of Note and Unpitched objects are now supported! We're getting much closer to equal support for percussion as for pitched music!
- Multiple instruments can be in a part now and manipulated and exported to musicxml. This works simultaneously in voices, successively (broken before in musicxml), or overridden on a single note basis with n.storedInstrument.
- Full support for Python 3.9. Python 3.10 also seems to work with m21v7, but is not officially supported. Official support will come during the v.7 lifecycle unless it requires backward incompatible changes (unlikely). In keeping with music21 policy to support the last three versions of Python, version 7 will be the last version of music21 to support Python 3.7.
- The representation of many music21 objects has changed and become standardized to give a lot more information (what type of rest is it? What octave is the note in?) This should help with debugging and shouldn't affect anyone unless you are parsing repr() for information. (Don't do that). If you are creating your own Music21Object subclasses define _reprInternal() to return just internal information beyond the class name to get it right.
- Braille output respects lineLength configurations. Slurs work better too in braille.
MIDI import comes with measures already made for you!
- roman.romanNumeralFromChord() recognizes a bunch more chords including all augmented sixth chords in all inversions (except German7 which I can't figure out). And RomanNumeral now takes "It" alone to mean It+6, and same for the others -- it puts them in their most common inversions. To get root-position Aug6 chords, spell out their figures explicitly: It53, Ger7, Fr7, etc.
- Ornaments now realize with their key contexts. Trills are great.
- MIDI input now preserves channel and program numbers for MIDI output.
- Chris Reyes has contributed a formal grammar for TinyNotation which helped us find lots of bugs. Thanks!
- Write compressed musicxml directly by passing in a filename ending in .mxl.
- getContextByClass has configuration options that when called on a Stream let them look inside themselves for their own context.
- Beaming improvements in pickups and incomplete final measures.
- MusicXML and MIDI files that give a part name like "flute" but no instrument or program code will get a Flute object in music21. It's the least we can do. And if a score sets a MIDI-0 instrument but no part name and only a single staff, it's probably a default value and not a piano, so we just give a generic Instrument object.
Incompatible Changes that might affect casual users:
- Python 3.6 is no longer supported. Stay with 6.7.1 if you need that.
- The default extension for musicxml is now .musicxml and not .xml
- MIDI import comes with measures already made
- Stream.iter is now Stream.iter() -- the old format will work for one more version. (Most people just do "for el in s" anyhow, so not a big deal.
- findGaps() now returns Rest objects at the same place as the old Music21Objects. Makes it easier to add them back to the Stream to fill gaps.
- See above about if you're parsing repr() that representations have changed.
- n.pitch.accidental = 'sharp' is no longer allowed. Do n.pitch.accidental = pitch.Accidental('sharp') -- this is so that querying n.pitch.accidental afterwards returns the same object.
- Stream.sorted has become Stream.sorted(), but you probably should never call this anyhow, since all streams are always sorted unless you set .autoSort to False.
- stripTies() removes retainContainers parameter. They're always retained. Just call .flatten() after stripTies to remove them. MatchByPitch is also True by default now.
- Before running WindowedAnalysis on a Score, flatten it. (This came from the makeMeasures change)
- See the changes to instantiating a Stream with a list of elements above.
- note.SpacerRest() is gone. Use a normalRest with .style.hideObjectOnPrint set to True.
- ComposerPopularityFeature is gone. It was a fun routine that added the popularity of the composer by googling her or him and returning the log10 of the number of search results. But Google changed their API so it was no longer working. Too bad. (It's not working in v6 either)
- Dynamics, etc. now use "placement" instead of "positionPlacement"
- Now that Percussion chords are being used and unpitched objects will appear more often, do not assume that the only things in ".notes" are Notes and Chords. So if you want to call ".pitch" on the object, check that it is a Note, instead of checking that it is not a Chord.
Other improvements and fixes
*Add TempoChangeSpanner with subclasses RitardandoSpanner and AccelerandoSpanner. How these were missed is beyond me!
- ABC supports more chord formats including better durations (thanks Marian Schultz)
- Stream.splitAtDurations() now works and can efficiently remove all "complex" durations.
- A number of places where "coreElementsChanged()" weren't being called now are.
- NotRest objects all get .pitches attribute, which might be empty. Version 8 will add this to Rest objects as well, which will of course always be empty.
- Lots of docs typos fixed (thanks Meekohi)
- Plaintext (non-Regexp) lyric searching had bugs that are fixed
- Piano Scores can now have independen...
Maintenance release for v6.7 --
fixes bugs in lyric.search for working with "composite" lyrics, in the export of piano scores with key signatures, and a bug in piano scores and other part staffs that (a) prevented them from being flattened properly and (b) did not allow flattened piano scores to call `.show()
Other changes and improvements are going into the v7 / main branch.
Music21 v6.7 released
music21 v6.7 is released. This will likely be the last release on the v6 line (more later), which has seen remarkable speed and stability improvements. Here’s what’s new in the past month since 6.5 came out:
- Important bug fix: if you’ve had trouble loading
music21with an “importlib” error, this is fixed.
- Composite lyrics changes to the implementation in 6.5: multiple syllables on one note in a single verse (like in Italian, “Il bianco e dolce cigno”) now are imported to MusicXML property, stored in a Lyric.components object, and export to MusicXML properly.
- Lyrics searching finds all lyrics in all verses (and composite lyrics too)
- More major improvements to piano staff imports (thanks to Jacob Tyler Walls = JTW)
- RomanNumeral.isMixture() shows whether a chord is borrowed from the other mode (Mark Gotham)
- Several improvements in chord symbols (JTW + Alexandre Papadopoulos)
- More improvements to finding instrument names from MIDI (JTW)
- Duration marks in chords in ABC import properly (Marian Schultz)
- Documentation improvements.
- MusicXML parse failures now more often give the part and measure context (JTW)
- Substantial bug fixes in Stream.setElementOffset. Adds a new Stream.coreSetElementOffset for the dangerous but super fast version, and makes the original version safer. (JTW)
- Bug fixes in MEI articulations (heinzer) and accidentals (JTW)
- Bug fixes in external tools in windows including spaces (JTW)
- Channels handle better in MIDI (bearpelican)
- Humdrum files with positioned rests no longer crash (Phil Kirlin)
- OctaveRepeatingScale and CyclicalScale now usable as abstract classes (JTW)
- Articulations and expressions musicxml does not support are exported as (JTW)
- Better support for .musicxml as a file name within compressed .mxl files.
- Beaming in pickup measures is fixed.
- Stem directions can now be set automatically to coincide with beam groups. This is very useful if you are creating your own notation from scratch (as in VexFlow output; m21j gets the same routines)
- Spanner endHeight and startHeight are processed correctly (JTW)
- NoChord objects (in Chord Symbols) now retain their text (like “N.C.”) in more situations (JTW)
- All NotRest objects get a .pitches function – a small thing, but will be helpful in the future.
6.7 is likely the last release in version 6. We begin work on version 7 today! This means that most deprecated functions will be removed, to speed up the system and help build new things.
- Version 7 will require Python 3.7 as a minimum version. Python 3.6 will be end-of-life by November, and v.7 will last for at least into 2022. music21 will continue to support all Python versions that are actively maintained during the expected life of the version. v3.7-3.9 will be supported, and when 3.10 comes out, the next minor version of
music21will support it.
But dropping Py3.6 means some great changes:
- Many things that are NamedTuples will become dataclasses. (all but sortTuple). This will make working with a lot of data much better.
- Many many string options (such as notehead and beam types) will become Enums. This will help with avoiding making coding mistakes that are hard to detect. Where this has already happened (like in VoiceLeadingQuartet.MotionType) life has already become better. They will be StringEnums, and have a transition period, so code that checks for Beam.type == “start” or Lyric.syllabic == “begin” will still work (but I can never remember which is start and which is begin. Hence the point!)
- Substantial changes to Unpitched to make percussion support work.
- Some OrderedDicts (yuk!) will become normal dictionaries, now that insertion order is guaranteed to be preserved.
- Whatever else has been annoying me but I haven't been able to fix by committing to keep major versions backwards compatible.
- For simplifying the life of beginner users,
__dir__will be defined for certain key modules (like Note) so that all the typing and internal information isn't exposed.
- I'm hoping that getElementsByClass will be able to specify its return type, at least when called with a class. For people using Typing in Python, this will be a major improvement.
Deprecated functions gone ASAP:
- Chord.findRoot() -- just use chord.root() instead
- interval.convertSpecifier – use parseSpecifier instead
- formats.findFormat (and many others in the formats module etc.)
- humdrum.parseData, humdrum.parseFile (just use converter.parse)
- Editorial.misc (just stick it on editorial)
- Duration.updateQuarterLength (not needed)
- SpacerRest will become deprecated – just use a normal Rest with hideObjectOnPrint = True
- Setting a pitch.accidental to a number or string will be deprecated – create an Accidental object first
- setElementOffset deprecates two keywords: addElement and setActiveSite
- isClassOrSubclass to be deprecated, use Class in .classSet – WAY faster
- getClefs to be deprecated – use recurse().getElementsByClass(‘Clef’)
- getKeySignatures to be deprecated -- use recurse().getElementsByClass(‘KeySignature’)
- Stream.makeChords() to be deprecated – Chordify is the way to go.
- Stream.extendDurationsAndGetBoundaries – was meant to be deprecated in 6 and gone in 7. It gets a one version reprieve.
- stripTies.retainContainers to be deprecated – will always be True. Just call .flat afterwards to not get this.
- Stream.iter.variants to be deprecated. Just use .getElementsByClass(‘Variant’)
- tree.toStream.chordified() to be deprecated. It’s the internal guts of Chordify now
- VoiceLeading.color to be deprecated – set .style.color on notes like any other object
Weird changes of properties to methods:
Stream.iter()will be the encouraged new form instead of
Stream.sorted()will be encouraged new form instead of
- (This might not happen, but...)
Stream.flat-- similarly for
- Other properties where it is possible to encourage method calling will also get this change.
These methods were disguised as properties early on in
music21 and it was a bad mistake, leading to lots of problems with introspection. Migration will go like this: v7 -- new forms are allowed and documentation is updated to encourage it. v8 -- all mention of old forms will be removed from the system and where possible using the old form will send a DeprecationWarning. v9 -- old forms are removed.
Version 7 might take until the summer or beyond. (Hence there may be bug-fix versions of v6.7 along the way). So for now, enjoy what’s out there and look forward to the future. Master branch will move to v7 but will remain as stable as possible.
Thanks to the community for great support and as always to the Seaver Institute, National Endowment for the Humanities, and MIT for support of
Music21 v6.5 released
Happy New Year! I am pleased to announce that the newest Version of
music21, version 6.5 has been released. It is nearly completely backwards compatible with other v6 releases and runs on Python 3.6–3.8.
Music21 is an open-source toolkit for computational music theory and musicology, and also used in composition and music production. Download it via
pip install --upgrade music21
Version 6.5 adds several important new features since the bug-fix version 6.3 (from mid-November 2020) while squashing many bugs and speeding up a number of parts of the system. Many of the contributions were made by members of the open source community, including major contributions by Jacob Tyler Walls (JTW), Mark Gotham (MG), Néstor Nápoles López (NNL), and Paula Muñoz Lago.
PartStaffobjects such as a staff of a piano part now export properly back to MusicXML as one part with
<staff>tags. Huge work by JTW!
- RomanText is now a valid output format in addition to input! Save your analyses for later! Thanks Mark Gotham!
- search/lyrics now finds second and subsequent lyrics (thanks to Paula ML and DIDONE project)
- Improvements to VI and VII roman numerals in minor (JTW)
- MIDI tries to import part names from instruments (JTW)
- MIDI properly reads and writes conductor tracks (JTW)
- Doc improvements for many places including RomanNumerals, insertIntoNoteOrChord, chordify with GraceNote (MSC)
- Major speedups for many chord actions including getLeadingTone, isTriad, isMajorTriad, etc. (NNL + MSC w/ JTW)
music21loads or starts up in 1/3 the time as before. (MSC)
- Opus.write() improvements -- now all filenames of an Opus write call have similar names and only the last filename is returned (JTW)
- All properties in music21 are readable without raising an exception. This will help inspection/debugging software. (MSC)
- Staff-type is imported and exported properly to/from musicxml as the
.staffLinesis now settable on all Stream types (not just Parts) as a shortcut to manipulating
layout.StaffLayout().staffLinesat the start of the Stream. (MSC)
- roman.RomanNumeral.isNeapolitan() (MG)
Smaller features and bug fixes:
- midi.realtime.StreamPlayer now allows for non-blocking playing and for stopping at various points. (antran22)
- If scratch/temp directory is not writable or does not exist, use backup directories (JTW + Tanchihpin0517 )
- Use subprocess.run() for launching external tools (JTW)
- Deprecated method Environment.launch() is removed. (JTW)
- MusicXML reader selection improved, especially on Windows (MSC)
- Refactor of the musicxml subpackage for smaller files and more expandability (MSC)
- Default readers set for Unix (Thomas Wilson).
- RomanNumeral parsing improvements, esp. for chords like V7b5. (MSC)
- testing is moved to Github Actions for faster responses. Thanks to Travis-CI for years of support (MSC)
- works on Python 3.9 -- v6 is likely the last version to support py 3.6. (MSC)
- Instruments outside of voices are retained when making measures (JTW)
- all tests pass on Windows for windows developers. (JTW)
- better installation on conda-forge w/ a webcolors change (JTW)
- unmeasured scores export to MusicXML better (JTW)
- MIDI instruments no longer get incorrect durations (JTW)
- MIDI pitch bends are easier to understand (JTW)
- Improved tuplet brackets when number is not shown (JTW)
- Coverage improved (MSC + JTW)
- Better commonName for 0, 1, 2 note chords, and microtonal chords (MSC)
.show('scala')works on more scales. (JTW)
- More XML Chord symbols import (JTW)
- Fixes for aadd6 and other chord symbols where the name of the note ("A") is also present in the modifier ("Add") (JTW)
- Chord.quality returns "other" for C C# E G (MG)
- An empty degree-alter now matches MusicXML spec (JTW)
- ABC and MIDI parsing cleanups to make it easier for developers to extend (MSC)
- Very old musicxml files with empty "tie" elements parse better. (JTW)
- Improved handling of omitted pitches in RomanNumerals (JTW)
instrument.deduplicate()removes duplicate instruments at the same offset in a stream (JTW)
- Repeat endings with no number displayed now export to musicxml properly (JTW)
- Several routines such as findGaps were leaving Streams in corrupt states -- fixed (MSC)
partitionByInstrument()no longer leaves instruments with non-zero durations (MSC)
- MuseData reading works properly on zip files created on an OS with different line breaks (MSC)
Thanks always to the Seaver Institute, the NEH, and MIT for support on creating
I'm not sure if the next release will be v7 (with some backwards incompatible changes) or another v6 release (6.7). I do know that better piano support and percussion support are high on my lists. However, I'll be taking a bit of a break from music21 over January at least in order to get other publications out and work with my other projects. Happily, the community engagement with music21 has never been stronger and I'll still be here reviewing Pull Requests and thinking about the next steps!
-- Myke Cuthbert
Music21 v6.3 released
Music21 version 6.3 has been released. Biggest new feature is compatibility with macOS 11.0 Big Sur, whose numbering system change broke music21. Major bug of
corpus.search() on Windows not working should be fixed also. Chordify users get a nice upgrade also.
pip install --upgrade music21
This is primarily a bug fix release, so let's list the major bugs squashed first:
- Music21 gets the proper mac version and runs in Big Sur (thanks Daniel Fürst)
- corpus.search() should work on PC now. Sharing music21 scores that have been frozen and thawed should also work across Mac and PC.
- ChordSymbols preserve root and bass (thanks to Jacob Tayler Walls = JTW for this and so much else in this release!)
- Instrument names that cannot be decoded from MIDI do not crash MIDI parsing (JTW)
- Audio searches and other searches on empty streams are improved. (JTW)
- Non existent user scratch directory does not raise major bugs any more (David Garfinkle and JTW)
- New location for System/Preview on macOS since Catalina and musescore on Windows (MSC + JTW)
- remove() now searches endElements as well.
- Corrected octaves on pitches derived in IntervalNetwork.nextPitch() (JTW) -- should fix some weird scale pitch octaves.
- TextExpressions now have correct offsets when derived from a tempo indication or coda (JTW)
- MIDI files parsed multiple times with different quantization settings work properly (JTW)
- MIDI files with zero-length notes now create zero-length GraceNotes and not 1.0 length notes in music21 (JTW)
- All tests pass in Python 3.8 (now on to 3.9!)
- Beethoven Opus 59 no 3 mvmt 4 contained all 4 movements in it. Now it only contains movement 4.
- MIDI's matchedNoteOff was not working properly. Works now (Thanks SunWoong KIM)
- If two keys had the same likelihood in probe-tone analysis then only one appeared in .alterateInterpretations. Now there will always be a 23-element list. (ZM-J + JTW)
- C-version of Python Levenshtein was sometimes not being called even if installed. This will greatly speed up similarity searching.
- Harmony.addChordStepModification gets an
updatePitches=Trueattribute that will immediately apply the chordStepModification to the computed pitches. The default of False remains for now, but will become True in music21 v.7.
- Chordify and Verticality.makeChords gets a new keyword attribute "copyPitches=False" which makes it so that the original pitches (and not deepcopies) from the score appear in the chordified score. This can make it MUCH easier to see which pitches in a chordified score relate to the pitches in the original. However, they are identical objects, so changing one later will change the other. Default behavior is unchanged.
- Repeats play back properly in MIDI (JTW)
- Improved Docs (configuration instructions, typos, examples) (many people but especially JTW)
- Much better typing all around for developers
- math.log2 used instead of math.log(x, 2) for no more floating point confusion in many quarterLengths (JTW)
- Braille keeps its debugging information in Note.editorial instead of custom attributes (backwards incompatible change, but okay)
- Braille/runAllBrailleTests improved for non-sighted developers.
- Incomplete 7th/9th/11th chords find roots better (JTW)
- Legacy code for Python 3.5 removed (JTW)
- Augmented sixth RomanNumerals work w/o needing a key. Also work with secondary numerals (JTW)
- Bach chorales sort by BWV as a number rather than a string (JTW)
- Beethoven quartets from Project Gutenberg had hidden voices w/ incorrect durations to show playback of trills, etc. Those voices have been removed. Speeds up the parsing of those pieces greatly, and gives better feature extractions. Affected pieces are opus 59.1.3, 59.1.4, 59.2.1, 59.2.2, 59.3.2, 59.3.3, 59.3.4, and opus 133.
- Improvements to instrument name lookups (Thanks Mark Gotham)
- Unnecessary list comprehensions are removed.
- For running tests, missing optional modules and Lilypond. will cause import errors.
- ABC module has been partially cleaned up, and made easier for developers to hack new ABC extensions to.
as this is a 6.X release, we have tried to keep backwards incompatible changes to a bare minimum, but a few obscure cases are changed:
.beatStrengthon notes without a TimeSignature or MetronomeMark context now return
naninstead of raising an exception.
.beatStrreturns the string
"nan". Python 3.8's mock methods iterate through all properties before setting up the mocked object and properties that might raise exceptions cause problems. This seems like a good direction to go in, so please expect that all property getters will switch to never raising an exception but giving
nanor another failure indicator in the future.
- KrumhanslSchmucker and KrumhanslKessler probe tone analysis are now identical. The difference before was probably a typo. They are now synonyms for each other.
Thanks always to the Seaver Institute, the National Endowment for the Humanities, and the School of Humanities, Arts, and Social Sciences and the Music and Theater Arts Section of MIT for their support in making music21 possible. And can we all give applause to Jacob Tayler Walls for all the great work done on this release!!!
Music21 v6 is OUT as v6.1.0! This represents over 500 commits over the past 14 months since v5.7 was released.
Many thanks to Jacob Tyler Walls (JTW below) who made so many contributions to the v6 branch, both big and small. Mad props and round of applause!
v6 fully supports Python 3.8 and removes support for Python 3.5. v6 will be the last major release to support Python 3.6 and we will work on Python 3.9 support immediately.
As with all new
v.X releases of
music21 there are improvements and some backwards incompatible changes (not too many)
In no particular order, here are the things to look for in the new music21 v6:
Type hints throughout music21 -- when you program with a sophisticated IDE you will be able to see what is returned and required as attributes in much of music21.
music21 is no longer packaged with external modules; these will be installed when installing music21 via pip (otherwise run
pip install -r requirements.txt). Speed and security improvements come with this.
converter.parse('file.mid', quantizePost=False)will let you load in a MIDI file without any quantizing. (Thanks JTW)
Lots more values cached = faster music21; RomanNumerals in particular are over an order of magnitude faster, and Chords are faster too. If you ever have a problem, all Music21Objects have a .clearCache() function. Just add @cacheMethod as a decorator to a method and it will use the caching routine.
Intervals have been rewritten to use properties entirely. So whatever happens to an Interval, its
semiSimpleNiceName(to take one of dozens of examples) will always be up to date. Intervals use
Specifiersthat are enums like
interval. Specifier.PERFECTinstead of inscrutable numbers. (those inscrutable numbers still work though) Specifiers are more than just standard enums -- they can invert themselves, do
semitonesAboveMajor()etc. Interval geeks rejoice.
Intervals given a noteStart and a name will generate noteEnd automagically. They also get transposePitch() improvements along the way.
transposePitchFromC()which takes a pitch in C major and returns the pitch in the same scale degree in this key..
Voices with gaps in them work way better in MusicXML. Repeat endings with multiple numbers like 1,2 r/t with musicxml (JTW)
TSV files which encode harmonic analysis can now be parsed (Thanks Mark Gotham)
harmspines parse now, giving another way of encoding harmonic analysis. (Thanks Néstor Nápoles López)
MIDI refactor: easier to subclass and extend and with many docs -- keeps a clear distinction between strings and bytes. MIDI values are all Enum classes (but IntEnums so they compare well with pure numbers)
StripTies works much better thanks to JTW -- and does not filter out non-Notes anymore (technically an incompatibility, but really a bug fix). Voices, etc. don't faze
.stripTies()any more. Stream.voicesToParts() also preserves more elements. Chords with some notes tied and some don't no longer get merged. Note that stripTies
retainContainersdefaults to True now, because getting the opposite behavior is as easy as a
Internal but important: lots of parts of music21 code that used abbreviations now spell out the whole word. This is important for our friends using screen readers. While music21 will (for historical/compatibility reasons) still use
camelCasefor all method names, attribute names, etc., internal variables may now use
underscore_casewhich helps with screen readers.
Stream().write('mxl')will write compressed musicxml (JTW). Or
write('...', format='musicxml', compress=True)
Improvements to VoiceLeadingQuartets (thanks Ryaan Ahmed), including finding parallel intervals with octave displacement. voiceCrossing and voiceOverlap detection.
Substantial improvements to RomanText: see https://dmitri.mycpanel.princeton.edu/romantext.pdf
RomanNumerals can specify how they represent ^6 and ^7 in minor with
OMR fixers can recognize Turns and other ornaments. More merging here to come. Thanks Janelle Sands!
Substantial improvements to beaming routines and tests (thanks Almog Cohen!)
Keys now have
.deriveByDegree()like Scales, so "What minor key has scale degree 3 as B-flat?" can easily be answered.
Improvements to dotted tuplets (Almog Cohen)
Chord.name/fullName now gives better names for common chords like Major/Minor triads -- no longer relies entirely on chord.tables. But even there many improvements and spelling corrections.
.notesto get at the notes that make up a chord, in a different way than
for n in Chord-- I'm still an old Perl guy, sometimes There's More Than One Way to Do It, and this way makes some things conceptually much easier and faster.
More Bach Chorale fixes from Doctor Schmidt (thanks!)
StringIndication, FretIndication work in musicxml (thanks Peter Mitrano)
For those who are adventurous -- intervalNetworks are now exposed on scales.
prebase.ProtoM21Object-- an idea ported back from
music21j: nearly every object in
music21, including all Music21Objects, inherits from this super-lightweight base class which allows for querying classes and giving consistent representations. It makes working in music21 a lot more fun.
- Stream filters now return a new StreamIterator. So old code like:
s = stream.Stream() sIter = s.iter sIter.getElementsByClass('Chord') list(sIter)
should now be written as:
s = stream.Stream() sIter = s.iter sIter2 = sIter.getElementsByClass('Chord') list(sIter2)
For most people using filters within a for-loop, nothing will appear to have changed.
if element in streamnow only returns True if the element is actually in the Stream, not if element is equal to something in the Stream. This is not normal Python behavior for
__contains__but it is something music21 users have counted on for a decade, and now it is assured.
MIDI has been completely refactored, so if you are mucking with MIDI internals, it's going to be completely different. If you're just using
.write('midi')it won't have changed much.
- Setting a pitch's accidental to a number is deprecated and to be removed soon. use
b = pitch.Pitch('B4'); b.accidental = pitch.Accidental(-1).
- some long deprecated functions removed, such as Stream.restoreActiveSites, Stream. _yieldReverseUpwardsSearch, common.standardDeviation (use statistics.stdev instead).
- Chord sort methods no longer return the chord itself if
- interval.convertSemitoneToSpecifierGenericMicrotone, convertSemitoneToSpecifierGeneric now return a Specifier Enum as their first value
- Spelling corrections that are technically incompatible: Interval.perfectable replaces typo Interval.prefectable. Appoggiatura is spelled correctly with two-gs everywhere it's used (JTW)
stripTies(retainContainers=True)is now the default.
- Half-diminished chords have ø7 etc. as their default representation.
- MIDI.intsToHexString has become MIDI.intsToHexBytes which does what is says it does.
Small Changes/Bugs squashed:
- A malformed spanner in musicxml will no longer crash parsing.
- Tuplets are equal if their durations are equal. Better docs for duration equality.
activeSiteOnlykeyword for searching activeSite only. Speed!
music21.X import *works much more reliably.
- Bugs fixed in feature extraction of keys.
serialallows "P" or "T" to be used for transpositions
- Tone-Rows give their row in the repr.
- Historical tone-rows no longer have Row in their name. For instance:
serial.getHistoricalRowByName('SchoenbergOp37').matrix()-- the old form still works though.
- Feature extraction on empty streams (or ones that don't have instruments or something else) works properly (JTW)
- Feature output formats can set
.extdirectly, in case you need a different extension.
- viio7 can be specified as vii07
- Interval: reverse=True works properly
- subprocess.run is used instead of os.system for PNG generation. Thanks Uğur Güney. Fixes using musescore with music21 in Jupyter when spaces appear in filenames. (also thanks to Frank Zalkow)
- Better representation for many objects
- Error handling for incorrect chord abbreviation is improved. Thanks Vikram Natarajan
- Librettists and lyricists can be searched in metadata.
.age()works properly for living composers.
- MIDI plays back properly in Jupyter again BUT also does not add a delay when writing out a file.
- Voice numbers in generated musicxml are now low numbers
- pitch.Accidental gets
. setAttributeIndependently()in case you want something to look like a flat but only alter 0.8 semitones. (This appeared in v.5 at some point but was never announced)
- Note gets a
pitchChanged()method which is called by its attached pitch anytime it changes so that caches can be used. Pitch gets an
informClient()method which is called anytime the pitch itself changes. There is something similar in Chords too. This squashes a lot of bugs where pitches were changing but notes/chords/scales/etc. did not act like they had changed.
- makeAccidentals works properly in Voices (JTW)
- MIDI parsing gets more instrument objects from more places (JTW)
- zero-length objects at the end of streams were being ignored by makeNotation (JTW)
- Show formats: MuseScore 3.5 compatibility. (JTW). Preview is found by default on macOS Catalina/Big Sur -- still works for older OSes. No more 'is your doc > 999 pages?' bugs!
- Some Neo-Riemannian docs weren't showing (thanks Adam Spiers)