earworm 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.0.1 / 2008-08-01
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/earworm
+lib/earworm.rb
+lib/earworm/client.rb
+lib/earworm/fingerprint.rb
+lib/earworm/puid.rb
+lib/earworm/track.rb
+lib/earworm_lib.rb
+test/test_earworm.rb

data/README.txt

@@ -0,0 +1,66 @@
+= earworm
+
+* http://earworm.rubyforge.org
+
+== DESCRIPTION:
+
+Earworm can identify unknown music using MusicDNS and libofa.
+
+== FEATURES/PROBLEMS:
+
+* Identifies mp3, ogg, and wav files.
+
+== SYNOPSIS:
+
+Identify an unknown audio file:
+
+  ew = Earworm::Client.new('MY Music DNS Key')
+  info = ew.identify(:file => '/home/aaron/unknown.wav')
+  puts "#{info.artist_name} - #{info.title}"
+
+Fetch info for a PUID:
+
+  ew = Earworm::Client.new('MY Music DNS Key')
+  info = ew.identify(:puid => 'f39d4c68-ab2d-5067-9a1a-c6b45a367906')
+  puts "#{info.artist_name} - #{info.title}"
+
+== REQUIREMENTS:
+
+* {MusicDNS key}[https://secure.musicip.com/dns/index.jsp]
+* libofa
+* icanhasaudio
+
+== INSTALL:
+
+OS X:
+* sudo port install libogg libvorbis lame libofa
+* gem install earworm
+
+Linux:
+* sudo yum install libogg-devel libvorbis-devel lame-devel libofa
+* gem install earworm
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 {Aaron Patterson}[http://tenderlovemaking.com/]
+
+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/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'earworm'
+
+Hoe.new('earworm', Earworm::VERSION) do |p|
+  p.developer('Aaron Patterson', 'aaronp@rubyforge.org')
+  p.extra_deps = [['icanhasaudio', '>=0.1.1']]
+end
+
+# vim: syntax=Ruby

data/bin/earworm

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'earworm'
+require 'yaml'
+
+CONFIG = File.join(File.expand_path(ENV['HOME']), '.earworm')
+config = YAML.load_file(CONFIG)
+
+(puts("USAGE: #{$0} unknown_file") || exit) unless ARGV[0]
+
+ew = Earworm::Client.new(config['key'])
+track =
+  if File.exists?(ARGV[0])
+    ew.identify(:file => ARGV[0])
+  else
+    ew.identify(:puid => ARGV[0])
+  end
+
+puts "Title: #{track.title}" if track.title
+puts "Artist: #{track.artist}" if track.artist
+track.puid_list.each do |puid|
+  puts "PUID: #{puid}"
+end
+

data/lib/earworm.rb

@@ -0,0 +1,26 @@
+require 'icanhasaudio'
+require 'tempfile'
+require 'earworm_lib'
+require 'earworm/track'
+require 'earworm/puid'
+require 'earworm/fingerprint'
+require 'earworm/client'
+require 'rexml/document'
+require 'rexml/parsers/pullparser'
+
+module Earworm
+  VERSION = '0.0.1'
+  URL = 'http://ofa.musicdns.org/ofa/1/track'
+  class << self
+    def ofa_version
+      major = DL.malloc(DL.sizeof('I'))
+      minor = DL.malloc(DL.sizeof('I'))
+      rev = DL.malloc(DL.sizeof('I'))
+      major.struct!('I', 'val')
+      minor.struct!('I', 'val')
+      rev.struct!('I', 'val')
+      EarwormLib.ofa_get_version(major, minor, rev)
+      "#{major['val']}.#{minor['val']}.#{rev['val']}"
+    end
+  end
+end

data/lib/earworm/client.rb

@@ -0,0 +1,49 @@
+module Earworm
+  class Client
+    attr_accessor :client_id
+    def initialize(client_id)
+      @client_id = client_id
+    end
+
+    def identify(options = {})
+      post_opts = nil
+      if options.key?(:file)
+        post_opts = {
+          'cid'  => @client_id,
+          'cvr'  => "Earworm #{VERSION}",
+          'rmd'  => 1,
+          'enc'  => '',
+        }.merge(Fingerprint.new(options[:file]).to_hash)
+      end
+      if options.key?(:puid)
+        post_opts = {
+          'cid'  => @client_id,
+          'cvr'  => "Earworm #{VERSION}",
+          'rmd'  => 1,
+          'enc'  => '',
+        }.merge(PUID.new(options[:puid]).to_hash)
+      end
+      xml = Net::HTTP.post_form(URI.parse(URL), post_opts).body
+      parser = REXML::Parsers::PullParser.new(xml)
+      track = Track.new
+      while parser.has_next?
+        thing = parser.pull
+        if thing.start_element?
+          case thing[0]
+          when 'title'
+            track.title = parser.pull[0]
+          when 'name'
+            track.artist_name = parser.pull[0]
+          when 'puid'
+            track.puid_list << thing[1]['id']
+          end
+        end
+      end
+      track
+    end
+
+    def fingerprint(filename)
+      Fingerprint.new(filename).to_s
+    end
+  end
+end

data/lib/earworm/fingerprint.rb

@@ -0,0 +1,102 @@
+module Earworm
+  class Fingerprint
+    def initialize(thing)
+      @thing  = thing
+      @hash   = nil
+    end
+
+    def to_hash
+      return @hash if @hash
+      info = nil
+      @hash = {
+        'art'  => 'unknown',
+        'ttl'  => 'unknown',
+        'alb'  => 'unknown',
+        'tnm'  => 0,
+        'gnr'  => 'unknown',
+        'yrr'  => 0,
+        'brt'  => 0,
+        'fmt'  => 'wav',
+      }
+      if @thing.is_a?(IO)
+        info = wav_info_for(@thing)
+      else
+        tmpfile = case @thing
+                  when /mp3$/
+                    @hash['fmt'] = 'mp3'
+                    begin
+                      require 'id3lib'
+                      @hash = @hash.merge(id3_info_for(@thing))
+                    rescue LoadError
+                    end
+                    decode_mp3(@thing)
+                  when /ogg$/
+                    @hash['fmt'] = 'ogg'
+                    decode_ogg(@thing)
+                  else # Assume its a wav file
+                    @thing
+                  end
+        File.open(tmpfile, 'rb') { |f|
+          info = wav_info_for(f)
+        }
+      end
+      @hash['fpt'] = info[:fpt]
+      @hash['dur'] = info[:milliseconds]
+      @hash
+    end
+
+    def to_s
+      to_hash['fpt']
+    end
+
+    private
+    def wav_info_for(io)
+      header = io.read(4).unpack('N').first
+      raise unless header == Audio::MPEG::Encoder::WAV_ID_RIFF
+      info = Audio::MPEG::Encoder.parse_wave_header(io)
+      bytes_in_seconds = 135 * info[:in_samplerate] * 2 * info[:num_channels]
+      read_bytes =
+        if info[:bytes_in_seconds] > bytes_in_seconds
+          bytes_in_seconds
+        else
+          info[:bytes_in_seconds]
+        end
+
+      data = io.read(read_bytes)
+      info[:fpt] = EarwormLib.ofa_create_print( data,
+                                                0,
+                                                read_bytes/2,
+                                                info[:in_samplerate], 1)
+      info
+    end
+
+    def id3_info_for(filename)
+      tag = ID3Lib::Tag.new(filename)
+      {
+        'art'  => tag.artist,
+        'ttl'  => tag.title,
+        'alb'  => tag.album,
+        'tnm'  => tag.track[/^(\d+)/],
+        'gnr'  => tag.genre,
+        'yrr'  => tag.year,
+      }
+    end
+
+    {
+      'ogg' => Audio::OGG::Decoder,
+      'mp3' => Audio::MPEG::Decoder,
+    }.each do |type,klass|
+      define_method(:"decode_#{type}") do |filename|
+        reader = klass.new
+        name = File.join(Dir::tmpdir,
+          "#{File.basename(filename, ".#{type}")}.wav")
+        File.open(filename, 'rb') { |input|
+          File.open(name, 'wb') { |tmpfile|
+            reader.decode(input, tmpfile)
+          }
+        }
+        name
+      end
+    end
+  end
+end

data/lib/earworm/puid.rb

@@ -0,0 +1,21 @@
+module Earworm
+  class PUID
+    def initialize(puid)
+      @puid = puid
+    end
+
+    def to_hash
+      {
+        'puid' => @puid,
+        'art'  => 'unknown',
+        'ttl'  => 'unknown',
+        'alb'  => 'unknown',
+        'tnm'  => 0,
+        'gnr'  => 'unknown',
+        'yrr'  => 0,
+      }
+    end
+
+    def to_s; @puid; end
+  end
+end

data/lib/earworm/track.rb

@@ -0,0 +1,11 @@
+module Earworm
+  class Track
+    attr_accessor :title, :artist_name, :puid_list
+    alias :artist :artist_name
+    def initialize
+      @title = nil
+      @artist_name = nil
+      @puid_list = []
+    end
+  end
+end

data/lib/earworm_lib.rb

@@ -0,0 +1,21 @@
+require 'dl/import'
+module EarwormLib # :nodoc:
+  extend DL::Importable
+  loaded = false
+  libs = %w{ libofa.dylib libofa.so libofa.so.0 }
+  dirs = %w{ /opt/local/lib /usr/local/lib }
+  libs += libs.map { |lib| dirs.map { |dir| File.join(dir, lib) } }.flatten
+  libs.each do |so|
+    begin
+      dlload(so)
+      loaded = true
+      break
+    rescue
+      next
+    end
+  end
+  raise "Please install libofa" unless loaded
+
+  extern "void ofa_get_version(int *, int *, int *)"
+  extern "const char * ofa_create_print(const char *, int, long, int, int)"
+end

data/test/test_earworm.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'test/unit'
+require 'earworm'
+require 'yaml'
+
+class EarwormTest < Test::Unit::TestCase
+  def setup
+    settings = YAML.load_file(File.join(ENV['HOME'], '.earworm'))
+    assert settings
+    assert settings['assets']
+    assert settings['key']
+    @assets = settings['assets']
+    @key = settings['key']
+    @mp3 = Dir[@assets + "/*.mp3"].first
+  end
+
+  def test_ofa_version
+    assert Earworm.ofa_version
+  end
+
+  def test_fingerprint
+    ew = Earworm::Client.new('123')
+    key = ew.fingerprint(@mp3)
+    assert key
+  end
+
+  def test_identify_file
+    ew = Earworm::Client.new(@key)
+    info = ew.identify(:file => @mp3)
+    assert info
+    assert info.artist_name
+    assert info.title
+    assert info.puid_list.length > 0
+  end
+
+  def test_idenfity_puid
+    ew = Earworm::Client.new(@key)
+    info = ew.identify(:puid => 'f39d4c68-ab2d-5067-9a1a-c6b45a367906')
+    assert info
+    assert info.artist_name
+    assert info.title
+    assert info.puid_list.length > 0
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: earworm
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: icanhasaudio
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: Earworm can identify unknown music using MusicDNS and libofa.
+email: 
+- aaronp@rubyforge.org
+executables: 
+- earworm
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/earworm
+- lib/earworm.rb
+- lib/earworm/client.rb
+- lib/earworm/fingerprint.rb
+- lib/earworm/puid.rb
+- lib/earworm/track.rb
+- lib/earworm_lib.rb
+- test/test_earworm.rb
+has_rdoc: true
+homepage: http://earworm.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: earworm
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Earworm can identify unknown music using MusicDNS and libofa.
+test_files: 
+- test/test_earworm.rb