docs(ci): Update protocol.md - c428201 [skip ci]

Requests: Add scene transition override requests

.editorconfig

@@ -0,0 +1,9 @@
+[*]
+insert_final_newline = true
+
+[*.{c,cpp,h,hpp}]
+indent_style = tab
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2

.github/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+## Contributing to obs-websocket
+
+### Translating obs-websocket to your language
+Localization happens on Crowdin: https://crowdin.com/project/obs-websocket
+
+### Writing code for obs-websocket
+#### Coding Guidelines
+- Function and variable names: snake_case for C names, CamelCase for C++ names
+- Tabs are 8 columns wide
+- 80 columns max.
+
+#### Commit Guidelines
+- Commits follow the 50/72 standard:
+	- 50 characters max for the title
+	- One empty line after the title
+	- Description wrapped to 72 columns max per line.
+- Commit titles:
+	- Use present tense
+	- Prefix the title with a "scope" name
+		- e.g: "CI: fix wrong behaviour when packaging for OS X"
+		- Typical scopes: CI, General, Request, Event, Server
+		- Look at existing commits for more examples

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,16 @@
+##### Issue type
+Bug report? Feature request? Other?
+
+##### Description
+*Replace this with a description of the bug encountered or feature requested.*
+
+##### Steps to reproduce and other useful info
+*If it's a bug, please describe the steps to reproduce it and PLEASE include an OBS log file. Otherwise, remove this section.*
+
+##### Technical information
+- **Operating System** :
+- **OBS Studio version** :
+
+##### Development Environment
+*If you're trying to compile obs-websocket, please describe your compiler type and version (e.g: GCC 4.7, VC2013, ...), and the CMake settings used.  
+Remove this section if it doesn't apply to your case.*

.gitignore

@@ -1,3 +1,10 @@
+*~
+.DS_Store
 /build/
 /build32/
 /build64/
+/release/
+/package/
+/installer/Output/
+.idea
+.vscode

.gitmodules

@@ -1,3 +1,6 @@
-[submodule "deps/mbedtls"]
-	path = deps/mbedtls
-	url = https://github.com/ARMmbed/mbedtls
+[submodule "deps/websocketpp"]
+	path = deps/websocketpp
+	url = https://github.com/zaphoyd/websocketpp.git
+[submodule "deps/asio"]
+	path = deps/asio
+	url = https://github.com/chriskohlhoff/asio.git

BUILDING.md

@@ -0,0 +1,62 @@
+# Compiling obs-websocket
+
+## Prerequisites
+
+You'll need [Qt 5.10.x](https://download.qt.io/official_releases/qt/5.10/),
+[CMake](https://cmake.org/download/) and a working [OBS Studio development environment](https://obsproject.com/wiki/install-instructions) installed on your
+computer.
+
+## Windows
+
+In cmake-gui, you'll have to set the following variables :
+
+- **QTDIR** (path) : location of the Qt environment suited for your compiler and architecture
+- **LIBOBS_INCLUDE_DIR** (path) : location of the libobs subfolder in the source code of OBS Studio
+- **LIBOBS_LIB** (filepath) : location of the obs.lib file
+- **OBS_FRONTEND_LIB** (filepath) : location of the obs-frontend-api.lib file
+
+## Linux
+
+On Debian/Ubuntu :
+
+```shell
+sudo apt-get install libboost-all-dev
+git clone --recursive https://github.com/Palakis/obs-websocket.git
+cd obs-websocket
+mkdir build && cd build
+cmake -DLIBOBS_INCLUDE_DIR="<path to the libobs sub-folder in obs-studio's source code>" -DCMAKE_INSTALL_PREFIX=/usr -DUSE_UBUNTU_FIX=true ..
+make -j4
+sudo make install
+```
+
+## OS X
+
+As a prerequisite, you will need Xcode for your current OSX version, the Xcode command line tools, and [Homebrew](https://brew.sh/).
+Homebrew's setup will guide you in getting your system set up, you should be good to go once Homebrew is successfully up and running.
+
+Use of the Travis macOS CI scripts is recommended. Please note that these
+scripts install new software and can change several settings on your system. An
+existing obs-studio development environment is not required, as
+`install-build-obs-macos.sh` will install it for you. If you already have a
+working obs-studio development environment and have built obs-studio, you can
+skip that script.
+
+Of course, you're encouraged to dig through the contents of these scripts to
+look for issues or specificities.
+
+```shell
+git clone --recursive https://github.com/Palakis/obs-websocket.git
+cd obs-websocket
+./CI/install-dependencies-macos.sh
+./CI/install-build-obs-macos.sh
+./CI/build-macos.sh
+./CI/package-macos.sh
+```
+
+This will result in a ready-to-use `obs-websocket.pkg` installer in the `release` subfolder.
+
+## Automated Builds
+
+- Windows: [![Automated Build status for Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history)
+- Linux: [![Automated Build status for Linux](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
+- macOS: [![Automated Build status for macOS](https://img.shields.io/azure-devops/build/Palakis/obs-websocket/Palakis.obs-websocket.svg)](https://dev.azure.com/Palakis/obs-websocket/_build)

CI/build-macos.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+OSTYPE=$(uname)
+
+if [ "${OSTYPE}" != "Darwin" ]; then
+    echo "[obs-websocket - Error] macOS build script can be run on Darwin-type OS only."
+    exit 1
+fi
+
+HAS_CMAKE=$(type cmake 2>/dev/null)
+
+if [ "${HAS_CMAKE}" = "" ]; then
+    echo "[obs-websocket - Error] CMake not installed - please run 'install-dependencies-macos.sh' first."
+    exit 1
+fi
+
+#export QT_PREFIX="$(find /usr/local/Cellar/qt5 -d 1 | tail -n 1)"
+
+echo "[obs-websocket] Building 'obs-websocket' for macOS."
+mkdir -p build && cd build
+cmake .. \
+	-DQTDIR=/usr/local/opt/qt \
+	-DLIBOBS_INCLUDE_DIR=../../obs-studio/libobs \
+	-DLIBOBS_LIB=../../obs-studio/libobs \
+	-DOBS_FRONTEND_LIB="$(pwd)/../../obs-studio/build/UI/obs-frontend-api/libobs-frontend-api.dylib" \
+	-DCMAKE_BUILD_TYPE=RelWithDebInfo \
+	-DCMAKE_INSTALL_PREFIX=/usr \
+&& make -j4

CI/build-ubuntu.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+set -ex
+
+mkdir build && cd build
+cmake -DCMAKE_INSTALL_PREFIX=/usr -DUSE_UBUNTU_FIX=true ..
+make -j4

CI/download-obs-deps.cmd

@@ -0,0 +1,6 @@
+if not exist %DepsBasePath% (
+    curl -o %DepsBasePath%.zip -kLO https://obsproject.com/downloads/dependencies2017.zip -f --retry 5 -C -
+    7z x %DepsBasePath%.zip -o%DepsBasePath%
+) else (
+    echo "OBS dependencies are already there. Download skipped."
+)

CI/generate-docs.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+set -e
+echo "-- Generating documentation."
+echo "-- Node version: $(node -v)"
+echo "-- NPM version: $(npm -v)"
+
+git fetch origin
+git checkout ${CHECKOUT_REF/refs\/heads\//}
+
+cd docs
+npm install
+npm run build
+
+echo "-- Documentation successfully generated."
+
+if git diff --quiet; then
+	echo "-- No documentation changes to commit."
+	exit 0
+fi
+
+REMOTE_URL="$(git config remote.origin.url)"
+TARGET_REPO=${REMOTE_URL/https:\/\/github.com\//github.com/}
+GITHUB_REPO=https://${GH_TOKEN:-git}@${TARGET_REPO}
+
+git config user.name "Azure CI"
+git config user.email "$COMMIT_AUTHOR_EMAIL"
+
+git add ./generated
+git pull
+git commit -m "docs(ci): Update protocol.md - $(git rev-parse --short HEAD) [skip ci]"
+git push -q $GITHUB_REPO

CI/install-build-obs-macos.sh

@@ -0,0 +1,42 @@
+#!/bin/sh
+
+OSTYPE=$(uname)
+
+if [ "${OSTYPE}" != "Darwin" ]; then
+    echo "[obs-websocket - Error] macOS obs-studio build script can be run on Darwin-type OS only."
+    exit 1
+fi
+
+HAS_CMAKE=$(type cmake 2>/dev/null)
+HAS_GIT=$(type git 2>/dev/null)
+
+if [ "${HAS_CMAKE}" = "" ]; then
+    echo "[obs-websocket - Error] CMake not installed - please run 'install-dependencies-macos.sh' first."
+    exit 1
+fi
+
+if [ "${HAS_GIT}" = "" ]; then
+    echo "[obs-websocket - Error] Git not installed - please install Xcode developer tools or via Homebrew."
+    exit 1
+fi
+
+echo "[obs-websocket] Downloading and unpacking OBS dependencies"
+wget --quiet --retry-connrefused --waitretry=1 https://obs-nightly.s3.amazonaws.com/osx-deps-2018-08-09.tar.gz
+tar -xf ./osx-deps-2018-08-09.tar.gz -C /tmp
+
+# Build obs-studio
+cd ..
+echo "[obs-websocket] Cloning obs-studio from GitHub.."
+git clone https://github.com/obsproject/obs-studio
+cd obs-studio
+OBSLatestTag=$(git describe --tags --abbrev=0)
+git checkout $OBSLatestTag
+mkdir build && cd build
+echo "[obs-websocket] Building obs-studio.."
+cmake .. \
+	-DCMAKE_OSX_DEPLOYMENT_TARGET=10.11 \
+	-DDISABLE_PLUGINS=true \
+    -DENABLE_SCRIPTING=0 \
+	-DDepsPath=/tmp/obsdeps \
+	-DCMAKE_PREFIX_PATH=/usr/local/opt/qt/lib/cmake \
+&& make -j4

CI/install-dependencies-macos.sh

@@ -0,0 +1,61 @@
+#!/bin/sh
+
+
+
+OSTYPE=$(uname)
+
+if [ "${OSTYPE}" != "Darwin" ]; then
+    echo "[obs-websocket - Error] macOS install dependencies script can be run on Darwin-type OS only."
+    exit 1
+fi
+
+HAS_BREW=$(type brew 2>/dev/null)
+
+if [ "${HAS_BREW}" = "" ]; then
+    echo "[obs-websocket - Error] Please install Homebrew (https://www.brew.sh/) to build obs-websocket on macOS."
+    exit 1
+fi
+
+# OBS Studio deps
+echo "[obs-websocket] Updating Homebrew.."
+brew update >/dev/null
+echo "[obs-websocket] Checking installed Homebrew formulas.."
+BREW_PACKAGES=$(brew list)
+BREW_DEPENDENCIES="jack speexdsp ccache swig mbedtls"
+
+for DEPENDENCY in ${BREW_DEPENDENCIES}; do
+    if echo "${BREW_PACKAGES}" | grep -q "^${DEPENDENCY}\$"; then
+        echo "[obs-websocket] Upgrading OBS-Studio dependency '${DEPENDENCY}'.."
+        brew upgrade ${DEPENDENCY} 2>/dev/null
+    else
+        echo "[obs-websocket] Installing OBS-Studio dependency '${DEPENDENCY}'.."
+        brew install ${DEPENDENCY} 2>/dev/null
+    fi
+done
+
+# qtwebsockets deps
+echo "[obs-websocket] Installing obs-websocket dependency 'QT 5.10.1'.."
+# =!= NOTICE =!=
+# When building QT5 from sources on macOS 10.13+, use local qt5 formula:
+# brew install ./CI/macos/qt.rb
+# Pouring from the bottle is much quicker though, so use bottle for now.
+# =!= NOTICE =!=
+
+brew install https://gist.githubusercontent.com/DDRBoxman/b3956fab6073335a4bf151db0dcbd4ad/raw/ed1342a8a86793ea8c10d8b4d712a654da121ace/qt.rb
+
+# Pin this version of QT5 to avoid `brew upgrade`
+# upgrading it to incompatible version
+brew pin qt
+
+# Fetch and install Packages app
+# =!= NOTICE =!=
+# Installs a LaunchDaemon under /Library/LaunchDaemons/fr.whitebox.packages.build.dispatcher.plist
+# =!= NOTICE =!=
+
+HAS_PACKAGES=$(type packagesbuild 2>/dev/null)
+
+if [ "${HAS_PACKAGES}" = "" ]; then
+    echo "[obs-websocket] Installing Packaging app (might require password due to 'sudo').."
+    curl -o './Packages.pkg' --retry-connrefused -s --retry-delay 1 'https://s3-us-west-2.amazonaws.com/obs-nightly/Packages.pkg'
+    sudo installer -pkg ./Packages.pkg -target /
+fi

CI/install-dependencies-ubuntu.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+set -ex
+
+sudo add-apt-repository -y ppa:obsproject/obs-studio
+sudo apt-get -qq update
+
+sudo apt-get install -y \
+	libc-dev-bin \
+	libc6-dev git \
+	build-essential \
+	checkinstall \
+	cmake \
+	obs-studio \
+	qtbase5-dev
+
+# Dirty hack
+sudo wget -O /usr/include/obs/obs-frontend-api.h https://raw.githubusercontent.com/obsproject/obs-studio/25.0.0/UI/obs-frontend-api/obs-frontend-api.h
+
+sudo ldconfig

CI/install-qt-win.cmd

@@ -0,0 +1,8 @@
+if not exist %QtBaseDir% (
+	curl -kLO https://cdn-fastly.obsproject.com/downloads/Qt_5.10.1.7z -f --retry 5 -z Qt_5.10.1.7z
+    7z x Qt_5.10.1.7z -o%QtBaseDir%
+) else (
+	echo "Qt is already installed. Download skipped."
+)
+
+dir %QtBaseDir%

CI/macos/obs-websocket.pkgproj

@@ -0,0 +1,726 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>PROJECT</key>
+	<dict>
+		<key>PACKAGE_FILES</key>
+		<dict>
+			<key>DEFAULT_INSTALL_LOCATION</key>
+			<string>/</string>
+			<key>HIERARCHY</key>
+			<dict>
+				<key>CHILDREN</key>
+				<array>
+					<dict>
+						<key>CHILDREN</key>
+						<array>
+							<dict>
+								<key>CHILDREN</key>
+								<array>
+									<dict>
+										<key>CHILDREN</key>
+										<array>
+											<dict>
+												<key>CHILDREN</key>
+												<array>
+													<dict>
+														<key>CHILDREN</key>
+														<array>
+															<dict>
+																<key>CHILDREN</key>
+																<array>
+																	<dict>
+																		<key>CHILDREN</key>
+																		<array/>
+																		<key>GID</key>
+																		<integer>80</integer>
+																		<key>PATH</key>
+																		<string>../../build/obs-websocket.so</string>
+																		<key>PATH_TYPE</key>
+																		<integer>1</integer>
+																		<key>PERMISSIONS</key>
+																		<integer>493</integer>
+																		<key>TYPE</key>
+																		<integer>3</integer>
+																		<key>UID</key>
+																		<integer>0</integer>
+																	</dict>
+																</array>
+																<key>GID</key>
+																<integer>80</integer>
+																<key>PATH</key>
+																<string>bin</string>
+																<key>PATH_TYPE</key>
+																<integer>0</integer>
+																<key>PERMISSIONS</key>
+																<integer>493</integer>
+																<key>TYPE</key>
+																<integer>2</integer>
+																<key>UID</key>
+																<integer>0</integer>
+															</dict>
+															<dict>
+																<key>CHILDREN</key>
+																<array/>
+																<key>GID</key>
+																<integer>80</integer>
+																<key>PATH</key>
+																<string>../../data</string>
+																<key>PATH_TYPE</key>
+																<integer>1</integer>
+																<key>PERMISSIONS</key>
+																<integer>493</integer>
+																<key>TYPE</key>
+																<integer>3</integer>
+																<key>UID</key>
+																<integer>0</integer>
+															</dict>
+														</array>
+														<key>GID</key>
+														<integer>80</integer>
+														<key>PATH</key>
+														<string>obs-websocket</string>
+														<key>PATH_TYPE</key>
+														<integer>0</integer>
+														<key>PERMISSIONS</key>
+														<integer>493</integer>
+														<key>TYPE</key>
+														<integer>2</integer>
+														<key>UID</key>
+														<integer>0</integer>
+													</dict>
+												</array>
+												<key>GID</key>
+												<integer>80</integer>
+												<key>PATH</key>
+												<string>plugins</string>
+												<key>PATH_TYPE</key>
+												<integer>0</integer>
+												<key>PERMISSIONS</key>
+												<integer>493</integer>
+												<key>TYPE</key>
+												<integer>2</integer>
+												<key>UID</key>
+												<integer>0</integer>
+											</dict>
+										</array>
+										<key>GID</key>
+										<integer>80</integer>
+										<key>PATH</key>
+										<string>obs-studio</string>
+										<key>PATH_TYPE</key>
+										<integer>0</integer>
+										<key>PERMISSIONS</key>
+										<integer>493</integer>
+										<key>TYPE</key>
+										<integer>2</integer>
+										<key>UID</key>
+										<integer>0</integer>
+									</dict>
+								</array>
+								<key>GID</key>
+								<integer>80</integer>
+								<key>PATH</key>
+								<string>Application Support</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Automator</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Documentation</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Extensions</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Filesystems</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Frameworks</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Input Methods</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Internet Plug-Ins</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>LaunchAgents</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>LaunchDaemons</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>PreferencePanes</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Preferences</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>80</integer>
+								<key>PATH</key>
+								<string>Printers</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>PrivilegedHelperTools</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>QuickLook</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>QuickTime</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Screen Savers</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Scripts</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Services</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Widgets</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>493</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+						</array>
+						<key>GID</key>
+						<integer>0</integer>
+						<key>PATH</key>
+						<string>Library</string>
+						<key>PATH_TYPE</key>
+						<integer>0</integer>
+						<key>PERMISSIONS</key>
+						<integer>493</integer>
+						<key>TYPE</key>
+						<integer>1</integer>
+						<key>UID</key>
+						<integer>0</integer>
+					</dict>
+					<dict>
+						<key>CHILDREN</key>
+						<array>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>GID</key>
+								<integer>0</integer>
+								<key>PATH</key>
+								<string>Shared</string>
+								<key>PATH_TYPE</key>
+								<integer>0</integer>
+								<key>PERMISSIONS</key>
+								<integer>1023</integer>
+								<key>TYPE</key>
+								<integer>1</integer>
+								<key>UID</key>
+								<integer>0</integer>
+							</dict>
+						</array>
+						<key>GID</key>
+						<integer>80</integer>
+						<key>PATH</key>
+						<string>Users</string>
+						<key>PATH_TYPE</key>
+						<integer>0</integer>
+						<key>PERMISSIONS</key>
+						<integer>493</integer>
+						<key>TYPE</key>
+						<integer>1</integer>
+						<key>UID</key>
+						<integer>0</integer>
+					</dict>
+				</array>
+				<key>GID</key>
+				<integer>0</integer>
+				<key>PATH</key>
+				<string>/</string>
+				<key>PATH_TYPE</key>
+				<integer>0</integer>
+				<key>PERMISSIONS</key>
+				<integer>493</integer>
+				<key>TYPE</key>
+				<integer>1</integer>
+				<key>UID</key>
+				<integer>0</integer>
+			</dict>
+			<key>PAYLOAD_TYPE</key>
+			<integer>0</integer>
+			<key>VERSION</key>
+			<integer>4</integer>
+		</dict>
+		<key>PACKAGE_SCRIPTS</key>
+		<dict>
+			<key>RESOURCES</key>
+			<array/>
+		</dict>
+		<key>PACKAGE_SETTINGS</key>
+		<dict>
+			<key>AUTHENTICATION</key>
+			<integer>1</integer>
+			<key>CONCLUSION_ACTION</key>
+			<integer>0</integer>
+			<key>IDENTIFIER</key>
+			<string>fr.palakis.obs-websocket</string>
+			<key>OVERWRITE_PERMISSIONS</key>
+			<false/>
+			<key>VERSION</key>
+			<string>4.8.0</string>
+		</dict>
+		<key>PROJECT_COMMENTS</key>
+		<dict>
+			<key>NOTES</key>
+			<data>
+			PCFET0NUWVBFIGh0bWwgUFVCTElDICItLy9XM0MvL0RURCBIVE1M
+			IDQuMDEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvVFIvaHRtbDQv
+			c3RyaWN0LmR0ZCI+CjxodG1sPgo8aGVhZD4KPG1ldGEgaHR0cC1l
+			cXVpdj0iQ29udGVudC1UeXBlIiBjb250ZW50PSJ0ZXh0L2h0bWw7
+			IGNoYXJzZXQ9VVRGLTgiPgo8bWV0YSBodHRwLWVxdWl2PSJDb250
+			ZW50LVN0eWxlLVR5cGUiIGNvbnRlbnQ9InRleHQvY3NzIj4KPHRp
+			dGxlPjwvdGl0bGU+CjxtZXRhIG5hbWU9IkdlbmVyYXRvciIgY29u
+			dGVudD0iQ29jb2EgSFRNTCBXcml0ZXIiPgo8bWV0YSBuYW1lPSJD
+			b2NvYVZlcnNpb24iIGNvbnRlbnQ9IjE0MDQuMTMiPgo8c3R5bGUg
+			dHlwZT0idGV4dC9jc3MiPgo8L3N0eWxlPgo8L2hlYWQ+Cjxib2R5
+			Pgo8L2JvZHk+CjwvaHRtbD4K
+			</data>
+		</dict>
+		<key>PROJECT_SETTINGS</key>
+		<dict>
+			<key>BUILD_PATH</key>
+			<dict>
+				<key>PATH</key>
+				<string>../../release</string>
+				<key>PATH_TYPE</key>
+				<integer>1</integer>
+			</dict>
+			<key>EXCLUDED_FILES</key>
+			<array>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.DS_Store</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Remove .DS_Store files</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove ".DS_Store" files created by the Finder.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.pbdevelopment</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Remove .pbdevelopment files</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove ".pbdevelopment" files created by ProjectBuilder or Xcode.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>CVS</string>
+							<key>TYPE</key>
+							<integer>1</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.cvsignore</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.cvspass</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.svn</string>
+							<key>TYPE</key>
+							<integer>1</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.git</string>
+							<key>TYPE</key>
+							<integer>1</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.gitignore</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Remove SCM metadata</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove helper files and folders used by the CVS, SVN or Git Source Code Management systems.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>classes.nib</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>designable.db</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>info.nib</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Optimize nib files</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove "classes.nib", "info.nib" and "designable.nib" files within .nib bundles.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>Resources Disabled</string>
+							<key>TYPE</key>
+							<integer>1</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Remove Resources Disabled folders</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove "Resources Disabled" folders.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>SEPARATOR</key>
+					<true/>
+				</dict>
+			</array>
+			<key>NAME</key>
+			<string>obs-websocket</string>
+		</dict>
+	</dict>
+	<key>TYPE</key>
+	<integer>1</integer>
+	<key>VERSION</key>
+	<integer>2</integer>
+</dict>
+</plist>

CI/macos/qt.rb

@@ -0,0 +1,163 @@
+# Patches for Qt must be at the very least submitted to Qt's Gerrit codereview
+# rather than their bug-report Jira. The latter is rarely reviewed by Qt.
+class Qt < Formula
+	desc "Cross-platform application and UI framework"
+	homepage "https://www.qt.io/"
+	url "https://download.qt.io/archive/qt/5.10/5.10.1/single/qt-everywhere-src-5.10.1.tar.xz"
+	mirror "https://mirrorservice.org/sites/download.qt-project.org/official_releases/qt/5.10/5.10.1/single/qt-everywhere-src-5.10.1.tar.xz"
+	sha256 "05ffba7b811b854ed558abf2be2ddbd3bb6ddd0b60ea4b5da75d277ac15e740a"
+	head "https://code.qt.io/qt/qt5.git", :branch => "5.10.1", :shallow => false
+
+	bottle do
+		sha256 "8b4bad005596a5f8790150fe455db998ac2406f4e0f04140d6656205d844d266" => :high_sierra
+		sha256 "9c488554935fb573554a4e36d36d3c81e47245b7fefc4b61edef894e67ba1740" => :sierra
+		sha256 "c0407afba5951df6cc4c6f6c1c315972bd41c99cecb4e029919c4c15ab6f7bdc" => :el_capitan
+	end
+
+	keg_only "Qt 5 has CMake issues when linked"
+
+	option "with-docs", "Build documentation"
+	option "with-examples", "Build examples"
+
+	deprecated_option "with-mysql" => "with-mysql-client"
+
+	# OS X 10.7 Lion is still supported in Qt 5.5, but is no longer a reference
+	# configuration and thus untested in practice. Builds on OS X 10.7 have been
+	# reported to fail: <https://github.com/Homebrew/homebrew/issues/45284>.
+	depends_on :macos => :mountain_lion
+
+	depends_on "pkg-config" => :build
+	depends_on :xcode => :build
+	depends_on "mysql-client" => :optional
+	depends_on "postgresql" => :optional
+
+	# Restore `.pc` files for framework-based build of Qt 5 on OS X. This
+	# partially reverts <https://codereview.qt-project.org/#/c/140954/> merged
+	# between the 5.5.1 and 5.6.0 releases. (Remove this as soon as feasible!)
+	#
+	# Core formulae known to fail without this patch (as of 2016-10-15):
+	#   * gnuplot  (with `--with-qt` option)
+	#   * mkvtoolnix (with `--with-qt` option, silent build failure)
+	#   * poppler    (with `--with-qt` option)
+	patch do
+		url "https://raw.githubusercontent.com/Homebrew/formula-patches/e8fe6567/qt5/restore-pc-files.patch"
+		sha256 "48ff18be2f4050de7288bddbae7f47e949512ac4bcd126c2f504be2ac701158b"
+	end
+
+	# Fix compile error on macOS 10.13 around QFixed:
+	# https://github.com/Homebrew/homebrew-core/issues/27095
+	# https://bugreports.qt.io/browse/QTBUG-67545
+	patch do
+		url "https://raw.githubusercontent.com/z00m1n/formula-patches/0de0e229/qt/QTBUG-67545.patch"
+		sha256 "4a115097c7582c7dce4207f5500d13feb8c990eb8a05a43f41953985976ebe6c"
+	end
+
+	# Fix compile error on macOS 10.13 caused by qtlocation dependency
+	# mapbox-gl-native using Boost 1.62.0 does not build with C++ 17:
+	# https://github.com/Homebrew/homebrew-core/issues/27095
+	# https://bugreports.qt.io/browse/QTBUG-67810
+	patch do
+		url "https://raw.githubusercontent.com/z00m1n/formula-patches/a1a1f0dd/qt/QTBUG-67810.patch"
+		sha256 "8ee0bf71df1043f08ebae3aa35036be29c4d9ebff8a27e3b0411a6bd635e9382"
+	end
+
+	def install
+		args = %W[
+			-verbose
+			-prefix #{prefix}
+			-release
+			-opensource -confirm-license
+			-system-zlib
+			-qt-libpng
+			-qt-libjpeg
+			-qt-freetype
+			-qt-pcre
+			-nomake tests
+			-no-rpath
+			-pkg-config
+			-dbus-runtime
+			-no-assimp
+		]
+
+		args << "-nomake" << "examples" if build.without? "examples"
+
+		if build.with? "mysql-client"
+			args << "-plugin-sql-mysql"
+			(buildpath/"brew_shim/mysql_config").write <<~EOS
+				#!/bin/sh
+				if [ x"$1" = x"--libs" ]; then
+					mysql_config --libs | sed "s/-lssl -lcrypto//"
+				else
+					exec mysql_config "$@"
+				fi
+			EOS
+			chmod 0755, "brew_shim/mysql_config"
+			args << "-mysql_config" << buildpath/"brew_shim/mysql_config"
+		end
+
+		args << "-plugin-sql-psql" if build.with? "postgresql"
+
+		system "./configure", *args
+		system "make"
+		ENV.deparallelize
+		system "make", "install"
+
+		if build.with? "docs"
+			system "make", "docs"
+			system "make", "install_docs"
+		end
+
+		# Some config scripts will only find Qt in a "Frameworks" folder
+		frameworks.install_symlink Dir["#{lib}/*.framework"]
+
+		# The pkg-config files installed suggest that headers can be found in the
+		# `include` directory. Make this so by creating symlinks from `include` to
+		# the Frameworks' Headers folders.
+		Pathname.glob("#{lib}/*.framework/Headers") do |path|
+			include.install_symlink path => path.parent.basename(".framework")
+		end
+
+		# Move `*.app` bundles into `libexec` to expose them to `brew linkapps` and
+		# because we don't like having them in `bin`.
+		# (Note: This move breaks invocation of Assistant via the Help menu
+		# of both Designer and Linguist as that relies on Assistant being in `bin`.)
+		libexec.mkpath
+		Pathname.glob("#{bin}/*.app") { |app| mv app, libexec }
+	end
+
+	def caveats; <<~EOS
+		We agreed to the Qt opensource license for you.
+		If this is unacceptable you should uninstall.
+		EOS
+	end
+
+	test do
+		(testpath/"hello.pro").write <<~EOS
+			QT       += core
+			QT       -= gui
+			TARGET = hello
+			CONFIG   += console
+			CONFIG   -= app_bundle
+			TEMPLATE = app
+			SOURCES += main.cpp
+		EOS
+
+		(testpath/"main.cpp").write <<~EOS
+			#include <QCoreApplication>
+			#include <QDebug>
+
+			int main(int argc, char *argv[])
+			{
+				QCoreApplication a(argc, argv);
+				qDebug() << "Hello World!";
+				return 0;
+			}
+		EOS
+
+		system bin/"qmake", testpath/"hello.pro"
+		system "make"
+		assert_predicate testpath/"hello", :exist?
+		assert_predicate testpath/"main.o", :exist?
+		system "./hello"
+	end
+end

CI/package-macos.sh

@@ -0,0 +1,90 @@
+#!/bin/bash
+
+set -e
+
+OSTYPE=$(uname)
+
+if [ "${OSTYPE}" != "Darwin" ]; then
+    echo "[obs-websocket - Error] macOS package script can be run on Darwin-type OS only."
+    exit 1
+fi
+
+echo "[obs-websocket] Preparing package build"
+export QT_CELLAR_PREFIX="$(/usr/bin/find /usr/local/Cellar/qt -d 1 | sort -t '.' -k 1,1n -k 2,2n -k 3,3n | tail -n 1)"
+
+GIT_HASH=$(git rev-parse --short HEAD)
+GIT_BRANCH_OR_TAG=$(git name-rev --name-only HEAD | awk -F/ '{print $NF}')
+
+VERSION="$GIT_HASH-$GIT_BRANCH_OR_TAG"
+
+FILENAME_UNSIGNED="obs-websocket-$VERSION-Unsigned.pkg"
+FILENAME="obs-websocket-$VERSION.pkg"
+
+echo "[obs-websocket] Modifying obs-websocket.so"
+install_name_tool \
+	-change /usr/local/opt/qt/lib/QtWidgets.framework/Versions/5/QtWidgets \
+		@executable_path/../Frameworks/QtWidgets.framework/Versions/5/QtWidgets \
+	-change /usr/local/opt/qt/lib/QtGui.framework/Versions/5/QtGui \
+		@executable_path/../Frameworks/QtGui.framework/Versions/5/QtGui \
+	-change /usr/local/opt/qt/lib/QtCore.framework/Versions/5/QtCore \
+		@executable_path/../Frameworks/QtCore.framework/Versions/5/QtCore \
+	./build/obs-websocket.so
+
+# Check if replacement worked
+echo "[obs-websocket] Dependencies for obs-websocket"
+otool -L ./build/obs-websocket.so
+
+if [[ "$RELEASE_MODE" == "True" ]]; then
+	echo "[obs-websocket] Signing plugin binary: obs-websocket.so"
+	codesign --sign "$CODE_SIGNING_IDENTITY" ./build/obs-websocket.so
+else
+	echo "[obs-websocket] Skipped plugin codesigning"
+fi
+
+echo "[obs-websocket] Actual package build"
+packagesbuild ./CI/macos/obs-websocket.pkgproj
+
+echo "[obs-websocket] Renaming obs-websocket.pkg to $FILENAME"
+mv ./release/obs-websocket.pkg ./release/$FILENAME_UNSIGNED
+
+if [[ "$RELEASE_MODE" == "True" ]]; then
+	echo "[obs-websocket] Signing installer: $FILENAME"
+	productsign \
+		--sign "$INSTALLER_SIGNING_IDENTITY" \
+		./release/$FILENAME_UNSIGNED \
+		./release/$FILENAME
+	rm ./release/$FILENAME_UNSIGNED
+
+	echo "[obs-websocket] Submitting installer $FILENAME for notarization"
+	zip -r ./release/$FILENAME.zip ./release/$FILENAME
+	UPLOAD_RESULT=$(xcrun altool \
+		--notarize-app \
+		--primary-bundle-id "fr.palakis.obs-websocket" \
+		--username "$AC_USERNAME" \
+		--password "$AC_PASSWORD" \
+		--asc-provider "$AC_PROVIDER_SHORTNAME" \
+		--file "./release/$FILENAME.zip")
+	rm ./release/$FILENAME.zip
+
+	REQUEST_UUID=$(echo $UPLOAD_RESULT | awk -F ' = ' '/RequestUUID/ {print $2}')
+	echo "Request UUID: $REQUEST_UUID"
+
+	echo "[obs-websocket] Wait for notarization result"
+	# Pieces of code borrowed from rednoah/notarized-app
+	while sleep 30 && date; do
+		CHECK_RESULT=$(xcrun altool \
+			--notarization-info "$REQUEST_UUID" \
+			--username "$AC_USERNAME" \
+			--password "$AC_PASSWORD" \
+			--asc-provider "$AC_PROVIDER_SHORTNAME")
+		echo $CHECK_RESULT
+
+		if ! grep -q "Status: in progress" <<< "$CHECK_RESULT"; then
+			echo "[obs-websocket] Staple ticket to installer: $FILENAME"
+			xcrun stapler staple ./release/$FILENAME
+			break
+		fi
+	done
+else
+	echo "[obs-websocket] Skipped installer codesigning and notarization"
+fi

CI/package-ubuntu.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -e
+
+export GIT_HASH=$(git rev-parse --short HEAD)
+export PKG_VERSION="1-$GIT_HASH-$BRANCH_SHORT_NAME-git"
+
+if [[ "$BRANCH_FULL_NAME" =~ "^refs/tags/" ]]; then
+	export PKG_VERSION="$BRANCH_SHORT_NAME"
+fi
+
+cd ./build
+
+PAGER="cat" sudo checkinstall -y --type=debian --fstrans=no --nodoc \
+	--backup=no --deldoc=yes --install=no \
+	--pkgname=obs-websocket --pkgversion="$PKG_VERSION" \
+	--pkglicense="GPLv2.0" --maintainer="stephane.lepin@gmail.com" \
+	--pkggroup="video" \
+	--pkgsource="https://github.com/Palakis/obs-websocket" \
+	--requires="obs-studio \(\>= 25.0.7\), libqt5core5a, libqt5widgets5, qt5-image-formats-plugins" \
+	--pakdir="../package"
+
+sudo chmod ao+r ../package/*

CI/package-windows.cmd

@@ -0,0 +1,12 @@
+mkdir package
+cd package
+
+git rev-parse --short HEAD > package-version.txt
+set /p PackageVersion=<package-version.txt
+del package-version.txt
+
+REM Package ZIP archive
+7z a "obs-websocket-%PackageVersion%-Windows.zip" "..\release\*"
+
+REM Build installer
+iscc ..\installer\installer.iss /O. /F"obs-websocket-%PackageVersion%-Windows-Installer"

CI/prepare-obs-windows.cmd

@@ -0,0 +1,37 @@
+
+@echo off
+SETLOCAL EnableDelayedExpansion
+
+REM If obs-studio directory does not exist, clone the git repo
+if not exist %OBSPath% (
+	echo obs-studio directory does not exist
+	git clone https://github.com/obsproject/obs-studio %OBSPath%
+	cd /D %OBSPath%\
+	git describe --tags --abbrev=0 --exclude="*-rc*" > "%OBSPath%\obs-studio-latest-tag.txt"
+    set /p OBSLatestTag=<"%OBSPath%\obs-studio-latest-tag.txt"
+)
+
+REM Prepare OBS Studio builds
+
+echo Running CMake...
+cd /D %OBSPath%
+echo   git checkout %OBSLatestTag%
+git checkout %OBSLatestTag%
+echo:
+
+if not exist build32 mkdir build32
+if not exist build64 mkdir build64
+
+echo   Running cmake for obs-studio %OBSLatestTag% 32-bit...
+cd build32
+cmake -G "Visual Studio 16 2019" -A Win32 -DCMAKE_SYSTEM_VERSION=10.0 -DQTDIR="%QTDIR32%" -DDepsPath="%DepsPath32%" -DBUILD_CAPTIONS=true -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
+echo:
+echo:
+
+echo   Running cmake for obs-studio %OBSLatestTag% 64-bit...
+cd ..\build64
+cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_SYSTEM_VERSION=10.0 -DQTDIR="%QTDIR64%" -DDepsPath="%DepsPath64%" -DBUILD_CAPTIONS=true -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
+echo:
+echo:
+
+dir "%OBSPath%\libobs"

CI/prepare-windows.cmd

@@ -0,0 +1,7 @@
+mkdir build32
+mkdir build64
+
+cd build32
+cmake -G "Visual Studio 16 2019" -A Win32 -DCMAKE_SYSTEM_VERSION=10.0 -DQTDIR="%QTDIR32%" -DLibObs_DIR="%OBSPath%\build32\libobs" -DLIBOBS_INCLUDE_DIR="%OBSPath%\libobs" -DLIBOBS_LIB="%OBSPath%\build32\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="%OBSPath%\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
+cd ..\build64
+cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_SYSTEM_VERSION=10.0 -DQTDIR="%QTDIR64%" -DLibObs_DIR="%OBSPath%\build64\libobs" -DLIBOBS_INCLUDE_DIR="%OBSPath%\libobs" -DLIBOBS_LIB="%OBSPath%\build64\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="%OBSPath%\build64\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..

CMakeLists.txt

@@ -1,58 +1,210 @@
 cmake_minimum_required(VERSION 3.5)
-project(obs-websocket)
+project(obs-websocket VERSION 4.8.0)
 
 set(CMAKE_PREFIX_PATH "${QTDIR}")
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTOUIC ON)
 
-include(external/FindLibObs.cmake)
-find_package(LibObs REQUIRED)
-find_package(Qt5Core REQUIRED)
-find_package(Qt5WebSockets REQUIRED)
-find_package(Qt5Widgets REQUIRED)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-add_subdirectory(deps/mbedtls EXCLUDE_FROM_ALL)
-set(ENABLED_PROGRAMS false)
+add_definitions(-DASIO_STANDALONE)
 
-set(OBS_FRONTEND_LIB "OBS_FRONTEND_LIB-NOTFOUND" CACHE FILEPATH "OBS frontend library")
-if(OBS_FRONTEND_LIB EQUAL "OBS_FRONTEND_LIB-NOTFOUND")
-	message(FATAL_ERROR "Could not find OBS Frontend API\'s library !")
+if (WIN32 OR APPLE)
+	include(external/FindLibObs.cmake)
 endif()
 
+find_package(LibObs REQUIRED)
+find_package(Qt5 REQUIRED COMPONENTS Core Widgets)
+
 set(obs-websocket_SOURCES
-	obs-websocket.cpp
-	WSServer.cpp
-	WSRequestHandler.cpp
-	WSEvents.cpp
-	Config.cpp
-	Utils.cpp
-	forms/settings-dialog.cpp)
+	src/obs-websocket.cpp
+	src/WSServer.cpp
+	src/ConnectionProperties.cpp
+	src/WSRequestHandler.cpp
+	src/WSRequestHandler_General.cpp
+	src/WSRequestHandler_Profiles.cpp
+	src/WSRequestHandler_Recording.cpp
+	src/WSRequestHandler_ReplayBuffer.cpp
+	src/WSRequestHandler_SceneCollections.cpp
+	src/WSRequestHandler_Scenes.cpp
+	src/WSRequestHandler_SceneItems.cpp
+	src/WSRequestHandler_Sources.cpp
+	src/WSRequestHandler_Streaming.cpp
+	src/WSRequestHandler_StudioMode.cpp
+	src/WSRequestHandler_Transitions.cpp
+	src/WSRequestHandler_Outputs.cpp
+	src/WSEvents.cpp
+	src/Config.cpp
+	src/Utils.cpp
+	src/rpc/RpcRequest.cpp
+	src/rpc/RpcResponse.cpp
+	src/rpc/RpcEvent.cpp
+	src/protocol/OBSRemoteProtocol.cpp
+	src/forms/settings-dialog.cpp)
 
 set(obs-websocket_HEADERS
-	obs-websocket.h
-	WSServer.h
-	WSRequestHandler.h
-	WSEvents.h
-	Config.h
-	Utils.h
-	forms/settings-dialog.h)
+	src/obs-websocket.h
+	src/WSServer.h
+	src/ConnectionProperties.h
+	src/WSRequestHandler.h
+	src/WSEvents.h
+	src/Config.h
+	src/Utils.h
+	src/rpc/RpcRequest.h
+	src/rpc/RpcResponse.h
+	src/rpc/RpcEvent.h
+	src/protocol/OBSRemoteProtocol.h
+	src/forms/settings-dialog.h)
 
+# --- Platform-independent build settings ---
 add_library(obs-websocket MODULE
 	${obs-websocket_SOURCES}
 	${obs-websocket_HEADERS})
-add_dependencies(obs-websocket mbedcrypto)
+
 include_directories(
 	"${LIBOBS_INCLUDE_DIR}/../UI/obs-frontend-api"
 	${Qt5Core_INCLUDES}
-	${Qt5WebSockets_INCLUDES}
 	${Qt5Widgets_INCLUDES}
-	${mbedcrypto_INCLUDES}
-	"${CMAKE_SOURCE_DIR}/deps/mbedtls/include")
+	"${CMAKE_SOURCE_DIR}/deps/asio/asio/include"
+	"${CMAKE_SOURCE_DIR}/deps/websocketpp")
+
 target_link_libraries(obs-websocket
 	libobs
-	${OBS_FRONTEND_LIB}
 	Qt5::Core
-	Qt5::WebSockets
-	Qt5::Widgets
-	mbedcrypto)
+	Qt5::Widgets)
+
+# --- End of section ---
+
+# --- Windows-specific build settings and tasks ---
+if(WIN32)
+	if(NOT DEFINED OBS_FRONTEND_LIB)
+		set(OBS_FRONTEND_LIB "OBS_FRONTEND_LIB-NOTFOUND" CACHE FILEPATH "OBS frontend library")
+		message(FATAL_ERROR "Could not find OBS Frontend API's library !")
+	endif()
+
+    if(MSVC)
+        # Enable Multicore Builds and disable FH4 (to not depend on VCRUNTIME140_1.DLL)
+	    add_definitions(/MP /d2FH4-)
+    endif()
+
+	add_definitions(-D_WEBSOCKETPP_CPP11_STL_)
+
+	if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+		set(ARCH_NAME "64bit")
+		set(OBS_BUILDDIR_ARCH "build64")
+	else()
+		set(ARCH_NAME "32bit")
+		set(OBS_BUILDDIR_ARCH "build32")
+	endif()
+
+	include_directories(
+		"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/UI"
+	)
+
+	target_link_libraries(obs-websocket
+		"${OBS_FRONTEND_LIB}")
+
+	# --- Release package helper ---
+	# The "release" folder has a structure similar OBS' one on Windows
+	set(RELEASE_DIR "${PROJECT_SOURCE_DIR}/release")
+
+	add_custom_command(TARGET obs-websocket POST_BUILD
+		# If config is Release, package release files
+		COMMAND if $<CONFIG:Release>==1 (
+			"${CMAKE_COMMAND}" -E make_directory
+			"${RELEASE_DIR}/data/obs-plugins/obs-websocket"
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+
+		COMMAND if $<CONFIG:Release>==1 ("${CMAKE_COMMAND}" -E copy_directory
+			"${PROJECT_SOURCE_DIR}/data"
+			"${RELEASE_DIR}/data/obs-plugins/obs-websocket")
+
+		COMMAND if $<CONFIG:Release>==1 ("${CMAKE_COMMAND}" -E copy
+			"$<TARGET_FILE:obs-websocket>"
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+
+		# In Release mode, copy Qt image format plugins
+		COMMAND if $<CONFIG:Release>==1 (
+			"${CMAKE_COMMAND}" -E copy
+			"${QTDIR}/plugins/imageformats/qjpeg.dll"
+			"${RELEASE_DIR}/bin/${ARCH_NAME}/imageformats/qjpeg.dll")
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 (
+			"${CMAKE_COMMAND}" -E copy
+			"${QTDIR}/plugins/imageformats/qjpeg.dll"
+			"${RELEASE_DIR}/bin/${ARCH_NAME}/imageformats/qjpeg.dll")
+
+		# If config is RelWithDebInfo, package release files
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 (
+			"${CMAKE_COMMAND}" -E make_directory
+			"${RELEASE_DIR}/data/obs-plugins/obs-websocket"
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy_directory
+			"${PROJECT_SOURCE_DIR}/data"
+			"${RELEASE_DIR}/data/obs-plugins/obs-websocket")
+
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
+			"$<TARGET_FILE:obs-websocket>"
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
+			"$<TARGET_PDB_FILE:obs-websocket>"
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+
+		# Copy to obs-studio dev environment for immediate testing
+		COMMAND if $<CONFIG:Debug>==1 (
+			"${CMAKE_COMMAND}" -E copy
+				"$<TARGET_FILE:obs-websocket>"
+				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}")
+
+		COMMAND if $<CONFIG:Debug>==1 (
+			"${CMAKE_COMMAND}" -E copy
+				"$<TARGET_PDB_FILE:obs-websocket>"
+				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}")
+
+		COMMAND if $<CONFIG:Debug>==1 (
+			"${CMAKE_COMMAND}" -E make_directory
+				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/data/obs-plugins/obs-websocket")
+
+		COMMAND if $<CONFIG:Debug>==1 (
+			"${CMAKE_COMMAND}" -E copy_directory
+				"${PROJECT_SOURCE_DIR}/data"
+				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/data/obs-plugins/obs-websocket")
+	)
+	# --- End of sub-section ---
+
+endif()
+# --- End of section ---
+
+# --- Linux-specific build settings and tasks ---
+if(UNIX AND NOT APPLE)
+	include(GNUInstallDirs)
+
+	set_target_properties(obs-websocket PROPERTIES PREFIX "")
+	target_link_libraries(obs-websocket obs-frontend-api)
+
+	file(GLOB locale_files data/locale/*.ini)
+
+	if(${USE_UBUNTU_FIX})
+		install(TARGETS obs-websocket
+			LIBRARY DESTINATION "/usr/lib/obs-plugins")
+	endif()
+	install(TARGETS obs-websocket
+		LIBRARY DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}/obs-plugins")
+
+	install(FILES ${locale_files}
+		DESTINATION "${CMAKE_INSTALL_FULL_DATAROOTDIR}/obs/obs-plugins/obs-websocket/locale")
+endif()
+# --- End of section ---
+
+# -- OS X specific build settings and tasks --
+if(APPLE)
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++ -fvisibility=default")
+
+	set(CMAKE_SKIP_RPATH TRUE)
+	set_target_properties(obs-websocket PROPERTIES PREFIX "")
+	target_link_libraries(obs-websocket "${OBS_FRONTEND_LIB}")
+endif()
+# -- End of section --

Config.cpp

@@ -1,153 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#include <mbedtls/base64.h>
-#include <mbedtls/sha256.h>
-#include <obs-frontend-api.h>
-#include "Config.h"
-
-#define CONFIG_SECTION_NAME "obs-websocket"
-#define CONFIG_PARAM_SECRET "auth_hash"
-#define CONFIG_PARAM_SALT "auth_salt"
-#define CONFIG_PARAM_AUTHREQUIRED "auth_required"
-
-Config *Config::_instance = new Config();
-
-Config::Config() {
-	// Default settings
-	AuthRequired = false;
-	Secret = "";
-	Salt = "";
-	SettingsLoaded = false;
-
-	mbedtls_entropy_init(&entropy);
-	mbedtls_ctr_drbg_init(&rng);
-	mbedtls_ctr_drbg_seed(&rng, mbedtls_entropy_func, &entropy, nullptr, 0);
-	//mbedtls_ctr_drbg_set_prediction_resistance(&rng, MBEDTLS_CTR_DRBG_PR_ON);
-
-	SessionChallenge = GenerateSalt();
-}
-
-Config::~Config() {
-	mbedtls_ctr_drbg_free(&rng);
-	mbedtls_entropy_free(&entropy);
-}
-
-const char* Config::GenerateSalt() {
-	// Generate 32 random chars
-	unsigned char *random_chars = (unsigned char *)bzalloc(32);
-	mbedtls_ctr_drbg_random(&rng, random_chars, 32);
-
-	// Convert the 32 random chars to a base64 string
-	unsigned char *salt = (unsigned char*)bzalloc(64);
-	size_t salt_bytes;
-	mbedtls_base64_encode(salt, 64, &salt_bytes, random_chars, 32);
-	salt[salt_bytes] = 0; // Null-terminate the string
-
-	bfree(random_chars);
-	return (char *)salt;
-}
-
-const char* Config::GenerateSecret(const char *password, const char *salt) {
-	size_t passwordLength = strlen(password);
-	size_t saltLength = strlen(salt);
-
-	// Concatenate the password and the salt
-	unsigned char *passAndSalt = (unsigned char*)bzalloc(passwordLength + saltLength);
-	memcpy(passAndSalt, password, passwordLength);
-	memcpy(passAndSalt + passwordLength, salt, saltLength);
-	passAndSalt[passwordLength + saltLength] = 0; // Null-terminate the string
-
-	// Generate a SHA256 hash of the password
-	unsigned char *challengeHash = (unsigned char *)bzalloc(32);
-	mbedtls_sha256(passAndSalt, passwordLength + saltLength, challengeHash, 0);
-	
-	// Encode SHA256 hash to Base64
-	unsigned char *challenge = (unsigned char*)bzalloc(64);
-	size_t challenge_bytes = 0;
-	mbedtls_base64_encode(challenge, 64, &challenge_bytes, challengeHash, 32);
-	challenge[64] = 0; // Null-terminate the string
-
-	bfree(passAndSalt);
-	bfree(challengeHash);
-	return (char*)challenge;
-}
-
-void Config::SetPassword(const char *password) {
-	const char *new_salt = GenerateSalt();
-	const char *new_challenge = GenerateSecret(password, new_salt);
-
-	this->Salt = new_salt;
-	this->Secret = new_challenge;
-}
-
-bool Config::CheckAuth(const char *response) {
-	size_t secretLength = strlen(this->Secret);
-	size_t sessChallengeLength = strlen(this->SessionChallenge);
-	
-	// Concatenate auth secret with the challenge sent to the user
-	char *challengeAndResponse = (char*)bzalloc(secretLength + sessChallengeLength);
-	memcpy(challengeAndResponse, this->Secret, secretLength);
-	memcpy(challengeAndResponse + secretLength, this->SessionChallenge, sessChallengeLength);
-	challengeAndResponse[secretLength + sessChallengeLength] = 0; // Null-terminate the string
-
-	// Generate a SHA256 hash of challengeAndResponse
-	unsigned char *hash = (unsigned char*)bzalloc(32);
-	mbedtls_sha256((unsigned char*)challengeAndResponse, secretLength + sessChallengeLength, hash, 0);
-
-	// Encode the SHA256 hash to Base64
-	unsigned char *expected_response = (unsigned char*)bzalloc(64);
-	size_t base64_size = 0;
-	mbedtls_base64_encode(expected_response, 64, &base64_size, hash, 32);
-	expected_response[64] = 0; // Null-terminate the string
-
-	if (strcmp((char*)expected_response, response) == 0) {
-		SessionChallenge = GenerateSalt();
-		return true;
-	}
-	else {
-		return false;
-	}
-}
-
-void Config::OBSSaveCallback(obs_data_t *save_data, bool saving, void *private_data) {
-	Config *conf = static_cast<Config *>(private_data);
-
-	if (saving) {
-		obs_data_t *settings = obs_data_create();
-		obs_data_set_bool(settings, CONFIG_PARAM_AUTHREQUIRED, conf->AuthRequired);
-		obs_data_set_string(settings, CONFIG_PARAM_SECRET, conf->Secret);
-		obs_data_set_string(settings, CONFIG_PARAM_SALT, conf->Salt);
-
-		obs_data_set_obj(save_data, CONFIG_SECTION_NAME, settings);
-	}
-	else {
-		obs_data_t *settings = obs_data_get_obj(save_data, CONFIG_SECTION_NAME);
-		if (settings) {
-			conf->AuthRequired = obs_data_get_bool(settings, CONFIG_PARAM_AUTHREQUIRED);
-			conf->Secret = obs_data_get_string(settings, CONFIG_PARAM_SECRET);
-			conf->Salt = obs_data_get_string(settings, CONFIG_PARAM_SALT);
-
-			conf->SettingsLoaded = true;
-		}
-	}
-}
-
-Config* Config::Current() {
-	return _instance;
-}

PROTOCOL.md

@@ -1,104 +0,0 @@
-obs-websocket protocol reference
-================================
-
-## General introduction
-**This document is still a WIP. Some things are missing (but won't stay like this for long).**
-
-Messages exchanged between the client and the server are JSON objects.
-The protocol in general in based on the OBS Remote protoctol created by Bill Hamilton, with new commands specific to OBS Studio. 
-
-## Events
-
-### Description
-Events are sent exclusively by the server and broadcasted to every client connected to the server.
-An event message has at least one field :
-- **update-type** (string) : the type of event
-Additional fields will be present in the event message if the event type requires it.
-
-### Event types
-#### "SwitchScenes" 
-OBS is switching to another scene.  
-Additional fields :
-- **scene-name** : the name of the scene being switched to
-
-#### "ScenesChanged"
-The scene list has been modified (scenes added, removed or moved).
-
-#### "StreamStarting"
-Streaming is starting but isn't completely started yet.
-
-#### "StreamStarted"
-*New in OBS Studio*
-Streaming has been started successfully.
-
-#### "StreamStopping"
-Streaming is stopping but isn't completely stopped yet.
-
-#### "StreamStopped"
-*New in OBS Studio*  
-Streaming has been stopped successfully.
-
-#### "RecordingStarting"
-*New in OBS Studio*  
-Recording is starting but isn't completely started yet.
-
-#### "RecordingStarted"
-*New in OBS Studio*  
-Recording has been started successfully.
-
-#### "RecordingStopping"
-*New in OBS Studio*  
-Recording is stopping but isn't completely stopped yet.
-
-#### "RecordingStopped"
-*New in OBS Studio*  
-Recording has been stopped successfully.
-
-#### "StreamStatus"
-Sent every second with those additional fields :  
-- **streaming** (bool) : streaming state
-- **recording** (bool) : recording state
-- **preview-only** (bool) : always false.
-- **bytes-per-sec** (integer) : during streaming, amount of data (in bytes) transmitted by the stream encoder
-- **strain** (double) : i have no idea what this is
-- **total-stream-time** (integer) : total time since the beginning of streaming
-- **num-total-frames** (integer) : total number of frames transmitted since the beginning
-- **num-dropped-frames** (integer) : number of frames dropped by the encoder for the current streaming session
-- **fps** (double) : current framerate
-
-#### "Exiting"
-*New in OBS Studio*  
-OBS is exiting.
-
-## Requests
-
-### Description
-Requests are sent by the client and have at least two fields :
-- **"request-type"** (string) : one of the request types listed in the sub-section "Requests".
-- **"message-id"** (string) : an string defined by the client that will be embedded in the response from the server.
-Depending on the request type, additional fields are needed in the request message (see the "Request types" section below for more informations).
-
-Once a request is sent, the server processes it and sends a JSON response to the client with the following fields in it :
-- **"message-id"** (string) : the custom string you specified in the request.
-- **"status"** (string) : two possible values : "ok" or "error".
-- **"error"** (string) : the error message associated with an error reponse (when "status" equals "error").
-Additional fields can be sent in the response if a request type requires it.
-
-### Request types
-#### "GetVersion"
-#### "GetAuthRequired"
-#### "Authenticate"
-#### "GetCurrentScene"
-#### "SetCurrentScene"
-#### "GetSceneList"
-#### "SetSourceRender"
-#### "StartStopStreaming"
-#### "StartStopRecording"
-*New in OBS Studio*
-#### "GetStreamingStatus"
-#### "GetTransitionList"
-*New in OBS Studio*
-#### "GetCurrentTransition"
-*New in OBS Studio*
-#### "SetCurrentTransition"
-*New in OBS Studio*

README.md

@@ -1,19 +1,134 @@
 obs-websocket
 ==============
-Websocket API for OBS Studio.
 
-## Build prerequisites
-You need QT 5.7 (with QtWebSockets), CMake, and a working development environment for OBS Studio installed on your computer.
+WebSockets API for OBS Studio.
 
-## How to build
-In CMake, you'll need to fill these CMake variables :
-- **QTDIR** (path) : location of the Qt environment suited for your compiler and architecture
-- **LIBOBS_INCLUDE_DIR** (path) : location of the libobs subfolder in the source code of OBS Studio
-- **LIBOBS_LIB** (filepath) : location of the obs.lib file
-- **OBS_FRONTEND_LIB** (filepath) : location of the obs-frontend-api.lib file
+Follow the main author on Twitter for news & updates : [@LePalakis](https://twitter.com/LePalakis)
 
-After building the obs-websocket plugin's binary, copy its Qt dependencies (QtCore, QtNetwork and QtWebSockets library binaries) in the same folder.
+[![Build Status](https://dev.azure.com/Palakis/obs-websocket/_apis/build/status/Palakis.obs-websocket?branchName=4.x-current)](https://dev.azure.com/Palakis/obs-websocket/_build/latest?definitionId=2&branchName=4.x-current)
 
-## How to use
-There's currently no frontend or language API available for obs-websocket. However, the full protocol reference is documented in the [PROTOCOL.md](PROTOCOL.md) file.  
-A simple websocket client can connect to the plugin's embedded server.
+## Downloads
+
+Binaries for Windows, MacOS, and Linux are available in the [Releases](https://github.com/Palakis/obs-websocket/releases) section.
+
+## Using obs-websocket
+
+A web client and frontend made by [t2t2](https://github.com/t2t2/obs-tablet-remote) (compatible with tablets and other touch interfaces) is available here : http://t2t2.github.io/obs-tablet-remote/
+
+It is **highly recommended** to protect obs-websocket with a password against unauthorized control. To do this, open the "Websocket server settings" dialog under OBS' "Tools" menu. In the settings dialogs, you can enable or disable authentication and set a password for it.
+
+### Possible use cases
+
+- Remote control OBS from a phone or tablet on the same local network
+- Change your stream overlay/graphics based on the current scene
+- Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)
+
+### For developers
+
+The server is a typical Websockets server running by default on port 4444 (the port number can be changed in the Settings dialog).
+The protocol understood by the server is documented in [PROTOCOL.md](docs/generated/protocol.md).
+
+Here's a list of available language APIs for obs-websocket :
+- Javascript (browser & nodejs): [obs-websocket-js](https://github.com/haganbmj/obs-websocket-js) by Brendan Hagan
+- C#/VB.NET: [obs-websocket-dotnet](https://github.com/Palakis/obs-websocket-dotnet)
+- Python 2 and 3: [obs-websocket-py](https://github.com/Elektordi/obs-websocket-py) by Guillaume Genty a.k.a Elektordi
+- Python 3.5+ with asyncio: [obs-ws-rc](https://github.com/KirillMysnik/obs-ws-rc) by Kirill Mysnik
+- Python 3.6+ with asyncio: [simpleobsws](https://github.com/IRLToolkit/simpleobsws) by tt2468 
+- Java 8+: [obs-websocket-java](https://github.com/Twasi/websocket-obs-java) by TwasiNET
+- Golang: [go-obs-websocket](https://github.com/christopher-dG/go-obs-websocket) by Chris de Graaf
+- HTTP API: [obs-websocket-http](https://github.com/IRLToolkit/obs-websocket-http) by tt2468
+
+I'd like to know what you're building with or for obs-websocket. If you do something in this fashion, feel free to drop me an email at `stephane /dot/ lepin /at/ gmail /dot/ com` !
+
+## Compiling obs-websocket
+
+See the [build instructions](BUILDING.md).
+
+## Contributing
+
+### Branches
+
+Development happens on `4.x-current`
+
+### Pull Requests
+
+Pull Requests must never be based off your fork's main branch (in this case, `4.x-current`). Start your work in a new branch
+based on the main one (e.g.: `cool-new-feature`, `fix-palakis-mistakes`, ...) and open a Pull Request once you feel ready to show your work.
+
+**If your Pull Request is not ready to merge yet, create it as a Draft Pull Request** (open the little arrow menu next to the "Create pull request" button, then select "Create draft pull request").
+
+### Code style & formatting
+
+Source code is indented with tabs, with spaces allowed for alignment.
+
+Regarding protocol changes: new and updated request types / events must always come with accompanying documentation comments (see existing protocol elements for examples).
+These are required to automatically generate the [protocol specification document](docs/generated/protocol.md).
+
+Among other recommendations: favor return-early code and avoid wrapping huge portions of code in conditionals. As an example, this:
+
+```cpp
+if (success) {
+    return req->SendOKResponse();
+} else {
+    return req->SendErrorResponse("something went wrong");
+}
+```
+
+is better like this:
+
+```cpp
+if (!success) {
+    return req->SendErrorResponse("something went wrong");
+}
+return req->SendOKResponse();
+```
+
+
+## Translations
+
+**Your help is welcome on translations**. Please join the localization project on Crowdin: https://crowdin.com/project/obs-websocket
+
+## Special thanks
+
+In (almost) order of appearance:
+
+- [Brendan H.](https://github.com/haganbmj): Code contributions and gooder English in the Protocol specification
+- [Mikhail Swift](https://github.com/mikhailswift): Code contributions
+- [Tobias Frahmer](https://github.com/Frahmer): Initial German localization
+- [Genture](https://github.com/Genteure): Initial Simplified Chinese and Traditional Chinese localizations
+- [Larissa Gabilan](https://github.com/laris151): Initial Portuguese localization
+- [Andy Asquelt](https://github.com/asquelt): Initial Polish localization
+- [Marcel Haazen](https://github.com/nekocentral): Initial Dutch localization
+- [Peter Antonvich](https://github.com/pantonvich): Code contributions
+- [yinzara](https://github.com/yinzara): Code contributions
+- [Chris Angelico](https://github.com/Rosuav): Code contributions
+- [Guillaume "Elektordi" Genty](https://github.com/Elektordi): Code contributions
+- [Marwin M](https://github.com/dragonbane0): Code contributions
+- [Logan S.](https://github.com/lsdaniel): Code contributions
+- [RainbowEK](https://github.com/RainbowEK): Code contributions
+- [RytoEX](https://github.com/RytoEX): CI script and code contributions
+- [Theodore Stoddard](https://github.com/TStod): Code contributions
+- [Philip Loche](https://github.com/PicoCentauri): Code contributions
+- [Patrick Heyer](https://github.com/PatTheMav): Code contributions and CI fixes
+- [Alex Van Camp](https://github.com/Lange): Code contributions
+- [Freddie Meyer](https://github.com/DungFu): Code contributions
+- [Casey Muller](https://github.com/caseymrm): CI fixes
+- [Chris Angelico](https://github.com/Rosuav): Documentation fixes
+
+And also: special thanks to supporters of the project!
+
+## Supporters
+
+They have contributed financially to the project and made possible the addition of several features into obs-websocket. Many thanks to them!
+
+---
+
+[Support Class](http://supportclass.net) designs and develops professional livestreams, with services ranging from broadcast graphics design and integration to event organization, along many other skills.  
+
+[![Support Class](.github/images/supportclass_logo_blacktext.png)](http://supportclass.net)
+
+---
+
+[MediaUnit](http://www.mediaunit.no) is a Norwegian media company developing products and services for the media industry, primarly focused on web and events.  
+
+[![MediaUnit](.github/images/mediaunit_logo_black.png)](http://www.mediaunit.no/)

Utils.cpp

@@ -1,115 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#include "Utils.h"
-
-obs_data_array_t* Utils::GetSceneItems(obs_source_t *source) {
-	obs_data_array_t *items = obs_data_array_create();
-	obs_scene_t *scene = obs_scene_from_source(source);
-	if (scene == NULL) {
-		return NULL;
-	}
-
-	obs_scene_enum_items(scene, [](obs_scene_t *scene, obs_sceneitem_t *currentItem, void *param) {
-		obs_data_array_t *data = static_cast<obs_data_array_t *>(param);
-		obs_data_array_push_back(data, GetSceneItemData(currentItem));
-		return true;
-	}, items);
-
-	obs_scene_release(scene);
-	return items;
-}
-
-obs_data_t* Utils::GetSceneItemData(obs_sceneitem_t *item) {
-	if (!item) {
-		return NULL;
-	}
-
-	vec2 pos;
-	obs_sceneitem_get_pos(item, &pos);
-
-	vec2 bounds;
-	obs_sceneitem_get_bounds(item, &bounds);
-
-	obs_data_t *data = obs_data_create();
-	obs_data_set_string(data, "name", obs_source_get_name(obs_sceneitem_get_source(item)));
-	obs_data_set_string(data, "type", obs_source_get_id(obs_sceneitem_get_source(item)));
-	obs_data_set_double(data, "volume", obs_source_get_volume(obs_sceneitem_get_source(item)));
-	obs_data_set_double(data, "x", pos.x);
-	obs_data_set_double(data, "y", pos.y);
-	obs_data_set_double(data, "cx", bounds.x);
-	obs_data_set_double(data, "cy", bounds.y);
-	obs_data_set_bool(data, "render", obs_sceneitem_visible(item));
-
-	return data;
-}
-
-
-obs_sceneitem_t* Utils::GetSceneItemFromName(obs_source_t* source, const char* name) {
-	struct current_search {
-		const char* query;
-		obs_sceneitem_t* result;
-	};
-
-	current_search search;
-	search.query = name;
-	search.result = NULL;
-
-	obs_scene_t *scene = obs_scene_from_source(source);
-	if (scene == NULL) {
-		return NULL;
-	}
-
-	obs_scene_enum_items(scene, [](obs_scene_t *scene, obs_sceneitem_t *currentItem, void *param) {
-		current_search *search = static_cast<current_search *>(param);
-		
-		const char* currentItemName = obs_source_get_name(obs_sceneitem_get_source(currentItem));
-		if (strcmp(currentItemName, search->query) == 0) {
-			search->result = currentItem;
-			obs_sceneitem_addref(search->result);
-			return false;
-		}
-
-		return true;
-	}, &search);
-
-	return search.result;
-}
-
-obs_data_array_t* Utils::GetScenes() {
-	obs_frontend_source_list sceneList = {};
-	obs_frontend_get_scenes(&sceneList);
-
-	obs_data_array_t* scenes = obs_data_array_create();
-	for (size_t i = 0; i < (&sceneList)->sources.num; i++) {
-		obs_source_t* scene = (&sceneList)->sources.array[i];
-		obs_data_array_push_back(scenes, GetSceneData(scene));
-	}
-
-	obs_frontend_source_list_free(&sceneList);
-
-	return scenes;
-}
-
-obs_data_t* Utils::GetSceneData(obs_source *source) {
-	obs_data_t* sceneData = obs_data_create();
-	obs_data_set_string(sceneData, "name", obs_source_get_name(source));
-	obs_data_set_array(sceneData, "sources", GetSceneItems(source));
-	
-	return sceneData;
-}

WSEvents.cpp

@@ -1,215 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#include "WSEvents.h"
-
-WSEvents::WSEvents(WSServer *server) {
-	_srv = server;
-	obs_frontend_add_event_callback(WSEvents::FrontendEventHandler, this);
-
-	QTimer *statusTimer = new QTimer();
-	connect(statusTimer, SIGNAL(timeout()), this, SLOT(StreamStatus()));
-	statusTimer->start(1000);
-}
-
-WSEvents::~WSEvents() {
-	obs_frontend_remove_event_callback(WSEvents::FrontendEventHandler, this);
-}
-
-void WSEvents::FrontendEventHandler(enum obs_frontend_event event, void *private_data)
-{
-	WSEvents *owner = static_cast<WSEvents *>(private_data);
-
-	// TODO : implement SourceChanged, SourceOrderChanged and RepopulateSources
-
-	if (event == OBS_FRONTEND_EVENT_SCENE_CHANGED) {
-		owner->OnSceneChange();
-	}
-	else if (event == OBS_FRONTEND_EVENT_SCENE_LIST_CHANGED) {
-		owner->OnSceneListChange();
-	}
-	else if (event == OBS_FRONTEND_EVENT_STREAMING_STARTING) {
-		owner->OnStreamStarting();
-	}
-	else if (event == OBS_FRONTEND_EVENT_STREAMING_STARTED) {
-		owner->OnStreamStarted();
-	}
-	else if (event == OBS_FRONTEND_EVENT_STREAMING_STOPPING) {
-		owner->OnStreamStopping();
-	}
-	else if (event == OBS_FRONTEND_EVENT_STREAMING_STOPPED) {
-		owner->OnStreamStopped();
-	}
-	else if (event == OBS_FRONTEND_EVENT_RECORDING_STARTING) {
-		owner->OnRecordingStarting();
-	}
-	else if (event == OBS_FRONTEND_EVENT_RECORDING_STARTED) {
-		owner->OnRecordingStarted();
-	}
-	else if (event == OBS_FRONTEND_EVENT_RECORDING_STARTING) {
-		owner->OnRecordingStarting();
-	}
-	else if (event == OBS_FRONTEND_EVENT_RECORDING_STOPPED) {
-		owner->OnRecordingStopped();
-	}
-	else if (event == OBS_FRONTEND_EVENT_EXIT) {
-		obs_frontend_save();
-		owner->OnExit();
-	}
-}
-
-void WSEvents::broadcastUpdate(const char *updateType, obs_data_t *additionalFields = NULL) {
-	obs_source_t *source = obs_frontend_get_current_scene();
-	const char *name = obs_source_get_name(source);
-
-	obs_data_t *update = obs_data_create();
-
-	obs_data_set_string(update, "update-type", updateType);
-	if (additionalFields != NULL) {
-		obs_data_apply(update, additionalFields);
-	}
-
-	_srv->broadcast(obs_data_get_json(update));
-
-	obs_data_release(update);
-	obs_source_release(source);
-}
-
-void WSEvents::OnSceneChange() {
-	// Implements an existing update type from bilhamil's OBS Remote
-	obs_source_t *source = obs_frontend_get_current_scene();
-	const char *name = obs_source_get_name(source);
-
-	obs_data_t *data = obs_data_create();
-	obs_data_set_string(data, "scene-name", name);
-
-	broadcastUpdate("SwitchScenes", data);
-
-	obs_data_release(data);
-	obs_source_release(source);
-}
-
-void WSEvents::OnSceneListChange() {
-	broadcastUpdate("ScenesChanged");
-}
-
-void WSEvents::OnStreamStarting() {
-	// Implements an existing update type from bilhamil's OBS Remote
-	obs_data_t *data = obs_data_create();
-	obs_data_set_bool(data, "preview-only", false);
-
-	broadcastUpdate("StreamStarting", data);
-
-	obs_data_release(data);
-}
-
-void WSEvents::OnStreamStarted() {
-	// New update type specific to OBS Studio
-	_streamStartTime = os_gettime_ns();
-	_lastBytesSent = 0;
-	broadcastUpdate("StreamStarted");
-}
-
-void WSEvents::OnStreamStopping() {
-	// Implements an existing update type from bilhamil's OBS Remote
-	obs_data_t *data = obs_data_create();
-	obs_data_set_bool(data, "preview-only", false);
-
-	broadcastUpdate("StreamStopping", data);
-
-	obs_data_release(data);
-}
-
-void WSEvents::OnStreamStopped() {
-	// New update type specific to OBS Studio
-	_streamStartTime = 0;
-	broadcastUpdate("StreamStopped");
-}
-
-void WSEvents::OnRecordingStarting() {
-	// New update type specific to OBS Studio
-	broadcastUpdate("RecordingStarting");
-}
-
-void WSEvents::OnRecordingStarted() {
-	// New update type specific to OBS Studio
-	broadcastUpdate("RecordingStarted");
-}
-
-void WSEvents::OnRecordingStopping() {
-	// New update type specific to OBS Studio
-	broadcastUpdate("RecordingStopping");
-}
-
-void WSEvents::OnRecordingStopped() {
-	// New update type specific to OBS Studio
-	broadcastUpdate("RecordingStopped");
-}
-
-void WSEvents::OnExit() {
-	// New update type specific to OBS Studio
-	broadcastUpdate("Exiting");
-}
-
-void WSEvents::StreamStatus() {
-	bool streamingActive = obs_frontend_streaming_active();
-	bool recordingActive = obs_frontend_recording_active();
-
-	obs_output_t *streamOutput = obs_frontend_get_streaming_output();
-
-	if (!streamOutput || !streamingActive || !recordingActive) {
-		return;
-	}
-
-	uint64_t bytesSent = obs_output_get_total_bytes(streamOutput);
-	uint64_t bytesSentTime = os_gettime_ns();
-
-	if (bytesSent < _lastBytesSent) {
-		bytesSent = 0;
-	}
-	if (bytesSent == 0) {
-		_lastBytesSent = 0;
-	}
-	
-	uint64_t bitsBetween = (bytesSent - _lastBytesSent) * 8;
-	double timePassed = double(bytesSentTime - _lastBytesSentTime) / 1000000000.0;
-
-	uint64_t bitsPerSec = bitsBetween / timePassed;
-	uint64_t bytesPerSec = bitsPerSec / 8;
-
-	_lastBytesSent = bytesSent;
-	_lastBytesSentTime = bytesSentTime;
-
-	uint64_t totalStreamTime = (os_gettime_ns() - _streamStartTime) / 1000000000;
-
-	obs_data_t *data = obs_data_create();
-	obs_data_set_bool(data, "streaming", streamingActive);
-	obs_data_set_bool(data, "recording", recordingActive);
-	obs_data_set_bool(data, "preview-only", false); // Retrocompat with OBSRemote
-	obs_data_set_int(data, "bytes-per-sec", bytesPerSec); // BUG : Computation seems buggy
-	obs_data_set_double(data, "strain", 0.0); // dafuq is strain
-	obs_data_set_int(data, "total-stream-time", totalStreamTime);
-	obs_data_set_int(data, "num-total-frames", obs_output_get_total_frames(streamOutput));
-	obs_data_set_int(data, "num-dropped-frames", obs_output_get_frames_dropped(streamOutput));
-	obs_data_set_double(data, "fps", obs_get_active_fps());
-
-	broadcastUpdate("StreamStatus", data);
-
-	obs_data_release(data);
-	obs_output_release(streamOutput);
-}

WSEvents.h

@@ -1,63 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#ifndef WSEVENTS_H
-#define WSEVENTS_H
-
-#include <QtWebSockets/QWebSocket>
-#include <QTimer>
-#include <obs-frontend-api.h>
-#include <util/platform.h>
-#include "WSServer.h"
-
-class WSEvents : public QObject 
-{
-	Q_OBJECT
-
-	public:
-		explicit WSEvents(WSServer *server);
-		~WSEvents();
-		static void FrontendEventHandler(enum obs_frontend_event event, void *private_data);
-
-	private Q_SLOTS:
-		void StreamStatus();
-
-	private:
-		WSServer *_srv;
-		uint64_t _streamStartTime;
-		uint64_t _lastBytesSent;
-		uint64_t _lastBytesSentTime;
-		void broadcastUpdate(const char *updateType, obs_data_t *additionalFields);
-
-		void OnSceneChange();
-		void OnSceneListChange();
-
-		void OnStreamStarting();
-		void OnStreamStarted();
-		void OnStreamStopping();
-		void OnStreamStopped();
-
-		void OnRecordingStarting();
-		void OnRecordingStarted();
-		void OnRecordingStopping();
-		void OnRecordingStopped();
-
-		void OnExit();
-};
-
-#endif // WSEVENTS_H

WSRequestHandler.cpp

@@ -1,324 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#include "WSRequestHandler.h"
-#include "obs-websocket.h"
-#include "Config.h"
-#include "Utils.h"
-
-WSRequestHandler::WSRequestHandler(QWebSocket *client) :
-	_authenticated(false),
-	_messageId(0),
-	_requestType(""),
-	_requestData(nullptr)
-{
-	_client = client;
-
-	messageMap["GetVersion"] = WSRequestHandler::HandleGetVersion;
-	messageMap["GetAuthRequired"] = WSRequestHandler::HandleGetAuthRequired;
-	messageMap["Authenticate"] = WSRequestHandler::HandleAuthenticate;
-
-	messageMap["SetCurrentScene"] = WSRequestHandler::HandleSetCurrentScene;
-	messageMap["GetCurrentScene"] = WSRequestHandler::HandleGetCurrentScene;
-	messageMap["GetSceneList"] = WSRequestHandler::HandleGetSceneList;
-	messageMap["SetSourceOrder"] = WSRequestHandler::ErrNotImplemented;
-	messageMap["SetSourceRender"] = WSRequestHandler::HandleSetSourceRender;
-	messageMap["SetSceneItemPositionAndSize"] = WSRequestHandler::ErrNotImplemented;
-	messageMap["GetStreamingStatus"] = WSRequestHandler::HandleGetStreamingStatus;
-	messageMap["StartStopStreaming"] = WSRequestHandler::HandleStartStopStreaming;
-	messageMap["StartStopRecording"] = WSRequestHandler::HandleStartStopRecording;
-	messageMap["ToggleMute"] = WSRequestHandler::ErrNotImplemented;
-	messageMap["GetVolumes"] = WSRequestHandler::ErrNotImplemented;
-	messageMap["SetVolume"] = WSRequestHandler::ErrNotImplemented;
-
-	messageMap["GetTransitionList"] = WSRequestHandler::HandleGetTransitionList;
-	messageMap["GetCurrentTransition"] = WSRequestHandler::HandleGetCurrentTransition;
-	messageMap["SetCurrentTransition"] = WSRequestHandler::HandleSetCurrentTransition;
-
-	authNotRequired.insert("GetVersion");
-	authNotRequired.insert("GetAuthRequired");
-	authNotRequired.insert("Authenticate");
-
-	blog(LOG_INFO, "[obs-websockets] new client connected from %s:%d", _client->peerAddress().toString().toLocal8Bit(), _client->peerPort());
-
-	connect(_client, &QWebSocket::textMessageReceived, this, &WSRequestHandler::processTextMessage);
-	connect(_client, &QWebSocket::disconnected, this, &WSRequestHandler::socketDisconnected);
-}
-
-void WSRequestHandler::processTextMessage(QString textMessage) {
-	QByteArray msgData = textMessage.toLocal8Bit();
-	const char *msg = msgData;
-
-	_requestData = obs_data_create_from_json(msg);
-	if (!_requestData) {
-		blog(LOG_ERROR, "[obs-websockets] invalid JSON payload for '%s'", msg);
-		SendErrorResponse("invalid JSON payload");
-		return;
-	}
-
-	_requestType = obs_data_get_string(_requestData, "request-type");
-	_messageId = obs_data_get_string(_requestData, "message-id");
-
-	if (Config::Current()->AuthRequired 
-		&& !_authenticated 
-		&& authNotRequired.find(_requestType) == authNotRequired.end()) 
-	{
-		SendErrorResponse("Not Authenticated");
-		return;
-	}
-
-	void (*handlerFunc)(WSRequestHandler*) = (messageMap[_requestType]);
-
-	if (handlerFunc != NULL) {
-		handlerFunc(this);
-	}
-	else {
-		SendErrorResponse("invalid request type");
-	}
-}
-
-void WSRequestHandler::socketDisconnected() {
-	blog(LOG_INFO, "[obs-websockets] client %s:%d disconnected", _client->peerAddress().toString().toStdString(), _client->peerPort());
-
-	_authenticated = false;
-	_client->deleteLater();
-	emit disconnected();
-}
-
-void WSRequestHandler::sendTextMessage(QString textMessage) {
-	_client->sendTextMessage(textMessage);
-}
-
-WSRequestHandler::~WSRequestHandler() {
-	if (_requestData != NULL) {
-		obs_data_release(_requestData);
-	}
-}
-
-void WSRequestHandler::SendOKResponse(obs_data_t *additionalFields) {
-	obs_data_t *response = obs_data_create();
-	obs_data_set_string(response, "status", "ok");
-	obs_data_set_string(response, "message-id", _messageId);
-
-	if (additionalFields != NULL) {
-		obs_data_apply(response, additionalFields);
-	}
-
-	_client->sendTextMessage(obs_data_get_json(response));
-
-	obs_data_release(response);
-}
-
-void WSRequestHandler::SendErrorResponse(const char *errorMessage) {
-	obs_data_t *response = obs_data_create();
-	obs_data_set_string(response, "status", "error");
-	obs_data_set_string(response, "error", errorMessage);
-	obs_data_set_string(response, "message-id", _messageId);
-
-	_client->sendTextMessage(obs_data_get_json(response));
-
-	obs_data_release(response);
-}
-
-void WSRequestHandler::HandleGetVersion(WSRequestHandler *owner) {
-	obs_data_t *data = obs_data_create();
-	obs_data_set_double(data, "version", 1.1);
-	obs_data_set_string(data, "obs-websocket-version", OBS_WEBSOCKET_VERSION);
-	obs_data_set_string(data, "obs-studio-version", OBS_VERSION);
-	owner->SendOKResponse(data);
-
-	obs_data_release(data);
-}
-
-void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler *owner) {
-	bool authRequired = Config::Current()->AuthRequired;
-
-	obs_data_t *data = obs_data_create();
-	obs_data_set_bool(data, "authRequired", authRequired);
-
-	if (authRequired) {
-		obs_data_set_string(data, "challenge", Config::Current()->SessionChallenge);
-		obs_data_set_string(data, "salt", Config::Current()->Salt);
-	}
-
-	owner->SendOKResponse(data);
-
-	obs_data_release(data);
-}
-
-void WSRequestHandler::HandleAuthenticate(WSRequestHandler *owner) {
-	const char *auth = obs_data_get_string(owner->_requestData, "auth");
-	if (!auth || strlen(auth) < 1) {
-		owner->SendErrorResponse("auth not specified!");
-		return;
-	}
-
-	if (!(owner->_authenticated) && Config::Current()->CheckAuth(auth)) {
-		owner->_authenticated = true;
-		owner->SendOKResponse();
-	}
-	else {
-		owner->SendErrorResponse("Authentication Failed.");
-	}
-}
-
-void WSRequestHandler::HandleSetCurrentScene(WSRequestHandler *owner) {
-	const char *sceneName = obs_data_get_string(owner->_requestData, "scene-name");
-	obs_source_t *source = obs_get_source_by_name(sceneName);
-
-	if (source) {
-		obs_frontend_set_current_scene(source);
-		owner->SendOKResponse();
-	}
-	else {
-		owner->SendErrorResponse("requested scene does not exist");
-	}
-
-	obs_source_release(source);
-}
-
-void WSRequestHandler::HandleGetCurrentScene(WSRequestHandler *owner) {
-	obs_source_t *source = obs_frontend_get_current_scene();
-	const char *name = obs_source_get_name(source);
-
-	obs_data_array_t *scene_items = Utils::GetSceneItems(source);
-
-	obs_data_t *data = obs_data_create();
-	obs_data_set_string(data, "name", name);
-	obs_data_set_array(data, "sources", scene_items);
-
-	owner->SendOKResponse(data);
-	obs_data_release(data);
-	obs_data_array_release(scene_items);
-	//obs_source_release(source); // causes a source destroy sometimes
-}
-
-void WSRequestHandler::HandleGetSceneList(WSRequestHandler *owner) {
-	obs_data_t *data = obs_data_create();
-	obs_data_set_string(data, "current-scene", obs_source_get_name(obs_frontend_get_current_scene()));
-	obs_data_set_array(data, "scenes", Utils::GetScenes());
-
-	owner->SendOKResponse(data);
-
-	//obs_data_release(data); // da hell ? sometimes causes a crash too, like in GetCurrentScene...
-}
-
-void WSRequestHandler::HandleSetSourceRender(WSRequestHandler *owner) {
-	const char *itemName = obs_data_get_string(owner->_requestData, "source");
-	bool isVisible = obs_data_get_bool(owner->_requestData, "render");
-	if (itemName == NULL) {
-		owner->SendErrorResponse("invalid request parameters");
-		return;
-	}
-
-	obs_source_t* currentScene = obs_frontend_get_current_scene();
-	
-	obs_sceneitem_t *sceneItem = Utils::GetSceneItemFromName(currentScene, itemName);
-	if (sceneItem != NULL) {
-		obs_sceneitem_set_visible(sceneItem, isVisible);
-		obs_sceneitem_release(sceneItem);
-		owner->SendOKResponse();
-	}
-	else {
-		owner->SendErrorResponse("specified scene item doesn't exist");
-	}
-
-	obs_source_release(currentScene);
-}
-
-void WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler *owner) {
-	obs_data_t *data = obs_data_create();
-	obs_data_set_bool(data, "streaming", obs_frontend_streaming_active());
-	obs_data_set_bool(data, "recording", obs_frontend_recording_active());
-	obs_data_set_bool(data, "preview-only", false);
-
-	owner->SendOKResponse(data);
-	obs_data_release(data);
-}
-
-void WSRequestHandler::HandleStartStopStreaming(WSRequestHandler *owner) {
-	if (obs_frontend_streaming_active()) {
-		obs_frontend_streaming_stop();
-	}
-	else {
-		obs_frontend_streaming_start();
-	}
-
-	owner->SendOKResponse();
-}
-
-void WSRequestHandler::HandleStartStopRecording(WSRequestHandler *owner) {
-	if (obs_frontend_recording_active()) {
-		obs_frontend_recording_stop();
-	}
-	else {
-		obs_frontend_recording_start();
-	}
-
-	owner->SendOKResponse();
-}
-
-void WSRequestHandler::HandleGetTransitionList(WSRequestHandler *owner) {
-	obs_frontend_source_list transitionList = {};
-	obs_frontend_get_transitions(&transitionList);
-
-	obs_data_array_t* transitions = obs_data_array_create();
-	for (size_t i = 0; i < (&transitionList)->sources.num; i++) {
-		obs_source_t* transition = (&transitionList)->sources.array[i];
-		
-		obs_data_t *obj = obs_data_create();
-		obs_data_set_string(obj, "name", obs_source_get_name(transition));
-
-		obs_data_array_push_back(transitions, obj);
-	}
-	obs_frontend_source_list_free(&transitionList);
-
-	obs_data_t *response = obs_data_create();
-	obs_data_set_string(response, "current-transition", obs_source_get_name(obs_frontend_get_current_transition()));
-	obs_data_set_array(response, "transitions", transitions);
-	owner->SendOKResponse(response);
-
-	obs_data_release(response);
-}
-
-void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler *owner) {
-	obs_data_t *response = obs_data_create();
-	obs_data_set_string(response, "name", obs_source_get_name(obs_frontend_get_current_transition()));
-	owner->SendOKResponse(response);
-
-	obs_data_release(response);
-}
-
-void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler *owner) {
-	const char *name = obs_data_get_string(owner->_requestData, "transition-name");
-	obs_source_t *transition = obs_get_source_by_name(name);
-
-	if (transition) {
-		obs_frontend_set_current_transition(transition);
-		owner->SendOKResponse();
-
-		obs_source_release(transition);
-	}
-	else {
-		owner->SendErrorResponse("requested transition does not exist");
-	}
-}
-
-void WSRequestHandler::ErrNotImplemented(WSRequestHandler *owner) {
-	owner->SendErrorResponse("not implemented");
-}

WSRequestHandler.h

@@ -1,75 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#ifndef WSREQUESTHANDLER_H
-#define WSREQUESTHANDLER_H
-
-#include <map>
-#include <set>
-#include <QtWebSockets/QWebSocket>
-#include <obs-frontend-api.h>
-
-class WSRequestHandler : public QObject
-{
-	Q_OBJECT
-
-	public:
-		explicit WSRequestHandler(QWebSocket *client);
-		~WSRequestHandler();
-		void sendTextMessage(QString textMessage);
-
-	private Q_SLOTS:
-		void processTextMessage(QString textMessage);
-		void socketDisconnected();
-
-	Q_SIGNALS:
-		void disconnected();
-
-	private:
-		QWebSocket *_client;
-		bool _authenticated;
-		const char *_messageId;
-		const char *_requestType;
-		obs_data_t *_requestData;
-
-		std::map<std::string, void(*)(WSRequestHandler*)> messageMap;
-		std::set<std::string> authNotRequired;
-
-		void SendOKResponse(obs_data_t *additionalFields = NULL);
-		void SendErrorResponse(const char *errorMessage);
-		static void ErrNotImplemented(WSRequestHandler *owner);
-		
-		static void HandleGetVersion(WSRequestHandler *owner);
-		static void HandleGetAuthRequired(WSRequestHandler *owner);
-		static void HandleAuthenticate(WSRequestHandler *owner);
-
-		static void HandleSetCurrentScene(WSRequestHandler *owner);
-		static void HandleGetCurrentScene(WSRequestHandler *owner);
-		static void HandleGetSceneList(WSRequestHandler *owner);
-		static void HandleSetSourceRender(WSRequestHandler *owner);
-		
-		static void HandleGetStreamingStatus(WSRequestHandler *owner);
-		static void HandleStartStopStreaming(WSRequestHandler *owner);
-		static void HandleStartStopRecording(WSRequestHandler *owner);
-
-		static void HandleGetTransitionList(WSRequestHandler *owner);
-		static void HandleGetCurrentTransition(WSRequestHandler *owner);
-		static void HandleSetCurrentTransition(WSRequestHandler *owner);
-};
-
-#endif // WSPROTOCOL_H

WSServer.cpp

@@ -1,81 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#include "WSServer.h"
-#include "WSRequestHandler.h"
-#include <QtWebSockets/QWebSocketServer>
-#include <QtWebSockets/QWebSocket>
-#include <QtCore/QDebug>
-#include <QtCore/QThread>
-#include <obs-frontend-api.h>
-
-QT_USE_NAMESPACE
-
-WSServer::WSServer(quint16 port, QObject *parent) :
-	QObject(parent),
-	_wsServer(Q_NULLPTR),
-	_clients()
-{
-	_serverThread = new QThread();
-	_wsServer = new QWebSocketServer(
-		QStringLiteral("OBS Websocket API"),
-		QWebSocketServer::NonSecureMode,
-		this);
-	_wsServer->moveToThread(_serverThread);
-	_serverThread->start();
-
-	bool serverStarted = _wsServer->listen(QHostAddress::Any, port);
-	if (serverStarted) {
-		connect(_wsServer, &QWebSocketServer::newConnection, this, &WSServer::onNewConnection);
-	}
-}
-
-WSServer::~WSServer()
-{
-	_wsServer->close();
-	qDeleteAll(_clients.begin(), _clients.end());
-}
-
-void WSServer::broadcast(QString message)
-{
-	Q_FOREACH(WSRequestHandler *pClient, _clients) {
-		pClient->sendTextMessage(message);
-	}
-}
-
-void WSServer::onNewConnection()
-{
-	QWebSocket *pSocket = _wsServer->nextPendingConnection();
-
-	if (pSocket) {
-		WSRequestHandler *pHandler = new WSRequestHandler(pSocket);
-
-		connect(pHandler, &WSRequestHandler::disconnected, this, &WSServer::socketDisconnected);
-		_clients << pHandler;
-	}
-}
-
-void WSServer::socketDisconnected()
-{
-	WSRequestHandler *pClient = qobject_cast<WSRequestHandler *>(sender());
-
-	if (pClient) {
-		_clients.removeAll(pClient);
-		pClient->deleteLater();
-	}
-}

WSServer.h

@@ -1,49 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#ifndef WSSERVER_H
-#define WSSERVER_H
-
-#include <QtCore/QObject>
-#include <QtCore/QList>
-#include <QtCore/QByteArray>
-#include "WSRequestHandler.h"
-
-QT_FORWARD_DECLARE_CLASS(QWebSocketServer)
-QT_FORWARD_DECLARE_CLASS(QWebSocket)
-
-class WSServer : public QObject
-{
-	Q_OBJECT
-
-	public:
-		explicit WSServer(quint16 port, QObject *parent = Q_NULLPTR);
-		virtual ~WSServer();
-		void broadcast(QString message);
-
-	private Q_SLOTS:
-		void onNewConnection();
-		void socketDisconnected();
-
-	private:
-		QWebSocketServer *_wsServer;
-		QList<WSRequestHandler *> _clients;
-		QThread *_serverThread;
-};
-
-#endif // WSSERVER_H

azure-pipelines.yml

@@ -0,0 +1,183 @@
+variables:
+  isReleaseMode: ${{ startsWith(variables['Build.SourceBranch'], 'refs/tags/') }}
+
+trigger:
+  branches:
+    include:
+      - master
+  tags:
+    include:
+      - '*'
+
+jobs:
+- job: 'GenerateDocs'
+  condition: |
+    or(
+      eq(variables['Build.SourceBranch'], 'refs/heads/4.x-current'),
+      eq(variables['Build.SourceBranch'], 'refs/heads/master')
+    )
+  pool:
+    vmImage: 'ubuntu-18.04'
+  steps:
+    - checkout: self
+      submodules: false
+
+    - script: ./CI/generate-docs.sh
+      displayName: 'Generate docs'
+      env:
+        CHECKOUT_REF: $(Build.SourceBranch)
+        GH_TOKEN: $(GithubToken)
+
+- job: 'Build_Windows'
+  pool:
+    vmImage: 'windows-2019'
+  variables:
+    build_config: RelWithDebInfo
+    DepsBasePath: 'D:\obsdependencies'
+    DepsPath32: '$(DepsBasePath)\win32'
+    DepsPath64: '$(DepsBasePath)\win64'
+    QtBaseDir: 'D:\QtDep'
+    QTDIR32: '$(QtBaseDir)\5.10.1\msvc2017'
+    QTDIR64: '$(QtBaseDir)\5.10.1\msvc2017_64'
+    OBSPath: 'D:\obs-studio'
+  steps:
+    - checkout: self
+      submodules: true
+
+    - script: ./CI/install-qt-win.cmd
+      displayName: 'Install Qt'
+      env:
+        QtBaseDir: $(QtBaseDir)
+
+    - task: Cache@2
+      displayName: Restore cached OBS Studio dependencies
+      inputs:
+        key: 'obsdeps | "$(Agent.OS)"'
+        restoreKeys: |
+          obsdeps | "$(Agent.OS)"
+        path: $(DepsBasePath)
+
+    - script: ./CI/download-obs-deps.cmd
+      displayName: 'Download OBS Studio dependencies'
+
+    - task: Cache@2
+      displayName: Restore cached OBS Studio builds
+      inputs:
+        key: 'obs | "$(Agent.OS)"'
+        restoreKeys: |
+          obs | "$(Agent.OS)"
+        path: $(OBSPath)
+
+    - script: ./CI/prepare-obs-windows.cmd
+      displayName: 'Checkout & CMake OBS Studio'
+      env:
+        build_config: $(build_config)
+        DepsPath32: $(DepsPath32)
+        DepsPath64: $(DepsPath64)
+        QTDIR32: $(QTDIR32)
+        QTDIR64: $(QTDIR64)
+        OBSPath: $(OBSPath)
+
+    - task: MSBuild@1
+      displayName: 'Build OBS Studio 32-bit'
+      inputs:
+        msbuildArguments: '/m /p:Configuration=$(build_config)'
+        solution: '$(OBSPath)\build32\obs-studio.sln'
+
+    - task: MSBuild@1
+      displayName: 'Build OBS Studio 64-bit'
+      inputs:
+        msbuildArguments: '/m /p:Configuration=$(build_config)'
+        solution: '$(OBSPath)\build64\obs-studio.sln'
+
+    - script: ./CI/prepare-windows.cmd
+      displayName: 'CMake obs-websocket'
+      env:
+        build_config: $(build_config)
+        QTDIR32: $(QTDIR32)
+        QTDIR64: $(QTDIR64)
+        OBSPath: $(OBSPath)
+
+    - task: MSBuild@1
+      displayName: 'Build obs-websocket 32-bit'
+      inputs:
+        msbuildArguments: '/m /p:Configuration=$(build_config)'
+        solution: '.\build32\obs-websocket.sln'
+
+    - task: MSBuild@1
+      displayName: 'Build obs-websocket 64-bit'
+      inputs:
+        msbuildArguments: '/m /p:Configuration=$(build_config)'
+        solution: '.\build64\obs-websocket.sln'
+
+    - script: ./CI/package-windows.cmd
+      displayName: 'Package obs-websocket'
+
+    - task: PublishBuildArtifacts@1
+      displayName: 'Upload package artifacts'
+      inputs:
+        pathtoPublish: './package'
+        artifactName: 'windows_build'
+
+- job: 'Build_Linux'
+  pool:
+    vmImage: 'ubuntu-18.04'
+  variables:
+      BUILD_REASON: $(Build.Reason)
+      BRANCH_SHORT_NAME: $(Build.SourceBranchName)
+      BRANCH_FULL_NAME: $(Build.SourceBranch)
+  steps:
+    - checkout: self
+      submodules: true
+
+    - script: ./CI/install-dependencies-ubuntu.sh
+      displayName: 'Install dependencies'
+
+    - script: ./CI/build-ubuntu.sh
+      displayName: 'Build obs-websocket'
+
+    - script: ./CI/package-ubuntu.sh
+      displayName: 'Package obs-websocket'
+
+    - task: PublishBuildArtifacts@1
+      inputs:
+        pathtoPublish: './package'
+        artifactName: 'deb_build'
+
+- job: 'Build_macOS'
+  pool:
+    vmImage: 'macos-10.14'
+  steps:
+    - checkout: self
+      submodules: true
+
+    - script: ./CI/install-dependencies-macos.sh
+      displayName: 'Install dependencies'
+
+    - script: ./CI/install-build-obs-macos.sh
+      displayName: 'Build OBS'
+
+    - script: ./CI/build-macos.sh
+      displayName: 'Build obs-websocket'
+
+    - task: InstallAppleCertificate@1
+      displayName: 'Install release signing certificates'
+      condition: eq(variables['isReleaseMode'], true)
+      inputs:
+        certSecureFile: 'Certificates.p12'
+        certPwd: $(secrets.macOS.certificatesImportPassword)
+
+    - script: ./CI/package-macos.sh
+      displayName: 'Package obs-websocket'
+      env:
+        RELEASE_MODE: $(isReleaseMode)
+        CODE_SIGNING_IDENTITY: $(secrets.macOS.codeSigningIdentity)
+        INSTALLER_SIGNING_IDENTITY: $(secrets.macOS.installerSigningIdentity)
+        AC_USERNAME: $(secrets.macOS.notarization.username)
+        AC_PASSWORD: $(secrets.macOS.notarization.password)
+        AC_PROVIDER_SHORTNAME: $(secrets.macOS.notarization.providerShortName)
+
+    - task: PublishBuildArtifacts@1
+      inputs:
+        pathtoPublish: './release'
+        artifactName: 'macos_build'

crowdin.yml

@@ -0,0 +1,3 @@
+files:
+  - source: /data/locale/en-US.ini
+    translation: /data/locale/%locale%.ini

data/locale/de-DE.ini

@@ -0,0 +1,16 @@
+OBSWebsocket.Settings.DialogTitle="WebSockets-Servereinstellungen"
+OBSWebsocket.Settings.ServerEnable="WebSockets-Server aktivieren"
+OBSWebsocket.Settings.ServerPort="Server-Port"
+OBSWebsocket.Settings.AuthRequired="Authentifizierung aktivieren"
+OBSWebsocket.Settings.Password="Passwort"
+OBSWebsocket.Settings.DebugEnable="Debug-Protokollierung aktivieren"
+OBSWebsocket.Settings.AlertsEnable="Infobereichbenachrichtigungen aktivieren"
+OBSWebsocket.NotifyConnect.Title="Neue Websocket-Verbindung"
+OBSWebsocket.NotifyConnect.Message="Client %1 verbunden"
+OBSWebsocket.NotifyDisconnect.Title="Websocket-Client getrennt"
+OBSWebsocket.NotifyDisconnect.Message="Client %1 getrennt"
+OBSWebsocket.Server.StartFailed.Title="Websocket-Serverfehler"
+OBSWebsocket.Server.StartFailed.Message="Der WebSockets-Server konnte nicht gestartet werden, mögliche Gründe:\n - Der TCP-Port %1 wird möglicherweise gerade von einem anderen Programm verwendet. Versuchen Sie einen anderen Port in den Websocket-Servereinstellungen zu setzen oder alle Programme zu beenden, die den Port möglicherweise verwenden.\n - Ein unbekannter Netzwerkfehler ist aufgetreten. Versuchen Sie es mit anderen Einstellungen, einem OBS-Neustart oder einem Systemneustart erneut."
+OBSWebsocket.ProfileChanged.Started="WebSockets-Server in diesem Profil aktiviert. Server gestartet."
+OBSWebsocket.ProfileChanged.Stopped="WebSockets-Server in diesem Profil deaktiviert. Server gestoppt."
+OBSWebsocket.ProfileChanged.Restarted="WebSockets-Server in diesem Profil geändert. Server startet neu."

data/locale/en-US.ini

@@ -1,4 +1,16 @@
-Menu.SettingsItem="Websocket server settings"
-Settings.DialogTitle="obs-websocket"
-Settings.AuthRequired="Enable authentication"
-Settings.Password="Password"
+OBSWebsocket.Settings.DialogTitle="WebSockets Server Settings"
+OBSWebsocket.Settings.ServerEnable="Enable WebSockets server"
+OBSWebsocket.Settings.ServerPort="Server Port"
+OBSWebsocket.Settings.AuthRequired="Enable authentication"
+OBSWebsocket.Settings.Password="Password"
+OBSWebsocket.Settings.DebugEnable="Enable debug logging"
+OBSWebsocket.Settings.AlertsEnable="Enable System Tray Alerts"
+OBSWebsocket.NotifyConnect.Title="New WebSocket connection"
+OBSWebsocket.NotifyConnect.Message="Client %1 connected"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket client disconnected"
+OBSWebsocket.NotifyDisconnect.Message="Client %1 disconnected"
+OBSWebsocket.Server.StartFailed.Title="WebSockets Server failure"
+OBSWebsocket.Server.StartFailed.Message="The WebSockets server failed to start, maybe because:\n - TCP port %1 may currently be in use elsewhere on this system, possibly by another application. Try setting a different TCP port in the WebSocket server settings, or stop any application that could be using this port.\n - Error message: %2"
+OBSWebsocket.ProfileChanged.Started="WebSockets server enabled in this profile. Server started."
+OBSWebsocket.ProfileChanged.Stopped="WebSockets server disabled in this profile. Server stopped."
+OBSWebsocket.ProfileChanged.Restarted="WebSockets server port changed in this profile. Server restarted."

data/locale/es-ES.ini

@@ -0,0 +1,12 @@
+OBSWebsocket.Settings.ServerEnable="Habilitar el servidor WebSockets"
+OBSWebsocket.Settings.ServerPort="Puerto del Servidor"
+OBSWebsocket.Settings.AuthRequired="Habilitar autenticación"
+OBSWebsocket.Settings.Password="Contraseña"
+OBSWebsocket.Settings.DebugEnable="Habilitar registro de depuración"
+OBSWebsocket.Settings.AlertsEnable="Habilitar alertas en la bandeja de sistema"
+OBSWebsocket.NotifyConnect.Title="Nueva conexión WebSocket"
+OBSWebsocket.NotifyConnect.Message="Cliente %1 conectado"
+OBSWebsocket.NotifyDisconnect.Title="Cliente WebSocket desconectado"
+OBSWebsocket.NotifyDisconnect.Message="Cliente %1 desconectado"
+OBSWebsocket.Server.StartFailed.Title="Falla en el servidor WebSockets"
+OBSWebsocket.Server.StartFailed.Message="El servidor obs-websocket no se pudo iniciar, tal vez porque: \n - el puerto TCP %1 podría estar actualmente siendo usado este sistema, posiblemente por otra aplicación. Intente configurar un puerto TCP diferente en la configuración del servidor WebSocket, o detenga cualquier aplicación que pudiese estar utilizando este puerto \n - Un error de red desconocido ha afectado su sistema. Inténtelo de nuevo cambiando la configuración, reiniciando OBS o reiniciando su sistema."

data/locale/fr-FR.ini

@@ -1,4 +1,16 @@
-Menu.SettingsItem="Paramètres du serveur Websocket"
-Settings.DialogTitle="obs-websocket"
-Settings.AuthRequired="Activer l'authentification"
-Settings.Password="Mot de passe"
+OBSWebsocket.Settings.DialogTitle="Paramètres du serveur WebSockets"
+OBSWebsocket.Settings.ServerEnable="Activer le serveur WebSocket"
+OBSWebsocket.Settings.ServerPort="Port du serveur"
+OBSWebsocket.Settings.AuthRequired="Activer l'authentification"
+OBSWebsocket.Settings.Password="Mot de passe"
+OBSWebsocket.Settings.DebugEnable="Débogage dans le fichier journal"
+OBSWebsocket.Settings.AlertsEnable="Notifications de connexion/déconnexion"
+OBSWebsocket.NotifyConnect.Title="Nouvelle connexion WebSocket"
+OBSWebsocket.NotifyConnect.Message="Le client %1 s'est connecté"
+OBSWebsocket.NotifyDisconnect.Title="Déconnexion WebSocket"
+OBSWebsocket.NotifyDisconnect.Message="Le client %1 s'est déconnecté"
+OBSWebsocket.Server.StartFailed.Title="Impossible de démarrer le serveur WebSockets"
+OBSWebsocket.Server.StartFailed.Message="Le serveur WebSockets n'a pas pu démarrer, peut-être parce que :\n - Le port TCP %1 est en cours d'utilisation sur ce système, certainement par un autre programme. Essayez un port différent dans les réglages du serveur WebSocket, ou arrêtez tout programme susceptible d'utiliser ce port.\n - Une erreur réseau inconnue est survenue. Essayez à nouveau en modifiant vos réglages, en redémarrant OBS ou en redémarrant votre ordinateur."
+OBSWebsocket.ProfileChanged.Started="Serveur WebSockets actif dans ce profil."
+OBSWebsocket.ProfileChanged.Stopped="Serveur WebSockets désactivé dans ce profil."
+OBSWebsocket.ProfileChanged.Restarted="Le port actuel diffère du port configuré dans ce profil. Serveur WebSockets redémarré."

data/locale/it-IT.ini

@@ -0,0 +1,12 @@
+OBSWebsocket.Settings.ServerEnable="Abilitare il server WebSockets"
+OBSWebsocket.Settings.ServerPort="Porta del server"
+OBSWebsocket.Settings.AuthRequired="Abilitare l'autenticazione"
+OBSWebsocket.Settings.Password="Password"
+OBSWebsocket.Settings.DebugEnable="Attivare la registrazione di debug"
+OBSWebsocket.Settings.AlertsEnable="Attivare gli avvisi di vassoio di sistema"
+OBSWebsocket.NotifyConnect.Title="Nuova connessione WebSocket"
+OBSWebsocket.NotifyConnect.Message="%1 cliente collegato"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket cliente disconnesso"
+OBSWebsocket.NotifyDisconnect.Message="%1 cliente disconnesso"
+OBSWebsocket.Server.StartFailed.Title="Errore del WebSocket Server"
+OBSWebsocket.Server.StartFailed.Message="Impossibile avviare, forse perché il server di WebSockets: \n - %1 porta TCP potrebbe essere attualmente in uso altrove su questo sistema, possibilmente da un'altra applicazione. Provare a impostare una porta TCP diversa nelle impostazioni del server di WebSockets, o arrestare tutte le applicazioni che potrebbero utilizzare questa porta. \n - è verificato un errore di rete sconosciuto sul sistema. Riprova modificando le impostazioni, riavviare OBS o riavvio del sistema."

data/locale/ja-JP.ini

@@ -0,0 +1,11 @@
+OBSWebsocket.Settings.ServerEnable="WebSockets サーバーを有効にする"
+OBSWebsocket.Settings.ServerPort="サーバーポート"
+OBSWebsocket.Settings.AuthRequired="認証を有効にする"
+OBSWebsocket.Settings.Password="パスワード"
+OBSWebsocket.Settings.DebugEnable="デバッグログを有効にする"
+OBSWebsocket.Settings.AlertsEnable="システムトレイ通知を有効にする"
+OBSWebsocket.NotifyConnect.Title="新しい WebSocket 接続"
+OBSWebsocket.NotifyConnect.Message="接続されているクライアント %1"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket クライアントが切断されました"
+OBSWebsocket.NotifyDisconnect.Message="切断されたクライアント %1"
+OBSWebsocket.Server.StartFailed.Title="WebSockets サーバー障害"

data/locale/nl-NL.ini

@@ -0,0 +1,9 @@
+OBSWebsocket.Settings.ServerPort="Serverpoort"
+OBSWebsocket.Settings.DebugEnable="Activeer debug logs"
+OBSWebsocket.Settings.AlertsEnable="Systemvak waarschuwingen inschakelen"
+OBSWebsocket.NotifyConnect.Title="Nieuwe WebSocket verbinding"
+OBSWebsocket.NotifyConnect.Message="Client %1 verbonden"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket client connectie verbroken"
+OBSWebsocket.NotifyDisconnect.Message="Client %1 losgekoppeld"
+OBSWebsocket.Server.StartFailed.Title="Fout in WebSocket server"
+OBSWebsocket.Server.StartFailed.Message="De obs-websocket server kan niet worden gestart, misschien omdat: \n - TCP-poort %1 momenteel elders wordt gebruikt op dit systeem, eventueel door een andere toepassing. Probeer een andere TCP-poort in te stellen in de WebSocket Server-instellingen of stop elke toepassing die deze poort zou kunnen gebruiken.\n Een onbekende Netwerkfout op uw systeem. Probeer het opnieuw door de instellingen te wijzigen, OBS te herstarten of uw systeem te herstarten."

data/locale/pl-PL.ini

@@ -0,0 +1,10 @@
+OBSWebsocket.Settings.ServerEnable="Włącz serwer WebSockets"
+OBSWebsocket.Settings.AuthRequired="Wymagaj uwierzytelniania"
+OBSWebsocket.Settings.DebugEnable="Włącz rejestrowanie debugowania"
+OBSWebsocket.Settings.AlertsEnable="Włącz powiadomienia w zasobniku systemowym"
+OBSWebsocket.NotifyConnect.Title="Nowe połączenie WebSocket"
+OBSWebsocket.NotifyConnect.Message="Klient %1 połączony"
+OBSWebsocket.NotifyDisconnect.Title="Klient WebSocket odłączony"
+OBSWebsocket.NotifyDisconnect.Message="Klient %1 rozłączony"
+OBSWebsocket.Server.StartFailed.Title="Awaria serwera WebSockets"
+OBSWebsocket.Server.StartFailed.Message="Nie udało się uruchomić serwera WebSockets, może a powodu: \n - TCP port %1 może być obecnie używany gdzie indziej w tym systemie, możliwie przez inną aplikację. Spróbuj ustawić inny port TCP w ustawieniach serwera WebSockets, lub zatrzymać dowolną aplikację, która może używać tego portu \n -nieznany błąd sieci wydarzył się w systemie. Spróbuj ponownie, zmieniając ustawienia, ponownie uruchamiając OBS lub ponownie uruchamiając system."

data/locale/pt-PT.ini

@@ -0,0 +1,12 @@
+OBSWebsocket.Settings.ServerEnable="Habilitar servidor de WebSockets"
+OBSWebsocket.Settings.ServerPort="Porta do Servidor"
+OBSWebsocket.Settings.AuthRequired="Activar autenticação"
+OBSWebsocket.Settings.Password="Palavra passe"
+OBSWebsocket.Settings.DebugEnable="Habilitar registro de debug"
+OBSWebsocket.Settings.AlertsEnable="Ativar Alertas da bandeja do sistema"
+OBSWebsocket.NotifyConnect.Title="Nova conexão WebSocket"
+OBSWebsocket.NotifyConnect.Message="Cliente %1 conectado"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket cliente desconectado"
+OBSWebsocket.NotifyDisconnect.Message="Cliente %1 desconectado"
+OBSWebsocket.Server.StartFailed.Title="Falha do servidor de WebSocket"
+OBSWebsocket.Server.StartFailed.Message="O servidor de WebSockets falhou ao iniciar, talvez porque: \n - TCP port %1 pode estar atualmente em uso em outro lugar sobre este sistema, possivelmente por outro aplicativo. Tente definir uma porta TCP diferente nas configurações do servidor de WebSockets, ou parar qualquer aplicativo que poderia estar usando este porto \n - um erro de rede desconhecido aconteceu no seu sistema. Tente novamente alterar configurações, reiniciando OBS ou reiniciando o sistema."

data/locale/ru-RU.ini

@@ -0,0 +1,13 @@
+OBSWebsocket.Settings.DialogTitle="Настройки сервера WebSockets"
+OBSWebsocket.Settings.ServerEnable="Включить сервер WebSockets"
+OBSWebsocket.Settings.ServerPort="Порт сервера"
+OBSWebsocket.Settings.AuthRequired="Включить авторизацию"
+OBSWebsocket.Settings.Password="Пароль"
+OBSWebsocket.Settings.DebugEnable="Включить ведение журнала отладки"
+OBSWebsocket.Settings.AlertsEnable="Включить оповещения в системном трее"
+OBSWebsocket.NotifyConnect.Title="Новое соединение WebSocket"
+OBSWebsocket.NotifyConnect.Message="Клиент %1 подключен"
+OBSWebsocket.NotifyDisconnect.Title="Клиент WebSocket отключён"
+OBSWebsocket.NotifyDisconnect.Message="Клиент %1 отключен"
+OBSWebsocket.Server.StartFailed.Title="Сбой сервера WebSockets"
+OBSWebsocket.Server.StartFailed.Message="Ошибка запуска сервера WebSockets. Вероятные причины:\n - Возможно, TCP-порт %1 занят другим приложением в системе. Попробуйте задать другой TCP-порт в настройках сервера WebSockets или закройте приложение, которое может использовать данный порт.\n - Произошла неизвестная сетевая ошибка в системе. Попробуйте снова после изменения настроек, перезапуска OBS или системы."

data/locale/zh-CN.ini

@@ -0,0 +1,12 @@
+OBSWebsocket.Settings.ServerEnable="启用 WebSockets 服务器"
+OBSWebsocket.Settings.ServerPort="服务器端口"
+OBSWebsocket.Settings.AuthRequired="启用身份验证"
+OBSWebsocket.Settings.Password="密码"
+OBSWebsocket.Settings.DebugEnable="启用调试日志"
+OBSWebsocket.Settings.AlertsEnable="启用系统托盘通知"
+OBSWebsocket.NotifyConnect.Title="新 WebSocket 连接"
+OBSWebsocket.NotifyConnect.Message="客户端 %1 已连接"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket 客户端已断开"
+OBSWebsocket.NotifyDisconnect.Message="客户端 %1 已断开连接"
+OBSWebsocket.Server.StartFailed.Title="WebSockets 服务器错误"
+OBSWebsocket.Server.StartFailed.Message="WebSockets 服务器启动失败，可能是因为：\n - TCP 端口 %1 可能被本机的另一个应用程序占用。尝试在 WebSockets 服务器设置中设置不同的 TCP 端口，或关闭任何可能使用此端口的应用程序。\n - 在您的系统上发生了未知的网络错误。请尝试更改设置、重新启动 OBS 或重新启动系统。"

data/locale/zh-TW.ini

@@ -0,0 +1,9 @@
+OBSWebsocket.Settings.ServerPort="伺服器連接埠"
+OBSWebsocket.Settings.DebugEnable="啟用除錯日誌"
+OBSWebsocket.Settings.AlertsEnable="啟用系統列通知"
+OBSWebsocket.NotifyConnect.Title="新的 WebSocket 連線"
+OBSWebsocket.NotifyConnect.Message="客戶端 %1 已連線"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket 客戶端已離線"
+OBSWebsocket.NotifyDisconnect.Message="客戶端 %1 已離線"
+OBSWebsocket.Server.StartFailed.Title="WebSocket 伺服器錯誤"
+OBSWebsocket.Server.StartFailed.Message="WebSockets 伺服器啟動失敗，可能的原因有：\n - TCP 連接埠 %1 被系統的其他程式所使用，試著為 WebSockets 伺服器指定不同的 TCP 連接埠，或是關閉任何可能使用此連接埠的程式。\n - 發生的未知的網路錯誤，試著更改設定、重新啟動 OBS 或是重新啟動您的系統。"

docs/.editorconfig

@@ -0,0 +1,11 @@
+[*]
+end_of_line = lf
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md, *.mustache]
+trim_trailing_whitespace = false
+insert_final_newline = false

docs/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+logs
+*.log
+npm-debug.log*

docs/.npmrc

@@ -0,0 +1 @@
+package-lock=false

docs/README.md

@@ -0,0 +1,21 @@
+## Installation
+
+Install node and update npm if necessary.
+
+```sh
+cd obs-websocket/docs
+npm install
+```
+
+## Build
+
+```sh
+# Just extract the comments.
+npm run comments
+
+# Just render the markdown.
+npm run docs
+
+# Do both comments and markdown.
+npm run build
+```

docs/comments.js

@@ -0,0 +1,104 @@
+const fs = require('fs');
+const path = require('path');
+const glob = require('glob');
+const parseComments = require('parse-comments');
+const config = require('./config.json');
+
+/**
+ * Read each file and call `parse-comments` on it.
+ *
+ * @param  {String|Array} `files` List of file paths to read from.
+ * @return {Object|Array}         Array of `parse-comments` objects.
+ */
+const parseFiles = files => {
+    let response = [];
+    files.forEach(file => {
+        const f = fs.readFileSync(file, 'utf8').toString();
+        response = response.concat(parseComments(f));
+    });
+
+    return response;
+};
+
+/**
+ * Filters/sorts the results from `parse-comments`.
+ * @param  {Object|Array} `comments` Array of `parse-comments` objects.
+ * @return {Object}                  Filtered comments sorted by `@api` and `@category`.
+ */
+const processComments = comments => {
+    let sorted = {};
+    let errors = [];
+
+    comments.forEach(comment => {
+        if (comment.typedef) {
+            comment.comment = undefined;
+            comment.context = undefined;
+            sorted['typedefs'] = sorted['typedefs'] || [];
+            sorted['typedefs'].push(comment);
+            return;
+        }
+
+        if (typeof comment.api === 'undefined') return;
+        let validationFailures = validateComment(comment);
+
+        if (validationFailures) {
+            errors.push(validationFailures);
+        }
+
+        // Store the object based on its api (ie. requests, events) and category (ie. general, scenes, etc).
+        comment.category = comment.category || 'miscellaneous';
+
+        // Remove some unnecessary properties to avoid result differences in travis.
+        comment.comment = undefined;
+        comment.context = undefined;
+
+        // Create an entry in sorted for the api/category if one does not exist.
+        sorted[comment.api] = sorted[comment.api] || {};
+        sorted[comment.api][comment.category] = sorted[comment.api][comment.category] || [];
+
+        // Store the comment in the appropriate api/category.
+        sorted[comment.api][comment.category].push(comment);
+    });
+
+    if (errors.length) {
+        throw JSON.stringify(errors, null, 2);
+    }
+
+    return sorted;
+};
+
+// Rudimentary validation of documentation content, returns an error object or undefined.
+const validateComment = comment => {
+    let errors = [];
+    [].concat(comment.params).concat(comment.returns).filter(Boolean).forEach(param => {
+        if (typeof param.name !== 'string' || param.name === '') {
+            errors.push({
+                description: `Invalid param or return value name`,
+                param: param
+            });
+        }
+
+        if (typeof param.type !== 'string' || param.type === '') {
+            errors.push({
+                description: `Invalid param or return value type`,
+                param: param
+            });
+        }
+    });
+
+    if (errors.length) {
+        return {
+            errors: errors,
+            fullContext: Object.assign({}, comment)
+        };
+    }
+};
+
+const files = glob.sync(config.srcGlob);
+const comments = processComments(parseFiles(files));
+
+if (!fs.existsSync(config.outDirectory)){
+    fs.mkdirSync(config.outDirectory);
+}
+
+fs.writeFileSync(path.join(config.outDirectory, 'comments.json'), JSON.stringify(comments, null, 2));

docs/config.json

@@ -0,0 +1,5 @@
+{
+    "srcGlob": "./../src/**/*.@(cpp|h)",
+    "srcTemplate": "./protocol.hbs",
+    "outDirectory": "./generated"
+}

docs/docs.js

@@ -0,0 +1,37 @@
+const fs = require('fs');
+const path = require('path');
+const toc = require('markdown-toc');
+const handlebars = require('handlebars');
+const config = require('./config.json');
+
+const helpers = require('handlebars-helpers')({
+    handlebars: handlebars
+});
+
+// Allows pipe characters to be used within markdown tables.
+handlebars.registerHelper('depipe', (text) => {
+    return typeof text === 'string' ? text.replace('|', '\\|') : text;
+});
+
+const insertHeader = (text) => {
+    return '<!-- This file was generated based on handlebars templates. Do not edit directly! -->\n\n' + text;
+};
+
+/**
+ * Writes `protocol.md` using `protocol.mustache`.
+ *
+ * @param  {Object} `data` Data to assign to the mustache template.
+ */
+const generateProtocol = (templatePath, data) => {
+    const template = fs.readFileSync(templatePath).toString();
+    const generated = handlebars.compile(template)(data);
+    return insertHeader(toc.insert(generated));
+};
+
+if (!fs.existsSync(config.outDirectory)){
+    fs.mkdirSync(config.outDirectory);
+}
+
+const comments = fs.readFileSync(path.join(config.outDirectory, 'comments.json'), 'utf8');
+const markdown = generateProtocol(config.srcTemplate, JSON.parse(comments));
+fs.writeFileSync(path.join(config.outDirectory, 'protocol.md'), markdown);

docs/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "obs-websocket-docs",
+  "version": "1.0.0",
+  "description": "",
+  "main": "docs.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "docs": "node ./docs.js",
+    "comments": "node ./comments.js",
+    "build": "npm run comments && npm run docs"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "glob": "^7.1.2",
+    "handlebars": "^4.0.10",
+    "handlebars-helpers": "^0.9.6",
+    "markdown-toc": "^1.1.0",
+    "parse-comments": "^0.4.3"
+  }
+}

docs/partials/eventsHeader.md

@@ -0,0 +1,11 @@
+# Events
+Events are broadcast by the server to each connected client when a recognized action occurs within OBS.
+
+An event message will contain at least the following base fields:
+- `update-type` _String_: the type of event.
+- `stream-timecode` _String (optional)_: time elapsed between now and stream start (only present if OBS Studio is streaming).
+- `rec-timecode` _String (optional)_: time elapsed between now and recording start (only present if OBS Studio is recording).
+
+Timecodes are sent using the format: `HH:MM:SS.mmm`
+
+Additional fields may be present in the event message depending on the event type.

docs/partials/introduction.md

@@ -0,0 +1,34 @@
+# obs-websocket 4.8.0 protocol reference
+
+# General Introduction
+Messages are exchanged between the client and the server as JSON objects.
+This protocol is based on the original OBS Remote protocol created by Bill Hamilton, with new commands specific to OBS Studio.
+
+# Authentication
+`obs-websocket` uses SHA256 to transmit credentials.
+
+A request for [`GetAuthRequired`](#getauthrequired) returns two elements:
+- A `challenge`: a random string that will be used to generate the auth response.
+- A `salt`: applied to the password when generating the auth response.
+
+To generate the answer to the auth challenge, follow this procedure:
+- Concatenate the user declared password with the `salt` sent by the server (in this order: `password + server salt`).
+- Generate a binary SHA256 hash of the result and encode the resulting SHA256 binary hash to base64, known as a `base64 secret`.
+- Concatenate the base64 secret with the `challenge` sent by the server (in this order: `base64 secret + server challenge`).
+- Generate a binary SHA256 hash of the result and encode it to base64.
+- Voilà, this last base64 string is the `auth response`. You may now use it to authenticate to the server with the [`Authenticate`](#authenticate) request.
+
+Pseudo Code Example:
+```
+password = "supersecretpassword"
+challenge = "ztTBnnuqrqaKDzRM3xcVdbYm"
+salt = "PZVbYpvAnZut2SS6JNJytDm9"
+
+secret_string = password + salt
+secret_hash = binary_sha256(secret_string)
+secret = base64_encode(secret_hash)
+
+auth_response_string = secret + challenge
+auth_response_hash = binary_sha256(auth_response_string)
+auth_response = base64_encode(auth_response_hash)
+```

docs/partials/requestsHeader.md

@@ -0,0 +1,11 @@
+# Requests
+Requests are sent by the client and require at least the following two fields:
+- `request-type` _String_: String name of the request type.
+- `message-id` _String_: Client defined identifier for the message, will be echoed in the response.
+
+Once a request is sent, the server will return a JSON response with at least the following fields:
+- `message-id` _String_: The client defined identifier specified in the request.
+- `status` _String_: Response status, will be one of the following: `ok`, `error`
+- `error` _String_: An error message accompanying an `error` status.
+
+Additional information may be required/returned depending on the request type. See below for more information.

docs/partials/typedefsHeader.md

@@ -0,0 +1,2 @@
+# Typedefs
+These are complex types, such as `Source` and `Scene`, which are used as arguments or return values in multiple requests and/or events. 

docs/protocol.hbs

@@ -0,0 +1,112 @@
+{{#read "partials/introduction.md"}}{{/read}}
+
+
+
+# Table of Contents
+<!-- toc -->
+
+
+
+{{#read "partials/typedefsHeader.md"}}{{/read}}
+
+{{#each typedefs}}
+## {{typedefs.0.name}}
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+{{#each properties}}
+| `{{name}}` | _{{depipe type}}_ | {{{depipe description}}} |
+{{/each}}
+{{/each}}
+
+
+
+{{#read "partials/eventsHeader.md"}}{{/read}}
+
+{{#each events}}
+## {{capitalizeAll @key}}
+
+{{#each this}}
+### {{name}}
+
+{{#if deprecated}}
+- **⚠️ Deprecated. {{deprecated}} ⚠️**
+{{/if}}
+
+{{#eq since "unreleased"}}
+- Unreleased
+{{else}}
+- Added in v{{since}}
+{{/eq}}
+
+{{{description}}}
+
+**Response Items:**
+
+{{#if returns.length}}
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+{{#each returns}}
+| `{{name}}` | _{{depipe type}}_ | {{{depipe description}}} |
+{{/each}}
+
+{{else}}
+_No additional response items._
+{{/if}}
+
+---
+
+{{/each}}
+{{/each}}
+
+
+
+{{#read "partials/requestsHeader.md"}}{{/read}}
+
+{{#each requests}}
+## {{capitalizeAll @key}}
+
+{{#each this}}
+### {{name}}
+
+{{#if deprecated}}
+- **⚠️ Deprecated. {{deprecated}} ⚠️**
+{{/if}}
+
+{{#eq since "unreleased"}}
+- Unreleased
+{{else}}
+- Added in v{{since}}
+{{/eq}}
+
+{{{description}}}
+
+**Request Fields:**
+
+{{#if params.length}}
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+{{#each params}}
+| `{{name}}` | _{{depipe type}}_ | {{{depipe description}}} |
+{{/each}}
+
+{{else}}
+_No specified parameters._
+{{/if}}
+
+**Response Items:**
+
+{{#if returns.length}}
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+{{#each returns}}
+| `{{name}}` | _{{depipe type}}_ | {{{depipe description}}} |
+{{/each}}
+
+{{else}}
+_No additional response items._
+{{/if}}
+
+---
+
+{{/each}}
+{{/each}}

forms/settings-dialog.cpp

@@ -1,88 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#include <obs-frontend-api.h>
-#include "settings-dialog.h"
-#include "ui_settings-dialog.h"
-#include "Config.h"
-
-#define CHANGE_ME "changeme"
-
-SettingsDialog::SettingsDialog(QWidget *parent) :
-    QDialog(parent),
-    ui(new Ui::SettingsDialog)
-{
-    ui->setupUi(this);
-	
-	connect(ui->authRequired, &QCheckBox::stateChanged, this, &SettingsDialog::AuthCheckboxChanged);
-	connect(ui->buttonBox, &QDialogButtonBox::accepted, this, &SettingsDialog::FormAccepted);
-
-	AuthCheckboxChanged();
-}
-
-void SettingsDialog::showEvent(QShowEvent *event) {
-	ui->authRequired->setChecked(Config::Current()->AuthRequired);
-	ui->password->setText(CHANGE_ME);
-}
-
-void SettingsDialog::ToggleShowHide() {
-	if (!isVisible()) {
-		setVisible(true);
-	}
-	else {
-		setVisible(false);
-	}
-}
-
-void SettingsDialog::AuthCheckboxChanged() {
-	if (ui->authRequired->isChecked()) {
-		ui->password->setEnabled(true);
-	}
-	else {
-		ui->password->setEnabled(false);
-	}
-}
-
-void SettingsDialog::FormAccepted() {
-	if (ui->authRequired->isChecked()) {
-		if (ui->password->text() != CHANGE_ME) {
-			QByteArray pwd = ui->password->text().toLocal8Bit();
-			const char *new_password = pwd;
-
-			blog(LOG_INFO, "new password : %s", new_password);
-			Config::Current()->SetPassword(new_password);
-		}
-		
-		if (strcmp(Config::Current()->Secret, "") != 0) {
-			Config::Current()->AuthRequired = true;
-		}
-		else {
-			Config::Current()->AuthRequired = false;
-		}
-	}
-	else {
-		Config::Current()->AuthRequired = false;
-	}
-	
-	obs_frontend_save();
-}
-
-SettingsDialog::~SettingsDialog()
-{
-    delete ui;
-}

forms/settings-dialog.ui

@@ -1,101 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>SettingsDialog</class>
- <widget class="QDialog" name="SettingsDialog">
-  <property name="geometry">
-   <rect>
-    <x>0</x>
-    <y>0</y>
-    <width>354</width>
-    <height>110</height>
-   </rect>
-  </property>
-  <property name="sizePolicy">
-   <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
-    <horstretch>0</horstretch>
-    <verstretch>0</verstretch>
-   </sizepolicy>
-  </property>
-  <property name="windowTitle">
-   <string>Settings.DialogTitle</string>
-  </property>
-  <property name="sizeGripEnabled">
-   <bool>false</bool>
-  </property>
-  <layout class="QVBoxLayout" name="verticalLayout">
-   <property name="sizeConstraint">
-    <enum>QLayout::SetDefaultConstraint</enum>
-   </property>
-   <item>
-    <layout class="QFormLayout" name="formLayout">
-     <item row="3" column="0">
-      <widget class="QLabel" name="lbl_password">
-       <property name="text">
-        <string>Settings.Password</string>
-       </property>
-      </widget>
-     </item>
-     <item row="3" column="1">
-      <widget class="QLineEdit" name="password">
-       <property name="echoMode">
-        <enum>QLineEdit::Password</enum>
-       </property>
-      </widget>
-     </item>
-     <item row="2" column="1">
-      <widget class="QCheckBox" name="authRequired">
-       <property name="text">
-        <string>Settings.AuthRequired</string>
-       </property>
-      </widget>
-     </item>
-    </layout>
-   </item>
-   <item>
-    <widget class="QDialogButtonBox" name="buttonBox">
-     <property name="orientation">
-      <enum>Qt::Horizontal</enum>
-     </property>
-     <property name="standardButtons">
-      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
-     </property>
-    </widget>
-   </item>
-  </layout>
- </widget>
- <resources/>
- <connections>
-  <connection>
-   <sender>buttonBox</sender>
-   <signal>accepted()</signal>
-   <receiver>SettingsDialog</receiver>
-   <slot>accept()</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>248</x>
-     <y>254</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>157</x>
-     <y>274</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>buttonBox</sender>
-   <signal>rejected()</signal>
-   <receiver>SettingsDialog</receiver>
-   <slot>reject()</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>316</x>
-     <y>260</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>286</x>
-     <y>274</y>
-    </hint>
-   </hints>
-  </connection>
- </connections>
-</ui>

installer/installer.iss

@@ -0,0 +1,68 @@
+; Script generated by the Inno Setup Script Wizard.
+; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
+
+#define MyAppName "obs-websocket"
+#define MyAppVersion "4.8.0"
+#define MyAppPublisher "Stephane Lepin"
+#define MyAppURL "http://github.com/Palakis/obs-websocket"
+
+[Setup]
+; NOTE: The value of AppId uniquely identifies this application.
+; Do not use the same AppId value in installers for other applications.
+; (To generate a new GUID, click Tools | Generate GUID inside the IDE.)
+AppId={{117EE44F-48E1-49E5-A381-CC8D9195CF35}
+AppName={#MyAppName}
+AppVersion={#MyAppVersion}
+;AppVerName={#MyAppName} {#MyAppVersion}
+AppPublisher={#MyAppPublisher}
+AppPublisherURL={#MyAppURL}
+AppSupportURL={#MyAppURL}
+AppUpdatesURL={#MyAppURL}
+DefaultDirName={code:GetDirName}
+DefaultGroupName={#MyAppName}
+OutputBaseFilename=obs-websocket-Windows-Installer
+Compression=lzma
+SolidCompression=yes
+
+[Languages]
+Name: "english"; MessagesFile: "compiler:Default.isl"
+
+[Files]
+Source: "..\release\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
+Source: "..\LICENSE"; Flags: dontcopy
+; NOTE: Don't use "Flags: ignoreversion" on any shared system files
+
+[Icons]
+Name: "{group}\{cm:ProgramOnTheWeb,{#MyAppName}}"; Filename: "{#MyAppURL}"
+Name: "{group}\{cm:UninstallProgram,{#MyAppName}}"; Filename: "{uninstallexe}"
+
+[Code]
+procedure InitializeWizard();
+var
+  GPLText: AnsiString;
+  Page: TOutputMsgMemoWizardPage;
+begin
+  ExtractTemporaryFile('LICENSE');
+  LoadStringFromFile(ExpandConstant('{tmp}\LICENSE'), GPLText);
+
+  Page := CreateOutputMsgMemoPage(wpWelcome,
+    'License Information', 'Please review the license terms before installing obs-websocket',
+    'Press Page Down to see the rest of the agreement. Once you are aware of your rights, click Next to continue.',
+    String(GPLText)
+  );
+end;
+
+// credit where it's due :
+// following function come from https://github.com/Xaymar/obs-studio_amf-encoder-plugin/blob/master/%23Resources/Installer.in.iss#L45
+function GetDirName(Value: string): string;
+var
+	InstallPath: string;
+begin
+	// initialize default path, which will be returned when the following registry
+	// key queries fail due to missing keys or for some different reason
+	Result := '{pf}\obs-studio';
+	// query the first registry value; if this succeeds, return the obtained value
+	if RegQueryStringValue(HKLM32, 'SOFTWARE\OBS Studio', '', InstallPath) then
+		Result := InstallPath
+end;
+

obs-websocket.cpp

@@ -1,63 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program. If not, see <https://www.gnu.org/licenses/>
-*/
-
-#include <obs-module.h>
-#include <obs-frontend-api.h>
-#include <QAction>
-
-#include "obs-websocket.h"
-#include "WSEvents.h"
-#include "WSServer.h"
-#include "Config.h"
-#include "forms/settings-dialog.h"
-
-OBS_DECLARE_MODULE()
-OBS_MODULE_USE_DEFAULT_LOCALE("obs-websocket", "en-US")
-
-WSEvents *eventHandler;
-WSServer *server;
-SettingsDialog *settings_dialog;
-
-bool obs_module_load(void) 
-{
-	blog(LOG_INFO, "[obs-websockets] you can haz websockets (version %s)", OBS_WEBSOCKET_VERSION);
-	
-	server = new WSServer(4444);
-	eventHandler = new WSEvents(server);
-	
-	obs_frontend_add_save_callback(Config::OBSSaveCallback, Config::Current());
-
-	QAction *menu_action = (QAction*)obs_frontend_add_tools_menu_qaction(obs_module_text("Menu.SettingsItem"));
-
-	obs_frontend_push_ui_translation(obs_module_get_string);
-	settings_dialog = new SettingsDialog();
-	obs_frontend_pop_ui_translation();
-
-	auto menu_cb = [] {
-		settings_dialog->ToggleShowHide();
-	};
-	menu_action->connect(menu_action, &QAction::triggered, menu_cb);
-
-	return true;
-}
-
-void obs_module_unload()
-{
-	blog(LOG_INFO, "[obs-websockets] goodbye !");
-}
-

src/Config.cpp

@@ -0,0 +1,286 @@
+/*
+obs-websocket
+Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#include <obs-frontend-api.h>
+
+#include <QtCore/QCryptographicHash>
+#include <QtCore/QTime>
+#include <QtWidgets/QSystemTrayIcon>
+
+#define SECTION_NAME "WebsocketAPI"
+#define PARAM_ENABLE "ServerEnabled"
+#define PARAM_PORT "ServerPort"
+#define PARAM_DEBUG "DebugEnabled"
+#define PARAM_ALERT "AlertsEnabled"
+#define PARAM_AUTHREQUIRED "AuthRequired"
+#define PARAM_SECRET "AuthSecret"
+#define PARAM_SALT "AuthSalt"
+
+#include "Utils.h"
+#include "WSServer.h"
+
+#include "Config.h"
+
+#define QT_TO_UTF8(str) str.toUtf8().constData()
+
+Config::Config() :
+	ServerEnabled(true),
+	ServerPort(4444),
+	DebugEnabled(false),
+	AlertsEnabled(true),
+	AuthRequired(false),
+	Secret(""),
+	Salt(""),
+	SettingsLoaded(false)
+{
+	qsrand(QTime::currentTime().msec());
+
+	SetDefaults();
+	SessionChallenge = GenerateSalt();
+
+	obs_frontend_add_event_callback(OnFrontendEvent, this);
+}
+
+Config::~Config()
+{
+	obs_frontend_remove_event_callback(OnFrontendEvent, this);
+}
+
+void Config::Load()
+{
+	config_t* obsConfig = GetConfigStore();
+
+	ServerEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ENABLE);
+	ServerPort = config_get_uint(obsConfig, SECTION_NAME, PARAM_PORT);
+
+	DebugEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_DEBUG);
+	AlertsEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ALERT);
+
+	AuthRequired = config_get_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED);
+	Secret = config_get_string(obsConfig, SECTION_NAME, PARAM_SECRET);
+	Salt = config_get_string(obsConfig, SECTION_NAME, PARAM_SALT);
+}
+
+void Config::Save()
+{
+	config_t* obsConfig = GetConfigStore();
+
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_ENABLE, ServerEnabled);
+	config_set_uint(obsConfig, SECTION_NAME, PARAM_PORT, ServerPort);
+
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_DEBUG, DebugEnabled);
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_ALERT, AlertsEnabled);
+
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED, AuthRequired);
+	config_set_string(obsConfig, SECTION_NAME, PARAM_SECRET,
+		QT_TO_UTF8(Secret));
+	config_set_string(obsConfig, SECTION_NAME, PARAM_SALT,
+		QT_TO_UTF8(Salt));
+
+	config_save(obsConfig);
+}
+
+void Config::SetDefaults()
+{
+	// OBS Config defaults
+	config_t* obsConfig = GetConfigStore();
+	if (obsConfig) {
+		config_set_default_bool(obsConfig,
+			SECTION_NAME, PARAM_ENABLE, ServerEnabled);
+		config_set_default_uint(obsConfig,
+			SECTION_NAME, PARAM_PORT, ServerPort);
+
+		config_set_default_bool(obsConfig,
+			SECTION_NAME, PARAM_DEBUG, DebugEnabled);
+		config_set_default_bool(obsConfig,
+			SECTION_NAME, PARAM_ALERT, AlertsEnabled);
+
+		config_set_default_bool(obsConfig,
+			SECTION_NAME, PARAM_AUTHREQUIRED, AuthRequired);
+		config_set_default_string(obsConfig,
+			SECTION_NAME, PARAM_SECRET, QT_TO_UTF8(Secret));
+		config_set_default_string(obsConfig,
+			SECTION_NAME, PARAM_SALT, QT_TO_UTF8(Salt));
+	}
+}
+
+config_t* Config::GetConfigStore()
+{
+	return obs_frontend_get_profile_config();
+}
+
+QString Config::GenerateSalt()
+{
+	// Generate 32 random chars
+	const size_t randomCount = 32;
+	QByteArray randomChars;
+	for (size_t i = 0; i < randomCount; i++) {
+		randomChars.append((char)qrand());
+	}
+
+	// Convert the 32 random chars to a base64 string
+	QString salt = randomChars.toBase64();
+
+	return salt;
+}
+
+QString Config::GenerateSecret(QString password, QString salt)
+{
+	// Concatenate the password and the salt
+	QString passAndSalt = "";
+	passAndSalt += password;
+	passAndSalt += salt;
+
+	// Generate a SHA256 hash of the password and salt
+	auto challengeHash = QCryptographicHash::hash(
+		passAndSalt.toUtf8(),
+		QCryptographicHash::Algorithm::Sha256
+	);
+
+	// Encode SHA256 hash to Base64
+	QString challenge = challengeHash.toBase64();
+
+	return challenge;
+}
+
+void Config::SetPassword(QString password)
+{
+	QString newSalt = GenerateSalt();
+	QString newChallenge = GenerateSecret(password, newSalt);
+
+	this->Salt = newSalt;
+	this->Secret = newChallenge;
+}
+
+bool Config::CheckAuth(QString response)
+{
+	// Concatenate auth secret with the challenge sent to the user
+	QString challengeAndResponse = "";
+	challengeAndResponse += Secret;
+	challengeAndResponse += SessionChallenge;
+
+	// Generate a SHA256 hash of challengeAndResponse
+	auto hash = QCryptographicHash::hash(
+		challengeAndResponse.toUtf8(),
+		QCryptographicHash::Algorithm::Sha256
+	);
+
+	// Encode the SHA256 hash to Base64
+	QString expectedResponse = hash.toBase64();
+
+	bool authSuccess = false;
+	if (response == expectedResponse) {
+		SessionChallenge = GenerateSalt();
+		authSuccess = true;
+	}
+
+	return authSuccess;
+}
+
+void Config::OnFrontendEvent(enum obs_frontend_event event, void* param)
+{
+	auto config = reinterpret_cast<Config*>(param);
+
+	if (event == OBS_FRONTEND_EVENT_PROFILE_CHANGED) {
+		obs_frontend_push_ui_translation(obs_module_get_string);
+		QString startMessage = QObject::tr("OBSWebsocket.ProfileChanged.Started");
+		QString stopMessage = QObject::tr("OBSWebsocket.ProfileChanged.Stopped");
+		QString restartMessage = QObject::tr("OBSWebsocket.ProfileChanged.Restarted");
+		obs_frontend_pop_ui_translation();
+
+		bool previousEnabled = config->ServerEnabled;
+		uint64_t previousPort = config->ServerPort;
+
+		config->SetDefaults();
+		config->Load();
+
+		if (config->ServerEnabled != previousEnabled || config->ServerPort != previousPort) {
+			auto server = GetServer();
+			server->stop();
+
+			if (config->ServerEnabled) {
+				server->start(config->ServerPort);
+
+				if (previousEnabled != config->ServerEnabled) {
+					Utils::SysTrayNotify(startMessage, QSystemTrayIcon::MessageIcon::Information);
+				} else {
+					Utils::SysTrayNotify(restartMessage, QSystemTrayIcon::MessageIcon::Information);
+				}
+			} else {
+				Utils::SysTrayNotify(stopMessage, QSystemTrayIcon::MessageIcon::Information);
+			}
+		}
+	}
+}
+
+void Config::MigrateFromGlobalSettings()
+{
+	config_t* source = obs_frontend_get_global_config();
+	config_t* destination = obs_frontend_get_profile_config();
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_ENABLE)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_ENABLE);
+		config_set_bool(destination, SECTION_NAME, PARAM_ENABLE, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_ENABLE);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_PORT)) {
+		uint64_t value = config_get_uint(source, SECTION_NAME, PARAM_PORT);
+		config_set_uint(destination, SECTION_NAME, PARAM_PORT, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_PORT);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_DEBUG)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_DEBUG);
+		config_set_bool(destination, SECTION_NAME, PARAM_DEBUG, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_DEBUG);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_ALERT)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_ALERT);
+		config_set_bool(destination, SECTION_NAME, PARAM_ALERT, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_ALERT);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_AUTHREQUIRED)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_AUTHREQUIRED);
+		config_set_bool(destination, SECTION_NAME, PARAM_AUTHREQUIRED, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_AUTHREQUIRED);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_SECRET)) {
+		const char* value = config_get_string(source, SECTION_NAME, PARAM_SECRET);
+		config_set_string(destination, SECTION_NAME, PARAM_SECRET, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_SECRET);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_SALT)) {
+		const char* value = config_get_string(source, SECTION_NAME, PARAM_SALT);
+		config_set_string(destination, SECTION_NAME, PARAM_SALT, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_SALT);
+	}
+
+	config_save(destination);
+}

src/Config.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,35 +16,42 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef CONFIG_H
-#define CONFIG_H
+#pragma once
 
-#include <obs-module.h>
-#include <mbedtls/entropy.h>
-#include <mbedtls/ctr_drbg.h>
+#include <obs-frontend-api.h>
+#include <util/config-file.h>
+#include <QtCore/QString>
+#include <QtCore/QSharedPointer>
 
 class Config {
 	public:
 		Config();
 		~Config();
-		void SetPassword(const char *password);
-		bool CheckAuth(const char *userChallenge);
-		const char* GenerateSalt();
-		static const char* GenerateSecret(const char *password, const char *salt);
-		static void OBSSaveCallback(obs_data_t *save_data, bool saving, void *);
+		void Load();
+		void Save();
+		void SetDefaults();
+		config_t* GetConfigStore();
+
+		void MigrateFromGlobalSettings();
+
+		void SetPassword(QString password);
+		bool CheckAuth(QString userChallenge);
+		QString GenerateSalt();
+		static QString GenerateSecret(
+				QString password, QString salt);
+
+		bool ServerEnabled;
+		uint64_t ServerPort;
+
+		bool DebugEnabled;
+		bool AlertsEnabled;
 
 		bool AuthRequired;
-		const char *Secret;
-		const char *Salt;
-		const char *SessionChallenge;
+		QString Secret;
+		QString Salt;
+		QString SessionChallenge;
 		bool SettingsLoaded;
 
-		static Config* Current();
-
 	private:
-		static Config *_instance;
-		mbedtls_entropy_context entropy;
-		mbedtls_ctr_drbg_context rng;
+		static void OnFrontendEvent(enum obs_frontend_event event, void* param);
 };
-
-#endif // CONFIG_H

src/ConnectionProperties.cpp

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,21 +16,19 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef UTILS_H
-#define UTILS_H
+#include "ConnectionProperties.h"
 
-#include <obs-module.h>
-#include <obs-frontend-api.h>
-
-class Utils
+ConnectionProperties::ConnectionProperties()
+    : _authenticated(false)
 {
-	public:
-		static obs_data_array_t* GetSceneItems(obs_source_t *source);
-		static obs_data_t* GetSceneItemData(obs_scene_item *item);
-		static obs_sceneitem_t* GetSceneItemFromName(obs_source_t *source, const char* name);
+}
 
-		static obs_data_array_t* GetScenes();
-		static obs_data_t* GetSceneData(obs_source *source);
-};
+bool ConnectionProperties::isAuthenticated()
+{
+    return _authenticated.load();
+}
 
-#endif // UTILS_H
+void ConnectionProperties::setAuthenticated(bool authenticated)
+{
+    _authenticated.store(authenticated);
+}

src/ConnectionProperties.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,9 +16,16 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef OBSWEBSOCKET_H
-#define OBSWEBSOCKET_H
+#pragma once
 
-#define OBS_WEBSOCKET_VERSION "0.3-alpha"
+#include <atomic>
 
-#endif // OBSWEBSOCKET_H
+class ConnectionProperties
+{
+public:
+    explicit ConnectionProperties();
+    bool isAuthenticated();
+    void setAuthenticated(bool authenticated);
+private:
+    std::atomic<bool> _authenticated;
+};

src/Utils.cpp

@@ -0,0 +1,861 @@
+/*
+obs-websocket
+Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#include <inttypes.h>
+#include <QtWidgets/QMainWindow>
+#include <QtCore/QDir>
+#include <QtCore/QUrl>
+
+#include <obs-frontend-api.h>
+#include <obs.hpp>
+#include <util/platform.h>
+
+#include "obs-websocket.h"
+
+#include "Utils.h"
+#include "Config.h"
+
+Q_DECLARE_METATYPE(OBSScene);
+
+const QHash<obs_bounds_type, QString> boundTypeNames = {
+	{ OBS_BOUNDS_STRETCH, "OBS_BOUNDS_STRETCH" },
+	{ OBS_BOUNDS_SCALE_INNER, "OBS_BOUNDS_SCALE_INNER" },
+	{ OBS_BOUNDS_SCALE_OUTER, "OBS_BOUNDS_SCALE_OUTER" },
+	{ OBS_BOUNDS_SCALE_TO_WIDTH, "OBS_BOUNDS_SCALE_TO_WIDTH" },
+	{ OBS_BOUNDS_SCALE_TO_HEIGHT, "OBS_BOUNDS_SCALE_TO_HEIGHT" },
+	{ OBS_BOUNDS_MAX_ONLY, "OBS_BOUNDS_MAX_ONLY" },
+	{ OBS_BOUNDS_NONE, "OBS_BOUNDS_NONE" },
+};
+
+QString getBoundsNameFromType(obs_bounds_type type) {
+	QString fallback = boundTypeNames.value(OBS_BOUNDS_NONE);
+	return boundTypeNames.value(type, fallback);
+}
+
+obs_bounds_type getBoundsTypeFromName(QString name) {
+	return boundTypeNames.key(name);
+}
+
+obs_data_array_t* Utils::StringListToArray(char** strings, const char* key) {
+	obs_data_array_t* list = obs_data_array_create();
+
+	if (!strings || !key) {
+		return list; // empty list
+	}
+
+	size_t index = 0;
+	char* value = nullptr;
+
+	do {
+		value = strings[index];
+
+		OBSDataAutoRelease item = obs_data_create();
+		obs_data_set_string(item, key, value);
+
+		if (value) {
+			obs_data_array_push_back(list, item);
+		}
+
+		index++;
+	} while (value != nullptr);
+
+	return list;
+}
+
+obs_data_array_t* Utils::GetSceneItems(obs_source_t* source) {
+	obs_data_array_t* items = obs_data_array_create();
+	OBSScene scene = obs_scene_from_source(source);
+
+	if (!scene) {
+		return nullptr;
+	}
+
+	obs_scene_enum_items(scene, [](
+			obs_scene_t* scene,
+			obs_sceneitem_t* currentItem,
+			void* param)
+	{
+		obs_data_array_t* data = reinterpret_cast<obs_data_array_t*>(param);
+
+		OBSDataAutoRelease itemData = GetSceneItemData(currentItem);
+		obs_data_array_insert(data, 0, itemData);
+		return true;
+	}, items);
+
+	return items;
+}
+
+/**
+ * @typedef {Object} `SceneItem` An OBS Scene Item.
+ * @property {Number} `cy`
+ * @property {Number} `cx`
+ * @property {Number} `alignment` The point on the source that the item is manipulated from. The sum of 1=Left or 2=Right, and 4=Top or 8=Bottom, or omit to center on that axis.
+ * @property {String} `name` The name of this Scene Item.
+ * @property {int} `id` Scene item ID
+ * @property {Boolean} `render` Whether or not this Scene Item is set to "visible".
+ * @property {Boolean} `muted` Whether or not this Scene Item is muted.
+ * @property {Boolean} `locked` Whether or not this Scene Item is locked and can't be moved around
+ * @property {Number} `source_cx`
+ * @property {Number} `source_cy`
+ * @property {String} `type` Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown"
+ * @property {Number} `volume`
+ * @property {Number} `x`
+ * @property {Number} `y`
+ * @property {String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)
+ * @property {Array<SceneItem> (optional)} `groupChildren` List of children (if this item is a group)
+ */
+obs_data_t* Utils::GetSceneItemData(obs_sceneitem_t* item) {
+	if (!item) {
+		return nullptr;
+	}
+
+	vec2 pos;
+	obs_sceneitem_get_pos(item, &pos);
+
+	vec2 scale;
+	obs_sceneitem_get_scale(item, &scale);
+
+	// obs_sceneitem_get_source doesn't increase the refcount
+	OBSSource itemSource = obs_sceneitem_get_source(item);
+	float item_width = float(obs_source_get_width(itemSource));
+	float item_height = float(obs_source_get_height(itemSource));
+
+	obs_data_t* data = obs_data_create();
+	obs_data_set_string(data, "name",
+		obs_source_get_name(itemSource));
+	obs_data_set_int(data, "id",
+		obs_sceneitem_get_id(item));
+	obs_data_set_string(data, "type",
+		obs_source_get_id(itemSource));
+	obs_data_set_double(data, "volume",
+		obs_source_get_volume(itemSource));
+	obs_data_set_double(data, "x", pos.x);
+	obs_data_set_double(data, "y", pos.y);
+	obs_data_set_int(data, "source_cx", (int)item_width);
+	obs_data_set_int(data, "source_cy", (int)item_height);
+	obs_data_set_bool(data, "muted", obs_source_muted(itemSource));
+	obs_data_set_int(data, "alignment", (int)obs_sceneitem_get_alignment(item));
+	obs_data_set_double(data, "cx", item_width * scale.x);
+	obs_data_set_double(data, "cy", item_height * scale.y);
+	obs_data_set_bool(data, "render", obs_sceneitem_visible(item));
+	obs_data_set_bool(data, "locked", obs_sceneitem_locked(item));
+
+	obs_scene_t* parent = obs_sceneitem_get_scene(item);
+	if (parent) {
+		OBSSource parentSource = obs_scene_get_source(parent);
+		QString parentKind = obs_source_get_id(parentSource);
+		if (parentKind == "group") {
+			obs_data_set_string(data, "parentGroupName", obs_source_get_name(parentSource));
+		}
+	}
+
+	if (obs_sceneitem_is_group(item)) {
+		OBSDataArrayAutoRelease children = obs_data_array_create();
+		obs_sceneitem_group_enum_items(item, [](obs_scene_t*, obs_sceneitem_t* currentItem, void* param) {
+			obs_data_array_t* items = reinterpret_cast<obs_data_array_t*>(param);
+
+			OBSDataAutoRelease itemData = GetSceneItemData(currentItem);
+			obs_data_array_push_back(items, itemData);
+
+			return true;
+		}, children);
+		obs_data_set_array(data, "groupChildren", children);
+	}
+
+	return data;
+}
+
+obs_sceneitem_t* Utils::GetSceneItemFromName(obs_scene_t* scene, QString name) {
+	if (!scene) {
+		return nullptr;
+	}
+
+	struct current_search {
+		QString query;
+		obs_sceneitem_t* result;
+		bool (*enumCallback)(obs_scene_t*, obs_sceneitem_t*, void*);
+	};
+
+	current_search search;
+	search.query = name;
+	search.result = nullptr;
+
+	search.enumCallback = [](
+			obs_scene_t* scene,
+			obs_sceneitem_t* currentItem,
+			void* param)
+	{
+		current_search* search = reinterpret_cast<current_search*>(param);
+
+		if (obs_sceneitem_is_group(currentItem)) {
+			obs_sceneitem_group_enum_items(currentItem, search->enumCallback, search);
+			if (search->result) {
+				return false;
+			}
+		}
+
+		QString currentItemName =
+			obs_source_get_name(obs_sceneitem_get_source(currentItem));
+
+		if (currentItemName == search->query) {
+			search->result = currentItem;
+			obs_sceneitem_addref(search->result);
+			return false;
+		}
+
+		return true;
+	};
+
+	obs_scene_enum_items(scene, search.enumCallback, &search);
+
+	return search.result;
+}
+
+obs_sceneitem_t* Utils::GetSceneItemFromId(obs_scene_t* scene, int64_t id) {
+	if (!scene) {
+		return nullptr;
+	}
+
+	struct current_search {
+		int query;
+		obs_sceneitem_t* result;
+		bool (*enumCallback)(obs_scene_t*, obs_sceneitem_t*, void*);
+	};
+
+	current_search search;
+	search.query = id;
+	search.result = nullptr;
+
+	search.enumCallback = [](
+		obs_scene_t* scene,
+		obs_sceneitem_t* currentItem,
+		void* param)
+	{
+		current_search* search = reinterpret_cast<current_search*>(param);
+
+		if (obs_sceneitem_is_group(currentItem)) {
+			obs_sceneitem_group_enum_items(currentItem, search->enumCallback, search);
+			if (search->result) {
+				return false;
+			}
+		}
+
+		if (obs_sceneitem_get_id(currentItem) == search->query) {
+			search->result = currentItem;
+			obs_sceneitem_addref(search->result);
+			return false;
+		}
+
+		return true;
+	};
+
+	obs_scene_enum_items(scene, search.enumCallback, &search);
+
+	return search.result;
+}
+
+obs_sceneitem_t* Utils::GetSceneItemFromItem(obs_scene_t* scene, obs_data_t* itemInfo) {
+	if (!scene) {
+		return nullptr;
+	}
+
+	OBSDataItemAutoRelease idInfoItem = obs_data_item_byname(itemInfo, "id");
+	int id = obs_data_item_get_int(idInfoItem);
+
+	OBSDataItemAutoRelease nameInfoItem = obs_data_item_byname(itemInfo, "name");
+	const char* name = obs_data_item_get_string(nameInfoItem);
+
+	if (idInfoItem) {
+		obs_sceneitem_t* sceneItem = GetSceneItemFromId(scene, id);
+		obs_source_t* sceneItemSource = obs_sceneitem_get_source(sceneItem);
+
+		QString sceneItemName = obs_source_get_name(sceneItemSource);
+		if (nameInfoItem && (QString(name) != sceneItemName)) {
+			return nullptr;
+		}
+
+		return sceneItem;
+	} else if (nameInfoItem) {
+		return GetSceneItemFromName(scene, name);
+	}
+
+	return nullptr;
+}
+
+obs_sceneitem_t* Utils::GetSceneItemFromRequestField(obs_scene_t* scene, obs_data_item_t* dataItem)
+{
+	enum obs_data_type dataType = obs_data_item_gettype(dataItem);
+
+	if (dataType == OBS_DATA_OBJECT) {
+		OBSDataAutoRelease itemData = obs_data_item_get_obj(dataItem);
+		return GetSceneItemFromItem(scene, itemData);
+	} else if (dataType == OBS_DATA_STRING) {
+		QString name = obs_data_item_get_string(dataItem);
+		return GetSceneItemFromName(scene, name);
+	}
+
+	return nullptr;
+}
+
+bool Utils::IsValidAlignment(const uint32_t alignment) {
+	switch (alignment) {
+		case OBS_ALIGN_CENTER:
+		case OBS_ALIGN_LEFT:
+		case OBS_ALIGN_RIGHT:
+		case OBS_ALIGN_TOP:
+		case OBS_ALIGN_BOTTOM:
+		case OBS_ALIGN_TOP | OBS_ALIGN_LEFT:
+		case OBS_ALIGN_TOP | OBS_ALIGN_RIGHT:
+		case OBS_ALIGN_BOTTOM | OBS_ALIGN_LEFT:
+		case OBS_ALIGN_BOTTOM | OBS_ALIGN_RIGHT: {
+			return true;
+		}
+	}
+	return false;
+}
+
+obs_source_t* Utils::GetTransitionFromName(QString searchName) {
+	obs_source_t* foundTransition = nullptr;
+
+	obs_frontend_source_list transition_list = {};
+	obs_frontend_get_transitions(&transition_list);
+
+	for (size_t i = 0; i < transition_list.sources.num; i++) {
+		obs_source_t* transition = transition_list.sources.array[i];
+		QString transitionName = obs_source_get_name(transition);
+
+		if (transitionName == searchName) {
+			foundTransition = transition;
+			obs_source_addref(foundTransition);
+			break;
+		}
+	}
+
+	obs_frontend_source_list_free(&transition_list);
+	return foundTransition;
+}
+
+obs_scene_t* Utils::GetSceneFromNameOrCurrent(QString sceneName) {
+	// Both obs_frontend_get_current_scene() and obs_get_source_by_name()
+	// increase the returned source's refcount
+	OBSSourceAutoRelease sceneSource = nullptr;
+
+	if (sceneName.isEmpty() || sceneName.isNull()) {
+		sceneSource = obs_frontend_get_current_scene();
+	}
+	else {
+		sceneSource = obs_get_source_by_name(sceneName.toUtf8());
+	}
+
+	return obs_scene_from_source(sceneSource);
+}
+
+obs_data_array_t* Utils::GetScenes() {
+	obs_frontend_source_list sceneList = {};
+	obs_frontend_get_scenes(&sceneList);
+
+	obs_data_array_t* scenes = obs_data_array_create();
+	for (size_t i = 0; i < sceneList.sources.num; i++) {
+		obs_source_t* scene = sceneList.sources.array[i];
+		OBSDataAutoRelease sceneData = GetSceneData(scene);
+		obs_data_array_push_back(scenes, sceneData);
+	}
+
+	obs_frontend_source_list_free(&sceneList);
+	return scenes;
+}
+
+obs_data_t* Utils::GetSceneData(obs_source_t* source) {
+	OBSDataArrayAutoRelease sceneItems = GetSceneItems(source);
+
+	obs_data_t* sceneData = obs_data_create();
+	obs_data_set_string(sceneData, "name", obs_source_get_name(source));
+	obs_data_set_array(sceneData, "sources", sceneItems);
+
+	return sceneData;
+}
+
+QSpinBox* Utils::GetTransitionDurationControl() {
+	QMainWindow* window = (QMainWindow*)obs_frontend_get_main_window();
+	return window->findChild<QSpinBox*>("transitionDuration");
+}
+
+int Utils::GetTransitionDuration(obs_source_t* transition) {
+	if (!transition || obs_source_get_type(transition) != OBS_SOURCE_TYPE_TRANSITION) {
+		return -1;
+	}
+
+	QString transitionKind = obs_source_get_id(transition);
+	if (transitionKind == "cut_transition") {
+		// If this is a Cut transition, return 0
+		return 0;
+	}
+
+	if (obs_transition_fixed(transition)) {
+		// If this transition has a fixed duration (such as a Stinger),
+		// we don't currently have a way of retrieving that number.
+		// For now, return -1 to indicate that we don't know the actual duration.
+		return -1;
+	}
+
+	OBSSourceAutoRelease destinationScene = obs_transition_get_active_source(transition);
+	OBSDataAutoRelease destinationSettings = obs_source_get_private_settings(destinationScene);
+
+	// Detect if transition is the global transition or a transition override.
+	// Fetching the duration is different depending on the case.
+	obs_data_item_t* transitionDurationItem = obs_data_item_byname(destinationSettings, "transition_duration");
+	int duration = (
+		transitionDurationItem
+		? obs_data_item_get_int(transitionDurationItem)
+		: obs_frontend_get_transition_duration()
+	);
+
+	return duration;
+}
+
+bool Utils::SetTransitionByName(QString transitionName) {
+	OBSSourceAutoRelease transition = GetTransitionFromName(transitionName);
+
+	if (transition) {
+		obs_frontend_set_current_transition(transition);
+		return true;
+	} else {
+		return false;
+	}
+}
+
+obs_data_t* Utils::GetTransitionData(obs_source_t* transition) {
+	int duration = Utils::GetTransitionDuration(transition);
+	if (duration < 0) {
+		blog(LOG_WARNING, "GetTransitionData: duration is negative !");
+	}
+
+	OBSSourceAutoRelease sourceScene = obs_transition_get_source(transition, OBS_TRANSITION_SOURCE_A);
+	OBSSourceAutoRelease destinationScene = obs_transition_get_active_source(transition);
+
+	obs_data_t* transitionData = obs_data_create();
+	obs_data_set_string(transitionData, "name", obs_source_get_name(transition));
+	obs_data_set_string(transitionData, "type", obs_source_get_id(transition));
+	obs_data_set_int(transitionData, "duration", duration);
+
+	// When a transition starts and while it is running, SOURCE_A is the source scene
+	// and SOURCE_B is the destination scene.
+	// Before the transition_end event is triggered on a transition, the destination scene
+	// goes into SOURCE_A and SOURCE_B becomes null. This means that, in transition_stop
+	// we don't know what was the source scene
+	// TODO fix this in libobs
+
+	bool isTransitionEndEvent = (sourceScene == destinationScene);
+	if (!isTransitionEndEvent) {
+		obs_data_set_string(transitionData, "from-scene", obs_source_get_name(sourceScene));
+	}
+	
+	obs_data_set_string(transitionData, "to-scene", obs_source_get_name(destinationScene));
+
+	return transitionData;
+}
+
+QString Utils::OBSVersionString() {
+	uint32_t version = obs_get_version();
+
+	uint8_t major, minor, patch;
+	major = (version >> 24) & 0xFF;
+	minor = (version >> 16) & 0xFF;
+	patch = version & 0xFF;
+
+	QString result = QString("%1.%2.%3")
+		.arg(major).arg(minor).arg(patch);
+
+	return result;
+}
+
+QSystemTrayIcon* Utils::GetTrayIcon() {
+	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
+	if (!main) return nullptr;
+
+	QList<QSystemTrayIcon*> trays = main->findChildren<QSystemTrayIcon*>();
+	return trays.isEmpty() ? nullptr : trays.first();
+}
+
+void Utils::SysTrayNotify(QString text,
+	QSystemTrayIcon::MessageIcon icon, QString title) {
+	if (!GetConfig()->AlertsEnabled ||
+		!QSystemTrayIcon::isSystemTrayAvailable() ||
+		!QSystemTrayIcon::supportsMessages())
+	{
+		return;
+	}
+
+	QSystemTrayIcon* trayIcon = GetTrayIcon();
+	if (trayIcon)
+		trayIcon->showMessage(title, text, icon);
+}
+
+const char* Utils::GetRecordingFolder() {
+	config_t* profile = obs_frontend_get_profile_config();
+	QString outputMode = config_get_string(profile, "Output", "Mode");
+
+	if (outputMode == "Advanced") {
+		// Advanced mode
+		return config_get_string(profile, "AdvOut", "RecFilePath");
+	} else {
+		// Simple mode
+		return config_get_string(profile, "SimpleOutput", "FilePath");
+	}
+}
+
+bool Utils::SetRecordingFolder(const char* path) {
+	QDir dir(path);
+	if (!dir.exists()) {
+		dir.mkpath(".");
+	}
+
+	config_t* profile = obs_frontend_get_profile_config();
+	config_set_string(profile, "AdvOut", "RecFilePath", path);
+	config_set_string(profile, "SimpleOutput", "FilePath", path);
+
+	config_save(profile);
+	return true;
+}
+
+QString Utils::ParseDataToQueryString(obs_data_t* data) {
+	if (!data)
+		return QString();
+
+	QString query;
+
+	obs_data_item_t* item = obs_data_first(data);
+	if (item) {
+		bool isFirst = true;
+		do {
+			if (!obs_data_item_has_user_value(item))
+				continue;
+
+			if (!isFirst)
+				query += "&";
+			else
+				isFirst = false;
+
+			QString attrName = obs_data_item_get_name(item);
+			query += (attrName + "=");
+
+			switch (obs_data_item_gettype(item)) {
+				case OBS_DATA_BOOLEAN:
+					query += (obs_data_item_get_bool(item) ? "true" : "false");
+					break;
+
+				case OBS_DATA_NUMBER:
+					switch (obs_data_item_numtype(item)) {
+						case OBS_DATA_NUM_DOUBLE:
+							query +=
+								QString::number(obs_data_item_get_double(item));
+							break;
+						case OBS_DATA_NUM_INT:
+							query +=
+								QString::number(obs_data_item_get_int(item));
+							break;
+						case OBS_DATA_NUM_INVALID:
+							break;
+					}
+					break;
+
+				case OBS_DATA_STRING:
+					query +=
+						QUrl::toPercentEncoding(
+							QString(obs_data_item_get_string(item)));
+					break;
+
+				default:
+					//other types are not supported
+					break;
+			}
+		} while (obs_data_item_next(&item));
+	}
+
+	return query;
+}
+
+obs_hotkey_t* Utils::FindHotkeyByName(QString name) {
+	struct current_search {
+		QString query;
+		obs_hotkey_t* result;
+	};
+
+	current_search search;
+	search.query = name;
+	search.result = nullptr;
+
+	obs_enum_hotkeys([](void* data, obs_hotkey_id id, obs_hotkey_t* hotkey) {
+		current_search* search = reinterpret_cast<current_search*>(data);
+
+		const char* hk_name = obs_hotkey_get_name(hotkey);
+		if (hk_name == search->query) {
+			search->result = hotkey;
+			return false;
+		}
+
+		return true;
+	}, &search);
+
+	return search.result;
+}
+
+bool Utils::ReplayBufferEnabled() {
+	config_t* profile = obs_frontend_get_profile_config();
+	QString outputMode = config_get_string(profile, "Output", "Mode");
+
+	if (outputMode == "Simple") {
+		return config_get_bool(profile, "SimpleOutput", "RecRB");
+	}
+	else if (outputMode == "Advanced") {
+		return config_get_bool(profile, "AdvOut", "RecRB");
+	}
+
+	return false;
+}
+
+void Utils::StartReplayBuffer() {
+	if (obs_frontend_replay_buffer_active())
+		return;
+
+	if (!IsRPHotkeySet()) {
+		obs_output_t* rpOutput = obs_frontend_get_replay_buffer_output();
+		OBSData outputHotkeys = obs_hotkeys_save_output(rpOutput);
+
+		OBSDataAutoRelease dummyBinding = obs_data_create();
+		obs_data_set_bool(dummyBinding, "control", true);
+		obs_data_set_bool(dummyBinding, "alt", true);
+		obs_data_set_bool(dummyBinding, "shift", true);
+		obs_data_set_bool(dummyBinding, "command", true);
+		obs_data_set_string(dummyBinding, "key", "OBS_KEY_0");
+
+		OBSDataArray rpSaveHotkey = obs_data_get_array(
+			outputHotkeys, "ReplayBuffer.Save");
+		obs_data_array_push_back(rpSaveHotkey, dummyBinding);
+
+		obs_hotkeys_load_output(rpOutput, outputHotkeys);
+		obs_frontend_replay_buffer_start();
+
+		obs_output_release(rpOutput);
+	}
+	else {
+		obs_frontend_replay_buffer_start();
+	}
+}
+
+bool Utils::IsRPHotkeySet() {
+	OBSOutputAutoRelease rpOutput = obs_frontend_get_replay_buffer_output();
+	OBSDataAutoRelease hotkeys = obs_hotkeys_save_output(rpOutput);
+	OBSDataArrayAutoRelease bindings = obs_data_get_array(hotkeys,
+		"ReplayBuffer.Save");
+
+	size_t count = obs_data_array_count(bindings);
+	return (count > 0);
+}
+
+const char* Utils::GetFilenameFormatting() {
+	config_t* profile = obs_frontend_get_profile_config();
+	return config_get_string(profile, "Output", "FilenameFormatting");
+}
+
+bool Utils::SetFilenameFormatting(const char* filenameFormatting) {
+	config_t* profile = obs_frontend_get_profile_config();
+	config_set_string(profile, "Output", "FilenameFormatting", filenameFormatting);
+	config_save(profile);
+	return true;
+}
+
+// Transform properties copy-pasted from WSRequestHandler_SceneItems.cpp because typedefs can't be extended yet
+
+/**
+ * @typedef {Object} `SceneItemTransform`
+ * @property {int} `position.x` The x position of the scene item from the left.
+ * @property {int} `position.y` The y position of the scene item from the top.
+ * @property {int} `position.alignment` The point on the scene item that the item is manipulated from.
+ * @property {double} `rotation` The clockwise rotation of the scene item in degrees around the point of alignment.
+ * @property {double} `scale.x` The x-scale factor of the scene item.
+ * @property {double} `scale.y` The y-scale factor of the scene item.
+ * @property {int} `crop.top` The number of pixels cropped off the top of the scene item before scaling.
+ * @property {int} `crop.right` The number of pixels cropped off the right of the scene item before scaling.
+ * @property {int} `crop.bottom` The number of pixels cropped off the bottom of the scene item before scaling.
+ * @property {int} `crop.left` The number of pixels cropped off the left of the scene item before scaling.
+ * @property {bool} `visible` If the scene item is visible.
+ * @property {bool} `locked` If the scene item is locked in position.
+ * @property {String} `bounds.type` Type of bounding box. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE".
+ * @property {int} `bounds.alignment` Alignment of the bounding box.
+ * @property {double} `bounds.x` Width of the bounding box.
+ * @property {double} `bounds.y` Height of the bounding box.
+ * @property {int} `sourceWidth` Base width (without scaling) of the source
+ * @property {int} `sourceHeight` Base source (without scaling) of the source
+ * @property {double} `width` Scene item width (base source width multiplied by the horizontal scaling factor)
+ * @property {double} `height` Scene item height (base source height multiplied by the vertical scaling factor)
+ * @property {String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)
+ * @property {Array<SceneItemTransform> (optional)} `groupChildren` List of children (if this item is a group) 
+ */
+obs_data_t* Utils::GetSceneItemPropertiesData(obs_sceneitem_t* sceneItem) {
+	if (!sceneItem) {
+		return nullptr;
+	}
+
+	OBSSource source = obs_sceneitem_get_source(sceneItem);
+	uint32_t baseSourceWidth = obs_source_get_width(source);
+	uint32_t baseSourceHeight = obs_source_get_height(source);
+
+	vec2 pos, scale, bounds;
+	obs_sceneitem_crop crop;
+
+	obs_sceneitem_get_pos(sceneItem, &pos);
+	obs_sceneitem_get_scale(sceneItem, &scale);
+	obs_sceneitem_get_crop(sceneItem, &crop);
+	obs_sceneitem_get_bounds(sceneItem, &bounds);
+
+	uint32_t alignment = obs_sceneitem_get_alignment(sceneItem);
+	float rotation = obs_sceneitem_get_rot(sceneItem);
+	bool isVisible = obs_sceneitem_visible(sceneItem);
+	bool isLocked = obs_sceneitem_locked(sceneItem);
+
+	obs_bounds_type boundsType = obs_sceneitem_get_bounds_type(sceneItem);
+	uint32_t boundsAlignment = obs_sceneitem_get_bounds_alignment(sceneItem);
+	QString boundsTypeName = getBoundsNameFromType(boundsType);
+
+	OBSDataAutoRelease posData = obs_data_create();
+	obs_data_set_double(posData, "x", pos.x);
+	obs_data_set_double(posData, "y", pos.y);
+	obs_data_set_int(posData, "alignment", alignment);
+
+	OBSDataAutoRelease scaleData = obs_data_create();
+	obs_data_set_double(scaleData, "x", scale.x);
+	obs_data_set_double(scaleData, "y", scale.y);
+
+	OBSDataAutoRelease cropData = obs_data_create();
+	obs_data_set_int(cropData, "left", crop.left);
+	obs_data_set_int(cropData, "top", crop.top);
+	obs_data_set_int(cropData, "right", crop.right);
+	obs_data_set_int(cropData, "bottom", crop.bottom);
+
+	OBSDataAutoRelease boundsData = obs_data_create();
+	obs_data_set_string(boundsData, "type", boundsTypeName.toUtf8());
+	obs_data_set_int(boundsData, "alignment", boundsAlignment);
+	obs_data_set_double(boundsData, "x", bounds.x);
+	obs_data_set_double(boundsData, "y", bounds.y);
+
+	obs_data_t* data = obs_data_create();
+	obs_data_set_obj(data, "position", posData);
+	obs_data_set_double(data, "rotation", rotation);
+	obs_data_set_obj(data, "scale", scaleData);
+	obs_data_set_obj(data, "crop", cropData);
+	obs_data_set_bool(data, "visible", isVisible);
+	obs_data_set_bool(data, "locked", isLocked);
+	obs_data_set_obj(data, "bounds", boundsData);
+
+	obs_data_set_int(data, "sourceWidth", baseSourceWidth);
+	obs_data_set_int(data, "sourceHeight", baseSourceHeight);
+	obs_data_set_double(data, "width", baseSourceWidth * scale.x);
+	obs_data_set_double(data, "height", baseSourceHeight * scale.y);
+
+	obs_scene_t* parent = obs_sceneitem_get_scene(sceneItem);
+	if (parent) {
+		OBSSource parentSource = obs_scene_get_source(parent);
+		QString parentKind = obs_source_get_id(parentSource);
+		if (parentKind == "group") {
+			obs_data_set_string(data, "parentGroupName", obs_source_get_name(parentSource));
+		}
+	}
+
+	if (obs_sceneitem_is_group(sceneItem)) {
+		OBSDataArrayAutoRelease children = obs_data_array_create();
+		obs_sceneitem_group_enum_items(sceneItem, [](obs_scene_t*, obs_sceneitem_t* subItem, void* param) {
+			obs_data_array_t* items = reinterpret_cast<obs_data_array_t*>(param);
+
+			OBSDataAutoRelease itemData = GetSceneItemPropertiesData(subItem);
+			obs_data_array_push_back(items, itemData);
+
+			return true;
+		}, children);
+		obs_data_set_array(data, "groupChildren", children);
+	}
+
+	return data;
+}
+
+obs_data_t* Utils::GetSourceFilterInfo(obs_source_t* filter, bool includeSettings)
+{
+	obs_data_t* data = obs_data_create();
+	obs_data_set_bool(data, "enabled", obs_source_enabled(filter));
+	obs_data_set_string(data, "type", obs_source_get_id(filter));
+	obs_data_set_string(data, "name", obs_source_get_name(filter));
+	if (includeSettings) {
+		OBSDataAutoRelease settings = obs_source_get_settings(filter);
+		obs_data_set_obj(data, "settings", settings);
+	}
+	return data;
+}
+
+obs_data_array_t* Utils::GetSourceFiltersList(obs_source_t* source, bool includeSettings)
+{
+	struct enum_params {
+		obs_data_array_t* filters;
+		bool includeSettings;
+	};
+
+	if (!source) {
+		return nullptr;
+	}
+
+	struct enum_params enumParams;
+
+	enumParams.filters = obs_data_array_create();
+	enumParams.includeSettings = includeSettings;
+
+	obs_source_enum_filters(source, [](obs_source_t* parent, obs_source_t* child, void* param)
+	{
+		auto enumParams = reinterpret_cast<struct enum_params*>(param);
+
+		OBSDataAutoRelease filterData = Utils::GetSourceFilterInfo(child, enumParams->includeSettings);
+		obs_data_array_push_back(enumParams->filters, filterData);
+	}, &enumParams);
+
+	return enumParams.filters;
+}
+
+void getPauseRecordingFunctions(RecordingPausedFunction* recPausedFuncPtr, PauseRecordingFunction* pauseRecFuncPtr)
+{
+	void* frontendApi = os_dlopen("obs-frontend-api");
+
+	if (recPausedFuncPtr) {
+		*recPausedFuncPtr = (RecordingPausedFunction)os_dlsym(frontendApi, "obs_frontend_recording_paused");
+	}
+
+	if (pauseRecFuncPtr) {
+		*pauseRecFuncPtr = (PauseRecordingFunction)os_dlsym(frontendApi, "obs_frontend_recording_pause");
+	}
+}
+
+QString Utils::nsToTimestamp(uint64_t ns)
+{
+	uint64_t ms = ns / 1000000ULL;
+	uint64_t secs = ms / 1000ULL;
+	uint64_t minutes = secs / 60ULL;
+
+	uint64_t hoursPart = minutes / 60ULL;
+	uint64_t minutesPart = minutes % 60ULL;
+	uint64_t secsPart = secs % 60ULL;
+	uint64_t msPart = ms % 1000ULL;
+
+	return QString::asprintf("%02" PRIu64 ":%02" PRIu64 ":%02" PRIu64 ".%03" PRIu64, hoursPart, minutesPart, secsPart, msPart);
+}

src/Utils.h

@@ -0,0 +1,88 @@
+/*
+obs-websocket
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#pragma once
+
+#include <stdio.h>
+
+#include <QtCore/QString>
+#include <QtWidgets/QSpinBox>
+#include <QtWidgets/QPushButton>
+#include <QtWidgets/QLayout>
+#include <QtWidgets/QListWidget>
+#include <QtWidgets/QSystemTrayIcon>
+
+#include <obs.hpp>
+#include <obs-module.h>
+#include <util/config-file.h>
+
+typedef void(*PauseRecordingFunction)(bool);
+typedef bool(*RecordingPausedFunction)();
+
+namespace Utils {
+	obs_data_array_t* StringListToArray(char** strings, const char* key);
+	obs_data_array_t* GetSceneItems(obs_source_t* source);
+	obs_data_t* GetSceneItemData(obs_sceneitem_t* item);
+
+	// These functions support nested lookup into groups
+	obs_sceneitem_t* GetSceneItemFromName(obs_scene_t* scene, QString name);
+	obs_sceneitem_t* GetSceneItemFromId(obs_scene_t* scene, int64_t id);
+	obs_sceneitem_t* GetSceneItemFromItem(obs_scene_t* scene, obs_data_t* item);
+	obs_sceneitem_t* GetSceneItemFromRequestField(obs_scene_t* scene, obs_data_item_t* dataItem);
+
+	obs_scene_t* GetSceneFromNameOrCurrent(QString sceneName);
+	obs_data_t* GetSceneItemPropertiesData(obs_sceneitem_t* item);
+
+	obs_data_t* GetSourceFilterInfo(obs_source_t* filter, bool includeSettings);
+	obs_data_array_t* GetSourceFiltersList(obs_source_t* source, bool includeSettings);
+
+	bool IsValidAlignment(const uint32_t alignment);
+
+	obs_data_array_t* GetScenes();
+	obs_data_t* GetSceneData(obs_source_t* source);
+
+	// TODO contribute a proper frontend API method for this to OBS and remove this hack
+	QSpinBox* GetTransitionDurationControl();
+	int GetTransitionDuration(obs_source_t* transition);
+	obs_source_t* GetTransitionFromName(QString transitionName);
+	bool SetTransitionByName(QString transitionName);
+	obs_data_t* GetTransitionData(obs_source_t* transition);
+
+	QString OBSVersionString();
+
+	QSystemTrayIcon* GetTrayIcon();
+	void SysTrayNotify(
+		QString text,
+		QSystemTrayIcon::MessageIcon n,
+		QString title = QString("obs-websocket"));
+
+	const char* GetRecordingFolder();
+	bool SetRecordingFolder(const char* path);
+
+	QString ParseDataToQueryString(obs_data_t* data);
+	obs_hotkey_t* FindHotkeyByName(QString name);
+
+	bool ReplayBufferEnabled();
+	void StartReplayBuffer();
+	bool IsRPHotkeySet();
+
+	const char* GetFilenameFormatting();
+	bool SetFilenameFormatting(const char* filenameFormatting);
+
+	QString nsToTimestamp(uint64_t ns);
+};

src/WSEvents.h

@@ -0,0 +1,145 @@
+/*
+obs-websocket
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2017	Brendan Hagan <https://github.com/haganbmj>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#pragma once
+
+#include <obs.hpp>
+#include <obs-frontend-api.h>
+#include <util/platform.h>
+
+#include <QtWidgets/QListWidgetItem>
+#include <QtCore/QSharedPointer>
+#include <QtCore/QTimer>
+
+#include "WSServer.h"
+
+class WSEvents : public QObject
+{
+Q_OBJECT
+
+public:
+	explicit WSEvents(WSServerPtr srv);
+	~WSEvents();
+
+	void connectSourceSignals(obs_source_t* source);
+	void disconnectSourceSignals(obs_source_t* source);
+
+	void connectFilterSignals(obs_source_t* filter);
+	void disconnectFilterSignals(obs_source_t* filter);
+
+	void hookTransitionPlaybackEvents();
+	void unhookTransitionPlaybackEvents();
+
+	uint64_t getStreamingTime();
+	uint64_t getRecordingTime();
+
+	QString getStreamingTimecode();
+	QString getRecordingTimecode();
+	
+	obs_data_t* GetStats();
+
+	void OnBroadcastCustomMessage(QString realm, obs_data_t* data);
+
+	bool HeartbeatIsActive;
+
+private slots:
+	void StreamStatus();
+	void Heartbeat();
+	void TransitionDurationChanged(int ms);
+
+private:
+	WSServerPtr _srv;
+	QTimer streamStatusTimer;
+	QTimer heartbeatTimer;
+	os_cpu_usage_info_t* cpuUsageInfo;
+
+	bool pulse;
+
+	uint64_t _streamStarttime;
+
+	uint64_t _lastBytesSent;
+	uint64_t _lastBytesSentTime;
+
+	void broadcastUpdate(const char* updateType,
+		obs_data_t* additionalFields);
+
+	void OnSceneChange();
+	void OnSceneListChange();
+	void OnSceneCollectionChange();
+	void OnSceneCollectionListChange();
+
+	void OnTransitionChange();
+	void OnTransitionListChange();
+
+	void OnProfileChange();
+	void OnProfileListChange();
+
+	void OnStreamStarting();
+	void OnStreamStarted();
+	void OnStreamStopping();
+	void OnStreamStopped();
+
+	void OnRecordingStarting();
+	void OnRecordingStarted();
+	void OnRecordingStopping();
+	void OnRecordingStopped();
+	void OnRecordingPaused();
+	void OnRecordingResumed();
+
+	void OnReplayStarting();
+	void OnReplayStarted();
+	void OnReplayStopping();
+	void OnReplayStopped();
+
+	void OnStudioModeSwitched(bool enabled);
+	void OnPreviewSceneChanged();
+
+	void OnExit();
+
+	static void FrontendEventHandler(
+		enum obs_frontend_event event, void* privateData);
+
+	static void OnTransitionBegin(void* param, calldata_t* data);
+	static void OnTransitionEnd(void* param, calldata_t* data);
+	static void OnTransitionVideoEnd(void* param, calldata_t* data);
+
+	static void OnSourceCreate(void* param, calldata_t* data);
+	static void OnSourceDestroy(void* param, calldata_t* data);
+
+	static void OnSourceVolumeChange(void* param, calldata_t* data);
+	static void OnSourceMuteStateChange(void* param, calldata_t* data);
+	static void OnSourceAudioSyncOffsetChanged(void* param, calldata_t* data);
+	static void OnSourceAudioMixersChanged(void* param, calldata_t* data);
+
+	static void OnSourceRename(void* param, calldata_t* data);
+
+	static void OnSourceFilterAdded(void* param, calldata_t* data);
+	static void OnSourceFilterRemoved(void* param, calldata_t* data);
+	static void OnSourceFilterVisibilityChanged(void* param, calldata_t* data);
+	static void OnSourceFilterOrderChanged(void* param, calldata_t* data);
+
+	static void OnSceneReordered(void* param, calldata_t* data);
+	static void OnSceneItemAdd(void* param, calldata_t* data);
+	static void OnSceneItemDelete(void* param, calldata_t* data);
+	static void OnSceneItemVisibilityChanged(void* param, calldata_t* data);
+	static void OnSceneItemLockChanged(void* param, calldata_t* data);
+	static void OnSceneItemTransform(void* param, calldata_t* data);
+	static void OnSceneItemSelected(void* param, calldata_t* data);
+	static void OnSceneItemDeselected(void* param, calldata_t* data);
+};

src/WSRequestHandler.cpp

@@ -0,0 +1,181 @@
+/**
+ * obs-websocket
+ * Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+ * Copyright (C) 2017	Mikhail Swift <https://github.com/mikhailswift>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>
+ */
+
+#include <functional>
+
+#include <obs-data.h>
+
+#include "Config.h"
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+using namespace std::placeholders;
+
+const QHash<QString, RpcMethodHandler> WSRequestHandler::messageMap {
+	{ "GetVersion", &WSRequestHandler::GetVersion },
+	{ "GetAuthRequired", &WSRequestHandler::GetAuthRequired },
+	{ "Authenticate", &WSRequestHandler::Authenticate },
+
+	{ "GetStats", &WSRequestHandler::GetStats },
+	{ "SetHeartbeat", &WSRequestHandler::SetHeartbeat },
+	{ "GetVideoInfo", &WSRequestHandler::GetVideoInfo },
+	{ "OpenProjector", &WSRequestHandler::OpenProjector },
+
+	{ "SetFilenameFormatting", &WSRequestHandler::SetFilenameFormatting },
+	{ "GetFilenameFormatting", &WSRequestHandler::GetFilenameFormatting },
+
+	{ "BroadcastCustomMessage", &WSRequestHandler::BroadcastCustomMessage },
+
+	{ "SetCurrentScene", &WSRequestHandler::SetCurrentScene },
+	{ "GetCurrentScene", &WSRequestHandler::GetCurrentScene },
+	{ "GetSceneList", &WSRequestHandler::GetSceneList },
+	{ "SetSceneTransitionOverride", &WSRequestHandler::SetSceneTransitionOverride },
+	{ "RemoveSceneTransitionOverride", &WSRequestHandler::RemoveSceneTransitionOverride },
+	{ "GetSceneTransitionOverride", &WSRequestHandler::GetSceneTransitionOverride },
+
+	{ "SetSourceRender", &WSRequestHandler::SetSceneItemRender }, // Retrocompat
+	{ "SetSceneItemRender", &WSRequestHandler::SetSceneItemRender },
+	{ "SetSceneItemPosition", &WSRequestHandler::SetSceneItemPosition },
+	{ "SetSceneItemTransform", &WSRequestHandler::SetSceneItemTransform },
+	{ "SetSceneItemCrop", &WSRequestHandler::SetSceneItemCrop },
+	{ "GetSceneItemProperties", &WSRequestHandler::GetSceneItemProperties },
+	{ "SetSceneItemProperties", &WSRequestHandler::SetSceneItemProperties },
+	{ "ResetSceneItem", &WSRequestHandler::ResetSceneItem },
+	{ "DeleteSceneItem", &WSRequestHandler::DeleteSceneItem },
+	{ "DuplicateSceneItem", &WSRequestHandler::DuplicateSceneItem },
+	{ "ReorderSceneItems", &WSRequestHandler::ReorderSceneItems },
+
+	{ "GetStreamingStatus", &WSRequestHandler::GetStreamingStatus },
+	{ "StartStopStreaming", &WSRequestHandler::StartStopStreaming },
+	{ "StartStopRecording", &WSRequestHandler::StartStopRecording },
+
+	{ "StartStreaming", &WSRequestHandler::StartStreaming },
+	{ "StopStreaming", &WSRequestHandler::StopStreaming },
+
+	{ "StartRecording", &WSRequestHandler::StartRecording },
+	{ "StopRecording", &WSRequestHandler::StopRecording },
+	{ "PauseRecording", &WSRequestHandler::PauseRecording },
+	{ "ResumeRecording", &WSRequestHandler::ResumeRecording },
+
+	{ "StartStopReplayBuffer", &WSRequestHandler::StartStopReplayBuffer },
+	{ "StartReplayBuffer", &WSRequestHandler::StartReplayBuffer },
+	{ "StopReplayBuffer", &WSRequestHandler::StopReplayBuffer },
+	{ "SaveReplayBuffer", &WSRequestHandler::SaveReplayBuffer },
+
+	{ "SetRecordingFolder", &WSRequestHandler::SetRecordingFolder },
+	{ "GetRecordingFolder", &WSRequestHandler::GetRecordingFolder },
+
+	{ "GetTransitionList", &WSRequestHandler::GetTransitionList },
+	{ "GetCurrentTransition", &WSRequestHandler::GetCurrentTransition },
+	{ "SetCurrentTransition", &WSRequestHandler::SetCurrentTransition },
+	{ "SetTransitionDuration", &WSRequestHandler::SetTransitionDuration },
+	{ "GetTransitionDuration", &WSRequestHandler::GetTransitionDuration },
+	{ "GetTransitionPosition", &WSRequestHandler::GetTransitionPosition },
+
+	{ "SetVolume", &WSRequestHandler::SetVolume },
+	{ "GetVolume", &WSRequestHandler::GetVolume },
+	{ "ToggleMute", &WSRequestHandler::ToggleMute },
+	{ "SetMute", &WSRequestHandler::SetMute },
+	{ "GetMute", &WSRequestHandler::GetMute },
+	{ "SetSourceName", &WSRequestHandler::SetSourceName },
+	{ "SetSyncOffset", &WSRequestHandler::SetSyncOffset },
+	{ "GetSyncOffset", &WSRequestHandler::GetSyncOffset },
+	{ "GetSpecialSources", &WSRequestHandler::GetSpecialSources },
+	{ "GetSourcesList", &WSRequestHandler::GetSourcesList },
+	{ "GetSourceTypesList", &WSRequestHandler::GetSourceTypesList },
+	{ "GetSourceSettings", &WSRequestHandler::GetSourceSettings },
+	{ "SetSourceSettings", &WSRequestHandler::SetSourceSettings },
+	{ "GetAudioMonitorType", &WSRequestHandler::GetAudioMonitorType },
+	{ "SetAudioMonitorType", &WSRequestHandler::SetAudioMonitorType },
+	{ "TakeSourceScreenshot", &WSRequestHandler::TakeSourceScreenshot },
+
+	{ "GetSourceFilters", &WSRequestHandler::GetSourceFilters },
+	{ "GetSourceFilterInfo", &WSRequestHandler::GetSourceFilterInfo },
+	{ "AddFilterToSource", &WSRequestHandler::AddFilterToSource },
+	{ "RemoveFilterFromSource", &WSRequestHandler::RemoveFilterFromSource },
+	{ "ReorderSourceFilter", &WSRequestHandler::ReorderSourceFilter },
+	{ "MoveSourceFilter", &WSRequestHandler::MoveSourceFilter },
+	{ "SetSourceFilterSettings", &WSRequestHandler::SetSourceFilterSettings },
+	{ "SetSourceFilterVisibility", &WSRequestHandler::SetSourceFilterVisibility },
+
+	{ "SetCurrentSceneCollection", &WSRequestHandler::SetCurrentSceneCollection },
+	{ "GetCurrentSceneCollection", &WSRequestHandler::GetCurrentSceneCollection },
+	{ "ListSceneCollections", &WSRequestHandler::ListSceneCollections },
+
+	{ "SetCurrentProfile", &WSRequestHandler::SetCurrentProfile },
+	{ "GetCurrentProfile", &WSRequestHandler::GetCurrentProfile },
+	{ "ListProfiles", &WSRequestHandler::ListProfiles },
+
+	{ "SetStreamSettings", &WSRequestHandler::SetStreamSettings },
+	{ "GetStreamSettings", &WSRequestHandler::GetStreamSettings },
+	{ "SaveStreamSettings", &WSRequestHandler::SaveStreamSettings },
+#if BUILD_CAPTIONS
+	{ "SendCaptions", &WSRequestHandler::SendCaptions },
+#endif
+
+	{ "GetStudioModeStatus", &WSRequestHandler::GetStudioModeStatus },
+	{ "GetPreviewScene", &WSRequestHandler::GetPreviewScene },
+	{ "SetPreviewScene", &WSRequestHandler::SetPreviewScene },
+	{ "TransitionToProgram", &WSRequestHandler::TransitionToProgram },
+	{ "EnableStudioMode", &WSRequestHandler::EnableStudioMode },
+	{ "DisableStudioMode", &WSRequestHandler::DisableStudioMode },
+	{ "ToggleStudioMode", &WSRequestHandler::ToggleStudioMode },
+
+	{ "SetTextGDIPlusProperties", &WSRequestHandler::SetTextGDIPlusProperties },
+	{ "GetTextGDIPlusProperties", &WSRequestHandler::GetTextGDIPlusProperties },
+
+	{ "SetTextFreetype2Properties", &WSRequestHandler::SetTextFreetype2Properties },
+	{ "GetTextFreetype2Properties", &WSRequestHandler::GetTextFreetype2Properties },
+
+	{ "GetBrowserSourceProperties", &WSRequestHandler::GetBrowserSourceProperties },
+	{ "SetBrowserSourceProperties", &WSRequestHandler::SetBrowserSourceProperties },
+
+	{ "ListOutputs", &WSRequestHandler::ListOutputs },
+	{ "GetOutputInfo", &WSRequestHandler::GetOutputInfo },
+	{ "StartOutput", &WSRequestHandler::StartOutput },
+	{ "StopOutput", &WSRequestHandler::StopOutput }
+};
+
+const QSet<QString> WSRequestHandler::authNotRequired {
+	"GetVersion",
+	"GetAuthRequired",
+	"Authenticate"
+};
+
+WSRequestHandler::WSRequestHandler(ConnectionProperties& connProperties) :
+	_connProperties(connProperties)
+{
+}
+
+RpcResponse WSRequestHandler::processRequest(const RpcRequest& request){
+	if (GetConfig()->AuthRequired
+		&& (!authNotRequired.contains(request.methodName()))
+		&& (!_connProperties.isAuthenticated()))
+	{
+		return RpcResponse::fail(request, "Not Authenticated");
+	}
+
+	RpcMethodHandler handlerFunc = messageMap[request.methodName()];
+	if (!handlerFunc) {
+		return RpcResponse::fail(request, "invalid request type");
+	}
+
+	return std::bind(handlerFunc, this, _1)(request);
+}

src/WSRequestHandler.h

@@ -0,0 +1,171 @@
+/*
+obs-websocket
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2017	Mikhail Swift <https://github.com/mikhailswift>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#pragma once
+
+#include <QtCore/QString>
+#include <QtCore/QHash>
+#include <QtCore/QSet>
+
+#include <obs.hpp>
+#include <obs-frontend-api.h>
+
+#include "ConnectionProperties.h"
+
+#include "rpc/RpcRequest.h"
+#include "rpc/RpcResponse.h"
+
+#include "obs-websocket.h"
+
+class WSRequestHandler;
+typedef RpcResponse(WSRequestHandler::*RpcMethodHandler)(const RpcRequest&);
+
+class WSRequestHandler {
+	public:
+		explicit WSRequestHandler(ConnectionProperties& connProperties);
+		RpcResponse processRequest(const RpcRequest& textMessage);
+
+	private:
+		ConnectionProperties& _connProperties;
+
+		static const QHash<QString, RpcMethodHandler> messageMap;
+		static const QSet<QString> authNotRequired;
+
+		RpcResponse GetVersion(const RpcRequest&);
+		RpcResponse GetAuthRequired(const RpcRequest&);
+		RpcResponse Authenticate(const RpcRequest&);
+
+		RpcResponse GetStats(const RpcRequest&);
+		RpcResponse SetHeartbeat(const RpcRequest&);
+		RpcResponse GetVideoInfo(const RpcRequest&);
+		RpcResponse OpenProjector(const RpcRequest&);
+
+		RpcResponse SetFilenameFormatting(const RpcRequest&);
+		RpcResponse GetFilenameFormatting(const RpcRequest&);
+
+		RpcResponse BroadcastCustomMessage(const RpcRequest&);
+
+		RpcResponse SetCurrentScene(const RpcRequest&);
+		RpcResponse GetCurrentScene(const RpcRequest&);
+		RpcResponse GetSceneList(const RpcRequest&);
+		RpcResponse SetSceneTransitionOverride(const RpcRequest&);
+		RpcResponse RemoveSceneTransitionOverride(const RpcRequest&);
+		RpcResponse GetSceneTransitionOverride(const RpcRequest&);
+
+		RpcResponse SetSceneItemRender(const RpcRequest&);
+		RpcResponse SetSceneItemPosition(const RpcRequest&);
+		RpcResponse SetSceneItemTransform(const RpcRequest&);
+		RpcResponse SetSceneItemCrop(const RpcRequest&);
+		RpcResponse GetSceneItemProperties(const RpcRequest&);
+		RpcResponse SetSceneItemProperties(const RpcRequest&);
+		RpcResponse ResetSceneItem(const RpcRequest&);
+		RpcResponse DuplicateSceneItem(const RpcRequest&);
+		RpcResponse DeleteSceneItem(const RpcRequest&);
+		RpcResponse ReorderSceneItems(const RpcRequest&);
+
+		RpcResponse GetStreamingStatus(const RpcRequest&);
+		RpcResponse StartStopStreaming(const RpcRequest&);
+		RpcResponse StartStopRecording(const RpcRequest&);
+
+		RpcResponse StartStreaming(const RpcRequest&);
+		RpcResponse StopStreaming(const RpcRequest&);
+
+		RpcResponse StartRecording(const RpcRequest&);
+		RpcResponse StopRecording(const RpcRequest&);
+		RpcResponse PauseRecording(const RpcRequest&);
+		RpcResponse ResumeRecording(const RpcRequest&);
+
+		RpcResponse StartStopReplayBuffer(const RpcRequest&);
+		RpcResponse StartReplayBuffer(const RpcRequest&);
+		RpcResponse StopReplayBuffer(const RpcRequest&);
+		RpcResponse SaveReplayBuffer(const RpcRequest&);
+
+		RpcResponse SetRecordingFolder(const RpcRequest&);
+		RpcResponse GetRecordingFolder(const RpcRequest&);
+
+		RpcResponse GetTransitionList(const RpcRequest&);
+		RpcResponse GetCurrentTransition(const RpcRequest&);
+		RpcResponse SetCurrentTransition(const RpcRequest&);
+		RpcResponse SetTransitionDuration(const RpcRequest&);
+		RpcResponse GetTransitionDuration(const RpcRequest&);
+		RpcResponse GetTransitionPosition(const RpcRequest&);
+
+		RpcResponse SetVolume(const RpcRequest&);
+		RpcResponse GetVolume(const RpcRequest&);
+		RpcResponse ToggleMute(const RpcRequest&);
+		RpcResponse SetMute(const RpcRequest&);
+		RpcResponse GetMute(const RpcRequest&);
+		RpcResponse SetSourceName(const RpcRequest&);
+		RpcResponse SetSyncOffset(const RpcRequest&);
+		RpcResponse GetSyncOffset(const RpcRequest&);
+		RpcResponse GetSpecialSources(const RpcRequest&);
+		RpcResponse GetSourcesList(const RpcRequest&);
+		RpcResponse GetSourceTypesList(const RpcRequest&);
+		RpcResponse GetSourceSettings(const RpcRequest&);
+		RpcResponse SetSourceSettings(const RpcRequest&);
+		RpcResponse GetAudioMonitorType(const RpcRequest&);
+		RpcResponse SetAudioMonitorType(const RpcRequest&);
+		RpcResponse TakeSourceScreenshot(const RpcRequest&);
+
+		RpcResponse GetSourceFilters(const RpcRequest&);
+		RpcResponse GetSourceFilterInfo(const RpcRequest&);
+		RpcResponse AddFilterToSource(const RpcRequest&);
+		RpcResponse RemoveFilterFromSource(const RpcRequest&);
+		RpcResponse ReorderSourceFilter(const RpcRequest&);
+		RpcResponse MoveSourceFilter(const RpcRequest&);
+		RpcResponse SetSourceFilterSettings(const RpcRequest&);
+		RpcResponse SetSourceFilterVisibility(const RpcRequest&);
+
+		RpcResponse SetCurrentSceneCollection(const RpcRequest&);
+		RpcResponse GetCurrentSceneCollection(const RpcRequest&);
+		RpcResponse ListSceneCollections(const RpcRequest&);
+
+		RpcResponse SetCurrentProfile(const RpcRequest&);
+		RpcResponse GetCurrentProfile(const RpcRequest&);
+		RpcResponse ListProfiles(const RpcRequest&);
+
+		RpcResponse SetStreamSettings(const RpcRequest&);
+		RpcResponse GetStreamSettings(const RpcRequest&);
+		RpcResponse SaveStreamSettings(const RpcRequest&);
+#if BUILD_CAPTIONS
+		RpcResponse SendCaptions(const RpcRequest&);
+#endif
+
+		RpcResponse GetStudioModeStatus(const RpcRequest&);
+		RpcResponse GetPreviewScene(const RpcRequest&);
+		RpcResponse SetPreviewScene(const RpcRequest&);
+		RpcResponse TransitionToProgram(const RpcRequest&);
+		RpcResponse EnableStudioMode(const RpcRequest&);
+		RpcResponse DisableStudioMode(const RpcRequest&);
+		RpcResponse ToggleStudioMode(const RpcRequest&);
+
+		RpcResponse SetTextGDIPlusProperties(const RpcRequest&);
+		RpcResponse GetTextGDIPlusProperties(const RpcRequest&);
+
+		RpcResponse SetTextFreetype2Properties(const RpcRequest&);
+		RpcResponse GetTextFreetype2Properties(const RpcRequest&);
+
+		RpcResponse SetBrowserSourceProperties(const RpcRequest&);
+		RpcResponse GetBrowserSourceProperties(const RpcRequest&);
+
+		RpcResponse ListOutputs(const RpcRequest&);
+		RpcResponse GetOutputInfo(const RpcRequest&);
+		RpcResponse StartOutput(const RpcRequest&);
+		RpcResponse StopOutput(const RpcRequest&);
+};

src/WSRequestHandler_General.cpp

@@ -0,0 +1,346 @@
+#include "WSRequestHandler.h"
+
+#include <QtCore/QByteArray>
+#include <QtGui/QImageWriter>
+
+#include "obs-websocket.h"
+#include "Config.h"
+#include "Utils.h"
+#include "WSEvents.h"
+
+#define CASE(x) case x: return #x;
+const char *describe_output_format(int format) {
+	switch (format) {
+		default:
+		CASE(VIDEO_FORMAT_NONE)
+		CASE(VIDEO_FORMAT_I420)
+		CASE(VIDEO_FORMAT_NV12)
+		CASE(VIDEO_FORMAT_YVYU)
+		CASE(VIDEO_FORMAT_YUY2)
+		CASE(VIDEO_FORMAT_UYVY)
+		CASE(VIDEO_FORMAT_RGBA)
+		CASE(VIDEO_FORMAT_BGRA)
+		CASE(VIDEO_FORMAT_BGRX)
+		CASE(VIDEO_FORMAT_Y800)
+		CASE(VIDEO_FORMAT_I444)
+	}
+}
+
+const char *describe_color_space(int cs) {
+	switch (cs) {
+		default:
+		CASE(VIDEO_CS_DEFAULT)
+		CASE(VIDEO_CS_601)
+		CASE(VIDEO_CS_709)
+	}
+}
+
+const char *describe_color_range(int range) {
+	switch (range) {
+		default:
+		CASE(VIDEO_RANGE_DEFAULT)
+		CASE(VIDEO_RANGE_PARTIAL)
+		CASE(VIDEO_RANGE_FULL)
+	}
+}
+
+const char *describe_scale_type(int scale) {
+	switch (scale) {
+		default:
+		CASE(VIDEO_SCALE_DEFAULT)
+		CASE(VIDEO_SCALE_POINT)
+		CASE(VIDEO_SCALE_FAST_BILINEAR)
+		CASE(VIDEO_SCALE_BILINEAR)
+		CASE(VIDEO_SCALE_BICUBIC)
+	}
+}
+#undef CASE
+
+/**
+ * Returns the latest version of the plugin and the API.
+ *
+ * @return {double} `version` OBSRemote compatible API version. Fixed to 1.1 for retrocompatibility.
+ * @return {String} `obs-websocket-version` obs-websocket plugin version.
+ * @return {String} `obs-studio-version` OBS Studio program version.
+ * @return {String} `available-requests` List of available request types, formatted as a comma-separated list string (e.g. : "Method1,Method2,Method3").
+ * @return {String} `supported-image-export-formats` List of supported formats for features that use image export (like the TakeSourceScreenshot request type) formatted as a comma-separated list string
+ *
+ * @api requests
+ * @name GetVersion
+ * @category general
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::GetVersion(const RpcRequest& request) {
+	QString obsVersion = Utils::OBSVersionString();
+
+	QList<QString> names = messageMap.keys();
+	QList<QByteArray> imageWriterFormats = QImageWriter::supportedImageFormats();
+
+	// (Palakis) OBS' data arrays only support object arrays, so I improvised.
+	QString requests;
+	names.sort(Qt::CaseInsensitive);
+	requests += names.takeFirst();
+	for (const QString& reqName : names) {
+		requests += ("," + reqName);
+	}
+
+	QString supportedImageExportFormats;
+	supportedImageExportFormats += QString::fromUtf8(imageWriterFormats.takeFirst());
+	for (const QByteArray& format : imageWriterFormats) {
+		supportedImageExportFormats += ("," + QString::fromUtf8(format));
+	}
+
+	OBSDataAutoRelease data = obs_data_create();
+	obs_data_set_double(data, "version", 1.1);
+	obs_data_set_string(data, "obs-websocket-version", OBS_WEBSOCKET_VERSION);
+	obs_data_set_string(data, "obs-studio-version", obsVersion.toUtf8());
+	obs_data_set_string(data, "available-requests", requests.toUtf8());
+	obs_data_set_string(data, "supported-image-export-formats", supportedImageExportFormats.toUtf8());
+
+	return request.success(data);
+}
+
+/**
+ * Tells the client if authentication is required. If so, returns authentication parameters `challenge`
+ * and `salt` (see "Authentication" for more information).
+ *
+ * @return {boolean} `authRequired` Indicates whether authentication is required.
+ * @return {String (optional)} `challenge`
+ * @return {String (optional)} `salt`
+ *
+ * @api requests
+ * @name GetAuthRequired
+ * @category general
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::GetAuthRequired(const RpcRequest& request) {
+	bool authRequired = GetConfig()->AuthRequired;
+
+	OBSDataAutoRelease data = obs_data_create();
+	obs_data_set_bool(data, "authRequired", authRequired);
+
+	if (authRequired) {
+		auto config = GetConfig();
+		obs_data_set_string(data, "challenge",
+			config->SessionChallenge.toUtf8());
+		obs_data_set_string(data, "salt",
+			config->Salt.toUtf8());
+	}
+
+	return request.success(data);
+}
+
+/**
+ * Attempt to authenticate the client to the server.
+ *
+ * @param {String} `auth` Response to the auth challenge (see "Authentication" for more information).
+ *
+ * @api requests
+ * @name Authenticate
+ * @category general
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::Authenticate(const RpcRequest& request) {
+	if (!request.hasField("auth")) {
+		return request.failed("missing request parameters");
+	}
+
+	if (_connProperties.isAuthenticated()) {
+		return request.failed("already authenticated");
+	}
+
+	QString auth = obs_data_get_string(request.parameters(), "auth");
+	if (auth.isEmpty()) {
+		return request.failed("auth not specified!");
+	}
+
+	if (GetConfig()->CheckAuth(auth) == false) {
+		return request.failed("Authentication Failed.");
+	}
+
+	_connProperties.setAuthenticated(true);
+	return request.success();
+}
+
+/**
+ * Enable/disable sending of the Heartbeat event
+ *
+ * @param {boolean} `enable` Starts/Stops emitting heartbeat messages
+ *
+ * @api requests
+ * @name SetHeartbeat
+ * @category general
+ * @since 4.3.0
+ */
+RpcResponse WSRequestHandler::SetHeartbeat(const RpcRequest& request) {
+	if (!request.hasField("enable")) {
+		return request.failed("Heartbeat <enable> parameter missing");
+	}
+
+	auto events = GetEventsSystem();
+	events->HeartbeatIsActive = obs_data_get_bool(request.parameters(), "enable");
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_bool(response, "enable", events->HeartbeatIsActive);
+
+	return request.success(response);
+}
+
+/**
+ * Set the filename formatting string
+ *
+ * @param {String} `filename-formatting` Filename formatting string to set.
+ *
+ * @api requests
+ * @name SetFilenameFormatting
+ * @category general
+ * @since 4.3.0
+ */
+RpcResponse WSRequestHandler::SetFilenameFormatting(const RpcRequest& request) {
+	if (!request.hasField("filename-formatting")) {
+		return request.failed("<filename-formatting> parameter missing");
+	}
+
+	QString filenameFormatting = obs_data_get_string(request.parameters(), "filename-formatting");
+	if (filenameFormatting.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	Utils::SetFilenameFormatting(filenameFormatting.toUtf8());
+
+	return request.success();
+}
+
+/**
+ * Get the filename formatting string
+ *
+ * @return {String} `filename-formatting` Current filename formatting string.
+ *
+ * @api requests
+ * @name GetFilenameFormatting
+ * @category general
+ * @since 4.3.0
+ */
+RpcResponse WSRequestHandler::GetFilenameFormatting(const RpcRequest& request) {
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "filename-formatting", Utils::GetFilenameFormatting());
+
+	return request.success(response);
+}
+
+/**
+ * Get OBS stats (almost the same info as provided in OBS' stats window)
+ *
+ * @return {OBSStats} `stats` OBS stats
+ *
+ * @api requests
+ * @name GetStats
+ * @category general
+ * @since 4.6.0
+ */
+RpcResponse WSRequestHandler::GetStats(const RpcRequest& request) {
+	OBSDataAutoRelease stats = GetEventsSystem()->GetStats();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_obj(response, "stats", stats);
+
+	return request.success(response);
+}
+
+/**
+ * Broadcast custom message to all connected WebSocket clients
+ *
+ * @param {String} `realm` Identifier to be choosen by the client
+ * @param {Object} `data` User-defined data
+ *
+ * @api requests
+ * @name BroadcastCustomMessage
+ * @category general
+ * @since 4.7.0
+ */
+RpcResponse WSRequestHandler::BroadcastCustomMessage(const RpcRequest& request) {
+	if (!request.hasField("realm") || !request.hasField("data")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString realm = obs_data_get_string(request.parameters(), "realm");
+	OBSDataAutoRelease data = obs_data_get_obj(request.parameters(), "data");
+
+	if (realm.isEmpty()) {
+		return request.failed("realm not specified!");
+	}
+
+	if (!data) {
+		return request.failed("data not specified!");
+	}
+
+	auto events = GetEventsSystem();
+	events->OnBroadcastCustomMessage(realm, data);
+
+	return request.success();
+}
+
+
+/**
+ * Get basic OBS video information
+ * 
+ * @return {int} `baseWidth` Base (canvas) width
+ * @return {int} `baseHeight` Base (canvas) height
+ * @return {int} `outputWidth` Output width
+ * @return {int} `outputHeight` Output height
+ * @return {String} `scaleType` Scaling method used if output size differs from base size
+ * @return {double} `fps` Frames rendered per second
+ * @return {String} `videoFormat` Video color format
+ * @return {String} `colorSpace` Color space for YUV
+ * @return {String} `colorRange` Color range (full or partial)
+ * 
+ * @api requests
+ * @name GetVideoInfo
+ * @category general
+ * @since 4.6.0 
+ */
+RpcResponse WSRequestHandler::GetVideoInfo(const RpcRequest& request) {
+	obs_video_info ovi;
+	obs_get_video_info(&ovi);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_int(response, "baseWidth", ovi.base_width);
+	obs_data_set_int(response, "baseHeight", ovi.base_height);
+	obs_data_set_int(response, "outputWidth", ovi.output_width);
+	obs_data_set_int(response, "outputHeight", ovi.output_height);
+	obs_data_set_double(response, "fps", (double)ovi.fps_num / ovi.fps_den);
+	obs_data_set_string(response, "videoFormat", describe_output_format(ovi.output_format));
+	obs_data_set_string(response, "colorSpace", describe_color_space(ovi.colorspace));
+	obs_data_set_string(response, "colorRange", describe_color_range(ovi.range));
+	obs_data_set_string(response, "scaleType", describe_scale_type(ovi.scale_type));
+
+	return request.success(response);
+}
+
+/**
+ * Open a projector window or create a projector on a monitor. Requires OBS v24.0.4 or newer.
+ * 
+ * @param {String (Optional)} `type` Type of projector: Preview (default), Source, Scene, StudioProgram, or Multiview (case insensitive).
+ * @param {int (Optional)} `monitor` Monitor to open the projector on. If -1 or omitted, opens a window.
+ * @param {String (Optional)} `geometry` Size and position of the projector window (only if monitor is -1). Encoded in Base64 using Qt's geometry encoding (https://doc.qt.io/qt-5/qwidget.html#saveGeometry). Corresponds to OBS's saved projectors.
+ * @param {String (Optional)} `name` Name of the source or scene to be displayed (ignored for other projector types).
+ * 
+ * @api requests
+ * @name OpenProjector
+ * @category general
+ * @since 4.8.0
+ */
+RpcResponse WSRequestHandler::OpenProjector(const RpcRequest& request) {
+	const char* type = obs_data_get_string(request.parameters(), "type");
+
+	int monitor = -1;
+	if (request.hasField("monitor")) {
+		monitor = obs_data_get_int(request.parameters(), "monitor");
+	}
+
+	const char* geometry = obs_data_get_string(request.parameters(), "geometry");
+	const char* name = obs_data_get_string(request.parameters(), "name");
+
+	obs_frontend_open_projector(type, monitor, geometry, name);
+	return request.success();
+}

src/WSRequestHandler_Outputs.cpp

@@ -0,0 +1,184 @@
+#include <functional>
+
+#include "WSRequestHandler.h"
+
+/**
+* @typedef {Object} `Output`
+* @property {String} `name` Output name
+* @property {String} `type` Output type/kind
+* @property {int} `width` Video output width
+* @property {int} `height` Video output height
+* @property {Object} `flags` Output flags
+* @property {int} `flags.rawValue` Raw flags value
+* @property {boolean} `flags.audio` Output uses audio
+* @property {boolean} `flags.video` Output uses video
+* @property {boolean} `flags.encoded` Output is encoded
+* @property {boolean} `flags.multiTrack` Output uses several audio tracks
+* @property {boolean} `flags.service` Output uses a service
+* @property {Object} `settings` Output name
+* @property {boolean} `active` Output status (active or not)
+* @property {boolean} `reconnecting` Output reconnection status (reconnecting or not)
+* @property {double} `congestion` Output congestion
+* @property {int} `totalFrames` Number of frames sent
+* @property {int} `droppedFrames` Number of frames dropped
+* @property {int} `totalBytes` Total bytes sent
+*/
+obs_data_t* getOutputInfo(obs_output_t* output)
+{
+	if (!output) {
+		return nullptr;
+	}
+
+	OBSDataAutoRelease settings = obs_output_get_settings(output);
+
+	uint32_t rawFlags = obs_output_get_flags(output);
+	OBSDataAutoRelease flags = obs_data_create();
+	obs_data_set_int(flags, "rawValue", rawFlags);
+	obs_data_set_bool(flags, "audio", rawFlags & OBS_OUTPUT_AUDIO);
+	obs_data_set_bool(flags, "video", rawFlags & OBS_OUTPUT_VIDEO);
+	obs_data_set_bool(flags, "encoded", rawFlags & OBS_OUTPUT_ENCODED);
+	obs_data_set_bool(flags, "multiTrack", rawFlags & OBS_OUTPUT_MULTI_TRACK);
+	obs_data_set_bool(flags, "service",  rawFlags & OBS_OUTPUT_SERVICE);
+
+	obs_data_t* data = obs_data_create();
+
+	obs_data_set_string(data, "name", obs_output_get_name(output));
+	obs_data_set_string(data, "type", obs_output_get_id(output));
+	obs_data_set_int(data, "width", obs_output_get_width(output));
+	obs_data_set_int(data, "height", obs_output_get_height(output));
+	obs_data_set_obj(data, "flags", flags);
+	obs_data_set_obj(data, "settings", settings);
+
+	obs_data_set_bool(data, "active", obs_output_active(output));
+	obs_data_set_bool(data, "reconnecting", obs_output_reconnecting(output));
+	obs_data_set_double(data, "congestion", obs_output_get_congestion(output));
+	obs_data_set_int(data, "totalFrames", obs_output_get_total_frames(output));
+	obs_data_set_int(data, "droppedFrames", obs_output_get_frames_dropped(output));
+	obs_data_set_int(data, "totalBytes", obs_output_get_total_bytes(output));
+
+	return data;
+}
+
+RpcResponse findOutputOrFail(const RpcRequest& request, std::function<RpcResponse (obs_output_t*)> callback)
+{
+	if (!request.hasField("outputName")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* outputName = obs_data_get_string(request.parameters(), "outputName");
+	OBSOutputAutoRelease output = obs_get_output_by_name(outputName);
+	if (!output) {
+		return request.failed("specified output doesn't exist");
+	}
+
+	return callback(output);	
+}
+
+/**
+* List existing outputs
+*
+* @return {Array<Output>} `outputs` Outputs list
+*
+* @api requests
+* @name ListOutputs
+* @category outputs
+* @since 4.7.0
+*/
+RpcResponse WSRequestHandler::ListOutputs(const RpcRequest& request)
+{
+	OBSDataArrayAutoRelease outputs = obs_data_array_create();
+
+	obs_enum_outputs([](void* param, obs_output_t* output) {
+		obs_data_array_t* outputs = reinterpret_cast<obs_data_array_t*>(param);
+
+		OBSDataAutoRelease outputInfo = getOutputInfo(output);
+		obs_data_array_push_back(outputs, outputInfo);
+
+		return true;
+	}, outputs);
+
+	OBSDataAutoRelease fields = obs_data_create();
+	obs_data_set_array(fields, "outputs", outputs);
+
+	return request.success(fields);
+}
+
+/**
+* Get information about a single output
+*
+* @param {String} `outputName` Output name
+*
+* @return {Output} `outputInfo` Output info
+*
+* @api requests
+* @name GetOutputInfo
+* @category outputs
+* @since 4.7.0
+*/
+RpcResponse WSRequestHandler::GetOutputInfo(const RpcRequest& request)
+{
+	return findOutputOrFail(request, [request](obs_output_t* output) {
+		OBSDataAutoRelease outputInfo = getOutputInfo(output);
+
+		OBSDataAutoRelease fields = obs_data_create();
+		obs_data_set_obj(fields, "outputInfo", outputInfo);
+		return request.success(fields);
+	});
+}
+
+/**
+* Start an output
+*
+* @param {String} `outputName` Output name
+*
+* @api requests
+* @name StartOutput
+* @category outputs
+* @since 4.7.0
+*/
+RpcResponse WSRequestHandler::StartOutput(const RpcRequest& request)
+{
+	return findOutputOrFail(request, [request](obs_output_t* output) {
+		if (obs_output_active(output)) {
+			return request.failed("output already active");
+		}
+
+		bool success = obs_output_start(output);
+		if (!success) {
+			QString lastError = obs_output_get_last_error(output);
+			QString errorMessage = QString("output start failed: %1").arg(lastError);
+			return request.failed(errorMessage);
+		}
+
+		return request.success();
+	});
+}
+
+/**
+* Stop an output
+*
+* @param {String} `outputName` Output name
+* @param {boolean (optional)} `force` Force stop (default: false)
+*
+* @api requests
+* @name StopOutput
+* @category outputs
+* @since 4.7.0
+*/
+RpcResponse WSRequestHandler::StopOutput(const RpcRequest& request)
+{
+	return findOutputOrFail(request, [request](obs_output_t* output) {
+		if (!obs_output_active(output)) {
+			return request.failed("output not active");
+		}
+		
+		bool forceStop = obs_data_get_bool(request.parameters(), "force");
+		if (forceStop) {
+			obs_output_force_stop(output);
+		} else {
+			obs_output_stop(output);
+		}
+
+		return request.success();
+	});
+}

src/WSRequestHandler_Profiles.cpp

@@ -0,0 +1,67 @@
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+/**
+ * Set the currently active profile.
+ * 
+ * @param {String} `profile-name` Name of the desired profile.
+ *
+ * @api requests
+ * @name SetCurrentProfile
+ * @category profiles
+ * @since 4.0.0
+ */
+RpcResponse WSRequestHandler::SetCurrentProfile(const RpcRequest& request) {
+	if (!request.hasField("profile-name")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString profileName = obs_data_get_string(request.parameters(), "profile-name");
+	if (profileName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	// TODO : check if profile exists
+	obs_frontend_set_current_profile(profileName.toUtf8());
+	return request.success();
+}
+
+ /**
+ * Get the name of the current profile.
+ * 
+ * @return {String} `profile-name` Name of the currently active profile.
+ *
+ * @api requests
+ * @name GetCurrentProfile
+ * @category profiles
+ * @since 4.0.0
+ */
+RpcResponse WSRequestHandler::GetCurrentProfile(const RpcRequest& request) {
+	OBSDataAutoRelease response = obs_data_create();
+	char* currentProfile = obs_frontend_get_current_profile();
+	obs_data_set_string(response, "profile-name", currentProfile);
+	bfree(currentProfile);
+	return request.success(response);
+}
+
+/**
+ * Get a list of available profiles.
+ *
+ * @return {Array<Object>} `profiles` List of available profiles.
+ *
+ * @api requests
+ * @name ListProfiles
+ * @category profiles
+ * @since 4.0.0
+ */
+RpcResponse WSRequestHandler::ListProfiles(const RpcRequest& request) {
+	char** profiles = obs_frontend_get_profiles();
+	OBSDataArrayAutoRelease list = Utils::StringListToArray(profiles, "profile-name");
+	bfree(profiles);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_array(response, "profiles", list);
+
+	return request.success(response);
+}

src/WSRequestHandler_Recording.cpp

@@ -0,0 +1,151 @@
+#include "WSRequestHandler.h"
+
+#include <functional>
+#include <util/platform.h>
+#include "Utils.h"
+
+RpcResponse ifCanPause(const RpcRequest& request, std::function<RpcResponse()> callback)
+{
+	if (!obs_frontend_recording_active()) {
+		return request.failed("recording is not active");
+	}
+
+	return callback();
+}
+
+/**
+ * Toggle recording on or off.
+ *
+ * @api requests
+ * @name StartStopRecording
+ * @category recording
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::StartStopRecording(const RpcRequest& request) {
+	(obs_frontend_recording_active() ? obs_frontend_recording_stop() : obs_frontend_recording_start());
+	return request.success();
+}
+
+/**
+ * Start recording.
+ * Will return an `error` if recording is already active.
+ *
+ * @api requests
+ * @name StartRecording
+ * @category recording
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::StartRecording(const RpcRequest& request) {
+	if (obs_frontend_recording_active()) {
+		return request.failed("recording already active");
+	}
+
+	obs_frontend_recording_start();
+	return request.success();
+}
+
+/**
+ * Stop recording.
+ * Will return an `error` if recording is not active.
+ *
+ * @api requests
+ * @name StopRecording
+ * @category recording
+ * @since 4.1.0
+ */
+ RpcResponse WSRequestHandler::StopRecording(const RpcRequest& request) {
+	if (!obs_frontend_recording_active()) {
+		return request.failed("recording not active");
+	}
+
+	obs_frontend_recording_stop();
+	return request.success();
+}
+
+/**
+* Pause the current recording.
+* Returns an error if recording is not active or already paused.
+*
+* @api requests
+* @name PauseRecording
+* @category recording
+* @since 4.7.0
+*/
+RpcResponse WSRequestHandler::PauseRecording(const RpcRequest& request) {
+	return ifCanPause(request, [request]() {
+		if (obs_frontend_recording_paused()) {
+			return request.failed("recording already paused");
+		}
+
+		obs_frontend_recording_pause(true);
+		return request.success();
+	});
+}
+
+/**
+* Resume/unpause the current recording (if paused).
+* Returns an error if recording is not active or not paused.
+*
+* @api requests
+* @name ResumeRecording
+* @category recording
+* @since 4.7.0
+*/
+RpcResponse WSRequestHandler::ResumeRecording(const RpcRequest& request) {
+	return ifCanPause(request, [request]() {
+		if (!obs_frontend_recording_paused()) {
+			return request.failed("recording is not paused");
+		}
+
+		obs_frontend_recording_pause(false);
+		return request.success();
+	});
+}
+
+/**
+ * In the current profile, sets the recording folder of the Simple and Advanced
+ * output modes to the specified value.
+ * 
+ * Please note: if `SetRecordingFolder` is called while a recording is
+ * in progress, the change won't be applied immediately and will be
+ * effective on the next recording.
+ * 
+ * @param {String} `rec-folder` Path of the recording folder.
+ *
+ * @api requests
+ * @name SetRecordingFolder
+ * @category recording
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::SetRecordingFolder(const RpcRequest& request) {
+	if (!request.hasField("rec-folder")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* newRecFolder = obs_data_get_string(request.parameters(), "rec-folder");
+	bool success = Utils::SetRecordingFolder(newRecFolder);
+	if (!success) {
+		return request.failed("invalid request parameters");
+	}
+
+	return request.success();
+}
+
+/**
+ * Get the path of  the current recording folder.
+ *
+ * @return {String} `rec-folder` Path of the recording folder.
+ *
+ * @api requests
+ * @name GetRecordingFolder
+ * @category recording
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::GetRecordingFolder(const RpcRequest& request) {
+	const char* recFolder = Utils::GetRecordingFolder();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "rec-folder", recFolder);
+
+	return request.success(response);
+}

src/WSRequestHandler_ReplayBuffer.cpp

@@ -0,0 +1,88 @@
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+/**
+* Toggle the Replay Buffer on/off.
+*
+* @api requests
+* @name StartStopReplayBuffer
+* @category replay buffer
+* @since 4.2.0
+*/
+RpcResponse WSRequestHandler::StartStopReplayBuffer(const RpcRequest& request) {
+	if (obs_frontend_replay_buffer_active()) {
+		obs_frontend_replay_buffer_stop();
+	} else {
+		Utils::StartReplayBuffer();
+	}
+	return request.success();
+}
+
+/**
+* Start recording into the Replay Buffer.
+* Will return an `error` if the Replay Buffer is already active or if the
+* "Save Replay Buffer" hotkey is not set in OBS' settings.
+* Setting this hotkey is mandatory, even when triggering saves only
+* through obs-websocket.
+*
+* @api requests
+* @name StartReplayBuffer
+* @category replay buffer
+* @since 4.2.0
+*/
+RpcResponse WSRequestHandler::StartReplayBuffer(const RpcRequest& request) {
+	if (!Utils::ReplayBufferEnabled()) {
+		return request.failed("replay buffer disabled in settings");
+	}
+
+	if (obs_frontend_replay_buffer_active() == true) {
+		return request.failed("replay buffer already active");
+	}
+
+	Utils::StartReplayBuffer();
+	return request.success();
+}
+
+/**
+* Stop recording into the Replay Buffer.
+* Will return an `error` if the Replay Buffer is not active.
+*
+* @api requests
+* @name StopReplayBuffer
+* @category replay buffer
+* @since 4.2.0
+*/
+RpcResponse WSRequestHandler::StopReplayBuffer(const RpcRequest& request) {
+	if (obs_frontend_replay_buffer_active() == true) {
+		obs_frontend_replay_buffer_stop();
+		return request.success();
+	} else {
+		return request.failed("replay buffer not active");
+	}
+}
+
+/**
+* Flush and save the contents of the Replay Buffer to disk. This is
+* basically the same as triggering the "Save Replay Buffer" hotkey.
+* Will return an `error` if the Replay Buffer is not active.
+*
+* @api requests
+* @name SaveReplayBuffer
+* @category replay buffer
+* @since 4.2.0
+*/
+RpcResponse WSRequestHandler::SaveReplayBuffer(const RpcRequest& request) {
+	if (!obs_frontend_replay_buffer_active()) {
+		return request.failed("replay buffer not active");
+	}
+
+	OBSOutputAutoRelease replayOutput = obs_frontend_get_replay_buffer_output();
+
+	calldata_t cd = { 0 };
+	proc_handler_t* ph = obs_output_get_proc_handler(replayOutput);
+	proc_handler_call(ph, "save", &cd);
+	calldata_free(&cd);
+
+	return request.success();
+}

src/WSRequestHandler_SceneCollections.cpp

@@ -0,0 +1,70 @@
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+/**
+ * Change the active scene collection.
+ *
+ * @param {String} `sc-name` Name of the desired scene collection.
+ *
+ * @api requests
+ * @name SetCurrentSceneCollection
+ * @category scene collections
+ * @since 4.0.0
+ */
+RpcResponse WSRequestHandler::SetCurrentSceneCollection(const RpcRequest& request) {
+	if (!request.hasField("sc-name")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sceneCollection = obs_data_get_string(request.parameters(), "sc-name");
+	if (sceneCollection.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	// TODO : Check if specified profile exists and if changing is allowed
+	obs_frontend_set_current_scene_collection(sceneCollection.toUtf8());
+	return request.success();
+}
+
+/**
+ * Get the name of the current scene collection.
+ *
+ * @return {String} `sc-name` Name of the currently active scene collection.
+ *
+ * @api requests
+ * @name GetCurrentSceneCollection
+ * @category scene collections
+ * @since 4.0.0
+ */
+RpcResponse WSRequestHandler::GetCurrentSceneCollection(const RpcRequest& request) {
+	OBSDataAutoRelease response = obs_data_create();
+
+	char* sceneCollection = obs_frontend_get_current_scene_collection();
+	obs_data_set_string(response, "sc-name", sceneCollection);
+	bfree(sceneCollection);
+
+	return request.success(response);
+}
+
+/**
+ * List available scene collections
+ *
+ * @return {Array<String>} `scene-collections` Scene collections list
+ *
+ * @api requests
+ * @name ListSceneCollections
+ * @category scene collections
+ * @since 4.0.0
+ */
+RpcResponse WSRequestHandler::ListSceneCollections(const RpcRequest& request) {
+	char** sceneCollections = obs_frontend_get_scene_collections();
+	OBSDataArrayAutoRelease list =
+		Utils::StringListToArray(sceneCollections, "sc-name");
+	bfree(sceneCollections);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_array(response, "scene-collections", list);
+
+	return request.success(response);
+}

src/WSRequestHandler_SceneItems.cpp

@@ -0,0 +1,621 @@
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+/**
+* Gets the scene specific properties of the specified source item.
+* Coordinates are relative to the item's parent (the scene or group it belongs to).
+*
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String | Object} `item` Scene Item name (if this field is a string) or specification (if it is an object).
+* @param {String (optional)} `item.name` Scene Item name (if the `item` field is an object)
+* @param {int (optional)} `item.id` Scene Item ID (if the `item` field is an object)
+*
+* @return {String} `name` Scene Item name.
+* @return {int} `itemId` Scene Item ID.
+* @return {int} `position.x` The x position of the source from the left.
+* @return {int} `position.y` The y position of the source from the top.
+* @return {int} `position.alignment` The point on the source that the item is manipulated from.
+* @return {double} `rotation` The clockwise rotation of the item in degrees around the point of alignment.
+* @return {double} `scale.x` The x-scale factor of the source.
+* @return {double} `scale.y` The y-scale factor of the source.
+* @return {int} `crop.top` The number of pixels cropped off the top of the source before scaling.
+* @return {int} `crop.right` The number of pixels cropped off the right of the source before scaling.
+* @return {int} `crop.bottom` The number of pixels cropped off the bottom of the source before scaling.
+* @return {int} `crop.left` The number of pixels cropped off the left of the source before scaling.
+* @return {bool} `visible` If the source is visible.
+* @return {bool} `muted` If the source is muted.
+* @return {bool} `locked` If the source's transform is locked.
+* @return {String} `bounds.type` Type of bounding box. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE".
+* @return {int} `bounds.alignment` Alignment of the bounding box.
+* @return {double} `bounds.x` Width of the bounding box.
+* @return {double} `bounds.y` Height of the bounding box.
+* @return {int} `sourceWidth` Base width (without scaling) of the source
+* @return {int} `sourceHeight` Base source (without scaling) of the source
+* @return {double} `width` Scene item width (base source width multiplied by the horizontal scaling factor)
+* @return {double} `height` Scene item height (base source height multiplied by the vertical scaling factor)
+* @return {int} `alignment` The point on the source that the item is manipulated from. The sum of 1=Left or 2=Right, and 4=Top or 8=Bottom, or omit to center on that axis.
+* @return {String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)
+* @return {Array<SceneItemTransform> (optional)} `groupChildren` List of children (if this item is a group)
+* 
+* @api requests
+* @name GetSceneItemProperties
+* @category scene items
+* @since 4.3.0
+*/
+RpcResponse WSRequestHandler::GetSceneItemProperties(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
+	}
+
+	OBSData params = request.parameters();
+
+	QString sceneName = obs_data_get_string(params, "scene-name");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene doesn't exist");
+	}
+
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(params, "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
+	if (!sceneItem) {
+		return request.failed("specified scene item doesn't exist");
+	}
+
+	OBSDataAutoRelease data = Utils::GetSceneItemPropertiesData(sceneItem);
+
+	OBSSource sceneItemSource = obs_sceneitem_get_source(sceneItem);
+	obs_data_set_string(data, "name", obs_source_get_name(sceneItemSource));
+	obs_data_set_int(data, "itemId", obs_sceneitem_get_id(sceneItem));
+
+	return request.success(data);
+}
+
+/**
+* Sets the scene specific properties of a source. Unspecified properties will remain unchanged.
+* Coordinates are relative to the item's parent (the scene or group it belongs to).
+*
+* @param {String (optional)} `scene-name` Name of the scene the source item belongs to. Defaults to the current scene.
+* @param {String | Object} `item` Scene Item name (if this field is a string) or specification (if it is an object).
+* @param {String (optional)} `item.name` Scene Item name (if the `item` field is an object)
+* @param {int (optional)} `item.id` Scene Item ID (if the `item` field is an object)
+* @param {int (optional)} `position.x` The new x position of the source.
+* @param {int (optional)} `position.y` The new y position of the source.
+* @param {int (optional)} `position.alignment` The new alignment of the source.
+* @param {double (optional)} `rotation` The new clockwise rotation of the item in degrees.
+* @param {double (optional)} `scale.x` The new x scale of the item.
+* @param {double (optional)} `scale.y` The new y scale of the item.
+* @param {int (optional)} `crop.top` The new amount of pixels cropped off the top of the source before scaling.
+* @param {int (optional)} `crop.bottom` The new amount of pixels cropped off the bottom of the source before scaling.
+* @param {int (optional)} `crop.left` The new amount of pixels cropped off the left of the source before scaling.
+* @param {int (optional)} `crop.right` The new amount of pixels cropped off the right of the source before scaling.
+* @param {bool (optional)} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.
+* @param {bool (optional)} `locked` The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement.
+* @param {String (optional)} `bounds.type` The new bounds type of the source. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE".
+* @param {int (optional)} `bounds.alignment` The new alignment of the bounding box. (0-2, 4-6, 8-10)
+* @param {double (optional)} `bounds.x` The new width of the bounding box.
+* @param {double (optional)} `bounds.y` The new height of the bounding box.
+*
+* @api requests
+* @name SetSceneItemProperties
+* @category scene items
+* @since 4.3.0
+*/
+RpcResponse WSRequestHandler::SetSceneItemProperties(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
+	}
+
+	OBSData params = request.parameters();
+
+	QString sceneName = obs_data_get_string(params, "scene-name");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene doesn't exist");
+	}
+
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(params, "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
+	if (!sceneItem) {
+		return request.failed("specified scene item doesn't exist");
+	}
+
+	bool badRequest = false;
+	OBSDataAutoRelease errorData = obs_data_create();
+
+	obs_sceneitem_defer_update_begin(sceneItem);
+
+	if (request.hasField("position")) {
+		vec2 oldPosition;
+		OBSDataAutoRelease positionError = obs_data_create();
+		obs_sceneitem_get_pos(sceneItem, &oldPosition);
+
+		OBSDataAutoRelease reqPosition = obs_data_get_obj(params, "position");
+		vec2 newPosition = oldPosition;
+
+		if (obs_data_has_user_value(reqPosition, "x")) {
+			newPosition.x = obs_data_get_int(reqPosition, "x");
+		}
+		if (obs_data_has_user_value(reqPosition, "y")) {
+			newPosition.y = obs_data_get_int(reqPosition, "y");
+		}
+
+		if (obs_data_has_user_value(reqPosition, "alignment")) {
+			const uint32_t alignment = obs_data_get_int(reqPosition, "alignment");
+			if (Utils::IsValidAlignment(alignment)) {
+				obs_sceneitem_set_alignment(sceneItem, alignment);
+			} else {
+				badRequest = true;
+				obs_data_set_string(positionError, "alignment", "invalid");
+				obs_data_set_obj(errorData, "position", positionError);
+			}
+		}
+
+		obs_sceneitem_set_pos(sceneItem, &newPosition);
+	}
+
+	if (request.hasField("rotation")) {
+		obs_sceneitem_set_rot(sceneItem, (float)obs_data_get_double(params, "rotation"));
+	}
+
+	if (request.hasField("scale")) {
+		vec2 oldScale;
+		obs_sceneitem_get_scale(sceneItem, &oldScale);
+		vec2 newScale = oldScale;
+
+		OBSDataAutoRelease reqScale = obs_data_get_obj(params, "scale");
+		
+		if (obs_data_has_user_value(reqScale, "x")) {
+			newScale.x = obs_data_get_double(reqScale, "x");
+		}
+		if (obs_data_has_user_value(reqScale, "y")) {
+			newScale.y = obs_data_get_double(reqScale, "y");
+		}
+
+		obs_sceneitem_set_scale(sceneItem, &newScale);
+	}
+
+	if (request.hasField("crop")) {
+		obs_sceneitem_crop oldCrop;
+		obs_sceneitem_get_crop(sceneItem, &oldCrop);
+
+		OBSDataAutoRelease reqCrop = obs_data_get_obj(params, "crop");
+		obs_sceneitem_crop newCrop = oldCrop;
+
+		if (obs_data_has_user_value(reqCrop, "top")) {
+			newCrop.top = obs_data_get_int(reqCrop, "top");
+		}
+		if (obs_data_has_user_value(reqCrop, "right")) {
+			newCrop.right = obs_data_get_int(reqCrop, "right");
+		}
+		if (obs_data_has_user_value(reqCrop, "bottom")) {
+			newCrop.bottom = obs_data_get_int(reqCrop, "bottom");
+		}
+		if (obs_data_has_user_value(reqCrop, "left")) {
+			newCrop.left = obs_data_get_int(reqCrop, "left");
+		}
+
+		obs_sceneitem_set_crop(sceneItem, &newCrop);
+	}
+
+	if (request.hasField("visible")) {
+		obs_sceneitem_set_visible(sceneItem, obs_data_get_bool(params, "visible"));
+	}
+
+	if (request.hasField("locked")) {
+		obs_sceneitem_set_locked(sceneItem, obs_data_get_bool(params, "locked"));
+	}
+
+	if (request.hasField("bounds")) {
+		bool badBounds = false;
+		OBSDataAutoRelease boundsError = obs_data_create();
+		OBSDataAutoRelease reqBounds = obs_data_get_obj(params, "bounds");
+
+		if (obs_data_has_user_value(reqBounds, "type")) {
+			QString newBoundsType = obs_data_get_string(reqBounds, "type");
+			if (newBoundsType == "OBS_BOUNDS_NONE") {
+				obs_sceneitem_set_bounds_type(sceneItem, OBS_BOUNDS_NONE);
+			}
+			else if (newBoundsType == "OBS_BOUNDS_STRETCH") {
+				obs_sceneitem_set_bounds_type(sceneItem, OBS_BOUNDS_STRETCH);
+			}
+			else if (newBoundsType == "OBS_BOUNDS_SCALE_INNER") {
+				obs_sceneitem_set_bounds_type(sceneItem, OBS_BOUNDS_SCALE_INNER);
+			}
+			else if (newBoundsType == "OBS_BOUNDS_SCALE_OUTER") {
+				obs_sceneitem_set_bounds_type(sceneItem, OBS_BOUNDS_SCALE_OUTER);
+			}
+			else if (newBoundsType == "OBS_BOUNDS_SCALE_TO_WIDTH") {
+				obs_sceneitem_set_bounds_type(sceneItem, OBS_BOUNDS_SCALE_TO_WIDTH);
+			}
+			else if (newBoundsType == "OBS_BOUNDS_SCALE_TO_HEIGHT") {
+				obs_sceneitem_set_bounds_type(sceneItem, OBS_BOUNDS_SCALE_TO_HEIGHT);
+			}
+			else if (newBoundsType == "OBS_BOUNDS_MAX_ONLY") {
+				obs_sceneitem_set_bounds_type(sceneItem, OBS_BOUNDS_MAX_ONLY);
+			}
+			else {
+				badRequest = badBounds = true;
+				obs_data_set_string(boundsError, "type", "invalid");
+			}
+		}
+
+		vec2 oldBounds;
+		obs_sceneitem_get_bounds(sceneItem, &oldBounds);
+		vec2 newBounds = oldBounds;
+
+		if (obs_data_has_user_value(reqBounds, "x")) {
+			newBounds.x = obs_data_get_double(reqBounds, "x");
+		}
+		if (obs_data_has_user_value(reqBounds, "y")) {
+			newBounds.y = obs_data_get_double(reqBounds, "y");
+		}
+
+		obs_sceneitem_set_bounds(sceneItem, &newBounds);
+		
+		if (obs_data_has_user_value(reqBounds, "alignment")) {
+			const uint32_t bounds_alignment = obs_data_get_int(reqBounds, "alignment");
+			if (Utils::IsValidAlignment(bounds_alignment)) {
+				obs_sceneitem_set_bounds_alignment(sceneItem, bounds_alignment);
+			}
+			else {
+				badRequest = badBounds = true;
+				obs_data_set_string(boundsError, "alignment", "invalid");
+			}
+		}
+
+		if (badBounds) {
+			obs_data_set_obj(errorData, "bounds", boundsError);
+		}
+	}
+
+	obs_sceneitem_defer_update_end(sceneItem);
+
+	if (badRequest) {
+		return request.failed("error", errorData);
+	}
+
+	return request.success();
+}
+
+/**
+* Reset a scene item.
+*
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String | Object} `item` Scene Item name (if this field is a string) or specification (if it is an object).
+* @param {String (optional)} `item.name` Scene Item name (if the `item` field is an object)
+* @param {int (optional)} `item.id` Scene Item ID (if the `item` field is an object)
+*
+* @api requests
+* @name ResetSceneItem
+* @category scene items
+* @since 4.2.0
+*/
+RpcResponse WSRequestHandler::ResetSceneItem(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
+	}
+
+	OBSData params = request.parameters();
+
+	const char* sceneName = obs_data_get_string(params, "scene-name");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene doesn't exist");
+	}
+
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(params, "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
+	if (!sceneItem) {
+		return request.failed("specified scene item doesn't exist");
+	}
+
+	OBSSource sceneItemSource = obs_sceneitem_get_source(sceneItem);
+
+	OBSDataAutoRelease settings = obs_source_get_settings(sceneItemSource);
+	obs_source_update(sceneItemSource, settings);
+
+	return request.success();
+}
+
+/**
+* Show or hide a specified source item in a specified scene.
+*
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the currently active scene.
+* @param {String} `source` Scene Item name.
+* @param {boolean} `render` true = shown ; false = hidden
+*
+* @api requests
+* @name SetSceneItemRender
+* @category scene items
+* @since 0.3
+* @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
+*/
+RpcResponse WSRequestHandler::SetSceneItemRender(const RpcRequest& request) {
+	if (!request.hasField("source") ||
+		!request.hasField("render"))
+	{
+		return request.failed("missing request parameters");
+	}
+
+	const char* itemName = obs_data_get_string(request.parameters(), "source");
+	bool isVisible = obs_data_get_bool(request.parameters(), "render");
+
+	if (!itemName) {
+		return request.failed("invalid request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(request.parameters(), "scene-name");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene doesn't exist");
+	}
+
+	OBSSceneItemAutoRelease sceneItem =
+		Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return request.failed("specified scene item doesn't exist");
+	}
+
+	obs_sceneitem_set_visible(sceneItem, isVisible);
+	return request.success();
+}
+
+/**
+* Sets the coordinates of a specified source item.
+*
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String} `item` Scene Item name.
+* @param {double} `x` X coordinate.
+* @param {double} `y` Y coordinate.
+
+*
+* @api requests
+* @name SetSceneItemPosition
+* @category scene items
+* @since 4.0.0
+* @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
+*/
+RpcResponse WSRequestHandler::SetSceneItemPosition(const RpcRequest& request) {
+	if (!request.hasField("item") ||
+		!request.hasField("x") || !request.hasField("y")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString itemName = obs_data_get_string(request.parameters(), "item");
+	if (itemName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(request.parameters(), "scene-name");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene could not be found");
+	}
+
+	OBSSceneItem sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return request.failed("specified scene item doesn't exist");
+	}
+
+	vec2 item_position = { 0 };
+	item_position.x = obs_data_get_double(request.parameters(), "x");
+	item_position.y = obs_data_get_double(request.parameters(), "y");
+	obs_sceneitem_set_pos(sceneItem, &item_position);
+
+	return request.success();
+}
+
+/**
+* Set the transform of the specified source item.
+*
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String} `item` Scene Item name.
+* @param {double} `x-scale` Width scale factor.
+* @param {double} `y-scale` Height scale factor.
+* @param {double} `rotation` Source item rotation (in degrees).
+*
+* @api requests
+* @name SetSceneItemTransform
+* @category scene items
+* @since 4.0.0
+* @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
+*/
+RpcResponse WSRequestHandler::SetSceneItemTransform(const RpcRequest& request) {
+	if (!request.hasField("item") ||
+		!request.hasField("x-scale") ||
+		!request.hasField("y-scale") ||
+		!request.hasField("rotation"))
+	{
+		return request.failed("missing request parameters");
+	}
+
+	QString itemName = obs_data_get_string(request.parameters(), "item");
+	if (itemName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(request.parameters(), "scene-name");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene doesn't exist");
+	}
+
+	vec2 scale;
+	scale.x = obs_data_get_double(request.parameters(), "x-scale");
+	scale.y = obs_data_get_double(request.parameters(), "y-scale");
+	float rotation = obs_data_get_double(request.parameters(), "rotation");
+
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return request.failed("specified scene item doesn't exist");
+	}
+
+	obs_sceneitem_defer_update_begin(sceneItem);
+
+	obs_sceneitem_set_scale(sceneItem, &scale);
+	obs_sceneitem_set_rot(sceneItem, rotation);
+	
+	obs_sceneitem_defer_update_end(sceneItem);
+
+	return request.success();
+}
+
+/**
+* Sets the crop coordinates of the specified source item.
+*
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String} `item` Scene Item name.
+* @param {int} `top` Pixel position of the top of the source item.
+* @param {int} `bottom` Pixel position of the bottom of the source item.
+* @param {int} `left` Pixel position of the left of the source item.
+* @param {int} `right` Pixel position of the right of the source item.
+*
+* @api requests
+* @name SetSceneItemCrop
+* @category scene items
+* @since 4.1.0
+* @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
+*/
+RpcResponse WSRequestHandler::SetSceneItemCrop(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString itemName = obs_data_get_string(request.parameters(), "item");
+	if (itemName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(request.parameters(), "scene-name");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene doesn't exist");
+	}
+
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return request.failed("specified scene item doesn't exist");
+	}
+
+	struct obs_sceneitem_crop crop = { 0 };
+	crop.top = obs_data_get_int(request.parameters(), "top");
+	crop.bottom = obs_data_get_int(request.parameters(), "bottom");
+	crop.left = obs_data_get_int(request.parameters(), "left");
+	crop.right = obs_data_get_int(request.parameters(), "right");
+
+	obs_sceneitem_set_crop(sceneItem, &crop);
+
+	return request.success();
+}
+
+/**
+ * Deletes a scene item.
+ *
+ * @param {String (optional)} `scene` Name of the scene the scene item belongs to. Defaults to the current scene.
+ * @param {Object} `item` Scene item to delete (required)
+ * @param {String} `item.name` Scene Item name (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` Scene Item ID.
+ *
+ * @api requests
+ * @name DeleteSceneItem
+ * @category scene items
+ * @since 4.5.0
+ */
+RpcResponse WSRequestHandler::DeleteSceneItem(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(request.parameters(), "scene");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene doesn't exist");
+	}
+
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(request.parameters(), "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
+	if (!sceneItem) {
+		return request.failed("item with id/name combination not found in specified scene");
+	}
+
+	obs_sceneitem_remove(sceneItem);
+
+	return request.success();
+}
+
+/**
+ * Duplicates a scene item.
+ *
+ * @param {String (optional)} `fromScene` Name of the scene to copy the item from. Defaults to the current scene.
+ * @param {String (optional)} `toScene` Name of the scene to create the item in. Defaults to the current scene.
+ * @param {Object} `item` Scene Item to duplicate from the source scene (required)
+ * @param {String} `item.name` Scene Item name (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` Scene Item ID.
+ *
+ * @return {String} `scene` Name of the scene where the new item was created
+ * @return {Object} `item` New item info
+ * @return {int} `item.id` New item ID
+ * @return {String} `item.name` New item name
+ *
+ * @api requests
+ * @name DuplicateSceneItem
+ * @category scene items
+ * @since 4.5.0
+ */
+RpcResponse WSRequestHandler::DuplicateSceneItem(const RpcRequest& request) {
+	struct DuplicateSceneItemData {
+		obs_sceneitem_t *referenceItem;
+		obs_source_t *fromSource;
+		obs_sceneitem_t *newItem;
+	};
+
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* fromSceneName = obs_data_get_string(request.parameters(), "fromScene");
+	OBSScene fromScene = Utils::GetSceneFromNameOrCurrent(fromSceneName);
+	if (!fromScene) {
+		return request.failed("requested fromScene doesn't exist");
+	}
+
+	const char* toSceneName = obs_data_get_string(request.parameters(), "toScene");
+	OBSScene toScene = Utils::GetSceneFromNameOrCurrent(toSceneName);
+	if (!toScene) {
+		return request.failed("requested toScene doesn't exist");
+	}
+
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(request.parameters(), "item");
+	OBSSceneItemAutoRelease referenceItem = Utils::GetSceneItemFromRequestField(fromScene, itemField);
+	if (!referenceItem) {
+		return request.failed("item with id/name combination not found in specified scene");
+	}
+
+	DuplicateSceneItemData data;
+	data.fromSource = obs_sceneitem_get_source(referenceItem);
+	data.referenceItem = referenceItem;
+
+	obs_enter_graphics();
+	obs_scene_atomic_update(toScene, [](void *_data, obs_scene_t *scene) {
+		auto data = reinterpret_cast<DuplicateSceneItemData*>(_data);
+		data->newItem = obs_scene_add(scene, data->fromSource);
+		obs_sceneitem_set_visible(data->newItem, obs_sceneitem_visible(data->referenceItem));
+	}, &data);
+	obs_leave_graphics();
+
+	obs_sceneitem_t *newItem = data.newItem;
+	if (!newItem) {
+		return request.failed("Error duplicating scene item");
+	}
+
+	OBSDataAutoRelease itemData = obs_data_create();
+	obs_data_set_int(itemData, "id", obs_sceneitem_get_id(newItem));
+	obs_data_set_string(itemData, "name", obs_source_get_name(obs_sceneitem_get_source(newItem)));
+
+	OBSDataAutoRelease responseData = obs_data_create();
+	obs_data_set_obj(responseData, "item", itemData);
+	obs_data_set_string(responseData, "scene", obs_source_get_name(obs_scene_get_source(toScene)));
+
+	return request.success(responseData);
+}

src/WSRequestHandler_Scenes.cpp

@@ -0,0 +1,275 @@
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+/**
+* @typedef {Object} `Scene`
+* @property {String} `name` Name of the currently active scene.
+* @property {Array<SceneItem>} `sources` Ordered list of the current scene's source items.
+*/
+
+/**
+ * Switch to the specified scene.
+ *
+ * @param {String} `scene-name` Name of the scene to switch to.
+ *
+ * @api requests
+ * @name SetCurrentScene
+ * @category scenes
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::SetCurrentScene(const RpcRequest& request) {
+	if (!request.hasField("scene-name")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(request.parameters(), "scene-name");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName);
+
+	if (source) {
+		obs_frontend_set_current_scene(source);
+		return request.success();
+	} else {
+		return request.failed("requested scene does not exist");
+	}
+}
+
+/**
+ * Get the current scene's name and source items.
+ * 
+ * @return {String} `name` Name of the currently active scene.
+ * @return {Array<SceneItem>} `sources` Ordered list of the current scene's source items.
+ *
+ * @api requests
+ * @name GetCurrentScene
+ * @category scenes
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::GetCurrentScene(const RpcRequest& request) {
+	OBSSourceAutoRelease currentScene = obs_frontend_get_current_scene();
+	OBSDataArrayAutoRelease sceneItems = Utils::GetSceneItems(currentScene);
+
+	OBSDataAutoRelease data = obs_data_create();
+	obs_data_set_string(data, "name", obs_source_get_name(currentScene));
+	obs_data_set_array(data, "sources", sceneItems);
+
+	return request.success(data);
+}
+
+/**
+ * Get a list of scenes in the currently active profile.
+ * 
+ * @return {String} `current-scene` Name of the currently active scene.
+ * @return {Array<Scene>} `scenes` Ordered list of the current profile's scenes (See [GetCurrentScene](#getcurrentscene) for more information).
+ *
+ * @api requests
+ * @name GetSceneList
+ * @category scenes
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::GetSceneList(const RpcRequest& request) {
+	OBSSourceAutoRelease currentScene = obs_frontend_get_current_scene();
+	OBSDataArrayAutoRelease scenes = Utils::GetScenes();
+
+	OBSDataAutoRelease data = obs_data_create();
+	obs_data_set_string(data, "current-scene",
+		obs_source_get_name(currentScene));
+	obs_data_set_array(data, "scenes", scenes);
+
+	return request.success(data);
+}
+
+/**
+* Changes the order of scene items in the requested scene.
+*
+* @param {String (optional)} `scene` Name of the scene to reorder (defaults to current).
+* @param {Array<Scene>} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene
+* @param {int (optional)} `items[].id` Id of a specific scene item. Unique on a scene by scene basis.
+* @param {String (optional)} `items[].name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene.
+*
+* @api requests
+* @name ReorderSceneItems
+* @category scenes
+* @since 4.5.0
+*/
+RpcResponse WSRequestHandler::ReorderSceneItems(const RpcRequest& request) {
+	QString sceneName = obs_data_get_string(request.parameters(), "scene");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene doesn't exist");
+	}
+
+	OBSDataArrayAutoRelease items = obs_data_get_array(request.parameters(), "items");
+	if (!items) {
+		return request.failed("sceneItem order not specified");
+	}
+
+	struct reorder_context {
+		obs_data_array_t* items;
+		bool success;
+		QString errorMessage;
+	};
+
+	struct reorder_context ctx;
+	ctx.success = false;
+	ctx.items = items;
+
+	obs_scene_atomic_update(scene, [](void* param, obs_scene_t* scene) {
+		auto ctx = reinterpret_cast<struct reorder_context*>(param);
+
+		QVector<struct obs_sceneitem_order_info> orderList;
+		struct obs_sceneitem_order_info info;
+
+		size_t itemCount = obs_data_array_count(ctx->items);
+		for (uint i = 0; i < itemCount; i++) {
+			OBSDataAutoRelease item = obs_data_array_item(ctx->items, i);
+
+			OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromItem(scene, item);
+			if (!sceneItem) {
+				ctx->success = false;
+				ctx->errorMessage = "Invalid sceneItem id or name specified";
+				return;
+			}
+
+			info.group = nullptr;
+			info.item = sceneItem;
+			orderList.insert(0, info);
+		}
+
+		ctx->success = obs_scene_reorder_items2(scene, orderList.data(), orderList.size());
+		if (!ctx->success) {
+			ctx->errorMessage = "Invalid sceneItem order";
+		}
+	}, &ctx);
+
+	if (!ctx.success) {
+		return request.failed(ctx.errorMessage);
+	}
+
+	return request.success();
+}
+
+/**
+ * Set a scene to use a specific transition override.
+ *
+ * @param {String} `sceneName` Name of the scene to switch to.
+ * @param {String} `transitionName` Name of the transition to use.
+ * @param {int (Optional)} `transitionDuration` Duration in milliseconds of the transition if transition is not fixed. Defaults to the current duration specified in the UI if there is no current override and this value is not given.
+ *
+ * @api requests
+ * @name SetSceneTransitionOverride
+ * @category scenes
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::SetSceneTransitionOverride(const RpcRequest& request) {
+	if (!request.hasField("sceneName") || !request.hasField("transitionName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(request.parameters(), "sceneName");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName.toUtf8());
+	if (!source) {
+		return request.failed("requested scene does not exist");
+	}
+	
+	enum obs_source_type sourceType = obs_source_get_type(source);
+	if (sourceType != OBS_SOURCE_TYPE_SCENE) {
+		return request.failed("requested scene is invalid");
+	}
+	
+	QString transitionName = obs_data_get_string(request.parameters(), "transitionName");
+	if (!Utils::GetTransitionFromName(transitionName)) {
+		return request.failed("requested transition does not exist");
+	}
+
+	OBSDataAutoRelease sourceData = obs_source_get_private_settings(source);
+	obs_data_set_string(sourceData, "transition", transitionName.toUtf8().constData());
+
+	if (request.hasField("transitionDuration")) {
+		int transitionOverrideDuration = obs_data_get_int(request.parameters(), "transitionDuration");
+		obs_data_set_int(sourceData, "transition_duration", transitionOverrideDuration);
+	} else if(!obs_data_has_user_value(sourceData, "transition_duration")) {
+		obs_data_set_int(sourceData, "transition_duration",
+			obs_frontend_get_transition_duration()
+		);
+	}
+	
+	return request.success();
+}
+
+/**
+ * Remove any transition override on a scene.
+ *
+ * @param {String} `sceneName` Name of the scene to switch to.
+ *
+ * @api requests
+ * @name RemoveSceneTransitionOverride
+ * @category scenes
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::RemoveSceneTransitionOverride(const RpcRequest& request) {
+	if (!request.hasField("sceneName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(request.parameters(), "sceneName");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName.toUtf8());
+	if (!source) {
+		return request.failed("requested scene does not exist");
+	}
+	
+	enum obs_source_type sourceType = obs_source_get_type(source);
+	if (sourceType != OBS_SOURCE_TYPE_SCENE) {
+		return request.failed("requested scene is invalid");
+	}
+
+	OBSDataAutoRelease sourceData = obs_source_get_private_settings(source);
+	obs_data_erase(sourceData, "transition");
+	obs_data_erase(sourceData, "transition_duration");
+
+	return request.success();
+}
+
+/**
+ * Get the current scene transition override.
+ *
+ * @param {String} `sceneName` Name of the scene to switch to.
+ *
+ * @return {String} `transitionName` Name of the current overriding transition. Empty string if no override is set.
+ * @return {int} `transitionDuration` Transition duration. `-1` if no override is set.
+ *
+ * @api requests
+ * @name GetSceneTransitionOverride
+ * @category scenes
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::GetSceneTransitionOverride(const RpcRequest& request) {
+	if (!request.hasField("sceneName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(request.parameters(), "sceneName");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName.toUtf8());
+	if (!source) {
+		return request.failed("requested scene does not exist");
+	}
+	
+	enum obs_source_type sourceType = obs_source_get_type(source);
+	if (sourceType != OBS_SOURCE_TYPE_SCENE) {
+		return request.failed("requested scene is invalid");
+	}
+
+	OBSDataAutoRelease sourceData = obs_source_get_private_settings(source);
+	const char* transitionOverrideName = obs_data_get_string(sourceData, "transition");
+
+	bool hasDurationOverride = obs_data_has_user_value(sourceData, "transition_duration");
+	int transitionOverrideDuration = obs_data_get_int(sourceData, "transition_duration");
+
+	OBSDataAutoRelease fields = obs_data_create();
+	obs_data_set_string(fields, "transitionName", transitionOverrideName);
+	obs_data_set_int(fields, "transitionDuration",
+		(hasDurationOverride ? transitionOverrideDuration : -1)
+	);
+
+	return request.success(fields);
+}

src/WSRequestHandler_Streaming.cpp

@@ -0,0 +1,320 @@
+#include "obs-websocket.h"
+#include "Utils.h"
+#include "WSEvents.h"
+
+#include "WSRequestHandler.h"
+
+#define STREAM_SERVICE_ID "websocket_custom_service"
+
+ /**
+ * Get current streaming and recording status.
+ *
+ * @return {boolean} `streaming` Current streaming status.
+ * @return {boolean} `recording` Current recording status.
+ * @return {String (optional)} `stream-timecode` Time elapsed since streaming started (only present if currently streaming).
+ * @return {String (optional)} `rec-timecode` Time elapsed since recording started (only present if currently recording).
+ * @return {boolean} `preview-only` Always false. Retrocompatibility with OBSRemote.
+ *
+ * @api requests
+ * @name GetStreamingStatus
+ * @category streaming
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::GetStreamingStatus(const RpcRequest& request) {
+	auto events = GetEventsSystem();
+
+	OBSDataAutoRelease data = obs_data_create();
+	obs_data_set_bool(data, "streaming", obs_frontend_streaming_active());
+	obs_data_set_bool(data, "recording", obs_frontend_recording_active());
+	obs_data_set_bool(data, "recording-paused", obs_frontend_recording_paused());
+	obs_data_set_bool(data, "preview-only", false);
+
+	if (obs_frontend_streaming_active()) {
+		QString streamingTimecode = events->getStreamingTimecode();
+		obs_data_set_string(data, "stream-timecode", streamingTimecode.toUtf8().constData());
+	}
+
+	if (obs_frontend_recording_active()) {
+		QString recordingTimecode = events->getRecordingTimecode();
+		obs_data_set_string(data, "rec-timecode", recordingTimecode.toUtf8().constData());
+	}
+
+	return request.success(data);
+}
+
+/**
+ * Toggle streaming on or off.
+ *
+ * @api requests
+ * @name StartStopStreaming
+ * @category streaming
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::StartStopStreaming(const RpcRequest& request) {
+	if (obs_frontend_streaming_active())
+		return StopStreaming(request);
+	else
+		return StartStreaming(request);
+}
+
+/**
+ * Start streaming.
+ * Will return an `error` if streaming is already active.
+ *
+ * @param {Object (optional)} `stream` Special stream configuration. Please note: these won't be saved to OBS' configuration.
+ * @param {String (optional)} `stream.type` If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common'). If the currently configured stream type does not match the given stream type, all settings must be specified in the `settings` object or an error will occur when starting the stream.
+ * @param {Object (optional)} `stream.metadata` Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream. Used to pass data to the RTMP service about the streaming. May be any String, Numeric, or Boolean field.
+ * @param {Object (optional)} `stream.settings` Settings for the stream.
+ * @param {String (optional)} `stream.settings.server` The publish URL.
+ * @param {String (optional)} `stream.settings.key` The publish key of the stream.
+ * @param {boolean (optional)} `stream.settings.use_auth` Indicates whether authentication should be used when connecting to the streaming server.
+ * @param {String (optional)} `stream.settings.username` If authentication is enabled, the username for the streaming server. Ignored if `use_auth` is not set to `true`.
+ * @param {String (optional)} `stream.settings.password` If authentication is enabled, the password for the streaming server. Ignored if `use_auth` is not set to `true`.
+ *
+ * @api requests
+ * @name StartStreaming
+ * @category streaming
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::StartStreaming(const RpcRequest& request) {
+	if (obs_frontend_streaming_active() == false) {
+		OBSService configuredService = obs_frontend_get_streaming_service();
+		OBSService newService = nullptr;
+
+		// TODO: fix service memory leak
+
+		if (request.hasField("stream")) {
+			OBSDataAutoRelease streamData = obs_data_get_obj(request.parameters(), "stream");
+			OBSDataAutoRelease newSettings = obs_data_get_obj(streamData, "settings");
+			OBSDataAutoRelease newMetadata = obs_data_get_obj(streamData, "metadata");
+
+			OBSDataAutoRelease csHotkeys =
+				obs_hotkeys_save_service(configuredService);
+
+			QString currentType = obs_service_get_type(configuredService);
+			QString newType = obs_data_get_string(streamData, "type");
+			if (newType.isEmpty() || newType.isNull()) {
+				newType = currentType;
+			}
+
+			//Supporting adding metadata parameters to key query string
+			QString query = Utils::ParseDataToQueryString(newMetadata);
+			if (!query.isEmpty()
+					&& obs_data_has_user_value(newSettings, "key"))
+			{
+				const char* key = obs_data_get_string(newSettings, "key");
+				size_t keylen = strlen(key);
+
+				bool hasQuestionMark = false;
+				for (size_t i = 0; i < keylen; i++) {
+					if (key[i] == '?') {
+						hasQuestionMark = true;
+						break;
+					}
+				}
+
+				if (hasQuestionMark) {
+					query.prepend('&');
+				} else {
+					query.prepend('?');
+				}
+
+				query.prepend(key);
+				obs_data_set_string(newSettings, "key", query.toUtf8());
+			}
+
+			if (newType == currentType) {
+				// Service type doesn't change: apply settings to current service
+
+				// By doing this, you can send a request to the websocket
+				// that only contains settings you want to change, instead of
+				// having to do a get and then change them
+
+				OBSDataAutoRelease currentSettings = obs_service_get_settings(configuredService);
+				OBSDataAutoRelease updatedSettings = obs_data_create();
+
+				obs_data_apply(updatedSettings, currentSettings); //first apply the existing settings
+				obs_data_apply(updatedSettings, newSettings); //then apply the settings from the request should they exist
+
+				newService = obs_service_create(
+					newType.toUtf8(), STREAM_SERVICE_ID,
+					updatedSettings, csHotkeys);
+			}
+			else {
+				// Service type changed: override service settings
+				newService = obs_service_create(
+					newType.toUtf8(), STREAM_SERVICE_ID,
+					newSettings, csHotkeys);
+			}
+
+			obs_frontend_set_streaming_service(newService);
+		}
+
+		obs_frontend_streaming_start();
+
+		// Stream settings provided in StartStreaming are not persisted to disk
+		if (newService != nullptr) {
+			obs_frontend_set_streaming_service(configuredService);
+		}
+
+		return request.success();
+	} else {
+		return request.failed("streaming already active");
+	}
+}
+
+/**
+ * Stop streaming.
+ * Will return an `error` if streaming is not active.
+ *
+ * @api requests
+ * @name StopStreaming
+ * @category streaming
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::StopStreaming(const RpcRequest& request) {
+	if (obs_frontend_streaming_active() == true) {
+		obs_frontend_streaming_stop();
+		return request.success();
+	} else {
+		return request.failed("streaming not active");
+	}
+}
+
+/**
+ * Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings).
+ *
+ * @param {String} `type` The type of streaming service configuration, usually `rtmp_custom` or `rtmp_common`.
+ * @param {Object} `settings` The actual settings of the stream.
+ * @param {String (optional)} `settings.server` The publish URL.
+ * @param {String (optional)} `settings.key` The publish key.
+ * @param {boolean (optional)} `settings.use_auth` Indicates whether authentication should be used when connecting to the streaming server.
+ * @param {String (optional)} `settings.username` The username for the streaming service.
+ * @param {String (optional)} `settings.password` The password for the streaming service.
+ * @param {boolean} `save` Persist the settings to disk.
+ *
+ * @api requests
+ * @name SetStreamSettings
+ * @category streaming
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::SetStreamSettings(const RpcRequest& request) {
+	OBSService service = obs_frontend_get_streaming_service();
+
+	OBSDataAutoRelease requestSettings = obs_data_get_obj(request.parameters(), "settings");
+	if (!requestSettings) {
+		return request.failed("'settings' are required'");
+	}
+
+	QString serviceType = obs_service_get_type(service);
+	QString requestedType = obs_data_get_string(request.parameters(), "type");
+
+	if (requestedType != nullptr && requestedType != serviceType) {
+		OBSDataAutoRelease hotkeys = obs_hotkeys_save_service(service);
+		service = obs_service_create(
+			requestedType.toUtf8(), STREAM_SERVICE_ID, requestSettings, hotkeys);
+		obs_frontend_set_streaming_service(service);
+	} else {
+		// If type isn't changing, we should overlay the settings we got
+		// to the existing settings. By doing so, you can send a request that
+		// only contains the settings you want to change, instead of having to
+		// do a get and then change them
+
+		OBSDataAutoRelease existingSettings = obs_service_get_settings(service);
+		OBSDataAutoRelease newSettings = obs_data_create();
+
+		// Apply existing settings
+		obs_data_apply(newSettings, existingSettings);
+		// Then apply the settings from the request
+		obs_data_apply(newSettings, requestSettings);
+
+		obs_service_update(service, newSettings);
+	}
+
+	//if save is specified we should immediately save the streaming service
+	if (obs_data_get_bool(request.parameters(), "save")) {
+		obs_frontend_save_streaming_service();
+	}
+
+	OBSService responseService = obs_frontend_get_streaming_service();
+	OBSDataAutoRelease serviceSettings = obs_service_get_settings(responseService);
+	const char* responseType = obs_service_get_type(responseService);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "type", responseType);
+	obs_data_set_obj(response, "settings", serviceSettings);
+
+	return request.success(response);
+}
+
+/**
+ * Get the current streaming server settings.
+ *
+ * @return {String} `type` The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'.
+ * @return {Object} `settings` Stream settings object.
+ * @return {String} `settings.server` The publish URL.
+ * @return {String} `settings.key` The publish key of the stream.
+ * @return {boolean} `settings.use_auth` Indicates whether authentication should be used when connecting to the streaming server.
+ * @return {String} `settings.username` The username to use when accessing the streaming server. Only present if `use_auth` is `true`.
+ * @return {String} `settings.password` The password to use when accessing the streaming server. Only present if `use_auth` is `true`.
+ *
+ * @api requests
+ * @name GetStreamSettings
+ * @category streaming
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::GetStreamSettings(const RpcRequest& request) {
+	OBSService service = obs_frontend_get_streaming_service();
+
+	const char* serviceType = obs_service_get_type(service);
+	OBSDataAutoRelease settings = obs_service_get_settings(service);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "type", serviceType);
+	obs_data_set_obj(response, "settings", settings);
+
+	return request.success(response);
+}
+
+/**
+ * Save the current streaming server settings to disk.
+ *
+ * @api requests
+ * @name SaveStreamSettings
+ * @category streaming
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::SaveStreamSettings(const RpcRequest& request) {
+	obs_frontend_save_streaming_service();
+	return request.success();
+}
+
+
+/**
+ * Send the provided text as embedded CEA-608 caption data.
+ * As of OBS Studio 23.1, captions are not yet available on Linux.
+ *
+ * @param {String} `text` Captions text
+ *
+ * @api requests
+ * @name SendCaptions
+ * @category streaming
+ * @since 4.6.0
+ */
+#if BUILD_CAPTIONS
+RpcResponse WSRequestHandler::SendCaptions(const RpcRequest& request) {
+	if (!request.hasField("text")) {
+		return request.failed("missing request parameters");
+	}
+
+	OBSOutputAutoRelease output = obs_frontend_get_streaming_output();
+	if (output) {
+		const char* caption = obs_data_get_string(request.parameters(), "text");
+		// Send caption text with immediately (0 second delay)
+		obs_output_output_caption_text2(output, caption, 0.0);
+	}
+
+	return request.success();
+}
+#endif
+

src/WSRequestHandler_StudioMode.cpp

@@ -0,0 +1,185 @@
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+/**
+ * Indicates if Studio Mode is currently enabled.
+ *
+ * @return {boolean} `studio-mode` Indicates if Studio Mode is enabled.
+ *
+ * @api requests
+ * @name GetStudioModeStatus
+ * @category studio mode
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::GetStudioModeStatus(const RpcRequest& request) {
+	bool previewActive = obs_frontend_preview_program_mode_active();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_bool(response, "studio-mode", previewActive);
+
+	return request.success(response);
+}
+
+/**
+ * Get the name of the currently previewed scene and its list of sources.
+ * Will return an `error` if Studio Mode is not enabled.
+ *
+ * @return {String} `name` The name of the active preview scene.
+ * @return {Array<SceneItem>} `sources`
+ *
+ * @api requests
+ * @name GetPreviewScene
+ * @category studio mode
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::GetPreviewScene(const RpcRequest& request) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return request.failed("studio mode not enabled");
+	}
+
+	OBSSourceAutoRelease scene = obs_frontend_get_current_preview_scene();
+	OBSDataArrayAutoRelease sceneItems = Utils::GetSceneItems(scene);
+
+	OBSDataAutoRelease data = obs_data_create();
+	obs_data_set_string(data, "name", obs_source_get_name(scene));
+	obs_data_set_array(data, "sources", sceneItems);
+
+	return request.success(data);
+}
+
+/**
+ * Set the active preview scene.
+ * Will return an `error` if Studio Mode is not enabled.
+ *
+ * @param {String} `scene-name` The name of the scene to preview.
+ *
+ * @api requests
+ * @name SetPreviewScene
+ * @category studio mode
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::SetPreviewScene(const RpcRequest& request) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return request.failed("studio mode not enabled");
+	}
+
+	if (!request.hasField("scene-name")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* scene_name = obs_data_get_string(request.parameters(), "scene-name");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(scene_name);
+	if (!scene) {
+		return request.failed("specified scene doesn't exist");
+	}
+
+	obs_frontend_set_current_preview_scene(obs_scene_get_source(scene));
+	return request.success();
+}
+
+/**
+ * Transitions the currently previewed scene to the main output.
+ * Will return an `error` if Studio Mode is not enabled.
+ *
+ * @param {Object (optional)} `with-transition` Change the active transition before switching scenes. Defaults to the active transition. 
+ * @param {String} `with-transition.name` Name of the transition.
+ * @param {int (optional)} `with-transition.duration` Transition duration (in milliseconds).
+ *
+ * @api requests
+ * @name TransitionToProgram
+ * @category studio mode
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::TransitionToProgram(const RpcRequest& request) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return request.failed("studio mode not enabled");
+	}
+
+	if (request.hasField("with-transition")) {
+		OBSDataAutoRelease transitionInfo =
+			obs_data_get_obj(request.parameters(), "with-transition");
+
+		if (obs_data_has_user_value(transitionInfo, "name")) {
+			QString transitionName =
+				obs_data_get_string(transitionInfo, "name");
+			if (transitionName.isEmpty()) {
+				return request.failed("invalid request parameters");
+			}
+
+			bool success = Utils::SetTransitionByName(transitionName);
+			if (!success) {
+				return request.failed("specified transition doesn't exist");
+			}
+		}
+
+		if (obs_data_has_user_value(transitionInfo, "duration")) {
+			int transitionDuration =
+				obs_data_get_int(transitionInfo, "duration");
+			obs_frontend_set_transition_duration(transitionDuration);
+		}
+	}
+
+	obs_frontend_preview_program_trigger_transition();
+	return request.success();
+}
+
+/**
+ * Enables Studio Mode.
+ *
+ * @api requests
+ * @name EnableStudioMode
+ * @category studio mode
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::EnableStudioMode(const RpcRequest& request) {
+	if (obs_frontend_preview_program_mode_active()) {
+		return request.failed("studio mode already active");
+	}
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
+		obs_frontend_set_preview_program_mode(true);
+
+		UNUSED_PARAMETER(param);
+	}, nullptr, true);
+	return request.success();
+}
+
+/**
+ * Disables Studio Mode.
+ *
+ * @api requests
+ * @name DisableStudioMode
+ * @category studio mode
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::DisableStudioMode(const RpcRequest& request) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return request.failed("studio mode not active");
+	}
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
+		obs_frontend_set_preview_program_mode(false);
+
+		UNUSED_PARAMETER(param);
+	}, nullptr, true);
+
+	return request.success();
+}
+
+/**
+ * Toggles Studio Mode.
+ *
+ * @api requests
+ * @name ToggleStudioMode
+ * @category studio mode
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::ToggleStudioMode(const RpcRequest& request) {
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
+		bool previewProgramMode = obs_frontend_preview_program_mode_active();
+		obs_frontend_set_preview_program_mode(!previewProgramMode);
+
+		UNUSED_PARAMETER(param);
+	}, nullptr, true);
+
+	return request.success();
+}

src/WSRequestHandler_Transitions.cpp

@@ -0,0 +1,141 @@
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+/**
+ * List of all transitions available in the frontend's dropdown menu.
+ *
+ * @return {String} `current-transition` Name of the currently active transition.
+ * @return {Array<Object>} `transitions` List of transitions.
+ * @return {String} `transitions.*.name` Name of the transition.
+ *
+ * @api requests
+ * @name GetTransitionList
+ * @category transitions
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::GetTransitionList(const RpcRequest& request) {
+	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
+	obs_frontend_source_list transitionList = {};
+	obs_frontend_get_transitions(&transitionList);
+
+	OBSDataArrayAutoRelease transitions = obs_data_array_create();
+	for (size_t i = 0; i < transitionList.sources.num; i++) {
+		OBSSource transition = transitionList.sources.array[i];
+
+		OBSDataAutoRelease obj = obs_data_create();
+		obs_data_set_string(obj, "name", obs_source_get_name(transition));
+		obs_data_array_push_back(transitions, obj);
+	}
+	obs_frontend_source_list_free(&transitionList);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "current-transition",
+		obs_source_get_name(currentTransition));
+	obs_data_set_array(response, "transitions", transitions);
+
+	return request.success(response);
+}
+
+/**
+ * Get the name of the currently selected transition in the frontend's dropdown menu.
+ *
+ * @return {String} `name` Name of the selected transition.
+ * @return {int (optional)} `duration` Transition duration (in milliseconds) if supported by the transition.
+ *
+ * @api requests
+ * @name GetCurrentTransition
+ * @category transitions
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::GetCurrentTransition(const RpcRequest& request) {
+	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "name",
+		obs_source_get_name(currentTransition));
+
+	if (!obs_transition_fixed(currentTransition))
+		obs_data_set_int(response, "duration", obs_frontend_get_transition_duration());
+
+	return request.success(response);
+}
+
+/**
+ * Set the active transition.
+ *
+ * @param {String} `transition-name` The name of the transition.
+ *
+ * @api requests
+ * @name SetCurrentTransition
+ * @category transitions
+ * @since 0.3
+ */
+RpcResponse WSRequestHandler::SetCurrentTransition(const RpcRequest& request) {
+	if (!request.hasField("transition-name")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString name = obs_data_get_string(request.parameters(), "transition-name");
+	bool success = Utils::SetTransitionByName(name);
+	if (!success) {
+		return request.failed("requested transition does not exist");
+	}
+	
+	return request.success();
+}
+
+/**
+ * Set the duration of the currently selected transition if supported.
+ *
+ * @param {int} `duration` Desired duration of the transition (in milliseconds).
+ *
+ * @api requests
+ * @name SetTransitionDuration
+ * @category transitions
+ * @since 4.0.0
+ */
+RpcResponse WSRequestHandler::SetTransitionDuration(const RpcRequest& request) {
+	if (!request.hasField("duration")) {
+		return request.failed("missing request parameters");
+	}
+
+	int ms = obs_data_get_int(request.parameters(), "duration");
+	obs_frontend_set_transition_duration(ms);
+	return request.success();
+}
+
+/**
+ * Get the duration of the currently selected transition if supported.
+ *
+ * @return {int} `transition-duration` Duration of the current transition (in milliseconds).
+ *
+ * @api requests
+ * @name GetTransitionDuration
+ * @category transitions
+ * @since 4.1.0
+ */
+RpcResponse WSRequestHandler::GetTransitionDuration(const RpcRequest& request) {
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_int(response, "transition-duration", obs_frontend_get_transition_duration());
+	return request.success(response);
+}
+
+/**
+ * Get the position of the current transition.
+ *
+ * @return {double} `position` current transition position. This value will be between 0.0 and 1.0. Note: Transition returns 1.0 when not active.
+ *
+ * @api requests
+ * @name GetTransitionPosition
+ * @category transitions
+ * @since 4.8.0
+ */
+RpcResponse WSRequestHandler::GetTransitionPosition(const RpcRequest& request) {
+	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_double(response, "position", obs_transition_get_time(currentTransition));
+
+	return request.success(response);
+}

src/WSServer.cpp

@@ -0,0 +1,247 @@
+/*
+obs-websocket
+Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#include <chrono>
+#include <thread>
+
+#include <QtCore/QThread>
+#include <QtCore/QByteArray>
+#include <QtWidgets/QMainWindow>
+#include <QtWidgets/QMessageBox>
+#include <QtConcurrent/QtConcurrent>
+#include <obs-frontend-api.h>
+#include <util/platform.h>
+
+#include "WSServer.h"
+#include "obs-websocket.h"
+#include "Config.h"
+#include "Utils.h"
+#include "protocol/OBSRemoteProtocol.h"
+
+QT_USE_NAMESPACE
+
+using websocketpp::lib::placeholders::_1;
+using websocketpp::lib::placeholders::_2;
+using websocketpp::lib::bind;
+
+WSServer::WSServer()
+	: QObject(nullptr),
+	  _connections(),
+	  _clMutex(QMutex::Recursive)
+{
+        _server.get_alog().clear_channels(websocketpp::log::alevel::frame_header | websocketpp::log::alevel::frame_payload | websocketpp::log::alevel::control);
+	_server.init_asio();
+#ifndef _WIN32
+	_server.set_reuse_addr(true);
+#endif
+
+	_server.set_open_handler(bind(&WSServer::onOpen, this, ::_1));
+	_server.set_close_handler(bind(&WSServer::onClose, this, ::_1));
+	_server.set_message_handler(bind(&WSServer::onMessage, this, ::_1, ::_2));
+}
+
+WSServer::~WSServer()
+{
+	stop();
+}
+
+void WSServer::start(quint16 port)
+{
+	if (_server.is_listening() && port == _serverPort) {
+		blog(LOG_INFO, "WSServer::start: server already on this port. no restart needed");
+		return;
+	}
+
+	if (_server.is_listening()) {
+		stop();
+	}
+
+	_server.reset();
+
+	_serverPort = port;
+
+	websocketpp::lib::error_code errorCode;
+	_server.listen(_serverPort, errorCode);
+
+	if (errorCode) {
+		std::string errorCodeMessage = errorCode.message();
+		blog(LOG_INFO, "server: listen failed: %s", errorCodeMessage.c_str());
+
+		obs_frontend_push_ui_translation(obs_module_get_string);
+		QString errorTitle = tr("OBSWebsocket.Server.StartFailed.Title");
+		QString errorMessage = tr("OBSWebsocket.Server.StartFailed.Message").arg(_serverPort).arg(errorCodeMessage.c_str());
+		obs_frontend_pop_ui_translation();
+
+		QMainWindow* mainWindow = reinterpret_cast<QMainWindow*>(obs_frontend_get_main_window());
+		QMessageBox::warning(mainWindow, errorTitle, errorMessage);
+
+		return;
+	}
+
+	_server.start_accept();
+
+	QtConcurrent::run([=]() {
+		blog(LOG_INFO, "io thread started");
+		_server.run();
+		blog(LOG_INFO, "io thread exited");
+	});
+
+	blog(LOG_INFO, "server started successfully on port %d", _serverPort);
+}
+
+void WSServer::stop()
+{
+	if (!_server.is_listening()) {
+		return;
+	}
+
+	_server.stop_listening();
+	for (connection_hdl hdl : _connections) {
+		_server.close(hdl, websocketpp::close::status::going_away, "Server stopping");
+	}
+	_connections.clear();
+	_connectionProperties.clear();
+
+	_threadPool.waitForDone();
+
+	while (!_server.stopped()) {
+		std::this_thread::sleep_for(std::chrono::milliseconds(1));
+	}
+
+	blog(LOG_INFO, "server stopped successfully");
+}
+
+void WSServer::broadcast(const RpcEvent& event)
+{
+	OBSRemoteProtocol protocol;
+	std::string message = protocol.encodeEvent(event);
+
+	if (GetConfig()->DebugEnabled) {
+		blog(LOG_INFO, "Update << '%s'", message.c_str());
+	}
+
+	QMutexLocker locker(&_clMutex);
+	for (connection_hdl hdl : _connections) {
+		if (GetConfig()->AuthRequired) {
+			bool authenticated = _connectionProperties[hdl].isAuthenticated();
+			if (!authenticated) {
+				continue;
+			}
+		}
+
+		websocketpp::lib::error_code errorCode;
+		_server.send(hdl, message, websocketpp::frame::opcode::text, errorCode);
+
+		if (errorCode) {
+			std::string errorCodeMessage = errorCode.message();
+			blog(LOG_INFO, "server(broadcast): send failed: %s",
+				errorCodeMessage.c_str());
+		}
+	}
+}
+
+void WSServer::onOpen(connection_hdl hdl)
+{
+	QMutexLocker locker(&_clMutex);
+	_connections.insert(hdl);
+	locker.unlock();
+
+	QString clientIp = getRemoteEndpoint(hdl);
+	notifyConnection(clientIp);
+	blog(LOG_INFO, "new client connection from %s", clientIp.toUtf8().constData());
+}
+
+void WSServer::onMessage(connection_hdl hdl, server::message_ptr message)
+{
+	auto opcode = message->get_opcode();
+	if (opcode != websocketpp::frame::opcode::text) {
+		return;
+	}
+
+	QtConcurrent::run(&_threadPool, [=]() {
+		std::string payload = message->get_payload();
+
+		QMutexLocker locker(&_clMutex);
+		ConnectionProperties& connProperties = _connectionProperties[hdl];
+		locker.unlock();
+
+		if (GetConfig()->DebugEnabled) {
+			blog(LOG_INFO, "Request >> '%s'", payload.c_str());
+		}
+
+		WSRequestHandler requestHandler(connProperties);
+		OBSRemoteProtocol protocol;
+		std::string response = protocol.processMessage(requestHandler, payload);
+
+		if (GetConfig()->DebugEnabled) {
+			blog(LOG_INFO, "Response << '%s'", response.c_str());
+		}
+
+		websocketpp::lib::error_code errorCode;
+		_server.send(hdl, response, websocketpp::frame::opcode::text, errorCode);
+
+		if (errorCode) {
+			std::string errorCodeMessage = errorCode.message();
+			blog(LOG_INFO, "server(response): send failed: %s",
+				errorCodeMessage.c_str());
+		}
+	});
+}
+
+void WSServer::onClose(connection_hdl hdl)
+{
+	QMutexLocker locker(&_clMutex);
+	_connections.erase(hdl);
+	_connectionProperties.erase(hdl);
+	locker.unlock();
+
+	auto conn = _server.get_con_from_hdl(hdl);
+	auto localCloseCode = conn->get_local_close_code();
+
+	if (localCloseCode != websocketpp::close::status::going_away) {
+		QString clientIp = getRemoteEndpoint(hdl);
+		notifyDisconnection(clientIp);
+		blog(LOG_INFO, "client %s disconnected", clientIp.toUtf8().constData());
+	}
+}
+
+QString WSServer::getRemoteEndpoint(connection_hdl hdl)
+{
+	auto conn = _server.get_con_from_hdl(hdl);
+	return QString::fromStdString(conn->get_remote_endpoint());
+}
+
+void WSServer::notifyConnection(QString clientIp)
+{
+	obs_frontend_push_ui_translation(obs_module_get_string);
+	QString title = tr("OBSWebsocket.NotifyConnect.Title");
+	QString msg = tr("OBSWebsocket.NotifyConnect.Message").arg(clientIp);
+	obs_frontend_pop_ui_translation();
+
+	Utils::SysTrayNotify(msg, QSystemTrayIcon::Information, title);
+}
+
+void WSServer::notifyDisconnection(QString clientIp)
+{
+	obs_frontend_push_ui_translation(obs_module_get_string);
+	QString title = tr("OBSWebsocket.NotifyDisconnect.Title");
+	QString msg = tr("OBSWebsocket.NotifyDisconnect.Message").arg(clientIp);
+	obs_frontend_pop_ui_translation();
+
+	Utils::SysTrayNotify(msg, QSystemTrayIcon::Information, title);
+}

src/WSServer.h

@@ -0,0 +1,69 @@
+/*
+obs-websocket
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#pragma once
+
+#include <map>
+#include <set>
+#include <QtCore/QObject>
+#include <QtCore/QMutex>
+#include <QtCore/QSharedPointer>
+#include <QtCore/QVariantHash>
+#include <QtCore/QThreadPool>
+
+#include <websocketpp/config/asio_no_tls.hpp>
+#include <websocketpp/server.hpp>
+
+#include "ConnectionProperties.h"
+#include "WSRequestHandler.h"
+#include "rpc/RpcEvent.h"
+
+using websocketpp::connection_hdl;
+
+typedef websocketpp::server<websocketpp::config::asio> server;
+
+class WSServer : public QObject
+{
+Q_OBJECT
+
+public:
+	explicit WSServer();
+	virtual ~WSServer();
+	void start(quint16 port);
+	void stop();
+	void broadcast(const RpcEvent& event);
+	QThreadPool* threadPool() {
+		return &_threadPool;
+	}
+
+private:
+	void onOpen(connection_hdl hdl);
+	void onMessage(connection_hdl hdl, server::message_ptr message);
+	void onClose(connection_hdl hdl);
+
+	QString getRemoteEndpoint(connection_hdl hdl);
+	void notifyConnection(QString clientIp);
+	void notifyDisconnection(QString clientIp);
+
+	server _server;
+	quint16 _serverPort;
+	std::set<connection_hdl, std::owner_less<connection_hdl>> _connections;
+	std::map<connection_hdl, ConnectionProperties, std::owner_less<connection_hdl>> _connectionProperties;
+	QMutex _clMutex;
+	QThreadPool _threadPool;
+};

src/forms/settings-dialog.cpp

@@ -0,0 +1,106 @@
+/*
+obs-websocket
+Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#include <obs-frontend-api.h>
+
+#include "../obs-websocket.h"
+#include "../Config.h"
+#include "../WSServer.h"
+#include "settings-dialog.h"
+
+#define CHANGE_ME "changeme"
+
+SettingsDialog::SettingsDialog(QWidget* parent) :
+	QDialog(parent, Qt::Dialog),
+	ui(new Ui::SettingsDialog)
+{
+	ui->setupUi(this);
+
+	connect(ui->authRequired, &QCheckBox::stateChanged,
+		this, &SettingsDialog::AuthCheckboxChanged);
+	connect(ui->buttonBox, &QDialogButtonBox::accepted,
+		this, &SettingsDialog::FormAccepted);
+
+
+	AuthCheckboxChanged();
+}
+
+void SettingsDialog::showEvent(QShowEvent* event) {
+	auto conf = GetConfig();
+
+	ui->serverEnabled->setChecked(conf->ServerEnabled);
+	ui->serverPort->setValue(conf->ServerPort);
+
+	ui->debugEnabled->setChecked(conf->DebugEnabled);
+	ui->alertsEnabled->setChecked(conf->AlertsEnabled);
+
+	ui->authRequired->setChecked(conf->AuthRequired);
+	ui->password->setText(CHANGE_ME);
+}
+
+void SettingsDialog::ToggleShowHide() {
+	if (!isVisible())
+		setVisible(true);
+	else
+		setVisible(false);
+}
+
+void SettingsDialog::AuthCheckboxChanged() {
+	if (ui->authRequired->isChecked())
+		ui->password->setEnabled(true);
+	else
+		ui->password->setEnabled(false);
+}
+
+void SettingsDialog::FormAccepted() {
+	auto conf = GetConfig();
+
+	conf->ServerEnabled = ui->serverEnabled->isChecked();
+	conf->ServerPort = ui->serverPort->value();
+
+	conf->DebugEnabled = ui->debugEnabled->isChecked();
+	conf->AlertsEnabled = ui->alertsEnabled->isChecked();
+
+	if (ui->authRequired->isChecked()) {
+		if (ui->password->text() != CHANGE_ME) {
+			conf->SetPassword(ui->password->text());
+		}
+
+		if (!GetConfig()->Secret.isEmpty())
+			conf->AuthRequired = true;
+		else
+			conf->AuthRequired = false;
+	}
+	else
+	{
+		conf->AuthRequired = false;
+	}
+
+	conf->Save();
+
+	auto server = GetServer();
+	if (conf->ServerEnabled) {
+		server->start(conf->ServerPort);
+	} else {
+		server->stop();
+	}
+}
+
+SettingsDialog::~SettingsDialog() {
+	delete ui;
+}

src/forms/settings-dialog.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,23 +16,20 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef SETTINGSDIALOG_H
-#define SETTINGSDIALOG_H
+#pragma once
 
-#include <QDialog>
+#include <QtWidgets/QDialog>
 
-namespace Ui {
-class SettingsDialog;
-}
+#include "ui_settings-dialog.h"
 
 class SettingsDialog : public QDialog
 {
-    Q_OBJECT
+	Q_OBJECT
 
 public:
-    explicit SettingsDialog(QWidget *parent = 0);
-    ~SettingsDialog();
-	void showEvent(QShowEvent *event);
+	explicit SettingsDialog(QWidget* parent = 0);
+	~SettingsDialog();
+	void showEvent(QShowEvent* event);
 	void ToggleShowHide();
 
 private Q_SLOTS:
@@ -40,7 +37,5 @@ private Q_SLOTS:
 	void FormAccepted();
 
 private:
-    Ui::SettingsDialog *ui;
+	Ui::SettingsDialog* ui;
 };
-
-#endif // SETTINGSDIALOG_H

src/forms/settings-dialog.ui

@@ -0,0 +1,151 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>SettingsDialog</class>
+ <widget class="QDialog" name="SettingsDialog">
+	<property name="geometry">
+	 <rect>
+		<x>0</x>
+		<y>0</y>
+		<width>407</width>
+		<height>195</height>
+	 </rect>
+	</property>
+	<property name="sizePolicy">
+	 <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
+		<horstretch>0</horstretch>
+		<verstretch>0</verstretch>
+	 </sizepolicy>
+	</property>
+	<property name="windowTitle">
+	 <string>OBSWebsocket.Settings.DialogTitle</string>
+	</property>
+	<property name="sizeGripEnabled">
+	 <bool>false</bool>
+	</property>
+	<layout class="QVBoxLayout" name="verticalLayout">
+	 <property name="sizeConstraint">
+		<enum>QLayout::SetDefaultConstraint</enum>
+	 </property>
+	 <item>
+		<layout class="QFormLayout" name="formLayout">
+		 <item row="3" column="1">
+			<widget class="QCheckBox" name="authRequired">
+			 <property name="text">
+				<string>OBSWebsocket.Settings.AuthRequired</string>
+			 </property>
+			</widget>
+		 </item>
+		 <item row="4" column="0">
+			<widget class="QLabel" name="lbl_password">
+			 <property name="text">
+				<string>OBSWebsocket.Settings.Password</string>
+			 </property>
+			</widget>
+		 </item>
+		 <item row="4" column="1">
+			<widget class="QLineEdit" name="password">
+			 <property name="echoMode">
+				<enum>QLineEdit::Password</enum>
+			 </property>
+			</widget>
+		 </item>
+		 <item row="1" column="1">
+			<widget class="QCheckBox" name="serverEnabled">
+			 <property name="text">
+				<string>OBSWebsocket.Settings.ServerEnable</string>
+			 </property>
+			 <property name="checked">
+				<bool>true</bool>
+			 </property>
+			</widget>
+		 </item>
+		 <item row="2" column="0">
+			<widget class="QLabel" name="lbl_serverPort">
+			 <property name="text">
+				<string>OBSWebsocket.Settings.ServerPort</string>
+			 </property>
+			</widget>
+		 </item>
+		 <item row="2" column="1">
+			<widget class="QSpinBox" name="serverPort">
+			 <property name="minimum">
+				<number>1024</number>
+			 </property>
+			 <property name="maximum">
+				<number>65535</number>
+			 </property>
+			 <property name="value">
+				<number>4444</number>
+			 </property>
+			</widget>
+		 </item>
+		 <item row="5" column="1">
+			 <widget class="QCheckBox" name="alertsEnabled">
+				 <property name="text">
+					 <string>OBSWebsocket.Settings.AlertsEnable</string>
+				 </property>
+				 <property name="checked">
+					 <bool>true</bool>
+				 </property>
+			 </widget>
+		 </item>
+		 <item row="6" column="1">
+			 <widget class="QCheckBox" name="debugEnabled">
+				 <property name="text">
+					 <string>OBSWebsocket.Settings.DebugEnable</string>
+				 </property>
+				 <property name="checked">
+					 <bool>false</bool>
+				 </property>
+			 </widget>
+		 </item>
+		</layout>
+	 </item>
+	 <item>
+		<widget class="QDialogButtonBox" name="buttonBox">
+		 <property name="orientation">
+			<enum>Qt::Horizontal</enum>
+		 </property>
+		 <property name="standardButtons">
+			<set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+		 </property>
+		</widget>
+	 </item>
+	</layout>
+ </widget>
+ <resources/>
+ <connections>
+	<connection>
+	 <sender>buttonBox</sender>
+	 <signal>accepted()</signal>
+	 <receiver>SettingsDialog</receiver>
+	 <slot>accept()</slot>
+	 <hints>
+		<hint type="sourcelabel">
+		 <x>248</x>
+		 <y>294</y>
+		</hint>
+		<hint type="destinationlabel">
+		 <x>157</x>
+		 <y>314</y>
+		</hint>
+	 </hints>
+	</connection>
+	<connection>
+	 <sender>buttonBox</sender>
+	 <signal>rejected()</signal>
+	 <receiver>SettingsDialog</receiver>
+	 <slot>reject()</slot>
+	 <hints>
+		<hint type="sourcelabel">
+		 <x>316</x>
+		 <y>300</y>
+		</hint>
+		<hint type="destinationlabel">
+		 <x>286</x>
+		 <y>314</y>
+		</hint>
+	 </hints>
+	</connection>
+ </connections>
+</ui>