voicemeeter_api_ruby 4.4.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5218c12fdf2ff6d99a68ce6ac4e896f8fc213848c17301bbaaf1897b71446b
-  data.tar.gz: 66f1a8e56633c592e9fd78b0188ac5061328e6324dd7b23eaee7077a33228e1f
+  metadata.gz: 2d5c6df9dba5f3f6bb249665cc26a6aeb8541c6e77712b4ff45f73452cfac8c4
+  data.tar.gz: a4c14273ab0cff0f004a68b4b9aa1816c087c775627bb2ab7872c8275b497859
 SHA512:
-  metadata.gz: efab5bb8f17a001f170cbf5f257ff523c1647a42b77dd962f1e95329b38b76ccfd458f5b18f9f66342e544b1e9fd6e1a2c4037a1411309f7a616e3c2b26e2ffc
-  data.tar.gz: b3a47db4e3cfa1f82baa9dfda397be0a0b64fd9fa91d4c483c387c97e99004f47efd8dc06c6fac077feef6f3c92c35d484ee27fd03eb4415b35abd13f928605d
+  metadata.gz: ad89a1cd012ccc74a42e7f8886c17a531e72b5af8180bba87e28da1df191dee74ac2b24d6531c11c0493e554652779a334241823d31af1e73718a76fc1bdbb11
+  data.tar.gz: d7f1d28cc751ed6d40d770f66691e2d012e71d9a29e72d236d2a7800fca3b19f1bbb536fa066e9b0b392a109e27df76be8658dca0605d41769afbe82670eb1a9

data/README.md

@@ -12,9 +12,9 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
 
--   Basic 1.0.8.2
--   Banana 2.0.6.2
--   Potato 3.0.2.2
+-   Basic 1.0.8.4
+-   Banana 2.0.6.4
+-   Potato 3.0.2.4
 
 ## Requirements
 

data/lib/voicemeeter/base.rb

@@ -1,255 +1,211 @@
-require "observer"
-
-require_relative "runvm"
-require_relative "configs"
-require_relative "errors"
-require_relative "event"
-require_relative "midi"
-
-module Voicemeeter
-  class Base
-    "
-    Base class responsible for wrapping the C Remote API
-
-    Mixin required modules
-    "
-    include Observable
-    include Configs
-    include RunVM
-
-    attr_accessor :strip,
-                  :bus,
-                  :button,
-                  :vban,
-                  :command,
-                  :recorder,
-                  :device,
-                  :midi
-    attr_accessor :strip_mode, :event
-
-    attr_reader :kind, :p_in, :v_in, :p_out, :v_out, :retval, :cache
-    attr_reader :running, :_strip_comp, :_bus_comp, :delay
-
-    DELAY = 0.001
-    SYNC = false
-    RATELIMIT = 0.033
-    SIZE = 1
-
-    def initialize(kind, **kwargs)
-      @kind = kind
-      @sync = kwargs.delete(:sync) || SYNC
-      @ratelimit = kwargs.delete(:ratelimit) || RATELIMIT
-      @p_in, @v_in = kind.layout[:strip].values
-      @p_out, @v_out = kind.layout[:bus].values
-      @running = false
-      @strip_mode = 0
-      @delay = DELAY
-      @cache = Hash.new
-      @midi = Midi.new
-      @event = Event.new(**kwargs)
-    end
-
-    def init_thread
-      puts "Listening for #{@event.get.join(", ")} events"
-      @cache["strip_level"], @cache["bus_level"] = _get_levels
-      @running = true
-      Thread.new do
-        loop do
-          Thread.stop if !@running
-          if @event.pdirty && pdirty?
-            changed
-            notify_observers("pdirty")
-          end
-          if @event.mdirty && mdirty?
-            changed
-            notify_observers("mdirty")
-          end
-          if @event.midi && get_midi_message
-            changed
-            notify_observers("midi")
-          end
-          if @event.ldirty && ldirty?
-            changed
-            @_strip_comp =
-              @cache["strip_level"].map.with_index do |x, i|
-                !(x == @strip_buf[i])
-              end
-            @_bus_comp =
-              @cache["bus_level"].map.with_index { |x, i| !(x == @bus_buf[i]) }
-            @cache["strip_level"] = @strip_buf
-            @cache["bus_level"] = @bus_buf
-            notify_observers("ldirty")
-          end
-          sleep(@ratelimit)
-        end
-      end
-    end
-
-    def end_thread
-      @running = false
-    end
-
-    def login
-      @@cdll.call(:login)
-      clear_polling
-    rescue CAPIErrors => error
-      case
-      when error.value == 1
-        self.start(@kind.name)
-        clear_polling
-      when error.value < 0
-        raise
-      end
-    end
-
-    def logout
-      clear_polling
-      sleep(0.1)
-      @@cdll.call(:logout)
-    end
-
-    def type
-      c_type = FFI::MemoryPointer.new(:long, SIZE)
-      @@cdll.call(:vmtype, c_type)
-      types = { 1 => "basic", 2 => "banana", 3 => "potato" }
-      types[c_type.read_long]
-    end
-
-    def version
-      c_ver = FFI::MemoryPointer.new(:long, SIZE)
-      @@cdll.call(:vmversion, c_ver)
-      v1 = (c_ver.read_long & 0xFF000000) >> 24
-      v2 = (c_ver.read_long & 0x00FF0000) >> 16
-      v3 = (c_ver.read_long & 0x0000FF00) >> 8
-      v4 = c_ver.read_long & 0x000000FF
-      "#{v1}.#{v2}.#{v3}.#{v4}"
-    end
-
-    def get_parameter(name, is_string = false)
-      self.polling("get_parameter", name: name) do
-        if is_string
-          c_get = FFI::MemoryPointer.new(:string, 512, true)
-          @@cdll.call(:get_parameter_string, name, c_get)
-          c_get.read_string
-        else
-          c_get = FFI::MemoryPointer.new(:float, SIZE)
-          @@cdll.call(:get_parameter_float, name, c_get)
-          c_get.read_float.round(1)
-        end
-      end
-    end
-
-    def set_parameter(name, value)
-      if value.is_a? String
-        @@cdll.call(:set_parameter_string, name, value)
-      else
-        @@cdll.call(:set_parameter_float, name, value.to_f)
-      end
-      @cache.store(name, value)
-    end
-
-    def get_buttonstatus(id, mode)
-      self.polling("get_buttonstatus", id: id, mode: mode) do
-        c_get = FFI::MemoryPointer.new(:float, SIZE)
-        @@cdll.call(:get_buttonstatus, id, c_get, mode)
-        c_get.read_float.to_i
-      end
-    end
-
-    def set_buttonstatus(id, state, mode)
-      @@cdll.call(:set_buttonstatus, id, state, mode)
-      @cache.store("mb_#{id}_#{mode}", state)
-    end
-
-    def set_parameter_multi(param_hash)
-      param_hash.each do |(key, val)|
-        prop, m2, m3, *rem = key.to_s.split("_")
-        if m2.to_i.to_s == m2
-          m2 = m2.to_i
-        elsif m3.to_i.to_s == m3
-          m3 = m3.to_i
-        end
-
-        case prop
-        when "strip"
-          self.strip[m2].set_multi(val)
-        when "bus"
-          self.bus[m2].set_multi(val)
-        when "button", "mb"
-          self.button[m2].set_multi(val)
-        when "vban"
-          if %w[instream in].include? m2
-            self.vban.instream[m3].set_multi(val)
-          elsif %w[outstream out].include? m2
-            self.vban.outstream[m3].set_multi(val)
-          end
-        end
-        sleep(DELAY)
-      end
-    end
-
-    def get_level(type, index)
-      c_get = FFI::MemoryPointer.new(:float, SIZE)
-      @@cdll.call(:get_level, type, index, c_get)
-      c_get.read_float
-    end
-
-    def _get_levels
-      [
-        (0...(2 * @p_in + 8 * @v_in)).map { |i| get_level(@strip_mode, i) },
-        (0...(8 * (@p_out + @v_out))).map { |i| get_level(3, i) }
-      ]
-    end
-
-    def get_num_devices(direction)
-      unless %w[in out].include? direction
-        raise VMRemoteErrors.new("expected in or out")
-      end
-      if direction == "in"
-        res = @@cdll.call(:get_num_indevices)
-      else
-        res = @@cdll.call(:get_num_outdevices)
-      end
-      res[0]
-    end
-
-    def get_device_description(index, direction)
-      unless %w[in out].include? direction
-        raise VMRemoteErrors.new("expected in or out")
-      end
-      c_type = FFI::MemoryPointer.new(:long, SIZE)
-      c_name = FFI::MemoryPointer.new(:string, 256, true)
-      c_hwid = FFI::MemoryPointer.new(:string, 256, true)
-      if direction == "in"
-        @@cdll.call(:get_desc_indevices, index, c_type, c_name, c_hwid)
-      else
-        @@cdll.call(:get_desc_outdevices, index, c_type, c_name, c_hwid)
-      end
-      [c_name.read_string, c_type.read_long, c_hwid.read_string]
-    end
-
-    def get_midi_message
-      c_msg = FFI::MemoryPointer.new(:string, 1024, true)
-      res = @@cdll.call(:get_midi_message, c_msg, 1024)
-      if res[0] > 0
-        vals = c_msg.read_string.bytes
-        vals.each_slice(3) do |ch, key, vel|
-          @midi.channel = ch if @midi.channel.nil? || @midi.channel != ch
-          @midi.current = key.to_i
-          @midi.set(key.to_i, vel.to_i)
-        end
-      elsif res[0] == -1 || res[0] == -2
-        raise CAPIErrors.new("VBVMR_GetMidiMessage returned #{msg[0]}")
-      end
-      res[0] > 0
-    end
-
-    alias_method "set_multi", :set_parameter_multi
-    alias_method "apply", :set_parameter_multi
-    alias_method "get", :get_parameter
-    alias_method "set", :set_parameter
-    alias_method "pdirty", :pdirty?
-    alias_method "mdirty", :mdirty?
-    alias_method "ldirty", :ldirty?
-  end
-end
+require "observer"
+
+require_relative "worker"
+require_relative "runvm"
+require_relative "configs"
+require_relative "errors"
+require_relative "event"
+require_relative "midi"
+
+module Voicemeeter
+  class Base
+    "
+    Base class responsible for wrapping the C Remote API
+
+    Mixin required modules
+    "
+    include Observable
+    include Configs
+    include RunVM
+    include Worker
+
+    attr_accessor :strip, :bus, :button, :vban, :command, :recorder, :device
+    attr_accessor :midi
+    attr_accessor :strip_mode, :event
+
+    attr_reader :kind, :p_in, :v_in, :p_out, :v_out, :retval, :cache
+    attr_reader :running, :_strip_comp, :_bus_comp, :delay
+
+    DELAY = 0.001
+    SYNC = false
+    RATELIMIT = 0.033
+    SIZE = 1
+
+    def initialize(kind, **kwargs)
+      @kind = kind
+      @sync = kwargs.delete(:sync) || SYNC
+      @ratelimit = kwargs.delete(:ratelimit) || RATELIMIT
+      @p_in, @v_in = kind.layout[:strip].values
+      @p_out, @v_out = kind.layout[:bus].values
+      @running = false
+      @strip_mode = 0
+      @delay = DELAY
+      @cache = Hash.new
+      @midi = Midi.new
+      @event = Event.new(**kwargs)
+    end
+
+    def login
+      @@cdll.call(:login)
+      clear_polling
+    rescue CAPIErrors => error
+      case
+      when error.value == 1
+        self.start(@kind.name)
+        clear_polling
+      when error.value < 0
+        raise
+      end
+    end
+
+    def logout
+      clear_polling
+      sleep(0.1)
+      @@cdll.call(:logout)
+    end
+
+    def type
+      c_type = FFI::MemoryPointer.new(:long, SIZE)
+      @@cdll.call(:vmtype, c_type)
+      types = { 1 => "basic", 2 => "banana", 3 => "potato" }
+      types[c_type.read_long]
+    end
+
+    def version
+      c_ver = FFI::MemoryPointer.new(:long, SIZE)
+      @@cdll.call(:vmversion, c_ver)
+      v1 = (c_ver.read_long & 0xFF000000) >> 24
+      v2 = (c_ver.read_long & 0x00FF0000) >> 16
+      v3 = (c_ver.read_long & 0x0000FF00) >> 8
+      v4 = c_ver.read_long & 0x000000FF
+      "#{v1}.#{v2}.#{v3}.#{v4}"
+    end
+
+    def get_parameter(name, is_string = false)
+      self.polling("get_parameter", name: name) do
+        if is_string
+          c_get = FFI::MemoryPointer.new(:string, 512, true)
+          @@cdll.call(:get_parameter_string, name, c_get)
+          c_get.read_string
+        else
+          c_get = FFI::MemoryPointer.new(:float, SIZE)
+          @@cdll.call(:get_parameter_float, name, c_get)
+          c_get.read_float.round(1)
+        end
+      end
+    end
+
+    def set_parameter(name, value)
+      if value.is_a? String
+        @@cdll.call(:set_parameter_string, name, value)
+      else
+        @@cdll.call(:set_parameter_float, name, value.to_f)
+      end
+      @cache.store(name, value)
+    end
+
+    def get_buttonstatus(id, mode)
+      self.polling("get_buttonstatus", id: id, mode: mode) do
+        c_get = FFI::MemoryPointer.new(:float, SIZE)
+        @@cdll.call(:get_buttonstatus, id, c_get, mode)
+        c_get.read_float.to_i
+      end
+    end
+
+    def set_buttonstatus(id, state, mode)
+      @@cdll.call(:set_buttonstatus, id, state, mode)
+      @cache.store("mb_#{id}_#{mode}", state)
+    end
+
+    def set_parameter_multi(param_hash)
+      param_hash.each do |(key, val)|
+        prop, m2, m3, *rem = key.to_s.split("_")
+        if m2.to_i.to_s == m2
+          m2 = m2.to_i
+        elsif m3.to_i.to_s == m3
+          m3 = m3.to_i
+        end
+
+        case prop
+        when "strip"
+          self.strip[m2].set_multi(val)
+        when "bus"
+          self.bus[m2].set_multi(val)
+        when "button", "mb"
+          self.button[m2].set_multi(val)
+        when "vban"
+          if %w[instream in].include? m2
+            self.vban.instream[m3].set_multi(val)
+          elsif %w[outstream out].include? m2
+            self.vban.outstream[m3].set_multi(val)
+          end
+        end
+        sleep(DELAY)
+      end
+    end
+
+    def get_level(type, index)
+      c_get = FFI::MemoryPointer.new(:float, SIZE)
+      @@cdll.call(:get_level, type, index, c_get)
+      c_get.read_float
+    end
+
+    def _get_levels
+      [
+        (0...(2 * @p_in + 8 * @v_in)).map { |i| get_level(@strip_mode, i) },
+        (0...(8 * (@p_out + @v_out))).map { |i| get_level(3, i) }
+      ]
+    end
+
+    def get_num_devices(direction)
+      unless %w[in out].include? direction
+        raise VMRemoteErrors.new("expected in or out")
+      end
+      if direction == "in"
+        res = @@cdll.call(:get_num_indevices)
+      else
+        res = @@cdll.call(:get_num_outdevices)
+      end
+      res[0]
+    end
+
+    def get_device_description(index, direction)
+      unless %w[in out].include? direction
+        raise VMRemoteErrors.new("expected in or out")
+      end
+      c_type = FFI::MemoryPointer.new(:long, SIZE)
+      c_name = FFI::MemoryPointer.new(:string, 256, true)
+      c_hwid = FFI::MemoryPointer.new(:string, 256, true)
+      if direction == "in"
+        @@cdll.call(:get_desc_indevices, index, c_type, c_name, c_hwid)
+      else
+        @@cdll.call(:get_desc_outdevices, index, c_type, c_name, c_hwid)
+      end
+      [c_name.read_string, c_type.read_long, c_hwid.read_string]
+    end
+
+    def get_midi_message
+      c_msg = FFI::MemoryPointer.new(:string, 1024, true)
+      res = @@cdll.call(:get_midi_message, c_msg, 1024)
+      if res[0] > 0
+        vals = c_msg.read_string.bytes
+        vals.each_slice(3) do |ch, key, vel|
+          @midi.channel = ch if @midi.channel.nil? || @midi.channel != ch
+          @midi.current = key.to_i
+          @midi.set(key.to_i, vel.to_i)
+        end
+      elsif res[0] == -1 || res[0] == -2
+        raise CAPIErrors.new("VBVMR_GetMidiMessage returned #{msg[0]}")
+      end
+      res[0] > 0
+    end
+
+    alias_method "set_multi", :set_parameter_multi
+    alias_method "apply", :set_parameter_multi
+    alias_method "get", :get_parameter
+    alias_method "set", :set_parameter
+    alias_method "pdirty", :pdirty?
+    alias_method "mdirty", :mdirty?
+    alias_method "ldirty", :ldirty?
+  end
+end

data/lib/voicemeeter/button.rb

@@ -1,25 +1,25 @@
-require_relative "iremote"
-require_relative "meta"
-
-module Voicemeeter
-  class MacroButton < IRemote
-    include MacroButton_Meta_Functions
-
-    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
-
-    def getter(mode)
-      @remote.get_buttonstatus(@index, mode)
-    end
-
-    def setter(set, mode)
-      @remote.set_buttonstatus(@index, set, mode)
-    end
-  end
-end
+require_relative "iremote"
+require_relative "meta"
+
+module Voicemeeter
+  class MacroButton < IRemote
+    include MacroButton_Meta_Functions
+
+    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
+
+    def getter(mode)
+      @remote.get_buttonstatus(@index, mode)
+    end
+
+    def setter(set, mode)
+      @remote.set_buttonstatus(@index, set, mode)
+    end
+  end
+end

data/lib/voicemeeter/command.rb

@@ -1,38 +1,38 @@
-require_relative "iremote"
-require_relative "meta"
-
-module Voicemeeter
-  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
-end
+require_relative "iremote"
+require_relative "meta"
+
+module Voicemeeter
+  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
+end