feat: add hls support

Dockerfile

@@ -33,6 +33,7 @@ RUN set -eux \
     && install --directory --owner=${USER} /etc/libretime /srv/libretime
 
 ENV LIBRETIME_CONFIG_FILEPATH=/etc/libretime/config.yml
+ENV LIBRETIME_OUTPUT_PATH=/var/playout/hls
 
 # Shared packages
 COPY tools/packages.py /tmp/packages.py
@@ -124,6 +125,9 @@ COPY playout .
 RUN --mount=type=cache,target=/root/.cache/pip \
     pip install --editable .[sentry]
 
+RUN mkdir -p $LIBRETIME_OUTPUT_PATH
+RUN chown ${USER}:${USER} $LIBRETIME_OUTPUT_PATH
+
 # Run
 USER ${UID}:${GID}
 WORKDIR /app

dev/config.yml

@@ -43,29 +43,53 @@ stream:
 
     icecast:
       - <<: *default_icecast_output
-        enabled: true
+        enabled: false
         mount: main.ogg
         public_url: https://localhost:8443/main.ogg
         audio:
           format: ogg
           bitrate: 256
 
       - <<: *default_icecast_output
-        enabled: true
+        enabled: false
         mount: main.opus
         public_url: https://localhost:8443/main.opus
         audio:
           format: opus
           bitrate: 256
 
       - <<: *default_icecast_output
-        enabled: true
+        enabled: false
         mount: main.mp3
         public_url: https://localhost:8443/main.mp3
         audio:
           format: mp3
           bitrate: 256
 
+    hls:
+      - enabled: true
+        segment_duration: 2.0
+        segment_count: 5
+        segments_overhead: 5
+        public_url:
+        manifest: main.m3u8
+        streams:
+          - segments_prefix: mp3_low
+            codec: libmp3lame
+            bitrate: 32k
+            sample_rate: 44100
+            format: mpegts
+          - segments_prefix: mp3_med
+            format: mpegts
+            codec: libmp3lame
+            bitrate: 128k
+            sample_rate: 44100
+          - segments_prefix: mp3_hifi
+            format: mpegts
+            codec: libmp3lame
+            bitrate: 256k
+            sample_rate: 44100
+
     system:
       - enabled: false
         kind: pulseaudio

docker-compose.yml

@@ -47,6 +47,7 @@ services:
     volumes:
       - ${LIBRETIME_CONFIG_FILEPATH:-./config.yml}:/etc/libretime/config.yml:ro
       - libretime_playout:/app
+      - libretime_playout_hls:/var/playout/hls
     environment:
       LIBRETIME_GENERAL_PUBLIC_URL: http://nginx:8080
 
@@ -110,6 +111,7 @@ services:
       - libretime_assets:/var/www/html:ro
       - libretime_storage:/srv/libretime:ro
       - ${NGINX_CONFIG_FILEPATH:-./nginx.conf}:/etc/nginx/conf.d/default.conf:ro
+      - libretime_playout_hls:/var/playout/hls:ro
 
   icecast:
     image: ghcr.io/libretime/icecast:2.4.4
@@ -125,3 +127,4 @@ volumes:
   libretime_storage: {}
   libretime_assets: {}
   libretime_playout: {}
+  libretime_playout_hls: {}

docker/config.template.yml

@@ -317,6 +317,48 @@ stream:
         # > default is false
         mobile: false
 
+    hls:
+      - # Whether the output is enabled.
+        # > default is false
+        enabled: true
+        # > segment_duration  (default:2.0)
+        segment_duration: 2.0
+        # > segments count  (default:5)
+        segment_count: 5
+        # > segments_overhead (default:5)
+        segments_overhead: 5
+        # Output public url, If not defined, the value will be generated from
+        # the [general.public_url] hostname, the output port and mount.
+        public_url:
+        # hls mount point
+        # > this field is REQUIRED
+        manifest: main.m3u8
+        streams:
+          - # > prefix of generated fragment
+            # > this field is REQUIRED
+            segments_prefix: mp3_low
+            # > must be one of ('mpegts', 'adts')
+            # > this field is REQUIRED
+            format: mpegts
+            # > codec must be one of ('libmp3lame', 'aac')
+            # > this field is REQUIRED
+            codec: libmp3lame
+            # > bitrate of the stream
+            # > this field is REQUIRED
+            bitrate: 32k
+            # > sampling rate (default: 44100Hz)
+            sample_rate: 44100
+          - segments_prefix: mp3_med
+            format: mpegts
+            codec: libmp3lame
+            bitrate: 128k
+            sample_rate: 44100
+          - segments_prefix: mp3_hifi
+            format: mpegts
+            codec: libmp3lame
+            bitrate: 256k
+            sample_rate: 44100
+
     # System outputs.
     # > max items is 1
     system:

docker/config.yml

@@ -317,6 +317,48 @@ stream:
         # > default is false
         mobile: false
 
+    hls:
+      - # Whether the output is enabled.
+        # > default is false
+        enabled: true
+        # > segment_duration  (default:2.0)
+        segment_duration: 2.0
+        # > segments count  (default:5)
+        segment_count: 5
+        # > segments_overhead (default:5)
+        segments_overhead: 5
+        # Output public url, If not defined, the value will be generated from
+        # the [general.public_url] hostname, the output port and mount.
+        public_url:
+        # hls mount point
+        # > this field is REQUIRED
+        manifest: main.m3u8
+        streams:
+          - # > prefix of generated fragment
+            # > this field is REQUIRED
+            segments_prefix: mp3_low
+            # > must be one of ('mpegts', 'adts')
+            # > this field is REQUIRED
+            format: mpegts
+            # > codec must be one of ('libmp3lame', 'aac')
+            # > this field is REQUIRED
+            codec: libmp3lame
+            # > bitrate of the stream
+            # > this field is REQUIRED
+            bitrate: 32k
+            # > sampling rate (default: 44100Hz)
+            sample_rate: 44100
+          - segments_prefix: mp3_med
+            format: mpegts
+            codec: libmp3lame
+            bitrate: 128k
+            sample_rate: 44100
+          - segments_prefix: mp3_hifi
+            format: mpegts
+            codec: libmp3lame
+            bitrate: 256k
+            sample_rate: 44100
+
     # System outputs.
     # > max items is 1
     system:

docker/example/config.yml

@@ -317,6 +317,48 @@ stream:
         # > default is false
         mobile: false
 
+    hls:
+      - # Whether the output is enabled.
+        # > default is false
+        enabled: true
+        # > segment_duration  (default:2.0)
+        segment_duration: 2.0
+        # > segments count  (default:5)
+        segment_count: 5
+        # > segments_overhead (default:5)
+        segments_overhead: 5
+        # Output public url, If not defined, the value will be generated from
+        # the [general.public_url] hostname, the output port and mount.
+        public_url:
+        # hls mount point
+        # > this field is REQUIRED
+        manifest: main.m3u8
+        streams:
+          - # > prefix of generated fragment
+            # > this field is REQUIRED
+            segments_prefix: mp3_low
+            # > must be one of ('mpegts', 'adts')
+            # > this field is REQUIRED
+            format: mpegts
+            # > codec must be one of ('libmp3lame', 'aac')
+            # > this field is REQUIRED
+            codec: libmp3lame
+            # > bitrate of the stream
+            # > this field is REQUIRED
+            bitrate: 32k
+            # > sampling rate (default: 44100Hz)
+            sample_rate: 44100
+          - segments_prefix: mp3_med
+            format: mpegts
+            codec: libmp3lame
+            bitrate: 128k
+            sample_rate: 44100
+          - segments_prefix: mp3_hifi
+            format: mpegts
+            codec: libmp3lame
+            bitrate: 256k
+            sample_rate: 44100
+
     # System outputs.
     # > max items is 1
     system:

docker/nginx.conf

@@ -9,6 +9,10 @@ server {
   client_max_body_size 512M;
   client_body_timeout 300s;
 
+  location /hls {
+     alias /var/playout/hls;
+  }
+
   location ~ \.php$ {
     fastcgi_buffers 64 4K;
     fastcgi_split_path_info ^(.+\.php)(/.+)$;

docs/admin-manual/configuration.md

@@ -392,6 +392,7 @@ stream:
   outputs:
     icecast: # See the [stream.outputs.icecast] section.
     shoutcast: # See the [stream.outputs.shoutcast] section.
+    hls: # See the [stream.outputs.hls] section.
     system: # See the [stream.outputs.system] section.
 ```
 
@@ -535,6 +536,65 @@ stream:
         mobile: false
 ```
 
+#### Hls
+
+The `stream.outputs.hls` section configures the HLS output streams.
+
+HLS is an HTTP-based adaptive bitrate streaming protocol.
+
+It consists on presenting multiple streams with varying qualities to the client player which select the most fitted to its bandwidth.
+
+To configure hls streams, first describe the container of these streams by its **format**.
+
+Then setup the composites streams with various **codec**s and **bitrate**s.
+
+:::warning
+
+For security purposes, liquidsoap produces hls files in the webserver mount point **hls/** instead of creating its own.
+
+```yml
+stream:
+  outputs:
+    # Shoutcast output streams.
+    # > max items is 1
+    hls:
+      - # Whether the output is enabled.
+        # > default is false
+        enabled: true
+        # > segment_duration  (default:2.0)
+        segment_duration: 2.0
+        # > segments count  (default:5)
+        segment_count: 5
+        # > segments_overhead (default:5)
+        segments_overhead: 5
+        # Output public url, If not defined, the value will be generated from
+        # the [general.public_url] hostname, the output port and mount.
+        public_url:
+        # hls mount point
+        # > this field is REQUIRED
+        manifest: main.m3u8
+        streams:
+          - # > prefix of generated fragment
+            # > this field is REQUIRED
+            segments_prefix: mp3_low
+            # > must be one of ('mpegts', 'adts')
+            # > this field is REQUIRED
+            format: mpegts
+            # > codec must be one of ('libmp3lame', 'aac')
+            # > this field is REQUIRED
+            codec: libmp3lame
+            # > bitrate of the stream
+            # > this field is REQUIRED
+            bitrate: 32k
+            # > sampling rate (default: 44100Hz)
+            sample_rate: 44100
+          - segments_prefix: mp3_hifi
+            format: mpegts
+            codec: libmp3lame
+            bitrate: 256k
+            sample_rate: 44100
+```
+
 #### System
 
 The `stream.outputs.system` section configures the system outputs.