musescore-downloader/src/mscore.ts

/* eslint-disable @typescript-eslint/no-var-requires */
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */

import { fetchMscz } from './mscz'
import { fetchData } from './utils'
import { ScoreInfo } from './scoreinfo'
import isNodeJs from 'detect-node'
import i18n from './i18n'

const WEBMSCORE_URL = 'https://cdn.jsdelivr.net/npm/webmscore@0.16/webmscore.js'

// fonts for Chinese characters (CN) and Korean hangul (KR)
// JP characters are included in the CN font
const FONT_URLS = ['CN', 'KR'].map(l => `https://cdn.jsdelivr.net/npm/@librescore/fonts/SourceHanSans${l}-Regular.woff2`)

const SF3_URL = 'https://cdn.jsdelivr.net/npm/@librescore/sf3/FluidR3Mono_GM.sf3'
const SOUND_FONT_LOADED = Symbol('SoundFont loaded')

export type WebMscore = import('webmscore').default
export type WebMscoreConstr = typeof import('webmscore').default

const initMscore = async (w: Window): Promise<WebMscoreConstr> => {
  if (!isNodeJs) { // attached to a page
    if (!w['WebMscore']) {
      // init webmscore (https://github.com/LibreScore/webmscore)
      const script = w.document.createElement('script')
      script.src = WEBMSCORE_URL
      w.document.body.append(script)
      await new Promise(resolve => { script.onload = resolve })
    }
    return w['WebMscore'] as WebMscoreConstr
  } else { // nodejs
    return require('webmscore').default as WebMscoreConstr
  }
}

let fonts: Promise<Uint8Array[]> | undefined
const initFonts = () => {
  // load CJK fonts
  // CJK (East Asian) characters will be rendered as "tofu" if there is no font
  if (!fonts) {
    if (isNodeJs) {
      // module.exports.CN = ..., module.exports.KR = ...
      const FONTS = Object.values(require('@librescore/fonts'))

      const fs = require('fs')
      fonts = Promise.all(
        FONTS.map((path: string) => fs.promises.readFile(path) as Promise<Buffer>),
      )
    } else {
      fonts = Promise.all(
        FONT_URLS.map(url => fetchData(url)),
      )
    }
  }
}

export const loadSoundFont = (score: WebMscore): Promise<void> => {
  if (!score[SOUND_FONT_LOADED]) {
    const loadPromise = (async () => {
      let data: Uint8Array
      if (isNodeJs) {
        // module.exports.FluidR3Mono = ...
        const SF3 = Object.values(require('@librescore/sf3'))[0]
        const fs = require('fs')
        data = await fs.promises.readFile(SF3)
      } else {
        data = await fetchData(SF3_URL)
      }

      await score.setSoundFont(
        data,
      )
    })()
    score[SOUND_FONT_LOADED] = loadPromise
  }
  return score[SOUND_FONT_LOADED] as Promise<void>
}

export const loadMscore = async (scoreinfo: ScoreInfo, w?: Window): Promise<WebMscore> => {
  initFonts()
  const WebMscore = await initMscore(w!)

  // parse mscz data
  const data = new Uint8Array(
    new Uint8Array(await fetchMscz(scoreinfo)), // copy its ArrayBuffer
  )
  const score = await WebMscore.load('mscz', data, await fonts)
  await score.generateExcerpts()

  return score
}

export interface IndividualDownload {
  name: string;
  fileExt: string;
  action (score: WebMscore): Promise<Uint8Array>;
}

export const INDV_DOWNLOADS: IndividualDownload[] = [
  {
    name: i18n('DOWNLOAD')('PDF'),
    fileExt: 'pdf',
    action: (score) => score.savePdf(),
  },
  {
    name: i18n('DOWNLOAD')('MSCZ'),
    fileExt: 'mscz',
    action: (score) => score.saveMsc('mscz'),
  },
  {
    name: i18n('DOWNLOAD')('MusicXML'),
    fileExt: 'mxl',
    action: (score) => score.saveMxl(),
  },
  {
    name: i18n('DOWNLOAD')('MIDI'),
    fileExt: 'mid',
    action: (score) => score.saveMidi(true, true),
  },
  {
    name: i18n('DOWNLOAD_AUDIO')('MP3'),
    fileExt: 'mp3',
    action: (score) => loadSoundFont(score).then(() => score.saveAudio('mp3')),
  },
  {
    name: i18n('DOWNLOAD_AUDIO')('FLAC'),
    fileExt: 'flac',
    action: (score) => loadSoundFont(score).then(() => score.saveAudio('flac')),
  },
  {
    name: i18n('DOWNLOAD_AUDIO')('OGG'),
    fileExt: 'ogg',
    action: (score) => loadSoundFont(score).then(() => score.saveAudio('ogg')),
  },
]