14 Commits

Author SHA1 Message Date
f6437fcbe7 make static 2024-07-03 17:52:08 +01:00
fb54c4a492 fixes compiler error 'Incompatible pointer types' 2024-07-03 15:25:16 +01:00
8aeb793a41 fixes compiler error 'Forward declaration of enums' 2024-07-03 15:24:44 +01:00
b6b4b04a8a upd includes 2024-07-03 13:57:58 +01:00
b7fa15d87d log_warn an incorrect -D arg.
log_fatal possible exit points.
2024-07-03 12:58:34 +01:00
b95c40265c fix s flag in help message 2024-07-02 17:59:44 +01:00
4b64ae95fd add -m flag for launching macrobuttons app.
add -s flag for launching streamerview app

add -m, -s flags to Use section in README.
2024-07-02 17:49:51 +01:00
f8d2f80cbf remove the extra call to version 2024-07-02 14:49:42 +01:00
4b79b7f849 add -= example to README 2024-07-02 12:00:16 +01:00
3ec98ea391 add note about += and -= to README
add increment/decrement instructions to example_commands
2024-07-02 11:55:34 +01:00
faad5bc2c8 add doc comments 2024-07-02 11:15:17 +01:00
cc0ec73ef4 fix help dialogue 2024-07-02 10:25:25 +01:00
c45df11286 add -v flag to README use section 2024-07-02 10:24:07 +01:00
a383aaa36b reword
add link defs
2024-07-02 10:21:37 +01:00
10 changed files with 664 additions and 668 deletions

View File

@@ -13,28 +13,31 @@
## `Use`
```powershell
./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>
./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-m] [-s] <api commands>
```
Where:
- `h`: Prints the help dialogue.
- `h`: Prints the help message.
- `i`: Enable interactive mode. If set, any api commands passed on the command line will be ignored.
- `k`: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI.
- `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL
- `v`: Enable extra console output (toggle, set messages)
- `m`: Launch the MacroButtons application
- `s`: Launch the StreamerView application
## `API Commands`
- Commands starting with `!` will be toggled, use it with boolean parameters.
- Commands containing `=` will set a value.
- Commands containing `=` will set a value. (use `+=` and `-=` to increment/decrement)
- All other commands with get a value.
Examples:
Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, then print its new value
Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, print its new value, then decrease Bus 0 Gain by 3.8
```powershell
./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute
./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
@@ -74,14 +77,19 @@ Multiple API commands can be in a single line but they should be space separated
Run the included `makefile` with [GNU Make](https://www.gnu.org/software/make/).
By default the log.c module is built with coloured logging enabled. To disable this you can override the `LOG_USE_COLOR` variable, for example:
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](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
- [Voicemeeter Remote C API][remoteapi-docs]
## `Special Thanks`
- [rxi](https://github.com/rxi) for writing the [log.c](https://github.com/rxi/log.c) package
- [rxi][rxi-user] for writing the [log.c][log-c] package
[releases]: https://github.com/onyx-and-iris/vmrcli/releases
[remoteapi-docs]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf
[rxi-user]: https://github.com/rxi
[log-c]: https://github.com/rxi/log.c

View File

@@ -1,3 +1,5 @@
strip[0].mute !strip[0].mute strip[0].mute strip[0].gain strip[0].label=podmic strip[0].label
strip[1].mute=1 strip[1].mute
bus[0].label bus[0].gain=-8.3
strip[1].mute=1 strip[1].mute strip[1].limit-=8
strip[2].gain-=5 strip[2].comp+=4.8
bus[0].label
bus[1].gain-=5.8

View File

@@ -1,5 +1,5 @@
/******************************************************************************/
/* Voicemeeter Remote API. V.Burel©2015-2023 */
/* Voicemeeter Remote API. V.Burel<EFBFBD>2015-2023 */
/******************************************************************************/
/* This Library allows communication with Voicemeeter applications */
/* 4 Client Applications can be connected to remote Voicemeeter. */
@@ -19,25 +19,24 @@
/* 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).
@@ -47,15 +46,14 @@ 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).
@@ -65,29 +63,18 @@ long __stdcall VBVMR_Logout(void);
-2: unknown vType number
*/
long __stdcall VBVMR_RunVoicemeeter(long vType);
long __stdcall VBVMR_RunVoicemeeter(long vType);
/** @} */
/** @} */
/******************************************************************************/
/* */
/* General Information */
/* */
/******************************************************************************/
/******************************************************************************/
/* */
/* General Information */
/* */
/******************************************************************************/
/** @name General Information
* @{ */
/** @name General Information
* @{ */
/**
@brief Get Voicemeeter Type
@@ -117,7 +104,7 @@ long __stdcall VBVMR_RunVoicemeeter(long vType);
-2: no server.
*/
long __stdcall VBVMR_GetVoicemeeterType(long * pType);
long __stdcall VBVMR_GetVoicemeeterType(long *pType);
/**
@brief Get Voicemeeter Version
@@ -132,36 +119,18 @@ long __stdcall VBVMR_GetVoicemeeterType(long * pType);
-2: no server.
*/
long __stdcall VBVMR_GetVoicemeeterVersion(long * pVersion);
long __stdcall VBVMR_GetVoicemeeterVersion(long *pVersion);
/** @} */
/** @} */
/******************************************************************************/
/* */
/* Get parameters */
/* */
/******************************************************************************/
/******************************************************************************/
/* */
/* Get parameters */
/* */
/******************************************************************************/
/** @name Getting Parameters
* @{ */
/** @name Getting Parameters
* @{ */
/**
@brief Check if parameters have changed.
@@ -174,7 +143,7 @@ long __stdcall VBVMR_GetVoicemeeterVersion(long * pVersion);
-2: no server.
*/
long __stdcall VBVMR_IsParametersDirty(void);
long __stdcall VBVMR_IsParametersDirty(void);
/**
@brief get parameter value.
@@ -187,7 +156,7 @@ long __stdcall VBVMR_IsParametersDirty(void);
-5: structure mismatch
*/
long __stdcall VBVMR_GetParameterFloat(char * szParamName, float * pValue);
long __stdcall VBVMR_GetParameterFloat(char *szParamName, float *pValue);
/**
@brief get parameter value.
@@ -200,27 +169,19 @@ long __stdcall VBVMR_GetParameterFloat(char * szParamName, float * pValue);
-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 */
/* */
/******************************************************************************/
/******************************************************************************/
/* */
/* Get levels */
/* */
/******************************************************************************/
/** @name Getting RT Data
* @{ */
/** @name Getting RT Data
* @{ */
/**
@brief Get Current levels.
@@ -281,8 +242,7 @@ long __stdcall VBVMR_GetParameterStringW(char * szParamName, unsigned short * ws
-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.
@@ -301,9 +261,7 @@ long __stdcall VBVMR_GetLevel(long nType, long nuChannel, float * pValue);
-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.
@@ -319,29 +277,18 @@ long __stdcall VBVMR_GetMidiMessage(unsigned char *pMIDIBuffer, long nbByteMax);
-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 */
/* */
/******************************************************************************/
/** @} */
/******************************************************************************/
/* */
/* Set Parameters */
/* */
/******************************************************************************/
/** @name Setting Parameters
* @{ */
/** @name Setting Parameters
* @{ */
/**
@brief Set a single float 32 bits parameters .
@@ -359,9 +306,7 @@ long __stdcall VBVMR_SendMidiMessage(unsigned char *pMIDIBuffer, long nbByte);
-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 .
@@ -379,12 +324,8 @@ long __stdcall VBVMR_SetParameterFloat(char * szParamName, float Value);
*/
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 ).
@@ -407,29 +348,17 @@ long __stdcall VBVMR_SetParameterStringW(char * szParamName, unsigned short * ws
-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 */
/******************************************************************************/
/******************************************************************************/
/* DEVICES ENUMERATOR */
/******************************************************************************/
/** @name Device Enumeration Functions
* @{ */
/** @name Device Enumeration Functions
* @{ */
#define VBVMR_DEVTYPE_MME 1
#define VBVMR_DEVTYPE_WDM 3
@@ -441,7 +370,7 @@ long __stdcall VBVMR_SetParametersW(unsigned short * szParamScript);
@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
@@ -452,15 +381,15 @@ long __stdcall VBVMR_Output_GetDeviceNumber(void);
@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
@@ -471,50 +400,40 @@ long __stdcall VBVMR_Input_GetDeviceNumber(void);
@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
* @{ */
/******************************************************************************/
/* 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
{
typedef struct tagVBVMR_AUDIOINFO
{
long samplerate;
long nbSamplePerFrame;
} 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;
} 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;
/**
@brief VB-AUDIO Callback is called for different task to Initialize, perform and end your process.
@@ -533,23 +452,21 @@ typedef struct tagVBVMR_AUDIOBUFFER
@return : 0: always 0 (unused).
*/
typedef long(__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void *lpUser, long nCommand, void *lpData, long nnn);
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
#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_STARTING 1 //command to initialize data according SR and buffer size
//info = (VBVMR_LPT_AUDIOINFO)lpData
#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_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
-----------------------------------------------------
@@ -572,9 +489,9 @@ typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand,
| 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 |
@@ -603,9 +520,9 @@ typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand,
| 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 |
@@ -656,7 +573,7 @@ typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand,
| 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
@@ -678,11 +595,11 @@ typedef long (__stdcall *T_VBVMR_VBAUDIOCALLBACK)(void * lpUser, long nCommand,
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
@@ -693,9 +610,8 @@ long __stdcall VBVMR_AudioCallbackRegister(long mode, T_VBVMR_VBAUDIOCALLBACK pC
-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
@@ -706,25 +622,18 @@ long __stdcall VBVMR_AudioCallbackStop(void);
1: callback already unregistered.
*/
long __stdcall VBVMR_AudioCallbackUnregister(void);
long __stdcall VBVMR_AudioCallbackUnregister(void);
/** @} */
/******************************************************************************/
/* */
/* Macro Buttons */
/* */
/******************************************************************************/
/** @} */
/******************************************************************************/
/* */
/* Macro Buttons */
/* */
/******************************************************************************/
/** @name Macro Buttons functions
* @{ */
/** @name Macro Buttons functions
* @{ */
/**
@brief Check if Macro Buttons states changed.
@@ -737,7 +646,7 @@ long __stdcall VBVMR_AudioCallbackUnregister(void);
-2: no server.
*/
long __stdcall VBVMR_MacroButton_IsDirty(void);
long __stdcall VBVMR_MacroButton_IsDirty(void);
/**
@brief get current status of a given button.
@@ -751,7 +660,7 @@ long __stdcall VBVMR_MacroButton_IsDirty(void);
-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.
@@ -765,72 +674,59 @@ long __stdcall VBVMR_MacroButton_GetStatus(long nuLogicalButton, float * pValue,
-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 long(__stdcall *T_VBVMR_Login)(void);
typedef long long(__stdcall *T_VBVMR_Logout)(void);
typedef long long(__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
typedef long long(__stdcall *T_VBVMR_GetVoicemeeterType)(long *pType);
typedef long long(__stdcall *T_VBVMR_GetVoicemeeterVersion)(long *pVersion);
typedef long long(__stdcall *T_VBVMR_IsParametersDirty)(void);
typedef long long(__stdcall *T_VBVMR_GetParameterFloat)(char *szParamName, float *pValue);
typedef long long(__stdcall *T_VBVMR_GetParameterStringA)(char *szParamName, char *szString);
typedef long 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 long(__stdcall *T_VBVMR_GetMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long long(__stdcall *T_VBVMR_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
typedef long long(__stdcall *T_VBVMR_SetParameterFloat)(char *szParamName, float Value);
typedef long long(__stdcall *T_VBVMR_SetParameters)(char *szParamScript);
typedef long long(__stdcall *T_VBVMR_SetParametersW)(unsigned short *szParamScript);
typedef long long(__stdcall *T_VBVMR_SetParameterStringA)(char *szParamName, char *szString);
typedef long long(__stdcall *T_VBVMR_SetParameterStringW)(char *szParamName, unsigned short *wszString);
typedef long 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 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 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 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 long(__stdcall *T_VBVMR_AudioCallbackStop)(void);
typedef long long(__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
typedef long long(__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
typedef long 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);
/******************************************************************************/
/* '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
{
typedef struct tagVBVMR_INTERFACE
{
T_VBVMR_Login VBVMR_Login;
T_VBVMR_Logout VBVMR_Logout;
T_VBVMR_RunVoicemeeter VBVMR_RunVoicemeeter;
@@ -867,34 +763,27 @@ typedef struct tagVBVMR_INTERFACE
T_VBVMR_MacroButton_GetStatus VBVMR_MacroButton_GetStatus;
T_VBVMR_MacroButton_SetStatus VBVMR_MacroButton_SetStatus;
} T_VBVMR_INTERFACE, *PT_VBVMR_INTERFACE, *LPT_VBVMR_INTERFACE;
} 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
@@ -917,9 +806,9 @@ typedef struct tagVBAN_VMRT_PACKET //packedt ident: 0
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()
@@ -971,16 +860,15 @@ typedef struct tagVBAN_VMRT_PACKET //packedt ident: 0
#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
@@ -992,7 +880,7 @@ typedef struct tagVBAN_VMPARAM_STRIP
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];
@@ -1036,7 +924,7 @@ typedef struct tagVBAN_VMPARAM_STRIP
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
@@ -1046,12 +934,11 @@ typedef struct tagVBAN_VMPARAM_STRIP
#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
#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
{
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
@@ -1059,35 +946,29 @@ typedef struct tagVBAN_VMPARAMSTRIP_PACKET //packedt ident: 1
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 */
/******************************************************************************/
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);
/******************************************************************************/
/* 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);
#ifdef __cplusplus
}
#endif
#endif /*__VOICEMEETER_REMOTE_H__*/

View File

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

View File

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

View File

@@ -6,12 +6,15 @@
enum kind
{
UNKNOWN = -1,
BASIC = 1,
BANANA,
POTATO,
BASICX64,
BANANAX64,
POTATOX64,
MACROBUTTONS = 11,
STREAMERVIEW
};
long login(T_VBVMR_INTERFACE *vmr, int kind);

View File

@@ -1,5 +1,6 @@
#include <stdbool.h>
#include <stdio.h>
#include <windows.h>
#include "cdll.h"
#include "util.h"

View File

@@ -3,6 +3,11 @@
#include "vmr.h"
#include "util.h"
/**
* @brief Removes the last part of a path
*
* @param szPath
*/
void remove_name_in_path(char *szPath)
{
char *p = szPath;
@@ -57,9 +62,17 @@ int replace_multiple_space_with_one(char *s, size_t len)
return j;
}
char *kind_as_string(char *s, enum kind kind, int n)
/**
* @brief
*
* @param s Pointer to a character buffer
* @param kind The kind of Voicemeeter.
* @param n maximum number of characters to be written to the buffer
* @return char* The kind of Voicemeeter as a string
*/
char *kind_as_string(char *s, int kind, int n)
{
char *kinds[] = {
static const char *kinds[] = {
"Basic",
"Banana",
"Potato",

View File

@@ -8,6 +8,15 @@
#define VERSION_STR_LEN 128
#define KIND_STR_LEN 64
/**
* @brief Logs into the API.
* Tests for valid connection for up to 2 seconds.
* If successful initializes the dirty parameters.
*
* @param vmr
* @param kind
* @return long
*/
long login(T_VBVMR_INTERFACE *vmr, int kind)
{
int rep;
@@ -21,30 +30,37 @@ long login(T_VBVMR_INTERFACE *vmr, int kind)
log_info(
"Launching Voicemeeter %s GUI",
kind_as_string(kind_s, kind, KIND_STR_LEN));
}
time_t endwait;
int timeout = 2;
endwait = time(NULL) + timeout;
time_t start = time(NULL);
do
{
if ((rep = version(vmr, &v)) == 0)
break;
Sleep(50);
} while (time(NULL) < endwait);
}
if (rep == 0)
{
version(vmr, &v);
char version_s[VERSION_STR_LEN];
log_info(
"Successfully logged into the Voicemeeter API v%s",
version_as_string(version_s, v, VERSION_STR_LEN));
break;
}
Sleep(50);
} while (time(NULL) < start + timeout);
if (rep == 0)
{
clear_dirty(vmr);
}
return rep;
}
/**
* @brief Logs out of the API giving a short wait to allow a
* final instruction to complete.
*
* @param vmr The API interface as a struct
* @return long VBVMR_Logout return value
*/
long logout(T_VBVMR_INTERFACE *vmr)
{
int rep;

View File

@@ -2,6 +2,8 @@
#include <stdlib.h>
#include <stdbool.h>
#include <getopt.h>
#include <string.h>
#include <ctype.h>
#include "cdll.h"
#include "vmr.h"
#include "log.h"
@@ -9,12 +11,21 @@
#define MAX_LINE 512
/**
* @brief An enum used to define the kind of value
* a 'get' call returns.
*
*/
enum
{
FLOAT_T,
STRING_T,
};
/**
* @brief A struct holding the result of a get call.
*
*/
struct result
{
int type;
@@ -27,7 +38,7 @@ struct result
void help(void);
enum kind set_kind(char *kval);
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, enum kind kind);
void interactive(T_VBVMR_INTERFACE *vmr);
void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len);
void parse_command(T_VBVMR_INTERFACE *vmr, char *command);
@@ -37,9 +48,10 @@ bool vflag = false;
int main(int argc, char *argv[])
{
bool iflag = false;
bool iflag = false,
mflag = false,
sflag = false;
int opt;
char *kvalue = "";
int dvalue;
enum kind kind = BANANAX64;
@@ -51,20 +63,30 @@ int main(int argc, char *argv[])
log_set_level(LOG_WARN);
while ((opt = getopt(argc, argv, "k:ihD:v")) != -1)
while ((opt = getopt(argc, argv, "hk:msiD:v")) != -1)
{
switch (opt)
{
case 'i':
iflag = true;
break;
case 'k':
kvalue = optarg;
kind = set_kind(kvalue);
break;
case 'h':
help();
exit(EXIT_SUCCESS);
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 'i':
iflag = true;
break;
case 'D':
dvalue = atoi(optarg);
if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
@@ -73,7 +95,7 @@ int main(int argc, char *argv[])
}
else
{
log_error(
log_warn(
"-D arg out of range, expected value from 0 up to 5\n"
"Log level will default to LOG_WARN (3).\n");
}
@@ -95,6 +117,18 @@ int main(int argc, char *argv[])
exit(EXIT_FAILURE);
}
if (mflag)
{
log_info("MacroButtons app launched");
run_voicemeeter(vmr, MACROBUTTONS);
}
if (sflag)
{
log_info("StreamerView app launched");
run_voicemeeter(vmr, STREAMERVIEW);
}
if (iflag)
{
puts("Interactive mode enabled. Enter 'Q' to exit.");
@@ -116,19 +150,21 @@ int main(int argc, char *argv[])
}
/**
* @brief prints the help dialogue
* @brief prints the help message
*
*/
void help()
{
puts(
"Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] <api commands>\n"
"Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-m] [-s] <api commands>\n"
"Where: \n"
"\th: Prints the help dialogue\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"
"\tv: Enable extra console output (toggle, set messages)\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"
"\tm: Launch the MacroButtons application\n"
"\ts: Launch the StreamerView application");
}
/**
@@ -162,23 +198,30 @@ enum kind set_kind(char *kval)
}
else
{
log_error("Unknown Voicemeeter kind '%s'\n", kval);
exit(EXIT_FAILURE);
return UNKNOWN;
}
}
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
/**
* @brief Defines the DLL interface as a struct.
* Logs into the API.
*
* @param vmr The API interface as a struct
* @param kind
* @return int
*/
int init_voicemeeter(T_VBVMR_INTERFACE *vmr, enum kind kind)
{
int rep = initialize_dll_interfaces(vmr);
if (rep < 0)
{
if (rep == -100)
{
log_error("Voicemeeter is not installed");
log_fatal("Voicemeeter is not installed");
}
else
{
log_error("Error loading Voicemeeter dll with code %d\n", rep);
log_fatal("Error loading Voicemeeter dll with code %d\n", rep);
}
return rep;
}
@@ -186,13 +229,20 @@ int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
rep = login(vmr, kind);
if (rep != 0)
{
log_error("Error logging into Voicemeeter");
log_fatal("Error logging into Voicemeeter");
return rep;
}
return 0;
}
/**
* @brief Continuously read lines from stdin.
* Break if 'Q' is entered on the interactive prompt.
* Each line is passed to parse_input()
*
* @param vmr The API interface as a struct
*/
void interactive(T_VBVMR_INTERFACE *vmr)
{
char input[MAX_LINE];
@@ -213,6 +263,14 @@ void interactive(T_VBVMR_INTERFACE *vmr)
}
}
/**
* @brief Walks through each line split by a space delimiter.
* Each token is passed to parse_command()
*
* @param vmr The API interface as a struct
* @param input Each input line, from stdin or CLI args
* @param len The length of the input line
*/
void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len)
{
char *token;
@@ -226,6 +284,14 @@ void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len)
}
}
/**
* @brief Execute each command according to type.
* See command type definitions in:
* https://github.com/onyx-and-iris/vmrcli?tab=readme-ov-file#api-commands
*
* @param vmr The API interface as a struct
* @param command Each token from the input line as its own command string
*/
void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
{
log_debug("Parsing %s", command);
@@ -279,6 +345,13 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
}
}
/**
* @brief
*
* @param vmr The API interface as a struct
* @param command A parsed 'get' command as a string
* @param res A struct holding the result of the API call.
*/
void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
{
clear_dirty(vmr);