Fix (#753)Fixes #753

.github/workflows/build.yml

@@ -196,7 +196,7 @@ jobs:
           - script: linux-checks/check-formatting
             image: rocstreaming/env-ubuntu
 
-          - script: linux-checks/check-doctests
+          - script: linux-checks/check-scons
             image: rocstreaming/env-ubuntu
 
           - script: linux-checks/pulseaudio-versions

SConstruct

@@ -440,13 +440,13 @@ doc_env = env.DeepClone()
 doc_env.SConscript('docs/SConscript',
                    duplicate=0, exports='doc_env')
 
-# run python doctests
-env.AlwaysBuild(env.Alias('doctest', [], [
-    env.DocTest('#scripts/scons_helpers/build-3rdparty.py'),
+# run scons self-test
+env.AlwaysBuild(env.Alias('selftest', [], [
+    env.SelfTest(),
 ]))
 
 # exit early if there is nothing to build
-non_build_targets = ['fmt', 'docs', 'sphinx', 'doxygen', 'doctest']
+non_build_targets = ['fmt', 'docs', 'sphinx', 'doxygen', 'selftest']
 if set(COMMAND_LINE_TARGETS) \
   and set(COMMAND_LINE_TARGETS).intersection(non_build_targets) == set(COMMAND_LINE_TARGETS):
     Return()
@@ -893,7 +893,7 @@ if meta.compiler in ['gcc', 'clang']:
         '-std=c11',
     ])
 
-if 'target_posix' in env['ROC_TARGETS'] and meta.platform not in ['macos']:
+if 'target_posix' in env['ROC_TARGETS'] and meta.platform not in ['darwin']:
     # macOS is special, otherwise rely on _POSIX_C_SOURCE
     env.Append(CPPDEFINES=[('_POSIX_C_SOURCE', env['ROC_POSIX_PLATFORM'])])
 
@@ -902,18 +902,6 @@ env.Append(CPPDEFINES=[
     ('__STDC_LIMIT_MACROS', '1'),
 ])
 
-if meta.platform in ['windows']:
-    env.Append(CPPDEFINES=[
-        # enable M_PI and similar
-        '_USE_MATH_DEFINES',
-        # disable min() and max() macros
-        'NOMINMAX',
-        # disable winsock1 and redundant macros like far/near
-        'WIN32_LEAN_AND_MEAN',
-        # minimal supported windows version (windows 7)
-        ('_WIN32_WINNT', '0x0601'),
-    ])
-
 # env will hold settings common to all code
 # subenvs will hold settings specific to particular parts of code
 subenv_names = 'internal_modules public_libs examples tools tests generated_code'.split()
@@ -927,7 +915,7 @@ subenvs = type('subenvs', (), subenv_attrs)
 env, subenvs = env.SConscript('3rdparty/SConscript',
                        duplicate=0, exports='env subenvs meta')
 
-if meta.platform in ['macos']:
+if meta.platform in ['darwin']:
     if env['ROC_MACOS_PLATFORM']:
         for var in ['CXXFLAGS', 'CFLAGS', 'LINKFLAGS']:
             env.Append(**{var: [

docs/sphinx/_static/sphinx_extras.css

@@ -77,7 +77,3 @@ table.align-center {
     width: 180px;
     height: 90px;
 }
-
-.api-examples li a {
-    background-color: #d0dcdf36;
-}

docs/sphinx/about_project/licensing.rst

@@ -29,4 +29,5 @@ 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.
 
+OpenFEC
 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.

docs/sphinx/building/dependencies.rst

@@ -77,6 +77,11 @@ Runtime dependencies
      - LGPL
      - optional, enables additional audio file formats
 
+   * - `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
@@ -90,7 +95,7 @@ Runtime dependencies
    * - `OpenFEC <https://openfec.inrialpes.fr>`_
      - >= 1.4.2 (recommended to use `our fork <https://github.com/roc-streaming/openfec>`_)
      - CeCCIL-C (LGPL-like) + CeCCIL (GPL-like, only for LDPC-Staircase) + BSD-like + CC BY-SA
-     - optional, enables packet loss repair with FECFRAME
+     - optional, used for FECFRAME support
 
    * - `OpenSSL <https://www.openssl.org/>`_
      - >= 1.1.1
@@ -105,7 +110,7 @@ Runtime dependencies
    * - `SoX <https://sox.sourceforge.net>`_
      - >= 14.4.0
      - LGPL
-     - optional, enables additional audio file formats and sound servers
+     - optional, used for audio I/O
 
    * - `SpeexDSP <https://github.com/xiph/speexdsp>`_
      - >= 1.2beta3

docs/sphinx/internals/audio_backends.rst

@@ -45,7 +45,7 @@ The job of ``roc-send`` and ``roc-recv`` is thus to open a source and a sink and
 
 - in ``roc-recv``, ``ISource`` is implemented by receiver pipeline from ``roc_pipeline``, and ``ISink`` is implemented by device or file from ``roc_sndio``
 
-The task of transferring sound from ``ISource`` to ``ISink`` is implemented in `sndio::IoPump <https://roc-streaming.org/toolkit/doxygen/classroc_1_1sndio_1_1IoPump.html>`_ class, which works uniformly with any pair of source and sink, being it file, device, or pipeline.
+The task of transferring sound from ``ISource`` to ``ISink`` is implemented in `sndio::Pump <https://roc-streaming.org/toolkit/doxygen/classroc_1_1sndio_1_1Pump.html>`_ class, which works uniformly with any pair of source and sink, being it file, device, or pipeline.
 
 Backends and drivers
 ====================

docs/sphinx/internals/code_structure.rst

@@ -137,6 +137,17 @@ target_pc             Enabled for PC (like server, desktop, laptop)
 target_posix          Enabled for a POSIX OS
 target_posix_ext      Enabled for a POSIX OS with POSIX extensions
 target_posix_pc       Enabled for a POSIX OS on PC
+target_gnu            Enabled for GNU-like libc and compiler
+target_darwin         Enabled for macOS
+target_android        Enabled for Android
+target_c11            Enabled for C11 compilers
+target_libunwind      Enabled if libunwind is available
+target_libatomic_ops  Enabled if libatomic_ops is available
+target_libuv          Enabled if libuv is available
+target_openfec        Enabled if OpenFEC is available
+target_speexdsp       Enabled if SpeexDSP is available
+target_sox            Enabled if SoX is available
+target_sndfile        Enabled if libsndfile is available
 target_pulseaudio     Enabled if PulseAudio is available
 target_sndfile        Enabled if libsndfile is available
 target_sox            Enabled if SoX is available

scripts/ci_checks/linux-arm/run-tests-in-qemu.sh

@@ -20,6 +20,6 @@ find bin/"$toolchain" -name 'roc-test-*' | \
     do
         LD_LIBRARY_PATH="/opt/sysroot/lib:$(echo \
           "$PWD/build/3rdparty/$toolchain/$compiler"/*/rpath | tr ' ' ':')" \
-            python3 scripts/scons_helpers/timeout-run.py 900 \
+            python3 scripts/scons_helpers/timeout-run.py 300 \
               "$qemu_cmd" -L "/opt/sysroot" -cpu "$cpu" "$tst"
     done

scripts/ci_checks/linux-checks/check-scons.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+scons -Q selftest