riiif 1.7.1 → 2.0.0.beta1

data/app/services/riiif/imagemagick_transformer.rb

@@ -0,0 +1,8 @@
+module Riiif
+  # Transforms an image using Imagemagick
+  class ImagemagickTransformer < AbstractTransformer
+    def command_factory
+      ImagemagickCommandFactory
+    end
+  end
+end

data/app/services/riiif/kakadu_command_factory.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Riiif
+  # Builds a command to run a transformation using Kakadu
+  class KakaduCommandFactory
+    class_attribute :external_command
+    self.external_command = 'kdu_expand'
+
+    # A helper method to instantiate and invoke build
+    # @param [String] path the location of the file
+    # @param info [ImageInformation] information about the source
+    # @param [Transformation] transformation
+    def initialize(path, info, transformation)
+      @path = path
+      @info = info
+      @transformation = transformation
+    end
+
+    attr_reader :path, :info, :transformation
+
+    # @param tmp_file [String] the path to the temporary file
+    # @return [String] a command for running kdu_expand to produce the requested output
+    def command(tmp_file)
+      [external_command, quiet, input, threads, region, reduce, output(tmp_file)].join
+    end
+
+    def reduction_factor
+      @reduction_factor ||= transformation.size.reduction_factor
+    end
+
+    private
+
+      def input
+        " -i #{path}"
+      end
+
+      def output(output_filename)
+        " -o #{output_filename}"
+      end
+
+      def threads
+        ' -num_threads 4'
+      end
+
+      def quiet
+        ' -quiet'
+      end
+
+      def region
+        region_arg = transformation.crop.to_kakadu
+        " -region \"#{region_arg}\"" if region_arg
+      end
+
+      # kdu_expand is not capable of arbitrary scaling, but it does
+      # offer a -reduce argument which is capable of downscaling by
+      # factors of 2, significantly speeding decompression. We can
+      # use it if either the percent is <=50, or the height/width
+      # are <=50% of full size.
+      def reduce
+        " -reduce #{reduction_factor}" if reduction_factor && reduction_factor != 0
+      end
+  end
+end

data/app/services/riiif/link_name_service.rb

@@ -0,0 +1,8 @@
+module Riiif
+  # Creates names for a temporary file
+  class LinkNameService
+    def self.create
+      ::File.join(Dir.tmpdir, SecureRandom.uuid) + '.bmp'
+    end
+  end
+end

data/app/services/riiif/option_decoder.rb

@@ -52,14 +52,14 @@ module Riiif
 
     def decode_region(region)
       if region.nil? || region == 'full'
-        Riiif::Region::Imagemagick::FullDecoder.new.decode
+        Riiif::Region::Full.new(image_info)
       elsif md = /^pct:(\d+),(\d+),(\d+),(\d+)$/.match(region)
-        Riiif::Region::Imagemagick::PercentageDecoder
-          .new(image_info, md[1], md[2], md[3], md[4]).decode
+        Riiif::Region::Percentage
+          .new(image_info, md[1], md[2], md[3], md[4])
       elsif md = /^(\d+),(\d+),(\d+),(\d+)$/.match(region)
-        Riiif::Region::Imagemagick::AbsoluteDecoder.new(md[1], md[2], md[3], md[4]).decode
+        Riiif::Region::Absolute.new(image_info, md[1], md[2], md[3], md[4])
       elsif region == 'square'
-        Riiif::Region::Imagemagick::SquareDecoder.new(image_info).decode
+        Riiif::Region::Square.new(image_info)
       else
         raise InvalidAttributeError, "Invalid region: #{region}"
       end
@@ -68,17 +68,17 @@ module Riiif
     # rubocop:disable Metrics/PerceivedComplexity
     def decode_size(size)
       if size.nil? || size == 'full'
-        Riiif::Size::Imagemagick::FullDecoder.new.decode
+        Riiif::Size::Full.new
       elsif md = /^,(\d+)$/.match(size)
-        Riiif::Size::Imagemagick::HeightDecoder.new(md[1]).decode
+        Riiif::Size::Height.new(image_info, md[1])
       elsif md = /^(\d+),$/.match(size)
-        Riiif::Size::Imagemagick::WidthDecoder.new(md[1]).decode
+        Riiif::Size::Width.new(image_info, md[1])
       elsif md = /^pct:(\d+(.\d+)?)$/.match(size)
-        Riiif::Size::Imagemagick::PercentDecoder.new(md[1]).decode
+        Riiif::Size::Percent.new(image_info, md[1])
       elsif md = /^(\d+),(\d+)$/.match(size)
-        Riiif::Size::Imagemagick::AbsoluteDecoder.new(md[1], md[2]).decode
+        Riiif::Size::Absolute.new(image_info, md[1], md[2])
       elsif md = /^!(\d+),(\d+)$/.match(size)
-        Riiif::Size::Imagemagick::BestFitDecoder.new(md[1], md[2]).decode
+        Riiif::Size::BestFit.new(image_info, md[1], md[2])
       else
         raise InvalidAttributeError, "Invalid size: #{size}"
       end

data/app/services/riiif/region/absolute.rb

@@ -0,0 +1,23 @@
+module Riiif
+  module Region
+    # Represents an absolute specified region
+    class Absolute < Crop
+      # TODO: only kakadu needs image_info. So there's potenial to optimize by
+      # making image_info a proxy that fetches the info lazily when needed.
+      # @param [ImageInformation] image_info
+      # @param [String] x
+      # @param [String] y
+      # @param [String] width
+      # @param [String] height
+      def initialize(image_info, x, y, width, height)
+        @image_info = image_info
+        @offset_x = x.to_i
+        @offset_y = y.to_i
+        @width = width.to_i
+        @height = height.to_i
+      end
+
+      attr_reader :width, :height
+    end
+  end
+end

data/app/services/riiif/region/full.rb

@@ -0,0 +1,23 @@
+module Riiif
+  module Region
+    # Represents the image or region requested at its full size.
+    # This is a nil crop operation.
+    class Full < Crop
+      def initialize(image_info)
+        @image_info = image_info
+      end
+
+      # @return [NilClass] a region for imagemagick to decode
+      #                    the nil implies no cropping needed
+      def to_imagemagick
+        nil
+      end
+
+      # @return [NilClass] a region for kakadu to decode
+      #                    the nil implies no cropping needed
+      def to_kakadu
+        nil
+      end
+    end
+  end
+end

data/app/services/riiif/region/percentage.rb

@@ -0,0 +1,68 @@
+module Riiif
+  module Region
+    # represents request cooridnates specified as percentage
+    class Percentage < Crop
+      def initialize(image_info, x, y, width, height)
+        @image_info = image_info
+        @x_pct = x
+        @y_pct = y
+        @width_pct = width
+        @height_pct = height
+      end
+
+      # From the Imagemagick docs:
+      #   The percentage symbol '%' can appear anywhere in a argument, and if
+      #   given will refer to both width and height numbers. It is a flag that
+      #   just declares that the 'image size' parts are a percentage fraction
+      #   of the images virtual canvas or page size. Offsets are always given
+      #   in pixels.
+      # @return [String] a region for imagemagick to decode
+      #                  (appropriate for passing to the -crop parameter)
+      def to_imagemagick
+        "#{@width_pct}%x#{@height_pct}+#{offset_x}+#{offset_y}"
+      end
+
+      def maintain_aspect_ratio?
+        @width_pct == @height_pct
+      end
+
+      private
+
+        # @param [String] n a percentage to convert
+        # @return [Float]
+        def percentage_to_fraction(n)
+          Integer(n).to_f / 100
+        end
+
+        # @return [Integer]
+        def offset_x
+          (@image_info.width * percentage_to_fraction(@x_pct)).round
+        end
+
+        # @return [Integer]
+        def offset_y
+          (@image_info.height * percentage_to_fraction(@y_pct)).round
+        end
+
+        # @return [Float]
+        def decimal_height
+          percentage_to_fraction(@height_pct)
+        end
+
+        # @return [Float]
+        def decimal_width
+          percentage_to_fraction(@width_pct)
+        end
+
+        # @return [Float]
+        def decimal_offset_y
+          percentage_to_fraction(@y_pct)
+        end
+
+        # @return [Float]
+        def decimal_offset_x
+          percentage_to_fraction(@x_pct)
+        end
+    end
+  end
+end

data/app/services/riiif/region/square.rb

@@ -0,0 +1,45 @@
+module Riiif
+  module Region
+    # Represents requested square cooridnates
+    class Square < Crop
+      def initialize(image_info)
+        @image_info = image_info
+        @min, @max = [@image_info.width, @image_info.height].minmax
+        @offset = (@max - @min) / 2
+      end
+
+      # @return [String] a square region for imagemagick to decode
+      #                  (appropriate for passing to the -crop parameter)
+      def to_imagemagick
+        if @image_info.height >= @image_info.width
+          "#{height}x#{width}+0+#{@offset}"
+        else
+          "#{height}x#{width}+#{@offset}+0"
+        end
+      end
+
+      # @return [String] a region for kakadu to decode
+      #                  (appropriate for passing to the -region parameter)
+      def to_kakadu
+        # (top, left, height, width)
+        if @image_info.height >= @image_info.width
+          # Portrait
+          "\{#{decimal_height(@offset)},0\}," \
+          "\{#{decimal_height(height)},#{decimal_width(height)}\}"
+        else
+          # Landscape
+          "\{0,#{decimal_width(@offset)}\}," \
+          "\{#{decimal_height(width)},#{decimal_width(width)}\}"
+        end
+      end
+
+      def height
+        @min
+      end
+
+      def width
+        @min
+      end
+    end
+  end
+end

data/app/services/riiif/resize.rb

@@ -0,0 +1,45 @@
+module Riiif
+  # Represents a resize operation
+  class Resize
+    attr_reader :image_info
+
+    # @return [Integer] the height in pixels
+    def height
+      image_info.height
+    end
+
+    # @return [Integer] the width in pixels
+    def width
+      image_info.width
+    end
+
+    # Should we reduce this image with KDU?
+    def reduce?
+      true
+    end
+
+    # This is used for a second resize by imagemagick after resizing
+    # by kdu.
+    # No need to scale most resize operations (only percent)
+    # @param [Integer] factor to scale by
+    # @return [Absolute] a copy of self if factor is zero.
+    def reduce(_factor)
+      dup
+    end
+
+    # @return [Integer] the reduction factor for this operation
+    def reduction_factor(max_factor = 5)
+      return nil unless reduce?
+      scale = [width.to_f / image_info.width,
+               height.to_f / image_info.height].min
+      factor = 0
+      raise "I don't know how to scale to #{scale}" if scale > 1
+      next_pct = 0.5
+      while scale <= next_pct && factor < max_factor
+        next_pct /= 2.0
+        factor += 1
+      end
+      factor
+    end
+  end
+end

data/app/services/riiif/size/absolute.rb

@@ -0,0 +1,39 @@
+module Riiif
+  module Size
+    # The width and height of the returned image are exactly w and h.
+    # The aspect ratio of the returned image may be different than the extracted
+    # region, resulting in a distorted image.
+    class Absolute < Resize
+      # @param [ImageInformation] info
+      # @param [String] width
+      # @param [String] height
+      def initialize(info, width, height)
+        @image_info = info
+        @width = width.to_i
+        @height = height.to_i
+      end
+
+      # @return [String] a resize directive for imagemagick to use
+      def to_imagemagick
+        "#{@width}x#{@height}!"
+      end
+
+      attr_reader :height, :width
+
+      # Reduce this if the aspect ratio of the image is maintained.
+      def reduce?
+        in_delta?(image_info.aspect_ratio, aspect_ratio, 0.001)
+      end
+
+      private
+
+        def aspect_ratio
+          width.to_f / height
+        end
+
+        def in_delta?(x1, x2, delta)
+          (x1 - x2).abs <= delta
+        end
+    end
+  end
+end

data/app/services/riiif/size/best_fit.rb

@@ -0,0 +1,18 @@
+module Riiif
+  module Size
+    # The image content is scaled for the best fit such that the resulting width and
+    # height are less than or equal to the requested width and height.
+    class BestFit < Resize
+      def initialize(info, width, height)
+        @image_info = info
+        @width = width
+        @height = height
+      end
+
+      # @return [String] a resize directive for imagemagick to use
+      def to_imagemagick
+        "#{@width}x#{@height}"
+      end
+    end
+  end
+end

data/app/services/riiif/size/full.rb

@@ -0,0 +1,17 @@
+module Riiif
+  module Size
+    # represents requested full size
+    class Full < Resize
+      # @return [NilClass] a size for imagemagick to decode
+      #                    the nil implies no resizing needed
+      def to_imagemagick
+        nil
+      end
+
+      # Should we reduce this image?
+      def reduce?
+        false
+      end
+    end
+  end
+end

data/app/services/riiif/size/height.rb

@@ -0,0 +1,24 @@
+module Riiif
+  module Size
+    # The image or region should be scaled so that its height is exactly equal
+    # to the provided parameter, and the width will be a calculated value that
+    # maintains the aspect ratio of the extracted region
+    class Height < Resize
+      def initialize(info, height)
+        @image_info = info
+        @height = height.to_i
+      end
+
+      # @return [String] a resize directive for imagemagick to use
+      def to_imagemagick
+        "x#{@height}"
+      end
+
+      def width
+        height * image_info.width / image_info.height
+      end
+
+      attr_reader :height
+    end
+  end
+end