tivohmo 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf38e58ce80df9b5a177019960ace75cee1214cd
-  data.tar.gz: 84358dcbc8cc552c560a34b67cd3bec1f40d7d62
+  metadata.gz: 23e9f9103ee58ffb81e0bb0bbd17e8d3362ead11
+  data.tar.gz: 62c368b9bb3d2e760d8fef53a4a309d34c0a14f9
 SHA512:
-  metadata.gz: 1643360b023aa69207324541bfd041b25ce3d07e7211aa57bc7a3b33ab6b497c6063a560ba26ebe0f577e18a4fc8361838de7778b5758b5250b06f59996e62be
-  data.tar.gz: 807c936f1152bb55a0a62ddcb6c933aaa0c03d19c44cf407fde517f283ca16c8e3ccb6fb2d84744090f3cb90885077fbde392fc831ac75540d59ab85af34fee0
+  metadata.gz: 7e61409326f627087d50ea35a95ec391d74ded1fde2b446f7e67398f063a0219e98e2c6f7daedf689fcb438d8728cee318965317b52e21fce51fddef3cfc2cca
+  data.tar.gz: 641ca50d1d8fc479fc85ebc16d0b4cd9977aa011d930196e92a758bcc7019498c1a88b3fcd03a5a600bbe869138ce758a86c40cb510ae9e3e8b71f8a9744d38f

data/CHANGELOG

@@ -1,3 +1,8 @@
+0.3.1 (03/08/2015)
+------------------
+
+refactored subtitles support, add subtitles to filesystem app, refactor change listeners in filesystem app <9820722> [Matt Conway]
+
 0.3.0 (03/01/2015)
 ------------------
 

data/README.md

@@ -15,6 +15,14 @@ A Plex adapter is also available with similar functionality.  The transcoding on
 
 This project only supports serving of video resources (for now) as that fills my need.
 
+## Noteworthy features
+
+ * Full control of runtime from command line or config file
+ * Application for changing runtime settings of the server from the Tivo UI
+ * Application to serve video to the Tivo from the Filesystem
+ * Application to serve video to the Tivo from a Plex Media Server
+ * Can serve video with on-the-fly hardcoded subtitles from srt files (embedded subs are also supported in plex app)
+
 ## Installation
 
 Install the gem:

data/TODO

@@ -1 +1,5 @@
 fix back after watching movie (anchor)
+add audio track support similar to embedded subtitles
+add embedded subtitles to filesystem app
+figure out how to stream/transcode from plex rather than hack to use local files
+figure out a way to embed subtitles in mpeg2 stream for live toggling from tivo ui (EIA-608/CEA-708/line 21)

data/lib/tivohmo/adapters/filesystem/application.rb

@@ -1,5 +1,6 @@
 require 'active_support/core_ext/string/inflections'
 require 'tivohmo/adapters/streamio'
+require 'listen'
 
 module TivoHMO
   module Adapters
@@ -15,7 +16,43 @@ module TivoHMO
           super(identifier)
           self.metadata_class = TivoHMO::Adapters::StreamIO::Metadata
           self.transcoder_class = TivoHMO::Adapters::StreamIO::Transcoder
+
+          setup_change_listener
+        end
+
+        private
+
+        def setup_change_listener
+          logger.debug "Setting up change listener on #{identifier}"
+
+          fq_path = File.realdirpath(identifier)
+          listener = Listen.to(fq_path) do |modified, added, removed|
+            logger.debug "Detected filesystem change on #{identifier}"
+
+            dirs = (modified + added + removed).flatten.collect do |path|
+              relative_path = path.sub(fq_path, '')
+              relative_dir = File.dirname(relative_path).sub(/^\//, '')
+            end
+            dirs.uniq!
+
+            dirs.each do |dir|
+              begin
+                logger.debug "Handling filesystem change: #{dir.inspect}"
+                title_path = dir.split('/').collect(&:titleize).join('/')
+                # TODO fix Node#find
+                container = title_path.blank? ? self : find(title_path)
+                container.refresh if container
+              rescue Exception => e
+                logger.log_exception(e, "Ignoring exception in filesystem refresh: #{path}")
+              end
+            end
+
+            logger.debug "Completed filesystem refresh on #{identifier}"
+          end
+
+          listener.start
         end
+
       end
 
     end

data/lib/tivohmo/adapters/filesystem/file_item.rb

@@ -9,14 +9,16 @@ module TivoHMO
         include TivoHMO::API::Item
         include GemLogger::LoggerSupport
 
-        def initialize(identifier)
+        def initialize(identifier, subtitle=nil)
           full_path = File.expand_path(identifier)
           raise ArgumentError, "Must provide an existing file" unless File.file?(full_path)
 
           super(full_path)
 
           self.file = full_path
+          self.subtitle = subtitle
           self.title = File.basename(self.identifier)
+          self.title = "[#{subtitle.language_code} #{subtitle.type} sub] #{self.title}" if subtitle
           self.modified_at = File.mtime(self.identifier)
           self.created_at = File.ctime(self.identifier)
         end

data/lib/tivohmo/adapters/filesystem/folder_container.rb

@@ -1,5 +1,5 @@
 require 'active_support/core_ext/string/inflections'
-require 'listen'
+require 'tivohmo/subtitles_util'
 
 module TivoHMO
   module Adapters
@@ -10,6 +10,7 @@ module TivoHMO
         include TivoHMO::API::Container
         include GemLogger::LoggerSupport
         include MonitorMixin
+        include TivoHMO::Config::Mixin
 
         VIDEO_EXTENSIONS = %w[
           tivo mpg avi wmv mov flv f4v vob mp4 m4v mkv
@@ -40,26 +41,29 @@ module TivoHMO
           self.modified_at = File.mtime(self.identifier)
           self.created_at = File.ctime(self.identifier)
 
-          setup_change_listener
+          @subtitles = config_get(:enable_subtitles)
         end
 
         def children
           synchronize do
-            if super.blank?
-              folders = []
-              files = []
+            if super.blank? || @subtitles != config_get(:enable_subtitles)
+              super.clear
+              @subtitles = config_get(:enable_subtitles)
 
-              Dir["#{self.full_path}/*"].each do |path|
+              items = Dir["#{self.full_path}/*"].group_by do |path|
                 if allowed_container?(path)
-                  folders << FolderContainer.new(path)
+                  :dir
                 elsif allowed_item?(path)
-                  files << FileItem.new(path)
+                  :file
                 else
-                  logger.debug "Ignoring: #{path}"
+                  :skipped
                 end
               end
 
-              (folders + files).each {|c| add_child(c) }
+              Array(items[:dir]).each {|path| add_child(FolderContainer.new(path)) }
+              Array(items[:file]).each {|path| add_grouped(path) }
+              Array(items[:skipped]).each {|path| logger.debug "Ignoring: #{path}" } if logger.debug?
+
             end
           end
 
@@ -68,25 +72,6 @@ module TivoHMO
 
         protected
 
-        def setup_change_listener
-          logger.debug "Setting up change listener on #{identifier}"
-          @listener = Listen.to(identifier, ignore: /\//) do |modified, added, removed|
-            logger.debug "Detected filesystem change on #{identifier}"
-            logger.debug "modified: #{modified}"
-            logger.debug "added: #{added}"
-            logger.debug "removed: #{removed}"
-
-            # TODO: be more intelligent instead of just wiping children to cause the refresh
-            self.refresh
-
-            # cleanup - not strictly correct as this listener won't necessarily get triggered
-            # if self is removed from the parent
-            @listener.stop unless root.find(title_path)
-            logger.debug "Completed filesystem refresh on #{identifier}"
-          end
-          @listener.start
-        end
-
         def allowed_container?(path)
           File.directory?(path) && allowed_item_types.include?(:dir)
         end
@@ -98,6 +83,25 @@ module TivoHMO
               allowed_item_extensions.include?(ext)
         end
 
+        def add_grouped(path)
+          primary = FileItem.new(path)
+
+          if @subtitles
+            subs = SubtitlesUtil.instance.subtitles_for_media_file(path)
+
+            if subs.size > 0
+              group = Group.new(primary.identifier, primary.title)
+              add_child(group)
+              group.add_child(primary)
+              subs.each {|s| group.add_child(FileItem.new(path, s)) }
+            else
+              add_child(primary)
+            end
+          else
+            add_child(primary)
+          end
+        end
+
       end
 
     end

data/lib/tivohmo/adapters/filesystem/group.rb

@@ -0,0 +1,22 @@
+module TivoHMO
+  module Adapters
+    module Filesystem
+
+      class Group
+        include TivoHMO::API::Container
+        include GemLogger::LoggerSupport
+
+        def initialize(ident, title)
+          super(ident)
+
+          self.presorted = true
+          self.title = title
+          self.modified_at = File.mtime(self.identifier)
+          self.created_at = File.ctime(self.identifier)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tivohmo/adapters/filesystem.rb

@@ -1,3 +1,4 @@
 require_relative 'filesystem/file_item'
+require_relative 'filesystem/group'
 require_relative 'filesystem/folder_container'
 require_relative 'filesystem/application'

data/lib/tivohmo/adapters/plex/category.rb

@@ -1,3 +1,6 @@
+require 'tivohmo/subtitles_util'
+require 'iso-639'
+
 module TivoHMO
   module Adapters
     module Plex
@@ -107,6 +110,10 @@ module TivoHMO
 
           source_filename = CGI.unescape(item_delegate.medias.first.parts.first.file)
 
+          # add in the file based subtitles
+          subs.concat(SubtitlesUtil.instance.subtitles_for_media_file(source_filename))
+
+          # add in the embedded subtitles
           item_delegate.medias.each do |media|
             media.parts.each do |part|
               prev_stream_count = 0
@@ -116,25 +123,25 @@ module TivoHMO
                 # stream.key.present? means file based srt
                 # stream.index and no key, means embedded
                 if stream.stream_type.to_i == 3
-                  if %w[key language language_code].all? {|m| stream.respond_to?(m) && stream.send(m).present? }
-                    st = TivoHMO::API::Subtitle.new
-                    st.language = stream.language
-                    st.language_code = stream.language_code
-                    st.format = stream.codec
-                    st.type = :file
-                    st.location = source_filename.chomp(File.extname(source_filename))
-                    subs << st
-                  elsif stream.respond_to?(:index) && stream.index.present?
+                  if stream.respond_to?(:index) && stream.index.present?
                     st = TivoHMO::API::Subtitle.new
-                    st.language = stream.respond_to?(:language) && stream.language || "Embedded"
-                    st.language_code = stream.respond_to?(:language_code) && stream.language_code || "???"
+
+                    lang_code = stream.respond_to?(:language_code) && stream.language_code || "??"
+                    st.language_code = lang_code
+
+                    iso_entry = ISO_639.find_by_code(lang_code.downcase)
+                    if iso_entry
+                      st.language = iso_entry.english_name
+                    else
+                      logger.warn "Subtitle stream has unknown language code: #{lang_code}"
+                      st.language = "Unknown"
+                    end
+
                     st.format = stream.codec
                     st.type = :embedded
                     # subtitle index should be the index amongst just the embedded subtitle streams
                     st.location = stream.index.to_i - prev_stream_count
                     subs << st
-                  else
-                    logger.warn "Unrecognized subtitle for #{item_delegate.title}"
                   end
                 end
 

data/lib/tivohmo/adapters/plex/episode.rb

@@ -9,7 +9,7 @@ module TivoHMO
         include GemLogger::LoggerSupport
         include TivoHMO::Config::Mixin
 
-        attr_reader :delegate, :subtitle
+        attr_reader :delegate
 
         config_register(:group_with_zap2it, true,
                         "Use zap2it ID for grouping episodes (Gives thumbnail in My Shows, but can cause problems)")
@@ -24,7 +24,7 @@ module TivoHMO
           self.subtitle = subtitle
 
           self.title = delegate.title
-          self.title = "[#{subtitle.language_code} sub] #{self.title}" if subtitle
+          self.title = "[#{subtitle.language_code} #{subtitle.type} sub] #{self.title}" if subtitle
 
           self.modified_at = Time.at(delegate.updated_at.to_i)
           self.created_at = Time.parse(delegate.originally_available_at) rescue nil

data/lib/tivohmo/adapters/plex/movie.rb

@@ -6,7 +6,7 @@ module TivoHMO
         include TivoHMO::API::Item
         include GemLogger::LoggerSupport
 
-        attr_reader :delegate, :subtitle
+        attr_reader :delegate
 
         def initialize(delegate, subtitle=nil)
           # delegate is a Plex::Movie
@@ -18,7 +18,7 @@ module TivoHMO
           self.subtitle = subtitle
 
           self.title = delegate.title
-          self.title = "[#{subtitle.language_code} sub] #{self.title}" if subtitle
+          self.title = "[#{subtitle.language_code} #{subtitle.type} sub] #{self.title}" if subtitle
 
           self.modified_at = Time.at(delegate.updated_at.to_i)
           self.created_at = Time.parse(delegate.originally_available_at) rescue nil

data/lib/tivohmo/adapters/streamio/transcoder.rb

@@ -209,20 +209,11 @@ module TivoHMO
                 code = st.language_code
                 file = st.location
 
-                # TODO: This is a little hacky
-                # we have a leaky abstraction here but the file globbing is a bad
-                # performance hit to UI when generating Containers on first view
-                file_glob = file + ".*.srt"
-                sub_file = Dir[file_glob].find do |f|
-                  file_code = f.split('.')[-2].downcase
-                  file_code == code || file_code.starts_with?(code) || code.starts_with?(file_code)
-                end
-
-                if sub_file
-                  logger.info "Using subtitles present at: #{sub_file}"
-                  opts[:custom] << "-vf subtitles=\"#{sub_file}\""
+                if File.exist?(file)
+                  logger.info "Using subtitles present at: #{file}"
+                  opts[:custom] << "-vf subtitles=\"#{file}\""
                 else
-                  logger.error "Subtitle doesn't exist at: #{file_glob}"
+                  logger.error "Subtitle doesn't exist at: #{file}"
                 end
               when :embedded
                 file = item.file

data/lib/tivohmo/api/container.rb

@@ -9,6 +9,7 @@ module TivoHMO
       extend ActiveSupport::Concern
       include Node
       include GemLogger::LoggerSupport
+      include MonitorMixin
 
       attr_accessor :uuid, :presorted
 
@@ -23,7 +24,9 @@ module TivoHMO
       end
 
       def refresh
-        self.children = []
+        synchronize do
+          self.children.clear
+        end
       end
 
       def child_count

data/lib/tivohmo/subtitles_util.rb

@@ -0,0 +1,109 @@
+require 'iso-639'
+require 'listen'
+
+module TivoHMO
+
+  class SubtitlesUtil
+    include GemLogger::LoggerSupport
+    include MonitorMixin
+    include Singleton
+
+    ALLOWED_SUBTITLE_FORMATS = %w[srt]
+
+    def subtitles_for_media_file(media_path)
+      synchronize do
+        fq_path = File.realdirpath(media_path)
+        base_dir = File.dirname(fq_path)
+        base_file = fq_path.chomp(File.extname(fq_path))
+        Array(subtitles_for_dir(base_dir)[base_file])
+      end
+    end
+
+    private
+
+    def refresh_subtitles(dir)
+      synchronize do
+        @subtitle_files ||= {}
+        @subtitle_files[dir] = nil
+      end
+    end
+
+    def subtitles_for_dir(dir)
+      @subtitle_files ||= {}
+      @subtitle_files[dir] ||= begin
+        subs = {}
+
+        Dir["#{dir}/*"].each do |f|
+          # /path/to/movie.<lang_code>.srt
+          pieces = f.scan(/(.+)\.(\w+)\.(\w+)$/).flatten
+          next if pieces.size != 3
+
+          format = pieces[-1].downcase
+          next unless ALLOWED_SUBTITLE_FORMATS.include?(format)
+
+          lang_code = pieces[-2]
+          base_path = pieces[-3]
+
+          sub = create_subtitle(f, lang_code, format)
+          next unless sub
+
+          subs[base_path] ||= []
+          subs[base_path] << sub
+        end
+
+        setup_change_listener(dir) unless @subtitle_files.has_key?(dir)
+
+        subs
+      end
+    end
+
+    def create_subtitle(subtitle_file, lang_code, format)
+      iso_entry = ISO_639.find_by_code(lang_code.downcase)
+      if iso_entry.nil?
+        logger.warn "Subtitle filename has invalid language code: #{subtitle_file}"
+        return nil
+      end
+
+      st = TivoHMO::API::Subtitle.new
+      st.language = iso_entry.english_name
+      # use the verbatim code as we could have multiple due to case insensitive fs
+      st.language_code = lang_code
+      st.format = format
+      st.type = :file
+      st.location = subtitle_file
+
+      st
+    end
+
+    def setup_change_listener(dir)
+      logger.debug "Setting up change listener on #{dir}"
+
+      listener = Listen.to(dir) do |modified, added, removed|
+        logger.debug "Detected filesystem change on #{dir}"
+
+        dirs = (added + removed).flatten.collect do |path|
+          logger.debug "Inspecting filesystem change: #{path}"
+
+          if ALLOWED_SUBTITLE_FORMATS.include?(File.extname(path)[1..-1])
+            File.dirname(path)
+          else
+            nil
+          end
+        end
+        dirs = dirs.compact.uniq
+
+        dirs.each do |dir|
+          logger.debug "Handling filesystem change: #{dir.inspect}"
+          refresh_subtitles(dir)
+        end
+
+        logger.debug "Completed filesystem refresh on #{dir}"
+      end
+
+      listener.start
+      listener
+    end
+
+  end
+
+end

data/lib/tivohmo/version.rb

@@ -1,3 +1,3 @@
 module TivoHMO
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/adapters/filesystem/application_spec.rb

@@ -16,4 +16,70 @@ describe TivoHMO::Adapters::Filesystem::Application do
 
   end
 
+  describe "#children" do
+
+    it "watches for filesystem addition in self" do
+      with_file_tree('1.avi', foo: ['2.avi']) do |dir|
+        subject = described_class.new(dir)
+        expect(subject.children.collect(&:title)).to match_array ['1.avi', 'Foo']
+        FileUtils.touch "#{dir}/3.avi"
+        sleep 0.5
+        expect(subject.children.collect(&:title)).to match_array ['3.avi','1.avi', 'Foo']
+      end
+    end
+
+    it "watches for filesystem addition in children" do
+      with_file_tree('1.avi', foo: ['2.avi']) do |dir|
+        subject = described_class.new(dir)
+        expect(subject.children.collect(&:title)).to match_array ['1.avi', 'Foo']
+        FileUtils.touch "#{dir}/foo/3.avi"
+        sleep 0.5
+        expect(subject.find("Foo").children.collect(&:title)).to match_array ['3.avi','2.avi']
+      end
+    end
+
+    it "watches for filesystem removal in self" do
+      with_file_tree('1.avi', foo: ['2.avi']) do |dir|
+        subject = described_class.new(dir)
+        expect(subject.children.collect(&:title)).to match_array ['1.avi', 'Foo']
+        FileUtils.rm "#{dir}/1.avi"
+        sleep 0.5
+        expect(subject.children.collect(&:title)).to match_array ['Foo']
+      end
+    end
+
+    it "watches for filesystem removal in children" do
+      with_file_tree('1.avi', foo: ['2.avi']) do |dir|
+        subject = described_class.new(dir)
+        expect(subject.children.collect(&:title)).to match_array ['1.avi', 'Foo']
+        FileUtils.rm "#{dir}/foo/2.avi"
+        sleep 0.5
+        expect(subject.find("Foo").children.collect(&:title)).to match_array []
+      end
+    end
+
+    it "watches for filesystem mod in self" do
+      with_file_tree('1.avi', foo: ['2.avi']) do |dir|
+        subject = described_class.new(dir)
+        orig = subject.find('1.avi')
+        sleep 1
+        FileUtils.touch "#{dir}/1.avi"
+        sleep 0.5
+        expect(subject.find('1.avi')).to_not eq(orig)
+      end
+    end
+
+    it "watches for filesystem mod in children" do
+      with_file_tree('1.avi', foo: ['2.avi']) do |dir|
+        subject = described_class.new(dir)
+        orig = subject.find('Foo/2.avi')
+        sleep 1
+        FileUtils.touch "#{dir}/foo/2.avi"
+        sleep 0.5
+        expect(subject.find('Foo/2.avi')).to_not eq(orig)
+      end
+    end
+
+  end
+
 end

data/spec/adapters/filesystem/file_item_spec.rb

@@ -26,6 +26,18 @@ describe TivoHMO::Adapters::Filesystem::FileItem do
         expect(subject.created_at).to_not be_nil
       end
 
+      it "should instantiate with subtitle" do
+        file = __FILE__
+        st = TivoHMO::API::Subtitle.new()
+        st.language_code = 'en'
+        st.language = 'English'
+        st.type = :file
+        subject = described_class.new(file, st)
+        expect(subject).to be_a described_class
+        expect(subject.subtitle).to eq(st)
+        expect(subject.title).to eq "[en file sub] #{File.basename(file)}"
+      end
+
     end
 
   end

data/spec/adapters/filesystem/folder_container_spec.rb

@@ -80,33 +80,35 @@ describe TivoHMO::Adapters::Filesystem::FolderContainer do
       expect(subject.children.object_id).to eq subject.children.object_id
     end
 
-    it "watches for filesystem addition" do
-      with_file_tree('1.avi', foo: ['2.avi']) do |dir|
+    it "should have children with subtitles" do
+      with_file_tree('1.avi', '1.en.srt', '2.avi') do |dir|
+        described_class.config_set(:enable_subtitles, true)
         subject = described_class.new(dir)
-        expect(subject.children.collect(&:title)).to match_array ['1.avi', 'Foo']
-        FileUtils.touch "#{dir}/3.avi"
-        sleep 0.5
-        expect(subject.children.collect(&:title)).to match_array ['3.avi','1.avi', 'Foo']
-      end
-    end
 
-    it "watches for filesystem removal" do
-      with_file_tree('1.avi', foo: ['2.avi']) do |dir|
-        subject = described_class.new(dir)
-        expect(subject.children.collect(&:title)).to match_array ['1.avi', 'Foo']
-        FileUtils.rm "#{dir}/1.avi"
-        sleep 0.5
-        expect(subject.children.collect(&:title)).to match_array ['Foo']
+        expect(subject.children.collect(&:title)).to match_array ['1.avi', '2.avi']
+
+        subgroup = subject.children.find {|c| c.is_a?(TivoHMO::Adapters::Filesystem::Group) }
+        expect(subgroup).to_not be_nil
+        primary = subgroup.children[0]
+        sub = subgroup.children[1]
+        expect(primary.title).to_not match(/sub\]/)
+        expect(sub.title).to match(primary.title)
+        expect(sub.title).to match(/sub\]/)
+        expect(sub.subtitle.language).to_not be_nil
+        expect(sub.subtitle.language_code).to_not be_nil
+        expect(sub.subtitle.location).to_not be_nil
+
+        withoutsub = subject.children.find {|c| ! c.is_a?(TivoHMO::Adapters::Filesystem::Group) }
+        expect(withoutsub).to_not be_nil
       end
     end
 
-    it "doesn't watch children" do
-      with_file_tree('1.avi', foo: ['2.avi']) do |dir|
+    it "should allow disabling subtitles" do
+      with_file_tree('1.avi', '1.en.srt', '2.avi') do |dir|
+        described_class.config_set(:enable_subtitles, false)
         subject = described_class.new(dir)
-        oldid = subject.children.object_id
-        FileUtils.touch "#{dir}/foo/3.avi"
-        sleep 0.5
-        expect(subject.children.object_id).to eq oldid
+        withsub = subject.children.find {|c| c.is_a?(TivoHMO::Adapters::Filesystem::Group) }
+        expect(withsub).to be_nil
       end
     end