depix 1.0.0 → 1.0.1

data/DPX_HEADER_STRUCTURE.txt

@@ -34,10 +34,10 @@ and method name
     * <tt>low_quantity</tt> Float
     * <tt>high_data</tt> Integer
     * <tt>high_quantity</tt> Float
-    * <tt>descriptor</tt> String
-    * <tt>transfer</tt> String
-    * <tt>colorimetric</tt> String
-    * <tt>bit_size</tt> String
+    * <tt>descriptor</tt> Integer
+    * <tt>transfer</tt> Integer
+    * <tt>colorimetric</tt> Integer
+    * <tt>bit_size</tt> Integer
     * <tt>packing</tt> Integer
     * <tt>encoding</tt> Integer
     * <tt>data_offset</tt> Integer
@@ -79,10 +79,10 @@ and method name
 * <tt>television</tt> hash of
   * <tt>time_code</tt> Integer
   * <tt>user_bits</tt> Integer
-  * <tt>interlace</tt> String
-  * <tt>field_number</tt> String
-  * <tt>video_signal</tt> String
-  * <tt>padding</tt> String
+  * <tt>interlace</tt> Integer
+  * <tt>field_number</tt> Integer
+  * <tt>video_signal</tt> Integer
+  * <tt>padding</tt> Integer
   * <tt>horizontal_sample_rate</tt> Float
   * <tt>vertical_sample_rate</tt> Float
   * <tt>frame_rate</tt> Float

data/History.txt

@@ -1,3 +1,6 @@
+=== 1.0.1 / 2008-12-18
+* small doc and usability improvements
+
 === 1.0.0 / 2008-12-18
 
 * 1 major enhancement

data/README.txt

@@ -1,6 +1,6 @@
 = depix
 
-* http://rubyforge.org/julik/depix
+* http://wiretap.rubyforge.org/depix
 
 == DESCRIPTION:
 
@@ -8,7 +8,7 @@ Read DPX file metadata
 
 == SYNOPSIS:
 
-  meta = Depix::Reader.new.from_file(dpx_file_path)
+  meta = Depix::Reader.from_file(dpx_file_path)
   puts meta.television.time_code #=> 10:00:00:02
   
 The data returned is described in the DPX_HEADER_STRUCTURE[link:files/DPX_HEADER_STRUCTURE_txt.html]. The structs
@@ -21,7 +21,11 @@ The gem also contains an executable called depix-desribe which can be used from
 == NOTES:
 
 The reader tries to be efficient - fast Ruby unpacking is used, some shortcuts are taken. Also don't worry - we do not need to read
-the whole DPX file (which usually is around 8mb per frame) to know the details
+the whole DPX file (which usually is around 8mb per frame) to know the details.
+
+In the future there will be a possibility to modify and commit the headers, but it's not a priority at this time.
+
+Autodesk IFFS systems write the reel name for the file to the orientation.device field
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -6,6 +6,7 @@ Hoe.new('depix', Depix::VERSION) do |p|
   p.developer('Julik Tarkhanov', 'me@julik.nl')
   p.rubyforge_name = 'wiretap'
   p.extra_deps.reject! {|e| e[0] == 'hoe' }
+  p.remote_rdoc_dir = 'depix'
 end
 
 task :describe_structs do

data/bin/depix-describe

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
 require File.dirname(__FILE__) + '/../lib/depix'
-ARGV.flatten.each do | file |
+if ARGV.flatten.map do | file |
   data = Depix::Reader.describe_file(file)
   puts "Describing DPX #{file}. Empty elements are omitted."
   puts data
+end.empty?
+  STDERR.puts "Usage: depix-describe somefile.dpx anotherfile.dpx"
 end

data/lib/depix.rb

@@ -5,8 +5,12 @@ require 'timecode'
 require File.dirname(__FILE__) + '/depix/structs'
 
 module Depix
-  VERSION = '1.0.0'
-  BLANK_4, BLANK_2 = 0xFFFFFFFF, 0xFFFF
+  VERSION = '1.0.1'
+  
+  BLANK_2 = 0xFFFF #:nodoc:
+  BLANK_4 = 0xFFFFFFFF #:nodoc:
+  BLANK_F = 0xFFFFFFFF #:nodoc:
+  BLANK_CHAR = 0xFF #:nodoc:
   
   # Methodic hash - stolen from Camping
   class H < Hash
@@ -17,11 +21,37 @@ module Depix
     #   => :macadamian
     #
     def method_missing(m,*a)
-        m.to_s=~/=$/?self[$`]=a[0]:a==[]? (self.key?(m.to_sym) ? self[m.to_sym] : super ) : super
+        m.to_s=~/=$/ ? (self[$`] = a[0]) : (a == [] ? (self.key?(m.to_s) ? self[m.to_s] : super ) : super)
     end
     undef id, type
   end
   
+  # Offers convenience access to a few common attributes bypassing the piecemeal structs
+  module Synthetics
+    def keycode
+      [film.id, film.type, film.offset, film.prefix, film.count].compact.join(' ')
+    end
+    
+    def flame_reel
+      orientation.device.to_s.scan(/^(\w+)/).to_s
+    end
+    
+    def time_code
+      Timecode.from_uint(television.time_code, film.fps)
+    end
+    
+    # Get the name of the transfer function (Linear, Logarithmic, ...)
+    def colorimetric
+      Structs::COLORIMETRIC.invert[image.image_elements[0].colorimetric]
+    end
+    
+    # Get the name of the compnent type (RGB, YCbCr, ...)
+    def component_type
+      Structs::COMPONENT_TYPE.invert[image.image_elements[0].descriptor]
+    end
+
+  end
+  
   # Reads the metadata
   class Reader
     
@@ -36,12 +66,14 @@ module Depix
         new.from_string(str)
       end
       
+      # Returns a printable report on all the headers present in the string
       def describe_string(str)
         reader = new
         result = reader.deep_parse(str, Structs::DPX_INFO)
         reader.inform(result)
       end
-      
+
+      # Returns a printable report on all the headers present in the file at the path passed
       def describe_file(path)
         header = File.open(path, 'r') { |f| f.read(Structs::TEMPLATE_LENGTH) }
         describe_string(header)
@@ -81,9 +113,12 @@ module Depix
     end
     
     def wrap(result)
-      self.class.nestify(Structs::TEMPLATE_KEYS, result)
+      eich = self.class.nestify(Structs::TEMPLATE_KEYS, result)
+      class << eich; include Synthetics; end
+      eich
     end
     
+    # FIXME - currently no array handling
     def self.nestify(keys, values)
       auto_hash = H.new do |h,k| 
         h[k] = H.new(&h.default_proc)
@@ -104,20 +139,9 @@ module Depix
     end
     
     def unpad(string) # :nodoc:
-      string.gsub(0xFF.chr, '').gsub(0xFF.chr, '')
+      string.gsub("\000", '').gsub(0xFF.chr, '')
     end
     
-    TIME_FIELDS = 7 # :nodoc:
-
-    def uint_to_tc(timestamp)  # :nodoc:
-      shift = 4 * TIME_FIELDS;
-      tc_elements = (0..TIME_FIELDS).map do 
-        part = ((timestamp >> shift) & 0x0F)
-        shift -= 4
-        part
-      end.join.scan(/(\d{2})/).flatten.map{|e| e.to_i}
-      
-      Timecode.at(*tc_elements)
-    end
+    #:startdoc:
   end
 end

data/lib/depix/structs.rb

@@ -4,10 +4,6 @@ module Depix
   # Which is a reformulation of http://www.cineon.com/ff_draft.php
   #
   # Which is a preamble to some SMPTE crap that you have to buy for 14 bucks. Or download from http://www.cinesite.com/static/scanning/techdocs/dpx_spec.pdf
-  #
-  # It's very fragile - in the world of C, everything is fixed length. If Tolstoy wanted to write
-  # "War and Peace" in C he would need to know the number of letters ahead. It has good and bad
-  # qualities - the good ones being computers go faster like that. The rest are bad parts.
   module Structs
   
   COLORIMETRIC = {
@@ -55,7 +51,7 @@ module Depix
   #:stopdoc: 
   
   # To avoid fucking up with sizes afterwards
-  UINT, FLOAT, USHORT, UCHAR = 4, 4, 2, 1
+  U32, R32, U16, U8, UCHAR = 4, 4, 2, 1, 1
   
   def self.struct_size(struct_const) #:nodoc:
     struct_const.inject(0){| s, e | s + e[2]}
@@ -67,15 +63,15 @@ module Depix
   
   FILE_INFO = Struct[
     [:magic, String, 4],
-    [:image_offset, Integer, UINT],
+    [:image_offset, Integer, U32],
     
     [:version, String, 8],
     
-    [:file_size, Integer, UINT],
-    [:ditto_key, Integer, UINT],
-    [:generic_size, Integer, UINT],
-    [:industry_size, Integer, UINT],
-    [:user_size, Integer, UINT],
+    [:file_size, Integer, U32],
+    [:ditto_key, Integer, U32],
+    [:generic_size, Integer, U32],
+    [:industry_size, Integer, U32],
+    [:user_size, Integer, U32],
     
     [:filename, String, 100],
     [:timestamp, String, 24],
@@ -83,7 +79,7 @@ module Depix
     [:project, String, 200],
     [:copyright, String, 200],
     
-    [:encrypt_key, Integer, UINT],
+    [:encrypt_key, Integer, U32],
     [:reserve, String, 104],
   ]
 
@@ -95,12 +91,12 @@ module Depix
       [:count, String, 4],
       [:format, String, 32],
       
-      [:frame_position, Integer, UINT],
-      [:sequence_extent, Integer, UINT],
-      [:held_count, Integer, UINT],
+      [:frame_position, Integer, U32],
+      [:sequence_extent, Integer, U32],
+      [:held_count, Integer, U32],
     
-      [:frame_rate, Float, FLOAT],
-      [:shutter_angle, Float, FLOAT],
+      [:frame_rate, Float, R32],
+      [:shutter_angle, Float, R32],
       
       [:frame_id, String, 32],
       [:slate, String, 100],
@@ -109,57 +105,57 @@ module Depix
   
 
   IMAGE_ELEMENT = Struct[
-     [:data_sign, Integer, UINT],
-     [:low_data, Integer, UINT],
-     [:low_quantity, Float, FLOAT],
-     [:high_data, Integer, UINT],
-     [:high_quantity, Float, FLOAT],
+     [:data_sign, Integer, U32],
+     [:low_data, Integer, U32],
+     [:low_quantity, Float, R32],
+     [:high_data, Integer, U32],
+     [:high_quantity, Float, R32],
      
      # TODO: Autoreplace with enum values. Note: with these we will likely be addressing the enums
-     [:descriptor, String, UCHAR],
-     [:transfer, String, UCHAR],
-     [:colorimetric, String, UCHAR],
-     [:bit_size, String, UCHAR],
+     [:descriptor, Integer, U8],
+     [:transfer, Integer, U8],
+     [:colorimetric, Integer, U8],
+     [:bit_size, Integer, U8],
      
-     [:packing, Integer, USHORT],
-     [:encoding, Integer, USHORT],
-     [:data_offset, Integer, UINT],
-     [:end_of_line_padding, Integer, UINT],
-     [:end_of_image_padding, Integer, UINT],
+     [:packing, Integer, U16],
+     [:encoding, Integer, U16],
+     [:data_offset, Integer, U32],
+     [:end_of_line_padding, Integer, U32],
+     [:end_of_image_padding, Integer, U32],
      [:description, String, 32],
   ]
   
   IMAGE_ELEMENTS = (0..7).map{|e| [e, IMAGE_ELEMENT, struct_size(IMAGE_ELEMENT)] }
   
   IMAGE_INFO = Struct[
-    [:orientation, Integer, USHORT],
-    [:number_elements, Integer, USHORT],
+    [:orientation, Integer, U16],
+    [:number_elements, Integer, U16],
     
-    [:pixels_per_line, Integer, UINT],
-    [:lines_per_element, Integer, UINT],
+    [:pixels_per_line, Integer, U32],
+    [:lines_per_element, Integer, U32],
     
     [:image_elements, IMAGE_ELEMENTS, struct_size(IMAGE_ELEMENTS) ],
 
     [:reserve, String, 52],
   ]
   
-  BORDER = (0..3).map{|s| [s, Integer, USHORT] }
+  BORDER = (0..3).map{|s| [s, Integer, U16] }
 
   ASPECT_RATIO = [
-    [0, Integer, UINT],
-    [1, Integer, UINT],
+    [0, Integer, U32],
+    [1, Integer, U32],
   ]
   
   ORIENTATION_INFO = Struct[
   
-    [:x_offset, Integer, UINT],
-    [:y_offset, Integer, UINT],
+    [:x_offset, Integer, U32],
+    [:y_offset, Integer, U32],
     
-    [:x_center, Float, FLOAT],
-    [:y_center, Float, FLOAT],
+    [:x_center, Float, R32],
+    [:y_center, Float, R32],
     
-    [:x_size, Integer, UINT],
-    [:y_size, Integer, UINT],
+    [:x_size, Integer, U32],
+    [:y_size, Integer, U32],
     
     [:filename, String, 100],
     [:timestamp, String, 24],
@@ -173,30 +169,30 @@ module Depix
   ]
   
   TELEVISION_INFO = Struct[
-    [:time_code, Integer, UINT],
-    [:user_bits, Integer, UINT],
+    [:time_code, Integer, U32],
+    [:user_bits, Integer, U32],
     
-    [:interlace, String, UCHAR],
-    [:field_number, String, UCHAR],
-    [:video_signal, String, UCHAR],
-    [:padding, String, UCHAR],
+    [:interlace, Integer, U8],
+    [:field_number, Integer, U8],
+    [:video_signal, Integer, U8],
+    [:padding, Integer, U8],
     
-    [:horizontal_sample_rate, Float, FLOAT],
-    [:vertical_sample_rate, Float, FLOAT],
-    [:frame_rate, Float, FLOAT],
-    [:time_offset, Float, FLOAT],
-    [:gamma, Float, FLOAT],
-    [:black_level, Float, FLOAT],
-    [:black_gain, Float, FLOAT],
-    [:break_point, Float, FLOAT],
-    [:white_level, Float, FLOAT],
-    [:integration_times, Float, FLOAT],
+    [:horizontal_sample_rate, Float, R32],
+    [:vertical_sample_rate, Float, R32],
+    [:frame_rate, Float, R32],
+    [:time_offset, Float, R32],
+    [:gamma, Float, R32],
+    [:black_level, Float, R32],
+    [:black_gain, Float, R32],
+    [:break_point, Float, R32],
+    [:white_level, Float, R32],
+    [:integration_times, Float, R32],
     [:reserve, String, 76],
   ]
   
   USER_INFO = Struct[
     [:id, String, 32],
-    [:user_data, Integer, UINT],
+    [:user_data, Integer, U32],
   ]
   
   DPX_INFO = Struct[
@@ -242,7 +238,9 @@ module Depix
   end
   
   def self.integer_template(size, big_endian) #:nodoc:
-    if size == 2
+    if size == 1
+      "c"
+    elsif size == 2
       big_endian ? "n" : "v"
     elsif size == 4
       big_endian ? "N" : "V"

data/test/test_depix.rb

@@ -56,6 +56,16 @@ class StructsTest < Test::Unit::TestCase
   end
 end
 
+class EichTest < Test::Unit::TestCase
+  def test_eich
+    eich = Depix::H.new
+    assert_nothing_raised { assert_not_nil eich.foo = 1 }
+    assert_nothing_raised { eich.foo }
+    assert_equal ['foo'], eich.keys
+    assert_equal 1, eich.foo
+  end
+end
+
 class ReaderTest < Test::Unit::TestCase
   def test_nestify
     k, v = ["foo", "bar"], [1, 2]
@@ -77,11 +87,65 @@ class ReaderTest < Test::Unit::TestCase
     assert_equal( {"foo"=>1, "bar"=>{0=>{"dam"=>3, "baz"=>2}}}, Depix::Reader.nestify(k,v))
   end
   
-  def test_parse
+  def test_parsed_properly
+    file = 'samples/E012_P001_L000002_lin.0001.dpx'
+    parsed = Depix::Reader.from_file(file)
+    assert_equal "SDPX", parsed.file.magic
+    assert_equal 8192, parsed.file.image_offset
+    assert_equal "V1.0", parsed.file.version
+    assert_equal 319488, parsed.file.file_size
+    assert_equal 1, parsed.file.ditto_key
+    assert_equal 1664, parsed.file.generic_size
+    assert_equal 384, parsed.file.industry_size
+    assert_equal 6144, parsed.file.user_size
+    assert_equal "E012_P001_L000002_lin.0001.dpx", parsed.file.filename
+    assert_equal "2008:12:19:01:18:37:CEST", parsed.file.timestamp
+    assert_equal "UTODESK", parsed.file.creator
+    assert_equal 0, parsed.image.orientation
+    assert_equal 1, parsed.image.number_elements
+    assert_equal 320, parsed.image.pixels_per_line
+    assert_equal 240, parsed.image.lines_per_element
+    assert_equal 0, parsed.image.image_elements[0].data_sign
+    assert_equal 0, parsed.image.image_elements[0].low_data
+    assert_equal 0.0, parsed.image.image_elements[0].low_quantity
+    assert_equal 1023, parsed.image.image_elements[0].high_data
+    assert_in_delta 2.04699993133545, parsed.image.image_elements[0].high_quantity, 1.0 ** -10
+    
+    assert_equal 50, parsed.image.image_elements[0].descriptor # RGB :-)
+    assert_equal 2, parsed.image.image_elements[0].transfer
+    assert_equal 2, parsed.image.image_elements[0].colorimetric
+    assert_equal 10, parsed.image.image_elements[0].bit_size
+    assert_equal 1, parsed.image.image_elements[0].packing
+    assert_equal 0, parsed.image.image_elements[0].encoding
+    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�", 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]
+
+    assert_equal '75', parsed.film.id
+    assert_equal '00', parsed.film.type
+    assert_equal '19', parsed.film.offset
+    assert_equal '740612', parsed.film.prefix
+    assert_equal '9841', parsed.film.count
+    assert_equal 1, parsed.film.frame_position
+    assert_equal 2, parsed.film.sequence_extent
+    assert_equal 1, parsed.film.held_count
+    assert_equal 25.0, parsed.film.frame_rate
+    assert_equal 18157848, parsed.television.time_code
+    assert_equal 0, parsed.television.user_bits
+  end
+  
+  def test_syntethics
+    assert_nothing_raised { Depix::Synthetics }
+
     file = 'samples/E012_P001_L000002_lin.0001.dpx'
     parsed = Depix::Reader.from_file(file)
-    assert_equal 'SDPX', parsed.file.magic
-    assert_equal 320, image.pixels_per_line
-    assert_equal 240, image.lines_per_element
+    assert_equal "75 00 19 740612 9841", parsed.keycode
+    assert_equal :RGB, parsed.component_type
+    assert_equal :Linear, parsed.colorimetric
+    assert_equal "E012", parsed.flame_reel
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: depix
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -50,7 +50,7 @@ files:
 - test/samples/E012_P001_L000002_log.0001.dpx
 - test/samples/E012_P001_L000002_log.0002.dpx
 has_rdoc: true
-homepage: http://rubyforge.org/julik/depix
+homepage: http://wiretap.rubyforge.org/depix
 post_install_message: 
 rdoc_options: 
 - --main