Wwise SDK 2023.1.3

플러그인 미디어 시스템을 이용하면 플러그인(효과, 음원, 싱크, 믹서)에서 Wwise 아키텍처를 활용해 프로젝트 내 이진 데이터 파일을 저장할 수 있습니다.

플러그인에서 커스텀 데이터를 사용하는 대신 플러그인 미디어를 사용하면 다음과 같은 다양한 장점이 있습니다.

데이터 빌트인 지속
Source Control 통합 (작업 그룹 기능 사용)
플랫폼별로 허용된 데이터 변환
허용된 데이터를 담을 SoundBank를 최종 사용자가 선택

Wwise 저작 플러그인

플러그인 미디어 관리하기

자신의 플러그인 백엔드에서 AK::Wwise::Plugin::RequestObjectMedia 를 상속받아 Object Media 서비스를 요청할 수 있습니다. 그러면 m_objectMedia 멤버가 제공돼 해당 서비스의 메소드에 접근할 수 있습니다. 오브젝트 미디어를 사용자가 변경하는 등, 관련된 알림을 받으려면 AK::Wwise::Plugin::Notifications::ObjectMedia 로부터 상속받아 AK::Wwise::Plugin::Notifications::ObjectMedia::NotifyPluginMediaChanged() 를 오버라이드합니다.

class MyPluginBackend
:   public AK::Wwise::Plugin::AudioPlugin
,   public AK::Wwise::Plugin::RequestObjectMedia
,   public AK::Wwise::Plugin::Notifications::ObjectMedia
,   public AK::Wwise::Plugin::RequestHost
{
    void NotifyPluginMediaChanged() override
    {
        // 변경에 따른 반응
        // ...
 
        // Wwise에게 데이터가 재변환되어야 한다고 알림.
        m_host.NotifyInternalDataChanged(
            AK::IAkPluginParam::ALL_PLUGIN_DATA_ID,
            true /* in_bMakeProjectDirty */
        );
    }
};

AK::Wwise::Plugin::ObjectMedia::SetMediaSource() 를 호출해 미디어 파일을 가져올 수 있습니다. 미디어를 가져올 때, 해당 미디어는 플러그인의 "Originals" 디렉터리에 복사되어 전적으로 Wwise가 관리하게 됩니다. 인덱스 0에서 플러그인 미디어 파일을 추가하려면:

m_pObjMedia->SetMediaSource( pszFilename, 0, bReplace );

플러그인 데이터가 변경되었을 때 알림을 받기 위해 NotifyPluginMediaChanged 함수를 오버라이드합니다. NotifyPluginMediaChanged is triggered by any modifications to the media source.

void NotifyPluginMediaChanged() override
{
    // 변경에 대한 응답
    // ...
    
    // Wwise에게 데이터가 내변환되어야 한다고 알림.
    m_pPSet->NotifyInternalDataChanged( AK::IAkPluginParam::ALL_PLUGIN_DATA_ID );
}

더 자세한 정보은 AK::Wwise::Plugin::ObjectMedia 함수의 설명 문서를 참고하세요.

런타임을 위한 미디어 변환

If the plug-in definition file uses CanReferenceDataFile, you must convert your imported original WAV media at runtime to an appropriate format for the real-time component.

To implement conversion functions, inherit from AK::Wwise::Plugin::MediaConverter and implement the required functions:

class MyPlugin
:   public AK::Wwise::Plugin::AudioPlugin,
,   public AK::Wwise::Plugin::MediaConverter

다음은 AK::Wwise::Plugin::MediaConverter 함수의 구현 예시입니다.

#include <AK/Tools/Common/AkFNVHash.h>
#include <filesystem>
#include <ctype.h>
 
AK::Wwise::Plugin::ConversionResult MyPlugin::ConvertFile(
    const GUID& in_guidPlatform,
    const BasePlatformID& in_basePlatform,
    const AkOSChar* in_szSourceFile,
    const AkOSChar* in_szDestFile,
    AkUInt32 in_uSampleRate,
    AkUInt32 in_uBlockLength,
    IProgress* in_pProgress,
    IWriteString* io_pError)
{
    // Convert the original source to a converted file.
    // At minimum, copy the original file to converted
    std::error_code ec;
    std::filesystem::copy(
        in_szSourceFile,
        in_szDestFile,
        std::filesystem::copy_options::overwrite_existing,
        ec
    );
 
    if (ec)
    {
        return AK:Wwise::Plugin::ConversionFailed;
    }
    return AK::Wwise::Plugin::ConversionSuccess;
}
 
uint32_t MyPlugin::GetCurrentConversionSettingsHash(
    const GUID& in_guidPlatform,
    AkUInt32 in_uSampleRate,
    AkUInt32 in_uBlockLength)
{
    AK::FNVHash32 hashFunc;
 
    // 변환에 영향을 미치는 매개 변수로부터 Hash 생성.
    // 원본 파일 이름 가져오기.
    char szInputFileName[_MAX_PATH];
    auto size = m_pObjMedia->GetMediaSourceFileName(szInputFileName, _MAX_PATH);
    if (size == 0)
        return 0;
 
    for (int i = 0; i < size; ++i)
    {
        szInputFileName[i] = tolower(szInputFileName[i]);
    }
    return hashFunc.Compute(szInputFileName, size);
}

플러그인 정의

In the plug-in definition file (the plug-in XML file), ensure that the CanReferenceDataFile element is set to true.

<PluginModule>
    <EffectPlugin Name="YOUR_PLUGIN" CompanyID="???" PluginID="???">
        <PluginInfo MenuPath="???">
            <PlatformSupport>
                <Platform Name="Windows">
...
                    <CanReferenceDataFile>true</CanReferenceDataFile>
                </Platform>
                <Platform Name="XboxOne">
...
                    <CanReferenceDataFile>true</CanReferenceDataFile>
                </Platform>

런타임 플러그인

런타임에 플러그인 미디어 사용하기

자신의 플러그인의 Sound Engine 부분에서, AK::IAkEffectPlugin 을 구현하면 Init(...) 함수에서 AK::IAkEffectPluginContext 포인터를 받게 됩니다. AK::IAkEffectPluginContext 로부터 AK::IAkPluginContextBase::GetPluginMedia 를 호출하여 Wwise SoundBank에 패키징된 변환된 미디어를 구할 수 있습니다.

AKRESULT RunTimeEffect::Init(
    AK::IAkPluginMemAlloc* in_pAllocator,       // 메모리 할당 인터페이스
    AK::IAkEffectPluginContext* in_pFXCtx,      // FX 컨텍스트
    const AkAudioFormat& in_rFormat             // 오디오 입력 형식 )
{
    AkUInt8 * pPluginData = NULL;
    AkUInt32 uPluginDataSize;
    in_pFXCtx->GetPluginMedia( 0, pPluginData, uPluginDataSize );
    if ( pPluginData == NULL )
        return AK_Fail; // 임펄스 응답 없이 플러그인을 인스턴스화 하면 포인터가 없음.
    ...
}

참고: 이 예제에서는 런타임 때 effect 플러그인 미디어를 사용하는 방법을 설명합니다. 그러나 source plug-in 과 같이 다른 플러그인 타입을 사용하는 방법도 보여줍니다. 이 경우, AK::IAkSourcePlugin 을 구현하고 AK::IAkSourcePluginContex 포인터를 받게 됩니다.