sensible-cinema 0.7.3 → 0.7.4

data/README

@@ -1,14 +1,17 @@
-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.
+Sensible-cinema is a program that allows you to do pre-programmed scene selection (i.e. "mute out" 
+or "bleep out" scenes) on arbitrary media players like netflix online, vlc, etc.
 
-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, 
+Currently it takes as input a list of known "skip-worthy" scenes.
+It then tracks the player you are using, and mutes or blanks out the system screen appropriately, 
 during the scenes specified.
 
-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.
+Currently it works out of the box with the hulu and VLC players on windows.  It isn't hard to 
+add new players,and probably wouldn't be too hard to add more operating systems.
 
-The concept isn't all that novel: http://en.wikipedia.org/wiki/Edit_decision_list
+The concept isn't novel:
+
+http://www.imdb.com/swiki/special?ParentalGuideHelp "scene description"
+http://en.wikipedia.org/wiki/Edit_decision_list
 
 == How to use ==
 
@@ -16,21 +19,21 @@ Start playing your movie in its player, then startup sensible-cinema thus:
 
      C:\> jruby -S sensible-cinema
 
-It then prompts you for a scene list file (ex: bambi.yml), 
-and then subsequently for a player description file (ex: hulu_full_screen_with_total_length_over_an_hour.yml).
+It prompts you for a scene description file (ex: bambi.yml), 
+and also for a player description file (ex: hulu_full_screen_with_total_length_over_an_hour.yml).
 
-You could also specify those two filenames on the command-line, if desired, like
+Sensible-cinema will now run in a console window, screen tracking the player to monitor its position,
+and react appropriately.
 
-     C:\> jruby -S sensible-cinema mute_list.yml player_description.yml
+It is presumed that you'll then minimize the console window and proceed to enjoy the movie.
 
-Sensible-cinema will now run in your console window, screen tracking the player's timer to monitor the playback position
-and react appropriately.
+You could also specify those same two filenames on the command-line, if desired, ex:
+
+     C:\> jruby -S sensible-cinema mute_list.yml player_description.yml
 
 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.
-
 == How to install ==
 
 First you'll need to install jruby (in case you haven't already), from http://www.jruby.org
@@ -49,9 +52,9 @@ choosing the hulu player.
 
 It will proceed do a few "demo" mutes and blank outs.
 
-== Programming Your Own Scene List ==
+== Programming Your Own Scene Description File ==
 
-To program sensible-cinema, your job is to create an edit decision list it can use.
+To program sensible-cinema, you create a scene description list it can use.
 
 An Edit Decision List (EDL) looks something like this trivial example:
 
@@ -70,20 +73,20 @@ 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.
+So here is a way to create your scene description file.
 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.
+Now use sensible-cinema and select the new file you just created.
+Now "preview" the movie, and as you do, you're going scenes to the file, and then test your 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), 
+controls.  When you encounter the scene again, track its beginning and ending time.  One way to do this
+is to, just before and just after the scene, hit the space bar *in the sensible-cinema window*.  
+Hitting the space bar outputs the current time.  If you hit it twice, once before and once after, 
+you should now have two reasonably accurate "timestamps" displayed.
+Add the beginning and ending times to your scene description file (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.
 
-
-Once you're done then you can contribute your scene list if desired, to the project [1].
+Once you're done then you can contribute your scene description file if desired, back to the project [1].
 
 [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,
@@ -102,19 +105,23 @@ A. Not yet. And maybe.  Currently you'll either need to attach your computer to
    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?
+Q. What movies does this work with?
+
+A. Any that you program it for  :) Assuming the 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), 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.
+A. Not many are available free (hulu, youtube have a few), though Netflix has quite a few with its default subscription.  
+   Plus you can watch your existing DVD's, or rent or borrow DVD's and watch them using sensible-cinema.
 
-Q. Why does my mouse bounce up and down while this thing is playing?
+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 for it.
 
 Q. Why does it seem really laggy at screen detection at the beginning?
 
-A. It takes it awhile to warm up.  Ping me if you want this fixed.
+A. It takes it awhile to warm up its digit detection.  Ping me if you would like to see this improved speed-wise.
 
 == Thanks ==
 
@@ -127,8 +134,9 @@ 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
+http://imdb.com tends to have reasonably good lists of what occurs in movies (find a movie, click on "parent's guide" on the left).
+Sometimes it even lists the time signatures for events occur (ex: "Labyrinth" http://www.imdb.com/title/tt0047673/parentalguide)
+which you could use to translate into a sensible-cinema compatible list.
 
 == Feedback ==
 

data/TODO

@@ -4,30 +4,27 @@
 
   release ruby-y-y why not, it's interesting
     "Linux compat anyone?"
+  utube nuki
+  generations first profanidade...
   
-== raw backlog ... based on user request.. ==
+== random backlog ... based on user request..remember:  just local files for my own needs...==
 
-remember:  just local files for my own needs...
-utube nuki
-generations profanidade
+blank overlay "and you are one awesome klingon"
 
-screencast
-bundle fewer imagemagick binaries
+screencast of something helpful.
 
-"do" star trek generations hulu scene list
-  "**g" (Hulu near beginning)
-  "may g** have mercy on your soul"
-  Data when they crash into the earth
+optimize imdb: http://www.imdb.com/board/bd0000042/thread/58361958?d=58361958, english friendlier url's
 
-finish happy feet scene list
+bundle fewer imagemagick binaries
 
 just plow forward, to "grab" available ideas...
 
 netflix
   
 add my own stuff to imdb...
+antz to imdb...
 
-imdb parser
+imdb parser...somehow
 
 make it into a real live full functional app...like fully fully functional and good (for use, not editing), mostly with the drop down lists uh guess.
 
@@ -39,7 +36,7 @@ advertise like to lay men, to try to popularize
 
 with VLC non full screen, it does the annoying mouse thing needlessly (which doesn't bug as much these days...)
 
-youtube non full screened...hmmm
+youtube/hulu non full screened...hmmm
 
 overlay with wav file (would work for VLC, could also "click to mute" for the others...)
 
@@ -56,9 +53,7 @@ a web runnable? Why not?
 
 blank out with a user specifiable color (?)
 
-Auto mute commercials?
-
-rruby.net rubyy.net
+Auto mute/blank commercials?
 
 new github username
 
@@ -74,11 +69,6 @@ overlay alpha transparent pic
 Have a "list of all known movies (url's)" and be able to open (IE et al) to the correct part, and start playing them, and they work...
 
 magnify video parts (?)
-overlay with transparent gif?
-
-OCR
-  pop it up only every so often (?)
-    after commercials?
 
 user customizable levels...
   maybe even "I don't like ones that are x, y, z", or "boring level x"
@@ -86,18 +76,16 @@ user customizable levels...
 user-assignable "confidence" (how much time to 'wrap' surround the mutes, etc. to accomodate for slow computers/laggy internet/different players/poor input)
 
 auto-assignment of EDL's to media:
-  DVD's
-    VLC
-    directory of scene-lists
-  web plugin?
+  DVD's (right click...)
+  web browser plugin?
+  auto start on DVD insertion (?)
+    and show appropriate scene-lists available based on title/md5 of something?
 
 Programmatically do all of the above, by driving a player with its real API.
   VLC
-    Allow it to make mp4's somewhere.
-    See if burnable to DVD.
-    web interface?
-  auto start on DVD insertion (?)
-    and show appropriate scene-lists available based on title/md5 of something?
+    Allow it to record to mp4's somewhere.
+    See if burnable to DVD/CD ...
+    (use web interface?)
     
 never do unless paid:
 

data/VERSION

@@ -1 +1 @@
-0.7.3
+0.7.4

data/bin/sensible-cinema

@@ -40,19 +40,18 @@ else
     sleep 4
   else
     if !File.exist? scene_list.to_s
-      scene_list = FileChooser.choose_file("SELECT SCENE LIST", __dir__  + "/../zamples/scene_lists")
+      scene_list = FileChooser.choose_file("SELECT SCENE DESCRIPTIONS FILE", __dir__  + "/../zamples/scene_lists")
     end
     unless scene_list
-        puts "error: have to specify a scene list\n    or specify \"test\" on the command line if you just want to snapshot your player"
+        puts "error: have to specify a scene descriptions file\n    or specify \"test\" on the command line if you just want to snapshot your player"
         exit 1
     end
-    puts 'Selected scene list ' + File.basename(scene_list) + " (#{scene_list})", ''
-    overlay = OverLayer.new(scene_list)  
-    
+    puts 'Selected scene descriptions file ' + File.basename(scene_list) + " (#{scene_list})", ''
+    overlay = OverLayer.new(scene_list)    
   end
   
-  player_description = ARGV.shift
-  if !File.exist?(player_description.to_s)    
+  player_description = ARGV.shift.to_s
+  if !File.exist?(player_description)    
     player_description = FileChooser.choose_file("SELECT PLAYER (optional)", __dir__ + "/../zamples/players")
   end
   

data/lib/overlayer.rb

@@ -87,7 +87,7 @@ class OverLayer
     @mutex = Mutex.new
     @cv = ConditionVariable.new
     @file_mtime = nil
-    reload_yaml!
+    check_reload_yaml
     @start_time = Time.now_f # assume they want to start immediately...
     if minutes
       self.set_seconds self.class.translate_string_to_seconds(minutes)
@@ -112,7 +112,7 @@ class OverLayer
         start = translate_string_to_seconds(start)
         endy = translate_string_to_seconds(endy)
         if start == 0 || endy == 0
-          p 'warning--possible error in the scene list someline not parsed! (NB if you want one to start at time 0 please use 0.0001)', start, endy unless $DEBUG
+          p 'warning--possible error in the scene descriptions file some line not parsed! (NB if you want one to start at time 0 please use 0.0001)', start, endy unless $DEBUG
           # drop it in bitbucket...
         else
           new[start] = endy

data/zamples/players/how_to_create_a_new_player_description.txt

@@ -1,21 +1,17 @@
-Basically to create a player description you tell it the window title and the coordinates of the "clock" as it plays, including the digits
+Basically to create a player description you tell it the window title and the coordinates 
+of the "clock" as it plays, including the digits
 
+Use the others are examples
 
-  some tips:
+  Some tips:
   
-    use WinCheat to see window names (under "Text")
-    run scene-skipper with -v -- it will dump a screenshot of the window in question
-    use Paint.net to examine the dumped graphic and get coords
-
-you can specify "test" in place of the "mutes_list.yml" to have it just the player_description.yml and exit
-it will screen capture your segment to your current working directory.
-
-Paint.net is quite handy.
+    use WinCheat to help with window names (under "Text") (alt+tab helps, too, since it displays titles).
+    run scene-skipper with 'test' for the scene description filename: it will dump a screenshot using the player description
+    use Paint.net to examine the dumped graphic and get coords (invert it to get easy negative coords).
 
 NB that the clock coords can have negative start offsets, which mean "distance from the bottom right corner"
 
-Also you can "invert" the image to more easily get the offsets if you have to use negative offsets.
-
-NB that you can specify "desktop" for the window name meaning full screen.
+NB that you can specify "desktop" for the window name, meaning full screen.  This is easier, though not necessarily better,
+than finding out the real way.
 
-Post back with difficulties or questions.
+Post back with difficulties and/or questions.

data/zamples/scene_lists/example_scene_list.yml

@@ -1,6 +1,4 @@
 # 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
@@ -18,3 +16,9 @@ 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.
+  
+title: Forever Strong 
+source: Hulu # these aren't required fields -- mutes and blank_outs are
+something_else: "for now you can add whatever categories you want, like what_it_would_now_be_rated 
+what_aspects_were_not_able_to_be_removed, url, DVD label, etc, though in reality the only required ones are mutes and blank_outs"
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 0
     - 7
-    - 3
-  version: 0.7.3
+    - 4
+  version: 0.7.4
 platform: ruby
 authors: 
   - Roger Pack