Implement curves

Author: MatthewDorner

lib/main/draw-to-context.js

@@ -2,6 +2,7 @@ import Vex from 'vexflow';
 import { Stave } from 'vexflow/src/stave';
 import { TabStave } from 'vexflow/src/tabstave';
 import { Formatter } from 'vexflow/src/formatter';
+import { Curve } from 'vexflow/src/curve';
 import { convertKeySignature } from '../utils';
 
 /**
@@ -20,7 +21,6 @@ export default function drawToContext(context, tune) {
 
  tune.parts.forEach((part) => {
  part.bars.forEach((bar) => {
-
  let tabsPositionY;
  if (tune.renderOptions.staveVisibility) {
  tabsPositionY = bar.position.y + 60;
@@ -94,5 +94,15 @@ export default function drawToContext(context, tune) {
  });
  }
  });
+
+ // DRAW CURVES
+ part.curves.forEach((partCurve) => {
+ const vexCurve = new Curve(partCurve.startNote, partCurve.endNote, {
+ thickness: 2,
+ cps: [{ x: -5, y: 7 }, { x: 0, y: 7 }],
+ x_shift: -10
+ });
+ vexCurve.setContext(context).draw();
+ });
  });
 }

lib/main/generate-vex-objects.js

@@ -13,7 +13,7 @@ import Bar from '../models/bar';
 import Part from '../models/part';
 import Tune from '../models/tune';
 
-import { getKeys, getVexDuration, addDecorations, getTabPosition } from '../utils';
+import { getKeys, getVexDuration, addDecorations, getTabPosition, generateBeamsCompound } from '../utils';
 import { VEX_ACCIDENTAL_FROM_ABCJS } from '../constants';
 
 /**
@@ -163,6 +163,36 @@ export default function generateVexObjects(partRegions, tuneAttrs, renderOptions
  tabNoteToAdd.addModifier(tabGraceNoteGroup);
  }
 
+ obj.pitches.forEach((pitch) => {
+ if (pitch.startTie) {
+ currentPart.curves.push({
+ startNote: noteToAdd
+ });
+ }
+ if (pitch.endTie) {
+ currentPart.curves[currentPart.curves.length - 1].endNote = noteToAdd;
+ }
+ if (pitch.startSlur) {
+ pitch.startSlur.forEach(() => {
+ currentPart.curves.push({
+ startNote: noteToAdd
+ });
+ });
+ }
+ if (pitch.endSlur) {
+ pitch.endSlur.forEach(() => {
+ let i = currentPart.curves.length - 1;
+ while (i >= 0) {
+ if (!currentPart.curves[i].endNote) {
+ currentPart.curves[i].endNote = noteToAdd;
+ return;
+ }
+ i += -1;
+ }
+ });
+ }
+ });
+
  currentBar.tabNotes.push(tabNoteToAdd);
  } else { // IS a rest
  noteToAdd = new StaveNote({
@@ -198,7 +228,7 @@ export default function generateVexObjects(partRegions, tuneAttrs, renderOptions
  if (obj.endTriplet && inTriplet) {
  currentBar.tuplets.push(new Tuplet(inTriplet.notes, {
  num_notes: inTriplet.num_notes,
- notes_occupied: inTriplet.notes_occupied,
+ notes_occupied: inTriplet.notes_occupied
  }));
  // I think still need to create tuplets for the tabNotes so they align correctly,
  // but don't want to draw them because it's already drawn in the regular stave
@@ -210,17 +240,21 @@ export default function generateVexObjects(partRegions, tuneAttrs, renderOptions
  }
  }); // end of barRegion.contents.forEach
 
+ const { meter } = tune.tuneAttrs;
+
  // set the voice so setBarPositions can use it to have VexFlow Formatter figure out the space needed
- const meterArray = tune.tuneAttrs.meter.split('/');
+ const meterArray = meter.split('/');
  const voice = new Voice({ num_beats: meterArray[0], beat_value: meterArray[1] });
  voice.setStrict(false);
  voice.addTickables(currentBar.notes);
  currentBar.voice = voice;
 
- if (tuneAttrs.meter === '4/4') {
+ if (meter === '4/4') {
  currentBar.beams = Beam.generateBeams(currentBar.notes, { groups: [new Vex.Flow.Fraction(2, 4)] });
+ } else if (meter === '3/8' || meter === '6/8' || meter === '9/8' || meter === '12/8') {
+ currentBar.beams = generateBeamsCompound(currentBar.notes);
  } else {
- currentBar.beams = Beam.generateBeams(currentBar.notes, { groups: Beam.getDefaultBeamGroups(tuneAttrs.meter) });
+ currentBar.beams = Beam.generateBeams(currentBar.notes, { groups: Beam.getDefaultBeamGroups(meter) });
  }
  });
  });

lib/main/set-bar-positions.js

@@ -100,6 +100,24 @@ export default function setBarPositions(tune) {
 
  return newBar;
  });
+
+ let firstBarY;
+ newPart.curves.forEach((curve) => {
+ newPart.bars.forEach((bar) => {
+ bar.notes.forEach((note) => {
+ if (note === curve.startNote) {
+ firstBarY = bar.position.y;
+ }
+ if (note === curve.endNote) {
+ if (firstBarY !== bar.position.y) {
+ newPart.curves.push({ endNote: curve.endNote });
+ curve.endNote = null;
+ }
+ }
+ });
+ });
+ });
+
  return newPart;
  });
  return newTune;

lib/models/part.js

@@ -2,6 +2,7 @@ export default class Part {
  constructor(title) {
  this.title = title; // i don't really use this...
  this.bars = []; // the Bar class from bar.js
+ this.curves = [];
  Object.seal(this);
  }
 }

lib/test-data/abc-key-signatures.js

@@ -23,5 +23,21 @@ const BFlatMajor = {
  }
  ]
 };
-const AbcKeySignatures = { CMajor, GMajor, BFlatMajor };
+
+const DMajor = {
+ accidentals: [
+ {
+ acc: 'sharp',
+ note: 'c'
+ },
+ {
+ acc: 'sharp',
+ note: 'f'
+ }
+
+ ]
+
+};
+
+const AbcKeySignatures = { CMajor, DMajor, GMajor, BFlatMajor };
 export default AbcKeySignatures;

lib/utils/get-tab-position.js

@@ -195,7 +195,6 @@ function convertToFingering(fret) {
  * fret, but we can enter any string for fret, so we just write the positions in string form on the first line of tablature
  */
 function getHarmonicaPosition(adjustedAbsoluteChromatic, pitchOffset) {
-
  // 'd' = draw bend, 'b' = blow bend, 'ob' = overblow, 'od' = overdraw
  const harmonicaPositions = [
  '^1', // c
@@ -257,35 +256,35 @@ function getHarmonicaPosition(adjustedAbsoluteChromatic, pitchOffset) {
  */
 function getTinWhistlePosition(adjustedAbsoluteChromatic, pitchOffset) {
  const whistlePositions = [
- '6', // D
+ '6', // D, 1
  '5½',
- '5', // E
+ '5', // E, M2
  '4½', // F
- '4',
- '3', // G
+ '4', // M3
+ '3', // G, P4
  '2½',
- '2', // A
+ '2', // A, P5
  '1½',
- '1', // B
+ '1', // B, M6
  '½', // C
- '0',
- '6+', // D
+ '0', // M7
+ '6+', // D, P8
  '5½+',
- '5+', // E
+ '5+', // E, M2
  '4½+', // F
- '4+',
- '3+', // G
+ '4+', // M3
+ '3+', // G, P4
  '2½+',
- '2+', // A
+ '2+', // A, P5
  '1½+',
- '1+', // B
+ '1+', // B, M6
  '½+', // C
- '0+'
+ '0+' // M7
  ];
 
+ // pitch offset for C is -2...
  const startPitch = 50 + pitchOffset;
 
-
  if (adjustedAbsoluteChromatic - startPitch >= 0 && adjustedAbsoluteChromatic - startPitch < whistlePositions.length) {
  return [{ str: 1, fret: whistlePositions[adjustedAbsoluteChromatic - startPitch] }];
  }

lib/utils/tests/generate-beams-compound.test.js

@@ -16,7 +16,7 @@ import { generateBeamsCompound } from '../index';
 // each test case should present an entire bar's worth of notes, for simplicity
 // also test tuplets
 
-jest.mock('vexflow/src/beam');
+jest.mock('../../vexflow/build/cjs/vexflow');
 Beam.mockReturnValue(null);
 
 test('6 8th notes should result in 2 beams of 3 notes each', () => {
@@ -29,7 +29,7 @@ test('6 8th notes should result in 2 beams of 3 notes each', () => {
  expect(Beam.mock.calls[1][0].length).toBe(3); // 3 notes in the second beam
 });
 
-jest.mock('vexflow/src/beam');
+jest.mock('../../vexflow/build/cjs/vexflow');
 Beam.mockReturnValue(null);
 
 // change this to a dotted quarter

lib/utils/tests/get-tab-position.test.js

@@ -1,4 +1,5 @@
 import { getTabPosition } from '../index';
+import { TUNINGS } from '../../constants/tunings';
 
 import AbcObjects from '../../test-data/abcjs-objects';
 import AbcKeySignatures from '../../test-data/abc-key-signatures';
@@ -182,3 +183,33 @@ test('grace note - accidental on n-1 regular note will apply to grace note n ove
  // The sharp accidental from the n-1 note should be applied, not the flat from the n-1 grace note
  expect(getTabPosition(keys, abcKeySignature, barContents, 1, tuning, true)).toStrictEqual([{ str: 1, fret: 2 }]);
 });
+
+// TEST FOR TIN WHISTLE
+test('tin whistle - C Major scale for C whistle', () => {
+ // each will be put into its own single-element keys[] array
+ const noteKeys = ['c/4', 'd/4', 'e/4', 'f/4', 'g/4', 'a/4', 'b/4', 'c/5', 'd/5', 'e/5', 'f/5', 'g/5', 'a/5', 'b/5'];
+ const abcKeySignature = AbcKeySignatures.CMajor;
+
+ const barContents = []; // this wouldn't be empty but if it's OK I'll leave it?
+
+ const expectedPositions = [
+ '6',
+ '5',
+ '4',
+ '3',
+ '2',
+ '1',
+ '0',
+ '6+',
+ '5+',
+ '4+',
+ '3+',
+ '2+',
+ '1+',
+ '0+'
+ ];
+
+ expectedPositions.forEach((position, i) => {
+ expect(getTabPosition([noteKeys[i]], abcKeySignature, barContents, 1, TUNINGS.TIN_WHISTLE_C, false)).toStrictEqual([{ str: 1, fret: position }]);
+ });
+});

lib/vexflow

@@ -0,0 +1 @@
+Subproject commit dadc65fb797e1405ac960a860d4b8dcea421d435