Packageorg.si.sion.module.channels
Classpublic class SiOPMChannelKS
InheritanceSiOPMChannelKS Inheritance SiOPMChannelFM Inheritance SiOPMChannelBase Inheritance Object

Karplus-Strong algorism with FM synth.



Public Properties
 PropertyDefined By
 InheritedactiveOperator : SiOPMOperator
active operator
SiOPMChannelFM
 InheritedactiveOperatorIndex : int
[override] [write-only] active operator index (i)
SiOPMChannelFM
 InheritedbufferIndex : int
[read-only] buffer index
SiOPMChannelBase
 InheritedchannelType : int
[read-only] channel type
SiOPMChannelBase
 Inheriteddetune : int
[override] [write-only] detune (@dt)
SiOPMChannelFM
 Inheritederst : Boolean
[override] [write-only] envelop reset (@er)
SiOPMChannelFM
 InheritedfilterType : int
filter mode
SiOPMChannelBase
  fixedPitch : int
[override] [write-only] fixed pitch (@fx)
SiOPMChannelKS
 Inheritedfmul : int
[override] [write-only] fine multiple (@ml)
SiOPMChannelFM
 InheritedisFilterActive : Boolean
[read-only] Is filter active ?
SiOPMChannelBase
 InheritedisIdling : Boolean
[read-only] Is idling ?
SiOPMChannelBase
 InheritedisNoteOn : Boolean
[read-only] is this channel note on ?
SiOPMChannelBase
 InheritedmasterVolume : int
Master volume (0-128)
SiOPMChannelBase
 Inheritedmute : Boolean
Mute
SiOPMChannelBase
 Inheritedoperator : Vector.<SiOPMOperator>
operators
SiOPMChannelFM
 Inheritedpan : int
Pan (-64-64 left=-64, center=0, right=64). [left volume] = cos((pan+64)/128I.5) volume; [right volume] = sin((pan+64)/128I.5) volume;
SiOPMChannelBase
 Inheritedphase : int
[override] [write-only] phase (@ph)
SiOPMChannelFM
  pitch : int
[override] pitch = (note << 6) | (kf & 63) [0,8191]
SiOPMChannelKS
  rr : int
[override] [write-only] release rate (@rr)
SiOPMChannelKS
 Inheritedssgec : int
[override] [write-only] ssgec (@se)
SiOPMChannelFM
 Inheritedtl : int
[override] [write-only] total level (@tl)
SiOPMChannelFM
Protected Properties
 PropertyDefined By
 Inherited_algorism : int
algorism
SiOPMChannelFM
 Inherited_am_depth : int
am depth
SiOPMChannelFM
 Inherited_am_out : int
am output level
SiOPMChannelFM
 Inherited_basePipe : SLLint
base pipe
SiOPMChannelBase
 Inherited_bufferIndex : int
buffering index
SiOPMChannelBase
 Inherited_chip : SiOPMModule
chip
SiOPMChannelBase
 Inherited_cutoff : int
cutoff frequency
SiOPMChannelBase
 Inherited_cutoff_offset : int
cutoff frequency
SiOPMChannelBase
 Inherited_eg_timer_initial : int
ENV_TIMER_INITIAL freq_ratio
SiOPMChannelFM
 Inherited_expressionTable : Vector.<int>
expression table
SiOPMChannelBase
 Inherited_filter_eg_cutoff : Vector.<int>
eg level
SiOPMChannelBase
 Inherited_filter_eg_cutoff_inc : int
eg direction
SiOPMChannelBase
 Inherited_filter_eg_next : int
eg phase shift l.
SiOPMChannelBase
 Inherited_filter_eg_state : int
eg state
SiOPMChannelBase
 Inherited_filter_eg_step : int
eg step
SiOPMChannelBase
 Inherited_filter_eg_time : Vector.<int>
eg rate
SiOPMChannelBase
 Inherited_filterOn : Boolean
filter switch
SiOPMChannelBase
 Inherited_filterType : int
filter type
SiOPMChannelBase
 Inherited_filterVriables : Vector.<Number>
filter Variables
SiOPMChannelBase
 Inherited_freq_ratio : int
frequency ratio
SiOPMChannelBase
 Inherited_funcProcess : Function
functor to process
SiOPMChannelBase
 Inherited_funcProcessList : Array
process func
SiOPMChannelFM
 Inherited_funcProcessType : int
process type
SiOPMChannelFM
 Inherited_hasEffectSend : Boolean
effect send flag
SiOPMChannelBase
 Inherited_inPipe : SLLint
in pipe
SiOPMChannelBase
 Inherited_inputLevel : int
input level
SiOPMChannelBase
 Inherited_inputMode : int
input level
SiOPMChannelBase
 Inherited_isIdling : Boolean
idling flag
SiOPMChannelBase
 Inherited_isNoteOn : Boolean
note on flag
SiOPMChannelBase
 Inherited_lfo_on : int
lfo switch
SiOPMChannelBase
 Inherited_lfo_phase : int
lfo phase
SiOPMChannelBase
 Inherited_lfo_timer : int
lfo timer
SiOPMChannelBase
 Inherited_lfo_timer_initial : int
LFO_TIMER_INITIAL freq_ratio
SiOPMChannelFM
 Inherited_lfo_timer_step_ : int
lfo step buffer
SiOPMChannelBase
 Inherited_lfo_timer_step : int
lfo timer step
SiOPMChannelBase
 Inherited_lfo_waveShape : int
lfo wave shape
SiOPMChannelBase
 Inherited_lfo_waveTable : Vector.<int>
lfo wave table
SiOPMChannelBase
 Inherited_mute : Boolean
mute
SiOPMChannelBase
 Inherited_operatorCount : int
count
SiOPMChannelFM
 Inherited_outPipe : SLLint
out pipe
SiOPMChannelBase
 Inherited_outputMode : int
output mode
SiOPMChannelBase
 Inherited_pan : int
pan
SiOPMChannelBase
 Inherited_pipe0 : SLLint
internal pipe0
SiOPMChannelFM
 Inherited_pipe1 : SLLint
internal pipe1
SiOPMChannelFM
 Inherited_pm_depth : int
pm depth
SiOPMChannelFM
 Inherited_pm_out : int
pm output level
SiOPMChannelFM
 Inherited_prevStepRemain : int
eg step residue
SiOPMChannelBase
 Inherited_resonance : Number
resonance
SiOPMChannelBase
 Inherited_ringmodLevel : Number
ringmod level
SiOPMChannelBase
 Inherited_ringPipe : SLLint
ringmod pipe
SiOPMChannelBase
 Inherited_streams : Vector.<SiOPMStream>
stream
SiOPMChannelBase
 Inherited_table : SiOPMTable
table
SiOPMChannelBase
 Inherited_veocityTable : Vector.<int>
veocity table
SiOPMChannelBase
 Inherited_volumes : Vector.<Number>
volume
SiOPMChannelBase
Public Methods
 MethodDefined By
  
constructor
SiOPMChannelKS
 Inherited
activateFilter(b:Boolean):void
Filter activation
SiOPMChannelBase
  
buffer(len:int):void
[override] Buffering
SiOPMChannelKS
 Inherited
[override] Get SiOPMChannelParam.
SiOPMChannelFM
 Inherited
getStreamSend(streamNum:int):Number
get stream send.
SiOPMChannelBase
  
initialize(prev:SiOPMChannelBase, bufferIndex:int):void
[override] Initialize.
SiOPMChannelKS
 Inherited
initializeLFO(waveform:int, customWaveTable:Vector.<int> = null):void
[override] initialize low frequency oscillator.
SiOPMChannelFM
 Inherited
nop(len:int):void
Buffering without processnig
SiOPMChannelBase
  
noteOff():void
[override] Note off.
SiOPMChannelKS
  
noteOn():void
[override] Note on.
SiOPMChannelKS
 Inherited
offsetFilter(i:int):void
LP Filter cutoff offset controled by table envelop (nf)
SiOPMChannelBase
  
offsetVolume(expression:int, velocity:int):void
[override] update all tl offsets of final carriors
SiOPMChannelKS
  
reset():void
[override] Reset.
SiOPMChannelKS
  
[override] Prepare buffering
SiOPMChannelKS
 Inherited
setAlgorism(cnt:int, alg:int):void
[override] Set algorism (@al)
SiOPMChannelFM
  
setAllAttackRate(ar:int):void
[override] Attack rate
SiOPMChannelKS
  
setAllReleaseRate(rr:int):void
[override] Release rate (s)
SiOPMChannelKS
 Inherited
setAllStreamSendLevels(param:Vector.<int>):void
set all stream send levels by Vector.<int>.
SiOPMChannelBase
 Inherited
setAmplitudeModulation(depth:int):void
[override] Amplitude modulation.
SiOPMChannelFM
 Inherited
setChannelNumber(channelNum:int):void
[override] set channel number (2nd argument of %)
SiOPMChannelFM
 Inherited
setFeedBack(fb:int, fbc:int):void
[override] Set feedback(@fb).
SiOPMChannelFM
 Inherited
setFrequencyRatio(ratio:int):void
[override] set chip "PSEUDO" frequency ratio by [%].
SiOPMChannelFM
 Inherited
setInput(level:int, pipeIndex:int):void
Set input pipe (@i).
SiOPMChannelBase
  
setKarplusStrongParam(ar:int = 48, dr:int = 48, tl:int = 0, fixedPitch:int = 0, ws:int = -1, tension:int = 8):void
Set Karplus Strong parameters
SiOPMChannelKS
 Inherited
setLFOCycleTime(ms:Number):void
set LFO cycle time (@lfo).
SiOPMChannelBase
 Inherited
setOutput(outputMode:int, pipeIndex:int):void
Set output pipe (@o).
SiOPMChannelBase
  
setParameters(param:Vector.<int>):void
[override] Set parameters (@ commands 2nd-15th args.).
SiOPMChannelKS
 Inherited
setPitchModulation(depth:int):void
[override] Pitch modulation.
SiOPMChannelFM
 Inherited
setRegister(addr:int, data:int):void
[override] set register
SiOPMChannelFM
 Inherited
setRingModulation(level:int, pipeIndex:int):void
Set ring modulation pipe (@r).
SiOPMChannelBase
 Inherited
setSiOPMChannelParam(param:SiOPMChannelParam, withVolume:Boolean, withModulation:Boolean = true):void
[override] Set by SiOPMChannelParam.
SiOPMChannelFM
 Inherited
setSiOPMParameters(ar:int, dr:int, sr:int, rr:int, sl:int, tl:int, ksr:int, ksl:int, mul:int, dt1:int, detune:int, ams:int, phase:int, fixNote:int):void
Set sound by 14 basic params.
SiOPMChannelFM
 Inherited
setStreamBuffer(streamNum:int, stream:SiOPMStream = null):void
set stream buffer.
SiOPMChannelBase
 Inherited
setStreamSend(streamNum:int, volume:Number):void
set stream send.
SiOPMChannelBase
 Inherited
setSVFilter(cutoff:int = 128, resonance:int = 0, ar:int = 0, dr1:int = 0, dr2:int = 0, rr:int = 0, dc1:int = 128, dc2:int = 128, sc:int = 128, rc:int = 128):void
SVFilter envelop (@f).
SiOPMChannelBase
  
setType(pgType:int, ptType:int):void
[override] pgType and ptType (@ commands 1st arg except for %6,7)
SiOPMChannelKS
 Inherited
setVolumeTables(vtable:Vector.<int>, xtable:Vector.<int>):void
set velocity and expression tables
SiOPMChannelBase
 Inherited
setWaveData(waveData:SiOPMWaveBase):void
[override] Set wave data.
SiOPMChannelFM
  
toString():String
[override] Output parameters.
SiOPMChannelKS
Protected Methods
 MethodDefined By
 Inherited
_applyRingModulation(pointer:SLLint, len:int):void
ring modulation
SiOPMChannelBase
 Inherited
_applySVFilter(pointer:SLLint, len:int, variables:Vector.<Number> = null):void
state variable filter
SiOPMChannelBase
 Inherited
_nop(len:int):void
No process (default functor of _funcProcess).
SiOPMChannelBase
 Inherited
reset SVFilter
SiOPMChannelBase
 Inherited
shiftSVFilterState(state:int):void
shift SVFilter state
SiOPMChannelBase
Public Constants
 ConstantDefined By
 InheritedFILTER_BP : int = 1
[static] band pass filter
SiOPMChannelBase
 InheritedFILTER_HP : int = 2
[static] high pass filter
SiOPMChannelBase
 InheritedFILTER_LP : int = 0
[static] low pass filter
SiOPMChannelBase
 InheritedINPUT_FEEDBACK : int = 2
[static] input from feedback
SiOPMChannelBase
 InheritedINPUT_PIPE : int = 1
[static] input from pipe
SiOPMChannelBase
 InheritedINPUT_ZERO : int = 0
[static] no input from pipe
SiOPMChannelBase
 InheritedOUTPUT_ADD : int = 2
[static] add to pipe
SiOPMChannelBase
 InheritedOUTPUT_OVERWRITE : int = 1
[static] overwrite pipe
SiOPMChannelBase
 InheritedOUTPUT_STANDARD : int = 0
[static] standard output
SiOPMChannelBase
Property Detail
fixedPitchproperty
fixedPitch:int  [write-only] [override]

fixed pitch (@fx)


Implementation
    public function set fixedPitch(value:int):void
pitchproperty 
pitch:int[override]

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


Implementation
    public function get pitch():int
    public function set pitch(value:int):void
rrproperty 
rr:int  [write-only] [override]

release rate (@rr)


Implementation
    public function set rr(value:int):void
Constructor Detail
SiOPMChannelKS()Constructor
public function SiOPMChannelKS(chip:SiOPMModule)

constructor

Parameters
chip:SiOPMModule
Method Detail
buffer()method
override public function buffer(len:int):void

Buffering

Parameters

len:int

initialize()method 
override public function initialize(prev:SiOPMChannelBase, bufferIndex:int):void

Initialize.

Parameters

prev:SiOPMChannelBase
 
bufferIndex:int

noteOff()method 
override public function noteOff():void

Note off.

noteOn()method 
override public function noteOn():void

Note on.

offsetVolume()method 
override public function offsetVolume(expression:int, velocity:int):void

update all tl offsets of final carriors

Parameters

expression:int
 
velocity:int

reset()method 
override public function reset():void

Reset.

resetChannelBufferStatus()method 
override public function resetChannelBufferStatus():void

Prepare buffering

setAllAttackRate()method 
override public function setAllAttackRate(ar:int):void

Attack rate

Parameters

ar:int

setAllReleaseRate()method 
override public function setAllReleaseRate(rr:int):void

Release rate (s)

Parameters

rr:int

setKarplusStrongParam()method 
public function setKarplusStrongParam(ar:int = 48, dr:int = 48, tl:int = 0, fixedPitch:int = 0, ws:int = -1, tension:int = 8):void

Set Karplus Strong parameters

Parameters

ar:int (default = 48) — attack rate of plunk energy
 
dr:int (default = 48) — decay rate of plunk energy
 
tl:int (default = 0) — total level of plunk energy
 
fixedPitch:int (default = 0) — plunk noise pitch
 
ws:int (default = -1) — wave shape of plunk
 
tension:int (default = 8) — sustain rate of the tone

setParameters()method 
override public function setParameters(param:Vector.<int>):void

Set parameters (@ commands 2nd-15th args.). (@alg,ar,dr,tl,fix,ws)

Parameters

param:Vector.<int>

setType()method 
override public function setType(pgType:int, ptType:int):void

pgType and ptType (@ commands 1st arg except for %6,7)

Parameters

pgType:int
 
ptType:int

toString()method 
override public function toString():String

Output parameters.

Returns
String