gnu.javax.sound.midi.dssi

Class DSSISynthesizer

Implemented Interfaces:
AutoCloseable, MidiDevice, Synthesizer

public class DSSISynthesizer
extends Object
implements Synthesizer

DSSI soft-synth support. All DSSI soft-synths are expected to be installed in /usr/lib/dssi.

Nested Class Summary

class
DSSISynthesizer.DSSIMidiChannel

Constructor Summary

DSSISynthesizer(Info info, String soname, long index)
Create a DSSI Synthesizer.

Method Summary

void
close()
Close this MIDI device, and release any system resources we're using.
Instrument[]
getAvailableInstruments()
Get an array containing all instruments in this synthesizer.
MidiChannel[]
getChannels()
Get the set of MIDI channels controlled by this synth.
Soundbank
getDefaultSoundbank()
Get the default Soundbank for this synth.
Info
getDeviceInfo()
Get the Info object describing this device.
long
getLatency()
The processing latency for this synth in microseconds.
Instrument[]
getLoadedInstruments()
Get an array containing all instruments loaded in this synthesizer.
int
getMaxPolyphony()
Get the maximum number of notes that the synth can play at once.
int
getMaxReceivers()
The maximum number of MIDI IN connections we can get as Receivers, or -1 if there is no maximum.
int
getMaxTransmitters()
The maximum number of MIDI OUT connections we can get as Transmitters, or -1 if there is no maximum.
long
getMicrosecondPosition()
If this device supports time-stamps, then it will return the number of microseconds since this device has been open, and -1 otherwise.
Receiver
getReceiver()
Get a MIDI IN Receiver for this device.
Transmitter
getTransmitter()
Get a MIDI OUT Transmitter for this device.
VoiceStatus[]
getVoiceStatus()
Get the current status for the voices produced by this synth.
boolean
isOpen()
Returns true if this MIDI device is open and false otherwise.
boolean
isSoundbankSupported(Soundbank soundbank)
Returns true is this synth is capable of loading soundbank.
boolean
loadAllInstruments(Soundbank soundbank)
Load all soundbank instruments into this synthesizer.
boolean
loadInstrument(Instrument instrument)
Load an instrument into this synth.
boolean
loadInstruments(Soundbank soundbank, Patch[] patchList)
Load a subset of soundbank instruments into this synthesizer.
void
open()
Open this MIDI device and allocate any system resource we need.
boolean
remapInstrument(Instrument from, Instrument to)
Move an intrument from one place to another.
void
unloadAllInstruments(Soundbank soundbank)
Unload all soundbank instruments from this synthesizer.
void
unloadInstrument(Instrument instrument)
Unload an instrument from this synth.
void
unloadInstruments(Soundbank soundbank, Patch[] patchList)
Unload a subset of soundbank instruments from this synthesizer.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DSSISynthesizer

public DSSISynthesizer(Info info,
                       String soname,
                       long index)
Create a DSSI Synthesizer.
Parameters:
info - the DSSIInfo for this soft-synth
soname - the name of the .so file for this DSSI synth
index - the DSSI index for this soft-synth

Method Details

close

public void close()
Close this MIDI device, and release any system resources we're using.
Specified by:
close in interface MidiDevice
close in interface AutoCloseable

getAvailableInstruments

public Instrument[] getAvailableInstruments()
Get an array containing all instruments in this synthesizer.
Specified by:
getAvailableInstruments in interface Synthesizer
Returns:
an array containing all instruments in this synthesizer

getChannels

public MidiChannel[] getChannels()
Get the set of MIDI channels controlled by this synth.
Specified by:
getChannels in interface Synthesizer
Returns:
an array of MIDI channels controlled by this synth

getDefaultSoundbank

public Soundbank getDefaultSoundbank()
Get the default Soundbank for this synth. Return null if there is no default.
Specified by:
getDefaultSoundbank in interface Synthesizer
Returns:
the default Soundbank for this synth, possibly null.

getDeviceInfo

public Info getDeviceInfo()
Get the Info object describing this device.
Specified by:
getDeviceInfo in interface MidiDevice
Returns:
the Info object describing this device

getLatency

public long getLatency()
The processing latency for this synth in microseconds.
Specified by:
getLatency in interface Synthesizer
Returns:
the processing latency for this synth in microseconds

getLoadedInstruments

public Instrument[] getLoadedInstruments()
Get an array containing all instruments loaded in this synthesizer.
Specified by:
getLoadedInstruments in interface Synthesizer
Returns:
an array containing all instruments loaded in this synthesizer

getMaxPolyphony

public int getMaxPolyphony()
Get the maximum number of notes that the synth can play at once.
Specified by:
getMaxPolyphony in interface Synthesizer
Returns:
the maximum number of notes that the synth can play at once

getMaxReceivers

public int getMaxReceivers()
The maximum number of MIDI IN connections we can get as Receivers, or -1 if there is no maximum.
Specified by:
getMaxReceivers in interface MidiDevice
Returns:
-1 or the maximum number of Receivers we can get

getMaxTransmitters

public int getMaxTransmitters()
The maximum number of MIDI OUT connections we can get as Transmitters, or -1 if there is no maximum.
Specified by:
getMaxTransmitters in interface MidiDevice
Returns:
-1 or the maximum number of Transmitters we can get

getMicrosecondPosition

public long getMicrosecondPosition()
If this device supports time-stamps, then it will return the number of microseconds since this device has been open, and -1 otherwise.
Specified by:
getMicrosecondPosition in interface MidiDevice
Returns:
-1 or the number of microseconds since this was opened

getReceiver

public Receiver getReceiver()
            throws MidiUnavailableException
Get a MIDI IN Receiver for this device.
Specified by:
getReceiver in interface MidiDevice
Returns:
a MIDI IN Receiver for this device
Throws:
MidiUnavailableException - if we can't get a Receiver

getTransmitter

public Transmitter getTransmitter()
            throws MidiUnavailableException
Get a MIDI OUT Transmitter for this device.
Specified by:
getTransmitter in interface MidiDevice
Returns:
a MIDI OUT Transmitter for this device
Throws:
MidiUnavailableException - if we can't get a Transmitter

getVoiceStatus

public VoiceStatus[] getVoiceStatus()
Get the current status for the voices produced by this synth.
Specified by:
getVoiceStatus in interface Synthesizer
Returns:
an array of VoiceStatus objects, getMaxPolyphony() in length

isOpen

public boolean isOpen()
Returns true if this MIDI device is open and false otherwise.
Specified by:
isOpen in interface MidiDevice
Returns:
true if this is open, false otherwise

isSoundbankSupported

public boolean isSoundbankSupported(Soundbank soundbank)
Returns true is this synth is capable of loading soundbank.
Specified by:
isSoundbankSupported in interface Synthesizer
Parameters:
soundbank - the Soundbank to examine
Returns:
true if soundbank can be loaded, false otherwise

loadAllInstruments

public boolean loadAllInstruments(Soundbank soundbank)
Load all soundbank instruments into this synthesizer.
Specified by:
loadAllInstruments in interface Synthesizer
Parameters:
soundbank - the Soundbank from which to load instruments
Returns:
true if all instruments were loaded, false othewise
Throws:
IllegalArgumentException - if the soundbank isn't supported by this

loadInstrument

public boolean loadInstrument(Instrument instrument)
Load an instrument into this synth. The instrument must be part of a supported soundbank.
Specified by:
loadInstrument in interface Synthesizer
Parameters:
instrument - the Instrument to load
Returns:
true if the instrument was loaded and false otherwise
Throws:
IllegalArgumentException - if this synth doesn't support instrument

loadInstruments

public boolean loadInstruments(Soundbank soundbank,
                               Patch[] patchList)
Load a subset of soundbank instruments into this synthesizer. The subset is defined by an array of Patch objects.
Specified by:
loadInstruments in interface Synthesizer
Parameters:
soundbank - the Soundbank from which to load instruments
patchList - the array of patches identifying instruments to load
Returns:
true if instruments were loaded, false otherwise
Throws:
IllegalArgumentException - if the soundbank isn't supported by this

open

public void open()
            throws MidiUnavailableException
Open this MIDI device and allocate any system resource we need.
Specified by:
open in interface MidiDevice
Throws:
MidiUnavailableException - if we're not able to open for some reason

remapInstrument

public boolean remapInstrument(Instrument from,
                               Instrument to)
Move an intrument from one place to another. The instrument at the target location is unloaded.
Specified by:
remapInstrument in interface Synthesizer
Parameters:
from - the instrument source
to - the instrument target
Returns:
if from was remapped

unloadAllInstruments

public void unloadAllInstruments(Soundbank soundbank)
Unload all soundbank instruments from this synthesizer.
Specified by:
unloadAllInstruments in interface Synthesizer
Parameters:
soundbank - the Soundbank containing the instruments to unload
Throws:
IllegalArgumentException - if the soundbank isn't supported by this

unloadInstrument

public void unloadInstrument(Instrument instrument)
Unload an instrument from this synth.
Specified by:
unloadInstrument in interface Synthesizer
Parameters:
instrument - the Instrument to unload
Throws:
IllegalArgumentException - if this synth doesn't support instrument

unloadInstruments

public void unloadInstruments(Soundbank soundbank,
                              Patch[] patchList)
Unload a subset of soundbank instruments from this synthesizer.
Specified by:
unloadInstruments in interface Synthesizer
Parameters:
soundbank - the Soundbank containing the instruments to unload
patchList - the array of patches identifying instruments to unload
Throws:
IllegalArgumentException - if the soundbank isn't supported by this

DSSISynthesizer.java -- DSSI Synthesizer Provider Copyright (C) 2005, 2006, 2012 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.