sensible-cinema 0.23.2 → 0.23.3

data/LICENSE.TXT

@@ -15,4 +15,4 @@ unzip.exe is herein included, under the info-zip license: http://www.info-zip.or
 
 some binary builds of dvdid are also distributed here.  See http://www.srcf.ucam.org/~cjk32/dvdid
 
-See first also the file "is_it_legal_to_copy_dvds.txt" for more information on legal use in your country.
+See first also the file "documentation/is_it_legal_to_copy_dvds.txt" for more information on legal implications in your country.

data/README

@@ -45,17 +45,17 @@ Enjoy your movies!
 
 == Installation ==
 
-Installation instructions available here: http://rogerdpack.t28.net/sensible-cinema
-NB that you want to download from sourceforge, not from github downloads.
+Installation and usage instructions available here: http://rogerdpack.t28.net/sensible-cinema
+NB that you want to download it sourceforge, not from github downloads.
 
 == Creating Your Own Delete Lists, or modifying previously existing ones ==
 
-See the accompanied how_to_create_your_own_delete_lists.txt file.
+See the accompanying documentation/how_to_create_your_own_delete_lists.txt file.
 
 == Creating an edited DVD ==
 
-See also is_it_legal_to_copy_dvds.txt for some caveats you should understand.
-I don't actually know how I've never burned a DVD.
+I don't actually know how to do this I've never burned a DVD.
+See also is_it_legal_to_copy_dvds.txt for some caveats you should understand first.
 Windows DVD Maker might help, http://www.dvdflick.net might help.
 iDVD might help on mac.
 DO NOT MAKE ILLEGAL COPIES OF DVD's. See is_it_legal_to_copy_dvds.txt.
@@ -148,95 +148,14 @@ See also the "Overly Verbose History" section.
   and they told us the model we got was defective, and that the new one was much better and we could get it at a discount, but 
   the next one just died also."
 
-== Overly Verbose History ==
-
-Sensible Cinema was preceded/inspired by EDL's of editors in the 90's, cleanflicks (both analog and digital incantations, late 90's), 
-then mplayer began to support EDL, zoomplayer added a scene-cut editor, 
-http://code.google.com/p/movie-content-editor came along, and also many
-other editors have historically supported EDL for content creation and/or playback (see wikipedia's "edit decision list"),
-such as mythtv/XBMC's EDL support (as suggested by the phantom edit [1], oreillynet.com), 
-VLC also added playlists with optional start and stop positions per entry.  Ffmpeg, mencoder were high quality video editing open source tools. 
-Once I discovered all of these previously existing programs, I knew the right elements were ready for 
-something like sensible cinema.
-
-See also the "related" section, and "motivation" section.
-
-Originally the project started as a prototype to "watch hulu (online) and netflix instant movies
-edited" (it uses/used screen snapshots (of specific locations where the digits are expected, based on windows position) 
-and then tracks, using OCR of the on-screen (convert to timestamp), to monitor it for specific times relative 
-to an EDL, and react appropriately.
-However, this functionality, though working and available, is disabled currently for potential patent
-issues.  Some older released versions had it enabled, but not the later releases.
-Then I realized I could basically have the same effect by instructing a video player (VLC) to "play from second x to y"
-ok "now play from z to q muted" etc. (so kind of a stop and go video player, kind of like controlling the remote for you).
-It basically was implementing Edit Decision Lists (EDL's) using playlists and
-VLC.  
-I just passed VLC a playlist, it did all the work for me, without any necessary real-time tracking.  This seemed patent friendly,
-so I went with this.  There are a few released versions with this feature enabled.  
-They avoid real-time tracking by specifying "play from here to here"
-not "skip from here to here" as some other editing players do.
-
-Then it occurred to me that one could grab the several clean segments
-off a movie file, and piece them together to create an edited clean version ( a la cleanflix ).  This also avoids 
-realtime tracking, so I also included this ability.
-The playlist option is disabled in later releases, as it was deemed too user-non-friendly, and because VLC timing
-is "different" than standard DVD players, so I decided to just use standardized timing, though it worked fine
-for VLC playbacks.
-I replaced it with support for mplayer's EDL format, which works better, and has consistent timing, though is still a bit buggy.
-
-You can see a full list of other features that have been published and demonstrated
-in the accompanying file change_log_with_feature_list.txt.  Each feature mentioned works 
-in some released version of sensible-cinema though some features have been removed in subsequent versions
-(they're all available as rubygems).
-
-Who knows what the future will hold...
-
-[1] http://www.oreillynet.com/sysadmin/blog/2005/06/make_your_own_phantom_edit_wit.html
-
-== Related ==
-
-The concepts I use aren't novel.  Some other previously existing related type examples:
-
-Edited "airplane edit" style movies.
-Commercial TV (ABC, NBC) show their own (edited) movies.
-http://en.wikipedia.org/wiki/Linear_video_editing
-http://en.wikipedia.org/wiki/Edit_decision_list#Systems_supporting_EDL_playback.2C_not_just_EDL_cutting lists a lot of players that support EDL DVD playback in some form or another.
-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 (ex: "Labyrinth" http://www.imdb.com/title/tt0091369/parentalguide) which you could use to translate into a sensible-cinema compatible list.
-Normal DVD's versus "directors cut" versions of movies (one is at times preferable, content wise)
-http://en.wikipedia.org/wiki/Edit_decision_list (it's a linear editing tool, after all--so see the vast list of those)
-Clean Flicks (used to) sell edited movies
-http://www.videoredo.com/en/index.htm lets you "cut out" offensive content (commercials et al) and burn DVD's from mpeg's/h264 streams
-http://www.microsoft.com/windows/windowsmedia/howto/articles/device_control.aspx Windows Media Encoder supports EDL's by timestamp
-http://www.mplayerhq.hu/DOCS/HTML/en/edl.html
-http://www.sharewareconnection.com/fast-compress-content-and-anti-profanity.htm replaces profanity in web pages with euphemized content.
-http://www.oreillynet.com/sysadmin/blog/2005/06/make_your_own_phantom_edit_wit.html (mplayer has had this ability for awhile, with no complaints).
-http://clearplay.com a commercial "filtering" DVD player See the "motivation" section for a description.
-  It does offer a few features that sensible cinema supports but disables, for patent reasons, like automatic (user flexible) content decisions.  Ours are manual, etc.
-http://en.wikipedia.org/wiki/RiffTrax has an interesting idea of "overlaying" audio over the original video, and synchronizing between the two (their re-player does, anyway).
-http://forum.bsplayer.com/feature-requests-feedback-suggestions/7157-chapter-playlist-scene-cut-3.html
-http://www.inmatrix.com zoom player's "scene cut editor"
-http://wiki.xbmc.org/?title=EDL_(commercial_skipping)_and_SceneMarker_support (XBMC's scene cut supporter--also contains links to some other editors' support for EDL's)
-http://dvdshrink.info "Re-author" mode: to make "movie-only" backups, compilations, combine "flippers",.... DvdShrink has the ability to "crop or cut parts of a title" etc.
-The VCR with its record button, coupled with the stop+rewind button.
-http://kb2.adobe.com/cps/191/tn_19151.html Adobe Director MX 2004 can "script" DVD playback.
-DVD's themselves allow for "scripted" playback of certain content, allowing controls for jumping from location to location, switching audio/video tracks, etc.
-http://code.google.com/p/movie-content-editor (player written in Python, controls VLC based on subtitles and user-input, using edit decision lists in realtime)
-http://forums.gbpvr.com/showthread.php?10606-Automated-Cutting-and-Transcoding-Guide-Using-Mencoder/page45
-http://www.imdb.com/swiki/special?ParentalGuideHelp (search for "scene description")
-http://www.mythtv.org/wiki/Removing_Commercials
-showanalyzer http://www.dragonglobal.biz/showanalyzer.html and comskip analyze videos to look for "segments to cut out" automatically (commercials, in this case, but the principle still applies) 
-Old-school: using the remote control with the pause, mute, stop, fast forward, and play buttons, along with previous knowledge of "questionable" scene locations
-The scissors and old VHS tapes (Clean Flicks' origin, if I remember correctly).  http://www.familysafemedia.com/home_movie_editor.html (was a helper kit for cutting VHS tape)
-Windows Movie Maker.  Allows for users to cut and copy scenes of movies.  Really any editor can do this.
-http://forum.videolan.org/viewtopic.php?f=7&t=56998 VLC Media Player using EDL's via playlists
-Corel WinDVD has "Quick Clip" settings for capturing from DVD.
-Microsoft's built-in magnifier basically copies DVD's screen output if mouse is placed over playing DVD.
-http://superuser.com/questions/85278/how-can-i-cut-scenes-out-of-a-dvd
-http://blog.josephhall.com/2008/09/command-line-dvd-authoring-part-1.html
-AviSynth can script dvd playback http://forum.doom9.org/archive/index.php/t-109558.html
-ps3 media server has edl support: https://github.com/chocolateboy/PMS-EDL maybe would work with DVD's dunno
-Anydvd HD's "magic file replacement" for DVD's/blu-ray's
-RiffTrax allows for an audio "overlay" to a DVD playback, have their own player to coordinate the two.
+== History ==
+
+See the file history_and_related_works_list.txt for an overly verbose history.
+Also see the file change_log_with_feature_list.txt.
+
+== Related Works ==
+
+See the file history_and_related_works_list.txt
 
 == License ==
 
@@ -249,30 +168,7 @@ See first also the file "is_it_legal_to_copy_dvds.txt" for more information on l
 
 == Troubleshooting ==
 
-If you run into some snag, try cleaning your DVD and starting over (delete all files, start again). 
-Baking soda toothpaste might help with cleaning it.
-If it still errs, report it, along with a screen snapshot and steps of
-how to reproduce the problem, preferably.  See the feedback section.
-
-It can fail also because a deletion is past end of DVD, or 
-Also make sure you aren't out of disk space.
-
-Try playback in "VLC Media Player"
-
-You try to play back a sensible cinema-ized video file and it plays back without
- audio or video (example: windows media player)?
-
- This probably means you're using windows media player, and don't have "codecs" installed
-   to handle this type of audio.  Not to fear, just download the "ffdshow tryouts" (google for it)
-   and, when it gives you the option, be sure to check "mpeg2 video" and then
-   it should "just work."  You could also optionally just play the file in VLC Media Player or smplayer
-   (there's a button for that).  Installing "AC3Filter" may help if you can hear no audio.  
-   Really VLC Media Player is your best bet though.
-
-If the end result picture is too grainy/pixelated or if the overall process is too slow, let me know and I'll work on
-making it better.  No really, I have some ideas, but want to see if there's need first for improvement in those areas.
-
-Finally, report back! If there are problems that arise, I want to hear about them so we can help you through it.
+See the file documentation/troubleshooting.txt, or contact (see the feedback/development section).
 
 == Thanks ==
 
@@ -284,21 +180,21 @@ the authors and maintainers of said libraries, and anybody else I forgot to ment
 
 == Feedback/Development ==
 
-Feedback, including feature requests, comments, etc. welcome:
+Feedback, including feature requests, comments, etc. all welcome:
 
-Mailing List: http://groups.google.com/group/sensible-cinema
+Mailing List: http://groups.google.com/group/sensible-cinema, or just mail to sensible-cinema@googlegroups.com
 
 If you're a developer and want to help out with programmming or look and feel, etc., please do!
-See development.txt : github.com/rdp/sensible-cinema
+See development.txt file, and also http://github.com/rdp/sensible-cinema
 
 If you want to donate something, please consider donating to a charity of your choice.  
-No really.  Do it for this!
+No really.
 
 == Competition/use of files ==
 
 Note that competition/use of files from sensible cinema is welcome!
 
-In fact, the current end goal is to publish the delete lists (EDL's) as a separate repository with its
-own API, meaning that even "for profit" users can use them for whatever other use they want, hopefully
+In fact, the current end goal is to publish the delete lists (EDL's) to a separate repository with its
+own API under the CC license, meaning that even "for profit" users can use them for whatever other use they want, hopefully
 good uses :)  More direct direct competitors are also welcome here.  I only made this because I had to
-and nothing like it existed, so if something else springs up, I'm happy to use it instead.
+and nothing like it existed, so if something else springs up, I'm actually happy to use it instead, too.

data/Rakefile

@@ -119,17 +119,23 @@ task 'zip' do
 end
 
 def sys arg
- raise unless system arg
+ 3.times {
+  if system arg
+    return
+  end
+ }
+ raise arg + ' failed 3x!'
 end
 
 task 'deploy' do
   name = 'sensible-cinema-' + cur_ver + ".zip"
   p 'copying to ilab'
   sys "scp #{name} rdp@ilab1.cs.byu.edu:~/incoming"
+  p 'creating sf shell'
+  sys "ssh rdp@ilab1.cs.byu.edu 'ssh rogerdpack,sensible-cinema@shell.sourceforge.net create'" # needed for the next command to be able to work [weird]
   p 'creating sf dir'
-  sys "ssh rdp@ilab1.cs.byu.edu 'ssh -t rogerdpack,sensible-cinema@shell.sourceforge.net create'" # needed for the next command to work.
   sys "ssh rdp@ilab1.cs.byu.edu 'ssh rogerdpack,sensible-cinema@shell.sourceforge.net \"mkdir /home/frs/project/s/se/sensible-cinema/#{cur_ver}\"'"
-  p 'copying into sf'
+  p 'copying into sf from ilab'
   sys "ssh rdp@ilab1.cs.byu.edu 'scp ~/incoming/#{name} rogerdpack,sensible-cinema@frs.sourceforge.net:/home/frs/project/s/se/sensible-cinema/#{cur_ver}/#{name}'"
   p 'successfully deployed to sf only! ' + cur_ver
 end

data/TODO

@@ -6,13 +6,13 @@
   
   === loose ordering/eventually ===
     linearize [?] hmm...
-    re-update todo/all docu
+    re-update todo/all docu/user feedbacks
     create web site/api-ify
     LLC
       if...back off to just the ffmpeg (plus an "[A,B]" viewer) only...but for now stick with just DVD playback [?] until people want more...
     no propaganda...
 	  no auto subtitles...
-    try out on people
+    fix VLC dvdnav itself +- mplayer DVD EDL
   
 == high prio like blocking bugs ==  
   
@@ -25,60 +25,57 @@
    url -> url inference [hopefully this is cake...]
    fix the failing 9 digit test the fancy shmancy way :P
    can pass in a profanity command line
-   can handle dual md5's
+   can handle dual dvdid's
    youtube: use the javascript API somehow, like http://universalsubtitles.org/en does
      phase 1: does they use inferred timestamp?  can I use that generally, too? [do phase 1--publish simple javascript demo of it muting for awhile after startup]
       just in case youtube takes over the world
  
-== yes do ordered ==
+== yes do ordered in conjunction with the above ==
   try buy delete lists from all x,y,z [?] maybe ask for them for free first? ()
+    http://www.familysafemovies.com
+    cleanflix (earl? that guy [John webster http://www.amazon.com/Make-Edited-Movies-ebook/dp/B004EYT3BU]?)
+    cougar video (that looks tough...)
+    http://www.cleanplaydvds.com
+    cleanfilms.com (now dead) "clean films"
+    that one on state street (John webster?)
+    http://www.edited-movies.com/buy-edited-movies/
+    http://www.clean-edited-movies.com/clean_flicks.htm ray lines ?
+    maybe more listed here: http://www.clean-edited-movies.com/clean_flicks.htm
+    Almost overnight, competitors to CleanFlicks popped up with twists on the CleanFlicks brand -- CleanFilms, Clean Flix, Clean-Flicks, Family Focus Films
+    family flix
+    http://theeditedmovieencyclopedia.blogspot.com/2008/08/clean-play-dvds-grand-opening-e-mail.html has grande list
   next timing thing (notes file)
 
-== yes do, un-ordered currently, from the various release options ==
-
-  unit tests all
-  after remove the ability to "grab" update readme
-  check if tmdb uses the full DVDID [?]
-  just tell mac users "use tsmuxer this way" http://instantitunes.wordpress.com/2010/02/26/use-tsmuxer-on-snow-leopard
-  for now just make a "convert timestamp" button for mplayer OSD conversion ?
-  if they disdain to choose a filename the whole thing exits.
-  an "advanced" screen for obscure things...
-    maybe after tooltips? I need some user feedback here...
-  note realtime: clearplay
-  tell them "I need it as a raw mpeg file, use makemkv with tsmuxer to transform it to an mpeg, or use mplayer to grab it" 
-    "just look at the title track in the EDL, then..."
+== yes do, un-ordered currently, from the various future release options ==
+  don't use eval!
+  warn/redirect if wrong looking file extension...
+  add the "create .edl file for xbmc et al" button
+  add a "watch edited from file" option...don't *force* too...?
+    check if some other buttons are outdated...
+  unit tests (all)
+  if they disdain to choose a save to filename the whole thing exits.
   tell them "to edit easily..."
-    "for now just ignore any editors...they're just too fickle!"
-    double check--are my ffmpeg splits really really really the same as mplayer's EDL splits? really?
-    "hardware DVD player/commercial DVD software"
+    double check--are my ffmpeg splits really really really the same as mplayer's EDL DVD splits? really?
     "you could watch it under mplayer with the OSD turned on" 
       [+ button for same?]
-      "you could watch it with a normal DVD player (hardware or software, a la powerDDVD et al)"
-        add button for "convert from DVD Player [mplayer OSD, commercial]" to accurate timestamp [single timestamp]
-    "you could edit it in basically any editor--they are usually pretty accurate"
-    "you could edit your file "raw" file "with avidemux, except video will be slightly off, but audio will be on"
-    "VLC [or any GUI] is always slightly off."
   can I avoid requiring use of tsmuxer first?
+    auto tsmuxer/mediainfo [yikes]? 
+      MUXOPT --no-pcr-on-video-pid --new-audio-pes --vbr --vbv-len=500 V_MPEG-2, "G:\Video\c\title00.mkv", fps=23.976, ar=As source, track=1, lang=eng A_AC3, "G:\Video\c\title00.mkv", track=2, lang=eng
   check with blu-ray...do they match timing-wise? sub-title wise?
   donate tsmuxer, makemkv, http://ffmpeg.zeranoe.com/builds, mulder [?] smplayer
-  auto tsmuxer/mediainfo [yikes]? 
-    MUXOPT --no-pcr-on-video-pid --new-audio-pes --vbr --vbv-len=500 V_MPEG-2, "G:\Video\c\title00.mkv", fps=23.976, ar=As source, track=1, lang=eng A_AC3, "G:\Video\c\title00.mkv", track=2, lang=eng
-  instructions: reference the sintel DVD :) (+download it from my site here)
   add an mencoder convert with mplayer_breaks button :P
     can I just use mencoder -hr-edl-seek (off mpeg) to avoid the fulli phase? please? does it work super-accurately, after that?
     maybe just under an "advanced" window...
   youtube/hulu timings
-  Watch...unedited smplayer button doesn't play from the right device if you have two :P
-  get LLC before a "real" domain name
-  always force them to have a DVD in the drive :P
-  upconverter
   split LLC's website+consumer
-  employ instructions: watch @ realtime after profanity filter first pass :P
-  
+    get LLC before a "real" domain name
+  always force them to have a DVD in the drive :P ?
+  upconverter
+  employee instructions: watch @ realtime after profanity filter first pass :P  
   clear runnings
     have ben and chris test it out, have it work, then ask about video quality
-    me try my copy
-  try disney digital copy/amazon library "local download"...
+    me try
+  try disney digital copy
   C player:
     use DVD navigator
     just use mplayer EDL syntax, plus a title track (or just detect track change, if long enough, assume... :P) :)
@@ -94,29 +91,16 @@
         can come out of full screen more easily :P
     note pay for XP http://windows.microsoft.com/en-US/windows/downloads/windows-media-player/plug-ins search for the cheapest
     note to them windows vista/7: use ac3filter [?]
-  donate menumeter $
-  tool tips for all buttons...tweak naming, too :P
-  fix/create the "play previously created edited file for current DVD" button
-  vendorize smplayer * 2
-    test if latest smplayer can work with edl and seek [?]
-    be able to use smplayer, never just mplayer [yikes]
-    apparently just using webdl is like r30369 yipers
+  donate menumeter $ makemkv
+  reate the "play previously created edited file for current DVD" button
   note better to previewer "you are about to preview these specific edits..." ?
   ask for more beta testers for use, ask for more beta testers for creation, too
-  beta release: rinse and repeat with various ppl
+    beta release: rinse and repeat with various ppl
   youtube videos -> new account name
-  note "pay us/somebody to do it for you on the google group"?
-  note "this is the full list--your help is wanted/needed"
   create a semi-accurate phantom edit EDL
     http://www.chefelf.com/forums/index.php?showtopic=6176
     karlie?
   inventionzy: blu-ray OCR
-  accomodate 2 disk unique id's...yeah
-  don't exit program if they don't select a disk originally :) e.g. if they cancel out of "Please pick a DVD Delete list file"
-  tell them "you can open the file for more specific editing accuracy of timestamps via microsoft Windows Movie Maker" or whatever it is (try it out first :P)
-    7: Windows Live Movie Maker
-    previous: Windows Movie Maker
-  re-run with several DVD's
   port to mac OS X--try everything out (all buttons), make sure all works...
       appears that, for now, have to just use mplayer dvd://
       ppc dvdid?
@@ -124,11 +108,8 @@
       bundle a copy of smplayer locally?
   typically delete unedited.fulli file automatically
     except if it's a specific scene run test...
-  the final "edited.avi" really "could/should" be playable in WMP...
-  it should clear old smplayer options on startup always, just in case, somehow
-  use smplayer with my mplayer always...unless I'm moving away from that...
-  @makemkv: show us the title numbers, and number them *by those*
-  generic EDL run through should be through smplayer...do I need the other way around, even?
+  the final "edited.avi" really "could/should" be playable in WMP...if possible
+  generic/consumer EDL run through should be through smplayer...do I need the other way around, even?
 
 == other lists ==
 
@@ -142,7 +123,8 @@
   canceling from the "dvd id" box exits the whole app LOL
 
 == DVD-realtime backlog once do, now not do, unordered ==
-  can "blur out" scenes, or specific pixels on frames, like that guy bleeping out his own profanity just lips plus bleep
+  investigate boxee edl (just fer fun...maybe possible?) http://getsatisfaction.com/boxee/topics/commercial_skipping_edl_support
+  investigate xbmc dvd edl
   for mplayer realtime it needs to start early, but end on time
   mplayer instructions are obscured
   mplayer EDL allow this:
@@ -158,12 +140,17 @@
   can I make playback more smooth by upping mplayer cache? does smplayer pass it a parameter?
   lua VLC EDL plugin? LOL yeah right.
   investigate: can I use zoomplayer max?
+  investigate dvdrsbvdl (windows media center edl plugin)
 
 == DVD/DVD-realtime backlog (totally unordered, some very low prio, basically all never do) ==
-
+  @makemkv: show us the title numbers, and number them *by those*
   @macports: set notestxt \
   13	    "The MPlayer developers do not believe in making regular releases. \
   14	    You are likely better off using the mplayer-devel port." *before* and after (?) (double check it--would one way work ok? mplayer)
+  can I use mplayer's "-edlout" to simplify something something, or maybe I should slave mode mplayer for my own means of the same?
+  create real plugins for boxee, XBMC et al
+  can "blur out" scenes, or specific pixels on frames, like that guy bleeping out his own profanity just lips plus bleep
+  a new button (maybe just in advanced mode?) "play EDL mplayer from file (no transcoding)" [if anybody ever would want/need it--seems related to the new c-based player kind of...?]
   if it doesn't parse a file you choose it annoyingly loops *forever* "error pooping" "error pooping" [?]
   "real" dvdid for blu-ray, can work with them (once I figure out timing info...)
   accept the "user inputable" profanities, based on the DVD (like "thor" or what not...)
@@ -340,7 +327,8 @@ warn when labels both exist and don't match...
 @mplayer warn before overwrite
 @mplayer you cannot convert mkv files correctly you silly!
 bounty dvdnav
-fix dvdnav?
+  fix dvdnav stuffs?
+ask swank if individuals can rent too?
 
 == random non-DVD backlog ... or never do DVD. note: just plow forward, to "grab" available ideas...except that for now, just what *I* plan on needing for myself (filters for what I need/want). ==
 

data/VERSION

@@ -1 +1 @@
-0.23.2
+0.23.3

data/bin/sensible-cinema

@@ -30,12 +30,14 @@ raise 'need jruby' unless OS.java?
 raise 'need newer jruby!' unless RUBY_DESCRIPTION >= 'jruby 1.6.0' # may not need this since we still have to accomodate for so many oddities :P
 
 alias system_original system
+require 'fileutils'
 require_relative '../lib/mencoder_wrapper'
 require_relative '../lib/storage'
 require_relative '../lib/edl_parser'
 require_relative '../lib/mplayer_edl'
 require_relative '../lib/play_audio'
 require_relative '../lib/subtitle_profanity_finder'
+require_relative '../lib/convert_thirty_fps'
 
 require 'tmpdir'
 require_relative '../lib/swing_helpers'
@@ -79,7 +81,7 @@ module SensibleSwing
     # currently advanced mode only *adds* buttons
     def new_jbutton title, only_on_create_mode, tooltip = nil
       button = JButton.new title
-      button.tool_tip= tooltip
+      button.tool_tip = tooltip
       button.set_bounds(44, @starting_button_y, @button_width, 23)
       add = true
       if we_are_in_create_mode
@@ -96,19 +98,29 @@ module SensibleSwing
       button
     end
     
-    def increment_button_location
-      @starting_button_y += 30
+    def add_text_line line
+      return unless we_are_in_create_mode
+      jlabel = JLabel.new line
+      happy = Font.new("Tahoma", Font::PLAIN, 11)
+      jlabel.setFont(happy)
+      jlabel.set_bounds(44,@starting_button_y ,460,14)
+      @panel.add jlabel
+      increment_button_location 18
+    end
+    
+    def increment_button_location how_much = 30
+      @starting_button_y += how_much
     end
     
     def force_accept_license_first
         require_blocking_license_accept_dialog 'Sensible Cinema', 'gplv3', 'http://www.gnu.org/licenses/gpl.html', 'Sensible Cinema license agreement', 
           "Sensible Cinema is distributed under the gplv3.\nBY CLICKING \"accept\" YOU SIGNIFY THAT YOU HAVE READ, UNDERSTOOD AND AGREED TO ABIDE BY THE TERMS OF THIS AGREEMENT"
-        require_blocking_license_accept_dialog 'Sensible Cinema', 'is_it_legal_to_copy_dvds.txt file', File.expand_path(File.dirname(__FILE__) + "/../is_it_legal_to_copy_dvds.txt"), 
-          'is_it_legal_to_copy_dvds.txt file', 'I acknowledge that I have read, understand, accept and agree to abide by the implications noted in the is_it_legal_to_copy_dvds.txt file'
+        require_blocking_license_accept_dialog 'Sensible Cinema', 'is_it_legal_to_copy_dvds.txt file', File.expand_path(File.dirname(__FILE__) + "/../documentation/is_it_legal_to_copy_dvds.txt"), 
+          'is_it_legal_to_copy_dvds.txt file', 'I acknowledge that I have read, understand, accept and agree to abide by the implications noted in the documentation/is_it_legal_to_copy_dvds.txt file'
         Storage['main_license_accepted'] = VERSION
     end
 
-    Storage = Storage.new("sensible_cinema")
+    Storage = Storage.new("sensible_cinema_storage")
     
     def initialize
       super "Sensible-Cinema #{VERSION} (GPL)"
@@ -123,10 +135,10 @@ module SensibleSwing
       panel.set_layout nil
       add panel # why can't I just slap these down?
 
-      jlabel = JLabel.new 'Welcome to Sensible Cinema!' + (we_are_in_create_mode ? " Hover over buttons for descriptions." : "")
+      jlabel = JLabel.new 'Welcome to Sensible Cinema!' + (we_are_in_create_mode ? " Hover over buttons for tooltip \"help\" descriptions." : "")
       happy = Font.new("Tahoma", Font::PLAIN, 11)
       jlabel.setFont(happy)
-      jlabel.set_bounds(44,44,360,14)
+      jlabel.set_bounds(44,44,460,14)
       panel.add jlabel
       @starting_button_y = 120
       @button_width = 400      
@@ -139,7 +151,7 @@ module SensibleSwing
         do_mplayer_edl
       }
       
-      @create = new_jbutton( "Create edited copy of DVD on Your Hard Drive, from a DVD", false)
+      @create = new_jbutton( "Create edited copy of a DVD file on Your Hard Drive", false)
       @create.tool_tip = <<-EOL
         This grabs from your DVD and creates a new file on your hard disk like dvd_name_edited.mpg for you to watch later.
         The file you create will contain the whole movie edited.
@@ -149,17 +161,19 @@ module SensibleSwing
         do_copy_dvd_to_hard_drive false
       }
       
-      @create_new_edl_for_current_dvd = new_jbutton("Create new Delete List for a new DVD", true, 
-        "If your DVD doesn't have an EDL created for it, this will be your first step--create a new EDL file for it.")
+      @create_new_edl_for_current_dvd = new_jbutton("Create new Delete List for a DVD", true, 
+        "If your DVD doesn't have an EDL created for it, this will be your first step--create an EDL file for it.")
       @create_new_edl_for_current_dvd.on_clicked do
         create_brand_new_edl
       end
 
-      @open_help_file = new_jbutton("open how_to_get_files_from_dvd.txt file", false).on_clicked do
-        open_file_to_edit_it("how_to_get_files_from_dvd.txt")
+      @open_help_file = new_jbutton("View Sensible Cinema Documentation", false).on_clicked do
+        system_blocking("explorer \"#{__DIR__.to_filename}..\\documentation\"") rescue nil # says it fails in error...
       end
       
-      @open_list = new_jbutton("Open/Edit a previously existing Delete List", true, "If your DVD has a previously existing EDL for it, you can open it to edit it with this button.")
+      add_text_line 'Realtime create Options:'
+      
+      @open_list = new_jbutton("Open/Edit a previously created Delete List", true, "If your DVD has a previously existing EDL for it, you can open it to edit it with this button.")
       @open_list.on_clicked {
         dialog = FileDialog.new(self, "Pick file to edit")
         dialog.set_directory EDL_DIR
@@ -175,7 +189,7 @@ module SensibleSwing
         This is useful if you want to just kind of watch the movie to enjoy it, and look for scenes to cut out.
         You can use the built-in OSD (on-screen-display) to see what time frame the questionable scenes are at
         (type "o" to toggle it).  However, just realize that the OSD is in 30 fps, and our time stamps are all in 29.97
-        fps, so you'll need to convert it to be able to use it in a file.
+        fps, so you'll need to convert it (the convert timestamp button) to be able to use it in a file.
       EOL
       @play_smplayer.on_clicked {
         play_dvd_smplayer_unedited
@@ -183,21 +197,79 @@ module SensibleSwing
 
       @play_mplayer_raw = new_jbutton( "Watch full DVD unedited (realtime mplayer)", true)
       @play_mplayer_raw.tool_tip = <<-EOL
-        This is also useful for comparing subtitle files to see
-        if they have accurate timings.
-        If you turn on subtitles (v button), then compare your file at say, the 1 hour mark, or 2 hour mark,
+        This is also useful for comparing subtitle files to see if they have accurate timings.
+        If you turn on subtitles (use the v button), then compare your srt file at say, the 1 hour mark, or 2 hour mark,
         with the subtitles that mplayer displays, it *should* match exactly with the output in the command line,
-        like "A: 3600.0" should match your subtitle line of approximately "01:00:00,000"
+        like "V: 3600.0" should match your subtitle line "01:00:00,000 --> ..."
       EOL
       @play_mplayer_raw.on_clicked {
         play_dvd_smplayer_unedited true
       }
 
-#      @watch_created_file = new_jbutton( "Watch edited file copy of DVD", false).on_clicked {
+#      @watch_created_file = new_jbutton( "Watch the edited file version of DVD", false).on_clicked {
 #        raise 'todo' # TODO 
 #      }
 
-      @preview_section = new_jbutton( "Preview a certain time frame from file (edited)", true )
+      # TODO "Watch a file using an EDL on it"
+
+
+      @display_unique = new_jbutton( "Display current DVD's unique ID", true )
+      @display_unique.tool_tip = "This is useful to setup a DVD's 'unique ID' within an EDL for it. \nIf your EDL doesn't have a line like disk_unique_id => \"...\" then you will want to run this to be able to add that line in."
+      @display_unique.on_clicked {
+        drive, volume, dvd_id = choose_dvd_drive
+        # display it, allow them to copy and paste it out
+        show_copy_pastable_string("#{drive} #{volume} for your copying+pasting pleasure (highlight, then ctrl+c to copy)\n
+        This is USED to identify a disk to match it to its EDL, later.", "\"disk_unique_id\" => \"#{dvd_id}\",")
+      }
+      
+      @convert_timestamp = new_jbutton( "Convert timestamp from DVD player time to EDL time", true)
+      @convert_timestamp.tool_tip=<<-EOL
+        Our EDL's assume 29.97 fps (which is what a DVD is).  Unfortunately most hardware/commercial DVD players
+        assume that the DVD is 30 fps, which means that if you watch a movie with them, then use those timestamps
+        for your EDL file, you will be off, at the end of a 2 hour film, by 8 seconds.  So all your edits will be wrong.
+        How to fix: convert your times from "DVD player" time to "EDL accurate" time by using this button.
+        This is necessary for hardware DVD player timestamps, PowerDVD, Windows Media Player (playing a DVD),
+        but not necessary for smplayer timestamps (or mplayer's "V: 3600" in the command line), which are already 29.97.
+        smplayer's on-screen-display (the 'o' key) is accurate (and doesn't suffer from dvd_mplayer_splits) 
+        but is 30 fps, so timestamps would need to be converted.
+        Dont use VLC for DVD timestamps at all--it can get up to 30s off!  VLC playing back a file is usually pretty accurate to 29.97.
+        In general, GUI's like VLC or smplayer are always a tidge off (maybe 0.3s) from the right timestamp, so take that into consideration.
+        Mplayers "V: 3600" is usually right on, however.
+      EOL
+      @convert_timestamp.on_clicked {
+        thirty_fps = get_user_input("Enter your DVD (30 fps) timestamp, I'll convert it to 29.97 (usable in EDL's):", "1:00:00.1")
+        thirty_fps_in_seconds = EdlParser.translate_string_to_seconds thirty_fps
+        twenty_nine_seven_fps = ConvertThirtyFps.from_thirty(thirty_fps_in_seconds)
+        human_twenty_nine_seven = EdlParser.translate_time_to_human_readable twenty_nine_seven_fps, true
+        show_copy_pastable_string("29.97 (sensible cinema usable) value would be:                ", human_twenty_nine_seven)
+      }
+      
+      @parse_srt = new_jbutton("Parse a subtitle file (.srt) to detect profanities", true)
+      @parse_srt.tool_tip = <<-EOL
+        You can download a .srt file and parse it to automaticaly search for profanities.
+        Basically download it from opensubtitles.org (possibly from other places, too),
+        (enter dvd name in the search box, click a result, click one from the list with an English flag, then click 'Download(zip)')
+        Once you download the zip, unzip it, and then compare the timestamps in it with those on the DVD (see the button "Watch DVD unedited (realtime mplayer)")
+      EOL
+      @parse_srt.on_clicked {
+        fc = new_filechooser
+        fc.set_title "Pick srt file:"
+        if old_dir = Storage['old_srt_dir']
+          fc.set_current_directory JFile.new(old_dir)
+        end
+        filename = fc.go
+        Storage['old_srt_dir'] = fc.get_current_directory.to_s
+        Storage['start_time']
+        
+        parsed = SubtitleProfanityFinder.edl_output [filename]
+        File.write(EdlTempFile, "# add these into your mute section if they apply\n" + parsed)
+        open_file_to_edit_it EdlTempFile
+      }
+
+
+      add_text_line 'Create Options that first create a local intermediary file unless it already exists:'
+
+      @preview_section = new_jbutton( "Preview a certain time frame from fulli file (edited)", true )
       @preview_section.tool_tip = <<-EOL
         This allows you to preview an edit easily.
         It is the equivalent of saying \"watch this file edited from exactly minute x second y to minute z second q"
@@ -207,28 +279,34 @@ module SensibleSwing
         do_copy_dvd_to_hard_drive true
       }
       
-      @preview_section_unedited = new_jbutton("Preview a certain time frame (unedited)", true)
+      @preview_section_unedited = new_jbutton("Preview a certain time frame from fulli file (unedited)", true)
       @preview_section.tool_tip = "Allows you to view a certain time frame unedited (ex: 10:00 to 10:05), so you can narrow down to pinpoint where questionable scenes are, etc. This is the only way to view a specific scene if there are not cuts within that scene yet."
       @preview_section_unedited.on_clicked {
         do_copy_dvd_to_hard_drive true, false, true
       }
 
-      @rerun_preview = new_jbutton( "Re-run most recently watched preview time frame", true )
+      @rerun_preview = new_jbutton( "Re-run most recently watched preview time frame from fulli file", true )
       @rerun_preview.tool_tip = "This will re-run the preview that you most recently performed.  Great for checking to see if you last edits were successful or not."
       @rerun_preview.on_clicked {
         repeat_last_copy_dvd_to_hard_drive
       }
       
-      @fast_preview = new_jbutton( "fast preview all (smplayer EDL on file)", true)
-      @fast_preview.tool_tip = "Plays smplayer with an EDL.  \nThis gives you a rough estimate to see if your edits are accurate, and is really fast to seek, etc.\nThis is useful because you can't use mplayer on a DVD if it has any DVD timestamp splits in it [some DVD's are buggy]"
+      # Maybe this button should go too...
+      @fast_preview = new_jbutton("fast preview all from fulli file (smplayer EDL)", true)
+      @fast_preview.tool_tip = <<-EOL
+        Plays smplayer on a file with an EDL.
+        This gives you a rough estimate to see if your edits are accurate, and is really fast to seek, etc.
+        This is useful because you can't use mplayer on a DVD for accurate timestamps if it has any 
+        timestamp splits in it [because some DVD's are buggy]
+      EOL
       @fast_preview.on_clicked {
         success, wrote_to_here_fulli = do_copy_dvd_to_hard_drive false, true
         sleep 0.5 # lodo take out ???
         background_thread.join if background_thread # let it write out the original fulli, if necessary [?]
         nice_file = wrote_to_here_fulli #+ ".fast.mpg"
         if false#!File.exist?(nice_file)
-          p = show_non_blocking_message_dialog("Creating quick lookup file--NB that for each changed deletion, 
-            you'll need to restart the fast preview SMplayer
+          p = show_non_blocking_message_dialog("Creating quick lookup file--NB that for each changed deletion setting, 
+            you'll need to save your file and restart the fast preview SMplayer instance.
             Also note that the start and end times will be slightly off if reality [delayed]
             Also note that while doing fast preview, it can be doing a normal preview as well
             in the background, simultaneously.")
@@ -241,54 +319,16 @@ module SensibleSwing
         set_smplayer_opts "-edl #{EdlTempFile}"
         thread = do_mplayer_edl( "smplayer_portable #{nice_file}") # note the smplayer, but it's for the fast file...
       }
-
-      # TODO remove me...
-      @watch_unedited = new_jbutton("Watch full DVD unedited (while simultaneously grabbing file to hard drive)", true)
-      @watch_unedited.on_clicked {
-        success_no_run, wrote_to_here_fulli = do_copy_dvd_to_hard_drive false, true, true
-        sleep 5 unless success_no_run
-        command = "smplayer_portable #{wrote_to_here_fulli}"
-        system_non_blocking command
-      }
-
-      # until I can let them know *why* they would ever need this button...
-      @display_unique = new_jbutton( "Calculate DVD's unique ID", true )
-      @display_unique.tool_tip = "This is useful to setup a DVD's 'unique ID' within an EDL for it.  If your EDL doesn't have a line like disk_unique_id => \"...\" then you will want to run this to add it in."
-      @display_unique.on_clicked {
-        drive, volume, dvd_id = choose_dvd_drive
-        # display it, allow them to copy and paste it out
-        get_user_input("#{drive} #{volume} for your copying+pasting pleasure (highlight, then ctrl+c to copy)\n
-        This is USED to identify a disk to match it to its EDL, later.", "\"disk_unique_id\" => \"#{dvd_id}\",")
-      }
       
-      @upload = new_jbutton("Upload/E-mail suggestion/Submit anything", true)
+      add_text_line 'Contact:'
+
+      @upload = new_jbutton("Upload/E-mail suggestion/Contact/Submit anything", true) # keep this one last! :)
       @upload.tool_tip = "We welcome all feedback!  For example if you create a new DVD EDL, please submit it back to us so that others can benefit from it!"
       @upload.on_clicked {
         system_non_blocking("start mailto:sensible-cinema@googlegroups.com")
         system_non_blocking("start http://groups.google.com/group/sensible-cinema")
       }
       
-      @parse_srt = new_jbutton("Parse a subtitle file (.srt) to detect profanities", true)
-      @parse_srt.tool_tip = <<-EOL
-        You can download a .srt file and parse it to automaticaly search for profanities.
-        Basically download it from opensubtitles.org (possibly from other places, too),
-        (enter dvd name in the search box, click a result, click one from the list with an English flag, then click 'Download(zip)')
-        Once you download the zip, unzip it, and then compare the timestamps in it with those on the DVD (see the button "Watch DVD unedited (realtime mplayer)")
-      EOL
-      @parse_srt.on_clicked {
-        fc = new_filechooser
-        fc.set_title "Pick srt file:"
-        if old_dir = Storage['old_srt_dir']
-          fc.set_current_directory JFile.new(old_dir)
-        end
-        filename = fc.go
-        Storage['old_srt_dir'] = fc.get_current_directory.to_s
-        Storage['start_time']
-        
-        parsed = SubtitleProfanityFinder.edl_output [filename]
-        File.write(EdlTempFile, "# add these into your mute section if they apply\n" + parsed)
-        open_file_to_edit_it EdlTempFile
-      }
       
       @progress_bar = JProgressBar.new(0, 100)
       @progress_bar.set_bounds(44,@starting_button_y,@button_width,23)
@@ -314,18 +354,16 @@ module SensibleSwing
       check_for_dependencies
     end
     
-    require 'fileutils'
-    
     def set_smplayer_opts to_this
-        smplayer_prefs_file = File.expand_path("~/.smplayer/smplayer.ini")
-        old_prefs = File.read(smplayer_prefs_file) rescue ''
-        old_prefs = "[advanced]\nmplayer_additional_options=" unless old_prefs.contain? 'mplayer_additional_options='
-        new_prefs = old_prefs.gsub(/mplayer_additional_options=.*/, "mplayer_additional_options=#{to_this}")
-        FileUtils.mkdir_p File.dirname(smplayer_prefs_file) # case it doesn't exist'
-        File.write(smplayer_prefs_file, new_prefs)
-        p 'wrote', new_prefs.length, smplayer_prefs_file, to_this
-        # no worky doze File.write(File.expand_path('~/.mplayer/config'), to_this)
-        smplayer_prefs_file
+      smplayer_prefs_file = File.expand_path("~/.smplayer/smplayer.ini")
+      old_prefs = File.read(smplayer_prefs_file) rescue ''
+      old_prefs = "[advanced]\nmplayer_additional_options=" unless old_prefs.contain? 'mplayer_additional_options='
+      new_prefs = old_prefs.gsub(/mplayer_additional_options=.*/, "mplayer_additional_options=#{to_this}")
+      FileUtils.mkdir_p File.dirname(smplayer_prefs_file) # case it doesn't exist'
+      File.write(smplayer_prefs_file, new_prefs)
+      p 'wrote', new_prefs.length, smplayer_prefs_file, to_this
+      # no worky doze File.write(File.expand_path('~/.mplayer/config'), to_this)
+      smplayer_prefs_file
     end
     
     def create_brand_new_edl
@@ -431,7 +469,7 @@ module SensibleSwing
       command = "#{exe} dvdnav://#{title_track_maybe_nil}/#{drive} -osd-fractions 2 -nocache "
       p command
       @play_smplayer_warn ||= show_non_blocking_message_dialog "Directions:
-      'o' key: turn on on-screen time stamps (note: these are 30 fps timestamps so will need to be converted to use).
+      'o' key: turn on on-screen-display timestamps (note: these are 30 fps timestamps so will need to be converted to use).
       'v' key: turn off subtitles.
       '.' key: step one frame.
       'f' for full screen."
@@ -480,11 +518,11 @@ module SensibleSwing
       puts 'Please confirm license agreement in open window.'
       old = ['no', 'yes', 'ok'].map{|name| 'OptionPane.' + name + 'ButtonText'}.map{|name| [name, UIManager.get(name)]}
       UIManager.put("OptionPane.yesButtonText", 'Accept')
-      UIManager.put("OptionPane.noButtonText", "View License (#{license_name})")
+      UIManager.put("OptionPane.noButtonText", "View File (#{license_name})")
       # cancel button stays the same...
 
       message ||= "Sensible Cinema requires a separately installed program (#{program}).  You can install this program
-        separately, or Sensible Cinema can download it for you.
+        separately to the vendor/cache directory, or Sensible Cinema can download it for you.
         By clicking accept, below, you are confirming that you have read and agree to be bound by the
         terms of its license (the #{license_name}), located at #{license_url_should_also_be_embedded_by_you_in_message}.  
         Click 'View License' to view it.  If you do not agree to these terms, click 'Cancel'.  You also agree that this is a 
@@ -497,6 +535,7 @@ module SensibleSwing
       # 2 is cancel
       if returned == 1
         system_non_blocking("start #{license_url_should_also_be_embedded_by_you_in_message}")
+        puts "Please restart after reading license agreement, to be able to then accept it."
         System.exit 1
       end
       if returned == 2
@@ -639,12 +678,16 @@ module SensibleSwing
     
     include_class javax.swing.UIManager
     
-    def get_user_input(message, default = '')
+    def get_user_input(message, default = '', cancel_ok = false)
       received = JOptionPane.showInputDialog(message, default)
-      raise 'user canceled' unless received
+      raise 'user canceled' unless received unless cancel_ok
       received
     end
     
+    def show_copy_pastable_string(message, value)
+      get_user_input message, value, true
+    end
+    
     def parse_edl path
       EdlParser.parse_file path
     end
@@ -659,10 +702,10 @@ module SensibleSwing
         edit_list_path = single_edit_list_matches_dvd(dvd_id)
         if !edit_list_path && choose_file
           fc = FileDialog.new(self)
-          fc.set_title "Please pick a DVD Delete List File (non matching found)"
+          fc.set_title "Please pick a DVD Delete List File (none found that seem to match #{dvd_volume_name})--or create one for it"
           fc.set_directory EDL_DIR
           edit_list_path = fc.go
-          raise 'cancelled' unless edit_list_path
+          raise 'cancelled choosing an EDL' unless edit_list_path
         end
         @_edit_list_path = edit_list_path
       end
@@ -692,7 +735,7 @@ module SensibleSwing
       @_get_import_from_filename ||=
       begin
         file_from_chooser = new_filechooser Storage['get_import_from_filename_dir']
-        file_from_chooser.set_title "Please choose the file that is your ripped version of #{dvd_title} title ##{dvd_title_track} (.mpg or .ts--see how_to_use.txt)"
+        file_from_chooser.set_title "Please choose the file that is your ripped version of #{dvd_title} title ##{dvd_title_track} (.mpg or .ts--see documentation/how_to_get_files_from_dvd.txt file)"
         outgoing = file_from_chooser.go
         Storage['get_import_from_filename_dir'] = File.dirname(outgoing)
         outgoing
@@ -763,7 +806,7 @@ module SensibleSwing
       save_to_edited = get_save_to_filename dvd_friendly_name
       fulli = MencoderWrapper.calculate_fulli_filename save_to_edited
       if exit_early_if_fulli_exists
-        if fulli_dot_done_file_exists
+        if fulli_dot_done_file_exists? save_to_edited
           return [true, fulli]
         end
         # make it create a dummy response file for us :)
@@ -811,16 +854,15 @@ module SensibleSwing
            to #{file_from} (#{dvd_title}).
         Copying to #{save_to}.
       EOL
-      if !fulli_dot_done_file_exists save_to
+      if !fulli_dot_done_file_exists? save_to
         popup_message += "This could take quite awhile (several hours), and will prompt you with a chime noise when it is done.\n
         You can close this window and minimize sensible cinema and continue using your computer while it runs in the background."
       end
       
       if !start_time
         # assume a full run..
-        popup_message += "\nNB that the created file will be playable only with VLC (possibly also with smplayer), but probably not with windows media player."
+        popup_message += "NB that the created file will be playable only with VLC (possibly also with smplayer), but probably not with windows media player."
       end
-
       
       popup = show_non_blocking_message_dialog(popup_message, "OK")
 
@@ -910,8 +952,7 @@ module SensibleSwing
         @saved_opticals = opticals # since we force them to have their disc already in there...guess this is ok for os x :)
         return @_choose_dvd_drive
       else
-        puts 'did not select a drive...hard exiting'
-        java.lang.System.exit 1
+        raise 'did not select a drive...'
       end
     end