voicemeeter_api_ruby 2.0.3 → 4.0.0

data/lib/base.rb

@@ -1,143 +1,209 @@
-require 'ffi'
-require_relative 'inst'
-
-include InstallationFunctions
-
-module Base
-    extend FFI::Library
-
-    begin
-        OS_BITS = get_arch
-        VM_PATH = get_vmpath(OS_BITS)
-        DLL_NAME = "VoicemeeterRemote#{OS_BITS == 64 ? "64" : ""}.dll"
-
-        self.vmr_dll = VM_PATH.join(DLL_NAME)
-    rescue InstallErrors => error
-        puts "ERROR: #{error.message}"
-        raise
-    end
-
-    ffi_lib @vmr_dll
-    ffi_convention :stdcall
-
-    attach_function :vmr_login, :VBVMR_Login, [], :long
-    attach_function :vmr_logout, :VBVMR_Logout, [], :long
-    attach_function :vmr_runvm, :VBVMR_RunVoicemeeter, [:long], :long
-    attach_function :vmr_vmtype, :VBVMR_GetVoicemeeterType, [:pointer], :long
-
-    attach_function :vmr_mdirty, :VBVMR_MacroButton_IsDirty, [], :long
-    attach_function :vmr_macro_setstatus, :VBVMR_MacroButton_SetStatus, \
-    [:long, :float, :long], :long
-    attach_function :vmr_macro_getstatus, :VBVMR_MacroButton_GetStatus, \
-    [:long, :pointer, :long], :long
-
-    attach_function :vmr_pdirty, :VBVMR_IsParametersDirty, [], :long
-    attach_function :vmr_set_parameter_float, :VBVMR_SetParameterFloat, \
-    [:string, :float], :long
-    attach_function :vmr_get_parameter_float, :VBVMR_GetParameterFloat, \
-    [:string, :pointer], :long
-
-    attach_function :vmr_set_parameter_string, :VBVMR_SetParameterStringA, \
-    [:string, :string], :long
-    attach_function :vmr_get_parameter_string, :VBVMR_GetParameterStringA, \
-    [:string, :pointer], :long
-
-    attach_function :vmr_set_parameter_multi, :VBVMR_SetParameters, \
-    [:string], :long
-
-    DELAY = 0.001
-    MAX_POLLS = 8
-
-    def cache=(value)
-        @cache = value
-    end
-
-    def pdirty
-        return vmr_pdirty&.nonzero?
-    end
-
-    def mdirty
-        return vmr_mdirty&.nonzero?
-    end
-
-    def clear_polling
-        while self.pdirty || self.mdirty
-        end
-    end
-
-    def polling(func, name=nil, id=nil, mode=nil)
-        params = {
-            "get_parameter" => name,
-            "macro_getstatus" => "mb_#{id}_#{mode}"
-        }
-        MAX_POLLS.times do |i|
-            if @cache.key? params[func]
-                if func.include?('param') && self.pdirty ||
-                func.include?('macro') && self.mdirty
-                    return @cache.delete(params[func])[0]
-                end
-                sleep(DELAY)
-                break if @cache[params[func]][1] == false && i == 1
-            end
-        end
-
-        val = yield
-        self.cache.store(params[func], [val, false])
-        val
-    end
-
-    def retval=(values)
-        """ Writer validation for CAPI calls """
-        retval, func = *values
-        raise CAPIErrors.new(retval, func) if retval&.nonzero?
-        @retval = retval
-    end
-
-    def run_as(func, *args)
-        val = send('vmr_' + func, *args)
-        self.retval = [val, func]
-        sleep(DELAY) if func.include?('set') && @wait
-    end
-end
-
-module Define_Version
-    include Base
-
-    def define_version(kind)
-        case kind
-        when "basic"
-            self.properties = {
-                :name => kind,
-                :exe => "voicemeeter.exe"
-            }
-            self.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 = {
-                :name => kind,
-                :exe => "voicemeeterpro.exe"
-            }
-            self.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 = {
-                :name => kind,
-                :exe => "voicemeeter8#{OS_BITS == 64 ? "x64" : ""}.exe"
-            }
-            self.layout = {
-                :strip => {:p_in => 5, :v_in=> 3},
-                :bus => {:p_out => 5, :v_out=> 3},
-                :vban => {:instream => 8, :outstream => 8},
-                :mb => 70,
-            }
-        end
-    end
-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_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

data/lib/bus.rb

@@ -1,31 +1,68 @@
-require_relative 'channel'
-
-
-class Bus < IChannel
-    def self.make(remote, layout_bus)
-        "
-        Factory function for Bus classes.
-        "
-        p_out = layout_bus[:p_out]
-        v_out = layout_bus[:v_out]
-        
-        (0...(p_out + v_out)).map do |i|
-            i < p_out ? \
-            PhysicalBus.new(remote, i) : \
-            VirtualBus.new(remote, i)
-        end
-    end
-
-    def initialize(remote, i)
-        super
-        self.make_accessor_bool :mute, :mono, :eq
-        self.make_accessor_float :gain
-    end
-
-    def cmd
-        return "Bus[#{@index}]"
-    end
-end
-
-class PhysicalBus < Bus; end
-class VirtualBus < Bus; end
+require_relative 'iremote'
+
+class Bus < IRemote
+    '
+    Concrete Bus class
+    '
+    include Channel_Meta_Functions
+    include Fades
+
+    attr_accessor :mode
+
+    def self.make(remote, layout_bus)
+        '
+        Factory function for Bus classes.
+        '
+        p_out, v_out = layout_bus.values
+        (0...(p_out + v_out)).map do |i|
+            i < p_out ? PhysicalBus.new(remote, i) : VirtualBus.new(remote, i)
+        end
+    end
+
+    def initialize(remote, i)
+        super
+        self.make_accessor_bool :mute, :mono, :eq, :sel
+        self.make_accessor_float :gain
+        self.make_accessor_string :label
+
+        @mode = BusModes.new(remote, i)
+    end
+
+    def identifier
+        "bus[#{@index}]"
+    end
+end
+
+class PhysicalBus < Bus
+    def initialize(remote, i)
+        super
+        self.make_reader_only :device, :sr
+    end
+end
+
+class VirtualBus < Bus
+end
+
+class BusModes < IRemote
+    include Channel_Meta_Functions
+
+    def initialize(remote, i)
+        super
+        self.make_bus_modes :normal,
+                            :amix,
+                            :bmix,
+                            :repeat,
+                            :composite,
+                            :tvmix,
+                            :upmix21,
+                            :upmix41,
+                            :upmix61,
+                            :centeronly,
+                            :lfeonly,
+                            :rearonly
+    end
+
+    def identifier
+        "bus[#{@index}].mode"
+    end
+end

data/lib/button.rb

@@ -1,41 +1,23 @@
-require_relative 'meta'
-
-
-class IMacroButton
-    include MacroButton_Meta_Functions
-
-    attr_accessor :remote, :index
-
-    def initialize(remote, index)
-        self.remote = remote
-        self.index = index
-    end
-
-    def getter(mode)
-        return @remote.macro_getstatus(@index, mode)
-    end
-
-    def setter(set, mode)
-        @remote.macro_setstatus(@index, set, mode)
-    end
-
-    def set_multi(param_hash)
-        param_hash.each do |(key,val)|
-            self.send("#{key}=", val)
-        end
-    end
-end
-
-
-class MacroButton < IMacroButton
-    def self.make(remote, num_buttons)
-        (0...num_buttons).map do |i|
-            MacroButton.new(remote, i)
-        end
-    end
-
-    def initialize(remote, i)
-        super
-        self.make_accessor_macrobutton :state, :stateonly, :trigger 
-    end
-end
+require_relative 'iremote'
+require_relative 'meta'
+
+class MacroButton < IRemote
+    include MacroButton_Meta_Functions
+
+    def self.make(remote, num_buttons)
+        (0...num_buttons).map { |i| MacroButton.new(remote, i) }
+    end
+
+    def initialize(remote, i)
+        super
+        self.make_accessor_macrobutton :state, :stateonly, :trigger
+    end
+
+    def getter(mode)
+        @remote.get_buttonstatus(@index, mode)
+    end
+
+    def setter(set, mode)
+        @remote.set_buttonstatus(@index, set, mode)
+    end
+end

data/lib/cbindings.rb

@@ -0,0 +1,122 @@
+require 'ffi'
+require_relative 'inst'
+
+include InstallationFunctions
+
+module CBindings
+    '
+    Creates Ruby bindings to the C DLL
+
+    Performs other low level tasks
+    '
+    extend FFI::Library
+
+    private
+
+    begin
+        OS_BITS = FFI::Platform::CPU.downcase == 'x64' ? 64 : 32
+        VM_PATH = get_vmpath(OS_BITS)
+        DLL_NAME = "VoicemeeterRemote#{OS_BITS == 64 ? '64' : ''}.dll"
+
+        self.vm_dll = VM_PATH.join(DLL_NAME)
+    rescue InstallErrors => error
+        puts "ERROR: #{error.message}"
+        raise
+    end
+
+    ffi_lib @vm_dll
+    ffi_convention :stdcall
+
+    attach_function :vm_login, :VBVMR_Login, [], :long
+    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_mdirty, :VBVMR_MacroButton_IsDirty, [], :long
+    attach_function :vm_get_buttonstatus,
+                    :VBVMR_MacroButton_GetStatus,
+                    %i[long pointer long],
+                    :long
+    attach_function :vm_set_buttonstatus,
+                    :VBVMR_MacroButton_SetStatus,
+                    %i[long float long],
+                    :long
+
+    attach_function :vm_pdirty, :VBVMR_IsParametersDirty, [], :long
+    attach_function :vm_get_parameter_float,
+                    :VBVMR_GetParameterFloat,
+                    %i[string pointer],
+                    :long
+    attach_function :vm_set_parameter_float,
+                    :VBVMR_SetParameterFloat,
+                    %i[string float],
+                    :long
+
+    attach_function :vm_get_parameter_string,
+                    :VBVMR_GetParameterStringA,
+                    %i[string pointer],
+                    :long
+    attach_function :vm_set_parameter_string,
+                    :VBVMR_SetParameterStringA,
+                    %i[string string],
+                    :long
+
+    attach_function :vm_set_parameter_multi,
+                    :VBVMR_SetParameters,
+                    [:string],
+                    :long
+
+    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_desc_indevices,
+                    :VBVMR_Input_GetDeviceDescA, %i[long pointer pointer pointer],
+                    :long
+
+    attach_function :vm_get_num_outdevices,
+                    :VBVMR_Output_GetDeviceNumber, [], :long
+    attach_function :vm_get_desc_outdevices,
+                    :VBVMR_Output_GetDeviceDescA, %i[long pointer pointer pointer],
+                    :long
+
+
+
+    @@cdll =
+        lambda do |func, *args|
+            self.retval = [send("vm_#{func}", *args), func]
+        end
+
+    def clear_polling() = while pdirty? || mdirty?; end
+
+    def polling(func, **kwargs)
+        params = {
+            'get_parameter' => kwargs[:name],
+            'get_buttonstatus' => "mb_#{kwargs[:id]}_#{kwargs[:mode]}",
+        }
+        return @cache.delete(params[func]) if @cache.key? params[func]
+
+        clear_polling if @sync
+
+        yield
+    end
+
+    def retval=(values)
+        ' Writer validation for CAPI calls '
+        retval, func = *values
+        unless [:get_num_indevices, :get_num_outdevices].include? func
+            raise CAPIErrors.new(retval, func) if retval&.nonzero?
+        end
+        @retval = retval
+    end
+
+    public
+
+    def pdirty?() =  vm_pdirty&.nonzero?
+
+    def mdirty?() =  vm_mdirty&.nonzero?
+end