Wwise SDK 2024.1.3

オフラインレンダリング

Wwise Sound Engineは、計算負荷の高いリアルタイムで行わないオーディオ生成や、計算負荷の高い動画生成に同期したオーディオ処理のための、オフラインレンダリングを提供しています。

warning 注意: 同期的な AK::SoundEngine::LoadBank や AK::SoundEngine::UnloadBank のAPIを使うアプリケーションでオフラインレンダリングを有効にする場合は、特に注意する必要があります。詳細は Audio Rendering Thread を参照してください。

オーディオキャプチャのコールバックを、レンダリングされたオーディオバッファをアクセスする方法を提供する AK::SoundEngine::RegisterCaptureCallback を使い、登録することができます。

以下は、オフラインレンダリングの1つの実装方法を示す例です:

/// ゲームコードでアクセスできる動画キャプチャサービス
namespace VideoCaptureServices
{
    /// 動画キャプチャ用のバッファを割り当てることが可能
    void Initialize();
    
    /// キャプチャ動画とオーディオをムービーファイルとして出力することが可能
    void Finalize();
 
    /// ファイルに、単一の動画フレームバッファをキャプチャする可能性。
    void CaptureSingleFrame();
}
 
/// ゲームコードでアクセスできるオーディオキャプチャサービス
namespace AudioCaptureServices
{
    /// 以後のオーディオサンプルのキャプチャのために、バッファを割り当てたり、ファイルを開いたりする。
    void Initialize(unsigned in_uSampleRate, unsigned in_uChannels);
 
    /// オーディオサンプルキャプチャが完了したら、バッファやファイルハンドルを解放する。
    void Finalize();
 
    /// 割り当てられたバッファに、オーディオサンプルを追加する
    void CaptureInterleavedSamples(float* in_pfSamples, unsigned in_uSampleCount);
}
 
class GameInterface
{
    // ...
 
public:
    /// 関数をゲームフレームごとに呼び出す
    virtual void UpdateCallback(float deltaTime //< 経過したリアルタイムのwall clock time、オフラインモードの希望するフレームレートの逆数
        ) = 0;
};
 
class Game : public GameInterface
{
    // ...
 
private:
    /// オフラインレンダリングが有効なときはTrue。
    bool m_bIsOfflineRendering{ false };
 
    /// キャプチャコールバックの登録・登録解除のための、出力デバイスID。
    AkOutputDeviceID m_defaultOutputDeviceId{ AK_INVALID_OUTPUT_DEVICE_ID };
 
    /// Wwiseオーディオキャプチャのコールバック。
    static void CaptureCallback(AkAudioBuffer& in_CaptureBuffer, AkOutputDeviceID /*in_idOutput*/, void* /*in_pCookie*/)
    {
        const unsigned uSampleCount = static_cast<unsigned>(in_CaptureBuffer.uValidFrames) * in_CaptureBuffer.NumChannels();
        if (!uSampleCount)
            return;
 
        AudioCaptureServices::CaptureInterleavedSamples(in_CaptureBuffer.GetInterleavedData(), uSampleCount);
    }
 
public:
    /// オフラインレンダリングの有効化・無効化のためにコールする関数
    void SetOfflineRendering(bool bIsOfflineRendering //< オフラインレンダリングはtrue、リアルタイムレンダリングはfalse
        )
    {
        const bool bWasOfflineRendering{ m_bIsOfflineRendering };
        m_bIsOfflineRendering = bIsOfflineRendering;
 
        // オフラインレンダリングの有効化・無効化のために、メッセージをメッセージキューにポストする
        AK::SoundEngine::SetOfflineRendering(m_bIsOfflineRendering);
 
        if (m_bIsOfflineRendering == bWasOfflineRendering)
            return;
 
        // 後続のRenderAudio()へのコールでオーディオサンプルがさらに生成されないように、オフラインレンダリングのフレームタイムをゼロに設定するメッセージをメッセージキューにポストする。
        AK::SoundEngine::SetOfflineRenderingFrameTime(0.0f);
 
        // RenderAudio()をコールしてメッセージキューをフラッシュする。このコール後にオフラインレンダリングが有効化・無効化される。
        AK::SoundEngine::RenderAudio();
 
        if (m_bIsOfflineRendering)
        {
            VideoCaptureServices::Initialize();
 
            // オフラインのレンダリングを行うと、出力コンフィギュレーションはデフォルトでStereo出力に切り替わる
            // 別の出力スピーカーレイアウトにレンダリングするには、出力を明示的に定義したものに置き換える。
            // この例では、7.1.4に切り替える
            AkChannelConfig surroundConfig;
            surroundConfig.SetStandard(AK_SPEAKER_SETUP_DOLBY_7_1_4);
 
            // メッセージをポストして出力デバイスを置き換える。
            AkOutputSettings newSettings;
            newSettings.audioDeviceShareset = AK::AUDIO_DEVICES::SYSTEM;
            newSettings.idDevice = 0;
            newSettings.ePanningRule = AkPanningRule_Speakers;
            newSettings.channelConfig = surroundConfig;
            AK::SoundEngine::ReplaceOutput(newSettings, 0, &m_defaultOutputDeviceId);
        
            // メッセージキューを再度フラッシュして、オフラインデバイスでキャプチャコールバックを登録する前に、ReplaceOutputが確実に処理されるようにする
            AK::SoundEngine::RenderAudio(true);
 
            const AkUInt32 uSampleRate{ AK::SoundEngine::GetSampleRate() };
 
            // 適切なバッファを割り当てるために、サンプルレートとチャンネル数を提供。
            AudioCaptureServices::Initialize(uSampleRate, surroundConfig.uNumChannels);
 
            AK::SoundEngine::RegisterCaptureCallback(&CaptureCallback, m_defaultOutputDeviceId, this);
        }
        else
        {
            AK::SoundEngine::UnregisterCaptureCallback(&CaptureCallback, m_defaultOutputDeviceId, this);
 
            AudioCaptureServices::Finalize();
            VideoCaptureServices::Finalize();
        }
    }
 
    void UpdateCallback(float deltaTime) override
    {
        if (m_bIsOfflineRendering)
            AK::SoundEngine::SetOfflineRenderingFrameTime(deltaTime);
 
        AK::SoundEngine::RenderAudio();
 
        if (m_bIsOfflineRendering)
            VideoCaptureServices::CaptureSingleFrame();
    }
};

AK::SoundEngine::GetSampleRate

AKSOUNDENGINE_API AkUInt32 GetSampleRate()

AkOutputSettings::ePanningRule

AkPanningRule ePanningRule

Definition: AkSoundEngine.h:147

AkChannelConfig::uNumChannels

AkUInt32 uNumChannels

Number of channels.

Definition: AkSpeakerConfig.h:449

AkAudioBuffer::NumChannels

AkForceInline AkUInt32 NumChannels() const

Get the number of channels.

Definition: AkCommonDefs.h:348

AkChannelConfig

Definition: AkSpeakerConfig.h:444

AkOutputSettings

Platform-independent initialization settings of output devices.

Definition: AkSoundEngine.h:123

AK::SoundEngine::SetOfflineRenderingFrameTime

AKSOUNDENGINE_API AKRESULT SetOfflineRenderingFrameTime(AkReal32 in_fFrameTimeInSeconds)

AK::SoundEngine::ReplaceOutput

AKSOUNDENGINE_API AKRESULT ReplaceOutput(const AkOutputSettings &in_Settings, AkOutputDeviceID in_outputDeviceId, AkOutputDeviceID *out_pOutputDeviceId=NULL)

AkAudioBuffer::uValidFrames

AkUInt16 uValidFrames

Number of valid sample frames in the audio buffer

Definition: AkCommonDefs.h:513

AK_SPEAKER_SETUP_DOLBY_7_1_4

#define AK_SPEAKER_SETUP_DOLBY_7_1_4

Dolby 7.1.4 setup channel mask

Definition: AkSpeakerConfig.h:110

AK::SoundEngine::RegisterCaptureCallback

AKSOUNDENGINE_API AKRESULT RegisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)

AK::SoundEngine::RenderAudio

AKSOUNDENGINE_API AKRESULT RenderAudio(bool in_bAllowSyncRender=true)

AK::SoundEngine::UnregisterCaptureCallback

AKSOUNDENGINE_API AKRESULT UnregisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)

AK_INVALID_OUTPUT_DEVICE_ID

static const AkUInt32 AK_INVALID_OUTPUT_DEVICE_ID

Invalid Device ID

Definition: AkTypes.h:110

AkPanningRule_Speakers

@ AkPanningRule_Speakers

Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).

Definition: AkTypes.h:1152

AK::SoundEngine::SetOfflineRendering

AKSOUNDENGINE_API AKRESULT SetOfflineRendering(bool in_bEnableOfflineRendering)

AkOutputSettings::idDevice

AkUInt32 idDevice