phash-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ed6783979b46e09e95389897750228c77636def24aca69d4317bdefe2084d87
+  data.tar.gz: fd24447815072b2c2327c08611db9ff92f26a334064a610c93a5074db3a45b61
+SHA512:
+  metadata.gz: 82b859cbc9d5bd00dc452e7c62e33e0b74a6015be8276a9954300c2391727604dd6726a96bcbe276e04e23a3176c36cb3e78e1167934e595f2cf094127d13551
+  data.tar.gz: bce7b097bb1c3f370fe2622fb375064b086f4e264347f61d5da6ed03a2e54aba72f66a99341a496e7a298c8e1f61231cd6adfe6705c01e5c015dbec95fcdd31b

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Tomasz Ratajczak, Krzysztof Hasiński
+
+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,71 @@
+# Phash
+
+Phashion replacement without native dependencies. Compatible with pHash 0.9.6.
+
+## Installation
+
+
+```bash
+bundle add phash-rb
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install phash-rb
+```
+
+## Usage
+
+If you're using Phashion replace Phashion::Image with Phash::Image.
+
+Public interface is the same as Phashion::Image.
+
+```ruby
+require 'phash'
+
+img1 = Phash::Image.new(filename1)
+img2 = Phash::Image.new(filename2)
+img1.duplicate?(img2) # true
+```
+
+Optionally, you can set the minimum Hamming distance in the second argument, an options Hash:
+
+```ruby
+img1.duplicate?(img2, threshold: 5) # true
+
+img1.duplicate?(img2, threshold: 0) # false
+```
+
+We also support the fingerprint method for storing Phash fingerprints in the database.
+
+```ruby
+require 'phash'
+
+Phash::Image.new(filename1).fingerprint # 3714852948054213970
+```
+
+Fingerprint is also available in a command `phash`:
+
+```bash
+$ phash filename1
+3714852948054213970
+```
+
+## 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 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/khasinski/phash-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/phash-rb/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Phash project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/phash-rb/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/exe/phash

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/phash"
+
+filename = ARGV[0]
+
+begin
+  puts Phash.fingerprint(filename)
+rescue => e
+  puts "Failed to compute pHash for #{filename}."
+  puts e
+  exit 1
+end

data/lib/phash/image.rb

@@ -0,0 +1,19 @@
+module Phash
+  class Image
+    def initialize(image)
+      @image = image
+    end
+
+    def fingerprint
+      @fingerprint ||= Phash.fingerprint(@image)
+    end
+
+    def duplicate?(other_image, threshold: 10)
+      distance_from(other_image) < threshold
+    end
+
+    def distance_from(other_image)
+      (fingerprint ^ other_image.fingerprint).to_s(2).count('1')
+    end
+  end
+end

data/lib/phash/version.rb

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

data/lib/phash.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "phash/version"
+require_relative "phash/image"
+require "vips"
+require "matrix"
+
+module Phash
+  CIMG_PI = 3.14159265358979323846
+  CIMG_V = CIMG_PI / 2 / 32
+  CIMG_SCALE = 2**8 + 1
+
+  def self.fingerprint(file)
+    img = Vips::Image.new_from_file(file)
+    #Y = (66*R + 129*G + 25*B + 128)/256 + 16
+    img = img * [66.0 / 256, 129.0 / 256, 25.0 / 256]
+    r, g, b = img.bandsplit
+    img = r + g + b + 16.5
+
+    mask = Vips::Image.new_from_array([[1.0] * 7] * 7)
+    img = img.colourspace("grey16")
+    img = img.conv(mask)
+    mat = sample(img)
+    dct = ph_dct_matrix
+    dct_t = dct.transpose
+
+    out = dct * mat * dct_t
+
+    sub = out.minor(1..8, 1..8).to_a.flatten
+    median = sub.sort[31..32].sum / 2
+
+    sub.reverse.map {|i| i > median ? 1 : 0 }.join.to_i(2)
+  end
+
+  private
+
+  def self.ph_dct_matrix
+    v = 1 / Math.sqrt(32)
+    c1 = Math.sqrt(2.0 / 32)
+
+    Matrix.build(32, 32) do |y, x|
+      (y < 1 ? v : c1 * Math.cos(CIMG_V * y * (2*x + 1))).round(6)
+    end
+  end
+
+  def self.sample(img)
+    w, h = img.width / 32.0, img.height / 32.0
+    src = img.to_a
+    Matrix.build(32, 32) do |y, x|
+      src[y*h][x*w][0] / CIMG_SCALE
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: phash-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomasz Ratajczak
+- Krzysztof Hasiński
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-22 00:00:00.000000000 Z
+dependencies:
+- !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: matrix
+  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'
+description: Ruby implementation of pHash library, uses VIPS for image processing
+email:
+- twratajczak@gmail.com
+- krzysztof.hasinski@gmail.com
+executables:
+- phash
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/phash
+- lib/phash.rb
+- lib/phash/image.rb
+- lib/phash/version.rb
+homepage: http://github.com/khasinski/phash-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/khasinski/phash-rb
+  source_code_uri: http://github.com/khasinski/phash-rb
+  changelog_uri: http://github.com/khasinski/phash-rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby implementation of pHash library
+test_files: []