Module ngx_http_hls_module

ngx_http_hls_module模块为 MP4 和 MOV 媒体文件提供 HTTP 实时流(HLS)服务器端支持。此类文件通常具有.mp4.m4v.m4a.mov.qt文件 extensions。该模块支持 H.264 视频编解码器,AAC 和 MP3 音频编解码器。

对于每个媒体文件,都支持两个 URI:

  • extensions 为“ .m3u8”的播放列表 URI。 URI 可以接受可选参数:

  • start”和“ end”以秒为单位定义播放列表边界(1.9.0)。

    • offset”将初始播放位置移动到以秒为单位的时间偏移量(1.9.0)。正值设置从播放列表开始的时间偏移。负值设置与播放列表中最后一个片段的末尾的时间偏移。

    • len”以秒为单位定义片段长度。

  • extensions 为“ .ts”的片段 URI。 URI 可以接受可选参数:

  • start”和“ end”以秒为单位定义片段边界。

Note

此模块可作为commercial subscription的一部分使用。

Example Configuration

location / {
    hls;
    hls_fragment            5s;
    hls_buffers             10 10m;
    hls_mp4_buffer_size     1m;
    hls_mp4_max_buffer_size 5m;
    root /var/video/;
}

使用此配置,“ /var/video/test.mp4”文件支持以下 URI:

http://hls.example.com/test.mp4.m3u8?offset=1.000&start=1.000&end=2.200
http://hls.example.com/test.mp4.m3u8?len=8.000
http://hls.example.com/test.mp4.ts?start=1.000&end=2.200

Directives

Syntax:hls;
Default:
Context:location

打开周围位置的 HLS 流。

Syntax:hls_buffers number size;
Default:hls_buffers 8 2m;
Context:http , server , location

设置用于读取和写入数据帧的缓冲区的最大numbersize

Syntax:hls_forward_args on | off;
Default:hls_forward_args off;
Context:http , server , location

该指令出现在 1.5.12 版本中。

将来自播放列表请求的参数添加到片段的 URI。这对于在请求片段时或在使用ngx_http_secure_link_module模块保护 HLS 流时执行客户端授权很有用。

例如,如果客户端请求播放列表http://example.com/hls/test.mp4.m3u8?a=1&b=2,则参数a=1b=2将被添加到片段 URI 的参数startend之后:

#EXTM3U
#EXT-X-VERSION:3
#EXT-X-TARGETDURATION:15
#EXT-X-PLAYLIST-TYPE:VOD

#EXTINF:9.333,
test.mp4.ts?start=0.000&end=9.333&a=1&b=2
#EXTINF:7.167,
test.mp4.ts?start=9.333&end=16.500&a=1&b=2
#EXTINF:5.416,
test.mp4.ts?start=16.500&end=21.916&a=1&b=2
#EXTINF:5.500,
test.mp4.ts?start=21.916&end=27.416&a=1&b=2
#EXTINF:15.167,
test.mp4.ts?start=27.416&end=42.583&a=1&b=2
#EXTINF:9.626,
test.mp4.ts?start=42.583&end=52.209&a=1&b=2

#EXT-X-ENDLIST

如果 HLS 流受ngx_http_secure_link_module模块保护,则$uri不应在secure_link_md5表达式中使用,因为这会在请求片段时导致错误。应该使用Base URI而不是$uri(在示例中为$hls_uri):

http {
    ...

    map $uri $hls_uri {
        ~^(?<base_uri>.*).m3u8$ $base_uri;
        ~^(?<base_uri>.*).ts$   $base_uri;
        default                 $uri;
    }

    server {
        ...

        location /hls/ {
            hls;
            hls_forward_args on;

            alias /var/videos/;

            secure_link $arg_md5,$arg_expires;
            secure_link_md5 "$secure_link_expires$hls_uri$remote_addr secret";

            if ($secure_link = "") {
                return 403;
            }

            if ($secure_link = "0") {
                return 410;
            }
        }
    }
}

Syntax:hls_fragment time;
Default:hls_fragment 5s;
Context:http , server , location

为没有“ len”参数的请求播放列表 URI 定义默认片段长度。

Syntax:hls_mp4_buffer_size size;
Default:hls_mp4_buffer_size 512k;
Context:http , server , location

设置用于处理 MP4 和 MOV 文件的缓冲区的初始size

Syntax:hls_mp4_max_buffer_size size;
Default:hls_mp4_max_buffer_size 10m;
Context:http , server , location

在元数据处理期间,可能需要更大的缓冲区。它的大小不能超过指定的size,否则 nginx 将返回服务器错误 500(内部服务器错误),并记录以下消息:

"/some/movie/file.mp4" mp4 moov atom is too large:
12583268, you may want to increase hls_mp4_max_buffer_size