94 Commits

Author SHA1 Message Date
7254a8af3f add release workflow 2026-03-04 18:03:51 +00:00
46053fdeda md fix 2026-03-04 16:59:25 +00:00
df5d9db528 bump all occurences of version in file headers 2026-03-04 16:56:31 +00:00
57d836178d update README to improve readability 2026-03-04 16:56:12 +00:00
a1556e38c8 improved parser that preserves quoted commands. 2026-03-04 16:55:18 +00:00
4e58015411 add bump task 2026-02-19 09:40:24 +00:00
6390f52420 use log_level to set level 2025-12-02 02:23:46 +00:00
fe969193f6 fix updated flags in Use section 2025-12-02 02:15:05 +00:00
1950d6dd8e update README with flag changes 2025-12-02 02:09:50 +00:00
ca15785789 -D flag changed to -l flag. It now expects a string. (DEBUG, INFO etc)
-v flag now prints the cli version

new flag -e prints extra console info

new flag -f, prevents the CLI from splitting strings on spaces. This allows users to pass string requests containing spaces (setting devices, naming channel labels etc)
2025-12-02 02:09:25 +00:00
12522667d3 remove workflow 2025-02-17 17:32:35 +00:00
aa6317c79e upd
gcc version
artifact path
2025-02-17 16:04:28 +00:00
57266334e8 upd step version 2025-02-17 15:57:40 +00:00
514e7fda7a remove version 2025-02-17 15:53:05 +00:00
354efdfe73 upd gcc step 2025-02-17 15:51:18 +00:00
7bbf438878 upd gcc step 2025-02-17 15:49:55 +00:00
dc8395c404 add release workflow 2025-02-17 15:25:01 +00:00
0affb2bf2d run through formatter 2025-02-07 23:02:10 +00:00
7f84267b5a use pwsh core 2025-02-07 11:39:07 +00:00
8e37cec719 add INC_DIR 2025-02-03 16:54:17 +00:00
95820c3043 split long commands across lines 2025-02-03 16:38:33 +00:00
87c2192403 upd var 2025-02-03 15:24:42 +00:00
29510feb8e upd vars 2025-02-03 06:45:30 +00:00
f2a3247077 use vars 2025-02-03 06:12:40 +00:00
452bf6f6de add Taskfile + .env 2025-02-03 06:08:33 +00:00
22b7e9a765 add comments to makefile 2025-01-28 22:27:20 +00:00
9388844acb add IS_64_BIT macro to interface.h 2024-07-25 22:14:06 +01:00
955edb781c get new len from strcspn
remove reset input buffer
2024-07-25 21:35:56 +01:00
a719af8265 use ++i 2024-07-25 17:34:38 +01:00
7c46f30e62 minor bump 2024-07-23 17:33:03 +01:00
41a256786f add terminate()
logs fatal, frees dyn memory and exits with EXIT_FAILURE
2024-07-23 17:27:47 +01:00
6179374eaa rename ivmr.c to interface.c
dynamically allocate interface memory.

remove global var iVMR

fix duplicate error code for VBVMR_Logout and VBVMR_RunVoicemeeter
2024-07-23 17:26:59 +01:00
086f5dd28a typo fix 2024-07-13 12:04:47 +01:00
2c1c7033d5 minor ver bump 2024-07-13 11:50:47 +01:00
218186781d test vmr for NULL, if so exit
log timeout if login() returns -2

make functions in this module static. They aren't expected to be called elsewhere
2024-07-13 11:47:37 +01:00
ca803c09ed add docstrings to the wrapper functions 2024-07-13 11:45:30 +01:00
9eb0d2f623 move clear back into wrapper.c
remove some of the duplicate includes
2024-07-13 11:44:57 +01:00
453797b0d9 create_interface() return NULL if interface fails to initialize 2024-07-13 11:43:21 +01:00
de70cd39cf move clear intil util.c 2024-07-12 18:46:05 +01:00
b225ba5cc3 allow clear to accept either dirty func as pointer 2024-07-12 17:09:12 +01:00
35335a60aa add with_prompt docstring 2024-07-12 15:01:30 +01:00
a7c0bc1620 fix comment 2024-07-12 12:05:43 +01:00
25692a9f35 increase input buffer size
when resetting buffer, clear only bits written to
2024-07-12 12:04:03 +01:00
a05b029e9d specify enum type 2024-07-11 18:45:35 +01:00
68c2022ad7 return quickcommands + i 2024-07-10 23:57:19 +01:00
ff2970f4c5 move quickcommands into parse_command() 2024-07-10 23:37:49 +01:00
f60fc231b0 add note about quick commands to README 2024-07-10 18:20:58 +01:00
c1dad8b99c minor bump 2024-07-10 18:17:13 +01:00
2f2e503ae3 implements a short list of quickcommands 2024-07-10 18:15:11 +01:00
ff69837f19 add LOGIN_TIMEOUT macro 2024-07-10 18:11:58 +01:00
b35a29396b add -I flag for disabling >> on the interactive prompt
return early from parse_input() if input is a comment

add comments to example_commands.txt

upd README.

minor ver bump
2024-07-10 10:51:53 +01:00
39540e9c3e add pragma macros,
silences -Wcast-function-type
2024-07-09 15:57:38 +01:00
af98dead75 swap blocks. 2024-07-09 15:11:48 +01:00
ad91a7f4e6 log fatal exit points 2024-07-09 13:18:57 +01:00
8d9e70b79a patch bump 2024-07-09 13:14:52 +01:00
d7d42e4b21 upd makefile to compile for c2x
replace fallthrough comment with fallthrough attribute
2024-07-09 12:59:46 +01:00
babec7abbb revert func signatures, we're getting compile warnings anyway 2024-07-09 12:58:06 +01:00
b2bdd21da5 add USAGE, OPTSTR macros
rename help() to usage()

log_warn() an unknown option

condense set_kind()
2024-07-09 12:43:32 +01:00
88fe1f5782 reword 2024-07-08 18:02:35 +01:00
82823687db minor bump 2024-07-08 18:01:10 +01:00
3d00c7dd4f upd parse_input() desc 2024-07-08 17:31:24 +01:00
c95ff0e163 add :, delimiters to parse_input()
remove replace_blanks_with_single_space()
2024-07-08 17:29:23 +01:00
48bb15e8f2 upd util.h 2024-07-08 16:39:03 +01:00
dc8a4036c8 upd utility functions 2024-07-08 16:01:14 +01:00
6b7e0afb91 add get desc 2024-07-08 08:45:14 +01:00
477267e278 add note about piping data to the CLI 2024-07-07 07:58:12 +01:00
bc7568a191 bump wait after loading config by 50ms 2024-07-07 07:38:39 +01:00
c5c9360d32 wait and then clear dirty parameters after loading a config 2024-07-07 07:01:03 +01:00
9ee3f42334 don't attempt to print a string result if parameter unknown 2024-07-07 06:30:20 +01:00
61d81b0abf fix docstring 2024-07-06 13:42:24 +01:00
03b45129dd fix link to Voicemeeter SDK license 2024-07-06 09:36:33 +01:00
b4519cc2cc upd docstrings in util.c 2024-07-06 09:09:11 +01:00
19a3a16b74 rename vmr module to wrapper.
rename cdll module to ivmr

upd doc strings
2024-07-06 09:03:13 +01:00
09793afafa upd instruction for -c.
giving file name is unreliable.
2024-07-05 12:05:50 +01:00
8bdbfe9b04 change -p for -c, seems more intuitive 2024-07-05 11:28:29 +01:00
f87977165a add -p flag for loading a user configuration file.
add -p explanation to README
2024-07-05 11:21:46 +01:00
36eadb4b58 remove func prototype 2024-07-05 10:51:26 +01:00
930093da7f add create_interface() to cdll.c.
Use it to initialize the dll interface and return a pointer to it.
2024-07-05 10:41:07 +01:00
a28db25bcc define mb function pointers in the iVMR interface.
add trace logs for login, logout and mb functions
2024-07-04 12:19:04 +01:00
83a85fd7c5 add new typedef struct *PT_VMR
use it to pass around references to the iVMR instance
2024-07-04 09:14:14 +01:00
f6437fcbe7 make static 2024-07-03 17:52:08 +01:00
fb54c4a492 fixes compiler error 'Incompatible pointer types' 2024-07-03 15:25:16 +01:00
8aeb793a41 fixes compiler error 'Forward declaration of enums' 2024-07-03 15:24:44 +01:00
b6b4b04a8a upd includes 2024-07-03 13:57:58 +01:00
b7fa15d87d log_warn an incorrect -D arg.
log_fatal possible exit points.
2024-07-03 12:58:34 +01:00
b95c40265c fix s flag in help message 2024-07-02 17:59:44 +01:00
4b64ae95fd add -m flag for launching macrobuttons app.
add -s flag for launching streamerview app

add -m, -s flags to Use section in README.
2024-07-02 17:49:51 +01:00
f8d2f80cbf remove the extra call to version 2024-07-02 14:49:42 +01:00
4b79b7f849 add -= example to README 2024-07-02 12:00:16 +01:00
3ec98ea391 add note about += and -= to README
add increment/decrement instructions to example_commands
2024-07-02 11:55:34 +01:00
faad5bc2c8 add doc comments 2024-07-02 11:15:17 +01:00
cc0ec73ef4 fix help dialogue 2024-07-02 10:25:25 +01:00
c45df11286 add -v flag to README use section 2024-07-02 10:24:07 +01:00
a383aaa36b reword
add link defs
2024-07-02 10:21:37 +01:00
20 changed files with 1948 additions and 1201 deletions

1
.env Normal file
View File

@@ -0,0 +1 @@
LOG_USE_COLOR=yes

98
.github/workflows/release.yml vendored Normal file
View File

@@ -0,0 +1,98 @@
name: Build vmrcli
on:
push:
tags:
- 'v*.*.*'
workflow_dispatch:
jobs:
build-windows:
runs-on: windows-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup MSYS2
uses: msys2/setup-msys2@v2
with:
msystem: MINGW64
update: true
install: >-
mingw-w64-x86_64-gcc
mingw-w64-x86_64-make
make
- name: Add MSYS2 to PATH
run: |
echo "${{ runner.temp }}\msys64\mingw64\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
echo "${{ runner.temp }}\msys64\usr\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
shell: pwsh
- name: Verify GCC installation
run: |
gcc --version
make --version
shell: pwsh
- name: Clean previous builds
run: make clean
shell: pwsh
continue-on-error: true
- name: Build vmrcli
run: make all
shell: pwsh
env:
LOG_USE_COLOR: yes
- name: Verify build output
run: |
if (Test-Path "bin/vmrcli.exe") {
Write-Host "✅ Build successful - vmrcli.exe created"
Get-Item "bin/vmrcli.exe" | Format-List Name, Length, LastWriteTime
} else {
Write-Host "❌ Build failed - vmrcli.exe not found"
exit 1
}
shell: pwsh
- name: Test executable
run: |
if (Test-Path "bin/vmrcli.exe") {
Write-Host "Testing vmrcli.exe..."
& ".\bin\vmrcli.exe" -h
}
shell: pwsh
continue-on-error: true
- name: Upload build artifact
uses: actions/upload-artifact@v4
with:
name: vmrcli-windows
path: |
bin/vmrcli.exe
retention-days: 30
- name: Upload build logs (on failure)
if: failure()
uses: actions/upload-artifact@v4
with:
name: build-logs
path: |
obj/
*.log
retention-days: 7
- name: Create GitHub Release
if: startsWith(github.ref, 'refs/tags/')
uses: softprops/action-gh-release@v2
with:
files: |
bin/vmrcli.exe
tag_name: ${{ github.ref_name }}
name: vmrcli ${{ github.ref_name }}
draft: false
prerelease: false
generate_release_notes: true

7
.gitignore vendored
View File

@@ -51,4 +51,11 @@ Module.symvers
Mkfile.old Mkfile.old
dkms.conf dkms.conf
# Task Runner
.task/
.vscode/ .vscode/
test/
test-*

182
README.md
View File

@@ -1,87 +1,191 @@
# Voicemeeter Remote Command Line Utility # Voicemeeter Remote Command Line Utility
## `Tested against` [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Platform](https://img.shields.io/badge/platform-Windows-blue)](#requirements)
- Basic 1.1.1.1 > A command-line interface for controlling Voicemeeter
- Banana 2.1.1.1
- Potato 3.1.1.1
## `Requirements` ## Compatibility
- [Voicemeeter](https://voicemeeter.com/) | Voicemeeter Version | Status |
|-------------------|--------|
| Basic 1.1.2.2 | ✅ Tested |
| Banana 2.1.2.2 | ✅ Tested |
| Potato 3.1.2.2 | ✅ Tested |
## `Use` ## Requirements
- **[Voicemeeter](https://voicemeeter.com/)** - Any version (Basic, Banana, or Potato)
- **Windows** operating system
- **Command line environment** (PowerShell, CMD, or Terminal)
## Usage
```powershell ```powershell
./vmrcli.exe [-h] [-i] [-k] [-D] <api commands> .\vmrcli.exe [OPTIONS] <api_commands>
``` ```
Where: ### Command Line Options
- `h`: Prints the help dialogue. | Option | Description | Example |
- `i`: Enable interactive mode. If set, any api commands passed on the command line will be ignored. |--------|-------------|----------|
- `k`: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI. | `-h` | Print help message | `vmrcli.exe -h` |
- `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL | `-v` | Show version information | `vmrcli.exe -v` |
| `-i` | Enable interactive mode | `vmrcli.exe -i` |
| `-I` | Interactive mode without prompt | `vmrcli.exe -I` |
| `-f` | Don't split input on spaces | `vmrcli.exe -f` |
| `-k <type>` | Launch Voicemeeter GUI | `-kbasic`, `-kbanana`, `-kpotato` |
| `-l <level>` | Set log level | `-lDEBUG`, `-lINFO`, `-lWARN` |
| `-e` | Enable extra console output | `vmrcli.exe -e` |
| `-c <path>` | Load user configuration | `-c "C:\config.txt"` |
| `-m` | Launch MacroButtons app | `vmrcli.exe -m` |
| `-s` | Launch StreamerView app | `vmrcli.exe -s` |
> **Note:** When using interactive mode (`-i`), command line API commands are ignored.
## `API Commands` ## `API Commands`
- Commands starting with `!` will be toggled, use it with boolean parameters. ### Command Types
- Commands containing `=` will set a value.
- All other commands with get a value.
Examples: | Syntax | Action | Example |
|--------|---------|---------|
| `!command` | **Toggle** boolean values | `!strip[0].mute` |
| `command=value` | **Set** a parameter | `strip[0].gain=2.5` |
| `command+=value` | **Increment** a parameter | `bus[0].gain+=1.2` |
| `command-=value` | **Decrement** a parameter | `bus[0].gain-=3.8` |
| `command` | **Get** current value | `strip[0].label` |
Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, then print its new value > **Tip:** Use quotes around values containing spaces: `'strip[0].label="my device"'`
---
### Examples
#### **Basic Operations**
*Toggle mute, get values, and adjust gain*
```powershell ```powershell
./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute .\vmrcli.exe -kbasic -lINFO !strip[0].mute strip[0].mute bus[0].gain-=3.8
``` ```
Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then print Strip 2 label #### **Setting Labels with Spaces**
*Set device labels and retrieve values*
```powershell ```powershell
./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label .\vmrcli.exe -kbanana -lDEBUG 'strip[0].label="my podmic"' strip[2].label
``` ```
## `Interactive Mode` #### **Device Configuration**
*Configure hardware devices with complex names*
Running the following command in Powershell:
```powershell ```powershell
./vmrcli.exe -i .\vmrcli.exe -lDEBUG bus[2].mute=1 bus[2].mute 'bus[2].device.wdm="Realtek Digital Output (Realtek(R) Audio)"'
``` ```
Will open an interactive prompt: #### **Batch Operations**
*Multiple strip configurations in one command*
```powershell
.\vmrcli.exe `
'strip[0].label="my podmic"' strip[0].label !strip[0].mute `
'strip[1].label="my wavemic"' strip[1].label !strip[1].mute
```
### Quick Commands
*Convenient shortcuts for common Voicemeeter operations*
| Command | API Equivalent | Description |
|---------|----------------|-------------|
| `lock` | `command.lock=1` | 🔒 Lock Voicemeeter parameters |
| `unlock` | `command.lock=0` | 🔓 Unlock Voicemeeter parameters |
| `show` | `command.show=1` | 👁️ Show Voicemeeter interface |
| `hide` | `command.show=0` | 🙈 Hide Voicemeeter interface |
| `restart` | `command.restart=1` | 🔄 Restart Voicemeeter engine |
> **Available in both direct and interactive modes**
## Interactive Mode
*Real-time command interface for live audio control*
**Start interactive session:**
```powershell
.\vmrcli.exe -i
```
**Interactive prompt:**
```powershell ```powershell
Interactive mode enabled. Enter 'Q' to exit. Interactive mode enabled. Enter 'Q' to exit.
>> >>
``` ```
API commands follow the same rules as listed above. Entering `Q` or `q` will exit the program. > **Important:** Command line API arguments are ignored when using `-i`
## `Script files` ## Script Files
Scripts can be loaded from text files, for example in Powershell: *Automate complex audio setups with script files*
### Loading Scripts
**From file content:**
```powershell ```powershell
./vmrcli.exe -D1 $(Get-Content .\example_commands.txt) .\vmrcli.exe -lDEBUG $(Get-Content .\example_commands.txt)
``` ```
Multiple API commands can be in a single line but they should be space separated. **Via pipeline:**
```powershell
$(Get-Content .\example_commands.txt) | .\vmrcli.exe -lDEBUG -I
```
## `Build` ### Script Format Rules
Run the included `makefile` with [GNU Make](https://www.gnu.org/software/make/). | Feature | Syntax | Example |
|---------|--------|----------|
| **Multiple commands per line** | Space, `;`, or `,` separated | `strip[0].mute=1;bus[0].gain+=2` |
| **Comments** | Lines starting with `#` | `# This is a comment` |
By default the log.c module is built with coloured logging enabled. To disable this you can override the `LOG_USE_COLOR` variable, for example: ## Build Instructions
`make LOG_USE_COLOR=no` *Compile from source using GNU Make*
## `Official Documentation` ### Prerequisites
- [GNU Make](https://www.gnu.org/software/make/)
- GCC compiler (recommended)
- Windows development environment
- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf) ### Build Commands
## `Special Thanks` ```bash
# Standard build
make
- [rxi](https://github.com/rxi) for writing the [log.c](https://github.com/rxi/log.c) package # Disable colored logging
make LOG_USE_COLOR=no
# Clean build artifacts
make clean
```
> **Pre-built binaries** are available in [Releases][releases] with coloured logging enabled
---
## Resources
### Official Documentation
- [Voicemeeter Remote C API][remoteapi-docs] - Complete API reference
### Acknowledgments
- **[rxi][rxi-user]** - Creator of the excellent [log.c][log-c] logging library
---
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
[releases]: https://github.com/onyx-and-iris/vmrcli/releases
[remoteapi-docs]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf
[rxi-user]: https://github.com/rxi
[log-c]: https://github.com/rxi/log.c

85
Taskfile.yml Normal file
View File

@@ -0,0 +1,85 @@
version: '3'
dotenv: ['.env']
vars:
PROGRAM: vmrcli
SHELL: pwsh
CC: gcc
SRC_DIR: src
INC_DIR: include
OBJ_DIR: obj
BIN_DIR: bin
CPPFLAGS: -I{{.INC_DIR}} -MMD -MP {{if eq .LOG_USE_COLOR "yes"}}-DLOG_USE_COLOR{{end}}
CFLAGS: -O -Wall -W -pedantic -ansi -std=c2x
LDFLAGS: -Llib
LDLIBS: -lm
tasks:
default:
desc: Build vmrcli for Windows
deps: [build]
build:
desc: Build vmrcli for Windows
deps: [link]
link:
desc: Link all files in obj/ for Windows
deps: [compile]
cmds:
- |
{{.SHELL}} -Command "
if (!(Test-Path -Path '{{.BIN_DIR}}')) {
New-Item -ItemType Directory -Path '{{.BIN_DIR}}'
}
{{.CC}} {{.LDFLAGS}} {{.OBJ_DIR}}/*.o {{.LDLIBS}} -o {{.BIN_DIR}}/{{.PROGRAM}}.exe"
sources:
- '{{.OBJ_DIR}}/**'
generates:
- '{{.BIN_DIR}}/{{.PROGRAM}}.exe'
compile:
desc: Compile all files in src/ and include/ for Windows
cmds:
- |
{{.SHELL}} -Command "
if (!(Test-Path -Path '{{.OBJ_DIR}}')) {
New-Item -ItemType Directory -Path '{{.OBJ_DIR}}'
}
Get-ChildItem -Path '{{.SRC_DIR}}' -Filter '*.c' |
ForEach-Object { \$_.Name -replace '\.c$', '' } |
ForEach-Object { {{.CC}} {{.CPPFLAGS}} {{.CFLAGS}} -c {{.SRC_DIR}}/\$_.c -o {{.OBJ_DIR}}/\$_.o }"
sources:
- '{{.SRC_DIR}}/**'
- '{{.INC_DIR}}/**'
generates:
- '{{.OBJ_DIR}}/**'
clean:
desc: Remove all files in obj/ and bin/
cmds:
- |
{{.SHELL}} -Command "
if (Test-Path -Path '{{.OBJ_DIR}}') { Remove-Item -Path '{{.OBJ_DIR}}' -Recurse -Force }
if (Test-Path -Path '{{.BIN_DIR}}') { Remove-Item -Path '{{.BIN_DIR}}' -Recurse -Force }"
bump:
desc: 'Bump the version. Usage: "task bump -- show" or "task bump -- [patch|minor|major]".'
preconditions:
- sh: 'pwsh -c "if (Get-Command bump) { exit 0 } else { exit 1 }"'
msg: "The 'bump' command is not available. Please install the required tools to use this command."
cmds:
- |
{{if eq .CLI_ARGS "show"}}
pwsh -c "bump show -f src/vmrcli.c -p \"#define VERSION .(\d+\.\d+\.\d+).\""
{{else}}
pwsh -c "bump {{.CLI_ARGS}} -w -f src/vmrcli.c -p \"#define VERSION .(\d+\.\d+\.\d+).\""
pwsh -c "bump {{.CLI_ARGS}} -w -f src/interface.c -f src/util.c -f src/vmrcli.c -f src/wrapper.c -p \"@version (\d+\.\d+\.\d+)\""
{{end}}

View File

@@ -1,3 +1,14 @@
# Strip 0
strip[0].mute !strip[0].mute strip[0].mute strip[0].gain strip[0].label=podmic strip[0].label strip[0].mute !strip[0].mute strip[0].mute strip[0].gain strip[0].label=podmic strip[0].label
strip[1].mute=1 strip[1].mute
bus[0].label bus[0].gain=-8.3 # Strip 1
strip[1].mute=1 strip[1].mute strip[1].limit-=8
# Strip 2
strip[2].gain-=5 strip[2].comp+=4.8
# Bus 0
bus[0].label
# Bus 1
bus[1].gain-=5.8

View File

@@ -1,5 +1,5 @@
/******************************************************************************/ /******************************************************************************/
/* Voicemeeter Remote API. V.Burel©2015-2023 */ /* Voicemeeter Remote API. V.Burel<EFBFBD>2015-2023 */
/******************************************************************************/ /******************************************************************************/
/* This Library allows communication with Voicemeeter applications */ /* This Library allows communication with Voicemeeter applications */
/* 4 Client Applications can be connected to remote Voicemeeter. */ /* 4 Client Applications can be connected to remote Voicemeeter. */
@@ -19,25 +19,24 @@
/* long = 32 bit integer */ /* long = 32 bit integer */
/******************************************************************************/ /******************************************************************************/
#ifndef __VOICEMEETER_REMOTE_H__ #ifndef __VOICEMEETER_REMOTE_H__
#define __VOICEMEETER_REMOTE_H__ #define __VOICEMEETER_REMOTE_H__
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C"
{
#endif #endif
#define VBVMR_RESULT_OK 0 #define VBVMR_RESULT_OK 0
/******************************************************************************/ /******************************************************************************/
/* */ /* */
/* Login */ /* Login */
/* */ /* */
/******************************************************************************/ /******************************************************************************/
/** @name Communication Login / logout /** @name Communication Login / logout
* @{ */ * @{ */
/** /**
@brief Open Communication Pipe With Voicemeeter (typically called on software startup). @brief Open Communication Pipe With Voicemeeter (typically called on software startup).
@@ -47,15 +46,14 @@ extern "C" {
-2: unexpected login (logout was expected before). -2: unexpected login (logout was expected before).
*/ */
long __stdcall VBVMR_Login(void); long __stdcall VBVMR_Login(void);
/** /**
@brief Close Communication Pipe With Voicemeeter (typically called on software end). @brief Close Communication Pipe With Voicemeeter (typically called on software end).
@return : 0 if ok. @return : 0 if ok.
*/ */
long __stdcall VBVMR_Logout(void); long __stdcall VBVMR_Logout(void);
/** /**
@brief Run Voicemeeter Application (get installation directory and run Voicemeeter Application). @brief Run Voicemeeter Application (get installation directory and run Voicemeeter Application).
@@ -65,29 +63,18 @@ long __stdcall VBVMR_Logout(void);
-2: unknown vType number -2: unknown vType number
*/ */
long __stdcall VBVMR_RunVoicemeeter(long vType); long __stdcall VBVMR_RunVoicemeeter(long vType);
/** @} */
/** @} */ /******************************************************************************/
/* */
/* General Information */
/* */
/******************************************************************************/
/** @name General Information
* @{ */
/******************************************************************************/
/* */
/* General Information */
/* */
/******************************************************************************/
/** @name General Information
* @{ */
/** /**
@brief Get Voicemeeter Type @brief Get Voicemeeter Type
@@ -117,7 +104,7 @@ long __stdcall VBVMR_RunVoicemeeter(long vType);
-2: no server. -2: no server.
*/ */
long __stdcall VBVMR_GetVoicemeeterType(long * pType); long __stdcall VBVMR_GetVoicemeeterType(long *pType);
/** /**
@brief Get Voicemeeter Version @brief Get Voicemeeter Version
@@ -132,36 +119,18 @@ long __stdcall VBVMR_GetVoicemeeterType(long * pType);
-2: no server. -2: no server.
*/ */
long __stdcall VBVMR_GetVoicemeeterVersion(long * pVersion); long __stdcall VBVMR_GetVoicemeeterVersion(long *pVersion);
/** @} */
/** @} */ /******************************************************************************/
/* */
/* Get parameters */
/* */
/******************************************************************************/
/** @name Getting Parameters
* @{ */
/******************************************************************************/
/* */
/* Get parameters */
/* */
/******************************************************************************/
/** @name Getting Parameters
* @{ */
/** /**
@brief Check if parameters have changed. @brief Check if parameters have changed.
@@ -174,7 +143,7 @@ long __stdcall VBVMR_GetVoicemeeterVersion(long * pVersion);
-2: no server. -2: no server.
*/ */
long __stdcall VBVMR_IsParametersDirty(void); long __stdcall VBVMR_IsParametersDirty(void);
/** /**
@brief get parameter value. @brief get parameter value.
@@ -187,7 +156,7 @@ long __stdcall VBVMR_IsParametersDirty(void);
-5: structure mismatch -5: structure mismatch
*/ */
long __stdcall VBVMR_GetParameterFloat(char * szParamName, float * pValue); long __stdcall VBVMR_GetParameterFloat(char *szParamName, float *pValue);
/** /**
@brief get parameter value. @brief get parameter value.
@@ -200,27 +169,19 @@ long __stdcall VBVMR_GetParameterFloat(char * szParamName, float * pValue);
-5: structure mismatch -5: structure mismatch
*/ */
long __stdcall VBVMR_GetParameterStringA(char * szParamName, char * szString); long __stdcall VBVMR_GetParameterStringA(char *szParamName, char *szString);
long __stdcall VBVMR_GetParameterStringW(char * szParamName, unsigned short * wszString); long __stdcall VBVMR_GetParameterStringW(char *szParamName, unsigned short *wszString);
/** @} */ /** @} */
/******************************************************************************/
/* */
/* Get levels */
/* */
/******************************************************************************/
/** @name Getting RT Data
* @{ */
/******************************************************************************/
/* */
/* Get levels */
/* */
/******************************************************************************/
/** @name Getting RT Data
* @{ */
/** /**
@brief Get Current levels. @brief Get Current levels.
@@ -281,8 +242,7 @@ long __stdcall VBVMR_GetParameterStringW(char * szParamName, unsigned short * ws
-4: out of range -4: out of range
*/ */
long __stdcall VBVMR_GetLevel(long nType, long nuChannel, float * pValue); long __stdcall VBVMR_GetLevel(long nType, long nuChannel, float *pValue);
/** /**
@brief Get MIDI message from M.I.D.I. input device used by Voicemeeter M.I.D.I. mapping. @brief Get MIDI message from M.I.D.I. input device used by Voicemeeter M.I.D.I. mapping.
@@ -301,9 +261,7 @@ long __stdcall VBVMR_GetLevel(long nType, long nuChannel, float * pValue);
-6: no MIDI data -6: no MIDI data
*/ */
long __stdcall VBVMR_GetMidiMessage(unsigned char *pMIDIBuffer, long nbByteMax);
long __stdcall VBVMR_GetMidiMessage(unsigned char *pMIDIBuffer, long nbByteMax);
/** /**
@brief Send MIDI message to M.I.D.I. output device used by Voicemeeter M.I.D.I. mapping. @brief Send MIDI message to M.I.D.I. output device used by Voicemeeter M.I.D.I. mapping.
@@ -319,29 +277,18 @@ long __stdcall VBVMR_GetMidiMessage(unsigned char *pMIDIBuffer, long nbByteMax);
-5: cannot send MIDI data -5: cannot send MIDI data
*/ */
long __stdcall VBVMR_SendMidiMessage(unsigned char *pMIDIBuffer, long nbByte);
long __stdcall VBVMR_SendMidiMessage(unsigned char *pMIDIBuffer, long nbByte); /** @} */
/******************************************************************************/
/* */
/* Set Parameters */
/* */
/******************************************************************************/
/** @} */ /** @name Setting Parameters
* @{ */
/******************************************************************************/
/* */
/* Set Parameters */
/* */
/******************************************************************************/
/** @name Setting Parameters
* @{ */
/** /**
@brief Set a single float 32 bits parameters . @brief Set a single float 32 bits parameters .
@@ -359,9 +306,7 @@ long __stdcall VBVMR_SendMidiMessage(unsigned char *pMIDIBuffer, long nbByte);
-3: unknown parameter -3: unknown parameter
*/ */
long __stdcall VBVMR_SetParameterFloat(char * szParamName, float Value); long __stdcall VBVMR_SetParameterFloat(char *szParamName, float Value);
/** /**
@brief Set a single string parameters . @brief Set a single string parameters .
@@ -379,12 +324,8 @@ long __stdcall VBVMR_SetParameterFloat(char * szParamName, float Value);
*/ */
long __stdcall VBVMR_SetParameterStringA(char *szParamName, char *szString);
long __stdcall VBVMR_SetParameterStringA(char * szParamName, char * szString); long __stdcall VBVMR_SetParameterStringW(char *szParamName, unsigned short *wszString);
long __stdcall VBVMR_SetParameterStringW(char * szParamName, unsigned short * wszString);
/** /**
@brief Set one or several parameters by a script ( < 48 kB ). @brief Set one or several parameters by a script ( < 48 kB ).
@@ -407,29 +348,17 @@ long __stdcall VBVMR_SetParameterStringW(char * szParamName, unsigned short * ws
-4: unexpected error -4: unexpected error
*/ */
long __stdcall VBVMR_SetParameters(char * szParamScript); long __stdcall VBVMR_SetParameters(char *szParamScript);
long __stdcall VBVMR_SetParametersW(unsigned short * szParamScript); long __stdcall VBVMR_SetParametersW(unsigned short *szParamScript);
/** @} */
/** @} */ /******************************************************************************/
/* DEVICES ENUMERATOR */
/******************************************************************************/
/** @name Device Enumeration Functions
* @{ */
/******************************************************************************/
/* DEVICES ENUMERATOR */
/******************************************************************************/
/** @name Device Enumeration Functions
* @{ */
#define VBVMR_DEVTYPE_MME 1 #define VBVMR_DEVTYPE_MME 1
#define VBVMR_DEVTYPE_WDM 3 #define VBVMR_DEVTYPE_WDM 3
@@ -441,7 +370,7 @@ long __stdcall VBVMR_SetParametersW(unsigned short * szParamScript);
@return : return number of device found. @return : return number of device found.
*/ */
long __stdcall VBVMR_Output_GetDeviceNumber(void); long __stdcall VBVMR_Output_GetDeviceNumber(void);
/** /**
@brief Return pointer on Output Device Descriptor according index @brief Return pointer on Output Device Descriptor according index
@@ -452,15 +381,15 @@ long __stdcall VBVMR_Output_GetDeviceNumber(void);
@return : 0: OK (no error). @return : 0: OK (no error).
*/ */
long __stdcall VBVMR_Output_GetDeviceDescA(long zindex, long * nType, char * szDeviceName, char * szHardwareId); long __stdcall VBVMR_Output_GetDeviceDescA(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
long __stdcall VBVMR_Output_GetDeviceDescW(long zindex, long * nType, unsigned short * wszDeviceName, unsigned short * wszHardwareId); long __stdcall VBVMR_Output_GetDeviceDescW(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
/** /**
@brief Get number of Audio Input Device available on the system @brief Get number of Audio Input Device available on the system
@return : return number of device found. @return : return number of device found.
*/ */
long __stdcall VBVMR_Input_GetDeviceNumber(void); long __stdcall VBVMR_Input_GetDeviceNumber(void);
/** /**
@brief Return pointer on Input Device Descriptor according index @brief Return pointer on Input Device Descriptor according index
@@ -471,50 +400,40 @@ long __stdcall VBVMR_Input_GetDeviceNumber(void);
@return : 0: OK (no error). @return : 0: OK (no error).
*/ */
long __stdcall VBVMR_Input_GetDeviceDescA(long zindex, long * nType, char * szDeviceName, char * szHardwareId); long __stdcall VBVMR_Input_GetDeviceDescA(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
long __stdcall VBVMR_Input_GetDeviceDescW(long zindex, long * nType, unsigned short * wszDeviceName, unsigned short * wszHardwareId); long __stdcall VBVMR_Input_GetDeviceDescW(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
/** @} */
/******************************************************************************/
/* VB-AUDIO CALLBACK */
/******************************************************************************/
/* 4x Functions to process all voicemeeter audio input and output channels */
/* */
/* VBVMR_AudioCallbackRegister :to register your audio callback(s) */
/* VBVMR_AudioCallbackStart :to start the audio stream */
/* VBVMR_AudioCallbackStop :to stop the audio stream */
/* VBVMR_AudioCallbackUnregister :to unregister / Release callback(s) */
/******************************************************************************/
/** @} */ /** @name VB-Audio Callback Functions
* @{ */
typedef struct tagVBVMR_AUDIOINFO
{
/******************************************************************************/
/* VB-AUDIO CALLBACK */
/******************************************************************************/
/* 4x Functions to process all voicemeeter audio input and output channels */
/* */
/* VBVMR_AudioCallbackRegister :to register your audio callback(s) */
/* VBVMR_AudioCallbackStart :to start the audio stream */
/* VBVMR_AudioCallbackStop :to stop the audio stream */
/* VBVMR_AudioCallbackUnregister :to unregister / Release callback(s) */
/******************************************************************************/
/** @name VB-Audio Callback Functions
* @{ */
typedef struct tagVBVMR_AUDIOINFO
{
long samplerate; long samplerate;
long nbSamplePerFrame; long nbSamplePerFrame;
} VBVMR_T_AUDIOINFO, *VBVMR_PT_AUDIOINFO, *VBVMR_LPT_AUDIOINFO; } VBVMR_T_AUDIOINFO, *VBVMR_PT_AUDIOINFO, *VBVMR_LPT_AUDIOINFO;
typedef struct tagVBVMR_AUDIOBUFFER
{
long audiobuffer_sr; //Sampling Rate
long audiobuffer_nbs; //number of sample per frame
long audiobuffer_nbi; //number of inputs
long audiobuffer_nbo; //number of outputs
float * audiobuffer_r[128]; //nbi input pointers containing frame of nbs sample (of 32bits float)
float * audiobuffer_w[128]; //nbo output pointers containing frame of nbs sample (of 32bits float)
} VBVMR_T_AUDIOBUFFER, *VBVMR_PT_AUDIOBUFFER, *VBVMR_LPT_AUDIOBUFFER;
typedef struct tagVBVMR_AUDIOBUFFER
{
long audiobuffer_sr; // Sampling Rate
long audiobuffer_nbs; // number of sample per frame
long audiobuffer_nbi; // number of inputs
long audiobuffer_nbo; // number of outputs
float *audiobuffer_r[128]; // nbi input pointers containing frame of nbs sample (of 32bits float)
float *audiobuffer_w[128]; // nbo output pointers containing frame of nbs sample (of 32bits float)
} VBVMR_T_AUDIOBUFFER, *VBVMR_PT_AUDIOBUFFER, *VBVMR_LPT_AUDIOBUFFER;
/** /**
@brief VB-AUDIO Callback is called for different task to Initialize, perform and end your process. @brief VB-AUDIO Callback is called for different task to Initialize, perform and end your process.
@@ -533,23 +452,21 @@ typedef struct tagVBVMR_AUDIOBUFFER
@return : 0: always 0 (unused). @return : 0: always 0 (unused).
*/ */
typedef long(__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void *lpUser, long nCommand, void *lpData, long nnn);
typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand, void * lpData, long nnn); #define VBVMR_CBCOMMAND_STARTING 1 // command to initialize data according SR and buffer size
// info = (VBVMR_LPT_AUDIOINFO)lpData
#define VBVMR_CBCOMMAND_ENDING 2 // command to release data
#define VBVMR_CBCOMMAND_CHANGE 3 // If change in audio stream, you will have to restart audio
#define VBVMR_CBCOMMAND_STARTING 1 //command to initialize data according SR and buffer size #define VBVMR_CBCOMMAND_BUFFER_IN 10 // input insert
//info = (VBVMR_LPT_AUDIOINFO)lpData #define VBVMR_CBCOMMAND_BUFFER_OUT 11 // bus output insert
#define VBVMR_CBCOMMAND_BUFFER_MAIN 20 // all i/o
// audiobuffer = (VBVMR_LPT_AUDIOBUFFER)lpData
// nnn = synchro = 1 if synchro with Voicemeeter
#define VBVMR_CBCOMMAND_ENDING 2 //command to release data /*
#define VBVMR_CBCOMMAND_CHANGE 3 //If change in audio stream, you will have to restart audio
#define VBVMR_CBCOMMAND_BUFFER_IN 10 //input insert
#define VBVMR_CBCOMMAND_BUFFER_OUT 11 //bus output insert
#define VBVMR_CBCOMMAND_BUFFER_MAIN 20 //all i/o
//audiobuffer = (VBVMR_LPT_AUDIOBUFFER)lpData
//nnn = synchro = 1 if synchro with Voicemeeter
/*
----------------------------------------------------- -----------------------------------------------------
AUDIO BUFFER for VBVMR_CBCOMMAND_BUFFER_IN AUDIO BUFFER for VBVMR_CBCOMMAND_BUFFER_IN
----------------------------------------------------- -----------------------------------------------------
@@ -572,9 +489,9 @@ typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand,
| 00 | 01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | | 00 | 01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 |
----------------------------------------------------- -----------------------------------------------------
AUDIO BUFFER for VBVMR_CBCOMMAND_BUFFER_OUT AUDIO BUFFER for VBVMR_CBCOMMAND_BUFFER_OUT
----------------------------------------------------- -----------------------------------------------------
VOICEMEETER VOICEMEETER
| Output A1 / A2 | Virtual Output | | Output A1 / A2 | Virtual Output |
@@ -603,9 +520,9 @@ typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand,
| 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 |
----------------------------------------------------- -----------------------------------------------------
AUDIO BUFFER for VBVMR_CBCOMMAND_BUFFER_MAIN AUDIO BUFFER for VBVMR_CBCOMMAND_BUFFER_MAIN
----------------------------------------------------- -----------------------------------------------------
VOICEMEETER VOICEMEETER
| Strip 1 | Strip 2 | Virtual Input | | Strip 1 | Strip 2 | Virtual Input |
@@ -656,7 +573,7 @@ typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand,
| 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 |
*/ */
/** /**
@brief register your audio callback function to receive real time audio buffer @brief register your audio callback function to receive real time audio buffer
@@ -678,11 +595,11 @@ typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand,
1: callback already registered (by another application). 1: callback already registered (by another application).
*/ */
long __stdcall VBVMR_AudioCallbackRegister(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void * lpUser, char szClientName[64]); long __stdcall VBVMR_AudioCallbackRegister(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void *lpUser, char szClientName[64]);
#define VBVMR_AUDIOCALLBACK_IN 0x00000001 //to process input insert #define VBVMR_AUDIOCALLBACK_IN 0x00000001 // to process input insert
#define VBVMR_AUDIOCALLBACK_OUT 0x00000002 //to process output bus insert #define VBVMR_AUDIOCALLBACK_OUT 0x00000002 // to process output bus insert
#define VBVMR_AUDIOCALLBACK_MAIN 0x00000004 //to receive all i/o #define VBVMR_AUDIOCALLBACK_MAIN 0x00000004 // to receive all i/o
/** /**
@brief Start / Stop Audio processing @brief Start / Stop Audio processing
@@ -693,9 +610,8 @@ long __stdcall VBVMR_AudioCallbackRegister(long mode, T_VBVMR_VBAUDIOCALLBACK pC
-2: no callback registred. -2: no callback registred.
*/ */
long __stdcall VBVMR_AudioCallbackStart(void); long __stdcall VBVMR_AudioCallbackStart(void);
long __stdcall VBVMR_AudioCallbackStop(void); long __stdcall VBVMR_AudioCallbackStop(void);
/** /**
@brief unregister your callback to release voicemeeter virtual driver @brief unregister your callback to release voicemeeter virtual driver
@@ -706,25 +622,18 @@ long __stdcall VBVMR_AudioCallbackStop(void);
1: callback already unregistered. 1: callback already unregistered.
*/ */
long __stdcall VBVMR_AudioCallbackUnregister(void); long __stdcall VBVMR_AudioCallbackUnregister(void);
/** @} */
/******************************************************************************/
/* */
/* Macro Buttons */
/* */
/******************************************************************************/
/** @} */ /** @name Macro Buttons functions
* @{ */
/******************************************************************************/
/* */
/* Macro Buttons */
/* */
/******************************************************************************/
/** @name Macro Buttons functions
* @{ */
/** /**
@brief Check if Macro Buttons states changed. @brief Check if Macro Buttons states changed.
@@ -737,7 +646,7 @@ long __stdcall VBVMR_AudioCallbackUnregister(void);
-2: no server. -2: no server.
*/ */
long __stdcall VBVMR_MacroButton_IsDirty(void); long __stdcall VBVMR_MacroButton_IsDirty(void);
/** /**
@brief get current status of a given button. @brief get current status of a given button.
@@ -751,7 +660,7 @@ long __stdcall VBVMR_MacroButton_IsDirty(void);
-5: structure mismatch -5: structure mismatch
*/ */
long __stdcall VBVMR_MacroButton_GetStatus(long nuLogicalButton, float * pValue, long bitmode); long __stdcall VBVMR_MacroButton_GetStatus(long nuLogicalButton, float *pValue, long bitmode);
/** /**
@brief set current button value. @brief set current button value.
@@ -765,72 +674,59 @@ long __stdcall VBVMR_MacroButton_GetStatus(long nuLogicalButton, float * pValue,
-5: structure mismatch -5: structure mismatch
*/ */
long __stdcall VBVMR_MacroButton_SetStatus(long nuLogicalButton, float fValue, long bitmode); long __stdcall VBVMR_MacroButton_SetStatus(long nuLogicalButton, float fValue, long bitmode);
#define VBVMR_MACROBUTTON_MODE_DEFAULT 0x00000000 //PUSH or RELEASE button #define VBVMR_MACROBUTTON_MODE_DEFAULT 0x00000000 // PUSH or RELEASE button
#define VBVMR_MACROBUTTON_MODE_STATEONLY 0x00000002 //change Displayed State only #define VBVMR_MACROBUTTON_MODE_STATEONLY 0x00000002 // change Displayed State only
#define VBVMR_MACROBUTTON_MODE_TRIGGER 0x00000003 //change Trigger State #define VBVMR_MACROBUTTON_MODE_TRIGGER 0x00000003 // change Trigger State
#define VBVMR_MACROBUTTON_MODE_COLOR 0x00000004 //change color #define VBVMR_MACROBUTTON_MODE_COLOR 0x00000004 // change color
/** @} */
/******************************************************************************/
/* 'C' STRUCTURED INTERFACE */
/******************************************************************************/
/** @} */ typedef long(__stdcall *T_VBVMR_Login)(void);
typedef long(__stdcall *T_VBVMR_Logout)(void);
typedef long(__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
typedef long(__stdcall *T_VBVMR_GetVoicemeeterType)(long *pType);
typedef long(__stdcall *T_VBVMR_GetVoicemeeterVersion)(long *pVersion);
typedef long(__stdcall *T_VBVMR_IsParametersDirty)(void);
typedef long(__stdcall *T_VBVMR_GetParameterFloat)(char *szParamName, float *pValue);
typedef long(__stdcall *T_VBVMR_GetParameterStringA)(char *szParamName, char *szString);
typedef long(__stdcall *T_VBVMR_GetParameterStringW)(char *szParamName, unsigned short *wszString);
typedef long(__stdcall *T_VBVMR_GetLevel)(long nType, long nuChannel, float *pValue);
typedef long(__stdcall *T_VBVMR_GetMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long(__stdcall *T_VBVMR_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long(__stdcall *T_VBVMR_SetParameterFloat)(char *szParamName, float Value);
typedef long(__stdcall *T_VBVMR_SetParameters)(char *szParamScript);
typedef long(__stdcall *T_VBVMR_SetParametersW)(unsigned short *szParamScript);
typedef long(__stdcall *T_VBVMR_SetParameterStringA)(char *szParamName, char *szString);
typedef long(__stdcall *T_VBVMR_SetParameterStringW)(char *szParamName, unsigned short *wszString);
typedef long(__stdcall *T_VBVMR_Output_GetDeviceNumber)(void);
typedef long(__stdcall *T_VBVMR_Output_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
typedef long(__stdcall *T_VBVMR_Output_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
typedef long(__stdcall *T_VBVMR_Input_GetDeviceNumber)(void);
typedef long(__stdcall *T_VBVMR_Input_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
typedef long(__stdcall *T_VBVMR_Input_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
typedef long(__stdcall *T_VBVMR_AudioCallbackRegister)(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void *lpUser, char szClientName[64]);
typedef long(__stdcall *T_VBVMR_AudioCallbackStart)(void);
typedef long(__stdcall *T_VBVMR_AudioCallbackStop)(void);
typedef long(__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
typedef long(__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
typedef long(__stdcall *T_VBVMR_MacroButton_GetStatus)(long nuLogicalButton, float *pValue, long bitmode);
typedef long(__stdcall *T_VBVMR_MacroButton_SetStatus)(long nuLogicalButton, float fValue, long bitmode);
typedef struct tagVBVMR_INTERFACE
/******************************************************************************/ {
/* 'C' STRUCTURED INTERFACE */
/******************************************************************************/
typedef long (__stdcall *T_VBVMR_Login)(void);
typedef long (__stdcall *T_VBVMR_Logout)(void);
typedef long (__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
typedef long (__stdcall *T_VBVMR_GetVoicemeeterType)(long * pType);
typedef long (__stdcall *T_VBVMR_GetVoicemeeterVersion)(long * pVersion);
typedef long (__stdcall *T_VBVMR_IsParametersDirty)(void);
typedef long (__stdcall *T_VBVMR_GetParameterFloat)(char * szParamName, float * pValue);
typedef long (__stdcall *T_VBVMR_GetParameterStringA)(char * szParamName, char * szString);
typedef long (__stdcall *T_VBVMR_GetParameterStringW)(char * szParamName, unsigned short * wszString);
typedef long (__stdcall *T_VBVMR_GetLevel)(long nType, long nuChannel, float * pValue);
typedef long (__stdcall *T_VBVMR_GetMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long (__stdcall *T_VBVMR_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long (__stdcall *T_VBVMR_SetParameterFloat)(char * szParamName, float Value);
typedef long (__stdcall *T_VBVMR_SetParameters)(char * szParamScript);
typedef long (__stdcall *T_VBVMR_SetParametersW)(unsigned short * szParamScript);
typedef long (__stdcall *T_VBVMR_SetParameterStringA)(char * szParamName, char * szString);
typedef long (__stdcall *T_VBVMR_SetParameterStringW)(char * szParamName, unsigned short * wszString);
typedef long (__stdcall *T_VBVMR_Output_GetDeviceNumber)(void);
typedef long (__stdcall *T_VBVMR_Output_GetDeviceDescA)(long zindex, long * nType, char * szDeviceName, char * szHardwareId);
typedef long (__stdcall *T_VBVMR_Output_GetDeviceDescW)(long zindex, long * nType, unsigned short * wszDeviceName, unsigned short * wszHardwareId);
typedef long (__stdcall *T_VBVMR_Input_GetDeviceNumber)(void);
typedef long (__stdcall *T_VBVMR_Input_GetDeviceDescA)(long zindex, long * nType, char * szDeviceName, char * szHardwareId);
typedef long (__stdcall *T_VBVMR_Input_GetDeviceDescW)(long zindex, long * nType, unsigned short * wszDeviceName, unsigned short * wszHardwareId);
typedef long (__stdcall *T_VBVMR_AudioCallbackRegister)(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void * lpUser, char szClientName[64]);
typedef long (__stdcall *T_VBVMR_AudioCallbackStart)(void);
typedef long (__stdcall *T_VBVMR_AudioCallbackStop)(void);
typedef long (__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
typedef long (__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
typedef long (__stdcall *T_VBVMR_MacroButton_GetStatus)(long nuLogicalButton, float * pValue, long bitmode);
typedef long (__stdcall *T_VBVMR_MacroButton_SetStatus)(long nuLogicalButton, float fValue, long bitmode);
typedef struct tagVBVMR_INTERFACE
{
T_VBVMR_Login VBVMR_Login; T_VBVMR_Login VBVMR_Login;
T_VBVMR_Logout VBVMR_Logout; T_VBVMR_Logout VBVMR_Logout;
T_VBVMR_RunVoicemeeter VBVMR_RunVoicemeeter; T_VBVMR_RunVoicemeeter VBVMR_RunVoicemeeter;
@@ -867,34 +763,27 @@ typedef struct tagVBVMR_INTERFACE
T_VBVMR_MacroButton_GetStatus VBVMR_MacroButton_GetStatus; T_VBVMR_MacroButton_GetStatus VBVMR_MacroButton_GetStatus;
T_VBVMR_MacroButton_SetStatus VBVMR_MacroButton_SetStatus; T_VBVMR_MacroButton_SetStatus VBVMR_MacroButton_SetStatus;
} T_VBVMR_INTERFACE, *PT_VBVMR_INTERFACE, *LPT_VBVMR_INTERFACE, *PT_VMR;
} T_VBVMR_INTERFACE, *PT_VBVMR_INTERFACE, *LPT_VBVMR_INTERFACE;
#ifdef VBUSE_LOCALLIB #ifdef VBUSE_LOCALLIB
// internal used (not public) // internal used (not public)
void __stdcall VBVMR_SetHinstance(HINSTANCE hinst); void __stdcall VBVMR_SetHinstance(HINSTANCE hinst);
#endif #endif
/******************************************************************************/
/* VBAN RT PACKET */
/******************************************************************************/
/******************************************************************************/
/* VBAN RT PACKET */
/******************************************************************************/
#pragma pack(1) #pragma pack(1)
// short = 2 bytes // short = 2 bytes
// char = 1 byte // char = 1 byte
// COMPATIBILITY: defined structure cannot be changed. // COMPATIBILITY: defined structure cannot be changed.
// some field could be added at the end of the structure to keep the compatibility in the time. // some field could be added at the end of the structure to keep the compatibility in the time.
typedef struct tagVBAN_VMRT_PACKET //packedt ident: 0 typedef struct tagVBAN_VMRT_PACKET // packedt ident: 0
{ {
unsigned char voicemeeterType; // 1 = Voicemeeter, 2= Voicemeeter Banana, 3 Potato unsigned char voicemeeterType; // 1 = Voicemeeter, 2= Voicemeeter Banana, 3 Potato
unsigned char reserved; // unused unsigned char reserved; // unused
unsigned short buffersize; // main stream buffer size unsigned short buffersize; // main stream buffer size
@@ -917,9 +806,9 @@ typedef struct tagVBAN_VMRT_PACKET //packedt ident: 0
short busGaindB100[8]; // Bus Gain in dB * 100 short busGaindB100[8]; // Bus Gain in dB * 100
char stripLabelUTF8c60[8][60]; // Strip Label char stripLabelUTF8c60[8][60]; // Strip Label
char busLabelUTF8c60[8][60]; // Bus Label char busLabelUTF8c60[8][60]; // Bus Label
} T_VBAN_VMRT_PACKET, *PT_VBAN_VMRT_PACKET, *LPT_VBAN_VMRT_PACKET; } T_VBAN_VMRT_PACKET, *PT_VBAN_VMRT_PACKET, *LPT_VBAN_VMRT_PACKET;
#define expected_size_T_VBAN_VMRT_PACKET 1384 //1436 max #define expected_size_T_VBAN_VMRT_PACKET 1384 // 1436 max
#pragma pack() #pragma pack()
@@ -971,16 +860,15 @@ typedef struct tagVBAN_VMRT_PACKET //packedt ident: 0
#define VMRTSTATE_MODE_SEL 0x10000000 #define VMRTSTATE_MODE_SEL 0x10000000
#define VMRTSTATE_MODE_MONITOR 0x20000000 #define VMRTSTATE_MODE_MONITOR 0x20000000
#pragma pack(1) #pragma pack(1)
// long = 4 bytes // long = 4 bytes
// short = 2 bytes // short = 2 bytes
// char = 1 byte // char = 1 byte
// float = 4 bytes // float = 4 bytes
typedef struct tagVBAN_VMPARAM_STRIP typedef struct tagVBAN_VMPARAM_STRIP
{ {
long mode; long mode;
float dblevel; // x 100 float dblevel; // x 100
short Audibility; // x 100 short Audibility; // x 100
@@ -992,7 +880,7 @@ typedef struct tagVBAN_VMPARAM_STRIP
short EQgain2; // x 100 short EQgain2; // x 100
short EQgain3; // x 100 short EQgain3; // x 100
//first channel parametric EQ // first channel parametric EQ
char PEQ_eqOn[6]; // 0 or 1 char PEQ_eqOn[6]; // 0 or 1
char PEQ_eqtype[6]; // see define below char PEQ_eqtype[6]; // see define below
float PEQ_eqgain[6]; float PEQ_eqgain[6];
@@ -1036,7 +924,7 @@ typedef struct tagVBAN_VMPARAM_STRIP
short Pitch_formant_med; // x 100 short Pitch_formant_med; // x 100
short Pitch_formant_high; // x 100 short Pitch_formant_high; // x 100
} T_VBAN_VMPARAM_STRIP, *PT_VBAN_VMPARAM_STRIP, *LPT_VBAN_VMPARAM_STRIP; } T_VBAN_VMPARAM_STRIP, *PT_VBAN_VMPARAM_STRIP, *LPT_VBAN_VMPARAM_STRIP;
#define VMRT_EQTYPE_PEQ 0 #define VMRT_EQTYPE_PEQ 0
#define VMRT_EQTYPE_NOTCH 1 #define VMRT_EQTYPE_NOTCH 1
@@ -1046,12 +934,11 @@ typedef struct tagVBAN_VMPARAM_STRIP
#define VMRT_EQTYPE_LOSHELF 5 #define VMRT_EQTYPE_LOSHELF 5
#define VMRT_EQTYPE_HISHELF 6 #define VMRT_EQTYPE_HISHELF 6
#define expected_size_T_VBAN_VMPARAM_STRIP (8 + (8 * sizeof(short)) + (2 * 6) + (3 * 6 * sizeof(float)) + ((11 + 9 + 6 + 7) * sizeof(short)))
// 170
#define expected_size_T_VBAN_VMPARAM_STRIP (8+ (8 * sizeof(short)) + (2*6) + (3 * 6 * sizeof(float)) + ((11 + 9 + 6 + 7) * sizeof(short))) typedef struct tagVBAN_VMPARAMSTRIP_PACKET // packedt ident: 1
//170 {
typedef struct tagVBAN_VMPARAMSTRIP_PACKET //packedt ident: 1
{
unsigned char voicemeeterType; // 1 = Voicemeeter, 2= Voicemeeter Banana, 3 Potato unsigned char voicemeeterType; // 1 = Voicemeeter, 2= Voicemeeter Banana, 3 Potato
unsigned char reserved; // unused unsigned char reserved; // unused
unsigned short buffersize; // main stream buffer size unsigned short buffersize; // main stream buffer size
@@ -1059,35 +946,29 @@ typedef struct tagVBAN_VMPARAMSTRIP_PACKET //packedt ident: 1
unsigned long optionBits; // unused unsigned long optionBits; // unused
unsigned long samplerate; // main stream samplerate unsigned long samplerate; // main stream samplerate
T_VBAN_VMPARAM_STRIP Strips[8]; // all input strips T_VBAN_VMPARAM_STRIP Strips[8]; // all input strips
} T_VBAN_VMPARAMSTRIP_PACKET, *PT_VBAN_VMPARAMSTRIP_PACKET, *LPT_VBAN_VMPARAMSTRIP_PACKET; } T_VBAN_VMPARAMSTRIP_PACKET, *PT_VBAN_VMPARAMSTRIP_PACKET, *LPT_VBAN_VMPARAMSTRIP_PACKET;
#pragma pack() #pragma pack()
#define expected_size_T_VBAN_VMPARAMSTRIP_PACKET ((4 * 4) + (expected_size_T_VBAN_VMPARAM_STRIP * 8)) //1436 max #define expected_size_T_VBAN_VMPARAMSTRIP_PACKET ((4 * 4) + (expected_size_T_VBAN_VMPARAM_STRIP * 8)) // 1436 max
//1376 // 1376
/******************************************************************************/ /******************************************************************************/
/* LOCAL FUNCTIONS */ /* LOCAL FUNCTIONS */
/******************************************************************************/ /******************************************************************************/
long VBVMR_LocalInit(void);
long VBVMR_LocalEnd(void);
void * VBVMR_GetRequestVB0STREAMPTR(void);
long VBVMR_SetParametersWEx(unsigned short * szParamScript, long fCopyToClient);
long VBVMR_LoginEx(long properties);
long VBVMR_MB_PushSettings(void * lpParam);
long VBVMR_LocalInit(void);
long VBVMR_LocalEnd(void);
void *VBVMR_GetRequestVB0STREAMPTR(void);
long VBVMR_SetParametersWEx(unsigned short *szParamScript, long fCopyToClient);
long VBVMR_LoginEx(long properties);
long VBVMR_MB_PushSettings(void *lpParam);
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
#endif /*__VOICEMEETER_REMOTE_H__*/ #endif /*__VOICEMEETER_REMOTE_H__*/

View File

@@ -1,9 +0,0 @@
#ifndef __CDLL_H__
#define __CDLL_H__
#include <windows.h>
#include "VoicemeeterRemote.h"
long initialize_dll_interfaces(T_VBVMR_INTERFACE *iVMR);
#endif /*__CDLL_H__*/

17
include/interface.h Normal file
View File

@@ -0,0 +1,17 @@
/**
* Copyright (c) 2024 Onyx and Iris
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MIT license. See `ivmr.c` for details.
*/
#ifndef __IVMR_H__
#define __IVMR_H__
#include "VoicemeeterRemote.h"
#define IS_64_BIT sizeof(void *) == 8
PT_VMR create_interface();
#endif /* __IVMR_H__ */

View File

@@ -1,9 +1,25 @@
/**
* Copyright (c) 2024 Onyx and Iris
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MIT license. See `util.c` for details.
*/
#ifndef __UTIL_H__ #ifndef __UTIL_H__
#define __UTIL_H__ #define __UTIL_H__
void remove_name_in_path(char *szPath); struct quickcommand
int replace_multiple_space_with_one(char *s, size_t len); {
char *kind_as_string(char *s, enum kind kind, int n); char *name;
char *version_as_string(char *, long v, int n); char *fullcommand;
};
void remove_last_part_of_path(char *fullpath);
int log_level_from_string(const char *level);
char *kind_as_string(char *s, int kind, int n);
char *version_as_string(char *s, long v, int n);
bool is_comment(char *s);
struct quickcommand *command_in_quickcommands(const char *command, const struct quickcommand *quickcommands, int n);
bool add_quotes_if_needed(const char *command, char *output, size_t max_len);
#endif /* __UTIL_H__ */ #endif /* __UTIL_H__ */

View File

@@ -1,36 +0,0 @@
#ifndef __VMR_H__
#define __VMR_H__
#include <stdbool.h>
#include "voicemeeterRemote.h"
enum kind
{
BASIC = 1,
BANANA,
POTATO,
BASICX64,
BANANAX64,
POTATOX64,
};
long login(T_VBVMR_INTERFACE *vmr, int kind);
long logout(T_VBVMR_INTERFACE *vmr);
long run_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
long type(T_VBVMR_INTERFACE *vmr, long *type);
long version(T_VBVMR_INTERFACE *vmr, long *version);
bool is_pdirty(T_VBVMR_INTERFACE *vmr);
long get_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float *f);
long get_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, unsigned short *s);
long set_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float val);
long set_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, char *s);
long set_parameters(T_VBVMR_INTERFACE *vmr, char *command);
bool is_mdirty(T_VBVMR_INTERFACE *vmr);
long macrobutton_getstatus(T_VBVMR_INTERFACE *vmr, long n, float *val, long mode);
long macrobutton_setstatus(T_VBVMR_INTERFACE *vmr, long n, float val, long mode);
void clear_dirty(T_VBVMR_INTERFACE *vmr);
#endif /* __VMR_H__ */

46
include/wrapper.h Normal file
View File

@@ -0,0 +1,46 @@
/**
* Copyright (c) 2024 Onyx and Iris
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MIT license. See `wrapper.c` for details.
*/
#ifndef __WRAPPER_H__
#define __WRAPPER_H__
#include <stdbool.h>
#include "voicemeeterRemote.h"
enum kind : int
{
UNKNOWN = -1,
BASIC = 1,
BANANA,
POTATO,
BASICX64,
BANANAX64,
POTATOX64,
MACROBUTTONS = 11,
STREAMERVIEW
};
long login(PT_VMR vmr, int kind);
long logout(PT_VMR vmr);
long run_voicemeeter(PT_VMR vmr, int kind);
long type(PT_VMR vmr, long *type);
long version(PT_VMR vmr, long *version);
bool is_pdirty(PT_VMR vmr);
long get_parameter_float(PT_VMR vmr, char *param, float *f);
long get_parameter_string(PT_VMR vmr, char *param, wchar_t *s);
long set_parameter_float(PT_VMR vmr, char *param, float val);
long set_parameter_string(PT_VMR vmr, char *param, char *s);
long set_parameters(PT_VMR vmr, char *command);
bool is_mdirty(PT_VMR vmr);
long macrobutton_getstatus(PT_VMR vmr, long n, float *val, long mode);
long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode);
void clear(PT_VMR vmr, bool (*f)(PT_VMR));
#endif /* __WRAPPER_H__ */

View File

@@ -1,38 +1,53 @@
# Program name
program = vmrcli program = vmrcli
# Compiler
CC = gcc CC = gcc
# Directories
SRC_DIR := src SRC_DIR := src
OBJ_DIR := obj OBJ_DIR := obj
BIN_DIR := bin BIN_DIR := bin
# Executable and source/object files
EXE := $(BIN_DIR)/$(program).exe EXE := $(BIN_DIR)/$(program).exe
SRC := $(wildcard $(SRC_DIR)/*.c) SRC := $(wildcard $(SRC_DIR)/*.c)
OBJ := $(SRC:$(SRC_DIR)/%.c=$(OBJ_DIR)/%.o) OBJ := $(SRC:$(SRC_DIR)/%.c=$(OBJ_DIR)/%.o)
# Conditional compilation flags for logging
LOG_USE_COLOR ?= yes LOG_USE_COLOR ?= yes
ifeq ($(LOG_USE_COLOR), yes) ifeq ($(LOG_USE_COLOR), yes)
CPPFLAGS := -Iinclude -MMD -MP -DLOG_USE_COLOR CPPFLAGS := -Iinclude -MMD -MP -DLOG_USE_COLOR
else else
CPPFLAGS := -Iinclude -MMD -MP CPPFLAGS := -Iinclude -MMD -MP
endif endif
CFLAGS = -O -Wall -W -pedantic -ansi -std=c99
# Compiler and linker flags
CFLAGS = -O -Wall -W -pedantic -ansi -std=c2x
LDFLAGS := -Llib LDFLAGS := -Llib
LDLIBS := -lm LDLIBS := -lm
# Phony targets
.PHONY: all clean .PHONY: all clean
# Default target
all: $(EXE) all: $(EXE)
# Link the executable
$(EXE): $(OBJ) | $(BIN_DIR) $(EXE): $(OBJ) | $(BIN_DIR)
$(CC) $(LDFLAGS) $^ $(LDLIBS) -o $@ $(CC) $(LDFLAGS) $^ $(LDLIBS) -o $@
# Compile source files to object files
$(OBJ_DIR)/%.o: $(SRC_DIR)/%.c | $(OBJ_DIR) $(OBJ_DIR)/%.o: $(SRC_DIR)/%.c | $(OBJ_DIR)
$(CC) $(CPPFLAGS) $(CFLAGS) -c $< -o $@ $(CC) $(CPPFLAGS) $(CFLAGS) -c $< -o $@
# Create necessary directories
$(BIN_DIR) $(OBJ_DIR): $(BIN_DIR) $(OBJ_DIR):
pwsh -Command New-Item -Path $@ -ItemType Directory pwsh -Command New-Item -Path $@ -ItemType Directory
# Clean up generated files
clean: clean:
pwsh -Command Remove-Item -Recurse $(EXE), $(OBJ_DIR) pwsh -Command Remove-Item -Recurse $(BIN_DIR), $(OBJ_DIR) -force
# Include dependency files
-include $(OBJ:.o=.d) -include $(OBJ:.o=.d)

View File

@@ -1,159 +0,0 @@
#include <stdbool.h>
#include <stdio.h>
#include "cdll.h"
#include "util.h"
/*******************************************************************************/
/** GET VOICEMEETER DIRECTORY **/
/*******************************************************************************/
#define INSTALLER_UNINST_KEY "VB:Voicemeeter {17359A74-1236-5467}"
#ifndef KEY_WOW64_32KEY
#define KEY_WOW64_32KEY 0x0200
#endif
bool __cdecl registry_get_voicemeeter_folder(char *szDir)
{
char szKey[256];
char sss[1024];
DWORD nnsize = 1024;
HKEY hkResult;
LONG rep;
DWORD pptype = REG_SZ;
sss[0] = 0;
const char uninstDirKey[] = "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall";
// build Voicemeeter uninstallation key
strcpy(szKey, uninstDirKey);
strcat(szKey, "\\");
strcat(szKey, INSTALLER_UNINST_KEY);
// open key
rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKey, 0, KEY_READ, &hkResult);
if (rep != ERROR_SUCCESS)
{
// if not present we consider running in 64bit mode and force to read 32bit registry
rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKey, 0, KEY_READ | KEY_WOW64_32KEY, &hkResult);
}
if (rep != ERROR_SUCCESS)
return false;
// read uninstall path from registry
rep = RegQueryValueEx(hkResult, "UninstallString", 0, &pptype, (unsigned char *)sss, &nnsize);
RegCloseKey(hkResult);
if (pptype != REG_SZ)
return false;
if (rep != ERROR_SUCCESS)
return false;
// remove name to get the path only
remove_name_in_path(sss);
if (nnsize > 512)
nnsize = 512;
strncpy(szDir, sss, nnsize);
return true;
}
/*******************************************************************************/
/** GET DLL INTERFACE **/
/*******************************************************************************/
long initialize_dll_interfaces(T_VBVMR_INTERFACE *iVMR)
{
HMODULE G_H_Module = NULL;
char szDllName[1024];
memset(iVMR, 0, sizeof(T_VBVMR_INTERFACE));
// get Voicemeeter installation directory
if (!registry_get_voicemeeter_folder(szDllName))
{
// Voicemeeter not installed
return -100;
}
// use right dll according to O/S type
if (sizeof(void *) == 8)
strcat(szDllName, "\\VoicemeeterRemote64.dll");
else
strcat(szDllName, "\\VoicemeeterRemote.dll");
// Load Dll
G_H_Module = LoadLibrary(szDllName);
if (G_H_Module == NULL)
return -101;
// Get function pointers
iVMR->VBVMR_Login = (T_VBVMR_Login)GetProcAddress(G_H_Module, "VBVMR_Login");
iVMR->VBVMR_Logout = (T_VBVMR_Logout)GetProcAddress(G_H_Module, "VBVMR_Logout");
iVMR->VBVMR_RunVoicemeeter = (T_VBVMR_RunVoicemeeter)GetProcAddress(G_H_Module, "VBVMR_RunVoicemeeter");
iVMR->VBVMR_GetVoicemeeterType = (T_VBVMR_GetVoicemeeterType)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterType");
iVMR->VBVMR_GetVoicemeeterVersion = (T_VBVMR_GetVoicemeeterVersion)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterVersion");
iVMR->VBVMR_IsParametersDirty = (T_VBVMR_IsParametersDirty)GetProcAddress(G_H_Module, "VBVMR_IsParametersDirty");
iVMR->VBVMR_GetParameterFloat = (T_VBVMR_GetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_GetParameterFloat");
iVMR->VBVMR_GetParameterStringA = (T_VBVMR_GetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringA");
iVMR->VBVMR_GetParameterStringW = (T_VBVMR_GetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringW");
iVMR->VBVMR_GetLevel = (T_VBVMR_GetLevel)GetProcAddress(G_H_Module, "VBVMR_GetLevel");
iVMR->VBVMR_GetMidiMessage = (T_VBVMR_GetMidiMessage)GetProcAddress(G_H_Module, "VBVMR_GetMidiMessage");
iVMR->VBVMR_SetParameterFloat = (T_VBVMR_SetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_SetParameterFloat");
iVMR->VBVMR_SetParameters = (T_VBVMR_SetParameters)GetProcAddress(G_H_Module, "VBVMR_SetParameters");
iVMR->VBVMR_SetParametersW = (T_VBVMR_SetParametersW)GetProcAddress(G_H_Module, "VBVMR_SetParametersW");
iVMR->VBVMR_SetParameterStringA = (T_VBVMR_SetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringA");
iVMR->VBVMR_SetParameterStringW = (T_VBVMR_SetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringW");
iVMR->VBVMR_Output_GetDeviceNumber = (T_VBVMR_Output_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceNumber");
iVMR->VBVMR_Output_GetDeviceDescA = (T_VBVMR_Output_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescA");
iVMR->VBVMR_Output_GetDeviceDescW = (T_VBVMR_Output_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescW");
iVMR->VBVMR_Input_GetDeviceNumber = (T_VBVMR_Input_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceNumber");
iVMR->VBVMR_Input_GetDeviceDescA = (T_VBVMR_Input_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescA");
iVMR->VBVMR_Input_GetDeviceDescW = (T_VBVMR_Input_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescW");
// check pointers are valid
if (iVMR->VBVMR_Login == NULL)
return -1;
if (iVMR->VBVMR_Logout == NULL)
return -2;
if (iVMR->VBVMR_RunVoicemeeter == NULL)
return -2;
if (iVMR->VBVMR_GetVoicemeeterType == NULL)
return -3;
if (iVMR->VBVMR_GetVoicemeeterVersion == NULL)
return -4;
if (iVMR->VBVMR_IsParametersDirty == NULL)
return -5;
if (iVMR->VBVMR_GetParameterFloat == NULL)
return -6;
if (iVMR->VBVMR_GetParameterStringA == NULL)
return -7;
if (iVMR->VBVMR_GetParameterStringW == NULL)
return -8;
if (iVMR->VBVMR_GetLevel == NULL)
return -9;
if (iVMR->VBVMR_SetParameterFloat == NULL)
return -10;
if (iVMR->VBVMR_SetParameters == NULL)
return -11;
if (iVMR->VBVMR_SetParametersW == NULL)
return -12;
if (iVMR->VBVMR_SetParameterStringA == NULL)
return -13;
if (iVMR->VBVMR_SetParameterStringW == NULL)
return -14;
if (iVMR->VBVMR_GetMidiMessage == NULL)
return -15;
if (iVMR->VBVMR_Output_GetDeviceNumber == NULL)
return -30;
if (iVMR->VBVMR_Output_GetDeviceDescA == NULL)
return -31;
if (iVMR->VBVMR_Output_GetDeviceDescW == NULL)
return -32;
if (iVMR->VBVMR_Input_GetDeviceNumber == NULL)
return -33;
if (iVMR->VBVMR_Input_GetDeviceDescA == NULL)
return -34;
if (iVMR->VBVMR_Input_GetDeviceDescW == NULL)
return -35;
return 0;
}

234
src/interface.c Normal file
View File

@@ -0,0 +1,234 @@
/**
* @file interface.c
* @author Vincent Burel, Onyx and Iris (code@onyxandiris.online)
* @brief Functions for initializing the iVMR interface.
* Defines a single public function that returns a pointer to the interface.
* @version 0.13.0
* @date 2024-07-06
*
* @copyright Vincent Burel(c)2015-2021 All Rights Reserved
* https://github.com/vburel2018/Voicemeeter-SDK/blob/main/LICENSE
*
* Copyright (c) 2024 Onyx and Iris
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <windows.h>
#include "interface.h"
#include "util.h"
#include "log.h"
#define PRAGMA_IgnoreWCastIncompatibleFuncTypes \
_Pragma("GCC diagnostic push") \
_Pragma("GCC diagnostic ignored \"-Wcast-function-type\"")
#define PRAGMA_Pop \
_Pragma("GCC diagnostic pop")
static long initialize_dll_interfaces(PT_VMR vmr);
static bool registry_get_voicemeeter_folder(char *dll_fullpath);
/**
* @brief Create an interface object
*
* @return PT_VMR Pointer to the iVMR interface
* May return NULL if the interface fails to initialize
*/
PT_VMR create_interface()
{
PT_VMR vmr = malloc(sizeof(T_VBVMR_INTERFACE));
if (vmr == NULL)
{
log_error("malloc failed to allocate memory");
return NULL;
}
LONG rep = initialize_dll_interfaces(vmr);
if (rep < 0)
{
if (rep == -100)
{
log_fatal("Voicemeeter is not installed");
}
else
{
log_fatal("Error loading Voicemeeter dll with code %d", rep);
}
free(vmr);
vmr = NULL;
}
return vmr;
}
/*******************************************************************************/
/** GET DLL INTERFACE **/
/*******************************************************************************/
#define DLL_FULLPATH_SZ 1024
#define DLL64_NAME "\\VoicemeeterRemote64.dll"
#define DLL32_NAME "\\VoicemeeterRemote.dll"
static long initialize_dll_interfaces(PT_VMR vmr)
{
HMODULE G_H_Module = NULL;
char dll_fullpath[DLL_FULLPATH_SZ];
memset(vmr, 0, sizeof(T_VBVMR_INTERFACE));
// get Voicemeeter installation directory
if (!registry_get_voicemeeter_folder(dll_fullpath))
{
// Voicemeeter not installed
return -100;
}
// use right dll according to O/S type
if (IS_64_BIT)
strncat(dll_fullpath, DLL64_NAME, DLL_FULLPATH_SZ - strlen(DLL64_NAME) - 1);
else
strncat(dll_fullpath, DLL32_NAME, DLL_FULLPATH_SZ - strlen(DLL32_NAME) - 1);
// Load Dll
G_H_Module = LoadLibrary(dll_fullpath);
if (G_H_Module == NULL)
return -101;
PRAGMA_IgnoreWCastIncompatibleFuncTypes;
// Get function pointers
vmr->VBVMR_Login = (T_VBVMR_Login)GetProcAddress(G_H_Module, "VBVMR_Login");
vmr->VBVMR_Logout = (T_VBVMR_Logout)GetProcAddress(G_H_Module, "VBVMR_Logout");
vmr->VBVMR_RunVoicemeeter = (T_VBVMR_RunVoicemeeter)GetProcAddress(G_H_Module, "VBVMR_RunVoicemeeter");
vmr->VBVMR_GetVoicemeeterType = (T_VBVMR_GetVoicemeeterType)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterType");
vmr->VBVMR_GetVoicemeeterVersion = (T_VBVMR_GetVoicemeeterVersion)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterVersion");
vmr->VBVMR_IsParametersDirty = (T_VBVMR_IsParametersDirty)GetProcAddress(G_H_Module, "VBVMR_IsParametersDirty");
vmr->VBVMR_GetParameterFloat = (T_VBVMR_GetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_GetParameterFloat");
vmr->VBVMR_GetParameterStringA = (T_VBVMR_GetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringA");
vmr->VBVMR_GetParameterStringW = (T_VBVMR_GetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringW");
vmr->VBVMR_GetLevel = (T_VBVMR_GetLevel)GetProcAddress(G_H_Module, "VBVMR_GetLevel");
vmr->VBVMR_GetMidiMessage = (T_VBVMR_GetMidiMessage)GetProcAddress(G_H_Module, "VBVMR_GetMidiMessage");
vmr->VBVMR_SetParameterFloat = (T_VBVMR_SetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_SetParameterFloat");
vmr->VBVMR_SetParameters = (T_VBVMR_SetParameters)GetProcAddress(G_H_Module, "VBVMR_SetParameters");
vmr->VBVMR_SetParametersW = (T_VBVMR_SetParametersW)GetProcAddress(G_H_Module, "VBVMR_SetParametersW");
vmr->VBVMR_SetParameterStringA = (T_VBVMR_SetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringA");
vmr->VBVMR_SetParameterStringW = (T_VBVMR_SetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringW");
vmr->VBVMR_Output_GetDeviceNumber = (T_VBVMR_Output_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceNumber");
vmr->VBVMR_Output_GetDeviceDescA = (T_VBVMR_Output_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescA");
vmr->VBVMR_Output_GetDeviceDescW = (T_VBVMR_Output_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescW");
vmr->VBVMR_Input_GetDeviceNumber = (T_VBVMR_Input_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceNumber");
vmr->VBVMR_Input_GetDeviceDescA = (T_VBVMR_Input_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescA");
vmr->VBVMR_Input_GetDeviceDescW = (T_VBVMR_Input_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescW");
vmr->VBVMR_MacroButton_IsDirty = (T_VBVMR_MacroButton_IsDirty)GetProcAddress(G_H_Module, "VBVMR_MacroButton_IsDirty");
vmr->VBVMR_MacroButton_GetStatus = (T_VBVMR_MacroButton_GetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_GetStatus");
vmr->VBVMR_MacroButton_SetStatus = (T_VBVMR_MacroButton_SetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_SetStatus");
PRAGMA_Pop;
// check pointers are valid
if (vmr->VBVMR_Login == NULL)
return -1;
if (vmr->VBVMR_Logout == NULL)
return -2;
if (vmr->VBVMR_RunVoicemeeter == NULL)
return -3;
if (vmr->VBVMR_GetVoicemeeterType == NULL)
return -4;
if (vmr->VBVMR_GetVoicemeeterVersion == NULL)
return -5;
if (vmr->VBVMR_IsParametersDirty == NULL)
return -6;
if (vmr->VBVMR_GetParameterFloat == NULL)
return -7;
if (vmr->VBVMR_GetParameterStringA == NULL)
return -8;
if (vmr->VBVMR_GetParameterStringW == NULL)
return -9;
if (vmr->VBVMR_GetLevel == NULL)
return -10;
if (vmr->VBVMR_SetParameterFloat == NULL)
return -11;
if (vmr->VBVMR_SetParameters == NULL)
return -12;
if (vmr->VBVMR_SetParametersW == NULL)
return -13;
if (vmr->VBVMR_SetParameterStringA == NULL)
return -14;
if (vmr->VBVMR_SetParameterStringW == NULL)
return -15;
if (vmr->VBVMR_GetMidiMessage == NULL)
return -16;
if (vmr->VBVMR_Output_GetDeviceNumber == NULL)
return -30;
if (vmr->VBVMR_Output_GetDeviceDescA == NULL)
return -31;
if (vmr->VBVMR_Output_GetDeviceDescW == NULL)
return -32;
if (vmr->VBVMR_Input_GetDeviceNumber == NULL)
return -33;
if (vmr->VBVMR_Input_GetDeviceDescA == NULL)
return -34;
if (vmr->VBVMR_Input_GetDeviceDescW == NULL)
return -35;
if (vmr->VBVMR_MacroButton_IsDirty == NULL)
return -36;
if (vmr->VBVMR_MacroButton_GetStatus == NULL)
return -37;
if (vmr->VBVMR_MacroButton_SetStatus == NULL)
return -38;
return 0;
}
/*******************************************************************************/
/** GET VOICEMEETER DIRECTORY **/
/*******************************************************************************/
#define INSTALLER_DIR_KEY "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall"
#define INSTALLER_UNINST_KEY "VB:Voicemeeter {17359A74-1236-5467}"
#ifndef KEY_WOW64_32KEY
#define KEY_WOW64_32KEY 0x0200
#endif
#define UNINSTALL_KEY_SZ 256
#define UNINSTALL_PATH_SZ 1024
static bool registry_get_voicemeeter_folder(char *dll_fullpath)
{
// build Voicemeeter uninstallation key
char uninstall_key[UNINSTALL_KEY_SZ];
snprintf(uninstall_key, UNINSTALL_KEY_SZ, "%s\\%s", INSTALLER_DIR_KEY, INSTALLER_UNINST_KEY);
// open key
HKEY result;
LONG rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, uninstall_key, 0, KEY_READ, &result);
if (rep != ERROR_SUCCESS)
{
// if not present we consider running in 64bit mode and force to read 32bit registry
rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, uninstall_key, 0, KEY_READ | KEY_WOW64_32KEY, &result);
}
if (rep != ERROR_SUCCESS)
return false;
// read uninstall path from registry
DWORD pptype = REG_SZ;
DWORD len_uninstall_path = UNINSTALL_PATH_SZ;
char uninstall_path[UNINSTALL_PATH_SZ] = {0};
rep = RegQueryValueEx(result, "UninstallString", 0, &pptype, (unsigned char *)uninstall_path, &len_uninstall_path);
RegCloseKey(result);
if (pptype != REG_SZ)
return false;
if (rep != ERROR_SUCCESS)
return false;
// remove name to get the path only
remove_last_part_of_path(uninstall_path);
snprintf(dll_fullpath, DLL_FULLPATH_SZ, uninstall_path);
return true;
}

View File

@@ -118,7 +118,7 @@ void log_set_quiet(bool enable)
int log_add_callback(log_LogFn fn, void *udata, int level) int log_add_callback(log_LogFn fn, void *udata, int level)
{ {
for (int i = 0; i < MAX_CALLBACKS; i++) for (int i = 0; i < MAX_CALLBACKS; ++i)
{ {
if (!L.callbacks[i].fn) if (!L.callbacks[i].fn)
{ {
@@ -163,7 +163,7 @@ void log_log(int level, const char *file, int line, const char *fmt, ...)
va_end(ev.ap); va_end(ev.ap);
} }
for (int i = 0; i < MAX_CALLBACKS && L.callbacks[i].fn; i++) for (int i = 0; i < MAX_CALLBACKS && L.callbacks[i].fn; ++i)
{ {
Callback *cb = &L.callbacks[i]; Callback *cb = &L.callbacks[i];
if (level >= cb->level) if (level >= cb->level)

View File

@@ -1,65 +1,68 @@
#include <stddef.h> /**
* @file util.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Utility functions.
* @version 0.13.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <stdio.h> #include <stdio.h>
#include "vmr.h" #include <string.h>
#include "util.h" #include "util.h"
#include "log.h"
void remove_name_in_path(char *szPath) /**
* @brief Removes the last part of a path
*
* @param fullpath
*/
void remove_last_part_of_path(char *fullpath)
{ {
char *p = szPath; char *p;
while (*p++) if ((p = strrchr(fullpath, '\\')) != NULL)
; {
while (p > szPath && *p != '\\')
p--;
if (*p == '\\')
*p = '\0'; *p = '\0';
}
} }
/** /**
* @brief replaces multiple newlines and tabs with single spaces * @brief Gets log level as int from string
* * @param level Log level as string
* @param s the string to be reduced * @return int Log level as int, or -1 if not found
* @param len current length of the string
* @return int new length of the string
*/ */
int replace_multiple_space_with_one(char *s, size_t len) int log_level_from_string(const char *level)
{ {
int j = 0; if (strcmp(level, "TRACE") == 0)
int count = 0; return LOG_TRACE;
else if (strcmp(level, "DEBUG") == 0)
if (len == 1 && (s[0] == ' ' || s[0] == '\t')) return LOG_DEBUG;
{ else if (strcmp(level, "INFO") == 0)
s[0] = '\0'; return LOG_INFO;
return len; else if (strcmp(level, "WARN") == 0)
} return LOG_WARN;
else if (strcmp(level, "ERROR") == 0)
if (len < 2) return LOG_ERROR;
return len; else if (strcmp(level, "FATAL") == 0)
return LOG_FATAL;
for (int i = 0; s[i] != '\0'; i++) else
{ return -1;
if (s[i] == ' ' || s[i] == '\t')
{
count++;
}
if (s[i] != ' ' && s[i] != '\t')
{
if (count >= 1)
{
count = 0;
s[j++] = ' ';
}
s[j++] = s[i];
}
}
s[j] = '\0';
return j;
} }
char *kind_as_string(char *s, enum kind kind, int n) /**
* @brief Converts Voicemeeter's kind into a string.
*
* @param s Pointer to a character buffer receiving the kind
* @param kind The kind of Voicemeeter.
* @param n Maximum number of characters to be written to the buffer
* @return char* String representation of the kind of Voicemeeter.
*/
char *kind_as_string(char *s, int kind, int n)
{ {
char *kinds[] = { static const char *kinds[] = {
"Basic", "Basic",
"Banana", "Banana",
"Potato", "Potato",
@@ -72,12 +75,12 @@ char *kind_as_string(char *s, enum kind kind, int n)
} }
/** /**
* @brief returns Voicemeeter's version as a string * @brief Converts Voicemeeter's version into a string.
* *
* @param s string buffer the version will be written to * @param s Pointer to a character buffer receiving the version
* @param v unprocessed version as a long int * @param v Unprocessed version as a long int
* @param n maximum number of characters to be written to the buffer * @param n Maximum number of characters to be written to the buffer
* @return char* * @return char* String representation of the Voicemeeter version
*/ */
char *version_as_string(char *s, long v, int n) char *version_as_string(char *s, long v, int n)
{ {
@@ -88,3 +91,101 @@ char *version_as_string(char *s, long v, int n)
snprintf(s, n, "%i.%i.%i.%i", (int)v1, (int)v2, (int)v3, (int)v4); snprintf(s, n, "%i.%i.%i.%i", (int)v1, (int)v2, (int)v3, (int)v4);
return s; return s;
} }
/**
* @brief Is the current input a comment
*
* @param s Pointer to the current input
* @return true
* @return false
*/
bool is_comment(char *s)
{
return s[0] == '#';
}
/**
* @brief Searches the quickcommands array for a quickcommand
* corresponding to the command_key.
*
* @param command_key The key used to search for the quickcommand
* @param quickcommands Pointer to an array of quickcommands
* @param n The number of quickcommands
* @return struct quickcommand* Pointer to the found quickcommand
* May return NULL if quickcommand not found.
*/
struct quickcommand *command_in_quickcommands(const char *command_key, const struct quickcommand *quickcommands, int n)
{
for (int i = 0; i < n; ++i)
{
if (strcmp(command_key, quickcommands[i].name) == 0)
{
return (struct quickcommand *)(quickcommands + i);
}
}
return NULL;
}
/**
* @brief Adds quotes around the value part of a command if it contains spaces or tabs
*
* @param command The input command string (parameter=value format)
* @param output Buffer to store the result
* @param max_len Maximum length of the output buffer
* @return true if quotes were added or command was copied successfully
* @return false if the command is too long or invalid
*/
bool add_quotes_if_needed(const char *command, char *output, size_t max_len)
{
const char *equals_pos = strchr(command, '=');
// No '=' found, copy command as-is
if (equals_pos == NULL) {
if (strlen(command) >= max_len)
return false;
strcpy(output, command);
return true;
}
const char *value = equals_pos + 1;
// Value doesn't contain spaces or tabs, copy command as-is
if (strchr(value, ' ') == NULL && strchr(value, '\t') == NULL) {
if (strlen(command) >= max_len)
return false;
strcpy(output, command);
return true;
}
// Value needs quotes - calculate required buffer size
size_t param_len = equals_pos - command;
size_t value_len = strlen(value);
size_t quotes_len = 2;
size_t required_len = param_len + 1 + quotes_len + value_len + 1; // param + '=' + '"' + value + '"' + '\0'
if (required_len > max_len)
return false;
/**
* Construct the output string in the format: parameter="value"
* - Copy the parameter part (up to the '=')
* - Append '=' and opening quote
* - Append the value
* - Append closing quote and null terminator
*/
char *pos = output;
strncpy(pos, command, param_len);
pos += param_len;
*pos++ = '=';
*pos++ = '"';
strcpy(pos, value);
pos += value_len;
*pos++ = '"';
*pos = '\0';
return true;
}

133
src/vmr.c
View File

@@ -1,133 +0,0 @@
#include <windows.h>
#include <stdio.h>
#include <time.h>
#include "vmr.h"
#include "log.h"
#include "util.h"
#define VERSION_STR_LEN 128
#define KIND_STR_LEN 64
long login(T_VBVMR_INTERFACE *vmr, int kind)
{
int rep;
long v;
rep = vmr->VBVMR_Login();
if (rep == 1)
{
run_voicemeeter(vmr, kind);
char kind_s[KIND_STR_LEN];
log_info(
"Launching Voicemeeter %s GUI",
kind_as_string(kind_s, kind, KIND_STR_LEN));
time_t endwait;
int timeout = 2;
endwait = time(NULL) + timeout;
do
{
if ((rep = version(vmr, &v)) == 0)
break;
Sleep(50);
} while (time(NULL) < endwait);
}
if (rep == 0)
{
version(vmr, &v);
char version_s[VERSION_STR_LEN];
log_info(
"Successfully logged into the Voicemeeter API v%s",
version_as_string(version_s, v, VERSION_STR_LEN));
clear_dirty(vmr);
}
return rep;
}
long logout(T_VBVMR_INTERFACE *vmr)
{
int rep;
Sleep(20); /* give time for last command */
rep = vmr->VBVMR_Logout();
if (rep == 0)
log_info("Successfully logged out of the Voicemeeter API");
return rep;
}
long run_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
{
log_trace("VBVMR_RunVoicemeeter(%d)", kind);
return vmr->VBVMR_RunVoicemeeter((long)kind);
}
long type(T_VBVMR_INTERFACE *vmr, long *type)
{
log_trace("VBVMR_GetVoicemeeterType(<long> *t)");
return vmr->VBVMR_GetVoicemeeterType(type);
}
long version(T_VBVMR_INTERFACE *vmr, long *version)
{
log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)");
return vmr->VBVMR_GetVoicemeeterVersion(version);
}
bool is_pdirty(T_VBVMR_INTERFACE *vmr)
{
log_trace("VBVMR_IsParametersDirty()");
return vmr->VBVMR_IsParametersDirty() == 1;
}
long get_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float *f)
{
log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param);
return vmr->VBVMR_GetParameterFloat(param, f);
}
long get_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, unsigned short *s)
{
log_trace("VBVMR_GetParameterStringW(%s, <unsigned short> *s)", param);
return vmr->VBVMR_GetParameterStringW(param, s);
}
long set_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float val)
{
log_trace("VBVMR_SetParameterFloat(%s, %.1f)", param, val);
return vmr->VBVMR_SetParameterFloat(param, val);
}
long set_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, char *s)
{
log_trace("VBVMR_SetParameterStringA(%s, %s)", param, s);
return vmr->VBVMR_SetParameterStringA(param, s);
}
long set_parameters(T_VBVMR_INTERFACE *vmr, char *command)
{
log_trace("VBVMR_SetParameters(%s)", command);
return vmr->VBVMR_SetParameters(command);
}
bool is_mdirty(T_VBVMR_INTERFACE *vmr)
{
return vmr->VBVMR_MacroButton_IsDirty() == 1;
}
long macrobutton_getstatus(T_VBVMR_INTERFACE *vmr, long n, float *val, long mode)
{
return vmr->VBVMR_MacroButton_GetStatus(n, val, mode);
}
long macrobutton_setstatus(T_VBVMR_INTERFACE *vmr, long n, float val, long mode)
{
return vmr->VBVMR_MacroButton_SetStatus(n, val, mode);
}
void clear_dirty(T_VBVMR_INTERFACE *vmr)
{
Sleep(30);
while (is_pdirty(vmr))
Sleep(1);
}

View File

@@ -1,235 +1,419 @@
/**
* @file vmrcli.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief A Voicemeeter Remote Command Line Interface
* @version 0.13.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>
#include <stdbool.h> #include <string.h>
#include <ctype.h>
#include <getopt.h> #include <getopt.h>
#include "cdll.h" #include <windows.h>
#include "vmr.h" #include "interface.h"
#include "wrapper.h"
#include "log.h" #include "log.h"
#include "util.h" #include "util.h"
#define MAX_LINE 512 #define USAGE "Usage: .\\vmrcli.exe [-h] [-v] [-i|-I] [-f] [-k] [-l] [-e] [-c] [-m] [-s] <api commands>\n" \
"Where: \n" \
"\th: Print the help message\n" \
"\tv: Print the version number\n" \
"\ti: Enable interactive mode, use (-I) to disable the '>>' prompt\n" \
"\tf: Do not split input on spaces\n" \
"\tk: The kind of Voicemeeter (basic, banana, potato)\n" \
"\tl: Set log level, must be one of TRACE, DEBUG, INFO, WARN, ERROR, or FATAL\n" \
"\te: Enable extra console output (toggle, set messages)\n" \
"\tc: Load a user configuration (give the full file path)\n" \
"\tm: Launch the MacroButtons application\n" \
"\ts: Launch the StreamerView application"
#define OPTSTR ":hvk:msc:iIfl:e"
#define MAX_LINE 4096 /* Size of the input buffer */
#define RES_SZ 512 /* Size of the buffer passed to VBVMR_GetParameterStringW */
#define COUNT_OF(x) (sizeof(x) / sizeof(x[0]))
#define DELIMITERS " \t;,"
#define VERSION "0.13.0"
enum /**
* @enum The kind of values a get call may return.
*/
enum restype : int
{ {
FLOAT_T, FLOAT_T,
STRING_T, STRING_T,
}; };
/**
* @struct A struct used for:
* - tracking the type of value stored
* - storing the result of a get call
*/
struct result struct result
{ {
int type; enum restype type;
union val union val
{ {
float f; float f;
wchar_t s[MAX_LINE]; wchar_t s[RES_SZ];
} val; } val;
}; };
void help(void); static bool eflag = false;
enum kind set_kind(char *kval);
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
void interactive(T_VBVMR_INTERFACE *vmr);
void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len);
void parse_command(T_VBVMR_INTERFACE *vmr, char *command);
void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res);
bool vflag = false; static void terminate(PT_VMR vmr, char *msg);
static void usage();
static enum kind set_kind(char *kval);
static void interactive(PT_VMR vmr, bool with_prompt, char *delimiters);
static void parse_input(PT_VMR vmr, char *input, char *delimiters);
static void parse_command(PT_VMR vmr, char *command);
static void get(PT_VMR vmr, char *command, struct result *res);
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
bool iflag = false; bool iflag = false,
mflag = false,
sflag = false,
cflag = false,
fflag = false,
with_prompt = true;
int opt; int opt;
char *kvalue = ""; int log_level = LOG_WARN;
int dvalue; char *cvalue;
enum kind kind = BANANAX64; enum kind kind = BANANAX64;
if (argc == 1) if (argc == 1)
{ {
help(); usage();
exit(EXIT_SUCCESS);
} }
log_set_level(LOG_WARN); log_set_level(log_level);
while ((opt = getopt(argc, argv, "k:ihD:v")) != -1) opterr = 0;
while ((opt = getopt(argc, argv, OPTSTR)) != -1)
{ {
switch (opt) switch (opt)
{ {
case 'v':
printf("vmrcli version %s\n", VERSION);
exit(EXIT_SUCCESS);
case 'k':
kind = set_kind(optarg);
if (kind == UNKNOWN)
{
log_fatal("Unknown Voicemeeter kind '%s'", optarg);
exit(EXIT_FAILURE);
}
break;
case 'm':
mflag = true;
break;
case 's':
sflag = true;
break;
case 'c':
cflag = true;
cvalue = optarg;
break;
case 'I':
with_prompt = false;
[[fallthrough]];
case 'i': case 'i':
iflag = true; iflag = true;
break; break;
case 'k': case 'f':
kvalue = optarg; fflag = true;
kind = set_kind(kvalue);
break; break;
case 'h': case 'l':
help(); log_level = log_level_from_string(optarg);
exit(EXIT_SUCCESS); if (log_level != -1)
case 'D':
dvalue = atoi(optarg);
if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
{ {
log_set_level(dvalue); log_set_level(log_level);
} }
else else
{ {
log_error( log_warn(
"-D arg out of range, expected value from 0 up to 5\n" "-l arg out of range, expected TRACE, DEBUG, INFO, WARN, ERROR, or FATAL\n"
"Log level will default to LOG_WARN (3).\n"); "Log level will default to LOG_WARN (3).\n");
} }
break; break;
case 'v': case 'e':
vflag = true; eflag = true;
break; break;
case '?':
log_fatal("unknown option -- '%c'\n"
"Try .\\vmrcli.exe -h for more information.",
optopt);
exit(EXIT_FAILURE);
case ':':
log_fatal("missing argument for option -- '%c'\n"
"Try .\\vmrcli.exe -h for more information.",
optopt);
exit(EXIT_FAILURE);
case 'h':
[[fallthrough]];
default: default:
abort(); usage();
} }
} }
T_VBVMR_INTERFACE iVMR; PT_VMR vmr = create_interface();
T_VBVMR_INTERFACE *vmr = &iVMR; if (vmr == NULL)
int rep = init_voicemeeter(vmr, kind);
if (rep != 0)
{ {
exit(EXIT_FAILURE); exit(EXIT_FAILURE);
} }
long rep = login(vmr, kind);
if (rep != 0)
{
if (rep == -2)
terminate(vmr, "Timeout logging into the API.");
else
terminate(vmr, "Error logging into the Voicemeeter API");
}
if (mflag)
{
run_voicemeeter(vmr, MACROBUTTONS);
log_info("MacroButtons app launched");
}
if (sflag)
{
run_voicemeeter(vmr, STREAMERVIEW);
log_info("StreamerView app launched");
}
if (cflag)
{
set_parameter_string(vmr, "command.load", cvalue);
log_info("Profile %s loaded", cvalue);
Sleep(300);
clear(vmr, is_pdirty);
}
char *delimiter_ptr = DELIMITERS;
if (fflag)
{
delimiter_ptr++; /* skip space delimiter */
}
if (iflag) if (iflag)
{ {
puts("Interactive mode enabled. Enter 'Q' to exit."); puts("Interactive mode enabled. Enter 'Q' to exit.");
interactive(vmr); interactive(vmr, with_prompt, delimiter_ptr);
} }
else else
{ {
for (int i = optind; i < argc; i++) for (int i = optind; i < argc; ++i)
{ {
parse_input(vmr, argv[i], strlen(argv[i])); parse_input(vmr, argv[i], delimiter_ptr);
} }
} }
rep = logout(vmr); rep = logout(vmr);
if (rep == 0)
return EXIT_SUCCESS;
else
return EXIT_FAILURE;
}
/**
* @brief prints the help dialogue
*
*/
void help()
{
puts(
"Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] <api commands>\n"
"Where: \n"
"\th: Prints the help dialogue\n"
"\ti: Enable interactive mode\n"
"\tk: The kind of Voicemeeter (basic, banana, potato)\n"
"\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL"
"\tv: Enable extra console output (toggle, set messages)\n");
}
/**
* @brief Set the kind object
*
* @param kval
* @return enum kind
*/
enum kind set_kind(char *kval)
{
if (strcmp(kval, "basic") == 0)
{
if (sizeof(void *) == 8)
return BASICX64;
else
return BASIC;
}
else if (strcmp(kval, "banana") == 0)
{
if (sizeof(void *) == 8)
return BANANAX64;
else
return BANANA;
}
else if (strcmp(kval, "potato") == 0)
{
if (sizeof(void *) == 8)
return POTATOX64;
else
return POTATO;
}
else
{
log_error("Unknown Voicemeeter kind '%s'\n", kval);
exit(EXIT_FAILURE);
}
}
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
{
int rep = initialize_dll_interfaces(vmr);
if (rep < 0)
{
if (rep == -100)
{
log_error("Voicemeeter is not installed");
}
else
{
log_error("Error loading Voicemeeter dll with code %d\n", rep);
}
return rep;
}
rep = login(vmr, kind);
if (rep != 0) if (rep != 0)
{ {
log_error("Error logging into Voicemeeter"); terminate(vmr, "Error logging out of the Voicemeeter API");
return rep;
} }
return 0; log_info("Successfully logged out of the Voicemeeter API");
free(vmr);
return EXIT_SUCCESS;
} }
void interactive(T_VBVMR_INTERFACE *vmr) /**
* @brief Write fatal error log, free dyn allocated memory then exit
*
* @param vmr Pointer to the iVMR interface
* @param msg Fatal error message
*/
static void terminate(PT_VMR vmr, char *msg)
{
log_fatal(msg);
free(vmr);
exit(EXIT_FAILURE);
}
/**
* @brief Prints the help message
*/
static void usage()
{
puts(USAGE);
exit(EXIT_SUCCESS);
}
/**
* @brief Set the kind of Voicemeeter based on the value of -k flag.
* For 64 bit systems the value is promoted to X64.
*
* @param kval Value of the -k flag
* @return enum kind
*/
static enum kind set_kind(char *kval)
{
if (strcmp(kval, "basic") == 0)
return IS_64_BIT ? BASICX64 : BASIC;
else if (strcmp(kval, "banana") == 0)
return IS_64_BIT ? BANANAX64 : BANANA;
else if (strcmp(kval, "potato") == 0)
return IS_64_BIT ? POTATOX64 : POTATO;
else
return UNKNOWN;
}
/**
* @brief Continuously read lines from stdin.
* Break if 'Q' is entered on the interactive prompt.
* Each line is passed to parse_input()
*
* @param vmr Pointer to the iVMR interface
* @param with_prompt If true, prints the interactive prompt '>>'
* @param delimiters A string of delimiter characters to split each input line
*/
static void interactive(PT_VMR vmr, bool with_prompt, char *delimiters)
{ {
char input[MAX_LINE]; char input[MAX_LINE];
size_t len; size_t len;
if (with_prompt)
printf(">> "); printf(">> ");
while (fgets(input, MAX_LINE, stdin) != NULL) while (fgets(input, MAX_LINE, stdin) != NULL)
{ {
input[strcspn(input, "\n")] = 0; input[(len = strcspn(input, "\n"))] = 0;
len = strlen(input);
if (len == 1 && toupper(input[0]) == 'Q') if (len == 1 && toupper(input[0]) == 'Q')
break; break;
parse_input(vmr, input, len); parse_input(vmr, input, delimiters);
memset(input, '\0', MAX_LINE); /* reset input buffer */ if (with_prompt)
printf(">> "); printf(">> ");
} }
} }
void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len) /* Helper functions for parse_input */
{ static inline bool is_quote_char(char c) {
char *token; return (c == '"' || c == '\'');
}
replace_multiple_space_with_one(input, len); static inline bool is_delimiter_char(char c, const char *delimiters) {
token = strtok(input, " "); return strchr(delimiters, c) != NULL;
while (token != NULL) }
static char* skip_consecutive_delimiters(char *p, const char *delimiters) {
while (*p != '\0' && is_delimiter_char(*p, delimiters)) {
p++;
}
return p;
}
static bool add_char_to_token(char *token, size_t *token_len, char c, size_t max_len) {
if (*token_len < max_len - 1) {
token[(*token_len)++] = c;
return true;
}
return false; // Buffer would overflow
}
/**
* @brief Parse each input line into separate commands and execute them.
* Commands are split based on the delimiters argument, but quoted strings are preserved as single commands.
* See the test cases for examples of how input lines are parsed:
* https://github.com/onyx-and-iris/vmrcli?tab=readme-ov-file#api-commands
* @param vmr Pointer to the iVMR interface
* @param input Each input line, from stdin or CLI args
* @param delimiters A string of delimiter characters to split each input line
*/
static void parse_input(PT_VMR vmr, char *input, char *delimiters)
{
if (is_comment(input))
return;
char *current = input;
char token[MAX_LINE];
size_t token_length = 0;
bool inside_quotes = false;
char quote_char = '\0';
while (*current != '\0')
{ {
if (!inside_quotes && is_quote_char(*current))
{
inside_quotes = true;
quote_char = *current;
current++;
log_trace("Entering quotes with char '%c'", quote_char);
continue;
}
else if (inside_quotes && *current == quote_char)
{
inside_quotes = false;
quote_char = '\0';
current++;
log_trace("Exiting quotes");
continue;
}
else if (!inside_quotes && is_delimiter_char(*current, delimiters))
{
if (token_length > 0)
{
token[token_length] = '\0';
parse_command(vmr, token);
token_length = 0;
}
current = skip_consecutive_delimiters(current, delimiters);
continue;
}
else
{
add_char_to_token(token, &token_length, *current, MAX_LINE);
log_trace("Added char '%c' to token, current token: '%s'", *current, token);
}
current++;
}
if (token_length > 0)
{
token[token_length] = '\0';
parse_command(vmr, token); parse_command(vmr, token);
token = strtok(NULL, " ");
} }
} }
void parse_command(T_VBVMR_INTERFACE *vmr, char *command) /**
* @brief Execute each command according to type.
* See command type definitions in:
* https://github.com/onyx-and-iris/vmrcli?tab=readme-ov-file#api-commands
*
* @param vmr Pointer to the iVMR interface
* @param command Each token from the input line as its own command string
*/
static void parse_command(PT_VMR vmr, char *command)
{ {
log_debug("Parsing %s", command); log_debug("Parsing %s", command);
static const struct quickcommand quickcommands[] = {
{.name = "lock", .fullcommand = "command.lock=1"},
{.name = "unlock", .fullcommand = "command.lock=0"},
{.name = "show", .fullcommand = "command.show=1"},
{.name = "hide", .fullcommand = "command.show=0"},
{.name = "restart", .fullcommand = "command.restart=1"}};
struct quickcommand *qc_ptr = command_in_quickcommands(command, quickcommands, (int)COUNT_OF(quickcommands));
if (qc_ptr != NULL)
{
set_parameters(vmr, qc_ptr->fullcommand);
if (eflag) {
printf("Setting %s\n", qc_ptr->fullcommand);
}
return;
}
if (command[0] == '!') /* toggle */ if (command[0] == '!') /* toggle */
{ {
command++; command++;
@@ -241,8 +425,7 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
if (res.val.f == 1 || res.val.f == 0) if (res.val.f == 1 || res.val.f == 0)
{ {
set_parameter_float(vmr, command, 1 - res.val.f); set_parameter_float(vmr, command, 1 - res.val.f);
if (vflag) if (eflag) {
{
printf("Toggling %s\n", command); printf("Toggling %s\n", command);
} }
} }
@@ -254,12 +437,20 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
if (strchr(command, '=') != NULL) /* set */ if (strchr(command, '=') != NULL) /* set */
{ {
set_parameters(vmr, command); char quoted_command[MAX_LINE];
if (vflag)
if (add_quotes_if_needed(command, quoted_command, MAX_LINE))
{ {
set_parameters(vmr, quoted_command);
if (eflag) {
printf("Setting %s\n", command); printf("Setting %s\n", command);
} }
} }
else
{
log_error("Command too long after adding quotes");
}
}
else /* get */ else /* get */
{ {
struct result res = {.type = FLOAT_T}; struct result res = {.type = FLOAT_T};
@@ -271,6 +462,7 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
printf("%s: %.1f\n", command, res.val.f); printf("%s: %.1f\n", command, res.val.f);
break; break;
case STRING_T: case STRING_T:
if (res.val.s[0] != '\0')
printf("%s: %ls\n", command, res.val.s); printf("%s: %ls\n", command, res.val.s);
break; break;
default: default:
@@ -279,9 +471,17 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
} }
} }
void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res) /**
* @brief Get the value of a float or string parameter.
* Stores its type and value into a result struct
*
* @param vmr Pointer to the iVMR interface
* @param command A parsed 'get' command as a string
* @param res Pointer to a struct holding the result of the API call.
*/
static void get(PT_VMR vmr, char *command, struct result *res)
{ {
clear_dirty(vmr); clear(vmr, is_pdirty);
if (get_parameter_float(vmr, command, &res->val.f) != 0) if (get_parameter_float(vmr, command, &res->val.f) != 0)
{ {
res->type = STRING_T; res->type = STRING_T;

268
src/wrapper.c Normal file
View File

@@ -0,0 +1,268 @@
/**
* @file wrapper.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Provides public functions that wrap the iVMR calls
* @version 0.13.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <windows.h>
#include "wrapper.h"
#include "log.h"
#include "util.h"
#define KIND_STR_LEN 64
#define VERSION_STR_LEN 32
#define LOGIN_TIMEOUT 2
/**
* @brief Logs into the API.
* Tests for valid connection for up to 2 seconds.
* If successful initializes the dirty parameters.
*
* @param vmr Pointer to the iVMR interface
* @param kind The kind of Voicemeeter Gui to launch.
* @return long
* 0: OK (no error).
* -2: Login timed out.
*/
long login(PT_VMR vmr, int kind)
{
long rep;
long v;
log_trace("VBVMR_Login()");
rep = vmr->VBVMR_Login();
if (rep == 1)
{
run_voicemeeter(vmr, kind);
char kind_s[KIND_STR_LEN];
log_info(
"Launching Voicemeeter %s GUI",
kind_as_string(kind_s, kind, KIND_STR_LEN));
}
time_t start = time(NULL);
do
{
if ((rep = version(vmr, &v)) == 0)
{
char version_s[VERSION_STR_LEN];
log_info(
"Successfully logged into the Voicemeeter API v%s",
version_as_string(version_s, v, VERSION_STR_LEN));
clear(vmr, is_pdirty);
break;
}
Sleep(50);
} while (difftime(time(NULL), start) < LOGIN_TIMEOUT);
return rep;
}
/**
* @brief Logs out of the API giving a short wait to allow a
* final instruction to complete.
*
* @param vmr Pointer to the iVMR interface
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L56
*/
long logout(PT_VMR vmr)
{
Sleep(20); /* give time for last command */
log_trace("VBVMR_Logout()");
return vmr->VBVMR_Logout();
}
/**
* @brief Launches Voicemeeter or other utility apps
*
* @param vmr Pointer to the iVMR interface
* @param kind The kind of app to launch
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L66
*/
long run_voicemeeter(PT_VMR vmr, int kind)
{
log_trace("VBVMR_RunVoicemeeter(%d)", kind);
return vmr->VBVMR_RunVoicemeeter((long)kind);
}
/**
* @brief Get Voicemeeter type
*
* @param vmr Pointer to the iVMR interface
* @param type Pointer to a long object receiving the type
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L107
*/
long type(PT_VMR vmr, long *type)
{
log_trace("VBVMR_GetVoicemeeterType(<long> *t)");
return vmr->VBVMR_GetVoicemeeterType(type);
}
/**
* @brief Get Voicemeeter version
*
* @param vmr Pointer to the iVMR interface
* @param version Pointer to a long object receiving the version
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L122
*/
long version(PT_VMR vmr, long *version)
{
log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)");
return vmr->VBVMR_GetVoicemeeterVersion(version);
}
/**
* @brief Polling function, use it to determine if there are parameter
* states to be updated.
*
* @param vmr Pointer to the iVMR interface
* @return true New parameters yet to be updated
* @return false No new parameters, safe to make a get call
*/
bool is_pdirty(PT_VMR vmr)
{
log_trace("VBVMR_IsParametersDirty()");
return vmr->VBVMR_IsParametersDirty() == 1;
}
/**
* @brief Get the parameter float object
*
* @param vmr Pointer to the iVMR interface
* @param param The parameter to be queried
* @param f Pointer to a float object receiving the value
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L159
*/
long get_parameter_float(PT_VMR vmr, char *param, float *f)
{
log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param);
return vmr->VBVMR_GetParameterFloat(param, f);
}
/**
* @brief Get the parameter string object
*
* @param vmr Pointer to the iVMR interface
* @param param The parameter to be queried
* @param s Pointer to a character buffer receiving the string value
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L173
*/
long get_parameter_string(PT_VMR vmr, char *param, wchar_t *s)
{
log_trace("VBVMR_GetParameterStringW(%s, <wchar_t> *s)", param);
return vmr->VBVMR_GetParameterStringW(param, s);
}
/**
* @brief Set the parameter float object
*
* @param vmr Pointer to the iVMR interface
* @param param The parameter to be updated
* @param val The new value
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L309
*/
long set_parameter_float(PT_VMR vmr, char *param, float val)
{
log_trace("VBVMR_SetParameterFloat(%s, %.1f)", param, val);
return vmr->VBVMR_SetParameterFloat(param, val);
}
/**
* @brief Set the parameter string object
*
* @param vmr Pointer to the iVMR interface
* @param param The parameter to be updated
* @param s Pointer to a char[] object containing the new value
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L327
*/
long set_parameter_string(PT_VMR vmr, char *param, char *s)
{
log_trace("VBVMR_SetParameterStringA(%s, %s)", param, s);
return vmr->VBVMR_SetParameterStringA(param, s);
}
/**
* @brief Run a script possibly containing multiple instructions
*
* @param vmr Pointer to the iVMR interface
* @param command Pointer to a char[] object containing the script
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L351
*/
long set_parameters(PT_VMR vmr, char *command)
{
log_trace("VBVMR_SetParameters(%s)", command);
return vmr->VBVMR_SetParameters(command);
}
/**
* @brief Polling function, use it to determine if there are macrobutton
* states to be updated.
*
* @param vmr Pointer to the iVMR interface
* @return true Macrobutton states yet to be udpated
* @return false No new macrobutton states
*/
bool is_mdirty(PT_VMR vmr)
{
log_trace("VBVMR_MacroButton_IsDirty()");
return vmr->VBVMR_MacroButton_IsDirty() >= 0;
}
/**
* @brief Get the current status of macrobutton[n].{mode}
*
* @param vmr Pointer to the iVMR interface
* @param n Index of the macrobutton
* @param val Pointer to a float object the current value will be stored in
* @param mode The mode (stateonly, state, trigger)
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L663
*/
long macrobutton_getstatus(PT_VMR vmr, long n, float *val, long mode)
{
log_trace("VBVMR_MacroButton_GetStatus(%ld, <float> *v, %ld)", n, mode);
return vmr->VBVMR_MacroButton_GetStatus(n, val, mode);
}
/**
* @brief Set the current status of macrobutton[n].{mode}
*
* @param vmr Pointer to the iVMR interface
* @param n Index of the macrobutton
* @param val Value to be updated
* @param mode The mode (stateonly, state, trigger)
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L677
*/
long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode)
{
log_trace("VBVMR_MacroButton_SetStatus(%ld, %d, %ld)", n, (int)val, mode);
return vmr->VBVMR_MacroButton_SetStatus(n, val, mode);
}
/**
* @brief Continuously polls an is_{}dirty function until it clears.
*
* @param vmr Pointer to the iVMR interface
* @param f Pointer to a polling function
*/
void clear(PT_VMR vmr, bool (*f)(PT_VMR))
{
Sleep(30);
while (f(vmr))
Sleep(1);
}