Unreal Engine Support

[Eecornwell]

I am able to get your awesome library working inside Unreal Engine if I use an earlier version of your library. When I import and use your .h library directly into Unreal Engine 4.26, 4.27, and 5.1, the build package will fail with current version 0.11.12.

UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(18428): warning C4191: 'type cast': unsafe conversion from 'FARPROC' to 'ma_proc'
UATHelper: Packaging (Windows):         Calling this function through the result pointer may cause your program to fail
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21176): error C2065: 'STGM_READ': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21248): warning C4191: 'type cast': unsafe conversion from 'ma_proc' to 'MA_PFN_PropVariantClear'
UATHelper: Packaging (Windows):         Calling this function through the result pointer may cause your program to fail
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21295): warning C4191: 'type cast': unsafe conversion from 'ma_proc' to 'MA_PFN_CoCreateInstance'
UATHelper: Packaging (Windows):         Calling this function through the result pointer may cause your program to fail
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21295): error C2065: 'CLSCTX_ALL': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21369): warning C4191: 'type cast': unsafe conversion from 'ma_proc' to 'MA_PFN_CoCreateInstance'
UATHelper: Packaging (Windows):         Calling this function through the result pointer may cause your program to fail
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21369): error C2065: 'CLSCTX_ALL': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21439): error C2065: 'STGM_READ': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21447): warning C4191: 'type cast': unsafe conversion from 'ma_proc' to 'MA_PFN_PropVariantClear'
UATHelper: Packaging (Windows):         Calling this function through the result pointer may cause your program to fail
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21457): error C2065: 'CLSCTX_ALL': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21546): error C2065: 'CLSCTX_ALL': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21747): warning C4191: 'type cast': unsafe conversion from 'ma_proc' to 'MA_PFN_CoCreateInstance'
UATHelper: Packaging (Windows):         Calling this function through the result pointer may cause your program to fail
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21747): error C2065: 'CLSCTX_ALL': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(21994): error C2065: 'STGM_READ': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(22006): warning C4191: 'type cast': unsafe conversion from 'ma_proc' to 'MA_PFN_PropVariantClear'
UATHelper: Packaging (Windows):         Calling this function through the result pointer may cause your program to fail
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(22138): error C2065: 'CLSCTX_ALL': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(22284): error C2065: 'STGM_READ': undeclared identifier
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(22291): warning C4191: 'type cast': unsafe conversion from 'ma_proc' to 'MA_PFN_PropVariantClear'
UATHelper: Packaging (Windows):         Calling this function through the result pointer may cause your program to fail
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(22676): warning C4191: 'type cast': unsafe conversion from 'ma_proc' to 'MA_PFN_CoCreateInstance'
UATHelper: Packaging (Windows):         Calling this function through the result pointer may cause your program to fail
UATHelper: Packaging (Windows): D:\Unreal Projects\SpatialAudioTest\ThirdParty\miniaudio\miniaudio.h(22676): error C2065: 'CLSCTX_ALL': undeclared identifier

[orcmid]

Many of those are warnings (but serious) and some fatal (unresolved identifiers).

I am curious. Why are you not using the audio provisions of Uhreal itself? It provides integration of sound effects, character dialog, and theme music. It is tied into the Unreal architecture for game operation that should be smoother. Unreal 5.1 has considerable capability.

[Eecornwell]

@orcmid unfortunately, unreal is not the only engine supporting. In order to unify the audio system while being cross-platform using this library.

[mackron]

Thanks for reporting these. I like miniaudio to work everywhere so I'm happy to address this. I believe these are happening because the Unreal Engine build system is including windows.h prior to the miniaudio definition and is using WIN32_LEAN_AND_MEAN which is excluding them which in turn results in miniaudio trying to use undefined symbols.

I've addressed all of these issues. They're in the dev branch. Are you able to try that again?

[Eecornwell]

Thanks I will retry tonight and report back.

[Eecornwell]

Looks like it is down to these errors now using newest dev branch:

UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10326): error C4668: '_WIN32_WINNT_WIN10_TH2' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10332): error C4668: '_WIN32_WINNT_WIN10_RS1' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10337): error C4668: '_WIN32_WINNT_WIN10_TH2' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10341): error C4668: '_WIN32_WINNT_WIN10_TH2' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10348): error C4668: '_WIN32_WINNT_WIN10_RS2' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10358): error C4668: '_WIN32_WINNT_WIN10_RS2' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10362): error C4668: '_WIN32_WINNT_WIN10_TH2' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10367): error C4668: '_WIN32_WINNT_WIN10_RS3' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10374): error C4668: '_WIN32_WINNT_WIN10_RS4' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10377): error C4668: '_WIN32_WINNT_WIN10_RS1' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10380): error C4668: '_WIN32_WINNT_WIN10_RS4' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10385): error C4668: '_WIN32_WINNT_WIN10_RS1' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10388): error C4668: '_WIN32_WINNT_WIN10_RS5' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10588): error C4668: '_WIN32_WINNT_WIN10_RS2' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(10612): error C4668: '_WIN32_WINNT_WIN10_RS5' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(14093): error C4668: '_WIN32_WINNT_WIN10_RS5' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(15406): error C4668: '_WIN32_WINNT_WIN10_RS2' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(15525): error C4668: '_WIN32_WINNT_WIN10_RS3' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(15675): error C4668: '_WIN32_WINNT_WIN10_RS4' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(15688): error C4668: '_WIN32_WINNT_WIN10_RS4' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
UATHelper: Packaging (Windows): C:\Program Files (x86)\Windows Kits\10\include\10.0.19041.0\um\winioctl.h(15916): error C4668: '_WIN32_WINNT_WIN10_RS1' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'

[mackron]

These errors are coming from inside the Windows headers so I can't provide a direct fix for those. You'll need to work around them. A few ideas for you to try.

These usually present as warnings. It looks like they're presenting as errors because your build system has been configured to treat warnings as errors? Perhaps try disabling the warning with /wd4668.

Another option is to try manually defining those defines on the command line: /D_WIN32_WINNT_WIN10_TH2=0

[Eecornwell]

Thank you, I was able to get your library working in Unreal Engine v5.1. I had to include the following line in build config for ignoring the warning:
bEnableUndefinedIdentifierWarnings = false;

Enable warnings for using undefined identifiers in #if expressions