sensible-cinema 0.20.5 → 0.21.3

data/experimental_readme.txt

@@ -1,5 +1,8 @@
-Currently it takes as input a list of "skippable" scenes, and a player description.
-It then tracks whichever player you are using, and mutes or blanks out the system appropriately, 
+Currently the experimental screen tracker (bin\sensible-cinema-cli) prompts for a delete list
+and a player description.
+
+It then tracks whichever player you are using, by using OCR on its timestamps (
+moves the mouse every so often to and mutes or blanks out the system appropriately, 
 during the scenes specified.
 
 It works out of the box with the hulu and VLC players on windows.  It isn't hard to 
@@ -7,26 +10,19 @@ add new players, and probably wouldn't be too hard to add more operating systems
 
 == How to Use ==
 
-Start playing your movie in its respective player, then startup sensible-cinema by running the file
-run_sensible_cinema.bat
+Start playing your movie in its player, then start sensible-cinema-cli
 
 It prompts you for an EDL (Edit decision List) file (ex: bambi.txt), 
-and also for a player file (ex: hulu_full_screen.txt).
+and also for a player description file (ex: hulu_full_screen.txt).
 
-Sensible-cinema will now run in a console window, screen tracking the player to monitor its position,
-and react'ing appropriately.
+Sensible-cinema will now run in its console window, screen tracking the player to monitor its position,
+and react appropriately (mute system volume, or overlay screen with a black window to cover content playback).
 
-It is presumed that you'll then minimize sensible-cinema and proceed to enjoy the movie.
+It is presumed that you'll then minimize sensible-cinema and enjoy the movie.
 
 You'll know that it's working if, when you change the time of your player (ex: dragging it to a new spot 
-in the playback), the screen output in sensible-cinema's console should change to match the new time.
-
-== How to install ==
-
-You'll need to install imagemagick first: http://www.imagemagick.org/script/binary-releases.php
+in the playback), the screen output listed in sensible-cinema's console should also change to match the new time.
 
-Next go and get the program: http://rogerdpack.t28.net
-  
 You can test that it's installed by running it (see above) and selecting the "example_edit_decision_list.txt", and 
 choosing the hulu player.
 
@@ -34,50 +30,16 @@ It will show you a few "demo" mutes and blank outs.
 
 == FAQ ==
 
-Q. Can I watch movies this way on my TV, not just on my computer?
-
-A. Maybe.  Or possible not yet, depending on your current hardware.
-   Currently you'll either need to attach your computer to your TV
-   (buy some long cables, or a new graphics card that matches your cables, etc.) 
-   or get some computer that you can move closer to the TV to do the same 
-   (ex: buy a used older laptop with s-video out, use that, or a laptop with DVI/HDMI would
-   work with an HDMI TV).  If you're really aggressive you could run an ethernet cable from your computer, as well [1].
-   I'd be happy to do a linux port of sensible-cinema if anybody requests it, for use with 
-   their dedicated TV computer.
-   There has also been some work toward getting ones computer to stream "live" to your existing wii/ps3/xbox.
-   Message me if you're interested in trying it out (testers wanted--plus I'll only work on it if there's demand)!   
-
-Q. What movies does this work with?
-
-A. Any that you program it for :) (Assuming the computer player is compatible, which most probably are.)
-
 Q. What movies are freely available to watch online?
 
-A. Not many are available free (hulu, youtube have a few). Netflix has quite a few with its default subscription.  
-   You can of course use it with any existing DVD, or rent or borrow DVD's and watch them using sensible-cinema.
+A. Not many are available free (hulu, youtube have a few). Netflix has quite a few now for money.  
+   You can of course use SC with DVD's, too, or rent or borrow DVD's.
+   (If they have a delete list (or you could create your own for them if not...).)
 
 Q. Why does my mouse bounce up and down while sensible-cinema is going?
 
 A. This enables your player to keep its on-screen time tracker, which in turn allows sensible-cinema to track where 
-   you're at.  Message me if this bugs you too much and we'll see what we can do about it.
-
-[1] http://ps3mediaserver.org/forum/viewtopic.php?f=6&t=5731#p34279
-
-== Advanced Usage ==
-
-You could specify the scene descriptions list and player list on the command-line, if you don't want to have
-to pick them each time, like:
-
-first install jruby, then
-
-C:\> jruby -S gem install sensible-cinema (double check if that gives you the latest version)
-
-C:\> jruby -S sensible-cinema edit_decision_list.yml player_description.yml
-
-Also if you specify "test" for the scene descriptions file, it will pause 4s, take a snapshot of the player, then exit.
-You can also specify -v or -t if you want to enable more verbose (chatty) output.
-
-== Thanks ==
-
-Thanks to Jarmo for the win32-screenshot gem, mini_magick gem authors, jruby guys, etc.  
-The combination made programming this actually something of a pleasure.
+   you're at time position.  Message me if this bugs you too much and we'll see what we can do to alleviate it.
+  
+To create a new player, basically you have to create a new descriptor, then add unit tests for all of its digits, to make sure they OCR well :(
+A bit convoluted, I agree.  Ping me if you want one added.

data/go.bat

@@ -1,2 +1,5 @@
-call j bin\sensible-cinema.rb
-taskkill /f /im mencoder.exe
+taskkill /f /im mencoder.exe
+taskkill /f /im ffmpeg.exe
+call j %* bin\sensible-cinema.rb
+taskkill /f /im mencoder.exe
+taskkill /f /im ffmpeg.exe

data/how_to_create.txt

@@ -1,41 +1,37 @@
-You create a delete list for sensible cinema to use against whatever you want.
+You can create a delete list for sensible cinema to use against whatever DVD you want.
 
-An delete list looks something like this example:
+A delete list looks something like this example:
 
 https://github.com/rdp/sensible-cinema/blob/master/zamples/edit_decision_lists/example_edit_decision_list.txt
 
-Basically your job is to create an appropriate file (like that one), 
-then start sensible-cinema and instruct it to use your new file.
-
 For a DVD, the steps might look like this:
 
-open Sensible cinema "create mode"
-insert DVD, click "create new" button
-
-click "open ripped version of DVD unedited", right click, create new file, name it something.txt, right click, "open", and then select it.
-
-it will rip that fella to the hard drive (for the save to filename, use the default).  
-It will take quite awhile, but will get everything set up for quick editing after that point.
-
-In the meantime, make your file look like this:
-
-https://github.com/rdp/sensible-cinema/blob/master/zamples/edit_decision_lists/example_edit_decision_list.txt
-
-After it finishes ripping it, it will start you watching it in mplayer, from which you can "derive" the parts you wish to delete.
-
-Add timestamps to your file as necessary, then (exit smplayer and) click "Preview edited section of current DVD" (use the default filename),
-give it a range "around" the edit you just added, then it will preview that segment.  If it didn't work, edit the file,
-close smplayer, and hit "re-run most recent preview"
-
-Also after you're done, you can delete any left over files that are still there.
-
-Also after you're done, you can submit it back to the project by submitting it, see end of README.
-
-A few pointers:
- I typically like to make two delete lists per DVD.  One that takes out swearing, sex, and gruesome violence, and another
-   "more paranoid" version that takes out basically anything that could be offensive to anybody :) ("dang", "fetch", "too tense" of scenes...)
- You can just watch the DVD (using any DVD player), and get timestamps that way, before starting this.
- A good one is "smplayer" (the [ and ] keys control playback speed, right and left, page up and page down control seeking), 
- and you can turn on subtitles to help locae profanity (as also in VLC).
- You can watch the DVD using VLC Player, which has a "fast forward" button, just recognize that VLC's timestamps are always slightly off,
-  so they'll only be approximate, but it might be close.
+open Sensible cinema with "edit/create mode...bat"
+insert your DVD, click "Create new delete list for DVD" button
+
+Now you want to add timestamps and then test them to make sure they're accurate, using the various buttons.
+
+Note that you can also add timestamps then click "Watch DVD on computer realtime" to avoid having 
+to rip it to your hard drive.  This is slightly less accurate, though faster.  See pointers.
+
+If you want to edit it the accurate way, then you can use the "Watch DVD unedited" button
+to save time, as it allows you to watch it while it "grabs" it to the hard drive (note: you'll
+probably need at least a dual core processor for this button to work well).
+
+After you're done, you can submit your newly created delete list back to the project 
+(so others can use it) by using the Upload button.
+
+A few pointers:
+
+ You can make several different "delete lists" per DVD, just use different filenames.
+    For example one could take out all profanity, and the other take out profanity and also remove tense scenes.
+ You can just watch a DVD (using any DVD player), and get timestamps that way, before creating a delete list at all.
+ A good computer program for this is "smplayer" (the [ and ] keys control playback speed, and right and left, 
+   page up and page down buttons control seeking), and you can also turn on subtitles to help locate profanity.  
+   You can also do the same thing using VLC player, except that VLC's timestamps are always a bit off.
+ Also note that you should probably rewatch the whole thing when you're done, to double check and see 
+  if you got the time signatures right (using "create DVD file on local hard drive" button).
+ Also note that you can add your timing information to IMDB's parental guide pages about movies.  
+  This can help users of other than sensible cinema with editing their movies.
+ Also note that you don't need to "grab" the DVD to your hard drive to edit.  You can just setup the 
+  EDL to work right [ http://goo.gl/yMfqX ] then use math to setup the correct time signatures.

data/lib/edl_parser.rb

@@ -61,28 +61,40 @@ class EdlParser
     out
   end
   
-  TimeStamp = /^\d+:\d\d[\d:\.]*$/
+  TimeStamp = /(^\d+:\d\d[\d:\.]*$|\d+)/
   # starts with a digit, has at least one colon followed by two digits,then some combo of digits and colons and periods...
+  # or just like 5057 s
   
   def self.extract_entry! from_this
     return nil if from_this.length == 0
     # two digits, then whatever else you see, that's not a digit...
     out = from_this.shift(2)
     out.each{|d|
-      raise SyntaxError.new('non timestamp? ' + d) unless d =~ TimeStamp
+      unless d =~ TimeStamp
+        raise SyntaxError.new('non timestamp? ' + d) 
+      end
     }
     while(from_this[0] && from_this[0] !~ TimeStamp)
-     out << from_this.shift
+      out << from_this.shift
     end
     out
   end
   
   def self.get_secs timestamp_string_begin, timestamp_string_end, add_begin, add_end, splits
     answers = []
+    unless timestamp_string_begin
+    p 'BAD'
+      raise 'non begin' 
+    end
+    unless timestamp_string_end
+    p 'BAD2', '', ''
+      raise 'non end' 
+    end
     for type, offset, multiplier in [[timestamp_string_begin, add_begin, -1], [timestamp_string_end, add_end, 1]]
       original_secs = translate_string_to_seconds(type) + offset
       # now if splits is 900 and we'are at 909, then we're just 9
       closest_split_idx = splits.reverse.index{|t| t < original_secs}
+      p 'got idx', closest_split_idx
       if closest_split_idx
         closest_split = splits.reverse[closest_split_idx]
         # add some extra seconds onto these if they're "past" a split, too
@@ -103,9 +115,9 @@ class EdlParser
     end
     mutes = incoming["mutes"] || {}
     blanks = incoming["blank_outs"] || {}
+    p 'incoming', incoming, splits
     mutes = mutes.map{|k, v| get_secs(k, v, -add_this_to_mutes_beginning, add_this_to_mutes_end, splits) + [:mute]}
     blanks = blanks.map{|k, v| get_secs(k, v, -add_this_to_mutes_beginning, add_this_to_mutes_end, splits) + [:blank]}
-    p mutes, blanks
     combined = (mutes+blanks).sort
     
     previous = nil
@@ -140,7 +152,13 @@ class EdlParser
     
     # s is like 1:01:02.0
     total = 0.0
-    seconds = s.split(":")[-1]
+    seconds = nil
+    begin
+      seconds = s.split(":")[-1]
+    rescue Exception => e
+     p 'failed!', s
+     raise e
+    end
     total += seconds.to_f
     minutes = s.split(":")[-2] || "0"
     total += 60 * minutes.to_i
@@ -174,7 +192,7 @@ class EdlParser
   
 end
 
-# <= 1.8.7 Symbol compat
+# == 1.8.7 Symbol compat
 
 class Symbol
   # Standard in ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Symbol.html]
@@ -182,4 +200,8 @@ class Symbol
     return nil unless with.is_a? Symbol
     to_s <=> with.to_s
   end unless method_defined? :"<=>"
+end
+
+if RUBY_VERSION < '1.8.7'
+  raise 'needs ruby 1.8.7 at least'
 end

data/lib/mencoder_wrapper.rb

@@ -29,8 +29,8 @@ class MencoderWrapper
         out = '@rem '
       end
       audio_codec = these_settings['audio_codec'] || 'lavc' # not copy...sniff...or you can't hear cars...
-      video_opts = "-ovc lavc -lavcopts vcodec=mpeg2video:vrc_buf_size=1835:vrc_maxrate=9800:vbitrate=5000:keyint=1:vstrict=0:acodec=ac3:abitrate=192:autoaspect -ofps 30000/1001"
-      out + "call mencoder dvdnav://#{@dvd_title_track} -of mpeg -mpegopts format=dvd:tsaf -alang en -nocache -sid 1000 -oac #{audio_codec} #{video_opts} -o #{@big_temp} -dvd-device #{this_drive} && echo done_grabbing > #{@big_temp}.done\n"# -vf harddup
+      video_opts = "-vf scale=720:480,harddup -ovc lavc -lavcopts vcodec=mpeg2video:vrc_buf_size=1835:vrc_maxrate=9800:vbitrate=5000:keyint=1:vstrict=0:acodec=ac3:abitrate=192:autoaspect -ofps 30000/1001"
+      out + "mencoder dvdnav://#{@dvd_title_track} -of mpeg -mpegopts format=dvd:tsaf -alang en -nocache -sid 1000 -oac #{audio_codec} #{video_opts} -o #{@big_temp} -dvd-device #{this_drive} && echo done_grabbing > #{@big_temp}.done\n"
     end
     
     def calculate_final_filename to_here_final_file
@@ -77,9 +77,9 @@ class MencoderWrapper
       out += "call mencoder #{partials.join(' ')} -o #{to_here_final_file} -ovc copy -oac copy\n"
       # LODO only do this if they want to watch it on their computer, with something other than smplayer, or want to make it smaller, as it takes *forever* longer to run...
       # or is ffdshow enough without this?
-      out += "@rem call mencoder -oac lavc -ovc lavc -of mpeg -mpegopts format=dvd:tsaf -vf scale=720:480,harddup -srate 48000 -af lavcresample=48000 -lavcopts vcodec=mpeg2video:vrc_buf_size=1835:vrc_maxrate=9800:vbitrate=5000:keyint=18:vstrict=0:acodec=ac3:abitrate=192:aspect=16/9 -ofps 30000/1001  #{partials.join(' ')} -o #{to_here_final_file}\n"
+      out += "@rem old way... call mencoder -oac lavc -ovc lavc -of mpeg -mpegopts format=dvd:tsaf -vf scale=720:480,harddup -srate 48000 -af lavcresample=48000 -lavcopts vcodec=mpeg2video:vrc_buf_size=1835:vrc_maxrate=9800:vbitrate=5000:keyint=18:vstrict=0:acodec=ac3:abitrate=192:aspect=16/9 -ofps 30000/1001  #{partials.join(' ')} -o #{to_here_final_file}\n"
       
-      delete_prefix = delete_partials ? "" : "@rem "
+      delete_prefix = ""#delete_partials ? "" : "@rem "
 
       out += "@rem del #{@big_temp}\n" # LODO no @rem
       out += "#{delete_prefix} del " + partials.join(' ') + "\n"
@@ -98,7 +98,7 @@ class MencoderWrapper
       if File.exist? partial_filename
         FileUtils.rm partial_filename
       end
-      "call ffmpeg -i #{@big_temp} #{codecs} -ss #{start} -t #{endy} #{partial_filename}\n"
+      "ffmpeg -i #{@big_temp} #{codecs} -ss #{start} -t #{endy} #{partial_filename}\n"
     end
   
   end

data/lib/ocr.rb

@@ -17,12 +17,12 @@ This file is part of Sensible Cinema.
 =end
 require 'sane' # gem
 require 'whichr' # gem
-require_relative 'swing_helpers' # to_filename lodo not have it there
-im_path = File.expand_path(File.dirname(__FILE__) + "/../vendor/cache/imagemagick") # convert.exe wants to only be chosen from here...
-ENV['PATH'] = im_path.to_filename + ';' + ENV['PATH']
+
+# not a dependency yet, so I don't have to bundle it...
+# im_path = File.expand_path(File.dirname(__FILE__) + "/../vendor/cache/imagemagick") # convert.exe wants to only be chosen from here...
+# ENV['PATH'] = im_path.gsub('/', "\\") + ';' + ENV['PATH']
 
 if RubyWhich.new.which('identify').length == 0 || RubyWhich.new.which('convert').length == 0
- # for gem users, so I don't have to bundle it :P
  puts 'appears you do not have imagemagick installed (or not in your path) -- please install it first! http://www.imagemagick.org/script/binary-releases.php'
  sleep 100
 end

data/lib/overlayer.rb

@@ -15,12 +15,15 @@ This file is part of Sensible Cinema.
     You should have received a copy of the GNU General Public License
     along with Sensible Cinema.  If not, see <http://www.gnu.org/licenses/>.
 =end
+
 require 'sane'
 require 'thread'
 require 'timeout'
 require 'yaml'
 require_relative 'muter'
 require_relative 'blanker'
+require_relative 'edl_parser'
+
 require 'pp' # for pretty_inspect
 
 class OverLayer
@@ -69,7 +72,7 @@ class OverLayer
   attr_accessor :all_sequences
   
   def reload_yaml!
-    @all_sequences = OverLayer.translate_yaml(File.read(@filename))
+    @all_sequences = OverLayer.translate_file(@filename)
     puts '(re) loaded mute sequences from ' + File.basename(@filename) + ' as', pretty_sequences.pretty_inspect, "" unless defined?($AM_IN_UNIT_TEST)
     signal_change
   end  
@@ -79,7 +82,7 @@ class OverLayer
     @all_sequences.each{|type, values|
       if values.is_a? Array
         new_sequences[type] = values.map{|s, f|
-          [translate_time_to_human_readable(s), translate_time_to_human_readable(f)]
+          [EdlParser.translate_time_to_human_readable(s), EdlParser.translate_time_to_human_readable(f)]
         }
       else
         new_sequences[type] = values
@@ -106,17 +109,18 @@ class OverLayer
   end
   
   # note this is actually deprecated and won't work anymore <sigh> and needs to be updated.
-  def self.translate_yaml raw_yaml
+  def self.translate_file filename
     begin
-      all = YAML.load(raw_yaml) || {}      
-    rescue NoMethodError, ArgumentError
-      p 'appears your file has a syntax error in it--perhaps missing quotation marks?'
-      return
+      all = EdlParser.parse_file(filename)
+    rescue NoMethodError, ArgumentError => e
+      p 'appears your file has a syntax error in it--perhaps missing quotation marks?', e.to_s
+      raise e # hope this is ok...
     end
+    
     # now it's like {:mutes => {"1:02.0" => "1:3.0"}}
     # translate to floats like 62.0 => 63.0
 
-    for type in [:mutes, :blank_outs]
+    for type in [:mutes, :blank_outs] # LODO standardize these :mutes and :blank_outs somewhere...scary to have them repeated *everywhere*
       maps = all[type] || all[type.to_s] || {}
       new = {}
       maps.each{|start,endy|
@@ -162,7 +166,7 @@ class OverLayer
   end
   
   def cur_english_time
-    translate_time_to_human_readable(cur_time)
+    EdlParser.translate_time_to_human_readable(cur_time)
   end
   
   def status
@@ -172,7 +176,7 @@ class OverLayer
       if next_sig == :done
         state = " no more after this point..."
       else
-        state = " next will be at #{translate_time_to_human_readable next_sig}s "
+        state = " next will be at #{EdlParser.translate_time_to_human_readable next_sig}s "
       end
       if blank? or muted?
         state += "(" + [muted? ? "muted" : nil, blank? ? "blanked" : nil ].compact.join(' ') + ") "

data/lib/screen_tracker.rb

@@ -52,13 +52,17 @@ class ScreenTracker
     @x = x; @y = y; @x2 = x+width; @y2 = y+height; @callback = callback    
     @max_x = max_x
     raise "poor width or wrong window #{@x2} #{max_x} #{x}" if @x2 > max_x  || @x2 == x
-    if @y2 > max_y || @y2 == y
-      raise 'poor height or wrong window' 
+    if @y2 > max_y || @y2 == y || @y2 <= 0
+      raise "poor height or wrong window selected #{@y2} > #{max_y} || #{@y2} == #{y} || #{@y2} <= 0" 
+    end
+    if max_x == 0 || max_y == 0
+      # I don't think we can ever get here, because of the checks above
+      raise 'window invisible?'
     end
     @digits = digits
     @previously_displayed_warning = false
     @dump_digit_count = 1
-    pps 'using x',@x, 'from x', x, 'y', @y, 'from y', y,'x2',@x2,'y2',@y2,'digits', @digits if $VERBOSE
+    pps 'using x',@x, 'from x', x, 'y', @y, 'from y', y,'x2',@x2,'y2',@y2,'digits', @digits.inspect if $VERBOSE
   end
   
   def get_hwnd
@@ -124,7 +128,13 @@ class ScreenTracker
         if(x < 0)
           x = @max_x + x
         end
-        out[type] = Win32::Screenshot::BitmapMaker.capture_area(@hwnd, x, @y, x+w, @y2) {|h,w,bmp| bmp}
+        x2 = x + w
+        raise 'a digit width can never be negative #{w}' if w <= 0
+        y2 = @y2
+        width = x2 - x
+        height = y2 - @y
+        # lodo calculate these only once...
+        out[type] = Win32::Screenshot::BitmapMaker.capture_area(@hwnd, x, @y, x2, y2) {|h,w,bmp| bmp}
       end
     end
     out
@@ -165,7 +175,7 @@ class ScreenTracker
         sleep 0.02
         if(Time.now - time_since_last_screen_change > 2.0)
           # display a warning
-          p 'warning--unable to track screen time for some reason [perhaps screen obscured or it\'s not playing yet?]'
+          p 'warning--unable to track screen time for some reason [perhaps screen obscured or it\'s not playing yet, or paused?]'
           @previously_displayed_warning = true
           time_since_last_screen_change = Time.now
           # also reget window hwnd, just in case that's the problem...(can be with VLC moving from title to title)

data/lib/swing_helpers.rb

@@ -42,7 +42,7 @@ module SensibleSwing
        rescue Exception => e
          puts 'got fatal exception in button', e, e.class
          puts e.backtrace.join("\n"), e
-         System.exit(1) # LODO no exit [?]
+         System.exit(1) # LODO no exit [?] once jruby cleans up their act...
        end        
      end
      self