onyx_online/vmrcli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vmrcli.git synced 2025-04-18 20:13:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: onyx_online:main
Branches Tags
onyx_online:main
onyx_online:v0.11.0
onyx_online:v0.10.0
onyx_online:v0.9.0
onyx_online:v0.8.0
onyx_online:v0.7.1
onyx_online:v0.7.0
onyx_online:v0.6.0
onyx_online:v0.5.0
onyx_online:v0.4.0
onyx_online:v0.3.0
onyx_online:v0.2.1
onyx_online:v0.2.0
onyx_online:0.1.0
..
compare: onyx_online:v0.2.0
Branches Tags
onyx_online:main
onyx_online:v0.11.0
onyx_online:v0.10.0
onyx_online:v0.9.0
onyx_online:v0.8.0
onyx_online:v0.7.1
onyx_online:v0.7.0
onyx_online:v0.6.0
onyx_online:v0.5.0
onyx_online:v0.4.0
onyx_online:v0.3.0
onyx_online:v0.2.1
onyx_online:v0.2.0
onyx_online:0.1.0

No commits in common. "main" and "v0.2.0" have entirely different histories.
main ... v0.2.0

20 changed files with 1114 additions and 1665 deletions
Show Stats Expand all files Collapse all files

1
.env
View File

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

5
.gitignore vendored
View File

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

21
LICENSE
View File

@ -1,21 +0,0 @@
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.

84
README.md
View File

@ -1,4 +1,4 @@
# Voicemeeter Remote Command Line Utility
# VMRCLI Command Line Utility
## `Tested against`
@ -12,106 +12,42 @@
## `Use`
```powershell
.\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
```
`./vmrcli.exe [-i] [-k] [-D] <api commands>`
Where:
- `h`: Prints the help message.
- `i`: Enable interactive mode, use (-I) to disable the '>>' prompt.
- If set, any api commands passed on the command line will be ignored.
- `i`: Enable interactive mode. If set any api commands passed 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. (use `+=` and `-=` to increment/decrement)
- Commands containing `=` will set a value.
- All other commands with get a value.
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, then print its new value
```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`
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
```
#### `Quick Commands`
A short list of quick commands are available:
- `lock`: command.lock=1
- `unlock`: command.lock=0
- `show`: command.show=1
- `hide`: command.show=0
- `restart`: command.restart=1
They may be used in direct or interactive mode.
## `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.
`./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label`
## `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 separated by space, `;` or `,`.
Lines starting with `#` will be interpreted as comments.
## `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]
- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
## `Special Thanks`
- [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
- [rxi](https://github.com/rxi) for writing the [log.c](https://github.com/rxi/log.c) package

71
Taskfile.yml
View File

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

22
example_commands.txt
View File

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

531
include/VoicemeeterRemote.h
View File

@ -1,5 +1,5 @@
/******************************************************************************/
/* Voicemeeter Remote API. V.Burel<EFBFBD>2015-2023 */
/* Voicemeeter Remote API. V.Burel©2015-2023 */
/******************************************************************************/
/* This Library allows communication with Voicemeeter applications */
/* 4 Client Applications can be connected to remote Voicemeeter. */
@ -19,24 +19,25 @@
/* long = 32 bit integer */
/******************************************************************************/
#ifndef __VOICEMEETER_REMOTE_H__
#define __VOICEMEETER_REMOTE_H__
#ifdef __cplusplus
extern "C"
{
extern "C" {
#endif
#define VBVMR_RESULT_OK 0
/******************************************************************************/
/* */
/* Login */
/* */
/******************************************************************************/
/******************************************************************************/
/* */
/* Login */
/* */
/******************************************************************************/
/** @name Communication Login / logout
* @{ */
/** @name Communication Login / logout
* @{ */
/**
@brief Open Communication Pipe With Voicemeeter (typically called on software startup).
@ -46,14 +47,15 @@ extern "C"
-2: unexpected login (logout was expected before).
*/
long __stdcall VBVMR_Login(void);
long __stdcall VBVMR_Login(void);
/**
@brief Close Communication Pipe With Voicemeeter (typically called on software end).
@return : 0 if ok.
*/
long __stdcall VBVMR_Logout(void);
long __stdcall VBVMR_Logout(void);
/**
@brief Run Voicemeeter Application (get installation directory and run Voicemeeter Application).
@ -63,18 +65,29 @@ extern "C"
-2: unknown vType number
*/
long __stdcall VBVMR_RunVoicemeeter(long vType);
long __stdcall VBVMR_RunVoicemeeter(long vType);
/** @} */
/******************************************************************************/
/* */
/* General Information */
/* */
/******************************************************************************/
/** @} */
/** @name General Information
* @{ */
/******************************************************************************/
/* */
/* General Information */
/* */
/******************************************************************************/
/** @name General Information
* @{ */
/**
@brief Get Voicemeeter Type
@ -104,7 +117,7 @@ extern "C"
-2: no server.
*/
long __stdcall VBVMR_GetVoicemeeterType(long *pType);
long __stdcall VBVMR_GetVoicemeeterType(long * pType);
/**
@brief Get Voicemeeter Version
@ -119,18 +132,36 @@ extern "C"
-2: no server.
*/
long __stdcall VBVMR_GetVoicemeeterVersion(long *pVersion);
long __stdcall VBVMR_GetVoicemeeterVersion(long * pVersion);
/** @} */
/******************************************************************************/
/* */
/* Get parameters */
/* */
/******************************************************************************/
/** @} */
/** @name Getting Parameters
* @{ */
/******************************************************************************/
/* */
/* Get parameters */
/* */
/******************************************************************************/
/** @name Getting Parameters
* @{ */
/**
@brief Check if parameters have changed.
@ -143,7 +174,7 @@ extern "C"
-2: no server.
*/
long __stdcall VBVMR_IsParametersDirty(void);
long __stdcall VBVMR_IsParametersDirty(void);
/**
@brief get parameter value.
@ -156,7 +187,7 @@ extern "C"
-5: structure mismatch
*/
long __stdcall VBVMR_GetParameterFloat(char *szParamName, float *pValue);
long __stdcall VBVMR_GetParameterFloat(char * szParamName, float * pValue);
/**
@brief get parameter value.
@ -169,19 +200,27 @@ extern "C"
-5: structure mismatch
*/
long __stdcall VBVMR_GetParameterStringA(char *szParamName, char *szString);
long __stdcall VBVMR_GetParameterStringW(char *szParamName, unsigned short *wszString);
long __stdcall VBVMR_GetParameterStringA(char * szParamName, char * szString);
long __stdcall VBVMR_GetParameterStringW(char * szParamName, unsigned short * wszString);
/** @} */
/** @} */
/******************************************************************************/
/* */
/* Get levels */
/* */
/******************************************************************************/
/** @name Getting RT Data
* @{ */
/******************************************************************************/
/* */
/* Get levels */
/* */
/******************************************************************************/
/** @name Getting RT Data
* @{ */
/**
@brief Get Current levels.
@ -242,7 +281,8 @@ extern "C"
-4: out of range
*/
long __stdcall VBVMR_GetLevel(long nType, long nuChannel, float *pValue);
long __stdcall VBVMR_GetLevel(long nType, long nuChannel, float * pValue);
/**
@brief Get MIDI message from M.I.D.I. input device used by Voicemeeter M.I.D.I. mapping.
@ -261,7 +301,9 @@ extern "C"
-6: no MIDI data
*/
long __stdcall VBVMR_GetMidiMessage(unsigned char *pMIDIBuffer, long nbByteMax);
long __stdcall VBVMR_GetMidiMessage(unsigned char *pMIDIBuffer, long nbByteMax);
/**
@brief Send MIDI message to M.I.D.I. output device used by Voicemeeter M.I.D.I. mapping.
@ -277,18 +319,29 @@ extern "C"
-5: cannot send MIDI data
*/
long __stdcall VBVMR_SendMidiMessage(unsigned char *pMIDIBuffer, long nbByte);
/** @} */
long __stdcall VBVMR_SendMidiMessage(unsigned char *pMIDIBuffer, long nbByte);
/******************************************************************************/
/* */
/* Set Parameters */
/* */
/******************************************************************************/
/** @name Setting Parameters
* @{ */
/** @} */
/******************************************************************************/
/* */
/* Set Parameters */
/* */
/******************************************************************************/
/** @name Setting Parameters
* @{ */
/**
@brief Set a single float 32 bits parameters .
@ -306,7 +359,9 @@ extern "C"
-3: unknown parameter
*/
long __stdcall VBVMR_SetParameterFloat(char *szParamName, float Value);
long __stdcall VBVMR_SetParameterFloat(char * szParamName, float Value);
/**
@brief Set a single string parameters .
@ -324,8 +379,12 @@ extern "C"
*/
long __stdcall VBVMR_SetParameterStringA(char *szParamName, char *szString);
long __stdcall VBVMR_SetParameterStringW(char *szParamName, unsigned short *wszString);
long __stdcall VBVMR_SetParameterStringA(char * szParamName, char * szString);
long __stdcall VBVMR_SetParameterStringW(char * szParamName, unsigned short * wszString);
/**
@brief Set one or several parameters by a script ( < 48 kB ).
@ -348,17 +407,29 @@ extern "C"
-4: unexpected error
*/
long __stdcall VBVMR_SetParameters(char *szParamScript);
long __stdcall VBVMR_SetParametersW(unsigned short *szParamScript);
long __stdcall VBVMR_SetParameters(char * szParamScript);
long __stdcall VBVMR_SetParametersW(unsigned short * szParamScript);
/** @} */
/******************************************************************************/
/* DEVICES ENUMERATOR */
/******************************************************************************/
/** @} */
/** @name Device Enumeration Functions
* @{ */
/******************************************************************************/
/* DEVICES ENUMERATOR */
/******************************************************************************/
/** @name Device Enumeration Functions
* @{ */
#define VBVMR_DEVTYPE_MME 1
#define VBVMR_DEVTYPE_WDM 3
@ -370,7 +441,7 @@ extern "C"
@return : return number of device found.
*/
long __stdcall VBVMR_Output_GetDeviceNumber(void);
long __stdcall VBVMR_Output_GetDeviceNumber(void);
/**
@brief Return pointer on Output Device Descriptor according index
@ -381,15 +452,15 @@ extern "C"
@return : 0: OK (no error).
*/
long __stdcall VBVMR_Output_GetDeviceDescA(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
long __stdcall VBVMR_Output_GetDeviceDescW(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
long __stdcall VBVMR_Output_GetDeviceDescA(long zindex, long * nType, char * szDeviceName, char * szHardwareId);
long __stdcall VBVMR_Output_GetDeviceDescW(long zindex, long * nType, unsigned short * wszDeviceName, unsigned short * wszHardwareId);
/**
@brief Get number of Audio Input Device available on the system
@return : return number of device found.
*/
long __stdcall VBVMR_Input_GetDeviceNumber(void);
long __stdcall VBVMR_Input_GetDeviceNumber(void);
/**
@brief Return pointer on Input Device Descriptor according index
@ -400,40 +471,50 @@ extern "C"
@return : 0: OK (no error).
*/
long __stdcall VBVMR_Input_GetDeviceDescA(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
long __stdcall VBVMR_Input_GetDeviceDescW(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
long __stdcall VBVMR_Input_GetDeviceDescA(long zindex, long * nType, char * szDeviceName, char * szHardwareId);
long __stdcall VBVMR_Input_GetDeviceDescW(long zindex, long * nType, unsigned short * wszDeviceName, unsigned short * wszHardwareId);
/** @} */
/******************************************************************************/
/* VB-AUDIO CALLBACK */
/******************************************************************************/
/* 4x Functions to process all voicemeeter audio input and output channels */
/* */
/* VBVMR_AudioCallbackRegister :to register your audio callback(s) */
/* VBVMR_AudioCallbackStart :to start the audio stream */
/* VBVMR_AudioCallbackStop :to stop the audio stream */
/* VBVMR_AudioCallbackUnregister :to unregister / Release callback(s) */
/******************************************************************************/
/** @name VB-Audio Callback Functions
* @{ */
/** @} */
typedef struct tagVBVMR_AUDIOINFO
{
/******************************************************************************/
/* VB-AUDIO CALLBACK */
/******************************************************************************/
/* 4x Functions to process all voicemeeter audio input and output channels */
/* */
/* VBVMR_AudioCallbackRegister :to register your audio callback(s) */
/* VBVMR_AudioCallbackStart :to start the audio stream */
/* VBVMR_AudioCallbackStop :to stop the audio stream */
/* VBVMR_AudioCallbackUnregister :to unregister / Release callback(s) */
/******************************************************************************/
/** @name VB-Audio Callback Functions
* @{ */
typedef struct tagVBVMR_AUDIOINFO
{
long samplerate;
long nbSamplePerFrame;
} VBVMR_T_AUDIOINFO, *VBVMR_PT_AUDIOINFO, *VBVMR_LPT_AUDIOINFO;
} VBVMR_T_AUDIOINFO, *VBVMR_PT_AUDIOINFO, *VBVMR_LPT_AUDIOINFO;
typedef struct tagVBVMR_AUDIOBUFFER
{
long audiobuffer_sr; //Sampling Rate
long audiobuffer_nbs; //number of sample per frame
long audiobuffer_nbi; //number of inputs
long audiobuffer_nbo; //number of outputs
float * audiobuffer_r[128]; //nbi input pointers containing frame of nbs sample (of 32bits float)
float * audiobuffer_w[128]; //nbo output pointers containing frame of nbs sample (of 32bits float)
} VBVMR_T_AUDIOBUFFER, *VBVMR_PT_AUDIOBUFFER, *VBVMR_LPT_AUDIOBUFFER;
typedef struct tagVBVMR_AUDIOBUFFER
{
long audiobuffer_sr; // Sampling Rate
long audiobuffer_nbs; // number of sample per frame
long audiobuffer_nbi; // number of inputs
long audiobuffer_nbo; // number of outputs
float *audiobuffer_r[128]; // nbi input pointers containing frame of nbs sample (of 32bits float)
float *audiobuffer_w[128]; // nbo output pointers containing frame of nbs sample (of 32bits float)
} VBVMR_T_AUDIOBUFFER, *VBVMR_PT_AUDIOBUFFER, *VBVMR_LPT_AUDIOBUFFER;
/**
@brief VB-AUDIO Callback is called for different task to Initialize, perform and end your process.
@ -452,21 +533,23 @@ extern "C"
@return : 0: always 0 (unused).
*/
typedef long(__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void *lpUser, long nCommand, void *lpData, long nnn);
#define VBVMR_CBCOMMAND_STARTING 1 // command to initialize data according SR and buffer size
// info = (VBVMR_LPT_AUDIOINFO)lpData
typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand, void * lpData, long nnn);
#define VBVMR_CBCOMMAND_ENDING 2 // command to release data
#define VBVMR_CBCOMMAND_CHANGE 3 // If change in audio stream, you will have to restart audio
#define VBVMR_CBCOMMAND_BUFFER_IN 10 // input insert
#define VBVMR_CBCOMMAND_BUFFER_OUT 11 // bus output insert
#define VBVMR_CBCOMMAND_BUFFER_MAIN 20 // all i/o
// audiobuffer = (VBVMR_LPT_AUDIOBUFFER)lpData
// nnn = synchro = 1 if synchro with Voicemeeter
#define VBVMR_CBCOMMAND_STARTING 1 //command to initialize data according SR and buffer size
//info = (VBVMR_LPT_AUDIOINFO)lpData
/*
#define VBVMR_CBCOMMAND_ENDING 2 //command to release data
#define VBVMR_CBCOMMAND_CHANGE 3 //If change in audio stream, you will have to restart audio
#define VBVMR_CBCOMMAND_BUFFER_IN 10 //input insert
#define VBVMR_CBCOMMAND_BUFFER_OUT 11 //bus output insert
#define VBVMR_CBCOMMAND_BUFFER_MAIN 20 //all i/o
//audiobuffer = (VBVMR_LPT_AUDIOBUFFER)lpData
//nnn = synchro = 1 if synchro with Voicemeeter
/*
-----------------------------------------------------
AUDIO BUFFER for VBVMR_CBCOMMAND_BUFFER_IN
-----------------------------------------------------
@ -489,9 +572,9 @@ extern "C"
| 00 | 01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 |
-----------------------------------------------------
-----------------------------------------------------
AUDIO BUFFER for VBVMR_CBCOMMAND_BUFFER_OUT
-----------------------------------------------------
-----------------------------------------------------
VOICEMEETER
| Output A1 / A2 | Virtual Output |
@ -520,9 +603,9 @@ extern "C"
| 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 |
-----------------------------------------------------
-----------------------------------------------------
AUDIO BUFFER for VBVMR_CBCOMMAND_BUFFER_MAIN
-----------------------------------------------------
-----------------------------------------------------
VOICEMEETER
| Strip 1 | Strip 2 | Virtual Input |
@ -573,7 +656,7 @@ extern "C"
| 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 |
*/
*/
/**
@brief register your audio callback function to receive real time audio buffer
@ -595,11 +678,11 @@ extern "C"
1: callback already registered (by another application).
*/
long __stdcall VBVMR_AudioCallbackRegister(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void *lpUser, char szClientName[64]);
long __stdcall VBVMR_AudioCallbackRegister(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void * lpUser, char szClientName[64]);
#define VBVMR_AUDIOCALLBACK_IN 0x00000001 // to process input insert
#define VBVMR_AUDIOCALLBACK_OUT 0x00000002 // to process output bus insert
#define VBVMR_AUDIOCALLBACK_MAIN 0x00000004 // to receive all i/o
#define VBVMR_AUDIOCALLBACK_IN 0x00000001 //to process input insert
#define VBVMR_AUDIOCALLBACK_OUT 0x00000002 //to process output bus insert
#define VBVMR_AUDIOCALLBACK_MAIN 0x00000004 //to receive all i/o
/**
@brief Start / Stop Audio processing
@ -610,8 +693,9 @@ extern "C"
-2: no callback registred.
*/
long __stdcall VBVMR_AudioCallbackStart(void);
long __stdcall VBVMR_AudioCallbackStop(void);
long __stdcall VBVMR_AudioCallbackStart(void);
long __stdcall VBVMR_AudioCallbackStop(void);
/**
@brief unregister your callback to release voicemeeter virtual driver
@ -622,18 +706,25 @@ extern "C"
1: callback already unregistered.
*/
long __stdcall VBVMR_AudioCallbackUnregister(void);
long __stdcall VBVMR_AudioCallbackUnregister(void);
/** @} */
/******************************************************************************/
/* */
/* Macro Buttons */
/* */
/******************************************************************************/
/** @name Macro Buttons functions
* @{ */
/** @} */
/******************************************************************************/
/* */
/* Macro Buttons */
/* */
/******************************************************************************/
/** @name Macro Buttons functions
* @{ */
/**
@brief Check if Macro Buttons states changed.
@ -646,7 +737,7 @@ extern "C"
-2: no server.
*/
long __stdcall VBVMR_MacroButton_IsDirty(void);
long __stdcall VBVMR_MacroButton_IsDirty(void);
/**
@brief get current status of a given button.
@ -660,7 +751,7 @@ extern "C"
-5: structure mismatch
*/
long __stdcall VBVMR_MacroButton_GetStatus(long nuLogicalButton, float *pValue, long bitmode);
long __stdcall VBVMR_MacroButton_GetStatus(long nuLogicalButton, float * pValue, long bitmode);
/**
@brief set current button value.
@ -674,59 +765,72 @@ extern "C"
-5: structure mismatch
*/
long __stdcall VBVMR_MacroButton_SetStatus(long nuLogicalButton, float fValue, long bitmode);
long __stdcall VBVMR_MacroButton_SetStatus(long nuLogicalButton, float fValue, long bitmode);
#define VBVMR_MACROBUTTON_MODE_DEFAULT 0x00000000 // PUSH or RELEASE button
#define VBVMR_MACROBUTTON_MODE_STATEONLY 0x00000002 // change Displayed State only
#define VBVMR_MACROBUTTON_MODE_TRIGGER 0x00000003 // change Trigger State
#define VBVMR_MACROBUTTON_MODE_COLOR 0x00000004 // change color
#define VBVMR_MACROBUTTON_MODE_DEFAULT 0x00000000 //PUSH or RELEASE button
#define VBVMR_MACROBUTTON_MODE_STATEONLY 0x00000002 //change Displayed State only
#define VBVMR_MACROBUTTON_MODE_TRIGGER 0x00000003 //change Trigger State
#define VBVMR_MACROBUTTON_MODE_COLOR 0x00000004 //change color
/** @} */
/******************************************************************************/
/* 'C' STRUCTURED INTERFACE */
/******************************************************************************/
typedef long(__stdcall *T_VBVMR_Login)(void);
typedef long(__stdcall *T_VBVMR_Logout)(void);
typedef long(__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
/** @} */
typedef long(__stdcall *T_VBVMR_GetVoicemeeterType)(long *pType);
typedef long(__stdcall *T_VBVMR_GetVoicemeeterVersion)(long *pVersion);
typedef long(__stdcall *T_VBVMR_IsParametersDirty)(void);
typedef long(__stdcall *T_VBVMR_GetParameterFloat)(char *szParamName, float *pValue);
typedef long(__stdcall *T_VBVMR_GetParameterStringA)(char *szParamName, char *szString);
typedef long(__stdcall *T_VBVMR_GetParameterStringW)(char *szParamName, unsigned short *wszString);
typedef long(__stdcall *T_VBVMR_GetLevel)(long nType, long nuChannel, float *pValue);
typedef long(__stdcall *T_VBVMR_GetMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long(__stdcall *T_VBVMR_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long(__stdcall *T_VBVMR_SetParameterFloat)(char *szParamName, float Value);
typedef long(__stdcall *T_VBVMR_SetParameters)(char *szParamScript);
typedef long(__stdcall *T_VBVMR_SetParametersW)(unsigned short *szParamScript);
typedef long(__stdcall *T_VBVMR_SetParameterStringA)(char *szParamName, char *szString);
typedef long(__stdcall *T_VBVMR_SetParameterStringW)(char *szParamName, unsigned short *wszString);
typedef long(__stdcall *T_VBVMR_Output_GetDeviceNumber)(void);
typedef long(__stdcall *T_VBVMR_Output_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
typedef long(__stdcall *T_VBVMR_Output_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
typedef long(__stdcall *T_VBVMR_Input_GetDeviceNumber)(void);
typedef long(__stdcall *T_VBVMR_Input_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
typedef long(__stdcall *T_VBVMR_Input_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
typedef long(__stdcall *T_VBVMR_AudioCallbackRegister)(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void *lpUser, char szClientName[64]);
typedef long(__stdcall *T_VBVMR_AudioCallbackStart)(void);
typedef long(__stdcall *T_VBVMR_AudioCallbackStop)(void);
typedef long(__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
typedef long(__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
typedef long(__stdcall *T_VBVMR_MacroButton_GetStatus)(long nuLogicalButton, float *pValue, long bitmode);
typedef long(__stdcall *T_VBVMR_MacroButton_SetStatus)(long nuLogicalButton, float fValue, long bitmode);
typedef struct tagVBVMR_INTERFACE
{
/******************************************************************************/
/* 'C' STRUCTURED INTERFACE */
/******************************************************************************/
typedef long (__stdcall *T_VBVMR_Login)(void);
typedef long (__stdcall *T_VBVMR_Logout)(void);
typedef long (__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
typedef long (__stdcall *T_VBVMR_GetVoicemeeterType)(long * pType);
typedef long (__stdcall *T_VBVMR_GetVoicemeeterVersion)(long * pVersion);
typedef long (__stdcall *T_VBVMR_IsParametersDirty)(void);
typedef long (__stdcall *T_VBVMR_GetParameterFloat)(char * szParamName, float * pValue);
typedef long (__stdcall *T_VBVMR_GetParameterStringA)(char * szParamName, char * szString);
typedef long (__stdcall *T_VBVMR_GetParameterStringW)(char * szParamName, unsigned short * wszString);
typedef long (__stdcall *T_VBVMR_GetLevel)(long nType, long nuChannel, float * pValue);
typedef long (__stdcall *T_VBVMR_GetMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long (__stdcall *T_VBVMR_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long (__stdcall *T_VBVMR_SetParameterFloat)(char * szParamName, float Value);
typedef long (__stdcall *T_VBVMR_SetParameters)(char * szParamScript);
typedef long (__stdcall *T_VBVMR_SetParametersW)(unsigned short * szParamScript);
typedef long (__stdcall *T_VBVMR_SetParameterStringA)(char * szParamName, char * szString);
typedef long (__stdcall *T_VBVMR_SetParameterStringW)(char * szParamName, unsigned short * wszString);
typedef long (__stdcall *T_VBVMR_Output_GetDeviceNumber)(void);
typedef long (__stdcall *T_VBVMR_Output_GetDeviceDescA)(long zindex, long * nType, char * szDeviceName, char * szHardwareId);
typedef long (__stdcall *T_VBVMR_Output_GetDeviceDescW)(long zindex, long * nType, unsigned short * wszDeviceName, unsigned short * wszHardwareId);
typedef long (__stdcall *T_VBVMR_Input_GetDeviceNumber)(void);
typedef long (__stdcall *T_VBVMR_Input_GetDeviceDescA)(long zindex, long * nType, char * szDeviceName, char * szHardwareId);
typedef long (__stdcall *T_VBVMR_Input_GetDeviceDescW)(long zindex, long * nType, unsigned short * wszDeviceName, unsigned short * wszHardwareId);
typedef long (__stdcall *T_VBVMR_AudioCallbackRegister)(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void * lpUser, char szClientName[64]);
typedef long (__stdcall *T_VBVMR_AudioCallbackStart)(void);
typedef long (__stdcall *T_VBVMR_AudioCallbackStop)(void);
typedef long (__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
typedef long (__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
typedef long (__stdcall *T_VBVMR_MacroButton_GetStatus)(long nuLogicalButton, float * pValue, long bitmode);
typedef long (__stdcall *T_VBVMR_MacroButton_SetStatus)(long nuLogicalButton, float fValue, long bitmode);
typedef struct tagVBVMR_INTERFACE
{
T_VBVMR_Login VBVMR_Login;
T_VBVMR_Logout VBVMR_Logout;
T_VBVMR_RunVoicemeeter VBVMR_RunVoicemeeter;
@ -763,27 +867,34 @@ extern "C"
T_VBVMR_MacroButton_GetStatus VBVMR_MacroButton_GetStatus;
T_VBVMR_MacroButton_SetStatus VBVMR_MacroButton_SetStatus;
} T_VBVMR_INTERFACE, *PT_VBVMR_INTERFACE, *LPT_VBVMR_INTERFACE, *PT_VMR;
} T_VBVMR_INTERFACE, *PT_VBVMR_INTERFACE, *LPT_VBVMR_INTERFACE;
#ifdef VBUSE_LOCALLIB
// internal used (not public)
void __stdcall VBVMR_SetHinstance(HINSTANCE hinst);
#endif
/******************************************************************************/
/* VBAN RT PACKET */
/******************************************************************************/
/******************************************************************************/
/* VBAN RT PACKET */
/******************************************************************************/
#pragma pack(1)
// short = 2 bytes
// char = 1 byte
// short = 2 bytes
// char = 1 byte
// COMPATIBILITY: defined structure cannot be changed.
// some field could be added at the end of the structure to keep the compatibility in the time.
// COMPATIBILITY: defined structure cannot be changed.
// some field could be added at the end of the structure to keep the compatibility in the time.
typedef struct tagVBAN_VMRT_PACKET // packedt ident: 0
{
typedef struct tagVBAN_VMRT_PACKET //packedt ident: 0
{
unsigned char voicemeeterType; // 1 = Voicemeeter, 2= Voicemeeter Banana, 3 Potato
unsigned char reserved; // unused
unsigned short buffersize; // main stream buffer size
@ -806,9 +917,9 @@ extern "C"
short busGaindB100[8]; // Bus Gain in dB * 100
char stripLabelUTF8c60[8][60]; // Strip Label
char busLabelUTF8c60[8][60]; // Bus Label
} T_VBAN_VMRT_PACKET, *PT_VBAN_VMRT_PACKET, *LPT_VBAN_VMRT_PACKET;
} T_VBAN_VMRT_PACKET, *PT_VBAN_VMRT_PACKET, *LPT_VBAN_VMRT_PACKET;
#define expected_size_T_VBAN_VMRT_PACKET 1384 // 1436 max
#define expected_size_T_VBAN_VMRT_PACKET 1384 //1436 max
#pragma pack()
@ -860,15 +971,16 @@ extern "C"
#define VMRTSTATE_MODE_SEL 0x10000000
#define VMRTSTATE_MODE_MONITOR 0x20000000
#pragma pack(1)
// long = 4 bytes
// short = 2 bytes
// char = 1 byte
// float = 4 bytes
// long = 4 bytes
// short = 2 bytes
// char = 1 byte
// float = 4 bytes
typedef struct tagVBAN_VMPARAM_STRIP
{
typedef struct tagVBAN_VMPARAM_STRIP
{
long mode;
float dblevel; // x 100
short Audibility; // x 100
@ -880,7 +992,7 @@ extern "C"
short EQgain2; // x 100
short EQgain3; // x 100
// first channel parametric EQ
//first channel parametric EQ
char PEQ_eqOn[6]; // 0 or 1
char PEQ_eqtype[6]; // see define below
float PEQ_eqgain[6];
@ -924,7 +1036,7 @@ extern "C"
short Pitch_formant_med; // x 100
short Pitch_formant_high; // x 100
} T_VBAN_VMPARAM_STRIP, *PT_VBAN_VMPARAM_STRIP, *LPT_VBAN_VMPARAM_STRIP;
} T_VBAN_VMPARAM_STRIP, *PT_VBAN_VMPARAM_STRIP, *LPT_VBAN_VMPARAM_STRIP;
#define VMRT_EQTYPE_PEQ 0
#define VMRT_EQTYPE_NOTCH 1
@ -934,11 +1046,12 @@ extern "C"
#define VMRT_EQTYPE_LOSHELF 5
#define VMRT_EQTYPE_HISHELF 6
#define expected_size_T_VBAN_VMPARAM_STRIP (8 + (8 * sizeof(short)) + (2 * 6) + (3 * 6 * sizeof(float)) + ((11 + 9 + 6 + 7) * sizeof(short)))
// 170
typedef struct tagVBAN_VMPARAMSTRIP_PACKET // packedt ident: 1
{
#define expected_size_T_VBAN_VMPARAM_STRIP (8+ (8 * sizeof(short)) + (2*6) + (3 * 6 * sizeof(float)) + ((11 + 9 + 6 + 7) * sizeof(short)))
//170
typedef struct tagVBAN_VMPARAMSTRIP_PACKET //packedt ident: 1
{
unsigned char voicemeeterType; // 1 = Voicemeeter, 2= Voicemeeter Banana, 3 Potato
unsigned char reserved; // unused
unsigned short buffersize; // main stream buffer size
@ -946,29 +1059,35 @@ extern "C"
unsigned long optionBits; // unused
unsigned long samplerate; // main stream samplerate
T_VBAN_VMPARAM_STRIP Strips[8]; // all input strips
} T_VBAN_VMPARAMSTRIP_PACKET, *PT_VBAN_VMPARAMSTRIP_PACKET, *LPT_VBAN_VMPARAMSTRIP_PACKET;
} T_VBAN_VMPARAMSTRIP_PACKET, *PT_VBAN_VMPARAMSTRIP_PACKET, *LPT_VBAN_VMPARAMSTRIP_PACKET;
#pragma pack()
#define expected_size_T_VBAN_VMPARAMSTRIP_PACKET ((4 * 4) + (expected_size_T_VBAN_VMPARAM_STRIP * 8)) // 1436 max
// 1376
#define expected_size_T_VBAN_VMPARAMSTRIP_PACKET ((4 * 4) + (expected_size_T_VBAN_VMPARAM_STRIP * 8)) //1436 max
//1376
/******************************************************************************/
/* LOCAL FUNCTIONS */
/******************************************************************************/
/******************************************************************************/
/* LOCAL FUNCTIONS */
/******************************************************************************/
long VBVMR_LocalInit(void);
long VBVMR_LocalEnd(void);
void * VBVMR_GetRequestVB0STREAMPTR(void);
long VBVMR_SetParametersWEx(unsigned short * szParamScript, long fCopyToClient);
long VBVMR_LoginEx(long properties);
long VBVMR_MB_PushSettings(void * lpParam);
long VBVMR_LocalInit(void);
long VBVMR_LocalEnd(void);
void *VBVMR_GetRequestVB0STREAMPTR(void);
long VBVMR_SetParametersWEx(unsigned short *szParamScript, long fCopyToClient);
long VBVMR_LoginEx(long properties);
long VBVMR_MB_PushSettings(void *lpParam);
#ifdef __cplusplus
}
#endif
#endif /*__VOICEMEETER_REMOTE_H__*/

9
include/cdll.h Normal file
View File

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

17
include/interface.h
View File

@ -1,17 +0,0 @@
/**
* 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"
#define IS_64_BIT sizeof(void *) == 8
PT_VMR create_interface();
#endif /* __IVMR_H__ */

23
include/util.h
View File

@ -1,23 +0,0 @@
/**
* 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__
struct quickcommand
{
char *name;
char *fullcommand;
};
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);
bool is_comment(char *s);
struct quickcommand *command_in_quickcommands(const char *command, const struct quickcommand *quickcommands, int n);
#endif /* __UTIL_H__ */

34
include/vmr.h Normal file
View File

@ -0,0 +1,34 @@
#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
View File

@ -1,46 +0,0 @@
/**
* 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 : int
{
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, wchar_t *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(PT_VMR vmr, bool (*f)(PT_VMR));
#endif /* __WRAPPER_H__ */

27
makefile
View File

@ -1,53 +1,34 @@
# 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
CPPFLAGS := -Iinclude -MMD -MP
CFLAGS = -O -Wall -W -pedantic -ansi -std=c99
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 $(BIN_DIR), $(OBJ_DIR) -force
pwsh -Command Remove-Item -Recurse $(EXE)
pwsh -Command Remove-Item -Recurse $(OBJ_DIR)
# Include dependency files
-include $(OBJ:.o=.d)

170
src/cdll.c Normal file
View File

@ -0,0 +1,170 @@
#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;
}

234
src/interface.c
View File

@ -1,234 +0,0 @@
/**
* @file interface.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.11.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 <windows.h>
#include "interface.h"
#include "util.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 long initialize_dll_interfaces(PT_VMR vmr);
static bool registry_get_voicemeeter_folder(char *dll_fullpath);
/**
* @brief Create an interface object
*
* @return PT_VMR Pointer to the iVMR interface
* May return NULL if the interface fails to initialize
*/
PT_VMR create_interface()
{
PT_VMR vmr = malloc(sizeof(T_VBVMR_INTERFACE));
if (vmr == NULL)
{
log_error("malloc failed to allocate memory");
return NULL;
}
LONG rep = initialize_dll_interfaces(vmr);
if (rep < 0)
{
if (rep == -100)
{
log_fatal("Voicemeeter is not installed");
}
else
{
log_fatal("Error loading Voicemeeter dll with code %d", rep);
}
free(vmr);
vmr = NULL;
}
return vmr;
}
/*******************************************************************************/
/** GET DLL INTERFACE **/
/*******************************************************************************/
#define DLL_FULLPATH_SZ 1024
#define DLL64_NAME "\\VoicemeeterRemote64.dll"
#define DLL32_NAME "\\VoicemeeterRemote.dll"
static long initialize_dll_interfaces(PT_VMR vmr)
{
HMODULE G_H_Module = NULL;
char dll_fullpath[DLL_FULLPATH_SZ];
memset(vmr, 0, sizeof(T_VBVMR_INTERFACE));
// get Voicemeeter installation directory
if (!registry_get_voicemeeter_folder(dll_fullpath))
{
// Voicemeeter not installed
return -100;
}
// use right dll according to O/S type
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);
// Load Dll
G_H_Module = LoadLibrary(dll_fullpath);
if (G_H_Module == NULL)
return -101;
PRAGMA_IgnoreWCastIncompatibleFuncTypes;
// 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");
PRAGMA_Pop;
// check pointers are valid
if (vmr->VBVMR_Login == NULL)
return -1;
if (vmr->VBVMR_Logout == NULL)
return -2;
if (vmr->VBVMR_RunVoicemeeter == NULL)
return -3;
if (vmr->VBVMR_GetVoicemeeterType == NULL)
return -4;
if (vmr->VBVMR_GetVoicemeeterVersion == NULL)
return -5;
if (vmr->VBVMR_IsParametersDirty == NULL)
return -6;
if (vmr->VBVMR_GetParameterFloat == NULL)
return -7;
if (vmr->VBVMR_GetParameterStringA == NULL)
return -8;
if (vmr->VBVMR_GetParameterStringW == NULL)
return -9;
if (vmr->VBVMR_GetLevel == NULL)
return -10;
if (vmr->VBVMR_SetParameterFloat == NULL)
return -11;
if (vmr->VBVMR_SetParameters == NULL)
return -12;
if (vmr->VBVMR_SetParametersW == NULL)
return -13;
if (vmr->VBVMR_SetParameterStringA == NULL)
return -14;
if (vmr->VBVMR_SetParameterStringW == NULL)
return -15;
if (vmr->VBVMR_GetMidiMessage == NULL)
return -16;
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_DIR_KEY "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall"
#define INSTALLER_UNINST_KEY "VB:Voicemeeter {17359A74-1236-5467}"
#ifndef KEY_WOW64_32KEY
#define KEY_WOW64_32KEY 0x0200
#endif
#define UNINSTALL_KEY_SZ 256
#define UNINSTALL_PATH_SZ 1024
static bool registry_get_voicemeeter_folder(char *dll_fullpath)
{
// build Voicemeeter uninstallation key
char uninstall_key[UNINSTALL_KEY_SZ];
snprintf(uninstall_key, UNINSTALL_KEY_SZ, "%s\\%s", INSTALLER_DIR_KEY, INSTALLER_UNINST_KEY);
// open key
HKEY result;
LONG rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, uninstall_key, 0, KEY_READ, &result);
if (rep != ERROR_SUCCESS)
{
// if not present we consider running in 64bit mode and force to read 32bit registry
rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, uninstall_key, 0, KEY_READ | KEY_WOW64_32KEY, &result);
}
if (rep != ERROR_SUCCESS)
return false;
// read uninstall path from registry
DWORD pptype = REG_SZ;
DWORD len_uninstall_path = UNINSTALL_PATH_SZ;
char uninstall_path[UNINSTALL_PATH_SZ] = {0};
rep = RegQueryValueEx(result, "UninstallString", 0, &pptype, (unsigned char *)uninstall_path, &len_uninstall_path);
RegCloseKey(result);
if (pptype != REG_SZ)
return false;
if (rep != ERROR_SUCCESS)
return false;
// remove name to get the path only
remove_last_part_of_path(uninstall_path);
snprintf(dll_fullpath, DLL_FULLPATH_SZ, uninstall_path);
return true;
}

4
src/log.c
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)

103
src/util.c
View File

@ -1,103 +0,0 @@
/**
* @file util.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Utility functions.
* @version 0.11.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <stdio.h>
#include <string.h>
#include "util.h"
/**
* @brief Removes the last part of a path
*
* @param fullpath
*/
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 receiving the kind
* @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 receiving the version
* @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;
}
/**
* @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, const struct quickcommand *quickcommands, int n)
{
for (int i = 0; i < n; ++i)
{
if (strcmp(command_key, quickcommands[i].name) == 0)
{
return (struct quickcommand *)(quickcommands + i);
}
}
return NULL;
}

143
src/vmr.c Normal file
View File

@ -0,0 +1,143 @@
#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);
}

380
src/vmrcli.c
View File

@ -1,121 +1,66 @@
/**
* @file vmrcli.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief A Voicemeeter Remote Command Line Interface
* @version 0.11.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 <windows.h>
#include "interface.h"
#include "wrapper.h"
#include "cdll.h"
#include "vmr.h"
#include "log.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 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 MAX_LINE 512
/**
* @enum The kind of values a get call may return.
*/
enum restype : int
enum
{
FLOAT_T,
STRING_T,
};
/**
* @struct A struct used for:
* - tracking the type of value stored
* - storing the result of a get call
*/
struct result
{
enum restype type;
int type;
union val
{
float f;
wchar_t s[RES_SZ];
char s[MAX_LINE];
} val;
};
static bool vflag = 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 parse_command(PT_VMR vmr, char *command);
static void get(PT_VMR vmr, char *command, struct result *res);
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);
int main(int argc, char *argv[])
{
bool iflag = false,
mflag = false,
sflag = false,
cflag = false,
with_prompt = true;
bool iflag = false;
int opt;
char *kvalue = "";
int dvalue;
char *cvalue;
enum kind kind = BANANAX64;
int kind = BANANA;
if (argc == 1)
{
usage();
help();
exit(EXIT_SUCCESS);
}
log_set_level(LOG_WARN);
opterr = 0;
while ((opt = getopt(argc, argv, OPTSTR)) != -1)
while ((opt = getopt(argc, argv, "k:ihD:")) != -1)
{
switch (opt)
{
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':
with_prompt = false;
[[fallthrough]];
case 'i':
iflag = true;
break;
case 'k':
kvalue = optarg;
kind = set_kind(kvalue);
break;
case 'h':
help();
exit(EXIT_SUCCESS);
case 'D':
dvalue = atoi(optarg);
if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
@ -124,212 +69,138 @@ int main(int argc, char *argv[])
}
else
{
log_warn(
fputs(
"-D arg out of range, expected value from 0 up to 5\n"
"Log level will default to LOG_WARN (3).\n");
"Log level will default to LOG_WARN (3).\n",
stderr);
}
break;
case 'v':
vflag = true;
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:
usage();
abort();
}
}
PT_VMR vmr = create_interface();
if (vmr == NULL)
{
exit(EXIT_FAILURE);
}
T_VBVMR_INTERFACE iVMR;
T_VBVMR_INTERFACE *vmr = &iVMR;
long rep = login(vmr, kind);
int rep = init_voicemeeter(vmr, kind);
if (rep != 0)
{
if (rep == -2)
terminate(vmr, "Timeout logging into the API.");
else
terminate(vmr, "Error logging into the Voicemeeter API");
}
if (mflag)
{
run_voicemeeter(vmr, MACROBUTTONS);
log_info("MacroButtons app launched");
}
if (sflag)
{
run_voicemeeter(vmr, STREAMERVIEW);
log_info("StreamerView app launched");
}
if (cflag)
{
set_parameter_string(vmr, "command.load", cvalue);
log_info("Profile %s loaded", cvalue);
Sleep(300);
clear(vmr, is_pdirty);
exit(EXIT_FAILURE);
}
if (iflag)
{
puts("Interactive mode enabled. Enter 'Q' to exit.");
interactive(vmr, with_prompt);
interactive(vmr);
}
else
{
for (int i = optind; i < argc; ++i)
for (int i = optind; i < argc; i++)
{
parse_input(vmr, argv[i]);
parse_command(vmr, argv[i]);
}
}
rep = logout(vmr);
if (rep != 0)
{
terminate(vmr, "Error logging out of the Voicemeeter API");
}
log_info("Successfully logged out of the Voicemeeter API");
free(vmr);
if (rep == 0)
return EXIT_SUCCESS;
else
return EXIT_FAILURE;
}
/**
* @brief Write fatal error log, free dyn allocated memory then exit
*
* @param vmr Pointer to the iVMR interface
* @param msg Fatal error message
*/
static void terminate(PT_VMR vmr, char *msg)
void help()
{
log_fatal(msg);
free(vmr);
exit(EXIT_FAILURE);
puts(
"Usage: ./vmrcli.exe [-i] [-k] [-D] <api commands>\n"
"Where: \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");
}
/**
* @brief Prints the help message
*/
static void usage()
{
puts(USAGE);
exit(EXIT_SUCCESS);
}
/**
* @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
*/
static enum kind set_kind(char *kval)
int set_kind(char *kval)
{
if (strcmp(kval, "basic") == 0)
return IS_64_BIT ? BASICX64 : BASIC;
{
return BASIC;
}
else if (strcmp(kval, "banana") == 0)
return IS_64_BIT ? BANANAX64 : BANANA;
{
return BANANA;
}
else if (strcmp(kval, "potato") == 0)
return IS_64_BIT ? POTATOX64 : POTATO;
{
if (sizeof(void *) == 8)
return POTATOX64;
else
return UNKNOWN;
return POTATO;
}
else
{
fprintf(stderr, "Unknown Voicemeeter kind '%s'\n", kval);
exit(EXIT_FAILURE);
}
}
/**
* @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
* @param with_prompt If true, prints the interactive prompt '>>'
*/
static void interactive(PT_VMR vmr, bool with_prompt)
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)
{
char input[MAX_LINE];
size_t len;
char *p = input;
if (with_prompt)
printf(">> ");
while (fgets(input, MAX_LINE, stdin) != NULL)
{
input[(len = strcspn(input, "\n"))] = 0;
if (len == 1 && toupper(input[0]) == 'Q')
input[strcspn(input, "\n")] = 0;
if (strlen(input) == 1 && (strncmp(input, "Q", 1) == 0 || strncmp(input, "q", 1) == 0))
break;
parse_input(vmr, input);
if (with_prompt)
printf(">> ");
}
}
/**
* @brief Returns early if input is a comment
* 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
*/
static void parse_input(PT_VMR vmr, char *input)
{
if (is_comment(input))
return;
char *token, *p;
token = strtok_r(input, DELIMITERS, &p);
while (token != NULL)
while (*p)
{
parse_command(vmr, token);
token = strtok_r(NULL, DELIMITERS, &p);
char command[MAX_LINE];
int i = 0;
while (!isspace(*p))
command[i++] = *p++;
command[i] = '\0';
p++; /* shift to next char */
parse_command(vmr, command);
}
p = input; /* reset pointer */
}
}
/**
* @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
*/
static void parse_command(PT_VMR vmr, char *command)
void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
{
log_debug("Parsing %s", command);
static const 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"}};
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 */
{
command++;
@ -337,17 +208,8 @@ static void parse_command(PT_VMR 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;
}
@ -355,10 +217,6 @@ static void parse_command(PT_VMR vmr, char *command)
if (strchr(command, '=') != NULL) /* set */
{
set_parameters(vmr, command);
if (vflag)
{
printf("Setting %s\n", command);
}
}
else /* get */
{
@ -368,36 +226,30 @@ static void parse_command(PT_VMR vmr, char *command)
switch (res.type)
{
case FLOAT_T:
printf("%s: %.1f\n", command, res.val.f);
printf("%.1f\n", res.val.f);
break;
case STRING_T:
if (res.val.s[0] != '\0')
printf("%s: %ls\n", command, res.val.s);
puts(res.val.s);
break;
default:
fputs("Unexpected result type", stderr);
break;
}
}
}
/**
* @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 Pointer to a struct holding the result of the API call.
*/
static void get(PT_VMR vmr, char *command, struct result *res)
struct result *get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
{
clear(vmr, is_pdirty);
clear_dirty(vmr);
if (get_parameter_float(vmr, command, &res->val.f) != 0)
{
res->type = STRING_T;
if (get_parameter_string(vmr, command, res->val.s) != 0)
{
res->val.s[0] = 0;
log_error("Unknown parameter '%s'", command);
fputs("Unknown parameter", stderr);
}
}
return res;
}

268
src/wrapper.c
View File

@ -1,268 +0,0 @@
/**
* @file wrapper.c
* @author Onyx and Iris (code@onyxandiris.online)
* @brief Provides public functions that wrap the iVMR calls
* @version 0.11.0
* @date 2024-07-06
*
* @copyright Copyright (c) 2024
* https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
*/
#include <windows.h>
#include "wrapper.h"
#include "log.h"
#include "util.h"
#define KIND_STR_LEN 64
#define VERSION_STR_LEN 32
#define LOGIN_TIMEOUT 2
/**
* @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
* 0: OK (no error).
* -2: Login timed out.
*/
long login(PT_VMR vmr, int kind)
{
long 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));
}
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));
clear(vmr, is_pdirty);
break;
}
Sleep(50);
} while (difftime(time(NULL), start) < LOGIN_TIMEOUT);
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 See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L56
*/
long logout(PT_VMR vmr)
{
Sleep(20); /* give time for last command */
log_trace("VBVMR_Logout()");
return vmr->VBVMR_Logout();
}
/**
* @brief Launches Voicemeeter or other utility apps
*
* @param vmr Pointer to the iVMR interface
* @param kind The kind of app to launch
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L66
*/
long run_voicemeeter(PT_VMR vmr, int kind)
{
log_trace("VBVMR_RunVoicemeeter(%d)", kind);
return vmr->VBVMR_RunVoicemeeter((long)kind);
}
/**
* @brief Get Voicemeeter type
*
* @param vmr Pointer to the iVMR interface
* @param type Pointer to a long object receiving the type
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L107
*/
long type(PT_VMR vmr, long *type)
{
log_trace("VBVMR_GetVoicemeeterType(<long> *t)");
return vmr->VBVMR_GetVoicemeeterType(type);
}
/**
* @brief Get Voicemeeter version
*
* @param vmr Pointer to the iVMR interface
* @param version Pointer to a long object receiving the version
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L122
*/
long version(PT_VMR vmr, long *version)
{
log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)");
return vmr->VBVMR_GetVoicemeeterVersion(version);
}
/**
* @brief Polling function, use it to determine if there are parameter
* states to be updated.
*
* @param vmr Pointer to the iVMR interface
* @return true New parameters yet to be updated
* @return false No new parameters, safe to make a get call
*/
bool is_pdirty(PT_VMR vmr)
{
log_trace("VBVMR_IsParametersDirty()");
return vmr->VBVMR_IsParametersDirty() == 1;
}
/**
* @brief Get the parameter float object
*
* @param vmr Pointer to the iVMR interface
* @param param The parameter to be queried
* @param f Pointer to a float object receiving the value
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L159
*/
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);
}
/**
* @brief Get the parameter string object
*
* @param vmr Pointer to the iVMR interface
* @param param The parameter to be queried
* @param s Pointer to a character buffer receiving the string value
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L173
*/
long get_parameter_string(PT_VMR vmr, char *param, wchar_t *s)
{
log_trace("VBVMR_GetParameterStringW(%s, <wchar_t> *s)", param);
return vmr->VBVMR_GetParameterStringW(param, s);
}
/**
* @brief Set the parameter float object
*
* @param vmr Pointer to the iVMR interface
* @param param The parameter to be updated
* @param val The new value
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L309
*/
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);
}
/**
* @brief Set the parameter string object
*
* @param vmr Pointer to the iVMR interface
* @param param The parameter to be updated
* @param s Pointer to a char[] object containing the new value
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L327
*/
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);
}
/**
* @brief Run a script possibly containing multiple instructions
*
* @param vmr Pointer to the iVMR interface
* @param command Pointer to a char[] object containing the script
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L351
*/
long set_parameters(PT_VMR vmr, char *command)
{
log_trace("VBVMR_SetParameters(%s)", command);
return vmr->VBVMR_SetParameters(command);
}
/**
* @brief Polling function, use it to determine if there are macrobutton
* states to be updated.
*
* @param vmr Pointer to the iVMR interface
* @return true Macrobutton states yet to be udpated
* @return false No new macrobutton states
*/
bool is_mdirty(PT_VMR vmr)
{
log_trace("VBVMR_MacroButton_IsDirty()");
return vmr->VBVMR_MacroButton_IsDirty() >= 0;
}
/**
* @brief Get the current status of macrobutton[n].{mode}
*
* @param vmr Pointer to the iVMR interface
* @param n Index of the macrobutton
* @param val Pointer to a float object the current value will be stored in
* @param mode The mode (stateonly, state, trigger)
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L663
*/
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);
}
/**
* @brief Set the current status of macrobutton[n].{mode}
*
* @param vmr Pointer to the iVMR interface
* @param n Index of the macrobutton
* @param val Value to be updated
* @param mode The mode (stateonly, state, trigger)
* @return long See:
* https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L677
*/
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);
}
/**
* @brief Continuously polls an is_{}dirty function until it clears.
*
* @param vmr Pointer to the iVMR interface
* @param f Pointer to a polling function
*/
void clear(PT_VMR vmr, bool (*f)(PT_VMR))
{
Sleep(30);
while (f(vmr))
Sleep(1);
}