voicemeeter_api_ruby 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74364d7c7210a1b080f7903862f4a1811105a3b7cb69fb572cbc729325e577ca
-  data.tar.gz: 87289218250b0177ed6064777edf199f02d40c69d84458185d6cff5f798d2fe0
+  metadata.gz: e1665d58c08963437a1f97aea620c0d92d660135c653791e136a8e16b468430e
+  data.tar.gz: 4c9b65a8bc057ecde1206007c48321ea90205828e7f5618279c283e621a35632
 SHA512:
-  metadata.gz: be94880faab9294919932abc5b1dc61177798f60deb2847c7672e6be0e7ca6dcc770e0a70983ab003ca098d8b08705b397ca3db3062b0756534dc881e5ed5725
-  data.tar.gz: 46f0cc75b33f53a4b35ac4f72064ac75f88dca55437b8c5727ae44c615bc0207546c9af8b9d83846750b777e186dc364008033b19c6688dfc55743ed73da2f9d
+  metadata.gz: 49412d436f0a24d23f68d06757f6b4c6f652ad1c3489f83483d98b1128f26e7d4c22db192248361ce223e57ee8c3cdf1ad4e3e513b3d6055e34fea8b0c5916ef
+  data.tar.gz: 7a95182d33363a4301a00c17329b0b782b084d9558d6fa348207508aec7d498a71644b5444677405d7e34282e5fd18fd9d825ecd9f30800b09c7e5aa15cd9669

data/CHANGELOG.md

@@ -5,13 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-Before any major/minor/patch is released all test units will be run to verify they pass.
+Before any major/minor/patch is released all unit tests will be run to verify they pass.
 
 ## [Unreleased] - These changes have not been added to RubyGems yet
 
--   [ ] Update Readme for version 3 changes.
+-   [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
 
-## [3.0.0] - 2022-01-24
+## [3.0.0] - 2022-05-03
 
 ### Added
 
@@ -171,7 +178,7 @@ README is up to date with version 2.0.2 onwards.
 
 ### Added
 
--   Added base0 test units for alias functions. This includes:
+-   Added base0 unit tests for alias functions. This includes:
     SetParamMultiBase0
     MacroButtonStatusWithAliasBase0
     SetParamMultiWithAliasBase0
@@ -185,7 +192,7 @@ README is up to date with version 2.0.2 onwards.
 
 ### Added
 
--   Base0 test units for each type.
+-   Base0 unit tests for each type.
 -   README updated to demonstrate set_multi, Macrobutton commands,
     Special commands and a brief description on how to run tests.
 
@@ -215,7 +222,7 @@ README is up to date with version 2.0.2 onwards.
 
 ### Added
 
--   test/<vbtype>/errors/errors_minitest.rb test unit files added to test
+-   test/<vbtype>/errors/errors_minitest.rb unit test files added to test
     custom error classes for each type of voicemeeter. Errors tests:
     APIError
     LoginError
@@ -267,5 +274,5 @@ README is up to date with version 2.0.2 onwards.
 
 -   Initial Commit
 -   Core of API
--   Test units
+-   Unit tests
 -   README.md

data/README.md

@@ -1,6 +1,8 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/voicemeeter-api-ruby/blob/dev/LICENSE)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/plugin-ruby)
 ![tests: failed count](https://img.shields.io/badge/dynamic/json?color=blue&label=tests&query=summary.failure_count&suffix=%20failed&url=https%3A%2F%2Fraw.githubusercontent.com%2Fonyx-and-iris%2Fvoicemeeter-api-ruby%2Fdev%2Fspec%2Frspec.json)
+[![Gem Version](https://badge.fury.io/rb/voicemeeter_api_ruby.svg)](https://badge.fury.io/rb/voicemeeter_api_ruby)
+![](https://ruby-gem-downloads-badge.herokuapp.com/voicemeeter_api_ruby?type=total&color=red)
 
 # Ruby Wrapper for Voicemeeter API
 
@@ -25,13 +27,13 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 Install voicemeeter_api_ruby gem from your console
 
-`gem install voicemeeter_api_ruby`
+`gem 'voicemeeter_api_ruby'`
 
 ### Bundler
 
 Put this in your Gemfile:
 
-`gem 'voicemeeter_api_ruby', require: false`
+`gem 'voicemeeter_api_ruby'`
 
 or use bundlers built in git functionality:
 
@@ -39,12 +41,11 @@ or use bundlers built in git functionality:
 
 ## `Use`
 
-Simplest use case, request a Remote class of a kind, then pass a block to run:
+Simplest use case, request a Remote class of a kind, then pass a block to run.
 
-as gem:
-`ruby .\main.rb`
-with bundler:
-`bundle exec ruby .\main.rb`
+Login and logout are handled for you in this scenario.
+
+#### `main.rb`
 
 ```ruby
 require 'voicemeeter'
@@ -54,21 +55,21 @@ kind_id = 'banana'
 # start Voicemeeter GUI
 Voicemeeter.start(kind_id)
 
-vmr = Voicemeeter.remote(kind_id)
+vm = Voicemeeter.remote(kind_id)
 
-# vmr.run accepts a block
-vmr.run do
+# vm.run accepts a block
+vm.run do
     # mute the leftmost strip
-    vmr.strip[0].mute = true
-    puts vmr.strip[0].mute
+    vm.strip[0].mute = true
+    puts vm.strip[0].mute
 
     # disable eq for second from left bus
-    vmr.bus[1].eq = false
-    puts vmr.bus[1].eq
+    vm.bus[1].eq = false
+    puts vm.bus[1].eq
 end
 ```
 
-Login and logout are handled for you in this scenario.
+Otherwise you must remember to call `vm.login` `vm.logout` at the start/end of your code.
 
 ## `kind_id`
 
@@ -80,18 +81,74 @@ Pass the kind of Voicemeeter as an argument. kind_id may be:
 
 ## `Available commands`
 
-### Channels (strip/bus)
+### Strip
 
-The following properties exist for audio channels.
+The following properties are available.
 
 -   `mono`: boolean
+-   `solo`: boolean
 -   `mute`: boolean
--   `gain`: float, from -60 to 12
--   `mc`, `k`: boolean
--   `comp`, `gate`: float, from 0 to 10
+-   `gain`: float, from -60.0 to 12.0
+-   `comp`: float, from 0.0 to 10.0
+-   `gate`: float, from 0.0 to 10.0
+-   `audibility`: float, from 0.0 to 10.0
 -   `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
+-   `mid`: float, from -12.0 to 12.0
+-   `treble`: float, from -12.0 to 12.0
+
+example:
+
+```ruby
+vm.strip[3].gain = 3.7
+puts vm.strip[0].label
+```
+
+The following methods are Available.
+
+-   `appgain(name, value)`: string, float, from 0.0 to 1.0
+
+Set the gain in db by value for the app matching name.
+
+-   `appmute(name, value)`: string, bool
+
+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)
+```
+
+##### Gainlayers
+
+-   `gain`: float, from -60.0 to 12.0
+
+example:
+
+```ruby
+vm.strip[3].gainlayer[3].gain = 3.7
+```
+
+Gainlayers are defined for potato version only.
+
+### Bus
+
+The following properties are available.
+
+-   `mono`: boolean
+-   `mute`: boolean
 -   `eq`: boolean
+-   `eq_ab`: boolean
+-   `sel`: boolean
+-   `gain`: float, from -60.0 to 12.0
 -   `label`: string
 -   `device`: string
 -   `sr`: int
@@ -99,10 +156,46 @@ The following properties exist for audio channels.
 example:
 
 ```ruby
-vmr.strip[3].gain = 3.7
-puts strip[0].label
+vm.bus[3].gain = 3.7
+puts vm.bus[0].label
 
-vmr.bus[4].mono = true
+vm.bus[4].mono = true
+```
+
+##### Modes
+
+-   `normal`: boolean
+-   `amix`: boolean
+-   `bmix`: boolean
+-   `composite`: boolean
+-   `tvmix`: boolean
+-   `upmix21`: boolean
+-   `upmix41`: boolean
+-   `upmix61`: boolean
+-   `centeronly`: boolean
+-   `lfeonly`: boolean
+-   `rearonly`: boolean
+
+example:
+
+```ruby
+vm.bus[4].mode.amix = true
+```
+
+### Strip | Bus
+
+The following methods are Available
+
+-   `fadeto(amount, time)`: float, int
+-   `fadeby(amount, time)`: float, int
+
+Modify gain to or by the selected amount in db over a time interval in ms.
+
+example:
+
+```ruby
+vm.strip[0].fadeto(-10.3, 1000)
+vm.bus[3].fadeby(-5.6, 500)
 ```
 
 ### Macrobuttons
@@ -116,12 +209,18 @@ Three modes defined: state, stateonly and trigger.
 example:
 
 ```ruby
-vmr.button[37].state = true
-vmr.button[55].trigger = false
+vm.button[37].state = true
+vm.button[55].trigger = false
 ```
 
 ### Recorder
 
+The following properties accept boolean values.
+
+-   `loop`: boolean
+-   `A1 - A5`: boolean
+-   `B1 - A3`: boolean
+
 The following methods are Available
 
 -   `play`
@@ -130,34 +229,31 @@ The following methods are Available
 -   `record`
 -   `ff`
 -   `rew`
-    The following properties accept boolean values.
--   `loop`: boolean
--   `A1 - A5`: boolean
--   `B1 - A3`: boolean
-    Load accepts a string:
--   `load`: string
+-   `load(filepath)`: string
 
 example:
 
 ```ruby
-vmr.recorder.play
-vmr.recorder.stop
+vm.recorder.play
+vm.recorder.stop
 
 # Enable loop play
-vmr.recorder.loop = True
+vm.recorder.loop = True
 
 # Disable recorder out channel B2
-vmr.recorder.B2 = False
+vm.recorder.B2 = False
 
 # filepath as string
-vmr.recorder.load('C:\music\mytune.mp3')
+vm.recorder.load('C:\music\mytune.mp3')
 ```
 
 ### VBAN
 
--   `vmr.vban.enable` `vmr.vban.disable` Turn VBAN on or off
+-   `vm.vban.enable` `vm.vban.disable` Turn VBAN on or off
+
+##### Instream | Outstream
 
-For each vban in/out stream the following properties are defined:
+The following properties are available.
 
 -   `on`: boolean
 -   `name`: string
@@ -175,13 +271,13 @@ example:
 
 ```ruby
 # turn VBAN on
-vmr.vban.enable
+vm.vban.enable
 
 # turn on vban instream 0
-vmr.vban.instream[0].on = True
+vm.vban.instream[0].on = True
 
 # set bit property for outstream 3 to 24
-vmr.vban.outstream[3].bit = 24
+vm.vban.outstream[3].bit = 24
 ```
 
 ### Command
@@ -200,8 +296,19 @@ The following properties are write only and accept boolean values.
 example:
 
 ```ruby
-vmr.command.restart
-vmr.command.showvbanchat = true
+vm.command.restart
+vm.command.showvbanchat = true
+```
+
+### Device
+
+-   `ins` `outs` : Returns the number of input/output devices
+-   `input(i)` `output(i)` : Returns a hash of device properties for device[i]
+
+example:
+
+```ruby
+vm.run { (0...vm.device.ins).each { |i| puts vm.device.input(i) } }
 ```
 
 ### Multiple parameters
@@ -210,7 +317,7 @@ vmr.command.showvbanchat = true
     Set many strip/bus/macrobutton/vban parameters at once, for example:
 
 ```ruby
-vmr.set_multi(
+vm.set_multi(
     {
         strip_0: {
             mute: true,
@@ -235,30 +342,46 @@ vmr.set_multi(
 Or for each class you may do:
 
 ```ruby
-vmr.strip[0].set_multi(mute: true, gain: 3.2, A1: true)
-vmr.vban.outstream[0].set_multi(on: true, name: 'streamname', bit: 24)
+vm.strip[0].set_multi(mute: true, gain: 3.2, A1: true)
+vm.vban.outstream[0].set_multi(on: true, name: 'streamname', bit: 24)
 ```
 
+## Config Files
+
+`vm.set_config(<configname>)`
+
+You may load config files in TOML format.
+Three example configs have been included with the package. Remember to save
+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') }
+```
+
+will load a config file at configs/banana/example.toml for Voicemeeter Banana.
+
 ## `Voicemeeter Module`
 
 ### Remote class
 
 Access to lower level Getters and Setters are provided with these functions:
 
--   `vmr.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.
--   `vmr.set(param, value)`: For setting the value of any parameter.
+-   `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.
+-   `vm.set(param, value)`: For setting the value of any parameter.
 
 Access to lower level polling functions are provided with these functions:
 
--   `vmr.pdirty?`: Returns true if a parameter has been updated.
--   `vmr.mdirty?`: Returns true if a macrobutton has been updated.
+-   `vm.pdirty?`: Returns true if a parameter has been updated.
+-   `vm.mdirty?`: Returns true if a macrobutton has been updated.
 
 example:
 
 ```ruby
-vmr.get('Strip[2].Mute')
-vmr.set('Strip[4].Label', 'stripname')
-vmr.set('Strip[0].Gain', -3.6)
+vm.get('Strip[2].Mute')
+vm.set('Strip[4].Label', 'stripname')
+vm.set('Strip[0].Gain', -3.6)
 ```
 
 #### Voicemeeter::start
@@ -271,24 +394,6 @@ require 'voicemeeter'
 Voicemeeter.start('banana')
 ```
 
-## Config Files
-
-`vmr.set_profile('config')`
-
-You may load config files in TOML format.
-Three example profiles have been included with the package. Remember to save
-current settings before loading a profile. To test them simply rename \_profiles
-directory to profiles. They will be loaded into memory but not set. To set one
-you may do:
-
-```ruby
-require 'voicemeeter'
-vmr = Voicemeeter.remote('banana')
-vmr.run { vmr.set_profile('config') }
-```
-
-will load a config file at profiles/banana/config.toml for Voicemeeter Banana.
-
 ### Run tests
 
 To run all tests:
@@ -305,4 +410,4 @@ Bundle exec rspec --tag 'higher'
 
 ### Official Documentation
 
--   [Voicemeeter Remote C API](https://forum.vb-audio.com/viewtopic.php?f=8&t=346)
+-   [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)

data/lib/base.rb

@@ -1,12 +1,8 @@
+require 'observer'
+
 require_relative 'runvm'
-require_relative 'profiles'
+require_relative 'configs'
 require_relative 'errors'
-require_relative 'strip'
-require_relative 'bus'
-require_relative 'button'
-require_relative 'vban'
-require_relative 'command'
-require_relative 'recorder'
 
 class Base
     '
@@ -14,17 +10,18 @@ class Base
 
     Mixin required modules
     '
-    include Profiles
+    include Observable
+    include Configs
     include RunVM
 
-    attr_accessor :strip, :bus, :button, :vban, :command, :recorder
+    attr_accessor :strip, :bus, :button, :vban, :command, :recorder, :device
 
-    attr_reader :kind, :retval, :cache, :profiles, :delay
+    attr_reader :kind, :retval, :cache, :delay
 
     DELAY = 0.001
     SYNC = false
+    RATELIMIT = 0.033
     SIZE = 1
-    BUFF = 512
 
     def initialize(kind, **kwargs)
         @kind = kind
@@ -32,16 +29,33 @@ class Base
         @p_out, @v_out = kind.layout[:bus].values
         @cache = Hash.new
         @sync = kwargs[:sync] || SYNC
+        @ratelimit = kwargs[:ratelimit] || RATELIMIT
         @delay = DELAY
-        @profiles = get_profiles(@kind)
-        @cdll =
-            lambda do |func, *args|
-                self.retval = [send("vmr_#{func}", *args), func]
+        @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')
+        @@cdll.call(:login)
         clear_polling
     rescue CAPIErrors => error
         case
@@ -56,18 +70,35 @@ class Base
     def logout
         clear_polling
         sleep(0.1)
-        @cdll.call('logout')
+        @@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, BUFF, true)
-                @cdll.call('get_parameter_string', name, c_get)
+                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)
+                @@cdll.call(:get_parameter_float, name, c_get)
                 c_get.read_float.round(1)
             end
         end
@@ -75,9 +106,9 @@ class Base
 
     def set_parameter(name, value)
         if value.is_a? String
-            @cdll.call('set_parameter_string', name, value)
+            @@cdll.call(:set_parameter_string, name, value)
         else
-            @cdll.call('set_parameter_float', name, value.to_f)
+            @@cdll.call(:set_parameter_float, name, value.to_f)
         end
         @cache.store(name, value)
     end
@@ -85,13 +116,13 @@ class Base
     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)
+            @@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)
+        @@cdll.call(:set_buttonstatus, id, state, mode)
         @cache.store("mb_#{id}_#{mode}", state)
     end
 
@@ -124,13 +155,13 @@ class Base
 
     def get_level(type, index)
         c_get = FFI::MemoryPointer.new(:float, SIZE)
-        @cdll.call('get_level', type, index, c_get)
+        @@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, 
+        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) }
@@ -143,9 +174,36 @@ class Base
         (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', :pdirty?
+    alias_method 'mdirty', :mdirty?
 end