voicemeeter_api_ruby 4.3.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfec081c74f1dbdd1b315bd0c3aeaff0b80da1e520b995c584d087f2753cb56e
-  data.tar.gz: 5e40c74ebc5d8aef7f153f278b3737387f43748604d073d35a308fa817a21627
+  metadata.gz: 4b5218c12fdf2ff6d99a68ce6ac4e896f8fc213848c17301bbaaf1897b71446b
+  data.tar.gz: 66f1a8e56633c592e9fd78b0188ac5061328e6324dd7b23eaee7077a33228e1f
 SHA512:
-  metadata.gz: 189d225992622d19c21d7eb6a3f81e08db74b5b5556b7f8794bcc3fe4c0efe17393fbd6897bae1c869d1b4ebef9eafae1433827a1ecafecb393e0349260bcfb8
-  data.tar.gz: 933d748eb4ca2bcae4081a35c4b3cc9258b08defa79fca143c0caced8ec3c00773c55acc086f71f36c9ede579515dca945dcd26de335ed825dedd8a2529294a3
+  metadata.gz: efab5bb8f17a001f170cbf5f257ff523c1647a42b77dd962f1e95329b38b76ccfd458f5b18f9f66342e544b1e9fd6e1a2c4037a1411309f7a616e3c2b26e2ffc
+  data.tar.gz: b3a47db4e3cfa1f82baa9dfda397be0a0b64fd9fa91d4c483c387c97e99004f47efd8dc06c6fac077feef6f3c92c35d484ee27fd03eb4415b35abd13f928605d

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

@@ -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

@@ -3,6 +3,8 @@ require "observer"
 require_relative "runvm"
 require_relative "configs"
 require_relative "errors"
+require_relative "event"
+require_relative "midi"
 
 module Voicemeeter
   class Base
@@ -15,8 +17,15 @@ module Voicemeeter
     include Configs
     include RunVM
 
-    attr_accessor :strip, :bus, :button, :vban, :command, :recorder, :device
-    attr_accessor :strip_mode
+    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
@@ -28,31 +37,38 @@ module Voicemeeter
 
     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
-      @cache = Hash.new
-      @sync = kwargs[:sync] || SYNC
-      @ratelimit = kwargs[:ratelimit] || RATELIMIT
       @running = false
       @strip_mode = 0
       @delay = DELAY
+      @cache = Hash.new
+      @midi = Midi.new
+      @event = Event.new(**kwargs)
     end
 
     def init_thread
-      @running = true
+      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 pdirty?
+          if @event.pdirty && pdirty?
             changed
             notify_observers("pdirty")
           end
-          if mdirty?
+          if @event.mdirty && mdirty?
             changed
             notify_observers("mdirty")
           end
-          if ldirty?
+          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|
@@ -190,11 +206,11 @@ module Voicemeeter
         raise VMRemoteErrors.new("expected in or out")
       end
       if direction == "in"
-        val = @@cdll.call(:get_num_indevices)
+        res = @@cdll.call(:get_num_indevices)
       else
-        val = @@cdll.call(:get_num_outdevices)
+        res = @@cdll.call(:get_num_outdevices)
       end
-      val[0]
+      res[0]
     end
 
     def get_device_description(index, direction)
@@ -212,6 +228,22 @@ module Voicemeeter
       [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

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/cbindings.rb

@@ -84,6 +84,11 @@ module Voicemeeter
                     %i[long pointer pointer pointer],
                     :long
 
+    attach_function :vm_get_midi_message,
+                    :VBVMR_GetMidiMessage,
+                    %i[pointer long],
+                    :long
+
     @@cdll =
       lambda { |func, *args| retval = [send("vm_#{func}", *args), func] }
 
@@ -104,7 +109,7 @@ module Voicemeeter
     def retval=(values)
       " Writer validation for CAPI calls "
       retval, func = *values
-      unless %i[get_num_indevices get_num_outdevices].include? func
+      unless %i[get_num_indevices get_num_outdevices get_midi_message].include? func
         raise CAPIErrors.new(retval, func) if retval&.nonzero?
       end
       @retval = retval

data/lib/voicemeeter/event.rb

@@ -0,0 +1,31 @@
+module Voicemeeter
+  class Event
+    attr_accessor :pdirty, :mdirty, :midi, :ldirty
+
+    def initialize(pdirty: true, mdirty: true, midi: true, ldirty: false)
+      @pdirty = pdirty
+      @mdirty = mdirty
+      @midi = midi
+      @ldirty = ldirty
+    end
+
+    def info(msg)
+      info_msg = ["#{msg} events", "Now listening for #{get.join(", ")} events"]
+      puts info_msg.join("\n")
+    end
+
+    def get
+      %w[pdirty mdirty midi ldirty].reject { |ev| !send("#{ev}") }
+    end
+
+    def add(event)
+      send("#{event}=", true)
+      info("#{event} added to")
+    end
+
+    def remove(event)
+      send("#{event}=", false)
+      info("#{event} removed from")
+    end
+  end
+end

data/lib/voicemeeter/midi.rb

@@ -0,0 +1,17 @@
+module Voicemeeter
+  class Midi
+    attr_accessor :cache, :current, :channel
+
+    def initialize
+      @cache = Hash.new
+    end
+
+    def get(key)
+      @cache[key]
+    end
+
+    def set(key, vel)
+      @cache[key] = vel
+    end
+  end
+end

data/lib/voicemeeter/mixin.rb

@@ -24,8 +24,10 @@ module Voicemeeter
 
     module Outputs
       include Channel_Meta_Functions
-      def initialize(remote, i = nil)
+
+      def initialize(*args)
         super
+        remote, *rem = args
         num_A, num_B = remote.kind.layout[:bus].values
         channels =
           (1..(num_A + num_B)).map do |i|

data/lib/voicemeeter/strip.rb

@@ -96,10 +96,10 @@ module Voicemeeter
     end
 
     def get_level(mode)
-      if @remote.running
+      if @remote.running && @remote.event.ldirty
         vals = @remote.cache["strip_level"][@init, @offset]
       else
-        vals = (@init...@offset).map { |i| 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/version.rb

@@ -7,11 +7,11 @@ module Voicemeeter
     end
 
     def minor
-      3
+      4
     end
 
     def patch
-      1
+      0
     end
 
     def to_a

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voicemeeter_api_ruby
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.0
 platform: ruby
 authors:
 - onyx_online
@@ -93,10 +93,12 @@ files:
 - lib/voicemeeter/configs.rb
 - lib/voicemeeter/device.rb
 - lib/voicemeeter/errors.rb
+- lib/voicemeeter/event.rb
 - lib/voicemeeter/inst.rb
 - lib/voicemeeter/iremote.rb
 - lib/voicemeeter/kinds.rb
 - lib/voicemeeter/meta.rb
+- lib/voicemeeter/midi.rb
 - lib/voicemeeter/mixin.rb
 - lib/voicemeeter/recorder.rb
 - lib/voicemeeter/runvm.rb