colordom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e428a11ebd273b9e3f8867468f74eff34cc681426e97133ec4cbce666c9006ce
+  data.tar.gz: e7d31a241c15cdd96b078f60ae8ae302d81206f691b0d50ff8208b2d526803e9
+SHA512:
+  metadata.gz: 5545da4d90450efee71fb4b1d078760d4820a703497a2cc7c3ba785f6be6f8caef49e218dcf011052c8ee6affbb1cf6b736b5be5210e0209ef4d5179a3ff73e1
+  data.tar.gz: 78350ba55457fc55e4429854b343a10a639137a8daeb3379e431425da93d48580bce4efed1707c744dd911a56b160664c0db6980eebe20802238d7e3d4ee3211

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# Added by cargo
+
+/target
+Cargo.lock
+
+/lib/*.so
+/mkmf.log

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+env:
+  global:
+    - RUST_VERSION=stable
+before_install:
+  - if [ ! -e "$HOME/.cargo/bin" ]; then curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain $RUST_VERSION -y; fi
+  - export PATH="$HOME/.cargo/bin:$PATH"
+  - rustup default $RUST_VERSION
+  - gem install bundler -v 2.1.4

data/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "colordom"
+version = "0.1.0"
+authors = ["Jonian Guveli <jonian@hardpixel.eu>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[dependencies]
+image = "0.24"
+dominant_color = "0.3"
+palette_extract = "0.1"
+
+[dependencies.kmeans_colors]
+version = "0.5"
+default-features = false
+features = ["palette_color"]
+
+[dependencies.palette]
+version = "0.6"
+default-features = false
+features = ["std"]
+
+[lib]
+name = "colordom"
+crate-type = ["cdylib"]

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in colordom.gemspec
+gemspec
+
+gem 'benchmark-ips'
+gem 'benchmark-memory'
+gem 'camalian'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 jonian
+
+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,53 @@
+# Colordom
+
+Ruby gem to extract color palettes from images implemented in Rust. Rust must be available on your system to install this gem.
+
+[![Gem Version](https://badge.fury.io/rb/colordom.svg)](https://badge.fury.io/rb/colordom)
+[![Build Status](https://travis-ci.org/hardpixel/colordom.svg?branch=master)](https://travis-ci.org/hardpixel/colordom)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7e307214d3c2e4d2056d/maintainability)](https://codeclimate.com/github/hardpixel/colordom/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'colordom'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install colordom
+
+## Usage
+
+```ruby
+require 'colordom'
+
+# Get colors using histogram algorithm
+Colordom.histogram(image_path)
+
+# Get colors using median cut algorithm
+Colordom.mediancut(image_path)
+
+# Get colors using kmeans algorithm
+Colordom.kmeans(image_path)
+```
+
+## 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.
+
+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/hardpixel/colordom.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'thermite/tasks'
+
+Thermite::Tasks.new
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: %w[thermite:build test]

data/bin/benchmark

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'benchmark/ips'
+require 'benchmark/memory'
+
+require 'colordom'
+require 'camalian'
+
+COUNT = 5
+IMAGE = File.join(__dir__, '..', 'samples/sample.png')
+
+def camalian(quant)
+  img = Camalian::load(IMAGE)
+  img.prominent_colors(COUNT, quantization: quant)
+end
+
+reports = lambda do |x|
+  x.report('colordom (HST)') do
+    Colordom.histogram(IMAGE, COUNT)
+  end
+
+  x.report('colordom (MCQ)') do
+    Colordom.mediancut(IMAGE, COUNT)
+  end
+
+  x.report('colordom (KMS)') do
+    Colordom.kmeans(IMAGE, COUNT)
+  end
+
+  x.report('camalian (HST)') do
+    camalian(Camalian::QUANTIZATION_HISTOGRAM)
+  end
+
+  x.report('camalian (MCQ)') do
+    camalian(Camalian::QUANTIZATION_MEDIAN_CUT)
+  end
+
+  x.report('camalian (KMS)') do
+    camalian(Camalian::QUANTIZATION_K_MEANS)
+  end
+end
+
+Benchmark.ips do |x|
+  reports.call(x)
+  x.compare!
+end
+
+Benchmark.memory do |x|
+  reports.call(x)
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'colordom'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/colordom.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/colordom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'colordom'
+  spec.version       = Colordom::VERSION
+  spec.authors       = ['Jonian Guveli']
+  spec.email         = ['jonian@hardpixel.eu']
+
+  spec.summary       = %q{Ruby wrapper for dominant color utilities in Rust}
+  spec.description   = %q{This project is a wrapper for dominant color utilities implemented in Rust.}
+  spec.homepage      = 'https://github.com/hardpixel/colordom'
+  spec.license       = 'MIT'
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|samples)/}) }
+  end
+
+  spec.extensions    = ['ext/Rakefile']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'ffi'
+  spec.add_runtime_dependency 'thermite'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+end

data/ext/Rakefile

@@ -0,0 +1,10 @@
+require 'thermite/tasks'
+
+project_dir = File.dirname(File.dirname(__FILE__))
+
+Thermite::Tasks.new(
+  cargo_project_path: project_dir,
+  ruby_project_path: project_dir
+)
+
+task default: %w[thermite:build]

data/lib/colordom/color.rb

@@ -0,0 +1,27 @@
+module Colordom
+  class Color
+    attr_reader :r, :g, :b
+
+    def initialize(red, green, blue)
+      @r, @g, @b = [red, green, blue].map(&:to_i)
+    end
+
+    def ==(other)
+      other.is_a?(self.class) &&
+        rgb == other.rgb
+    end
+
+    def rgb
+      [r, g, b]
+    end
+
+    def hex
+      rgb.inject('#') do |str, val|
+        str + val.to_s(16).rjust(2, '0').upcase
+      end
+    end
+
+    alias to_rgb rgb
+    alias to_hex hex
+  end
+end

data/lib/colordom/error.rb

@@ -0,0 +1,4 @@
+module Colordom
+  class Error < StandardError
+  end
+end

data/lib/colordom/native.rb

@@ -0,0 +1,16 @@
+module Colordom
+  module Native
+    extend FFI::Library
+
+    LIBNAME = "colordom.#{FFI::Platform::LIBSUFFIX}".freeze
+    LIBPATH = File.expand_path('..', __dir__).freeze
+
+    ffi_lib File.expand_path(LIBNAME, LIBPATH)
+
+    attach_function :to_histogram, :to_histogram, [:string], Result
+    attach_function :to_mediancut, :to_mediancut, [:string, :uint8], Result
+    attach_function :to_kmeans, :to_kmeans, [:string, :uint8], Result
+
+    attach_function :free, :free_result, [Result], :void
+  end
+end

data/lib/colordom/result.rb

@@ -0,0 +1,9 @@
+module Colordom
+  class Result < FFI::AutoPointer
+    class << self
+      def release(ptr)
+        Native.free(ptr)
+      end
+    end
+  end
+end

data/lib/colordom/version.rb

@@ -0,0 +1,3 @@
+module Colordom
+  VERSION = '0.1.0'.freeze
+end

data/lib/colordom.rb

@@ -0,0 +1,56 @@
+require 'ffi'
+
+require 'colordom/result'
+require 'colordom/native'
+require 'colordom/error'
+require 'colordom/color'
+require 'colordom/version'
+
+module Colordom
+  class << self
+    def histogram(path, max_colors = 5)
+      regex = /(\d+), (\d+), (\d+)/
+      value = call(:to_histogram, path)
+
+      parse(value, regex, max_colors)
+    end
+
+    def mediancut(path, max_colors = 5)
+      regex = /r: (\d+), g: (\d+), b: (\d+)/
+      value = call(:to_mediancut, path, max_colors)
+
+      parse(value, regex, max_colors)
+    end
+
+    def kmeans(path, max_colors = 5)
+      regex = /red: (\d+), green: (\d+), blue: (\d+)/
+      value = call(:to_kmeans, path, max_colors)
+
+      parse(value, regex)
+    end
+
+    private
+
+    def call(method, path, *args)
+      return if path.nil?
+
+      result = Native.send(method, path, *args)
+      result = result.read_string.force_encoding('UTF-8')
+
+      raise Error, result if result.start_with?(Error.name)
+
+      result
+    end
+
+    def parse(result, regex, limit = nil)
+      return [] if result.nil?
+
+      colors = result.scan(regex)
+      colors = colors.first(limit) if limit && limit.positive?
+
+      colors.map do |values|
+        Color.new(*values)
+      end
+    end
+  end
+end

data/src/lib.rs

@@ -0,0 +1,100 @@
+use std::os::raw::c_char;
+use std::ffi::{CStr, CString};
+
+use image;
+use dominant_color;
+use kmeans_colors;
+
+use palette_extract::{Quality, MaxColors, PixelEncoding, PixelFilter};
+use palette::{FromColor, IntoColor, Lab, Pixel, Srgb};
+
+fn to_string(unsafe_string: *const c_char) -> String {
+  unsafe { CStr::from_ptr(unsafe_string) }.to_str().unwrap().to_string()
+}
+
+fn to_char(string: String) -> *mut c_char {
+  CString::new(string).unwrap().into_raw()
+}
+
+#[no_mangle]
+pub extern "C" fn to_histogram(path: *const c_char) -> *mut c_char {
+  let img = match image::open(&to_string(path)) {
+    Ok(res) => res,
+    Err(ex) => return to_char(format!("Colordom::Error {:?}", ex.to_string()))
+  };
+
+
+  let has_alpha = match img.color() {
+    image::ColorType::Rgba8 => true,
+    image::ColorType::Rgba16 => true,
+    image::ColorType::Rgba32F => true,
+    _ => false
+  };
+
+  let pixels = img.as_bytes();
+  let result = dominant_color::get_colors(&pixels, has_alpha);
+
+  return to_char(format!("{:?}", result));
+}
+
+#[no_mangle]
+pub extern "C" fn to_mediancut(path: *const c_char, max_colors: u8) -> *mut c_char {
+  let img = match image::open(&to_string(path)) {
+    Ok(res) => res,
+    Err(ex) => return to_char(format!("Colordom::Error {:?}", ex.to_string()))
+  };
+
+  let pixels = img.as_bytes();
+  let result = palette_extract::get_palette_with_options(
+    &pixels,
+    PixelEncoding::Rgb,
+    Quality::default(),
+    MaxColors::new(max_colors),
+    PixelFilter::None
+  );
+
+  return to_char(format!("{:?}", result))
+}
+
+#[no_mangle]
+pub extern "C" fn to_kmeans(path: *const c_char, max_colors: u8) -> *mut c_char {
+  let img = match image::open(&to_string(path)) {
+    Ok(res) => res,
+    Err(ex) => return to_char(format!("Colordom::Error {:?}", ex.to_string()))
+  };
+
+  let pixels = img.as_bytes();
+  let max_iterations = 20;
+  let converge = 1.0;
+  let verbose = false;
+  let seed: u64 = 0;
+
+  let lab: Vec<Lab> = Srgb::from_raw_slice(&pixels)
+    .iter()
+    .map(|x| x.into_format().into_color())
+    .collect();
+
+  let run_result = kmeans_colors::get_kmeans_hamerly(
+    max_colors.into(),
+    max_iterations,
+    converge,
+    verbose,
+    &lab,
+    seed
+  );
+
+  let result = &run_result.centroids
+    .iter()
+    .map(|x| Srgb::from_color(*x).into_format())
+    .collect::<Vec<Srgb<u8>>>();
+
+  return to_char(format!("{:?}", result))
+}
+
+#[no_mangle]
+pub extern "C" fn free_result(string: *mut c_char) {
+  unsafe {
+    if string.is_null() { return }
+    CString::from_raw(string)
+  };
+}

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: colordom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  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: thermite
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: This project is a wrapper for dominant color utilities implemented in
+  Rust.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions:
+- ext/Rakefile
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Cargo.toml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/benchmark
+- bin/console
+- bin/setup
+- colordom.gemspec
+- ext/Rakefile
+- lib/colordom.rb
+- lib/colordom/color.rb
+- lib/colordom/error.rb
+- lib/colordom/native.rb
+- lib/colordom/result.rb
+- lib/colordom/version.rb
+- src/lib.rs
+homepage: https://github.com/hardpixel/colordom
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+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: 3.1.6
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for dominant color utilities in Rust
+test_files: []