com.jsyn.unitgen

Class EnvelopeDAHDSR

java.lang.Object

com.jsyn.unitgen.UnitGenerator

com.jsyn.unitgen.UnitGate

com.jsyn.unitgen.EnvelopeDAHDSR

All Implemented Interfaces:

UnitSource

public class EnvelopeDAHDSR
extends UnitGate
implements UnitSource

Six stage envelope similar to an ADSR. DAHDSR is like an ADSR but with an additional Delay stage before the attack, and a Hold stage after the Attack. If Delay and Hold are both set to zero then it will act like an ADSR. The envelope is triggered when the input goes above THRESHOLD. The envelope is released when the input goes below THRESHOLD. The THRESHOLD is currently 0.01 but may change so it would be best to use an input signal that went from 0 to 1. Mathematically an exponential Release will never reach 0.0. But when it reaches -96 dB the DAHDSR just sets its output to 0.0 and stops. There is an example program in the ZIP archive called HearDAHDSR. It drives a DAHDSR with a square wave.

Author:

Phil Burk (C) 2010 Mobileer Inc

See Also:

SegmentedEnvelope

Field Summary

Fields

Modifier and Type	Field and Description
UnitInputPort	amplitude
UnitInputPort	attack Time in seconds for the rising stage of the envelope to go from 0.0 to 1.0.
UnitInputPort	decay Time in seconds for the falling stage to go from 0 dB to -90 dB.
UnitInputPort	delay Time in seconds for first stage of the envelope, before the attack.
UnitInputPort	hold Time in seconds for the plateau between the attack and decay stages.
UnitInputPort	release Time in seconds to go from 0 dB to -90 dB.
UnitInputPort	sustain Level for the sustain stage.

Fields inherited from class com.jsyn.unitgen.UnitGate

input, output

Fields inherited from class com.jsyn.unitgen.UnitGenerator

FALSE, PORT_NAME_AMPLITUDE, PORT_NAME_CUTOFF, PORT_NAME_FREQUENCY, PORT_NAME_FREQUENCY_SCALER, PORT_NAME_INPUT, PORT_NAME_OUTPUT, PORT_NAME_PAN, PORT_NAME_PHASE, PORT_NAME_PRESSURE, PORT_NAME_TIMBRE, PORT_NAME_TIME, synthesisEngine, TRUE, VERY_SMALL_FLOAT

Constructor Summary

Constructors

Constructor and Description
EnvelopeDAHDSR()

Method Summary

Modifier and Type	Method and Description
void	export(Circuit circuit, java.lang.String prefix)
void	generate(int start, int limit) Perform essential synthesis function.
UnitOutputPort	getOutput()

Methods inherited from class com.jsyn.unitgen.UnitGate

setupAutoDisable

Methods inherited from class com.jsyn.unitgen.UnitGenerator

addPort, addPort, autoStop, convertHalfLifeToMultiplier, convertTimeToRate, flattenOutputs, generate, getCircuit, getFramePeriod, getFrameRate, getId, getPortByName, getPorts, getSynthesisEngine, getSynthesizer, getTopUnit, getUnitGenerator, incrementWrapPhase, isEnabled, isStartRequired, printConnections, printConnections, printConnections, pullData, setCircuit, setEnabled, setFrameRate, setPort, setSynthesisEngine, start, start, start, stop, stop, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jsyn.unitgen.UnitSource

getUnitGenerator

Field Detail

delay

public UnitInputPort delay

Time in seconds for first stage of the envelope, before the attack. Typically zero.

attack

public UnitInputPort attack

Time in seconds for the rising stage of the envelope to go from 0.0 to 1.0. The attack is a linear ramp.

hold

public UnitInputPort hold

Time in seconds for the plateau between the attack and decay stages.

decay

public UnitInputPort decay

Time in seconds for the falling stage to go from 0 dB to -90 dB. The decay stage will stop at the sustain level. But we calculate the time to fall to -90 dB so that the decay rate will be unaffected by the sustain level.

sustain

public UnitInputPort sustain

Level for the sustain stage. The envelope will hold here until the input goes to zero or less. This should be set between 0.0 and 1.0.

release

public UnitInputPort release

Time in seconds to go from 0 dB to -90 dB. This stage is triggered when the input goes to zero or less. The release stage will start from the sustain level. But we calculate the time to fall from full amplitude so that the release rate will be unaffected by the sustain level.

amplitude

public UnitInputPort amplitude

Constructor Detail

EnvelopeDAHDSR

public EnvelopeDAHDSR()

Method Detail

generate

public void generate(int start,
                     int limit)

Description copied from class: UnitGenerator

Perform essential synthesis function.

Specified by:

generate in class UnitGenerator

Parameters:

start - offset into port buffers

limit - limit offset into port buffers for loop

export

public void export(Circuit circuit,
                   java.lang.String prefix)

getOutput

public UnitOutputPort getOutput()

Specified by:

getOutput in interface UnitSource

Overrides:

getOutput in class UnitGate