livelist 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71f726fd7f7b086ff553ddcbfee959ef777185bbeab869f86426b0dbeb6e59d4
+  data.tar.gz: 54c1894d723b52a28ea85f77f631f852497edccf210f025aefe492e5bc583256
+SHA512:
+  metadata.gz: 324b514aacc3ebe288319c56c7d89bb1f2a648af3cf907b42ec68c4bed140c1816762e084f32ce7862fb4b2f1c3356a0a453b25a5320dac6ac3e7db4c63fb880
+  data.tar.gz: ea1188459a10e9503edfb62995341ee399d29a264111c5f297cc781ee3125aba3d04c380a1c60fe5e30a52a77bcc86349de7daf18274c574248fb7e2b6497eb8

data/lib/livelist/exceptions/invalid_format.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Livelist
+  module Exceptions
+    # Livelist::Exceptions::InvalidFormat
+    # Throws an error if file has invalid format (if not .m3u8)
+    class InvalidFormat < StandardError
+      def initialize(message: 'That file has invalid format')
+        super(message)
+      end
+    end
+  end
+end

data/lib/livelist/hls/hls.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Livelist
+  # Livelist::HLS
+  module HLS
+    def self.current_time(playlist, seconds = 2)
+      lines = File
+              .readlines(playlist)
+              .select { |line| line =~ /EXTINF:[0-9]/ }
+      lines.length * seconds
+    end
+
+    # Finish the playlist with a endlist tag
+    # @param String playlist
+    # @return void
+    def self.finish(playlist)
+      file = File.read(playlist)
+      content = file.gsub(/#EXT-X-PLAYLIST-TYPE:EVENT/, '#EXT-X-PLAYLIST-TYPE:VOD')
+      File.open(playlist, 'w') { |f| f.puts content}
+      File.open(playlist, 'a') do |file|
+        file.puts '#EXT-X-ENDLIST'
+      end
+    end
+  end
+end

data/lib/livelist/hls/pipeline.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Livelist
+  module HLS
+    # A pipeline for manipulate playlist
+    # using HTTP Livestreaming standards
+    class Pipeline
+      # @param [String] path
+      # @param [Hash] options
+      def initialize(path, options = {})
+        @path = path
+        @options = options
+        @playlist = Livelist::Playlist.new(@path, options)
+      end
+
+      # Run the pipeline to HTTP streaming
+      # @param [String] segment_name
+      # @return [void]
+      def run(segment_name)
+        create_playlist
+        append_segment(segment_name)
+      end
+
+      private
+
+      # Write the playlist file
+      def create_playlist
+        @playlist.write unless File.exist? @path
+      end
+
+      # Append a segment to playlist file
+      # the segment name can be a URL or a simple file
+      #
+      # @param [String] segment_name
+      def append_segment(segment_name)
+        Livelist::Segment
+          .new(segment_name, @options[:target_duration].to_f)
+          .append(@playlist)
+      end
+    end
+  end
+end

data/lib/livelist/playlist.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Livelist
+  # A Playlist m3u8
+  class Playlist
+    # @param path [String] where will be the final m3u8
+    #
+    # @param options [Hash] all options allowed 
+    # @option options [Integer] :version playlist version defaults 1
+    # @option options [Boolean] :allow playlist allow cache defaults false
+    # @option options [Integer] :target_duration playlist target duration in seconds defaults 10
+    #
+    # @raise [Exceptions::InvalidFormat] invalid format if file is not a .m3u8
+    def initialize(path, options = {})
+      @path = path
+      @options = options
+      @tag = "#EXTM3U"
+      raise Exceptions::InvalidFormat unless File.extname(path) == '.m3u8'
+    end
+
+    def path
+      @path
+    end
+
+    # Write the m3u8 file
+    def write
+      File.open(@path, 'w') do |file|
+        [
+          @tag,
+          type,
+          version,
+          media_sequence,
+          allow_cache?,
+          target_duration,
+        ].each { |tag| file.puts tag }
+      end
+    end
+
+    # Return a string version of m3u8 file
+    def to_s
+      [
+        @tag,
+        version,
+        media_sequence,
+        allow_cache?,
+        target_duration
+      ].join("\n")
+    end
+
+    private
+    def version
+      "#EXT-X-VERSION:#{@options[:version] ||= 1}"
+    end
+
+    def allow_cache?
+      "#EXT-X-ALLOW-CACHE:#{@options[:allow] ? 'YES' : 'NO'}"
+    end
+
+    def target_duration
+      "#EXT-X-TARGETDURATION:#{@options[:target_duration] ||= 10}"
+    end
+
+    def media_sequence
+      '#EXT-X-MEDIA-SEQUENCE:0'
+    end
+
+    def type
+      "#EXT-X-PLAYLIST-TYPE:#{@options[:type] ||= 'EVENT'}"
+    end
+  end
+end

data/lib/livelist/segment.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Livelist
+  # A Segment to playlist file
+  class Segment
+    # @param src [String] src can be a URI or a file name
+    # @param duration [Float] duration in seconds
+    def initialize(src, duration)
+      @src = src
+      @duration = duration
+    end
+
+    # Append a new segment on playlist file
+    #
+    # @param [Livelist::Playlist] playlist
+    def append(playlist)
+      write(playlist) if File.exist? playlist.path
+    end
+
+    # Append a new segment but removing
+    # the previous segment from playlist
+    #
+    # @param [Livelist::Playlist] playlist
+    def hls_append(playlist)
+      hls_write(playlist) if File.exist? playlist.path
+    end
+
+    private
+
+    # @param [Livelist::Playlist] playlist
+    def write(playlist)
+      File.open(playlist.path, 'a') do |file|
+        [
+          "#EXTINF:#{@duration},",
+          @src
+        ].each { |line| file.puts line }
+      end
+    end
+
+    # @param [Livelist::Playlist] playlist
+    def hls_write(playlist)
+      append(playlist)
+      segment = File.open(playlist.path, 'r') do |file|
+        context = file.readlines.map(&:chomp)
+        remove_tag_and_segment(context)
+      end
+      File.open(playlist.path, 'w') { |f| f.puts segment }
+    end
+
+    # @param context [Array] an array containing tag and segment
+    # @return [Array] updated array without tag and segment
+    def remove_tag_and_segment(context)
+      if context.grep(/#EXTINF:[0-9]+/).length > 2
+        context.delete_at 5
+        context.delete_at 5
+      end
+      context
+    end
+  end
+end

data/lib/livelist/sequence.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Livelist
+  # A Media Sequence for playlist file
+  class Sequence
+    # @param playlist [Livelist::Playlist] Playlist instance
+    def initialize(playlist)
+      @playlist = playlist
+      @pattern = /#EXT-X-MEDIA-SEQUENCE:[0-9]+/
+    end
+
+    # Writes the new sequence on playlist file
+    def add
+      file = File.read(@playlist.path)
+      content = file.gsub(@pattern, new_sequence_line(sequence_line))
+      File.open(@playlist.path, 'w') { |f| f.puts content}
+    end
+
+    private
+
+    # Return the sequence line adding 1 to the previous value
+    # @param line [String]
+    # @return [String] the sequence tag with the updated value
+    def new_sequence_line(line)
+      tag, sequence = line.split(':')
+      seq = sequence.strip.to_i + 1
+      "#{tag}:#{seq}"
+    end
+
+    # Return the sequence tag based on regex pattern
+    # @return [String] sequence tag line
+    def sequence_line
+      File.open(@playlist.path, 'r') do |file|
+        file.find { |line| line =~ @pattern }
+      end
+    end
+  end
+end

data/lib/livelist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Livelist
+  VERSION = '0.2.1'
+end

data/lib/livelist.rb

@@ -0,0 +1,2 @@
+require 'livelist/version'
+Dir[File.dirname(__FILE__) + "/livelist/**/*.rb"].each { |file| require file }

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: livelist
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Vitor Roque
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-12 00:00:00.000000000 Z
+dependencies: []
+description: A simple gem to manipulate m3u8 files
+email:
+- vitor.roquep@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/livelist.rb
+- lib/livelist/exceptions/invalid_format.rb
+- lib/livelist/hls/hls.rb
+- lib/livelist/hls/pipeline.rb
+- lib/livelist/playlist.rb
+- lib/livelist/segment.rb
+- lib/livelist/sequence.rb
+- lib/livelist/version.rb
+homepage: https://github.com/roqueando/livelist
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/roqueando/livelist
+  source_code_uri: https://github.com/roqueando/livelist
+  changelog_uri: https://github.com/roqueando/livelist
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: A simple gem to manipulate m3u8 files
+test_files: []