Add optional commandline parameters (that save) for tuning the buffer size and head->tail difference size

Author: LouDnl

README.md

@@ -10,6 +10,15 @@ Use `-usaudiomode 1` to enable Stereo mode, default is Mono mode. Works on PCB v
    x64sc -usreadmode 1 -usaudiomode 1
    vsid -usreadmode 1 -usaudiomode 1
 ```
+# Optional tuning of write buffer and it's head->tail difference size
+Buffer and difference size must always be a multiple of 8!  
+Use `-usdiffsize 64` to set the head->tail difference size  
+Use `-usbuffsize 8192` to set the buffer size  
+```shell
+   # Examples
+   x64sc -usdiffsize 64 -usbuffsize 512
+   vsid -usdiffsize 64 -usbuffsize 512
+```
 
 # Linux Building and installing
 For building you can mostly follow the instructions in the [Linux-GTK3-Howto](vice/doc/building/Linux-GTK3-Howto.txt) \

vice/src/arch/shared/hwsiddrv/us-unixwin-device.c

@@ -69,6 +69,9 @@
 static int rc = -1, sids_found = -1, no_sids = -1;
 static int r_audiomode = -1, audiomode = -1;
 static int r_readmode = -1, readmode = -1;
+static int buffsize = -1, diffsize = -1;
+static int r_buffsize = -1, r_diffsize = -1;
+const int d_buffsize = 8192, d_diffsize = 64;
 static uint8_t sidbuf[0x20 * US_MAXSID];
 
 static CLOCK usid_main_clk;
@@ -125,6 +128,12 @@ int us_device_open(void)
             resources_get_int("SidUSBSIDAudioMode", &r_audiomode);
             // log_message(usbsid_log, "SidUSBSIDAudioMode: %d, readmode: %d\r", r_audiomode, audiomode);
             audiomode = r_audiomode;
+            resources_get_int("SidUSBSIDDiffSize", &r_readmode);
+            // log_message(usbsid_log, "SidUSBSIDReadMode: %d, readmode: %d\r", r_readmode, readmode);
+            diffsize = r_diffsize;
+            resources_get_int("SidUSBSIDBufferSize", &r_diffsize);
+            // log_message(usbsid_log, "SidUSBSIDAudioMode: %d, readmode: %d\r", r_audiomode, audiomode);
+            buffsize = r_buffsize;
         }
 
         if (readmode == 1) {
@@ -247,12 +256,42 @@ void us_set_readmode(int val)
 void us_set_audiomode(int val)
 {   /* Gets set by x64sc from SID settings and by VSID at SID file change */
     resources_get_int("SidUSBSIDAudioMode", &r_audiomode);
-    log_message(usbsid_log, "Audio mode is '%s'\r", (r_audiomode == 1 ? "Stereo" : "Mono"));
+    log_message(usbsid_log, "Audio mode is '%s' (resource:%d val:%d)\r", (r_audiomode == 1 ? "Stereo" : "Mono"), r_audiomode, val);
     audiomode = r_audiomode;
 
     setstereo_USBSID(usbsid, audiomode);
 }
 
+void us_restart_ringbuffer(void)
+{   /* Restarts the ringbuffer with a new value */
+    if (buffsize != d_buffsize) {
+        log_message(usbsid_log, "Restarting ringbuffer with buffer size:%d & diff size:%d\r", buffsize, diffsize);
+        restartringbuffer_USBSID(usbsid);
+    }
+}
+
+void us_set_buffsize(int val)
+{   /* Set the ringbuffer size */
+    resources_get_int("SidUSBSIDBufferSize", &r_buffsize);
+    buffsize = r_buffsize;
+    if (r_buffsize != d_buffsize) {
+        log_message(usbsid_log, "Setting ringbuffer size to: %d (val:%d default:%d)\r", buffsize, val, d_buffsize);
+        setbuffsize_USBSID(usbsid, buffsize);
+        us_restart_ringbuffer();
+    }
+}
+
+void us_set_diffsize(int val)
+{   /* Set the ringbuffer head to tail difference size */
+    resources_get_int("SidUSBSIDDiffSize", &r_diffsize);
+    diffsize = r_diffsize;
+    if (r_diffsize != d_diffsize) {
+        log_message(usbsid_log, "Setting ringbuffer diff size to: %d  (val:%d default:%d)\r", diffsize, val, d_diffsize);
+        setdiffsize_USBSID(usbsid, diffsize);
+    }
+
+}
+
 static void usbsid_alarm_handler(CLOCK offset, void *data)
 {
     CLOCK cycles = (usid_alarm_clk + offset) - usid_main_clk;

vice/src/arch/shared/hwsiddrv/us-unixwin.h

@@ -58,6 +58,12 @@ void us_set_readmode(int val);
 
 void us_set_audiomode(int val);
 
+void us_restart_ringbuffer(void);
+
+void us_set_buffsize(int val);
+
+void us_set_diffsize(int val);
+
 void us_device_state_read(int chipno, struct sid_us_snapshot_state_s *sid_state);
 
 void us_device_state_write(int chipno, struct sid_us_snapshot_state_s *sid_state);

vice/src/arch/shared/hwsiddrv/usbsid-unixwin-drv.c

@@ -115,6 +115,27 @@ void usbsid_drv_set_audiomode(int val)
     }
 }
 
+void usbsid_drv_restart_ringbuffer(void)
+{
+    if (use_us_device) {
+        us_restart_ringbuffer();
+    }
+}
+
+void usbsid_drv_set_buffsize(int val)
+{
+    if (use_us_device) {
+        us_set_buffsize(val);
+    }
+}
+
+void usbsid_drv_set_diffsize(int val)
+{
+    if (use_us_device) {
+        us_set_diffsize(val);
+    }
+}
+
 void usbsid_drv_state_read(int chipno, struct sid_us_snapshot_state_s *sid_state)
 {
     if (use_us_device) {

vice/src/sid/sid-cmdline-options.c

@@ -132,6 +132,38 @@ static const struct engine_s engine_match[] = {
     { NULL, -1 }
 };
 
+#ifdef HAVE_USBSID
+int us_setparam(const char *param, void *extra_param)
+{
+    printf("KUT: %s %s %s\n", param, (char *)&extra_param, (char *)extra_param);
+    if ((!strcmp(((char *)extra_param), "rw")) && (strlen(param) >= 1)) {
+        int r = atoi(param);
+        printf("R: %d\n", r);
+        resources_set_int("SidUSBSIDReadMode", r);
+        usbsid_set_readmode(r);
+    }
+    if ((!strcmp(((char *)extra_param), "audio")) && (strlen(param) >= 1)) {
+        int a = atoi(param);
+        printf("A: %d\n", a);
+        resources_set_int("SidUSBSIDAudioMode", a);
+        usbsid_set_audiomode(a);
+    }
+    if ((!strcmp(((char *)extra_param), "diff")) && (strlen(param) >= 1)) {
+        int d = atoi(param);
+        printf("D: %d\n", d);
+        resources_set_int("SidUSBSIDDiffSize", d);
+        usbsid_set_diffsize(d);
+    }
+    if ((!strcmp(((char *)extra_param), "buff")) && (strlen(param) >= 1)) {
+        int b = atoi(param);
+        printf("B: %d\n", b);
+        resources_set_int("SidUSBSIDBufferSize", b);
+        usbsid_set_buffsize(b);
+    }
+    return 0;
+}
+#endif
+
 int sid_common_set_engine_model(const char *param, void *extra_param)
 {
     int engine;
@@ -240,12 +272,32 @@ static const cmdline_option_t hardsid_cmdline_options[] =
 #ifdef HAVE_USBSID
 static const cmdline_option_t usbsid_cmdline_options[] =
 {
+
     { "-usreadmode", SET_RESOURCE, CMDLINE_ATTRIB_NEED_ARGS,
       NULL, NULL, "SidUSBSIDReadMode", NULL,
       "<1 or 0>", "Enable USBSID read mode (disables cycled writing & digiplay)" },
     { "-usaudiomode", SET_RESOURCE, CMDLINE_ATTRIB_NEED_ARGS,
       NULL, NULL, "SidUSBSIDAudioMode", NULL,
       "<1 or 0>", "Set audio to Stereo(1) or Mono(0) (Default)" },
+    { "-usdiffsize", SET_RESOURCE, CMDLINE_ATTRIB_NEED_ARGS,
+      NULL, NULL, "SidUSBSIDDiffSize", NULL,
+      "<n divisable by 8>", "Write buffer head -> tail diff size (default: 64)" },
+    { "-usbuffsize", SET_RESOURCE, CMDLINE_ATTRIB_NEED_ARGS,
+      NULL, NULL, "SidUSBSIDBufferSize", NULL,
+      "<n divisable by 8>", "Write buffer size (default: 8192)" },
+
+    // { "-usreadmode", CALL_FUNCTION, CMDLINE_ATTRIB_NEED_ARGS,
+    //   us_setparam, "rw", "SidUSBSIDReadMode", NULL,
+    //   "<1 or 0>", "Enable USBSID read mode (disables cycled writing & digiplay)" },
+    // { "-usaudiomode", CALL_FUNCTION, CMDLINE_ATTRIB_NEED_ARGS,
+    //   us_setparam, "audio", "SidUSBSIDAudioMode", NULL,
+    //   "<1 or 0>", "Set audio to Stereo(1) or Mono(0) (Default)" },
+    // { "-usbuffsize", CALL_FUNCTION, CMDLINE_ATTRIB_NEED_ARGS,
+    //   us_setparam, "buff", "SidUSBSIDBufferSize", NULL,
+    //   "<n divisable by 8>", "Write buffer size (default: 8192)" },
+    // { "-usdiffsize", CALL_FUNCTION, CMDLINE_ATTRIB_NEED_ARGS,
+    //   us_setparam, "diff", "SidUSBSIDDiffSize", NULL,
+    //   "<n divisable by 8>", "Write buffer head -> tail diff size (default: 64)" },
     CMDLINE_LIST_END
 };
 #endif
@@ -493,7 +545,7 @@ static char *build_sid_engine_cmdline_option(int sid_type)
 #endif
 
 #ifdef HAVE_USBSID
-    /* add hardsid options if available */
+    /* add usbsid options if available */
     if (usbsid_available()) {
         new = util_concat(old, ", 5: USBSID", NULL);
         lib_free(old);

vice/src/sid/sid-cmdline-options.h

@@ -31,6 +31,10 @@
 int sid_cmdline_options_init(int sid_type);
 int sid_common_set_engine_model(const char *param, void *extra_param);
 
+#ifdef HAVE_USBSID
+int us_setparam(const char *param, void *extra_param);
+#endif
+
 void sid_cmdline_options_shutdown(void);
 
 #endif

vice/src/sid/sid-resources.c

@@ -90,6 +90,8 @@ static int sid_hardsid_right;
 #ifdef HAVE_USBSID
 static int sid_usbsid_readmode;
 static int sid_usbsid_audiomode;
+static int sid_usbsid_buffsize;
+static int sid_usbsid_diffsize;
 #endif
 
 static int set_sid_engine(int set_engine, void *param)
@@ -383,6 +385,22 @@ static int set_sid_usbsid_audiomode(int val, void *param)
 
     return 0;
 }
+
+static int set_sid_usbsid_buffsize(int val, void *param)
+{
+    sid_usbsid_buffsize = (unsigned int)val;
+    usbsid_drv_set_buffsize(sid_usbsid_buffsize);
+
+    return 0;
+}
+
+static int set_sid_usbsid_diffsize(int val, void *param)
+{
+    sid_usbsid_diffsize = (unsigned int)val;
+    usbsid_drv_set_diffsize(sid_usbsid_diffsize);
+
+    return 0;
+}
 #endif
 
 
@@ -474,6 +492,10 @@ static const resource_int_t usbsid_resources_int[] = {
       &sid_usbsid_readmode, set_sid_usbsid_readmode, NULL },
     { "SidUSBSIDAudioMode", 0, RES_EVENT_NO, NULL,
       &sid_usbsid_audiomode, set_sid_usbsid_audiomode, NULL },
+    { "SidUSBSIDDiffSize", 64, RES_EVENT_NO, NULL,
+      &sid_usbsid_diffsize, set_sid_usbsid_diffsize, NULL },
+    { "SidUSBSIDBufferSize", 8192, RES_EVENT_NO, NULL,
+      &sid_usbsid_buffsize, set_sid_usbsid_buffsize, NULL },
     RESOURCE_INT_LIST_END
 };
 #endif
@@ -519,11 +541,9 @@ int sid_common_resources_init(void)
 #endif
 
 #ifdef HAVE_USBSID
-    // if (usbsid_available()) {
     if (resources_register_int(usbsid_resources_int) < 0) {
         return -1;
     }
-    // }
 #endif
 
     return resources_register_int(common_resources_int);

vice/src/sid/sid.c

@@ -639,7 +639,7 @@ void sid_sound_machine_reset(sound_t *psid, CLOCK cpu_clk)
 {
     sid_engine.reset(psid, cpu_clk);
     #ifdef HAVE_USBSID
-    usbsid_reset(false); /* This is called when the STOP button is pressed */
+    usbsid_reset(true); /* This is called when the STOP button is pressed */
     #endif
 }
 

vice/src/sid/usbsid.c

@@ -156,6 +156,27 @@ void usbsid_set_audiomode(int val)
     }
 }
 
+void usbsid_restart_ringbuffer(void)
+{
+    if (!usbsid_is_open) {
+        usbsid_drv_restart_ringbuffer();
+    }
+}
+
+void usbsid_set_buffsize(int val)
+{
+    if (!usbsid_is_open) {
+        usbsid_drv_set_buffsize(val);
+    }
+}
+
+void usbsid_set_diffsize(int val)
+{
+    if (!usbsid_is_open) {
+        usbsid_drv_set_diffsize(val);
+    }
+}
+
 
 /* ---------------------------------------------------------------------*/
 

vice/src/usbsid.h

@@ -43,6 +43,9 @@ void usbsid_set_machine_parameter(long cycles_per_sec);
 int usbsid_available(void);
 void usbsid_set_audiomode(int val);
 void usbsid_set_readmode(int val);
+void usbsid_restart_ringbuffer(void);
+void usbsid_set_buffsize(int val);
+void usbsid_set_diffsize(int val);
 
 int usbsid_drv_open(void);
 int usbsid_drv_close(void);
@@ -53,6 +56,9 @@ void usbsid_drv_set_machine_parameter(long cycles_per_sec);
 int usbsid_drv_available(void);
 void usbsid_drv_set_audiomode(int val);
 void usbsid_drv_set_readmode(int val);
+void usbsid_drv_restart_ringbuffer(void);
+void usbsid_drv_set_buffsize(int val);
+void usbsid_drv_set_diffsize(int val);
 
 void usbsid_state_read(int chipno, struct sid_us_snapshot_state_s *sid_state);
 void usbsid_state_write(int chipno, struct sid_us_snapshot_state_s *sid_state);