Engine: save state of non-audioclip playbacks (such as voice)

Author: ivan-mogilko

Common/ac/dynobj/scriptaudioclip.h

@@ -32,8 +32,14 @@ enum AudioFileType {
     eAudioFileMOD = 6
 };
 
-#define AUCL_BUNDLE_EXE 1
-#define AUCL_BUNDLE_VOX 2
+// TODO: consider turning this into generic "asset bundle type"?
+enum AudioClipBundle
+{
+    kAudioBundle_Undefined = 0,
+    kAudioBundle_GamePak = 1,
+    kAudioBundle_AudioVox = 2,
+    kAudioBundle_SpeechVox = 3
+};
 
 #define LEGACY_AUDIOCLIP_SCRIPTNAMELENGTH    30
 #define LEGACY_AUDIOCLIP_FILENAMELENGTH      15
@@ -42,7 +48,7 @@ struct ScriptAudioClip {
     int id = 0;
     Common::String scriptName;
     Common::String fileName;
-    uint8_t bundlingType = AUCL_BUNDLE_EXE;
+    uint8_t bundlingType = kAudioBundle_Undefined;
     uint8_t type = 0;
     AudioFileType fileType = eAudioFileOGG;
     char defaultRepeat = 0;

Common/game/main_game_file.cpp

@@ -452,15 +452,15 @@ void BuildAudioClipArray(const std::vector<String> &assets, std::vector<ScriptAu
         {
             clip.scriptName.Format("aMusic%d", temp_number);
             clip.fileName.Format("music%d.%s", temp_number, temp_extension);
-            clip.bundlingType = (ags_stricmp(temp_extension, "mid") == 0) ? AUCL_BUNDLE_EXE : AUCL_BUNDLE_VOX;
+            clip.bundlingType = (ags_stricmp(temp_extension, "mid") == 0) ? kAudioBundle_GamePak : kAudioBundle_AudioVox;
             clip.type = 2;
             clip.defaultRepeat = 1;
         }
         else if (ags_stricmp(temp_name, "sound") == 0)
         {
             clip.scriptName.Format("aSound%d", temp_number);
             clip.fileName.Format("sound%d.%s", temp_number, temp_extension);
-            clip.bundlingType = AUCL_BUNDLE_EXE;
+            clip.bundlingType = kAudioBundle_GamePak;
             clip.type = 3;
             clip.defaultRepeat = 0;
         }

Engine/ac/file.cpp

@@ -892,9 +892,15 @@ String find_assetlib(const String &filename)
     return "";
 }
 
-AssetPath get_audio_clip_assetpath(int /*bundling_type*/, const String &filename)
-{ // NOTE: bundling_type is ignored now
-    return AssetPath(filename, "audio");
+AssetPath get_audio_clip_assetpath(int bundling_type, const String &filename)
+{
+    switch (bundling_type)
+    {
+    case kAudioBundle_SpeechVox:
+        return AssetPath(filename, "voice");
+    default:
+        return AssetPath(filename, "audio");
+    }
 }
 
 AssetPath get_voice_over_assetpath(const String &filename)

Engine/ac/global_audio.cpp

@@ -503,6 +503,8 @@ static bool play_voice_clip_on_channel(const String &voice_name)
 
     std::unique_ptr<SoundClip> voice_clip(load_sound_clip(apath, "", false));
     if (voice_clip != nullptr) {
+        voice_clip->fileName = apath.Name;
+        voice_clip->bundlingType = kAudioBundle_SpeechVox;
         voice_clip->set_volume255(play.speech_volume);
         if (!voice_clip->play())
             voice_clip.reset();

Engine/game/savegame.cpp

@@ -573,15 +573,26 @@ static HSaveError RestoreAudio(const RestoredData &r_data)
     for (int i = 0; i < TOTAL_AUDIO_CHANNELS; ++i)
     {
         const RestoredData::ChannelInfo &chan_info = r_data.AudioChans[i];
-        if (chan_info.ClipID < 0)
+        if (chan_info.ClipID < 0 && chan_info.FileName.IsEmpty())
             continue;
-        if ((size_t)chan_info.ClipID >= game.audioClips.size())
+
+        if (chan_info.ClipID >= 0)
+        {
+            if ((size_t)chan_info.ClipID >= game.audioClips.size())
+            {
+                return new SavegameError(kSvgErr_GameObjectInitFailed,
+                                         String::FromFormat("Invalid audio clip index: %d (clip count: %zu).", chan_info.ClipID, game.audioClips.size()));
+            }
+
+            play_audio_clip_on_channel(i, &game.audioClips[chan_info.ClipID],
+                chan_info.Priority, chan_info.Repeat, chan_info.Pos);
+        }
+        else
         {
-            return new SavegameError(kSvgErr_GameObjectInitFailed,
-                String::FromFormat("Invalid audio clip index: %d (clip count: %zu).", chan_info.ClipID, game.audioClips.size()));
+            auto sound = load_sound_clip(chan_info.FileName, chan_info.BundlingType, chan_info.Repeat);
+            if (sound)
+                play_sound_on_channel(std::move(sound), i, chan_info.Priority, chan_info.Repeat, chan_info.Pos);
         }
-        play_audio_clip_on_channel(i, &game.audioClips[chan_info.ClipID],
-            chan_info.Priority, chan_info.Repeat, chan_info.Pos);
 
         auto* ch = AudioChans::GetChannel(i);
         if (ch != nullptr)

Engine/game/savegame_components.cpp

@@ -467,6 +467,7 @@ enum AudioSvgVersion
     kAudioSvgVersion_35026    = 1, // source position settings
     kAudioSvgVersion_36009    = 2, // up number of channels
     kAudioSvgVersion_36130    = 3060130, // playback state
+    kAudioSvgVersion_36215    = 3060215, // clips referenced by filename
 };
 
 HSaveError WriteAudio(Stream *out)
@@ -483,13 +484,17 @@ HSaveError WriteAudio(Stream *out)
         out->WriteInt32(play.default_audio_type_volumes[i]);
     }
 
-    // Audio clips and crossfade
+    // Audio playbacks (from channels)
     for (int i = 0; i < TOTAL_AUDIO_CHANNELS; i++)
     {
         auto* ch = AudioChans::GetChannelIfPlaying(i);
-        if ((ch != nullptr) && (ch->sourceClipID >= 0))
+        if (ch)
         {
             out->WriteInt32(ch->sourceClipID);
+            // kAudioSvgVersion_36215
+            StrUtil::WriteString(ch->fileName, out);
+            out->WriteInt8(ch->bundlingType);
+            //
             out->WriteInt32(ch->get_pos());
             out->WriteInt32(ch->priority);
             out->WriteInt32(ch->repeat ? 1 : 0);
@@ -513,9 +518,13 @@ HSaveError WriteAudio(Stream *out)
         }
         else
         {
-            out->WriteInt32(-1);
+            out->WriteInt32(-1); // no clip id
+            out->WriteInt32(0); // empty string (fileName)
+            out->WriteInt8(kAudioBundle_Undefined);
         }
     }
+
+    // Crossfading
     out->WriteInt32(crossFading);
     out->WriteInt32(crossFadeVolumePerStep);
     out->WriteInt32(crossFadeStep);
@@ -567,7 +576,14 @@ HSaveError ReadAudio(Stream *in, int32_t cmp_ver, soff_t cmp_size, const Preserv
         RestoredData::ChannelInfo &chan_info = r_data.AudioChans[i];
         chan_info.Pos = 0;
         chan_info.ClipID = in->ReadInt32();
-        if (chan_info.ClipID >= 0)
+
+        if (cmp_ver >= kAudioSvgVersion_36215)
+        {
+            chan_info.FileName = StrUtil::ReadString(in);
+            chan_info.BundlingType = in->ReadInt8();
+        }
+
+        if (chan_info.ClipID >= 0 || !chan_info.FileName.IsEmpty())
         {
             chan_info.Pos = in->ReadInt32();
             if (chan_info.Pos < 0)
@@ -1755,7 +1771,7 @@ ComponentHandler ComponentHandlers[] =
     },
     {
         "Audio",
-        kAudioSvgVersion_36130,
+        kAudioSvgVersion_36215,
         kAudioSvgVersion_Initial,
         kSaveCmp_Audio,
         WriteAudio,

Engine/game/savegame_internal.h

@@ -187,6 +187,8 @@ struct RestoredData
     struct ChannelInfo
     {
         int ClipID = -1;
+        String FileName;
+        uint8_t BundlingType = kAudioBundle_Undefined;
         int Flags = 0;
         int Pos = 0;
         int Priority = 0;

Engine/media/audio/audio.cpp

@@ -263,6 +263,21 @@ std::unique_ptr<SoundClip> load_sound_clip(ScriptAudioClip *audioClip, bool repe
         soundClip->set_volume100(audioClip->defaultVolume);
         soundClip->sourceClipID = audioClip->id;
         soundClip->sourceClipType = audioClip->type;
+        soundClip->fileName = asset_name.Name;
+        soundClip->bundlingType = audioClip->bundlingType;
+    }
+    return soundClip;
+}
+
+std::unique_ptr<SoundClip> load_sound_clip(const String &filename, uint8_t bundleType, bool repeat)
+{
+    AssetPath asset_name = get_audio_clip_assetpath(bundleType, filename);
+    std::unique_ptr<SoundClip> soundClip = load_sound_clip(asset_name, nullptr, repeat);
+    if (soundClip != nullptr)
+    {
+        soundClip->set_volume100(100);
+        soundClip->fileName = asset_name.Name;
+        soundClip->bundlingType = bundleType;
     }
     return soundClip;
 }
@@ -429,6 +444,20 @@ ScriptAudioChannel* play_audio_clip_on_channel(int channel, ScriptAudioClip *cli
     return &scrAudioChannel[channel];
 }
 
+ScriptAudioChannel *play_sound_on_channel(std::unique_ptr<SoundClip> &&sound, int channel, int priority, int repeat, int fromOffset)
+{
+    if (sound->play_from(fromOffset) == 0)
+    {
+        debug_script_log("Failed to play sound file %s", sound->fileName.GetCStr());
+        return nullptr;
+    }
+
+    sound->repeat = repeat;
+    sound->priority = priority;
+    AudioChans::SetChannel(channel, std::move(sound));
+    return &scrAudioChannel[channel];
+}
+
 void remove_clips_of_type_from_queue(int audioType) 
 {
     int aa;

Engine/media/audio/audio.h

@@ -16,11 +16,13 @@
 
 #include <array>
 #include <memory>
-#include "media/audio/audiodefines.h"
+#include "ac/timer.h"
 #include "ac/dynobj/scriptaudioclip.h"
 #include "ac/dynobj/scriptaudiochannel.h"
 #include "media/audio/ambientsound.h"
+#include "media/audio/audiodefines.h"
 #include "media/audio/soundclip.h"
+#include "util/string.h"
 #include "util/time_util.h"
 
 class AudioChans
@@ -53,7 +55,9 @@ void        update_clip_default_volume(ScriptAudioClip *audioClip);
 void        start_fading_in_new_track_if_applicable(int fadeInChannel, ScriptAudioClip *newSound);
 void        stop_or_fade_out_channel(int fadeOutChannel, int fadeInChannel = -1, ScriptAudioClip *newSound = nullptr);
 std::unique_ptr<SoundClip> load_sound_clip(ScriptAudioClip *audioClip, bool repeat);
+std::unique_ptr<SoundClip> load_sound_clip(const AGS::Common::String &filename, uint8_t bundleType, bool repeat);
 ScriptAudioChannel* play_audio_clip_on_channel(int channel, ScriptAudioClip *clip, int priority, int repeat, int fromOffset, std::unique_ptr<SoundClip> &&cachedClip = nullptr);
+ScriptAudioChannel *play_sound_on_channel(std::unique_ptr<SoundClip> &&sound, int channel, int priority, int repeat, int fromOffset);
 void        remove_clips_of_type_from_queue(int audioType);
 void        update_queued_clips_volume(int audioType, int new_vol);
 // Checks if speech voice-over is currently playing, and reapply volume drop to all other active clips

Engine/media/audio/soundclip.cpp

@@ -12,6 +12,7 @@
 //
 //=============================================================================
 #include <cmath>
+#include "ac/dynobj/scriptaudioclip.h"
 #include "media/audio/soundclip.h"
 #include "media/audio/audio_core.h"
 
@@ -22,6 +23,7 @@ SoundClip::SoundClip(int slot, int snd_type, bool loop)
 {
     sourceClipID = -1;
     sourceClipType = 0;
+    bundlingType = kAudioBundle_Undefined;
     priority = 50;
     vol255 = 0;
     vol100 = 0;