fixed bug with not recognizing ".mode_loop: false" for music
[rocksndiamonds.git] / src / libgame / sound.h
index 5d27f20a9f6f6547cedf369903cb8b921941689c..e2d2054ae404fae4454885738b2fc9b4f93b9c56 100644 (file)
@@ -1,42 +1,28 @@
-/***********************************************************
-* Artsoft Retro-Game Library                               *
-*----------------------------------------------------------*
-* (c) 1994-2001 Artsoft Entertainment                      *
-*               Holger Schemel                             *
-*               Detmolder Strasse 189                      *
-*               33604 Bielefeld                            *
-*               Germany                                    *
-*               e-mail: info@artsoft.org                   *
-*----------------------------------------------------------*
-* sound.h                                                  *
-***********************************************************/
+// ============================================================================
+// Artsoft Retro-Game Library
+// ----------------------------------------------------------------------------
+// (c) 1995-2014 by Artsoft Entertainment
+//                         Holger Schemel
+//                 info@artsoft.org
+//                 http://www.artsoft.org/
+// ----------------------------------------------------------------------------
+// sound.h
+// ============================================================================
 
 #ifndef SOUND_H
 #define SOUND_H
 
-#include "platform.h"
+#include "system.h"
 
 
-#if defined(PLATFORM_UNIX) && !defined(TARGET_SDL)
-#define AUDIO_UNIX_NATIVE
-#endif
-
-#if defined(PLATFORM_LINUX) || defined(PLATFORM_FREEBSD) || defined(VOXWARE)
-#define AUDIO_LINUX_IOCTL
-#endif
-
-#if defined(AUDIO_LINUX_IOCTL) || defined(PLATFORM_NETBSD)
-#define AUDIO_STREAMING_DSP
-#endif
-
 /* values for platform specific sound initialization */
-#define AUDIO_SAMPLE_RATE_8000         8000
 #define AUDIO_SAMPLE_RATE_22050                22050
 
 #define AUDIO_FRAGMENT_SIZE_512                512
 #define AUDIO_FRAGMENT_SIZE_1024       1024
 #define AUDIO_FRAGMENT_SIZE_2048       2048
 #define AUDIO_FRAGMENT_SIZE_4096       4096
+#define AUDIO_FRAGMENT_SIZE_32768      32768
 
 #define AUDIO_NUM_CHANNELS_MONO                1
 #define AUDIO_NUM_CHANNELS_STEREO      2
 #define AUDIO_FORMAT_LE                        (1 << 2)
 #define AUDIO_FORMAT_BE                        (1 << 3)
 
-#if defined(AUDIO_UNIX_NATIVE) && !defined(AUDIO_STREAMING_DSP)
-#define DEFAULT_AUDIO_SAMPLE_RATE      AUDIO_SAMPLE_RATE_8000
-#else
 #define DEFAULT_AUDIO_SAMPLE_RATE      AUDIO_SAMPLE_RATE_22050
-#endif
 
 #if defined(PLATFORM_WIN32)
-#define DEFAULT_AUDIO_FRAGMENT_SIZE    AUDIO_FRAGMENT_SIZE_2048
+#define DEFAULT_AUDIO_FRAGMENT_SIZE    AUDIO_FRAGMENT_SIZE_1024
 #else
 #define DEFAULT_AUDIO_FRAGMENT_SIZE    AUDIO_FRAGMENT_SIZE_512
 #endif
 
-#if defined(TARGET_SDL)
 #define NUM_MIXER_CHANNELS             MIX_CHANNELS
-#else
-#define NUM_MIXER_CHANNELS             8
-#endif
 
 #define MUSIC_CHANNEL                  0
 #define FIRST_SOUND_CHANNEL            1
 
 
 /* values for PlaySound(), StopSound() and friends */
-#define SND_CTRL_NONE          (0)
-#define SND_CTRL_MUSIC         (1 << 0)
-#define SND_CTRL_LOOP          (1 << 1)
-#define SND_CTRL_FADE          (1 << 2)
-#define SND_CTRL_STOP          (1 << 3)
-#define SND_CTRL_ALL_SOUNDS    (1 << 4)
-#define SND_CTRL_RELOAD_SOUNDS (1 << 5)
-#define SND_CTRL_RELOAD_MUSIC  (1 << 6)
-
-#define SND_CTRL_PLAY_SOUND    (SND_CTRL_NONE)
-#define SND_CTRL_PLAY_LOOP     (SND_CTRL_LOOP)
-#define SND_CTRL_PLAY_MUSIC    (SND_CTRL_LOOP | SND_CTRL_MUSIC)
-
-#define SND_CTRL_FADE_SOUND    (SND_CTRL_FADE)
-#define SND_CTRL_FADE_MUSIC    (SND_CTRL_FADE | SND_CTRL_MUSIC)
-#define SND_CTRL_FADE_ALL      (SND_CTRL_FADE | SND_CTRL_ALL_SOUNDS)
-
-#define SND_CTRL_STOP_SOUND    (SND_CTRL_STOP)
-#define SND_CTRL_STOP_MUSIC    (SND_CTRL_STOP | SND_CTRL_MUSIC)
-#define SND_CTRL_STOP_ALL      (SND_CTRL_STOP | SND_CTRL_ALL_SOUNDS)
-
-#define IS_MUSIC(x)            ((x).state & SND_CTRL_MUSIC)
-#define IS_LOOP(x)             ((x).state & SND_CTRL_LOOP)
-#define IS_FADING(x)           ((x).state & SND_CTRL_FADE)
-#define IS_STOPPING(x)         ((x).state & SND_CTRL_STOP)
-#define IS_RELOADING(x)                ((x).state & (SND_CTRL_RELOAD_SOUNDS | \
-                                             SND_CTRL_RELOAD_MUSIC))
-#define ALL_SOUNDS(x)          ((x).state & SND_CTRL_ALL_SOUNDS)
-
-
-#if !defined(TARGET_ALLEGRO)
-
-#define PSND_SILENCE           0
-#define PSND_MAX_VOLUME_BITS   15
-#define PSND_MIN_VOLUME                0
-#define PSND_MAX_VOLUME                (1 << PSND_MAX_VOLUME_BITS)
-#define PSND_MIDDLE            0
-#define PSND_MAX_STEREO_BITS   7
-#define PSND_MAX_STEREO                (1 << PSND_MAX_STEREO_BITS)
-#define PSND_MAX_LEFT          (-PSND_MAX_STEREO)
-#define PSND_MAX_RIGHT         (+PSND_MAX_STEREO)
-#define PSND_MAX_LEFT2RIGHT_BITS (PSND_MAX_STEREO_BITS+1)
-#define PSND_MAX_LEFT2RIGHT    (1 << PSND_MAX_LEFT2RIGHT_BITS)
-
-#else  /* TARGET_ALLEGRO */
-
-#define PSND_SILENCE           0
-#define PSND_MIN_VOLUME                0
-#define PSND_MAX_VOLUME                255
-#define PSND_MAX_LEFT          0
-#define PSND_MAX_RIGHT         255
-#define PSND_MIDDLE            128
-
-#endif
-
-/* value for undefined sound effect filename */
-#define SND_FILE_UNDEFINED     "NONE"
-
-
-struct SoundEffectInfo
-{
-  char *text;
-  char *default_filename;
-  char *filename;
-};
+#define SND_CTRL_NONE                  (0)
+#define SND_CTRL_MUSIC                 (1 << 0)
+#define SND_CTRL_LOOP                  (1 << 1)
+#define SND_CTRL_FADE                  (1 << 2)
+#define SND_CTRL_STOP                  (1 << 3)
+#define SND_CTRL_ALL_SOUNDS            (1 << 4)
+#define SND_CTRL_RELOAD_SOUNDS         (1 << 5)
+#define SND_CTRL_RELOAD_MUSIC          (1 << 6)
+#define SND_CTRL_EXPIRE_LOOPS          (1 << 7)
+
+#define SND_CTRL_PLAY_SOUND            (SND_CTRL_NONE)
+#define SND_CTRL_PLAY_LOOP             (SND_CTRL_LOOP)
+#define SND_CTRL_PLAY_MUSIC            (SND_CTRL_MUSIC)
+#define SND_CTRL_PLAY_MUSIC_LOOP       (SND_CTRL_MUSIC | SND_CTRL_LOOP)
+
+#define SND_CTRL_FADE_SOUND            (SND_CTRL_FADE)
+#define SND_CTRL_FADE_MUSIC            (SND_CTRL_FADE | SND_CTRL_MUSIC)
+#define SND_CTRL_FADE_ALL              (SND_CTRL_FADE | SND_CTRL_ALL_SOUNDS)
+
+#define SND_CTRL_STOP_SOUND            (SND_CTRL_STOP)
+#define SND_CTRL_STOP_MUSIC            (SND_CTRL_STOP | SND_CTRL_MUSIC)
+#define SND_CTRL_STOP_ALL              (SND_CTRL_STOP | SND_CTRL_ALL_SOUNDS)
+
+#define IS_MUSIC(x)                    ((x).state & SND_CTRL_MUSIC)
+#define IS_LOOP(x)                     ((x).state & SND_CTRL_LOOP)
+#define IS_FADING(x)                   ((x).state & SND_CTRL_FADE)
+#define IS_STOPPING(x)                 ((x).state & SND_CTRL_STOP)
+#define IS_RELOADING(x)                        ((x).state & (SND_CTRL_RELOAD_SOUNDS |\
+                                                     SND_CTRL_RELOAD_MUSIC))
+#define ALL_SOUNDS(x)                  ((x).state & SND_CTRL_ALL_SOUNDS)
+#define SET_EXPIRE_LOOPS(x)            ((x).state & SND_CTRL_EXPIRE_LOOPS)
+
+#define MAP_NOCONF_MUSIC(x)            (-((x) + 1))
+#define UNMAP_NOCONF_MUSIC(x)          MAP_NOCONF_MUSIC(x)
+
+
+#define SOUND_MIN_VOLUME               0
+#define SOUND_MAX_VOLUME               SDL_MIX_MAXVOLUME
+
+#define SOUND_MAX_LEFT                 0
+#define SOUND_MAX_RIGHT                        255
+#define SOUND_MAX_LEFT2RIGHT           255
+#define SOUND_MIDDLE                   (SOUND_MAX_LEFT2RIGHT / 2)
 
 
 /* general sound functions */
@@ -147,21 +103,39 @@ void StartMixer(void);
 
 /* sound client functions */
 void PlayMusic(int);
+void PlayMusicLoop(int);
 void PlaySound(int);
 void PlaySoundStereo(int, int);
 void PlaySoundLoop(int);
 void PlaySoundMusic(int);
+void PlaySoundMusicLoop(int);
 void PlaySoundExt(int, int, int, int);
 void FadeMusic(void);
 void FadeSound(int);
 void FadeSounds(void);
+void FadeSoundsAndMusic(void);
 void StopMusic(void);
 void StopSound(int);
 void StopSounds(void);
 void StopSoundExt(int, int);
-void InitSoundList(struct SoundEffectInfo *, int);
-void InitReloadSounds(char *);
-void InitReloadMusic(char *);
+void ExpireSoundLoops(boolean);
+
+int getSoundListSize();
+int getMusicListSize();
+struct FileInfo *getSoundListEntry(int);
+struct FileInfo *getMusicListEntry(int);
+char *getMusicInfoEntryFilename(int);
+char *getCurrentlyPlayingMusicFilename();
+int getSoundListPropertyMappingSize();
+int getMusicListPropertyMappingSize();
+struct PropertyMapping *getSoundListPropertyMapping();
+struct PropertyMapping *getMusicListPropertyMapping();
+void InitSoundList(struct ConfigInfo *, int, struct ConfigTypeInfo *,
+                  char **, char **, char **, char **, char **);
+void InitMusicList(struct ConfigInfo *, int, struct ConfigTypeInfo *,
+                  char **, char **, char **, char **, char **);
+void InitReloadCustomSounds(char *);
+void InitReloadCustomMusic(char *);
 void FreeAllSounds(void);
 void FreeAllMusic(void);