psd_native 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3455db8f83d189130541ead18b691098dd5c63b9
+  data.tar.gz: 0a606b3f924bfa86ccfd5dc0a0f81a66868339e8
+SHA512:
+  metadata.gz: e9d211703ff9633bb3d74f4fe9e54dfd802d7a183308e23369363d1de83183ec88d8d4de4565fae75e8c13ab9328c48522145a4bbd4a3926ef11ed963b8f4a60
+  data.tar.gz: f10ac6b1d616c6745a9d99bbb65fd7808747b8a7bc8e80a784344e4dc4a4b698ac2233a49ae32389982053260a840a6ccf01dd5217abc6917dc153c86203a8db

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Makefile
+*.o
+conftest.dSYM
+.DS_Store
+*.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in psd_native.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan LeFevre
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# PSDNative
+
+A gem that includes multiple mixins that speed up [PSD.rb](https://github.com/layervault/psd.rb) by delegating certain parts of the library to native C code. This library allows for PSD.rb to function as a pure Ruby library, while allowing for optional native code speed improvements. It overwrites specific methods within PSD.rb transparently, so you can use PSD.rb as you normally would.
+
+Currently, PSDNative replaces these sections of PSD.rb with native code:
+
+* RGB processing
+* RLE decoding (disabled; needs optimization)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'psd_native'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install psd_native
+
+## Usage
+
+``` ruby
+require 'psd_native'
+
+psd = PSD.new("path/to/file.psd")
+psd.parse!
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new('psd_native') do |ext|
+  ext.lib_dir = File.join('lib', 'psd_native')
+  ext.config_options = '--with-cflags="-std=c99"'
+end

data/ext/psd_native/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+$CFLAGS << ' -Wall'
+create_makefile('psd_native/psd_native')

data/ext/psd_native/image_mode_rgb.c

@@ -0,0 +1,39 @@
+#include "psd_native_ext.h"
+
+VALUE psd_native_combine_rgb_channel(VALUE self) {
+  psd_logger("debug", "Beginning RGB processing");
+  
+  uint32_t num_pixels = FIX2UINT(rb_iv_get(self, "@num_pixels"));
+  uint32_t pixel_step = FIX2UINT(rb_funcall(self, rb_intern("pixel_step"), 0));
+
+  VALUE channels_info = rb_iv_get(self, "@channels_info");
+  VALUE channel_data = rb_iv_get(self, "@channel_data");
+  uint32_t channel_length = FIX2UINT(rb_iv_get(self, "@channel_length"));
+  uint32_t channel_count = FIX2UINT(rb_funcall(channels_info, rb_intern("length"), 0));
+
+  int i, j;
+  uint32_t val, r, g, b, a;
+
+  // Loop through every pixel in the image
+  for (i = 0; i < num_pixels; i += pixel_step) {
+    r = g = b = 0;
+    a = 255;
+
+    // And every channel for every pixel
+    for (j = 0; j < channel_count; j++) {
+      val = FIX2UINT(rb_ary_entry(channel_data, i + (channel_length * j)));
+
+      // Get the hash containing channel info
+      switch (FIX2INT(rb_hash_aref(rb_ary_entry(channels_info, j), ID2SYM(rb_intern("id"))))) {
+        case -1: a = val; break;
+        case 0:  r = val; break;
+        case 1:  g = val; break;
+        case 2:  b = val; break;
+      }
+    }
+
+    rb_ary_push(rb_iv_get(self, "@pixel_data"), INT2FIX(BUILD_PIXEL(r, g, b, a)));
+  }
+
+  return Qnil;
+}

data/ext/psd_native/image_mode_rgb.h

@@ -0,0 +1,8 @@
+#ifndef PSD_NATIVE_RGB
+#define PSD_NATIVE_RGB
+
+#define BUILD_PIXEL(r, g, b, a)  (((PIXEL) (r) << 24) + ((PIXEL) (g) << 16) + ((PIXEL) (b) << 8) + (PIXEL) (a))
+
+VALUE psd_native_combine_rgb_channel(VALUE self);
+
+#endif

data/ext/psd_native/psd_native_ext.c

@@ -0,0 +1,33 @@
+#include "psd_native_ext.h"
+
+void Init_psd_native() {
+  VALUE PSDNative = rb_define_module("PSDNative");
+  VALUE ImageMode = rb_define_module_under(PSDNative, "ImageMode");
+
+  // RGB Processing
+  VALUE ImageMode_RGB = rb_define_module_under(ImageMode, "RGB");
+  rb_define_private_method(ImageMode_RGB, "combine_rgb_channel", psd_native_combine_rgb_channel, 0);
+
+  // RLE decoding
+  VALUE ImageFormat = rb_define_module_under(PSDNative, "ImageFormat");
+  VALUE RLE = rb_define_module_under(ImageFormat, "RLE");
+  rb_define_private_method(RLE, "decode_rle_channel", psd_native_decode_rle_channel, 0);
+
+  psd_logger("info", "PSD native mixins enabled!");
+}
+
+VALUE psd_class() {
+  return rb_const_get(rb_cObject, rb_intern("PSD"));
+}
+
+void psd_logger(char* level, char* message) {
+  rb_funcall(rb_funcall(psd_class(), rb_intern("logger"), 0), rb_intern(level), 1, rb_str_new2(message));
+}
+
+VALUE psd_file(VALUE self) {
+  return rb_iv_get(self, "@file");
+}
+
+int psd_file_tell(VALUE self) {
+  return FIX2INT(rb_funcall(psd_file(self), rb_intern("tell"), 0));
+}

data/ext/psd_native/psd_native_ext.h

@@ -0,0 +1,22 @@
+#ifndef PSD_NATIVE_EXT
+#define PSD_NATIVE_EXT
+
+#include "ruby.h"
+
+#define RSTRING_NOT_MODIFIED
+
+// Pixels use 32 bits unsigned integers
+// We borrow this from OilyPNG
+typedef uint32_t PIXEL;
+
+// Our native mixins
+#include "image_mode_rgb.h"
+#include "rle_decoding.h"
+
+void Init_psd_native();
+VALUE psd_class();
+void psd_logger(char* level, char* message);
+VALUE psd_file(VALUE self);
+int psd_file_tell(VALUE self);
+
+#endif

data/ext/psd_native/rle_decoding.c

@@ -0,0 +1,56 @@
+#include "psd_native_ext.h"
+
+VALUE psd_native_decode_rle_channel(VALUE self) {
+  int height = FIX2INT(rb_funcall(self, rb_intern("height"), 0));
+  VALUE channel_data = rb_iv_get(self, "@channel_data");
+  int bytes, finish, len, val;
+
+  for (int i = 0; i < height; i++) {
+    bytes = psd_byte_count(self, i);
+    finish = psd_file_tell(self) + bytes;
+
+    while (psd_file_tell(self) < finish) {
+      len = FIX2INT(psd_file_read_byte(self));
+
+      if (len < 128) {
+        len++;
+        for (int j = psd_chan_pos(self); j < psd_chan_pos(self) + len; j++) {
+          rb_ary_store(channel_data, j, psd_file_read_byte(self));
+        }
+
+        rb_iv_set(self, "@chan_pos", INT2FIX(psd_chan_pos(self) + len));
+      } else if (len > 128) {
+        len ^= 0xff;
+        len += 2;
+
+        val = psd_file_read_byte(self);
+        for (int j = psd_chan_pos(self); j < psd_chan_pos(self) + len; j++) {
+          rb_ary_store(channel_data, j, val);
+        }
+
+        rb_iv_set(self, "@chan_pos", INT2FIX(psd_chan_pos(self) + len));
+      }
+    }
+  }
+
+  return Qnil;
+}
+
+int psd_byte_count(VALUE self, int line) {
+  return FIX2INT(
+    rb_ary_entry(
+      rb_iv_get(self, "@byte_counts"), 
+      FIX2INT(rb_iv_get(self, "@line_index")) + line
+    )
+  );
+}
+
+VALUE psd_file_read_byte(VALUE self) {
+  VALUE data = rb_funcall(psd_file(self), rb_intern("read"), 1, INT2FIX(1));
+  VALUE bytes = rb_funcall(data, rb_intern("bytes"), 0);
+  return rb_ary_entry(rb_funcall(bytes, rb_intern("to_a"), 0), 0);
+}
+
+int psd_chan_pos(VALUE self) {
+  return FIX2INT(rb_iv_get(self, "@chan_pos"));
+}

data/ext/psd_native/rle_decoding.h

@@ -0,0 +1,9 @@
+#ifndef PSD_NATIVE_RLE_DECODING
+#define PSD_NATIVE_RLE_DECODING
+
+VALUE psd_native_decode_rle_channel(VALUE self);
+int psd_byte_count(VALUE self, int line);
+VALUE psd_file_read_byte(VALUE self);
+int psd_chan_pos(VALUE self);
+
+#endif

data/lib/psd_native/version.rb

@@ -0,0 +1,3 @@
+module PSDNative
+  VERSION = "0.1.0"
+end

data/lib/psd_native.rb

@@ -0,0 +1,14 @@
+require "psd"
+require "psd_native/version"
+require "psd_native/psd_native"
+
+module PSDNative
+  def self.included(base)
+    base::Image.send(:include, PSDNative::ImageMode::RGB)
+
+    # Disabled until optimized
+    # base::Image.send(:include, PSDNative::ImageFormat::RLE)
+  end
+end
+
+PSD.send :include, PSDNative

data/psd_native.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'psd_native/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "psd_native"
+  spec.version       = PSDNative::VERSION
+  spec.authors       = ["Ryan LeFevre"]
+  spec.email         = ["ryan@layervault.com"]
+  spec.description   = %q{Native mixins to speed up PSD.rb}
+  spec.summary       = %q{Native C mixins to speed up the slowest parts of PSD.rb}
+  spec.homepage      = "http://cosmos.layervault.com/psdrb.html"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.extensions    = ["ext/psd_native/extconf.rb"]
+  spec.require_paths = ["lib", "ext"]
+
+  spec.add_runtime_dependency "psd", "~> 1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-compiler"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: psd_native
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan LeFevre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Native mixins to speed up PSD.rb
+email:
+- ryan@layervault.com
+executables: []
+extensions:
+- ext/psd_native/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/psd_native/extconf.rb
+- ext/psd_native/image_mode_rgb.c
+- ext/psd_native/image_mode_rgb.h
+- ext/psd_native/psd_native_ext.c
+- ext/psd_native/psd_native_ext.h
+- ext/psd_native/rle_decoding.c
+- ext/psd_native/rle_decoding.h
+- lib/psd_native.rb
+- lib/psd_native/version.rb
+- psd_native.gemspec
+homepage: http://cosmos.layervault.com/psdrb.html
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.8
+signing_key: 
+specification_version: 4
+summary: Native C mixins to speed up the slowest parts of PSD.rb
+test_files: []