ndav-magick-image 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf489f7ae5981b5e552d896e8ce0f0696784d914572af0678790464f409f9b16
+  data.tar.gz: '09e621d161ed19c832229e535a9f9ff3a6864b1f05756ab91c0c2e5a1e3e800b'
+SHA512:
+  metadata.gz: 955db5a60c525d1be3a242c424428a93a71cdec036724684f14c1876741bb56f3de86d0e3be75ced7980f44038573332a7a508b0918df524017f3b3e17c4e666
+  data.tar.gz: 85d97b041b9153ff193b5348fee2b55257458f76450019307b2a4ff529b726c68d388fb3f1944328aaba12deaf09422d4b6d525c41c5658364b6c7146b30faea

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Kitaiti Makoto
+
+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,112 @@
+NDAV::Magick::Image
+===================
+
+[NDAV][] bridge for [RMagick][]'s `Magick::Image`.
+
+SYNOPSIS
+--------
+
+```ruby
+require "rmagick"
+require "ndav/magick/image"
+
+# to_xxx API
+image_list = Magick::ImageList.new("path/to/image")
+image = image_list[0]        # => Magick::Image
+ndav  = image.to_ndav        # => NDAV
+image = ndav.to_magick_image # => Magick::Image
+
+# Now it's a MemoryView producer
+memory_view = Fiddle::MemoryView.new(image) # => Fiddle::MemoryView
+
+# from_xxx API
+ndav  = NDAV.from_magick_image(image) # => NDAV
+image = Magick::Image.from_ndav(ndav) # => Magick::Image
+
+# cast-like conversion API
+include NDAV::Converter
+ndav = NDAV(image)        # => NDAV
+image = MagickImage(ndav) # => Magick::Image
+```
+
+*Note* that this bridge currently copies data during conversion between `NDAV` and `Magick::Image`.
+
+*Note* that this bridge is the early implementation. Breaking changes are expected in the near future.
+
+INSTALLATION
+------------
+
+    % gem install ndav-magick-image
+
+Or,
+
+    % bundle add ndav-magick-image
+
+CONVERSION RULES
+----------------
+
+These are conversion rules between `Magick::Image` and `NDAV`.
+
+### shape ###
+
+The shape is `[height, width, channels]`. Channels vary based on the image attributes.
+
+| channels | gray?    | alpha? | pixel value          |
+|----------|----------|--------|----------------------|
+| `1`      | `true`   | `false`| `[intensity]`        |
+| `2`      | `true`   | `true` | `[intensity, alpha]` |
+| `3`      | `false`  | `false`| `[R, G, B]`          |
+| `4`      | `false`  | `true` | `[R, G, B, alpha]`   |
+
+### format and item size ###
+
+Currently, this bridge supports only 8-bit depth expression of pixels, which means all channels including grayscale intencity, RGB and alpha are 0-255 values. Therefore, the MemoryView format is always `"C"` and the item size is 1-byte. Currently, HDR images are converted to standard dynamic-range images.
+
+Other formats such as float might be supported in the future.
+
+EXAMPLE
+-------
+
+Using `NDAV`, we can convert between `Magick::Image` and `Numo::NArray`. Let's inject noise to an image. That's quite easy if you use [Numo::NArray][].
+
+```ruby
+require "rmagick"
+require "ndav/magick/image"
+require "numo/narray/alt"
+require "ndav/numo/narray"
+
+include ::NDAV::Converter
+
+image_list = Magick::ImageList.new("path/to/image")
+image = image_list[0]
+numo = NumoNArray(image)
+abort "Use RGB image" unless numo.shape[2] == 3
+
+noise = Numo::Int8.new(numo.shape).rand(Numo::Int8::MIN, Numo::Int8::MAX)
+noised = Numo::Int16.cast(numo)
+noised.inplace + noise
+noised.inplace.clip(Numo::UInt8::MIN, Numo::UInt8::MAX)
+
+noised_image = MagickImage(Numo::UInt8.cast(noised))
+noised_image.write "noised.png"
+```
+
+| Before | After |
+|--------|-------|
+| [![Original image](https://i.gyazo.com/905f541f15c0d57db5fc7ea3f6edaf07.png)](https://gyazo.com/905f541f15c0d57db5fc7ea3f6edaf07) | [![Noized image](https://i.gyazo.com/7ad51507e7a2d2c8c39c15ce71a5175a.png)](https://gyazo.com/7ad51507e7a2d2c8c39c15ce71a5175a) |
+
+TODO
+----
+
+* Support HDRI
+* Support zero-copy
+* Support float value pixels
+
+LICENSE
+-------
+
+MIT License. See LICENSE.txt file.
+
+[NDAV]: https://kitaitimakoto.gitlab.io/ndav/
+[RMagick]: https://rmagick.github.io/
+[Numo::NArray]: https://ruby-numo.github.io/numo-narray/

data/Rakefile

@@ -0,0 +1,7 @@
+require "rake/testtask"
+require "rubygems/tasks"
+
+task default: :test
+
+Gem::Tasks.new
+Rake::TestTask.new

data/lib/ndav/magick/image.rb

@@ -0,0 +1,74 @@
+require "ndav"
+require "rmagick"
+
+class NDAV
+  module Magick
+    module Image
+      CHANNELS_TO_MAP = {
+        nil => "I",
+        1   => "I",
+        2   => "IA",
+        3   => "RGB",
+        4   => "RGBA"
+      }
+
+      module FromNDAV
+        # TODO: Support more formats
+        def from_ndav(ndav)
+          raise %|Currently, supports only format "C", but is "#{ndav.format}"| unless ndav.format == "C"
+          raise "Currently, supports only row-major contiguous NDAV" unless ndav.row_major_contiguous?
+          raise "ndim must be 2 or 3 but is #{ndav.ndim}" unless [2, 3].include? ndav.ndim
+
+          height, width, channels = ndav.shape
+          map = CHANNELS_TO_MAP[channels]          
+          raise "Unsupported channels: #{channels}" unless map
+
+          image = ::Magick::Image.new(width, height)
+          image.import_pixels 0, 0, width, height, map, ndav.to_s
+          image
+        end
+      end
+  
+      module MemoryViewable
+        private
+
+        # TODO: Support HDRI
+        def ndav_descriptor(**)
+          map =
+            case [gray?, alpha?]
+            when [true, true]  then "IA"
+            when [true, false] then "I"
+            when [false, true] then "RGBA"
+            else                    "RGB"
+            end
+          shape = [rows, columns, map.length]
+          format = "C"
+          item_size = ::NDAV::ITEM_SIZES[format]
+
+          {
+            data: export_pixels_to_str(0, 0, columns, rows, map, ::Magick::CharPixel),
+            shape:,
+            strides: ::NDAV.default_strides(shape:, item_size:),
+            format:,
+            byte_size: shape.reduce(item_size, :*),
+            readonly?: true
+          }
+        end
+      end
+  
+      module Converter
+        def MagickImage(array, *, **)
+          if array.kind_of? ::Magick::Image
+            array
+          elsif array.respond_to? :to_ndav
+            array.to_ndav(*, **).to_magick_image
+          else
+            ::NDAV.new(array, *, **).to_magick_image
+          end
+        end
+      end
+    end
+  end
+
+  register ::Magick::Image, Magick::Image, name: :magick_image
+end

data/ndav-magick-image.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name = "ndav-magick-image"
+  s.version = "0.0.1"
+  s.authors = ["Kitaiti Makoto"]
+  s.summary = "N-Dimensional Array View for RMagick"
+  s.licenses = ["MIT"]
+  s.homepage = "https://gitlab.com/KitaitiMakoto/ndav-magick-image"
+
+  s.files = Dir.chdir(__dir__) {`git ls-files -z`.split("\x0")}
+
+  s.add_runtime_dependency "ndav"
+  s.add_runtime_dependency "rmagick"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "test-unit-notify"
+  s.add_development_dependency "terminal-notifier" if RUBY_PLATFORM.match? /darwin/
+  s.add_development_dependency "rubygems-tasks"
+  s.add_development_dependency "fiddle"
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+require "ndav/magick/image"
+require "test/unit"
+require "test/unit/notify"
+require "fiddle"
+require "tmpdir"

data/test/test_converter.rb

@@ -0,0 +1,30 @@
+require_relative "helper"
+
+class TestConverter < Test::Unit::TestCase
+  def setup
+    @width = 3
+    @height = 2
+  end
+
+  def test_ndav_from_magick_image
+    image = ::Magick::Image.new(@width, @height)
+    draw = ::Magick::Draw.new
+    draw.fill "#00FF00"
+    draw.rectangle 0, 1, 3, 2
+    draw.draw image
+    image.alpha ::Magick::OffAlphaChannel
+
+    assert_instance_of ::NDAV, ::NDAV::Converter::NDAV(image)
+  end
+
+  def test_magick_image_from_ndav
+    array = [
+              [[255, 255, 255] * @width] * (@height / 2),
+              [[  0, 255,   0] * @width] * (@height / 2)
+            ]
+    ptr = Fiddle::Pointer[array.flatten.pack("C*")]
+    ndav = ::NDAV.new(ptr, shape: [@height, @width, 3])
+
+    assert_instance_of ::Magick::Image, ::NDAV::Converter::MagickImage(ndav)
+  end
+end

data/test/test_from_ndav.rb

@@ -0,0 +1,72 @@
+require_relative "helper"
+
+class TestFromNDAV < Test::Unit::TestCase
+  def setup
+    @width = 3
+    @height = 2
+  end
+
+  def test_basic
+    array = [
+               [[255, 255, 255] * @width] * (@height / 2),
+               [[  0, 255,   0] * @width] * (@height / 2)
+             ]
+    ptr = Fiddle::Pointer[array.flatten.pack("C*")]
+    ndav = ::NDAV.new(ptr, shape: [@height, @width, 3])
+    image = ::Magick::Image.from_ndav(ndav)
+
+    assert_equal @width, image.columns
+    assert_equal @height, image.rows
+    assert_false image.gray?
+    assert_false image.alpha?
+    assert_equal array.flatten, image.export_pixels_to_str.unpack("C*")
+  end
+
+  def test_alpha
+    array = [
+              [[255, 255, 255, 128] * @width] * (@height / 2),
+              [[  0, 255,   0, 128] * @width] * (@height / 2)
+            ]
+    ptr = Fiddle::Pointer[array.flatten.pack("C*")]
+    ndav = ::NDAV.new(ptr, shape: [@height, @width, 4])
+    image = ::Magick::Image.from_ndav(ndav)
+
+    assert_equal @width, image.columns
+    assert_equal @height, image.rows
+    assert_false image.gray?
+    assert_true image.alpha?
+    assert_equal array.flatten, image.export_pixels_to_str(0, 0, @width, @height, "RGBA").unpack("C*")
+  end
+
+  def test_grayscale
+    array = [
+              [[255] * @width] * (@height / 2),
+              [[128] * @width] * (@height / 2)
+            ]
+    ptr = Fiddle::Pointer[array.flatten.pack("C*")]
+    ndav = ::NDAV.new(ptr, shape: [@height, @width, 1])
+    image = ::Magick::Image.from_ndav(ndav)
+
+    assert_equal @width, image.columns
+    assert_equal @height, image.rows
+    assert_true image.gray?
+    assert_false image.alpha?
+    assert_equal array.flatten, image.export_pixels_to_str(0, 0, @width, @height, "R").unpack("C*")
+  end
+
+  def test_gray_alpha
+    array = [
+              [[255, 128] * @width] * (@height / 2),
+              [[128, 128] * @width] * (@height / 2)
+            ]
+    ptr = Fiddle::Pointer[array.flatten.pack("C*")]
+    ndav = ::NDAV.new(ptr, shape: [@height, @width, 2])
+    image = ::Magick::Image.from_ndav(ndav)
+
+    assert_equal @width, image.columns
+    assert_equal @height, image.rows
+    assert_true image.gray?
+    assert_true image.alpha?
+    assert_equal array.flatten, image.export_pixels_to_str(0, 0, @width, @height, "RA").unpack("C*")
+  end
+end

data/test/test_magick_image.rb

@@ -0,0 +1,31 @@
+require_relative "helper"
+
+class TestMagickImage < Test::Unit::TestCase
+  def setup
+    @width = 3
+    @height = 2
+    @color = "#00FF00"
+  end
+
+  def test_identical
+    image = Magick::Image.new(@width, @height)
+    draw = Magick::Draw.new
+    draw.fill @color
+    draw.rectangle 0, 1, 3, 2
+    draw.draw image
+    image.alpha Magick::OffAlphaChannel
+    converted = image.to_ndav.to_magick_image
+
+    assert_equal image, converted
+
+    Dir.mktmpdir do |dir|
+      dir = File.realpath(dir)
+      orig_path = File.join(dir, "orig.png")
+      converted_path = File.join(dir, "converted.png")
+
+      image.write orig_path
+      converted.write converted_path
+      assert_equal File.read(orig_path), File.read(converted_path)
+    end
+  end
+end

data/test/test_memory_viewable.rb

@@ -0,0 +1,82 @@
+require_relative "helper"
+
+class TestMemoryViewable < Test::Unit::TestCase
+  def setup
+    @width = 3
+    @height = 2
+    @image = ::Magick::Image.new(@width, @height)
+
+    draw = Magick::Draw.new
+    draw.fill "#00FF00"
+    draw.rectangle 0, 1, 3, 2
+    draw.draw @image
+
+    @image.alpha Magick::OffAlphaChannel
+  end
+
+  def test_basic
+    Fiddle::MemoryView.export @image do |view|
+      assert_equal 3, view.ndim
+      assert_equal [@height, @width, 3], view.shape
+      assert_equal 1, view.item_size
+      assert_equal "C", view.format
+      assert_equal @width * @height * 3, view.byte_size
+      assert_equal [
+                     [[255, 255, 255] * @width] * (@height / 2),
+                     [[  0, 255,   0] * @width] * (@height / 2)
+                   ].flatten,
+                   view.to_s.unpack("C*")
+    end
+  end
+
+  def test_alpha
+    @image.alpha Magick::OnAlphaChannel
+
+    Fiddle::MemoryView.export @image do |view|
+      assert_equal 3, view.ndim
+      assert_equal [@height, @width, 4], view.shape
+      assert_equal 1, view.item_size
+      assert_equal "C", view.format
+      assert_equal @width * @height * 4, view.byte_size
+    end
+  end
+
+  def test_grayscale
+    image = @image.quantize(256, Magick::GRAYColorspace)
+
+    Fiddle::MemoryView.export image do |view|
+      assert_equal 3, view.ndim
+      assert_equal [@height, @width, 1], view.shape
+      assert_equal 1, view.item_size
+      assert_equal "C", view.format
+      assert_equal @width * @height * 1, view.byte_size
+      assert_equal [
+                     [[255] * @width] * (@height / 2),
+                     [[182] * @width] * (@height / 2)
+                   ].flatten,
+                   view.to_s.unpack("C*")
+    end
+  end
+
+  def test_gray_alpha
+    image = @image.quantize(256, Magick::GRAYColorspace)
+    image.alpha Magick::OnAlphaChannel
+
+    Fiddle::MemoryView.export image do |view|
+      assert_equal 3, view.ndim
+      assert_equal [@height, @width, 2], view.shape
+      assert_equal 1, view.item_size
+      assert_equal "C", view.format
+      assert_equal @width * @height * 2, view.byte_size
+      assert_equal [
+                      [[255, 255] * @width] * (@height / 2),
+                      [[182, 255] * @width] * (@height / 2)
+                    ].flatten,
+                    view.to_s.unpack("C*")
+    end
+  end
+
+  def test_writable
+    pend
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: ndav-magick-image
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kitaiti Makoto
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ndav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: test-unit
+  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: test-unit-notify
+  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: terminal-notifier
+  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: rubygems-tasks
+  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: fiddle
+  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'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ndav/magick/image.rb
+- ndav-magick-image.gemspec
+- test/helper.rb
+- test/test_converter.rb
+- test/test_from_ndav.rb
+- test/test_magick_image.rb
+- test/test_memory_viewable.rb
+homepage: https://gitlab.com/KitaitiMakoto/ndav-magick-image
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+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: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: N-Dimensional Array View for RMagick
+test_files: []