fiddle_fluidsynth 0.0.1

data/examples/fiddle-pointer.rb

@@ -0,0 +1,18 @@
+#! /usr/bin/env ruby
+#
+#
+
+# Fiddle::Pointer read/write example.
+#
+#
+require_relative "#{__dir__}/../lib/fiddle-fluidsynth"
+#require "fiddle_fluidsynth"
+
+
+dbl_p = Fiddle::Pointer.malloc_dbl
+Fiddle::Pointer.set_dbl(dbl_p, 4.6692)
+fbc = Fiddle::Pointer.decode1_dbl(dbl_p)
+puts "decoded: #{fbc}"
+
+
+####

data/examples/presets-each.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+#
+#
+
+# presets-each.rb  - list all presets of SoundFont files with
+# bank and preset number.
+# (SoundFont instance's `#each_preset` example)
+#
+# This code is in the public domain.
+#
+# [YAMAMOTO, Masayuki]
+
+require_relative '../lib/fiddle_fluidsynth'
+#require 'fiddle_fluidsynth'
+
+
+#
+if ARGV[0].to_s == '-h' || ARGV[0].to_s == '--help'
+  puts "#{__FILE__} [soundfont fullpath]"
+  exit 0
+end
+
+#
+fs = if ARGV[0].nil?
+       FiddleFluidSynth.new
+     else
+       FiddleFluidSynth.new(soundfont_full_path: ARGV[0])
+     end
+fs.start
+
+#
+puts "sfid_ary: #{fs.sfid_ary}"
+
+#
+sfcount = fs.sfonts.size
+fs.sfonts.each_with_index do |sfont, _i|
+
+  #
+  sfid  = sfont.sfid
+  name  = sfont.name
+
+  #
+  puts "#{_i+1}/#{sfcount}. sfont: #{name}, sfid: #{sfid}" +
+    " (sfont instance addr: 0x#{sfont.to_i.to_s(16)}:#{sfont.class})"
+
+  #
+  sfont.each_preset do |_preset|
+    name    = _preset.name
+    prenum  = _preset.num
+    bknum   = _preset.bknum
+
+    #
+    puts "  %05d:%03d" % [bknum,prenum] +
+      ", name: #{name}" +
+      " (preset obj addr: 0x#{_preset.to_i.to_s(16)})"
+  end
+
+end
+
+
+#
+fs.raise_error_in_callback
+fs.delete
+
+
+####

data/examples/presets-full_scan.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+#
+#
+
+# presets-full_scan.rb  - list all presets (full-scan version).
+# traverse all presets in the bank number x program number space.
+#
+# This code is in the public domein.
+# [YAMAMOTO, Masayuki]
+#
+
+require_relative '../lib/fiddle_fluidsynth'
+#require 'fiddle_fluidsynth'
+
+
+# fs = FiddleFluidSynth.new(soundfont_name: nil)
+#reset_presets = 1
+reset_presets = 0
+fs = if ARGV[0].nil?
+       FiddleFluidSynth.new(reset_presets: reset_presets)
+     else
+       FiddleFluidSynth.new(
+         soundfont_full_path: ARGV[0], reset_presets: reset_presets)
+     end
+fs.start
+
+#
+# sfont   = fs.sfont_new
+puts "sfid_ary: #{fs.sfid_ary}"
+
+#
+fs.sfonts.each_with_index do |sfont, _i|
+  #name = fs.sfont_get_name(sfont)
+  name = sfont.name
+  puts "#{_i+1}. sfont: #{name}" +
+    " (sfont instance addr: 0x#{sfont.to_i.to_s(16)})"
+
+  #
+  for bknum in fs.bknum_range_whole
+    for pgnum in fs.pgnum_range_whole
+      #_preset = fs.sfont_get_preset(sfont, bknum: bknum, prenum: pgnum)
+      _preset = fs.sfont_get_preset(sfont, bknum: bknum, prenum: pgnum)
+
+      if !(_preset.null?)
+        name   = fs.preset_get_name(_preset)
+        prenum = fs.preset_get_num(_preset)
+        bknum  = fs.preset_get_bknum(_preset)
+        puts "  %05d:%03d %s" % [bknum,prenum,name] +
+          " (preset obj addr: 0x#{_preset.to_i.to_s(16)})"
+      end
+    end
+  end
+
+end
+
+
+#
+fs.raise_error_in_callback
+fs.delete

data/examples/settings-each.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+#
+#
+
+# List all settings (settings' iterator test program).
+#
+# References:
+# - Libfluidsynth, [Settings Reference](https://www.fluidsynth.org/api/fluidsettings.html)
+#
+
+#
+require_relative '../lib/fiddle_fluidsynth'
+#require 'fiddle_fluidsynth'
+
+
+# fs = FiddleFluidSynth.new(soundfont_name: nil)
+fs = if ARGV[0].nil?
+       FiddleFluidSynth.new
+     else
+       FiddleFluidSynth.new(soundfont_full_path: ARGV[0])
+     end
+
+#
+#
+#
+item_cnt = 0
+fs.settings.each_setting{|data, name, type|
+  item_cnt +=1
+
+  #
+  # $stderr.puts "{each_setting} data: #{data.null?}," +
+  #   " name: #{name}, type: #{type}"
+  puts "item (#{item_cnt}): \"#{name}\", type: #{type}"
+
+  #
+  mname = FiddleFluidSynth.settings_item_to_meth_name(name)
+  mname_default = mname + "_default"
+  mname_range   = mname + "_range"
+  msg = ""
+  if fs.settings.respond_to?(mname)
+    msg += "  value: #{fs.settings.send(mname)}" +
+      " (default: #{fs.settings.send(mname_default)}"
+    msg += ", range: #{fs.settings.send(mname_range)}" unless \
+      fs.settings.send(mname_range).nil?
+    msg += ")"
+  else
+    puts "[BUG] item \"#{name}\" does NOT respond to ##{mname}..."
+  end
+  puts "#{msg}"
+
+  #
+  puts "  notype?: #{fs.setting_type_is_notype?(type)}"
+  puts "  num?:    #{fs.setting_type_is_num?(type)}"
+  puts "  int?:    #{fs.setting_type_is_int?(type)}"
+  puts "  str?:    #{fs.setting_type_is_str?(type)}"
+  puts "  set?:    #{fs.setting_type_is_set?(type)}"
+
+  #
+  hints = fs.settings.hints_of(name)
+  if hints.nil?
+    puts "[ERROR] get_hints() is failed!"
+  end
+  puts "  hints: #{hints}"
+
+  hint_bounded_above_f = fs.setting_hints_is_bounded_above?(hints)
+  hint_bounded_below_f = fs.setting_hints_is_bounded_below?(hints)
+  hint_optionlist_f    = fs.setting_hints_is_optionlist?(hints)
+  hint_toggled_f       = fs.setting_hints_is_toggled?(hints)
+
+  puts "    bounded above?: #{hint_bounded_above_f}"
+  puts "    bounded below?: #{hint_bounded_below_f}"
+  puts "    optionlist?:    #{hint_optionlist_f}"
+  puts "    toggled?:       #{hint_toggled_f}"
+
+  #
+  if fs.setting_type_is_str?(type) && 
+      fs.setting_hints_is_optionlist?(hints)
+      # fs.settings.hints_is_optionlist?(name)
+
+    tmp_opts = []
+    fs.settings.each_option_of(name){|data,name,option|
+      tmp_opts << option
+    }
+    puts "    #{name} is string and optionlist:"
+    puts "    opt. (#{tmp_opts.size}):"
+    tmp_opts.each_with_index do |anopt, _i|
+      puts "      (#{_i+1}) \"#{anopt}\""
+    end
+  else
+    # puts "    #{name} is NOT string and optionlist:"
+  end
+
+  # test.
+  # raise SyntaxError, "test."
+  #
+}
+puts
+
+
+#
+fs.raise_error_in_callback
+fs.delete
+puts "end."
+
+
+####

data/exe/ffs_midiplay.rb

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+#
+#
+#
+
+# ffs_midiplay.rb  - fiddle_fluidsynth MIDI file player (tick callback
+# test program).
+# This code is in the public domain.
+#
+# [YAMAMOTO, Masayuki]
+#
+
+#
+#require_relative '../lib/fiddle_fluidsynth'
+require 'fiddle_fluidsynth'
+
+
+#
+DEFAULT_SF2_NAME = "default.sf2"
+f_1 = ARGV[0]
+f_2 = ARGV[1]
+
+f_midi = f_2 || f_1
+f_sf2  = (f_2.nil?)? DEFAULT_SF2_NAME : f_1
+puts "SoundFont: #{f_sf2}, MIDI file #{f_midi}"
+
+if f_midi.nil?
+  $stderr.puts "Help: #{File.basename(__FILE__)} [SoundFont] MIDI-file"
+  raise "Specify a MIDI file you want to play at least."
+end
+
+#
+#
+#
+fs = if File.exist?(f_sf2)
+       FiddleFluidSynth.new(soundfont_full_path: f_sf2)
+     else
+       FiddleFluidSynth.new(soundfont_name: f_sf2)
+     end
+fs.start
+
+#
+#
+#
+is_midi = fs.is_midifile(f_midi)
+raise "MIDI file is strange (#{is_midi}): #{f_midi}" \
+  unless fs.is_midifile?(f_midi)
+
+ver_s   = fs.fluidsynth_version_str
+ver_ary = fs.fluidsynth_version
+
+puts "MIDI file (#{is_midi}): #{f_midi}"
+puts "fluidsynth version_str: #{ver_s} (by version: #{ver_ary})"
+puts
+
+#
+#
+#
+fs.player_file(f_midi)
+time_start = Time.now
+puts "#{time_start}: Playing #{f_midi}"
+
+
+#
+# we can pass user_data via handler_data as follows, but this is completely
+# meaningless in FiddleFluidSynth.
+#
+# because we use closure to define the callback function, i.e.,
+# we can use any variables in the callback freely.
+#
+# ```
+# str_ptr = FFI::MemoryPointer.from_string("this is a test.")
+# fdl_ptr = Fiddle::Pointer.new(str_ptr.address)
+#
+# fs.player_set_tick_callback(handler_data: fdl_ptr_ary){|user_data, cur_tick|
+#    :
+#    puts "#{user_data}/#{user_data.read_string}"  # user_data is FFI::Pointer.
+#    :
+# }
+# ```
+#
+fs.player_set_tick_callback{|user_data, cur_tick|
+  #
+  total_ticks = fs.player_get_total_ticks
+
+  #
+  status = fs.player_status
+  bpm    = fs.player_bpm
+
+  #
+  # puts "#{user_data}/#{user_data.address}"
+  # puts "#{user_data}/#{user_data.read_string}"
+  puts "#{Time.now}: player status: #{status}/bpm: #{bpm}"
+
+  #
+  if cur_tick <= total_ticks
+    puts "Tick: %4d / %4d" % [cur_tick, total_ticks]
+  else
+    puts "(**) All events in the MIDI file are executed" +
+      " (Tick: %4d / %4d)" % [cur_tick, total_ticks]
+  end
+}
+
+
+#
+#
+#
+until fs.player_is_done?
+  sleep(1.0)
+end
+
+
+#
+#
+#
+fs.raise_error_in_callback
+fs.delete
+time_end = Time.now
+puts "#{time_end}: Finished (in #{time_end-time_start} [sec])."
+
+
+#### end.

data/lib/fiddle_fluidsynth/audio_output/driver.rb

@@ -0,0 +1,104 @@
+#
+# filename: fiddle-fluidsynth/audio_output/driver.rb
+#
+
+
+# References
+# - fluidsynth.org, [API Reference](https://www.fluidsynth.org/api/modules.html)
+#
+class FiddleFluidSynth
+
+  #
+  module C
+
+    # Functions for managing audio drivers and file renderers.
+    # ==== References
+    # - Audio Output/[Audio Driver](https://www.fluidsynth.org/api/group__audio__driver.html)
+    # - [library fiddle](https://docs.ruby-lang.org/ja/latest/library/fiddle.html)
+    #
+
+    ### basic types are in types/types.rb
+
+    # Callback function type used with new_fluid_audio_driver2() to allow
+    # for custom user audio processing before the audio is sent to the driver.
+    typealias 'fluid_audio_func_t', 'void'
+
+
+    # Lifecycle Functions.
+    #
+    #
+    extern 'fluid_audio_driver_t* new_fluid_audio_driver' +
+      '(fluid_settings_t*, fluid_synth_t*)'
+    extern 'fluid_audio_driver_t* new_fluid_audio_driver2' +
+      '(fluid_settings_t*, fluid_audio_func_t*, void*)'
+    extern 'void delete_fluid_audio_driver(fluid_audio_driver_t*)'    #
+
+
+    # Functions.
+    #
+    #
+    extern 'int fluid_audio_driver_register(char**)'    #
+
+  end
+end
+
+
+#
+#
+#
+class FiddleFluidSynth
+
+  # Create a new audio driver.
+  #
+  def self.audio_driver_new( synth: , settings: )
+    ret = C.new_fluid_audio_driver(settings, synth)
+    # ret.extend(Interface::AudioOutputDriver)
+    #
+    ret
+  end
+  def audio_driver_new( synth: self.synth, settings: self.settings )
+    self.class.audio_driver_new(synth: synth, settings: settings)
+  end
+
+
+  # Create a new audio driver.
+  # ==== Args
+  #
+  def self.audio_driver_new2( settings: , audio_func: , data: nil )
+    ret = C.new_fluid_audio_driver2(settings, audio_func, data)
+    # ret.extend(Interface::AudioOutputDriver)
+    #
+    ret
+  end
+  def audio_driver_new2( audio_func: , data: nil, settings: self.settings )
+    self.class.audio_driver_new2(
+      audio_func: audio_func, data: data, settings: settings)
+  end
+
+
+  # Deletes an audio driver instance.
+  def self.audio_driver_delete( driver )
+    ret = C.delete_fluid_audio_driver(driver)
+    ret
+  end
+  def audio_driver_delete( driver = self.audio_driver )
+    self.class.audio_driver_delete(driver)
+  end
+
+end
+
+#
+#
+#
+class FiddleFluidSynth
+
+  # Registers audio drivers to use.
+  def audio_driver_register( adrivers = nil )
+    ret = C.fluid_audio_driver_register(adrivers)
+    ret
+  end
+
+end
+
+
+#### endof filename: fiddle-fluidsynth/audio_output/driver.rb

data/lib/fiddle_fluidsynth/audio_output/file_renderer.rb

@@ -0,0 +1,84 @@
+#
+# filename: fiddle-fluidstynth/audio_output/file_renderer.rb
+#
+
+
+# References
+# - fluidsynth.org, [API Reference](https://www.fluidsynth.org/api/modules.html)
+#
+class FiddleFluidSynth
+
+  # Functions for managing file renderers and triggering the rendering.
+  # ==== References
+  # - Audio Output/[File Renderer](https://www.fluidsynth.org/api/group__file__renderer.html)
+  # - [library fiddle](https://docs.ruby-lang.org/ja/latest/library/fiddle.html)
+  #
+
+  #
+  module C
+
+
+    # Lifecycle Functions.
+    #
+    #
+    extern 'fluid_file_renderer_t* new_fluid_file_renderer(fluid_synth_t*)'
+    extern 'void delete_fluid_file_renderer(fluid_file_renderer_t*)'
+
+    # Functions.
+    #
+    #
+    extern 'int fluid_file_renderer_process_block(fluid_file_renderer_t*)'
+    extern 'int fluid_file_set_encoding_quality(fluid_file_renderer_t*, double)'
+
+  end
+end
+
+
+#
+#
+#
+class FiddleFluidSynth
+
+  # Create a new file renderer and open the file.
+  #def self.file_renderer_new( synth: )
+  def self.file_renderer_new( synth )
+    ret = C.new_fluid_file_renderer(synth)
+    ret
+  end
+  # def file_renderer_new( synth: self.synth )
+  def file_renderer_new( synth = self.synth )
+    self.class.file_renderer_new(synth)
+  end
+
+  # Close file and destroy a file renderer object.
+  def self.file_renderer_delete( dev )
+    ret = C.delete_fluid_file_renderer(dev)
+    ret
+  end
+  def file_renderer_delete( dev = self.file_renderer )
+    self.class.file_renderer_delete(dev)
+  end
+
+end
+
+#
+#
+#
+class FiddleFluidSynth
+
+  # Write period_size samples to file.
+  def file_renderer_process_block( dev )
+    ret = C.fluid_file_renderer_process_block(dev)
+    ret
+  end
+
+  # Set vbr encoding quality (only available with libsndfile support)
+  def file_renderer_set_encoding_quality( dev: , q: )
+    ret = C.fluid_file_set_encoding_quality(dev, q)
+    ret
+  end
+
+end
+
+
+#### endof filename: fiddle-fluidstynth/audio_output/file_renderer.rb

data/lib/fiddle_fluidsynth/audio_output.rb

@@ -0,0 +1,7 @@
+#
+# filename: audio_output.rb
+#
+require_relative "./audio_output/driver"
+require_relative "./audio_output/file_renderer"
+
+####

data/lib/fiddle_fluidsynth/command_interface/command_interface.rb

@@ -0,0 +1,90 @@
+#
+# filename: fiddle-fluidstynth/command_interface/command_interface.rb
+#
+
+
+# References
+# - [API Reference](https://www.fluidsynth.org/api/modules.html)
+#
+class FiddleFluidSynth
+
+  # Control and configuration interface.
+  # ==== References
+  # - API References, [Command Interface](https://www.fluidsynth.org/api/group__command__interface.html)
+  # - [library fiddle](https://docs.ruby-lang.org/ja/latest/library/fiddle.html)
+  #
+
+  #
+  module C
+
+    # Functions.
+    #
+    #
+
+    # Get standard in stream handle.
+    extern 'fluid_istream_t fluid_get_stdin(void)'
+
+    # Get standard output stream handle.
+    extern 'fluid_ostream_t fluid_get_stdout(void)'
+
+    # Get the system FluidSynth command file name.
+    extern 'char* fluid_get_sysconf(char*, int)'
+
+    # Get the user specific FluidSynth command file name.
+    extern 'char* fluid_get_userconf(char*, int)'
+
+  end
+end
+
+
+#
+#
+#
+class FiddleFluidSynth
+
+  def self.get_stdin
+    ret = C.fluid_get_stdin()
+    ret
+  end
+  def get_stdin
+    self.class.get_stdin()
+  end
+
+  def self.get_stdout
+    ret = C.fluid_get_stdout()
+    ret
+  end
+  def get_stdout
+    self.class.get_stdout()
+  end
+
+  #
+  # ==== Args
+  # buf:: Caller supplied string buffer to store file name to.
+  # len:: Length of buf.
+  #
+  def self.get_sysconf( buf, len )
+    ret = C.fluid_get_sysconf(buf, len)
+    ret
+  end
+  def get_sysconf( buf, len )
+    self.class.get_sysconf(buf, len)
+  end
+
+  #
+  # ==== Args
+  # buf:: Caller supplied string buffer to store file name to.
+  # len:: Length of buf.
+  #
+  def self.get_userconf( buf, len )
+    ret = C.fluid_get_userconf(buf, len)
+    ret
+  end
+  def get_userconf( buf, len )
+    self.class.get_userconf(buf, len)
+  end
+
+end
+
+
+#### endof filename: fiddle-fluidstynth/command_interface/command_interface.rb