tracksperanto 3.1.0 → 3.2.0

data/Gemfile

@@ -1,6 +1,7 @@
 # -*- ruby -*-
 source :rubygems
 
+gem "tickly", "~> 0.0.2"
 gem "obuf", "~> 1.1.0"
 gem "progressive_io", "~> 1.0"
 gem "flame_channel_parser", "~> 4.0"
@@ -13,4 +14,5 @@ group :development do
   gem "rake"
   gem "flexmock", "~>0.8"
   gem "cli_test", "~>1.0"
+  gem "rake-hooks"
 end

data/History.txt

@@ -1,3 +1,7 @@
+=== 3.2.0
+
+* Add Nuke 7 import support
+
 === 3.1.0
 
 * Add a Maxscript export module

data/README.rdoc

@@ -54,26 +54,46 @@ converted files already exist <b>they will be overwritten without warning</b>.
 
 == Format support
 
-Import and export support:
-* Nuke v5 script (Tracker3 nodes, also known as Tracker in the UI - this is the node that you track with, and Reconcile3D)
-* Shake tracker node export (textfile with many tracks per file)
-* PFTrack 2dt (version 4 and 5) anf PFMatchit/PFTrack 2011 point track exports
-* Syntheyes 2D tracking data exports
-* 3DE point exports (as output by the default script) - versions 3 and 4
-* MatchMover Pro .rz2
-* MayaLive track export (square pixel aspect only, you will need to write some extra code if your tracks are based on nonsquare pixels)
+--- 
+=== Formats Tracksperanto can read
+ 
+* 3DE v3 point export file
+* 3DE v4 point export file
+* Boujou feature tracks export
 * Flame .stabilizer file
-* Boujou feature track export
+* MatchMover REALVIZ Ascii Point Tracks .rz2 file
+* MatchMover RZML .rzml file
+* Maya Live track export file
+* Nuke .nk script file with Tracker, Reconcile3D and PlanarTracker nodes
+* PFTrack/PFMatchit .2dt file
+* Shake .shk script file
+* Shake .txt tracker file and Nuke CameraTracker auto tracks export
+* Syntheyes "All Tracker Paths" export .txt file
+* Syntheyes 2D tracker paths file
+ 
+=== Formats Tracksperanto can export to
+ 
+* 3DE v3 point export .txt file
+* 3DE v4 point export .txt file
+* AfterEffects .jsx script generating null layers
+* Autodesk 3dsmax script for nulls on an image plane
+* Autodesk Softimage nulls Python script
+* Bare Ruby code
+* Flame/Smoke 2D Stabilizer setup
+* Flame/Smoke 2D Stabilizer setup for bilinear corner pins
+* MatchMover REALVIZ Ascii Point Tracks .rz2 file
+* Maya ASCII scene with locators on an image plane
+* MayaLive track export
+* Nuke .nk script
+* Nuke CameraTracker node autotracks (enable import/export in the Tracking tab)
+* PFTrack v4 .2dt file
+* PFTrack v5 .2dt file (single camera)
+* PFTrack2011/PFMatchit .txt file (single camera)
+* Shake trackers in a .txt file
+* Syntheyes 2D tracker paths file
+* boujou feature tracks
+---
 
-Import only:
-* Shake scripts (Tracker, Matchmove and Stabilize nodes embedded in ANY shake script)
-* MatchMover RZML files
-
-Export only:
-* AfterEffects .jsx script that creates one null object per tracker (run through the script editor)
-* Ruby (will make calls to Tracksperanto to create trackers/keyframes) - useful if you want to play with trackers as data
-* Maya locators (animated locators on an image plane)
-* Softimage/XSI Python script (animated nulls on an image plane)
 
 == Editing your tracks while converting
 

data/Rakefile

@@ -1,5 +1,7 @@
 require './lib/tracksperanto'
 require 'jeweler'
+require 'rake/hooks'
+
 Jeweler::Tasks.new do |gem|
   gem.version = Tracksperanto::VERSION
   gem.name = "tracksperanto"
@@ -31,4 +33,33 @@ Rake::TestTask.new("test") do |t|
   t.verbose = true
 end
 
-task :default => [ :test ]
+# Automatically update the supported format list
+after :test do
+  formats = StringIO.new
+  
+  formats.puts(" ")
+  formats.puts('=== Formats Tracksperanto can read')
+  formats.puts(" ")
+  Tracksperanto.importers.each do | import_mdoule |
+    formats.puts("* %s" % import_mdoule.human_name)
+  end
+  
+  formats.puts(" ")
+  formats.puts('=== Formats Tracksperanto can export to')
+  formats.puts(" ")
+  Tracksperanto.exporters.each do | export_module |
+    formats.puts("* %s" % export_module.human_name)
+  end
+  
+  readme_text = File.read(File.dirname(__FILE__) + "/README.rdoc")
+  three = readme_text.split('---')
+  raise "Should split in 3" unless three.length == 3
+  three[1] = formats.string
+  
+  File.open(File.dirname(__FILE__) + "/README.rdoc", "w") do | f |
+    f.write(three.join('---'))
+  end
+end
+
+task :default => [ :test ]
+

data/lib/import/nuke_grammar/utils.rb

@@ -4,9 +4,10 @@ class Tracksperanto::NukeGrammarUtils
   KEYFRAME = /^([-\d\.]+)$/
   
   # Scan a TCL curve expression into a number of tuples of [frame, value]
-  def parse_curve(curve_text)
+  def parse_curve(atoms)
     # Replace the closing curly brace with a curly brace with space so that it gets caught by split
-    atoms, tuples = curve_text.gsub(/\}/m, ' }').split, []
+    atoms.shift # remove the "curve" keyword
+    tuples = []
     # Nuke saves curves very efficiently. x(keyframe_number) means that an uninterrupted sequence of values will start,
     # after which values follow. When the curve is interrupted in some way a new x(keyframe_number) will signifu that we
     # skip to that specified keyframe and the curve continues from there, in gap size defined by the last fragment.
@@ -24,8 +25,6 @@ class Tracksperanto::NukeGrammarUtils
       elsif  atom =~ KEYFRAME
         tuples << [last_processed_keyframe, $1.to_f]
         last_processed_keyframe += intraframe_gap_size
-      elsif atom == '}'
-        return tuples
       end
     end
     tuples

data/lib/import/nuke_script.rb

@@ -1,6 +1,7 @@
 # -*- encoding : utf-8 -*-
 require 'delegate'
 require File.expand_path(File.dirname(__FILE__)) + "/nuke_grammar/utils"
+require 'tickly'
 
 class Tracksperanto::Import::NukeScript < Tracksperanto::Import::Base
   
@@ -13,104 +14,121 @@ class Tracksperanto::Import::NukeScript < Tracksperanto::Import::Base
   end
   
   def self.known_snags
-    'The only supported nodes that we can extract tracks from are Reconcile3D, PlanarTracker and Tracker'
+    'The only supported nodes that we can extract tracks from are Reconcile3D, PlanarTracker and Tracker (supported Nuke versions are 5, 6 and 7)'
   end
   
   def each
-    io = Tracksperanto::ExtIO.new(@io)
-    while line = io.gets_and_strip
-      if line =~ TRACKER_3_PATTERN
-        scan_tracker_node(io).each(&Proc.new)
-      elsif line =~ RECONCILE_PATTERN
-        scan_reconcile_node(io).each(&Proc.new)
-      elsif line =~ PLANAR_PATTERN
-        scan_planar_tracker_node(io).each(&Proc.new)
+    script_tree = Tickly::Parser.new.parse(@io)
+    evaluator = Tickly::Evaluator.new
+    evaluator.add_node_handler_class(Tracker3)
+    evaluator.add_node_handler_class(Reconcile3D)
+    evaluator.add_node_handler_class(PlanarTracker1_0)
+    evaluator.add_node_handler_class(Tracker4)
+    
+    script_tree.each do | node |
+      result = evaluator.evaluate(node)
+      if result
+        result.trackers.each do | t |
+          report_progress("Scavenging tracker #{t.name}")
+          yield t
+        end
       end
     end
   end
   
   private
-    
-    TRACKER_3_PATTERN = /^Tracker3 \{/
-    RECONCILE_PATTERN = /^Reconcile3D \{/
-    PLANAR_PATTERN = /^PlanarTracker1_0 \{/
-    OUTPUT_PATTERN = /^output \{/
-    TRACK_PATTERN = /^track(\d) \{/
-    NODENAME = /^name ([^\n]+)/
-    PLANAR_CORNERS = %w( outputBottomLeft outputBottomRight outputTopLeft outputTopRight)
-    
-    # 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
+  
+  class Tracker3
+    include Tracksperanto::ZipTuples
+    attr_reader :trackers
+
+    def initialize(options)
+      @trackers = []
+      point_channels.each do | point_name |
+        next unless options[point_name]
+        point_channel = options[point_name]
+        
+        curves = extract_curves_from_channel(point_channel)
+        
+        # We must always have 2 anim curves
+        next unless curves.length == 2
+        
+        full_name = [options["name"], point_name].join('_')
+        tracker = package_tracker(full_name, curves[0], curves[1])
+        
+        @trackers << tracker
       end
     end
     
-    # Scans a PlanarTracker node and recovers corner pin
-    def scan_planar_tracker_node(io)
-      trackers, node_name = [], nil
-      while line = io.gets_and_strip
-        PLANAR_CORNERS.each do | corner_name |
-          if line =~ /#{corner_name}/
-            t = Tracksperanto::Tracker.new
-            t = extract_tracker(line)
-            t.name = corner_name
-            trackers.push(t.dup)
-          elsif line =~ NODENAME
-            node_name = $1
-          end
-        end
-        
-        if node_name && trackers.length == 4
-          trackers.each{|t| t.name = "%s_%s" % [node_name, t.name] }
-          return trackers
+    def package_tracker(full_name, xcurve, ycurve)
+      frame_x_and_y = zip_curve_tuples(xcurve, ycurve)
+      Tracksperanto::Tracker.new(:name => full_name) do | t |
+        frame_x_and_y.each do | (f, x, y) |
+            t.keyframe!(:frame => (f -1), :abs_x => x, :abs_y => y) 
         end
       end
-      
-      # Fail
-      return []
     end
     
-    # Scans a tracker node and return all tracks within that node (no more than 4)
-    def scan_tracker_node(io)
-      tracks_in_tracker = []
-      while line = io.gets_and_strip
-        if line =~ TRACK_PATTERN
-          t = extract_tracker(line)
-          tracks_in_tracker.push(t) if t
-        elsif line =~ NODENAME
-          tracks_in_tracker.each_with_index do | t, i |
-            t.name = "#{$1}_track#{i+1}"
-            report_progress("Scavenging Tracker3 node #{t.name}")
-          end
-          return tracks_in_tracker
+    def extract_curves_from_channel(point_channel)
+      u = Tracksperanto::NukeGrammarUtils.new
+      point_channel.to_a.map do | curve_argument | 
+        if curve_argument[0] == "curve"
+          u.parse_curve(curve_argument.to_a)
+        else
+          nil
         end
-      end
-      raise "Tracker node went all the way to end of stream"
+      end.compact
     end
     
-    def scan_track(line_with_curve)
-      x_curve, y_curve = line_with_curve.split(/\}/).map do | one_curve| 
-        Tracksperanto::NukeGrammarUtils.new.parse_curve(one_curve)
-      end
-      return nil unless (x_curve && y_curve)
-      zip_curve_tuples(x_curve, y_curve)
+    def point_channels
+      %w( track1 track2 track3 track4 )
     end
     
-    def extract_tracker(line)
-      tuples = scan_track(line)
-      return nil unless (tuples && tuples.any?)
-      Tracksperanto::Tracker.new do | t |
-        tuples.each do | (f, x, y) |
-            t.keyframe!(:frame => (f -1), :abs_x => x, :abs_y => y) 
-        end
+  end
+  
+  class Reconcile3D < Tracker3
+    def point_channels
+      %w( output)
+    end
+  end
+  
+  class PlanarTracker1_0 < Tracker3
+    def point_channels
+      %w( outputBottomLeft outputBottomRight outputTopLeft outputTopRight)
+    end
+  end
+  
+  class Tracker4 < Tracker3
+    
+    def initialize(options)
+      
+      @name = options["name"]
+      @trackers = []
+      tracks = options["tracks"]
+      preamble = tracks[0]
+      headers = tracks[1]
+      values = tracks[2]
+      
+      table_headers = headers[0].map{|header| header[0][-1]}
+      #puts table_headers.inspect
+      # When this was written, this was the order of the columns in the table:
+      # le("e", "name", "track_x", "track_y", "offset_x", "offset_y", "T", "R", "S", "error", 
+      #  "error_min", "error_max", "pattern_x", "pattern_y", "pattern_r", "pattern_t", "search_x",
+      # "search_y", "search_r", "search_t", "key_track", "key_search_x", "key_search_y", "key_search_r",
+      # "key_search_t", "key_track_x", "key_track_y", "key_track_r", "key_track_t", "key_centre_offset_x", "key_centre_offset_y")
+      tracker_rows = values[0]
+      
+      u = Tracksperanto::NukeGrammarUtils.new
+      
+      tracker_rows.each do | row |
+        row_content = row[0][0]
+        # For offsets see above
+        point_name, x_curve, y_curve = row_content[1], u.parse_curve(row_content[2].to_a), u.parse_curve(row_content[3].to_a)
+        
+        full_name = [options["name"], point_name].join('_')
+        tracker = package_tracker(full_name, x_curve, y_curve)
+        @trackers << tracker
       end
     end
+  end
 end

data/lib/tracksperanto.rb

@@ -3,7 +3,7 @@
 
 module Tracksperanto
   PATH = File.expand_path(File.dirname(__FILE__))
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
   
   module Import; end
   module Export; end

data/test/import/test_nuke_import.rb

@@ -45,7 +45,7 @@ class NukeImportTest < Test::Unit::TestCase
     assert_equal 4, trackers.length
     
     ref_names = %w( PlanarTracker2_outputBottomLeft PlanarTracker2_outputBottomRight 
-      PlanarTracker2_outputTopRight PlanarTracker2_outputTopLeft )
+      PlanarTracker2_outputTopLeft PlanarTracker2_outputTopRight )
     assert_equal ref_names, trackers.map{|e| e.name }
   end
   
@@ -106,6 +106,25 @@ class NukeImportTest < Test::Unit::TestCase
     assert_equal 11, t[5].frame
   end
   
+  def test_parsing_from_nuke7_tracker4
+    fixture = File.open(File.dirname(__FILE__) + '/samples/nuke/nuke7_tracker_2tracks.nk')
+    
+    parser = Tracksperanto::Import::NukeScript.new(:io => fixture)
+    parser.width = 1280
+    parser.height = 720
+    
+    trackers = parser.to_a
+    assert_equal 2, trackers.length
+    assert_equal "Tracker1_track_1", trackers[0].name
+    assert_equal "Tracker1_track_2", trackers[1].name
+    assert_equal 15, trackers[1].length
+    
+    kf = trackers[1][5]
+    assert_in_delta 106.75, kf.abs_x, DELTA
+    assert_in_delta 77.01, kf.abs_y, DELTA
+    assert_equal 9, kf.frame
+  end
+  
   def test_parsing_from_nuke_group
     fixture = File.open(File.dirname(__FILE__) + '/samples/nuke/one_tracker_with_break_in_grp.nk')
     
@@ -124,9 +143,9 @@ class NukeImportTest < Test::Unit::TestCase
   end
   
   def test_parsing_nuke_curve
-    curve = '{curve x742 888 890.2463989 891.6602783 \
-893.5056763 895.6155396 s95 897.2791748 899.1762695 \
-x754 912.0731812 x755 913.7190552 916.0959473 918.1025391 920.0751953 922.1898804}'
+    curve = %w( curve x742 888 890.2463989 891.6602783 
+893.5056763 895.6155396 s95 897.2791748 899.1762695 
+x754 912.0731812 x755 913.7190552 916.0959473 918.1025391 920.0751953 922.1898804 )
     p = Tracksperanto::NukeGrammarUtils.new
     result = p.parse_curve(curve)
     assert_kind_of Array, result

data/tracksperanto.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "tracksperanto"
-  s.version = "3.1.0"
+  s.version = "3.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2013-01-14"
+  s.date = "2013-03-02"
   s.description = "Converts 2D track exports between different apps like Flame, MatchMover, PFTrack..."
   s.email = "me@julik.nl"
   s.executables = ["tracksperanto"]
@@ -212,6 +212,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<tickly>, ["~> 0.0.2"])
       s.add_runtime_dependency(%q<obuf>, ["~> 1.1.0"])
       s.add_runtime_dependency(%q<progressive_io>, ["~> 1.0"])
       s.add_runtime_dependency(%q<flame_channel_parser>, ["~> 4.0"])
@@ -222,7 +223,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<flexmock>, ["~> 0.8"])
       s.add_development_dependency(%q<cli_test>, ["~> 1.0"])
+      s.add_development_dependency(%q<rake-hooks>, [">= 0"])
     else
+      s.add_dependency(%q<tickly>, ["~> 0.0.2"])
       s.add_dependency(%q<obuf>, ["~> 1.1.0"])
       s.add_dependency(%q<progressive_io>, ["~> 1.0"])
       s.add_dependency(%q<flame_channel_parser>, ["~> 4.0"])
@@ -233,8 +236,10 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<flexmock>, ["~> 0.8"])
       s.add_dependency(%q<cli_test>, ["~> 1.0"])
+      s.add_dependency(%q<rake-hooks>, [">= 0"])
     end
   else
+    s.add_dependency(%q<tickly>, ["~> 0.0.2"])
     s.add_dependency(%q<obuf>, ["~> 1.1.0"])
     s.add_dependency(%q<progressive_io>, ["~> 1.0"])
     s.add_dependency(%q<flame_channel_parser>, ["~> 4.0"])
@@ -245,6 +250,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<flexmock>, ["~> 0.8"])
     s.add_dependency(%q<cli_test>, ["~> 1.0"])
+    s.add_dependency(%q<rake-hooks>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tracksperanto
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tickly
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: obuf
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +187,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake-hooks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Converts 2D track exports between different apps like Flame, MatchMover,
   PFTrack...
 email: me@julik.nl
@@ -379,7 +411,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3821362273456769612
+      hash: 2047932148332982909
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: