tivohmo 0.2.3 → 0.3.0

data/lib/tivohmo/adapters/settings/key_container.rb

@@ -0,0 +1,35 @@
+module TivoHMO
+  module Adapters
+    module Settings
+
+      # A Container for config keys
+      class KeyContainer
+        include TivoHMO::API::Container
+        include GemLogger::LoggerSupport
+        include MonitorMixin
+
+        def initialize(key)
+          super(key)
+          self.presorted = true
+        end
+
+        def children
+          synchronize do
+            if super.blank?
+              spec = Config.instance.known_config[identifier]
+              add_child(DisplayItem.new("Help", spec[:description]))
+              add_child(DisplayItem.new("Default Value: #{spec[:default_value]}"))
+              val = Config.instance.get(identifier)
+              add_child(DisplayItem.new("Current Value: #{!!val}"))
+              add_child(SetValueItem.new(identifier, !val))
+            end
+          end
+
+          super
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tivohmo/adapters/settings/metadata.rb

@@ -0,0 +1,26 @@
+module TivoHMO
+  module Adapters
+    module Settings
+
+      # Dummy metadata
+      class Metadata
+        include TivoHMO::API::Metadata
+        include GemLogger::LoggerSupport
+
+        attr_accessor :item_detail_callback
+
+        def initialize(item)
+          super(item)
+        end
+
+        # hack - star_rating only gets called when viewing item_detail
+        def star_rating
+          item_detail_callback.try(:call, self)
+          return nil
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tivohmo/adapters/settings/reset_defaults_item.rb

@@ -0,0 +1,39 @@
+require 'active_support/core_ext/string/inflections'
+require 'listen'
+
+module TivoHMO
+  module Adapters
+    module Settings
+
+      # An Item for toggling boolean bvalue
+      class ResetDefaultsItem
+        include TivoHMO::API::Item
+        include GemLogger::LoggerSupport
+        include MonitorMixin
+
+        def initialize()
+          super('reset_all')
+          self.title = "Reset Defaults"
+        end
+
+        def metadata
+          md = super
+
+          md.description = "All runtime config has now been reset to defaults, hit back to return"
+
+          md.item_detail_callback = Proc.new do
+            logger.info("Resetting defaults")
+            Config.instance.known_config.each do |key, spec|
+              Config.instance.set(key, spec[:default_value])
+            end
+            parent.children.clear
+          end
+
+          md
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tivohmo/adapters/settings/set_value_item.rb

@@ -0,0 +1,38 @@
+require 'active_support/core_ext/string/inflections'
+require 'listen'
+
+module TivoHMO
+  module Adapters
+    module Settings
+
+      # An Item for toggling boolean bvalue
+      class SetValueItem
+        include TivoHMO::API::Item
+        include GemLogger::LoggerSupport
+        include MonitorMixin
+
+        def initialize(key, new_value)
+          super(key)
+          @new_value = new_value
+          self.title = "Set value to #{new_value}"
+        end
+
+        def metadata
+          md = super
+
+          md.description = "Value has now been set to #{@new_value}, hit back to return"
+
+          md.item_detail_callback = Proc.new do
+            logger.info("Setting #{identifier} to: #{@new_value}")
+            Config.instance.set(identifier, @new_value)
+            parent.children.clear
+          end
+
+          md
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module TivoHMO
+  module Adapters
+    module Settings
+
+
+      # Dummy transcoder
+      class Transcoder
+        include TivoHMO::API::Transcoder
+        include GemLogger::LoggerSupport
+
+        def transcode(writeable_io, format="video/x-tivo-mpeg")
+          nil
+        end
+
+        def transcoder_options(format="video/x-tivo-mpeg")
+          {}
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tivohmo/adapters/settings.rb

@@ -0,0 +1,7 @@
+require_relative 'settings/transcoder'
+require_relative 'settings/metadata'
+require_relative 'settings/reset_defaults_item'
+require_relative 'settings/set_value_item'
+require_relative 'settings/display_item'
+require_relative 'settings/key_container'
+require_relative 'settings/application'

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

@@ -50,6 +50,7 @@ module TivoHMO
           opts = select_audio_bitrate(opts)
           opts = select_audio_sample_rate(opts)
           opts = select_container(opts)
+          opts = select_subtitle(opts)
 
           custom = opts.delete(:custom)
           opts[:custom] = custom.join(" ") if custom
@@ -61,7 +62,7 @@ module TivoHMO
         protected
 
         def movie
-          @movie ||= FFMPEG::Movie.new(source_filename)
+          @movie ||= FFMPEG::Movie.new(item.file)
         end
 
         def video_info
@@ -199,6 +200,43 @@ module TivoHMO
           opts
         end
 
+        def select_subtitle(opts)
+
+          st = item.subtitle
+          if st
+            case st.type
+              when :file
+                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}\""
+                else
+                  logger.error "Subtitle doesn't exist at: #{file_glob}"
+                end
+              when :embedded
+                file = item.file
+                idx = st.location
+                logger.info "Using embedded subtitles [#{idx}] present at: #{file}"
+                opts[:custom] << "-vf subtitles=\"#{file}\":si=#{idx}"
+              else
+                logger.error "Unknown subtitle type: #{st.type}"
+            end
+          end
+
+          opts
+        end
+
         def run_transcode(output_filename, format)
 
           logger.info "Movie Info: " +

data/lib/tivohmo/api/container.rb

@@ -10,12 +10,13 @@ module TivoHMO
       include Node
       include GemLogger::LoggerSupport
 
-      attr_accessor :uuid
+      attr_accessor :uuid, :presorted
 
 
       def initialize(identifier)
         super(identifier)
         self.uuid = SecureRandom.uuid
+        self.presorted = false
 
         self.content_type = "x-tivo-container/tivo-videos"
         self.source_format = "x-tivo-container/folder"
@@ -25,6 +26,9 @@ module TivoHMO
         self.children = []
       end
 
+      def child_count
+        children.size
+      end
     end
 
   end

data/lib/tivohmo/api/item.rb

@@ -8,6 +8,8 @@ module TivoHMO
       include Node
       include GemLogger::LoggerSupport
 
+      attr_accessor :file, :subtitle
+
       def initialize(identifier)
         super(identifier)
         self.content_type = "video/x-tivo-mpeg"

data/lib/tivohmo/api/subtitle.rb

@@ -0,0 +1,13 @@
+module TivoHMO
+  module API
+
+    # Represents a subtitle
+    class Subtitle
+      include GemLogger::LoggerSupport
+
+      attr_accessor :language, :language_code, :format, :type, :location
+
+    end
+
+  end
+end

data/lib/tivohmo/api/transcoder.rb

@@ -17,12 +17,10 @@ module TivoHMO
       AUDIO_CODECS = %w[ac3 liba52 mp2]
       AUDIO_SAMPLE_RATES = %w[44100 48000]
 
-      attr_accessor :item,
-                    :source_filename
+      attr_accessor :item
 
       def initialize(item)
         self.item = item
-        self.source_filename = item.identifier
       end
 
       def transcode(writeable_io, format)

data/lib/tivohmo/api.rb

@@ -1,5 +1,6 @@
 require 'tivohmo/api/node'
 require 'tivohmo/api/item'
+require 'tivohmo/api/subtitle'
 require 'tivohmo/api/container'
 require 'tivohmo/api/transcoder'
 require 'tivohmo/api/metadata'

data/lib/tivohmo/beacon.rb

@@ -11,8 +11,6 @@ module TivoHMO
       @interval = interval
       @limit = limit
       @uid = SecureRandom.uuid
-      @socket = UDPSocket.new(Socket::AF_INET)
-      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
       @services = ['TiVoMediaServer:%s/http' % service_port]
       @running = false
     end
@@ -66,7 +64,9 @@ module TivoHMO
       bcast_port = 2190
       packet = beacon_data('broadcast')
       logger.debug "Sending beacon packet: #{packet}"
-      @socket.send(packet, 0, bcast_ip, bcast_port)
+      socket = UDPSocket.new(Socket::AF_INET)
+      socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+      socket.send(packet, 0, bcast_ip, bcast_port)
     end
 
   end

data/lib/tivohmo/cli.rb

@@ -22,18 +22,26 @@ module TivoHMO
 
         e.g.
 
-        tivohmo -a TivoHMO::Adapters::Filesystem::Application -i ~/Video/Movies \\
-                -a TivoHMO::Adapters::Filesystem::Application -i ~/Video/TV
+        tivohmo -t Movies
+                  -a TivoHMO::Adapters::Filesystem::Application \\
+                  -i ~/Video/Movies \\
+                -t "TV Shows" \\
+                  -a TivoHMO::Adapters::Filesystem::Application \\
+                  -i ~/Video/TV
 
         to run two top level filesystem video serving apps for different dirs, or
 
-        tivohmo -a TivoHMO::Adapters::Filesystem::Application -t Vids -i ~/Video
+        tivohmo -t Vids \\
+                  -a TivoHMO::Adapters::Filesystem::Application \\
+                  -i ~/Video
 
-        to run the single filesystem app with a custom title, or
+        to run the single filesystem app, or
 
-        tivohmo -a TivoHMO::Adapters::Plex::Application -t PlexVideo -i localhost
+        tivohmo -t PlexVideo \\
+                  -a TivoHMO::Adapters::Plex::Application \\
+                  -i localhost
 
-        to run the single plex app with a custom title
+        to run the single plex app
       DESC
       desc.split("\n").collect(&:strip).join("\n")
     end
@@ -62,6 +70,13 @@ module TivoHMO
     option ["-f", "--configuration"],
            "FILE", "load configuration from given filename\n"
 
+    option ["-s", "--settings"],
+           "FILE", "a writable file for storing runtime settings\n"
+
+    option ["-t", "--title"],
+           "TITLE", "setup an application for the given title\n",
+           multivalued: true
+
     option ["-a", "--application"],
            "CLASSNAME", "use the given application class\n",
            multivalued: true
@@ -71,10 +86,6 @@ module TivoHMO
            "a string that has meaning to the application\n",
            multivalued: true
 
-    option ["-t", "--title"],
-           "TITLE", "use the given title for the application\n",
-           multivalued: true
-
     option ["-T", "--transcoder"],
            "CLASSNAME", "override the application's transcoder class\n",
            multivalued: true
@@ -86,59 +97,37 @@ module TivoHMO
     option ["-b", "--beacon"],
            "LIMIT:INTERVAL", "configure beacon limit and/or interval\n"
 
+    option ["-l", "--install"],
+           :flag, "install tivohmo into your system\n"
+
     def execute
+
       if version?
         puts "TivoHMO Version #{TivoHMO::VERSION}"
         return
       end
 
-      setup_logging
-
-      logger.info "TivoHMO #{TivoHMO::VERSION} starting up"
+      install_tivohmo if install?
 
-      if configuration
-        config = YAML.load_file(configuration)
+      c = File.expand_path(configuration) if configuration
+      s = File.expand_path(settings) if settings
+      TivoHMO::Config.instance.setup(c, s)
 
-        # allow cli option to override config file
-        set_if_default(:port, config['port'].to_i)
-      end
+      setup_logging
 
-      signal_usage_error "at least one application is required" unless application_list.present?
-      signal_usage_error "an initializer is needed for each application" unless
-          application_list.size == identifier_list.size
+      logger.info "TivoHMO #{TivoHMO::VERSION} starting up"
 
-      (application_list + transcoder_list + metadata_list).each do |c|
-        if c && c.starts_with?('TivoHMO::Adapters::')
-          path = c.downcase.split('::')[0..-2].join('/')
-          require path
-        end
-      end
+      # allow cli option to override config file
+      set_if_default(:port, TivoHMO::Config.instance.get(:port).try(:to_i))
 
       server = TivoHMO::API::Server.new
-
-      apps_with_config = application_list.zip(identifier_list,
-                                              title_list,
-                                              transcoder_list,
-                                              metadata_list)
-
-      apps_with_config.each do |app_classname, identifier, title, transcoder, metadata|
-        app_class = app_classname.constantize
-        app = app_class.new(identifier)
-
-        if title
-          app.title = title
-        else
-          app.title = "#{app.title} on #{server.title}"
-        end
-
-        app.transcoder_class = transcoder.constantize if transcoder
-        app.metadata_class = metadata.constantize if metadata
-        server.add_child(app)
-      end
+      apps = setup_applications
+      apps.each {|app| server.add_child(app) }
 
       preload_containers(server) if preload?
 
       opts = {}
+      set_if_default(:beacon, TivoHMO::Config.instance.get(:beacon))
       if beacon.present?
         limit, interval = beacon.split(":")
         opts[:limit] = limit.to_i if limit.present?
@@ -154,8 +143,10 @@ module TivoHMO
     private
 
     def setup_logging
+      set_if_default(:debug, TivoHMO::Config.instance.get(:debug))
       Logging.logger.root.level = :debug if debug?
 
+      set_if_default(:logfile, TivoHMO::Config.instance.get(:logfile))
       if logfile.present?
         appender = Logging.appenders.rolling_file(
             logfile,
@@ -176,7 +167,64 @@ module TivoHMO
     end
 
     def set_if_default(attr, new_value)
-      self.send("#{attr}=", new_value) if self.send(attr) == self.send("default_#{attr}")
+      opt = self.class.find_option("--#{attr}")
+      raise "Unknonwn cli attribute" unless opt
+      self.send("#{attr}=", new_value) if new_value && self.send(opt.read_method) == opt.default_value
+    end
+
+    def load_adapter(clazz)
+      if clazz && clazz.starts_with?('TivoHMO::Adapters::')
+        path = clazz.downcase.split('::')[0..-2].join('/')
+        require path
+      end
+    end
+
+    def setup_applications
+      app_specs = TivoHMO::Config.instance.get(:applications) || {}
+
+      title_list.each_with_index do |title, i|
+        app = app_specs[title]
+        app_was_in_config = app.present?
+        app = {} unless app_was_in_config
+
+        app[:application] = application_list[i] if application_list[i]
+        signal_usage_error "an application class is needed for each application" unless app[:application]
+
+        app[:identifier] = identifier_list[i] if identifier_list[i]
+        signal_usage_error "an initializer is needed for each application" unless app[:identifier]
+
+
+        app[:transcoder] = transcoder_list[i] if transcoder_list[i]
+        app[:metadata] = metadata_list[i] if metadata_list[i]
+
+        logger.debug "Merged app: #{title} - #{app.inspect}"
+        app_specs[title] = app unless app_was_in_config
+      end
+
+      signal_usage_error "at least one application is required" unless app_specs.present?
+
+      apps = app_specs.collect do |title, app_spec|
+        logger.debug "Adding app: #{title} - #{app_spec.inspect}"
+        load_adapter(app_spec[:application])
+
+        app_class = app_spec[:application].constantize
+        app = app_class.new(app_spec[:identifier])
+        app.title = title
+
+        if app_spec[:transcoder]
+          load_adapter(app_spec[:transcoder])
+          app.transcoder_class = app_spec[:transcoder].constantize
+        end
+
+        if app_spec[:metadata]
+          load_adapter(app_spec[:metadata])
+          app.metadata_class = app_spec[:metadata].constantize
+        end
+
+        app
+      end
+
+      apps
     end
 
     def preload_containers(server)
@@ -204,6 +252,85 @@ module TivoHMO
       end
     end
 
+    # Opens the file for writing by root
+    def sudo_open(path, mode, perms=0755, &block)
+      open("|sudo tee #{path} > /dev/null", perms, &block)
+    end
+
+    def get_binding(config)
+      binding
+    end
+
+    def install_file(src, dst, config={}, sudo=false)
+      src = File.expand_path(src)
+      dst = File.expand_path(dst)
+
+      block = Proc.new do |f|
+        template = ERB.new(File.read(src), nil, "-")
+        result = template.result(get_binding(config))
+        f.write(result)
+      end
+
+      puts "Installing #{dst}"
+
+      if sudo
+        sudo_open(dst, "w", &block)
+      else
+        open(dst, "w", &block)
+      end
+    end
+
+    def install_tivohmo
+      puts "Installing TivoHMO"
+
+      contrib_path = File.expand_path("../../../contrib", __FILE__)
+
+      case RUBY_PLATFORM
+        when /darwin/
+
+          config = {
+              daemon_config: "~/Library/LaunchAgents/tivohmo.plist",
+              configuration: "~/Library/Preferences/tivohmo.yml",
+              logfile: "~/Library/Logs/tivohmo.log",
+              settings: "~/Library/Preferences/tivohmo.runtime.yml"
+          }
+
+          install_file("#{contrib_path}/tivohmo.yml", config[:configuration], config)
+          install_file("#{contrib_path}/tivohmo.plist", config[:daemon_config], config)
+
+          puts "TivoHMO installed"
+          puts "To start tivohmo, execute the command:"
+          puts "\tlaunchctl load #{config[:daemon_config]}"
+          puts "To stop tivohmo, execute the command:"
+          puts "\tlaunchctl unload #{config[:daemon_config]}"
+
+        when /linux/
+
+          config = {
+              daemon_config: "/etc/init/tivohmo.conf",
+              configuration: "/etc/tivohmo.yml",
+              logfile: "/var/log/tivohmo.log",
+              settings: "/var/run/tivohmo.runtime.yml"
+          }
+
+          puts "Sudo password needed to install files"
+          install_file("#{contrib_path}/tivohmo.yml", config[:configuration], config, true)
+          install_file("#{contrib_path}/tivohmo.conf", config[:daemon_config], config, true)
+
+          puts "TivoHMO installed"
+          puts "To start tivohmo, execute the command:"
+          puts "\tsudo service tivohmo start"
+          puts "To stop tivohmo, execute the command:"
+          puts "\tsudo service tivohmo stop"
+
+        else
+          $stderr.puts "Unsupported OS: #{RUBY_PLATFORM}"
+          exit(1)
+      end
+
+      exit(0)
+    end
+
   end
 
 end