bring v2.0-wip into develop

.github/workflows/build.yml

@@ -0,0 +1,83 @@
+name: Build
+
+on:
+  pull_request:
+    branches:
+      - develop
+      - main
+
+jobs:
+  emscripten:
+    name: Emscripten
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+
+      - name: Set up Python (required for Emscripten)
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install Emscripten SDK
+        run: |
+          git clone https://github.com/emscripten-core/emsdk.git
+          cd emsdk
+          ./emsdk install latest
+          ./emsdk activate latest
+          source ./emsdk_env.sh
+        shell: bash
+
+      - name: Build
+        run: |
+          source emsdk/emsdk_env.sh
+          emcmake cmake . -B emscripten-build
+          cmake --build emscripten-build --config=Release
+        shell: bash
+
+  ubuntu:
+    name: Ubuntu
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+
+      - name: Install zlib and libpng without interaction
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y zlib1g-dev libpng-dev          
+
+      - name: Set default gcc and g++ versions to latest
+        run: |
+          sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-13 100
+          sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-13 100
+
+      - name: Build
+        env:
+          CC: gcc
+          CXX: g++
+        run: |
+          cmake . -B build -DTEST=1
+          cmake --build build
+        shell: bash
+
+  windows:
+    name: Windows
+    runs-on: windows-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+      - name: Build
+        run: |
+          cmake . -B build
+          cmake --build build
+
+

.github/workflows/emscripten-deploy.yml → .github/workflows/deploy.yml

@@ -32,8 +32,8 @@ jobs:
       - name: Build with Emscripten
         run: |
           source emsdk/emsdk_env.sh
-          emcmake cmake . -B emscripten-build
-          cmake --build emscripten-build --config=Release
+          emcmake cmake . -B emscripten-build -DCMAKE_BUILD_TYPE:String=Debug
+          cmake --build emscripten-build --config Debug
         shell: bash
 
       - name: Deploy Main Demo

CMakeLists.txt

@@ -3,7 +3,10 @@ cmake_minimum_required(VERSION 3.10)
 
 project(olcPGEX_MiniAudio)
 
+# Options you can set via command-line
+option(HAS_TERMINAL "Show a terminal window for STDOUT/STDERR" ON)
 option(UPDATE_GIT_SUBMODULES "Update Git submodules" ON)
+option(TEST "Build In Test Mode" OFF)
 
 if (UPDATE_GIT_SUBMODULES)
     message(STATUS "Updating Git submodules...")
@@ -152,17 +155,23 @@ function(add_common_settings target)
     ######################################################################
     if(UNIX AND NOT APPLE AND NOT EMSCRIPTEN)
 
+        if (TEST)
+            target_compile_definitions(${target} PRIVATE -DOLC_PGE_HEADLESS)
+        endif()
+
         # OpenGL
-        set(OpenGL_GL_PREFERENCE LEGACY)
-        find_package(OpenGL REQUIRED)
-        include_directories(${OpenGL_INCLUDE_DIRS})
-        target_link_libraries(${target} ${OpenGL_LIBRARIES} OpenGL::GL)
+        if (NOT TEST)
+            set(OpenGL_GL_PREFERENCE LEGACY)
+            find_package(OpenGL REQUIRED)
+            include_directories(${OpenGL_INCLUDE_DIRS})
+            target_link_libraries(${target} ${OpenGL_LIBRARIES} OpenGL::GL)
 
-        # X11
-        find_package(X11 REQUIRED)
-        target_link_libraries(${target} X11::X11)
+            # X11
+            find_package(X11 REQUIRED)
+            target_link_libraries(${target} X11::X11)
 
-        include_directories(${X11_INCLUDE_DIRS})
+            include_directories(${X11_INCLUDE_DIRS})
+        endif()
 
         # Threads
         find_package(Threads REQUIRED)
@@ -228,7 +237,8 @@ endfunction()
 add_executable(
     demo
     demo/demo.cpp
-    demo/common.cpp
+    demo/olcPGEX_MiniAudio.cpp
+    demo/olcPixelGameEngine.cpp
     olcPGEX_MiniAudio.h
     third_party/olcPixelGameEngine/olcPixelGameEngine.h
     third_party/miniaudio/miniaudio.h
@@ -237,7 +247,8 @@ add_executable(
 add_executable(
     demo_synthesis
     demo/demo_synthesis.cpp
-    demo/common.cpp
+    demo/olcPGEX_MiniAudio.cpp
+    demo/olcPixelGameEngine.cpp
     olcPGEX_MiniAudio.h
     third_party/olcPixelGameEngine/olcPixelGameEngine.h
     third_party/miniaudio/miniaudio.h
@@ -246,7 +257,8 @@ add_executable(
 add_executable(
     demo_waveform
     demo/demo_waveform.cpp
-    demo/common.cpp
+    demo/olcPGEX_MiniAudio.cpp
+    demo/olcPixelGameEngine.cpp
     olcPGEX_MiniAudio.h
     third_party/olcPixelGameEngine/olcPixelGameEngine.h
     third_party/miniaudio/miniaudio.h

README.md

@@ -26,6 +26,7 @@ Cross-Platform, out-of-the-box. Easily use in your Linux, Windows, MacOS, and Em
 ### Loading Features
 * Loads WAV files
 * Loads MP3 files
+* Use ``olc::ResourcePack`` (as of v2.0)
 
 ### Configuration Features
 * Background Playback
@@ -50,19 +51,20 @@ Cross-Platform, out-of-the-box. Easily use in your Linux, Windows, MacOS, and Em
 * Get the current position in the sample, in milliseconds.
 * Get the current position in the sample, as float 0.0f is start, 1.0f is end.
 
-### Waveform Features
+### Waveform Features (as of v1.7)
 * Create sine, square, sawtooth, and triangle waves.
 * Load and play multiple waveform channels at the same time.
 * Modify waveform amplitudes, frequencies, and types in realtime.
 
-### Noise Generation Features
+### Noise Generation Features (as of v1.7)
 * Set a callback function to send and play raw audio data for potential sound synthesis.
 * Send raw data for both left and right stereo channels.
 * Track passage of audio frame time for oscillators / time-sensitive applications.
 
-*** Advanced Features, for those who want to use more of miniaudio
+###  Advanced Features, for those who want to use more of miniaudio
 * Get a pointer to the ma_device
 * Get a pointer to the ma_engine
+* Get a pointer to the ma_resource_manager (as of v2.0)
 * Get pointers to waveforms and sounds
 
 # Usage

demo/demo.cpp

@@ -12,20 +12,24 @@ class Demo : public olc::PixelGameEngine
     }
 
 public:
-
     bool OnUserCreate() override
     {
-        // Load a sample from a file, currently decodes WAV and MP3
-        // files, out-of-the-box without further coding or configuration.
-        // returns a sample ID (int), for future control calls.
+        /**
+         * load a sample from a file. currently decodes WAV and MP3
+         * files without further coding or configuration.
+         * 
+         * returns a sample ID (int), for control and expression calls.
+         */
         song1 = ma.LoadSound("assets/sounds/song1.mp3");
 
-        // This is here to demonstrate how the adventurous can exploit other features of miniaudio
-        // that hasn't been abstracted by the PGEX.
-        // 
-        // see how we get a pointer of the song1 sound?
-        ma_sound_set_position(ma.GetSounds()[song1], 0.0f, 0.0f, 0.0f);
-        std::cout << "This demo was built with the latest workflow.\n";
+        /**
+         * this is here to demonstrate how the adventurous can
+         * exploit other features of miniaudio that hasn't been
+         * abstracted by the PGEX
+         * 
+         * Here you get a pointer to a sample's ma_sound.
+         */
+        ma_sound_set_position(ma.GetSound(song1), 0.0f, 0.0f, 0.0f);
         return true;
     }
 
@@ -46,8 +50,11 @@ class Demo : public olc::PixelGameEngine
 
         if(GetKey(olc::SPACE).bPressed)
         {
-            // Toggle takes a sample ID (int) and either starts playback or pauses playback
-            // depending on whether the sample is currently playing, or not.
+            /**
+             * Toggle takes a sample ID (int) and either
+             * starts playback or pauses playback depending
+             * on whether the sample is currently playing or not.
+             */
             ma.Toggle(song1);
         }
 
@@ -84,33 +91,46 @@ class Demo : public olc::PixelGameEngine
             distance = 0.0f;
         }
 
-        // This is here to demonstrate how the adventurous can exploit other features of miniaudio
-        // that hasn't been abstracted by the PGEX.
+        /**
+         * this is here to demosntrate how the adventurous can exploit other
+         * features of miniaudio that haven't been abstracted by the PGEX.
+         */
         distance = std::clamp(distance, 0.0f, 100.0f);
         ma_engine_listener_set_position(ma.GetEngine(), 0, 0.0f, distance, 0.0f);
 
-        // Set pan, takes a sample ID (int), and a float
-        // -1.0 to 1.0 where 0 is center
-        pan    = std::clamp(pan,   -1.0f, 1.0f);
+
+        /**
+         * SetPan takes a sample ID (int) and a float
+         * -1.0f to 1.0f where 0 is center.
+         */
+        pan = std::clamp(pan, -1.0f, 1.0f);
         ma.SetPan(song1, pan);
 
-        // Set pitch, takes a sample ID (int), and a float
-        // 1.0 is normal pitch
+        /**
+         * SetPitch takes a sample ID (int) and a float
+         * 1.0f is normal pitch.
+         */
         pitch  = std::clamp(pitch,  0.0f, 2.0f);
         ma.SetPitch(song1, pitch);
 
-        // Set volume, takes a sample ID (int), and a float
-        // 0.0 to 1.0 where 1.0 is full volume
+        /**
+         * SetVolume takes a sample ID (int) and a float
+         * 0.0f to 1.0f where 1.0f is full volume.
+         */
         volume = std::clamp(volume, 0.0f, 1.0f);
         ma.SetVolume(song1, volume);
 
-        // Gets the current playback position in the provided sample ID (int),
-        // returns float 0.0 to 1.0, nearer 1.0 is near the end
+        /**
+         * GetCursorFloat takes a sample ID (int) and returns
+         * a float 0.0f to 1.0f, nearer to 1.0f is nearer the end.
+         */
         seek = ma.GetCursorFloat(song1);
 
-        // Gets the current playback position in the provided sample ID (int),
-        // returns unsigned long long in milliseconds
-        cursor=ma.GetCursorMilliseconds(song1);
+        /**
+         * GetCursorMilliseconds takes a sample ID (int) and returns
+         * the current playback position, in milliseconds.
+         */
+        cursor = ma.GetCursorMilliseconds(song1);
 
         // Draw Instructions and Indicators
         Clear(olc::BLACK);
@@ -129,7 +149,7 @@ class Demo : public olc::PixelGameEngine
             "\n"
             "Distance <" + std::to_string(distance) + "> Left, Right\n"
             "\n"
-            "One-Off Sounds <" + std::to_string(ma.GetOneOffSounds().size()) + ">   S\n" \
+            "One-Off Sounds <" + std::to_string(ma.GetOneOffCount()) + ">   S\n" \
             "\n" \
             "BackgroundPlay <" + ((backgroundPlay) ? "On": "Off") + "> K1\n",
         olc::WHITE, {0.5f, 0.5f});
@@ -173,7 +193,7 @@ class Demo : public olc::PixelGameEngine
     float volume = 1.0f;
     float distance = 0.0f;
     bool backgroundPlay = false;
-    unsigned long long cursor = 0ull;
+    ma_uint64 cursor = 0ull;
 
 };
 

demo/olcPGEX_MiniAudio.cpp

@@ -0,0 +1,2 @@
+#define OLC_PGEX_MINIAUDIO
+#include "olcPGEX_MiniAudio.h"

demo/common.cpp → demo/olcPixelGameEngine.cpp

@@ -1,5 +1,2 @@
 #define OLC_PGE_APPLICATION
 #include "olcPixelGameEngine.h"
-
-#define OLC_PGEX_MINIAUDIO
-#include "olcPGEX_MiniAudio.h"