Add OpenAL extension AL_SOFT_events using userParam ALCcontext as key for GlueGen JavaCallback

https://openal-soft.org/openal-extensions/SOFT_events.txt

5 files changed, 120 insertions, 0 deletions

diff --git a/make/config/joal-alext.cfg b/make/config/joal-alext.cfg
index da63612..39bc50e 100644
--- a/make/config/joal-alext.cfg
+++ b/make/config/joal-alext.cfg
@@ -27,6 +27,10 @@ ForceProcAddressGen __ALL__
 # pointer typedefs for these routines to AL_APIENTRY
 LocalProcAddressCallingConvention __ALL__ AL_APIENTRY
 
+ArgumentIsPascalString ALEVENTPROCSOFT 3 4
+JavaCallbackDef  alEventCallbackSOFT 1 ALEVENTPROCSOFT 5 com.jogamp.openal.ALContextKey
+JavaCallbackKey  alEventCallbackSOFT 1 ALEVENTPROCSOFT 5
+
 Import java.io.UnsupportedEncodingException
 Import java.util.*
 Import com.jogamp.openal.*
diff --git a/make/config/joal.cfg b/make/config/joal.cfg
index 050c000..f553e9a 100755..100644
--- a/make/config/joal.cfg
+++ b/make/config/joal.cfg
@@ -21,6 +21,9 @@ ForceProcAddressGen __ALL__
 # pointer typedefs for these routines to AL_APIENTRY
 LocalProcAddressCallingConvention __ALL__ AL_APIENTRY
 
+# JavaCallback requires `JNI_OnLoad*(..)` and `JVMUtil_GetJNIEnv(..)`
+LibraryOnLoad joal
+
 Import com.jogamp.openal.*
 Import jogamp.openal.*
 Import java.security.AccessController
diff --git a/make/stub_includes/openal/alext.h b/make/stub_includes/openal/alext.h
index 070e839..3c53033 100644
--- a/make/stub_includes/openal/alext.h
+++ b/make/stub_includes/openal/alext.h
@@ -338,6 +338,28 @@ AL_API void AL_APIENTRY alGetSourcei64vSOFT(ALuint source, ALenum param, ALint64
 #endif
 #endif
 
+#ifndef AL_SOFT_events
+#define AL_SOFT_events 1
+#define AL_EVENT_CALLBACK_FUNCTION_SOFT          0x19A2
+#define AL_EVENT_CALLBACK_USER_PARAM_SOFT        0x19A3
+#define AL_EVENT_TYPE_BUFFER_COMPLETED_SOFT      0x19A4
+#define AL_EVENT_TYPE_SOURCE_STATE_CHANGED_SOFT  0x19A5
+#define AL_EVENT_TYPE_DISCONNECTED_SOFT          0x19A6
+typedef void (AL_APIENTRY*ALEVENTPROCSOFT)(ALenum eventType, ALuint object, ALuint param,
+                                           ALsizei length, const ALchar *message,
+                                           void *userParam);
+typedef void (AL_APIENTRY*LPALEVENTCONTROLSOFT)(ALsizei count, const ALenum *types, ALboolean enable);
+typedef void (AL_APIENTRY*LPALEVENTCALLBACKSOFT)(ALEVENTPROCSOFT callback, void *userParam);
+typedef void* (AL_APIENTRY*LPALGETPOINTERSOFT)(ALenum pname);
+typedef void (AL_APIENTRY*LPALGETPOINTERVSOFT)(ALenum pname, void **values);
+#ifdef AL_ALEXT_PROTOTYPES
+AL_API void AL_APIENTRY alEventControlSOFT(ALsizei count, const ALenum *types, ALboolean enable);
+AL_API void AL_APIENTRY alEventCallbackSOFT(ALEVENTPROCSOFT callback, void *userParam);
+AL_API void* AL_APIENTRY alGetPointerSOFT(ALenum pname);
+AL_API void AL_APIENTRY alGetPointervSOFT(ALenum pname, void **values);
+#endif
+#endif
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/src/java/com/jogamp/openal/ALContextKey.java b/src/java/com/jogamp/openal/ALContextKey.java
new file mode 100644
index 0000000..9f3d4bf
--- /dev/null
+++ b/src/java/com/jogamp/openal/ALContextKey.java
@@ -0,0 +1,88 @@
+/**
+ * Copyright 2023 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+package com.jogamp.openal;
+
+import com.jogamp.common.util.HashUtil;
+
+/**
+ * Implementing {@link #equals(Object)} based on the native address
+ * and {@link #hashCode()} on the {@link HashUtil#getAddrHash32_EqualDist(long)} with same native address.
+ * <p>
+ * Both, the native address and its hash code values are cached.
+ * </p>
+ */
+public class ALContextKey {
+    static final ALC alc = ALFactory.getALC();
+    private final ALCcontext alCtx;
+    private final long nativeAddress;
+    private final int hashCodeValue;
+
+    /** Creates an instance using the current context as key. */
+    public ALContextKey( final Object userParam ) {
+        if( null == userParam ) {
+            throw new IllegalArgumentException("userParam null");
+        }
+        if( !(userParam instanceof ALCcontext) ) {
+            throw new IllegalArgumentException("userParam not ALCcontext but "+userParam.getClass());
+        }
+        // alCtx = alc.alcGetCurrentContext();
+        alCtx = (ALCcontext) userParam;
+        if( null != alCtx ) {
+            nativeAddress = alCtx.getDirectBufferAddress();
+            hashCodeValue = HashUtil.getAddrHash32_EqualDist(nativeAddress);
+        } else {
+            nativeAddress = 0;
+            hashCodeValue = 0;
+        }
+    }
+
+    public ALCcontext getContext() { return alCtx; }
+
+    @Override
+    public boolean equals(final Object o) {
+        if( this == o ) {
+            return true;
+        }
+        if( !(o instanceof ALContextKey) ) {
+            return false;
+        }
+        final ALContextKey o2 = (ALContextKey)o;
+        final long o2_ptr = null != o2.alCtx ? o2.alCtx.getDirectBufferAddress() : 0;
+        return nativeAddress == o2_ptr;
+    }
+    @Override
+    public int hashCode() {
+        return hashCodeValue;
+    }
+
+    @Override
+    public String toString() {
+        return "ALContextKey[alCtx hash 0x"+Integer.toHexString(System.identityHashCode(alCtx))+
+                ", native[ptr 0x"+Long.toHexString(nativeAddress)+", hash 0x"+Integer.toHexString(hashCodeValue)+"]]";
+    }
+}
\ No newline at end of file
diff --git a/src/java/com/jogamp/openal/util/ALHelpers.java b/src/java/com/jogamp/openal/util/ALHelpers.java
index a232fe3..fe48aa9 100644
--- a/src/java/com/jogamp/openal/util/ALHelpers.java
+++ b/src/java/com/jogamp/openal/util/ALHelpers.java
@@ -43,6 +43,9 @@ public class ALHelpers {
      *   extensions. Due to conflicts with AL_EXT_SOURCE_RADIUS.
      */
     public static final String AL_SOFT_buffer_samples = "AL_SOFT_buffer_samples";
+    // public static final String AL_SOFT_callback_buffer = "AL_SOFT_callback_buffer";
+    public static final String AL_SOFT_events = "AL_SOFT_events";
+
     public static final String AL_EXT_MCFORMATS = "AL_EXT_MCFORMATS";
     public static final String AL_EXT_FLOAT32 = "AL_EXT_FLOAT32";
     public static final String AL_EXT_DOUBLE = "AL_EXT_DOUBLE";