docs: Small updates in sphinx docs

roc-streaming · Aug 13, 2024 · 9fdac74 · 9fdac74
1 parent 6f10045
commit 9fdac74
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 152 deletions.
diff --git a/docs/sphinx/about_project/licensing.rst b/docs/sphinx/about_project/licensing.rst
@@ -5,4 +5,9 @@ Roc Toolkit source code is licensed under `MPL-2.0 <https://www.mozilla.org/en-U
 
 You may also want to check licenses of the :doc:`dependencies </building/dependencies>`. If you can't use dependencies with strong copyleft licenses like GPL, you may need to disable them at build time.
 
-In particular, if Roc Toolkit is built with OpenFEC support enabled, it must be distributed under a license compatible with CeCCIL-C (LGPL-like license), if LDPC-Staircase codec is disabled, or CeCCIL (GPL-like license), if LDPC-Staircase codec is enabled. Refer to `OpenFEC website <http://openfec.org/patents.html>`_ for further details.
+OpenFEC
+=======
+
+OpenFEC is an optional but very useful dependency that allows to restore lost packets. OpenFEC source code has several licenses. Most of the code is licensed under CeCCIL-C, which is LGPL-like. LDPC-Staircase codec, however, is licensed under CeCCIL, a stricter GPL-like license. There are also portions under BSD-like and CC BY-SA licenses that may require attribution.
+
+If you can't fulfill CeCCIL requirements, you can build OpenFEC with LDPC-Staircase disabled. When using `our fork <https://github.com/roc-streaming/openfec>`_, you can pass ``-DOF_USE_LDPC_STAIRCASE_CODEC=OFF`` option to cmake. Alternatively, you can disable OpenFEC dependency altogether by passing ``--disable-openfec`` option to scons, but then you won't have loss recovery.
diff --git a/docs/sphinx/about_project/sponsors.rst b/docs/sphinx/about_project/sponsors.rst
@@ -45,8 +45,13 @@ This section lists features which development was sponsored by companies, indivi
      - Source
      - Feature
 
+   * - Aug 2024
+     - 0.5.0
+     - contract work
+     - Adaptive latency support.
+
    * - Jun 2024
-     -
+     - 0.5.0
      - contract work
      - Simple PLC & support for registering custom PLC in C API.
 

diff --git a/docs/sphinx/building/dependencies.rst b/docs/sphinx/building/dependencies.rst
@@ -60,6 +60,7 @@ Runtime dependencies
 ====================
 
 .. list-table::
+   :widths: 10 25 30 25
 
    * - **dependency**
      - **version**
@@ -71,6 +72,11 @@ Runtime dependencies
      - MIT
      - only required on pre-C11 compilers
 
+   * - `libsndfile <https://libsndfile.github.io/libsndfile/>`_
+     - >= 1.0.26
+     - LGPL
+     - optional, used for audio I/O
+
    * - `libunwind <https://www.nongnu.org/libunwind/>`_
      - >= 1.2.1
      - X11
@@ -81,9 +87,9 @@ Runtime dependencies
      - MIT
      - required
 
-   * - `OpenFEC <http://openfec.org>`_
+   * - `OpenFEC <https://openfec.inrialpes.fr>`_
      - >= 1.4.2 (recommended to use `our fork <https://github.com/roc-streaming/openfec>`_)
-     - CeCCIL-C / CeCCIL
+     - CeCCIL-C (LGPL-like) + CeCCIL (GPL-like, only for LDPC-Staircase) + BSD-like + CC BY-SA
      - optional, used for FECFRAME support
 
    * - `OpenSSL <https://www.openssl.org/>`_
@@ -101,11 +107,6 @@ Runtime dependencies
      - LGPL
      - optional, used for audio I/O
 
-   * - `libsndfile <https://libsndfile.github.io/libsndfile/>`_
-     - >= 1.0.26
-     - LGPL
-     - optional, used for audio I/O
-
    * - `SpeexDSP <https://github.com/xiph/speexdsp>`_
      - >= 1.2beta3
      - BSD

diff --git a/docs/sphinx/development.rst b/docs/sphinx/development.rst
@@ -5,7 +5,6 @@ Development
    :maxdepth: 1
 
    development/changelog
-   development/history
    development/roadmap
    development/contribution_guidelines
    development/coding_guidelines

diff --git a/docs/sphinx/development/history.rst b/docs/sphinx/development/history.rst
diff --git a/docs/sphinx/development/roadmap.rst b/docs/sphinx/development/roadmap.rst
@@ -20,12 +20,11 @@ Basic features
 Advanced features
 =================
 
-- |:white_large_square:| End-to-end latency estimation
-- |:white_large_square:| Dynamic latency adjustment (requires RTCP)
-- |:white_large_square:| Dynamic adjustment of FEC block size (requires RTCP)
-- |:white_large_square:| Dynamic adjustment of FEC code rate (requires RTCP and XRs from `RFC 5725 <https://tools.ietf.org/html/rfc5725>`_)
-- |:white_large_square:| Dynamic audio bitrate adjustment
-- |:white_large_square:| Dynamic payload type switch
+- |:white_large_square:| End-to-end latency estimation and tuning
+- |:ballot_box_with_check:| Adaptive latency (requires RTCP)
+- |:white_large_square:| Adaptive FEC block and rate (requires RTCP and XRs from `RFC 5725 <https://tools.ietf.org/html/rfc5725>`_)
+- |:white_large_square:| Adaptive packet size
+- |:white_large_square:| Adaptive bitrate (for lossy codecs)
 - |:white_large_square:| Encryption support (SRTP and DTLS)
 - |:white_large_square:| QoS support
 - |:white_large_square:| Packet loss concealment (PLC)
@@ -45,7 +44,8 @@ Extensibility
 - |:white_large_square:| Provide custom allocator
 - |:ballot_box_with_check:| Register custom payload types
 - |:white_large_square:| Register custom codecs
-- |:white_large_square:| Register custom PLC
+- |:ballot_box_with_check:| Register custom PLC
+- |:white_large_square:| Register custom effect
 - |:white_large_square:| Register custom mixer
 
 Protocols