Release 2.2.0

ultravideo · Mar 13, 2023 · b6f7030 · b6f7030
1 parent 6d23229
commit b6f7030
Show file tree

Hide file tree

Showing 61 changed files with 1,420 additions and 1,063 deletions.
diff --git a/cmake/ProjectDetails.cmake b/cmake/ProjectDetails.cmake
@@ -1,3 +1,3 @@
-set(uvgrtp_VER 2.1.2)
+set(uvgrtp_VER 2.2.0)
 set(uvgrtp_DESCR "uvgRTP is an Real-Time Transport Protocol (RTP) library written in C++ with a focus on simple to use and high-efficiency media delivery over the internet")
 set(uvgrtp_URL "https://github.com/ultravideo/uvgRTP")
diff --git a/docs/html/annotated.html b/docs/html/annotated.html
@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
-<meta name="generator" content="Doxygen 1.9.5"/>
+<meta name="generator" content="Doxygen 1.9.6"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>uvgRTP: Class List</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.2</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.2.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>
@@ -30,7 +30,7 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.9.5 -->
+<!-- Generated by Doxygen 1.9.6 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -96,7 +96,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
 </small></address>
 </body>
 </html>
diff --git a/docs/html/classes.html b/docs/html/classes.html
@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
-<meta name="generator" content="Doxygen 1.9.5"/>
+<meta name="generator" content="Doxygen 1.9.6"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>uvgRTP: Class Index</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.2</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.2.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>
@@ -30,7 +30,7 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.9.5 -->
+<!-- Generated by Doxygen 1.9.6 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -91,7 +91,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
 </small></address>
 </body>
 </html>
diff --git a/docs/html/classuvgrtp_1_1context-members.html b/docs/html/classuvgrtp_1_1context-members.html
@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
-<meta name="generator" content="Doxygen 1.9.5"/>
+<meta name="generator" content="Doxygen 1.9.6"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>uvgRTP: Member List</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.2</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.2.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>
@@ -30,7 +30,7 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.9.5 -->
+<!-- Generated by Doxygen 1.9.6 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -89,7 +89,7 @@
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
 </small></address>
 </body>
 </html>
diff --git a/docs/html/classuvgrtp_1_1context.html b/docs/html/classuvgrtp_1_1context.html
@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
-<meta name="generator" content="Doxygen 1.9.5"/>
+<meta name="generator" content="Doxygen 1.9.6"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>uvgRTP: uvgrtp::context Class Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.2</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.2.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>
@@ -30,7 +30,7 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.9.5 -->
+<!-- Generated by Doxygen 1.9.6 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -89,26 +89,26 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr class="memitem:a98be18c2848404549cfadf910ba1573a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvgrtp_1_1context.html#a98be18c2848404549cfadf910ba1573a">context</a> ()</td></tr>
-<tr class="memdesc:a98be18c2848404549cfadf910ba1573a"><td class="mdescLeft">&#160;</td><td class="mdescRight">RTP context constructor.  <a href="classuvgrtp_1_1context.html#a98be18c2848404549cfadf910ba1573a">More...</a><br /></td></tr>
+<tr class="memdesc:a98be18c2848404549cfadf910ba1573a"><td class="mdescLeft">&#160;</td><td class="mdescRight">RTP context constructor.  <br /></td></tr>
 <tr class="separator:a98be18c2848404549cfadf910ba1573a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a652a201ae11685961267455ab823eb60"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvgrtp_1_1context.html#a652a201ae11685961267455ab823eb60">~context</a> ()</td></tr>
-<tr class="memdesc:a652a201ae11685961267455ab823eb60"><td class="mdescLeft">&#160;</td><td class="mdescRight">RTP context destructor.  <a href="classuvgrtp_1_1context.html#a652a201ae11685961267455ab823eb60">More...</a><br /></td></tr>
+<tr class="memdesc:a652a201ae11685961267455ab823eb60"><td class="mdescLeft">&#160;</td><td class="mdescRight">RTP context destructor.  <br /></td></tr>
 <tr class="separator:a652a201ae11685961267455ab823eb60"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a81b2dc23ebf64d1153410376503eccb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvgrtp_1_1session.html">uvgrtp::session</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvgrtp_1_1context.html#a81b2dc23ebf64d1153410376503eccb4">create_session</a> (std::string address)</td></tr>
-<tr class="memdesc:a81b2dc23ebf64d1153410376503eccb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new RTP session.  <a href="classuvgrtp_1_1context.html#a81b2dc23ebf64d1153410376503eccb4">More...</a><br /></td></tr>
+<tr class="memdesc:a81b2dc23ebf64d1153410376503eccb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new RTP session.  <br /></td></tr>
 <tr class="separator:a81b2dc23ebf64d1153410376503eccb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a7699c9df53e8e7380d755f374d6fc2ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvgrtp_1_1session.html">uvgrtp::session</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvgrtp_1_1context.html#a7699c9df53e8e7380d755f374d6fc2ce">create_session</a> (std::string remote_addr, std::string local_addr)</td></tr>
-<tr class="memdesc:a7699c9df53e8e7380d755f374d6fc2ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new RTP session.  <a href="classuvgrtp_1_1context.html#a7699c9df53e8e7380d755f374d6fc2ce">More...</a><br /></td></tr>
+<tr class="memdesc:a7699c9df53e8e7380d755f374d6fc2ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new RTP session.  <br /></td></tr>
 <tr class="separator:a7699c9df53e8e7380d755f374d6fc2ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a61daf2f3cdcdf2542ee997ab6de5efa9"><td class="memItemLeft" align="right" valign="top">rtp_error_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvgrtp_1_1context.html#a61daf2f3cdcdf2542ee997ab6de5efa9">destroy_session</a> (<a class="el" href="classuvgrtp_1_1session.html">uvgrtp::session</a> *<a class="el" href="classuvgrtp_1_1session.html">session</a>)</td></tr>
-<tr class="memdesc:a61daf2f3cdcdf2542ee997ab6de5efa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy RTP session and all of its media streams.  <a href="classuvgrtp_1_1context.html#a61daf2f3cdcdf2542ee997ab6de5efa9">More...</a><br /></td></tr>
+<tr class="memdesc:a61daf2f3cdcdf2542ee997ab6de5efa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy RTP session and all of its media streams.  <br /></td></tr>
 <tr class="separator:a61daf2f3cdcdf2542ee997ab6de5efa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0ddad3f0a78b6a4b13f2b8fdd15c9087"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvgrtp_1_1context.html#a0ddad3f0a78b6a4b13f2b8fdd15c9087">crypto_enabled</a> () const</td></tr>
-<tr class="memdesc:a0ddad3f0a78b6a4b13f2b8fdd15c9087"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has Crypto++ been included in uvgRTP library.  <a href="classuvgrtp_1_1context.html#a0ddad3f0a78b6a4b13f2b8fdd15c9087">More...</a><br /></td></tr>
+<tr class="memdesc:a0ddad3f0a78b6a4b13f2b8fdd15c9087"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has Crypto++ been included in uvgRTP library.  <br /></td></tr>
 <tr class="separator:a0ddad3f0a78b6a4b13f2b8fdd15c9087"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p >Provides CNAME isolation and can be used to create <a class="el" href="classuvgrtp_1_1session.html" title="Provides ZRTP synchronization and can be used to create uvgrtp::media_stream objects.">uvgrtp::session</a> objects. </p>
+<div class="textblock"><p>Provides CNAME isolation and can be used to create <a class="el" href="classuvgrtp_1_1session.html" title="Provides ZRTP synchronization and can be used to create uvgrtp::media_stream objects.">uvgrtp::session</a> objects. </p>
 
 <p class="definition">Definition at line <a class="el" href="context_8hh_source.html#l00016">16</a> of file <a class="el" href="context_8hh_source.html">context.hh</a>.</p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
@@ -128,7 +128,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a98be18c2848404549cfadf91
 </div><div class="memdoc">
 
 <p>RTP context constructor. </p>
-<p >Most of the time one RTP context per application is enough. If CNAME namespace isolation is required, multiple context objects can be created. </p>
+<p>Most of the time one RTP context per application is enough. If CNAME namespace isolation is required, multiple context objects can be created. </p>
 
 </div>
 </div>
@@ -148,7 +148,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a652a201ae11685961267455a
 </div><div class="memdoc">
 
 <p>RTP context destructor. </p>
-<p >This does not destroy active sessions. They must be destroyed manually by calling <a class="el" href="classuvgrtp_1_1context.html#a61daf2f3cdcdf2542ee997ab6de5efa9" title="Destroy RTP session and all of its media streams.">uvgrtp::context::destroy_session()</a> </p>
+<p>This does not destroy active sessions. They must be destroyed manually by calling <a class="el" href="classuvgrtp_1_1context.html#a61daf2f3cdcdf2542ee997ab6de5efa9" title="Destroy RTP session and all of its media streams.">uvgrtp::context::destroy_session()</a> </p>
 
 </div>
 </div>
@@ -214,7 +214,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7699c9df53e8e7380d755f37
 </div><div class="memdoc">
 
 <p>Create a new RTP session. </p>
-<p >If UDP holepunching should be utilized, in addition to remote IP address, the caller must also provide local IP address where uvgRTP should bind itself to. If you are using uvgRTP for unidirectional streaming, please take a look at <a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa8e66f45819774772a0156647d3788a95">RCE_HOLEPUNCH_KEEPALIVE</a></p>
+<p>If UDP holepunching should be utilized, in addition to remote IP address, the caller must also provide local IP address where uvgRTP should bind itself to. If you are using uvgRTP for unidirectional streaming, please take a look at <a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa8e66f45819774772a0156647d3788a95">RCE_HOLEPUNCH_KEEPALIVE</a></p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">remote_addr</td><td>IPv4 address of the remote participant </td></tr>
@@ -299,7 +299,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a61daf2f3cdcdf2542ee997ab
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
 </small></address>
 </body>
 </html>
diff --git a/docs/html/classuvgrtp_1_1media__stream-members.html b/docs/html/classuvgrtp_1_1media__stream-members.html
@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
-<meta name="generator" content="Doxygen 1.9.5"/>
+<meta name="generator" content="Doxygen 1.9.6"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>uvgRTP: Member List</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.2</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.2.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>
@@ -30,7 +30,7 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.9.5 -->
+<!-- Generated by Doxygen 1.9.6 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -90,11 +90,13 @@
   <tr class="odd"><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html#a157e9973d92b65e82914d4028690c770">push_frame</a>(uint8_t *data, size_t data_len, int rtp_flags)</td><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html#a068a0963e06f789b4e4310a45cbe4409">push_frame</a>(std::unique_ptr&lt; uint8_t[]&gt; data, size_t data_len, int rtp_flags)</td><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html#ac0cb1cf34b639c9ba71b047b3ba26d22">push_frame</a>(uint8_t *data, size_t data_len, uint32_t ts, int rtp_flags)</td><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html#abe9099254c6bf16f255f5f50441ec9d2">push_frame</a>(std::unique_ptr&lt; uint8_t[]&gt; data, size_t data_len, uint32_t ts, int rtp_flags)</td><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html#a5577c57f1bdd5b888aa4e8c4f939eba7">push_frame</a>(uint8_t *data, size_t data_len, uint32_t ts, uint64_t ntp_ts, int rtp_flags)</td><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html#abe9099254c6bf16f255f5f50441ec9d2">push_frame</a>(std::unique_ptr&lt; uint8_t[]&gt; data, size_t data_len, uint32_t ts, int rtp_flags)</td><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html#a56d2a209b2647d0f3ee7948e8cf45438">push_frame</a>(std::unique_ptr&lt; uint8_t[]&gt; data, size_t data_len, uint32_t ts, uint64_t ntp_ts, int rtp_flags)</td><td class="entry"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
 </small></address>
 </body>
 </html>