voicemeeter_api_ruby 4.4.0 → 4.4.1

data/lib/voicemeeter/meta.rb

@@ -1,251 +1,251 @@
-require_relative "errors"
-
-module Voicemeeter
-  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
-
-        define_singleton_method("#{param}=") do |value|
-          self.setter("#{param}", Boolean(value) ? 1 : 0)
-        end
-      end
-    end
-
-    def make_accessor_int(*params)
-      params.each do |param|
-        define_singleton_method("#{param}") do
-          return self.getter("#{param}").to_i
-        end
-
-        define_singleton_method("#{param}=") do |value|
-          self.setter("#{param}", value)
-        end
-      end
-    end
-
-    def make_accessor_float(*params)
-      params.each do |param|
-        define_singleton_method("#{param}") { return self.getter("#{param}") }
-
-        define_singleton_method("#{param}=") do |value|
-          self.setter("#{param}", value)
-        end
-      end
-    end
-
-    def make_accessor_string(*params)
-      params.each do |param|
-        define_singleton_method("#{param}") do
-          return self.getter("#{param}", true)
-        end
-
-        define_singleton_method("#{param}=") do |value|
-          self.setter("#{param}", value)
-        end
-      end
-    end
-
-    def make_reader_only(*params)
-      params.each do |param|
-        define_singleton_method("#{param}") { return self.getter("#{param}") }
-      end
-    end
-
-    def make_writer_only(*params)
-      params.each do |param|
-        define_singleton_method("#{param}=") do |value = 1|
-          self.setter("#{param}", value)
-        end
-      end
-    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 Meta_Functions
-
-    def make_accessor_bool(*params)
-      params.each do |param|
-        cmds = { eq: "EQ.on", eq_ab: "EQ.ab" }
-        if cmds.key? param
-          cmd = cmds[param]
-        else
-          cmd = param
-        end
-
-        define_singleton_method("#{param}") do
-          return !(self.getter("#{cmd}")).zero?
-        end
-
-        define_singleton_method("#{param}=") do |value|
-          self.setter("#{cmd}", Boolean(value) ? 1 : 0)
-        end
-      end
-    end
-
-    def make_reader_only(*params)
-      params.each do |param|
-        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("#{cmd}", true)
-          when :sr
-            return self.getter("#{cmd}").to_i
-          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 Meta_Functions
-
-    def make_reader_int(*params)
-      params.each do |param|
-        define_singleton_method("#{param}") do
-          case param
-          when :bit
-            return self.getter("#{param}").to_i == 1 ? 16 : 24
-          else
-            return self.getter("#{param}").to_i
-          end
-        end
-      end
-    end
-
-    def make_accessor_int(*params)
-      params.each do |param|
-        define_singleton_method("#{param}") do
-          case param
-          when :bit
-            return self.getter("#{param}").to_i == 1 ? 16 : 24
-          else
-            return self.getter("#{param}").to_i
-          end
-        end
-
-        opts = {
-          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|
-          unless opts[param].member? value
-            raise OutOfBoundsErrors.new(opts[param])
-          end
-          case param
-          when :bit
-            self.setter("#{param}", value == 16 ? 1 : 2)
-          else
-            self.setter("#{param}", value)
-          end
-        end
-      end
-    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 }
-
-        define_singleton_method("#{param}") do
-          return !(self.getter(mode[param])).zero?
-        end
-
-        define_singleton_method("#{param}=") do |value|
-          self.setter(Boolean(value) ? 1 : 0, mode[param])
-        end
-      end
-    end
-  end
-
-  module Commands_Meta_Functions
-    private
-
-    include Meta_Functions
-    def make_writer_bool(*params)
-      params.each do |param|
-        cmds = { showvbanchat: "DialogShow.VBANCHAT" }
-        if cmds.key? param
-          cmd = cmds[param]
-        else
-          cmd = param
-        end
-
-        define_singleton_method("#{param}=") do |value|
-          self.setter("#{cmd}", Boolean(value) ? 1 : 0)
-        end
-      end
-    end
-  end
-end
+require_relative "errors"
+
+module Voicemeeter
+  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
+
+        define_singleton_method("#{param}=") do |value|
+          self.setter("#{param}", Boolean(value) ? 1 : 0)
+        end
+      end
+    end
+
+    def make_accessor_int(*params)
+      params.each do |param|
+        define_singleton_method("#{param}") do
+          return self.getter("#{param}").to_i
+        end
+
+        define_singleton_method("#{param}=") do |value|
+          self.setter("#{param}", value)
+        end
+      end
+    end
+
+    def make_accessor_float(*params)
+      params.each do |param|
+        define_singleton_method("#{param}") { return self.getter("#{param}") }
+
+        define_singleton_method("#{param}=") do |value|
+          self.setter("#{param}", value)
+        end
+      end
+    end
+
+    def make_accessor_string(*params)
+      params.each do |param|
+        define_singleton_method("#{param}") do
+          return self.getter("#{param}", true)
+        end
+
+        define_singleton_method("#{param}=") do |value|
+          self.setter("#{param}", value)
+        end
+      end
+    end
+
+    def make_reader_only(*params)
+      params.each do |param|
+        define_singleton_method("#{param}") { return self.getter("#{param}") }
+      end
+    end
+
+    def make_writer_only(*params)
+      params.each do |param|
+        define_singleton_method("#{param}=") do |value = 1|
+          self.setter("#{param}", value)
+        end
+      end
+    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 Meta_Functions
+
+    def make_accessor_bool(*params)
+      params.each do |param|
+        cmds = { eq: "EQ.on", eq_ab: "EQ.ab" }
+        if cmds.key? param
+          cmd = cmds[param]
+        else
+          cmd = param
+        end
+
+        define_singleton_method("#{param}") do
+          return !(self.getter("#{cmd}")).zero?
+        end
+
+        define_singleton_method("#{param}=") do |value|
+          self.setter("#{cmd}", Boolean(value) ? 1 : 0)
+        end
+      end
+    end
+
+    def make_reader_only(*params)
+      params.each do |param|
+        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("#{cmd}", true)
+          when :sr
+            return self.getter("#{cmd}").to_i
+          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 Meta_Functions
+
+    def make_reader_int(*params)
+      params.each do |param|
+        define_singleton_method("#{param}") do
+          case param
+          when :bit
+            return self.getter("#{param}").to_i == 1 ? 16 : 24
+          else
+            return self.getter("#{param}").to_i
+          end
+        end
+      end
+    end
+
+    def make_accessor_int(*params)
+      params.each do |param|
+        define_singleton_method("#{param}") do
+          case param
+          when :bit
+            return self.getter("#{param}").to_i == 1 ? 16 : 24
+          else
+            return self.getter("#{param}").to_i
+          end
+        end
+
+        opts = {
+          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|
+          unless opts[param].member? value
+            raise OutOfBoundsErrors.new(opts[param])
+          end
+          case param
+          when :bit
+            self.setter("#{param}", value == 16 ? 1 : 2)
+          else
+            self.setter("#{param}", value)
+          end
+        end
+      end
+    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 }
+
+        define_singleton_method("#{param}") do
+          return !(self.getter(mode[param])).zero?
+        end
+
+        define_singleton_method("#{param}=") do |value|
+          self.setter(Boolean(value) ? 1 : 0, mode[param])
+        end
+      end
+    end
+  end
+
+  module Commands_Meta_Functions
+    private
+
+    include Meta_Functions
+    def make_writer_bool(*params)
+      params.each do |param|
+        cmds = { showvbanchat: "DialogShow.VBANCHAT" }
+        if cmds.key? param
+          cmd = cmds[param]
+        else
+          cmd = param
+        end
+
+        define_singleton_method("#{param}=") do |value|
+          self.setter("#{cmd}", Boolean(value) ? 1 : 0)
+        end
+      end
+    end
+  end
+end

data/lib/voicemeeter/recorder.rb

@@ -1,20 +1,20 @@
-require_relative "iremote"
-require_relative "meta"
-
-module Voicemeeter
-  class Recorder < IRemote
-    "
-    Concrete Recorder class
-    "
-    include Mixin::Outputs
-
-    def initialize(remote)
-      super
-      self.make_action_prop :play, :stop, :record, :ff, :rew
-    end
-
-    def identifier
-      :recorder
-    end
-  end
-end
+require_relative "iremote"
+require_relative "meta"
+
+module Voicemeeter
+  class Recorder < IRemote
+    "
+    Concrete Recorder class
+    "
+    include Mixin::Outputs
+
+    def initialize(remote)
+      super
+      self.make_action_prop :play, :stop, :record, :ff, :rew
+    end
+
+    def identifier
+      :recorder
+    end
+  end
+end

data/lib/voicemeeter/remote.rb

@@ -0,0 +1,77 @@
+module Voicemeeter
+  include RunVM
+
+  private
+
+  class Remote < Base
+    include Kinds
+    "
+    Remote class, subclasses Base
+
+    Console layout built according to a kind
+
+    Offers a run method for resource closure.
+    "
+    def initialize(kind, **kwargs)
+      super
+      self.strip = Strip.make(self, kind.layout[:strip])
+      self.bus = Bus.make(self, kind.layout[:bus])
+      self.button = MacroButton.make(self, kind.layout[:mb])
+      self.vban = Vban.new(self, kind.layout[:vban])
+      self.command = Command.new(self)
+      self.recorder = Recorder.new(self)
+      self.device = Device.new(self)
+    end
+
+    def run
+      "
+      Handles login/logout
+
+      Starts/stops the observable thread.
+      "
+      login
+      init_worker
+
+      yield if block_given?
+    ensure
+      end_worker
+      logout
+    end
+  end
+
+  public
+
+  def self.remote(kind_id, **kwargs)
+    "
+    Factory method for remotes.
+
+    Creates a hash of remote classes, one for each kind.
+
+    Handles kind_id request errors.
+
+    Returns a remote class of the kind requested.
+    "
+    _remotes =
+      Kinds.kinds_all.to_h do |kind|
+        [kind.name.to_s, Remote.new(kind, **kwargs)]
+      end
+
+    unless _remotes.key? kind_id
+      raise VMRemoteErrors.new("Unknown Voicemeeter Kind.")
+    end
+    _remotes[kind_id]
+  end
+
+  def self.testing
+    "
+    Returns a random Remote class
+    "
+    unless ENV["RACK_ENV"] == "dev"
+      raise VMRemoteErrors.new("Not in developer mode")
+    end
+
+    Remote.new(Kinds.kinds_all.sample)
+  end
+
+  module_function :start
+end

data/lib/voicemeeter/runvm.rb

@@ -1,31 +1,31 @@
-require_relative "cbindings"
-require_relative "kinds"
-
-module Voicemeeter
-  module RunVM
-    "
-    Starts Voicemeeter of the Kind requested.
-    "
-    include CBindings
-    include Kinds
-
-    def start(kind_id)
-      unless Kinds.kind_map.key? kind_id
-        raise VMRemoteErrors.new("Unknown Voicemeeter Kind.")
-      end
-
-      enums =
-        Kinds.kinds_all.map.with_index do |kind, i|
-          if CBindings::OS_BITS == 64 && kind.name.to_s == "potato"
-            [kind.name.to_s, i + 4]
-          else
-            [kind.name.to_s, i + 1]
-          end
-        end
-      exes = enums.to_h { |k, v| [k, v.to_i] }
-
-      CBindings.vm_runvm(exes[kind_id])
-      sleep(1)
-    end
-  end
-end
+require_relative "cbindings"
+require_relative "kinds"
+
+module Voicemeeter
+  module RunVM
+    "
+    Starts Voicemeeter of the Kind requested.
+    "
+    include CBindings
+    include Kinds
+
+    def start(kind_id)
+      unless Kinds.kind_map.key? kind_id
+        raise VMRemoteErrors.new("Unknown Voicemeeter Kind.")
+      end
+
+      enums =
+        Kinds.kinds_all.map.with_index do |kind, i|
+          if CBindings::OS_BITS == 64 && kind.name.to_s == "potato"
+            [kind.name.to_s, i + 4]
+          else
+            [kind.name.to_s, i + 1]
+          end
+        end
+      exes = enums.to_h { |k, v| [k, v.to_i] }
+
+      CBindings.vm_runvm(exes[kind_id])
+      sleep(1)
+    end
+  end
+end