Add more audio features and versioning system (#8)

* Improve audio system

- Add loop points
- Add volume and pitch control
- Move `AudioDecoder` functionality into AudioSource
- Make audio buffer size and count customizable

* Fix documentation for `Application` class

* Improve crash messages to incent bug reports

* Add versioning system

* Remove SemVer dependancy, fix .zwversion bug when out/ doesn't exist

* Small changes

- Null out deferred functions
- Change Asset mangle to FQN
- Make AudioThread synchronized

* Fix versioning system

Keeping it the way it was seemed to cause a recompilation
of the engine every time. This is now fixed.

* Fix LDC crashes, with caveats

- AudioThread code is run on main thread currently
- AudioStream is instantiated on heap for no apparent reason

* Fix accidental commenting in dub.sdl

* Change pointer to value-type again

* Audio bug fix

- Add state property to AudioSource
- Made AudioThread an actual thread again
- Disable automatic GC collection again
- Change Timer deregistration to swap deletion

Author: zyebytevt

.gitignore

@@ -9,4 +9,5 @@ bin/
 *.a
 .vscode
 dub.selections.json
-core.zpk
+out/*
+.zwversion

VERSIONING.md

@@ -0,0 +1,28 @@
+# ZyeWare versioning system
+
+In general, we'll use a versioning system similar to [Semantic versioning](https://semver.org/):
+
+MAJOR.MINOR.PATCH, which increment:
+1. MAJOR version when we make incompatible public API changes
+2. MINOR version when we add functionality in a backwards compatible manner
+3. PATCH version when we make backwards compatible bug fixes
+
+(Public API in this case is every piece of code that is reachable by the client application, in the case of D when the `public` modifier is applied)
+
+## Version string
+
+A small "v" should be prepended in front of the actual version number.
+
+If appropriate, a pre-release version name is appended with a hyphen (-), usually "alpha", "beta" and "rc".
+
+Which would result in this hypothetical version string:
+`v0.1.2-alpha`
+
+Major version zero (0.y.z) is, as defined by SemVer, used for initial development and incompatible changes may happen anytime.
+
+With the introduction of this versioning schema, we'll arbitrarily start at 0.3.0, because 3 is
+a nice number.
+
+## Querying the version number
+
+It should always be possible to get the version number from `ZyeWare.engineVersion`

dub.sdl

@@ -3,26 +3,23 @@ description "Simple, general purpose 2D and 3D game engine."
 authors "ZyeByte"
 copyright "Copyright © 2022, ZyeByte"
 license "LGPL-3.0"
-dependency "inmath" version="~>1.0.5"
 dependency "terminal" version="~>1.0.0"
 dependency "imagefmt" version="~>2.1.1"
 dependency "sdlang-d" version="~>0.10.6"
-dependency "bmfont" version="~>0.2.0"
 dependency "audio-formats" version="~>2.0.2"
+dependency "bmfont" version="~>0.2.0"
+dependency "inmath" version="~>1.0.5"
 targetType "library"
 targetPath "out"
-postBuildCommands "dub run zpklink -- -i res/core-package -o out/core.zpk"
-copyFiles "out/core.zpk"
-
 sourcePaths "source"
-
+copyFiles "out/core.zpk"
+postBuildCommands "dub run zpklink -- -i res/core-package -o out/core.zpk"
 configuration "sdl-opengl" {
 	platforms "posix" "windows"
-
 	dependency "bindbc-opengl" version="~>1.0.0"
-	dependency "bindbc-sdl" version="~>1.0.1"
 	dependency "bindbc-openal" version="~>1.0.0"
-
+	dependency "bindbc-sdl" version="~>1.0.1"
+	targetType "library"
 	sourcePaths "platform/opengl" "platform/openal"
 	versions "GL_41" "SDL_204" "GL_KHR_debug"
 }

platform/openal/buffer.d

@@ -5,86 +5,82 @@
 // Copyright 2021 ZyeByte
 module zyeware.audio.buffer;
 
+import std.sumtype;
+
 import bindbc.openal;
 
 import zyeware.common;
 import zyeware.audio;
 
-// TODO: Check memory constness someday.
 @asset(Yes.cache)
-class AudioStream
+class Audio
 {
 protected:
     const(ubyte)[] mEncodedMemory;
+    LoopPoint mLoopPoint;
 
 public:
-    this(const(ubyte)[] encodedMemory)
+    this(const(ubyte)[] encodedMemory, AudioProperties properties = AudioProperties.init)
     {
         mEncodedMemory = encodedMemory;
+        mLoopPoint = properties.loopPoint;
     }
 
-    const(ubyte)[] encodedMemory() pure nothrow
-    {
-        return mEncodedMemory;
-    }
-
-    static AudioStream load(string path)
+    LoopPoint loopPoint() pure const nothrow
     {
-        VFSFile source = VFS.getFile(path);
-        ubyte[] bestCommunityData = source.readAll!(ubyte[])();
-        source.close();
-
-        Logger.core.log(LogLevel.debug_, "Loaded file '%s' as audio.", path);
-
-        return new AudioStream(bestCommunityData);
+        return mLoopPoint;
     }
-}
-
-/*
-@asset(Yes.cache)
-class Sound
-{
-protected:
-    uint mId;
 
-public:
-    this(size_t channels, size_t sampleRate, in float[] data) nothrow
+    void loopPoint(LoopPoint value) pure nothrow
     {
-        alGenBuffers(1, &mId);
-        alBufferData(mId, channels == 1 ? AL_FORMAT_MONO_FLOAT32 : AL_FORMAT_STEREO_FLOAT32,
-            data.ptr, cast(int) (data.length * float.sizeof), cast(int) sampleRate);
+        mLoopPoint = value;
     }
 
-    ~this()
-    {
-        alDeleteBuffers(1, &mId);
-    }
-
-    uint id() const pure nothrow
+    const(ubyte)[] encodedMemory() pure nothrow
     {
-        return mId;
+        return mEncodedMemory;
     }
 
-    static Sound load(string path)
+    static Audio load(string path)
     {
-        auto decoder = AudioDecoder(VFS.getFile(path));
-
-        float[] data;
-        float[] readBuffer = new float[2048];
-        size_t readCount;
-
-        while ((readCount = decoder.read(readBuffer)) != 0)
-            data ~= readBuffer[0 .. readCount];
-
-        Logger.core.log(LogLevel.debug_, "data size: %d", data.length);
+        VFSFile source = VFS.getFile(path);
+        ubyte[] bestCommunityData = source.readAll!(ubyte[])();
+        source.close();
 
-        return new Sound(decoder.channels, decoder.sampleRate, data);
+        AudioProperties properties;
+
+        if (VFS.hasFile(path ~ ".props")) // Properties file exists
+        {
+            import std.conv : to;
+            import sdlang;
+
+            VFSFile propsFile = VFS.getFile(path ~ ".props");
+            Tag root = parseSource(propsFile.readAll!string);
+            propsFile.close();
+
+            try
+            {
+                if (Tag loopTag = root.getTag("loop-point"))
+                {
+                    int v1, v2;
+
+                    if ((v1 = loopTag.getAttribute!int("sample")) != int.init)
+                        properties.loopPoint = LoopPoint(v1);
+                    else if ((v1 = loopTag.getAttribute!int("pattern")) != int.init
+                        && (v2 = loopTag.getAttribute!int("row")) != int.init)
+                        properties.loopPoint = LoopPoint(ModuleLoopPoint(v1, v2));
+                    else
+                        throw new Exception("Could not interpret loop point.");
+                }
+            }
+            catch (Exception ex)
+            {
+                Logger.core.log(LogLevel.warning, "Failed to parse properties file for '%s': %s", path, ex.msg);
+            }
+        }
+
+        Logger.core.log(LogLevel.debug_, "Loaded file '%s' into memory for streaming.", path);
+
+        return new Audio(bestCommunityData, properties);
     }
-}
-
-@asset(Yes.cache)
-class StreamingSound
-{
-public:
-    static StreamingSound load(string path);
-}*/
+}