voicemeeter_api_ruby 4.1.5 → 4.2.0

data/lib/voicemeeter/inst.rb

@@ -0,0 +1,27 @@
+require "win32/registry"
+require "pathname"
+require "voicemeeter/errors"
+
+module Voicemeeter
+  module InstallationFunctions
+    private
+
+    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"]
+
+        pn = Pathname.new(value)
+        return pn.dirname
+      end
+      raise InstallErrors.new("Could not get the Voicemeeter path")
+    end
+
+    def vm_dll=(value)
+      raise InstallErrors.new("Could not fetch the dll file") unless value.file?
+      @vm_dll = value
+    end
+  end
+end

data/lib/voicemeeter/iremote.rb

@@ -0,0 +1,34 @@
+require "voicemeeter/meta"
+require "voicemeeter/errors"
+
+module Voicemeeter
+  class IRemote
+    "
+    Common interface between base class and higher classes.
+    "
+    include Meta_Functions
+
+    def initialize(remote, i = nil)
+      @remote = remote
+      @index = i
+    end
+
+    def getter(param, is_string = false)
+      @remote.get_parameter("#{self.identifier}.#{param}", is_string)
+    end
+
+    def setter(param, value)
+      @remote.set_parameter("#{self.identifier}.#{param}", value)
+    end
+
+    def identifier
+      raise "Called abstract method: identifier"
+    end
+
+    def set_multi(param_hash)
+      param_hash.each { |(key, val)| self.send("#{key}=", val) }
+    end
+
+    alias_method "apply", :set_multi
+  end
+end

data/lib/{meta.rb → voicemeeter/meta.rb}

@@ -1,4 +1,4 @@
-require_relative "errors"
+require "voicemeeter/errors"
 
 module Conversions
   module_function
@@ -37,6 +37,7 @@ module Meta_Functions
       define_singleton_method("#{param}") do
         return self.getter("#{param}").to_i
       end
+
       define_singleton_method("#{param}=") do |value|
         self.setter("#{param}", value)
       end
@@ -46,6 +47,7 @@ module Meta_Functions
   def make_accessor_float(*params)
     params.each do |param|
       define_singleton_method("#{param}") { return self.getter("#{param}") }
+
       define_singleton_method("#{param}=") do |value|
         self.setter("#{param}", value)
       end
@@ -57,6 +59,7 @@ module Meta_Functions
       define_singleton_method("#{param}") do
         return self.getter("#{param}", true)
       end
+
       define_singleton_method("#{param}=") do |value|
         self.setter("#{param}", value)
       end
@@ -91,7 +94,6 @@ end
 module Channel_Meta_Functions
   private
 
-  include Conversions
   include Meta_Functions
 
   def make_accessor_bool(*params)
@@ -113,28 +115,6 @@ module Channel_Meta_Functions
     end
   end
 
-  def make_accessor_float(*params)
-    params.each do |param|
-      define_singleton_method("#{param}") { return self.getter("#{param}") }
-
-      define_singleton_method("#{param}=") do |value|
-        self.setter("#{param}", value)
-      end
-    end
-  end
-
-  def make_accessor_int(*params)
-    params.each do |param|
-      define_singleton_method("#{param}") do
-        return self.getter("#{param}").to_i
-      end
-
-      define_singleton_method("#{param}=") do |value|
-        self.setter("#{param}", value)
-      end
-    end
-  end
-
   def make_reader_only(*params)
     params.each do |param|
       cmds = { device: "device.name", sr: "device.sr" }
@@ -172,7 +152,6 @@ end
 module Vban_Meta_Functions
   private
 
-  include Conversions
   include Meta_Functions
 
   def make_reader_int(*params)
@@ -256,7 +235,6 @@ end
 module Commands_Meta_Functions
   private
 
-  include Conversions
   include Meta_Functions
   def make_writer_bool(*params)
     params.each do |param|

data/lib/voicemeeter/recorder.rb

@@ -0,0 +1,22 @@
+require "voicemeeter/iremote"
+require "voicemeeter/meta"
+
+module Voicemeeter
+  class Recorder < IRemote
+    "
+    Concrete Recorder class
+    "
+
+    def initialize(remote)
+      super
+      self.make_action_prop :play, :stop, :record, :ff, :rew
+
+      num_A, num_B = remote.kind.layout[:bus].values
+      self.make_accessor_bool *make_channel_props(num_A, num_B)
+    end
+
+    def identifier
+      :recorder
+    end
+  end
+end

data/lib/{runvm.rb → voicemeeter/runvm.rb}

@@ -1,7 +1,7 @@
-require_relative "cbindings"
-require_relative "kinds"
+require "voicemeeter/cbindings"
+require "voicemeeter/kinds"
 
-include CBindings
+include Voicemeeter::CBindings
 include Kinds
 
 module RunVM

data/lib/voicemeeter/strip.rb

@@ -0,0 +1,137 @@
+require "voicemeeter/iremote"
+
+module Voicemeeter
+  class Strip < IRemote
+    "
+    Concrete Strip class
+    "
+    include Channel_Meta_Functions
+
+    attr_accessor :gainlayer, :levels
+
+    def self.make(remote, layout_strip)
+      "
+      Factory function for Strip classes.
+      "
+      p_in, v_in = layout_strip.values
+      (0...(p_in + v_in)).map do |i|
+        i < p_in ? PhysicalStrip.new(remote, i) : VirtualStrip.new(remote, i)
+      end
+    end
+
+    def initialize(remote, i)
+      super
+      self.make_accessor_bool :solo, :mute, :mono
+      self.make_accessor_float :gain
+      self.make_accessor_int :limit
+      self.make_accessor_string :label
+
+      num_A, num_B = remote.kind.layout[:bus].values
+      self.make_accessor_bool *make_channel_props(num_A, num_B)
+
+      @gainlayer = (0...8).map { |j| GainLayer.new(remote, i, j) }
+      @levels = StripLevels.new(remote, i)
+    end
+
+    def identifier
+      "strip[#{@index}]"
+    end
+
+    def fadeto(target, time)
+      self.setter("FadeTo", "(#{target}, #{time})")
+      sleep(@remote.delay)
+    end
+
+    def fadeby(change, time)
+      self.setter("FadeBy", "(#{change}, #{time})")
+      sleep(@remote.delay)
+    end
+  end
+
+  class PhysicalStrip < Strip
+    def initialize(remote, i)
+      super
+      self.make_accessor_float :comp, :gate, :audibility
+      self.make_reader_only :device, :sr
+    end
+  end
+
+  class VirtualStrip < Strip
+    def initialize(remote, i)
+      super
+      self.make_accessor_bool :mc
+      self.make_accessor_int :k
+      self.make_accessor_float :bass, :mid, :treble
+    end
+
+    def appgain(name, gain)
+      self.setter("AppGain", "(\"#{name}\", #{gain})")
+    end
+
+    def appmute(name, mute)
+      self.setter("AppMute", "(\"#{name}\", #{mute ? 1 : 0})")
+    end
+  end
+
+  class GainLayer < IRemote
+    def initialize(remote, i, j)
+      super(remote, i)
+      @j = j
+    end
+
+    def identifier
+      "strip[#{@index}]"
+    end
+
+    def gain
+      self.getter("gainlayer[#{@j}]")
+    end
+
+    def gain=(value)
+      self.setter("gainlayer[#{@j}]", value)
+    end
+  end
+
+  class StripLevels < IRemote
+    def initialize(remote, i)
+      super
+      if i < @remote.p_in
+        @init = i * 2
+        @offset = 2
+      else
+        @init = (@remote.p_in * 2) + ((i - @remote.p_in) * 8)
+        @offset = 8
+      end
+    end
+
+    def identifier
+      "strip[#{@index}]"
+    end
+
+    def get_level(mode)
+      if @remote.running
+        vals = @remote.cache["strip_level"][@init, @offset]
+      else
+        vals = (@init...@offset).map { |i| get_level(mode, i) }
+      end
+      vals.map { |x| x > 0 ? (20 * Math.log(x, 10)).round(1) : -200.0 }
+    end
+
+    def prefader
+      @remote.strip_mode = 0
+      get_level(0)
+    end
+
+    def postfader
+      @remote.strip_mode = 1
+      get_level(1)
+    end
+
+    def postmute
+      @remote.strip_mode = 2
+      get_level(2)
+    end
+
+    def isdirty? = @remote._strip_comp[@init, @offset].any?
+  end
+end

data/lib/voicemeeter/vban.rb

@@ -0,0 +1,80 @@
+require "voicemeeter/iremote"
+require "voicemeeter/meta"
+require "voicemeeter/errors"
+
+module Voicemeeter
+  class VbanStream < IRemote
+    "
+    A class representing a VBAN stream
+    "
+    include Vban_Meta_Functions
+
+    def initialize(remote, i)
+      super
+      self.make_accessor_bool :on
+      self.make_accessor_string :name, :ip
+      self.make_accessor_int :quality, :route
+    end
+
+    def identifier
+      "vban.#{self.direction}stream[#{@index}]"
+    end
+
+    def direction
+      raise "Called abstract mehod: direction"
+    end
+  end
+
+  class VbanInstream < VbanStream
+    "
+    A subclass representing a VBAN Instream
+    "
+    def initialize(remote, i)
+      super
+      self.make_reader_int :sr, :channel, :bit
+    end
+
+    def direction
+      :in
+    end
+  end
+
+  class VbanOutstream < VbanStream
+    "
+    A subclass representing a VBAN Outstream
+    "
+    def initialize(remote, i)
+      super
+      self.make_accessor_int :sr, :channel, :bit
+    end
+
+    def direction
+      :out
+    end
+  end
+
+  class Vban
+    attr_accessor :instream, :outstream
+
+    def initialize(remote, vban_streams)
+      "
+      Initializes a Vban class
+
+      Creates an array for each in/out stream
+      "
+      vban_in, vban_out = vban_streams.values
+      self.instream = (0...vban_in).map { |i| VbanInstream.new(remote, i) }
+      self.outstream = (0...vban_out).map { |i| VbanOutstream.new(remote, i) }
+
+      @remote = remote
+    end
+
+    def enable
+      @remote.set_parameter("vban.enable", 1)
+    end
+
+    def disable
+      @remote.set_parameter("vban.enable", 0)
+    end
+  end
+end

data/lib/{version.rb → voicemeeter/version.rb}

@@ -1,3 +1,3 @@
 module Voicemeeter_API_Ruby
-  VERSION = "4.1.5"
+  VERSION = "4.2.0"
 end

data/lib/voicemeeter.rb

@@ -1,11 +1,11 @@
-require_relative "base"
-require_relative "strip"
-require_relative "bus"
-require_relative "button"
-require_relative "vban"
-require_relative "command"
-require_relative "recorder"
-require_relative "device"
+require "voicemeeter/base"
+require "voicemeeter/strip"
+require "voicemeeter/bus"
+require "voicemeeter/button"
+require "voicemeeter/vban"
+require "voicemeeter/command"
+require "voicemeeter/recorder"
+require "voicemeeter/device"
 
 module Voicemeeter
   include RunVM

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voicemeeter_api_ruby
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.2.0
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -84,24 +84,24 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- lib/base.rb
-- lib/bus.rb
-- lib/button.rb
-- lib/cbindings.rb
-- lib/command.rb
-- lib/configs.rb
-- lib/device.rb
-- lib/errors.rb
-- lib/inst.rb
-- lib/iremote.rb
-- lib/kinds.rb
-- lib/meta.rb
-- lib/recorder.rb
-- lib/runvm.rb
-- lib/strip.rb
-- lib/vban.rb
-- lib/version.rb
 - lib/voicemeeter.rb
+- lib/voicemeeter/base.rb
+- lib/voicemeeter/bus.rb
+- lib/voicemeeter/button.rb
+- lib/voicemeeter/cbindings.rb
+- lib/voicemeeter/command.rb
+- lib/voicemeeter/configs.rb
+- lib/voicemeeter/device.rb
+- lib/voicemeeter/errors.rb
+- lib/voicemeeter/inst.rb
+- lib/voicemeeter/iremote.rb
+- lib/voicemeeter/kinds.rb
+- lib/voicemeeter/meta.rb
+- lib/voicemeeter/recorder.rb
+- lib/voicemeeter/runvm.rb
+- lib/voicemeeter/strip.rb
+- lib/voicemeeter/vban.rb
+- lib/voicemeeter/version.rb
 homepage: https://rubygems.org/gems/voicemeeter_api_ruby
 licenses:
 - MIT

data/lib/base.rb

@@ -1,220 +0,0 @@
-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
-
-  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
-    @delay = DELAY
-  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")
-        end
-        if mdirty?
-          changed
-          notify_observers("mdirty")
-        end
-        if 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 { |x, i| !(x == @bus_buf[i]) }
-          @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(@strip_mode, 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 "apply", :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