FretBend supports alter (interval), prebend, and release #1580

adhooge · 2023-05-23T14:40:56Z

Hi! First PR so I expect a few things to be added/modified but here's a first draft.
I've updated the FretBend articulation so that it includes the musicXML properties bendAlter, preBend and release.

It goes round from musicXML to m21 back to mXML.

I've not written any tests yet because I'm not sure what to add. Let me know of what could be good to add!

as a PR newbie, I also have some irrelevant commits that I manually reverted. If that's a problem I'll try to clean that up.

mscuthbert

Well on its way! Ask around if you need help in writing tests, and for help on why music21's system of intervals is more complex than musicxml's.

(the changes to note.Note are rejected, so please remove them, thanks!)

music21/articulations.py

mscuthbert · 2023-05-24T15:02:13Z

music21/articulations.py

+    release: t.Optional[float]
+    withBar: t.Optional[bool]
+
+    def __init__(self, number=0, preBend=False, release=None, withBar=None, **keywords):


number is too generic a term -- and we usually reserve the term for identifying which of multiple simultaneous items (like slur number=1 vs slur number=2). Are fret-bends always chromatic intervals? it seems like you can also have a diatonic interval of a fretbend. hence why bendAlter was typed as IntervalBase not ChromaticInterval. It seems better to have bendAlter as described above interval.IntervalBase | None = None where None indicates unspecified. Having a default of 0, becoming ChromaticInterval(0) indicates that this fretBend does not alter the pitch at all, which would be a very strange fret bend. This would also make it so that interval.py does not need to be imported here.

The other keywords should be typed in the __init__ declaration in addition to the class.

We no longer use t.Optional[X] in the code base. Use X | None instead.

Changed with d63c78a

mscuthbert · 2023-05-24T15:04:38Z

music21/articulations.py

+        bend indication for fretted instruments
+
+        bend in musicxml
+
+        number is the interval of the bend in number of semitones, bend-alter in musicxml
+        preBend indicates wether the note is prebended or not
+        release is the offset value for releasing the bend, if Any
+        withBar indicates if the bend is done using a whammy bar movement


Capitalization and use asterisks and line breaks for documentation -- run documentation/build.py and look at the difference between the docs produced here and elsewhere in the system.

preBend indicates wether the note is prebended or not -- I don't know what prebended means.

what is release measured in? Is it an offset (which is relative to the start of the Measure/stream)? That doesn't sound right. Is it a quarterLength measured from the start of the note? or from the end of the note.

withBar doc is fine.

I've tried to improve it in 03e6117
Let me know if that seems good to you

tests are on their way

mscuthbert · 2023-05-24T15:08:53Z

music21/musicxml/m21ToXml.py

+            bendAlterSubElement = SubElement(mxTechnicalMark, 'bend-alter')
+            bendAlterSubElement.text = str(articulationMark.bendAlter.semitones)


this has enough ifs that it should be brought out as its own small method that allows for easier documentation and testing. articulationMark will probably need to be cast as a FretBend.

We can solve the case of GenericInterval later, which doesn't have .semitones. Perhaps it always needs to be a full Interval object or None.

New submethod added in 85cc6a8
Now I indeed have the problem that I need to retrieve the number of semitones. I could probably do something with GenericInterval.value but I don't know how to do the conversion properly

mscuthbert · 2023-05-24T15:10:01Z

music21/musicxml/m21ToXml.py

+                releaseSubElement = SubElement(mxTechnicalMark, 'release')
+                releaseSubElement.set('offset', str(articulationMark.release))


musicxml's definition of offset is very different from music21's and (despite me now being editor of the musicxml spec) we shouldn't use musicxml offsets anywhere in music21 -- these need to be converted according to the current divisionsPerQuarter setting.

should work with d93af6d though I need to write the tests

mscuthbert · 2023-05-24T15:12:41Z

music21/musicxml/xmlToM21.py

                if mxObj.get('substitution') is not None:
                    tech.substitution = xmlObjects.yesNoToBoolean(mxObj.get('substitution'))
+            if tag == 'bend':
+                tech.bendAlter = interval.Interval(int(mxObj.find('bend-alter').text))


this has too many potentials for crashing the processing. What if there is no bend-alter or no bend-alter.text? check that before typing to assign.

(Better to call out into a separate sub-method. This method was designed just for one-to-two lines per technical

sub-method and bend-alter check in 2e1ea43

mscuthbert · 2023-05-24T15:13:22Z

music21/musicxml/xmlToM21.py

+                if mxObj.find('pre-bend') is not None:
+                    tech.preBend = True
+                if mxObj.find('release') is not None:
+                        tech.release = int(mxObj.find('release').get('offset'))


as above -- offset needs to be converted to music21 quarterLengths.

except clause without Try.

Both fixed with 58eeb04

mscuthbert · 2023-05-24T15:13:33Z

music21/musicxml/xmlToM21.py

+                        tech.release = int(mxObj.find('release').get('offset'))
+                    except TypeError:
+                        # offset is not mandatory
+                        tech.release = 0


release is a float. needs to be 0.0

also fixed with 58eeb04

mscuthbert · 2023-05-24T15:14:38Z

music21/note.py

+from music21 import articulations

 if t.TYPE_CHECKING:
    from music21 import articulations


as above -- alphabetical and remove from type-checking if imported at top. (but won't be necessary).

mscuthbert · 2023-05-24T15:19:49Z

music21/note.py

+    @property
+    def string(self):


this new property and all properties below are rejected. Note is the most common object in music21 and users who are not working with guitar music will never use these routines but will need to figure out what they mean in the docs. (we don't have "accent" or "staccato" etc. either) -- and parallel routines would need to be added to Chord, etc.

In general for any mature open-source project, don't make additions or substantive changes to core parts of the system without a prior discussion.

oops sorry about that, they were just for my personal convenience. Removed with 0b2074f

mscuthbert · 2023-07-01T08:59:43Z

Hello -- just as a note (from the music21list Google Group) I'm taking a sabbatical from reviewing music21 issues and PRs until at least Jan 1, 2024, so this PR will be deferred until then.

adhooge · 2023-07-10T06:54:40Z

Hello Michael, sorry for not being able to finish this PR sooner. Enjoy your sabbatical! Hopefully my PR will be ready for approval when you come back 🤞

adhooge · 2025-05-05T13:16:26Z

Hello @mscuthbert !
Apologies for the very long delay, I had difficulties finding time for finishing this PR, but I'm hopeful it can be done by the end of the month :)

I think I have addressed all your comments, let me know if there is anything I should improve further!

Best,

mscuthbert

Hi adhooge I'm realizing that for some reason you don't have permissions to run the Github Actions here automatically (I think you get them the first time you open a PR that passes)

Make sure that you're running python music21/test/multiprocessTest.py before pushing here -- you have tests that aren't passing -- as soon as I noticed that I stopped reviewing for now.

If you want to open up a dummy PR that changes one letter (like add a period somewhere it's missing) point to this comment and I'll merge it so you have full actions rights. (Or point me to some web resource that tells me how to exempt you from the hold back until you have it).

music21/articulations.py

music21/musicxml/m21ToXml.py

adhooge · 2025-05-13T10:09:17Z

Hi mscuthbert apologies for the missed test, I updated them and also made a dummy PR so that I can run github actions to check linting etc.:
#1776

coveralls · 2025-05-13T17:45:25Z

coverage: 93.01% (+0.004%) from 93.006%
when pulling 7e8a800 on adhooge:pr-bend
into 9e84df1 on cuthbertLab:master.

adhooge · 2025-05-14T10:25:28Z

It seems I got all the coveted green ticks! There might still be a few changes required. I'm thinking in particular about the fact that I had to import interval and OffsetQL to get the typing tests to pass. They should probably only be imported for type checking? I'll wait for your feedback on that before changing it

Thank you very much for your reactivity and detailed answers mscuthbert, it was very helpful!

mscuthbert

Congrats! Looks great!

mscuthbert · 2025-05-14T21:43:28Z

This is a really significant contribution for a first PR. Congrats! Hope it was a good enough experience that there will be many more.

I'm planning on doing a release by July 1 or when we get the Piano Pedal PRs in whichever comes first.

adhooge · 2025-05-15T08:07:48Z

Thank you very much for your kind help throughout the process (that spanned over several years!!)
It was a great experience and I'm very happy and proud to contribute to this great library :)

I won't hesitate to contribute more in the future!

adhooge and others added 17 commits November 21, 2022 17:00

⤴️ bend export

03fdb47

add some properties to note.Note

aca37e2

fix missing import

7118189

FretBend: update preBend type

766a113

FretBend: update Release type

17bc30d

noteToNotations: export string fret art in chord

4bcdffc

new changes

274c904

Merge remote-tracking branch 'upstream/master'

0fdac57

read bends

6d778f1

restore README

7e6ced8

single quotes

ef52fe0

typing withBar

e3f88ee

python3.9 compatibility

f1eae7d

remove useless files

22d07da

bendAlter typing

c157a53

rm useless file

67540ea

restore file

34ecc42

mscuthbert requested changes May 24, 2023

View reviewed changes

Alexandre D'Hooge and others added 10 commits March 18, 2024 12:20

fix some conflicts

13ac21f

add some properties to note.Note

9c3b1a3

fix missing import

0839230

finish rebase

cd534fe

FretBend: update Release type

b1c9277

noteToNotations: export string fret art in chord

caa8bd2

new changes

a21d3f6

read bends

7855e26

restore README

b95c2c0

single quotes

97297be

adhooge and others added 5 commits August 19, 2024 10:43

add tests

daa6848

Merge branch 'cuthbertLab:master' into pr-bend

b0b66aa

Merge branch 'pr-bend' of github.com:adhooge/music21 into pr-bend

e3749de

use number as a positional argument

4c585ea

remove duplicate technical_mark

91e9f84

adhooge marked this pull request as ready for review May 7, 2025 08:32

adhooge requested a review from mscuthbert May 12, 2025 07:06

mscuthbert requested changes May 13, 2025

View reviewed changes

music21/articulations.py Show resolved Hide resolved

music21/articulations.py Show resolved Hide resolved

music21/articulations.py Show resolved Hide resolved

music21/articulations.py Show resolved Hide resolved

music21/musicxml/m21ToXml.py Show resolved Hide resolved

fix doctests

a79a6dc

adhooge mentioned this pull request May 13, 2025

Minor doc update: User's guide Chords #1776

Merged

adhooge and others added 9 commits May 14, 2025 11:29

fix some writing

51e8ee5

update test

d4e175d

unindent arguments

9879148

import interval for pylint

b39ea71

import OffsetQL for pylint

243f3b6

remove trailing whitespace

9a17ec8

fix indentation for flake8

3fc5849

add FretBend type checking

d1ff663

Merge branch 'cuthbertLab:master' into pr-bend

d021fed

adhooge added 2 commits May 14, 2025 12:27

minor improvements on the documentation

2447e4e

Merge branch 'pr-bend' of github.com:adhooge/music21 into pr-bend

7e8a800

mscuthbert approved these changes May 14, 2025

View reviewed changes

mscuthbert changed the title ~~FretBend update~~ FretBend supports alter (interval), prebend, and release May 14, 2025

mscuthbert merged commit ed245aa into cuthbertLab:master May 14, 2025
8 checks passed

		bendAlterSubElement = SubElement(mxTechnicalMark, 'bend-alter')
		bendAlterSubElement.text = str(articulationMark.bendAlter.semitones)

		releaseSubElement = SubElement(mxTechnicalMark, 'release')
		releaseSubElement.set('offset', str(articulationMark.release))

FretBend supports alter (interval), prebend, and release #1580

FretBend supports alter (interval), prebend, and release #1580

Uh oh!

Conversation

adhooge commented May 23, 2023

Uh oh!

mscuthbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mscuthbert commented Jul 1, 2023

Uh oh!

adhooge commented Jul 10, 2023

Uh oh!

adhooge commented May 5, 2025

Uh oh!

mscuthbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adhooge commented May 13, 2025

Uh oh!

coveralls commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adhooge commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mscuthbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mscuthbert commented May 14, 2025

Uh oh!

adhooge commented May 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

coveralls commented May 13, 2025 •

edited

Loading

adhooge commented May 14, 2025 •

edited

Loading