vcs_ruby 1.0.1 → 1.1.0

data/lib/configuration.rb

@@ -3,7 +3,7 @@
 #
 
 require 'font'
-
+require 'singleton'
 
 class ::Hash
     def deep_merge(second)
@@ -14,22 +14,21 @@ end
 
 module VCSRuby
   class Configuration
-    attr_accessor :capturer
+    include Singleton
+
     attr_reader :header_font, :title_font, :timestamp_font, :signature_font
+    attr_writer :verbose, :quiet, :capturer
 
-    def initialize profile
+    def initialize
       default_config_file = File.expand_path("defaults.yml", File.dirname(__FILE__))
       @config = ::YAML::load_file(default_config_file)
 
       local_config_files = ['~/.vcs.rb.yml']
       local_config_files.select{ |f| File.exists?(f) }.each do |local_config_file|
-        puts "Local configuration file loaded: #{local_config_file}" if Tools.verbose?
         local_config = YAML::load_file(local_config_file)
         @config = @config.deep_merge(local_config)
       end
 
-      load_profile profile if profile
-      
       @header_font    = Font.new @config['style']['header']['font'],    @config['style']['header']['size']
       @title_font     = Font.new @config['style']['title']['font'],     @config['style']['title']['size']
       @timestamp_font = Font.new @config['style']['timestamp']['font'], @config['style']['timestamp']['size']
@@ -42,7 +41,7 @@ module VCSRuby
       found = false
       profiles.each do |profile|
         if File.exists?(profile)
-          puts "Profile loaded: #{profile}" if Tools.verbose?
+          puts "Profile loaded: #{profile}" if verbose?
           config = YAML::load_file(profile)
           @config = @config.deep_merge(config)
           found = true
@@ -52,6 +51,18 @@ module VCSRuby
       raise "No profile '#{profile}' found" unless found
     end
 
+    def verbose?
+      @verbose
+    end
+
+    def quiet?
+      @quiet
+    end
+
+    def capturer
+      @capturer || :any
+    end
+
     def rows
       @config['main']['rows'] ? @config['main']['rows'].to_i : nil
     end

data/lib/contact_sheet.rb

@@ -10,49 +10,45 @@ require 'vcs'
 
 module VCSRuby
   class ContactSheet
-    attr_accessor :capturer, :format, :signature, :title, :highlight
+    attr_accessor :signature, :title, :highlight
     attr_accessor :softshadow, :timestamp, :polaroid
     attr_reader :thumbnail_width, :thumbnail_height
     attr_reader :length, :from, :to
 
-    def initialize video, profile = nil
-      @capturer = :any
-      @configuration = Configuration.new profile
+    def initialize video, capturer
+      @video = video
+      @capturer = capturer
       @signature = "Created by Video Contact Sheet Ruby"
-      initialize_capturers video
-      initialize_filename(File.basename(@video, '.*'))
-      puts "Processing #{File.basename(video)}..." unless Tools.quiet?
+      initialize_filename
+
+      if Configuration.instance.verbose?
+        puts "Processing #{File.basename(video.full_path)}..."
+      end
+
+      return unless @video.valid?
+
       detect_video_properties
 
-      @thumbnails = []
-      @filters = []
+      @from = TimeIndex.new 0
+      @to = @video.info.duration
 
-      @timestamp = @configuration.timestamp
-      @softshadow = @configuration.softshadow
-      @polaroid = @configuration.polaroid
+      @timestamp = Configuration.instance.timestamp
+      @softshadow = Configuration.instance.softshadow
+      @polaroid = Configuration.instance.polaroid
 
       @tempdir = Dir.mktmpdir
 
       ObjectSpace.define_finalizer(self, self.class.finalize(@tempdir) )
+      initialize_geometry(Configuration.instance.rows, Configuration.instance.columns, Configuration.instance.interval)
 
-      initialize_geometry(@configuration.rows, @configuration.columns, @configuration.interval)
     end
 
-    def initialize_filename filename
-      @out_path = File.dirname(filename)
-      @out_filename = File.basename(filename,'.*')
-      ext = File.extname(filename).gsub('.', '')
-      if ['png', 'jpg', 'jpeg', 'tiff'].include?(ext)
-        @format ||= ext.to_sym
-      end
-    end
+    def initialize_filename override = nil
+      @out_path = File.dirname(@video.full_path)
+      @out_filename = File.basename(override || @video.full_path,'.*')
 
-    def filename
-      "#{@out_filename}.#{@format ? @format.to_s : 'png'}"
-    end
-
-    def full_path
-      File.join(@out_path, filename)
+      extension = override ?  File.extname(override) : ''
+      @format = extension.length > 0 ? extension : '.png'
     end
 
     def initialize_geometry(rows, columns, interval)
@@ -62,6 +58,14 @@ module VCSRuby
       @interval = interval
     end
 
+    def filename
+      "#{@out_filename}#{@format}"
+    end
+
+    def full_path
+      File.join(@out_path, filename)
+    end
+
     def rows
       @rows
     end
@@ -71,7 +75,7 @@ module VCSRuby
     end
 
     def interval
-      @interval || (@to - @from) / (number_of_caps + 1)
+      @interval || (@to - @from) / (number_of_caps)
     end
 
     def number_of_caps
@@ -112,61 +116,37 @@ module VCSRuby
       end
     end
 
-
-    def self.finalize(tempdir)
-      proc do
-        puts "Cleaning up..." unless Tools.quiet?
-        FileUtils.rm_r tempdir
-      end
-    end
-
     def build
-      selected_capturer.format = selected_capturer.available_formats.first
-      initialize_filters
-      initialize_thumbnails
-      capture_thumbnails
+      if (@video.info.duration.total_seconds < 1.0)
+        puts "Video is shorter than 1 sec"
+      else
+        initialize_filters
+        initialize_thumbnails
+        capture_thumbnails
 
-      puts "Composing standard contact sheet..." unless Tools.quiet?
-      montage = splice_montage(montage_thumbs)
+        puts "Composing standard contact sheet..." unless Configuration.instance.quiet?
+        montage = splice_montage(montage_thumbs)
 
-      image = MiniMagick::Image.open(montage)
+        image = MiniMagick::Image.open(montage)
 
-      puts "Adding header and footer..." unless Tools.quiet?
-      final = add_header_and_footer image
+        puts "Adding header and footer..." unless Configuration.instance.quiet?
+        final = add_header_and_footer image
 
-      puts "Done. Output wrote to '#{filename}'" unless Tools.quiet?
-      FileUtils.mv(final, full_path)
+        puts "Done. Output wrote to '#{filename}'" unless Configuration.instance.quiet?
+        FileUtils.mv(final, full_path)
+      end
     end
 
-
 private
-    def selected_capturer
-      result = nil
-      if @capturer == nil || @capturer == :any
-        result = available_capturers.first
-      else
-        result =  available_capturers.select{ |c| c.name == @capturer }.first
+    def self.finalize(tempdir)
+      proc do
+        puts "Cleaning up..." unless Configuration.instance.quiet?
+        FileUtils.rm_r tempdir
       end
-      raise "Selected Capturer (#{@capturer.to_s}) not available. Install one of these: #{@capturers.map{ |c| c.name }.join(', ')}" unless result
-      return result
-    end
-
-    def initialize_capturers video
-      @capturers = []
-      @capturers << LibAV.new(video)
-      @capturers << MPlayer.new(video)
-      @capturers << FFmpeg.new(video)
-
-      @video = video
-
-      puts "Available capturers: #{available_capturers.map{ |c| c.to_s }.join(', ')}" if Tools.verbose?
-    end
-    
-    def available_capturers 
-      @capturers.select{ |c| c.available? }
     end
 
     def initialize_filters
+      @filters = []
       @filters << :resize_filter
       @filters << :softshadow_filter if softshadow
       @filters << :timestamp_filter if timestamp
@@ -174,14 +154,14 @@ private
     end
 
     def initialize_thumbnails
-      time = @from
+      @thumbnails = []
+      time = @from + (interval / 2)
       (1..number_of_caps).each do |i|
-        thumb = Thumbnail.new selected_capturer, @video, @configuration
-
+        thumb = Frame.new @video, @capturer, time
+        time = time + interval
         thumb.width = thumbnail_width
         thumb.height = thumbnail_height
-        thumb.time = (time += interval)
-        thumb.image_path = File::join(@tempdir, "th#{"%03d" % i}.#{selected_capturer.format.to_s}")
+        thumb.filename = File::join(@tempdir, "th#{"%03d" % i}.#{@capturer.format_extension}")
         thumb.filters.push(*@filters)
 
         @thumbnails << thumb
@@ -189,11 +169,11 @@ private
     end
 
     def capture_thumbnails
-      puts "Capturing in range [#{from}..#{to}]. Total length: #{@length}" unless Tools.quiet?
+      puts "Capturing in range [#{from}..#{to}]. Total length: #{@length}" unless Configuration.instance.quiet?
 
       @thumbnails.each_with_index do |thumbnail, i|
-        puts "Generating capture ##{i + 1}/#{number_of_caps} #{thumbnail.time}..." unless Tools::quiet?
-        if @configuration.blank_evasion?
+        puts "Generating capture ##{i + 1}/#{number_of_caps} #{thumbnail.time}..." unless Configuration.instance.quiet?
+        if Configuration.instance.blank_evasion?
           thumbnail.capture_and_evade interval
         else
           thumbnail.capture
@@ -208,25 +188,25 @@ private
     end
 
     def detect_length
-      @length = selected_capturer.length
+      @length = @video.info.duration
 
       @from = TimeIndex.new 0.0
       @to = @length
     end
 
     def detect_dimensions
-      @thumbnail_width = selected_capturer.width
-      @thumbnail_height = selected_capturer.height
+      @thumbnail_width = @video.video.width
+      @thumbnail_height = @video.video.height
     end
 
     def montage_thumbs
       file_path = File::join(@tempdir, 'montage.png')
       MiniMagick::Tool::Montage.new do |montage|
-        montage.background @configuration.contact_background
+        montage.background Configuration.instance.contact_background
         @thumbnails.each do |thumbnail|
-          montage << thumbnail.image_path
+          montage << thumbnail.filename
         end
-        montage.geometry "+#{@configuration.padding}+#{@configuration.padding}"
+        montage.geometry "+#{Configuration.instance.padding}+#{Configuration.instance.padding}"
         # rows or columns can be nil (auto fit)
         montage.tile "#{@columns}x#{@rows}"
         montage << file_path
@@ -236,18 +216,18 @@ private
 
     def splice_montage montage_path
       if softshadow
-        left = @configuration.padding + 3
-        top = @configuration.padding + 5
-        bottom = right = @configuration.padding
+        left = Configuration.instance.padding + 3
+        top = Configuration.instance.padding + 5
+        bottom = right = Configuration.instance.padding
       else
-        left = right = top = bottom = @configuration.padding
-      end 
+        left = right = top = bottom = Configuration.instance.padding
+      end
 
 
       file_path = File::join(@tempdir, 'spliced.png')
       MiniMagick::Tool::Convert.new do |convert|
         convert << montage_path
-        convert.background @configuration.contact_background
+        convert.background Configuration.instance.contact_background
 
         convert.splice "#{left}x#{top}"
         convert.gravity 'SouthEast'
@@ -262,14 +242,14 @@ private
       file_path = File::join(@tempdir, 'title.png')
       MiniMagick::Tool::Convert.new do |convert|
         convert.stack do |ul|
-          ul.size "#{montage.width}x#{@configuration.title_font.line_height}"
-          ul.xc @configuration.title_background
-          if @configuration.title_font.exists?
-            ul.font @configuration.title_font.path
+          ul.size "#{montage.width}x#{Configuration.instance.title_font.line_height}"
+          ul.xc Configuration.instance.title_background
+          if Configuration.instance.title_font.exists?
+            ul.font Configuration.instance.title_font.path
           end
-          ul.pointsize @configuration.title_font.size
-          ul.background @configuration.title_background
-          ul.fill @configuration.title_color
+          ul.pointsize Configuration.instance.title_font.size
+          ul.background Configuration.instance.title_background
+          ul.fill Configuration.instance.title_color
           ul.gravity 'Center'
           ul.annotate(0, @title)
         end
@@ -281,12 +261,11 @@ private
 
     def create_highlight montage
       puts "Generating highlight..."
-      thumb = Thumbnail.new selected_capturer, @video, @configuration
+      thumb = Frame.new @video, @highlight
 
       thumb.width = thumbnail_width
       thumb.height = thumbnail_height
-      thumb.time = @highlight
-      thumb.image_path = File::join(@tempdir, "highlight_thumb.png")
+      thumb.filename = File::join(@tempdir, "highlight_thumb.png")
       thumb.capture
       thumb.apply_filters
 
@@ -294,9 +273,9 @@ private
       MiniMagick::Tool::Convert.new do |convert|
         convert.stack do |a|
           a.size "#{montage.width}x#{thumbnail_height+20}"
-          a.xc @configuration.highlight_background
+          a.xc Configuration.instance.highlight_background
           a.gravity 'Center'
-          a << thumb.image_path
+          a << thumb.filename
           a.composite
         end
         convert.stack do |a|
@@ -312,33 +291,33 @@ private
 
     def add_header_and_footer montage
       file_path = File::join(@tempdir, filename)
-      header_height = @configuration.header_font.line_height * 3
-      signature_height = @configuration.signature_font.line_height + 8
+      header_height = Configuration.instance.header_font.line_height * 3
+      signature_height = Configuration.instance.signature_font.line_height + 8
       MiniMagick::Tool::Convert.new do |convert|
         convert.stack do |a|
           a.size "#{montage.width - 18}x1"
-          a.xc @configuration.header_background
+          a.xc Configuration.instance.header_background
           a.size.+
-          if @configuration.header_font.exists?
-            a.font @configuration.header_font.path
+          if Configuration.instance.header_font.exists?
+            a.font Configuration.instance.header_font.path
           end
-          a.pointsize @configuration.header_font.size
-          a.background @configuration.header_background
-          a.fill @configuration.header_color
+          a.pointsize Configuration.instance.header_font.size
+          a.background Configuration.instance.header_background
+          a.fill Configuration.instance.header_color
           a.stack do |b|
             b.gravity 'West'
             b.stack do |c|
               c.label 'Filename: '
-              if @configuration.header_font.exists?
-                c.font  @configuration.header_font.path
+              if Configuration.instance.header_font.exists?
+                c.font  Configuration.instance.header_font.path
               end
-              c.label File.basename(@video)
+              c.label File.basename(@video.full_path)
               c.append.+
             end
-            if @configuration.header_font.exists?            
-              b.font @configuration.header_font.path
+            if Configuration.instance.header_font.exists?
+              b.font Configuration.instance.header_font.path
             end
-            b.label "File size: #{Tools.to_human_size(File.size(@video))}"
+            b.label "File size: #{Tools.to_human_size(File.size(@video.full_path))}"
             b.label "Length: #{@length.to_timestamp}"
             b.append
             b.crop "#{montage.width}x#{header_height}+0+0"
@@ -347,11 +326,11 @@ private
           a.stack do |b|
             b.size "#{montage.width}x#{header_height}"
             b.gravity 'East'
-            b.fill @configuration.header_color
+            b.fill Configuration.instance.header_color
             b.annotate '+0-1'
-            b << "Dimensions: #{selected_capturer.width}x#{selected_capturer.height}\nFormat: #{selected_capturer.video_codec} / #{selected_capturer.audio_codec}\nFPS: #{"%.02f" % selected_capturer.fps}"
+            b << "Dimensions: #{@video.video.width}x#{@video.video.height}\nFormat: #{@video.video.codec(true)} / #{@video.audio.codec(true)}\nFPS: #{"%.02f" % @video.video.frame_rate.to_f}"
           end
-          a.bordercolor @configuration.header_background
+          a.bordercolor Configuration.instance.header_background
           a.border 9
         end
         convert << create_title(montage) if @title
@@ -362,18 +341,18 @@ private
           convert.stack do |a|
             a.size "#{montage.width}x#{signature_height}"
             a.gravity 'Center'
-            a.xc @configuration.signature_background
-            if @configuration.signature_font.exists?
-              a.font @configuration.signature_font.path
+            a.xc Configuration.instance.signature_background
+            if Configuration.instance.signature_font.exists?
+              a.font Configuration.instance.signature_font.path
             end
-            a.pointsize @configuration.signature_font.size
-            a.fill @configuration.signature_color
+            a.pointsize Configuration.instance.signature_font.size
+            a.fill Configuration.instance.signature_color
             a.annotate(0, @signature)
           end
           convert.append
         end
-        if format == :jpg || format == :jpeg
-          convert.quality(@configuration.quality)
+        if @format == :jpg || @format == :jpeg
+          convert.quality(Configuration.instance.quality)
         end
         convert << file_path
       end

data/lib/defaults.yml

@@ -1,6 +1,6 @@
 main:
   rows: 4
-  columns: 4 
+  columns: 4
   interval: ~
   padding: 2
   quality: 95
@@ -20,7 +20,7 @@ style:
     color: Black
     background: White
   highlight:
-    background: LightGoldenRod 
+    background: LightGoldenRod
   contact:
     background: White
   timestamp:
@@ -35,5 +35,5 @@ style:
     background: SlateGray
 lowlevel:
   blank_evasion: true
-  blank_threshold: 0.10
-  blank_alternatives: [ -5, 5, -10, 10, -30, 30]
+  blank_threshold: 0.08
+  blank_alternatives: [ -2, 2, -5, 5, -10, 10, -15, 15, -30, 30, 0]

data/lib/font.rb

@@ -12,29 +12,29 @@ module VCSRuby
     attr_reader :name, :path, :size
 
     @@fonts = {}
-    
+
     def initialize name, size
       @name = name
       @path = find_path
       @size = size
     end
-    
+
     def exists?
       load_font_cache if @@fonts.length == 0
-      
+
       !!font_by_name(@name)
     end
-    
+
     def find_path
       load_font_cache if @@fonts.length == 0
-      
+
       if exists?
         font_by_name(@name).glyphs
       else
         nil
       end
     end
-    
+
     def font_by_name name
       if name =~ /\./
         key, font = @@fonts.select{ |key, f| f.glyphs =~ /#{name}\z/ }.first
@@ -43,26 +43,26 @@ module VCSRuby
         @@fonts[name]
       end
     end
-    
+
     def load_font_cache
-     
+
       fonts = MiniMagick::Tool::Identify.new(whiny: false) do |identify|
         identify.list 'font'
       end
 
       parse_fonts(fonts)
     end
-    
+
     def parse_fonts(fonts)
       font = nil
       fonts.lines.each do |line|
         key, value = line.strip.split(':', 2).map(&:strip)
-        
+
         next if [nil, 'Path'].include? key
 
         if key == 'Font'
-          @@fonts[value] = font = IMFont.new(value) 
-        else           
+          @@fonts[value] = font = IMFont.new(value)
+        else
           font.send("#{key}=", value)
         end
       end