flame_channel_parser 1.3.1 → 1.3.2

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.3.2 / 2011-05-30
+
+* Fix linear extrapolation occurring after linear keyframes, enforce the tangent/increment of zero for linear extrap. segments
+
 === 1.3.1 / 2011-05-30
 
 * Add minor fixes and imporvements to the curve extraction bin
@@ -8,16 +12,6 @@
 * Add bake_flame_channel binary
 * Ensure linear prepolation works when counting to a linear interpolated keyframe
 
-=== 1.2.0 / 2011-05-20
-
-* Ensure single-key channels interpolate correctly
-
-=== 1.1.1 / 2011-05-17
-
-* Added support for 2012 Bezier splines
-
-=== 1.1.1 / 2011-05-17
-
 * Added support for 2012 Bezier splines
   
 === 1.0.0 / 2011-03-21

data/bin/bake_flame_channel

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
-require File.dirname(__FILE__) + '/../lib/flame_channel_parser'
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/flame_channel_parser'
 require 'optparse'
 
 options = {}
 
 op = OptionParser.new
-op.banner = "Usage: bake_flame_channel --channel \"Timing/Timing\" -e 123 /usr/discreet/projects/Luxury/timewarp/shot2_tw.timewarp > /mnt/3d/curves/shot2_tw.framecurve.txt\n" +
+op.banner = "Usage: bake_flame_channel --channel Timing/Timing -e 123 /usr/discreet/projects/Luxury/timewarp/shot2_tw.timewarp > /mnt/3d/curves/shot2_tw.framecurve.txt\n" +
   "The output file can be used as Time+Value ASCII input for Nuke " + 
   "or parsed with any simple script"
 op.on(" -c", "--channel CHANNEL_NAME", String,

data/lib/extractor.rb

@@ -10,27 +10,40 @@ class FlameChannelParser::Extractor
   # Raised when you try to autodetect the length of a channel that has no keyframes
   class NoKeyframesError < RuntimeError; end
   
-  # Pass the path to Flame setup here and you will get the timewarp curve on STDOUT
+  # Raised when you try to bake 0 or negative amount of frames
+  class EmptySegmentError < RuntimeError; end
+  
+  # Pass the path to Flame setup here and you will get the animation curve on the object passed in
+  # the :destionation option (defaults to STDOUT). The following options are accepted:
+  #
+  #  :destination - The object to write the output to, anything that responds to shovel (<<) will do
+  #  :start_frame - From which frame the curve should be baked. Will default to the first keyframe of the curve
+  #  :end_frame - Upto which frame to bake. Will default to the last keyframe of the curve
+  #  :channel - Name of the channel to extract from the setup. Defaults to "Timing/Timing" (timewarp frame)
   def self.extract(path, options = {})
     options = DEFAULTS.merge(options)
-    File.open(path) do | f |
+    File.open(path) do |f|
       channels = FlameChannelParser.parse(f)
-      selected_channel = channels.find{|c| options[:channel] == c.path }
-      unless selected_channel
-        message = "Channel #{options[:channel]} not found in this setup (set the channel with the --channel option). Found other channels though:" 
-        message << "\n"
-        message += channels.map{|c| "\t%s\n" % c.path }.join
-        raise ChannelNotFoundError, message
-      end
-      
-      write_channel(selected_channel, options[:destination], options[:start_frame], options[:end_frame])
+      selected_channel = find_channel_in(channels, options[:channel])
+      interpolator = FlameChannelParser::Interpolator.new(selected_channel)
+      write_channel(interpolator, options[:destination], options[:start_frame], options[:end_frame])
     end
   end
   
   private
   
-  def self.write_channel(channel, to_io, start_frame, end_frame)
-    interpolator = FlameChannelParser::Interpolator.new(channel)
+  def self.find_channel_in(channels, channel_path)
+    selected_channel = channels.find{|c| channel_path == c.path }
+    unless selected_channel
+      message = "Channel #{channel_path.inspect} not found in this setup (set the channel with the --channel option). Found other channels though:" 
+      message << "\n"
+      message += channels.map{|c| "\t%s\n" % c.path }.join
+      raise ChannelNotFoundError, message
+    end
+    selected_channel
+  end
+
+  def self.write_channel(interpolator, to_io, start_frame, end_frame)
     
     from_frame = start_frame || interpolator.first_defined_frame
     to_frame =  end_frame || interpolator.last_defined_frame
@@ -39,8 +52,11 @@ class FlameChannelParser::Extractor
         "Please set the start and end frame explicitly."
     end
     
+    raise EmptySegmentError, "The segment you are trying to bake is too small (it has nothing in it)" if to_frame - from_frame < 1
+    
     (from_frame..to_frame).each do | frame |
-      to_io.puts("%d\t%.5f" % [frame, interpolator.sample_at(frame)])
+      line = "%d\t%.5f\n" % [frame, interpolator.sample_at(frame)]
+      to_io << line
     end
   end
   

data/lib/flame_channel_parser.rb

@@ -1,7 +1,7 @@
 require "delegate"
 
 module FlameChannelParser
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
   
   # Parse a Flame setup into an array of ChannelBlock objects
   def self.parse(io)

data/lib/interpolator.rb

@@ -16,6 +16,7 @@ class FlameChannelParser::Interpolator
   # segments from which samples can be made
   def initialize(channel)
     @segments = []
+    @extrap = channel.extrapolation
     
     # Edge case - channel has no anim at all
     if channel.length.zero?
@@ -31,16 +32,27 @@ class FlameChannelParser::Interpolator
       end
       
       # so we just output it separately
-      @segments << pick_extrapolation(channel.extrapolation, channel[-1])
+      @segments << pick_extrapolation(channel.extrapolation, channel[-2], channel[-1])
     end
   end
   
   # Sample the value of the animation curve at this frame
   def sample_at(frame)
-    segment = @segments.find{|s| s.defines?(frame) }
-    raise "No segment on this curve that can interpolate the value at #{frame}" unless segment
+    # No test files present for now so we turn this off
+    # if [:cycle, :rev_cycle].include?(frame)
+    #   # Recompute the frame number and retry
+    #   unless frame >= first_defined_frame && frame <= last_defined_frame 
+    #     animated_on = (last_defined_frame - first_defined_frame)
+    #     fdiff = if frame < first_defined_frame
+    #       (first_defined_frame - frame) % animated_on
+    #     else
+    #       (frame - last_defined_frame) % animated_on
+    #     end
+    #     sample_from_segments(first_defined_frame + fdiff)
+    #   end
+    # end
     
-    segment.value_at(frame)
+    sample_from_segments(frame)
   end
   
   # Returns the first frame number that is concretely defined as a keyframe
@@ -61,6 +73,12 @@ class FlameChannelParser::Interpolator
   
   private
   
+  def sample_from_segments(at_frame)
+    segment = @segments.find{|s| s.defines?(at_frame) }
+    raise "No segment on this curve that can interpolate the value at #{frame}" unless segment
+    segment.value_at(at_frame)
+  end
+  
   def pick_prepolation(extrap_symbol, first_key, second_key)
     if extrap_symbol == :linear && second_key
       if first_key.interpolation != :linear
@@ -76,9 +94,16 @@ class FlameChannelParser::Interpolator
     end
   end
   
-  def pick_extrapolation(extrap_symbol, last_key)
+  def pick_extrapolation(extrap_symbol, previous_key, last_key)
     if extrap_symbol == :linear
-      LinearExtrapolate.new(last_key.frame, last_key.value, last_key.right_slope)
+      if previous_key && last_key.interpolation == :linear
+        # For linear keys the tangent actually does not do anything, so we need to look a frame
+        # ahead and compute the increment
+        increment = (last_key.value - previous_key.value) / (last_key.frame - previous_key.frame)
+        LinearExtrapolate.new(last_key.frame, last_key.value, increment)
+      else
+        LinearExtrapolate.new(last_key.frame, last_key.value, last_key.right_slope)
+      end
     else
       ConstantExtrapolate.new(last_key.frame, last_key.value)
     end

data/lib/segments.rb

@@ -1,11 +1,9 @@
 require "matrix"
 
-
-# :nodoc:
-module FlameChannelParser::Segments 
+module FlameChannelParser::Segments #:nodoc:
   
   # This segment just stays on the value of it's keyframe
-  class ConstantSegment
+  class ConstantSegment #:nodoc:
   
     NEG_INF = (-1.0/0.0)
     POS_INF = (1.0/0.0)
@@ -30,7 +28,7 @@ module FlameChannelParser::Segments
   end
   
   # This segment linearly interpolates
-  class LinearSegment < ConstantSegment
+  class LinearSegment < ConstantSegment #:nodoc:
   
     def initialize(from_frame, to_frame, value1, value2)
       @vint = (value2 - value1)
@@ -46,7 +44,7 @@ module FlameChannelParser::Segments
   
   # This segment does Hermite interpolation
   # using the Flame algo.
-  class HermiteSegment < LinearSegment
+  class HermiteSegment < LinearSegment #:nodoc:
   
     # In Ruby matrix columns are arrays, so here we go
     HERMATRIX = Matrix[
@@ -94,7 +92,7 @@ module FlameChannelParser::Segments
   
   end
   
-  class BezierSegment < LinearSegment
+  class BezierSegment < LinearSegment #:nodoc:
     Pt = Struct.new(:x, :y, :tanx, :tany)
     
     def initialize(x1, x2, y1, y2, t1x, t1y, t2x, t2y)
@@ -185,7 +183,7 @@ module FlameChannelParser::Segments
   end
   
   # This segment does prepolation of a constant value
-  class ConstantPrepolate < LinearSegment
+  class ConstantPrepolate < LinearSegment #:nodoc:
     def initialize(upto_frame, base_value)
       @value = base_value
       @end_frame = upto_frame
@@ -198,13 +196,12 @@ module FlameChannelParser::Segments
   end
   
   # This segment does prepolation with a linear coefficient
-  class LinearPrepolate < LinearSegment
+  class LinearPrepolate < LinearSegment #:nodoc:
     def initialize(upto_frame, base_value, tangent)
       @value = base_value
       @end_frame = upto_frame
       @start_frame = NEG_INF
       @tangent = tangent.to_f
-      
     end
     
     def value_at(frame)
@@ -214,7 +211,7 @@ module FlameChannelParser::Segments
   end
   
   # This segment does extrapolation using a constant value
-  class ConstantExtrapolate < LinearSegment
+  class ConstantExtrapolate < LinearSegment #:nodoc:
     def initialize(from_frame, base_value)
       @start_frame = from_frame
       @base_value = base_value
@@ -227,10 +224,10 @@ module FlameChannelParser::Segments
   end
   
   # This segment does extrapolation using the tangent from the preceding keyframe
-  class LinearExtrapolate < ConstantExtrapolate
+  class LinearExtrapolate < ConstantExtrapolate #:nodoc:
     def initialize(from_frame, base_value, tangent)
       super(from_frame, base_value)
-      @tangent = tangent
+      @tangent = tangent.to_f
     end
   
     def value_at(frame)
@@ -240,7 +237,7 @@ module FlameChannelParser::Segments
   end
   
   # This can be used for an anim curve that stays constant all along
-  class ConstantFunction < ConstantSegment
+  class ConstantFunction < ConstantSegment #:nodoc:
   
     def defines?(frame)
       true
@@ -255,5 +252,3 @@ module FlameChannelParser::Segments
     end
   end
 end
-
-# :nodoc:

data/test/snaps/RefT_Steadicam_Extraction_F19_to_347.txt

@@ -210,120 +210,120 @@
 228	5.00000
 229	3.00000
 230	1.00000
-231	-0.57143
-232	-2.14286
-233	-3.71429
-234	-5.28572
-235	-6.85715
-236	-8.42858
-237	-10.00001
-238	-11.57144
-239	-13.14287
-240	-14.71430
-241	-16.28573
-242	-17.85716
-243	-19.42859
-244	-21.00002
-245	-22.57145
-246	-24.14288
-247	-25.71431
-248	-27.28574
-249	-28.85717
-250	-30.42860
-251	-32.00003
-252	-33.57146
-253	-35.14289
-254	-36.71432
-255	-38.28575
-256	-39.85718
-257	-41.42861
-258	-43.00004
-259	-44.57147
-260	-46.14290
-261	-47.71433
-262	-49.28576
-263	-50.85719
-264	-52.42862
-265	-54.00005
-266	-55.57148
-267	-57.14291
-268	-58.71434
-269	-60.28577
-270	-61.85720
-271	-63.42863
-272	-65.00006
-273	-66.57149
-274	-68.14292
-275	-69.71435
-276	-71.28578
-277	-72.85721
-278	-74.42864
-279	-76.00007
-280	-77.57150
-281	-79.14293
-282	-80.71436
-283	-82.28579
-284	-83.85722
-285	-85.42865
-286	-87.00008
-287	-88.57151
-288	-90.14294
-289	-91.71437
-290	-93.28580
-291	-94.85723
-292	-96.42866
-293	-98.00009
-294	-99.57152
-295	-101.14295
-296	-102.71438
-297	-104.28581
-298	-105.85724
-299	-107.42867
-300	-109.00010
-301	-110.57153
-302	-112.14296
-303	-113.71439
-304	-115.28582
-305	-116.85725
-306	-118.42868
-307	-120.00011
-308	-121.57154
-309	-123.14297
-310	-124.71440
-311	-126.28583
-312	-127.85726
-313	-129.42869
-314	-131.00012
-315	-132.57155
-316	-134.14298
-317	-135.71441
-318	-137.28584
-319	-138.85727
-320	-140.42870
-321	-142.00013
-322	-143.57156
-323	-145.14299
-324	-146.71442
-325	-148.28585
-326	-149.85728
-327	-151.42871
-328	-153.00014
-329	-154.57157
-330	-156.14300
-331	-157.71443
-332	-159.28586
-333	-160.85729
-334	-162.42872
-335	-164.00015
-336	-165.57158
-337	-167.14301
-338	-168.71444
-339	-170.28587
-340	-171.85730
-341	-173.42873
-342	-175.00016
-343	-176.57159
-344	-178.14302
-345	-179.71445
-346	-181.28588
-347	-182.85731
+231	-1.00000
+232	-3.00000
+233	-5.00000
+234	-7.00000
+235	-9.00000
+236	-11.00000
+237	-13.00000
+238	-15.00000
+239	-17.00000
+240	-19.00000
+241	-21.00000
+242	-23.00000
+243	-25.00000
+244	-27.00000
+245	-29.00000
+246	-31.00000
+247	-33.00000
+248	-35.00000
+249	-37.00000
+250	-39.00000
+251	-41.00000
+252	-43.00000
+253	-45.00000
+254	-47.00000
+255	-49.00000
+256	-51.00000
+257	-53.00000
+258	-55.00000
+259	-57.00000
+260	-59.00000
+261	-61.00000
+262	-63.00000
+263	-65.00000
+264	-67.00000
+265	-69.00000
+266	-71.00000
+267	-73.00000
+268	-75.00000
+269	-77.00000
+270	-79.00000
+271	-81.00000
+272	-83.00000
+273	-85.00000
+274	-87.00000
+275	-89.00000
+276	-91.00000
+277	-93.00000
+278	-95.00000
+279	-97.00000
+280	-99.00000
+281	-101.00000
+282	-103.00000
+283	-105.00000
+284	-107.00000
+285	-109.00000
+286	-111.00000
+287	-113.00000
+288	-115.00000
+289	-117.00000
+290	-119.00000
+291	-121.00000
+292	-123.00000
+293	-125.00000
+294	-127.00000
+295	-129.00000
+296	-131.00000
+297	-133.00000
+298	-135.00000
+299	-137.00000
+300	-139.00000
+301	-141.00000
+302	-143.00000
+303	-145.00000
+304	-147.00000
+305	-149.00000
+306	-151.00000
+307	-153.00000
+308	-155.00000
+309	-157.00000
+310	-159.00000
+311	-161.00000
+312	-163.00000
+313	-165.00000
+314	-167.00000
+315	-169.00000
+316	-171.00000
+317	-173.00000
+318	-175.00000
+319	-177.00000
+320	-179.00000
+321	-181.00000
+322	-183.00000
+323	-185.00000
+324	-187.00000
+325	-189.00000
+326	-191.00000
+327	-193.00000
+328	-195.00000
+329	-197.00000
+330	-199.00000
+331	-201.00000
+332	-203.00000
+333	-205.00000
+334	-207.00000
+335	-209.00000
+336	-211.00000
+337	-213.00000
+338	-215.00000
+339	-217.00000
+340	-219.00000
+341	-221.00000
+342	-223.00000
+343	-225.00000
+344	-227.00000
+345	-229.00000
+346	-231.00000
+347	-233.00000

data/test/test_extractor.rb

@@ -22,14 +22,23 @@ class TestExtractor < Test::Unit::TestCase
     io = StringIO.new
     ops = {:destination => io, :channel => "axis1/position/y"}
     FlameChannelParser::Extractor.extract(File.dirname(__FILE__) + "/snaps/FLEM_curves_example_migrated_to_2012.action", ops)
-    assert_match /12	-101.80433/, io.string
+    line_re = /12	-101.80433/
+    assert_match line_re , io.string
   end
   
+  def test_extraction_succeeds_for_tw_with_odd_end
+    io = StringIO.new
+    ops = {:start_frame => 1, :end_frame => 504, :destination => io, :channel => "Timing/Timing"}
+    FlameChannelParser::Extractor.extract(File.dirname(__FILE__) + "/snaps/timewarp_where_interp_fails_at_end.timewarp", ops)
+    line_re = /1\t-7.00000\n2\t-6.00000/
+    assert_match line_re , io.string
+  end
   
   def test_frame_overrides
     io = StringIO.new
     o = {:destination => io, :start_frame => 19, :end_frame => 347 }
     FlameChannelParser::Extractor.extract(File.dirname(__FILE__) + "/snaps/RefT_Steadicam.timewarp", o)
+    
     assert_equal File.read(File.dirname(__FILE__) + "/snaps/RefT_Steadicam_Extraction_F19_to_347.txt"), io.string
   end
   

data/test/test_interpolator.rb

@@ -116,6 +116,17 @@ class TestInterpolator < Test::Unit::TestCase
     assert_in_delta 1, interp.sample_at(230), DELTA
   end
   
+  def test_ascending_linear_extrapolation_on_baked_curve
+    data = File.open(File.dirname(__FILE__) + "/snaps/timewarp_where_interp_fails_at_end.timewarp")
+    channels_in_tw = FlameChannelParser.parse(data)
+    chan = channels_in_tw.find{|c| c.name == "Timing/Timing"}
+    interp = chan.to_interpolator
+    assert_in_delta -7, interp.sample_at(1), DELTA
+    assert_in_delta 492, interp.sample_at(502), DELTA
+    assert_in_delta 492, interp.sample_at(502), DELTA
+    assert_in_delta 494, interp.sample_at(504), DELTA
+  end
+  
   def test_descending_linear_prepolate_two_KFs
     data = File.open(File.dirname(__FILE__) + "/snaps/RefT_Steadicam_TwoKFs.timewarp")
     channels_in_tw = FlameChannelParser.parse(data)
@@ -125,7 +136,7 @@ class TestInterpolator < Test::Unit::TestCase
     assert_in_delta 459, interp.sample_at(1), DELTA
     assert_in_delta 421, interp.sample_at(20), DELTA
     assert_in_delta 1, interp.sample_at(230), DELTA
-    assert_in_delta -39, interp.sample_at(250), DELTA
+    assert_in_delta( -39, interp.sample_at(250), DELTA)
   end
   
   def test_descending_linear_prepolate_two_KFs_different_slope

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flame_channel_parser
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 1
   - 3
-  - 1
-  version: 1.3.1
+  - 2
+  version: 1.3.2
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-03 00:00:00 +02:00
+date: 2011-06-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency