SynthesisEngine

java.lang.Object
- com.jsyn.engine.SynthesisEngine

All Implemented Interfaces:

Synthesizer
```
public class SynthesisEngine
extends java.lang.Object
implements Synthesizer
```
Internal implementation of JSyn Synthesizer. The public API is in the Synthesizer interface. This class might be used directly internally.

Author:

Phil Burk (C) 2009 Mobileer Inc

See Also:

Synthesizer

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`DB90` A fraction that is approximately -90.3 dB.
`static double`	`DB96` A fraction corresponding to exactly -96 dB.
`static int`	`DEFAULT_FRAME_RATE`

Fields inherited from interface com.jsyn.Synthesizer
FRAMES_PER_BLOCK

Constructor Summary

Constructors
Constructor and Description

SynthesisEngine()

SynthesisEngine(AudioDeviceManager audioDeviceManager)

Constructors
Constructor and Description
`SynthesisEngine()`
`SynthesisEngine(AudioDeviceManager audioDeviceManager)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(UnitGenerator ugen)` Add a unit generator to the synthesizer so it can be played.
`void`	`addAudioTask(java.lang.Runnable blockTask)` Add a task that will get run on the Audio Thread before it generates a new block of Audio.
`void`	`autoStopUnit(UnitGenerator unitGenerator)`
`void`	`clearCommandQueue()` Clear all scheduled commands from the queue.
`static short`	`convertDoubleToShort(double d)` Convert a double value in the range -1.0 to almost 1.0 to a short.
`static double`	`convertShortToDouble(short sdata)` Convert a short value to a double in the range -1.0 to almost 1.0.
`double`	`convertTimeToExponentialScaler(double duration)`
`TimeStamp`	`createTimeStamp()` Create a TimeStamp using the current audio time.
`void`	`generateNextBuffer()`
`AudioDeviceManager`	`getAudioDeviceManager()` An AudioDeviceManager is an interface to audio hardware.
`double`	`getCurrentTime()`
`long`	`getFrameCount()` This count is not reset if you stop and restart.
`double`	`getFramePeriod()`
`int`	`getFrameRate()`
`double[]`	`getInputBuffer(int i)`
`double`	`getInputLatency()`
`double`	`getInverseNyquist()`
`double[]`	`getOutputBuffer(int i)`
`double`	`getOutputLatency()`
`double`	`getUsage()`
`java.lang.String`	`getVersion()`
`int`	`getVersionCode()`
`boolean`	`isPullDataEnabled()`
`boolean`	`isRealTime()` Is JSyn running in real-time mode?
`boolean`	`isRunning()`
`void`	`printConnections()`
`void`	`queueCommand(ScheduledCommand command)` Queue a command to be processed as soon as possible in the background audio thread.
`void`	`remove(UnitGenerator ugen)` Removes a unit generator added using add().
`void`	`removeAudioTask(java.lang.Runnable blockTask)`
`void`	`scheduleCommand(double time, ScheduledCommand command)` Queue a command to be processed at a specific time in the background audio thread.
`void`	`scheduleCommand(TimeStamp timeStamp, ScheduledCommand command)` Queue a command to be processed at a specific time in the background audio thread.
`void`	`setPullDataEnabled(boolean pullDataEnabled)` If set true then audio data will be pulled from the output ports of connected unit generators.
`void`	`setRealTime(boolean realTime)` If set true then the synthesizer will generate audio in real-time.
`void`	`sleepFor(double duration)` Sleep for the specified audio time duration.
`void`	`sleepUntil(double time)` Sleep until the specified audio time is reached.
`void`	`start()` Starts a background thread that generates audio using the default frame rate of 44100 and two stereo output channels.
`void`	`start(int frameRate)` Starts a background thread that generates audio using the specified frame rate and two stereo output channels.
`void`	`start(int frameRate, int inputDeviceID, int numInputChannels, int outputDeviceID, int numOutputChannels)` Starts the synthesizer using specific audio devices.
`void`	`startUnit(UnitGenerator unit)` The startUnit and stopUnit methods are mainly for internal use.
`void`	`startUnit(UnitGenerator unit, double time)` Start a unit generator at the specified time.
`void`	`startUnit(UnitGenerator unit, TimeStamp timeStamp)`
`void`	`stop()` Stops the background thread that generates the audio.
`void`	`stopUnit(UnitGenerator unit)` The startUnit and stopUnit methods are mainly for internal use.
`void`	`stopUnit(UnitGenerator unit, double time)`
`void`	`stopUnit(UnitGenerator unit, TimeStamp timeStamp)`
`void`	`terminate()`
`java.lang.String`	`toString()`

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

- Field Detail
  - DEFAULT_FRAME_RATE
```
public static final int DEFAULT_FRAME_RATE
```
    See Also:
    
    Constant Field Values
  - DB96
```
public static final double DB96
```
    A fraction corresponding to exactly -96 dB.
    
    See Also:
    
    Constant Field Values
  - DB90
```
public static final double DB90
```
    A fraction that is approximately -90.3 dB. Defined as 1 bit of an S16.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SynthesisEngine
```
public SynthesisEngine(AudioDeviceManager audioDeviceManager)
```
  - SynthesisEngine
```
public SynthesisEngine()
```
- Method Detail
  - getVersion
```
public java.lang.String getVersion()
```
    Specified by:
    
    getVersion in interface Synthesizer
    
    Returns:
    
    JSyn version as a string
  - getVersionCode
```
public int getVersionCode()
```
    Specified by:
    
    getVersionCode in interface Synthesizer
    
    Returns:
    
    version as an integer that always increases
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isPullDataEnabled
```
public boolean isPullDataEnabled()
```
  - setPullDataEnabled
```
public void setPullDataEnabled(boolean pullDataEnabled)
```
    If set true then audio data will be pulled from the output ports of connected unit generators. The final unit in a tree of units needs to be start()ed.
    
    Parameters:
    
    pullDataEnabled -
  - terminate
```
public void terminate()
```
  - start
```
public void start()
```
    Description copied from interface: Synthesizer
    
    Starts a background thread that generates audio using the default frame rate of 44100 and two stereo output channels.
    
    Specified by:
    
    start in interface Synthesizer
  - start
```
public void start(int frameRate)
```
    Description copied from interface: Synthesizer
    
    Starts a background thread that generates audio using the specified frame rate and two stereo output channels.
    
    Specified by:
    
    start in interface Synthesizer
    
    Parameters:
    
    frameRate - in Hertz
  - start
```
public void start(int frameRate,
                  int inputDeviceID,
                  int numInputChannels,
                  int outputDeviceID,
                  int numOutputChannels)
```
    Description copied from interface: Synthesizer
    
    Starts the synthesizer using specific audio devices.
    
    Specified by:
    
    start in interface Synthesizer
    
    Parameters:
    
    frameRate - in Hertz
    
    inputDeviceID - obtained from an AudioDeviceManager or pass AudioDeviceManager.USE_DEFAULT_DEVICE
    
    numInputChannels - 1 for mono, 2 for stereo, etcetera
    
    outputDeviceID - obtained from an AudioDeviceManager or pass AudioDeviceManager.USE_DEFAULT_DEVICE
    
    numOutputChannels - 1 for mono, 2 for stereo, etcetera
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface Synthesizer
    
    Returns:
    
    true if the Synthesizer has been started
  - stop
```
public void stop()
```
    Description copied from interface: Synthesizer
    
    Stops the background thread that generates the audio.
    
    Specified by:
    
    stop in interface Synthesizer
  - generateNextBuffer
```
public void generateNextBuffer()
```
  - getCurrentTime
```
public double getCurrentTime()
```
    Specified by:
    
    getCurrentTime in interface Synthesizer
    
    Returns:
    
    the current audio time in seconds
  - createTimeStamp
```
public TimeStamp createTimeStamp()
```
    Description copied from interface: Synthesizer
    
    Create a TimeStamp using the current audio time.
    
    Specified by:
    
    createTimeStamp in interface Synthesizer
  - scheduleCommand
```
public void scheduleCommand(TimeStamp timeStamp,
                            ScheduledCommand command)
```
    Description copied from interface: Synthesizer
    
    Queue a command to be processed at a specific time in the background audio thread.
    
    Specified by:
    
    scheduleCommand in interface Synthesizer
  - scheduleCommand
```
public void scheduleCommand(double time,
                            ScheduledCommand command)
```
    Description copied from interface: Synthesizer
    
    Queue a command to be processed at a specific time in the background audio thread.
    
    Specified by:
    
    scheduleCommand in interface Synthesizer
  - queueCommand
```
public void queueCommand(ScheduledCommand command)
```
    Description copied from interface: Synthesizer
    
    Queue a command to be processed as soon as possible in the background audio thread.
    
    Specified by:
    
    queueCommand in interface Synthesizer
  - clearCommandQueue
```
public void clearCommandQueue()
```
    Description copied from interface: Synthesizer
    
    Clear all scheduled commands from the queue. Commands will be discarded.
    
    Specified by:
    
    clearCommandQueue in interface Synthesizer
  - getInputBuffer
```
public double[] getInputBuffer(int i)
```
  - getOutputBuffer
```
public double[] getOutputBuffer(int i)
```
  - autoStopUnit
```
public void autoStopUnit(UnitGenerator unitGenerator)
```
  - startUnit
```
public void startUnit(UnitGenerator unit,
                      double time)
```
    Description copied from interface: Synthesizer
    
    Start a unit generator at the specified time. This is not needed if a unit generator's output is connected to other units. Typically you only need to start units that have no outputs, for example LineOut.
    
    Specified by:
    
    startUnit in interface Synthesizer
  - stopUnit
```
public void stopUnit(UnitGenerator unit,
                     double time)
```
    Specified by:
    
    stopUnit in interface Synthesizer
  - startUnit
```
public void startUnit(UnitGenerator unit,
                      TimeStamp timeStamp)
```
    Specified by:
    
    startUnit in interface Synthesizer
  - stopUnit
```
public void stopUnit(UnitGenerator unit,
                     TimeStamp timeStamp)
```
    Specified by:
    
    stopUnit in interface Synthesizer
  - startUnit
```
public void startUnit(UnitGenerator unit)
```
    Description copied from interface: Synthesizer
    
    The startUnit and stopUnit methods are mainly for internal use. Please call unit.start() or unit.stop() instead.
    
    Specified by:
    
    startUnit in interface Synthesizer
  - stopUnit
```
public void stopUnit(UnitGenerator unit)
```
    Description copied from interface: Synthesizer
    
    The startUnit and stopUnit methods are mainly for internal use. Please call unit.start() or unit.stop() instead.
    
    Specified by:
    
    stopUnit in interface Synthesizer
  - getInverseNyquist
```
public double getInverseNyquist()
```
  - convertTimeToExponentialScaler
```
public double convertTimeToExponentialScaler(double duration)
```
  - getFrameCount
```
public long getFrameCount()
```
    Description copied from interface: Synthesizer
    
    This count is not reset if you stop and restart.
    
    Specified by:
    
    getFrameCount in interface Synthesizer
    
    Returns:
    
    number of frames synthesized
  - getFrameRate
```
public int getFrameRate()
```
    Specified by:
    
    getFrameRate in interface Synthesizer
    
    Returns:
    
    the frameRate
  - getFramePeriod
```
public double getFramePeriod()
```
    Specified by:
    
    getFramePeriod in interface Synthesizer
    
    Returns:
    
    the inverse of the frameRate for efficiency
  - convertShortToDouble
```
public static double convertShortToDouble(short sdata)
```
    Convert a short value to a double in the range -1.0 to almost 1.0.
  - convertDoubleToShort
```
public static short convertDoubleToShort(double d)
```
    Convert a double value in the range -1.0 to almost 1.0 to a short. Double value is clipped before converting.
  - addAudioTask
```
public void addAudioTask(java.lang.Runnable blockTask)
```
    Description copied from interface: Synthesizer
    
    Add a task that will get run on the Audio Thread before it generates a new block of Audio. This task must be very quick and should not perform any blocking operations. If you are not certain that you need an Audio rate task then don't use this.
    
    Specified by:
    
    addAudioTask in interface Synthesizer
  - removeAudioTask
```
public void removeAudioTask(java.lang.Runnable blockTask)
```
    Specified by:
    
    removeAudioTask in interface Synthesizer
  - getUsage
```
public double getUsage()
```
    Specified by:
    
    getUsage in interface Synthesizer
    
    Returns:
    
    the current CPU usage as a fraction between 0.0 and 1.0
  - getAudioDeviceManager
```
public AudioDeviceManager getAudioDeviceManager()
```
    Description copied from interface: Synthesizer
    
    An AudioDeviceManager is an interface to audio hardware. It might be implemented using JavaSound or a wrapper around PortAudio.
    
    Specified by:
    
    getAudioDeviceManager in interface Synthesizer
    
    Returns:
    
    audio device manager being used by the synthesizer.
  - setRealTime
```
public void setRealTime(boolean realTime)
```
    Description copied from interface: Synthesizer
    
    If set true then the synthesizer will generate audio in real-time. Set it true for live audio. If false then JSyn will run in non-real-time mode. This can be used to generate audio to be written to a file. The default is true.
    
    Specified by:
    
    setRealTime in interface Synthesizer
  - isRealTime
```
public boolean isRealTime()
```
    Description copied from interface: Synthesizer
    
    Is JSyn running in real-time mode?
    
    Specified by:
    
    isRealTime in interface Synthesizer
  - getOutputLatency
```
public double getOutputLatency()
```
  - getInputLatency
```
public double getInputLatency()
```
  - add
```
public void add(UnitGenerator ugen)
```
    Description copied from interface: Synthesizer
    
    Add a unit generator to the synthesizer so it can be played. This is required before starting or connecting a unit generator into a network.
    
    Specified by:
    
    add in interface Synthesizer
    
    Parameters:
    
    ugen - a unit generator to be executed by the synthesizer
  - remove
```
public void remove(UnitGenerator ugen)
```
    Description copied from interface: Synthesizer
    
    Removes a unit generator added using add().
    
    Specified by:
    
    remove in interface Synthesizer
  - sleepUntil
```
public void sleepUntil(double time)
                throws java.lang.InterruptedException
```
    Description copied from interface: Synthesizer
    
    Sleep until the specified audio time is reached. In non-real-time mode, this will enable the synthesizer to run.
    
    Specified by:
    
    sleepUntil in interface Synthesizer
    
    Throws:
    
    java.lang.InterruptedException
  - sleepFor
```
public void sleepFor(double duration)
              throws java.lang.InterruptedException
```
    Description copied from interface: Synthesizer
    
    Sleep for the specified audio time duration. In non-real-time mode, this will enable the synthesizer to run.
    
    Specified by:
    
    sleepFor in interface Synthesizer
    
    Throws:
    
    java.lang.InterruptedException
  - printConnections
```
public void printConnections()
```

Class SynthesisEngine

Field Summary

Fields inherited from interface com.jsyn.Synthesizer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FRAME_RATE

DB96

DB90

Constructor Detail

SynthesisEngine

SynthesisEngine

Method Detail

getVersion

getVersionCode

toString

isPullDataEnabled

setPullDataEnabled

terminate

start

start

start

isRunning

stop

generateNextBuffer

getCurrentTime

createTimeStamp

scheduleCommand

scheduleCommand

queueCommand

clearCommandQueue

getInputBuffer

getOutputBuffer

autoStopUnit

startUnit

stopUnit

startUnit

stopUnit

startUnit

stopUnit

getInverseNyquist

convertTimeToExponentialScaler

getFrameCount

getFrameRate

getFramePeriod

convertShortToDouble

convertDoubleToShort

addAudioTask

removeAudioTask

getUsage

getAudioDeviceManager

setRealTime

isRealTime

getOutputLatency

getInputLatency

add

remove

sleepUntil

sleepFor

printConnections