flame_channel_parser 3.0.0 → 4.0.0

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem "update_hints", "~> 1.0"
+gem "framecurve", "~> 1.0.1"
+
+group :development do
+  gem "jeweler"
+  gem "rake"
+  gem "cli_test", "~>1.0"
+end

data/History.txt

@@ -1,3 +1,8 @@
+=== 4.0.0 / 2011-09-11
+
+* Integrate the Framecurve library. Parse TO framecurve as well as FROM to all supported timewarpers
+* Support new XML batch node setups
+
 === 3.0.0 / 2011-09-11
 
 * Allow for channels to be passed to a block instead of being collected into an array

data/README.rdoc

@@ -18,9 +18,11 @@ 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
 
-If you just need to process a timewarp, use the bake_flame_timewarp which autodetects most of the settings by itself
+If you just need to process a timewarp, use the bake_flame_timewarp which autodetects most of the settings by itself and gives you a nice .framecurve.txt file
 
-    $bake_flame_timewarp /usr/discreet/projects/BZO/timewarp/s02_tw.timewarp > /mnt/3d/curves/shot2_tw.framecurve.txt
+    $framecurve_from_flame /usr/discreet/projects/BZO/timewarp/s02_tw.timewarp
+    
+This will create a framecurve file called s02_tw.timewarp.framecurve.txt next to the setup
 
 To use the library:
     

data/Rakefile

@@ -1,17 +1,30 @@
 # -*- ruby -*-
 
 require 'rubygems'
-require 'hoe'
+require 'jeweler'
+require './lib/flame_channel_parser'
 
-Hoe::RUBY_FLAGS.gsub!(/^\-w/, '') # No thanks undefined ivar warnings
-Hoe.spec 'flame_channel_parser' do | p |
-  p.developer('Julik Tarkhanov', 'me@julik.nl')
-  
-  p.readme_file   = 'README.rdoc'
-  p.extra_rdoc_files  = FileList['*.rdoc'] + FileList['*.txt']
-  p.extra_deps = {"update_hints" => ">=0" }
-  p.extra_dev_deps = {"cli_test" => "~> 1.0.0" }
-  p.clean_globs = File.read(".gitignore").split("\n")
+Jeweler::Tasks.new do |gem|
+  gem.version = FlameChannelParser::VERSION
+  gem.name = "flame_channel_parser"
+  gem.summary = "A parser/interpolator for Flame/Smoke animation curves"
+  gem.description = "Reads and interpolates animation channels in IFFS setups"
+  gem.email = "me@julik.nl"
+  gem.homepage = "http://guerilla-di.org/flame-channel-parser/"
+  gem.authors = ["Julik Tarkhanov"]
+  gem.license = 'MIT'
 end
 
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+desc "Run all tests"
+Rake::TestTask.new("test") do |t|
+  t.libs << "test"
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
+end
+
+task :default => [ :test ]
+
 # vim: syntax=ruby

data/bin/{bake_flame_timewarp → framecurve_from_flame}

@@ -28,6 +28,10 @@ unless File.exist?(setup_path)
   exit -1
 end
 
-FlameChannelParser::TimewarpExtractor.new.extract(setup_path, options)
+# Setup the destination
+destination_path = setup_path.gsub(/\.(\w+)$/, '.framecurve.txt')
+File.open(destination_path, "wb") do | f |
+  FlameChannelParser::TimewarpExtractor.new.extract(setup_path, options.merge(:destination => f))
+end
 
 UpdateHints.version_check("flame_channel_parser", FlameChannelParser::VERSION, $stderr)

data/bin/framecurve_to_flame

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/flame_channel_parser'
+require 'optparse'
+require "update_hints"
+
+op = OptionParser.new
+op.banner = "Usage: framecurve_to_flame /usr/discreet/projects/ExpensiveDildo/timewarp/shot2_tw.framecurve.txt"
+op.parse!
+
+fc_path = ARGV.shift
+fail("No input file path provided.") unless fc_path
+fail("File %s does not exist." % fc_path) unless File.exist?(fc_path)
+
+curve = Framecurve::Parser.new.parse(fc_path)
+FlameChannelParser::FramecurveWriters::Base.with_each_writer do | writer_class |
+  filename = [fc_path, writer_class.extension].join
+  File.open(filename, "wb") do | f |
+    writer_class.new.run_export_from_framecurve(f, curve)
+  end
+end
+
+UpdateHints.version_check("flame_channel_parser", FlameChannelParser::VERSION, $stderr)

data/flame_channel_parser.gemspec

@@ -0,0 +1,130 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "flame_channel_parser"
+  s.version = "4.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2011-12-30"
+  s.description = "Reads and interpolates animation channels in IFFS setups"
+  s.email = "me@julik.nl"
+  s.executables = ["bake_flame_channel", "framecurve_from_flame", "framecurve_to_flame"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+    ".travis.yml",
+    "Gemfile",
+    "History.txt",
+    "README.rdoc",
+    "Rakefile",
+    "bin/bake_flame_channel",
+    "bin/framecurve_from_flame",
+    "bin/framecurve_to_flame",
+    "flame_channel_parser.gemspec",
+    "lib/builder.rb",
+    "lib/channel.rb",
+    "lib/extractor.rb",
+    "lib/flame_channel_parser.rb",
+    "lib/framecurve_writers/base.rb",
+    "lib/framecurve_writers/batch_timewarp.rb",
+    "lib/framecurve_writers/kronos.rb",
+    "lib/framecurve_writers/softfx_timewarp.rb",
+    "lib/framecurve_writers/templates/BatchTW.xml",
+    "lib/framecurve_writers/templates/SampleKronos.F_Kronos",
+    "lib/framecurve_writers/templates/TW_Sample.timewarp",
+    "lib/framecurve_writers/templates/key.xml",
+    "lib/interpolator.rb",
+    "lib/key.rb",
+    "lib/parser.rb",
+    "lib/segments.rb",
+    "lib/timewarp_extractor.rb",
+    "lib/xml_parser.rb",
+    "test/channel_with_constants.dat",
+    "test/helper.rb",
+    "test/sample_channel.dat",
+    "test/snaps/BatchTimewar_proper.xml",
+    "test/snaps/BatchTimewarp_ext1.timewarp_node",
+    "test/snaps/Cycle_and_revcycle.action",
+    "test/snaps/FLEM_BrokenTangents.action",
+    "test/snaps/FLEM_advanced_curve.png",
+    "test/snaps/FLEM_advanced_curve_example_FL2012.action",
+    "test/snaps/FLEM_baked_curve.png",
+    "test/snaps/FLEM_curves_example.action",
+    "test/snaps/FLEM_curves_example_migrated_to_2012.action",
+    "test/snaps/FLEM_std_curve.png",
+    "test/snaps/RefT_Steadicam.timewarp",
+    "test/snaps/RefT_Steadicam_Baked.timewarp",
+    "test/snaps/RefT_Steadicam_Extraction.txt",
+    "test/snaps/RefT_Steadicam_Extraction_F19_to_347.txt",
+    "test/snaps/RefT_Steadicam_TwoKFs.timewarp",
+    "test/snaps/RefT_Steadicam_TwoKFs_AnotherSlope.timewarp",
+    "test/snaps/RefT_Steadicam_TwoKFs_HermiteAtBegin.timewarp",
+    "test/snaps/TW.timewarp",
+    "test/snaps/TW_015_010_v03.timewarp",
+    "test/snaps/TW_SingleFrameExtrapolated_from2011.timewarp",
+    "test/snaps/TW_TEST.F_Kronos",
+    "test/snaps/timewarp_where_interp_fails_at_end.timewarp",
+    "test/test_base_timewarp_writer.rb",
+    "test/test_batch_timewarp_writer.rb",
+    "test/test_channel.rb",
+    "test/test_cli.rb",
+    "test/test_cli_framecurve_to_flame.rb",
+    "test/test_cli_timewarp_extractor.rb",
+    "test/test_extractor.rb",
+    "test/test_flame_builder.rb",
+    "test/test_flame_channel_parser.rb",
+    "test/test_interpolator.rb",
+    "test/test_key.rb",
+    "test/test_kronos_timewarp_writer.rb",
+    "test/test_segments.rb",
+    "test/test_softfx_timewarp_writer.rb",
+    "test/test_timewarp_extractor.rb",
+    "test/test_xml_setup.rb",
+    "test/timewarp_examples/TW_015_010_v01_Baked.timewarp",
+    "test/timewarp_examples/TW_016_010_v01.timewarp",
+    "test/timewarp_examples/TW_016_010_v01_Baked.timewarp",
+    "test/timewarp_examples/TW_16_010_v01.output.txt",
+    "test/timewarp_examples/TW_TEST.F_Kronos",
+    "test/timewarp_examples/output.txt",
+    "test/timewarp_examples/simple.framecurve.txt",
+    "test/timewarp_export_samples/BatchTW.timewarp_node",
+    "test/timewarp_export_samples/Kronos.F_Kronos",
+    "test/timewarp_export_samples/SoftFX.timewarp"
+  ]
+  s.homepage = "http://guerilla-di.org/flame-channel-parser/"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "A parser/interpolator for Flame/Smoke animation curves"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<update_hints>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<framecurve>, ["~> 1.0.1"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<cli_test>, ["~> 1.0"])
+    else
+      s.add_dependency(%q<update_hints>, ["~> 1.0"])
+      s.add_dependency(%q<framecurve>, ["~> 1.0.1"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<cli_test>, ["~> 1.0"])
+    end
+  else
+    s.add_dependency(%q<update_hints>, ["~> 1.0"])
+    s.add_dependency(%q<framecurve>, ["~> 1.0.1"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<cli_test>, ["~> 1.0"])
+  end
+end
+

data/lib/builder.rb

@@ -0,0 +1,86 @@
+# A Builder-like class for exporting Flame setups
+class FlameChannelParser::Builder #< BasicObject
+  INDENT = "\t"
+  
+  def initialize(io, indent = 0)
+    @io, @indent = io, indent
+  end
+  
+  # Writes a block of values delimited by "End" terminators.
+  # Will yield a nested Builder objectg which 
+  def write_block!(name, value = nil, &blk)
+    value.nil? ? write_loose!(name) : write_tuple!(name, value)
+    yield(self.class.new(@io, @indent + 1))
+    @io.puts(INDENT * (@indent + 1) + "End")
+  end
+  
+  # Write an unterminated block of values
+  def write_unterminated_block!(name, value = nil, &blk)
+    value.nil? ? write_loose!(name) : write_tuple!(name, value)
+    yield(self.class.new(@io, @indent + 1))
+  end
+  
+  # Write a tuple of "Parameter Value", like "Frame 13"
+  def write_tuple!(key, value)
+    @io.puts("%s%s %s" % [INDENT * @indent, __camelize(key), __flameize(value)])
+  end
+  
+  # Write a number of linebreaks
+  def write_loose!(value)
+    @io.puts("%s%s" % [INDENT * @indent, __camelize(value)])
+  end
+  
+  # Write a number of linebreaks
+  def linebreak!(how_many = 1)
+    @io.write("\n" * how_many)
+  end
+  
+  # Write a color hash with the right order of values
+  def color_hash!(name, red, green, blue)
+    write_unterminated_block!(name) do | b |
+      b.red(red)
+      b.green(green)
+      b.blue(blue)
+    end
+  end
+  
+  # Append the text passed to the setup. The appended
+  # lines will be prepended by the indent of the current builder
+  def <<(some_verbatim_string)
+    some_verbatim_string.split("\n").each do | line |
+      @io.puts(["\t" * @indent, line].join)
+    end
+  end
+  
+  private
+  
+  def method_missing(meth, arg = nil)
+    if block_given?
+      write_block!(meth, arg) {|c| yield(c) }
+    else
+      if arg.nil?
+        write_loose!(meth)
+      else
+        write_tuple!(meth, arg)
+      end
+    end
+  end
+  
+  def __camelize(s)
+    @@camelizations ||= {}
+    @@camelizations[s] ||= s.to_s.gsub(/(^|_)(.)/) { $2.upcase }
+  end
+  
+  def __flameize(v)
+    case v
+      when Float
+        "%.3f" % v
+      when TrueClass
+        "yes"
+      when FalseClass
+        "no"
+      else
+        v.to_s
+    end
+  end
+end

data/lib/flame_channel_parser.rb

@@ -1,18 +1,45 @@
 module FlameChannelParser
-  VERSION = '3.0.0'
+  VERSION = '4.0.0'
+  
+  module FramecurveWriters; end
   
   # Parse a Flame setup into an array of Channel objects.
   # If a block is given to the method it will yield Channel
   # objects one by one instead of accumulating them into an array (useful for big setups)
   def self.parse(io)
+    c = get_parser_class(io)
     if block_given?
-      Parser.new.parse(io, &Proc.new)
+      c.new.parse(io, &Proc.new)
     else
-      Parser.new.parse(io)
+      c.new.parse(io)
     end
   end
+  
+  # Parse a Flame setup at passed path. Will return the channels instead of yielding them
+  def self.parse_file_at(path)
+    File.open(path, &method(:parse))
+  end
+  
+  private
+  
+  # Returns the XML parser class for XML setups
+  def self.get_parser_class(for_io)
+    tokens = %w( <Setup> <?xml )
+    current = for_io.pos
+    tokens.each do | token |
+      for_io.rewind
+      return XMLParser if for_io.read(token.size) == token
+    end
+    return Parser
+  ensure
+    for_io.seek(current)
+  end
 end
 
 %w(
-  key channel parser segments interpolator extractor timewarp_extractor
+  key channel parser segments interpolator extractor timewarp_extractor builder xml_parser
 ).each {|f| require File.expand_path(File.dirname(__FILE__) + "/" + f ) }
+
+%w(
+  base softfx_timewarp batch_timewarp kronos 
+).each {|f| require File.expand_path(File.dirname(__FILE__) + "/framecurve_writers/" + f ) }

data/lib/framecurve_writers/base.rb

@@ -0,0 +1,49 @@
+# Writes out a framecurve setup
+class FlameChannelParser::FramecurveWriters::Base
+  class KeyWriter
+    attr_reader :keys
+    def initialize
+      @keys = []
+    end
+    
+    def key(at, value)
+      @keys.push([at.to_i,value.to_f])
+    end
+    
+  end
+  
+  def self.inherited(by)
+    @@writers ||= []
+    @@writers.push(by)
+  end
+  
+  # Yields each defined writer class to the block
+  def self.with_each_writer
+    @@writers.each(&Proc.new)
+  end
+  
+  # Should return the desired extension for the exported file
+  def self.extension
+    '.timewarp'
+  end
+  
+  # Run the exporter writing the result to the passed IO. Will yield a KeyWriter
+  # to the caller for writing frames (call key(at, value) on it)
+  def run_export(io)
+    w = KeyWriter.new
+    yield(w)
+    w.keys.each do | at, value |
+      io.puts("%d %.5f" % [at, value])
+    end
+  end
+  
+  # Run the exporter writing the result to it, and pulling framecurve frames from the passed Curve
+  # object
+  def run_export_from_framecurve(io, curve)
+    run_export(io) do | writer |
+      curve.to_materialized_curve.each_tuple do | t |
+        writer.key(t.at, t.value)
+      end
+    end
+  end
+end

data/lib/framecurve_writers/batch_timewarp.rb

@@ -0,0 +1,41 @@
+# Writes out a Batch timewarp node setup
+class FlameChannelParser::FramecurveWriters::BatchTimewarp < FlameChannelParser::FramecurveWriters::SoftfxTimewarp
+  
+  TEMPLATE = File.dirname(__FILE__) + "/templates/BatchTW.xml"
+  TEMPLATE_KEY = File.dirname(__FILE__) + "/templates/key.xml"
+  
+  def self.extension
+    '.timewarp_node'
+  end
+  
+  def run_export(io)
+    w = KeyWriter.new
+    yield(w)
+    keys = w.keys
+    
+    keys_data = ''
+    keys.each_with_index do | k, idx |
+      keys_data << templatize(TEMPLATE_KEY, :frame => k[0].to_i, :value => k[1].to_f, :idx => idx)
+    end
+    
+    # Whole range BOTH in the source and destination
+    used_frames = (keys.map{|k| k[1]} + keys.map{|k| k[0]}).sort
+    first_frame, last_frame = used_frames[0], used_frames[-1]
+    
+    info = {:start_frame => first_frame, :last_frame => last_frame, :first_value => keys[0][1], :key_size => keys.size, :keys => keys_data }
+    io.write(templatize(TEMPLATE, info))
+  end
+  
+  private
+  def templatize(file, hash)
+    t = File.read(file)
+    hash.each_pair do | pattern, value |
+      p = Regexp.escape('$%s' % pattern)
+      handle = Regexp.new(p, [Regexp::MULTILINE, Regexp::EXTENDED])
+      t.gsub!(handle, value.to_s)
+    end
+    raise "Not all substitutions done" if t.include?('$')
+    
+    return t
+  end
+end