voicemeeter_api_ruby 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1665d58c08963437a1f97aea620c0d92d660135c653791e136a8e16b468430e
-  data.tar.gz: 4c9b65a8bc057ecde1206007c48321ea90205828e7f5618279c283e621a35632
+  metadata.gz: e855e458e3debb64c2fe076bcad06c73643f8750c60d9a719f1eb5bb95ab3886
+  data.tar.gz: 68a4ff2917b5f62a7e1846d09b9dff380e7e5991f6403fabf55e350ef99f65be
 SHA512:
-  metadata.gz: 49412d436f0a24d23f68d06757f6b4c6f652ad1c3489f83483d98b1128f26e7d4c22db192248361ce223e57ee8c3cdf1ad4e3e513b3d6055e34fea8b0c5916ef
-  data.tar.gz: 7a95182d33363a4301a00c17329b0b782b084d9558d6fa348207508aec7d498a71644b5444677405d7e34282e5fd18fd9d825ecd9f30800b09c7e5aa15cd9669
+  metadata.gz: 8d9297aaf1dbc13b231f1aa0b3388f58b13ae5fcbfb630a4bb7bfdb4b6d29ea559ef3b58c7c2df2725d6dc7d16a0369549c2fa331caf128b3c784e63315cbcd0
+  data.tar.gz: a430dccd4348bc9d04ec2e54f6579d66df12227ff25d7d38577e979e88e1135ff68537346d8a6be9b67cd90b131bb43f6d58e1a7a91280ac14728c800e7990a1

data/CHANGELOG.md

@@ -9,14 +9,45 @@ 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
 
--   [x] type, version added to base class
--   [x] device class implemented
--   [x] common interface iremote defined
--   [x] configs reworked. configs are now loaded lazily.
--   [x] TOMLStrBuilder added to config, builds a default reset config
--   [x] command.reset now applies reset config from toml parser.
--   [x] profiles dir renamed to configs
--   [x] major version bump
+-   [ ] add xy parameters to strip/bus
+
+## [4.1.0] - 2022-07-19
+
+### Added
+
+-   Conversion module in meta
+-   strip/bus levels implemented, ldirty added to notifications.
+
+### Changed
+
+-   1, 0 switched for true false in example configs
+-   observer example updated.
+-   minor version bump
+
+### Removed
+
+-   Boolean class monkey patch
+-   type checks
+
+## [4.0.0] - 2022-06-27
+
+### Added
+
+-   type, version added to base class
+-   device class implemented
+-   TOMLStrBuilder added to config, builds a default reset config
+-   support for observers to subscribe to updates
+-   observer example added
+-   device, sr, sel added to bus
+-   audibility, bass, mid, treble added to strip
+
+### Changed
+
+-   common interface iremote defined
+-   configs reworked. configs are now loaded lazily.
+-   command.reset now applies reset config from toml parser.
+-   profiles dir renamed to configs
+-   major version bump due to non-backwards compatible changes
 
 ## [3.0.0] - 2022-05-03
 

data/README.md

@@ -23,21 +23,17 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Installation
 
-### Gem
-
-Install voicemeeter_api_ruby gem from your console
-
-`gem 'voicemeeter_api_ruby'`
-
 ### Bundler
 
 Put this in your Gemfile:
 
 `gem 'voicemeeter_api_ruby'`
 
-or use bundlers built in git functionality:
+### Gem
+
+Install voicemeeter_api_ruby gem from your console
 
-`gem "voicemeeter_api_ruby", :git => "git://github.com/onyx-and-iris/voicemeeter-api-ruby"`
+`gem install 'voicemeeter_api_ruby'`
 
 ## `Use`
 
@@ -110,7 +106,7 @@ vm.strip[3].gain = 3.7
 puts vm.strip[0].label
 ```
 
-The following methods are Available.
+The following methods are available.
 
 -   `appgain(name, value)`: string, float, from 0.0 to 1.0
 
@@ -123,8 +119,8 @@ Set mute state as value for the app matching name.
 example:
 
 ```ruby
-vm.strip[5].appmute('Spotify', true)
 vm.strip[5].appgain('Spotify', 0.5)
+vm.strip[5].appmute('Spotify', true)
 ```
 
 ##### Gainlayers
@@ -139,6 +135,22 @@ vm.strip[3].gainlayer[3].gain = 3.7
 
 Gainlayers are defined for potato version only.
 
+##### Levels
+
+The following properties are available.
+
+-   `prefader`
+-   `postfader`
+-   `postmute`
+
+example:
+
+```ruby
+puts vm.strip[3].levels.prefader
+```
+
+Level properties will return -200.0 if no audio detected.
+
 ### Bus
 
 The following properties are available.
@@ -182,6 +194,20 @@ example:
 vm.bus[4].mode.amix = true
 ```
 
+##### Levels
+
+The following properties are available.
+
+-   `all`
+
+example:
+
+```ruby
+puts vm.bus[0].levels.all
+```
+
+`levels.all` will return -200.0 if no audio detected.
+
 ### Strip | Bus
 
 The following methods are Available
@@ -357,7 +383,7 @@ current settings before loading a config. To set one you may do:
 ```ruby
 require 'voicemeeter'
 vm = Voicemeeter.remote('banana')
-vm.run { vm.set_profile('example') }
+vm.run { vm.set_config('example') }
 ```
 
 will load a config file at configs/banana/example.toml for Voicemeeter Banana.

data/lib/base.rb

@@ -1,209 +1,218 @@
-require 'observer'
-
-require_relative 'runvm'
-require_relative 'configs'
-require_relative 'errors'
-
-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_reader :kind, :retval, :cache, :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
-        @delay = DELAY
-        @running = true
-    end
-
-    def init_thread
-        Thread.new do
-            loop do
-                Thread.stop if !@running
-                if pdirty?
-                    changed
-                    notify_observers('pdirty')
-                elsif mdirty?
-                    changed
-                    notify_observers('mdirty')
-                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 strip_levels
-        '
-        Returns the full level array for strips, PREFADER mode,
-        before math conversion
-        '
-        (0...(2 * @p_in + 8 * @v_in)).map { |i| get_level(0, i) }
-    end
-
-    def bus_levels
-        '
-        Returns the full level array for buses, before math conversion
-        '
-        (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 'get', :get_parameter
-    alias_method 'set', :set_parameter
-    alias_method 'pdirty', :pdirty?
-    alias_method 'mdirty', :mdirty?
-end
+require 'observer'
+
+require_relative 'runvm'
+require_relative 'configs'
+require_relative 'errors'
+
+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 = 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
+    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')
+                elsif mdirty?
+                    changed
+                    notify_observers('mdirty')
+                elsif 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 do |x, i|
+                            !(x == @bus_buf[i])
+                        end
+                    @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
+        s = (0...(2 * @p_in + 8 * @v_in)).map { |i| get_level(0, i) }
+        b = (0...(8 * (@p_out + @v_out))).map { |i| get_level(3, i) }
+        [s, b]
+    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 'get', :get_parameter
+    alias_method 'set', :set_parameter
+    alias_method 'pdirty', :pdirty?
+    alias_method 'mdirty', :mdirty?
+    alias_method 'ldirty', :ldirty?
+end