OG Xbox/NXDK support

[VoxelTek]

Hi,

As part of my work on isle-portable, I've been trying to port LEGO Island to the OG Xbox. For 3D audio, isle-portable utilises miniaudio, which works most of the time on most platforms. However, attempting to compile for the Xbox throws many, many errors, which I have been unable to fix.

I believe that many of these issues exist within the core of miniaudio, and even disabling every single backend doesn't make a difference.

The first error is fairly simple;

/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:11556:10: fatal error: 'sys/stat.h' file not found
 11556 | #include <sys/stat.h>   /* For fstat(), etc. */
       |          ^~~~~~~~~~~~

I've found that this can be fixed simply by changing from <sys/stat.h> to <stat.h>. However, once that is fixed, things get significantly worse.

/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:12039:13: error: call to undeclared function '_controlfp_s'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
 12039 |             _controlfp_s(&prevState, 0, 0);
       |             ^
/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:12040:47: error: use of undeclared identifier '_DN_FLUSH'
 12040 |             _controlfp_s(&unused, prevState | _DN_FLUSH, _MCW_DN);
       |                                               ^
/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:12040:58: error: use of undeclared identifier '_MCW_DN'
 12040 |             _controlfp_s(&unused, prevState | _DN_FLUSH, _MCW_DN);
       |                                                          ^

This kinda thing continues for a bit, complaining about stuff like _wfopen_s missing, BY_HANDLE_FILE_INFORMATION being undefined, etc etc.

I believe much of this is a problem due to the NXDK defining both MSVC and _WIN32, however undefining them causes miniaudio to instead use different functions, which also don't appear to exist on the Xbox.

It's possible that this is moreso an issue with NXDK instead of miniaudio, but I figured I should report this here.

Kind regards,
@VoxelTek

[mackron]

I'd be happy to get this compiling, but I need advice and/or some PRs from the community to make it work, and only if it does not cause issues for existing platforms. I have no experience with Xbox development. Having said that, I don't think any of the existing backends would actually work, unless it works with DirectSound, so you'd end up with silence until a working backend is implemented. That would have to wait for miniaudio version 0.12 (still in development) because it includes a major overhaul to the backend system, and I'm not doing any more backend stuff in 0.11.

Is this what you're using? https://github.com/XboxDev/nxdk. I'm not making any guarantees or anything, but if in the future I wanted to play around with this, is there a way for me to practically test it without owning an Xbox?

Can you post the full error listing here, as a text file? There might be a few obvious errors we can pick off.

[VoxelTek]

I'd be happy to get this compiling, but I need advice and/or some PRs from the community to make it work

I'll reach out to some people in the Xbox development scene, I'm sure there are at least a couple people interested in making this work.

and only if it does not cause issues for existing platforms.

Yeah, that's a concern. However, it's likely possible to implement several #ifdefs like the ones that already exist in the code, but I'm not sure.

Having said that, I don't think any of the existing backends would actually work, unless it works with DirectSound, so you'd end up with silence until a working backend is implemented.

At this point, for my purposes, I don't mind. I'd rather get it compiling with no sound than not compiling at all.

Is this what you're using? https://github.com/XboxDev/nxdk.

Yep!

I'm not making any guarantees or anything, but if in the future I wanted to play around with this, is there a way for me to practically test it without owning an Xbox?

Most of the errors right now are at compile time, so owning an Xbox isn't necessary. If and when it gets to the point where testing is required, xemu is fairly good from my understanding.

Can you post the full error listing here, as a text file? There might be a few obvious errors we can pick off.

First error is the <sys/stat.h> one, and it's a simple fix so I'll exclude it. After fixing that, here's the error wall:

miniaudio_xbox_errors.txt

While I've tried fixing these, I haven't made much progress.

[mackron]

Thanks. I actually think those errors might be quite easy to sort out. Off the top of my head:

• The _controlfp_s() is just denormal stuff. We can just add an Xbox-specific define check and have it fall back to the no-op branch. This is just an optimization thing so no worries if that's just skipped.
• The same should apply to fopen_s() - we can add a define check for nxdk to have it just use fopen() instead of fopen_s().
• Again, same with _wfopen_s() - miniaudio defines a MA_HAS_WFOPEN. We can massage the checks for that to include nxdk so that MA_HAS_WFOPEN is never defined and thus never tries to use _wfopen_s().
• With the CreateFileW() and related stuff, we can adjust the logic that defines MA_USE_WIN32_FILEIO to force it to use stdio instead.

I'm assuming there is a compile time define for nxdk - something like __nxdx__ or something. Do you know what that might be? I could possibly hack something together when I get a chance.

[VoxelTek]

Thanks. I actually think those errors might be quite easy to sort out.

That's extremely promising!

I'm assuming there is a compile time define for nxdk - something like __nxdx__ or something. Do you know what that might be? I could possibly hack something together when I get a chance.

Helpfully, it's just NXDK, so a simple #ifdef NXDK should work.

One other thing that slipped my mind last time is that, to my knowledge, isle-portable doesn't directly interface with a platform's sound libraries, instead using SDL3. We now have a beta port of SDL3 for the Xbox, so it's probably possible to get audio without having to write any miniaudio backends for the Xbox. That was the case with the PSP and 3DS, which I don't believe have miniaudio backends, but still worked fine.

[mackron]

Thanks. I will hack something together and push some changes when I get a chance. Will report back.

[VoxelTek]

• The _controlfp_s() is just denormal stuff. We can just add an Xbox-specific define check and have it fall back to the no-op branch. This is just an optimization thing so no worries if that's just skipped.

• The same should apply to fopen_s() - we can add a define check for nxdk to have it just use fopen() instead of fopen_s().

• Again, same with _wfopen_s() - miniaudio defines a MA_HAS_WFOPEN. We can massage the checks for that to include nxdk so that MA_HAS_WFOPEN is never defined and thus never tries to use _wfopen_s().

• With the CreateFileW() and related stuff, we can adjust the logic that defines MA_USE_WIN32_FILEIO to force it to use stdio instead.

On this, I bodged some changes and followed what you recommended, and managed to get past all those issues...kinda. Now there are complaints about wcsrtombs being an undeclared function, struct stat info having an incomplete type, and a couple other things.

In file included from /home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.c:2:
/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:13187:13: warning: unused variable 'err' [-Wunused-variable]
 13187 |     errno_t err;
       |             ^~~
/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:13287:17: error: call to undeclared function 'wcsrtombs'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
 13287 |         lenMB = wcsrtombs(NULL, &pFilePathTemp, 0, &mbs);
       |                 ^
[ 47%] Built target miniwin
/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:59997:17: error: variable has incomplete type 'struct stat'
 59997 |     struct stat info;
       |                 ^
/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:59997:12: note: forward declaration of 'struct stat'
 59997 |     struct stat info;
       |            ^
/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:60007:10: error: call to undeclared function 'fileno'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
 60007 |     fd = fileno((FILE*)file);
       |          ^
/home/voxeltek/isle-xbox/build/_deps/miniaudio-src/miniaudio.h:60010:9: error: call to undeclared function 'fstat'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
 60010 |     if (fstat(fd, &info) != 0) {
       |         ^
1 warning and 4 errors generated.
make[2]: *** [_deps/miniaudio-build/CMakeFiles/miniaudio.dir/build.make:79: _deps/miniaudio-build/CMakeFiles/miniaudio.dir/miniaudio.c.obj] Error 1
make[1]: *** [CMakeFiles/Makefile2:489: _deps/miniaudio-build/CMakeFiles/miniaudio.dir/all] Error 2
make: *** [Makefile:156: all] Error 2

[mackron]

The wcsrtombs() thing is not surprising considering the absence of CreateFileW(). That'll need a rework - not sure how to work around that off the top of my head outside of a simple stub. With the stat stuff, could that possibly be due to a missing include? I would be surprised if struct stat and stat() were unavailable - I would have thought that'd be essential functionality. If indeed NXDX does not support those, that might be an issue I'll need to consider.

[VoxelTek]

Can't say I'm too hopeful, but it does sound maybe doable. This is much more complex than I first expected, though.

Would it be possible to just...not use any functions that touch files? In my case (isle-portable), I'm fairly certain we only need to take data from the game, and then give it back to SDL3. Could I just disable the file handling functions, just as a temporary "patch"?

[mackron]

I'll need to look at the code and refresh my memory on where file info is used. I think ma_file_info only includes the size, so I could implement a fall back that just gets the size in terms of the whole seek/tell/seek pattern. Maybe you could switch back to MA_USE_WIN32_FILEIO, and then do a pre-processor check - if it's NXDK, use seek/tell/seek to grab the size, otherwise use the existing function. Same with CreateFileW() - if it's NXDK, just have it return MA_ERROR or MA_NOT_IMPLEMENTED even.

For the wchar_t related functions, I think miniaudio should be updated so that those functions fail if the platform does not have a way to make it work. Having some kind of macro, similar to MA_USE_WIN32_FILEIO which can be used to easily turn it on or off by massaging the relevant conditionals. In the short term, stubbing out the relevant functions, or doing some pre-processor magic might be the best option.

I'll be back onto miniaudio when this VSCode bug has been fixed: microsoft/vscode#257535. Once that's done I'll have a play around with this. In particular, that wchar_t stuff needs to be addressed because I've had another user have the same error with DJGPP when trying to compile for DOS.

[mackron]

I felt like hacking away on this so I decided to work on it. I think this should be fixed in the dev branch if you were wanting to try that. See the commit message for details if you're interested: 61a85dc

I have done no testing on this whatsoever, but it compiles fine for me.

[VoxelTek]

I'll give it a shot, will report back!

[VoxelTek]

It compiles! I can't yet test the whole application, there are some lego1 linker errors I need to deal with, but miniaudio seems to be compiling fine! Thank you!!!