depix 3.0.0 → 3.0.1

data/Gemfile

@@ -5,6 +5,7 @@ gem"timecode", "~> 1.0"
 gem "progressbar", "~> 0.9"
 gem "sequencer", "~> 1.0"
 gem "term-ansicolor"
+gem "update_hints"
 
 group :development do
   gem "jeweler"

data/README.rdoc

@@ -1,10 +1,12 @@
-= depix
+Film scans and images are usualy shoved about in http://en.wikipedia.org/wiki/Digital_Picture_Exchange files.
+These files embed a massive amount of metadata which can be used to automatically catalog and search in big
+file collections (and searching is essential since a complete feature film will run well into tens of thousands
+of files). Reading this metadata can easily help with cumbersome tasks like sorting DPX files per reel/timecode,
+resolution, selective copying/processing and such daily tasks.
 
-* http://guerilla-di.org/depix
+Additionally, **depix** supports editing of DPX metadata without the need to copy the file over (since files can
+be big). The metadata gets modified in-place without any copy operations, which is especially helpful when operating across a network.
 
-== DESCRIPTION:
-
-Read and write DPX file metadata
 
 == SYNOPSIS:
 
@@ -35,6 +37,34 @@ for a long description or
 
 for a short description.
 
+  $depix_describe ~/Desktop/Storm/E036/E036_L005.0007.dpx
+  Describing DPX /Users/julik/Desktop/Storm/E036/E036_L005.0007.dpx. Empty elements are omitted.
+  ===================================================
+  File information   Endianness (SDPX is big endian) SDPX
+    Offset to image data in bytes 8192
+    Version of header format V1.0
+    Total image size in bytes 9641984
+    Whether the basic headers stay the same through the sequence (1 means they do) 1
+    Generic header length 1664
+    Industry header length 384
+    User header length 6144
+    Original filename E036_L005.0007.dpx
+    Creation 15 2009:02:13:11:19:37+10
+    Creator application ARRISCAN077
+    Project name De_Storm_VFX
+  ..... lots of info...
+  
+  
+  Synthetic properties
+  ============
+  keycode : 02 05 32 173388 6668
+  component_type : RGB
+  colorimetric : UserDefined
+  aspect : 1.00
+  le? : false
+  time_code : 03:38:02:01
+  flame_reel : 000005
+
 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
@@ -51,6 +81,10 @@ or for a whole sequence - just supply the -s flag and pass one file
 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
 
+Scanning tens of thousands of files is slow, not because Ruby is slow per se but because the disk is constantly
+on seek. It is recommended to **cache** the whole bulk of your metadata objects for later reuse, which is perfectly
+easy since Depix objects are serializable.
+
 == REQUIREMENTS:
 
 * timecode gem (sudo gem install timecode)

data/Rakefile

@@ -6,7 +6,7 @@ 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.description = "Allows you to read and edit DPX file headers parsed into Ruby objects"
   gem.email = "me@julik.nl"
   gem.homepage = "http://guerilla-di.org/depix"
   gem.authors = ["Julik Tarkhanov"]

data/bin/depix-describe

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$stderr.puts "WARNING: depix-describe is now called depix_describe (that is undersores instead of dashes)"
+$stderr.puts "Uninstall old versions of the depix gem so that the old binary disappears from your shell completions"
+exit 1
+

data/bin/depix_describe

@@ -2,6 +2,7 @@
 
 require File.dirname(__FILE__) + '/../lib/depix'
 require 'optparse'
+require "update_hints"
 
 options = {}
 OptionParser.new do |opts|
@@ -32,4 +33,5 @@ ARGV.each do | file |
   rescue Depix::InvalidHeader
     puts " - Invalid header data"
   end
-end
+end
+UpdateHints.version_check("depix", Depix::VERSION)

data/depix.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "depix"
-  s.version = "3.0.0"
+  s.version = "3.0.1"
 
   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.date = "2012-07-16"
+  s.description = "Allows you to read and edit DPX file headers parsed into Ruby objects"
   s.email = "me@julik.nl"
   s.executables = ["depix_describe", "depix_fix_headers"]
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "History.txt",
     "README.rdoc",
     "Rakefile",
+    "bin/depix-describe",
     "bin/depix_describe",
     "bin/depix_fix_headers",
     "depix.gemspec",
@@ -57,7 +58,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://guerilla-di.org/depix"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
+  s.rubygems_version = "1.8.24"
   s.summary = "Read and write DPX file headers"
 
   if s.respond_to? :specification_version then
@@ -68,6 +69,7 @@ Gem::Specification.new do |s|
       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_runtime_dependency(%q<update_hints>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<cli_test>, ["~> 1.0"])
@@ -76,6 +78,7 @@ Gem::Specification.new do |s|
       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<update_hints>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<cli_test>, ["~> 1.0"])
@@ -85,6 +88,7 @@ Gem::Specification.new do |s|
     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<update_hints>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<cli_test>, ["~> 1.0"])

data/lib/depix.rb

@@ -15,7 +15,7 @@ require File.expand_path(File.dirname(__FILE__)) + '/depix/editor'
 require File.expand_path(File.dirname(__FILE__)) + '/depix/describe'
 
 module Depix
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
   
   class InvalidHeader < RuntimeError; end
   

data/lib/depix/compact_structs.rb

@@ -5,7 +5,8 @@ module Depix
     :magic,
     :ditto_key,
     :filename,
-    :timestamp 
+    :timestamp,
+    :image_offset 
   )
   
   
@@ -14,7 +15,12 @@ module Depix
     :count,
     :frame_position,
     :frame_id,
-    :slate
+    :slate,
+    :id,
+    :type,
+    :prefix,
+    :sequence_extent,
+    :frame_rate
   )
   
   CompactOrientation = OrientationInfo.only(

data/test/test_depix.rb

@@ -88,7 +88,29 @@ class ReaderTest < Test::Unit::TestCase
   
   def test_parsed_properly_using_compact_structs
     file = SAMPLE_DPX
-    assert_nothing_raised { Depix.from_file(file, compact = true) }
+    
+    parsed = Depix.from_file(file, compact = true)
+    assert_equal "SDPX", parsed.file.magic
+    assert_equal 8192, parsed.file.image_offset
+    assert_equal 1, parsed.file.ditto_key
+    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 "E012", 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 25.0, parsed.film.frame_rate
+    assert_equal 18157848, parsed.television.time_code
+    assert_equal 0, parsed.television.user_bits
   end
   
   def test_packing

data/test/test_describe.rb

@@ -4,6 +4,7 @@ require "cli_test"
 
 class TestDescribe < Test::Unit::TestCase
   BIN_P = File.dirname(__FILE__) + "/../bin/depix_describe"
+  OBSOLETE_BINARY = File.dirname(__FILE__) + "/../bin/depix-describe"
   SAMPLE_DPX = File.dirname(__FILE__) + '/samples/E012_P001_L000002_lin.0001.dpx'
   
   def test_app
@@ -12,6 +13,12 @@ class TestDescribe < Test::Unit::TestCase
     assert o.include?("03:09:00:17"), "Should include the timecode"
   end
   
+  def test_obsolete_binary
+    s, o, e = CLITest.new(OBSOLETE_BINARY).run(File.dirname(__FILE__) + "/samples/gluetools_file_header.dpx")
+    assert !s.zero?
+    assert_match /is now called/, e
+  end
+  
   def test_describe_class_simple
     desc =  Depix::Describe.new.describe(SAMPLE_DPX)
     assert_match(/320/, desc)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: depix
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-29 00:00:00.000000000 Z
+date: 2012-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: timecode
-  requirement: &10534200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *10534200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: progressbar
-  requirement: &10533900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *10533900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: sequencer
-  requirement: &10533550 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,31 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *10533550
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &10533130 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: update_hints
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +85,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10533130
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &10532890 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10532890
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10532610 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10532610
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cli_test
-  requirement: &10532240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,8 +133,13 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *10532240
-description: Allos you to edit headers and read their contents parsed into Ruby objects
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Allows you to read and edit DPX file headers parsed into Ruby objects
 email: me@julik.nl
 executables:
 - depix_describe
@@ -105,6 +156,7 @@ files:
 - History.txt
 - README.rdoc
 - Rakefile
+- bin/depix-describe
 - bin/depix_describe
 - bin/depix_fix_headers
 - depix.gemspec
@@ -146,6 +198,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1469233932135135424
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -154,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Read and write DPX file headers