blurhash-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e6bf34cd0850084ed01d434630f305a64a975c18925bfdfcdd9166b80e395a0
+  data.tar.gz: 52e1b5032437812fe02502131ac047967ed81dd1dfb2731f460436ab87934826
+SHA512:
+  metadata.gz: 29677b0b8d35ce21b3aa2fd50291dcd63c0a6bba8bd0ffd74756f4a70fe180a5aa4a2e8c8e196258672a378782a53ffb8c810173f5ddd80d36aa7b30bfba8786
+  data.tar.gz: dfc376653a4deb4d980fdd0a1dff0da97577809413eddf321387d2b9e1f45002e98e7201fc6e84a1be68e3d523226805211cc1459454a88a5b450589764fffe4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+require:
+  - rubocop-inhouse
+
+inherit_gem:
+  rubocop-inhouse:
+    - config/default.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+
+Lint/ItWithoutArgumentsInBlock:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-28
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Nolan J Tait
+
+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,83 @@
+# Blurhash
+
+This is a pure ruby implementation of the [blurhash](https://blurha.sh/)
+algorithm.
+
+There are other Ruby based libraries for this. But all of them use compiled
+dependencies which tend to cause issues over time.
+
+Currently it only handles encoding.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash bundle add blurhash-rb ```
+
+If bundler is not being used to manage dependencies, install the gem by
+executing:
+
+```bash gem install blurhash-rb ```
+
+## Usage
+
+To use it you just need to feed in the `pixels`, `width` and `height` of the
+image.
+
+```ruby
+require "blurhash-rb"
+
+def load_image_as_rgba(path)
+  image = ChunkyPNG::Image.from_file(path)
+  width = image.width
+  height = image.height
+  pixels = []
+
+  height.times do |y|
+    width.times do |x|
+      pixel = image[x, y]
+      r = ChunkyPNG::Color.r(pixel)
+      g = ChunkyPNG::Color.g(pixel)
+      b = ChunkyPNG::Color.b(pixel)
+      a = ChunkyPNG::Color.a(pixel)
+      pixels.push(r, g, b, a)
+    end
+  end
+
+  [pixels, width, height]
+end
+
+pixels, width, height = load_image_as_rgba("spec/fixtures/test.png")
+
+hash = described_class.call(
+  pixels:,
+  width:,
+  height:,
+  component_x: 4,
+  component_y: 3
+)
+
+puts hash #=> "LEHV6nae2yk8pyo0adR*.7kCMdnj"
+```
+
+## 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 the created tag, 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/nolantait/blurhash-rb.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/blurhash/base83.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Blurhash
+  module Base83
+    DIGIT_CHARACTERS =
+      # rubocop:disable Layout/MultilineArrayLineBreaks
+      %w(
+        0 1 2 3 4 5 6 7 8 9
+        A B C D E F G H I J
+        K L M N O P Q R S T
+        U V W X Y Z a b c d
+        e f g h i j k l m n
+        o p q r s t u v w x
+        y z # $ % * + , - .
+        : ; = ? @ [ ] ^ _ {
+        | } ~
+      ).freeze
+    # rubocop:enable Layout/MultilineArrayLineBreaks
+
+    def self.encode(number, length)
+      result = ""
+
+      (1..length).each do |integer|
+        digit = (number.floor / (83**(length - integer))) % 83
+        result += DIGIT_CHARACTERS[digit.floor]
+      end
+
+      result
+    end
+
+    def self.decode(string)
+      value = 0
+
+      string.each_char.with_index do |char, _index|
+        digit = DIGIT_CHARACTERS.index(char)
+        value = (value * 83) + digit
+      end
+
+      value
+    end
+  end
+end

data/lib/blurhash/encode.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Blurhash
+  class Encode
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    def self.call(...) = new.call(...)
+
+    def call(pixels:, width:, height:, component_x:, component_y:)
+      if component_x < 1 ||
+          component_x > 9 ||
+          component_y < 1 ||
+          component_y > 9
+        raise ValidationError,
+          "BlurHash must have between 1 and 9 components"
+      end
+      unless pixels.length == width * height * 3
+        raise ValidationError,
+          "Width and height must match the pixels array"
+      end
+
+      factors = []
+
+      component_y.times do |y|
+        component_x.times do |x|
+          normalisation = x.zero? && y.zero? ? 1 : 2
+          factor = multiply_basis_function(pixels, width, height) do |i, j|
+            normalisation *
+              Math.cos(Math::PI * x * i / width) *
+              Math.cos(Math::PI * y * j / height)
+          end
+          factors << factor
+        end
+      end
+
+      dc = factors[0]
+      ac = factors[1..]
+
+      hash = +""
+
+      size_flag = (component_x - 1) + ((component_y - 1) * 9)
+      hash << Base83.encode(size_flag, 1)
+
+      if ac.any?
+        actual_max = ac.map(&:max).max
+        quant_max = ((actual_max * 166) - 0.5).floor.clamp(0, 82)
+        max_val = (quant_max + 1) / 166.0
+        hash << Base83.encode(quant_max, 1)
+      else
+        max_val = 1.0
+        hash << Base83.encode(0, 1)
+      end
+
+      hash << Base83.encode(encode_dc(dc), 4)
+
+      ac.each do |factor|
+        hash << Base83.encode(encode_ac(factor, max_val), 2)
+      end
+
+      hash
+    end
+
+    private
+
+    def multiply_basis_function(pixels, width, height, &)
+      r = g = b = 0.0
+      bytes_per_pixel = 3
+      bytes_per_row = width * bytes_per_pixel
+
+      width.times do |x|
+        base_x = bytes_per_pixel * x
+        height.times do |y|
+          index = base_x + (y * bytes_per_row)
+          basis = yield(x, y)
+
+          r += basis * srgb_to_linear(pixels[index])
+          g += basis * srgb_to_linear(pixels[index + 1])
+          b += basis * srgb_to_linear(pixels[index + 2])
+        end
+      end
+
+      scale = 1.0 / (width * height)
+      [r * scale, g * scale, b * scale]
+    end
+
+    def encode_dc(value)
+      r = linear_to_srgb(value[0])
+      g = linear_to_srgb(value[1])
+      b = linear_to_srgb(value[2])
+      (r << 16) + (g << 8) + b
+    end
+
+    def encode_ac(value, maximum_value)
+      quant_r = ((sign_pow(value[0] / maximum_value, 0.5) * 9) + 9.5)
+        .floor
+        .clamp(0, 18)
+      quant_g = ((sign_pow(value[1] / maximum_value, 0.5) * 9) + 9.5)
+        .floor
+        .clamp(0, 18)
+      quant_b = ((sign_pow(value[2] / maximum_value, 0.5) * 9) + 9.5)
+        .floor
+        .clamp(0, 18)
+
+      (quant_r * 19 * 19) + (quant_g * 19) + quant_b
+    end
+
+    def srgb_to_linear(value)
+      v = value / 255.0
+      v <= 0.04045 ? v / 12.92 : ((v + 0.055) / 1.055)**2.4
+    end
+
+    def linear_to_srgb(value)
+      value = value.clamp(0, 1)
+
+      if value <= 0.0031308
+        ((value * 12.92 * 255) + 0.5).truncate(0)
+      else
+        ((((1.055 * (value**(1.0 / 2.4))) - 0.055) * 255) + 0.5).truncate(0)
+      end
+    end
+
+    def sign_pow(val, exp)
+      (val.abs**exp) * (val.negative? ? -1 : 1)
+    end
+
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  end
+end

data/lib/blurhash/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Blurhash
+  VERSION = "0.1.0"
+end

data/lib/blurhash.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "blurhash/version"
+require_relative "blurhash/base83"
+require_relative "blurhash/encode"
+
+module Blurhash
+  class Error < StandardError; end
+  # Your code goes here...
+
+  ValidationError = Class.new(Error)
+
+  def self.encode(pixels:, width:, height:, component_x: 4, component_y: 3)
+    Encode.call(pixels:, width:, height:, component_x:, component_y:)
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: blurhash-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nolan J Tait
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A pure Ruby implementation of the BlurHash algorithm, which encodes images
+  into a short string representation that can be used to display a blurred
+  version of the image while it is loading.
+email:
+- nolanjtait@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/blurhash.rb
+- lib/blurhash/base83.rb
+- lib/blurhash/encode.rb
+- lib/blurhash/version.rb
+homepage: https://github.com/nolantait/blurhash-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nolantait/blurhash-rb
+  source_code_uri: https://github.com/nolantait/blurhash-rb
+  changelog_uri: https://github.com/nolantait/blurhash-rb
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A pure Ruby implementation of the BlurHash algorithm.
+test_files: []