depix 1.0.2 → 1.0.3

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.0.2 / 2008-12-23
+
+* Do not cleanup null bytes and terminators in the middle of char[] attributes (something useful might be in there)
+
 === 1.0.2 / 2008-12-19
 
 * refactor struct parsing completely

data/README.txt

@@ -8,7 +8,7 @@ Read DPX file metadata
 
 == SYNOPSIS:
 
-  meta = Depix::Reader.from_file(dpx_file_path)
+  meta = Depix.from_file(dpx_file_path)
   puts meta.time_code #=> 10:00:00:02
   
 The data returned is described in the DPX_HEADER_STRUCTURE[link:files/DPX_HEADER_STRUCTURE_txt.html]. It's

data/bin/depix-describe

@@ -15,5 +15,9 @@ end.parse!
 ARGV.each do | file |
   puts "Describing DPX #{file}. Empty elements are omitted.\n\n"
   puts "===================================================\n\n"
-  puts Depix.describe_file(file, options[:compact])
+  begin
+    puts Depix.describe_file(file, options[:compact])
+  rescue Depix::InvalidHeader
+    puts " - Invalid header data"
+  end
 end

data/lib/depix.rb

@@ -8,7 +8,9 @@ require File.dirname(__FILE__) + '/depix/compact_structs'
 require File.dirname(__FILE__) + '/depix/enums'
 
 module Depix
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
+  
+  class InvalidHeader < RuntimeError; end
   
   # Offers convenience access to a few common attributes bypassing the piecemeal structs
   module Synthetics
@@ -16,8 +18,10 @@ module Depix
       [film.id, film.type, film.offset, film.prefix, film.count].compact.join(' ')
     end
     
+    # Return the flame reel name. The data after the first null byte is not meant to be seen and is used by Flame internally
+    # as it seems
     def flame_reel
-      orientation.device.to_s.scan(/^(\w+)/).to_s
+      orientation.device.split("\000").shift
     end
     
     def time_code
@@ -71,16 +75,38 @@ module Depix
     
     def from_file(path, compact)
       header = File.open(path, 'r') { |f| f.read(DPX.length) }
-      parse(header, compact)
+      begin
+        parse(header, compact)
+      rescue InvalidHeader => e
+        raise InvalidHeader, "Invalid header in file #{path}"
+      end
     end
     
     # The hear of Depix
     def parse(data, compact)
       magic = data[0..3]
+      
+      raise InvalidHeader unless %w( SDPX XPDS).include?(magic)
+      
       struct = compact ? CompactDPX : DPX
       
-      template = (magic == "SDPX") ? struct.pattern : make_le(struct.pattern)
-      struct.consume!(data.unpack(template))
+      is_be = (magic == "SDPX")
+      version_check = FileInfo.only(:magic, :version)
+      
+      result = begin
+        if is_be
+          version_check.consume!(data.unpack(version_check.pattern))
+        else
+          version_check.consume!(data.unpack(make_le(version_check.pattern)))
+        end
+      rescue ArgumentError
+        raise InvalidHeader
+      end
+      
+      raise InvalidHeader unless result.version == "V1.0"
+       
+      template = is_be ? DPX.pattern : make_le(DPX.pattern)
+      struct.consume!(data.unpack(struct.pattern))
     end
     
     # Describe a filled DPX structure

data/lib/depix/dict.rb

@@ -54,6 +54,7 @@ module Depix
   
   class U32Field < Field
     BLANK = 0xFFFFFFFF
+    undef :length=, :pattern=
     
     def pattern
       "N"
@@ -69,6 +70,7 @@ module Depix
   end
   
   class U8Field < Field
+    undef :length=, :pattern=
 
     BLANK = 0xFF
 
@@ -90,6 +92,7 @@ module Depix
   end
   
   class Filler < Field
+    undef :pattern=
     def pattern
       "x#{length ? length.to_i : 1}"
     end
@@ -102,6 +105,7 @@ module Depix
     
   class U16Field < Field
     BLANK = 0xFFFF
+    undef :length=, :pattern=
     
     def pattern
       "n"
@@ -121,6 +125,8 @@ module Depix
   end
   
   class R32Field < Field
+    undef :length=, :pattern=
+    
     def pattern
       "g"
     end
@@ -140,6 +146,12 @@ module Depix
   
   class CharField < Field
     BLANK = "\0"
+    undef :pattern=
+    
+    BLANKING_VALUES = [0x00.chr, 0xFF.chr]
+    BLANKING_PATTERNS = BLANKING_VALUES.inject([]) do | p, char |
+      p << /^(#{char}+)/ << /(#{char}+)$/
+    end
     
     def pattern
       "A#{(length || 1).to_i}"
@@ -149,8 +161,8 @@ module Depix
       if v == BLANK
         nil
       else
-        cleansed = v.gsub(0xFF.chr, '').gsub(0x00.chr, '')
-        cleansed.empty? ? nil : cleansed
+        2.times { BLANKING_PATTERNS.each{|p| v.gsub!(p, '')} }
+        v.empty? ? nil : v
       end
     end
     
@@ -320,6 +332,8 @@ module Depix
         
         anon = Class.new(self)
         anon.fields.replace(distillate)
+        only_items = distillate.map{|n| n.name }
+        
         anon
       end
       

data/test/test_depix.rb

@@ -4,7 +4,7 @@ require 'test/unit'
 class ReaderTest < Test::Unit::TestCase
   
   SAMPLE_DPX = File.dirname(__FILE__) + '/samples/E012_P001_L000002_lin.0001.dpx'
-  
+    
   def test_parsed_properly
     file = SAMPLE_DPX
     parsed = Depix.from_file(file)
@@ -38,8 +38,10 @@ class ReaderTest < Test::Unit::TestCase
     assert_equal 8192, parsed.image.image_elements[0].data_offset
     assert_equal 0, parsed.image.image_elements[0].end_of_line_padding
     assert_equal 0, parsed.image.image_elements[0].end_of_image_padding
-    assert_equal "IMAGE DESCRIPTION DATA        P", parsed.image.image_elements[0].description
-    assert_equal "E012x\340\264\020\005", parsed.orientation.device #- this is where Flame writes the reel
+    assert_equal "IMAGE DESCRIPTION DATA        \000P", parsed.image.image_elements[0].description
+    assert_equal "E012\000\000\000\000x\340\264\020\000\000\000\000\005", 
+      parsed.orientation.device #- this is where Flame writes the reel
+    
     assert_equal 853, parsed.orientation.aspect_ratio[0]
     assert_equal 640, parsed.orientation.aspect_ratio[1]
 
@@ -66,7 +68,7 @@ class ReaderTest < Test::Unit::TestCase
     assert_equal "01:15:11:18", parsed.time_code.to_s
     assert_equal :RGB, parsed.component_type
     assert_equal :Linear, parsed.colorimetric
-    assert_equal "E012x", parsed.flame_reel
+    assert_equal "E012", parsed.flame_reel
   end
   
   def test_parsed_properly_using_compact_structs
@@ -81,4 +83,16 @@ class ReaderTest < Test::Unit::TestCase
       assert_match(/Offset to data for this image element/, desc)
     end
   end
+  
+  def test_parsing_something_else_should_raise
+    s = "Mary had a little lamb"
+    assert_raise(Depix::InvalidHeader) { Depix.from_string(s) }
+    
+    s = "Mary had a little lamb" * 1000
+    assert_raise(Depix::InvalidHeader) { Depix.from_string(s) }
+
+    s = "SDPX Mary had a little lamb" * 1000
+    assert_raise(Depix::InvalidHeader) { Depix.from_string(s) }
+
+  end
 end

data/test/test_dict.rb

@@ -13,6 +13,10 @@ module FieldConformity
     assert_respond_to f, :rtype
     assert_respond_to f, :explain
   end
+  
+  def assert_method_removed(f, method)
+    fail("#{f.inspect} should not respond to #{method}") if f.respond_to?(method)
+  end
 end
 
 class FieldExplainsItself < Test::Unit::TestCase
@@ -124,9 +128,15 @@ class TestArrayField < Test::Unit::TestCase
     conform_field!(f)
     
     assert_respond_to f, :name=
-
-    assert_raise(NoMethodError) { f.length = 1 }
-    assert_raise(NoMethodError) { f.pattern = 'C' }
+    
+    assert_method_removed f, :length=
+    assert_method_removed f, :pattern=
+  end
+  
+  def test_array_does_not_allow_setting_length
+    f = ArrayField.new
+    assert_method_removed(f, :length=)
+    assert_method_removed(f, :pattern=)
   end
   
   def test_array_field_has_members
@@ -162,8 +172,8 @@ class TestInnerField < Test::Unit::TestCase
     assert_respond_to f, :cast
     assert_respond_to f, :cast=
     
-    assert_raise(NoMethodError) { f.length = 1 }
-    assert_raise(NoMethodError) { f.pattern = 'C' }
+    assert_method_removed(f, :length=)
+    assert_method_removed(f, :pattern=)
   end
   
   def test_inner_field_asks_cast_for_pattern_and_length
@@ -173,6 +183,10 @@ class TestInnerField < Test::Unit::TestCase
     casted = InnerField.new(:cast => sample)
     assert_equal 123, casted.length
     assert_equal 'C123', casted.pattern
+    
+    assert_method_removed(casted, :length=)
+    assert_method_removed(casted, :pattern=)
+    
   end
   
   def test_rtype_for_inner_field_is_cast
@@ -203,6 +217,7 @@ class TestCharField < Test::Unit::TestCase
   def test_char_field_conforms_to_basics
     f = CharField.new :name  => :foo
     conform_field!(f)
+    assert_method_removed(f, :pattern=)
   end
   
   def test_char_field_pads
@@ -213,14 +228,19 @@ class TestCharField < Test::Unit::TestCase
     assert_equal String, f.rtype
   end
   
-  def test_char_field_clean_inner_nulls
+  def test_char_field_does_not_clean_inner_nulls
     f = CharField.new :name => :foo, :length => 15
-    assert_equal "foo", f.clean("\0\0foo")
+    assert_equal "foo\0foo", f.clean("\0\0foo\0foo\0")
+    assert_equal "swoop\377\0bla", f.clean("\0\0\0\377\377swoop\377\0bla\0\0\0\377\377\377\377\0\0\0")
   end
   
   def test_char_field_clean_blank
     f = CharField.new :name => :foo, :length => 15
     assert_equal nil, f.clean("\0")
+    assert_equal nil, f.clean("\0\0\0\0\0\0")
+    assert_equal nil, f.clean("\0\0\0\377\377\0\0\0")
+    assert_equal "foo\0foo", f.clean("\0\0foo\0foo\0")
+
   end
 end
 
@@ -249,6 +269,10 @@ class TestSmallintField < Test::Unit::TestCase
   def test_smallint_conformity
     f = U8Field.new :name => :foo
     conform_field!(f)
+    
+    assert_method_removed(f, :pattern=)
+    assert_method_removed(f, :length=)
+    
   end
   
   def test_smallint_operation
@@ -274,6 +298,9 @@ class TestDoubleField < Test::Unit::TestCase
   def test_double_conformity
     f = U16Field.new :name => :foo
     conform_field!(f)
+
+    assert_method_removed(f, :pattern=)
+    assert_method_removed(f, :length=)
   end
   
   def test_double_operation
@@ -301,6 +328,10 @@ class TestFillerField < Test::Unit::TestCase
     assert_equal "x1", f.pattern
   end
   
+  def test_filler_does_not_allow_setting_pattern
+    assert_method_removed(Filler.new, :pattern=)
+  end
+  
   def test_pattern_discards_value
     data = [1,2,3].pack("ccc")
     filler = Filler.new(:length => 3)
@@ -596,11 +627,16 @@ class TestDictCompact < Test::Unit::TestCase
     assert_equal distill.length, c.length, "The distilled struct should occupy the same space"
     assert_equal 3, distill.fields.length
     
+    result = distill.apply!("abcdefhjhjkujkdkklsalierioeiore")
+    
     assert_kind_of Filler, distill.fields[0]
     assert_equal 5, distill.fields[0].length
 
     assert_kind_of Filler, distill.fields[2]
     assert_equal 14, distill.fields[2].length
+    
+    assert_nil result.some
+    assert_nil result.fourth
   end
   
   def test_get_filler

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: depix
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-21 00:00:00 +01:00
+date: 2008-12-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency