fiddle_fluidsynth 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c99ccb1af07194f305ce99f260dc9b7aea453c6174834ac54187f12146954e9e
+  data.tar.gz: 9da5f79bbca05c80a9f54ec04552f792ee4020c23ba25f9421c6244f754a4012
+SHA512:
+  metadata.gz: 584e30be468d722a13c8846a6a7832f750ecedc426ec8b9b02383eddb315e7e2be77ea55647eff948a7fef9c1c937aa30e5f685a5fe1a70e4014363cdc767b8c
+  data.tar.gz: cb248bcbad970e06c6d5b5ffeda8b308ee144fcb9269e3c6aa87267b87354237f3ff993451a1256424df10ccb20374ecefd095b8d7991186058516ce1963f8a3

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-28
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 YAMAMOTO, Masayuki
+
+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,138 @@
+# FiddleFluidsynth
+
+A `fiddle` (`ffi` is partially used) wrapped [`libfluidsynth`](https://www.fluidsynth.org/). We can program/play the music from our code with this.
+
+To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+## Requirements
+
+`libfluidsynth` is required.
+
+In macOS, do `brew install fluidsynth` and make symbolic link
+`default.sf2` in `/opt/homebrew/share/fluid-synth/sf2/` for the default
+SoundFont.
+
+As for the default soundfont, I recommend GeneralUser GS 2.0.2 (`GeneralUser-GS.sf2`), created by S. Christian Collins. We can download it from [his site](https://www.schristiancollins.com/generaluser.php). This package includes some MIDI files for demo.
+
+[FluidR3 GM](https://musical-artifacts.com/artifacts/738) soundfont by Frank Wen and Toby Smithe is also great. We can download them on [Musical Artifact](https://musical-artifacts.com/).
+
+Other soundfont resources are listed in the FluidSynth User Manual Wiki, [SoundFont](https://github.com/FluidSynth/fluidsynth/wiki/SoundFont) chapter.
+
+## Developed Environment
+
+Developed/Tested environments are as follows:
+
+- libfluidsynth 2.4.6
+- Ruby 3.3.0
+- macOS 15.5
+
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+
+## Usage
+
+See `examples/` directory.
+
+
+
+## Technical info
+
+`fiddle` is used to wrap and `ffi` is partially used (for callback functions).
+
+
+The Structure of classes/modules is:
+
+- FiddleFluidSynth (class)      top.
+    - (class/)instance methods are defined. These are almost one-to-one
+      mapping with C-functions, but little bit ruby-fied.
+    - utility methods for shortcuts.
+    - ~~`FiddleFluidSynth#object` (this might be removed...?)
+        the method for referencing to the instance hierarchy~~.
+- FiddleFluidSynth::C (module)   direct mapping for C-functions.
+
+
+Ruby-fication is actually not enough and work in progress...
+
+
+### Attention on callback functions
+
+If we use the callbacks of FiddleFluidSynth, including `each_something{ ... }`-
+code blocks, we have to have special attention to our codes.
+
+Because the code blocks of them are out of our Ruby code once,
+we could not catch Exceptions correctly.
+
+__I highly recommend that code blocks for the callbacks should be
+short as far as we can, or use methods which are tested well.__
+
+__and also do `FiddleFluidSynth.#raise_error_in_callback` after
+some main routine to get the errors in callback function.__
+
+
+- Settings
+    - `fluid_settings_foreach()`
+    - `fluid_settings_foreach_option()`
+    - =>`#each_setting()`, `#each_option_of()`
+- Synthesizer
+    - `fluid_synth_tuning_iteration_start()`, `fluid_synth_tuning_iteration_next()`
+    - Not Yet.
+- SoundFont
+    - `fluid_sfont_iteration_start()`, `fluid_sfont_iteration_next()`
+    - =>`#each_preset()`
+
+- callback sample programs are `example/{ffs_fx, ffs_metronome, ffs_arpeggio, ffs_midiplay}.rb`.
+- `each_*` sample programs are `example/{presets-each, settings}.rb`, etc.
+
+
+## `libfluidsynth` and other MIDI/SoundFont-related apps and resources
+
+- [libfluidsynth](https://www.fluidsynth.org/)
+    - [User Documentation](https://www.fluidsynth.org/documentation/)
+    - [Developper Documentation](https://www.fluidsynth.org/api/)
+        - [API Reference](https://www.fluidsynth.org/api/modules.html)
+        - [Setting Reference](https://www.fluidsynth.org/api/fluidsettings.html)
+
+- [PolyPhone](https://www.polyphone.io/)  - the SoundFont editor. `brew install polyphone`
+- [Sonic Pi](https://sonic-pi.net/)   - awesome DAW environment. Sonic Pi has nice tutorial and documents. We can write score and play in Ruby. `brew install sonic-pi`.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/mephistobooks/fiddle_fluidsynth`.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## DISCLAIMER
+
+SoundFont® is a registered trademark of Creative Technology Ltd.
+
+
+---
+end.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/examples/enum.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+#
+#
+#
+
+# List all enumerations defined for fiddle_fluidsynth.
+#
+#
+require_relative '../lib/fiddle_fluidsynth'
+# require 'fiddle_fluidsynth'
+
+
+#
+FiddleFluidSynth.constants.grep(/^Enum/).sort.each_with_index do |_enum, _i|
+
+  puts "#{_i+1}. #{_enum}:"
+  puts FiddleFluidSynth.const_get(_enum).constants.map{|e|
+    v = FiddleFluidSynth.const_get(_enum).const_get(e)
+
+    [e, v]
+  }.sort_by{|e| e.last}.map.with_index{|e,_i|
+    "(#{_i+1}) FiddleFluidSynth::#{_enum}::#{e.first} = #{e.last}" +
+      " = FiddleFluidSynth::#{e.first} (#{FiddleFluidSynth.const_get(e.first)})"
+  }
+  puts
+
+end
+
+
+#### end.

data/examples/ffs_arpeggio.rb

@@ -0,0 +1,252 @@
+#!/usr/bin/env ruby
+#
+#
+
+# Original comments:
+# FluidSynth Arpeggio - Sequencer API example
+#
+# This code is in the public domain.
+#
+# To compile:
+#   gcc -o fluidsynth_arpeggio -lfluidsynth fluidsynth_arpeggio.c
+#
+# To run:
+#   fluidsynth_arpeggio soundfont [steps [duration]]
+#
+# [Pedro Lopez-Cabanillas <plcl@users.sf.net>]
+
+# fiddle_fluidsynth comments:
+# `ffs_arpeggio.rb` is fiddle_fluidsynth version of `fluidsynth_arpeggio.c`.
+# This code is also in the public domain.
+#
+# [YAMAMOTO, Masayuki, https://github.com/mephistobooks]
+
+#
+require_relative '../lib/fiddle_fluidsynth'
+#require 'fiddle_fluidsynth'
+
+
+#
+FFS  = FiddleFluidSynth
+@seq = nil
+
+#
+@synth_dest, @client_dest = nil, nil
+@time_marker = nil
+
+# duration of the pattern in ticks.
+@duration = 1440
+
+# notes of the arpeggio.
+@notes = [ 60, 64, 67, 72, 76, 79, 84, 79, 76, 72, 67, 64, ]
+
+# number of notes in one pattern.
+@pattern_size = 4
+
+
+### schedule a note on message.
+def schedule_noteon( ch, key, ticks )
+
+  # ev = FFS.event_new
+  FFS.seq_event(:noteon, ch: ch, key: key, vel: 127){|ev| 
+    # FFS.event_set_src(ev, src: -1)
+    # FFS.event_set_dest(ev, dest: @synth_dest)
+    ev.src = -1
+    ev.dst = @synth_dest
+    # ev.noteon(ch: ch, key: key, vel: 127)
+    # tmp = @seq.send_at(event: ev, time: ticks, absolute: 1)
+    if @seq.send_at(event: ev, time: ticks, absolute: 1) == FFS::FLUID_FAILED
+      $stderr.puts "(**) {#{__method__}} seq. send_at(): failed."
+    end
+
+    #if FFS::FLUID_FAILED == tmp
+    #  $stderr.puts "(**) {#{__method__}} seq. send_at(): failed (#{tmp})."
+    #else
+    #  $stderr.puts "(**) {#{__method__}} seq. send_at(): succeeded (#{tmp})."
+    #end
+    # FFS.event_delete(ev)
+  }
+
+end
+
+### schedule a note off message.
+def schedule_noteoff( ch, key, ticks )
+
+  # ev = FFS.event_new
+  FFS.seq_event(:noteoff, ch: ch, key: key){|ev|
+    # FFS.event_set_src(ev, src: -1)
+    # FFS.event_set_dest(ev, dest: @synth_dest)
+    # FFS.event_noteoff(ev, ch: ch, key: key)
+    ev.src = -1
+    ev.dst = @synth_dest
+    # ev.noteoff(ch: ch, key: key)
+    # tmp = FFS.sequencer_send_at(@seq, event: ev, time: ticks, absolute: 1)
+    # tmp = @seq.send_at(event: ev, time: ticks, absolute: 1)
+    if @seq.send_at(event: ev, time: ticks, absolute: 1) == FFS::FLUID_FAILED
+      $stderr.puts "(**) {#{__method__}} seq. send_at(): failed."
+    end
+
+    # if FFS::FLUID_FAILED == tmp
+    #   $stderr.puts "(**) {#{__method__}} seq. send_at(): failed (#{tmp})."
+    # else
+    #   $stderr.puts "(**) {#{__method__}} seq. send_at(): succeeded (#{tmp})."
+    # end
+    # FFS.event_delete(ev)
+  }
+
+end
+
+# schedule a timer event (shall trigger the callback).
+#
+#
+def schedule_timer_event
+
+  # ev = FFS.event_new
+  FFS.seq_event(:timer, data: nil){|ev|
+    # FFS.event_set_src(ev, src: -1)
+    # FFS.event_set_dest(ev, dest: @client_dest)
+    # FFS.event_timer(ev, data: nil)
+    ev.src = -1
+    ev.dst = @client_dest
+    # ev.timer(data: nil)
+
+    # tmp = FFS.sequencer_send_at(@seq, event: ev, time: @time_marker, absolute: 1)
+    # tmp = @seq.send_at(event: ev, time: @time_marker, absolute: 1)
+    if @seq.send_at(event: ev, time: @time_marker, absolute: 1) == \
+      FFS::FLUID_FAILED
+      $stderr.puts "(**) {#{__method__}} seq. send_at(): failed (#{tmp})."
+    end
+
+    # if FFS::FLUID_FAILED == tmp
+    #   $stderr.puts "(**) {#{__method__}} seq. send_at(): failed (#{tmp})."
+    # else
+    #   $stderr.puts "(**) {#{__method__}} seq. send_at(): succeeded (#{tmp})."
+    # end
+    # FFS.event_delete(ev)
+  }
+
+end
+
+
+# schedule the arpeggio's notes.
+#
+#
+def schedule_pattern
+  #
+  note_time     = @time_marker
+  note_duration = @duration/@pattern_size
+
+  #
+  (0...@pattern_size).each do |_i|
+    schedule_noteon(0, @notes[_i], note_time)
+    note_time += note_duration
+    schedule_noteoff(0, @notes[_i], note_time)
+  end
+
+  @time_marker += @duration
+end
+
+#
+@seq_cb_ptr = FFS.define_event_callback{|time, ev, seq, data|
+  #
+  schedule_timer_event()
+  schedule_pattern()
+}
+
+def usage( prog_name = __FILE__ )
+  puts "Usage: #{prog_name} [soundfont] [steps [duration]]"
+  puts "\t(optional) steps:    number of pattern notes, from 2" +
+    " to #{@pattern_size}"
+  puts "\t(optional) duration: of the pattern in ticks, default #{@duration}"
+end
+
+
+### main.
+
+# n = nil
+# if ARGV.size < 1
+if ARGV[0] == '-h' || ARGV[0] == '--help'
+  usage()
+  exit 1
+end
+
+#
+opt_idx = 0
+fs = if File.exist?(ARGV[0].to_s)
+       opt_idx += 1
+       FiddleFluidSynth.new(soundfont_full_path: ARGV[0], player_f: false)
+     else
+       FiddleFluidSynth.new(player_f: false)
+     end
+
+#
+@seq   = fs.sequencer_new2
+if @seq.null?
+  raise "Cannot prepare the sequencer!"
+end
+puts "#seq. clients: #{@seq.count_clients}"
+
+### register the synthesizer to the sequencer.
+# @synth_dest  = fs.sequencer_register_fluidsynth(@seq, fs.synth)
+@synth_dest  = @seq.register_fluidsynth(fs.synth)
+if FFS::FLUID_FAILED == @synth_dest
+  raise "Client (synth) registsteration failed."
+end
+puts "seq_id: #{@synth_dest}, #seq. clients:" +
+  " #{@seq.count_clients}"
+
+### register the sequencer client.
+# @client_dest = fs.sequencer_register_client(
+#                  @seq, name: 'ffs_metronome',
+#                  event_callback: @seq_cb_ptr,
+#                  data: nil)
+@client_dest = @seq.register_client(
+                 name: 'ffs_metronome',
+                 event_callback: @seq_cb_ptr, data: nil)
+if FFS::FLUID_FAILED == @client_dest
+  raise "Client registsteration failed."
+end
+puts "seq_id: #{@client_dest}, #seq. clients:" +
+  " #{@seq.count_clients}"
+
+#
+if ARGV.size >= 1 && ARGV[opt_idx]
+  n = ARGV[opt_idx].to_i
+  @pattern_size = n if n > 1 && (n < @pattern_size)
+  opt_idx += 1
+end
+
+if ARGV.size >= 2 && ARGV[opt_idx]
+  n = ARGV[opt_idx].to_i
+  @duration = n if n > 0
+  opt_idx += 1
+end
+$stderr.puts "@pattern_size: #{@pattern_size}, @duration: #{@duration}"
+
+
+#
+# @audiodriver = fs.audio_driver_prepare
+
+# get the current time in ticks.
+@time_marker = @seq.tick
+
+# schedule patterns.
+schedule_pattern()
+schedule_timer_event()
+schedule_pattern()
+
+
+# wait for user input.
+print 'Press "Enter" to stop: '
+$stdin.getc
+fs.raise_error_in_callback
+puts "done."
+
+#
+puts "Cleaning up..."
+fs.delete
+puts "fs.deleted."
+puts "Done. Exiting program."
+
+
+#### end.

data/examples/ffs_example.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+#
+#
+#
+
+# Original comments:
+# An example of how to use FluidSynth.
+#
+# To compile it on Linux:
+#  $ gcc -o example example.c `pkg-config fluidsynth --libs`
+#
+# To compile it on Windows:
+#    ...
+#
+#
+# Author: Peter Hanappe.
+# This code is in the public domain. Use it as you like.
+#
+
+# `ffs_example.rb` is fiddle_fluidsynth version of `example.c`
+# This code is also in the public domain.
+#
+# [YAMAMOTO, Masayuki]
+require_relative '../lib/fiddle_fluidsynth'
+#require 'fiddle_fluidsynth'
+
+#
+fs = FiddleFluidSynth.new(player_f: false)
+srand(Process.pid)
+
+#
+12.times do |i|
+    key = 60 + 12.0 * rand(0.0..1.0)
+    # fs.noteon(0, key, 80)
+    # fs.synth_noteon(ch: 0, key: key, vel: 80)
+    fs.noteon(0, key, 80)
+    sleep(1)
+    # fs.noteoff(0, key)
+    # fs.synth_noteoff(ch: 0, key: key)
+    fs.noteoff(0, key)
+end
+
+fs.raise_error_in_callback
+fs.delete
+
+
+#### end.