sensible-cinema 0.7.2 → 0.7.3

data/README

@@ -1,13 +1,14 @@
-Sensible-cinema is a program that aims to allow you to do arbitrary scene selection (i.e. "mute out" or "bleep out" bad scenes).
+Sensible-cinema is a program that allows you to do edit-decision-list scene selection (i.e. "mute out" 
+or "bleep out" bad scenes) on arbitrary players like netflix online, vlc.
 
 Currently it takes as input a list of known "skip-worthy" scenes (profanity, violence, annoying songs, whatever you don't like). 
-It then tracks the player you are using, as it is playing, and mutes or blanks out the system screen appropriately, during the scenes
-specified.
+It then tracks the player you are using, as it is playing, and mutes or blanks out the system screen appropriately, 
+during the scenes specified.
 
-Currently it is known to work for for hulu and VLC playback on windows.  It also isn't hard to add new players, 
-and probably wouldn't be super hard to add more operating systems.
+Currently it is programmed out of the box to work with hulu and VLC player on windows.  It isn't hard to 
+add new players,and probably wouldn't be super hard to add more operating systems.
 
-The concept isn't new: http://en.wikipedia.org/wiki/Edit_decision_list
+The concept isn't all that novel: http://en.wikipedia.org/wiki/Edit_decision_list
 
 == How to use ==
 
@@ -25,8 +26,8 @@ You could also specify those two filenames on the command-line, if desired, like
 Sensible-cinema will now run in your console window, screen tracking the player's timer to monitor the playback position
 and react appropriately.
 
-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.
+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.
 
 It is presumed that you'll then minimize the console window and enjoy the movie.
 
@@ -48,59 +49,68 @@ choosing the hulu player.
 
 It will proceed do a few "demo" mutes and blank outs.
 
-== How to Program ==
+== Programming Your Own Scene List ==
 
-To program sensible-cinema to play what you'd like, first "preview" the on-computer movie you'd like to create a scene-list for.  
-As questionable scenes occur, jot down their start and end times somewhere.
-Then create an Edit Decision List (EDL) file that looks like this:
+To program sensible-cinema, your job is to create an edit decision list it can use.
+
+An Edit Decision List (EDL) looks something like this trivial example:
 
 mutes:
-  "00:01:01.5" : "00:01:02.5" # mute from one minute, one second and a half to one minute, two seconds and a half
  "01:00:00" : "01:01:02.5" # mute from exactly one hour to one hour, one minute, two seconds and a half will be muted.
+  "01:00:00" : "01:01:02.5" # mute from exactly one hour to one hour, one minute, two seconds and a half will be muted.
 blank_outs:
-  "00:15" : "00:18" # sultry scene from seconds 15 to 18 will be blanked out.
-  "01:00:00" : "01:01:02.5" # also blank out on of the muted scenes.
+  "01:00:00" : "01:01:02.5" # also blank out (overlay with blank window) the same.
 
-...
+Here's one with more detail
 
-Here's an example with more detail
 http://github.com/rdp/sensible-cinema/blob/master/zamples/scene_lists/example_scene_list.yml
 
-Now save that file somewhere (I tend to save it with a .yml extension--you don't have to--.txt will do) 
-and remember where you saved it.
+Basically your job is to save an appropriate file like that somewhere, 
+then start sensible-cinema and instruct it to use your new file.
+
+To create it, basically you notice something you want to add to the list, add it, then go back a few seconds 
+in your media player, and it should now be muted/blanked out automatically.
+
+So here is a way to create your scene list.
+First create a new file [2], and select it in sensible-cinema (even though it's still blank).
+Now select the new file you just created as your scene list.
+Now "preview" the movie, and as we do, we're going to add to the file, and test our additions.
+As you watch and hit a questionable scene, go back to several seconds before it using your player's 
+controls.  When you run into it again, just before and just after the scene, 
+hit the space bar *in the sensible-cinema window*.  Hitting the space bar outputs the current playback time.
+You should now have two reasonably accurate "timestamps" displayed.
+If they look reasonable, add them to your scene list (changes will be automatically picked up), 
+then review your additions by rewinding your player and letting it play through the scene in question again.
+It should now skip it appropriately.  If not, adjust your timestamps and try again.
 
-Now start sensible-cinema, see above, and browse to wherever you file is (the "home" icon might be useful to you), and
-select it for your scene list.  Also restart the movie.
 
-Sensible-cinema will now use it as the edit decision list for the movie
-as it plays it back.  You could probably re-watch the movie and see if you got the timings right.  A good excuse to
-watch movies, what could be better?
+Once you're done then you can contribute your scene list if desired, to the project [1].
 
-Note also that don't have to watch the whole movie twice.  You can create and test the scene list file on the fly.
-To do so, first create a blank file, and choose it in sensible-cinema (even though it's blank).
-Now "as you watch" the movie, you can edit the file, and any new changes should be picked up automatically.
-So you could basically notice something you want to add to the list, add it to the file, then go back a few seconds in your
-media player, and it should now be muted/blanked out automatically.
+[1] http://github.com/rdp/sensible-cinema/issues
+[2] The easiest way to do this is to start sensible-cinema, then instead of choosing an existing file,
+right click and choose "New -> Text Document" Now rename it (leaving it as .txt).
+"Right click -> Open" to open it in an editor.  Now also select that same file in sensible-cinema.
+Another easy way is to "right drag" an existing file then rename it and edit that one.
 
 == FAQ ==
 
 Q. Can I watch movies this way on my TV, not just on my computer?
 
-A. Not yet. Well maybe.  Currently you'll either need to attach your computer to your TV
-   (buy some long cables, or a new graphics card, etc.)
-   or get some other computer that you can move closer to the TV and do the same (ex: buy a used older laptop with s-video out).
-   I'd be happy to do a linux port of sensible-cinema if anybody needs that for their dedicated TV computer.
-   There has also been some work toward getting your computer to stream what it plays "live" to your wii/ps3/xbox.
-   github message me if you're interested in trying it out.
+A. Not yet. And maybe.  Currently you'll either need to attach your computer to your TV
+   (buy some long cables, or a new graphics card, etc.) or get some computer that you can move closer to the TV and do the same 
+   (ex: buy a used older laptop with s-video out, use that).
+   I'd be happy to do a linux port of sensible-cinema if anybody requests it for their dedicated TV computer.
+   There has also been some work toward getting your computer to stream "live" to your wii/ps3/xbox.
+   github message me if you're interested in trying it out!
 
 Q. What movies are available to watch online?
 
-A. Not many are available free (hulu, youtube have a few), but Netflix has quite a few.  Plus you can watch your DVD's
-   on your computer monitor, or rent or borrow them.
+A. Not many are available free (hulu, youtube have a few), but Netflix has quite a few for its default subscription.  
+   Plus you can watch your existing DVD's on your computer, or rent or borrow them and watch them there.
 
 Q. Why does my mouse bounce up and down while this thing is playing?
 
-A. This enables you to keep your on screen tracker visible, which 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 for it.
+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 for it.
 
 Q. Why does it seem really laggy at screen detection at the beginning?
 
@@ -113,10 +123,16 @@ Made programming this actually somewhat a pleasure.
 
 == License ==
 
-See the LICENSE for licensing, usage terms (gplv3).
+See the LICENSE file for licensing, usage terms (gplv3).
+
+== Related ==
+
+http://imdb.com (click on "parent's guide") and http://kids-in-mind.com are two sites that tend to have
+reasonably good lists of what all goes on in a movie
 
 == Feedback ==
 
 Feedback, including feature requests, welcome.
+
 http://github.com/rdp/sensible-cinema
 http://github.com/rdp me

data/TODO

@@ -8,7 +8,10 @@
 == raw backlog ... based on user request.. ==
 
 remember:  just local files for my own needs...
+utube nuki
+generations profanidade
 
+screencast
 bundle fewer imagemagick binaries
 
 "do" star trek generations hulu scene list

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.7.3

data/lib/overlayer.rb

@@ -25,30 +25,32 @@ class OverLayer
   def mute!
     @am_muted = true
     puts 'muting!' if $VERBOSE
-    Muter.mute! unless $DEBUG
+    Muter.mute!
   end
   
   def unmute!
     @am_muted = false
     puts 'unmuting!' if $VERBOSE
-    Muter.unmute! unless $DEBUG
+    Muter.unmute!
   end
   
   def blank!
     @am_blanked = true
-    Blanker.blank_full_screen! unless $DEBUG
+    Blanker.blank_full_screen!
   end
   
   def unblank!
     @am_blanked = false
-    Blanker.unblank_full_screen! unless $DEBUG
+    Blanker.unblank_full_screen!
   end
   
   def check_reload_yaml
-    current_mtime = File.stat(@filename).mtime # save 0.0002!
+    current_mtime = File.stat(@filename).mtime
     if @file_mtime != current_mtime
       reload_yaml!
       @file_mtime = current_mtime 
+    else
+      p 'same mtime:', @file_mtime if $DEBUG && $VERBOSE
     end
   end
   
@@ -203,7 +205,7 @@ class OverLayer
         p 'set debug to', $DEBUG
         return
       when ' ' then
-        puts cur_time
+        puts cur_english_time
         return
       when 'r' then
         reload_yaml!
@@ -320,7 +322,6 @@ class OverLayer
         pps 'sleeping until next action (%s) begins in %fs (%f) %f' % [next_point, time_till_next_mute_starts, Time.now_f, cur_time] if $VERBOSE
         
         @cv.wait(@mutex, time_till_next_mute_starts) if time_till_next_mute_starts > 0
-        pps 'just woke up from pre-mute wait at', Time.now_f if $VERBOSE
         set_states!
       }
     }

data/lib/screen_tracker.rb

@@ -109,6 +109,17 @@ class ScreenTracker
       current = get_bmp
       if current != original
         if @digits
+          return attempt_to_get_time_from_screen
+        else
+          puts 'screen time change only detected...' if $VERBOSE
+        end
+        return
+      end
+      sleep 0.02
+    }
+  end
+  
+  def attempt_to_get_time_from_screen
           out = {}
           dump_digits if $DEBUG            
           digits = get_digits_as_bitmaps # 0.08s [!] not too accurate...
@@ -123,8 +134,12 @@ class ScreenTracker
                   p 'unable to identify digit!' + type.to_s + @a.to_s
                   File.binwrite("bad_digit#{@a}#{type}.bmp", digits[type])
                 end
-                # early return
-                return
+                if type == :hours
+                  digit = 0 # this one can fail in VLC
+                else
+                  # early return
+                  return
+                end
               end
               out[type] = digit
             else
@@ -136,15 +151,8 @@ class ScreenTracker
           p 'got new screen time ' + out + " delta:" + (Time.now - start).to_s if $VERBOSE
           # if the window was in the background it will be all zeroes, so nil it out
           out = nil unless out =~ /[1-9]/
-          return out, Time.now - start
-        else
-          puts 'screen time change only detected...' if $VERBOSE
+          return out, Time.now-start
         end
-        return
-      end
-      sleep 0.02
-    }
-  end
   
   def process_forever_in_thread
     Thread.new {

data/spec/screen_tracker.spec.rb

@@ -165,13 +165,23 @@ describe ScreenTracker do
         end
 
         it "should use OCR against the changes appropriately" do
-          output = @a.wait_till_next_change
+          output = @a.wait_till_next_change # grab a real change
           output[0].should be_a(String)
-          output[0].should include("00:0")# let's hope it runs quickly...
+          output[0].should include("00:0") # let's hope it runs quickly...
           output[0].should match(/[1-9]/)
+          output[1].should be_a Float
         end
-
-        context "with an OCR that can change from hour to minutes during ads" do
+        
+        it "should be ok with a failed hours read" do
+          @a.stub!(:get_digits_as_bitmaps) do
+            four = File.binread('images/4.bmp')
+            {:minute_tens=>four,:second_tens => four, :second_ones => four, :minute_ones => four,
+              :hours => File.binread('images/black.bmp')}
+          end
+          @a.attempt_to_get_time_from_screen[0].should == "0:44:44"
+        end
+        
+      context "with an OCR that can change from hour to minutes during ads" do
           it "should ocr slash...[in other]"
           it "with VLC should be able to recognize when it goes past an hour somehow...probably by presence of hourly colon" # might already do this
         end

data/zamples/players/vlc_full_screened_total_length_over_an_hour.yml

@@ -4,6 +4,7 @@ x: 522
 y: 47
 width: 35
 height: 14
+note: this does not work for a maximized window, but does for full screen (double click)
 digits:
       :hours:
       - -89

data/zamples/players/vlc_non_full_screened_and_total_length_over_an_hour.yml

@@ -0,0 +1,22 @@
+name: VLC media player
+x: -90
+y : -15
+width: 44
+height: 11
+note: does not work if VLC is maximized, must be in a window
+digits:
+      :hours:
+      - -108
+      - 8
+      :minute_tens:
+      - -97
+      - 6
+      :minute_ones:
+      - -91
+      - 7
+      :second_tens:
+      - -81
+      - 6
+      :second_ones:
+      - -76
+      - 7    

data/zamples/scene_lists/example_scene_list.yml

@@ -1,19 +1,20 @@
-title: Forever Strong
-source: Hulu
-version: 0.4.8
-mutes:
-  2.0 : 3.0 # comments can go after the # on each line
-  4.0 : 5.0 # mute from second 4 to second 5
-  9.0 : 13.0 # mute from second 9 to second 13
-  44.0 : 50.0 # mute for 6 seconds starting at second 44
-  # This next means mute from one minute to one minute one second
-  1:00 : 1:01
-  10:01 : 10:02 # mute from ten minutes, one second to ten minutes, 2 seconds
-  # if you use decimals, you'll have to put them in quotes
-  # 01:01:01.05 (for one hour, one minute, one second and a half) does not work
-  # "01:01:01.05" does
-  "01:01:00.5" : "01:01:01.5" # mute from one hour one minute and a half second to one hour one minute and 1.5s
-  
-blank_outs:
-  "00:15" : "00:18" # blank from second 15 to 18
-  01:01 : "01:02.0" # blank from one minute one second to one minute two seconds, etc.
+# comments can go after the # on each line
+title: Forever Strong 
+source: Hulu # these aren't required fields -- mutes and blank_outs are
+mutes:
+  2.0 : 3.0 
+  4.0 : 5.0 # mute from second 4 to second 5
+  9.0 : 13.0 # mute from second 9 to second 13
+  44.0 : 50.0 # mute for 6 seconds starting at second 44
+  # This next means mute from one minute to one minute one second
+  1:00 : 1:01
+  10:01 : 10:02 # mute from ten minutes, one second to ten minutes, 2 seconds
+  # if you use decimals, you'll have to put them in quotes
+  # 01:01:01.05 (for one hour, one minute, one second and a half) does not work
+  # "01:01:01.05" does
+  "01:01:00.5" : "01:01:01.5" # mute from one hour one minute and a half second to one hour one minute and 1.5s
+  
+blank_outs:
+  "00:15" : "00:18" # blank from second 15 to 18
+  01:01 : "01:02.0" # blank from one minute one second to one minute two seconds, etc.
+  1:00:00 : 1:00:30 # note also that if you blank something out it isn't muted unless you *also* add it to the mute list, above. Message me if you want that changed.

data/zamples/scene_lists/happy_feet_dvd.yml

@@ -1,7 +1,12 @@
 title: Happy Feet
-source: VLC DVD
+source: DVD (VLC)
 mutes:
-  # one hour one minute and a half second to one hour one minute and 1.5s
-  "01:33:25.0" : "01:33:50.0"
+  1:45 : 2:25   # sensuality: let's talk about eggs, baby...
+  34:44 : 34:47 # "kiss our bums"
+  "46:33.5" : 46:41 # sensuality: my couch of perpetual indulgence
+  "01:33:21.0" : "01:33:50.0" # sensuality: a few sensual lyrics
 blank_outs:
-  "55:35" : "55:42.0"  # blank from one minute one second to one minute two seconds
+  "55:35" : "55:42.0" # sensuality: some "questionable" dancing
+
+the good: "fun graphics, lots of varied, fun music"
+the bad: bit of a liberal agenda

data/zamples/scene_lists/star_trek_generations_hulu.yml

@@ -0,0 +1,9 @@
+source: "hulu"
+mutes:
+  # these aren't actually accurate yet, except for Data's one
+  # oh my ... at beginning
+  08:54.5 : 08:56 # what the he...
+  10:46.5 : 10:48 # durn
+  11:21 : 11:24.5 # the he...
+  19:45 : 19:50 # religious "...have mercy"
+  "01:15:38.5" : "01:15:41.5" # Data "oh s...."

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 0
     - 7
-    - 2
-  version: 0.7.2
+    - 3
+  version: 0.7.3
 platform: ruby
 authors: 
   - Roger Pack
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-07 00:00:00 -06:00
+date: 2010-08-09 00:00:00 -06:00
 default_executable: sensible-cinema
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -191,21 +191,23 @@ files:
   - vendor/imagemagick/msvcp90.dll
   - vendor/imagemagick/msvcr90.dll
   - vendor/imagemagick/vcomp90.dll
-  - zamples/players/captures/hulu full screen non hour.jpg
-  - zamples/players/captures/hulu full screen over hour.jpg
-  - zamples/players/captures/silence.bmp
-  - zamples/players/captures/vlc grab over one hour file over one hour play.bmp
-  - zamples/players/captures/vlc2.bmp
-  - zamples/players/captures/vlc_full_screen_slider under one hour.bmp
-  - zamples/players/captures/youtube full screen big screen.jpg
   - zamples/players/how_to_create_a_new_player_description.txt
   - zamples/players/hulu_full_screen_total_length_over_an_hour.yml
+  - zamples/players/sample_snapshots/hulu full screen non hour.jpg
+  - zamples/players/sample_snapshots/hulu full screen over hour.jpg
+  - zamples/players/sample_snapshots/silence.bmp
+  - zamples/players/sample_snapshots/utube.JPG
+  - zamples/players/sample_snapshots/vlc grab over one hour file over one hour play.bmp
+  - zamples/players/sample_snapshots/vlc2.bmp
+  - zamples/players/sample_snapshots/vlc_full_screen_slider under one hour.bmp
+  - zamples/players/sample_snapshots/youtube full screen big screen.jpg
   - zamples/players/vlc_full_screened_total_length_over_an_hour.yml
+  - zamples/players/vlc_non_full_screened_and_total_length_over_an_hour.yml
   - zamples/players/vlc_non_full_screened_and_total_length_under_an_hour.yml
   - zamples/scene_lists/disney_cars.yml
   - zamples/scene_lists/example_scene_list.yml
   - zamples/scene_lists/happy_feet_dvd.yml
-  - zamples/scene_lists/star_trek_generations.yml
+  - zamples/scene_lists/star_trek_generations_hulu.yml
 has_rdoc: true
 homepage: http://github.com/rdp
 licenses: []

data/zamples/scene_lists/star_trek_generations.yml

@@ -1,8 +0,0 @@
-source: "hulu"
-mutes:
-  # these aren't actually accurate yet, except for Data's one
-  08:55 : 08:56 # what the he...
-  10:50 : 10:51 # durn
-  11:23 : "11:24" # ?
-  "01:15:39.5" : "01:15:41.5" # Data "oh s...."
-  # two onyx at beginning