tracksperanto 2.6.1 → 2.6.2

data/History.txt

@@ -1,3 +1,7 @@
+=== 2.6.2 / 2011-30-07
+
+* Fix missing progress percentages in the Flame import module
+
 === 2.6.1 / 2011-22-07
 
 * Fix errors that occurred when empty disabled trackers were present in Flame setups 

data/Manifest.txt

@@ -94,6 +94,7 @@ test/export/test_pftrack5_export.rb
 test/export/test_pftrack_export.rb
 test/export/test_shake_export.rb
 test/export/test_syntheyes_export.rb
+test/fixtures/processing_log.txt
 test/helper.rb
 test/import/samples/3de_v3/3de_export_v3.txt
 test/import/samples/3de_v4/3de_export_cube.txt

data/bin/tracksperanto

@@ -94,6 +94,7 @@ op.on("--version", "Show the version and exit") do |v|
     UpdateHints.version_check("tracksperanto", Tracksperanto::VERSION, STDOUT)
     exit(0)
 end
+op.on("--trace", "Output LOTS of info during conversion") { $debug = true }
 
 begin
   op.parse!
@@ -114,7 +115,14 @@ unless File.exist?(input_file)
 end
 
 pbar = ProgressBar.new("Converting", 100, $stdout)
-progress = lambda{|percent,message| pbar.set(percent) }
+progress = lambda do |percent,message| 
+  pbar.set(percent)
+  if $debug
+    STDOUT.puts("[%d -> %s]" % [percent, message])
+    STDOUT.flush
+  end
+end
+
 begin
   pipe = Tracksperanto::Pipeline::Base.new(:progress_block => progress, :middleware_tuples => $middlewares)
   pipe.exporters = [Tracksperanto.get_exporter(writer_class_name)] if writer_class_name

data/lib/import/flame_stabilizer.rb

@@ -23,8 +23,6 @@ class Tracksperanto::Import::FlameStabilizer < Tracksperanto::Import::Base
     
     report_progress("Assembling tracker curves from channels")
     scavenge_trackers_from_channels(channels, names) {|t| yield(t) }
-  ensure
-    channels.clear
   end
   
   private
@@ -46,28 +44,31 @@ class Tracksperanto::Import::FlameStabilizer < Tracksperanto::Import::Base
       end
       
     end
-
-    def extract_channels_from_stream(io)
-      channels = FlameChannelParser.parse(io)
-      [channels, channels.map{|c| c.path }]
-    end
     
-    USEFUL_CHANNELS = %w( /shift/x /shift/y /ref/x /ref/y ).map(&Regexp.method(:new))
-    
-    # This method tells the importer whether a channel that has been found in the source
-    # setup is needed. If that method returns ++false++ the channel will be discarded and not
-    # kept in memory. Should you need to write a module that scavenges other Flame animation channels
-    # inherit from this class and rewrite this method to either return +true+ always (then all the channels
-    # will be recovered) or to return +true+ only for channels that you actually need.
-    def channel_is_useful?(channel_name)
-      USEFUL_CHANNELS.any?{|e| channel_name =~ e }
+    # We subclass the standard parser for a couple of reasons - we want to only parse the needed channels
+    # AND we want to provide progress reports
+    class StabilizerParser < FlameChannelParser::Parser
+      USEFUL_CHANNELS = %w( /shift/x /shift/y /ref/x /ref/y ).map(&Regexp.method(:new))
+      
+      # This method tells the importer whether a channel that has been found in the source
+      # setup is needed. If that method returns ++false++ the channel will be discarded and not
+      # kept in memory. Should you need to write a module that scavenges other Flame animation channels
+      # inherit from this class and rewrite this method to either return +true+ always (then all the channels
+      # will be recovered) or to return +true+ only for channels that you actually need.
+      def channel_is_useful?(channel_name)
+        USEFUL_CHANNELS.any?{|e| channel_name =~ e }
+      end
     end
     
-    REF_CHANNEL = "ref" # or "track" - sometimes works sometimes don't
+    def extract_channels_from_stream(io)
+      parser = StabilizerParser.new(&method(:report_progress))
+      channels = parser.parse(io)
+      [channels, channels.map{|c| c.path }]
+    end
     
     def scavenge_trackers_from_channels(channels, names)
       channels.each do |c|
-        next unless c.name =~ /\/#{REF_CHANNEL}\/x/
+        next unless c.name =~ /\/ref\/x/
         
         report_progress("Detected reference channel #{c.name}")
         
@@ -87,7 +88,7 @@ class Tracksperanto::Import::FlameStabilizer < Tracksperanto::Import::Base
       
       # This takes a LONG time when we have alot of channels, we need a precache of
       # some sort to do this
-      ref_idx = names.index("#{t.name}/#{REF_CHANNEL}/y")
+      ref_idx = names.index("#{t.name}/ref/y")
       shift_x_idx = names.index("#{t.name}/shift/x")
       shift_y_idx = names.index("#{t.name}/shift/y")
       

data/lib/import/shake_grammar/lexer.rb

@@ -1,5 +1,5 @@
 module Tracksperanto::ShakeGrammar
-  class WrongInput < RuntimeError; end
+  class WrongInputError < RuntimeError; end
   
   # Since Shake uses a C-like language for it's scripts we rig up a very sloppy
   # but concise C-like lexer to cope
@@ -41,11 +41,11 @@ module Tracksperanto::ShakeGrammar
       c = @io.read(1)
       
       if @buf.length > MAX_BUFFER_SIZE # Wrong format and the buffer is filled up, bail
-        raise WrongInput, "Atom buffer overflow at #{MAX_BUFFER_SIZE} bytes, this is definitely not a Shake script"
+        raise WrongInputError, "Atom buffer overflow at #{MAX_BUFFER_SIZE} bytes, this is definitely not a Shake script"
       end
       
       if @stack_depth > MAX_STACK_DEPTH # Wrong format - parentheses overload
-        raise WrongInput, "Stack overflow at level #{MAX_STACK_DEPTH}, this is probably a LISP program uploaded by accident"
+        raise WrongInputError, "Stack overflow at level #{MAX_STACK_DEPTH}, this is probably a LISP program uploaded by accident"
       end
       
       if c == '/' && (@buf[-1].chr rescue nil) == '/' # Comment start

data/lib/pipeline/base.rb

@@ -132,21 +132,33 @@ module Tracksperanto::Pipeline
   # status message that you can pass back to the UI
   def run_export(tracker_data_io, importer, exporter)
     points, keyframes, percent_complete = 0, 0, 0.0
+    last_reported_percentage = 0.0
     
     report_progress(percent_complete, "Starting the parser")
+    progress_lambda = lambda do | m | 
+      last_reported_percentage = percent_complete
+      report_progress(percent_complete, m)
+    end
     
     # Report progress from the parser
-    importer.progress_block = lambda { | m | report_progress(percent_complete, m) }
+    importer.progress_block = progress_lambda
     
     # Wrap the input in a progressive IO, 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 = Tracksperanto::ProgressiveIO.new(tracker_data_io) do | offset, of_total |
       percent_complete = (50.0 / of_total) * offset
+      
+      # Some importers do not signal where they are and do not send nice reports. The way we can help that in the interim
+      # would be just to indicate where we are in the input, but outside of the exporter. We do not want to flood
+      # the logs though so what we WILL do instead is report some progress going on every 2-3 percent
+      progress_lambda.call("Parsing the file") if (percent_complete - last_reported_percentage) > 3
     end
+    
     @ios.push(io_with_progress)
     
     @accumulator = Tracksperanto::Accumulator.new
+    
     begin
     
       # OBSOLETE - for this version we are going to permit it.

data/lib/tracksperanto.rb

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

data/test/fixtures/processing_log.txt

@@ -0,0 +1,50 @@
+0 -> Starting the parser
+0 -> Extracting setup size
+0 -> Extracting all animation channels
+3 -> Parsing the file
+6 -> Parsing the file
+9 -> Parsing the file
+13 -> Parsing the file
+16 -> Parsing the file
+19 -> Parsing the file
+22 -> Parsing the file
+25 -> Parsing the file
+28 -> Parsing the file
+31 -> Parsing the file
+34 -> Parsing the file
+37 -> Parsing the file
+40 -> Parsing the file
+43 -> Parsing the file
+46 -> Parsing the file
+49 -> Parsing the file
+50 -> Assembling tracker curves from channels
+50 -> Detected reference channel tracker1/ref/x
+50 -> Extracting tracker tracker1
+50 -> Detecting base value
+50 -> Extracting keyframe 2 of tracker1
+50 -> Extracting keyframe 3 of tracker1
+50 -> Extracting keyframe 4 of tracker1
+50 -> Detected reference channel tracker2/ref/x
+50 -> Extracting tracker tracker2
+50 -> Detecting base value
+50 -> Extracting keyframe 2 of tracker2
+50 -> Extracting keyframe 3 of tracker2
+50 -> Extracting keyframe 4 of tracker2
+50 -> Detected reference channel tracker3/ref/x
+50 -> Extracting tracker tracker3
+50 -> Detecting base value
+50 -> Extracting keyframe 2 of tracker3
+50 -> Extracting keyframe 3 of tracker3
+50 -> Extracting keyframe 4 of tracker3
+50 -> Validating 3 imported trackers
+50 -> Starting export
+55 -> Writing keyframe 1 of "tracker1", 3 trackers to go
+61 -> Writing keyframe 2 of "tracker1", 3 trackers to go
+66 -> Writing keyframe 3 of "tracker1", 3 trackers to go
+72 -> Writing keyframe 1 of "tracker2", 2 trackers to go
+77 -> Writing keyframe 2 of "tracker2", 2 trackers to go
+83 -> Writing keyframe 3 of "tracker2", 2 trackers to go
+88 -> Writing keyframe 1 of "tracker3", 1 trackers to go
+94 -> Writing keyframe 2 of "tracker3", 1 trackers to go
+100 -> Writing keyframe 3 of "tracker3", 1 trackers to go
+100 -> Wrote 3 points and 9 keyframes

data/test/import/test_flame_import.rb

@@ -87,7 +87,7 @@ class FlameImportTest < Test::Unit::TestCase
   end
   
   # a failing setup from flame 2012
-  def test_from_flame2012
+  def test_from_flame2012_with_empty_trackers
     fixture = File.open(File.dirname(__FILE__) + '/samples/flame_stabilizer/flame_2012_another.stabilizer')
     trackers = Tracksperanto::Import::FlameStabilizer.new(:io => fixture).to_a
     assert_equal 1, trackers.length

data/test/import/test_shake_lexer.rb

@@ -7,14 +7,14 @@ class ShakeLexerTest < Test::Unit::TestCase
   WRONG = File.dirname(__FILE__) + "/samples/flame_stabilizer/hugeFlameSetup.stabilizer"
   
   def test_raises_wrong_input_when_buffer_gets_too_large
-    assert_raise(Tracksperanto::ShakeGrammar::WrongInput) do
+    assert_raise(Tracksperanto::ShakeGrammar::WrongInputError) do
        parse(File.open(WRONG), L)
     end
   end
   
   def test_raises_wrong_input_on_stack_size
     huge_stack = "(" * 345
-    assert_raise(Tracksperanto::ShakeGrammar::WrongInput) do
+    assert_raise(Tracksperanto::ShakeGrammar::WrongInputError) do
        parse(StringIO.new(huge_stack), L)
     end
   end

data/test/test_cli.rb

@@ -65,6 +65,12 @@ class CliTest < Test::Unit::TestCase
     assert_same_set fs, Dir.entries(TEMP_DIR)
   end
   
+  # TODO: This currently hangs in testing
+  # def test_cli_with_trace_option
+  #   FileUtils.cp(File.dirname(__FILE__) + "/import/samples/flame_stabilizer/fromCombustion_fromMidClip_wSnap.stabilizer", TEMP_DIR + "/flm.stabilizer")
+  #   status, o, e = cli("#{BIN_P} --trace #{TEMP_DIR}/flm.stabilizer")
+  # end
+  
   def test_cli_reformat
     FileUtils.cp(File.dirname(__FILE__) + "/import/samples/flame_stabilizer/fromCombustion_fromMidClip_wSnap.stabilizer", TEMP_DIR + "/flm.stabilizer")
     cli("--reformat-x 1204 --reformat-y 340 --only flamestabilizer #{TEMP_DIR}/flm.stabilizer")

data/test/test_pipeline.rb

@@ -35,7 +35,7 @@ class PipelineTest < Test::Unit::TestCase
     assert_equal [:a, :b], pipeline.middleware_tuples
   end
   
-  def test_run_with_autodetected_importer_and_size
+  def test_run_with_autodetected_importer_and_size_without_progress_block
     create_stabilizer_file
     pipeline = Tracksperanto::Pipeline::Base.new
     assert_nothing_raised { pipeline.run(@stabilizer) }
@@ -43,6 +43,19 @@ class PipelineTest < Test::Unit::TestCase
     assert_equal 9, pipeline.converted_keyframes, "Should report conversion of 9 keyframes"
   end
   
+  def test_run_with_autodetected_importer_and_size_with_progress_block
+    create_stabilizer_file
+    processing_log = ""
+    accum = lambda do | percent, message |
+      processing_log << ("%d -> %s\n" % [percent, message])
+    end
+    
+    pipeline = Tracksperanto::Pipeline::Base.new(:progress_block => accum)
+    assert_nothing_raised { pipeline.run(@stabilizer) }
+    reference = File.read(File.dirname(__FILE__) + "/fixtures/processing_log.txt")
+    assert_equal reference, processing_log, "The log output should be the same"
+  end
+  
   def test_run_crashes_with_empty_file
     empty_file_path = "./input_empty.stabilizer"
     f = File.open(empty_file_path, "w"){|f| f.write('') }

metadata

@@ -2,7 +2,7 @@
 name: tracksperanto
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.6.1
+  version: 2.6.2
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-22 00:00:00 Z
+date: 2011-07-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: flame_channel_parser
@@ -188,6 +188,7 @@ files:
 - test/export/test_pftrack_export.rb
 - test/export/test_shake_export.rb
 - test/export/test_syntheyes_export.rb
+- test/fixtures/processing_log.txt
 - test/helper.rb
 - test/import/samples/3de_v3/3de_export_v3.txt
 - test/import/samples/3de_v4/3de_export_cube.txt