onyx_online/voicemeeter-api-powershell
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter-api-powershell.git synced 2025-12-06 13:47:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #29 from pblivingston/float-decimals

Browse Source 
Float decimals
This commit is contained in:
Onyx and Iris 2025-12-05 23:31:49 +00:00 committed by GitHub
commit a8e66113f7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 108 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -57,6 +57,7 @@ Recorder.FileType changed from method to write-only property
- Device: explicit $arg types for consistency - Device: explicit $arg types for consistency
- Recorder.Armstrip|Armbus -> BoolArrayMember: now have .Get() - Recorder.Armstrip|Armbus -> BoolArrayMember: now have .Get()
- Cast Recorder getters to types for consistency - Cast Recorder getters to types for consistency
- Floats can now take up to two decimal places
### Fixed ### Fixed

70
README.md
View File

@ -123,18 +123,18 @@ The following strip commands are available:
- A1-A5: bool - A1-A5: bool
- B1-B3: bool - B1-B3: bool
- limit: int, from -40 to 12 - limit: int, from -40 to 12
- gain: float, from -60.0 to 12.0 - gain: float, from -60.00 to 12.00
- label: string - label: string
- reverb: float, from 0.0 to 10.0 - reverb: float, from 0.00 to 10.00
- delay: float, from 0.0 to 10.0 - delay: float, from 0.00 to 10.00
- fx1: float, from 0.0 to 10.0 - fx1: float, from 0.00 to 10.00
- fx2: float, from 0.0 to 10.0 - fx2: float, from 0.00 to 10.00
- pan_x: float, from -0.5 to 0.5 - pan_x: float, from -0.50 to 0.50
- pan_y: float, from 0.0 to 1.0 - pan_y: float, from 0.00 to 1.00
- color_x: float, from -0.5 to 0.5 - color_x: float, from -0.50 to 0.50
- color_y: float, from 0.0 to 1.0 - color_y: float, from 0.00 to 1.00
- fx_x: float, from -0.5 to 0.5 - fx_x: float, from -0.50 to 0.50
- fx_y: float, from 0.0 to 1.0 - fx_y: float, from 0.00 to 1.00
- postreverb: bool - postreverb: bool
- postdelay: bool - postdelay: bool
- postfx1: bool - postfx1: bool
@ -157,14 +157,14 @@ mc, k for virtual strips only.
The following strip.comp commands are available: The following strip.comp commands are available:
- knob: float, from 0.0 to 10.0 - knob: float, from 0.00 to 10.00
- gainin: float, from -24.0 to 24.0 - gainin: float, from -24.00 to 24.00
- ratio: float, from 1.0 to 8.0 - ratio: float, from 1.00 to 8.00
- threshold: float, from -40.0 to -3.0 - threshold: float, from -40.00 to -3.00
- attack: float, from 0.0 to 200.0 - attack: float, from 0.00 to 200.00
- release: float, from 0.0 to 5000.0 - release: float, from 0.00 to 5000.00
- knee: float, 0.0 to 1.0 - knee: float, 0.00 to 1.00
- gainout: float, from -24.0 to 24.0 - gainout: float, from -24.00 to 24.00
- makeup: bool - makeup: bool
for example: for example:
@ -177,13 +177,13 @@ $vmr.strip[3].comp.attack = 8.5
The following strip.gate commands are available: The following strip.gate commands are available:
- knob: float, from 0.0 to 10.0 - knob: float, from 0.00 to 10.00
- threshold: float, from -60.0 to -10.0 - threshold: float, from -60.00 to -10.00
- damping: float, from -60.0 to -10.0 - damping: float, from -60.00 to -10.00
- bpsidechain: int, from 100 to 4000 - bpsidechain: int, from 100 to 4000
- attack: float, from 0.0 to 1000.0 - attack: float, from 0.00 to 1000.00
- hold: float, from 0.0 to 5000.0 - hold: float, from 0.00 to 5000.00
- release: float, from 0.0 to 5000.0 - release: float, from 0.00 to 5000.00
for example: for example:
@ -195,7 +195,7 @@ $vmr.strip[3].gate.threshold = -40.5
The following strip.denoiser commands are available: The following strip.denoiser commands are available:
- knob: float, from 0.0 to 10.0 - knob: float, from 0.00 to 10.00
for example: for example:
@ -238,12 +238,12 @@ The following bus commands are available:
- monitor: bool - monitor: bool
- vaio: bool - vaio: bool
- mono: int, 0 off, 1 mono, 2 stereo reverse - mono: int, 0 off, 1 mono, 2 stereo reverse
- gain: float, from -60.0 to 12.0 - gain: float, from -60.00 to 12.00
- label: string - label: string
- returnreverb: float, from 0.0 to 10.0 - returnreverb: float, from 0.00 to 10.00
- returndelay: float, from 0.0 to 10.0 - returndelay: float, from 0.00 to 10.00
- returnfx1: float, from 0.0 to 10.0 - returnfx1: float, from 0.00 to 10.00
- returnfx2: float, from 0.0 to 10.0 - returnfx2: float, from 0.00 to 10.00
for example: for example:
@ -342,9 +342,9 @@ The following eq.channel.cell commands are available:
- on: bool - on: bool
- type: int, from 0 to 6 - type: int, from 0 to 6
- f: float, from 20.0 to 20000.0 - f: float, from 20.00 to 20000.00
- gain: float, from -12.0 to 12.0 - gain: float, from -12.00 to 12.00
- q: float, from 0.3 to 100.0 - q: float, from 0.30 to 100.00
for example: for example:
@ -538,7 +538,7 @@ The following commands are available:
- A1 - A5: bool - A1 - A5: bool
- B1 - B3: bool - B1 - B3: bool
- gain: float, from -60.0 to 12.0 - gain: float, from -60.00 to 12.00
- armedbus: int, from 0 to bus index - armedbus: int, from 0 to bus index
- state: string, ('play', 'stop', 'record', 'pause') - state: string, ('play', 'stop', 'record', 'pause')
- prerectime: int, from 0 to 20 seconds - prerectime: int, from 0 to 20 seconds

8
lib/arraymember.ps1
View File

@ -43,11 +43,17 @@ class FloatArrayMember : ArrayMember {
[int]$decimals [int]$decimals
FloatArrayMember ( FloatArrayMember (
[int]$index, [string]$prefix, [Object]$parent, [int]$decimals = 1 [int]$index, [string]$prefix, [Object]$parent, [int]$decimals
) : base ($index, $prefix, $parent) { ) : base ($index, $prefix, $parent) {
$this.decimals = $decimals $this.decimals = $decimals
} }
FloatArrayMember (
[int]$index, [string]$prefix, [Object]$parent
) : base ($index, $prefix, $parent) {
$this.decimals = 2
}
[double] Get () { [double] Get () {
return [math]::Round($this.Getter(''), $this.decimals) return [math]::Round($this.Getter(''), $this.decimals)
} }

5
lib/meta.ps1
View File

@ -16,12 +16,13 @@ function AddBoolMembers () {
function AddFloatMembers () { function AddFloatMembers () {
param( param(
[String[]]$PARAMS [String[]]$PARAMS,
[int]$decimals = 2
) )
[hashtable]$Signatures = @{} [hashtable]$Signatures = @{}
foreach ($param in $PARAMS) { foreach ($param in $PARAMS) {
# Define getter # Define getter
$Signatures['Getter'] = "[math]::Round(`$this.Getter('{0}'), 1)" -f $param $Signatures['Getter'] = "[math]::Round(`$this.Getter('{0}'), {1})" -f $param, $decimals
# Define setter # Define setter
$Signatures['Setter'] = "param ( [Single]`$arg )`n`$this.Setter('{0}', `$arg)" ` $Signatures['Setter'] = "param ( [Single]`$arg )`n`$this.Setter('{0}', `$arg)" `
-f $param -f $param

2
lib/option.ps1
View File

@ -14,7 +14,7 @@ class Option : IRemote {
$this.delay = @() $this.delay = @()
for ($i = 0; $i -lt $num_A; $i++) { for ($i = 0; $i -lt $num_A; $i++) {
$this.delay.Add([FloatArrayMember]::new($i, 'delay', $this, 2)) $this.delay.Add([FloatArrayMember]::new($i, 'delay', $this))
} }
} }

143
tests/higher.Tests.ps1
View File

@ -244,94 +244,81 @@ Describe -Tag 'higher', -TestName 'All Higher Tests' {
} }
} }
Describe 'Float Tests' -Tag 'float' { Describe 'Float Tests' -Tag 'float' -ForEach @(
@{ Gain = -24.63; Knob = 5.27; Slide = -7.51; Xy10 = 0.83; Xy05 = -0.42; MsHz = 196.57 }
@{ Gain = -12.48; Knob = 8.91; Slide = 3.14; Xy10 = 0.27; Xy05 = 0.69; MsHz = 142.13 }
) {
Context 'Strip, one physical one virtual' -ForEach @( Context 'Strip, one physical one virtual' -ForEach @(
@{ Index = $phys_in }, @{ Index = $virt_in } @{ Index = $phys_in }, @{ Index = $virt_in }
) { ) {
It "Should set Strip[$index].Gain to $value" -ForEach @( It "Should set Strip[$index].Gain" {
@{ Value = 3.6; Expected = 3.6 }, @{ Value = -8.2; Expected = -8.2 } $vmr.strip[$index].gain = $gain
) { $vmr.strip[$index].gain | Should -Be $gain
$vmr.strip[$index].gain = $value
$vmr.strip[$index].gain | Should -Be $expected
} }
} }
Context 'Strip, physical only' -Skip:$ifBasic -ForEach @( Context 'Strip, physical only' -ForEach @(
@{ Index = $phys_in } @{ Index = $phys_in }
) { ) {
Context 'Knobs' -Skip:$ifBasic -ForEach @( Context 'Comp, Gate' -Skip:$ifBasic {
@{ Value = 8.3; Expected = 8.3 }, @{ Value = 5.1; Expected = 5.1 } It "Should set Strip[$index].Comp" {
) { $vmr.strip[$index].comp.knob = $knob
It "Should set Strip[$index].Comp to $value" { $vmr.strip[$index].comp.knob | Should -Be $knob
$vmr.strip[$index].comp.knob = $value
$vmr.strip[$index].comp.knob | Should -Be $expected
} }
It "Should set Strip[$index].Gate to $value" { It "Should set Strip[$index].Gate" {
$vmr.strip[$index].gate.knob = $value $vmr.strip[$index].gate.knob = $knob
$vmr.strip[$index].gate.knob | Should -Be $expected $vmr.strip[$index].gate.knob | Should -Be $knob
}
It "Should set Strip[$index].Denoiser to $value" -Skip:$ifNotPotato {
$vmr.strip[$index].denoiser.knob = $value
$vmr.strip[$index].denoiser.knob | Should -Be $expected
} }
} }
Context 'Comp' -Skip:$ifNotPotato { Context 'Comp' -Skip:$ifNotPotato {
It "Should set Strip[$index].Comp.Attack" -ForEach @( It "Should set Strip[$index].Comp.Attack" {
@{ Value = 8.3; Expected = 8.3 }, @{ Value = 5.1; Expected = 5.1 } $vmr.strip[$index].comp.attack = $msHz
) { $vmr.strip[$index].comp.attack | Should -Be $msHz
$vmr.strip[$index].comp.attack = $value
$vmr.strip[$index].comp.attack | Should -Be $expected
} }
It "Should set Strip[$index].Comp.Knee" -ForEach @( It "Should set Strip[$index].Comp.Knee" {
@{ Value = 0.3; Expected = 0.3 }, @{ Value = 0.8; Expected = 0.8 } $vmr.strip[$index].comp.knee = $xy10
) { $vmr.strip[$index].comp.knee | Should -Be $xy10
$vmr.strip[$index].comp.knee = $value
$vmr.strip[$index].comp.knee | Should -Be $expected
} }
} }
Context 'Gate' -Skip:$ifNotPotato { Context 'Gate' -Skip:$ifNotPotato {
It "Should set Strip[$index].Gate.BPSidechain" -ForEach @( It "Should set Strip[$index].Gate.BPSidechain" {
@{ Value = 103.1; Expected = 103.1 }, @{ Value = 3800; Expected = 3800 } $vmr.strip[$index].gate.bpsidechain = $msHz
) { $vmr.strip[$index].gate.bpsidechain | Should -Be $msHz
$vmr.strip[$index].gate.bpsidechain = $value
$vmr.strip[$index].gate.bpsidechain | Should -Be $expected
} }
It "Should set Strip[$index].Gate.Hold" -ForEach @( It "Should set Strip[$index].Gate.Hold" {
@{ Value = 0.3; Expected = 0.3 }, @{ Value = 5000; Expected = 5000 } $vmr.strip[$index].gate.hold = $msHz
) { $vmr.strip[$index].gate.hold | Should -Be $msHz
$vmr.strip[$index].gate.hold = $value }
$vmr.strip[$index].gate.hold | Should -Be $expected }
Context 'Denoiser' -Skip:$ifNotPotato {
It "Should set Strip[$index].Denoiser" {
$vmr.strip[$index].denoiser.knob = $knob
$vmr.strip[$index].denoiser.knob | Should -Be $knob
} }
} }
Context 'EQ' -Skip:$ifNotPotato -ForEach @( Context 'EQ' -Skip:$ifNotPotato -ForEach @(
@{ Eq = $vmr.strip[$index].eq } @{ Eq = $vmr.strip[$index].eq }
) { ) {
It "Should set Strip[$index].EQ.Channel[$strip_ch].Cell[$cells].F" -ForEach @( It "Should set Strip[$index].EQ.Channel[$strip_ch].Cell[$cells].F" {
@{ Value = 1234.6; Expected = 1234.6 }, @{ Value = 7500; Expected = 7500 } $eq.channel[$strip_ch].cell[$cells].f = $msHz
) { $eq.channel[$strip_ch].cell[$cells].f | Should -Be $msHz
$eq.channel[$strip_ch].cell[$cells].f = $value
$eq.channel[$strip_ch].cell[$cells].f | Should -Be $expected
} }
It "Should set Strip[$index].EQ.Channel[$strip_ch].Cell[$cells].Gain" -ForEach @( It "Should set Strip[$index].EQ.Channel[$strip_ch].Cell[$cells].Gain" {
@{ Value = 4.2; Expected = 4.2 }, @{ Value = -7.3; Expected = -7.3 } $eq.channel[$strip_ch].cell[$cells].gain = $slide
) { $eq.channel[$strip_ch].cell[$cells].gain | Should -Be $slide
$eq.channel[$strip_ch].cell[$cells].gain = $value
$eq.channel[$strip_ch].cell[$cells].gain | Should -Be $expected
} }
It "Should set Strip[$index].EQ.Channel[$strip_ch].Cell[$cells].Q" -ForEach @( It "Should set Strip[$index].EQ.Channel[$strip_ch].Cell[$cells].Q" {
@{ Value = 1.2; Expected = 1.2 }, @{ Value = 5.6; Expected = 5.6 } $eq.channel[$strip_ch].cell[$cells].q = $knob
) { $eq.channel[$strip_ch].cell[$cells].q | Should -Be $knob
$eq.channel[$strip_ch].cell[$cells].q = $value
$eq.channel[$strip_ch].cell[$cells].q | Should -Be $expected
} }
} }
} }
@ -339,47 +326,37 @@ Describe -Tag 'higher', -TestName 'All Higher Tests' {
Context 'Bus, one physical one virtual' -ForEach @( Context 'Bus, one physical one virtual' -ForEach @(
@{ Index = $phys_out }, @{ Index = $virt_out } @{ Index = $phys_out }, @{ Index = $virt_out }
) { ) {
It "Should set Bus[$index].Gain" -ForEach @( It "Should set Bus[$index].Gain" {
@{ Value = 5.2; Expected = 5.2 }, @{ Value = -38.2; Expected = -38.2 } $vmr.bus[$index].gain = $gain
) { $vmr.bus[$index].gain | Should -Be $gain
$vmr.bus[$index].gain = $value
$vmr.bus[$index].gain | Should -Be $expected
} }
Context 'EQ' -Skip:$ifBasic -ForEach @( Context 'EQ' -Skip:$ifBasic -ForEach @(
@{ Eq = $vmr.bus[$index].eq } @{ Eq = $vmr.bus[$index].eq }
) { ) {
It "Should set Bus[$index].EQ.Channel[$bus_ch].Cell[$cells].F" -ForEach @( It "Should set Bus[$index].EQ.Channel[$bus_ch].Cell[$cells].F" {
@{ Value = 1234.6; Expected = 1234.6 }, @{ Value = 7500; Expected = 7500 } $eq.channel[$bus_ch].cell[$cells].f = $msHz
) { $eq.channel[$bus_ch].cell[$cells].f | Should -Be $msHz
$eq.channel[$bus_ch].cell[$cells].f = $value
$eq.channel[$bus_ch].cell[$cells].f | Should -Be $expected
} }
It "Should set Bus[$index].EQ.Channel[$bus_ch].Cell[$cells].Gain" -ForEach @( It "Should set Bus[$index].EQ.Channel[$bus_ch].Cell[$cells].Gain" {
@{ Value = 4.2; Expected = 4.2 }, @{ Value = -7.3; Expected = -7.3 } $eq.channel[$bus_ch].cell[$cells].gain = $slide
) { $eq.channel[$bus_ch].cell[$cells].gain | Should -Be $slide
$eq.channel[$bus_ch].cell[$cells].gain = $value
$eq.channel[$bus_ch].cell[$cells].gain | Should -Be $expected
} }
It "Should set Bus[$index].EQ.Channel[$bus_ch].Cell[$cells].Q" -ForEach @( It "Should set Bus[$index].EQ.Channel[$bus_ch].Cell[$cells].Q" {
@{ Value = 1.2; Expected = 1.2 }, @{ Value = 5.6; Expected = 5.6 } $eq.channel[$bus_ch].cell[$cells].q = $knob
) { $eq.channel[$bus_ch].cell[$cells].q | Should -Be $knob
$eq.channel[$bus_ch].cell[$cells].q = $value
$eq.channel[$bus_ch].cell[$cells].q | Should -Be $expected
} }
} }
} }
Context 'Option' { Context 'Option' {
It "Should set and get Option.delay[$phys_out]" -ForEach @( It "Should set and get Option.delay[$phys_out]" {
@{ Value = 486.57 }, @{ Value = 26.41 } $vmr.option.delay[$phys_out].set($msHz)
) {
$vmr.option.delay[$phys_out].set($value)
$vmr.command.restart() $vmr.command.restart()
Start-Sleep -Milliseconds 2000 Start-Sleep -Milliseconds 2000
$vmr.option.delay[$phys_out].get() | Should -Be $value $vmr.option.delay[$phys_out].get() | Should -Be $msHz
} }
} }
} }
@ -908,7 +885,7 @@ Describe -Tag 'higher', -TestName 'All Higher Tests' {
$vmr.recorder.filetype = $filetype $vmr.recorder.filetype = $filetype
$vmr.recorder.state = 'record' $vmr.recorder.state = 'record'
Start-Sleep -Milliseconds 100 Start-Sleep -Milliseconds 10
$stamp = '{0:yyyy-MM-dd} at {0:HH}h{0:mm}m{0:ss}s' -f (Get-Date) $stamp = '{0:yyyy-MM-dd} at {0:HH}h{0:mm}m{0:ss}s' -f (Get-Date)
$vmr.recorder.state | Should -Be 'record' $vmr.recorder.state | Should -Be 'record'
Start-Sleep -Milliseconds 2000 Start-Sleep -Milliseconds 2000
@ -1002,7 +979,7 @@ Describe -Tag 'higher', -TestName 'All Higher Tests' {
BeforeEach { BeforeEach {
$vmr.recorder.record() $vmr.recorder.record()
Start-Sleep -Milliseconds 100 Start-Sleep -Milliseconds 10
$stamp = '{0:yyyy-MM-dd} at {0:HH}h{0:mm}m{0:ss}s' -f (Get-Date) $stamp = '{0:yyyy-MM-dd} at {0:HH}h{0:mm}m{0:ss}s' -f (Get-Date)
Start-Sleep -Milliseconds 2000 Start-Sleep -Milliseconds 2000

2
tests/run.ps1
View File

@ -12,7 +12,7 @@ function Test-RecDir ([object]$vmr, [string]$recDir) {
try { try {
$vmr.recorder.record() $vmr.recorder.record()
Start-Sleep -Milliseconds 100 Start-Sleep -Milliseconds 10
$stamp = '{0:yyyy-MM-dd} at {0:HH}h{0:mm}m{0:ss}s' -f (Get-Date) $stamp = '{0:yyyy-MM-dd} at {0:HH}h{0:mm}m{0:ss}s' -f (Get-Date)
Start-Sleep -Milliseconds 2000 Start-Sleep -Milliseconds 2000