tracksperanto 2.9.5 → 2.9.6

data/Gemfile

@@ -1,7 +1,7 @@
 # -*- ruby -*-
 source :rubygems
 
-gem "obuf", "~> 1.0.4"
+gem "obuf", "~> 1.1.0"
 gem "progressive_io", "~> 1.0"
 gem "flame_channel_parser", "~> 4.0"
 gem "progressbar", "0.10.0"

data/History.txt

@@ -1,3 +1,8 @@
+=== 2.9.6
+
+* Add Nuke Reconcile3D support
+* Add Middleware::Base.parameters for automatic GUI building
+
 === 2.9.5
 
 * Export a Maya ASCII scene instead of a MEL script

data/bin/tracksperanto

@@ -17,7 +17,7 @@ require 'progressbar'
 require "update_hints"
 
 def disclaimer
-  "Please consider a small donation to keep Tracksperanto going. http://guerilla-di.org/source-and-license/\n"+
+  "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
 
@@ -29,13 +29,21 @@ writers = Tracksperanto.exporter_names
 
 op = OptionParser.new
 
-def mw(name, option, default_value = nil)
+def mw(*name_option_and_default_value)
   Proc.new do |value| 
+    name, option, default_value = name_option_and_default_value
     v = value.nil? ? default_value : value
-    $middlewares.push([name, {option => v}])
+    mw_tuple = [name]
+    mw_tuple.push({option => v}) if option
+    
+    $middlewares.push(mw_tuple)
   end
 end
 
+def mwd(name)
+  Tracksperanto.get_middleware(name).action_description
+end
+
 def list_exporters(dest = $stderr)
   dest.puts "The following export modules are available:"
   Tracksperanto.exporters.each do | exporter |
@@ -66,32 +74,35 @@ op.on(" -w", "--width WIDTH_IN_PIXELS", Integer, "Absolute input comp width in p
 op.on(" -h", "--height HEIGHT_IN_PIXELS", Integer, "Absolute input comp height in pixels (will try to autodetect)") {|w| options[:height] = w }
 op.on(" -o", "--only EXPORTER_NAME", String, "Only export the selected format, format must be one of #{writers.join(", ")}") { |f| writer_class_name = f }
 
-op.on(" -xs", "--xscale X_SCALING_FACTOR", Float, "Scale the result in X by this factor (1.0 is the default)", &mw("Scaler", :x_factor))
+op.on(" -xs", "--xscale X_SCALING_FACTOR", Float, mwd("Scaler"), &mw("Scaler", :x_factor))
 
-op.on(" -pad", "--pad PAD_FRACTION_VALUES_COMMA_SEPARATED", String, "Pad the comp by these ratios") do | pads|
+op.on(" -pad", "--pad PAD_FRACTION_VALUES_COMMA_SEPARATED", String, mwd("Pad")) do | pads|
   left, right, top, bottom = pads.split(",").map{|e| e.to_f }
   $middlewares.push(["Pad", {"left_pad" => left, "right_pad"=> right, "top_pad" => top, "bottom_pad" => bottom}])
 end
 
-op.on(" -crop", "--crop CROP_VALUES_COMMA_SEPARATED", String, "Crop or unpad the comp by these pixel values") do | pads|
+op.on(" -crop", "--crop CROP_VALUES_COMMA_SEPARATED", String, mwd("Crop")) do | pads|
   left, right, top, bottom = pads.split(",").map{|e| e.to_i }
   $middlewares.push(["Crop", {"left" => left, "right"=> right, "top" => top, "bottom" => bottom}])
 end
 
-op.on(" -ys", "--yscale Y_SCALING_FACTOR", Float, "Scale the result in Y by this factor (1.0 is the default)", &mw("Scaler", :y_factor))
-op.on(" -t", "--trim", "Trim the start frames (do not allow negative frame values)",  &mw("StartTrim", :enabled, true)) # Before slip!
-op.on(" -s", "--slip FRAMES", Integer, "Slip the result by this number of frames, positive is 'later'", &mw("Slipper", :slip))
-
-op.on(" -g", "--golden", "Reset the residuals of all trackers to 0 (ignore correlation)", &mw("Golden", :enabled, true))
+op.on(" -ys", "--yscale Y_SCALING_FACTOR", Float, mwd("Scaler"), &mw("Scaler", :y_factor))
+op.on(" -t", "--trim", Float, mwd("StartTrim"),  &mw("StartTrim")) # Before slip!
+op.on(" -s", "--slip FRAMES", Integer, mwd("Slipper"), &mw("Slipper", :slip))
+op.on(" -g", "--golden", mwd("Golden"), &mw("Golden"))
+op.on(" -m", "--min-length LENGTH_IN_FRAMES", Integer, mwd("LengthCutoff"), &mw("LengthCutoff", :min_length))
+op.on(" -p", "--prefix PREFIX", String, mwd("Prefix"), &mw("Prefix", :prefix))
+op.on("--lerp", mwd("Lerp"), &mw("Lerp"))
+op.on("--flip", mwd("Flip"), &mw("Flip"))
+op.on("--flop", mwd("Flop"), &mw("Flop"))
+
+# TODO - multiparameters
 op.on(" -rx", "--reformat-x NEW_PIX_WIDTH", Integer, "Reformat the comp to this width and scale all tracks to it", &mw("Reformat", :width))
 op.on(" -ry", "--reformat-y NEW_PIX_HEIGHT", Integer, "Reformat the comp to this height and scale all tracks to it", &mw("Reformat", :height))
-op.on(" -m", "--min-length LENGTH_IN_FRAMES", Integer, "Only export trackers having more than X keyframes", &mw("LengthCutoff", :min_length))
 op.on(" -xm", "--xshift X_IN_PIXELS", Float, "Move the points left or right", &mw("Shift", :x_shift))
 op.on(" -ym", "--yshift Y_IN_PIXELS", Float, "Move the points up or down", &mw("Shift", :y_shift)) 
-op.on(" -p", "--prefix PREFIX", String, "A prefix to prepend to tracker names in bulk", &mw("Prefix", :prefix))
-op.on("--lerp", "Linearly interpolate missing keyframes", &mw("Lerp", :enabled, true))
-op.on("--flip", "Flip the comp horizontally", &mw("Flip", :enabled, true))
-op.on("--flop", "Flop the comp vertically", &mw("Flop", :enabled, true))
+
+
 op.on("--list-exporters", "Show available export modules") do
   list_exporters; exit(0)
 end
@@ -131,22 +142,21 @@ begin
   pipe = Tracksperanto::Pipeline::Base.new(:progress_block => progress, :middleware_tuples => $middlewares)
   pipe.exporters = [Tracksperanto.get_exporter(writer_class_name)] if writer_class_name
   pipe.run(input_file, options)
+  pbar.finish
+  $stdout.puts "Found and converted %d trackers with %d keyframes." % [pipe.converted_points, pipe.converted_keyframes]
 rescue Tracksperanto::UnknownExporterError => damn
   $stderr.puts damn.message
   list_exporters($stderr)
-  exit(2)
+  fail "Unknown exporter"
 rescue Tracksperanto::UnknownImporterError => damn
   $stderr.puts damn.message
   list_importers($stderr)
-  exit(2)
+  fail "Unknown importer"
 rescue Tracksperanto::UnknownMiddlewareError => damn
   $stderr.puts damn.message
-  $stderr.puts "This is a bug, please report it"
-  exit(2)
+  fail "This is a bug, please report it"
 rescue Exception => damn
   fail damn.message
-ensure
-  pbar.finish
 end
 
 puts disclaimer

data/lib/export/equalizer3.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
-# Export for 3DE v3 point files
+# Export for 3DE v3 point files. 3DE always starts frames at 1.
 class Tracksperanto::Export::Equalizer3 < Tracksperanto::Export::Base
   
   HEADER = '// 3DE Multiple Tracking Curves Export %d x %d * %d frames'

data/lib/export/equalizer4.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
-# Export for 3DE v4 point files
+# Export for 3DE v4 point files. 3DE always starts frames at 1.
 class Tracksperanto::Export::Equalizer4 < Tracksperanto::Export::Base
   
   def self.desc_and_extension

data/lib/import/flame_stabilizer.rb

@@ -131,8 +131,8 @@ class Tracksperanto::Import::FlameStabilizer < Tracksperanto::Import::Base
     
     def find_base_x_and_y(track_tuples, shift_tuples)
       base_track_tuple = track_tuples.find do | track_tuple |
-        shift_tuples.find { |shift_tuple| shift_tuple[0] == track_tuple [0] }
-      end || track_tuples[0]
-      base_track_tuple[1..2]
+        shift_tuples.find { |shift_tuple| shift_tuple[0] == track_tuple[0] }
+      end
+      (base_track_tuple || track_tuples[0])[1..2]
     end
 end

data/lib/import/nuke_script.rb

@@ -5,7 +5,7 @@ require File.expand_path(File.dirname(__FILE__)) + "/nuke_grammar/utils"
 class Tracksperanto::Import::NukeScript < Tracksperanto::Import::Base
   
   def self.human_name
-    "Nuke .nk script file"
+    "Nuke .nk script file with Tracker or Reconcile3D nodes"
   end
   
   def self.distinct_file_ext
@@ -16,7 +16,9 @@ class Tracksperanto::Import::NukeScript < Tracksperanto::Import::Base
     io = Tracksperanto::ExtIO.new(@io)
     while line = io.gets_and_strip
       if line =~ TRACKER_3_PATTERN
-        scan_tracker_node(io).each { |t| yield(t) }
+        scan_tracker_node(io).each(&Proc.new)
+      elsif line =~ RECONCILE_PATTERN
+        scan_reconcile_node(io).each(&Proc.new)
       end
     end
   end
@@ -24,9 +26,26 @@ class Tracksperanto::Import::NukeScript < Tracksperanto::Import::Base
   private
     
     TRACKER_3_PATTERN = /^Tracker3 \{/
+    RECONCILE_PATTERN = /^Reconcile3D \{/
+    OUTPUT_PATTERN = /^output \{/
     TRACK_PATTERN = /^track(\d) \{/
     NODENAME = /^name ([^\n]+)/
     
+    
+    # Scans a Reconcile3D node and returs it's output
+    def scan_reconcile_node(io)
+      t = Tracksperanto::Tracker.new
+      while line = io.gets_and_strip
+        if line =~ OUTPUT_PATTERN
+          t = extract_tracker(line)
+        elsif line =~ NODENAME
+          t.name = "Reconcile_#{$1}"
+          report_progress("Scavenging Reconcile3D node #{t.name}")
+          return [t] # Klunky
+        end
+      end
+    end
+    
     # Scans a tracker node and return all tracks within that node (no more than 4)
     def scan_tracker_node(io)
       tracks_in_tracker = []
@@ -56,11 +75,10 @@ class Tracksperanto::Import::NukeScript < Tracksperanto::Import::Base
     def extract_tracker(line)
       tuples = scan_track(line)
       return nil unless (tuples && tuples.any?)
-      
-      Tracksperanto::Tracker.new(
-        :keyframes => tuples.map do | (f, x, y) | 
-          Tracksperanto::Keyframe.new(:frame => f -1, :abs_x => x, :abs_y => y) 
+      Tracksperanto::Tracker.new do | t |
+        tuples.each do | (f, x, y) |
+            t.keyframe!(:frame => (f -1), :abs_x => x, :abs_y => y) 
         end
-      )
+      end
     end
 end

data/lib/middleware/base.rb

@@ -1,4 +1,6 @@
 # -*- encoding : utf-8 -*-
+require "forwardable"
+
 # The base middleware class works just like a Tracksperanto::Export::Base, but it only wraps another exporting object and does not get registered on it's own
 # as an export format. Middleware can be used to massage the tracks being exported in various interesting ways - like moving the coordinates, clipping the keyframes,
 # scaling the whole export or even reversing the trackers to go backwards
@@ -7,6 +9,10 @@ class Tracksperanto::Middleware::Base
   include Tracksperanto::BlockInit
   include Tracksperanto::ConstName
   include Tracksperanto::SimpleExport
+  include Tracksperanto::Parameters
+  
+  extend Forwardable
+  def_delegators :@exporter, :start_export, :start_tracker_segment, :end_tracker_segment, :export_point, :end_export
   
   # Used to automatically register your middleware in Tracksperanto.middlewares
   # Normally you wouldn't need to override this
@@ -15,15 +21,16 @@ class Tracksperanto::Middleware::Base
     super
   end
   
-  # Constructor accepts the exporter that will be wrapped
+  # Returns the human name of the action that the middleware will perform. The action is
+  # the in infinitive form, like "Remove all the invalid keyframes", "Crop the image" and so on
+  def self.action_description
+    "Base middleware class"
+  end
+  
+  # Constructor accepts the exporter that will be wrapped, followed by the optional options hash
+  # and the optional block that yields self
   def initialize(*exporter_and_args_for_block_init)
     @exporter = exporter_and_args_for_block_init.shift
     super
   end
-  
-  %w( start_export start_tracker_segment end_tracker_segment
-    export_point end_export).each do | m |
-    define_method(m){|*a| @exporter.send(m, *a)}
-  end
-
 end

data/lib/middleware/crop.rb

@@ -1,8 +1,15 @@
 # -*- encoding : utf-8 -*-
 # Does the same as the Pad middleware but with absolute pixel values instead of fractionals
 class Tracksperanto::Middleware::Crop < Tracksperanto::Middleware::Base
-  attr_accessor :top, :left, :right, :bottom
-  cast_to_int :top, :left, :right, :bottom
+  
+  parameter :top, :cast => :int, :desc => "Top crop amount in px"
+  parameter :left, :cast => :int, :desc => "Left crop amount in px"
+  parameter :right, :cast => :int, :desc => "Right crop amount in px"
+  parameter :bottom, :cast => :int, :desc => "Bottom crop amount in px"
+  
+  def self.action_description
+    "Crop or pad the image by a specified number of pixels"
+  end
   
   def start_export(w, h)
     left_pad, right_pad, top_pad, bottom_pad = (left / w.to_f), (right / w.to_f), (top / h.to_f), (bottom / h.to_f)

data/lib/middleware/flip.rb

@@ -1,11 +1,13 @@
 # -*- encoding : utf-8 -*-
 # Flips the comp being exported horizontally
 class Tracksperanto::Middleware::Flip < Tracksperanto::Middleware::Base
-
-  attr_accessor :enabled
+  
+  def self.action_description
+    "Mirrors all the tracker paths horizontally"
+  end
   
   def start_export(w, h)
-    factor = enabled ? -1 : 1
+    factor = -1
     @exporter = Tracksperanto::Middleware::Scaler.new(@exporter, :x_factor => factor)
     super
   end

data/lib/middleware/flop.rb

@@ -2,10 +2,12 @@
 # Flips the comp being exported vertically
 class Tracksperanto::Middleware::Flop < Tracksperanto::Middleware::Base
   
-  attr_accessor :enabled
+  def self.action_description
+    "Mirror all the tracker paths vertically"
+  end
   
   def start_export(w, h)
-    factor = enabled ? -1 : 1
+    factor = -1
     @exporter = Tracksperanto::Middleware::Scaler.new(@exporter, :y_factor => factor)
     super
   end

data/lib/middleware/golden.rb

@@ -1,10 +1,13 @@
 # -*- encoding : utf-8 -*-
 # This middleware marks all trackers as being 100% accurate
 class Tracksperanto::Middleware::Golden < Tracksperanto::Middleware::Base
-  attr_accessor :enabled
+  
+  def self.action_description
+    "Reset residual of all the trackers to zero"
+  end
   
   def export_point(frame, float_x, float_y, float_residual)
-    super(frame, float_x, float_y, (enabled ? 0.0 : float_residual))
+    super(frame, float_x, float_y, 0.0)
   end
   
 end

data/lib/middleware/length_cutoff.rb

@@ -2,8 +2,12 @@
 # This middleware removes trackers that contain less than min_length keyframes
 # from the exported batch
 class Tracksperanto::Middleware::LengthCutoff < Tracksperanto::Middleware::Base
-  attr_accessor :min_length
-  cast_to_int :min_length
+  
+  parameter :min_length, :cast => :int, :desc => "The minimum number of keyframes for the item to contain", :default => 100
+  
+  def self.action_description
+    "Remove trackers that have less than the specified number of keyframes"
+  end
   
   def start_tracker_segment(name)
     @tracker = Tracksperanto::Tracker.new(:name => name)

data/lib/middleware/lerp.rb

@@ -1,7 +1,10 @@
 # -*- encoding : utf-8 -*-
 # This middleware adds linearly interpolated keyframes BETWEEN the keyframes passing through the exporter
 class Tracksperanto::Middleware::Lerp < Tracksperanto::Middleware::Base
-  attr_accessor :enabled
+  
+  def self.action_description
+    "Interpolate missing keyframes of all the trackers"
+  end
   
   def end_tracker_segment
     @last_f, @last_x, @last_y, @last_res = nil, nil, nil, nil
@@ -10,7 +13,7 @@ class Tracksperanto::Middleware::Lerp < Tracksperanto::Middleware::Base
   
   def export_point(frame, float_x, float_y, float_residual)
     
-    if @enabled && @last_f && (frame - @last_f > 1) # Interpolate!
+    if @last_f && (frame - @last_f > 1) # Interpolate!
       interpolated_frames = []
       interpolated_x = []
       lerp(@last_f, @last_x, frame, float_x) do | interp_f, interp_x |

data/lib/middleware/lint.rb

@@ -1,6 +1,11 @@
 # -*- encoding : utf-8 -*-
 # Prevents you from exporting invalid trackers
 class Tracksperanto::Middleware::Lint < Tracksperanto::Middleware::Base
+  
+  def self.action_description
+    "Verify all the exported trackers and check for errors"
+  end
+  
   class NoTrackersExportedError < RuntimeError
     def message
       "There were no trackers exported"

data/lib/middleware/move_to_first.rb

@@ -0,0 +1,50 @@
+# -*- encoding : utf-8 -*-
+# Sometimes your tracked sequence has been loaded from say frame 73282381, but you want to import into an application
+# that expects the trackers to start at frame 1. This middleware autoslips everything so that your trackers start at frame 1.
+class Tracksperanto::Middleware::MoveToFirst < Tracksperanto::Middleware::Base
+  
+  def self.action_description
+    "Move all the keyframes in time so that the first frame is the first animated keyframe"
+  end
+  
+  def start_export(width, height)
+    @width, @height = width, height
+    @start_frames = []
+    @buf = Obuf.new
+    @registered = false
+  end
+    
+  def start_tracker_segment(tracker_name)
+    @current = Tracksperanto::Tracker.new(:name => tracker_name)
+  end
+  
+  def end_tracker_segment
+    @buf.push(@current)
+    @registered = false
+  end
+  
+  def export_point(frame, float_x, float_y, float_residual)
+    @current.keyframe!(:frame => frame, :abs_x => float_x, :abs_y => float_y, :residual => float_residual)
+    return if @registered
+    
+    # Note where this tracker starts
+    @start_frames.push(frame)
+    @registered = true
+  end
+  
+  def end_export
+    actual_start = @start_frames.sort.shift
+    
+    @exporter.start_export(@width, @height)
+    @buf.each do | tracker |
+      @exporter.start_tracker_segment(tracker.name)
+      tracker.each do | kf |
+        @exporter.export_point(kf.frame - actual_start, kf.abs_x, kf.abs_y, kf.residual)
+      end
+      @exporter.end_tracker_segment
+    end
+    @exporter.end_export
+    
+    @buf.clear
+  end
+end

data/lib/middleware/pad.rb

@@ -3,9 +3,15 @@
 # some fucked-up telecine transfers. The padding is in fractional units of the total width
 # and height
 class Tracksperanto::Middleware::Pad < Tracksperanto::Middleware::Base
-  attr_accessor :left_pad, :right_pad, :top_pad, :bottom_pad
   
-  cast_to_float :left_pad, :right_pad, :top_pad, :bottom_pad
+  parameter :top_pad,     :cast => :float, :desc => "Top padding (fraction of original size)"
+  parameter :left_pad,    :cast => :float, :desc => "Left padding (fraction of original size)"
+  parameter :right_pad,   :cast => :float, :desc => "Right padding (fraction of original size)"
+  parameter :bottom_pad,  :cast => :float, :desc => "Bottom padding (fraction of original size)"
+  
+  def self.action_description
+    "Pad or crop the image by a fraction of it's original size"
+  end
   
   def start_export(w, h)
     @shift_left, @shift_bottom = w * left_pad, h * bottom_pad