voicemeeter_api_ruby 3.0.0 → 4.1.1

data/lib/runvm.rb

@@ -1,29 +1,29 @@
-require_relative 'cbindings'
-require_relative 'kinds'
-
-include CBindings
-include Kinds
-
-module RunVM
-    '
-    Starts Voicemeeter of the Kind requested.
-    '
-    def start(kind_id)
-        unless Kinds.kind_map.key? kind_id
-            raise VMRemoteErrors.new('Unknown Voicemeeter Kind.')
-        end
-
-        enums =
-            Kinds.kinds_all.map.with_index do |kind, i|
-                if OS_BITS == 64 && kind.name == 'potato'
-                    [kind.name, i + 4]
-                else
-                    [kind.name, i + 1]
-                end
-            end
-        exes = enums.to_h { |k, v| [k, v.to_i] }
-
-        send('vmr_runvm', exes[kind_id])
-        sleep(1)
-    end
-end
+require_relative 'cbindings'
+require_relative 'kinds'
+
+include CBindings
+include Kinds
+
+module RunVM
+    '
+    Starts Voicemeeter of the Kind requested.
+    '
+    def start(kind_id)
+        unless Kinds.kind_map.key? kind_id
+            raise VMRemoteErrors.new('Unknown Voicemeeter Kind.')
+        end
+
+        enums =
+            Kinds.kinds_all.map.with_index do |kind, i|
+                if OS_BITS == 64 && kind.name.to_s == 'potato'
+                    [kind.name.to_s, i + 4]
+                else
+                    [kind.name.to_s, i + 1]
+                end
+            end
+        exes = enums.to_h { |k, v| [k, v.to_i] }
+
+        send(:vm_runvm, exes[kind_id])
+        sleep(1)
+    end
+end

data/lib/strip.rb

@@ -1,80 +1,131 @@
-require_relative 'channel'
-
-class Strip < IChannel
-    '
-    Concrete Strip class
-    '
-    include Fades
-
-    attr_accessor :gainlayer
-
-    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|
-            if i < p_in
-                PhysicalStrip.new(remote, i)
-            else
-                VirtualStrip.new(remote, i)
-            end
-        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) }
-    end
-
-    def identifier
-        :strip
-    end
-end
-
-class PhysicalStrip < Strip
-    def initialize(remote, i)
-        super
-        self.make_accessor_float :comp, :gate
-        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
-    end
-
-    def appgain(name, gain) = self.setter("AppGain", "(\"#{name}\", #{gain})")
-
-    def appmute(name, mute) = self.setter("AppMute", "(\"#{name}\", #{mute ? 1 : 0})")
-end
-
-class GainLayer < IChannel
-    def initialize(remote, i, j)
-        super(remote, i)
-        @j = j
-    end
-
-    def identifier
-        :strip
-    end
-
-    def gain
-        self.getter("gainlayer[#{@j}]")
-    end
-
-    def gain=(value)
-        self.setter("gainlayer[#{@j}]", value)
-    end
-end
+require_relative 'iremote'
+require_relative 'mixin'
+
+class Strip < IRemote
+    '
+    Concrete Strip class
+    '
+    include Channel_Meta_Functions
+    include Fades
+
+    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|
+            if i < p_in
+                PhysicalStrip.new(remote, i)
+            else
+                VirtualStrip.new(remote, i)
+            end
+        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
+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

data/lib/vban.rb

@@ -1,103 +1,78 @@
-require_relative 'meta'
-require_relative 'errors'
-
-class IVban
-    '
-    Base Vban class
-    '
-    include Vban_Meta_Functions
-
-    def initialize(remote, index)
-        @remote = remote
-        @index = index
-    end
-
-    def getter(param, is_string = false)
-        @remote.get_parameter("#{self.cmd}.#{param}", is_string)
-    end
-
-    def setter(param, value)
-        @remote.set_parameter("#{self.cmd}.#{param}", value)
-    end
-
-    def cmd
-        "#{self.identifier}.#{self.direction}stream[#{@index}]"
-    end
-
-    def direction
-        raise 'Called abstract mehod: direction'
-    end
-
-    def set_multi(param_hash)
-        param_hash.each { |(key, val)| self.send("#{key}=", val) }
-    end
-end
-
-class Vban < IVban
-    '
-    Concrete Vban class
-    '
-    def self.make(remote, vban_streams)
-        '
-        Factory function for Vban class.
-
-        Returns a mixin of instream/outstream subclasses
-        '
-        class << self
-            attr_accessor :instream, :outstream, :remote
-
-            def enable
-                @remote.set_parameter('vban.enable', 1)
-            end
-            def disable
-                @remote.set_parameter('vban.enable', 0)
-            end
-        end
-
-        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) }
-
-        self.remote = remote
-        return self
-    end
-
-    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
-    end
-end
-
-class VbanInstream < Vban
-    '
-    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 < Vban
-    '
-    A subclass representing a VBAN Outstream
-    '
-    def initialize(remote, i)
-        super
-        self.make_accessor_int :sr, :channel, :bit
-    end
-
-    def direction
-        :out
-    end
-end
+require_relative 'iremote'
+require_relative 'meta'
+require_relative 'errors'
+
+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

data/lib/version.rb

@@ -1,3 +1,3 @@
-module Voicemeeter_API_Ruby
-    VERSION = '3.0.0'
-end
+module Voicemeeter_API_Ruby
+    VERSION = '4.1.1'
+end

data/lib/voicemeeter.rb

@@ -1,73 +1,86 @@
-require_relative 'base'
-
-module Voicemeeter
-    include RunVM
-
-    private
-
-    class Remote < Base
-        include Kinds
-        '
-        Remote class, subclasses Base
-
-        Console layout built according to a kind
-
-        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.kinds_all.to_h do |kind|
-                [kind.name, Remote.new(kind, **kwargs)]
-            end
-        end
-
-        def initialize(kind)
-            super
-            self.strip = Strip.make(self, kind.layout[:strip])
-            self.bus = Bus.make(self, kind.layout[:bus])
-            self.button = MacroButton.make(self, kind.layout[:mb])
-            self.vban = Vban.make(self, kind.layout[:vban])
-            self.command = Command.new(self)
-            self.recorder = Recorder.new(self)
-        end
-
-        def run
-            yield if block_given?
-        ensure
-            logout
-        end
-    end
-
-    public
-
-    def self.remote(kind_id, **kwargs)
-        '
-        Request a Remote class of a kind and login to the API
-        '
-        _remotes = Remote.make(**kwargs)
-
-        unless _remotes.key? kind_id
-            raise VMRemoteErrors.new('Unknown Voicemeeter Kind.')
-        end
-
-        _remotes[kind_id].login
-        return _remotes[kind_id]
-    end
-
-    def self.testing
-        '
-        Returns a random Remote class
-        '
-        unless ENV['RACK_ENV'] == 'dev'
-            raise VMRemoteErrors.new('Not in developer mode')
-        end
-
-        return Remote.new(Kinds.kinds_all.sample)
-    end
-
-    module_function :start
-end
+require_relative 'base'
+require_relative 'strip'
+require_relative 'bus'
+require_relative 'button'
+require_relative 'vban'
+require_relative 'command'
+require_relative 'recorder'
+require_relative 'device'
+
+module Voicemeeter
+    include RunVM
+
+    private
+
+    class Remote < Base
+        include Kinds
+        '
+        Remote class, subclasses Base
+
+        Console layout built according to a kind
+
+        Offers a run method for resource closure.
+        '
+        def initialize(kind, **kwargs)
+            super
+            self.strip = Strip.make(self, kind.layout[:strip])
+            self.bus = Bus.make(self, kind.layout[:bus])
+            self.button = MacroButton.make(self, kind.layout[:mb])
+            self.vban = Vban.new(self, kind.layout[:vban])
+            self.command = Command.new(self)
+            self.recorder = Recorder.new(self)
+            self.device = Device.new(self)
+        end
+
+        def run
+            '
+            Handles login/logout
+
+            Starts/stops the observable thread.
+            '
+            login
+            init_thread
+
+            yield if block_given?
+        ensure
+            end_thread
+            logout
+        end
+    end
+
+    public
+
+    def self.remote(kind_id, **kwargs)
+        '
+        Factory method for remotes.
+
+        Creates a hash of remote classes, one for each kind.
+
+        Handles kind_id request errors.
+
+        Returns a remote class of the kind requested.
+        '
+        _remotes =
+            Kinds.kinds_all.to_h do |kind|
+                [kind.name.to_s, Remote.new(kind, **kwargs)]
+            end
+
+        unless _remotes.key? kind_id
+            raise VMRemoteErrors.new('Unknown Voicemeeter Kind.')
+        end
+        _remotes[kind_id]
+    end
+
+    def self.testing
+        '
+        Returns a random Remote class
+        '
+        unless ENV['RACK_ENV'] == 'dev'
+            raise VMRemoteErrors.new('Not in developer mode')
+        end
+
+        Remote.new(Kinds.kinds_all.sample)
+    end
+
+    module_function :start
+end