Compare commits

...

23 Commits

Author SHA1 Message Date
6390f52420 use log_level to set level 2025-12-02 02:23:46 +00:00
fe969193f6 fix updated flags in Use section 2025-12-02 02:15:05 +00:00
1950d6dd8e update README with flag changes 2025-12-02 02:09:50 +00:00
ca15785789 -D flag changed to -l flag. It now expects a string. (DEBUG, INFO etc)
-v flag now prints the cli version

new flag -e prints extra console info

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

1
.env Normal file
View File

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

3
.gitignore vendored
View File

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

View File

@ -2,9 +2,9 @@
## `Tested against`
- Basic 1.1.1.1
- Banana 2.1.1.1
- Potato 3.1.1.1
- Basic 1.1.1.9
- Banana 2.1.1.9
- Potato 3.1.1.9
## `Requirements`
@ -13,17 +13,19 @@
## `Use`
```powershell
.\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
.\vmrcli.exe [-h] [-v] [-i|-I] [-f] [-k] [-l] [-e] [-c] [-m] [-s] <api commands>
```
Where:
- `h`: Prints the help message.
- `h`: Print the help message.
- `v`: Print the version of vmrcli.
- `i`: Enable interactive mode, use (-I) to disable the '>>' prompt.
- If set, any api commands passed on the command line will be ignored.
- `f`: Do not split input on spaces.
- `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)
- `l`: Set log level, must be one of TRACE, DEBUG, INFO, WARN, ERROR, or FATAL
- `e`: 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
@ -39,13 +41,23 @@ Examples:
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 -D2 !strip[0].mute strip[0].mute bus[0].gain-=3.8
.\vmrcli.exe -kbasic -lINFO !strip[0].mute strip[0].mute bus[0].gain-=3.8
```
Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then print Strip 2 label
```powershell
.\vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label
.\vmrcli.exe -kbanana -lDEBUG strip[0].label=podmic strip[2].label
```
#### `String Commands With Spaces`
It may be desirable to send a string request containing spaces, for example to change an output device. By default the CLI splits such strings, to avoid this pass the `-f` flag. It's probably best to use this with single commands only due to its effect on how the CLI parses strings. Also note the inclusion of the double quotation marks, it seems the C API requires them.
```powershell
.\vmrcli.exe -lDEBUG -f bus[1].device.wdm='"Realtek Digital Output (Realtek(R) Audio)"'
.\vmrcli.exe -lDEBUG -f strip[0].label='"My Podmic"'
```
#### `Quick Commands`
@ -82,13 +94,13 @@ API commands follow the same rules as listed above. Entering `Q` or `q` will exi
Scripts can be loaded from text files, for example in Powershell:
```powershell
.\vmrcli.exe -D1 $(Get-Content .\example_commands.txt)
.\vmrcli.exe -lDEBUG $(Get-Content .\example_commands.txt)
```
You may also pipe a scripts contents to the CLI:
```powershell
$(Get-Content .\example_commands.txt) | .\vmrcli.exe -D1 -I
$(Get-Content .\example_commands.txt) | .\vmrcli.exe -lDEBUG -I
```
Multiple API commands can be in a single line, they may be separated by space, `;` or `,`.

71
Taskfile.yml Normal file
View File

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

View File

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

View File

@ -15,6 +15,7 @@ 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);

View File

@ -1,38 +1,53 @@
# 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 $(EXE), $(OBJ_DIR) -force
pwsh -Command Remove-Item -Recurse $(BIN_DIR), $(OBJ_DIR) -force
# Include dependency files
-include $(OBJ:.o=.d)

View File

@ -81,7 +81,7 @@ static long initialize_dll_interfaces(PT_VMR vmr)
return -100;
}
// use right dll according to O/S type
if (sizeof(void *) == 8)
if (IS_64_BIT)
strncat(dll_fullpath, DLL64_NAME, DLL_FULLPATH_SZ - strlen(DLL64_NAME) - 1);
else
strncat(dll_fullpath, DLL32_NAME, DLL_FULLPATH_SZ - strlen(DLL32_NAME) - 1);

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

@ -12,6 +12,7 @@
#include <stdio.h>
#include <string.h>
#include "util.h"
#include "log.h"
/**
* @brief Removes the last part of a path
@ -28,6 +29,29 @@ 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.
*
@ -92,7 +116,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)
{

View File

@ -18,21 +18,24 @@
#include "log.h"
#include "util.h"
#define USAGE "Usage: .\\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n" \
#define USAGE "Usage: .\\vmrcli.exe [-h] [-v] [-i|-I] [-f] [-k] [-l] [-e] [-c] [-m] [-s] <api commands>\n" \
"Where: \n" \
"\th: Prints the help message\n" \
"\th: Print the help message\n" \
"\tv: Print the version number\n" \
"\ti: Enable interactive mode, use (-I) to disable the '>>' prompt\n" \
"\tf: Do not split input on spaces\n" \
"\tk: The kind of Voicemeeter (basic, banana, potato)\n" \
"\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" \
"\tl: Set log level, must be one of TRACE, DEBUG, INFO, WARN, ERROR, or FATAL\n" \
"\te: Enable extra console output (toggle, set messages)\n" \
"\tc: Load a user configuration (give the full file path)\n" \
"\tm: Launch the MacroButtons application\n" \
"\ts: Launch the StreamerView application"
#define OPTSTR ":hk:msc:iID:v"
#define OPTSTR ":hvk:msc:iIfl:e"
#define MAX_LINE 4096 /* Size of the input buffer */
#define RES_SZ 512 /* Size of the buffer passed to VBVMR_GetParameterStringW */
#define COUNT_OF(x) (sizeof(x) / sizeof(x[0]))
#define DELIMITERS " \t;,"
#define VERSION "0.12.0"
/**
* @enum The kind of values a get call may return.
@ -58,13 +61,13 @@ struct result
} val;
};
static bool vflag = false;
static bool eflag = 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);
static void parse_input(PT_VMR vmr, char *input);
static void interactive(PT_VMR vmr, bool with_prompt, char *delimiters);
static void parse_input(PT_VMR vmr, char *input, char *delimiters);
static void parse_command(PT_VMR vmr, char *command);
static void get(PT_VMR vmr, char *command, struct result *res);
@ -74,9 +77,10 @@ int main(int argc, char *argv[])
mflag = false,
sflag = false,
cflag = false,
fflag = false,
with_prompt = true;
int opt;
int dvalue;
int log_level = LOG_WARN;
char *cvalue;
enum kind kind = BANANAX64;
@ -85,13 +89,16 @@ int main(int argc, char *argv[])
usage();
}
log_set_level(LOG_WARN);
log_set_level(log_level);
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)
@ -116,21 +123,24 @@ int main(int argc, char *argv[])
case 'i':
iflag = true;
break;
case 'D':
dvalue = atoi(optarg);
if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
case 'f':
fflag = true;
break;
case 'l':
log_level = log_level_from_string(optarg);
if (log_level != -1)
{
log_set_level(dvalue);
log_set_level(log_level);
}
else
{
log_warn(
"-D arg out of range, expected value from 0 up to 5\n"
"-l arg out of range, expected TRACE, DEBUG, INFO, WARN, ERROR, or FATAL\n"
"Log level will default to LOG_WARN (3).\n");
}
break;
case 'v':
vflag = true;
case 'e':
eflag = true;
break;
case '?':
log_fatal("unknown option -- '%c'\n"
@ -184,16 +194,22 @@ 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);
interactive(vmr, with_prompt, delimiter_ptr);
}
else
{
for (int i = optind; i < argc; i++)
for (int i = optind; i < argc; ++i)
{
parse_input(vmr, argv[i]);
parse_input(vmr, argv[i], delimiter_ptr);
}
}
@ -240,11 +256,11 @@ static void usage()
static enum kind set_kind(char *kval)
{
if (strcmp(kval, "basic") == 0)
return sizeof(void *) == 8 ? BASICX64 : BASIC;
return IS_64_BIT ? BASICX64 : BASIC;
else if (strcmp(kval, "banana") == 0)
return sizeof(void *) == 8 ? BANANAX64 : BANANA;
return IS_64_BIT ? BANANAX64 : BANANA;
else if (strcmp(kval, "potato") == 0)
return sizeof(void *) == 8 ? POTATOX64 : POTATO;
return IS_64_BIT ? POTATOX64 : POTATO;
else
return UNKNOWN;
}
@ -256,8 +272,9 @@ 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)
static void interactive(PT_VMR vmr, bool with_prompt, char *delimiters)
{
char input[MAX_LINE];
size_t len;
@ -266,12 +283,11 @@ static void interactive(PT_VMR vmr, bool with_prompt)
printf(">> ");
while (fgets(input, MAX_LINE, stdin) != NULL)
{
input[strcspn(input, "\n")] = 0;
if ((len = strlen(input)) == 1 && toupper(input[0]) == 'Q')
input[(len = strcspn(input, "\n"))] = 0;
if (len == 1 && toupper(input[0]) == 'Q')
break;
parse_input(vmr, input);
memset(input, 0, len); /* reset input buffer */
parse_input(vmr, input, delimiters);
if (with_prompt)
printf(">> ");
@ -285,19 +301,20 @@ static void interactive(PT_VMR vmr, bool with_prompt)
*
* @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)
static void parse_input(PT_VMR vmr, char *input, char *delimiters)
{
if (is_comment(input))
return;
char *token, *p;
token = strtok_r(input, DELIMITERS, &p);
token = strtok_r(input, delimiters, &p);
while (token != NULL)
{
parse_command(vmr, token);
token = strtok_r(NULL, DELIMITERS, &p);
token = strtok_r(NULL, delimiters, &p);
}
}
@ -324,7 +341,7 @@ static void parse_command(PT_VMR vmr, char *command)
if (qc_ptr != NULL)
{
set_parameters(vmr, qc_ptr->fullcommand);
if (vflag)
if (eflag)
{
printf("Setting %s\n", qc_ptr->fullcommand);
}
@ -342,7 +359,7 @@ 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 (vflag)
if (eflag)
{
printf("Toggling %s\n", command);
}
@ -356,7 +373,7 @@ static void parse_command(PT_VMR vmr, char *command)
if (strchr(command, '=') != NULL) /* set */
{
set_parameters(vmr, command);
if (vflag)
if (eflag)
{
printf("Setting %s\n", command);
}