🔉 Nginx module that generates audio track for HTTP Live Streaming (HLS) streams on the fly.
C Nginx Python
Switch branches/tags
Nothing to show
Clone or download
Latest commit 84f79f7 May 6, 2015

README.md

Nginx Audio Track for HTTP Live Streaming

This nginx module generates audio track for hls streams on the fly.

Why?

Apple HTTP Live Streaming (HLS) has being adopted for almost all video stream players, and one of their recommendations is to serve an audio-only track to users that have experiencing bad bandwidth connections.

This module aims to serve audio-only track directly on nginx, without the necessity to pre-demux the stream on Video On Demand (VoD) scenarios or the overhead and occupation of one stream output on the encoder side for live streams.

How?

Using a combination of nginx locations with simple scripts written in Lua and this module, it's possible to generate the entire audio track on Nginx. Look at how things are done.

A viewer requests the master playlist, and the response is modified. A simple lua script gets the first stream of the list and add an audio-playlist at the end:

location ~ /master-playlist.m3u8$ {
    rewrite (.*)master-playlist.m3u8$ $1playlist.m3u8 break;
    content_by_lua '
        local res = ngx.location.capture(ngx.var.uri);
        local first_playlist = res.body:match("[^\\n]*m3u8")
        local audio_playlist = first_playlist:gsub("\.m3u8", "-audio.m3u8")
        local ext_inf = "#EXT-X-STREAM-INF:PROGRAM-ID=1,BANDWIDTH=64000\\n"
        ngx.print(res.body)
        ngx.print(ext_inf)
        ngx.print(audio_playlist)
        ngx.print("\\n")
    ';
}

Then, when user's connection goes bad and he needs to go to the audio target, another location will handle the request, getting the original (video) playlist and changing the extension of the chunks:

location ~ -audio\.m3u8$ {
    default_type application/vnd.apple.mpegurl;
    content_by_lua '
        local base_m3u8_url = ngx.var.uri:gsub("-audio.m3u8", ".m3u8")
        local res = ngx.location.capture(base_m3u8_url)
        local new_body = res.body:gsub("\.ts", ".aac")
        ngx.print(new_body)
    ';
 }

Every request for .aac extensions will invoke audio extract module:

location ~ (\.aac)$ {
    ngx_hls_audio_track;
    ngx_hls_audio_track_rootpath "/path/were/video/chunks/are/";
    ngx_hls_audio_track_output_format "adts";
    ngx_hls_audio_track_output_header "audio/aac";
    
    expires 10m;
}

That's it!

You can select the output format for the chunks. All formats that you avformat library support are allowed. To show all formats supported in your instalattion, exec "ffprobe -formats" on your system.

For example, to return mpegts with only audio stream:

location ~ -audio\.m3u8$ {
    default_type application/vnd.apple.mpegurl;
    content_by_lua '
        local base_m3u8_url = ngx.var.uri:gsub("-audio.m3u8", ".m3u8")
        local res = ngx.location.capture(base_m3u8_url)
        local new_body = res.body:gsub("\.ts", "-audio.ts")
        ngx.print(new_body)
    ';
 }

Every request for -audio.ts files will invoke audio extract module:

location ~ (-audio\.ts)$ {
    rewrite ^(.*)-audio\.ts$ /$1.ts break;

    ngx_hls_audio_track;
    ngx_hls_audio_track_rootpath "/path/were/video/chunks/are/";
    ngx_hls_audio_track_output_format "mpegts";
    ngx_hls_audio_track_output_header "video/MP2T";
    
    expires 10m;
}

Status

This module is under development, but production ready. Feedbacks, issues and patches are welcome.

Requirements

This module depends from some libraries (headers and shared objects) which has to be installed before it:

  • avformat >= 55.0.0 (tested version: 55.0.0) - commonly distributed with FFmpeg
  • avcodec >= 55.3.0 (tested version: 55.3.0) - commonly distributed with FFmpeg
  • avutil >= 52.10.0 (tested version: 52.10.0) - commonly distributed with FFmpeg

Supported Formats

For now, the audio extractor module only supports extraction from mpegts video chunks to aac audio-only chunks.

Look at project issues to see which other formats are going to be supported in the future.

Installation

Follow the steps:

  • Clone this project
$ git clone git://github.com/flavioribeiro/nginx-audio-track-for-hls-module.git
$ git clone git://github.com/chaoslawful/lua-nginx-module.git
  • Download nginx and compile it using both modules:
$ ./configure --add-module=/path/to/nginx-audio-track-for-hls-module --add-module=/path/to/lua-nginx-module
$ make install

Now you can look at our nginx configuration example and make your changes. Have fun!

Warning

It is high recommended to use caching in all locations of HLS, in special the one that returns the generated .aac.

License

Copyright (C) 2013-2015 Flávio Ribeiro < email at flavioribeiro.com >

Nginx Audio Track For HLS Module is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Nginx Audio Track For HLS Module is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Nginx Audio Track For HLS Module. If not, see http://www.gnu.org/licenses/.

All files in Nginx Audio Track For HLS Module are under GPL unless otherwise noted in file's header. Some files may be sublicensed.

Free Software, Fuck Yeah!