50 Commits

Author SHA1 Message Date
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
35ec276979 add login timeout
print the API version to info string
2024-06-27 02:51:27 +01:00
744f0d64df print float values to 1 dp 2024-06-27 02:00:17 +01:00
760924def8 upd README 2024-06-27 01:18:25 +01:00
7b7d4fc2c7 add log trace messages to vmr.c 2024-06-27 01:18:17 +01:00
0b6e0800ce default log level to LOG_WARN
write message to stderr if -D flag out of range
2024-06-27 01:17:59 +01:00
4488a386b8 move includes into header guards 2024-06-27 01:17:09 +01:00
9863ca6dca remove EOF check 2024-06-26 20:17:33 +01:00
cd11b26ad8 add -D flag to help() output 2024-06-26 19:31:08 +01:00
71e06ac646 fix script files example 2024-06-26 19:03:21 +01:00
050a4d9e60 add link to api documentation 2024-06-26 18:37:52 +01:00
694a4dbc65 add ./ 2024-06-26 18:34:05 +01:00
3f8ed17176 reword 2024-06-26 18:30:47 +01:00
11 changed files with 473 additions and 152 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,38 +12,84 @@
## `Use`
`./vmrcli.exe [-i] [-k] [-D] <api commands>`
```powershell
./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-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)
- `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 debug 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 debug level to DEBUG, set Strip 0 label to podmic then print Strip 2 label
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:
Scripts can be loaded from text files, for example in Powershell:
```powershell
./vbantxt-cli -D1 $(Get-Content .\example_commands.txt)
./vmrcli.exe -D1 $(Get-Content .\example_commands.txt)
```
Multiple API commands can be in a single line but they should be space separated.
## `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][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

View File

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

9
include/util.h Normal file
View File

@@ -0,0 +1,9 @@
#ifndef __UTIL_H__
#define __UTIL_H__
void remove_name_in_path(char *szPath);
int replace_multiple_space_with_one(char *s, size_t len);
char *kind_as_string(char *s, enum kind kind, int n);
char *version_as_string(char *, long v, int n);
#endif /* __UTIL_H__ */

View File

@@ -1,34 +1,38 @@
#include <stdbool.h>
#include "voicemeeterRemote.h"
#ifndef __VMR_H__
#define __VMR_H__
#include <stdbool.h>
#include "voicemeeterRemote.h"
enum kind
{
BASIC = 1,
BANANA,
POTATO,
POTATOX64 = 6
BASICX64,
BANANAX64,
POTATOX64,
MACROBUTTONS = 11,
STREAMERVIEW
};
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);
long login(T_VBVMR_INTERFACE *vmr, int kind);
long logout(T_VBVMR_INTERFACE *vmr);
long run_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
long type(T_VBVMR_INTERFACE *vmr, long *type);
long version(T_VBVMR_INTERFACE *vmr, long *version);
bool is_pdirty(T_VBVMR_INTERFACE *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_pdirty(T_VBVMR_INTERFACE *vmr);
long get_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float *f);
long get_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, unsigned short *s);
long set_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float val);
long set_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, char *s);
long set_parameters(T_VBVMR_INTERFACE *vmr, char *command);
bool is_mdirty(T_VBVMR_INTERFACE *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);
bool is_mdirty(T_VBVMR_INTERFACE *vmr);
long macrobutton_getstatus(T_VBVMR_INTERFACE *vmr, long n, float *val, long mode);
long macrobutton_setstatus(T_VBVMR_INTERFACE *vmr, long n, float val, long mode);
void clear_dirty(T_VBVMR_INTERFACE *iVMR);
void clear_dirty(T_VBVMR_INTERFACE *vmr);
#endif
#endif /* __VMR_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,6 +1,7 @@
#include <stdbool.h>
#include <stdio.h>
#include "cdll.h"
#include "util.h"
/*******************************************************************************/
/** GET VOICEMEETER DIRECTORY **/
@@ -12,18 +13,6 @@
#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];

103
src/util.c Normal file
View File

@@ -0,0 +1,103 @@
#include <stddef.h>
#include <stdio.h>
#include "vmr.h"
#include "util.h"
/**
* @brief Removes the last part of a path
*
* @param szPath
*/
void remove_name_in_path(char *szPath)
{
char *p = szPath;
while (*p++)
;
while (p > szPath && *p != '\\')
p--;
if (*p == '\\')
*p = '\0';
}
/**
* @brief replaces multiple newlines and tabs with single spaces
*
* @param s the string to be reduced
* @param len current length of the string
* @return int new length of the string
*/
int replace_multiple_space_with_one(char *s, size_t len)
{
int j = 0;
int count = 0;
if (len == 1 && (s[0] == ' ' || s[0] == '\t'))
{
s[0] = '\0';
return len;
}
if (len < 2)
return len;
for (int i = 0; s[i] != '\0'; i++)
{
if (s[i] == ' ' || s[i] == '\t')
{
count++;
}
if (s[i] != ' ' && s[i] != '\t')
{
if (count >= 1)
{
count = 0;
s[j++] = ' ';
}
s[j++] = s[i];
}
}
s[j] = '\0';
return j;
}
/**
* @brief
*
* @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* The kind of Voicemeeter as a string
*/
char *kind_as_string(char *s, enum kind kind, int n)
{
char *kinds[] = {
"Basic",
"Banana",
"Potato",
"Basic x64",
"Banana x64",
"Potato x64",
};
snprintf(s, n, kinds[kind - 1]);
return s;
}
/**
* @brief returns Voicemeeter's version as a string
*
* @param s string buffer the version will be written to
* @param v unprocessed version as a long int
* @param n maximum number of characters to be written to the buffer
* @return char*
*/
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;
}

130
src/vmr.c
View File

@@ -1,117 +1,149 @@
#include <windows.h>
#include <stdio.h>
#include <time.h>
#include "vmr.h"
#include "log.h"
#include "util.h"
long login(T_VBVMR_INTERFACE *iVMR, int kind)
#define VERSION_STR_LEN 128
#define KIND_STR_LEN 64
/**
* @brief Logs into the API.
* Tests for valid connection for up to 2 seconds.
* If successful initializes the dirty parameters.
*
* @param vmr
* @param kind
* @return long
*/
long login(T_VBVMR_INTERFACE *vmr, int kind)
{
int rep;
long v;
rep = iVMR->VBVMR_Login();
Sleep(20);
rep = vmr->VBVMR_Login();
if (rep == 1)
{
rep = 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;
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));
}
Sleep(1200);
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)
{
log_info("Successfully logged into the Voicemeeter API");
clear_dirty(iVMR);
clear_dirty(vmr);
}
return rep;
}
long logout(T_VBVMR_INTERFACE *iVMR)
/**
* @brief Logs out of the API giving a short wait to allow a
* final instruction to complete.
*
* @param vmr The API interface as a struct
* @return long VBVMR_Logout return value
*/
long logout(T_VBVMR_INTERFACE *vmr)
{
int rep;
Sleep(20); /* give time for last command */
rep = iVMR->VBVMR_Logout();
rep = vmr->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)
long run_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
{
return iVMR->VBVMR_RunVoicemeeter((long)kind);
log_trace("VBVMR_RunVoicemeeter(%d)", kind);
return vmr->VBVMR_RunVoicemeeter((long)kind);
}
long type(T_VBVMR_INTERFACE *iVMR, long *type)
long type(T_VBVMR_INTERFACE *vmr, long *type)
{
return iVMR->VBVMR_GetVoicemeeterType(type);
log_trace("VBVMR_GetVoicemeeterType(<long> *t)");
return vmr->VBVMR_GetVoicemeeterType(type);
}
long version(T_VBVMR_INTERFACE *iVMR, long *version)
long version(T_VBVMR_INTERFACE *vmr, long *version)
{
return iVMR->VBVMR_GetVoicemeeterType(version);
log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)");
return vmr->VBVMR_GetVoicemeeterVersion(version);
}
bool is_pdirty(T_VBVMR_INTERFACE *iVMR)
bool is_pdirty(T_VBVMR_INTERFACE *vmr)
{
return iVMR->VBVMR_IsParametersDirty() == 1;
log_trace("VBVMR_IsParametersDirty()");
return vmr->VBVMR_IsParametersDirty() == 1;
}
long get_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float *f)
long get_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float *f)
{
return iVMR->VBVMR_GetParameterFloat(param, f);
log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param);
return vmr->VBVMR_GetParameterFloat(param, f);
}
long get_parameter_string(T_VBVMR_INTERFACE *iVMR, char *param, char *s)
long get_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, unsigned short *s)
{
return iVMR->VBVMR_GetParameterStringA(param, s);
log_trace("VBVMR_GetParameterStringW(%s, <unsigned short> *s)", param);
return vmr->VBVMR_GetParameterStringW(param, s);
}
long set_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float val)
long set_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float val)
{
return iVMR->VBVMR_SetParameterFloat(param, val);
log_trace("VBVMR_SetParameterFloat(%s, %.1f)", param, val);
return vmr->VBVMR_SetParameterFloat(param, val);
}
long set_parameter_string(T_VBVMR_INTERFACE *iVMR, char *param, char *s)
long set_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, char *s)
{
return iVMR->VBVMR_SetParameterStringA(param, s);
log_trace("VBVMR_SetParameterStringA(%s, %s)", param, s);
return vmr->VBVMR_SetParameterStringA(param, s);
}
long set_parameters(T_VBVMR_INTERFACE *iVMR, char *command)
long set_parameters(T_VBVMR_INTERFACE *vmr, char *command)
{
return iVMR->VBVMR_SetParameters(command);
log_trace("VBVMR_SetParameters(%s)", command);
return vmr->VBVMR_SetParameters(command);
}
bool is_mdirty(T_VBVMR_INTERFACE *iVMR)
bool is_mdirty(T_VBVMR_INTERFACE *vmr)
{
return iVMR->VBVMR_MacroButton_IsDirty() == 1;
return vmr->VBVMR_MacroButton_IsDirty() == 1;
}
long macrobutton_getstatus(T_VBVMR_INTERFACE *iVMR, long n, float *val, long mode)
long macrobutton_getstatus(T_VBVMR_INTERFACE *vmr, long n, float *val, long mode)
{
return iVMR->VBVMR_MacroButton_GetStatus(n, val, mode);
return vmr->VBVMR_MacroButton_GetStatus(n, val, mode);
}
long macrobutton_setstatus(T_VBVMR_INTERFACE *iVMR, long n, float val, long mode)
long macrobutton_setstatus(T_VBVMR_INTERFACE *vmr, long n, float val, long mode)
{
return iVMR->VBVMR_MacroButton_SetStatus(n, val, mode);
return vmr->VBVMR_MacroButton_SetStatus(n, val, mode);
}
void clear_dirty(T_VBVMR_INTERFACE *iVMR)
void clear_dirty(T_VBVMR_INTERFACE *vmr)
{
Sleep(30);
while (is_pdirty(iVMR))
while (is_pdirty(vmr))
Sleep(1);
}

View File

@@ -5,67 +5,98 @@
#include "cdll.h"
#include "vmr.h"
#include "log.h"
#include "util.h"
#define MAX_LINE 512
/**
* @brief An enum used to define the kind of value
* a 'get' call returns.
*
*/
enum
{
FLOAT_T,
STRING_T,
};
/**
* @brief 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;
};
void help(void);
int set_kind(char *kval);
enum kind set_kind(char *kval);
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
void interactive(T_VBVMR_INTERFACE *vmr);
void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len);
void parse_command(T_VBVMR_INTERFACE *vmr, char *command);
struct result *get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res);
void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res);
bool vflag = false;
int main(int argc, char *argv[])
{
bool iflag = false;
bool mflag = false;
bool sflag = false;
int opt;
char *kvalue = "";
int dvalue;
int kind = BANANA;
enum kind kind = BANANAX64;
if (argc == 1)
{
help();
return EXIT_SUCCESS;
exit(EXIT_SUCCESS);
}
log_set_level(LOG_INFO);
log_set_level(LOG_WARN);
while ((opt = getopt(argc, argv, "k:ihD:")) != -1)
while ((opt = getopt(argc, argv, "hk:msiD:v")) != -1)
{
switch (opt)
{
case 'i':
iflag = true;
break;
case 'h':
help();
exit(EXIT_SUCCESS);
case 'k':
kvalue = optarg;
kind = set_kind(kvalue);
break;
case 'h':
help();
exit(EXIT_SUCCESS);
case 'm':
mflag = true;
break;
case 's':
sflag = true;
break;
case 'i':
iflag = true;
break;
case 'D':
if ((dvalue = atoi(optarg)) && dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
dvalue = atoi(optarg);
if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
{
log_set_level(dvalue);
}
else
{
log_error(
"-D arg out of range, expected value from 0 up to 5\n"
"Log level will default to LOG_WARN (3).\n");
}
break;
case 'v':
vflag = true;
break;
default:
abort();
@@ -81,6 +112,18 @@ int main(int argc, char *argv[])
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 (iflag)
{
puts("Interactive mode enabled. Enter 'Q' to exit.");
@@ -90,7 +133,7 @@ int main(int argc, char *argv[])
{
for (int i = optind; i < argc; i++)
{
parse_command(vmr, argv[i]);
parse_input(vmr, argv[i], strlen(argv[i]));
}
}
@@ -101,24 +144,44 @@ int main(int argc, char *argv[])
return EXIT_FAILURE;
}
/**
* @brief prints the help message
*
*/
void help()
{
puts(
"Usage: ./vmrcli.exe [-i] [-k] <api commands>\n"
"Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-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"
"\tm: Launch the MacroButtons application\n"
"\ts: Launch the StreamerView application");
}
int set_kind(char *kval)
/**
* @brief Set the kind object
*
* @param kval
* @return enum kind
*/
enum kind set_kind(char *kval)
{
if (strcmp(kval, "basic") == 0)
{
if (sizeof(void *) == 8)
return BASICX64;
else
return BASIC;
}
else if (strcmp(kval, "banana") == 0)
{
if (sizeof(void *) == 8)
return BANANAX64;
else
return BANANA;
}
else if (strcmp(kval, "potato") == 0)
@@ -130,11 +193,19 @@ int set_kind(char *kval)
}
else
{
fprintf(stderr, "Unknown Voicemeeter kind '%s'\n", kval);
log_error("Unknown Voicemeeter kind '%s'\n", kval);
exit(EXIT_FAILURE);
}
}
/**
* @brief Defines the DLL interface as a struct.
* Logs into the API.
*
* @param vmr The API interface as a struct
* @param kind
* @return int
*/
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
{
int rep = initialize_dll_interfaces(vmr);
@@ -142,11 +213,11 @@ int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
{
if (rep == -100)
{
fputs("Voicemeeter is not installed", stderr);
log_error("Voicemeeter is not installed");
}
else
{
fprintf(stderr, "Error loading Voicemeeter dll with code %d\n", rep);
log_error("Error loading Voicemeeter dll with code %d\n", rep);
}
return rep;
}
@@ -154,41 +225,69 @@ int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
rep = login(vmr, kind);
if (rep != 0)
{
fputs("Error logging into Voicemeeter", stderr);
log_error("Error logging into Voicemeeter");
return rep;
}
return 0;
}
/**
* @brief Continuously read lines from stdin.
* Break if 'Q' is entered on the interactive prompt.
* Each line is passed to parse_input()
*
* @param vmr The API interface as a struct
*/
void interactive(T_VBVMR_INTERFACE *vmr)
{
char input[MAX_LINE];
char *p = input;
size_t len;
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))
len = strlen(input);
if (len == 1 && toupper(input[0]) == 'Q')
break;
while (*p)
{
char command[MAX_LINE];
int i = 0;
parse_input(vmr, input, len);
while (!isspace(*p) && *p != EOF)
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(">> ");
}
}
/**
* @brief Walks through each line split by a space delimiter.
* Each token is passed to parse_command()
*
* @param vmr The API interface as a struct
* @param input Each input line, from stdin or CLI args
* @param len The length of the input line
*/
void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len)
{
char *token;
replace_multiple_space_with_one(input, len);
token = strtok(input, " ");
while (token != NULL)
{
parse_command(vmr, token);
token = strtok(NULL, " ");
}
}
/**
* @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 The API interface as a struct
* @param command Each token from the input line as its own command string
*/
void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
{
log_debug("Parsing %s", command);
@@ -200,8 +299,17 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
get(vmr, command, &res);
if (res.type == FLOAT_T)
{
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;
}
@@ -209,6 +317,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 */
{
@@ -218,19 +330,25 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
switch (res.type)
{
case FLOAT_T:
printf("%.2f\n", res.val.f);
printf("%s: %.1f\n", command, res.val.f);
break;
case STRING_T:
puts(res.val.s);
printf("%s: %ls\n", command, res.val.s);
break;
default:
fputs("Unknown result...", stderr);
break;
}
}
}
struct result *get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
/**
* @brief
*
* @param vmr The API interface as a struct
* @param command A parsed 'get' command as a string
* @param res A struct holding the result of the API call.
*/
void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
{
clear_dirty(vmr);
if (get_parameter_float(vmr, command, &res->val.f) != 0)
@@ -239,9 +357,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;
}