Compare commits

...

57 Commits
v0.7.1 ... main

Author SHA1 Message Date
3823e0c497 include pattern in output 2026-03-06 01:48:55 +00:00
9bb7b32f7b upd example_commands 2026-03-04 19:13:17 +00:00
23146cf1a0 fix label example 2026-03-04 18:23:59 +00:00
d05cb1a7f4 update perms 2026-03-04 18:15:18 +00:00
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
15 changed files with 918 additions and 221 deletions

1
.env Normal file
View File

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

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

@ -0,0 +1,102 @@
name: Build vmrcli
on:
push:
tags:
- 'v*.*.*'
workflow_dispatch:
jobs:
build-windows:
runs-on: windows-latest
permissions:
contents: write # Required to create releases
actions: read # Required to download artifacts
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@v1
with:
files: |
bin/vmrcli.exe
tag_name: ${{ github.ref_name }}
name: vmrcli ${{ github.ref_name }}
draft: false
prerelease: false
generate_release_notes: true
token: ${{ secrets.GITHUB_TOKEN }}

9
.gitignore vendored
View File

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

179
README.md
View File

@ -1,100 +1,189 @@
# 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] [-v] [-c] [-m] [-s] <api commands> .\vmrcli.exe [OPTIONS] <api_commands>
``` ```
Where: ### Command Line Options
- `h`: Prints the help message. | 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` |
- `v`: Enable extra console output (toggle, set messages) | `-i` | Enable interactive mode | `vmrcli.exe -i` |
- `c`: Load a user configuration (give the full file path) | `-I` | Interactive mode without prompt | `vmrcli.exe -I` |
- `m`: Launch the MacroButtons application | `-f` | Don't split input on spaces | `vmrcli.exe -f` |
- `s`: Launch the StreamerView application | `-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. (use `+=` and `-=` to increment/decrement)
- 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, print its new value, then decrease Bus 0 Gain by 3.8 > **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 bus[0].gain-=3.8 .\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 labels and print them back*
```powershell ```powershell
.\vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label .\vmrcli.exe -kbanana -lDEBUG 'strip[0].label="my podmic"' strip[0].label
``` ```
## `Interactive Mode` #### **Device Configuration**
*Configure hardware devices with complex names*
Running the following command in Powershell: ```powershell
.\vmrcli.exe -lDEBUG bus[2].mute=1 bus[2].mute 'bus[2].device.wdm="Realtek Digital Output (Realtek(R) Audio)"'
```
#### **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 ```powershell
.\vmrcli.exe -i .\vmrcli.exe -i
``` ```
Will open an interactive prompt: **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)
``` ```
You may also pipe a scripts contents to the CLI: **Via pipeline:**
```powershell ```powershell
$(Get-Content .\example_commands.txt) | .\vmrcli.exe -D1 -i $(Get-Content .\example_commands.txt) | .\vmrcli.exe -lDEBUG -I
``` ```
Multiple API commands can be in a single line, they may be separated by space, `;` or `,`. ### Script Format Rules
## `Build` | 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` |
Run the included `makefile` with [GNU Make](https://www.gnu.org/software/make/). ## Build Instructions
The binary in [Releases][releases] is compiled with coloured logging enabled. To disable this you can override the `LOG_USE_COLOR` variable, for example: *Compile from source using GNU Make*
`make LOG_USE_COLOR=no` ### Prerequisites
- [GNU Make](https://www.gnu.org/software/make/)
- GCC compiler (recommended)
- Windows development environment
## `Official Documentation` ### Build Commands
- [Voicemeeter Remote C API][remoteapi-docs] ```bash
# Standard build
make
## `Special Thanks` # Disable colored logging
make LOG_USE_COLOR=no
- [rxi][rxi-user] for writing the [log.c][log-c] package # 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 [releases]: https://github.com/onyx-and-iris/vmrcli/releases
[remoteapi-docs]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf [remoteapi-docs]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf

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+).\" -pp"
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+)\" -pp"
{{end}}

View File

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

View File

@ -10,6 +10,8 @@
#include "VoicemeeterRemote.h" #include "VoicemeeterRemote.h"
#define IS_64_BIT sizeof(void *) == 8
PT_VMR create_interface(); PT_VMR create_interface();
#endif /* __IVMR_H__ */ #endif /* __IVMR_H__ */

View File

@ -8,8 +8,18 @@
#ifndef __UTIL_H__ #ifndef __UTIL_H__
#define __UTIL_H__ #define __UTIL_H__
struct quickcommand
{
char *name;
char *fullcommand;
};
void remove_last_part_of_path(char *fullpath); 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 *kind_as_string(char *s, int kind, int n);
char *version_as_string(char *s, long v, 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

@ -11,7 +11,7 @@
#include <stdbool.h> #include <stdbool.h>
#include "voicemeeterRemote.h" #include "voicemeeterRemote.h"
enum kind enum kind : int
{ {
UNKNOWN = -1, UNKNOWN = -1,
BASIC = 1, BASIC = 1,
@ -32,7 +32,7 @@ long version(PT_VMR vmr, long *version);
bool is_pdirty(PT_VMR vmr); bool is_pdirty(PT_VMR vmr);
long get_parameter_float(PT_VMR vmr, char *param, float *f); long get_parameter_float(PT_VMR vmr, char *param, float *f);
long get_parameter_string(PT_VMR vmr, char *param, unsigned short *s); 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_float(PT_VMR vmr, char *param, float val);
long set_parameter_string(PT_VMR vmr, char *param, char *s); long set_parameter_string(PT_VMR vmr, char *param, char *s);
long set_parameters(PT_VMR vmr, char *command); long set_parameters(PT_VMR vmr, char *command);
@ -41,6 +41,6 @@ bool is_mdirty(PT_VMR vmr);
long macrobutton_getstatus(PT_VMR vmr, long n, float *val, long mode); long macrobutton_getstatus(PT_VMR vmr, long n, float *val, long mode);
long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode); long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode);
void clear_dirty(PT_VMR vmr); void clear(PT_VMR vmr, bool (*f)(PT_VMR));
#endif /* __WRAPPER_H__ */ #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
# Compiler and linker flags
CFLAGS = -O -Wall -W -pedantic -ansi -std=c2x 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,9 +1,9 @@
/** /**
* @file ivmr.c * @file interface.c
* @author Vincent Burel, Onyx and Iris (code@onyxandiris.online) * @author Vincent Burel, Onyx and Iris (code@onyxandiris.online)
* @brief Functions for initializing the iVMR interface. * @brief Functions for initializing the iVMR interface.
* Defines a single public function that returns a pointer to the interface. * Defines a single public function that returns a pointer to the interface.
* @version 0.7.0 * @version 0.13.0
* @date 2024-07-06 * @date 2024-07-06
* *
* @copyright Vincent Burel(c)2015-2021 All Rights Reserved * @copyright Vincent Burel(c)2015-2021 All Rights Reserved
@ -13,41 +13,49 @@
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE * https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/ */
#include <stdbool.h>
#include <stdio.h>
#include <windows.h> #include <windows.h>
#include "ivmr.h" #include "interface.h"
#include "util.h" #include "util.h"
#include "log.h" #include "log.h"
static T_VBVMR_INTERFACE iVMR; #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 long initialize_dll_interfaces(PT_VMR vmr);
static bool registry_get_voicemeeter_folder(char *szDir); static bool registry_get_voicemeeter_folder(char *dll_fullpath);
/** /**
* @brief Create an interface object * @brief Create an interface object
* *
* @return PT_VMR Pointer to the iVMR interface * @return PT_VMR Pointer to the iVMR interface
* May return NULL if the interface fails to initialize
*/ */
PT_VMR create_interface() PT_VMR create_interface()
{ {
PT_VMR vmr = &iVMR; PT_VMR vmr = malloc(sizeof(T_VBVMR_INTERFACE));
int rep; if (vmr == NULL)
{
log_error("malloc failed to allocate memory");
return NULL;
}
rep = initialize_dll_interfaces(vmr); LONG rep = initialize_dll_interfaces(vmr);
if (rep < 0) if (rep < 0)
{ {
if (rep == -100) if (rep == -100)
{ {
log_fatal("Voicemeeter is not installed"); log_fatal("Voicemeeter is not installed");
exit(EXIT_FAILURE);
} }
else else
{ {
log_fatal("Error loading Voicemeeter dll with code %d\n", rep); log_fatal("Error loading Voicemeeter dll with code %d", rep);
exit(EXIT_FAILURE);
} }
free(vmr);
vmr = NULL;
} }
return vmr; return vmr;
@ -56,29 +64,35 @@ PT_VMR create_interface()
/*******************************************************************************/ /*******************************************************************************/
/** GET DLL INTERFACE **/ /** 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) static long initialize_dll_interfaces(PT_VMR vmr)
{ {
HMODULE G_H_Module = NULL; HMODULE G_H_Module = NULL;
char szDllName[1024]; char dll_fullpath[DLL_FULLPATH_SZ];
memset(vmr, 0, sizeof(T_VBVMR_INTERFACE)); memset(vmr, 0, sizeof(T_VBVMR_INTERFACE));
// get Voicemeeter installation directory // get Voicemeeter installation directory
if (!registry_get_voicemeeter_folder(szDllName)) if (!registry_get_voicemeeter_folder(dll_fullpath))
{ {
// Voicemeeter not installed // Voicemeeter not installed
return -100; return -100;
} }
// use right dll according to O/S type // use right dll according to O/S type
if (sizeof(void *) == 8) if (IS_64_BIT)
strcat(szDllName, "\\VoicemeeterRemote64.dll"); strncat(dll_fullpath, DLL64_NAME, DLL_FULLPATH_SZ - strlen(DLL64_NAME) - 1);
else else
strcat(szDllName, "\\VoicemeeterRemote.dll"); strncat(dll_fullpath, DLL32_NAME, DLL_FULLPATH_SZ - strlen(DLL32_NAME) - 1);
// Load Dll // Load Dll
G_H_Module = LoadLibrary(szDllName); G_H_Module = LoadLibrary(dll_fullpath);
if (G_H_Module == NULL) if (G_H_Module == NULL)
return -101; return -101;
PRAGMA_IgnoreWCastIncompatibleFuncTypes;
// Get function pointers // Get function pointers
vmr->VBVMR_Login = (T_VBVMR_Login)GetProcAddress(G_H_Module, "VBVMR_Login"); 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_Logout = (T_VBVMR_Logout)GetProcAddress(G_H_Module, "VBVMR_Logout");
@ -110,39 +124,41 @@ static long initialize_dll_interfaces(PT_VMR vmr)
vmr->VBVMR_MacroButton_GetStatus = (T_VBVMR_MacroButton_GetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_GetStatus"); 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"); vmr->VBVMR_MacroButton_SetStatus = (T_VBVMR_MacroButton_SetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_SetStatus");
PRAGMA_Pop;
// check pointers are valid // check pointers are valid
if (vmr->VBVMR_Login == NULL) if (vmr->VBVMR_Login == NULL)
return -1; return -1;
if (vmr->VBVMR_Logout == NULL) if (vmr->VBVMR_Logout == NULL)
return -2; return -2;
if (vmr->VBVMR_RunVoicemeeter == NULL) if (vmr->VBVMR_RunVoicemeeter == NULL)
return -2;
if (vmr->VBVMR_GetVoicemeeterType == NULL)
return -3; return -3;
if (vmr->VBVMR_GetVoicemeeterVersion == NULL) if (vmr->VBVMR_GetVoicemeeterType == NULL)
return -4; return -4;
if (vmr->VBVMR_IsParametersDirty == NULL) if (vmr->VBVMR_GetVoicemeeterVersion == NULL)
return -5; return -5;
if (vmr->VBVMR_GetParameterFloat == NULL) if (vmr->VBVMR_IsParametersDirty == NULL)
return -6; return -6;
if (vmr->VBVMR_GetParameterStringA == NULL) if (vmr->VBVMR_GetParameterFloat == NULL)
return -7; return -7;
if (vmr->VBVMR_GetParameterStringW == NULL) if (vmr->VBVMR_GetParameterStringA == NULL)
return -8; return -8;
if (vmr->VBVMR_GetLevel == NULL) if (vmr->VBVMR_GetParameterStringW == NULL)
return -9; return -9;
if (vmr->VBVMR_SetParameterFloat == NULL) if (vmr->VBVMR_GetLevel == NULL)
return -10; return -10;
if (vmr->VBVMR_SetParameters == NULL) if (vmr->VBVMR_SetParameterFloat == NULL)
return -11; return -11;
if (vmr->VBVMR_SetParametersW == NULL) if (vmr->VBVMR_SetParameters == NULL)
return -12; return -12;
if (vmr->VBVMR_SetParameterStringA == NULL) if (vmr->VBVMR_SetParametersW == NULL)
return -13; return -13;
if (vmr->VBVMR_SetParameterStringW == NULL) if (vmr->VBVMR_SetParameterStringA == NULL)
return -14; return -14;
if (vmr->VBVMR_GetMidiMessage == NULL) if (vmr->VBVMR_SetParameterStringW == NULL)
return -15; return -15;
if (vmr->VBVMR_GetMidiMessage == NULL)
return -16;
if (vmr->VBVMR_Output_GetDeviceNumber == NULL) if (vmr->VBVMR_Output_GetDeviceNumber == NULL)
return -30; return -30;
@ -171,50 +187,48 @@ static long initialize_dll_interfaces(PT_VMR vmr)
/** GET VOICEMEETER DIRECTORY **/ /** GET VOICEMEETER DIRECTORY **/
/*******************************************************************************/ /*******************************************************************************/
#define INSTALLER_DIR_KEY "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall"
#define INSTALLER_UNINST_KEY "VB:Voicemeeter {17359A74-1236-5467}" #define INSTALLER_UNINST_KEY "VB:Voicemeeter {17359A74-1236-5467}"
#ifndef KEY_WOW64_32KEY #ifndef KEY_WOW64_32KEY
#define KEY_WOW64_32KEY 0x0200 #define KEY_WOW64_32KEY 0x0200
#endif #endif
static bool registry_get_voicemeeter_folder(char *szDir) #define UNINSTALL_KEY_SZ 256
{ #define UNINSTALL_PATH_SZ 1024
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";
static bool registry_get_voicemeeter_folder(char *dll_fullpath)
{
// build Voicemeeter uninstallation key // build Voicemeeter uninstallation key
strcpy(szKey, uninstDirKey); char uninstall_key[UNINSTALL_KEY_SZ];
strcat(szKey, "\\"); snprintf(uninstall_key, UNINSTALL_KEY_SZ, "%s\\%s", INSTALLER_DIR_KEY, INSTALLER_UNINST_KEY);
strcat(szKey, INSTALLER_UNINST_KEY);
// open key // open key
rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKey, 0, KEY_READ, &hkResult); HKEY result;
LONG rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, uninstall_key, 0, KEY_READ, &result);
if (rep != ERROR_SUCCESS) if (rep != ERROR_SUCCESS)
{ {
// if not present we consider running in 64bit mode and force to read 32bit registry // 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); rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, uninstall_key, 0, KEY_READ | KEY_WOW64_32KEY, &result);
} }
if (rep != ERROR_SUCCESS) if (rep != ERROR_SUCCESS)
return false; return false;
// read uninstall path from registry // read uninstall path from registry
rep = RegQueryValueEx(hkResult, "UninstallString", 0, &pptype, (unsigned char *)sss, &nnsize); DWORD pptype = REG_SZ;
RegCloseKey(hkResult); 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) if (pptype != REG_SZ)
return false; return false;
if (rep != ERROR_SUCCESS) if (rep != ERROR_SUCCESS)
return false; return false;
// remove name to get the path only // remove name to get the path only
remove_last_part_of_path(sss); remove_last_part_of_path(uninstall_path);
if (nnsize > 512) snprintf(dll_fullpath, DLL_FULLPATH_SZ, uninstall_path);
nnsize = 512;
strncpy(szDir, sss, nnsize);
return true; 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

@ -2,24 +2,22 @@
* @file util.c * @file util.c
* @author Onyx and Iris (code@onyxandiris.online) * @author Onyx and Iris (code@onyxandiris.online)
* @brief Utility functions. * @brief Utility functions.
* @version 0.7.0 * @version 0.13.0
* @date 2024-07-06 * @date 2024-07-06
* *
* @copyright Copyright (c) 2024 * @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE * https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/ */
#include <stddef.h>
#include <stdio.h> #include <stdio.h>
#include <string.h> #include <string.h>
#include <ctype.h>
#include "wrapper.h"
#include "util.h" #include "util.h"
#include "log.h"
/** /**
* @brief Removes the last part of a path * @brief Removes the last part of a path
* *
* @param fullpath The entire path * @param fullpath
*/ */
void remove_last_part_of_path(char *fullpath) void remove_last_part_of_path(char *fullpath)
{ {
@ -31,10 +29,33 @@ void remove_last_part_of_path(char *fullpath)
} }
} }
/**
* @brief Gets log level as int from string
* @param level Log level as string
* @return int Log level as int, or -1 if not found
*/
int log_level_from_string(const char *level)
{
if (strcmp(level, "TRACE") == 0)
return LOG_TRACE;
else if (strcmp(level, "DEBUG") == 0)
return LOG_DEBUG;
else if (strcmp(level, "INFO") == 0)
return LOG_INFO;
else if (strcmp(level, "WARN") == 0)
return LOG_WARN;
else if (strcmp(level, "ERROR") == 0)
return LOG_ERROR;
else if (strcmp(level, "FATAL") == 0)
return LOG_FATAL;
else
return -1;
}
/** /**
* @brief Converts Voicemeeter's kind into a string. * @brief Converts Voicemeeter's kind into a string.
* *
* @param s Pointer to a character buffer * @param s Pointer to a character buffer receiving the kind
* @param kind The kind of Voicemeeter. * @param kind The kind of Voicemeeter.
* @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* String representation of the kind of Voicemeeter. * @return char* String representation of the kind of Voicemeeter.
@ -56,7 +77,7 @@ char *kind_as_string(char *s, int kind, int n)
/** /**
* @brief Converts Voicemeeter's version into a string. * @brief Converts Voicemeeter's version into a string.
* *
* @param s Pointer to a character buffer * @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* String representation of the Voicemeeter version * @return char* String representation of the Voicemeeter version
@ -69,4 +90,102 @@ char *version_as_string(char *s, long v, int n)
v4 = (v & 0x000000FF); v4 = (v & 0x000000FF);
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;
}

View File

@ -2,7 +2,7 @@
* @file vmrcli.c * @file vmrcli.c
* @author Onyx and Iris (code@onyxandiris.online) * @author Onyx and Iris (code@onyxandiris.online)
* @brief A Voicemeeter Remote Command Line Interface * @brief A Voicemeeter Remote Command Line Interface
* @version 0.7.0 * @version 0.13.0
* @date 2024-07-06 * @date 2024-07-06
* *
* @copyright Copyright (c) 2024 * @copyright Copyright (c) 2024
@ -11,68 +11,78 @@
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>
#include <stdbool.h>
#include <getopt.h>
#include <string.h> #include <string.h>
#include <ctype.h> #include <ctype.h>
#include <getopt.h>
#include <windows.h> #include <windows.h>
#include "ivmr.h" #include "interface.h"
#include "wrapper.h" #include "wrapper.h"
#include "log.h" #include "log.h"
#include "util.h" #include "util.h"
#define USAGE "Usage: .\\vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n" \ #define USAGE "Usage: .\\vmrcli.exe [-h] [-v] [-i|-I] [-f] [-k] [-l] [-e] [-c] [-m] [-s] <api commands>\n" \
"Where: \n" \ "Where: \n" \
"\th: Prints the help message\n" \ "\th: Print the help message\n" \
"\ti: Enable interactive mode\n" \ "\tv: Print the version number\n" \
"\tk: The kind of Voicemeeter (basic, banana, potato)\n" \ "\ti: Enable interactive mode, use (-I) to disable the '>>' prompt\n" \
"\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL\n" \ "\tf: Do not split input on spaces\n" \
"\tv: Enable extra console output (toggle, set messages)\n" \ "\tk: The kind of Voicemeeter (basic, banana, potato)\n" \
"\tc: Load a user configuration (give the full file path)\n" \ "\tl: Set log level, must be one of TRACE, DEBUG, INFO, WARN, ERROR, or FATAL\n" \
"\tm: Launch the MacroButtons application\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" "\ts: Launch the StreamerView application"
#define OPTSTR ":hk:msc:iD:v" #define OPTSTR ":hvk:msc:iIfl:e"
#define MAX_LINE 512 #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 The kind of values a get call may return. * @enum The kind of values a get call may return.
*/ */
enum enum restype : int
{ {
FLOAT_T, FLOAT_T,
STRING_T, STRING_T,
}; };
/** /**
* @struct A struct holding the result of a get call. * @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;
}; };
static bool vflag = false; static bool eflag = false;
static void usage(void); static void terminate(PT_VMR vmr, char *msg);
enum kind set_kind(char *kval); static void usage();
void interactive(PT_VMR vmr); static enum kind set_kind(char *kval);
void parse_input(PT_VMR vmr, char *input); static void interactive(PT_VMR vmr, bool with_prompt, char *delimiters);
void parse_command(PT_VMR vmr, char *command); static void parse_input(PT_VMR vmr, char *input, char *delimiters);
void get(PT_VMR vmr, char *command, struct result *res); 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, mflag = false,
sflag = false, sflag = false,
cflag = false; cflag = false,
fflag = false,
with_prompt = true;
int opt; int opt;
int dvalue; int log_level = LOG_WARN;
char *cvalue; char *cvalue;
enum kind kind = BANANAX64; enum kind kind = BANANAX64;
@ -81,13 +91,16 @@ int main(int argc, char *argv[])
usage(); usage();
} }
log_set_level(LOG_WARN); log_set_level(log_level);
opterr = 0; opterr = 0;
while ((opt = getopt(argc, argv, OPTSTR)) != -1) while ((opt = getopt(argc, argv, OPTSTR)) != -1)
{ {
switch (opt) switch (opt)
{ {
case 'v':
printf("vmrcli version %s\n", VERSION);
exit(EXIT_SUCCESS);
case 'k': case 'k':
kind = set_kind(optarg); kind = set_kind(optarg);
if (kind == UNKNOWN) if (kind == UNKNOWN)
@ -106,24 +119,30 @@ int main(int argc, char *argv[])
cflag = true; cflag = true;
cvalue = optarg; cvalue = optarg;
break; break;
case 'I':
with_prompt = false;
[[fallthrough]];
case 'i': case 'i':
iflag = true; iflag = true;
break; break;
case 'D': case 'f':
dvalue = atoi(optarg); fflag = true;
if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL) break;
case 'l':
log_level = log_level_from_string(optarg);
if (log_level != -1)
{ {
log_set_level(dvalue); log_set_level(log_level);
} }
else else
{ {
log_warn( 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 '?': case '?':
log_fatal("unknown option -- '%c'\n" log_fatal("unknown option -- '%c'\n"
@ -143,61 +162,85 @@ int main(int argc, char *argv[])
} }
PT_VMR vmr = create_interface(); PT_VMR vmr = create_interface();
if (vmr == NULL)
{
exit(EXIT_FAILURE);
}
int rep = login(vmr, kind); long rep = login(vmr, kind);
if (rep != 0) if (rep != 0)
{ {
log_fatal("Error logging into the Voicemeeter API"); if (rep == -2)
exit(EXIT_FAILURE); terminate(vmr, "Timeout logging into the API.");
else
terminate(vmr, "Error logging into the Voicemeeter API");
} }
if (mflag) if (mflag)
{ {
log_info("MacroButtons app launched");
run_voicemeeter(vmr, MACROBUTTONS); run_voicemeeter(vmr, MACROBUTTONS);
log_info("MacroButtons app launched");
} }
if (sflag) if (sflag)
{ {
log_info("StreamerView app launched");
run_voicemeeter(vmr, STREAMERVIEW); run_voicemeeter(vmr, STREAMERVIEW);
log_info("StreamerView app launched");
} }
if (cflag) if (cflag)
{ {
log_info("Profile %s loaded", cvalue);
set_parameter_string(vmr, "command.load", cvalue); set_parameter_string(vmr, "command.load", cvalue);
log_info("Profile %s loaded", cvalue);
Sleep(300); Sleep(300);
clear_dirty(vmr); 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]); parse_input(vmr, argv[i], delimiter_ptr);
} }
} }
rep = logout(vmr); rep = logout(vmr);
if (rep == 0) if (rep != 0)
{ {
return EXIT_SUCCESS; terminate(vmr, "Error logging out of the Voicemeeter API");
}
else
{
log_fatal("Error logging out of the Voicemeeter API");
return EXIT_FAILURE;
} }
log_info("Successfully logged out of the Voicemeeter API");
free(vmr);
return EXIT_SUCCESS;
} }
/** /**
* @brief prints the help message * @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() static void usage()
{ {
@ -212,14 +255,14 @@ static void usage()
* @param kval Value of the -k flag * @param kval Value of the -k flag
* @return enum kind * @return enum kind
*/ */
enum kind set_kind(char *kval) static enum kind set_kind(char *kval)
{ {
if (strcmp(kval, "basic") == 0) if (strcmp(kval, "basic") == 0)
return sizeof(void *) == 8 ? BASICX64 : BASIC; return IS_64_BIT ? BASICX64 : BASIC;
else if (strcmp(kval, "banana") == 0) else if (strcmp(kval, "banana") == 0)
return sizeof(void *) == 8 ? BANANAX64 : BANANA; return IS_64_BIT ? BANANAX64 : BANANA;
else if (strcmp(kval, "potato") == 0) else if (strcmp(kval, "potato") == 0)
return sizeof(void *) == 8 ? POTATOX64 : POTATO; return IS_64_BIT ? POTATOX64 : POTATO;
else else
return UNKNOWN; return UNKNOWN;
} }
@ -230,41 +273,115 @@ enum kind set_kind(char *kval)
* Each line is passed to parse_input() * Each line is passed to parse_input()
* *
* @param vmr Pointer to the iVMR interface * @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
*/ */
void interactive(PT_VMR vmr) static void interactive(PT_VMR vmr, bool with_prompt, char *delimiters)
{ {
char input[MAX_LINE]; char input[MAX_LINE];
size_t len;
printf(">> "); if (with_prompt)
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;
if (strlen(input) == 1 && toupper(input[0]) == 'Q') if (len == 1 && toupper(input[0]) == 'Q')
break; break;
parse_input(vmr, input); parse_input(vmr, input, delimiters);
memset(input, 0, MAX_LINE); /* reset input buffer */ if (with_prompt)
printf(">> "); printf(">> ");
} }
} }
/* Helper functions for parse_input */
static inline bool is_quote_char(char c) {
return (c == '"' || c == '\'');
}
static inline bool is_delimiter_char(char c, const char *delimiters) {
return strchr(delimiters, c) != 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 Walks through each line split by " \t;," delimiters. * @brief Parse each input line into separate commands and execute them.
* Each token is passed to parse_command() * 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 vmr Pointer to the iVMR interface
* @param input Each input line, from stdin or CLI args * @param input Each input line, from stdin or CLI args
* @param delimiters A string of delimiter characters to split each input line
*/ */
void parse_input(PT_VMR vmr, char *input) static void parse_input(PT_VMR vmr, char *input, char *delimiters)
{ {
char *token, *p; if (is_comment(input))
return;
token = strtok_r(input, " \t;,", &p); char *current = input;
while (token != NULL) 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_r(NULL, " \t;,", &p);
} }
} }
@ -276,10 +393,27 @@ void parse_input(PT_VMR vmr, char *input)
* @param vmr Pointer to the iVMR interface * @param vmr Pointer to the iVMR interface
* @param command Each token from the input line as its own command string * @param command Each token from the input line as its own command string
*/ */
void parse_command(PT_VMR vmr, char *command) 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++;
@ -291,8 +425,7 @@ void parse_command(PT_VMR 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);
} }
} }
@ -304,10 +437,18 @@ void parse_command(PT_VMR 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))
{ {
printf("Setting %s\n", command); set_parameters(vmr, quoted_command);
if (eflag) {
printf("Setting %s\n", command);
}
}
else
{
log_error("Command too long after adding quotes");
} }
} }
else /* get */ else /* get */
@ -336,11 +477,11 @@ void parse_command(PT_VMR vmr, char *command)
* *
* @param vmr Pointer to the iVMR interface * @param vmr Pointer to the iVMR interface
* @param command A parsed 'get' command as a string * @param command A parsed 'get' command as a string
* @param res A struct holding the result of the API call. * @param res Pointer to a struct holding the result of the API call.
*/ */
void get(PT_VMR vmr, char *command, struct result *res) 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;

View File

@ -2,7 +2,7 @@
* @file wrapper.c * @file wrapper.c
* @author Onyx and Iris (code@onyxandiris.online) * @author Onyx and Iris (code@onyxandiris.online)
* @brief Provides public functions that wrap the iVMR calls * @brief Provides public functions that wrap the iVMR calls
* @version 0.7.0 * @version 0.13.0
* @date 2024-07-06 * @date 2024-07-06
* *
* @copyright Copyright (c) 2024 * @copyright Copyright (c) 2024
@ -10,14 +10,13 @@
*/ */
#include <windows.h> #include <windows.h>
#include <stdio.h>
#include <time.h>
#include "wrapper.h" #include "wrapper.h"
#include "log.h" #include "log.h"
#include "util.h" #include "util.h"
#define KIND_STR_LEN 64 #define KIND_STR_LEN 64
#define VERSION_STR_LEN 32 #define VERSION_STR_LEN 32
#define LOGIN_TIMEOUT 2
/** /**
* @brief Logs into the API. * @brief Logs into the API.
@ -26,11 +25,13 @@
* *
* @param vmr Pointer to the iVMR interface * @param vmr Pointer to the iVMR interface
* @param kind The kind of Voicemeeter Gui to launch. * @param kind The kind of Voicemeeter Gui to launch.
* @return long VBVMR_Login return value * @return long
* 0: OK (no error).
* -2: Login timed out.
*/ */
long login(PT_VMR vmr, int kind) long login(PT_VMR vmr, int kind)
{ {
int rep; long rep;
long v; long v;
log_trace("VBVMR_Login()"); log_trace("VBVMR_Login()");
@ -44,7 +45,6 @@ long login(PT_VMR vmr, int kind)
kind_as_string(kind_s, kind, KIND_STR_LEN)); kind_as_string(kind_s, kind, KIND_STR_LEN));
} }
int timeout = 2;
time_t start = time(NULL); time_t start = time(NULL);
do do
{ {
@ -54,15 +54,12 @@ long login(PT_VMR vmr, int kind)
log_info( log_info(
"Successfully logged into the Voicemeeter API v%s", "Successfully logged into the Voicemeeter API v%s",
version_as_string(version_s, v, VERSION_STR_LEN)); version_as_string(version_s, v, VERSION_STR_LEN));
clear(vmr, is_pdirty);
break; break;
} }
Sleep(50); Sleep(50);
} while (time(NULL) < start + timeout); } while (difftime(time(NULL), start) < LOGIN_TIMEOUT);
if (rep == 0)
{
clear_dirty(vmr);
}
return rep; return rep;
} }
@ -71,95 +68,201 @@ long login(PT_VMR vmr, int kind)
* final instruction to complete. * final instruction to complete.
* *
* @param vmr Pointer to the iVMR interface * @param vmr Pointer to the iVMR interface
* @return long VBVMR_Logout return value * @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L56
*/ */
long logout(PT_VMR vmr) long logout(PT_VMR vmr)
{ {
int rep;
Sleep(20); /* give time for last command */ Sleep(20); /* give time for last command */
log_trace("VBVMR_Logout()"); log_trace("VBVMR_Logout()");
rep = vmr->VBVMR_Logout(); return vmr->VBVMR_Logout();
if (rep == 0)
log_info("Successfully logged out of the Voicemeeter API");
return rep;
} }
/**
* @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) long run_voicemeeter(PT_VMR vmr, int kind)
{ {
log_trace("VBVMR_RunVoicemeeter(%d)", kind); log_trace("VBVMR_RunVoicemeeter(%d)", kind);
return vmr->VBVMR_RunVoicemeeter((long)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) long type(PT_VMR vmr, long *type)
{ {
log_trace("VBVMR_GetVoicemeeterType(<long> *t)"); log_trace("VBVMR_GetVoicemeeterType(<long> *t)");
return vmr->VBVMR_GetVoicemeeterType(type); 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) long version(PT_VMR vmr, long *version)
{ {
log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)"); log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)");
return vmr->VBVMR_GetVoicemeeterVersion(version); 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) bool is_pdirty(PT_VMR vmr)
{ {
log_trace("VBVMR_IsParametersDirty()"); log_trace("VBVMR_IsParametersDirty()");
return vmr->VBVMR_IsParametersDirty() == 1; 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) long get_parameter_float(PT_VMR vmr, char *param, float *f)
{ {
log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param); log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param);
return vmr->VBVMR_GetParameterFloat(param, f); return vmr->VBVMR_GetParameterFloat(param, f);
} }
long get_parameter_string(PT_VMR vmr, char *param, unsigned short *s) /**
* @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, <unsigned short> *s)", param); log_trace("VBVMR_GetParameterStringW(%s, <wchar_t> *s)", param);
return vmr->VBVMR_GetParameterStringW(param, s); 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) long set_parameter_float(PT_VMR vmr, char *param, float val)
{ {
log_trace("VBVMR_SetParameterFloat(%s, %.1f)", param, val); log_trace("VBVMR_SetParameterFloat(%s, %.1f)", param, val);
return vmr->VBVMR_SetParameterFloat(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) long set_parameter_string(PT_VMR vmr, char *param, char *s)
{ {
log_trace("VBVMR_SetParameterStringA(%s, %s)", param, s); log_trace("VBVMR_SetParameterStringA(%s, %s)", param, s);
return vmr->VBVMR_SetParameterStringA(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) long set_parameters(PT_VMR vmr, char *command)
{ {
log_trace("VBVMR_SetParameters(%s)", command); log_trace("VBVMR_SetParameters(%s)", command);
return vmr->VBVMR_SetParameters(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) bool is_mdirty(PT_VMR vmr)
{ {
log_trace("VBVMR_MacroButton_IsDirty()"); log_trace("VBVMR_MacroButton_IsDirty()");
return vmr->VBVMR_MacroButton_IsDirty() == 1; 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) long macrobutton_getstatus(PT_VMR vmr, long n, float *val, long mode)
{ {
log_trace("VBVMR_MacroButton_GetStatus(%ld, <float> *v, %ld)", n, mode); log_trace("VBVMR_MacroButton_GetStatus(%ld, <float> *v, %ld)", n, mode);
return vmr->VBVMR_MacroButton_GetStatus(n, val, 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) long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode)
{ {
log_trace("VBVMR_MacroButton_SetStatus(%ld, %d, %ld)", n, (int)val, mode); log_trace("VBVMR_MacroButton_SetStatus(%ld, %d, %ld)", n, (int)val, mode);
return vmr->VBVMR_MacroButton_SetStatus(n, val, mode); return vmr->VBVMR_MacroButton_SetStatus(n, val, mode);
} }
void clear_dirty(PT_VMR vmr) /**
* @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); Sleep(30);
while (is_pdirty(vmr)) while (f(vmr))
Sleep(1); Sleep(1);
} }