Skip to content

Commit

Permalink
Merge pull request #2 from urish/master
Browse files Browse the repository at this point in the history 
I have implemented the missing JVstPersistence.loadBank()
  • Loading branch information
@mhroth
mhroth committed May 18, 2012
2 parents 38d7b74 + 1744e86 commit 83dd5e7
Show file tree
Hide file tree
Showing 2 changed files with 150 additions and 62 deletions.
Binary file modified JVstHost.jar
View file
Binary file not shown.
212 changes: 150 additions & 62 deletions src/com/synthbot/audioplugin/vst/vst2/JVstPersistence.java
View file
Expand Up @@ -42,9 +42,15 @@ public class JVstPersistence {
private static final String OPAQUE_PRESET_MAGIC = "FPCh";
private static final String REGULAR_BANK_MAGIC = "FxBk";
private static final String OPAQUE_BANK_MAGIC = "FBCh";

/**
* In some VSTPlugins the version number inside the preset/bank files is buggy. Set this
* to true to skip the version number checks when loading a preset/bank file.
*/
public static boolean ignorePluginVersion = false;

/**
* Loads a program preset frm file to the current program of the plugin.
* Loads a program preset from file to the current program of the plugin.
* @param vst The plugin to load the data into.
* @param file The file to read which contains the program data.
* @throws DataFormatException Thrown if there is a problem loading the data in the file to the plugin.
Expand All @@ -68,83 +74,165 @@ public static void loadPreset(JVstHost2 vst, File file) throws DataFormatExcepti

DataInputStream fxp = new DataInputStream(new FileInputStream(file));

byte[] fourBytes = new byte[4];

fxp.read(fourBytes);
if (!CHUNK_MAGIC.equals(new String(fourBytes))) {
fxp.close();
throw new DataFormatException("File does not contain required Chunk Magic, \"" + CHUNK_MAGIC + "\", flag.");
}
try {
byte[] fourBytes = new byte[4];

// fileLength is read an assigned to a variable for debugging purposes only
@SuppressWarnings("unused")
int fileLength = fxp.readInt();
fxp.read(fourBytes);
if (!CHUNK_MAGIC.equals(new String(fourBytes))) {
throw new DataFormatException("File does not contain required Chunk Magic, \"" + CHUNK_MAGIC + "\", flag.");
}

fxp.read(fourBytes);
String chunkDataType = new String(fourBytes);
boolean isRegularChunk = true;
if (REGULAR_PRESET_MAGIC.equals(chunkDataType)) {
isRegularChunk = true;
} else if (OPAQUE_PRESET_MAGIC.equals(chunkDataType)) {
if (!vst.acceptsProgramsAsChunks()) {
fxp.close();
throw new DataFormatException("File contains opaque data but plugin claims not to accept programs as chunks.");
// fileLength is read an assigned to a variable for debugging purposes only
@SuppressWarnings("unused")
int fileLength = fxp.readInt();

fxp.read(fourBytes);
String chunkDataType = new String(fourBytes);
boolean isRegularChunk = true;
if (REGULAR_PRESET_MAGIC.equals(chunkDataType)) {
isRegularChunk = true;
} else if (OPAQUE_PRESET_MAGIC.equals(chunkDataType)) {
if (!vst.acceptsProgramsAsChunks()) {
throw new DataFormatException("File contains opaque data but plugin claims not to accept programs as chunks.");
} else {
isRegularChunk = false;
}
} else {
isRegularChunk = false;
throw new DataFormatException("File reports that is contains neither regular nor opqaue chunks.");
}
} else {
throw new DataFormatException("File reports that is contains neither regular nor opqaue chunks.");
}

int fileVersion = fxp.readInt();
if (fileVersion > 1) {
fxp.close();
throw new DataFormatException("File version " + Integer.toString(fileVersion) + " is not supported.");
}
int fileVersion = fxp.readInt();
if (fileVersion > 1) {
throw new DataFormatException("File version " + Integer.toString(fileVersion) + " is not supported.");
}

// unique id
fxp.read(fourBytes);
String uniqueId = new String(fourBytes);
if (!vst.getUniqueId().equals(uniqueId)) {
fxp.close();
throw new DataFormatException("Unique plugin ID in file does not match given plugin. " +
"Is this file really for " + vst.getEffectName() + "?");
}
// unique id
fxp.read(fourBytes);
String uniqueId = new String(fourBytes);
if (!vst.getUniqueId().equals(uniqueId)) {
throw new DataFormatException("Unique plugin ID in file does not match given plugin. " +
"Is this file really for " + vst.getEffectName() + "?");
}

int filePluginVersion = fxp.readInt();
if (vst.getPluginVersion() < filePluginVersion) {
fxp.close();
throw new DataFormatException("This file contains data for a later plugin version " +
Integer.toString(filePluginVersion) + ", and the given plugin is only version " +
Integer.toString(vst.getPluginVersion()) + ". Get a newer version of the plugin.");
}
int filePluginVersion = fxp.readInt();
if (!ignorePluginVersion && (vst.getPluginVersion() < filePluginVersion)) {
throw new DataFormatException("This file contains data for a later plugin version " +
Integer.toString(filePluginVersion) + ", and the given plugin is only version " +
Integer.toString(vst.getPluginVersion()) + ". Get a newer version of the plugin.");
}

int numParameters = fxp.readInt();
int numParameters = fxp.readInt();

byte[] programNameBytes = new byte[28];
fxp.read(programNameBytes);
String programName = new String(programNameBytes);
vst.setProgramName(programName);
byte[] programNameBytes = new byte[28];
fxp.read(programNameBytes);
String programName = new String(programNameBytes);
vst.setProgramName(programName);

if (isRegularChunk) {
for (int i = 0; i < numParameters; i++) {
vst.setParameter(i, fxp.readFloat());
if (isRegularChunk) {
for (int i = 0; i < numParameters; i++) {
vst.setParameter(i, fxp.readFloat());
}
} else {
byte[] chunkData = new byte[fxp.readInt()];
fxp.read(chunkData);
vst.setProgramChunk(chunkData);
}
} else {
byte[] chunkData = new byte[fxp.readInt()];
fxp.read(chunkData);
vst.setProgramChunk(chunkData);
} finally {
fxp.close();
}

fxp.close();
}

/**
* This method is not yet implemented.
* Loads a preset bank from file to the current bank of the plugin.
* @param vst The plugin to load the data into.
* @param file The file to read which contains the preset data.
* @author Uri Shaked <uri@urish.org>
*/
@Deprecated
public static void loadBank(JVstHost2 vst, File file) throws IOException {
throw new IllegalStateException("JVstPersistence.loadBank(...) is not yet implemented.");
public static void loadBank(JVstHost2 vst, File file) throws DataFormatException, IOException {
if (vst == null) {
throw new NullPointerException("The given JVstHost2 object may not be null.");
}
if (file == null) {
throw new NullPointerException("The given File object may not be null.");
}
if (!file.exists()) {
throw new FileNotFoundException("The given file, " + file.toString() + ", cannot be found.");
}
if (!file.isFile()) {
throw new FileNotFoundException("The given file, " + file.toString() + ", is not a file.");
}

DataInputStream fxp = new DataInputStream(new FileInputStream(file));

try {
byte[] fourBytes = new byte[4];

fxp.read(fourBytes);
if (!CHUNK_MAGIC.equals(new String(fourBytes))) {
throw new DataFormatException("File does not contain required Chunk Magic, \"" + CHUNK_MAGIC + "\", flag.");
}

// fileLength is read an assigned to a variable for debugging purposes only
@SuppressWarnings("unused")
int fileLength = fxp.readInt();

fxp.read(fourBytes);
String chunkDataType = new String(fourBytes);
boolean isRegularChunk = true;
if (REGULAR_BANK_MAGIC.equals(chunkDataType)) {
isRegularChunk = true;
} else if (OPAQUE_BANK_MAGIC.equals(chunkDataType)) {
if (!vst.acceptsProgramsAsChunks()) {
throw new DataFormatException("File contains opaque data but plugin claims not to accept programs as chunks.");
} else {
isRegularChunk = false;
}
} else {
throw new DataFormatException("File reports that is contains neither regular nor opqaue chunks.");
}

int fileVersion = fxp.readInt();
if (fileVersion > 2) {
throw new DataFormatException("File version " + Integer.toString(fileVersion) + " is not supported.");
}

// unique id
fxp.read(fourBytes);
String uniqueId = new String(fourBytes);
if (!vst.getUniqueId().equals(uniqueId)) {
throw new DataFormatException("Unique plugin ID in file does not match given plugin. " +
"Is this file really for " + vst.getEffectName() + "?");
}

int filePluginVersion = fxp.readInt();
if (!ignorePluginVersion && (vst.getPluginVersion() < filePluginVersion)) {
throw new DataFormatException("This file contains data for a later plugin version " +
Integer.toString(filePluginVersion) + ", and the given plugin is only version " +
Integer.toString(vst.getPluginVersion()) + ". Get a newer version of the plugin.");
}

int numPrograms = fxp.readInt();

int currentProgram = fxp.readInt();

// reserved (zero)
fxp.read(new byte[124]);

if (isRegularChunk) {
for (int i = currentProgram; i < currentProgram + numPrograms; i++) {
vst.setProgram(i);
for (int j = 0; j < vst.numParameters(); j++) {
vst.setParameter(i, fxp.readFloat());
}
}
} else {
byte[] chunkData = new byte[fxp.readInt()];
fxp.read(chunkData);
vst.setBankChunk(chunkData);
}
} finally {
fxp.close();
}
}

/**
Expand Down

0 comments on commit 83dd5e7

Please sign in to comment.