samvera_hls 0.3.7 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f32eacb28341f9d899a5480d319e4a81932a98b3e127b16527df4a35ccaf341b
-  data.tar.gz: 739fecf309e110cdc1a8afa89da970dfbb8bb4f6e1a0ca07e293da377de11526
+  metadata.gz: fabf475ee9c330289d588739a782d74302ea15aeb48d5e1be604dd096afab002
+  data.tar.gz: 32c5e0a93ad559431881f6b3855e66c21848acf5fce558a05f12fbd50436b1a5
 SHA512:
-  metadata.gz: 9c40564b3b77a51618ecab582b5410d5428091ab4679bef4c6f1ea5555691bd9f4f8f94af7335ed5c8e11809edf44a06564977e7f03a74354c7199b66b1064d6
-  data.tar.gz: 944f49e17331dc7559d629620f89bd3ead7105a6c94ca153ffb8d012467ff007762e2d3f9aee750ab155730ab5f60463b0b91d3b431e325697dd33be5b993c0d
+  metadata.gz: 90961c9d137aa7e2f62bd434e55070e04fed71f733a4439905c151e97a4b402d8817d1a7ea239e87c997021a0e812a740afe9e90ff9f4585f4d5945ba63f5832
+  data.tar.gz: 2dcc42a69be39cb831d1f2832a46021f29f7c046d0d793f8d48d9895fedbdc70d3af4a60fd80a1152b149d2290e5cde3c6c021b7f6f951e767fd63446359d1fb

data/app/controllers/concerns/samvera_hls/file_sets_controller_behavior.rb

@@ -9,23 +9,21 @@ module SamveraHls
 
     def embed
       response.headers["X-FRAME-OPTIONS"] = "ALLOWALL"
-      fs = FileSet.find(params[:id])
-      @playlist_url = fs.hls_master_url
-      @media_partial = media_display_partial(fs)
+      @playlist_url = File.join("file_set",params[:id],"hls.m3u8")
+      @media_partial = media_display_partial(params[:id])
       render layout: false
     end
     
     def master
-      fs = FileSet.find(params[:id])
-      render inline: fs.hls_master_playlist(root_url), content_type: 'application/x-mpegurl'
+      render inline: SamveraHls::HlsPlaylistGenerator.hls_master_playlist(params[:id],root_url), content_type: 'application/x-mpegurl'
     end
 
     def variant
-      fs = FileSet.find(params[:id])
-      render inline: fs.hls_segment_playlist(root_url,params[:format]), content_type: 'application/x-mpegurl'
+      render inline: SamveraHls::HlsPlaylistGenerator.hls_segment_playlist(params[:id],root_url,params[:format]), content_type: 'application/x-mpegurl'
     end
 
-    def media_display_partial(file_set)
+    def media_display_partial(file_set_id)
+      file_set = SolrDocument.find(file_set_id)
       base = 'file_sets/media_display'
         if file_set.image?
           File.join('hyrax',base,'image')

data/app/models/concerns/samvera_hls/file_set_behavior.rb

@@ -1,151 +1,54 @@
 require "samvera_hls/derivatives/video_derivatives"
 require "samvera_hls/derivatives/audio_derivatives"
+require "uri"
 
 module SamveraHls
   module FileSetBehavior
     extend ActiveSupport::Concern
 
-    def create_hls_derivatives(filename)
-      case mime_type
-      when *self.class.audio_mime_types
-        hls_dir = File.join(derivative_dir,"hls")
-        create_audio_derivates filename, hls_dir
-      when *self.class.video_mime_types
-        hls_dir = File.join(derivative_dir,"hls")
-        create_video_derivates filename, hls_dir
-      else
-        return false
-      end
-    end
-
-    def hls_master_url
-        File.join("file_set",id,"hls.m3u8")
-    end
-
-    def hls_master_playlist root_url
-      root_url = root_url.gsub("/?locale=en","")
-        type = mime_type.split('/')[0]
-        defaults = hls_config[type]["default"]
-        playlist = "#EXTM3U\n"
-        playlist << "#EXT-X-VERSION:6\n"
-        variants.each{|variant| 
-          next if variant.blank?
-          path, filename = File.split(variant)
-          format = filename.gsub(".m3u8","")
-          options = defaults.merge(hls_config[type][format])
-          playlist << "#EXT-X-STREAM-INF:PROGRAM-ID=1,"
-          playlist << "BANDWIDTH=#{options["maxrate"]},"
-          playlist << "CODECS=\"#{options["codec_code"]}\","
-          playlist << "RESOLUTION=#{options["resolution"]}\n"
-          playlist << File.join(root_url,variant_url(format)) + "\n"
-        }
-        playlist
+    def self.audio_mime_types
+      ['audio/mp3', 'audio/mpeg', 'audio/wav', 'audio/x-wave', 'audio/x-wav', 'audio/ogg', 'audio/flac','audio/x-flac', 'audio/x-aiff', 'audio/aiff', ]
     end
 
-    def hls_segment_playlist root_url, format
-      root_url = root_url.gsub("/?locale=en","")
-      playlist = ""
-      File.open(segment_playlist_path(format),'r') {|file|
-        file.each_line do |line|
-          if line.include? ".ts" then
-            playlist << File.join(root_url,
-                                  segment_url_base,
-                                  timestamp.to_s,
-                                  token(line),
-                                  line).strip+"\n"
-          else
-            playlist << line.strip+"\n"
-          end
-        end
-      }
-      playlist
+    def self.video_mime_types
+      ['video/mp4']
     end
 
-    def derivative_url(destination_name = nil)
-      if destination_name.nil?
-        @deriv_url ||= derivative_dir.gsub(Hyrax.config.derivatives_path,"")
+    def create_hls_derivatives(filename)
+      case mime_type
+      when *audio_mime_types
+        create_hls_audio_derivatives filename
+      when *video_mime_types
+        create_hls_video_derivatives filename
       else
-        path = derivative_path(destination_name)
-        URI("file://#{path}").to_s
-      end
-    end
-
-    module ClassMethods
-
-      def audio_mime_types
-        # audio/x-wave is the mime type that fits 0.6.0 returns for a wav file.
-        # audio/mpeg is the mime type that fits 0.6.0 returns for an mp3 file.
-        ['audio/mp3', 'audio/mpeg', 'audio/wav', 'audio/x-wave', 'audio/x-wav', 'audio/ogg', 'audio/flac','audio/x-flac', 'audio/x-aiff', 'audio/aiff', ]
+        return false
       end
     end
 
     private
 
-    def segment_url_base
-      File.join("stream",derivative_url,"hls")
-    end
-
-    def variants
-      variants = Dir.glob(File.join(derivative_dir,"hls","*.m3u8"))
-      variants.map!{ |file| 
-        name = File.split(file)[1]
-      }
+    def audio_mime_types
+      self.class.audio_mime_types
     end
 
-    def variant_url format 
-        File.join("file_set",id,format,"variant.m3u8")
+    def video_mime_types
+      self.class.video_mime_types
     end
 
-    def create_audio_derivates filename, hls_dir
+    def create_hls_audio_derivatives filename
       outputs = [
-        { label: 'mp3', format: 'mp3', url: derivative_url('mp3') },
-        { label: 'ogg', format: 'ogg', url: derivative_url('ogg') },
-        { label: 'hls_hd', format: 'hls_hd',path: hls_dir}, 
-        { label: 'hls', format: 'hls', path: hls_dir}]
+        { label: 'hls_hd', format: 'hls_hd', id: id}, 
+        { label: 'hls', format: 'hls', id: id}]
       SamveraHls::Derivatives::AudioDerivatives.create(filename,{:outputs => outputs})
     end
 
-    def create_video_derivates filename, hls_dir
-      outputs = [{ label: :thumbnail, format: 'jpg', url: derivative_url('thumbnail') },
-#                 { label: 'webm', format: 'webm', url: derivative_url('webm') },
-                 { label: 'mp4', format: 'mp4', url: derivative_url('mp4') },
-                 { label: 'hls_high', format: "hls_high", path: hls_dir}, 
-                 { label: 'hls_med', format: "hls_med", path: hls_dir}, 
-                 { label: 'hls_low', format: "hls_low", path: hls_dir}]
+    def create_hls_video_derivatives filename
+      outputs = [{ label: :thumbnail, format: 'jpg', url: SamveraHls::HlsPlaylistGenerator.derivative_url(id,'thumbnail') },
+                 { label: 'hls_high', format: "hls_high", id: id }, 
+                 { label: 'hls_med', format: "hls_med", id: id }, 
+                 { label: 'hls_low', format: "hls_low", id: id }]
       SamveraHls::Derivatives::VideoDerivatives.create(filename,{:outputs => outputs})
     end
 
-    def token line
-      @token ||=  Digest::SHA256.hexdigest("/" + File.join(segment_url_base,timestamp.to_s,line).strip[0...-9] + token_secret)
-    end
-
-    def timestamp
-      @timestamp ||= Time.now.to_i + 7200
-    end
-
-    def token_secret
-      @token_secret ||= ENV['hls_token_secret']
-    end
-
-    def hls_config
-      @hls_config ||= YAML.load_file(Rails.root.join('config','hls.yml'))
-    end
-
-    def segment_playlist_path format
-        File.join(derivative_dir,"hls",format+".m3u8")
-    end
-
-    def derivative_dir
-      File.split(derivative_path("dummy"))[0]
-    end
-
-    def derivative_path destination_name
-      derivative_path_service.derivative_path_for_reference(self, destination_name)
-    end
-
-    def derivative_path_service
-      Hyrax::DerivativePath
-    end
-
   end
 end

data/app/services/samvera_hls/hls_output_file_service.rb

@@ -2,7 +2,7 @@ require 'hydra/derivatives'
 module SamveraHls
   class HlsOutputFileService < Hyrax::PersistDerivatives
     def self.call( directives,temp_dir)
-      hls_dir =  directives[:path]
+      hls_dir =  SamveraHls::HlsPlaylistGenerator.hls_dir(directives[:id])
       FileUtils.mkdir_p(hls_dir)
       FileUtils.move(Dir.glob(temp_dir+"/*") , hls_dir)
     end  

data/app/services/samvera_hls/hls_playlist_generator.rb

@@ -0,0 +1,125 @@
+module SamveraHls
+  class HlsPlaylistGenerator
+    class <<self 
+      
+      def hls_master_url file_set_id
+        File.join("file_set",file_set_id,"hls.m3u8")
+      end
+
+      def hls_master_playlist file_set_id, root_url
+        # make sure the root url doesn't get any default  params attached (e.g. locale)
+        parsed_url = URI::parse(root_url)
+        parsed_url.fragment = parsed_url.query = nil
+        root_url = parsed_url.to_s
+
+        type = SolrDocument.find(file_set_id).mime_type.split('/')[0]
+        config = hls_config[type]
+        return nil if config.nil?
+        defaults = config["default"]
+        playlist = "#EXTM3U\n"
+        playlist << "#EXT-X-VERSION:6\n"
+        variants(file_set_id).each do |variant| 
+          next if variant.blank?
+          path, filename = File.split(variant)
+          format = filename.gsub(".m3u8","")
+          options = defaults.merge(config[format])
+          playlist << "#EXT-X-STREAM-INF:PROGRAM-ID=1,"
+          playlist << "BANDWIDTH=#{options["maxrate"]},"
+          playlist << "CODECS=\"#{options["codec_code"]}\","
+          playlist << "RESOLUTION=#{options["resolution"]}\n"
+          playlist << File.join(root_url,variant_url(file_set_id,format)) + "\n"
+        end
+        playlist
+      end
+
+      def hls_segment_playlist file_set_id, root_url, format
+        # make sure the root url doesn't get any default  params attached (e.g. locale)
+        parsed_url = URI::parse(root_url)
+        parsed_url.fragment = parsed_url.query = nil
+        root_url = parsed_url.to_s
+
+        # initialize timestamp once for whole playlist
+        timestamp = Time.now.to_i + 7200
+
+        playlist = ""
+
+        File.open(segment_playlist_path(file_set_id, format),'r') {|file|
+          
+          variant_token = false;
+          file.each_line do |line|
+            if line.include? ".ts" then
+              # We only need to set the token once for each variant file. 
+              # It doesn't depend on which segment we're playing, so we 
+              # speed things up by only calculating one.
+              variant_token ||= token(file_set_id,line, timestamp)
+              if Rails.env == "development" || Rails.env == "test"
+                playlist << File.join(root_url,
+                                      segment_url_base(file_set_id),
+                                      line).strip+"\n"
+              else
+                playlist << File.join(root_url,
+                                      segment_url_base(file_set_id),
+                                      timestamp.to_s,
+                                      variant_token,
+                                      line).strip+"\n"
+              end
+            else
+              playlist << line.strip+"\n"
+            end
+          end
+        }
+        playlist
+      end
+
+      def hls_dir file_set_id
+        derivative_path(file_set_id,"hls").gsub(/\.hls\z/,"")
+      end
+
+      def derivative_url file_set_id, destination_name 
+        derivative_path(file_set_id, destination_name).gsub(Hyrax.config.derivatives_path,"")
+      end
+
+      private
+
+      def token_secret
+        @token_secret ||= ENV['hls_token_secret']
+      end
+
+      def segment_url_base id
+        File.join("stream",derivative_url(id, "hls")).gsub(/\.hls\z/,"")
+      end
+
+      def token id, line, timestamp
+        Digest::SHA256.hexdigest("/" + File.join(segment_url_base(id),timestamp.to_s,line).strip[0...-9] + token_secret)
+      end
+
+      def segment_playlist_path id, format
+        File.join(hls_dir(id),"#{format}.m3u8")
+      end
+
+      def hls_config
+        @hls_config ||= YAML.load_file(Rails.root.join('config','hls.yml'))
+      end
+
+      def variants id
+        variants = Dir.glob(File.join(hls_dir(id),"*.m3u8"))
+        variants.map!{ |file| 
+          name = File.split(file)[1]
+        }
+      end
+      
+      def variant_url id, format 
+        File.join("file_set",id,format,"variant.m3u8")
+      end
+      
+      def derivative_path id, destination_name
+        derivative_path_service.derivative_path_for_reference(id, destination_name)
+      end
+
+      def derivative_path_service
+        Hyrax::DerivativePath
+      end
+
+    end
+  end
+end

data/lib/samvera_hls/version.rb

@@ -1,3 +1,3 @@
 module SamveraHls
-  VERSION = "0.3.7"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samvera_hls
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.4
 platform: ruby
 authors:
 - Ned Henry, UCSC Library Digital Initiatives
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,8 +45,8 @@ files:
 - app/assets/stylesheets/samvera-hls-styles.scss
 - app/controllers/concerns/samvera_hls/file_sets_controller_behavior.rb
 - app/models/concerns/samvera_hls/file_set_behavior.rb
-- app/models/concerns/samvera_hls/solr_document_behavior.rb
 - app/services/samvera_hls/hls_output_file_service.rb
+- app/services/samvera_hls/hls_playlist_generator.rb
 - app/views/_playlist.html.erb
 - app/views/file_sets/embed.html.erb
 - app/views/file_sets/media_display/_audio_hls.html.erb
@@ -152,7 +152,7 @@ homepage: http://github.com/UCSCLibrary/samvera_hls
 licenses:
 - Apache License, v2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +167,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: An engine to add hls adaptive streaming to a samvera based application.
 test_files:

data/app/models/concerns/samvera_hls/solr_document_behavior.rb

@@ -1,112 +0,0 @@
-module SamveraHls
-  module SolrDocumentBehavior
-    extend ActiveSupport::Concern
-
-    
-    def hls_master_url
-        File.join("file_set",id,"hls.m3u8")
-    end
-
-    def hls_master_playlist root_url
-      root_url = root_url.gsub("/?locale=en","")
-        type = mime_type.split('/')[0]
-        defaults = hls_config[type]["default"]
-        playlist = "#EXTM3U\n"
-        playlist << "#EXT-X-VERSION:6\n"
-        variants.each{|variant| 
-          next if variant.blank?
-          path, filename = File.split(variant)
-          format = filename.gsub(".m3u8","")
-          options = defaults.merge(hls_config[type][format])
-          playlist << "#EXT-X-STREAM-INF:PROGRAM-ID=1,"
-          playlist << "BANDWIDTH=#{options["maxrate"]},"
-          playlist << "CODECS=\"#{options["codec_code"]}\","
-          playlist << "RESOLUTION=#{options["resolution"]}\n"
-          playlist << File.join(root_url,variant_url(format)) + "\n"
-        }
-        playlist
-    end
-
-    def hls_segment_playlist root_url, format
-      root_url = root_url.gsub("/?locale=en","")
-      playlist = ""
-      File.open(segment_playlist_path(format),'r') {|file|
-        file.each_line do |line|
-          if ENV["RAILS_ENV"] == 'development'
-            this_segment_url = File.join(root_url,
-                                         segment_url_base,
-                                         line).strip 
-          else
-            this_segment_url = File.join(root_url,
-                                         segment_url_base,
-                                         timestamp.to_s,
-                                         token(line),
-                                         line).strip
-          end
-          if line.include? ".ts" then
-            playlist << this_segment_url + "\n"
-          else
-            playlist << line.strip+"\n"
-          end
-        end
-      }
-      playlist
-    end
-
-   
-    private
-
-    def segment_url_base
-      File.join("stream",derivative_url,"hls")
-    end
-
-    def variants
-      variants = Dir.glob(File.join(derivative_dir,"hls","*.m3u8"))
-      variants.map!{ |file| 
-        name = File.split(file)[1]
-      }
-    end
-
-    def variant_url format 
-        File.join("file_set",id,format,"variant.m3u8")
-    end
-
-    
-    def token line
-      @token ||=  Digest::SHA256.hexdigest("/" + File.join(segment_url_base,timestamp.to_s,line).strip[0...-9] + token_secret)
-    end
-
-    def timestamp
-      @timestamp ||= Time.now.to_i + 7200
-    end
-
-    def token_secret
-      if ENV["RAILS_ENV"] == 'development'
-        return ''
-      else
-        return @token_secret ||= ENV['hls_token_secret']
-      end
-    end
-
-    def hls_config
-      @hls_config ||= YAML.load_file(Rails.root.join('config','hls.yml'))
-    end
-
-    def segment_playlist_path format
-        File.join(derivative_dir,"hls",format+".m3u8")
-    end
-
-    def derivative_dir
-      File.split(derivative_path("dummy"))[0]
-    end
-
-    def derivative_path destination_name
-      derivative_path_service.derivative_path_for_reference(self, destination_name)
-    end
-
-    def derivative_path_service
-      Hyrax::DerivativePath
-    end
-
-  end
-end