Compare commits

..

No commits in common. "main" and "v0.10.0" have entirely different histories.

14 changed files with 170 additions and 650 deletions

1
.env
View File

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

View File

@ -1,102 +0,0 @@
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 }}

7
.gitignore vendored
View File

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

184
README.md
View File

@ -1,189 +1,115 @@
# Voicemeeter Remote Command Line Utility
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Platform](https://img.shields.io/badge/platform-Windows-blue)](#requirements)
## `Tested against`
> A command-line interface for controlling Voicemeeter
- Basic 1.1.1.1
- Banana 2.1.1.1
- Potato 3.1.1.1
## Compatibility
## `Requirements`
| Voicemeeter Version | Status |
|-------------------|--------|
| Basic 1.1.2.2 | ✅ Tested |
| Banana 2.1.2.2 | ✅ Tested |
| Potato 3.1.2.2 | ✅ Tested |
- [Voicemeeter](https://voicemeeter.com/)
## Requirements
- **[Voicemeeter](https://voicemeeter.com/)** - Any version (Basic, Banana, or Potato)
- **Windows** operating system
- **Command line environment** (PowerShell, CMD, or Terminal)
## Usage
## `Use`
```powershell
.\vmrcli.exe [OPTIONS] <api_commands>
.\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
```
### Command Line Options
Where:
| Option | Description | Example |
|--------|-------------|----------|
| `-h` | Print help message | `vmrcli.exe -h` |
| `-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.
- `h`: Prints the help message.
- `i`: Enable interactive mode, use (-I) to disable the '>>' prompt.
- 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.
- `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL
- `v`: Enable extra console output (toggle, set messages)
- `c`: Load a user configuration (give the full file path)
- `m`: Launch the MacroButtons application
- `s`: Launch the StreamerView application
## `API Commands`
### Command Types
- Commands starting with `!` will be toggled, use it with boolean parameters.
- Commands containing `=` will set a value. (use `+=` and `-=` to increment/decrement)
- All other commands with get a value.
| 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` |
Examples:
> **Tip:** Use quotes around values containing spaces: `'strip[0].label="my device"'`
---
### Examples
#### **Basic Operations**
*Toggle mute, get values, and adjust gain*
Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, print its new value, then decrease Bus 0 Gain by 3.8
```powershell
.\vmrcli.exe -kbasic -lINFO !strip[0].mute strip[0].mute bus[0].gain-=3.8
.\vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute bus[0].gain-=3.8
```
#### **Setting Labels with Spaces**
*Set labels and print them back*
Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then print Strip 2 label
```powershell
.\vmrcli.exe -kbanana -lDEBUG 'strip[0].label="my podmic"' strip[0].label
.\vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label
```
#### **Device Configuration**
*Configure hardware devices with complex names*
#### `Quick Commands`
```powershell
.\vmrcli.exe -lDEBUG bus[2].mute=1 bus[2].mute 'bus[2].device.wdm="Realtek Digital Output (Realtek(R) Audio)"'
```
A short list of quick commands are available:
#### **Batch Operations**
*Multiple strip configurations in one command*
- `lock`: command.lock=1
- `unlock`: command.lock=0
- `show`: command.show=1
- `hide`: command.show=0
- `restart`: command.restart=1
```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
```
They may be used in direct or interactive mode.
### Quick Commands
## `Interactive Mode`
*Convenient shortcuts for common Voicemeeter operations*
Running the following command in Powershell:
| 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:**
Will open an interactive prompt:
```powershell
Interactive mode enabled. Enter 'Q' to exit.
>>
```
> **Important:** Command line API arguments are ignored when using `-i`
API commands follow the same rules as listed above. Entering `Q` or `q` will exit the program.
## Script Files
## `Script files`
*Automate complex audio setups with script files*
Scripts can be loaded from text files, for example in Powershell:
### Loading Scripts
**From file content:**
```powershell
.\vmrcli.exe -lDEBUG $(Get-Content .\example_commands.txt)
.\vmrcli.exe -D1 $(Get-Content .\example_commands.txt)
```
**Via pipeline:**
You may also pipe a scripts contents to the CLI:
```powershell
$(Get-Content .\example_commands.txt) | .\vmrcli.exe -lDEBUG -I
$(Get-Content .\example_commands.txt) | .\vmrcli.exe -D1 -I
```
### Script Format Rules
Multiple API commands can be in a single line, they may be separated by space, `;` or `,`.
| 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` |
Lines starting with `#` will be interpreted as comments.
## Build Instructions
## `Build`
*Compile from source using GNU Make*
Run the included `makefile` with [GNU Make](https://www.gnu.org/software/make/).
### Prerequisites
- [GNU Make](https://www.gnu.org/software/make/)
- GCC compiler (recommended)
- Windows development environment
The binary in [Releases][releases] is compiled with coloured logging enabled. To disable this you can override the `LOG_USE_COLOR` variable, for example:
### Build Commands
`make LOG_USE_COLOR=no`
```bash
# Standard build
make
## `Official Documentation`
# Disable colored logging
make LOG_USE_COLOR=no
- [Voicemeeter Remote C API][remoteapi-docs]
# Clean build artifacts
make clean
```
## `Special Thanks`
> **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.
- [rxi][rxi-user] for writing the [log.c][log-c] package
[releases]: https://github.com/onyx-and-iris/vmrcli/releases
[remoteapi-docs]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf

View File

@ -1,85 +0,0 @@
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,5 @@
# Strip 0
strip[0].mute !strip[0].mute strip[0].mute strip[0].gain strip[0].label="my 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
strip[1].mute=1 strip[1].mute strip[1].limit-=8

View File

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

View File

@ -15,11 +15,9 @@ struct quickcommand
};
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__ */

View File

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

View File

@ -1,9 +1,9 @@
/**
* @file interface.c
* @file ivmr.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
* @version 0.10.0
* @date 2024-07-06
*
* @copyright Vincent Burel(c)2015-2021 All Rights Reserved
@ -14,7 +14,7 @@
*/
#include <windows.h>
#include "interface.h"
#include "ivmr.h"
#include "util.h"
#include "log.h"
@ -25,8 +25,10 @@
#define PRAGMA_Pop \
_Pragma("GCC diagnostic pop")
static T_VBVMR_INTERFACE iVMR;
static long initialize_dll_interfaces(PT_VMR vmr);
static bool registry_get_voicemeeter_folder(char *dll_fullpath);
static bool registry_get_voicemeeter_folder(char *szDir);
/**
* @brief Create an interface object
@ -36,14 +38,10 @@ static bool registry_get_voicemeeter_folder(char *dll_fullpath);
*/
PT_VMR create_interface()
{
PT_VMR vmr = malloc(sizeof(T_VBVMR_INTERFACE));
if (vmr == NULL)
{
log_error("malloc failed to allocate memory");
return NULL;
}
PT_VMR vmr = &iVMR;
int rep;
LONG rep = initialize_dll_interfaces(vmr);
rep = initialize_dll_interfaces(vmr);
if (rep < 0)
{
if (rep == -100)
@ -54,8 +52,7 @@ PT_VMR create_interface()
{
log_fatal("Error loading Voicemeeter dll with code %d", rep);
}
free(vmr);
vmr = NULL;
return NULL;
}
return vmr;
@ -64,30 +61,26 @@ PT_VMR create_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)
{
HMODULE G_H_Module = NULL;
char dll_fullpath[DLL_FULLPATH_SZ];
char szDllName[1024];
memset(vmr, 0, sizeof(T_VBVMR_INTERFACE));
// get Voicemeeter installation directory
if (!registry_get_voicemeeter_folder(dll_fullpath))
if (!registry_get_voicemeeter_folder(szDllName))
{
// 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);
if (sizeof(void *) == 8)
strcat(szDllName, "\\VoicemeeterRemote64.dll");
else
strncat(dll_fullpath, DLL32_NAME, DLL_FULLPATH_SZ - strlen(DLL32_NAME) - 1);
strcat(szDllName, "\\VoicemeeterRemote.dll");
// Load Dll
G_H_Module = LoadLibrary(dll_fullpath);
G_H_Module = LoadLibrary(szDllName);
if (G_H_Module == NULL)
return -101;
@ -132,33 +125,33 @@ static long initialize_dll_interfaces(PT_VMR vmr)
if (vmr->VBVMR_Logout == NULL)
return -2;
if (vmr->VBVMR_RunVoicemeeter == NULL)
return -3;
return -2;
if (vmr->VBVMR_GetVoicemeeterType == NULL)
return -4;
return -3;
if (vmr->VBVMR_GetVoicemeeterVersion == NULL)
return -5;
return -4;
if (vmr->VBVMR_IsParametersDirty == NULL)
return -6;
return -5;
if (vmr->VBVMR_GetParameterFloat == NULL)
return -7;
return -6;
if (vmr->VBVMR_GetParameterStringA == NULL)
return -8;
return -7;
if (vmr->VBVMR_GetParameterStringW == NULL)
return -9;
return -8;
if (vmr->VBVMR_GetLevel == NULL)
return -10;
return -9;
if (vmr->VBVMR_SetParameterFloat == NULL)
return -11;
return -10;
if (vmr->VBVMR_SetParameters == NULL)
return -12;
return -11;
if (vmr->VBVMR_SetParametersW == NULL)
return -13;
return -12;
if (vmr->VBVMR_SetParameterStringA == NULL)
return -14;
return -13;
if (vmr->VBVMR_SetParameterStringW == NULL)
return -15;
return -14;
if (vmr->VBVMR_GetMidiMessage == NULL)
return -16;
return -15;
if (vmr->VBVMR_Output_GetDeviceNumber == NULL)
return -30;
@ -187,48 +180,50 @@ static long initialize_dll_interfaces(PT_VMR vmr)
/** 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)
static bool 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
char uninstall_key[UNINSTALL_KEY_SZ];
snprintf(uninstall_key, UNINSTALL_KEY_SZ, "%s\\%s", INSTALLER_DIR_KEY, INSTALLER_UNINST_KEY);
strcpy(szKey, uninstDirKey);
strcat(szKey, "\\");
strcat(szKey, INSTALLER_UNINST_KEY);
// open key
HKEY result;
LONG rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, uninstall_key, 0, KEY_READ, &result);
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, uninstall_key, 0, KEY_READ | KEY_WOW64_32KEY, &result);
rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKey, 0, KEY_READ | KEY_WOW64_32KEY, &hkResult);
}
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);
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_last_part_of_path(uninstall_path);
snprintf(dll_fullpath, DLL_FULLPATH_SZ, uninstall_path);
remove_last_part_of_path(sss);
if (nnsize > 512)
nnsize = 512;
strncpy(szDir, sss, nnsize);
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)
{
for (int i = 0; i < MAX_CALLBACKS; ++i)
for (int i = 0; i < MAX_CALLBACKS; i++)
{
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);
}
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];
if (level >= cb->level)

View File

@ -2,7 +2,7 @@
* @file util.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Utility functions.
* @version 0.13.0
* @version 0.10.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
@ -12,7 +12,6 @@
#include <stdio.h>
#include <string.h>
#include "util.h"
#include "log.h"
/**
* @brief Removes the last part of a path
@ -29,29 +28,6 @@ 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.
*
@ -116,7 +92,7 @@ bool is_comment(char *s)
*/
struct quickcommand *command_in_quickcommands(const char *command_key, const struct quickcommand *quickcommands, int n)
{
for (int i = 0; i < n; ++i)
for (int i = 0; i < n; i++)
{
if (strcmp(command_key, quickcommands[i].name) == 0)
{
@ -125,67 +101,3 @@ struct quickcommand *command_in_quickcommands(const char *command_key, const str
}
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
* @author Onyx and Iris (code@onyxandiris.online)
* @brief A Voicemeeter Remote Command Line Interface
* @version 0.13.0
* @version 0.10.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
@ -11,33 +11,28 @@
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <getopt.h>
#include <windows.h>
#include "interface.h"
#include "ivmr.h"
#include "wrapper.h"
#include "log.h"
#include "util.h"
#define USAGE "Usage: .\\vmrcli.exe [-h] [-v] [-i|-I] [-f] [-k] [-l] [-e] [-c] [-m] [-s] <api commands>\n" \
#define USAGE "Usage: .\\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n" \
"Where: \n" \
"\th: Print the help message\n" \
"\tv: Print the version number\n" \
"\th: Prints the help message\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" \
"\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL\n" \
"\tv: 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 OPTSTR ":hk:msc:iID:v"
#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.
@ -63,13 +58,12 @@ struct result
} val;
};
static bool eflag = false;
static 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 interactive(PT_VMR vmr, bool with_prompt);
static void parse_input(PT_VMR vmr, char *input);
static void parse_command(PT_VMR vmr, char *command);
static void get(PT_VMR vmr, char *command, struct result *res);
@ -79,10 +73,9 @@ int main(int argc, char *argv[])
mflag = false,
sflag = false,
cflag = false,
fflag = false,
with_prompt = true;
int opt;
int log_level = LOG_WARN;
int dvalue;
char *cvalue;
enum kind kind = BANANAX64;
@ -91,16 +84,13 @@ int main(int argc, char *argv[])
usage();
}
log_set_level(log_level);
log_set_level(LOG_WARN);
opterr = 0;
while ((opt = getopt(argc, argv, OPTSTR)) != -1)
{
switch (opt)
{
case 'v':
printf("vmrcli version %s\n", VERSION);
exit(EXIT_SUCCESS);
case 'k':
kind = set_kind(optarg);
if (kind == UNKNOWN)
@ -125,24 +115,21 @@ int main(int argc, char *argv[])
case 'i':
iflag = true;
break;
case 'f':
fflag = true;
break;
case 'l':
log_level = log_level_from_string(optarg);
if (log_level != -1)
case 'D':
dvalue = atoi(optarg);
if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
{
log_set_level(log_level);
log_set_level(dvalue);
}
else
{
log_warn(
"-l arg out of range, expected TRACE, DEBUG, INFO, WARN, ERROR, or FATAL\n"
"-D arg out of range, expected value from 0 up to 5\n"
"Log level will default to LOG_WARN (3).\n");
}
break;
case 'e':
eflag = true;
case 'v':
vflag = true;
break;
case '?':
log_fatal("unknown option -- '%c'\n"
@ -171,9 +158,10 @@ int main(int argc, char *argv[])
if (rep != 0)
{
if (rep == -2)
terminate(vmr, "Timeout logging into the API.");
log_fatal("Timeout logging into the API.");
else
terminate(vmr, "Error logging into the Voicemeeter API");
log_fatal("Eror logging into the Voicemeeter API");
exit(EXIT_FAILURE);
}
if (mflag)
@ -196,47 +184,30 @@ int main(int argc, char *argv[])
clear(vmr, is_pdirty);
}
char *delimiter_ptr = DELIMITERS;
if (fflag)
{
delimiter_ptr++; /* skip space delimiter */
}
if (iflag)
{
puts("Interactive mode enabled. Enter 'Q' to exit.");
interactive(vmr, with_prompt, delimiter_ptr);
interactive(vmr, with_prompt);
}
else
{
for (int i = optind; i < argc; ++i)
for (int i = optind; i < argc; i++)
{
parse_input(vmr, argv[i], delimiter_ptr);
parse_input(vmr, argv[i]);
}
}
rep = logout(vmr);
if (rep != 0)
{
terminate(vmr, "Error logging out of the Voicemeeter API");
log_fatal("Error logging out of the Voicemeeter API");
return EXIT_FAILURE;
}
else
{
log_info("Successfully logged out of the Voicemeeter API");
return EXIT_SUCCESS;
}
log_info("Successfully logged out of the Voicemeeter API");
free(vmr);
return EXIT_SUCCESS;
}
/**
* @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);
}
/**
@ -258,11 +229,11 @@ static void usage()
static enum kind set_kind(char *kval)
{
if (strcmp(kval, "basic") == 0)
return IS_64_BIT ? BASICX64 : BASIC;
return sizeof(void *) == 8 ? BASICX64 : BASIC;
else if (strcmp(kval, "banana") == 0)
return IS_64_BIT ? BANANAX64 : BANANA;
return sizeof(void *) == 8 ? BANANAX64 : BANANA;
else if (strcmp(kval, "potato") == 0)
return IS_64_BIT ? POTATOX64 : POTATO;
return sizeof(void *) == 8 ? POTATOX64 : POTATO;
else
return UNKNOWN;
}
@ -274,9 +245,8 @@ static enum kind set_kind(char *kval)
*
* @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)
static void interactive(PT_VMR vmr, bool with_prompt)
{
char input[MAX_LINE];
size_t len;
@ -285,103 +255,38 @@ static void interactive(PT_VMR vmr, bool with_prompt, char *delimiters)
printf(">> ");
while (fgets(input, MAX_LINE, stdin) != NULL)
{
input[(len = strcspn(input, "\n"))] = 0;
if (len == 1 && toupper(input[0]) == 'Q')
input[strcspn(input, "\n")] = 0;
if ((len = strlen(input)) == 1 && toupper(input[0]) == 'Q')
break;
parse_input(vmr, input, delimiters);
parse_input(vmr, input);
memset(input, 0, len); /* reset input buffer */
if (with_prompt)
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 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
* @brief Returns early if input is a comment
* Walks through each line split by " \t;," delimiters.
* Each token is passed to parse_command()
*
* @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)
static void parse_input(PT_VMR vmr, char *input)
{
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';
char *token, *p;
while (*current != '\0')
token = strtok_r(input, DELIMITERS, &p);
while (token != NULL)
{
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);
token = strtok_r(NULL, DELIMITERS, &p);
}
}
@ -408,7 +313,8 @@ static void parse_command(PT_VMR vmr, char *command)
if (qc_ptr != NULL)
{
set_parameters(vmr, qc_ptr->fullcommand);
if (eflag) {
if (vflag)
{
printf("Setting %s\n", qc_ptr->fullcommand);
}
return;
@ -425,7 +331,8 @@ static void parse_command(PT_VMR vmr, char *command)
if (res.val.f == 1 || res.val.f == 0)
{
set_parameter_float(vmr, command, 1 - res.val.f);
if (eflag) {
if (vflag)
{
printf("Toggling %s\n", command);
}
}
@ -437,18 +344,10 @@ static void parse_command(PT_VMR vmr, char *command)
if (strchr(command, '=') != NULL) /* set */
{
char quoted_command[MAX_LINE];
if (add_quotes_if_needed(command, quoted_command, MAX_LINE))
set_parameters(vmr, command);
if (vflag)
{
set_parameters(vmr, quoted_command);
if (eflag) {
printf("Setting %s\n", command);
}
}
else
{
log_error("Command too long after adding quotes");
printf("Setting %s\n", command);
}
}
else /* get */

View File

@ -2,7 +2,7 @@
* @file wrapper.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Provides public functions that wrap the iVMR calls
* @version 0.13.0
* @version 0.10.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024