Merge branch 'v5' into v5-feat-steam-Short-Discription

src/backend/effects/builtin/control-emulation.js

@@ -125,6 +125,18 @@ const effect = {
             "f10",
             "f11",
             "f12",
+            "f13",
+            "f14",
+            "f15",
+            "f16",
+            "f17",
+            "f18",
+            "f19",
+            "f20",
+            "f21",
+            "f22",
+            "f23",
+            "f24",
             "alt",
             "control",
             "shift",

src/backend/effects/builtin/play-video.js

@@ -10,6 +10,9 @@ const accountAccess = require("../../common/account-access");
 const util = require("../../utility");
 const fs = require('fs-extra');
 const path = require("path");
+const frontendCommunicator = require('../../common/frontend-communicator');
+const { wait } = require("../../utility");
+const { parseYoutubeId } = require("../../../shared/youtube-url-parser");
 
 /**
  * The Play Video effect
@@ -439,40 +442,31 @@ const playVideo = {
         }
 
         let resourceToken;
+        let duration;
         if (effect.videoType === "YouTube Video") {
-            resourceToken = resourceTokenManager.storeResourcePath(data.filepath, effect.length);
+            const youtubeData = parseYoutubeId(data.youtubeId);
+            data.youtubeId = youtubeData.id;
+            const result = await frontendCommunicator.fireEventAsync("getYoutubeVideoDuration", data.youtubeId);
+            if (!isNaN(result)) {
+                duration = result;
+            }
+            if (data.videoStarttime == null || data.videoStarttime == "" || data.videoStarttime == 0) {
+                data.videoStarttime = youtubeData.startTime;
+            }
         } else {
-            const durationToken = resourceTokenManager.storeResourcePath(data.filepath, 5);
-
-            const durationPromise = new Promise(async (resolve, reject) => {
-                const listener = (event) => {
-                    try {
-                        if (event.name === "video-duration" && event.data.resourceToken === durationToken) {
-                            webServer.removeListener("overlay-event", listener);
-                            resolve(event.data.duration);
-                        }
-                    } catch (err) {
-                        logger.error("Error while trying to process overlay-event for getVideoDuration: ", err);
-                        reject(err);
-                    }
-                };
-                webServer.on("overlay-event", listener);
-            });
-
-            webServer.sendToOverlay("getVideoDuration", {
-                resourceToken: durationToken,
-                overlayInstance: data.overlayInstance
-            });
-
-            const duration = await durationPromise;
-            resourceToken = resourceTokenManager.storeResourcePath(data.filepath, duration + 5);
-            logger.info(`Retrieved duration for video: ${duration}`);
+            const result = await frontendCommunicator.fireEventAsync("getVideoDuration", data.filepath);
+            if (!isNaN(result)) {
+                duration = result;
+            }
+            resourceToken = resourceTokenManager.storeResourcePath(data.filepath, duration);
         }
 
         data.resourceToken = resourceToken;
 
         webServer.sendToOverlay("video", data);
-        if (effect.wait) {
+        if (effect.wait && effect.videoType === "YouTube Video") {
+            // Use overlay callback for youtube video, needs local way to get duration for production.
+            // If effect is ran with "Wait for video to finish" while overlay is not open, it may freeze an effect queue.
             await new Promise(async (resolve, reject) => {
                 const listener = (event) => {
                     try {
@@ -487,6 +481,12 @@ const playVideo = {
                 };
                 webServer.on("overlay-event", listener);
             });
+        } else if (effect.wait && data.videoType === "Local Video") {
+            let internalDuration = data.videoDuration;
+            if (internalDuration == null || internalDuration === 0 || internalDuration === "") {
+                internalDuration = duration;
+            }
+            await wait(internalDuration * 1000);
         }
         return true;
     },
@@ -637,9 +637,6 @@ const playVideo = {
                         const exitVideo = () => {
                             delete startedVidCache[this.id]; // eslint-disable-line no-undef
                             animateVideoExit(`#${wrapperId}`, exitAnimation, exitDuration, inbetweenAnimation);
-                            setTimeout(function(){
-                                sendWebsocketEvent("video-end", {resourceToken: token}); // eslint-disable-line no-undef
-                            }, millisecondsFromString(exitDuration));
                         };
 
                         // Remove div after X time.
@@ -669,29 +666,6 @@ const playVideo = {
 
                     $(".wrapper").append(wrappedHtml);
 
-                    try {
-                        const url = new URL(youtubeId);
-                        if (url.hostname.includes("www.youtube.com")) {
-                            for (const [key, value] of url.searchParams) {
-                                if (key === "v") {
-                                    youtubeId = value;
-                                } else if (key === "t") {
-                                    videoStarttime = value;
-                                }
-                            }
-                        }
-                        if (url.hostname.includes("youtu.be")) {
-                            youtubeId = url.pathname.replace("/", "");
-                            for (const [key, value] of url.searchParams) {
-                                if (key === "t") {
-                                    videoStarttime = value;
-                                }
-                            }
-                        }
-                    } catch (error) {
-                        //failed to convert url
-                    }
-
                     // Add iframe.
 
                     const playerVars = {
@@ -737,9 +711,6 @@ const playVideo = {
                             onStateChange: (event) => {
                                 if (event.data === 0 && !videoDuration) {
                                     animateVideoExit(`#${wrapperId}`, exitAnimation, exitDuration, inbetweenAnimation);
-                                    setTimeout(function(){
-                                        sendWebsocketEvent("video-end", {resourceToken: token}); // eslint-disable-line no-undef
-                                    }, millisecondsFromString(exitDuration));
                                 }
                             }
                         }
@@ -757,9 +728,6 @@ const playVideo = {
                     if (videoDuration) {
                         setTimeout(function () {
                             animateVideoExit(`#${wrapperId}`, exitAnimation, exitDuration, inbetweenAnimation);
-                            setTimeout(function(){
-                                sendWebsocketEvent("video-end", {resourceToken: token}); // eslint-disable-line no-undef
-                            }, millisecondsFromString(exitDuration));
                         }, videoDuration);
                     }
                 }

src/backend/variables/builtin-variable-loader.js

@@ -31,6 +31,7 @@ exports.loadReplaceVariables = () => {
         'array-reverse',
         'array-shuffle-raw',
         'array-shuffle',
+        'audio-duration',
         'bits-badge-tier',
         'bits-badge-unlocked-message',
         'bits-cheered',
@@ -203,9 +204,11 @@ exports.loadReplaceVariables = () => {
         'username-array-raw',
         'username-array',
         'username',
+        'video-duration',
         'view-time',
         'whisper-message',
-        'word'
+        'word',
+        'youtube-video-duration'
     ].forEach(filename => {
         const definition = require(`./builtin/${filename}`);
         replaceVariableManager.registerReplaceVariable(definition);

src/backend/variables/builtin/array-element.js

@@ -15,11 +15,16 @@ const model = {
         if (jsonArray) {
             const array = utils.jsonParse(jsonArray);
             if (Array.isArray(array)) {
+                // Check value for being array or object, otherwise return raw value
+                if (Array.isArray(array[index]) || Object.prototype.toString.call(array[index]) == "[object Object]")
+                {
+                    return JSON.stringify(array[index]);
+                }
                 return array[index];
             }
         }
         return null;
     }
 };
 
-module.exports = model;
+module.exports = model;

src/backend/variables/builtin/audio-duration.js

@@ -0,0 +1,29 @@
+"use strict";
+
+const { OutputDataType, VariableCategory } = require("../../../shared/variable-constants");
+
+const frontendCommunicator = require("../../common/frontend-communicator");
+
+const model = {
+    definition: {
+        handle: "audioDuration",
+        usage: "audioDuration[filePathOrUrl]",
+        description: "Attempts to retrieve audio duration.",
+        categories: [VariableCategory.ADVANCED],
+        possibleDataOutput: [OutputDataType.NUMBER]
+    },
+    evaluator: async (trigger, url) => {
+        if (url == null) {
+            return "[NO URL PROVIDED]";
+        }
+        try {
+            return await frontendCommunicator.fireEventAsync("getSoundDuration", {
+                path: url
+            });
+        } catch (err) {
+            return "[ERROR FETCHING DURATION]";
+        }
+    }
+};
+
+module.exports = model;

src/backend/variables/builtin/video-duration.js

@@ -0,0 +1,30 @@
+"use strict";
+
+const { OutputDataType, VariableCategory } = require("../../../shared/variable-constants");
+
+const frontendCommunicator = require("../../common/frontend-communicator");
+const logger = require("../../logwrapper");
+
+const model = {
+    definition: {
+        handle: "videoDuration",
+        usage: "videoDuration[filePathOrUrl]",
+        description: "Attempts to retrieve video duration.",
+        categories: [VariableCategory.ADVANCED],
+        possibleDataOutput: [OutputDataType.TEXT]
+    },
+    evaluator: async (trigger, url) => {
+        if (url == null) {
+            return "[NO URL PROVIDED]";
+        }
+        const result = await frontendCommunicator.fireEventAsync("getVideoDuration", url);
+
+        if (isNaN(result)) {
+            logger.error("Error while retrieving video duration", result);
+            return "[ERROR FETCHING DURATION]";
+        }
+        return result;
+    }
+};
+
+module.exports = model;

src/backend/variables/builtin/youtube-video-duration.js

@@ -0,0 +1,30 @@
+"use strict";
+
+const { OutputDataType, VariableCategory } = require("../../../shared/variable-constants");
+const logger = require("../../logwrapper");
+const frontendCommunicator = require("../../common/frontend-communicator");
+const { parseYoutubeId } = require("../../../shared/youtube-url-parser");
+
+const model = {
+    definition: {
+        handle: "youtubeVideoDuration",
+        usage: "youtubeVideoDuration[urlOrId]",
+        description: "Attempts to retrieve youtube video duration.",
+        categories: [VariableCategory.ADVANCED],
+        possibleDataOutput: [OutputDataType.TEXT]
+    },
+    evaluator: async (trigger, id) => {
+        if (id == null) {
+            return "[NO VIDEO ID PROVIDED]";
+        }
+        const result = await frontendCommunicator.fireEventAsync("getYoutubeVideoDuration", parseYoutubeId(id).id);
+
+        if (isNaN(result)) {
+            logger.error("Error while retrieving youtube video duration", result);
+            return "[ERROR FETCHING DURATION]";
+        }
+        return result;
+    }
+};
+
+module.exports = model;

src/gui/app/app-main.js

@@ -121,9 +121,10 @@
         scheduledTaskService,
         channelRewardsService,
         sortTagsService,
-        iconsService
+        iconsService,
+        videoService
     ) {
-        // 'chatMessagesService' is included so its instantiated on app start
+        // 'chatMessagesService' and 'videoService' are included so they're instantiated on app start
 
         connectionService.loadProfiles();
 

src/gui/app/index.html

@@ -89,6 +89,8 @@
 
     <script src="./app-main.js"></script>
 
+    <script src="https://www.youtube.com/iframe_api"></script>
+
     <!-- include: "type": "js", "files": "controllers/**/*.js" -->
     <script type="text/javascript" src="./controllers/channel-rewards.controller.js"></script>
     <script type="text/javascript" src="./controllers/chat-messages.controller.js"></script>