mirror of
https://github.com/badvision/lawless-legends.git
synced 2024-06-09 23:29:37 +00:00
338 lines
12 KiB
Java
338 lines
12 KiB
Java
/*
|
|
* Copyright (C) 2012 Brendan Robert (BLuRry) brendan.robert@gmail.com.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
* MA 02110-1301 USA
|
|
*/
|
|
package jace.hardware;
|
|
|
|
import java.util.concurrent.ExecutionException;
|
|
import java.util.logging.Level;
|
|
import java.util.logging.Logger;
|
|
|
|
import jace.Emulator;
|
|
import jace.config.ConfigurableField;
|
|
import jace.config.Name;
|
|
import jace.core.Card;
|
|
import jace.core.RAMEvent;
|
|
import jace.core.RAMEvent.TYPE;
|
|
import jace.core.RAMListener;
|
|
import jace.core.SoundMixer;
|
|
import jace.core.SoundMixer.SoundBuffer;
|
|
import jace.core.SoundMixer.SoundError;
|
|
import jace.hardware.mockingboard.PSG;
|
|
import jace.hardware.mockingboard.R6522;
|
|
|
|
/**
|
|
* Mockingboard-C implementation (with partial Phasor support). This uses two
|
|
* 6522 chips to communicate to two respective AY PSG sound chips. This class
|
|
* manages the I/O access as well as the sound playback thread.
|
|
*
|
|
* @author Brendan Robert (BLuRry) brendan.robert@gmail.com
|
|
*/
|
|
@Name("Mockingboard")
|
|
public class CardMockingboard extends Card {
|
|
// If true, emulation will cover 4 AY chips. Otherwise, only 2 AY chips
|
|
|
|
@ConfigurableField(name = "Volume", shortName = "vol",
|
|
category = "Sound",
|
|
description = "Mockingboard volume, 100=max, 0=silent")
|
|
public int volume = 100;
|
|
static public int MAX_AMPLITUDE = 0x007fff;
|
|
@ConfigurableField(name = "Phasor mode",
|
|
category = "Sound",
|
|
description = "If enabled, card will have 4 sound chips instead of 2")
|
|
public boolean phasorMode = false;
|
|
@ConfigurableField(name = "Clock Rate (hz)",
|
|
category = "Sound",
|
|
defaultValue = "1020484",
|
|
description = "Clock rate of AY oscillators")
|
|
public int CLOCK_SPEED = 1020484;
|
|
@ConfigurableField(name = "Buffer size",
|
|
category = "Sound",
|
|
description = "Number of samples to generate on each pass")
|
|
public int BUFFER_LENGTH = 2;
|
|
// The array of configured AY chips
|
|
public PSG[] chips;
|
|
// The 6522 controllr chips (always 2)
|
|
public R6522[] controllers;
|
|
@ConfigurableField(name = "Idle sample threshold", description = "Number of samples to wait before suspending sound")
|
|
int[] left, right;
|
|
SoundBuffer buffer;
|
|
int ticksBetweenPlayback = 24;
|
|
int MAX_IDLE_TICKS = 1000000;
|
|
boolean activatedAfterReset = false;
|
|
boolean debug = false;
|
|
|
|
@Override
|
|
public String getDeviceName() {
|
|
return "Mockingboard";
|
|
}
|
|
|
|
public CardMockingboard() {
|
|
super();
|
|
activatedAfterReset = false;
|
|
left = new int[BUFFER_LENGTH];
|
|
right = new int[BUFFER_LENGTH];
|
|
controllers = new R6522[2];
|
|
for (int i = 0; i < 2; i++) {
|
|
// has to be final to be used inside of anonymous class below
|
|
final int j = i;
|
|
controllers[i] = new R6522() {
|
|
@Override
|
|
public void sendOutputA(int value) {
|
|
chips[j].setBus(value);
|
|
if (phasorMode) {
|
|
chips[j + 2].setBus(value);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void sendOutputB(int value) {
|
|
if (phasorMode) {
|
|
if ((chips[j].mask & value) != 0) {
|
|
chips[j].setControl(value & 0x07);
|
|
}
|
|
if ((chips[j + 2].mask & value) != 0) {
|
|
chips[j + 2].setControl(value & 0x07);
|
|
}
|
|
} else {
|
|
chips[j].setControl(value & 0x07);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public int receiveOutputA() {
|
|
return chips[j] == null ? 0 : chips[j].bus;
|
|
}
|
|
|
|
@Override
|
|
public int receiveOutputB() {
|
|
return 0;
|
|
}
|
|
|
|
@Override
|
|
public String getShortName() {
|
|
return "timer" + j;
|
|
}
|
|
};
|
|
addChildDevice(controllers[i]);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void reset() {
|
|
activatedAfterReset = false;
|
|
suspend();
|
|
}
|
|
RAMListener mainListener = null;
|
|
|
|
@Override
|
|
protected void handleFirmwareAccess(int register, TYPE type, int value, RAMEvent e) {
|
|
if (chips == null) {
|
|
reconfigure();
|
|
}
|
|
|
|
int chip = 0;
|
|
for (PSG psg : chips) {
|
|
if (psg.getBaseReg() == (register & 0x0f0)) {
|
|
break;
|
|
}
|
|
chip++;
|
|
}
|
|
if (chip >= 2) {
|
|
System.err.println("Could not determine which PSG to communicate to for access to regsiter + " + Integer.toHexString(register));
|
|
Emulator.withVideo(v->e.setNewValue(v.getFloatingBus()));
|
|
return;
|
|
}
|
|
R6522 controller = controllers[chip & 1];
|
|
if (e.getType().isRead()) {
|
|
int val = controller.readRegister(register & 0x0f);
|
|
e.setNewValue(val);
|
|
if (debug) System.out.println("Chip " + chip + " Read "+Integer.toHexString(register & 0x0f)+" == "+val);
|
|
} else {
|
|
controller.writeRegister(register & 0x0f, e.getNewValue());
|
|
if (debug) System.out.println("Chip " + chip + " Write "+Integer.toHexString(register & 0x0f)+" == "+e.getNewValue());
|
|
}
|
|
// Any firmware access will reset the idle counter and wake up the card, this allows the timers to start running again
|
|
// Games such as "Skyfox" use the timer to detect if the card is present.
|
|
idleTicks = 0;
|
|
if (!isRunning() || isPaused()) {
|
|
activatedAfterReset = true;
|
|
resume();
|
|
}
|
|
}
|
|
|
|
@Override
|
|
protected void handleIOAccess(int register, TYPE type, int value, RAMEvent e) {
|
|
// Oddly, all IO is done at the firmware address bank. It's a strange card.
|
|
// System.out.println("MB I/O Access "+type.name()+" "+register+":"+value);
|
|
Emulator.withVideo(v->e.setNewValue(v.getFloatingBus()));
|
|
}
|
|
long ticksSinceLastPlayback = 0;
|
|
long idleTicks = 0;
|
|
@Override
|
|
public void tick() {
|
|
try {
|
|
ticksSinceLastPlayback++;
|
|
if (ticksSinceLastPlayback >= ticksBetweenPlayback) {
|
|
ticksSinceLastPlayback -= ticksBetweenPlayback;
|
|
if (playSound(left, right)) {
|
|
idleTicks = 0;
|
|
} else {
|
|
idleTicks += ticksBetweenPlayback;
|
|
}
|
|
}
|
|
} catch (InterruptedException | ExecutionException | SoundError | NullPointerException ex) {
|
|
Logger.getLogger(CardMockingboard.class.getName()).log(Level.SEVERE, "Mockingboard playback encountered fatal exception", ex);
|
|
suspend();
|
|
// Do nothing, probably suspending CPU
|
|
}
|
|
|
|
if (idleTicks >= MAX_IDLE_TICKS) {
|
|
suspend();
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void reconfigure() {
|
|
initPSG();
|
|
for (PSG chip : chips) {
|
|
chip.setRate(phasorMode ? CLOCK_SPEED * 2 : CLOCK_SPEED, SoundMixer.RATE);
|
|
chip.reset();
|
|
}
|
|
long motherboardSpeed = Emulator.withComputer(c->c.getMotherboard().getSpeedInHz(), 1L);
|
|
ticksBetweenPlayback = (int) ((motherboardSpeed * BUFFER_LENGTH) / SoundMixer.RATE);
|
|
buildMixerTable();
|
|
|
|
super.reconfigure();
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////
|
|
public static int[] VolTable;
|
|
|
|
public boolean playSound(int[] left, int[] right) throws InterruptedException, ExecutionException, SoundError {
|
|
if (buffer == null) {
|
|
return false;
|
|
}
|
|
chips[0].update(left, true, left, false, left, false, BUFFER_LENGTH);
|
|
chips[1].update(right, true, right, false, right, false, BUFFER_LENGTH);
|
|
if (phasorMode) {
|
|
chips[2].update(left, false, left, false, left, false, BUFFER_LENGTH);
|
|
chips[3].update(right, false, right, false, right, false, BUFFER_LENGTH);
|
|
}
|
|
boolean nonZeroSamples = false;
|
|
for (int i=0; i < BUFFER_LENGTH; i++) {
|
|
buffer.playSample((short) left[i]);
|
|
buffer.playSample((short) right[i]);
|
|
if (left[i] != 0 || right[i] != 0) {
|
|
nonZeroSamples = true;
|
|
}
|
|
}
|
|
return nonZeroSamples;
|
|
}
|
|
|
|
public void buildMixerTable() {
|
|
VolTable = new int[16];
|
|
int numChips = phasorMode ? 4 : 2;
|
|
|
|
/* calculate the volume->voltage conversion table */
|
|
/* The AY-3-8910 has 16 levels, in a logarithmic scale (3dB per step) */
|
|
/* The YM2149 still has 16 levels for the tone generators, but 32 for */
|
|
/* the envelope generator (1.5dB per step). */
|
|
double out = (MAX_AMPLITUDE * volume) / 100.0;
|
|
// Reduce max amplitude to reflect post-mixer values so we don't have to scale volume when mixing channels
|
|
out = out * 2.0 / 3.0 / numChips;
|
|
// double delta = 1.15;
|
|
for (int i = 15; i > 0; i--) {
|
|
VolTable[i] = (int) (out / Math.pow(Math.sqrt(2),(15-i)));
|
|
// out /= 1.188502227; /* = 10 ^ (1.5/20) = 1.5dB */
|
|
// out /= 1.15; /* = 10 ^ (3/20) = 3dB */
|
|
// delta += 0.0225;
|
|
// out /= delta; // As per applewin's source, the levels don't scale as documented.
|
|
}
|
|
|
|
VolTable[0] = 0;
|
|
}
|
|
|
|
@Override
|
|
public void resume() {
|
|
if (!activatedAfterReset) {
|
|
// Do not re-activate until firmware access was made
|
|
return;
|
|
}
|
|
if (buffer == null || !buffer.isAlive()) {
|
|
try {
|
|
buffer = SoundMixer.createBuffer(true);
|
|
} catch (InterruptedException | ExecutionException | SoundError e) {
|
|
System.out.println("Error whhen trying to create sound buffer for Mockingboard: " + e.getMessage());
|
|
e.printStackTrace();
|
|
suspend();
|
|
}
|
|
}
|
|
if (chips == null) {
|
|
initPSG();
|
|
for (PSG psg : chips) {
|
|
psg.setRate(phasorMode ? CLOCK_SPEED * 2 : CLOCK_SPEED, SoundMixer.RATE);
|
|
psg.reset();
|
|
}
|
|
}
|
|
idleTicks = 0;
|
|
setPaused(false);
|
|
reconfigure();
|
|
super.resume();
|
|
}
|
|
|
|
@Override
|
|
public boolean suspend() {
|
|
if (buffer != null) {
|
|
try {
|
|
buffer.shutdown();
|
|
} catch (InterruptedException | ExecutionException | SoundError e) {
|
|
System.out.println("Error when trying to shutdown sound buffer for Mockingboard: " + e.getMessage());
|
|
e.printStackTrace();
|
|
} finally {
|
|
buffer = null;
|
|
}
|
|
}
|
|
return super.suspend();
|
|
}
|
|
|
|
private void initPSG() {
|
|
if (phasorMode) {
|
|
chips = new PSG[4];
|
|
chips[0] = new PSG(0x10, CLOCK_SPEED * 2, SoundMixer.RATE, "AY1", 8);
|
|
chips[1] = new PSG(0x80, CLOCK_SPEED * 2, SoundMixer.RATE, "AY2", 8);
|
|
chips[2] = new PSG(0x10, CLOCK_SPEED * 2, SoundMixer.RATE, "AY3", 16);
|
|
chips[3] = new PSG(0x80, CLOCK_SPEED * 2, SoundMixer.RATE, "AY4", 16);
|
|
} else {
|
|
chips = new PSG[2];
|
|
chips[0] = new PSG(0, CLOCK_SPEED, SoundMixer.RATE, "AY1", 255);
|
|
chips[1] = new PSG(0x80, CLOCK_SPEED, SoundMixer.RATE, "AY2", 255);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
protected void handleC8FirmwareAccess(int register, TYPE type, int value, RAMEvent e) {
|
|
// There is no c8 rom access to emulate
|
|
}
|
|
|
|
// This fixes freezes when resizing the window, etc.
|
|
// @Override
|
|
// public boolean suspendWithCPU() {
|
|
// return true;
|
|
// }
|
|
}
|