voicemeeter_api_ruby 3.0.0 → 4.1.1

data/lib/cbindings.rb

@@ -1,103 +1,128 @@
-require 'ffi'
-require_relative 'inst'
-
-include InstallationFunctions
-
-module CBindings
-    '
-    Creates Ruby bindings to the C DLL
-
-    Performs other low level tasks
-    '
-    extend FFI::Library
-
-    private
-
-    begin
-        OS_BITS = get_arch
-        VM_PATH = get_vmpath(OS_BITS)
-        DLL_NAME = "VoicemeeterRemote#{OS_BITS == 64 ? '64' : ''}.dll"
-
-        self.vmr_dll = VM_PATH.join(DLL_NAME)
-    rescue InstallErrors => error
-        puts "ERROR: #{error.message}"
-        raise
-    end
-
-    ffi_lib @vmr_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 :vmr_mdirty, :VBVMR_MacroButton_IsDirty, [], :long
-    attach_function :vmr_get_buttonstatus,
-                    :VBVMR_MacroButton_GetStatus,
-                    %i[long pointer long],
-                    :long
-    attach_function :vmr_set_buttonstatus,
-                    :VBVMR_MacroButton_SetStatus,
-                    %i[long float long],
-                    :long
-
-    attach_function :vmr_pdirty, :VBVMR_IsParametersDirty, [], :long
-    attach_function :vmr_get_parameter_float,
-                    :VBVMR_GetParameterFloat,
-                    %i[string pointer],
-                    :long
-    attach_function :vmr_set_parameter_float,
-                    :VBVMR_SetParameterFloat,
-                    %i[string float],
-                    :long
-
-    attach_function :vmr_get_parameter_string,
-                    :VBVMR_GetParameterStringA,
-                    %i[string pointer],
-                    :long
-    attach_function :vmr_set_parameter_string,
-                    :VBVMR_SetParameterStringA,
-                    %i[string string],
-                    :long
-
-    attach_function :vmr_set_parameter_multi,
-                    :VBVMR_SetParameters,
-                    [:string],
-                    :long
-
-    attach_function :vmr_get_level,
-                    :VBVMR_GetLevel,
-                    %i[long long pointer],
-                    :long
-
-    def polling(func, **kwargs)
-        params = {
-            'get_parameter' => kwargs[:name],
-            'get_buttonstatus' => "mb_#{kwargs[:id]}_#{kwargs[:mode]}",
-        }
-        return @cache.delete(params[func]) if @cache.key? params[func]
-
-        self.clear_polling if @sync
-
-        yield
-    end
-
-    def retval=(values)
-        ' Writer validation for CAPI calls '
-        retval, func = *values
-        raise CAPIErrors.new(retval, func) if retval&.nonzero?
-        @retval = retval
-    end
-
-    public
-
-    def clear_polling
-        while self.pdirty? || self.mdirty?
-        end
-    end
-
-    def pdirty?() =  vmr_pdirty&.nonzero?
-
-    def mdirty?() =  vmr_mdirty&.nonzero?
-end
+require 'ffi'
+require_relative 'inst'
+
+include InstallationFunctions
+
+module CBindings
+    '
+    Creates Ruby bindings to the C DLL
+
+    Performs other low level tasks
+    '
+    extend FFI::Library
+
+    private
+
+    begin
+        OS_BITS = FFI::Platform::CPU.downcase == 'x64' ? 64 : 32
+        VM_PATH = get_vmpath(OS_BITS)
+        DLL_NAME = "VoicemeeterRemote#{OS_BITS == 64 ? '64' : ''}.dll"
+
+        self.vm_dll = VM_PATH.join(DLL_NAME)
+    rescue InstallErrors => error
+        puts "ERROR: #{error.message}"
+        raise
+    end
+
+    ffi_lib @vm_dll
+    ffi_convention :stdcall
+
+    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 :vm_mdirty, :VBVMR_MacroButton_IsDirty, [], :long
+    attach_function :vm_get_buttonstatus,
+                    :VBVMR_MacroButton_GetStatus,
+                    %i[long pointer long],
+                    :long
+    attach_function :vm_set_buttonstatus,
+                    :VBVMR_MacroButton_SetStatus,
+                    %i[long float long],
+                    :long
+
+    attach_function :vm_pdirty, :VBVMR_IsParametersDirty, [], :long
+    attach_function :vm_get_parameter_float,
+                    :VBVMR_GetParameterFloat,
+                    %i[string pointer],
+                    :long
+    attach_function :vm_set_parameter_float,
+                    :VBVMR_SetParameterFloat,
+                    %i[string float],
+                    :long
+
+    attach_function :vm_get_parameter_string,
+                    :VBVMR_GetParameterStringA,
+                    %i[string pointer],
+                    :long
+    attach_function :vm_set_parameter_string,
+                    :VBVMR_SetParameterStringA,
+                    %i[string string],
+                    :long
+
+    attach_function :vm_set_parameter_multi,
+                    :VBVMR_SetParameters,
+                    [:string],
+                    :long
+
+    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],
+            'get_buttonstatus' => "mb_#{kwargs[:id]}_#{kwargs[:mode]}",
+        }
+        return @cache.delete(params[func]) if @cache.key? params[func]
+
+        clear_polling if @sync
+
+        yield
+    end
+
+    def retval=(values)
+        ' Writer validation for CAPI calls '
+        retval, func = *values
+        unless [:get_num_indevices, :get_num_outdevices].include? func
+            raise CAPIErrors.new(retval, func) if retval&.nonzero?
+        end
+        @retval = retval
+    end
+
+    public
+
+    def pdirty?() =  vm_pdirty&.nonzero?
+
+    def mdirty?() =  vm_mdirty&.nonzero?
+
+    def ldirty?
+        @strip_buf, @bus_buf = _get_levels
+        return !(
+            @cache['strip_level'] == @strip_buf && @cache['bus_level'] == @bus_buf
+        )
+    end
+end

data/lib/command.rb

@@ -1,41 +1,36 @@
-require_relative 'meta'
-
-class ICommand
-    include Commands_Meta_Functions
-
-    def initialize(remote)
-        @remote = remote
-    end
-
-    def setter(param, value)
-        @remote.set_parameter("#{self.identifier}.#{param}", value)
-    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)
-    end
-
-    def load(value)
-        raise VMRemoteErrors.new('Expected a string') unless value.is_a? String
-        self.setter('load', value)
-        sleep(0.2)
-    end
-
-    def save(value)
-        raise VMRemoteErrors.new('Expected a string') unless value.is_a? String
-        self.setter('save', value)
-        sleep(0.2)
-    end
-end
+require_relative 'iremote'
+require_relative 'meta'
+
+class Command < IRemote
+    include Commands_Meta_Functions
+
+    def initialize(remote)
+        super
+        self.make_action_prop :show, :restart, :shutdown
+        self.make_writer_bool :showvbanchat, :lock
+    end
+
+    def identifier
+        :command
+    end
+
+    def hide
+        self.setter('show', 0)
+    end
+
+    def load(value)
+        raise VMRemoteErrors.new('Expected a string') unless value.is_a? String
+        self.setter('load', value)
+        sleep(0.2)
+    end
+
+    def save(value)
+        raise VMRemoteErrors.new('Expected a string') unless value.is_a? String
+        self.setter('save', value)
+        sleep(0.2)
+    end
+
+    def reset
+        @remote.set_config('reset')
+    end
+end

data/lib/configs.rb

@@ -0,0 +1,81 @@
+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
+
+    alias_method 'apply_config', :set_config
+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

@@ -1,38 +1,29 @@
-require 'win32/registry'
-require 'pathname'
-require_relative 'errors'
-
-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 =
-            "Software#{os_bits == 64 ? "\\WOW6432Node" : ''}\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\"
-        Win32::Registry::HKEY_LOCAL_MACHINE.open(reg_key + vm_key) do |reg|
-            value = reg['UninstallString']
-
-            pn = Pathname.new(value)
-            return pn.dirname
-        end
-        raise InstallErrors.new('Could not get the Voicemeeter path')
-    end
-
-    def vmr_dll=(value)
-        unless value.file?
-            raise InstallErrors.new('Could not fetch the dll file')
-        end
-        @vmr_dll = value
-    end
-end
+require 'win32/registry'
+require 'pathname'
+require_relative 'errors'
+
+include Errors
+
+module InstallationFunctions
+    private
+
+    def get_vmpath(os_bits)
+        vm_key = 'VB:Voicemeeter {17359A74-1236-5467}'
+        reg_key =
+            "Software#{os_bits == 64 ? "\\WOW6432Node" : ''}\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\"
+        Win32::Registry::HKEY_LOCAL_MACHINE.open(reg_key + vm_key) do |reg|
+            value = reg['UninstallString']
+
+            pn = Pathname.new(value)
+            return pn.dirname
+        end
+        raise InstallErrors.new('Could not get the Voicemeeter path')
+    end
+
+    def vm_dll=(value)
+        unless value.file?
+            raise InstallErrors.new('Could not fetch the dll file')
+        end
+        @vm_dll = value
+    end
+end

data/lib/iremote.rb

@@ -0,0 +1,30 @@
+require_relative 'meta'
+require_relative 'errors'
+
+class IRemote
+    '
+    Common interface between base class and higher classes.
+    '
+    include Meta_Functions
+
+    def initialize(remote, i = nil)
+        @remote = remote
+        @index = i
+    end
+
+    def getter(param, is_string = false)
+        @remote.get_parameter("#{self.identifier}.#{param}", is_string)
+    end
+
+    def setter(param, value)
+        @remote.set_parameter("#{self.identifier}.#{param}", value)
+    end
+
+    def identifier
+        raise 'Called abstract method: identifier'
+    end
+
+    def set_multi(param_hash)
+        param_hash.each { |(key, val)| self.send("#{key}=", val) }
+    end
+end