@huffduff/midi-writer-ts 3.2.0 → 3.2.2

package/src/vexflow.ts

@@ -0,0 +1,96 @@
+import {NoteEvent} from './midi-events/note-event';
+import {Track} from './chunks/track';
+
+class VexFlow {
+
+	/**
+	 * Support for converting VexFlow voice into MidiWriterJS track
+	 * @return MidiWriter.Track object
+	 */
+	trackFromVoice(voice, options = {addRenderedAccidentals: false}): Track {
+		const track = new Track;
+		let wait = [];
+
+		voice.tickables.forEach(tickable => {
+			if (tickable.noteType === 'n') {
+				track.addEvent(new NoteEvent({
+					pitch: tickable.keys.map((pitch, index) => this.convertPitch(pitch, index, tickable, options.addRenderedAccidentals)),
+					duration: this.convertDuration(tickable),
+					wait
+				}));
+				// reset wait
+				wait = [];
+			} else if (tickable.noteType === 'r') {
+				// move on to the next tickable and add this to the stack
+				// of the `wait` property for the next note event
+				wait.push(this.convertDuration(tickable));
+			}
+		});
+
+		// There may be outstanding rests at the end of the track,
+		// pad with a ghost note (zero duration and velocity), just to capture the wait.
+		if(wait.length > 0) {
+			track.addEvent(new NoteEvent({pitch: '[c4]', duration: '0', wait, velocity: '0'}));
+		}
+
+		return track;
+	}
+
+	/**
+	 * Converts VexFlow pitch syntax to MidiWriterJS syntax
+	 * @param pitch string
+	 * @param index pitch index
+	 * @param note struct from Vexflow
+	 * @param addRenderedAccidentals adds Vexflow rendered accidentals
+	 */
+	convertPitch(pitch, index, note, addRenderedAccidentals = false) {
+		// Splits note name from octave
+		const pitchParts = pitch.split('/');
+
+		// Retrieves accidentals from pitch
+		// Removes natural accidentals since they are not accepted in Tonal Midi
+		let accidentals = pitchParts[0].substring(1).replace('n', '');
+		
+		if (addRenderedAccidentals) {
+			note.getAccidentals()?.forEach(accidental => {
+				if (accidental.index === index) {
+					if (accidental.type === 'n') {
+						accidentals = '';
+					} else {
+						accidentals += accidental.type;
+					}
+				}
+			});
+		}
+
+		return pitchParts[0][0] + accidentals + pitchParts[1];
+	}
+
+	/**
+	 * Converts VexFlow duration syntax to MidiWriterJS syntax
+	 * @param note struct from VexFlow
+	 */
+	convertDuration(note) {
+		return 'd'.repeat(note.dots) + this.convertBaseDuration(note.duration) + (note.tuplet ? 't' + note.tuplet.num_notes : '');
+	}
+
+	/**
+	 * Converts VexFlow base duration syntax to MidiWriterJS syntax
+	 * @param duration Vexflow duration
+	 * @returns MidiWriterJS duration
+	 */
+	convertBaseDuration(duration: string): string {
+		switch (duration) {
+			case 'w':
+				return '1';
+			case 'h':
+				return '2';
+			case 'q':
+				return '4';
+			default:
+				return duration;
+		}
+	}
+}
+
+export {VexFlow};

package/src/writer.ts

@@ -0,0 +1,99 @@
+import {Header} from './chunks/header';
+import {Track} from './chunks/track';
+import {Utils} from './utils';
+
+/**
+ * Object that puts together tracks and provides methods for file output.
+ * @param {array|Track} tracks - A single {Track} object or an array of {Track} objects.
+ * @param {object} options - {middleC: 'C4'}
+ * @return {Writer}
+ */
+class Writer {
+	tracks: Track[];
+	options: object;
+
+	constructor(tracks, options = {}) {
+		// Ensure tracks is an array
+		this.tracks = Utils.toArray(tracks);
+		this.options = options;
+	}
+
+	/**
+	 * Builds array of data from chunkschunks.
+	 * @return {array}
+	 */
+	buildData() {
+		const data = [];
+		data.push(new Header(this.tracks.length))
+
+		// For each track add final end of track event and build data
+		this.tracks.forEach((track) => {
+			data.push(track.buildData(this.options));
+		});
+
+		return data;
+	}
+
+	/**
+	 * Builds the file into a Uint8Array
+	 * @return {Uint8Array}
+	 */
+	buildFile(): Uint8Array {
+		let build = [];
+
+		// Data consists of chunks which consists of data
+		this.buildData().forEach((d) => build = build.concat(d.type, d.size, d.data));
+
+		return new Uint8Array(build);
+	}
+
+	/**
+	 * Convert file buffer to a base64 string.  Different methods depending on if browser or node.
+	 * @return {string}
+	 */
+	base64(): string {
+		if (typeof btoa === 'function') {
+			let binary = '';
+			const bytes = this.buildFile();
+			const len = bytes.byteLength;
+
+			for (let i = 0; i < len; i++) {
+				binary += String.fromCharCode(bytes[i]);
+			}
+
+			return btoa(binary);
+		}
+
+		return Buffer.from(this.buildFile()).toString('base64');
+	}
+
+    /**
+     * Get the data URI.
+     * @return {string}
+     */
+    dataUri(): string {
+		return 'data:audio/midi;base64,' + this.base64();
+    }
+
+
+	/**
+	 * Set option on instantiated Writer.
+	 * @param {string} key
+	 * @param {any} value
+	 * @return {Writer}
+	 */
+	setOption(key: string, value: number|string): Writer {
+		this.options[key] = value;
+		return this;
+	}
+
+	/**
+	 * Output to stdout
+	 * @return {string}
+	 */
+    stdout() {
+		return process.stdout.write(Buffer.from(this.buildFile()));
+    }
+}
+
+export {Writer};

package/.editorconfig

@@ -1,24 +0,0 @@
-# http://editorconfig.org
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 4
-indent_style = tab
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.json]
-insert_final_newline = false
-indent_size = 2
-indent_style = space
-
-[*.md]
-indent_size = 2
-indent_style = space
-trim_trailing_whitespace = false
-
-[*.yml]
-indent_size = 2
-indent_style = space

package/.eslintignore

@@ -1,3 +0,0 @@
-**/__tests__/**
-**/coverage/**
-**/node_modules/**

package/.eslintrc.js

@@ -1,18 +0,0 @@
-module.exports = {
-    "env": {
-        "browser": true,
-        "es6": true,
-        "node": true
-    },
-    "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
-    "parser": '@typescript-eslint/parser',
-    "plugins": ['@typescript-eslint'],
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parserOptions": {
-        "ecmaVersion": 2020,
-        "sourceType": "module"
-    }
-};

package/.nvmrc

@@ -1 +0,0 @@
-v18.14.2

package/.travis.yml

@@ -1,3 +0,0 @@
-language: node_js
-node_js:
-  - "stable"