ReSIDBuilder.java
/**
* ReSID builder class for creating/controlling resids --------------------------------------------------- begin
* : Wed Sep 5 2001 copyright : (C) 2001 by Simon White email : s_a_white@email.com
* <p>
* This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation; either version 2 of the License or (at your option) any later
* version.
*
* @author Ken Händel
*
*/
package builder.resid;
import builder.resid.resid.ReSID;
import builder.resid.residfp.ReSIDfp;
import builder.resid.residfp.circuit.ReSIDfpCircuit;
import libsidplay.common.*;
import libsidplay.components.cart.Cartridge;
import libsidplay.config.IConfig;
import libsidplay.config.IEmulationSection;
import libsidplay.sidtune.SidTune;
import libsidutils.sound.SoundSetup;
import static libsidplay.common.SIDChip.REG_COUNT;
/**
*
* Support of software emulated SIDs.
*
* @author ken
*
*/
public class ReSIDBuilder extends SIDMixer implements SIDBuilder {
// Presentation metadata lives outside the hot SID objects. Filled only during configuration.
private final SoundSetup[] soundSetups = new SoundSetup[libsidplay.config.ISidPlay2SystemProperties.MAX_SIDS];
private final SIDEmu[] describedChips = new SIDEmu[soundSetups.length];
public SoundSetup getSoundSetup(int chip) { return soundSetups[chip]; }
public ReSIDBuilder(EventScheduler context, IConfig config, CPUClock cpuClock, Cartridge cart) {
super(context, config, cpuClock, cart);
}
/**
* Create a SID chip implementation and configure it, then start mixing.
*/
@Override
public SIDEmu lock(SIDEmu oldSIDEmu, int sidNum, SidTune tune) {
final ReSIDBase sid = getOrCreateSID(oldSIDEmu, tune, sidNum);
IEmulationSection emulationSection = config.getEmulationSection();
sid.setChipModel(ChipModel.getChipModel(emulationSection, tune, sidNum));
sid.setClockFrequency(cpuClock.getCpuFrequency());
sid.setFilter(config, sidNum);
sid.setFilterEnable(emulationSection, sidNum);
soundSetups[sidNum] = SoundSetup.capture(config, tune, sidNum, cpuClock, context.getTime(Event.Phase.PHI2));
describedChips[sidNum] = sid;
sid.setDigiBoost(emulationSection.isDigiBoosted8580());
for (int voice = 0; voice < 4; voice++) {
sid.setVoiceMute(voice, emulationSection.isMuteVoice(sidNum, voice));
}
for (int i = 0; oldSIDEmu != null && !oldSIDEmu.equals(sid) && i < REG_COUNT; i++) {
sid.write(i, oldSIDEmu.readInternalRegister(i));
}
add(tune, sidNum, sid);
return sid;
}
/**
* Release a SID chip implementation (stop mixing SID chip).
*/
@Override
public void unlock(final SIDEmu sid) {
for (int chip = 0; chip < describedChips.length; chip++) {
if (describedChips[chip] == sid) {
describedChips[chip] = null;
soundSetups[chip] = null;
}
}
remove((ReSIDBase) sid);
}
/**
* Create SID emulation of a specific emulation type or re-use already used SID
* chip, if implementation does not change.<BR>
* Note: The reason for re-using SID implementation is to preserve the current
* SID's internal state, when changing filters or chip model type.
*
* @param oldSIDEmu currently used SID chip
* @param tune current tune
* @param sidNum current SID number
*
* @return new or re-used SID emulation of a specific emulation engine
*/
private ReSIDBase getOrCreateSID(SIDEmu oldSIDEmu, SidTune tune, int sidNum) {
final IEmulationSection emulationSection = config.getEmulationSection();
final Emulation emulation = Emulation.getEmulation(emulationSection, sidNum);
boolean fakeStereo = SidTune.isFakeStereoSid(emulationSection, tune, sidNum);
Class<? extends ReSIDBase> sidImplClass = getSIDImplClass(emulation, fakeStereo);
if (oldSIDEmu != null && oldSIDEmu.getClass().equals(sidImplClass)) {
// the implementing class does not change, re-use!
return (ReSIDBase) oldSIDEmu;
}
return createSID(sidImplClass, sidNum);
}
/**
* Get SID chip implementation class.
*
* @param emulation wanted emulation type
* @param fakeStereo fake-stereo mode (two SIDs at the same address)
* @return SID implementation class
*/
private Class<? extends ReSIDBase> getSIDImplClass(final Emulation emulation, final boolean fakeStereo) {
return switch (emulation) {
case RESID -> fakeStereo ? ReSID.FakeStereo.class : ReSID.class;
case RESIDFP -> fakeStereo ? ReSIDfp.FakeStereo.class : ReSIDfp.class;
case RESIDFP_CIRCUIT -> fakeStereo ? ReSIDfpCircuit.FakeStereo.class : ReSIDfpCircuit.class;
default -> throw new RuntimeException("Unknown SID emulation: " + emulation);
};
}
/**
* Create a new SID chip implementation.
*
* @param sidImplCls SID implementation class
* @param sidNum current SID number
* @return new SID chip
*/
private ReSIDBase createSID(final Class<? extends ReSIDBase> sidImplCls, int sidNum) {
if (ReSID.class.equals(sidImplCls)) {
return new ReSID(context);
} else if (ReSIDfp.class.equals(sidImplCls)) {
return new ReSIDfp(context);
} else if (ReSIDfpCircuit.class.equals(sidImplCls)) {
return new ReSIDfpCircuit(context);
} else if (ReSIDfpCircuit.FakeStereo.class.equals(sidImplCls)) {
return new ReSIDfpCircuit.FakeStereo(context, config, sidNum - 1, sids);
} else if (ReSID.FakeStereo.class.equals(sidImplCls)) {
return new ReSID.FakeStereo(context, config, sidNum - 1, sids);
} else if (ReSIDfp.FakeStereo.class.equals(sidImplCls)) {
return new ReSIDfp.FakeStereo(context, config, sidNum - 1, sids);
} else {
throw new RuntimeException("Unknown SID impl.: " + sidImplCls);
}
}
}