voicemeeter_api_ruby 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3a0e9817ffa5ec8ae524a4af3fe6a64f9f85277a83cb6e39c64f7746006a564
-  data.tar.gz: eecdc15368fb025b6632961ab3df850ac505e79de105f472569e6b0678dd96d9
+  metadata.gz: feb89f841882b2ece4f1bc959c8a5a728a738b054798635d2937ff9dceacf37c
+  data.tar.gz: 382ba6af1cde36e8b450d0549e383f9e6c68040d8385923ec8b2c413ddfc3d1b
 SHA512:
-  metadata.gz: 390dda38c9597c3996d913b3c5c0462307ffd7df102ca5fad2879e76b682104b373ecb5c9b0879911cee20622decfece3f0756082d7d1c85e3ad349ace1a547f
-  data.tar.gz: fd2bf7bfb8bd6157f4dc54e22e1636629ae7a934c466752ddc2f3fda23b9abebef31f5002435dcc4d75075fe792e34aad78295296c5910b107a72adad261750b
+  metadata.gz: 719e6d87cf5514dc7d759bdf15bf75ae32a533686894c172e4c1d4151dc2b7c480e8967a0d0d41a4187a0df2ff7f4094a3bc9520f86cf7f75c0604f00b711b7e
+  data.tar.gz: 728b8458b2897592282c24b944a0d1a3dca0af14791c0c3c73a1d1eb474a9462f4f24eecd5aa3caad2fec024f111998dedac8e057b5d092f727a763feda6ab5e

data/lib/base.rb

@@ -1,11 +1,18 @@
+require 'toml'
 require 'ffi'
 require_relative 'inst'
 
 include InstallationFunctions
 
+
 module Base
+    """
+    Perform low level tasks.
+    """
     extend FFI::Library
 
+    $kinds_all = ["basic", "banana", "potato"]
+
     begin
         OS_BITS = get_arch
         VM_PATH = get_vmpath(OS_BITS)
@@ -48,32 +55,29 @@ module Base
     DELAY = 0.001
     MAX_POLLS = 8
 
-    def cache=(value)
-        @cache = value
-    end
-
-    def pdirty
+    def pdirty?
         return vmr_pdirty&.nonzero?
     end
 
-    def mdirty
+    def mdirty?
         return vmr_mdirty&.nonzero?
     end
 
+    private
     def clear_polling
-        while self.pdirty || self.mdirty
+        while self.pdirty? || self.mdirty?
         end
     end
 
-    def polling(func, name=nil, id=nil, mode=nil)
+    def polling(func, **kwargs)
         params = {
-            "get_parameter" => name,
-            "macro_getstatus" => "mb_#{id}_#{mode}"
+            "get_parameter" => kwargs[:name],
+            "macro_getstatus" => "mb_#{kwargs[:id]}_#{kwargs[:mode]}"
         }
-        MAX_POLLS.times do |i|
+        @max_polls.times do |i|
             if @cache.key? params[func]
-                if func.include?('param') && self.pdirty ||
-                func.include?('macro') && self.mdirty
+                if func.include?('param') && self.pdirty? ||
+                func.include?('macro') && self.mdirty?
                     return @cache.delete(params[func])[0]
                 end
                 sleep(DELAY)
@@ -82,7 +86,7 @@ module Base
         end
 
         val = yield
-        self.cache.store(params[func], [val, false])
+        @cache.store(params[func], [val, false])
         val
     end
 
@@ -101,38 +105,41 @@ module Base
 end
 
 module Define_Version
+    """
+    Defines the console layout for a specific kind of Voicemeeter.
+    """
     include Base
-
+    private
     def define_version(kind)
         case kind
         when "basic"
-            self.properties = {
+            @properties = {
                 :name => kind,
-                :exe => "voicemeeter.exe"
+                :exe => "voicemeeter.exe",
             }
-            self.layout = {
+            @layout = {
                 :strip => {:p_in => 2, :v_in=> 1},
                 :bus => {:p_out => 1, :v_out=> 1},
                 :vban => {:instream => 4, :outstream => 4},
                 :mb => 70,
             }
         when "banana"
-            self.properties = {
+            @properties = {
                 :name => kind,
-                :exe => "voicemeeterpro.exe"
+                :exe => "voicemeeterpro.exe",
             }
-            self.layout = {
+            @layout = {
                 :strip => {:p_in => 3, :v_in=> 2},
                 :bus => {:p_out => 3, :v_out=> 2},
                 :vban => {:instream => 8, :outstream => 8},
                 :mb => 70,
             }
         when "potato"
-            self.properties = {
+            @properties = {
                 :name => kind,
-                :exe => "voicemeeter8#{OS_BITS == 64 ? "x64" : ""}.exe"
+                :exe => "voicemeeter8#{OS_BITS == 64 ? "x64" : ""}.exe",
             }
-            self.layout = {
+            @layout = {
                 :strip => {:p_in => 5, :v_in=> 3},
                 :bus => {:p_out => 5, :v_out=> 3},
                 :vban => {:instream => 8, :outstream => 8},
@@ -141,3 +148,24 @@ module Define_Version
         end
     end
 end
+
+
+module Profiles
+    include Define_Version
+    private
+    def get_profiles
+        filepath = File.join(File.dirname(__dir__), "/profiles/#{@properties[:name]}/*.toml")
+
+        Dir.glob(filepath).to_h do |toml_file|
+            filename = File.basename(toml_file, ".toml")
+            puts "loading profile #{@properties[:name]}/#{filename}"
+            [filename, TOML::Parser.new(File.read(toml_file)).parsed]
+        end
+    end
+    public
+    def set_profile(value)
+        raise VMRemoteErrors.new("No profile with name #{value} was loaded") unless @profiles.key? value
+        self.send("set_multi", @profiles[value])
+        sleep(DELAY)
+    end 
+end

data/lib/bus.rb

@@ -2,13 +2,14 @@ require_relative 'channel'
 
 
 class Bus < IChannel
+    """
+    Concrete class for Bus objects
+    """
     def self.make(remote, layout_bus)
         "
         Factory function for Bus classes.
         "
-        p_out = layout_bus[:p_out]
-        v_out = layout_bus[:v_out]
-        
+        p_out, v_out = layout_bus.map { |k, v| v }
         (0...(p_out + v_out)).map do |i|
             i < p_out ? \
             PhysicalBus.new(remote, i) : \
@@ -20,6 +21,7 @@ class Bus < IChannel
         super
         self.make_accessor_bool :mute, :mono, :eq
         self.make_accessor_float :gain
+        self.make_accessor_string :label
     end
 
     def cmd

data/lib/button.rb

@@ -23,6 +23,7 @@ class IMacroButton
         param_hash.each do |(key,val)|
             self.send("#{key}=", val)
         end
+        sleep(remote.delay)
     end
 end
 
@@ -38,4 +39,4 @@ class MacroButton < IMacroButton
         super
         self.make_accessor_macrobutton :state, :stateonly, :trigger 
     end
-end
+end

data/lib/channel.rb

@@ -2,6 +2,9 @@ require_relative 'meta'
 require_relative 'errors'
 
 class IChannel
+    """
+    Base class for audio channels
+    """
     include Channel_Meta_Functions
 
     attr_accessor :remote, :index

data/lib/errors.rb

@@ -34,4 +34,4 @@ module Errors
             end
         end
     end
-end
+end

data/lib/inst.rb

@@ -4,11 +4,8 @@ require_relative 'errors'
 
 include Errors
 
-BASIC = 1
-BANANA = 2
-POTATO = 3
-
 module InstallationFunctions
+    private
     def get_arch
         key = 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment'
         Win32::Registry::HKEY_LOCAL_MACHINE.open(key) do |reg|
@@ -23,7 +20,6 @@ module InstallationFunctions
     def get_vmpath(os_bits)
         vm_key = "VB:Voicemeeter {17359A74-1236-5467}"
         reg_key = "Software#{os_bits == 64 ? "\\WOW6432Node" : ""}\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\"
-
         Win32::Registry::HKEY_LOCAL_MACHINE.open(reg_key + vm_key) do |reg|           
             value = reg["UninstallString"]
 

data/lib/meta.rb

@@ -1,16 +1,20 @@
 require_relative 'errors'
 
+class FalseClass; def to_i; 0 end end
+class TrueClass; def to_i; 1 end end
+
 module Meta_Functions
+    private
     def make_accessor_bool(*params)
         params.each do |param|
             define_singleton_method("#{param}") do
                 return !(self.getter("#{param}")).zero?
             end
 
-            opts = [false, true]
+            opts = [false, true, 0, 1]
             define_singleton_method("#{param}=") do |value|
                 raise OutOfBoundsErrors.new(opts) unless opts.include? value
-                self.setter("#{param}", value ? 1 : 0)
+                self.setter("#{param}", value.to_i == 1 ? 1 : 0)
             end
         end
     end
@@ -64,12 +68,10 @@ module Meta_Functions
         end
     end
 
-    def _make_channel_props(num_A, num_B)
-        channels = (1..(num_A + num_B)).map.each do |i|
+    def make_channel_props(num_A, num_B)
+        (1..(num_A + num_B)).map do |i|
             i <= num_A ? "A#{i}" : "B#{i - num_A}"
         end
-
-        self.make_accessor_bool *channels
     end
 end
 
@@ -88,10 +90,10 @@ module Channel_Meta_Functions
                 return !(self.getter("#{val}")).zero?
             end
 
-            opts = [false, true]
+            opts = [false, true, 0, 1]
             define_singleton_method("#{param}=") do |value|
                 raise OutOfBoundsErrors.new(opts) unless opts.include? value
-                self.setter("#{val}", value ? 1 : 0)
+                self.setter("#{val}", value.to_i == 1 ? 1 : 0)
             end
         end
     end
@@ -214,10 +216,10 @@ module MacroButton_Meta_Functions
                 return !(self.getter(mode[param])).zero?
             end
 
-            opts = [false, true]
+            opts = [false, true, 0, 1]
             define_singleton_method("#{param}=") do |value|
                 raise OutOfBoundsErrors.new(opts[param]) unless opts.include? value
-                self.setter(value ? 1 : 0, mode[param])
+                self.setter(value.to_i == 1 ? 1 : 0, mode[param])
             end
         end
     end
@@ -243,7 +245,7 @@ module Commands_Meta_Functions
             opts = [false, true]
             define_singleton_method("#{param}=") do |value|
                 raise OutOfBoundsErrors.new(opts) unless opts.include? value
-                self.setter("#{param}", value ? 1 : 0)
+                self.setter("#{param}", value.to_i == 1 ? 1 : 0)
             end
         end
     end

data/lib/recorder.rb

@@ -2,6 +2,9 @@ require_relative 'meta'
 
 
 class IRecorder
+    """
+    Base class for Recorder object
+    """
     include Meta_Functions
 
     attr_accessor :remote
@@ -25,13 +28,15 @@ end
 
 
 class Recorder < IRecorder
-    def initialize(remote, layout_bus)
+    """
+    Concrete class for recorder
+    """
+    def initialize(remote)
         super(remote)
         self.make_writer_only :play, :stop, :record, :ff, :rew
 
-        num_A = layout_bus[:p_out]
-        num_B = layout_bus[:v_out]
-        self._make_channel_props(num_A, num_B)
+        num_A, num_B = remote.layout[:bus].map { |k, v| v }
+        self.make_accessor_bool *make_channel_props(num_A, num_B)
     end
 
     def cmd

data/lib/routines.rb

@@ -10,25 +10,29 @@ require_relative 'recorder'
 
 class Routines
     """
-    define basic behaviours of API functions
-    mixin modules
+    Define basic behaviours of API functions
+
+    Mixin required modules
     """
-    include Define_Version
+    include Profiles
     include RunVM
 
-    attr_accessor :properties, :layout, :strip, :bus, :button, :vban, :command,
-    :recorder
+    attr_accessor :strip, :bus, :button, :vban, :command, :recorder
 
-    attr_reader :retval, :cache, :wait
+    attr_reader :retval, :cache, :wait, :layout, :properties,
+    :delay, :max_polls, :profiles
 
     SIZE = 1
     BUFF = 512
 
-    def initialize(kind)
+    def initialize(kind, **kwargs)
         define_version(kind)
 
-        self.cache = Hash.new
+        @cache = Hash.new
         @wait = true
+        @delay = kwargs[:delay] || DELAY
+        @max_polls = kwargs[:max_polls] || MAX_POLLS
+        @profiles = get_profiles
     end
 
     def login
@@ -38,7 +42,8 @@ class Routines
     rescue CAPIErrors => error
         case
         when error.value == 1
-            run_voicemeeter
+            self.start(@properties[:name])
+            clear_polling
         when error.value < 0
             raise
         end
@@ -50,7 +55,7 @@ class Routines
     end
 
     def get_parameter(name, is_string=false)
-        self.polling("get_parameter", name) do
+        self.polling("get_parameter", name: name) do
             if is_string
                 c_get = FFI::MemoryPointer.new(:string, BUFF, true)
                 run_as("get_parameter_string", name, c_get)
@@ -69,11 +74,11 @@ class Routines
         else    
             run_as("set_parameter_float", name, value.to_f)
         end
-        self.cache.store(name, [value, true])
+        @cache.store(name, [value, true])
     end
 
     def macro_getstatus(id, mode)
-        self.polling("macro_getstatus", name=nil, id, mode) do
+        self.polling("macro_getstatus", id: id, mode: mode) do
             c_get = FFI::MemoryPointer.new(:float, SIZE)
             run_as("macro_getstatus", id, c_get, mode)
             c_get.read_float.to_i
@@ -82,7 +87,7 @@ class Routines
 
     def macro_setstatus(id, state, mode)
         run_as("macro_setstatus", id, state, mode)
-        self.cache.store("mb_#{id}_#{mode}", [state, true])
+        @cache.store("mb_#{id}_#{mode}", [state, true])
     end
 
     def set_parameter_multi(param_hash)
@@ -109,7 +114,10 @@ class Routines
         end
         @wait = true
     end
+
     alias_method "set_multi", :set_parameter_multi
-    alias_method "set", :set_parameter
     alias_method "get", :get_parameter
+    alias_method "set", :set_parameter
+    alias_method "pdirty", :pdirty?
+    alias_method "mdirty", :pdirty?
 end

data/lib/runvm.rb

@@ -1,20 +1,18 @@
-require 'open3'
-require_relative 'errors'
 require_relative 'base'
 
-module RunVM
-    include Base
+include Base
 
-    def run_voicemeeter
-        if VM_PATH.join(@properties[:exe]).executable?
-            exe_path = String(VM_PATH.join(@properties[:exe]))
-        else
-            raise InstallErrors.new("Could not find Voicemeeter exe file")
+module RunVM
+    """
+    Starts Voicemeeter of the Kind requested.
+    """
+    def start(kind)
+        enums = $kinds_all.map.with_index do |val, i|
+            get_arch == 64 && val == "potato" ? [val, i+4] : [val, i+1]
         end
+        exes = enums.to_h { |k, v| [k, v.to_i] }
 
-        Open3.popen3(exe_path, '')
+        run_as('runvm', exes[kind])
         sleep(1)
-
-        clear_polling
     end
 end

data/lib/strip.rb

@@ -2,30 +2,29 @@ require_relative 'channel'
 
 
 class Strip < IChannel
-    attr_reader :num_A, :num_B
-
-    def self.make(remote, layout_strip, out_channels)
+    """
+    Concrete class for Strip objects
+    """
+    def self.make(remote, layout_strip)
         "
         Factory function for Strip classes.
         "
-        p_in = layout_strip[:p_in]
-        v_in = layout_strip[:v_in]
-        num_A = out_channels[:p_out]
-        num_B = out_channels[:v_out]
-
+        p_in, v_in = layout_strip.map { |k, v| v }
         (0...(p_in + v_in)).map do |i|
             i < p_in ? \
-            PhysicalStrip.new(remote, i, num_A, num_B) : \
-            VirtualStrip.new(remote, i, num_A, num_B) 
+            PhysicalStrip.new(remote, i) : \
+            VirtualStrip.new(remote, i) 
         end
     end
 
-    def initialize(remote, i, num_A, num_B)
-        super(remote, i)
+    def initialize(remote, i)
+        super
         self.make_accessor_bool :solo, :mute, :mono
         self.make_accessor_float :gain
         self.make_accessor_string :label
-        self._make_channel_props(num_A, num_B)
+
+        num_A, num_B = remote.layout[:bus].map { |k, v| v }
+        self.make_accessor_bool *make_channel_props(num_A, num_B)
     end
 
     def cmd
@@ -34,7 +33,7 @@ class Strip < IChannel
 end
 
 class PhysicalStrip < Strip
-    def initialize(remote, i, num_A, num_B)
+    def initialize(remote, i)
         super
         self.make_accessor_float :comp, :gate
         self.make_accessor_int :limit
@@ -43,7 +42,7 @@ class PhysicalStrip < Strip
 end
 
 class VirtualStrip < Strip
-    def initialize(remote, i, num_A, num_B)
+    def initialize(remote, i)
         super
         self.make_accessor_bool :mc, :k
     end

data/lib/vban.rb

@@ -3,6 +3,9 @@ require_relative 'errors'
 
 
 class IVban
+    """
+    Base class for Vban objects
+    """
     include Vban_Meta_Functions
 
     attr_accessor :remote, :index
@@ -37,6 +40,9 @@ end
 
 
 class Vban < IVban
+    """
+    Concrete class for Vban objects
+    """
     def self.make(remote, vban_streams)
         "
         Factory function for Vban class.

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Voicemeeter_API_Ruby
-    VERSION = '2.0.3'
+    VERSION = '2.0.4'
 end

data/lib/voicemeeter.rb

@@ -1,22 +1,38 @@
 require_relative 'routines'
 require_relative 'errors'
 
+
 module Voicemeeter
+    include RunVM
+
+    private
     class Remote < Routines
-        def self.make
-            ["basic", "banana", "potato"].to_h do |kind|
-                [kind, Remote.new(kind)]
+        """
+        Remote class, subclasses Routines
+
+        Console layout built according to version definition.
+
+        Offers a run method for resource closure.
+        """
+        def self.make(**kwargs)
+            """
+            Factory function that generates a remote class for each kind.
+
+            Returns a hash of Remote classes.
+            """
+            $kinds_all.to_h do |kind|
+                [kind, Remote.new(kind, **kwargs)]
             end
         end
 
         def initialize(kind)
             super
-            self.strip = Strip.make(self, @layout[:strip], @layout[:bus])
+            self.strip = Strip.make(self, @layout[:strip])
             self.bus = Bus.make(self, @layout[:bus])
             self.button = MacroButton.make(self, @layout[:mb])
             self.vban = Vban.make(self, @layout[:vban])
             self.command = Command.new(self)
-            self.recorder = Recorder.new(self, @layout[:bus])
+            self.recorder = Recorder.new(self)
         end
 
         def run
@@ -27,13 +43,18 @@ module Voicemeeter
         end
     end
 
-    def remote(kind)
-        _remotes = Remote.make
+    public
+    def remote(kind, **kwargs)
+        """
+        Request a Remote for a specific kind and login to the API
+        """
+        _remotes = Remote.make(**kwargs)
+
+        raise VMRemoteErrors.new("Unknown Voicemeeter Kind.") unless _remotes.key? kind
 
-        raise VMRemoteErrors.new("Unknown Voicemeeter Kind") unless _remotes[kind]
         _remotes[kind].login
         return _remotes[kind]
     end
 
-    module_function :remote
+    module_function :remote, :start
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voicemeeter_api_ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.10
+- !ruby/object:Gem::Dependency
+  name: toml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement