Skip to content

Latest commit

 

History

History
276 lines (212 loc) · 12.4 KB

README.md

File metadata and controls

276 lines (212 loc) · 12.4 KB

flow

Go 实现的 RTSP / RTMP / HTTP-FLV / HLS / DASH / SRT / WebRTC 流媒体服务器: 本地文件或 stdin 摄像头作为媒体源,所有协议按流名共享同一组源,任一协议 推上来的流其他协议都能直接拉取。

构建与运行

go build ./...

# RTSP :8554,RTMP :1935,HTTP-FLV :8080,HLS :8082,DASH :8083,
# SRT :9000,WebRTC(WHIP/WHEP):8084
go run ./cmd/server

播放本地测试媒体(testdata/ 会自动作为兜底源):

ffplay rtsp://127.0.0.1:8554/live
ffplay -rtsp_transport tcp rtsp://127.0.0.1:8554/live
ffplay rtmp://127.0.0.1:1935/live/test
ffplay http://127.0.0.1:8080/live/test.flv

HTTP-FLV 支持跨域与防盗链:-httpflv-cors 配置允许的 Origin, -httpflv-referer / -httpflv-require-referer 校验 Referer, -httpflv-token 要求 ?token= 或 X-Flow-Token 头; -httpflv-addr 传空可关闭该服务。

WebRTC(P-4)用 WHIP 推、WHEP 拉,浏览器直接收发 H.264 + Opus, 传输走 ICE/DTLS/SRTP,媒体进同一个注册表:

go run ./cmd/server -webrtc-addr :8084 -webrtc-cors '*' -webrtc-loopback

# 推流:POST application/sdp 到 /whip/<name>,返回 201 + Location + ETag
# 拉流:POST application/sdp 到 /whep/<name>
# 结束:DELETE <Location>,trickle:PATCH <Location>

浏览器验收页(正文见 webrtc.md):

python test/e2e/webrtc_e2e.py      # 起服务 + headless Edge 全自动验收

截图 / 缩略图(F-6,默认 :8085):从流的最近一个 IDR 解码一帧,输出 JPEG/PNG,供列表页或播前预览。H.264 用纯 Go 解码;H.265 或 hi264 不支持 的 H.264 可配置 -snapshot-ffmpeg 回退到 ffmpeg,否则返回 415。

go run ./cmd/server -snapshot-addr :8085 -snapshot-max-width 480

# 路径后缀选择格式;width/quality 覆盖默认缩略参数
curl -o thumb.jpg "http://127.0.0.1:8085/snapshot/live/test.jpg?width=320&quality=80"
curl -o frame.png "http://127.0.0.1:8085/snapshot/live/test.png"

# fresh=1 忽略预热的 GOP,等下一个关键帧(直播画面而不是缓存 GOP)
curl -o fresh.jpg "http://127.0.0.1:8085/snapshot/live/test.jpg?fresh=1"

# H.265 兜底
go run ./cmd/server -snapshot-ffmpeg ffmpeg

-snapshot-cache(默认 1s)让同一路流的重复请求复用已编码图片, -snapshot-concurrency(默认 2)限制同时解码数;-snapshot-cors / -snapshot-referer / -snapshot-token 与其它 HTTP 服务语义一致, -snapshot-addr "" 关闭该服务。

转码(F-4):用外部 ffmpeg 进程把注册表里的一路流解码、缩放、重新编码, 结果以新流名发布回同一份注册表,RTSP / RTMP / HTTP-FLV / HLS / DASH 都能 直接拉;Go 侧只做帧源订阅、MPEG-TS 封装/解封装和进程管理,不需要 cgo。 音频不解码,原样复制到输出流。

# 1080p 源 → 720p(输出流名默认 <源>_720p)
./flow -transcode "live/src=w=1280,h=720"

# 多档位;字段:w/h 或 size、codec=h264|h265、bitrate=3m、fps=30、out=
./flow -transcode "live/src=size=1280x720,bitrate=3m;live/src=size=640x360,out=live/src_360p"

# 硬件编码(需要显卡驱动与对应 ffmpeg 构建)
./flow -transcode "live/src=size=1280x720" -transcode-hw nvenc

-transcode-ffmpeg 指定 ffmpeg 路径(默认 ffmpeg),-transcode-preset 是软件编码器 preset(默认 veryfast),-transcode-gop 控制强制关键帧 间隔(默认 2s,HLS/录制/中途加入依赖它)。ffmpeg 崩溃或消费过慢会按 500ms→10s 指数退避重启;重启后的输出时间轴接在上一次之后,下游不会看到 时间戳回退。指标见 flow_transcode_*。

多码率 ABR(F-5):同一 Source 的多个转码档位会自动组成 ABR 阶梯 (-transcode-abr=true,默认开启)。/hls/<source>/master.m3u8 按码率 升序输出多个 EXT-X-STREAM-INF,每档带自己的音频 rendition; /dash/<source>/manifest.mpd 把它们放进同一个 video AdaptationSet(多 Representation),音频取最低档。播放器在段边界切档。

MPEG-TS 输入(P-6):UDP(单播/组播)与本地文件里的 MPEG-TS 直接解复用成 H.264/H.265 + AAC 写进注册表,RTSP / RTMP / HTTP-FLV / HLS / DASH 都能拉, 也可以继续通过 SRT(P-5)或 HLS 输出 TS。

# ffmpeg 通过 UDP 推 TS(组播地址会自动加入组)
./flow -ts-udp "live/udp=239.1.1.1:5000"
ffmpeg -re -i input.mp4 -c copy -f mpegts "udp://239.1.1.1:5000?pkt_size=1316"
ffplay rtsp://127.0.0.1:8554/live/udp

# 本地文件,按 PTS 实时播放;-ts-file-loop 循环,-ts-file-rate 调速度
./flow -ts-file "live/file=clips/demo.ts" -ts-file-loop -ts-file-rate 1
ffplay rtmp://127.0.0.1:1935/live/file

多个输入用逗号、分号或换行分隔(name=host:port / name=path)。UDP 输入 超过 -ts-udp-idle(默认 10s)没有包会摘流,下一包到达时自动重新发布, 发送端重启不需要重启 flow;一个端口只应有一个发送端(原始 TS 没有会话 标识)。文件播完后摘流,-ts-file-loop 每圈把时间戳接在上一圈之后,下游 不会看到回退;文件路径里不要包含逗号或分号。

RTMP 回源(从上游拉流并在本地重新发布,供 RTSP/RTMP/HTTP-FLV 下游拉取; 上游断开后自动重连,下游保持连接):

# 拉 rtmp://upstream/live/src,本地按 relay 名字发布
./flow -pull "relay=rtmp://upstream/live/src"

# 可配置多路(逗号分隔);省略本地名时取 URL 最后一节
./flow -pull "rtmp://upstream/live/a,rtmp://upstream/live/b"
ffplay rtmp://127.0.0.1:1935/live/relay

按需回源 / 级联(-origin,S-1):本机注册表没有某路流时,按模板从上游 RTSP / RTMP / HTTP-FLV 拉流,收到首帧后以本地流名登记,RTSP / RTMP / HTTP-FLV 下游都能直接播放;上游断开后按 1s→30s 指数退避重连,本地流不 摘除,下游继续等帧。首次回源在 -origin-timeout 内拿不到媒体就回退到 404 / 本地 testdata;已经就绪的流在源站重启期间不会被放弃。

# 通配模板:本地缺 live/src 时拉 rtmp://upstream/live/src
./flow -origin rtmp://upstream/live

# 显式映射(本地名=上游 URL),可带 RTMP 拉流 token(T-3)
./flow -origin "news=rtmp://upstream/live/src?token=playsecret"

# 上游 RTSP 需要 Basic/Digest 时把凭据写进 URL
./flow -origin rtsp://user:pass@camera/live

# 多个模板逗号分隔;等待首帧的超时默认 5s
./flow -origin "rtmp://up/live,http://cdn/live" -origin-timeout 5s

RTMP / HTTP-FLV 上游的时间戳在重连时按 PTS(DTS+CTS)平移到上一连接 最大值之后,下游不会看到时间戳回退。回源流不做空闲回收,首个请求触发后 保持到进程退出。

动态源注册与发现(-discovery-url,S-3):节点把本地正在出帧的流按 TTL 租约登记到注册中心;边缘节点本地没有某路流时查询注册中心,命中就用 RTSP 302(D-1 语义)把客户端指到真正持有该流的节点。推流端停止出帧超过 -stream-idle(默认 30s)后本地注册表自动摘除,节点进程消失则由 TTL 过期兜底。

# 注册中心(独立进程,默认 :7000,租约 15s)
./registry -listen :7000 -ttl 15s

# 节点:上报自己的 RTSP/RTMP 公网地址,并启用本地空闲回收
# RTMP 地址要带 app 路径(推流/播放都是 rtmp://host:1935/live/<流名>)
./flow -node-id edge-a \
       -advertise rtsp://10.0.0.5:8554,rtmp://10.0.0.5:1935/live \
       -discovery-url http://registry:7000

# 边缘节点本地没有 live/demo 时,ffplay 会跟随 302 连到持有者
ffplay rtsp://10.0.0.6:8554/live/demo

-stream-idle 0 关闭本地回收;S-1 回源和 -pull 的流始终豁免,由各自的 重连逻辑维护。发现只做精确流名匹配;RTMP 客户端不跟随 RTSP 302。

边缘分发与负载均衡(-discovery-mode proxy,S-2):边缘节点不再只是回 302,而是直接按发现结果从持有者拉流,再以本节点流名对外服务。上游节点 宕机时,puller 在下一轮重连时重新查询注册中心并切换到其他副本,本地流 不关闭,已经连上的 RTSP / RTMP / HTTP-FLV 下游继续收帧(时间戳跨上游 平移,不会回退)。注册中心会记录每个节点的活跃观看数,查询时按负载 排序;边缘副本按 hops 登记,-discovery-max-hops(默认 1)限制级联 深度,避免拓扑无限加深。

# 推流源:上报自己的 RTSP/RTMP 地址(RTMP 基础地址带 app 路径)
./flow -node-id origin \
       -advertise rtsp://10.0.0.5:8554,rtmp://10.0.0.5:1935/live \
       -discovery-url http://registry:7000

# 边缘节点:本地没有的流直接从发现到的节点拉,失败时自动切换
./flow -node-id edge-b \
       -advertise rtsp://10.0.0.6:8554,rtmp://10.0.0.6:1935/live \
       -discovery-url http://registry:7000 \
       -discovery-mode proxy

# 客户端始终连边缘节点;节点 A 宕机后连接保持并恢复出帧
ffplay rtsp://10.0.0.6:8554/live/demo

redirect(默认)只做 RTSP 302,边缘不承担带宽;proxy 适用于 RTMP 和 HTTP-FLV(它们无法跟随 302),代价是媒体经过边缘节点。代理模式下 -advertise 可以省略(纯消费节点),但这样不会成为其他节点的候选。

从摄像头推实时 H.264(-live 表示从 stdin 读 Annex-B 裸流):

ffmpeg -f dshow -rtbufsize 100M -i video="USB Camera" \
       -c:v libx264 -preset ultrafast -tune zerolatency -f h264 pipe:1 | flow.exe -live

常用参数见 go run ./cmd/server -h(鉴权、重定向、组播、CSeq 校验等)。

压测:N 路并发 DESCRIBE/SETUP/PLAY,统计收包数、序号空洞和建连耗时; -transport udp 可切到 UDP 收流,-d 控制时长。

go run ./cmd/loadtest -url rtsp://127.0.0.1:8554/live -n 20 -d 5m

性能分析(仅回环可访问,空值关闭):

go run ./cmd/server -pprof :6060

# CPU 30s / heap / goroutine / block / mutex
curl -o cpu.pprof "http://127.0.0.1:6060/debug/pprof/profile?seconds=30"
curl -o heap.pprof "http://127.0.0.1:6060/debug/pprof/heap?gc=1"
curl "http://127.0.0.1:6060/debug/pprof/goroutine?debug=1"
curl -o block.pprof "http://127.0.0.1:6060/debug/pprof/block"
curl -o mutex.pprof "http://127.0.0.1:6060/debug/pprof/mutex"

# 浏览器里看 Top / Graph / Flame Graph
go tool pprof -http=127.0.0.1:8081 cpu.pprof

目录结构

路径 说明
cmd/server/ 服务入口:解析参数、组装媒体源、并发启动 RTSP / RTMP / HTTP-FLV 服务
cmd/loadtest/ 压测客户端:N 路并发拉流,统计收包/丢包/建连耗时
cmd/demux_test/ 裸 H.264 文件解复用的小工具
internal/rtsp/ RTSP 协议层:请求解析、会话、鉴权、SR/RR、NACK/PLI、组播等
internal/rtmp/ RTMP 协议层:握手、Chunk、AMF0、publish/play,以及回源客户端(-pull)
internal/origin/ 按需回源/级联(-origin):模板匹配、跨协议拉流、退避重连与本地缓存
internal/flvingest/ FLV tag → source.Frame(推流/回源共用),含 PTS/CTS 与跨重连时间戳平移
internal/httpflv/, internal/flvmux/ HTTP-FLV 分发与 frame→FLV Tag 封装
internal/webrtc/ WHIP/WHEP 入口:pion 负责 ICE/DTLS/SRTP,媒体桥接共享注册表
internal/snapshot/ 截图:IDR → hi264 解码 → JPEG/PNG,含缓存、并发限制与 ffmpeg 兜底
internal/rtp/ RTP 打包/解包,H.264、Opus 与 AAC
internal/rtcp/ RTCP 包解析:SR/RR、SDES、BYE、NACK
internal/rtpbuf/, internal/plc/ 接收侧抖动缓冲、丢包补偿
internal/flv/, internal/media/ FLV 封装、H.264/AAC 解复用与 SDP
internal/source/, internal/stream/, internal/session/ 媒体源抽象、共享流注册表、会话管理
test/e2e/ 端到端验收脚本
testdata/ 测试用媒体文件
docs/ 学习笔记与任务拆解

关于 Stage 1 ~ Stage 5

Stage 1 ~ Stage5 是项目早期按阶段推进的单文件练习版本,已从 dev 主线移除, 完整代码保留在 stages 分支:

git switch stages

主线只需要 cmd/ + internal/ 下的包结构,不再保留重复的历史实现。 对应的学习大纲和自测题见 docs/TASK.md。

许可证

本项目使用 MIT License。