nginx-rtmp-module README

The project's README from github.com/arut/nginx-rtmp-module. As one markdown file: README.md.

NGINX-based Media Streaming Server

nginx-rtmp-module

Project blog

http://nginx-rtmp.blogspot.com

Wiki manual

https://github.com/arut/nginx-rtmp-module/wiki/Directives

Google group

https://groups.google.com/group/nginx-rtmp

https://groups.google.com/group/nginx-rtmp-ru (Russian)

Donation page (Paypal etc)

http://arut.github.com/nginx-rtmp-module/

Features

Build

cd to NGINX source directory & run this:

./configure --add-module=/path/to/nginx-rtmp-module
make
make install

Several versions of nginx (1.3.14 - 1.5.0) require http_ssl_module to be added as well:

./configure --add-module=/path/to/nginx-rtmp-module --with-http_ssl_module

For building debug version of nginx add --with-debug

./configure --add-module=/path/to-nginx/rtmp-module --with-debug

Read more about debug log

Windows limitations

Windows support is limited. These features are not supported

RTMP URL format

rtmp://rtmp.example.com/app[/name]

app - should match one of application {} blocks in config

name - interpreted by each application can be empty

Multi-worker live streaming

Module supports multi-worker live streaming through automatic stream pushing to nginx workers. This option is toggled with rtmp_auto_push directive.

Example 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 can be used for accessing RTMP stats
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;
        }
    }
}

Multi-worker streaming example

rtmp_auto_push on;

rtmp {
    server {
        listen 1935;

        application mytv {
            live on;
        }
    }
}

nginx-rtmp-module (arut/nginx-rtmp-module)

Searching Database…

14K ·GitHub
Nginx-rtmp-module
这是什么？nginx-rtmp-module 可以把 NGINX 变成流媒体服务器，支持 RTMP、HLS 和 MPEG-DASH 直播，还支持通过 RTMP 点播播放 FLV/MP4 文件。
它是独立的流媒体服务器，还是 NGINX 的插件？它是一个 C 语言源码模块，通过 NGINX 自己的构建系统直接编译进 NGINX 的源码树中，没有单独的可执行文件。
我该怎么把它添加到 NGINX 里？将模块源码放在 NGINX 源码旁边，然后在 NGINX 源码目录中依次运行 ./configure --add-module=/path/to/nginx-rtmp-module、make、make install。较旧的 NGINX 版本 1.3.14-1.5.0 还需要加上 --with-httpsslmodule。
我需要 FFmpeg 做什么吗？只有需要转码时才需要：exec 指令可以调用 FFmpeg（或 avconv）来调整分辨率、重新编码或重新推送直播流。
在 Windows 上所有功能都一样吗？不一样。在 Windows 上不支持 exec 命令、静态拉流（static pulls）和自动 worker 推流（autopush）。
哪些操作系统可以运行它？它可以在 Linux、FreeBSD、macOS 和 Windows 上构建和运行，但 Windows 有上面提到的限制。
我怎样查看直播统计数据？该模块提供一个 HTTP 统计接口，以 XML 格式返回 RTMP 统计信息，可以借助自带的 stat.xsl 样式表在浏览器中显示为易读的页面。
直播流可以在多台 nginx 服务器之间转发吗？可以。push 和 pull 指令可以让应用把接收到的直播流转发到远程 RTMP 服务器，或从远程服务器拉取直播流，从而搭建分布式直播架构。
它能在多个 NGINX worker 进程之间扩展吗？可以。rtmp_auto_push 指令会自动把发布的直播流推送到每个 NGINX worker，使观众的请求在各个 worker 之间实现负载均衡。
直播开始或结束时，我可以触发自定义逻辑吗？可以。onpublish、onplay、onrecorddone 等 HTTP 回调，以及 exec 指令，可以让你在发布、播放、录制和断开连接等事件发生时运行外部程序或发起 HTTP 请求。
What are similar projects?livego, srs, FFmpeg, go2rtc, ZLMediaKit, owncast, mediamtx, GSYVideoPlayer
Which topics is it in?mp4, streams, relay, rtmp, recording, hls, live-streaming, nginx, web-server, video-streaming, freebsd, hooks
Creator
arut
Size
3.1 MB
Stars
14K
Updated
CommitDec 24
Age
14y
Commits · 90 Days