engage-engine 1.232.90720005 → 1.234.90740001

package/include/EngageAudioDevice.h

@@ -11,6 +11,8 @@
 #ifndef EngageAudioDevice_h
 #define EngageAudioDevice_h
 
+#include <stdint.h>
+
 
 #ifdef __cplusplus
 extern "C"

package/include/EngageConstants.h

@@ -8,6 +8,69 @@
 
 #include <stdint.h>
 
+#if 1
+#include <cstddef>
+#include <cstdint>
+
+#ifdef WIN32
+    #include <winsock2.h>
+	#include <windows.h>
+    #include <ws2tcpip.h>
+#else
+    #include <netinet/in.h>
+#endif
+
+static const int ENGAGE_INVALID_IP_ADDRESS_FAMILY = -1;
+
+static const size_t ENGAGE_MAX_RTP_OUTPUT_QUEUE_PACKETS = 100;
+
+static const size_t ENGAGE_MAX_IP_ADDR_SIZE = sizeof(struct sockaddr_in6);
+static const size_t ENGAGE_MAX_ALIAS_SIZE = 16;
+static const size_t ENGAGE_MAX_NODE_ID_SIZE = 16;
+
+static const size_t ENGAGE_BLOB_PACKET_BUFFER_ALLOCATION_EXTRA_BYTES = 512;
+
+static const int16_t ENGAGE_PCM_MIN_VALUE = -32768;
+static const int16_t ENGAGE_PCM_MAX_VALUE = 32767;
+
+static const uint16_t ENGAGE_SELECT_FUNCTION_TIMEOUT_SECS = 1;
+static const uint16_t ENGAGE_MULTICAST_REJOIN_SECS = 8;
+
+static const size_t ENGAGE_MAX_DATAGRAM_SIZE = 4096;
+static const long ENGAGE_MAX_RECONNECT_PAUSE_MS = 30000;
+static const long ENGAGE_RECONNECT_FAILURE_PAUSE_INCREMENT_MS = 1500;
+
+static const size_t ENGAGE_BASE_RTP_HEADER_SIZE = 12;
+static const uint16_t ENGAGE_ACCEPTED_RTP_VERSION = 2;
+static const size_t ENGAGE_MAX_RTP_SAMPLES_THAT_CAN_BE_DECODED = (8000 * 5);
+
+static const size_t ENGAGE_PCM_SAMPLE_COUNT_PER_MS = 8;
+static const size_t ENGAGE_PCM_10_MS_SAMPLE_COUNT = (ENGAGE_PCM_SAMPLE_COUNT_PER_MS * 10);
+
+#if defined(__APPLE__)
+    static const size_t ENGAGE_PCM_MIN_PLATFORM_SAMPLE_COUNT = (ENGAGE_PCM_SAMPLE_COUNT_PER_MS * 40);
+#elif defined(__ANDROID__)
+    static const size_t ENGAGE_PCM_MIN_PLATFORM_SAMPLE_COUNT = (ENGAGE_PCM_SAMPLE_COUNT_PER_MS * 250);
+#elif defined(__linux__)
+    static const size_t ENGAGE_PCM_MIN_PLATFORM_SAMPLE_COUNT = (ENGAGE_PCM_SAMPLE_COUNT_PER_MS * 250);
+#elif defined(WIN32)
+	static const size_t ENGAGE_PCM_MIN_PLATFORM_SAMPLE_COUNT = (ENGAGE_PCM_SAMPLE_COUNT_PER_MS * 250);
+#elif defined(__EMSCRIPTEN__)
+	static const size_t ENGAGE_PCM_MIN_PLATFORM_SAMPLE_COUNT = (ENGAGE_PCM_SAMPLE_COUNT_PER_MS * 250);
+#endif
+
+static const long ENGAGE_TLS_CONNECTION_KEY_MATERIAL_SIZE = 32;
+static const uint64_t ENGAGE_RTP_RESET_AFTER_IDLE_MS = (1000 * 30);
+
+#if defined(RTS_DEBUG_BUILD)
+static const uint64_t ENGAGE_GROUP_HEALTH_ERROR_ERROR_NOTIFICATION_INTERVAL_MS = (1000 * 10);
+#else
+static const uint64_t ENGAGE_GROUP_HEALTH_ERROR_ERROR_NOTIFICATION_INTERVAL_MS = (1000 * 30);
+#endif
+
+static const size_t ENGAGE_MAX_GROUPS_PER_BRIDGE = 128;
+#endif
+
 /** @addtogroup resultCodes Engage Engine Result Codes
  *
  * Result codes are returned by calls to the API functions and most often are related to
@@ -37,6 +100,8 @@ static const int ENGAGE_RESULT_ALREADY_STARTED = -6;
 static const int ENGAGE_RESULT_INSUFFICIENT_DESTINATION_SPACE = -7;
 /** @brief Initialization of the crypto module failed */
 static const int ENGAGE_RESULT_CRYPTO_MODULE_INITIALIZATION_FAILED = -8;
+/** @brief An application high resolution timer is already defined */
+static const int ENGAGE_RESULT_HIGH_RES_TIMER_ALREADY_EXISTS = -9;
 /** @} */
 
 

package/include/EngageInterface.h

@@ -13,6 +13,11 @@
 #define EngageInterface_h
 
 #include <stdint.h>
+
+#if defined(__EMSCRIPTEN__)
+    #include <emscripten.h>
+#endif
+
 #include "EngageConstants.h"
 
 #ifdef __cplusplus
@@ -20,6 +25,10 @@ extern "C"
 {
 #endif
 
+#if defined(ENGAGE_ALLOW_NATIVE)
+#include "ILogger.h"
+#endif
+
 #if !defined(ENGAGE_API)
     #if defined(WIN32)
         #ifdef ENGAGE_EXPORTS
@@ -29,7 +38,11 @@ extern "C"
             #define ENGAGE_API  extern
         #endif
     #else
-        #define ENGAGE_API  __attribute__ ((visibility ("default")))
+        #if defined(__EMSCRIPTEN__)
+            #define ENGAGE_API  EMSCRIPTEN_KEEPALIVE __attribute__ ((visibility ("default")))
+        #else
+            #define ENGAGE_API  __attribute__ ((visibility ("default")))
+        #endif
     #endif
 #endif
 
@@ -41,6 +54,9 @@ extern "C"
 /** @brief Prototype for logging callbacks */
 typedef void (*PFN_ENGAGE_LOG_HOOK)(int level, const char * _Nonnull tag, const char * _Nonnull message);
 
+/** @brief Prototype for the high-resolution timer callback */
+typedef void (*PFN_ENGAGE_HIGH_RES_TIMER_TICK)(uint32_t tickType, uint64_t ticksSoFar);
+
 // Structures (all packed on 1-byte boundaries)
 #pragma pack(push, 1)
 
@@ -273,6 +289,9 @@ typedef struct _EngageEvents_t
 
     /** @brief Fired when an audio recording has ended */    
     void (* _Nullable PFN_ENGAGE_AUDIO_RECORDING_ENDED)(const char * _Nonnull pId, const char * _Nullable eventExtraJson);    
+
+    /** @brief Fired whenever the previously-registered high-resolution timer interval ticks.  'tickType' is 1, 2, or 3 for pre-tick, tick, and post-tick respectively */    
+    // void (* _Nullable PFN_ENGAGE_ON_HIGH_RESOLUTION_TIMER_TICK)(uint32_t tickType, uint32_t ticksSoFarLow, uint32_t ticksSoFarHigh, const char * _Nullable eventExtraJson);
 } EngageEvents_t;
 /** @} */
 
@@ -1240,9 +1259,23 @@ ENGAGE_API int engageSetMissionId(const char * _Nullable missionId);
 
 
 /**
- * @brief [SYNC] Opens/creates a certificate store
+ * @brief [SYNC] Creates a certificate store
+ *
+ * This function creates a certificate store and makes it the active certificate store used for the Engine.
+ *
+ * No events are generated by this API call.
  *
- * This function opens (or creates) a certificate store and makes it the active certificate store used for the Engine.  The function fails
+ * @param fileName The full path to the file
+ * @param passwordHexByteString Password as a hex byte string (if the file is to be password protected with an additional application password)
+ * @return ENGAGE_RESULT_OK if the store was opened
+ */
+ENGAGE_API int engageCreateCertStore(const char * _Nonnull fileName, const char * _Nullable passwordHexByteString);
+
+
+/**
+ * @brief [SYNC] Opens a certificate store
+ *
+ * This function opensa certificate store and makes it the active certificate store used for the Engine.  The function fails
  * if the file already exists and it cannot be opened due to file corruption, password mismatch, or invalid content.
  *
  * No events are generated by this API call.
@@ -1593,6 +1626,34 @@ ENGAGE_API int engageIsCryptoFipsValidated(void);
  */
 ENGAGE_API int engageSetCertStore(const uint8_t * _Nonnull buffer, size_t size, const char * _Nullable passwordHexByteString);
 
+/**
+ * @brief [SYNC] Verifies a recorded RIFF file.
+ *
+ * This function verifies a signed, recorded RIFF file.  It returns ENGAGE_RESULT_OK (0) on success.
+ *
+ * No events are generated by this API call.
+ *
+ * @param fn The path to the file.
+ * @return ENGAGE_RESULT_OK if operation was successful.
+ */
+ENGAGE_API int engageVerifyRiff(const char * _Nonnull fn);
+
+/**
+ * @brief [SYNC] Returns a descriptor for a RIFF file
+ *
+ * Call this function to obtain a JSON descriptor of the RIFF file.
+ *
+ * No events are generated by this API call.
+ *
+ * @param fn The path to the file.
+ * @return Zero-terminated string representing a JSON object describing the RIFF file
+ * <P>
+ * Example: @include[doc] examples/RiffDescriptor.json
+ * </P>
+ */
+
+ENGAGE_API const char * _Nonnull engageGetRiffDescriptor(const char * _Nonnull fn);
+
 // TODO: Engage compression/decompression functions not available at this time
 #if 0
 /**
@@ -1635,6 +1696,46 @@ ENGAGE_API int engageCompress(const uint8_t * _Nonnull src, size_t srcSize, uint
 ENGAGE_API int engageDecompress(const uint8_t * _Nonnull src, size_t srcSize, uint8_t * _Nonnull dst, size_t maxDstSize);
 #endif
 
+
+#if defined(ENGAGE_ALLOW_NATIVE)
+/**
+ * @brief [SYNC] Returns a pointer to the library's internbal logger as an ILogger interface
+ *
+ * No events are generated by this API call.
+ *
+ * @return ILogger*
+ */
+ENGAGE_API ILogger * _Nullable engageGetLoggerNative();
+
+/**
+ * @brief [SYNC] Registers for a high resolution (millisecond-precision) timer via direct native callback
+ *
+ * Creates an ongoing timer at millisecond resolution.  Only a single high resolution
+ * timer can exist at any one time.
+ *
+ * No events are generated by this API call.
+ *
+ * @param durationMs Milliseconds between intervals
+ * @param pfnDirectCallback Pointer to the application callback function
+ * @return ENGAGE_RESULT_OK on success, other values on failure
+ * @see engageUnregisterFromHighResolutionTimerNative()
+ */
+ENGAGE_API int engageRegisterForHighResolutionTimerNative(uint32_t durationMs, PFN_ENGAGE_HIGH_RES_TIMER_TICK _Nullable pfnDirectCallback);
+
+
+/**
+ * @brief [SYNC] Unregisters the previously-registered native high-resolution timer if any.
+ *
+ * Unregisters the previously registered timer.  If none exists no error occurs.
+ *
+ * No events are generated by this API call.
+ *
+ * @return ENGAGE_RESULT_OK on success, other values on failure
+ * @see engageRegisterForHighResolutionTimerNative()
+ */
+ENGAGE_API int engageUnregisterFromHighResolutionTimerNative(void);
+#endif
+
 #endif
 
 #ifdef __cplusplus

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "engage-engine",
-  "version": "1.232.90720005",
+  "version": "1.234.90740001",
   "description": "Use Engage to communicate with everyone, everywhere, from any device",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -23,6 +23,6 @@
   "dependencies": {
     "bindings": "^1.5.0",
     "nan": "^2.14.0",
-    "node-gyp": "^7.1.2"
+    "node-gyp": "^9.0.3"
   }
 }