define(['mathlive/core/mathAtom',
'mathlive/core/definitions',
'mathlive/editor/editor-popover'],
function(MathAtom, Definitions, Popover) {
// Markup
// Two common flavor of markups: SSML and 'mac'. The latter is only available
// when using the native TTS synthesizer on Mac OS.
// Use SSML in the production rules below. The markup will either be striped
// off or replaced with the 'mac' markup as necessary.
//
// SSML Mac
// ---- ----
// <emphasis>WORD</emphasis> [[emph +]]WORD
// <break time="150ms"/> [[slc 150]]
// <say-as interpret-as="character">A</say-as> [[char LTRL] A [[char NORM]]
// https://developer.apple.com/library/content/documentation/UserExperience/Conceptual/SpeechSynthesisProgrammingGuide/FineTuning/FineTuning.html#//apple_ref/doc/uid/TP40004365-CH5-SW3
// https://pdfs.semanticscholar.org/8887/25b82b8dbb45dd4dd69b36a65f092864adb0.pdf
// "<audio src='non_existing_file.au'>File could not be played.</audio>"
// "I am now <prosody rate='+0.06'>speaking 6% faster.</prosody>"
const PRONUNCIATION = {
'\\alpha': ' alpha ',
'\\mu': ' mew ',
'\\sigma': ' sigma ',
'\\pi': ' pie ',
'\\imaginaryI': ' eye ',
'\\sum': ' Summation ',
'\\prod': ' Product ',
';': ' <break time="150ms"/> semi-colon <break time="150ms"/>',
',': ' <break time="150ms"/> comma <break time="150ms"/>',
'|': ' <break time="150ms"/>Vertical bar<break time="150ms"/>',
'(': ' <break time="150ms"/>Open paren. <break time="150ms"/>',
')': '. <break time="150ms"/> Close paren. <break time="150ms"/>',
'=': ' equals ',
'<': ' is less than ',
'\\lt': ' is less than ',
'<=': ' is less than or equal to ',
'\\le': ' is less than or equal to ',
'\\gt': ' is greater than ',
'>': ' is greater than ',
'\\ge': ' is greater than or equal to ',
'\\geq': ' is greater than or equal to ',
'\\leq': ' is less than or equal to ',
'!': ' factorial ',
'\\sin': ' sine ',
'\\cos': ' cosine ',
'\u200b': '',
'\u2212': ' minus ',
':': ' <break time="150ms"/> such that <break time="200ms"/> ',
'\\colon': ' <break time="150ms"/> such that <break time="200ms"/> ',
'\\hbar': ' etch bar ',
'\\iff': ' <break time="200ms"/>if, and only if, <break time="200ms"/>',
'\\Longleftrightarrow': '<break time="200ms"/>if, and only if, <break time="200ms"/>',
'\\land': ' and ',
'\\lor': ' or ',
'\\neg': ' not ',
'\\div': ' divided by ',
'\\forall': ' for all ',
'\\exists': ' there exists ',
'\\nexists': ' there does not exists ',
'\\in': ' element of ',
'\\N': ' the set <break time="150ms"/><say-as interpret-as="character">n</say-as>',
'\\C': ' the set <break time="150ms"/><say-as interpret-as="character">c</say-as>',
'\\Z': ' the set <break time="150ms"/><say-as interpret-as="character">z</say-as>',
'\\Q': ' the set <break time="150ms"/><say-as interpret-as="character">q</say-as>',
'\\infty': ' infinity ',
'\\nabla': ' nabla ',
'\\partial': ' partial derivative of ',
'\\cdots': ' dot dot dot ',
'\\Rightarrow': ' implies ',
'\\lbrace': '<break time="150ms"/>open brace<break time="150ms"/>',
'\\{': '<break time="150ms"/>open brace<break time="150ms"/>',
'\\rbrace': '<break time="150ms"/>close brace<break time="150ms"/>',
'\\}': '<break time="150ms"/>close brace<break time="150ms"/>',
'\\langle': '<break time="150ms"/>left angle bracket<break time="150ms"/>',
'\\rangle': '<break time="150ms"/>right angle bracket<break time="150ms"/>',
'\\lfloor': '<break time="150ms"/>open floor<break time="150ms"/>',
'\\rfloor': '<break time="150ms"/>close floor<break time="150ms"/>',
'\\lceil': '<break time="150ms"/>open ceiling<break time="150ms"/>',
'\\rceil': '<break time="150ms"/>close ceiling<break time="150ms"/>',
'\\vert': '<break time="150ms"/>vertical bar<break time="150ms"/>',
'\\mvert': '<break time="150ms"/>divides<break time="150ms"/>',
'\\lvert': '<break time="150ms"/>left vertical bar<break time="150ms"/>',
'\\rvert': '<break time="150ms"/>right vertical bar<break time="150ms"/>',
// '\\lbrack': 'left bracket',
// '\\rbrack': 'right bracket',
'\\lbrack': ' <break time="150ms"/> open square bracket <break time="150ms"/>',
'\\rbrack': ' <break time="150ms"/> close square bracket <break time="150ms"/>',
}
function getSpokenName(latex) {
let result = Popover.NOTES[latex];
if (!result && latex.charAt(0) === '\\') {
result = ' ' + latex.replace('\\', '') + ' ';
}
// If we got more than one result (from NOTES),
// pick the first one.
if (Array.isArray(result)) {
result = result[0];
}
return result;
}
function platform(p) {
let result = 'other';
if (navigator && navigator.platform && navigator.userAgent) {
if (/^(mac)/i.test(navigator.platform)) {
result = 'mac';
} else if (/^(win)/i.test(navigator.platform)) {
result = 'win';
} else if (/(android)/i.test(navigator.userAgent)) {
result = 'android';
} else if (/(iphone)/i.test(navigator.userAgent) ||
/(ipod)/i.test(navigator.userAgent) ||
/(ipad)/i.test(navigator.userAgent)) {
result = 'ios';
} else if (/\bCrOS\b/i.test(navigator.userAgent)) {
result = 'chromeos';
}
}
return result === p ? p : '!' + p;
}
function isAtomic(mathlist) {
let count = 0;
if (mathlist && Array.isArray(mathlist)) {
for (const atom of mathlist) {
if (atom.type !== 'first') {
count += 1;
}
}
}
return count === 1;
}
function atomicID(mathlist) {
if (mathlist && Array.isArray(mathlist)) {
for (const atom of mathlist) {
if (atom.type !== 'first' && atom.id) {
return atom.id.toString();
}
}
}
return '';
}
function atomicValue(mathlist) {
let result = '';
if (mathlist && Array.isArray(mathlist)) {
for (const atom of mathlist) {
if (atom.type !== 'first' && typeof atom.body === 'string') {
result += atom.body;
}
}
}
return result;
}
MathAtom.toSpeakableFragment = function(atom, options) {
function letter(c) {
let result = '';
if (!options.textToSpeechMarkup) {
if (/[a-z]/.test(c)) {
result += " '" + c.toUpperCase() + "'";
} else if (/[A-Z]/.test(c)) {
result += " 'capital " + c.toUpperCase() + "'";
} else {
result += c;
}
} else {
if (/[a-z]/.test(c)) {
result += ' <say-as interpret-as="character">' + c + '</say-as>';
} else if (/[A-Z]/.test(c)) {
result += 'capital ' + c.toLowerCase() + '';
} else {
result += c;
}
}
return result;
}
function emph(s) {
return '<emphasis>' + s + '</emphasis>';
}
if (!atom) return '';
let result = '';
if (atom.id && options.speechMode === 'math') {
result += '<mark name="' + atom.id.toString() + '"/>';
}
if (Array.isArray(atom)) {
let isInDigitRun = false; // need to group sequence of digits
for (let i = 0; i < atom.length; i++) {
if (i < atom.length - 2 &&
atom[i].type === 'mopen' &&
atom[i + 2].type === 'mclose' &&
atom[i + 1].type === 'mord') {
result += ' of ';
result += emph(MathAtom.toSpeakableFragment(atom[i + 1], options));
i += 2;
// '.' and ',' should only be allowed if prev/next entry is a digit
// However, if that isn't the case, this still works because 'toSpeakableFragment' is called in either case.
} else if (atom[i].type === 'mord' && /[0123456789,.]/.test(atom[i].latex)) {
if (isInDigitRun) {
result += atom[i].latex;
} else {
isInDigitRun = true;
result += MathAtom.toSpeakableFragment(atom[i], options);
}
} else {
isInDigitRun = false
result += MathAtom.toSpeakableFragment(atom[i], options);
}
}
} else {
let numer = '';
let denom = '';
let body = '';
let supsubHandled = false;
switch(atom.type) {
case 'group':
case 'root':
result += MathAtom.toSpeakableFragment(atom.body, options);
break;
case 'genfrac':
numer = MathAtom.toSpeakableFragment(atom.numer, options);
denom = MathAtom.toSpeakableFragment(atom.denom, options);
if (isAtomic(atom.numer) && isAtomic(atom.denom)) {
const COMMON_FRACTIONS = {
'1/2': ' half ',
'1/3': ' one third ',
'2/3': ' two third',
'1/4': ' one quarter ',
'3/4': ' three quarter ',
'1/5': ' one fifth ',
'2/5': ' two fifths ',
'3/5': ' three fifths ',
'4/5': ' four fifths ',
'1/6': ' one sixth ',
'5/6': ' five sixths ',
'1/8': ' one eight ',
'3/8': ' three eights ',
'5/8': ' five eights ',
'7/8': ' seven eights ',
'1/9': ' one ninth ',
'2/9': ' two ninths ',
'4/9': ' four ninths ',
'5/9': ' five ninths ',
'7/9': ' seven ninths ',
'8/9': ' eight ninths ',
// '1/10': ' one tenth ',
// '1/12': ' one twelfth ',
// 'x/2': ' <say-as interpret-as="character">X</say-as> over 2',
};
const commonFraction = COMMON_FRACTIONS[
atomicValue(atom.numer) + '/' + atomicValue(atom.denom)];
if (commonFraction) {
result = commonFraction;
} else {
result += numer + ' over ' + denom;
}
} else {
result += ' The fraction <break time="150ms"/>' + numer + ', over <break time="150ms"/>' + denom + '.<break time="150ms"/> End fraction.<break time="150ms"/>';
}
break;
case 'surd':
body = MathAtom.toSpeakableFragment(atom.body, options);
if (!atom.index) {
if (isAtomic(atom.body)) {
result += ' The square root of ' + body + ' , ';
} else {
result += ' The square root of <break time="200ms"/>' + body + '. <break time="200ms"/> End square root';
}
} else {
let index = MathAtom.toSpeakableFragment(atom.index, options);
index = index.trim();
const index2 = index.replace(/<mark([^/]*)\/>/g, '')
if (index2 === '3') {
result += ' The cube root of <break time="200ms"/>' + body + '. <break time="200ms"/> End cube root';
} else if (index2 === 'n') {
result += ' The nth root of <break time="200ms"/>' + body + '. <break time="200ms"/> End root';
} else {
result += ' The root with index: <break time="200ms"/>' + index + ', of <break time="200ms"/>' + body + '. <break time="200ms"/> End root';
}
}
break;
case 'accent':
break;
case 'leftright':
result += PRONUNCIATION[atom.leftDelim] || atom.leftDelim;
result += MathAtom.toSpeakableFragment(atom.body, options);
result += PRONUNCIATION[atom.rightDelim] || atom.rightDelim;
break;
case 'line':
// @todo
break;
case 'rule':
// @todo
break;
case 'overunder':
// @todo
break;
case 'overlap':
// @todo
break;
case 'placeholder':
result += 'placeholder ' + atom.body;
break;
case 'delim':
case 'sizeddelim':
case 'mord':
case 'minner':
case 'mbin':
case 'mrel':
case 'mpunct':
case 'mopen':
case 'mclose':
case 'textord':
{
const command = atom.latex ? atom.latex.trim() : '' ;
if (command === '\\mathbin' || command === '\\mathrel' ||
command === '\\mathopen' || command === '\\mathclose' ||
command === '\\mathpunct' || command === '\\mathord' ||
command === '\\mathinner') {
result = MathAtom.toSpeakableFragment(atom.body, options);
break;
}
let atomValue = atom.body;
let latexValue = atom.latex;
if (atom.type === 'delim' || atom.type === 'sizeddelim') {
atomValue = latexValue = atom.delim;
}
if (options.speechMode === 'text') {
result += atomValue;
} else {
if (atom.type === 'mbin') {
result += '<break time="150ms"/>';
}
if (atomValue) {
const value = PRONUNCIATION[atomValue] ||
(latexValue ? PRONUNCIATION[latexValue.trim()] : '');
if (value) {
result += ' ' + value;
} else {
const spokenName = latexValue ?
getSpokenName(latexValue.trim()) : '';
result += spokenName ? spokenName : letter(atomValue);
}
} else {
result += MathAtom.toSpeakableFragment(atom.body, options);
}
if (atom.type === 'mbin') {
result += '<break time="150ms"/>';
}
}
break;
}
case 'mop':
// @todo
if (atom.body !== '\u200b') {
// Not ZERO-WIDTH
const trimLatex = atom.latex ? atom.latex.trim() : '' ;
if (trimLatex === '\\sum') {
if (atom.superscript && atom.subscript) {
let sup = MathAtom.toSpeakableFragment(atom.superscript, options);
sup = sup.trim();
let sub = MathAtom.toSpeakableFragment(atom.subscript, options);
sub = sub.trim();
result += ' The summation from <break time="200ms"/>' + sub + '<break time="200ms"/> to <break time="200ms"/>' + sup + '<break time="200ms"/> of <break time="150ms"/>';
supsubHandled = true;
} else if (atom.subscript) {
let sub = MathAtom.toSpeakableFragment(atom.subscript, options);
sub = sub.trim();
result += ' The summation from <break time="200ms"/>' + sub + '<break time="200ms"/> of <break time="150ms"/>';
supsubHandled = true;
} else {
result += ' The summation of';
}
} else if (trimLatex === '\\prod') {
if (atom.superscript && atom.subscript) {
let sup = MathAtom.toSpeakableFragment(atom.superscript, options);
sup = sup.trim();
let sub = MathAtom.toSpeakableFragment(atom.subscript, options);
sub = sub.trim();
result += ' The product from <break time="200ms"/>' + sub + '<break time="200ms"/> to <break time="200ms"/>' + sup + '<break time="200ms"/> of <break time="150ms"/>';
supsubHandled = true;
} else if (atom.subscript) {
let sub = MathAtom.toSpeakableFragment(atom.subscript, options);
sub = sub.trim();
result += ' The product from <break time="200ms"/>' + sub + '<break time="200ms"/> of <break time="150ms"/>';
supsubHandled = true;
} else {
result += ' The product of ';
}
} else if (trimLatex === '\\int') {
if (atom.superscript && atom.subscript) {
let sup = MathAtom.toSpeakableFragment(atom.superscript, options);
sup = sup.trim();
let sub = MathAtom.toSpeakableFragment(atom.subscript, options);
sub = sub.trim();
result += ' The integral from <break time="200ms"/>' + emph(sub) + '<break time="200ms"/> to <break time="200ms"/>' + emph(sup) + ' <break time="200ms"/> of ';
supsubHandled = true;
} else {
result += ' The integral of <break time="200ms"/> ';
}
} else if (typeof atom.body === 'string') {
const value = PRONUNCIATION[atom.body] ||
PRONUNCIATION[atom.latex.trim()];
if (value) {
result += value;
} else {
result += ' ' + atom.body;
}
} else if (atom.latex && atom.latex.length > 0) {
if (atom.latex[0] === '\\') {
result += ' ' + atom.latex.substr(1);
} else {
result += ' ' + atom.latex;
}
}
}
break;
case 'font':
options.speechMode = 'text';
result += '<break time="200ms"/>';
result += MathAtom.toSpeakableFragment(atom.body, options);
result += '<break time="200ms"/>';
options.speechMode = 'math';
break;
case 'enclose':
body = MathAtom.toSpeakableFragment(atom.body, options);
if (isAtomic(atom.body)) {
result += ' crossed out ' + body + ' , ';
} else {
result += ' crossed out ' + body + ' End cross out';
}
break;
case 'space':
case 'spacing':
case 'color':
case 'sizing':
case 'mathstyle':
case 'box':
// @todo
break;
}
if (!supsubHandled && atom.superscript) {
let sup = MathAtom.toSpeakableFragment(atom.superscript, options);
sup = sup.trim();
const sup2 = sup.replace(/<[^>]*>/g, '');
if (isAtomic(atom.superscript)) {
if (options.speechMode === 'math') {
const id = atomicID(atom.superscript);
if (id) {
result += '<mark name="' + id + '"/>';
}
}
if (sup2 === '\u2032') {
result += ' prime ';
} else if (sup2 === '2') {
result += ' squared ';
} else if (sup2 === '3') {
result += ' cubed ';
} else if (isNaN(parseInt(sup2))) {
result += ' to the ' + sup + '; ';
} else {
result += ' to the <say-as interpret-as="ordinal">' + sup2 + '</say-as> power; ';
}
} else {
if (isNaN(parseInt(sup2))) {
result += ' raised to the ' + sup + '; ';
} else {
result += ' raised to the <say-as interpret-as="ordinal">' + sup2 + '</say-as> power; ';
}
}
}
if (!supsubHandled && atom.subscript) {
let sub = MathAtom.toSpeakableFragment(atom.subscript, options);
sub = sub.trim();
if (isAtomic(atom.subscript)) {
result += ' sub ' + sub;
} else {
result += ' subscript ' + sub + ' End subscript. ';
}
}
}
return result;
}
/**
* @param {MathAtom[]} [atoms] The atoms to represent as speakable text.
* If omitted, `this` is used.
* @param {Object.<string, any>} [options]
*/
MathAtom.toSpeakableText = function(atoms, options) {
if (!options) {
options = {
textToSpeechMarkup: '', // no markup
textToSpeechRules: 'mathlive'
}
}
options.speechMode = 'math';
if (window.sre && options.textToSpeechRules === 'sre') {
options.generateID = true;
const mathML = MathAtom.toMathML(atoms, options);
if (mathML) {
if (options.textToSpeechMarkup) {
options.textToSpeechRulesOptions = options.textToSpeechRulesOptions || {};
options.textToSpeechRulesOptions.markup = options.textToSpeechMarkup;
if (options.textToSpeechRulesOptions.markup === 'ssml') {
options.textToSpeechRulesOptions.markup = 'arno';
}
options.textToSpeechRulesOptions.rate = options.speechEngineRate;
}
if (options.textToSpeechRulesOptions) {
window.sre.System.getInstance().setupEngine(options.textToSpeechRulesOptions);
}
return window.sre.System.getInstance().toSpeech(mathML);
}
return '';
// return window.sre.toSpeech(MathAtom.toMathML(atoms));
}
let result = MathAtom.toSpeakableFragment(atoms, options);
if (options.textToSpeechMarkup === 'ssml') {
let prosody = '';
if (options.speechEngineRate) {
prosody = '<prosody rate="' + options.speechEngineRate + '">'
}
result = `<?xml version="1.0"?><speak version="1.1" xmlns="http://www.w3.org/2001/10/synthesis" xml:lang="en-US">` +
'<amazon:auto-breaths>' +
prosody +
'<p><s>' +
result +
'</s></p>' +
(prosody ? '</prosody>' : '') +
'</amazon:auto-breaths>' +
'</speak>';
} else if (options.textToSpeechMarkup === 'mac' && platform('mac') === 'mac') {
// Convert SSML to Mac markup
result = result.replace(/<mark([^/]*)\/>/g, '')
.replace(/<emphasis>/g, '[[emph+]]')
.replace(/<\/emphasis>/g, '')
.replace(/<break time="([0-9]*)ms"\/>/g, '[[slc $1]]')
.replace(/<say-as[^>]*>/g, '')
.replace(/<\/say-as>/g, '');
} else {
// If no markup was requested, or 'mac' markup, but we're not on a mac,
// remove any that we may have
// Strip out the SSML markup
result = result.replace(/<[^>]*>/g, '')
.replace(/\s{2,}/g, ' ');
}
return result;
}
// Export the public interface for this module
return {}
})
