feat: add hls support

docker/config.template.yml

@@ -317,6 +317,53 @@ stream:
         # > default is false
         mobile: false
 
+    hls:
+      - # Whether the output is enabled.
+        # > default is false
+        enabled: true
+        # > must be one of ('mpegts', 'mp3', 'adts', 'mp4')
+        # > this field is REQUIRED
+        format: mpegts
+        # > 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:
+        # web server host.
+        # > default is localhost
+        host: localhost
+        # webs server server port.
+        # > default is 80
+        port: 80
+        # hls mount point
+        # > this field is REQUIRED
+        mount: hls/main
+        streams:
+          - # > prefix of generated fragment
+            # > this field is REQUIRED
+            fragment_prefix: mp3_low
+            # > must be one of ( 'libmp3lame', 'flac', 'aac', 'libopus', 'libvorbis')
+            # > this field is REQUIRED
+            codec: libmp3lame
+            # > bitrate of the stream
+            # > this field is REQUIRED
+            bitrate: 32k
+            # > sampling rate (default: 44100Hz)
+            sample_rate: 44100
+          - fragment_prefix: mp3_med
+            codec: libmp3lame
+            bitrate: 128k
+          - fragment_prefix: mp3_hifi
+            codec: libmp3lame
+            bitrate: 256k
+        # Whether the stream should be used for mobile devices.
+        # > default is false
+        mobile: false
+
     # System outputs.
     # > max items is 1
     system:

docker/config.yml

@@ -317,6 +317,53 @@ stream:
         # > default is false
         mobile: false
 
+    hls:
+      - # Whether the output is enabled.
+        # > default is false
+        enabled: true
+        # > must be one of ('mpegts', 'mp3', 'adts', 'mp4')
+        # > this field is REQUIRED
+        format: mpegts
+        # > 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:
+        # web server host.
+        # > default is localhost
+        host: localhost
+        # webs server server port.
+        # > default is 80
+        port: 80
+        # hls mount point
+        # > this field is REQUIRED
+        mount: hls/main
+        streams:
+          - # > prefix of generated fragment
+            # > this field is REQUIRED
+            fragment_prefix: mp3_low
+            # > must be one of ( 'libmp3lame', 'flac', 'aac', 'libopus', 'libvorbis')
+            # > this field is REQUIRED
+            codec: libmp3lame
+            # > bitrate of the stream
+            # > this field is REQUIRED
+            bitrate: 32k
+            # > sampling rate (default: 44100Hz)
+            sample_rate: 44100
+          - fragment_prefix: mp3_med
+            codec: libmp3lame
+            bitrate: 128k
+          - fragment_prefix: mp3_hifi
+            codec: libmp3lame
+            bitrate: 256k
+        # Whether the stream should be used for mobile devices.
+        # > default is false
+        mobile: false
+
     # System outputs.
     # > max items is 1
     system:

docker/example/config.yml

@@ -317,6 +317,53 @@ stream:
         # > default is false
         mobile: false
 
+    hls:
+      - # Whether the output is enabled.
+        # > default is false
+        enabled: true
+        # > must be one of ('mpegts', 'mp3', 'adts', 'mp4')
+        # > this field is REQUIRED
+        format: mpegts
+        # > 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:
+        # web server host.
+        # > default is localhost
+        host: localhost
+        # webs server server port.
+        # > default is 80
+        port: 80
+        # hls mount point
+        # > this field is REQUIRED
+        mount: hls/main
+        streams:
+          - # > prefix of generated fragment
+            # > this field is REQUIRED
+            fragment_prefix: mp3_low
+            # > must be one of ( 'libmp3lame', 'flac', 'aac', 'libopus', 'libvorbis')
+            # > this field is REQUIRED
+            codec: libmp3lame
+            # > bitrate of the stream
+            # > this field is REQUIRED
+            bitrate: 32k
+            # > sampling rate (default: 44100Hz)
+            sample_rate: 44100
+          - fragment_prefix: mp3_med
+            codec: libmp3lame
+            bitrate: 128k
+          - fragment_prefix: mp3_hifi
+            codec: libmp3lame
+            bitrate: 256k
+        # Whether the stream should be used for mobile devices.
+        # > default is false
+        mobile: false
+
     # System outputs.
     # > max items is 1
     system:

install

@@ -628,6 +628,7 @@ link_python_app libretime-playout-notify
 
 info "creating libretime-playout working directory"
 mkdir_and_chown "$LIBRETIME_USER" "$WORKING_DIR/playout"
+mkdir_and_chown "$LIBRETIME_USER" "$WORKING_DIR/playout/hls"
 
 install_service "libretime-liquidsoap.service" "$SCRIPT_DIR/playout/install/systemd/libretime-liquidsoap.service"
 install_service "libretime-playout.service" "$SCRIPT_DIR/playout/install/systemd/libretime-playout.service"

installer/config.yml

@@ -317,6 +317,53 @@ stream:
         # > default is false
         mobile: false
 
+    hls:
+      - # Whether the output is enabled.
+        # > default is false
+        enabled: true
+        # > must be one of ('mpegts', 'mp3', 'adts', 'mp4')
+        # > this field is REQUIRED
+        format: mpegts
+        # > 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:
+        # web server host.
+        # > default is localhost
+        host: localhost
+        # webs server server port.
+        # > default is 80
+        port: 80
+        # hls mount point
+        # > this field is REQUIRED
+        mount: hls/main
+        streams:
+          - # > prefix of generated fragment
+            # > this field is REQUIRED
+            fragment_prefix: mp3_low
+            # > must be one of ( 'libmp3lame', 'flac', 'aac', 'libopus', 'libvorbis')
+            # > this field is REQUIRED
+            codec: libmp3lame
+            # > bitrate of the stream
+            # > this field is REQUIRED
+            bitrate: 32k
+            # > sampling rate (default: 44100Hz)
+            sample_rate: 44100
+          - fragment_prefix: mp3_med
+            codec: libmp3lame
+            bitrate: 128k
+          - fragment_prefix: mp3_hifi
+            codec: libmp3lame
+            bitrate: 256k
+        # Whether the stream should be used for mobile devices.
+        # > default is false
+        mobile: false
+
     # System outputs.
     # > max items is 1
     system:

installer/nginx/libretime.conf

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

legacy/application/configs/conf.php

@@ -204,6 +204,37 @@ public function getConfigTreeBuilder()
             /*  */->booleanNode('mobile')->defaultFalse()->end()
             /**/->end()->end()->end()
 
+            // Hls outputs
+            /**/->arrayNode('hls')->arrayPrototype()->children()
+            /*  */->arrayNode('streams')->arrayPrototype()->children()
+            /*       */->scalarNode('fragment_prefix')->end()
+            /*       */->scalarNode('bitrate')->isRequired()->end()
+            /*       */->IntegerNode('sample_rate')->defaultValue(44100)->end()
+            /*       */->scalarNode('codec')->cannotBeEmpty()
+            /*        */->validate()->ifNotInArray(['aac', 'libmp3lame', 'flac', 'libopus', 'libvorbis'])
+            /*        */->thenInvalid('invalid stream.outputs.hls.streams.codec %s')
+            /*        */->end()
+            /*    */->end()
+            /*  */->end()->end()->end()
+            /*  */->scalarNode('format')->cannotBeEmpty()
+            /*        */->validate()->ifNotInArray(['mpegts', 'mp3', 'adts', 'mp4'])
+            /*        */->thenInvalid('invalid stream.outputs.hls.format %s')
+            /*        */->end()
+            /*    */->end()
+            /*  */->floatNode('segment_duration')->defaultValue(2.0)->end()
+            /*  */->integerNode('segment_count')->defaultValue(5)->end()
+            /*  */->integerNode('segments_overhead')->defaultValue(5)->end()
+            /*  */->booleanNode('enabled')->defaultFalse()->end()
+
+            /*  */->enumNode('kind')->values(['hls'])->defaultValue('hls')->end()
+            /*  */->scalarNode('public_url')->end()
+            /*  */->scalarNode('host')->defaultValue('localhost')->end()
+            /*  */->integerNode('port')->defaultValue(80)->end()
+            /*  */->scalarNode('mount')->cannotBeEmpty()
+            /*    */->validate()->ifString()->then($trim_leading_slash)->end()
+            /*  */->end()
+            /*  */->booleanNode('mobile')->defaultFalse()->end()
+            /**/->end()->end()->end()
             // System outputs
             /**/->arrayNode('system')->arrayPrototype()->children()
             /*  */->booleanNode('enabled')->defaultFalse()->end()
@@ -270,7 +301,8 @@ private static function load()
         // Merge Icecast and Shoutcast outputs
         $values['stream']['outputs']['merged'] = array_merge(
             $values['stream']['outputs']['icecast'],
-            $values['stream']['outputs']['shoutcast']
+            $values['stream']['outputs']['shoutcast'],
+            $values['stream']['outputs']['hls']
         );
 
         self::$values = $values;

legacy/application/models/StreamSetting.php

@@ -55,16 +55,20 @@ public static function getOutput($key, $add_prefix = false)
                 $prefix . 'pass' => $output['source_password'] ?? '',
                 $prefix . 'admin_user' => $output['admin_user'] ?? 'admin',
                 $prefix . 'admin_pass' => $output['admin_password'] ?? '',
-                $prefix . 'channels' => $output['audio']['channels'] ?? 'stereo',
-                $prefix . 'bitrate' => $output['audio']['bitrate'] ?? 128,
-                $prefix . 'type' => $output['audio']['format'],
                 $prefix . 'name' => $output['name'] ?? '',
                 $prefix . 'description' => $output['description'] ?? '',
                 $prefix . 'genre' => $output['genre'] ?? '',
                 $prefix . 'url' => $output['website'] ?? '',
                 $prefix . 'mobile' => $output['mobile'] ?? 'false',
                 // $prefix . 'liquidsoap_error' => 'waiting',
             ];
+            if (array_key_exists('audio', $output)) {
+                $result .= merge([
+                    $prefix . 'channels' => $output['audio']['channels'] ?? 'stereo',
+                    $prefix . 'bitrate' => $output['audio']['bitrate'] ?? 128,
+                    $prefix . 'type' => $output['audio']['format'],
+                ]);
+            }
         }
 
         if (!$result[$prefix . 'public_url']) {
@@ -108,8 +112,8 @@ public static function getEnabledStreamData()
             $prefix = $id . '_';
             $streams[$id] = [
                 'url' => $streamData[$prefix . 'public_url'],
-                'codec' => $streamData[$prefix . 'type'],
-                'bitrate' => $streamData[$prefix . 'bitrate'],
+                'codec' => $streamData[$prefix . 'type'] ?? 'hls',
+                'bitrate' => $streamData[$prefix . 'bitrate'] ?? '',
                 'mobile' => $streamData[$prefix . 'mobile'],
             ];
         }

playout/libretime_playout/liquidsoap/1.4/ls_lib.liq

@@ -1,3 +1,22 @@
+def start_hls(input_main_mount, streamsref, servpath, segment_duration, segments, segments_overhead, segment_named, output_source)
+    streams_infos = ref([])
+    #generate dummy stream infos does the trick for 1.4
+    list.iter(fun(item) ->
+        streams_infos := list.append([(fst(item), (0,'',''))], !streams_infos )
+    , streamsref())
+    argstream = !streamsref
+    arginfos = !streams_infos
+    output.file.hls(playlist=input_main_mount,
+                segment_duration=segment_duration,
+                segments=segments,
+                segments_overhead=segments_overhead,
+                streams_info=arginfos,
+                segment_name=segment_named,
+                servpath,
+                argstream,
+                output_source )
+end
+
 def gateway(args)
   command = "timeout --signal=KILL 45 libretime-playout-notify #{args} &"
   log(command)

playout/libretime_playout/liquidsoap/templates/outputs.liq.j2

@@ -41,6 +41,33 @@
 {%- endif -%}
 {%- endmacro -%}
 
+
+{#-
+  Build an hls output the output configuration.
+#}
+{%- macro output_hls(output_id, output) -%}
+# hls:{{ output_id }}
+
+output_hls_{{ output_id }}_source = s
+
+streams = ref([])
+
+def segment_name(~position,~extname, stream_name) =
+  timestamp = int_of_float(time())
+  duration = {{output.segment_duration}}
+  "#{stream_name}_#{duration}_#{timestamp}_#{position}.#{extname}"
+end
+
+start_hls(input_main_mount, streams,
+          "/var/lib/libretime/playout/hls",
+          {{output.segment_duration}},
+          {{output.segment_count}},
+          {{output.segments_overhead}},
+          segment_name,
+          output_hls_{{ output_id }}_source)
+
+{%- endmacro -%}
+
 {#-
   Build an icecast output the output configuration.
 #}
@@ -130,6 +157,13 @@ output.{{ output.kind.value }}(id="{{ output.kind.value }}:{{ loop.index }}", s)
 {% endif -%}
 {% endfor -%}
 
+{% for output in config.stream.outputs.hls -%}
+{% if output.enabled -%}
+{{ output_hls(loop.index, output) }}
+
+{% endif -%}
+{% endfor -%}
+
 {% for output in config.stream.outputs.icecast -%}
 {% if output.enabled -%}
 {{ output_icecast(loop.index, output) }}

shared/libretime_shared/config/__init__.py

@@ -5,6 +5,7 @@
     DatabaseConfig,
     GeneralConfig,
     HarborInput,
+    HlsOutput,
     IcecastOutput,
     RabbitMQConfig,
     ShoutcastOutput,