arut/nginx-rtmp-module
GitHub: arut/nginx-rtmp-module
基于 nginx 的流媒体服务器模块,提供 RTMP/HLS/MPEG-DASH 协议的直播与点播能力。
Stars: 14024 | Forks: 3591
# 基于 NGINX 的流媒体服务器
## nginx-rtmp-module
### 项目博客
http://nginx-rtmp.blogspot.com
### Wiki 手册
https://github.com/arut/nginx-rtmp-module/wiki/Directives
### Google 讨论组
https://groups.google.com/group/nginx-rtmp
https://groups.google.com/group/nginx-rtmp-ru (俄语)
### 功能特性
* RTMP/HLS/MPEG-DASH 直播
* RTMP 视频点播 FLV/MP4,
支持从本地文件系统或 HTTP 播放
* 支持分布式流媒体推流:push 与 pull 模型
* 将流录制为多个 FLV 文件
* 支持 H264/AAC
* 使用 FFmpeg 进行在线转码
* HTTP 回调(发布/播放/录制/更新等)
* 在特定事件下运行外部程序(exec)
* 用于录制音频/视频和断开客户端连接的 HTTP 控制模块
* 高级缓冲技术,
将内存分配保持在最低
水平,以实现更快的流媒体传输和
更低的内存占用
* 已验证可与 Wirecast、FMS、Wowza、
JWPlayer、FlowPlayer、StrobeMediaPlayback、
ffmpeg、avconv、rtmpdump、flvstreamer
等众多工具配合使用
* 以 XML/XSL 格式输出机器可读和人类可读的
统计数据
* Linux/FreeBSD/MacOS/Windows
### 构建
进入 NGINX 源码目录并运行以下命令:
```
./configure --add-module=/path/to/nginx-rtmp-module
make
make install
```
某些版本的 nginx(1.3.14 - 1.5.0)还需要添加 http_ssl_module:
```
./configure --add-module=/path/to/nginx-rtmp-module --with-http_ssl_module
```
要构建 nginx 的 debug 版本,请添加 `--with-debug`
```
./configure --add-module=/path/to-nginx/rtmp-module --with-debug
```
[阅读更多关于 debug log 的信息](https://github.com/arut/nginx-rtmp-module/wiki/Debug-log)
### Windows 限制
Windows 支持有限。以下功能不受支持
* execs
* static pulls
* auto_push
### RTMP URL 格式
```
rtmp://rtmp.example.com/app[/name]
```
app - 应与配置中的某个 application {}
块匹配
name - 由各 application 自行解释
可以为空
### 多 worker 直播
该模块通过自动将流推送给 nginx workers 来支持多 worker 直播。此选项通过
rtmp_auto_push 指令进行切换。
### nginx.conf 示例
```
rtmp {
server {
listen 1935;
chunk_size 4000;
# TV mode: one publisher, many subscribers
application mytv {
# enable live streaming
live on;
# record first 1K of stream
record all;
record_path /tmp/av;
record_max_size 1K;
# append current timestamp to each flv
record_unique on;
# publish only from localhost
allow publish 127.0.0.1;
deny publish all;
#allow play all;
}
# Transcoding (ffmpeg needed)
application big {
live on;
# On every pusblished stream run this command (ffmpeg)
# with substitutions: $app/${app}, $name/${name} for application & stream name.
#
# This ffmpeg call receives stream from this application &
# reduces the resolution down to 32x32. The stream is the published to
# 'small' application (see below) under the same name.
#
# ffmpeg can do anything with the stream like video/audio
# transcoding, resizing, altering container/codec params etc
#
# Multiple exec lines can be specified.
exec ffmpeg -re -i rtmp://localhost:1935/$app/$name -vcodec flv -acodec copy -s 32x32
-f flv rtmp://localhost:1935/small/${name};
}
application small {
live on;
# Video with reduced resolution comes here from ffmpeg
}
application webcam {
live on;
# Stream from local webcam
exec_static ffmpeg -f video4linux2 -i /dev/video0 -c:v libx264 -an
-f flv rtmp://localhost:1935/webcam/mystream;
}
application mypush {
live on;
# Every stream published here
# is automatically pushed to
# these two machines
push rtmp1.example.com;
push rtmp2.example.com:1934;
}
application mypull {
live on;
# Pull all streams from remote machine
# and play locally
pull rtmp://rtmp3.example.com pageUrl=www.example.com/index.html;
}
application mystaticpull {
live on;
# Static pull is started at nginx start
pull rtmp://rtmp4.example.com pageUrl=www.example.com/index.html name=mystream static;
}
# video on demand
application vod {
play /var/flvs;
}
application vod2 {
play /var/mp4s;
}
# Many publishers, many subscribers
# no checks, no recording
application videochat {
live on;
# The following notifications receive all
# the session variables as well as
# particular call arguments in HTTP POST
# request
# Make HTTP request & use HTTP retcode
# to decide whether to allow publishing
# from this connection or not
on_publish http://localhost:8080/publish;
# Same with playing
on_play http://localhost:8080/play;
# Publish/play end (repeats on disconnect)
on_done http://localhost:8080/done;
# All above mentioned notifications receive
# standard connect() arguments as well as
# play/publish ones. If any arguments are sent
# with GET-style syntax to play & publish
# these are also included.
# Example URL:
# rtmp://localhost/myapp/mystream?a=b&c=d
# record 10 video keyframes (no audio) every 2 minutes
record keyframes;
record_path /tmp/vc;
record_max_frames 10;
record_interval 2m;
# Async notify about an flv recorded
on_record_done http://localhost:8080/record_done;
}
# HLS
# For HLS to work please create a directory in tmpfs (/tmp/hls here)
# for the fragments. The directory contents is served via HTTP (see
# http{} section in config)
#
# Incoming stream must be in H264/AAC. For iPhones use baseline H264
# profile (see ffmpeg example).
# This example creates RTMP stream from movie ready for HLS:
#
# ffmpeg -loglevel verbose -re -i movie.avi -vcodec libx264
# -vprofile baseline -acodec libmp3lame -ar 44100 -ac 1
# -f flv rtmp://localhost:1935/hls/movie
#
# If you need to transcode live stream use 'exec' feature.
#
application hls {
live on;
hls on;
hls_path /tmp/hls;
}
# MPEG-DASH is similar to HLS
application dash {
live on;
dash on;
dash_path /tmp/dash;
}
}
}
# 可以使用 HTTP 访问 RTMP 统计信息
http {
server {
listen 8080;
# This URL provides RTMP statistics in XML
location /stat {
rtmp_stat all;
# Use this stylesheet to view XML as web page
# in browser
rtmp_stat_stylesheet stat.xsl;
}
location /stat.xsl {
# XML stylesheet to view RTMP stats.
# Copy stat.xsl wherever you want
# and put the full directory path here
root /path/to/stat.xsl/;
}
location /hls {
# Serve HLS fragments
types {
application/vnd.apple.mpegurl m3u8;
video/mp2t ts;
}
root /tmp;
add_header Cache-Control no-cache;
}
location /dash {
# Serve DASH fragments
root /tmp;
add_header Cache-Control no-cache;
}
}
}
```
### 多 worker 流媒体传输示例
```
rtmp_auto_push on;
rtmp {
server {
listen 1935;
application mytv {
live on;
}
}
}
```
标签:FFmpeg, HLS, Nginx模块, RTMP, 客户端加密, 流媒体服务器, 直播技术, 负责任AI, 音视频开发