nl-fast_png 0.0.0.pre.usegit

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64d8014055d54b9e7940be354f9e63af3185212a13b1b3063d181068531730e0
+  data.tar.gz: 7004e22bbd82073df23f0b66776c410ef0675b62460769ffdd6d364d9a7a8a15
+SHA512:
+  metadata.gz: 610ba7f0b0c7930a2808e6256221a26ea1355623cb32ddeae797c1c820ef5a82ced924f21b2f1d042bef5b1ac6d961dce3047cd4cc068bf12c8e96c89cb32d4e
+  data.tar.gz: bb52db8b67c2c2b32c2fd701f7c331d5055433839d5889665507ab78f6f23844fcd6d10845df65b77e839c129bcee16ff66cad7c19eef96f8e35a2212d08afd9

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/ext/nl-fast_png/Makefile
+/ext/**/*.o
+/ext/**/*.so
+/ext/**/mkmf.log
+/lib/**/*.so
+
+/.ruby-version
+/.ruby-gemset

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nl-fast_png.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    nl-fast_png (0.0.0.pre.usegit)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rake-compiler (1.1.1)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nl-fast_png!
+  pry
+  rake (~> 12.0)
+  rake-compiler
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011-2020, Mike Bourgeous
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,41 @@
+# NL::FastPNG
+
+NL::FastPng is a C-based extension that uses libpng in a simplified
+configuration for faster performance on black and white images, at the expense
+of slightly larger file sizes.
+
+This code was used by the Nitrogen Logic Depth Camera Controller to generate
+PNG images from realtime depth data on limited hardware.
+
+## License
+
+NL::FastPng is licensed under a 2-clause BSD license.  See the LICENSE file for
+details.  NL::FastPng is © 2011-2020, Mike Bourgeous.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nl-fast_png'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nl-fast_png
+
+## Usage
+
+```
+require 'nl/fast_png'
+
+# Store a 2x2 checkerboard pattern to /tmp/x.png
+File.write('/tmp/x.png', NL::FastPng.store_png(2, 2, 8, "\xff\x00\x00\xff"))
+
+# Store a 256x256 horizontal gradient to /tmp/grad.png
+File.write('/tmp/grad.png', NL::FastPng.store_png(256, 256, 8, 256.times.map(&:chr).join * 256))
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/extensiontask'
+
+task :default => :spec
+
+Rake::ExtensionTask.new 'png_ext' do |ext|
+  ext.name = 'png_ext'
+  ext.ext_dir = 'ext/nl-fast_png'
+  ext.lib_dir = 'lib/nl/fast_png'
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nl/fast_png"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/nl-fast_png/extconf.rb

@@ -0,0 +1,7 @@
+require 'mkmf'
+
+raise 'libpng not found; please install libpng-dev' unless have_library("png", "png_create_write_struct")
+
+with_cflags("#{$CFLAGS} -O3 -Wall -Wextra #{ENV['EXTRACFLAGS']} -std=c99") do
+  create_makefile('nl/fast_png/png_ext')
+end

data/ext/nl-fast_png/png_ext.c

@@ -0,0 +1,172 @@
+/*
+ * Kinect data manipulation utilities for Ruby.
+ * (C)2011 Mike Bourgeous
+ *
+ * References:
+ * http://www.rubyinside.com/how-to-create-a-ruby-extension-in-c-in-under-5-minutes-100.html
+ * http://www.ruby-doc.org/docs/ProgrammingRuby/html/ext_ruby.html
+ */
+#include <ruby.h>
+#include <ruby/thread.h>
+#include <libpng/png.h>
+#include <zlib.h>
+
+// Information passed into store_png_blocking()
+struct kinpng_info {
+	unsigned int w, h, d;
+	unsigned char *data;
+	png_structp png_ptr;
+	png_infop info_ptr;
+};
+
+// The PngExt Ruby module
+VALUE PngExt = Qnil;
+
+// Adds a libpng error message to the error string.
+static void error_func(png_structp png, const char *msg)
+{
+	VALUE *errstr = png_get_error_ptr(png);
+
+	rb_warning("%s\n", msg);
+
+	if(RSTRING_LEN(*errstr) > 0) {
+		rb_str_cat2(*errstr, " - ");
+	}
+	rb_str_cat2(*errstr, "Err: ");
+	rb_str_cat2(*errstr, msg);
+}
+
+// Adds a libpng warning message to the error string.
+static void warn_func(png_structp png, const char *msg)
+{
+	VALUE *errstr = png_get_error_ptr(png);
+
+	rb_warning("%s\n", msg);
+
+	if(RSTRING_LEN(*errstr) > 0) {
+		rb_str_cat2(*errstr, " - ");
+	}
+	rb_str_cat2(*errstr, "Warn: ");
+	rb_str_cat2(*errstr, msg);
+}
+
+// Appends PNG data to the output buffer.
+static void write_func(png_structp png, png_bytep data, png_size_t length)
+{
+	VALUE *outbuf = png_get_io_ptr(png);
+
+	// FIXME: Wrap with rb_protect(), re-acquire the GVL
+	rb_str_cat(*outbuf, data, length);
+}
+
+// Does nothing.
+static void flush_func(png_structp png)
+{
+}
+
+void *store_png_blocking(void *data)
+{
+	struct kinpng_info *info = data;
+	png_bytep row_pointers[info->h];
+	unsigned int span = info->w * (info->d / 8);
+	int i;
+
+	if(setjmp(png_jmpbuf(info->png_ptr))) {
+		return NULL;
+	}
+
+	for(i = 0; i < info->h; i++, info->data += span) {
+		row_pointers[i] = info->data;
+	}
+	png_set_swap(info->png_ptr);
+	png_write_image(info->png_ptr, row_pointers);
+
+	png_write_end(info->png_ptr, info->info_ptr);
+
+	return data;
+}
+
+// Stores the given data as a grayscale image with depth 8 or 16, using
+// compression settings optimized for speed (SUB filter, minimal zlib
+// compression).  16-bit data is expected to be in little-endian order.
+VALUE rb_store_png(VALUE self, VALUE width, VALUE height, VALUE depth, VALUE data)
+{
+	VALUE outbuf;
+	VALUE errstr;
+	VALUE ret;
+
+	unsigned int w, h, d;
+	png_structp png_ptr;
+	png_infop info_ptr;
+
+	Check_Type(data, T_STRING);
+	w = NUM2UINT(width);
+	h = NUM2UINT(height);
+	d = NUM2UINT(depth);
+
+	if(d != 8 && d != 16) {
+		rb_raise(rb_eArgError, "Depth must be either 8 or 16 (got %u).", d);
+	}
+
+	if(RSTRING_LEN(data) < w * h * (d / 8)) {
+		rb_raise(rb_eArgError, "Data must contain at least %u bytes (got %zd).", w * h * (d / 8), (ssize_t)RSTRING_LEN(data));
+	}
+
+	outbuf = rb_str_buf_new(0);
+
+	if(!(png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, &errstr, error_func, warn_func))) {
+		rb_raise(rb_eStandardError, "Unable to create PNG writing structure: %s\n", RSTRING_PTR(errstr));
+	}
+
+	if(!(info_ptr = png_create_info_struct(png_ptr))) {
+		png_destroy_write_struct(&png_ptr, NULL);
+		rb_raise(rb_eStandardError, "Unable to create PNG info structure: %s\n", RSTRING_PTR(errstr));
+	}
+
+	if(setjmp(png_jmpbuf(png_ptr))) {
+		png_destroy_write_struct(&png_ptr, &info_ptr);
+		rb_raise(rb_eStandardError, "A libpng error occurred: %s\n", RSTRING_PTR(errstr));
+	}
+
+	png_set_write_fn(png_ptr, &outbuf, write_func, flush_func);
+
+	png_set_IHDR(png_ptr, info_ptr, w, h, d,
+		     PNG_COLOR_TYPE_GRAY, PNG_INTERLACE_NONE,
+		     PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);
+
+	png_set_filter(png_ptr, 0, PNG_FILTER_SUB);
+	png_set_compression_level(png_ptr, Z_BEST_SPEED);
+
+	png_write_info(png_ptr, info_ptr);
+
+	// FIXME: this is accessing a Ruby string's contents without the GVL; is that a problem?
+	ret = rb_thread_call_without_gvl(
+			store_png_blocking,
+			&(struct kinpng_info){
+			.w = w, .h = h, .d = d, .data = RSTRING_PTR(data), .png_ptr = png_ptr, .info_ptr = info_ptr
+			},
+			NULL,
+			NULL
+			);
+	if(ret == NULL) {
+		rb_raise(rb_eStandardError, "A libpng error occurred while writing: %s\n", RSTRING_PTR(errstr));
+	}
+
+	if(setjmp(png_jmpbuf(png_ptr))) {
+		rb_raise(rb_eStandardError, "A libpng error occurred: %s\n", RSTRING_PTR(errstr));
+	}
+
+	png_destroy_write_struct(&png_ptr, &info_ptr);
+
+	return outbuf;
+}
+
+// Initializes the kinpng module.
+void Init_png_ext()
+{
+	VALUE nl = rb_define_module("NL");
+	VALUE fast_png = rb_define_module_under(nl, "FastPng");
+	PngExt = rb_define_module_under(fast_png, "PngExt");
+
+	rb_define_module_function(PngExt, "store_png", rb_store_png, 4);
+}

data/lib/nl/fast_png.rb

@@ -0,0 +1,17 @@
+require "nl/fast_png/version"
+
+module NL
+  module FastPng
+    # Returns a String containing a compressed PNG version of the given
+    # grayscale +data+, which has +width+ columns, +height+ lines, and has a
+    # bit depth of +depth+ (either 8 or 16).
+    #
+    # Example:
+    #     File.write('/tmp/x.png', NL::FastPng.store_png(2, 2, 8, "\xff\x00\x00\xff"))
+    def self.store_png(width, height, depth, data)
+      PngExt.store_png(width, height, depth, data)
+    end
+  end
+end
+
+require_relative 'fast_png/png_ext'

data/lib/nl/fast_png/version.rb

@@ -0,0 +1,5 @@
+module NL
+  module FastPng
+    VERSION = "0.0.0-usegit"
+  end
+end

data/nl-fast_png.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/nl/fast_png/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nl-fast_png"
+  spec.version       = NL::FastPng::VERSION
+  spec.authors       = ["Mike Bourgeous"]
+  spec.email         = ["mike@mikebourgeous.com"]
+
+  spec.summary       = %q{A fast libpng-based compressor for black and white images.}
+  spec.homepage      = 'https://github.com/nitrogenlogic/nl-fast_png'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.extensions = [
+    'ext/nl-fast_png/extconf.rb'
+  ]
+
+  spec.add_development_dependency 'rake-compiler'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: nl-fast_png
+version: !ruby/object:Gem::Version
+  version: 0.0.0.pre.usegit
+platform: ruby
+authors:
+- Mike Bourgeous
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-28 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- mike@mikebourgeous.com
+executables: []
+extensions:
+- ext/nl-fast_png/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/nl-fast_png/extconf.rb
+- ext/nl-fast_png/png_ext.c
+- lib/nl/fast_png.rb
+- lib/nl/fast_png/version.rb
+- nl-fast_png.gemspec
+homepage: https://github.com/nitrogenlogic/nl-fast_png
+licenses: []
+metadata:
+  homepage_uri: https://github.com/nitrogenlogic/nl-fast_png
+  source_code_uri: https://github.com/nitrogenlogic/nl-fast_png
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A fast libpng-based compressor for black and white images.
+test_files: []