voicemeeter_api_ruby 2.0.4 → 4.1.0

data/lib/command.rb

@@ -1,41 +1,36 @@
+require_relative 'iremote'
 require_relative 'meta'
 
-
-class ICommand
+class Command < IRemote
     include Commands_Meta_Functions
 
-    attr_accessor :remote
-
     def initialize(remote)
-        self.remote = remote
+        super
+        self.make_action_prop :show, :restart, :shutdown
+        self.make_writer_bool :showvbanchat, :lock
     end
 
-    def setter(param, value)
-        @remote.set_parameter("#{self.cmd}.#{param}", value)
+    def identifier
+        :command
     end
 
-    def cmd
-        return "command"
-    end
-end
-
-
-class Command < ICommand
-    def initialize(remote)
-        super
-        self.make_action_prop :show, :restart, :reset, :shutdown
-        self.make_writer_bool :showvbanchat, :lock
+    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)
+        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)
+        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,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(@remote.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/errors.rb

@@ -1,37 +1,39 @@
-module Errors
-    class VMRemoteErrors < StandardError; end
-
-    class InstallErrors < VMRemoteErrors; end
-
-    class CAPIErrors < VMRemoteErrors
-        attr_accessor :value, :func
-
-        def initialize(value, func)
-            self.value = value
-            self.func = func
-        end
-
-        def message
-            "When attempting to run function #{@func} the
-            C API returned value #{@value}. See documentation for further info"
-        end
-    end
-
-    class OutOfBoundsErrors < VMRemoteErrors
-        attr_accessor :range
-
-        def initialize(range)
-            self.range = range
-        end
-
-        def message
-            if @range.kind_of?(Range)
-                "Value error, expected value in range (#{range.first}..#{range.last})"
-            elsif @range.kind_of?(Array)
-                "Value error, expected one of: #{@range}"
-            else
-                "Value error, expected #{@range}"
-            end
-        end
-    end
-end
+module Errors
+    class VMRemoteErrors < StandardError
+    end
+
+    class InstallErrors < VMRemoteErrors
+    end
+
+    class CAPIErrors < VMRemoteErrors
+        attr_accessor :value, :func
+
+        def initialize(value, func)
+            self.value = value
+            self.func = func
+        end
+
+        def message
+            "When attempting to run function #{@func} the
+            C API returned value #{@value}. See documentation for further info"
+        end
+    end
+
+    class OutOfBoundsErrors < VMRemoteErrors
+        attr_accessor :range
+
+        def initialize(range)
+            self.range = range
+        end
+
+        def message
+            if @range.kind_of?(Range)
+                "Value error, expected value in range (#{range.first}..#{range.last})"
+            elsif @range.kind_of?(Array)
+                "Value error, expected one of: #{@range}"
+            else
+                "Value error, expected #{@range}"
+            end
+        end
+    end
+end

data/lib/inst.rb

@@ -6,22 +6,13 @@ 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"]
-            if os_bits.include? 64.to_s
-                return 64
-            end
-            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"]
+        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
@@ -29,8 +20,10 @@ module InstallationFunctions
         raise InstallErrors.new('Could not get the Voicemeeter path')
     end
 
-    def vmr_dll=(value)
-        raise InstallErrors.new('Could not fetch the dll file') unless value.file?
-        @vmr_dll = value
+    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

data/lib/kinds.rb

@@ -0,0 +1,77 @@
+module Kinds
+    '
+    A Kind struct for each version of Voicemeeter
+    '
+    attr_reader :kind_map, :kinds_all
+
+    Kind = Struct.new(:name, :layout)
+    basic =
+        Kind.new(
+            'basic',
+            {
+                strip: {
+                    p_in: 2,
+                    v_in: 1,
+                },
+                bus: {
+                    p_out: 1,
+                    v_out: 1,
+                },
+                vban: {
+                    instream: 4,
+                    outstream: 4,
+                },
+                mb: 80,
+            },
+        )
+
+    banana =
+        Kind.new(
+            'banana',
+            {
+                strip: {
+                    p_in: 3,
+                    v_in: 2,
+                },
+                bus: {
+                    p_out: 3,
+                    v_out: 2,
+                },
+                vban: {
+                    instream: 8,
+                    outstream: 8,
+                },
+                mb: 80,
+            },
+        )
+
+    potato =
+        Kind.new(
+            'potato',
+            {
+                strip: {
+                    p_in: 5,
+                    v_in: 3,
+                },
+                bus: {
+                    p_out: 5,
+                    v_out: 3,
+                },
+                vban: {
+                    instream: 8,
+                    outstream: 8,
+                },
+                mb: 80,
+            },
+        )
+
+    @kind_map = [basic, banana, potato].to_h { |kind| [kind.name, kind] }
+
+    def get_kind(kind_id)
+        @kind_map[kind_id]
+    end
+
+    @kinds_all = @kind_map.values
+
+    module_function :get_kind
+end

data/lib/meta.rb

@@ -1,20 +1,34 @@
 require_relative 'errors'
 
-class FalseClass; def to_i; 0 end end
-class TrueClass; def to_i; 1 end end
+module Conversions
+    module_function
+
+    def Boolean(value)
+        case value
+        when true, 1
+            true
+        when false, nil, 0
+            false
+        else
+            raise ArgumentError,
+                  "invalid value for Boolean(): \"#{value.inspect}\""
+        end
+    end
+end
 
 module Meta_Functions
     private
+
+    include Conversions
+
     def make_accessor_bool(*params)
         params.each do |param|
             define_singleton_method("#{param}") do
                 return !(self.getter("#{param}")).zero?
             end
 
-            opts = [false, true, 0, 1]
             define_singleton_method("#{param}=") do |value|
-                raise OutOfBoundsErrors.new(opts) unless opts.include? value
-                self.setter("#{param}", value.to_i == 1 ? 1 : 0)
+                self.setter("#{param}", Boolean(value) ? 1 : 0)
             end
         end
     end
@@ -62,38 +76,44 @@ module Meta_Functions
 
     def make_writer_only(*params)
         params.each do |param|
-            define_singleton_method("#{param}=") do |value=1|
+            define_singleton_method("#{param}=") do |value = 1|
                 self.setter("#{param}", value)
             end
         end
     end
 
     def make_channel_props(num_A, num_B)
-        (1..(num_A + num_B)).map do |i|
-            i <= num_A ? "A#{i}" : "B#{i - num_A}"
+        (1..(num_A + num_B)).map { |i| i <= num_A ? "A#{i}" : "B#{i - num_A}" }
+    end
+
+    def make_action_prop(*params)
+        params.each do |param|
+            define_singleton_method("#{param}") { self.setter("#{param}", 1) }
         end
     end
 end
 
-
 module Channel_Meta_Functions
+    private
+
+    include Conversions
     include Meta_Functions
 
     def make_accessor_bool(*params)
         params.each do |param|
-            cmds = {
-                :eq => 'EQ.on',
-            }
-            if cmds[param] then val = cmds[param] else val = param end
+            cmds = { eq: 'EQ.on' }
+            if cmds.key? param
+                cmd = cmds[param]
+            else
+                cmd = param
+            end
 
             define_singleton_method("#{param}") do
-                return !(self.getter("#{val}")).zero?
+                return !(self.getter("#{cmd}")).zero?
             end
 
-            opts = [false, true, 0, 1]
             define_singleton_method("#{param}=") do |value|
-                raise OutOfBoundsErrors.new(opts) unless opts.include? value
-                self.setter("#{val}", value.to_i == 1 ? 1 : 0)
+                self.setter("#{cmd}", Boolean(value) ? 1 : 0)
             end
         end
     end
@@ -104,13 +124,7 @@ module Channel_Meta_Functions
                 return self.getter("#{param}")
             end
 
-            opts = {
-                :gain => [-60,12],
-                :comp => [0,10],
-                :gate => [0,10],
-            }
             define_singleton_method("#{param}=") do |value|
-                raise OutOfBoundsErrors.new(opts[param]) unless value.between? *opts[param]
                 self.setter("#{param}", value)
             end
         end
@@ -122,11 +136,7 @@ module Channel_Meta_Functions
                 return self.getter("#{param}").to_i
             end
 
-            opts = {
-                :limit => (-40..12),
-            }
             define_singleton_method("#{param}=") do |value|
-                raise OutOfBoundsErrors.new(opts[param]) unless opts[param].member? value
                 self.setter("#{param}", value)
             end
         end
@@ -134,26 +144,42 @@ module Channel_Meta_Functions
 
     def make_reader_only(*params)
         params.each do |param|
-            cmds = {
-                :device => 'device.name',
-                :sr => 'device.sr',
-            }
-            if cmds[param] then val = cmds[param] else val = param end
+            cmds = { device: 'device.name', sr: 'device.sr' }
+            if cmds.key? param
+                cmd = cmds[param]
+            else
+                cmd = param
+            end
 
             define_singleton_method("#{param}") do
                 case param
                 when :device
-                    return self.getter("#{val}", true)
+                    return self.getter("#{cmd}", true)
                 when :sr
-                    return self.getter("#{val}", true).to_i
+                    return self.getter("#{cmd}").to_i
                 end
             end
         end
     end
-end
 
+    def make_bus_modes(*params)
+        params.each do |param|
+            define_singleton_method("#{param}") do
+                @remote.clear_polling
+                return !(self.getter("#{param}")).zero?
+            end
+
+            define_singleton_method("#{param}=") do |value|
+                self.setter("#{param}", Boolean(value) ? 1 : 0)
+            end
+        end
+    end
+end
 
 module Vban_Meta_Functions
+    private
+
+    include Conversions
     include Meta_Functions
 
     def make_reader_int(*params)
@@ -181,16 +207,28 @@ module Vban_Meta_Functions
             end
 
             opts = {
-                :sr => [11025, 16000, 22050, 24000, 32000, 44100, 48000,
-                64000, 88200, 96000],
-                :channel => (1..8),
-                :bit => [16,24],
-                :quality => (0..4),
-                :route => (0..8),
+                sr: [
+                    11_025,
+                    16_000,
+                    22_050,
+                    24_000,
+                    32_000,
+                    44_100,
+                    48_000,
+                    64_000,
+                    88_200,
+                    96_000,
+                ],
+                channel: (1..8),
+                bit: [16, 24],
+                quality: (0..4),
+                route: (0..8),
             }
 
             define_singleton_method("#{param}=") do |value|
-                raise OutOfBoundsErrors.new(opts[param]) unless opts[param].member? value
+                unless opts[param].member? value
+                    raise OutOfBoundsErrors.new(opts[param])
+                end
                 case param
                 when :bit
                     self.setter("#{param}", value == 16 ? 1 : 2)
@@ -202,50 +240,42 @@ module Vban_Meta_Functions
     end
 end
 
-
 module MacroButton_Meta_Functions
+    private
+
+    include Conversions
+
     def make_accessor_macrobutton(*params)
         params.each do |param|
-            mode = {
-                :state => 1,
-                :stateonly => 2,
-                :trigger => 3,
-            }
+            mode = { state: 1, stateonly: 2, trigger: 3 }
 
             define_singleton_method("#{param}") do
                 return !(self.getter(mode[param])).zero?
             end
 
-            opts = [false, true, 0, 1]
             define_singleton_method("#{param}=") do |value|
-                raise OutOfBoundsErrors.new(opts[param]) unless opts.include? value
-                self.setter(value.to_i == 1 ? 1 : 0, mode[param])
+                self.setter(Boolean(value) ? 1 : 0, mode[param])
             end
         end
     end
 end
 
 module Commands_Meta_Functions
-    include Meta_Functions
-    def make_action_prop(*params)
-        params.each do |param|
-            define_singleton_method("#{param}") do
-                self.setter("#{param}", 1)
-            end
-        end
-    end
+    private
 
+    include Conversions
+    include Meta_Functions
     def make_writer_bool(*params)
         params.each do |param|
-            cmds = {
-                :showvbanchat => 'DialogShow.VBANCHAT',
-            }
-            if cmds[param] then val = cmds[param] else val = param end
+            cmds = { showvbanchat: 'DialogShow.VBANCHAT' }
+            if cmds.key? param
+                cmd = cmds[param]
+            else
+                cmd = param
+            end
 
-            opts = [false, true]
             define_singleton_method("#{param}=") do |value|
-                raise OutOfBoundsErrors.new(opts) unless opts.include? value
-                self.setter("#{param}", value.to_i == 1 ? 1 : 0)
+                self.setter("#{cmd}", Boolean(value) ? 1 : 0)
             end
         end
     end

data/lib/mixin.rb

@@ -0,0 +1,11 @@
+module Fades
+    def fadeto(target, time)
+        self.setter('FadeTo', "(#{target}, #{time})")
+        sleep(@remote.DELAY)
+    end
+
+    def fadeby(change, time)
+        self.setter('FadeBy', "(#{change}, #{time})")
+        sleep(@remote.DELAY)
+    end
+end