]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - snd_main.c
added snd_soundradius cvar (default 1000 as before) to allow games (Nexuiz for instan...
[xonotic/darkplaces.git] / snd_main.c
index 18cc555a93d4da94791385b282f94087f631dcc5..3273355c56b26c7dd0d56c3edf0dc4319f21a585 100644 (file)
@@ -26,7 +26,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 
 #define SND_MIN_SPEED 8000
-#define SND_MAX_SPEED 96000
+#define SND_MAX_SPEED 48000
 #define SND_MIN_WIDTH 1
 #define SND_MAX_WIDTH 2
 #define SND_MIN_CHANNELS 1
@@ -53,6 +53,9 @@ speakerlayout_t;
 
 static speakerlayout_t snd_speakerlayout;
 
+// Our speaker layouts are based on ALSA. They differ from those
+// Win32 and Mac OS X APIs use when there's more than 4 channels.
+// (rear left + rear right, and front center + LFE are swapped).
 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
 static const speakerlayout_t snd_speakerlayouts[] =
 {
@@ -138,12 +141,11 @@ unsigned int total_channels;
 snd_ringbuffer_t *snd_renderbuffer = NULL;
 unsigned int soundtime = 0;
 static unsigned int oldpaintedtime = 0;
-unsigned int extrasoundtime = 0;
+static unsigned int extrasoundtime = 0;
 static double snd_starttime = 0.0;
 
 vec3_t listener_origin;
 matrix4x4_t listener_matrix[SND_LISTENERS];
-vec_t sound_nominal_clip_dist=1000.0;
 mempool_t *snd_mempool;
 
 // Linked list of known sfx
@@ -153,18 +155,25 @@ static qboolean sound_spatialized = false;
 
 qboolean simsound = false;
 
+static qboolean recording_sound = false;
+
 int snd_blocked = 0;
+static int current_swapstereo = false;
+static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
+static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
 
 // Cvars declared in sound.h (part of the sound API)
 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
+cvar_t snd_soundradius = {0, "snd_soundradius", "1000", "radius of weapon sounds and other standard sound effects (monster idle noises are half this radius and flickering light noises are one third of this radius)"};
 
 // Cvars declared in snd_main.h (shared with other snd_*.c files)
 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1", "how much sound to mix ahead of time"};
 cvar_t snd_streaming = { CVAR_SAVE, "snd_streaming", "1", "enables keeping compressed ogg sound files compressed, decompressing them only as needed, otherwise they will be decompressed completely at load (may use a lot of memory)"};
 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
+cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
 
 // Local cvars
 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
@@ -255,7 +264,7 @@ static void S_SoundList_f (void)
                {
                        unsigned int size;
                        const snd_format_t* format;
-                       
+
                        size = sfx->memsize;
                        format = sfx->fetcher->getfmt(sfx);
                        Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
@@ -292,54 +301,162 @@ void S_SoundInfo_f(void)
 }
 
 
-// TODO: make this function smarter...
+int S_GetSoundRate(void)
+{
+       return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
+}
+
+
 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
 {
-       // Can we decrease the number of channels?
-       if (!fixed_channels && format->channels > 1)
+       static const snd_format_t thresholds [] =
        {
-               unsigned short channels = format->channels;
+               // speed                        width                   channels
+               { SND_MIN_SPEED,        SND_MIN_WIDTH,  SND_MIN_CHANNELS },
+               { 11025,                        1,                              2 },
+               { 22050,                        2,                              2 },
+               { 44100,                        2,                              2 },
+               { 48000,                        2,                              6 },
+               { SND_MAX_SPEED,        SND_MAX_WIDTH,  SND_MAX_CHANNELS },
+       };
+       const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
+       unsigned int speed_level, width_level, channels_level;
+
+       // If we have reached the minimum values, there's nothing more we can do
+       if ((format->speed == thresholds[0].speed || fixed_speed) &&
+               (format->width == thresholds[0].width || fixed_width) &&
+               (format->channels == thresholds[0].channels || fixed_channels))
+               return false;
 
-               // If it has an odd number of channels(?!), make it even
-               if (channels & 1)
-                       channels--;
-               else
-               {
-                       // Remove 2 speakers, unless it's a stereo format
-                       if (channels != 2)
-                               channels -= 2;
-                       else
-                               channels = 1;
-               }
+       // Check the min and max values
+       #define CHECK_BOUNDARIES(param)                                                         \
+       if (format->param < thresholds[0].param)                                        \
+       {                                                                                                                       \
+               format->param = thresholds[0].param;                                    \
+               return true;                                                                                    \
+       }                                                                                                                       \
+       if (format->param > thresholds[nb_thresholds - 1].param)        \
+       {                                                                                                                       \
+               format->param = thresholds[nb_thresholds - 1].param;    \
+               return true;                                                                                    \
+       }
+       CHECK_BOUNDARIES(speed);
+       CHECK_BOUNDARIES(width);
+       CHECK_BOUNDARIES(channels);
+       #undef CHECK_BOUNDARIES
+
+       // Find the level of each parameter
+       #define FIND_LEVEL(param)                                                                       \
+       param##_level = 0;                                                                                      \
+       while (param##_level < nb_thresholds - 1)                                       \
+       {                                                                                                                       \
+               if (format->param <= thresholds[param##_level].param)   \
+                       break;                                                                                          \
+                                                                                                                               \
+               param##_level++;                                                                                \
+       }
+       FIND_LEVEL(speed);
+       FIND_LEVEL(width);
+       FIND_LEVEL(channels);
+       #undef FIND_LEVEL
 
-               format->channels = channels;
+       // Decrease the parameter with the highest level to the previous level
+       if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
+       {
+               format->channels = thresholds[channels_level - 1].channels;
                return true;
        }
+       if (speed_level >= width_level && !fixed_speed)
+       {
+               format->speed = thresholds[speed_level - 1].speed;
+               return true;
+       }
+
+       format->width = thresholds[width_level - 1].width;
+       return true;
+}
+
+
+#define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
+
+static void S_SetChannelLayout (void)
+{
+       unsigned int i;
+       listener_t swaplistener;
+       listener_t *listeners;
+       int layout;
+
+       for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
+               if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
+                       break;
+       if (i >= SND_SPEAKERLAYOUTS)
+       {
+               Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
+                                  snd_renderbuffer->format.channels);
+               i = SND_SPEAKERLAYOUTS - 1;
+       }
+
+       snd_speakerlayout = snd_speakerlayouts[i];
+       listeners = snd_speakerlayout.listeners;
 
-       // Can we decrease the speed?
-       if (!fixed_speed)
+       // Swap the left and right channels if snd_swapstereo is set
+       if (snd_swapstereo.integer)
        {
-               unsigned int suggest_speeds [] = { 44100, 22050, 11025 };
-               unsigned int i;
-               
-               for (i = 0; i < sizeof(suggest_speeds) / sizeof(suggest_speeds[0]); i++)
-                       if (format->speed > suggest_speeds[i])
-                       {
-                               format->speed = suggest_speeds[i];
-                               return true;
-                       }
+               switch (snd_speakerlayout.channels)
+               {
+                       case 8:
+                               SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
+                               // no break
+                       case 4:
+                       case 6:
+                               SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
+                               // no break
+                       case 2:
+                               SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
+                               break;
+
+                       default:
+                       case 1:
+                               // Nothing to do
+                               break;
+               }
+       }
+
+       // Sanity check
+       if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
+               snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
+               Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
 
-               // the speed is already low
+       if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
+       {
+               // If we're in the sound engine initialization
+               if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
+               {
+                       layout = SND_CHANNELLAYOUT_STANDARD;
+                       Cvar_SetValueQuick (&snd_channellayout, layout);
+               }
+               else
+                       layout = current_channellayout_used;
        }
+       else
+               layout = snd_channellayout.integer;
 
-       // Can we decrease the number of bits per sample?
-       if (!fixed_width && format->width > 1)
+       // Convert our layout (= ALSA) to the standard layout if necessary
+       if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
        {
-               format->width = 1;
-               return true;
+               if (layout == SND_CHANNELLAYOUT_STANDARD)
+               {
+                       SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
+                       SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
+               }
+
+               Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
+                                  (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
        }
 
-       return false;
+       current_swapstereo = snd_swapstereo.integer;
+       current_channellayout = snd_channellayout.integer;
+       current_channellayout_used = layout;
 }
 
 
@@ -350,7 +467,6 @@ void S_Startup (void)
        static snd_format_t prev_render_format = {0, 0, 0};
        const char* env;
        int i;
-       unsigned int layout_id;
 
        if (!snd_initialized.integer)
                return;
@@ -429,7 +545,7 @@ void S_Startup (void)
                        chosen_fmt.speed = prev_render_format.speed;
                }
        }
-       
+
        // Sanity checks
        if (chosen_fmt.speed < SND_MIN_SPEED)
        {
@@ -463,7 +579,7 @@ void S_Startup (void)
                chosen_fmt.channels = SND_MAX_CHANNELS;
                fixed_channels = false;
        }
-       
+
        // create the sound buffer used for sumitting the samples to the plaform-dependent module
        if (!simsound)
        {
@@ -517,9 +633,15 @@ void S_Startup (void)
                           chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
 
        // Update the cvars
-       snd_speed.integer = chosen_fmt.speed;
-       snd_width.integer = chosen_fmt.width;
-       snd_channels.integer = chosen_fmt.channels;
+       if (snd_speed.integer != (int)chosen_fmt.speed)
+               Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
+       if (snd_width.integer != chosen_fmt.width)
+               Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
+       if (snd_channels.integer != chosen_fmt.channels)
+               Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
+
+       current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
+       S_SetChannelLayout();
 
        snd_starttime = realtime;
 
@@ -540,19 +662,7 @@ void S_Startup (void)
                extrasoundtime = 0;
        snd_renderbuffer->startframe = soundtime;
        snd_renderbuffer->endframe = soundtime;
-
-       // select speaker layout
-       for (layout_id = 0; layout_id < SND_SPEAKERLAYOUTS; layout_id++)
-               if (snd_speakerlayouts[layout_id].channels == snd_renderbuffer->format.channels)
-                       break;
-       if (layout_id >= SND_SPEAKERLAYOUTS)
-       {
-               Con_Printf("S_Startup: invalid number of channels (%hu). Can't find the corresponding speaker layout.\n"
-                                  "Defaulting to mono output\n",
-                                  snd_renderbuffer->format.channels);
-               layout_id = SND_SPEAKERLAYOUTS - 1;
-       }
-       snd_speakerlayout = snd_speakerlayouts[layout_id];
+       recording_sound = false;
 }
 
 void S_Shutdown(void)
@@ -625,6 +735,8 @@ void S_Init(void)
        Cvar_RegisterVariable(&snd_show);
        Cvar_RegisterVariable(&_snd_mixahead);
        Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
+       Cvar_RegisterVariable(&snd_channellayout);
+       Cvar_RegisterVariable(&snd_soundradius);
 
        Cvar_SetValueQuick(&snd_initialized, true);
 
@@ -1029,10 +1141,10 @@ void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags,
        {
                if (sfx->loopstart == -1)
                        Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
-               target_chan->dist_mult = attenuation / (64.0f * sound_nominal_clip_dist);
+               target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
        }
        else
-               target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
+               target_chan->dist_mult = attenuation / snd_soundradius.value;
 
        // Lock the SFX during play
        S_LockSfx (sfx);
@@ -1047,11 +1159,9 @@ int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float f
 
        if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
                return -1;
-       if (!sfx->fetcher)
-       {
-               Con_DPrintf ("S_StartSound: \"%s\" hasn't been precached\n", sfx->name);
+
+       if (sfx->fetcher == NULL)
                return -1;
-       }
 
        if (entnum && entnum >= cl.max_entities)
                CL_ExpandEntities(entnum);
@@ -1167,7 +1277,7 @@ void S_StopAllSounds (void)
        {
                int clear;
                size_t memsize;
-               
+
                clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
                memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
                memset(snd_renderbuffer->ring, clear, memsize);
@@ -1279,22 +1389,46 @@ static void S_PaintAndSubmit (void)
 {
        unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
 
-       if (snd_renderbuffer == NULL || snd_blocked > 0)
+       if (snd_renderbuffer == NULL || nosound.integer)
+               return;
+
+       if (snd_blocked > 0 && !(cls.capturevideo.soundrate && !cls.capturevideo.realtime))
                return;
 
        // Update sound time
-       if (cls.capturevideo_soundfile) // SUPER NASTY HACK to record non-realtime sound
-               newsoundtime = (unsigned int)((double)cls.capturevideo_frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo_framerate);
+       if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
+               newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
        else if (simsound)
                newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
        else
                newsoundtime = SndSys_GetSoundTime();
-       
+
        newsoundtime += extrasoundtime;
        if (newsoundtime < soundtime)
-               Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
-                                  newsoundtime, soundtime);
+       {
+               if ((cls.capturevideo.soundrate != 0) != recording_sound)
+               {
+                       unsigned int additionaltime;
+
+                       // add some time to extrasoundtime make newsoundtime higher
+
+                       // The extra time must be a multiple of the render buffer size
+                       // to avoid modifying the current position in the buffer,
+                       // some modules write directly to a shared (DMA) buffer
+                       additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
+                       additionaltime -= additionaltime % snd_renderbuffer->maxframes;
+
+                       extrasoundtime += additionaltime;
+                       newsoundtime += additionaltime;
+                       Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
+                                               extrasoundtime);
+               }
+               else
+                       Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
+                                          newsoundtime, soundtime);
+       }
        soundtime = newsoundtime;
+       recording_sound = (cls.capturevideo.soundrate != 0);
 
        // Check to make sure that we haven't overshot
        paintedtime = snd_renderbuffer->endframe;
@@ -1328,9 +1462,17 @@ void S_Update(const matrix4x4_t *listenermatrix)
        channel_t *ch, *combine;
        matrix4x4_t basematrix, rotatematrix;
 
-       if (!snd_initialized.integer || snd_blocked > 0 || snd_renderbuffer == NULL)
+       if (snd_renderbuffer == NULL || nosound.integer)
+               return;
+
+       if (snd_blocked > 0 && !(cls.capturevideo.soundrate && !cls.capturevideo.realtime))
                return;
 
+       // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
+       if (current_swapstereo != snd_swapstereo.integer ||
+               current_channellayout != snd_channellayout.integer)
+               S_SetChannelLayout();
+
        Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
        Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);