src/object/objectsnd.cpp

   1 /*
   2  * Copyright (C) Volition, Inc. 1999.  All rights reserved.
   3  *
   4  * All source code herein is the property of Volition, Inc. You may not sell
   5  * or otherwise commercially exploit the source or things you created based on
   6  * the source.
   7  */
   8
   9 /*
  10  * $Logfile: /Freespace2/code/Object/ObjectSnd.cpp $
  11  * $Revision$
  12  * $Date$
  13  * $Author$
  14  *
  15  * C module for managing object-linked persistant sounds
  16  *
  17  * $Log$
  18  * Revision 1.5  2002/06/17 06:33:10  relnev
  19  * ryan's struct patch for gcc 2.95
  20  *
  21  * Revision 1.4  2002/06/09 04:41:24  relnev
  22  * added copyright header
  23  *
  24  * Revision 1.3  2002/06/05 08:05:29  relnev
  25  * stub/warning removal.
  26  *
  27  * reworked the sound code.
  28  *
  29  * Revision 1.2  2002/05/07 03:16:48  theoddone33
  30  * The Great Newline Fix
  31  *
  32  * Revision 1.1.1.1  2002/05/03 03:28:10  root
  33  * Initial import.
  34  *
  35  *
  36  * 11    9/08/99 8:56a Mikek
  37  * Blast.  Suppress a debug warning.
  38  *
  39  * 10    9/08/99 8:56a Mikek
  40  * Whoops, broke the build with debug code.
  41  *
  42  * 9     9/08/99 8:42a Mikek
  43  * Make flyby sounds a lot easier to trigger.  Decrease some thresholds
  44  * and remove the dot product check.  This is handled by the delta
  45  * velocity check.
  46  *
  47  * 8     7/01/99 4:23p Dave
  48  * Full support for multiple linked ambient engine sounds. Added "big
  49  * damage" flag.
  50  *
  51  * 7     7/01/99 11:44a Dave
  52  * Updated object sound system to allow multiple obj sounds per ship.
  53  * Added hit-by-beam sound. Added killed by beam sound.
  54  *
  55  * 6     6/25/99 3:08p Dave
  56  * Multiple flyby sounds.
  57  *
  58  * 5     5/23/99 8:11p Alanl
  59  * Added support for EAX
  60  *
  61  * 4     5/18/99 11:50a Andsager
  62  * Remove unused object type OBJ_GHOST_SAVE
  63  *
  64  * 3     4/23/99 12:01p Johnson
  65  * Added SIF_HUGE_SHIP
  66  *
  67  * 2     10/07/98 10:53a Dave
  68  * Initial checkin.
  69  *
  70  * 1     10/07/98 10:50a Dave
  71  *
  72  * 59    5/15/98 5:16p Dave
  73  * Fix a standalone resetting bug.Tweaked PXO interface. Display captaincy
  74  * status for team vs. team. Put in asserts to check for invalid team vs.
  75  * team situations.
  76  *
  77  * 58    5/07/98 12:24a Hoffoss
  78  * Finished up sidewinder force feedback support.
  79  *
  80  * 57    5/06/98 1:29p Dan
  81  * AL: allow engine sounds to play polyphonically
  82  *
  83  * 56    5/06/98 10:27a Dan
  84  * AL: Fix bug with object sounds and Aureal
  85  *
  86  * 55    4/19/98 9:32p Lawrance
  87  * Add support for Shivan flyby sound
  88  *
  89  * 54    4/18/98 9:12p Lawrance
  90  * Added Aureal support.
  91  *
  92  * 53    4/12/98 5:31p Lawrance
  93  * use timer_get_milliseconds() instead of gettime()
  94  *
  95  * 52    4/08/98 8:33p Lawrance
  96  * increase distance at which flyby sound  is heard
  97  *
  98  * 51    4/01/98 9:21p John
  99  * Made NDEBUG, optimized build with no warnings or errors.
 100  *
 101  * 50    3/21/98 3:36p Lawrance
 102  * Don't change frequency unless a threshold change has been reached.
 103  *
 104  * 49    3/19/98 5:34p Lawrance
 105  * Only play flyby sound if both ships involved are above a minimum speed
 106  *
 107  * 48    3/18/98 9:49a Lawrance
 108  * fix uninitialized data bug
 109  *
 110  * 47    3/17/98 5:55p Lawrance
 111  * Support object-linked sounds for asteroids.
 112  *
 113  * 46    3/14/98 4:59p Lawrance
 114  * Fix bug with object sounds not getting cleared
 115  *
 116  * 45    2/22/98 2:48p John
 117  * More String Externalization Classification
 118  *
 119  * 44    2/20/98 8:32p Lawrance
 120  * Add radius parm to sound_play_3d()
 121  *
 122  * 43    2/12/98 11:53p Lawrance
 123  * move engine pos closer to center of ship, ensure flyby sounds only play
 124  * when flying past a small ship
 125  *
 126  * 42    2/11/98 5:38p Dave
 127  * Put in a global inited flag for objsound.
 128  *
 129  * 41    2/11/98 11:30a Dan
 130  * AL: fix DirectSound3D bug
 131  *
 132  * 40    2/11/98 10:28a Lawrance
 133  * Fix attenuation problems related to engine position.
 134  *
 135  * 39    2/09/98 9:09p Lawrance
 136  * ensure we don't get two flyby sounds too close together
 137  *
 138  * 38    2/02/98 8:23p Lawrance
 139  * double distance at which a flyby sound is played
 140  *
 141  * 37    1/29/98 10:31a Lawrance
 142  * Don't play doppler effect for cruisers and capital ships
 143  *
 144  * 36    1/20/98 10:04a Lawrance
 145  * fix volume bug, do obj_snd_do_frame at 10Hz
 146  *
 147  * 35    1/20/98 9:47a Mike
 148  * Suppress optimized compiler warnings.
 149  * Some secondary weapon work.
 150  *
 151  * 34    1/10/98 1:14p John
 152  * Added explanation to debug console commands
 153  *
 154  * 33    12/21/97 4:33p John
 155  * Made debug console functions a class that registers itself
 156  * automatically, so you don't need to add the function to
 157  * debugfunctions.cpp.
 158  *
 159  * 32    11/20/97 6:45p Lawrance
 160  * allow two looping debris sounds to play
 161  *
 162  * 31    11/04/97 10:18a Dan
 163  * initialize closest_obj to NULL
 164  *
 165  * 30    11/03/97 11:09p Lawrance
 166  * Only play flyby sound for ships (ie not debris).
 167  *
 168  * 29    10/26/97 3:22p Lawrance
 169  * use volume and not distance when deciding which engine sounds to play
 170  *
 171  * 28    10/22/97 10:37a Johnson
 172  * ALAN: ensure that object sounds are only deleted once
 173  *
 174  * 27    10/10/97 7:43p Lawrance
 175  * use SF_ENGINES_ON flag
 176  *
 177  * 26    10/06/97 4:13p Lawrance
 178  * use engine pos when updating volume for object sounds
 179  *
 180  * 25    10/01/97 5:55p Lawrance
 181  * change call to snd_play_3d() to allow for arbitrary listening position
 182  *
 183  * 24    9/18/97 7:58a Lawrance
 184  * use rear of ship when deciding where to play the engine sound
 185  *
 186  * 23    9/11/97 5:01p Dave
 187  * Minor changes to handle ingame joining/dropping for multiplayer.
 188  *
 189  * 22    9/03/97 5:02p Lawrance
 190  * add engine stuttering when a ship is dying
 191  *
 192  * 21    8/29/97 5:04p Dave
 193  * Made sure ghost objects are handled correctly.
 194  *
 195  * 20    7/28/97 11:38a Lawrance
 196  * let ship engine scale with speed for DirectSound3D engine sounds too
 197  *
 198  * 19    7/27/97 5:14p Lawrance
 199  * add afterburners to the player control info
 200  *
 201  * 18    7/14/97 12:04a Lawrance
 202  * make Obj_snd_enabled visible
 203  *
 204  * 17    7/09/97 12:07a Mike
 205  * Changes in ship_info struct.
 206  *
 207  * 16    7/08/97 11:38a Lawrance
 208  * added SIF_BIG_SHIP flag (used for object-linked engine sounds)
 209  *
 210  * 15    6/23/97 10:15a Lawrance
 211  * fix bug with object linked sounds not stopping playing sounds
 212  *
 213  * 14    6/19/97 2:05p Lawrance
 214  * when stopping  a linked sound, stop it right away
 215  *
 216  * 13    6/09/97 11:50p Lawrance
 217  * integrating DirectSound3D
 218  *
 219  * 12    6/08/97 5:59p Lawrance
 220  * comment out ds3d stuff for now
 221  *
 222  * 11    6/06/97 4:13p Lawrance
 223  * use an index instead of a pointer for object-linked sounds
 224  *
 225  * 10    6/05/97 1:37a Lawrance
 226  * change to support snd_get_vol_and_pan()
 227  *
 228  * 9     6/05/97 1:07a Lawrance
 229  * changes to support sound interface
 230  *
 231  * 8     6/02/97 1:50p Lawrance
 232  * supporting integration with Direct3D
 233  *
 234  * 7     5/18/97 2:40p Lawrance
 235  * added debug function to toggle doppler effect
 236  *
 237  * 6     5/15/97 9:05a Lawrance
 238  * comment out some debugging nprintf()'s
 239  *
 240  * 5     5/14/97 10:47a Lawrance
 241  * only play external engine sound for loudest ship
 242  *
 243  * 4     5/09/97 4:33p Lawrance
 244  * doppler effects
 245  *
 246  * 3     5/09/97 9:41a Lawrance
 247  * modified comments
 248  *
 249  * 2     5/08/97 4:30p Lawrance
 250  * split off object sound stuff into separate file
 251  *
 252  * $NoKeywords: $
 253  */
 254
 255
 256 #include "object.h"
 257 #include "objectsnd.h"
 258 #include "linklist.h"
 259 #include "ship.h"
 260 #include "gamesnd.h"
 261 #include "oal.h"
 262 #include "timer.h"
 263 #include "3d.h"
 264 #include "joy_ff.h"
 265
 266 // Persistant sounds for objects (pointer to obj_snd is in object struct)
 267 typedef struct _obj_snd {
 268         _obj_snd        *next, *prev;
 269         int             objnum;                 // object index of object that contains this sound
 270         int             id;                             // Index into Snds[] array
 271         int             instance;               // handle of currently playing sound (a ds3d handle if USES_DS3D flag set)
 272         int             next_update;    // timestamp that marks next allowed vol/pan change
 273         float           vol;                            // volume of sound (range: 0.0 -> 1.0)
 274         float           pan;                            // pan of sound (range: -1.0 -> 1.0)
 275         int             freq;                           // valid range: 100 -> 100000 Hz
 276         int             flags;
 277         vector  offset;                 // offset from the center of the object where the sound lives
 278 } obj_snd;
 279
 280 #define VOL_PAN_UPDATE                  50                                              // time in ms to update a persistant sound vol/pan
 281 #define MIN_PERSISTANT_VOL              0.10f
 282 #define MIN_FORWARD_SPEED               5
 283 #define SPEED_SOUND                             600.0f                          // speed of sound in FreeSpace
 284
 285 #define MAX_OBJ_SOUNDS_PLAYING                                          5
 286 static  int Num_obj_sounds_playing;
 287
 288 #define OBJSND_CHANGE_FREQUENCY_THRESHOLD                       10
 289
 290 static  obj_snd obj_snd_list;                                           // head of linked list of object sound structs
 291 static  int             Doppler_enabled = TRUE;
 292
 293 #define MAX_OBJ_SNDS    256
 294 obj_snd Objsnds[MAX_OBJ_SNDS];
 295
 296 int             Obj_snd_enabled = TRUE;
 297 int             Obj_snd_last_update;                                                    // timer used to run object sound updates at fixed time intervals
 298 int             Obj_snd_level_inited=0;
 299
 300 // ship flyby data
 301 #define FLYBY_MIN_DISTANCE                              90
 302 #define FLYBY_MIN_SPEED                                 50
 303 #define FLYBY_MIN_RELATIVE_SPEED                100
 304 #define FLYBY_MIN_NEXT_TIME                             1000    // in ms
 305 #define FLYBY_MIN_REPEAT_TIME                   4000    // in ms
 306 int             Flyby_next_sound;
 307 int             Flyby_next_repeat;
 308 object  *Flyby_last_objp;
 309
 310 // return the world pos of the sound source on a ship.
 311 void obj_snd_source_pos(vector *sound_pos, obj_snd *osp)
 312 {
 313         vector offset_world;
 314         object *objp = &Objects[osp->objnum];
 315
 316         // get sound pos in world coords
 317         vm_vec_unrotate(&offset_world, &osp->offset, &objp->orient);
 318         vm_vec_add(sound_pos, &objp->pos, &offset_world);
 319 }
 320
 321 // ---------------------------------------------------------------------------------------
 322 // dcf_objsnd()
 323 //
 324 // Debug console function for object linked persistant sounds
 325 //
 326 //XSTR:OFF
 327 DCF(objsnd, "Persistant sound stuff" )
 328 {
 329         char            buf1[16], buf2[64];
 330         obj_snd *osp;
 331
 332         if ( Dc_command )       {
 333                 dc_get_arg(ARG_STRING|ARG_NONE);
 334
 335                 if ( Dc_arg_type & ARG_NONE ) {
 336                         if ( Obj_snd_enabled == TRUE ) {
 337                                 obj_snd_stop_all();
 338                                 Obj_snd_enabled = FALSE;
 339                         }
 340                         else {
 341                                 Obj_snd_enabled = TRUE;
 342                         }
 343                 }
 344                 if ( !SDL_strcasecmp( Dc_arg, "list" )) {
 345                         for ( osp = GET_FIRST(&obj_snd_list); osp !=END_OF_LIST(&obj_snd_list); osp = GET_NEXT(osp) ) {
 346                                 SDL_assert(osp != NULL);
 347                                 if ( osp->instance == -1 ) {
 348                                         continue;
 349                                         //strcpy(buf1,"OFF");
 350                                 } else {
 351                                         SDL_strlcpy(buf1, "ON", SDL_arraysize(buf1));
 352                                 }
 353
 354                                 if ( Objects[osp->objnum].type == OBJ_SHIP ) {
 355                                         SDL_strlcpy(buf2, Ships[Objects[osp->objnum].instance].ship_name, SDL_arraysize(buf2));
 356                                 }
 357                                 else if ( Objects[osp->objnum].type == OBJ_DEBRIS ) {
 358                                         SDL_strlcpy(buf2, "Debris", SDL_arraysize(buf2));
 359                                 }
 360                                 else {
 361                                         SDL_strlcpy(buf2, "Unknown", SDL_arraysize(buf2));
 362                                 }
 363
 364                                 vector source_pos;
 365                                 float distance;
 366
 367                                 obj_snd_source_pos(&source_pos, osp);
 368                                 distance = vm_vec_dist_quick( &source_pos, &View_position );
 369
 370                                 dc_printf("Object %d => name: %s vol: %.2f pan: %.2f dist: %.2f status: %s\n", osp->objnum, buf2, osp->vol, osp->pan, distance, buf1);
 371                         } // end for
 372                                 dc_printf("Number object-linked sounds playing: %d\n", Num_obj_sounds_playing);
 373                 }
 374         }
 375
 376         if ( Dc_help ) {
 377                 dc_printf ("Usage: objsnd [list]\n");
 378                 dc_printf ("[list] --  displays status of all objects with linked sounds\n");
 379                 dc_printf ("with no parameters, object sounds are toggled on/off\n");
 380                 Dc_status = 0;
 381         }
 382
 383         if ( Dc_status )        {
 384                 dc_printf( "Object sounds are: %s\n", (Obj_snd_enabled?"ON":"OFF") );
 385         }
 386 }
 387 //XSTR:ON
 388
 389 // ---------------------------------------------------------------------------------------
 390 // Debug console function for toggling doppler effection on/off
 391 //
 392 DCF_BOOL( doppler, Doppler_enabled )
 393
 394
 395 // ---------------------------------------------------------------------------------------
 396 // obj_snd_get_slot()
 397 //
 398 // Get a free slot in the Objsnds[] array
 399 //
 400 //      returns -1 if no slot is available
 401 int obj_snd_get_slot()
 402 {
 403         int i;
 404
 405         for ( i = 0; i < MAX_OBJ_SNDS; i++ ) {
 406                 if ( !(Objsnds[i].flags & OS_USED) )
 407                         return i;
 408         }
 409
 410         return -1;
 411 }
 412
 413 // ---------------------------------------------------------------------------------------
 414 // obj_snd_init()
 415 //
 416 // Called once at level start to initialize the persistant object sound system
 417 //
 418 void obj_snd_level_init()
 419 {
 420         int i;
 421
 422         list_init(&obj_snd_list);
 423         for ( i = 0; i < MAX_OBJ_SNDS; i++ ) {
 424                 Objsnds[i].flags = 0;
 425         }
 426
 427         Num_obj_sounds_playing = 0;
 428         Flyby_next_sound = 1;
 429         Flyby_next_repeat = 1;
 430         Flyby_last_objp = NULL;
 431         Obj_snd_last_update=0;
 432
 433         Obj_snd_level_inited=1;
 434 }
 435
 436
 437 // ---------------------------------------------------------------------------------------
 438 // obj_snd_stop()
 439 //
 440 // Stop a persistant sound from playing.
 441 //
 442 // parameters:  objp                    => pointer to object that sound is to be stopped for
 443 //
 444 //
 445 void obj_snd_stop(object *objp, int index)
 446 {
 447         obj_snd *osp;
 448         int idx;
 449
 450         // sanity
 451         if(index >= MAX_OBJECT_SOUNDS){
 452                 Int3();
 453                 return;
 454         }
 455
 456         // if index is -1, kill all sounds for this guy
 457         if(index == -1){
 458                 // kill all sounds for this guy
 459                 for(idx=0; idx<MAX_OBJECT_SOUNDS; idx++){
 460                         if ( objp->objsnd_num[idx] == -1 ){
 461                                 continue;
 462                         }
 463
 464                         osp = &Objsnds[objp->objsnd_num[idx]];
 465
 466                         if ( osp->instance != -1 ) {
 467                                 snd_stop(osp->instance);
 468                                 osp->instance = -1;
 469                                 switch(objp->type) {
 470                                         case OBJ_SHIP:
 471                                         case OBJ_GHOST:
 472                                         case OBJ_DEBRIS:
 473                                         case OBJ_ASTEROID:
 474                                                 Num_obj_sounds_playing--;
 475                                                 SDL_assert(Num_obj_sounds_playing >= 0);
 476                                                 break;
 477
 478                                         default:
 479                                                 Int3(); // get Alan
 480                                                 break;
 481                                 }
 482                         }
 483                 }
 484         } else {
 485                 if ( objp->objsnd_num[index] == -1 ){
 486                         return;
 487                 }
 488
 489                 osp = &Objsnds[objp->objsnd_num[index]];
 490
 491                 if ( osp->instance != -1 ) {
 492                         snd_stop(osp->instance);
 493                         osp->instance = -1;
 494                         switch(objp->type) {
 495                         case OBJ_SHIP:
 496                         case OBJ_GHOST:
 497                         case OBJ_DEBRIS:
 498                         case OBJ_ASTEROID:
 499                                 Num_obj_sounds_playing--;
 500                                 SDL_assert(Num_obj_sounds_playing >= 0);
 501                                 break;
 502
 503                         default:
 504                                 Int3(); // get Alan
 505                                 break;
 506                         }
 507                 }
 508         }
 509 }
 510
 511 // ---------------------------------------------------------------------------------------
 512 // obj_snd_stop_all()
 513 //
 514 // Stop all object-linked persistant sounds from playing
 515 //
 516 //
 517 void obj_snd_stop_all()
 518 {
 519         object* A;
 520
 521         for ( A = GET_FIRST(&obj_used_list); A !=END_OF_LIST(&obj_used_list); A = GET_NEXT(A) ) {
 522                 if ( A ) {
 523                         obj_snd_stop(A, -1);
 524                 }
 525         }
 526 }
 527
 528 // ---------------------------------------------------------------------------------------
 529 // obj_snd_get_freq()
 530 //
 531 // Calculate the frequency of a sound to be played, based on the relative velocities
 532 // of the source and observor
 533 //
 534 //      returns:                frequency of the sound
 535 //
 536 int obj_snd_get_freq(int source_freq, object* source, object* observor, vector *source_pos)
 537 {
 538         vector  v_os, v_so;     // os == observor to source, so == source to observor
 539         float           vo, vs, freq;
 540
 541         vm_vec_normalized_dir(&v_os, source_pos, &observor->pos);
 542         vm_vec_normalized_dir(&v_so, &observor->pos, source_pos);
 543
 544         vo = vm_vec_dotprod(&v_os, &observor->phys_info.vel);
 545         vs = vm_vec_dotprod(&v_so, &source->phys_info.vel);
 546
 547         freq = source_freq * ( (SPEED_SOUND + vo) / (SPEED_SOUND - vs) );
 548         return fl2i(freq);
 549 }
 550
 551
 552 // ---------------------------------------------------------------------------------------
 553 // obj_snd_stop_lowest_vol()
 554 //
 555 //      Stop a playing object sound, if it is quieter than sound at new_distance
 556 //
 557 // input:               new_vol                 =>      volume of requested sound to play
 558 //
 559 //      returns:                TRUE    =>              A sound was stopped
 560 //                                      FALSE   =>              A sound was not stopped
 561 //
 562 int obj_snd_stop_lowest_vol(float new_vol)
 563 {
 564         obj_snd                 *osp;
 565         object                  *objp = NULL;
 566         obj_snd                 *lowest_vol_osp = NULL;
 567         float                           lowest_vol;
 568         int obj_snd_index = -1;
 569         int idx;
 570
 571         lowest_vol = 1000.0f;
 572         for ( osp = GET_FIRST(&obj_snd_list); osp !=END_OF_LIST(&obj_snd_list); osp = GET_NEXT(osp) ) {
 573                 SDL_assert(osp->objnum != -1);
 574
 575                 if ( (osp->instance != -1) && (osp->vol < lowest_vol) ) {
 576                         lowest_vol = osp->vol;
 577                         lowest_vol_osp = osp;
 578                 }
 579         }
 580
 581         if (lowest_vol_osp == NULL) {
 582                 Int3();
 583                 return FALSE;
 584         }
 585
 586         objp = &Objects[lowest_vol_osp->objnum];
 587
 588         if ( (lowest_vol < new_vol) && (objp != NULL) ) {
 589                 // determine what index in this guy the sound is
 590                 for(idx=0; idx<MAX_OBJECT_SOUNDS; idx++){
 591                         if(objp->objsnd_num[idx] == (lowest_vol_osp - Objsnds)){
 592                                 obj_snd_index = idx;
 593                                 break;
 594                         }
 595                 }
 596
 597                 if((obj_snd_index == -1) || (obj_snd_index >= MAX_OBJECT_SOUNDS)){
 598                         Int3();         // get dave
 599                 } else {
 600                         obj_snd_stop(objp, obj_snd_index);
 601                 }
 602
 603                 return TRUE;
 604         }
 605
 606         return FALSE;
 607 }
 608
 609 //int Debug_1 = 0, Debug_2 = 0;
 610
 611 // ---------------------------------------------------------------------------------------
 612 // maybe_play_flyby_snd()
 613 //
 614 // Based on how close the object is to the player ship (and relative speed), maybe
 615 // play a flyby sound.  Only play flyby sound for OBJ_SHIP objects.
 616 //
 617 // NOTE: global data Flyby_last_objp, Flyby_next_sound, Flyby_next_repeat are
 618 //                      used.
 619 //
 620 void maybe_play_flyby_snd(float closest_dist, object *closest_objp)
 621 {
 622         if ( closest_objp == NULL || closest_objp->type != OBJ_SHIP ) {
 623                 goto play_no_flyby_sound;
 624         }
 625
 626         if ( closest_dist < FLYBY_MIN_DISTANCE ) {
 627                 float relative_speed;
 628                 vector diff;
 629                 vm_vec_sub(&diff, &Player_obj->phys_info.vel, &closest_objp->phys_info.vel);
 630
 631
 632                 relative_speed = vm_vec_mag_quick(&diff);
 633                 if ( relative_speed > FLYBY_MIN_RELATIVE_SPEED ) {
 634                         if ( timestamp_elapsed(Flyby_next_sound) ) {
 635
 636                                 if ( closest_objp == Flyby_last_objp ) {
 637                                         if ( timestamp_elapsed(Flyby_next_repeat) ) {
 638                                                 Flyby_next_repeat = timestamp(FLYBY_MIN_REPEAT_TIME);
 639                                         }
 640                                         else
 641                                                 goto play_no_flyby_sound;
 642                                 }
 643
 644                                 SDL_assert(closest_objp->type == OBJ_SHIP);
 645                                 if(closest_objp->type != OBJ_SHIP){
 646                                         return;
 647                                 }
 648
 649                                 // pick a random species-based sound
 650                                 ship_info *sip = &Ship_info[Ships[closest_objp->instance].ship_info_index];
 651                                 int species = SPECIES_TERRAN;
 652                                 if((sip->species >= 0) && (sip->species < MAX_SPECIES_NAMES)){
 653                                         species = sip->species;
 654                                 }
 655                                 int ship_size = 0;      // fighter
 656                                 if(sip->flags & SIF_BOMBER){
 657                                         ship_size = 1;
 658                                 }
 659
 660                                 // play da sound
 661                                 snd_play_3d(&Snds_flyby[species][ship_size], &closest_objp->pos, &View_position);
 662                                 //snd_play_3d(&Snds_flyby[Debug_1][Debug_2], &closest_objp->pos, &View_position);
 663
 664                                 //float dist = vm_vec_dist(&closest_objp->pos, &View_position);
 665                                 //nprintf(("AI", "Frame %i: Playing flyby sound, species = %i, size = %i, dist = %7.3f\n", Framecount, species, ship_size, dist));
 666 //                              nprintf(("AI", "Frame %i: Playing flyby sound, species = %i, size = %i, dist = %7.3f\n", Framecount, Debug_1, Debug_2, dist));
 667 //Debug_1 = (Debug_1+1)%3;
 668 //Debug_2 = (Debug_2+1)%2;
 669
 670                                 joy_ff_fly_by(100 - (int) (100.0f * closest_dist / FLYBY_MIN_DISTANCE));
 671
 672                                 Flyby_next_sound = timestamp(FLYBY_MIN_NEXT_TIME);
 673                                 Flyby_last_objp = closest_objp;
 674                         }
 675                 }
 676         }
 677
 678         play_no_flyby_sound:
 679         return;
 680 }
 681
 682 // ---------------------------------------------------------------------------------------
 683 // obj_snd_do_frame()
 684 //
 685 // Called once per frame to process the persistant sound objects
 686 //
 687 void obj_snd_do_frame()
 688 {
 689         float                           closest_dist, distance, speed_vol_multiplier, percent_max;
 690         obj_snd                 *osp;
 691         object                  *objp, *closest_objp;
 692         game_snd                        *gs;
 693         ship                            *sp;
 694         int                             go_ahead_flag;
 695         vector                  source_pos;
 696         float                           add_distance;
 697
 698         if ( Obj_snd_enabled == FALSE )
 699                 return;
 700
 701         int now = timer_get_milliseconds();
 702         if ( (now - Obj_snd_last_update) > 100 ) {
 703                 Obj_snd_last_update=now;
 704         } else {
 705                 return;
 706         }
 707
 708         closest_dist = 1000000.0f;
 709         closest_objp = NULL;
 710
 711         for ( osp = GET_FIRST(&obj_snd_list); osp !=END_OF_LIST(&obj_snd_list); osp = GET_NEXT(osp) ) {
 712                 SDL_assert(osp != NULL);
 713                 objp = &Objects[osp->objnum];
 714                 if ( Player_obj == objp ) {
 715                         continue;
 716                 }
 717
 718                 gs = &Snds[osp->id];
 719
 720                 obj_snd_source_pos(&source_pos, osp);
 721                 distance = vm_vec_dist_quick( &source_pos, &View_position );
 722
 723                 // how much extra distance do we add before attentuation?
 724                 add_distance = 0.0f;
 725                 if(osp->flags & OS_MAIN){
 726                         add_distance = objp->radius;
 727                 }
 728
 729                 distance -= add_distance;
 730                 if ( distance < 0 ) {
 731                         distance = 0.0f;
 732                 }
 733
 734                 // save closest distance (used for flyby sound) if this is a small ship
 735                 if ( (objp->type == OBJ_SHIP) && (distance < closest_dist) ) {
 736                         if ( Ship_info[Ships[objp->instance].ship_info_index].flags & SIF_SMALL_SHIP ) {
 737                                 closest_dist = distance;
 738                                 closest_objp = objp;
 739                         }
 740                 }
 741
 742                 // If the object is a ship, we don't want to start the engine sound unless the ship is
 743                 // moving (unless flag SIF_BIG_SHIP is set)
 744                 speed_vol_multiplier = 1.0f;
 745                 if ( objp->type == OBJ_SHIP ) {
 746                         if ( !(Ship_info[Ships[objp->instance].ship_info_index].flags & (SIF_BIG_SHIP | SIF_HUGE_SHIP)) ) {
 747                                 if ( objp->phys_info.max_vel.xyz.z <= 0 ) {
 748                                         percent_max = 0.0f;
 749                                 }
 750                                 else
 751                                         percent_max = objp->phys_info.fspeed / objp->phys_info.max_vel.xyz.z;
 752
 753                                 if ( percent_max >= 0.5 )
 754                                         speed_vol_multiplier = 1.0f;
 755                                 else {
 756                                         speed_vol_multiplier = 0.5f + (percent_max);    // linear interp: 0.5->1.0 when 0.0->0.5
 757                                 }
 758                         }
 759                 }
 760
 761                 go_ahead_flag = TRUE;
 762                 float max_vol,new_vol;
 763                 if ( osp->instance == -1 ) {
 764                         if ( distance < Snds[osp->id].max ) {
 765                                 max_vol = Snds[osp->id].default_volume;
 766                                 if ( distance <= Snds[osp->id].min ) {
 767                                         new_vol = max_vol;
 768                                 }
 769                                 else {
 770                                         new_vol = max_vol - (distance - Snds[osp->id].min) * max_vol / (Snds[osp->id].max - Snds[osp->id].min);
 771                                 }
 772
 773                                 if ( new_vol < 0.1 ) {
 774                                         continue;
 775                                 }
 776
 777                                 switch( objp->type ) {
 778                                         case OBJ_SHIP:
 779                                         case OBJ_DEBRIS:
 780                                         case OBJ_ASTEROID:
 781                                                 if ( Num_obj_sounds_playing >= MAX_OBJ_SOUNDS_PLAYING ) {
 782                                                         go_ahead_flag = obj_snd_stop_lowest_vol(new_vol);
 783                                                 }
 784                                                 break;
 785
 786                                         default:
 787                                                 Int3(); // get Alan
 788                                                 break;
 789                                 } // end switch
 790
 791                                 if ( go_ahead_flag ) {
 792                                         osp->instance = snd_play_3d(gs, &source_pos, &View_position, add_distance, &objp->phys_info.vel, 1, 1.0f, SND_PRIORITY_TRIPLE_INSTANCE);
 793                                         if ( osp->instance != -1 ) {
 794                                                 Num_obj_sounds_playing++;
 795                                         }
 796                                 }
 797                                 SDL_assert(Num_obj_sounds_playing <= MAX_OBJ_SOUNDS_PLAYING);
 798
 799                         } //            end if ( distance < Snds[osp->id].max )
 800                 } //            if ( osp->instance == -1 )
 801                 else {
 802                         if ( distance > Snds[osp->id].max ) {
 803                                 int sound_index = -1;
 804                                 int idx;
 805
 806                                 // determine which sound index it is for this guy
 807                                 for(idx=0; idx<MAX_OBJECT_SOUNDS; idx++){
 808                                         if(objp->objsnd_num[idx] == (osp - Objsnds)){
 809                                                 sound_index = idx;
 810                                                 break;
 811                                         }
 812                                 }
 813
 814                                 SDL_assert(sound_index != -1);
 815                                 obj_snd_stop(objp, sound_index);                                                // currently playing sound has gone past maximum
 816                         }
 817                 }
 818
 819                 if ( osp->instance == -1 )
 820                         continue;
 821
 822                 sp = NULL;
 823                 if ( objp->type == OBJ_SHIP )
 824                         sp = &Ships[objp->instance];
 825
 826                 // for 3D sounds, re-establish the maximum speed based on the
 827                 //      speed_vol_multiplier
 828                 if ( sp == NULL || ( (sp != NULL) && (sp->flags & SF_ENGINES_ON) ) ) {
 829                         snd_set_volume( osp->instance, gs->default_volume*speed_vol_multiplier );
 830                 }
 831                 else {
 832                         // engine sound is disabled
 833                         snd_set_volume( osp->instance, 0.0f );
 834                 }
 835
 836                 vector *vel=NULL;
 837                 vel = &objp->phys_info.vel;
 838
 839                 // Don't play doppler effect for cruisers or captials
 840                 if ( sp ) {
 841                         if ( ship_get_SIF(sp) & (SIF_BIG_SHIP | SIF_HUGE_SHIP) ) {
 842                                 vel=NULL;
 843                         }
 844                 }
 845
 846                 snd_update_source(osp->instance, gs->min, gs->max, &source_pos, vel);
 847                 snd_get_3d_vol_and_pan(gs, &source_pos, &osp->vol, &osp->pan, add_distance);
 848         }       // end for
 849
 850         // see if we want to play a flyby sound
 851         maybe_play_flyby_snd(closest_dist, closest_objp);
 852 }
 853
 854 // ---------------------------------------------------------------------------------------
 855 // obj_snd_assign()
 856 //
 857 // Assign a persistant sound to an object.
 858 //
 859 // parameters:  objnum          => index of object that sound is being assigned to
 860 //              i                               => Index into Snds[] array
 861 //                                       fname          => filename of sound to play ( so DS3D can load the sound )
 862 //
 863 // returns:     -1                      => sound could not be assigned (possible, since only MAX_OBJECT_SOUNDS persistant
 864 //                                                                              sound can be assigned per object).
 865 //               0                      => sound was successfully assigned
 866 //
 867 int obj_snd_assign(int objnum, int i, vector *pos, int main)
 868 {
 869         obj_snd *snd;
 870         object  *objp;
 871         int idx, sound_index;
 872
 873         objp = &Objects[objnum];
 874
 875         if ( Obj_snd_enabled == FALSE )
 876                 return -1;
 877
 878         // try and find a valid objsound index
 879         sound_index = -1;
 880         for(idx=0; idx<MAX_OBJECT_SOUNDS; idx++){
 881                 if(objp->objsnd_num[idx] == -1){
 882                         sound_index = idx;
 883                         break;
 884                 }
 885         }
 886
 887         // no sound. doh!
 888         if ( sound_index == -1 ){
 889                 return -1;
 890         }
 891
 892         objp->objsnd_num[sound_index] = (short)obj_snd_get_slot();
 893         if ( objp->objsnd_num[sound_index] == -1 ) {
 894                 nprintf(("Sound", "SOUND ==> No free object-linked sounds left\n"));
 895                 return -1;
 896         }
 897         snd = &Objsnds[objp->objsnd_num[sound_index]];
 898         snd->flags = OS_USED;
 899
 900         if(main){
 901                 snd->flags |= OS_MAIN;
 902         }
 903
 904         if ( i == -1 ) {
 905                 return -1;
 906         }
 907         snd->id = i;
 908
 909         snd->instance = -1;
 910         snd->vol = 0.0f;
 911         snd->objnum = OBJ_INDEX(objp);
 912         snd->next_update = 1;
 913         snd->offset = *pos;
 914         // vm_vec_sub(&snd->offset, pos, &objp->pos);
 915
 916         // add objp to the obj_snd_list
 917         list_append( &obj_snd_list, snd );
 918
 919         return 0;
 920 }
 921
 922
 923 // ---------------------------------------------------------------------------------------
 924 // obj_snd_delete()
 925 //
 926 // Remove a persistant sound that has been assigned to an object.
 927 //
 928 // parameters:  objnum          => index of object that sound is being removed from.
 929 //
 930 //
 931 void    obj_snd_delete(int objnum, int sndnum)
 932 {
 933         object  *objp;
 934         obj_snd *osp;
 935         int idx;
 936
 937         SDL_assert(objnum >= 0 && objnum < MAX_OBJECTS);
 938         objp = &Objects[objnum];
 939
 940         // delete all object sounds for this guy
 941         for(idx=0; idx<MAX_OBJECT_SOUNDS; idx++){
 942                 // no sound
 943                 if ( objp->objsnd_num[idx] == -1 ){
 944                         continue;
 945                 }
 946
 947                 osp = &Objsnds[objp->objsnd_num[idx]];
 948
 949                 // if we're just deleting a specific sound type
 950                 // and this is not one of them. skip it.
 951                 if((sndnum != -1) && (osp->id != sndnum)){
 952                         continue;
 953                 }
 954
 955                 obj_snd_stop(objp, -1);
 956
 957                 // remove objp from the obj_snd_list
 958                 list_remove( &obj_snd_list, osp );
 959                 osp->objnum = -1;
 960                 osp->flags = 0;
 961                 osp = NULL;
 962                 objp->objsnd_num[idx] = -1;
 963         }
 964 }
 965
 966 // ---------------------------------------------------------------------------------------
 967 // obj_snd_delete_all()
 968 //
 969 // Remove all persistant sounds
 970 //
 971 void obj_snd_delete_all()
 972 {
 973         /*
 974         obj_snd *osp, *temp;
 975
 976         osp = GET_FIRST(&obj_snd_list);
 977         while( (osp != NULL) && (osp !=END_OF_LIST(&obj_snd_list)) )    {
 978                 temp = GET_NEXT(osp);
 979                 SDL_assert( osp->objnum != -1 );
 980
 981                 obj_snd_delete( osp->objnum );
 982
 983                 osp = temp;
 984         }
 985         */
 986
 987         int idx;
 988         for(idx=0; idx<MAX_OBJ_SNDS; idx++){
 989                 if(Objsnds[idx].flags & OS_USED){
 990                         obj_snd_delete(Objsnds[idx].objnum);
 991                 }
 992         }
 993 }
 994
 995 // ---------------------------------------------------------------------------------------
 996 // obj_snd_close()
 997 //
 998 // Called once at game close to de-initialize the persistant object sound system
 999 //
1000 void obj_snd_level_close()
1001 {
1002         if ( !Obj_snd_level_inited ) {
1003                 return;
1004         }
1005         obj_snd_delete_all();
1006         Obj_snd_level_inited=0;
1007 }
1008
1009 // ---------------------------------------------------------------------------------------
1010 // obj_snd_is_playing()
1011 //
1012 // Determines if a given object-linked sound is currently playing
1013 //
1014 int obj_snd_is_playing(int index)
1015 {
1016         obj_snd *osp;
1017
1018         if ( index == -1 )
1019                 return 0;
1020
1021         SDL_assert( index >= 0 && index < MAX_OBJ_SNDS );
1022
1023         osp = &Objsnds[index];
1024         if ( osp->instance == -1 )
1025                 return 0;
1026
1027         return 1;
1028 }
1029
1030 // ---------------------------------------------------------------------------------------
1031 // obj_snd_return_instance()
1032 //
1033 // Returns the sound instance for a given object-linked sound
1034 //
1035 int obj_snd_return_instance(int index)
1036 {
1037         if ( index == -1 )
1038                 return -1;
1039
1040         SDL_assert( index >= 0 && index < MAX_OBJ_SNDS );
1041
1042         return Objsnds[index].instance;
1043 }
1044