Initial RetroWave OPL3 board library support

Author: daemon32

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "src/sound/RetroWave"]
+	path = src/sound/RetroWave
+	url = https://github.com/daemon32/RetroWave
+	branch = 86box

CMakeLists.txt

@@ -124,6 +124,7 @@ cmake_dependent_option(NO_SIO       "Machines without emulated Super I/O chips"
 cmake_dependent_option(OLIVETTI     "Olivetti M290"                                 ON      "DEV_BRANCH"    OFF)
 cmake_dependent_option(OPEN_AT      "OpenAT"                                        ON      "DEV_BRANCH"    OFF)
 cmake_dependent_option(PAS16        "Pro Audio Spectrum 16"                         OFF     "DEV_BRANCH"    OFF)
+cmake_dependent_option(RETROWAVE    "RetroWave OPL3 support"                        ON      "DEV_BRANCH"    OFF)
 cmake_dependent_option(SIO_DETECT   "Super I/O Detection Helper"                    ON      "DEV_BRANCH"    OFF)
 cmake_dependent_option(VGAWONDER    "ATI VGA Wonder (ATI-18800)"                    ON      "DEV_BRANCH"    OFF)
 cmake_dependent_option(VNC          "VNC renderer"                                  OFF     "DEV_BRANCH"    OFF)

src/include/86box/snd_opl_retrowave.h

@@ -0,0 +1,31 @@
+/*
+ * 86Box	A hypervisor and IBM PC system emulator that specializes in
+ *		running old operating systems and software designed for IBM
+ *		PC systems and compatibles from 1981 through fairly recent
+ *		system designs based on the PCI bus.
+ *
+ *		This file is part of the 86Box distribution.
+ *
+ *		Definitions for the RetroWave OPL driver.
+ *
+ * Version:	@(#)snd_opl_retrowave.h	1.0.0	2021/12/22
+ *
+ * Authors:	Fred N. van Kempen, <decwiz@yahoo.com>
+ *		Miran Grca, <mgrca8@gmail.com>
+ *
+ *		Copyright 2017-2020 Fred N. van Kempen.
+ *		Copyright 2016-2019 Miran Grca.
+ */
+#ifndef SOUND_OPL_RETROWAVE_H
+# define SOUND_OPL_RETROWAVE_H
+
+
+extern void *	retrowave_86box_module_init();
+extern void	retrowave_close(void *);
+
+extern uint16_t	retrowave_write_addr(void *, uint16_t port, uint8_t val);
+extern void	retrowave_write_reg(void *, uint16_t reg, uint8_t v);
+
+extern void	retrowave_generate_stream(void *, int32_t *sndptr, uint32_t num);
+
+#endif	/*SOUND_OPL_RETROWAVE_H*/

src/sound/CMakeLists.txt

@@ -13,7 +13,7 @@
 #           Copyright 2020,2021 David Hrdlička.
 #
 
-add_library(snd OBJECT sound.c openal.c snd_opl.c snd_opl_nuked.c snd_resid.cc
+add_library(snd OBJECT sound.c openal.c snd_opl.c snd_opl_nuked.c snd_opl_retrowave.c snd_resid.cc
     midi.c midi_rtmidi.cpp snd_speaker.c snd_pssj.c snd_lpt_dac.c snd_ac97_codec.c snd_ac97_via.c
     snd_lpt_dss.c snd_adlib.c snd_adlibgold.c snd_ad1848.c snd_audiopci.c
     snd_azt2316a.c snd_cms.c snd_cs423x.c snd_gus.c snd_sb.c snd_sb_dsp.c
@@ -41,5 +41,10 @@ if(GUSMAX)
     target_compile_definitions(snd PRIVATE USE_GUSMAX)
 endif()
 
+# Avoid building the player app, don't need it
+set(RETROWAVE_BUILD_PLAYER 0)
+
 add_subdirectory(resid-fp)
-target_link_libraries(86Box resid-fp)
+add_subdirectory(RetroWave)
+target_link_libraries(86Box RetroWave)
+target_link_libraries(86Box resid-fp)

src/sound/RetroWave

@@ -31,7 +31,7 @@
 #include <86box/io.h>
 #include <86box/sound.h>
 #include <86box/snd_opl.h>
-#include <86box/snd_opl_nuked.h>
+#include <86box/snd_opl_retrowave.h>
 
 
 enum {
@@ -155,7 +155,7 @@ static void
 opl_write(opl_t *dev, uint16_t port, uint8_t val)
 {
     if ((port & 0x0001) == 0x0001) {
-	nuked_write_reg_buffered(dev->opl, dev->port, val);
+	retrowave_write_reg(dev->opl, dev->port, val);
 
 	switch (dev->port) {
 		case 0x02:	/* Timer 1 */
@@ -181,7 +181,7 @@ opl_write(opl_t *dev, uint16_t port, uint8_t val)
 			break;
 	}
     } else {
-	dev->port = nuked_write_addr(dev->opl, port, val) & 0x01ff;
+	dev->port = retrowave_write_addr(dev->opl, port, val) & 0x01ff;
 
 	if (!(dev->flags & FLAG_OPL3))
 		dev->port &= 0x00ff;
@@ -210,8 +210,8 @@ opl_init(opl_t *dev, int is_opl3)
     else
 	dev->status = 0x06;
 
-    /* Create a NukedOPL object. */
-    dev->opl = nuked_init(48000);
+    /* Create a RetroWave object. */
+    dev->opl = retrowave_86box_module_init();
 
     timer_add(&dev->timers[0], timer_1, dev, 0);
     timer_add(&dev->timers[1], timer_2, dev, 0);
@@ -221,9 +221,9 @@ opl_init(opl_t *dev, int is_opl3)
 void
 opl_close(opl_t *dev)
 {
-    /* Release the NukedOPL object. */
+    /* Release the RetroWave object. */
     if (dev->opl) {
-	nuked_close(dev->opl);
+	retrowave_close(dev->opl);
 	dev->opl = NULL;
     }
 }
@@ -270,7 +270,7 @@ opl2_update(opl_t *dev)
 		return;
 	}
 
-    nuked_generate_stream(dev->opl,
+    retrowave_generate_stream(dev->opl,
 			  &dev->buffer[dev->pos * 2],
 			  sound_pos_global - dev->pos);
 
@@ -299,7 +299,7 @@ void
 opl3_write(uint16_t port, uint8_t val, void *priv)
 {
     opl_t *dev = (opl_t *)priv;
-	
+
     opl3_update(dev);
 
     opl_write(dev, port, val);
@@ -320,7 +320,7 @@ opl3_update(opl_t *dev)
     if (dev->pos >= sound_pos_global)
 	return;
 
-    nuked_generate_stream(dev->opl,
+    retrowave_generate_stream(dev->opl,
 			  &dev->buffer[dev->pos * 2],
 			  sound_pos_global - dev->pos);
 

src/sound/snd_opl.c

@@ -0,0 +1,117 @@
+/*
+ * 86Box	A hypervisor and IBM PC system emulator that specializes in
+ *		running old operating systems and software designed for IBM
+ *		PC systems and compatibles from 1981 through fairly recent
+ *		system designs based on the PCI bus.
+ *
+ *		This file is part of the 86Box distribution.
+ *
+ *		RetroWave OPL3 bridge.
+ *
+ *		 Version: 1.0.0
+ *
+ * Version:	@(#)snd_opl_retrowave.c	1.0.0	2021/12/22
+ *
+ * Authors:	Fred N. van Kempen, <decwiz@yahoo.com>
+ *		Miran Grca, <mgrca8@gmail.com>
+ *		Alexey Khokholov (Nuke.YKT)
+ *
+ *		Copyright 2017-2020 Fred N. van Kempen.
+ *		Copyright 2016-2020 Miran Grca.
+ *		Copyright 2013-2018 Alexey Khokholov (Nuke.YKT)
+ */
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <86box/86box.h>
+#include <86box/timer.h>
+#include <86box/sound.h>
+#include <86box/snd_opl_retrowave.h>
+#include "RetroWave/RetroWaveLib/RetroWave_86Box.h"
+
+
+#define WRBUF_SIZE	1024
+#define WRBUF_DELAY	1
+#define RSM_FRAC	10
+
+
+struct chip;
+
+typedef struct chip {
+    uint8_t opl3_port;
+} retrowave_t;
+
+
+uint16_t
+retrowave_write_addr(void *priv, uint16_t port, uint8_t val)
+{
+    retrowave_t *dev = (retrowave_t *)priv;
+//                      printf("writeaddr: 0x%08x 0x%02x\n", port, val);
+
+    switch (port & 3) {
+        case 0:
+            dev->opl3_port = 0;
+            return val;
+        case 2:
+            dev->opl3_port = 1;
+            if (val == 0x05)
+                return 0x100 | val;
+            else
+                return val;
+    }
+}
+
+
+void
+retrowave_write_reg(void *priv, uint16_t reg, uint8_t val)
+{
+    retrowave_t *dev = (retrowave_t *)priv;
+//                      printf("writereg: 0x%08x 0x%02x\n", reg, val);
+
+                        uint8_t real_reg = reg & 0xff;
+                        uint8_t real_val = val;
+
+    if (dev->opl3_port) {
+        retrowave_opl3_queue_port1(&retrowave_global_context, real_reg, real_val);
+    } else {
+        retrowave_opl3_queue_port0(&retrowave_global_context, real_reg, real_val);
+    }
+}
+
+
+void *
+retrowave_86box_module_init()
+{
+    retrowave_t *dev;
+    uint8_t i;
+
+    dev = (retrowave_t *)malloc(sizeof(retrowave_t));
+    memset(dev, 0x00, sizeof(retrowave_t));
+
+    dev->opl3_port = 0;
+
+    retrowave_init_86box("ttyOPL");
+    retrowave_opl3_reset(&retrowave_global_context);
+
+    return(dev);
+}
+
+
+void
+retrowave_close(void *priv)
+{
+    retrowave_t *dev = (retrowave_t *)priv;
+
+    free(dev);
+}
+
+
+void
+retrowave_generate_stream(void *priv, int32_t *sndptr, uint32_t num)
+{
+    retrowave_t *dev = (retrowave_t *)priv;
+    uint32_t i;
+
+    retrowave_flush(&retrowave_global_context);
+}