depix 1.0.4 → 1.0.5

data/DPX_HEADER_STRUCTURE.txt

@@ -6,7 +6,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
 
 == Metadata structure
 
-* <tt>file</tt> (Depix::FileInfo) File information:
+* <tt>file</tt> (Depix::FileInfo) File information - required:
   * <tt>magic</tt> (String) Endianness (SDPX is big endian) - required
   * <tt>image_offset</tt> Offset to image data in bytes - required
   * <tt>version</tt> (String) Version of header format - required
@@ -16,13 +16,13 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
   * <tt>industry_size</tt> Industry header length
   * <tt>user_size</tt> User header length
   * <tt>filename</tt> (String) Original filename
-  * <tt>timestamp</tt> (String) Creation 15
+  * <tt>timestamp</tt> (String) Creation timestamp
   * <tt>creator</tt> (String) Creator application
   * <tt>roject</tt> (String) Project name
   * <tt>copyright</tt> (String) Copyright
   * <tt>encrypt_key</tt> Encryption key
   * <tt>reserve</tt> (String)
-* <tt>image</tt> (Depix::ImageInfo) Image information:
+* <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
   * <tt>pixels_per_line</tt> Pixels per horizontal line - required
@@ -44,7 +44,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
     * <tt>end_of_image_padding</tt> End-of-line padding for this image element
     * <tt>description</tt> (String)
   * <tt>reserve</tt> (String)
-* <tt>orientation</tt> (Depix::OrientationInfo) Orientation:
+* <tt>orientation</tt> (Depix::OrientationInfo) Orientation - required:
   * <tt>x_offset</tt> 
   * <tt>y_offset</tt> 
   * <tt>x_center</tt> (Float)
@@ -58,7 +58,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
   * <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>film</tt> (Depix::FilmInfo) Film industry info:
+* <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)
   * <tt>offset</tt> (String) Offset in perfs (2 digits from film edge code)
@@ -73,7 +73,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
   * <tt>frame_id</tt> (String) Frame identification (keyframe)
   * <tt>slate</tt> (String) Slate information
   * <tt>reserve</tt> (String)
-* <tt>television</tt> (Depix::TelevisionInfo) TV industry info:
+* <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
   * <tt>interlace</tt> (Integer) Interlace (0 = noninterlaced; 1 = 2:1 interlace
@@ -91,7 +91,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
   * <tt>white_level</tt> (Float) White level
   * <tt>integration_times</tt> (Float) Integration times (S)
   * <tt>reserve</tt> (Float)
-* <tt>user</tt> (Depix::UserInfo) User info:
+* <tt>user</tt> (Depix::UserInfo) User info - required:
   * <tt>id</tt> (String) Name of the user data tag
   * <tt>user_data_ptr</tt> 
 

data/History.txt

@@ -1,6 +1,11 @@
-=== 1.0.4 / 2008-12-23
+=== 1.0.5 / 2009-01-18
+
+* Switch project to guerilla-di
+
+=== 1.0.4 / 2008-12-25
 
 * Add brief inspect
+* Add metadata editing
 
 === 1.0.3 / 2008-12-23
 

data/Manifest.txt

@@ -1,21 +1,22 @@
+DPX_HEADER_STRUCTURE.txt
 History.txt
 Manifest.txt
 README.txt
-DPX_HEADER_STRUCTURE.txt
 Rakefile
 bin/depix-describe
+depix.gemspec
 lib/depix.rb
-lib/depix/struct_explainer.rb
-lib/depix/structs.rb
 lib/depix/benchmark.rb
 lib/depix/compact_structs.rb
-lib/depix/enums.rb
 lib/depix/dict.rb
-lib/depix/reader.rb
 lib/depix/editor.rb
-test/test_dict.rb
-test/test_depix.rb
+lib/depix/enums.rb
+lib/depix/reader.rb
+lib/depix/struct_explainer.rb
+lib/depix/structs.rb
 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/E012_P001_L000002_log.0002.dpx
+test/test_depix.rb
+test/test_dict.rb

data/Rakefile

@@ -2,13 +2,9 @@ require 'rubygems'
 require 'hoe'
 require './lib/depix'
 
-Class.new(Hoe) do
-  def extra_deps
-    super.reject {|e| e[0] == 'hoe' }
-  end
-end.new('depix', Depix::VERSION) do |p|
+Hoe.new('depix', Depix::VERSION) do |p|
   p.developer('Julik Tarkhanov', 'me@julik.nl')
-  p.rubyforge_name = 'wiretap'
+  p.rubyforge_name = 'guerilla-di'
   p.extra_deps << 'timecode'
   p.remote_rdoc_dir = 'depix'
 end

data/depix.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |s|
+  s.name = %q{depix}
+  s.version = "1.0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julik Tarkhanov"]
+  s.date = %q{2008-12-26}
+  s.default_executable = %q{depix-describe}
+  s.description = %q{Read DPX file metadata}
+  s.email = ["me@julik.nl"]
+  s.executables = ["depix-describe"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt", "DPX_HEADER_STRUCTURE.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "DPX_HEADER_STRUCTURE.txt", "Rakefile", "bin/depix-describe", "lib/depix.rb", "lib/depix/struct_explainer.rb", "lib/depix/structs.rb", "lib/depix/benchmark.rb", "lib/depix/compact_structs.rb", "lib/depix/enums.rb", "lib/depix/dict.rb", "lib/depix/reader.rb", "lib/depix/editor.rb", "test/test_dict.rb", "test/test_depix.rb", "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"]
+  s.has_rdoc = true
+  s.homepage = %q{http://guerilla-di.rubyforge.org/depix}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{guerilla-di}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Read DPX file metadata}
+  s.test_files = ["test/test_depix.rb", "test/test_dict.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
+    else
+      s.add_dependency(%q<hoe>, [">= 1.8.2"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 1.8.2"])
+  end
+end

data/lib/depix.rb

@@ -10,13 +10,14 @@ require File.dirname(__FILE__) + '/depix/editor'
 
 
 module Depix
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
   
   class InvalidHeader < RuntimeError; end
   
   # Offers convenience access to a few common attributes bypassing the piecemeal structs
   module Synthetics
     
+    # Get formatted keycode as string, empty elements are omitted
     def keycode
       [film.id, film.type, film.offset, film.prefix, film.count].compact.join(' ')
     end
@@ -32,6 +33,7 @@ module Depix
       orientation.device = new_reel
     end
     
+    # Get television.time_code as a Timecode object with a framerate
     def time_code
       Timecode.from_uint(television.time_code) #, film.frame_rate)
     end
@@ -51,7 +53,7 @@ module Depix
       COMPONENT_TYPE.invert[image.image_elements[0].descriptor]
     end
     
-    # Aspect in it's traditional repr
+    # Aspect in it's traditional representation (1.77 for 16x9 and so on)
     def aspect
       "%.2f" % (orientation.aspect_ratio[0].to_f / orientation.aspect_ratio[1].to_f)
     end

data/lib/depix/structs.rb

@@ -15,7 +15,7 @@ module Depix
     u32  :user_size,      :desc => 'User header length'
     
     char :filename, 100,  :desc => 'Original filename'
-    char :timestamp, 24,  :desc => 'Creation 15'
+    char :timestamp, 24,  :desc => 'Creation timestamp'
     char :creator, 100,   :desc => 'Creator application'
     char :roject, 200,    :desc => 'Project name'
     char :copyright, 200, :desc => 'Copyright'

data/test/test_depix.rb

@@ -20,25 +20,30 @@ class ReaderTest < Test::Unit::TestCase
     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 1, parsed.image.number_elements
+    assert_equal 1, parsed.image.image_elements.length
+    ie = parsed.image.image_elements[0]
+    
+    assert_equal 0, ie.data_sign
+    assert_equal 0, ie.low_data
+    assert_equal 0.0, ie.low_quantity
+    assert_equal 1023, ie.high_data
+    assert_in_delta 2.04699993133545, ie.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        \000P", parsed.image.image_elements[0].description
+    assert_equal 50,    ie.descriptor # RGB :-)
+    assert_equal 2,     ie.transfer
+    assert_equal 2,     ie.colorimetric
+    assert_equal 10,    ie.bit_size
+    assert_equal 1,     ie.packing
+    assert_equal 0,     ie.encoding
+    assert_equal 8192,  ie.data_offset
+    assert_equal 0,     ie.end_of_line_padding
+    assert_equal 0,     ie.end_of_image_padding
+    assert_equal "IMAGE DESCRIPTION DATA        \000P", ie.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
     
@@ -122,7 +127,7 @@ class EditorTest < Test::Unit::TestCase
     begin
       FileUtils.cp(SAMPLE_DPX, temp_path)
       e  = Depix::Editor.new(temp_path)
-      e.headers.orientation.device = "E013"
+      e.headers.flame_reel = "E013"
 
       assert_nothing_raised { e.commit! }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: depix
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-26 00:00:00 +01:00
+date: 2009-01-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: timecode
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -30,32 +40,33 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- DPX_HEADER_STRUCTURE.txt
 - History.txt
 - Manifest.txt
 - README.txt
-- DPX_HEADER_STRUCTURE.txt
 files: 
+- DPX_HEADER_STRUCTURE.txt
 - History.txt
 - Manifest.txt
 - README.txt
-- DPX_HEADER_STRUCTURE.txt
 - Rakefile
 - bin/depix-describe
+- depix.gemspec
 - lib/depix.rb
-- lib/depix/struct_explainer.rb
-- lib/depix/structs.rb
 - lib/depix/benchmark.rb
 - lib/depix/compact_structs.rb
-- lib/depix/enums.rb
 - lib/depix/dict.rb
-- lib/depix/reader.rb
 - lib/depix/editor.rb
-- test/test_dict.rb
-- test/test_depix.rb
+- lib/depix/enums.rb
+- lib/depix/reader.rb
+- lib/depix/struct_explainer.rb
+- lib/depix/structs.rb
 - 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/test_depix.rb
+- test/test_dict.rb
 has_rdoc: true
 homepage: http://wiretap.rubyforge.org/depix
 post_install_message: 
@@ -78,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: wiretap
+rubyforge_project: guerilla-di
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2