SIDWrite.java
/**
*
*/
package server.netsiddev;
public final class SIDWrite {
private final int chip;
private final int reg;
private final byte value;
private final int cycles;
private boolean pureDelay;
private final boolean end;
/**
* This command is a general write command to SID. Reg is a SID register or FM address; cycles may be zero for same-cycle writes.
*
* @param chip The specified SID chip to write to.
* @param reg The SID register to write to.
* @param data The data to write to the specified SID register.
* @param cycles Cycles to spend on writing the data.
* @throws InvalidCommandException invalid command
*/
public SIDWrite(final int chip, final int reg, final byte data, final int cycles) throws InvalidCommandException {
if (cycles < 0) {
throw new InvalidCommandException("Cycle interval must be >= 0: " + cycles);
}
this.chip = chip;
this.reg = reg;
this.value = data;
this.cycles = cycles;
this.pureDelay = false;
this.end = false;
}
private SIDWrite(final int chip, final int cycles) throws InvalidCommandException {
this(chip, (byte) 0, (byte) 0, cycles);
this.pureDelay = true;
}
private SIDWrite() {
this.chip = 0;
this.reg = 0;
this.value = 0;
this.cycles = 0;
this.pureDelay = false;
this.end = true;
}
/**
* This command instructs AudioGeneratorThread about the need to execute a pure delay on specified SID. Throws if
* cycles < 0.
*
* @param sid The SID to execute a pure delay on.
* @param cycles Number of cycles to execute the pure delay for.
* @return A new SIDWrite instance.
* @throws InvalidCommandException invalid command
*/
public static SIDWrite makePureDelay(final int sid, final int cycles) throws InvalidCommandException {
return new SIDWrite(sid, cycles);
}
/** Whether this event writes a SID register rather than delaying, ending or writing FM. */
boolean isSidWrite() {
return !pureDelay && !end && reg <= NetworkSIDProtocol.SID_REGISTER_MASK;
}
/** Whether this event writes an FM register on the same global timeline. */
boolean isFmWrite() {
return !pureDelay && !end && reg > NetworkSIDProtocol.SID_REGISTER_MASK;
}
/**
* Is command a no-write command?
*
* @return True if the SIDWrite object is a no-write command; false otherwise.
*/
boolean isPureDelay() {
return pureDelay;
}
/**
* This command instructs AudioGeneratorThread to exit cleanly.
*
* @return A new SIDWrite instance.
*/
public static SIDWrite makeEnd() {
return new SIDWrite();
}
/**
* Is an "END" command?
*
* @return True if the SIDWrite object is an END command; false otherwise.
*/
boolean isEnd() {
return end;
}
/**
* Gets the SID chip being used in this SIDWrite instance.
*
* @return The SID chip being used in this SIDWrite instance.
*/
int getChip() {
return chip;
}
/**
* Gets the register being written to in this SIDWrite instance.
*
* @return The register being written to in this SIDWrite instance.
*/
int getRegister() {
return reg;
}
/**
* Gets the value being written to the register in this SIDWrite instance.
*
* @return The value being written to the register in this SIDWrite instance.
*/
byte getValue() {
return value;
}
/**
* Gets the number of cycles writing will take in this SIDWrite instance.
*
* @return The number of cycles writing will take in this SIDWrite instance.
*/
int getCycles() {
return cycles;
}
}