linuxsampler/lscp/AudioOutputChannel.java

/*
 *   jlscp - a java LinuxSampler control protocol API
 *
 *   Copyright (C) 2005 Grigor Kirilov Iliev
 *
 *   This file is part of jlscp.
 *
 *   jlscp 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.
 *
 *   jlscp 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 jlscp; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.linuxsampler.lscp;

import java.util.Vector;


/**
 * This class provides detailed information about an audio output chanel.
 * @author  Grigor Iliev
 */
public class AudioOutputChannel {
        private Parameter<String> name;
        private Parameter<Boolean> mixChannel;
        private Parameter<Integer> mcDst;
        
        private final Vector<Parameter> prmList = new Vector<Parameter>();
        
        
        /** Creates a new instance of AudioOutputChannel */
        public
        AudioOutputChannel() {
        }
        
        /**
         * Gets the name of this audio output channel.
         * @return The name of this audio output channel.
         */
        public String
        getName() { return name == null ? null : name.getValue(); }
        
        /**
         * Gets the <code>NAME</code> parameter.
         * @return A <code>Parameter<String></code> instance.
         */
        public Parameter<String>
        getNameParameter() { return name; }
        
        /**
         * Sets the <code>NAME</code> parameter.
         * @param name A <code>Parameter<String></code> instance.
         */
        public void
        setNameParameter(Parameter<String> name) { this.name = name; }
        
        /**
         * Determines whether this channel is a mix-channel.
         * @return <code>true</code> if this is a mix-channel, <code>false</code> otherwise.
         */
        public boolean
        isMixChannel() { return mixChannel == null ? false : mixChannel.getValue(); }
        
        /**
         * Gets the <code>IS_MIX_CHANNEL</code> parameter.
         * @return A <code>Parameter<Integer></code> instance.
         */
        public Parameter<Boolean>
        getMixChannelParameter() { return mixChannel; }
        
        /**
         * Sets whether this channel is a mix-channel.
         * @param mixChannel Specifies whether this channel is a mix-channel or not.
         */
        public void
        setMixChannelParameter(Parameter<Boolean> mixChannel) {
                this.mixChannel = mixChannel;
        }
        
        /**
         * Gets the number of the real audio channel this mix channel refers to.
         * @return The number of the real audio channel this mix channel refers to.
         */
        public int
        getMixChannelDest() { return mcDst == null ? -1 : mcDst.getValue(); }
        
        /**
         * Gets the <code>MIX_CHANNEL_DESTINATION</code> parameter.
         * @return The <code>MIX_CHANNEL_DESTINATION</code> parameter.
         */
        public Parameter<Integer>
        getMixChannelDestParameter() { return mcDst; }
        
        /**
         * Sets the <code>MIX_CHANNEL_DESTINATION</code> parameter.
         * @param mcDst The new <code>MIX_CHANNEL_DESTINATION</code> parameter.
         */
        public void
        setMixChannelDestParameter(Parameter<Integer> mcDst) { this.mcDst = mcDst; }
        
        /**
         * Adds additional parameter to this audio output channel.
         * @param prm The additional parameter to be added.
         */
        public void
        addParameter(Parameter prm) { prmList.add(prm); }
        
        /**
         * Gets a <code>Parameter</code> array with the additional parameters
         * of this audio output channel.
         * @return A <code>Parameter</code> array with the additional parameters
         * of this audio output channel.
         */
        public Parameter[]
        getAdditionalParameters() {
                return prmList.toArray(new Parameter[prmList.size()]);
        }
        
        /**
         * Gets a <code>Parameter</code> array providing all parameters
         * of this audio output channel (including <code>NAME</code>,
         * <code>IS_MIX_CHANNEL</code>, <code>MIX_CHANNEL_DESTINATION</code> parameters).
         * @return A <code>Parameter</code> array providing all parameters
         * of this audio output channel.
         */
        public Parameter[]
        getAllParameters() {
                Parameter[] params;
                
                if(getMixChannelDestParameter() != null) {
                        params = new Parameter[prmList.size() + 3];
                        params[2] = getMixChannelDestParameter();
                        for(int i = 0; i < prmList.size(); i++) params[i + 3] = prmList.get(i);
                } else {
                        params = new Parameter[prmList.size() + 2];
                        for(int i = 0; i < prmList.size(); i++) params[i + 2] = prmList.get(i);
                }
                
                params[0] = getNameParameter();
                params[1] = getMixChannelParameter();
                
                return params;
        }
        
        /**
         * Determines whether this audio output channel has additional parameters.
         * @return <code>true</code> if this audio output channel has additional parameters,
         *  <code>false</code> otherwise. 
         */
        public boolean
        hasAdditionalParameters() { return prmList.size() > 0; }
        
        /**
         * Returns the name of this audio output chanel.
         * @return The name of this audio output chanel.
         */
        public String
        toString() { return getName(); }
}
1	/*
2	* jlscp - a java LinuxSampler control protocol API
3	*
4	* Copyright (C) 2005 Grigor Kirilov Iliev
5	*
6	* This file is part of jlscp.
7	*
8	* jlscp 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	* jlscp 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 jlscp; 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.linuxsampler.lscp;
24
25	import java.util.Vector;
26
27
28	/**
29	* This class provides detailed information about an audio output chanel.
30	* @author Grigor Iliev
31	*/
32	public class AudioOutputChannel {
33	private Parameter<String> name;
34	private Parameter<Boolean> mixChannel;
35	private Parameter<Integer> mcDst;
36
37	private final Vector<Parameter> prmList = new Vector<Parameter>();
38
39
40	/** Creates a new instance of AudioOutputChannel */
41	public
42	AudioOutputChannel() {
43	}
44
45	/**
46	* Gets the name of this audio output channel.
47	* @return The name of this audio output channel.
48	*/
49	public String
50	getName() { return name == null ? null : name.getValue(); }
51
52	/**
53	* Gets the <code>NAME</code> parameter.
54	* @return A <code>Parameter<String></code> instance.
55	*/
56	public Parameter<String>
57	getNameParameter() { return name; }
58
59	/**
60	* Sets the <code>NAME</code> parameter.
61	* @param name A <code>Parameter<String></code> instance.
62	*/
63	public void
64	setNameParameter(Parameter<String> name) { this.name = name; }
65
66	/**
67	* Determines whether this channel is a mix-channel.
68	* @return <code>true</code> if this is a mix-channel, <code>false</code> otherwise.
69	*/
70	public boolean
71	isMixChannel() { return mixChannel == null ? false : mixChannel.getValue(); }
72
73	/**
74	* Gets the <code>IS_MIX_CHANNEL</code> parameter.
75	* @return A <code>Parameter<Integer></code> instance.
76	*/
77	public Parameter<Boolean>
78	getMixChannelParameter() { return mixChannel; }
79
80	/**
81	* Sets whether this channel is a mix-channel.
82	* @param mixChannel Specifies whether this channel is a mix-channel or not.
83	*/
84	public void
85	setMixChannelParameter(Parameter<Boolean> mixChannel) {
86	this.mixChannel = mixChannel;
87	}
88
89	/**
90	* Gets the number of the real audio channel this mix channel refers to.
91	* @return The number of the real audio channel this mix channel refers to.
92	*/
93	public int
94	getMixChannelDest() { return mcDst == null ? -1 : mcDst.getValue(); }
95
96	/**
97	* Gets the <code>MIX_CHANNEL_DESTINATION</code> parameter.
98	* @return The <code>MIX_CHANNEL_DESTINATION</code> parameter.
99	*/
100	public Parameter<Integer>
101	getMixChannelDestParameter() { return mcDst; }
102
103	/**
104	* Sets the <code>MIX_CHANNEL_DESTINATION</code> parameter.
105	* @param mcDst The new <code>MIX_CHANNEL_DESTINATION</code> parameter.
106	*/
107	public void
108	setMixChannelDestParameter(Parameter<Integer> mcDst) { this.mcDst = mcDst; }
109
110	/**
111	* Adds additional parameter to this audio output channel.
112	* @param prm The additional parameter to be added.
113	*/
114	public void
115	addParameter(Parameter prm) { prmList.add(prm); }
116
117	/**
118	* Gets a <code>Parameter</code> array with the additional parameters
119	* of this audio output channel.
120	* @return A <code>Parameter</code> array with the additional parameters
121	* of this audio output channel.
122	*/
123	public Parameter[]
124	getAdditionalParameters() {
125	return prmList.toArray(new Parameter[prmList.size()]);
126	}
127
128	/**
129	* Gets a <code>Parameter</code> array providing all parameters
130	* of this audio output channel (including <code>NAME</code>,
131	* <code>IS_MIX_CHANNEL</code>, <code>MIX_CHANNEL_DESTINATION</code> parameters).
132	* @return A <code>Parameter</code> array providing all parameters
133	* of this audio output channel.
134	*/
135	public Parameter[]
136	getAllParameters() {
137	Parameter[] params;
138
139	if(getMixChannelDestParameter() != null) {
140	params = new Parameter[prmList.size() + 3];
141	params[2] = getMixChannelDestParameter();
142	for(int i = 0; i < prmList.size(); i++) params[i + 3] = prmList.get(i);
143	} else {
144	params = new Parameter[prmList.size() + 2];
145	for(int i = 0; i < prmList.size(); i++) params[i + 2] = prmList.get(i);
146	}
147
148	params[0] = getNameParameter();
149	params[1] = getMixChannelParameter();
150
151	return params;
152	}
153
154	/**
155	* Determines whether this audio output channel has additional parameters.
156	* @return <code>true</code> if this audio output channel has additional parameters,
157	* <code>false</code> otherwise.
158	*/
159	public boolean
160	hasAdditionalParameters() { return prmList.size() > 0; }
161
162	/**
163	* Returns the name of this audio output chanel.
164	* @return The name of this audio output chanel.
165	*/
166	public String
167	toString() { return getName(); }
168	}