Initial commit

BarRaider · Jan 13, 2019 · 0b24cbe · 0b24cbe
1 parent 031dc5b
commit 0b24cbe
Show file tree

Hide file tree

Showing 12 changed files with 958 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,56 @@
 # streamdeck-voicemeeter
+VoiceMeeter integration and live feedback for the Elgato Stream Deck device.
+
+## Current functionality
+### 3 Plugins built into one:
+#### VoiceMeeter Mute/Unmute
+- Allows you to easily connect to one of VoiceMeeter's Strips or Buses
+- 3 different modes: Toggle/Push-To-Talk/Single Setting (on/off)
+- See a live indication of the current status on Stream Deck (never forget your microphone on again!)
+- Can also be used to mute/unmute different Strips/Buses such as Spotify/Background music/etc.
+- Choose from 4 different icons to display the mute/unmute settings
+
+#### VoiceMeeter Modify Setting
+- Allows you to easily modify various VoiceMeeter settings
+- Supports a whole list of options for each Strip/Bus
+	* Options include modifying the: Gain slider, gate, comp,  mono button, solo button, audibility, color_x, color_y, eqgain1, eqgain2, eqgain3, fx_x, fx_y, mc,pan_x, pan_y
+	(Valid values can be found starting on page 9 of VoiceMeeter API PDF: https://download.vb-audio.com/Download_CABLE/VoicemeeterRemoteAPI.pdf )
+- Live feedback on the current value of that setting
+- Supports both Click and Long Click (allows you to toggle between two preset values for this setting)
+- Option to turn off the Live feedback and set the title to whatever you want
+
+#### VoiceMeeter Advanced Plugin
+- **Note:** This is for advanced users (you better know what you're doing)
+- Allows you to directly modify a whole set of settings
+- Example: `Strip[0].mono=1;Strip[1].Mute=1;Bus[2].Gain=-20;`
+	* Additional examples can be found on the VoiceMeeter forum: https://forum.vb-audio.com/viewtopic.php?f=8&t=346&sid=a773394396c10847fd6fd7e332a55e49#p495
+	and the VoiceMeeter API PDF: https://download.vb-audio.com/Download_CABLE/VoicemeeterRemoteAPI.pdf
+- Supports both Click and Long Click (allows you to toggle between two preset list of settings)
+- Live feedback on whatever setting you choose
+- Option to turn off the Live feedback and set the title to whatever you want
+
+
+## Dependencies
+- This library uses the [streamdeck-client-csharp](https://github.com/TyrenDe/streamdeck-client-csharp) wrapper
+- This library uses a modified version of [VoiceMeeterWrapper](https://github.com/tocklime/VoiceMeeterWrapper) and includes additional functionality
+
+## Feature roadmap
+Always open to more suggestions.
+
+## How do I get started using it?
+Install by clicking the com.barraider.voicemeeter.streamDeckPlugin file in the Releases folder:
+https://github.com/BarRaider/streamdeck-voicemeeter/releases
+
+## I found a bug, who do I contact?
+Just head over to the issues page and create a new issue.
+
+## License
+MIT License
+
+Copyright (c) 2019
+
+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/VoiceMeeter/IPluginable.cs b/VoiceMeeter/IPluginable.cs
@@ -0,0 +1,12 @@
+using Newtonsoft.Json.Linq;
+
+namespace VoiceMeeter
+{
+    public interface IPluginable
+    {
+        void KeyPressed();
+        void KeyReleased();
+        void UpdateSettings(JObject payload);
+        void OnTick();
+    }
+}
diff --git a/VoiceMeeter/Images/vm.png b/VoiceMeeter/Images/vm.png
diff --git a/VoiceMeeter/Images/[email protected] b/VoiceMeeter/Images/[email protected]
diff --git a/VoiceMeeter/Images/vmTop.png b/VoiceMeeter/Images/vmTop.png
diff --git a/VoiceMeeter/PropertyInspector/Advanced.js b/VoiceMeeter/PropertyInspector/Advanced.js
@@ -0,0 +1,190 @@
+var websocket = null,
+    uuid = null,
+    actionInfo = {},
+    inInfo = {},
+    runningApps = [],
+    isQT = navigator.appVersion.includes('QtWebEngine');
+
+function connectSocket(inPort, inUUID, inRegisterEvent, inInfo, inActionInfo) {
+    uuid = inUUID;
+    actionInfo = JSON.parse(inActionInfo); // cache the info
+    inInfo = JSON.parse(inInfo);
+    websocket = new WebSocket('ws://localhost:' + inPort);
+
+    addDynamicStyles(inInfo.colors);
+
+    websocket.onopen = function () {
+        var json = {
+            event: inRegisterEvent,
+            uuid: inUUID
+        };
+
+        websocket.send(JSON.stringify(json));
+
+        // Notify the plugin that we are connected
+        sendValueToPlugin('propertyInspectorConnected', 'property_inspector');
+    };
+
+    websocket.onmessage = function (evt) {
+        // Received message from Stream Deck
+        var jsonObj = JSON.parse(evt.data);
+
+        if (jsonObj.event === 'sendToPropertyInspector') {
+            var payload = jsonObj.payload;
+
+            var setValue = document.getElementById('setValue');
+            setValue.value = payload['setValue'];
+
+            var longPressValue = document.getElementById('longPressValue');
+            longPressValue.value = payload['longPressValue'];
+
+            var titleType = document.getElementById('titleType');
+            titleType.value = payload['titleType'];
+
+            var titleParam = document.getElementById('titleParam');
+            titleParam.value = payload['titleParam'];
+        }
+    };
+}
+
+function updateSettings() {
+    var setValue        = document.getElementById('setValue');
+    var longPressValue  = document.getElementById('longPressValue');
+    var titleType       = document.getElementById('titleType');
+    var titleParam      = document.getElementById('titleParam');
+
+
+    var payload = {};
+
+    payload.property_inspector = 'updateSettings';
+    payload.setValue        = setValue.value;
+    payload.longPressValue  = longPressValue.value;
+    payload.titleType       = titleType.value;
+    payload.titleParam      = titleParam.value;
+
+    sendPayloadToPlugin(payload);
+}
+
+function sendPayloadToPlugin(payload) {
+    if (websocket && (websocket.readyState === 1)) {
+        const json = {
+            'action': actionInfo['action'],
+            'event': 'sendToPlugin',
+            'context': uuid,
+            'payload': payload
+        };
+        websocket.send(JSON.stringify(json));
+    }
+}
+
+// our method to pass values to the plugin
+function sendValueToPlugin(value, param) {
+    if (websocket && (websocket.readyState === 1)) {
+        const json = {
+            'action': actionInfo['action'],
+            'event': 'sendToPlugin',
+            'context': uuid,
+            'payload': {
+                [param]: value
+            }
+        };
+        websocket.send(JSON.stringify(json));
+    }
+}
+
+if (!isQT) {
+    document.addEventListener('DOMContentLoaded', function () {
+        initPropertyInspector();
+    });
+}
+
+window.addEventListener('beforeunload', function (e) {
+    e.preventDefault();
+
+    // Notify the plugin we are about to leave
+    sendValueToPlugin('propertyInspectorWillDisappear', 'property_inspector');
+
+    // Don't set a returnValue to the event, otherwise Chromium with throw an error.
+});
+
+function initPropertyInspector() {
+    // Place to add functions
+}
+
+
+function addDynamicStyles(clrs) {
+    const node = document.getElementById('#sdpi-dynamic-styles') || document.createElement('style');
+    if (!clrs.mouseDownColor) clrs.mouseDownColor = fadeColor(clrs.highlightColor, -100);
+    const clr = clrs.highlightColor.slice(0, 7);
+    const clr1 = fadeColor(clr, 100);
+    const clr2 = fadeColor(clr, 60);
+    const metersActiveColor = fadeColor(clr, -60);
+
+    node.setAttribute('id', 'sdpi-dynamic-styles');
+    node.innerHTML = `
+
+    input[type="radio"]:checked + label span,
+    input[type="checkbox"]:checked + label span {
+        background-color: ${clrs.highlightColor};
+    }
+
+    input[type="radio"]:active:checked + label span,
+    input[type="radio"]:active + label span,
+    input[type="checkbox"]:active:checked + label span,
+    input[type="checkbox"]:active + label span {
+      background-color: ${clrs.mouseDownColor};
+    }
+
+    input[type="radio"]:active + label span,
+    input[type="checkbox"]:active + label span {
+      background-color: ${clrs.buttonPressedBorderColor};
+    }
+
+    td.selected,
+    td.selected:hover,
+    li.selected:hover,
+    li.selected {
+      color: white;
+      background-color: ${clrs.highlightColor};
+    }
+
+    .sdpi-file-label > label:active,
+    .sdpi-file-label.file:active,
+    label.sdpi-file-label:active,
+    label.sdpi-file-info:active,
+    input[type="file"]::-webkit-file-upload-button:active,
+    button:active {
+      background-color: ${clrs.buttonPressedBackgroundColor};
+      color: ${clrs.buttonPressedTextColor};
+      border-color: ${clrs.buttonPressedBorderColor};
+    }
+
+    ::-webkit-progress-value,
+    meter::-webkit-meter-optimum-value {
+        background: linear-gradient(${clr2}, ${clr1} 20%, ${clr} 45%, ${clr} 55%, ${clr2})
+    }
+
+    ::-webkit-progress-value:active,
+    meter::-webkit-meter-optimum-value:active {
+        background: linear-gradient(${clr}, ${clr2} 20%, ${metersActiveColor} 45%, ${metersActiveColor} 55%, ${clr})
+    }
+    `;
+    document.body.appendChild(node);
+};
+
+/** UTILITIES */
+
+/*
+    Quick utility to lighten or darken a color (doesn't take color-drifting, etc. into account)
+    Usage:
+    fadeColor('#061261', 100); // will lighten the color
+    fadeColor('#200867'), -100); // will darken the color
+*/
+function fadeColor(col, amt) {
+    const min = Math.min, max = Math.max;
+    const num = parseInt(col.replace(/#/g, ''), 16);
+    const r = min(255, max((num >> 16) + amt, 0));
+    const g = min(255, max((num & 0x0000FF) + amt, 0));
+    const b = min(255, max(((num >> 8) & 0x00FF) + amt, 0));
+    return '#' + (g | (b << 8) | (r << 16)).toString(16).padStart(6, 0);
+}