magro 0.2.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e24a0d3e82248b27f8a652e84ebe382363234a082732af2b1c18a55ea0dc6c3
-  data.tar.gz: dc3bc91550338e59455d2ea51effcaf6934b0970c7169434a2cce7422c852252
+  metadata.gz: f911e57e71f9fda41695c940712fd4e471d543dab28e924c9d15459cac02d62e
+  data.tar.gz: 37a3d0c6702219ec3cfee20fe9f319e2aff5945d1ed6d3ba28f842a9eee4a4c0
 SHA512:
-  metadata.gz: 000e7447d4f24a0dd6c97610c5c057ee96feb6eb0698a4e3564e7cec29ce6103a1ac3479f12a90fd1d1436ea89329418097197ad346879cc00018cca25e25aa0
-  data.tar.gz: f8a09aad3d5fcadc92e753a453213f8c33e66fbde0522a263afeb02b7a3ceaaf3245c6801f9d61bde41fe7015070391bd3cba8298dc2a1ca275e4ed4e110c60b
+  metadata.gz: ff9033acf66ce81535d2c9aaa0e8843a35004cf9082b84b9aad1169c859074658e1b0bdb30b144d20f594264a7ad94c2be039f22462b1f8976edff9ffb08a01b
+  data.tar.gz: 938646fe6a9d838ec85f429a117f94ca44feb035d7e6b40ac8480549f81007b967a5ba6f79a204949848f5a4e9d17b25c360221744eb39b3d2f7beb6ec791d06

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: github-ci

data/.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install libpng and libjpeg
+        run: sudo apt-get install -y libpng-dev libjpeg-dev
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install --no-document bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.github/workflows/coverage.yml

@@ -0,0 +1,29 @@
+name: coverage
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install libpng and libjpeg
+        run: sudo apt-get install -y libpng-dev libjpeg-dev
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.7
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install
+          bundle exec rake
+      - name: Coveralls GitHub Action
+        uses: coverallsapp/github-action@v1.1.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# 0.4.3
+- Fix imread method to read image from URL.
+- Fix some configulation files.
+
+# 0.4.2
+- Add GC guard to reading and writing image methods.
+
+# 0.4.1
+- Add GC guard to narray given to native extension method.
+- Fix some configulation files.
+
+# 0.4.0
+- Rename extension file for reading and writing image file.
+- Update documentations.
+
+# 0.3.0
+- Add [filter module](https://yoshoku.github.io/magro/doc/Magro/Filter.html) consists of image filtering methods.
+- Change to use round instead of ceil in [quantization of resize method](https://github.com/yoshoku/magro/commit/1b3308ddfb98a650889483af3cd2045aaf6b8837) when given integer image.
+
 # 0.2.0
 - Add [transform module](https://yoshoku.github.io/magro/doc/Magro/Transform.html) and resize method.
 - Fix some configulation files.

data/Gemfile

@@ -4,6 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'bundler', '~> 2.0'
-gem 'rake', '~> 12.0'
+gem 'rake', '~> 13.0'
 gem 'rake-compiler', '~> 1.0'
 gem 'rspec', '~> 3.0'
+gem 'simplecov', '~> 0.19'
+gem 'simplecov-lcov', '~> 0.8'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2019-2020 Atsushi Tatsuma
+Copyright (c) 2019-2021 Atsushi Tatsuma
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -1,17 +1,21 @@
 # Magro
 
-[![Build Status](https://travis-ci.org/yoshoku/magro.svg?branch=master)](https://travis-ci.org/yoshoku/magro)
+[![Build Status](https://github.com/yoshoku/magro/workflows/build/badge.svg)](https://github.com/yoshoku/magro/actions?query=workflow%3Abuild)
+[![Coverage Status](https://coveralls.io/repos/github/yoshoku/magro/badge.svg?branch=main)](https://coveralls.io/github/yoshoku/magro?branch=main)
 [![Gem Version](https://badge.fury.io/rb/magro.svg)](https://badge.fury.io/rb/magro)
-[![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/numo-liblinear/blob/master/LICENSE.txt)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://yoshoku.github.io/magro/doc/)
+[![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/numo-liblinear/blob/main/LICENSE.txt)
+[![Documentation](http://img.shields.io/badge/api-reference-blue.svg)](https://yoshoku.github.io/magro/doc/)
 
-Magro is an image processing library in Ruby.
-Magro uses [Numo::NArray](https://github.com/ruby-numo/numo-narray) arrays as image objects.
+Magro is a minimal image processing library in Ruby.
+Magro uses [Numo::NArray](https://github.com/ruby-numo/numo-narray) arrays as image objects and
+provides basic image processing functions.
+Current supporting features are reading and writing JPEG and PNG images,
+image resizing with bilinear interpolation method, and image filtering.
 
 ## Installation
 
-Magro dependents libpng and libjpeg to provides functions loading image file.
-It is recommended that using libpng version 1.6 or later.
+Magro dependents libpng and libjpeg to provides functions reading and writing image file.
+Moreover, it is recommended that using libpng version 1.6 or later.
 
 macOS:
 
@@ -35,25 +39,23 @@ Or install it yourself as:
 
     $ gem install magro
 
+## Documentation
+
+- [Magro API Documentation](https://yoshoku.github.io/magro/doc/)
+
 ## Usage
 
 ```ruby
 > require 'magro'
 => true
-> image = Magro::IO.imread('lena.png')
+> image = Magro::IO.imread('foo.png')
 => Numo::UInt8#shape=[512,512,3]
 > grayscale = image.median(axis: 2)
 => Numo::UInt8#shape=[512,512]
-> Magro::IO.imsave('lena_gray.png', grayscale)
+> Magro::IO.imsave('foo_gray.png', grayscale)
 => true
 ```
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/magro.
@@ -61,4 +63,4 @@ This project is intended to be a safe, welcoming space for collaboration, and co
 
 ## Code of Conduct
 
-Everyone interacting in the Magro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/magro/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Magro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/magro/blob/main/CODE_OF_CONDUCT.md).

data/ext/magro/{io.c → imgrw.c}

@@ -1,4 +1,4 @@
-#include "io.h"
+#include "imgrw.h"
 
 RUBY_EXTERN VALUE mMagro;
 
@@ -126,6 +126,8 @@ VALUE magro_io_read_png(VALUE self, VALUE filename_)
   fclose(file_ptr);
   png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
 
+  RB_GC_GUARD(filename_);
+
   return nary;
 }
 
@@ -226,6 +228,9 @@ VALUE magro_io_save_png(VALUE self, VALUE filename_, VALUE image)
   png_free(png_ptr, row_ptr_ptr);
   png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
 
+  RB_GC_GUARD(image);
+  RB_GC_GUARD(filename_);
+
   return Qtrue;
 }
 
@@ -298,6 +303,8 @@ VALUE magro_io_read_jpg(VALUE self, VALUE filename_)
   jpeg_finish_decompress(&jpeg);
   jpeg_destroy_decompress(&jpeg);
 
+  RB_GC_GUARD(filename_);
+
   return nary;
 }
 
@@ -398,6 +405,9 @@ VALUE magro_io_save_jpg(int argc, VALUE* argv, VALUE self)
 
   fclose(file_ptr);
 
+  RB_GC_GUARD(image);
+  RB_GC_GUARD(filename_);
+
   return Qtrue;
 }
 

data/ext/magro/magro.h

@@ -3,6 +3,6 @@
 
 #include <ruby.h>
 
-#include "io.h"
+#include "imgrw.h"
 
 #endif /* MAGRO_H */

data/lib/magro.rb

@@ -5,5 +5,6 @@ require 'numo/narray'
 require 'magro/version'
 require 'magro/magro'
 
+require 'magro/filter'
 require 'magro/io'
 require 'magro/transform'

data/lib/magro/filter.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Magro
+  # Filter module provides functions for image filtering.
+  module Filter
+    module_function
+
+    # Applies box filter to image.
+    # This method performs zero padding as a preprocessing.
+    #
+    # @example
+    #   image = Magro::IO.imread('foo.png')
+    #   kernel = Numo::DFloat[
+    #     [1, 1, 1],
+    #     [1, 1, 1],
+    #     [1, 1, 1]
+    #   ]
+    #   blured_image = Magro::Filter.filter2d(image, kernel)
+    #   Magro::IO.imsave('bar.png', blured_image)
+    #
+    # @param image [Numo::UInt8] (shape: [height, width, n_channels]) Input image to be filtered.
+    # @param kernel [Numo::DFloat] (shape: [kernel_height, kernel_width]) Box filter.
+    # @param scale [Float/Nil] Scale parameter for box filter. If nil is given, the box filter is normalized with sum of filter values.
+    # @param offset [Integer] Offset value of filtered image.
+    # @raise [ArgumentError] This error is raised when class of input image is not Numo::NArray.
+    # @return [Numo::UInt8] (shape: [height, width, n_channels]) Filtered image.
+    def filter2d(image, kernel, scale: nil, offset: 0)
+      raise ArgumentError, 'Expect class of image to be Numo::NArray.' unless image.is_a?(Numo::NArray)
+      filter_h, filter_w = kernel.shape
+      padded = zero_padding(image, filter_h, filter_w)
+      n_channels = image.shape[2]
+      if n_channels.nil?
+        filter1ch(padded, kernel, scale, offset)
+      else
+        image.class.zeros(*image.shape).tap do |filtered|
+          n_channels.times do |c|
+            filtered[true, true, c] = filter1ch(padded[true, true, c], kernel, scale, offset)
+          end
+        end
+      end
+    end
+
+    # Convolve two 2-dimensional arrays.
+    #
+    # @param arr1 [Numo::NArray] (shape: [row1, col1]) First input array.
+    # @param arr2 [Numo::NArray] (shape: [row2, col2]) Second input array.
+    # @raise [ArgumentError] This error is raised when class of input array is not Numo::NArray.
+    # @return [Numo::NArray] (shape: [row1 - row2 + 1, col1 - col2 + 1]) Convolution of arr1 with arr2.
+    def convolve2d(arr1, arr2)
+      raise ArgumentError, 'Expect class of first input array to be Numo::NArray.' unless arr1.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect class of second input array to be Numo::NArray.' unless arr2.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect first input array to be 2-dimensional array.' unless arr1.ndim == 2
+      raise ArgumentError, 'Expect second input array to be 2-dimensional array.' unless arr2.ndim == 2
+      row1, col1 = arr1.shape
+      row2, col2 = arr2.shape
+      # FIXME: lib/numo/narray/extra.rb:1098: warning: Using the last argument as keyword parameters is deprecated
+      # convolved = im2col(arr1, row2, col2).dot(arr2.flatten)
+      convolved = arr2.flatten.dot(im2col(arr1, row2, col2).transpose)
+      convolved.reshape(row1 - row2 + 1, col1 - col2 + 1)
+    end
+
+    # private
+
+    def zero_padding(image, filter_h, filter_w)
+      image_h, image_w, n_channels = image.shape
+      pad_h = filter_h / 2
+      pad_w = filter_w / 2
+      out_h = image_h + pad_h * 2
+      out_w = image_w + pad_w * 2
+      if n_channels.nil?
+        image.class.zeros(out_h, out_w).tap do |padded|
+          padded[pad_h...(pad_h + image_h), pad_w...(pad_w + image_w)] = image
+        end
+      else
+        image.class.zeros(out_h, out_w, n_channels).tap do |padded|
+          n_channels.times do |c|
+            padded[pad_h...(pad_h + image_h), pad_w...(pad_w + image_w), c] = image[true, true, c]
+          end
+        end
+      end
+    end
+
+    def filter1ch(image, kernel, scale, offset)
+      scale ||= kernel.sum
+      kernel *= scale.zero? ? 1.0 : 1.fdiv(scale)
+      filtered = convolve2d(image, kernel)
+      filtered = (filtered + offset).round.clip(image.class::MIN, image.class::MAX) if integer_narray?(image)
+      filtered = image.class.cast(filtered) unless filtered.is_a?(image.class)
+      filtered
+    end
+
+    def im2col(image, filter_h, filter_w)
+      height, width = image.shape
+      rows = height - filter_h + 1
+      cols = width - filter_w + 1
+      mat = image.class.zeros(filter_h, filter_w, rows, cols)
+      filter_h.times do |y|
+        y_end = y + rows
+        filter_w.times do |x|
+          x_end = x + cols
+          mat[y, x, true, true] = image[y...y_end, x...x_end]
+        end
+      end
+      mat.transpose(2, 3, 0, 1).reshape(rows * cols, filter_h * filter_w)
+    end
+
+    INTEGER_NARRAY = %w[Numo::Int8 Numo::Int16 Numo::Int32 Numo::Int64
+                        Numo::UInt8 Numo::UInt16 Numo::UInt32 Numo::UInt64].freeze
+
+    private_constant :INTEGER_NARRAY
+
+    def integer_narray?(image)
+      INTEGER_NARRAY.include?(image.class.to_s)
+    end
+
+    private_class_method :zero_padding, :filter1ch, :im2col, :integer_narray?
+  end
+end

data/lib/magro/io.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+require 'open-uri'
+require 'tempfile'
+
 module Magro
   # IO module provides functions for input and output of image file.
   module IO
     module_function
 
     # Loads an image from file.
-    # @param filename [String] Path to image file to be loaded.
+    # @param filename [String] File path or URL of image file to be loaded.
     #   Currently, the following file formats are support:
     #   Portbale Network Graphics (*.png) and JPEG files (*.jpeg, *.jpg, *jpe).
     # @raise [ArgumentError] This error is raised when filename is not String.
@@ -15,8 +18,27 @@ module Magro
     # @return [Numo::UInt8] (shape: [height, width, n_channels]) Loaded image.
     def imread(filename)
       raise ArgumentError, 'Expect class of filename to be String.' unless filename.is_a?(String)
-      return read_jpg(filename) if filename.downcase =~ /\.(jpeg|jpg|jpe)$/
-      return read_png(filename) if filename.downcase =~ /\.png$/
+
+      unless url?(filename)
+        return case filename.downcase
+               when /\.(jpeg|jpg|jpe)$/
+                 read_jpg(filename)
+               when /\.png$/
+                 read_png(filename)
+               end
+      end
+
+      uri = URI.parse(filename)
+      ext = File.extname(uri.path).downcase
+      raise IOError, 'Failed to detect file extension from given URL.' unless ext =~ /\.(jpeg|jpg|jpe|png)$/
+
+      uri.open do |file|
+        temp = Tempfile.new(['magro_', ext])
+        temp.binmode
+        temp.write(file.read)
+        temp.rewind
+        imread(temp.path)
+      end
     end
 
     # Saves an image to file.
@@ -46,6 +68,11 @@ module Magro
       false
     end
 
-    private_class_method :read_jpg, :read_png, :save_jpg, :save_png
+    def url?(str)
+      uri = URI.parse(str)
+      uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+    end
+
+    private_class_method :read_jpg, :read_png, :save_jpg, :save_png, :url?
   end
 end

data/lib/magro/transform.rb

@@ -58,7 +58,7 @@ module Magro
 
       resized = a * (1 - x_d) * (1 - y_d) + b * x_d * (1 - y_d) + c * (1 - x_d) * y_d + d * x_d * y_d
 
-      resized = resized.ceil.clip(image.class::MIN, image.class::MAX) if integer_narray?(image)
+      resized = resized.round.clip(image.class::MIN, image.class::MAX) if integer_narray?(image)
       resized = image.class.cast(resized) unless resized.is_a?(image.class)
       resized.reshape(new_height, new_width)
     end

data/lib/magro/version.rb

@@ -3,5 +3,5 @@
 # Magro is an image processing library in Ruby.
 module Magro
   # The version of Magro you are using.
-  VERSION = '0.2.0'
+  VERSION = '0.4.3'
 end

data/magro.gemspec

@@ -8,12 +8,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['yoshoku']
   spec.email         = ['yoshoku@outlook.com']
 
-  spec.summary       = 'Magro is an image processing library for Ruby.'
-  spec.description   = 'Magro is an image processing library for Ruby.'
+  spec.summary       = 'Magro is a minimal image processing library for Ruby.'
+  spec.description   = <<~MSG
+    Magro is a minimal image processing library for Ruby.
+    Magro uses Numo::NArray arrays as image objects and provides basic image processing functions.
+    Current supporting features are reading and writing JPEG and PNG images,
+    image resizing with bilinear interpolation method, and image filtering.
+  MSG
 
   spec.homepage      = 'https://github.com/yoshoku/magro'
   spec.license       = 'BSD-3-Clause'
 
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/yoshoku/magro'
+  spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/magro/blob/main/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://yoshoku.github.io/magro/doc/'
+
   # 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(__dir__)) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magro
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.3
 platform: ruby
 authors:
 - yoshoku
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray
@@ -24,7 +24,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
-description: Magro is an image processing library for Ruby.
+description: |
+  Magro is a minimal image processing library for Ruby.
+  Magro uses Numo::NArray arrays as image objects and provides basic image processing functions.
+  Current supporting features are reading and writing JPEG and PNG images,
+  image resizing with bilinear interpolation method, and image filtering.
 email:
 - yoshoku@outlook.com
 executables: []
@@ -32,9 +36,11 @@ extensions:
 - ext/magro/extconf.rb
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
+- ".github/workflows/build.yml"
+- ".github/workflows/coverage.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -44,11 +50,12 @@ files:
 - bin/console
 - bin/setup
 - ext/magro/extconf.rb
-- ext/magro/io.c
-- ext/magro/io.h
+- ext/magro/imgrw.c
+- ext/magro/imgrw.h
 - ext/magro/magro.c
 - ext/magro/magro.h
 - lib/magro.rb
+- lib/magro/filter.rb
 - lib/magro/io.rb
 - lib/magro/transform.rb
 - lib/magro/version.rb
@@ -56,8 +63,12 @@ files:
 homepage: https://github.com/yoshoku/magro
 licenses:
 - BSD-3-Clause
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/yoshoku/magro
+  source_code_uri: https://github.com/yoshoku/magro
+  changelog_uri: https://github.com/yoshoku/magro/blob/main/CHANGELOG.md
+  documentation_uri: https://yoshoku.github.io/magro/doc/
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +83,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
-summary: Magro is an image processing library for Ruby.
+summary: Magro is a minimal image processing library for Ruby.
 test_files: []

data/.travis.yml

@@ -1,19 +0,0 @@
----
-os: linux
-dist: bionic
-language: ruby
-cache: bundler
-rvm:
-  - '2.4'
-  - '2.5'
-  - '2.6'
-  - '2.7'
-
-addons:
-  apt:
-    packages:
-      - libpng-dev
-      - libjpeg-dev
-
-before_install:
-  - gem install bundler -v 2.1.4