tracksperanto 2.9.5 → 2.9.6

data/lib/middleware/prefix.rb

@@ -2,8 +2,12 @@
 # This middleware prepends the names of the trackers passing through it with a prefix
 # and an underscore
 class Tracksperanto::Middleware::Prefix < Tracksperanto::Middleware::Base
-  attr_accessor :prefix
-  cast_to_string :prefix
+  
+  parameter :prefix,  :cast => :string, :desc => "The prefix to apply", :default => "trk_"
+  
+  def self.action_description
+    "Prefix tracker names with text"
+  end
   
   def start_tracker_segment(tracker_name)
     prefixed_name = [prefix.gsub(/_$/, ''), tracker_name]

data/lib/middleware/reformat.rb

@@ -5,9 +5,12 @@ require File.dirname(__FILE__) + '/scaler'
 # applying proxy tracks to full-res images
 class Tracksperanto::Middleware::Reformat < Tracksperanto::Middleware::Base
   
-  # To which format we have to scale
-  attr_accessor :width, :height
-  cast_to_int :width, :height
+  parameter :width,  :cast => :int, :desc => "New comp width in px", :default => 1080
+  parameter :height,  :cast => :int, :desc => "New comp height in px", :default => 1080
+  
+  def self.action_description
+    "Reformat the comp together with it's trackers to conform to a specific format"
+  end
   
   # Called on export start
   def start_export( img_width, img_height)

data/lib/middleware/scaler.rb

@@ -3,8 +3,12 @@
 class Tracksperanto::Middleware::Scaler < Tracksperanto::Middleware::Base
   DEFAULT_FACTOR = 1
   
-  attr_accessor :x_factor, :y_factor
-  cast_to_float :x_factor, :y_factor
+  parameter :x_factor,  :cast => :float, :desc => "Factor to scale by", :default => DEFAULT_FACTOR
+  parameter :y_factor,  :cast => :float, :desc => "Factor to scale by", :default => 0.5
+  
+  def self.action_description
+    "Scale the comp by a specified factor"
+  end
   
   # Called on export start
   def start_export( img_width, img_height)

data/lib/middleware/shift.rb

@@ -1,8 +1,13 @@
 # -*- encoding : utf-8 -*-
 # This middleware moves the keyframs by a preset number of pixels
 class Tracksperanto::Middleware::Shift < Tracksperanto::Middleware::Base
-  attr_accessor :x_shift, :y_shift
-  cast_to_float :x_shift, :y_shift
+  
+  parameter :x_shift,  :cast => :float, :desc => "Amount of horizontal shift (in px)", :default => 0
+  parameter :y_shift,  :cast => :float, :desc => "Amount of vertical shift (in px)", :default => 0
+  
+  def self.action_description
+    "Move all the trackers by a specified number of pixels"
+  end
   
   def export_point(frame, float_x, float_y, float_residual)
     super(frame, float_x + @x_shift.to_f, float_y + @y_shift.to_f, float_residual)

data/lib/middleware/slipper.rb

@@ -2,8 +2,12 @@
 # Slips the keyframe positions by a specific integer amount of frames, positive values slip forward (later in time). Useful if you just edited some stuff onto
 # the beginning if your sequence and need to extend your tracks.
 class Tracksperanto::Middleware::Slipper < Tracksperanto::Middleware::Base
-  attr_accessor :slip
-  cast_to_int :slip
+  
+  parameter :slip,  :cast => :int, :desc => "Number of frames to slip related to the current frames", :default => 0
+  
+  def self.action_description
+    "Slip all the tracker keyframes in time"
+  end
   
   def export_point(frame, float_x, float_y, float_residual)
     super(frame + @slip.to_i, float_x, float_y, float_residual)

data/lib/middleware/start_trim.rb

@@ -1,17 +1,17 @@
 # -*- encoding : utf-8 -*-
 # This middleware removes all keyframes before frame 0, and skips trackers entirely if they are all before frame 0
 class Tracksperanto::Middleware::StartTrim < Tracksperanto::Middleware::Base
-  attr_accessor :enabled
+  
+  def self.action_description
+    "Remove all the keyframes that are on frames below 1"
+  end
   
   def start_export( img_width, img_height)
-    if @enabled
-      @exporter = Tracksperanto::Middleware::LengthCutoff.new(@exporter, :min_length => 1) # Ensure at least one keyframe
-    end
-    
+    @exporter = Tracksperanto::Middleware::LengthCutoff.new(@exporter, :min_length => 1) # Ensure at least one keyframe
     super
   end
   
   def export_point(frame, float_x, float_y, float_residual)
-    return super unless (@enabled && frame < 0)
+    return super unless frame < 0
   end
 end

data/lib/pipeline/base.rb

@@ -161,49 +161,45 @@ module Tracksperanto::Pipeline
     
     @ios.push(io_with_progress)
     
-    @accumulator = Obuf.new
+    importer.io = io_with_progress
+    obuf = Obuf.new(Tracksperanto::YieldNonEmpty.new(importer))
     
-    begin
-    
-      importer.io = io_with_progress
-      importer.each {|t| @accumulator.push(t) unless t.empty? }
-    
-      report_progress(percent_complete = 50.0, "Validating #{@accumulator.size} imported trackers")
-      raise NoTrackersRecoveredError if @accumulator.size.zero?
-    
-      report_progress(percent_complete, "Starting export")
-    
-      percent_per_tracker = (100.0 - percent_complete) / @accumulator.size
-    
-      # Use the width and height provided by the parser itself
-      exporter.start_export(importer.width, importer.height)
+    report_progress(percent_complete = 50.0, "Validating #{obuf.size} imported trackers")
+    raise NoTrackersRecoveredError if obuf.size.zero?
+  
+    report_progress(percent_complete, "Starting export")
+  
+    percent_per_tracker = (100.0 - percent_complete) / obuf.size
+  
+    # Use the width and height provided by the parser itself
+    exporter.start_export(importer.width, importer.height)
+  
+    # Now send each tracker through the middleware chain
+    obuf.each_with_index do | t, tracker_idx |
     
-      # Now send each tracker through the middleware chain
-      @accumulator.each_with_index do | t, tracker_idx |
-      
-        kf_weight = percent_per_tracker / t.keyframes.length
-        points += 1
-        exporter.start_tracker_segment(t.name)
-        t.each_with_index do | kf, idx |
-          keyframes += 1
-          exporter.export_point(kf.frame, kf.abs_x, kf.abs_y, kf.residual)
-          report_progress(
-              percent_complete += kf_weight,
-              "Writing keyframe #{idx+1} of #{t.name.inspect}, #{@accumulator.size - tracker_idx} trackers to go"
-          )
-        end
-        exporter.end_tracker_segment
+      kf_weight = percent_per_tracker / t.keyframes.length
+      points += 1
+      exporter.start_tracker_segment(t.name)
+      t.each_with_index do | kf, idx |
+        keyframes += 1
+        exporter.export_point(kf.frame, kf.abs_x, kf.abs_y, kf.residual)
+        report_progress(
+            percent_complete += kf_weight,
+            "Writing keyframe #{idx+1} of #{t.name.inspect}, #{obuf.size - tracker_idx} trackers to go"
+        )
       end
-      exporter.end_export
+      exporter.end_tracker_segment
+    end
+    exporter.end_export
+  
+    report_progress(100.0, "Wrote #{points} points and #{keyframes} keyframes")
     
-      report_progress(100.0, "Wrote #{points} points and #{keyframes} keyframes")
+    obuf.clear
     
-      [points, keyframes]
-    ensure
-      @accumulator.clear
-      @ios.map!{|e| e.close! rescue e.close }
-      @ios.clear
-    end
+    @ios.map!{|e| e.close! rescue e.close }
+    @ios.clear
+  
+    return [points, keyframes]
   end
   
   # Setup output files and return a single output

data/lib/tracksperanto.rb

@@ -3,7 +3,7 @@
 
 module Tracksperanto
   PATH = File.expand_path(File.dirname(__FILE__))
-  VERSION = '2.9.5'
+  VERSION = '2.9.6'
   
   module Import; end
   module Export; end
@@ -38,6 +38,21 @@ module Tracksperanto
     def middleware_names
       middlewares.map{|e| e.const_name }
     end
+    
+    def exporters
+      sort_on_human_name(@exporters)
+    end
+    
+    def importers
+      sort_on_human_name(@importers)
+    end
+    
+    private
+    
+    def sort_on_human_name(array)
+      array.sort!{|a, b| a.human_name <=> b.human_name }
+      array
+    end
   end
   
   self.exporters, self.importers, self.middlewares = [], [], []
@@ -86,6 +101,8 @@ end
   simple_export
   uv_coordinates
   buffering_reader
+  parameters
+  yield_non_empty
 ).each do | submodule |
   require File.join(Tracksperanto::PATH, "tracksperanto", submodule)
 end

data/lib/tracksperanto/format_detector.rb

@@ -8,32 +8,32 @@ class Tracksperanto::FormatDetector
     freeze
   end
   
+  # Tells if an importer has been found for this file
+  def match?
+    !!@importer_klass
+  end
+  
+  # Returns the importer if there is one
+  def importer_klass
+    @importer_klass
+  end
+  
+  # Tells if comp size needs to be provided
+  def auto_size?
+    match? ? importer_klass.autodetects_size? : false
+  end
+  
+  # Returns the human name of the importer
+  def human_importer_name
+    match? ? importer_klass.human_name : "Unknown format"
+  end
+  
   private
-    def perform_detection(for_path)
-      return unless (for_path && !for_path.to_s.empty?)
-      ext = File.extname(for_path.downcase)
-      @importer_klass = Tracksperanto.importers.find{ |i| i.distinct_file_ext == ext }
-    end
+
+  def perform_detection(for_path)
+    return unless (for_path && !for_path.to_s.empty?)
+    ext = File.extname(for_path.downcase)
+    @importer_klass = Tracksperanto.importers.find{ |i| i.distinct_file_ext == ext }
+  end
   
-  public
-    
-    # Tells if an importer has been found for this extension
-    def match?
-      !!@importer_klass
-    end
-    
-    # Returns the importer if there is one
-    def importer_klass
-      @importer_klass
-    end
-    
-    # Tells if comp size needs to be provided
-    def auto_size?
-      match? ? importer_klass.autodetects_size? : false
-    end
-    
-    # Returns the human name of the importer
-    def human_importer_name
-      match? ? importer_klass.human_name : "Unknown format"
-    end
 end

data/lib/tracksperanto/parameters.rb

@@ -0,0 +1,56 @@
+module Tracksperanto::Parameters
+  
+  def self.included(into)
+    into.extend(self)
+    super
+  end
+  
+  class Parameter
+    include Tracksperanto::BlockInit
+    
+    # The name of the paramenter and the related object attribute
+    attr_accessor :name
+    
+    # Whether the attribute is required
+    attr_accessor :required
+    
+    # Default value of the attribute
+    attr_accessor :default
+    
+    # The cast for the attribute (like :int or :float)
+    attr_accessor :cast
+    
+    # Attribute description for the UI
+    attr_accessor :desc
+    
+    def apply_to(to_class)
+      to_class.send(:attr_accessor, name)
+      
+      if cast
+        cast_call = "cast_to_#{cast}"
+        to_class.send(cast_call, name)
+      end
+      
+      if required
+        to_class.safe_reader name
+      end
+      
+    end
+  end
+  
+  # Defines a parameter, options conform to the Parameter class.
+  # The parameter will of course add an attr_accessor to your class for the specified parameter,
+  # but it will also 
+  def parameter(name, options = {})
+    options = {:name => name}.merge(options)
+    param = Parameter.new(options)
+    parameters.push(param)
+    param.apply_to(self)
+  end
+  
+  # Returns the array of the parameters defined for this class
+  def parameters
+    @ui_parameters ||= []
+    @ui_parameters
+  end
+end

data/lib/tracksperanto/yield_non_empty.rb

@@ -0,0 +1,15 @@
+# An Enumerable wrapper that will only yield non-empty elements
+class Tracksperanto::YieldNonEmpty
+  
+  include Enumerable
+  
+  def initialize(obj)
+    @obj = obj
+  end
+  
+  def each
+    @obj.each do | item |
+      yield(item) unless item.empty?
+    end
+  end
+end

data/test/import/test_nuke_import.rb

@@ -6,7 +6,7 @@ class NukeImportTest < Test::Unit::TestCase
   
   def test_introspects_properly
     i = Tracksperanto::Import::NukeScript
-    assert_equal "Nuke .nk script file", i.human_name
+    assert_equal "Nuke .nk script file with Tracker or Reconcile3D nodes", i.human_name
     assert !i.autodetects_size?
   end
   
@@ -20,6 +20,21 @@ class NukeImportTest < Test::Unit::TestCase
     assert_equal 45, trackers.length
   end
   
+  
+  def test_parsing_from_reconciles
+    fixture = File.open(File.dirname(__FILE__) + '/samples/nuke/reconciles.nk')
+    
+    parser = Tracksperanto::Import::NukeScript.new(:io => fixture)
+    parser.width = 2048
+    parser.height = 1176
+    
+    trackers = parser.to_a.reject{|e| e.empty? }
+    
+    assert_equal 5, trackers.length
+    assert_equal 128, trackers[0].length
+  end
+  
+  
   def test_parsing_from_nuke
     fixture = File.open(File.dirname(__FILE__) + '/samples/nuke/one_tracker_with_break.nk')
     

data/test/middleware/test_crop_middleware.rb

@@ -2,6 +2,11 @@
 require File.expand_path(File.dirname(__FILE__)) + '/../helper'
 
 class CropMiddlewareTest < Test::Unit::TestCase
+  
+  def test_action_description
+    assert_equal "Crop or pad the image by a specified number of pixels", Tracksperanto::Middleware::Crop.action_description
+  end
+  
   def test_crop_supports_hash_init
     receiver = flexmock
     m = Tracksperanto::Middleware::Crop.new(receiver, :left => 13, :right => 0, :top => 25)

data/test/middleware/test_flip_middleware.rb

@@ -2,14 +2,9 @@
 require File.expand_path(File.dirname(__FILE__)) + '/../helper'
 
 class FlipMiddlewareTest < Test::Unit::TestCase
-  def test_flip_supports_hash_init
-    receiver = flexmock
-    
-    m = Tracksperanto::Middleware::Flip.new(receiver)
-    assert !m.enabled
-    
-    m = Tracksperanto::Middleware::Flip.new(receiver, :enabled => true)
-    assert m.enabled
+  
+  def test_action_description
+    assert_equal "Mirrors all the tracker paths horizontally", Tracksperanto::Middleware::Flip.action_description
   end
   
   def test_export_with_enabled_flip
@@ -17,17 +12,7 @@ class FlipMiddlewareTest < Test::Unit::TestCase
     receiver.should_receive(:start_export).once.with(110, 120)
     receiver.should_receive(:export_point).once.with(1, 100, 95, 0)
 
-    m = Tracksperanto::Middleware::Flip.new(receiver, :enabled => true)
-    m.start_export(110, 120)
-    m.export_point(1, 10, 95, 0)
-  end
-
-  def test_export_with_disabled_flip
-    receiver = flexmock(:exporter)
-    receiver.should_receive(:start_export).once.with(110, 120)
-    receiver.should_receive(:export_point).once.with(1, 10, 95, 0)
-
-    m = Tracksperanto::Middleware::Flip.new(receiver, :enabled => false)
+    m = Tracksperanto::Middleware::Flip.new(receiver)
     m.start_export(110, 120)
     m.export_point(1, 10, 95, 0)
   end