12 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
6 changed files with 46 additions and 82 deletions

View File

@@ -13,7 +13,7 @@
## `Use`
```powershell
./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
.\vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
```
Where:
@@ -38,13 +38,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
```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
```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`
@@ -52,7 +52,7 @@ Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then prin
Running the following command in Powershell:
```powershell
./vmrcli.exe -i
.\vmrcli.exe -i
```
Will open an interactive prompt:
@@ -69,10 +69,16 @@ 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 -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 delimited by space, `;` or `,`.
## `Build`

View File

@@ -8,9 +8,8 @@
#ifndef __UTIL_H__
#define __UTIL_H__
void remove_name_in_path(char *szPath);
int replace_multiple_space_with_one(char *s, size_t len);
void remove_last_part_of_path(char *fullpath);
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);
#endif /* __UTIL_H__ */

View File

@@ -3,13 +3,13 @@
* @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.5.0
* @version 0.6.0
* @date 2024-07-06
*
* @copyright Vincent Burel(c)2015-2021 All Rights Reserved
* https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/LICENSE
* https://github.com/vburel2018/Voicemeeter-SDK/blob/main/LICENSE
*
* Copyright (c) 2024
* Copyright (c) 2024 Onyx and Iris
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
@@ -211,7 +211,7 @@ static bool registry_get_voicemeeter_folder(char *szDir)
if (rep != ERROR_SUCCESS)
return false;
// remove name to get the path only
remove_name_in_path(sss);
remove_last_part_of_path(sss);
if (nnsize > 512)
nnsize = 512;
strncpy(szDir, sss, nnsize);

View File

@@ -2,7 +2,7 @@
* @file util.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Utility functions.
* @version 0.5.0
* @version 0.6.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
@@ -11,66 +11,24 @@
#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 szPath Pointer to the path string
* @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++)
;
while (p > szPath && *p != '\\')
p--;
if (*p == '\\')
if ((p = strrchr(fullpath, '\\')) != NULL)
{
*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;
}
/**

View File

@@ -2,7 +2,7 @@
* @file vmrcli.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief A Voicemeeter Remote Command Line Interface
* @version 0.5.0
* @version 0.6.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
@@ -15,6 +15,7 @@
#include <getopt.h>
#include <string.h>
#include <ctype.h>
#include <windows.h>
#include "ivmr.h"
#include "wrapper.h"
#include "log.h"
@@ -49,7 +50,7 @@ static bool vflag = false;
void help(void);
enum kind set_kind(char *kval);
void interactive(PT_VMR vmr);
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 get(PT_VMR vmr, char *command, struct result *res);
@@ -146,6 +147,8 @@ int main(int argc, char *argv[])
{
log_info("Profile %s loaded", cvalue);
set_parameter_string(vmr, "command.load", cvalue);
Sleep(300);
clear_dirty(vmr);
}
if (iflag)
@@ -157,7 +160,7 @@ int main(int argc, char *argv[])
{
for (int i = optind; i < argc; i++)
{
parse_input(vmr, argv[i], strlen(argv[i]));
parse_input(vmr, argv[i]);
}
}
@@ -179,7 +182,7 @@ int main(int argc, char *argv[])
void help()
{
puts(
"Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <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"
@@ -237,41 +240,37 @@ enum kind set_kind(char *kval)
void interactive(PT_VMR vmr)
{
char input[MAX_LINE];
size_t len;
printf(">> ");
while (fgets(input, MAX_LINE, stdin) != NULL)
{
input[strcspn(input, "\n")] = 0;
len = strlen(input);
if (len == 1 && toupper(input[0]) == 'Q')
if (strlen(input) == 1 && toupper(input[0]) == 'Q')
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 */
printf(">> ");
}
}
/**
* @brief Walks through each line split by a space delimiter.
* @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
* @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;
char *token, *p;
replace_multiple_space_with_one(input, len);
token = strtok(input, " ");
token = strtok_r(input, " \t;,", &p);
while (token != NULL)
{
parse_command(vmr, token);
token = strtok(NULL, " ");
token = strtok_r(NULL, " \t;,", &p);
}
}
@@ -328,6 +327,7 @@ void parse_command(PT_VMR vmr, char *command)
printf("%s: %.1f\n", command, res.val.f);
break;
case STRING_T:
if (res.val.s[0] != '\0')
printf("%s: %ls\n", command, res.val.s);
break;
default:
@@ -337,7 +337,8 @@ 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 Pointer to the iVMR interface
* @param command A parsed 'get' command as a string

View File

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