depix 2.0.0 → 3.0.0

data/.travis.yml

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

data/DPX_HEADER_STRUCTURE.rdoc

@@ -21,7 +21,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
   * <tt>project</tt> (String) Project name
   * <tt>copyright</tt> (String) Copyright
   * <tt>encrypt_key</tt> Encryption key
-  * <tt>reserve</tt> (String)
+  * <tt>reserve</tt> (NilClass)
 * <tt>image</tt> (Depix::ImageInfo) Image information - required:
   * <tt>orientation</tt> (Integer) Orientation descriptor - required
   * <tt>number_elements</tt> (Integer) How many elements to scan - required
@@ -43,7 +43,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
     * <tt>end_of_line_padding</tt> End-of-line padding for this image element
     * <tt>end_of_image_padding</tt> End-of-line padding for this image element
     * <tt>description</tt> (String)
-  * <tt>reserve</tt> (String)
+  * <tt>reserve</tt> (NilClass)
 * <tt>orientation</tt> (Depix::OrientationInfo) Orientation - required:
   * <tt>x_offset</tt> 
   * <tt>y_offset</tt> 
@@ -57,7 +57,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
   * <tt>serial</tt> (String) Input device serial number
   * <tt>border</tt> (Array of 4 Integer fields) Border validity: XL, XR, YT, YB:
   * <tt>aspect_ratio</tt> (Array of 2  fields) Aspect (H:V):
-  * <tt>reserve</tt> (String)
+  * <tt>reserve</tt> (NilClass)
 * <tt>film</tt> (Depix::FilmInfo) Film industry info - required:
   * <tt>id</tt> (String) Film mfg. ID code (2 digits from film edge code)
   * <tt>type</tt> (String) Film type (2 digits from film edge code)
@@ -72,7 +72,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
   * <tt>shutter_angle</tt> (Float) Shutter angle
   * <tt>frame_id</tt> (String) Frame identification (keyframe)
   * <tt>slate</tt> (String) Slate information
-  * <tt>reserve</tt> (String)
+  * <tt>reserve</tt> (NilClass)
 * <tt>television</tt> (Depix::TelevisionInfo) TV industry info - required:
   * <tt>time_code</tt> Timecode, formatted as HH:MM:SS:FF in the 4 higher bits of each 8bit group
   * <tt>user_bits</tt> Timecode UBITs
@@ -90,7 +90,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
   * <tt>break_point</tt> (Float) Break point (?)
   * <tt>white_level</tt> (Float) White level
   * <tt>integration_times</tt> (Float) Integration times (S)
-  * <tt>reserve</tt> (Float)
+  * <tt>reserve</tt> (NilClass)
 * <tt>user</tt> (Depix::UserInfo) User info - required:
   * <tt>id</tt> (String) Name of the user data tag
   * <tt>user_data_ptr</tt> 

data/Gemfile

@@ -0,0 +1,13 @@
+# --ruby--
+source :rubygems
+
+gem"timecode", "~> 1.0"
+gem "progressbar", "~> 0.9"
+gem "sequencer", "~> 1.0"
+gem "term-ansicolor"
+
+group :development do
+  gem "jeweler"
+  gem "rake"
+  gem "cli_test", "~>1.0"
+end

data/History.txt

@@ -1,3 +1,17 @@
+=== 3.0.0 / 2011-11-29
+
+* Use jeweler for gem builds
+* depix-describe renamed with a dash. Sorry folks.
+* Adds depix_fix_headers to fix wonky headers with, for instance, improper null-termination
+* Multiple bug fixes
+  * Padded reserved fields not shown anymore
+  * More fields that have invalid values resolve to nil now
+  * fixed that Synthetics#aspect would return pixel aspect and not image aspect
+
+=== 2.0.1 / 2011-11-09
+
+* Fix the errors in depix-describe
+
 === 2.0.0 / 2011-06-14
 
 * Depix::Binary is now public, and it's a nice library. Check it out.

data/README.rdoc

@@ -27,17 +27,29 @@ have the same name as the specified fields.
 
 The gem also contains an executable called depix-desribe which can be used from the command line
   
-  $book depix-describe 001_PTAPE_001.001.dpx
+  $depix_describe 001_PTAPE_001.001.dpx
 
 for a long description or 
 
-  $book depix-describe -s 001_PTAPE_001.001.dpx 
+  $depix_describe -s 001_PTAPE_001.001.dpx 
+
+for a short description.
+
+If you have a file that does not import into some application you could run "fix headers" on it to comb
+out invalid data (or data some systems do not approve of). To do so, run depix_fix_headers. Note that the files
+will be modified in-place
+
+  $depix_fix_headers 001_PTAPE_001.001.dpx
+
+or for a whole sequence - just supply the -s flag and pass one file
+
+  $depix_fix_headers -s 001_PTAPE_001.001.dpx
 
-for a short description
 
 == NOTES:
 
 Autodesk IFFS systems write the reel name for the file to the orientation.device field, some scanners write it into user data.
+Currently unpacking slots which contain invalid reals and ints will yield the maximum possible value for the type
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -1,20 +1,34 @@
 require 'rubygems'
-require 'hoe'
 require './lib/depix'
+require 'jeweler'
 
-Hoe.spec('depix') do |p|
-  p.version = Depix::VERSION
-  p.developer('Julik Tarkhanov', 'me@julik.nl')
-  p.rubyforge_name = 'guerilla-di'
-  p.extra_deps << ['timecode']
-  p.remote_rdoc_dir = 'depix'
-  p.readme_file   = 'README.rdoc'
-  p.extra_rdoc_files  = FileList['*.rdoc']
-  
-  p.clean_globs = %w( **/.DS_Store )
+Jeweler::Tasks.new do |gem|
+  gem.version = Depix::VERSION
+  gem.name = "depix"
+  gem.summary = "Read and write DPX file headers"
+  gem.description = "Allos you to edit headers and read their contents parsed into Ruby objects"
+  gem.email = "me@julik.nl"
+  gem.homepage = "http://guerilla-di.org/depix"
+  gem.authors = ["Julik Tarkhanov"]
+  gem.extra_rdoc_files << "DEVELOPER_DOCS.rdoc"
+  gem.license = 'MIT'
+  gem.executables = ["depix_describe", "depix_fix_headers"]
+  gem.extra_rdoc_files  = FileList['*.rdoc']
 end
 
-task :describe_structs do
-  require File.dirname(__FILE__) + '/lib/depix/struct_explainer'
-  File.open('DPX_HEADER_STRUCTURE.rdoc', 'w') {|f| f << RdocExplainer.new.get_rdoc_for(Depix::DPX) }
+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 ]
+
+task :document_structs do
+  require './lib/depix/binary/descriptor'
+  File.open('DPX_HEADER_STRUCTURE.rdoc', 'w') {|f| f << Depix::Binary::RdocGenerator.new.get_rdoc_for(Depix::DPX) }
 end

data/bin/{depix-describe → depix_describe}

@@ -5,7 +5,7 @@ require 'optparse'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: depix-describe somefile.dpx anotherfile.dpx [options]"
+  opts.banner = "Usage: depix_describe somefile.dpx anotherfile.dpx [options]"
 
   opts.on("-c", "--compact", "Compact output (only fields that change per frame)") do |v|
     options[:compact] = true
@@ -18,15 +18,16 @@ OptionParser.new do |opts|
 end.parse!
 
 ARGV.each do | file |
+  puts "\n"
   puts "Describing DPX #{file}. Empty elements are omitted."
   puts "===================================================\n"
   begin
     if options[:synthetics]
-      puts Depix.describe_brief(file)
+      puts Depix::Describe.new.describe_brief(file)
     elsif options[:compact]
-      puts Depix.describe_file(file, true)
+      puts Depix::Describe.new.describe(file, true)
     else
-      puts Depix.describe_file(file)
+      puts Depix::Describe.new.describe(file)
     end
   rescue Depix::InvalidHeader
     puts " - Invalid header data"

data/bin/depix_fix_headers

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/depix'
+require "rubygems"
+require 'optparse'
+require "progressbar"
+require "sequencer"
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: depix_fix_headers somefile.dpx anotherfile.dpx" + "\n" +
+       "For sequences: depix_fix_headers -s one_file_from_the_sequence.dpx"
+
+  opts.on("-s", "--sequence", "Detect a sequence instead (pass one file from the sequence)") do |v|
+    $sequence = true
+  end
+end.parse!
+
+files = if $sequence
+  paths = []
+  Sequencer.from_single_file(ARGV.shift).each_path do | p |
+    paths.push(p)
+  end
+  paths
+else
+  ARGV
+end
+
+raise "No files provided" unless files.any?
+
+header = "Fixing headers in %d files" % files.length
+pbar = ProgressBar.new(header, files.length)
+pbar.format = "%-#{header.length}s %3d%% %s %s"
+
+files.each do | file |
+  pbar.inc
+  Depix::Editor.new(file).commit!
+end
+puts ""

data/depix.gemspec

@@ -0,0 +1,93 @@
+# 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 = "depix"
+  s.version = "3.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2011-11-29"
+  s.description = "Allos you to edit headers and read their contents parsed into Ruby objects"
+  s.email = "me@julik.nl"
+  s.executables = ["depix_describe", "depix_fix_headers"]
+  s.extra_rdoc_files = [
+    "DPX_HEADER_STRUCTURE.rdoc",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gemtest",
+    ".travis.yml",
+    "DPX_HEADER_STRUCTURE.rdoc",
+    "Gemfile",
+    "History.txt",
+    "README.rdoc",
+    "Rakefile",
+    "bin/depix_describe",
+    "bin/depix_fix_headers",
+    "depix.gemspec",
+    "lib/depix.rb",
+    "lib/depix/binary/fields.rb",
+    "lib/depix/binary/rdoc_generator.rb",
+    "lib/depix/binary/structure.rb",
+    "lib/depix/compact_structs.rb",
+    "lib/depix/describe.rb",
+    "lib/depix/editor.rb",
+    "lib/depix/enums.rb",
+    "lib/depix/reader.rb",
+    "lib/depix/structs.rb",
+    "lib/depix/synthetics.rb",
+    "test/samples/026_FROM_HERO_TAPE_5-3-1_MOV.0029.dpx",
+    "test/samples/E012_P001_L000002_lin.0001.dpx",
+    "test/samples/E012_P001_L000002_lin.0002.dpx",
+    "test/samples/E012_P001_L000002_log.0001.dpx",
+    "test/samples/E012_P001_L000002_log.0002.dpx",
+    "test/samples/from_nuke_no_TC_meta.dpx",
+    "test/samples/gluetools_file_header.dpx",
+    "test/samples/little_endian.dpx",
+    "test/samples/northlight_tc_mode_mismatch.dpx",
+    "test/samples/scratch.dpx",
+    "test/test_binary.rb",
+    "test/test_depix.rb",
+    "test/test_describe.rb",
+    "test/test_fix_headers.rb"
+  ]
+  s.homepage = "http://guerilla-di.org/depix"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Read and write DPX file headers"
+
+  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<timecode>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<progressbar>, ["~> 0.9"])
+      s.add_runtime_dependency(%q<sequencer>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<term-ansicolor>, [">= 0"])
+      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<timecode>, ["~> 1.0"])
+      s.add_dependency(%q<progressbar>, ["~> 0.9"])
+      s.add_dependency(%q<sequencer>, ["~> 1.0"])
+      s.add_dependency(%q<term-ansicolor>, [">= 0"])
+      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<timecode>, ["~> 1.0"])
+    s.add_dependency(%q<progressbar>, ["~> 0.9"])
+    s.add_dependency(%q<sequencer>, ["~> 1.0"])
+    s.add_dependency(%q<term-ansicolor>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<cli_test>, ["~> 1.0"])
+  end
+end
+

data/lib/depix.rb

@@ -12,9 +12,10 @@ require File.expand_path(File.dirname(__FILE__)) + '/depix/synthetics'
 require File.expand_path(File.dirname(__FILE__)) + '/depix/reader'
 require File.expand_path(File.dirname(__FILE__)) + '/depix/editor'
 
+require File.expand_path(File.dirname(__FILE__)) + '/depix/describe'
 
 module Depix
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
   
   class InvalidHeader < RuntimeError; end
   
@@ -31,15 +32,4 @@ module Depix
   def self.from_string(string, compact = false)
     Reader.new.parse(string, compact)
   end
-  
-  # Retrurn a formatted description of the DPX file at path. Empty values are omitted.
-  def self.describe_file(path, compact = false)
-    Reader.new.describe_file(path, compact)
-  end
-  
-  # Return a formatted description of the DPX file at path, showing only synthetic attributes
-  def self.describe_brief(path)
-    Reader.new.describe_synthetics_of_struct(from_file(path))
-  end
-  
 end

data/lib/depix/binary/fields.rb

@@ -1,15 +1,15 @@
-module Depix
-  module Binary
-  module Fields
+# coding: ASCII-8BIT
+module Depix; module Binary; module Fields
   
   # Base class for a padded field in a struct
   class Field
-    attr_accessor :name, # Field name
-                  :length, # Field length in bytes, including any possible padding
-                  :pattern, # The unpack pattern that defines the field
-                  :req, # Is the field required?
-                  :desc, # Field description
-                  :rtype  # To which Ruby type this has to be cast (and which type is accepted as value)
+    attr_accessor :name # Field name
+    attr_accessor :length # Field length in bytes, including any possible padding
+    attr_accessor :pattern # The unpack pattern that defines the field
+    attr_accessor :req # Is the field required?
+    attr_accessor :desc # Field description
+    attr_accessor :rtype  # To which Ruby type this has to be cast (and which type is accepted as value)
+    
     alias_method :req?, :req
     
     # Hash init
@@ -53,6 +53,11 @@ module Depix
         [value].pack(pattern)
       end
     end
+    
+    private
+    def blanking?(blob)
+      blob.nil? || blob.empty? || blob == (0xFF.chr * length)
+    end
   end
   
   # unit32 field
@@ -84,7 +89,7 @@ module Depix
   # uint8 field
   class U8Field < Field
     undef :length=, :pattern=
-
+    
     BLANK = 0xFF
 
     def pattern
@@ -144,26 +149,36 @@ module Depix
     end
     
     def clean(v)
-      v == BLANK ? nil : v
+      (v == BLANK || v == -1) ? nil : v
     end
     
     def validate!(value)
       super(value)
       raise "#{name} value #{value} out of bounds for 16bit unsigned int" if (value < 0 || value >= BLANK)
     end
+    
   end
   
-  # real32 field
+  # real32 field. Now, there is some lap dancing to be done here.
+  # The DPX files in the wild define nonexistant data as a charfield with all
+  # it's bits set (four times 0xFF byte). This is easy to verify with a string
+  # but practically useless once the charfield has been unpacked into a float.
+  # Therefore we first unpack the value as a charfield, then we check whether it's all
+  # blanking, and if it is we return nil. If it's not "all bits set" though what we will do
+  # is try to decode it again using the real float unpack pattern. The same dance
+  # happens reciprocally when repacking the data.
   class R32Field < Field
     undef :length=, :pattern=
-    BLANK = 0xFFFFFFFF
+    BLANK = (0xFF.chr * 4)
+    PATTERN_BE = "g"
+    PATTERN_LE = "n"
     
     def pattern
       "g"
     end
     
     def clean(v)
-      v.nan? ? nil : v
+      (v.nil? || v.nan?) ? nil : v
     end
     
     def length
@@ -173,34 +188,35 @@ module Depix
     def rtype
       Float
     end
+    
+    # The packing of NaN
+    # [12] pry(main)> value = 0 / 0.0
+    # => NaN
+    # [13] pry(main)> [value].pack("g")
+    # => "\xFF\xC0\x00\x00"
+    # [14] pry(main)> [value].pack("g")
+    def pack(value)
+      (value.nil? || value.nan? ) ? BLANK : [value].pack("g")
+    end
   end
   
   # null-terminated string field with fixed padding
   class CharField < Field
-    BLANK = "\0"
     undef :pattern=
     
-    BLANKING_VALUES = [0x00.chr, 0xFF.chr]
-    BLANKING_PATTERNS = BLANKING_VALUES.inject([]) do | p, char |
-      p << /^([#{char}]+)/ << /([#{char}]+)$/mu
-    end
-    
     def initialize(opts = {})
       super({:length => 1}.merge(opts))
     end
     
     def pattern
-      "A#{(length || 1).to_i}"
+      "Z#{length}"
     end
     
     def clean(v)
-      if v == BLANK
-        nil
-      else
-        # Truncate everything from the null byte up
-        upto_nulb = v.split(0x00.chr).shift
-        (upto_nulb.nil? || upto_nulb.empty?) ? nil : upto_nulb
-      end
+      # Use the pack->unpack trick to remove null-termination
+      v = pack(v.to_s).unpack(pattern)[0]
+      # Blanked fields are 0xFF all the way
+      blanking?(v) ? nil : v
     end
     
     def rtype
@@ -213,7 +229,35 @@ module Depix
     end
     
     def pack(value)
-      value.ljust(length, "\000") rescue ("\000" * length)
+      unless blanking?(value)
+        [value].pack(pattern)
+      else
+        0xFF.chr * length
+      end
+    end
+  end
+  
+  # For reserved fields and blanking 
+  class BlankingField < CharField
+    
+    def validate!(value)
+      raise "The value of this field should be nil" unless value.nil?
+    end
+    
+    def pattern
+      "Z#{length}"
+    end
+    
+    def clean(v)
+      nil
+    end
+    
+    def rtype
+      NilClass
+    end
+    
+    def pack(value)
+      0xFF.chr * length
     end
   end
   
@@ -297,6 +341,4 @@ module Depix
       cast.pack(value)
     end
   end
-end
-end
-end
+end; end; end