UnitGenerator

java.lang.Object
- com.jsyn.unitgen.UnitGenerator

Direct Known Subclasses:

BrownNoise, ChannelIn, ChannelOut, Circuit, CrossFade, DualInTwoOut, FFTBase, FourWayFade, GrainFarm, Integrate, LatchZeroCrossing, LineIn, LineOut, MixerMono, MultiChannelScopeProbeUnit, MultiplyAdd, Pan, PanControl, ParabolicEnvelope, PeakFollower, PinkNoise, PitchDetector, PowerOfTwo, Select, SequentialDataReader, SequentialDataWriter, SpectralFFT, SpectralIFFT, SpectralProcessor, TwoInDualOut, UnitBinaryOperator, UnitFilter, UnitGate, UnitOscillator, UnitStreamWriter, WhiteNoise, ZeroCrossingCounter
```
public abstract class UnitGenerator
extends java.lang.Object
```
Base class for all unit generators.

Author:

Phil Burk (C) 2009 Mobileer Inc

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`FALSE`
`static java.lang.String`	`PORT_NAME_AMPLITUDE`
`static java.lang.String`	`PORT_NAME_CUTOFF`
`static java.lang.String`	`PORT_NAME_FREQUENCY`
`static java.lang.String`	`PORT_NAME_FREQUENCY_SCALER`
`static java.lang.String`	`PORT_NAME_INPUT`
`static java.lang.String`	`PORT_NAME_OUTPUT`
`static java.lang.String`	`PORT_NAME_PAN`
`static java.lang.String`	`PORT_NAME_PHASE`
`static java.lang.String`	`PORT_NAME_PRESSURE`
`static java.lang.String`	`PORT_NAME_TIMBRE`
`static java.lang.String`	`PORT_NAME_TIME`
`protected SynthesisEngine`	`synthesisEngine`
`static double`	`TRUE`
`protected static double`	`VERY_SMALL_FLOAT`

Constructor Summary

Constructors
Constructor and Description

UnitGenerator()

Constructors
Constructor and Description
`UnitGenerator()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPort(UnitPort port)`
`void`	`addPort(UnitPort port, java.lang.String name)`
`protected void`	`autoStop()`
`double`	`convertHalfLifeToMultiplier(double halfLife)` Calculate signal based on halflife of an exponential decay.
`protected double`	`convertTimeToRate(double time)` Calculate rate based on phase going from 0.0 to 1.0 in time.
`void`	`flattenOutputs()` Flatten output ports so we don't output a changing signal when stopped.
`void`	`generate()` Generate a full block.
`abstract void`	`generate(int start, int limit)` Perform essential synthesis function.
`Circuit`	`getCircuit()`
`double`	`getFramePeriod()`
`int`	`getFrameRate()`
`int`	`getId()`
`UnitPort`	`getPortByName(java.lang.String portName)` Case-insensitive search for a port by name.
`java.util.Collection<UnitPort>`	`getPorts()`
`SynthesisEngine`	`getSynthesisEngine()`
`Synthesizer`	`getSynthesizer()`
`UnitGenerator`	`getTopUnit()`
`UnitGenerator`	`getUnitGenerator()` Needed by UnitSink
`protected double`	`incrementWrapPhase(double currentPhase, double phaseIncrement)`
`boolean`	`isEnabled()`
`boolean`	`isStartRequired()` Some units, for example LineOut and FixedRateMonoWriter, will only work if started explicitly.
`void`	`printConnections()`
`void`	`printConnections(java.io.PrintStream out)`
`void`	`printConnections(java.io.PrintStream out, int level)`
`void`	`pullData(long frameCount, int start, int limit)`
`void`	`setCircuit(Circuit circuit)`
`void`	`setEnabled(boolean enabled)` If enabled, then a unit will execute if its output is connected to another unit that is executed.
`void`	`setFrameRate(int rate)` Deprecated. ignored, frameRate comes from the SynthesisEngine
`void`	`setPort(java.lang.String portName, double value, TimeStamp timeStamp)` Needed by UnitVoice
`void`	`setSynthesisEngine(SynthesisEngine synthesisEngine)`
`void`	`start()` Start executing this unit directly by adding it to a "run list" of units in the synthesis engine.
`void`	`start(double time)` Start a unit at the specified time.
`void`	`start(TimeStamp timeStamp)` Start a unit at the specified time.
`void`	`stop()`
`void`	`stop(double time)` Stop a unit at the specified time.
`void`	`stop(TimeStamp timeStamp)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERY_SMALL_FLOAT
```
protected static final double VERY_SMALL_FLOAT
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_INPUT
```
public static final java.lang.String PORT_NAME_INPUT
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_OUTPUT
```
public static final java.lang.String PORT_NAME_OUTPUT
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_PHASE
```
public static final java.lang.String PORT_NAME_PHASE
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_FREQUENCY
```
public static final java.lang.String PORT_NAME_FREQUENCY
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_FREQUENCY_SCALER
```
public static final java.lang.String PORT_NAME_FREQUENCY_SCALER
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_AMPLITUDE
```
public static final java.lang.String PORT_NAME_AMPLITUDE
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_PAN
```
public static final java.lang.String PORT_NAME_PAN
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_TIME
```
public static final java.lang.String PORT_NAME_TIME
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_CUTOFF
```
public static final java.lang.String PORT_NAME_CUTOFF
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_PRESSURE
```
public static final java.lang.String PORT_NAME_PRESSURE
```
    See Also:
    
    Constant Field Values
  - PORT_NAME_TIMBRE
```
public static final java.lang.String PORT_NAME_TIMBRE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final double FALSE
```
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final double TRUE
```
    See Also:
    
    Constant Field Values
  - synthesisEngine
```
protected SynthesisEngine synthesisEngine
```
- Constructor Detail
  - UnitGenerator
```
public UnitGenerator()
```
- Method Detail
  - getId
```
public int getId()
```
  - getFrameRate
```
public int getFrameRate()
```
  - getFramePeriod
```
public double getFramePeriod()
```
  - addPort
```
public void addPort(UnitPort port)
```
  - addPort
```
public void addPort(UnitPort port,
                    java.lang.String name)
```
  - getPortByName
```
public UnitPort getPortByName(java.lang.String portName)
```
    Case-insensitive search for a port by name.
    
    Parameters:
    
    portName -
    
    Returns:
    
    matching port or null
  - getPorts
```
public java.util.Collection<UnitPort> getPorts()
```
  - generate
```
public abstract void generate(int start,
                              int limit)
```
    Perform essential synthesis function.
    
    Parameters:
    
    start - offset into port buffers
    
    limit - limit offset into port buffers for loop
  - generate
```
public void generate()
```
    Generate a full block.
  - getSynthesisEngine
```
public SynthesisEngine getSynthesisEngine()
```
    Returns:
    
    the synthesisEngine
  - getSynthesizer
```
public Synthesizer getSynthesizer()
```
    Returns:
    
    the Synthesizer
  - setSynthesisEngine
```
public void setSynthesisEngine(SynthesisEngine synthesisEngine)
```
    Parameters:
    
    synthesisEngine - the synthesisEngine to set
  - getTopUnit
```
public UnitGenerator getTopUnit()
```
  - autoStop
```
protected void autoStop()
```
  - convertHalfLifeToMultiplier
```
public double convertHalfLifeToMultiplier(double halfLife)
```
    Calculate signal based on halflife of an exponential decay.
  - incrementWrapPhase
```
protected double incrementWrapPhase(double currentPhase,
                                    double phaseIncrement)
```
  - convertTimeToRate
```
protected double convertTimeToRate(double time)
```
    Calculate rate based on phase going from 0.0 to 1.0 in time.
  - flattenOutputs
```
public void flattenOutputs()
```
    Flatten output ports so we don't output a changing signal when stopped.
  - setCircuit
```
public void setCircuit(Circuit circuit)
```
  - getCircuit
```
public Circuit getCircuit()
```
  - pullData
```
public void pullData(long frameCount,
                     int start,
                     int limit)
```
  - isEnabled
```
public boolean isEnabled()
```
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    If enabled, then a unit will execute if its output is connected to another unit that is executed. If not enabled then it will not execute and will not pull data from units that are connected to its inputs. Disabling a unit at the output of a tree of units can be used to turn off the entire tree, thus saving CPU cycles.
    
    Parameters:
    
    enabled -
    
    See Also:
    
    UnitGate.setupAutoDisable(UnitGenerator), start
  - isStartRequired
```
public boolean isStartRequired()
```
    Some units, for example LineOut and FixedRateMonoWriter, will only work if started explicitly. Other units will run when downstream units are started.
    
    Returns:
    
    true if you should call start() for this unit
  - start
```
public void start()
```
    Start executing this unit directly by adding it to a "run list" of units in the synthesis engine. This method is normally only called for the final unit in a chain, for example a LineOut. When that final unit executes it will "pull" data from any units connected to its inputs. Those units will then pull data their inputs until the entire chain is executed. If units are connected in a circle then this will be detected and the infinite recursion will be blocked.
    
    See Also:
    
    setEnabled
  - start
```
public void start(double time)
```
    Start a unit at the specified time.
    
    Parameters:
    
    time -
    
    See Also:
    
    start
  - start
```
public void start(TimeStamp timeStamp)
```
    Start a unit at the specified time.
    
    Parameters:
    
    timeStamp -
    
    See Also:
    
    start
  - stop
```
public void stop(double time)
```
    Stop a unit at the specified time.
    
    Parameters:
    
    time -
    
    See Also:
    
    start
  - stop
```
public void stop()
```
  - stop
```
public void stop(TimeStamp timeStamp)
```
  - setFrameRate
```
@Deprecated
public void setFrameRate(int rate)
```
    Deprecated. ignored, frameRate comes from the SynthesisEngine
    
    Parameters:
    
    rate -
  - getUnitGenerator
```
public UnitGenerator getUnitGenerator()
```
    Needed by UnitSink
  - setPort
```
public void setPort(java.lang.String portName,
                    double value,
                    TimeStamp timeStamp)
```
    Needed by UnitVoice
  - printConnections
```
public void printConnections()
```
  - printConnections
```
public void printConnections(java.io.PrintStream out)
```
  - printConnections
```
public void printConnections(java.io.PrintStream out,
                             int level)
```

Class UnitGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERY_SMALL_FLOAT

PORT_NAME_INPUT

PORT_NAME_OUTPUT

PORT_NAME_PHASE

PORT_NAME_FREQUENCY

PORT_NAME_FREQUENCY_SCALER

PORT_NAME_AMPLITUDE

PORT_NAME_PAN

PORT_NAME_TIME

PORT_NAME_CUTOFF

PORT_NAME_PRESSURE

PORT_NAME_TIMBRE

FALSE

TRUE

synthesisEngine

Constructor Detail

UnitGenerator

Method Detail

getId

getFrameRate

getFramePeriod

addPort

addPort

getPortByName

getPorts

generate

generate

getSynthesisEngine

getSynthesizer

setSynthesisEngine

getTopUnit

autoStop

convertHalfLifeToMultiplier

incrementWrapPhase

convertTimeToRate

flattenOutputs

setCircuit

getCircuit

pullData

isEnabled

setEnabled

isStartRequired

start

start

start

stop

stop

stop

setFrameRate

getUnitGenerator

setPort

printConnections

printConnections

printConnections