tracksperanto 1.5.1 → 1.5.2

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.5.2 / 2009-10-09
+
+* Fix Windows-specific issue (Tempfile-related) in the Equalizer4 exporter
+* Add Export::Base#just_export and Middleware::Base#just_export
+
 === 1.5.0 / 2009-10-09
 
 * Implement support for older 3DE exports (in and out)

data/lib/export/base.rb

@@ -13,18 +13,20 @@ class Tracksperanto::Export::Base
     super
   end
   
-  # Should return the suffix and extension of this export file (like "flame.stabilizer"). It's a class
-  # method because it gets requested before the exporter is instantiated
+  # Should return the suffix and extension of this export file (like "flame.stabilizer"), without
+  # the leading underscore. It's a class method because it gets requested before the exporter is instantiated
   def self.desc_and_extension
     "data.txt"
   end
   
-  # Should return the human-readable (read: with spaces) name of the export module
+  # Should return the human-readable (read: properly capitalized and with spaces) name of the export module
   def self.human_name
     "Abstract export format"
   end
   
   # The constructor for an exporter should accept a handle to the IO object that you can write to.
+  # This gets assigned to @io ivar by default, but you can do whatever ypu wish
+  # By convention, the caller will close the IO when you are done so don't do it here
   def initialize(write_to_io)
     @io = write_to_io
   end
@@ -33,7 +35,7 @@ class Tracksperanto::Export::Base
   def start_export( img_width, img_height)
   end
   
-  # Called on export end. No need to close the passed IO, it will be done for you afterwards
+  # Called on export end. By convention, the caller will close the IO when you are done so don't do it here
   def end_export
   end
   

data/lib/export/equalizer3.rb

@@ -3,7 +3,6 @@ class Tracksperanto::Export::Equalizer3 < Tracksperanto::Export::Base
   
   HEADER = '// 3DE Multiple Tracking Curves Export 2048 x 778 * 275 frames'
   
-  # Should return the suffix and extension of this export file (like "_flame.stabilizer")
   def self.desc_and_extension
     "3de_v3.txt"
   end

data/lib/export/equalizer4.rb

@@ -1,7 +1,6 @@
 # Export for 3DE v4 point files
 class Tracksperanto::Export::Equalizer4 < Tracksperanto::Export::Base
   
-  # Should return the suffix and extension of this export file (like "_flame.stabilizer")
   def self.desc_and_extension
     "3de_v4.txt"
   end
@@ -13,13 +12,13 @@ class Tracksperanto::Export::Equalizer4 < Tracksperanto::Export::Base
   def start_export( img_width, img_height)
     # 3DE needs to know the number of points in advance,
     # so we will just buffer to a StringIO
-    @internal_io, @num_of_trackers = Tempfile.new(self.class.to_s), 0
+    @internal_io, @num_of_trackers = Tempfile.new("teq4x"), 0
   end
   
   def start_tracker_segment(tracker_name)
     @internal_io.puts(tracker_name)
     @num_of_trackers += 1
-    @tracker_buffer, @num_of_kfs = Tempfile.new(self.class.to_s), 0
+    @tracker_buffer, @num_of_kfs = Tempfile.new("teq4x_p"), 0
   end
   
   def export_point(frame, abs_float_x, abs_float_y, float_residual)

data/lib/export/nuke_script.rb

@@ -26,7 +26,6 @@ Constant {
       include ::Tracksperanto::BlockInit
     end
     
-    # Should return the suffix and extension of this export file (like "_flame.stabilizer")
     def self.desc_and_extension
       "nuke.nk"
     end

data/lib/export/pftrack_5.rb

@@ -12,7 +12,7 @@ class Tracksperanto::Export::PFTrack5 < Tracksperanto::Export::PFTrack4
     def end_tracker_segment
       block = [ "\n",
         @tracker_name.inspect, # "autoquotes"
-        "Primary".inspect,
+        "Primary".inspect, # For primary/secondary cam in stereo pair
         @prev_tracker.length,
         @prev_tracker.join("\n") ]
       @io.puts block.join("\n")

data/lib/export/shake_text.rb

@@ -3,7 +3,6 @@ class Tracksperanto::Export::ShakeText < Tracksperanto::Export::Base
   PREAMBLE = "TrackName %s\n   Frame             X             Y   Correlation\n"
   POSTAMBLE = "\n"
   
-  # Should return the suffix and extension of this export file (like "_flame.stabilizer")
   def self.desc_and_extension
     "shake_trackers.txt"
   end

data/lib/export/syntheyes.rb

@@ -1,7 +1,6 @@
 # Export for Syntheyes tracker UVs
 class Tracksperanto::Export::SynthEyes < Tracksperanto::Export::Base
   
-  # Should return the suffix and extension of this export file (like "_flame.stabilizer")
   def self.desc_and_extension
     "syntheyes_2dt.txt"
   end

data/lib/import/base.rb

@@ -38,7 +38,7 @@ class Tracksperanto::Import::Base
   end
   
   # Return an extension WITH DOT if this format has a typical extension that
-  # you can detect 
+  # you can detect (like ".nk" for Nuke) 
   def self.distinct_file_ext
     nil
   end
@@ -54,15 +54,17 @@ class Tracksperanto::Import::Base
     false
   end
   
-  # Call this method to tell what you are doing. This gets propagated to the caller automatically, or
-  # gets ignored if the caller did not request any progress reports
+  # Call this method from the inside of your importer to tell what you are doing. 
+  # This gets propagated to the caller automatically, or gets ignored if the caller did not request any progress reports
   def report_progress(message)
     @progress_block.call(message) if @progress_block
   end
   
   # The main method of the parser. Will receive an IO handle to the file being imported, and should
   # return an array of Tracksperanto::Tracker objects containing keyframes. If you have a problem
-  # doing an import, raise from here.
+  # doing an import, raise from here. Note that in general it's a good idea to stream-parse a document
+  # instead of bulk-reading it into memory (since Tracksperanto tries to be mem-efficient when dealing
+  # with large files)
   def parse(track_file_io)
     []
   end

data/lib/import/equalizer3.rb

@@ -29,6 +29,7 @@ class Tracksperanto::Import::Equalizer3 < Tracksperanto::Import::Base
         if line =~ /^(\w+)/ # Tracker name
           discard_last_empty_tracker!(ts)
           ts.push(Tracksperanto::Tracker.new(:name => line.strip))
+          report_progress("Capturing tracker #{line.strip}")
         elsif line =~ /^\t/
           ts[-1].push(make_keyframe(line))
         end
@@ -39,11 +40,15 @@ class Tracksperanto::Import::Equalizer3 < Tracksperanto::Import::Base
     end
     
     def discard_last_empty_tracker!(in_array)
-      in_array.delete_at(-1) if (in_array.any? && in_array[-1].empty?)
+      if (in_array.any? && in_array[-1].empty?)
+        in_array.delete_at(-1)
+        report_progress("Removing the last tracker since it had no keyframes")
+      end
     end
     
     def make_keyframe(from_line)
       frame, x, y = from_line.split
+      report_progress("Capturing keyframe #{frame}")
       Tracksperanto::Keyframe.new(:frame => (frame.to_i - 1), :abs_x => x, :abs_y => y)
     end
 end

data/lib/import/equalizer4.rb

@@ -26,6 +26,8 @@ class Tracksperanto::Import::Equalizer4 < Tracksperanto::Import::Base
     def extract_tracker(io)
       t = Tracksperanto::Tracker.new(:name => io.gets.strip)
       
+      report_progress("Capturing tracker #{t.name}")
+      
       io.gets # Tracker color, internal 3DE repr and 0 is Red
       
       num_of_keyframes = io.gets.to_i
@@ -35,6 +37,7 @@ class Tracksperanto::Import::Equalizer4 < Tracksperanto::Import::Base
           throw :__emp unless line
           
           frame, x, y = line.scan(KF_PATTERN).flatten
+          report_progress("Capturing keyframe #{frame}")
           t.keyframe!(:frame => (frame.to_i - 1), :abs_x => x, :abs_y => y)
         end
       end

data/lib/tracksperanto.rb

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

data/tracksperanto.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tracksperanto}
-  s.version = "1.5.1"
+  s.version = "1.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tracksperanto
 version: !ruby/object:Gem::Version 
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-10 00:00:00 +02:00
+date: 2009-10-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency