-
Notifications
You must be signed in to change notification settings - Fork 0
/
SynthPatchAbstract.java
319 lines (289 loc) · 9.23 KB
/
SynthPatchAbstract.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
/* Synth Patch Conversion
* Copyright (C) 2003-4, Kenneth L. Martinez (kmartin@users.sourceforge.net)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This library 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 Library General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
package PatchConversion;
/**
* Implements several common features required by SynthPatch interface
*
* @author Kenneth L. Martinez
*/
//import java.io.*;
import java.util.*;
public abstract class SynthPatchAbstract implements SynthPatch {
protected String manufacturerName;
protected String itemName;
protected String invalidMsg;
protected int programType; // 0=stored, 1=edit buffer
protected ArrayList sourceTags; // XML tags which make up the source patch
protected ArrayList sourceTagsEdit; // XML tags for edit buffer source patch
protected ArrayList pgmParms; // program parameters
protected ArrayList hdrParms; // global parameters (patch number, etc)
protected ArrayList hdrParmsEdit; // global parameters for edit buffer
protected GenericPatch genPatch;
protected ArrayList parmTranslators;
protected ArrayList parmLinks;
protected byte sysex[]; // program sysex data
protected byte initSysex[]; // init stored program sysex
protected byte initSysexEdit[]; // init edit buffer sysex
SynthPatchAbstract(String pManufacturerName, String pItemName, byte pInitSysex[],
byte pInitSysexEdit[], String pVersion) {
programType = 0;
sourceTags = new ArrayList();
sourceTagsEdit = new ArrayList();
pgmParms = new ArrayList();
hdrParms = new ArrayList();
hdrParmsEdit = new ArrayList();
genPatch = new GenericPatch(pVersion);
parmTranslators = new ArrayList();
parmLinks = new ArrayList();
manufacturerName = pManufacturerName;
itemName = pItemName;
initSysex = pInitSysex;
initSysexEdit = pInitSysexEdit;
}
/**
* see if all voice and global parameters have values within their valid ranges
* @return valid
*/
public boolean isValid() {
int i;
try {
if (programType == 0) {
for (i = 0; i < hdrParms.size(); i++) {
if (((SynthParm)hdrParms.get(i)).isValid() == false) {
invalidMsg = "parm " + ((SynthParm)hdrParms.get(i)).getName() + " was invalid";
return false;
}
}
} else {
for (i = 0; i < hdrParmsEdit.size(); i++) {
if (((SynthParm)hdrParmsEdit.get(i)).isValid() == false) {
invalidMsg = "parm " + ((SynthParm)hdrParmsEdit.get(i)).getName() + " was invalid";
return false;
}
}
}
for (i = 0; i < pgmParms.size(); i++) {
if (((SynthParm)pgmParms.get(i)).isValid() == false) {
invalidMsg = "parm " + ((SynthParm)pgmParms.get(i)).getName() + " was invalid";
return false;
}
}
} catch (NullPointerException e) {
invalidMsg = "error reading parm list";
return false;
}
return true;
}
/**
* see if all voice and global parameters have values within their defined ranges
* @return valid
*/
public boolean isDefined() {
int i;
try {
if (programType == 0) {
for (i = 0; i < hdrParms.size(); i++) {
if (((SynthParm)hdrParms.get(i)).isDefined() == false) {
invalidMsg = "parm " + ((SynthParm)hdrParms.get(i)).getName() + " was invalid";
return false;
}
}
} else {
for (i = 0; i < hdrParmsEdit.size(); i++) {
if (((SynthParm)hdrParmsEdit.get(i)).isDefined() == false) {
invalidMsg = "parm " + ((SynthParm)hdrParmsEdit.get(i)).getName() + " was invalid";
return false;
}
}
}
for (i = 0; i < pgmParms.size(); i++) {
if (((SynthParm)pgmParms.get(i)).isDefined() == false) {
invalidMsg = "parm " + ((SynthParm)pgmParms.get(i)).getName() + " was invalid";
return false;
}
}
} catch (NullPointerException e) {
invalidMsg = "error reading parm list";
return false;
}
return true;
}
public String getInvalidMsg() {
return invalidMsg;
}
public GenericPatch getGenPatch() {
return genPatch;
}
void addPgmParm(SynthParmAbstract spa, XMLTagGroup xtg) {
pgmParms.add(spa);
xtg.add(new XMLTagValue(spa.getName(), spa));
}
/**
* see if input XML contains this type of patch
*/
public String matchXMLTop(String xml) {
int i;
String tag[];
i = xml.indexOf("<synth_patch"); // skipping <?xml ... ?>
if (i == -1) {
return null;
}
XMLReader xr = new XMLReader(xml.substring(i));
tag = xr.getNextTag();
if (tag[0].equalsIgnoreCase("synth_patch") == false) {
return null;
}
xr = new XMLReader(tag[1]);
tag = xr.getNextTag();
if (tag == null || tag[0].equalsIgnoreCase("source_synth_manufacturer") == false ||
tag[1].equalsIgnoreCase(manufacturerName) == false) {
return null;
}
tag = xr.getNextTag();
if (tag == null || tag[0].equalsIgnoreCase("source_synth_name") == false ||
tag[1].equalsIgnoreCase(itemName) == false) {
return null;
}
tag = xr.getNextTag();
if (tag == null || tag[0].equalsIgnoreCase("source_patch") == false) {
return null;
}
return tag[1];
}
/**
* convert patch internal variables to XML
*/
public String toXML() throws PatchDefinitionException {
int i;
StringBuffer sb = new StringBuffer();
sb.append("<?xml version=\"1.0\" encoding=\"UTF-8\" ?>");
sb.append("<synth_patch version=\"0.1\">");
sb.append("<source_synth_manufacturer>" + manufacturerName + "</source_synth_manufacturer>");
sb.append("<source_synth_name>" + itemName + "</source_synth_name>");
if (programType == 0) {
for (i = 0; i < sourceTags.size(); i++) {
sb.append(((XMLTag)sourceTags.get(i)).writeXML());
}
} else {
for (i = 0; i < sourceTagsEdit.size(); i++) {
sb.append(((XMLTag)sourceTagsEdit.get(i)).writeXML());
}
}
if (isDefined()) {
translateToGeneric();
sb.append(genPatch.writeXML());
} else {
System.out.println("input parameter(s) undefined - cannot create generic patch");
}
sb.append("</synth_patch>");
return sb.toString();
}
/**
* read XML into internal variables
*/
public void fromXML(String xml) throws PatchDefinitionException {
xml = XMLReader.convertInputEscapedChars(xml);
if (matchXMLStored(xml) == true) {
// Using this to initialize any unmapped parms
fromSysex(initSysex);
programType = 0;
((XMLTag)sourceTags.get(0)).readXML(xml);
genPatch.readInfoXML(XMLReader.getTagValue(xml, "generic_patch"));
toSysex();
} else if (matchXMLEdit(xml) == true) {
// Using this to initialize any unmapped parms
fromSysex(initSysexEdit);
programType = 1;
((XMLTag)sourceTagsEdit.get(0)).readXML(xml);
genPatch.readInfoXML(XMLReader.getTagValue(xml, "generic_patch"));
toSysex();
} else if (xml.indexOf("generic_patch") != -1) {
System.out.println("input file does not contain a " + manufacturerName +
" " + itemName + ", converting from generic patch");
if (genPatch.readXML(xml)) {
adjustFromGeneric();
if (genPatch.convertXML()) {
translateFromGeneric();
toSysex();
}
}
} else {
System.out.println("input file does not contain a " + manufacturerName +
" " + itemName + " and has no generic patch");
}
}
void adjustFromGeneric() throws PatchDefinitionException {
// Each synth may need to make special adjustments to a generic patch
// to be able to convert it, e.g. may need to simulate an AR envelope
// with an ADSR by setting sustain to zero and decay=release
}
void translateFromGeneric() {
for (int i = 0; i < parmLinks.size(); i++) {
((ParmTranslator)parmLinks.get(i)).fromGeneric();
}
for (int i = 0; i < parmTranslators.size(); i++) {
((ParmTranslator)parmTranslators.get(i)).fromGeneric();
}
}
void translateToGeneric() throws PatchDefinitionException {
for (int i = 0; i < parmTranslators.size(); i++) {
((ParmTranslator)parmTranslators.get(i)).toGeneric();
}
for (int i = 0; i < parmLinks.size(); i++) {
((ParmTranslator)parmLinks.get(i)).toGeneric();
}
/*
* Start at Synth Audio Out, work backwards across connections
* to find all modules that are either in the audio chain or
* are active modulators of those modules
*/
ModuleJack mj = genPatch.findModuleInputJack("Audio Out", "Voice In");
genPatch.findJacksAndModulesUsed(mj);
}
/**
* @return sysex
*/
public byte[] getSysex() {
return sysex;
}
public SynthParm findPgmParm(String name) {
int i;
SynthParm sp;
// with few parms, a sequential search is fast enough
for (i = 0; i < pgmParms.size(); i++) {
sp = (SynthParm)pgmParms.get(i);
if (sp.getName().equalsIgnoreCase(name)) {
return sp;
}
}
return null;
}
public SynthParm findHdrParm(String name) {
int i;
SynthParm sp;
// with few parms, a sequential search is fast enough
for (i = 0; i < hdrParms.size(); i++) {
sp = (SynthParm)hdrParms.get(i);
if (sp.getName().equalsIgnoreCase(name)) {
return sp;
}
}
return null;
}
}