flame_timewarp_extractor 0.0.2 → 1.1.0

data/History.txt

@@ -1,3 +1,11 @@
+=== 1.1.0 / 2011-05-17
+
+* Update the dependency version
+
+=== 1.0.0 / 2011-05-13
+
+* Use the flame_channel_parser_gem
+
 === 0.0.2 / 2011-03-21
 
 * Specify the missing Tracksperanto dependency

data/Manifest.txt

@@ -1,6 +1,6 @@
 History.txt
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 bin/flametwextract
 lib/flame_timewarp_extractor.rb

data/{README.txt → README.rdoc}

@@ -4,8 +4,7 @@
 
 == DESCRIPTION:
 
-Extract timewarp channels from Flame setup files, for usage in say Maya or Houdini or whathaveyou.
-
+Extract timewarp channels from Flame setup files into a simple list of "to-frame" to "from-frame" mappings.
 
 == SYNOPSIS:
 

data/Rakefile

@@ -4,8 +4,9 @@ require 'rubygems'
 require 'hoe'
 
 Hoe.spec 'flame_timewarp_extractor' do | s |
+  s.readme_file   = 'README.rdoc'
   s.developer('Julik', 'me@julik.nl')
-  s.extra_deps = {"tracksperanto" => ">=1.9.6"}
+  s.extra_deps = {"flame_channel_parser" => ">=1.1.1"}
 end
 
 # vim: syntax=ruby

data/bin/flametwextract

@@ -1,4 +1,3 @@
 #!/usr/bin/env ruby
 require File.dirname(__FILE__) + '/../lib/flame_timewarp_extractor'
-
 FlameTimewarpExtractor.new.extract(ARGV.shift)

data/lib/flame_timewarp_extractor.rb

@@ -1,79 +1,35 @@
 require "rubygems"
-require "tracksperanto"
+require "flame_channel_parser"
 
 class FlameTimewarpExtractor
   
-  VERSION = "0.0.2"
-  
-  class Output
-    def initialize(io, first_f, last_f)
-      @io, @first, @last = io, first_f, last_f
-    end
-    attr_reader :output_header, :output_tail
-    def write_kf(to_f, from_f)
-    end
-  end
-  
-  class Import < Tracksperanto::Import::FlameStabilizer
-    def initialize
-      @progress_block = nil
-    end
-    
-    def channel_is_useful?(name)
-      true
-    end
-    
-    def extract_channels(from_io)
-      extract_channels_from_stream(from_io)
-    end
-  end
-  
-  class OutputChan < Output
-    def write_kf(to_f, from_f)
-      @io.puts("%d\t%.5f" % [to_f, from_f])
-    end
-  end
+  VERSION = "1.1.0"
   
   CHANNELS = %( Timing/Timing  Frame )
   
-  def extract(path)
-    f = File.open(path)
-    channels = Import.new.extract_channels(f)
-    timing_channel = channels.find{|c| CHANNELS.include?(c.name) }
-    raise "No timing channel found in this setup" unless timing_channel
-    
-    write_channel(timing_channel)
+  # Pass the path to the Kronos or Timewarp setup here and you will get the timewarp curve on STDOUT
+  def extract(path, to_io = $stdout)
+    File.open(path) do | f |
+      channels = FlameChannelParser.parse(f)
+      
+      timing_channel = channels.find{|c| CHANNELS.include?(c.name) }
+      raise "No timing channel found in this setup" unless timing_channel
+      
+      write_channel(timing_channel, to_io)
+    end
   end
   
   private
   
-  def write_channel(ch)
+  def write_channel(channel, to_io)
+    interpolator = FlameChannelParser::Interpolator.new(channel)
+    
+    from_frame = interpolator.first_defined_frame
+    to_frame = interpolator.last_defined_frame
     
-    o = OutputChan.new($stdout, ch[0][0], (ch[0][0] + ch.length))
-    o.output_header
-    last_at, last_value = nil, nil
-    ch.each do | at, value |
-      last_at, last_value = lerp(last_at, last_value, at, value) do | interp_at, interp_value |
-        o.write_kf(interp_at, interp_value)
-      end
+    (from_frame..to_frame).each do | frame |
+      to_io.puts("%d\t%.5f" % [frame, interpolator.sample_at(frame)])
     end
-    o.output_tail
   end
   
-  # Do a simple linear interpolxion. The function will yield
-  # the interim X and Y, one tuple per whole value between the set points,
-  # and return the last tuple (so you can return-assign from it in a loop)
-  def lerp(last_x, last_y, x, y) #:yields: interp_x, interp_y
-    if last_x.nil?
-      yield(x, y)
-    else
-      gap_size = x - last_x
-      increment = (y.to_f - last_y) / gap_size.to_f
-      (1..gap_size).each do | index |
-        yield(last_x + index, last_y + (increment * index))
-      end
-    end
-    
-    return [x, y]
-  end
 end

data/test/test_twextract.rb

@@ -3,17 +3,44 @@ require "flame_timewarp_extractor"
 require "stringio"
 
 class TestTwextract < Test::Unit::TestCase
-  def test_parse
-    bkup = $stdout
-    output = StringIO.new
-    begin
-      $stdout = output
-      FlameTimewarpExtractor.new.extract(File.dirname(__FILE__) + "/samples/TW_015_010_v01_Baked.timewarp")
-    ensure
-      $stdout = bkup
-    end
+  def test_parse_with_basic_baked_setup
+    io = StringIO.new
+    FlameTimewarpExtractor.new.extract(File.dirname(__FILE__) + "/samples/TW_015_010_v01_Baked.timewarp", io)
+    
+    compare_outputs(File.read(File.dirname(__FILE__) + "/samples/output.txt"), io.string)
+  end
+  
+  def test_parse_with_interpolated_setup
+    interpolated_io = StringIO.new
+    baked_io = StringIO.new
+    
+    FlameTimewarpExtractor.new.extract(File.dirname(__FILE__) + "/samples/TW_016_010_v01.timewarp", interpolated_io)
+    FlameTimewarpExtractor.new.extract(File.dirname(__FILE__) + "/samples/TW_016_010_v01_Baked.timewarp", baked_io)
     
-    ref = File.read(File.dirname(__FILE__) + "/samples/output.txt")
-    assert_equal ref, output.string, "Should have the same output"
+    compare_outputs(baked_io.string, interpolated_io.string)
+  end
+  
+  private
+  D = 0.1
+  
+  def compare_outputs(ref, out)
+    ref = ref.split("\n")
+    out = out.split("\n")
+    
+    puts ref
+    puts out
+    
+    ref.zip(out).each_with_index do | (reference_line, output_line), lineno |
+      assert_not_nil output_line, "at #{lineno} the output should not be shorter than the reference"
+      assert_not_nil reference_line, "at #{lineno} the output should not be longer than the reference"
+      
+      from_f, from_d = reference_line.strip.split
+      to_f, to_d = output_line.strip.split
+      
+      assert_equal from_f, to_f, "at #{lineno} the line should have the same frame"
+      
+      assert_in_delta from_d.to_f, to_d.to_f, D, "At frame #{to_f}"
+    end
   end
+  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flame_timewarp_extractor
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 19
   prerelease: 
   segments: 
+  - 1
+  - 1
   - 0
-  - 0
-  - 2
-  version: 0.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Julik
@@ -15,23 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-21 00:00:00 +01:00
+date: 2011-05-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: tracksperanto
+  name: flame_channel_parser
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 63
+        hash: 17
         segments: 
         - 1
-        - 9
-        - 6
-        version: 1.9.6
+        - 1
+        - 1
+        version: 1.1.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,7 @@ dependencies:
         version: 2.9.1
   type: :development
   version_requirements: *id002
-description: Extract timewarp channels from Flame setup files, for usage in say Maya or Houdini or whathaveyou.
+description: Extract timewarp channels from Flame setup files into a simple list of "to-frame" to "from-frame" mappings.
 email: 
 - me@julik.nl
 executables: 
@@ -60,11 +60,10 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
 files: 
 - History.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - bin/flametwextract
 - lib/flame_timewarp_extractor.rb
@@ -79,7 +78,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -106,6 +105,6 @@ rubyforge_project: flame_timewarp_extractor
 rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
-summary: Extract timewarp channels from Flame setup files, for usage in say Maya or Houdini or whathaveyou.
+summary: Extract timewarp channels from Flame setup files into a simple list of "to-frame" to "from-frame" mappings.
 test_files: 
 - test/test_twextract.rb