SFX API Changes

DSound has since been deprecated and xaudio2 would require us to write our own 3d spatialization and mixer
Load devices the same way we load in the gfx end
setup sfx provider
run sfx devices on startup
various fixes around sfx null device
added the bitrate and samplerate globals
added the hrtf global code is in to use this but not setup yet
Adds speed of sound to the sound system
SFXAmbience now has a property for speed of sound for different mediums, can also be set directly

Templates/BaseGame/game/core/core.tscript

@@ -70,9 +70,7 @@ function CoreModule::onCreate(%this)
    
    // Init the physics plugin.
    physicsInit();
-
-   sfxStartup();
-
+   
    // Set up networking.
    setNetPort(0);
 

Templates/BaseGame/game/core/sfx/Core_SFX.tscript

@@ -3,10 +3,10 @@ function Core_SFX::onCreate(%this)
 {
    exec("./scripts/audio." @ $TorqueScriptFileExtension);
    exec("./scripts/audioData." @ $TorqueScriptFileExtension);
+   exec("./scripts/audioStates." @ $TorqueScriptFileExtension);
+   exec("./scripts/audioEnvironments." @ $TorqueScriptFileExtension);
    exec("./scripts/audioAmbience." @ $TorqueScriptFileExtension);
    exec("./scripts/audioDescriptions." @ $TorqueScriptFileExtension);
-   exec("./scripts/audioEnvironments." @ $TorqueScriptFileExtension);
-   exec("./scripts/audioStates." @ $TorqueScriptFileExtension);
    exec("./scripts/audioOptions." @ $TorqueScriptFileExtension);
 }
 

Templates/BaseGame/game/core/sfx/scripts/audio.tscript

@@ -145,10 +145,6 @@ function sfxStartup()
 function sfxInit()
 {
    // If already initialized, shut down the current device first.
-   
-   if( sfxGetDeviceInfo() !$= "" )
-      sfxShutdown();
-      
    if ($isDedicated)
    {
       sfxCreateDevice("Null","Null Device", false, 8);
@@ -156,12 +152,16 @@ function sfxInit()
    }
    
    // Start it up!
-   %maxBuffers = $pref::SFX::useHardware ? -1 : $pref::SFX::maxSoftwareBuffers;
-   if ( !sfxCreateDevice( $pref::SFX::provider, $pref::SFX::device, $pref::SFX::useHardware, %maxBuffers ) )
-      return false;
+   %info = sfxGetDeviceInfo();
+   if(%info $= "" )
+   {
+      %maxBuffers = $pref::SFX::useHardware ? -1 : $pref::SFX::maxSoftwareBuffers;
+      if ( !sfxCreateDevice() )
+         return false;
+   }
 
    // This returns a tab seperated string with
-   // the initialized system info.
+   // the initialized system info
    %info = sfxGetDeviceInfo();
    $pref::SFX::provider       = getField( %info, 0 );
    $pref::SFX::device         = getField( %info, 1 );

Templates/BaseGame/game/core/sfx/scripts/audioAmbience.tscript

@@ -23,22 +23,27 @@
 singleton SFXAmbience( AudioAmbienceDefault )
 {
    environment = AudioEnvOff;
+   dopplerFactor = "1";
 };
 
 singleton SFXAmbience( AudioAmbienceOutside )
 {
    environment = AudioEnvPlain;
    states[ 0 ] = AudioLocationOutside;
+   dopplerFactor = "1";
 };
 
 singleton SFXAmbience( AudioAmbienceInside )
 {
    environment = AudioEnvRoom;
    states[ 0 ] = AudioLocationInside;
+   dopplerFactor = "1";
 };
 
 singleton SFXAmbience( AudioAmbienceUnderwater )
 {
    environment = AudioEnvUnderwater;
    states[ 0 ] = AudioLocationUnderwater;
+   dopplerFactor = "0.5";
+   speedOfSound = "1500.0";
 };

Templates/BaseGame/game/core/sfx/scripts/audioOptions.tscript

@@ -6,8 +6,8 @@ new SimGroup(AudioSettingsGroup)
    new SimGroup()
    {
       class = "SubOptionsGroup";
-      displayName = "Audio Devices";
-      
+      displayName = "Audio Settings";
+
       new SimGroup(AudioSettingsProviderGroup)
       { 
          class = "AudioOptionsSettings";
@@ -15,7 +15,7 @@ new SimGroup(AudioSettingsGroup)
          OptionName = "Audio Provider";
          Description = "";
       };
-      
+         
       new SimGroup(AudioSettingsDeviceGroup)
       { 
          class = "AudioOptionsSettings";
@@ -31,43 +31,40 @@ function AudioSettingsGroup::populateSettings(%this)
    AudioSettingsProviderGroup.clear();
    AudioSettingsDeviceGroup.clear();
    
-   %buffer = sfxGetAvailableDevices();
-   %count = getRecordCount( %buffer );
-   
-   for(%i = 0; %i < %count; %i++)
+   %pCount = sfxGetProviderCount();
+   for(%i = 0; %i < %pCount; %i++)
    {
-      %record = getRecord(%buffer, %i);
-      %provider = getField(%record, 0);
-      %device = getField(%record, 1);
-      
-      //When the client is actually running, we don't care about null audo devices
-      if(%provider $= "null")
-         continue;
-         
-      //We can't have duplicate providers, so double check for uniqueness
-      %foundProvider = false;
-      foreach(%registeredProviders in AudioSettingsProviderGroup)
+      %provider = sfxGetProviderType(%i);
+      if(%provider !$= "NullProvider")
       {
-         if(%registeredProviders.displayName $= %provider)
+         //We can't have duplicate providers, so double check for uniqueness
+         %foundProvider = false;
+         foreach(%registeredProviders in AudioSettingsProviderGroup)
          {
-            %foundProvider = true;
-            break;
+            if(%registeredProviders.displayName $= %provider)
+            {
+               %foundProvider = true;
+               break;
+            }
+         }
+         
+         if(!%foundProvider)
+         {
+            //Provider entry
+            %providerEntry = new ArrayObject()
+            {
+               class = "OptionsQualityLevel";
+               displayName = %provider;
+               key["$pref::SFX::provider"] = %provider;
+            };
+            AudioSettingsProviderGroup.add(%providerEntry);
          }
       }
-      
-      if(!%foundProvider)
-      {
-         //Provider entry
-         %providerEntry = new ArrayObject()
-         {
-            class = "OptionsQualityLevel";
-            displayName = %provider;
-            key["$pref::SFX::provider"] = %provider;
-         };
-         
-         AudioSettingsProviderGroup.add(%providerEntry);
-      }
-         
+   }
+
+   for(%i = 0; %i < %pCount; %i++)
+   {
+      %device = sfxGetProviderDevice(%i);
       //Device Entry
       %deviceEntry = new ArrayObject()
       {
@@ -93,10 +90,7 @@ function AudioSettingsDeviceGroup::onApply(%this)
 
 function updateAudioOptionsSettings()
 {
-   if ( !sfxCreateDevice(  $pref::SFX::provider, 
-                           $pref::SFX::device, 
-                           $pref::SFX::useHardware,
-                           -1 ) )                              
+   if ( !sfxCreateDevice() )                              
       error( "Unable to create SFX device: " @ $pref::SFX::provider 
                                              SPC $pref::SFX::device 
                                              SPC $pref::SFX::useHardware );

Templates/BaseGame/game/data/UI/guis/optionsMenu.tscript

@@ -223,7 +223,6 @@ function OptionsMenu::openOptionsCategory(%this, %categoryName)
    else if(%categoryName $= "Audio")
    {
       $MenuList = AudioSettingsList;
-
       %this.currentCatgeoryIdx = 1;
    }
    else if(%categoryName $= "KBM")