src/sound/audiostr.cpp

   1 /*
   2  * $Logfile: $
   3  * $Revision$
   4  * $Date$
   5  * $Author$
   6  *
   7  * OpenAL based audio streaming
   8  *
   9  * $Log$
  10  * Revision 1.4  2005/10/01 21:53:06  taylor
  11  * include file cleanup
  12  * byte-swap streaming PCM to avoid the endless, loud, static
  13  *
  14  * Revision 1.3  2005/08/13 16:59:23  taylor
  15  * type check
  16  *
  17  * Revision 1.2  2005/08/12 20:21:06  taylor
  18  * woorps!
  19  *
  20  * Revision 1.1  2005/08/12 08:44:39  taylor
  21  * import of FS2_Open audio code which is now *nix only, does not include windows or ogg support that FS2_Open has
  22  *
  23  * Revision 1.12  2005/06/24 19:36:49  taylor
  24  * we only want to have m_data_offset be 0 for oggs since the seeking callback will account for the true offset
  25  * only extern the one int we need for the -nosound speech fix rather than including the entire header
  26  *
  27  * Revision 1.11  2005/06/19 02:45:55  taylor
  28  * OGG streaming fixes to get data reading right and avoid skipping
  29  * properly handle seeking in OGG streams
  30  * compiler warning fix in OpenAL builds
  31  *
  32  * Revision 1.10  2005/06/01 09:41:14  taylor
  33  * bit of cleanup for audiostr-openal and fix a Windows-only enum error
  34  * bunch of OGG related fixes for Linux and Windows (DirectSound and OpenAL), fixes audio related TBP 3.2 crashes
  35  * gracefully handle OGG logical bitstream changes, shouldn't even load if there is more than 1
  36  *
  37  * Revision 1.9  2005/05/28 19:43:28  taylor
  38  * debug message fixing
  39  * a little bit of code clarity
  40  *
  41  * Revision 1.8  2005/05/24 03:11:38  taylor
  42  * an extra bounds check in sound.cpp
  43  * fix audiostr error when filename is !NULL but 0 in len might hit on SDL debug code
  44  *
  45  * Revision 1.7  2005/05/15 06:47:57  taylor
  46  * don't let the ogg callbacks close the file handle on us, let us do it ourselves to keep things straight
  47  *
  48  * Revision 1.6  2005/05/13 23:09:28  taylor
  49  * Ooops!  Added the wrong version of the streaming patch from Jens
  50  *
  51  * Revision 1.5  2005/05/12 17:47:57  taylor
  52  * use vm_malloc(), vm_free(), vm_realloc(), vm_strdup() rather than system named macros
  53  *   fixes various problems and is past time to make the switch
  54  * fix a few streaming errors in OpenAL code (Jens Granseuer)
  55  * temporary change to help deal with missing music in OpenAL Windows builds
  56  * don't assert when si->data is NULL unless we really need to check (OpenAL only)
  57  *
  58  * Revision 1.4  2005/04/05 11:48:22  taylor
  59  * remove acm-unix.cpp, replaced by acm-openal.cpp since it's properly cross-platform now
  60  * better error handling for OpenAL functions
  61  * Windows can now build properly with OpenAL
  62  * extra check to make sure we don't try and use too many hardware bases sources
  63  * fix memory error from OpenAL extension list in certain instances
  64  *
  65  * Revision 1.3  2005/04/01 07:33:08  taylor
  66  * fix hanging on exit with OpenAL
  67  * some better error handling on OpenAL init and make it more Windows friendly too
  68  * basic 3d sound stuff for OpenAL, not working right yet
  69  *
  70  * Revision 1.2  2005/03/27 08:51:24  taylor
  71  * this is what coding on an empty stomach will get you
  72  *
  73  * Revision 1.1  2005/03/27 05:48:58  taylor
  74  * initial import of OpenAL streaming (many thanks to Pierre Willenbrock for the missing parts)
  75  *
  76  *
  77  * $NoKeywords: $
  78  */
  79
  80
  81 #include <vector>
  82
  83 #include "pstypes.h"
  84 #include "audiostr.h"
  85 #include "oal.h"
  86 #include "acm.h"
  87 #include "cfile.h"
  88 #include "sound.h"
  89 #include "timer.h"
  90
  91
  92 #define MAX_STREAM_BUFFERS 4
  93
  94 // Constants
  95 #define BIGBUF_SIZE                                     180000                  // This can be reduced to 88200 once we don't use any stereo
  96 //#define BIGBUF_SIZE                                   88300                   // This can be reduced to 88200 once we don't use any stereo
  97 static ubyte *Wavedata_load_buffer = NULL;              // buffer used for cueing audiostreams
  98 static ubyte *Wavedata_service_buffer = NULL;   // buffer used for servicing audiostreams
  99
 100 SDL_mutex *Global_service_lock;
 101
 102 typedef bool (*TIMERCALLBACK)(ptr_u);
 103
 104 #define COMPRESSED_BUFFER_SIZE  88300
 105 static ubyte *Compressed_buffer = NULL;                         // Used to load in compressed data during a cueing interval
 106 static ubyte *Compressed_service_buffer = NULL; // Used to read in compressed data during a service interval
 107
 108 #define AS_HIGHEST_MAX  999999999       // max uncompressed filesize supported is 999 meg
 109
 110 // status
 111 #define ASF_FREE        0
 112 #define ASF_USED        1
 113
 114 static int Audiostream_inited = 0;
 115
 116
 117 class Timer
 118 {
 119 public:
 120     void constructor();
 121     void destructor();
 122
 123     bool Create(uint nPeriod, ptr_u dwUser, TIMERCALLBACK pfnCallback);
 124
 125 protected:
 126         static Uint32 TimeProc(Uint32 interval, void *dwUser);
 127
 128         TIMERCALLBACK m_pfnCallback;
 129     ptr_u m_dwUser;
 130     uint m_nPeriod;
 131     SDL_TimerID m_nIDTimer;
 132 };
 133
 134 class WaveFile
 135 {
 136 public:
 137         void Init();
 138         void Close();
 139         bool Open(const char *pszFilename);
 140         bool Cue();
 141         int     Read(ubyte *pbDest, uint cbSize, int service = 1);
 142         ubyte GetSilenceData();
 143
 144         uint GetNumBytesRemaining()
 145         {
 146                 return (m_nDataSize - m_nBytesPlayed);
 147         }
 148
 149         uint GetUncompressedAvgDataRate()
 150         {
 151                 return m_nUncompressedAvgDataRate;
 152         }
 153
 154         uint GetDataSize()
 155         {
 156                 return m_nDataSize;
 157         }
 158
 159         uint GetNumBytesPlayed()
 160         {
 161                 return m_nBytesPlayed;
 162         }
 163
 164         ALenum GetOALFormat()
 165         {
 166                 return m_oal_format;
 167         }
 168
 169         WAVE_chunk m_wfmt;                                      // format of wave file
 170         WAVE_chunk *m_pwfmt_original;   // foramt of wave file from actual wave source
 171         uint m_total_uncompressed_bytes_read;
 172         uint m_max_uncompressed_bytes_to_read;
 173         uint m_bits_per_sample_uncompressed;
 174
 175 protected:
 176         uint m_data_offset;                                             // number of bytes to actual wave data
 177         int  m_data_bytes_left;
 178         CFILE *cfp;
 179
 180         ALenum m_oal_format;
 181         uint m_wave_format;                                             // format of wave source (ie WAVE_FORMAT_PCM, WAVE_FORMAT_ADPCM)
 182         uint m_nBlockAlign;                                             // wave data block alignment spec
 183         uint m_nUncompressedAvgDataRate;                // average wave data rate
 184         uint m_nDataSize;                                                       // size of data chunk
 185         uint m_nBytesPlayed;                                            // offset into data chunk
 186         bool m_abort_next_read;
 187
 188         void *m_hStream;
 189         int m_hStream_open;
 190         WAVE_chunk m_wfxDest;
 191 };
 192
 193 class AudioStream
 194 {
 195 public:
 196         AudioStream();
 197         ~AudioStream();
 198
 199         bool Create(const char *pszFilename);
 200         bool Destroy();
 201         void Play(float volume, int looping);
 202         void Stop(bool paused = false);
 203         void Stop_and_Rewind();
 204         void Fade_and_Destroy();
 205         void Fade_and_Stop();
 206         void Set_Volume(float vol);
 207         float Get_Volume();
 208         void Init_Data();
 209         void Set_Byte_Cutoff(uint num_bytes_cutoff);
 210         uint Get_Bytes_Committed();
 211
 212         bool Is_Playing()
 213         {
 214                 return m_fPlaying;
 215         }
 216
 217         bool Is_Paused()
 218         {
 219                 return m_bIsPaused;
 220         }
 221
 222         bool Is_Past_Limit()
 223         {
 224                 return m_bPastLimit;
 225         }
 226
 227         void Set_Default_Volume(float _volume)
 228         {
 229                 m_lDefaultVolume = _volume;
 230         }
 231
 232         float Get_Default_Volume()
 233         {
 234                 return m_lDefaultVolume;
 235         }
 236
 237         bool Is_looping()
 238         {
 239                 return m_bLooping;
 240         }
 241
 242         int status;
 243         int     type;
 244         ushort m_bits_per_sample_uncompressed;
 245
 246 protected:
 247         void Cue();
 248         bool WriteWaveData(uint cbSize, uint* num_bytes_written,int service=1);
 249         uint GetMaxWriteSize();
 250         bool ServiceBuffer();
 251         static bool TimerCallback(ptr_u dwUser);
 252
 253         ALuint m_source_id;   // name of openAL source
 254         ALuint m_buffer_ids[MAX_STREAM_BUFFERS]; //names of buffers
 255         int m_play_buffer_id;
 256
 257         Timer m_timer;              // ptr to Timer object
 258         WaveFile *m_pwavefile;        // ptr to WaveFile object
 259         bool m_fCued;                  // semaphore (stream cued)
 260         bool m_fPlaying;               // semaphore (stream playing)
 261         long m_lInService;             // reentrancy semaphore
 262         uint m_cbBufOffset;            // last write position
 263         uint m_nBufLength;             // length of sound buffer in msec
 264         uint m_cbBufSize;              // size of sound buffer in bytes
 265         uint m_nBufService;            // service interval in msec
 266         uint m_nTimeStarted;           // time (in system time) playback started
 267
 268         bool    m_bLooping;                                             // whether or not to loop playback
 269         bool    m_bFade;                                                        // fade out music
 270         bool    m_bDestroy_when_faded;
 271         float   m_lVolume;                                              // volume of stream ( 0 -> -10 000 )
 272         float   m_lCutoffVolume;
 273         bool    m_bIsPaused;                                    // stream is stopped, but not rewinded
 274         ushort  m_silence_written;                      // number of bytes of silence written to buffer
 275         ushort  m_bReadingDone;                         // no more bytes to be read from disk, still have remaining buffer to play
 276         uint    m_fade_timer_id;                                // timestamp so we know when to start fade
 277         uint    m_finished_id;                                  // timestamp so we know when we've played #bytes required
 278         bool    m_bPastLimit;                                   // flag to show we've played past the number of bytes requred
 279         float   m_lDefaultVolume;
 280 };
 281
 282
 283 // Timer class implementation
 284 //
 285 ////////////////////////////////////////////////////////////
 286
 287 void Timer::constructor()
 288 {
 289         m_nIDTimer = 0;
 290 }
 291
 292 void Timer::destructor()
 293 {
 294         if (m_nIDTimer) {
 295                 SDL_RemoveTimer(m_nIDTimer);
 296                 m_nIDTimer = 0;
 297         }
 298 }
 299
 300 bool Timer::Create(uint nPeriod, ptr_u dwUser, TIMERCALLBACK pfnCallback)
 301 {
 302         SDL_assert( pfnCallback != NULL );
 303         SDL_assert( nPeriod > 10 );
 304
 305         m_nPeriod = nPeriod;
 306         m_dwUser = dwUser;
 307         m_pfnCallback = pfnCallback;
 308
 309         m_nIDTimer = SDL_AddTimer(m_nPeriod, TimeProc, (void*)this);
 310
 311         if ( !m_nIDTimer ) {
 312                 nprintf(("SOUND", "SOUND ==> Error, unable to create timer\n"));
 313                 return false;
 314         }
 315
 316         return true;
 317 }
 318
 319 // Calls procedure specified when Timer object was created. The
 320 // dwUser parameter contains "this" pointer for associated Timer object.
 321 //
 322 Uint32 Timer::TimeProc(Uint32 interval, void *dwUser)
 323 {
 324     // dwUser contains ptr to Timer object
 325         Timer *ptimer = (Timer *)dwUser;
 326
 327     // Call user-specified callback and pass back user specified data
 328     (ptimer->m_pfnCallback)(ptimer->m_dwUser);
 329
 330     if (ptimer->m_nPeriod) {
 331                 return interval;
 332     } else {
 333                 SDL_RemoveTimer(ptimer->m_nIDTimer);
 334                 ptimer->m_nIDTimer = 0;
 335
 336                 return 0;
 337     }
 338 }
 339
 340
 341 // WaveFile class implementation
 342 //
 343 ////////////////////////////////////////////////////////////
 344
 345 void WaveFile::Init()
 346 {
 347         // Init data members
 348         m_data_offset = 0;
 349         cfp = NULL;
 350         m_pwfmt_original = NULL;
 351         m_nBlockAlign= 0;
 352         m_nUncompressedAvgDataRate = 0;
 353         m_nDataSize = 0;
 354         m_nBytesPlayed = 0;
 355         m_total_uncompressed_bytes_read = 0;
 356         m_max_uncompressed_bytes_to_read = AS_HIGHEST_MAX;
 357
 358         m_hStream_open = 0;
 359         m_abort_next_read = false;
 360 }
 361
 362 void WaveFile::Close()
 363 {
 364         // Free memory
 365         if (m_pwfmt_original) {
 366                 free(m_pwfmt_original);
 367                 m_pwfmt_original = NULL;
 368         }
 369
 370         if (m_hStream_open) {
 371                 ACM_stream_close((void*)m_hStream);
 372                 m_hStream_open = 0;
 373         }
 374
 375         // Close file
 376         if (cfp) {
 377                 cfclose(cfp);
 378                 cfp = NULL;
 379         }
 380 }
 381
 382 bool WaveFile::Open(const char *pszFilename)
 383 {
 384         int done = false;
 385         bool fRtn = true;    // assume success
 386         int id = 0;
 387         uint tag = 0, size = 0, next_chunk;
 388
 389         m_total_uncompressed_bytes_read = 0;
 390         m_max_uncompressed_bytes_to_read = AS_HIGHEST_MAX;
 391
 392         m_pwfmt_original = (WAVE_chunk*) malloc (sizeof(WAVE_chunk));
 393
 394         if (m_pwfmt_original == NULL) {
 395                 goto OPEN_ERROR;
 396         }
 397
 398         cfp = cfopen(pszFilename, "rb");
 399
 400         if (cfp == NULL) {
 401                 goto OPEN_ERROR;
 402         }
 403
 404         // check for valid file type
 405         id = cfread_int(cfp);
 406
 407         // 'RIFF'
 408         if (id != 0x46464952) {
 409                 nprintf(("Error", "Not a WAVE file '%s'\n", pszFilename));
 410                 goto OPEN_ERROR;
 411         }
 412
 413         // skip RIFF size
 414         cfread_int(cfp);
 415
 416         // check for valid RIFF type
 417         id = cfread_int(cfp);
 418
 419         // 'WAVE'
 420         if (id != 0x45564157) {
 421                 nprintf(("Error", "Not a WAVE file '%s'\n", pszFilename));
 422                 goto OPEN_ERROR;
 423         }
 424
 425         while ( !done ) {
 426                 tag = cfread_uint(cfp);
 427                 size = cfread_uint(cfp);
 428
 429                 next_chunk = cftell(cfp) + size;
 430
 431                 switch (tag) {
 432                         // 'fmt '
 433                         case 0x20746d66: {
 434                                 m_pwfmt_original->code = cfread_short(cfp);
 435                                 m_pwfmt_original->num_channels = cfread_ushort(cfp);
 436                                 m_pwfmt_original->sample_rate = cfread_uint(cfp);
 437                                 m_pwfmt_original->bytes_per_second = cfread_uint(cfp);
 438                                 m_pwfmt_original->block_align = cfread_ushort(cfp);
 439                                 m_pwfmt_original->bits_per_sample = cfread_ushort(cfp);
 440
 441                                 if (m_pwfmt_original->code != 1) {
 442                                         m_pwfmt_original->extra_size = cfread_ushort(cfp);
 443                                 }
 444
 445                                 if (m_pwfmt_original->extra_size) {
 446                                         m_pwfmt_original->extra_data = (ubyte*) malloc (m_pwfmt_original->extra_size);
 447                                         SDL_assert( m_pwfmt_original->extra_data != NULL );
 448
 449                                         if (m_pwfmt_original->extra_data == NULL) {
 450                                                 goto OPEN_ERROR;
 451                                         }
 452
 453                                         cfread(m_pwfmt_original->extra_data, m_pwfmt_original->extra_size, 1, cfp);
 454                                 }
 455
 456                                 break;
 457                         }
 458
 459                         // 'data'
 460                         case 0x61746164: {
 461                                 m_nDataSize = size;     // size of data, compressed size if ADPCM
 462                                 m_data_bytes_left = size;
 463                                 m_data_offset = cftell(cfp);
 464
 465                                 done = true;
 466
 467                                 break;
 468                         }
 469
 470                         // drop everything else
 471                         default:
 472                                 break;
 473                 }
 474
 475                 cfseek(cfp, next_chunk, CF_SEEK_SET);
 476         }
 477
 478         // we force PCM format, so keep track of original format for later
 479         switch (m_pwfmt_original->code) {
 480                 case WAVE_FORMAT_PCM:
 481                         m_wave_format = WAVE_FORMAT_PCM;
 482                         m_wfmt.bits_per_sample = m_pwfmt_original->bits_per_sample;
 483                         break;
 484
 485                 case WAVE_FORMAT_ADPCM:
 486                         m_wave_format = WAVE_FORMAT_ADPCM;
 487                         m_wfmt.bits_per_sample = 16;
 488                         m_bits_per_sample_uncompressed = 16;
 489                         break;
 490
 491                 default:
 492                         nprintf(("SOUND", "SOUND => Not supporting %d format for playing wave files\n", m_pwfmt_original->code));
 493                         //Int3();
 494                         goto OPEN_ERROR;
 495                         break;
 496
 497         }
 498
 499         m_wfmt.code = WAVE_FORMAT_PCM;
 500         m_wfmt.num_channels = m_pwfmt_original->num_channels;
 501         m_wfmt.sample_rate = m_pwfmt_original->sample_rate;
 502         m_wfmt.extra_size = 0;
 503         m_wfmt.block_align = (ushort)(( m_wfmt.num_channels * m_wfmt.bits_per_sample ) / 8);
 504         m_wfmt.bytes_per_second = m_wfmt.block_align * m_wfmt.sample_rate;
 505
 506         // set OpenAL format
 507         m_oal_format = AL_FORMAT_MONO8;
 508
 509         if (m_wfmt.num_channels == 1) {
 510                 if (m_wfmt.bits_per_sample == 8) {
 511                         m_oal_format = AL_FORMAT_MONO8;
 512                 } else if (m_wfmt.bits_per_sample == 16) {
 513                         m_oal_format = AL_FORMAT_MONO16;
 514                 }
 515         } else if (m_wfmt.num_channels == 2) {
 516                 if (m_wfmt.bits_per_sample == 8) {
 517                         m_oal_format = AL_FORMAT_STEREO8;
 518                 } else if (m_wfmt.bits_per_sample == 16) {
 519                         m_oal_format = AL_FORMAT_STEREO16;
 520                 }
 521         }
 522
 523         // Init some member data from format chunk
 524         m_nBlockAlign = m_pwfmt_original->block_align;
 525         m_nUncompressedAvgDataRate = m_wfmt.bytes_per_second;
 526
 527         // Successful open
 528         goto OPEN_DONE;
 529
 530 OPEN_ERROR:
 531         // Handle all errors here
 532         nprintf(("SOUND","SOUND ==> Could not open wave file %s for streaming\n", pszFilename));
 533
 534         fRtn = false;
 535
 536         if (m_pwfmt_original) {
 537                 free(m_pwfmt_original);
 538                 m_pwfmt_original = NULL;
 539         }
 540
 541         if (cfp != NULL) {
 542                 cfclose(cfp);
 543                 cfp = NULL;
 544         }
 545
 546 OPEN_DONE:
 547         return (fRtn);
 548 }
 549
 550 // Cue
 551 //
 552 // Set the file pointer to the start of wave data
 553 //
 554 bool WaveFile::Cue()
 555 {
 556         bool fRtn = true;    // assume success
 557         int rval = -1;
 558
 559         m_total_uncompressed_bytes_read = 0;
 560         m_max_uncompressed_bytes_to_read = AS_HIGHEST_MAX;
 561
 562         rval = cfseek(cfp, m_data_offset, CF_SEEK_SET);
 563
 564         if (rval) {
 565                 fRtn = false;
 566         }
 567
 568         m_data_bytes_left = m_nDataSize;
 569         m_abort_next_read = false;
 570
 571         return fRtn;
 572 }
 573
 574 // Read
 575 //
 576 // Returns number of bytes actually read.
 577 //
 578 //      Returns -1 if there is nothing more to be read.  This function can return 0, since
 579 // sometimes the amount of bytes requested is too small for the ACM decompression to
 580 // locate a suitable block
 581 int WaveFile::Read(ubyte *pbDest, uint cbSize, int service)
 582 {
 583         void *dest_buf = NULL, *uncompressed_wave_data;
 584         int rc, uncompressed_bytes_written;
 585         uint src_bytes_used, convert_len, num_bytes_desired=0, num_bytes_read;
 586
 587 //      nprintf(("Alan","Reqeusted: %d\n", cbSize));
 588
 589         if ( service ) {
 590                 uncompressed_wave_data = Wavedata_service_buffer;
 591         } else {
 592                 uncompressed_wave_data = Wavedata_load_buffer;
 593         }
 594
 595         switch (m_wave_format) {
 596                 case WAVE_FORMAT_PCM: {
 597                         num_bytes_desired = cbSize;
 598                         dest_buf = pbDest;
 599
 600                         break;
 601                 }
 602
 603                 case WAVE_FORMAT_ADPCM: {
 604                         if ( !m_hStream_open ) {
 605                                 if ( !ACM_stream_open(m_pwfmt_original, &m_wfxDest, (void**)&m_hStream, m_bits_per_sample_uncompressed) ) {
 606                                         m_hStream_open = 1;
 607                                 } else {
 608                                         Int3();
 609                                 }
 610                         }
 611
 612                         num_bytes_desired = cbSize;
 613
 614                         if (service) {
 615                                 dest_buf = Compressed_service_buffer;
 616                         } else {
 617                                 dest_buf = Compressed_buffer;
 618                         }
 619
 620                         if (num_bytes_desired <= 0) {
 621                                 num_bytes_desired = 0;
 622 //                              nprintf(("Alan","No bytes required for ADPCM time interval\n"));
 623                         } else {
 624                                 num_bytes_desired = ACM_query_source_size((void*)m_hStream, cbSize);
 625 //                              nprintf(("Alan","Num bytes desired: %d\n", num_bytes_desired));
 626                         }
 627
 628                         break;
 629                 }
 630
 631                 default:
 632                         nprintf(("SOUND", "SOUND => Not supporting %d format for playing wave files\n"));
 633                         Int3();
 634                         break;
 635
 636         } // end switch
 637
 638         num_bytes_read = 0;
 639         convert_len = 0;
 640         src_bytes_used = 0;
 641
 642         // read data from disk
 643         if (m_data_bytes_left <= 0) {
 644                 return -1;
 645         }
 646
 647         if ( (m_data_bytes_left > 0) && (num_bytes_desired > 0) ) {
 648                 int actual_read = 0;
 649
 650                 if (num_bytes_desired <= (uint)m_data_bytes_left) {
 651                         num_bytes_read = num_bytes_desired;
 652                 } else {
 653                         num_bytes_read = m_data_bytes_left;
 654                 }
 655
 656                 actual_read = cfread(dest_buf, 1, num_bytes_read, cfp);
 657
 658                 if ( (actual_read <= 0) || (m_abort_next_read) ) {
 659                         return -1;
 660                 }
 661
 662                 if (num_bytes_desired >= (uint)m_data_bytes_left) {
 663                         m_abort_next_read = 1;
 664                 }
 665
 666                 num_bytes_read = actual_read;
 667         }
 668
 669         // convert data if necessary, to PCM
 670         if (m_wave_format == WAVE_FORMAT_ADPCM) {
 671                 if ( num_bytes_read > 0 ) {
 672                         rc = ACM_convert((void*)m_hStream, (ubyte*)dest_buf, num_bytes_read, (ubyte*)uncompressed_wave_data, BIGBUF_SIZE, &convert_len, &src_bytes_used);
 673
 674                         if (rc == -1) {
 675                                 goto READ_ERROR;
 676                         }
 677
 678                         if (convert_len == 0) {
 679                                 Int3();
 680                         }
 681                 }
 682
 683                 SDL_assert( src_bytes_used <= num_bytes_read );
 684
 685                 if (src_bytes_used < num_bytes_read) {
 686                         // seek back file pointer to reposition before unused source data
 687                         cfseek(cfp, src_bytes_used - num_bytes_read, CF_SEEK_CUR);
 688                 }
 689
 690                 // Adjust number of bytes left
 691                 m_data_bytes_left -= src_bytes_used;
 692                 m_nBytesPlayed += src_bytes_used;
 693                 uncompressed_bytes_written = convert_len;
 694
 695                 // Successful read, keep running total of number of data bytes read
 696                 goto READ_DONE;
 697         } else {
 698                 // Successful read, keep running total of number of data bytes read
 699                 // Adjust number of bytes left
 700                 m_data_bytes_left -= num_bytes_read;
 701                 m_nBytesPlayed += num_bytes_read;
 702                 uncompressed_bytes_written = num_bytes_read;
 703
 704 #if BYTE_ORDER == BIG_ENDIAN
 705                 if (m_wave_format == WAVE_FORMAT_PCM) {
 706                         // swap 16-bit sound data
 707                         if (m_wfmt.bits_per_sample == 16) {
 708                                 ushort *swap_tmp;
 709
 710                                 for (int i = 0; i < uncompressed_bytes_written; i = (i+2)) {
 711                                         swap_tmp = (ushort*)((ubyte*)dest_buf + i);
 712                                         *swap_tmp = INTEL_SHORT(*swap_tmp);
 713                                 }
 714                         }
 715                 }
 716 #endif
 717
 718                 goto READ_DONE;
 719         }
 720
 721 READ_ERROR:
 722         uncompressed_bytes_written = 0;
 723
 724 READ_DONE:
 725         m_total_uncompressed_bytes_read += uncompressed_bytes_written;
 726 //      nprintf(("Alan","Read: %d\n", uncompressed_bytes_written));
 727
 728         return uncompressed_bytes_written;
 729 }
 730
 731 // GetSilenceData
 732 //
 733 // Returns 8 bits of data representing silence for the Wave file format.
 734 //
 735 // Since we are dealing only with PCM format, we can fudge a bit and take
 736 // advantage of the fact that for all PCM formats, silence can be represented
 737 // by a single byte, repeated to make up the proper word size. The actual size
 738 // of a word of wave data depends on the format:
 739 //
 740 // PCM Format       Word Size       Silence Data
 741 // 8-bit mono       1 byte          0x80
 742 // 8-bit stereo     2 bytes         0x8080
 743 // 16-bit mono      2 bytes         0x0000
 744 // 16-bit stereo    4 bytes         0x00000000
 745 //
 746 ubyte WaveFile::GetSilenceData()
 747 {
 748         ubyte bSilenceData = 0;
 749
 750         // Silence data depends on format of Wave file
 751         if (m_pwfmt_original) {
 752                 if (m_wfmt.bits_per_sample == 8) {
 753                         // For 8-bit formats (unsigned, 0 to 255)
 754                         // Packed DWORD = 0x80808080;
 755                         bSilenceData = 0x80;
 756                 } else if (m_wfmt.bits_per_sample == 16) {
 757                         // For 16-bit formats (signed, -32768 to 32767)
 758                         // Packed DWORD = 0x00000000;
 759                         bSilenceData = 0x00;
 760                 } else {
 761                         Int3();
 762                 }
 763         } else {
 764                 Int3();
 765         }
 766
 767         return bSilenceData;
 768 }
 769
 770 //
 771 // AudioStream class implementation
 772 //
 773 ////////////////////////////////////////////////////////////
 774
 775 // The following constants are the defaults for our streaming buffer operation.
 776 static const ushort DefBufferLength          = 2000; // default buffer length in msec
 777 static const ushort DefBufferServiceInterval = 250;  // default buffer service interval in msec
 778
 779 // Constructor
 780 AudioStream::AudioStream()
 781 {
 782 }
 783
 784 // Destructor
 785 AudioStream::~AudioStream()
 786 {
 787 }
 788
 789 void AudioStream::Init_Data()
 790 {
 791         m_bLooping = false;
 792         m_bFade = false;
 793         m_fade_timer_id = 0;
 794         m_finished_id = 0;
 795         m_bPastLimit = false;
 796
 797         m_bDestroy_when_faded = false;
 798         m_lDefaultVolume = 1.0f;
 799         m_lVolume = 1.0f;
 800         m_lCutoffVolume = 0.0f;
 801         m_bIsPaused = false;
 802         m_silence_written = 0;
 803         m_bReadingDone = false;
 804
 805         m_pwavefile = NULL;
 806
 807         m_fPlaying = m_fCued = false;
 808         m_lInService = false;
 809         m_cbBufOffset = 0;
 810         m_nBufLength = DefBufferLength;
 811         m_cbBufSize = 0;
 812         m_nBufService = DefBufferServiceInterval;
 813         m_nTimeStarted = 0;
 814
 815         memset(m_buffer_ids, 0, sizeof(m_buffer_ids));
 816         m_source_id = 0;
 817         m_play_buffer_id = 0;
 818 }
 819
 820 // Create
 821 bool AudioStream::Create(const char *pszFilename)
 822 {
 823         SDL_assert( pszFilename != NULL );
 824
 825         Init_Data();
 826
 827         if (pszFilename == NULL) {
 828                 return false;
 829         }
 830
 831         // make 100% sure we got a good filename
 832         if ( !strlen(pszFilename) ) {
 833                 return false;
 834         }
 835
 836         // Create a new WaveFile object
 837         m_pwavefile = (WaveFile *)malloc(sizeof(WaveFile));
 838         SDL_assert( m_pwavefile != NULL );
 839
 840         if (m_pwavefile == NULL) {
 841                 nprintf(("Sound", "SOUND => Failed to create WaveFile object %s\n\r", pszFilename));
 842                 return false;
 843         }
 844
 845         // Call constructor
 846         m_pwavefile->Init();
 847
 848         m_pwavefile->m_bits_per_sample_uncompressed = m_bits_per_sample_uncompressed;
 849
 850         // Open given file
 851         if ( m_pwavefile->Open(pszFilename) ) {
 852                 // Calculate sound buffer size in bytes
 853                 // Buffer size is average data rate times length of buffer
 854                 // No need for buffer to be larger than wave data though
 855                 m_cbBufSize = (m_nBufLength/1000) * (m_pwavefile->m_wfmt.bits_per_sample/8) * m_pwavefile->m_wfmt.num_channels * m_pwavefile->m_wfmt.sample_rate;
 856                 m_cbBufSize /= MAX_STREAM_BUFFERS;
 857                 // if the requested buffer size is too big then cap it
 858                 m_cbBufSize = (m_cbBufSize > BIGBUF_SIZE) ? BIGBUF_SIZE : m_cbBufSize;
 859
 860 //              nprintf(("SOUND", "SOUND => Stream buffer created using %d bytes\n", m_cbBufSize));
 861
 862                 // Create sound buffer
 863                 alGenBuffers(MAX_STREAM_BUFFERS, m_buffer_ids);
 864
 865                 Snd_sram += m_cbBufSize * MAX_STREAM_BUFFERS;
 866         } else {
 867                 // Error opening file
 868                 nprintf(("SOUND", "SOUND => Failed to open wave file: %s\n\r", pszFilename));
 869
 870                 m_pwavefile->Close();
 871
 872                 free(m_pwavefile);
 873                 m_pwavefile = NULL;
 874
 875                 return false;
 876         }
 877
 878         return true;
 879 }
 880
 881 // Destroy
 882 bool AudioStream::Destroy()
 883 {
 884         // Stop playback
 885         Stop();
 886
 887         // Release sound buffer
 888         alDeleteBuffers(MAX_STREAM_BUFFERS, m_buffer_ids);
 889
 890         Snd_sram -= m_cbBufSize;
 891
 892         // Delete WaveFile object
 893         if (m_pwavefile) {
 894                 m_pwavefile->Close();
 895
 896                 free(m_pwavefile);
 897                 m_pwavefile = NULL;
 898         }
 899
 900         status = ASF_FREE;
 901
 902         return true;
 903 }
 904
 905 // WriteWaveData
 906 //
 907 // Writes wave data to sound buffer. This is a helper method used by Create and
 908 // ServiceBuffer; it's not exposed to users of the AudioStream class.
 909 bool AudioStream::WriteWaveData(uint size, uint *num_bytes_written, int service)
 910 {
 911         ubyte *uncompressed_wave_data;
 912
 913         *num_bytes_written = 0;
 914
 915         if ( (size == 0) || m_bReadingDone ) {
 916                 return true;
 917         }
 918
 919         if ( (m_buffer_ids[0] == 0) || !m_pwavefile ) {
 920                 return true;
 921         }
 922
 923         if ( service ) {
 924                 SDL_LockMutex(Global_service_lock);
 925         }
 926
 927         if ( service ) {
 928                 uncompressed_wave_data = Wavedata_service_buffer;
 929         } else {
 930                 uncompressed_wave_data = Wavedata_load_buffer;
 931         }
 932
 933         int num_bytes_read = 0;
 934
 935         oal_check_for_errors("AudioStream::WriteWaveData() begin");
 936
 937         if ( !service ) {
 938                 for (int ib = 0; ib < MAX_STREAM_BUFFERS; ib++) {
 939                         num_bytes_read = m_pwavefile->Read(uncompressed_wave_data, m_cbBufSize, service);
 940
 941                         if (num_bytes_read < 0) {
 942                                 m_bReadingDone = 1;
 943                         } else if (num_bytes_read > 0) {
 944                                 alBufferData(m_buffer_ids[ib], m_pwavefile->GetOALFormat(), uncompressed_wave_data, num_bytes_read, m_pwavefile->m_wfmt.sample_rate);
 945                                 alSourceQueueBuffers(m_source_id, 1, &m_buffer_ids[ib]);
 946                                 *num_bytes_written += num_bytes_read;
 947                         }
 948                 }
 949         } else {
 950                 ALint buffers_processed = 0;
 951                 ALuint buffer_id = 0;
 952
 953                 alGetSourcei(m_source_id, AL_BUFFERS_PROCESSED, &buffers_processed);
 954
 955                 while (buffers_processed) {
 956                         alSourceUnqueueBuffers(m_source_id, 1, &buffer_id);
 957
 958                         num_bytes_read = m_pwavefile->Read(uncompressed_wave_data, m_cbBufSize, service);
 959
 960                         if (num_bytes_read < 0) {
 961                                 m_bReadingDone = 1;
 962                         } else if (num_bytes_read > 0) {
 963                                 alBufferData(buffer_id, m_pwavefile->GetOALFormat(), uncompressed_wave_data, num_bytes_read, m_pwavefile->m_wfmt.sample_rate);
 964                                 alSourceQueueBuffers(m_source_id, 1, &buffer_id);
 965                                 *num_bytes_written += num_bytes_read;
 966                         }
 967
 968                         buffers_processed--;
 969                 }
 970         }
 971
 972         oal_check_for_errors("AudioStream::WriteWaveData() end");
 973
 974         if ( service ) {
 975                 SDL_UnlockMutex(Global_service_lock);
 976         }
 977
 978         return true;
 979 }
 980
 981 // GetMaxWriteSize
 982 //
 983 // Helper function to calculate max size of sound buffer write operation, i.e. how much
 984 // free space there is in buffer.
 985 uint AudioStream::GetMaxWriteSize()
 986 {
 987         uint dwMaxSize = m_cbBufSize;
 988         ALint n = 0, q = 0;
 989
 990         oal_check_for_errors("AudioStream::GetMaxWriteSize() begin");
 991
 992         alGetSourcei(m_source_id, AL_BUFFERS_PROCESSED, &n);
 993
 994         alGetSourcei(m_source_id, AL_BUFFERS_QUEUED, &q);
 995
 996         if ( !n && (q >= MAX_STREAM_BUFFERS) ) {
 997                 //all buffers queued
 998                 dwMaxSize = 0;
 999         }
1000
1001         oal_check_for_errors("AudioStream::GetMaxWriteSize() end");
1002
1003         //      nprintf(("Alan","Max write size: %d\n", dwMaxSize));
1004         return dwMaxSize;
1005 }
1006
1007 #define VOLUME_ATTENUATION_BEFORE_CUTOFF        0.03f           //  12db
1008 #define VOLUME_ATTENUATION                                      0.65f
1009
1010 bool AudioStream::ServiceBuffer()
1011 {
1012         float vol;
1013         bool fRtn = true;
1014
1015         if (type == ASF_FREE) {
1016                 return false;
1017         }
1018
1019         if (m_bFade) {
1020                 if (m_lCutoffVolume == 0.0f) {
1021                         vol = Get_Volume();
1022 //                      nprintf(("Alan","Volume is: %d\n",vol));
1023                         m_lCutoffVolume = vol * VOLUME_ATTENUATION_BEFORE_CUTOFF;
1024                 }
1025
1026                 vol = Get_Volume() * VOLUME_ATTENUATION;
1027 //              nprintf(("Alan","Volume is now: %d\n",vol));
1028                 Set_Volume(vol);
1029
1030 //              nprintf(("Sound","SOUND => Volume for stream sound is %d\n",vol));
1031 //              nprintf(("Alan","Cuttoff Volume is: %d\n",m_lCutoffVolume));
1032                 if (vol < m_lCutoffVolume) {
1033                         m_bFade = false;
1034                         m_lCutoffVolume = 0.0f;
1035
1036                         if (m_bDestroy_when_faded) {
1037                                 Destroy();
1038
1039                                 return false;
1040                         }
1041                         else {
1042                                 Stop_and_Rewind();
1043
1044                                 return true;
1045                         }
1046                 }
1047         }
1048
1049         // All of sound not played yet, send more data to buffer
1050         uint dwFreeSpace = GetMaxWriteSize();
1051
1052         // Determine free space in sound buffer
1053         if (dwFreeSpace) {
1054                 // Some wave data remains, but not enough to fill free space
1055                 // Send wave data to buffer, fill remainder of free space with silence
1056                 uint num_bytes_written;
1057
1058                 if ( WriteWaveData(dwFreeSpace, &num_bytes_written) ) {
1059 //                      nprintf(("Alan","Num bytes written: %d\n", num_bytes_written));
1060
1061                         if (m_pwavefile->m_total_uncompressed_bytes_read >= m_pwavefile->m_max_uncompressed_bytes_to_read) {
1062                                 m_fade_timer_id = timer_get_milliseconds() + 1700;              // start fading 1.7 seconds from now
1063                                 m_finished_id = timer_get_milliseconds() + 2000;                // 2 seconds left to play out buffer
1064                                 m_pwavefile->m_max_uncompressed_bytes_to_read = AS_HIGHEST_MAX;
1065                         }
1066
1067                         if ( (m_fade_timer_id > 0) && ((uint)timer_get_milliseconds() > m_fade_timer_id) ) {
1068                                 m_fade_timer_id = 0;
1069                                 Fade_and_Stop();
1070                         }
1071
1072                         if ( (m_finished_id > 0) && ((uint)timer_get_milliseconds() > m_finished_id) ) {
1073                                 m_finished_id = 0;
1074                                 m_bPastLimit = true;
1075                         }
1076
1077                         // see if we're done
1078                         ALint state = 0;
1079
1080                         alGetSourcei(m_source_id, AL_SOURCE_STATE, &state);
1081
1082                         if ( m_bReadingDone && (state != AL_PLAYING) ) {
1083                                 if ( m_bDestroy_when_faded == true ) {
1084                                         Destroy();
1085                                         // Reset reentrancy semaphore
1086
1087                                         return false;
1088                                 }
1089
1090                                 // All of sound has played, stop playback or loop again
1091                                 if ( m_bLooping && !m_bFade) {
1092                                         Play(m_lVolume, m_bLooping);
1093                                 } else {
1094                                         Stop_and_Rewind();
1095                                 }
1096                         }
1097                 } else {
1098                         // Error writing wave data
1099                         fRtn = false;
1100                         Int3();
1101                 }
1102         }
1103
1104         return fRtn;
1105 }
1106
1107 // Cue
1108 void AudioStream::Cue()
1109 {
1110         uint num_bytes_written;
1111
1112         if ( !m_fCued ) {
1113                 m_bFade = false;
1114                 m_fade_timer_id = 0;
1115                 m_finished_id = 0;
1116                 m_bPastLimit = false;
1117                 m_lVolume = 1.0f;
1118                 m_lCutoffVolume = 0.0f;
1119
1120                 m_bDestroy_when_faded = false;
1121
1122                 // Reset buffer ptr
1123                 m_cbBufOffset = 0;
1124
1125                 // Reset file ptr, etc
1126                 m_pwavefile->Cue();
1127
1128                 // Unqueue all buffers
1129                 ALint buffers_processed = 0;
1130                 ALuint buffer_id = 0;
1131
1132                 alGetSourcei(m_source_id, AL_BUFFERS_PROCESSED, &buffers_processed);
1133
1134                 while (buffers_processed) {
1135                         alSourceUnqueueBuffers(m_source_id, 1, &buffer_id);
1136
1137                         buffers_processed--;
1138                 }
1139
1140                 // Fill buffer with wave data
1141                 WriteWaveData(m_cbBufSize, &num_bytes_written, 0);
1142
1143                 m_fCued = true;
1144         }
1145 }
1146
1147 // Play
1148 void AudioStream::Play(float volume, int looping)
1149 {
1150         if ( m_buffer_ids[0] ) {
1151                 oal_check_for_errors("AudioStream::Play() begin");
1152
1153                 // If playing, stop
1154                 if (m_fPlaying) {
1155                         if ( m_bIsPaused == false)
1156                                 Stop_and_Rewind();
1157                 }
1158
1159                 // get source id if we don't have one
1160                 if ( !m_source_id ) {
1161                         sound_channel *chan = oal_get_free_channel(1.0f, -1, SND_PRIORITY_MUST_PLAY);
1162                         m_source_id = chan->source_id;
1163                 }
1164
1165                 // Cue for playback if necessary
1166                 if (!m_fCued) {
1167                         Cue ();
1168                 }
1169
1170                 if (looping == 1) {
1171                         m_bLooping = true;
1172                 } else {
1173                         m_bLooping = false;
1174                 }
1175
1176                 m_nTimeStarted = timer_get_milliseconds();
1177                 Set_Volume(volume);
1178
1179                 // Kick off timer to service buffer
1180                 m_timer.constructor();
1181
1182                 m_timer.Create(m_nBufService, (ptr_u)this, TimerCallback);
1183
1184                 alSourcef(m_source_id, AL_GAIN, m_lVolume);
1185                 alSource3f(m_source_id, AL_POSITION, 0.0f, 0.0f, 0.0f);
1186                 alSource3f(m_source_id, AL_VELOCITY, 0.0f, 0.0f, 0.0f);
1187                 alSource3f(m_source_id, AL_DIRECTION, 0.0f, 0.0f, 0.0f);
1188                 alSourcef(m_source_id, AL_ROLLOFF_FACTOR, 0.0f);
1189                 alSourcei(m_source_id, AL_SOURCE_RELATIVE, AL_TRUE);
1190                 alSourcei(m_source_id, AL_LOOPING, AL_FALSE);
1191
1192                 alSourcePlay(m_source_id);
1193
1194                 // Playback begun, no longer cued
1195                 m_fPlaying = true;
1196                 m_bIsPaused = false;
1197
1198                 oal_check_for_errors("AudioStream::Play() end");
1199         }
1200 }
1201
1202 // Timer callback for Timer object created by ::Play method.
1203 bool AudioStream::TimerCallback(ptr_u dwUser)
1204 {
1205     // dwUser contains ptr to AudioStream object
1206     AudioStream * pas = (AudioStream *) dwUser;
1207
1208     return (pas->ServiceBuffer ());
1209 }
1210
1211 void AudioStream::Set_Byte_Cutoff(unsigned int byte_cutoff)
1212 {
1213         if ( m_pwavefile == NULL )
1214                 return;
1215
1216         m_pwavefile->m_max_uncompressed_bytes_to_read = byte_cutoff;
1217 }
1218
1219 uint AudioStream::Get_Bytes_Committed(void)
1220 {
1221         if (m_pwavefile == NULL) {
1222                 return 0;
1223         }
1224
1225         return m_pwavefile->m_total_uncompressed_bytes_read;
1226 }
1227
1228 // Fade_and_Destroy
1229 void AudioStream::Fade_and_Destroy()
1230 {
1231         m_bFade = true;
1232         m_bDestroy_when_faded = true;
1233 }
1234
1235 // Fade_and_Destroy
1236 void AudioStream::Fade_and_Stop()
1237 {
1238         m_bFade = true;
1239         m_bDestroy_when_faded = false;
1240 }
1241
1242 // Stop
1243 void AudioStream::Stop(bool paused)
1244 {
1245         if (m_fPlaying) {
1246                 if (paused) {
1247                         alSourcePause(m_source_id);
1248                 } else {
1249                         alSourceStop(m_source_id);
1250                         alSourcei(m_source_id, AL_BUFFER, 0);
1251                         m_source_id = 0;
1252                 }
1253
1254                 m_fPlaying = false;
1255                 m_bIsPaused = paused;
1256
1257                 // Delete Timer object
1258                 m_timer.destructor();
1259         }
1260 }
1261
1262 // Stop_and_Rewind
1263 void AudioStream::Stop_and_Rewind()
1264 {
1265         if (m_fPlaying) {
1266                 // Stop playback
1267                 alSourceStop(m_source_id);
1268                 alSourcei(m_source_id, AL_BUFFER, 0);
1269                 m_source_id = 0;
1270
1271                 // Delete Timer object
1272                 m_timer.destructor();
1273
1274                 m_fPlaying = false;
1275         }
1276
1277         m_fCued = false;        // this will cause wave file to start from beginning
1278         m_bReadingDone = false;
1279 }
1280
1281 // Set_Volume
1282 void AudioStream::Set_Volume(float vol)
1283 {
1284         if (m_fPlaying) {
1285                 alSourcef(m_source_id, AL_GAIN, vol);
1286         }
1287
1288         m_lVolume = vol;
1289 }
1290
1291
1292 // Set_Volume
1293 float AudioStream::Get_Volume()
1294 {
1295         return m_lVolume;
1296 }
1297
1298
1299 #define MAX_AUDIO_STREAMS       30
1300 static AudioStream *Audio_streams = NULL;
1301
1302
1303 void audiostream_init()
1304 {
1305         if (Audiostream_inited) {
1306                 return;
1307         }
1308
1309         // Allocate memory for the buffer which holds the uncompressed wave data that is streamed from the
1310         // disk during a load/cue
1311         if (Wavedata_load_buffer == NULL) {
1312                 Wavedata_load_buffer = (ubyte*)malloc(BIGBUF_SIZE);
1313
1314                 if (Wavedata_load_buffer == NULL) {
1315                         goto INIT_ERROR;
1316                 }
1317         }
1318
1319         // Allocate memory for the buffer which holds the uncompressed wave data that is streamed from the
1320         // disk during a service interval
1321         if (Wavedata_service_buffer == NULL) {
1322                 Wavedata_service_buffer = (ubyte*)malloc(BIGBUF_SIZE);
1323
1324                 if (Wavedata_service_buffer == NULL) {
1325                         goto INIT_ERROR;
1326                 }
1327         }
1328
1329         // Allocate memory for the buffer which holds the compressed wave data that is read from the hard disk
1330         if (Compressed_buffer == NULL) {
1331                 Compressed_buffer = (ubyte*)malloc(COMPRESSED_BUFFER_SIZE);
1332
1333                 if (Compressed_buffer == NULL) {
1334                         goto INIT_ERROR;
1335                 }
1336         }
1337
1338         if (Compressed_service_buffer == NULL) {
1339                 Compressed_service_buffer = (ubyte*)malloc(COMPRESSED_BUFFER_SIZE);
1340
1341                 if (Compressed_service_buffer == NULL) {
1342                         goto INIT_ERROR;
1343                 }
1344         }
1345
1346         if (Audio_streams == NULL) {
1347                 Audio_streams = (AudioStream*)malloc(sizeof(AudioStream) * MAX_AUDIO_STREAMS);
1348
1349                 if (Audio_streams == NULL) {
1350                         goto INIT_ERROR;
1351                 }
1352         }
1353
1354         for (int i = 0; i < MAX_AUDIO_STREAMS; i++ ) {
1355                 Audio_streams[i].Init_Data();
1356                 Audio_streams[i].status = ASF_FREE;
1357                 Audio_streams[i].type = ASF_NONE;
1358         }
1359
1360         Global_service_lock = SDL_CreateMutex();
1361
1362         Audiostream_inited = 1;
1363
1364         return;
1365
1366 INIT_ERROR:
1367         if (Wavedata_service_buffer) {
1368                 free(Wavedata_service_buffer);
1369                 Wavedata_service_buffer = NULL;
1370         }
1371
1372         if (Compressed_buffer) {
1373                 free(Compressed_buffer);
1374                 Compressed_buffer = NULL;
1375         }
1376
1377         if (Compressed_service_buffer) {
1378                 free(Compressed_service_buffer);
1379                 Compressed_service_buffer = NULL;
1380         }
1381
1382         if (Audio_streams) {
1383                 free(Audio_streams);
1384                 Audio_streams = NULL;
1385         }
1386
1387         Audiostream_inited = 0;
1388 }
1389
1390 // Close down the audiostream system.  Must call audiostream_init() before any audiostream functions can
1391 // be used.
1392 void audiostream_close()
1393 {
1394         if ( !Audiostream_inited ) {
1395                 return;
1396         }
1397
1398         SDL_assert( Audio_streams != NULL );
1399
1400         for (int i = 0; i < MAX_AUDIO_STREAMS; i++) {
1401                 if ( Audio_streams[i].status == ASF_USED ) {
1402                         Audio_streams[i].status = ASF_FREE;
1403                         Audio_streams[i].Destroy();
1404                 }
1405         }
1406
1407         free(Audio_streams);
1408         Audio_streams = NULL;
1409
1410         // free global buffers
1411         if (Wavedata_load_buffer) {
1412                 free(Wavedata_load_buffer);
1413                 Wavedata_load_buffer = NULL;
1414         }
1415
1416         if (Wavedata_service_buffer) {
1417                 free(Wavedata_service_buffer);
1418                 Wavedata_service_buffer = NULL;
1419         }
1420
1421         if (Compressed_buffer) {
1422                 free(Compressed_buffer);
1423                 Compressed_buffer = NULL;
1424         }
1425
1426         if (Compressed_service_buffer) {
1427                 free(Compressed_service_buffer);
1428                 Compressed_service_buffer = NULL;
1429         }
1430
1431         SDL_DestroyMutex( Global_service_lock );
1432
1433         Audiostream_inited = 0;
1434
1435 }
1436
1437 // Open a digital sound file for streaming
1438 //
1439 // input:       filename        =>      disk filename of sound file
1440 //                              type            => what type of audio stream do we want to open:
1441 //                                                                      ASF_SOUNDFX
1442 //                                                                      ASF_EVENTMUSIC
1443 //                                                                      ASF_VOICE
1444 //
1445 // returns:     success => handle to identify streaming sound
1446 //                              failure => -1
1447 int audiostream_open( const char *filename, int type )
1448 {
1449         int i;
1450
1451         if ( !Audiostream_inited ) {
1452                 return -1;
1453         }
1454
1455         for (i = 0; i < MAX_AUDIO_STREAMS; i++) {
1456                 if (Audio_streams[i].status == ASF_FREE) {
1457                         Audio_streams[i].status = ASF_USED;
1458                         Audio_streams[i].type = type;
1459                         break;
1460                 }
1461         }
1462
1463         if (i == MAX_AUDIO_STREAMS) {
1464                 nprintf(("Sound", "SOUND => No more audio streams available!\n"));
1465                 return -1;
1466         }
1467
1468         switch (type) {
1469                 case ASF_VOICE:
1470                 case ASF_SOUNDFX:
1471                         Audio_streams[i].m_bits_per_sample_uncompressed = 8;
1472                         break;
1473
1474                 case ASF_EVENTMUSIC:
1475                         Audio_streams[i].m_bits_per_sample_uncompressed = 16;
1476                         break;
1477
1478                 default:
1479                         Int3();
1480                         return -1;
1481         }
1482
1483         if ( !Audio_streams[i].Create(filename) ) {
1484                 Audio_streams[i].status = ASF_FREE;
1485                 return -1;
1486         }
1487
1488         return i;
1489 }
1490
1491 void audiostream_close_file(int i, int fade)
1492 {
1493         if ( !Audiostream_inited ) {
1494                 return;
1495         }
1496
1497         if (i < 0) {
1498                 return;
1499         }
1500
1501         SDL_assert( i < MAX_AUDIO_STREAMS );
1502
1503         if (Audio_streams[i].status == ASF_FREE) {
1504                 return;
1505         }
1506
1507         if (fade) {
1508                 Audio_streams[i].Fade_and_Destroy();
1509         } else {
1510                 Audio_streams[i].Destroy();
1511         }
1512 }
1513
1514 void audiostream_close_all(int fade)
1515 {
1516         int i;
1517
1518         if ( !Audiostream_inited ) {
1519                 return;
1520         }
1521
1522         for (i = 0; i < MAX_AUDIO_STREAMS; i++) {
1523                 if (Audio_streams[i].status == ASF_FREE) {
1524                         continue;
1525                 }
1526
1527                 audiostream_close_file(i, fade);
1528         }
1529 }
1530
1531 void audiostream_play(int i, float volume, int looping)
1532 {
1533         if ( !Audiostream_inited ) {
1534                 return;
1535         }
1536
1537         if (i < 0) {
1538                 return;
1539         }
1540
1541         SDL_assert( i < MAX_AUDIO_STREAMS );
1542
1543         if (Audio_streams[i].status == ASF_FREE) {
1544                 return;
1545         }
1546
1547         if (volume < 0.0f) {
1548                 volume = Audio_streams[i].Get_Default_Volume();
1549         }
1550
1551         Audio_streams[i].Set_Default_Volume(volume);
1552         Audio_streams[i].Play(volume, looping);
1553 }
1554
1555 // use as buffer service function
1556 bool audiostream_is_playing(int i)
1557 {
1558         if ( !Audiostream_inited ) {
1559                 return false;
1560         }
1561
1562         if (i < 0) {
1563                 return false;
1564         }
1565
1566         SDL_assert( i < MAX_AUDIO_STREAMS );
1567
1568         if (Audio_streams[i].status == ASF_FREE) {
1569                 return false;
1570         }
1571
1572         return Audio_streams[i].Is_Playing();
1573 }
1574
1575 void audiostream_stop(int i, int rewind, int paused)
1576 {
1577         if ( !Audiostream_inited ) {
1578                 return;
1579         }
1580
1581         if (i < 0) {
1582                 return;
1583         }
1584
1585         SDL_assert( i < MAX_AUDIO_STREAMS );
1586
1587         if (Audio_streams[i].status == ASF_FREE) {
1588                 return;
1589         }
1590
1591         if (rewind) {
1592                 Audio_streams[i].Stop_and_Rewind();
1593         } else {
1594                 Audio_streams[i].Stop( (paused != 0) );
1595         }
1596 }
1597
1598 void audiostream_set_volume_all(float volume, int type)
1599 {
1600         int i;
1601
1602         if ( !Audiostream_inited ) {
1603                 return;
1604         }
1605
1606         for (i = 0; i < MAX_AUDIO_STREAMS; i++) {
1607                 if (Audio_streams[i].status == ASF_FREE) {
1608                         continue;
1609                 }
1610
1611                 if (Audio_streams[i].type == type) {
1612                         Audio_streams[i].Set_Volume(volume);
1613                 }
1614         }
1615 }
1616
1617 void audiostream_set_volume(int i, float volume)
1618 {
1619         if ( !Audiostream_inited ) {
1620                 return;
1621         }
1622
1623         if (i < 0) {
1624                 return;
1625         }
1626
1627         SDL_assert( i < MAX_AUDIO_STREAMS );
1628
1629         if (Audio_streams[i].status == ASF_FREE) {
1630                 return;
1631         }
1632
1633         Audio_streams[i].Set_Volume(volume);
1634 }
1635
1636 bool audiostream_is_paused(int i)
1637 {
1638         if ( !Audiostream_inited ) {
1639                 return false;
1640         }
1641
1642         if (i < 0) {
1643                 return false;
1644         }
1645
1646         SDL_assert( i < MAX_AUDIO_STREAMS );
1647
1648         if (Audio_streams[i].status == ASF_FREE) {
1649                 return false;
1650         }
1651
1652         return Audio_streams[i].Is_Paused();
1653 }
1654
1655 void audiostream_set_byte_cutoff(int i, uint cutoff)
1656 {
1657         if ( !Audiostream_inited ) {
1658                 return;
1659         }
1660
1661         if (i < 0) {
1662                 return;
1663         }
1664
1665         SDL_assert( i < MAX_AUDIO_STREAMS );
1666
1667         if (Audio_streams[i].status == ASF_FREE) {
1668                 return;
1669         }
1670
1671         Audio_streams[i].Set_Byte_Cutoff(cutoff);
1672 }
1673
1674 uint audiostream_get_bytes_committed(int i)
1675 {
1676         if ( !Audiostream_inited ) {
1677                 return 0;
1678         }
1679
1680         if (i < 0) {
1681                 return 0;
1682         }
1683
1684         SDL_assert( i < MAX_AUDIO_STREAMS );
1685
1686         if (Audio_streams[i].status == ASF_FREE) {
1687                 return 0;
1688         }
1689
1690         return Audio_streams[i].Get_Bytes_Committed();
1691 }
1692
1693 bool audiostream_done_reading(int i)
1694 {
1695         if ( !Audiostream_inited ) {
1696                 return true;
1697         }
1698
1699         if (i < 0) {
1700                 return true;
1701         }
1702
1703         SDL_assert( i < MAX_AUDIO_STREAMS );
1704
1705         if (Audio_streams[i].status == ASF_FREE) {
1706                 return true;
1707         }
1708
1709         return Audio_streams[i].Is_Past_Limit();
1710 }
1711
1712 int audiostream_is_inited()
1713 {
1714         return Audiostream_inited;
1715 }
1716
1717 void audiostream_pause(int i)
1718 {
1719         if ( !Audiostream_inited ) {
1720                 return;
1721         }
1722
1723         if (i < 0) {
1724                 return;
1725         }
1726
1727         SDL_assert( i < MAX_AUDIO_STREAMS );
1728
1729         if (Audio_streams[i].status == ASF_FREE) {
1730                 return;
1731         }
1732
1733         if ( audiostream_is_playing(i) ) {
1734                 audiostream_stop(i, 0, 1);
1735         }
1736 }
1737
1738 void audiostream_pause_all()
1739 {
1740         int i;
1741
1742         if ( !Audiostream_inited ) {
1743                 return;
1744         }
1745
1746         for (i = 0; i < MAX_AUDIO_STREAMS; i++) {
1747                 if (Audio_streams[i].status == ASF_FREE) {
1748                         continue;
1749                 }
1750
1751                 audiostream_pause(i);
1752         }
1753 }
1754
1755 void audiostream_unpause(int i)
1756 {
1757         int is_looping;
1758
1759         if ( !Audiostream_inited ) {
1760                 return;
1761         }
1762
1763         if (i < 0) {
1764                 return;
1765         }
1766
1767         SDL_assert( i < MAX_AUDIO_STREAMS );
1768
1769         if (Audio_streams[i].status == ASF_FREE) {
1770                 return;
1771         }
1772
1773         if ( audiostream_is_paused(i) ) {
1774                 is_looping = Audio_streams[i].Is_looping();
1775                 audiostream_play(i, -1.0f, is_looping);
1776         }
1777 }
1778
1779 void audiostream_unpause_all()
1780 {
1781         int i;
1782
1783         if ( !Audiostream_inited ) {
1784                 return;
1785         }
1786
1787         for (i = 0; i < MAX_AUDIO_STREAMS; i++) {
1788                 if (Audio_streams[i].status == ASF_FREE) {
1789                         continue;
1790                 }
1791
1792                 audiostream_unpause(i);
1793         }
1794 }