flame_channel_parser 1.3.0 → 1.3.1

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.3.1 / 2011-05-30
+
+* Add minor fixes and imporvements to the curve extraction bin
+
 === 1.3.0 / 2011-05-20
 
 * Added the Extractor class that does simple per-frame baking to STDOUT

data/README.rdoc

@@ -14,9 +14,15 @@ Thanks to Marijn Eken, Philippe Soeiro and Andre Gagnon for their support and ad
 
 == SYNOPSIS:
 
-Currently there is no application that you can use directly, the parser is now a library that you can use in your own scripts
+To just bake a specific channel, use the bake_flame_channel binary.
+
+    $ bake_flame_channel --channel \"Timing/Timing\" -e 123 /usr/discreet/projects/BZO/timewarp/s02_tw.timewarp > /mnt/3d/curves/shot2_tw.framecurve.txt
+
+To use the library:
     
     require "flame_channel_parser"
+    
+    # Parse the setup into channels
     channels = File.open("TW_Setup.timewarp") do | f |
       FlameChannelParser.parse(f)
     end

data/bin/bake_flame_channel

@@ -6,16 +6,16 @@ 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" +
-  "The output file can be used as Time+Value ASCII input for Nuke\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,
-  "Select the channel to bake (for example in Timewarp setups the useful one is Timing/Timing)"
+  "Select the channel to bake (for example in Timewarp setups the useful one is Timing/Timing)."
 ) {|chan| options[:channel] = chan }
 op.on(" -s", "--startframe FRAME", Integer,
-  "Bake the curve from this specific frame onwards (defaults to the first keyframe in the setup"
+  "Bake the curve from this specific frame onwards (defaults to the first keyframe in the setup)"
 ) {|from| options[:start_frame] = from }
 op.on(" -e", "--endframe FRAME", Integer,
-  "Bake the curve upto this specific frame (defaults to the last keyframe in the setup"
+  "Bake the curve upto this specific frame (defaults to the last keyframe in the setup)"
 ) {|upto| options[:end_frame] = upto }
 op.on(" -f", "--to-file FILENAME",  String, 
   "Write the curve to a file at this path instead of printing it to STDOUT"
@@ -23,7 +23,7 @@ op.on(" -f", "--to-file FILENAME",  String,
 
 op.parse!
 setup_path = ARGV.shift
-raise "No input file path provided" unless setup_path
+raise "No input file path provided. Please see bake_flame_channel --help for usage information" unless setup_path
 
 FlameChannelParser::Extractor.new.extract(setup_path, options)
 options[:destination].close if options[:destination].respond_to?(:close)

data/lib/extractor.rb

@@ -1,22 +1,25 @@
 # Extracts and bakes a specific animation channel
 class FlameChannelParser::Extractor
   
-  DEFAULTS = {:destination => $stdout, :start_frame => nil, :end_frame => nil, :channel => "Timing/Timing" }
+  DEFAULT_CHANNEL_TO_EXTRACT = "Timing/Timing"
+  DEFAULTS = {:destination => $stdout, :start_frame => nil, :end_frame => nil, :channel => DEFAULT_CHANNEL_TO_EXTRACT }
   
   # Raised when a channel is not found in the setup file
-  class ChannelNotFoundError < RuntimeError
-  end
+  class ChannelNotFoundError < RuntimeError; end
+  
+  # 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
   def self.extract(path, options = {})
     options = DEFAULTS.merge(options)
     File.open(path) do | f |
       channels = FlameChannelParser.parse(f)
-      selected_channel = channels.find{|c| options[:channel] == c.name }
+      selected_channel = channels.find{|c| options[:channel] == c.path }
       unless selected_channel
-        message = "Channel not #{options[:channel]}found in this setup (set the channel with the --channel option). Found other channels though:" 
+        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| c.name }.join("\n")
+        message += channels.map{|c| "\t%s\n" % c.path }.join
         raise ChannelNotFoundError, message
       end
       
@@ -31,6 +34,10 @@ class FlameChannelParser::Extractor
     
     from_frame = start_frame || interpolator.first_defined_frame
     to_frame =  end_frame || interpolator.last_defined_frame
+    unless (from_frame && to_frame)
+      raise NoKeyframesError, "This channel probably has no animation so there is no way to automatically tell how many keyframes it has. " +
+        "Please set the start and end frame explicitly."
+    end
     
     (from_frame..to_frame).each do | frame |
       to_io.puts("%d\t%.5f" % [frame, interpolator.sample_at(frame)])

data/lib/flame_channel_parser.rb

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

data/lib/segments.rb

@@ -1,6 +1,8 @@
 require "matrix"
 
-module FlameChannelParser::Segments
+
+# :nodoc:
+module FlameChannelParser::Segments 
   
   # This segment just stays on the value of it's keyframe
   class ConstantSegment
@@ -92,14 +94,14 @@ module FlameChannelParser::Segments
   
   end
   
-  Point = Struct.new(:x, :y, :tanx, :tany)
-
   class BezierSegment < LinearSegment
+    Pt = Struct.new(:x, :y, :tanx, :tany)
+    
     def initialize(x1, x2, y1, y2, t1x, t1y, t2x, t2y)
       @start_frame, @end_frame = x1, x2
       
-      @a = Point.new(x1, y1, t1x, t1y)
-      @b = Point.new(x2, y2, t2x, t2y)
+      @a = Pt.new(x1, y1, t1x, t1y)
+      @b = Pt.new(x2, y2, t2x, t2y)
     end
     
     def value_at(frame)
@@ -254,3 +256,4 @@ module FlameChannelParser::Segments
   end
 end
 
+# :nodoc:

data/test/test_extractor.rb

@@ -4,23 +4,45 @@ require "stringio"
 require File.dirname(__FILE__) + "/../lib/flame_channel_parser"
 
 class TestExtractor < Test::Unit::TestCase
-  def test_basic_op
+  def test_basic_operation
     io = StringIO.new
     FlameChannelParser::Extractor.extract(File.dirname(__FILE__) + "/snaps/RefT_Steadicam.timewarp", :destination => io)
     assert_equal File.read(File.dirname(__FILE__) + "/snaps/RefT_Steadicam_Extraction.txt"), io.string
   end
   
+  def test_channel_selection_by_path_raises_with_not_animated_channel_and_no_start_and_end
+    io = StringIO.new
+    ops = {:destination => io, :channel => "axis1/position/z"}
+    assert_raise(FlameChannelParser::Extractor::NoKeyframesError) do
+      FlameChannelParser::Extractor.extract(File.dirname(__FILE__) + "/snaps/FLEM_curves_example_migrated_to_2012.action", ops)
+    end
+  end
+  
+  def test_channel_selection_by_path_outputs_properly
+    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
+  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
   
+  def test_constant_channels_need_domain_of_definition_on_time
+    assert_raise(FlameChannelParser::Extractor::NoKeyframesError) do
+      FlameChannelParser::Extractor.extract(File.dirname(__FILE__) + "/snaps/RefT_Steadicam.timewarp", :channel => "Mix/Mix")
+    end
+  end
+  
   def test_raises_on_Missing_channel
     assert_raise(FlameChannelParser::Extractor::ChannelNotFoundError) do
       FlameChannelParser::Extractor.extract(File.dirname(__FILE__) + "/snaps/RefT_Steadicam.timewarp", :channel => "foo/bar")
     end
   end
+  
 end

metadata

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