voicemeeter_api_ruby 2.0.2 → 3.0.0

data/lib/runvm.rb

@@ -1,20 +1,29 @@
-require 'open3'
-require_relative 'errors'
-require_relative 'base'
-
-module RunVM
-    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")
-        end
-
-        Open3.popen3(exe_path, '')
-        sleep(1)
-
-        clear_polling
-    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 == '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

data/lib/strip.rb

@@ -1,49 +1,80 @@
-require_relative 'channel'
-
-
-class Strip < IChannel
-    attr_reader :num_A, :num_B
-
-    def self.make(remote, layout_strip, out_channels)
-        "
-        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]
-
-        (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) 
-        end
-    end
-
-    def initialize(remote, i, num_A, num_B)
-        super(remote, i)
-        self.make_accessor_bool :solo, :mute, :mono
-        self.make_accessor_float :gain
-        self._make_channel_props(num_A, num_B)
-    end
-
-    def cmd
-        return "Strip[#{@index}]"
-    end
-end
-
-class PhysicalStrip < Strip
-    def initialize(remote, i, num_A, num_B)
-        super
-        self.make_accessor_float :comp, :gate
-        self.make_accessor_int :limit
-        self.make_reader_only :device, :sr
-    end
-end
-
-class VirtualStrip < Strip
-    def initialize(remote, i, num_A, num_B)
-        super
-        self.make_accessor_bool :mc, :k
-    end
-end
+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

data/lib/vban.rb

@@ -1,92 +1,103 @@
-require_relative 'meta'
-require_relative 'errors'
-
-
-class IVban
-    include Vban_Meta_Functions
-
-    attr_accessor :remote, :index
-
-    def initialize(remote, index)
-        self.remote = remote
-        self.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
-        return "vban.#{self.direction}stream[#{@index}]"
-    end
-
-    def direction
-        raise NotImplementedError
-    end
-end
-
-
-class Vban < IVban
-    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
-
-        self.instream = 
-        (0...vban_streams[:instream]).map do |i|
-            VbanInstream.new(remote, i)
-        end
-        self.outstream = 
-        (0...vban_streams[:outstream]).map do |i|
-            VbanOutstream.new(remote, i)
-        end
-
-        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
-end
-
-class VbanInstream < Vban
-    def initialize(remote, i)
-        super
-        self.make_reader_int :sr, :channel, :bit
-    end
-
-    def direction
-        return "in"
-    end
-end
-
-class VbanOutstream < Vban
-    def initialize(remote, i)
-        super
-        self.make_accessor_int :sr, :channel, :bit
-    end
-
-    def direction
-        return "out"
-    end
-end
+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

data/lib/version.rb

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

data/lib/voicemeeter.rb

@@ -1,30 +1,73 @@
-require_relative 'routines'
-require_relative 'errors'
-
-module Voicemeeter
-    class Remote < Routines
-        def self.make
-            ["basic", "banana", "potato"].to_h do |kind|
-                [kind, Remote.new(kind)]
-            end
-        end
-
-        def run
-            if block_given?
-                yield
-                
-                logout
-            end
-        end
-    end
-
-    def remote(kind)
-        _remotes = Remote.make
-
-        raise VMRemoteErrors.new("Unknown Voicemeeter Kind") unless _remotes[kind]
-        _remotes[kind].login
-        return _remotes[kind]
-    end
-
-    module_function :remote
-end
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voicemeeter_api_ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -31,61 +31,57 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.9.10
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: toml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.3
-  type: :development
+        version: 0.3.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.14.4
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.14.4
+        version: '3.4'
 description: A wrapper for Voicemeeter virtual mixer API in Ruby
 email: code@onyxandiris.online
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 - lib/base.rb
 - lib/bus.rb
 - lib/button.rb
+- lib/cbindings.rb
 - lib/channel.rb
 - lib/command.rb
 - lib/errors.rb
 - lib/inst.rb
+- lib/kinds.rb
 - lib/meta.rb
+- lib/profiles.rb
 - lib/recorder.rb
-- lib/routines.rb
 - lib/runvm.rb
 - lib/strip.rb
 - lib/vban.rb
@@ -93,7 +89,7 @@ files:
 - lib/voicemeeter.rb
 homepage: https://rubygems.org/gems/voicemeeter_api_ruby
 licenses:
-- NGPL
+- MIT
 metadata:
   source_code_uri: https://github.com/onyx-and-iris/voicemeeter-api-ruby.git
 post_install_message:
@@ -104,14 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Voicemeeter API wrapper