26 Commits

Author SHA1 Message Date
c1dad8b99c minor bump 2024-07-10 18:17:13 +01:00
2f2e503ae3 implements a short list of quickcommands 2024-07-10 18:15:11 +01:00
ff69837f19 add LOGIN_TIMEOUT macro 2024-07-10 18:11:58 +01:00
b35a29396b add -I flag for disabling >> on the interactive prompt
return early from parse_input() if input is a comment

add comments to example_commands.txt

upd README.

minor ver bump
2024-07-10 10:51:53 +01:00
39540e9c3e add pragma macros,
silences -Wcast-function-type
2024-07-09 15:57:38 +01:00
af98dead75 swap blocks. 2024-07-09 15:11:48 +01:00
ad91a7f4e6 log fatal exit points 2024-07-09 13:18:57 +01:00
8d9e70b79a patch bump 2024-07-09 13:14:52 +01:00
d7d42e4b21 upd makefile to compile for c2x
replace fallthrough comment with fallthrough attribute
2024-07-09 12:59:46 +01:00
babec7abbb revert func signatures, we're getting compile warnings anyway 2024-07-09 12:58:06 +01:00
b2bdd21da5 add USAGE, OPTSTR macros
rename help() to usage()

log_warn() an unknown option

condense set_kind()
2024-07-09 12:43:32 +01:00
88fe1f5782 reword 2024-07-08 18:02:35 +01:00
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
12 changed files with 330 additions and 207 deletions

View File

@@ -13,13 +13,14 @@
## `Use` ## `Use`
```powershell ```powershell
./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands> .\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
``` ```
Where: Where:
- `h`: Prints the help message. - `h`: Prints the help message.
- `i`: Enable interactive mode. If set, any api commands passed on the command line will be ignored. - `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. - `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 - `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL
- `v`: Enable extra console output (toggle, set messages) - `v`: Enable extra console output (toggle, set messages)
@@ -38,13 +39,13 @@ 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 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 ```powershell
./vmrcli.exe -kbasic -D2 !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
``` ```
Launch banana GUI, set log 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
```powershell ```powershell
./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label .\vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label
``` ```
## `Interactive Mode` ## `Interactive Mode`
@@ -52,7 +53,7 @@ Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then prin
Running the following command in Powershell: Running the following command in Powershell:
```powershell ```powershell
./vmrcli.exe -i .\vmrcli.exe -i
``` ```
Will open an interactive prompt: Will open an interactive prompt:
@@ -69,10 +70,18 @@ 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: Scripts can be loaded from text files, for example in Powershell:
```powershell ```powershell
./vmrcli.exe -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. 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 separated by space, `;` or `,`.
Lines starting with `#` will be interpreted as comments.
## `Build` ## `Build`

View File

@@ -1,5 +1,14 @@
# Strip 0
strip[0].mute !strip[0].mute strip[0].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
strip[1].mute=1 strip[1].mute strip[1].limit-=8 strip[1].mute=1 strip[1].mute strip[1].limit-=8
# Strip 2
strip[2].gain-=5 strip[2].comp+=4.8 strip[2].gain-=5 strip[2].comp+=4.8
# Bus 0
bus[0].label bus[0].label
# Bus 1
bus[1].gain-=5.8 bus[1].gain-=5.8

View File

@@ -687,43 +687,43 @@ extern "C"
/* 'C' STRUCTURED INTERFACE */ /* 'C' STRUCTURED INTERFACE */
/******************************************************************************/ /******************************************************************************/
typedef long long(__stdcall *T_VBVMR_Login)(void); typedef long(__stdcall *T_VBVMR_Login)(void);
typedef long long(__stdcall *T_VBVMR_Logout)(void); typedef long(__stdcall *T_VBVMR_Logout)(void);
typedef long long(__stdcall *T_VBVMR_RunVoicemeeter)(long vType); typedef long(__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
typedef long long(__stdcall *T_VBVMR_GetVoicemeeterType)(long *pType); typedef long(__stdcall *T_VBVMR_GetVoicemeeterType)(long *pType);
typedef long long(__stdcall *T_VBVMR_GetVoicemeeterVersion)(long *pVersion); typedef long(__stdcall *T_VBVMR_GetVoicemeeterVersion)(long *pVersion);
typedef long long(__stdcall *T_VBVMR_IsParametersDirty)(void); typedef long(__stdcall *T_VBVMR_IsParametersDirty)(void);
typedef long long(__stdcall *T_VBVMR_GetParameterFloat)(char *szParamName, float *pValue); typedef long(__stdcall *T_VBVMR_GetParameterFloat)(char *szParamName, float *pValue);
typedef long long(__stdcall *T_VBVMR_GetParameterStringA)(char *szParamName, char *szString); typedef long(__stdcall *T_VBVMR_GetParameterStringA)(char *szParamName, char *szString);
typedef long long(__stdcall *T_VBVMR_GetParameterStringW)(char *szParamName, unsigned short *wszString); typedef long(__stdcall *T_VBVMR_GetParameterStringW)(char *szParamName, unsigned short *wszString);
typedef long long(__stdcall *T_VBVMR_GetLevel)(long nType, long nuChannel, float *pValue); typedef long(__stdcall *T_VBVMR_GetLevel)(long nType, long nuChannel, float *pValue);
typedef long long(__stdcall *T_VBVMR_GetMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax); typedef long(__stdcall *T_VBVMR_GetMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long long(__stdcall *T_VBVMR_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax); typedef long(__stdcall *T_VBVMR_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long long(__stdcall *T_VBVMR_SetParameterFloat)(char *szParamName, float Value); typedef long(__stdcall *T_VBVMR_SetParameterFloat)(char *szParamName, float Value);
typedef long long(__stdcall *T_VBVMR_SetParameters)(char *szParamScript); typedef long(__stdcall *T_VBVMR_SetParameters)(char *szParamScript);
typedef long long(__stdcall *T_VBVMR_SetParametersW)(unsigned short *szParamScript); typedef long(__stdcall *T_VBVMR_SetParametersW)(unsigned short *szParamScript);
typedef long long(__stdcall *T_VBVMR_SetParameterStringA)(char *szParamName, char *szString); typedef long(__stdcall *T_VBVMR_SetParameterStringA)(char *szParamName, char *szString);
typedef long long(__stdcall *T_VBVMR_SetParameterStringW)(char *szParamName, unsigned short *wszString); typedef long(__stdcall *T_VBVMR_SetParameterStringW)(char *szParamName, unsigned short *wszString);
typedef long long(__stdcall *T_VBVMR_Output_GetDeviceNumber)(void); typedef long(__stdcall *T_VBVMR_Output_GetDeviceNumber)(void);
typedef long long(__stdcall *T_VBVMR_Output_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId); typedef long(__stdcall *T_VBVMR_Output_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
typedef long long(__stdcall *T_VBVMR_Output_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId); typedef long(__stdcall *T_VBVMR_Output_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
typedef long long(__stdcall *T_VBVMR_Input_GetDeviceNumber)(void); typedef long(__stdcall *T_VBVMR_Input_GetDeviceNumber)(void);
typedef long long(__stdcall *T_VBVMR_Input_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId); typedef long(__stdcall *T_VBVMR_Input_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
typedef long long(__stdcall *T_VBVMR_Input_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId); typedef long(__stdcall *T_VBVMR_Input_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
typedef long long(__stdcall *T_VBVMR_AudioCallbackRegister)(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void *lpUser, char szClientName[64]); typedef long(__stdcall *T_VBVMR_AudioCallbackRegister)(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void *lpUser, char szClientName[64]);
typedef long long(__stdcall *T_VBVMR_AudioCallbackStart)(void); typedef long(__stdcall *T_VBVMR_AudioCallbackStart)(void);
typedef long long(__stdcall *T_VBVMR_AudioCallbackStop)(void); typedef long(__stdcall *T_VBVMR_AudioCallbackStop)(void);
typedef long long(__stdcall *T_VBVMR_AudioCallbackUnregister)(void); typedef long(__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
typedef long long(__stdcall *T_VBVMR_MacroButton_IsDirty)(void); typedef long(__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
typedef long long(__stdcall *T_VBVMR_MacroButton_GetStatus)(long nuLogicalButton, float *pValue, long bitmode); typedef long(__stdcall *T_VBVMR_MacroButton_GetStatus)(long nuLogicalButton, float *pValue, long bitmode);
typedef long long(__stdcall *T_VBVMR_MacroButton_SetStatus)(long nuLogicalButton, float fValue, long bitmode); typedef long(__stdcall *T_VBVMR_MacroButton_SetStatus)(long nuLogicalButton, float fValue, long bitmode);
typedef struct tagVBVMR_INTERFACE typedef struct tagVBVMR_INTERFACE
{ {

View File

@@ -1,8 +0,0 @@
#ifndef __CDLL_H__
#define __CDLL_H__
#include "VoicemeeterRemote.h"
PT_VMR create_interface();
#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__ */

View File

@@ -1,9 +1,23 @@
/**
* 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__ #ifndef __UTIL_H__
#define __UTIL_H__ #define __UTIL_H__
void remove_name_in_path(char *szPath); struct quickcommand
int replace_multiple_space_with_one(char *s, size_t len); {
char *name;
char *fullcommand;
};
void remove_last_part_of_path(char *fullpath);
char *kind_as_string(char *s, int kind, int n); char *kind_as_string(char *s, int kind, int n);
char *version_as_string(char *, long v, int n); char *version_as_string(char *s, long v, int n);
bool is_comment(char *s);
struct quickcommand *command_in_quickcommands(const char *command, struct quickcommand *quickcommands, int n);
#endif /* __UTIL_H__ */ #endif /* __UTIL_H__ */

View File

@@ -1,5 +1,12 @@
#ifndef __VMR_H__ /**
#define __VMR_H__ * 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 <stdbool.h>
#include "voicemeeterRemote.h" #include "voicemeeterRemote.h"
@@ -36,4 +43,4 @@ long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode);
void clear_dirty(PT_VMR vmr); void clear_dirty(PT_VMR vmr);
#endif /* __VMR_H__ */ #endif /* __WRAPPER_H__ */

View File

@@ -15,7 +15,7 @@ ifeq ($(LOG_USE_COLOR), yes)
else else
CPPFLAGS := -Iinclude -MMD -MP CPPFLAGS := -Iinclude -MMD -MP
endif endif
CFLAGS = -O -Wall -W -pedantic -ansi -std=c99 CFLAGS = -O -Wall -W -pedantic -ansi -std=c2x
LDFLAGS := -Llib LDFLAGS := -Llib
LDLIBS := -lm LDLIBS := -lm
@@ -33,6 +33,6 @@ $(BIN_DIR) $(OBJ_DIR):
pwsh -Command New-Item -Path $@ -ItemType Directory pwsh -Command New-Item -Path $@ -ItemType Directory
clean: clean:
pwsh -Command Remove-Item -Recurse $(EXE), $(OBJ_DIR) pwsh -Command Remove-Item -Recurse $(EXE), $(OBJ_DIR) -force
-include $(OBJ:.o=.d) -include $(OBJ:.o=.d)

View File

@@ -1,15 +1,42 @@
/**
* @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.9.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 <stdbool.h>
#include <stdio.h> #include <stdio.h>
#include <windows.h> #include <windows.h>
#include "cdll.h" #include "ivmr.h"
#include "util.h" #include "util.h"
#include "log.h" #include "log.h"
#define PRAGMA_IgnoreWCastIncompatibleFuncTypes \
_Pragma("GCC diagnostic push") \
_Pragma("GCC diagnostic ignored \"-Wcast-function-type\"")
#define PRAGMA_Pop \
_Pragma("GCC diagnostic pop")
static T_VBVMR_INTERFACE iVMR; static T_VBVMR_INTERFACE iVMR;
static long initialize_dll_interfaces(PT_VMR vmr); static long initialize_dll_interfaces(PT_VMR vmr);
static bool registry_get_voicemeeter_folder(char *szDir); static bool registry_get_voicemeeter_folder(char *szDir);
/**
* @brief Create an interface object
*
* @return PT_VMR Pointer to the iVMR interface
*/
PT_VMR create_interface() PT_VMR create_interface()
{ {
PT_VMR vmr = &iVMR; PT_VMR vmr = &iVMR;
@@ -59,6 +86,8 @@ static long initialize_dll_interfaces(PT_VMR vmr)
if (G_H_Module == NULL) if (G_H_Module == NULL)
return -101; return -101;
PRAGMA_IgnoreWCastIncompatibleFuncTypes;
// Get function pointers // Get function pointers
vmr->VBVMR_Login = (T_VBVMR_Login)GetProcAddress(G_H_Module, "VBVMR_Login"); vmr->VBVMR_Login = (T_VBVMR_Login)GetProcAddress(G_H_Module, "VBVMR_Login");
vmr->VBVMR_Logout = (T_VBVMR_Logout)GetProcAddress(G_H_Module, "VBVMR_Logout"); vmr->VBVMR_Logout = (T_VBVMR_Logout)GetProcAddress(G_H_Module, "VBVMR_Logout");
@@ -90,6 +119,8 @@ static long initialize_dll_interfaces(PT_VMR vmr)
vmr->VBVMR_MacroButton_GetStatus = (T_VBVMR_MacroButton_GetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_GetStatus"); vmr->VBVMR_MacroButton_GetStatus = (T_VBVMR_MacroButton_GetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_GetStatus");
vmr->VBVMR_MacroButton_SetStatus = (T_VBVMR_MacroButton_SetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_SetStatus"); vmr->VBVMR_MacroButton_SetStatus = (T_VBVMR_MacroButton_SetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_SetStatus");
PRAGMA_Pop;
// check pointers are valid // check pointers are valid
if (vmr->VBVMR_Login == NULL) if (vmr->VBVMR_Login == NULL)
return -1; return -1;
@@ -191,7 +222,7 @@ static bool registry_get_voicemeeter_folder(char *szDir)
if (rep != ERROR_SUCCESS) if (rep != ERROR_SUCCESS)
return false; return false;
// remove name to get the path only // remove name to get the path only
remove_name_in_path(sss); remove_last_part_of_path(sss);
if (nnsize > 512) if (nnsize > 512)
nnsize = 512; nnsize = 512;
strncpy(szDir, sss, nnsize); strncpy(szDir, sss, nnsize);

View File

@@ -1,74 +1,43 @@
/**
* @file util.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Utility functions.
* @version 0.9.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <stddef.h> #include <stddef.h>
#include <stdio.h> #include <stdio.h>
#include "vmr.h" #include <string.h>
#include <ctype.h>
#include "wrapper.h"
#include "util.h" #include "util.h"
/** /**
* @brief Removes the last part of a path * @brief Removes the last part of a path
* *
* @param szPath * @param fullpath The entire path
*/ */
void remove_name_in_path(char *szPath) void remove_last_part_of_path(char *fullpath)
{ {
char *p = szPath; char *p;
while (*p++) if ((p = strrchr(fullpath, '\\')) != NULL)
; {
while (p > szPath && *p != '\\')
p--;
if (*p == '\\')
*p = '\0'; *p = '\0';
}
} }
/** /**
* @brief replaces multiple newlines and tabs with single spaces * @brief Converts Voicemeeter's kind into a string.
*
* @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 s Pointer to a character buffer
* @param kind The kind of Voicemeeter. * @param kind The kind of Voicemeeter.
* @param n maximum number of characters to be written to the buffer * @param n Maximum number of characters to be written to the buffer
* @return char* The kind of Voicemeeter as a string * @return char* String representation of the kind of Voicemeeter.
*/ */
char *kind_as_string(char *s, int kind, int n) char *kind_as_string(char *s, int kind, int n)
{ {
@@ -85,12 +54,12 @@ char *kind_as_string(char *s, int kind, int n)
} }
/** /**
* @brief returns Voicemeeter's version as a string * @brief Converts Voicemeeter's version into a string.
* *
* @param s string buffer the version will be written to * @param s Pointer to a character buffer
* @param v unprocessed version as a long int * @param v Unprocessed version as a long int
* @param n maximum number of characters to be written to the buffer * @param n Maximum number of characters to be written to the buffer
* @return char* * @return char* String representation of the Voicemeeter version
*/ */
char *version_as_string(char *s, long v, int n) char *version_as_string(char *s, long v, int n)
{ {
@@ -101,3 +70,37 @@ char *version_as_string(char *s, long v, int n)
snprintf(s, n, "%i.%i.%i.%i", (int)v1, (int)v2, (int)v3, (int)v4); snprintf(s, n, "%i.%i.%i.%i", (int)v1, (int)v2, (int)v3, (int)v4);
return s; return s;
} }
/**
* @brief Is the current input a comment
*
* @param s Pointer to the current input
* @return true
* @return false
*/
bool is_comment(char *s)
{
return s[0] == '#';
}
/**
* @brief Searches the quickcommands array for a quickcommand
* corresponding to the command_key.
*
* @param command_key The key used to search for the quickcommand
* @param quickcommands Pointer to an array of quickcommands
* @param n The number of quickcommands
* @return struct quickcommand* Pointer to the found quickcommand
* May return NULL if quickcommand not found.
*/
struct quickcommand *command_in_quickcommands(const char *command_key, struct quickcommand *quickcommands, int n)
{
for (int i = 0; i < n; i++)
{
if (strncmp(command_key, quickcommands[i].name, strlen(command_key)) == 0)
{
return &quickcommands[i];
}
}
return NULL;
}

View File

@@ -1,20 +1,42 @@
/**
* @file vmrcli.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief A Voicemeeter Remote Command Line Interface
* @version 0.9.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>
#include <stdbool.h> #include <stdbool.h>
#include <getopt.h> #include <getopt.h>
#include <string.h> #include <string.h>
#include <ctype.h> #include <ctype.h>
#include "cdll.h" #include <windows.h>
#include "vmr.h" #include "ivmr.h"
#include "wrapper.h"
#include "log.h" #include "log.h"
#include "util.h" #include "util.h"
#define USAGE "Usage: .\\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n" \
"Where: \n" \
"\th: Prints the help message\n" \
"\ti: Enable interactive mode, use (-I) to disable the '>>' prompt\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" \
"\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 MAX_LINE 512 #define MAX_LINE 512
#define COUNT_OF(x) (sizeof(x) / sizeof(x[0]))
/** /**
* @brief An enum used to define the kind of value * @enum The kind of values a get call may return.
* a 'get' call returns.
*
*/ */
enum enum
{ {
@@ -23,8 +45,7 @@ enum
}; };
/** /**
* @brief A struct holding the result of a get call. * @struct A struct holding the result of a get call.
*
*/ */
struct result struct result
{ {
@@ -36,12 +57,19 @@ struct result
} val; } val;
}; };
struct quickcommand quickcommands[] = {
{.name = "lock", .fullcommand = "command.lock=1"},
{.name = "unlock", .fullcommand = "command.lock=0"},
{.name = "show", .fullcommand = "command.show=1"},
{.name = "hide", .fullcommand = "command.show=0"},
{.name = "restart", .fullcommand = "command.restart=1"}};
static bool vflag = false; static bool vflag = false;
void help(void); static void usage(void);
enum kind set_kind(char *kval); enum kind set_kind(char *kval);
void interactive(PT_VMR vmr); void interactive(PT_VMR vmr, bool with_prompt);
void parse_input(PT_VMR vmr, char *input, int len); void parse_input(PT_VMR vmr, char *input);
void parse_command(PT_VMR vmr, char *command); void parse_command(PT_VMR vmr, char *command);
void get(PT_VMR vmr, char *command, struct result *res); void get(PT_VMR vmr, char *command, struct result *res);
@@ -50,7 +78,8 @@ int main(int argc, char *argv[])
bool iflag = false, bool iflag = false,
mflag = false, mflag = false,
sflag = false, sflag = false,
cflag = false; cflag = false,
with_prompt = true;
int opt; int opt;
int dvalue; int dvalue;
char *cvalue; char *cvalue;
@@ -58,19 +87,16 @@ int main(int argc, char *argv[])
if (argc == 1) if (argc == 1)
{ {
help(); usage();
exit(EXIT_SUCCESS);
} }
log_set_level(LOG_WARN); log_set_level(LOG_WARN);
while ((opt = getopt(argc, argv, "hk:msc:iD:v")) != -1) opterr = 0;
while ((opt = getopt(argc, argv, OPTSTR)) != -1)
{ {
switch (opt) switch (opt)
{ {
case 'h':
help();
exit(EXIT_SUCCESS);
case 'k': case 'k':
kind = set_kind(optarg); kind = set_kind(optarg);
if (kind == UNKNOWN) if (kind == UNKNOWN)
@@ -89,6 +115,9 @@ int main(int argc, char *argv[])
cflag = true; cflag = true;
cvalue = optarg; cvalue = optarg;
break; break;
case 'I':
with_prompt = false;
[[fallthrough]];
case 'i': case 'i':
iflag = true; iflag = true;
break; break;
@@ -108,14 +137,26 @@ int main(int argc, char *argv[])
case 'v': case 'v':
vflag = true; vflag = true;
break; break;
case '?':
log_fatal("unknown option -- '%c'\n"
"Try .\\vmrcli.exe -h for more information.",
optopt);
exit(EXIT_FAILURE);
case ':':
log_fatal("missing argument for option -- '%c'\n"
"Try .\\vmrcli.exe -h for more information.",
optopt);
exit(EXIT_FAILURE);
case 'h':
[[fallthrough]];
default: default:
abort(); usage();
} }
} }
PT_VMR vmr = create_interface(); PT_VMR vmr = create_interface();
int rep = login(vmr, kind); long rep = login(vmr, kind);
if (rep != 0) if (rep != 0)
{ {
log_fatal("Error logging into the Voicemeeter API"); log_fatal("Error logging into the Voicemeeter API");
@@ -138,85 +179,61 @@ int main(int argc, char *argv[])
{ {
log_info("Profile %s loaded", cvalue); log_info("Profile %s loaded", cvalue);
set_parameter_string(vmr, "command.load", cvalue); set_parameter_string(vmr, "command.load", cvalue);
Sleep(300);
clear_dirty(vmr);
} }
if (iflag) if (iflag)
{ {
puts("Interactive mode enabled. Enter 'Q' to exit."); puts("Interactive mode enabled. Enter 'Q' to exit.");
interactive(vmr); interactive(vmr, with_prompt);
} }
else else
{ {
for (int i = optind; i < argc; i++) for (int i = optind; i < argc; i++)
{ {
parse_input(vmr, argv[i], strlen(argv[i])); parse_input(vmr, argv[i]);
} }
} }
rep = logout(vmr); rep = logout(vmr);
if (rep == 0) if (rep != 0)
{
return EXIT_SUCCESS;
}
else
{ {
log_fatal("Error logging out of the Voicemeeter API"); log_fatal("Error logging out of the Voicemeeter API");
return EXIT_FAILURE; return EXIT_FAILURE;
} }
else
{
return EXIT_SUCCESS;
}
} }
/** /**
* @brief prints the help message * @brief prints the help message
*
*/ */
void help() static void usage()
{ {
puts( puts(USAGE);
"Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n" exit(EXIT_SUCCESS);
"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\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");
} }
/** /**
* @brief Set the kind object * @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 * @param kval Value of the -k flag
* @return enum kind * @return enum kind
*/ */
enum kind set_kind(char *kval) enum kind set_kind(char *kval)
{ {
if (strcmp(kval, "basic") == 0) if (strcmp(kval, "basic") == 0)
{ return sizeof(void *) == 8 ? BASICX64 : BASIC;
if (sizeof(void *) == 8)
return BASICX64;
else
return BASIC;
}
else if (strcmp(kval, "banana") == 0) else if (strcmp(kval, "banana") == 0)
{ return sizeof(void *) == 8 ? BANANAX64 : BANANA;
if (sizeof(void *) == 8)
return BANANAX64;
else
return BANANA;
}
else if (strcmp(kval, "potato") == 0) else if (strcmp(kval, "potato") == 0)
{ return sizeof(void *) == 8 ? POTATOX64 : POTATO;
if (sizeof(void *) == 8)
return POTATOX64;
else else
return POTATO;
}
else
{
return UNKNOWN; return UNKNOWN;
}
} }
/** /**
@@ -224,46 +241,48 @@ enum kind set_kind(char *kval)
* Break if 'Q' is entered on the interactive prompt. * Break if 'Q' is entered on the interactive prompt.
* Each line is passed to parse_input() * Each line is passed to parse_input()
* *
* @param vmr The API interface as a struct * @param vmr Pointer to the iVMR interface
*/ */
void interactive(PT_VMR vmr) void interactive(PT_VMR vmr, bool with_prompt)
{ {
char input[MAX_LINE]; char input[MAX_LINE];
size_t len;
if (with_prompt)
printf(">> "); printf(">> ");
while (fgets(input, MAX_LINE, stdin) != NULL) while (fgets(input, MAX_LINE, stdin) != NULL)
{ {
input[strcspn(input, "\n")] = 0; input[strcspn(input, "\n")] = 0;
len = strlen(input); if (strlen(input) == 1 && toupper(input[0]) == 'Q')
if (len == 1 && toupper(input[0]) == 'Q')
break; break;
parse_input(vmr, input, len); parse_input(vmr, input);
memset(input, '\0', MAX_LINE); /* reset input buffer */ memset(input, 0, MAX_LINE); /* reset input buffer */
if (with_prompt)
printf(">> "); printf(">> ");
} }
} }
/** /**
* @brief Walks through each line split by a space delimiter. * @brief Returns early if input is a comment
* Walks through each line split by " \t;," delimiters.
* Each token is passed to parse_command() * Each token is passed to parse_command()
* *
* @param vmr The API interface as a struct * @param vmr Pointer to the iVMR interface
* @param input Each input line, from stdin or CLI args * @param input Each input line, from stdin or CLI args
* @param len The length of the input line
*/ */
void parse_input(PT_VMR vmr, char *input, int len) void parse_input(PT_VMR vmr, char *input)
{ {
char *token; if (is_comment(input))
return;
replace_multiple_space_with_one(input, len); char *token, *p;
token = strtok(input, " ");
token = strtok_r(input, " \t;,", &p);
while (token != NULL) while (token != NULL)
{ {
parse_command(vmr, token); parse_command(vmr, token);
token = strtok(NULL, " "); token = strtok_r(NULL, " \t;,", &p);
} }
} }
@@ -272,13 +291,24 @@ void parse_input(PT_VMR vmr, char *input, int len)
* See command type definitions in: * See command type definitions in:
* https://github.com/onyx-and-iris/vmrcli?tab=readme-ov-file#api-commands * https://github.com/onyx-and-iris/vmrcli?tab=readme-ov-file#api-commands
* *
* @param vmr The API interface as a struct * @param vmr Pointer to the iVMR interface
* @param command Each token from the input line as its own command string * @param command Each token from the input line as its own command string
*/ */
void parse_command(PT_VMR vmr, char *command) void parse_command(PT_VMR vmr, char *command)
{ {
log_debug("Parsing %s", command); log_debug("Parsing %s", command);
struct quickcommand *qc_ptr = command_in_quickcommands(command, quickcommands, (int)COUNT_OF(quickcommands));
if (qc_ptr != NULL)
{
set_parameters(vmr, qc_ptr->fullcommand);
if (vflag)
{
printf("Setting %s\n", qc_ptr->fullcommand);
}
return;
}
if (command[0] == '!') /* toggle */ if (command[0] == '!') /* toggle */
{ {
command++; command++;
@@ -320,6 +350,7 @@ void parse_command(PT_VMR vmr, char *command)
printf("%s: %.1f\n", command, res.val.f); printf("%s: %.1f\n", command, res.val.f);
break; break;
case STRING_T: case STRING_T:
if (res.val.s[0] != '\0')
printf("%s: %ls\n", command, res.val.s); printf("%s: %ls\n", command, res.val.s);
break; break;
default: default:
@@ -329,9 +360,10 @@ void parse_command(PT_VMR vmr, char *command)
} }
/** /**
* @brief * @brief Get the value of a float or string parameter.
* Stores its type and value into a result struct
* *
* @param vmr The API interface as a struct * @param vmr Pointer to the iVMR interface
* @param command A parsed 'get' command as a string * @param command A parsed 'get' command as a string
* @param res A struct holding the result of the API call. * @param res A struct holding the result of the API call.
*/ */

View File

@@ -1,25 +1,37 @@
/**
* @file wrapper.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Provides public functions that wrap the iVMR calls
* @version 0.9.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <windows.h> #include <windows.h>
#include <stdio.h> #include <stdio.h>
#include <time.h> #include <time.h>
#include "vmr.h" #include "wrapper.h"
#include "log.h" #include "log.h"
#include "util.h" #include "util.h"
#define VERSION_STR_LEN 128
#define KIND_STR_LEN 64 #define KIND_STR_LEN 64
#define VERSION_STR_LEN 32
#define LOGIN_TIMEOUT 2
/** /**
* @brief Logs into the API. * @brief Logs into the API.
* Tests for valid connection for up to 2 seconds. * Tests for valid connection for up to 2 seconds.
* If successful initializes the dirty parameters. * If successful initializes the dirty parameters.
* *
* @param vmr * @param vmr Pointer to the iVMR interface
* @param kind * @param kind The kind of Voicemeeter Gui to launch.
* @return long * @return long VBVMR_Login return value
*/ */
long login(PT_VMR vmr, int kind) long login(PT_VMR vmr, int kind)
{ {
int rep; long rep;
long v; long v;
log_trace("VBVMR_Login()"); log_trace("VBVMR_Login()");
@@ -33,7 +45,6 @@ long login(PT_VMR vmr, int kind)
kind_as_string(kind_s, kind, KIND_STR_LEN)); kind_as_string(kind_s, kind, KIND_STR_LEN));
} }
int timeout = 2;
time_t start = time(NULL); time_t start = time(NULL);
do do
{ {
@@ -46,7 +57,7 @@ long login(PT_VMR vmr, int kind)
break; break;
} }
Sleep(50); Sleep(50);
} while (time(NULL) < start + timeout); } while (difftime(time(NULL), start) < LOGIN_TIMEOUT);
if (rep == 0) if (rep == 0)
{ {
@@ -59,12 +70,12 @@ long login(PT_VMR vmr, int kind)
* @brief Logs out of the API giving a short wait to allow a * @brief Logs out of the API giving a short wait to allow a
* final instruction to complete. * final instruction to complete.
* *
* @param vmr The API interface as a struct * @param vmr Pointer to the iVMR interface
* @return long VBVMR_Logout return value * @return long VBVMR_Logout return value
*/ */
long logout(PT_VMR vmr) long logout(PT_VMR vmr)
{ {
int rep; long rep;
Sleep(20); /* give time for last command */ Sleep(20); /* give time for last command */
log_trace("VBVMR_Logout()"); log_trace("VBVMR_Logout()");