# -*- coding: utf-8 -*-
# ------------------------------------------------------------------------------
# Name: vexflow/toMusic21j.py
# Purpose: music21 classes for converting music21 objects to music21j
#
# Authors: Michael Scott Asato Cuthbert
# based on an earlier version by Christopher Reyes
#
# Copyright: Copyright © 2012-14 Michael Scott Asato Cuthbert
# License: BSD, see license.txt
# ------------------------------------------------------------------------------
'''
Convert a music21 object into JSON and send it to the browser for music21j to use.
'''
from __future__ import annotations
import unittest
from music21.exceptions21 import Music21Exception
from music21 import freezeThaw
from music21 import stream
supportedDisplayModes = [
'html',
'jsbody',
'jsbodyScript',
'json'
]
def fromObject(thisObject, *, mode='html', local=False):
'''
returns a string of data for a given Music21Object such as a Score, Note, etc. that
can be displayed in a browser using the music21j package. Called by .show('vexflow').
>>> n = note.Note('C#4')
>>> #_DOCS_SHOW print(vexflow.toMusic21j.fromObject(n))
Music21 Fragment
* Changed in v8: mode and useLocal are keyword only.
'''
conv = VexflowPickler()
conv.mode = mode
conv.useLocal = local
return conv.fromObject(thisObject)
class VexflowPickler:
templateHtml = ('' + '''
{title}
{loadM21Template}
{jsBodyScript}
''')
jsBodyScript = ''''''
jsBody = '''require(['music21'], function() {{
var pickleIn = {pickleOutput};
var jpc = new music21.fromPython.Converter();
streamObj = jpc.run(pickleIn);
{callback}
}});'''
loadM21Template = ''''''
def __init__(self):
self.defaults = {
'pickleOutput': '{"py/object": "hello"}',
'm21URI': 'https://www.music21.org/music21j/src/music21',
'requireURI': 'https://www.music21.org/music21j/ext/require/require.js',
'callback': (
'streamObj.renderOptions.events.resize = "reflow";'
+ '\n\t\t'
+ 'streamObj.appendNewCanvas();'
),
'm21URIlocal': 'file:///Users/Cuthbert/git/music21j/src/music21',
'requireURIlocal': 'file:///Users/Cuthbert/git/music21j/ext/require/require.js',
}
self.mode = 'html'
self.useLocal = False
def fromObject(self, thisObject, mode=None):
if mode is None:
mode = self.mode
if thisObject.isStream is False:
retStream = stream.Stream()
retStream.append(thisObject)
else:
retStream = thisObject
return self.fromStream(retStream, mode=mode)
def splitLongJSON(self, jsonString, chunkSize=110):
allJSONList = []
for i in range(0, len(jsonString), chunkSize):
allJSONList.append("'" + jsonString[i:i + chunkSize] + "'")
return ' + \n '.join(allJSONList)
def getLoadTemplate(self, urls=None):
'''
Gets the "
>>> d = {'m21URI': 'file:///tmp/music21', 'requireURI': 'http://requirejs.com/require.js'}
>>> vfp.getLoadTemplate(d)
""
'''
if urls is None:
urls = self.defaults
if self.useLocal is False:
loadM21formatted = self.loadM21Template.format(m21URI=urls['m21URI'],
requireURI=urls['requireURI'],)
else:
loadM21formatted = self.loadM21Template.format(m21URI=urls['m21URIlocal'],
requireURI=urls['requireURIlocal'],)
return loadM21formatted
def getJSBodyScript(self, dataSplit, defaults=None):
'''
Get the tag to render the JSON
>>> vfp = vexflow.toMusic21j.VexflowPickler()
>>> print(vfp.getJSBodyScript('{"hi": "hello"}'))
'''
if defaults is None:
defaults = self.defaults
jsBody = self.getJSBody(dataSplit, defaults)
jsBodyScript = self.jsBodyScript.format(jsBody=jsBody)
return jsBodyScript
def getJSBody(self, dataSplit, defaults=None):
'''
Get the javascript code without the