12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031 |
- import { OpenSheetMusicDisplay } from '../src/OpenSheetMusicDisplay/OpenSheetMusicDisplay';
- import { BackendType } from '../src/OpenSheetMusicDisplay/OSMDOptions';
- import { PlaybackManager, LinearTimingSource, BasicAudioPlayer, ControlPanel } from '../src/Playback';
- import * as jsPDF from '../node_modules/jspdf/dist/jspdf.es.min';
- import * as svg2pdf from '../node_modules/svg2pdf.js/dist/svg2pdf.umd.min';
- import { TransposeCalculator } from '../src/Plugins/Transpose/TransposeCalculator';
- /*jslint browser:true */
- (function () {
- "use strict";
- var openSheetMusicDisplay;
- var sampleFolder = "",
- samples = {
- "Beethoven, L.v. - An die ferne Geliebte": "Beethoven_AnDieFerneGeliebte.xml",
- "Clementi, M. - Sonatina Op.36 No.1 Pt.1": "MuzioClementi_SonatinaOpus36No1_Part1.xml",
- "Clementi, M. - Sonatina Op.36 No.1 Pt.2": "MuzioClementi_SonatinaOpus36No1_Part2.xml",
- "Clementi, M. - Sonatina Op.36 No.3 Pt.1": "MuzioClementi_SonatinaOpus36No3_Part1.xml",
- "Clementi, M. - Sonatina Op.36 No.3 Pt.2": "MuzioClementi_SonatinaOpus36No3_Part2.xml",
- "Bach, J.S. - Praeludium in C-Dur BWV846 1": "JohannSebastianBach_PraeludiumInCDur_BWV846_1.xml",
- "Bach, J.S. - Air": "JohannSebastianBach_Air.xml",
- "Gounod, C. - Méditation": "CharlesGounod_Meditation.xml",
- "Haydn, J. - Concertante Cello": "JosephHaydn_ConcertanteCello.xml",
- "Joplin, S. - Elite Syncopations": "ScottJoplin_EliteSyncopations.xml",
- "Joplin, S. - The Entertainer": "ScottJoplin_The_Entertainer.xml",
- "Mozart, W.A. - An Chloe": "Mozart_AnChloe.xml",
- "Mozart, W.A. - Das Veilchen": "Mozart_DasVeilchen.xml",
- "Mozart, W.A. - Clarinet Quintet (Excerpt)": "Mozart_Clarinet_Quintet_Excerpt.mxl",
- "Mozart, W.A. - String Quartet in G, K. 387, 1st Mvmt Excerpt": "Mozart_String_Quartet_in_G_K._387_1st_Mvmnt_excerpt.musicxml",
- "Mozart/Holzer - Land der Berge (national anthem of Austria)": "Land_der_Berge.musicxml",
- "OSMD Function Test - All": "OSMD_function_test_all.xml",
- "OSMD Function Test - Accidentals": "OSMD_function_test_accidentals.musicxml",
- "OSMD Function Test - Autobeam": "OSMD_function_test_autobeam.musicxml",
- "OSMD Function Test - Auto-/Custom-Coloring": "OSMD_function_test_auto-custom-coloring-entchen.musicxml",
- "OSMD Function Test - Bar lines": "OSMD_function_test_bar_lines.musicxml",
- "OSMD Function Test - Chord Symbols": "OSMD_function_test_chord_symbols.musicxml",
- "OSMD Function Test - Chord Spacing": "OSMD_function_test_chord_spacing.mxl",
- "OSMD Function Test - Chord Symbols - Various Chords": "OSMD_function_test_chord_tests_various.musicxml",
- "OSMD Function Test - Chord Symbols - BrookeWestSample": "BrookeWestSample.mxl",
- "OSMD Function Test - Color (from XML)": "OSMD_function_test_color.musicxml",
- "OSMD Function Test - Container height (compacttight mode)": "OSMD_Function_Test_Container_height.musicxml",
- "OSMD Function Test - Drumset": "OSMD_function_test_drumset.musicxml",
- "OSMD Function Test - Drums on one Line": "OSMD_Function_Test_Drums_one_line_snare_plus_piano.musicxml",
- "OSMD Function Test - Expressions": "OSMD_function_test_expressions.musicxml",
- "OSMD Function Test - Expressions Overlap": "OSMD_function_test_expressions_overlap.musicxml",
- "OSMD Function Test - Grace Notes": "OSMD_function_test_GraceNotes.xml",
- "OSMD Function Test - Metronome Marks": "OSMD_function_test_metronome_marks.mxl",
- "OSMD Function Test - Multiple Rest Measures": "OSMD_function_test_multiple_rest_measures.musicxml",
- "OSMD Function Test - Invisible Notes": "OSMD_function_test_invisible_notes.musicxml",
- "OSMD Function Test - Notehead Shapes": "OSMD_function_test_noteheadShapes.musicxml",
- "OSMD Function Test - Ornaments": "OSMD_function_test_Ornaments.xml",
- "OSMD Function Test - Pedals": "OSMD_Function_Test_Pedals.musicxml",
- "OSMD Function Test - Selecting Measures To Draw": "OSMD_function_test_measuresToDraw_Beethoven_AnDieFerneGeliebte.xml",
- "OSMD Function Test - System and Page Breaks": "OSMD_Function_Test_System_and_Page_Breaks_4_pages.mxl",
- "OSMD Function Test - Tabulature": "OSMD_Function_Test_Tabulature_hayden_study_1.mxl",
- "OSMD Function Test - Tabulature MultiBends": "OSMD_Function_Test_Tablature_Multibends.musicxml",
- "OSMD Function Test - Tabulature All Effects": "OSMD_Function_Test_Tablature_Alleffects.musicxml",
- "OSMD Function Test - Tremolo": "OSMD_Function_Test_Tremolo_2bars.musicxml",
- "OSMD Function Test - Labels": "OSMD_Function_Test_Labels.musicxml",
- "OSMD Function Test - High Slur Test": "test_slurs_highNotes.musicxml",
- "OSMD Function Test - Auto Multirest Measures Single Staff": "Test_Auto_Multirest_1.musicxml",
- "OSMD Function Test - Auto Multirest Measures Multiple Staves": "Test_Auto_Multirest_2.musicxml",
- "OSMD Function Test - String number collisions": "test_string_number_collisions.musicxml",
- "OSMD Function Test - Repeat Stave Connectors": "OSMD_function_Test_Repeat.musicxml",
- "OSMD Function Test - Trill Lines": "OSMD_Trill_Line_Function_Test.musicxml",
- "OSMD Function Test - Voice Alignment": "OSMD_Function_Test_Voice_Alignment.musicxml",
- "Schubert, F. - An Die Musik": "Schubert_An_die_Musik.xml",
- "Actor, L. - Prelude (Large Sample, loading time)": "ActorPreludeSample.xml",
- "Actor, L. - Prelude (Large, No Print Part Names)": "ActorPreludeSample_PartName.xml",
- "Anonymous - Saltarello": "Saltarello.mxl",
- "Debussy, C. - Mandoline": "Debussy_Mandoline.xml",
- "Levasseur, F. - Parlez Mois": "Parlez-moi.mxl",
- "Schumann, R. - Dichterliebe": "Dichterliebe01.xml",
- "Telemann, G.P. - Sonate-Nr.1.1-Dolce": "TelemannWV40.102_Sonate-Nr.1.1-Dolce.xml",
- "Telemann, G.P. - Sonate-Nr.1.2-Allegro": "TelemannWV40.102_Sonate-Nr.1.2-Allegro-F-Dur.xml",
- },
- comments = {
- "Beethoven_AnDieFerneGeliebte.xml": ["Beethoven_AnDieFerneGeliebte_comments.xml", "Beethoven_AnDieFerneGeliebte_comments_2.xml"]
- },
- zoom = 1.0,
- // HTML Elements in the page
- divControls,
- zoomControls,
- header,
- err,
- error_tr,
- canvas,
- selectSample,
- selectBounding,
- skylineDebug,
- bottomlineDebug,
- zoomIns,
- zoomOuts,
- zoomDivs,
- custom,
- nextCursorBtn,
- resetCursorBtn,
- followCursorCheckbox,
- showCursorBtn,
- hideCursorBtn,
- backendSelect,
- backendSelectDiv,
- debugReRenderBtn,
- debugClearBtn,
- selectPageSizes,
- printPdfBtns,
- transpose,
- transposeBtn,
- performanceMode,
- performanceModeBtn,
- playbackControlsButton,
- playbackControl;
-
- // manage option setting and resetting for specific samples, e.g. in the autobeam sample autobeam is set to true, otherwise reset to previous state
- // TODO design a more elegant option state saving & restoring system, though that requires saving the options state in OSMD
- var minMeasureToDrawStashed = 1;
- var maxMeasureToDrawStashed = Number.MAX_SAFE_INTEGER;
- var measureToDrawRangeNeedsReset = false;
- var drawingParametersStashed = "default";
- var drawingParametersNeedsReset = false;
- var autobeamOptionNeedsReset = false;
- var autobeamOptionStashedValue = false;
- var autoCustomColoringOptionNeedsReset = false;
- var autoCustomColoringOptionStashedValue = false;
- var drawPartNamesOptionStashedValue = true;
- var drawPartAbbreviationsStashedValue = true;
- var drawPartNamesOptionNeedsReset = false;
- var pageBreaksOptionStashedValue = false;
- var pageBreaksOptionNeedsReset = false;
- var systemBreaksOptionStashedValue = false; // reset handled by pageBreaksOptionNeedsReset
- var showControls = true;
- var showExportPdfControl = false;
- var showPageFormatControl = false;
- var showZoomControl = true;
- var showHeader = true;
- var showDebugControls = false;
- document.title = "OpenSheetMusicDisplay Demo";
- // Initialization code
- function init() {
- var name, option;
- // Handle window parameter
- var paramEmbedded = findGetParameter('embedded');
- var paramShowControls = findGetParameter('showControls');
- var paramShowPageFormatControl = findGetParameter('showPageFormatControl');
- var paramShowExportPdfControl = findGetParameter('showExportPdfControl');
- var paramShowZoomControl = findGetParameter('showZoomControl');
- var paramShowHeader = findGetParameter('showHeader');
- var paramZoom = findGetParameter('zoom');
- var paramOverflow = findGetParameter('overflow');
- var paramOpenUrl = findGetParameter('openUrl');
- var paramDebugControls = findGetParameter('debugControls');
- var paramCompactMode = findGetParameter('compactMode');
- var paramMeasureRangeStart = findGetParameter('measureRangeStart');
- var paramMeasureRangeEnd = findGetParameter('measureRangeEnd');
- var paramPageFormat = findGetParameter('pageFormat');
- var paramPageBackgroundColor = findGetParameter('pageBackgroundColor');
- var paramBackendType = findGetParameter('backendType');
- var paramPageWidth = findGetParameter('pageWidth');
- var paramPageHeight = findGetParameter('pageHeight');
- var paramHorizontalScrolling = findGetParameter('horizontalScrolling');
- var paramSingleHorizontalStaffline = findGetParameter('singleHorizontalStaffline');
- showHeader = (paramShowHeader !== '0');
- showControls = false;
- if (paramEmbedded) {
- showControls = paramShowControls !== '0';
- showZoomControl = paramShowZoomControl !== '0';
- showPageFormatControl = paramShowPageFormatControl !== '0';
- showExportPdfControl = paramShowExportPdfControl !== '0';
- }
- if (paramZoom) {
- if (paramZoom > 0.1 && paramZoom < 5.0) {
- zoom = paramZoom;
- }
- }
- if (paramOverflow && typeof paramOverflow === 'string') {
- if (paramOverflow === 'hidden' || paramOverflow === 'auto' || paramOverflow === 'scroll' || paramOverflow === 'visible') {
- document.body.style.overflow = paramOverflow;
- }
- }
-
- var compactMode = paramCompactMode && paramCompactMode !== '0';
- var measureRangeStart = paramMeasureRangeStart ? Number.parseInt(paramMeasureRangeStart) : 0;
- var measureRangeEnd = paramMeasureRangeEnd ? Number.parseInt(paramMeasureRangeEnd) : Number.MAX_SAFE_INTEGER;
- if (measureRangeStart && measureRangeEnd && measureRangeEnd < measureRangeStart) {
- console.log("[OSMD] warning: measure range end parameter should not be smaller than measure range start. We've set start measure = end measure now.")
- measureRangeStart = measureRangeEnd;
- }
- let pageFormat = paramPageFormat ? paramPageFormat : "Endless";
- if (paramPageHeight && paramPageWidth) {
- pageFormat = `${paramPageWidth}x${paramPageHeight}`
- }
- var pageBackgroundColor = paramPageBackgroundColor ? "#" + paramPageBackgroundColor : undefined; // vexflow format, see OSMDOptions. can't use # in parameters.
- //console.log("demo: osmd pagebgcolor: " + pageBackgroundColor);
- var backendType = (paramBackendType && paramBackendType.toLowerCase) ? paramBackendType : "svg";
- var horizontalScrolling = paramHorizontalScrolling === '1';
- var singleHorizontalStaffline = paramSingleHorizontalStaffline === '1';
-
- // set the backendSelect debug controls dropdown menu selected item
- //console.log("true: " + backendSelect && backendType.toLowerCase && backendType.toLowerCase() === "canvas");
- // TODO somehow backendSelect becomes undefined here:
- /*if (backendSelect && backendType.toLowerCase && backendType.toLowerCase() === "canvas") {
- console.log("here1");
- for (var i=0; i<backendSelect.options.length; i++) {
- if (backendSelect.options[i].value.toLowerCase() === "canvas") {
- backendSelect.selectedIndex = i;
- }
- }
- backendSelect.value = "Canvas";
- }*/
- divControls = document.getElementById('divControls');
- zoomControls = document.getElementById('zoomControls');
- header = document.getElementById('header');
- err = document.getElementById("error-td");
- error_tr = document.getElementById("error-tr");
- zoomDivs = [];
- zoomDivs.push(document.getElementById("zoom-str"));
- zoomDivs.push(document.getElementById("zoom-str-optional"));
- custom = document.createElement("option");
- selectSample = document.getElementById("selectSample");
- selectBounding = document.getElementById("selectBounding");
- skylineDebug = document.getElementById("skylineDebug");
- bottomlineDebug = document.getElementById("bottomlineDebug");
- performanceMode = false;
- performanceModeBtn = document.getElementById("performanceMode");
- zoomIns = [];
- zoomIns.push(document.getElementById("zoom-in-btn"));
- zoomIns.push(document.getElementById("zoom-in-btn-optional"));
- zoomOuts = [];
- zoomOuts.push(document.getElementById("zoom-out-btn"));
- zoomOuts.push(document.getElementById("zoom-out-btn-optional"));
- canvas = document.createElement("div");
- if (horizontalScrolling) {
- canvas.style.overflowX = 'auto'; // enable horizontal scrolling
- }
- //canvas.id = 'osmdCanvasDiv';
- //canvas.style.overflowX = 'auto'; // enable horizontal scrolling
- nextCursorBtn = document.getElementById("next-cursor-btn");
- resetCursorBtn = document.getElementById("reset-cursor-btn");
- followCursorCheckbox = document.getElementById("follow-cursor-checkbox");
- showCursorBtn = document.getElementById("show-cursor-btn");
- hideCursorBtn = document.getElementById("hide-cursor-btn");
- backendSelect = document.getElementById("backend-select");
- backendSelectDiv = document.getElementById("backend-select-div");
- debugReRenderBtn = document.getElementById("debug-re-render-btn");
- debugClearBtn = document.getElementById("debug-clear-btn");
- selectPageSizes = [];
- selectPageSizes.push(document.getElementById("selectPageSize"));
- selectPageSizes.push(document.getElementById("selectPageSize-optional"));
- printPdfBtns = [];
- printPdfBtns.push(document.getElementById("print-pdf-btn"));
- printPdfBtns.push(document.getElementById("print-pdf-btn-optional"));
- transpose = document.getElementById('transpose');
- transposeBtn = document.getElementById('transpose-btn');
- playbackControlsButton = document.getElementById("playback-settings-button")
- //var defaultDisplayVisibleValue = "block"; // TODO in some browsers flow could be the better/default value
- var defaultVisibilityValue = "visible";
- showDebugControls = paramDebugControls !== '0';
- if (showDebugControls) {
- var elementsToEnable = [
- selectSample, selectBounding, selectPageSizes[0], backendSelect, backendSelectDiv, divControls
- ];
- for (var i=0; i<elementsToEnable.length; i++) {
- if (elementsToEnable[i]) { // make sure this element is not null/exists in the index.html, e.g. github.io demo has different index.html
- if (elementsToEnable[i].style) {
- elementsToEnable[i].style.visibility = defaultVisibilityValue;
- elementsToEnable[i].style.opacity = 1.0;
- }
- }
- }
- } else {
- if (divControls) {
- divControls.style.display = "none";
- }
- }
- const optionalControls = document.getElementById('optionalControls');
- if (optionalControls) {
- if (showControls) {
- optionalControls.style.visibility = defaultVisibilityValue;
- optionalControls.style.opacity = 0.8;
- } else {
- optionalControls.style.display = 'none';
- }
- }
- if (!showHeader) {
- if (header) {
- header.style.display = 'none';
- }
- } else {
- if (header) {
- header.style.opacity = 1.0;
- }
- }
- // Hide error
- error();
- if (showControls) {
- const optionalControls = document.getElementById('optionalControls');
- if (optionalControls) {
- optionalControls.style.opacity = 1.0;
- // optionalControls.appendChild(zoomControlsButtons);
- // optionalControls.appendChild(zoomControlsString);
- optionalControls.style.position = 'absolute';
- optionalControls.style.zIndex = '10';
- optionalControls.style.right = '10px';
- // optionalControls.style.padding = '10px';
- }
- if (showZoomControl) {
- const zoomControlsButtonsColumn = document.getElementById('zoomControlsButtons-optional-column');
- zoomControlsButtonsColumn.style.opacity = 1.0;
- // const zoomControlsButtons = document.getElementById('zoomControlsButtons-optional');
- // zoomControlsButtons.style.opacity = 1.0;
- const zoomControlsString = document.getElementById('zoom-str-optional'); // actually === zoomDivs[1] above
- if (zoomControlsString) {
- zoomControlsString.innerHTML = Math.floor(zoom * 100.0) + "%";
- zoomControlsString.style.display = 'inline';
- // zoomControlsString.style.padding = '10px';
- }
- }
- if (showExportPdfControl) {
- const exportPdfButtonColumn = document.getElementById('print-pdf-btn-optional-column');
- if (exportPdfButtonColumn) {
- exportPdfButtonColumn.style.opacity = 1.0;
- }
- }
- const pageFormatControlColumn = document.getElementById("selectPageSize-optional-column");
- if (pageFormatControlColumn) {
- if (showPageFormatControl) {
- pageFormatControlColumn.style.opacity = 1.0;
- } else {
- // showPageFormatControlColumn.innerHTML = "";
- // pageFormatControlColumn.style.minWidth = 0;
- // pageFormatControlColumn.style.width = 0;
- pageFormatControlColumn.style.display = 'none'; // squeezes buttons/columns
- // pageFormatControlColumn.style.visibility = 'hidden';
- // const optionalControlsColumnContainer = document.getElementById("optionalControlsColumnContainer");
- // optionalControlsColumnContainer.removeChild(pageFormatControlColumn);
- // optionalControlsColumnContainer.width *= 0.66;
- // optionalControls.witdh *= 0.66;
- // optionalControls.focus();
- }
- }
- }
- // Create select
- for (name in samples) {
- if (samples.hasOwnProperty(name)) {
- option = document.createElement("option");
- option.value = samples[name];
- option.textContent = name;
- }
- if (selectSample) {
- selectSample.appendChild(option);
- }
- }
- if (selectSample) {
- selectSample.onchange = selectSampleOnChange;
- }
- if (selectBounding) {
- selectBounding.onchange = selectBoundingOnChange;
- }
- for (const selectPageSize of selectPageSizes) {
- if (selectPageSize) {
- selectPageSize.onchange = function (evt) {
- var value = evt.target.value;
- openSheetMusicDisplay.setPageFormat(value);
- openSheetMusicDisplay.render();
- };
- }
- }
- for (const printPdfBtn of printPdfBtns) {
- if (printPdfBtn) {
- printPdfBtn.onclick = function () {
- createPdf();
- }
- }
- }
- // Pre-select default music piece
- custom.appendChild(document.createTextNode("Custom"));
- // Create zoom controls
- for (const zoomIn of zoomIns) {
- if (zoomIn) {
- zoomIn.onclick = function () {
- zoom *= 1.2;
- scale();
- };
- }
- }
- for (const zoomOut of zoomOuts) {
- if (zoomOut) {
- zoomOut.onclick = function () {
- zoom /= 1.2;
- scale();
- };
- }
- }
- if (skylineDebug) {
- skylineDebug.onclick = function () {
- openSheetMusicDisplay.DrawSkyLine = !openSheetMusicDisplay.DrawSkyLine;
- openSheetMusicDisplay.render();
- }
- }
- if (bottomlineDebug) {
- bottomlineDebug.onclick = function () {
- openSheetMusicDisplay.DrawBottomLine = !openSheetMusicDisplay.DrawBottomLine;
- openSheetMusicDisplay.render();
- }
- }
- if (performanceModeBtn) {
- performanceModeBtn.onclick = function () {
- performanceMode = !performanceMode;
- openSheetMusicDisplay.setOptions({performanceMode});
- }
- }
- if (debugReRenderBtn) {
- debugReRenderBtn.onclick = function () {
- rerender();
- }
- }
- if (debugClearBtn) {
- debugClearBtn.onclick = function () {
- openSheetMusicDisplay.clear();
- }
- }
- // Create OSMD object and canvas
- openSheetMusicDisplay = new OpenSheetMusicDisplay(canvas, {
- autoResize: true,
- backend: backendType,
- //backend: "canvas",
- //cursorsOptions: [{type: 3, color: "#2bb8cd", alpha: 0.6, follow: true}], // highlight current measure instead of just a small vertical bar over approximate notes
- disableCursor: false,
- drawingParameters: compactMode ? "compact" : "default", // try compact (instead of default)
- drawPartNames: true, // try false
- // drawTitle: false,
- // drawSubtitle: false,
- drawFingerings: true,
- //fingeringPosition: "left", // Above/Below is default. try left or right. experimental: above, below.
- //fingeringPositionFromXML: false, // do this if you want them always left, for example.
- // fingeringInsideStafflines: "true", // default: false. true draws fingerings directly above/below notes
- setWantedStemDirectionByXml: true, // try false, which was previously the default behavior
- // drawUpToMeasureNumber: 3, // draws only up to measure 3, meaning it draws measure 1 to 3 of the piece.
- drawFromMeasureNumber : measureRangeStart,
- drawUpToMeasureNumber : measureRangeEnd,
- //drawMeasureNumbers: false, // disable drawing measure numbers
- //measureNumberInterval: 4, // draw measure numbers only every 4 bars (and at the beginning of a new system)
- useXMLMeasureNumbers: true, // read measure numbers from xml
- // coloring options
- coloringEnabled: true,
- // defaultColorNotehead: "#CC0055", // try setting a default color. default is black (undefined)
- // defaultColorStem: "#BB0099",
- autoBeam: false, // try true, OSMD Function Test AutoBeam sample
- autoBeamOptions: {
- beam_rests: false,
- beam_middle_rests_only: false,
- //groups: [[3,4], [1,1]],
- maintain_stem_directions: false
- },
- pageFormat: pageFormat,
- pageBackgroundColor: pageBackgroundColor,
- renderSingleHorizontalStaffline: singleHorizontalStaffline,
- performanceMode: performanceMode
- // tupletsBracketed: true, // creates brackets for all tuplets except triplets, even when not set by xml
- // tripletsBracketed: true,
- // tupletsRatioed: true, // unconventional; renders ratios for tuplets (3:2 instead of 3 for triplets)
- });
- //openSheetMusicDisplay.DrawSkyLine = true;
- //openSheetMusicDisplay.DrawBottomLine = true;
- //openSheetMusicDisplay.setDrawBoundingBox("GraphicalLabel", false);
- openSheetMusicDisplay.setLogLevel('info'); // set this to 'debug' if you want to see more detailed control flow information in console
- document.body.appendChild(canvas);
- window.addEventListener("keydown", function (e) {
- var event = window.event ? window.event : e;
- if (event.keyCode === 39) {
- openSheetMusicDisplay.cursor.next();
- }
- });
- nextCursorBtn.addEventListener("click", function () {
- openSheetMusicDisplay.cursor.next();
- });
- resetCursorBtn.addEventListener("click", function () {
- openSheetMusicDisplay.cursor.reset();
- });
- if (followCursorCheckbox) {
- followCursorCheckbox.onchange = function () {
- openSheetMusicDisplay.FollowCursor = !openSheetMusicDisplay.FollowCursor;
- }
- }
- window.addEventListener("wheel", function(e){
- if(followCursorCheckbox) {
- followCursorCheckbox.checked = false;
- openSheetMusicDisplay.FollowCursor = false;
- }
- });
- hideCursorBtn.addEventListener("click", function () {
- if (openSheetMusicDisplay.cursor) {
- openSheetMusicDisplay.cursor.hide();
- } else {
- console.info("Can't hide cursor, as it was disabled (e.g. by drawingParameters).");
- }
- });
- showCursorBtn.addEventListener("click", function () {
- if (openSheetMusicDisplay.cursor) {
- openSheetMusicDisplay.cursor.show();
- } else {
- console.info("Can't show cursor, as it was disabled (e.g. by drawingParameters).");
- }
- });
- backendSelect.addEventListener("change", function (e) {
- var value = e.target.value;
- var createNewOsmd = true;
- if (createNewOsmd) {
- // clears the canvas element
- canvas.innerHTML = "";
- openSheetMusicDisplay = new OpenSheetMusicDisplay(canvas, { backend: value });
- openSheetMusicDisplay.setLogLevel('info'); // set this to 'debug' if you want to get more detailed control flow information
- } else {
- // alternative, doesn't work yet, see setOptions():
- openSheetMusicDisplay.setOptions({ backend: value });
- }
- console.log("[OSMD] selectSampleOnChange addEventListener change");
- // selectSampleOnChange();
- });
- if(transposeBtn && transpose){
- openSheetMusicDisplay.TransposeCalculator = new TransposeCalculator();
- transposeBtn.onclick = function(){
- var transposeValue = parseInt(transpose.value);
- openSheetMusicDisplay.Sheet.Transpose = transposeValue;
- openSheetMusicDisplay.updateGraphic();
- rerender();
- }
- }
- playbackControl = demoPlaybackControl(openSheetMusicDisplay);
- playbackControlsButton.addEventListener("click", function(){
- if(!playbackControl.IsClosed()){
- playbackControl.hideControls();
- } else {
- playbackControl.showControls();
- }
- });
- // TODO after selectSampleOnChange, the resize handler triggers immediately,
- // so we render twice at the start of the demo.
- // maybe delay the first osmd render, e.g. when window ready?
- if (paramOpenUrl) {
- if (openSheetMusicDisplay.getLogLevel() < 2) { // debug or trace
- console.log("[OSMD] selectSampleOnChange with " + paramOpenUrl);
- }
- // DEBUG: cause an error for a certain sample, for testing
- // if (paramOpenUrl.startsWith("Beethoven")) {
- // paramOpenUrl.causeError();
- // }
- selectSampleOnChange(paramOpenUrl);
- } else {
- if (openSheetMusicDisplay.getLogLevel() < 2) { // debug or trace
- console.log("[OSMD] selectSampleOnChange without param");
- }
- selectSampleOnChange();
- }
- }
- function findGetParameter(parameterName) {
- // special treatment for the openUrl parameter, because different systems attach different arguments to an URL.
- // because of CORS (cross-origin safety restrictions), you can only load an xml file from the same origin (server).
- // test parameter: ?openUrl=https://opensheetmusiceducation.org/index.php?gf-download=2020%2F01%2FJohannSebastianBach_PraeludiumInCDur_BWV846_1.xml&endUrl&form-id=1&field-id=4&hash=c4ba271ef08204a26cbd4cd2d751c53b78f238c25ddbb1f343e1172f2ce2aa53
- // (enable the console.log at the end of this method for testing)
- // working test parameter in local demo: ?openUrl=OSMD_function_test_all.xml&endUrl
-
- if (parameterName === 'openUrl') {
- let startParameterName = 'openUrl=';
- let endParameterName = '&endUrl';
- let openUrlIndex = location.search.indexOf(startParameterName);
- if (openUrlIndex < 0) {
- return undefined;
- }
- let endIndex = location.search.indexOf(endParameterName) + endParameterName.length;
- if (endIndex < 0) {
- console.log("[OSMD] If using openUrl as a parameter, you have to end it with '&endUrl'. openUrl parameter omitted.");
- return undefined;
- }
- let urlString = location.search.substring(openUrlIndex + startParameterName.length, endIndex - endParameterName.length);
- //console.log("openUrl: " + urlString);
- return urlString;
- }
- let result = undefined;
- let tmp = [];
- location.search
- .substr(1)
- .split('&')
- .forEach(function (item) {
- tmp = item.split('=');
- if (tmp[0] === parameterName) {
- result = decodeURIComponent(tmp[1]);
- //console.log('Found param:' + parameterName + ' = ' + result);
- }
- });
- return result;
- }
- function selectBoundingOnChange(evt) {
- var value = evt.target.value;
- openSheetMusicDisplay.DrawBoundingBox = value;
- }
- function selectSampleOnChange(str) {
- var comment = undefined;
- var sampleStr = undefined;
- error();
- disable();
- var isCustom = typeof str === "string";
- if (!isCustom) {
- if (selectSample) {
- sampleStr = selectSample.value;
- str = sampleFolder + sampleStr;
- } else {
- if (samples && samples.length > 0) {
- sampleStr = samples[0];
- str = sampleFolder + sampleStr;
- } else {
- return; // no sample to load right now
- }
- }
- if(comments.hasOwnProperty(sampleStr)){
- comment = comments[sampleStr];
- }
- }
- // zoom = 1.0;
- setSampleSpecificOptions(str, isCustom);
- openSheetMusicDisplay.load(str, comment).then(
- function () {
- // This gives you access to the osmd object in the console. Do not use in production code
- window.osmd = openSheetMusicDisplay;
- openSheetMusicDisplay.zoom = zoom;
- //openSheetMusicDisplay.Sheet.Transpose = 3; // try transposing between load and first render if you have transpose issues with F# etc
- return openSheetMusicDisplay.render();
- },
- function (e) {
- errorLoadingOrRenderingSheet(e, "rendering");
- }
- ).then(
- function () {
- return onLoadingEnd(isCustom);
- }, function (e) {
- errorLoadingOrRenderingSheet(e, "loading");
- onLoadingEnd(isCustom);
- }
- );
- }
- function setSampleSpecificOptions(str, isCustom) {
- if (!isCustom && str.includes("measuresToDraw")) { // set options for measuresToDraw sample
- // stash previously set range of measures to draw
- if (!measureToDrawRangeNeedsReset) { // only stash once, when measuresToDraw called multiple times in a row
- minMeasureToDrawStashed = openSheetMusicDisplay.EngravingRules.MinMeasureToDrawIndex + 1;
- maxMeasureToDrawStashed = openSheetMusicDisplay.EngravingRules.MaxMeasureToDrawIndex + 1;
- }
- measureToDrawRangeNeedsReset = true;
- // for debugging: draw from a random range of measures
- let minMeasureToDraw = Math.ceil(Math.random() * 15); // measures start at 1 (measureIndex = measure number - 1 elsewhere)
- let maxMeasureToDraw = Math.ceil(Math.random() * 15);
- if (minMeasureToDraw > maxMeasureToDraw) {
- minMeasureToDraw = maxMeasureToDraw;
- let a = minMeasureToDraw;
- maxMeasureToDraw = a;
- }
- //minMeasureToDraw = 1; // set your custom indexes here. Drawing only one measure can be a special case
- //maxMeasureToDraw = 1;
- console.log("drawing measures in the range: [" + minMeasureToDraw + "," + maxMeasureToDraw + "]");
- openSheetMusicDisplay.setOptions({
- drawFromMeasureNumber: minMeasureToDraw,
- drawUpToMeasureNumber: maxMeasureToDraw
- });
- } else if (measureToDrawRangeNeedsReset) { // reset for other samples
- openSheetMusicDisplay.setOptions({
- drawFromMeasureNumber: minMeasureToDrawStashed,
- drawUpToMeasureNumber: maxMeasureToDrawStashed
- });
- measureToDrawRangeNeedsReset = false;
- }
- if (!isCustom && str.includes("Test_Container_height")) {
- drawingParametersStashed = openSheetMusicDisplay.drawingParameters.drawingParametersEnum;
- openSheetMusicDisplay.setOptions({
- drawingParameters: "compacttight"
- });
- drawingParametersNeedsReset = true;
- } else if (drawingParametersNeedsReset) {
- openSheetMusicDisplay.setOptions({
- drawingParameters: drawingParametersStashed
- });
- drawingParametersNeedsReset = false;
- }
- // Enable Boomwhacker-like coloring for OSMD Function Test - Auto-Coloring (Boomwhacker-like, custom color set)
- if (!isCustom && str.includes("auto-custom-coloring")) { // set options for auto coloring sample
- autoCustomColoringOptionNeedsReset = true;
- //openSheetMusicDisplay.setOptions({coloringMode: 1}); // Auto-Coloring with pre-defined colors
- openSheetMusicDisplay.setOptions({
- coloringMode: 2, // custom coloring set. 0 would be XML, 1 autocoloring
- coloringSetCustom: ["#d82c6b", "#F89D15", "#FFE21A", "#4dbd5c", "#009D96", "#43469d", "#76429c", "#ff0000"],
- // last color value of coloringSetCustom is for rest notes
- colorStemsLikeNoteheads: true
- });
- } else if (autoCustomColoringOptionNeedsReset) {
- openSheetMusicDisplay.setOptions({ // set default values. better would be to restore to stashed values, but unnecessarily complex for demo
- coloringMode: 0,
- colorStemsLikeNoteheads: false,
- coloringSetCustom: null
- });
- autoCustomColoringOptionNeedsReset = false;
- }
- if (!isCustom && str.includes("autobeam")) {
- autobeamOptionStashedValue = openSheetMusicDisplay.EngravingRules.AutoBeamNotes; // stash previously set value, to restore later
- autobeamOptionNeedsReset = true;
- openSheetMusicDisplay.setOptions({ autoBeam: true });
- } else if (autobeamOptionNeedsReset) {
- openSheetMusicDisplay.setOptions({ autoBeam: autobeamOptionStashedValue });
- autobeamOptionNeedsReset = false;
- }
- if (!isCustom && str.includes("OSMD_Function_Test_System_and_Page_Breaks")) {
- pageBreaksOptionStashedValue = openSheetMusicDisplay.EngravingRules.NewPageAtXMLNewPageAttribute;
- systemBreaksOptionStashedValue = openSheetMusicDisplay.EngravingRules.NewSystemAtXMLNewSystemAttribute;
- pageBreaksOptionNeedsReset = true;
- openSheetMusicDisplay.setOptions({ newPageFromXML: true, newSystemFromXML: true });
- }
- else if (pageBreaksOptionNeedsReset) {
- openSheetMusicDisplay.setOptions({ newPageFromXML: pageBreaksOptionStashedValue, newSystemFromXML: systemBreaksOptionStashedValue });
- pageBreaksOptionNeedsReset = false;
- }
- if (!isCustom && str.includes("Schubert_An_die_Musik")) { // TODO weird layout bug here with part names. but shouldn't be in score anyways
- drawPartNamesOptionStashedValue = openSheetMusicDisplay.EngravingRules.RenderPartNames;
- drawPartAbbreviationsStashedValue = openSheetMusicDisplay.EngravingRules.RenderPartAbbreviations;
- openSheetMusicDisplay.setOptions({ drawPartNames: false, drawPartAbbreviations: false }); // TODO sets osmd.drawingParameters.DrawPartNames! also check EngravingRules.RenderPartAbbreviations, was false
- drawPartNamesOptionNeedsReset = true;
- } else if (drawPartNamesOptionNeedsReset) {
- openSheetMusicDisplay.setOptions({ drawPartNames: drawPartNamesOptionStashedValue, drawPartAbbreviations: drawPartAbbreviationsStashedValue });
- drawPartNamesOptionNeedsReset = false;
- }
- }
- function errorLoadingOrRenderingSheet(e, loadingOrRenderingString) {
- var errorString = "Error " + loadingOrRenderingString + " sheet: " + e;
- // Always giving a StackTrace might give us more and better error reports.
- // TODO for a release, StackTrace control could be reenabled
- errorString += "\n" + "StackTrace: \n" + e.stack;
- // }
- console.warn(errorString);
- }
- function onLoadingEnd(isCustom) {
- // Remove option from select
- if (!isCustom && custom.parentElement === selectSample) {
- selectSample.removeChild(custom);
- }
- playbackControl.initialize();
- // Enable controls again
- enable();
- }
- function logCanvasSize() {
- for (const zoomDiv of zoomDivs) {
- if (zoomDiv) {
- zoomDiv.innerHTML = Math.floor(zoom * 100.0) + "%";
- }
- }
- }
- function scale() {
- disable();
- window.setTimeout(function () {
- openSheetMusicDisplay.Zoom = zoom;
- openSheetMusicDisplay.render();
- enable();
- }, 0);
- }
- function rerender() {
- disable();
- window.setTimeout(function () {
- if (openSheetMusicDisplay.IsReadyToRender()) {
- openSheetMusicDisplay.render();
- } else {
- console.log("[OSMD demo] Loses context!"); // TODO not sure that this message is reasonable, renders fine anyways. maybe vexflow context lost?
- selectSampleOnChange(); // reload sample e.g. after osmd.clear()
- }
- enable();
- }, 0);
- }
- function error(errString) {
- if (!errString) {
- error_tr.style.display = "none";
- } else {
- console.log("[OSMD demo] error: " + errString)
- err.textContent = errString;
- error_tr.style.display = "";
- canvas.width = canvas.height = 0;
- enable();
- }
- }
- // Enable/Disable Controls
- function disable() {
- document.body.style.opacity = 0.3;
- setDisabledForControls("disabled");
- }
- function enable() {
- document.body.style.opacity = 1;
- setDisabledForControls("");
- logCanvasSize();
- }
- function setDisabledForControls(disabledValue) {
- if (selectSample) {
- selectSample.disabled = disabledValue;
- }
- for (const zoomIn of zoomIns) {
- if (zoomIn) {
- zoomIn.disabled = disabledValue;
- }
- }
- for (const zoomOut of zoomOuts) {
- if (zoomOut) {
- zoomOut.disabled = disabledValue;
- }
- }
- }
- /**
- * Creates a Pdf of the currently rendered MusicXML
- * @param pdfName if no name is given, the composer and title of the piece will be used
- */
- async function createPdf(pdfName) {
- if (openSheetMusicDisplay.backendType !== BackendType.SVG) {
- console.log("[OSMD] createPdf(): Warning: createPDF is only supported for SVG background for now, not for Canvas." +
- " Please use osmd.setOptions({backendType: SVG}).");
- return;
- }
- if (pdfName === undefined) {
- pdfName = openSheetMusicDisplay.sheet.FullNameString + ".pdf";
- }
- const backends = openSheetMusicDisplay.drawer.Backends;
- let svgElement = backends[0].getSvgElement();
- let pageWidth = 210;
- let pageHeight = 297;
- const engravingRulesPageFormat = openSheetMusicDisplay.rules.PageFormat;
- if (engravingRulesPageFormat && !engravingRulesPageFormat.IsUndefined) {
- pageWidth = engravingRulesPageFormat.width;
- pageHeight = engravingRulesPageFormat.height;
- } else {
- pageHeight = pageWidth * svgElement.clientHeight / svgElement.clientWidth;
- }
- const orientation = pageHeight > pageWidth ? "p" : "l";
- // create a new jsPDF instance
- const pdf = new jsPDF.jsPDF({
- orientation: orientation,
- unit: "mm",
- format: [pageWidth, pageHeight]
- });
- //const scale = pageWidth / svgElement.clientWidth;
- for (let idx = 0, len = backends.length; idx < len; ++idx) {
- if (idx > 0) {
- pdf.addPage();
- }
- svgElement = backends[idx].getSvgElement();
-
- if (!pdf.svg && !svg2pdf) { // this line also serves to make the svg2pdf not unused, though it's still necessary
- // we need svg2pdf to have pdf.svg defined
- console.log("svg2pdf missing, necessary for jspdf.svg().");
- return;
- }
- await pdf.svg(svgElement, {
- x: 0,
- y: 0,
- width: pageWidth,
- height: pageHeight,
- })
- }
- pdf.save(pdfName); // save/download the created pdf
- //pdf.output("pdfobjectnewwindow", {filename: "osmd_createPDF.pdf"}); // open PDF in new tab/window
- // note that using jspdf with svg2pdf creates unnecessary console warnings "AcroForm-Classes are not populated into global-namespace..."
- // this will hopefully be fixed with a new jspdf release, see https://github.com/yWorks/jsPDF/pull/32
- }
- var demoPlaybackControl = function(osmd) {
- var playbackListener = {
- play() {
- followCursorCheckbox.checked = true;
- openSheetMusicDisplay.FollowCursor = true;
- },
- pause() {},
- reset() {},
- bpmChanged() {},
- volumeChanged() {},
- volumeMute() {},
- volumeUnmute() {}
- }
- var timingSource = new LinearTimingSource();
- var playbackManager = new PlaybackManager(timingSource, undefined, new BasicAudioPlayer(), undefined);
- playbackManager.DoPlayback = true;
- playbackManager.DoPreCount = false;
- playbackManager.PreCountMeasures = 1; // note that DoPreCount has to be true for a precount to happen
- var playbackControlPanel = new ControlPanel();
- playbackControlPanel.addListener(playbackManager);
- playbackControlPanel.addListener(playbackListener);
- function initialize() {
- timingSource.reset();
- timingSource.pause();
- timingSource.Settings = osmd.Sheet.playbackSettings;
- playbackManager.initialize(osmd.Sheet.musicPartManager);
- playbackManager.addListener(osmd.cursor);
- playbackManager.reset();
- osmd.PlaybackManager = playbackManager;
- playbackControlPanel.clearVolumeTracks();
- playbackControlPanel.addVolumeTrack(playbackManager.Metronome.Name, playbackManager.Metronome.Id, playbackManager.Metronome.Volume*100);
- for(const instrId of playbackManager.InstrumentIdMapping.keys()) {
- const instr = playbackManager.InstrumentIdMapping.getValue(instrId);
- playbackControlPanel.addVolumeTrack(instr.Name, instrId, instr.Volume * 100);
- }
- playbackControlPanel.bpmChanged(osmd.Sheet.DefaultStartTempoInBpm);
- }
- function showControls() {
- playbackControlPanel.show();
- }
- function hideControls() {
- playbackControlPanel.hideAndClear();
- }
- function IsClosed() {
- return playbackControlPanel.IsClosed;
- }
- return {
- initialize: initialize,
- showControls: showControls,
- hideControls: hideControls,
- IsClosed: IsClosed
- }
- };
- // Register events: load, drag&drop
- window.addEventListener("load", function () {
- init();
- });
- window.addEventListener("dragenter", function (event) {
- event.preventDefault();
- disable();
- });
- window.addEventListener("dragover", function (event) {
- event.preventDefault();
- });
- window.addEventListener("dragleave", function (event) {
- enable();
- });
- window.addEventListener("drop", function (event) {
- event.preventDefault();
- if (!event.dataTransfer || !event.dataTransfer.files || event.dataTransfer.files.length === 0) {
- return;
- }
- // Add "Custom..." score
- selectSample.appendChild(custom);
- custom.selected = "selected";
- // Read dragged file
- var reader = new FileReader();
- reader.onload = function (res) {
- selectSampleOnChange(res.target.result);
- };
- var filename = event.dataTransfer.files[0].name;
- if (filename.toLowerCase().indexOf(".xml") > 0
- || filename.toLowerCase().indexOf(".musicxml") > 0) {
- reader.readAsText(event.dataTransfer.files[0]);
- } else if (event.dataTransfer.files[0].name.toLowerCase().indexOf(".mxl") > 0) {
- reader.readAsBinaryString(event.dataTransfer.files[0]);
- }
- else {
- alert("No vaild .xml/.mxl/.musicxml file!");
- }
- });
- }());
|