voicemeeter_api_ruby 3.0.0 → 4.0.0

data/lib/bus.rb

@@ -1,9 +1,10 @@
-require_relative 'channel'
+require_relative 'iremote'
 
-class Bus < IChannel
+class Bus < IRemote
     '
     Concrete Bus class
     '
+    include Channel_Meta_Functions
     include Fades
 
     attr_accessor :mode
@@ -20,7 +21,7 @@ class Bus < IChannel
 
     def initialize(remote, i)
         super
-        self.make_accessor_bool :mute, :mono, :eq
+        self.make_accessor_bool :mute, :mono, :eq, :sel
         self.make_accessor_float :gain
         self.make_accessor_string :label
 
@@ -28,16 +29,23 @@ class Bus < IChannel
     end
 
     def identifier
-        :bus
+        "bus[#{@index}]"
     end
 end
 
 class PhysicalBus < Bus
+    def initialize(remote, i)
+        super
+        self.make_reader_only :device, :sr
+    end
 end
+
 class VirtualBus < Bus
 end
 
-class BusModes < IChannel
+class BusModes < IRemote
+    include Channel_Meta_Functions
+
     def initialize(remote, i)
         super
         self.make_bus_modes :normal,
@@ -55,10 +63,6 @@ class BusModes < IChannel
     end
 
     def identifier
-        :bus
-    end
-
-    def cmd
-        "#{super}.mode"
+        "bus[#{@index}].mode"
     end
 end

data/lib/button.rb

@@ -1,13 +1,16 @@
+require_relative 'iremote'
 require_relative 'meta'
 
-class IMacroButton
+class MacroButton < IRemote
     include MacroButton_Meta_Functions
 
-    attr_accessor :remote, :index
+    def self.make(remote, num_buttons)
+        (0...num_buttons).map { |i| MacroButton.new(remote, i) }
+    end
 
-    def initialize(remote, index)
-        self.remote = remote
-        self.index = index
+    def initialize(remote, i)
+        super
+        self.make_accessor_macrobutton :state, :stateonly, :trigger
     end
 
     def getter(mode)
@@ -17,20 +20,4 @@ class IMacroButton
     def setter(set, mode)
         @remote.set_buttonstatus(@index, set, mode)
     end
-
-    def set_multi(param_hash)
-        param_hash.each { |(key, val)| self.send("#{key}=", val) }
-        sleep(remote.delay)
-    end
-end
-
-class MacroButton < IMacroButton
-    def self.make(remote, num_buttons)
-        (0...num_buttons).map { |i| MacroButton.new(remote, i) }
-    end
-
-    def initialize(remote, i)
-        super
-        self.make_accessor_macrobutton :state, :stateonly, :trigger
-    end
 end

data/lib/cbindings.rb

@@ -14,63 +14,85 @@ module CBindings
     private
 
     begin
-        OS_BITS = get_arch
+        OS_BITS = FFI::Platform::CPU.downcase == 'x64' ? 64 : 32
         VM_PATH = get_vmpath(OS_BITS)
         DLL_NAME = "VoicemeeterRemote#{OS_BITS == 64 ? '64' : ''}.dll"
 
-        self.vmr_dll = VM_PATH.join(DLL_NAME)
+        self.vm_dll = VM_PATH.join(DLL_NAME)
     rescue InstallErrors => error
         puts "ERROR: #{error.message}"
         raise
     end
 
-    ffi_lib @vmr_dll
+    ffi_lib @vm_dll
     ffi_convention :stdcall
 
-    attach_function :vmr_login, :VBVMR_Login, [], :long
-    attach_function :vmr_logout, :VBVMR_Logout, [], :long
-    attach_function :vmr_runvm, :VBVMR_RunVoicemeeter, [:long], :long
-    attach_function :vmr_vmtype, :VBVMR_GetVoicemeeterType, [:pointer], :long
+    attach_function :vm_login, :VBVMR_Login, [], :long
+    attach_function :vm_logout, :VBVMR_Logout, [], :long
+    attach_function :vm_runvm, :VBVMR_RunVoicemeeter, [:long], :long
+    attach_function :vm_vmtype, :VBVMR_GetVoicemeeterType, [:pointer], :long
+    attach_function :vm_vmversion, :VBVMR_GetVoicemeeterVersion, [:pointer], :long
 
-    attach_function :vmr_mdirty, :VBVMR_MacroButton_IsDirty, [], :long
-    attach_function :vmr_get_buttonstatus,
+    attach_function :vm_mdirty, :VBVMR_MacroButton_IsDirty, [], :long
+    attach_function :vm_get_buttonstatus,
                     :VBVMR_MacroButton_GetStatus,
                     %i[long pointer long],
                     :long
-    attach_function :vmr_set_buttonstatus,
+    attach_function :vm_set_buttonstatus,
                     :VBVMR_MacroButton_SetStatus,
                     %i[long float long],
                     :long
 
-    attach_function :vmr_pdirty, :VBVMR_IsParametersDirty, [], :long
-    attach_function :vmr_get_parameter_float,
+    attach_function :vm_pdirty, :VBVMR_IsParametersDirty, [], :long
+    attach_function :vm_get_parameter_float,
                     :VBVMR_GetParameterFloat,
                     %i[string pointer],
                     :long
-    attach_function :vmr_set_parameter_float,
+    attach_function :vm_set_parameter_float,
                     :VBVMR_SetParameterFloat,
                     %i[string float],
                     :long
 
-    attach_function :vmr_get_parameter_string,
+    attach_function :vm_get_parameter_string,
                     :VBVMR_GetParameterStringA,
                     %i[string pointer],
                     :long
-    attach_function :vmr_set_parameter_string,
+    attach_function :vm_set_parameter_string,
                     :VBVMR_SetParameterStringA,
                     %i[string string],
                     :long
 
-    attach_function :vmr_set_parameter_multi,
+    attach_function :vm_set_parameter_multi,
                     :VBVMR_SetParameters,
                     [:string],
                     :long
 
-    attach_function :vmr_get_level,
+    attach_function :vm_get_level,
                     :VBVMR_GetLevel,
                     %i[long long pointer],
                     :long
 
+    attach_function :vm_get_num_indevices,
+                    :VBVMR_Input_GetDeviceNumber, [], :long
+    attach_function :vm_get_desc_indevices,
+                    :VBVMR_Input_GetDeviceDescA, %i[long pointer pointer pointer],
+                    :long
+
+    attach_function :vm_get_num_outdevices,
+                    :VBVMR_Output_GetDeviceNumber, [], :long
+    attach_function :vm_get_desc_outdevices,
+                    :VBVMR_Output_GetDeviceDescA, %i[long pointer pointer pointer],
+                    :long
+
+
+
+    @@cdll =
+        lambda do |func, *args|
+            self.retval = [send("vm_#{func}", *args), func]
+        end
+
+    def clear_polling() = while pdirty? || mdirty?; end
+
     def polling(func, **kwargs)
         params = {
             'get_parameter' => kwargs[:name],
@@ -78,7 +100,7 @@ module CBindings
         }
         return @cache.delete(params[func]) if @cache.key? params[func]
 
-        self.clear_polling if @sync
+        clear_polling if @sync
 
         yield
     end
@@ -86,18 +108,15 @@ module CBindings
     def retval=(values)
         ' Writer validation for CAPI calls '
         retval, func = *values
-        raise CAPIErrors.new(retval, func) if retval&.nonzero?
+        unless [:get_num_indevices, :get_num_outdevices].include? func
+            raise CAPIErrors.new(retval, func) if retval&.nonzero?
+        end
         @retval = retval
     end
 
     public
 
-    def clear_polling
-        while self.pdirty? || self.mdirty?
-        end
-    end
-
-    def pdirty?() =  vmr_pdirty&.nonzero?
+    def pdirty?() =  vm_pdirty&.nonzero?
 
-    def mdirty?() =  vmr_mdirty&.nonzero?
+    def mdirty?() =  vm_mdirty&.nonzero?
 end

data/lib/command.rb

@@ -1,27 +1,18 @@
+require_relative 'iremote'
 require_relative 'meta'
 
-class ICommand
+class Command < IRemote
     include Commands_Meta_Functions
 
     def initialize(remote)
-        @remote = remote
-    end
-
-    def setter(param, value)
-        @remote.set_parameter("#{self.identifier}.#{param}", value)
+        super
+        self.make_action_prop :show, :restart, :shutdown
+        self.make_writer_bool :showvbanchat, :lock
     end
 
     def identifier
         :command
     end
-end
-
-class Command < ICommand
-    def initialize(remote)
-        super
-        self.make_action_prop :show, :restart, :reset, :shutdown
-        self.make_writer_bool :showvbanchat, :lock
-    end
 
     def hide
         self.setter('show', 0)
@@ -38,4 +29,8 @@ class Command < ICommand
         self.setter('save', value)
         sleep(0.2)
     end
+
+    def reset
+        @remote.set_config('reset')
+    end
 end

data/lib/configs.rb

@@ -0,0 +1,79 @@
+require 'kinds'
+require 'toml'
+
+module Configs
+    private
+
+    @@configs = Hash.new
+
+    class TOMLStrBuilder
+        def initialize(kind)
+            @p_in, @v_in = kind[:layout][:strip].values
+            @p_out, @v_out = kind[:layout][:bus].values
+            @vs_params =
+                ['mute = false', 'mono = false', 'solo = false', 'gain = 0.0'] +
+                    (1..@p_out).map { |i| "A#{i} = false" } +
+                    (1..@v_out).map { |i| "B#{i} = false" }
+
+            @ps_params = @vs_params + ['comp = 0.0', 'gate = 0.0']
+            @bus_params = ['mono = false', 'eq = false', 'mute = false']
+        end
+
+        def build
+            '
+            Builds a TOML script for the parser
+            '
+            @ps = (0...@p_in).map { |i| ["[strip_#{i}]"] + @ps_params }
+            @ps.map! { |a| a.map { |s| s.gsub('B1 = false', 'B1 = true') } }
+            @vs =
+                (@p_in...(@p_in + @v_in)).map do |i|
+                    ["[strip_#{i}]"] + @vs_params
+                end
+            @vs.map! { |a| a.map { |s| s.gsub('A1 = false', 'A1 = true') } }
+
+            @b =
+                (0...(@p_out + @v_out)).map { |i| ["[bus_#{i}]"] + @bus_params }
+
+            [@ps + @vs + @b].join("\n")
+        end
+    end
+
+    def parser(data)
+        TOML::Parser.new(data).parsed
+    end
+
+    def get_configs(kind_id)
+        file_pattern =
+            File.join(File.dirname(__dir__), 'configs', "#{kind_id}", '*.toml')
+
+        Dir
+            .glob(file_pattern)
+            .to_h do |toml_file|
+                filename = File.basename(toml_file, '.toml')
+                puts "loading config #{kind_id}/#{filename} into memory"
+                [filename, parser(File.read(toml_file))]
+            end
+    end
+
+    def loader
+        if @@configs.empty?
+            builder = TOMLStrBuilder.new(@kind)
+            puts 'loading config reset into memory'
+            @@configs['reset'] = parser(builder.build)
+            @@configs.merge!(get_configs(@kind.name.to_s))
+        end
+    end
+
+    public
+
+    def set_config(value)
+        loader
+        unless @@configs.key? value
+            raise VMRemoteErrors.new("No profile with name #{value} was loaded")
+        end
+
+        self.send('set_multi', @@configs[value])
+        puts "config #{@kind.name}/#{value} applied!"
+        sleep(@delay)
+    end
+end

data/lib/device.rb

@@ -0,0 +1,24 @@
+require_relative 'iremote'
+require_relative 'meta'
+
+class Device
+    def initialize(remote)
+        @remote = remote
+    end
+
+    def getter(**kwargs)
+        return @remote.get_num_devices(kwargs[:direction]) if kwargs[:index].nil?
+
+        vals = @remote.get_device_description(kwargs[:index], kwargs[:direction])
+        types = { 1 => 'mme', 3 => 'wdm', 4 => 'ks', 5 => 'asio' }
+        { 'name': vals[0], 'type': types[vals[1]], 'id': vals[2] }
+    end
+
+    def ins() = getter(direction: 'in')
+
+    def outs() = getter(direction: 'out')
+
+    def input(i) = getter(index: i, direction: 'in')
+
+    def output(i) = getter(index: i, direction: 'out')
+end

data/lib/inst.rb

@@ -7,15 +7,6 @@ include Errors
 module InstallationFunctions
     private
 
-    def get_arch
-        key = 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment'
-        Win32::Registry::HKEY_LOCAL_MACHINE.open(key) do |reg|
-            os_bits = reg['PROCESSOR_ARCHITECTURE']
-            return 64 if os_bits.include? '64'
-            return 32
-        end
-    end
-
     def get_vmpath(os_bits)
         vm_key = 'VB:Voicemeeter {17359A74-1236-5467}'
         reg_key =
@@ -29,10 +20,10 @@ module InstallationFunctions
         raise InstallErrors.new('Could not get the Voicemeeter path')
     end
 
-    def vmr_dll=(value)
+    def vm_dll=(value)
         unless value.file?
             raise InstallErrors.new('Could not fetch the dll file')
         end
-        @vmr_dll = value
+        @vm_dll = value
     end
 end

data/lib/{channel.rb → iremote.rb}

@@ -1,31 +1,27 @@
 require_relative 'meta'
 require_relative 'errors'
 
-class IChannel
+class IRemote
     '
-    Base Channel class
+    Common interface between base class and higher classes.
     '
-    include Channel_Meta_Functions
+    include Meta_Functions
 
-    def initialize(remote, i)
+    def initialize(remote, i = nil)
         @remote = remote
         @index = i
     end
 
     def getter(param, is_string = false)
-        @remote.get_parameter("#{self.cmd}.#{param}", is_string)
+        @remote.get_parameter("#{self.identifier}.#{param}", is_string)
     end
 
     def setter(param, value)
-        @remote.set_parameter("#{self.cmd}.#{param}", value)
-    end
-
-    def cmd
-        "#{self.identifier}[#{@index}]"
+        @remote.set_parameter("#{self.identifier}.#{param}", value)
     end
 
     def identifier
-        raise 'Called abstract mehod: identifier'
+        raise 'Called abstract method: identifier'
     end
 
     def set_multi(param_hash)

data/lib/meta.rb

@@ -150,7 +150,7 @@ module Channel_Meta_Functions
                 when :device
                     return self.getter("#{cmd}", true)
                 when :sr
-                    return self.getter("#{cmd}", true).to_i
+                    return self.getter("#{cmd}").to_i
                 end
             end
         end

data/lib/recorder.rb

@@ -1,28 +1,11 @@
+require_relative 'iremote'
 require_relative 'meta'
 
-class IRecorder
-    '
-    Base Recorder class
-    '
-    include Meta_Functions
-
-    def initialize(remote)
-        @remote = remote
-    end
-
-    def getter(param)
-        @remote.get_parameter("#{self.identifier}.#{param}")
-    end
-
-    def setter(param, value)
-        @remote.set_parameter("#{self.identifier}.#{param}", value)
-    end
-end
-
-class Recorder < IRecorder
+class Recorder < IRemote
     '
     Concrete Recorder class
     '
+
     def initialize(remote)
         super
         self.make_action_prop :play, :stop, :record, :ff, :rew

data/lib/runvm.rb

@@ -15,15 +15,15 @@ module RunVM
 
         enums =
             Kinds.kinds_all.map.with_index do |kind, i|
-                if OS_BITS == 64 && kind.name == 'potato'
-                    [kind.name, i + 4]
+                if OS_BITS == 64 && kind.name.to_s == 'potato'
+                    [kind.name.to_s, i + 4]
                 else
-                    [kind.name, i + 1]
+                    [kind.name.to_s, i + 1]
                 end
             end
         exes = enums.to_h { |k, v| [k, v.to_i] }
 
-        send('vmr_runvm', exes[kind_id])
+        send(:vm_runvm, exes[kind_id])
         sleep(1)
     end
 end

data/lib/strip.rb

@@ -1,9 +1,10 @@
-require_relative 'channel'
+require_relative 'iremote'
 
-class Strip < IChannel
+class Strip < IRemote
     '
     Concrete Strip class
     '
+    include Channel_Meta_Functions
     include Fades
 
     attr_accessor :gainlayer
@@ -36,14 +37,14 @@ class Strip < IChannel
     end
 
     def identifier
-        :strip
+        "strip[#{@index}]"
     end
 end
 
 class PhysicalStrip < Strip
     def initialize(remote, i)
         super
-        self.make_accessor_float :comp, :gate
+        self.make_accessor_float :comp, :gate, :audibility
         self.make_reader_only :device, :sr
     end
 end
@@ -53,21 +54,26 @@ class VirtualStrip < Strip
         super
         self.make_accessor_bool :mc
         self.make_accessor_int :k
+        self.make_accessor_float :bass, :mid, :treble
     end
 
-    def appgain(name, gain) = self.setter("AppGain", "(\"#{name}\", #{gain})")
+    def appgain(name, gain)
+        self.setter('AppGain', "(\"#{name}\", #{gain})")
+    end
 
-    def appmute(name, mute) = self.setter("AppMute", "(\"#{name}\", #{mute ? 1 : 0})")
+    def appmute(name, mute)
+        self.setter('AppMute', "(\"#{name}\", #{mute ? 1 : 0})")
+    end
 end
 
-class GainLayer < IChannel
+class GainLayer < IRemote
     def initialize(remote, i, j)
         super(remote, i)
         @j = j
     end
 
     def identifier
-        :strip
+        "strip[#{@index}]"
     end
 
     def gain