org/jsampler/SamplerModel.java

/*
 *   JSampler - a java front-end for LinuxSampler
 *
 *   Copyright (C) 2005-2011 Grigor Iliev <grigor@grigoriliev.com>
 *
 *   This file is part of JSampler.
 *
 *   JSampler is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License version 2
 *   as published by the Free Software Foundation.
 *
 *   JSampler 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 JSampler; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.jsampler;

import org.jsampler.event.ListListener;
import org.jsampler.event.MidiDeviceListListener;
import org.jsampler.event.SamplerChannelListListener;
import org.jsampler.event.SamplerListener;

import org.linuxsampler.lscp.*;


/**
 * A data model representing a sampler.
 * Note that the setter methods does <b>not</b> alter any settings
 * on the backend side unless otherwise specified.
 * @author Grigor Iliev
 */
public interface SamplerModel {
        /**
         * Registers the specified listener for receiving event messages.
         * @param l The <code>SamplerListener</code> to register.
         */
        public void addSamplerListener(SamplerListener l);
        
        /**
         * Removes the specified listener.
         * @param l The <code>SamplerListener</code> to remove.
         */
        public void removeSamplerListener(SamplerListener l);
        
        /**
         * Registers the specified listener for receiving event messages.
         * @param listener The <code>ListListener</code> to register.
         */
        public void addAudioDeviceListListener(ListListener<AudioDeviceModel> listener);
        
        /**
         * Removes the specified listener.
         * @param listener The <code>ListListener</code> to remove.
         */
        public void removeAudioDeviceListListener(ListListener<AudioDeviceModel> listener);
        
        /**
         * Registers the specified listener for receiving event messages.
         * @param listener The <code>MidiDeviceListListener</code> to register.
         */
        public void addMidiDeviceListListener(MidiDeviceListListener listener);
        
        /**
         * Removes the specified listener.
         * @param listener The <code>MidiDeviceListListener</code> to remove.
         */
        public void removeMidiDeviceListListener(MidiDeviceListListener listener);
        
        /**
         * Registers the specified listener for receiving event messages.
         * @param listener The <code>ListListener</code> to register.
         */
        public void addMidiInstrumentMapListListener(ListListener<MidiInstrumentMap> listener);
        
        /**
         * Removes the specified listener.
         * @param listener The <code>ListListener</code> to remove.
         */
        public void removeMidiInstrumentMapListListener(ListListener<MidiInstrumentMap> listener);
        
        /**
         * Registers the specified listener for receiving event messages.
         * @param listener The <code>SamplerChannelListListener</code> to register.
         */
        public void addSamplerChannelListListener(SamplerChannelListListener listener);
        
        /**
         * Removes the specified listener.
         * @param listener The <code>SamplerChannelListListener</code> to remove.
         */
        public void removeSamplerChannelListListener(SamplerChannelListListener listener);
        
        /**
         * Gets information about the LinuxSampler instance the front-end is connected to.
         * 
         * @return <code>ServerInfo</code> instance containing
         * information about the LinuxSampler instance the front-end is connected to.
         */
        public ServerInfo getServerInfo();
        
        /**
         * Gets all audio output drivers currently available for the LinuxSampler instance.
         * 
         * @return <code>AudioOutputDriver</code> array containing all audio output drivers
         * currently available for the LinuxSampler instance.
         */
        public AudioOutputDriver[] getAudioOutputDrivers();
        
        
        /**
         * Gets the model of the audio device at the specified position.
         * @param index The position of the audio device to return.
         * @return The model of the audio device at the specified position.
         * @see #getAudioDeviceCount
         */
        public AudioDeviceModel getAudioDevice(int index);
        
        /**
         * Gets the model of the audio device with ID <code>deviceId</code>.
         * @param deviceId The ID of the audio device whose model should be obtained.
         * @return The model of the specified audio device or <code>null</code> 
         * if there is no audio device with ID <code>deviceId</code>.
         */
        public AudioDeviceModel getAudioDeviceById(int deviceId);
        
        /**
         * Gets the index of the audio device with ID <code>deviceId</code>.
         * @param deviceId The ID of the audio device whose
         * position in the audio device list should be obtained.
         * @return The zero-based position of the specified audio device
         * in the audio device list or <code>-1</code> 
         * if there is no audio device with ID <code>deviceId</code>.
         */
        public int getAudioDeviceIndex(int deviceId);
        
        /**
         * Gets the current number of audio devices.
         * @return The current number of audio devices.
         */
        public int getAudioDeviceCount();
        
        /**
         * Gets the current list of audio device models.
         * @return The current list of audio device models.
         */
        public AudioDeviceModel[] getAudioDevices();
        
        /**
         * Adds the specified audio device.
         * @param device The audio device to be added.
         */
        public void addAudioDevice(AudioOutputDevice device);
        
        /**
         * Removes the specified audio device.
         * @param deviceId The ID of the audio device to be removed.
         * @return <code>true</code> if the audio device is removed successfully, <code>false</code>
         * if the device list does not contain audio device with ID <code>deviceId</code>.
         */
        public boolean removeAudioDeviceById(int deviceId);
        
        /**
         * Removes (on the backend side) the specified audio device.
         * @param deviceId The ID of the audio device to be removed.
         */
        public void removeBackendAudioDevice(int deviceId);
        
        /**
         * Gets all MIDI input drivers currently available for the LinuxSampler instance.
         * 
         * @return <code>MidiInputDriver</code> array containing all MIDI input drivers currently 
         * available for the LinuxSampler instance.
         */
        public MidiInputDriver[] getMidiInputDrivers();
        
        /**
         * Gets the model of the MIDI device at the specified position.
         * @param index The position of the MIDI device to return.
         * @return The model of the MIDI device at the specified position.
         */
        public MidiDeviceModel getMidiDevice(int index);
        
        /**
         * Gets the model of the MIDI device with ID <code>deviceId</code>.
         * @param deviceId The ID of the MIDI device whose model should be obtained.
         * @return The model of the specified MIDI device or <code>null</code> 
         * if there is no MIDI device with ID <code>deviceId</code>.
         */
        public MidiDeviceModel getMidiDeviceById(int deviceId);
        
        /**
         * Gets the current number of MIDI input devices.
         * @return The current number of MIDI input devices.
         */
        public int getMidiDeviceCount();
        
        /**
         * Gets the current list of MIDI device models.
         * @return The current list of MIDI device models.
         */
        public MidiDeviceModel[] getMidiDevices();
        
        /**
         * Adds the specified MIDI device.
         * @param device The MIDI device to be added.
         */
        public void addMidiDevice(MidiInputDevice device);
        
        /**
         * Schedules a new task for adding new MIDI device.
         * @param driver The desired MIDI input system.
         * @param parameters An optional list of driver specific parameters.
         */
        public void addBackendMidiDevice(String driver, Parameter... parameters);
        
        /**
         * Removes the specified MIDI device.
         * @param deviceId The ID of the MIDI device to be removed.
         * @return <code>true</code> if the MIDI device is removed successfully, <code>false</code>
         * if the device list does not contain MIDI device with ID <code>deviceId</code>.
         */
        public boolean removeMidiDeviceById(int deviceId);
        
        /**
         * Schedules a new task for removing the specified MIDI device.
         * @param deviceId The ID of the MIDI input device to be destroyed.
         */
        public void removeBackendMidiDevice(int deviceId);
        
        /**
         * Gets the MIDI instrument map with ID <code>mapId</code>.
         * @param mapId The ID of the MIDI instrument map to obtain.
         * @return The MIDI instrument map with the specified ID or <code>null</code> 
         * if there is no MIDI instrument map with ID <code>mapId</code>.
         */
        public MidiInstrumentMap getMidiInstrumentMapById(int mapId);
        
        /**
         * Gets the MIDI instrument map at the specified position.
         * @param index The position of the MIDI instrument map to return.
         * @return The MIDI instrument map at the specified position.
         */
        public MidiInstrumentMap getMidiInstrumentMap(int index);
        
        /**
         * Gets the current number of MIDI instrument maps.
         * @return The current number of MIDI instrument maps.
         */
        public int getMidiInstrumentMapCount();
        
        /**
         * Gets the current list of MIDI instrument maps.
         * @return The current list of MIDI instrument maps.
         */
        public MidiInstrumentMap[] getMidiInstrumentMaps();
        
        /**
         * Gets the position of the specified MIDI instrument map in the list.
         * @param map The map whose index should be returned.
         * @return The position of the specified map in the list,
         * or -1 if <code>map</code> is <code>null</code> or
         * the map list does not contain the specified map.
         */
        public int getMidiInstrumentMapIndex(MidiInstrumentMap map);
        
        /**
         * Adds the specified MIDI instrument map.
         * @param map The MIDI instrument map to be added.
         */
        public void addMidiInstrumentMap(MidiInstrumentMap map);
        
        /**
         * Schedules a new task for creating a new MIDI instrument map on the backend side.
         * @param name The name of the MIDI instrument map.
         * @throws IllegalArgumentException If <code>name</code> is <code>null</code>.
         */
        public void addBackendMidiInstrumentMap(String name);
        
        /**
         * Removes the specified MIDI instrument map.
         * @param mapId The ID of the MIDI instrument map to be removed.
         * @return <code>true</code> if the MIDI instrument map is removed successfully,
         * <code>false</code> if the MIDI instrument map's list does not contain
         * MIDI instrument map with ID <code>mapId</code>.
         */
        public boolean removeMidiInstrumentMapById(int mapId);
        
        /** Removes all MIDI instrument maps. */
        public void removeAllMidiInstrumentMaps();
        
        /**
         * Schedules a new task for removing the
         * specified MIDI instrument map on the backend side.
         * @param mapId The numerical ID of the MIDI instrument map to remove.
         * @throws IllegalArgumentException If <code>mapId</code> is negative.
         */
        public void removeBackendMidiInstrumentMap(int mapId);
        
        /**
         * Schedules a new task for changing the name of
         * the specified MIDI instrument map on the backend side.
         * @param mapId The numerical ID of the MIDI instrument map.
         * @param name The new name for the specified MIDI instrument map.
         */
        public void setBackendMidiInstrumentMapName(int mapId, String name);
        
        /**
         * Gets the default MIDI instrument map.
         * @return The default MIDI instrument map or <code>null</code>
         * if there are no maps created.
         */
        public MidiInstrumentMap getDefaultMidiInstrumentMap();
        
        /**
         * Schedules a new task for mapping a MIDI instrument on the backend side.
         * @param mapId The id of the MIDI instrument map.
         * @param bank The index of the MIDI bank, which shall contain the instrument.
         * @param program The MIDI program number of the new instrument.
         * @param instrInfo Provides the MIDI instrument settings.
         */
        public void
        mapBackendMidiInstrument(int mapId, int bank, int program, MidiInstrumentInfo instrInfo);
        
        /**
         * Schedules a new task for removing a MIDI instrument on the backend side.
         * @param mapId The id of the MIDI instrument map containing the instrument to be removed.
         * @param bank The index of the MIDI bank containing the instrument to be removed.
         * @param program The MIDI program number of the instrument to be removed.
         */
        public void unmapBackendMidiInstrument(int mapId, int bank, int program);
        
        /**
         * Gets a list of all available engines.
         * @return A list of all available engines.
         */
        public SamplerEngine[] getEngines();
        
        /**
         * Gets the current list of sampler channel models.
         * @return The current list of sampler channel models.
         */
        public SamplerChannelModel[] getChannels();
        
        /**
         * Gets the model of the sampler channel in the specified position.
         * @param index The position of the channel to return.
         * @return The model of the specified sampler channel.
         * @see #getchannelCount
         */
        public SamplerChannelModel getChannel(int index);
        
        /**
         * Gets the model of the sampler channel with ID <code>channelId</code>.
         * @param channelId The ID of the sampler channel whose model should be obtained.
         * @return The model of the specified sampler channel or <code>null</code> 
         * if there is no channel with ID <code>channelId</code>.
         */
        public SamplerChannelModel getChannelById(int channelId);
        
        /**
         * Gets the position of the specified channel.
         * @param channel The model of the channel.
         * @return The position of the specified channel in the channel list or -1
         * if the channel is not in the list.
         */
        public int getChannelIndex(SamplerChannelModel channel);
        
        /**
         * Gets the current number of sampler channels.
         * @return The current number of sampler channels.
         */
        public int getChannelCount();
        
        /**
         * Adds a new sampler channel on the backend side. The channel will
         * be actually added to this model when the backend notifies for its creation.
         * @see #addChannel
         */
        public void addBackendChannel();
        
        /**
         * Adds the specified sampler channel.
         * @param channel The channel to be added.
         */
        public void addChannel(SamplerChannel channel);
        
        /**
         * Removes the specified sampler channel.
         * Note that this method doesn't remove the channel in the backend,
         * it is used to remove the channel from the model when those channel
         * is removed in the backend.
         * @param channelId The ID of the channel to be removed.
         * @return <code>true</code> if the channel is removed successfully, <code>false</code>
         * if the channel's list does not contain channel with ID <code>channelId</code>.
         */
        public boolean removeChannelById(int channelId);
        
        /**
         * Removes all sampler channels.
         * Note that this method doesn't remove the channel in the backend.
         */
        public void removeAllChannels();
        
        /**
         * Schedules a new task for removing the specified sampler channel on the backend side.
         * @param channelId The ID of the channel to be removed.
         */
        public void removeBackendChannel(int channelId);
        
        /**
         * Updates the settings of the specified channel.
         * @param channel A <code>SamplerChannel</code> instance containing the new settings
         * for the channel.
         */
        public void updateChannel(SamplerChannel channel);
        
        /**
         * Determines whether there are known upcoming changes to the 
         * channel list, which should be considered as part of a single action.
         */
        public boolean getChannelListIsAdjusting();
        
        /**
         * Sets whether the upcoming changes to the 
         * channel list should be considered part of a single action.
         */
        public void setChannelListIsAdjusting(boolean b);
        
        /**
         * Schedules a new task for starting an instrument editor for editing
         * the loaded instrument on the specified sampler channel.
         * @param channelId The sampler channel number.
         */
        public void editBackendInstrument(int channelId);
        
        /**
         * Determines whether there is at least one solo channel in the current list
         * of sampler channels.
         * @return <code>true</code> if there is at least one solo channel in the current list of 
         * sampler channels, <code>false</code> otherwise.
         */
        public boolean hasSoloChannel();
        
        /**
         * Gets the number of solo channels in the current list of sampler channels.
         * @return The number of solo channels in the current list of sampler channels.
         */
        public int getSoloChannelCount();
        
        /**
         * Gets the number of muted channels in the current list of sampler channels.
         * This number includes the channels muted because of the presence of a solo channel.
         * @return The number of muted channels in the current list of sampler channels.
         */
        public int getMutedChannelCount();
        
        /**
         * Gets the number of channels muted because of the presence of a solo channel.
         * @return The number of channels muted because of the presence of a solo channel.
         */
        public int getMutedBySoloChannelCount();
        
        /**
         * Gets the total number of active streams.
         * @return The total number of active streams.
         */
        public int getTotalStreamCount();
        
        /**
         * Gets the total number of active voices.
         * @return The total number of active voices.
         */
        public int getTotalVoiceCount();
        
        /**
         * Gets the maximum number of active voices.
         * @return The maximum number of active voices.
         */
        public int getTotalVoiceCountMax();
        
        /**
         * Gets the golobal volume of the sampler.
         * @return The golobal volume of the sampler.
         */
        public float getVolume();
        
        /**
         * Sets the global volume.
         * @param volume The new volume value.
         */
        public void setVolume(float volume);
        
        /**
         * Sets the global volume on the backend side.
         * @param volume The new volume value.
         */
        public void setBackendVolume(float volume);
        
        /** Gets the list of internal effects */
        public EffectList getEffects();
        
        public EffectInstance getEffectInstanceById(int instanceId);
        
        public void updateEffectInstance(EffectInstanceInfo instance);
        
        /**
         * Schedules a new task for resetting the sampler.
         */
        public void resetBackend();
        
        /**
         * Updates the current number of active disk streams in the sampler.
         * @param count The new number of active streams.
         */
        public void updateActiveStreamsInfo(int count);
        
        /**
         * Updates the current and the maximum number of active voices in the sampler.
         * @param count The new number of active voices.
         * @param countMax The maximum number of active voices.
         */
        public void updateActiveVoiceInfo(int count, int countMax);
        
        /**
         * Determines whether the sampler configuration is modified.
         */
        public boolean isModified();
        
        /**
         * Sets whether the sampler configuration is modified.
         */
        public void setModified(boolean b);
        
        /** Resets the model. */
        public void reset();
}
1	iliev	787	/*
2			* JSampler - a java front-end for LinuxSampler
3			*
4	iliev	2192	* Copyright (C) 2005-2011 Grigor Iliev <grigor@grigoriliev.com>
5	iliev	787	*
6			* This file is part of JSampler.
7			*
8			* JSampler is free software; you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License version 2
10			* as published by the Free Software Foundation.
11			*
12			* JSampler is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License
18			* along with JSampler; if not, write to the Free Software
19			* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
20			* MA 02111-1307 USA
21			*/
22
23			package org.jsampler;
24
25	iliev	1143	import org.jsampler.event.ListListener;
26	iliev	787	import org.jsampler.event.MidiDeviceListListener;
27			import org.jsampler.event.SamplerChannelListListener;
28			import org.jsampler.event.SamplerListener;
29
30			import org.linuxsampler.lscp.*;
31
32
33			/**
34	iliev	911	* A data model representing a sampler.
35	iliev	1143	* Note that the setter methods does <b>not</b> alter any settings
36			* on the backend side unless otherwise specified.
37	iliev	787	* @author Grigor Iliev
38			*/
39			public interface SamplerModel {
40			/**
41			* Registers the specified listener for receiving event messages.
42			* @param l The <code>SamplerListener</code> to register.
43			*/
44			public void addSamplerListener(SamplerListener l);
45
46			/**
47			* Removes the specified listener.
48			* @param l The <code>SamplerListener</code> to remove.
49			*/
50			public void removeSamplerListener(SamplerListener l);
51
52			/**
53			* Registers the specified listener for receiving event messages.
54	iliev	1143	* @param listener The <code>ListListener</code> to register.
55	iliev	787	*/
56	iliev	1143	public void addAudioDeviceListListener(ListListener<AudioDeviceModel> listener);
57	iliev	787
58			/**
59			* Removes the specified listener.
60	iliev	1143	* @param listener The <code>ListListener</code> to remove.
61	iliev	787	*/
62	iliev	1143	public void removeAudioDeviceListListener(ListListener<AudioDeviceModel> listener);
63	iliev	787
64			/**
65			* Registers the specified listener for receiving event messages.
66			* @param listener The <code>MidiDeviceListListener</code> to register.
67			*/
68			public void addMidiDeviceListListener(MidiDeviceListListener listener);
69
70			/**
71			* Removes the specified listener.
72			* @param listener The <code>MidiDeviceListListener</code> to remove.
73			*/
74			public void removeMidiDeviceListListener(MidiDeviceListListener listener);
75
76			/**
77			* Registers the specified listener for receiving event messages.
78	iliev	1143	* @param listener The <code>ListListener</code> to register.
79			*/
80			public void addMidiInstrumentMapListListener(ListListener<MidiInstrumentMap> listener);
81
82			/**
83			* Removes the specified listener.
84			* @param listener The <code>ListListener</code> to remove.
85			*/
86			public void removeMidiInstrumentMapListListener(ListListener<MidiInstrumentMap> listener);
87
88			/**
89			* Registers the specified listener for receiving event messages.
90	iliev	787	* @param listener The <code>SamplerChannelListListener</code> to register.
91			*/
92			public void addSamplerChannelListListener(SamplerChannelListListener listener);
93
94			/**
95			* Removes the specified listener.
96			* @param listener The <code>SamplerChannelListListener</code> to remove.
97			*/
98			public void removeSamplerChannelListListener(SamplerChannelListListener listener);
99
100			/**
101			* Gets information about the LinuxSampler instance the front-end is connected to.
102			*
103			* @return <code>ServerInfo</code> instance containing
104			* information about the LinuxSampler instance the front-end is connected to.
105			*/
106			public ServerInfo getServerInfo();
107
108			/**
109			* Gets all audio output drivers currently available for the LinuxSampler instance.
110			*
111			* @return <code>AudioOutputDriver</code> array containing all audio output drivers
112			* currently available for the LinuxSampler instance.
113			*/
114			public AudioOutputDriver[] getAudioOutputDrivers();
115
116	iliev	1467
117
118	iliev	787	/**
119	iliev	1467	* Gets the model of the audio device at the specified position.
120			* @param index The position of the audio device to return.
121			* @return The model of the audio device at the specified position.
122			* @see #getAudioDeviceCount
123			*/
124			public AudioDeviceModel getAudioDevice(int index);
125
126			/**
127	iliev	1143	* Gets the model of the audio device with ID <code>deviceId</code>.
128			* @param deviceId The ID of the audio device whose model should be obtained.
129	iliev	787	* @return The model of the specified audio device or <code>null</code>
130	iliev	1143	* if there is no audio device with ID <code>deviceId</code>.
131	iliev	787	*/
132	iliev	1204	public AudioDeviceModel getAudioDeviceById(int deviceId);
133	iliev	787
134			/**
135	iliev	2200	* Gets the index of the audio device with ID <code>deviceId</code>.
136			* @param deviceId The ID of the audio device whose
137			* position in the audio device list should be obtained.
138			* @return The zero-based position of the specified audio device
139			* in the audio device list or <code>-1</code>
140			* if there is no audio device with ID <code>deviceId</code>.
141			*/
142			public int getAudioDeviceIndex(int deviceId);
143
144			/**
145	iliev	787	* Gets the current number of audio devices.
146			* @return The current number of audio devices.
147			*/
148			public int getAudioDeviceCount();
149
150			/**
151			* Gets the current list of audio device models.
152			* @return The current list of audio device models.
153			*/
154	iliev	1204	public AudioDeviceModel[] getAudioDevices();
155	iliev	787
156			/**
157			* Adds the specified audio device.
158			* @param device The audio device to be added.
159			*/
160			public void addAudioDevice(AudioOutputDevice device);
161
162			/**
163			* Removes the specified audio device.
164	iliev	1143	* @param deviceId The ID of the audio device to be removed.
165	iliev	787	* @return <code>true</code> if the audio device is removed successfully, <code>false</code>
166	iliev	1143	* if the device list does not contain audio device with ID <code>deviceId</code>.
167	iliev	787	*/
168	iliev	1204	public boolean removeAudioDeviceById(int deviceId);
169	iliev	787
170			/**
171	iliev	1143	* Removes (on the backend side) the specified audio device.
172			* @param deviceId The ID of the audio device to be removed.
173			*/
174			public void removeBackendAudioDevice(int deviceId);
175
176			/**
177	iliev	787	* Gets all MIDI input drivers currently available for the LinuxSampler instance.
178			*
179			* @return <code>MidiInputDriver</code> array containing all MIDI input drivers currently
180			* available for the LinuxSampler instance.
181			*/
182			public MidiInputDriver[] getMidiInputDrivers();
183
184			/**
185	iliev	1467	* Gets the model of the MIDI device at the specified position.
186			* @param index The position of the MIDI device to return.
187			* @return The model of the MIDI device at the specified position.
188			*/
189			public MidiDeviceModel getMidiDevice(int index);
190
191			/**
192	iliev	1143	* Gets the model of the MIDI device with ID <code>deviceId</code>.
193			* @param deviceId The ID of the MIDI device whose model should be obtained.
194	iliev	787	* @return The model of the specified MIDI device or <code>null</code>
195	iliev	1143	* if there is no MIDI device with ID <code>deviceId</code>.
196	iliev	787	*/
197	iliev	1204	public MidiDeviceModel getMidiDeviceById(int deviceId);
198	iliev	787
199			/**
200			* Gets the current number of MIDI input devices.
201			* @return The current number of MIDI input devices.
202			*/
203			public int getMidiDeviceCount();
204
205			/**
206			* Gets the current list of MIDI device models.
207			* @return The current list of MIDI device models.
208			*/
209	iliev	1204	public MidiDeviceModel[] getMidiDevices();
210	iliev	787
211			/**
212			* Adds the specified MIDI device.
213			* @param device The MIDI device to be added.
214			*/
215			public void addMidiDevice(MidiInputDevice device);
216
217			/**
218	iliev	1143	* Schedules a new task for adding new MIDI device.
219			* @param driver The desired MIDI input system.
220			* @param parameters An optional list of driver specific parameters.
221			*/
222			public void addBackendMidiDevice(String driver, Parameter... parameters);
223
224			/**
225	iliev	787	* Removes the specified MIDI device.
226	iliev	1143	* @param deviceId The ID of the MIDI device to be removed.
227	iliev	787	* @return <code>true</code> if the MIDI device is removed successfully, <code>false</code>
228	iliev	1143	* if the device list does not contain MIDI device with ID <code>deviceId</code>.
229	iliev	787	*/
230	iliev	1204	public boolean removeMidiDeviceById(int deviceId);
231	iliev	787
232			/**
233	iliev	1143	* Schedules a new task for removing the specified MIDI device.
234			* @param deviceId The ID of the MIDI input device to be destroyed.
235			*/
236			public void removeBackendMidiDevice(int deviceId);
237
238			/**
239			* Gets the MIDI instrument map with ID <code>mapId</code>.
240			* @param mapId The ID of the MIDI instrument map to obtain.
241			* @return The MIDI instrument map with the specified ID or <code>null</code>
242			* if there is no MIDI instrument map with ID <code>mapId</code>.
243			*/
244			public MidiInstrumentMap getMidiInstrumentMapById(int mapId);
245
246			/**
247			* Gets the MIDI instrument map at the specified position.
248			* @param index The position of the MIDI instrument map to return.
249			* @return The MIDI instrument map at the specified position.
250			*/
251			public MidiInstrumentMap getMidiInstrumentMap(int index);
252
253			/**
254			* Gets the current number of MIDI instrument maps.
255			* @return The current number of MIDI instrument maps.
256			*/
257			public int getMidiInstrumentMapCount();
258
259			/**
260			* Gets the current list of MIDI instrument maps.
261			* @return The current list of MIDI instrument maps.
262			*/
263			public MidiInstrumentMap[] getMidiInstrumentMaps();
264
265			/**
266	iliev	1285	* Gets the position of the specified MIDI instrument map in the list.
267			* @param map The map whose index should be returned.
268			* @return The position of the specified map in the list,
269			* or -1 if <code>map</code> is <code>null</code> or
270			* the map list does not contain the specified map.
271			*/
272			public int getMidiInstrumentMapIndex(MidiInstrumentMap map);
273
274			/**
275	iliev	1143	* Adds the specified MIDI instrument map.
276			* @param map The MIDI instrument map to be added.
277			*/
278			public void addMidiInstrumentMap(MidiInstrumentMap map);
279
280			/**
281			* Schedules a new task for creating a new MIDI instrument map on the backend side.
282			* @param name The name of the MIDI instrument map.
283			* @throws IllegalArgumentException If <code>name</code> is <code>null</code>.
284			*/
285			public void addBackendMidiInstrumentMap(String name);
286
287			/**
288			* Removes the specified MIDI instrument map.
289			* @param mapId The ID of the MIDI instrument map to be removed.
290			* @return <code>true</code> if the MIDI instrument map is removed successfully,
291			* <code>false</code> if the MIDI instrument map's list does not contain
292			* MIDI instrument map with ID <code>mapId</code>.
293			*/
294	iliev	1204	public boolean removeMidiInstrumentMapById(int mapId);
295	iliev	1143
296			/** Removes all MIDI instrument maps. */
297			public void removeAllMidiInstrumentMaps();
298
299			/**
300			* Schedules a new task for removing the
301			* specified MIDI instrument map on the backend side.
302			* @param mapId The numerical ID of the MIDI instrument map to remove.
303			* @throws IllegalArgumentException If <code>mapId</code> is negative.
304			*/
305			public void removeBackendMidiInstrumentMap(int mapId);
306
307			/**
308			* Schedules a new task for changing the name of
309			* the specified MIDI instrument map on the backend side.
310			* @param mapId The numerical ID of the MIDI instrument map.
311			* @param name The new name for the specified MIDI instrument map.
312			*/
313			public void setBackendMidiInstrumentMapName(int mapId, String name);
314
315			/**
316			* Gets the default MIDI instrument map.
317			* @return The default MIDI instrument map or <code>null</code>
318			* if there are no maps created.
319			*/
320			public MidiInstrumentMap getDefaultMidiInstrumentMap();
321
322			/**
323			* Schedules a new task for mapping a MIDI instrument on the backend side.
324			* @param mapId The id of the MIDI instrument map.
325			* @param bank The index of the MIDI bank, which shall contain the instrument.
326			* @param program The MIDI program number of the new instrument.
327			* @param instrInfo Provides the MIDI instrument settings.
328			*/
329			public void
330			mapBackendMidiInstrument(int mapId, int bank, int program, MidiInstrumentInfo instrInfo);
331
332			/**
333			* Schedules a new task for removing a MIDI instrument on the backend side.
334			* @param mapId The id of the MIDI instrument map containing the instrument to be removed.
335			* @param bank The index of the MIDI bank containing the instrument to be removed.
336			* @param program The MIDI program number of the instrument to be removed.
337			*/
338			public void unmapBackendMidiInstrument(int mapId, int bank, int program);
339
340			/**
341	iliev	787	* Gets a list of all available engines.
342			* @return A list of all available engines.
343			*/
344			public SamplerEngine[] getEngines();
345
346			/**
347			* Gets the current list of sampler channel models.
348			* @return The current list of sampler channel models.
349			*/
350	iliev	1204	public SamplerChannelModel[] getChannels();
351	iliev	787
352			/**
353	iliev	1467	* Gets the model of the sampler channel in the specified position.
354			* @param index The position of the channel to return.
355			* @return The model of the specified sampler channel.
356			* @see #getchannelCount
357			*/
358			public SamplerChannelModel getChannel(int index);
359
360			/**
361	iliev	1143	* Gets the model of the sampler channel with ID <code>channelId</code>.
362			* @param channelId The ID of the sampler channel whose model should be obtained.
363	iliev	787	* @return The model of the specified sampler channel or <code>null</code>
364	iliev	1143	* if there is no channel with ID <code>channelId</code>.
365	iliev	787	*/
366	iliev	1204	public SamplerChannelModel getChannelById(int channelId);
367	iliev	787
368			/**
369	iliev	1743	* Gets the position of the specified channel.
370			* @param channel The model of the channel.
371			* @return The position of the specified channel in the channel list or -1
372			* if the channel is not in the list.
373			*/
374			public int getChannelIndex(SamplerChannelModel channel);
375
376			/**
377	iliev	787	* Gets the current number of sampler channels.
378			* @return The current number of sampler channels.
379			*/
380			public int getChannelCount();
381
382			/**
383	iliev	1143	* Adds a new sampler channel on the backend side. The channel will
384			* be actually added to this model when the backend notifies for its creation.
385	iliev	787	* @see #addChannel
386			*/
387	iliev	1143	public void addBackendChannel();
388	iliev	787
389			/**
390			* Adds the specified sampler channel.
391			* @param channel The channel to be added.
392			*/
393			public void addChannel(SamplerChannel channel);
394
395			/**
396			* Removes the specified sampler channel.
397	iliev	911	* Note that this method doesn't remove the channel in the backend,
398			* it is used to remove the channel from the model when those channel
399			* is removed in the backend.
400	iliev	1143	* @param channelId The ID of the channel to be removed.
401	iliev	787	* @return <code>true</code> if the channel is removed successfully, <code>false</code>
402	iliev	1143	* if the channel's list does not contain channel with ID <code>channelId</code>.
403	iliev	787	*/
404	iliev	1204	public boolean removeChannelById(int channelId);
405	iliev	787
406			/**
407	iliev	1818	* Removes all sampler channels.
408			* Note that this method doesn't remove the channel in the backend.
409			*/
410			public void removeAllChannels();
411
412			/**
413	iliev	1143	* Schedules a new task for removing the specified sampler channel on the backend side.
414			* @param channelId The ID of the channel to be removed.
415			*/
416			public void removeBackendChannel(int channelId);
417
418			/**
419	iliev	787	* Updates the settings of the specified channel.
420			* @param channel A <code>SamplerChannel</code> instance containing the new settings
421			* for the channel.
422			*/
423	iliev	1143	public void updateChannel(SamplerChannel channel);
424	iliev	787
425			/**
426	iliev	1737	* Determines whether there are known upcoming changes to the
427			* channel list, which should be considered as part of a single action.
428			*/
429			public boolean getChannelListIsAdjusting();
430
431			/**
432			* Sets whether the upcoming changes to the
433			* channel list should be considered part of a single action.
434			*/
435			public void setChannelListIsAdjusting(boolean b);
436
437			/**
438	iliev	1341	* Schedules a new task for starting an instrument editor for editing
439			* the loaded instrument on the specified sampler channel.
440			* @param channelId The sampler channel number.
441			*/
442			public void editBackendInstrument(int channelId);
443
444			/**
445	iliev	787	* Determines whether there is at least one solo channel in the current list
446			* of sampler channels.
447			* @return <code>true</code> if there is at least one solo channel in the current list of
448			* sampler channels, <code>false</code> otherwise.
449			*/
450			public boolean hasSoloChannel();
451
452			/**
453			* Gets the number of solo channels in the current list of sampler channels.
454			* @return The number of solo channels in the current list of sampler channels.
455			*/
456			public int getSoloChannelCount();
457
458			/**
459			* Gets the number of muted channels in the current list of sampler channels.
460			* This number includes the channels muted because of the presence of a solo channel.
461			* @return The number of muted channels in the current list of sampler channels.
462			*/
463			public int getMutedChannelCount();
464
465			/**
466			* Gets the number of channels muted because of the presence of a solo channel.
467			* @return The number of channels muted because of the presence of a solo channel.
468			*/
469			public int getMutedBySoloChannelCount();
470
471			/**
472	iliev	1545	* Gets the total number of active streams.
473			* @return The total number of active streams.
474			*/
475			public int getTotalStreamCount();
476
477			/**
478	iliev	787	* Gets the total number of active voices.
479			* @return The total number of active voices.
480			*/
481			public int getTotalVoiceCount();
482
483			/**
484			* Gets the maximum number of active voices.
485			* @return The maximum number of active voices.
486			*/
487			public int getTotalVoiceCountMax();
488
489			/**
490	iliev	1143	* Gets the golobal volume of the sampler.
491			* @return The golobal volume of the sampler.
492			*/
493			public float getVolume();
494
495			/**
496			* Sets the global volume.
497			* @param volume The new volume value.
498			*/
499			public void setVolume(float volume);
500
501			/**
502			* Sets the global volume on the backend side.
503			* @param volume The new volume value.
504			*/
505			public void setBackendVolume(float volume);
506
507	iliev	2192	/** Gets the list of internal effects */
508			public EffectList getEffects();
509
510	iliev	2195	public EffectInstance getEffectInstanceById(int instanceId);
511
512			public void updateEffectInstance(EffectInstanceInfo instance);
513
514	iliev	1143	/**
515			* Schedules a new task for resetting the sampler.
516			*/
517			public void resetBackend();
518
519			/**
520	iliev	1545	* Updates the current number of active disk streams in the sampler.
521			* @param count The new number of active streams.
522			*/
523			public void updateActiveStreamsInfo(int count);
524
525			/**
526	iliev	787	* Updates the current and the maximum number of active voices in the sampler.
527			* @param count The new number of active voices.
528			* @param countMax The maximum number of active voices.
529			*/
530			public void updateActiveVoiceInfo(int count, int countMax);
531	iliev	1567
532			/**
533			* Determines whether the sampler configuration is modified.
534			*/
535			public boolean isModified();
536
537			/**
538			* Sets whether the sampler configuration is modified.
539			*/
540			public void setModified(boolean b);
541	iliev	1688
542			/** Resets the model. */
543			public void reset();
544	iliev	787	}