v10.5.4

v10.5.4

Author: s60sc

README.md

@@ -3,6 +3,7 @@
 
 Application for ESP32 / ESP32S3 with OV2640 / OV5640 camera to record JPEGs to SD card as AVI files and playback to browser as an MJPEG stream. The AVI format allows recordings to replay at correct frame rate on media players. If a microphone is installed then a WAV file is also created and stored in the AVI file.  
 The application supports:
+* [RTSP Server](#rtsp) stream Video, Audio and Subtitles
 * [Motion detection by camera](#motion-detection-by-camera) or PIR / radar sensor
 * Time lapse recording
 * [Audio Recording](#audio-recording) from I2S or PDM microphones
@@ -27,8 +28,9 @@ The ESP32 cannot support all of the features as it will run out of heap space. F
 ***This is a complex app and some users are raising issues when the app reports a warning, but this is the app notifying the user that there is an problem with their setup, which only the user can fix. Be aware that some clone boards have different specs to the original, eg PSRAM size. Please only raise issues for actual bugs (ERR messages, unhandled library error or crash). Thanks.  
 To suggest an improvement or enhancement use Discussions.*** 
 
-Changes up to version 10.5.3:
+Changes up to version 10.5.4:
 * Stream to [NVR](#stream-to-nvr) using integration to RTSPServer library contributed by [@rjsachse](https://github.com/rjsachse). 
+* RTSP server now has multiple client support as well as user/pass authentication.
 * Frame resolution selection mismatch corrected due to [#10801](https://github.com/espressif/arduino-esp32/issues/10801) in arduino core v3.1.0
 * SD card 4 bit mode configurable (see `utilsFS.cpp`)
 * Shared I2C fixed following code changes in Arduino core v3.1.1
@@ -453,7 +455,7 @@ Streaming performance depends on quality of network connection, but can be incre
 
 #### RTSP
 
-This requires an additional library to be installed - see [RTSPServer](https://github.com/rjsachse/RTSPServer) library for details.
+This requires an additional library to be installed - see [RTSPServer](https://github.com/rjsachse/ESP32-RTSPServer) library for details. Must be version 1.3.1 or above
 
 To integrate library with this app, set `#define INCLUDE_RTSP` to `true`.
 
@@ -464,7 +466,14 @@ To enable RTSP, under **Edit Config** -> **Streaming** tab, select:
 
 Then save and reboot. 
 
-To view the stream, connect to `rtsp://<camera_ip>:554` using app supporting RTSP.
+To view the stream, connect to `rtsp://<camera_ip>:<RTSPport>` using app supporting RTSP.
+
+Or if authentication is enabled (username and password):
+`rtsp://<RTSPuser>:<RTSPpass>@<camera_ip>:<RTSPport>`
+
+RTSP now supports multiple clients for multicast. You can also override this logic and enable multiple clients for all transports (TCP, UDP, Multicast) by commenting out //#define OVERRIDE_RTSP_SINGLE_CLIENT_MODE in rtsp.cpp. 
+However, enabling multiple clients for all transports can slow the stream down and may cause issues, so use with care. It is better to leave it for only one client if using TCP or UDP unicast for best results. For more details, 
+check out the README in the RTSPServer library.
 
 #### HTTP
 

appGlobals.h

@@ -62,7 +62,7 @@
 #define INCLUDE_EXTHB false   // externalHeartbeat.cpp (heartbeat to remote server)
 #define INCLUDE_PGRAM false   // photogram.cpp (photogrammetry feature). Needs INCLUDE_PERIPH true
 #define INCLUDE_MCPWM false   // mcpwm.cpp (BDC motor control). Needs INCLUDE_PERIPH true
-#define INCLUDE_RTSP false    // rtsp.cpp (RTSP Streaming). Requires additional library: ESP32-RTSPServer
+#define INCLUDE_RTSP false    // rtsp.cpp (RTSP Streaming). Requires additional library: Latest ESP32-RTSPServer (https://github.com/rjsachse/ESP32-RTSPServer)
 #define INCLUDE_DS18B20 false // if true, requires INCLUDE_PERIPH and additional libraries: OneWire and DallasTemperature
 #define INCLUDE_I2C false     // periphsI2C.cpp (support for I2C peripherals)
 
@@ -108,7 +108,7 @@
 #define DOT_MAX 50
 #define HOSTNAME_GRP 99
 
-#define APP_VER "10.5.3"
+#define APP_VER "10.5.4"
 
 #if defined(AUXILIARY)
 #define APP_NAME "ESP-CAM_AUX" // max 15 chars
@@ -151,7 +151,7 @@
 #define ISCAM // cam specific code in generics
 
 // to determine if newer data files need to be loaded
-#define CFG_VER 25
+#define CFG_VER 26
 
 #define AVI_EXT "avi"
 #define CSV_EXT "csv"
@@ -489,7 +489,10 @@ extern uint16_t rtpVideoPort;
 extern uint16_t rtpAudioPort;
 extern uint16_t rtpSubtitlesPort;
 extern char RTP_ip[];
+extern uint8_t rtspMaxClients;
 extern uint8_t rtpTTL;
+extern char RTSP_Name[];
+extern char RTSP_Pass[];
 
 // task handling
 extern TaskHandle_t battHandle;

appSpecific.cpp

@@ -228,19 +228,6 @@ bool updateAppStatus(const char* variable, const char* value, bool fromUser) {
   else if (!strcmp(variable, "uartTxdPin")) uartTxdPin = intVal;
   else if (!strcmp(variable, "uartRxdPin")) uartRxdPin = intVal;
 #endif
-
-#if INCLUDE_RTSP
-  else if (!strcmp(variable, "rtsp0Video")) rtspVideo = streamVid = (bool)intVal;
-  else if (!strcmp(variable, "rtsp1Audio")) rtspAudio = streamAud = (bool)intVal;
-  else if (!strcmp(variable, "rtsp2Subtitles")) rtspSubtitles = streamSrt = (bool)intVal;
-  else if (!strcmp(variable, "rtsp3Port")) rtspPort = intVal;
-  else if (!strcmp(variable, "rtsp4VideoPort")) rtpVideoPort = intVal;
-  else if (!strcmp(variable, "rtsp5AudioPort")) rtpAudioPort = intVal;
-  else if (!strcmp(variable, "rtsp6SubtitlesPort")) rtpSubtitlesPort = intVal;
-  else if (!strcmp(variable, "rtsp7Ip")) strncpy(RTP_ip, value, MAX_IP_LEN-1);
-  else if (!strcmp(variable, "rtsp8TTL")) rtpTTL = intVal;
-#endif
-
 #ifndef AUXILIARY
   // camera settings
   else if (!strcmp(variable, "xclkMhz")) xclkMhz = intVal;
@@ -991,13 +978,16 @@ relayMode~0~3~S:Manual:Night~How relay activated
 relaySwitch~0~3~C~Switch relay off / on
 I2Csda~-1~3~N~I2C SDA pin if unshared
 I2Cscl~-1~3~N~I2C SCL pin if unshared
-rtsp0Video~1~8~C~Enable RTSP Video
-rtsp1Audio~0~8~C~Enable RTSP Audio
-rtsp2Subtitles~1~8~C~Enable RTSP Subtitles
-rtsp3Port~554~8~N~RTSP ServerPort
-rtsp4VideoPort~5430~8~N~RTSP Video Port
-rtsp5AudioPort~5432~8~N~RTSP Audio Port
-rtsp6SubtitlesPort~5434~8~N~RTSP Subtitles Port
-rtsp7Ip~239.255.0.1~8~T~RTSP Multicast IP
-rtsp8TTL~1~8~N~RTSP Multicast Time-to-Live
+RTSP_Name~~8~T~RTSP Auth Username
+RTSP_Pass~~8~T~RTSP Auth Password
+rtsp00Video~1~8~C~Enable RTSP Video
+rtsp01Audio~0~8~C~Enable RTSP Audio
+rtsp02Subtitles~1~8~C~Enable RTSP Subtitles
+rtsp03Port~554~8~N~RTSP ServerPort
+rtsp04VideoPort~5430~8~N~RTSP Video Port
+rtsp05AudioPort~5432~8~N~RTSP Audio Port
+rtsp06SubtitlesPort~5434~8~N~RTSP Subtitles Port
+rtsp07Ip~239.255.0.1~8~T~RTSP Multicast IP
+rtsp08MaxC~3~8~N~RTSP Multicast Max Connections
+rtsp09TTL~1~8~N~RTSP Multicast Time-to-Live
 )~";

mjpeg2sd.cpp

@@ -841,7 +841,7 @@ static esp_err_t changeXCLK(camera_config_t config) {
     .speed_mode = LEDC_LOW_SPEED_MODE,
     .duty_resolution = LEDC_TIMER_1_BIT,
     .timer_num = config.ledc_timer,
-    .freq_hz = config.xclk_freq_hz,
+    .freq_hz = (uint32_t)config.xclk_freq_hz, // Fix arduino  warning: narrowing conversion from 'int' to 'uint32_t'
     .clk_cfg = LEDC_AUTO_CLK
   };
   res = ledc_timer_config(&ledc_timer);

prefs.cpp

@@ -191,6 +191,9 @@ static bool savePrefs(bool retain = true) {
 #endif
 #if INCLUDE_MQTT
   prefs.putString("mqtt_user_Pass", mqtt_user_Pass);
+#endif
+#if INCLUDE_RTSP
+  prefs.putString("RTSP_Pass", RTSP_Pass);
 #endif
   prefs.end();
   LOG_INF("Saved preferences");
@@ -221,6 +224,9 @@ static bool loadPrefs() {
 #endif
 #if INCLUDE_MQTT
   prefs.getString("mqtt_user_Pass", mqtt_user_Pass, MAX_PWD_LEN);
+#endif
+#if INCLUDE_RTSP
+  prefs.getString("RTSP_Pass", RTSP_Pass, MAX_PWD_LEN);
 #endif
   prefs.end();
   return true;
@@ -314,7 +320,20 @@ void updateStatus(const char* variable, const char* _value, bool fromUser) {
   else if (!strcmp(variable, "mqtt_user_Pass") && value[0] != '*') strncpy(mqtt_user_Pass, value, MAX_PWD_LEN-1);
   else if (!strcmp(variable, "mqtt_topic_prefix")) strncpy(mqtt_topic_prefix, value, (FILE_NAME_LEN/2)-1);
 #endif
-
+#if INCLUDE_RTSP
+  else if (!strcmp(variable, "RTSP_Name")) strncpy(RTSP_Name, value, MAX_HOST_LEN-1);
+  else if (!strcmp(variable, "RTSP_Pass")  && value[0] != '*')strncpy(RTSP_Pass, value, MAX_PWD_LEN-1);
+  else if (!strcmp(variable, "rtsp00Video")) rtspVideo = streamVid = (bool)intVal;
+  else if (!strcmp(variable, "rtsp01Audio")) rtspAudio = streamAud = (bool)intVal;
+  else if (!strcmp(variable, "rtsp02Subtitles")) rtspSubtitles = streamSrt = (bool)intVal;
+  else if (!strcmp(variable, "rtsp03Port")) rtspPort = intVal;
+  else if (!strcmp(variable, "rtsp04VideoPort")) rtpVideoPort = intVal;
+  else if (!strcmp(variable, "rtsp05AudioPort")) rtpAudioPort = intVal;
+  else if (!strcmp(variable, "rtsp06SubtitlesPort")) rtpSubtitlesPort = intVal;
+  else if (!strcmp(variable, "rtsp07Ip")) strncpy(RTP_ip, value, MAX_IP_LEN-1);
+  else if (!strcmp(variable, "rtsp08MaxC")) rtspMaxClients = intVal;
+  else if (!strcmp(variable, "rtsp09TTL")) rtpTTL = intVal;
+#endif
   // Other settings
   else if (!strcmp(variable, "clockUTC")) syncToBrowser((uint32_t)intVal);      
   else if (!strcmp(variable, "timezone")) strncpy(timezone, value, FILE_NAME_LEN-1);
@@ -410,6 +429,9 @@ void buildJsonString(uint8_t filter) {
 #endif
 #if INCLUDE_MQTT
       p += sprintf(p, "\"mqtt_user_Pass\":\"%.*s\",", strlen(mqtt_user_Pass), FILLSTAR);
+#endif
+#if INCLUDE_RTSP
+      p += sprintf(p, "\"RTSP_Pass\":\"%.*s\",", strlen(RTSP_Pass), FILLSTAR);
 #endif
     }
   } else {

rtsp.cpp

@@ -28,15 +28,22 @@
 
 RTSPServer rtspServer;
 
+//Comment out to enable multiple clients for all transports (TCP, UDP, Multicast)
+//#define OVERRIDE_RTSP_SINGLE_CLIENT_MODE
+
 bool rtspVideo;
 bool rtspAudio;
 bool rtspSubtitles;
 int rtspPort;
 uint16_t rtpVideoPort;
 uint16_t rtpAudioPort;
 uint16_t rtpSubtitlesPort;
-char RTP_ip [MAX_IP_LEN];
+char RTP_ip[MAX_IP_LEN];
+uint8_t rtspMaxClients;
 uint8_t rtpTTL;
+char RTSP_Name[MAX_HOST_LEN-1] = "";
+char RTSP_Pass[MAX_PWD_LEN-1] = "";
+bool useAuth;
 
 IPAddress rtpIp;
 char transportStr[30];  // Adjust the size as needed
@@ -123,6 +130,7 @@ static void startRTSPSubtitles(void* arg) {
 }
 
 void prepRTSP() {
+  useAuth = rtspServer.setCredentials(RTSP_Name, RTSP_Pass); // Set RTSP authentication
   RTSPServer::TransportType transport = determineTransportType();
   rtpIp.fromString(RTP_ip);
   rtspServer.transport = transport;
@@ -134,16 +142,19 @@ void prepRTSP() {
   rtspServer.rtpAudioPort = rtpAudioPort; 
   rtspServer.rtpSubtitlesPort = rtpSubtitlesPort;
   rtspServer.rtpIp = rtpIp; 
+  rtspServer.maxRTSPClients = rtspMaxClients;
   rtspServer.rtpTTL = rtpTTL; 
 
   if (transport != RTSPServer::NONE) {
     if (rtspServer.init()) { 
       LOG_INF("RTSP server started successfully with transport%s", transportStr);
-      LOG_INF("Connect to: rtsp://%s:%d", WiFi.localIP().toString().c_str(), rtspServer.rtspPort);
+      useAuth ? 
+          LOG_INF("Connect to: rtsp://<username>:<password>@%s:%d (credentials not shown for security reasons)", WiFi.localIP().toString().c_str(), rtspServer.rtspPort) :
+          LOG_INF("Connect to: rtsp://%s:%d", WiFi.localIP().toString().c_str(), rtspServer.rtspPort);
 
       // start RTSP tasks, need bigger stack for video
       if (rtspVideo) xTaskCreate(sendRTSPVideo, "sendRTSPVideo", 1024 * 5, NULL, SUSTAIN_PRI, &sustainHandle[1]); 
-      if (rtspAudio) xTaskCreate(sendRTSPAudio, "sendRTSPAudio", 1024 * 4, NULL, SUSTAIN_PRI, &sustainHandle[2]);
+      if (rtspAudio) xTaskCreate(sendRTSPAudio, "sendRTSPAudio", 1024 * 5, NULL, SUSTAIN_PRI, &sustainHandle[2]);
       if (rtspSubtitles) xTaskCreate(startRTSPSubtitles, "startRTSPSubtitles", 1024 * 1, NULL, SUSTAIN_PRI, &sustainHandle[3]);  
     } else { 
       LOG_ERR("Failed to start RTSP server");