Merge pull request #1730 from marauder2k9-torque/SFXSystem-Refactor

Sfx system refactor

Author: Azaezel

Engine/lib/CMakeLists.txt

@@ -197,22 +197,44 @@ add_subdirectory(squish ${TORQUE_LIB_TARG_DIRECTORY}/squish EXCLUDE_FROM_ALL)
 add_subdirectory(collada ${TORQUE_LIB_TARG_DIRECTORY}/collada EXCLUDE_FROM_ALL)
 add_subdirectory(glad ${TORQUE_LIB_TARG_DIRECTORY}/glad EXCLUDE_FROM_ALL)
 
+set(ALSOFT_REQUIRE_LINUX OFF)
+set(ALSOFT_REQUIRE_WINDOWS OFF)
+set(ALSOFT_REQUIRE_WINDOWS_NOT_UWP OFF)
+set(ALSOFT_REQUIRE_APPLE OFF)
+set(ALSOFT_CPUEXT_NEON OFF)
+
+if(UNIX AND NOT APPLE)
+    set(ALSOFT_REQUIRE_LINUX ON)
+endif()
+if(WIN32)
+    set(ALSOFT_REQUIRE_WINDOWS ON)
+endif()
+if(APPLE)
+    set(ALSOFT_REQUIRE_APPLE ON)
+endif()
+
 #hidden options
 if(TORQUE_SFX_OPENAL)
     advanced_option(TORQUE_OGGVORBIS "Enable OGG Vorbis" ON)
     advanced_option(ALSOFT_EAX "Enable legacy EAX extensions" ${WIN32})
     advanced_option(ALSOFT_UPDATE_BUILD_VERSION "Update git build version info" ON)
     mark_as_advanced(ALSOFT_BACKEND_COREAUDIO)
-    advanced_option(ALSOFT_BACKEND_DSOUND "Enable DirectSound backend" OFF)    
+    advanced_option(ALSOFT_BACKEND_ALSA "Enable ALSA Backend" ${ALSOFT_REQUIRE_LINUX})
+    advanced_option(ALSOFT_REQUIRE_ALSA "Require ALSA Backend" ${ALSOFT_REQUIRE_LINUX})
+    advanced_option(ALSOFT_BACKEND_DSOUND "Enable DirectSound backend" ${ALSOFT_REQUIRE_WINDOWS})    
+    advanced_option(ALSOFT_REQUIRE_DSOUND "Require DirectSound Backend" ${ALSOFT_REQUIRE_WINDOWS})
     advanced_option(ALSOFT_BACKEND_JACK "Enable Jack backend" OFF)
     advanced_option(ALSOFT_BACKEND_OBOE "Enable OBOE backend" OFF)
     advanced_option(ALSOFT_BACKEND_OPENSL "Enable OpenSL backend" OFF)
     advanced_option(ALSOFT_BACKEND_PIPEWIRE "Enable PipeWire backend" OFF)
     advanced_option(ALSOFT_BACKEND_PORTAUDIO "Enable PortAudio backend" OFF)
     advanced_option(ALSOFT_BACKEND_PULSEAUDIO "Enable PulseAudio backend" OFF)
-    advanced_option(ALSOFT_BACKEND_SDL2 "Use SDL2 Backend" ON)
-    advanced_option(ALSOFT_BACKEND_WASAPI "Enable WASAPI backend" OFF)
-    advanced_option(ALSOFT_BACKEND_WAVE "Enable Wave backend" OFF)
+    advanced_option(ALSOFT_BACKEND_SDL2 "Use SDL2 Backend" OFF)
+    advanced_option(ALSOFT_BACKEND_COREAUDIO "Enable CoreAudio backend" ${ALSOFT_REQUIRE_APPLE})
+    advanced_option(ALSOFT_REQUIRE_COREAUDIO "Require CoreAudio backend" ${ALSOFT_REQUIRE_APPLE})
+    advanced_option(ALSOFT_BACKEND_WASAPI "Enable WASAPI backend" ${ALSOFT_REQUIRE_WINDOWS})
+    advanced_option(ALSOFT_REQUIRE_WASAPI "Require WASAPI backend" ${ALSOFT_REQUIRE_WINDOWS})
+    advanced_option(ALSOFT_BACKEND_WAVE "Enable Wave backend" ON)
     advanced_option(ALSOFT_BACKEND_WINMM "Enable WinMM backend" OFF)
     mark_as_advanced(ALSOFT_BUILD_ROUTER)
     mark_as_advanced(ALSOFT_CPUEXT_NEON)
@@ -232,8 +254,6 @@ if(TORQUE_SFX_OPENAL)
     advanced_option(ALSOFT_INSTALL_UTILS "Install utility programs (openal-info, alsoft-config, ...)" OFF)
     mark_as_advanced(ALSOFT_UPDATE_BUILD_VERSION)
     mark_as_advanced(ALSOFT_NO_CONFIG_UTIL)
-    mark_as_advanced(ALSOFT_REQUIRE_COREAUDIO)
-    mark_as_advanced(ALSOFT_REQUIRE_DSOUND)
     mark_as_advanced(ALSOFT_REQUIRE_JACK)
     mark_as_advanced(ALSOFT_REQUIRE_NEON)
     mark_as_advanced(ALSOFT_REQUIRE_OBOE)
@@ -246,7 +266,6 @@ if(TORQUE_SFX_OPENAL)
     mark_as_advanced(ALSOFT_REQUIRE_SSE2)
     mark_as_advanced(ALSOFT_REQUIRE_SSE3)
     mark_as_advanced(ALSOFT_REQUIRE_SSE4_1)
-    mark_as_advanced(ALSOFT_REQUIRE_WASAPI)
     mark_as_advanced(ALSOFT_REQUIRE_WINMM)
     mark_as_advanced(ALSOFT_SEARCH_INSTALL_DATADIR)
     mark_as_advanced(ALSOFT_TESTS)

Engine/source/T3D/assets/SoundAsset.cpp

@@ -87,21 +87,12 @@ class SoundAsset : public AssetBase
    typedef AssetPtr<SoundAsset> ConcreteAssetPtr;
 
 protected:
-   StringTableEntry           mSoundFile[SFXPlayList::SFXPlaylistSettings::NUM_SLOTS];
-   StringTableEntry           mSoundPath[SFXPlayList::SFXPlaylistSettings::NUM_SLOTS];
-   SimObjectPtr<SFXProfile>   mSFXProfile[SFXPlayList::SFXPlaylistSettings::NUM_SLOTS];
 
-   SFXDescription          mProfileDesc;
-   SFXPlayList             mPlaylist;
-   // subtitles
-   StringTableEntry        mSubtitleString;
-   bool                    mPreload;
-   bool                    mIsPlaylist;
    //SFXPlayList::SlotData   mSlots;
 
    /*These will be needed in the refactor!
    Resource<SFXResource>   mSoundResource;
-   
+
 
    // SFXDesctriptions, some off these will be removed
    F32                     mPitchAdjust;
@@ -121,9 +112,6 @@ class SoundAsset : public AssetBase
    F32                     mPriority;
    */
 
-   typedef Signal<void()> SoundAssetChanged;
-   SoundAssetChanged mChangeSignal;
-
 public:
    enum SoundAssetErrCode
    {
@@ -142,41 +130,79 @@ class SoundAsset : public AssetBase
       if (errCode > SoundAssetErrCode::Extended) return "undefined error";
       return mErrCodeStrings[errCode - Parent::Extended];
    };
+
+private:
+   StringTableEntry        mSoundFile[SFXPlayList::SFXPlaylistSettings::NUM_SLOTS];
+   Resource<SFXResource>   mSoundResource[SFXPlayList::SFXPlaylistSettings::NUM_SLOTS];
+
+   SFXDescription          mProfileDesc;
+
+   SFXPlayList             mPlaylist;
+   // subtitles
+   StringTableEntry        mSubtitleString;
+   bool                    mPreload;
+   bool                    mIsPlaylist;
+   SFXTrack* mResolvedTrack;
+   SFXDescription* mResolvedDescription;
+
+public:
    SoundAsset();
    virtual ~SoundAsset();
 
    /// Engine.
    static void initPersistFields();
+   void onRemove() override;
+   void inspectPostApply() override;
    void copyTo(SimObject* object) override;
 
    //SFXResource* getSound() { return mSoundResource; }
-   Resource<SFXResource> getSoundResource(const U32 slotId = 0) { load(); return mSFXProfile[slotId]->getResource(); }
+   Resource<SFXResource> getSoundResource(const U32 slotId = 0) { load(); return mSoundResource[slotId]; }
 
    /// Declare Console Object.
    DECLARE_CONOBJECT(SoundAsset);
 
-   static bool _setSoundFile(void* object, const char* index, const char* data);
+   // asset Base load
    U32 load() override;
-   inline StringTableEntry getSoundPath(const U32 slotId = 0) const { return mSoundPath[slotId]; };
-   SFXProfile* getSfxProfile(const U32 slotId = 0) { return mSFXProfile[slotId]; }
-   SFXPlayList* getSfxPlaylist() { return &mPlaylist; }
-   SFXTrack* getSFXTrack() { load(); return mIsPlaylist ? dynamic_cast<SFXTrack*>(&mPlaylist) : dynamic_cast<SFXTrack*>(mSFXProfile[0].getPointer()); }
-   SFXDescription* getSfxDescription() { return &mProfileDesc; }
-   bool isPlaylist(){ return mIsPlaylist; }
+
+   void                    setSoundFile(StringTableEntry pSoundFile, U32 slot = 0);
+   inline StringTableEntry getSoundFile(U32 slot = 0) { return mSoundFile[slot]; }
+   inline StringTableEntry getRelativeSoundFile(U32 slot = 0) { return collapseAssetFilePath(mSoundFile[slot]); }
+
+   SFXTrack* getSFXTrack() { load(); return mResolvedTrack; }
+   SFXDescription* getSfxDescription() { return mResolvedDescription ? mResolvedDescription : &mProfileDesc; }
+   bool isPlaylist() { return mIsPlaylist; }
 
    bool isLoop() { return mProfileDesc.mIsLooping; }
    bool is3D() { return mProfileDesc.mIs3D; }
 
    static StringTableEntry getAssetIdByFileName(StringTableEntry fileName);
    static U32 getAssetById(StringTableEntry assetId, AssetPtr<SoundAsset>* materialAsset);
-   static U32 getAssetByFileName(StringTableEntry fileName, AssetPtr<SoundAsset>* matAsset);
+   static U32 getAssetByFilename(StringTableEntry fileName, AssetPtr<SoundAsset>* matAsset);
+
+   void        buildDescription();
+   SFXProfile* buildProfile();
+   SFXPlayList* buildPlaylist();
+
+   void populateSFXTrack(void);
+
+protected:
+   // Asset Base callback
+   void  initializeAsset(void) override;
+   void  _onResourceChanged(const Torque::Path& path);
+   void  onAssetRefresh(void) override;
+
+   /// Taml callbacks.
+   void onTamlPreWrite(void) override;
+   void onTamlPostWrite(void) override;
+   void onTamlCustomWrite(TamlCustomNodes& customNodes) override;
+   void onTamlCustomRead(const TamlCustomNodes& customNodes) override;
 
 protected:
-   void            initializeAsset(void) override;
-   void _onResourceChanged(const Torque::Path & path);
-   void            onAssetRefresh(void) override;
+   static bool _setSoundFile(void* obj, const char* index, const char* data) { U32 idx = 0; if (index) idx = dAtoi(index); static_cast<SoundAsset*>(obj)->setSoundFile(data, idx); return false; }
+
 };
 
+DECLARE_STRUCT(AssetPtr<SoundAsset>)
 DefineConsoleType(TypeSoundAssetPtr, SoundAsset)
 DefineConsoleType(TypeSoundAssetId, String)
 
@@ -272,8 +298,8 @@ public: \
    \
    const StringTableEntry get##name() const\
    {\
-      if (m##name##Asset && (m##name##Asset->getSoundPath() != StringTable->EmptyString()))\
-         return m##name##Asset->getSoundPath();\
+      if (m##name##Asset && (m##name##Asset->getSoundFile() != StringTable->EmptyString()))\
+         return m##name##Asset->getSoundFile();\
       else if (m##name##AssetId != StringTable->EmptyString())\
          return m##name##AssetId;\
       else if (m##name##Name != StringTable->EmptyString())\
@@ -467,8 +493,8 @@ public: \
    \
    const StringTableEntry get##name(const U32& index) const\
    {\
-      if (m##name##Asset[index] && (m##name##Asset[index]->getSoundPath() != StringTable->EmptyString()))\
-         return m##name##Asset[index]->getSoundPath();\
+      if (m##name##Asset[index] && (m##name##Asset[index]->getSoundFile() != StringTable->EmptyString()))\
+         return m##name##Asset[index]->getSoundFile();\
       else if (m##name##AssetId[index] != StringTable->EmptyString())\
          return m##name##AssetId[index];\
       else if (m##name##Name[index] != StringTable->EmptyString())\

Engine/source/T3D/assets/SoundAsset.h

@@ -3309,30 +3309,19 @@ Torque::Path AssetImporter::importSoundAsset(AssetImportObject* assetItem)
 
    StringTableEntry assetName = StringTable->insert(assetItem->assetName.c_str());
 
-   String soundFileName = assetItem->filePath.getFileName() + "." + assetItem->filePath.getExtension();
-   String assetPath = targetPath + "/" + soundFileName;
+   String soundFileName = assetItem->filePath.getFullFileName();
+   String assetPath = "@" + soundFileName;
    String tamlPath = targetPath + "/" + assetName + ".asset.taml";
    String originalPath = assetItem->filePath.getFullPath().c_str();
 
-   char qualifiedFromFile[2048];
-   char qualifiedToFile[2048];
-
-#ifndef TORQUE_SECURE_VFS
-   Platform::makeFullPathName(originalPath.c_str(), qualifiedFromFile, sizeof(qualifiedFromFile));
-   Platform::makeFullPathName(assetPath.c_str(), qualifiedToFile, sizeof(qualifiedToFile));
-#else
-   dStrcpy(qualifiedFromFile, originalPath.c_str(), sizeof(qualifiedFromFile));
-   dStrcpy(qualifiedToFile, assetPath.c_str(), sizeof(qualifiedToFile));
-#endif
-
    newAsset->setAssetName(assetName);
-   newAsset->_setSoundFile(newAsset, "0", soundFileName.c_str());
+   newAsset->setSoundFile(assetPath.c_str());
 
    //If it's not a re-import, check that the file isn't being in-place imported. If it isn't, store off the original
    //file path for reimporting support later
-   if (!isReimport && String::compare(qualifiedFromFile, qualifiedToFile) && Torque::FS::IsFile(qualifiedFromFile))
+   if (!isReimport)
    {
-      newAsset->setDataField(StringTable->insert("originalFilePath"), NULL, qualifiedFromFile);
+      newAsset->setDataField(StringTable->insert("originalFilePath"), nullptr, originalPath.c_str());
    }
 
    Taml tamlWriter;
@@ -3345,18 +3334,6 @@ Torque::Path AssetImporter::importSoundAsset(AssetImportObject* assetItem)
       return "";
    }
 
-   if (!isReimport)
-   {
-      bool isInPlace = !String::compare(qualifiedFromFile, qualifiedToFile);
-
-      if (!isInPlace && !Torque::FS::CopyFile(qualifiedFromFile, qualifiedToFile, !isReimport))
-      {
-         dSprintf(importLogBuffer, sizeof(importLogBuffer), "Error! Unable to copy file %s", assetItem->filePath.getFullPath().c_str());
-         activityLog.push_back(importLogBuffer);
-         return "";
-      }
-   }
-
    return tamlPath;
 }
 

Engine/source/T3D/assets/assetImporter.cpp

@@ -217,7 +217,7 @@ U32 LevelInfo::packUpdate(NetConnection *conn, U32 mask, BitStream *stream)
    mathWrite( *stream, mAmbientLightBlendCurve );
 
    sfxWrite( stream, mSoundAmbience );
-   stream->writeInt( mSoundDistanceModel, 1 );
+   stream->writeInt( mSoundDistanceModel, 4 );
 
    PACK_ASSET_REFACTOR(conn, AccuTexture);
 
@@ -251,7 +251,7 @@ void LevelInfo::unpackUpdate(NetConnection *conn, BitStream *stream)
    String errorStr;
    if( !sfxReadAndResolve( stream, &mSoundAmbience, errorStr ) )
       Con::errorf( "%s", errorStr.c_str() );
-   mSoundDistanceModel = ( SFXDistanceModel ) stream->readInt( 1 );
+   mSoundDistanceModel = ( SFXDistanceModel ) stream->readInt( 4 );
 
    if( isProperlyAdded() )
    {

Engine/source/T3D/levelInfo.cpp

@@ -820,7 +820,7 @@ void SFXEmitter::_update()
    // is toggled on a local profile sound.  It makes the
    // editor feel responsive and that things are working.
    if(  gEditingMission &&
-        (SoundAsset::getAssetErrCode(mSoundAsset) || !mSoundAsset->getSfxProfile()) &&
+        (SoundAsset::getAssetErrCode(mSoundAsset) || !mSoundAsset->getSFXTrack()) &&
         mPlayOnAdd && 
         mDirty.test( IsLooping ) )
       prevState = SFXStatusPlaying;

Engine/source/T3D/sfx/sfxEmitter.cpp

@@ -231,6 +231,12 @@ bool GuiCanvas::onAdd()
 {
    // ensure that we have a cursor
    setCursor(dynamic_cast<GuiCursor*>(Sim::findObject("DefaultCursor")));
+
+   SFXSystem::enumerateProviders();
+   SFXProvider* p = SFXSystem::getBestProviderChoice();
+
+   if (p)
+      SFX->createDevice(p);
 
    // Enumerate things for GFX before we have an active device.
    GFXInit::enumerateAdapters();