aubio 0.2.2 → 0.3.4

data/lib/aubio/beats.rb

@@ -1,75 +1,78 @@
-module Aubio
-	class Beats
+# frozen_string_literal: true
 
-		def initialize(aubio_source, params)
+module Aubio
+  class Beats
+    def initialize(aubio_source, params)
       # TODO: cleanup param dups
-			@sample_rate = params[:sample_rate] || 44100
-			@window_size = params[:window_size] || 1024
-			@hop_size    = params[:hop_size]    || 512
+      @sample_rate = params[:sample_rate] || 44_100
+      @window_size = params[:window_size] || 1024
+      @hop_size    = params[:hop_size]    || 512
 
-			@source = aubio_source
-			@tempo = Api.new_aubio_tempo('specdiff', @window_size, @hop_size, @sample_rate)
+      @source = aubio_source
+      @tempo = Api.new_aubio_tempo('specdiff', @window_size, @hop_size, @sample_rate)
 
-			# create output for source
-			@sample_buffer = Api.new_fvec(@hop_size)
-			# create output for beat
-			@out_fvec = Api.new_fvec(1)
-		end
+      # create output for source
+      @sample_buffer = Api.new_fvec(@hop_size)
+      # create output for beat
+      @out_fvec = Api.new_fvec(1)
+    end
 
-		def each
-			return enum_for(:each) unless block_given?
+    def each
+      return enum_for(:each) unless block_given?
 
-			total_frames_counter = 0
-			read_buffer = FFI::MemoryPointer.new(:int)
+      total_frames_counter = 0
+      read_buffer = FFI::MemoryPointer.new(:int)
+      total_samples = Api.aubio_source_get_duration(@source).to_f
 
-			loop do
-				# Perform tempo calculation
+      loop do
+        # Perform tempo calculation
         Api.aubio_source_do(@source, @sample_buffer, read_buffer)
-				Api.aubio_tempo_do(@tempo, @sample_buffer, @out_fvec)
+        Api.aubio_tempo_do(@tempo, @sample_buffer, @out_fvec)
 
         # Retrieve result
-				is_beat = Api.fvec_get_sample(@out_fvec, 0)
+        is_beat = Api.fvec_get_sample(@out_fvec, 0)
         no_of_bytes_read = read_buffer.read_int
         total_frames_counter += no_of_bytes_read
 
         if is_beat > 0.0
-					tempo_seconds = Api.aubio_tempo_get_last_s(@tempo)
-					tempo_milliseconds = Api.aubio_tempo_get_last_ms(@tempo)
+          tempo_samples = Api.aubio_tempo_get_last(@tempo)
+          tempo_seconds = Api.aubio_tempo_get_last_s(@tempo)
+          tempo_milliseconds = Api.aubio_tempo_get_last_ms(@tempo)
           tempo_confidence = Api.aubio_tempo_get_confidence(@tempo)
 
-					output = {
-            :confidence => tempo_confidence,
-            :s => tempo_seconds,
-            :ms => tempo_milliseconds,
-            :start => (tempo_seconds == 0.0 ? 1 : 0),
-            :end => 0
-					}
-          yield output
-				end
-
-        if no_of_bytes_read != @hop_size
-          # there's no more audio to look at
-
-          # Let's output one last tempo to mark the end of the file
-          total_time = total_frames_counter.to_f / @sample_rate.to_f
           output = {
-            :confidence => 1.0,
-            :s => total_time,
-            :ms => total_time/1000.0,
-            :start => 0,
-            :end  => 1
+            confidence: tempo_confidence,
+            s: tempo_seconds,
+            ms: tempo_milliseconds,
+            sample_no: tempo_samples,
+            total_samples: total_samples,
+            rel_start: tempo_samples / total_samples
           }
           yield output
+        end
 
-          # clean up
-          Api.del_aubio_tempo(@tempo)
-          Api.del_fvec(@sample_buffer)
-          Api.del_fvec(@out_fvec)
+        next unless no_of_bytes_read != @hop_size
 
-          break
-        end
-			end
-		end
+        # there's no more audio to look at
+
+        # Let's output one last tempo to mark the end of the file
+        total_time = total_frames_counter.to_f / @sample_rate.to_f
+        output = {
+          confidence: 1.0,
+          s: total_time,
+          ms: total_time / 1000.0,
+          sample_no: total_samples,
+          total_samples: total_samples
+        }
+        yield output
+
+        # clean up
+        Api.del_aubio_tempo(@tempo)
+        Api.del_fvec(@sample_buffer)
+        Api.del_fvec(@out_fvec)
 
-	end
+        break
+      end
+    end
+  end
 end

data/lib/aubio/{api.rb → legacy_api.rb}

@@ -1,72 +1,74 @@
+# frozen_string_literal: true
+
 require 'ffi'
 
 module Aubio
-  module Api #:nodoc
+  module LegacyApi #:nodoc
     extend FFI::Library
     # idea inspired by https://github.com/qoobaa/magic/blob/master/lib/magic/api.rb
-    lib_paths = Array(ENV["AUBIO_LIB"] || Dir["/{opt,usr}/{,local/}{lib,lib64,Cellar/aubio**}/libaubio.{*.dylib,so.*}"])
-    fallback_names = %w(libaubio.4.2.2.dylib libaubio.so.1 aubio1.dll)
+    lib_paths = Array(ENV['AUBIO_LIB'] || Dir['/{opt,usr}/{,local/}{lib,lib64,Cellar/aubio**,lib/arm-linux-gnueabihf}/libaubio.{*.dylib,so.*}'])
+    fallback_names = %w[libaubio.4.2.2.dylib libaubio.so.1 aubio1.dll]
     ffi_lib(lib_paths + fallback_names)
 
     # tempo
-    attach_function :new_aubio_tempo, [ :string, :int, :int, :int ], :pointer
-    attach_function :aubio_tempo_do, [:pointer, :pointer, :pointer], :void
+    attach_function :new_aubio_tempo, %i[string int int int], :pointer
+    attach_function :aubio_tempo_do, %i[pointer pointer pointer], :void
     attach_function :aubio_tempo_get_last, [:pointer], :int
     attach_function :aubio_tempo_get_last_s, [:pointer], :float
     attach_function :aubio_tempo_get_last_ms, [:pointer], :float
-    attach_function :aubio_tempo_set_silence, [:pointer, :float], :int
+    attach_function :aubio_tempo_set_silence, %i[pointer float], :int
     attach_function :aubio_tempo_get_silence, [:pointer], :float
-    attach_function :aubio_tempo_set_threshold, [:pointer, :float], :int
+    attach_function :aubio_tempo_set_threshold, %i[pointer float], :int
     attach_function :aubio_tempo_get_threshold, [:pointer], :float
     attach_function :aubio_tempo_get_bpm, [:pointer], :float
     attach_function :aubio_tempo_get_confidence, [:pointer], :float
     attach_function :del_aubio_tempo, [:pointer], :void
 
     # beattracking / misc
-    attach_function :new_aubio_beattracking, [:int, :int, :int], :pointer
-    attach_function :aubio_beattracking_do, [:pointer, :pointer, :pointer], :void
+    attach_function :new_aubio_beattracking, %i[int int int], :pointer
+    attach_function :aubio_beattracking_do, %i[pointer pointer pointer], :void
     attach_function :aubio_beattracking_get_bpm, [:pointer], :float
-    attach_function :aubio_filter_do, [:pointer, :pointer], :void
+    attach_function :aubio_filter_do, %i[pointer pointer], :void
     attach_function :new_aubio_filter_a_weighting, [:int], :pointer
 
     # source
-    attach_function :new_aubio_source, [:string, :int, :int], :pointer
-    attach_function :aubio_source_do, [:pointer, :pointer, :pointer], :void
-    attach_function :aubio_source_do_multi, [:pointer, :pointer, :pointer], :void
+    attach_function :new_aubio_source, %i[string int int], :pointer
+    attach_function :aubio_source_do, %i[pointer pointer pointer], :void
+    attach_function :aubio_source_do_multi, %i[pointer pointer pointer], :void
     attach_function :aubio_source_get_samplerate, [:pointer], :int
     attach_function :aubio_source_get_channels, [:pointer], :int
-    attach_function :aubio_source_seek, [:pointer, :int], :int
+    attach_function :aubio_source_seek, %i[pointer int], :int
     attach_function :aubio_source_close, [:pointer], :int
     attach_function :del_aubio_source, [:pointer], :void
 
     # sink
-    attach_function :new_aubio_sink, [:string, :int], :pointer
-    attach_function :aubio_sink_preset_samplerate, [:pointer, :int], :void
-    attach_function :aubio_sink_preset_channels, [:pointer, :int], :void
+    attach_function :new_aubio_sink, %i[string int], :pointer
+    attach_function :aubio_sink_preset_samplerate, %i[pointer int], :void
+    attach_function :aubio_sink_preset_channels, %i[pointer int], :void
     attach_function :aubio_sink_get_samplerate, [:pointer], :int
     attach_function :aubio_sink_get_channels, [:pointer], :int
-    attach_function :aubio_sink_do, [:pointer, :pointer, :int], :void
-    attach_function :aubio_sink_do_multi, [:pointer, :pointer, :int], :void
+    attach_function :aubio_sink_do, %i[pointer pointer int], :void
+    attach_function :aubio_sink_do_multi, %i[pointer pointer int], :void
     attach_function :aubio_sink_close, [:pointer], :int
     attach_function :del_aubio_sink, [:pointer], :void
 
     # onset
-    attach_function :new_aubio_onset, [:string, :int, :int, :int], :pointer
-    attach_function :aubio_onset_do, [:pointer, :pointer, :pointer], :void
+    attach_function :new_aubio_onset, %i[string int int int], :pointer
+    attach_function :aubio_onset_do, %i[pointer pointer pointer], :void
     attach_function :aubio_onset_get_last, [:pointer], :int
     attach_function :aubio_onset_get_last_s, [:pointer], :float
     attach_function :aubio_onset_get_last_ms, [:pointer], :float
-    attach_function :aubio_onset_set_silence, [:pointer, :float], :int
+    attach_function :aubio_onset_set_silence, %i[pointer float], :int
     attach_function :aubio_onset_get_silence, [:pointer], :float
     attach_function :aubio_onset_get_descriptor, [:pointer], :float
     attach_function :aubio_onset_get_thresholded_descriptor, [:pointer], :float
-    attach_function :aubio_onset_set_threshold, [:pointer, :float], :int
-    attach_function :aubio_onset_set_minioi, [:pointer, :int], :int
-    attach_function :aubio_onset_set_minioi_s, [:pointer, :int], :int
-    attach_function :aubio_onset_set_minioi_ms, [:pointer, :float], :int
-    attach_function :aubio_onset_set_delay, [:pointer, :int], :int
-    attach_function :aubio_onset_set_delay_s, [:pointer, :int], :int
-    attach_function :aubio_onset_set_delay_ms, [:pointer, :float], :int
+    attach_function :aubio_onset_set_threshold, %i[pointer float], :int
+    attach_function :aubio_onset_set_minioi, %i[pointer int], :int
+    attach_function :aubio_onset_set_minioi_s, %i[pointer int], :int
+    attach_function :aubio_onset_set_minioi_ms, %i[pointer float], :int
+    attach_function :aubio_onset_set_delay, %i[pointer int], :int
+    attach_function :aubio_onset_set_delay_s, %i[pointer int], :int
+    attach_function :aubio_onset_set_delay_ms, %i[pointer float], :int
     attach_function :aubio_onset_get_minioi, [:pointer], :int
     attach_function :aubio_onset_get_minioi_s, [:pointer], :float
     attach_function :aubio_onset_get_minioi_ms, [:pointer], :float
@@ -77,11 +79,11 @@ module Aubio
     attach_function :del_aubio_onset, [:pointer], :void
 
     # pitch
-    attach_function :new_aubio_pitch, [:string, :int, :int, :int], :pointer
-    attach_function :aubio_pitch_do, [:pointer, :pointer, :pointer], :void
-    attach_function :aubio_pitch_set_tolerance, [:pointer, :int], :int
-    attach_function :aubio_pitch_set_unit, [:pointer, :string], :int
-    attach_function :aubio_pitch_set_silence, [:pointer, :float], :int
+    attach_function :new_aubio_pitch, %i[string int int int], :pointer
+    attach_function :aubio_pitch_do, %i[pointer pointer pointer], :void
+    attach_function :aubio_pitch_set_tolerance, %i[pointer int], :int
+    attach_function :aubio_pitch_set_unit, %i[pointer string], :int
+    attach_function :aubio_pitch_set_silence, %i[pointer float], :int
     attach_function :aubio_pitch_get_silence, [:pointer], :float
     attach_function :aubio_pitch_get_confidence, [:pointer], :float
     attach_function :del_aubio_pitch, [:pointer], :void
@@ -89,16 +91,15 @@ module Aubio
     # new fvec
     attach_function :new_fvec, [:int], :pointer
     attach_function :del_fvec, [:pointer], :void
-    attach_function :fvec_get_sample, [:pointer, :int], :float
-    attach_function :fvec_set_sample, [:pointer, :float, :int], :void
+    attach_function :fvec_get_sample, %i[pointer int], :float
+    attach_function :fvec_set_sample, %i[pointer float int], :void
     attach_function :fvec_get_data, [:pointer], :float
     attach_function :fvec_print, [:pointer], :void
-    attach_function :fvec_set_all, [:pointer, :float], :void
+    attach_function :fvec_set_all, %i[pointer float], :void
     attach_function :fvec_zeros, [:pointer], :void
     attach_function :fvec_rev, [:pointer], :void
-    attach_function :fvec_weight, [:pointer, :pointer], :void
-    attach_function :fvec_copy, [:pointer, :pointer], :void
+    attach_function :fvec_weight, %i[pointer pointer], :void
+    attach_function :fvec_copy, %i[pointer pointer], :void
     attach_function :fvec_ones, [:pointer], :void
-
   end
 end

data/lib/aubio/onsets.rb

@@ -1,73 +1,73 @@
-module Aubio
-	class Onsets
+# frozen_string_literal: true
 
-		def initialize(aubio_source, params)
+module Aubio
+  class Onsets
+    def initialize(aubio_source, params)
       # TODO: cleanup param dups
-			@sample_rate = params[:sample_rate] || 44100
-			@window_size = params[:window_size] || 1024
-			@hop_size    = params[:hop_size]    || 512
+      @sample_rate = params[:sample_rate] || 44_100
+      @window_size = params[:window_size] || 1024
+      @hop_size    = params[:hop_size]    || 512
 
-			@source = aubio_source
-			@onset = Api.new_aubio_onset('default', @window_size, @hop_size, @sample_rate)
-			Api.aubio_onset_set_minioi_ms(@onset, 12.0)
-			Api.aubio_onset_set_threshold(@onset, 0.3)
+      @source = aubio_source
+      @onset = Api.new_aubio_onset('default', @window_size, @hop_size, @sample_rate)
+      Api.aubio_onset_set_minioi_ms(@onset, 12.0)
+      Api.aubio_onset_set_threshold(@onset, 0.3)
 
-			# create output for source
-			@sample_buffer = Api.new_fvec(@hop_size)
-			# create output for pitch and beat
-			@out_fvec = Api.new_fvec(1)
-		end
+      # create output for source
+      @sample_buffer = Api.new_fvec(@hop_size)
+      # create output for pitch and beat
+      @out_fvec = Api.new_fvec(1)
+    end
 
-		def each
-			return enum_for(:each) unless block_given?
+    def each
+      return enum_for(:each) unless block_given?
 
-			total_frames_counter = 0
-			read_buffer = FFI::MemoryPointer.new(:int)
+      total_frames_counter = 0
+      read_buffer = FFI::MemoryPointer.new(:int)
 
-			loop do
-				# Perform onset calculation
+      loop do
+        # Perform onset calculation
         Api.aubio_source_do(@source, @sample_buffer, read_buffer)
-				Api.aubio_onset_do(@onset, @sample_buffer, @out_fvec)
+        Api.aubio_onset_do(@onset, @sample_buffer, @out_fvec)
 
         # Retrieve result
-				onset_new_peak = Api.fvec_get_sample(@out_fvec, 0)
+        onset_new_peak = Api.fvec_get_sample(@out_fvec, 0)
         no_of_bytes_read = read_buffer.read_int
         total_frames_counter += no_of_bytes_read
 
         if onset_new_peak > 0.0
-					onset_seconds = Api.aubio_onset_get_last_s(@onset)
-					onset_milliseconds = Api.aubio_onset_get_last_ms(@onset)
-					output = {
-            :s => onset_seconds,
-            :ms => onset_milliseconds,
-            :start => (onset_seconds == 0.0 ? 1 : 0),
-            :end => 0
-					}
-          yield output
-				end
-
-        if no_of_bytes_read != @hop_size
-          # there's no more audio to look at
-
-          # Let's output one last onset to mark the end of the file
-          total_time = total_frames_counter.to_f / @sample_rate.to_f
+          onset_seconds = Api.aubio_onset_get_last_s(@onset)
+          onset_milliseconds = Api.aubio_onset_get_last_ms(@onset)
           output = {
-            :s => total_time,
-            :ms => total_time/1000.0,
-            :start => 0,
-            :end  => 1
+            s: onset_seconds,
+            ms: onset_milliseconds,
+            start: (onset_seconds == 0.0 ? 1 : 0),
+            end: 0
           }
           yield output
+        end
 
-          # clean up
-          Api.del_aubio_onset(@onset)
-          Api.del_fvec(@sample_buffer)
-          Api.del_fvec(@out_fvec)
+        next unless no_of_bytes_read != @hop_size
 
-          break
-        end
-			end
-		end
+        # there's no more audio to look at
+
+        # Let's output one last onset to mark the end of the file
+        total_time = total_frames_counter.to_f / @sample_rate.to_f
+        output = {
+          s: total_time,
+          ms: total_time / 1000.0,
+          start: 0,
+          end: 1
+        }
+        yield output
+
+        # clean up
+        Api.del_aubio_onset(@onset)
+        Api.del_fvec(@sample_buffer)
+        Api.del_fvec(@out_fvec)
 
-	end
+        break
+      end
+    end
+  end
 end

data/lib/aubio/pitches.rb

@@ -1,34 +1,43 @@
-module Aubio
-	class Pitches
+# frozen_string_literal: true
 
-		def initialize(aubio_source, params)
+module Aubio
+  class Pitches
+    def initialize(aubio_source, params)
       # TODO: cleanup param dups
-			@sample_rate = params[:sample_rate] || 44100
-			@window_size = params[:window_size] || 1024
-			@hop_size    = params[:hop_size]    || 512
-
-			@source = aubio_source
-			@pitch = Api.new_aubio_pitch('yin', @window_size, @hop_size, @sample_rate)
-			Api.aubio_pitch_set_unit(@pitch, 'midi')
-			Api.aubio_pitch_set_tolerance(@pitch, 0.8)
-
-			# create output for source
-			@sample_buffer = Api.new_fvec(@hop_size)
-			# create output for pitch and beat
-			@out_fvec = Api.new_fvec(1)
-		end
-
-		def each
-			return enum_for(:each) unless block_given?
-
-			total_frames_counter = 0
-			read_buffer = FFI::MemoryPointer.new(:int)
+      @sample_rate = params[:sample_rate] || 44_100
+      @window_size = params[:window_size] || 1024
+      @hop_size    = params[:hop_size]    || 512
+
+      # Set the tolerance for the pitch detection algorithm.
+      # Typical values range between 0.2 and 0.9.
+      # Pitch candidates found with a confidence less than this threshold will not be selected.
+      # The higher the threshold, the more confidence in the candidates.
+      @confidence_thresh = params[:confidence_thresh] || 0.9
+
+      @pitch_method = params[:pitch_method] || 'yinfast'
+
+      @source = aubio_source
+      @pitch = Api.new_aubio_pitch(@pitch_method, @window_size, @hop_size, @sample_rate)
+      Api.aubio_pitch_set_unit(@pitch, 'midi')
+      Api.aubio_pitch_set_tolerance(@pitch, @confidence_thresh)
+
+      # create output for source
+      @sample_buffer = Api.new_fvec(@hop_size)
+      # create output for pitch and beat
+      @out_fvec = Api.new_fvec(1)
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      total_frames_counter = 0
+      read_buffer = FFI::MemoryPointer.new(:int)
       last_pitch = 0
 
-			loop do
-				# Perform pitch calculation
+      loop do
+        # Perform pitch calculation
         Api.aubio_source_do(@source, @sample_buffer, read_buffer)
-				Api.aubio_pitch_do(@pitch, @sample_buffer, @out_fvec)
+        Api.aubio_pitch_do(@pitch, @sample_buffer, @out_fvec)
 
         # Retrieve result
         pitch = Api.fvec_get_sample(@out_fvec, 0)
@@ -36,40 +45,39 @@ module Aubio
         no_of_bytes_read = read_buffer.read_int
         total_frames_counter += no_of_bytes_read
 
-        if (last_pitch - pitch).abs >= 1 and confidence > 0.9
-					output = {
-            :pitch => pitch,
-            :confidence => confidence,
-            :start => (total_frames_counter == 0 ? 1 : 0),
-            :end => 0
-					}
+        if ((last_pitch - pitch).abs >= 1) && (confidence > @confidence_thresh)
+          output = {
+            pitch: pitch,
+            confidence: confidence,
+            start: (total_frames_counter == 0 ? 1 : 0),
+            end: 0
+          }
           yield output
-				end
+        end
 
         last_pitch = pitch
 
-        if no_of_bytes_read != @hop_size
-          # there's no more audio to look at
+        next unless no_of_bytes_read != @hop_size
 
-          # Let's output one last pitch to mark the end of the file
-          total_time = total_frames_counter.to_f / @sample_rate.to_f
-          output = {
-            :pitch => pitch,
-            :confidence => confidence,
-            :start => 0,
-            :end  => 1
-          }
-          yield output
+        # there's no more audio to look at
 
-          # clean up
-          Api.del_aubio_pitch(@pitch)
-          Api.del_fvec(@sample_buffer)
-          Api.del_fvec(@out_fvec)
+        # Let's output one last pitch to mark the end of the file
+        total_time = total_frames_counter.to_f / @sample_rate.to_f
+        output = {
+          pitch: pitch,
+          confidence: confidence,
+          start: 0,
+          end: 1
+        }
+        yield output
 
-          break
-        end
-			end
-		end
+        # clean up
+        Api.del_aubio_pitch(@pitch)
+        Api.del_fvec(@sample_buffer)
+        Api.del_fvec(@out_fvec)
 
-	end
+        break
+      end
+    end
+  end
 end