image_pack 0.2.0 → 0.2.2

data/lib/image_pack/configuration.rb

@@ -8,7 +8,8 @@ module ImagePack
                   :max_pixels,
                   :max_width,
                   :max_height,
-                  :max_output_size
+                  :max_output_size,
+                  :max_input_size
 
     def initialize
       @execution              = :auto
@@ -18,6 +19,7 @@ module ImagePack
       @max_width              = 30_000
       @max_height             = 30_000
       @max_output_size        = 256 * 1024 * 1024
+      @max_input_size         = 256 * 1024 * 1024
     end
   end
 end

data/lib/image_pack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImagePack
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/image_pack.rb

@@ -13,7 +13,6 @@ require "pathname"
 require_relative "image_pack/version"
 require_relative "image_pack/errors"
 require_relative "image_pack/configuration"
-require_relative "image_pack/backend"
 
 begin
   require "image_pack/image_pack"
@@ -29,9 +28,11 @@ rescue LoadError
 end
 
 module ImagePack
-  ALGOS = %i[jpeg_turbo mozjpeg].freeze
+  ALGOS = %i[jpeg_turbo mozjpeg fast size].freeze
+  ALGO_TO_NATIVE = { jpeg_turbo: :jpeg_turbo, mozjpeg: :mozjpeg, fast: :jpeg_turbo, size: :mozjpeg }.freeze
   EXECUTION_MODES = %i[direct nogvl offload auto].freeze
   DEFAULT_QUALITY = 82
+  DEFAULT_ALGO = :mozjpeg
 
   class << self
     def configuration
@@ -45,9 +46,66 @@ module ImagePack
       configuration
     end
 
+    def build_info
+      {
+        version: VERSION,
+        mozjpeg: defined?(NATIVE_MOZJPEG_VERSION) ? NATIVE_MOZJPEG_VERSION : nil,
+        simd: defined?(NATIVE_SIMD) ? NATIVE_SIMD : nil
+      }
+    end
+
+    def compress_bytes(bytes, **options)
+      raise InvalidArgumentError, "bytes must be a String" unless bytes.is_a?(String)
+
+      compress(bytes.b, **options)
+    end
+
+    def compress_file(path, **options)
+      pathname = Pathname(path)
+      raise InvalidArgumentError, "input path does not exist: #{pathname}" unless pathname.file?
+
+      compress(pathname, **options)
+    end
+
+    def optimize_bytes(bytes, **options)
+      raise InvalidArgumentError, "bytes must be a String" unless bytes.is_a?(String)
+
+      optimize_jpeg(bytes.b, **options)
+    end
+
+    def optimize_file(path, **options)
+      pathname = Pathname(path)
+      raise InvalidArgumentError, "input path does not exist: #{pathname}" unless pathname.file?
+
+      optimize_jpeg(pathname, **options)
+    end
+
+    def optimize_jpeg(input,
+                      output: nil,
+                      progressive: true,
+                      strip_metadata: false,
+                      execution: nil,
+                      cancellable: false)
+      execution ||= configuration.execution
+      validate_execution!(execution)
+      validate_cancellable!(:lossless_optimize, execution, cancellable)
+
+      normalized_input_kind = input_kind!(input)
+      normalized_output_kind = output_kind!(output)
+      has_scheduler = fiber_scheduler_active?
+
+      __optimize_jpeg(input, normalized_input_kind,
+                      output, normalized_output_kind,
+                      progressive ? 1 : 0,
+                      strip_metadata ? 1 : 0,
+                      execution,
+                      cancellable ? 1 : 0,
+                      has_scheduler ? 1 : 0)
+    end
+
     def compress(input,
                  output: nil,
-                 algo: :jpeg_turbo,
+                 algo: DEFAULT_ALGO,
                  quality: nil,
                  min_ssim: nil,
                  mozjpeg_trellis: true,
@@ -72,7 +130,7 @@ module ImagePack
 
       __compress_jpeg(input, normalized_input_kind,
                       output, normalized_output_kind,
-                      algo, effective_quality.to_i,
+                      ALGO_TO_NATIVE.fetch(algo), effective_quality.to_i,
                       min_ssim ? min_ssim.to_f : 0.0,
                       mozjpeg_trellis ? 1 : 0,
                       progressive ? 1 : 0,
@@ -87,25 +145,45 @@ module ImagePack
                         height:,
                         channels:,
                         output: nil,
-                        algo: :jpeg_turbo,
+                        algo: DEFAULT_ALGO,
                         quality: DEFAULT_QUALITY,
+                        min_ssim: nil,
                         progressive: false,
+                        drop_alpha: nil,
                         execution: nil,
                         cancellable: false)
       validate_algo!(algo)
+      validate_min_ssim!(min_ssim)
       validate_quality!(quality)
       validate_dimensions!(width, height, channels)
       execution ||= configuration.execution
       validate_execution!(execution)
       validate_cancellable!(algo, execution, cancellable)
 
+      if channels.to_i == 4
+        case drop_alpha
+        when nil
+          warn "ImagePack.compress_pixels: RGBA input has its alpha channel " \
+               "discarded (JPEG cannot store alpha). Pass drop_alpha: true to " \
+               "silence this warning, or drop_alpha: false to raise instead."
+        when false
+          raise UnsupportedError,
+                "JPEG cannot store an alpha channel. Pass drop_alpha: true to drop it explicitly."
+        end
+      end
+
       normalized_output_kind = output_kind!(output)
       has_scheduler = fiber_scheduler_active?
 
+      if min_ssim && channels.to_i == 4
+        raise UnsupportedError, "min_ssim is not supported for RGBA input"
+      end
+
       __compress_pixels(buffer,
                         width.to_i, height.to_i, channels.to_i,
                         output, normalized_output_kind,
-                        algo, quality.to_i,
+                        ALGO_TO_NATIVE.fetch(algo), quality.to_i,
+                        min_ssim ? min_ssim.to_f : 0.0,
                         progressive ? 1 : 0,
                         execution,
                         cancellable ? 1 : 0,
@@ -123,10 +201,10 @@ module ImagePack
       when String
         if input.encoding == Encoding::BINARY || input.encoding == Encoding::ASCII_8BIT
           :bytes
-        else
-          raise InvalidArgumentError, "input path does not exist: #{input.inspect}" unless File.file?(input)
-
+        elsif input.bytesize < 4096 && !input.include?("\0") && File.file?(input)
           :path
+        else
+          :bytes
         end
       when Pathname
         raise InvalidArgumentError, "input path does not exist: #{input}" unless input.file?
@@ -146,7 +224,7 @@ module ImagePack
       return :return_string if output.nil?
       return :path if output.is_a?(String) || output.is_a?(Pathname)
 
-      raise InvalidArgumentError, "output must be nil, String path, or Pathname in v0.2.0"
+      raise InvalidArgumentError, "output must be nil, String path, or Pathname in v0.2.2"
     end
 
     def validate_algo!(algo)
@@ -187,14 +265,8 @@ module ImagePack
       raise InvalidArgumentError, "channels must be 1, 3 or 4" unless [1, 3, 4].include?(channels)
     end
 
-    def validate_cancellable!(algo, execution, cancellable)
+    def validate_cancellable!(_algo, execution, cancellable)
       return unless cancellable
-
-      if algo == :jpeg_turbo
-        raise InvalidArgumentError,
-              "cancellable: true is only supported with algo: :mozjpeg in v0.2.0"
-      end
-
       return unless execution == :direct
 
       raise InvalidArgumentError,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_pack
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Roman Haydarov
@@ -402,7 +402,6 @@ files:
 - ext/image_pack/vendor/mozjpeg/wrtarga.c
 - ext/image_pack/vendor/mozjpeg/yuvjpeg.c
 - lib/image_pack.rb
-- lib/image_pack/backend.rb
 - lib/image_pack/configuration.rb
 - lib/image_pack/errors.rb
 - lib/image_pack/version.rb

data/lib/image_pack/backend.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module ImagePack
-  module Backend
-    JPEG_TURBO = :jpeg_turbo
-    MOZJPEG = :mozjpeg
-  end
-end