abcjs 6.0.0-beta.9 → 6.0.2

package/dist/abcjs-plugin-min.js.LICENSE

@@ -0,0 +1,23 @@
+/**!
+Copyright (c) 2009-2022 Paul Rosen and Gregory Dyke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+ **This text is from: http://opensource.org/licenses/MIT**
+!**/

package/index.js

@@ -1,6 +1,30 @@
+/**!
+Copyright (c) 2009-2022 Paul Rosen and Gregory Dyke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+ **This text is from: http://opensource.org/licenses/MIT**
+!**/
 var version = require('./version');
 var animation = require('./src/api/abc_animation');
 var tuneBook = require('./src/api/abc_tunebook');
+var sequence = require('./src/synth/abc_midi_sequencer');
 
 var abcjs = {};
 
@@ -44,9 +68,10 @@ abcjs.synth = {
 	supportsAudio: supportsAudio,
 	playEvent: playEvent,
 	getMidiFile: getMidiFile,
+	sequence: sequence,
 };
 
-var editor = require('./src/edit/abc_editor');
-abcjs['Editor'] = editor;
+abcjs['Editor'] = require('./src/edit/abc_editor');
+abcjs['EditArea'] = require('./src/edit/abc_editarea');
 
 module.exports = abcjs;

package/{static-wrappers/license.js → license.js}

@@ -1,5 +1,5 @@
 /**!
-Copyright (c) 2009-2020 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2022 Paul Rosen and Gregory Dyke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,21 +1,19 @@
 {
   "name": "abcjs",
-  "version": "6.0.0-beta.9",
+  "version": "6.0.2",
   "description": "Renderer for abc music notation",
   "main": "index.js",
+  "types": "types/index.d.ts",
   "scripts": {
     "webpack": "webpack",
-    "build": "npm run fix-versions && npm run build:basic-min && npm run build:basic && npm run build:midi && npm run build:plugin && npm run build:plugin-midi",
-    "build:basic": "npm run webpack -- --env.mode development --env.type basic",
-    "build:basic-min": "npm run webpack -- --env.mode production --env.type basic",
-    "build:midi": "npm run webpack -- --env.mode production --env.type midi",
-    "build:plugin": "npm run webpack -- --env.mode production --env.type plugin",
-    "build:plugin-midi": "npm run webpack -- --env.mode production --env.type plugin-midi",
-    "fix-versions": "./fix-versions.sh 6.0.0-beta.9",
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "npm run build:basic && npm run webpack",
+    "build:basic": "npm run webpack -- --mode development --config-name basic",
+    "build:basic-min": "npm run webpack -- --mode production --config-name basic",
+    "build:plugin": "npm run webpack -- --mode production --config-name plugin",
+    "test": "mocha 'tests/**/*.js'",
     "docs:dev": "vuepress dev docs",
     "docs:build": "vuepress build docs",
-    "build:analyze": "npm run build:basic -- --env.presets analyze"
+    "build:analyze": "npm run build:basic -- --env analyze"
   },
   "repository": {
     "type": "git",
@@ -25,36 +23,35 @@
     "abc",
     "music",
     "notation",
-    "midi"
+    "midi",
+    "webaudio"
   ],
   "author": "Paul Rosen <paul@paulrosen.net> (https://abcjs.net)",
   "contributors": [
     "Gregory Dyke",
+    "Jean-Yves Mengant",
+    "Todd Brown",
     "Thomas Chandelle"
   ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/paulrosen/abcjs/issues"
   },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/paulrosen"
+  },
   "homepage": "https://abcjs.net",
   "devDependencies": {
-    "@babel/core": "7.7.5",
-    "@babel/preset-env": "7.7.6",
-    "@vuepress/shared-utils": "1.2.0",
-    "babel-loader": "8.0.6",
-    "compression-webpack-plugin": "3.0.1",
-    "serialize-javascript": "2.1.2",
-    "svg-inline-loader": "0.8.0",
-    "vuepress": "1.2.0",
-    "webpack": "4.41.2",
-    "webpack-bundle-analyzer": "3.6.0",
-    "webpack-cli": "3.3.10",
-    "webpack-merge": "4.2.2",
-    "webpack-node-externals": "1.7.2",
-    "workbox-webpack-plugin": "4.3.1"
-  },
-  "dependencies": {
-    "abcjs": "6.0.0-beta.9",
-    "midi": "https://github.com/paulrosen/MIDI.js.git#abcjs"
+    "@babel/core": "7.14.3",
+    "@babel/preset-env": "7.14.4",
+    "@tarp/require": "1.4.3",
+    "babel-loader": "8.2.2",
+    "chai": "4.3.4",
+    "mocha": "8.4.0",
+    "vuepress": "2.0.0-beta.26",
+    "vuex": "4.0.0",
+    "webpack-bundle-analyzer": "4.4.2",
+    "webpack-cli": "4.9.0"
   }
 }

package/{src/plugin/abc_plugin.js → plugin.js}

@@ -1,26 +1,34 @@
+/**!
+Copyright (c) 2009-2022 Paul Rosen and Gregory Dyke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+ **This text is from: http://opensource.org/licenses/MIT**
+!**/
 //    abc_plugin.js: Find everything which looks like abc and convert it
 
-//    Copyright (C) 2010-2020 Gregory Dyke (gregdyke at gmail dot com)
-//
-//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-//    documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-//    the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
-//    to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-//
-//    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-//
-//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-//    BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-//    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
 /*global abcjs_is_user_script, abcjs_plugin_autostart */
 "use strict";
 
-var TuneBook = require('../api/abc_tunebook').TuneBook;
-var Parse = require('../parse/abc_parse');
-var EngraverController = require('../write/abc_engraver_controller');
+var TuneBook = require('./src/api/abc_tunebook').TuneBook;
+var Parse = require('./src/parse/abc_parse');
+var EngraverController = require('./src/write/abc_engraver_controller');
 
 var Plugin = function() {
 	"use strict";
@@ -239,4 +247,8 @@ if (autostart &&
   }
 }
 
-module.exports = plugin;
+var abcjs = {
+	plugin: Plugin
+};
+
+module.exports = abcjs;

package/src/api/abc_animation.js

@@ -1,21 +1,5 @@
 //    abc_animation.js: handles animating the music in real time.
-//    Copyright (C) 2014-2020 Paul Rosen (paul at paulrosen dot net)
-//
-//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-//    documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-//    the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
-//    to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-//
-//    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-//
-//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-//    BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-//    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-var spacing = require('../write/abc_spacing');
-var parseCommon = require('../parse/abc_common');
+
 var TimingCallbacks = require('./abc_timing_callbacks');
 
 var animation = {};

package/src/api/abc_tablatures.js

@@ -0,0 +1,144 @@
+/*
+ * Tablature Plugins
+ * tablature are defined dynamically and registered inside abcjs
+ * by calling abcTablatures.register(plugin) 
+ * where plugin represents a plugin instance 
+ * 
+ */
+var ViolinTablature = require('../tablatures/instruments/violin/tab-violin');
+var GuitarTablature = require('../tablatures/instruments/guitar/tab-guitar');
+
+/* extend the table below when adding a new instrument plugin */
+
+// Existing tab classes 
+var pluginTab = {
+  'violin': 'ViolinTab',
+  'guitar': 'GuitarTab'
+};
+
+var abcTablatures = {
+
+  inited: false,
+  plugins: {},
+
+  
+  /**
+   * to be called once per plugin for registration 
+   * @param {*} plugin 
+   */
+  register: function (plugin) {
+    var name = plugin.name;
+    var tablature = plugin.tablature;
+    this.plugins[name] = tablature;
+  },
+
+  setError: function (tune, msg) {
+    if (tune.warnings) {
+      tune.warning.push(msg);
+    } else {
+      tune.warnings = [msg];
+    }
+  },
+
+  /**
+   * handle params for current processed score
+   * @param {*} tune current tune 
+   * @param {*} tuneNumber number in tune list
+   * @param {*} params params to be processed for tablature
+   * @return prepared tablatures plugin instances for current tune
+   */
+  preparePlugins: function (tune, tuneNumber, params) {
+    var returned = null;
+    var nbPlugins = 0;
+    if (params.tablature) {
+      // validate requested plugins 
+      var tabs = params.tablature;
+      returned = [];
+      for (var ii = 0; ii < tabs.length; ii++) {
+        var args = tabs[ii];
+        var instrument = args['instrument'];
+        if (instrument == null) {
+          this.setError(tune, "tablature 'instrument' is missing");
+          return returned;
+        }
+        var tabName = pluginTab[instrument];
+        var plugin = null;
+        if (tabName) {
+          plugin = this.plugins[tabName];
+        }
+        if (plugin) {
+          if (params.visualTranspose != 0) {
+            // populate transposition request to tabs
+            args.visualTranspose = params.visualTranspose;
+          }
+          args.abcSrc = params.tablature.abcSrc;
+          var pluginInstance = {
+            classz: plugin,
+            tuneNumber: tuneNumber,
+            params: args,
+            instance: null,
+          };
+          // proceed with tab plugin  init 
+          // plugin.init(tune, tuneNumber, args, ii);
+          returned.push(pluginInstance);
+          nbPlugins++;
+        } else {
+          // unknown tab plugin 
+          //this.emit_error('Undefined tablature plugin: ' + tabName)
+          this.setError(tune, 'Undefined tablature plugin: ' + instrument);
+          return returned;
+        }
+      }
+    }
+    return returned;
+  },
+
+  /**
+   * Call requested plugin
+   * @param {*} renderer 
+   * @param {*} abcTune 
+   */
+  layoutTablatures: function (renderer, abcTune) {
+    var tabs = abcTune.tablatures;
+    // chack tabs request for each staffs
+    for (var ii = 0; ii < abcTune.lines.length; ii++) {
+      var line = abcTune.lines[ii];
+      var curStaff = line.staff;
+      if (curStaff) {
+        for (var jj = 0; jj < curStaff.length; jj++) {
+          if (tabs[jj]) {
+            // tablature requested for staff
+            var tabPlugin = tabs[jj];
+            if (tabPlugin.instance == null) {
+              tabPlugin.instance = new tabPlugin.classz();
+              // plugin.init(tune, tuneNumber, args, ii);
+              // call initer first
+              tabPlugin.instance.init(abcTune,
+                tabPlugin.tuneNumber,
+                tabPlugin.params,
+                jj
+              );
+            }
+            // render next
+            tabPlugin.instance.render(renderer, line, jj);
+          }
+        }
+      }  
+    }
+  },
+
+  /**
+   * called once internally to register internal plugins
+   */
+  init: function () {
+    // just register plugin hosted by abcjs 
+    if (!this.inited) {
+      this.register(new ViolinTablature());
+      this.register(new GuitarTablature());
+      this.inited = true;
+    }
+  }
+};
+
+
+module.exports = abcTablatures ;