voicemeeter_api_ruby 4.3.1 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfec081c74f1dbdd1b315bd0c3aeaff0b80da1e520b995c584d087f2753cb56e
-  data.tar.gz: 5e40c74ebc5d8aef7f153f278b3737387f43748604d073d35a308fa817a21627
+  metadata.gz: 2d5c6df9dba5f3f6bb249665cc26a6aeb8541c6e77712b4ff45f73452cfac8c4
+  data.tar.gz: a4c14273ab0cff0f004a68b4b9aa1816c087c775627bb2ab7872c8275b497859
 SHA512:
-  metadata.gz: 189d225992622d19c21d7eb6a3f81e08db74b5b5556b7f8794bcc3fe4c0efe17393fbd6897bae1c869d1b4ebef9eafae1433827a1ecafecb393e0349260bcfb8
-  data.tar.gz: 933d748eb4ca2bcae4081a35c4b3cc9258b08defa79fca143c0caced8ec3c00773c55acc086f71f36c9ede579515dca945dcd26de335ed825dedd8a2529294a3
+  metadata.gz: ad89a1cd012ccc74a42e7f8886c17a531e72b5af8180bba87e28da1df191dee74ac2b24d6531c11c0493e554652779a334241823d31af1e73718a76fc1bdbb11
+  data.tar.gz: d7f1d28cc751ed6d40d770f66691e2d012e71d9a29e72d236d2a7800fca3b19f1bbb536fa066e9b0b392a109e27df76be8658dca0605d41769afbe82670eb1a9

data/CHANGELOG.md

@@ -9,7 +9,26 @@ Before any major/minor/patch is released all unit tests will be run to verify th
 
 ## [Unreleased] - These changes have not been added to RubyGems yet
 
--   [ ]
+-   [ ] Add midi example
+
+## [4.4.0] - 2022-08-06
+
+### Added
+
+-   midi device support added.
+-   pdirty, mdirty, midi, ldirty kwargs added to Remote class. Initialize which events to sub to.
+-   Event class added. Toggle events, get list of currently subscribed.
+-   Voicemeeter.remote added to README in Remote class section.
+-   observer example updated to reflect changes.
+
+### Changed
+
+-   channel out props for strip/recorder now mixed in.
+-   By default no longer listen for level updates (high volume). Should be enabled explicitly.
+
+### Fixed
+
+-   bug in strip/bus levels if making capi calls directly.
 
 ## [4.3.0] - 2022-07-29
 

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
 
@@ -229,7 +229,7 @@ puts vm.bus[0].levels.all
 
 ### Strip | Bus
 
-The following methods are Available
+The following methods are available
 
 -   `fadeto(amount, time)`: float, int
 -   `fadeby(amount, time)`: float, int
@@ -266,7 +266,7 @@ The following properties accept boolean values.
 -   `A1 - A5`: boolean
 -   `B1 - A3`: boolean
 
-The following methods are Available
+The following methods are available
 
 -   `play`
 -   `stop`
@@ -356,6 +356,27 @@ example:
 vm.run { (0...vm.device.ins).each { |i| puts vm.device.input(i) } }
 ```
 
+### Midi
+
+The following properties are available:
+
+-   `channel`: int, returns the midi channel
+-   `current`: int, returns the current (or most recently pressed) key
+
+The following methods are available:
+
+-   `get(key)`: int, returns most recent velocity value for a key
+
+
+example:
+
+```ruby
+puts vm.midi.get(12)
+```
+
+get may return nil if no value for requested key in midi cache
+
+
 ### Multiple parameters
 
 -   `apply`
@@ -411,6 +432,58 @@ will load a config file at mydir/configs/banana/example.toml for Voicemeeter Ban
 
 ### Remote class
 
+#### Voicemeeter.remote
+
+You may pass the following optional keyword arguments:
+
+-   `sync`: boolean=false, force the getters to wait for dirty parameters to clear. For most cases leave this as false.
+-   `ratelimit`: float=0.033, how often to check for updates in ms.
+-   `pdirty`: boolean=true, parameter updates
+-   `mdirty`: boolean=true, macrobutton updates
+-   `midi`: boolean=true, midi updates
+-   `ldirty`: boolean=false, level updates
+
+
+#### Event updates
+
+To receive event updates you should do the following:
+
+-   register your app to receive updates using the `vm.add_observer(observer)` method, where observer is your app.
+-   define an `update(subject)` callback function in your app. The value of subject may be checked for the type of event.
+
+See `examples/observer` for a demonstration.
+
+Level updates are considered high volume, by default they are NOT listened for. However, polling them with strip levels and bus levels methods will still work.
+
+So if you don't wish to receive level updates, or you prefer to handle them yourself simply leave ldirty as default (False).
+
+Each of the update types may be enabled/disabled separately. Don't use a midi controller? You have the option to disable midi updates.
+
+example:
+
+```ruby
+require 'voicemeeter'
+# Set updates to occur every 50ms
+# Listen for level updates but disable midi updates
+vm = Voicemeeter.remote('banana', ratelimit: 0.05, ldirty: true, midi: false)
+vm.run { ... }
+```
+
+#### `vm.event`
+
+You may also add/remove event subscriptions as necessary with the Event class.
+
+example:
+
+```ruby
+vm.event.add("ldirty")
+
+vm.event.remove("pdirty")
+
+# get a list of currently subscribed
+p vm.event.get
+```
+
 Access to lower level Getters and Setters are provided with these functions:
 
 -   `vm.get(param, string=false)`: For getting the value of any parameter. Set string to true if getting a property value expected to return a string.
@@ -429,7 +502,7 @@ vm.set('Strip[4].Label', 'stripname')
 vm.set('Strip[0].Gain', -3.6)
 ```
 
-#### Voicemeeter::start
+#### Voicemeeter.start
 
 Use this function to start Voicemeeter of a kind independently of Remote class.
 for example:

data/lib/voicemeeter/base.rb

@@ -1,223 +1,211 @@
-require "observer"
-
-require_relative "runvm"
-require_relative "configs"
-require_relative "errors"
-
-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
-    attr_accessor :strip_mode
-
-    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
-      @p_in, @v_in = kind.layout[:strip].values
-      @p_out, @v_out = kind.layout[:bus].values
-      @cache = Hash.new
-      @sync = kwargs[:sync] || SYNC
-      @ratelimit = kwargs[:ratelimit] || RATELIMIT
-      @running = false
-      @strip_mode = 0
-      @delay = DELAY
-    end
-
-    def init_thread
-      @running = true
-      @cache["strip_level"], @cache["bus_level"] = _get_levels
-      Thread.new do
-        loop do
-          Thread.stop if !@running
-          if pdirty?
-            changed
-            notify_observers("pdirty")
-          end
-          if mdirty?
-            changed
-            notify_observers("mdirty")
-          end
-          if 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"
-        val = @@cdll.call(:get_num_indevices)
-      else
-        val = @@cdll.call(:get_num_outdevices)
-      end
-      val[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
-
-    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/bus.rb

@@ -82,10 +82,10 @@ module Voicemeeter
     end
 
     def getter(mode)
-      if @remote.running
+      if @remote.running && @remote.event.ldirty
         vals = @remote.cache["bus_level"][@init, @offset]
       else
-        vals = (@init...@offset).map { |i| @remote.get_level(mode, i) }
+        vals = (@init...@init + @offset).map { |i| @remote.get_level(mode, i) }
       end
       vals.map { |x| x > 0 ? (20 * Math.log(x, 10)).round(1) : -200.0 }
     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