active_analysis 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50bc86a224ca66770b89a5d682a0bfe35a1656b984d03c4ddcf241db3b806419
-  data.tar.gz: eff170d586dd5d3b8c7b954dd93eccae0e4f95734da74bdbe0e9c5876032e8db
+  metadata.gz: 75cde4e32a958cb79b87b7c333a4cb39fb3bd6be937c00bb4c8cd2e2012741b2
+  data.tar.gz: 1729529848f522024d7ce5774dab64344b7efe70358ab832793fa992e6bc6c2a
 SHA512:
-  metadata.gz: 7ec4bb9f83d259d7331562b2ff741bbf12514ac8521c7f61810f139a2f3a7271851766ce85859b1df58910e3d9c02feeffe2d2f8a08bee8a508bb14c85958c3f
-  data.tar.gz: c964a651bc33f323bc71f11814e32d56328dcab774725bc7b2cddf1bf412e0ac978e7548596d863b388dcd3099d4aa538f1060f18ab410a1df16cf527e54c5fd
+  metadata.gz: 1a9ccbaeb56aad39604101559f9ec0909d551d315714ccf5b3313be824aa6a46138a67bb96404e426864bc7868e971890a76c4e95279bc0967571128e87d1975
+  data.tar.gz: 7b43f43265abaa0adb94b4722b1cf26cb74a9d20de9b103b0a706df906960dd7ec2c5f5f701572d75a05503b1058c41c50c9baf2b97bde3b5728d272b661de7a

data/README.md

@@ -63,6 +63,18 @@ A modification of the original video analyzer. Requires the [FFmpeg](https://www
 - Audio (true if file has an audio channel, false if not)
 - Video (true if file has an video channel, false if not)
 
+## Addons
+Active Analysis allows additional features to be added to the image analyzers through addons. To create an addon simply inherit the `Addon` class and add it to the addons array in the configuration.
+```ruby
+Rails.application.configure do |config|
+  config.active_analysis.addons << ActiveAnalysis::Addon::ImageAddon::OptimalQuality
+end
+```
+
+The following addons available:
+- ImageAddon::OptimalQuality: An EXPERIMENTAL addon that calculates the optimal image quality using a DSSIM of 0.001. This addon is SLOOOOOOW.
+- ImageAddon::WhiteBackground: An EXPERIMENTAL addon that checks if the image has a white background. Requires both vips and image magick to be installed.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/active_analysis.rb

@@ -7,9 +7,12 @@ module ActiveAnalysis
   autoload :FixtureSet
 
   mattr_accessor :logger
+
   mattr_accessor :image_library
   mattr_accessor :image_analyzer
   mattr_accessor :audio_analyzer
   mattr_accessor :pdf_analyzer
   mattr_accessor :video_analyzer
+
+  mattr_accessor :addons
 end

data/lib/active_analysis/addon.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveAnalysis
+  # This is an abstract base class for analyzer addons, which extract extra metadata from blobs.
+  class Addon
+    attr_reader :file
+
+    def self.accept?(blob)
+      false
+    end
+
+    def initialize(file)
+      @file = file
+    end
+
+    def metadata
+      raise NotImplementedError
+    end
+  end
+end

data/lib/active_analysis/addon/image_addon.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "../addon"
+
+module ActiveAnalysis
+  # This is an abstract base class for image addons
+  class Addon::ImageAddon < Addon
+    def self.accept?(blob)
+      blob.image?
+    end
+
+    def metadata
+      raise NotImplementedError
+    end
+  end
+end
+

data/lib/active_analysis/addon/image_addon/optimal_quality.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "../image_addon"
+
+module ActiveAnalysis
+  class Addon::ImageAddon::OptimalQuality < Addon::ImageAddon
+    def metadata
+      { optimal_quality: calculate_optimal_quality }
+    end
+
+    private
+      def calculate_optimal_quality
+        quality = 85
+
+        loop do
+          new_quality = quality - 5
+          dssim = calculate_dssim(new_quality)
+          break if dssim > 0.001 || quality <= 50
+          quality = new_quality
+        end
+
+        quality
+      rescue
+        nil
+      end
+
+      def calculate_dssim(quality)
+        image_with_quality(quality) do |image|
+          dssim = `dssim #{file.path} #{image.path}`
+          Float dssim.split.first
+        end
+      end
+
+      def image_with_quality(quality)
+        extname  = File.extname(file.path)
+        basename = File.basename(file.path, extname)
+
+        Tempfile.create(["#{basename}_#{quality}", extname]) do |tempfile|
+          processor.apply(saver: { format: "jpg", quality: quality }).call(file.path, destination: tempfile.path)
+          yield tempfile
+        end
+      end
+
+      def processor
+        ActiveAnalysis.image_library == :vips ? ::ImageProcessing::Vips : ::ImageProcessing::MiniMagick
+      end
+  end
+end
+

data/lib/active_analysis/addon/image_addon/white_background.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "../image_addon"
+
+module ActiveAnalysis
+  class Addon::ImageAddon::WhiteBackground < Addon::ImageAddon
+    def metadata
+      { white_background: white_background? }
+    end
+
+    private
+      def white_background?
+        corners = extract_corner_areas(file)
+        colors = corners.map { |corner| primary_color_for(corner) }
+        colors.all? { |color| color.all? { |value| value > 250 } }
+      rescue
+        nil
+      end
+
+      def extract_corner_areas(image)
+        paths = []
+
+        image_path = ActiveAnalysis.image_analyzer == :vips ? image.filename : image.path
+        basename   = SecureRandom.urlsafe_base64
+        width      = image.width
+        height     = image.height
+        size       = 8
+
+        paths << Rails.root.join("tmp", "#{basename}_top_left.jpg")
+        `vips im_extract_area #{image_path} #{paths.last} 0 0 #{size} #{size}`
+
+        paths << Rails.root.join("tmp", "#{basename}_top_right.jpg")
+        `vips im_extract_area #{image_path} #{paths.last} #{width - size} 0 #{size} #{size}`
+
+        paths << Rails.root.join("tmp", "#{basename}_bottom_right.jpg")
+        `vips im_extract_area #{image_path} #{paths.last} #{width - size} #{height - size} #{size} #{size}`
+
+        paths << Rails.root.join("tmp", "#{basename}_bottom_left.jpg")
+        `vips im_extract_area #{image_path} #{paths.last} 0 #{height - size} #{size} #{size}`
+
+        paths
+      end
+
+      def primary_color_for(filepath)
+        histogram = generate_color_histogram(filepath)
+        sorted = sort_by_frequency(histogram)
+        extract_dominant_rgb(sorted)
+      end
+
+      def generate_color_histogram(path)
+        `convert #{path} +dither -colors 5 -define histogram:unique-colors=true -format "%c" histogram:info:`
+      end
+
+      def sort_by_frequency(histogram)
+        histogram.each_line.map { |line| parts = line.split(":"); [parts[0].to_i, parts[1]] }.sort_by { |line| line[0] }.reverse
+      end
+
+      def extract_dominant_rgb(array)
+        array.map { |line| line[1].match(/\(([\d.,]+)/).captures.first.split(",").take(3).map(&:to_i) }.first
+      end
+  end
+end
+

data/lib/active_analysis/analyzer/image_analyzer.rb

@@ -19,9 +19,9 @@ module ActiveAnalysis
     def metadata
       read_image do |image|
         if rotated_image?(image)
-          { width: image.height, height: image.width, opaque: opaque?(image) }
+          { width: image.height, height: image.width, opaque: opaque?(image), **addons(image) }.compact
         else
-          { width: image.width, height: image.height, opaque: opaque?(image) }
+          { width: image.width, height: image.height, opaque: opaque?(image), **addons(image) }.compact
         end
       end
     end
@@ -38,6 +38,10 @@ module ActiveAnalysis
       def opaque?(image)
         raise NotImplementedError
       end
+
+      def addons(image)
+        ActiveAnalysis.addons.select { |addon| addon.accept?(blob) }.map { |addon_class| addon_class.new(image).metadata }.reduce({}, :merge).compact
+      end
   end
 end
 

data/lib/active_analysis/engine.rb

@@ -3,6 +3,7 @@
 require "active_storage"
 
 require "marcel"
+require "image_processing"
 require "ruby-vips"
 require "mini_magick"
 
@@ -14,21 +15,30 @@ require_relative "analyzer/audio_analyzer"
 require_relative "analyzer/video_analyzer"
 require_relative "analyzer/pdf_analyzer"
 
+require_relative "addon"
+require_relative "addon/image_addon"
+require_relative "addon/image_addon/optimal_quality"
+require_relative "addon/image_addon/white_background"
+
 module ActiveAnalysis
   class Engine < ::Rails::Engine
     isolate_namespace ActiveAnalysis
 
     config.active_analysis = ActiveSupport::OrderedOptions.new
+    config.active_analysis.addons = []
+
     config.eager_load_namespaces << ActiveAnalysis
 
     initializer "active_analysis.configs" do
       config.after_initialize do |app|
         ActiveAnalysis.logger         = app.config.active_analysis.logger         || Rails.logger
+
         ActiveAnalysis.image_library  = app.config.active_analysis.image_library  || app.config.active_storage.variant_processor || :mini_magick
         ActiveAnalysis.image_analyzer = app.config.active_analysis.image_analyzer || true
         ActiveAnalysis.audio_analyzer = app.config.active_analysis.audio_analyzer || true
         ActiveAnalysis.pdf_analyzer   = app.config.active_analysis.pdf_analyzer   || true
         ActiveAnalysis.video_analyzer = app.config.active_analysis.video_analyzer || true
+        ActiveAnalysis.addons         = app.config.active_analysis.addons         || []
       end
     end
 

data/lib/active_analysis/gem_version.rb

@@ -8,8 +8,8 @@ module ActiveAnalysis
 
   module VERSION
     MAJOR = 0
-    MINOR = 2
-    TINY  = 1
+    MINOR = 3
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_analysis
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Breno Gazzola
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage
@@ -39,47 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: mini_magick
+  name: image_processing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: ruby-vips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: platform_agent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +157,10 @@ files:
 - app/views/layouts/active_analysis/application.html.erb
 - config/routes.rb
 - lib/active_analysis.rb
+- lib/active_analysis/addon.rb
+- lib/active_analysis/addon/image_addon.rb
+- lib/active_analysis/addon/image_addon/optimal_quality.rb
+- lib/active_analysis/addon/image_addon/white_background.rb
 - lib/active_analysis/analyzer.rb
 - lib/active_analysis/analyzer/audio_analyzer.rb
 - lib/active_analysis/analyzer/image_analyzer.rb