tracksperanto 2.2.0 → 2.2.2

data/History.txt

@@ -1,3 +1,14 @@
+=== 2.2.2 / 2011-04-03
+
+* The last change to PFMatchit exporter had adverse effects on pftrack files, now fixed.
+* Pipeline now has it's own exceptions, all inheriting from RuntimeError
+
+=== 2.2.1 / 2011-04-01
+
+* April fool!
+* PFMAtchit requires LF in it's files instead of CRLF, but our FPTrack exporter used CRLF. Now fixed.
+* Changed PFMatchit exporter to export .txt files instead of .2dt
+
 === 2.2.0 / 2011-03-01
 
 * Improve documentation substantially

data/Rakefile

@@ -9,7 +9,7 @@ begin
   
   Hoe.spec('tracksperanto') do | p |
     p.readme_file   = 'README.rdoc'
-    p.extra_rdoc_files  = FileList['*.rdoc']
+    p.extra_rdoc_files  = FileList['*.rdoc'] + FileList['*.txt']
     p.version = Tracksperanto::VERSION
     
     p.extra_deps = {"progressbar" => ">=0"}

data/bin/tracksperanto

@@ -18,10 +18,10 @@ require "net/http"
 require "open-uri"
 require "timeout"
 
-def version_check
+def version_check(version_present)
   begin
     version_info = open("http://rubygems.org/api/v1/gems/tracksperanto.xml").string.scan(/<version>(.+)<\/version>/).to_s
-    int_available, int_present = [version_info, Tracksperanto::VERSION].map{|v| v.scan(/(\d+)/).to_s.to_i }
+    int_available, int_present = [version_info, version_present].map{|v| v.scan(/(\d+)/).to_s.to_i }
     if int_available > int_present
       puts "Your version of Tracksperanto is probably out of date (the current version is #{version_info}, but you have #{Tracksperanto::VERSION})."
       puts "Please consider updating (run 'gem update tracksperanto')"
@@ -30,8 +30,12 @@ def version_check
   end
 end
 
+def disclaimer
+  "Please consider a small donation to keep Tracksperanto going. http://guerilla-di.org/source-and-license/\n"+
+  "For information and support please contact info#{64.chr}guerilla-di.org"
+end
+
 options = {}
-$notice = "Please consider a small donation to keep Tracksperanto going. http://guerilla-di.org/source-and-license/"
 $middlewares = []
 writer_klass_name = nil
 readers = Tracksperanto.importer_names
@@ -77,8 +81,7 @@ op.on("--flop", "Flop the comp vertically", &mw("Flop", :enabled, true))
 op.on("--version", "Show the version and exit") do |v| 
     puts "Tracksperanto v.#{Tracksperanto::VERSION} running on Ruby #{RUBY_VERSION} on #{RUBY_PLATFORM}"
     puts "Copyright 2008-#{Time.now.year} by Guerilla-DI (Julik Tarkhanov and contributors)"
-    puts "For questions and support contact info#{64.chr}guerilla-di.org"
-    puts $notice
+    puts disclaimer
     version_check()
     exit(0)
 end
@@ -107,5 +110,6 @@ pipe.exporters = [Tracksperanto.get_exporter(writer_klass_name)] if writer_klass
 pipe.run(input_file, options)
 pbar.finish
 
-puts "Converted #{pipe.converted_points} trackers with #{pipe.converted_keyframes} keys. #{$notice}"
-version_check()
+puts "Converted #{pipe.converted_points} trackers with #{pipe.converted_keyframes} keys."
+puts disclaimer
+version_check(Tracksperanto::VERSION)

data/lib/export/pfmatchit.rb

@@ -1,16 +1,14 @@
 # Export for PFMatchit
 class Tracksperanto::Export::PFMatchit < Tracksperanto::Export::Base
   
-  # PFtrack wants cross-platform linebreaks
-  LINEBREAK = "\r\n"
-  KEYFRAME_TEMPLATE = "%s %.3f %.3f %.3f\r\n"
+  KEYFRAME_TEMPLATE = "%s %.3f %.3f %.3f"
   
   def self.desc_and_extension
-    "pfmatchit.2dt"
+    "pfmatchit.txt"
   end
   
   def self.human_name
-    "PFMatchit .2dt file (single camera)"
+    "PFMatchit user track export file (single camera)"
   end
   
   def start_tracker_segment(tracker_name)
@@ -22,13 +20,13 @@ class Tracksperanto::Export::PFMatchit < Tracksperanto::Export::Base
   
   # TODO: currently exports to one camera
   def end_tracker_segment
-    2.times { @io.write(LINEBREAK) }
+    2.times { @io.write(linebreak) }
     @io.write(@tracker_name.inspect) # autoquotes
-    @io.write LINEBREAK
+    @io.write linebreak
     @io.write camera_name # For primary/secondary cam in stereo pair
-    @io.write LINEBREAK
+    @io.write linebreak
     @io.write @frame_count
-    @io.write LINEBREAK
+    @io.write linebreak
     
     @tracker_io.rewind
     @io.write(@tracker_io.read) until @tracker_io.eof?
@@ -39,10 +37,15 @@ class Tracksperanto::Export::PFMatchit < Tracksperanto::Export::Base
     @frame_count += 1
     line = KEYFRAME_TEMPLATE % [frame, abs_float_x, abs_float_y, float_residual / 8]
     @tracker_io.write(line)
+    @tracker_io.write(linebreak)
   end
   
   private
   
+  def linebreak
+    "\n"
+  end
+  
   def camera_name
     "1"
   end

data/lib/export/pftrack_5.rb

@@ -14,4 +14,9 @@ class Tracksperanto::Export::PFTrack5 < Tracksperanto::Export::PFMatchit
     def camera_name
       "Primary".inspect
     end
+    
+    # PFT5 wants CRLF
+    def linebreak
+      "\r\n"
+    end
 end

data/lib/import/base.rb

@@ -2,7 +2,7 @@
 # this class the inherited class will be included in the list of supported
 # Tracksperanto importers. The API that an importer should present is very
 # basic, and consists only of a few methods. The main method is
-# stream_parse(io)
+# `each`.
 class Tracksperanto::Import::Base
   include Enumerable
   include Tracksperanto::Safety

data/lib/import/flame_stabilizer.rb

@@ -14,6 +14,10 @@ class Tracksperanto::Import::FlameStabilizer < Tracksperanto::Import::Base
     "Flame .stabilizer file"
   end
   
+  class Key
+    attr_accessor :at, :value, :extrap, :interp, :left_tangent, :right_tangent
+  end
+  
   class ChannelBlock < Array
     include ::Tracksperanto::Casts
     cast_to_string :name

data/lib/import/shake_script.rb

@@ -13,13 +13,13 @@ class Tracksperanto::Import::ShakeScript < Tracksperanto::Import::Base
   
   def each
     progress_proc = lambda{|msg| report_progress(msg) }
-    Traxtractor.new(@io, [Proc.new, progress_proc])
+    TrackExtractor.new(@io, [Proc.new, progress_proc])
   end
   
   private
   
   # Extractor. Here we define copies of Shake's standard node creation functions.
-  class Traxtractor < Tracksperanto::ShakeGrammar::Catcher
+  class TrackExtractor < Tracksperanto::ShakeGrammar::Catcher
     include Tracksperanto::ZipTuples
     
     # Normally, we wouldn't need to look for the variable name from inside of the funcall. However,

data/lib/pipeline/base.rb

@@ -1,17 +1,35 @@
-# The base pipeline is the whole process of track conversion from start to finish. The pipeline object organizes the import formats, scans them,
-# applies the default middlewares and yields them for processing. Here's how a calling sequence for a pipeline looks like:
-#
-#   pipe = Tracksperanto::Pipeline::Base.new
-#   pipe.progress_block = lambda{|percent, msg| puts("#{msg}..#{percent.to_i}%") }
-#   
-#   pipe.run("/tmp/shakescript.shk", :width => 720, :height => 576) do | *all_middlewares |
-#     # configure middlewares here
-#   end
-#
-# The pipeline will also automatically allocate output files with the right extensions
-# at the same place where the original file resides,
-# and setup outputs for all supported export formats.
-class Tracksperanto::Pipeline::Base
+module Tracksperanto::Pipeline
+
+  class EmptySourceFileError < RuntimeError
+    def message;  "This is an empty source file"; end
+  end
+  
+  class UnknownFormatError < RuntimeError
+    def message; "Unknown input format"; end
+  end
+  
+  class DimensionsRequiredError < RuntimeError
+    def message; "Width and height must be provided for this importer"; end
+  end
+  
+  class NoTrackersRecoveredError < RuntimeError
+    def message; "Could not recover any non-empty trackers from this file. Wrong import format maybe?"; end
+  end
+  
+  
+  # The base pipeline is the whole process of track conversion from start to finish. The pipeline object organizes the import formats, scans them,
+  # applies the middlewares. Here's how a calling sequence for a pipeline looks like:
+  #
+  #   pipe = Tracksperanto::Pipeline::Base.new
+  #   pipe.middleware_tuples = ["Golden", {:enabled => true}]
+  #   pipe.progress_block = lambda{|percent, msg| puts("#{msg}..#{percent.to_i}%") }
+  #   pipe.run("/tmp/shakescript.shk", :width => 720, :height => 576)
+  #
+  # The pipeline will also automatically allocate output files with the right extensions
+  # at the same place where the original file resides,
+  # and setup outputs for all supported export formats.
+  class Base
+  
   EXTENSION = /\.([^\.]+)$/ #:nodoc:
   PERMITTED_OPTIONS = [:importer, :width, :height]
   
@@ -36,6 +54,12 @@ class Tracksperanto::Pipeline::Base
   # Contains arrays of the form ["MiddewareName", {:param => value}]
   attr_accessor :middleware_tuples
   
+  
+  def initialize(*any)
+    super
+    @ios = []
+  end
+  
   def wrap_output_with_middlewares(output)
     return output unless (middleware_tuples && middleware_tuples.any?)
     
@@ -57,7 +81,7 @@ class Tracksperanto::Pipeline::Base
     importer = initialize_importer_with_path_and_options(from_input_file_path, passed_options)
     
     # Check for empty files
-    raise "This is an empty source file" if File.stat(from_input_file_path).size.zero?
+    raise EmptySourceFileError if File.stat(from_input_file_path).size.zero?
     
     # Open the file
     read_data = File.open(from_input_file_path, "rb")
@@ -89,12 +113,12 @@ class Tracksperanto::Pipeline::Base
       require_dimensions_in!(options)
       d.importer_klass.new(:width => options[:width], :height => options[:height])
     else
-      raise "Unknown input format"
+      raise UnknownFormatError
     end
   end
   
   def require_dimensions_in!(opts)
-    raise "Width and height must be provided for this importer" unless (opts[:width] && opts[:height])
+    raise DimensionsRequiredError unless (opts[:width] && opts[:height])
   end
   
   # Runs the export and returns the number of points and keyframes processed.
@@ -114,22 +138,22 @@ class Tracksperanto::Pipeline::Base
     io_with_progress = Tracksperanto::ProgressiveIO.new(tracker_data_io) do | offset, of_total |
       percent_complete = (50.0 / of_total) * offset
     end
-    @ios << io_with_progress
+    @ios.push(io_with_progress)
     
     @accumulator = Tracksperanto::Accumulator.new
-    importer.io = io_with_progress
-    importer.each {|t| @accumulator.push(t) }
     
-    # OBSOLETE - for this version we are going to permit it
+    # OBSOLETE - for this version we are going to permit it.
     if importer.respond_to?(:stream_parse)
+      STDERR.puts "Import::Base#stream_parse(io) is obsolete, please rewrite your importer to use each instead"
       importer.receiver = @accumulator
       importer.stream_parse(io_with_progress)
+    else
+      importer.io = io_with_progress
+      importer.each {|t| @accumulator.push(t) }
     end
     
     report_progress(percent_complete = 50.0, "Validating #{@accumulator.size} imported trackers")
-    if @accumulator.size.zero?
-      raise "Could not recover any non-empty trackers from this file. Wrong import format maybe?"
-    end
+    raise NoTrackersRecoveredError if @accumulator.size.zero?
     
     report_progress(percent_complete, "Starting export")
     
@@ -162,8 +186,7 @@ class Tracksperanto::Pipeline::Base
   ensure
     @accumulator.clear
     @ios.map!{|e| e.close! rescue e.close }
-    @ios = []
-    @accumulator = nil
+    @ios.clear
   end
   
   # Setup output files and return a single output
@@ -181,7 +204,7 @@ class Tracksperanto::Pipeline::Base
   
   # Open the file for writing and register it to be closed automatically
   def open_owned_export_file(path_to_file)
-    @ios ||= []
     @ios.push(File.open(path_to_file, "wb"))[-1]
   end
+end
 end

data/lib/tracksperanto.rb

@@ -5,7 +5,7 @@ require 'tempfile'
 
 module Tracksperanto
   PATH = File.expand_path(File.dirname(__FILE__))
-  VERSION = '2.2.0'
+  VERSION = '2.2.2'
   
   module Import; end
   module Export; end

data/lib/tracksperanto/accumulator.rb

@@ -1,18 +1,16 @@
 # An accumulator buffer for Ruby objects. Use it to sequentially store a shitload
 # of objects on disk and then retreive them one by one. Make sure to call clear when done
-# with it to discard the stored blob.
-#
-# This object is intended to be used as a Tracksperanto::Import::Base#receiver, but can be used
-# in general like a disk-based object buffer.
+# with it to discard the stored blob. It can be used like a disk-based object buffer.
+# (Tracksperanto stores parsed trackers into it)
 #
 #  a = Tracksperanto::Accumulator.new
 #  parse_big_file do | one_node |
 #    a.push(one_node)
 #  end
 #
-#  a.size #=> 30932
+#  a.size #=> 30932 # We've stored 30 thousand objects on disk without breaking a sweat
 #  a.each do | node_read_from_disk |
-#     # do something with node
+#     # do something with node that has been recovered from disk
 #  end
 #
 #  a.clear # ensure that the file is deleted
@@ -24,6 +22,7 @@ class Tracksperanto::Accumulator
   
   def initialize
     @store = Tracksperanto::BufferIO.new
+    
     @size = 0
     @byte_size = 0
     
@@ -33,15 +32,19 @@ class Tracksperanto::Accumulator
   # Store an object
   def push(object_to_store)
     @store.seek(@byte_size)
+    
     blob = marshal_object(object_to_store)
     @store.write(blob)
     @size += 1
     @byte_size = @byte_size + blob.size
+    
     object_to_store
   end
   
+  alias_method :<<, :push
+  
   # Retreive each stored object in succession. All other Enumerable
-  # methods are also available (but be careful with Enumerable#map)
+  # methods are also available (but be careful with Enumerable#map and to_a)
   def each
     @store.rewind
     @size.times { yield(recover_object) }
@@ -51,6 +54,7 @@ class Tracksperanto::Accumulator
   def clear
     @store.close!
     @size = 0
+    @offsets = []
   end
   
   private

data/test/export/samples/ref_PFMatchit.2dt

@@ -1,54 +1,54 @@
-
-
-"Parabolic_1_from_top_left"
-1
-19
-0 0.000 1080.000 0.000
-1 96.000 874.800 0.006
-2 192.000 691.200 0.012
-3 288.000 529.200 0.018
-4 384.000 388.800 0.024
-5 480.000 270.000 0.030
-6 576.000 172.800 0.036
-7 672.000 97.200 0.042
-8 768.000 43.200 0.048
-9 864.000 10.800 0.054
-12 1152.000 43.200 0.071
-13 1248.000 97.200 0.077
-14 1344.000 172.800 0.083
-15 1440.000 270.000 0.089
-16 1536.000 388.800 0.095
-17 1632.000 529.200 0.101
-18 1728.000 691.200 0.107
-19 1824.000 874.800 0.113
-20 1920.000 1080.000 0.119
-
-
-"Parabolic_2_from_bottom_right"
-1
-19
-0 1920.000 0.000 0.000
-1 1824.000 205.200 0.006
-2 1728.000 388.800 0.012
-3 1632.000 550.800 0.018
-4 1536.000 691.200 0.024
-5 1440.000 810.000 0.030
-6 1344.000 907.200 0.036
-7 1248.000 982.800 0.042
-8 1152.000 1036.800 0.048
-9 1056.000 1069.200 0.054
-12 768.000 1036.800 0.071
-13 672.000 982.800 0.077
-14 576.000 907.200 0.083
-15 480.000 810.000 0.089
-16 384.000 691.200 0.095
-17 288.000 550.800 0.101
-18 192.000 388.800 0.107
-19 96.000 205.200 0.113
-20 0.000 0.000 0.119
-
-
-"SingleFrame"
-1
-1
-0 970.000 550.000 0.000
+
+
+"Parabolic_1_from_top_left"
+1
+19
+0 0.000 1080.000 0.000
+1 96.000 874.800 0.006
+2 192.000 691.200 0.012
+3 288.000 529.200 0.018
+4 384.000 388.800 0.024
+5 480.000 270.000 0.030
+6 576.000 172.800 0.036
+7 672.000 97.200 0.042
+8 768.000 43.200 0.048
+9 864.000 10.800 0.054
+12 1152.000 43.200 0.071
+13 1248.000 97.200 0.077
+14 1344.000 172.800 0.083
+15 1440.000 270.000 0.089
+16 1536.000 388.800 0.095
+17 1632.000 529.200 0.101
+18 1728.000 691.200 0.107
+19 1824.000 874.800 0.113
+20 1920.000 1080.000 0.119
+
+
+"Parabolic_2_from_bottom_right"
+1
+19
+0 1920.000 0.000 0.000
+1 1824.000 205.200 0.006
+2 1728.000 388.800 0.012
+3 1632.000 550.800 0.018
+4 1536.000 691.200 0.024
+5 1440.000 810.000 0.030
+6 1344.000 907.200 0.036
+7 1248.000 982.800 0.042
+8 1152.000 1036.800 0.048
+9 1056.000 1069.200 0.054
+12 768.000 1036.800 0.071
+13 672.000 982.800 0.077
+14 576.000 907.200 0.083
+15 480.000 810.000 0.089
+16 384.000 691.200 0.095
+17 288.000 550.800 0.101
+18 192.000 388.800 0.107
+19 96.000 205.200 0.113
+20 0.000 0.000 0.119
+
+
+"SingleFrame"
+1
+1
+0 970.000 550.000 0.000

data/test/export/test_pfmatchit_export.rb

@@ -3,12 +3,9 @@ require File.expand_path(File.dirname(__FILE__)) + '/../helper'
 class PFMatchitExportTest < Test::Unit::TestCase
   include ParabolicTracks
   
-  def test_human_name
-    assert_equal "PFMatchit .2dt file (single camera)", Tracksperanto::Export::PFMatchit.human_name
-  end
-  
   def test_desc_and_ext
-    assert_equal "pfmatchit.2dt", Tracksperanto::Export::PFMatchit.desc_and_extension
+    assert_equal "PFMatchit user track export file (single camera)", Tracksperanto::Export::PFMatchit.human_name
+    assert_equal "pfmatchit.txt", Tracksperanto::Export::PFMatchit.desc_and_extension
   end
   
   P = File.dirname(__FILE__) + "/samples/ref_PFMatchit.2dt"

data/test/test_cli.rb

@@ -49,7 +49,7 @@ class CliTest < Test::Unit::TestCase
     assert_equal 0, status, "Should exit with a normal status"
     fs = %w(. .. 
       flm.stabilizer flm_3de_v3.txt flm_3de_v4.txt flm_boujou_text.txt flm_flame.stabilizer 
-      flm_matchmover.rz2 flm_mayalive.txt flm_nuke.nk flm_pfmatchit.2dt flm_pftrack_v4.2dt
+      flm_matchmover.rz2 flm_mayalive.txt flm_nuke.nk flm_pfmatchit.txt flm_pftrack_v4.2dt
       flm_pftrack_v5.2dt flm_shake_trackers.txt flm_syntheyes_2dt.txt
     )
     

data/test/test_pipeline.rb

@@ -47,7 +47,7 @@ class PipelineTest < Test::Unit::TestCase
     empty_file_path = "./input_empty.stabilizer"
     f = File.open(empty_file_path, "w"){|f| f.write('') }
     pipeline = Tracksperanto::Pipeline::Base.new
-    assert_raise(RuntimeError) { pipeline.run(empty_file_path) }
+    assert_raise(Tracksperanto::Pipeline::EmptySourceFileError) { pipeline.run(empty_file_path) }
   end
   
   def test_middleware_initialization_from_tuples
@@ -72,7 +72,7 @@ class PipelineTest < Test::Unit::TestCase
   def test_run_with_autodetected_importer_that_requires_size
     FileUtils.cp("./import/samples/shake_script/four_tracks_in_one_stabilizer.shk", "./input.shk")
     pipeline = Tracksperanto::Pipeline::Base.new
-    assert_raise(RuntimeError) { pipeline.run("./input.shk") }
+    assert_raise(Tracksperanto::Pipeline::DimensionsRequiredError) { pipeline.run("./input.shk") }
   end
   
   def test_run_with_autodetected_importer_that_requires_size_when_size_supplied
@@ -97,15 +97,15 @@ class PipelineTest < Test::Unit::TestCase
   def test_run_with_unknown_format_raises
     FileUtils.touch("./input.txt")
     pipeline = Tracksperanto::Pipeline::Base.new
-    assert_raise(RuntimeError) { pipeline.run("./input.txt") }
-    assert_raise(RuntimeError) { pipeline.run("./input.txt", :width => 100, :height => 100) }
-    assert_raise(RuntimeError) { pipeline.run("./input.txt", :importer => "Syntheyes") }
+    assert_raise(Tracksperanto::Pipeline::UnknownFormatError) { pipeline.run("./input.txt") }
+    assert_raise(Tracksperanto::Pipeline::UnknownFormatError) { pipeline.run("./input.txt", :width => 100, :height => 100) }
+    assert_raise(Tracksperanto::Pipeline::DimensionsRequiredError) { pipeline.run("./input.txt", :importer => "Syntheyes") }
   end
   
   def test_run_with_overridden_importer_and_size
     FileUtils.cp("./import/samples/3de_v4/3de_export_cube.txt", "./input.txt")
     pipeline = Tracksperanto::Pipeline::Base.new
-    assert_raise(RuntimeError) { pipeline.run("./input.txt", :importer => "Equalizer4") }
+    assert_raise(Tracksperanto::Pipeline::DimensionsRequiredError) { pipeline.run("./input.txt", :importer => "Equalizer4") }
     assert_nothing_raised { pipeline.run("./input.txt", :importer => "Equalizer4", :width => 720, :height => 576) }
   end
   

data/test/test_progressive_io.rb

@@ -43,7 +43,11 @@ class TestProgressiveIO < Test::Unit::TestCase
     io.progress_block = lambda do | offset, total |
       assert_equal [1, 3], [offset, total]
     end
-    assert_equal 49, io.getc
+    if RUBY_VERSION < "1.9"
+      assert_equal 49, io.getc
+    else
+      assert_equal "1", io.getc
+    end
   end
   
   def test_gets
@@ -67,7 +71,12 @@ class TestProgressiveIO < Test::Unit::TestCase
     io.progress_block = lambda do | offset, total |
       assert_equal [1, 3], [offset, total]
     end
-    assert_equal 49, io.readchar
+    
+    if RUBY_VERSION < "1.9"
+      assert_equal 49, io.getc
+    else
+      assert_equal "1", io.getc
+    end
   end
   
   def test_readline

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tracksperanto
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 2
   - 2
-  - 0
-  version: 2.2.0
+  - 2
+  version: 2.2.2
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +01:00
+date: 2011-04-02 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency