music_detector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 351f70dc693ce76ab58d592cad6543f0c657918e
+  data.tar.gz: ad85f66c2b598fa8692d42436b352f22234470dc
+SHA512:
+  metadata.gz: 36662b050ed8615d05196a23621d65df77aca65a7c80eb730431189c050078cfcac90640b9f03f580c5f68e9e59094ae24000ae1194d3de09a802c6f73fd147a
+  data.tar.gz: e25d5ed2c4dfadbbc694145c0e0085e0db9b8325926911d745e317c36a2ea42741887dd7c89f1a5de2d2f84145a1c11144208f65e658d5cdf89b833e9309f9ec

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.14.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sobatarooo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in music_detector.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 sobataro
+
+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,50 @@
+# MusicDetector
+
+A music detector written in Ruby.
+
+
+## System Requirements
+
+- fftw-devel
+  - can be installed by `yum install fftw-devel` on RHEL-like systems
+  - can be installed by `brew install fftw` on OS X
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'music_detector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install music_detector
+
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## 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 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/sobataro/music_detector. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "music_detector"
+
+# 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/lib/music_detector/configuration.rb

@@ -0,0 +1,16 @@
+module MusicDetector
+  class Configuration
+    attr_reader :a, :temperament_range, :in_tune_cents, :out_of_tune_cents
+
+    # @param [Numeric] a                  base A4 frequency of the equal temperament (typically 440)
+    # @param [Range]   temperament_range  range of the equal temperament used to extract feature vector
+    # @param [Float]   in_tune_cents      maximum frequency difference between an in-tune note and the equal temperament
+    # @param [Float]   out_of_tune_ratio  minimum frequency difference between an out-of-tune note and the equal temperament
+    def initialize(a: 440, temperament_range: -12..24, in_tune_cents: 10, out_of_tune_cents: 30)
+      @a                 = a
+      @temperament_range = temperament_range
+      @in_tune_cents     = in_tune_cents
+      @out_of_tune_cents = out_of_tune_cents
+    end
+  end
+end

data/lib/music_detector/feature_vector_extractor.rb

@@ -0,0 +1,106 @@
+require 'wavefile'
+require 'numru/fftw3'
+
+module MusicDetector
+  class FeatureVectorExtractor
+
+    attr_reader :config
+
+    # @param [MusicDetector::Configuration] config config to process music file
+    def initialize(config)
+      @config = config
+    end
+
+    # @param [String] file      path of the input audio file
+    # @param [Float]  seektime  seek time in the audio file (in seconds)
+    # @param [Float]  duration  duration in the audio file (in seconds)
+    # @return [NArray<Float>]   extracted feature vector
+    def extract_from(file:, seektime:, duration:)
+      # read audio file
+      wave, samplerate = read_audio_file(file: file, seektime: seektime, duration: duration)
+
+      # do fft and make frequency spectrum
+      length      = wave.length / 2
+      spectrum    = NumRu::FFTW3.fft(wave, NumRu::FFTW3::FORWARD).abs[0...length]
+      frequencies = NArray.to_na((0...length).map { |i| i.to_f / length * samplerate / 2 }) # frequencies of each element in spectrum
+
+      # bandpath filter (to faster computation)
+      spectrum, frequencies = band_path_filter(spectrum: spectrum, frequencies: frequencies)
+
+      # prepare for analysis
+      log_frequencies = NMath::log(frequencies)
+      log_temperament = NMath::log(equal_temperament)
+
+      log_bin_freq_half_bandwidth    = (log_temperament[1] - log_temperament[0]) / 2.0
+      log_in_tune_freq_threshold     = log_bin_freq_half_bandwidth * @config.in_tune_cents / 100.0
+      log_out_of_tune_freq_threshold = log_bin_freq_half_bandwidth * @config.out_of_tune_cents / 100.0
+
+      log_temperament.map do |log_bin_center_freq|
+        # indices of the target bin (for spectrum)
+        log_bin_indices = (log_frequencies - log_bin_center_freq).abs < log_bin_freq_half_bandwidth
+
+        # extract the target bin
+        target_log_frequencies = log_frequencies[log_bin_indices]
+        target_spectrum        = spectrum[log_bin_indices]
+
+        # calc ratio between in-tune and out-of-tune powers
+        target_in_tune_indices     = (target_log_frequencies - log_bin_center_freq).abs <= log_in_tune_freq_threshold
+        target_out_of_tune_indices = (target_log_frequencies - log_bin_center_freq).abs >  log_out_of_tune_freq_threshold
+
+        in_tune_power     = target_spectrum[target_in_tune_indices].mean
+        out_of_tune_power = target_spectrum[target_out_of_tune_indices].mean
+
+        in_tune_power / out_of_tune_power
+      end.sort.reverse
+    end
+
+    private
+
+    def read_audio_file(file:, seektime:, duration:)
+      mono_wave = nil
+      samplerate = nil
+
+      WaveFile::Reader.new(file) do |sound|
+        samplerate = sound.format.sample_rate
+        channels = sound.format.channels
+
+        # seek
+        sound.read((seektime * samplerate).round)
+
+        # read
+        sample_count = (duration * samplerate).round
+        mono_wave = NArray.sint(sample_count)
+
+        sound.read(sample_count).samples.each.with_index do |sample, i|
+          case sample
+          when Array
+            mono_wave[i] = sample.inject(&:+) / channels # normalize to monoral
+            mono_wave[i] *= (2 ** (bits_per_sample - 1)) if Float === sample.first
+          when Fixnum
+            mono_wave[i] = sample
+          when Float
+            mono_wave[i] = sample * (2 ** (bits_per_sample - 1))
+          else
+            raise StandardError("unsupported file: #{file}")
+          end
+        end
+      end
+
+      [mono_wave, samplerate]
+    end
+
+    def band_path_filter(spectrum:, frequencies:)
+      hpf_freq = @config.a * 2 ** ((@config.temperament_range.first - 1) / 12.0)
+      lpf_freq = @config.a * 2 ** ((@config.temperament_range.last + 1) / 12.0)
+
+      bpf_indices = (hpf_freq < frequencies) * (frequencies < lpf_freq)
+      spectrum    = spectrum[bpf_indices]
+      frequencies = frequencies[bpf_indices]
+      [spectrum, frequencies]
+    end
+
+    def equal_temperament
+      NArray.to_na(@config.temperament_range.map { |i| @config.a * 2 ** (i / 12.0) })
+    end
+  end
+end

data/lib/music_detector/multiple_linear_regression.rb

@@ -0,0 +1,89 @@
+require 'narray'
+
+module MusicDetector
+
+  # y = X * b + err
+  class MultipleLinearRegression
+    NEGATIVE = -1
+    POSITIVE = 1
+
+    attr_accessor :b
+
+    # @param [NArray<Float>] negative_example_fvs  feature vectors of negative examples
+    # @param [NArray<Float>] positive_example_fvs  feature vectors of positive examples
+    # @return [MultipleLinearRegression]           model trained by given examples
+    # FIXME: change parameters to:
+    #  - a matrix of example fvs
+    #  - a vector of labels of the matrix
+    def self.train_by(negative_example_fvs:, positive_example_fvs:)
+      model = MultipleLinearRegression.new
+
+      negative_count = negative_example_fvs.count
+      positive_count = positive_example_fvs.count
+      raise RuntimeError('give one or more negative examples') if negative_count == 0
+      raise RuntimeError('give one or more positive examples') if positive_count == 0
+
+      fv_length = negative_example_fvs.first.total
+      negative_example_fvs.each { |fv| raise RuntimeError if fv_length != fv.total }
+      positive_example_fvs.each { |fv| raise RuntimeError if fv_length != fv.total }
+
+      # prepare matrix X and vector y
+      x = NMatrix.float(fv_length + 1, negative_count + positive_count)
+      y = NVector.float(negative_count + positive_count)
+
+      x[0, true] = NVector.int(negative_count + positive_count).fill(1)
+      negative_example_fvs.each.with_index do |fv, i|
+        x[1..fv_length, i] = fv
+        y[i] = NEGATIVE
+      end
+      positive_example_fvs.each.with_index do |fv, i|
+        x[1..fv_length, negative_count + i] = fv
+        y[negative_count + i] = POSITIVE
+      end
+
+      # estimate parameters
+      model.b = (x.transpose * x).inverse * x.transpose * y
+
+      model
+    end
+
+    def self.import_from(file_path)
+      model = MultipleLinearRegression.new
+
+      lines = File.read(file_path).each_line.to_a
+
+      # skip configurations
+      lines.shift
+
+      # vector b
+      b = lines.first.chomp.split(',').map { |e| e.to_f }
+      model.b = NVector[*b]
+
+      model
+    end
+
+    # @param [NArray]
+    def estimate(input)
+      raise RuntimeError('the form of the input is differ from trained model') if @b.total - 1 != input.shape[0]
+
+      x = NMatrix.float(input.shape[0] + 1, input.shape[1])
+      (input.shape[1]).times do |i|
+        x[0, i] = 1.0
+        x[1..(input.shape[0]), i] = input[true, i].flatten
+      end
+      x * @b
+    end
+
+    def export_to(file_path, config:)
+      File.open(file_path, 'w+') do |file|
+        file.puts(config.inspect)
+        file.puts(b.to_a.join(','))
+      end
+    end
+
+    private
+
+    def initialize
+    end
+  end
+end

data/lib/music_detector/version.rb

@@ -0,0 +1,3 @@
+module MusicDetector
+  VERSION = "0.1.0"
+end

data/lib/music_detector.rb

@@ -0,0 +1,6 @@
+module MusicDetector
+  require "music_detector/version"
+  require "music_detector/feature_vector_extractor"
+  require "music_detector/multiple_linear_regression"
+  require "music_detector/configuration"
+end

data/music_detector.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'music_detector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "music_detector"
+  spec.version       = MusicDetector::VERSION
+  spec.authors       = ["sobataro"]
+  spec.email         = ["sobatarooo@gmail.com"]
+
+  spec.summary       = %q{music detector}
+  spec.description   = %q{detects music on wave (.wav) file}
+  spec.homepage      = "https://github.com/sobataro/ruby-music-detector"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|examples)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'wavefile', '~> 0.8.1'
+  spec.add_runtime_dependency 'ruby-fftw3', '~> 1.0', '>= 1.0.2'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: music_detector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sobataro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wavefile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: ruby-fftw3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: detects music on wave (.wav) file
+email:
+- sobatarooo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/music_detector.rb
+- lib/music_detector/configuration.rb
+- lib/music_detector/feature_vector_extractor.rb
+- lib/music_detector/multiple_linear_regression.rb
+- lib/music_detector/version.rb
+- music_detector.gemspec
+homepage: https://github.com/sobataro/ruby-music-detector
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: music detector
+test_files: []