tracksperanto 1.7.4 → 1.7.5

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.7.5 / 2010-02-17
+
+* Use a special IO so that we can display progress when parsing/reading a file (based on the IO offset)
+
 === 1.7.4 / 2010-02-02
 
 * Introduce an intentional gap in the reference exports to test trackers with gaps

data/Manifest.txt

@@ -46,6 +46,7 @@ lib/tracksperanto/const_name.rb
 lib/tracksperanto/ext_io.rb
 lib/tracksperanto/format_detector.rb
 lib/tracksperanto/keyframe.rb
+lib/tracksperanto/progressive_io.rb
 lib/tracksperanto/safety.rb
 lib/tracksperanto/simple_export.rb
 lib/tracksperanto/tracker.rb
@@ -129,6 +130,7 @@ test/test_const_name.rb
 test/test_extio.rb
 test/test_format_detector.rb
 test/test_keyframe.rb
+test/test_progressive_io.rb
 test/test_simple_export.rb
 test/test_tracker.rb
 test/test_tracksperanto.rb

data/bin/tracksperanto

@@ -92,7 +92,6 @@ end
 input_file = ARGV.pop
 if !input_file
   STDERR.puts "No input file provided - should be the last argument"
-  puts parser
   exit(-1)
 end
 
@@ -100,20 +99,26 @@ class Spinner
   RING = ['|', '/', '-', '\\', '|', '/', '-', '\\']
   
   def initialize
-    @counter = 0
-    @last_message_length = 0
+    @counter, @last_len = 0, 0
   end
   
   def spin(percent, msg)
     current = RING[(@counter += 1) % RING.length]
     output = " [%s %d%%]" % [current, percent]
-    STDOUT.write(output + "\r" * output.length)
+    STDOUT.write(output + ("\r" * output.length))
     STDOUT.flush
+    @last_len = output.length
+  end
+  
+  def finish(with_message = '')
+    STDOUT.write("\r" * @last_len.to_i)
+    STDOUT.flush
+    STDOUT.puts(with_message)
   end
 end
 
-pipe = Tracksperanto::Pipeline::Base.new
-pipe.progress_block = Spinner.new.method(:spin).to_proc
+spinner = Spinner.new
+pipe = Tracksperanto::Pipeline::Base.new(:progress_block => spinner.method(:spin).to_proc)
 
 if sole_format
   begin
@@ -137,4 +142,5 @@ pipe.run(input_file, :pix_w => width, :pix_h => height, :parser => reader_klass)
   lerpm.enabled = lerp
   len.min_length = length_gate
 end
-STDOUT.puts("\rConverted #{pipe.converted_points} trackers with #{pipe.converted_keyframes} keys")
+
+spinner.finish("Converted #{pipe.converted_points} trackers with #{pipe.converted_keyframes} keys")

data/lib/export/syntheyes.rb

@@ -25,7 +25,7 @@ class Tracksperanto::Export::SynthEyes < Tracksperanto::Export::Base
   end
   
   def start_tracker_segment(tracker_name)
-    @last_f, @tracker_name = nil, tracker_name
+    @last_registered_frame, @tracker_name = nil, tracker_name
   end
   
   def export_point(frame, abs_float_x, abs_float_y, float_residual)
@@ -38,14 +38,14 @@ class Tracksperanto::Export::SynthEyes < Tracksperanto::Export::Base
     # It's very important that we provide an outcome code for Syntheyes. Regular keyframes get
     # STATUS_STD, and after a gap we have to signal STATUS_REENABLE, otherwise this might bust solves
     def get_outcome_code(frame)
-      outcome = if @last_f.nil?
+      outcome = if @last_registered_frame.nil?
         STATUS_KF
-      elsif @last_f && (@last_f != frame -1)
+      elsif @last_registered_frame != (frame - 1)
         STATUS_REENABLE
       else
         STATUS_STD
       end
-      @last_f = frame
+      @last_registered_frame = frame
       outcome
     end
 end

data/lib/import/shake_grammar/lexer.rb

@@ -12,6 +12,8 @@ module Tracksperanto::ShakeGrammar
     attr_reader :sentinel
     
     STOP_TOKEN = :__stop #:nodoc:
+    MAX_BUFFER_SIZE = 32000
+    MAX_STACK_DEPTH = 127
     
     # The first argument is the IO handle to the data of the Shake script.
     # The second argument is a "sentinel" that is going to be passed
@@ -42,11 +44,11 @@ module Tracksperanto::ShakeGrammar
       
       c = @io.read(1)
       
-      if @buf.length > 32000 # Wrong format and the buffer is filled up, bail
+      if @buf.length > MAX_BUFFER_SIZE # Wrong format and the buffer is filled up, bail
         raise WrongInput, "Buffer overflow at 32K, this is definitely not a Shake script"
       end
       
-      if @stack_depth > 127 # Wrong format - parentheses overload
+      if @stack_depth > MAX_STACK_DEPTH # Wrong format - parentheses overload
         raise WrongInput, "Stack overflow at level 128, this is probably a LISP program uploaded by accident"
       end
       

data/lib/pipeline/base.rb

@@ -13,6 +13,8 @@
 # and setup outputs for all supported export formats.
 class Tracksperanto::Pipeline::Base
   
+  include Tracksperanto::BlockInit
+  
   # How many points have been converted. In general, the pipeline does not preserve the parsed tracker objects
   # after they have been exported
   attr_reader :converted_points
@@ -83,16 +85,27 @@ class Tracksperanto::Pipeline::Base
   # If a block is passed, the block will receive the percent complete and the last
   # status message that you can pass back to the UI
   def run_export(tracker_data_io, parser, processor)
-    @ios << tracker_data_io
-    
     points, keyframes, percent_complete = 0, 0, 0.0
     
     yield(percent_complete, "Starting the parser") if block_given?
+    
+    # Report progress from the parser
     parser.progress_block = lambda do | message |
       yield(percent_complete, message) if block_given?
     end
     
-    trackers = parser.parse(tracker_data_io)
+    # Wrap the input in a progressive IO
+    io_with_progress = Tracksperanto::ProgressiveIO.new(tracker_data_io)
+    @ios << io_with_progress
+    
+    # Setup a lambda that will spy on the reader and update the percentage.
+    # We will only broadcast messages that come from the parser though (complementing it
+    # with a percentage)
+    io_with_progress.progress_block = lambda do | offset, of_total |
+      percent_complete = (50.0 / of_total) * offset
+    end
+    
+    trackers = parser.parse(io_with_progress)
     
     validate_trackers!(trackers)
     

data/lib/tracksperanto.rb

@@ -4,7 +4,7 @@ require 'tempfile'
 
 module Tracksperanto
   PATH = File.expand_path(File.dirname(__FILE__))
-  VERSION = '1.7.4'
+  VERSION = '1.7.5'
   
   module Import; end
   module Export; end
@@ -42,8 +42,7 @@ module Tracksperanto
   # Case-insensitive search for an export module by name
   def self.get_exporter(name)
     exporters.each do | x |
-      normalized_name = x.to_s.split("::")[-1].downcase
-      return x if normalized_name == name.downcase
+      return x if x.const_name.downcase == name.downcase
     end
     
     raise NameError, "Unknown exporter #{name}"
@@ -52,8 +51,7 @@ module Tracksperanto
   # Case-insensitive search for an export module by name
   def self.get_importer(name)
     importers.each do | x |
-      normalized_name = x.to_s.split("::")[-1].downcase
-      return x if normalized_name == name.downcase
+      return x if x.const_name.downcase == name.downcase
     end
     
     raise NameError, "Unknown importer #{name}"
@@ -70,6 +68,7 @@ end
   tracker
   format_detector
   ext_io
+  progressive_io
   simple_export
   uv_coordinates
 ).each do | submodule |

data/lib/tracksperanto/ext_io.rb

@@ -1,17 +1,17 @@
 # Many importers use this as a standard. This works like a wrapper for any
-# IO object with a couple extra methods added
+# IO object with a couple extra methods added.
 class Tracksperanto::ExtIO < DelegateClass(IO)
   def initialize(with)
     __setobj__ with
   end
   
   def gets_and_strip
-    s = __getobj__.gets
+    s = gets
     s ? s.strip : nil
   end
   
   def gets_non_empty
-    line = __getobj__.gets
+    line = gets
     return nil if line.nil?
     s = line.strip
     return gets_non_empty if s.empty?

data/lib/tracksperanto/progressive_io.rb

@@ -0,0 +1,79 @@
+# Used for IO objects that need to report the current offset at each operation that changes the said offset
+# (useful for building progress bars that report on a file read operation)
+class Tracksperanto::ProgressiveIO < DelegateClass(IO)
+  
+  # Should contain a block that accepts the current offset in bytes and the total size
+  attr_accessor :progress_block
+  
+  # Get or set the total size of the contained IO. If the passed IO is a File object 
+  # the size will be preset automatically
+  attr_accessor :total_size
+  
+  def initialize(with_file)
+    __setobj__(with_file)
+    @total_size = with_file.stat.size if with_file.respond_to?(:stat)
+  end
+  
+  def each(sep_string = $/, &blk)
+    # Report offset at each call of the iterator
+    result = super(sep_string) do | line |
+      yield(line)
+      notify_read
+    end
+  end
+  alias_method :each_line, :each
+  
+  def each_byte(&blk)
+    # Report offset at each call of the iterator
+    super { |b| yield(b); notify_read }
+  end
+  
+  def getc
+    returning(super) { notify_read }
+  end
+  
+  def gets
+    returning(super) { notify_read }
+  end
+  
+  def read(*a)
+    returning(super) { notify_read }
+  end
+  
+  def readbytes(*a)
+    returning(super) { notify_read }
+  end
+  
+  def readchar
+    returning(super) { notify_read }
+  end
+  
+  def readline(*a)
+    returning(super) { notify_read }
+  end
+  
+  def readlines(*a)
+    returning(super) { notify_read }
+  end
+  
+  def seek(*a)
+    returning(super) { notify_read }
+  end
+  
+  def ungetc(*a)
+    returning(super) { notify_read }
+  end 
+  
+  def pos=(p)
+    returning(super) { notify_read }
+  end
+  
+  private
+    def returning(r)
+      yield; r
+    end
+    
+    def notify_read
+      @progress_block.call(pos, @total_size) if @progress_block
+    end
+end

data/test/test_progressive_io.rb

@@ -0,0 +1,119 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestProgressiveIO < Test::Unit::TestCase
+  
+  def e(s)
+    
+    # Make a mock File object from a string
+    io = StringIO.new(s)
+     mock_stat = flexmock(:size => s.length)
+     flexmock(io).should_receive(:stat).and_return(mock_stat)
+    
+    Tracksperanto::ProgressiveIO.new(io)
+  end
+  
+  def test_each
+    io, messages = e("Mary\nHad\nA little\nLamb"), []
+    
+    io.progress_block = lambda do | offset, total |
+      messages.push([offset, total])
+    end
+    
+    lines = []
+    io.each {|line|  lines.push(line) }
+    assert_equal ["Mary\n", "Had\n", "A little\n", "Lamb"], lines
+    assert_equal [[5, 22], [9, 22], [18, 22], [22, 22]], messages
+  end
+  
+  def test_each_byte
+    io, messages = e("123"), []
+    
+    io.progress_block = lambda do | offset, total |
+      messages.push([offset, total])
+    end
+    
+    bytes = []
+    io.each_byte{|s| bytes << s }
+    assert_equal [49, 50, 51], bytes
+    assert_equal [[1, 3], [2, 3], [3, 3]], messages
+  end
+  
+  def test_getc
+    io = e("123")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [1, 3], [offset, total]
+    end
+    assert_equal 49, io.getc
+  end
+  
+  def test_gets
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [5, 22], [offset, total]
+    end
+    assert_equal "Mary\n", io.gets
+  end
+  
+  def test_read
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [15, 22], [offset, total]
+    end
+    assert_equal "Mary\nHad\nA litt", io.read(15)
+  end
+  
+  def test_readchar
+    io = e("123")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [1, 3], [offset, total]
+    end
+    assert_equal 49, io.readchar
+  end
+  
+  def test_readline
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [5, 22], [offset, total]
+    end
+    assert_equal "Mary\n", io.readline
+  end
+  
+  def test_readlines
+    io = e("Mary\nHad\nA little\nLamb")
+    m = []
+    io.progress_block = lambda do | offset, total |
+      m.push([offset, total])
+    end
+    
+    assert_equal ["Mary\n", "Had\n", "A little\n", "Lamb"], io.readlines
+    assert_equal [[22, 22]], m
+  end
+  
+  def test_seek
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [6, 22], [offset, total]
+    end
+    io.seek(6)
+  end
+  
+  def test_ungetc
+    io = e("Mary\nHad\nA little\nLamb")
+    m = []
+    io.progress_block = lambda do | offset, total |
+      m.push([offset, total])
+    end
+    
+    io.getc
+    io.ungetc(2)
+    assert_equal [[1, 22], [0, 22]], m
+  end
+  
+  def test_poseq
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [2, 22], [offset, total]
+    end
+    io.pos = 2
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tracksperanto
 version: !ruby/object:Gem::Version 
-  version: 1.7.4
+  version: 1.7.5
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-09 00:00:00 +01:00
+date: 2010-02-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -93,6 +93,7 @@ files:
 - lib/tracksperanto/ext_io.rb
 - lib/tracksperanto/format_detector.rb
 - lib/tracksperanto/keyframe.rb
+- lib/tracksperanto/progressive_io.rb
 - lib/tracksperanto/safety.rb
 - lib/tracksperanto/simple_export.rb
 - lib/tracksperanto/tracker.rb
@@ -176,6 +177,7 @@ files:
 - test/test_extio.rb
 - test/test_format_detector.rb
 - test/test_keyframe.rb
+- test/test_progressive_io.rb
 - test/test_simple_export.rb
 - test/test_tracker.rb
 - test/test_tracksperanto.rb
@@ -244,6 +246,7 @@ test_files:
 - test/test_extio.rb
 - test/test_format_detector.rb
 - test/test_keyframe.rb
+- test/test_progressive_io.rb
 - test/test_simple_export.rb
 - test/test_tracker.rb
 - test/test_tracksperanto.rb