midi_lyrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d996919ed3cfcda1dcfda3adc2280ceb1681a5b1
+  data.tar.gz: 3fe6246949062d40b66c03df9c68d279da5ded7e
+SHA512:
+  metadata.gz: 5aec8699ca8f49b4ed1637e5a329b79f4c7941028fa4058af5572425a3b8e85d62f358b20e1c8a0e14cb850575dd54eb0a53095ba1ec2671af3445c640beb715
+  data.tar.gz: 415d7b89ecfe943be95089f60c3f28c8a5bb2f840aa911f81bc322cfc3844a29748e04599a8e426634d7b03fa039ee07b36f9e246bf815dea2e056d9dbd85dd8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--profile
+--tty

data/.ruby-gemset

@@ -0,0 +1 @@
+midi_lyrics

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in midi_lyrics.gemspec
+gemspec
+
+group :test do
+  gem 'simplecov', :require => false
+  gem 'coveralls', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mateus Del Bianco
+
+MIT License
+
+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,31 @@
+# MidiLyrics
+
+[![Build Status](https://travis-ci.org/mateusdelbianco/midi_lyrics.png)](https://travis-ci.org/mateusdelbianco/midi_lyrics)
+[![Code Climate](https://codeclimate.com/github/mateusdelbianco/midi_lyrics.png)](https://codeclimate.com/github/mateusdelbianco/midi_lyrics)
+[![Coverage Status](https://coveralls.io/repos/mateusdelbianco/midi_lyrics/badge.png?branch=master)](https://coveralls.io/r/mateusdelbianco/midi_lyrics?branch=master)
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'midi_lyrics'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install midi_lyrics
+
+## Usage
+
+    MidiLyrics::Parser.new("test.mid").extract
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/midi_lyrics.rb

@@ -0,0 +1,113 @@
+require "midi_lyrics/version"
+require "midilib"
+
+module MidiLyrics
+  class FileNotFound < StandardError; end
+
+  class LyricSyllable
+    attr_accessor :text, :start_in_pulses, :duration_in_pulses
+    attr_writer :sequence
+
+    def initialize(fields = {})
+      self.start_in_pulses = fields[:start_in_pulses]
+      self.duration_in_pulses = fields[:duration_in_pulses]
+      self.text = fields[:text]
+      self.sequence = fields[:sequence]
+    end
+
+    def start
+      format_time(start_in_pulses)
+    end
+
+    def duration
+      format_time(duration_in_pulses)
+    end
+
+    private
+    def format_time(time)
+      @sequence.pulses_to_seconds(time.to_f).round(3)
+    end
+  end
+
+  class Parser
+    def initialize(file)
+      @file = file
+
+      unless File.exists?(@file)
+        raise MidiLyrics::FileNotFound
+      end
+    end
+
+    def read_sequence_from_file
+      @sequence = ::MIDI::Sequence.new()
+      File.open(@file, "rb") do | file |
+        @sequence.read(file)
+      end
+      @sequence
+    end
+
+    def load_tracks
+      @lyrics_track = ::MIDI::Track.new(@sequence)
+      @noteon_track = ::MIDI::Track.new(@sequence)
+      @sequence.tracks[1].each do | event |
+        if event.kind_of?(::MIDI::MetaEvent) && event.meta_type == ::MIDI::META_LYRIC
+          text = event.data.collect{|x| x.chr(Encoding::UTF_8)}.join
+          if text.gsub(" ", "") != ""
+            @lyrics_track.events << event
+          end
+        end
+        if event.kind_of?(::MIDI::NoteOn)
+          @noteon_track.events << event
+        end
+      end
+    end
+
+    def calculate_durations
+      @durations = {}
+      @noteon_track.each do |event|
+        @durations[event.time_from_start] = event.off.time_from_start - event.time_from_start
+      end
+    end
+
+    def load_lyrics
+      @lyrics = @lyrics_track.collect do |event|
+        LyricSyllable.new(
+          :sequence => @sequence,
+          :start_in_pulses => event.time_from_start,
+          :duration_in_pulses => @durations[event.time_from_start],
+          :text => event.data.collect{|x| x.chr(Encoding::UTF_8)}.join,
+        )
+      end
+    end
+
+    def remove_heading_blank_lines
+      while @lyrics.first.text.strip == ""
+        @lyrics.shift
+      end
+    end
+
+    def consolidate_carriage_returns
+      new_lyrics = []
+      @lyrics.each do |l|
+        if ["\r", "\n"].include?(l.text)
+          l.start_in_pulses = new_lyrics.last.start_in_pulses + new_lyrics.last.duration_in_pulses
+          l.duration_in_pulses = 0
+          new_lyrics << l
+        else
+          new_lyrics << l
+        end
+      end
+      @lyrics = new_lyrics
+    end
+
+    def extract
+      read_sequence_from_file
+      load_tracks
+      calculate_durations
+      load_lyrics
+      remove_heading_blank_lines
+      consolidate_carriage_returns
+      @lyrics
+    end
+  end
+end

data/lib/midi_lyrics/version.rb

@@ -0,0 +1,3 @@
+module MidiLyrics
+  VERSION = "0.0.1"
+end

data/midi_lyrics.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'midi_lyrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "midi_lyrics"
+  spec.version       = MidiLyrics::VERSION
+  spec.authors       = ["Mateus Del Bianco"]
+  spec.email         = ["mateus@delbianco.net.br"]
+  spec.description   = %q{MIDI Lyrics extractor}
+  spec.summary       = %q{Extracts lyrics with timing from MIDI files}
+  spec.homepage      = "https://github.com/mateusdelbianco/midi_lyrics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency("midilib", ["~> 2.0.0"])
+end

data/spec/midi_lyrics_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe MidiLyrics do
+  QUARTER_NOTE_DURATION = 0.417
+  HALF_NOTE_DURATION = 0.875
+
+  it "returns an array" do
+    expect(MidiLyrics::Parser.new("spec/fixtures/one_note_one_syllable.mid").extract).to be_kind_of(Array)
+  end
+
+  context "parsing" do
+    it "parses one_note_one_syllable.mid correctly" do
+      lyrics = MidiLyrics::Parser.new("spec/fixtures/one_note_one_syllable.mid").extract
+      lyrics = lyrics.collect{|x| { text: x.text, start: x.start, duration: x.duration } }
+      expect(lyrics).to eq([
+        { :text => "Test ", :start => 0.0, :duration => QUARTER_NOTE_DURATION },
+        { :text => "\r", :start => QUARTER_NOTE_DURATION, :duration => 0.0 },
+        { :text => "\n", :start => QUARTER_NOTE_DURATION, :duration => 0.0 }
+      ])
+    end
+
+    it "parses two_notes_one_syllable.mid correctly" do
+      lyrics = MidiLyrics::Parser.new("spec/fixtures/two_notes_one_syllable.mid").extract
+      lyrics = lyrics.collect{|x| { text: x.text, start: x.start, duration: x.duration } }
+      expect(lyrics).to eq([
+        { text: "Test ", start: 0, duration: 0.5 + QUARTER_NOTE_DURATION },
+        { text: "\r", start: 0.5 + QUARTER_NOTE_DURATION, duration: 0 },
+        { text: "\n", start: 0.5 + QUARTER_NOTE_DURATION, duration: 0 }
+      ])
+    end
+
+    it "parses two_notes_two_syllables.mid correctly" do
+      lyrics = MidiLyrics::Parser.new("spec/fixtures/two_notes_two_syllables.mid").extract
+      lyrics = lyrics.collect{|x| { text: x.text, start: x.start, duration: x.duration } }
+      expect(lyrics).to eq([
+        { text: "Test", start: 0, duration: QUARTER_NOTE_DURATION },
+        { text: "ing ", start: 0.5, duration: QUARTER_NOTE_DURATION },
+        { text: "\r", start: 0.5 + QUARTER_NOTE_DURATION, duration: 0 },
+        { text: "\n", start: 0.5 + QUARTER_NOTE_DURATION, duration: 0 }
+      ])
+    end
+
+    it "parses spaces_and_returns.mid correctly" do
+      lyrics = MidiLyrics::Parser.new("spec/fixtures/spaces_and_returns.mid").extract
+      lyrics = lyrics.collect{|x| { text: x.text, start: x.start, duration: x.duration } }
+      expect(lyrics).to eq([
+        { text: "Test", start: 0.5, duration: QUARTER_NOTE_DURATION },
+        { text: "ing ", start: 1, duration: QUARTER_NOTE_DURATION },
+        { text: "\r", start: 1 + QUARTER_NOTE_DURATION, duration: 0 },
+        { text: "One", start: 1.5, duration: HALF_NOTE_DURATION },
+        { text: "Two", start: 2.5, duration: HALF_NOTE_DURATION },
+        { text: "Three ", start: 3.5, duration: HALF_NOTE_DURATION },
+        { text: "\r", start: 3.5 + HALF_NOTE_DURATION, duration: 0 },
+        { text: "\n", start: 3.5 + HALF_NOTE_DURATION, duration: 0 }
+      ])
+    end
+  end
+
+  context "error handling" do
+    it "raises MidiLyrics::FileNotFound if file does not exist" do
+      expect { MidiLyrics::Parser.new("test.mid").extract }.to raise_error(MidiLyrics::FileNotFound)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "simplecov"
+require "coveralls"
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    Coveralls::SimpleCov::Formatter.new.format(result)
+  end
+end
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+SimpleCov.start do
+  add_filter "spec"
+end
+
+require "midi_lyrics"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: midi_lyrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mateus Del Bianco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: midilib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: MIDI Lyrics extractor
+email:
+- mateus@delbianco.net.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/midi_lyrics.rb
+- lib/midi_lyrics/version.rb
+- midi_lyrics.gemspec
+- spec/fixtures/complete_example.mid
+- spec/fixtures/complete_example.nwc
+- spec/fixtures/one_note_one_syllable.mid
+- spec/fixtures/one_note_one_syllable.nwc
+- spec/fixtures/repeating_lyrics.mid
+- spec/fixtures/repeating_lyrics.nwc
+- spec/fixtures/spaces_and_returns.mid
+- spec/fixtures/spaces_and_returns.nwc
+- spec/fixtures/two_notes_one_syllable.mid
+- spec/fixtures/two_notes_one_syllable.nwc
+- spec/fixtures/two_notes_two_syllables.mid
+- spec/fixtures/two_notes_two_syllables.nwc
+- spec/midi_lyrics_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mateusdelbianco/midi_lyrics
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Extracts lyrics with timing from MIDI files
+test_files:
+- spec/fixtures/complete_example.mid
+- spec/fixtures/complete_example.nwc
+- spec/fixtures/one_note_one_syllable.mid
+- spec/fixtures/one_note_one_syllable.nwc
+- spec/fixtures/repeating_lyrics.mid
+- spec/fixtures/repeating_lyrics.nwc
+- spec/fixtures/spaces_and_returns.mid
+- spec/fixtures/spaces_and_returns.nwc
+- spec/fixtures/two_notes_one_syllable.mid
+- spec/fixtures/two_notes_one_syllable.nwc
+- spec/fixtures/two_notes_two_syllables.mid
+- spec/fixtures/two_notes_two_syllables.nwc
+- spec/midi_lyrics_spec.rb
+- spec/spec_helper.rb