Partial fix for #15 and HLS-20
[HLS-Stream-Creator.git] / HLS-Stream-Creator.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
#!/bin/bash
#
# A very simple BASH script to take an input video and split it down into Segments 
# before creating an M3U8 Playlist, allowing the file to be served using HLS
#
#
 
######################################################################################
#
# Copyright (c) 2013, Ben Tasker
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
# 
#   Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.
# 
#   Redistributions in binary form must reproduce the above copyright notice, this
#   list of conditions and the following disclaimer in the documentation and/or
#   other materials provided with the distribution.
# 
#   Neither the name of Ben Tasker nor the names of his
#   contributors may be used to endorse or promote products derived from
#   this software without specific prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# 
######################################################################################
 
# Basic config
OUTPUT_DIRECTORY=${OUTPUT_DIRECTORY:-'./output'}
 
# Change this if you want to specify a path to use a specific version of FFMPeg
FFMPEG=${FFMPEG:-'ffmpeg'}
 
# Number of threads which will be used for transcoding. With newer FFMPEGs and x264
# encoders "0" means "optimal". This is normally the number of CPU cores.
NUMTHREADS=${NUMTHREADS:-"0"}
 
# Video codec for the output video. Will be used as an value for the -vcodec argument
VIDEO_CODEC=${VIDEO_CODEC:-"libx264"}
 
# Video codec for the output video. Will be used as an value for the -acodec argument
AUDIO_CODEC=${AUDIO_CODEC:-"libfdk_aac"}
 
# Additional flags for ffmpeg
FFMPEG_FLAGS=${FFMPEG_FLAGS:-""}
 
# If the input is a live stream (i.e. linear video) this should be 1
LIVE_STREAM=${LIVE_STREAM:-0}
 
# Video bitrates to use in output (comma seperated list if you want to create an adaptive stream.)
# leave null to use the input bitrate
OP_BITRATES=${OP_BITRATES:-''}
 
# Determines whether the processing for adaptive streams should run sequentially or not
NO_FORK=${NO_FORK:-0}
 
# Lets put our functions here
 
 
## Output the script's CLI Usage
#
#
function print_usage(){
 
cat << EOM
HTTP Live Stream Creator
Version 1
 
Copyright (C) 2013 B Tasker, D Atanasov
Released under BSD 3 Clause License
See LICENSE
 
 
Usage: HLS-Stream-Creator.sh -[lf] [-c segmentcount] -i [inputfile] -s [segmentlength(seconds)] -o [outputdir] -b [bitrates]  [-p filename]
 
        -i      Input file
        -s      Segment length (seconds)
        -o      Output directory (default: ./output)
        -l      Input is a live stream
        -c      Number of segments to include in playlist (live streams only) - 0 is no limit
        -b      Output video Bitrates (comma seperated list for adaptive streams)
        -f      Foreground encoding only (don't fork the encoding processes into the background - adaptive non-live streams only)
        -p      Playlist filename
        -t      Segment filename prefix
        -S      Segment directory name (default none)
 
Deprecated Legacy usage:
        HLS-Stream-Creator.sh inputfile segmentlength(seconds) [outputdir='./output']
 
EOM
 
exit
 
}
 
 
function createStream(){
# For VoD and single bitrate streams the variables we need will exist in Global scope.
# for live adaptive streams though, that won't be the case, so we need to take them as arguments
# Some are global though, so we'll leave those as is
 
playlist_name="$1"
output_name="$2"
bitrate="$3"
infile="$4"
 
$FFMPEG -i "$infile" \
    -loglevel error -y \
    -vcodec "$VIDEO_CODEC" \
    -acodec "$AUDIO_CODEC" \
    -threads "$NUMTHREADS" \
    -map 0 \
    -flags \
    -global_header \
    -f segment \
    -segment_list "$playlist_name" \
    -segment_time "$SEGLENGTH" \
    -segment_format mpeg_ts \
    $bitrate \
    $FFMPEG_ADDITIONAL \
    $FFMPEG_FLAGS \
    "$OUTPUT_DIRECTORY/$output_name"
}
 
 
function createVariantPlaylist(){
playlist_name="$1"
echo "#EXTM3U" > "$playlist_name"
}
 
 
function appendVariantPlaylistentry(){
playlist_name=$1
playlist_path=$2
playlist_bw=$(( $3 * 1000 )) # bits not bytes :)
 
cat << EOM >> "$playlist_name"
#EXT-X-STREAM-INF:BANDWIDTH=$playlist_bw
$playlist_path
EOM
 
}
 
 
function awaitCompletion(){
# Monitor the encoding pids for their completion status
while [ ${#PIDS[@]} -ne 0 ]; do
    # Calculate the length of the array
    pid_length=$((${#PIDS[@]} - 1))
 
    # Check each PID in the array
    for i in `seq 0 $pid_length`
    do
          # Test whether the pid is still active
          if ! kill -0 ${PIDS[$i]} 2> /dev/null
          then
                echo "Encoding for bitrate ${BITRATE_PROCESSES[$i]}k completed"
 
                if [ "$LIVE_STREAM" == "1" ]
                then
                    # Correctly terminate the manifest. See HLS-15 for info on why
                    echo "#EXT-X-ENDLIST" >> "$OUTPUT_DIRECTORY/${PLAYLIST_PREFIX}_${BITRATE_PROCESSES[$i]}.m3u8"
                fi
 
                unset BITRATE_PROCESSES[$i]
                unset PIDS[$i]
          fi
    done
    PIDS=("${PIDS[@]}") # remove any nulls
    sleep 1
done
}
 
 
# This is used internally, if the user wants to specify their own flags they should be
# setting FFMPEG_FLAGS
FFMPEG_ADDITIONAL=''
LIVE_SEGMENT_COUNT=0
IS_FIFO=0
TMPDIR=${TMPDIR:-"/tmp"}
MYPID=$$
# Get the input data
 
# This exists to maintain b/c
LEGACY_ARGS=1
 
# If even one argument is supplied, switch off legacy argument style
while getopts "i:o:s:c:b:p:t:S:lf" flag
do
        LEGACY_ARGS=0
        case "$flag" in
                i) INPUTFILE="$OPTARG";;
                o) OUTPUT_DIRECTORY="$OPTARG";;
                s) SEGLENGTH="$OPTARG";;
                l) LIVE_STREAM=1;;
                c) LIVE_SEGMENT_COUNT="$OPTARG";;
                b) OP_BITRATES="$OPTARG";;
                f) NO_FORK=1;;
                p) PLAYLIST_PREFIX="$OPTARG";;
                t) SEGMENT_PREFIX="$OPTARG";;
                S) SEGMENT_DIRECTORY="$OPTARG";;
        esac
done
 
 
if [ "$LEGACY_ARGS" == "1" ]
then
  # Old Basic Usage is 
  # cmd.sh inputfile segmentlength 
 
  INPUTFILE=${INPUTFILE:-$1}
  SEGLENGTH=${SEGLENGTH:-$2}
  if ! [ -z "$3" ]
  then
    OUTPUT_DIRECTORY=$3
  fi
fi
 
 
# Check we've got the arguments we need
if [ "$INPUTFILE" == "" ] || [ "$SEGLENGTH" == "" ]
then
  print_usage
fi
 
# FFMpeg is a pre-requisite, so let check for it
if hash $FFMPEG 2> /dev/null
then
  # FFMpeg exists
  echo "ffmpeg command found.... continuing"
else
  # FFMPeg doesn't exist, uh-oh!
  echo "Error: FFmpeg doesn't appear to exist in your PATH. Please addresss and try again"
  exit 1
fi
 
# Check whether the input is a named pipe
if [ -p "$INPUTFILE" ]
then
  echo "Warning: Input is FIFO - EXPERIMENTAL"
  IS_FIFO=1
 
fi
 
# Check output directory exists otherwise create it
if [ ! -w $OUTPUT_DIRECTORY ]
then
  echo "Creating $OUTPUT_DIRECTORY"
  mkdir -p $OUTPUT_DIRECTORY
fi
 
if [ "$LIVE_STREAM" == "1" ]
then
    FFMPEG_ADDITIONAL+="-segment_list_flags +live"
 
    if [ "$LIVE_SEGMENT_COUNT" -gt 0 ]
    then
        FFMPEG_ADDITIONAL+=" -segment_list_size $LIVE_SEGMENT_COUNT"
    fi
fi
 
 
# Pulls file name from INPUTFILE which may be an absolute or relative path.
INPUTFILENAME=${INPUTFILE##*/}
 
# If a prefix hasn't been specified, use the input filename
PLAYLIST_PREFIX=${PLAYLIST_PREFIX:-$INPUTFILENAME}
SEGMENT_PREFIX=${SEGMENT_PREFIX:-$PLAYLIST_PREFIX}
 
# The 'S' option allows segments and bitrate specific manifests to be placed in a subdir
SEGMENT_DIRECTORY=${SEGMENT_DIRECTORY:-''}
 
if [ ! "$SEGMENT_DIRECTORY" == "" ]
then
 
        if [ ! -d "${OUTPUT_DIRECTORY}/${SEGMENT_DIRECTORY}" ]
        then
                mkdir "${OUTPUT_DIRECTORY}/${SEGMENT_DIRECTORY}"
        fi
 
        SEGMENT_DIRECTORY+="/"
fi
 
# Set the bitrate
if [ ! "$OP_BITRATES" == "" ]
then
      # Make the bitrate list easier to parse
      OP_BITRATES=${OP_BITRATES//,/$'\n'}
 
      # Create an array to house the pids for backgrounded tasks
      declare -a PIDS
      declare -a BITRATE_PROCESSES
 
      # Get the variant playlist created
      createVariantPlaylist "$OUTPUT_DIRECTORY/${PLAYLIST_PREFIX}_master.m3u8"
      for br in $OP_BITRATES
      do
            appendVariantPlaylistentry "$OUTPUT_DIRECTORY/${PLAYLIST_PREFIX}_master.m3u8" "${SEGMENT_DIRECTORY}${PLAYLIST_PREFIX}_${br}.m3u8" "$br"
      done
 
      OUTPUT_DIRECTORY+=$SEGMENT_DIRECTORY
 
      # Now for the longer running bit, transcode the video
      for br in $OP_BITRATES
      do
              BITRATE="-b:v ${br}k -bufsize ${br}k"
              # Finally, lets build the output filename format
              OUT_NAME="${SEGMENT_PREFIX}_${br}_%05d.ts"
              PLAYLIST_NAME="$OUTPUT_DIRECTORY/${PLAYLIST_PREFIX}_${br}.m3u8"
              SOURCE_FILE="$INPUTFILE"
              echo "Generating HLS segments for bitrate ${br}k - this may take some time"
 
              if [ "$NO_FORK" == "0" ] || [ "$LIVE_STREAM" == "1" ]
              then
                      # Processing Starts
                      if [ "$IS_FIFO" == "1" ]
                      then
                            # Create a FIFO specially for this bitrate
                            SOURCE_FILE="$TMPDIR/hlsc.encode.$MYPID.$br"
                            mknod "$SOURCE_FILE" p
                      fi
 
                      # Schedule the encode
                      createStream "$PLAYLIST_NAME" "$OUT_NAME" "$BITRATE" "$SOURCE_FILE" &
                      PID=$!
                      PIDS=(${PIDS[@]} $PID)
                      BITRATE_PROCESSES=(${BITRATE_PROCESSES[@]} $br)
              else
                      createStream "$PLAYLIST_NAME" "$OUT_NAME" "$BITRATE" "$SOURCE_FILE"
              fi
 
      done
 
      if [ "$IS_FIFO" == "1" ]
      then
              # If the input was a FIFO we need to read from it and push into the new FIFOs
              cat "$INPUTFILE" | tee $(for br in $OP_BITRATES; do echo "$TMPDIR/hlsc.encode.$MYPID.$br"; done) > /dev/null &
              TEE_PID=$!
      fi
 
      if [ "$NO_FORK" == "0" ] || [ "$LIVE_STREAM" == "1" ]
      then
            # Monitor the background tasks for completion
            echo "All transcoding processes started, awaiting completion"
            awaitCompletion
      fi
 
      if [ "$IS_FIFO" == "1" ]
      then
            for br in $OP_BITRATES
            do 
                rm -f "$TMPDIR/hlsc.encode.$MYPID.$br"; 
            done
            # If we were interrupted, tee may still be running
            kill $TEE_PID 2> /dev/null 
      fi
 
else
 
  OUTPUT_DIRECTORY+=$SEGMENT_DIRECTORY
  # No bitrate specified
 
  # Finally, lets build the output filename format
  OUT_NAME="${SEGMENT_PREFIX}_%05d.ts"
  PLAYLIST_NAME="$OUTPUT_DIRECTORY/${PLAYLIST_PREFIX}.m3u8"
 
  echo "Generating HLS segments - this may take some time"
 
  # Processing Starts
 
  createStream "$PLAYLIST_NAME" "$OUT_NAME" "$BITRATE" "$INPUTFILE"
 
 
fi