SDL: audio: Rename SDL_GetAudioStreamBinding to SDL_GetAudioStreamDevice.

SDLPushPostBot · August 27, 2023, 8:56pm

From 58c859f64db25d30efe966c7e189c2894535f469 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Sun, 27 Aug 2023 16:34:26 -0400
Subject: [PATCH] audio: Rename SDL_GetAudioStreamBinding to
 SDL_GetAudioStreamDevice.

---
 docs/README-migration.md          |  4 ++--
 include/SDL3/SDL_audio.h          | 10 +++++-----
 src/audio/SDL_audio.c             |  2 +-
 src/dynapi/SDL_dynapi.sym         |  2 +-
 src/dynapi/SDL_dynapi_overrides.h |  2 +-
 src/dynapi/SDL_dynapi_procs.h     |  2 +-
 test/loopwave.c                   |  2 +-
 test/testaudiocapture.c           |  4 ++--
 test/testaudiohotplug.c           |  2 +-
 test/testmultiaudio.c             |  4 ++--
 test/testsurround.c               |  2 +-
 11 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/docs/README-migration.md b/docs/README-migration.md
index 5d03f0e42234..26bf2178417f 100644
--- a/docs/README-migration.md
+++ b/docs/README-migration.md
@@ -94,7 +94,7 @@ In SDL2, you might have done something like this to play audio...
     /* ...somewhere near startup... */
     const SDL_AudioSpec spec = { SDL_AUDIO_S16, 2, 44100 };
     SDL_AudioStream *stream = SDL_OpenAudioDeviceStream(SDL_AUDIO_DEVICE_DEFAULT_OUTPUT, &spec, MyAudioCallback, &my_audio_callback_user_data);
-    SDL_ResumeAudioDevice(SDL_GetAudioStreamBinding(stream));
+    SDL_ResumeAudioDevice(SDL_GetAudioStreamDevice(stream));

If you used SDL_QueueAudio instead of a callback in SDL2, this is also straightforward.
@@ -103,7 +103,7 @@ If you used SDL_QueueAudio instead of a callback in SDL2, this is also straightf
/* …somewhere near startup… */
const SDL_AudioSpec spec = { SDL_AUDIO_S16, 2, 44100 };
SDL_AudioStream *stream = SDL_OpenAudioDeviceStream(SDL_AUDIO_DEVICE_DEFAULT_OUTPUT, &spec, NULL, NULL);

SDL_ResumeAudioDevice(SDL_GetAudioStreamBinding(stream));

SDL_ResumeAudioDevice(SDL_GetAudioStreamDevice(stream));

/* …in your main loop… /
/ calculate a little more audio into buf, add it to stream */
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index d9f35abcb19e…03ce0240c263 100644
— a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -549,7 +549,7 @@ extern DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID devid);

\sa SDL_BindAudioStreams
\sa SDL_UnbindAudioStreams
\sa SDL_UnbindAudioStream

- \sa SDL_GetAudioStreamBinding

- \sa SDL_GetAudioStreamDevice
  */
  extern DECLSPEC int SDLCALL SDL_BindAudioStreams(SDL_AudioDeviceID devid, SDL_AudioStream **streams, int num_streams);

@@ -571,7 +571,7 @@ extern DECLSPEC int SDLCALL SDL_BindAudioStreams(SDL_AudioDeviceID devid, SDL_Au

\sa SDL_BindAudioStreams
\sa SDL_UnbindAudioStreams
\sa SDL_UnbindAudioStream

- \sa SDL_GetAudioStreamBinding

- \sa SDL_GetAudioStreamDevice
  */
  extern DECLSPEC int SDLCALL SDL_BindAudioStream(SDL_AudioDeviceID devid, SDL_AudioStream *stream);

@@ -595,7 +595,7 @@ extern DECLSPEC int SDLCALL SDL_BindAudioStream(SDL_AudioDeviceID devid, SDL_Aud

\sa SDL_BindAudioStreams
\sa SDL_BindAudioStream
\sa SDL_UnbindAudioStream

- \sa SDL_GetAudioStreamBinding

- \sa SDL_GetAudioStreamDevice
  */
  extern DECLSPEC void SDLCALL SDL_UnbindAudioStreams(SDL_AudioStream **streams, int num_streams);

@@ -614,7 +614,7 @@ extern DECLSPEC void SDLCALL SDL_UnbindAudioStreams(SDL_AudioStream **streams, i

\sa SDL_BindAudioStream
\sa SDL_BindAudioStreams
\sa SDL_UnbindAudioStreams

- \sa SDL_GetAudioStreamBinding

- \sa SDL_GetAudioStreamDevice
  */
  extern DECLSPEC void SDLCALL SDL_UnbindAudioStream(SDL_AudioStream *stream);

@@ -638,7 +638,7 @@ extern DECLSPEC void SDLCALL SDL_UnbindAudioStream(SDL_AudioStream *stream);

\sa SDL_UnbindAudioStream
\sa SDL_UnbindAudioStreams
*/
-extern DECLSPEC SDL_AudioDeviceID SDLCALL SDL_GetAudioStreamBinding(SDL_AudioStream *stream);
+extern DECLSPEC SDL_AudioDeviceID SDLCALL SDL_GetAudioStreamDevice(SDL_AudioStream *stream);

/**
diff --git a/src/audio/SDL_audio.c b/src/audio/SDL_audio.c
index 722a6f2e1883…bcf8c046b61b 100644
— a/src/audio/SDL_audio.c
+++ b/src/audio/SDL_audio.c
@@ -1498,7 +1498,7 @@ void SDL_UnbindAudioStream(SDL_AudioStream *stream)
SDL_UnbindAudioStreams(&stream, 1);
}

-SDL_AudioDeviceID SDL_GetAudioStreamBinding(SDL_AudioStream *stream)
+SDL_AudioDeviceID SDL_GetAudioStreamDevice(SDL_AudioStream *stream)
{
SDL_AudioDeviceID retval = 0;
if (stream) {
diff --git a/src/dynapi/SDL_dynapi.sym b/src/dynapi/SDL_dynapi.sym
index fc64d2f4f1eb…bf92d4b9a78a 100644
— a/src/dynapi/SDL_dynapi.sym
+++ b/src/dynapi/SDL_dynapi.sym
@@ -886,7 +886,7 @@ SDL3_0.0.0 {
SDL_PauseAudioDevice;
SDL_ResumeAudioDevice;
SDL_IsAudioDevicePaused;

SDL_GetAudioStreamBinding;

SDL_GetAudioStreamDevice;
SDL_ShowWindowSystemMenu;
SDL_ReadS16LE;
SDL_ReadS16BE;
diff --git a/src/dynapi/SDL_dynapi_overrides.h b/src/dynapi/SDL_dynapi_overrides.h
index 33be02cd4da5…1d038f6fd85b 100644
— a/src/dynapi/SDL_dynapi_overrides.h
+++ b/src/dynapi/SDL_dynapi_overrides.h
@@ -911,7 +911,7 @@
#define SDL_PauseAudioDevice SDL_PauseAudioDevice_REAL
#define SDL_ResumeAudioDevice SDL_ResumeAudioDevice_REAL
#define SDL_IsAudioDevicePaused SDL_IsAudioDevicePaused_REAL
-#define SDL_GetAudioStreamBinding SDL_GetAudioStreamBinding_REAL
+#define SDL_GetAudioStreamDevice SDL_GetAudioStreamDevice_REAL
#define SDL_ShowWindowSystemMenu SDL_ShowWindowSystemMenu_REAL
#define SDL_ReadS16LE SDL_ReadS16LE_REAL
#define SDL_ReadS16BE SDL_ReadS16BE_REAL
diff --git a/src/dynapi/SDL_dynapi_procs.h b/src/dynapi/SDL_dynapi_procs.h
index 6c933ee828a5…f0a3e4c62b75 100644
— a/src/dynapi/SDL_dynapi_procs.h
+++ b/src/dynapi/SDL_dynapi_procs.h
@@ -955,7 +955,7 @@ SDL_DYNAPI_PROC(int,SDL_LoadWAV,(const char *a, SDL_AudioSpec *b, Uint8 **c, Uin
SDL_DYNAPI_PROC(int,SDL_PauseAudioDevice,(SDL_AudioDeviceID a),(a),return)
SDL_DYNAPI_PROC(int,SDL_ResumeAudioDevice,(SDL_AudioDeviceID a),(a),return)
SDL_DYNAPI_PROC(SDL_bool,SDL_IsAudioDevicePaused,(SDL_AudioDeviceID a),(a),return)
-SDL_DYNAPI_PROC(SDL_AudioDeviceID,SDL_GetAudioStreamBinding,(SDL_AudioStream *a),(a),return)
+SDL_DYNAPI_PROC(SDL_AudioDeviceID,SDL_GetAudioStreamDevice,(SDL_AudioStream *a),(a),return)
SDL_DYNAPI_PROC(int,SDL_ShowWindowSystemMenu,(SDL_Window *a, int b, int c),(a,b,c),return)
SDL_DYNAPI_PROC(SDL_bool,SDL_ReadS16LE,(SDL_RWops *a, Sint16 *b),(a,b),return)
SDL_DYNAPI_PROC(SDL_bool,SDL_ReadS16BE,(SDL_RWops *a, Sint16 *b),(a,b),return)
diff --git a/test/loopwave.c b/test/loopwave.c
index e07773aef4e5…5e5921965272 100644
— a/test/loopwave.c
+++ b/test/loopwave.c
@@ -72,7 +72,7 @@ open_audio(void)
SDL_free(wave.sound);
quit(2);
}

SDL_ResumeAudioDevice(SDL_GetAudioStreamBinding(stream));

SDL_ResumeAudioDevice(SDL_GetAudioStreamDevice(stream));
}

diff --git a/test/testaudiocapture.c b/test/testaudiocapture.c
index fdecc1838514…4bdb0dfdc497 100644
— a/test/testaudiocapture.c
+++ b/test/testaudiocapture.c
@@ -28,8 +28,8 @@ static int done = 0;

static void loop(void)
{

const SDL_AudioDeviceID devid_in = SDL_GetAudioStreamBinding(stream_in);
const SDL_AudioDeviceID devid_out = SDL_GetAudioStreamBinding(stream_out);

const SDL_AudioDeviceID devid_in = SDL_GetAudioStreamDevice(stream_in);
const SDL_AudioDeviceID devid_out = SDL_GetAudioStreamDevice(stream_out);
SDL_bool please_quit = SDL_FALSE;
SDL_Event e;

diff --git a/test/testaudiohotplug.c b/test/testaudiohotplug.c
index 34caf696a6c2…6f3198488201 100644
— a/test/testaudiohotplug.c
+++ b/test/testaudiohotplug.c
@@ -88,7 +88,7 @@ static void iteration(void)
/* !!! FIXME: laziness, this used to loop the audio, but we’ll just play it once for now on each connect. */
SDL_PutAudioStreamData(stream, sound, soundlen);
SDL_FlushAudioStream(stream);

               SDL_ResumeAudioDevice(SDL_GetAudioStreamBinding(stream));

               SDL_ResumeAudioDevice(SDL_GetAudioStreamDevice(stream));
               /* !!! FIXME: this is leaking the stream for now. We'll wire it up to a dictionary or whatever later. */
           }
       }

diff --git a/test/testmultiaudio.c b/test/testmultiaudio.c
index e2e22d5d10cf…ecf0316cdecb 100644
— a/test/testmultiaudio.c
+++ b/test/testmultiaudio.c
@@ -66,7 +66,7 @@ test_multi_audio(SDL_AudioDeviceID *devices, int devcount)
if ((stream = SDL_OpenAudioDeviceStream(devices[i], &spec, NULL, NULL)) == NULL) {
SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, “Audio stream creation failed: %s”, SDL_GetError());
} else {

       SDL_ResumeAudioDevice(SDL_GetAudioStreamBinding(stream));

       SDL_ResumeAudioDevice(SDL_GetAudioStreamDevice(stream));
       SDL_PutAudioStreamData(stream, sound, soundlen);
       SDL_FlushAudioStream(stream);

#ifdef EMSCRIPTEN
@@ -107,7 +107,7 @@ test_multi_audio(SDL_AudioDeviceID devices, int devcount)
/ try to start all the devices about the same time. SDL does not guarantee sync across physical devices. */
for (i = 0; i < devcount; i++) {
if (streams[i]) {

           SDL_ResumeAudioDevice(SDL_GetAudioStreamBinding(streams[i]));

           SDL_ResumeAudioDevice(SDL_GetAudioStreamDevice(streams[i]));
       }
   }

diff --git a/test/testsurround.c b/test/testsurround.c
index 2d4604ea4e55…4bd51a907a95 100644
— a/test/testsurround.c
+++ b/test/testsurround.c
@@ -216,7 +216,7 @@ int main(int argc, char *argv[])
SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, “SDL_OpenAudioDeviceStream() failed: %s\n”, SDL_GetError());
continue;
}

   SDL_ResumeAudioDevice(SDL_GetAudioStreamBinding(stream));

   SDL_ResumeAudioDevice(SDL_GetAudioStreamDevice(stream));

   for (j = 0; j < total_channels; j++) {
       const int sine_freq = is_lfe_channel(j, total_channels) ? LFE_SINE_FREQ_HZ : SINE_FREQ_HZ;