From a505ee05446651a8b6e7d01ad1a6fd246cdef7bd Mon Sep 17 00:00:00 2001 From: A-tG Date: Thu, 28 Jan 2021 20:39:18 +0300 Subject: [PATCH] Initial commit --- .gitattributes | 2 + .gitignore | 353 ++++++++++++++++++ LICENSE | 21 ++ README.md | 2 + voicemeeter remote api wrap.sln | 18 + voicemeeter remote api wrap/PathHelper.cs | 48 +++ .../RemoteApiWrapper.cs | 168 +++++++++ .../voicemeeter remote api wrap.projitems | 15 + .../voicemeeter remote api wrap.shproj | 13 + 9 files changed, 640 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 voicemeeter remote api wrap.sln create mode 100644 voicemeeter remote api wrap/PathHelper.cs create mode 100644 voicemeeter remote api wrap/RemoteApiWrapper.cs create mode 100644 voicemeeter remote api wrap/voicemeeter remote api wrap.projitems create mode 100644 voicemeeter remote api wrap/voicemeeter remote api wrap.shproj diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e645270 --- /dev/null +++ b/.gitignore @@ -0,0 +1,353 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..54d3cc2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 A-tG + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..afaf1df --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# voicemeeter-remote-api-wrap + Visual Studio C# **Shared Project**. **WIP** Helps dynamically load VoicemeeterRemote64.dll or VoicemeeterRemote.dll depending on OS. Not tested on 32 bit Windows. diff --git a/voicemeeter remote api wrap.sln b/voicemeeter remote api wrap.sln new file mode 100644 index 0000000..1c21767 --- /dev/null +++ b/voicemeeter remote api wrap.sln @@ -0,0 +1,18 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.30907.101 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "voicemeeter remote api wrap", "voicemeeter remote api wrap\voicemeeter remote api wrap.shproj", "{28B74DFA-514F-49AB-B226-A3E5535E73DB}" +EndProject +Global + GlobalSection(SharedMSBuildProjectFiles) = preSolution + voicemeeter remote api wrap\voicemeeter remote api wrap.projitems*{28b74dfa-514f-49ab-b226-a3e5535e73db}*SharedItemsImports = 13 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {94AAA4CF-A244-4466-9961-3BFA161627BC} + EndGlobalSection +EndGlobal diff --git a/voicemeeter remote api wrap/PathHelper.cs b/voicemeeter remote api wrap/PathHelper.cs new file mode 100644 index 0000000..ebe6290 --- /dev/null +++ b/voicemeeter remote api wrap/PathHelper.cs @@ -0,0 +1,48 @@ +using System; +using System.IO; +using Microsoft.Win32; + +namespace AtgDev.Voicemeeter.Utils +{ + static class PathHelper + { + private const string VmKey = "VB:Voicemeeter {17359A74-1236-5467}"; + private const string regkeyHead = @"HKEY_LOCAL_MACHINE\SOFTWARE\"; + private const string regKeyTail = @"Microsoft\Windows\CurrentVersion\Uninstall\" + VmKey; + private const string regKeyMiddle = @"WOW6432Node\"; + private const string valueName = "UninstallString"; + + private static string GetDllName() + { + string result = "VoicemeeterRemote"; + if (Environment.Is64BitOperatingSystem) + { + result += "64"; + } + return result + ".dll"; + } + + /// Thrown when cannot find Voicemeeter registry key + public static string GetProgramFolder() + { + var regKey = regkeyHead + regKeyTail; + var result = Registry.GetValue(regKey, valueName, null); + if (result == null) + { + // try to search in WOW6432Node node + regKey = regkeyHead + regKeyMiddle + regKeyTail; + result = Registry.GetValue(regKey, valueName, null); + if (result == null) + { + throw new DirectoryNotFoundException($"Error reading registry path: {regKey}"); + } + } + return Path.GetDirectoryName((string)result); + } + + public static string GetDllPath() + { + return Path.Combine(GetProgramFolder(), GetDllName()); + } + } +} diff --git a/voicemeeter remote api wrap/RemoteApiWrapper.cs b/voicemeeter remote api wrap/RemoteApiWrapper.cs new file mode 100644 index 0000000..c22fad7 --- /dev/null +++ b/voicemeeter remote api wrap/RemoteApiWrapper.cs @@ -0,0 +1,168 @@ +using System; +using System.Text; +using System.Runtime.InteropServices; + +namespace AtgDev.Voicemeeter +{ + using AtgDev.Utils.Native; + // Aliases for correct types from DLL's documentation + using vmLong = Int32; + using vmFloat = Single; + + /// + /// List of Voicemeeter fucntions/parameters + /// + /// + /// Parameter name + /// test + /// + /// + /// Value range + /// test + /// + /// + /// Remark + /// test + /// + /// + /// "Strip[i].Mono" + /// 0 (off) or 1 (on) + /// Mono Button + /// + /// + /// + /// + /// Voicemeeter Remote API + /// Wrapper for library that allows communication with Voicemeeter Applications + /// + class RemoteApiWrapper : DllWrapperBase + { + public RemoteApiWrapper(string dllPath) : base(dllPath) + { + InitProcedures(); + } + + private void InitProcedures() + { + m_login = GetReadyDelegate(); + m_logout = GetReadyDelegate(); + m_getVoicemeeterType = GetReadyDelegate(); + m_isParametersDirty = GetReadyDelegate(); + m_getParameterFloat = GetReadyDelegate(); + m_getParameterString = GetReadyDelegate(); + } + + private IntPtr ConvertStringToNullTermAscii(in string str) + { + return Marshal.StringToHGlobalAnsi(str); + } + + + private delegate vmLong VBVMR_Login(); + private VBVMR_Login m_login; + /// + /// Open Communication Pipe With Voicemeeter (typically called on software startup). + /// + /// + /// 0: OK (no error).
+ /// 1: OK but Voicemeeter Application not launched.
+ /// -1: cannot get client (unexpected)
+ /// -2: unexpected login (logout was expected before).
+ /// + public vmLong Login() + { + return m_login(); + } + + private delegate vmLong VBVMR_Logout(); + private VBVMR_Logout m_logout; + /// + /// Close Communication Pipe With Voicemeeter (typically called on software end). + /// + /// + /// 0 if ok.
+ /// + public vmLong Logout() + { + return m_logout(); + } + + private delegate vmLong VBVMR_GetVoicemeeterType(out vmLong type); + private VBVMR_GetVoicemeeterType m_getVoicemeeterType; + /// + /// Get Voicemeeter Type. + /// + ///The variable receiving the type (1 = Voicemeeter, 2 = Voicemeeter Banana, 3 = Voicemeeter Potato). + /// + /// 0: OK (no error).
+ /// -1: cannot get client (unexpected)
+ /// -2: no server.
+ /// + public vmLong GetVoicemeeterType(out vmLong type) + { + return m_getVoicemeeterType(out type); + } + + private delegate vmLong VBVMR_IsParametersDirty(); + private VBVMR_IsParametersDirty m_isParametersDirty; + /// + /// Check if parameters have changed. + /// Call this function periodically (typically every 10 or 20ms). + /// + /// + /// 0: no new paramters.
+ /// 1: New parameters -> update your display.
+ /// -1: error (unexpected)
+ /// -2: no server.
+ /// + public vmLong IsParametersDirty() + { + return m_isParametersDirty(); + } + + // using just string for paramName works, + // but stil better to convert it to null terminated ASCII according to DLL header just in case + private delegate vmLong VBVMR_GetParameterFloat(IntPtr paramName, out vmFloat value); + private VBVMR_GetParameterFloat m_getParameterFloat; + /// + /// Get parameter value. + /// + ///The name of the parameter (see VoicemeeterRemoteAPI parameters name table) + ///The float variable receiving the wanted value. + /// + /// 0: OK (no error).
+ /// -1: error
+ /// -2: no server.
+ /// -3: unknown parameter
+ /// -5: structure mismatch
+ /// + public vmLong GetParameter(string paramName, out vmFloat val) + { + var paramNamePtr = ConvertStringToNullTermAscii(in paramName); + return m_getParameterFloat(paramNamePtr, out val); + } + + private delegate vmLong VBVMR_GetParameterStringA(IntPtr paramName, StringBuilder strVal); + private VBVMR_GetParameterStringA m_getParameterString; + /// + /// Get parameter value. + /// + ///The name of the parameter (see VoicemeeterRemoteAPI parameters name table) + ///The string variable receiving the wanted value. + /// + /// 0: OK (no error).
+ /// -1: error
+ /// -2: no server.
+ /// -3: unknown parameter
+ /// -5: structure mismatch
+ /// + public vmLong GetParameter(string paramName, out string strVal) + { + var strB = new StringBuilder(512); + var paramNamePtr = ConvertStringToNullTermAscii(in paramName); + var resp = m_getParameterString(paramNamePtr, strB); + strVal = strB.ToString(); + return resp; + } + } +} diff --git a/voicemeeter remote api wrap/voicemeeter remote api wrap.projitems b/voicemeeter remote api wrap/voicemeeter remote api wrap.projitems new file mode 100644 index 0000000..2bc6694 --- /dev/null +++ b/voicemeeter remote api wrap/voicemeeter remote api wrap.projitems @@ -0,0 +1,15 @@ + + + + $(MSBuildAllProjects);$(MSBuildThisFileFullPath) + true + 28b74dfa-514f-49ab-b226-a3e5535e73db + + + voicemeeter_remote_api_wrap + + + + + + \ No newline at end of file diff --git a/voicemeeter remote api wrap/voicemeeter remote api wrap.shproj b/voicemeeter remote api wrap/voicemeeter remote api wrap.shproj new file mode 100644 index 0000000..ce65e8e --- /dev/null +++ b/voicemeeter remote api wrap/voicemeeter remote api wrap.shproj @@ -0,0 +1,13 @@ + + + + 28b74dfa-514f-49ab-b226-a3e5535e73db + 14.0 + + + + + + + +