com.jsyn.util

Class VoiceAllocator

java.lang.Object

com.jsyn.util.VoiceAllocator

All Implemented Interfaces:

Instrument

public class VoiceAllocator
extends java.lang.Object
implements Instrument

Allocate voices based on an integer tag. The tag could, for example, be a MIDI note number. Or a tag could be an int that always increments. Use the same tag to refer to a voice for noteOn() and noteOff(). If no new voices are available then a voice in use will be stolen.

Author:

Phil Burk (C) 2011 Mobileer Inc

Constructor Summary

Constructors

Constructor and Description
VoiceAllocator(UnitVoice[] voices) Create an allocator for the array of UnitVoices.

Method Summary

Modifier and Type	Method and Description
void	allNotesOff(TimeStamp timeStamp) Turn off all the note currently on.
protected UnitVoice	allocate(int tag) Allocate a Voice associated with this tag.
Synthesizer	getSynthesizer()
int	getVoiceCount()
protected boolean	isOn(int tag)
void	noteOff(int tag, TimeStamp timeStamp) Turn off the voice associated with the given tag if allocated.
void	noteOn(int tag, double frequency, double amplitude, TimeStamp timeStamp) Play a note on the voice and associate it with the given tag.
void	noteOn(int tag, double frequency, double amplitude, VoiceOperation operation, TimeStamp timeStamp) Play a note on the voice and associate it with the given tag.
protected UnitVoice	off(int tag)
void	setPort(int tag, java.lang.String portName, double value, TimeStamp timeStamp) Set a port on the voice associated with the given tag if allocated.
void	usePreset(int presetIndex, TimeStamp timeStamp)

Methods inherited from class java.lang.Object

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

Constructor Detail

VoiceAllocator

public VoiceAllocator(UnitVoice[] voices)

Create an allocator for the array of UnitVoices. The array must be full of instantiated UnitVoices that are connected to some kind of mixer.

Parameters:

voices -

Method Detail

getSynthesizer

public Synthesizer getSynthesizer()

getVoiceCount

public int getVoiceCount()

Returns:

number of UnitVoices passed to the allocator.

allocate

protected UnitVoice allocate(int tag)

Allocate a Voice associated with this tag. It will first pick a voice already assigned to that tag. Next it will pick the oldest voice that is off. Next it will pick the oldest voice that is on. If you are using timestamps to play the voice in the future then you should use the noteOn() noteOff() and setPort() methods.

Parameters:

tag -

Returns:

Voice that is most available.

isOn

protected boolean isOn(int tag)

off

protected UnitVoice off(int tag)

allNotesOff

public void allNotesOff(TimeStamp timeStamp)

Turn off all the note currently on.

Specified by:

allNotesOff in interface Instrument

noteOn

public void noteOn(int tag,
                   double frequency,
                   double amplitude,
                   TimeStamp timeStamp)

Play a note on the voice and associate it with the given tag. if needed a new voice will be allocated and an old voice may be turned off.

Specified by:

noteOn in interface Instrument

noteOn

public void noteOn(int tag,
                   double frequency,
                   double amplitude,
                   VoiceOperation operation,
                   TimeStamp timeStamp)

Play a note on the voice and associate it with the given tag. if needed a new voice will be allocated and an old voice may be turned off. Apply an operation to the voice.

noteOff

public void noteOff(int tag,
                    TimeStamp timeStamp)

Turn off the voice associated with the given tag if allocated.

Specified by:

noteOff in interface Instrument

setPort

public void setPort(int tag,
                    java.lang.String portName,
                    double value,
                    TimeStamp timeStamp)

Set a port on the voice associated with the given tag if allocated.

Specified by:

setPort in interface Instrument

usePreset

public void usePreset(int presetIndex,
                      TimeStamp timeStamp)

Specified by:

usePreset in interface Instrument