Enable RTSP capture and add CI coverage

Author: shimat

.github/workflows/macos.yml

@@ -13,6 +13,7 @@ on:
 env:
   OPENCV_VERSION: 5.0.0
   CACHE_VERSION: "1"
+  MEDIAMTX_VERSION: 1.19.3
 
 jobs:
   # ---------------------------------------------------------------------------
@@ -334,6 +335,51 @@ jobs:
         with:
           dotnet-version: '10.0.x'
 
+      - name: Start local RTSP test server
+        run: |
+          version="${MEDIAMTX_VERSION}"
+          archive_name="mediamtx_v${version}_darwin_arm64.tar.gz"
+          download_base="https://github.com/bluenviron/mediamtx/releases/download/v${version}"
+          server_dir="${RUNNER_TEMP}/mediamtx"
+          archive_path="${RUNNER_TEMP}/${archive_name}"
+          checksums_path="${RUNNER_TEMP}/mediamtx-checksums.sha256"
+
+          curl -fL --retry 5 "${download_base}/${archive_name}" -o "${archive_path}"
+          curl -fL --retry 5 "${download_base}/checksums.sha256" -o "${checksums_path}"
+
+          expected_checksum=$(grep -E "[ *]${archive_name}$" "${checksums_path}" | awk '{print $1}')
+          if [ -z "${expected_checksum}" ]; then
+            echo "Checksum not found for ${archive_name}"
+            exit 1
+          fi
+          actual_checksum=$(shasum -a 256 "${archive_path}" | awk '{print $1}')
+          if [ "${actual_checksum}" != "${expected_checksum}" ]; then
+            echo "Checksum mismatch for ${archive_name}: expected ${expected_checksum}, got ${actual_checksum}"
+            exit 1
+          fi
+
+          mkdir -p "${server_dir}"
+          tar -xzf "${archive_path}" -C "${server_dir}"
+          "${server_dir}/mediamtx" "${GITHUB_WORKSPACE}/test/rtsp/mediamtx.yml" \
+            >"${RUNNER_TEMP}/mediamtx.log" 2>&1 &
+          server_pid=$!
+
+          for attempt in $(seq 1 30); do
+            if ! kill -0 "${server_pid}" 2>/dev/null; then
+              cat "${RUNNER_TEMP}/mediamtx.log"
+              exit 1
+            fi
+            if grep -q "stream is available" "${RUNNER_TEMP}/mediamtx.log"; then
+              echo "OPENCVSHARP_TEST_RTSP_URL=rtsp://127.0.0.1:8554/test" >> "${GITHUB_ENV}"
+              echo "OPENCVSHARP_RTSP_SERVER_PID=${server_pid}" >> "${GITHUB_ENV}"
+              exit 0
+            fi
+            sleep 1
+          done
+
+          cat "${RUNNER_TEMP}/mediamtx.log"
+          exit 1
+
       - name: Test
         run: |
           cd ${GITHUB_WORKSPACE}/test/OpenCvSharp.Tests
@@ -350,6 +396,13 @@ jobs:
             --logger "trx;LogFileName=test-results.trx" \
             --blame-crash --blame-crash-dump-type full < /dev/null
 
+      - name: Stop local RTSP test server
+        if: always()
+        run: |
+          if [ -n "${OPENCVSHARP_RTSP_SERVER_PID:-}" ]; then
+            kill "${OPENCVSHARP_RTSP_SERVER_PID}" 2>/dev/null || true
+          fi
+
       - name: Test Avalonia extensions
         run: |
           cd ${GITHUB_WORKSPACE}/test/OpenCvSharp.Tests.Avalonia

.github/workflows/manylinux.yml

@@ -10,6 +10,7 @@ on:
 env:
   DEBIAN_FRONTEND: noninteractive
   OPENCV_VERSION: 5.0.0
+  MEDIAMTX_VERSION: 1.19.3
 
 jobs:
   # ---------------------------------------------------------------------------
@@ -204,7 +205,27 @@ jobs:
         with:
           dotnet-version: '10.0.x'
 
+      - name: Start local RTSP test server
+        run: |
+          docker run --detach --rm \
+            --name opencvsharp-rtsp \
+            --publish 8554:8554 \
+            --volume "${GITHUB_WORKSPACE}/test/rtsp/mediamtx.yml:/mediamtx.yml:ro" \
+            bluenviron/mediamtx:${MEDIAMTX_VERSION}
+
+          for attempt in $(seq 1 30); do
+            if docker logs opencvsharp-rtsp 2>&1 | grep -q "stream is available"; then
+              exit 0
+            fi
+            sleep 1
+          done
+
+          docker logs opencvsharp-rtsp
+          exit 1
+
       - name: Test (full)
+        env:
+          OPENCVSHARP_TEST_RTSP_URL: rtsp://127.0.0.1:8554/test
         run: |
           cd ${GITHUB_WORKSPACE}/test/OpenCvSharp.Tests
           dotnet build -c Release -f net10.0
@@ -224,6 +245,8 @@ jobs:
       # Headless has the same module set as full except highgui, so it runs the same xunit
       # suite minus the one test class that calls into highgui (WaitKey/PollKey/...).
       - name: Test (headless)
+        env:
+          OPENCVSHARP_TEST_RTSP_URL: rtsp://127.0.0.1:8554/test
         run: |
           cd ${GITHUB_WORKSPACE}/test/OpenCvSharp.Tests
           cp ${GITHUB_WORKSPACE}/nuget-headless/libOpenCvSharpExtern-headless.so bin/Release/net10.0/libOpenCvSharpExtern.so
@@ -233,6 +256,10 @@ jobs:
             --filter "FullyQualifiedName!~OpenCvSharp.Tests.HighGui.HighGuiTest" \
             --logger "trx;LogFileName=test-results-headless.trx" < /dev/null
 
+      - name: Stop local RTSP test server
+        if: always()
+        run: docker stop opencvsharp-rtsp >/dev/null 2>&1 || true
+
       - name: Smoke test (slim)
         run: |
           cd ${GITHUB_WORKSPACE}/nuget-slim/

.github/workflows/windows.yml

@@ -15,6 +15,7 @@ on:
 
 env:
   OPENCV_VERSION: "5.0.0"
+  MEDIAMTX_VERSION: "1.19.3"
 
 jobs:
   build:
@@ -174,6 +175,55 @@ jobs:
             -D NO_INSTALL_TO_TEST=ON
           cmake --build src/build_slim --config Release -j 4
 
+      - name: Start local RTSP test server
+        shell: pwsh
+        run: |
+          $ErrorActionPreference = "Stop"
+          $version = $env:MEDIAMTX_VERSION
+          $archiveName = "mediamtx_v${version}_windows_amd64.zip"
+          $downloadBase = "https://github.com/bluenviron/mediamtx/releases/download/v${version}"
+          $serverDir = Join-Path $env:RUNNER_TEMP "mediamtx"
+          $archivePath = Join-Path $env:RUNNER_TEMP $archiveName
+          $checksumsPath = Join-Path $env:RUNNER_TEMP "mediamtx-checksums.sha256"
+
+          Invoke-WebRequest "$downloadBase/$archiveName" -OutFile $archivePath
+          Invoke-WebRequest "$downloadBase/checksums.sha256" -OutFile $checksumsPath
+
+          $checksumLine = Get-Content $checksumsPath | Where-Object { $_ -match "[ *]$([regex]::Escape($archiveName))$" }
+          if (-not $checksumLine) { throw "Checksum not found for $archiveName" }
+          $expectedChecksum = ($checksumLine -split "\s+")[0].ToLowerInvariant()
+          $actualChecksum = (Get-FileHash $archivePath -Algorithm SHA256).Hash.ToLowerInvariant()
+          if ($actualChecksum -ne $expectedChecksum) {
+            throw "Checksum mismatch for ${archiveName}: expected $expectedChecksum, got $actualChecksum"
+          }
+
+          Expand-Archive $archivePath -DestinationPath $serverDir
+          $stdoutPath = Join-Path $env:RUNNER_TEMP "mediamtx.stdout.log"
+          $stderrPath = Join-Path $env:RUNNER_TEMP "mediamtx.stderr.log"
+          $server = Start-Process `
+            (Join-Path $serverDir "mediamtx.exe") `
+            -ArgumentList "${env:GITHUB_WORKSPACE}\test\rtsp\mediamtx.yml" `
+            -RedirectStandardOutput $stdoutPath `
+            -RedirectStandardError $stderrPath `
+            -WindowStyle Hidden `
+            -PassThru
+
+          for ($attempt = 1; $attempt -le 30; $attempt++) {
+            if ($server.HasExited) {
+              Get-Content $stdoutPath, $stderrPath -ErrorAction SilentlyContinue
+              throw "MediaMTX exited with code $($server.ExitCode)"
+            }
+            if ((Get-Content $stdoutPath -Raw -ErrorAction SilentlyContinue) -match "stream is available") {
+              "OPENCVSHARP_TEST_RTSP_URL=rtsp://127.0.0.1:8554/test" | Out-File $env:GITHUB_ENV -Append
+              "OPENCVSHARP_RTSP_SERVER_PID=$($server.Id)" | Out-File $env:GITHUB_ENV -Append
+              exit 0
+            }
+            Start-Sleep -Seconds 1
+          }
+
+          Get-Content $stdoutPath, $stderrPath -ErrorAction SilentlyContinue
+          throw "Timed out waiting for MediaMTX"
+
       - name: Test
         shell: cmd
         # --blame-crash* collects a full memory dump and a Sequence_*.xml (listing tests executed,
@@ -182,6 +232,14 @@ jobs:
         # re-run. See "Upload crash dumps on failure" below.
         run: dotnet test test\OpenCvSharp.Tests -c Release -f net10.0 --runtime win-x64 --blame-crash --blame-crash-dump-type full
 
+      - name: Stop local RTSP test server
+        if: always()
+        shell: pwsh
+        run: |
+          if ($env:OPENCVSHARP_RTSP_SERVER_PID) {
+            Stop-Process -Id $env:OPENCVSHARP_RTSP_SERVER_PID -Force -ErrorAction SilentlyContinue
+          }
+
       - name: Upload crash dumps on failure
         if: failure()
         uses: actions/upload-artifact@v7

packaging/docker/manylinux/build_static_deps.sh

@@ -35,6 +35,7 @@ dnf install -y nasm yasm
 # ---------------------------------------------------------------------------
 # FFmpeg (LGPL v2.1+ — statically linked, no patented external codecs)
 # Internal decoders cover H.264, H.265, VP8, VP9, MPEG-4, MPEG-2, and many others.
+# Networking remains enabled so videoio can open RTSP and other network streams.
 # Hwaccel autodetection (vaapi/vdpau/v4l2-m2m) is disabled explicitly: this build
 # never uses hardware acceleration, but if libva happens to be present in the
 # build container, FFmpeg's configure would auto-enable vaapi and silently add
@@ -59,7 +60,7 @@ cd "ffmpeg-${FFMPEG_VERSION}"
     --disable-doc \
     --disable-programs \
     --disable-debug \
-    --disable-network \
+    --enable-network \
     --disable-avdevice \
     --disable-postproc \
     --enable-avcodec \

test/OpenCvSharp.Tests/videoio/VideoCaptureTest.cs

@@ -12,6 +12,12 @@ public class VideoCaptureTest : TestBase
         // True only when a real V4L2 device is present (e.g. /dev/video0)
         public static bool HasV4L2Device => IsLinux && Directory.EnumerateFiles("/dev", "video*").Any();
 
+        private const string RtspUrlEnvironmentVariable = "OPENCVSHARP_TEST_RTSP_URL";
+
+        // The CI workflows start a local MediaMTX instance and set this URL.
+        public static bool HasRtspTestUrl =>
+            !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable(RtspUrlEnvironmentVariable));
+
         // Backend used for the custom-stream (IStreamReader/Stream) VideoCapture tests below.
         // FFMPEG's custom-stream support (VideoCapture(Ptr<IStreamReader>, ...)) is flaky on the
         // Windows CI runners' prebuilt FFmpeg plugin DLL (createCapture(stream, ...) reports not
@@ -100,6 +106,30 @@ public void GrabAndRetrieveImageSequence()
             }
         }
 
+        [Fact(
+            Skip = $"Set {RtspUrlEnvironmentVariable} to run the RTSP integration test",
+            SkipUnless = nameof(HasRtspTestUrl))]
+        public void ReadRtspStreamWithFFmpeg()
+        {
+            var url = Environment.GetEnvironmentVariable(RtspUrlEnvironmentVariable)!;
+            using var capture = new VideoCapture(
+                url,
+                VideoCaptureAPIs.FFMPEG,
+                [
+                    (int)VideoCaptureProperties.OpenTimeoutMsec, 10_000,
+                    (int)VideoCaptureProperties.ReadTimeoutMsec, 10_000,
+                ]);
+
+            Assert.True(capture.IsOpened());
+            Assert.Equal("FFMPEG", capture.GetBackendName());
+
+            using var frame = new Mat();
+            Assert.True(capture.Read(frame));
+            Assert.False(frame.Empty());
+            Assert.True(frame.Width > 0);
+            Assert.True(frame.Height > 0);
+        }
+
         [Fact]
         public void GetSetExceptionMode()
         {

test/rtsp/mediamtx.yml

@@ -0,0 +1,13 @@
+logLevel: info
+rtspTransports: [tcp]
+rtmp: false
+hls: false
+webrtc: false
+srt: false
+moq: false
+
+paths:
+  test:
+    alwaysAvailable: true
+    alwaysAvailableTracks:
+      - codec: H264