Skip to content

Ocyss/srs-auth / .agents/skills/srs-develop

srs-develop

Verified

Develop, modify, debug, review, maintain, and explain the SRS and Oryx codebases and the SRS Docker image toolchain. Use for planned changes to the next-generation SRS Go proxy, SRS browser player, ossrs/dev-docker images, or Oryx Go backend, React dashboard, integrated runtime, packaging, installers, releases, and tests; bug maintenance; issue and pull-request triage; pull-request review; and Learn Code questions. The C++ SRS server is in maintenance mode, and planned Go origin and edge development is not yet supported. NOT for end-user support, usage questions, or configuration help — use srs-support for those.

FileKindSize
SKILL.mdskill md8.2 KB
references/develop-code.mdmarkdown15.1 KB
references/fix-a-bug.mdmarkdown6.6 KB
references/integration-tests.mdmarkdown2.9 KB
references/learn-code.mdmarkdown3.3 KB
references/oryx-issues.mdmarkdown218 B
references/oryx-local-development.mdmarkdown11.9 KB
references/review-a-pr.mdmarkdown3.5 KB
references/scan-issues.mdmarkdown993 B
references/scan-prs.mdmarkdown1.4 KB
references/srs-issues.mdmarkdown58.5 KB
references/version-and-changelog.mdmarkdown2.3 KB
scripts/browser-page-url-test.jsscript2.7 KB
scripts/gb28181-api-timeout-test.shscript5.3 KB
scripts/gb28181-create-session.shscript2.1 KB
scripts/gb28181-publish-stream.shscript3.9 KB
scripts/gb28181-tcp-disconnect-test.shscript4.3 KB
scripts/oryx-api-smoke-test.shscript4.2 KB
scripts/oryx-camera-test.shscript12.2 KB
scripts/oryx-forward-test.shscript10.9 KB
scripts/oryx-live-room-test.shscript10.2 KB
scripts/oryx-live-streaming-test.shscript12.6 KB
scripts/oryx-record-test.shscript10.4 KB
scripts/oryx-run-tests.shscript2.3 KB
scripts/oryx-stack-start.shscript5.2 KB
scripts/oryx-stack-stop.shscript1.8 KB
scripts/oryx-transcode-test.shscript9.8 KB
scripts/oryx-vlive-test.shscript12.0 KB
scripts/proxy-e2e-bearer-auth-test.shscript12.0 KB
scripts/proxy-e2e-cluster-test.shscript10.4 KB
scripts/proxy-e2e-edge-test.shscript10.6 KB
scripts/proxy-e2e-redis-test.shscript11.7 KB
scripts/proxy-e2e-srt-test.shscript9.5 KB
scripts/proxy-e2e-test.shscript5.7 KB
scripts/proxy-e2e-transmux-test.shscript7.3 KB
scripts/proxy-e2e-whip-test.shscript11.5 KB
scripts/proxy-utest.shscript1.5 KB
scripts/setup-ffmpeg-with-whip.shscript7.5 KB

scripts/oryx-live-streaming-test.sh

View on GitHub
#!/bin/bash
# E2E test for the Oryx "Live" scenario page (tab=live): query the publish
# secret the page uses, then publish through every protocol that page offers
# -- RTMP, SRT, and WHIP -- and for each one verify playback via RTMP,
# HTTP-FLV, and HLS, plus confirm the stream shows up in the SRS HTTP API.
#
# Requires the shared local stack (Redis, SRS, Oryx Go backend) to already be
# running -- start it once with oryx-stack-start.sh. This script only starts
# its own ffmpeg publishers and cleans those up; it does not manage server
# lifecycle, so it is safe to run concurrently with other oryx-*-test.sh
# scripts against that same shared stack. Publishes with ffmpeg and verifies
# with ffprobe/curl (same pattern as proxy-e2e-srt-test.sh /
# proxy-e2e-whip-test.sh).
#
# SRT publish requires an ffmpeg built with libsrt, which the default
# Homebrew formula does not include; this script builds one via
# setup-ffmpeg-with-whip.sh on first use (can take several minutes).

SCRIPT_DIR="$(cd -P "$(dirname "$0")" && pwd)"
# Walk up from SCRIPT_DIR looking for go.mod, the SRS repo root. This avoids
# brittle "../../../.." counting when the skills directory is reached via a
# symlink (which changes the symbolic vs. physical depth).
WORKSPACE="$SCRIPT_DIR"
while [[ "$WORKSPACE" != "/" && ! -f "$WORKSPACE/go.mod" ]]; do
  WORKSPACE="$(dirname "$WORKSPACE")"
done
if [[ ! -f "$WORKSPACE/go.mod" ]]; then
  echo "Error: go.mod not found walking up from: $SCRIPT_DIR" >&2
  exit 1
fi

ORYX_DIR="$WORKSPACE/oryx"
PLATFORM_DIR="$ORYX_DIR/platform"
SOURCE_FLV="$WORKSPACE/trunk/doc/source.flv"
ENDPOINT="${ORYX_ENDPOINT:-http://localhost:2022}"
SRS_API="${SRS_API_ENDPOINT:-http://localhost:1985}"
SRS_RTMP="${SRS_RTMP_ENDPOINT:-rtmp://localhost:1935}"
SRS_HTTP="${SRS_HTTP_ENDPOINT:-http://localhost:8080}"
SRS_SRT="${SRS_SRT_ENDPOINT:-srt://localhost:10080}"
ENV_FILE="$PLATFORM_DIR/containers/data/config/.env"
APP="live"

# PID of this script's own ffmpeg publisher; always ours to kill.
FFMPEG_PID=""

cleanup() {
  echo ""
  echo "=== Cleaning up ==="
  if [[ -n "$FFMPEG_PID" ]]; then
    kill -9 "$FFMPEG_PID" 2>/dev/null || true
  fi
  echo "Cleanup done."
}
trap cleanup EXIT

# SRT needs libsrt, WHIP needs the whip muxer -- the default Homebrew ffmpeg
# formula has neither reliably. Resolution order: PATH, then ~/.local/bin
# (built previously), then build from source via setup-ffmpeg-with-whip.sh.
ffmpeg_supports_srt_and_whip() {
  local bin="$1"
  [[ -x "$bin" ]] || return 1
  "$bin" -hide_banner -protocols 2>/dev/null | grep -qw srt || return 1
  "$bin" -hide_banner -muxers 2>/dev/null | grep -qw whip || return 1
  return 0
}

resolve_ffmpeg() {
  local sys_ffmpeg sys_ffprobe local_ffmpeg local_ffprobe
  sys_ffmpeg="$(command -v ffmpeg || true)"
  sys_ffprobe="$(command -v ffprobe || true)"
  local_ffmpeg="$HOME/.local/bin/ffmpeg"
  local_ffprobe="$HOME/.local/bin/ffprobe"

  if [[ -n "$sys_ffprobe" ]] && ffmpeg_supports_srt_and_whip "$sys_ffmpeg"; then
    FFMPEG_BIN="$sys_ffmpeg"
    FFPROBE_BIN="$sys_ffprobe"
    return 0
  fi
  if [[ -x "$local_ffprobe" ]] && ffmpeg_supports_srt_and_whip "$local_ffmpeg"; then
    FFMPEG_BIN="$local_ffmpeg"
    FFPROBE_BIN="$local_ffprobe"
    return 0
  fi
  return 1
}

probe_has_audio_video() {
  local name="$1" url="$2" deadline=10
  echo "Verifying $name playback: $url"
  local output
  # One-shot muxers (e.g. WHIP's audio track landing in HTTP-FLV) can lag a
  # beat behind video, especially under concurrent CPU load -- retry instead
  # of failing on the first incomplete probe.
  for ((i = 1; i <= deadline; i++)); do
    output=$("$FFPROBE_BIN" -v error -show_streams "$url" 2>&1 || true)
    if echo "$output" | grep -q "codec_type=video" && echo "$output" | grep -q "codec_type=audio"; then
      echo "PASS: $name video stream detected."
      echo "PASS: $name audio stream detected."
      return
    fi
    sleep 1
  done

  if echo "$output" | grep -q "codec_type=video"; then
    echo "PASS: $name video stream detected."
  else
    echo "FAIL: $name no video stream detected after ${deadline}s." >&2
  fi
  if echo "$output" | grep -q "codec_type=audio"; then
    echo "PASS: $name audio stream detected."
  else
    echo "FAIL: $name no audio stream detected after ${deadline}s." >&2
  fi
  echo "ffprobe output:" >&2
  echo "$output" >&2
  exit 1
}

wait_for_hls_playlist() {
  local url="$1" deadline=60
  echo "Waiting for HLS playlist to be generated (up to ${deadline}s): $url"
  for ((i = 1; i <= deadline; i++)); do
    if curl -fsS "$url" 2>/dev/null | grep -q "#EXTM3U"; then
      echo "HLS playlist is ready."
      return
    fi
    sleep 1
  done
  echo "FAIL: HLS playlist was not generated in ${deadline}s." >&2
  curl -v "$url" 2>&1 || true
  exit 1
}

first_hls_segment() {
  local url="$1"
  curl -fsS "$url" 2>/dev/null | awk '
    /^[[:space:]]*$/ { next }
    /^#/ { next }
    { print; exit }
  '
}

wait_for_hls_to_skip_first_segment() {
  local url="$1" deadline=60
  local first_segment current_segment output

  first_segment="$(first_hls_segment "$url")"
  if [[ -z "$first_segment" ]]; then
    echo "FAIL: HLS playlist has no media segment: $url" >&2
    curl -fsS "$url" 2>&1 || true
    exit 1
  fi

  echo "Waiting for HLS to skip the first possibly incomplete segment (up to ${deadline}s): $first_segment"
  for ((i = 1; i <= deadline; i++)); do
    current_segment="$(first_hls_segment "$url")"
    if [[ -n "$current_segment" && "$current_segment" != "$first_segment" ]]; then
      output=$("$FFPROBE_BIN" -v error -show_streams "$url" 2>&1 || true)
      if echo "$output" | grep -q "codec_type=video" && echo "$output" | grep -q "codec_type=audio"; then
        echo "HLS first segment advanced and audio/video is ready: $current_segment"
        return
      fi
    fi
    sleep 1
  done

  echo "FAIL: HLS did not skip the first segment and expose audio/video in ${deadline}s." >&2
  curl -fsS "$url" 2>&1 || true
  exit 1
}

# Confirm the stream is actually live per the SRS HTTP API, mirroring what a
# maintainer would check by hand: GET /api/v1/streams/ and look for the
# stream name with an active publisher.
check_srs_stream_published() {
  local stream="$1" deadline=15
  echo "Checking SRS HTTP API for published stream: $stream"
  for ((i = 1; i <= deadline; i++)); do
    local body
    body=$(curl -sS -m 3 "$SRS_API/api/v1/streams/" 2>/dev/null)
    if echo "$body" | grep -q "\"name\":\"$stream\"" && echo "$body" | grep -q '"publish":{"active":true'; then
      echo "PASS: SRS API reports $stream as actively published."
      return
    fi
    sleep 1
  done
  echo "FAIL: SRS API never reported $stream as actively published." >&2
  echo "Last response: $body" >&2
  exit 1
}

echo "=== Oryx Live Streaming Test ==="
echo "Endpoint: $ENDPOINT"
echo ""

# --- Step 0: Require the shared stack to already be running ---
if ! curl -sS -m 2 -o /dev/null "$SRS_API/api/v1/versions" 2>/dev/null || \
   ! curl -sS -m 2 -o /dev/null "$ENDPOINT/terraform/v1/mgmt/versions" 2>/dev/null; then
  echo "FAIL: local Oryx stack is not running. Start it first:" >&2
  echo "  bash $SCRIPT_DIR/oryx-stack-start.sh" >&2
  exit 1
fi

# --- Step 1: Resolve ffmpeg/ffprobe with SRT + WHIP support ---
echo "=== Step 1: Resolve ffmpeg with SRT and WHIP support ==="
if ! resolve_ffmpeg; then
  echo "No ffmpeg with both SRT and WHIP support found on PATH or in ~/.local/bin."
  echo "Building ffmpeg from source via setup-ffmpeg-with-whip.sh -- this can take several minutes."
  bash "$SCRIPT_DIR/setup-ffmpeg-with-whip.sh"
  FFMPEG_BIN="$HOME/.local/bin/ffmpeg"
  FFPROBE_BIN="$HOME/.local/bin/ffprobe"
  if ! ffmpeg_supports_srt_and_whip "$FFMPEG_BIN"; then
    echo "Error: ffmpeg still lacks SRT/WHIP support after running setup-ffmpeg-with-whip.sh." >&2
    exit 1
  fi
fi
echo "ffmpeg : $FFMPEG_BIN"
echo "ffprobe: $FFPROBE_BIN"
if [[ ! -f "$SOURCE_FLV" ]]; then
  echo "FAIL: test source not found: $SOURCE_FLV" >&2
  exit 1
fi
echo ""

# --- Step 2: Login and fetch the publish secret the Live page uses ---
echo "=== Step 2: Login and query the publish secret ==="
PASSWORD="${MGMT_PASSWORD:-}"
if [[ -z "$PASSWORD" && -f "$ENV_FILE" ]]; then
  # godotenv quotes values, e.g. MGMT_PASSWORD="abc123" -- strip the quotes.
  PASSWORD=$(sed -n 's/^MGMT_PASSWORD="\(.*\)"$/\1/p' "$ENV_FILE")
fi
if [[ -z "$PASSWORD" ]]; then
  echo "FAIL: no MGMT_PASSWORD found (env var or $ENV_FILE)." >&2
  exit 1
fi

# The backend serializes logins with a mutex and replies "login is running,
# try later" to a losing concurrent request -- expected when multiple
# oryx-*-test.sh scripts log in around the same moment, not a real failure.
# Retry past it instead of hard-failing.
BEARER=""
for ((i = 1; i <= 10; i++)); do
  LOGIN_RESP=$(curl -sS -m 5 -X POST "$ENDPOINT/terraform/v1/mgmt/login" \
    -H 'Content-Type: application/json' \
    -d "{\"password\":\"$PASSWORD\"}")
  BEARER=$(echo "$LOGIN_RESP" | sed -n 's/.*"bearer":"\([^"]*\)".*/\1/p')
  [[ -n "$BEARER" ]] && break
  sleep 1
done
if [[ -z "$BEARER" ]]; then
  echo "FAIL: login did not return a security key after retries: $LOGIN_RESP" >&2
  exit 1
fi

SECRET_RESP=$(curl -sS -m 5 -X POST "$ENDPOINT/terraform/v1/hooks/srs/secret/query" \
  -H "Authorization: Bearer $BEARER" \
  -H 'Content-Type: application/json' \
  -d '{}')
PUBLISH_SECRET=$(echo "$SECRET_RESP" | sed -n 's/.*"publish":"\([^"]*\)".*/\1/p')
if [[ -z "$PUBLISH_SECRET" ]]; then
  echo "FAIL: secret/query did not return a publish secret: $SECRET_RESP" >&2
  exit 1
fi
echo "PASS: publish secret resolved (${#PUBLISH_SECRET} chars)."
echo ""

# --- Step 3: RTMP publish, verify RTMP/HTTP-FLV/HLS playback ---
echo "=== Step 3: Publish via RTMP, verify RTMP/HTTP-FLV/HLS playback ==="
STREAM_RTMP="livetest-rtmp-$(date +%s)"
"$FFMPEG_BIN" -re -stream_loop -1 -i "$SOURCE_FLV" -c copy -f flv \
  "$SRS_RTMP/$APP/$STREAM_RTMP?secret=$PUBLISH_SECRET" >/tmp/oryx-live-ffmpeg-rtmp.log 2>&1 &
FFMPEG_PID=$!
sleep 3
if ! kill -0 "$FFMPEG_PID" 2>/dev/null; then
  echo "FAIL: RTMP publisher exited early. Logs:" >&2
  cat /tmp/oryx-live-ffmpeg-rtmp.log >&2
  exit 1
fi
check_srs_stream_published "$STREAM_RTMP"
probe_has_audio_video "RTMP" "$SRS_RTMP/$APP/$STREAM_RTMP"
probe_has_audio_video "HTTP-FLV" "$SRS_HTTP/$APP/$STREAM_RTMP.flv"
HLS_URL="$SRS_HTTP/$APP/$STREAM_RTMP.m3u8"
wait_for_hls_playlist "$HLS_URL"
wait_for_hls_to_skip_first_segment "$HLS_URL"
probe_has_audio_video "HLS" "$HLS_URL"
kill -9 "$FFMPEG_PID" 2>/dev/null || true
wait "$FFMPEG_PID" 2>/dev/null || true
FFMPEG_PID=""
echo ""

# --- Step 4: SRT publish, verify RTMP/HTTP-FLV/HLS playback (srt_to_rtmp) ---
echo "=== Step 4: Publish via SRT, verify RTMP/HTTP-FLV/HLS playback ==="
STREAM_SRT="livetest-srt-$(date +%s)"
"$FFMPEG_BIN" -re -stream_loop -1 -i "$SOURCE_FLV" -c copy -f mpegts \
  "$SRS_SRT?streamid=#!::r=$APP/$STREAM_SRT?secret=$PUBLISH_SECRET,m=publish" >/tmp/oryx-live-ffmpeg-srt.log 2>&1 &
FFMPEG_PID=$!
sleep 3
if ! kill -0 "$FFMPEG_PID" 2>/dev/null; then
  echo "FAIL: SRT publisher exited early. Logs:" >&2
  cat /tmp/oryx-live-ffmpeg-srt.log >&2
  exit 1
fi
check_srs_stream_published "$STREAM_SRT"
probe_has_audio_video "RTMP" "$SRS_RTMP/$APP/$STREAM_SRT"
probe_has_audio_video "HTTP-FLV" "$SRS_HTTP/$APP/$STREAM_SRT.flv"
HLS_URL="$SRS_HTTP/$APP/$STREAM_SRT.m3u8"
wait_for_hls_playlist "$HLS_URL"
wait_for_hls_to_skip_first_segment "$HLS_URL"
probe_has_audio_video "HLS" "$HLS_URL"
kill -9 "$FFMPEG_PID" 2>/dev/null || true
wait "$FFMPEG_PID" 2>/dev/null || true
FFMPEG_PID=""
echo ""

# --- Step 5: WHIP publish, verify RTMP/HTTP-FLV/HLS playback (rtc_to_rtmp) ---
echo "=== Step 5: Publish via WHIP, verify RTMP/HTTP-FLV/HLS playback ==="
STREAM_WHIP="livetest-whip-$(date +%s)"
WHIP_URL="$ENDPOINT/rtc/v1/whip/?app=$APP&stream=$STREAM_WHIP&secret=$PUBLISH_SECRET"
echo "Publish URL: $WHIP_URL"
# WebRTC requires H.264 (baseline-friendly) + Opus. source.flv is H.264 High
# profile + AAC, so transcode video to baseline and audio to Opus.
"$FFMPEG_BIN" -stream_loop -1 -re -i "$SOURCE_FLV" \
  -c:v libx264 -profile:v baseline -level 3.1 -pix_fmt yuv420p \
  -tune zerolatency -preset ultrafast -g 25 \
  -c:a libopus -ar 48000 -ac 2 \
  -f whip "$WHIP_URL" >/tmp/oryx-live-ffmpeg-whip.log 2>&1 &
FFMPEG_PID=$!
sleep 10
if ! kill -0 "$FFMPEG_PID" 2>/dev/null; then
  echo "FAIL: WHIP publisher exited early. Logs:" >&2
  cat /tmp/oryx-live-ffmpeg-whip.log >&2
  exit 1
fi
check_srs_stream_published "$STREAM_WHIP"
probe_has_audio_video "RTMP" "$SRS_RTMP/$APP/$STREAM_WHIP"
probe_has_audio_video "HTTP-FLV" "$SRS_HTTP/$APP/$STREAM_WHIP.flv"
HLS_URL="$SRS_HTTP/$APP/$STREAM_WHIP.m3u8"
wait_for_hls_playlist "$HLS_URL"
wait_for_hls_to_skip_first_segment "$HLS_URL"
probe_has_audio_video "HLS" "$HLS_URL"
kill -9 "$FFMPEG_PID" 2>/dev/null || true
wait "$FFMPEG_PID" 2>/dev/null || true
FFMPEG_PID=""
echo ""

echo "=== Oryx Live Streaming Test PASSED ==="
finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the workStars: 322kUpdated Claude CodeCodexVerifiedInstall
systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixesStars: 322kUpdated Claude CodeCodexVerifiedInstall
test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation codeStars: 322kUpdated Claude CodeCodexVerifiedInstall
skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.Stars: 197kUpdated Claude CodeCodexVerifiedInstall