Packageorg.si.sion.utils
Classpublic class Translator
InheritanceTranslator Inheritance Object

Translator


Public Methods
 MethodDefined By
  
Translator()
constructor, do nothing.
Translator
  
errorParameterNotValid(cmd:String, param:String):Error
[static]
Translator
  
errorToneParameterNotValid(cmd:String, chParam:int, opParam:int):Error
[static]
Translator
  
errorTranslation(str:String):Error
[static]
Translator
  
errorUnknown(str:String):Error
[static]
Translator
  
extractSystemCommand(mml:String):Array
[static] extract system command from mml
Translator
  
flmml(flMML:String):String
[static] Translate flMML's mml to SiOPM mml.
Translator
  
getALParam(param:SiOPMChannelParam):Array
[static] get number list inside of #AL@{..};
Translator
  
getMA3Param(param:SiOPMChannelParam):Array
[static] get number list inside of #MA@{..};
Translator
  
getOPLParam(param:SiOPMChannelParam):Array
[static] get number list inside of #OPL@{..};
Translator
  
getOPMParam(param:SiOPMChannelParam):Array
[static] get number list inside of #OPM@{..};
Translator
  
getOPNParam(param:SiOPMChannelParam):Array
[static] get number list inside of #OPN@{..};
Translator
  
getOPXParam(param:SiOPMChannelParam):Array
[static] get number list inside of #OPX@{..};
Translator
  
getParam(param:SiOPMChannelParam):Array
[static] get number list inside of #@{..};
Translator
  
mckc(mckcMML:String):String
[static] Translate ppmckc mml to SiOPM mml.
Translator
  
mmlALParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String
[static] reconstruct mml text of #AL@{..};
Translator
  
mmlMA3Param(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String
[static] reconstruct mml text of #MA@{..};
Translator
  
mmlOPLParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String
[static] reconstruct mml text of #OPL@{..};
Translator
  
mmlOPMParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String
[static] reconstruct mml text of #OPM@{..};
Translator
  
mmlOPNParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String
[static] reconstruct mml text of #OPN@{..};
Translator
  
mmlOPXParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String
[static] reconstruct mml text of #OPX@{..};
Translator
  
mmlParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String
[static] reconstruct mml text of #@{..}.
Translator
  
mmlVoiceSetting(voice:SiMMLVoice):String
[static] reconstruct voice setting mml (except for channel operator parameters and envelopes)
Translator
  
parseALParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam
[static] parse inside of #AL@{..};
Translator
  
parseEffectorMML(mml:String, postfix:String):Array
[static] Parse effector mml and return an array of SiEffectBase.
Translator
  
parseMA3Param(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam
[static] parse inside of #MA@{..};
Translator
  
parseOPLParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam
[static] parse inside of #OPL@{..};
Translator
  
parseOPMParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam
[static] parse inside of #OPM@{..};
Translator
  
parseOPNParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam
[static] parse inside of #OPN@{..};
Translator
  
parseOPXParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam
[static] parse inside of #OPX@{..};
Translator
  
parseParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam
[static] parse inside of #@{..};
Translator
  
parsePCMVoice(voice:SiMMLVoice, mml:String, postfix:String, envelopes:Vector.<SiMMLEnvelopTable> = null):Boolean
[static] parse mml text of pcm voice setting (#PCMVOICE system command)
Translator
  
parsePCMWave(table:SiOPMWavePCMTable, mml:String, soundReferTable:*):Boolean
[static] parse mml text of pcm wave setting (#PCMWAVE system command).
Translator
  
parseSamplerWave(table:SiOPMWaveSamplerTable, noteNumber:int, mml:String, soundReferTable:*):Boolean
[static] parse mml text of sampler wave setting (#SAMPLER system command).
Translator
  
parseTableNumbers(tableNumbers:String, postfix:String, maxIndex:int = 65536):*
[static] parse mml of envelop and wave table numbers.
Translator
  
parseVoiceSetting(voice:SiMMLVoice, mml:String, envelopes:Vector.<SiMMLEnvelopTable> = null):SiMMLVoice
[static] parse voice setting mml
Translator
  
parseWAV(tableNumbers:String, postfix:String):Vector.<Number>
[static] parse #WAV data
Translator
  
parseWAVB(hex:String):Vector.<Number>
[static] parse #WAVB data
Translator
  
setALParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam
[static] set inside of #AL@{..};
Translator
  
setMA3Param(param:SiOPMChannelParam, data:Array):SiOPMChannelParam
[static] set inside of #MA@{..};
Translator
  
setOPLParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam
[static] set inside of #OPL@{..};
Translator
  
setOPMParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam
[static] set inside of #OPM@{..};
Translator
  
setOPMVoicesByRegister(regData:Vector.<int>, address:int, enableLFO:Boolean = false, voiceSet:Array = null):Array
[static] set SiONVoice list by OPM register data
Translator
  
setOPNParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam
[static] set inside of #OPN@{..};
Translator
  
setOPXParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam
[static] set inside of #OPX@{..};
Translator
  
setParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam
[static] set inside of #@{..};
Translator
  
tsscp(tsscpMML:String, volumeByX:Boolean = true):String
[static] Translate pTSSCP mml to SiOPM mml.
Translator
Constructor Detail
Translator()Constructor
public function Translator()

constructor, do nothing.

Method Detail
errorParameterNotValid()method
public static function errorParameterNotValid(cmd:String, param:String):Error

Parameters

cmd:String
 
param:String

Returns
Error
errorToneParameterNotValid()method 
public static function errorToneParameterNotValid(cmd:String, chParam:int, opParam:int):Error

Parameters

cmd:String
 
chParam:int
 
opParam:int

Returns
Error
errorTranslation()method 
public static function errorTranslation(str:String):Error

Parameters

str:String

Returns
Error
errorUnknown()method 
public static function errorUnknown(str:String):Error

Parameters

str:String

Returns
Error
extractSystemCommand()method 
public static function extractSystemCommand(mml:String):Array

extract system command from mml

Parameters

mml:String — mml text

Returns
Array — extracted command list. the mml of "#CMD1{cont}pfx;" is converted to the Object as {command:"CMD", number:1, content:"cont", postfix:"pfx"}.
flmml()method 
public static function flmml(flMML:String):String

Translate flMML's mml to SiOPM mml.

Parameters

flMML:String — flMML's MML text.

Returns
String — translated SiON MML text
getALParam()method 
public static function getALParam(param:SiOPMChannelParam):Array

get number list inside of #AL@{..};

Parameters

param:SiOPMChannelParam

Returns
Array
getMA3Param()method 
public static function getMA3Param(param:SiOPMChannelParam):Array

get number list inside of #MA@{..};

Parameters

param:SiOPMChannelParam

Returns
Array
getOPLParam()method 
public static function getOPLParam(param:SiOPMChannelParam):Array

get number list inside of #OPL@{..};

Parameters

param:SiOPMChannelParam

Returns
Array
getOPMParam()method 
public static function getOPMParam(param:SiOPMChannelParam):Array

get number list inside of #OPM@{..};

Parameters

param:SiOPMChannelParam

Returns
Array
getOPNParam()method 
public static function getOPNParam(param:SiOPMChannelParam):Array

get number list inside of #OPN@{..};

Parameters

param:SiOPMChannelParam

Returns
Array
getOPXParam()method 
public static function getOPXParam(param:SiOPMChannelParam):Array

get number list inside of #OPX@{..};

Parameters

param:SiOPMChannelParam

Returns
Array
getParam()method 
public static function getParam(param:SiOPMChannelParam):Array

get number list inside of #@{..};

Parameters

param:SiOPMChannelParam

Returns
Array
mckc()method 
public static function mckc(mckcMML:String):String

Translate ppmckc mml to SiOPM mml.

Parameters

mckcMML:String — ppmckc MML text.

Returns
String — translated SiON MML text
mmlALParam()method 
public static function mmlALParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String

reconstruct mml text of #AL@{..};

Parameters

param:SiOPMChannelParam — SiOPMChannelParam for MML reconstruction
 
separator:String (default = ) — String to separate each number
 
lineEnd:String (default = ) — String to separate line end
 
comment:String (default = null) — comment text inserting after 'fbc' number

Returns
String — text formatted as "{..}".
mmlMA3Param()method 
public static function mmlMA3Param(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String

reconstruct mml text of #MA@{..};

Parameters

param:SiOPMChannelParam — SiOPMChannelParam for MML reconstruction
 
separator:String (default = ) — String to separate each number
 
lineEnd:String (default = ) — String to separate line end
 
comment:String (default = null) — comment text inserting after 'fbc' number

Returns
String — text formatted as "{..}".
mmlOPLParam()method 
public static function mmlOPLParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String

reconstruct mml text of #OPL@{..};

Parameters

param:SiOPMChannelParam — SiOPMChannelParam for MML reconstruction
 
separator:String (default = ) — String to separate each number
 
lineEnd:String (default = ) — String to separate line end
 
comment:String (default = null) — comment text inserting after 'fbc' number

Returns
String — text formatted as "{..}".
mmlOPMParam()method 
public static function mmlOPMParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String

reconstruct mml text of #OPM@{..};

Parameters

param:SiOPMChannelParam — SiOPMChannelParam for MML reconstruction
 
separator:String (default = ) — String to separate each number
 
lineEnd:String (default = ) — String to separate line end
 
comment:String (default = null) — comment text inserting after 'fbc' number

Returns
String — text formatted as "{..}".
mmlOPNParam()method 
public static function mmlOPNParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String

reconstruct mml text of #OPN@{..};

Parameters

param:SiOPMChannelParam — SiOPMChannelParam for MML reconstruction
 
separator:String (default = ) — String to separate each number
 
lineEnd:String (default = ) — String to separate line end
 
comment:String (default = null) — comment text inserting after 'fbc' number

Returns
String — text formatted as "{..}".
mmlOPXParam()method 
public static function mmlOPXParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String

reconstruct mml text of #OPX@{..};

Parameters

param:SiOPMChannelParam — SiOPMChannelParam for MML reconstruction
 
separator:String (default = ) — String to separate each number
 
lineEnd:String (default = ) — String to separate line end
 
comment:String (default = null) — comment text inserting after 'fbc' number

Returns
String — text formatted as "{..}".
mmlParam()method 
public static function mmlParam(param:SiOPMChannelParam, separator:String = , lineEnd:String = , comment:String = null):String

reconstruct mml text of #@{..}.

Parameters

param:SiOPMChannelParam — SiOPMChannelParam for MML reconstruction
 
separator:String (default = ) — String to separate each number
 
lineEnd:String (default = ) — String to separate line end
 
comment:String (default = null) — comment text inserting after 'fbc' number

Returns
String — text formatted as "{..}".
mmlVoiceSetting()method 
public static function mmlVoiceSetting(voice:SiMMLVoice):String

reconstruct voice setting mml (except for channel operator parameters and envelopes)

Parameters

voice:SiMMLVoice

Returns
String
parseALParam()method 
public static function parseALParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam

parse inside of #AL@{..};

Parameters

param:SiOPMChannelParam
 
dataString:String

Returns
SiOPMChannelParam
parseEffectorMML()method 
public static function parseEffectorMML(mml:String, postfix:String):Array

Parse effector mml and return an array of SiEffectBase.

Parameters

mml:String — Effector MML text.
 
postfix:String — postfix text.

Returns
Array — An array of SiEffectBase.
parseMA3Param()method 
public static function parseMA3Param(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam

parse inside of #MA@{..};

Parameters

param:SiOPMChannelParam
 
dataString:String

Returns
SiOPMChannelParam
parseOPLParam()method 
public static function parseOPLParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam

parse inside of #OPL@{..};

Parameters

param:SiOPMChannelParam
 
dataString:String

Returns
SiOPMChannelParam
parseOPMParam()method 
public static function parseOPMParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam

parse inside of #OPM@{..};

Parameters

param:SiOPMChannelParam
 
dataString:String

Returns
SiOPMChannelParam
parseOPNParam()method 
public static function parseOPNParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam

parse inside of #OPN@{..};

Parameters

param:SiOPMChannelParam
 
dataString:String

Returns
SiOPMChannelParam
parseOPXParam()method 
public static function parseOPXParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam

parse inside of #OPX@{..};

Parameters

param:SiOPMChannelParam
 
dataString:String

Returns
SiOPMChannelParam
parseParam()method 
public static function parseParam(param:SiOPMChannelParam, dataString:String):SiOPMChannelParam

parse inside of #@{..};

Parameters

param:SiOPMChannelParam
 
dataString:String

Returns
SiOPMChannelParam
parsePCMVoice()method 
public static function parsePCMVoice(voice:SiMMLVoice, mml:String, postfix:String, envelopes:Vector.<SiMMLEnvelopTable> = null):Boolean

parse mml text of pcm voice setting (#PCMVOICE system command)

Parameters

voice:SiMMLVoice — SiMMLVoice to update parameters
 
mml:String — comma separated values of #PCMVOICE system command
 
postfix:String — postfix of #PCMVOICE system command
 
envelopes:Vector.<SiMMLEnvelopTable> (default = null) — envelope list to pickup envelope

Returns
Boolean — true when success to update parameters
parsePCMWave()method 
public static function parsePCMWave(table:SiOPMWavePCMTable, mml:String, soundReferTable:*):Boolean

parse mml text of pcm wave setting (#PCMWAVE system command).

Parameters

table:SiOPMWavePCMTable — table to set PCM wave
 
mml:String — comma separated values of #PCMWAVE system command
 
soundReferTable:* — reference table of Sound instances.

Returns
Boolean — true when success to find wave from soundReferTable.
parseSamplerWave()method 
public static function parseSamplerWave(table:SiOPMWaveSamplerTable, noteNumber:int, mml:String, soundReferTable:*):Boolean

parse mml text of sampler wave setting (#SAMPLER system command).

Parameters

table:SiOPMWaveSamplerTable — table to set sampler wave
 
noteNumber:int — note number to set sample
 
mml:String — comma separated text of #SAMPLER system command
 
soundReferTable:* — reference table of Sound instances.

Returns
Boolean — true when success to find wave from soundReferTable.
parseTableNumbers()method 
public static function parseTableNumbers(tableNumbers:String, postfix:String, maxIndex:int = 65536):*

parse mml of envelop and wave table numbers.

Parameters

tableNumbers:String — String of table numbers
 
postfix:String — String of postfix
 
maxIndex:int (default = 65536) — maximum size of envelop table

Returns
* — this instance
parseVoiceSetting()method 
public static function parseVoiceSetting(voice:SiMMLVoice, mml:String, envelopes:Vector.<SiMMLEnvelopTable> = null):SiMMLVoice

parse voice setting mml

Parameters

voice:SiMMLVoice — voice to update
 
mml:String — setting mml
 
envelopes:Vector.<SiMMLEnvelopTable> (default = null) — envelope list to pickup envelope

Returns
SiMMLVoice — same as argument of 'voice'.
parseWAV()method 
public static function parseWAV(tableNumbers:String, postfix:String):Vector.<Number>

parse #WAV data

Parameters

tableNumbers:String — number string of #WAV command.
 
postfix:String — postfix string of #WAV command.

Returns
Vector.<Number> — vector of Number in the range of [-1,1]
parseWAVB()method 
public static function parseWAVB(hex:String):Vector.<Number>

parse #WAVB data

Parameters

hex:String — hex string of #WAVB command.

Returns
Vector.<Number> — vector of Number in the range of [-1,1]
setALParam()method 
public static function setALParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam

set inside of #AL@{..};

Parameters

param:SiOPMChannelParam
 
data:Array

Returns
SiOPMChannelParam
setMA3Param()method 
public static function setMA3Param(param:SiOPMChannelParam, data:Array):SiOPMChannelParam

set inside of #MA@{..};

Parameters

param:SiOPMChannelParam
 
data:Array

Returns
SiOPMChannelParam
setOPLParam()method 
public static function setOPLParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam

set inside of #OPL@{..};

Parameters

param:SiOPMChannelParam
 
data:Array

Returns
SiOPMChannelParam
setOPMParam()method 
public static function setOPMParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam

set inside of #OPM@{..};

Parameters

param:SiOPMChannelParam
 
data:Array

Returns
SiOPMChannelParam
setOPMVoicesByRegister()method 
public static function setOPMVoicesByRegister(regData:Vector.<int>, address:int, enableLFO:Boolean = false, voiceSet:Array = null):Array

set SiONVoice list by OPM register data

Parameters

regData:Vector.<int> — int vector of register data.
 
address:int — address of the first data in regData
 
enableLFO:Boolean (default = false) — flag to enable LFO parameters
 
voiceSet:Array (default = null) — voice list to set parameters. When this argument is null, returning voices are allocated inside.

Returns
Array — voice list pick up values from register data.
setOPNParam()method 
public static function setOPNParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam

set inside of #OPN@{..};

Parameters

param:SiOPMChannelParam
 
data:Array

Returns
SiOPMChannelParam
setOPXParam()method 
public static function setOPXParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam

set inside of #OPX@{..};

Parameters

param:SiOPMChannelParam
 
data:Array

Returns
SiOPMChannelParam
setParam()method 
public static function setParam(param:SiOPMChannelParam, data:Array):SiOPMChannelParam

set inside of #@{..};

Parameters

param:SiOPMChannelParam
 
data:Array

Returns
SiOPMChannelParam
tsscp()method 
public static function tsscp(tsscpMML:String, volumeByX:Boolean = true):String

Translate pTSSCP mml to SiOPM mml.

Parameters

tsscpMML:String — TSSCP MML text.
 
volumeByX:Boolean (default = true) — true to translate volume control to SiON MMLs 'x' command, false to translate to SiON MMLs 'v' command.

Returns
String — translated SiON MML text



© 2009-2014 keim_at_si

Fri Jan 22 2016, 07:46 PM +09:00