64 Commits

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

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

add -m, -s flags to Use section in README.
2024-07-02 17:49:51 +01:00
f8d2f80cbf remove the extra call to version 2024-07-02 14:49:42 +01:00
4b79b7f849 add -= example to README 2024-07-02 12:00:16 +01:00
3ec98ea391 add note about += and -= to README
add increment/decrement instructions to example_commands
2024-07-02 11:55:34 +01:00
faad5bc2c8 add doc comments 2024-07-02 11:15:17 +01:00
cc0ec73ef4 fix help dialogue 2024-07-02 10:25:25 +01:00
c45df11286 add -v flag to README use section 2024-07-02 10:24:07 +01:00
a383aaa36b reword
add link defs
2024-07-02 10:21:37 +01:00
28945b72c5 modify example_commands to show multiple instructions per line
Add note in README about change.
2024-07-02 10:14:25 +01:00
97fc9ca9ce use strtok to walk through the input string
vflag added for extra console output (toggle, set operations)
2024-07-02 10:13:37 +01:00
12a55a52f2 Merge branch 'main' of https://github.com/onyx-and-iris/vmrcli 2024-07-01 07:35:35 +01:00
d4afbfa881 upd heading 2024-07-01 07:35:32 +01:00
ea1f05d323 remove shift one char 2024-07-01 04:43:15 +01:00
900ed23ebf Create LICENSE 2024-07-01 03:46:09 +01:00
815a19210b protect against unsafe gain changes 2024-07-01 03:40:33 +01:00
adaf3a7837 break up long line 2024-06-29 03:08:03 +01:00
1199b31e2c extra X64 kinds added to enum kind
log message updated to reflect new kinds

replace_multiple_space_with_one() now returns new line length

kind_as_string() added to util.c
2024-06-29 03:05:51 +01:00
2740c6c82d move remove_name_in_path() into util.c
add version_as_string() to util.c
2024-06-28 03:21:38 +01:00
0bda368f59 add -h flag to help dialogue
add -h flag to Use section in README

update example markdown in README
2024-06-28 03:04:14 +01:00
49604b874b ensure we don't step past the NUL terminator here. 2024-06-28 01:54:04 +01:00
161b1061c4 remove unnecessary args in log_trace calls
ensure we shift a char after copying next command from input buffer
2024-06-28 01:23:40 +01:00
3c46b3d9f3 Use VBVMR_GetParameterStringW instead of VBVMR_GetParameterStringA
update struct result definition

fixes bug with unknown parameters
2024-06-27 23:26:46 +01:00
accab93fba reword 2024-06-27 23:09:10 +01:00
947abb3c01 clear the input buffer before reading from stdin again 2024-06-27 23:07:29 +01:00
e06a26f87b add Build section to README. 2024-06-27 23:02:34 +01:00
25bf542b46 add conditional override var LOG_USE_COLOR to makefile 2024-06-27 22:57:35 +01:00
50271edd8f add log_trace message while traversing input buffer 2024-06-27 22:56:58 +01:00
41bf1322ac add Interactive Mode section to README. 2024-06-27 22:07:53 +01:00
f88fb9b994 pass len of input to replace_multiple_space_with_one()
add an input prompt to interactive mode
2024-06-27 22:06:15 +01:00
9191a38745 readd comment 2024-06-27 19:20:21 +01:00
1d71f38d39 add utility function replace_multiple_space_with_one()
use it to parse the interactive input
2024-06-27 19:18:28 +01:00
2dda32ead9 up clean target 2024-06-27 10:28:09 +01:00
f60fdb4ed2 rename iVMR to vmr in vmr.c
update get() prototype. no need to return pointer.
2024-06-27 10:06:22 +01:00
6567c2c610 write error messages using log_error 2024-06-27 08:27:49 +01:00
41afc099dc sleep after, set to 50ms 2024-06-27 03:39:52 +01:00
7db10650fb do..while, sleep before first call to version() 2024-06-27 03:31:26 +01:00
06df144374 fix log_trace messages 2024-06-27 03:23:48 +01:00
16 changed files with 1309 additions and 1076 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 Onyx and Iris
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -1,4 +1,4 @@
# VMRCLI Command Line Utility
# Voicemeeter Remote Command Line Utility
## `Tested against`
@@ -12,42 +12,91 @@
## `Use`
`./vmrcli.exe [-i] [-k] [-D] <api commands>`
```powershell
.\vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
```
Where:
- `i`: Enable interactive mode. If set any api commands passed will be ignored.
- `h`: Prints the help message.
- `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.
- `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`
- Commands starting with `!` will be toggled, use it with boolean parameters.
- Commands containing `=` will set a value.
- Commands containing `=` will set a value. (use `+=` and `-=` to increment/decrement)
- All other commands with get a value.
Examples:
Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, then print its new value
Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, print its new value, then decrease Bus 0 Gain by 3.8
`./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute`
```powershell
.\vmrcli.exe -kbasic -D2 !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
`./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label`
```powershell
.\vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label
```
## `Interactive Mode`
Running the following command in Powershell:
```powershell
.\vmrcli.exe -i
```
Will open an interactive prompt:
```powershell
Interactive mode enabled. Enter 'Q' to exit.
>>
```
API commands follow the same rules as listed above. Entering `Q` or `q` will exit the program.
## `Script files`
Scripts can be loaded from text files, for example in Powershell:
```powershell
./vmrcli.exe -D1 $(Get-Content .\example_commands.txt)
.\vmrcli.exe -D1 $(Get-Content .\example_commands.txt)
```
You may also pipe a scripts contents to the CLI:
```powershell
$(Get-Content .\example_commands.txt) | .\vmrcli.exe -D1 -i
```
Multiple API commands can be in a single line, they may be delimited by space, `;` or `,`.
## `Build`
Run the included `makefile` with [GNU Make](https://www.gnu.org/software/make/).
The binary in [Releases][releases] is compiled with coloured logging enabled. To disable this you can override the `LOG_USE_COLOR` variable, for example:
`make LOG_USE_COLOR=no`
## `Official Documentation`
- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
- [Voicemeeter Remote C API][remoteapi-docs]
## `Special Thanks`
- [rxi](https://github.com/rxi) for writing the [log.c](https://github.com/rxi/log.c) package
- [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
[rxi-user]: https://github.com/rxi
[log-c]: https://github.com/rxi/log.c

View File

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

File diff suppressed because it is too large Load Diff

View File

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

15
include/ivmr.h Normal file
View File

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

15
include/util.h Normal file
View File

@@ -0,0 +1,15 @@
/**
* Copyright (c) 2024 Onyx and Iris
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MIT license. See `util.c` for details.
*/
#ifndef __UTIL_H__
#define __UTIL_H__
void remove_last_part_of_path(char *fullpath);
char *kind_as_string(char *s, int kind, int n);
char *version_as_string(char *s, long v, int n);
#endif /* __UTIL_H__ */

View File

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

46
include/wrapper.h Normal file
View File

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

View File

@@ -9,7 +9,12 @@ EXE := $(BIN_DIR)/$(program).exe
SRC := $(wildcard $(SRC_DIR)/*.c)
OBJ := $(SRC:$(SRC_DIR)/%.c=$(OBJ_DIR)/%.o)
CPPFLAGS := -Iinclude -MMD -MP
LOG_USE_COLOR ?= yes
ifeq ($(LOG_USE_COLOR), yes)
CPPFLAGS := -Iinclude -MMD -MP -DLOG_USE_COLOR
else
CPPFLAGS := -Iinclude -MMD -MP
endif
CFLAGS = -O -Wall -W -pedantic -ansi -std=c99
LDFLAGS := -Llib
LDLIBS := -lm
@@ -28,7 +33,6 @@ $(BIN_DIR) $(OBJ_DIR):
pwsh -Command New-Item -Path $@ -ItemType Directory
clean:
pwsh -Command Remove-Item -Recurse $(EXE)
pwsh -Command Remove-Item -Recurse $(OBJ_DIR)
pwsh -Command Remove-Item -Recurse $(EXE), $(OBJ_DIR)
-include $(OBJ:.o=.d)

View File

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

220
src/ivmr.c Normal file
View File

@@ -0,0 +1,220 @@
/**
* @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.6.0
* @date 2024-07-06
*
* @copyright Vincent Burel(c)2015-2021 All Rights Reserved
* https://github.com/vburel2018/Voicemeeter-SDK/blob/main/LICENSE
*
* Copyright (c) 2024 Onyx and Iris
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <stdbool.h>
#include <stdio.h>
#include <windows.h>
#include "ivmr.h"
#include "util.h"
#include "log.h"
static T_VBVMR_INTERFACE iVMR;
static long initialize_dll_interfaces(PT_VMR vmr);
static bool registry_get_voicemeeter_folder(char *szDir);
/**
* @brief Create an interface object
*
* @return PT_VMR Pointer to the iVMR interface
*/
PT_VMR create_interface()
{
PT_VMR vmr = &iVMR;
int rep;
rep = initialize_dll_interfaces(vmr);
if (rep < 0)
{
if (rep == -100)
{
log_fatal("Voicemeeter is not installed");
exit(EXIT_FAILURE);
}
else
{
log_fatal("Error loading Voicemeeter dll with code %d\n", rep);
exit(EXIT_FAILURE);
}
}
return vmr;
}
/*******************************************************************************/
/** GET DLL INTERFACE **/
/*******************************************************************************/
static long initialize_dll_interfaces(PT_VMR vmr)
{
HMODULE G_H_Module = NULL;
char szDllName[1024];
memset(vmr, 0, sizeof(T_VBVMR_INTERFACE));
// get Voicemeeter installation directory
if (!registry_get_voicemeeter_folder(szDllName))
{
// Voicemeeter not installed
return -100;
}
// use right dll according to O/S type
if (sizeof(void *) == 8)
strcat(szDllName, "\\VoicemeeterRemote64.dll");
else
strcat(szDllName, "\\VoicemeeterRemote.dll");
// Load Dll
G_H_Module = LoadLibrary(szDllName);
if (G_H_Module == NULL)
return -101;
// Get function pointers
vmr->VBVMR_Login = (T_VBVMR_Login)GetProcAddress(G_H_Module, "VBVMR_Login");
vmr->VBVMR_Logout = (T_VBVMR_Logout)GetProcAddress(G_H_Module, "VBVMR_Logout");
vmr->VBVMR_RunVoicemeeter = (T_VBVMR_RunVoicemeeter)GetProcAddress(G_H_Module, "VBVMR_RunVoicemeeter");
vmr->VBVMR_GetVoicemeeterType = (T_VBVMR_GetVoicemeeterType)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterType");
vmr->VBVMR_GetVoicemeeterVersion = (T_VBVMR_GetVoicemeeterVersion)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterVersion");
vmr->VBVMR_IsParametersDirty = (T_VBVMR_IsParametersDirty)GetProcAddress(G_H_Module, "VBVMR_IsParametersDirty");
vmr->VBVMR_GetParameterFloat = (T_VBVMR_GetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_GetParameterFloat");
vmr->VBVMR_GetParameterStringA = (T_VBVMR_GetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringA");
vmr->VBVMR_GetParameterStringW = (T_VBVMR_GetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringW");
vmr->VBVMR_GetLevel = (T_VBVMR_GetLevel)GetProcAddress(G_H_Module, "VBVMR_GetLevel");
vmr->VBVMR_GetMidiMessage = (T_VBVMR_GetMidiMessage)GetProcAddress(G_H_Module, "VBVMR_GetMidiMessage");
vmr->VBVMR_SetParameterFloat = (T_VBVMR_SetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_SetParameterFloat");
vmr->VBVMR_SetParameters = (T_VBVMR_SetParameters)GetProcAddress(G_H_Module, "VBVMR_SetParameters");
vmr->VBVMR_SetParametersW = (T_VBVMR_SetParametersW)GetProcAddress(G_H_Module, "VBVMR_SetParametersW");
vmr->VBVMR_SetParameterStringA = (T_VBVMR_SetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringA");
vmr->VBVMR_SetParameterStringW = (T_VBVMR_SetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringW");
vmr->VBVMR_Output_GetDeviceNumber = (T_VBVMR_Output_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceNumber");
vmr->VBVMR_Output_GetDeviceDescA = (T_VBVMR_Output_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescA");
vmr->VBVMR_Output_GetDeviceDescW = (T_VBVMR_Output_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescW");
vmr->VBVMR_Input_GetDeviceNumber = (T_VBVMR_Input_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceNumber");
vmr->VBVMR_Input_GetDeviceDescA = (T_VBVMR_Input_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescA");
vmr->VBVMR_Input_GetDeviceDescW = (T_VBVMR_Input_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescW");
vmr->VBVMR_MacroButton_IsDirty = (T_VBVMR_MacroButton_IsDirty)GetProcAddress(G_H_Module, "VBVMR_MacroButton_IsDirty");
vmr->VBVMR_MacroButton_GetStatus = (T_VBVMR_MacroButton_GetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_GetStatus");
vmr->VBVMR_MacroButton_SetStatus = (T_VBVMR_MacroButton_SetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_SetStatus");
// check pointers are valid
if (vmr->VBVMR_Login == NULL)
return -1;
if (vmr->VBVMR_Logout == NULL)
return -2;
if (vmr->VBVMR_RunVoicemeeter == NULL)
return -2;
if (vmr->VBVMR_GetVoicemeeterType == NULL)
return -3;
if (vmr->VBVMR_GetVoicemeeterVersion == NULL)
return -4;
if (vmr->VBVMR_IsParametersDirty == NULL)
return -5;
if (vmr->VBVMR_GetParameterFloat == NULL)
return -6;
if (vmr->VBVMR_GetParameterStringA == NULL)
return -7;
if (vmr->VBVMR_GetParameterStringW == NULL)
return -8;
if (vmr->VBVMR_GetLevel == NULL)
return -9;
if (vmr->VBVMR_SetParameterFloat == NULL)
return -10;
if (vmr->VBVMR_SetParameters == NULL)
return -11;
if (vmr->VBVMR_SetParametersW == NULL)
return -12;
if (vmr->VBVMR_SetParameterStringA == NULL)
return -13;
if (vmr->VBVMR_SetParameterStringW == NULL)
return -14;
if (vmr->VBVMR_GetMidiMessage == NULL)
return -15;
if (vmr->VBVMR_Output_GetDeviceNumber == NULL)
return -30;
if (vmr->VBVMR_Output_GetDeviceDescA == NULL)
return -31;
if (vmr->VBVMR_Output_GetDeviceDescW == NULL)
return -32;
if (vmr->VBVMR_Input_GetDeviceNumber == NULL)
return -33;
if (vmr->VBVMR_Input_GetDeviceDescA == NULL)
return -34;
if (vmr->VBVMR_Input_GetDeviceDescW == NULL)
return -35;
if (vmr->VBVMR_MacroButton_IsDirty == NULL)
return -36;
if (vmr->VBVMR_MacroButton_GetStatus == NULL)
return -37;
if (vmr->VBVMR_MacroButton_SetStatus == NULL)
return -38;
return 0;
}
/*******************************************************************************/
/** GET VOICEMEETER DIRECTORY **/
/*******************************************************************************/
#define INSTALLER_UNINST_KEY "VB:Voicemeeter {17359A74-1236-5467}"
#ifndef KEY_WOW64_32KEY
#define KEY_WOW64_32KEY 0x0200
#endif
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
strcpy(szKey, uninstDirKey);
strcat(szKey, "\\");
strcat(szKey, INSTALLER_UNINST_KEY);
// open key
rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKey, 0, KEY_READ, &hkResult);
if (rep != ERROR_SUCCESS)
{
// if not present we consider running in 64bit mode and force to read 32bit registry
rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKey, 0, KEY_READ | KEY_WOW64_32KEY, &hkResult);
}
if (rep != ERROR_SUCCESS)
return false;
// read uninstall path from registry
rep = RegQueryValueEx(hkResult, "UninstallString", 0, &pptype, (unsigned char *)sss, &nnsize);
RegCloseKey(hkResult);
if (pptype != REG_SZ)
return false;
if (rep != ERROR_SUCCESS)
return false;
// remove name to get the path only
remove_last_part_of_path(sss);
if (nnsize > 512)
nnsize = 512;
strncpy(szDir, sss, nnsize);
return true;
}

72
src/util.c Normal file
View File

@@ -0,0 +1,72 @@
/**
* @file util.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Utility functions.
* @version 0.6.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <stddef.h>
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include "wrapper.h"
#include "util.h"
/**
* @brief Removes the last part of a path
*
* @param fullpath The entire path
*/
void remove_last_part_of_path(char *fullpath)
{
char *p;
if ((p = strrchr(fullpath, '\\')) != NULL)
{
*p = '\0';
}
}
/**
* @brief Converts Voicemeeter's kind into a string.
*
* @param s Pointer to a character buffer
* @param kind The kind of Voicemeeter.
* @param n Maximum number of characters to be written to the buffer
* @return char* String representation of the kind of Voicemeeter.
*/
char *kind_as_string(char *s, int kind, int n)
{
static const char *kinds[] = {
"Basic",
"Banana",
"Potato",
"Basic x64",
"Banana x64",
"Potato x64",
};
snprintf(s, n, kinds[kind - 1]);
return s;
}
/**
* @brief Converts Voicemeeter's version into a string.
*
* @param s Pointer to a character buffer
* @param v Unprocessed version as a long int
* @param n Maximum number of characters to be written to the buffer
* @return char* String representation of the Voicemeeter version
*/
char *version_as_string(char *s, long v, int n)
{
long v1 = (v & 0xFF000000) >> 24,
v2 = (v & 0x00FF0000) >> 16,
v3 = (v & 0x0000FF00) >> 8,
v4 = (v & 0x000000FF);
snprintf(s, n, "%i.%i.%i.%i", (int)v1, (int)v2, (int)v3, (int)v4);
return s;
}

143
src/vmr.c
View File

@@ -1,143 +0,0 @@
#include <windows.h>
#include <stdio.h>
#include <time.h>
#include "vmr.h"
#include "log.h"
long login(T_VBVMR_INTERFACE *iVMR, int kind)
{
int rep;
long v;
rep = iVMR->VBVMR_Login();
Sleep(20);
if (rep == 1)
{
run_voicemeeter(iVMR, kind);
switch (kind)
{
case BASIC:
log_info("Launching Voicemeeter Basic GUI");
break;
case BANANA:
log_info("Launching Voicemeeter Banana GUI");
break;
case POTATO:
log_info("Launching Voicemeeter Potato GUI");
break;
case POTATOX64:
log_info("Launching Voicemeeter Potato x64 GUI");
break;
}
time_t endwait;
int timeout = 2;
endwait = time(NULL) + timeout;
while (time(NULL) < endwait)
{
if ((rep = version(iVMR, &v)) == 0)
break;
Sleep(20);
}
}
if (rep == 0)
{
version(iVMR, &v);
long v1 = (v & 0xFF000000) >> 24,
v2 = (v & 0x00FF0000) >> 16,
v3 = (v & 0x0000FF00) >> 8,
v4 = (v & 0x000000FF);
char version_s[128];
sprintf(version_s, "%i.%i.%i.%i", (int)v1, (int)v2, (int)v3, (int)v4);
log_info("Successfully logged into the Voicemeeter API v%s", version_s);
clear_dirty(iVMR);
}
return rep;
}
long logout(T_VBVMR_INTERFACE *iVMR)
{
int rep;
Sleep(20); /* give time for last command */
rep = iVMR->VBVMR_Logout();
if (rep == 0)
log_info("Successfully logged out of the Voicemeeter API");
return rep;
}
long run_voicemeeter(T_VBVMR_INTERFACE *iVMR, int kind)
{
log_trace("VBVMR_RunVoicemeeter(%d)", kind);
return iVMR->VBVMR_RunVoicemeeter((long)kind);
}
long type(T_VBVMR_INTERFACE *iVMR, long *type)
{
return iVMR->VBVMR_GetVoicemeeterType(type);
}
long version(T_VBVMR_INTERFACE *iVMR, long *version)
{
log_trace("VBVMR_GetVoicemeeterType(<long> *v)");
return iVMR->VBVMR_GetVoicemeeterVersion(version);
}
bool is_pdirty(T_VBVMR_INTERFACE *iVMR)
{
log_trace("VBVMR_IsParametersDirty()");
return iVMR->VBVMR_IsParametersDirty() == 1;
}
long get_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float *f)
{
log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param, f);
return iVMR->VBVMR_GetParameterFloat(param, f);
}
long get_parameter_string(T_VBVMR_INTERFACE *iVMR, char *param, char *s)
{
log_trace("VBVMR_GetParameterStringA(%s, <char> *s)", param, s);
return iVMR->VBVMR_GetParameterStringA(param, s);
}
long set_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float val)
{
log_trace("VBVMR_SetParameterFloat(%s, %.2f)", param, val);
return iVMR->VBVMR_SetParameterFloat(param, val);
}
long set_parameter_string(T_VBVMR_INTERFACE *iVMR, char *param, char *s)
{
log_trace("VBVMR_SetParameterStringA(%s, %s)", param, s);
return iVMR->VBVMR_SetParameterStringA(param, s);
}
long set_parameters(T_VBVMR_INTERFACE *iVMR, char *command)
{
log_trace("VBVMR_SetParameters(%s)", command);
return iVMR->VBVMR_SetParameters(command);
}
bool is_mdirty(T_VBVMR_INTERFACE *iVMR)
{
return iVMR->VBVMR_MacroButton_IsDirty() == 1;
}
long macrobutton_getstatus(T_VBVMR_INTERFACE *iVMR, long n, float *val, long mode)
{
return iVMR->VBVMR_MacroButton_GetStatus(n, val, mode);
}
long macrobutton_setstatus(T_VBVMR_INTERFACE *iVMR, long n, float val, long mode)
{
return iVMR->VBVMR_MacroButton_SetStatus(n, val, mode);
}
void clear_dirty(T_VBVMR_INTERFACE *iVMR)
{
Sleep(30);
while (is_pdirty(iVMR))
Sleep(1);
}

View File

@@ -1,43 +1,69 @@
/**
* @file vmrcli.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief A Voicemeeter Remote Command Line Interface
* @version 0.6.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <getopt.h>
#include "cdll.h"
#include "vmr.h"
#include <string.h>
#include <ctype.h>
#include <windows.h>
#include "ivmr.h"
#include "wrapper.h"
#include "log.h"
#include "util.h"
#define MAX_LINE 512
/**
* @enum The kind of values a get call may return.
*/
enum
{
FLOAT_T,
STRING_T,
};
/**
* @struct A struct holding the result of a get call.
*/
struct result
{
int type;
union val
{
float f;
char s[MAX_LINE];
wchar_t s[MAX_LINE];
} val;
};
static bool vflag = false;
void help(void);
int set_kind(char *kval);
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
void interactive(T_VBVMR_INTERFACE *vmr);
void parse_command(T_VBVMR_INTERFACE *vmr, char *command);
struct result *get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res);
enum kind set_kind(char *kval);
void interactive(PT_VMR vmr);
void parse_input(PT_VMR vmr, char *input);
void parse_command(PT_VMR vmr, char *command);
void get(PT_VMR vmr, char *command, struct result *res);
int main(int argc, char *argv[])
{
bool iflag = false;
bool iflag = false,
mflag = false,
sflag = false,
cflag = false;
int opt;
char *kvalue = "";
int dvalue;
int kind = BANANA;
char *cvalue;
enum kind kind = BANANAX64;
if (argc == 1)
{
@@ -47,20 +73,34 @@ int main(int argc, char *argv[])
log_set_level(LOG_WARN);
while ((opt = getopt(argc, argv, "k:ihD:")) != -1)
while ((opt = getopt(argc, argv, "hk:msc:iD:v")) != -1)
{
switch (opt)
{
case 'i':
iflag = true;
break;
case 'k':
kvalue = optarg;
kind = set_kind(kvalue);
break;
case 'h':
help();
exit(EXIT_SUCCESS);
case 'k':
kind = set_kind(optarg);
if (kind == UNKNOWN)
{
log_fatal("Unknown Voicemeeter kind '%s'", optarg);
exit(EXIT_FAILURE);
}
break;
case 'm':
mflag = true;
break;
case 's':
sflag = true;
break;
case 'c':
cflag = true;
cvalue = optarg;
break;
case 'i':
iflag = true;
break;
case 'D':
dvalue = atoi(optarg);
if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
@@ -69,26 +109,48 @@ int main(int argc, char *argv[])
}
else
{
fputs(
log_warn(
"-D arg out of range, expected value from 0 up to 5\n"
"Log level will default to LOG_WARN (3).\n",
stderr);
"Log level will default to LOG_WARN (3).\n");
}
break;
case 'v':
vflag = true;
break;
default:
abort();
}
}
T_VBVMR_INTERFACE iVMR;
T_VBVMR_INTERFACE *vmr = &iVMR;
PT_VMR vmr = create_interface();
int rep = init_voicemeeter(vmr, kind);
int rep = login(vmr, kind);
if (rep != 0)
{
log_fatal("Error logging into the Voicemeeter API");
exit(EXIT_FAILURE);
}
if (mflag)
{
log_info("MacroButtons app launched");
run_voicemeeter(vmr, MACROBUTTONS);
}
if (sflag)
{
log_info("StreamerView app launched");
run_voicemeeter(vmr, STREAMERVIEW);
}
if (cflag)
{
log_info("Profile %s loaded", cvalue);
set_parameter_string(vmr, "command.load", cvalue);
Sleep(300);
clear_dirty(vmr);
}
if (iflag)
{
puts("Interactive mode enabled. Enter 'Q' to exit.");
@@ -98,36 +160,62 @@ int main(int argc, char *argv[])
{
for (int i = optind; i < argc; i++)
{
parse_command(vmr, argv[i]);
parse_input(vmr, argv[i]);
}
}
rep = logout(vmr);
if (rep == 0)
{
return EXIT_SUCCESS;
}
else
{
log_fatal("Error logging out of the Voicemeeter API");
return EXIT_FAILURE;
}
}
/**
* @brief prints the help message
*/
void help()
{
puts(
"Usage: ./vmrcli.exe [-i] [-k] [-D] <api commands>\n"
"Usage: .\\vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n"
"Where: \n"
"\th: Prints the help message\n"
"\ti: Enable interactive mode\n"
"\tk: The kind of Voicemeeter (basic, banana, potato)\n"
"\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL");
"\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");
}
int set_kind(char *kval)
/**
* @brief Set the kind of Voicemeeter based on the value of -k flag.
* For 64 bit systems the value is promoted to X64.
*
* @param kval Value of the -k flag
* @return enum kind
*/
enum kind set_kind(char *kval)
{
if (strcmp(kval, "basic") == 0)
{
return BASIC;
if (sizeof(void *) == 8)
return BASICX64;
else
return BASIC;
}
else if (strcmp(kval, "banana") == 0)
{
return BANANA;
if (sizeof(void *) == 8)
return BANANAX64;
else
return BANANA;
}
else if (strcmp(kval, "potato") == 0)
{
@@ -138,66 +226,63 @@ int set_kind(char *kval)
}
else
{
fprintf(stderr, "Unknown Voicemeeter kind '%s'\n", kval);
exit(EXIT_FAILURE);
return UNKNOWN;
}
}
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
{
int rep = initialize_dll_interfaces(vmr);
if (rep < 0)
{
if (rep == -100)
{
fputs("Voicemeeter is not installed", stderr);
}
else
{
fprintf(stderr, "Error loading Voicemeeter dll with code %d\n", rep);
}
return rep;
}
rep = login(vmr, kind);
if (rep != 0)
{
fputs("Error logging into Voicemeeter", stderr);
return rep;
}
return 0;
}
void interactive(T_VBVMR_INTERFACE *vmr)
/**
* @brief Continuously read lines from stdin.
* Break if 'Q' is entered on the interactive prompt.
* Each line is passed to parse_input()
*
* @param vmr Pointer to the iVMR interface
*/
void interactive(PT_VMR vmr)
{
char input[MAX_LINE];
char *p = input;
printf(">> ");
while (fgets(input, MAX_LINE, stdin) != NULL)
{
input[strcspn(input, "\n")] = 0;
if (strlen(input) == 1 && (strncmp(input, "Q", 1) == 0 || strncmp(input, "q", 1) == 0))
if (strlen(input) == 1 && toupper(input[0]) == 'Q')
break;
while (*p)
{
char command[MAX_LINE];
int i = 0;
parse_input(vmr, input);
while (!isspace(*p))
command[i++] = *p++;
command[i] = '\0';
p++; /* shift to next char */
parse_command(vmr, command);
}
p = input; /* reset pointer */
memset(input, 0, MAX_LINE); /* reset input buffer */
printf(">> ");
}
}
void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
/**
* @brief 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
*/
void parse_input(PT_VMR vmr, char *input)
{
char *token, *p;
token = strtok_r(input, " \t;,", &p);
while (token != NULL)
{
parse_command(vmr, token);
token = strtok_r(NULL, " \t;,", &p);
}
}
/**
* @brief Execute each command according to type.
* See command type definitions in:
* https://github.com/onyx-and-iris/vmrcli?tab=readme-ov-file#api-commands
*
* @param vmr Pointer to the iVMR interface
* @param command Each token from the input line as its own command string
*/
void parse_command(PT_VMR vmr, char *command)
{
log_debug("Parsing %s", command);
@@ -209,7 +294,16 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
get(vmr, command, &res);
if (res.type == FLOAT_T)
{
set_parameter_float(vmr, command, 1 - res.val.f);
if (res.val.f == 1 || res.val.f == 0)
{
set_parameter_float(vmr, command, 1 - res.val.f);
if (vflag)
{
printf("Toggling %s\n", command);
}
}
else
log_warn("%s does not appear to be a boolean parameter", command);
}
return;
}
@@ -217,6 +311,10 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
if (strchr(command, '=') != NULL) /* set */
{
set_parameters(vmr, command);
if (vflag)
{
printf("Setting %s\n", command);
}
}
else /* get */
{
@@ -226,19 +324,27 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
switch (res.type)
{
case FLOAT_T:
printf("%.1f\n", res.val.f);
printf("%s: %.1f\n", command, res.val.f);
break;
case STRING_T:
puts(res.val.s);
if (res.val.s[0] != '\0')
printf("%s: %ls\n", command, res.val.s);
break;
default:
fputs("Unexpected result type", stderr);
break;
}
}
}
struct result *get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
/**
* @brief Get the value of a float or string parameter.
* Stores its type and value into a result struct
*
* @param vmr Pointer to the iVMR interface
* @param command A parsed 'get' command as a string
* @param res A struct holding the result of the API call.
*/
void get(PT_VMR vmr, char *command, struct result *res)
{
clear_dirty(vmr);
if (get_parameter_float(vmr, command, &res->val.f) != 0)
@@ -247,9 +353,7 @@ struct result *get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
if (get_parameter_string(vmr, command, res->val.s) != 0)
{
res->val.s[0] = 0;
fputs("Unknown parameter", stderr);
log_error("Unknown parameter '%s'", command);
}
}
return res;
}

165
src/wrapper.c Normal file
View File

@@ -0,0 +1,165 @@
/**
* @file wrapper.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Provides public functions that wrap the iVMR calls
* @version 0.6.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <windows.h>
#include <stdio.h>
#include <time.h>
#include "wrapper.h"
#include "log.h"
#include "util.h"
#define KIND_STR_LEN 64
#define VERSION_STR_LEN 32
/**
* @brief Logs into the API.
* Tests for valid connection for up to 2 seconds.
* If successful initializes the dirty parameters.
*
* @param vmr Pointer to the iVMR interface
* @param kind The kind of Voicemeeter Gui to launch.
* @return long VBVMR_Login return value
*/
long login(PT_VMR vmr, int kind)
{
int rep;
long v;
log_trace("VBVMR_Login()");
rep = vmr->VBVMR_Login();
if (rep == 1)
{
run_voicemeeter(vmr, kind);
char kind_s[KIND_STR_LEN];
log_info(
"Launching Voicemeeter %s GUI",
kind_as_string(kind_s, kind, KIND_STR_LEN));
}
int timeout = 2;
time_t start = time(NULL);
do
{
if ((rep = version(vmr, &v)) == 0)
{
char version_s[VERSION_STR_LEN];
log_info(
"Successfully logged into the Voicemeeter API v%s",
version_as_string(version_s, v, VERSION_STR_LEN));
break;
}
Sleep(50);
} while (time(NULL) < start + timeout);
if (rep == 0)
{
clear_dirty(vmr);
}
return rep;
}
/**
* @brief Logs out of the API giving a short wait to allow a
* final instruction to complete.
*
* @param vmr Pointer to the iVMR interface
* @return long VBVMR_Logout return value
*/
long logout(PT_VMR vmr)
{
int rep;
Sleep(20); /* give time for last command */
log_trace("VBVMR_Logout()");
rep = vmr->VBVMR_Logout();
if (rep == 0)
log_info("Successfully logged out of the Voicemeeter API");
return rep;
}
long run_voicemeeter(PT_VMR vmr, int kind)
{
log_trace("VBVMR_RunVoicemeeter(%d)", kind);
return vmr->VBVMR_RunVoicemeeter((long)kind);
}
long type(PT_VMR vmr, long *type)
{
log_trace("VBVMR_GetVoicemeeterType(<long> *t)");
return vmr->VBVMR_GetVoicemeeterType(type);
}
long version(PT_VMR vmr, long *version)
{
log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)");
return vmr->VBVMR_GetVoicemeeterVersion(version);
}
bool is_pdirty(PT_VMR vmr)
{
log_trace("VBVMR_IsParametersDirty()");
return vmr->VBVMR_IsParametersDirty() == 1;
}
long get_parameter_float(PT_VMR vmr, char *param, float *f)
{
log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param);
return vmr->VBVMR_GetParameterFloat(param, f);
}
long get_parameter_string(PT_VMR vmr, char *param, unsigned short *s)
{
log_trace("VBVMR_GetParameterStringW(%s, <unsigned short> *s)", param);
return vmr->VBVMR_GetParameterStringW(param, s);
}
long set_parameter_float(PT_VMR vmr, char *param, float val)
{
log_trace("VBVMR_SetParameterFloat(%s, %.1f)", param, val);
return vmr->VBVMR_SetParameterFloat(param, val);
}
long set_parameter_string(PT_VMR vmr, char *param, char *s)
{
log_trace("VBVMR_SetParameterStringA(%s, %s)", param, s);
return vmr->VBVMR_SetParameterStringA(param, s);
}
long set_parameters(PT_VMR vmr, char *command)
{
log_trace("VBVMR_SetParameters(%s)", command);
return vmr->VBVMR_SetParameters(command);
}
bool is_mdirty(PT_VMR vmr)
{
log_trace("VBVMR_MacroButton_IsDirty()");
return vmr->VBVMR_MacroButton_IsDirty() == 1;
}
long macrobutton_getstatus(PT_VMR vmr, long n, float *val, long mode)
{
log_trace("VBVMR_MacroButton_GetStatus(%ld, <float> *v, %ld)", n, mode);
return vmr->VBVMR_MacroButton_GetStatus(n, val, mode);
}
long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode)
{
log_trace("VBVMR_MacroButton_SetStatus(%ld, %d, %ld)", n, (int)val, mode);
return vmr->VBVMR_MacroButton_SetStatus(n, val, mode);
}
void clear_dirty(PT_VMR vmr)
{
Sleep(30);
while (is_pdirty(vmr))
Sleep(1);
}