Packageorg.si.sion.module.channels
Classpublic class SiOPMOperator
InheritanceSiOPMOperator Inheritance Object

SiOPM operator class. This operator based on the OPM emulation of MAME, but its extended in below points, 1) You can set the phase offest of pulse generator. 2) You can select the wave form from some wave tables (see class SiOPMTable). 3) You can set the key scale level. 4) You can fix the pitch. 5) You can set the ssgec in OPNA.



Public Properties
 PropertyDefined By
  ame : Boolean
amplitude modulation enable [t/f]
SiOPMOperator
  ams : int
amplitude modulation shift [t/f]
SiOPMOperator
  ar : int
Attack rate [0,63]
SiOPMOperator
  detune : int
Detune for pTSS.
SiOPMOperator
  detune2 : int
Detune for pitch modulation.
SiOPMOperator
  dr : int
Decay rate [0,63]
SiOPMOperator
  dt1 : int
dt1 [0-7]
SiOPMOperator
  dt2 : int
dt2 [0-3]
SiOPMOperator
  _erst : Boolean
SiOPMOperator
  erst : Boolean
Envelop reset on attack
SiOPMOperator
  fixedPitchIndex : int
[write-only] Fixed pitch index.
SiOPMOperator
  fmul : int
Fine multiple for pTSS.
SiOPMOperator
  fnum : int
[write-only] F-Number for OPNA.
SiOPMOperator
  kc : int
Key code [0,127]
SiOPMOperator
  keyOnPhase : int
Phase at keyOn [-1-255].
SiOPMOperator
  kf : int
key fraction [0-63]
SiOPMOperator
  ks : int
Key scaling rate [0,3]
SiOPMOperator
  ksl : int
Key scaling level [0,3]
SiOPMOperator
  modLevel : int
Frequency modulation level.
SiOPMOperator
  mul : int
multiple [0,15]
SiOPMOperator
  mute : Boolean
Mute
SiOPMOperator
  pgType : int
Pulse generator type.
SiOPMOperator
  pitchFixed : Boolean
[read-only]
SiOPMOperator
  pitchIndex : int
pitchIndex = (note << 6) | (kf & 63) [0,8191]
SiOPMOperator
  ptType : int
[write-only] Pitch table type.
SiOPMOperator
  rr : int
Release rate [0,63]
SiOPMOperator
  sl : int
Sustain level [0,15]
SiOPMOperator
  sr : int
Sustain rate [0,63]
SiOPMOperator
  ssgec : int
SSG type envelop control
SiOPMOperator
  tl : int
Total level [0,127]
SiOPMOperator
Public Methods
 MethodDefined By
  
constructor
SiOPMOperator
  
Get paramaters by SiOPMOperatorParam
SiOPMOperator
  
initialize():void
Initialize.
SiOPMOperator
  
noteOff():void
Note off.
SiOPMOperator
  
noteOn():void
Note on.
SiOPMOperator
  
reset():void
Reset.
SiOPMOperator
  
Set PCM data.
SiOPMOperator
  
Set paramaters by SiOPMOperatorParam
SiOPMOperator
  
Set Wave table data.
SiOPMOperator
  
toString():String
SiOPMOperator
Public Constants
 ConstantDefined By
  EG_ATTACK : int = 0
[static]
SiOPMOperator
  EG_DECAY : int = 1
[static]
SiOPMOperator
  EG_OFF : int = 4
[static]
SiOPMOperator
  EG_RELEASE : int = 3
[static]
SiOPMOperator
  EG_SUSTAIN : int = 2
[static]
SiOPMOperator
Property Detail
_erstproperty
public var _erst:Boolean

ameproperty 
ame:Boolean

amplitude modulation enable [t/f]


Implementation
    public function get ame():Boolean
    public function set ame(value:Boolean):void
amsproperty 
ams:int

amplitude modulation shift [t/f]


Implementation
    public function get ams():int
    public function set ams(value:int):void
arproperty 
ar:int

Attack rate [0,63]


Implementation
    public function get ar():int
    public function set ar(value:int):void
detuneproperty 
detune:int

Detune for pTSS. 1 halftone divides into 64 steps. This property resets dt2.


Implementation
    public function get detune():int
    public function set detune(value:int):void
detune2property 
detune2:int

Detune for pitch modulation. This is independent value.


Implementation
    public function get detune2():int
    public function set detune2(value:int):void
drproperty 
dr:int

Decay rate [0,63]


Implementation
    public function get dr():int
    public function set dr(value:int):void
dt1property 
dt1:int

dt1 [0-7]


Implementation
    public function get dt1():int
    public function set dt1(value:int):void
dt2property 
dt2:int

dt2 [0-3]


Implementation
    public function get dt2():int
    public function set dt2(value:int):void
erstproperty 
erst:Boolean

Envelop reset on attack


Implementation
    public function get erst():Boolean
    public function set erst(value:Boolean):void
fixedPitchIndexproperty 
fixedPitchIndex:int  [write-only]

Fixed pitch index. 0 means fixed off.


Implementation
    public function set fixedPitchIndex(value:int):void
fmulproperty 
fmul:int

Fine multiple for pTSS. 128=x1.


Implementation
    public function get fmul():int
    public function set fmul(value:int):void
fnumproperty 
fnum:int  [write-only]

F-Number for OPNA. This property resets kf,dt2 and detune.


Implementation
    public function set fnum(value:int):void
kcproperty 
kc:int

Key code [0,127]


Implementation
    public function get kc():int
    public function set kc(value:int):void
keyOnPhaseproperty 
keyOnPhase:int

Phase at keyOn [-1-255]. similar with pTSS. The value of 255 sets no phase reset, -1 sets randamize.


Implementation
    public function get keyOnPhase():int
    public function set keyOnPhase(value:int):void
kfproperty 
kf:int

key fraction [0-63]


Implementation
    public function get kf():int
    public function set kf(value:int):void
ksproperty 
ks:int

Key scaling rate [0,3]


Implementation
    public function get ks():int
    public function set ks(value:int):void
kslproperty 
ksl:int

Key scaling level [0,3]


Implementation
    public function get ksl():int
    public function set ksl(value:int):void
modLevelproperty 
modLevel:int

Frequency modulation level. 15 is standard modulation.


Implementation
    public function get modLevel():int
    public function set modLevel(value:int):void
mulproperty 
mul:int

multiple [0,15]


Implementation
    public function get mul():int
    public function set mul(value:int):void
muteproperty 
mute:Boolean

Mute


Implementation
    public function get mute():Boolean
    public function set mute(value:Boolean):void
pgTypeproperty 
pgType:int

Pulse generator type.


Implementation
    public function get pgType():int
    public function set pgType(value:int):void
pitchFixedproperty 
pitchFixed:Boolean  [read-only]


Implementation
    public function get pitchFixed():Boolean
pitchIndexproperty 
pitchIndex:int

pitchIndex = (note << 6) | (kf & 63) [0,8191]


Implementation
    public function get pitchIndex():int
    public function set pitchIndex(value:int):void
ptTypeproperty 
ptType:int  [write-only]

Pitch table type.


Implementation
    public function set ptType(value:int):void
rrproperty 
rr:int

Release rate [0,63]


Implementation
    public function get rr():int
    public function set rr(value:int):void
slproperty 
sl:int

Sustain level [0,15]


Implementation
    public function get sl():int
    public function set sl(value:int):void
srproperty 
sr:int

Sustain rate [0,63]


Implementation
    public function get sr():int
    public function set sr(value:int):void
ssgecproperty 
ssgec:int

SSG type envelop control


Implementation
    public function get ssgec():int
    public function set ssgec(value:int):void
tlproperty 
tl:int

Total level [0,127]


Implementation
    public function get tl():int
    public function set tl(value:int):void
Constructor Detail
SiOPMOperator()Constructor
public function SiOPMOperator(chip:SiOPMModule)

constructor

Parameters
chip:SiOPMModule
Method Detail
getSiOPMOperatorParam()method
public function getSiOPMOperatorParam(param:SiOPMOperatorParam):void

Get paramaters by SiOPMOperatorParam

Parameters

param:SiOPMOperatorParam

initialize()method 
public function initialize():void

Initialize.

noteOff()method 
public function noteOff():void

Note off.

noteOn()method 
public function noteOn():void

Note on.

reset()method 
public function reset():void

Reset.

setPCMData()method 
public function setPCMData(pcmData:SiOPMWavePCMData):void

Set PCM data.

Parameters

pcmData:SiOPMWavePCMData

setSiOPMOperatorParam()method 
public function setSiOPMOperatorParam(param:SiOPMOperatorParam):void

Set paramaters by SiOPMOperatorParam

Parameters

param:SiOPMOperatorParam

setWaveTable()method 
public function setWaveTable(waveTable:SiOPMWaveTable):void

Set Wave table data.

Parameters

waveTable:SiOPMWaveTable

toString()method 
public function toString():String

Returns
String
Constant Detail
EG_ATTACKConstant
public static const EG_ATTACK:int = 0

EG_DECAYConstant 
public static const EG_DECAY:int = 1

EG_OFFConstant 
public static const EG_OFF:int = 4

EG_RELEASEConstant 
public static const EG_RELEASE:int = 3

EG_SUSTAINConstant 
public static const EG_SUSTAIN:int = 2