The Big CMake + MinGW + Sound PR by TheBrokenRail · Pull Request #127 · nbcraft-org/nbcraft

TheBrokenRail · 2024-06-18T22:51:04Z

This PR:

Refactors the CMake build-system:
- There is now a top-level CMakeLists.txt so you no longer need to cd platforms/sdl before building the project.
- SDL is now loaded in platforms/sdl/CMakeLists.txt like you would expect instead of in source/CMakeLists.txt.
- Sound systems have been decoupled from SDL/Win32. You can now build SDL with DirectSound or Win32 with OpenAL.
- The Win32 platform can now be built with CMake using MinGW-w64.
- The SDL platform can also now be built with CMake using MinGW-w64.
- Both of those configurations have been added to the CI.'
Sound is now loaded at runtime instead of being loaded from the binary! (Fixes Load Sounds From Filesystem #119)
- tools/grabsounds.py now extracts sounds to game/assets/sound using LIEF (which is downloaded automatically).
- Sound data is loaded using AppPlatform::readAssetFile, which has been implemented (and tested) for both SDL, Win32, and native Android.
- AppPlatform::getPatchData has been changed to use AppPlatform::readAssetFile.
Extra Notes:
- The macOS build currently only works because I added a ln -s to the CI, someone should probably fix that.
- I also adjusted the line width calculation for block outlines.
- And I updated the GLES Compatibility Layer.
- Finally, I fixed some bugs with Logger.

iProgramMC · 2024-06-19T05:39:12Z

-};
+};
+
+#define SOUND_SYSTEM SoundSystemDS


I disagree with renaming all sound systems to CustomSoundSystem. I especially disagree with your choice of using a #define where a typedef would have fit incredibly well.

I would say revert this and then in each AppPlatform, use preprocessor conditions to determine the sound system in that AppPlatform. And use typedef for that.

You can't really use DirectSound on non-Windows; nor can you use OpenSL ES on desktop Linux and Windows.

You can't really use DirectSound on non-Windows; nor can you use OpenSL ES on desktop Linux and Windows.

The issue is OpenAL. It can be used on both SDL and Win32, so you end up with:

#ifdef USE_OPENAL #include "SoundSystemAL.h" #define SOUND_SYSTEM SoundSystemAL #else #include "SoundSystemDS.h" #define SOUND_SYSTEM SoundSystemDS #endif

In both platforms/sdl/main.cpp and platforms/windows/main.cpp.

I'll switch to typedefs though, that is nicer.

Yep, that's fine. I don't mind that at all.

iProgramMC · 2024-06-19T05:42:59Z

-	return "";
+	AssetFile file = readAssetFile("patches/patch_data.txt");
+	std::string out = std::string(file.data, file.data + file.size);
+	delete file.data;


You should delete data within the destructor and add move and copy constructors to AssetFile. Because we're using C++.

Wouldn't that require SoundDesc maintaining a copy of AssetFile so the sound data isn't deleted?

Yes. But you return AssetFile from AppPlatform::readAssetFile so you can just keep the AssetFile in memory (ideally you'd also use std::move to avoid copying)

So, funny story. Turns out SoundRepository copies SoundDesc a lot.

So the options are:

Modify SoundRepository to store pointers or references (which in turn would require modifying the SoundSystems).

Add a copy constructor to AssetFile and copy the sound data whenever it is used, which sounds... really inefficient.

Keep the data externally-managed.

iProgramMC · 2024-06-19T05:45:17Z


 	glPushMatrix();
 	glTranslatef(x + 0.0f, y + 2.3f, z);
-	glNormal3f(0.0f, 1.0f, 0.0f);


iProgramMC · 2024-06-19T05:54:40Z

Also worth noting that I don't really like giant PRs. Which is why I ask that you create separate PRs for different changes from now on.

TheBrokenRail · 2024-06-19T06:47:38Z

Yeah, sorry about that. I got a bit carried away (clearly).

TheBrokenRail · 2024-06-19T08:12:34Z

Also, I added tools/extract_apk.py. It just calls grabsounds,py and extracts the other assets to game/assets. I mainly created it because I got annoyed with having to figure out how to merge-copy the game assets into game/assets. It also shows a file chooser if you run it by itself, which should make it easier to use for beginners.

TheBrokenRail · 2025-01-04T05:50:03Z

When I get more time, I'm going to split this up into multiple PRs. Until then, I'll mark it as WIP.

* Fixed building on Windows * Added support for mob sounds * Added support for fire sounds

BrentDaMage · 2025-03-06T06:44:35Z

We should really be loading all of our SoundDesc structs dynamically based on the file hierarchy inside /assets/sounds. MCPE 0.12.1 has an "example" of this, even though it's getting most of its info from a JSON file.

* Re-enabled lighting & normals that were disabled due to merge * Re-added smooth outline rendering as fallback * Fixed OpenGL reference in CMake files

BrentDaMage · 2025-03-06T07:32:06Z

@TheBrokenRail Could you please fix the CMake files? Not sure why the SDL2 and GLES compatibility layer stuff is throwing back errors. I'm gonna make sure the Xcode project works for macOS and iOS tomorrow.

* Documented fields

BrentDaMage · 2025-04-13T10:02:26Z

Additionally, it's worth nothing, that for whatever reason, an Ogg Vorbis decoder is already present in one of our thirdparty libraries in ~/thirdparty/stb_image/include/stb_vorbis.c

iProgramMC · 2025-04-13T14:10:47Z

for whatever reason
Yes, because we clone this repo https://github.com/nothings/stb in stb_image. The name of that submodule is actually a misnomer as we import the entirety of stb, not just stb_image.

TheBrokenRail · 2025-04-20T07:49:37Z

CMake changes are in #149.

BrentDaMage · 2025-04-20T08:24:41Z

@TheBrokenRail For clarification, are sound changes also now being split out into a new PR as well? If so, is this PR going to be archived/closed?

TheBrokenRail · 2025-04-20T08:25:12Z

Yeah, once I make the sound PR, I'm closing this one.

TheBrokenRail · 2025-04-20T08:25:27Z

This branch is a disaster.

BrentDaMage · 2025-04-20T08:27:22Z

Yeah, once I make the sound PR, I'm closing this one.

Cool. I'm planning on adding OGG support on my flight back to the U.S.
I'm hoping to not have to deal with merge conflict hell.

TheBrokenRail · 2025-04-21T03:36:50Z

The sound code has been split off into its own PR: #150.

TheBrokenRail added 17 commits June 18, 2024 01:36

Attempt To Get CMake To Like MinGW

7e1940a

Some Fixes

8ee49a8

More CMake Fiexes!

73846e9

Decouple Audio Platforms

ad386d3

Try To Fix The Build Again

34baf62

Fix Cursed Symlink

7c268be

Please Work

37a8170

Maybe this will work?

0aae3d5

New Sound Script

3b5f465

Fancy Sound Loading

4d5d85e

Update GLES Layer

2e3a554

Fix macOS Build (Again)

fade654

Update GLES Compat Layer

f854bfc

I Dream Of Burning Macs

7a5c479

Some Final Fixes

cdd0b29

OpenAL On Windows

78b9dd2

Fix WASM Build

8414def

iProgramMC requested changes Jun 19, 2024

View reviewed changes

Fancy APK Extractor!

ba38e1f

Some Fixes

7cc2c5c

TheBrokenRail marked this pull request as draft January 4, 2025 05:50

Fix Merge Conflicts + Bugfixes

7786ce6

* Fixed building on Windows * Added support for mob sounds * Added support for fire sounds

Rendering Bugfixes

f4e028a

* Re-enabled lighting & normals that were disabled due to merge * Re-added smooth outline rendering as fallback * Fixed OpenGL reference in CMake files

BrentDaMage assigned BrentDaMage and TheBrokenRail Mar 6, 2025

BrentDaMage assigned iProgramMC Mar 6, 2025

BrentDaMage added enhancement New feature or request help wanted Extra attention is needed labels Mar 6, 2025

BrentDaMage added 2 commits March 14, 2025 20:21

Fixed UI sound playback volume + cleanup

f0c079b

Cleanup

dbe8cff

* Documented fields

Merge branch 'master' into cmake-mingw-things

22093e9

BrentDaMage and others added 2 commits April 19, 2025 09:57

Merge branch 'master' into cmake-mingw-things

45bb7e3

Fix bad merge

c87a853

BrentDaMage added 3 commits April 21, 2025 00:48

Added OGG Vorbis Support

d527f0e

Documented Field + Minor Bugfix

c8d3e09

Fixed stb_vorbis include

bef312f

TheBrokenRail closed this Apr 21, 2025

Conversation

TheBrokenRail commented Jun 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iProgramMC commented Jun 19, 2024

Uh oh!

TheBrokenRail commented Jun 19, 2024

Uh oh!

TheBrokenRail commented Jun 19, 2024

Uh oh!

TheBrokenRail commented Jan 4, 2025

Uh oh!

BrentDaMage commented Mar 6, 2025

Uh oh!

BrentDaMage commented Mar 6, 2025

Uh oh!

BrentDaMage commented Apr 13, 2025

Uh oh!

iProgramMC commented Apr 13, 2025

Uh oh!

TheBrokenRail commented Apr 20, 2025

Uh oh!

BrentDaMage commented Apr 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TheBrokenRail commented Apr 20, 2025

Uh oh!

TheBrokenRail commented Apr 20, 2025

Uh oh!

BrentDaMage commented Apr 20, 2025

Uh oh!

TheBrokenRail commented Apr 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

TheBrokenRail commented Jun 18, 2024 •

edited

Loading

BrentDaMage commented Apr 20, 2025 •

edited

Loading