Merge pull request #330 from Palakis/transitionbegin-hotfix

Fix TransitionBegin event

.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/ISSUE_TEMPLATE.md

@@ -1,18 +1,16 @@
-#### Issue type
-- [ ] Bug
-- [ ] Feature request
-- [ ] Other
+##### Issue type
+Bug report? Feature request? Other?
 
-#### Description
+##### Description
 *Replace this with a description of the bug encountered or feature requested.*
 
-#### Steps to reproduce
-*If it's a bug, please describe the steps to reproduce it. Otherwise, remove this section.*
+##### 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
+##### Technical information
 - **Operating System** :
 - **OBS Studio version** :
 
-#### Development Environment
+##### 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

@@ -5,3 +5,5 @@
 /build64/
 /release/
 /installer/Output/
+
+.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

.travis.yml

@@ -1,4 +1,5 @@
 language: cpp
+
 env:
   global:
   # AWS key ID
@@ -6,9 +7,18 @@ env:
   # AWS key secret
   - secure: bGwljoP3E1OVBXLXox0O6p8kwQXLcNQ8YDKVa4H8u9Y+Ic7uqE4iV3rYS3ynNWSBMVRWY3ZbyClnhrCNwRhBAlcd8qWSJdpjVzs6HdQyzhuKa1P3V4FJPb7upGP/5R/DECGwex8Mun9dmXpYDak75LxfKIJUidPis5VDCYqul7k/xVVCou6Ctjpj7vQhWXDj2G/py+mdB8DERhymnQCtyK1Ziu8c4QlFKByZmnD72GFm/h3JPI1Pq1V2mz3x6x6GaYjb9Rdbd0UNwqjGQX4q2M/c3GEJa6B2JBCoTncawNZBNnPUF9qtv+zh0TNaNHMRWX13AJ/qYB+nVDub0C9b/6Mc48mt0Tv4ze15MproVrylZdV6qHYEG8yGPBqpTVbRP6gv6Y2TXIHWoTzqA+F/Gv2IDChyHXsld/MQQS2MSo5iaYktIrZKtX8Z0qAmTzPwIVBromaSI3vrE7UH0fRSQ6fAM8+Tn+MRthOBdqu23kS1dnG+X2CPbUhBfsJp0OSwVQD5jQtA51/sREVeGFiJvzQIkvwQDjb5MYilsRnwmoBXemkLmqaviXVY4rz1o5AIvz2pgZS2YggK1xHZCuI5tSjcNEkb77VwZTfsqrdDo9EJh6VgfdnGlHQhR2/A5hUJ4ANpJ/LgZlgfVp71Xg2GWQW6M4Znc5uj6A6xLBkO6FA=
 
+cache:
+  directories:
+  - node_modules
+
 matrix:
   include:
   - os: linux
+    env: _generate_docs
+    script: "./CI/generate-docs.sh"
+
+  - os: linux
+    env: _linux_build
     dist: trusty
     sudo: required
     services:
@@ -22,12 +32,6 @@ matrix:
     after_success:
     - docker exec -it xenial /root/obs-websocket/CI/package-xenial.sh
 
-  - os: osx
-    osx_image: xcode8.3
-    before_install: "./CI/install-dependencies-osx.sh"
-    script: "./CI/build-osx.sh"
-    after_success: "./CI/package-osx.sh"
-
 deploy:
 - provider: s3
   region: eu-central-1
@@ -39,17 +43,7 @@ deploy:
   acl: public_read
   on:
     repo: Palakis/obs-websocket
-    condition: "$TRAVIS_OS_NAME = linux"
-    all_branches: true
-- provider: s3
-  region: eu-central-1
-  bucket: obs-websocket-osx-builds
-  access_key_id: "$AWS_ID"
-  secret_access_key: "$AWS_SECRET"
-  local_dir: release
-  skip_cleanup: true
-  acl: public_read
-  on:
-    repo: Palakis/obs-websocket
-    condition: "$TRAVIS_OS_NAME = osx"
+    condition:
+    - "$TRAVIS_OS_NAME = linux"
+    - "-d /home/travis/package"
     all_branches: true

BUILDING.md

@@ -1,18 +1,26 @@
 # Compiling obs-websocket
+
 ## Prerequisites
-You'll need [QT 5.7.0](https://download.qt.io/official_releases/qt/5.7/5.7.0/), CMake, and a working development environment for OBS Studio installed on your computer. 
+
+You'll need [Qt 5.10.x](https://download.qt.io/official_releases/qt/5.10/),
+[CMake](https://cmake.org/download/), [Boost](https://www.boost.org/) 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 :
-```
-sudo apt-get install libqt5websockets5-dev
+
+```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
@@ -22,8 +30,33 @@ sudo make install
 ```
 
 ## OS X
-*To do*
+
+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 & OS X : [![Automated Build status for Linux & OS X](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
+- 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-osx.sh

@@ -1,11 +0,0 @@
-#!/bin/sh
-set -ex
-
-mkdir build && cd build
-
-cmake .. \
-  -DQTDIR=/usr/local/opt/qt5 \
-  -DLIBOBS_INCLUDE_DIR=../../obs-studio/libobs \
-  -DOBS_FRONTEND_LIB="$(pwd)/../../obs-studio/build/UI/obs-frontend-api/libobs-frontend-api.dylib" \
-  -DCMAKE_INSTALL_PREFIX=/usr \
-&& make -j4

CI/build-xenial.sh

@@ -4,5 +4,5 @@ set -ex
 cd /root/obs-websocket
 
 mkdir build && cd build
-cmake -DLIBOBS_INCLUDE_DIR="../../obs-studio/libobs" -DCMAKE_INSTALL_PREFIX=/usr ..
+cmake -DCMAKE_INSTALL_PREFIX=/usr ..
 make -j4

CI/generate-docs.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+set -e
+echo "-- Generating documentation."
+echo "-- Node version: $(node -v)"
+echo "-- NPM version: $(npm -v)"
+
+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
+
+if [ "$TRAVIS_PULL_REQUEST" != "false" -o "$TRAVIS_BRANCH" != "4.x-current" ]; then
+	echo "-- Skipping documentation deployment because this is either a pull request or a non-master branch."
+	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 "Travis CI"
+git config user.email "$COMMIT_AUTHOR_EMAIL"
+
+git add ./generated
+git pull
+git commit -m "docs(travis): Update protocol.md - $(git rev-parse --short HEAD) [skip ci]"
+git push -q $GITHUB_REPO HEAD:$TRAVIS_BRANCH

CI/install-build-obs-macos.sh

@@ -0,0 +1,43 @@
+#!/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 .. \
+	-DBUILD_CAPTIONS=true \
+	-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-build-obs.cmd

@@ -0,0 +1,129 @@
+@echo off
+SETLOCAL EnableDelayedExpansion
+
+REM Check if obs-studio build exists.
+REM If the obs-studio directory does exist, check if the last OBS tag built
+REM matches the latest OBS tag.
+REM If the tags match, do not build obs-studio.
+REM If the tags do not match, build obs-studio.
+REM If the obs-studio directory doesn't exist, build obs-studio.
+echo Checking for obs-studio build...
+
+set OBSLatestTagPrePull=0
+set OBSLatestTagPostPull=0
+echo Latest tag pre-pull: %OBSLatestTagPrePull%
+echo Latest tag post-pull: %OBSLatestTagPostPull%
+
+REM Set up the build flag as undefined.
+set "BuildOBS="
+
+REM Check the last tag successfully built by CI.
+if exist C:\projects\obs-studio-last-tag-built.txt (
+	set /p OBSLastTagBuilt=<C:\projects\obs-studio-last-tag-built.txt
+) else (
+	set OBSLastTagBuilt=0
+)
+
+REM If obs-studio directory exists, run git pull and get the latest tag number.
+if exist C:\projects\obs-studio\ (
+	echo obs-studio directory exists
+	echo   Updating tag info
+	cd C:\projects\obs-studio\
+	git describe --tags --abbrev=0 > C:\projects\latest-obs-studio-tag-pre-pull.txt
+	set /p OBSLatestTagPrePull=<C:\projects\latest-obs-studio-tag-pre-pull.txt
+	git checkout master
+	git pull
+	git describe --tags --abbrev=0 > C:\projects\latest-obs-studio-tag-post-pull.txt
+	set /p OBSLatestTagPostPull=<C:\projects\latest-obs-studio-tag-post-pull.txt
+	set /p OBSLatestTag=<C:\projects\latest-obs-studio-tag-post-pull.txt
+	echo %OBSLatestTagPostPull%> C:\projects\latest-obs-studio-tag.txt
+)
+
+REM Check the obs-studio tags for mismatches.
+REM If a new tag was pulled, set the build flag.
+if not %OBSLatestTagPrePull%==%OBSLatestTagPostPull% (
+	echo Latest tag pre-pull: %OBSLatestTagPrePull%
+	echo Latest tag post-pull: %OBSLatestTagPostPull%
+	echo Tags do not match.  Need to rebuild OBS.
+	set BuildOBS=true
+)
+
+REM If the latest git tag doesn't match the last built tag, set the build flag.
+if not %OBSLatestTagPostPull%==%OBSLastTagBuilt% (
+	echo Last built OBS tag: %OBSLastTagBuilt%
+	echo Latest tag post-pull: %OBSLatestTagPostPull%
+	echo Tags do not match.  Need to rebuild OBS.
+	set BuildOBS=true
+)
+
+REM If obs-studio directory does not exist, clone the git repo, get the latest
+REM tag number, and set the build flag.
+if not exist C:\projects\obs-studio (
+	echo obs-studio directory does not exist
+	git clone https://github.com/obsproject/obs-studio
+	cd C:\projects\obs-studio\
+	git describe --tags --abbrev=0 > C:\projects\obs-studio-latest-tag.txt
+	set /p OBSLatestTag=<C:\projects\obs-studio-latest-tag.txt
+	set BuildOBS=true
+)
+
+REM If the needed obs-studio libs for this build_config do not exist,
+REM set the build flag.
+if not exist C:\projects\obs-studio\build32\libobs\%build_config%\obs.lib (
+	echo obs-studio\build32\libobs\%build_config%\obs.lib does not exist
+	set BuildOBS=true
+)
+if not exist C:\projects\obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib (
+	echo obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib does not exist
+	set BuildOBS=true
+)
+
+REM Some debug info
+echo:
+echo Latest tag pre-pull: %OBSLatestTagPrePull%
+echo Latest tag post-pull: %OBSLatestTagPostPull%
+echo Latest tag: %OBSLatestTag%
+echo Last built OBS tag: %OBSLastTagBuilt%
+
+if defined BuildOBS (
+	echo BuildOBS: true
+) else (
+	echo BuildOBS: false
+)
+echo:
+
+REM If the build flag is set, build obs-studio.
+if defined BuildOBS (
+	echo Building obs-studio...
+	echo   git checkout %OBSLatestTag%
+	git checkout %OBSLatestTag%
+	echo:
+	echo   Removing previous build dirs...
+	if exist build rmdir /s /q C:\projects\obs-studio\build
+	if exist build32 rmdir /s /q C:\projects\obs-studio\build32
+	if exist build64 rmdir /s /q C:\projects\obs-studio\build64
+	echo   Making new build dirs...
+	mkdir build
+	mkdir build32
+	mkdir build64
+	echo   Running cmake for obs-studio %OBSLatestTag% 32-bit...
+	cd ./build32
+	cmake -G "Visual Studio 14 2015" -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 14 2015 Win64" -DBUILD_CAPTIONS=true -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
+	echo:
+	echo:
+	echo   Building obs-studio %OBSLatestTag% 32-bit ^(Build Config: %build_config%^)...
+	call msbuild /m /p:Configuration=%build_config% C:\projects\obs-studio\build32\obs-studio.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
+	echo   Building obs-studio %OBSLatestTag% 64-bit ^(Build Config: %build_config%^)...
+	call msbuild /m /p:Configuration=%build_config% C:\projects\obs-studio\build64\obs-studio.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
+	cd ..
+	git describe --tags --abbrev=0 > C:\projects\obs-studio-last-tag-built.txt
+	set /p OBSLastTagBuilt=<C:\projects\obs-studio-last-tag-built.txt
+) else (
+	echo Last OBS tag built is:  %OBSLastTagBuilt%
+	echo No need to rebuild OBS.
+)

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-osx.sh

@@ -1,27 +0,0 @@
-#!/bin/sh
-set -ex
-
-# OBS Studio deps
-brew update
-brew install ffmpeg
-brew install libav
-
-# qtwebsockets deps
-brew install https://raw.githubusercontent.com/Homebrew/homebrew-core/fdb7c6e960e830b3bf630850c0002c5df9f68ed8/Formula/qt5.rb
-
-# Build obs-studio
-cd ..
-git clone --recursive https://github.com/jp9000/obs-studio
-cd obs-studio
-git checkout 19.0.2
-mkdir build && cd build
-cmake .. \
-  -DCMAKE_PREFIX_PATH=/usr/local/opt/qt5/lib/cmake \
-&& make -j4
-
-sudo make install
-
-# Packages app
-cd ..
-curl -L -O https://www.slepin.fr/obs-websocket/ci/Packages.pkg -f --retry 5 -C -
-sudo installer -pkg ./Packages.pkg -target /

CI/install-dependencies-xenial.sh

@@ -1,57 +1,19 @@
 #!/bin/sh
 set -ex
 
-# OBS Studio deps
+add-apt-repository -y ppa:obsproject/obs-studio
 apt-get -qq update
-apt-get install -y \
-        libc-dev-bin libc6-dev \
-        git \
-        build-essential
 
 apt-get install -y \
+	libc-dev-bin \
+	libc6-dev git \
 	build-essential \
 	checkinstall \
 	cmake \
-        libasound2-dev \
-        libavcodec-dev \
-        libavdevice-dev \
-        libavfilter-dev \
-        libavformat-dev \
-        libavutil-dev \
-        libcurl4-openssl-dev \
-        libfontconfig-dev \
-        libfreetype6-dev \
-        libgl1-mesa-dev \
-        libjack-jackd2-dev \
-        libjansson-dev \
-        libpulse-dev \
-        libqt5x11extras5-dev \
-        libspeexdsp-dev \
-        libswresample-dev \
-        libswscale-dev \
-        libudev-dev \
-        libv4l-dev \
-        libvlc-dev \
-        libx11-dev \
-        libx264-dev \
-        libxcb-shm0-dev \
-        libxcb-xinerama0-dev \
-        libxcomposite-dev \
-        libxinerama-dev \
-        pkg-config \
+	obs-studio \
 	qtbase5-dev
 
-# obs-websocket deps
-apt-get install -y libqt5websockets5-dev
-
-# Build obs-studio
-cd /root
-git clone https://github.com/jp9000/obs-studio ./obs-studio
-cd obs-studio
-git checkout 19.0.2
-mkdir build && cd build
-cmake -DUNIX_STRUCTURE=1 -DCMAKE_INSTALL_PREFIX=/usr ..
-make -j4
-make install
+# Dirty hack
+wget -O /usr/include/obs/obs-frontend-api.h https://raw.githubusercontent.com/obsproject/obs-studio/master/UI/obs-frontend-api/obs-frontend-api.h
 
 ldconfig

CI/install-setup-qt.cmd

@@ -0,0 +1,6 @@
+@echo off
+
+REM Set default values to use AppVeyor's built-in Qt.
+set QTDIR32=C:\Qt\5.10.1\msvc2015
+set QTDIR64=C:\Qt\5.10.1\msvc2015_64
+set QTCompileVersion=5.10.1

CI/macos/obs-websocket.pkgproj

@@ -12,123 +12,6 @@
 			<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/QtNetwork</string>
-																<key>PATH_TYPE</key>
-																<integer>1</integer>
-																<key>PERMISSIONS</key>
-																<integer>292</integer>
-																<key>TYPE</key>
-																<integer>3</integer>
-																<key>UID</key>
-																<integer>0</integer>
-															</dict>
-															<dict>
-																<key>CHILDREN</key>
-																<array/>
-																<key>GID</key>
-																<integer>80</integer>
-																<key>PATH</key>
-																<string>../../build/QtWebSockets</string>
-																<key>PATH_TYPE</key>
-																<integer>1</integer>
-																<key>PERMISSIONS</key>
-																<integer>292</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>509</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>Resources</string>
-												<key>PATH_TYPE</key>
-												<integer>0</integer>
-												<key>PERMISSIONS</key>
-												<integer>509</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>Contents</string>
-										<key>PATH_TYPE</key>
-										<integer>0</integer>
-										<key>PERMISSIONS</key>
-										<integer>509</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.app</string>
-								<key>PATH_TYPE</key>
-								<integer>0</integer>
-								<key>PERMISSIONS</key>
-								<integer>509</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>Applications</string>
-						<key>PATH_TYPE</key>
-						<integer>0</integer>
-						<key>PERMISSIONS</key>
-						<integer>509</integer>
-						<key>TYPE</key>
-						<integer>1</integer>
-						<key>UID</key>
-						<integer>0</integer>
-					</dict>
 					<dict>
 						<key>CHILDREN</key>
 						<array>
@@ -635,7 +518,7 @@
 			<key>OVERWRITE_PERMISSIONS</key>
 			<false/>
 			<key>VERSION</key>
-			<string>4.0.0</string>
+			<string>4.6.1</string>
 		</dict>
 		<key>PROJECT_COMMENTS</key>
 		<dict>

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,40 @@
+#!/bin/sh
+
+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)"
+
+export GIT_HASH=$(git rev-parse --short HEAD)
+export GIT_BRANCH_OR_TAG=$(git name-rev --name-only HEAD | awk -F/ '{print $NF}')
+
+export VERSION="$GIT_HASH-$GIT_BRANCH_OR_TAG"
+export LATEST_VERSION="$GIT_BRANCH_OR_TAG"
+
+export FILENAME="obs-websocket-$VERSION.pkg"
+export LATEST_FILENAME="obs-websocket-latest-$LATEST_VERSION.pkg"
+
+echo "[obs-websocket] Modifying obs-websocket.so"
+install_name_tool \
+	-change /usr/local/opt/qt/lib/QtWidgets.framework/Versions/5/QtWidgets @rpath/QtWidgets \
+	-change /usr/local/opt/qt/lib/QtGui.framework/Versions/5/QtGui @rpath/QtGui \
+	-change /usr/local/opt/qt/lib/QtCore.framework/Versions/5/QtCore @rpath/QtCore \
+	./build/obs-websocket.so
+
+# Check if replacement worked
+echo "[obs-websocket] Dependencies for obs-websocket"
+otool -L ./build/obs-websocket.so
+
+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
+cp ./release/$FILENAME ./release/$LATEST_FILENAME

CI/package-osx.sh

@@ -1,59 +0,0 @@
-#!/bin/sh
-
-set -e
-
-echo "-- Preparing package build"
-export QT_PREFIX="/usr/local/opt/qt5"
-
-export WS_LIB="$QT_PREFIX/lib/QtWebSockets.framework/QtWebSockets"
-export NET_LIB="$QT_PREFIX/lib/QtNetwork.framework/QtNetwork"
-
-export GIT_HASH=$(git rev-parse --short HEAD)
-
-export VERSION="$GIT_HASH-$TRAVIS_BRANCH"
-export LATEST_VERSION="$TRAVIS_BRANCH"
-if [ -n "${TRAVIS_TAG}" ]; then
-	export VERSION="$TRAVIS_TAG"
-	export LATEST_VERSION="$TRAVIS_TAG"
-fi
-
-export FILENAME="obs-websocket-$VERSION.pkg"
-export LATEST_FILENAME="obs-websocket-latest-$LATEST_VERSION.pkg"
-
-echo "-- Copying Qt dependencies"
-cp $WS_LIB ./build
-cp $NET_LIB ./build
-
-chmod +rw ./build/QtWebSockets ./build/QtNetwork
-
-echo "-- Modifying QtNetwork"
-# TODO : put a loop in there
-install_name_tool \
-	-change /usr/local/opt/qt/lib/QtNetwork.framework/Versions/5/QtNetwork @rpath/QtNetwork \
-	-change /usr/local/opt/qt/lib/QtCore.framework/Versions/5/QtCore @rpath/QtCore \
-	./build/QtNetwork
-
-echo "-- Modifying QtWebSockets"
-install_name_tool \
-	-change /usr/local/opt/qt/lib/QtWebSockets.framework/Versions/5/QtWebSockets @rpath/QtWebSockets \
-	-change /usr/local/opt/qt/lib/QtNetwork.framework/Versions/5/QtNetwork @rpath/QtNetwork \
-	-change /usr/local/opt/qt/lib/QtCore.framework/Versions/5/QtCore @rpath/QtCore \
-	./build/QtWebSockets
-
-echo "-- Modifying obs-websocket.so"
-install_name_tool \
-	-change "$QT_PREFIX/lib/QtWebSockets.framework/Versions/5/QtWebSockets" @rpath/QtWebSockets \
-	-change "$QT_PREFIX/lib/QtWidgets.framework/Versions/5/QtWidgets" @rpath/QtWidgets \
-	-change "$QT_PREFIX/lib/QtNetwork.framework/Versions/5/QtNetwork" @rpath/QtNetwork \
-	-change "$QT_PREFIX/lib/QtGui.framework/Versions/5/QtGui" @rpath/QtGui \
-	-change "$QT_PREFIX/lib/QtCore.framework/Versions/5/QtCore" @rpath/QtCore \
-	./build/obs-websocket.so
-
-chmod -w ./build/QtWebSockets ./build/QtNetwork
-
-echo "-- Actual package build"
-packagesbuild ./CI/osx/obs-websocket.pkgproj
-
-echo "-- Renaming obs-websocket.pkg to $FILENAME"
-mv ./release/obs-websocket.pkg ./release/$FILENAME
-cp ./release/$FILENAME ./release/$LATEST_FILENAME

CI/package-xenial.sh

@@ -17,7 +17,7 @@ PAGER=cat checkinstall -y --type=debian --fstrans=no --nodoc \
 	--backup=no --deldoc=yes --install=no \
 	--pkgname=obs-websocket --pkgversion="$PKG_VERSION" \
 	--pkglicense="GPLv2.0" --maintainer="contact@slepin.fr" \
-	--requires="libqt5websockets5" --pkggroup="video" \
+	--pkggroup="video" \
 	--pkgsource="https://github.com/Palakis/obs-websocket" \
 	--pakdir="/package"
 

CMakeLists.txt

@@ -6,55 +6,73 @@ set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTOUIC ON)
 
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+if (WIN32 OR APPLE)
 include(external/FindLibObs.cmake)
+endif()
+
+add_definitions(-DASIO_STANDALONE)
+
+if (UNIX)
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+endif()
+
+if (WIN32 OR APPLE)
+	include(external/FindLibObs.cmake)
+endif()
 
 find_package(LibObs REQUIRED)
 find_package(Qt5Core REQUIRED)
-find_package(Qt5WebSockets REQUIRED)
 find_package(Qt5Widgets REQUIRED)
 
-add_subdirectory(deps/mbedtls EXCLUDE_FROM_ALL)
-set(ENABLE_PROGRAMS false)
-
 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/WSEvents.cpp
+	src/Config.cpp
+	src/Utils.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/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
 	Qt5::Core
-	Qt5::WebSockets
-	Qt5::Widgets
-	mbedcrypto)
+	Qt5::Widgets)
 
 # --- End of section ---
 
@@ -62,35 +80,32 @@ target_link_libraries(obs-websocket
 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 !")
+		message(FATAL_ERROR "Could not find OBS Frontend API's library !")
 	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}")
 
-	add_custom_command(TARGET obs-websocket POST_BUILD
-		COMMAND if $<CONFIG:Release>==1 ("${CMAKE_COMMAND}" -E copy
-			"${QTDIR}/bin/Qt5WebSockets.dll"
-			"${QTDIR}/bin/Qt5Network.dll"
-			"${CMAKE_BINARY_DIR}/$<CONFIG>")
-
-		COMMAND if $<CONFIG:Debug>==1 ("${CMAKE_COMMAND}" -E copy
-			"${QTDIR}/bin/Qt5WebSocketsd.dll"
-			"${QTDIR}/bin/Qt5Networkd.dll"
-			"${CMAKE_BINARY_DIR}/$<CONFIG>")
-	)
-
 	# --- Release package helper ---
 	# The "release" folder has a structure similar OBS' one on Windows
 	set(RELEASE_DIR "${PROJECT_SOURCE_DIR}/release")
 
-	if(CMAKE_SIZEOF_VOID_P EQUAL 8)
-		set(ARCH_NAME "64bit")
-	else()
-		set(ARCH_NAME "32bit")
-	endif()
-
 	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"
@@ -102,9 +117,45 @@ if(WIN32)
 
 		COMMAND if $<CONFIG:Release>==1 ("${CMAKE_COMMAND}" -E copy
 			"$<TARGET_FILE:obs-websocket>"
-			"${QTDIR}/bin/Qt5WebSockets.dll" 
-			"${QTDIR}/bin/Qt5Network.dll" 
 			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+
+		# 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 ---
 
@@ -113,17 +164,18 @@ endif()
 
 # --- Linux-specific build settings and tasks ---
 if(UNIX AND NOT APPLE)
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
-
-	target_compile_options(mbedcrypto PRIVATE -fPIC)
 	set_target_properties(obs-websocket PROPERTIES PREFIX "")
-	target_link_libraries(obs-websocket
-		obs-frontend-api)
+	target_link_libraries(obs-websocket obs-frontend-api)
 
 	file(GLOB locale_files data/locale/*.ini)
+	execute_process(COMMAND uname -m COMMAND tr -d '\n' OUTPUT_VARIABLE UNAME_MACHINE)
 
 	install(TARGETS obs-websocket
 		LIBRARY DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/obs-plugins")
+	# Dirty fix for Ubuntu
+        install(TARGETS obs-websocket
+                LIBRARY DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/${UNAME_MACHINE}-linux-gnu/obs-plugins")
+
 	install(FILES ${locale_files}
 		DESTINATION "${CMAKE_INSTALL_PREFIX}/share/obs/obs-plugins/obs-websocket/locale")
 endif()
@@ -133,6 +185,7 @@ endif()
 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()

Config.cpp

@@ -1,199 +0,0 @@
-/*
-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 <mbedtls/base64.h>
-#include <mbedtls/sha256.h>
-#include <obs-frontend-api.h>
-#include <util/config-file.h>
-#include <string>
-
-#include "Config.h"
-
-#define SECTION_NAME "WebsocketAPI"
-#define PARAM_ENABLE "ServerEnabled"
-#define PARAM_PORT "ServerPort"
-#define PARAM_DEBUG "DebugEnabled"
-#define PARAM_AUTHREQUIRED "AuthRequired"
-#define PARAM_SECRET "AuthSecret"
-#define PARAM_SALT "AuthSalt"
-
-Config *Config::_instance = new Config();
-
-Config::Config()
-{
-	// Default settings
-	ServerEnabled = true;
-	ServerPort = 4444;
-	
-	DebugEnabled = false;
-
-	AuthRequired = false;
-	Secret = "";
-	Salt = "";
-	SettingsLoaded = false;
-
-	// OBS Config defaults
-	config_t* obs_config = obs_frontend_get_global_config();
-	if (obs_config)
-	{
-		config_set_default_bool(obs_config, 
-			SECTION_NAME, PARAM_ENABLE, ServerEnabled);
-		config_set_default_uint(obs_config, 
-			SECTION_NAME, PARAM_PORT, ServerPort);
-			
-		config_set_default_bool(obs_config,
-			SECTION_NAME, PARAM_DEBUG, DebugEnabled);
-
-		config_set_default_bool(obs_config, 
-			SECTION_NAME, PARAM_AUTHREQUIRED, AuthRequired);
-		config_set_default_string(obs_config, 
-			SECTION_NAME, PARAM_SECRET, Secret);
-		config_set_default_string(obs_config, 
-			SECTION_NAME, PARAM_SALT, Salt);
-	}
-
-	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);
-}
-
-void Config::Load()
-{
-	config_t* obs_config = obs_frontend_get_global_config();
-
-	ServerEnabled = config_get_bool(obs_config, SECTION_NAME, PARAM_ENABLE);
-	ServerPort = config_get_uint(obs_config, SECTION_NAME, PARAM_PORT);
-	
-	DebugEnabled = config_get_bool(obs_config, SECTION_NAME, PARAM_DEBUG);
-
-	AuthRequired = config_get_bool(obs_config, SECTION_NAME, PARAM_AUTHREQUIRED);
-	Secret = config_get_string(obs_config, SECTION_NAME, PARAM_SECRET);
-	Salt = config_get_string(obs_config, SECTION_NAME, PARAM_SALT);
-}
-
-void Config::Save()
-{
-	config_t* obs_config = obs_frontend_get_global_config();
-
-	config_set_bool(obs_config, SECTION_NAME, PARAM_ENABLE, ServerEnabled);
-	config_set_uint(obs_config, SECTION_NAME, PARAM_PORT, ServerPort);
-	
-	config_set_bool(obs_config, SECTION_NAME, PARAM_DEBUG, DebugEnabled);
-
-	config_set_bool(obs_config, SECTION_NAME, PARAM_AUTHREQUIRED, AuthRequired);
-	config_set_string(obs_config, SECTION_NAME, PARAM_SECRET, Secret);
-	config_set_string(obs_config, SECTION_NAME, PARAM_SALT, Salt);
-
-	config_save(obs_config);
-}
-
-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
-	char* salt = (char*)bzalloc(64);
-	size_t salt_bytes;
-	mbedtls_base64_encode(
-		(unsigned char*)salt, 64, &salt_bytes,
-		random_chars, 32);
-
-	bfree(random_chars);
-	return salt;
-}
-
-const char* Config::GenerateSecret(const char *password, const char *salt)
-{
-	// Concatenate the password and the salt
-	std::string passAndSalt = "";
-	passAndSalt += password;
-	passAndSalt += salt;
-
-	// Generate a SHA256 hash of the password
-	unsigned char* challengeHash = (unsigned char*)bzalloc(32);
-	mbedtls_sha256(
-		(unsigned char*)passAndSalt.c_str(), passAndSalt.length(),
-		challengeHash, 0);
-	
-	// Encode SHA256 hash to Base64
-	char* challenge = (char*)bzalloc(64);
-	size_t challenge_bytes = 0;
-	mbedtls_base64_encode(
-		(unsigned char*)challenge, 64, &challenge_bytes,
-		challengeHash, 32);
-
-	bfree(challengeHash);
-	return 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)
-{
-	// Concatenate auth secret with the challenge sent to the user
-	std::string challengeAndResponse = "";
-	challengeAndResponse += this->Secret;
-	challengeAndResponse += this->SessionChallenge;
-
-	// Generate a SHA256 hash of challengeAndResponse
-	unsigned char* hash = (unsigned char*)bzalloc(32);
-	mbedtls_sha256(
-		(unsigned char*)challengeAndResponse.c_str(),
-		challengeAndResponse.length(),
-		hash, 0);
-
-	// Encode the SHA256 hash to Base64
-	char* expected_response = (char*)bzalloc(64);
-	size_t base64_size = 0;
-	mbedtls_base64_encode(
-		(unsigned char*)expected_response, 64, &base64_size,
-		hash, 32);
-
-	bool authSuccess = false;
-	if (strcmp(expected_response, response) == 0) {
-		SessionChallenge = GenerateSalt();
-		authSuccess = true;
-	}
-
-	bfree(hash);
-	bfree(expected_response);
-	return authSuccess;
-}
-
-Config* Config::Current()
-{
-	return _instance;
-}

PROTOCOL.md

@@ -1,967 +0,0 @@
-obs-websocket 4.1 protocol reference
-================================
-**This is the reference for the latest 4.1 developement build. [See here for obs-websocket 4.0.0!](https://github.com/Palakis/obs-websocket/blob/4.0.0/PROTOCOL.md)**
-
-## General Introduction
-Messages exchanged between the client and the server are JSON objects.  
-The protocol in general is based on the OBS Remote protocol created by Bill Hamilton, with new commands specific to OBS Studio.
-
-### Table of contents
-* [Authentication](#authentication)
-* [Events](#events)
-  - [Description](#description)
-  - [Event Types](#event-types)
-    - **Scenes**
-      - ["SwitchScenes"](#switchscenes)
-      - ["ScenesChanged"](#sceneschanged)
-    - **Scene Items**
-      - ["SourceOrderChanged"](#sourceorderchanged)
-      - ["SceneItemAdded"](#sceneitemadded)
-      - ["SceneItemRemoved"](#sceneitemremoved)
-      - ["SceneItemVisibilityChanged"](#sceneitemvisibilitychanged)
-    - **Scene Collections**
-      - ["SceneCollectionChanged"](#scenecollectionchanged)
-      - ["SceneCollectionListChanged"](#scenecollectionlistchanged)
-    - **Transitions**
-      - ["SwitchTransition"](#switchtransition)
-      - ["TransitionDurationChanged"](#transitiondurationchanged)
-      - ["TransitionListChanged"](#transitionlistchanged)
-      - ["TransitionBegin"](#transitionbegin)
-    - **Studio Mode**
-      - ["PreviewSceneChanged"](#previewscenechanged)
-      - ["StudioModeSwitched"](#studiomodeswitched)
-    - **Profiles**
-      - ["ProfileChanged"](#profilechanged)
-      - ["ProfileListChanged"](#profilelistchanged)
-    - **Streaming**
-      - ["StreamStarting"](#streamstarting)
-      - ["StreamStarted"](#streamstarted)
-      - ["StreamStopping"](#streamstopping)
-      - ["StreamStopped"](#streamstopped)
-      - ["StreamStatus"](#streamstatus)
-    - **Recording**
-      - ["RecordingStarting"](#recordingstarting)
-      - ["RecordingStarted"](#recordingstarted)
-      - ["RecordingStopping"](#recordingstopping)
-      - ["RecordingStopped"](#recordingstopped)
-    - **Other**
-      - ["Exiting"](#exiting)
-* [Requests](#requests)
-  - [Description](#description-1)
-  - [Request Types](#request-types)
-    - **General**
-      - ["GetVersion"](#getversion)
-      - ["GetAuthRequired"](#getauthrequired)
-      - ["Authenticate"](#authenticate)
-    - **Scenes**
-      - ["GetCurrentScene"](#getcurrentscene)
-      - ["SetCurrentScene"](#setcurrentscene)
-      - ["GetSceneList"](#getscenelist)
-    - **Studio Mode**
-      - ["GetStudioModeStatus"](#getstudiomodestatus)
-      - ["SetPreviewScene"](#setpreviewscene)
-      - ["TransitionToProgram"](#transitiontoprogram)
-      - ["EnableStudioMode"](#enablestudiomode)
-      - ["DisableStudioMode"](#disablestudiomode)
-      - ["ToggleStudioMode"](#togglestudiomode)
-    - **Streaming**
-      - ["StartStopStreaming"](#startstopstreaming)
-      - ["StartStreaming"](#startstreaming)
-      - ["StopStreaming"](#stopstreaming)
-      - ["GetStreamingStatus"](#getstreamingstatus)
-    - **Recording**
-      - ["StartStopRecording"](#startstoprecording)
-      - ["StartRecording"](#startrecording)
-      - ["StopRecording"](#stoprecording)
-      - ["GetStreamingStatus"](#getstreamingstatus)
-      - ["SetRecordingFolder"](#setrecordingfolder)
-      - ["GetRecordingFolder"](#getrecordingfolder)
-    - **Transitions**
-      - ["GetTransitionList"](#gettransitionlist)
-      - ["GetCurrentTransition"](#getcurrenttransition)
-      - ["SetCurrentTransition"](#setcurrenttransition)
-      - ["GetTransitionDuration"](#gettransitionduration)
-      - ["SetTransitionDuration"](#settransitionduration)
-    - **Sources**
-      - ["GetCurrentScene"](#getcurrentscene)
-      - ["GetSceneList"](#getscenelist)
-      - ["GetSpecialSources"](#getspecialsources)
-      - ["GetTextGDIPlusProperties"](#gettextgdiplusproperties)
-      - ["SetTextGDIPlusProperties"](#settextgdiplusproperties)
-      - ["GetBrowserSourceProperties"](#getbrowsersourceproperties)
-      - ["SetBrowserSourceProperties"](#setbrowsersourceproperties)
-      - ["SetVolume"](#setvolume)
-      - ["GetVolume"](#getvolume)
-      - ["SetMute"](#setmute)
-      - ["GetMute"](#getmute)
-      - ["ToggleMute"](#togglemute)
-    - **Scene Items**
-      - ["SetSceneItemRender"](#setsourcerender) (a.k.a `SetSourceRender`)
-      - ["SetSceneItemPosition"](#setsceneitemposition)
-      - ["SetSceneItemTransform"](#setsceneitemtransform)
-      - ["SetSceneItemCrop"](#setsceneitemcrop)
-    - **Scene Collections**
-      - ["ListSceneCollections"](#listscenecollections)
-      - ["SetCurrentSceneCollection"](#setcurrentscenecollection)
-      - ["GetCurrentSceneCollection"](#getcurrentscenecollection)
-    - **Streaming Server Settings**
-      - ["GetStreamSettings"](#getstreamsettings)
-      - ["SetStreamSettings"](#setstreamsettings)
-      - ["SaveStreamSettings"](#savestreamsettings)
-    - **Profiles**
-      - ["ListProfiles"](#listprofiles)
-      - ["SetCurrentProfile"](#setcurrentprofile)
-      - ["GetCurrentProfile"](#getcurrentprofile)
-
-## Authentication
-A call to [`GetAuthRequired`](#getauthrequired) gives the client 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
-
-The client knows a password and must it to authenticate itself to the server.  
-However, it must keep this password secret, and it is the purpose of the authentication mecanism used by obs-websocket.
-
-After a call to [`GetAuthRequired`](#getauthrequired), the client knows a password (kept secret), a challenge and a salt (sent by the server).
-To generate the answer to the auth challenge, follow this procedure :
-- Concatenate the password with the salt sent by the server (in this order : password + server salt), then generate a binary SHA256 hash of the result and encode the resulting SHA256 binary hash to base64.
-- Concatenate the base64 secret with the challenge sent by the server (in this order : base64 secret + server challenge), then 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` request.
-
-Here's how it looks in pseudocode :
-```
-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)
-```
-
-A client can then authenticate to the server by calling [`Authenticate`](#authenticate) with the computed challenge response.
-
-## Events
-### Description
-Events are sent exclusively by the server and broadcast to each connected client.  
-An event message will contain at least one field :
-- **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 in the following format : HH:MM:SS.mmm
-
-Additional fields will be present in the event message depending on the event type.
-
-### Event Types
-#### "SwitchScenes"
-OBS is switching to another scene (called at the end of the transition).  
-- **scene-name** (string) : The name of the scene being switched to.
-- **sources** (array of objects) : List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene).
-
----
-
-#### "ScenesChanged"
-The scene list has been modified (Scenes have been added, removed, or renamed).
-
----
-
-#### "SourceOrderChanged"
-Scene items have been reordered.
-- **"scene-name"** (string) : name of the scene where items have been reordered
-
----
-
-#### "SceneItemAdded"
-An item has been added to the current scene.
-- **"scene-name"** (string) :  name of the scene
-- **"item-name"** (string) : name of the item added to **scene-name**
-
----
-
-#### "SceneItemRemoved"
-An item has been removed from the current scene.
-- **"scene-name"** (string) :  name of the scene
-- **"item-name"** (string) : name of the item removed from **scene-name**
-
----
-
-#### "SceneItemVisibilityChanged"
-An item's visibility has been toggled.
-- **"scene-name"** (string) :  name of the scene
-- **"item-name"** (string) : name of the item in **scene-name**
-- **"item-visible"** (bool) : new visibility of item **item-name**
-
----
-
-#### "SceneCollectionChanged"
-Triggered when switching to another scene collection or when renaming the current scene collection.
-
----
-
-#### "SceneCollectionListChanged"
-Triggered when a scene collection is created, added, renamed or removed.
-
----
-
-#### "SwitchTransition"
-The active transition has been changed.  
-- **transition-name** (string) : The name of the active transition.
-
----
-
-#### "TransitionDurationChanged"
-Triggered when the transition duration has changed.
-- **"new-duration"** (integer) : new transition duration
-
----
-
-#### "TransitionListChanged"
-The list of available transitions has been modified (Transitions have been added, removed, or renamed).
-
----
-
-#### "TransitionBegin"
-A transition other than "Cut" has begun.
-
----
-
-#### "PreviewSceneChanged"
-The selected Preview scene changed (only in Studio Mode).
-- **scene-name** (string) : Name of the scene being previewed.
-- **sources** (array of objects) : List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene).
-
----
-
-#### "StudioModeSwitched"
-Studio Mode has been switched on or off.
-- **"new-state"** (bool) : new state of Studio Mode: true if enabled, false if disabled.
-
----
-
-#### "ProfileChanged"
-Triggered when switching to another profile or when renaming the current profile.
-
----
-
-#### "ProfileListChanged"
-Triggered when a profile is created, added, renamed or removed.
-
----
-
-#### "StreamStarting"
-A request to start streaming has been issued.  
-- **preview-only** (bool) : Always false.
-
----
-
-#### "StreamStarted"  
-Streaming started successfully.  
-
----
-
-#### "StreamStopping"
-A request to stop streaming has been issued.  
-- **preview-only** (bool) : Always false.
-
----
-
-#### "StreamStopped"  
-Streaming stopped successfully.  
-
----
-
-#### "RecordingStarting"  
-A request to start recording has been issued.  
-
----
-
-#### "RecordingStarted"  
-Recording started successfully.  
-
----
-
-#### "RecordingStopping"
-A request to stop streaming has been issued.  
-
----
-
-#### "RecordingStopped"  
-Recording stopped successfully.  
-
----
-
-#### "StreamStatus"
-Sent every 2 seconds with the following information :  
-- **streaming** (bool) : Current Streaming state.
-- **recording** (bool) : Current Recording state.
-- **preview-only** (bool) : Always false.
-- **bytes-per-sec** (integer) : Amount of data per second (in bytes) transmitted by the stream encoder.
-- **kbits-per-sec** (integer) : "bytes-per-sec" converted to kilobits per second
-- **strain** (double) : Percentage of dropped frames
-- **total-stream-time** (integer) : Total time (in seconds) since the stream started.
-- **num-total-frames** (integer) : Total number of frames transmitted since the stream started.
-- **num-dropped-frames** (integer) : Number of frames dropped by the encoder since the stream started.
-- **fps** (double) : Current framerate.
-
----
-
-#### "Exiting"
-OBS is exiting.  
-
----
-
-## Requests
-
-### Description
-Requests are sent by the client and must have at least the following two fields :  
-- **"request-type"** (string) : One of the request types listed in the sub-section "[Requests Types](#request-types)".
-- **"message-id"** (string) : An identifier defined by the client which will be embedded in the server response.  
-
-Depending on the request type additional fields may be required (see the "[Request Types](#request-types)" section below for more information).
-
-Once a request is sent, the server will return a JSON response with the following fields :  
-- **"message-id"** (string) : The identifier specified in the request.
-- **"status"** (string) : Response status, will be one of the following : "ok", "error"
-- **"error"** (string) : The error message associated with an "error" status.  
-
-Depending on the request type additional fields may be present (see the "[Request Types](#request-types)" section below for more information).
-
-### Request Types
-#### "GetVersion"
-Returns the latest version of the plugin and the API.
-
-__Request fields__ : none  
-__Response__ : always OK, with these additional fields :  
-- **"version"** (double) : OBSRemote API version. Fixed to 1.1 for retrocompatibility.
-- **"obs-websocket-version"** (string) : obs-websocket version string
-- **"obs-studio-version"** (string) : OBS Studio version string
-
----
-
-#### "GetAuthRequired"
-Tells the client if authentication is required. If it is, authentication parameters "challenge" and "salt" are passed in the response fields (see "Authentication").
-
-__Request fields__ : none  
-__Response__ : always OK, with these additional fields :  
-- **"authRequired"** (bool)
-- **"challenge"** (string)
-- **"salt"** (string)
-
----
-
-#### "Authenticate"
-Try to authenticate the client on the server.
-
-__Request fields__ :  
-- **"auth"** (string) : response to the auth challenge (see "Authentication").
-
-__Response__ : OK if auth succeeded, error if invalid credentials. No additional fields.
-
----
-
-#### "GetCurrentScene"
-Get the current scene's name and items.
-
-__Request fields__ : none  
-__Response__ : always OK, with these additional fields :  
-- **"name"** (string) : name of the current scene
-- **"sources"** (array of objects) : ordered list of the current scene's items descriptions
-
-Objects in the "sources" array have the following fields :
-- **"name"** (string) : name of the source associated with the scene item
-- **"type"** (string) : internal source type name
-- **"volume"** (double) : audio volume of the source, ranging from 0.0 to 1.0
-- **"x"** (double) : X coordinate of the top-left corner of the item in the scene
-- **"y"** (double) : Y coordinate of the top-left corner of the item in the scene
-- **"source_cx"** (integer) : width of the item (without scale applied)
-- **"source_cy"** (integer) : height of the item (without scale applied)
-- **"cx"** (double) : width of the item (with scale applied)
-- **"cy"** (double) : height of the item (with scale applied)
-- **"render"** (bool) : visibility of the source in the scene
-
----
-
-#### "SetCurrentScene"
-Switch to the scene specified in "scene-name".
-
-__Request fields__ :  
-- **"scene-name"** (string) : name of the scene to switch to.
-
-__Response__ : always OK if scene exists, error if it doesn't. No additional fields
-
----
-
-#### "GetSceneList"
-List OBS' scenes.
-
-__Request fields__ : none  
-__Response__ : always OK, with these additional fields :  
-- **"current-scene"** (string) : name of the currently active scene
-- **"scenes"** (array of objects) : ordered list of scene descriptions (see `GetCurrentScene` for reference)
-
----
-
-#### "SetSourceRender"
-Show or hide a specific source in the current scene.
-
-__Request fields__ :  
-- **"source"** (string) : name of the source in the currently active scene.
-- **"render"** (bool) : desired visibility
-- **"scene-name"** (string; optional) : name of the scene the source belongs to.  defaults to current scene.
-
-__Response__ : OK if source exists in the current scene, error otherwise.
-
----
-
-#### "GetStudioModeStatus"
-Tells if Studio Mode is currently enabled or disabled.
-
-__Request fields__ : none  
-__Response__ : always OK, with these additional fields :  
-- **"studio-mode"** (bool) : true if OBS is in Studio Mode, false otherwise.
-
----
-
-#### "GetPreviewScene"
-Studio Mode only. Gets the name of the currently Previewed scene, along with a list of its sources.
-
-__Request fields__ : none  
-__Response__ : OK if Studio Mode is enabled, with the same fields as [`GetCurrentScene`](#getcurrentscene), error otherwise.
-
----
-
-#### "SetPreviewScene"
-Studio Mode only. Sets the specified scene as the Previewed scene in Studio Mode.
-
-__Request fields__ :  
-- **"scene-name"** (string) : name of the scene to selected as the preview of Studio Mode
-
-__Response__ : OK if Studio Mode is enabled and specified scene exists, error otherwise.
-
----
-
-#### "TransitionToProgram"
-Studio Mode only. Transitions the currently previewed scene to Program (main output).
-
-__Request fields__ :  
-- **"with-transition"** (object, optional) : if specified, use this transition when switching from preview to program. This will change the current transition in the frontend to this one.
-
-__Response__ : OK if studio mode is enabled and optional transition exists, error otherwise.
-
-An object passed as `"with-transition"` in a request must have the following fields :  
-- **"name"** (string, optional) : transition name
-- **"duration"** (integer, optional) : transition duration in milliseconds
-
----
-
-#### "EnableStudioMode"
-Enables Studio Mode.
-
-__Request fields__ : none  
-__Response__ : always OK. No additional fields.
-
----
-
-#### "DisableStudioMode"
-Disables Studio Mode.
-
-__Request fields__ : none  
-__Response__ : always OK. No additional fields.
-
----
-
-#### "ToggleStudioMode"
-Toggles Studio Mode on or off.
-
-__Request fields__ : none  
-__Response__ : always OK. No additional fields.
-
----
-
-#### "StartStopStreaming"
-Toggles streaming on or off.
-
-__Request fields__ : none  
-__Response__ : always OK. No additional fields.
-
----
-
-#### "StartStopRecording"
-Toggles recording on or off.
-
-__Request fields__ : 
-- **"stream"** (object; optional) : See 'stream' parameter in 'StartStreaming'.  Ignored if stream is already started.
-
-__Response__ : always OK. No additional fields.  
-
----
-
-#### "StartStreaming"
-Start streaming.
-
-__Request fields__ : 
-- **"stream"** (object; optional) : If specified allows for special configuration of the stream
- 
-The 'stream' object has the following fields:
-- **"settings"** (object; optional) : The settings for the stream
-- **"type"** (string; optional) : If specified ensures the type of the 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 starting the stream.
-- **"metadata"** (object; optional) : 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 stream.
-
-The 'settings' object has the following fields:
-- **"server"** (string; optional) : The publish URL
-- **"key"** (string; optional) : The publish key of the stream
-- **"use-auth"** (bool; optional) : should authentication be used when connecting to the streaming server
-- **"username"** (string; optional) : if authentication is enabled, the username for access to the streaming server. Ignored if 'use-auth' is not specified as 'true'.
-- **"password"** (string; optional) : if authentication is enabled, the password for access to the streaming server. Ignored if 'use-auth' is not specified as 'true'.
-
-The 'metadata' object supports passing any string, numeric or boolean field.
-  
-__Response__ : Error if streaming is already active, OK otherwise. No additional fields.  
-
----
-
-#### "StopStreaming"
-Stop streaming.
-
-__Request fields__ : none  
-__Response__ : Error if streaming is already inactive, OK otherwise. No additional fields.  
-
----
-
-#### "StartRecording"
-Start recording.
-
-__Request fields__ : none  
-__Response__ : Error if recording is already active, OK otherwise. No additional fields.  
-
----
-
-#### "StopRecording"
-Stop recording.
-
-__Request fields__ : none  
-__Response__ : Error if recording is already inactive, OK otherwise. No additional fields.  
-
----
-
-#### "SetRecordingFolder"
-Change the current recording folder.
-
-__Request fields__ :
-- **"rec-folder"** (string) : path of the desired recording folder
-
-__Response__ : OK if path is valid, error otherwise.
-
----
-
-#### "GetRecordingFolder"
-Get the path of the current recording folder.
-
-__Request fields__ : none
-
-__Response__ : OK with these additional fields :
-- **"rec-folder"** (string) : path of the current recording folder
-
----
-
-#### "GetStreamingStatus"
-Get current streaming and recording status.
-
-__Request fields__ : none  
-__Response__ : always OK, with these additional fields :
-- **"streaming"** (bool) : streaming status (active or not)
-- **"recording"** (bool) : recording status (active or not)
-- **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)
-- **"preview-only"** (bool) : always false. Retrocompat with OBSRemote.
-
----
-
-#### "GetTransitionList"
-List all transitions available in the frontend's dropdown menu.
-
-__Request fields__ : none  
-__Response__ : always OK, with these additional fields :
-- **"current-transition"** (string) : name of the current transition
-- **"transitions"** (array of objects) : list of transition descriptions
-
-Objects in the "transitions" array have only one field :
-- **"name"** (string) : name of the transition
-
----
-
-#### "GetCurrentTransition"
-Get the name of the currently selected transition in the frontend's dropdown menu.
-
-__Request fields__ : none  
-__Response__ : always OK, with these additional fields :
-- **"name"** (string) : name of the selected transition
-- **"duration"** (integer, only if transition supports this) : transition duration
-
----
-
-#### "SetCurrentTransition"
-__Request fields__ :
-- **"transition-name"** (string) : The name of the transition.
-
-__Response__ : OK if specified transition exists, error otherwise. 
-
----
-
-#### "SetTransitionDuration"
-Set the duration of the currently selected transition.
-
-__Request fields__ :
-- **"duration"** (integer) : desired transition duration in milliseconds
-
-__Response__ : always OK.
-
----
-
-#### "GetTransitionDuration"
-Set the duration of the currently selected transition.
-
-__Request fields__ : none  
-__Response__ : always OK, with these additional fields :
-- **"transition-duration"** (integer) : current transition duration, in milliseconds
-
----
-
-#### "SetVolume"
-Set the volume of a specific source.
-
-__Request fields__ :
-- **"source"** (string) : the name of the source
-- **"volume"** (double) : the desired volume
-
-__Response__ : OK if specified source exists, error otherwise.
-
----
-
-#### "GetVolume"
-Get the volume of a specific source.
-
-__Request fields__ :
-- **"source"** (string) : name of the source
-
-__Response__ : OK if source exists, with these additional fields :
-- **"name"** (string) : source name
-- **"volume"** (double) : source volume, on a linear scale (0.0 to 1.0)
-- **"muted"** (bool) : source mute status
-
----
-
-#### "SetMute"
-Mutes or unmutes a specific source.
-
-__Request fields__ :
-- **"source"** (string) : the name of the source
-- **"mute"** (bool) : the desired mute status
-
-__Response__ : OK if specified source exists, error otherwise.
-
----
-
-#### "GetMute"
-Get mute status of a specific source.
-
-__Request fields__ :
-- **"source"** (string) : the name of the source
-
-__Response__ : OK if source exists, with these additional fields :
-- **"name"** (string) : source name
-- **"muted"** (bool) : source mute status
-
----
-
-#### "ToggleMute"
-Inverts the mute status of a specific source.
-
-__Request fields__ :
-- **"source"** (string) : the name of the source
-
-__Response__ : OK if specified source exists, error otherwise.
-
----
-
-#### "GetSpecialSources"
-Get configured special sources like Desktop Audio and Mic/Aux sources.
-
-__Request fields__ : none
-
-__Response__ : always OK, with these additional fields :  
-- **"desktop-1"** (string, optional) : Name of the first Desktop Audio capture source
-- **"desktop-1"** (string, optional) : Name of the second Desktop Audio capture source
-- **"mic-1"** (string, optional) : Name of the first Mic/Aux input source
-- **"mic-2"** (string, optional) : Name of the second Mic/Aux input source
-- **"mic-3"** (string, optional) : Name of the third Mic/Aux input source
-
----
-
-#### "SetSceneItemPosition"
-__Request fields__ :
-- **"item"** (string) : The name of the scene item.
-- **"x"** (float) : x coordinate
-- **"y"** (float) : y coordinate
-- **"scene-name"** (string) : scene the item belongs to.  defaults to current scene.
-
-__Response__ : OK if specified item exists, error otherwise.
-
----
-
-#### "SetSceneItemTransform"
-__Request fields__ :
-- **"item"** (string) : The name of the scene item.
-- **"x-scale"** (float) : width scale factor
-- **"y-scale"** (float) : height scale factor
-- **"rotation"** (float) : item rotation (in degrees)
-- **"scene-name"** (string) : scene the item belongs to.  defaults to current scene.
-
-__Response__ : OK if specified item exists, error otherwise.
-
----
-
-#### "SetSceneItemCrop"
-__Request fields__ :
-- **"item"** (string) : Name of the scene item
-- **"scene-name"** (string, optional) : Scene the item belongs to. Default : current scene.
-- **"top"** (integer)
-- **"bottom"** (integer)
-- **"left"** (integer)
-- **"right"** (integer)
-
-__Response__ : OK if specified item exists, error otherwise.
-
----
-
-#### "SetCurrentSceneCollection"
-Change the current scene collection.
-
-__Request fields__ :
-- **"sc-name"** (string) : name of the desired scene collection
-
-__Response__ : OK if scene collection exists, error otherwise.
-
----
-
-#### "GetCurrentSceneCollection"
-Get the name of the current scene collection.
-
-__Request fields__ : none
-
-__Response__ : OK with these additional fields :
-- **"sc-name"** (string) : name of the current scene collection
-
----
-
-#### "ListSceneCollections"
-Get a list of available scene collections.
-
-__Request fields__ : none
-
-__Response__ : OK with these additional fields :
-- **"scene-collections"** (array of objects) : names of available scene collections
-
----
-
-#### "GetStreamSettings"
-Gets the current streaming server settings
-
-__Request fields__ : none
-
-__Response__ : OK with these additional fields :
-- **"type"** (string) : The type of streaming service configuration usually 'rtmp\_custom' or 'rtmp\_common'
-- **"settings"** (object) : The actual settings of the stream (i.e. server, key, use-auth, username, password)
-
-The 'settings' object has the following fields however they may vary by 'type':
-- **"server"** (string) : The publish URL
-- **"key"** (string) : The publish key of the stream
-- **"use-auth"** (bool) : should authentication be used when connecting to the streaming server
-- **"username"** (string) : if authentication is enabled, the username for access to the streaming server
-- **"password"** (string) : if authentication is enabled, the password for access to the streaming server
-
---
-
-#### "SetStreamSettings"
-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 (i.e. the same as GetStreamSettings)
-
-__Request fields__ :
-- **"type"** (string) : The type of streaming service configuration usually 'rtmp\_custom' or 'rtmp\_common'
-- **"settings"** (object) : The actual settings of the stream (i.e. server, key, use-auth, username, password)
-- **"save"** (bool) : If specified as true, saves the settings to disk
-
-The 'settings' object has the following fields however they may vary by 'type':
-- **"server"** (string; optional) : The publish URL
-- **"key"** (string; optional) : The publish key of the stream
-- **"use-auth"** (bool; optional) : should authentication be used when connecting to the streaming server
-- **"username"** (string; optional) : if authentication is enabled, the username for access to the streaming server
-- **"password"** (string; optional) : if authentication is enabled, the password for access to the streaming server
-
-__Response__ : OK with the same fields as the request (except 'save')
-
----
-
-#### "SaveStreamSettings"
-Saves the current streaming server settings to disk
-
-__Request fields__ : none
-
-__Response__ : OK
-
-
-#### "SetCurrentProfile"
-Change the current profile.
-
-__Request fields__ :
-- **"profile-name"** (string) : name of the desired profile
-
-__Response__ : OK if profile exists, error otherwise.
-
----
-
-#### "GetCurrentProfile"
-Get the name of the current profile.
-
-__Request fields__ : none
-
-__Response__ : OK with these additional fields :
-- **"profile-name"** (string) : name of the current profile
-
----
-
-#### "ListProfiles"
-Get a list of available profiles.
-
-__Request fields__ : none
-
-__Response__ : OK with the additional fields :
-- **"profiles"** (array of objects) : names of available profiles
-
----
-
-#### "GetTextGDIPlusProperties"
-Gets current properties for Text GDI Plus source.
-
-__Request fields__ :  
-- **"source"** (string) : name of the source in the currently active scene.
-- **"scene-name"** (string; optional) : name of the scene the source belongs to.  defaults to current scene.
-
-__Response__ : OK if source exists in the current scene with these additional fields when fields are set, error otherwise.
-- **"align"** (string) : "left","center","right" : text alignment
-- **"bk_color"** (integer) : background color
-- **"bk_opacity"** (integer) : background opacity range 0 to 100
-- **"chatlog"** (bool) : chat log 
-- **"chatlog_lines"** (integer) : chat log lines
-- **"color"** (integer) : text color
-- **"extents"** (bool) : extents 
-- **"extents_wrap"** (bool) : extents wrap 
-- **"extents_cx"** (integer) : extents cx
-- **"extents_cy"** (integer) : extents cy
-- **"file"** (string) : file path name
-- **"read_from_file"** (bool) : read text from file specified
-- **"font"** (object) : holds font data for face, flags, size and style
--- Example: "font": {"face": "Arial","flags": 0,"size": 150,"style": ""}
-- **"face"** (string) : font face i.e. Arial
-- **"flags"** (integer) : font text style flag i.e. Bold 1, Italic 2, Bold Italic 3, Underline 5, Strikeout 8
-- **"size"** (integer) : font text size
-- **"style"** (string) : font style (unknown function)
-- **"gradient"** (bool) : gradient 
-- **"gradient_color"** (integer) : gradient color
-- **"gradient_dir"** (float) : gradient direction
-- **"gradient_opacity"** (integer) : gradient opacity range 0 to 100
-- **"outline"** (bool) : outline 
-- **"outline_color"** (integer) : outline color
-- **"outline_size"** (integer) : outline size
-- **"outline_opacity"** (integer) : outline opacity range 0 to 100
-- **"text"** (string) : text to be displayed
-- **"valign"** (string) : "top","center","bottom" : text vertical alignment
-- **"vertical"** (bool) : vertical text 
-- **"render"** (bool) : visibility of the scene item
-
----
-
-#### "SetTextGDIPlusProperties"
-Sets current properties for Text GDI Plus source.
-
-__Request fields__ :  
-- **"source"** (string) : name of the source in the currently active scene.
-- **"scene-name"** (string; optional) : name of the scene the source belongs to.  defaults to current scene.
-- **"align"** (string; optional) : "left","center","right" : text alignment
-- **"bk_color"** (integer; optional) : background color
-- **"bk_opacity"** (integer; optional) : background opacity range 0 to 100
-- **"chatlog"** (bool; optional) : chat log 
-- **"chatlog_lines"** (integer; optional) : chat log lines
-- **"color"** (integer; optional) : text color
-- **"extents"** (bool; optional) : extents 
-- **"extents_wrap"** (bool; optional) : extents wrap 
-- **"extents_cx"** (integer; optional) : extents cx
-- **"extents_cy"** (integer; optional) : extents cy
-- **"file"** (string; optional) : file path name
-- **"read_from_file"** (bool; optional) : read text from file specified
-- **"font"** (object; optional) : holds font data for face, flags, size and style
--- Example: "font":{"face": "Arial","flags": 0,"size": 150,"style": ""}
-- **"face"** (string; optional) : font face i.e. Arial
--- Example: "font":{"face": "Arial"}
-- **"flags"** (integer; optional) : font text style flag i.e. Bold 1, Italic 2, Bold Italic 3, Underline 5, Strikeout 8
-- **"size"** (integer; optional) : font text size 
--- Example: "font": {"size":125}
-- **"style"** (string; optional) : font style (unknown function)
-- **"gradient"** (bool; optional) : gradient 
-- **"gradient_color"** (integer; optional) : gradient color
-- **"gradient_dir"** (float; optional) : gradient direction
-- **"gradient_opacity"** (integer; optional) : gradient opacity range 0 to 100
-- **"outline"** (bool; optional) : outline 
-- **"outline_color"** (integer; optional) : outline color
-- **"outline_size"** (integer; optional) : outline size
-- **"outline_opacity"** (integer; optional) : outline opacity range 0 to 100
-- **"text"** (string; optional) : text to be displayed
-- **"valign"** (string; optional) : "top","center","bottom" : text vertical alignment
-- **"vertical"** (bool; optional) : vertical text 
-- **"render"** (bool; optional) : visibility of the scene item
-
-__Response__ : OK if source exists in the current scene, error otherwise.
-
----
-
-#### "GetBrowserSourceProperties"
-Gets current properties for Browser Source.
-
-__Request fields__ :  
-- **"source"** (string) : name of the source in the currently active scene.
-- **"scene-name"** (string; optional) : name of the scene the source belongs to.  defaults to current scene.
-
-__Response__ : OK if source exists in the current scene with these additional fields when fields are set, error otherwise.
-
-- **"is_local_file"** (bool) : use local file
-- **"url"** (string) : url or file path
-- **"css"** (string) : cascading style sheet code
-- **"width"** (integer) : width
-- **"height"** (integer) : height
-- **"fps"** (integer) : frames per second 
-- **"shutdown"** (bool) : shutdown when sorce is not visible
-- **"render"** (bool; optional) : visibility of the scene item
-
----
-
-#### "SetBrowserSourceProperties"
-Sets current properties for Browser Source.
-
-__Request fields__ :  
-- **"source"** (string) : name of the source in the currently active scene.
-- **"scene-name"** (string; optional) : name of the scene the source belongs to.  defaults to current scene.
-- **"is_local_file"** (bool; optional) : use local file
-- **"url"** (string; optional) : url or file path
-- **"css"** (string; optional) : cascading style sheet code
-- **"width"** (integer; optional) : width
-- **"height"** (integer; optional) : height
-- **"fps"** (integer; optional) : frames per second 
-- **"shutdown"** (bool; optional) : shutdown when sorce is not visible
-- **"render"** (bool; optional) : visibility of the scene item
-
----

README.md

@@ -2,9 +2,9 @@ obs-websocket
 ==============
 Remote control of OBS Studio made easy.
 
-Follow the project on Twitter for news & updates : [@obswebsocket](https://twitter.com/obswebsocket)
+Follow the main author on Twitter for news & updates : [@LePalakis](https://twitter.com/LePalakis)
 
-[![Gitter chat](https://badges.gitter.im/obs-websocket/obs-websocket.png)](https://gitter.im/obs-websocket/obs-websocket) [![Build Status - Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history) [![Build Status - Linux & OS X](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
+[![Build Status - Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history) [![Build Status - Linux & OS X](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
 
 ## Downloads
 Binaries for Windows and Linux are available in the [Releases](https://github.com/Palakis/obs-websocket/releases) section.
@@ -20,46 +20,112 @@ It is **highly recommended** to protect obs-websocket with a password against un
 - 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](PROTOCOL.md).  
+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 : [obs-websocket-py](https://github.com/Elektordi/obs-websocket-py) by Guillaume Genty a.k.a Elektordi
+- 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
 
-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 `contact at slepin dot fr` !
+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
+
+The two main development branches are:
+
+- `4.x-current`: actively-maintained codebase for 4.x releases. Backwards-compatible (unless stated otherwise) with existing clients until 5.0.
+- `5.x`: upcoming 5.0 version
+
+**New features and fixes must be based off and contributed to `4.x-current`**, as obs-websocket 5.0 is not in active development yet.
+
+### Pull Requests
+
+Pull Requests must never be based off your fork's main branch (in our case, `4.x-current` or `5.x`). 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, tag it with the `work in progress` label. You can also use the `help needed` label if you have questions, need a hand or want to ask for input.
+
+### 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 using to automatically generate the [protocol specification](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
-**We need your help on translations**. Please join the localization project on Crowdin: https://crowdin.com/project/obs-websocket
+
+**Your help is welcome on translations**. Please join the localization project on Crowdin: https://crowdin.com/project/obs-websocket
 
 ## Special thanks
-In order of appearance:
-- [Brendan H.](https://github.com/haganbmj) : Code contributions and better English in the Protocol specification
+
+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) : German translation
-- [Genture](https://github.com/Genteure) : Simplified Chinese and Traditional Chinese translations
-- [Larissa Gabilan](https://github.com/laris151) : Portuguese translation
-- [Andy Asquelt](https://github.com/asquelt) : Polish translation
-- [Marcel Haazen](https://github.com/inpothet) : Dutch translation
+- [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](doc/supportclass_logo_blacktext.png)](http://supportclass.net)
+[![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](doc/mediaunit_logo_black.png)](http://www.mediaunit.no/)
+[![MediaUnit](.github/images/mediaunit_logo_black.png)](http://www.mediaunit.no/)

Utils.cpp

@@ -1,522 +0,0 @@
-/*
-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.hpp>
-#include <QMainWindow>
-#include <QDir>
-#include <QUrl>
-#include "Utils.h"
-#include "obs-websocket.h"
-
-Q_DECLARE_METATYPE(OBSScene);
-
-obs_data_array_t* string_list_to_array(char** strings, char* key)
-{
-	if (!strings)
-		return obs_data_array_create();
-
-	obs_data_array_t* list = obs_data_array_create();
-
-	char* value = "";
-	for (int i = 0; value != nullptr; i++)
-	{
-		value = strings[i];
-
-		obs_data_t* item = obs_data_create();
-		obs_data_set_string(item, key, value);
-
-		if (value)
-			obs_data_array_push_back(list, item);
-
-		obs_data_release(item);
-	}
-
-	return list;
-}
-
-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)
-		return nullptr;
-
-	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_t* item_data = GetSceneItemData(currentItem);
-		obs_data_array_insert(data, 0, item_data);
-
-		obs_data_release(item_data);
-		return true;
-	}, items);
-
-	return items;
-}
-
-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_source_t* item_source = obs_sceneitem_get_source(item);
-	float item_width = float(obs_source_get_width(item_source));
-	float item_height = float(obs_source_get_height(item_source));
-
-	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_int(data, "source_cx", (int)item_width);
-	obs_data_set_int(data, "source_cy", (int)item_height);
-	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));
-
-	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 = nullptr;
-
-	obs_scene_t* scene = obs_scene_from_source(source);
-	if (scene == nullptr)
-		return nullptr;
-
-	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_source_t* Utils::GetTransitionFromName(const char* search_name)
-{
-	obs_source_t* found_transition = NULL;
-
-	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];
-
-		const char* transition_name = obs_source_get_name(transition);
-		if (strcmp(transition_name, search_name) == 0)
-		{
-			found_transition = transition;
-			obs_source_addref(found_transition);
-			break;
-		}
-	}
-
-	obs_frontend_source_list_free(&transition_list);
-
-	return found_transition;
-}
-
-obs_source_t* Utils::GetSceneFromNameOrCurrent(const char* scene_name)
-{
-	obs_source_t* scene = nullptr;
-
-	if (!scene_name || !strlen(scene_name))
-		scene = obs_frontend_get_current_scene();
-	else
-		scene = obs_get_source_by_name(scene_name);
-
-	return scene;
-}
-
-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_t* scene_data = GetSceneData(scene);
-		obs_data_array_push_back(scenes, scene_data);
-
-		obs_data_release(scene_data);
-	}
-
-	obs_frontend_source_list_free(&sceneList);
-
-	return scenes;
-}
-
-obs_data_t* Utils::GetSceneData(obs_source* source)
-{
-	obs_data_array_t* scene_items = 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", scene_items);
-
-	obs_data_array_release(scene_items);
-	return sceneData;
-}
-
-obs_data_array_t* Utils::GetSceneCollections()
-{
-	char** scene_collections = obs_frontend_get_scene_collections();
-	obs_data_array_t* list = string_list_to_array(scene_collections, "sc-name");
-
-	bfree(scene_collections);
-	return list;
-}
-
-obs_data_array_t* Utils::GetProfiles()
-{
-	char** profiles = obs_frontend_get_profiles();
-	obs_data_array_t* list = string_list_to_array(profiles, "profile-name");
-
-	bfree(profiles);
-	return list;
-}
-
-QSpinBox* Utils::GetTransitionDurationControl()
-{
-	QMainWindow* window = (QMainWindow*)obs_frontend_get_main_window();
-	return window->findChild<QSpinBox*>("transitionDuration");
-}
-
-int Utils::GetTransitionDuration()
-{
-	QSpinBox* control = GetTransitionDurationControl();
-	if (control)
-		return control->value();
-	else
-		return -1;
-}
-
-void Utils::SetTransitionDuration(int ms)
-{
-	QSpinBox* control = GetTransitionDurationControl();
-
-	if (control && ms >= 0)
-		control->setValue(ms);
-}
-
-bool Utils::SetTransitionByName(const char* transition_name)
-{
-	obs_source_t* transition = GetTransitionFromName(transition_name);
-
-	if (transition)
-	{
-		obs_frontend_set_current_transition(transition);
-		obs_source_release(transition);
-
-		return true;
-	}
-	else
-	{
-		return false;
-	}
-}
-
-QPushButton* Utils::GetPreviewModeButtonControl()
-{
-	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
-	return main->findChild<QPushButton*>("modeSwitch");
-}
-
-QListWidget* Utils::GetSceneListControl()
-{
-	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
-	return main->findChild<QListWidget*>("scenes");
-}
-
-obs_scene_t* Utils::SceneListItemToScene(QListWidgetItem* item)
-{
-	if (!item)
-		return nullptr;
-
-	QVariant item_data = item->data(static_cast<int>(Qt::UserRole));
-	return item_data.value<OBSScene>();
-}
-
-QLayout* Utils::GetPreviewLayout()
-{
-	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
-	return main->findChild<QLayout*>("previewLayout");
-}
-
-bool Utils::IsPreviewModeActive()
-{
-	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
-
-	// Clue 1 : "Studio Mode" button is toggled on
-	bool buttonToggledOn = GetPreviewModeButtonControl()->isChecked();
-
-	// Clue 2 : Preview layout has more than one item
-	int previewChildCount = GetPreviewLayout()->count();
-	blog(LOG_INFO, "preview layout children count : %d", previewChildCount);
-
-	return buttonToggledOn || (previewChildCount >= 2);
-}
-
-void Utils::EnablePreviewMode()
-{
-	if (!IsPreviewModeActive())
-		GetPreviewModeButtonControl()->click();
-}
-
-void Utils::DisablePreviewMode()
-{
-	if (IsPreviewModeActive())
-		GetPreviewModeButtonControl()->click();
-}
-
-void Utils::TogglePreviewMode()
-{
-	GetPreviewModeButtonControl()->click();
-}
-
-obs_scene_t* Utils::GetPreviewScene()
-{
-	if (IsPreviewModeActive())
-	{
-		QListWidget* sceneList = GetSceneListControl();
-
-		QList<QListWidgetItem*> selected = sceneList->selectedItems();
-
-		// Qt::UserRole == QtUserRole::OBSRef
-		obs_scene_t* scene = Utils::SceneListItemToScene(selected.first());
-
-		obs_scene_addref(scene);
-		return scene;
-	}
-
-	return nullptr;
-}
-
-bool Utils::SetPreviewScene(const char* name)
-{
-	if (IsPreviewModeActive())
-	{
-		QListWidget* sceneList = GetSceneListControl();
-		QList<QListWidgetItem*> matchingItems =
-			sceneList->findItems(name, Qt::MatchExactly);
-
-		if (matchingItems.count() > 0)
-		{
-			sceneList->setCurrentItem(matchingItems.first());
-			return true;
-		}
-		else
-		{
-			return false;
-		}
-	}
-
-	return false;
-}
-
-void Utils::TransitionToProgram()
-{
-	if (!IsPreviewModeActive())
-		return;
-
-	// WARNING : if the layout created in OBS' CreateProgramOptions() changes
-	// then this won't work as expected
-
-	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
-
-	// The program options widget is the second item in the left-to-right layout
-	QWidget* programOptions = GetPreviewLayout()->itemAt(1)->widget();
-
-	// The "Transition" button lies in the mainButtonLayout
-	// which is the first itemin the program options' layout
-	QLayout* mainButtonLayout = programOptions->layout()->itemAt(1)->layout();
-	QWidget* transitionBtnWidget = mainButtonLayout->itemAt(0)->widget();
-
-	// Try to cast that widget into a button
-	QPushButton* transitionBtn = qobject_cast<QPushButton*>(transitionBtnWidget);
-
-	// Perform a click on that button
-	transitionBtn->click();
-}
-
-const char* Utils::OBSVersionString() {
-	uint32_t version = obs_get_version();
-
-	uint8_t major, minor, patch;
-	major = (version >> 24) & 0xFF;
-	minor = (version >> 16) & 0xFF;
-	patch = version & 0xFF;
-
-	char* result = (char*)bmalloc(sizeof(char) * 12);
-	sprintf(result, "%d.%d.%d", major, minor, patch);
-
-	return result;
-}
-
-QSystemTrayIcon* Utils::GetTrayIcon()
-{
-	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
-	return main->findChildren<QSystemTrayIcon*>().first();
-}
-
-void Utils::SysTrayNotify(QString &text, QSystemTrayIcon::MessageIcon icon, QString title)
-{
-	if (!QSystemTrayIcon::supportsMessages())
-		return;
-
-	QSystemTrayIcon* trayIcon = GetTrayIcon();
-	if (trayIcon)
-		trayIcon->showMessage(title, text, icon);
-}
-
-QString Utils::FormatIPAddress(QHostAddress &addr)
-{
-	if (addr.protocol() == QAbstractSocket::IPv4Protocol)
-		QString v4addr = addr.toString().replace("::fff:", "");
-
-	return addr.toString();
-}
-
-const char* Utils::GetRecordingFolder()
-{
-	config_t* profile = obs_frontend_get_profile_config();
-	const char* outputMode = config_get_string(profile, "Output", "Mode");
-
-	if (strcmp(outputMode, "Advanced") == 0)
-	{
-		// 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)
-{
-	if (!QDir(path).exists())
-		return false;
-
-	config_t* profile = obs_frontend_get_profile_config();
-	const char* outputMode = config_get_string(profile, "Output", "Mode");
-
-	if (strcmp(outputMode, "Advanced") == 0)
-	{
-		config_set_string(profile, "AdvOut", "RecFilePath", path);
-	}
-	else
-	{
-		config_set_string(profile, "SimpleOutput", "FilePath", path);
-	}
-
-	config_save(profile);
-	return true;
-}
-
-QString* Utils::ParseDataToQueryString(obs_data_t * data)
-{
-	QString* query = nullptr;
-	if (data)
-	{
-		obs_data_item_t* item = obs_data_first(data);
-		if (item)
-		{
-			query = new QString();
-			bool isFirst = true;
-			do
-			{
-				if (!obs_data_item_has_user_value(item))
-					continue;
-				
-				if (!isFirst)
-					query->append('&');
-				else
-					isFirst = false;
-				
-				const char* attrName = obs_data_item_get_name(item);
-				query->append(attrName).append("=");
-				switch (obs_data_item_gettype(item))
-				{
-					case OBS_DATA_BOOLEAN:
-						query->append(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->append(QString::number(obs_data_item_get_double(item)));
-								break;
-							case OBS_DATA_NUM_INT:
-								query->append(QString::number(obs_data_item_get_int(item)));
-								break;
-							case OBS_DATA_NUM_INVALID:
-								break;
-						}
-						break;
-					case OBS_DATA_STRING:
-						query->append(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;
-}

Utils.h

@@ -1,83 +0,0 @@
-/*
-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/>
-*/
-
-#ifndef UTILS_H
-#define UTILS_H
-
-#include <QSpinBox>
-#include <QPushButton>
-#include <QLayout>
-#include <QListWidget>
-#include <QSystemTrayIcon>
-#include <QHostAddress>
-#include <stdio.h>
-#include <obs-module.h>
-#include <util/config-file.h>
-
-class Utils
-{
-	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_source_t* GetTransitionFromName(const char* search_name);
-		static obs_source_t* GetSceneFromNameOrCurrent(const char* scene_name);
-
-		static obs_data_array_t* GetScenes();
-		static obs_data_t* GetSceneData(obs_source* source);
-
-		static obs_data_array_t* GetSceneCollections();
-		static obs_data_array_t* GetProfiles();
-
-		static QSpinBox* GetTransitionDurationControl();
-		static int GetTransitionDuration();
-		static void SetTransitionDuration(int ms);
-
-		static bool SetTransitionByName(const char* transition_name);
-
-		static QPushButton* GetPreviewModeButtonControl();
-		static QLayout* GetPreviewLayout();
-		static QListWidget* GetSceneListControl();
-		static obs_scene_t* SceneListItemToScene(QListWidgetItem* item);
-
-		static bool IsPreviewModeActive();
-		static void EnablePreviewMode();
-		static void DisablePreviewMode();
-		static void TogglePreviewMode();
-
-		static obs_scene_t* GetPreviewScene();
-		static bool SetPreviewScene(const char* name);
-		static void TransitionToProgram();
-
-		static const char* OBSVersionString();
-
-		static QSystemTrayIcon* GetTrayIcon();
-		static void SysTrayNotify(
-			QString &text,
-			QSystemTrayIcon::MessageIcon n,
-			QString title = QString("obs-websocket"));
-
-		static QString FormatIPAddress(QHostAddress &addr);
-		static const char* GetRecordingFolder();
-		static bool SetRecordingFolder(const char* path);
-	
-		static QString* ParseDataToQueryString(obs_data_t * data);
-};
-
-#endif // UTILS_H

WSEvents.cpp

@@ -1,647 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016-2017	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/>
-*/
-
-#include <util/platform.h>
-#include <QTimer>
-#include <QPushButton>
-#include "Config.h"
-#include "Utils.h"
-#include "WSEvents.h"
-#include "obs-websocket.h"
-
-bool transition_is_cut(obs_source_t* transition)
-{
-	if (!transition)
-		return false;
-
-	if (obs_source_get_type(transition) == OBS_SOURCE_TYPE_TRANSITION
-		&& strcmp(obs_source_get_id(transition), "cut_transition") == 0)
-	{
-		return true;
-	}
-
-	return false;
-}
-
-const char* ns_to_timestamp(uint64_t ns)
-{
-	uint64_t ms = ns / (1000 * 1000);
-	uint64_t secs = ms / 1000;
-	uint64_t minutes = secs / 60;
-
-	uint64_t hours_part = minutes / 60;
-	uint64_t minutes_part = minutes % 60;
-	uint64_t secs_part = secs % 60;
-	uint64_t ms_part = ms % 1000;
-
-	char* ts = (char*)bmalloc(64);
-	sprintf(ts, "%02d:%02d:%02d.%03d",
-		hours_part, minutes_part, secs_part, ms_part);
-
-	return ts;
-}
-
-WSEvents* WSEvents::Instance = nullptr;
-
-WSEvents::WSEvents(WSServer* srv)
-{
-	_srv = srv;
-	obs_frontend_add_event_callback(WSEvents::FrontendEventHandler, this);
-
-	QSpinBox* duration_control = Utils::GetTransitionDurationControl();
-	connect(duration_control, SIGNAL(valueChanged(int)),
-		this, SLOT(TransitionDurationChanged(int)));
-
-	QTimer* statusTimer = new QTimer();
-	connect(statusTimer, SIGNAL(timeout()),
-		this, SLOT(StreamStatus()));
-	statusTimer->start(2000); // equal to frontend's constant BITRATE_UPDATE_SECONDS
-
-	QListWidget* sceneList = Utils::GetSceneListControl();
-	connect(sceneList, SIGNAL(currentItemChanged(QListWidgetItem*, QListWidgetItem*)),
-		this, SLOT(SelectedSceneChanged(QListWidgetItem*, QListWidgetItem*)));
-
-	QPushButton* modeSwitch = Utils::GetPreviewModeButtonControl();
-	connect(modeSwitch, SIGNAL(clicked(bool)), this, SLOT(ModeSwitchClicked(bool)));
-
-	transition_handler = nullptr;
-	scene_handler = nullptr;
-
-	QTimer::singleShot(1000, this, SLOT(deferredInitOperations()));
-
-	_streaming_active = false;
-	_recording_active = false;
-
-	_stream_starttime = 0;
-	_rec_starttime = 0;
-}
-
-WSEvents::~WSEvents()
-{
-	obs_frontend_remove_event_callback(WSEvents::FrontendEventHandler, this);
-}
-
-void WSEvents::deferredInitOperations()
-{
-	obs_source_t* transition = obs_frontend_get_current_transition();
-	connectTransitionSignals(transition);
-	obs_source_release(transition);
-
-	obs_source_t* scene = obs_frontend_get_current_scene();
-	connectSceneSignals(scene);
-	obs_source_release(scene);
-}
-
-void WSEvents::FrontendEventHandler(enum obs_frontend_event event, void* private_data)
-{
-	WSEvents* owner = static_cast<WSEvents*>(private_data);
-
-	if (!owner->_srv)
-		return;
-
-	// TODO : implement 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_SCENE_COLLECTION_CHANGED)
-	{
-		owner->OnSceneCollectionChange();
-	}
-	else if (event == OBS_FRONTEND_EVENT_SCENE_COLLECTION_LIST_CHANGED)
-	{
-		owner->OnSceneCollectionListChange();
-	}
-	else if (event == OBS_FRONTEND_EVENT_TRANSITION_CHANGED)
-	{
-		owner->OnTransitionChange();
-	}
-	else if (event == OBS_FRONTEND_EVENT_TRANSITION_LIST_CHANGED)
-	{
-		owner->OnTransitionListChange();
-	}
-	else if (event == OBS_FRONTEND_EVENT_PROFILE_CHANGED)
-	{
-		owner->OnProfileChange();
-	}
-	else if (event == OBS_FRONTEND_EVENT_PROFILE_LIST_CHANGED)
-	{
-		owner->OnProfileListChange();
-	}
-	else if (event == OBS_FRONTEND_EVENT_STREAMING_STARTING)
-	{
-		owner->OnStreamStarting();
-	}
-	else if (event == OBS_FRONTEND_EVENT_STREAMING_STARTED)
-	{
-		owner->_streaming_active = true;
-		owner->OnStreamStarted();
-	}
-	else if (event == OBS_FRONTEND_EVENT_STREAMING_STOPPING)
-	{
-		owner->OnStreamStopping();
-	}
-	else if (event == OBS_FRONTEND_EVENT_STREAMING_STOPPED)
-	{
-		owner->_streaming_active = false;
-		owner->OnStreamStopped();
-	}
-	else if (event == OBS_FRONTEND_EVENT_RECORDING_STARTING)
-	{
-		owner->OnRecordingStarting();
-	}
-	else if (event == OBS_FRONTEND_EVENT_RECORDING_STARTED)
-	{
-		owner->_recording_active = true;
-		owner->OnRecordingStarted();
-	}
-	else if (event == OBS_FRONTEND_EVENT_RECORDING_STOPPING)
-	{
-		owner->OnRecordingStopping();
-	}
-	else if (event == OBS_FRONTEND_EVENT_RECORDING_STOPPED)
-	{
-		owner->_recording_active = false;
-		owner->OnRecordingStopped();
-	}
-	else if (event == OBS_FRONTEND_EVENT_EXIT)
-	{
-		owner->OnExit();
-	}
-}
-
-void WSEvents::broadcastUpdate(const char* updateType, obs_data_t* additionalFields = NULL)
-{
-	obs_data_t* update = obs_data_create();
-	obs_data_set_string(update, "update-type", updateType);
-
-	const char* ts = nullptr;
-	if (_streaming_active)
-	{
-		ts = ns_to_timestamp(os_gettime_ns() - _stream_starttime);
-		obs_data_set_string(update, "stream-timecode", ts);
-		bfree((void*)ts);
-	}
-
-	if (_recording_active)
-	{
-		ts = ns_to_timestamp(os_gettime_ns() - _rec_starttime);
-		obs_data_set_string(update, "rec-timecode", ts);
-		bfree((void*)ts);
-	}
-
-	if (additionalFields != NULL)
-		obs_data_apply(update, additionalFields);
-
-	const char *json = obs_data_get_json(update);
-	_srv->broadcast(json);
-	if (Config::Current()->DebugEnabled)
-		blog(LOG_DEBUG, "Update << '%s'", json);
-
-	obs_data_release(update);
-}
-
-void WSEvents::connectTransitionSignals(obs_source_t* transition)
-{
-	if (transition_handler)
-	{
-		signal_handler_disconnect(transition_handler,
-			"transition_start", OnTransitionBegin, this);
-	}
-
-	if (!transition_is_cut(transition))
-	{
-		transition_handler = obs_source_get_signal_handler(transition);
-		signal_handler_connect(transition_handler,
-			"transition_start", OnTransitionBegin, this);
-	}
-	else
-	{
-		transition_handler = nullptr;
-	}
-}
-
-void WSEvents::connectSceneSignals(obs_source_t* scene)
-{
-	if (scene_handler)
-	{
-		signal_handler_disconnect(scene_handler,
-			"reorder", OnSceneReordered, this);
-		signal_handler_disconnect(scene_handler,
-			"item_add", OnSceneItemAdd, this);
-		signal_handler_disconnect(scene_handler,
-			"item_remove", OnSceneItemDelete, this);
-		signal_handler_disconnect(scene_handler,
-			"item_visible", OnSceneItemVisibilityChanged, this);
-	}
-
-	// TODO : connect to all scenes, not just the current one.
-	scene_handler = obs_source_get_signal_handler(scene);
-	signal_handler_connect(scene_handler,
-		"reorder", OnSceneReordered, this);
-	signal_handler_connect(scene_handler,
-		"item_add", OnSceneItemAdd, this);
-	signal_handler_connect(scene_handler,
-		"item_remove", OnSceneItemDelete, this);
-	signal_handler_connect(scene_handler,
-		"item_visible", OnSceneItemVisibilityChanged, this);
-}
-
-uint64_t WSEvents::GetStreamingTime()
-{
-	if (_streaming_active)
-		return (os_gettime_ns() - _stream_starttime);
-	else
-		return 0;
-}
-
-const char* WSEvents::GetStreamingTimecode()
-{
-	return ns_to_timestamp(GetStreamingTime());
-}
-
-uint64_t WSEvents::GetRecordingTime()
-{
-	if (_recording_active)
-		return (os_gettime_ns() - _rec_starttime);
-	else
-		return 0;
-}
-
-const char* WSEvents::GetRecordingTimecode()
-{
-	return ns_to_timestamp(GetRecordingTime());
-}
-
-void WSEvents::OnSceneChange()
-{
-	// Implements an existing update type from bilhamil's OBS Remote
-	obs_data_t* data = obs_data_create();
-
-	obs_source_t* current_scene = obs_frontend_get_current_scene();
-	obs_data_array_t* scene_items = Utils::GetSceneItems(current_scene);
-	connectSceneSignals(current_scene);
-
-	obs_data_set_string(data, "scene-name", obs_source_get_name(current_scene));
-	obs_data_set_array(data, "sources", scene_items);
-
-	broadcastUpdate("SwitchScenes", data);
-
-	obs_data_array_release(scene_items);
-	obs_source_release(current_scene);
-	obs_data_release(data);
-
-	// Dirty fix : OBS blocks signals when swapping scenes in Studio Mode
-	// after transition end, so SelectedSceneChanged is never called...
-	if (Utils::IsPreviewModeActive())
-	{
-		QListWidget* list = Utils::GetSceneListControl();
-		SelectedSceneChanged(list->currentItem(), nullptr);
-	}
-}
-
-void WSEvents::OnSceneListChange()
-{
-	broadcastUpdate("ScenesChanged");
-}
-
-void WSEvents::OnSceneCollectionChange()
-{
-	broadcastUpdate("SceneCollectionChanged");
-
-	scene_handler = nullptr;
-	transition_handler = nullptr;
-
-	OnTransitionListChange();
-	OnTransitionChange();
-
-	OnSceneListChange();
-	OnSceneChange();
-}
-
-void WSEvents::OnSceneCollectionListChange()
-{
-	broadcastUpdate("SceneCollectionListChanged");
-}
-
-void WSEvents::OnTransitionChange()
-{
-	obs_source_t* current_transition = obs_frontend_get_current_transition();
-	connectTransitionSignals(current_transition);
-
-	obs_data_t* data = obs_data_create();
-	obs_data_set_string(data, "transition-name",
-		obs_source_get_name(current_transition));
-
-	broadcastUpdate("SwitchTransition", data);
-
-	obs_data_release(data);
-	obs_source_release(current_transition);
-}
-
-void WSEvents::OnTransitionListChange()
-{
-	broadcastUpdate("TransitionListChanged");
-}
-
-void WSEvents::OnProfileChange()
-{
-	broadcastUpdate("ProfileChanged");
-}
-
-void WSEvents::OnProfileListChange()
-{
-	broadcastUpdate("ProfileListChanged");
-}
-
-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
-	_stream_starttime = 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
-	_stream_starttime = 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
-	_rec_starttime = os_gettime_ns();
-	broadcastUpdate("RecordingStarted");
-}
-
-void WSEvents::OnRecordingStopping()
-{
-	// New update type specific to OBS Studio
-	broadcastUpdate("RecordingStopping");
-}
-
-void WSEvents::OnRecordingStopped()
-{
-	// New update type specific to OBS Studio
-	_rec_starttime = 0;
-	broadcastUpdate("RecordingStopped");
-}
-
-void WSEvents::OnExit()
-{
-	// New update type specific to OBS Studio
-	broadcastUpdate("Exiting");
-}
-
-void WSEvents::StreamStatus()
-{
-	bool streaming_active = obs_frontend_streaming_active();
-	bool recording_active = obs_frontend_recording_active();
-
-	obs_output_t* stream_output = obs_frontend_get_streaming_output();
-
-	if (!stream_output || !streaming_active)
-	{
-		if (stream_output)
-			obs_output_release(stream_output);
-
-		return;
-	}
-
-	uint64_t bytes_sent = obs_output_get_total_bytes(stream_output);
-	uint64_t bytes_sent_time = os_gettime_ns();
-
-	if (bytes_sent < _lastBytesSent)
-		bytes_sent = 0;
-
-	if (bytes_sent == 0)
-		_lastBytesSent = 0;
-
-	uint64_t bytes_between = bytes_sent - _lastBytesSent;
-	double time_passed =
-		double(bytes_sent_time - _lastBytesSentTime) / 1000000000.0;
-
-	uint64_t bytes_per_sec = bytes_between / time_passed;
-
-	_lastBytesSent = bytes_sent;
-	_lastBytesSentTime = bytes_sent_time;
-
-	uint64_t totalStreamTime =
-		(os_gettime_ns() - _stream_starttime) / 1000000000;
-
-	int total_frames = obs_output_get_total_frames(stream_output);
-	int dropped_frames = obs_output_get_frames_dropped(stream_output);
-
-	float strain = obs_output_get_congestion(stream_output);
-
-	obs_data_t* data = obs_data_create();
-	obs_data_set_bool(data, "streaming", streaming_active);
-	obs_data_set_bool(data, "recording", recording_active);
-	obs_data_set_int(data, "bytes-per-sec", bytes_per_sec);
-	obs_data_set_int(data, "kbits-per-sec", (bytes_per_sec * 8) / 1024);
-	obs_data_set_int(data, "total-stream-time", totalStreamTime);
-	obs_data_set_int(data, "num-total-frames", total_frames);
-	obs_data_set_int(data, "num-dropped-frames", dropped_frames);
-	obs_data_set_double(data, "fps", obs_get_active_fps());
-	obs_data_set_double(data, "strain", strain);
-	obs_data_set_bool(data, "preview-only", false); // Retrocompat with OBSRemote
-
-	broadcastUpdate("StreamStatus", data);
-
-	obs_data_release(data);
-	obs_output_release(stream_output);
-}
-
-void WSEvents::TransitionDurationChanged(int ms)
-{
-	obs_data_t* fields = obs_data_create();
-	obs_data_set_int(fields, "new-duration", ms);
-
-	broadcastUpdate("TransitionDurationChanged", fields);
-
-	obs_data_release(fields);
-}
-
-void WSEvents::OnTransitionBegin(void* param, calldata_t* data)
-{
-	UNUSED_PARAMETER(data);
-
-	WSEvents* instance = static_cast<WSEvents*>(param);
-	instance->broadcastUpdate("TransitionBegin");
-
-	blog(LOG_INFO, "transition begin");
-}
-
-void WSEvents::OnSceneReordered(void* param, calldata_t* data)
-{
-	WSEvents* instance = static_cast<WSEvents*>(param);
-
-	obs_scene_t* scene = nullptr;
-	calldata_get_ptr(data, "scene", &scene);
-
-	obs_data_t* fields = obs_data_create();
-	obs_data_set_string(fields, "scene-name",
-		obs_source_get_name(obs_scene_get_source(scene)));
-
-	instance->broadcastUpdate("SourceOrderChanged", fields);
-
-	obs_data_release(fields);
-}
-
-void WSEvents::OnSceneItemAdd(void* param, calldata_t* data)
-{
-	WSEvents* instance = static_cast<WSEvents*>(param);
-
-	obs_scene_t* scene = nullptr;
-	calldata_get_ptr(data, "scene", &scene);
-
-	obs_sceneitem_t* scene_item = nullptr;
-	calldata_get_ptr(data, "item", &scene_item);
-
-	const char* scene_name =
-		obs_source_get_name(obs_scene_get_source(scene));
-	const char* sceneitem_name =
-		obs_source_get_name(obs_sceneitem_get_source(scene_item));
-
-	obs_data_t* fields = obs_data_create();
-	obs_data_set_string(fields, "scene-name", scene_name);
-	obs_data_set_string(fields, "item-name", sceneitem_name);
-
-	instance->broadcastUpdate("SceneItemAdded", fields);
-
-	obs_data_release(fields);
-}
-
-void WSEvents::OnSceneItemDelete(void* param, calldata_t* data)
-{
-	WSEvents* instance = static_cast<WSEvents*>(param);
-
-	obs_scene_t* scene = nullptr;
-	calldata_get_ptr(data, "scene", &scene);
-
-	obs_sceneitem_t* scene_item = nullptr;
-	calldata_get_ptr(data, "item", &scene_item);
-
-	const char* scene_name =
-		obs_source_get_name(obs_scene_get_source(scene));
-	const char* sceneitem_name =
-		obs_source_get_name(obs_sceneitem_get_source(scene_item));
-
-	obs_data_t* fields = obs_data_create();
-	obs_data_set_string(fields, "scene-name", scene_name);
-	obs_data_set_string(fields, "item-name", sceneitem_name);
-
-	instance->broadcastUpdate("SceneItemRemoved", fields);
-
-	obs_data_release(fields);
-}
-
-void WSEvents::OnSceneItemVisibilityChanged(void* param, calldata_t* data)
-{
-	WSEvents* instance = static_cast<WSEvents*>(param);
-
-	obs_scene_t* scene = nullptr;
-	calldata_get_ptr(data, "scene", &scene);
-
-	obs_sceneitem_t* scene_item = nullptr;
-	calldata_get_ptr(data, "item", &scene_item);
-
-	bool visible = false;
-	calldata_get_bool(data, "visible", &visible);
-
-	const char* scene_name =
-		obs_source_get_name(obs_scene_get_source(scene));
-	const char* sceneitem_name =
-		obs_source_get_name(obs_sceneitem_get_source(scene_item));
-
-	obs_data_t* fields = obs_data_create();
-	obs_data_set_string(fields, "scene-name", scene_name);
-	obs_data_set_string(fields, "item-name", sceneitem_name);
-	obs_data_set_bool(fields, "item-visible", visible);
-
-	instance->broadcastUpdate("SceneItemVisibilityChanged", fields);
-
-	obs_data_release(fields);
-}
-
-void WSEvents::SelectedSceneChanged(QListWidgetItem* current, QListWidgetItem* prev)
-{
-	if (Utils::IsPreviewModeActive())
-	{
-		obs_scene_t* scene = Utils::SceneListItemToScene(current);
-		if (!scene) return;
-
-		obs_source_t* scene_source = obs_scene_get_source(scene);
-		obs_data_array_t* scene_items = Utils::GetSceneItems(scene_source);
-
-		obs_data_t* data = obs_data_create();
-		obs_data_set_string(data, "scene-name", obs_source_get_name(scene_source));
-		obs_data_set_array(data, "sources", scene_items);
-
-		broadcastUpdate("PreviewSceneChanged", data);
-
-		obs_data_array_release(scene_items);
-		obs_data_release(data);
-	}
-}
-
-void WSEvents::ModeSwitchClicked(bool checked)
-{
-	obs_data_t* data = obs_data_create();
-	obs_data_set_bool(data, "new-state", checked);
-
-	broadcastUpdate("StudioModeSwitched", data);
-
-	obs_data_release(data);
-}

WSEvents.h

@@ -1,101 +0,0 @@
-/*
-obs-websocket
-Copyright (C) 2016-2017	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/>
-*/
-
-#ifndef WSEVENTS_H
-#define WSEVENTS_H
-
-#include <obs-frontend-api.h>
-#include <QListWidgetItem>
-#include "WSServer.h"
-
-class WSEvents : public QObject
-{
-	Q_OBJECT
-
-	public:
-		explicit WSEvents(WSServer* srv);
-		~WSEvents();
-		static void FrontendEventHandler(
-			enum obs_frontend_event event, void* private_data);
-		void connectTransitionSignals(obs_source_t* transition);
-		void connectSceneSignals(obs_source_t* scene);
-		static WSEvents* Instance;
-
-		uint64_t GetStreamingTime();
-		const char* GetStreamingTimecode();
-		uint64_t GetRecordingTime();
-		const char* GetRecordingTimecode();
-
-	private Q_SLOTS:
-		void deferredInitOperations();
-		void StreamStatus();
-		void TransitionDurationChanged(int ms);
-		void SelectedSceneChanged(
-			QListWidgetItem* current, QListWidgetItem* prev);
-		void ModeSwitchClicked(bool checked);
-
-	private:
-		WSServer* _srv;
-		signal_handler_t* transition_handler;
-		signal_handler_t* scene_handler;
-
-		bool _streaming_active;
-		bool _recording_active;
-
-		uint64_t _stream_starttime;
-		uint64_t _rec_starttime;
-
-		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 OnExit();
-
-		static void OnTransitionBegin(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);
-};
-
-#endif // WSEVENTS_H

WSRequestHandler.h

@@ -1,116 +0,0 @@
-/*
-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/>
-*/
-
-#ifndef WSREQUESTHANDLER_H
-#define WSREQUESTHANDLER_H
-
-#include <obs-frontend-api.h>
-
-#include <QtWebSockets/QWebSocket>
-#include <QtWebSockets/QWebSocketServer>
-
-class WSRequestHandler : public QObject
-{
-	Q_OBJECT
-
-	public:
-		explicit WSRequestHandler(QWebSocket* client);
-		~WSRequestHandler();
-		void processIncomingMessage(QString textMessage);
-		bool hasField(const char* name);
-
-	private:
-		static obs_service_t* _service;
-		QWebSocket* _client;
-		const char* _messageId;
-		const char* _requestType;
-		obs_data_t* data;
-
-		QMap<QString, void(*)(WSRequestHandler*)> messageMap;
-		QSet<QString> authNotRequired;
-
-		void SendOKResponse(obs_data_t* additionalFields = NULL);
-		void SendErrorResponse(const char* errorMessage);
-		void SendResponse(obs_data_t* response);
-
-		static void HandleGetVersion(WSRequestHandler* req);
-		static void HandleGetAuthRequired(WSRequestHandler* req);
-		static void HandleAuthenticate(WSRequestHandler* req);
-
-		static void HandleSetCurrentScene(WSRequestHandler* req);
-		static void HandleGetCurrentScene(WSRequestHandler* req);
-		static void HandleGetSceneList(WSRequestHandler* req);
-
-		static void HandleSetSceneItemRender(WSRequestHandler* req);
-		static void HandleSetSceneItemPosition(WSRequestHandler* req);
-		static void HandleSetSceneItemTransform(WSRequestHandler* req);
-		static void HandleSetSceneItemCrop(WSRequestHandler* req);
-
-		static void HandleGetStreamingStatus(WSRequestHandler* req);
-		static void HandleStartStopStreaming(WSRequestHandler* req);
-		static void HandleStartStopRecording(WSRequestHandler* req);
-		static void HandleStartStreaming(WSRequestHandler* req);
-		static void HandleStopStreaming(WSRequestHandler* req);
-		static void HandleStartRecording(WSRequestHandler* req);
-		static void HandleStopRecording(WSRequestHandler* req);
-
-		static void HandleSetRecordingFolder(WSRequestHandler* req);
-		static void HandleGetRecordingFolder(WSRequestHandler* req);
-
-		static void HandleGetTransitionList(WSRequestHandler* req);
-		static void HandleGetCurrentTransition(WSRequestHandler* req);
-		static void HandleSetCurrentTransition(WSRequestHandler* req);
-
-		static void HandleSetVolume(WSRequestHandler* req);
-		static void HandleGetVolume(WSRequestHandler* req);
-		static void HandleToggleMute(WSRequestHandler* req);
-		static void HandleSetMute(WSRequestHandler* req);
-		static void HandleGetMute(WSRequestHandler* req);
-		static void HandleGetSpecialSources(WSRequestHandler* req);
-
-		static void HandleSetCurrentSceneCollection(WSRequestHandler* req);
-		static void HandleGetCurrentSceneCollection(WSRequestHandler* req);
-		static void HandleListSceneCollections(WSRequestHandler* req);
-
-		static void HandleSetCurrentProfile(WSRequestHandler* req);
-		static void HandleGetCurrentProfile(WSRequestHandler* req);
-		static void HandleListProfiles(WSRequestHandler* req);
-
-		static void HandleSetStreamSettings(WSRequestHandler* req);
-		static void HandleGetStreamSettings(WSRequestHandler* req);
-		static void HandleSaveStreamSettings(WSRequestHandler* req);
-
-		static void HandleSetTransitionDuration(WSRequestHandler* req);
-		static void HandleGetTransitionDuration(WSRequestHandler* req);
-
-		static void HandleGetStudioModeStatus(WSRequestHandler* req);
-		static void HandleGetPreviewScene(WSRequestHandler* req);
-		static void HandleSetPreviewScene(WSRequestHandler* req);
-		static void HandleTransitionToProgram(WSRequestHandler* req);
-		static void HandleEnableStudioMode(WSRequestHandler* req);
-		static void HandleDisableStudioMode(WSRequestHandler* req);
-		static void HandleToggleStudioMode(WSRequestHandler* req);
-		
-		static void HandleSetTextGDIPlusProperties(WSRequestHandler* req);
-		static void HandleGetTextGDIPlusProperties(WSRequestHandler* req);
-		static void HandleSetBrowserSourceProperties(WSRequestHandler* req);
-		static void HandleGetBrowserSourceProperties(WSRequestHandler* req);
-};
-
-#endif // WSPROTOCOL_H

WSServer.cpp

@@ -1,171 +0,0 @@
-/*
-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 <QtWebSockets/QWebSocket>
-#include <QtCore/QThread>
-#include <QtCore/QByteArray>
-#include <obs-frontend-api.h>
-
-#include "WSServer.h"
-#include "obs-websocket.h"
-#include "Config.h"
-#include "Utils.h"
-
-QT_USE_NAMESPACE
-
-WSServer* WSServer::Instance = nullptr;
-
-WSServer::WSServer(QObject* parent) :
-	QObject(parent),
-	_wsServer(Q_NULLPTR),
-	_clients(),
-	_clMutex(QMutex::Recursive)
-{
-	_serverThread = new QThread();
-
-	_wsServer = new QWebSocketServer(
-		QStringLiteral("obs-websocket"),
-		QWebSocketServer::NonSecureMode,
-		_serverThread);
-
-	_serverThread->start();
-}
-
-WSServer::~WSServer()
-{
-	Stop();
-	delete _serverThread;
-}
-
-void WSServer::Start(quint16 port)
-{
-	if (port == _wsServer->serverPort())
-		return;
-
-	if(_wsServer->isListening())
-		Stop();
-
-	bool serverStarted = _wsServer->listen(QHostAddress::Any, port);
-	if (serverStarted)
-	{
-		connect(_wsServer, &QWebSocketServer::newConnection,
-			this, &WSServer::onNewConnection);
-	}
-}
-
-void WSServer::Stop()
-{
-	_clMutex.lock();
-	for(QWebSocket* pClient : _clients) {
-		pClient->close();
-	}
-	_clMutex.unlock();
-
-	_wsServer->close();
-}
-
-void WSServer::broadcast(QString message)
-{
-	_clMutex.lock();
-
-	for(QWebSocket* pClient : _clients) {
-		if (Config::Current()->AuthRequired
-			&& (pClient->property(PROP_AUTHENTICATED).toBool() == false))
-		{
-			// Skip this client if unauthenticated
-			continue;
-		}
-
-		pClient->sendTextMessage(message);
-	}
-
-	_clMutex.unlock();
-}
-
-void WSServer::onNewConnection()
-{
-	QWebSocket* pSocket = _wsServer->nextPendingConnection();
-
-	if (pSocket)
-	{
-		connect(pSocket, &QWebSocket::textMessageReceived,
-			this, &WSServer::textMessageReceived);
-		connect(pSocket, &QWebSocket::disconnected,
-			this, &WSServer::socketDisconnected);
-		pSocket->setProperty(PROP_AUTHENTICATED, false);
-
-		_clMutex.lock();
-		_clients << pSocket;
-		_clMutex.unlock();
-
-		QHostAddress clientAddr = pSocket->peerAddress();
-		QString clientIp = Utils::FormatIPAddress(clientAddr);
-
-		blog(LOG_INFO, "new client connection from %s:%d",
-			clientIp.toUtf8().constData(), pSocket->peerPort());
-
-		QString msg = QString(obs_module_text("OBSWebsocket.ConnectNotify.ClientIP"))
-			+ QString(" ")
-			+ clientAddr.toString();
-
-		Utils::SysTrayNotify(msg,
-			QSystemTrayIcon::Information,
-			QString(obs_module_text("OBSWebsocket.ConnectNotify.Connected")));
-	}
-}
-
-void WSServer::textMessageReceived(QString message)
-{
-	QWebSocket* pSocket = qobject_cast<QWebSocket*>(sender());
-
-	if (pSocket)
-	{
-		WSRequestHandler handler(pSocket);
-		handler.processIncomingMessage(message);
-	}
-}
-
-void WSServer::socketDisconnected()
-{
-	QWebSocket* pSocket = qobject_cast<QWebSocket*>(sender());
-
-	if (pSocket)
-	{
-		pSocket->setProperty(PROP_AUTHENTICATED, false);
-
-		_clMutex.lock();
-		_clients.removeAll(pSocket);
-		_clMutex.unlock();
-
-		pSocket->deleteLater();
-
-		QHostAddress clientAddr = pSocket->peerAddress();
-		QString clientIp = Utils::FormatIPAddress(clientAddr);
-
-		blog(LOG_INFO, "client %s:%d disconnected",
-			clientIp.toUtf8().constData(), pSocket->peerPort());
-
-		QString msg = QString(obs_module_text("OBSWebsocket.ConnectNotify.ClientIP"))
-			+ QString(" ")
-			+ clientAddr.toString();
-
-		Utils::SysTrayNotify(msg,
-			QSystemTrayIcon::Information,
-			QString(obs_module_text("OBSWebsocket.ConnectNotify.Disconnected")));
-	}
-}

WSServer.h

@@ -1,55 +0,0 @@
-/*
-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/>
-*/
-
-#ifndef WSSERVER_H
-#define WSSERVER_H
-
-#include <QtCore/QObject>
-#include <QtCore/QList>
-#include <QtCore/QMutex>
-
-QT_FORWARD_DECLARE_CLASS(QWebSocketServer)
-QT_FORWARD_DECLARE_CLASS(QWebSocket)
-
-#include "WSRequestHandler.h"
-
-class WSServer : public QObject
-{
-	Q_OBJECT
-
-	public:
-		explicit WSServer(QObject* parent = Q_NULLPTR);
-		virtual ~WSServer();
-		void Start(quint16 port);
-		void Stop();
-		void broadcast(QString message);
-		static WSServer* Instance;
-
-	private Q_SLOTS:
-		void onNewConnection();
-		void textMessageReceived(QString message);
-		void socketDisconnected();
-
-	private:
-		QWebSocketServer* _wsServer;
-		QList<QWebSocket*> _clients;
-		QMutex _clMutex;
-		QThread* _serverThread;
-};
-
-#endif // WSSERVER_H

appveyor.yml

@@ -4,34 +4,20 @@ environment:
 install:
   - git submodule update --init --recursive
   - cd C:\projects\
-  - if not exist dependencies2013.zip curl -kLO https://obsproject.com/downloads/dependencies2013.zip -f --retry 5 -C -
-  - 7z x dependencies2013.zip -odependencies2013
-  - if not exist qt570.zip curl -kLO https://www.slepin.fr/obs-websocket/ci/qt570.zip -f --retry 5 -C -
-  - 7z x qt570.zip -o"Qt5.7.0"
-  - set DepsPath32=%CD%\dependencies2013\win32
-  - set DepsPath64=%CD%\dependencies2013\win64
-  - set QTDIR32=%CD%\Qt5.7.0\msvc2013
-  - set QTDIR64=%CD%\Qt5.7.0\msvc2013_64
-  - set build_config=Release
-  - git clone --recursive https://github.com/jp9000/obs-studio
-  - cd C:\projects\obs-studio\
-  - git checkout 19.0.2
-  - mkdir build
-  - mkdir build32
-  - mkdir build64
-  - cd ./build32
-  - cmake -G "Visual Studio 12 2013" -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
-  - cd ../build64
-  - cmake -G "Visual Studio 12 2013 Win64" -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
-  - call msbuild /m /p:Configuration=%build_config% C:\projects\obs-studio\build32\obs-studio.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
-  - call msbuild /m /p:Configuration=%build_config% C:\projects\obs-studio\build64\obs-studio.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
+  - if not exist dependencies2015.zip curl -kLO https://obsproject.com/downloads/dependencies2015.zip -f --retry 5 -C -
+  - 7z x dependencies2015.zip -odependencies2015
+  - set DepsPath32=%CD%\dependencies2015\win32
+  - set DepsPath64=%CD%\dependencies2015\win64
+  - call C:\projects\obs-websocket\CI\install-setup-qt.cmd
+  - set build_config=RelWithDebInfo
+  - call C:\projects\obs-websocket\CI\install-build-obs.cmd
   - cd C:\projects\obs-websocket\
   - mkdir build32
   - mkdir build64
   - cd ./build32
-  - cmake -G "Visual Studio 12 2013" -DQTDIR="%QTDIR32%" -DLibObs_DIR="C:\projects\obs-studio\build32\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build32\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
+  - cmake -G "Visual Studio 14 2015" -DQTDIR="%QTDIR32%" -DLibObs_DIR="C:\projects\obs-studio\build32\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build32\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
   - cd ../build64
-  - cmake -G "Visual Studio 12 2013 Win64" -DQTDIR="%QTDIR64%" -DLibObs_DIR="C:\projects\obs-studio\build64\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build64\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build64\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
+  - cmake -G "Visual Studio 14 2015 Win64" -DQTDIR="%QTDIR64%" -DLibObs_DIR="C:\projects\obs-studio\build64\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build64\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build64\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
 
 build_script:
   - call msbuild /m /p:Configuration=%build_config% C:\projects\obs-websocket\build32\obs-websocket.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
@@ -39,12 +25,16 @@ build_script:
 
 before_deploy:
   - 7z a "C:\projects\obs-websocket\build.zip" C:\projects\obs-websocket\release\*
+  - set PATH=%PATH%;"C:\\Program Files (x86)\\Inno Setup 5"
+  - iscc "C:\projects\obs-websocket\installer\installer.iss"
 
 deploy_script:
-  - ps: Push-AppveyorArtifact "C:\projects\obs-websocket\build.zip" -FileName "obs-websocket-$(git log --pretty=format:'%h' -n 1).zip"
+  - ps: Push-AppveyorArtifact "C:\projects\obs-websocket\build.zip" -FileName "obs-websocket-$(git log --pretty=format:'%h' -n 1)-Windows.zip"
+  - ps: Push-AppveyorArtifact "C:\projects\obs-websocket\installer\Output\obs-websocket-Windows-Installer.exe" -FileName "obs-websocket-$(git log --pretty=format:'%h' -n 1)-Windows-Installer.exe"
 
 test: off
 
 cache:
-  - C:\projects\dependencies2013.zip
-  - C:\projects\qt570.zip
+  - C:\projects\dependencies2015.zip
+  - C:\projects\obs-studio-last-tag-built.txt
+  - C:\projects\obs-studio\

azure-pipelines.yml

@@ -0,0 +1,23 @@
+pool:
+  vmImage: 'macOS-10.13'
+
+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'
+
+- script: ./CI/package-macos.sh
+  displayName: 'Package'
+
+- task: PublishBuildArtifacts@1
+  inputs:
+    pathtoPublish: './release'
+    artifactName: 'build'

crowdin.yml

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

data/locale/de-DE.ini

@@ -1,6 +1,16 @@
-OBSWebsocket.Menu.SettingsItem="Websocket-Server Einstellungen"
-OBSWebsocket.Settings.DialogTitle="Websocket-Server Einstellungen"
-OBSWebsocket.Settings.ServerEnable="Websocket-Server aktivieren"
-OBSWebsocket.Settings.ServerPort="Server Port"
-OBSWebsocket.Settings.AuthRequired="Authentifizierung erforderlich"
+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,10 +1,16 @@
-OBSWebsocket.Menu.SettingsItem="Websocket server settings"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Enable Websocket server"
+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.ConnectNotify.Connected="New WebSocket connection"
-OBSWebsocket.ConnectNotify.Disconnected="WebSocket client disconnected"
-OBSWebsocket.ConnectNotify.ClientIP="Client Address:"
+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 - An unknown network error happened on your system. Try again by changing settings, restarting OBS or restarting your system."
+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,9 +1,16 @@
-OBSWebsocket.Menu.SettingsItem="Paramètres du serveur Websocket"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Activer le serveur Websockets"
+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.ConnectNotify.Connected="Nouvelle connexion WebSocket"
-OBSWebsocket.ConnectNotify.Disconnected="Déconnexion WebSocket"
-OBSWebsocket.ConnectNotify.ClientIP="Adresse du client :"
+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

@@ -1,6 +1,9 @@
-OBSWebsocket.Menu.SettingsItem="Websocket server instellingen"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Activeer Websocket server"
-OBSWebsocket.Settings.ServerPort="Server Poort"
-OBSWebsocket.Settings.AuthRequired="Activeer authenticatie"
-OBSWebsocket.Settings.Password="Wachtwoord"
+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

@@ -1,6 +1,10 @@
-OBSWebsocket.Menu.SettingsItem="Ustawienia serwera zdalnego sterowania"
-OBSWebsocket.Settings.DialogTitle="Serwer zdalnego sterowania"
-OBSWebsocket.Settings.ServerEnable="Włącz serwer zdalnego sterowania (Websocket)"
-OBSWebsocket.Settings.ServerPort="Port serwera"
-OBSWebsocket.Settings.AuthRequired="Wymagaj hasła"
-OBSWebsocket.Settings.Password="Hasło"
+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-BR.ini

@@ -1,6 +0,0 @@
-OBSWebsocket.Menu.SettingsItem="Configuraçes do Servidor Websocket"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Habilitar o Servidor Websocket"
-OBSWebsocket.Settings.ServerPort="Porta do Servidor"
-OBSWebsocket.Settings.AuthRequired="Autenticação Requerida"
-OBSWebsocket.Settings.Password="Senha"

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

@@ -1,6 +1,12 @@
-OBSWebsocket.Menu.SettingsItem="Websocket 服务器设置"
-OBSWebsocket.Settings.DialogTitle="obs-websocket 设置"
-OBSWebsocket.Settings.ServerEnable="启用 Websocket 服务器"
+OBSWebsocket.Settings.ServerEnable="启用 WebSockets 服务器"
 OBSWebsocket.Settings.ServerPort="服务器端口"
-OBSWebsocket.Settings.AuthRequired="启用密码认证"
+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

@@ -1,6 +1,9 @@
-OBSWebsocket.Menu.SettingsItem="Websocket 伺服器設定"
-OBSWebsocket.Settings.DialogTitle="obs-websocket 設定"
-OBSWebsocket.Settings.ServerEnable="啟用 Websocket 伺服器"
-OBSWebsocket.Settings.ServerPort="伺服器端口"
-OBSWebsocket.Settings.AuthRequired="啟用密碼認證"
-OBSWebsocket.Settings.Password="密碼"
+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.6.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.ui

@@ -1,141 +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>407</width>
-    <height>175</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="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>274</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>157</x>
-     <y>294</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>280</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>286</x>
-     <y>294</y>
-    </hint>
-   </hints>
-  </connection>
- </connections>
-</ui>

installer/installer.iss

@@ -2,8 +2,8 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "obs-websocket"
-#define MyAppVersion "4.0.0"
-#define MyAppPublisher "St<EFBFBD>phane Lepin"
+#define MyAppVersion "4.6.1"
+#define MyAppPublisher "Stephane Lepin"
 #define MyAppURL "http://github.com/Palakis/obs-websocket"
 
 [Setup]
@@ -20,17 +20,16 @@ AppSupportURL={#MyAppURL}
 AppUpdatesURL={#MyAppURL}
 DefaultDirName={code:GetDirName}
 DefaultGroupName={#MyAppName}
-OutputBaseFilename=obs-websocket-{#MyAppVersion}-Windows-Installer
+OutputBaseFilename=obs-websocket-Windows-Installer
 Compression=lzma
 SolidCompression=yes
-LicenseFile=..\LICENSE
 
 [Languages]
 Name: "english"; MessagesFile: "compiler:Default.isl"
-Name: "french"; MessagesFile: "compiler:Languages\French.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]
@@ -38,6 +37,21 @@ 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;

obs-websocket.cpp

@@ -1,74 +0,0 @@
-/*
-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-module.h>
-#include <obs-frontend-api.h>
-#include <QAction>
-#include <QMainWindow>
-#include <QTimer>
-
-#include "obs-websocket.h"
-#include "WSServer.h"
-#include "WSEvents.h"
-#include "Config.h"
-#include "forms/settings-dialog.h"
-
-OBS_DECLARE_MODULE()
-OBS_MODULE_USE_DEFAULT_LOCALE("obs-websocket", "en-US")
-
-SettingsDialog *settings_dialog;
-
-bool obs_module_load(void) 
-{
-	blog(LOG_INFO, "you can haz websockets (version %s)", OBS_WEBSOCKET_VERSION);
-
-	// Core setup
-	Config* config = Config::Current();
-	config->Load();
-
-	WSServer::Instance = new WSServer();
-	WSEvents::Instance = new WSEvents(WSServer::Instance);
-
-	if (config->ServerEnabled)
-		WSServer::Instance->Start(config->ServerPort);
-
-	// UI setup
-	QAction *menu_action = (QAction*)obs_frontend_add_tools_menu_qaction(
-		obs_module_text("OBSWebsocket.Menu.SettingsItem"));
-
-	obs_frontend_push_ui_translation(obs_module_get_string);
-	QMainWindow* main_window = (QMainWindow*)obs_frontend_get_main_window();
-	settings_dialog = new SettingsDialog(main_window);
-	obs_frontend_pop_ui_translation();
-
-	auto menu_cb = [] {
-		settings_dialog->ToggleShowHide();
-	};
-	menu_action->connect(menu_action, &QAction::triggered, menu_cb);
-
-	// Loading finished
-	blog(LOG_INFO, "module loaded!");
-
-	return true;
-}
-
-void obs_module_unload()
-{
-	blog(LOG_INFO, "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-2017	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,43 +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 <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
-{
+class Config {
 	public:
 		Config();
 		~Config();
 		void Load();
 		void Save();
+		void SetDefaults();
+		config_t* GetConfigStore();
 
-		void SetPassword(const char *password);
-		bool CheckAuth(const char *userChallenge);
-		const char* GenerateSalt();
-		static const char* GenerateSecret(
-			const char *password, const char *salt);
+		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

@@ -0,0 +1,34 @@
+/*
+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/>
+*/
+
+#include "ConnectionProperties.h"
+
+ConnectionProperties::ConnectionProperties()
+    : _authenticated(false)
+{
+}
+
+bool ConnectionProperties::isAuthenticated()
+{
+    return _authenticated.load();
+}
+
+void ConnectionProperties::setAuthenticated(bool authenticated)
+{
+    _authenticated.store(authenticated);
+}

src/ConnectionProperties.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016-2017	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,13 +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 PROP_AUTHENTICATED "wsclient_authenticated"
-#define OBS_WEBSOCKET_VERSION "4.1.0"
-#define API_VERSION 1.3
+#include <atomic>
 
-#define blog(level, msg, ...) blog(level, "[obs-websocket] " msg, ##__VA_ARGS__)
-
-#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,777 @@
+/*
+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 <QtWidgets/QMainWindow>
+#include <QtCore/QDir>
+#include <QtCore/QUrl>
+
+#include <obs-frontend-api.h>
+#include <obs.hpp>
+#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 {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} `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_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::GetSceneItemFromItem(obs_source_t* source, obs_data_t* item) {
+        OBSSceneItem sceneItem;
+        if (obs_data_has_user_value(item, "id")) {
+                sceneItem = GetSceneItemFromId(source, obs_data_get_int(item, "id"));
+                if (obs_data_has_user_value(item, "name") &&
+                   (QString)obs_source_get_name(obs_sceneitem_get_source(sceneItem)) !=
+                   (QString)obs_data_get_string(item, "name")) {
+                        return nullptr;
+                }
+        }
+        else if (obs_data_has_user_value(item, "name")) {
+                sceneItem = GetSceneItemFromName(source, obs_data_get_string(item, "name"));
+        }
+        return sceneItem;
+}
+
+obs_sceneitem_t* Utils::GetSceneItemFromName(obs_source_t* source, QString name) {
+	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 = nullptr;
+
+	OBSScene scene = obs_scene_from_source(source);
+	if (!scene)
+		return 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;
+}
+
+// TODO refactor this to unify it with GetSceneItemFromName
+obs_sceneitem_t* Utils::GetSceneItemFromId(obs_source_t* source, size_t id) {
+	struct current_search {
+		size_t 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 = nullptr;
+
+	OBSScene scene = obs_scene_from_source(source);
+	if (!scene)
+		return 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, param);
+			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;
+}
+
+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_source_t* Utils::GetSceneFromNameOrCurrent(QString sceneName) {
+	// Both obs_frontend_get_current_scene() and obs_get_source_by_name()
+	// do addref on the return source, so no need to use an OBSSource helper
+	obs_source_t* scene = nullptr;
+
+	if (sceneName.isEmpty() || sceneName.isNull())
+		scene = obs_frontend_get_current_scene();
+	else
+		scene = obs_get_source_by_name(sceneName.toUtf8());
+
+	return scene;
+}
+
+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() {
+	QSpinBox* control = GetTransitionDurationControl();
+	if (control)
+		return control->value();
+	else
+		return -1;
+}
+
+void Utils::SetTransitionDuration(int ms) {
+	QSpinBox* control = GetTransitionDurationControl();
+	if (control && ms >= 0)
+		control->setValue(ms);
+}
+
+bool Utils::SetTransitionByName(QString transitionName) {
+	OBSSourceAutoRelease transition = GetTransitionFromName(transitionName);
+
+	if (transition) {
+		obs_frontend_set_current_transition(transition);
+		return true;
+	} else {
+		return false;
+	}
+}
+
+QPushButton* Utils::GetPreviewModeButtonControl() {
+	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
+	return main->findChild<QPushButton*>("modeSwitch");
+}
+
+QLayout* Utils::GetPreviewLayout() {
+	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
+	return main->findChild<QLayout*>("previewLayout");
+}
+
+void Utils::TransitionToProgram() {
+	if (!obs_frontend_preview_program_mode_active())
+		return;
+
+	// WARNING : if the layout created in OBS' CreateProgramOptions() changes
+	// then this won't work as expected
+
+	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
+
+	// The program options widget is the second item in the left-to-right layout
+	QWidget* programOptions = GetPreviewLayout()->itemAt(1)->widget();
+
+	// The "Transition" button lies in the mainButtonLayout
+	// which is the first itemin the program options' layout
+	QLayout* mainButtonLayout = programOptions->layout()->itemAt(1)->layout();
+	QWidget* transitionBtnWidget = mainButtonLayout->itemAt(0)->widget();
+
+	// Try to cast that widget into a button
+	QPushButton* transitionBtn = qobject_cast<QPushButton*>(transitionBtnWidget);
+
+	// Perform a click on that button
+	transitionBtn->click();
+}
+
+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);
+
+		OBSData 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_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 filter = obs_data_create();
+		obs_data_set_string(filter, "type", obs_source_get_id(child));
+		obs_data_set_string(filter, "name", obs_source_get_name(child));
+		if (enumParams->includeSettings) {
+			obs_data_set_obj(filter, "settings", obs_source_get_settings(child));
+		}
+		obs_data_array_push_back(enumParams->filters, filter);
+	}, &enumParams);
+
+	return enumParams.filters;
+}

src/Utils.h

@@ -0,0 +1,85 @@
+/*
+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>
+
+class Utils {
+  public:
+	static obs_data_array_t* StringListToArray(char** strings, const char* key);
+	static obs_data_array_t* GetSceneItems(obs_source_t* source);
+	static obs_data_t* GetSceneItemData(obs_sceneitem_t* item);
+	static obs_sceneitem_t* GetSceneItemFromName(
+		obs_source_t* source, QString name);
+        static obs_sceneitem_t* GetSceneItemFromId(obs_source_t* source, size_t id);
+	static obs_sceneitem_t* GetSceneItemFromItem(obs_source_t* source, obs_data_t* item);
+	static obs_source_t* GetTransitionFromName(QString transitionName);
+	static obs_source_t* GetSceneFromNameOrCurrent(QString sceneName);
+	static obs_data_t* GetSceneItemPropertiesData(obs_sceneitem_t* item);
+
+	static obs_data_array_t* GetSourceFiltersList(obs_source_t* source, bool includeSettings);
+
+	static bool IsValidAlignment(const uint32_t alignment);
+
+	static obs_data_array_t* GetScenes();
+	static obs_data_t* GetSceneData(obs_source_t* source);
+
+	// TODO contribute a proper frontend API method for this to OBS and remove this hack
+	static QSpinBox* GetTransitionDurationControl();
+	static int GetTransitionDuration();
+	static void SetTransitionDuration(int ms);
+
+	static bool SetTransitionByName(QString transitionName);
+
+	static QPushButton* GetPreviewModeButtonControl();
+	static QLayout* GetPreviewLayout();
+
+	// TODO contribute a proper frontend API method for this to OBS and remove this hack
+	static void TransitionToProgram();
+
+	static QString OBSVersionString();
+
+	static QSystemTrayIcon* GetTrayIcon();
+	static void SysTrayNotify(
+		QString text,
+		QSystemTrayIcon::MessageIcon n,
+		QString title = QString("obs-websocket"));
+
+	static const char* GetRecordingFolder();
+	static bool SetRecordingFolder(const char* path);
+
+	static QString ParseDataToQueryString(obs_data_t* data);
+	static obs_hotkey_t* FindHotkeyByName(QString name);
+	static bool ReplayBufferEnabled();
+	static void StartReplayBuffer();
+	static bool IsRPHotkeySet();
+	static const char* GetFilenameFormatting();
+	static bool SetFilenameFormatting(const char* filenameFormatting);
+};

src/WSEvents.h

@@ -0,0 +1,133 @@
+/*
+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 hookTransitionBeginEvent();
+	void unhookTransitionBeginEvent();
+
+	uint64_t GetStreamingTime();
+	const char* GetStreamingTimecode();
+	uint64_t GetRecordingTime();
+	const char* GetRecordingTimecode();
+	obs_data_t* GetStats();
+
+	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 _recStarttime;
+
+	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 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 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 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 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,227 @@
+/**
+ * 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 <obs-data.h>
+
+#include "Config.h"
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+QHash<QString, HandlerResponse(*)(WSRequestHandler*)> WSRequestHandler::messageMap {
+	{ "GetVersion", WSRequestHandler::HandleGetVersion },
+	{ "GetAuthRequired", WSRequestHandler::HandleGetAuthRequired },
+	{ "Authenticate", WSRequestHandler::HandleAuthenticate },
+
+	{ "GetStats", WSRequestHandler::HandleGetStats },
+	{ "SetHeartbeat", WSRequestHandler::HandleSetHeartbeat },
+	{ "GetVideoInfo", WSRequestHandler::HandleGetVideoInfo },
+
+	{ "SetFilenameFormatting", WSRequestHandler::HandleSetFilenameFormatting },
+	{ "GetFilenameFormatting", WSRequestHandler::HandleGetFilenameFormatting },
+
+	{ "SetCurrentScene", WSRequestHandler::HandleSetCurrentScene },
+	{ "GetCurrentScene", WSRequestHandler::HandleGetCurrentScene },
+	{ "GetSceneList", WSRequestHandler::HandleGetSceneList },
+
+	{ "SetSourceRender", WSRequestHandler::HandleSetSceneItemRender }, // Retrocompat
+	{ "SetSceneItemRender", WSRequestHandler::HandleSetSceneItemRender },
+	{ "SetSceneItemPosition", WSRequestHandler::HandleSetSceneItemPosition },
+	{ "SetSceneItemTransform", WSRequestHandler::HandleSetSceneItemTransform },
+	{ "SetSceneItemCrop", WSRequestHandler::HandleSetSceneItemCrop },
+	{ "GetSceneItemProperties", WSRequestHandler::HandleGetSceneItemProperties },
+	{ "SetSceneItemProperties", WSRequestHandler::HandleSetSceneItemProperties },
+	{ "ResetSceneItem", WSRequestHandler::HandleResetSceneItem },
+	{ "DeleteSceneItem", WSRequestHandler::HandleDeleteSceneItem },
+	{ "DuplicateSceneItem", WSRequestHandler::HandleDuplicateSceneItem },
+	{ "ReorderSceneItems", WSRequestHandler::HandleReorderSceneItems },
+
+	{ "GetStreamingStatus", WSRequestHandler::HandleGetStreamingStatus },
+	{ "StartStopStreaming", WSRequestHandler::HandleStartStopStreaming },
+	{ "StartStopRecording", WSRequestHandler::HandleStartStopRecording },
+	{ "StartStreaming", WSRequestHandler::HandleStartStreaming },
+	{ "StopStreaming", WSRequestHandler::HandleStopStreaming },
+	{ "StartRecording", WSRequestHandler::HandleStartRecording },
+	{ "StopRecording", WSRequestHandler::HandleStopRecording },
+
+	{ "StartStopReplayBuffer", WSRequestHandler::HandleStartStopReplayBuffer },
+	{ "StartReplayBuffer", WSRequestHandler::HandleStartReplayBuffer },
+	{ "StopReplayBuffer", WSRequestHandler::HandleStopReplayBuffer },
+	{ "SaveReplayBuffer", WSRequestHandler::HandleSaveReplayBuffer },
+
+	{ "SetRecordingFolder", WSRequestHandler::HandleSetRecordingFolder },
+	{ "GetRecordingFolder", WSRequestHandler::HandleGetRecordingFolder },
+
+	{ "GetTransitionList", WSRequestHandler::HandleGetTransitionList },
+	{ "GetCurrentTransition", WSRequestHandler::HandleGetCurrentTransition },
+	{ "SetCurrentTransition", WSRequestHandler::HandleSetCurrentTransition },
+	{ "SetTransitionDuration", WSRequestHandler::HandleSetTransitionDuration },
+	{ "GetTransitionDuration", WSRequestHandler::HandleGetTransitionDuration },
+
+	{ "SetVolume", WSRequestHandler::HandleSetVolume },
+	{ "GetVolume", WSRequestHandler::HandleGetVolume },
+	{ "ToggleMute", WSRequestHandler::HandleToggleMute },
+	{ "SetMute", WSRequestHandler::HandleSetMute },
+	{ "GetMute", WSRequestHandler::HandleGetMute },
+	{ "SetSyncOffset", WSRequestHandler::HandleSetSyncOffset },
+	{ "GetSyncOffset", WSRequestHandler::HandleGetSyncOffset },
+	{ "GetSpecialSources", WSRequestHandler::HandleGetSpecialSources },
+	{ "GetSourcesList", WSRequestHandler::HandleGetSourcesList },
+	{ "GetSourceTypesList", WSRequestHandler::HandleGetSourceTypesList },
+	{ "GetSourceSettings", WSRequestHandler::HandleGetSourceSettings },
+	{ "SetSourceSettings", WSRequestHandler::HandleSetSourceSettings },
+	{ "TakeSourceScreenshot", WSRequestHandler::HandleTakeSourceScreenshot },
+
+	{ "GetSourceFilters", WSRequestHandler::HandleGetSourceFilters },
+	{ "AddFilterToSource", WSRequestHandler::HandleAddFilterToSource },
+	{ "RemoveFilterFromSource", WSRequestHandler::HandleRemoveFilterFromSource },
+	{ "ReorderSourceFilter", WSRequestHandler::HandleReorderSourceFilter },
+	{ "MoveSourceFilter", WSRequestHandler::HandleMoveSourceFilter },
+	{ "SetSourceFilterSettings", WSRequestHandler::HandleSetSourceFilterSettings },
+
+	{ "SetCurrentSceneCollection", WSRequestHandler::HandleSetCurrentSceneCollection },
+	{ "GetCurrentSceneCollection", WSRequestHandler::HandleGetCurrentSceneCollection },
+	{ "ListSceneCollections", WSRequestHandler::HandleListSceneCollections },
+
+	{ "SetCurrentProfile", WSRequestHandler::HandleSetCurrentProfile },
+	{ "GetCurrentProfile", WSRequestHandler::HandleGetCurrentProfile },
+	{ "ListProfiles", WSRequestHandler::HandleListProfiles },
+
+	{ "SetStreamSettings", WSRequestHandler::HandleSetStreamSettings },
+	{ "GetStreamSettings", WSRequestHandler::HandleGetStreamSettings },
+	{ "SaveStreamSettings", WSRequestHandler::HandleSaveStreamSettings },
+#if BUILD_CAPTIONS
+	{ "SendCaptions", WSRequestHandler::HandleSendCaptions },
+#endif
+
+	{ "GetStudioModeStatus", WSRequestHandler::HandleGetStudioModeStatus },
+	{ "GetPreviewScene", WSRequestHandler::HandleGetPreviewScene },
+	{ "SetPreviewScene", WSRequestHandler::HandleSetPreviewScene },
+	{ "TransitionToProgram", WSRequestHandler::HandleTransitionToProgram },
+	{ "EnableStudioMode", WSRequestHandler::HandleEnableStudioMode },
+	{ "DisableStudioMode", WSRequestHandler::HandleDisableStudioMode },
+	{ "ToggleStudioMode", WSRequestHandler::HandleToggleStudioMode },
+
+	{ "SetTextGDIPlusProperties", WSRequestHandler::HandleSetTextGDIPlusProperties },
+	{ "GetTextGDIPlusProperties", WSRequestHandler::HandleGetTextGDIPlusProperties },
+
+	{ "SetTextFreetype2Properties", WSRequestHandler::HandleSetTextFreetype2Properties },
+	{ "GetTextFreetype2Properties", WSRequestHandler::HandleGetTextFreetype2Properties },
+
+	{ "GetBrowserSourceProperties", WSRequestHandler::HandleGetBrowserSourceProperties },
+	{ "SetBrowserSourceProperties", WSRequestHandler::HandleSetBrowserSourceProperties }
+};
+
+QSet<QString> WSRequestHandler::authNotRequired {
+	"GetVersion",
+	"GetAuthRequired",
+	"Authenticate"
+};
+
+WSRequestHandler::WSRequestHandler(ConnectionProperties& connProperties) :
+	_messageId(0),
+	_requestType(""),
+	data(nullptr),
+	_connProperties(connProperties)
+{
+}
+
+std::string WSRequestHandler::processIncomingMessage(std::string& textMessage) {
+	if (GetConfig()->DebugEnabled) {
+		blog(LOG_INFO, "Request >> '%s'", textMessage.c_str());
+	}
+
+	OBSDataAutoRelease responseData = processRequest(textMessage);
+	std::string response = obs_data_get_json(responseData);
+
+	if (GetConfig()->DebugEnabled) {
+		blog(LOG_INFO, "Response << '%s'", response.c_str());
+	}
+
+	return response;
+}
+
+HandlerResponse WSRequestHandler::processRequest(std::string& textMessage){
+	std::string msgContainer(textMessage);
+	const char* msg = msgContainer.c_str();
+
+	data = obs_data_create_from_json(msg);
+	if (!data) {
+		blog(LOG_ERROR, "invalid JSON payload received for '%s'", msg);
+		return SendErrorResponse("invalid JSON payload");
+	}
+
+	if (!hasField("request-type") || !hasField("message-id")) {
+		return SendErrorResponse("missing request parameters");
+	}
+
+	_requestType = obs_data_get_string(data, "request-type");
+	_messageId = obs_data_get_string(data, "message-id");
+
+	if (GetConfig()->AuthRequired
+		&& (!authNotRequired.contains(_requestType))
+		&& (!_connProperties.isAuthenticated()))
+	{
+		return SendErrorResponse("Not Authenticated");
+	}
+
+	HandlerResponse (*handlerFunc)(WSRequestHandler*) = (messageMap[_requestType]);
+	if (!handlerFunc) {
+		return SendErrorResponse("invalid request type");
+	}
+
+	return handlerFunc(this);
+}
+
+WSRequestHandler::~WSRequestHandler() {
+}
+
+HandlerResponse WSRequestHandler::SendOKResponse(obs_data_t* additionalFields) {
+	return SendResponse("ok", additionalFields);
+}
+
+HandlerResponse WSRequestHandler::SendErrorResponse(const char* errorMessage) {
+	OBSDataAutoRelease fields = obs_data_create();
+	obs_data_set_string(fields, "error", errorMessage);
+
+	return SendResponse("error", fields);
+}
+
+HandlerResponse WSRequestHandler::SendErrorResponse(obs_data_t* additionalFields) {
+	return SendResponse("error", additionalFields);
+}
+
+HandlerResponse WSRequestHandler::SendResponse(const char* status, obs_data_t* fields) {
+	obs_data_t* response = obs_data_create();
+	obs_data_set_string(response, "message-id", _messageId);
+	obs_data_set_string(response, "status", status);
+
+	if (fields) {
+		obs_data_apply(response, fields);
+	}
+
+	return response;
+}
+
+bool WSRequestHandler::hasField(QString name) {
+	if (!data || name.isEmpty() || name.isNull())
+		return false;
+
+	return obs_data_has_user_value(data, name.toUtf8());
+}

src/WSRequestHandler.h

@@ -0,0 +1,163 @@
+/*
+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/QHash>
+#include <QtCore/QSet>
+#include <QtCore/QVariantHash>
+#include <QtCore/QString>
+#include <QtCore/QSharedPointer>
+
+#include <obs.hpp>
+#include <obs-frontend-api.h>
+
+#include "ConnectionProperties.h"
+
+#include "obs-websocket.h"
+
+typedef obs_data_t* HandlerResponse;
+
+class WSRequestHandler : public QObject {
+	Q_OBJECT
+
+	public:
+		explicit WSRequestHandler(ConnectionProperties& connProperties);
+		~WSRequestHandler();
+		std::string processIncomingMessage(std::string& textMessage);
+		bool hasField(QString name);
+
+	private:
+		const char* _messageId;
+		const char* _requestType;
+		ConnectionProperties& _connProperties;
+		OBSDataAutoRelease data;
+
+		HandlerResponse processRequest(std::string& textMessage);
+
+		HandlerResponse SendOKResponse(obs_data_t* additionalFields = nullptr);
+		HandlerResponse SendErrorResponse(const char* errorMessage);
+		HandlerResponse SendErrorResponse(obs_data_t* additionalFields = nullptr);
+		HandlerResponse SendResponse(const char* status, obs_data_t* additionalFields = nullptr);
+
+		static QHash<QString, HandlerResponse(*)(WSRequestHandler*)> messageMap;
+		static QSet<QString> authNotRequired;
+
+		static HandlerResponse HandleGetVersion(WSRequestHandler* req);
+		static HandlerResponse HandleGetAuthRequired(WSRequestHandler* req);
+		static HandlerResponse HandleAuthenticate(WSRequestHandler* req);
+
+		static HandlerResponse HandleGetStats(WSRequestHandler* req);
+		static HandlerResponse HandleSetHeartbeat(WSRequestHandler* req);
+		static HandlerResponse HandleGetVideoInfo(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetFilenameFormatting(WSRequestHandler* req);
+		static HandlerResponse HandleGetFilenameFormatting(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetCurrentScene(WSRequestHandler* req);
+		static HandlerResponse HandleGetCurrentScene(WSRequestHandler* req);
+		static HandlerResponse HandleGetSceneList(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetSceneItemRender(WSRequestHandler* req);
+		static HandlerResponse HandleSetSceneItemPosition(WSRequestHandler* req);
+		static HandlerResponse HandleSetSceneItemTransform(WSRequestHandler* req);
+		static HandlerResponse HandleSetSceneItemCrop(WSRequestHandler* req);
+		static HandlerResponse HandleGetSceneItemProperties(WSRequestHandler* req);
+		static HandlerResponse HandleSetSceneItemProperties(WSRequestHandler* req);
+		static HandlerResponse HandleResetSceneItem(WSRequestHandler* req);
+		static HandlerResponse HandleDuplicateSceneItem(WSRequestHandler* req);
+		static HandlerResponse HandleDeleteSceneItem(WSRequestHandler* req);
+		static HandlerResponse HandleReorderSceneItems(WSRequestHandler* req);
+
+		static HandlerResponse HandleGetStreamingStatus(WSRequestHandler* req);
+		static HandlerResponse HandleStartStopStreaming(WSRequestHandler* req);
+		static HandlerResponse HandleStartStopRecording(WSRequestHandler* req);
+		static HandlerResponse HandleStartStreaming(WSRequestHandler* req);
+		static HandlerResponse HandleStopStreaming(WSRequestHandler* req);
+		static HandlerResponse HandleStartRecording(WSRequestHandler* req);
+		static HandlerResponse HandleStopRecording(WSRequestHandler* req);
+
+		static HandlerResponse HandleStartStopReplayBuffer(WSRequestHandler* req);
+		static HandlerResponse HandleStartReplayBuffer(WSRequestHandler* req);
+		static HandlerResponse HandleStopReplayBuffer(WSRequestHandler* req);
+		static HandlerResponse HandleSaveReplayBuffer(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetRecordingFolder(WSRequestHandler* req);
+		static HandlerResponse HandleGetRecordingFolder(WSRequestHandler* req);
+
+		static HandlerResponse HandleGetTransitionList(WSRequestHandler* req);
+		static HandlerResponse HandleGetCurrentTransition(WSRequestHandler* req);
+		static HandlerResponse HandleSetCurrentTransition(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetVolume(WSRequestHandler* req);
+		static HandlerResponse HandleGetVolume(WSRequestHandler* req);
+		static HandlerResponse HandleToggleMute(WSRequestHandler* req);
+		static HandlerResponse HandleSetMute(WSRequestHandler* req);
+		static HandlerResponse HandleGetMute(WSRequestHandler* req);
+		static HandlerResponse HandleSetSyncOffset(WSRequestHandler* req);
+		static HandlerResponse HandleGetSyncOffset(WSRequestHandler* req);
+		static HandlerResponse HandleGetSpecialSources(WSRequestHandler* req);
+		static HandlerResponse HandleGetSourcesList(WSRequestHandler* req);
+		static HandlerResponse HandleGetSourceTypesList(WSRequestHandler* req);
+		static HandlerResponse HandleGetSourceSettings(WSRequestHandler* req);
+		static HandlerResponse HandleSetSourceSettings(WSRequestHandler* req);
+		static HandlerResponse HandleTakeSourceScreenshot(WSRequestHandler* req);
+
+		static HandlerResponse HandleGetSourceFilters(WSRequestHandler* req);
+		static HandlerResponse HandleAddFilterToSource(WSRequestHandler* req);
+		static HandlerResponse HandleRemoveFilterFromSource(WSRequestHandler* req);
+		static HandlerResponse HandleReorderSourceFilter(WSRequestHandler* req);
+		static HandlerResponse HandleMoveSourceFilter(WSRequestHandler* req);
+		static HandlerResponse HandleSetSourceFilterSettings(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetCurrentSceneCollection(WSRequestHandler* req);
+		static HandlerResponse HandleGetCurrentSceneCollection(WSRequestHandler* req);
+		static HandlerResponse HandleListSceneCollections(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetCurrentProfile(WSRequestHandler* req);
+		static HandlerResponse HandleGetCurrentProfile(WSRequestHandler* req);
+		static HandlerResponse HandleListProfiles(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetStreamSettings(WSRequestHandler* req);
+		static HandlerResponse HandleGetStreamSettings(WSRequestHandler* req);
+		static HandlerResponse HandleSaveStreamSettings(WSRequestHandler* req);
+#if BUILD_CAPTIONS
+		static HandlerResponse HandleSendCaptions(WSRequestHandler * req);
+#endif
+
+		static HandlerResponse HandleSetTransitionDuration(WSRequestHandler* req);
+		static HandlerResponse HandleGetTransitionDuration(WSRequestHandler* req);
+
+		static HandlerResponse HandleGetStudioModeStatus(WSRequestHandler* req);
+		static HandlerResponse HandleGetPreviewScene(WSRequestHandler* req);
+		static HandlerResponse HandleSetPreviewScene(WSRequestHandler* req);
+		static HandlerResponse HandleTransitionToProgram(WSRequestHandler* req);
+		static HandlerResponse HandleEnableStudioMode(WSRequestHandler* req);
+		static HandlerResponse HandleDisableStudioMode(WSRequestHandler* req);
+		static HandlerResponse HandleToggleStudioMode(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetTextGDIPlusProperties(WSRequestHandler* req);
+		static HandlerResponse HandleGetTextGDIPlusProperties(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetTextFreetype2Properties(WSRequestHandler* req);
+		static HandlerResponse HandleGetTextFreetype2Properties(WSRequestHandler* req);
+
+		static HandlerResponse HandleSetBrowserSourceProperties(WSRequestHandler* req);
+		static HandlerResponse HandleGetBrowserSourceProperties(WSRequestHandler* req);
+};

src/WSRequestHandler_General.cpp

@@ -0,0 +1,266 @@
+#include "obs-websocket.h"
+#include "Config.h"
+#include "Utils.h"
+#include "WSEvents.h"
+
+#include "WSRequestHandler.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").
+ *
+ * @api requests
+ * @name GetVersion
+ * @category general
+ * @since 0.3
+ */
+HandlerResponse WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
+	QString obsVersion = Utils::OBSVersionString();
+
+	QList<QString> names = req->messageMap.keys();
+	names.sort(Qt::CaseInsensitive);
+
+	// (Palakis) OBS' data arrays only support object arrays, so I improvised.
+	QString requests;
+	requests += names.takeFirst();
+	for (QString reqName : names) {
+		requests += ("," + reqName);
+	}
+
+	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());
+
+	return req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
+	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 req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
+	if (!req->hasField("auth")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	if (req->_connProperties.isAuthenticated()) {
+		return req->SendErrorResponse("already authenticated");
+	}
+
+	QString auth = obs_data_get_string(req->data, "auth");
+	if (auth.isEmpty()) {
+		return req->SendErrorResponse("auth not specified!");
+	}
+
+	if (GetConfig()->CheckAuth(auth) == false) {
+		return req->SendErrorResponse("Authentication Failed.");
+	}
+
+	req->_connProperties.setAuthenticated(true);
+	return req->SendOKResponse();
+}
+
+/**
+ * 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
+ */
+HandlerResponse WSRequestHandler::HandleSetHeartbeat(WSRequestHandler* req) {
+	if (!req->hasField("enable")) {
+		return req->SendErrorResponse("Heartbeat <enable> parameter missing");
+	}
+
+	auto events = GetEventsSystem();
+	events->HeartbeatIsActive = obs_data_get_bool(req->data, "enable");
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_bool(response, "enable", events->HeartbeatIsActive);
+	return req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
+	if (!req->hasField("filename-formatting")) {
+		return req->SendErrorResponse("<filename-formatting> parameter missing");
+	}
+
+	QString filenameFormatting = obs_data_get_string(req->data, "filename-formatting");
+	if (filenameFormatting.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	Utils::SetFilenameFormatting(filenameFormatting.toUtf8());
+	return req->SendOKResponse();
+}
+
+/**
+ * Get the filename formatting string
+ *
+ * @return {String} `filename-formatting` Current filename formatting string.
+ *
+ * @api requests
+ * @name GetFilenameFormatting
+ * @category general
+ * @since 4.3.0
+ */
+HandlerResponse WSRequestHandler::HandleGetFilenameFormatting(WSRequestHandler* req) {
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "filename-formatting", Utils::GetFilenameFormatting());
+	return req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleGetStats(WSRequestHandler* req) {
+	OBSDataAutoRelease stats = GetEventsSystem()->GetStats();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_obj(response, "stats", stats);
+	return req->SendOKResponse(response);
+}
+
+/**
+ * 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 
+ */
+HandlerResponse WSRequestHandler::HandleGetVideoInfo(WSRequestHandler* req) {
+	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 req->SendOKResponse(response);
+}

src/WSRequestHandler_Profiles.cpp

@@ -0,0 +1,65 @@
+#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
+ */
+HandlerResponse WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req) {
+	if (!req->hasField("profile-name")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	QString profileName = obs_data_get_string(req->data, "profile-name");
+	if (profileName.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	// TODO : check if profile exists
+	obs_frontend_set_current_profile(profileName.toUtf8());
+	return req->SendOKResponse();
+}
+
+ /**
+ * 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
+ */
+HandlerResponse WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "profile-name", obs_frontend_get_current_profile());
+	return req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleListProfiles(WSRequestHandler* req) {
+	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 req->SendOKResponse(response);
+}

src/WSRequestHandler_Recording.cpp

@@ -0,0 +1,105 @@
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+/**
+ * Toggle recording on or off.
+ *
+ * @api requests
+ * @name StartStopRecording
+ * @category recording
+ * @since 0.3
+ */
+HandlerResponse WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req) {
+	if (obs_frontend_recording_active())
+		obs_frontend_recording_stop();
+	else
+		obs_frontend_recording_start();
+
+	return req->SendOKResponse();
+}
+
+/**
+ * Start recording.
+ * Will return an `error` if recording is already active.
+ *
+ * @api requests
+ * @name StartRecording
+ * @category recording
+ * @since 4.1.0
+ */
+HandlerResponse WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
+	if (obs_frontend_recording_active() == false) {
+		obs_frontend_recording_start();
+		return req->SendOKResponse();
+	} else {
+		return req->SendErrorResponse("recording already active");
+	}
+}
+
+/**
+ * Stop recording.
+ * Will return an `error` if recording is not active.
+ *
+ * @api requests
+ * @name StopRecording
+ * @category recording
+ * @since 4.1.0
+ */
+ HandlerResponse WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
+	if (obs_frontend_recording_active() == true) {
+		obs_frontend_recording_stop();
+		return req->SendOKResponse();
+	} else {
+		return req->SendErrorResponse("recording not active");
+	}
+}
+
+/**
+ * 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
+ */
+HandlerResponse WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) {
+	if (!req->hasField("rec-folder")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	const char* newRecFolder = obs_data_get_string(req->data, "rec-folder");
+	bool success = Utils::SetRecordingFolder(newRecFolder);
+	if (!success) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	return req->SendOKResponse();
+}
+
+/**
+ * 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
+ */
+HandlerResponse WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) {
+	const char* recFolder = Utils::GetRecordingFolder();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "rec-folder", recFolder);
+
+	return req->SendOKResponse(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
+*/
+HandlerResponse WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
+	if (obs_frontend_replay_buffer_active()) {
+		obs_frontend_replay_buffer_stop();
+	} else {
+		Utils::StartReplayBuffer();
+	}
+	return req->SendOKResponse();
+}
+
+/**
+* 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
+*/
+HandlerResponse WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
+	if (!Utils::ReplayBufferEnabled()) {
+		return req->SendErrorResponse("replay buffer disabled in settings");
+	}
+
+	if (obs_frontend_replay_buffer_active() == true) {
+		return req->SendErrorResponse("replay buffer already active");
+	}
+
+	Utils::StartReplayBuffer();
+	return req->SendOKResponse();
+}
+
+/**
+* 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
+*/
+HandlerResponse WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
+	if (obs_frontend_replay_buffer_active() == true) {
+		obs_frontend_replay_buffer_stop();
+		return req->SendOKResponse();
+	} else {
+		return req->SendErrorResponse("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
+*/
+HandlerResponse WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
+	if (!obs_frontend_replay_buffer_active()) {
+		return req->SendErrorResponse("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 req->SendOKResponse();
+}

src/WSRequestHandler_SceneCollections.cpp

@@ -0,0 +1,68 @@
+#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
+ */
+HandlerResponse WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandler* req) {
+	if (!req->hasField("sc-name")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	QString sceneCollection = obs_data_get_string(req->data, "sc-name");
+	if (sceneCollection.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	// TODO : Check if specified profile exists and if changing is allowed
+	obs_frontend_set_current_scene_collection(sceneCollection.toUtf8());
+	return req->SendOKResponse();
+}
+
+/**
+ * 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
+ */
+HandlerResponse WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) {
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "sc-name",
+		obs_frontend_get_current_scene_collection());
+
+	return req->SendOKResponse(response);
+}
+
+/**
+ * List available scene collections
+ *
+ * @return {Array<String>} `scene-collections` Scene collections list
+ *
+ * @api requests
+ * @name ListSceneCollections
+ * @category scene collections
+ * @since 4.0.0
+ */
+HandlerResponse WSRequestHandler::HandleListSceneCollections(WSRequestHandler* req) {
+	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 req->SendOKResponse(response);
+}

src/WSRequestHandler_SceneItems.cpp

@@ -0,0 +1,606 @@
+#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` the name of the scene that the source item belongs to. Defaults to the current scene.
+* @param {String} `item` The name of the source.
+*
+* @return {String} `name` The name of the source.
+* @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} `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)
+* @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)
+* 
+* @api requests
+* @name GetSceneItemProperties
+* @category scene items
+* @since 4.3.0
+*/
+HandlerResponse WSRequestHandler::HandleGetSceneItemProperties(WSRequestHandler* req) {
+	if (!req->hasField("item")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	QString itemName = obs_data_get_string(req->data, "item");
+	if (itemName.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	OBSSceneItemAutoRelease sceneItem =
+		Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
+	OBSDataAutoRelease data = Utils::GetSceneItemPropertiesData(sceneItem);
+	obs_data_set_string(data, "name", itemName.toUtf8());
+
+	return req->SendOKResponse(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` the name of the scene that the source item belongs to. Defaults to the current scene.
+* @param {String} `item` The name of the source.
+* @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
+*/
+HandlerResponse WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
+	if (!req->hasField("item")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	QString itemName = obs_data_get_string(req->data, "item");
+	if (itemName.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	OBSSceneItemAutoRelease sceneItem =
+		Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
+	bool badRequest = false;
+	OBSDataAutoRelease errorMessage = obs_data_create();
+
+	obs_sceneitem_defer_update_begin(sceneItem);
+
+	if (req->hasField("position")) {
+		vec2 oldPosition;
+		OBSDataAutoRelease positionError = obs_data_create();
+		obs_sceneitem_get_pos(sceneItem, &oldPosition);
+		OBSDataAutoRelease reqPosition = obs_data_get_obj(req->data, "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(errorMessage, "position", positionError);
+			}
+		}
+		obs_sceneitem_set_pos(sceneItem, &newPosition);
+	}
+
+	if (req->hasField("rotation")) {
+		obs_sceneitem_set_rot(sceneItem, (float)obs_data_get_double(req->data, "rotation"));
+	}
+
+	if (req->hasField("scale")) {
+		vec2 oldScale;
+		obs_sceneitem_get_scale(sceneItem, &oldScale);
+		OBSDataAutoRelease reqScale = obs_data_get_obj(req->data, "scale");
+		vec2 newScale = oldScale;
+		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 (req->hasField("crop")) {
+		obs_sceneitem_crop oldCrop;
+		obs_sceneitem_get_crop(sceneItem, &oldCrop);
+		OBSDataAutoRelease reqCrop = obs_data_get_obj(req->data, "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 (req->hasField("visible")) {
+		obs_sceneitem_set_visible(sceneItem, obs_data_get_bool(req->data, "visible"));
+	}
+
+	if (req->hasField("locked")) {
+		obs_sceneitem_set_locked(sceneItem, obs_data_get_bool(req->data, "locked"));
+	}
+
+	if (req->hasField("bounds")) {
+		bool badBounds = false;
+		OBSDataAutoRelease boundsError = obs_data_create();
+		OBSDataAutoRelease reqBounds = obs_data_get_obj(req->data, "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(errorMessage, "bounds", boundsError);
+		}
+	}
+
+	obs_sceneitem_defer_update_end(sceneItem);
+
+	if (badRequest) {
+		return req->SendErrorResponse(errorMessage);
+	}
+
+	return req->SendOKResponse();
+}
+
+/**
+* Reset a scene item.
+*
+* @param {String (optional)} `scene-name` Name of the scene the source belongs to. Defaults to the current scene.
+* @param {String} `item` Name of the source item.
+*
+* @api requests
+* @name ResetSceneItem
+* @category scene items
+* @since 4.2.0
+*/
+HandlerResponse WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
+	// TODO: remove this request, or refactor it to ResetSource
+
+	if (!req->hasField("item")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	const char* itemName = obs_data_get_string(req->data, "item");
+	if (!itemName) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(req->data, "scene-name");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return req->SendErrorResponse("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 req->SendOKResponse();
+}
+
+/**
+* Show or hide a specified source item in a specified scene.
+*
+* @param {String} `source` Scene item name in the specified scene.
+* @param {boolean} `render` true = shown ; false = hidden
+* @param {String (optional)} `scene-name` Name of the scene where the source resides. Defaults to the currently active scene.
+*
+* @api requests
+* @name SetSceneItemRender
+* @category scene items
+* @since 0.3
+* @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
+*/
+HandlerResponse WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
+	if (!req->hasField("source") ||
+		!req->hasField("render"))
+	{
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	const char* itemName = obs_data_get_string(req->data, "source");
+	bool isVisible = obs_data_get_bool(req->data, "render");
+
+	if (!itemName) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(req->data, "scene-name");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	OBSSceneItemAutoRelease sceneItem =
+		Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
+	obs_sceneitem_set_visible(sceneItem, isVisible);
+	return req->SendOKResponse();
+}
+
+/**
+* Sets the coordinates of a specified source item.
+*
+* @param {String (optional)} `scene-name` The name of the scene that the source item belongs to. Defaults to the current scene.
+* @param {String} `item` The name of the source item.
+* @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.
+*/
+HandlerResponse WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
+	if (!req->hasField("item") ||
+		!req->hasField("x") || !req->hasField("y")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	QString itemName = obs_data_get_string(req->data, "item");
+	if (itemName.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene could not be found");
+	}
+
+	OBSSceneItem sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
+	vec2 item_position = { 0 };
+	item_position.x = obs_data_get_double(req->data, "x");
+	item_position.y = obs_data_get_double(req->data, "y");
+	obs_sceneitem_set_pos(sceneItem, &item_position);
+
+	return req->SendOKResponse();
+}
+
+/**
+* Set the transform of the specified source item.
+*
+* @param {String (optional)} `scene-name` The name of the scene that the source item belongs to. Defaults to the current scene.
+* @param {String} `item` The name of the source item.
+* @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.
+*/
+HandlerResponse WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
+	if (!req->hasField("item") ||
+		!req->hasField("x-scale") ||
+		!req->hasField("y-scale") ||
+		!req->hasField("rotation"))
+	{
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	QString itemName = obs_data_get_string(req->data, "item");
+	if (itemName.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	vec2 scale;
+	scale.x = obs_data_get_double(req->data, "x-scale");
+	scale.y = obs_data_get_double(req->data, "y-scale");
+	float rotation = obs_data_get_double(req->data, "rotation");
+
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return req->SendErrorResponse("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 req->SendOKResponse();
+}
+
+/**
+* Sets the crop coordinates of the specified source item.
+*
+* @param {String (optional)} `scene-name` the name of the scene that the source item belongs to. Defaults to the current scene.
+* @param {String} `item` The name of the source.
+* @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.
+*/
+HandlerResponse WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
+	if (!req->hasField("item")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	QString itemName = obs_data_get_string(req->data, "item");
+	if (itemName.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
+	struct obs_sceneitem_crop crop = { 0 };
+	crop.top = obs_data_get_int(req->data, "top");
+	crop.bottom = obs_data_get_int(req->data, "bottom");
+	crop.left = obs_data_get_int(req->data, "left");
+	crop.right = obs_data_get_int(req->data, "right");
+
+	obs_sceneitem_set_crop(sceneItem, &crop);
+
+	return req->SendOKResponse();
+}
+
+/**
+ * Deletes a scene item.
+ *
+ * @param {String (optional)} `scene` Name of the scene the source belongs to. Defaults to the current scene.
+ * @param {Object} `item` item to delete (required)
+ * @param {String} `item.name` name of the scene item (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` id of the scene item.
+ *
+ * @api requests
+ * @name DeleteSceneItem
+ * @category scene items
+ * @since 4.5.0
+ */
+HandlerResponse WSRequestHandler::HandleDeleteSceneItem(WSRequestHandler* req) {
+	if (!req->hasField("item")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(req->data, "scene");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	OBSDataAutoRelease item = obs_data_get_obj(req->data, "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromItem(scene, item);
+	if (!sceneItem) {
+		return req->SendErrorResponse("item with id/name combination not found in specified scene");
+	}
+
+	obs_sceneitem_remove(sceneItem);
+
+	return req->SendOKResponse();
+}
+
+struct DuplicateSceneItemData {
+	obs_sceneitem_t *referenceItem;
+	obs_source_t *fromSource;
+	obs_sceneitem_t *newItem;
+};
+
+static void DuplicateSceneItem(void *_data, obs_scene_t *scene) {
+	DuplicateSceneItemData *data = (DuplicateSceneItemData *)_data;
+	data->newItem = obs_scene_add(scene, data->fromSource);
+	obs_sceneitem_set_visible(data->newItem, obs_sceneitem_visible(data->referenceItem));
+}
+
+/**
+ * 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` item to duplicate (required)
+ * @param {String} `item.name` name of the scene item (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` id of the scene item.
+ *
+ * @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
+ */
+HandlerResponse WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req) {
+	if (!req->hasField("item")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	const char* fromSceneName = obs_data_get_string(req->data, "fromScene");
+	OBSSourceAutoRelease fromScene = Utils::GetSceneFromNameOrCurrent(fromSceneName);
+	if (!fromScene) {
+		return req->SendErrorResponse("requested fromScene doesn't exist");
+	}
+
+	const char* toSceneName = obs_data_get_string(req->data, "toScene");
+	OBSSourceAutoRelease toScene = Utils::GetSceneFromNameOrCurrent(toSceneName);
+	if (!toScene) {
+		return req->SendErrorResponse("requested toScene doesn't exist");
+	}
+
+	OBSDataAutoRelease item = obs_data_get_obj(req->data, "item");
+	OBSSceneItemAutoRelease referenceItem = Utils::GetSceneItemFromItem(fromScene, item);
+	if (!referenceItem) {
+		return req->SendErrorResponse("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(obs_scene_from_source(toScene), DuplicateSceneItem, &data);
+	obs_leave_graphics();
+
+	obs_sceneitem_t *newItem = data.newItem;
+	if (!newItem) {
+		return req->SendErrorResponse("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(toScene));
+
+	return req->SendOKResponse(responseData);
+}

src/WSRequestHandler_Scenes.cpp

@@ -0,0 +1,141 @@
+#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
+ */
+HandlerResponse WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) {
+	if (!req->hasField("scene-name")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(req->data, "scene-name");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName);
+
+	if (source) {
+		obs_frontend_set_current_scene(source);
+		return req->SendOKResponse();
+	} else {
+		return req->SendErrorResponse("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
+ */
+HandlerResponse WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
+	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 req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
+	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 req->SendOKResponse(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
+*/
+HandlerResponse WSRequestHandler::HandleReorderSceneItems(WSRequestHandler* req) {
+	QString sceneName = obs_data_get_string(req->data, "scene");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	OBSDataArrayAutoRelease items = obs_data_get_array(req->data, "items");
+	if (!items) {
+		return req->SendErrorResponse("sceneItem order not specified");
+	}
+
+	size_t count = obs_data_array_count(items);
+
+	std::vector<obs_sceneitem_t*> newOrder;
+	newOrder.reserve(count);
+
+	for (size_t i = 0; i < count; ++i) {
+		OBSDataAutoRelease item = obs_data_array_item(items, i);
+
+		OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromItem(scene, item);
+		obs_sceneitem_release(sceneItem); // ref dec
+
+		if (!sceneItem) {
+			return req->SendErrorResponse("Invalid sceneItem id or name specified");
+		}
+		
+		for (size_t j = 0; j <= i; ++j) {
+			if (sceneItem == newOrder[j]) {
+				return req->SendErrorResponse("Duplicate sceneItem in specified order");
+			}
+		}
+
+		newOrder.push_back(sceneItem);
+	}
+
+	bool success = obs_scene_reorder_items(obs_scene_from_source(scene), newOrder.data(), count);
+	if (!success) {
+		return req->SendErrorResponse("Invalid sceneItem order");
+	}
+
+	for (auto const& item: newOrder) {
+		obs_sceneitem_release(item);
+	}
+
+	return req->SendOKResponse();
+}

src/WSRequestHandler_Streaming.cpp

@@ -0,0 +1,318 @@
+#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
+ */
+HandlerResponse WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) {
+	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, "preview-only", false);
+
+	const char* tc = nullptr;
+	if (obs_frontend_streaming_active()) {
+		tc = events->GetStreamingTimecode();
+		obs_data_set_string(data, "stream-timecode", tc);
+		bfree((void*)tc);
+	}
+
+	if (obs_frontend_recording_active()) {
+		tc = events->GetRecordingTimecode();
+		obs_data_set_string(data, "rec-timecode", tc);
+		bfree((void*)tc);
+	}
+
+	return req->SendOKResponse(data);
+}
+
+/**
+ * Toggle streaming on or off.
+ *
+ * @api requests
+ * @name StartStopStreaming
+ * @category streaming
+ * @since 0.3
+ */
+HandlerResponse WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) {
+	if (obs_frontend_streaming_active())
+		return HandleStopStreaming(req);
+	else
+		return HandleStartStreaming(req);
+}
+
+/**
+ * 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
+ */
+HandlerResponse WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
+	if (obs_frontend_streaming_active() == false) {
+		OBSService configuredService = obs_frontend_get_streaming_service();
+		OBSService newService = nullptr;
+
+		// TODO: fix service memory leak
+
+		if (req->hasField("stream")) {
+			OBSDataAutoRelease streamData = obs_data_get_obj(req->data, "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");
+				int keylen = strlen(key);
+
+				bool hasQuestionMark = false;
+				for (int 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 req->SendOKResponse();
+	} else {
+		return req->SendErrorResponse("streaming already active");
+	}
+}
+
+/**
+ * Stop streaming.
+ * Will return an `error` if streaming is not active.
+ *
+ * @api requests
+ * @name StopStreaming
+ * @category streaming
+ * @since 4.1.0
+ */
+HandlerResponse WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
+	if (obs_frontend_streaming_active() == true) {
+		obs_frontend_streaming_stop();
+		return req->SendOKResponse();
+	} else {
+		return req->SendErrorResponse("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
+ */
+HandlerResponse WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
+	OBSService service = obs_frontend_get_streaming_service();
+
+	OBSDataAutoRelease requestSettings = obs_data_get_obj(req->data, "settings");
+	if (!requestSettings) {
+		return req->SendErrorResponse("'settings' are required'");
+	}
+
+	QString serviceType = obs_service_get_type(service);
+	QString requestedType = obs_data_get_string(req->data, "type");
+
+	if (requestedType != nullptr && requestedType != serviceType) {
+		OBSDataAutoRelease hotkeys = obs_hotkeys_save_service(service);
+		service = obs_service_create(
+			requestedType.toUtf8(), STREAM_SERVICE_ID, requestSettings, hotkeys);
+	} 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(req->data, "save")) {
+		obs_frontend_save_streaming_service();
+	}
+
+	OBSDataAutoRelease serviceSettings = obs_service_get_settings(service);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "type", requestedType.toUtf8());
+	obs_data_set_obj(response, "settings", serviceSettings);
+
+	return req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
+	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 req->SendOKResponse(response);
+}
+
+/**
+ * Save the current streaming server settings to disk.
+ *
+ * @api requests
+ * @name SaveStreamSettings
+ * @category streaming
+ * @since 4.1.0
+ */
+HandlerResponse WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) {
+	obs_frontend_save_streaming_service();
+	return req->SendOKResponse();
+}
+
+
+/**
+ * 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
+HandlerResponse WSRequestHandler::HandleSendCaptions(WSRequestHandler* req) {
+	if (!req->hasField("text")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	OBSOutputAutoRelease output = obs_frontend_get_streaming_output();
+	if (output) {
+		const char* caption = obs_data_get_string(req->data, "text");
+		obs_output_output_caption_text1(output, caption);
+	}
+
+	return req->SendOKResponse();
+}
+#endif
+

src/WSRequestHandler_StudioMode.cpp

@@ -0,0 +1,165 @@
+#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
+ */
+HandlerResponse WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* req) {
+	bool previewActive = obs_frontend_preview_program_mode_active();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_bool(response, "studio-mode", previewActive);
+
+	return req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return req->SendErrorResponse("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 req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return req->SendErrorResponse("studio mode not enabled");
+	}
+
+	if (!req->hasField("scene-name")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	const char* scene_name = obs_data_get_string(req->data, "scene-name");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(scene_name);
+	if (!scene) {
+		return req->SendErrorResponse("specified scene doesn't exist");
+	}
+
+	obs_frontend_set_current_preview_scene(scene);
+	return req->SendOKResponse();
+}
+
+/**
+ * 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
+ */
+HandlerResponse WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return req->SendErrorResponse("studio mode not enabled");
+	}
+
+	if (req->hasField("with-transition")) {
+		OBSDataAutoRelease transitionInfo =
+			obs_data_get_obj(req->data, "with-transition");
+
+		if (obs_data_has_user_value(transitionInfo, "name")) {
+			QString transitionName =
+				obs_data_get_string(transitionInfo, "name");
+			if (transitionName.isEmpty()) {
+				return req->SendErrorResponse("invalid request parameters");
+			}
+
+			bool success = Utils::SetTransitionByName(transitionName);
+			if (!success) {
+				return req->SendErrorResponse("specified transition doesn't exist");
+			}
+		}
+
+		if (obs_data_has_user_value(transitionInfo, "duration")) {
+			int transitionDuration =
+				obs_data_get_int(transitionInfo, "duration");
+			Utils::SetTransitionDuration(transitionDuration);
+		}
+	}
+
+	Utils::TransitionToProgram();
+	return req->SendOKResponse();
+}
+
+/**
+ * Enables Studio Mode.
+ *
+ * @api requests
+ * @name EnableStudioMode
+ * @category studio mode
+ * @since 4.1.0
+ */
+HandlerResponse WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
+	obs_frontend_set_preview_program_mode(true);
+	return req->SendOKResponse();
+}
+
+/**
+ * Disables Studio Mode.
+ *
+ * @api requests
+ * @name DisableStudioMode
+ * @category studio mode
+ * @since 4.1.0
+ */
+HandlerResponse WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
+	obs_frontend_set_preview_program_mode(false);
+	return req->SendOKResponse();
+}
+
+/**
+ * Toggles Studio Mode.
+ *
+ * @api requests
+ * @name ToggleStudioMode
+ * @category studio mode
+ * @since 4.1.0
+ */
+HandlerResponse WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) {
+	bool previewProgramMode = obs_frontend_preview_program_mode_active();
+	obs_frontend_set_preview_program_mode(!previewProgramMode);
+	return req->SendOKResponse();
+}

src/WSRequestHandler_Transitions.cpp

@@ -0,0 +1,122 @@
+#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
+ */
+HandlerResponse WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req) {
+	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 req->SendOKResponse(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
+ */
+HandlerResponse WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
+	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", Utils::GetTransitionDuration());
+
+	return req->SendOKResponse(response);
+}
+
+/**
+ * Set the active transition.
+ *
+ * @param {String} `transition-name` The name of the transition.
+ *
+ * @api requests
+ * @name SetCurrentTransition
+ * @category transitions
+ * @since 0.3
+ */
+HandlerResponse WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
+	if (!req->hasField("transition-name")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	QString name = obs_data_get_string(req->data, "transition-name");
+	bool success = Utils::SetTransitionByName(name);
+	if (!success) {
+		return req->SendErrorResponse("requested transition does not exist");
+	}
+	
+	return req->SendOKResponse();
+}
+
+/**
+ * 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
+ */
+HandlerResponse WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
+	if (!req->hasField("duration")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	int ms = obs_data_get_int(req->data, "duration");
+	Utils::SetTransitionDuration(ms);
+	return req->SendOKResponse();
+}
+
+/**
+ * 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
+ */
+HandlerResponse WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) {
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_int(response, "transition-duration", Utils::GetTransitionDuration());
+	return req->SendOKResponse(response);
+}

src/WSServer.cpp

@@ -0,0 +1,214 @@
+/*
+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"
+
+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.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);
+		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(std::string message)
+{
+	QMutexLocker locker(&_clMutex);
+	for (connection_hdl hdl : _connections) {
+		if (GetConfig()->AuthRequired) {
+			bool authenticated = _connectionProperties[hdl].isAuthenticated();
+			if (!authenticated) {
+				continue;
+			}
+		}
+		_server.send(hdl, message, websocketpp::frame::opcode::text);
+	}
+}
+
+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();
+
+		WSRequestHandler handler(connProperties);
+		std::string response = handler.processIncomingMessage(payload);
+
+		_server.send(hdl, response, websocketpp::frame::opcode::text);
+	});
+}
+
+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,72 @@
+/*
+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"
+
+QT_FORWARD_DECLARE_CLASS(QWebSocketServer)
+QT_FORWARD_DECLARE_CLASS(QWebSocket)
+
+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(std::string message);
+	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

@@ -18,11 +18,10 @@ 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 "../obs-websocket.h"
+#include "../Config.h"
+#include "../WSServer.h"
 #include "settings-dialog.h"
-#include "ui_settings-dialog.h"
 
 #define CHANGE_ME "changeme"
 
@@ -41,55 +40,48 @@ SettingsDialog::SettingsDialog(QWidget* parent) :
 	AuthCheckboxChanged();
 }
 
-void SettingsDialog::showEvent(QShowEvent* event)
-{
-	Config* conf = Config::Current();
+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()
-{
+void SettingsDialog::ToggleShowHide() {
 	if (!isVisible())
 		setVisible(true);
 	else
 		setVisible(false);
 }
 
-void SettingsDialog::AuthCheckboxChanged()
-{
+void SettingsDialog::AuthCheckboxChanged() {
 	if (ui->authRequired->isChecked())
 		ui->password->setEnabled(true);
 	else
 		ui->password->setEnabled(false);
 }
 
-void SettingsDialog::FormAccepted()
-{
-	Config* conf = Config::Current();
+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)
-		{
-			QByteArray pwd = ui->password->text().toUtf8();
-			const char *new_password = pwd;
-
-			conf->SetPassword(new_password);
+	if (ui->authRequired->isChecked()) {
+		if (ui->password->text() != CHANGE_ME) {
+			conf->SetPassword(ui->password->text());
 		}
 
-		if (strcmp(Config::Current()->Secret, "") != 0)
+		if (!GetConfig()->Secret.isEmpty())
 			conf->AuthRequired = true;
 		else
 			conf->AuthRequired = false;
@@ -101,13 +93,14 @@ void SettingsDialog::FormAccepted()
 
 	conf->Save();
 
-	if (conf->ServerEnabled)
-		WSServer::Instance->Start(conf->ServerPort);
-	else
-		WSServer::Instance->Stop();
+	auto server = GetServer();
+	if (conf->ServerEnabled) {
+		server->start(conf->ServerPort);
+	} else {
+		server->stop();
+	}
 }
 
-SettingsDialog::~SettingsDialog()
-{
+SettingsDialog::~SettingsDialog() {
 	delete ui;
 }

src/forms/settings-dialog.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016-2017	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,14 +16,11 @@ 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
 {
@@ -42,5 +39,3 @@ private Q_SLOTS:
 private:
 	Ui::SettingsDialog* ui;
 };
-
-#endif // SETTINGSDIALOG_H