rnd-20020506-1-src
[rocksndiamonds.git] / src / libgame / sound.c
index 0e90a582ea86c9229d8f34629d3be45bf0caba6a..f1a38d2c4cc69acbf26287d0eaaf5e83e2694ec8 100644 (file)
 #include "setup.h"
 
 
+struct ListNode
+{
+  char *key;
+  void *content;
+  struct ListNode *next;
+};
+typedef struct ListNode ListNode;
+
+static ListNode *newListNode(void);
+static void addNodeToList(ListNode **, char *, void *);
+static void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
+static ListNode *getNodeFromKey(ListNode *, char *);
+static int getNumNodes(ListNode *);
+
+
+static struct SoundEffectInfo *sound_effect;
+static ListNode *SoundFileList = NULL;
 static SoundInfo **Sound = NULL;
 static MusicInfo **Music = NULL;
 static int num_sounds = 0, num_music = 0;
@@ -70,6 +87,10 @@ static void SoundServer_StopSound(struct SoundControl);
 static void SoundServer_StopAllSounds();
 #endif
 
+static void ReloadCustomSounds();
+static void ReloadCustomMusic();
+static void FreeSound(void *);
+
 #if defined(PLATFORM_UNIX)
 static int OpenAudioDevice(char *audio_device_name)
 {
@@ -277,12 +298,12 @@ void SoundServer(void)
       if (snd_ctrl.reload_sounds)
       {
        artwork.sounds_set_current = set_name;
-       audio.func_reload_sounds();
+       ReloadCustomSounds();
       }
       else
       {
        artwork.music_set_current = set_name;
-       audio.func_reload_music();
+       ReloadCustomMusic();
       }
 
       free(set_name);
@@ -630,10 +651,22 @@ static void sound_handler(struct SoundControl snd_ctrl)
 #if !defined(PLATFORM_WIN32)
 static void SoundServer_InsertNewSound(struct SoundControl snd_ctrl)
 {
+  SoundInfo *snd_info;
   int i, k;
 
   if (snd_ctrl.music)
     snd_ctrl.nr = snd_ctrl.nr % num_music;
+  else if (snd_ctrl.nr >= num_sounds)
+    return;
+
+  snd_info = (snd_ctrl.music ? Music[snd_ctrl.nr] : Sound[snd_ctrl.nr]);
+  if (snd_info == NULL)
+  {
+#if 0
+    printf("sound/music %d undefined\n", snd_ctrl.nr);
+#endif
+    return;
+  }
 
   /* if playlist is full, remove oldest sound */
   if (playing_sounds == MAX_SOUNDS_PLAYING)
@@ -729,9 +762,6 @@ static void SoundServer_InsertNewSound(struct SoundControl snd_ctrl)
     if (!playlist[i].active ||
        (snd_ctrl.music && i == audio.music_channel))
     {
-      SoundInfo *snd_info =
-       (snd_ctrl.music ? Music[snd_ctrl.nr] : Sound[snd_ctrl.nr]);
-
       snd_ctrl.data_ptr = snd_info->data_ptr;
       snd_ctrl.data_len = snd_info->data_len;
       snd_ctrl.format   = snd_info->format;
@@ -1100,6 +1130,10 @@ static SoundInfo *Load_WAV(char *filename)
   if (!audio.sound_available)
     return NULL;
 
+#if 0
+  printf("loading WAV file '%s'\n", filename);
+#endif
+
   snd_info = checked_calloc(sizeof(SoundInfo));
 
 #if defined(TARGET_SDL)
@@ -1203,22 +1237,95 @@ static SoundInfo *Load_WAV(char *filename)
   return snd_info;
 }
 
-SoundInfo *LoadCustomSound(char *basename)
+static void deleteSoundEntry(SoundInfo **snd_info)
+{
+  if (*snd_info)
+  {
+    char *filename = (*snd_info)->source_filename;
+
+#if 1
+    printf("[decrementing reference counter of sound '%s']\n", filename);
+#endif
+
+    if (--(*snd_info)->num_references <= 0)
+    {
+#if 1
+      printf("[deleting sound '%s']\n", filename);
+#endif
+
+      /*
+      FreeSound(*snd_info);
+      */
+      deleteNodeFromList(&SoundFileList, filename, FreeSound);
+    }
+
+    *snd_info = NULL;
+  }
+}
+
+static void replaceSoundEntry(SoundInfo **snd_info, char *filename)
+{
+  ListNode *node;
+
+  /* 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. */
+
+#if 0
+    printf("[sound '%s' already exists (same list entry)]\n", filename);
+#endif
+
+    return;
+  }
+
+  /* delete existing sound file entry */
+  deleteSoundEntry(snd_info);
+
+  /* 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
+
+      *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);
+  }
+}
+
+static void LoadCustomSound(SoundInfo **snd_info, char *basename)
 {
   char *filename = getCustomSoundFilename(basename);
 
+  if (strcmp(basename, SND_FILE_UNDEFINED) == 0)
+  {
+    deleteSoundEntry(snd_info);
+    return;
+  }
+
   if (filename == NULL)
   {
     Error(ERR_WARN, "cannot find sound file '%s'", basename);
-    return FALSE;
+    return;
   }
 
-  return Load_WAV(filename);
+  replaceSoundEntry(snd_info, filename);
 }
 
-void InitSoundList(int num_list_entries)
+void InitSoundList(struct SoundEffectInfo *sounds_list, int num_list_entries)
 {
-  Sound = checked_calloc(num_list_entries * sizeof(SoundInfo *));
+  if (Sound == NULL)
+    Sound = checked_calloc(num_list_entries * sizeof(SoundInfo *));
+
+  sound_effect = sounds_list;
   num_sounds = num_list_entries;
 }
 
@@ -1227,10 +1334,17 @@ void LoadSoundToList(char *basename, int list_pos)
   if (Sound == NULL || list_pos >= num_sounds)
     return;
 
-  if (Sound[list_pos])
-    FreeSound(Sound[list_pos]);
+#if 0
+  printf("loading sound '%s' ...  [%d]\n",
+        basename, getNumNodes(SoundFileList));
+#endif
 
-  Sound[list_pos] = LoadCustomSound(basename);
+  LoadCustomSound(&Sound[list_pos], basename);
+
+#if 0
+  printf("loading sound '%s' done [%d]\n",
+        basename, getNumNodes(SoundFileList));
+#endif
 }
 
 static MusicInfo *Load_MOD(char *filename)
@@ -1507,6 +1621,149 @@ void StopSoundExt(int nr, int method)
 #endif
 }
 
+ListNode *newListNode()
+{
+  return checked_calloc(sizeof(ListNode));
+}
+
+void addNodeToList(ListNode **node_first, char *key, void *content)
+{
+  ListNode *node_new = newListNode();
+
+#if 0
+  printf("LIST: adding node with key '%s'\n", key);
+#endif
+
+  node_new->key = getStringCopy(key);
+  node_new->content = content;
+  node_new->next = *node_first;
+  *node_first = node_new;
+}
+
+void deleteNodeFromList(ListNode **node_first, char *key,
+                       void (*destructor_function)(void *))
+{
+  if (node_first == NULL || *node_first == NULL)
+    return;
+
+  printf("[CHECKING LIST KEY '%s' == '%s']\n",
+        (*node_first)->key, key);
+
+  if (strcmp((*node_first)->key, key) == 0)
+  {
+    printf("[DELETING LIST ENTRY]\n");
+
+    free((*node_first)->key);
+    if (destructor_function)
+      destructor_function((*node_first)->content);
+    *node_first = (*node_first)->next;
+  }
+  else
+    deleteNodeFromList(&(*node_first)->next, key, destructor_function);
+}
+
+ListNode *getNodeFromKey(ListNode *node_first, char *key)
+{
+  if (node_first == NULL)
+    return NULL;
+
+  if (strcmp(node_first->key, key) == 0)
+    return node_first;
+  else
+    return getNodeFromKey(node_first->next, key);
+}
+
+int getNumNodes(ListNode *node_first)
+{
+  return (node_first ? 1 + getNumNodes(node_first->next) : 0);
+}
+
+void dumpList(ListNode *node_first)
+{
+  ListNode *node = node_first;
+
+  while (node)
+  {
+    printf("['%s' (%d)]\n", node->key,
+          ((SoundInfo *)node->content)->num_references);
+    node = node->next;
+  }
+
+  printf("[%d nodes]\n", getNumNodes(node_first));
+}
+
+static void LoadSoundsInfo()
+{
+  char *filename = getCustomSoundConfigFilename();
+  struct SetupFileList *setup_file_list;
+  int i;
+
+  /* always start with reliable default values */
+  for (i=0; i<num_sounds; i++)
+    sound_effect[i].filename = NULL;
+
+  if (filename == NULL)
+    return;
+
+  if ((setup_file_list = loadSetupFileList(filename)))
+  {
+    for (i=0; i<num_sounds; i++)
+      sound_effect[i].filename =
+       getStringCopy(getTokenValue(setup_file_list, sound_effect[i].text));
+
+    freeSetupFileList(setup_file_list);
+
+#if 1
+    for (i=0; i<num_sounds; i++)
+    {
+      printf("'%s' ", sound_effect[i].text);
+      if (sound_effect[i].filename)
+       printf("-> '%s'\n", sound_effect[i].filename);
+      else
+       printf("-> UNDEFINED [-> '%s']\n", sound_effect[i].default_filename);
+    }
+#endif
+  }
+}
+
+static void ReloadCustomSounds()
+{
+  int i;
+
+#if 0
+  printf("DEBUG: reloading sounds '%s' ...\n", artwork.sounds_set_current);
+#endif
+
+  LoadSoundsInfo();
+
+  for(i=0; i<num_sounds; i++)
+  {
+    if (sound_effect[i].filename)
+      LoadSoundToList(sound_effect[i].filename, i);
+    else
+      LoadSoundToList(sound_effect[i].default_filename, i);
+  }
+
+  /*
+  printf("list size == %d\n", getNumNodes(SoundFileList));
+  */
+
+#if 0
+  dumpList(SoundFileList);
+#endif
+}
+
+static void ReloadCustomMusic()
+{
+#if 0
+  printf("DEBUG: reloading music '%s' ...\n", artwork.music_set_current);
+#endif
+
+  FreeAllMusic();
+
+  LoadCustomMusic();
+}
+
 static void InitReloadSoundsOrMusic(char *set_name, int type)
 {
 #if defined(PLATFORM_UNIX) && !defined(TARGET_SDL)
@@ -1575,8 +1832,10 @@ void InitReloadMusic(char *set_name)
   InitReloadSoundsOrMusic(set_name, SND_RELOAD_MUSIC);
 }
 
-void FreeSound(SoundInfo *sound)
+void FreeSound(void *ptr)
 {
+  SoundInfo *sound = (SoundInfo *)ptr;
+
   if (sound == NULL)
     return;
 
@@ -1591,6 +1850,9 @@ void FreeSound(SoundInfo *sound)
 #endif
   }
 
+  if (sound->source_filename)
+    free(sound->source_filename);
+
   free(sound);
 }