Merge pull request #12 from pblivingston/option-params

Option class

CHANGELOG.md

@@ -14,6 +14,7 @@ Before any major/minor/patch is released all test units will be run to verify th
 - IRemote base class
 - ArrayMember classes for array-like properties
 - Patch class
+- Option class
 
 ## [3.3.0] - 2024-06-29
 

README.md

@@ -440,6 +440,43 @@ $vmr.patch.composite[5].set(0)   # sets composite channel 6 (5) to default bus c
 $vmr.patch.insert[4].get()
 ```
 
+### Option
+
+The following Option commands are available:
+
+- sr: int, (32000, 44100, 48000, 88200, 96000, 176400, 192000)
+- asiosr: bool
+- monitorOnSel: bool
+- sliderMode: bool
+
+The following Option.delay[i] methods are available:
+
+- Set($val): float, from 0.00 to 500.00
+- Get()
+
+for example:
+
+```powershell
+$vmr.Option.delay[2].set(30.26)   # sets the delay for the third (2) bus
+$vmr.Option.sliderMode = $false   # sets slider mode to absolute
+```
+
+#### buffers
+
+The following Option.buffer commands are available:
+
+- mme: int, (441, 480, 512, 576, 640, 704, 768, 896, 1024, 1536, 2048)
+- wdm: int, (128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 441, 448, 480, 512, 576, 640, 704, 768, 1024, 1536, 2048)
+- ks: int, (128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 441, 448, 480, 512, 576, 640, 704, 768, 1024, 1536, 2048)
+- asio: int, (0, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 441, 448, 480, 512, 576, 640, 704, 768, 1024)
+
+for example:
+
+```powershell
+$vmr.Option.buffer.wdm = 512
+$vmr.Option.buffer.asio = 0    # to use default buffer size
+```
+
 ### Recorder
 
 The following commands are available:

lib/Voicemeeter.psm1

@@ -11,6 +11,7 @@
 . $PSScriptRoot\command.ps1
 . $PSScriptRoot\recorder.ps1
 . $PSScriptRoot\patch.ps1
+. $PSScriptRoot\option.ps1
 . $PSScriptRoot\profiles.ps1
 
 class Remote {
@@ -81,6 +82,7 @@ class RemoteBasic : Remote {
     [PSCustomObject]$vban
     [Object]$command
     [Object]$patch
+    [Object]$option
 
     RemoteBasic () : base ('basic') {
         $this.strip = Make_Strips($this)
@@ -89,6 +91,7 @@ class RemoteBasic : Remote {
         $this.vban = Make_Vban($this)
         $this.command = Make_Command($this)
         $this.patch = Make_Patch($this)
+        $this.option = Make_Option($this)
     }
 }
 
@@ -99,6 +102,7 @@ class RemoteBanana : Remote {
     [PSCustomObject]$vban
     [Object]$command
     [Object]$patch
+    [Object]$option
     [Object]$recorder
 
     RemoteBanana () : base ('banana') {
@@ -108,6 +112,7 @@ class RemoteBanana : Remote {
         $this.vban = Make_Vban($this)
         $this.command = Make_Command($this)
         $this.patch = Make_Patch($this)
+        $this.option = Make_Option($this)
         $this.recorder = Make_Recorder($this)
     }
 }
@@ -119,6 +124,7 @@ class RemotePotato : Remote {
     [PSCustomObject]$vban
     [Object]$command
     [Object]$patch
+    [Object]$option
     [Object]$recorder
 
     RemotePotato () : base ('potato') {
@@ -128,6 +134,7 @@ class RemotePotato : Remote {
         $this.vban = Make_Vban($this)
         $this.command = Make_Command($this)
         $this.patch = Make_Patch($this)
+        $this.option = Make_Option($this)
         $this.recorder = Make_Recorder($this)
     }
 }

lib/option.ps1

@@ -0,0 +1,116 @@
+class Option : IRemote {
+    [System.Collections.ArrayList]$delay
+    [Object]$buffer
+    
+    Option ([Object]$remote) : base ($remote) {
+        AddBoolMembers -PARAMS @('asiosr', 'monitorOnSel', 'sliderMode')
+        
+        $this.buffer = [OptionBuffer]::new($remote)
+        
+        $num_A = $this.remote.kind.p_out
+        if ($this.remote.kind.name -eq 'basic') {
+            $num_A += $this.remote.kind.v_out
+        }
+        
+        $this.delay = @()
+        for ($i = 0; $i -lt $num_A; $i++) {
+            $this.delay.Add([FloatArrayMember]::new($i, 'delay', $this, 2))
+        }
+    }
+    
+    [string] identifier () {
+        return 'Option'
+    }
+    
+    hidden $_sr = $($this | Add-Member ScriptProperty 'sr' `
+        {
+            $this.Getter('sr')
+        } `
+        {
+            param([int]$arg)
+            $opts = @(32000, 44100, 48000, 88200, 96000, 176400, 192000)
+            if ($opts.Contains($arg)) {
+                $this._sr = $this.Setter('sr', $arg)
+            }
+            else {
+                Write-Warning ('Expected one of', $opts)
+            }
+        }
+    )
+}
+
+class OptionBuffer : IRemote {
+    OptionBuffer ([Object]$remote) : base ($remote) {}
+    
+    [string] identifier () {
+        return 'Option.Buffer'
+    }
+    
+    hidden $_mme = $($this | Add-Member ScriptProperty 'mme' `
+        {
+            $this.Getter('mme')
+        } `
+        {
+            param([int]$arg)
+            $opts = @(441, 480, 512, 576, 640, 704, 768, 896, 1024, 1536, 2048)
+            if ($opts.Contains($arg)) {
+                $this._mme = $this.Setter('mme', $arg)
+            }
+            else {
+                Write-Warning ('Expected one of', $opts)
+            }
+        }
+    )
+    
+    hidden $_wdm = $($this | Add-Member ScriptProperty 'wdm' `
+        {
+            $this.Getter('wdm')
+        } `
+        {
+            param([int]$arg)
+            $opts = @(128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 441, 448, 480, 512, 576, 640, 704, 768, 1024, 1536, 2048)
+            if ($opts.Contains($arg)) {
+                $this._wdm = $this.Setter('wdm', $arg)
+            }
+            else {
+                Write-Warning ('Expected one of', $opts)
+            }
+        }
+    )
+    
+    hidden $_ks = $($this | Add-Member ScriptProperty 'ks' `
+        {
+            $this.Getter('ks')
+        } `
+        {
+            param([int]$arg)
+            $opts = @(128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 441, 448, 480, 512, 576, 640, 704, 768, 1024, 1536, 2048)
+            if ($opts.Contains($arg)) {
+                $this._ks = $this.Setter('ks', $arg)
+            }
+            else {
+                Write-Warning ('Expected one of', $opts)
+            }
+        }
+    )
+    
+    hidden $_asio = $($this | Add-Member ScriptProperty 'asio' `
+        {
+            $this.Getter('asio')
+        } `
+        {
+            param([int]$arg)
+            $opts = @(0, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 441, 448, 480, 512, 576, 640, 704, 768, 1024)
+            if ($opts.Contains($arg)) {
+                $this._asio = $this.Setter('asio', $arg)
+            }
+            else {
+                Write-Warning ('Expected one of', $opts)
+            }
+        }
+    )
+}
+
+function Make_Option ([Object]$remote) {
+    return [Option]::new($remote)
+}

tests/higher.Tests.ps1

@@ -127,6 +127,22 @@ Describe -Tag 'higher', -TestName 'All Higher Tests' {
                 $vmr.patch.postfxinsert | Should -Be $value
             }
         }
+        
+        Context 'Option' {
+            It 'Should set and get Option.monitoronsel' -Skip:$ifNotPotato {
+                $vmr.option.monitoronsel = $value
+                $vmr.command.restart
+                Start-Sleep -Milliseconds 500
+                $vmr.option.monitoronsel | Should -Be $value
+            }
+            
+            It 'Should set and get Option.slidermode' -Skip:$ifNotPotato {
+                $vmr.option.slidermode = $value
+                $vmr.command.restart
+                Start-Sleep -Milliseconds 500
+                $vmr.option.slidermode | Should -Be $value
+            }
+        }
     }
 
     Describe 'Float Tests' {
@@ -222,6 +238,17 @@ Describe -Tag 'higher', -TestName 'All Higher Tests' {
                 }
             }
         }
+        
+        Context 'Option' {
+            It "Should set and get Option.delay[$phys_out]" -ForEach @(
+                @{ Value = 486.57 }, @{ Value = 26.41 }
+            ) {
+                $vmr.option.delay[$phys_out].set($value)
+                $vmr.command.restart
+                Start-Sleep -Milliseconds 500
+                $vmr.option.delay[$phys_out].get() | Should -Be $value
+            }
+        }
     }
 
     Describe 'Int Tests' -ForEach @(
@@ -267,6 +294,38 @@ Describe -Tag 'higher', -TestName 'All Higher Tests' {
                 $vmr.patch.composite[$composite].get() | Should -Be $value
             }
         }
+        
+        Context 'Option' {
+            It 'Should set and get Option.sr' -ForEach @(
+                @{ Value = 44100 }, @{ Value = 48000 }
+            ) {
+                $vmr.option.sr = $value
+                Start-Sleep -Milliseconds 500
+                $vmr.option.sr | Should -Be $value
+            }
+            
+            Context 'Option.buffer' -ForEach @(
+                @{ Value = 1024 }, @{ Value = 512 }
+            ) {
+                It 'Should set and get mme buffer' {
+                    $vmr.option.buffer.mme = $value
+                    Start-Sleep -Milliseconds 500
+                    $vmr.option.buffer.mme | Should -Be $value
+                }
+                
+                It 'Should set and get wdm buffer' {
+                    $vmr.option.buffer.wdm = $value
+                    Start-Sleep -Milliseconds 500
+                    $vmr.option.buffer.wdm | Should -Be $value
+                }
+                
+                It 'Should set and get ks buffer' {
+                    $vmr.option.buffer.ks = $value
+                    Start-Sleep -Milliseconds 500
+                    $vmr.option.buffer.ks | Should -Be $value
+                }
+            }
+        }
     }
 
     Describe 'String Tests' {