sensible-cinema 0.28.1 → 0.34.0

data/{developer_how_to_contribute_to_the_project.txt → notes_for_potential_developers.txt}

@@ -4,33 +4,40 @@ You can test the DVD portion of the program out by mounting the DVD of "big buck
 http://rogerdpack.t28.net/sensible-cinema/releases/dvd_isos has it and a few other creative commons ISO's for use.
 On windows daemon tools helps there, or "magic ISO" or the like, may be helpful to avoid having to burn disks.
 
-Or you could alternatively burn a copy of big buck bunny to DVD, then use that to test it against (a slightly more cross platform approach).
+Or you could alternatively burn a copy of big buck bunny to DVD, then use that to test it against 
+(a slightly more cross platform approach I guess).
 
-Then rip it and use the output.
+Then rip it and use the output, or use it as your DVD.
 
 Or if you have a DVD that already has a edit list available for it, you could use that, or create
 a new edit list for a DVD you own, etc.
 
-The main development roadmap/backlog is in the TODO. 
 If you have any feedback/feature requests, et al, post an
 issue or post to the Mailing List: http://groups.google.com/group/sensible-cinema
 
-To run it from source, you may need to install a few gem dependencies (listed in the Rakefile)
+To run it from source, download from github, you may need to install a few gem dependencies (listed in the Rakefile)
 
 or to install them automatically:
-
-$ jruby -S gem install sensible-cinema # installs dev. dependencies
-Note that, in order to run the unit tests, you'll want to checkout the source from the repository to get all the test images
-
-The tests are in the spec directory, though some of them are out of date as development has shifted focus to other areas.  
+$ jruby -S gem install rake os sane jeweler # some helper gems
+$ jruby -S rake build
+$ jruby -S gem install pkg\*.gem --development
+# optional:
+$ jruby -S gem uninstall -x sensible-cinema # uninstall the gem so you don't have to worry about it conflicting later, just in case.
+ 
+You'll have to install some git submodules, too.
+$ git submodule init
+$ git submodule update
+
+The tests are in the spec directory, though some of them are out of date as development has shifted focus to other areas.
 
 Note: you transfer (c) of materials to sensible cinema when you submit patches/contributions, of course, so don't submit something you don't want published :)
 
 Also you'll need to run git submodule init && git submodule update (possibly modify .gitsubmodules to be the open one, or ask me to)
 
 To run it via command line:
+
 $ jruby bin/sensible-cinema --help # tells you all available options
-  
+$ jruby lib/edl_parser edl_filename.txt # outputs the file, but parsed, and in YAML, useful for porting to other programming languages.
 Feedback/contribution welcome :)
 
 Ex: want JSON'ified output somehow? Just ask.
@@ -38,7 +45,7 @@ Ex: want JSON'ified output somehow? Just ask.
 == mac os x developers ==
 
 You'll have to install a few dependencies.  It will tell you which at runtime, 
-or see the installation instructions: http://rogerdpack.t28.net/sensible-cinema/
+or see the installation instructions: http://rogerdpack.t28.net/sensible-cinema
 
 == OCR screen tracker ==
 

data/roadmap_possibilities

@@ -0,0 +1,12 @@
+    create a skype/google+ video recorder
+    upconvert DVD
+    upconvert Netflix [seems low demand?]
+    C EDL possibly never
+    netflix/skype "disable screen saver while running" program [?]
+    linearize [?] hmm...
+    re-update todo/all docu/user feedback etc.
+    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 subtitle downloaders...
+    fix VLC's use of dvdnav itself +- mplayer DVD EDL

data/spec/arse.srt

@@ -8,7 +8,7 @@
 
 6
 00:00:55,069 --> 00:00:59,164
-<i>at the very end of this line is a realllly bad word
+<i>don't at the very end of this line is a realllly bad word
 
 6
 00:00:55,066 --> 00:00:59,164
@@ -34,3 +34,8 @@ waiting each < /i> < /I>
 <i>hello
 shell
 
+6
+00:00:56,070 --> 00:00:59,164
+<i>line_end_full_worddon't forget there is heaven and hell.
+waiting each < /i> < /I> 
+

data/spec/dragon.srt

@@ -1,6 +1,7 @@
 1
 00:00:34,715 --> 00:00:37,047
 <i>This is Berk.</i>
+<i>This is Berk.</i>
 
 2
 00:00:37,184 --> 00:00:41,587
@@ -15,6 +16,7 @@
 4
 00:00:46,460 --> 00:00:50,089
 <i>My viIIage. In a word, sturdy.</i>
+<i>My viIIage. In a word, sturdy.</i>
 
 5
 00:00:50,230 --> 00:00:54,929
@@ -29,3 +31,4 @@
 7
 00:00:59,306 --> 00:01:02,298
 <i>The onIy probIems are the pests.</i>
+<i>The onIy probIems are the pests.</i>

data/spec/edl_parser.spec.rb

@@ -18,6 +18,8 @@ This file is part of Sensible Cinema.
 require File.expand_path(File.dirname(__FILE__) + '/common')
 require_relative '../lib/edl_parser'
 
+# MplayerEdl spec also exercises this pretty good...
+
 describe EdlParser do
   
   E = EdlParser
@@ -27,22 +29,27 @@ describe EdlParser do
   end
   
   it "should get mutes and blank_outs" do
-   string = File.read(__DIR__ + "/../zamples/edit_decision_lists/old_not_yet_updated/example_edit_decision_list.txt")
+    string = <<-EOL
+      "mutes" => [
+        "00:00:01", "00:00:02",
+        "00:00:01", "00:00:02", "profanity", "dang",
+      ],
+      "blank_outs" => [
+        "01:01:00", "01:02:00", "nudity", "...",
+      ],
+      "missing_content" => "some stuff"
+    EOL
    expected = 
    {
     "mutes"=>[["00:00:01", "00:00:02"], 
-    ["00:00:01", "00:00:02", "profanity", "dang"], 
-    ["01:01:00", "01:02:00"]], 
-    "blank_outs"=>[["01:01:00", "01:02:00", "nudity", "..."], ["00:03:03.5", "00:03:04.5"]], 
-    "missing_content"=>"this doesn't list some mild name calling", 
-    "title"=>"Forever Strong", "source"=>"Hulu", "url"=>"http://www.byutv.org/watch/1790-100", 
-    "whatever_else_you_want"=>"this is the old version of the film",
-    "disk_unique_id"=>"1234|4678"
+    ["00:00:01", "00:00:02", "profanity", "dang"]], 
+    "blank_outs"=>[["01:01:00", "01:02:00", "nudity", "..."], ], 
+    "missing_content"=>"some stuff", 
    }
    E.parse_string(string, nil).should == expected
   end
   
-  it "should disallow full digits" do
+  it "should disallow full digits only" do
     proc {E.parse_string(%!"mutes" => ["1234", "1235", "profanity", "yo"]!, nil) }.should raise_exception SyntaxError    
     proc {E.parse_string(%!"mutes" => ["0.0", "1.1", "profanity", "yo"]!, nil) }.should_not raise_exception    
     proc {E.parse_string(%!"mutes" => ["0.0", "1.1", "profanity", "yo", "1234", "1235", "bad entry"]!, nil) }.should raise_exception SyntaxError    
@@ -55,12 +62,16 @@ describe EdlParser do
   end
   
   it "should extract digits plus 'stuff' well" do
-    out = ["1:01", "1:01", "a", "2:01", "2:02", "b"]
+    out = ["1:01", "1:01", "a", "2:01", " 2:02", "b"]
     EdlParser.extract_entry!(out).should == ["1:01", "1:01", "a"]
-    EdlParser.extract_entry!(out).should == ["2:01", "2:02", "b"]
+    EdlParser.extract_entry!(out).should == ["2:01", " 2:02", "b"]
+  end
+  
+  it "should parse with spaces ok" do
+    EdlParser.translate_string_to_seconds(" 2:02").should == 60*2+2
   end
   
-  it "should raise if the first two aren't digits" do
+  it "should raise if the first two aren't digits, which is unexpected" do
     proc { EdlParser.extract_entry!(["a"])}.should raise_exception(SyntaxError) 
   end
   
@@ -75,38 +86,39 @@ describe EdlParser do
   
   it "should parse a real file" do
    E.parse_file(File.expand_path(__DIR__) + "/../zamples/edit_decision_lists/dvds/bobs_big_plan.txt").should ==
-     {"title"=>"Bob's Big Plan", "dvd_title_track"=>1, "other notes"=>"could use more nit-picking of the song, as some parts seem all right in the end", "mutes"=>[["00:03.8", "01:03", "theme song is a bit raucous at times"], ["28:13.5", "29:40", "theme song again"], ["48:46", "49:08", "theme song again"]], "blank_outs"=>[]}
+     {"title"=>"Bob's Big Plan", "dvd_title_track"=>1, "other notes"=>"could use more nit-picking of the song, as some parts seem all right in the end", "disk_unique_id"=>"12e77a76|b6e48ce8",  "volume_name"=>"BOBS_BIG_PLAN","mutes"=>[["00:03.8", "01:03", "theme song is a bit raucous at times"], ["28:13.5", "29:40", "theme song again"], ["48:46", "49:08", "theme song again"]], "blank_outs"=>[]}
   end
   
   it "should be able to use personal preferences to decide which edits to make" do
    out = <<-EOL
       "mutes" => [
-      "00:10", "00:15", "test category", "1",
-      "00:20", "00:25", "test category", "2",
-      "00:30", "00:35", "test category", "3"
+      "00:10", "00:15", "test category", "cat1",
+      "00:20", "00:25", "test category", "cat2",
+      "00:30", "00:35", "test category", "cat3"
       ]
     EOL
     parsed = E.parse_string out, nil
     parsed["mutes"].length.should == 3 # has all of them
 
     1.upto(2) do |n|
-      parsed = E.parse_string(out, nil, [["test category", n.to_s]] )
+      parsed = E.parse_string(out, nil, [["test category", "cat" + n.to_s]] )
       parsed["mutes"].length.should == 2 # excludes one
     end
-    parsed = E.parse_string(out, nil, [["test category", "1"], ["test category", "2"]] )
+    parsed = E.parse_string(out, nil, [["test category", "cat1"], ["test category", "cat2"]] )
     parsed["mutes"].length.should == 1 # excludes two
 
     # now with...just saying "this entire category is fine"
     parsed = E.parse_string(out, nil, [["test category"]])
     parsed["mutes"].length.should == 0
-
-    # now with...just saying "levels below this are ok"
-    parsed = E.parse_string(out, nil, [["test category", 2]])
-    parsed["mutes"].length.should == 2
-
+
+    pending do
+      # now with...just saying "levels below this are ok"
+      parsed = E.parse_string(out, nil, [["test category", 2]])
+      parsed["mutes"].length.should == 2
+    end
   end
   
-  it "should parse mplayer_dvd_splits as floats" do
+  it "should parse mplayer_dvd_splits as strings" do
     E.parse_string('"mplayer_dvd_splits" => []', 'fakename')['mplayer_dvd_splits'].should == []
     E.parse_string('"mplayer_dvd_splits" => ["123.5","124.5"]', 'fakename')['mplayer_dvd_splits'].should == ["123.5","124.5"]
   end
@@ -135,36 +147,18 @@ describe EdlParser do
     proc{ go({"mutes"=>{105=>104.9}})}.should raise_error(SyntaxError)
   end
   
-  it "should allow for splits in its parseage" do
-    go({ "mutes"=>{5=>6,105=>106}, "blank_outs" => {110 => 111} }, 0, 0, [103]).should == 
-      [[1.0, 4.0, :mute], [5.0, 6.0, :mute], [6.0, 9.0, :blank]]
-  end
-  
   it "should raise on poor overlap" do
-    proc{go({ "mutes"=>{5=>10, 6=>7}}, 0, 0, [1000])}.should raise_error(/overlap/i)
+    proc{go({ "mutes"=>{5=>10, 6=>7}}, 0, 0, [])}.should raise_error(/overlap/i)
   end
   
-  # I put down it at 10:00 it's at 10:00.5
-  # so...postludingers should be...too early now?
-  # change when complaints come in :P
   it "should take the greater of the end and beginning on combined splits and greater of the blank versus mute" do
     # so if I have a very long mute with a mute in the middle, it should turn into a very long mute
-    go({ "mutes"=>{5=>10, 103=>107}}, 0, 0, [100]).should == [[2.0, 10.0, :mute]]
-    go({ "mutes"=>{5=>10, 103=>110}}, 0, 0, [100]).should == [[2.0, 11.0, :mute]]
-    go({ "mutes"=>{5=>15, 103=>110}}, 0, 0, [100]).should == [[2.0, 15.0, :mute]]
-    go({ "mutes"=>{5=>10, 103=>111}}, 0, 0, [100]).should == [[2.0, 12.0, :mute]]
-    # now throw in blanks to the mix...
-    go({ "mutes"=>{5=>10}, "blank_outs" => {103=>110}}, 0, 0, [100]).should == [[2.0, 11.0, :blank]]
-    go({ "blank_outs"=>{5=>10}, "mutes" => {103=>110}}, 0, 0, [100]).should == [[2.0, 11.0, :blank]]
-  end
-  
-  it "should accomodate well for multiples, and zero" do
-    go({ "mutes"=>{5=>10, 75 => 76, 101 => 102}}, 0, 0, [50, 100]).should == 
-      [[0.0, 4.0, :mute], [5.0, 10.0, :mute], [24.0, 27.0, :mute]]
+    go({ "mutes"=>{5=>10, 103=>107}}, 0, 0, []).should == [[5, 10, :mute], [103, 107, :mute]]
+
+    # and with blanks to the mix...
+    go({ "mutes"=>{5=>10}, "blank_outs" => {103=>110}}, 0, 0, []).should ==  [[5, 10, :mute], [103, 110, :blank]]
   end
   
-  it "should handle edge cases, like where an entry overlaps the divider, or the added stuff causes it to"
-  
   def translate x
     EdlParser.translate_string_to_seconds x
   end
@@ -191,11 +185,11 @@ describe EdlParser do
   end
   
   it "should translate ints to english timestamps well" do
-    english(60).should == "01:00"
+    english(60).should == "01:00.00"
     english(60.1).should == "01:00.10"
-    english(3600).should == "1:00:00"
-    english(3599).should == "59:59"
-    english(3660).should == "1:01:00"
+    english(3600).should == "1:00:00.00"
+    english(3599).should == "59:59.00"
+    english(3660).should == "1:01:00.00"
     english(3660 + 0.1).should == "1:01:00.10"
   end
   
@@ -255,7 +249,18 @@ describe EdlParser do
 
    it "should download from imdb if specified and merge" do
      File.binwrite('files/edls/a.txt', %!"imdb_id" => "tt1727587"!)
-     EdlParser.parse_file('files/edls/a.txt').should == {"blank_outs" => [["0:00:56", "0:00:57"], ["0:01:05", "0:01:14.500"]], "mutes" => [], "imdb_id" => "tt1727587"}
+     EdlParser.parse_file('files/edls/a.txt').should == {"blank_outs" => [["0:00:56.00", "0:00:57.00"], ["0:01:05.00", "0:01:14.50"]], "mutes" => [], "imdb_id" => "tt1727587"}
    end
   
+  it "should be able to convert from 29.97 DVD time to DVDNAV time" do
+    
+    #"dvd_title_track_start_offset" => "0.06",
+    #"dvd_nav_packet_offset" => [0.866667, 0.944217],
+    
+    start = [[1.0, 2.0, :blank], [3600, 3601, :mute]]
+    endy = EdlParser.convert_to_dvd_nav_times start, 'dvd_start_offset', 0.06, [0.866667, 0.944217], 29.97
+    # it should be slightly higher than 1, and slightly less than 3600
+    endy.should == [[1.07655099900099900000, 2.07555199800199830000, :blank], [3596.48114640359600000000, 3597.48014740259760000000, :mute]]
+  end
+  
 end

data/spec/mencoder_wrapper.spec.rb

@@ -34,7 +34,8 @@ describe MencoderWrapper do
     FileUtils.rm 'to_here.fulli_unedited.tmp.mpg.done' rescue nil
     FileUtils.rm 'to_here.fulli_unedited.tmp.mpg' rescue nil
     @a = EdlParser.parse_file "../zamples/edit_decision_lists/dvds/bobs_big_plan.txt"
-    @out = MencoderWrapper.get_bat_commands @a, "e:\\", 'to_here'
+    @a["dvd_start_offset"] = 0
+    go
   end
   
   it "should be able to convert" do      
@@ -164,13 +165,13 @@ describe MencoderWrapper do
   
   it "should accept audio_code" do
     # for the audio philes, I guess..
-    settings = {"audio_codec"=>"copy2"}
+    settings = {"audio_codec"=>"copy2", 'dvd_start_offset' => 0.0}
     out = MencoderWrapper.get_bat_commands settings, "e:\\", 'to_here.avi'
     out.should include("-oac copy2")
   end
   
   def setup
-    @settings = {"mutes"=>{1=>2, 7=>12}, "blank_outs"=>{"2"=>"3"}}
+    @settings = {"mutes"=>{1=>2, 7=>12}, "blank_outs"=>{"2"=>"3"}, "dvd_start_offset" => 0}
     @out = MencoderWrapper.get_bat_commands @settings, "e:\\", 'to_here.avi'
   end
   
@@ -199,30 +200,36 @@ describe MencoderWrapper do
     @out.scan(/(ffmpeg|mencoder).*to_here.avi.2.avi/).length.should be >= 1
   end
   
-  context 'pinpointing sections' do
+  context 'telling it to only go from here to there' do
     before do
-     settings = {"mutes"=>{15=>20, 30 => 35}}
-     @out = MencoderWrapper.get_bat_commands settings, "e:\\", 'to_here.avi', '00:14', '00:25'  
+     @settings = {"mutes"=>{15=>20, 30 => 35}, "dvd_start_offset" => 0}
+     @out2 = MencoderWrapper.get_bat_commands @settings, "e:\\", 'to_here.avi', '00:14', '00:25'  
     end
     
     it "should always somewhat grab the whole thing, no endpos" do
-      @out.should_not match(/mencoder dvd.*endpos/)
+      @out2.should_not match(/mencoder dvd.*endpos/)
     end
     
     it "should contain the included subsections" do
-     @out.should_not include("-t 34.99")
-     @out.should include("14.0")
-     @out.should_not include("99999")
-     @out.should include(" 0 ") # no start at 0 even
-     @out.should match(/-ss 14.0.*0.999/)
-     @out.should match(/-ss 15.0.*4.999/)
-  end
+     @out2.should_not include("-t 34.99")
+     @out2.should include("14.0")
+     @out2.should_not include("99999")
+     @out2.should include(" 0 ") # no start at 0 even
+     @out2.should match(/-ss 14.0.*0.999/)
+     @out2.should match(/-ss 15.0.*4.999/)
+    end
   
-  it "should allow you to play something even if there's no edit list, just for examination sake" do
-    setup
-    proc { MencoderWrapper.get_bat_commands @settings, "e:\\", 'to_here', '00:14', '00:15', "1", false, true}.should raise_error(/unable/)
+    it "should allow you to play something even if there's no edit list, just for examination sake" do
+      setup
+      proc { MencoderWrapper.get_bat_commands @settings, "e:\\", 'to_here', '00:14', '00:15', "1", false, true}.should raise_error(/unable/)
+    end
+  end
+
+  it "should allow one to specify some dvd_start_offsets" do
+    settings = {"mutes"=>{15=>20, 30 => 35}, "dvd_start_offset" => '0.36'}
+    out = MencoderWrapper.get_bat_commands settings, "e:\\", 'to_here.avi'
+    out.should match(/-vol 0  -ss 14.64 -t 4.999/) # mute
+    out.should match(/-ss 19.64 -t 9.999/) # unmute
   end
-  
-end
   
 end

data/spec/mplayer_edl.spec.rb

@@ -24,19 +24,19 @@ describe MplayerEdl do
   it "should translate verbatim" do
     a = MplayerEdl.convert_to_edl({ "mutes"=>{105=>145, "46:33.5"=>2801}, "blank_outs" => {6 => 7} } )
     # 0 for skip, 1 for mute
-    a.should == <<EOL
+    a.should == <<-EOL
 6.0 7.0 0
 105.0 145.0 1
 2793.5 2801.0 1
-EOL
+    EOL
   end
   
   it "should add to mutes" do
     a = MplayerEdl.convert_to_edl({ "mutes"=>{105=>106}, "blank_outs" => {110 => 111} }, 1 )
-    a.should == <<EOL
+    a.should == <<-EOL
 105.0 107.0 1
 110.0 112.0 0
-EOL
+    EOL
   end
 
   it "should catch overlaps from additions to mutes" do
@@ -51,20 +51,50 @@ EOL
 
   it "should add to beginning and ending of mutes" do
     a = MplayerEdl.convert_to_edl({ "mutes"=>{105=>106}, "blank_outs" => {110 => 111} }, 1, 1 )
-    a.should == <<EOL
+    a.should == <<-EOL
 104.0 107.0 1
 109.0 112.0 0
-EOL
+    EOL
+  
+  end
   
+  it "should accomodate for unordered sections in some dvd's and order the output" do
+    mplayer_dvd_splits = [103]
+    a = MplayerEdl.convert_to_edl({ "mutes"=>{5=>6,105=>106}, "blank_outs" => {110 => 111}}, 0, 0, mplayer_dvd_splits )
+    a.should == <<-EOL
+1.0 4.0 1
+5.0 6.0 1
+6.0 9.0 0
+    EOL
   end
   
-  it "should accomodate for split sections in some dvd's and order the output" do
-    a = MplayerEdl.convert_to_edl({ "mutes"=>{5=>6,105=>106}, "blank_outs" => {110 => 111}}, 0, 0, [103] )
+  it "should use non additive mplayer_dvd_splits" do
+    mplayer_dvd_splits = [103, 150]
+    a = MplayerEdl.convert_to_edl({ "mutes"=>{5=>6,114=>115}}, 0, 0, mplayer_dvd_splits )
     a.should == <<-EOL
-2.0 3.0 1
 5.0 6.0 1
-7.0 8.0 0
+10.0 13.0 1
     EOL
   end
+    
+  it "should combine overlaps" do
+    mplayer_dvd_splits = [103, 12]
+    a = MplayerEdl.convert_to_edl({ "mutes"=>{5=>6, 105 => 106, 120=>121}}, 0, 0, mplayer_dvd_splits )
+    a.should == <<-EOL
+1.0 8.0 1
+    EOL
+    
+  end
+  
+  it "should use non additive mplayer_dvd_splits 2" do
+    mplayer_dvd_splits = [103, 47]
+    a = MplayerEdl.convert_to_edl({ "mutes"=>{5=>6,124=>125, 185 => 190}}, 0, 0, mplayer_dvd_splits )
+    a.should == <<-EOL
+5.0 6.0 1
+20.0 23.0 1
+33.0 42.0 1
+    EOL
 
+  end
+  
 end