/
VexFlowMeasure.ts
1730 lines (1633 loc) · 87.5 KB
/
VexFlowMeasure.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 Vex from "vexflow";
import VF = Vex.Flow;
import {GraphicalMeasure} from "../GraphicalMeasure";
import {SourceMeasure} from "../../VoiceData/SourceMeasure";
import {Staff} from "../../VoiceData/Staff";
import {StaffLine} from "../StaffLine";
import {SystemLinesEnum} from "../SystemLinesEnum";
import {ClefInstruction, ClefEnum} from "../../VoiceData/Instructions/ClefInstruction";
import {KeyInstruction} from "../../VoiceData/Instructions/KeyInstruction";
import {RhythmInstruction} from "../../VoiceData/Instructions/RhythmInstruction";
import {VexFlowConverter} from "./VexFlowConverter";
import {VexFlowStaffEntry} from "./VexFlowStaffEntry";
import {Beam} from "../../VoiceData/Beam";
import {GraphicalNote} from "../GraphicalNote";
import {GraphicalStaffEntry} from "../GraphicalStaffEntry";
import StaveNote = VF.StaveNote;
import StemmableNote = VF.StemmableNote;
import NoteSubGroup = VF.NoteSubGroup;
import log from "loglevel";
import {unitInPixels} from "./VexFlowMusicSheetDrawer";
import {Tuplet} from "../../VoiceData/Tuplet";
import {RepetitionInstructionEnum, RepetitionInstruction, AlignmentType} from "../../VoiceData/Instructions/RepetitionInstruction";
import {SystemLinePosition} from "../SystemLinePosition";
import {StemDirectionType} from "../../VoiceData/VoiceEntry";
import {GraphicalVoiceEntry} from "../GraphicalVoiceEntry";
import {VexFlowVoiceEntry} from "./VexFlowVoiceEntry";
import {Fraction} from "../../../Common/DataObjects/Fraction";
import {Voice} from "../../VoiceData/Voice";
import {EngravingRules} from "../EngravingRules";
import {OrnamentContainer} from "../../VoiceData/OrnamentContainer";
import {TechnicalInstruction, TechnicalInstructionType} from "../../VoiceData/Instructions/TechnicalInstruction";
import {PlacementEnum} from "../../VoiceData/Expressions/AbstractExpression";
import {VexFlowGraphicalNote} from "./VexFlowGraphicalNote";
import {AutoBeamOptions} from "../../../OpenSheetMusicDisplay/OSMDOptions";
import {SkyBottomLineCalculator} from "../SkyBottomLineCalculator";
import { NoteType } from "../../VoiceData/NoteType";
import { Arpeggio } from "../../VoiceData/Arpeggio";
import { GraphicalTie } from "../GraphicalTie";
import { Note } from "../../VoiceData/Note";
// type StemmableNote = VF.StemmableNote;
export class VexFlowMeasure extends GraphicalMeasure {
constructor(staff: Staff, sourceMeasure?: SourceMeasure, staffLine?: StaffLine) {
super(staff, sourceMeasure, staffLine);
this.minimumStaffEntriesWidth = -1;
/*
* There is no case in which `staffLine === undefined && sourceMeasure === undefined` holds.
* Hence, it is not necessary to specify an `else` case.
* One can verify this through a usage search for this constructor.
*/
if (staffLine) {
this.rules = staffLine.ParentMusicSystem.rules;
} else if (sourceMeasure) {
this.rules = sourceMeasure.Rules;
} else {
this.rules = new EngravingRules();
}
this.resetLayout();
}
/** octaveOffset according to active clef */
public octaveOffset: number = 3;
/** The VexFlow Voices in the measure */
public vfVoices: { [voiceID: number]: VF.Voice } = {};
/** Call this function (if present) to x-format all the voices in the measure */
public formatVoices?: (width: number, parent: VexFlowMeasure) => void;
/** The VexFlow Ties in the measure */
public vfTies: VF.StaveTie[] = [];
/** The repetition instructions given as words or symbols (coda, dal segno..) */
public vfRepetitionWords: VF.Repetition[] = [];
public hasMetronomeMark: boolean = false;
/** The VexFlow Stave (= one measure in a staffline) */
protected stave!: VF.Stave;
/** VexFlow StaveConnectors (vertical lines) */
protected connectors: VF.StaveConnector[] = [];
/** Intermediate object to construct beams */
private beams: { [voiceID: number]: [Beam, VexFlowVoiceEntry[]] [] } = {};
/** Beams created by (optional) autoBeam function. */
private autoVfBeams: VF.Beam[] = [];
/** Beams of tuplet notes created by (optional) autoBeam function. */
private autoTupletVfBeams: VF.Beam[] = [];
/** VexFlow Beams */
private vfbeams: { [voiceID: number]: VF.Beam[] } = {};
/** Intermediate object to construct tuplets */
protected tuplets: { [voiceID: number]: [Tuplet, VexFlowVoiceEntry[]][] } = {};
/** VexFlow Tuplets */
private vftuplets: { [voiceID: number]: VF.Tuplet[] } = {};
// The engraving rules of OSMD.
public rules: EngravingRules;
// Sets the absolute coordinates of the VFStave on the canvas
public setAbsoluteCoordinates(x: number, y: number): void {
this.stave.setX(x).setY(y);
}
/**
* Reset all the geometric values and parameters of this measure and put it in an initialized state.
* This is needed to evaluate a measure a second time by system builder.
*/
public resetLayout(): void {
// Take into account some space for the begin and end lines of the stave
// Will be changed when repetitions will be implemented
//this.beginInstructionsWidth = 20 / UnitInPixels;
//this.endInstructionsWidth = 20 / UnitInPixels;
// TODO save beginning and end bar type, set these again after new stave.
this.stave = new VF.Stave(0, 0, 0, {
fill_style: this.rules.StaffLineColor,
space_above_staff_ln: 0,
space_below_staff_ln: 0
});
if (this.InitiallyActiveClef) {
(this.stave as any).clef = VexFlowConverter.Clef(this.InitiallyActiveClef).type;
// Vexflow sets stave.clef to treble by default. It needs this info e.g. for key signature accidentals on new key sig
}
(this.stave as any).MeasureNumber = this.MeasureNumber; // for debug info. vexflow automatically uses stave.measure for rendering measure numbers
// also see VexFlowMusicSheetDrawer.drawSheet() for some other vexflow default value settings (like default font scale)
this.hasMetronomeMark = false;
if (this.ParentStaff) {
this.setLineNumber(this.ParentStaff.StafflineCount);
}
// constructor sets beginning and end bar type to standard
this.stave.setBegBarType(VF.Barline.type.NONE); // technically not correct, but we'd need to set the next measure's beginning bar type
if (this.parentSourceMeasure && this.parentSourceMeasure.endingBarStyleEnum === SystemLinesEnum.None) {
// fix for vexflow ignoring ending barline style after new stave, apparently
this.stave.setEndBarType(VF.Barline.type.NONE);
}
// the correct bar types seem to be set later
this.updateInstructionWidth();
}
public clean(): void {
this.vfTies.length = 0;
this.connectors = [];
// Clean up instructions
this.resetLayout();
}
/**
* returns the x-width (in units) of a given measure line {SystemLinesEnum}.
* @param line
* @returns the x-width in osmd units
*/
public getLineWidth(line: SystemLinesEnum): number {
switch (line) {
// return 0 for the normal lines, as the line width will be considered at the updateInstructionWidth() method using the stavemodifiers.
// case SystemLinesEnum.SingleThin:
// return 5.0 / unitInPixels;
// case SystemLinesEnum.DoubleThin:
// return 5.0 / unitInPixels;
// case SystemLinesEnum.ThinBold:
// return 5.0 / unitInPixels;
// but just add a little extra space for repetitions (cosmetics):
case SystemLinesEnum.BoldThinDots:
case SystemLinesEnum.DotsThinBold:
return 10.0 / unitInPixels;
case SystemLinesEnum.DotsBoldBoldDots: // :||: = repeat ends, another repeat starts in next measure
return 10.0 / unitInPixels + this.rules.RepeatEndStartPadding;
default:
return 0;
}
}
/**
* adds the given clef to the begin of the measure.
* This has to update/increase BeginInstructionsWidth.
* @param clef
*/
public addClefAtBegin(clef: ClefInstruction): void {
if (!this.rules.RenderClefsAtBeginningOfStaffline) {
return;
}
this.octaveOffset = clef.OctaveOffset;
if (clef.ClefType === ClefEnum.TAB) {
this.stave.addClef("tab", undefined, undefined, undefined);
} else {
const vfclef: { type: string, size: string, annotation: string } = VexFlowConverter.Clef(clef, "default");
this.stave.addClef(vfclef.type, vfclef.size, vfclef.annotation, VF.StaveModifier.Position.BEGIN);
}
this.updateInstructionWidth();
}
/**
* Sets the number of stafflines that are rendered, so that they are centered properly
* @param lineNumber
*/
public setLineNumber(lineNumber: number): void {
if (lineNumber !== 5) {
if (lineNumber === 0) {
this.stave.setNumLines(0);
this.stave.getBottomLineY = function(): number {
return this.getYForLine(this.options.num_lines);
};
} else if (lineNumber === 1) {
// VF.Stave.setNumLines hides all but the top line.
// this is better
this.stave.options.line_config = [
{ visible: false },
{ visible: false },
{ visible: true }, // show middle
{ visible: false },
{ visible: false },
];
//quick fix to see if this matters for calculation. Doesn't seem to
this.stave.getBottomLineY = function(): number {
return this.getYForLine(2);
};
//lines (which isn't this case here)
//this.stave.options.num_lines = parseInt(lines, 10);
} else if (lineNumber === 2) {
this.stave.options.line_config = [
{ visible: false },
{ visible: false },
{ visible: true }, // show middle
{ visible: true },
{ visible: false },
];
this.stave.getBottomLineY = function(): number {
return this.getYForLine(3);
};
} else if (lineNumber === 3) {
this.stave.options.line_config = [
{ visible: false },
{ visible: true },
{ visible: true }, // show middle
{ visible: true },
{ visible: false },
];
this.stave.getBottomLineY = function(): number {
return this.getYForLine(2);
};
} else {
this.stave.setNumLines(lineNumber);
this.stave.getBottomLineY = function(): number {
return this.getYForLine(this.options.num_lines);
};
}
}
}
/**
* adds the given key to the begin of the measure.
* This has to update/increase BeginInstructionsWidth.
* @param currentKey the new valid key.
* @param previousKey the old cancelled key. Needed to show which accidentals are not valid any more.
* @param currentClef the valid clef. Needed to put the accidentals on the right y-positions.
*/
public addKeyAtBegin(currentKey: KeyInstruction, previousKey: KeyInstruction, currentClef: ClefInstruction): void {
if (!this.rules.RenderKeySignatures || !this.ShowKeySignature) {
return;
}
if (this.isTabMeasure && !this.rules.TabKeySignatureRendered && !this.rules.TabKeySignatureSpacingAdded) {
return;
// This will ignore key signatures completely, so for non-tab-only scores, vertical x-alignment will be prevented.
// If we want to x-align the startX / note startX, just not rendering the modifier is not enough.
// For tab-only scores, this is more compact though.
}
if (this.parentSourceMeasure?.isReducedToMultiRest && !this.rules.MultipleRestMeasureAddKeySignature) {
return;
}
this.stave.setKeySignature(
VexFlowConverter.keySignature(currentKey),
VexFlowConverter.keySignature(previousKey),
undefined
);
if (this.isTabMeasure && !this.rules.TabKeySignatureRendered) {
const modifiers: VF.StaveModifier[] = this.stave.getModifiers();
for (const modifier of modifiers) {
if (modifier instanceof VF.KeySignature) {
modifier.setStyle({ fillStyle: "#00000000"}); // transparent. requires VexflowPatch
// instead of not rendering the key signature, technically, we render it, but with transparent color. this helps layout / x-alignment.
// SVG compatibility: also set visibility="hidden".
// this helps make the key invisible instead of black in some systems like apps, outside the browser. (VexFlowPatch)
(modifier as any).hidden = true;
break;
}
}
}
this.updateInstructionWidth();
}
/**
* adds the given rhythm to the begin of the measure.
* This has to update/increase BeginInstructionsWidth.
* @param rhythm
*/
public addRhythmAtBegin(rhythm: RhythmInstruction): void {
if (this.isTabMeasure && !this.rules.TabTimeSignatureRendered && !this.rules.TabTimeSignatureSpacingAdded) {
return;
// This will ignore time signatures completely, so for non-tab-only scores, vertical x-alignment will be prevented.
// If we want to x-align the startX / note startX, just not rendering the modifier is not enough.
// For tab-only scores, this is more compact though.
}
const timeSig: VF.TimeSignature = VexFlowConverter.TimeSignature(rhythm);
this.stave.addModifier(
timeSig,
VF.StaveModifier.Position.BEGIN
);
if (!this.ShowTimeSignature ||
this.isTabMeasure && !this.rules.TabTimeSignatureRendered) {
// extends Element is missing from class StaveModifier in DefinitelyTyped definitions, so setStyle isn't found
timeSig.setStyle({ fillStyle: "#00000000"}); // transparent. requires VexflowPatch
// instead of not rendering the time signature, technically, we render it, but with transparent color. this helps layout / x-alignment.
// SVG compatibility: also set visibility="hidden".
// this helps make the modifier invisible instead of black in some systems like apps, outside the browser. (VexFlowPatch)
(timeSig as any).hidden = true;
}
this.updateInstructionWidth();
}
/**
* adds the given clef to the end of the measure.
* This has to update/increase EndInstructionsWidth.
* @param clef
*/
public addClefAtEnd(clef: ClefInstruction, visible: boolean = true): void {
const vfclef: { type: string, size: string, annotation: string } = VexFlowConverter.Clef(clef, "small");
if (!visible && this.stave.endClef) {
return; // don't overwrite existing clef with invisible clef
}
this.stave.setEndClef(vfclef.type, vfclef.size, vfclef.annotation);
for (const modifier of this.stave.getModifiers()) {
if (!visible) {
// make clef invisible in vexflow. (only rendered to correct layout and staffentry boundingbox)
if (modifier.getCategory() === "clefs" && modifier.getPosition() === VF.StaveModifier.Position.END) {
if ((modifier as any).type === vfclef.type) { // any = VF.Clef
const transparentStyle: string = "#12345600";
const originalStyle: any = modifier.getStyle();
if (originalStyle) {
(modifier as any).originalStrokeStyle = originalStyle.strokeStyle;
(modifier as any).originalFillStyle = originalStyle.fillStyle;
}
modifier.setStyle({strokeStyle: transparentStyle, fillStyle: transparentStyle});
}
}
} else {
// reset invisible style
const originalStrokeStyle: any = (modifier as any).originalStrokeStyle;
const originalFillStyle: any = (modifier as any).originalFillStyle;
if (modifier.getStyle()) {
if (originalStrokeStyle && originalFillStyle) {
modifier.getStyle().strokeStyle = originalStrokeStyle;
modifier.getStyle().fillStyle = originalFillStyle;
} else {
modifier.getStyle().strokeStyle = null;
modifier.getStyle().fillStyle = null;
}
}
}
}
this.parentSourceMeasure.hasEndClef = true;
return this.updateInstructionWidth();
}
// Render initial line is whether or not to render a single bar line at the beginning (if the repeat line we are drawing is
// offset by a clef, for ex.)
public addMeasureLine(lineType: SystemLinesEnum, linePosition: SystemLinePosition, renderInitialLine: boolean = true): void {
switch (linePosition) {
case SystemLinePosition.MeasureBegin:
switch (lineType) {
case SystemLinesEnum.BoldThinDots:
//customize the barline draw function if repeat is beginning of system
if (!renderInitialLine) {
(this.stave as any).modifiers[0].draw = function(stave: VF.Stave): void {
(stave as any).checkContext();
this.setRendered();
switch (this.type) {
case VF.Barline.type.SINGLE:
this.drawVerticalBar(stave, this.x, false);
break;
case VF.Barline.type.DOUBLE:
this.drawVerticalBar(stave, this.x, true);
break;
case VF.Barline.type.END:
this.drawVerticalEndBar(stave, this.x);
break;
case VF.Barline.type.REPEAT_BEGIN:
//removed the vertical line rendering that exists in VF codebase
this.drawRepeatBar(stave, this.x, true);
break;
case VF.Barline.type.REPEAT_END:
this.drawRepeatBar(stave, this.x, false);
break;
case VF.Barline.type.REPEAT_BOTH:
this.drawRepeatBar(stave, this.x, false);
this.drawRepeatBar(stave, this.x, true);
break;
default:
// Default is NONE, so nothing to draw
break;
}
};
}
this.stave.setBegBarType(VF.Barline.type.REPEAT_BEGIN);
break;
default:
//this.stave.setBegBarType(VF.Barline.type.NONE); // not necessary, it seems
break;
}
break;
case SystemLinePosition.MeasureEnd:
switch (lineType) {
case SystemLinesEnum.DotsBoldBoldDots:
this.stave.setEndBarType(VF.Barline.type.REPEAT_BOTH);
break;
case SystemLinesEnum.DotsThinBold:
this.stave.setEndBarType(VF.Barline.type.REPEAT_END);
break;
case SystemLinesEnum.DoubleThin:
this.stave.setEndBarType(VF.Barline.type.DOUBLE);
break;
case SystemLinesEnum.ThinBold:
this.stave.setEndBarType(VF.Barline.type.END);
break;
case SystemLinesEnum.None:
this.stave.setEndBarType(VF.Barline.type.NONE);
break;
// TODO: Add support for additional Barline types when VexFlow supports them
default:
break;
}
break;
default:
break;
}
}
/**
* Adds a measure number to the top left corner of the measure
* This method is not used currently in favor of the calculateMeasureNumberPlacement
* method in the MusicSheetCalculator.ts
*/
public addMeasureNumber(): void {
const text: string = this.MeasureNumber.toString();
const position: number = StavePositionEnum.ABOVE; //VF.StaveModifier.Position.ABOVE;
this.stave.setText(text, position, {
justification: 1,
shift_x: 0,
shift_y: 0,
});
}
public addWordRepetition(repetitionInstruction: RepetitionInstruction): void {
let instruction: number | undefined;
let position: number = VF.StaveModifier.Position.END;
const xShift: number = this.beginInstructionsWidth;
switch (repetitionInstruction.type) {
case RepetitionInstructionEnum.Segno:
// create Segno Symbol:
instruction = VF.Repetition.type.SEGNO_LEFT;
position = VF.StaveModifier.Position.LEFT;
break;
case RepetitionInstructionEnum.Coda:
// create Coda Symbol:
instruction = VF.Repetition.type.CODA_LEFT;
position = VF.StaveModifier.Position.LEFT;
break;
case RepetitionInstructionEnum.DaCapo:
instruction = VF.Repetition.type.DC;
break;
case RepetitionInstructionEnum.DalSegno:
instruction = VF.Repetition.type.DS;
break;
case RepetitionInstructionEnum.Fine:
instruction = VF.Repetition.type.FINE;
break;
case RepetitionInstructionEnum.ToCoda:
instruction = (VF.Repetition as any).type.TO_CODA;
break;
case RepetitionInstructionEnum.DaCapoAlFine:
instruction = VF.Repetition.type.DC_AL_FINE;
break;
case RepetitionInstructionEnum.DaCapoAlCoda:
instruction = VF.Repetition.type.DC_AL_CODA;
break;
case RepetitionInstructionEnum.DalSegnoAlFine:
instruction = VF.Repetition.type.DS_AL_FINE;
break;
case RepetitionInstructionEnum.DalSegnoAlCoda:
instruction = VF.Repetition.type.DS_AL_CODA;
break;
default:
break;
}
if (instruction) {
const repetition: VF.Repetition = new VF.Repetition(instruction, xShift, -this.rules.RepetitionSymbolsYOffset);
(repetition as any).xShiftAsPercentOfStaveWidth = this.rules.RepetitionEndInstructionXShiftAsPercentOfStaveWidth;
this.stave.addModifier(repetition, position);
return;
}
this.addVolta(repetitionInstruction);
}
protected addVolta(repetitionInstruction: RepetitionInstruction): void {
let voltaType: number = VF.Volta.type.BEGIN;
if (repetitionInstruction.type === RepetitionInstructionEnum.Ending) {
switch (repetitionInstruction.alignment) {
case AlignmentType.Begin:
if (this.parentSourceMeasure.endsRepetitionEnding()) {
voltaType = VF.Volta.type.BEGIN_END;
} else {
voltaType = VF.Volta.type.BEGIN;
}
break;
case AlignmentType.End:
if (this.parentSourceMeasure.beginsRepetitionEnding()) {
//voltaType = VF.Volta.type.BEGIN_END;
// don't add BEGIN_END volta a second time:
return;
} else {
voltaType = VF.Volta.type.END;
}
break;
default:
break;
}
const skyBottomLineCalculator: SkyBottomLineCalculator = this.ParentStaffLine.SkyBottomLineCalculator;
//Because of loss of accuracy when sampling (see SkyBottomLineCalculator.updateInRange), measures tend to overlap
//This causes getSkyLineMinInRange to return an incorrect min value (one from the previous measure, which has been modified)
//We need to offset the end of what we are measuring by a bit to prevent this, otherwise volta pairs step up
const start: number = this.PositionAndShape.AbsolutePosition.x + this.PositionAndShape.BorderMarginLeft + 0.4;
const end: number = Math.max(this.PositionAndShape.AbsolutePosition.x + this.PositionAndShape.BorderMarginRight, start + 0.4);
//2 unit gap, since volta is positioned from y center it seems.
//This prevents cases where the volta is rendered over another element
const skylineMinForMeasure: number = skyBottomLineCalculator.getSkyLineMinInRange( start, end ) - 2;
//-6 OSMD units is the 0 value that the volta is placed on. .1 extra so the skyline goes above the volta
//instead of on the line itself
let newSkylineValueForMeasure: number = -6.1 + this.rules.VoltaOffset;
let vexFlowVoltaHeight: number = this.rules.VoltaOffset;
//EngravingRules default offset is 2.5, can be user set.
//2.5 gives us a good default value to work with.
//if we calculate that the minimum skyline allowed by elements is above the default volta position, need to adjust volta up further
if (skylineMinForMeasure < newSkylineValueForMeasure) {
const skylineDifference: number = skylineMinForMeasure - newSkylineValueForMeasure;
vexFlowVoltaHeight += skylineDifference;
newSkylineValueForMeasure = skylineMinForMeasure;
}
let prevMeasure: VexFlowMeasure = undefined;
//if we already have a volta in the prev measure, should match it's height, or if we are higher, it should match ours
//find previous sibling measure that may have volta
const currentMeasureNumber: number = this.parentSourceMeasure.MeasureNumber;
for (let i: number = 0; i < this.ParentStaffLine.Measures.length; i++) {
const tempMeasure: GraphicalMeasure = this.ParentStaffLine.Measures[i];
if (!(tempMeasure instanceof VexFlowMeasure)) {
// can happen for MultipleRestMeasures
continue;
}
if (tempMeasure.MeasureNumber === currentMeasureNumber - 1 ||
tempMeasure.MeasureNumber + tempMeasure.parentSourceMeasure?.multipleRestMeasures === currentMeasureNumber) {
//We found the previous top measure
prevMeasure = tempMeasure as VexFlowMeasure;
}
}
if (prevMeasure) {
const prevStaveModifiers: VF.StaveModifier[] = prevMeasure.stave.getModifiers();
for (let i: number = 0; i < prevStaveModifiers.length; i++) {
const nextStaveModifier: VF.StaveModifier = prevStaveModifiers[i];
if (nextStaveModifier.hasOwnProperty("volta")) {
const prevskyBottomLineCalculator: SkyBottomLineCalculator = prevMeasure.ParentStaffLine.SkyBottomLineCalculator;
const prevStart: number = prevMeasure.PositionAndShape.AbsolutePosition.x + prevMeasure.PositionAndShape.BorderMarginLeft + 0.4;
const prevEnd: number = Math.max(
prevMeasure.PositionAndShape.AbsolutePosition.x + prevMeasure.PositionAndShape.BorderMarginRight,
prevStart + 0.4);
const prevMeasureSkyline: number = prevskyBottomLineCalculator.getSkyLineMinInRange(prevStart, prevEnd);
//if prev skyline is higher, use it
if (prevMeasureSkyline <= newSkylineValueForMeasure) {
const skylineDifference: number = prevMeasureSkyline - newSkylineValueForMeasure;
vexFlowVoltaHeight += skylineDifference;
newSkylineValueForMeasure = prevMeasureSkyline;
} else { //otherwise, we are higher. Need to adjust prev
(nextStaveModifier as any).y_shift = vexFlowVoltaHeight * unitInPixels;
prevMeasure.ParentStaffLine.SkyBottomLineCalculator.updateSkyLineInRange(prevStart, prevEnd, newSkylineValueForMeasure);
}
}
}
}
//convert to VF units (pixels)
vexFlowVoltaHeight *= 10;
this.stave.setVoltaType(voltaType, repetitionInstruction.endingIndices[0], vexFlowVoltaHeight);
skyBottomLineCalculator.updateSkyLineInRange(start, end, newSkylineValueForMeasure);
}
}
/**
* Sets the overall x-width of the measure.
* @param width
*/
public setWidth(width: number): void {
super.setWidth(width);
// Set the width of the VF.Stave
this.stave.setWidth(width * unitInPixels);
// Force the width of the Begin Instructions
//this.stave.setNoteStartX(this.beginInstructionsWidth * UnitInPixels);
}
/**
* This method is called after the StaffEntriesScaleFactor has been set.
* Here the final x-positions of the staff entries have to be set.
* (multiply the minimal positions with the scaling factor, considering the BeginInstructionsWidth)
*/
public layoutSymbols(): void {
// vexflow does the x-layout
}
/**
* Draw this measure on a VexFlow CanvasContext
* @param ctx
*/
public draw(ctx: Vex.IRenderContext): void {
// Draw stave lines
this.stave.setContext(ctx).draw();
// Draw all voices
for (const voiceID in this.vfVoices) {
if (this.vfVoices.hasOwnProperty(voiceID)) {
ctx.save();
this.vfVoices[voiceID].draw(ctx, this.stave);
ctx.restore();
// this.vfVoices[voiceID].tickables.forEach(t => t.getBoundingBox().draw(ctx));
// this.vfVoices[voiceID].tickables.forEach(t => t.getBoundingBox().draw(ctx));
}
}
// Draw beams
for (const voiceID in this.vfbeams) {
if (this.vfbeams.hasOwnProperty(voiceID)) {
for (const beam of this.vfbeams[voiceID]) {
beam.setContext(ctx).draw();
}
}
}
// Draw auto-generated beams from Beam.generateBeams()
if (this.autoVfBeams) {
for (const beam of this.autoVfBeams) {
beam.setContext(ctx).draw();
}
}
if (!this.isTabMeasure || this.rules.TupletNumbersInTabs) {
if (this.autoTupletVfBeams) {
for (const beam of this.autoTupletVfBeams) {
beam.setContext(ctx).draw();
}
}
// Draw tuplets
for (const voiceID in this.vftuplets) {
if (this.vftuplets.hasOwnProperty(voiceID)) {
for (let i: number = 0; i < this.tuplets[voiceID].length; i++) {
const tuplet: Tuplet = this.tuplets[voiceID][i][0];
const vftuplet: VF.Tuplet = this.vftuplets[voiceID][i];
if (!vftuplet) { // see #1330, potentially to be investigated. why undefined?
continue;
}
if (!tuplet.RenderTupletNumber ||
tuplet.ShowNumberNoneGivenInXml && this.rules.TupletNumberUseShowNoneXMLValue) {
// (vftuplet as any).numerator_glyphs_stored = [...(vftuplet as any).numerator_glyphs];
// (vftuplet as any).numerator_glyphs = [];
(vftuplet as any).RenderTupletNumber = false;
} else {
// issue with restoring glyphs (version without vexflowpatch): need to deep copy array, otherwise the reference is overwritten
// (vftuplet as any).numerator_glyphs = [...(vftuplet as any).numerator_glyphs_stored];
// (vftuplet as any).numerator_glyphs_stored = undefined;
(vftuplet as any).RenderTupletNumber = true;
}
vftuplet.setContext(ctx).draw();
}
}
}
}
// Draw ties
for (const tie of this.vfTies) {
if (tie instanceof VF.TabSlide) {
return; // rendered later in VexFlowMusicSheetDrawer.drawGlissandi(), when all staffline measures are rendered
}
tie.setContext(ctx);
tie.draw();
}
// Draw vertical lines
for (const connector of this.connectors) {
connector.setContext(ctx).draw();
}
this.correctNotePositions();
}
// this currently formats multiple measures, see VexFlowMusicSheetCalculator.formatMeasures()
public format(): void {
// If this is the first stave in the vertical measure, call the format
// method to set the width of all the voices
if (this.formatVoices) {
// set the width of the voices to the current measure width:
// (The width of the voices does not include the instructions (StaveModifiers))
this.formatVoices((this.PositionAndShape.Size.width - this.beginInstructionsWidth - this.endInstructionsWidth) * unitInPixels, this);
}
// this.correctNotePositions(); // now done at the end of draw()
}
// correct position / bounding box (note.setIndex() needs to have been called)
public correctNotePositions(): void {
if (this.isTabMeasure) {
return;
}
for (const voice of this.getVoicesWithinMeasure()) {
for (const ve of voice.VoiceEntries) {
for (const note of ve.Notes) {
const gNote: VexFlowGraphicalNote = this.rules.GNote(note) as VexFlowGraphicalNote;
if (!gNote?.vfnote) { // can happen were invisible, then multi rest measure. TODO fix multi rest measure not removed
return;
}
const vfnote: VF.StemmableNote = gNote.vfnote[0];
// if (note.isRest()) // TODO somehow there are never rest notes in ve.Notes
// TODO also, grace notes are not included here, need to be fixed as well. (and a few triple beamed notes in Bach Air)
let relPosY: number = 0;
if (gNote.parentVoiceEntry.parentVoiceEntry.StemDirection === StemDirectionType.Up && gNote.vfnote[0].getDuration() !== "w") {
relPosY += 3.5; // about 3.5 lines too high. this seems to be related to the default stem height, not actual stem height.
// alternate calculation using actual stem height: somehow wildly varying.
// if (ve.Notes.length > 1) {
// const stemHeight: number = vfnote.getStem().getHeight();
// // relPosY += shortFactor * stemHeight / unitInPixels - 3.5;
// relPosY += stemHeight / unitInPixels - 3.5; // for some reason this varies in its correctness between similar notes
// } else {
// relPosY += 3.5;
// }
} else {
relPosY += 0.5; // center-align bbox
}
const line: number = -gNote.notehead(vfnote).line; // vexflow y direction is opposite of osmd's
relPosY += line + (gNote.parentVoiceEntry.notes.last() as VexFlowGraphicalNote).notehead().line; // don't move for first note: - (-vexline)
gNote.PositionAndShape.RelativePosition.y = relPosY;
}
}
}
}
/**
* Returns all the voices that are present in this measure
*/
public getVoicesWithinMeasure(): Voice[] {
const voices: Voice[] = [];
for (const gse of this.staffEntries) {
for (const gve of gse.graphicalVoiceEntries) {
if (voices.indexOf(gve.parentVoiceEntry.ParentVoice) === -1) {
voices.push(gve.parentVoiceEntry.ParentVoice);
}
}
}
return voices;
}
/**
* Returns all the graphicalVoiceEntries of a given Voice.
* @param voice the voice for which the graphicalVoiceEntries shall be returned.
*/
public getGraphicalVoiceEntriesPerVoice(voice: Voice): GraphicalVoiceEntry[] {
const voiceEntries: GraphicalVoiceEntry[] = [];
for (const gse of this.staffEntries) {
for (const gve of gse.graphicalVoiceEntries) {
if (gve.parentVoiceEntry.ParentVoice === voice) {
voiceEntries.push(gve);
}
}
}
return voiceEntries;
}
/**
* Finds the gaps between the existing notes within a measure.
* Problem here is, that the graphicalVoiceEntry does not exist yet and
* that Tied notes are not present in the normal voiceEntries.
* To handle this, calculation with absolute timestamps is needed.
* And the graphical notes have to be analysed directly (and not the voiceEntries, as it actually should be -> needs refactoring)
* @param voice the voice for which the ghost notes shall be searched.
*/
protected getRestFilledVexFlowStaveNotesPerVoice(voice: Voice): GraphicalVoiceEntry[] {
let latestVoiceTimestamp: Fraction;
let gvEntries: GraphicalVoiceEntry[] = this.getGraphicalVoiceEntriesPerVoice(voice);
for (let idx: number = 0; idx < gvEntries.length; idx++) {
const gve: GraphicalVoiceEntry = gvEntries[idx];
const gNotesStartTimestamp: Fraction = gve.notes[0].sourceNote.getAbsoluteTimestamp();
// find the voiceEntry end timestamp:
let gNotesEndTimestamp: Fraction = new Fraction();
for (const graphicalNote of gve.notes) {
const noteEnd: Fraction = Fraction.plus(graphicalNote.sourceNote.getAbsoluteTimestamp(), graphicalNote.sourceNote.Length);
if (gNotesEndTimestamp.lt(noteEnd)) {
gNotesEndTimestamp = noteEnd;
}
}
// check if this voice has just been found the first time:
if (!latestVoiceTimestamp) {
// if this voice is new, check for a gap from measure start to the start of the current voice entry:
const gapFromMeasureStart: Fraction = Fraction.minus(gNotesStartTimestamp, this.parentSourceMeasure.AbsoluteTimestamp);
if (gapFromMeasureStart.RealValue > 0) {
log.trace(`Ghost Found at start (measure ${this.MeasureNumber})`); // happens too often for valid measures to be logged to debug
const ghostGves: GraphicalVoiceEntry[] = this.createGhostGves(gapFromMeasureStart);
gvEntries.splice(0, 0, ...ghostGves);
idx += ghostGves.length;
}
} else {
// get the length of the empty space between notes:
const inBetweenLength: Fraction = Fraction.minus(gNotesStartTimestamp, latestVoiceTimestamp);
if (inBetweenLength.RealValue > 0) {
log.trace(`Ghost Found in between (measure ${this.MeasureNumber})`); // happens too often for valid measures to be logged to debug
const ghostGves: VexFlowVoiceEntry[] = this.createGhostGves(inBetweenLength);
// add elements before current element:
gvEntries.splice(idx, 0, ...ghostGves);
// and increase index, as we added elements:
idx += ghostGves.length;
}
}
// finally set the latest timestamp of this voice to the end timestamp of the longest note in the current voiceEntry:
latestVoiceTimestamp = gNotesEndTimestamp;
}
const measureEndTimestamp: Fraction = Fraction.plus(this.parentSourceMeasure.AbsoluteTimestamp, this.parentSourceMeasure.Duration);
const restLength: Fraction = Fraction.minus(measureEndTimestamp, latestVoiceTimestamp);
if (restLength.RealValue > 0) {
// fill the gap with a rest ghost note
// starting from lastFraction
// with length restLength:
log.trace(`Ghost Found at end (measure ${this.MeasureNumber})`); // happens too often for valid measures to be logged to debug
const ghostGves: VexFlowVoiceEntry[] = this.createGhostGves(restLength);
gvEntries = gvEntries.concat(ghostGves);
}
return gvEntries;
}
private createGhostGves(duration: Fraction): VexFlowVoiceEntry[] {
const vfghosts: VF.GhostNote[] = VexFlowConverter.GhostNotes(duration);
const ghostGves: VexFlowVoiceEntry[] = [];
for (const vfghost of vfghosts) {
const ghostGve: VexFlowVoiceEntry = new VexFlowVoiceEntry(undefined, undefined, this.rules);
ghostGve.vfStaveNote = vfghost;
ghostGves.push(ghostGve);
}
return ghostGves;
}
/**
* Add a note to a beam
* @param graphicalNote
* @param beam
*/
public handleBeam(graphicalNote: GraphicalNote, beam: Beam): void {
const voiceID: number = graphicalNote.sourceNote.ParentVoiceEntry.ParentVoice.VoiceId;
let beams: [Beam, VexFlowVoiceEntry[]][] = this.beams[voiceID];
if (!beams) {
beams = this.beams[voiceID] = [];
}
let data: [Beam, VexFlowVoiceEntry[]];
for (const mybeam of beams) {
if (mybeam[0] === beam) {
data = mybeam;
}
}
if (!data) {
data = [beam, []];
beams.push(data);
}
const parent: VexFlowVoiceEntry = graphicalNote.parentVoiceEntry as VexFlowVoiceEntry;
if (data[1].indexOf(parent) < 0) {
data[1].push(parent);
}
}
public handleTuplet(graphicalNote: GraphicalNote, tuplet: Tuplet): void {
const voiceID: number = graphicalNote.sourceNote.ParentVoiceEntry.ParentVoice.VoiceId;
tuplet = graphicalNote.sourceNote.NoteTuplet;
let tuplets: [Tuplet, VexFlowVoiceEntry[]][] = this.tuplets[voiceID];
if (!tuplets) {
tuplets = this.tuplets[voiceID] = [];
}
let currentTupletBuilder: [Tuplet, VexFlowVoiceEntry[]];
for (const t of tuplets) {
if (t[0] === tuplet) {
currentTupletBuilder = t;
}
}
if (!currentTupletBuilder) {
currentTupletBuilder = [tuplet, []];
tuplets.push(currentTupletBuilder);
}
const parent: VexFlowVoiceEntry = graphicalNote.parentVoiceEntry as VexFlowVoiceEntry;
if (currentTupletBuilder[1].indexOf(parent) < 0) {
currentTupletBuilder[1].push(parent);
}
}
/**
* Complete the creation of VexFlow Beams in this measure
*/
public finalizeBeams(): void {
// The following line resets the created Vex.Flow Beams and
// created them brand new. Is this needed? And more importantly,
// should the old beams be removed manually by the notes?
this.vfbeams = {};
if (this.isTabMeasure && !this.rules.TabBeamsRendered) {
return; // fixes tab beams rendered in test_slide_glissando when TabBeamsRendered = false
}
const beamedNotes: StaveNote[] = []; // already beamed notes, will be ignored by this.autoBeamNotes()
for (const voiceID in this.beams) {
if (this.beams.hasOwnProperty(voiceID)) {
let vfbeams: VF.Beam[] = this.vfbeams[voiceID];
if (!vfbeams) {
vfbeams = this.vfbeams[voiceID] = [];
}
for (const beam of this.beams[voiceID]) {
let beamHasQuarterNoteOrLonger: boolean = false;
for (const note of beam[0].Notes) {
if (note.Length.RealValue >= new Fraction(1, 4).RealValue
// check whether the note has a TypeLength that's also not suitable for a beam (bigger than an eigth)
&& (!note.TypeLength || note.TypeLength.RealValue > 0.125)) {
beamHasQuarterNoteOrLonger = true;
break;
}
}
if (beamHasQuarterNoteOrLonger) {
log.debug("Beam between note >= quarter, likely tremolo, currently unsupported. continuing.");
continue;
}
const notes: VF.StaveNote[] = [];
const psBeam: Beam = beam[0];
const voiceEntries: VexFlowVoiceEntry[] = beam[1];
let autoStemBeam: boolean = true;
for (const gve of voiceEntries) {
if (gve.parentVoiceEntry.ParentVoice === psBeam.Notes[0].ParentVoiceEntry.ParentVoice) {
autoStemBeam = gve.parentVoiceEntry.WantedStemDirection === StemDirectionType.Undefined;
// if (psBeam.Notes[0].NoteTuplet) {
// autoStemBeam = true;
// // this fix seemed temporarily necessary for tuplets with beams, see test_drum_tublet_beams
// break;
// }
}
}
let isGraceBeam: boolean = false;
let beamColor: string;
const stemColors: string[] = [];
for (const entry of voiceEntries) {
const note: VF.StaveNote = entry.vfStaveNote as StaveNote;
if (note) {
notes.push(note);
beamedNotes.push(note);
}
if (entry.parentVoiceEntry.IsGrace) {
isGraceBeam = true;
}
if (entry.parentVoiceEntry.StemColor && this.rules.ColoringEnabled) {
stemColors.push(entry.parentVoiceEntry.StemColor);
}
}
if (notes.length > 1) {
const vfBeam: VF.Beam = new VF.Beam(notes, autoStemBeam);
if (isGraceBeam) {
// smaller beam, as in Vexflow.GraceNoteGroup.beamNotes()
(<any>vfBeam).render_options.beam_width = 3;
(<any>vfBeam).render_options.partial_beam_length = 4;
}
if (stemColors.length >= 2 && this.rules.ColorBeams) {
beamColor = stemColors[0];
for (const stemColor of stemColors) {
if (stemColor !== beamColor) {
beamColor = undefined;
break;
}
}
vfBeam.setStyle({ fillStyle: beamColor, strokeStyle: beamColor });
}
if (this.rules.FlatBeams) {
(<any>vfBeam).render_options.flat_beams = true;
(<any>vfBeam).render_options.flat_beam_offset = this.rules.FlatBeamOffset;
(<any>vfBeam).render_options.flat_beam_offset_per_beam = this.rules.FlatBeamOffsetPerBeam;
}
vfbeams.push(vfBeam);
} else {
log.debug("Warning! Beam with no notes!");
}
}
}
}
if (this.rules.AutoBeamNotes) {