]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - snd_win.c
revised commandline option comments for better categorization when sorted
[xonotic/darkplaces.git] / snd_win.c
index 23c9009182735e41b18865f3f68fa867c01225b3..a66bae5cc935379d0631fe0c6291869bed0df6c1 100644 (file)
--- a/snd_win.c
+++ b/snd_win.c
@@ -18,7 +18,10 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 */
 #include "quakedef.h"
-#include "winquake.h"
+#include <windows.h>
+#include <dsound.h>
+
+extern HWND mainwindow;
 
 #define iDirectSoundCreate(a,b,c)      pDirectSoundCreate(a,b,c)
 
@@ -190,23 +193,21 @@ sndinitstat SNDDMA_InitDirect (void)
        int                             reps;
        int i;
 
-       memset ((void *)&sn, 0, sizeof (sn));
-
-       shm = &sn;
-
-       shm->channels = 2;
-       shm->samplebits = 16;
-       i = COM_CheckParm ("-sndspeed"); // LordHavoc: -sndspeed option
+       memset((void *)shm, 0, sizeof(*shm));
+       shm->format.channels = 2;
+       shm->format.width = 2;
+// COMMANDLINEOPTION: Windows Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate
+       i = COM_CheckParm ("-sndspeed");
        if (i && i != (com_argc - 1))
-               shm->speed = atoi(com_argv[i+1]);
+               shm->format.speed = atoi(com_argv[i+1]);
        else
-               shm->speed = 44100;
+               shm->format.speed = 44100;
 
        memset (&format, 0, sizeof(format));
        format.wFormatTag = WAVE_FORMAT_PCM;
-    format.nChannels = shm->channels;
-    format.wBitsPerSample = shm->samplebits;
-    format.nSamplesPerSec = shm->speed;
+    format.nChannels = shm->format.channels;
+    format.wBitsPerSample = shm->format.width * 8;
+    format.nSamplesPerSec = shm->format.speed;
     format.nBlockAlign = format.nChannels * format.wBitsPerSample / 8;
     format.cbSize = 0;
     format.nAvgBytesPerSec = format.nSamplesPerSec * format.nBlockAlign;
@@ -217,7 +218,7 @@ sndinitstat SNDDMA_InitDirect (void)
 
                if (hInstDS == NULL)
                {
-                       Con_SafePrint("Couldn't load dsound.dll\n");
+                       Con_SafePrint("Couldn't load dsound.dll\n");
                        return SIS_FAILURE;
                }
 
@@ -225,7 +226,7 @@ sndinitstat SNDDMA_InitDirect (void)
 
                if (!pDirectSoundCreate)
                {
-                       Con_SafePrint("Couldn't get DS proc addr\n");
+                       Con_SafePrint("Couldn't get DS proc addr\n");
                        return SIS_FAILURE;
                }
        }
@@ -234,7 +235,7 @@ sndinitstat SNDDMA_InitDirect (void)
        {
                if (hresult != DSERR_ALLOCATED)
                {
-                       Con_SafePrint("DirectSound create failed\n");
+                       Con_SafePrint("DirectSound create failed\n");
                        return SIS_FAILURE;
                }
 
@@ -244,8 +245,7 @@ sndinitstat SNDDMA_InitDirect (void)
                                                "Sound not available",
                                                MB_RETRYCANCEL | MB_SETFOREGROUND | MB_ICONEXCLAMATION) != IDRETRY)
                {
-                       Con_SafePrintf ("DirectSoundCreate failure\n"
-                                                       "  hardware already in use\n");
+                       Con_SafePrint("DirectSoundCreate failure\n  hardware already in use\n");
                        return SIS_NOTAVAIL;
                }
        }
@@ -254,19 +254,19 @@ sndinitstat SNDDMA_InitDirect (void)
 
        if (DS_OK != pDS->lpVtbl->GetCaps (pDS, &dscaps))
        {
-               Con_SafePrint("Couldn't get DS caps\n");
+               Con_SafePrint("Couldn't get DS caps\n");
        }
 
        if (dscaps.dwFlags & DSCAPS_EMULDRIVER)
        {
-               Con_SafePrint("No DirectSound driver installed\n");
+               Con_SafePrint("No DirectSound driver installed\n");
                FreeSound ();
                return SIS_FAILURE;
        }
 
        if (DS_OK != pDS->lpVtbl->SetCooperativeLevel (pDS, mainwindow, DSSCL_EXCLUSIVE))
        {
-               Con_SafePrint("Set coop level failed\n");
+               Con_SafePrint("Set coop level failed\n");
                FreeSound ();
                return SIS_FAILURE;
        }
@@ -283,6 +283,7 @@ sndinitstat SNDDMA_InitDirect (void)
        dsbcaps.dwSize = sizeof(dsbcaps);
        primary_format_set = false;
 
+// COMMANDLINEOPTION: Windows DirectSound: -snoforceformat uses the format that DirectSound returns, rather than forcing it
        if (!COM_CheckParm ("-snoforceformat"))
        {
                if (DS_OK == pDS->lpVtbl->CreateSoundBuffer(pDS, &dsbuf, &pDSPBuf, NULL))
@@ -292,18 +293,19 @@ sndinitstat SNDDMA_InitDirect (void)
                        if (DS_OK != pDSPBuf->lpVtbl->SetFormat (pDSPBuf, &pformat))
                        {
                                if (snd_firsttime)
-                                       Con_SafePrint("Set primary sound buffer format: no\n");
+                                       Con_SafePrint("Set primary sound buffer format: no\n");
                        }
                        else
                        {
                                if (snd_firsttime)
-                                       Con_SafePrint("Set primary sound buffer format: yes\n");
+                                       Con_SafePrint("Set primary sound buffer format: yes\n");
 
                                primary_format_set = true;
                        }
                }
        }
 
+// COMMANDLINEOPTION: Windows DirectSound: -primarysound locks the sound hardware for exclusive use
        if (!primary_format_set || !COM_CheckParm ("-primarysound"))
        {
        // create the secondary buffer we'll actually work with
@@ -318,42 +320,42 @@ sndinitstat SNDDMA_InitDirect (void)
 
                if (DS_OK != pDS->lpVtbl->CreateSoundBuffer(pDS, &dsbuf, &pDSBuf, NULL))
                {
-                       Con_SafePrintf ("DS:CreateSoundBuffer Failed");
+                       Con_SafePrint("DS:CreateSoundBuffer Failed\n");
                        FreeSound ();
                        return SIS_FAILURE;
                }
 
-               shm->channels = format.nChannels;
-               shm->samplebits = format.wBitsPerSample;
-               shm->speed = format.nSamplesPerSec;
+               shm->format.channels = format.nChannels;
+               shm->format.width = format.wBitsPerSample / 8;
+               shm->format.speed = format.nSamplesPerSec;
 
                if (DS_OK != pDSBuf->lpVtbl->GetCaps (pDSBuf, &dsbcaps))
                {
-                       Con_SafePrint("DS:GetCaps failed\n");
+                       Con_SafePrint("DS:GetCaps failed\n");
                        FreeSound ();
                        return SIS_FAILURE;
                }
 
                if (snd_firsttime)
-                       Con_SafePrint("Using secondary sound buffer\n");
+                       Con_SafePrint("Using secondary sound buffer\n");
        }
        else
        {
                if (DS_OK != pDS->lpVtbl->SetCooperativeLevel (pDS, mainwindow, DSSCL_WRITEPRIMARY))
                {
-                       Con_SafePrint("Set coop level failed\n");
+                       Con_SafePrint("Set coop level failed\n");
                        FreeSound ();
                        return SIS_FAILURE;
                }
 
                if (DS_OK != pDSPBuf->lpVtbl->GetCaps (pDSPBuf, &dsbcaps))
                {
-                       Con_Print("DS:GetCaps failed\n");
+                       Con_Print("DS:GetCaps failed\n");
                        return SIS_FAILURE;
                }
 
                pDSBuf = pDSPBuf;
-               Con_SafePrint("Using primary sound buffer\n");
+               Con_SafePrint("Using primary sound buffer\n");
        }
 
        // Make sure mixer is active
@@ -363,25 +365,25 @@ sndinitstat SNDDMA_InitDirect (void)
                Con_SafePrintf("   %d channel(s)\n"
                               "   %d bits/sample\n"
                                           "   %d samples/sec\n",
-                                          shm->channels, shm->samplebits, shm->speed);
+                                          shm->format.channels, shm->format.width * 8, shm->format.speed);
 
        gSndBufSize = dsbcaps.dwBufferBytes;
 
 // initialize the buffer
        reps = 0;
 
-       while ((hresult = pDSBuf->lpVtbl->Lock(pDSBuf, 0, gSndBufSize, &lpData, &dwSize, NULL, NULL, 0)) != DS_OK)
+       while ((hresult = pDSBuf->lpVtbl->Lock(pDSBuf, 0, gSndBufSize, (LPVOID*)&lpData, &dwSize, NULL, NULL, 0)) != DS_OK)
        {
                if (hresult != DSERR_BUFFERLOST)
                {
-                       Con_SafePrint("SNDDMA_InitDirect: DS::Lock Sound Buffer Failed\n");
+                       Con_SafePrint("SNDDMA_InitDirect: DS::Lock Sound Buffer Failed\n");
                        FreeSound ();
                        return SIS_FAILURE;
                }
 
                if (++reps > 10000)
                {
-                       Con_SafePrint("SNDDMA_InitDirect: DS: couldn't restore buffer\n");
+                       Con_SafePrint("SNDDMA_InitDirect: DS: couldn't restore buffer\n");
                        FreeSound ();
                        return SIS_FAILURE;
                }
@@ -399,13 +401,10 @@ sndinitstat SNDDMA_InitDirect (void)
        pDSBuf->lpVtbl->GetCurrentPosition(pDSBuf, &mmstarttime.u.sample, &dwWrite);
        pDSBuf->lpVtbl->Play(pDSBuf, 0, 0, DSBPLAY_LOOPING);
 
-       shm->soundalive = true;
-       shm->splitbuffer = false;
-       shm->samples = gSndBufSize/(shm->samplebits/8);
+       shm->samples = gSndBufSize / shm->format.width;
        shm->samplepos = 0;
-       shm->submission_chunk = 1;
        shm->buffer = (unsigned char *) lpData;
-       sample16 = (shm->samplebits/8) - 1;
+       sample16 = shm->format.width - 1;
 
        dsound_init = true;
 
@@ -429,21 +428,21 @@ qboolean SNDDMA_InitWav (void)
        snd_sent = 0;
        snd_completed = 0;
 
-       shm = &sn;
-
-       shm->channels = 2;
-       shm->samplebits = 16;
+       memset((void *)shm, 0, sizeof(*shm));
+       shm->format.channels = 2;
+       shm->format.width = 2;
+// COMMANDLINEOPTION: Windows Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate
        i = COM_CheckParm ("-sndspeed"); // LordHavoc: -sndspeed option
        if (i && i != (com_argc - 1))
-               shm->speed = atoi(com_argv[i+1]);
+               shm->format.speed = atoi(com_argv[i+1]);
        else
-               shm->speed = 44100;
+               shm->format.speed = 44100;
 
        memset (&format, 0, sizeof(format));
        format.wFormatTag = WAVE_FORMAT_PCM;
-       format.nChannels = shm->channels;
-       format.wBitsPerSample = shm->samplebits;
-       format.nSamplesPerSec = shm->speed;
+       format.nChannels = shm->format.channels;
+       format.wBitsPerSample = shm->format.width * 8;
+       format.nSamplesPerSec = shm->format.speed;
        format.nBlockAlign = format.nChannels
                *format.wBitsPerSample / 8;
        format.cbSize = 0;
@@ -457,7 +456,7 @@ qboolean SNDDMA_InitWav (void)
        {
                if (hr != MMSYSERR_ALLOCATED)
                {
-                       Con_SafePrint("waveOutOpen failed\n");
+                       Con_SafePrint("waveOutOpen failed\n");
                        return false;
                }
 
@@ -467,8 +466,7 @@ qboolean SNDDMA_InitWav (void)
                                                "Sound not available",
                                                MB_RETRYCANCEL | MB_SETFOREGROUND | MB_ICONEXCLAMATION) != IDRETRY)
                {
-                       Con_SafePrintf ("waveOutOpen failure;\n"
-                                                       "  hardware already in use\n");
+                       Con_SafePrint("waveOutOpen failure;\n  hardware already in use\n");
                        return false;
                }
        }
@@ -483,14 +481,14 @@ qboolean SNDDMA_InitWav (void)
        hData = GlobalAlloc(GMEM_MOVEABLE | GMEM_SHARE, gSndBufSize);
        if (!hData)
        {
-               Con_SafePrint("Sound: Out of memory.\n");
+               Con_SafePrint("Sound: Out of memory.\n");
                FreeSound ();
                return false;
        }
        lpData = GlobalLock(hData);
        if (!lpData)
        {
-               Con_SafePrint("Sound: Failed to lock.\n");
+               Con_SafePrint("Sound: Failed to lock.\n");
                FreeSound ();
                return false;
        }
@@ -506,7 +504,7 @@ qboolean SNDDMA_InitWav (void)
 
        if (hWaveHdr == NULL)
        {
-               Con_SafePrint("Sound: Failed to Alloc header.\n");
+               Con_SafePrint("Sound: Failed to Alloc header.\n");
                FreeSound ();
                return false;
        }
@@ -515,7 +513,7 @@ qboolean SNDDMA_InitWav (void)
 
        if (lpWaveHdr == NULL)
        {
-               Con_SafePrint("Sound: Failed to lock header.\n");
+               Con_SafePrint("Sound: Failed to lock header.\n");
                FreeSound ();
                return false;
        }
@@ -531,19 +529,16 @@ qboolean SNDDMA_InitWav (void)
                if (waveOutPrepareHeader(hWaveOut, lpWaveHdr+i, sizeof(WAVEHDR)) !=
                                MMSYSERR_NOERROR)
                {
-                       Con_SafePrint("Sound: failed to prepare wave headers\n");
+                       Con_SafePrint("Sound: failed to prepare wave headers\n");
                        FreeSound ();
                        return false;
                }
        }
 
-       shm->soundalive = true;
-       shm->splitbuffer = false;
-       shm->samples = gSndBufSize/(shm->samplebits/8);
+       shm->samples = gSndBufSize / shm->format.width;
        shm->samplepos = 0;
-       shm->submission_chunk = 1;
        shm->buffer = (unsigned char *) lpData;
-       sample16 = (shm->samplebits/8) - 1;
+       sample16 = shm->format.width - 1;
 
        wav_init = true;
 
@@ -563,6 +558,7 @@ qboolean SNDDMA_Init(void)
 {
        sndinitstat     stat;
 
+// COMMANDLINEOPTION: Windows Sound: -wavonly uses wave sound instead of DirectSound
        if (COM_CheckParm ("-wavonly"))
                wavonly = true;
 
@@ -575,19 +571,19 @@ qboolean SNDDMA_Init(void)
        {
                if (snd_firsttime || snd_isdirect)
                {
-                       stat = SNDDMA_InitDirect ();;
+                       stat = SNDDMA_InitDirect ();
 
                        if (stat == SIS_SUCCESS)
                        {
                                snd_isdirect = true;
 
                                if (snd_firsttime)
-                                       Con_SafePrint("DirectSound initialized\n");
+                                       Con_SafePrint("DirectSound initialized\n");
                        }
                        else
                        {
                                snd_isdirect = false;
-                               Con_SafePrint("DirectSound failed to init\n");
+                               Con_SafePrint("DirectSound failed to init\n");
                        }
                }
        }
@@ -606,11 +602,11 @@ qboolean SNDDMA_Init(void)
                        if (snd_iswave)
                        {
                                if (snd_firsttime)
-                                       Con_SafePrint("Wave sound initialized\n");
+                                       Con_SafePrint("Wave sound initialized\n");
                        }
                        else
                        {
-                               Con_SafePrint("Wave sound failed to init\n");
+                               Con_SafePrint("Wave sound failed to init\n");
                        }
                }
        }
@@ -681,7 +677,7 @@ void SNDDMA_Submit(void)
        {
                if ( snd_completed == snd_sent )
                {
-                       Con_DPrint("Sound overrun\n");
+                       Con_DPrint("Sound overrun\n");
                        break;
                }
 
@@ -710,7 +706,7 @@ void SNDDMA_Submit(void)
 
                if (wResult != MMSYSERR_NOERROR)
                {
-                       Con_SafePrint("Failed to write block to device\n");
+                       Con_SafePrint("Failed to write block to device\n");
                        FreeSound ();
                        return;
                }
@@ -742,11 +738,11 @@ void *S_LockBuffer(void)
        {
                reps = 0;
 
-               while ((hresult = pDSBuf->lpVtbl->Lock(pDSBuf, 0, gSndBufSize, &dsound_pbuf, &dsound_dwSize, &dsound_pbuf2, &dsound_dwSize2, 0)) != DS_OK)
+               while ((hresult = pDSBuf->lpVtbl->Lock(pDSBuf, 0, gSndBufSize, (LPVOID*)&dsound_pbuf, &dsound_dwSize, (LPVOID*)&dsound_pbuf2, &dsound_dwSize2, 0)) != DS_OK)
                {
                        if (hresult != DSERR_BUFFERLOST)
                        {
-                               Con_Print("S_LockBuffer: DS::Lock Sound Buffer Failed\n");
+                               Con_Print("S_LockBuffer: DS::Lock Sound Buffer Failed\n");
                                S_Shutdown ();
                                S_Startup ();
                                return NULL;
@@ -754,7 +750,7 @@ void *S_LockBuffer(void)
 
                        if (++reps > 10000)
                        {
-                               Con_Print("S_LockBuffer: DS: couldn't restore buffer\n");
+                               Con_Print("S_LockBuffer: DS: couldn't restore buffer\n");
                                S_Shutdown ();
                                S_Startup ();
                                return NULL;
@@ -772,10 +768,3 @@ void S_UnlockBuffer(void)
                pDSBuf->lpVtbl->Unlock(pDSBuf, dsound_pbuf, dsound_dwSize, dsound_pbuf2, dsound_dwSize2);
 }
 
-void S_Open(void)
-{
-}
-
-void S_Close(void)
-{
-}