discreet_proxy 0.0.1 → 1.0.0

data/README.rdoc

@@ -7,11 +7,19 @@ To read every .p file on your Flame system and write it out as a PNG preview to
   Dir.glob("/usr/discreet/project/**/*.p").each do | icon_path |
     proxy = DiscreetProxy.from_file(icon_path)
     dest_path = "/tmp/" + File.basename(icon_path) + ".png"
-    proxy.save_png(icon_path)
+    proxy.save_png(dest_path)
   end
   
 Also you can use the builtin `flame_proxy_icon` binary to convert to and from the format.
 
+  $flame_proxy_icon --from-png my_icon.png
+  
+will create "my_icon.p", and the reverse
+
+  $flame_proxy_icon --from-icon SuperSetup.batch.p
+
+will create a SuperSetup.batch.png file that you can massage in, say, Photoshop.
+
 == Contributing to discreet_proxy
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/discreet_proxy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "discreet_proxy"
-  s.version = "0.0.1"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2011-12-10"
+  s.date = "2011-12-13"
   s.email = "me@julik.nl"
   s.executables = ["flame_proxy_icon"]
   s.extra_rdoc_files = [
@@ -23,10 +23,10 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "bin/flame_proxy_icon",
+    "discreet_proxy.gemspec",
     "lib/discreet_proxy.rb",
     "test/converted_png_proxies/Kanaty.stabilizer.p.p.png",
     "test/converted_png_proxies/Medianize.stabilizer.p.p.png",
-    "test/converted_png_proxies/Portretten_Erasmusbrug_Pts.stabilizer.p.p.png",
     "test/converted_png_proxies/Ripples.glsl.p.p.png",
     "test/converted_png_proxies/Tezt_flame_5_trackers.stabilizer.p.p.png",
     "test/converted_png_proxies/doberman.batch.p.p.png",
@@ -36,10 +36,10 @@ Gem::Specification.new do |s|
     "test/converted_png_proxies/spontaan2.stabilizer.p.p.png",
     "test/converted_png_proxies/t2.batch.p.p.png",
     "test/helper.rb",
+    "test/test_cli.rb",
     "test/test_discreet_proxy.rb",
     "test/test_proxies/Kanaty.stabilizer.p",
     "test/test_proxies/Medianize.stabilizer.p",
-    "test/test_proxies/Portretten_Erasmusbrug_Pts.stabilizer.p",
     "test/test_proxies/Ripples.glsl.p",
     "test/test_proxies/Tezt_flame_5_trackers.stabilizer.p",
     "test/test_proxies/doberman.batch.p",
@@ -47,7 +47,8 @@ Gem::Specification.new do |s|
     "test/test_proxies/e292_v02shadow.batch.p",
     "test/test_proxies/spontaan.stabilizer.p",
     "test/test_proxies/spontaan2.stabilizer.p",
-    "test/test_proxies/t2.batch.p"
+    "test/test_proxies/t2.batch.p",
+    "test/test_proxy_out/Kanaty.stabilizer.p"
   ]
   s.homepage = "http://github.com/julik/discreet_proxy"
   s.licenses = ["MIT"]
@@ -63,17 +64,20 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<cli_test>, [">= 0"])
     else
       s.add_dependency(%q<chunky_png>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<cli_test>, [">= 0"])
     end
   else
     s.add_dependency(%q<chunky_png>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<cli_test>, [">= 0"])
   end
 end
 

data/lib/discreet_proxy.rb

@@ -2,7 +2,7 @@ require "chunky_png"
 
 # The whole module for making and reading Flame proxy icon files
 module DiscreetProxy
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
   
   # Parse a .p file and return a Proxy
   def self.from_file(path)
@@ -43,36 +43,15 @@ module DiscreetProxy
   VERSION_BSWAP = "\x00\x00?\x8C\xCC\xCD"
   DEFAULT_WIDTH = 126
   DEFAULT_HEIGHT = 92
-  
-  # Here's what Autodesk has to say:
-  #
-  # You can use Flame to create a proxy of your effect, but if you don't have access to Flame, 
-  # or want to create proxies programmatically, you
-  # can use the following header (byteswap). The standard width and height of the proxy is 126x92, and the
-  # file is RGB 8-bit. Save your proxy files as .p, and place them in the same folder as your .glsl and .xml
-  # files of the same name.
-  # 
-  #typedef struct {
-  #        unsigned short Magic;
-  #        float  Version; // 6 bytes long
-  #        short  Width;
-  #        short  Height;
-  #        short  Depth;
-  #        float  Unused [ 6 ];
-  #} LibraryProxyHeaderStruct;
-  # and this bitch is 6 bytes aligned
-  #
-  ##define MAGIC 0xfaf0
-  ##define PROXY_VERSION 1.1f
-  ##define PROXY_DEPTH 130
-  #
-  # This class represents such a proxy.
+
+  # This class represents a proxy.
   class Proxy
     
     # Image dimensions, standard is 126x92
     attr_reader :width, :height
     
-    # Array of rows with each row being an array of 3-valut RGB triplets
+    # Array of rows with each row being an array of packed color 
+    # integers (you can unpack them with ChunkyPNG::Color)
     attr_reader :rows 
     
     def initialize(w = DEFAULT_WIDTH, h = DEFAULT_HEIGHT)
@@ -84,11 +63,11 @@ module DiscreetProxy
     def to_png
       png = ChunkyPNG::Image.new(@width, @height)
       png.metadata["Software"] = "Ruby DiscreetProxy converter/chunky_png"
-      @rows.each_with_index do | row, row_idx |
-        row.each_with_index do | pix, col_idx |
-          png[col_idx, row_idx] = pix
-        end
+      @rows.each_with_index do | row, y |
+        png.replace_row!(y, row)
       end
+      # Bump it to the default icon size
+      png.resample_bilinear!(DEFAULT_WIDTH, DEFAULT_HEIGHT)
       png
     end
     
@@ -123,8 +102,9 @@ module DiscreetProxy
       buf.seek(40)
       
       # Now... all the reverses come in reverse
-      @rows.reverse.each do | returning_row |
-        returning_row.each do | pix |
+      (0...@rows.length).each do | row_offset |
+        row_idx = (@rows.length - 1) - row_offset
+        @rows[row_idx].each do | pix |
           rgb = unpack_rgb(pix).pack("CCC")
           buf.write(rgb) 
         end
@@ -140,34 +120,30 @@ module DiscreetProxy
     def fill_pixbuf(io)
       @rows = []
       
-      # Data comes in row per row, starting on lower left with
-      # the values in the row being mirrored
+      # Data comes in row per row, starting on bottom left because of endianness
       per_row = (@width.to_i + row_pad) * 3
-      total_size = (per_row * @height) + 1
-      # First byteswap is when reading rows. We want to read from
-      # the bottom, so...
-      blob = StringIO.new(io.read(total_size).reverse)
+      total_size = ((per_row + row_pad) * @height) + 1
+      blob = StringIO.new(io.read(total_size))
       
       @height.times do
-        # At the end of each row (thus at the beginning byteswap),
-        # 2 bytes contain garbage since rows are aligned
-        # to start at 8-complement byte offsets. If they are not discarded this disturbs
-        # the RGB cadence of the other values.
-        skip = blob.read(row_pad)
-        
         row = []
         row_data = blob.read(@width.to_i * 3)
         row_data = StringIO.new(row_data.to_s)
         
         # Read 3x8bit for each pixel
         @width.times do
-          # And guess what - here they are reversed too! How awesome is that!
-          rgb = (row_data.read(3) || "AAA").unpack("CCC").reverse
+          rgb = (row_data.read(3) || "AAA").unpack("CCC")
           row.push(pack_rgb(*rgb))
         end
         
-        # Abd the row itself is reversed too
-        @rows.push(row.reverse)
+        # At the end of each row (thus at the beginning byteswap),
+        # 2 bytes contain garbage since rows are aligned
+        # to start at 8-complement byte offsets. If they are not discarded this disturbs
+        # the RGB cadence of the other values.
+        blob.seek(blob.pos + row_pad)
+        
+        # Since the file is actually BE, the rows are ordered top to bottom in the file
+        @rows.unshift(row)
       end
     end
     

data/test/test_discreet_proxy.rb

@@ -49,8 +49,7 @@ class TestDiscreetProxy < Test::Unit::TestCase
     Dir.glob(File.dirname(__FILE__) + "/test_proxies/*.p").each do | f |
       proxy = DiscreetProxy.from_file(f)
       png_path = File.dirname(__FILE__) + "/converted_png_proxies/%s.p.png" % File.basename(f)
-      chunky_png = proxy.to_png
-      assert_equal chunky_png, ChunkyPNG::Image.from_file(png_path)
+      assert_same_png ChunkyPNG::Image.from_file(png_path), proxy.to_png
     end
   end
   
@@ -58,10 +57,7 @@ class TestDiscreetProxy < Test::Unit::TestCase
     f = File.dirname(__FILE__) + "/converted_png_proxies/Kanaty.stabilizer.p.p.png"
     png = ChunkyPNG::Image.from_file(f)
     proxy = DiscreetProxy.from_png(png)
-    roundtrip_png = proxy.to_png
-    
-    dest = '/tmp/foo_%s' % File.basename(f)
-    assert_equal png, roundtrip_png
+    assert_same_png png, proxy.to_png
   end
   
   TEST_OUTPUT = "./test.p"
@@ -75,9 +71,11 @@ class TestDiscreetProxy < Test::Unit::TestCase
   
   def test_save
     path = File.dirname(__FILE__) + "/test_proxies/Kanaty.stabilizer.p"
+    ref_output = File.dirname(__FILE__) + "/test_proxy_out/Kanaty.stabilizer.p"
     proxy = DiscreetProxy.from_file(path)
     proxy.save(TEST_OUTPUT)
     assert File.exist?(TEST_OUTPUT)
+    assert_equal File.read(TEST_OUTPUT), File.read(ref_output)
   end
   
   def test_save_png
@@ -87,4 +85,13 @@ class TestDiscreetProxy < Test::Unit::TestCase
     assert File.exist?(TEST_PNG)
     assert_equal ChunkyPNG::Image.from_file(TEST_PNG), proxy.to_png
   end
+  
+  def assert_same_png(ref, actual)
+    if ref != actual
+      ref.save("/tmp/REF.png")
+      actual.save("/tmp/ACTUAL.png")
+      `open /tmp/REF.png /tmp/ACTUAL.png`
+      assert_equal ref, actual, "The PNG files were not the same"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discreet_proxy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-12 00:00:00.000000000 Z
+date: 2011-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
-  requirement: &10772190 !ruby/object:Gem::Requirement
+  requirement: &10672110 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10772190
+  version_requirements: *10672110
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10771470 !ruby/object:Gem::Requirement
+  requirement: &10671820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10771470
+  version_requirements: *10671820
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &10770310 !ruby/object:Gem::Requirement
+  requirement: &10671440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *10770310
+  version_requirements: *10671440
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &10770060 !ruby/object:Gem::Requirement
+  requirement: &10671100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *10770060
+  version_requirements: *10671100
 - !ruby/object:Gem::Dependency
   name: cli_test
-  requirement: &10769750 !ruby/object:Gem::Requirement
+  requirement: &10670720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10769750
+  version_requirements: *10670720
 description: 
 email: me@julik.nl
 executables:
@@ -85,7 +85,6 @@ files:
 - lib/discreet_proxy.rb
 - test/converted_png_proxies/Kanaty.stabilizer.p.p.png
 - test/converted_png_proxies/Medianize.stabilizer.p.p.png
-- test/converted_png_proxies/Portretten_Erasmusbrug_Pts.stabilizer.p.p.png
 - test/converted_png_proxies/Ripples.glsl.p.p.png
 - test/converted_png_proxies/Tezt_flame_5_trackers.stabilizer.p.p.png
 - test/converted_png_proxies/doberman.batch.p.p.png
@@ -99,7 +98,6 @@ files:
 - test/test_discreet_proxy.rb
 - test/test_proxies/Kanaty.stabilizer.p
 - test/test_proxies/Medianize.stabilizer.p
-- test/test_proxies/Portretten_Erasmusbrug_Pts.stabilizer.p
 - test/test_proxies/Ripples.glsl.p
 - test/test_proxies/Tezt_flame_5_trackers.stabilizer.p
 - test/test_proxies/doberman.batch.p
@@ -108,6 +106,7 @@ files:
 - test/test_proxies/spontaan.stabilizer.p
 - test/test_proxies/spontaan2.stabilizer.p
 - test/test_proxies/t2.batch.p
+- test/test_proxy_out/Kanaty.stabilizer.p
 homepage: http://github.com/julik/discreet_proxy
 licenses:
 - MIT