flame_channel_parser 3.0.0 → 4.0.0

data/lib/framecurve_writers/templates/TW_Sample.timewarp

@@ -0,0 +1,79 @@
+TimewarpFileVersion 1.0
+CreationDate Wed Dec 28 08:46:50 2011
+
+
+Fields 0
+Frames 28
+Origin 1
+RenderType yes
+SamplingStep 0
+Interpolation 0
+FlowQuality 2
+Animation
+	Channel Speed
+		Extrapolation linear
+		Value 100
+		End
+	Channel Timing/Timing
+		Extrapolation constant
+		Value 1
+		Size 3
+		KeyVersion 2
+		Key 0
+			Frame 1
+			Value 1
+			RHandleX 5.66666651
+			RHandleY 6.99977636
+			LHandleX 0.75
+			LHandleY 0.75
+			CurveMode bezier
+			CurveOrder cubic
+			LeftAutomaticSlope no
+			TangentMode manual
+			End
+		Key 1
+			Frame 15
+			Value 18.9993286
+			RHandleX 19.333334
+			RHandleY 23.3326626
+			LHandleX 10.333333
+			LHandleY 14.3326616
+			CurveMode bezier
+			CurveOrder cubic
+			TangentMode smooth
+			End
+		Key 2
+			Frame 28
+			Value 28
+			RHandleX 32.3333321
+			RHandleY 31.0002232
+			LHandleX 23.666666
+			LHandleY 24.9997768
+			CurveMode bezier
+			CurveOrder cubic
+			TangentMode smooth
+			End
+		Uncollapsed
+		End
+	Channel Mix/Mix
+		Extrapolation linear
+		Value 0
+		End
+	Channel Trail/Pre_Trail
+		Extrapolation linear
+		Value 1
+		End
+	Channel Trail/Pre_Weight
+		Extrapolation linear
+		Value 100
+		End
+	Channel Trail/Post_Trail
+		Extrapolation linear
+		Value 1
+		End
+	Channel Trail/Post_Weight
+		Extrapolation linear
+		Value 100
+		End
+	ChannelEnd
+End

data/lib/framecurve_writers/templates/key.xml

@@ -0,0 +1,10 @@
+<Key Index="$idx">
+  <Frame>$frame</Frame>
+  <Value>$value</Value>
+  <RHandleX>32.666668</RHandleX>
+  <RHandleY>36.319729</RHandleY>
+  <LHandleX>16.333334</LHandleX>
+  <LHandleY>14.986395</LHandleY>
+  <CurveMode>hermite</CurveMode>
+  <CurveOrder>linear</CurveOrder>
+</Key>

data/lib/timewarp_extractor.rb

@@ -1,3 +1,5 @@
+require "framecurve"
+
 module FlameChannelParser
   class TimewarpExtractor
     
@@ -5,7 +7,7 @@ module FlameChannelParser
     CHANNELS = %( Timing/Timing  Frame )
     
     class X < Extractor
-    
+      
       # This one is overridden here since instead of looking for a particular channel we are looking
       # for matches from a list
       def find_channel_in(channels, channel_path)
@@ -14,8 +16,22 @@ module FlameChannelParser
         return detected_channel if detected_channel
         raise ChannelNotFoundError, compose_channel_not_found_message(CHANNELS.join(' or '), channels)
       end
+      
+      FRAMECURVE_FORMAT = "%d\t%.5f\r\n"
+      
+      # Overridden to force CRLF line breaks as per Framecurve spec
+      def write_frame(to_io, frame, value)
+        @c.tuple!(frame, value)
+      end
+      
+      # Overridden to write a framecurve header
+      def write_channel(interpolator, to_io, from_frame_i, to_frame_i)
+        @c = Framecurve::Curve.new
+        super
+        Framecurve::Serializer.new.serialize(to_io, @c)
+      end
     end
-  
+    
     def extract(file_path, options)
       return X.extract(file_path, options)
     end

data/lib/xml_parser.rb

@@ -0,0 +1,90 @@
+require 'rexml/document'
+require "rexml/streamlistener"
+
+class FlameChannelParser::XMLParser < FlameChannelParser::Parser
+  # Here you can assign a logger proc or a lambda that will be call'ed with progress reports
+  attr_accessor :logger_proc
+  
+  # A SAX-based translation layer
+  class XMLToSetup
+    include REXML::StreamListener
+    
+    def initialize(vanilla_setup)
+      @dest = vanilla_setup
+      @indent = 0
+      @in_channel = false
+      @path = []
+    end
+    
+    # <KFrames>
+    #   <Key Index="0">
+    #     <Frame>1.000000</Frame>
+    #     <Value>100</Value>
+    #     <RHandleX>1.297667</RHandleX>
+    #     <RHandleY>100.000000</RHandleY>
+    #     <LHandleX>0.750000</LHandleX>
+    #     <LHandleY>100.000000</LHandleY>
+    #     <CurveMode>hermite</CurveMode>
+    #     <CurveOrder>linear</CurveOrder>
+    #   </Key>
+    # </KFrames>
+    def tag_start(element, attributes)
+      @path.push(element)
+      if element == "Channel"
+        channel_name = attributes["Name"]
+        @in_channel = true
+        # Compose the full channel name
+        
+        @dest.puts("Channel %s" % channel_name)
+      elsif element == "Key"
+        @in_key = true
+        @dest.puts("\tKey %d" % attributes["Index"].to_i)
+      end
+    end
+    
+    def text(text)
+      @text = text
+    end
+    
+    def tag_end(element)
+      @path.pop
+      if element == "Channel"
+        @in_channel = false
+        @dest.puts("\tEnd")
+      end
+      
+      if element == "Key"
+        @in_key = false
+        @dest.puts("\t\tEnd")
+      end
+      
+      if @in_key
+        @dest.puts("\t\t" + transfo(element) + " " + @text)
+      end
+      
+      if !@in_key && @in_channel
+        @dest.puts("\t" + transfo(element) + " " + @text)
+      end
+    end
+    
+    def transfo(t)
+      t == "Extrap" ? "Extrapolation" : t
+    end
+  end
+  
+  # Parses the setup passed in the IO. 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 parse(io)
+    # Ok this is gothic BUT needed. What we do is we transform the XML setup into the OLD
+    # setup format, after which we run it through the OLD parser all the same.
+    # I am almost sure that ADSK does the same.
+    t = Tempfile.new("bx")
+    REXML::Document.parse_stream(io, XMLToSetup.new(t))
+    t.rewind
+    if block_given?
+      super(t, &Proc.new)
+    else
+      super(t)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require "test/unit"
+require "stringio"
+require "tempfile"
+require "cli_test"
+
+require File.dirname(__FILE__) + "/../lib/flame_channel_parser"
+
+class Test::Unit::TestCase
+  def assert_same_buffer(ref_buffer, actual_buffer, message = "The line should be identical")
+    [ref_buffer, actual_buffer].each{|io| io.rewind }
+    at_line = 0
+    until ref_buffer.eof? && actual_buffer.eof?
+      at_line += 1
+      reference_line, output_line = ref_buffer.readline, actual_buffer.readline
+      assert_equal reference_line, output_line, "Line #{at_line} - #{message}"
+    end
+  end
+end

data/test/snaps/BatchTimewar_proper.xml

@@ -0,0 +1,157 @@
+<?xml version="1.0"?>
+<Setup>
+  <Base>
+    <Version>7.130000</Version>
+    <NAME>timewarp3</NAME>
+    <Note/>
+    <Expanded>False</Expanded>
+    <ScrollBar>0</ScrollBar>
+    <Frames>0</Frames>
+    <Current_Time>82</Current_Time>
+    <Input_DataType>3</Input_DataType>
+    <ClampMode>0</ClampMode>
+    <AdapDegrad>False</AdapDegrad>
+  </Base>
+  <State>
+    <TW_FlowQuality>4</TW_FlowQuality>
+    <TW_DoBlur>False</TW_DoBlur>
+    <TW_BlurPhase>0</TW_BlurPhase>
+    <TW_DoBlurReference>False</TW_DoBlurReference>
+    <TW_BlurRefColor>
+      <R>1.000000</R>
+      <G>0.000000</G>
+      <B>0.000000</B>
+      <A>1.000000</A>
+    </TW_BlurRefColor>
+    <TW_FrameMode>0</TW_FrameMode>
+    <TW_SamplingMode>0</TW_SamplingMode>
+    <TW_StartFrameIn>1</TW_StartFrameIn>
+    <TW_EndFrameIn>102</TW_EndFrameIn>
+    <TW_RenderMode>0</TW_RenderMode>
+    <TW_ReverseCurves>False</TW_ReverseCurves>
+    <TW_HeadMode>0</TW_HeadMode>
+    <TW_TailMode>0</TW_TailMode>
+    <TW_Regen>False</TW_Regen>
+    <TW_RetimerMode>1</TW_RetimerMode>
+    <TW_ReferencePointX>
+      <Channel Name="X"/>
+    </TW_ReferencePointX>
+    <TW_ReferencePointY>
+      <Channel Name="Y"/>
+    </TW_ReferencePointY>
+    <TW_Speed>
+      <Channel Name="Speed">
+        <Extrap>constant</Extrap>
+        <Value>100</Value>
+        <Size>1</Size>
+        <KeyVersion>2.000000</KeyVersion>
+        <KFrames>
+          <Key Index="0">
+            <Frame>1.000000</Frame>
+            <Value>100</Value>
+            <RHandleX>1.297667</RHandleX>
+            <RHandleY>100.000000</RHandleY>
+            <LHandleX>0.750000</LHandleX>
+            <LHandleY>100.000000</LHandleY>
+            <CurveMode>hermite</CurveMode>
+            <CurveOrder>linear</CurveOrder>
+          </Key>
+        </KFrames>
+      </Channel>
+    </TW_Speed>
+    <TW_SpeedTiming>
+      <Channel Name="SpeedTiming">
+        <Extrap>linear</Extrap>
+        <Value>1</Value>
+        <Size>1</Size>
+        <KeyVersion>2.000000</KeyVersion>
+        <KFrames>
+          <Key Index="0">
+            <Frame>1.000000</Frame>
+            <Value>1</Value>
+            <RHandleX>1.250000</RHandleX>
+            <RHandleY>1.250000</RHandleY>
+            <LHandleX>0.750000</LHandleX>
+            <LHandleY>0.750000</LHandleY>
+            <CurveMode>hermite</CurveMode>
+            <CurveOrder>quadratic</CurveOrder>
+            <RAutoSlope>False</RAutoSlope>
+            <LAutoSlope>False</LAutoSlope>
+            <TangentMode>manual</TangentMode>
+          </Key>
+        </KFrames>
+      </Channel>
+    </TW_SpeedTiming>
+    <TW_Timing>
+      <Channel Name="Timing">
+        <Extrap>linear</Extrap>
+        <Value>87.7692261</Value>
+        <Size>4</Size>
+        <KeyVersion>2.000000</KeyVersion>
+        <KFrames>
+          <Key Index="0">
+            <Frame>1.000000</Frame>
+            <Value>1</Value>
+            <RHandleX>8.666667</RHandleX>
+            <RHandleY>9.000000</RHandleY>
+            <LHandleX>0.750000</LHandleX>
+            <LHandleY>0.750000</LHandleY>
+            <CurveMode>hermite</CurveMode>
+            <CurveOrder>linear</CurveOrder>
+          </Key>
+          <Key Index="1">
+            <Frame>24.000000</Frame>
+            <Value>25</Value>
+            <RHandleX>32.666668</RHandleX>
+            <RHandleY>36.319729</RHandleY>
+            <LHandleX>16.333334</LHandleX>
+            <LHandleY>14.986395</LHandleY>
+            <CurveMode>hermite</CurveMode>
+            <CurveOrder>linear</CurveOrder>
+          </Key>
+          <Key Index="2">
+            <Frame>50.000000</Frame>
+            <Value>65</Value>
+            <RHandleX>67.333336</RHandleX>
+            <RHandleY>82.111107</RHandleY>
+            <LHandleX>41.333332</LHandleX>
+            <LHandleY>56.444447</LHandleY>
+            <CurveMode>hermite</CurveMode>
+            <CurveOrder>linear</CurveOrder>
+          </Key>
+          <Key Index="3">
+            <Frame>102.000000</Frame>
+            <Value>102</Value>
+            <RHandleX>135.666672</RHandleX>
+            <RHandleY>117.420235</RHandleY>
+            <LHandleX>68.333336</LHandleX>
+            <LHandleY>86.579773</LHandleY>
+            <CurveMode>hermite</CurveMode>
+            <CurveOrder>linear</CurveOrder>
+          </Key>
+        </KFrames>
+      </Channel>
+    </TW_Timing>
+    <TW_BlurSamplesChannel>
+      <Channel Name="Samples"/>
+    </TW_BlurSamplesChannel>
+    <TW_BlurShutterChannel>
+      <Channel Name="Shutter"/>
+    </TW_BlurShutterChannel>
+    <TW_Mix>
+      <Channel Name="MixAmount"/>
+    </TW_Mix>
+    <TW_PreTrail>
+      <Channel Name="Pre"/>
+    </TW_PreTrail>
+    <TW_PreWeight>
+      <Channel Name="Pre"/>
+    </TW_PreWeight>
+    <TW_PostTrail>
+      <Channel Name="Post"/>
+    </TW_PostTrail>
+    <TW_PostWeight>
+      <Channel Name="Post"/>
+    </TW_PostWeight>
+  </State>
+</Setup>

data/test/snaps/BatchTimewarp_ext1.timewarp_node

@@ -0,0 +1 @@
+<Setup><Base><Version>7.130000</Version><NAME>timewarp3</NAME><Note></Note><Expanded>False</Expanded><ScrollBar>0</ScrollBar><Frames>0</Frames><Current_Time>82</Current_Time><Input_DataType>3</Input_DataType><ClampMode>0</ClampMode><AdapDegrad>False</AdapDegrad></Base><State><TW_FlowQuality>4</TW_FlowQuality><TW_DoBlur>False</TW_DoBlur><TW_BlurPhase>0</TW_BlurPhase><TW_DoBlurReference>False</TW_DoBlurReference><TW_BlurRefColor><R>1.000000</R><G>0.000000</G><B>0.000000</B><A>1.000000</A></TW_BlurRefColor><TW_FrameMode>0</TW_FrameMode><TW_SamplingMode>0</TW_SamplingMode><TW_StartFrameIn>1</TW_StartFrameIn><TW_EndFrameIn>102</TW_EndFrameIn><TW_RenderMode>0</TW_RenderMode><TW_ReverseCurves>False</TW_ReverseCurves><TW_HeadMode>0</TW_HeadMode><TW_TailMode>0</TW_TailMode><TW_Regen>False</TW_Regen><TW_RetimerMode>1</TW_RetimerMode><TW_ReferencePointX><Channel Name="X"/></TW_ReferencePointX><TW_ReferencePointY><Channel Name="Y"/></TW_ReferencePointY><TW_Speed><Channel Name="Speed"><Extrap>constant</Extrap><Value>100</Value><Size>1</Size><KeyVersion>2.000000</KeyVersion><KFrames><Key Index="0"><Frame>1.000000</Frame><Value>100</Value><RHandleX>1.297667</RHandleX><RHandleY>100.000000</RHandleY><LHandleX>0.750000</LHandleX><LHandleY>100.000000</LHandleY><CurveMode>hermite</CurveMode><CurveOrder>linear</CurveOrder></Key></KFrames></Channel></TW_Speed><TW_SpeedTiming><Channel Name="SpeedTiming"><Extrap>linear</Extrap><Value>1</Value><Size>1</Size><KeyVersion>2.000000</KeyVersion><KFrames><Key Index="0"><Frame>1.000000</Frame><Value>1</Value><RHandleX>1.250000</RHandleX><RHandleY>1.250000</RHandleY><LHandleX>0.750000</LHandleX><LHandleY>0.750000</LHandleY><CurveMode>hermite</CurveMode><CurveOrder>quadratic</CurveOrder><RAutoSlope>False</RAutoSlope><LAutoSlope>False</LAutoSlope><TangentMode>manual</TangentMode></Key></KFrames></Channel></TW_SpeedTiming><TW_Timing><Channel Name="Timing"><Extrap>linear</Extrap><Value>87.7692261</Value><Size>4</Size><KeyVersion>2.000000</KeyVersion><KFrames><Key Index="0"><Frame>1.000000</Frame><Value>1</Value><RHandleX>8.666667</RHandleX><RHandleY>9.000000</RHandleY><LHandleX>0.750000</LHandleX><LHandleY>0.750000</LHandleY><CurveMode>hermite</CurveMode><CurveOrder>linear</CurveOrder></Key><Key Index="1"><Frame>24.000000</Frame><Value>25</Value><RHandleX>32.666668</RHandleX><RHandleY>36.319729</RHandleY><LHandleX>16.333334</LHandleX><LHandleY>14.986395</LHandleY><CurveMode>hermite</CurveMode><CurveOrder>linear</CurveOrder></Key><Key Index="2"><Frame>50.000000</Frame><Value>65</Value><RHandleX>67.333336</RHandleX><RHandleY>82.111107</RHandleY><LHandleX>41.333332</LHandleX><LHandleY>56.444447</LHandleY><CurveMode>hermite</CurveMode><CurveOrder>linear</CurveOrder></Key><Key Index="3"><Frame>102.000000</Frame><Value>102</Value><RHandleX>135.666672</RHandleX><RHandleY>117.420235</RHandleY><LHandleX>68.333336</LHandleX><LHandleY>86.579773</LHandleY><CurveMode>hermite</CurveMode><CurveOrder>linear</CurveOrder></Key></KFrames></Channel></TW_Timing><TW_BlurSamplesChannel><Channel Name="Samples"/></TW_BlurSamplesChannel><TW_BlurShutterChannel><Channel Name="Shutter"/></TW_BlurShutterChannel><TW_Mix><Channel Name="MixAmount"/></TW_Mix><TW_PreTrail><Channel Name="Pre"/></TW_PreTrail><TW_PreWeight><Channel Name="Pre"/></TW_PreWeight><TW_PostTrail><Channel Name="Post"/></TW_PostTrail><TW_PostWeight><Channel Name="Post"/></TW_PostWeight></State></Setup>

data/test/test_base_timewarp_writer.rb

@@ -0,0 +1,22 @@
+require "helper"
+
+class TestBaseTimewarpWriter < Test::Unit::TestCase
+  def test_with_each_writer
+    pack = []
+    FlameChannelParser::FramecurveWriters::Base.with_each_writer do | w |
+      pack.push(w)
+    end
+    assert_equal [FlameChannelParser::FramecurveWriters::SoftfxTimewarp,
+     FlameChannelParser::FramecurveWriters::BatchTimewarp,
+     FlameChannelParser::FramecurveWriters::Kronos], pack
+  end
+  
+  def test_write_from_framecurve
+    c = Framecurve::Curve.new(Framecurve::Tuple.new(10, 123.45), Framecurve::Tuple.new(15, 456.78))
+    b = FlameChannelParser::FramecurveWriters::Base.new
+    buf = StringIO.new
+    b.run_export_from_framecurve(buf, c)
+    assert_equal "10 123.45000\n11 190.11600\n12 256.78200\n13 323.44800\n14 390.11400\n15 456.78000\n", buf.string
+  end
+  
+end

data/test/test_batch_timewarp_writer.rb

@@ -0,0 +1,18 @@
+require "helper"
+
+class TestBatchTimewarpWriter < Test::Unit::TestCase
+  def test_simple_export
+    buf = StringIO.new
+    w = FlameChannelParser::FramecurveWriters::BatchTimewarp.new
+    w.run_export(buf) do | key_writer |
+      key_writer.key(1, 15)
+      key_writer.key(15, 50)
+      key_writer.key(19, 102)
+    end
+    
+    File.open(File.dirname(__FILE__) + "/timewarp_export_samples/BatchTW.timewarp_node", "wb"){|f| f.write(buf.string) }
+    
+    assert_same_buffer File.open(File.dirname(__FILE__) + "/timewarp_export_samples/BatchTW.timewarp_node"), buf
+  end
+  
+end

data/test/test_channel.rb

@@ -1,5 +1,4 @@
-require "test/unit"
-require File.dirname(__FILE__) + "/../lib/flame_channel_parser"
+require "helper"
 
 D = 0.001