phashion 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mike Perham
+
+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,64 @@
+Phashion
+===========
+
+Phashion is a Ruby wrapper around the pHash library, "perceptual hash", which detects duplicate
+and near duplicate multimedia files (images, audio, video).  The wrapper currently only supports images.
+
+Installation
+-------------
+
+First you need to install pHash.  pHash requires three libraries: CImg, ffmpeg and libjpeg.  My system already came with libjpeg on it so I didn't have to do anything for it.  YMMV.
+
+Install CImg.h by downloading the latest version from cimg.sf.net and placing the CImg.h header file in /usr/local/include.
+
+If you are working with audio or video, you will need to install ffmpeg:
+
+    port install ffmpeg (OR)
+    brew install ffmpeg
+
+Alternatively you can configure pHash to not support audio/video:
+
+    ./configure --disable-audio-hash --disable-video-hash
+
+Download and install the latest pHash tarball from http://phash.org/download/.  With 0.9.0, there are several issues with OSX: I had to disable audio and video support to avoid compilation issues and modify `ph_num_threads` in pHash.cpp to avoid Linux-specific code:
+
+    ./configure --disable-audio-hash --disable-video-hash
+    
+    int ph_num_threads()
+    {
+    	int numCPU = 2;
+    	return numCPU;
+    }
+
+Finally, run `make && make install` to install the pHash binaries.
+
+Now you can install this gem:
+
+    gem install phashion
+
+Usage
+---------
+
+    require 'phashion'
+    img1 = Phashion::Image.new(filename1)
+    img2 = Phashion::Image.new(filename2)
+    img1.duplicate?(img2)
+    --> true
+
+Left to the reader: add equality semantics so that duplicate images placed in a Ruby set are automatically removed:
+
+    set = Set.new
+    set << img1
+    set << img2
+    set.size
+    --> 1
+
+Author
+==========
+
+Mike Perham, http://mikeperham.com, http://twitter.com/mperham, mperham AT gmail.com
+
+Copyright
+----------
+
+Copyright (c) 2010 Mike Perham. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "phashion"
+    gem.summary = %Q{Simple wrapper around the pHash library}
+    gem.description = gem.summary
+    gem.email = "mperham@gmail.com"
+    gem.homepage = "http://github.com/mperham/phashion"
+    gem.authors = ["Mike Perham"]
+    gem.add_dependency 'RubyInline'
+    gem.version = '1.0.0'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "phashion"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/phashion.rb

@@ -0,0 +1,103 @@
+require 'rubygems'
+require 'inline'
+
+##
+# Provides a clean and simple API to detect duplicate image files using
+# the pHash library under the covers.
+#
+# The C API:
+# int ph_dct_imagehash(const char *file, ulong64 &hash);
+# int ph_hamming_distance(ulong64 hasha, ulong64 hashb);
+
+class Phashion
+  VERSION = '1.0.0'
+  
+  class Image
+    DUPE_THRESHOLD = 26
+    
+    attr_reader :filename
+    def initialize(filename)
+      @filename = filename
+    end
+    
+    def duplicate?(other)
+      Phashion.hamming_distance(hash_code, other.send(:hash_code)) < DUPE_THRESHOLD
+    end
+
+    private
+    
+    def hash_code
+      @hash ||= Phashion.image_hash_for(@filename)
+    end
+  end
+  
+  def self.image_hash_for(filename)
+  end
+
+  def self.hamming_distance(hashA, hashB)
+  end
+
+  inline do |builder|
+    if test ?d, "/opt/local" then
+      builder.add_compile_flags "-I/opt/local/include"
+      builder.add_link_flags "-L/opt/local/lib"
+    end
+
+    builder.add_compile_flags '-x c++', '-lstdc++'
+    builder.add_link_flags "-lpHash"
+    builder.include '"pHash.h"'
+
+    builder.c_singleton <<-"END"
+      VALUE image_hash_for(const char *filename) {
+        ulong64 hash;
+        if (-1 == ph_dct_imagehash(filename, hash)) {
+          rb_raise(rb_eRuntimeError, "Unknown pHash error");
+        }
+        return ULL2NUM(hash);
+      }
+    END
+
+    builder.c_singleton <<-"END"
+      VALUE hamming_distance(VALUE a, VALUE b) {
+        int result = 0;
+        result = ph_hamming_distance(NUM2ULL(a), NUM2ULL(b));
+        if (-1 == result) {
+          rb_raise(rb_eRuntimeError, "Unknown pHash error");
+        }
+        return INT2NUM(result);
+      }
+    END
+
+  end
+end
+
+if __FILE__ == $0
+  
+  def memory
+    `ps -o vsz,rss -p #{$$}`.strip
+  end
+  
+  def assert_duplicate(a, b)
+    raise ArgumentError, "#{a.filename} not dupe of #{b.filename}" unless a.duplicate?(b)
+  end
+
+  def assert_not_duplicate(a, b)
+    raise ArgumentError, "#{a.filename} dupe of #{b.filename}" if a.duplicate?(b)
+  end
+
+  FILES = %w(86x86-0a1e.jpeg 86x86-83d6.jpeg 86x86-a855.jpeg avatar.jpg)
+
+  images = FILES.map {|f| PHash::Image.new("#{File.dirname(__FILE__) + '/../test/'}#{f}")}
+  # GC.start
+  # puts memory
+  assert_duplicate images[0], images[1]
+  assert_duplicate images[1], images[2]
+  assert_duplicate images[0], images[2]
+
+  assert_not_duplicate images[0], images[3]
+  assert_not_duplicate images[1], images[3]
+  assert_not_duplicate images[2], images[3]
+  # GC.start
+  # puts memory
+  
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'test/unit'
+require 'phashion'
+
+class Test::Unit::TestCase
+end

data/test/test_phashion.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+class TestPhashion < Test::Unit::TestCase
+
+  def test_duplicate_detection
+    files = %w(86x86-0a1e.jpeg 86x86-83d6.jpeg 86x86-a855.jpeg)
+    images = files.map {|f| Phashion::Image.new("#{File.dirname(__FILE__) + '/../test/'}#{f}")}
+    assert_duplicate images[0], images[1]
+    assert_duplicate images[1], images[2]
+    assert_duplicate images[0], images[2]
+  end
+
+  def test_not_duplicate
+    files = %w(86x86-0a1e.jpeg 86x86-83d6.jpeg 86x86-a855.jpeg avatar.jpg)
+    images = files.map {|f| Phashion::Image.new("#{File.dirname(__FILE__) + '/../test/'}#{f}")}
+    assert_not_duplicate images[0], images[3]
+    assert_not_duplicate images[1], images[3]
+    assert_not_duplicate images[2], images[3]
+  end
+
+  private
+
+  def assert_duplicate(a, b)
+    raise ArgumentError, "#{a.filename} not dupe of #{b.filename}" unless a.duplicate?(b)
+  end
+
+  def assert_not_duplicate(a, b)
+    raise ArgumentError, "#{a.filename} dupe of #{b.filename}" if a.duplicate?(b)
+  end  
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: phashion
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Mike Perham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-20 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RubyInline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Simple wrapper around the pHash library
+email: mperham@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/phashion.rb
+- test/86x86-0a1e.jpeg
+- test/86x86-83d6.jpeg
+- test/86x86-a855.jpeg
+- test/avatar.jpg
+- test/helper.rb
+- test/test_phashion.rb
+has_rdoc: true
+homepage: http://github.com/mperham/phashion
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple wrapper around the pHash library
+test_files: 
+- test/helper.rb
+- test/test_phashion.rb