Module: FiddleFluidSynth::Interface::Settings

Defined in:
lib/fiddle_fluidsynth/settings/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb,
lib/fiddle_fluidsynth/util/interface/settings.rb

Constant Summary collapse

FFS = 
FiddleFluidSynth

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.define_accessors(item, debug_f: false) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 58

def self.define_accessors( item, debug_f: false )
  # dummy object for defining interface methods.
  settings_obj = FiddleFluidSynth.settings_new()

  type = ::FiddleFluidSynth::C.fluid_settings_get_type(settings_obj,item)
  $stderr.puts "{#{__method__}} item: #{item}, type: #{type}" if debug_f

  #
  mname_base = item_to_meth_name(item)
  mname_setter    = mname_base + "="
  mname_getter    = mname_base
  mname_default   = mname_base + "_default"
  mname_range     = mname_base + "_range"

  #
  mname_name = mname_base + "_name"
  define_method(mname_name){|_self: itself|
    ret = item
    ret
  }

  #
  case type
  when FiddleFluidSynth::FLUID_NUM_TYPE
    # setters.
    define_method(mname_setter){|dbl, _self: itself|
      _dbl = dbl
      rg = _self.send(mname_range)

      #
      if rg.nil?

      else
        if rg.cover?(_dbl)

        else
          _dbl = rg.first if _dbl < rg.first
          _dbl = rg.last  if rg.first < _dbl
          $stderr.puts "(**) value #{int} is out of range #{rg}." +
            " so fixed to #{_int}"
        end
      end

      ret = FiddleFluidSynth::C.fluid_settings_setnum(_self, item, _dbl)
      ret
    }

    # getters.
    define_method(mname_getter){|_self: itself|
      tmp = Fiddle::Pointer.malloc_dbl
      FiddleFluidSynth::C.fluid_settings_getnum(_self,item,tmp)
      ret = tmp.decode1_dbl
      ret
    }

    # default.
    define_method(mname_default){|_self: itself|
      ret = nil

      outval = Fiddle::Pointer.malloc_dbl
      tmp = FiddleFluidSynth::C.fluid_settings_getnum_default(
              _self,item,outval)
      if FLUID_OK == tmp
        ret = outval.decode1_dbl
      else
        # do nothing.
      end

      ret
    }

    # range.
    define_method(mname_range){|_self: itself|
      ret = nil

      out_min = Fiddle::Pointer.malloc_dbl
      out_max = Fiddle::Pointer.malloc_dbl
      tmp = FiddleFluidSynth::C.fluid_settings_getnum_range(
              _self,item,out_min,out_max)
      if FLUID_OK == tmp
        min = out_min.decode1_dbl
        max = out_max.decode1_dbl
        ret = min..max
      else
        # do nothing. (ret = nil)
      end
      ret
    }

  when FiddleFluidSynth::FLUID_INT_TYPE
    # setters.
    define_method(mname_setter){|int, _self: itself|
      _int = int
      rg = _self.send(mname_range)

      #
      if rg.nil?
        # nothing to do.
      else
        if rg.cover?(_int)
          # nothing to do.
        else
          _int = rg.first if _int < rg.first
          _int = rg.last  if rg.last < _int
          $stderr.puts "(**) value #{int} is out of range #{rg}." +
            " so fixed to #{_int}"
        end
      end

      ret = FiddleFluidSynth::C.fluid_settings_setint(_self, item, _int)
      ret
    }

    # getters.
    define_method(mname_getter){|_self: itself|
      tmp = Fiddle::Pointer.malloc_int
      FiddleFluidSynth::C.fluid_settings_getint(_self,item,tmp)
      ret = tmp.decode1_int
      ret
    }

    # default.
    define_method(mname_default){|_self: itself|
      ret = nil

      outval = Fiddle::Pointer.malloc_int
      tmp = FiddleFluidSynth::C.fluid_settings_getint_default(
              _self, item, outval)
      if FLUID_OK == tmp
        ret = outval.decode1_int
      else
        #
      end

      ret
    }

    # range.
    define_method(mname_range){|_self: itself|
      ret = nil

      out_min = Fiddle::Pointer.malloc_int
      out_max = Fiddle::Pointer.malloc_int
      tmp = FiddleFluidSynth::C.fluid_settings_getint_range(
        _self,item, out_min, out_max)
      if FLUID_OK == tmp
        min = out_min.decode1_int
        max = out_max.decode1_int
        ret = min..max
      else
        #
      end

      ret
    }

  when FiddleFluidSynth::FLUID_STR_TYPE
    # setters.
    define_method(mname_setter){|str, _self: itself|
      FiddleFluidSynth::C.fluid_settings_setstr(_self, item, str)
    }

    # getters. STR_TYPE
    define_method(mname_getter){|_self: itself|
      ret = nil
      out = Fiddle::Pointer.malloc_voidp
      ret = FiddleFluidSynth.settings_dupstr(
              settings: _self, name: item, out: out)
      ret
    }

    # default.
    define_method(mname_default){|_self: itself|
      ret = nil

      #
      outval = Fiddle::Pointer.malloc_voidp
      tmp = FiddleFluidSynth::C.fluid_settings_getstr_default(
              _self, item, outval)
      # $stderr.puts "[DEBUG] outval: #{outval}, tmp: #{tmp}, ret: #{ret}"

      #
      if FLUID_OK == tmp
        cstr_ptr  = outval.ptr
        ret = (cstr_ptr.null?)? nil : cstr_ptr.to_s
      else
        $stderr.puts "(**) API returned FLUID_FAILED (#{tmp})"
      end

      ret
    }

    # range. STR_TYPE does NOT have the range.
    # FIXME. by optionlist?
    #
    # define_method(mname_range){|_self: itself|
    #   ret = nil
    #   out_min = Fiddle::Pointer.malloc_dbl
    #   out_max = Fiddle::Pointer.malloc_dbl
    #   tmp = FiddleFluidSynth::C.fluid_settings_getint_range(
    #     _self,item, out_min, out_max)
    #   if FLUID_OK == tmp
    #     min = out_min.decode1_dbl
    #     max = out_max.decode1_dbl
    #     ret = min..max
    #   else
    #     #
    #   end
    #   ret
    # }
    define_method(mname_range){|_self: itself|
      ret = nil
      $stderr.puts "(**) #{item} does NOT have the range."
      ret
    }


  else
    msg = ""
    if FLUID_NO_TYPE == type
      msg = "(**) item \"#{item}\" is FLUID_NO_TYPE (#{type}) in this" +
        " machine. So we do NOT define accessors for this..."
    else
      msg = "(**) Unknown type #{type} for item: #{item}."
    end

    $stderr.puts "#{msg}"
  end

  #
  FiddleFluidSynth.settings_delete(settings_obj)
end

.item_to_meth_name(item) ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 35

def self.item_to_meth_name( item )
  _item = item
  ret = _item.to_s.gsub(/(\w)[.](\w)/, '\1_\2').
          gsub(/(\w)[-](\w)/, '\1__\2')
  ret
end

Instance Method Details

#each_option_of(setting_name, data: nil, verbose_f: false, &blk) ⇒ Object 



337
338
339
340
341
342
343
344
345
346
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 337

def each_option_of( setting_name, data: nil, verbose_f: false, &blk )
  cb_ptr = FiddleFluidSynth.
    define_settings_foreach_option_callback(){|_data,_name,_option|
      blk.call(_data,_name,_option)
    }
  $stderr.puts "{#{__method__}} 0x#{cb_ptr.to_i.to_s(16)}" if verbose_f

  FiddleFluidSynth::C.
    fluid_settings_foreach_option(self,setting_name,data,cb_ptr)
end

#each_setting(data: nil, verbose_f: false, &blk) ⇒ Object 



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 326

def each_setting( data: nil, verbose_f: false, &blk )
  cb_ptr = FiddleFluidSynth.
    define_settings_foreach_callback(){|data,name,type|
      blk.call(data,name,type)
    }
  $stderr.puts "{#{__method__}} 0x#{cb_ptr.to_i.to_s(16)}" if verbose_f

  FiddleFluidSynth::C.
    fluid_settings_foreach(self,data,cb_ptr)
end

#get_value_of(name) ⇒ Object Also known as: get_val_of, get_val, get_value, value_of, val_of, value, val 



292
293
294
295
296
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 292

def get_value_of( name )
  meth_name = self.item_to_meth_name(name)
  ret = self.send(meth_name)
  ret
end

#hints_of(name, _self: self.itself) ⇒ Object Also known as: hints

hints.



641
642
643
644
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 641

def hints_of( name, _self: self.itself )
  ret = FFS.settings_get_hints(name, settings: _self)
  ret
end

#is_realtime?(name, _self: self.itself) ⇒ Boolean

Warning

we have to prepare audio driver, midi driver, and synth, etc. to use this method. See API Reference ‘fluid_settings_is_realtime()`

Returns:

  • (Boolean) 


679
680
681
682
683
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 679

def is_realtime?( name, _self: self.itself )
  tmp = FFS.settings_is_realtime(_self, name: name)
  ret = (tmp != 0)
  ret
end

#item_to_meth_name(item) ⇒ Object

def item_to_meth_name( item ) def item_to_meth( item )



43
44
45
46
47
48
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 43

def item_to_meth_name( item )
  #ng. self.class.send(__method__, item)
  #ng. self.class.item_to_meth_name(item)
  # Settings.item_to_meth_name(item)  # ok.
  Settings.send(__method__, item)
end

#set_value_of(name, value) ⇒ Object Also known as: set_val_of, set_value, set_val 



305
306
307
308
309
310
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 305

def set_value_of( name, value )
  meth_name = self.item_to_meth_name(name)
  setter_name = meth_name + "="
  ret = self.send(setter_name, value)
  ret
end

#type_of(name, _self: self.itself) ⇒ Object Also known as: type

type.



611
612
613
614
 
# File 'lib/fiddle_fluidsynth/util/interface/settings.rb', line 611

def type_of( name, _self: self.itself )
  ret = FFS.settings_get_type(name, settings: _self)
  ret
end