vcs_ruby 0.8.5 → 1.0.0

data/bin/vcs.rb

@@ -89,6 +89,18 @@ optparse = OptionParser.new do|opts|
   opts.on( '-l [HIGHLIGHT]', '--highlight [HIGHLIGHT]' 'Add the frame found at timestamp [HIGHLIGHT] as a highlight.') do |highlight|
     options[:highlight] = TimeIndex.new highlight
   end
+  opts.on("--[no-]timestamp", "Add timestamp to thumbnails. Default: true") do |timestamp|
+    options[:timestamp] = timestamp
+  end
+  opts.on("--[no-]shadow", "Add shadow to thumbnails. Default: true") do |shadow|
+    options[:shadow] = shadow
+  end
+  opts.on("--[no-]polaroid", "Thumbnails look as polaroid frames. Default: false") do |polaroid|
+    options[:polaroid] = polaroid
+  end
+  opts.on( '-p [PROFILE]', '--profile [PROFILE]' 'Loads additional setting from profile.yml.') do |profile|
+    options[:profile] = profile
+  end
   opts.on( '-q', '--quiet', 'Don\'t print progress messages just errors. Repeat to mute completely, even on error.') do |file|
     options[:quiet] = true
   end
@@ -139,5 +151,6 @@ begin
   end
 rescue Exception => e
   STDERR.puts "ERROR: #{e.message}"
+  STDERR.puts "#{e.backtrace.join("\n")}" if options[:verbose]
 end
 

data/lib/black.yml

@@ -0,0 +1,12 @@
+style:
+  header:
+    color: White
+    background: Black
+  title:
+    color: White
+    background: Black
+  contact:
+    background: Black
+  signature:
+    color: White
+    background: Black

data/lib/capturer.rb

@@ -9,27 +9,43 @@ module VCSRuby
     end
 
     def name
-      raise "NotImplmentedException"
+      raise "NotImplementedException"
     end
 
     def load_video
-      raise "NotImplmentedException"
+      raise "NotImplementedException"
     end
 
     def length
-      raise "NotImplmentedException"
+      raise "NotImplementedException"
     end
 
     def width
-      raise "NotImplmentedException"
+      raise "NotImplementedException"
     end
 
     def height
-      raise "NotImplmentedException"
+      raise "NotImplementedException"
     end
 
-    def grab time
-      raise "NotImplmentedException"
+    def grab time, image_path
+      raise "NotImplementedException"
+    end
+
+    def available_formats
+      raise "NotImplementedException"
+    end
+
+    def format
+      @format
+    end
+
+    def format= format
+      if available_formats.include? format
+        @format = format
+      else
+        raise "Capturer '#{name}' does not support format: '#{format}'"
+      end
     end
   end
 end

data/lib/command.rb

@@ -15,8 +15,9 @@ module VCSRuby
       @available
     end
 
-    def execute parameter, streams = 0
+    def execute parameter, streams = 0, no_error = false
       raise "Command '#{name}' not available" unless available?
+      puts "#{@command} #{parameter} #{streams}" if Tools.verbose?
       result = nil
       if Tools::windows?
         streams = '2> nul' if streams === 0
@@ -28,9 +29,10 @@ module VCSRuby
         result =`#{@command} #{parameter} #{streams}`
       end
 
-      raise "#{@command} failed with return value '#{$?}'"unless $? == 0
+      raise "#{@command} failed with return value '#{$?}'" unless $?.to_i == 0 || no_error
       return result
     end
+
 private
     # http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
     def which cmd

data/lib/configuration.rb

@@ -4,30 +4,54 @@
 
 require 'font'
 
+
+class ::Hash
+    def deep_merge(second)
+        merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+        self.merge(second, &merger)
+    end
+end
+
 module VCSRuby
   class Configuration
     attr_accessor :capturer
     attr_reader :header_font, :title_font, :timestamp_font, :signature_font
 
-    def initialize
+    def initialize profile
       default_config_file = File.expand_path("defaults.yml", File.dirname(__FILE__))
-      local_config_files = ['~/.vcs.rb.yml']
+      @config = ::YAML::load_file(default_config_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)
-        cconfig.merge(local_config)
+        @config = @config.deep_merge(local_config)
       end
 
-      @config = config
-
+      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']
       @signature_font = Font.new @config['style']['signature']['font'], @config['style']['signature']['size']
     end
 
+    def load_profile profile
+      profiles = [File.expand_path("#{profile}.yml", File.dirname(__FILE__)), "~/#{profile}.yml"]
+
+      found = false
+      profiles.each do |profile|
+        if File.exists?(profile)
+          puts "Profile loaded: #{profile}" if Tools.verbose?
+          config = YAML::load_file(profile)
+          @config = @config.deep_merge(config)
+          found = true
+        end
+      end
+
+      raise "No profile '#{profile}' found" unless found
+    end
+
     def rows
       @config['main']['rows'] ? @config['main']['rows'].to_i : nil
     end
@@ -99,5 +123,17 @@ module VCSRuby
     def blank_alternatives
       @config['lowlevel']['blank_alternatives'].map{ |e| TimeIndex.new e.to_i }
     end
+
+    def timestamp
+      !!@config['filter']['timestamp']
+    end
+
+    def polaroid
+      !!@config['filter']['polaroid']
+    end
+
+    def softshadow
+      !!@config['filter']['softshadow']
+    end
   end
  end

data/lib/contact_sheet.rb

@@ -11,12 +11,13 @@ require 'vcs'
 module VCSRuby
   class ContactSheet
     attr_accessor :capturer, :format, :signature, :title, :highlight
+    attr_accessor :softshadow, :timestamp, :polaroid
     attr_reader :thumbnail_width, :thumbnail_height
     attr_reader :length, :from, :to
 
-    def initialize video, capturer = :any
-      @capturer = capturer
-      @configuration = Configuration.new
+    def initialize video, profile = nil
+      @capturer = :any
+      @configuration = Configuration.new profile
       @signature = "Created by Video Contact Sheet Ruby"
       initialize_capturers video
       initialize_filename(File.basename(@video, '.*'))
@@ -24,6 +25,11 @@ module VCSRuby
       detect_video_properties
 
       @thumbnails = []
+      @filters = []
+
+      @timestamp = @configuration.timestamp
+      @softshadow = @configuration.softshadow
+      @polaroid = @configuration.polaroid
 
       @tempdir = Dir.mktmpdir
 
@@ -115,13 +121,15 @@ module VCSRuby
     end
 
     def build
+      selected_capturer.format = selected_capturer.available_formats.first
+      initialize_filters
       initialize_thumbnails
       capture_thumbnails
 
       puts "Composing standard contact sheet..." unless Tools.quiet?
-      s = splice_montage(montage_thumbs)
+      montage = splice_montage(montage_thumbs)
 
-      image = MiniMagick::Image.open(s)
+      image = MiniMagick::Image.open(montage)
 
       puts "Adding header and footer..." unless Tools.quiet?
       final = add_header_and_footer image
@@ -158,6 +166,13 @@ private
       @capturers.select{ |c| c.available? }
     end
 
+    def initialize_filters
+      @filters << :resize_filter
+      @filters << :softshadow_filter if softshadow
+      @filters << :timestamp_filter if timestamp
+      @filters << :polaroid_filter if polaroid
+    end
+
     def initialize_thumbnails
       time = @from
       (1..number_of_caps).each do |i|
@@ -166,7 +181,8 @@ private
         thumb.width = thumbnail_width
         thumb.height = thumbnail_height
         thumb.time = (time += interval)
-        thumb.image_path = File::join(@tempdir, "th#{"%03d" % i}.png")
+        thumb.image_path = File::join(@tempdir, "th#{"%03d" % i}.#{selected_capturer.format.to_s}")
+        thumb.filters.push(*@filters)
 
         @thumbnails << thumb
       end
@@ -219,11 +235,24 @@ private
     end
 
     def splice_montage montage_path
+      if softshadow
+        left = @configuration.padding + 3
+        top = @configuration.padding + 5
+        bottom = right = @configuration.padding
+      else
+        left = right = top = bottom = @configuration.padding
+      end 
+
+
       file_path = File::join(@tempdir, 'spliced.png')
       MiniMagick::Tool::Convert.new do |convert|
         convert << montage_path
         convert.background @configuration.contact_background
-        convert.splice '5x10'
+
+        convert.splice "#{left}x#{top}"
+        convert.gravity 'SouthEast'
+        convert.splice "#{right}x#{bottom}"
+
         convert << file_path
       end
       file_path
@@ -295,7 +324,7 @@ private
           end
           a.pointsize @configuration.header_font.size
           a.background @configuration.header_background
-          a.fill 'Black'
+          a.fill @configuration.header_color
           a.stack do |b|
             b.gravity 'West'
             b.stack do |c|

data/lib/defaults.yml

@@ -4,6 +4,10 @@ main:
   interval: ~
   padding: 2
   quality: 95
+filter:
+  timestamp: true
+  polaroid: false
+  softshadow: true
 style:
   header:
     font: DejaVuSans.ttf

data/lib/ffmpeg.rb

@@ -13,6 +13,12 @@ module VCSRuby
     DIMENSION = 5
     FPS = 7
 
+    HEADER = 10
+
+    ENCODING_SUPPORT = 2
+    VIDEO_CODEC = 3
+    NAME = 8
+
     def initialize video
       @video = video
       @ffmpeg = Command.new :ffmpeg, 'ffmpeg'
@@ -90,6 +96,30 @@ module VCSRuby
       @ffmpeg.execute "-y -ss #{time.total_seconds} -i \"#{@video}\" -an -dframes 1 -vframes 1 -vcodec png -f rawvideo \"#{image_path}\""
     end
 
+    def available_formats
+      # Ordered by priority
+      image_formats = ['png', 'tiff', 'bmp', 'mjpeg']
+      formats = []
+
+      list = @ffprobe.execute "-codecs"
+      list.lines.drop(HEADER).each do |codec|
+        name, e, v = format_split(codec)
+        formats << name if image_formats.include?(name) && e && v
+      end
+
+      image_formats.select{ |format| formats.include?(format) }.map(&:to_sym)
+    end
+
+    def format_split line
+      e = line[ENCODING_SUPPORT] == 'E'
+      v = line[VIDEO_CODEC] == 'V'
+
+      name = line[NAME..-1].split(' ', 2).first
+      return name, e, v
+    rescue
+      return nil, false, false
+    end
+
     def to_s
       "FFmpeg #{@version}"
     end

data/lib/font.rb

@@ -58,12 +58,12 @@ module VCSRuby
       fonts.lines.each do |line|
         key, value = line.strip.split(':', 2).map(&:strip)
         
-        next if ['Path'].include? key
+        next if [nil, 'Path'].include? key
 
         if key == 'Font'
           @@fonts[value] = font = IMFont.new(value) 
         else           
-          font.send(key + '=', value)
+          font.send("#{key}=", value)
         end
       end
     end

data/lib/libav.rb

@@ -13,6 +13,12 @@ module VCSRuby
     DIMENSION = 4
     FPS = 6
 
+    HEADER = 10
+
+    ENCODING_SUPPORT = 2
+    VIDEO_CODEC = 3
+    NAME = 8
+
     def initialize video
       @video = video
       @avconv = Command.new :libav, 'avconv'
@@ -29,6 +35,7 @@ module VCSRuby
       @avconv.available? && @avprobe.available?
     end
 
+
     def detect_version
       info = @avconv.execute('-version')
       match = /avconv ([\d|.|-|:]*)/.match(info)
@@ -79,7 +86,31 @@ module VCSRuby
     end
 
     def grab time, image_path
-      @avconv.execute "-y -ss #{time.total_seconds} -i \"#{@video}\" -an -dframes 1 -vframes 1 -vcodec png -f rawvideo \"#{image_path}\""
+      @avconv.execute "-y -ss #{time.total_seconds} -i \"#{@video}\" -an -dframes 1 -vframes 1 -vcodec #{format} -f rawvideo \"#{image_path}\""
+    end
+
+    def available_formats
+      # Ordered by priority
+      image_formats = ['png', 'tiff', 'bmp', 'mjpeg']
+      formats = []
+
+      list = @avprobe.execute "-codecs"
+      list.lines.drop(HEADER).each do |codec|
+        name, e, v = format_split(codec)
+        formats << name if image_formats.include?(name) && e && v
+      end
+
+      image_formats.select{ |format| formats.include?(format) }.map(&:to_sym)
+    end
+
+    def format_split line
+      e = line[ENCODING_SUPPORT] == 'E'
+      v = line[VIDEO_CODEC] == 'V'
+
+      name = line[NAME..-1].split(' ', 2).first
+      return name, e, v
+    rescue
+      return nil, false, false
     end
 
     def to_s

data/lib/mplayer.rb

@@ -4,12 +4,18 @@
 
 require 'command'
 require 'capturer'
+require 'fileutils'
 
 module VCSRuby
   class MPlayer < Capturer
+
+    HEADER = 2
+
     def initialize video
       @video = video
       @mplayer = Command.new :mplayer, 'mplayer'
+
+      detect_version if available?
     end
 
     def name
@@ -17,12 +23,102 @@ module VCSRuby
     end
 
     def available?
-      @mplayer.available? && false
+      @mplayer.available?
     end
     
+    def detect_version
+      info = @mplayer.execute('')
+      match = /MPlayer (.*),/.match(info)
+      @version = match[1] if match
+    end
+
+    def length
+      load_probe
+      @length
+    end
+
+    def width
+      load_probe
+      @width
+    end
+
+    def height
+      load_probe
+      @height
+    end
+
+    def video_codec
+      load_probe
+      @video_codec
+    end
+
+    def audio_codec
+      load_probe
+      @audio_codec
+    end
+
+    def fps
+      load_probe
+      @fps
+    end
+
+    def file_pattern n
+      if format == :jpeg
+        "#{"%08d" % n}.jpg"
+      else
+        "#{"%08d" % n}.#{format.to_s}"
+      end
+    end
+
+    def grab time, image_path
+      @mplayer.execute "-sws 9 -ao null -benchmark -vo #{@format} -quiet -frames 5 -ss #{time.total_seconds} \"#{@video}\""
+      (1..4).each { |n| FileUtils.rm(file_pattern(n)) }
+      FileUtils.mv(file_pattern(5), image_path)      
+    end
+
+    def available_formats
+      # Ordered by priority
+      image_formats = ['png', 'jpeg']
+      formats = []
+
+      list = @mplayer.execute("-vo help", 0, true)
+      list.lines.drop(HEADER).each do |codec|
+        name = format_split(codec)
+        formats << name if image_formats.include?(name)
+      end
+
+      image_formats.select{ |format| formats.include?(format) }.map(&:to_sym)
+    end
+
+    def format_split line
+      name = line.strip.split(' ', 2).first
+    end
+
     def to_s
       "MPlayer #{@version}"
     end
+  private
+    def parsed?
+      !!@parsed
+    end
 
+    def load_probe
+      unless parsed?
+        parse_identify(@mplayer.execute("-ao null -vo null -identify -frames 0 -quiet \"#{@video}\""))
+      end
+    end
+
+    def parse_identify info
+      info.lines.each do |line|
+        key, value = line.split('=', 2)
+        @length = TimeIndex.new value.to_f if key == 'ID_LENGTH'
+        @width = value.to_i if key == 'ID_VIDEO_WIDTH'
+        @height = value.to_i if key == 'ID_VIDEO_HEIGHT'
+        @video_codec = value.chomp if key == 'ID_VIDEO_FORMAT'
+        @audio_codec = value.chomp if key == 'ID_AUDIO_FORMAT'
+        @fps = value.to_f if key == 'ID_VIDEO_FPS'
+      end
+      @parsed = true
+    end
   end
 end

data/lib/oldstyle.yml

@@ -0,0 +1,12 @@
+style:
+  header:
+    color: Black
+    background: YellowGreen
+  title:
+    color: White
+    background: Black
+  contact:
+    background: White
+  signature:
+    color: Black
+    background: SandyBrown

data/lib/thumbnail.rb

@@ -9,12 +9,13 @@ module VCSRuby
     attr_accessor :width, :height, :aspect
     attr_accessor :image_path
     attr_accessor :time
+    attr_reader :filters
 
     def initialize capper, video, configuration
       @capper = capper
       @video = video
       @configuration = configuration
-      @filters = [ method(:resize_filter),  method(:timestamp_filter), method(:softshadow_filter) ]
+      @filters = []
     end
 
     def capture
@@ -47,14 +48,28 @@ module VCSRuby
         convert.background 'Transparent'
         convert.fill 'Transparent'
         convert << @image_path
-        @filters.each do |filter|
-          filter.call(convert)
+
+        sorted_filters.each do |filter|
+          call_filter filter, convert
         end
+
         convert << @image_path
       end
     end
 
 private
+    def call_filter filter, convert
+      if respond_to?(filter, true)
+        method(filter).call(convert)
+      else
+        raise "Filter '#{filter}' does not exist"
+      end
+    end
+
+    def sorted_filters
+      [:resize_filter, :timestamp_filter, :photoframe_filter, :polaroid_filter, :random_rotation_filter, :softshadow_filter].select{ |filter| @filters.include?(filter) }
+    end
+
     def resize_filter convert
       convert.resize "#{width}x#{height}!"
     end
@@ -74,13 +89,6 @@ private
       convert.gravity 'None'
     end
 
-    def photoframe_filter convert
-      convert.bordercolor 'White'
-      convert.border 3
-      convert.bordercolor 'Grey60'
-      convert.border 1
-    end
-
     def softshadow_filter convert
       convert.stack do |box|
         box.background 'Black'
@@ -94,6 +102,13 @@ private
       convert.repage.+
     end
 
+    def photoframe_filter convert
+      convert.bordercolor 'White'
+      convert.border 3
+      convert.bordercolor 'Grey60'
+      convert.border 1
+    end
+
     def polaroid_filter convert
       border = 8
       convert.stack do |a|
@@ -109,8 +124,8 @@ private
         a.flip
         a.bordercolor 'Grey60'
         a.border 1
-        a.repage.+
       end
+      convert.repage.+
     end
 
     def random_rotation_filter convert

data/lib/tools.rb

@@ -40,7 +40,9 @@ module VCSRuby
     end
 
     def self.contact_sheet_with_options video, options
-      sheet = VCSRuby::ContactSheet.new video, options[:capturer]
+      sheet = VCSRuby::ContactSheet.new video, options[:profile]
+
+      sheet.capturer = options[:capturer]
       sheet.format = options[:format] if options[:format]
       sheet.title = options[:title] if options[:title]
       sheet.signature = options[:signature] if options[:signature]
@@ -56,6 +58,10 @@ module VCSRuby
       sheet.to = options[:to] if options[:to]
       sheet.highlight = options[:highlight] if options[:highlight]
 
+      sheet.timestamps = options[:timestamps] if options[:timestamps] != nil
+      sheet.softshadow = options[:softshadow] if options[:softshadow] != nil
+      sheet.polaroid = options[:polaroid] if options[:polaroid] != nil
+
       return sheet
     end
 

data/lib/version.info

@@ -1 +1 @@
-0.8.6
+1.0.1

data/lib/white.yml

@@ -0,0 +1,12 @@
+style:
+  header:
+    color: Black
+    background: White
+  title:
+    color: Black
+    background: White
+  contact:
+    background: White
+  signature:
+    color: Black
+    background: White

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcs_ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -77,11 +77,14 @@ files:
 - lib/ffmpeg.rb
 - lib/version.rb
 - lib/libav.rb
+- lib/white.yml
 - lib/capturer.rb
 - lib/version.info
 - lib/vcs.rb
 - lib/command.rb
+- lib/black.yml
 - lib/configuration.rb
+- lib/oldstyle.yml
 - lib/defaults.yml
 - bin/vcs.rb
 homepage: https://github.com/FreeApophis/vcs.rb