Release 2.1.0

ultravideo · Sep 21, 2022 · 49e6761 · 49e6761
1 parent 81d7e8f
commit 49e6761
Show file tree

Hide file tree

Showing 59 changed files with 618 additions and 571 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,7 +1,4 @@
 # Simple CircleCI configuration for building uvgRTP
-# ToDo: add tests
-
-
 
 version: 2.1
 
@@ -57,10 +54,8 @@ jobs:
       - run:
           name: Run user managed SRTP key example
           command: 'build/examples/srtp_user'
-
-# the SRTP + ZRTP example does not have an end so it is not included
-
       - run:
           name: Run ZRTP + SRTP multistream key example
           command: 'build/examples/zrtp_multistream'
 
+# the SRTP + ZRTP example does not have an end so it is not included
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 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. It features an intuitive and easy-to-use *Application Programming Interface (API)*, built-in support for transporting *Versatile Video Coding (VVC)*, *High Efficiency Video Coding (HEVC)*, *Advanced Video Coding (AVC)* encoded video and Opus encoded audio. uvgRTP also supports *End-to-End Encrypted (E2EE)* media delivery using the combination of *Secure RTP (SRTP)* and ZRTP. According to [our measurements](https://researchportal.tuni.fi/en/publications/open-source-rtp-library-for-high-speed-4k-hevc-video-streaming) uvgRTP is able to reach a goodput of 600 MB/s (4K at 700fps) for HEVC stream when measured in LAN. The CPU usage is relative to the goodput value, and therefore smaller streams have a very small CPU usage.
 
-uvgRTP is licensed under the permissive BSD 2-Clause License. This cross-platform library can be run on both Linux and Windows operating systems. Mac OS is also supported, but the support relies on community contributions. For SRTP/ZRTP support, uvgRTP uses [Crypto++ library](https://www.cryptopp.com/). 
+uvgRTP is licensed under the permissive BSD 2-Clause License. This cross-platform library can be run on both Linux and Windows operating systems. Mac OS is also supported, but the support relies on community contributions. For SRTP/ZRTP support, uvgRTP uses [Crypto++ library](https://www.cryptopp.com/).
 
 Currently supported specifications:
    * [RFC 3550: RTP: A Transport Protocol for Real-Time Applications](https://tools.ietf.org/html/rfc3550)

diff --git a/cmake/ProjectDetails.cmake b/cmake/ProjectDetails.cmake
@@ -1,3 +1,3 @@
-set(uvgrtp_VER 2.0.1)
+set(uvgrtp_VER 2.1.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/Doxyfile b/docs/Doxyfile
@@ -48,7 +48,7 @@ PROJECT_NAME           = uvgRTP
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.0.1
+PROJECT_NUMBER         = 2.1.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -1705,7 +1705,7 @@ FULL_SIDEBAR           = NO
 # Minimum value: 0, maximum value: 20, default value: 4.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-ENUM_VALUES_PER_LINE   = 4
+ENUM_VALUES_PER_LINE   = 1
 
 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
 # to set the initial width (in pixels) of the frame in which the tree is shown.

diff --git a/docs/README.md b/docs/README.md
@@ -21,7 +21,7 @@ Find the full documentation for uvgRTP's public API [here](https://ultravideo.gi
 ### Formats with packetization support:
 * AVC ([RFC 6184](https://tools.ietf.org/html/rfc6184))
 * HEVC ([RFC 7798](https://tools.ietf.org/html/rfc7798))
-* VVC ([Draft](https://tools.ietf.org/html/draft-ietf-avtcore-rtp-vvc-08))
+* VVC ([Draft](https://tools.ietf.org/html/draft-ietf-avtcore-rtp-vvc-18))
 
 ### Formats which don't need packetization (See [RFC 3551](https://www.rfc-editor.org/rfc/rfc3551)):
 * PCMU

diff --git a/docs/html/annotated.html b/docs/html/annotated.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/classes.html b/docs/html/classes.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/classuvgrtp_1_1context-members.html b/docs/html/classuvgrtp_1_1context-members.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/classuvgrtp_1_1context.html b/docs/html/classuvgrtp_1_1context.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/classuvgrtp_1_1media__stream-members.html b/docs/html/classuvgrtp_1_1media__stream-members.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/classuvgrtp_1_1media__stream.html b/docs/html/classuvgrtp_1_1media__stream.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/classuvgrtp_1_1rtcp-members.html b/docs/html/classuvgrtp_1_1rtcp-members.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/classuvgrtp_1_1rtcp.html b/docs/html/classuvgrtp_1_1rtcp.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/classuvgrtp_1_1session-members.html b/docs/html/classuvgrtp_1_1session-members.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/classuvgrtp_1_1session.html b/docs/html/classuvgrtp_1_1session.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/clock_8hh_source.html b/docs/html/clock_8hh_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/context_8hh_source.html b/docs/html/context_8hh_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/dir_9cba3ccb450b89ac6f0c2a18abcbadf0.html b/docs/html/dir_9cba3ccb450b89ac6f0c2a18abcbadf0.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/dir_e3f96ff476f8286b6e150580a2f7bd74.html b/docs/html/dir_e3f96ff476f8286b6e150580a2f7bd74.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/files.html b/docs/html/files.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/frame_8hh_source.html b/docs/html/frame_8hh_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/functions.html b/docs/html/functions.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>

diff --git a/docs/html/globals.html b/docs/html/globals.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>
@@ -76,19 +76,22 @@ <h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
 <li>RCC_CLOCK_RATE&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587faece26b6edb4fc1fe6733b8fec0504b99">util.hh</a></li>
 <li>RCC_DYN_PAYLOAD_TYPE&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587fac758a522806ada30386b262660f30617">util.hh</a></li>
 <li>RCC_FPS_DENOMINATOR&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587fa9e60e576f72eafe6219cd9f0a9615ce9">util.hh</a></li>
-<li>RCC_FPS_ENUMERATOR&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587fa972c50e87b7c6baaa2f3e1babb6b3147">util.hh</a></li>
+<li>RCC_FPS_NUMERATOR&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587fa51034849ac8a4078f0c3b5198b92ab54">util.hh</a></li>
 <li>RCC_MTU_SIZE&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587fa7667fb72b42a2c11991b4879619f9f83">util.hh</a></li>
 <li>RCC_PKT_MAX_DELAY&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587fa5ac1245e18a420489083adddfa97b135">util.hh</a></li>
 <li>RCC_RING_BUFFER_SIZE&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587fa9be732aa645fc09adde5c84a2d07e0f6">util.hh</a></li>
 <li>RCC_UDP_RCV_BUF_SIZE&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587fac52afca9d1a8c24b1a788bc5b8524663">util.hh</a></li>
 <li>RCC_UDP_SND_BUF_SIZE&#160;:&#160;<a class="el" href="util_8hh.html#aa98d9238629e33567e73af0d239e587fad4eba6c62183db35dd4bd0e09ddd107b">util.hh</a></li>
 <li>RCE_FRAGMENT_GENERIC&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa5b0a8dbb22c20ebe8c0711541fb68a79">util.hh</a></li>
-<li>RCE_FRAGMENT_PACING&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa63c559f4a0ea78a5999760fba37019df">util.hh</a></li>
-<li>RCE_FRAMERATE&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa9734027002242ab143aaecc4220b93da">util.hh</a></li>
+<li>RCE_FRAME_RATE&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afae175f37ce4fdc6e7d9e01d200b8d9abc">util.hh</a></li>
 <li>RCE_H26X_DEPENDENCY_ENFORCEMENT&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa121da451fe2a4008cec78ac4642399b2">util.hh</a></li>
-<li>RCE_H26X_DO_NOT_PREPEND_SC&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa134902ca847e3937595d76401633ff36">util.hh</a></li>
 <li>RCE_HOLEPUNCH_KEEPALIVE&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa8e66f45819774772a0156647d3788a95">util.hh</a></li>
+<li>RCE_NO_FLAGS&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa4952226c012292c16fe04477f76e5bcb">util.hh</a></li>
+<li>RCE_NO_H26X_PREPEND_SC&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa877835beb990d36f59f4d9c1d61d2c35">util.hh</a></li>
+<li>RCE_PACE_FRAGMENT_SENDING&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa836063a6ef3da262d0805cf1571ab35c">util.hh</a></li>
+<li>RCE_RECEIVE_ONLY&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afaf89817eda89d32c43e18ed0645ac4d73">util.hh</a></li>
 <li>RCE_RTCP&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afab1342138e5af3f03d6eaf1378382bf3d">util.hh</a></li>
+<li>RCE_SEND_ONLY&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa6bb67e1962af60c05c6062fb6f1df374">util.hh</a></li>
 <li>RCE_SRTP&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afaf235cba606675b9c38284ee1a491696b">util.hh</a></li>
 <li>RCE_SRTP_AUTHENTICATE_RTP&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afa820625b96886d955bc42e0cbc52cdd1e">util.hh</a></li>
 <li>RCE_SRTP_KEYSIZE_192&#160;:&#160;<a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2afaedeac11cc80833b61b51ae32f787db73">util.hh</a></li>
@@ -144,7 +147,6 @@ <h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
 <li>RTP_NOT_FOUND&#160;:&#160;<a class="el" href="util_8hh.html#aa6dc3f3578923d1afc40045e4cbe387ba0a18f9856d2dd5890bb6ec25e4acf631">util.hh</a></li>
 <li>RTP_NOT_INITIALIZED&#160;:&#160;<a class="el" href="util_8hh.html#aa6dc3f3578923d1afc40045e4cbe387ba32d67254c4da35568e7007ec3825f98a">util.hh</a></li>
 <li>RTP_NOT_SUPPORTED&#160;:&#160;<a class="el" href="util_8hh.html#aa6dc3f3578923d1afc40045e4cbe387ba756d5cd372b045f069a493ed2f2cfa22">util.hh</a></li>
-<li>RTP_OBSOLETE&#160;:&#160;<a class="el" href="util_8hh.html#af03a75996471fc531742cd640c7caf2dac44db79708ff5ea9f8abe6d427928629">util.hh</a></li>
 <li>RTP_OK&#160;:&#160;<a class="el" href="util_8hh.html#aa6dc3f3578923d1afc40045e4cbe387ba0d701531b2bb1c027f5e5bcc64ed29e1">util.hh</a></li>
 <li>RTP_RECV_ERROR&#160;:&#160;<a class="el" href="util_8hh.html#aa6dc3f3578923d1afc40045e4cbe387baa499befa487c22503360adffc590f33b">util.hh</a></li>
 <li>RTP_SEND_ERROR&#160;:&#160;<a class="el" href="util_8hh.html#aa6dc3f3578923d1afc40045e4cbe387ba6c47e86944dbed4d33531236a6e28079">util.hh</a></li>

diff --git a/docs/html/globals_enum.html b/docs/html/globals_enum.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.0.1</span>
+   <div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.0</span>
    </div>
    <div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
   </td>