midi_lyrics 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c9b84cff07242cecae62df47efb69be45145f9e
-  data.tar.gz: d7338244525a74d8b421a4f7c0ffe12870abb597
+  metadata.gz: f698931d0fee61f9ab69c4139d59528ae8c7f2a0
+  data.tar.gz: ac95cb42cff2ee743b5d5b0de43fa14b5c2bece8
 SHA512:
-  metadata.gz: cdc89a38e654ff98188a167736b4ce91fb9dfa911589bbcaf81f4e34a956a0f6ee148cd1aba5bc828ab3a6c3785fd37b3428761be631ddee5ac661b4dd53cc5d
-  data.tar.gz: f05d68e09fff457e6d1fae7759a17ec26f743a52cfdd6c948f5e2aa2ab978bd14cf8cf9dbfd40d670def40ea2f117ba70063a2b41412a3e6d61100b3f33f560a
+  metadata.gz: 736dc598ca49e75a2abf1816c652b4d6795cab42e5a2d7cf7913e49398e9f9cf57e10b1732447244aa61638b1503c0afa0f243dd2131a53d46deb88fe87e67f6
+  data.tar.gz: 51cd277418c0dff15160daad3ba2b56a1c0e3111695c215baeccd93cb6d3fc9d38fd0b1b9705f74c59e3f2269350d6f06b25cfbda44474aac11c192f1f5e730b

data/lib/midi_lyrics.rb

@@ -4,28 +4,50 @@ require "midilib"
 module MidiLyrics
   class FileNotFound < StandardError; end
 
-  class LyricSyllable
-    attr_accessor :text, :start_in_pulses, :start2_in_pulses, :duration_in_pulses
-    attr_writer :sequence
+  class Tempo
+    attr_accessor :start, :duration, :tempo
 
     def initialize(fields = {})
-      self.start_in_pulses = fields[:start_in_pulses]
-      self.start2_in_pulses = fields[:start2_in_pulses]
-      self.duration_in_pulses = fields[:duration_in_pulses]
-      self.text = fields[:text]
-      self.sequence = fields[:sequence]
+      self.start = fields[:start].to_f
+      self.tempo = fields[:tempo].to_f
     end
+  end
 
-    def start
-      format_time(start_in_pulses)
+  class TempoCalculator
+    attr_accessor :tempo_track
+    attr_accessor :sequence
+
+    def initialize(fields = {})
+      self.tempo_track = fields[:tempo_track]
+      self.sequence = fields[:sequence]
     end
 
-    def start2
-      format_time(start2_in_pulses)
+    def calculate(pulses)
+      pulses = pulses.to_f
+      value = 0.0
+      last_tempo = @tempo_track.first
+      @tempo_track.each do |t|
+        if t.start < pulses
+          value += (((t.start - last_tempo.start) / sequence.ppqn.to_f / ::MIDI::Tempo.mpq_to_bpm(last_tempo.tempo)) * 60.0)
+          last_tempo = t
+        end
+      end
+      if last_tempo.start < pulses
+        value += (((pulses - last_tempo.start) / sequence.ppqn.to_f / ::MIDI::Tempo.mpq_to_bpm(last_tempo.tempo)) * 60.0)
+      end
+      value
     end
+  end
 
-    def duration
-      format_time(duration_in_pulses)
+  class LyricSyllable
+    attr_accessor :text, :start_in_pulses, :start2_in_pulses, :duration_in_pulses
+    attr_accessor :start, :start2, :duration
+
+    def initialize(fields = {})
+      self.start_in_pulses = fields[:start_in_pulses]
+      self.start2_in_pulses = fields[:start2_in_pulses]
+      self.duration_in_pulses = fields[:duration_in_pulses]
+      self.text = fields[:text]
     end
 
     def end_in_pulses
@@ -48,11 +70,6 @@ module MidiLyrics
         duration: duration
       }
     end
-
-    private
-    def format_time(time)
-      @sequence.pulses_to_seconds(time.to_f).round(3)
-    end
   end
 
   class Parser
@@ -70,6 +87,7 @@ module MidiLyrics
 
     def extract
       read_sequence_from_file
+      load_tempo_track
       load_tracks
       calculate_durations
       load_lyrics
@@ -78,22 +96,41 @@ module MidiLyrics
       remove_lines_trailing_spaces
       fix_durations
       remove_repeating unless repeating
+      calculate_seconds
       @lyrics.collect(&:as_json)
     end
 
     private
     def read_sequence_from_file
       @sequence = ::MIDI::Sequence.new()
-      File.open(file, "rb") do | file |
+      File.open(file, "rb") do |file|
         @sequence.read(file)
       end
       @sequence
     end
 
+    def load_tempo_track
+      @tempo_track = []
+
+      @sequence.tracks[0].each do |event|
+        if event.kind_of?(::MIDI::Tempo)
+          @tempo_track << Tempo.new(
+            start: event.time_from_start,
+            tempo: event.data
+          )
+        end
+      end
+
+      if @tempo_track.size == 0
+        @tempo_track << Tempo.new(start: 0, tempo: ::MIDI::Tempo.bpm_to_mpq(120))
+      end
+    end
+
     def load_tracks
       @lyrics_track = ::MIDI::Track.new(@sequence)
       @noteon_track = ::MIDI::Track.new(@sequence)
-      @sequence.tracks[1].each do | event |
+
+      @sequence.tracks[1].each do |event|
         if event.kind_of?(::MIDI::MetaEvent) && event.meta_type == ::MIDI::META_LYRIC
           @lyrics_track.events << event
         end
@@ -125,7 +162,6 @@ module MidiLyrics
         [heading_space, letters, trailing_space].each do |text|
           unless text.nil?
             @lyrics << LyricSyllable.new(
-              sequence: @sequence,
               start_in_pulses: event.time_from_start,
               duration_in_pulses: @durations[event.time_from_start],
               text: text
@@ -199,5 +235,15 @@ module MidiLyrics
         end
       end
     end
+
+    def calculate_seconds
+      tempo_calculator = TempoCalculator.new(tempo_track: @tempo_track, sequence: @sequence)
+
+      @lyrics.each do |l|
+        l.start = tempo_calculator.calculate(l.start_in_pulses).round(3)
+        l.start2 = tempo_calculator.calculate(l.start2_in_pulses).round(3)
+        l.duration = (tempo_calculator.calculate(l.start_in_pulses + l.duration_in_pulses) - l.start).round(3)
+      end
+    end
   end
 end

data/lib/midi_lyrics/version.rb

@@ -1,3 +1,3 @@
 module MidiLyrics
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/midi_lyrics.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 
-  spec.add_dependency("midilib", ["~> 2.0.0"])
+  spec.add_dependency("midilib", ["= 2.0.4"])
 end

data/spec/midi_lyrics_spec.rb

@@ -1,8 +1,11 @@
 require "spec_helper"
 
 describe MidiLyrics do
-  QUARTER_NOTE_DURATION = 0.417
+  FLOAT_PRECISION_ERROR = 0.001
   HALF_NOTE_DURATION = 0.875
+  QUARTER_NOTE_DURATION = 0.417
+  QUARTER_NOTE_DURATION_90 = 0.555
+  QUARTER_NOTE_DURATION_60 = 0.833
 
   it "returns an array" do
     expect(MidiLyrics::Parser.new("spec/fixtures/one_note_one_syllable.mid").extract).to be_kind_of(Array)
@@ -31,7 +34,7 @@ describe MidiLyrics do
       expect(
         MidiLyrics::Parser.new("spec/fixtures/two_notes_one_syllable.mid").extract
       ).to eq([
-        { text: "Test", start: 0, start2: 0.0, duration: 0.5 + QUARTER_NOTE_DURATION },
+        { text: "Test", start: 0.0, start2: 0.0, duration: 0.5 + QUARTER_NOTE_DURATION },
         { text: "\r\n", start: 0.5 + QUARTER_NOTE_DURATION, start2: 0.0, duration: 0.0 }
       ])
     end
@@ -40,7 +43,7 @@ describe MidiLyrics do
       expect(
         MidiLyrics::Parser.new("spec/fixtures/two_notes_two_syllables.mid").extract
       ).to eq([
-        { text: "Test", start: 0, start2: 0.0, duration: QUARTER_NOTE_DURATION },
+        { text: "Test", start: 0.0, start2: 0.0, duration: QUARTER_NOTE_DURATION },
         { text: "ing", start: 0.5, start2: 0.0, duration: QUARTER_NOTE_DURATION },
         { text: "\r\n", start: 0.5 + QUARTER_NOTE_DURATION, start2: 0.0, duration: 0.0 }
       ])
@@ -50,7 +53,7 @@ describe MidiLyrics do
       expect(
         MidiLyrics::Parser.new("spec/fixtures/two_notes_two_syllables_dash.mid").extract
       ).to eq([
-        { text: "Test", start: 0, start2: 0.0, duration: QUARTER_NOTE_DURATION },
+        { text: "Test", start: 0.0, start2: 0.0, duration: QUARTER_NOTE_DURATION },
         { text: "ing", start: 0.5, start2: 0.0, duration: QUARTER_NOTE_DURATION },
         { text: "\r\n", start: 0.5 + QUARTER_NOTE_DURATION, start2: 0.0, duration: 0.0 }
       ])
@@ -60,7 +63,7 @@ describe MidiLyrics do
       expect(
         MidiLyrics::Parser.new("spec/fixtures/two_notes_three_syllables.mid").extract
       ).to eq([
-        { text: "Hello, test", start: 0, start2: 0.0, duration: QUARTER_NOTE_DURATION },
+        { text: "Hello, test", start: 0.0, start2: 0.0, duration: QUARTER_NOTE_DURATION },
         { text: "ing", start: 0.5, start2: 0.0, duration: QUARTER_NOTE_DURATION },
         { text: "\r\n", start: 0.5 + QUARTER_NOTE_DURATION, start2: 0.0, duration: 0.0 }
       ])
@@ -70,7 +73,7 @@ describe MidiLyrics do
       expect(
         MidiLyrics::Parser.new("spec/fixtures/three_notes_two_syllables.mid").extract
       ).to eq([
-        { text: "Test", start: 0, start2: 0.0, duration: 0.5 + QUARTER_NOTE_DURATION },
+        { text: "Test", start: 0.0, start2: 0.0, duration: 0.5 + QUARTER_NOTE_DURATION },
         { text: "ing", start: 1, start2: 0.0, duration: QUARTER_NOTE_DURATION },
         { text: "\r\n", start: 1 + QUARTER_NOTE_DURATION, start2: 0.0, duration: 0.0 }
       ])
@@ -80,7 +83,7 @@ describe MidiLyrics do
       expect(
         MidiLyrics::Parser.new("spec/fixtures/three_notes_two_syllables_with_pause.mid").extract
       ).to eq([
-        { text: "Test", start: 0, start2: 0.0, duration: QUARTER_NOTE_DURATION },
+        { text: "Test", start: 0.0, start2: 0.0, duration: QUARTER_NOTE_DURATION },
         { text: "ing", start: 1, start2: 0.0, duration: QUARTER_NOTE_DURATION },
         { text: "\r\n", start: 1 + QUARTER_NOTE_DURATION, start2: 0.0, duration: 0.0 }
       ])
@@ -189,6 +192,40 @@ describe MidiLyrics do
         MidiLyrics::Parser.new("spec/fixtures/complete_example.mid", repeating: true).extract
       ).to eq(parsed_complete_example)
     end
+
+    it "parses 60_tempo.mid correctly" do
+      expect(
+        MidiLyrics::Parser.new("spec/fixtures/60_tempo.mid").extract
+      ).to eq([
+        { text: "Test", start: 0.0, start2: 0.0, duration: QUARTER_NOTE_DURATION_60 },
+        { text: "ing", start: 1, start2: 0.0, duration: QUARTER_NOTE_DURATION_60 },
+        { text: "\r\n", start: 1 + QUARTER_NOTE_DURATION_60, start2: 0.0, duration: 0.0 }
+      ])
+    end
+
+    it "parses 90_tempo.mid correctly" do
+      expect(
+        MidiLyrics::Parser.new("spec/fixtures/90_tempo.mid").extract
+      ).to eq([
+        { text: "Test", start: 0.0, start2: 0.0, duration: QUARTER_NOTE_DURATION_90 + FLOAT_PRECISION_ERROR },
+        { text: "ing", start: 0.667, start2: 0.0, duration: QUARTER_NOTE_DURATION_90 },
+        { text: "\r\n", start: 1.222, start2: 0.0, duration: 0.0 }
+      ])
+    end
+
+    it "parses changing_tempo.mid correctly" do
+      expect(
+        MidiLyrics::Parser.new("spec/fixtures/changing_tempo.mid").extract
+      ).to eq([
+        { text: "Test", start: 0.0, start2: 0.0, duration: QUARTER_NOTE_DURATION },
+        { text: "ing", start: 0.5, start2: 0.0, duration: QUARTER_NOTE_DURATION },
+        { text: " ", start: 0.5 + QUARTER_NOTE_DURATION, start2: 0.0, duration: 0.0 },
+        { text: "One", start: 1.0, start2: 0.0, duration: QUARTER_NOTE_DURATION_60 },
+        { text: " ", start: 1.0 + QUARTER_NOTE_DURATION_60, start2: 0.0, duration: 0.0 },
+        { text: "Two", start: 2.0, start2: 0.0, duration: QUARTER_NOTE_DURATION_60 },
+        { text: "\r\n", start: 2.0 + QUARTER_NOTE_DURATION_60, start2: 0.0, duration: 0.0 }
+      ])
+    end
   end
 
   context "error handling" do
@@ -196,4 +233,23 @@ describe MidiLyrics do
       expect { MidiLyrics::Parser.new("test.mid").extract }.to raise_error(MidiLyrics::FileNotFound)
     end
   end
+
+  describe MidiLyrics::TempoCalculator do
+    it "calculates simple tempo" do
+      tempo_calculator = MidiLyrics::TempoCalculator.new(
+        tempo_track: [
+          MidiLyrics::Tempo.new(start: 0, tempo: ::MIDI::Tempo.bpm_to_mpq(1)),
+          MidiLyrics::Tempo.new(start: 10, tempo: ::MIDI::Tempo.bpm_to_mpq(2)),
+          MidiLyrics::Tempo.new(start: 20, tempo: ::MIDI::Tempo.bpm_to_mpq(1))
+        ],
+        sequence: double(ppqn: 1)
+      )
+      tempo_calculator.calculate(0).should == 0
+      tempo_calculator.calculate(1).should == 60.0
+      tempo_calculator.calculate(10).should == 600.0
+      tempo_calculator.calculate(11).should == 630.0
+      tempo_calculator.calculate(20).should == 900.0
+      tempo_calculator.calculate(21).should == 960.0
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: midi_lyrics
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Mateus Del Bianco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: midilib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.4
 description: MIDI Lyrics extractor
 email:
 - mateus@delbianco.net.br
@@ -85,6 +85,12 @@ files:
 - lib/midi_lyrics.rb
 - lib/midi_lyrics/version.rb
 - midi_lyrics.gemspec
+- spec/fixtures/60_tempo.mid
+- spec/fixtures/60_tempo.nwc
+- spec/fixtures/90_tempo.mid
+- spec/fixtures/90_tempo.nwc
+- spec/fixtures/changing_tempo.mid
+- spec/fixtures/changing_tempo.nwc
 - spec/fixtures/complete_example.mid
 - spec/fixtures/complete_example.nwc
 - spec/fixtures/one_note_one_syllable.mid
@@ -131,11 +137,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Extracts lyrics with timing from MIDI files
 test_files:
+- spec/fixtures/60_tempo.mid
+- spec/fixtures/60_tempo.nwc
+- spec/fixtures/90_tempo.mid
+- spec/fixtures/90_tempo.nwc
+- spec/fixtures/changing_tempo.mid
+- spec/fixtures/changing_tempo.nwc
 - spec/fixtures/complete_example.mid
 - spec/fixtures/complete_example.nwc
 - spec/fixtures/one_note_one_syllable.mid