storyboard 0.3.1 → 0.4.0

data/CHANGELOG

@@ -0,0 +1,16 @@
+0.4.0
+
+  Added two new options to Storyboard:
+  --preview [NUMBER] will output only the first NUMBER of frames that have subtitles.
+    if --preview is used with -c (forcing a scene change scan), it may include more than
+    NUMBER of frames, as the scene changes will also be included.
+
+  -n [NUMBER] nudges the timestamps forward or back in time by NUMBER seconds.
+    Combined with --preview this lets you more quickly line up the subtitles. Error detection
+    on nudging is nonexistant, and so if you nudge them too far forward or back they could
+    cause an error.
+
+    The following example will move the subtitles back 2 seconds, and render a 25 frame PDF:
+
+    storyboard -n -2 --preview 25 Video.mkv
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    storyboard (0.3.0)
+    storyboard (0.4.0)
       levenshtein-ffi
       mime-types (>= 1.19)
       mini_magick

data/README.md

@@ -18,17 +18,17 @@ Storyboard will try to generate a file at `/path/to/video-file.pdf` containing t
     $ ls .
     ShowName.1x01.EpisodeName.pdf    ShowName.1x02.AnotherEpisode.pdf    ShowName.1x03.ThirdEp.pdf
 
-You can see available commands by running the program without any options
+To quickly test if the subtitles that are used look ok, you can use the `--preview NUMBER` option, which generates a PDF with as many pages as you specify, defaulting to 10.
 
-    Usage: storyboard [options] videofile [output_directory]
-      -v, --[no-]verbose               Run verbosely
-          --[no-]scenes                Detect scene changes. This increases the time it takes to generate a file.
-      -ct FLOAT                        Scene detection threshold. 0.2 is too low, 0.8 is too high. Play with it!
-      -s, --subs FILE                  SRT subtitle file to use. Will skip extracting/downloading one.
-          --make x,y,z                 Filetypes to output
-                                       (pdf, mobi, epub)
-      -h, --help                       Show this message
+    storyboard --preview /path/to/video-file.mkv
 
+If the subtitles are off, you can nudge them back or forward with the `-n TIME` option. This can be positive or negative, and if you make it too large it can cause Storyboard to throw an error. This would nudge the subtitles back 2 seconds, and generate just the preview PDF.
+
+   storyboard -n -2 --preview /path/to/video-file.mkv
+
+You can see all the available options by using the help option:
+
+    storyboard -h
 
 ## Requirements
 

data/bin/storyboard

@@ -22,12 +22,14 @@ unless Storyboard.magick_installed?
   exit
 end
 
-options = {:scenes => true, :verbose => true, :types => ['pdf'], :scene_threshold => 0.4}
+options = {:nudge => 0, :verbose => true, :types => ['pdf'], :scene_threshold => 0.4}
 
 # think about them
 options[:consolidate_frame_threshold] = 0.4
 options[:max_width] = 600
 
+puts "Running Storyboard #{Storyboard::VERSION}"
+
 LOG = Logger.new(STDOUT)
 LOG.level = Logger::INFO
 
@@ -43,16 +45,27 @@ opts.on("-c", "--[no-]scenes", "Detect scene changes. This increases the time it
   options[:scenes] = v
 end
 
-opts.on("-ct", Float, "Scene detection threshold. 0.2 is too low, 0.8 is too high. Play with it!") do |f|
-  options[:scene_threshold] = f
+opts.on("--preview [FRAMES]", Integer, "Only render the specified number (default 10) of subtitled images.", "Unless the -c flag is used, scene detection will be skipped") do |n|
+  options[:preview] = n || 10
+  options[:scenes] ||= false
+end
+
+opts.on("-n", "--nudge TIME", Float, "Nudge the subtitles forward or backward. TIME is the number of seconds.", "Use this with the --preview option to quickly check and adjust the subtitle timings.") do |time|
+  options[:nudge] = time
 end
 
+#opts.on("--make x,y,z", Array, "Filetypes to output", '(pdf, mobi, epub)') do |types|
+#  options[:types] = types
+#end
+
 opts.on("-s", "--subs FILE", "SRT subtitle file to use. Will skip extracting/downloading one.") do |s|
   options[:subs] = s
 end
 
-opts.on("--make x,y,z", Array, "Filetypes to output", '(pdf, mobi, epub)') do |types|
-  options[:types] = types
+opts.on('--update', "Update Storyboard to the latest available version") do |u|
+  # This execs in the current environment, I believe.
+  puts `gem update storyboard`
+  exit
 end
 
 opts.on_tail("-h", "--help", "Show this message") do
@@ -67,6 +80,10 @@ rescue OptionParser::InvalidOption, OptionParser::InvalidArgument => e
   exit 1
 end
 
+options[:scenes] = true if options[:scenes].nil?
+
+p options
+
 if ARGV.size < 1
   puts "videofile required"
   puts opts.to_s

data/lib/storyboard/subtitles.rb

@@ -35,12 +35,7 @@ class Storyboard
       #downloader = Suby::Downloader::OpenSubtitles.new(suby_file, 'en')
       # try Addic7ed first, as, on average, it seems a bit better.
       downloader = nil
-      begin
-        LOG.debug("Searching for subtitles on Addic7ed")
-        #downloader = Suby::Downloader::Addic7ed.new(suby_file, 'en')
-      rescue Exception => e
-        LOG.debug(e)
-      end
+
 
       if downloader.nil?
         LOG.info("Searching for subtitles on OpenSubtitles")
@@ -89,8 +84,8 @@ class Storyboard
           end
         when :time
           if l =~ /^(#{TIME_REGEX}) --> (#{TIME_REGEX})$/
-            page[:start_time] = STRTime.parse($1)
-            page[:end_time] = STRTime.parse($2)
+            page[:start_time] = STRTime.parse($1) + @options[:nudge]
+            page[:end_time] = STRTime.parse($2) + @options[:nudge]
             phase = :text
           else
             raise "Bad SRT File: Should have time range but got '#{l}'"

data/lib/storyboard/version.rb

@@ -1,3 +1,3 @@
 class Storyboard
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/storyboard.rb

@@ -34,12 +34,22 @@ class Storyboard
     # bit of a temp hack so I don't have to wait all the time.
     @subtitles.save if options[:verbose]
 
-
     @renderers << Storyboard::PDFRenderer.new(self) if options[:types].include?('pdf')
 
     run_scene_detection if options[:scenes]
     consolidate_frames
+
+
+    # If the preview flag is set, do a quick count of how many subtitled frames fall before it.
+    if @options[:preview]
+      stop_time = @subtitles.pages[@options[:preview]].start_time.value
+      @stop_frame = @capture_points.count {|f| stop_time > f.value }
+    else
+      @stop_frame = @capture_points.count
+    end
+
     extract_frames
+
     render_output
 
     cleanup
@@ -58,7 +68,7 @@ class Storyboard
         end while !stdout.eof?
     }
     pbar.finish
-    LOG.info("#{@capture_points.count} scenes registered")
+    LOG.info("#{@capture_points.count} scenes found and added to the timeline")
   end
 
   def consolidate_frames
@@ -80,9 +90,14 @@ class Storyboard
 
   def extract_frames
     pool = Thread::Pool.new(2)
-    pbar = ProgressBar.create(:title => " Extracting Frames", :format => '%t [%c/%C|%B] %e', :total => @capture_points.count)
+    pbar = ProgressBar.create(:title => " Extracting Frames", :format => '%t [%c/%C|%B] %e', :total => @stop_frame )
 
     @capture_points.each_with_index {|f,i|
+      if i >= @stop_frame
+        pool.shutdown
+        return
+      end
+
       # It's *massively* quicker to jump to a bit before where we want to be, and then make the incrimental jump to
       # exactly where we want to be.
       seek_primer = (f.value < 1.000)  ? 0 : -1.000
@@ -103,8 +118,9 @@ class Storyboard
   end
 
   def render_output
-    pbar = ProgressBar.create(:title => " Rendering Output", :format => '%t [%c/%C|%B] %e', :total => @capture_points.count)
+    pbar = ProgressBar.create(:title => " Rendering Output", :format => '%t [%c/%C|%B] %e', :total => ( @options[:preview] || @capture_points.count ))
     @capture_points.each_with_index {|f,i|
+      next if i >= @stop_frame
       image_name = File.join(@options[:save_directory], "%04d.jpg" % [i])
       capture_point_subtitles = @subtitles.pages.select { |page| f.value >=  page.start_time.value and f.value <= page.end_time.value }.first
       begin
@@ -138,6 +154,7 @@ class Storyboard
   def setup
     @options[:basename] = File.basename(options[:file], ".*")
     @options[:work_dir] = Dir.mktmpdir
+    raise "Unable to create temporary directory" unless File.directory?(@options[:work_dir])
     Dir.mkdir(@options[:write_to]) unless File.directory?(@options[:write_to])
     @options[:save_directory] = File.join(@options[:work_dir], 'raw_frames')
     Dir.mkdir(@options[:save_directory]) unless File.directory?(@options[:save_directory])

data/setup/osx.sh

@@ -78,7 +78,7 @@ if [ -x /usr/local/bin/convert ]; then
   printf '%s ok %s\n' "$(tput setaf 2)" "$(tput op)"
 else
   printf '%s have to install %s\n' "$(tput setaf 1)" "$(tput op)"
-  brew install imagemagick
+  brew install imagemagick libtool
 fi
 
 echo -n "Checking for Ghostscript"

metadata

@@ -1,145 +1,171 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: storyboard
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 1
-  version: 0.3.1
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Mark Olson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-22 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mini_magick
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: prawn
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: ruby-progressbar
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: levenshtein-ffi
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: levenshtein-ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: path
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        - 0
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: path
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rubyzip
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: term-ansicolor
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: mime-types
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 19
-        version: "1.19"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.19'
   type: :runtime
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.19'
 description: Generate PDFs and eBooks from video files
-email: 
-- "\"theothermarkolson@gmail.com\""
-executables: 
+email:
+- ! '"theothermarkolson@gmail.com"'
+executables:
 - storyboard
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - INSTALL.md
@@ -179,38 +205,29 @@ files:
 - vendor/suby/spec/suby/filename_parser_spec.rb
 - vendor/suby/spec/suby_spec.rb
 - vendor/suby/suby.gemspec
-has_rdoc: true
 homepage: http://github.com/markolson/storyboard
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
 - vendor/suby
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 9
-      - 3
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.3
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Video to PDF/ePub generator
 test_files: []
-