Skip to content

Add a LyricIdentifiers detail, so lyrics can be compared without them #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rdebroiz wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add a LyricIdentifiers detail, so lyrics can be compared without them #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions musicdiff/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ def diff(
AllObjects), or any combination (with | or &~) of those or NotesAndRests,
Beams, Tremolos, Ornaments, Articulations, Ties, Slurs, Signatures,
Directions, Barlines, StaffDetails, ChordSymbols, Ottavas, Arpeggios, Lyrics,
Style, Metadata, Voicing, or NoteStaffPosition.
LyricIdentifiers, Style, Metadata, Voicing, or NoteStaffPosition.

Returns:
int | None: The total OMR Edit Distance, i.e. the number of individual symbols
Expand Down Expand Up @@ -355,7 +355,7 @@ def diff_ml_training(
AllObjects), or any combination (with | or &~) of those or NotesAndRests,
Beams, Tremolos, Ornaments, Articulations, Ties, Slurs, Signatures,
Directions, Barlines, StaffDetails, ChordSymbols, Ottavas, Arpeggios, Lyrics,
Style, Metadata, Voicing, or NoteStaffPosition.
LyricIdentifiers, Style, Metadata, Voicing, or NoteStaffPosition.

Returns:
tuple[float, str]: Overall OMR-NED score for the batch, and the full path to the
Expand Down
14 changes: 10 additions & 4 deletions musicdiff/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
'''
if __name__ == '__main__':
usage: str = '''python3 -m musicdiff [-h]
[-i [{decoratednotesandrests,otherobjects,allobjects,style,metadata,voicing,notestaffposition,notesandrests,beams,tremolos,ornaments,articulations,ties,slurs,signatures,directions,barlines,staffdetails,chordsymbols,ottavas,arpeggios,lyrics} ...]]
[-x [{decoratednotesandrests,otherobjects,allobjects,style,metadata,voicing,notestaffposition,notesandrests,beams,tremolos,ornaments,articulations,ties,slurs,signatures,directions,barlines,staffdetails,chordsymbols,ottavas,arpeggios,lyrics} ...]]
[-i [{decoratednotesandrests,otherobjects,allobjects,style,metadata,voicing,notestaffposition,lyricidentifiers,notesandrests,beams,tremolos,ornaments,articulations,ties,slurs,signatures,directions,barlines,staffdetails,chordsymbols,ottavas,arpeggios,lyrics} ...]]
[-x [{decoratednotesandrests,otherobjects,allobjects,style,metadata,voicing,notestaffposition,lyricidentifiers,notesandrests,beams,tremolos,ornaments,articulations,ties,slurs,signatures,directions,barlines,staffdetails,chordsymbols,ottavas,arpeggios,lyrics} ...]]
[-o [{visual,v,text,t,omrned,o} ...]]
[--fix_first_file_syntax]
file1 file2
Expand All @@ -37,8 +37,8 @@
--ground_truth_folder gtfolderpath
--predicted_folder predfolderpath
--output_folder outputfolderpath
[-i [{decoratednotesandrests,otherobjects,allobjects,style,metadata,voicing,notestaffposition,notesandrests,beams,tremolos,ornaments,articulations,ties,slurs,signatures,directions,barlines,staffdetails,chordsymbols,ottavas,arpeggios,lyrics} ...]]
[-x [{decoratednotesandrests,otherobjects,allobjects,style,metadata,voicing,notestaffposition,notesandrests,beams,tremolos,ornaments,articulations,ties,slurs,signatures,directions,barlines,staffdetails,chordsymbols,ottavas,arpeggios,lyrics} ...]]
[-i [{decoratednotesandrests,otherobjects,allobjects,style,metadata,voicing,notestaffposition,lyricidentifiers,notesandrests,beams,tremolos,ornaments,articulations,ties,slurs,signatures,directions,barlines,staffdetails,chordsymbols,ottavas,arpeggios,lyrics} ...]]
[-x [{decoratednotesandrests,otherobjects,allobjects,style,metadata,voicing,notestaffposition,lyricidentifiers,notesandrests,beams,tremolos,ornaments,articulations,ties,slurs,signatures,directions,barlines,staffdetails,chordsymbols,ottavas,arpeggios,lyrics} ...]]

'''
epilog: str = '''\
Expand Down Expand Up @@ -102,6 +102,7 @@
'metadata',
'voicing',
'notestaffposition',
'lyricidentifiers',

'notesandrests',
'beams',
Expand Down Expand Up @@ -135,6 +136,7 @@
'metadata',
'voicing',
'notestaffposition',
'lyricidentifiers',

'notesandrests',
'beams',
Expand Down Expand Up @@ -246,6 +248,8 @@
detail |= DetailLevel.Metadata
elif det == 'notestaffposition':
detail |= DetailLevel.NoteStaffPosition
elif det == 'lyricidentifiers':
detail |= DetailLevel.LyricIdentifiers

# bits in the DecoratedNotesAndRests combo
elif det == 'notesandrests':
Expand Down Expand Up @@ -300,6 +304,8 @@
detail &= ~DetailLevel.Metadata
elif det == 'notestaffposition':
detail &= ~DetailLevel.NoteStaffPosition
elif det == 'lyricidentifiers':
detail &= ~DetailLevel.LyricIdentifiers

# bits in the DecoratedNotesAndRests combo
elif det == 'notesandrests':
Expand Down
17 changes: 9 additions & 8 deletions musicdiff/annotation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def __init__(
AllObjects), or any combination (with | or &~) of those or NotesAndRests,
Beams, Tremolos, Ornaments, Articulations, Ties, Slurs, Signatures,
Directions, Barlines, StaffDetails, ChordSymbols, Ottavas, Arpeggios, Lyrics,
Style, Metadata, Voicing, or NoteStaffPosition.
LyricIdentifiers, Style, Metadata, Voicing, or NoteStaffPosition.
'''
super().__init__(general_note)
self.is_in_chord: bool = False
Expand Down Expand Up @@ -672,7 +672,7 @@ def __init__(
AllObjects), or any combination (with | or &~) of those or NotesAndRests,
Beams, Tremolos, Ornaments, Articulations, Ties, Slurs, Signatures,
Directions, Barlines, StaffDetails, ChordSymbols, Ottavas, Arpeggios, Lyrics,
Style, Metadata, Voicing, or NoteStaffPosition.
LyricIdentifiers, Style, Metadata, Voicing, or NoteStaffPosition.
'''
super().__init__(extra)
self.kind: str = M21Utils.extra_to_kind(extra)
Expand Down Expand Up @@ -894,7 +894,7 @@ def __init__(
AllObjects), or any combination (with | or &~) of those or NotesAndRests,
Beams, Tremolos, Ornaments, Articulations, Ties, Slurs, Signatures,
Directions, Barlines, StaffDetails, ChordSymbols, Ottavas, Arpeggios, Lyrics,
Style, Metadata, Voicing, or NoteStaffPosition.
LyricIdentifiers, Style, Metadata, Voicing, or NoteStaffPosition.
'''
super().__init__(lyric_holder)

Expand All @@ -911,7 +911,8 @@ def __init__(
if lyric.number is not None:
self.number = lyric.number

if (lyric._identifier is not None
if (DetailLevel.includesLyricIdentifiers(detail)
and lyric._identifier is not None
and lyric._identifier != lyric.number
and lyric._identifier != str(lyric.number)):
self.identifier = lyric._identifier
Expand Down Expand Up @@ -1027,7 +1028,7 @@ def __init__(
AllObjects), or any combination (with | or &~) of those or NotesAndRests,
Beams, Tremolos, Ornaments, Articulations, Ties, Slurs, Signatures,
Directions, Barlines, StaffDetails, ChordSymbols, Ottavas, Arpeggios, Lyrics,
Style, Metadata, Voicing, or NoteStaffPosition.
LyricIdentifiers, Style, Metadata, Voicing, or NoteStaffPosition.
'''
super().__init__(voice)
note_list: list[m21.note.GeneralNote] = []
Expand Down Expand Up @@ -1176,7 +1177,7 @@ def __init__(
AllObjects), or any combination (with | or &~) of those or NotesAndRests,
Beams, Tremolos, Ornaments, Articulations, Ties, Slurs, Signatures,
Directions, Barlines, StaffDetails, ChordSymbols, Ottavas, Arpeggios, Lyrics,
Style, Metadata, Voicing, or NoteStaffPosition.
LyricIdentifiers, Style, Metadata, Voicing, or NoteStaffPosition.
'''
super().__init__(measure)
self.includes_voicing: bool = DetailLevel.includesVoicing(detail)
Expand Down Expand Up @@ -1411,7 +1412,7 @@ def __init__(
AllObjects), or any combination (with | or &~) of those or NotesAndRests,
Beams, Tremolos, Ornaments, Articulations, Ties, Slurs, Signatures,
Directions, Barlines, StaffDetails, ChordSymbols, Ottavas, Arpeggios, Lyrics,
Style, Metadata, Voicing, or NoteStaffPosition.
LyricIdentifiers, Style, Metadata, Voicing, or NoteStaffPosition.
'''
super().__init__(part)
self.part_idx: int = part_idx
Expand Down Expand Up @@ -1720,7 +1721,7 @@ def __init__(
AllObjects), or any combination (with | or &~) of those or NotesAndRests,
Beams, Tremolos, Ornaments, Articulations, Ties, Slurs, Signatures,
Directions, Barlines, StaffDetails, ChordSymbols, Ottavas, Arpeggios, Lyrics,
Style, Metadata, Voicing, or NoteStaffPosition.
LyricIdentifiers, Style, Metadata, Voicing, or NoteStaffPosition.
'''
super().__init__(score)
self.part_list: list[AnnPart] = []
Expand Down
11 changes: 11 additions & 0 deletions musicdiff/detaillevel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,13 @@ class DetailLevel(IntEnum):
# into every affected note. If this is set, NotesAndRests will also be considered set.
NoteStaffPosition = 1 << 18

# The names the encoding gives to the lyric verses ('verse', 'part1verse1', etc).
# They print nothing in the score, so they are off by default; turn them on to
# compare them.
# Note that if Lyrics is not also requested, no lyric identifier differences
# will be found.
LyricIdentifiers = 1 << 19

# default detail level is all objects:
Default = AllObjects

Expand Down Expand Up @@ -193,6 +200,10 @@ def includesVoicing(cls, val: int) -> bool:
def includesNoteStaffPosition(cls, val: int) -> bool:
return val & cls.NoteStaffPosition != 0

@classmethod
def includesLyricIdentifiers(cls, val: int) -> bool:
return val & cls.LyricIdentifiers != 0

@classmethod
def _included_m21_types(cls, val: int) -> tuple[t.Type, ...]:
# Not all types go in here, just the ones where we will have pulled
Expand Down