flame_channel_parser 4.0.2 → 4.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63ea2d0b36c71708aed053a7e899fe45a90144f09a76a539bfde0fa75cebdbba
+  data.tar.gz: a28e90fce5c379defb431679b1593f5e9b1a02e1a69ac492b8312066bc1eb86e
+SHA512:
+  metadata.gz: 7b6359fb57c03a67a048c2679efddff22d1ced66ec00bc93a34fc8a0965a17eb0af749baa3b66423542775e6442d1cf61d509f784c69b8ea46303acbea9cbb95
+  data.tar.gz: caf1e909f3f2f8078218c230e6fc3f882fc2df70fb64b0f8f3e9ce8550314b67b12c401e68c4da541547af01b29e1b56aaef90e260c00f9397474554f42ccfc6

data/.gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+**/.DS_Store
+pkg
+doc
+coverage
+coverage.*
+*.autosave
+*.rbc
+.idea
+.yardoc
+*.numbers
+._*
+Gemfile.lock
+.ruby-version

data/.travis.yml

@@ -1,4 +1,9 @@
 rvm:
   - 1.8.7
   - 1.9.2
-  - 1.9.3
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.2.2
+cache: bundler
+sudo: false

data/Gemfile

@@ -1,10 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
-gem "update_hints", "~> 1.0"
-gem "framecurve", "~> 1.0.1"
-
-group :development do
-  gem "jeweler"
-  gem "rake"
-  gem "cli_test", "~>1.0"
-end
+gemspec

data/History.txt

@@ -1,3 +1,7 @@
+=== 4.1.0 / 2014-10-20
+
+* Adds `flame_channel_inspect` for examining Flame setups
+
 === 4.0.2 / 2011-09-11
 
 * Fix Batch timewarp parsing to framecurve

data/{README.rdoc → README.md}

@@ -1,29 +1,48 @@
-= flame_channel_parser
+# flame_channel_parser
 
-* http://guerilla-di.org/flame-channel-parser
+[![Build Status](https://travis-ci.org/guerilla-di/flame_channel_parser.svg?branch=master)](https://travis-ci.org/guerilla-di/flame_channel_parser)
 
-== DESCRIPTION:
+Flame is a compositing powerhouse, and it's animation tools are extremely good for quickly prototyping things in front of clients. However, once you want to pull your
+animation into other packages it can get troublesome, since only Action nodes currently support any kind of export (and it's FBX, and it's only partial).
+`flame_channel_parser` alleviates the problem - it can load **any** Flame setup file (an `.action` file, or a `.stabilizer` file, or any file created by one of your
+Sparks - like Kronos timewarps for examople) and extract arbitrary animation curves as tables of frames and values.
 
-Includes a small library for extracting, parsing and baking animation curves made on Discrodesk Floke/Inflinto, also known as flame.
+This gem includes a small library for extracting, parsing and baking animation curves made on Discrodesk Floke/Inflinto, also known as flame.
 Thanks to Marijn Eken, Philippe Soeiro and Andre Gagnon for their support and advice.
 
-== FEATURES/PROBLEMS:
+## Features:
 
 * All extrapolation and interpolation methods are supported (yes two keyframes with tangents across 2000 frames will do!)
 * Expressions on channels won't be evaluated (obviously!)
 
-== SYNOPSIS:
+## Synopsis
+
+To examing what channels your setup contains, use the flame_channel_inspect_binary
+    
+    $flame_channel_inspect /usr/discreet/projects/BZO/timewarp/s02_tw.timewarp
 
 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 and gives you a nice .framecurve.txt file
+If you just need to extract a framecurve file (http://framecurve.org) from a timewarp, use the framecurve_from_flame which autodetects most of the settings by itself and gives you a nice .framecurve.txt file
 
     $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
 
+The reverse is true for framecurve_to_flame
+
+    $framecurve_from_flame /usr/discreet/projects/BZO/timewarp/s02_tw.framecurve.txt
+
+will create setup files for use with both Timewarp modules and the Kronos spark.
+
+The bonuses are of course in the details - **flame_channel_parser** is a meticulous
+bitch and will faithfully replicate all the tricky things you can do to your animation curves to give them more _oomph_ - like broken tangents, two keyframes on
+500 frames with wild oscillations, looping and linear extrapolations, constant interpolations for jumps and so on. In short, this will _interpolate_ your
+animation channel and extract it frame by frame, so all the animation is intact. **No keyframe baking is necessary** for the Flame operator to do.
+Of course it supports both varieties of Flame setups - the newer 2012 ones as good as the old 9.0 - 2011 ones.
+
 To use the library:
     
     require "flame_channel_parser"
@@ -46,19 +65,19 @@ To use the library:
       p interpolator.value_at(frame_in_setup)
     end
     
-== REQUIREMENTS:
+## Requirements
 
-* Ruby 1.8.6 and above
+* Ruby 1.8.7 and above
 
-== INSTALL:
+## Installation
 
-* gem install flame_channel_parser
+    $gem install flame_channel_parser
 
-== LICENSE:
+## License
 
 (The MIT License)
 
-Copyright (c) 2011 Julik Tarkhanov
+Copyright (c) 2011-2015 Julik Tarkhanov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,23 +1,6 @@
-# -*- ruby -*-
-
-require 'rubygems'
-require 'jeweler'
-require './lib/flame_channel_parser'
-
-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 "bundler/gem_tasks"
 require 'rake/testtask'
+
 desc "Run all tests"
 Rake::TestTask.new("test") do |t|
   t.libs << "test"
@@ -25,6 +8,5 @@ Rake::TestTask.new("test") do |t|
   t.verbose = true
 end
 
+# Automatically update the LICENSE
 task :default => [ :test ]
-
-# vim: syntax=ruby

data/bin/bake_flame_channel

@@ -10,7 +10,7 @@
 # == Author
 #   Julik <me@julik.nl>
 
-require File.expand_path(File.dirname(__FILE__)) + '/../lib/flame_channel_parser' unless defined?(FlameChannelParser)
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/flame_channel_parser'
 require 'optparse'
 require 'rubygems'
 require "update_hints"

data/bin/flame_channel_inspect

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# == Synopsis
+# 
+# Shows a list of animation channels in the given Flame setup file
+#
+# == Usage
+# 
+#   flame_channel_inspect /usr/discreet/projects/Luxury/timewarp/shot2_tw.timewarp
+#
+# == Author
+#   Julik <me@julik.nl>
+
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/flame_channel_parser'
+require 'rubygems'
+require "update_hints"
+
+setup_path = ARGV.shift
+fail "No input file path provided." unless setup_path
+fail "File does not exist." unless File.exist?(setup_path)
+
+parser = FlameChannelParser::Parser.new
+File.open(setup_path, "r") do | f |
+  channels = parser.parse(f)
+  tree = FlameChannelParser::Inspector.new(channels)
+  tree.pretty_print
+end

data/flame_channel_parser.gemspec

@@ -1,131 +1,29 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-
+require File.dirname(__FILE__) + '/lib/flame_channel_parser/version'
 Gem::Specification.new do |s|
   s.name = "flame_channel_parser"
-  s.version = "4.0.2"
+  s.version = FlameChannelParser::VERSION
 
   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.date = Time.now.utc.strftime("%Y-%m-%d")
   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_bake_flame_channel_binary.rb",
-    "test/test_base_timewarp_writer.rb",
-    "test/test_batch_timewarp_writer.rb",
-    "test/test_channel.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_examples/tw_batch_out.framecurve.txt",
-    "test/timewarp_export_samples/BatchTW.timewarp_node",
-    "test/timewarp_export_samples/Kronos.F_Kronos",
-    "test/timewarp_export_samples/SoftFX.timewarp"
+    "README.md"
   ]
+  s.files = `git ls-files -z`.split("\x0")
   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
+  s.specification_version = 3
+  s.add_runtime_dependency("update_hints", ["~> 1.0"])
+  s.add_runtime_dependency("framecurve", ["~> 2"])
+  s.add_development_dependency("rake", [">= 0"])
+  s.add_development_dependency("cli_test", ["~> 1.0"])
+  s.add_development_dependency("test-unit")
 end
-

data/lib/flame_channel_parser.rb

@@ -1,5 +1,6 @@
+require File.dirname(__FILE__) + '/flame_channel_parser/version'
+
 module FlameChannelParser
-  VERSION = '4.0.2'
   
   module FramecurveWriters; end
   
@@ -37,7 +38,7 @@ module FlameChannelParser
 end
 
 %w(
-  key channel parser segments interpolator extractor timewarp_extractor builder xml_parser
+  key channel parser segments interpolator extractor timewarp_extractor builder xml_parser inspector
 ).each {|f| require File.expand_path(File.dirname(__FILE__) + "/" + f ) }
 
 %w(

data/lib/flame_channel_parser/version.rb

@@ -0,0 +1,3 @@
+module FlameChannelParser
+  VERSION = '4.1.1'
+end

data/lib/inspector.rb

@@ -0,0 +1,74 @@
+# Prints out a viewable tree of channel metadata. Useful when you need to inspect comparable setups
+# for small differentces in channel ordering and animation.
+class FlameChannelParser::Inspector
+  
+  def initialize(channels_arr)
+    @branches = OH.new
+    channels_arr.each {|c| cluster(c) }
+  end
+  
+  def pretty_print(output = $stdout)
+    @out = output
+    print_branch(@branches, initial_indent = 0)
+  end
+  
+  private
+  
+  class OH < Hash # It sucks to be Ruby 1.8-compatible sometimes.
+    def initialize
+      super
+      @keys_in_order = []
+    end
+    
+    def []=(k, v)
+      @keys_in_order.delete(k)
+      @keys_in_order << k
+      super(k, v)
+    end
+    
+    def each_pair
+      @keys_in_order.each {|k| yield(k, self[k]) }
+    end
+  end
+  
+  def puts(string)
+    @out.puts(string)
+  end
+  
+  def print_branch(branch, indent)
+    branch.each_pair do | k, v|
+      if v.is_a?(Hash)
+        puts((" " * indent) + k)
+        print_branch(v, indent + 1)
+      else
+        puts((" " * indent) + k + " - " + channel_metadata(v))
+      end
+    end
+  end
+  
+  def channel_metadata(channel)
+    if channel.length.zero?
+      "no animations, value %s" % [channel.base_value]
+    elsif channel.length > 1
+      first_key = channel[0].frame
+      last_key = channel[-1].frame
+      "animated, %d keys, first at %d last at %d" % [channel.length, first_key, last_key]
+    else
+      first_key = channel[0].frame
+      "animated, 1 key at %d, value %s" % [first_key, channel[0].value]
+    end
+  end
+  
+  def cluster(channel)
+    path_parts = channel.name.split('/')
+    leaf_name = path_parts.pop
+  
+    current = @branches
+    path_parts.each do | path_part |
+      current[path_part] ||= OH.new
+      current = current[path_part]
+    end
+    current[leaf_name] = channel
+  end
+  
+end