org.openimaj.audio.generation

Class Synthesizer

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.generation.Synthesizer

All Implemented Interfaces:

Iterable<SampleChunk>, Instrument

public class Synthesizer
extends AudioStream
implements Instrument

Really really basic synthesizer. Useful for doing tests by running the synth as an audio source through filters or whatever.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

2 May 2012

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Synthesizer.FMOptions Options class for FM synthesis.
static interface	Synthesizer.OscillatorOptions Interface for options.

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
Synthesizer()

Method Summary

Modifier and Type	Method and Description
void	addSynthesizerListener(SynthesizerListener sl) Add a synth listener to this synth.
void	applyADSREnvelope(SampleBuffer sb) Applies the ADSR gain envelope to the samples generated by the generator.
protected void	fireSynthQuiet() Fired when the synth finished the release phase.
long	getAttack() Get the ADSR attack time in milliseconds
long	getDecay() Get the ADSR decay time in milliseconds
char	getEnvelopePhase() Returns the phase of the ADSR envelope
long	getLength() Returns the length of the audio stream in milliseconds.
Oscillator	getOscillator() Returns the oscillator in use.
long	getRelease() Get the release time in milliseconds
float	getSustain() Get the ADSR sustain gain
boolean	isNoteOn() Returns whether the synth is playing a note or not.
SampleChunk	nextSampleChunk() Retrieve the next SampleChunk from the audio stream.
void	noteOff() Note off
void	noteOff(int noteNumber) Turn off the given note.
void	noteOn() Note on.
void	noteOn(int noteNumber, double velocity) Play a note on the instrument.
void	removeSynthesizerListener(SynthesizerListener sl) remove the synth listener from this synth.
void	reset() Reset the audio stream.
void	setAttack(long attack) Set the ADSR attack time in milliseconds
void	setDecay(long decay) Set the ADSR decay time in milliseconds
void	setFrequency(double f) Set the frequency at which the synth will generate tones.
void	setGain(int gain) Set the gain at which the synth will generate tones
void	setOscillatorType(Oscillator t) Set the type of oscillator used to generate tones.
void	setRelease(long release) Set the ADSR release time in milliseconds
void	setSustain(float sustain) Set the ADSR sustain gain

Methods inherited from class org.openimaj.audio.AudioStream

iterator, seek

Methods inherited from class org.openimaj.audio.Audio

getFormat, setFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Synthesizer

public Synthesizer()

Method Detail

nextSampleChunk

public SampleChunk nextSampleChunk()

Retrieve the next SampleChunk from the audio stream.

Specified by:

nextSampleChunk in class AudioStream

Returns:

The next sample chunk in the audio stream.

See Also:

AudioStream.nextSampleChunk()

setFrequency

public void setFrequency(double f)

Set the frequency at which the synth will generate tones.

Parameters:

f - The frequency

setGain

public void setGain(int gain)

Set the gain at which the synth will generate tones

Parameters:

gain - The gain

setOscillatorType

public void setOscillatorType(Oscillator t)

Set the type of oscillator used to generate tones.

Parameters:

t - The type of oscillator.

getOscillator

public Oscillator getOscillator()

Returns the oscillator in use.

Returns:

the oscillator instance.

reset

public void reset()

Reset the audio stream.

Specified by:

reset in class AudioStream

See Also:

AudioStream.reset()

getLength

public long getLength()

Returns the length of the audio stream in milliseconds. If the length is unknown (for a live stream for example), then this method should return -1.

Specified by:

getLength in class AudioStream

Returns:

The length in milliseconds, or -1

See Also:

AudioStream.getLength()

noteOn

public void noteOn()

Note on.

noteOff

public void noteOff()

Note off

isNoteOn

public boolean isNoteOn()

Returns whether the synth is playing a note or not.

Returns:

TRUE if the synth is currently playing a note.

applyADSREnvelope

public void applyADSREnvelope(SampleBuffer sb)

Applies the ADSR gain envelope to the samples generated by the generator.

Parameters:

sb - The sample buffer to affect

getEnvelopePhase

public char getEnvelopePhase()

Returns the phase of the ADSR envelope

Returns:

the envelope phase.

getAttack

public long getAttack()

Get the ADSR attack time in milliseconds

Returns:

the attack time in milliseconds

setAttack

public void setAttack(long attack)

Set the ADSR attack time in milliseconds

Parameters:

attack - the attack time in milliseconds

getDecay

public long getDecay()

Get the ADSR decay time in milliseconds

Returns:

the decay time in milliseconds

setDecay

public void setDecay(long decay)

Set the ADSR decay time in milliseconds

Parameters:

decay - the decay time in milliseconds

getSustain

public float getSustain()

Get the ADSR sustain gain

Returns:

the sustain gain

setSustain

public void setSustain(float sustain)

Set the ADSR sustain gain

Parameters:

sustain - the sustain gain

getRelease

public long getRelease()

Get the release time in milliseconds

Returns:

the release time in milliseconds

setRelease

public void setRelease(long release)

Set the ADSR release time in milliseconds

Parameters:

release - the release time in milliseconds

addSynthesizerListener

public void addSynthesizerListener(SynthesizerListener sl)

Add a synth listener to this synth.

Parameters:

sl - The synth listener

removeSynthesizerListener

public void removeSynthesizerListener(SynthesizerListener sl)

remove the synth listener from this synth.

Parameters:

sl - The synth listener to remove

fireSynthQuiet

protected void fireSynthQuiet()

Fired when the synth finished the release phase.

noteOn

public void noteOn(int noteNumber,
                   double velocity)

Play a note on the instrument.

Specified by:

noteOn in interface Instrument

Parameters:

noteNumber - The MIDI note number

velocity - The velocity (0-1)

See Also:

Instrument.noteOn(int, double)

noteOff

public void noteOff(int noteNumber)

Turn off the given note.

Specified by:

noteOff in interface Instrument

Parameters:

noteNumber - The note to turn off.

See Also:

Instrument.noteOff(int)