v1.5.3

Release Notes

API / ABI / Integration Changes

API/ABI version: 1.5.

New Features

• PR #2714: Added maximum BW limit for retransmissions. See SRTO_MAXREXMITBW.
  The new option limits the maximum bandwidth that can be used for the retransmission of lost packets. Can be used in conjunction with the SRTO_MAXBW options family, which limits the overall pacing, and thus, the maximum bandwidth utilized by all SRT packets from the sender.

Important Bug Fixes

• PR #2632: Use overlapped WSASendTo to avoid UDP sending losses.
• PR #2766: Fixed spurious group read-ready epoll events.
• PR #2772: Fixed RCV buffer initialization in Rendezvous. ⚠️
• PR #2757: Fix memory leak on queuing connection initialization packets.
• PR #2745: Fix hang up on not enough space in the RCV buffer.
• PR #2740: Fix possible tsbpd() deadlock with processCtrlShutdown().
• PR #2692: Rejection not undertaken in rendezvous after KMX failure.
• PR #2774: Fix rendezvous connection mode when processing resulted in ACCEPT it was still sending rejection.
• PR #2778: Drop unencrypted packets in AES-GCM mode.

Build

• PR #2779, #2780: Fix the build for targets without IP_ADD_SOURCE_MEMBERSHIP.
• PR #2784: Added missing public header files in Windows binary installer.

Unit Tests

• PR #2681: Added custom main with transparent parameters.

Documentation

• PR #2765: Updated the explicit information for binding to IPv6 wildcard.
• PR #2785: Fixed API doc: SRT_INVALID_SOCK instead of SRT_ERROR in str_accept.

Contributors

@aaron-jencks, @ethouris, @gou4shi1, @jlsantiago0, @lelegard, @maxsharabayko, @robUx4, @yomnes0

Changelog

Click to expand/collapse

Core Functionality

b1d8b04 Fixed SRT_ATTR_REQUIRES use.
4682646 SRT version raised to 1.5.3.
78a1020 Added maximum BW limit for retransmissions (#2714).
033dc9f Drop unencrypted packets in GCM mode.
f9e36db Initialize ISN and PeerISN in CUDT.
54ef85f Minor code clean up in CRateEstimator.
50619bd Fix: In rendezvous when processing resulted in ACCEPT it was still sending rejection
d039fe6 Rejection not undertaken in rendezvous after KMX failure (#2692).
46b0579 Slightly optimize the RCV drop by message number (#2686).
7cfe12b fix tsbpd() may deadlock with processCtrlShutdown()
744035b Fix hang up on not enough space in the RCV buffer (#2745).
c6572bf Refactor CRcvQueue::storePkt(..) for better resource management (#2775).
256244f Fix memory leak when can't buffer a HS packet (#2757).
69c2376 Fixed RCV buffer initialization in Rendezvous.
88ca9cc Perf improvement of group reading.
31294e3 Removed unused CUDTGroup::m_Positions.
c639310 Fixed group read-ready epoll events.
9f4e9b6 Fixed srctime from closing socket was mistakenly cleared
1737e96 Add volatile keyword to asm block in rdtsc (#2759).
61c7bed Use overlapped WSASendTo to avoid loss in UDP sending (#2632).
10e71a6 Fixed unhandled error in haicrypt (#2685).

Unit Tests

9f41437 Added custom main with transparent parameters for tests (#2681).

Build Scripts (CMake, etc.)

51e3d0d Added missing public header files in Windows binary installer.
421f4e1 Fix downversioning of _WIN32_WINNT (#2754).

Sample Applications

33a620b Fixed conditional IP_ADD_SOURCE_MEMBERSHIP in testmedia (#2780).
e9eb8b3 Fix the build for target without IP_ADD_SOURCE_MEMBERSHIP (#2779).

Documentation

09f35c0 Fixed API doc: SRT_INVALID_SOCK instead of SRT_ERROR in str_accept.
d063313 Updating the explicit information for binding to IPv6 wildcard (#2765).

Full Changelog: v1.5.2...v1.5.3

v1.5.3-rc.0

Release Notes

API / ABI / Integration Changes

API/ABI version: 1.5.

New Features

• PR #2714: Added maximum BW limit for retransmissions. See SRTO_MAXREXMITBW.

Important Bug Fixes

• PR #2632: Use overlapped WSASendTo to avoid UDP sending losses.
• PR #2766: Fixed spurious group read-ready epoll events.
• PR #2772: Fixed RCV buffer initialization in Rendezvous. ⚠️
• PR #2757: Fix memory leak on queing connection initialization packets.
• PR #2745: Fix hang up on not enough space in the RCV buffer.
• PR #2740: Fix possible tsbpd() deadlock with processCtrlShutdown().
• PR #2692: Rejection not undertaken in rendezvous after KMX failure.
• PR #2774: Fix rendezvous connection mode when processing resulted in ACCEPT it was still sending rejection.
• PR #2778: Drop unencrypted packets in AES-GCM mode.

Build

• PR #2779, #2780: Fix the build for target without IP_ADD_SOURCE_MEMBERSHIP.

Unit Tests

• PR #2681: Added custom main with transparent parameters.

Documentation

• PR #2765: Updated the explicit information for binding to IPv6 wildcard.

Contributors

@aaron-jencks, @ethouris, @gou4shi1, @jlsantiago0, @maxsharabayko, @robUx4, @yomnes0

Changelog

Click to expand/collapse

Core Functionality

4682646 SRT version raised to 1.5.3.
78a1020 Added maximum BW limit for retransmissions (#2714).
033dc9f Drop unencrypted packets in GCM mode.
f9e36db Initialize ISN and PeerISN in CUDT.
54ef85f Minor code clean up in CRateEstimator.
50619bd Fix: In rendezvous when processing resulted in ACCEPT it was still sending rejection
d039fe6 Rejection not undertaken in rendezvous after KMX failure (#2692).
46b0579 Slightly optimize the RCV drop by message number (#2686).
7cfe12b fix tsbpd() may deadlock with processCtrlShutdown()
744035b Fix hang up on not enough space in the RCV buffer (#2745).
c6572bf Refactor CRcvQueue::storePkt(..) for better resource management (#2775).
256244f Fix memory leak when can't buffer a HS packet (#2757).
69c2376 Fixed RCV buffer initialization in Rendezvous.
88ca9cc Perf improvement of group reading.
31294e3 Removed unused CUDTGroup::m_Positions.
c639310 Fixed group read-ready epoll events.
9f4e9b6 Fixed srctime from closing socket was mistakenly cleared
1737e96 Add volatile keyword to asm block in rdtsc (#2759).
61c7bed Use overlapped WSASendTo to avoid loss in UDP sending (#2632).
10e71a6 Fixed unhandled error in haicrypt (#2685).

Unit Tests

9f41437 Added custom main with transparent parameters for tests (#2681).

Build Scripts (CMake, etc.)

421f4e1 Fix downversioning of _WIN32_WINNT (#2754).

Sample Applications

33a620b Fixed conditional IP_ADD_SOURCE_MEMBERSHIP in testmedia (#2780).
e9eb8b3 Fix the build for target without IP_ADD_SOURCE_MEMBERSHIP (#2779).

Documentation

d063313 Updating the explicit information for binding to IPv6 wildcard (#2765).

v1.5.2

Release Notes

API / ABI / Integration Changes

API/ABI version: 1.5.

Known Issues

• #2773: Rendezvous Connection: Wrong Initial Sequence Initialization of the Receiver results in sequence discrepancy and connection break.

New Features and Improvements

• Epic #2336: Added Authenticated Encryption with Associated Data (AEAD) mode. v1.6.0 API Preview.
  Use a combination of ENABLE_AEAD_API_PREVIEW=ON,ENABLE_ENCRYPTION=ON, and USE_ENCLIB=openssl-evp build options to activate the feature.
• PR #456: Implemented replying to a connection request using the same network interface on which this connection request was received. In particular, in the case of socket groups this resolves handshake negotiation of individual member connections when a group listener is bound to IPv4_ANY or IPv6_ANY. Should be enabled via the ENABLE_PKTINFO=ON build option.
  Note that this feature is available only on certain platforms. BSD systems are known to NOT provide this feature, and the current implementation does NOT support this feature on Windows systems.

Important Bug Fixes

• #2697: Handshake-related issues on big-endian machines (byte order in packet filter config #2708 and peer address #2729).
• PR #2679: Fixed various compiler warnings on various platforms.
• PR #2717: Fixed the crash on FEC matrix resize.
• PR #2711: Changed the order of buffer allocations and crypto mode negotiation when crypto mode equals 0 (auto) for SRT listener, sender side. See the SRTO_CRYPTOMODE socket option.
• PR #2664: To close a connection in rendezvous mode, instead of a SHUTDOWN packet the peer now sends a CONCLUSION handshake packet with a rejection reason.
• PR #2661: Improved performance of the CRcvBuffer::dropMessage(..) function.
• PR #2643: A CLOSING state is now set when closing a socket.
• PR #2608: Reworked and fixed the multiplexer usage as well as the unit tests for ReuseAddr.
• PR #2619: Addressed possible crash when heavy logging is enabled and socket ID is less than 10.
• PR #2630: Fixed the IP_PKTINFO case that was failing for IPv4+IPv6 bound sockets.
• PR #2616: Fixed the incorrect null-safety condition check in the haicrypt library.
• PR #2622: A caller now sets the correct rejection reason (instead of always SRT_REJ_UNSECURE) depending on the encryption level error.
• PR #2605: The SRT_REJX_FALLBACK rejection reason is now used if an application rejects a group connection without providing a reason.
• PR #2589: Fixed problem where if SRTO_MSS < SRTO_PAYLOADSIZE, a message would be split into two packets in live configuration mode.
• PR #2557: Fixed the issue where one caller was successfully connecting to another. This is now restricted.
• PR #2555: Fixed the issue where a caller was successfully connecting to a peer in rendezvous mode. This is now restricted.
• PR #2553: Addressed possible crash when sending crypto keys.
• PR #2539: Improved the rendezvous connection process which was taking extra unnecessary steps in non-blocking mode.
• #2502: Fixed the issue with getting a corrupted packet on the receiving side when encryption is enabled.
• #2494: During the INDUCTION phase of the handshake process, the connection should be rejected if the Extension Flags field does not contain the magic value of 0x4A17. The associated rejection reason is SRT_REJ_ROGUE.
• #2485: Addressed the issue where a peer address was not available through the srt_getpeername() function.
• PR #2411: Disabled warnings on various platforms and improved C++20 Windows build.
• PR #1859: Improved mutex protection of m_iFlowWindowSize, m_iSndLastAck, m_tsLastRspTime, and m_iSndLastAck fields.

Build

• PR #2726: Added -Wshadow=local to CMake build flags. Supported since GCC 7.0.
• PR #2671: Restricted unit tests to serial execution only.
• PR #2439: Fixed the builds where the C++ runtime library does not have std::put_time() function.
• PR #2462: Fixed macOS build with SDK 10.5.

Documentation

• PR #2659: Added SRTO_PBKEYLEN negotiation table to the documentation.
• PR #2575: Fixed SRTO_PASSPHRASE length range.
• PR #2513: Fixed the incorrect description of PBKEYLEN conflict resolution.
• PR #2529: Added a note on activating HAICRYPT logging.
• PR #2483: Added AES GSM socket options and rejection reasons to the SRT API documentation (SRTO_CRYPTOMODE, SRT_REJ_CRYPTO, SRT_KM_S_BADCRYPTOMODE).

Sample Applications

• PR #2688: Fixed the crash in srt-test-multiplex application on medium error.

Changelog

Click to expand/collapse

API

41c4b1f Fixed #ifdef ENABLE_AEAD_API_PREVIEW (#2603).
b3a21e1 SRT version raised to 1.5.2.
c0d9fcd Restored resetlogfa(..) in udt.h. Reverting #2558, although udt.h is not the official SRT API.
87de405 Added ENABLE_AEAD_API_PREVIEW build option to enable AEAD API.
60d1237 Crypto mode 'auto' implemented for listener (#2574).
27e7d8d Socket Options: do not allow AES GCM if TSBPD is disabled.
3e4561e Add GCM to the SRT API.

Core Functionality

3cefede Correct remaining endianness issues
30e7ccd Minor fix of variable shadowing.
6fcff6d Fixed various compiler warnings on various platforms (#2679).
59cde53 Fixed FEC Emergency resize crash (#2717).
2fcd3d4 Fix crypto mode auto for listener sender (#2711).
b010763 Fixed typos in MBedTLS where it referred to GnuTLS (#2699).
a991767 Fix peer filter config being rejected because of endianness
1cffd2f Added rejection handshake sent to the peer in rendezvous mode (#2667).
f57ba89 Added missing thread watchdog ticks in 3 thread loop (#2669).
e8d0533 Fixed old ENABLE_AEAD_PREVIEW.
599c1fb Reworked the CRcvBuffer::dropMessage(..) function (#2661).
7948772 Removed duplicate lines (#2660).
3ffc93f Fixed CRcvBuffer::dropMessage (#2657).
e9a3955 Fixed guard for rcv-rexmit fields (#1859).
22e97f8 Fixed warnings and removed redundant includes (#2658).
c83c31b Reduce frequency of the decryption failure log (#2602).
21b55a2 Disabled warnings various platforms and fixed C++20 Windows build (#2411).
65bef37 Set CLOSING state when closing a socket (#2643).
02cba9e Drop undecrypted packet based on sequence number (#2654).
6d774dd Fixed invalid ASSERT checking outdated object in haicrypt (#2652).
8db35de Refaxed and fixed multiplexer reusage (#2608).
6c92a13 Fix crash when enable heavy log and socket id less than 10 (#2619).
64dedef CodeQL: operation requires 22 bytes.
0c583f8 CodeQL warning: checking NULL after new.
b8962b4 Fixed PKTINFO case that was failing for IPv4+IPv6 bound sockets (#2630).
a42a39f Fixed wrong null-safety condition check in haicrypt (#2616).
30f6f6b Removed extra redundant condition checks (#2615).
5f02310 Fix negative id when wrap around
f533716 Fixed reject reason by a caller if connection is UNSECURE (#2622).
04e8dbc Fixed default reject reason for a listener callback (#2605).
0b9d583 AEAD: don't break a connection on decrypt failure.
6db28dc RCV Buffer Refax: added some utils and simplifications (#2522).
5889a2c AES-GCM payload length check (#2591).
45232ad Allow fileCC in group mode
98b1b00 Added extraction of IP_PKTINFO when reading (#456).
de9fc45 Fix CRcvBuffer last position in getTimespan_ms (#2579).
38b4211 Remove use variable length array (#2279).
78dd987 Fixed missing DROPREQ for LOSSREPORT that partially predates ACK (#2498).
4090b25 Reject caller to caller connection (#2562).
0a835ea Refax: moved removal of one seq from fresh loss list to a separate function (#2521).
19af5d1 Obtain ConnectionLock while sending crypto keys.
3d517cf Fixed a warning: member referenced before initialized (#2433).
fc82eac Refax: remove usage of LOGF/HLOGF (#2566).
637d439 Refax: removed m_iRcvLastSkipAck and its dependencies (#2546).
6c52f2d Pass std::string by const ref where possible.
6d62096 Applied clang-format on md5.cpp and md5.h.
2c48cba MD5: Removed null pointer subtraction (may have undefined behavior).
ae39052 Fixed rendezvous connection in the Non Blocking Mode (#2548).
0138898 Fixed cloning the RX crypto context (AEAD)
be1ccf5 Moved KM refresh in packUniqueData() (#2541).
f864cec Fixed TARGET_OS_MAC not defined. Wrong include order.
432f2d8 fix CSndBuffer parameter incorrect in AES GCM mode
cbfa812 Refax/postfix: further fixes after last refax changes (#2528)
e082f30 Fixed validation of input parameters in srt_connect (#2520).
932e5bd Cleanup of bonding conditionals and unused code (#2525).
f477b51 Fixed connected peer address recording (#2526)
b76c8b2 Fixed CRcvBuffer::getAvailSize() may jump around. (#2490)
71c3e40 Refax: safety improvements for RCV loss list and closing state (#2517)
491e6e8 Extract RCV buffer insertion handling to a separate function (#2500).
258a858 Refax: added size cache to the group container (#2510).
2fd1363 Refax: improve logging and code readability around specific logging (#2511).
f7a024a Refax: removed the synconmsg property and its handling in the group (#2509)
53735e1 Don't consider tool old ACK as IPE, it' may caused by network.
d26bbf7 Fixed a false alarm: ACK ERROR...(diff -1)
0f6e7c7 Fixed the inconsistency between getFirstLostSeq() and ackDataUpTo() (#2488)
ea86302 Reduced calls to steady_clock::now() from two to one.
8e9958a Reje...

v1.5.2-rc.2

Release Notes

Changes from v1.5.2-rc.1.

API / ABI / Integration Changes

API/ABI version: 1.5.

Important Bug Fixes

#2697: Handshake issues on big-endian machines (byte order in Packet filter config #2708 and Peer address #2729).
#2679: Fixed various compiler warnings on various platforms.
#2717: Fixed FEC Emergency resize crash.
#2711: Fix crypto mode auto for listener sender.

Sample Applications

#2688: Fixed crash in srt-test-multiplex on medium error.

Build

#2726: Add -Wshadow=local to CMake build flags. Supported since GCC 7.0.

Documentation

#2721: Added the link for registration in Slack to the getting started table.

Changelog from v1.5.2-rc.1

Click to expand/collapse

Core Functionality

3cefede Correct remaining endianness issues
30e7ccd Minor fix of variable shadowing.
6fcff6d Fixed various compiler warnings on various platforms (#2679).
59cde53 Fixed FEC Emergency resize crash (#2717).
2fcd3d4 Fix crypto mode auto for listener sender (#2711).
b010763 Fixed typos in MBedTLS where it referred to GnuTLS (#2699).
a991767 Fix peer filter config being rejected because of endianness

Unit Tests

be254e7 Minor fix of variable shadowing.

Build Scripts (CMake, etc.)

66c86b1 Add -Wshadow=local to CMake build flags. Supported since GCC 7.0.
9fc5c09 Upgraded CI: ubuntu to version 20.04 (#2682).

Sample Applications

3982284 Fixed crash in srt-test-multiplex on medium error (#2688).

Documentation

4c9a417 Added the link for registration in slack to the getting started table (#2721).

v1.5.2-rc.1

Release Notes

Including changes from v1.5.2-rc.0.

API / ABI / Integration Changes

API/ABI version: 1.5.

New Features and Improvements

• Epic #2336: Add Authenticated-Encryption with Associated-Data (AEAD) mode - v1.6.0 API Preview.
  Use the ENABLE_AEAD_API_PREVIEW=ON and USE_ENCLIB=openssl-evp build options.
• PR #456: Added extraction of IP_PKTINFO.

Important Bug Fixes

• #2664: Send rejection handshake to the peer in rendezvous mode.
• #2661: Reworked the CRcvBuffer::dropMessage(..) function.
• #2643: Set CLOSING state when closing a socket.
• #2608: Refaxed and fixed multiplexer reusage.
• #2619: Fix crash when enable heavy log and socket id less than 10.
• #2630: Fixed PKTINFO case that was failing for IPv4+IPv6 bound sockets.
• #2616: Fixed wrong null-safety condition check in haicrypt.
• #2622: Fixed reject reason by a caller if connection is UNSECURE.
• #2605: Fixed default reject reason for a listener callback.
• #2589: SRTO_MSS = 1300 splits one message into two packets in TSBPD mode.
• #2557: The caller should not connect to another caller.
• #2555: The caller should not connect to rendezvous.
• #2553: Possible crash while sending crypto keys.
• #2539: Rendezvous Connection takes extra steps in the Non-Blocking Mode.
• #2502: Corrupted data packet at SRT receiver output when using encryption.
• #2494: Handshake: reject if the Extension Flags field does not contain the magic value (INDUCTION PHASE).
• #2485: Peer address not available through srt_getpeername().
• #2411: Disabled warnings various platforms and fixed C++20 Windows build.
• #1859: Fixed guard for rcv-rexmit fields.

Build

• PR #2671: Set serial running unit tests property.
• PR #2439: Fix builds where the C++ runtime library does not have std::put_time().
• PR #2462: Fix MacOS Build with SDK-10.5.

Documentation

• PR #2659: Added SRTO_PBKEYLEN negotiation table.
• PR #2575: Fixed SRTO_PASSPHRASE length range.
• PR #2513: Fixed wrong description of PBKEYLEN conflict resolution.
• PR #2529: Added a note on activating HAICRYPT logging.
• PR #2483: Added SRTO_CRYPTOMODE, SRT_REJ_CRYPTO, SRT_KM_S_BADCRYPTOMODE.

Changelog

Click to expand/collapse

API

41c4b1f Fixed #ifdef ENABLE_AEAD_API_PREVIEW (#2603).
b3a21e1 SRT version raised to 1.5.2.
c0d9fcd Restored resetlogfa(..) in udt.h. Reverting #2558, although udt.h is not the official SRT API.
87de405 Added ENABLE_AEAD_API_PREVIEW build option to enable AEAD API.
60d1237 Crypto mode 'auto' implemented for listener (#2574).
27e7d8d Socket Options: do not allow AES GCM if TSBPD is disabled.
3e4561e Add GCM to the SRT API.

Core Functionality

1cffd2f Added rejection handshake sent to the peer in rendezvous mode (#2667).
f57ba89 Added missing thread watchdog ticks in 3 thread loop (#2669).
e8d0533 Fixed old ENABLE_AEAD_PREVIEW.
599c1fb Reworked the CRcvBuffer::dropMessage(..) function (#2661).
7948772 Removed duplicate lines (#2660).
3ffc93f Fixed CRcvBuffer::dropMessage (#2657).
e9a3955 Fixed guard for rcv-rexmit fields (#1859).
22e97f8 Fixed warnings and removed redundant includes (#2658).
c83c31b Reduce frequency of the decryption failure log (#2602).
21b55a2 Disabled warnings various platforms and fixed C++20 Windows build (#2411).
65bef37 Set CLOSING state when closing a socket (#2643).
02cba9e Drop undecrypted packet based on sequence number (#2654).
6d774dd Fixed invalid ASSERT checking outdated object in haicrypt (#2652).
8db35de Refaxed and fixed multiplexer reusage (#2608).
6c92a13 Fix crash when enable heavy log and socket id less than 10 (#2619).
64dedef CodeQL: operation requires 22 bytes.
0c583f8 CodeQL warning: checking NULL after new.
b8962b4 Fixed PKTINFO case that was failing for IPv4+IPv6 bound sockets (#2630).
a42a39f Fixed wrong null-safety condition check in haicrypt (#2616).
30f6f6b Removed extra redundant condition checks (#2615).
5f02310 Fix negative id when wrap around
f533716 Fixed reject reason by a caller if connection is UNSECURE (#2622).
04e8dbc Fixed default reject reason for a listener callback (#2605).
0b9d583 AEAD: don't break a connection on decrypt failure.
6db28dc RCV Buffer Refax: added some utils and simplifications (#2522).
5889a2c AES-GCM payload length check (#2591).
45232ad Allow fileCC in group mode
98b1b00 Added extraction of IP_PKTINFO when reading (#456).
de9fc45 Fix CRcvBuffer last position in getTimespan_ms (#2579).
38b4211 Remove use variable length array (#2279).
78dd987 Fixed missing DROPREQ for LOSSREPORT that partially predates ACK (#2498).
4090b25 Reject caller to caller connection (#2562).
0a835ea Refax: moved removal of one seq from fresh loss list to a separate function (#2521).
19af5d1 Obtain ConnectionLock while sending crypto keys.
3d517cf Fixed a warning: member referenced before initialized (#2433).
fc82eac Refax: remove usage of LOGF/HLOGF (#2566).
637d439 Refax: removed m_iRcvLastSkipAck and its dependencies (#2546).
6c52f2d Pass std::string by const ref where possible.
6d62096 Applied clang-format on md5.cpp and md5.h.
2c48cba MD5: Removed null pointer subtraction (may have undefined behavior).
ae39052 Fixed rendezvous connection in the Non Blocking Mode (#2548).
0138898 Fixed cloning the RX crypto context (AEAD)
be1ccf5 Moved KM refresh in packUniqueData() (#2541).
f864cec Fixed TARGET_OS_MAC not defined. Wrong include order.
432f2d8 fix CSndBuffer parameter incorrect in AES GCM mode
cbfa812 Refax/postfix: further fixes after last refax changes (#2528)
e082f30 Fixed validation of input parameters in srt_connect (#2520).
932e5bd Cleanup of bonding conditionals and unused code (#2525).
f477b51 Fixed connected peer address recording (#2526)
b76c8b2 Fixed CRcvBuffer::getAvailSize() may jump around. (#2490)
71c3e40 Refax: safety improvements for RCV loss list and closing state (#2517)
491e6e8 Extract RCV buffer insertion handling to a separate function (#2500).
258a858 Refax: added size cache to the group container (#2510).
2fd1363 Refax: improve logging and code readability around specific logging (#2511).
f7a024a Refax: removed the synconmsg property and its handling in the group (#2509)
53735e1 Don't consider tool old ACK as IPE, it' may caused by network.
d26bbf7 Fixed a false alarm: ACK ERROR...(diff -1)
0f6e7c7 Fixed the inconsistency between getFirstLostSeq() and ackDataUpTo() (#2488)
ea86302 Reduced calls to steady_clock::now() from two to one.
8e9958a Reject if SRT_MAGIC_CODE is not set in the HS induction response.
8e67aa7 Tune logs of group members adding and removing.
c01c646 Fixed AES-GCM support check.
d5f73ca Protocol: set AES-GCM auth in the KM message.
f637035 Use setDataPacketTS to timestamp data packets (#2489).
04369b8 Made offset consistent with avail_bufsize. (#2465)
ba5ad53 Fixed message seqno check.
c416971 Minor edits to the CRcvBuffer::getTimespan_ms().
9ed7392 CRYSPR GCM: fixed usage of the aes_gcm_cipher(..) prototype. Renamed CRYSPR_AUTHTAGMAX to HAICRYPT_AUTHTAG_MAX and relocated.
66179ab CRYSPR: Add AES GCM mode with OpenSSL EVP (#2476).
1b20a48 Replaced m_iRcvLastSkipAck with m_iRcvLastAck in logs.
e94d3e1 Add auth tag to the sender buffer. The additional space to be used for auth tag in GCM AEAD.
6dd47c3 Add capacity property to CPacket.
345517b Changed CUnit::m_iFlag type to bool.
2fed400 Renamed buffer.cpp to buffer_snd.cpp.
4f2bf28 Renamed CRcvBufferNew to CRcvBuffer
29c7c64 Removed old receiver buffer and ENABLE_NEW_RCVBUFFER build option.
a1c0ab3 Combined the loops of m_FreshLoss and m_pRcvLossList
daf91f3 Replaced reorder_prevent_lossreport with initial_loss_ttl.
ae18186 Also protected m_pRcvLossList->insert() with m_RcvBufferLock.
432cfe4 Moved m_FreshLoss.push_back() out of the incoming loop.
e2f4375 Cleanup the useless tnkeep.
c21a5ae Mark m_pRcvLossList and m_FreshLoss to be guarded by m_RcvLossLock.
70a8eb2 Fixed missing m_RcvLossLock in processData().
22588e4 Improved logs of core.cpp with CONID()
229192c Added a trailing space in CONID()
d84ac20 Improved some logs for the no room issue.
90bcc64 Fixed CRcvLossList can not remove m_iMaxSeqNo.
8c6675c Fixed some wrong usages of m_iMaxSeqNo.
fda7441 Refax: moved buffer tools to a separate file (#2499).

Unit Tests

715da9d Added check for read-ready for decryption failure case (#2609).
053f179 Splitting ListenCallback test into 3 separate tests (#2556).
9a022d6 Added AES GCM unit test for CCryptoControl.
43a7c32 Added a couple of tests on RCV loss list.
fa8c58a Bonding: fixed closing the listener socket (#2538).

Build Scripts (CMake, etc.)

d9c1794 Set serial running unit tests property (#2671).
f57beb6 Fixed CodeQL configuration (#2644).
a7bd1b0 Use CXX 14 in MacOS GitHub Action.
dd19eac Add CodeQL workflow for GitHub code scanning (#2578).
85f555d Fix builds where the C++ runtime library does not have std::put_time() (#2439).
a08a42c Use GTest from brew in MacOS action. (#2607)
ef17a24 Travis: display stack trace by gdb on crash (#2565).
fdb9389 Run codecov only after success in Travis.
f86df39 Disable ConnectionTimeout test (blocking), Win GitHub Action (#2543).
27a92b3 Upgrade to checkout@v3 GitHub action.
b90b64d Identify parameters with a prepended -l in CMAKE_CXX_IMPLICIT_LINK_LIBRARIES
90af35a Fix MacOS Build with SDK-10.5 (#2462).
f610fe6 Find GTest using version range 1.8-1.12.

Sample Applications

46d55c6 Added 'bind' parameter handling for applications (#2672).
aba73de Added examples for message mode transmission (#2592).
b38b61d Fix ENABLE_AEAD_API_PREVIEW in apps. (#2588)
b6f1e9c Examples: wait 1 sec until receiver completes (#2572).
11701a6 Added cryptomode URI query option.
18c829a UriParser: fixed protocol type detection (#2452).
0bc3b03 List contributors using the changelog generation script (#2456)

Documentation

...

v1.5.2-rc.0

Release Notes

API / ABI / Integration Changes

API/ABI version: 1.5.

New Features and Improvements

• Epic #2336: Add Authenticated-Encryption with Associated-Data (AEAD) mode - v1.6.0 API Preview.
  Use the ENABLE_AEAD_API_PREVIEW=ON and USE_ENCLIB=openssl-evp build options.
• PR #456: Added extraction of IP_PKTINFO.

Important Bug Fixes

• #2589: SRTO_MSS = 1300 splits one message into two packets in TSBPD mode.
• #2557: The caller should not connect to another caller.
• #2555: The caller should not connect to rendezvous.
• #2553: Possible crash while sending crypto keys.
• #2539: Rendezvous Connection takes extra steps in the Non-Blocking Mode.
• #2502: Corrupted data packet at SRT receiver output when using encryption.
• #2494: Handshake: reject if the Extension Flags field does not contain the magic value (INDUCTION PHASE).
• #2485: Peer address not available through srt_getpeername().

Build

• PR #2462: Fix MacOS Build with SDK-10.5 (#2462).

Documentation

• PR #2513: Fixed wrong description of PBKEYLEN conflict resolution.
• PR #2529: Added a note on activating HAICRYPT logging.
• PR #2483: Added SRTO_CRYPTOMODE, SRT_REJ_CRYPTO, SRT_KM_S_BADCRYPTOMODE.

Changelog

Click to expand/collapse

API

b3a21e1 [API] SRT version raised to 1.5.2.
c0d9fcd [API] Restored resetlogfa(..) in udt.h. Reverting #2558, although udt.h is not the official SRT API.
87de405 [API] Added ENABLE_AEAD_API_PREVIEW build option to enable AEAD API.
60d1237 [API] Crypto mode 'auto' implemented for listener (#2574).
27e7d8d [api] Socket Options: do not allow AES GCM if TSBPD is disabled.
3e4561e [API] Add GCM to the SRT API.

Core Functionality

0b9d583 AEAD: don't break a connection on decrypt failure.
6db28dc RCV Buffer Refax: added some utils and simplifications (#2522).
5889a2c AES-GCM payload length check (#2591).
45232ad Allow fileCC in group mode
98b1b00 Added extraction of IP_PKTINFO when reading (#456).
de9fc45 Fix CRcvBuffer last position in getTimespan_ms (#2579).
38b4211 Remove use variable length array (#2279).
78dd987 Fixed missing DROPREQ for LOSSREPORT that partially predates ACK (#2498).
4090b25 Reject caller to caller connection (#2562).
0a835ea Refax: moved removal of one seq from fresh loss list to a separate function (#2521).
19af5d1 Obtain ConnectionLock while sending crypto keys.
3d517cf Fixed a warning: member referenced before initialized (#2433).
fc82eac Refax: remove usage of LOGF/HLOGF (#2566).
637d439 Refax: removed m_iRcvLastSkipAck and its dependencies (#2546).
6c52f2d Pass std::string by const ref where possible.
6d62096 Applied clang-format on md5.cpp and md5.h.
2c48cba MD5: Removed null pointer subtraction (may have undefined behavior).
ae39052 Fixed rendezvous connection in the Non Blocking Mode (#2548).
0138898 Fixed cloning the RX crypto context (AEAD)
be1ccf5 Moved KM refresh in packUniqueData() (#2541).
f864cec Fixed TARGET_OS_MAC not defined. Wrong include order.
432f2d8 fix CSndBuffer parameter incorrect in AES GCM mode
cbfa812 Refax/postfix: further fixes after last refax changes (#2528)
e082f30 Fixed validation of input parameters in srt_connect (#2520).
932e5bd Cleanup of bonding conditionals and unused code (#2525).
f477b51 Fixed connected peer address recording (#2526)
b76c8b2 Fixed CRcvBuffer::getAvailSize() may jump around. (#2490)
71c3e40 Refax: safety improvements for RCV loss list and closing state (#2517)
491e6e8 Extract RCV buffer insertion handling to a separate function (#2500).
258a858 Refax: added size cache to the group container (#2510).
2fd1363 Refax: improve logging and code readability around specific logging (#2511).
f7a024a Refax: removed the synconmsg property and its handling in the group (#2509)
53735e1 Don't consider tool old ACK as IPE, it' may caused by network.
d26bbf7 Fixed a false alarm: ACK ERROR...(diff -1)
0f6e7c7 Fixed the inconsistency between getFirstLostSeq() and ackDataUpTo() (#2488)
ea86302 Reduced calls to steady_clock::now() from two to one.
8e9958a Reject if SRT_MAGIC_CODE is not set in the HS induction response.
8e67aa7 Tune logs of group members adding and removing.
c01c646 Fixed AES-GCM support check.
d5f73ca Protocol: set AES-GCM auth in the KM message.
f637035 Use setDataPacketTS to timestamp data packets (#2489).
04369b8 Made offset consistent with avail_bufsize. (#2465)
ba5ad53 Fixed message seqno check.
c416971 Minor edits to the CRcvBuffer::getTimespan_ms().
9ed7392 CRYSPR GCM: fixed usage of the aes_gcm_cipher(..) prototype. Renamed CRYSPR_AUTHTAGMAX to HAICRYPT_AUTHTAG_MAX and relocated.
66179ab CRYSPR: Add AES GCM mode with OpenSSL EVP (#2476).
1b20a48 Replaced m_iRcvLastSkipAck with m_iRcvLastAck in logs.
e94d3e1 Add auth tag to the sender buffer. The additional space to be used for auth tag in GCM AEAD.
6dd47c3 Add capacity property to CPacket.
345517b Changed CUnit::m_iFlag type to bool.
2fed400 Renamed buffer.cpp to buffer_snd.cpp.
4f2bf28 Renamed CRcvBufferNew to CRcvBuffer
29c7c64 Removed old receiver buffer and ENABLE_NEW_RCVBUFFER build option.
a1c0ab3 Combined the loops of m_FreshLoss and m_pRcvLossList
daf91f3 Replaced reorder_prevent_lossreport with initial_loss_ttl.
ae18186 Also protected m_pRcvLossList->insert() with m_RcvBufferLock.
432cfe4 Moved m_FreshLoss.push_back() out of the incoming loop.
e2f4375 Cleanup the useless tnkeep.
c21a5ae Mark m_pRcvLossList and m_FreshLoss to be guarded by m_RcvLossLock.
70a8eb2 Fixed missing m_RcvLossLock in processData().
22588e4 Improved logs of core.cpp with CONID()
229192c Added a trailing space in CONID()
d84ac20 Improved some logs for the no room issue.
90bcc64 Fixed CRcvLossList can not remove m_iMaxSeqNo.
8c6675c Fixed some wrong usages of m_iMaxSeqNo.
fda7441 Refax: moved buffer tools to a separate file (#2499).

Unit Tests

053f179 Splitting ListenCallback test into 3 separate tests (#2556).
9a022d6 Added AES GCM unit test for CCryptoControl.
43a7c32 Added a couple of tests on RCV loss list.
fa8c58a Bonding: fixed closing the listener socket (#2538).

Build Scripts (CMake, etc.)

ef17a24 Travis: display stack trace by gdb on crash (#2565).
fdb9389 Run codecov only after success in Travis.
f86df39 Disable ConnectionTimeout test (blocking), Win GitHub Action (#2543).
27a92b3 Upgrade to checkout@v3 GitHub action.
b90b64d Identify parameters with a prepended -l in CMAKE_CXX_IMPLICIT_LINK_LIBRARIES
90af35a Fix MacOS Build with SDK-10.5 (#2462).
f610fe6 Find GTest using version range 1.8-1.12.

Sample Applications

aba73de Added examples for message mode transmission (#2592).
b38b61d Fix ENABLE_AEAD_API_PREVIEW in apps. (#2588)
b6f1e9c Examples: wait 1 sec until receiver completes (#2572).
11701a6 Added cryptomode URI query option.
18c829a UriParser: fixed protocol type detection (#2452).

Documentation

5b16f69 Removed LGTM badges from README.
a7e4204 groupconnect option value "1" (instead of "true") (#2590)
ba67d36 AES-GCM is only allowed if TSBPD is enabled.
72d135d Fixed SRTO_PASSPHRASE length range.
6a0caac Address multiple typo fixes. (#2570)
37d44f4 Added lacking SRTO_BINDTODEVICE for srt_config_add (#2564).
a791156 Fixed wrong description of PBKEYLEN conflict resolution (#2513).
89992c0 Added a note on activating HAICRYPT logging (#2529)
8a77525 Add SRTO_CRYPTOMODE, SRT_REJ_CRYPTO, SRT_KM_S_BADCRYPTOMODE.
e0a25d0 Fixed the build-win.md (#2487)
0f49f1c Defined a reason to use C++11 on Windows
6c4c299 Updated docs on release notes generation

v1.5.1

Release Notes

API / ABI / Integration Changes

API/ABI version: 1.5.

Some minor changes touching, but not affecting the API/ABI compliance:

• PR #2440: The SRT API file srt.h defines macros MJ and MN and almost immediately undefines them. Those short names could potentially conflict with macros in 3rd party applications. Renamed macro MN to SRT_EMN and MJ to SRT_EMJ.
• PR #2451: Fixed DLL build when using mingw-w64 that supports __declspec(dllexport) and __declspec(import) specifiers.

Improvements and Important Bug Fixes

• PR #2333: Added support for OpenSSL EVP API. Can be enabled with the help of the -DUSE_ENCLIB=openssl-evp CMake build option.
• PR #2408: Improved timing for idle connections. TSBPD time base (TsbpdTimeBase) and clock drift (Drift) values are adjusted to take the TSBPD wrapping period into account even if there are no data packets transmitted over the connection.
• PR #2384, #2395: Data race fixes for CRcvQueue and CUnitQueue.
• PR #2405: Improved receiver performance via CUnitQueue changes.
• PR #2416: Fixed the calculation of the byteRcvLoss statistic. This is a fix for the issue #2414 introduced in PR #2212. Affected version is v1.5.0.
• PR #2413, #2425: Fixed data races in crypto library in the case of mbedTLS.
• PR #2391: Fixed the sendBroadcast() function message length.
• PR #2398: Added ENABLE_BONDING socket option to the Windows PowerShell build script.

Documentation

• PR #2454: Added description of package managers supporting the SRT library to Build Instructions.

Contributors

@maxsharabayko, @jeandube, @oviano, @robUx4, @mbakholdina, @ethouris, @gou4shi1, @maksqwe, @lewk2, @Adela0814

Changelog

Click to expand/collapse

API/ABI

453b276 SRT version raised to 1.5.1.
ec52c45 Export functions in mingw-w64 when building as a DLL (#2451).
daf838e Renamed macro MN to SRT_EMN, MJ to SRT_EMJ.

Core Functionality

646bf2c Remove MSG_TRUNC logging
293a677 Removed unused struct HaveState
96d0c12 Fixed missing reject reason types (logging). (#2436)
8941831 Changed cond notification naming. Added and used new sync utilities. (#2429)
eae2749 Update TSBPD base time and clock drift on an idle connection. (#2408)
e50ccde Applied clang-format on CPacket.
666ee63 Fixed outlen_p value in EVP_AES_EcbCipher (crysprOpenSSL_EVP_AES_EcbCipher).
f0b2003 Minor CSndBuffer edits. (#2430)
fe98265 CCryptoControl: Partially removed dependency on CUDT. (#2424)
5ae3b00 Removed unused struct FByOldestActive.
7f12138 Initialize CRYSPR in startup() (#2425)
1b30573 Remove unused variable
e48f43d Fixed SRT_ASSERT definition for non-MSVC compilers (#2423).
ee398a3 Small refactor of the crysprFallback_MsEncrypt
618db39 Fixed byteRcvLoss stats
088e27d Create MbedTLS ctx in PBKDF (#2413)
ced76c7 Increased CUnitQueue block allocation speed. Allocates 128 additional units at the start and every time 90% of units are taken. Previously was allocating only 32 units.
a51ec39 Protect CUnit::m_iFlag from data race using an atomic. Refactored common allocation code CUnitQueue::allocateEntry(..).
b5055db Minor clean-up fix rethrowing an exception.
c3fed9c CRcvQueue tracks IP version instead of CUnitQueue
830c599 CUnitQueue::increase(): Do not adjust taken units. The adjustment was intended to patch issues around m_iCount. Those are not present anymore.
cdafca5 Fix sendBroadcast() message length (#2391).
c5f613e Added OpenSSL EVP API support to HaiCrypt (#2333).
5070037 Cookie contest log msg downgraded to Debug
bb6c493 Rethrow an exception without copying it.
c9e48bd Made CRcvQueue::m_counter atomic to avoid data race. Used for setting the RcvQueue:: worker thread name for logging.
6a489e1 Fixed suspicious (HCRYPT_CTX_F_ENCRYPT & ctx->flags ? ..).
2de9e6e Explicitly compare with an enum type. Fixes #2374.
61170ad Fixed local variable 'i' hiding previous local declaration. Fixes #2371.
88aab43 Fixed 'false' value implicitly casting to an integer. Handle handling failure of fillHsExtKMRSP(..). Fixed some other minor conversion warnings. Fixes #2372.

Sample Applications and Scripts

0bc3b03 List contributors using the changelog generation script (#2456)

Unit Tests

3ed8bfa Fixed a typo: cypto -> crypto.
086dfe9 Fixed TestIPv6.v6_calls_v4
0153f69 Minor fix for Bonding.CloseGroupAndSocket (#2406).
04407e6 SyncRandom.GenRandomInt: Increase tolerance (#2385)

Build Scripts (CMake, etc.)

95d82c4 Only install headers if CMAKE_INSTALL_INCLUDEDIR is available
91a4373 Only install pkg-config files if CMAKE_INSTALL_LIBDIR is available
3709471 Use the default TARGETS installation folder when possible
286b43e Don't force RUNTIME targets in CMAKE_INSTALL_BINDIR
3170590 Install scripts/srt-ffplay in the bin directory
ea84103 Always use GNUInstallDirs
bb6fede Add variable telling if DESTINATION is needed with install()
6b70452 Add 'ENABLE BONDING' option to Windows PowerShell build script (#2398).

Documentation

90d2f07 Fixed the version to 1.5.1 and did some minor changes to build options summary table.
82f742b Added Packet Managers section to Build Instructions.
286b3aa Updated the Debian badge in ReadMe
89e11eb Fixed Time Access link in API-functions.
5812e1f Fixed a typo in srt_epoll_uwait

v1.5.1-rc.0

Release Notes

API / ABI

API/ABI version: 1.5.

Improvements and Bug Fixes

• PR #2333: Added support for OpenSSL EVP API (enable using the -DUSE_ENCLIB=openssl-evp CMake build option).
• PR #2408: Improved timing on an idle connection (update TSBPD base time and clock drift on an idle connection).
• PR #2384, #2395. Data race fixes (CRcvQueue).
• PR #2405: Receiver performance improvements (CUnitQueue).
• PR #2416: Fixed byteRcvLoss stats.
• PR #2413, #2425: Fixed data races in Crypto Library (mbedTLS).
• PR #2391: Fix sendBroadcast() message length.
• PR #2398: Add ENABLE BONDING option to Windows PowerShell build script.
• PR #2451: Fixed mingw-w64 DLL build (mingw-w64 supports __declspec(dllexport)).

Changelog

Click to expand/collapse

API/ABI

453b276 SRT version raised to 1.5.1.
ec52c45 Export functions in mingw-w64 when building as a DLL (#2451).
daf838e Renamed macro MN to SRT_EMN, MJ to SRT_EMJ.

Core Functionality

646bf2c Remove MSG_TRUNC logging
293a677 Removed unused struct HaveState
96d0c12 Fixed missing reject reason types (logging). (#2436)
8941831 Changed cond notification naming. Added and used new sync utilities. (#2429)
eae2749 Update TSBPD base time and clock drift on an idle connection. (#2408)
e50ccde Applied clang-format on CPacket.
666ee63 Fixed outlen_p value in EVP_AES_EcbCipher (crysprOpenSSL_EVP_AES_EcbCipher).
f0b2003 Minor CSndBuffer edits. (#2430)
fe98265 CCryptoControl: Partially removed dependency on CUDT. (#2424)
5ae3b00 Removed unused struct FByOldestActive.
7f12138 Initialize CRYSPR in startup() (#2425)
1b30573 Remove unused variable
e48f43d Fixed SRT_ASSERT definition for non-MSVC compilers (#2423).
ee398a3 Small refactor of the crysprFallback_MsEncrypt
618db39 Fixed byteRcvLoss stats
088e27d Create MbedTLS ctx in PBKDF (#2413)
ced76c7 Increased CUnitQueue block allocation speed. Allocates 128 additional units at the start and every time 90% of units are taken. Previously was allocating only 32 units.
a51ec39 Protect CUnit::m_iFlag from data race using an atomic. Refactored common allocation code CUnitQueue::allocateEntry(..).
b5055db Minor clean-up fix rethrowing an exception.
c3fed9c CRcvQueue tracks IP version instead of CUnitQueue
830c599 CUnitQueue::increase(): Do not adjust taken units. The adjustment was intended to patch issues around m_iCount. Those are not present anymore.
cdafca5 Fix sendBroadcast() message length (#2391).
c5f613e Added OpenSSL EVP API support to HaiCrypt (#2333).
5070037 Cookie contest log msg downgraded to Debug
bb6c493 Rethrow an exception without copying it.
c9e48bd Made CRcvQueue::m_counter atomic to avoid data race. Used for setting the RcvQueue:: worker thread name for logging.
6a489e1 Fixed suspicious (HCRYPT_CTX_F_ENCRYPT & ctx->flags ? ..).
2de9e6e Explicitly compare with an enum type. Fixes #2374.
61170ad Fixed local variable 'i' hiding previous local declaration. Fixes #2371.
88aab43 Fixed 'false' value implicitly casting to an integer. Handle handling failure of fillHsExtKMRSP(..). Fixed some other minor conversion warnings. Fixes #2372.

Unit Tests

3ed8bfa Fixed a typo: cypto -> crypto.
086dfe9 Fixed TestIPv6.v6_calls_v4
0153f69 Minor fix for Bonding.CloseGroupAndSocket (#2406).
04407e6 SyncRandom.GenRandomInt: Increase tolerance (#2385)

Build Scripts (CMake, etc.)

95d82c4 Only install headers if CMAKE_INSTALL_INCLUDEDIR is available
91a4373 Only install pkg-config files if CMAKE_INSTALL_LIBDIR is available
3709471 Use the default TARGETS installation folder when possible
286b43e Don't force RUNTIME targets in CMAKE_INSTALL_BINDIR
3170590 Install scripts/srt-ffplay in the bin directory
ea84103 Always use GNUInstallDirs
bb6fede Add variable telling if DESTINATION is needed with install()
6b70452 Add 'ENABLE BONDING' option to Windows PowerShell build script (#2398).

Documentation

286b3aa Updated the Debian badge in ReadMe
89e11eb Fixed Time Access link in API-functions.
5812e1f Fixed a typo in srt_epoll_uwait

v1.5.0

Release Notes

API / ABI / Integration Changes

API/ABI version: 1.5.

• PR #2316: Renamed ENABLE_EXPERIMENTAL_BONDING build option to ENABLE_BONDING. With the Connection Bonding feature disabled, bonding API functions are present, but return an error.

• PR #2081: Added the SRTO_GROUPMINSTABLETIMEO socket option which defines the minimum stability timeout for all the active member sockets in a Main/Backup group.

• PR #2312: Deprecated srt_rejectreason_msg[]. The API function srt_rejectreason_str() should be used instead.

• PR #2271: Fixed missing extern "C" for the srt_rejectreason_str() API function.

• PR #2152: Use SOCKET type for any WIN32 environment.

• PR #2176: Fixed handshake cookie validation by the listener for rendezvous connections.

New Features and Improvements

1. Connection Bonding is no Longer Experimental

While this feature remains disabled by default, you can use the ENABLE_BONDING=ON build option to activate it.

Similar to SMPTE-2022-7 over managed networks, Connection Bonding adds seamless stream protection and hitless failover to the SRT protocol. This technology relies on more than one IP network path to prevent disruption to live video streams in the event of network congestion or outages, maintaining continuity of service.

This is accomplished using the socket groups introduced in the current release. The general concept of socket groups means having a group that contains multiple sockets, where one operation for sending one data signal is applied to the group. Single sockets inside the group will take over this operation and do what is necessary to deliver the signal to the receiver.

Two modes are supported:

• Broadcast - In Broadcast mode, data is sent redundantly over all the member links in a group. If one of the links fails or experiences network jitter and/or packet loss, the missing data will be received over another link in the group. Redundant packets are simply discarded at the receiver side.

• Main/Backup - In Main/Backup mode, only one (main) link at a time is used for data transmission while other (backup) connections are on standby to ensure the transmission will continue if the main link fails. The goal of Main/Backup mode is to identify a potential link break before it happens, thus providing a time window within which to seamlessly switch to one of the backup links.

Improvements and bug fixes since v1.4.4:

• PR #2260: Use the latest available input rate estimate from the main link for the newly activated backup link when the main one breaks (Main/Backup mode). This improvement is applied when maximum bandwidth is configured to operate in INPUTBW_ESTIMATED mode.

• PR #2316: Added the SRTO_GROUPCONNECT socket option. When set on a listener socket, the socket is allowed to accept incoming group connections.

• PR #2316: Added the SRTO_GROUPTYPE read-only socket option which returns the group type declared in the incoming connection.

• PR #2081: Added the SRTO_GROUPMINSTABLETIMEO socket option which defines the minimum stability timeout for all active member sockets in a Main/Backup group.

• PR #2257: Fixed the loss of initial packets by a group in Message mode with a message consisting of several packets.

• PR #2258: Fixed packet sequence number tracking in group sender (Broadcast mode).

• PR #2245: Improved group read-readiness update on sending an acknowledgment packet.

2. New Implementation of the Receiver Buffer with Behavior and Code Improvements

• PR #1964: Enabled by default with theENABLE_NEW_RCVBUFFER=ON build option. Note that while it is still possible to fall back to the old receiver buffer implementation, eventually the new implementation will be the only one available.

  • Improved memory management to better work with shared objects and fixed const-correctness violations to avoid unnecessary object state changes.

  • It is now possible to read packets from the receiver buffer without waiting for them to be acknowledged. The SRT latency can now be less than the interval of sending acknowledgments of 10 ms. See #1429.

  • Better handling of sender’s drop requests. The current implementation will mark packets as “dropped by sender”, and when the time comes those packets will be dropped by the TSBPD mechanism at the receiver side.

  • Out-of-order reading is now supported for the file transmission use case.

  • In the case of file transmission in message mode, the notification about the readiness of reading a message consisting of several packets is now sent once all the packets forming this message are received and ready to be read.

3. Packet Pacing and Live Congestion Control Improvements

• PR #2185: Operate with either the time when the packets are submitted to the SRT library (on the sender), or the source time, not both. If provided, source time is preferred over submitted time. Previously, submitted time was used by the Too-Late Packet Drop mechanism when dropping a message by TTL and calculating sender buffer timespan statistics (msSndBuf). If provided, source time was used as a data packet timestamp.

• PR #2180: Prioritize sending original packets over retransmissions in live streaming configuration. For file transmission configuration, the order of sending remains the same: retransmitted over original packets.

• PR #2232: Fixed issue #713 where the Too-Late Packet Drop mechanism may violate the configured maximum bandwidth, which limits the bandwidth usage by SRT.

• PR #2230: Use sender buffer delay (tsNow - tsOldestPacket) in Too-Late Packet Drop mechanism instead of timespan between the latest submitted packet and the oldest one present at the sender buffer (tsLatestPacket - tsOldestPacket).

• PR #2068: Drop a message based on Time to Live (TTL) even if it hasn’t been sent. A TTL value, in milliseconds, can be provided when submitting a message to SRT via the srt_sendmsg2(..., msgctrl.msgttl) function. If the TTL since a message has been submitted to SRT for sending is expired, this message will be discarded even if it hasn’t been sent yet. Previously, a message was always sent (at least once) and TTL affected further retransmissions only.

• PR #2229: The code related to forming an original data packet for sending has been moved to a separate function (packUniqueData(..)).

4. Other Improvements

• PRs #2324, #2125, #2301: Resolved symbol name leakage related issues. Placed sender and receiver buffer implementations, CEpoll, CEPollDesc, CIPAddress, CInfoBlock, CMD5 and other functions under the srt namespace.

• PRs #2241, #2208, #2210: Improved the condition for smoothed RTT recalculation in the case of bidirectional transmission. Fixed the issue introduced in RTT estimation when adding atomic types in PR #1863 (affected version: v1.4.4).

Important Bug Fixes

• PR #2159: Use Mersenne Twister engine with C++11 instead of std::random_device. Fixed the probability calculation of getting the maximum value for the default (C++03) rand().

• PR #1913: Replaced the global CUDTUnited object with static local one.

• PR #2277: Check if CryptoControl exists in craftKmResponse(). Fixes crash #2231.

• PRs #2291, #2292: Fixed volatile keyword usage. Prefer the usage of std::atomic where possible.

• PR #2223:...

v1.5.0-rc.0

Release Candidate Notes

API/ABI/Integration Changes

API/ABI version: 1.5​.

• PR #2316: ENABLE_BONDING build option (instead of ENABLE_EXPERIMENTAL_BONDING). Dummy bonding API version if disabled (default).
• PR #2312: Deprecated srt_rejectreason_msg[].
• PR #2152: Use the SOCKET type for any WIN32 environment.
• PR #2271: Fixed missing extern "C" for API function srt_rejectreason_str(..).
• PR #2176: Fixed handshake cookie validation by the listener (rendezvous connection).
• PR #2081: Added group socket option SRTO_GROUPMINSTABLETIMEO.

Improvements

• PR #2324: Resolved symbol name leakage / polution (placed inside the srt namespace).
• PR #2260: Source rate estimate: ignore outdated samples. Derive source rate estimate from active member (Main/Backup groups).
• PR #2241: Improved the condition for smoothed RTT recalculation with bidirectional transmission.
• PR #1260: Prioritize original packets over retransmissions in live streaming configuration (SRT Sender).
• PR #2232: Fix MaxBW limitation #713. Don't reschedule sending (keep pacing) on SND drop, NAK received, retransmission timeout. Added pacing amendment after sending probing packets.
• PR #2230: Use SND buffer delay for TL Packet Drop instead of the timespan between the first and the last packet in the buffer.
• PR #1950: Fix GC stop handling.
• PR #2068: Drop msg by TTL even if hasn't ever been sent.
• PR #2185: SND buffer: operate either origin or source time, not both.
• PR #1964: New receiver buffer implementation (enabled by default with ENABLE_NEW_RCVBUFFER=ON build option).
• PR #2159: Use Mersenne Twister engine with C++11 instead of the std::random_device. Fixed max value probability for the default (C++03) rand().
• PR #1913: Replaced global CUDTUnited with static local variable.

Fixed Issues Highlights

• PR #2208, #2210: Fixed RTT estimation for bidirectional transmission.
• PR #2231: Check if CryptoControl exists in craftKmResponse. Fixes crash #2231.
• PR #2125: Moved SND and RCV buffers into the 'srt' namespace (Symbol Name Leakage/Polution #1924).
• PR #2301: Fix name conflict with md5 functions (Symbol Name Leakage/Polution #1924).
• PR #2291, #2292: Fix volatile keyword usage. Prefer using std::atomic where possible.
• PR #2258: Fix extraction seq with scheduling seq in group.
• PR #2257: Fix unrecoverable initial packets lose in group message mode.
• PR #2245: Improved group readiness updating in sendCtrlAck(). Group::updateReadState() support out-of-order messages.
• PR #2223: fixed missing m_RcvBufferLock in processCtrlDropReq().
• PR #2214: Fixed RCV TL drop of packets dropped by SND.
• PR #2195: Fix consistency of packet seqno in CRcvLossList.
• PR #2197: Fix deadlock introduced by CUDTGroup::setOpt().
• PR #2196: fix CRcvLossList::m_iTail not reset to -1.
• PR #2162: Fix UDP RCVBUF and SNDBUF socket options on Solaris.
• PR #2168: Changed lock order in bstats(..) API functions to access statistics.

Build

• PR #2148: Support NDK r23, OpenSSL v3.
• PR #2319, #2325: Fixed building sendfile and recvfile examples. They don't need C++11.

Docs

• PR #2311: Added note on SRT versioning.

Acknowledgements

Kudos for valuable contribution in the release to Guangqing Chen, Zhili Zhao.

Changelog

Click to expand/collapse

API

64d7f69 SRT version raised to 1.5.0.
c6b95f5 Removed unused srt_group_configure API function.
f82b131 Dummy bonding API version if ENABLE_BONDING is disabled.
78b4d65 Drop EXPERIMENTAL from ENABLE_EXPERIMENTAL_BONDING
042df34 Removed balancing and multicast group types (#2323)
94ff168 Removed unused srt_include(..) and srt_exclude(..) API functions for unimplemented externally managed groups.
1c6e1ce Deprecated srt_rejectreason_msg[]. (#2312)
2fb3c9a Use the SOCKET type for any WIN32 environment (#2152)

Core Functionality

990b75a Moved bonding API to the end of srt.h
8901838 Moved CWindow inside the srt namespace.
9761063 Moved sockaddr_any inside the srt namespace.
909c8fb Moved CCache inside the srt namespace.
3fbb917 Placed CHandshake inside the srt namespace.
9ba7e64 Moved CEpoll, CUDTException, etc. into the srt namespace
681b363 Placed CSndLossList and CRcvLossList inside the srt namespace.
e926653 Fixed minor compiler warnings in RCV buffer
9b3e3c1 Fixed ENABLE_HAICRYPT_LOGGING (#2315).
477530f Drop packets in the new RCV buffer by group RCV base (#2207)
69284ce Fixed updating new RCV buffer on ISN change. (#2309)
c76f43d fix CRcvBufferNew::m_iStartSeqNo was not sync in group
48d1364 Added explicit to the Scoped and UniqueLock constructors
992d816 Check if CryptoControl exists in craftKmResponse. Fixes crash #2231.
591e320 Clean up the CUDT processConnectRequest(..) function. Update listener write-ready only after the new connection. Was changed in #1650, but must not be done at all (see #1831).
911de75 Fix name conflict with md5 functions (#2301)
c0da44e FixedArray: use a function to throw an exception.
29d56be Define an iterator for the srt::FixedArray.
1cd39b9 Show RCV buffer timespan instead of TSBPD ready span.
cc62e98 Fixed CRcvBufferNew::strFullnessState(..). Possible null pointer object call after if (m_entries[iLastPos].pUnit). Show the first valid packet instead of the very first position in the buffer.
6c8f0f1 fix volatile in group.h
1f8c1e9 prefer to use std::atomic if available
fec9a40 fix m_iLastSchedSeqNo
8f22c96 CSndUList use notify_one() instead of notify_all()
af6ff16 Downgrade ACKACK reorder log to Note
1dacc2a Remove declaration srt_logger_config again
4c08c3d Move srt_rejectreason_str implementation to srt_c_api
a68683a haicrypt_log.cpp include its header file
f1ec270 Remove duplicated includes
5bf0cc1 Remove redundant ';' after '}'
8d1a722 Applied clang-format on api.h and api.cpp.
ebbac9a fix CRcvBufferNew::m_bPeerRexmitFlag.
024e9c0 Fix extraction seq with scheduling seq in group. (#2258)
3975428 fix unrecoverable initial packets lose in group message mode
fe5debb Source rate estimate: ignore old samples
589d36e Backup group: derive source rate estimate from an active link on idle member activation
daf94c4 Moved source rate estimation logic to CRateEstimator from CSndBuffer
a60d98a Protect RCV buffer access from socket stats
4b70a63 Group option SRTO_GROUPMINSTABLETIMEO (#2081)
f15d300 Fix build for FreeBSD kernel (#2255)
7d77d41 SND Drop Request: ignore if TLPktDrop and TSBPD are enabled to reduce false drops when a packet can still arrive later. It will be dropped anyway as too late.
5adc2db RCV don't drop packets on SND drop request if they already exist in the buffer and can be read (full message is available).
81a31da Fix RCV drop count when dropping on SND DROP REQ. Extended RCVBUF trace logging.
0c5bf7a Decreased SND drop request log level to Debug
c885ed1 Group::updateReadState() support out-of-order messages
650dbe6 Fixed rcvDropTooLateUpTo calls. Broken after merging #2218
8f68f61 refactor Group::recv() base on new rcv buffer to support message mode
ac854f2 Fixed setting the peer rexmit flag on the RCV buffer
409d363 Improved the condition for smoothed_rtt recalculation, bidirectional transmission
08e6482 SND prioritize original packets in live configuration
ef11d26 SND pacing: amendment on probing packets
912463b Fix MaxBW limitation. Don't reschedule sending (keep pacing) on - SND drop, - NAK received - retransmission timeout.
308cd30 Added missing lock to CSndBuffer::readData
5773901 Use SND buffer delay for TL Packet Drop instead of the timespan between the first and the last packet in the buffer.
a31e618 Refactoring: added packUniqueData(..) func
8518558 fixed missing m_RcvBufferLock in processCtrlDropReq()
8c05c70 Fix CRcvBufferNew::dropMessage() (#2222)
24bf666 CRcvBufferNew::dropUpTo() able to drop non-empty units (#2221)
31de8aa Add CRcvBufferNew::dropUnitInPos(..) (#2226)
8afcdbe fix m_iMaxPosInc was not updated in releaseNextFillerEntries()
258167d replace ++ with incPos() in getTimespan_ms()
3d26644 Fixed build with the old RCV buffer
1111cbd Fixed RCV TL drop of packets dropped by SND (#2214)
5f7bc23 Refactored the core stats structure (#2212).
3558cd0 Fix GC stop handling (#1950)
26678fe Fixed the issue with RTT in case of bidirectional transmission introduced when adding atomic types
ae787bf Fix rtt estimate in bidirectional mode
c8cb38f Fix m_GroupOf->updateReadState() in message mode (#2204)
1d808c1 fix recv_WaitForReadReady() return empty
c9a8db7 Fix consistency of packet seqno in CRcvLossList (#2195)
244d2f4 Fix deadlock introduced by CUDTGroup::setOpt()
8b68157 fix CRcvLossList::m_iTail not reset to -1
e5a1179 Fix UDP RCVBUF and SNDBUF on Solaris (#2162).
6ae42c6 Drop msg by TTL even if hasn't ever been sent (#2068)
b99e41c SND buffer: operate either origin or source time, not both.
33c8e49 checkNeedDrop returns the congestion state
5f3cd06 Fixed std::runtime_error usage (use C++03 version instead of C++11) (#2184)
e4a1d2b Fixed read-ready epoll event in stream (file) mode. Only the new RCV buffer (PR #1964) is affected.
ec571a0 Fixed new RCV buffer in stream mode (reading fractional packets)
3c3824f Removed unused SRT_DEBUG_TSBPD_DRIFT
f11b026 fix listener's cookie check (#2176).
276a841 New receiver buffer implementation
3f2945c Reduced nesting of checkBrokenSockets()
c1fdb61 Changed lock order in bstats (#2168)
489c5fc Use Mersenne Twister engine with C++11 instead of the std::random_device. Fixed max value probability for the default (C++03) rand().
86d1eb2 Added CUDT::isRcvReady() with mutex lock. Added CUDT::getAvailRcvBufferSize() function with and without mutex lock.
2031b2c Do not set peerA...