engage-engine 1.251.90910020 → 1.251.90910022

package/include/ConfigurationObjects.h

@@ -1431,6 +1431,9 @@ namespace AppConfigurationObjects
         /** @brief [Optional, Default: false] Indicates that the aliasSpecializer must cause receivers to mute this transmission if they have an affinity for the specializer.. */
         bool            receiverRxMuteForAliasSpecializer;
 
+        /** @brief [Optional, Default: false] Indicates that the transmission should be restarted. */
+        bool            reBegin;
+
         AdvancedTxParams()
         {
             clear();
@@ -1448,6 +1451,7 @@ namespace AppConfigurationObjects
             audioUri.clear();
             aliasSpecializer = 0;
             receiverRxMuteForAliasSpecializer = false;
+            reBegin = false;
         }
 
         virtual void initForDocumenting()
@@ -1467,7 +1471,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(txId),
             TOJSON_IMPL(audioUri),
             TOJSON_IMPL(aliasSpecializer),
-            TOJSON_IMPL(receiverRxMuteForAliasSpecializer)
+            TOJSON_IMPL(receiverRxMuteForAliasSpecializer),
+            TOJSON_IMPL(reBegin)
         };
     }
     static void from_json(const nlohmann::json& j, AdvancedTxParams& p)
@@ -1483,6 +1488,7 @@ namespace AppConfigurationObjects
         getOptional<TxAudioUri>("audioUri", p.audioUri, j);
         getOptional<uint16_t>("aliasSpecializer", p.aliasSpecializer, j, 0);
         getOptional<bool>("receiverRxMuteForAliasSpecializer", p.receiverRxMuteForAliasSpecializer, j, false);
+        getOptional<bool>("reBegin", p.reBegin, j, false);
     }
 
     //-----------------------------------------------------------
@@ -2751,6 +2757,21 @@ namespace AppConfigurationObjects
         IMPLEMENT_JSON_DOCUMENTATION(Rallypoint)
 
     public:
+        /**
+         * @brief RP protocol enum.
+         *
+         */
+        typedef enum
+        {
+            /** @brief  [Default] TLS over TCP*/
+            rppTlsTcp    = 0,
+
+            /** @brief WebSocket over TLS */
+            rppTlsWs      = 1,
+
+            /** @brief Invalid */
+            rppInvalid    = -1
+        } RpProtocol_t;
 
         /**
          * @brief This is the host address for the Engine to connect to the RallyPoint service.
@@ -2823,6 +2844,13 @@ namespace AppConfigurationObjects
         std::string                 sni;
 
 
+        /** @brief [Optional, Default: rppTlsTcp] Specifies the protocol to be used for the Rallypoint connection. See @ref RpProtocol_t for all protocol types */
+        RpProtocol_t                protocol;
+
+        /** @brief [Optional, Default: ""] Path to use for the RP connection (only used for WebSocket) */
+        std::string                 path;
+
+
         Rallypoint()
         {
             clear();
@@ -2840,6 +2868,8 @@ namespace AppConfigurationObjects
             connectionTimeoutSecs = 0;
             tcpTxOptions.clear();
             sni.clear();
+            protocol = rppTlsTcp;
+            path.clear();
         }
 
         bool matches(const Rallypoint& other)
@@ -2849,6 +2879,16 @@ namespace AppConfigurationObjects
                 return false;
             }
 
+            if(protocol != other.protocol)
+            {
+                return false;
+            }
+
+            if(path.compare(other.path) != 0)
+            {
+                return false;
+            }
+
             if(certificate.compare(other.certificate) != 0)
             {
                 return false;
@@ -2932,7 +2972,9 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(disableMessageSigning),
             TOJSON_IMPL(connectionTimeoutSecs),
             TOJSON_IMPL(tcpTxOptions),
-            TOJSON_IMPL(sni)
+            TOJSON_IMPL(sni),
+            TOJSON_IMPL(protocol),
+            TOJSON_IMPL(path)
         };
     }
 
@@ -2950,6 +2992,8 @@ namespace AppConfigurationObjects
         getOptional<int>("connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
         getOptional<TcpNetworkTxOptions>("tcpTxOptions", p.tcpTxOptions, j);
         getOptional<std::string>("sni", p.sni, j);
+        getOptional<Rallypoint::RpProtocol_t>("protocol", p.protocol, j, Rallypoint::RpProtocol_t::rppTlsTcp);
+        getOptional<std::string>("path", p.path, j);
     }
 
     //-----------------------------------------------------------
@@ -3535,6 +3579,164 @@ namespace AppConfigurationObjects
         // internalKey is not serialized   
     }
 
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(AudioRegistryDevice)
+    /**
+     * @brief Describes an audio device that is available on the system
+     *
+     * Helper C++ class to serialize and de-serialize AudioRegistryDevice
+     *
+     * Example: @include[doc] examples/AudioRegistryDevice.json
+     *
+     * @see AudioRegistryDevice
+     */
+    class AudioRegistryDevice : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(AudioRegistryDevice)
+
+    public:
+        /** @brief The string identifier used to identify the hardware. */
+        std::string     hardwareId;
+
+        /** @brief True if this is the default device */
+        bool            isDefault;
+
+        /** @brief Name of the device */
+        std::string     name;
+
+        /** @brief [Optional] Manufacturer */
+        std::string     manufacturer;
+
+        /** @brief [Optional] Model */
+        std::string     model;
+
+        /** @brief [Optional] Serial number */
+        std::string     serialNumber;
+
+
+        /** @brief [Optional] Type */
+        std::string     type;
+
+        /** @brief [Optional] Extra */
+        std::string     extra;
+
+        AudioRegistryDevice()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            hardwareId.clear();
+            isDefault = false;
+            name.clear();
+            manufacturer.clear();
+            model.clear();
+            serialNumber.clear();
+            type.clear();
+            extra.clear();
+        }
+
+        virtual std::string toString()
+        {
+            char buff[2048];
+
+            snprintf(buff, sizeof(buff), "hardwareId=%s, isDefault=%d, name=%s, manufacturer=%s, model=%s, serialNumber=%s, type=%s, extra=%s",
+                        hardwareId.c_str(),
+                        (int)isDefault,
+                        name.c_str(),
+                        manufacturer.c_str(),
+                        model.c_str(),
+                        serialNumber.c_str(),
+                        type.c_str(),
+                        extra.c_str());
+
+            return std::string(buff);
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const AudioRegistryDevice& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(hardwareId),
+            TOJSON_IMPL(isDefault),
+            TOJSON_IMPL(name),
+            TOJSON_IMPL(manufacturer),
+            TOJSON_IMPL(model),
+            TOJSON_IMPL(serialNumber),
+            TOJSON_IMPL(type),
+            TOJSON_IMPL(extra)
+        };
+    }
+    static void from_json(const nlohmann::json& j, AudioRegistryDevice& p)
+    {
+        p.clear();
+        getOptional<std::string>("hardwareId", p.hardwareId, j, EMPTY_STRING);
+        getOptional<bool>("isDefault", p.isDefault, j, false);
+        getOptional("name", p.name, j);
+        getOptional("manufacturer", p.manufacturer, j);
+        getOptional("model", p.model, j);
+        getOptional("serialNumber", p.serialNumber, j);
+        getOptional("type", p.type, j);
+        getOptional("extra", p.extra, j);
+    }    
+
+
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(AudioRegistry)
+    /**
+     * @brief Describes an audio registry
+     *
+     * Helper C++ class to serialize and de-serialize AudioRegistry
+     *
+     * Example: @include[doc] examples/AudioRegistry.json
+     *
+     * @see AudioRegistry
+     */
+    class AudioRegistry : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(AudioRegistry)
+
+    public:
+        /** @brief [Optional] List of input devices to use for the registry. */
+        std::vector<AudioRegistryDevice> inputs;
+
+        /** @brief [Optional] List of output devices to use for the registry. */
+        std::vector<AudioRegistryDevice> outputs;
+
+        AudioRegistry()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            inputs.clear();
+            outputs.clear();
+        }
+
+        virtual std::string toString()
+        {
+            return std::string("");
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const AudioRegistry& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(inputs),
+            TOJSON_IMPL(outputs)
+        };
+    }
+    static void from_json(const nlohmann::json& j, AudioRegistry& p)
+    {
+        p.clear();
+        getOptional<std::vector<AudioRegistryDevice>>("inputs", p.inputs, j);
+        getOptional<std::vector<AudioRegistryDevice>>("outputs", p.outputs, j);
+    } 
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(AudioDeviceDescriptor)
     /**
@@ -3778,12 +3980,18 @@ namespace AppConfigurationObjects
         /** @brief [Optional, Default: first audio device] Id for the input audio device to use for this group. */
         int     inputId;
 
+        /** @brief [Optional] Hardware ID of the input audio device to use for this group. If empty, inputId is used. */
+        std::string     inputHardwareId;
+
         /** @brief [Optional, Default: 0] The percentage at which to gain the input audio. */
         int     inputGain;
 
         /** @brief [Optional, Default: first audio device] Id for the output audio device to use for this group. */
         int     outputId;
 
+        /** @brief [Optional] Hardware ID of the output audio device to use for this group. If empty, outputId is used. */
+        std::string     outputHardwareId;
+
         /** @brief [Optional, Default: 0] The percentage at which to gain the output audio. */
         int     outputGain;
 
@@ -3805,8 +4013,10 @@ namespace AppConfigurationObjects
         {
             enabled = true;
             inputId = 0;
+            inputHardwareId.clear();
             inputGain = 0;
             outputId = 0;
+            outputHardwareId.clear();
             outputGain = 0;
             outputLevelLeft = 100;
             outputLevelRight = 100;
@@ -3819,8 +4029,10 @@ namespace AppConfigurationObjects
         j = nlohmann::json{
             TOJSON_IMPL(enabled),
             TOJSON_IMPL(inputId),
+            TOJSON_IMPL(inputHardwareId),
             TOJSON_IMPL(inputGain),
             TOJSON_IMPL(outputId),
+            TOJSON_IMPL(outputHardwareId),
             TOJSON_IMPL(outputLevelLeft),
             TOJSON_IMPL(outputLevelRight),
             TOJSON_IMPL(outputMuted)
@@ -3831,8 +4043,10 @@ namespace AppConfigurationObjects
         p.clear();
         getOptional<bool>("enabled", p.enabled, j, true);
         getOptional<int>("inputId", p.inputId, j, 0);
+        getOptional<std::string>("inputHardwareId", p.inputHardwareId, j, EMPTY_STRING);
         getOptional<int>("inputGain", p.inputGain, j, 0);
         getOptional<int>("outputId", p.outputId, j, 0);
+        getOptional<std::string>("outputHardwareId", p.outputHardwareId, j, EMPTY_STRING);
         getOptional<int>("outputGain", p.outputGain, j, 0);
         getOptional<int>("outputLevelLeft", p.outputLevelLeft, j, 100);
         getOptional<int>("outputLevelRight", p.outputLevelRight, j, 100);
@@ -4764,11 +4978,14 @@ namespace AppConfigurationObjects
 
             /** @brief Audio payloads are transformed, headers are preserved, multiple parallel output streams are 
              * possible/expected. The group must be gtAudio (type = 1).*/
-            bomMultistream    = 1,
+            bomMultistream              = 1,
 
             /** @brief Audio payloads are mixed - output is anonymous (i.e. no metadata) if if the target group(s) 
              * allow header extensions. The group must be gtAudio (type = 1)*/
-            bomMixedStream          = 2,
+            bomMixedStream              = 2,
+
+            /** @brief No output will be made to the group regardless of type.*/
+            bomNone                     = 3
         } BridgingOpMode_t;
 
         /** @brief [Optional] The output mode */
@@ -6018,6 +6235,9 @@ namespace AppConfigurationObjects
         /** @brief [Optional, Default: false] If true, input audio is written to a PCM file in the data directory */
         bool                saveOutputPcm;
 
+        /** @brief [Optional] If specified, this registry will be used to discover the input and output devices */
+        AudioRegistry         registry;
+
 
         EnginePolicyAudio()
         {
@@ -6040,6 +6260,7 @@ namespace AppConfigurationObjects
             denoiseOutput = false;
             saveInputPcm = false;
             saveOutputPcm = false;
+            registry.clear();
         }
     };
 
@@ -6059,7 +6280,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(denoiseInput),
             TOJSON_IMPL(denoiseOutput),
             TOJSON_IMPL(saveInputPcm),
-            TOJSON_IMPL(saveOutputPcm)
+            TOJSON_IMPL(saveOutputPcm),
+            TOJSON_IMPL(registry)
         };
     }
     static void from_json(const nlohmann::json& j, EnginePolicyAudio& p)
@@ -6080,6 +6302,7 @@ namespace AppConfigurationObjects
         FROMJSON_IMPL(denoiseOutput, bool, false);
         FROMJSON_IMPL(saveInputPcm, bool, false);
         FROMJSON_IMPL(saveOutputPcm, bool, false);
+        getOptional<AudioRegistry>("registry", p.registry, j);
     }
 
     //-----------------------------------------------------------
@@ -7742,6 +7965,12 @@ namespace AppConfigurationObjects
 
         OutboundLeafPolicy_t    outboundLeafPolicy;
 
+        /** @brief [Optional, Default: Rallypoint::RpProtocol_t::rppTlsTcp] Protocol to use for the peer */
+        Rallypoint::RpProtocol_t    protocol;
+
+        /** @brief [Optional, Default: ""] Path to use for the peer (only used for WebSocket) */
+        std::string                     path;
+
         RallypointPeer()
         {
             clear();
@@ -7756,6 +7985,8 @@ namespace AppConfigurationObjects
             connectionTimeoutSecs = 0;
             forceIsMeshLeaf = false;
             outboundLeafPolicy = OutboundLeafPolicy_t::olpUseRpConfiguration;
+            protocol = Rallypoint::RpProtocol_t::rppTlsTcp;
+            path.clear();
         }
     };
 
@@ -7768,7 +7999,9 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(certificate),
             TOJSON_IMPL(connectionTimeoutSecs),
             TOJSON_IMPL(forceIsMeshLeaf),
-            TOJSON_IMPL(outboundLeafPolicy)
+            TOJSON_IMPL(outboundLeafPolicy),
+            TOJSON_IMPL(protocol),
+            TOJSON_IMPL(path)
         };
     }
     static void from_json(const nlohmann::json& j, RallypointPeer& p)
@@ -7781,6 +8014,8 @@ namespace AppConfigurationObjects
         getOptional<int>("connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
         getOptional<bool>("forceIsMeshLeaf", p.forceIsMeshLeaf, j, false);
         getOptional<RallypointPeer::OutboundLeafPolicy_t>("outboundLeafPolicy", p.outboundLeafPolicy, j, RallypointPeer::OutboundLeafPolicy_t::olpUseRpConfiguration);
+        getOptional<Rallypoint::RpProtocol_t>("protocol", p.protocol, j, Rallypoint::RpProtocol_t::rppTlsTcp);
+        getOptional<std::string>("path", p.path, j);
     }
 
     //-----------------------------------------------------------
@@ -8624,6 +8859,9 @@ namespace AppConfigurationObjects
         /** @brief [Default: false] Indicates whether the client is required to present a certificate */
         bool                                    requireClientCertificate;
 
+        /** @brief [Default: false] Indicates whether TLS is required */
+        bool                                    requireTls;
+
         RallypointWebsocketSettings()
         {
             clear();
@@ -8635,6 +8873,7 @@ namespace AppConfigurationObjects
             listenPort = 8443;
             certificate.clear();
             requireClientCertificate = false;
+            requireTls = true;
         }
     };
 
@@ -8644,7 +8883,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(enabled),
             TOJSON_IMPL(listenPort),
             TOJSON_IMPL(certificate),
-            TOJSON_IMPL(requireClientCertificate)
+            TOJSON_IMPL(requireClientCertificate),
+            TOJSON_IMPL(requireTls)
         };
     }
     static void from_json(const nlohmann::json& j, RallypointWebsocketSettings& p)
@@ -8654,6 +8894,7 @@ namespace AppConfigurationObjects
         getOptional<int>("listenPort", p.listenPort, j, 8443);
         getOptional<SecurityCertificate>("certificate", p.certificate, j);
         getOptional<bool>("requireClientCertificate", p.requireClientCertificate, j, false);
+        getOptional<bool>("requireTls", p.requireTls, j, true);
     }
 
 
@@ -10156,7 +10397,10 @@ namespace AppConfigurationObjects
             txsBridgedButNotMultistream     = -11,
 
             /** @brief  Transmission was automatically ended because the group became bridged on a non-multistream configuration */
-            txsAutoEndedDueToNonMultistreamBridge     = -12        
+            txsAutoEndedDueToNonMultistreamBridge     = -12,
+
+            /** @brief  Restart of transmission was attempted but transmission was not already operational */
+            txsReBeginWithoutPriorBegin     = -13        
         } TxStatus_t;
 
         /** @brief ID of the group */
@@ -10279,6 +10523,12 @@ namespace AppConfigurationObjects
 
             /** @brief The transport type is invalid */
             csInvalidTransport                  = -11,
+
+            /** @brief Audio input device not found in registry */
+            csAudioInputDeviceNotFound          = -12,
+
+            /** @brief Audio output device not found in registry */
+            csAudioOutputDeviceNotFound         = -13
         } CreationStatus_t;
 
         /** @brief ID of the group */

package/include/EngageConstants.h

@@ -24,6 +24,7 @@
 #endif
 
 static const size_t ENGAGE_MAX_CRYPTO_PASSWORD_BYTES = 256;
+static const uint64_t ENGAGE_ROOT_CA_CERTIFICATE_CACHE_EXPIRATION_MS = (60 * 1000);
 
 static const int ENGAGE_INVALID_IP_ADDRESS_FAMILY = -1;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "engage-engine",
-  "version": "1.251.90910020",
+  "version": "1.251.90910022",
   "description": "Use Engage to communicate with everyone, everywhere, from any device",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"