linuxsampler/lscp/AbstractInstrument.java

/*
 *   jlscp - a java LinuxSampler control protocol API
 *
 *   Copyright (C) 2005-2007 Grigor Iliev <grigor@grigoriliev.com>
 *
 *   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 static org.linuxsampler.lscp.Parser.*;

/**
 *
 * @author Grigor Iliev
 */
public abstract class AbstractInstrument implements Instrument, Parseable {
        private String name = "Untitled";
        private String description = "";
        private String path = null;
        private int instrumentIndex = 0;
        private String formatFamily = "";
        private String formatVersion = "";
        private Integer[] keyMapping = { };
        private Integer[] keyswitchMapping = { };
        
        /**
         * Creates a new instance of <code>AbstractInstrument</code>.
         */
        public
        AbstractInstrument() { }
        
        /**
         * Creates a new instance of <code>AbstractInstrument</code>.
         * @param resultSet An array with information categories about an instrument.
         */
        public
        AbstractInstrument(String[] resultSet) throws LscpException {
                for(String s : resultSet)
                        if(!parse(s)) Client.getLogger().info(LscpI18n.getLogMsg("unknownLine", s));
        }
        
        /**
         * Gets the name of this instrument.
         * @return The name of this instrument.
         */
        public String
        getName() { return name; }
        
        /**
         * Sets the name of this instrument.
         * @param name The name of this instrument.
         */
        public void
        setName(String name) { this.name = name; }
        
        /**
         * Gets a brief description about this instrument.
         * @return A brief description about this instrument.
         */
        public String
        getDescription() { return description; }
        
        /**
         * Returns the absolute path name of the instrument file.
         * @return The absolute path name of the instrument file.
         */
        public String
        getFilePath() { return path; }
        
        /**
         * Sets the absolute path name of the instrument file.
         * @param path Specifies the absolute path name of the instrument file.
         */
        public void
        setFilePath(String path) { this.path = path; }
        
        /**
         * Returns the index of the instrument in the instrument file.
         * @return The index of the instrument in the instrument file.
         */
        public int
        getInstrumentIndex() { return instrumentIndex; }
        
        /**
         * Sets the index of the instrument in the instrument file.
         * @param idx The index of the instrument in the instrument file.
         */
        public void
        setInstrumentIndex(int idx) { instrumentIndex = idx; }
        
        /**
         * Returns the format family of the instrument.
         **/
        public String
        getFormatFamily() { return formatFamily; }
        
        /**
         * Returns the format version of the instrument.
         **/
        public String
        getFormatVersion() { return formatVersion; }
        
        public Integer[]
        getKeyMapping() { return keyMapping; }
        
        public Integer[]
        getKeyswitchMapping() { return keyswitchMapping; }
        
        /**
         * Parses a line of text.
         * @param s The string to be parsed.
         * @return <code>true</code> if the line has been processed, <code>false</code> otherwise.
         * @throws LscpException If some error occurs.
         */
        public boolean
        parse(String s) throws LscpException {
                if(s.startsWith("NAME: ")) {
                        setName(s.substring("NAME: ".length()));
                } else if(s.startsWith("DESCRIPTION: ")) {
                        description = s.substring("DESCRIPTION: ".length());
                        description = toNonEscapedString(description);
                } else if(s.startsWith("INSTRUMENT_FILE: ")) {
                        setFilePath(s.substring("INSTRUMENT_FILE: ".length()));
                } else if(s.startsWith("INSTRUMENT_NR: ")) {
                        s = s.substring("INSTRUMENT_NR: ".length());
                        setInstrumentIndex(Parser.parseInt(s));
                } else if(s.startsWith("FORMAT_FAMILY: ")) {
                        formatFamily = s.substring("FORMAT_FAMILY: ".length());
                } else if(s.startsWith("FORMAT_VERSION: ")) {
                        formatVersion = s.substring("FORMAT_VERSION: ".length());
                } else if(s.startsWith("KEY_BINDINGS: ")) {
                        s = s.substring("KEY_BINDINGS: ".length());
                        keyMapping = Parser.parseIntList(s);
                } else if(s.startsWith("KEYSWITCH_BINDINGS: ")) {
                        s = s.substring("KEYSWITCH_BINDINGS: ".length());
                        keyswitchMapping = Parser.parseIntList(s);
                } else return false;
                
                return true;
        }
}
1	iliev	1202	/*
2			* jlscp - a java LinuxSampler control protocol API
3			*
4			* Copyright (C) 2005-2007 Grigor Iliev <grigor@grigoriliev.com>
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	iliev	1346	import static org.linuxsampler.lscp.Parser.*;
26
27	iliev	1202	/**
28			*
29			* @author Grigor Iliev
30			*/
31	iliev	1539	public abstract class AbstractInstrument implements Instrument, Parseable {
32	iliev	1202	private String name = "Untitled";
33			private String description = "";
34			private String path = null;
35			private int instrumentIndex = 0;
36	iliev	1539	private String formatFamily = "";
37			private String formatVersion = "";
38	iliev	1775	private Integer[] keyMapping = { };
39			private Integer[] keyswitchMapping = { };
40	iliev	1202
41			/**
42			* Creates a new instance of <code>AbstractInstrument</code>.
43			*/
44	iliev	1539	public
45			AbstractInstrument() { }
46
47			/**
48			* Creates a new instance of <code>AbstractInstrument</code>.
49			* @param resultSet An array with information categories about an instrument.
50			*/
51			public
52			AbstractInstrument(String[] resultSet) throws LscpException {
53			for(String s : resultSet)
54			if(!parse(s)) Client.getLogger().info(LscpI18n.getLogMsg("unknownLine", s));
55	iliev	1202	}
56
57			/**
58			* Gets the name of this instrument.
59			* @return The name of this instrument.
60			*/
61			public String
62			getName() { return name; }
63
64			/**
65			* Sets the name of this instrument.
66			* @param name The name of this instrument.
67			*/
68			public void
69			setName(String name) { this.name = name; }
70
71			/**
72			* Gets a brief description about this instrument.
73			* @return A brief description about this instrument.
74			*/
75			public String
76			getDescription() { return description; }
77
78			/**
79			* Returns the absolute path name of the instrument file.
80			* @return The absolute path name of the instrument file.
81			*/
82			public String
83			getFilePath() { return path; }
84
85			/**
86			* Sets the absolute path name of the instrument file.
87			* @param path Specifies the absolute path name of the instrument file.
88			*/
89			public void
90			setFilePath(String path) { this.path = path; }
91
92			/**
93			* Returns the index of the instrument in the instrument file.
94			* @return The index of the instrument in the instrument file.
95			*/
96			public int
97			getInstrumentIndex() { return instrumentIndex; }
98
99			/**
100			* Sets the index of the instrument in the instrument file.
101			* @param idx The index of the instrument in the instrument file.
102			*/
103			public void
104			setInstrumentIndex(int idx) { instrumentIndex = idx; }
105
106			/**
107	iliev	1539	* Returns the format family of the instrument.
108			**/
109			public String
110			getFormatFamily() { return formatFamily; }
111
112			/**
113			* Returns the format version of the instrument.
114			**/
115			public String
116			getFormatVersion() { return formatVersion; }
117
118	iliev	1775	public Integer[]
119			getKeyMapping() { return keyMapping; }
120
121			public Integer[]
122			getKeyswitchMapping() { return keyswitchMapping; }
123
124	iliev	1539	/**
125	iliev	1202	* Parses a line of text.
126			* @param s The string to be parsed.
127			* @return <code>true</code> if the line has been processed, <code>false</code> otherwise.
128			* @throws LscpException If some error occurs.
129			*/
130			public boolean
131			parse(String s) throws LscpException {
132			if(s.startsWith("NAME: ")) {
133			setName(s.substring("NAME: ".length()));
134			} else if(s.startsWith("DESCRIPTION: ")) {
135			description = s.substring("DESCRIPTION: ".length());
136	iliev	1351	description = toNonEscapedString(description);
137	iliev	1202	} else if(s.startsWith("INSTRUMENT_FILE: ")) {
138			setFilePath(s.substring("INSTRUMENT_FILE: ".length()));
139			} else if(s.startsWith("INSTRUMENT_NR: ")) {
140			s = s.substring("INSTRUMENT_NR: ".length());
141			setInstrumentIndex(Parser.parseInt(s));
142	iliev	1539	} else if(s.startsWith("FORMAT_FAMILY: ")) {
143			formatFamily = s.substring("FORMAT_FAMILY: ".length());
144			} else if(s.startsWith("FORMAT_VERSION: ")) {
145			formatVersion = s.substring("FORMAT_VERSION: ".length());
146	iliev	1775	} else if(s.startsWith("KEY_BINDINGS: ")) {
147			s = s.substring("KEY_BINDINGS: ".length());
148			keyMapping = Parser.parseIntList(s);
149			} else if(s.startsWith("KEYSWITCH_BINDINGS: ")) {
150			s = s.substring("KEYSWITCH_BINDINGS: ".length());
151			keyswitchMapping = Parser.parseIntList(s);
152	iliev	1202	} else return false;
153
154			return true;
155			}
156			}