rnd-20030120-3-src
[rocksndiamonds.git] / src / libgame / sound.c
index d31bc586cb5c9c8a46622eb6aca0f219ecaa4d9b..9b0282bc6de704d38de2c9cffc894894accfd0bc 100644 (file)
 #define SOUND_FADING_VOLUME_THRESHOLD  (SOUND_FADING_VOLUME_STEP * 2)
 #endif
 
-#if !defined(PLATFORM_HPUX)
-#define SND_BLOCKSIZE                  4096
-#else
-#define SND_BLOCKSIZE                  32768
-#endif
-
 #define SND_TYPE_NONE                  0
 #define SND_TYPE_WAV                   1
 
@@ -124,6 +118,7 @@ struct SampleInfo
   int format;
   void *data_ptr;              /* pointer to first sample (8 or 16 bit) */
   long data_len;               /* number of samples, NOT number of bytes */
+  int num_channels;            /* mono: 1 channel, stereo: 2 channels */
 };
 typedef struct SampleInfo SoundInfo;
 typedef struct SampleInfo MusicInfo;
@@ -145,6 +140,7 @@ struct SoundControl
   int format;
   void *data_ptr;              /* pointer to first sample (8 or 16 bit) */
   long data_len;               /* number of samples, NOT number of bytes */
+  int num_channels;            /* mono: 1 channel, stereo: 2 channels */
 
 #if defined(TARGET_ALLEGRO)
   int voice;
@@ -152,10 +148,7 @@ struct SoundControl
 };
 typedef struct SoundControl SoundControl;
 
-static struct ArtworkListInfo sound_info;
-
-static struct ArtworkConfigInfo *sound_config = NULL;
-static ListNode *SoundFileList = NULL;
+static struct ArtworkListInfo *sound_info = NULL;
 static SoundInfo **Sound = NULL;
 static MusicInfo **Music = NULL;
 static int num_sounds = 0, num_music = 0;
@@ -842,10 +835,11 @@ static void Mixer_InsertSound(SoundControl snd_ctrl)
     return;
 
   /* copy sound sample and format information */
-  snd_ctrl.type     = snd_info->type;
-  snd_ctrl.format   = snd_info->format;
-  snd_ctrl.data_ptr = snd_info->data_ptr;
-  snd_ctrl.data_len = snd_info->data_len;
+  snd_ctrl.type         = snd_info->type;
+  snd_ctrl.format       = snd_info->format;
+  snd_ctrl.data_ptr     = snd_info->data_ptr;
+  snd_ctrl.data_len     = snd_info->data_len;
+  snd_ctrl.num_channels = snd_info->num_channels;
 
   /* play music samples on a dedicated music channel */
   if (IS_MUSIC(snd_ctrl))
@@ -959,11 +953,16 @@ static void Mixer_InsertSound(SoundControl snd_ctrl)
     unsigned long playing_current = Counter();
     int longest = 0, longest_nr = audio.first_sound_channel;
 
+#if 0
+#if DEBUG
+    /* print some debugging information about audio channel usage */
     for (i=audio.first_sound_channel; i<audio.num_channels; i++)
     {
       Error(ERR_RETURN, "Mixer_InsertSound: %d [%d]: %ld (%ld)",
            i, mixer[i].active, mixer[i].data_len, (long)mixer[i].data_ptr);
     }
+#endif
+#endif
 
     for (i=audio.first_sound_channel; i<audio.num_channels; i++)
     {
@@ -1113,33 +1112,54 @@ void StartMixer(void)
 
 static void CopySampleToMixingBuffer(SoundControl *snd_ctrl,
                                     int sample_pos, int sample_size,
-                                    short *buffer_ptr)
+                                    short *buffer_base_ptr, int buffer_pos,
+                                    int num_output_channels)
 {
-  void *sample_ptr = snd_ctrl->data_ptr;
-  int i;
+  short *buffer_ptr = buffer_base_ptr + num_output_channels * buffer_pos;
+  int num_channels = snd_ctrl->num_channels;
+  int stepsize = num_channels;
+  int output_stepsize = num_output_channels;
+  int i, j;
 
   if (snd_ctrl->format == AUDIO_FORMAT_U8)
-    for (i=0; i<sample_size; i++)
-      *buffer_ptr++ =
-       ((short)(((byte *)sample_ptr)[sample_pos + i] ^ 0x80)) << 8;
+  {
+    byte *sample_ptr = (byte *)snd_ctrl->data_ptr + num_channels * sample_pos;
+
+    for (i=0; i<num_output_channels; i++)
+    {
+      int offset = (snd_ctrl->num_channels == 1 ? 0 : i);
+
+      for (j=0; j<sample_size; j++)
+       buffer_ptr[output_stepsize * j + i] =
+         ((short)(sample_ptr[stepsize * j + offset] ^ 0x80)) << 8;
+    }
+  }
   else /* AUDIO_FORMAT_S16 */
-    for (i=0; i<sample_size; i++)
-      *buffer_ptr++ =
-       ((short *)sample_ptr)[sample_pos + i];
+  {
+    short *sample_ptr= (short *)snd_ctrl->data_ptr + num_channels * sample_pos;
+
+    for (i=0; i<num_output_channels; i++)
+    {
+      int offset = (snd_ctrl->num_channels == 1 ? 0 : i);
+
+      for (j=0; j<sample_size; j++)
+       buffer_ptr[output_stepsize * j + i] =
+         sample_ptr[stepsize * j + offset];
+    }
+  }
 }
 
 #if defined(AUDIO_STREAMING_DSP)
 static void Mixer_Main_DSP()
 {
-  static short premix_first_buffer[SND_BLOCKSIZE];
-  static short premix_left_buffer[SND_BLOCKSIZE];
-  static short premix_right_buffer[SND_BLOCKSIZE];
-  static long premix_last_buffer[SND_BLOCKSIZE];
-  static byte playing_buffer[SND_BLOCKSIZE];
+  static short premix_first_buffer[DEFAULT_AUDIO_FRAGMENT_SIZE];
+  static long premix_last_buffer[DEFAULT_AUDIO_FRAGMENT_SIZE];
+  static byte playing_buffer[DEFAULT_AUDIO_FRAGMENT_SIZE];
   boolean stereo;
   int fragment_size;
   int sample_bytes;
   int max_sample_size;
+  int num_output_channels;
   int i, j;
 
   if (!mixer_active_channels)
@@ -1156,11 +1176,12 @@ static void Mixer_Main_DSP()
   stereo = afmt.stereo;
   fragment_size = afmt.fragment_size;
   sample_bytes = (afmt.format & AUDIO_FORMAT_U8 ? 1 : 2);
-  max_sample_size = fragment_size / ((stereo ? 2 : 1) * sample_bytes);
+  num_output_channels = (stereo ? 2 : 1);
+  max_sample_size = fragment_size / (num_output_channels * sample_bytes);
 
   /* first clear the last premixing buffer */
   memset(premix_last_buffer, 0,
-        max_sample_size * (stereo ? 2 : 1) * sizeof(long));
+        max_sample_size * num_output_channels * sizeof(long));
 
   for(i=0; i<audio.num_channels; i++)
   {
@@ -1187,7 +1208,7 @@ static void Mixer_Main_DSP()
 
     /* copy original sample to first mixing buffer */
     CopySampleToMixingBuffer(&mixer[i], sample_pos, sample_size,
-                            premix_first_buffer);
+                            premix_first_buffer, 0, num_output_channels);
 
     /* are we about to restart a looping sound? */
     if (IS_LOOP(mixer[i]) && sample_size < max_sample_size)
@@ -1197,14 +1218,9 @@ static void Mixer_Main_DSP()
        int restarted_sample_size =
          MIN(max_sample_size - sample_size, sample_len);
 
-       if (mixer[i].format == AUDIO_FORMAT_U8)
-         for (j=0; j<restarted_sample_size; j++)
-           premix_first_buffer[sample_size + j] =
-             ((short)(((byte *)sample_ptr)[j] ^ 0x80)) << 8;
-       else
-         for (j=0; j<restarted_sample_size; j++)
-           premix_first_buffer[sample_size + j] =
-             ((short *)sample_ptr)[j];
+       CopySampleToMixingBuffer(&mixer[i], 0, restarted_sample_size,
+                                premix_first_buffer, sample_size,
+                                num_output_channels);
 
        mixer[i].playing_pos = restarted_sample_size;
        sample_size += restarted_sample_size;
@@ -1218,11 +1234,11 @@ static void Mixer_Main_DSP()
 
     /* adjust volume of actual sound sample */
     if (mixer[i].volume != SOUND_MAX_VOLUME)
-      for(j=0; j<sample_size; j++)
+      for(j=0; j<sample_size * num_output_channels; j++)
        premix_first_buffer[j] =
          mixer[i].volume * (long)premix_first_buffer[j] / SOUND_MAX_VOLUME;
 
-    /* fill the last mixing buffer with stereo or mono sound */
+    /* adjust left and right channel volume due to stereo sound position */
     if (stereo)
     {
       int left_volume  = SOUND_VOLUME_LEFT(mixer[i].stereo_position);
@@ -1230,20 +1246,16 @@ static void Mixer_Main_DSP()
 
       for(j=0; j<sample_size; j++)
       {
-       premix_left_buffer[j] =
-         left_volume  * premix_first_buffer[j] / SOUND_MAX_LEFT2RIGHT;
-       premix_right_buffer[j] =
-         right_volume * premix_first_buffer[j] / SOUND_MAX_LEFT2RIGHT;
-
-       premix_last_buffer[2 * j + 0] += premix_left_buffer[j];
-       premix_last_buffer[2 * j + 1] += premix_right_buffer[j];
+       premix_first_buffer[2 * j + 0] =
+         left_volume  * premix_first_buffer[2 * j + 0] / SOUND_MAX_LEFT2RIGHT;
+       premix_first_buffer[2 * j + 1] =
+         right_volume * premix_first_buffer[2 * j + 1] / SOUND_MAX_LEFT2RIGHT;
       }
     }
-    else
-    {
-      for(j=0; j<sample_size; j++)
-       premix_last_buffer[j] += premix_first_buffer[j];
-    }
+
+    /* fill the last mixing buffer with stereo or mono sound */
+    for(j=0; j<sample_size * num_output_channels; j++)
+      premix_last_buffer[j] += premix_first_buffer[j];
 
     /* delete completed sound entries from the mixer */
     if (mixer[i].playing_pos >= mixer[i].data_len)
@@ -1258,7 +1270,7 @@ static void Mixer_Main_DSP()
   }
 
   /* prepare final playing buffer according to system audio format */
-  for(i=0; i<max_sample_size * (stereo ? 2 : 1); i++)
+  for(i=0; i<max_sample_size * num_output_channels; i++)
   {
     /* cut off at 17 bit value */
     if (premix_last_buffer[i] < -65535)
@@ -1296,9 +1308,10 @@ static void Mixer_Main_DSP()
 
 static int Mixer_Main_SimpleAudio(SoundControl snd_ctrl)
 {
-  static short premix_first_buffer[SND_BLOCKSIZE];
-  static byte playing_buffer[SND_BLOCKSIZE];
-  int max_sample_size = SND_BLOCKSIZE;
+  static short premix_first_buffer[DEFAULT_AUDIO_FRAGMENT_SIZE];
+  static byte playing_buffer[DEFAULT_AUDIO_FRAGMENT_SIZE];
+  int max_sample_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
+  int num_output_channels = 1;
   void *sample_ptr;
   int sample_len;
   int sample_pos;
@@ -1316,7 +1329,7 @@ static int Mixer_Main_SimpleAudio(SoundControl snd_ctrl)
 
   /* copy original sample to first mixing buffer */
   CopySampleToMixingBuffer(&mixer[i], sample_pos, sample_size,
-                          premix_first_buffer);
+                          premix_first_buffer, 0, num_output_channels);
 
   /* adjust volume of actual sound sample */
   if (mixer[i].volume != SOUND_MAX_VOLUME)
@@ -1548,6 +1561,7 @@ static void *Load_WAV(char *filename)
 #endif
   char chunk_name[CHUNK_ID_LEN + 1];
   int chunk_size;
+  int data_byte_len;
   FILE *file;
 #endif
 
@@ -1642,7 +1656,8 @@ static void *Load_WAV(char *filename)
        return NULL;
       }
 
-      if (header.num_channels != 1)
+      if (header.num_channels != 1 &&
+         header.num_channels != 2)
       {
        Error(ERR_WARN, "sound file '%s': number of %d channels not supported",
              filename, header.num_channels);
@@ -1651,7 +1666,8 @@ static void *Load_WAV(char *filename)
        return NULL;
       }
 
-      if (header.bits_per_sample != 8 && header.bits_per_sample != 16)
+      if (header.bits_per_sample != 8 &&
+         header.bits_per_sample != 16)
       {
        Error(ERR_WARN, "sound file '%s': %d bits per sample not supported",
              filename, header.bits_per_sample);
@@ -1677,7 +1693,9 @@ static void *Load_WAV(char *filename)
     }
     else if (strcmp(chunk_name, "data") == 0)
     {
-      snd_info->data_len = chunk_size;
+      data_byte_len = chunk_size;
+
+      snd_info->data_len = data_byte_len;
       snd_info->data_ptr = checked_malloc(snd_info->data_len);
 
       /* read sound data */
@@ -1691,8 +1709,8 @@ static void *Load_WAV(char *filename)
        return NULL;
       }
 
-      /* check for odd number of sample bytes (data chunk is word aligned) */
-      if ((chunk_size % 2) == 1)
+      /* check for odd number of data bytes (data chunk is word aligned) */
+      if ((data_byte_len % 2) == 1)
        ReadUnusedBytesFromFile(file, 1);
     }
     else       /* unknown chunk -- ignore */
@@ -1716,6 +1734,29 @@ static void *Load_WAV(char *filename)
     snd_info->data_len /= 2;           /* correct number of samples */
   }
 
+  snd_info->num_channels = header.num_channels;
+  if (header.num_channels == 2)
+    snd_info->data_len /= 2;           /* correct number of samples */
+
+#if 0
+  if (header.num_channels == 1)                /* convert mono sound to stereo */
+  {
+    void *buffer_ptr = checked_malloc(data_byte_len * 2);
+    void *sample_ptr = snd_info->data_ptr;
+    int sample_size = snd_info->data_len;
+    int i;
+
+    if (snd_ctrl->format == AUDIO_FORMAT_U8)
+      for (i=0; i<sample_size; i++)
+       *buffer_ptr++ =
+         ((short)(((byte *)sample_ptr)[i] ^ 0x80)) << 8;
+    else       /* AUDIO_FORMAT_S16 */
+      for (i=0; i<sample_size; i++)
+       *buffer_ptr++ =
+         ((short *)sample_ptr)[i];
+  }
+#endif
+
 #endif /* AUDIO_UNIX_NATIVE */
 
   snd_info->type = SND_TYPE_WAV;
@@ -1724,126 +1765,73 @@ static void *Load_WAV(char *filename)
   return snd_info;
 }
 
-static void deleteSoundEntry(SoundInfo **snd_info)
+struct FileInfo *getCurrentSoundList()
 {
-  if (*snd_info)
-  {
-    char *filename = (*snd_info)->source_filename;
-
-#if 0
-    printf("[decrementing reference counter of sound '%s']\n", filename);
-#endif
-
-    if (--(*snd_info)->num_references <= 0)
-    {
-#if 0
-      printf("[deleting sound '%s']\n", filename);
-#endif
-
-      /*
-      FreeSound(*snd_info);
-      */
-      deleteNodeFromList(&SoundFileList, filename, FreeSound);
-    }
-
-    *snd_info = NULL;
-  }
+  return sound_info->file_list;
 }
 
-static void replaceSoundEntry(SoundInfo **snd_info, char *filename)
+void InitSoundList(struct ConfigInfo *config_list, int num_file_list_entries,
+                  struct ConfigInfo *config_suffix_list,
+                  char **base_prefixes,
+                  char **ext1_suffixes,
+                  char **ext2_suffixes)
 {
-  ListNode *node;
+  int i;
 
-  /* check if the old and the new sound file are the same */
-  if (*snd_info && strcmp((*snd_info)->source_filename, filename) == 0)
-  {
-    /* The old and new sound are the same (have the same filename and path).
-       This usually means that this sound does not exist in this sound set
-       and a fallback to the existing sound is done. */
+  sound_info = checked_calloc(sizeof(struct ArtworkListInfo));
+  sound_info->type = ARTWORK_TYPE_SOUNDS;
 
-#if 0
-    printf("[sound '%s' already exists (same list entry)]\n", filename);
-#endif
+  /* ---------- initialize file list and suffix lists ---------- */
 
-    return;
-  }
+  sound_info->num_file_list_entries = num_file_list_entries;
+  sound_info->num_dynamic_file_list_entries = 0;
 
-  /* delete existing sound file entry */
-  deleteSoundEntry(snd_info);
+  sound_info->num_suffix_list_entries = 0;
+  for (i=0; config_suffix_list[i].token != NULL; i++)
+    sound_info->num_suffix_list_entries++;
 
-  /* check if the new sound file already exists in the list of sounds */
-  if ((node = getNodeFromKey(SoundFileList, filename)) != NULL)
-  {
-#if 0
-      printf("[sound '%s' already exists (other list entry)]\n", filename);
-#endif
+  sound_info->file_list =
+    getFileListFromConfigList(config_list, config_suffix_list,
+                             num_file_list_entries);
+  sound_info->dynamic_file_list = NULL;
 
-      *snd_info = (SoundInfo *)node->content;
-      (*snd_info)->num_references++;
-  }
-  else if ((*snd_info = Load_WAV(filename)) != NULL)   /* load new sound */
-  {
-    (*snd_info)->num_references = 1;
-    addNodeToList(&SoundFileList, (*snd_info)->source_filename, *snd_info);
-  }
-}
+  sound_info->suffix_list = config_suffix_list;
 
-static void LoadCustomSound(SoundInfo **snd_info, char *basename)
-{
-  char *filename = getCustomSoundFilename(basename);
+  /* ---------- initialize base prefix and suffixes lists ---------- */
 
-#if 0
-  printf("GOT CUSTOM SOUND FILE '%s'\n", filename);
-#endif
+  sound_info->num_base_prefixes = 0;
+  for (i=0; base_prefixes[i] != NULL; i++)
+    sound_info->num_base_prefixes++;
 
-  if (strcmp(basename, SND_FILE_UNDEFINED) == 0)
-  {
-    deleteSoundEntry(snd_info);
-    return;
-  }
+  sound_info->num_ext1_suffixes = 0;
+  for (i=0; ext1_suffixes[i] != NULL; i++)
+    sound_info->num_ext1_suffixes++;
 
-  if (filename == NULL)
-  {
-    Error(ERR_WARN, "cannot find sound file '%s'", basename);
-    return;
-  }
+  sound_info->num_ext2_suffixes = 0;
+  for (i=0; ext2_suffixes[i] != NULL; i++)
+    sound_info->num_ext2_suffixes++;
 
-  replaceSoundEntry(snd_info, filename);
-}
+  sound_info->base_prefixes = base_prefixes;
+  sound_info->ext1_suffixes = ext1_suffixes;
+  sound_info->ext2_suffixes = ext2_suffixes;
 
-void InitSoundList(struct ArtworkConfigInfo *config_list, int num_list_entries)
-{
-  if (Sound == NULL)
-    Sound = checked_calloc(num_list_entries * sizeof(SoundInfo *));
+  /* ---------- initialize artwork reference and content lists ---------- */
 
-  sound_config = config_list;
-  num_sounds = num_list_entries;
+  sound_info->sizeof_artwork_list_entry = sizeof(SoundInfo *);
 
-  sound_info.type = ARTWORK_TYPE_SOUNDS;
-  sound_info.num_list_entries = num_list_entries;
-  sound_info.config_list = config_list;
-  sound_info.artwork_list = (struct ArtworkListNodeInfo **)Sound;
-  sound_info.file_list = NULL;
-  sound_info.load_artwork = Load_WAV;
-  sound_info.free_artwork = FreeSound;
-}
+  sound_info->artwork_list =
+    checked_calloc(num_file_list_entries * sizeof(SoundInfo *));
+  sound_info->dynamic_artwork_list = NULL;
 
-void LoadSoundToList(char *basename, int list_pos)
-{
-  if (Sound == NULL || list_pos >= num_sounds)
-    return;
+  sound_info->content_list = NULL;
 
-#if 0
-  printf("loading sound '%s' ...  [%d]\n",
-        basename, getNumNodes(SoundFileList));
-#endif
+  /* ---------- initialize artwork loading/freeing functions ---------- */
 
-  LoadCustomSound(&Sound[list_pos], basename);
+  sound_info->load_artwork = Load_WAV;
+  sound_info->free_artwork = FreeSound;
 
-#if 0
-  printf("loading sound '%s' done [%d]\n",
-        basename, getNumNodes(SoundFileList));
-#endif
+  num_sounds = sound_info->num_file_list_entries;
+  Sound = (SoundInfo **)sound_info->artwork_list;
 }
 
 static MusicInfo *Load_MOD(char *filename)
@@ -1927,7 +1915,7 @@ void LoadCustomMusic(void)
     {
       num_music++;
       Music = checked_realloc(Music, num_music * sizeof(MusicInfo *));
-      Music[num_music -1] = mus_info;
+      Music[num_music - 1] = mus_info;
     }
   }
 
@@ -2048,52 +2036,15 @@ void StopSoundExt(int nr, int state)
   HandleSoundRequest(snd_ctrl);
 }
 
-#if 1
 static void ReloadCustomSounds()
 {
-  ReloadCustomArtworkFiles(&sound_info);
-}
-#else
-static void ReloadCustomSounds()
-{
-  static boolean draw_init_text = TRUE;                /* only draw at startup */
-  int i;
-
-#if 0
-  printf("DEBUG: reloading sounds '%s' ...\n",artwork.snd_current_identifier);
-#endif
-
-  LoadArtworkConfig(&sound_info);
-
-  if (draw_init_text)
-    DrawInitText("Loading sounds:", 120, FC_GREEN);
-
 #if 0
-  printf("DEBUG: reloading %d sounds ...\n", num_sounds);
+  printf("DEBUG: reloading sounds '%s' ...\n", artwork.snd_current_identifier);
 #endif
 
-  for(i=0; i<num_sounds; i++)
-  {
-    if (draw_init_text)
-      DrawInitText(sound_config[i].token, 150, FC_YELLOW);
-
-    if (sound_config[i].filename)
-      LoadSoundToList(sound_config[i].filename, i);
-    else
-      LoadSoundToList(sound_config[i].default_filename, i);
-  }
-
-  draw_init_text = FALSE;
-
-  /*
-  printf("list size == %d\n", getNumNodes(SoundFileList));
-  */
-
-#if 0
-  dumpList(SoundFileList);
-#endif
+  LoadArtworkConfig(sound_info);
+  ReloadCustomArtworkList(sound_info);
 }
-#endif
 
 static void ReloadCustomMusic()
 {
@@ -2101,27 +2052,23 @@ static void ReloadCustomMusic()
   printf("DEBUG: reloading music '%s' ...\n", artwork.mus_current_identifier);
 #endif
 
-#if 0
-  /* this is done directly in LoadCustomMusic() now */
-  FreeAllMusic();
-#endif
-
   LoadCustomMusic();
 }
 
-void InitReloadSounds(char *set_identifier)
+void InitReloadCustomSounds(char *set_identifier)
 {
   if (!audio.sound_available)
     return;
 
 #if defined(AUDIO_UNIX_NATIVE)
+  LoadArtworkConfig(sound_info);       /* also load config on sound client */
   WriteReloadInfoToPipe(set_identifier, SND_CTRL_RELOAD_SOUNDS);
 #else
   ReloadCustomSounds();
 #endif
 }
 
-void InitReloadMusic(char *set_identifier)
+void InitReloadCustomMusic(char *set_identifier)
 {
   if (!audio.music_available)
     return;
@@ -2181,31 +2128,7 @@ void FreeMusic(MusicInfo *music)
 
 void FreeAllSounds()
 {
-  int i;
-
-  if (Sound == NULL)
-    return;
-
-#if 0
-  printf("%s: FREEING SOUNDS ...\n",
-        IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT");
-#endif
-
-  for(i=0; i<num_sounds; i++)
-    deleteSoundEntry(&Sound[i]);
-  /*
-    FreeSound(Sound[i]);
-  */
-
-#if 0
-  printf("%s: FREEING SOUNDS -- DONE\n",
-        IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT");
-#endif
-
-  free(Sound);
-
-  Sound = NULL;
-  num_sounds = 0;
+  FreeCustomArtworkLists(sound_info);
 }
 
 void FreeAllMusic()