/
VoiceGenerator.ts
1122 lines (1075 loc) · 49.9 KB
/
VoiceGenerator.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { LinkedVoice } from "../VoiceData/LinkedVoice";
import { Voice } from "../VoiceData/Voice";
import { MusicSheet } from "../MusicSheet";
import { VoiceEntry, StemDirectionType } from "../VoiceData/VoiceEntry";
import { Note, TremoloInfo } from "../VoiceData/Note";
import { SourceMeasure } from "../VoiceData/SourceMeasure";
import { SourceStaffEntry } from "../VoiceData/SourceStaffEntry";
import { Beam } from "../VoiceData/Beam";
import { Tie } from "../VoiceData/Tie";
import { TieTypes } from "../../Common/Enums/";
import { Tuplet } from "../VoiceData/Tuplet";
import { Fraction } from "../../Common/DataObjects/Fraction";
import { IXmlElement } from "../../Common/FileIO/Xml";
import { ITextTranslation } from "../Interfaces/ITextTranslation";
import { LyricsReader } from "../ScoreIO/MusicSymbolModules/LyricsReader";
import { MusicSheetReadingException } from "../Exceptions";
import { AccidentalEnum } from "../../Common/DataObjects/Pitch";
import { NoteEnum } from "../../Common/DataObjects/Pitch";
import { Staff } from "../VoiceData/Staff";
import { StaffEntryLink } from "../VoiceData/StaffEntryLink";
import { VerticalSourceStaffEntryContainer } from "../VoiceData/VerticalSourceStaffEntryContainer";
import log from "loglevel";
import { Pitch } from "../../Common/DataObjects/Pitch";
import { IXmlAttribute } from "../../Common/FileIO/Xml";
import { CollectionUtil } from "../../Util/CollectionUtil";
import { ArticulationReader } from "./MusicSymbolModules/ArticulationReader";
import { SlurReader } from "./MusicSymbolModules/SlurReader";
import { Notehead } from "../VoiceData/Notehead";
import { Arpeggio, ArpeggioType } from "../VoiceData/Arpeggio";
import { NoteType, NoteTypeHandler } from "../VoiceData/NoteType";
import { TabNote } from "../VoiceData/TabNote";
import { PlacementEnum } from "../VoiceData/Expressions/AbstractExpression";
import { ReaderPluginManager } from "./ReaderPluginManager";
import { Instrument } from "../Instrument";
export class VoiceGenerator {
constructor(pluginManager: ReaderPluginManager, staff: Staff, voiceId: number, slurReader: SlurReader, mainVoice: Voice = undefined) {
this.staff = staff;
this.instrument = staff.ParentInstrument;
this.musicSheet = this.instrument.GetMusicSheet;
this.slurReader = slurReader;
this.pluginManager = pluginManager;
if (mainVoice) {
this.voice = new LinkedVoice(this.instrument, voiceId, mainVoice);
} else {
this.voice = new Voice(this.instrument, voiceId);
}
this.instrument.Voices.push(this.voice); // apparently necessary for cursor.next(), for "cursor with hidden instrument" test
this.staff.Voices.push(this.voice);
this.lyricsReader = new LyricsReader(this.musicSheet);
this.articulationReader = new ArticulationReader(this.musicSheet.Rules);
}
public pluginManager: ReaderPluginManager; // currently only used in audio player
private slurReader: SlurReader;
private lyricsReader: LyricsReader;
private articulationReader: ArticulationReader;
private musicSheet: MusicSheet;
private voice: Voice;
private currentVoiceEntry: VoiceEntry;
private currentNote: Note;
private currentMeasure: SourceMeasure;
private currentStaffEntry: SourceStaffEntry;
private staff: Staff;
private instrument: Instrument;
// private lastBeamTag: string = "";
private openBeams: Beam[] = []; // works like a stack, with push and pop
private beamNumberOffset: number = 0;
private get openTieDict(): { [_: number]: Tie } { return this.staff.openTieDict; }
private currentOctaveShift: number = 0;
private tupletDict: { [_: number]: Tuplet } = {};
private openTupletNumber: number = 0;
public get GetVoice(): Voice {
return this.voice;
}
public get OctaveShift(): number {
return this.currentOctaveShift;
}
public set OctaveShift(value: number) {
this.currentOctaveShift = value;
}
/**
* Create new [[VoiceEntry]], add it to given [[SourceStaffEntry]] and if given so, to [[Voice]].
* @param musicTimestamp
* @param parentStaffEntry
* @param addToVoice
* @param isGrace States whether the new VoiceEntry (only) has grace notes
*/
public createVoiceEntry(musicTimestamp: Fraction, parentStaffEntry: SourceStaffEntry, addToVoice: boolean,
isGrace: boolean = false, graceNoteSlash: boolean = false, graceSlur: boolean = false): void {
this.currentVoiceEntry = new VoiceEntry(musicTimestamp.clone(), this.voice, parentStaffEntry, isGrace, graceNoteSlash, graceSlur);
if (addToVoice) {
this.voice.VoiceEntries.push(this.currentVoiceEntry);
}
}
/**
* Create [[Note]]s and handle Lyrics, Articulations, Beams, Ties, Slurs, Tuplets.
* @param noteNode
* @param noteDuration
* @param divisions
* @param restNote
* @param parentStaffEntry
* @param parentMeasure
* @param measureStartAbsoluteTimestamp
* @param maxTieNoteFraction
* @param chord
* @param octavePlusOne Software like Guitar Pro gives one octave too low, so we need to add one
* @param printObject whether the note should be rendered (true) or invisible (false)
* @returns {Note}
*/
public read(noteNode: IXmlElement, noteDuration: Fraction, typeDuration: Fraction, noteTypeXml: NoteType, normalNotes: number, restNote: boolean,
parentStaffEntry: SourceStaffEntry, parentMeasure: SourceMeasure,
measureStartAbsoluteTimestamp: Fraction, maxTieNoteFraction: Fraction, chord: boolean, octavePlusOne: boolean,
printObject: boolean, isCueNote: boolean, isGraceNote: boolean, stemDirectionXml: StemDirectionType, tremoloInfo: TremoloInfo,
stemColorXml: string, noteheadColorXml: string, vibratoStrokes: boolean,
dotsXml: number): Note {
this.currentStaffEntry = parentStaffEntry;
this.currentMeasure = parentMeasure;
//log.debug("read called:", restNote);
try {
this.currentNote = restNote
? this.addRestNote(noteNode.element("rest"), noteDuration, noteTypeXml, typeDuration, normalNotes, printObject, isCueNote, noteheadColorXml)
: this.addSingleNote(noteNode, noteDuration, noteTypeXml, typeDuration, normalNotes, chord, octavePlusOne,
printObject, isCueNote, isGraceNote, stemDirectionXml, tremoloInfo, stemColorXml, noteheadColorXml, vibratoStrokes);
this.currentNote.DotsXml = dotsXml;
// read lyrics
const lyricElements: IXmlElement[] = noteNode.elements("lyric");
if (this.lyricsReader !== undefined && lyricElements) {
this.lyricsReader.addLyricEntry(lyricElements, this.currentVoiceEntry);
this.voice.Parent.HasLyrics = true;
}
let hasTupletCommand: boolean = false;
const notationNode: IXmlElement = noteNode.element("notations");
if (notationNode) {
// read articulations
if (this.articulationReader) {
this.readArticulations(notationNode, this.currentVoiceEntry, this.currentNote);
}
// read slurs
const slurElements: IXmlElement[] = notationNode.elements("slur");
const slideElements: IXmlElement[] = notationNode.elements("slide");
const glissElements: IXmlElement[] = notationNode.elements("glissando");
if (this.slurReader !== undefined &&
(slurElements.length > 0 || slideElements.length > 0) &&
!this.currentNote.ParentVoiceEntry.IsGrace) {
this.slurReader.addSlur(slurElements, this.currentNote);
if (slideElements.length > 0) {
this.slurReader.addSlur(slideElements, this.currentNote);
}
if (glissElements.length > 0) {
this.slurReader.addSlur(glissElements, this.currentNote);
}
}
// read Tuplets
const tupletElements: IXmlElement[] = notationNode.elements("tuplet");
if (tupletElements.length > 0) {
this.openTupletNumber = this.addTuplet(noteNode, tupletElements);
hasTupletCommand = true;
}
// check for Arpeggios
const arpeggioNode: IXmlElement = notationNode.element("arpeggiate");
if (arpeggioNode !== undefined) {
let currentArpeggio: Arpeggio;
if (this.currentVoiceEntry.Arpeggio) { // add note to existing Arpeggio
currentArpeggio = this.currentVoiceEntry.Arpeggio;
} else { // create new Arpeggio
let arpeggioAlreadyExists: boolean = false;
for (const voiceEntry of this.currentStaffEntry.VoiceEntries) {
if (voiceEntry.Arpeggio) {
arpeggioAlreadyExists = true;
currentArpeggio = voiceEntry.Arpeggio;
// TODO handle multiple arpeggios across multiple voices at same timestamp
// this.currentVoiceEntry.Arpeggio = currentArpeggio; // register the arpeggio in the current voice entry as well?
// but then we duplicate information, and may have to take care not to render it multiple times
// we already have an arpeggio in another voice, at the current timestamp. add the notes there.
break;
}
}
if (!arpeggioAlreadyExists) {
let arpeggioType: ArpeggioType = ArpeggioType.ARPEGGIO_DIRECTIONLESS;
const directionAttr: Attr = arpeggioNode.attribute("direction");
if (directionAttr) {
switch (directionAttr.value) {
case "up":
arpeggioType = ArpeggioType.ROLL_UP;
break;
case "down":
arpeggioType = ArpeggioType.ROLL_DOWN;
break;
default:
arpeggioType = ArpeggioType.ARPEGGIO_DIRECTIONLESS;
}
}
currentArpeggio = new Arpeggio(this.currentVoiceEntry, arpeggioType);
this.currentVoiceEntry.Arpeggio = currentArpeggio;
}
}
currentArpeggio.addNote(this.currentNote);
}
// check for Ties - must be the last check
const tiedNodeList: IXmlElement[] = notationNode.elements("tied");
if (tiedNodeList.length > 0) {
this.addTie(tiedNodeList, measureStartAbsoluteTimestamp, maxTieNoteFraction, TieTypes.SIMPLE);
}
//"check for slides, they are the same as Ties but with a different connection"
// correction: slide can have a different end note (e.g. guitar) -> should be handled like slur rather than tie
// const slideNodeList: IXmlElement[] = notationNode.elements("slide");
// if (slideNodeList.length > 0) {
// this.addTie(slideNodeList, measureStartAbsoluteTimestamp, maxTieNoteFraction, TieTypes.SLIDE);
// }
//check for guitar specific symbols:
const technicalNode: IXmlElement = notationNode.element("technical");
if (technicalNode) {
const hammerNodeList: IXmlElement[] = technicalNode.elements("hammer-on");
if (hammerNodeList.length > 0) {
this.addTie(hammerNodeList, measureStartAbsoluteTimestamp, maxTieNoteFraction, TieTypes.HAMMERON);
}
const pulloffNodeList: IXmlElement[] = technicalNode.elements("pull-off");
if (pulloffNodeList.length > 0) {
this.addTie(pulloffNodeList, measureStartAbsoluteTimestamp, maxTieNoteFraction, TieTypes.PULLOFF);
}
}
// remove open ties, if there is already a gap between the last tie note and now.
// TODO this deletes valid ties, see #1097
// const openTieDict: { [_: number]: Tie } = this.openTieDict;
// for (const key in openTieDict) {
// if (openTieDict.hasOwnProperty(key)) {
// const tie: Tie = openTieDict[key];
// if (Fraction.plus(tie.StartNote.ParentStaffEntry.Timestamp, tie.Duration).lt(this.currentStaffEntry.Timestamp)) {
// delete openTieDict[key];
// }
// }
// }
}
// time-modification yields tuplet in currentNote
// mustn't execute method, if this is the Note where the Tuplet has been created
if (noteNode.element("time-modification") !== undefined && !hasTupletCommand) {
this.handleTimeModificationNode(noteNode);
}
} catch (err) {
log.warn(err);
const errorMsg: string = ITextTranslation.translateText(
"ReaderErrorMessages/NoteError", "Ignored erroneous Note."
);
this.musicSheet.SheetErrors.pushMeasureError(errorMsg);
this.musicSheet.SheetErrors.pushMeasureError(err);
}
return this.currentNote;
}
/**
* Create a new [[StaffEntryLink]] and sets the currenstStaffEntry accordingly.
* @param index
* @param currentStaff
* @param currentStaffEntry
* @param currentMeasure
* @returns {SourceStaffEntry}
*/
public checkForStaffEntryLink(index: number, currentStaff: Staff, currentStaffEntry: SourceStaffEntry, currentMeasure: SourceMeasure): SourceStaffEntry {
const staffEntryLink: StaffEntryLink = new StaffEntryLink(this.currentVoiceEntry);
staffEntryLink.LinkStaffEntries.push(currentStaffEntry);
currentStaffEntry.Link = staffEntryLink;
const linkMusicTimestamp: Fraction = this.currentVoiceEntry.Timestamp.clone();
const verticalSourceStaffEntryContainer: VerticalSourceStaffEntryContainer = currentMeasure.getVerticalContainerByTimestamp(linkMusicTimestamp);
currentStaffEntry = verticalSourceStaffEntryContainer.StaffEntries[index];
if (!currentStaffEntry) {
currentStaffEntry = new SourceStaffEntry(verticalSourceStaffEntryContainer, currentStaff);
verticalSourceStaffEntryContainer.StaffEntries[index] = currentStaffEntry;
}
currentStaffEntry.VoiceEntries.push(this.currentVoiceEntry);
staffEntryLink.LinkStaffEntries.push(currentStaffEntry);
currentStaffEntry.Link = staffEntryLink;
return currentStaffEntry;
}
public checkForOpenBeam(): void {
if (this.openBeams.length > 0 && this.currentNote) {
this.handleOpenBeam();
}
}
public checkOpenTies(): void {
const openTieDict: { [key: number]: Tie } = this.openTieDict;
for (const key in openTieDict) {
if (openTieDict.hasOwnProperty(key)) {
const tie: Tie = openTieDict[key];
if (Fraction.plus(tie.StartNote.ParentStaffEntry.Timestamp, tie.Duration)
.lt(tie.StartNote.SourceMeasure.Duration)) {
delete openTieDict[key];
}
}
}
}
public hasVoiceEntry(): boolean {
return this.currentVoiceEntry !== undefined;
}
private readArticulations(notationNode: IXmlElement, currentVoiceEntry: VoiceEntry, currentNote: Note): void {
const articNode: IXmlElement = notationNode.element("articulations");
if (articNode) {
this.articulationReader.addArticulationExpression(articNode, currentVoiceEntry);
}
const fermaNode: IXmlElement = notationNode.element("fermata");
if (fermaNode) {
this.articulationReader.addFermata(fermaNode, currentVoiceEntry);
}
const tecNode: IXmlElement = notationNode.element("technical");
if (tecNode) {
this.articulationReader.addTechnicalArticulations(tecNode, currentVoiceEntry, currentNote);
}
const ornaNode: IXmlElement = notationNode.element("ornaments");
if (ornaNode) {
this.articulationReader.addOrnament(ornaNode, currentVoiceEntry);
// const tremoloNode: IXmlElement = ornaNode.element("tremolo");
// tremolo should be and is added per note, not per VoiceEntry. see addSingleNote()
}
}
/**
* Create a new [[Note]] and adds it to the currentVoiceEntry
* @param node
* @param noteDuration
* @param divisions
* @param chord
* @param octavePlusOne Software like Guitar Pro gives one octave too low, so we need to add one
* @returns {Note}
*/
private addSingleNote(node: IXmlElement, noteDuration: Fraction, noteTypeXml: NoteType, typeDuration: Fraction,
normalNotes: number, chord: boolean, octavePlusOne: boolean,
printObject: boolean, isCueNote: boolean, isGraceNote: boolean, stemDirectionXml: StemDirectionType, tremoloInfo: TremoloInfo,
stemColorXml: string, noteheadColorXml: string, vibratoStrokes: boolean): Note {
//log.debug("addSingleNote called");
let noteAlter: number = 0;
let accidentalValue: string;
let noteAccidental: AccidentalEnum = AccidentalEnum.NONE;
let noteStep: NoteEnum = NoteEnum.C;
let displayStepUnpitched: NoteEnum = NoteEnum.C;
let noteOctave: number = 0;
let displayOctaveUnpitched: number = 0;
let playbackInstrumentId: string = undefined;
let noteheadShapeXml: string = undefined;
let noteheadFilledXml: boolean = undefined; // if undefined, the final filled parameter will be calculated from duration
const xmlnodeElementsArr: IXmlElement[] = node.elements();
for (let idx: number = 0, len: number = xmlnodeElementsArr.length; idx < len; ++idx) {
const noteElement: IXmlElement = xmlnodeElementsArr[idx];
try {
if (noteElement.name === "pitch") {
const noteElementsArr: IXmlElement[] = noteElement.elements();
for (let idx2: number = 0, len2: number = noteElementsArr.length; idx2 < len2; ++idx2) {
const pitchElement: IXmlElement = noteElementsArr[idx2];
noteheadShapeXml = undefined; // reinitialize for each pitch
noteheadFilledXml = undefined;
try {
if (pitchElement.name === "step") {
noteStep = NoteEnum[pitchElement.value];
if (noteStep === undefined) { // don't replace undefined check
const errorMsg: string = ITextTranslation.translateText(
"ReaderErrorMessages/NotePitchError",
"Invalid pitch while reading note."
);
this.musicSheet.SheetErrors.pushMeasureError(errorMsg);
throw new MusicSheetReadingException(errorMsg, undefined);
}
} else if (pitchElement.name === "alter") {
noteAlter = parseFloat(pitchElement.value);
if (isNaN(noteAlter)) {
const errorMsg: string = ITextTranslation.translateText(
"ReaderErrorMessages/NoteAlterationError", "Invalid alteration while reading note."
);
this.musicSheet.SheetErrors.pushMeasureError(errorMsg);
throw new MusicSheetReadingException(errorMsg, undefined);
}
noteAccidental = Pitch.AccidentalFromHalfTones(noteAlter); // potentially overwritten by "accidental" noteElement
} else if (pitchElement.name === "octave") {
noteOctave = parseInt(pitchElement.value, 10);
if (isNaN(noteOctave)) {
const errorMsg: string = ITextTranslation.translateText(
"ReaderErrorMessages/NoteOctaveError", "Invalid octave value while reading note."
);
this.musicSheet.SheetErrors.pushMeasureError(errorMsg);
throw new MusicSheetReadingException(errorMsg, undefined);
}
}
} catch (ex) {
log.info("VoiceGenerator.addSingleNote read Step: ", ex.message);
}
}
} else if (noteElement.name === "accidental") {
accidentalValue = noteElement.value;
if (accidentalValue === "natural") {
noteAccidental = AccidentalEnum.NATURAL;
// following accidentals: ambiguous in alter value
} else if (accidentalValue === "slash-flat") {
noteAccidental = AccidentalEnum.SLASHFLAT;
} else if (accidentalValue === "slash-quarter-sharp") {
noteAccidental = AccidentalEnum.SLASHQUARTERSHARP;
} else if (accidentalValue === "slash-sharp") {
noteAccidental = AccidentalEnum.SLASHSHARP;
} else if (accidentalValue === "double-slash-flat") {
noteAccidental = AccidentalEnum.DOUBLESLASHFLAT;
} else if (accidentalValue === "sori") {
noteAccidental = AccidentalEnum.SORI;
} else if (accidentalValue === "koron") {
noteAccidental = AccidentalEnum.KORON;
}
} else if (noteElement.name === "unpitched") {
const displayStepElement: IXmlElement = noteElement.element("display-step");
const octave: IXmlElement = noteElement.element("display-octave");
if (octave) {
noteOctave = parseInt(octave.value, 10);
displayOctaveUnpitched = noteOctave - 3;
if (octavePlusOne) {
noteOctave += 1;
}
if (this.instrument.Staves[0].StafflineCount === 1) {
displayOctaveUnpitched += 1;
}
}
if (displayStepElement) {
noteStep = NoteEnum[displayStepElement.value.toUpperCase()];
let octaveShift: number = 0;
let noteValueShift: number = this.musicSheet.Rules.PercussionXMLDisplayStepNoteValueShift;
if (this.instrument.Staves[0].StafflineCount === 1) {
noteValueShift -= 3; // for percussion one line scores, we need to set the notes 3 lines lower
}
[displayStepUnpitched, octaveShift] = Pitch.lineShiftFromNoteEnum(noteStep, noteValueShift);
displayOctaveUnpitched += octaveShift;
}
} else if (noteElement.name === "instrument") {
if (noteElement.firstAttribute) {
playbackInstrumentId = noteElement.firstAttribute.value;
}
} else if (noteElement.name === "notehead") {
noteheadShapeXml = noteElement.value;
if (noteElement.attribute("filled")) {
noteheadFilledXml = noteElement.attribute("filled").value === "yes";
}
}
} catch (ex) {
log.info("VoiceGenerator.addSingleNote: ", ex);
}
}
noteOctave -= Pitch.OctaveXmlDifference;
const pitch: Pitch = new Pitch(noteStep, noteOctave, noteAccidental, accidentalValue);
const noteLength: Fraction = Fraction.createFromFraction(noteDuration);
let note: Note = undefined;
let stringNumber: number = -1; //1 to always recognize as valid tab note
let fretNumber: number = -1; //0 to always recognize as valid tab note
const bends: {bendalter: number, direction: string}[] = [];
// check for guitar tabs:
const notationNode: IXmlElement = node.element("notations");
if (notationNode) {
const technicalNode: IXmlElement = notationNode.element("technical");
if (technicalNode) {
const stringNode: IXmlElement = technicalNode.element("string");
if (stringNode) {
stringNumber = parseInt(stringNode.value, 10);
}
const fretNode: IXmlElement = technicalNode.element("fret");
if (fretNode) {
fretNumber = parseInt(fretNode.value, 10);
}
const bendElementsArr: IXmlElement[] = technicalNode.elements("bend");
bendElementsArr.forEach(function (bend: IXmlElement): void {
const bendalterNote: IXmlElement = bend.element("bend-alter");
const releaseNode: IXmlElement = bend.element("release");
if (releaseNode !== undefined) {
bends.push({bendalter: parseInt (bendalterNote.value, 10), direction: "down"});
} else {
bends.push({bendalter: parseInt (bendalterNote.value, 10), direction: "up"});
}
});
}
}
if (stringNumber < 0 || fretNumber < 0) {
// create normal Note
note = new Note(this.currentVoiceEntry, this.currentStaffEntry, noteLength, pitch, this.currentMeasure);
} else {
// create TabNote
note = new TabNote(this.currentVoiceEntry, this.currentStaffEntry, noteLength, pitch, this.currentMeasure,
stringNumber, fretNumber, bends, vibratoStrokes);
}
this.addNoteInfo(note, noteTypeXml, printObject, isCueNote, normalNotes,
displayStepUnpitched, displayOctaveUnpitched,
noteheadColorXml, noteheadColorXml);
note.TypeLength = typeDuration;
note.IsGraceNote = isGraceNote;
note.StemDirectionXml = stemDirectionXml; // maybe unnecessary, also in VoiceEntry
note.TremoloInfo = tremoloInfo;
note.PlaybackInstrumentId = playbackInstrumentId;
if ((noteheadShapeXml !== undefined && noteheadShapeXml !== "normal") || noteheadFilledXml !== undefined) {
note.Notehead = new Notehead(note, noteheadShapeXml, noteheadFilledXml);
} // if normal, leave note head undefined to save processing/runtime
if (stemDirectionXml === StemDirectionType.None) {
stemColorXml = "#00000000"; // just setting this to transparent for now
}
this.currentVoiceEntry.Notes.push(note);
this.currentVoiceEntry.StemDirectionXml = stemDirectionXml;
if (stemColorXml) {
this.currentVoiceEntry.StemColorXml = stemColorXml;
this.currentVoiceEntry.StemColor = stemColorXml;
note.StemColorXml = stemColorXml;
}
if (node.elements("beam") && !chord) {
this.createBeam(node, note);
}
return note;
}
/**
* Create a new rest note and add it to the currentVoiceEntry.
* @param noteDuration
* @param divisions
* @returns {Note}
*/
private addRestNote(node: IXmlElement, noteDuration: Fraction, noteTypeXml: NoteType, typeDuration: Fraction,
normalNotes: number, printObject: boolean, isCueNote: boolean, noteheadColorXml: string): Note {
const restFraction: Fraction = Fraction.createFromFraction(noteDuration);
const displayStepElement: IXmlElement = node.element("display-step");
const octaveElement: IXmlElement = node.element("display-octave");
let displayStep: NoteEnum;
let displayOctave: number;
let pitch: Pitch = undefined;
if (displayStepElement && octaveElement) {
displayStep = NoteEnum[displayStepElement.value.toUpperCase()];
displayOctave = parseInt(octaveElement.value, 10);
pitch = new Pitch(displayStep, displayOctave, AccidentalEnum.NONE, undefined, true);
}
const restNote: Note = new Note(this.currentVoiceEntry, this.currentStaffEntry, restFraction, pitch, this.currentMeasure, true);
this.addNoteInfo(restNote, noteTypeXml, printObject, isCueNote, normalNotes, displayStep, displayOctave, noteheadColorXml, noteheadColorXml);
restNote.TypeLength = typeDuration; // needed for tuplet note type information
// (e.g. quarter rest - but length different due to tuplet). see MusicSheetCalculator.calculateTupletNumbers()
this.currentVoiceEntry.Notes.push(restNote);
if (this.openBeams.length > 0) {
this.openBeams.last().ExtendedNoteList.push(restNote);
}
return restNote;
}
// common for "normal" notes and rest notes
private addNoteInfo(note: Note, noteTypeXml: NoteType, printObject: boolean, isCueNote: boolean, normalNotes: number,
displayStep: NoteEnum, displayOctave: number,
noteheadColorXml: string, noteheadColor: string): void {
// common for normal notes and rest note
note.NoteTypeXml = noteTypeXml;
note.PrintObject = printObject;
note.IsCueNote = isCueNote;
note.NormalNotes = normalNotes; // how many rhythmical notes the notes replace (e.g. for tuplets), see xml "actual-notes" and "normal-notes"
note.displayStepUnpitched = displayStep;
note.displayOctaveUnpitched = displayOctave;
note.NoteheadColorXml = noteheadColorXml; // color set in Xml, shouldn't be changed.
note.NoteheadColor = noteheadColorXml; // color currently used
// add TypeLength for rest notes like with Note?
// add IsGraceNote for rest notes like with Notes?
// add PlaybackInstrumentId for rest notes?
}
/**
* Handle the currentVoiceBeam.
* @param node
* @param note
*/
private createBeam(node: IXmlElement, note: Note): void {
try {
const beamNode: IXmlElement = node.element("beam");
let beamAttr: IXmlAttribute = undefined;
if (beamNode !== undefined && beamNode.hasAttributes) {
beamAttr = beamNode.attribute("number");
}
if (beamAttr) {
let beamNumber: number = parseInt(beamAttr.value, 10);
const mainBeamNode: IXmlElement[] = node.elements("beam");
const currentBeamTag: string = mainBeamNode[0].value;
if (mainBeamNode) {
if (currentBeamTag === "begin") {
if (beamNumber === this.openBeams.last()?.BeamNumber) {
// beam with same number already existed (error in XML), bump beam number
this.beamNumberOffset++;
beamNumber += this.beamNumberOffset;
} else if (this.openBeams.last()) {
this.handleOpenBeam();
}
this.openBeams.push(new Beam(beamNumber, this.beamNumberOffset));
} else {
beamNumber += this.beamNumberOffset;
}
}
let sameVoiceEntry: boolean = false;
if (!(beamNumber > 0 && beamNumber <= this.openBeams.length) || !this.openBeams[beamNumber - 1]) {
log.debug("[OSMD] invalid beamnumber"); // this shouldn't happen, probably error in this method
return;
}
for (let idx: number = 0, len: number = this.openBeams[beamNumber - 1].Notes.length; idx < len; ++idx) {
const beamNote: Note = this.openBeams[beamNumber - 1].Notes[idx];
if (this.currentVoiceEntry === beamNote.ParentVoiceEntry) {
sameVoiceEntry = true;
}
}
if (!sameVoiceEntry) {
const openBeam: Beam = this.openBeams[beamNumber - 1];
openBeam.addNoteToBeam(note);
// const lastBeamNote: Note = openBeam.Notes.last();
// const graceStatusChanged: boolean = (lastBeamNote?.IsCueNote || lastBeamNote?.IsGraceNote) !== (note.IsCueNote) || (note.IsGraceNote);
if (currentBeamTag === "end") {
this.endBeam();
}
}
}
} catch (e) {
const errorMsg: string = ITextTranslation.translateText(
"ReaderErrorMessages/BeamError", "Error while reading beam."
);
this.musicSheet.SheetErrors.pushMeasureError(errorMsg);
throw new MusicSheetReadingException("", e);
}
}
private endBeam(): void {
this.openBeams.pop(); // pop the last open beam from the stack. the latest openBeam will be the one before that now
this.beamNumberOffset = Math.max(0, this.beamNumberOffset - 1);
}
/**
* Check for open [[Beam]]s at end of [[SourceMeasure]] and closes them explicity.
*/
private handleOpenBeam(): void {
const openBeam: Beam = this.openBeams.last();
if (openBeam.Notes.length === 0) {
// TODO why is there such a beam? sample: test_percussion_display_step_from_xml
this.endBeam(); // otherwise beamLastNote.ParentStaffEntry will throw an undefined error
return;
}
if (openBeam.Notes.length === 1) {
const beamNote: Note = openBeam.Notes[0];
beamNote.NoteBeam = undefined;
this.endBeam();
return;
}
if (this.currentNote === CollectionUtil.last(openBeam.Notes)) {
this.endBeam();
} else {
const beamLastNote: Note = CollectionUtil.last(openBeam.Notes);
const beamLastNoteStaffEntry: SourceStaffEntry = beamLastNote.ParentStaffEntry;
const horizontalIndex: number = this.currentMeasure.getVerticalContainerIndexByTimestamp(beamLastNoteStaffEntry.Timestamp);
const verticalIndex: number = beamLastNoteStaffEntry.VerticalContainerParent.StaffEntries.indexOf(beamLastNoteStaffEntry);
if (horizontalIndex < this.currentMeasure.VerticalSourceStaffEntryContainers.length - 1) {
const nextStaffEntry: SourceStaffEntry = this.currentMeasure
.VerticalSourceStaffEntryContainers[horizontalIndex + 1]
.StaffEntries[verticalIndex];
if (nextStaffEntry) {
for (let idx: number = 0, len: number = nextStaffEntry.VoiceEntries.length; idx < len; ++idx) {
const voiceEntry: VoiceEntry = nextStaffEntry.VoiceEntries[idx];
if (voiceEntry.ParentVoice === this.voice) {
const candidateNote: Note = voiceEntry.Notes[0];
if (candidateNote.Length.lte(new Fraction(1, 8))) {
this.openBeams.last().addNoteToBeam(candidateNote);
this.endBeam();
} else {
this.endBeam();
}
}
}
}
} else {
this.endBeam();
}
}
}
/**
* Create a [[Tuplet]].
* @param node
* @param tupletNodeList
* @returns {number}
*/
private addTuplet(node: IXmlElement, tupletNodeList: IXmlElement[]): number {
let bracketed: boolean = false; // true if bracket=yes given, otherwise false
let bracketedXmlValue: boolean = undefined; // Exact xml bracket value given: true for bracket=yes, false for bracket=no, undefined if not given.
// TODO refactor this to not duplicate lots of code for the cases tupletNodeList.length == 1 and > 1
if (tupletNodeList !== undefined && tupletNodeList.length > 1) {
let timeModNode: IXmlElement = node.element("time-modification");
if (timeModNode) {
timeModNode = timeModNode.element("actual-notes");
}
const tupletNodeListArr: IXmlElement[] = tupletNodeList;
for (let idx: number = 0, len: number = tupletNodeListArr.length; idx < len; ++idx) {
const tupletNode: IXmlElement = tupletNodeListArr[idx];
if (tupletNode !== undefined && tupletNode.attributes()) {
const bracketAttr: Attr = tupletNode.attribute("bracket");
if (bracketAttr && bracketAttr.value === "yes") {
bracketed = true;
bracketedXmlValue = true;
} else if (bracketAttr && bracketAttr.value === "no") {
bracketedXmlValue = false;
}
const showNumberNoneGiven: boolean = this.readShowNumberNoneGiven(tupletNode);
const type: Attr = tupletNode.attribute("type");
if (type && type.value === "start") {
let tupletNumber: number = 1;
if (tupletNode.attribute("number")) {
tupletNumber = parseInt(tupletNode.attribute("number").value, 10);
}
let tupletLabelNumber: number = 0;
if (timeModNode) {
tupletLabelNumber = parseInt(timeModNode.value, 10);
if (isNaN(tupletLabelNumber)) {
const errorMsg: string = ITextTranslation.translateText(
"ReaderErrorMessages/TupletNoteDurationError", "Invalid tuplet note duration."
);
this.musicSheet.SheetErrors.pushMeasureError(errorMsg);
throw new MusicSheetReadingException(errorMsg, undefined);
}
}
const tuplet: Tuplet = new Tuplet(tupletLabelNumber, bracketed);
tuplet.BracketedXmlValue = bracketedXmlValue;
tuplet.ShowNumberNoneGivenInXml = showNumberNoneGiven;
//Default to above
tuplet.tupletLabelNumberPlacement = PlacementEnum.Above;
//If we ever encounter a placement attribute for this tuplet, should override.
//Even previous placement attributes for the tuplet
const placementAttr: Attr = tupletNode.attribute("placement");
if (placementAttr) {
if (placementAttr.value === "below") {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Below;
}
tuplet.PlacementFromXml = true;
}
if (this.tupletDict[tupletNumber]) {
delete this.tupletDict[tupletNumber];
if (Object.keys(this.tupletDict).length === 0) {
this.openTupletNumber = 0;
} else if (Object.keys(this.tupletDict).length > 1) {
this.openTupletNumber--;
}
}
this.tupletDict[tupletNumber] = tuplet;
const subnotelist: Note[] = [];
subnotelist.push(this.currentNote);
tuplet.Notes.push(subnotelist);
tuplet.Fractions.push(this.getTupletNoteDurationFromType(node));
this.currentNote.NoteTuplet = tuplet;
this.openTupletNumber = tupletNumber;
} else if (type.value === "stop") {
let tupletNumber: number = 1;
if (tupletNode.attribute("number")) {
tupletNumber = parseInt(tupletNode.attribute("number").value, 10);
}
const tuplet: Tuplet = this.tupletDict[tupletNumber];
if (tuplet) {
const placementAttr: Attr = tupletNode.attribute("placement");
if (placementAttr) {
if (placementAttr.value === "below") {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Below;
} else {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Above;
}
tuplet.PlacementFromXml = true;
}
const subnotelist: Note[] = [];
subnotelist.push(this.currentNote);
tuplet.Notes.push(subnotelist);
//If our placement hasn't been from XML, check all the notes in the tuplet
//Search for the first non-rest and use it's stem direction
if (!tuplet.PlacementFromXml) {
let foundNonRest: boolean = false;
for (const subList of tuplet.Notes) {
for (const note of subList) {
if (!note.isRest()) {
if(note.StemDirectionXml === StemDirectionType.Down) {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Below;
} else {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Above;
}
foundNonRest = true;
break;
}
}
if (foundNonRest) {
break;
}
}
}
tuplet.Fractions.push(this.getTupletNoteDurationFromType(node));
this.currentNote.NoteTuplet = tuplet;
delete this.tupletDict[tupletNumber];
if (Object.keys(this.tupletDict).length === 0) {
this.openTupletNumber = 0;
} else if (Object.keys(this.tupletDict).length > 1) {
this.openTupletNumber--;
}
}
}
}
}
} else if (tupletNodeList[0]) {
const n: IXmlElement = tupletNodeList[0];
if (n.hasAttributes) {
const type: string = n.attribute("type").value;
let tupletnumber: number = 1;
if (n.attribute("number")) {
tupletnumber = parseInt(n.attribute("number").value, 10);
}
const noTupletNumbering: boolean = isNaN(tupletnumber);
const showNumberNoneGiven: boolean = this.readShowNumberNoneGiven(n);
const bracketAttr: Attr = n.attribute("bracket");
if (bracketAttr && bracketAttr.value === "yes") {
bracketed = true;
bracketedXmlValue = true;
} else if (bracketAttr && bracketAttr.value === "no") {
bracketedXmlValue = false;
}
if (type === "start") {
let tupletLabelNumber: number = 0;
let timeModNode: IXmlElement = node.element("time-modification");
if (timeModNode) {
timeModNode = timeModNode.element("actual-notes");
}
if (timeModNode) {
tupletLabelNumber = parseInt(timeModNode.value, 10);
if (isNaN(tupletLabelNumber)) {
const errorMsg: string = ITextTranslation.translateText(
"ReaderErrorMessages/TupletNoteDurationError", "Invalid tuplet note duration."
);
this.musicSheet.SheetErrors.pushMeasureError(errorMsg);
throw new MusicSheetReadingException(errorMsg);
}
}
if (noTupletNumbering) {
this.openTupletNumber++;
tupletnumber = this.openTupletNumber;
}
let tuplet: Tuplet = this.tupletDict[tupletnumber];
if (!tuplet) {
tuplet = this.tupletDict[tupletnumber] = new Tuplet(tupletLabelNumber, bracketed);
tuplet.BracketedXmlValue = bracketedXmlValue;
tuplet.ShowNumberNoneGivenInXml = showNumberNoneGiven;
//Default to above
tuplet.tupletLabelNumberPlacement = PlacementEnum.Above;
}
//If we ever encounter a placement attribute for this tuplet, should override.
//Even previous placement attributes for the tuplet
const placementAttr: Attr = n.attribute("placement");
if (placementAttr) {
if (placementAttr.value === "below") {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Below;
} else {
//Just in case
tuplet.tupletLabelNumberPlacement = PlacementEnum.Above;
}
tuplet.PlacementFromXml = true;
}
const subnotelist: Note[] = [];
subnotelist.push(this.currentNote);
tuplet.Notes.push(subnotelist);
tuplet.Fractions.push(this.getTupletNoteDurationFromType(node));
this.currentNote.NoteTuplet = tuplet;
this.openTupletNumber = tupletnumber;
} else if (type === "stop") {
if (noTupletNumbering) {
tupletnumber = this.openTupletNumber;
}
const tuplet: Tuplet = this.tupletDict[this.openTupletNumber];
if (tuplet) {
const placementAttr: Attr = n.attribute("placement");
if (placementAttr) {
if (placementAttr.value === "below") {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Below;
} else {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Above;
}
tuplet.PlacementFromXml = true;
}
const subnotelist: Note[] = [];
subnotelist.push(this.currentNote);
tuplet.Notes.push(subnotelist);
//If our placement hasn't been from XML, check all the notes in the tuplet
//Search for the first non-rest and use it's stem direction
if (!tuplet.PlacementFromXml) {
let foundNonRest: boolean = false;
for (const subList of tuplet.Notes) {
for (const note of subList) {
if (!note.isRest()) {
if(note.StemDirectionXml === StemDirectionType.Down) {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Below;
} else {
tuplet.tupletLabelNumberPlacement = PlacementEnum.Above;
}
foundNonRest = true;
break;
}
}
if (foundNonRest) {
break;
}
}
}
tuplet.Fractions.push(this.getTupletNoteDurationFromType(node));
this.currentNote.NoteTuplet = tuplet;
if (Object.keys(this.tupletDict).length === 0) {
this.openTupletNumber = 0;
} else if (Object.keys(this.tupletDict).length > 1) {
this.openTupletNumber--;
}
delete this.tupletDict[tupletnumber];
}
}
}
}
return this.openTupletNumber;
}
private readShowNumberNoneGiven(tupletNode: IXmlElement): boolean {
const showNumber: Attr = tupletNode.attribute("show-number");
if (showNumber?.value) {
if (showNumber.value === "none") {
return true;
}
}
return false;
}
/**
* This method handles the time-modification IXmlElement for the Tuplet case (tupletNotes not at begin/end of Tuplet).
* @param noteNode
*/
private handleTimeModificationNode(noteNode: IXmlElement): void {
if (this.tupletDict[this.openTupletNumber]) {
try {
// Tuplet should already be created
const tuplet: Tuplet = this.tupletDict[this.openTupletNumber];
const notes: Note[] = CollectionUtil.last(tuplet.Notes);
const lastTupletVoiceEntry: VoiceEntry = notes[0].ParentVoiceEntry;
let noteList: Note[];
if (lastTupletVoiceEntry.Timestamp.Equals(this.currentVoiceEntry.Timestamp)) {
noteList = notes;
} else {
noteList = [];
tuplet.Notes.push(noteList);
tuplet.Fractions.push(this.getTupletNoteDurationFromType(noteNode));
}
noteList.push(this.currentNote);
this.currentNote.NoteTuplet = tuplet;
} catch (ex) {
const errorMsg: string = ITextTranslation.translateText(
"ReaderErrorMessages/TupletNumberError", "Invalid tuplet number."
);
this.musicSheet.SheetErrors.pushMeasureError(errorMsg);
throw ex;
}
} else if (this.currentVoiceEntry.Notes.length > 0) {
const firstNote: Note = this.currentVoiceEntry.Notes[0];
if (firstNote.NoteTuplet) {
const tuplet: Tuplet = firstNote.NoteTuplet;
const notes: Note[] = CollectionUtil.last(tuplet.Notes);
notes.push(this.currentNote);
this.currentNote.NoteTuplet = tuplet;
}
}
}
private addTie(tieNodeList: IXmlElement[], measureStartAbsoluteTimestamp: Fraction, maxTieNoteFraction: Fraction, tieType: TieTypes): void {
if (tieNodeList) {
if (tieNodeList.length === 1) {
const tieNode: IXmlElement = tieNodeList[0];
if (tieNode !== undefined && tieNode.attributes()) {
const tieDirection: PlacementEnum = this.getTieDirection(tieNode);
const type: string = tieNode.attribute("type").value;
try {
if (type === "start") {
const num: number = this.findCurrentNoteInTieDict(this.currentNote);
if (num < 0) {
delete this.openTieDict[num];
}
const newTieNumber: number = this.getNextAvailableNumberForTie();
const tie: Tie = new Tie(this.currentNote, tieType);