SDL client: implement support for OGG files

Author: draconisPW

SDL_mixer.dll

@@ -49,6 +49,7 @@ PWMAngband:
   maximum number of fonts to 60
 - Simplify food description
 - Simplify Dragon's Breath description
+- SDL client: implement support for OGG files
 
 Gameplay changes
 ----------------

changes.txt

@@ -2,6 +2,84 @@ MKPATH=../../mk/
 include $(MKPATH)buildsys.mk
 
 DATA = sound.cfg \
+	amb_bell_metal1.ogg       mco_scurry_dry.ogg        plm_glass_smashing.ogg \
+	amb_bell_metal2.ogg       mco_shake_roll.ogg        plm_jar_ding.ogg \
+	amb_bell_tibet1.ogg       mco_snarl_short.ogg       plm_levelup.ogg \
+	amb_bell_tibet2.ogg       mco_spray_long.ogg        plm_lock_case.ogg \
+	amb_bell_tibet3.ogg       mco_squish_hit.ogg        plm_lock_distant.ogg \
+	amb_deep.ogg              mco_squish_snap.ogg       plm_metal_clank.ogg \
+	amb_door_doom.ogg         mco_strange_music.ogg     plm_metal_sharpen.ogg \
+	amb_door_iron.ogg         mco_strange_thwoink.ogg   plm_open_case.ogg \
+	amb_dungeon_echo.ogg      mco_thoing_backwards.ogg  plm_spell1.ogg \
+	amb_dungeon_echowet.ogg   mco_thoing_deep.ogg       plm_spell2.ogg \
+	amb_gong_chinese.ogg      mco_thud_crash.ogg        plm_spell3.ogg \
+	amb_gong_low.ogg          mco_tube_hit.ogg          plm_use_staff.ogg \
+	amb_gong_strike.ogg       plc_bell_warn.ogg         plm_wood_thud.ogg \
+	amb_gong_undertone.ogg    plc_die_laugh.ogg         plm_zap_rod.ogg \
+	amb_guitar_chord.ogg      plc_hit_anvil2.ogg        pls_bell_bowl.ogg \
+	amb_melkor.ogg            plc_hit_anvil.ogg         pls_bell_chime_new.ogg \
+	amb_morgoth.ogg           plc_hit_arrow.ogg         pls_bell_glass.ogg \
+	amb_pulse_low.ogg         plc_hit_body.ogg          pls_bell_hibell_soft.ogg \
+	amb_sauron.ogg            plc_hit_critical.ogg      pls_bell_mute.ogg \
+	amb_senya.ogg             plc_hit_groan.ogg         pls_bell_sustain.ogg \
+	amb_thunder_rain.ogg      plc_hit_grunt2.ogg        pls_breathe_in.ogg \
+	amb_thunder_roll.ogg      plc_hit_grunt.ogg         pls_man_argoh.ogg \
+	amb_xakaze.ogg            plc_hit_hay.ogg           pls_man_gulp_new.ogg \
+	enter_pit.ogg             plc_miss_arrow2.ogg       pls_man_oooh.ogg \
+	id_bad_aww.ogg            plc_miss_arrow.ogg        pls_man_scream2.ogg \
+	id_bad_dang.ogg           plc_miss_swish.ogg        pls_man_sigh.ogg \
+	id_bad_hmm.ogg            plm_aim_wand.ogg          pls_man_sniff.ogg \
+	id_bad_hmph.ogg           plm_bang_ceramic.ogg      pls_man_sob.ogg \
+	id_bad_ohh.ogg            plm_bang_dumpster.ogg     pls_man_spit.ogg \
+	id_ego_whoa.ogg           plm_bang_metal.ogg        pls_man_ugh.ogg \
+	id_ego_woohoo.ogg         plm_book_pageturn.ogg     pls_man_yell.ogg \
+	id_ego_yeah2.ogg          plm_bottle_clinks.ogg     pls_tone_blurk.ogg \
+	id_ego_yeah.ogg           plm_break_canister.ogg    pls_tone_clave6.ogg \
+	id_ego_yes.ogg            plm_break_glass2.ogg      pls_tone_clavelo8.ogg \
+	id_good_hey2.ogg          plm_break_glass.ogg       pls_tone_conk.ogg \
+	id_good_hey.ogg           plm_break_plates.ogg      pls_tone_elec.ogg \
+	id_good_hmm.ogg           plm_break_shatter.ogg     pls_tone_goblet.ogg \
+	id_good_huh.ogg           plm_break_smash.ogg       pls_tone_guiro.ogg \
+	id_good_ooh.ogg           plm_break_wood.ogg        pls_tone_headstock.ogg \
+	id_good_ooo.ogg           plm_cabinet_open.ogg      pls_tone_scrape.ogg \
+	id_good_wow.ogg           plm_cabinet_shut.ogg      pls_tone_stick.ogg \
+	mco_attack_breath.ogg     plm_chain_light.ogg       sto_bell_desk.ogg \
+	mco_attack_spray.ogg      plm_chest_latch.ogg       sto_bell_dingaling.ogg \
+	mco_bite_chew.ogg         plm_chest_unlatch.ogg     sto_bell_ding.ogg \
+	mco_bite_chomp.ogg        plm_chimes_jangle.ogg     sto_bell_jingles.ogg \
+	mco_bite_dainty.ogg       plm_click_dry.ogg         sto_bell_register1.ogg \
+	mco_bite_gnash.ogg        plm_click_switch2.ogg     sto_bell_register2.ogg \
+	mco_bite_hard.ogg         plm_click_switch3.ogg     sto_bell_ringing.ogg \
+	mco_bite_long.ogg         plm_click_switch.ogg      sto_bell_shop.ogg \
+	mco_bite_munch.ogg        plm_click_wood.ogg        sto_coins_countertop.ogg \
+	mco_bite_regular.ogg      plm_close_hatch.ogg       sto_man_haha.ogg \
+	mco_bite_short.ogg        plm_coins_dump.ogg        sto_man_hey.ogg \
+	mco_bite_small.ogg        plm_coins_light.ogg       sto_man_whoohaha.ogg \
+	mco_bite_soft.ogg         plm_coins_pour.ogg        sum_angel_song.ogg \
+	mco_card_shuffle.ogg      plm_coins_shake.ogg       sum_bell_crystal.ogg \
+	mco_castanet_trill.ogg    plm_cork_pop.ogg          sum_bell_hand.ogg \
+	mco_ceramic_trill.ogg     plm_cork_squeak.ogg       sum_bell_tone.ogg \
+	mco_click_vibra.ogg       plm_door_bolt.ogg         sum_chime_jangle.ogg \
+	mco_creature_choking.ogg  plm_door_creak.ogg        sum_ghost_moan.ogg \
+	mco_creature_groan.ogg    plm_door_creakshut.ogg    sum_ghost_oooo.ogg \
+	mco_creature_yelp.ogg     plm_door_dungeon.ogg      sum_ghost_wail.ogg \
+	mco_cuica_rubbing.ogg     plm_door_echolock.ogg     sum_gong_temple.ogg \
+	mco_dino_low.ogg          plm_door_entrance.ogg     sum_laugh_evil2.ogg \
+	mco_dino_slur.ogg         plm_door_knob.ogg         sum_lion_growl.ogg  \
+	mco_dino_talk.ogg         plm_door_latch.ogg        sum_piano_scrape.ogg \
+	mco_dino_yawn.ogg         plm_door_opening.ogg      wild_deepwater.ogg \
+	mco_dub_wobble.ogg        plm_door_open.ogg         wild_desert.ogg \
+	mco_frog_trill.ogg        plm_door_rusty.ogg        wild_glacier.ogg \
+	mco_hit_whip.ogg          plm_door_shut.ogg         wild_grass.ogg \
+	mco_howl_croak.ogg        plm_door_slam.ogg         wild_hill.ogg \
+	mco_howl_deep.ogg         plm_door_squeaky.ogg      wild_mountain.ogg \
+	mco_howl_distressed.ogg   plm_door_wooden.ogg       wild_river.ogg \
+	mco_howl_high.ogg         plm_drop_boot.ogg         wild_shore.ogg \
+	mco_howl_long.ogg         plm_eat_bite.ogg          wild_swamp.ogg \
+	mco_liquid_squirt.ogg     plm_floor_creak2.ogg      wild_volcano.ogg \
+	mco_man_mumble.ogg        plm_floor_creak.ogg       wild_waste.ogg \
+	mco_mouse_squeaks.ogg     plm_glass_breaking.ogg    wild_wood.ogg \
+	mco_rubber_thud.ogg       plm_glass_break.ogg \
 	amb_bell_metal1.mp3       mco_scurry_dry.mp3        plm_glass_smashing.mp3 \
 	amb_bell_metal2.mp3       mco_shake_roll.mp3        plm_jar_ding.mp3 \
 	amb_bell_tibet1.mp3       mco_snarl_short.mp3       plm_levelup.mp3 \

lib/sounds/Makefile

@@ -23,4 +23,6 @@ How to build all SDL libraries required to run the SDL client:
 - In \SDL\libmad-0.15.1b, replace layer3.c by the one in \PWMAngband\src\fix to remove compile errors
 - Download and unzip SDL_mixer 1.2.12 in the \SDL directory:
 	https://www.libsdl.org/projects/SDL_mixer/release-1.2.html
+- In \SDL\SDL_mixer-1.2.12, replace the following file by the one in \PWMAngband\src\fix:
+    \VisualC\external\include\vorbis\vorbisfile.h
 - Run \PWMAngband\src\SDL.bat

lib/sounds/amb_bell_metal1.ogg

@@ -45,9 +45,9 @@ OTHERFILES =
 # ---------------------------------------------------------------------------
 DEBUGLIBPATH = $(BCB)\lib\debug
 RELEASELIBPATH = $(BCB)\lib\release
-USERDEFINES = WIN32;_WINDOWS;_CRT_SECURE_NO_WARNINGS;WAV_MUSIC;MP3_MAD_MUSIC;BUILD_SDL;FPM_DEFAULT
+USERDEFINES = WIN32;_WINDOWS;_CRT_SECURE_NO_WARNINGS;WAV_MUSIC;MP3_MAD_MUSIC;BUILD_SDL;FPM_DEFAULT;OGG_MUSIC;OGG_DYNAMIC=\"libvorbisfile-3.dll\";BCC
 SYSDEFINES = NO_STRICT;_NO_VCL
-INCLUDEPATH = $(BCB)\include;_SDL;..\..\SDL\libmad-0.15.1b
+INCLUDEPATH = $(BCB)\include;_SDL;..\..\SDL\libmad-0.15.1b;..\..\SDL\SDL_mixer-1.2.12\VisualC\external\include
 LIBPATH = $(BCB)\lib\obj;$(BCB)\lib;_SDL
 WARNINGS= -w-par
 PATHCPP= .;..\..\SDL\SDL_mixer-1.2.12;..\..\SDL\libmad-0.15.1b
@@ -61,7 +61,9 @@ CFLAG1 = -WD -O2 -Hc -w- -Vx -Ve -X- \
 IDLCFLAGS = -I$(BCB)\include -I_SDL \
     -I..\..\SDL\libmad-0.15.1b \
     -src_suffix cpp -DWIN32 -D_WINDOWS -D_CRT_SECURE_NO_WARNINGS -DWAV_MUSIC \
-    -DMP3_MAD_MUSIC -DBUILD_SDL -DFPM_DEFAULT -DNO_STRICT -D_NO_VCL -boa
+    -DMP3_MAD_MUSIC -DBUILD_SDL -DFPM_DEFAULT \
+    -DOGG_MUSIC -DOGG_DYNAMIC=\"libvorbisfile-3.dll\" -DBCC \
+    -DNO_STRICT -D_NO_VCL -boa
 PFLAGS = -$Y- -$L- -$D- -$A8 -v -JPHNE -M
 RFLAGS = 
 AFLAGS = /mx /w2 /zn

lib/sounds/amb_bell_metal2.ogg

@@ -42,8 +42,8 @@ enum
 
 static const struct sound_file_type supported_sound_files[] =
 {
-    {".mp3", SDL_MUSIC},
     {".ogg", SDL_CHUNK},
+    {".mp3", SDL_MUSIC},
     {"", SDL_NULL}
 };
 
@@ -62,6 +62,9 @@ typedef struct
 } sdl_sample;
 
 
+static bool use_init = false;
+
+
 /*
  * Initialize SDL and open the mixer.
  */
@@ -104,6 +107,12 @@ static bool load_sample_sdl(const char *filename, int file_type, sdl_sample *sam
     {
         case SDL_CHUNK:
         {
+            if (!use_init)
+            {
+                Mix_Init(MIX_INIT_OGG);
+                use_init = true;
+            }
+
             sample->sample_data.chunk = Mix_LoadWAV(filename);
             if (sample->sample_data.chunk) return true;
             break;
@@ -167,7 +176,7 @@ static bool play_sound_sdl(struct sound_data *data)
             case SDL_CHUNK:
             {
                 /* If another sound is currently playing, stop it */
-                Mix_HaltChannel(-1);
+                /*Mix_HaltChannel(-1);*/
 
                 if (sample->sample_data.chunk)
                     return (0 == Mix_PlayChannel(-1, sample->sample_data.chunk, 0));
@@ -234,6 +243,8 @@ static bool unload_sound_sdl(struct sound_data *data)
  */
 static bool close_audio_sdl(void)
 {
+    if (use_init) Mix_Quit();
+
     /*
      * Close the audio
      *

lib/sounds/amb_bell_tibet1.ogg

@@ -0,0 +1,208 @@
+/********************************************************************
+ *                                                                  *
+ * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
+ * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
+ * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
+ * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
+ *                                                                  *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007             *
+ * by the Xiph.Org Foundation http://www.xiph.org/                  *
+ *                                                                  *
+ ********************************************************************
+
+ function: stdio-based convenience library for opening/seeking/decoding
+ last mod: $Id: vorbisfile.h 17182 2010-04-29 03:48:32Z xiphmont $
+
+ ********************************************************************/
+
+#ifndef _OV_FILE_H_
+#define _OV_FILE_H_
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif /* __cplusplus */
+
+#include <stdio.h>
+#include "codec.h"
+
+/* The function prototypes for the callbacks are basically the same as for
+ * the stdio functions fread, fseek, fclose, ftell.
+ * The one difference is that the FILE * arguments have been replaced with
+ * a void * - this is to be used as a pointer to whatever internal data these
+ * functions might need. In the stdio case, it's just a FILE * cast to a void *
+ *
+ * If you use other functions, check the docs for these functions and return
+ * the right values. For seek_func(), you *MUST* return -1 if the stream is
+ * unseekable
+ */
+typedef struct {
+  size_t (*read_func)  (void *ptr, size_t size, size_t nmemb, void *datasource);
+  int    (*seek_func)  (void *datasource, ogg_int64_t offset, int whence);
+  int    (*close_func) (void *datasource);
+  long   (*tell_func)  (void *datasource);
+} ov_callbacks;
+
+#ifndef OV_EXCLUDE_STATIC_CALLBACKS
+
+/* a few sets of convenient callbacks, especially for use under
+ * Windows where ov_open_callbacks() should always be used instead of
+ * ov_open() to avoid problems with incompatible crt.o version linking
+ * issues. */
+
+static int _ov_header_fseek_wrap(FILE *f,ogg_int64_t off,int whence){
+  if(f==NULL)return(-1);
+
+#ifdef __MINGW32__
+  return fseeko64(f,off,whence);
+#elif defined (BCC)
+  return fseek(f,off,whence);
+#elif defined (_WIN32)
+  return _fseeki64(f,off,whence);
+#else
+  return fseek(f,off,whence);
+#endif
+}
+
+/* These structs below (OV_CALLBACKS_DEFAULT etc) are defined here as
+ * static data. That means that every file which includes this header
+ * will get its own copy of these structs whether it uses them or
+ * not unless it #defines OV_EXCLUDE_STATIC_CALLBACKS.
+ * These static symbols are essential on platforms such as Windows on
+ * which several different versions of stdio support may be linked to
+ * by different DLLs, and we need to be certain we know which one
+ * we're using (the same one as the main application).
+ */
+
+static ov_callbacks OV_CALLBACKS_DEFAULT = {
+  (size_t (*)(void *, size_t, size_t, void *))  fread,
+  (int (*)(void *, ogg_int64_t, int))           _ov_header_fseek_wrap,
+  (int (*)(void *))                             fclose,
+  (long (*)(void *))                            ftell
+};
+
+static ov_callbacks OV_CALLBACKS_NOCLOSE = {
+  (size_t (*)(void *, size_t, size_t, void *))  fread,
+  (int (*)(void *, ogg_int64_t, int))           _ov_header_fseek_wrap,
+  (int (*)(void *))                             NULL,
+  (long (*)(void *))                            ftell
+};
+
+static ov_callbacks OV_CALLBACKS_STREAMONLY = {
+  (size_t (*)(void *, size_t, size_t, void *))  fread,
+  (int (*)(void *, ogg_int64_t, int))           NULL,
+  (int (*)(void *))                             fclose,
+  (long (*)(void *))                            NULL
+};
+
+static ov_callbacks OV_CALLBACKS_STREAMONLY_NOCLOSE = {
+  (size_t (*)(void *, size_t, size_t, void *))  fread,
+  (int (*)(void *, ogg_int64_t, int))           NULL,
+  (int (*)(void *))                             NULL,
+  (long (*)(void *))                            NULL
+};
+
+#endif
+
+#define  NOTOPEN   0
+#define  PARTOPEN  1
+#define  OPENED    2
+#define  STREAMSET 3
+#define  INITSET   4
+
+typedef struct OggVorbis_File {
+  void            *datasource; /* Pointer to a FILE *, etc. */
+  int              seekable;
+  ogg_int64_t      offset;
+  ogg_int64_t      end;
+  ogg_sync_state   oy;
+
+  /* If the FILE handle isn't seekable (eg, a pipe), only the current
+     stream appears */
+  int              links;
+  ogg_int64_t     *offsets;
+  ogg_int64_t     *dataoffsets;
+  long            *serialnos;
+  ogg_int64_t     *pcmlengths; /* overloaded to maintain binary
+                                  compatibility; x2 size, stores both
+                                  beginning and end values */
+  vorbis_info     *vi;
+  vorbis_comment  *vc;
+
+  /* Decoding working state local storage */
+  ogg_int64_t      pcm_offset;
+  int              ready_state;
+  long             current_serialno;
+  int              current_link;
+
+  double           bittrack;
+  double           samptrack;
+
+  ogg_stream_state os; /* take physical pages, weld into a logical
+                          stream of packets */
+  vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
+  vorbis_block     vb; /* local working space for packet->PCM decode */
+
+  ov_callbacks callbacks;
+
+} OggVorbis_File;
+
+
+extern int ov_clear(OggVorbis_File *vf);
+extern int ov_fopen(const char *path,OggVorbis_File *vf);
+extern int ov_open(FILE *f,OggVorbis_File *vf,const char *initial,long ibytes);
+extern int ov_open_callbacks(void *datasource, OggVorbis_File *vf,
+                const char *initial, long ibytes, ov_callbacks callbacks);
+
+extern int ov_test(FILE *f,OggVorbis_File *vf,const char *initial,long ibytes);
+extern int ov_test_callbacks(void *datasource, OggVorbis_File *vf,
+                const char *initial, long ibytes, ov_callbacks callbacks);
+extern int ov_test_open(OggVorbis_File *vf);
+
+extern long ov_bitrate(OggVorbis_File *vf,int i);
+extern long ov_bitrate_instant(OggVorbis_File *vf);
+extern long ov_streams(OggVorbis_File *vf);
+extern long ov_seekable(OggVorbis_File *vf);
+extern long ov_serialnumber(OggVorbis_File *vf,int i);
+
+extern ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i);
+extern ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i);
+extern double ov_time_total(OggVorbis_File *vf,int i);
+
+extern int ov_raw_seek(OggVorbis_File *vf,ogg_int64_t pos);
+extern int ov_pcm_seek(OggVorbis_File *vf,ogg_int64_t pos);
+extern int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
+extern int ov_time_seek(OggVorbis_File *vf,double pos);
+extern int ov_time_seek_page(OggVorbis_File *vf,double pos);
+
+extern int ov_raw_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
+extern int ov_pcm_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
+extern int ov_pcm_seek_page_lap(OggVorbis_File *vf,ogg_int64_t pos);
+extern int ov_time_seek_lap(OggVorbis_File *vf,double pos);
+extern int ov_time_seek_page_lap(OggVorbis_File *vf,double pos);
+
+extern ogg_int64_t ov_raw_tell(OggVorbis_File *vf);
+extern ogg_int64_t ov_pcm_tell(OggVorbis_File *vf);
+extern double ov_time_tell(OggVorbis_File *vf);
+
+extern vorbis_info *ov_info(OggVorbis_File *vf,int link);
+extern vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
+
+extern long ov_read_float(OggVorbis_File *vf,float ***pcm_channels,int samples,
+                          int *bitstream);
+extern long ov_read_filter(OggVorbis_File *vf,char *buffer,int length,
+                          int bigendianp,int word,int sgned,int *bitstream,
+                          void (*filter)(float **pcm,long channels,long samples,void *filter_param),void *filter_param);
+extern long ov_read(OggVorbis_File *vf,char *buffer,int length,
+                    int bigendianp,int word,int sgned,int *bitstream);
+extern int ov_crosslap(OggVorbis_File *vf1,OggVorbis_File *vf2);
+
+extern int ov_halfrate(OggVorbis_File *vf,int flag);
+extern int ov_halfrate_p(OggVorbis_File *vf);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif
+