voicemeeter_api_ruby 4.4.3 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25d30480b41b65b719d0a8f76d87767c3dc9aad60c3074be0ff7d61434368f88
-  data.tar.gz: 62023ace8700d6ad5fd3e77098661f2e8df7bd5a9bf97a132168b6723dbd38f4
+  metadata.gz: 853191cf2f0496441c9db529fb2863f29f769088107e704f779cd3fa602baf4a
+  data.tar.gz: ac9610c2aa4bf7a3319dbd7677774b5b52d579970d58412447357e9d67443830
 SHA512:
-  metadata.gz: eccdfc9d875372183b18ce1739cf509c91b0a78c98417ec90b6963d8902c66930ca18f99414415040ff1f61654957f7aa073d58faf3d9bd28737ca0d3e4b3736
-  data.tar.gz: 4132a9c07c9344f7a5b53662dffb4820a91f242a8f34aad0fe55cdc296dc2ee506db220d6a3dfc3b1f95a21a9deeb5c7513cdb86f815d28db750710b4f43e23a
+  metadata.gz: 4dddc3aaa0fb7e600c489b0c0773a542447e9ff6fe1e839783b45f8766742a21d1354846daf5a2a3ee08f43ee85fc2272326ed6a696201eaa741f6b5002a1299
+  data.tar.gz: ab40474cf35aede927799ce48465a482269345803ec79692ccbe0da6bb082368545000a8622286530c08d9a8764b3e983c91383c89caf603d3432799a6d4fda0

data/CHANGELOG.md

@@ -9,7 +9,22 @@ 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.6.0] - 2022-10-17
+
+### Added
+
+-   StripDevice, BusDevice classes.
+-   midi example
+-   logger module to dependencies.
+-   README updated to reflect changes.
+
+### Changed
+
+-   log level info to examples.
+-   bus levels now printed in observer example.
+-   Event add/remove methods now accept multiple events.
 
 ## [4.4.0] - 2022-08-06
 

data/README.md

@@ -91,8 +91,6 @@ The following properties are available.
 -   `limit`: int, from -40 to 12
 -   `A1 - A5`, `B1 - B3`: boolean
 -   `label`: string
--   `device`: string
--   `sr`: int
 -   `mc`: boolean
 -   `k`: int, from 0 to 4
 -   `bass`: float, from -12.0 to 12.0
@@ -176,8 +174,6 @@ The following properties are available.
 -   `sel`: boolean
 -   `gain`: float, from -60.0 to 12.0
 -   `label`: string
--   `device`: string
--   `sr`: int
 -   `returnreverb`: float, from 0.0 to 10.0
 -   `returndelay`: float, from 0.0 to 10.0
 -   `returnfx1`: float, from 0.0 to 10.0
@@ -243,6 +239,24 @@ vm.strip[0].fadeto(-10.3, 1000)
 vm.bus[3].fadeby(-5.6, 500)
 ```
 
+#### Strip.Device | Bus.Device
+
+The following properties are available
+
+-   `name`: str
+-   `sr`: int
+-   `wdm`: str
+-   `ks`: str
+-   `mme`: str
+-   `asio`: str
+
+example:
+
+```ruby
+puts vm.strip[0].device.name
+vm.bus[0].device.asio = "Audient USB Audio ASIO Driver"
+```
+
 ### Macrobuttons
 
 Three modes defined: state, stateonly and trigger.
@@ -428,62 +442,90 @@ vm.run { vm.apply_config('example') }
 
 will load a config file at mydir/configs/banana/example.toml for Voicemeeter Banana.
 
-## `Voicemeeter Module`
+## Events
 
-### Remote class
+Level updates are considered high volume, by default they are NOT listened for.
 
-#### Voicemeeter.remote
+Use keyword args `pdirty`, `mdirty`, `midi`, `ldirty` to initialize event updates.
 
-You may pass the following optional keyword arguments:
+example:
 
--   `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
+```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.add_observer`|`vm.delete_observer`
 
-#### Event updates
+Use the add_observer/delete_observer methods to register/deregister an app as an observer.
 
-To receive event updates you should do the following:
+example:
 
--   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.
+```ruby
+# register an app to receive updates
+class App():
+    def initialize(vm)
+        @vm = vm
+        @vm.add_observer(self)
+        ...
+```
 
-See `examples/observer` for a demonstration.
+#### `vm.event`
 
-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.
+Use the event class to toggle updates as necessary.
 
-So if you don't wish to receive level updates, or you prefer to handle them yourself simply leave ldirty as default (False).
+The following properties are available:
 
-Each of the update types may be enabled/disabled separately. Don't use a midi controller? You have the option to disable midi updates.
+-   `pdirty`: boolean
+-   `mdirty`: boolean
+-   `midi`: boolean
+-   `ldirty`: boolean
 
 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.ldirty = true
+
+vm.event.pdirty = false
 ```
 
-#### `vm.event`
+Or add, remove an array of events.
 
-You may also add/remove event subscriptions as necessary with the Event class.
+The following methods are available:
+
+-   `add()`
+-   `remove()`
+-   `get()`
 
 example:
 
 ```ruby
-vm.event.add("ldirty")
+vm.event.add(%w[pdirty mdirty midi ldirty])
 
-vm.event.remove("pdirty")
+vm.event.remove(%w[pdirty mdirty midi ldirty])
 
 # get a list of currently subscribed
 p vm.event.get
 ```
 
+## `Voicemeeter Module`
+
+### 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
+
 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.

data/lib/voicemeeter/base.rb

@@ -45,9 +45,14 @@ module Voicemeeter
       @event = Event.new(**kwargs)
     end
 
+    def to_s
+      "Voicemeeter #{@kind.name.capitalize}"
+    end
+
     def login
       @@cdll.call(:login)
       clear_polling
+      LOGGER.info("Logged into Voiceemeter #{self}")
     rescue CAPIErrors => error
       case
       when error.value == 1
@@ -62,6 +67,7 @@ module Voicemeeter
       clear_polling
       sleep(0.1)
       @@cdll.call(:logout)
+      LOGGER.info("Logged out of Voiceemeter #{self}")
     end
 
     def type

data/lib/voicemeeter/bus.rb

@@ -9,7 +9,7 @@ module Voicemeeter
     include Mixin::Fades
     include Mixin::Return
 
-    attr_accessor :mode, :levels
+    attr_accessor :mode, :levels, :device
 
     def self.make(remote, layout_bus)
       "
@@ -39,7 +39,7 @@ module Voicemeeter
   class PhysicalBus < Bus
     def initialize(remote, i)
       super
-      self.make_reader_only :device, :sr
+      @device = BusDevice.new(remote, i)
     end
   end
 
@@ -96,4 +96,18 @@ module Voicemeeter
 
     def isdirty? = @remote._bus_comp[@init, @offset].any?
   end
+
+  class BusDevice < IRemote
+    include Channel_Meta_Functions
+
+    def initialize(remote, i)
+      super
+      self.make_reader_only :name, :sr
+      self.make_writer_only :wdm, :ks, :mme, :asio
+    end
+
+    def identifier
+      "bus[#{@index}].device"
+    end
+  end
 end

data/lib/voicemeeter/cbindings.rb

@@ -31,7 +31,10 @@ module Voicemeeter
     attach_function :vm_logout, :VBVMR_Logout, [], :long
     attach_function :vm_runvm, :VBVMR_RunVoicemeeter, [:long], :long
     attach_function :vm_vmtype, :VBVMR_GetVoicemeeterType, [:pointer], :long
-    attach_function :vm_vmversion, :VBVMR_GetVoicemeeterVersion, [:pointer], :long
+    attach_function :vm_vmversion,
+                    :VBVMR_GetVoicemeeterVersion,
+                    [:pointer],
+                    :long
 
     attach_function :vm_mdirty, :VBVMR_MacroButton_IsDirty, [], :long
     attach_function :vm_get_buttonstatus,
@@ -69,7 +72,10 @@ module Voicemeeter
 
     attach_function :vm_get_level, :VBVMR_GetLevel, %i[long long pointer], :long
 
-    attach_function :vm_get_num_indevices, :VBVMR_Input_GetDeviceNumber, [], :long
+    attach_function :vm_get_num_indevices,
+                    :VBVMR_Input_GetDeviceNumber,
+                    [],
+                    :long
     attach_function :vm_get_desc_indevices,
                     :VBVMR_Input_GetDeviceDescA,
                     %i[long pointer pointer pointer],
@@ -89,10 +95,7 @@ module Voicemeeter
                     %i[pointer long],
                     :long
 
-    @@cdll =
-      lambda { |func, *args| retval = [send("vm_#{func}", *args), func] }
-
-    def clear_polling = while pdirty? || mdirty?; end
+    @@cdll = lambda { |func, *args| retval = [send("vm_#{func}", *args), func] }
 
     def polling(func, **kwargs)
       params = {
@@ -109,7 +112,11 @@ module Voicemeeter
     def retval=(values)
       " Writer validation for CAPI calls "
       retval, func = *values
-      unless %i[get_num_indevices get_num_outdevices get_midi_message].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
@@ -117,6 +124,10 @@ module Voicemeeter
 
     public
 
+    def clear_polling =
+      while pdirty? || mdirty?
+      end
+
     def pdirty? = vm_pdirty&.nonzero?
 
     def mdirty? = vm_mdirty&.nonzero?
@@ -124,8 +135,10 @@ module Voicemeeter
     def ldirty?
       @strip_buf, @bus_buf = _get_levels
       return(
-        !(@cache["strip_level"] == @strip_buf && @cache["bus_level"] == @bus_buf)
+        !(
+          @cache["strip_level"] == @strip_buf && @cache["bus_level"] == @bus_buf
+        )
       )
     end
   end
-end
+end

data/lib/voicemeeter/event.rb

@@ -1,6 +1,6 @@
 module Voicemeeter
   class Event
-    attr_accessor :pdirty, :mdirty, :midi, :ldirty
+    attr_reader :pdirty, :mdirty, :midi, :ldirty
 
     def initialize(pdirty: true, mdirty: true, midi: true, ldirty: false)
       @pdirty = pdirty
@@ -13,23 +13,52 @@ module Voicemeeter
       "#{self.class.name.split("::").last}#{@index}"
     end
 
-    def info(msg)
-      info_msg = ["#{msg} events", "Now listening for #{get.join(", ")} events"]
-      puts info_msg.join("\n")
+    def info(msg = nil)
+      info_msg = msg ? ["#{msg} events."] : []
+      if any?
+        info_msg += ["Now listening for #{get.join(", ")} events"]
+      else
+        info_msg += ["Not listening for any events"]
+      end
+      LOGGER.info(info_msg.join(" "))
+    end
+
+    def pdirty=(val)
+      @pdirty = val
+      info("pdirty #{val ? "added to" : "removed from"}")
+    end
+
+    def mdirty=(val)
+      @mdirty = val
+      info("mdirty #{val ? "added to" : "removed from"}")
+    end
+
+    def ldirty=(val)
+      @ldirty = val
+      info("ldirty #{val ? "added to" : "removed from"}")
+    end
+
+    def midi=(val)
+      @midi = val
+      info("midi #{val ? "added to" : "removed from"}")
     end
 
     def get
       %w[pdirty mdirty midi ldirty].reject { |ev| !send("#{ev}") }
     end
 
-    def add(event)
-      send("#{event}=", true)
-      info("#{event} added to")
+    def any?
+      [pdirty, mdirty, midi, ldirty].any?
+    end
+
+    def add(events)
+      events = [events] if !events.respond_to? :each
+      events.each { |ev| send("#{ev}=", true) }
     end
 
-    def remove(event)
-      send("#{event}=", false)
-      info("#{event} removed from")
+    def remove(events)
+      events = [events] if !events.respond_to? :each
+      events.each { |ev| send("#{ev}=", false) }
     end
   end
 end

data/lib/voicemeeter/meta.rb

@@ -114,19 +114,12 @@ module Voicemeeter
 
     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 :name
+            return self.getter("#{param}", true)
           when :sr
-            return self.getter("#{cmd}").to_i
+            return self.getter("#{param}").to_i
           end
         end
       end

data/lib/voicemeeter/strip.rb

@@ -10,7 +10,7 @@ module Voicemeeter
     include Mixin::Outputs
     include Mixin::Fades
 
-    attr_accessor :gainlayer, :levels
+    attr_accessor :gainlayer, :levels, :device
 
     def self.make(remote, layout_strip)
       "
@@ -45,7 +45,8 @@ module Voicemeeter
     def initialize(remote, i)
       super
       self.make_accessor_float :comp, :gate, :audibility
-      self.make_reader_only :device, :sr
+
+      @device = StripDevice.new(remote, i)
     end
   end
 
@@ -121,4 +122,18 @@ module Voicemeeter
 
     def isdirty? = @remote._strip_comp[@init, @offset].any?
   end
+
+  class StripDevice < IRemote
+    include Channel_Meta_Functions
+
+    def initialize(remote, i)
+      super
+      self.make_reader_only :name, :sr
+      self.make_writer_only :wdm, :ks, :mme, :asio
+    end
+
+    def identifier
+      "strip[#{@index}].device"
+    end
+  end
 end

data/lib/voicemeeter/version.rb

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

data/lib/voicemeeter/worker.rb

@@ -1,7 +1,7 @@
 module Voicemeeter
   module Worker
     def init_worker
-      puts "Listening for #{@event.get.join(", ")} events"
+      LOGGER.info("Listening for #{@event.get.join(", ")} events")
       @cache["strip_level"], @cache["bus_level"] = _get_levels
       @running = true
       Thread.new do

data/lib/voicemeeter.rb

@@ -1,3 +1,5 @@
+require "logger"
+
 require_relative "voicemeeter/base"
 require_relative "voicemeeter/strip"
 require_relative "voicemeeter/bus"
@@ -7,3 +9,10 @@ require_relative "voicemeeter/command"
 require_relative "voicemeeter/recorder"
 require_relative "voicemeeter/device"
 require_relative "voicemeeter/remote"
+
+module Voicemeeter
+  include Logger::Severity
+
+  LOGGER = Logger.new(STDOUT)
+  LOGGER.level = WARN
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voicemeeter_api_ruby
 version: !ruby/object:Gem::Version
-  version: 4.4.3
+  version: 4.6.0
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -58,6 +58,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement