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

Requests: Add scene transition override requests

.editorconfig

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

.gitignore

@@ -4,6 +4,7 @@
 /build32/
 /build64/
 /release/
+/package/
 /installer/Output/
-
+.idea
 .vscode

.gitmodules

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

.travis.yml

@@ -1,69 +0,0 @@
-language: cpp
-
-env:
-  global:
-  # AWS key ID
-  - secure: pAiNUGVbjP12BfnWPk0FFTkbnk4Tocvv88XiT3rzRqkQaD7/iyEogLBfHM4nOEgFiIMHbC41aE83w5JgRNPwn6mTgoQBOglzqq1tGuXfqPyV2VStk8beji1evubGoVjjPaoPTFyIdQc5GGxdHyogI/ed9Hb3ccyykYvjyolj9XoCiW42QHx60AHGwl+So+dEa8xydj9SLRPlZ/AitmI/cPVN3YotA7s37BLFiab54enxk7T4rwpR1nU0HVfoCpn5F4wZYxRq+LlSVFzC8vVE9cpDSLS5kjrZIZaT18tYG1/untCj+wqMIZbghaJXLtPSRW2YPHcJTz8q1YSXnJ19+0uiAIMAqaVv0kD5BAM97byYDBW+b9H6SYFkb/Pw/qcK9amMzMBjDPFpYFkl9Q2kzhsNs3HsZf/flSZjtrkQJiP3SOi/KvKzVK9X4Wym6hYZWHgmMTTYFrvr6BYnf2GkpfKNjm1d2kc0NNrq4d5H4NOEQB8MP+QH+o+BPeM6d9dthrUc1Pw+BXzOAr85CN4qtpPGoAl/Dbfgd6eu/88E2LpUufW2VFAOPWjykSOqzSN3orh7AaWuE34VFEnQ+2y3uIE8AKoyXzJv6zYkyNnNewKZeGe2kKYNwLn5UxQA9JEj7a+tvVevk4xBSkkjFAvjSG2z8/F1FXNbEfoLX1Hz/bU=
-  # 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:
-    - docker
-    before_install:
-    - docker run -d --name xenial -v $(dirname $(pwd)):/root -v /home/travis/package:/package
-      -e TRAVIS_BRANCH="$TRAVIS_BRANCH" -e TRAVIS_TAG="$TRAVIS_TAG" -w /root nimmis/ubuntu:16.04
-    - docker exec -it xenial /root/obs-websocket/CI/install-dependencies-xenial.sh
-    script:
-    - docker exec -it xenial /root/obs-websocket/CI/build-xenial.sh
-    after_success:
-    - docker exec -it xenial /root/obs-websocket/CI/package-xenial.sh
-
-  - os: osx
-    env: _macos_build
-    osx_image: xcode8.3
-    before_install: "./CI/install-dependencies-macos.sh"
-    script: "./CI/build-macos.sh"
-    after_success: 
-    - ./CI/package-macos.sh
-
-deploy:
-- provider: s3
-  region: eu-central-1
-  bucket: obs-websocket-linux-builds
-  access_key_id: "$AWS_ID"
-  secret_access_key: "$AWS_SECRET"
-  local_dir: /home/travis/package
-  skip_cleanup: true
-  acl: public_read
-  on:
-    repo: Palakis/obs-websocket
-    condition: 
-    - "$TRAVIS_OS_NAME = linux"
-    - "-d /home/travis/package"
-    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"
-    all_branches: true

BUILDING.md

@@ -1,38 +1,62 @@
 # Compiling obs-websocket
+
 ## Prerequisites
-You'll need [QT 5.9.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/) 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
-cmake -DLIBOBS_INCLUDE_DIR="<path to the libobs sub-folder in obs-studio's source code>" -DCMAKE_INSTALL_PREFIX=/usr ..
+cmake -DLIBOBS_INCLUDE_DIR="<path to the libobs sub-folder in obs-studio's source code>" -DCMAKE_INSTALL_PREFIX=/usr -DUSE_UBUNTU_FIX=true ..
 make -j4
 sudo make install
 ```
 
 ## OS X
-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-dependencies-macos.sh` will install it for you.
+
-Of course, you're encouraged to dig through the contents of these scripts to look for issues or specificities.
+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)
+- Windows: [![Automated Build status for Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history)
+- Linux: [![Automated Build status for Linux](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
+- macOS: [![Automated Build status for macOS](https://img.shields.io/azure-devops/build/Palakis/obs-websocket/Palakis.obs-websocket.svg)](https://dev.azure.com/Palakis/obs-websocket/_build)

CI/build-macos.sh

@@ -1,13 +1,28 @@
 #!/bin/sh
-set -ex
+
+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)"
 
-mkdir build && cd build
+echo "[obs-websocket] Building 'obs-websocket' for macOS."
+mkdir -p build && cd build
 cmake .. \
-  -DQTDIR=/usr/local/opt/qt \
+	-DQTDIR=/usr/local/opt/qt \
-  -DLIBOBS_INCLUDE_DIR=../../obs-studio/libobs \
+	-DLIBOBS_INCLUDE_DIR=../../obs-studio/libobs \
-  -DLIBOBS_LIB=../../obs-studio/libobs \
+	-DLIBOBS_LIB=../../obs-studio/libobs \
-  -DOBS_FRONTEND_LIB="$(pwd)/../../obs-studio/build/UI/obs-frontend-api/libobs-frontend-api.dylib" \
+	-DOBS_FRONTEND_LIB="$(pwd)/../../obs-studio/build/UI/obs-frontend-api/libobs-frontend-api.dylib" \
-  -DCMAKE_INSTALL_PREFIX=/usr \
+	-DCMAKE_BUILD_TYPE=RelWithDebInfo \
+	-DCMAKE_INSTALL_PREFIX=/usr \
 && make -j4

CI/build-ubuntu.sh

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

CI/build-xenial.sh

@@ -1,8 +0,0 @@
-#!/bin/sh
-set -ex
-
-cd /root/obs-websocket
-
-mkdir build && cd build
-cmake -DLIBOBS_INCLUDE_DIR="../../obs-studio/libobs" -DCMAKE_INSTALL_PREFIX=/usr ..
-make -j4

CI/download-obs-deps.cmd

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

CI/generate-docs.sh

@@ -4,6 +4,9 @@ echo "-- Generating documentation."
 echo "-- Node version: $(node -v)"
 echo "-- NPM version: $(npm -v)"
 
+git fetch origin
+git checkout ${CHECKOUT_REF/refs\/heads\//}
+
 cd docs
 npm install
 npm run build
@@ -11,23 +14,18 @@ npm run build
 echo "-- Documentation successfully generated."
 
 if git diff --quiet; then
-    echo "-- No documentation changes to commit."
+	echo "-- No documentation changes to commit."
-    exit 0
+	exit 0
-fi
-
-if [ "$TRAVIS_PULL_REQUEST" != "false" -o "$TRAVIS_BRANCH" != "master" ]; 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.name "Azure 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 commit -m "docs(ci): Update protocol.md - $(git rev-parse --short HEAD) [skip ci]"
-git push -q $GITHUB_REPO HEAD:$TRAVIS_BRANCH
+git push -q $GITHUB_REPO

CI/install-build-obs-macos.sh

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

CI/install-build-obs.cmd

@@ -1,118 +0,0 @@
-@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 --recursive https://github.com/jp9000/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 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" -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" -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

@@ -1,32 +1,61 @@
 #!/bin/sh
-set -ex
+
+
+
+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
-brew update
+echo "[obs-websocket] Updating Homebrew.."
-brew install ffmpeg
+brew update >/dev/null
-brew install libav
+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
-# qt latest
+echo "[obs-websocket] Installing obs-websocket dependency 'QT 5.10.1'.."
-#brew install qt5
+# =!= 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 =!=
 
-# qt 5.9.2
+brew install https://gist.githubusercontent.com/DDRBoxman/b3956fab6073335a4bf151db0dcbd4ad/raw/ed1342a8a86793ea8c10d8b4d712a654da121ace/qt.rb
-brew install https://raw.githubusercontent.com/Homebrew/homebrew-core/2b121c9a96e58a5da14228630cb71d5bead7137e/Formula/qt.rb
 
-#echo "Qt path: $(find /usr/local/Cellar/qt5 -d 1 | tail -n 1)"
+# Pin this version of QT5 to avoid `brew upgrade`
+# upgrading it to incompatible version
+brew pin qt
 
-# Build obs-studio
+# Fetch and install Packages app
-cd ..
+# =!= NOTICE =!=
-git clone --recursive https://github.com/jp9000/obs-studio
+# Installs a LaunchDaemon under /Library/LaunchDaemons/fr.whitebox.packages.build.dispatcher.plist
-cd obs-studio
+# =!= NOTICE =!=
-git checkout 21.0.0
-mkdir build && cd build
-cmake .. \
-  -DCMAKE_PREFIX_PATH=/usr/local/opt/qt/lib/cmake \
-&& make -j4
 
-# Packages app
+HAS_PACKAGES=$(type packagesbuild 2>/dev/null)
-cd ..
+
-curl -L -O  http://s.sudre.free.fr/Software/files/Packages.dmg -f --retry 5 -C -
+if [ "${HAS_PACKAGES}" = "" ]; then
-hdiutil attach ./Packages.dmg
+    echo "[obs-websocket] Installing Packaging app (might require password due to 'sudo').."
-sudo installer -pkg /Volumes/Packages\ 1.2.2/packages/Packages.pkg -target /
+    curl -o './Packages.pkg' --retry-connrefused -s --retry-delay 1 'https://s3-us-west-2.amazonaws.com/obs-nightly/Packages.pkg'
+    sudo installer -pkg ./Packages.pkg -target /
+fi

CI/install-dependencies-ubuntu.sh

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

CI/install-dependencies-xenial.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-set -ex
-
-# OBS Studio deps
-apt-get -qq update
-apt-get install -y \
-        libc-dev-bin libc6-dev \
-        git \
-        build-essential
-
-apt-get install -y \
-        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 \
-        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 21.0.0
-mkdir build && cd build
-cmake -DUNIX_STRUCTURE=1 -DCMAKE_INSTALL_PREFIX=/usr ..
-make -j4
-make install
-
-ldconfig

CI/install-qt-win.cmd

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

CI/install-setup-qt.cmd

@@ -1,6 +0,0 @@
-@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>
@@ -631,11 +514,11 @@
 			<key>CONCLUSION_ACTION</key>
 			<integer>0</integer>
 			<key>IDENTIFIER</key>
-			<string>fr.palakis.obswebsocket</string>
+			<string>fr.palakis.obs-websocket</string>
 			<key>OVERWRITE_PERMISSIONS</key>
 			<false/>
 			<key>VERSION</key>
-			<string>4.3.3</string>
+			<string>4.8.0</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

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

CI/package-ubuntu.sh

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

CI/package-windows.cmd

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

CI/package-xenial.sh

@@ -1,24 +0,0 @@
-#!/bin/sh
-
-set -e
-
-cd /root/obs-websocket
-
-export GIT_HASH=$(git rev-parse --short HEAD)
-export PKG_VERSION="1-$GIT_HASH-$TRAVIS_BRANCH-git"
-
-if [ -n "${TRAVIS_TAG}" ]; then
-	export PKG_VERSION="$TRAVIS_TAG"
-fi
-
-cd /root/obs-websocket/build
-
-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" \
-	--pkgsource="https://github.com/Palakis/obs-websocket" \
-	--pakdir="/package"
-
-chmod ao+r /package/*

CI/prepare-obs-windows.cmd

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

CI/prepare-windows.cmd

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

CMakeLists.txt

@@ -1,24 +1,27 @@
-cmake_minimum_required(VERSION 3.2)
+cmake_minimum_required(VERSION 3.5)
-project(obs-websocket)
+project(obs-websocket VERSION 4.8.0)
 
 set(CMAKE_PREFIX_PATH "${QTDIR}")
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTOUIC ON)
 
-include(external/FindLibObs.cmake)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+add_definitions(-DASIO_STANDALONE)
+
+if (WIN32 OR APPLE)
+	include(external/FindLibObs.cmake)
+endif()
 
 find_package(LibObs REQUIRED)
-find_package(Qt5Core REQUIRED)
+find_package(Qt5 REQUIRED COMPONENTS Core Widgets)
-find_package(Qt5WebSockets REQUIRED)
-find_package(Qt5Widgets REQUIRED)
-
-add_subdirectory(deps/mbedtls EXCLUDE_FROM_ALL)
-set(ENABLE_PROGRAMS false)
 
 set(obs-websocket_SOURCES
 	src/obs-websocket.cpp
 	src/WSServer.cpp
+	src/ConnectionProperties.cpp
 	src/WSRequestHandler.cpp
 	src/WSRequestHandler_General.cpp
 	src/WSRequestHandler_Profiles.cpp
@@ -31,18 +34,28 @@ set(obs-websocket_SOURCES
 	src/WSRequestHandler_Streaming.cpp
 	src/WSRequestHandler_StudioMode.cpp
 	src/WSRequestHandler_Transitions.cpp
+	src/WSRequestHandler_Outputs.cpp
 	src/WSEvents.cpp
 	src/Config.cpp
 	src/Utils.cpp
+	src/rpc/RpcRequest.cpp
+	src/rpc/RpcResponse.cpp
+	src/rpc/RpcEvent.cpp
+	src/protocol/OBSRemoteProtocol.cpp
 	src/forms/settings-dialog.cpp)
 
 set(obs-websocket_HEADERS
 	src/obs-websocket.h
 	src/WSServer.h
+	src/ConnectionProperties.h
 	src/WSRequestHandler.h
 	src/WSEvents.h
 	src/Config.h
 	src/Utils.h
+	src/rpc/RpcRequest.h
+	src/rpc/RpcResponse.h
+	src/rpc/RpcEvent.h
+	src/protocol/OBSRemoteProtocol.h
 	src/forms/settings-dialog.h)
 
 # --- Platform-independent build settings ---
@@ -50,22 +63,17 @@ 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/asio/asio/include"
-	"${CMAKE_SOURCE_DIR}/deps/mbedtls/include")
+	"${CMAKE_SOURCE_DIR}/deps/websocketpp")
 
 target_link_libraries(obs-websocket
 	libobs
 	Qt5::Core
-	Qt5::WebSockets
+	Qt5::Widgets)
-	Qt5::Widgets
-	mbedcrypto)
 
 # --- End of section ---
 
@@ -73,9 +81,16 @@ 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()
 
+    if(MSVC)
+        # Enable Multicore Builds and disable FH4 (to not depend on VCRUNTIME140_1.DLL)
+	    add_definitions(/MP /d2FH4-)
+    endif()
+
+	add_definitions(-D_WEBSOCKETPP_CPP11_STL_)
+
 	if(CMAKE_SIZEOF_VOID_P EQUAL 8)
 		set(ARCH_NAME "64bit")
 		set(OBS_BUILDDIR_ARCH "build64")
@@ -91,23 +106,12 @@ if(WIN32)
 	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")
 
 	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"
@@ -119,16 +123,45 @@ if(WIN32)
 
 		COMMAND if $<CONFIG:Release>==1 ("${CMAKE_COMMAND}" -E copy
 			"$<TARGET_FILE:obs-websocket>"
-			"${QTDIR}/bin/Qt5WebSockets.dll" 
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
-			"${QTDIR}/bin/Qt5Network.dll" 
+
+		# In Release mode, copy Qt image format plugins
+		COMMAND if $<CONFIG:Release>==1 (
+			"${CMAKE_COMMAND}" -E copy
+			"${QTDIR}/plugins/imageformats/qjpeg.dll"
+			"${RELEASE_DIR}/bin/${ARCH_NAME}/imageformats/qjpeg.dll")
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 (
+			"${CMAKE_COMMAND}" -E copy
+			"${QTDIR}/plugins/imageformats/qjpeg.dll"
+			"${RELEASE_DIR}/bin/${ARCH_NAME}/imageformats/qjpeg.dll")
+
+		# If config is RelWithDebInfo, package release files
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 (
+			"${CMAKE_COMMAND}" -E make_directory
+			"${RELEASE_DIR}/data/obs-plugins/obs-websocket"
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy_directory
+			"${PROJECT_SOURCE_DIR}/data"
+			"${RELEASE_DIR}/data/obs-plugins/obs-websocket")
+
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
+			"$<TARGET_FILE:obs-websocket>"
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+
+		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
+			"$<TARGET_PDB_FILE:obs-websocket>"
 			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
 
 		# Copy to obs-studio dev environment for immediate testing
 		COMMAND if $<CONFIG:Debug>==1 (
 			"${CMAKE_COMMAND}" -E copy
 				"$<TARGET_FILE:obs-websocket>"
-				"${QTDIR}/bin/Qt5WebSocketsd.dll"
+				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}")
-				"${QTDIR}/bin/Qt5Networkd.dll"
+
+		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 (
@@ -147,19 +180,22 @@ endif()
 
 # --- Linux-specific build settings and tasks ---
 if(UNIX AND NOT APPLE)
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+	include(GNUInstallDirs)
 
-	target_compile_options(mbedcrypto PRIVATE -fPIC)
 	set_target_properties(obs-websocket PROPERTIES PREFIX "")
-	target_link_libraries(obs-websocket
+	target_link_libraries(obs-websocket obs-frontend-api)
-		obs-frontend-api)
 
 	file(GLOB locale_files data/locale/*.ini)
 
+	if(${USE_UBUNTU_FIX})
+		install(TARGETS obs-websocket
+			LIBRARY DESTINATION "/usr/lib/obs-plugins")
+	endif()
 	install(TARGETS obs-websocket
-		LIBRARY DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/obs-plugins")
+		LIBRARY DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}/obs-plugins")
+
 	install(FILES ${locale_files}
-		DESTINATION "${CMAKE_INSTALL_PREFIX}/share/obs/obs-plugins/obs-websocket/locale")
+		DESTINATION "${CMAKE_INSTALL_FULL_DATAROOTDIR}/obs/obs-plugins/obs-websocket/locale")
 endif()
 # --- End of section ---
 
@@ -167,6 +203,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()

README.md

@@ -1,25 +1,30 @@
 obs-websocket
 ==============
-Remote control of OBS Studio made easy.
 
-Follow the project on Twitter for news & updates : [@obswebsocket](https://twitter.com/obswebsocket)
+WebSockets API for OBS Studio.
 
-[![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)
+Follow the main author on Twitter for news & updates : [@LePalakis](https://twitter.com/LePalakis)
+
+[![Build Status](https://dev.azure.com/Palakis/obs-websocket/_apis/build/status/Palakis.obs-websocket?branchName=4.x-current)](https://dev.azure.com/Palakis/obs-websocket/_build/latest?definitionId=2&branchName=4.x-current)
 
 ## Downloads
-Binaries for Windows and Linux are available in the [Releases](https://github.com/Palakis/obs-websocket/releases) section.
+
+Binaries for Windows, MacOS, and Linux are available in the [Releases](https://github.com/Palakis/obs-websocket/releases) section.
 
 ## Using obs-websocket
+
 A web client and frontend made by [t2t2](https://github.com/t2t2/obs-tablet-remote) (compatible with tablets and other touch interfaces) is available here : http://t2t2.github.io/obs-tablet-remote/
 
 It is **highly recommended** to protect obs-websocket with a password against unauthorized control. To do this, open the "Websocket server settings" dialog under OBS' "Tools" menu. In the settings dialogs, you can enable or disable authentication and set a password for it.
 
 ### Possible use cases
+
 - Remote control OBS from a phone or tablet on the same local network
-- Change your stream overlay/graphics based on the current scene (like the AGDQ overlay does)
+- Change your stream overlay/graphics based on the current scene
 - Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)
 
 ### For developers
+
 The server is a typical Websockets server running by default on port 4444 (the port number can be changed in the Settings dialog).
 The protocol understood by the server is documented in [PROTOCOL.md](docs/generated/protocol.md).
 
@@ -28,38 +33,92 @@ Here's a list of available language APIs for obs-websocket :
 - C#/VB.NET: [obs-websocket-dotnet](https://github.com/Palakis/obs-websocket-dotnet)
 - Python 2 and 3: [obs-websocket-py](https://github.com/Elektordi/obs-websocket-py) by Guillaume Genty a.k.a Elektordi
 - Python 3.5+ with asyncio: [obs-ws-rc](https://github.com/KirillMysnik/obs-ws-rc) by Kirill Mysnik
+- Python 3.6+ with asyncio: [simpleobsws](https://github.com/IRLToolkit/simpleobsws) by tt2468 
+- Java 8+: [obs-websocket-java](https://github.com/Twasi/websocket-obs-java) by TwasiNET
+- Golang: [go-obs-websocket](https://github.com/christopher-dG/go-obs-websocket) by Chris de Graaf
+- HTTP API: [obs-websocket-http](https://github.com/IRLToolkit/obs-websocket-http) by tt2468
 
-I'd like to know what you're building with or for obs-websocket. If you do something in this fashion, feel free to drop me an email at `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
+
+Development happens on `4.x-current`
+
+### Pull Requests
+
+Pull Requests must never be based off your fork's main branch (in this case, `4.x-current`). Start your work in a new branch
+based on the main one (e.g.: `cool-new-feature`, `fix-palakis-mistakes`, ...) and open a Pull Request once you feel ready to show your work.
+
+**If your Pull Request is not ready to merge yet, create it as a Draft Pull Request** (open the little arrow menu next to the "Create pull request" button, then select "Create draft pull request").
+
+### Code style & formatting
+
+Source code is indented with tabs, with spaces allowed for alignment.
+
+Regarding protocol changes: new and updated request types / events must always come with accompanying documentation comments (see existing protocol elements for examples).
+These are required to automatically generate the [protocol specification document](docs/generated/protocol.md).
+
+Among other recommendations: favor return-early code and avoid wrapping huge portions of code in conditionals. As an example, this:
+
+```cpp
+if (success) {
+    return req->SendOKResponse();
+} else {
+    return req->SendErrorResponse("something went wrong");
+}
+```
+
+is better like this:
+
+```cpp
+if (!success) {
+    return req->SendErrorResponse("something went wrong");
+}
+return req->SendOKResponse();
+```
+
+
 ## Translations
-**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 gooder English in the Protocol specification
+In (almost) order of appearance:
-- [Mikhail Swift](https://github.com/mikhailswift) : Code contributions
+
-- [Tobias Frahmer](https://github.com/Frahmer) : German localization
+- [Brendan H.](https://github.com/haganbmj): Code contributions and gooder English in the Protocol specification
-- [Genture](https://github.com/Genteure) : Simplified Chinese and Traditional Chinese localizations
+- [Mikhail Swift](https://github.com/mikhailswift): Code contributions
-- [Larissa Gabilan](https://github.com/laris151) : Portuguese localization
+- [Tobias Frahmer](https://github.com/Frahmer): Initial German localization
-- [Andy Asquelt](https://github.com/asquelt) : Polish localization
+- [Genture](https://github.com/Genteure): Initial Simplified Chinese and Traditional Chinese localizations
-- [Marcel Haazen](https://github.com/inpothet) : Dutch localization
+- [Larissa Gabilan](https://github.com/laris151): Initial Portuguese localization
-- [Peter Antonvich](https://github.com/pantonvich) : Code contributions
+- [Andy Asquelt](https://github.com/asquelt): Initial Polish localization
-- [yinzara](https://github.com/yinzara) : Code contributions
+- [Marcel Haazen](https://github.com/nekocentral): Initial Dutch localization
-- [Chris Angelico](https://github.com/Rosuav) : Code contributions
+- [Peter Antonvich](https://github.com/pantonvich): Code contributions
-- [Guillaume "Elektordi" Genty](https://github.com/Elektordi) : Code contributions
+- [yinzara](https://github.com/yinzara): Code contributions
-- [Marwin M](https://github.com/dragonbane0) : Code contributions
+- [Chris Angelico](https://github.com/Rosuav): Code contributions
-- [Logan S.](https://github.com/lsdaniel) : Code contributions
+- [Guillaume "Elektordi" Genty](https://github.com/Elektordi): Code contributions
-- [RainbowEK](https://github.com/RainbowEK) : Code contributions
+- [Marwin M](https://github.com/dragonbane0): Code contributions
-- [RytoEX](https://github.com/RytoEX) : CI script and code contributions
+- [Logan S.](https://github.com/lsdaniel): Code contributions
-- [Theodore Stoddard](https://github.com/TStod) : Code contributions
+- [RainbowEK](https://github.com/RainbowEK): Code contributions
-- [Philip Loche](https://github.com/PicoCentauri) : 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!
 
 ---

appveyor.yml

@@ -1,37 +0,0 @@
-environment:
-  CURL_VERSION: 7.39.0
-
-install:
-  - git submodule update --init --recursive
-  - cd C:\projects\
-  - 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=Release
-  - 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 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 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"
-  - call msbuild /m /p:Configuration=%build_config% C:\projects\obs-websocket\build64\obs-websocket.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
-
-before_deploy:
-  - 7z a "C:\projects\obs-websocket\build.zip" C:\projects\obs-websocket\release\*
-
-deploy_script:
-  - ps: Push-AppveyorArtifact "C:\projects\obs-websocket\build.zip" -FileName "obs-websocket-$(git log --pretty=format:'%h' -n 1).zip"
-
-test: off
-
-cache:
-  - C:\projects\dependencies2015.zip
-  - C:\projects\obs-studio-last-tag-built.txt
-  - C:\projects\obs-studio\

azure-pipelines.yml

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

data/locale/de-DE.ini

@@ -1,14 +1,16 @@
-OBSWebsocket.Menu.SettingsItem="Websocket-Server Einstellungen"
+OBSWebsocket.Settings.DialogTitle="WebSockets-Servereinstellungen"
-OBSWebsocket.Settings.DialogTitle="Websocket-Server Einstellungen"
+OBSWebsocket.Settings.ServerEnable="WebSockets-Server aktivieren"
-OBSWebsocket.Settings.ServerEnable="Websocket-Server aktivieren"
+OBSWebsocket.Settings.ServerPort="Server-Port"
-OBSWebsocket.Settings.ServerPort="Server Port"
+OBSWebsocket.Settings.AuthRequired="Authentifizierung aktivieren"
-OBSWebsocket.Settings.AuthRequired="Authentifizierung erforderlich"
 OBSWebsocket.Settings.Password="Passwort"
 OBSWebsocket.Settings.DebugEnable="Debug-Protokollierung aktivieren"
-OBSWebsocket.Settings.AlertsEnable="Infobereich-Benachrichtigungen aktivieren"
+OBSWebsocket.Settings.AlertsEnable="Infobereichbenachrichtigungen aktivieren"
-OBSWebsocket.NotifyConnect.Title="Neue WebSocket Verbindung"
+OBSWebsocket.NotifyConnect.Title="Neue Websocket-Verbindung"
 OBSWebsocket.NotifyConnect.Message="Client %1 verbunden"
-OBSWebsocket.NotifyDisconnect.Title="WebSocket-Client getrennt"
+OBSWebsocket.NotifyDisconnect.Title="Websocket-Client getrennt"
 OBSWebsocket.NotifyDisconnect.Message="Client %1 getrennt"
-OBSWebsocket.Server.StartFailed.Title="WebSocket-Server Fehler"
+OBSWebsocket.Server.StartFailed.Title="Websocket-Serverfehler"
-OBSWebsocket.Server.StartFailed.Message="Der WebSocket-Server konnte nicht gestartet werden, mögliche Gründe:\n - TCP Port %1 wird möglicherweise gerade von einem anderen Programm verwendet. Versuchen Sie einen anderen Port in den WebSocket-Server Einstellungen zu setzten oder alle Programme zu beenden, die den Port möglicherweise verwenden.\n - Ein unbekannter Netzwerkfehler ist aufgetreten. Versuchen Sie es erneut mit anderen Einstellungen, einem OBS neustart oder einem System neustart."
+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,6 +1,5 @@
-OBSWebsocket.Menu.SettingsItem="Websocket server settings"
+OBSWebsocket.Settings.DialogTitle="WebSockets Server Settings"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
+OBSWebsocket.Settings.ServerEnable="Enable WebSockets server"
-OBSWebsocket.Settings.ServerEnable="Enable Websocket server"
 OBSWebsocket.Settings.ServerPort="Server Port"
 OBSWebsocket.Settings.AuthRequired="Enable authentication"
 OBSWebsocket.Settings.Password="Password"
@@ -10,5 +9,8 @@ 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="WebSocket Server failure"
+OBSWebsocket.Server.StartFailed.Title="WebSockets Server failure"
-OBSWebsocket.Server.StartFailed.Message="The obs-websocket 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.Server.StartFailed.Message="The WebSockets server failed to start, maybe because:\n - TCP port %1 may currently be in use elsewhere on this system, possibly by another application. Try setting a different TCP port in the WebSocket server settings, or stop any application that could be using this port.\n - Error message: %2"
+OBSWebsocket.ProfileChanged.Started="WebSockets server enabled in this profile. Server started."
+OBSWebsocket.ProfileChanged.Stopped="WebSockets server disabled in this profile. Server stopped."
+OBSWebsocket.ProfileChanged.Restarted="WebSockets server port changed in this profile. Server restarted."

data/locale/es-ES.ini

@@ -1,14 +1,12 @@
-OBSWebsocket.Menu.SettingsItem="Configuración del servidor obs-websocket"
+OBSWebsocket.Settings.ServerEnable="Habilitar el servidor WebSockets"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Habilitar el servidor Websocket"
 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 de la bandeja de sistema"
+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="Fallo del servidor WebSocket"
+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 en uso en 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 ocurrido en su sistema. Inténtalo de nuevo cambiando la configuración, reiniciando OBS o reiniciando su sistema."
+OBSWebsocket.Server.StartFailed.Message="El servidor obs-websocket no se pudo iniciar, tal vez porque: \n - el puerto TCP %1 podría estar actualmente siendo usado este sistema, posiblemente por otra aplicación. Intente configurar un puerto TCP diferente en la configuración del servidor WebSocket, o detenga cualquier aplicación que pudiese estar utilizando este puerto \n - Un error de red desconocido ha afectado su sistema. Inténtelo de nuevo cambiando la configuración, reiniciando OBS o reiniciando su sistema."

data/locale/fr-FR.ini

@@ -1,4 +1,4 @@
-OBSWebsocket.Menu.SettingsItem="Paramètres du serveur Websocket"
+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"
@@ -9,5 +9,8 @@ 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 WebSocket"
+OBSWebsocket.Server.StartFailed.Title="Impossible de démarrer le serveur WebSockets"
-OBSWebsocket.Server.StartFailed.Message="Le serveur WebSocket 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.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

@@ -1,6 +1,4 @@
-OBSWebsocket.Menu.SettingsItem="Impostazioni del server di WebSocket"
+OBSWebsocket.Settings.ServerEnable="Abilitare il server WebSockets"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Abilitare il server Websocket"
 OBSWebsocket.Settings.ServerPort="Porta del server"
 OBSWebsocket.Settings.AuthRequired="Abilitare l'autenticazione"
 OBSWebsocket.Settings.Password="Password"
@@ -11,4 +9,4 @@ 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 obs-websocket: \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 WebSocket, 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."
+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

@@ -1,8 +1,11 @@
-OBSWebsocket.Menu.SettingsItem="Websocket サーバー設定"
+OBSWebsocket.Settings.ServerEnable="WebSockets サーバーを有効にする"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Websocket サーバーを有効にする"
 OBSWebsocket.Settings.ServerPort="サーバーポート"
 OBSWebsocket.Settings.AuthRequired="認証を有効にする"
 OBSWebsocket.Settings.Password="パスワード"
 OBSWebsocket.Settings.DebugEnable="デバッグログを有効にする"
-OBSWebsocket.NotifyConnect.Title="新しいWebSocket接続"
+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,14 +1,9 @@
-OBSWebsocket.Menu.SettingsItem="Websocket server instellingen"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Activeer Websocket server"
 OBSWebsocket.Settings.ServerPort="Serverpoort"
-OBSWebsocket.Settings.AuthRequired="Activeer authenticatie"
-OBSWebsocket.Settings.Password="Wachtwoord"
 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="WebSocket Server mislukt"
+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 wordt gebruikt elders op dit systeem, eventueel door een andere toepassing. Probeer een andere TCP-poort instellen in de WebSocket Server-instellingen of stoppen van elke toepassing die deze poort zouden kunnen gebruiken.\n Een onbekende netwerkfout gebeurde op uw systeem. Probeer het opnieuw door de instellingen wijzigen, OBS herstarten of opnieuw opstarten van uw systeem."
+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,14 +1,10 @@
-OBSWebsocket.Menu.SettingsItem="Ustawienia serwera zdalnego sterowania"
+OBSWebsocket.Settings.ServerEnable="Włącz serwer WebSockets"
-OBSWebsocket.Settings.DialogTitle="Serwer zdalnego sterowania"
+OBSWebsocket.Settings.AuthRequired="Wymagaj uwierzytelniania"
-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.DebugEnable="Włącz rejestrowanie debugowania"
-OBSWebsocket.Settings.AlertsEnable="Włącz powiadomienia o zasobniku systemowym"
+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 połączony"
+OBSWebsocket.NotifyDisconnect.Message="Klient %1 rozłączony"
-OBSWebsocket.Server.StartFailed.Title="Awaria serwera WebSocket"
+OBSWebsocket.Server.StartFailed.Title="Awaria serwera WebSockets"
-OBSWebsocket.Server.StartFailed.Message="Nie udało się uruchomić serwera obs-websocket, 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 WebSocket, 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."
+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,5 +0,0 @@
-OBSWebsocket.Menu.SettingsItem="Configuraçes do Servidor 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

@@ -1,5 +1,3 @@
-OBSWebsocket.Menu.SettingsItem="Configurações do servidor Websocket"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
 OBSWebsocket.Settings.ServerEnable="Habilitar servidor de WebSockets"
 OBSWebsocket.Settings.ServerPort="Porta do Servidor"
 OBSWebsocket.Settings.AuthRequired="Activar autenticação"
@@ -11,4 +9,4 @@ 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 obs-websocket 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 WebSocket, 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."
+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

@@ -1,8 +1,7 @@
-OBSWebsocket.Menu.SettingsItem="Параметры сервера Websocket"
+OBSWebsocket.Settings.DialogTitle="Настройки сервера WebSockets"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
+OBSWebsocket.Settings.ServerEnable="Включить сервер WebSockets"
-OBSWebsocket.Settings.ServerEnable="Включить сервер Websocket"
 OBSWebsocket.Settings.ServerPort="Порт сервера"
-OBSWebsocket.Settings.AuthRequired="Включить аутентификацию"
+OBSWebsocket.Settings.AuthRequired="Включить авторизацию"
 OBSWebsocket.Settings.Password="Пароль"
 OBSWebsocket.Settings.DebugEnable="Включить ведение журнала отладки"
 OBSWebsocket.Settings.AlertsEnable="Включить оповещения в системном трее"
@@ -10,5 +9,5 @@ OBSWebsocket.NotifyConnect.Title="Новое соединение WebSocket"
 OBSWebsocket.NotifyConnect.Message="Клиент %1 подключен"
 OBSWebsocket.NotifyDisconnect.Title="Клиент WebSocket отключён"
 OBSWebsocket.NotifyDisconnect.Message="Клиент %1 отключен"
-OBSWebsocket.Server.StartFailed.Title="Сбой сервера WebSocket"
+OBSWebsocket.Server.StartFailed.Title="Сбой сервера WebSockets"
-OBSWebsocket.Server.StartFailed.Message="Сбой запуска сервера obs-websocket. Вероятные причины:\n - Возможно, TCP-порт %1 занят другим приложением в системе. Попробуйте задать другой TCP-порт в настройках сервера WebSocket или закройте приложение, которое может использовать данный порт.\n - Произошла неизвестная сетевая ошибка в системе. Попробуйте снова после изменения настроек, перезапуска OBS или перезапуска системы."
+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.ServerEnable="启用 WebSockets 服务器"
-OBSWebsocket.Settings.DialogTitle="obs-websocket 设置"
-OBSWebsocket.Settings.ServerEnable="启用 Websocket 服务器"
 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.ServerPort="伺服器連接埠"
-OBSWebsocket.Settings.DialogTitle="obs-websocket 設定"
+OBSWebsocket.Settings.DebugEnable="啟用除錯日誌"
-OBSWebsocket.Settings.ServerEnable="啟用 Websocket 伺服器"
+OBSWebsocket.Settings.AlertsEnable="啟用系統列通知"
-OBSWebsocket.Settings.ServerPort="伺服器端口"
+OBSWebsocket.NotifyConnect.Title="新的 WebSocket 連線"
-OBSWebsocket.Settings.AuthRequired="啟用密碼認證"
+OBSWebsocket.NotifyConnect.Message="客戶端 %1 已連線"
-OBSWebsocket.Settings.Password="密碼"
+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/comments.js

@@ -30,6 +30,14 @@ const processComments = comments => {
     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);
 
@@ -84,9 +92,7 @@ const validateComment = comment => {
             fullContext: Object.assign({}, comment)
         };
     }
-
+};
-    return;
-}
 
 const files = glob.sync(config.srcGlob);
 const comments = processComments(parseFiles(files));

docs/partials/introduction.md

@@ -1,12 +1,11 @@
-# obs-websocket 4.3.2 protocol reference
+# obs-websocket 4.8.0 protocol reference
 
 # General Introduction
 Messages are exchanged between the client and the server as JSON objects.
 This protocol is based on the original OBS Remote protocol created by Bill Hamilton, with new commands specific to OBS Studio.
 
-
 # Authentication
-OBSWebSocket uses SHA256 to transmit credentials.
+`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.

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

@@ -7,6 +7,19 @@
 
 
 
+{{#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}}

installer/installer.iss

@@ -2,7 +2,7 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "obs-websocket"
-#define MyAppVersion "4.3.3"
+#define MyAppVersion "4.8.0"
 #define MyAppPublisher "Stephane Lepin"
 #define MyAppURL "http://github.com/Palakis/obs-websocket"
 
@@ -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,17 +37,32 @@ Name: "{group}\{cm:ProgramOnTheWeb,{#MyAppName}}"; Filename: "{#MyAppURL}"
 Name: "{group}\{cm:UninstallProgram,{#MyAppName}}"; Filename: "{uninstallexe}"
 
 [Code]
+procedure InitializeWizard();
+var
+  GPLText: AnsiString;
+  Page: TOutputMsgMemoWizardPage;
+begin
+  ExtractTemporaryFile('LICENSE');
+  LoadStringFromFile(ExpandConstant('{tmp}\LICENSE'), GPLText);
+
+  Page := CreateOutputMsgMemoPage(wpWelcome,
+    'License Information', 'Please review the license terms before installing obs-websocket',
+    'Press Page Down to see the rest of the agreement. Once you are aware of your rights, click Next to continue.',
+    String(GPLText)
+  );
+end;
+
 // credit where it's due :
 // following function come from https://github.com/Xaymar/obs-studio_amf-encoder-plugin/blob/master/%23Resources/Installer.in.iss#L45
 function GetDirName(Value: string): string;
 var
-  InstallPath: string;
+	InstallPath: string;
 begin
-  // initialize default path, which will be returned when the following registry
+	// initialize default path, which will be returned when the following registry
-  // key queries fail due to missing keys or for some different reason
+	// key queries fail due to missing keys or for some different reason
-  Result := '{pf}\obs-studio';
+	Result := '{pf}\obs-studio';
-  // query the first registry value; if this succeeds, return the obtained value
+	// query the first registry value; if this succeeds, return the obtained value
-  if RegQueryStringValue(HKLM32, 'SOFTWARE\OBS Studio', '', InstallPath) then
+	if RegQueryStringValue(HKLM32, 'SOFTWARE\OBS Studio', '', InstallPath) then
-    Result := InstallPath
+		Result := InstallPath
 end;
 

src/Config.cpp

@@ -16,11 +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/>
 */
 
-#include <mbedtls/base64.h>
-#include <mbedtls/sha256.h>
 #include <obs-frontend-api.h>
-#include <util/config-file.h>
+
-#include <string>
+#include <QtCore/QCryptographicHash>
+#include <QtCore/QTime>
+#include <QtWidgets/QSystemTrayIcon>
 
 #define SECTION_NAME "WebsocketAPI"
 #define PARAM_ENABLE "ServerEnabled"
@@ -31,166 +31,256 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 #define PARAM_SECRET "AuthSecret"
 #define PARAM_SALT "AuthSalt"
 
-#include "Config.h"
 #include "Utils.h"
+#include "WSServer.h"
+
+#include "Config.h"
 
 #define QT_TO_UTF8(str) str.toUtf8().constData()
 
-Config* Config::_instance = new Config();
-
 Config::Config() :
-    ServerEnabled(true),
+	ServerEnabled(true),
-    ServerPort(4444),
+	ServerPort(4444),
-    DebugEnabled(false),
+	DebugEnabled(false),
-    AlertsEnabled(true),
+	AlertsEnabled(true),
-    AuthRequired(false),
+	AuthRequired(false),
-    Secret(""),
+	Secret(""),
-    Salt(""),
+	Salt(""),
-    SettingsLoaded(false)
+	SettingsLoaded(false)
 {
-    // OBS Config defaults
+	qsrand(QTime::currentTime().msec());
-    config_t* obsConfig = obs_frontend_get_global_config();
-    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,
+	SetDefaults();
-            SECTION_NAME, PARAM_DEBUG, DebugEnabled);
+	SessionChallenge = GenerateSalt();
-        config_set_default_bool(obsConfig,
-            SECTION_NAME, PARAM_ALERT, AlertsEnabled);
 
-        config_set_default_bool(obsConfig,
+	obs_frontend_add_event_callback(OnFrontendEvent, this);
-            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));
-    }
-
-    mbedtls_entropy_init(&entropy);
-    mbedtls_ctr_drbg_init(&rng);
-    mbedtls_ctr_drbg_seed(&rng, mbedtls_entropy_func, &entropy, nullptr, 0);
-
-    SessionChallenge = GenerateSalt();
 }
 
-Config::~Config() {
+Config::~Config()
-    mbedtls_ctr_drbg_free(&rng);
+{
-    mbedtls_entropy_free(&entropy);
+	obs_frontend_remove_event_callback(OnFrontendEvent, this);
 }
 
-void Config::Load() {
+void Config::Load()
-    config_t* obsConfig = obs_frontend_get_global_config();
+{
+	config_t* obsConfig = GetConfigStore();
 
-    ServerEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ENABLE);
+	ServerEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ENABLE);
-    ServerPort = config_get_uint(obsConfig, SECTION_NAME, PARAM_PORT);
+	ServerPort = config_get_uint(obsConfig, SECTION_NAME, PARAM_PORT);
 
-    DebugEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_DEBUG);
+	DebugEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_DEBUG);
-    AlertsEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ALERT);
+	AlertsEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ALERT);
 
-    AuthRequired = config_get_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED);
+	AuthRequired = config_get_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED);
-    Secret = config_get_string(obsConfig, SECTION_NAME, PARAM_SECRET);
+	Secret = config_get_string(obsConfig, SECTION_NAME, PARAM_SECRET);
-    Salt = config_get_string(obsConfig, SECTION_NAME, PARAM_SALT);
+	Salt = config_get_string(obsConfig, SECTION_NAME, PARAM_SALT);
 }
 
-void Config::Save() {
+void Config::Save()
-    config_t* obsConfig = obs_frontend_get_global_config();
+{
+	config_t* obsConfig = GetConfigStore();
 
-    config_set_bool(obsConfig, SECTION_NAME, PARAM_ENABLE, ServerEnabled);
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_ENABLE, ServerEnabled);
-    config_set_uint(obsConfig, SECTION_NAME, PARAM_PORT, ServerPort);
+	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_DEBUG, DebugEnabled);
-    config_set_bool(obsConfig, SECTION_NAME, PARAM_ALERT, AlertsEnabled);
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_ALERT, AlertsEnabled);
 
-    config_set_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED, AuthRequired);
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED, AuthRequired);
-    config_set_string(obsConfig, SECTION_NAME, PARAM_SECRET,
+	config_set_string(obsConfig, SECTION_NAME, PARAM_SECRET,
-        QT_TO_UTF8(Secret));
+		QT_TO_UTF8(Secret));
-    config_set_string(obsConfig, SECTION_NAME, PARAM_SALT,
+	config_set_string(obsConfig, SECTION_NAME, PARAM_SALT,
-        QT_TO_UTF8(Salt));
+		QT_TO_UTF8(Salt));
 
-    config_save(obsConfig);
+	config_save(obsConfig);
 }
 
-QString Config::GenerateSalt() {
+void Config::SetDefaults()
-    // Generate 32 random chars
+{
-    unsigned char* randomChars = (unsigned char*)bzalloc(32);
+	// OBS Config defaults
-    mbedtls_ctr_drbg_random(&rng, randomChars, 32);
+	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);
 
-    // Convert the 32 random chars to a base64 string
+		config_set_default_bool(obsConfig,
-    char* salt = (char*)bzalloc(64);
+			SECTION_NAME, PARAM_DEBUG, DebugEnabled);
-    size_t saltBytes;
+		config_set_default_bool(obsConfig,
-    mbedtls_base64_encode(
+			SECTION_NAME, PARAM_ALERT, AlertsEnabled);
-        (unsigned char*)salt, 64, &saltBytes,
-        randomChars, 32);
 
-    bfree(randomChars);
+		config_set_default_bool(obsConfig,
-    return salt;
+			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));
+	}
 }
 
-QString Config::GenerateSecret(QString password, QString salt) {
+config_t* Config::GetConfigStore()
-    // Concatenate the password and the salt
+{
-    QString passAndSalt = "";
+	return obs_frontend_get_profile_config();
-    passAndSalt += password;
-    passAndSalt += salt;
-
-    // Generate a SHA256 hash of the password
-    unsigned char* challengeHash = (unsigned char*)bzalloc(32);
-    mbedtls_sha256(
-        (unsigned char*)passAndSalt.toUtf8().constData(), passAndSalt.length(),
-        challengeHash, 0);
-
-    // Encode SHA256 hash to Base64
-    char* challenge = (char*)bzalloc(64);
-    size_t challengeBytes = 0;
-    mbedtls_base64_encode(
-        (unsigned char*)challenge, 64, &challengeBytes,
-        challengeHash, 32);
-
-    bfree(challengeHash);
-    return challenge;
 }
 
-void Config::SetPassword(QString password) {
+QString Config::GenerateSalt()
-    QString newSalt = GenerateSalt();
+{
-    QString newChallenge = GenerateSecret(password, newSalt);
+	// Generate 32 random chars
+	const size_t randomCount = 32;
+	QByteArray randomChars;
+	for (size_t i = 0; i < randomCount; i++) {
+		randomChars.append((char)qrand());
+	}
 
-    this->Salt = newSalt;
+	// Convert the 32 random chars to a base64 string
-    this->Secret = newChallenge;
+	QString salt = randomChars.toBase64();
+
+	return salt;
 }
 
-bool Config::CheckAuth(QString response) {
+QString Config::GenerateSecret(QString password, QString salt)
-    // Concatenate auth secret with the challenge sent to the user
+{
-    QString challengeAndResponse = "";
+	// Concatenate the password and the salt
-    challengeAndResponse += Secret;
+	QString passAndSalt = "";
-    challengeAndResponse += SessionChallenge;
+	passAndSalt += password;
+	passAndSalt += salt;
 
-    // Generate a SHA256 hash of challengeAndResponse
+	// Generate a SHA256 hash of the password and salt
-    unsigned char* hash = (unsigned char*)bzalloc(32);
+	auto challengeHash = QCryptographicHash::hash(
-    mbedtls_sha256(
+		passAndSalt.toUtf8(),
-        (unsigned char*)challengeAndResponse.toUtf8().constData(),
+		QCryptographicHash::Algorithm::Sha256
-        challengeAndResponse.length(),
+	);
-        hash, 0);
 
-    // Encode the SHA256 hash to Base64
+	// Encode SHA256 hash to Base64
-    char* expectedResponse = (char*)bzalloc(64);
+	QString challenge = challengeHash.toBase64();
-    size_t base64_size = 0;
-    mbedtls_base64_encode(
-        (unsigned char*)expectedResponse, 64, &base64_size,
-        hash, 32);
 
-    bool authSuccess = false;
+	return challenge;
-    if (response == QString(expectedResponse)) {
-        SessionChallenge = GenerateSalt();
-        authSuccess = true;
-    }
-
-    bfree(hash);
-    bfree(expectedResponse);
-    return authSuccess;
 }
 
-Config* Config::Current() {
+void Config::SetPassword(QString password)
-    return _instance;
+{
+	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,45 +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
+#pragma once
-#define CONFIG_H
 
-#include <QString>
+#include <obs-frontend-api.h>
-
+#include <util/config-file.h>
-#include <mbedtls/entropy.h>
+#include <QtCore/QString>
-#include <mbedtls/ctr_drbg.h>
+#include <QtCore/QSharedPointer>
 
 class Config {
-  public:
+	public:
-    Config();
+		Config();
-    ~Config();
+		~Config();
-    void Load();
+		void Load();
-    void Save();
+		void Save();
+		void SetDefaults();
+		config_t* GetConfigStore();
 
-    void SetPassword(QString password);
+		void MigrateFromGlobalSettings();
-    bool CheckAuth(QString userChallenge);
-    QString GenerateSalt();
-    static QString GenerateSecret(
-        QString password, QString salt);
 
-    bool ServerEnabled;
+		void SetPassword(QString password);
-    uint64_t ServerPort;
+		bool CheckAuth(QString userChallenge);
+		QString GenerateSalt();
+		static QString GenerateSecret(
+				QString password, QString salt);
 
-    bool DebugEnabled;
+		bool ServerEnabled;
-    bool AlertsEnabled;
+		uint64_t ServerPort;
 
-    bool AuthRequired;
+		bool DebugEnabled;
-    QString Secret;
+		bool AlertsEnabled;
-    QString Salt;
-    QString SessionChallenge;
-    bool SettingsLoaded;
 
-    static Config* Current();
+		bool AuthRequired;
+		QString Secret;
+		QString Salt;
+		QString SessionChallenge;
+		bool SettingsLoaded;
 
-  private:
+	private:
-    static Config* _instance;
+		static void OnFrontendEvent(enum obs_frontend_event event, void* param);
-    mbedtls_entropy_context entropy;
-    mbedtls_ctr_drbg_context rng;
 };
-
-#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

@@ -0,0 +1,31 @@
+/*
+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 <atomic>
+
+class ConnectionProperties
+{
+public:
+    explicit ConnectionProperties();
+    bool isAuthenticated();
+    void setAuthenticated(bool authenticated);
+private:
+    std::atomic<bool> _authenticated;
+};

src/Utils.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,70 +16,73 @@ 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
+#pragma once
-#define UTILS_H
 
 #include <stdio.h>
 
-#include <QSpinBox>
+#include <QtCore/QString>
-#include <QPushButton>
+#include <QtWidgets/QSpinBox>
-#include <QLayout>
+#include <QtWidgets/QPushButton>
-#include <QListWidget>
+#include <QtWidgets/QLayout>
-#include <QSystemTrayIcon>
+#include <QtWidgets/QListWidget>
-#include <QHostAddress>
+#include <QtWidgets/QSystemTrayIcon>
 
 #include <obs.hpp>
 #include <obs-module.h>
 #include <util/config-file.h>
 
-class Utils {
+typedef void(*PauseRecordingFunction)(bool);
-  public:
+typedef bool(*RecordingPausedFunction)();
-    static obs_data_array_t* StringListToArray(char** strings, 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_source_t* GetTransitionFromName(QString transitionName);
-    static obs_source_t* GetSceneFromNameOrCurrent(QString sceneName);
 
-    static bool IsValidAlignment(const uint32_t alignment);
+namespace Utils {
+	obs_data_array_t* StringListToArray(char** strings, const char* key);
+	obs_data_array_t* GetSceneItems(obs_source_t* source);
+	obs_data_t* GetSceneItemData(obs_sceneitem_t* item);
 
-    static obs_data_array_t* GetScenes();
+	// These functions support nested lookup into groups
-    static obs_data_t* GetSceneData(obs_source_t* source);
+	obs_sceneitem_t* GetSceneItemFromName(obs_scene_t* scene, QString name);
+	obs_sceneitem_t* GetSceneItemFromId(obs_scene_t* scene, int64_t id);
+	obs_sceneitem_t* GetSceneItemFromItem(obs_scene_t* scene, obs_data_t* item);
+	obs_sceneitem_t* GetSceneItemFromRequestField(obs_scene_t* scene, obs_data_item_t* dataItem);
 
-    static QSpinBox* GetTransitionDurationControl();
+	obs_scene_t* GetSceneFromNameOrCurrent(QString sceneName);
-    static int GetTransitionDuration();
+	obs_data_t* GetSceneItemPropertiesData(obs_sceneitem_t* item);
-    static void SetTransitionDuration(int ms);
 
-    static bool SetTransitionByName(QString transitionName);
+	obs_data_t* GetSourceFilterInfo(obs_source_t* filter, bool includeSettings);
+	obs_data_array_t* GetSourceFiltersList(obs_source_t* source, bool includeSettings);
 
-    static QPushButton* GetPreviewModeButtonControl();
+	bool IsValidAlignment(const uint32_t alignment);
-    static QLayout* GetPreviewLayout();
-    static QListWidget* GetSceneListControl();
-    static obs_scene_t* SceneListItemToScene(QListWidgetItem* item);
 
-    static void TransitionToProgram();
+	obs_data_array_t* GetScenes();
+	obs_data_t* GetSceneData(obs_source_t* source);
 
-    static QString OBSVersionString();
+	// TODO contribute a proper frontend API method for this to OBS and remove this hack
+	QSpinBox* GetTransitionDurationControl();
+	int GetTransitionDuration(obs_source_t* transition);
+	obs_source_t* GetTransitionFromName(QString transitionName);
+	bool SetTransitionByName(QString transitionName);
+	obs_data_t* GetTransitionData(obs_source_t* transition);
 
-    static QSystemTrayIcon* GetTrayIcon();
+	QString OBSVersionString();
-    static void SysTrayNotify(
-        QString &text,
-        QSystemTrayIcon::MessageIcon n,
-        QString title = QString("obs-websocket"));
 
-    static QString FormatIPAddress(QHostAddress &addr);
+	QSystemTrayIcon* GetTrayIcon();
+	void SysTrayNotify(
+		QString text,
+		QSystemTrayIcon::MessageIcon n,
+		QString title = QString("obs-websocket"));
 
-    static const char* GetRecordingFolder();
+	const char* GetRecordingFolder();
-    static bool SetRecordingFolder(const char* path);
+	bool SetRecordingFolder(const char* path);
 
-    static QString ParseDataToQueryString(obs_data_t* data);
+	QString ParseDataToQueryString(obs_data_t* data);
-    static obs_hotkey_t* FindHotkeyByName(QString name);
+	obs_hotkey_t* FindHotkeyByName(QString name);
-    static bool ReplayBufferEnabled();
+
-    static void StartReplayBuffer();
+	bool ReplayBufferEnabled();
-    static bool IsRPHotkeySet();
+	void StartReplayBuffer();
-    static const char* GetFilenameFormatting();
+	bool IsRPHotkeySet();
-    static bool SetFilenameFormatting(const char* filenameFormatting);
+
+	const char* GetFilenameFormatting();
+	bool SetFilenameFormatting(const char* filenameFormatting);
+
+	QString nsToTimestamp(uint64_t ns);
 };
-
-#endif // UTILS_H

src/WSEvents.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>
 Copyright (C) 2017	Brendan Hagan <https://github.com/haganbmj>
 
 This program is free software; you can redistribute it and/or modify
@@ -17,95 +17,129 @@ 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
+#pragma once
-#define WSEVENTS_H
 
 #include <obs.hpp>
 #include <obs-frontend-api.h>
-#include <QListWidgetItem>
+#include <util/platform.h>
+
+#include <QtWidgets/QListWidgetItem>
+#include <QtCore/QSharedPointer>
+#include <QtCore/QTimer>
+
 #include "WSServer.h"
 
-class WSEvents : public QObject {
+class WSEvents : public QObject
-  Q_OBJECT
+{
-  public:
+Q_OBJECT
-    explicit WSEvents(WSServer* srv);
-    ~WSEvents();
-    static void FrontendEventHandler(
-        enum obs_frontend_event event, void* privateData);
-    static WSEvents* Instance;
-    void connectTransitionSignals(obs_source_t* transition);
-    void connectSceneSignals(obs_source_t* scene);
 
-    uint64_t GetStreamingTime();
+public:
-    const char* GetStreamingTimecode();
+	explicit WSEvents(WSServerPtr srv);
-    uint64_t GetRecordingTime();
+	~WSEvents();
-    const char* GetRecordingTimecode();
 
-    bool HeartbeatIsActive;
+	void connectSourceSignals(obs_source_t* source);
+	void disconnectSourceSignals(obs_source_t* source);
 
-  private slots:
+	void connectFilterSignals(obs_source_t* filter);
-    void deferredInitOperations();
+	void disconnectFilterSignals(obs_source_t* filter);
-    void StreamStatus();
-    void Heartbeat();
-    void TransitionDurationChanged(int ms);
-    void SelectedSceneChanged(
-        QListWidgetItem* current, QListWidgetItem* prev);
 
-  private:
+	void hookTransitionPlaybackEvents();
-    WSServer* _srv;
+	void unhookTransitionPlaybackEvents();
-    OBSSource currentScene;
-    OBSSource currentTransition;
 
-    bool pulse;
+	uint64_t getStreamingTime();
+	uint64_t getRecordingTime();
 
-    bool _streamingActive;
+	QString getStreamingTimecode();
-    bool _recordingActive;
+	QString getRecordingTimecode();
 	
-    uint64_t _streamStarttime;
+	obs_data_t* GetStats();
-    uint64_t _recStarttime;
 
-    uint64_t _lastBytesSent;
+	void OnBroadcastCustomMessage(QString realm, obs_data_t* data);
-    uint64_t _lastBytesSentTime;
 
-    void broadcastUpdate(const char* updateType,
+	bool HeartbeatIsActive;
-        obs_data_t* additionalFields);
 
-    void OnSceneChange();
+private slots:
-    void OnSceneListChange();
+	void StreamStatus();
-    void OnSceneCollectionChange();
+	void Heartbeat();
-    void OnSceneCollectionListChange();
+	void TransitionDurationChanged(int ms);
 
-    void OnTransitionChange();
+private:
-    void OnTransitionListChange();
+	WSServerPtr _srv;
+	QTimer streamStatusTimer;
+	QTimer heartbeatTimer;
+	os_cpu_usage_info_t* cpuUsageInfo;
 
-    void OnProfileChange();
+	bool pulse;
-    void OnProfileListChange();
 
-    void OnStreamStarting();
+	uint64_t _streamStarttime;
-    void OnStreamStarted();
-    void OnStreamStopping();
-    void OnStreamStopped();
 
-    void OnRecordingStarting();
+	uint64_t _lastBytesSent;
-    void OnRecordingStarted();
+	uint64_t _lastBytesSentTime;
-    void OnRecordingStopping();
-    void OnRecordingStopped();
 
-    void OnReplayStarting();
+	void broadcastUpdate(const char* updateType,
-    void OnReplayStarted();
+		obs_data_t* additionalFields);
-    void OnReplayStopping();
-    void OnReplayStopped();
 
-    void OnStudioModeSwitched(bool enabled);
+	void OnSceneChange();
+	void OnSceneListChange();
+	void OnSceneCollectionChange();
+	void OnSceneCollectionListChange();
 
-    void OnExit();
+	void OnTransitionChange();
+	void OnTransitionListChange();
 
-    static void OnTransitionBegin(void* param, calldata_t* data);
+	void OnProfileChange();
+	void OnProfileListChange();
 
-    static void OnSceneReordered(void* param, calldata_t* data);
+	void OnStreamStarting();
-    static void OnSceneItemAdd(void* param, calldata_t* data);
+	void OnStreamStarted();
-    static void OnSceneItemDelete(void* param, calldata_t* data);
+	void OnStreamStopping();
-    static void OnSceneItemVisibilityChanged(void* param, calldata_t* data);
+	void OnStreamStopped();
+
+	void OnRecordingStarting();
+	void OnRecordingStarted();
+	void OnRecordingStopping();
+	void OnRecordingStopped();
+	void OnRecordingPaused();
+	void OnRecordingResumed();
+
+	void OnReplayStarting();
+	void OnReplayStarted();
+	void OnReplayStopping();
+	void OnReplayStopped();
+
+	void OnStudioModeSwitched(bool enabled);
+	void OnPreviewSceneChanged();
+
+	void OnExit();
+
+	static void FrontendEventHandler(
+		enum obs_frontend_event event, void* privateData);
+
+	static void OnTransitionBegin(void* param, calldata_t* data);
+	static void OnTransitionEnd(void* param, calldata_t* data);
+	static void OnTransitionVideoEnd(void* param, calldata_t* data);
+
+	static void OnSourceCreate(void* param, calldata_t* data);
+	static void OnSourceDestroy(void* param, calldata_t* data);
+
+	static void OnSourceVolumeChange(void* param, calldata_t* data);
+	static void OnSourceMuteStateChange(void* param, calldata_t* data);
+	static void OnSourceAudioSyncOffsetChanged(void* param, calldata_t* data);
+	static void OnSourceAudioMixersChanged(void* param, calldata_t* data);
+
+	static void OnSourceRename(void* param, calldata_t* data);
+
+	static void OnSourceFilterAdded(void* param, calldata_t* data);
+	static void OnSourceFilterRemoved(void* param, calldata_t* data);
+	static void OnSourceFilterVisibilityChanged(void* param, calldata_t* data);
+	static void OnSourceFilterOrderChanged(void* param, calldata_t* data);
+
+	static void OnSceneReordered(void* param, calldata_t* data);
+	static void OnSceneItemAdd(void* param, calldata_t* data);
+	static void OnSceneItemDelete(void* param, calldata_t* data);
+	static void OnSceneItemVisibilityChanged(void* param, calldata_t* data);
+	static void OnSceneItemLockChanged(void* param, calldata_t* data);
+	static void OnSceneItemTransform(void* param, calldata_t* data);
+	static void OnSceneItemSelected(void* param, calldata_t* data);
+	static void OnSceneItemDeselected(void* param, calldata_t* data);
 };
-
-#endif // WSEVENTS_H

src/WSRequestHandler.cpp

@@ -17,6 +17,8 @@
  * with this program. If not, see <https://www.gnu.org/licenses/>
  */
 
+#include <functional>
+
 #include <obs-data.h>
 
 #include "Config.h"
@@ -24,194 +26,156 @@
 
 #include "WSRequestHandler.h"
 
-QHash<QString, void(*)(WSRequestHandler*)> WSRequestHandler::messageMap {
+using namespace std::placeholders;
-    { "GetVersion", WSRequestHandler::HandleGetVersion },
-    { "GetAuthRequired", WSRequestHandler::HandleGetAuthRequired },
-    { "Authenticate", WSRequestHandler::HandleAuthenticate },
 
-    { "SetHeartbeat", WSRequestHandler::HandleSetHeartbeat },
+const QHash<QString, RpcMethodHandler> WSRequestHandler::messageMap {
+	{ "GetVersion", &WSRequestHandler::GetVersion },
+	{ "GetAuthRequired", &WSRequestHandler::GetAuthRequired },
+	{ "Authenticate", &WSRequestHandler::Authenticate },
 
-    { "SetFilenameFormatting", WSRequestHandler::HandleSetFilenameFormatting },
+	{ "GetStats", &WSRequestHandler::GetStats },
-    { "GetFilenameFormatting", WSRequestHandler::HandleGetFilenameFormatting },
+	{ "SetHeartbeat", &WSRequestHandler::SetHeartbeat },
+	{ "GetVideoInfo", &WSRequestHandler::GetVideoInfo },
+	{ "OpenProjector", &WSRequestHandler::OpenProjector },
 
-    { "SetCurrentScene", WSRequestHandler::HandleSetCurrentScene },
+	{ "SetFilenameFormatting", &WSRequestHandler::SetFilenameFormatting },
-    { "GetCurrentScene", WSRequestHandler::HandleGetCurrentScene },
+	{ "GetFilenameFormatting", &WSRequestHandler::GetFilenameFormatting },
-    { "GetSceneList", WSRequestHandler::HandleGetSceneList },
 
-    { "SetSourceRender", WSRequestHandler::HandleSetSceneItemRender }, // Retrocompat
+	{ "BroadcastCustomMessage", &WSRequestHandler::BroadcastCustomMessage },
-    { "SetSceneItemRender", WSRequestHandler::HandleSetSceneItemRender },
-    { "SetSceneItemPosition", WSRequestHandler::HandleSetSceneItemPosition },
-    { "SetSceneItemTransform", WSRequestHandler::HandleSetSceneItemTransform },
-    { "SetSceneItemCrop", WSRequestHandler::HandleSetSceneItemCrop },
-    { "GetSceneItemProperties", WSRequestHandler::HandleGetSceneItemProperties },
-    { "SetSceneItemProperties", WSRequestHandler::HandleSetSceneItemProperties },
-    { "ResetSceneItem", WSRequestHandler::HandleResetSceneItem },
 
-    { "GetStreamingStatus", WSRequestHandler::HandleGetStreamingStatus },
+	{ "SetCurrentScene", &WSRequestHandler::SetCurrentScene },
-    { "StartStopStreaming", WSRequestHandler::HandleStartStopStreaming },
+	{ "GetCurrentScene", &WSRequestHandler::GetCurrentScene },
-    { "StartStopRecording", WSRequestHandler::HandleStartStopRecording },
+	{ "GetSceneList", &WSRequestHandler::GetSceneList },
-    { "StartStreaming", WSRequestHandler::HandleStartStreaming },
+	{ "SetSceneTransitionOverride", &WSRequestHandler::SetSceneTransitionOverride },
-    { "StopStreaming", WSRequestHandler::HandleStopStreaming },
+	{ "RemoveSceneTransitionOverride", &WSRequestHandler::RemoveSceneTransitionOverride },
-    { "StartRecording", WSRequestHandler::HandleStartRecording },
+	{ "GetSceneTransitionOverride", &WSRequestHandler::GetSceneTransitionOverride },
-    { "StopRecording", WSRequestHandler::HandleStopRecording },
 
-    { "StartStopReplayBuffer", WSRequestHandler::HandleStartStopReplayBuffer },
+	{ "SetSourceRender", &WSRequestHandler::SetSceneItemRender }, // Retrocompat
-    { "StartReplayBuffer", WSRequestHandler::HandleStartReplayBuffer },
+	{ "SetSceneItemRender", &WSRequestHandler::SetSceneItemRender },
-    { "StopReplayBuffer", WSRequestHandler::HandleStopReplayBuffer },
+	{ "SetSceneItemPosition", &WSRequestHandler::SetSceneItemPosition },
-    { "SaveReplayBuffer", WSRequestHandler::HandleSaveReplayBuffer },
+	{ "SetSceneItemTransform", &WSRequestHandler::SetSceneItemTransform },
+	{ "SetSceneItemCrop", &WSRequestHandler::SetSceneItemCrop },
+	{ "GetSceneItemProperties", &WSRequestHandler::GetSceneItemProperties },
+	{ "SetSceneItemProperties", &WSRequestHandler::SetSceneItemProperties },
+	{ "ResetSceneItem", &WSRequestHandler::ResetSceneItem },
+	{ "DeleteSceneItem", &WSRequestHandler::DeleteSceneItem },
+	{ "DuplicateSceneItem", &WSRequestHandler::DuplicateSceneItem },
+	{ "ReorderSceneItems", &WSRequestHandler::ReorderSceneItems },
 
-    { "SetRecordingFolder", WSRequestHandler::HandleSetRecordingFolder },
+	{ "GetStreamingStatus", &WSRequestHandler::GetStreamingStatus },
-    { "GetRecordingFolder", WSRequestHandler::HandleGetRecordingFolder },
+	{ "StartStopStreaming", &WSRequestHandler::StartStopStreaming },
+	{ "StartStopRecording", &WSRequestHandler::StartStopRecording },
 
-    { "GetTransitionList", WSRequestHandler::HandleGetTransitionList },
+	{ "StartStreaming", &WSRequestHandler::StartStreaming },
-    { "GetCurrentTransition", WSRequestHandler::HandleGetCurrentTransition },
+	{ "StopStreaming", &WSRequestHandler::StopStreaming },
-    { "SetCurrentTransition", WSRequestHandler::HandleSetCurrentTransition },
-    { "SetTransitionDuration", WSRequestHandler::HandleSetTransitionDuration },
-    { "GetTransitionDuration", WSRequestHandler::HandleGetTransitionDuration },
 
-    { "SetVolume", WSRequestHandler::HandleSetVolume },
+	{ "StartRecording", &WSRequestHandler::StartRecording },
-    { "GetVolume", WSRequestHandler::HandleGetVolume },
+	{ "StopRecording", &WSRequestHandler::StopRecording },
-    { "ToggleMute", WSRequestHandler::HandleToggleMute },
+	{ "PauseRecording", &WSRequestHandler::PauseRecording },
-    { "SetMute", WSRequestHandler::HandleSetMute },
+	{ "ResumeRecording", &WSRequestHandler::ResumeRecording },
-    { "GetMute", WSRequestHandler::HandleGetMute },
-    { "SetSyncOffset", WSRequestHandler::HandleSetSyncOffset },
-    { "GetSyncOffset", WSRequestHandler::HandleGetSyncOffset },
-    { "GetSpecialSources", WSRequestHandler::HandleGetSpecialSources },
-    { "GetSourcesList", WSRequestHandler::HandleGetSourcesList },
-    { "GetSourceTypesList", WSRequestHandler::HandleGetSourceTypesList },
-    { "GetSourceSettings", WSRequestHandler::HandleGetSourceSettings },
-    { "SetSourceSettings", WSRequestHandler::HandleSetSourceSettings },
 
-    { "SetCurrentSceneCollection", WSRequestHandler::HandleSetCurrentSceneCollection },
+	{ "StartStopReplayBuffer", &WSRequestHandler::StartStopReplayBuffer },
-    { "GetCurrentSceneCollection", WSRequestHandler::HandleGetCurrentSceneCollection },
+	{ "StartReplayBuffer", &WSRequestHandler::StartReplayBuffer },
-    { "ListSceneCollections", WSRequestHandler::HandleListSceneCollections },
+	{ "StopReplayBuffer", &WSRequestHandler::StopReplayBuffer },
+	{ "SaveReplayBuffer", &WSRequestHandler::SaveReplayBuffer },
 
-    { "SetCurrentProfile", WSRequestHandler::HandleSetCurrentProfile },
+	{ "SetRecordingFolder", &WSRequestHandler::SetRecordingFolder },
-    { "GetCurrentProfile", WSRequestHandler::HandleGetCurrentProfile },
+	{ "GetRecordingFolder", &WSRequestHandler::GetRecordingFolder },
-    { "ListProfiles", WSRequestHandler::HandleListProfiles },
 
-    { "SetStreamSettings", WSRequestHandler::HandleSetStreamSettings },
+	{ "GetTransitionList", &WSRequestHandler::GetTransitionList },
-    { "GetStreamSettings", WSRequestHandler::HandleGetStreamSettings },
+	{ "GetCurrentTransition", &WSRequestHandler::GetCurrentTransition },
-    { "SaveStreamSettings", WSRequestHandler::HandleSaveStreamSettings },
+	{ "SetCurrentTransition", &WSRequestHandler::SetCurrentTransition },
+	{ "SetTransitionDuration", &WSRequestHandler::SetTransitionDuration },
+	{ "GetTransitionDuration", &WSRequestHandler::GetTransitionDuration },
+	{ "GetTransitionPosition", &WSRequestHandler::GetTransitionPosition },
 
-    { "GetStudioModeStatus", WSRequestHandler::HandleGetStudioModeStatus },
+	{ "SetVolume", &WSRequestHandler::SetVolume },
-    { "GetPreviewScene", WSRequestHandler::HandleGetPreviewScene },
+	{ "GetVolume", &WSRequestHandler::GetVolume },
-    { "SetPreviewScene", WSRequestHandler::HandleSetPreviewScene },
+	{ "ToggleMute", &WSRequestHandler::ToggleMute },
-    { "TransitionToProgram", WSRequestHandler::HandleTransitionToProgram },
+	{ "SetMute", &WSRequestHandler::SetMute },
-    { "EnableStudioMode", WSRequestHandler::HandleEnableStudioMode },
+	{ "GetMute", &WSRequestHandler::GetMute },
-    { "DisableStudioMode", WSRequestHandler::HandleDisableStudioMode },
+	{ "SetSourceName", &WSRequestHandler::SetSourceName },
-    { "ToggleStudioMode", WSRequestHandler::HandleToggleStudioMode },
+	{ "SetSyncOffset", &WSRequestHandler::SetSyncOffset },
+	{ "GetSyncOffset", &WSRequestHandler::GetSyncOffset },
+	{ "GetSpecialSources", &WSRequestHandler::GetSpecialSources },
+	{ "GetSourcesList", &WSRequestHandler::GetSourcesList },
+	{ "GetSourceTypesList", &WSRequestHandler::GetSourceTypesList },
+	{ "GetSourceSettings", &WSRequestHandler::GetSourceSettings },
+	{ "SetSourceSettings", &WSRequestHandler::SetSourceSettings },
+	{ "GetAudioMonitorType", &WSRequestHandler::GetAudioMonitorType },
+	{ "SetAudioMonitorType", &WSRequestHandler::SetAudioMonitorType },
+	{ "TakeSourceScreenshot", &WSRequestHandler::TakeSourceScreenshot },
 
-    { "SetTextGDIPlusProperties", WSRequestHandler::HandleSetTextGDIPlusProperties },
+	{ "GetSourceFilters", &WSRequestHandler::GetSourceFilters },
-    { "GetTextGDIPlusProperties", WSRequestHandler::HandleGetTextGDIPlusProperties },
+	{ "GetSourceFilterInfo", &WSRequestHandler::GetSourceFilterInfo },
+	{ "AddFilterToSource", &WSRequestHandler::AddFilterToSource },
+	{ "RemoveFilterFromSource", &WSRequestHandler::RemoveFilterFromSource },
+	{ "ReorderSourceFilter", &WSRequestHandler::ReorderSourceFilter },
+	{ "MoveSourceFilter", &WSRequestHandler::MoveSourceFilter },
+	{ "SetSourceFilterSettings", &WSRequestHandler::SetSourceFilterSettings },
+	{ "SetSourceFilterVisibility", &WSRequestHandler::SetSourceFilterVisibility },
 
-    { "GetBrowserSourceProperties", WSRequestHandler::HandleGetBrowserSourceProperties },
+	{ "SetCurrentSceneCollection", &WSRequestHandler::SetCurrentSceneCollection },
-    { "SetBrowserSourceProperties", WSRequestHandler::HandleSetBrowserSourceProperties }
+	{ "GetCurrentSceneCollection", &WSRequestHandler::GetCurrentSceneCollection },
+	{ "ListSceneCollections", &WSRequestHandler::ListSceneCollections },
+
+	{ "SetCurrentProfile", &WSRequestHandler::SetCurrentProfile },
+	{ "GetCurrentProfile", &WSRequestHandler::GetCurrentProfile },
+	{ "ListProfiles", &WSRequestHandler::ListProfiles },
+
+	{ "SetStreamSettings", &WSRequestHandler::SetStreamSettings },
+	{ "GetStreamSettings", &WSRequestHandler::GetStreamSettings },
+	{ "SaveStreamSettings", &WSRequestHandler::SaveStreamSettings },
+#if BUILD_CAPTIONS
+	{ "SendCaptions", &WSRequestHandler::SendCaptions },
+#endif
+
+	{ "GetStudioModeStatus", &WSRequestHandler::GetStudioModeStatus },
+	{ "GetPreviewScene", &WSRequestHandler::GetPreviewScene },
+	{ "SetPreviewScene", &WSRequestHandler::SetPreviewScene },
+	{ "TransitionToProgram", &WSRequestHandler::TransitionToProgram },
+	{ "EnableStudioMode", &WSRequestHandler::EnableStudioMode },
+	{ "DisableStudioMode", &WSRequestHandler::DisableStudioMode },
+	{ "ToggleStudioMode", &WSRequestHandler::ToggleStudioMode },
+
+	{ "SetTextGDIPlusProperties", &WSRequestHandler::SetTextGDIPlusProperties },
+	{ "GetTextGDIPlusProperties", &WSRequestHandler::GetTextGDIPlusProperties },
+
+	{ "SetTextFreetype2Properties", &WSRequestHandler::SetTextFreetype2Properties },
+	{ "GetTextFreetype2Properties", &WSRequestHandler::GetTextFreetype2Properties },
+
+	{ "GetBrowserSourceProperties", &WSRequestHandler::GetBrowserSourceProperties },
+	{ "SetBrowserSourceProperties", &WSRequestHandler::SetBrowserSourceProperties },
+
+	{ "ListOutputs", &WSRequestHandler::ListOutputs },
+	{ "GetOutputInfo", &WSRequestHandler::GetOutputInfo },
+	{ "StartOutput", &WSRequestHandler::StartOutput },
+	{ "StopOutput", &WSRequestHandler::StopOutput }
 };
 
-QSet<QString> WSRequestHandler::authNotRequired {
+const QSet<QString> WSRequestHandler::authNotRequired {
-    "GetVersion",
+	"GetVersion",
-    "GetAuthRequired",
+	"GetAuthRequired",
-    "Authenticate"
+	"Authenticate"
 };
 
-WSRequestHandler::WSRequestHandler(QWebSocket* client) :
+WSRequestHandler::WSRequestHandler(ConnectionProperties& connProperties) :
-    _messageId(0),
+	_connProperties(connProperties)
-    _requestType(""),
-    data(nullptr),
-    _client(client)
 {
 }
 
-void WSRequestHandler::processIncomingMessage(QString textMessage) {
+RpcResponse WSRequestHandler::processRequest(const RpcRequest& request){
-    QByteArray msgData = textMessage.toUtf8();
+	if (GetConfig()->AuthRequired
-    const char* msg = msgData.constData();
+		&& (!authNotRequired.contains(request.methodName()))
+		&& (!_connProperties.isAuthenticated()))
+	{
+		return RpcResponse::fail(request, "Not Authenticated");
+	}
 
-    data = obs_data_create_from_json(msg);
+	RpcMethodHandler handlerFunc = messageMap[request.methodName()];
-    if (!data) {
+	if (!handlerFunc) {
-        if (!msg)
+		return RpcResponse::fail(request, "invalid request type");
-            msg = "<null pointer>";
+	}
 
-        blog(LOG_ERROR, "invalid JSON payload received for '%s'", msg);
+	return std::bind(handlerFunc, this, _1)(request);
-        SendErrorResponse("invalid JSON payload");
-        return;
-    }
-
-    if (Config::Current()->DebugEnabled) {
-        blog(LOG_DEBUG, "Request >> '%s'", msg);
-    }
-
-    if (!hasField("request-type")
-        || !hasField("message-id"))
-    {
-        SendErrorResponse("missing request parameters");
-        return;
-    }
-
-    _requestType = obs_data_get_string(data, "request-type");
-    _messageId = obs_data_get_string(data, "message-id");
-
-    if (Config::Current()->AuthRequired
-        && (_client->property(PROP_AUTHENTICATED).toBool() == false)
-        && (authNotRequired.find(_requestType) == authNotRequired.end()))
-    {
-        SendErrorResponse("Not Authenticated");
-        return;
-    }
-
-    void (*handlerFunc)(WSRequestHandler*) = (messageMap[_requestType]);
-
-    if (handlerFunc != nullptr)
-        handlerFunc(this);
-    else
-        SendErrorResponse("invalid request type");
-}
-
-WSRequestHandler::~WSRequestHandler() {
-}
-
-void WSRequestHandler::SendOKResponse(obs_data_t* additionalFields) {
-    OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "status", "ok");
-    obs_data_set_string(response, "message-id", _messageId);
-
-    if (additionalFields)
-        obs_data_apply(response, additionalFields);
-
-    SendResponse(response);
-}
-
-void WSRequestHandler::SendErrorResponse(const char* errorMessage) {
-    OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "status", "error");
-    obs_data_set_string(response, "error", errorMessage);
-    obs_data_set_string(response, "message-id", _messageId);
-
-    SendResponse(response);
-}
-
-void WSRequestHandler::SendErrorResponse(obs_data_t* additionalFields) {
-    OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "status", "error");
-    obs_data_set_string(response, "message-id", _messageId);
-
-    if (additionalFields)
-        obs_data_set_obj(response, "error", additionalFields);
-
-    SendResponse(response);
-}
-
-void WSRequestHandler::SendResponse(obs_data_t* response)  {
-    QString json = obs_data_get_json(response);
-    _client->sendTextMessage(json);
-
-    if (Config::Current()->DebugEnabled)
-        blog(LOG_DEBUG, "Response << '%s'", json.toUtf8().constData());
-}
-
-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

@@ -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>
 Copyright (C) 2017	Mikhail Swift <https://github.com/mikhailswift>
 
 This program is free software; you can redistribute it and/or modify
@@ -17,123 +17,155 @@ 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
+#pragma once
-#define WSREQUESTHANDLER_H
 
-#include <QHash>
+#include <QtCore/QString>
-#include <QSet>
+#include <QtCore/QHash>
-#include <QWebSocket>
+#include <QtCore/QSet>
-#include <QWebSocketServer>
 
 #include <obs.hpp>
 #include <obs-frontend-api.h>
 
+#include "ConnectionProperties.h"
+
+#include "rpc/RpcRequest.h"
+#include "rpc/RpcResponse.h"
+
 #include "obs-websocket.h"
 
-class WSRequestHandler : public QObject {
+class WSRequestHandler;
-  Q_OBJECT
+typedef RpcResponse(WSRequestHandler::*RpcMethodHandler)(const RpcRequest&);
 
-  public:
+class WSRequestHandler {
-    explicit WSRequestHandler(QWebSocket* client);
+	public:
-    ~WSRequestHandler();
+		explicit WSRequestHandler(ConnectionProperties& connProperties);
-    void processIncomingMessage(QString textMessage);
+		RpcResponse processRequest(const RpcRequest& textMessage);
-    bool hasField(QString name);
 
-  private:
+	private:
-    QWebSocket* _client;
+		ConnectionProperties& _connProperties;
-    const char* _messageId;
-    const char* _requestType;
-    OBSDataAutoRelease data;
 
-    void SendOKResponse(obs_data_t* additionalFields = NULL);
+		static const QHash<QString, RpcMethodHandler> messageMap;
-    void SendErrorResponse(const char* errorMessage);
+		static const QSet<QString> authNotRequired;
-    void SendErrorResponse(obs_data_t* additionalFields = NULL);
-    void SendResponse(obs_data_t* response);
 
-    static QHash<QString, void(*)(WSRequestHandler*)> messageMap;
+		RpcResponse GetVersion(const RpcRequest&);
-    static QSet<QString> authNotRequired;
+		RpcResponse GetAuthRequired(const RpcRequest&);
+		RpcResponse Authenticate(const RpcRequest&);
 
-    static void HandleGetVersion(WSRequestHandler* req);
+		RpcResponse GetStats(const RpcRequest&);
-    static void HandleGetAuthRequired(WSRequestHandler* req);
+		RpcResponse SetHeartbeat(const RpcRequest&);
-    static void HandleAuthenticate(WSRequestHandler* req);
+		RpcResponse GetVideoInfo(const RpcRequest&);
+		RpcResponse OpenProjector(const RpcRequest&);
 
-    static void HandleSetHeartbeat(WSRequestHandler* req);
+		RpcResponse SetFilenameFormatting(const RpcRequest&);
+		RpcResponse GetFilenameFormatting(const RpcRequest&);
 
-    static void HandleSetFilenameFormatting(WSRequestHandler* req);
+		RpcResponse BroadcastCustomMessage(const RpcRequest&);
-    static void HandleGetFilenameFormatting(WSRequestHandler* req);
 
-    static void HandleSetCurrentScene(WSRequestHandler* req);
+		RpcResponse SetCurrentScene(const RpcRequest&);
-    static void HandleGetCurrentScene(WSRequestHandler* req);
+		RpcResponse GetCurrentScene(const RpcRequest&);
-    static void HandleGetSceneList(WSRequestHandler* req);
+		RpcResponse GetSceneList(const RpcRequest&);
+		RpcResponse SetSceneTransitionOverride(const RpcRequest&);
+		RpcResponse RemoveSceneTransitionOverride(const RpcRequest&);
+		RpcResponse GetSceneTransitionOverride(const RpcRequest&);
 
-    static void HandleSetSceneItemRender(WSRequestHandler* req);
+		RpcResponse SetSceneItemRender(const RpcRequest&);
-    static void HandleSetSceneItemPosition(WSRequestHandler* req);
+		RpcResponse SetSceneItemPosition(const RpcRequest&);
-    static void HandleSetSceneItemTransform(WSRequestHandler* req);
+		RpcResponse SetSceneItemTransform(const RpcRequest&);
-    static void HandleSetSceneItemCrop(WSRequestHandler* req);
+		RpcResponse SetSceneItemCrop(const RpcRequest&);
-    static void HandleGetSceneItemProperties(WSRequestHandler* req);
+		RpcResponse GetSceneItemProperties(const RpcRequest&);
-    static void HandleSetSceneItemProperties(WSRequestHandler* req);
+		RpcResponse SetSceneItemProperties(const RpcRequest&);
-    static void HandleResetSceneItem(WSRequestHandler* req);
+		RpcResponse ResetSceneItem(const RpcRequest&);
+		RpcResponse DuplicateSceneItem(const RpcRequest&);
+		RpcResponse DeleteSceneItem(const RpcRequest&);
+		RpcResponse ReorderSceneItems(const RpcRequest&);
 
-    static void HandleGetStreamingStatus(WSRequestHandler* req);
+		RpcResponse GetStreamingStatus(const RpcRequest&);
-    static void HandleStartStopStreaming(WSRequestHandler* req);
+		RpcResponse StartStopStreaming(const RpcRequest&);
-    static void HandleStartStopRecording(WSRequestHandler* req);
+		RpcResponse StartStopRecording(const RpcRequest&);
-    static void HandleStartStreaming(WSRequestHandler* req);
-    static void HandleStopStreaming(WSRequestHandler* req);
-    static void HandleStartRecording(WSRequestHandler* req);
-    static void HandleStopRecording(WSRequestHandler* req);
 
-    static void HandleStartStopReplayBuffer(WSRequestHandler* req);
+		RpcResponse StartStreaming(const RpcRequest&);
-    static void HandleStartReplayBuffer(WSRequestHandler* req);
+		RpcResponse StopStreaming(const RpcRequest&);
-    static void HandleStopReplayBuffer(WSRequestHandler* req);
-    static void HandleSaveReplayBuffer(WSRequestHandler* req);
 
-    static void HandleSetRecordingFolder(WSRequestHandler* req);
+		RpcResponse StartRecording(const RpcRequest&);
-    static void HandleGetRecordingFolder(WSRequestHandler* req);
+		RpcResponse StopRecording(const RpcRequest&);
+		RpcResponse PauseRecording(const RpcRequest&);
+		RpcResponse ResumeRecording(const RpcRequest&);
 
-    static void HandleGetTransitionList(WSRequestHandler* req);
+		RpcResponse StartStopReplayBuffer(const RpcRequest&);
-    static void HandleGetCurrentTransition(WSRequestHandler* req);
+		RpcResponse StartReplayBuffer(const RpcRequest&);
-    static void HandleSetCurrentTransition(WSRequestHandler* req);
+		RpcResponse StopReplayBuffer(const RpcRequest&);
+		RpcResponse SaveReplayBuffer(const RpcRequest&);
 
-    static void HandleSetVolume(WSRequestHandler* req);
+		RpcResponse SetRecordingFolder(const RpcRequest&);
-    static void HandleGetVolume(WSRequestHandler* req);
+		RpcResponse GetRecordingFolder(const RpcRequest&);
-    static void HandleToggleMute(WSRequestHandler* req);
-    static void HandleSetMute(WSRequestHandler* req);
-    static void HandleGetMute(WSRequestHandler* req);
-    static void HandleSetSyncOffset(WSRequestHandler* req);
-    static void HandleGetSyncOffset(WSRequestHandler* req);
-    static void HandleGetSpecialSources(WSRequestHandler* req);
-    static void HandleGetSourcesList(WSRequestHandler* req);
-    static void HandleGetSourceTypesList(WSRequestHandler* req);
-    static void HandleGetSourceSettings(WSRequestHandler* req);
-    static void HandleSetSourceSettings(WSRequestHandler* req);
 
-    static void HandleSetCurrentSceneCollection(WSRequestHandler* req);
+		RpcResponse GetTransitionList(const RpcRequest&);
-    static void HandleGetCurrentSceneCollection(WSRequestHandler* req);
+		RpcResponse GetCurrentTransition(const RpcRequest&);
-    static void HandleListSceneCollections(WSRequestHandler* req);
+		RpcResponse SetCurrentTransition(const RpcRequest&);
+		RpcResponse SetTransitionDuration(const RpcRequest&);
+		RpcResponse GetTransitionDuration(const RpcRequest&);
+		RpcResponse GetTransitionPosition(const RpcRequest&);
 
-    static void HandleSetCurrentProfile(WSRequestHandler* req);
+		RpcResponse SetVolume(const RpcRequest&);
-    static void HandleGetCurrentProfile(WSRequestHandler* req);
+		RpcResponse GetVolume(const RpcRequest&);
-    static void HandleListProfiles(WSRequestHandler* req);
+		RpcResponse ToggleMute(const RpcRequest&);
+		RpcResponse SetMute(const RpcRequest&);
+		RpcResponse GetMute(const RpcRequest&);
+		RpcResponse SetSourceName(const RpcRequest&);
+		RpcResponse SetSyncOffset(const RpcRequest&);
+		RpcResponse GetSyncOffset(const RpcRequest&);
+		RpcResponse GetSpecialSources(const RpcRequest&);
+		RpcResponse GetSourcesList(const RpcRequest&);
+		RpcResponse GetSourceTypesList(const RpcRequest&);
+		RpcResponse GetSourceSettings(const RpcRequest&);
+		RpcResponse SetSourceSettings(const RpcRequest&);
+		RpcResponse GetAudioMonitorType(const RpcRequest&);
+		RpcResponse SetAudioMonitorType(const RpcRequest&);
+		RpcResponse TakeSourceScreenshot(const RpcRequest&);
 
-    static void HandleSetStreamSettings(WSRequestHandler* req);
+		RpcResponse GetSourceFilters(const RpcRequest&);
-    static void HandleGetStreamSettings(WSRequestHandler* req);
+		RpcResponse GetSourceFilterInfo(const RpcRequest&);
-    static void HandleSaveStreamSettings(WSRequestHandler* req);
+		RpcResponse AddFilterToSource(const RpcRequest&);
+		RpcResponse RemoveFilterFromSource(const RpcRequest&);
+		RpcResponse ReorderSourceFilter(const RpcRequest&);
+		RpcResponse MoveSourceFilter(const RpcRequest&);
+		RpcResponse SetSourceFilterSettings(const RpcRequest&);
+		RpcResponse SetSourceFilterVisibility(const RpcRequest&);
 
-    static void HandleSetTransitionDuration(WSRequestHandler* req);
+		RpcResponse SetCurrentSceneCollection(const RpcRequest&);
-    static void HandleGetTransitionDuration(WSRequestHandler* req);
+		RpcResponse GetCurrentSceneCollection(const RpcRequest&);
+		RpcResponse ListSceneCollections(const RpcRequest&);
 
-    static void HandleGetStudioModeStatus(WSRequestHandler* req);
+		RpcResponse SetCurrentProfile(const RpcRequest&);
-    static void HandleGetPreviewScene(WSRequestHandler* req);
+		RpcResponse GetCurrentProfile(const RpcRequest&);
-    static void HandleSetPreviewScene(WSRequestHandler* req);
+		RpcResponse ListProfiles(const RpcRequest&);
-    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);
+		RpcResponse SetStreamSettings(const RpcRequest&);
-    static void HandleGetTextGDIPlusProperties(WSRequestHandler* req);
+		RpcResponse GetStreamSettings(const RpcRequest&);
-    static void HandleSetBrowserSourceProperties(WSRequestHandler* req);
+		RpcResponse SaveStreamSettings(const RpcRequest&);
-    static void HandleGetBrowserSourceProperties(WSRequestHandler* req);
+#if BUILD_CAPTIONS
+		RpcResponse SendCaptions(const RpcRequest&);
+#endif
+
+		RpcResponse GetStudioModeStatus(const RpcRequest&);
+		RpcResponse GetPreviewScene(const RpcRequest&);
+		RpcResponse SetPreviewScene(const RpcRequest&);
+		RpcResponse TransitionToProgram(const RpcRequest&);
+		RpcResponse EnableStudioMode(const RpcRequest&);
+		RpcResponse DisableStudioMode(const RpcRequest&);
+		RpcResponse ToggleStudioMode(const RpcRequest&);
+
+		RpcResponse SetTextGDIPlusProperties(const RpcRequest&);
+		RpcResponse GetTextGDIPlusProperties(const RpcRequest&);
+
+		RpcResponse SetTextFreetype2Properties(const RpcRequest&);
+		RpcResponse GetTextFreetype2Properties(const RpcRequest&);
+
+		RpcResponse SetBrowserSourceProperties(const RpcRequest&);
+		RpcResponse GetBrowserSourceProperties(const RpcRequest&);
+
+		RpcResponse ListOutputs(const RpcRequest&);
+		RpcResponse GetOutputInfo(const RpcRequest&);
+		RpcResponse StartOutput(const RpcRequest&);
+		RpcResponse StopOutput(const RpcRequest&);
 };
-
-#endif // WSPROTOCOL_H

src/WSRequestHandler_General.cpp

@@ -1,10 +1,60 @@
-#include <QString>
+#include "WSRequestHandler.h"
 
+#include <QtCore/QByteArray>
+#include <QtGui/QImageWriter>
+
+#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.
@@ -13,31 +63,41 @@
  * @return {String} `obs-websocket-version` obs-websocket plugin version.
  * @return {String} `obs-studio-version` OBS Studio program version.
  * @return {String} `available-requests` List of available request types, formatted as a comma-separated list string (e.g. : "Method1,Method2,Method3").
+ * @return {String} `supported-image-export-formats` List of supported formats for features that use image export (like the TakeSourceScreenshot request type) formatted as a comma-separated list string
  *
  * @api requests
  * @name GetVersion
  * @category general
  * @since 0.3
  */
- void WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetVersion(const RpcRequest& request) {
-    QString obsVersion = Utils::OBSVersionString();
+	QString obsVersion = Utils::OBSVersionString();
 
-    QList<QString> names = req->messageMap.keys();
+	QList<QString> names = messageMap.keys();
-    names.sort(Qt::CaseInsensitive);
+	QList<QByteArray> imageWriterFormats = QImageWriter::supportedImageFormats();
 
-    // (Palakis) OBS' data arrays only support object arrays, so I improvised.
+	// (Palakis) OBS' data arrays only support object arrays, so I improvised.
-    QString requests;
+	QString requests;
-    requests += names.takeFirst();
+	names.sort(Qt::CaseInsensitive);
-    for (QString reqName : names) {
+	requests += names.takeFirst();
-        requests += ("," + reqName);
+	for (const QString& reqName : names) {
-    }
+		requests += ("," + reqName);
+	}
 
-    OBSDataAutoRelease data = obs_data_create();
+	QString supportedImageExportFormats;
-    obs_data_set_string(data, "obs-websocket-version", OBS_WEBSOCKET_VERSION);
+	supportedImageExportFormats += QString::fromUtf8(imageWriterFormats.takeFirst());
-    obs_data_set_string(data, "obs-studio-version", obsVersion.toUtf8());
+	for (const QByteArray& format : imageWriterFormats) {
-    obs_data_set_string(data, "available-requests", requests.toUtf8());
+		supportedImageExportFormats += ("," + QString::fromUtf8(format));
+	}
 
-    req->SendOKResponse(data);
+	OBSDataAutoRelease data = obs_data_create();
+	obs_data_set_double(data, "version", 1.1);
+	obs_data_set_string(data, "obs-websocket-version", OBS_WEBSOCKET_VERSION);
+	obs_data_set_string(data, "obs-studio-version", obsVersion.toUtf8());
+	obs_data_set_string(data, "available-requests", requests.toUtf8());
+	obs_data_set_string(data, "supported-image-export-formats", supportedImageExportFormats.toUtf8());
+
+	return request.success(data);
 }
 
 /**
@@ -53,20 +113,21 @@
  * @category general
  * @since 0.3
  */
-void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetAuthRequired(const RpcRequest& request) {
-    bool authRequired = Config::Current()->AuthRequired;
+	bool authRequired = GetConfig()->AuthRequired;
 
-    OBSDataAutoRelease data = obs_data_create();
+	OBSDataAutoRelease data = obs_data_create();
-    obs_data_set_bool(data, "authRequired", authRequired);
+	obs_data_set_bool(data, "authRequired", authRequired);
 
-    if (authRequired) {
+	if (authRequired) {
-        obs_data_set_string(data, "challenge",
+		auto config = GetConfig();
-            Config::Current()->SessionChallenge.toUtf8());
+		obs_data_set_string(data, "challenge",
-        obs_data_set_string(data, "salt",
+			config->SessionChallenge.toUtf8());
-            Config::Current()->Salt.toUtf8());
+		obs_data_set_string(data, "salt",
-    }
+			config->Salt.toUtf8());
+	}
 
-    req->SendOKResponse(data);
+	return request.success(data);
 }
 
 /**
@@ -79,26 +140,26 @@ void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
  * @category general
  * @since 0.3
  */
-void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::Authenticate(const RpcRequest& request) {
-    if (!req->hasField("auth")) {
+	if (!request.hasField("auth")) {
-        req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-        return;
+	}
-    }
 
-    QString auth = obs_data_get_string(req->data, "auth");
+	if (_connProperties.isAuthenticated()) {
-    if (auth.isEmpty()) {
+		return request.failed("already authenticated");
-        req->SendErrorResponse("auth not specified!");
+	}
-        return;
-    }
 
-    if ((req->_client->property(PROP_AUTHENTICATED).toBool() == false)
+	QString auth = obs_data_get_string(request.parameters(), "auth");
-        && Config::Current()->CheckAuth(auth))
+	if (auth.isEmpty()) {
-    {
+		return request.failed("auth not specified!");
-        req->_client->setProperty(PROP_AUTHENTICATED, true);
+	}
-        req->SendOKResponse();
+
-    } else {
+	if (GetConfig()->CheckAuth(auth) == false) {
-        req->SendErrorResponse("Authentication Failed.");
+		return request.failed("Authentication Failed.");
-    }
+	}
+
+	_connProperties.setAuthenticated(true);
+	return request.success();
 }
 
 /**
@@ -111,19 +172,18 @@ void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
- void WSRequestHandler::HandleSetHeartbeat(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetHeartbeat(const RpcRequest& request) {
-    if (!req->hasField("enable")) {
+	if (!request.hasField("enable")) {
-        req->SendErrorResponse("Heartbeat <enable> parameter missing");
+		return request.failed("Heartbeat <enable> parameter missing");
-        return;
+	}
-    }
 
-    WSEvents::Instance->HeartbeatIsActive =
+	auto events = GetEventsSystem();
-        obs_data_get_bool(req->data, "enable");
+	events->HeartbeatIsActive = obs_data_get_bool(request.parameters(), "enable");
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_bool(response, "enable",
+	obs_data_set_bool(response, "enable", events->HeartbeatIsActive);
-        WSEvents::Instance->HeartbeatIsActive);
+
-    req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -136,19 +196,19 @@ void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
-void WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetFilenameFormatting(const RpcRequest& request) {
-    if (!req->hasField("filename-formatting")) {
+	if (!request.hasField("filename-formatting")) {
-        req->SendErrorResponse("<filename-formatting> parameter missing");
+		return request.failed("<filename-formatting> parameter missing");
-        return;
+	}
-    }
 
-    QString filenameFormatting = obs_data_get_string(req->data, "filename-formatting");
+	QString filenameFormatting = obs_data_get_string(request.parameters(), "filename-formatting");
-    if (!filenameFormatting.isEmpty()) {
+	if (filenameFormatting.isEmpty()) {
-        Utils::SetFilenameFormatting(filenameFormatting.toUtf8());
+		return request.failed("invalid request parameters");
-        req->SendOKResponse();
+	}
-    } else {
+
-        req->SendErrorResponse("invalid request parameters");
+	Utils::SetFilenameFormatting(filenameFormatting.toUtf8());
-    }
+
+	return request.success();
 }
 
 /**
@@ -161,8 +221,126 @@ void WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
-void WSRequestHandler::HandleGetFilenameFormatting(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetFilenameFormatting(const RpcRequest& request) {
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "filename-formatting", Utils::GetFilenameFormatting());
+	obs_data_set_string(response, "filename-formatting", Utils::GetFilenameFormatting());
-    req->SendOKResponse(response);
+
+	return request.success(response);
+}
+
+/**
+ * Get OBS stats (almost the same info as provided in OBS' stats window)
+ *
+ * @return {OBSStats} `stats` OBS stats
+ *
+ * @api requests
+ * @name GetStats
+ * @category general
+ * @since 4.6.0
+ */
+RpcResponse WSRequestHandler::GetStats(const RpcRequest& request) {
+	OBSDataAutoRelease stats = GetEventsSystem()->GetStats();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_obj(response, "stats", stats);
+
+	return request.success(response);
+}
+
+/**
+ * Broadcast custom message to all connected WebSocket clients
+ *
+ * @param {String} `realm` Identifier to be choosen by the client
+ * @param {Object} `data` User-defined data
+ *
+ * @api requests
+ * @name BroadcastCustomMessage
+ * @category general
+ * @since 4.7.0
+ */
+RpcResponse WSRequestHandler::BroadcastCustomMessage(const RpcRequest& request) {
+	if (!request.hasField("realm") || !request.hasField("data")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString realm = obs_data_get_string(request.parameters(), "realm");
+	OBSDataAutoRelease data = obs_data_get_obj(request.parameters(), "data");
+
+	if (realm.isEmpty()) {
+		return request.failed("realm not specified!");
+	}
+
+	if (!data) {
+		return request.failed("data not specified!");
+	}
+
+	auto events = GetEventsSystem();
+	events->OnBroadcastCustomMessage(realm, data);
+
+	return request.success();
+}
+
+
+/**
+ * Get basic OBS video information
+ * 
+ * @return {int} `baseWidth` Base (canvas) width
+ * @return {int} `baseHeight` Base (canvas) height
+ * @return {int} `outputWidth` Output width
+ * @return {int} `outputHeight` Output height
+ * @return {String} `scaleType` Scaling method used if output size differs from base size
+ * @return {double} `fps` Frames rendered per second
+ * @return {String} `videoFormat` Video color format
+ * @return {String} `colorSpace` Color space for YUV
+ * @return {String} `colorRange` Color range (full or partial)
+ * 
+ * @api requests
+ * @name GetVideoInfo
+ * @category general
+ * @since 4.6.0 
+ */
+RpcResponse WSRequestHandler::GetVideoInfo(const RpcRequest& request) {
+	obs_video_info ovi;
+	obs_get_video_info(&ovi);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_int(response, "baseWidth", ovi.base_width);
+	obs_data_set_int(response, "baseHeight", ovi.base_height);
+	obs_data_set_int(response, "outputWidth", ovi.output_width);
+	obs_data_set_int(response, "outputHeight", ovi.output_height);
+	obs_data_set_double(response, "fps", (double)ovi.fps_num / ovi.fps_den);
+	obs_data_set_string(response, "videoFormat", describe_output_format(ovi.output_format));
+	obs_data_set_string(response, "colorSpace", describe_color_space(ovi.colorspace));
+	obs_data_set_string(response, "colorRange", describe_color_range(ovi.range));
+	obs_data_set_string(response, "scaleType", describe_scale_type(ovi.scale_type));
+
+	return request.success(response);
+}
+
+/**
+ * Open a projector window or create a projector on a monitor. Requires OBS v24.0.4 or newer.
+ * 
+ * @param {String (Optional)} `type` Type of projector: Preview (default), Source, Scene, StudioProgram, or Multiview (case insensitive).
+ * @param {int (Optional)} `monitor` Monitor to open the projector on. If -1 or omitted, opens a window.
+ * @param {String (Optional)} `geometry` Size and position of the projector window (only if monitor is -1). Encoded in Base64 using Qt's geometry encoding (https://doc.qt.io/qt-5/qwidget.html#saveGeometry). Corresponds to OBS's saved projectors.
+ * @param {String (Optional)} `name` Name of the source or scene to be displayed (ignored for other projector types).
+ * 
+ * @api requests
+ * @name OpenProjector
+ * @category general
+ * @since 4.8.0
+ */
+RpcResponse WSRequestHandler::OpenProjector(const RpcRequest& request) {
+	const char* type = obs_data_get_string(request.parameters(), "type");
+
+	int monitor = -1;
+	if (request.hasField("monitor")) {
+		monitor = obs_data_get_int(request.parameters(), "monitor");
+	}
+
+	const char* geometry = obs_data_get_string(request.parameters(), "geometry");
+	const char* name = obs_data_get_string(request.parameters(), "name");
+
+	obs_frontend_open_projector(type, monitor, geometry, name);
+	return request.success();
 }

src/WSRequestHandler_Outputs.cpp

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

src/WSRequestHandler_Profiles.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -13,20 +12,19 @@
  * @category profiles
  * @since 4.0.0
  */
- void WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetCurrentProfile(const RpcRequest& request) {
-    if (!req->hasField("profile-name")) {
+	if (!request.hasField("profile-name")) {
-        req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-        return;
+	}
-    }
 
-    QString profileName = obs_data_get_string(req->data, "profile-name");
+	QString profileName = obs_data_get_string(request.parameters(), "profile-name");
-    if (!profileName.isEmpty()) {
+	if (profileName.isEmpty()) {
-        // TODO : check if profile exists
+		return request.failed("invalid request parameters");
-        obs_frontend_set_current_profile(profileName.toUtf8());
+	}
-        req->SendOKResponse();
+
-    } else {
+	// TODO : check if profile exists
-        req->SendErrorResponse("invalid request parameters");
+	obs_frontend_set_current_profile(profileName.toUtf8());
-    }
+	return request.success();
 }
 
  /**
@@ -39,32 +37,31 @@
  * @category profiles
  * @since 4.0.0
  */
-void WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetCurrentProfile(const RpcRequest& request) {
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "profile-name",
+	char* currentProfile = obs_frontend_get_current_profile();
-        obs_frontend_get_current_profile());
+	obs_data_set_string(response, "profile-name", currentProfile);
-
+	bfree(currentProfile);
-    req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
  * Get a list of available profiles.
  *
- * @return {Object|Array} `profiles` List of available profiles.
+ * @return {Array<Object>} `profiles` List of available profiles.
  *
  * @api requests
  * @name ListProfiles
  * @category profiles
  * @since 4.0.0
  */
-void WSRequestHandler::HandleListProfiles(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::ListProfiles(const RpcRequest& request) {
-    char** profiles = obs_frontend_get_profiles();
+	char** profiles = obs_frontend_get_profiles();
-    OBSDataArrayAutoRelease list =
+	OBSDataArrayAutoRelease list = Utils::StringListToArray(profiles, "profile-name");
-        Utils::StringListToArray(profiles, "profile-name");
+	bfree(profiles);
-    bfree(profiles);
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_array(response, "profiles", list);
+	obs_data_set_array(response, "profiles", list);
 
-    req->SendOKResponse(response);
+	return request.success(response);
 }

src/WSRequestHandler_Recording.cpp

@@ -1,7 +1,17 @@
-#include <QString>
+#include "WSRequestHandler.h"
+
+#include <functional>
+#include <util/platform.h>
 #include "Utils.h"
 
-#include "WSRequestHandler.h"
+RpcResponse ifCanPause(const RpcRequest& request, std::function<RpcResponse()> callback)
+{
+	if (!obs_frontend_recording_active()) {
+		return request.failed("recording is not active");
+	}
+
+	return callback();
+}
 
 /**
  * Toggle recording on or off.
@@ -11,13 +21,9 @@
  * @category recording
  * @since 0.3
  */
- void WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartStopRecording(const RpcRequest& request) {
-    if (obs_frontend_recording_active())
+	(obs_frontend_recording_active() ? obs_frontend_recording_stop() : obs_frontend_recording_start());
-        obs_frontend_recording_stop();
+	return request.success();
-    else
-        obs_frontend_recording_start();
-
-    req->SendOKResponse();
 }
 
 /**
@@ -29,13 +35,13 @@
  * @category recording
  * @since 4.1.0
  */
- void WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartRecording(const RpcRequest& request) {
-    if (obs_frontend_recording_active() == false) {
+	if (obs_frontend_recording_active()) {
-        obs_frontend_recording_start();
+		return request.failed("recording already active");
-        req->SendOKResponse();
+	}
-    } else {
+
-        req->SendErrorResponse("recording already active");
+	obs_frontend_recording_start();
-    }
+	return request.success();
 }
 
 /**
@@ -47,17 +53,62 @@
  * @category recording
  * @since 4.1.0
  */
-void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
+ RpcResponse WSRequestHandler::StopRecording(const RpcRequest& request) {
-    if (obs_frontend_recording_active() == true) {
+	if (!obs_frontend_recording_active()) {
-        obs_frontend_recording_stop();
+		return request.failed("recording not active");
-        req->SendOKResponse();
+	}
-    } else {
+
-        req->SendErrorResponse("recording not active");
+	obs_frontend_recording_stop();
-    }
+	return request.success();
 }
 
 /**
- * Change the current recording folder.
+* Pause the current recording.
+* Returns an error if recording is not active or already paused.
+*
+* @api requests
+* @name PauseRecording
+* @category recording
+* @since 4.7.0
+*/
+RpcResponse WSRequestHandler::PauseRecording(const RpcRequest& request) {
+	return ifCanPause(request, [request]() {
+		if (obs_frontend_recording_paused()) {
+			return request.failed("recording already paused");
+		}
+
+		obs_frontend_recording_pause(true);
+		return request.success();
+	});
+}
+
+/**
+* Resume/unpause the current recording (if paused).
+* Returns an error if recording is not active or not paused.
+*
+* @api requests
+* @name ResumeRecording
+* @category recording
+* @since 4.7.0
+*/
+RpcResponse WSRequestHandler::ResumeRecording(const RpcRequest& request) {
+	return ifCanPause(request, [request]() {
+		if (!obs_frontend_recording_paused()) {
+			return request.failed("recording is not paused");
+		}
+
+		obs_frontend_recording_pause(false);
+		return request.success();
+	});
+}
+
+/**
+ * In the current profile, sets the recording folder of the Simple and Advanced
+ * output modes to the specified value.
+ * 
+ * Please note: if `SetRecordingFolder` is called while a recording is
+ * in progress, the change won't be applied immediately and will be
+ * effective on the next recording.
  * 
  * @param {String} `rec-folder` Path of the recording folder.
  *
@@ -66,18 +117,18 @@ void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
  * @category recording
  * @since 4.1.0
  */
- void WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetRecordingFolder(const RpcRequest& request) {
-    if (!req->hasField("rec-folder")) {
+	if (!request.hasField("rec-folder")) {
-        req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-        return;
+	}
-    }
 
-    const char* newRecFolder = obs_data_get_string(req->data, "rec-folder");
+	const char* newRecFolder = obs_data_get_string(request.parameters(), "rec-folder");
-    bool success = Utils::SetRecordingFolder(newRecFolder);
+	bool success = Utils::SetRecordingFolder(newRecFolder);
-    if (success)
+	if (!success) {
-        req->SendOKResponse();
+		return request.failed("invalid request parameters");
-    else
+	}
-        req->SendErrorResponse("invalid request parameters");
+
+	return request.success();
 }
 
 /**
@@ -90,11 +141,11 @@ void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
  * @category recording
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetRecordingFolder(const RpcRequest& request) {
-    const char* recFolder = Utils::GetRecordingFolder();
+	const char* recFolder = Utils::GetRecordingFolder();
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "rec-folder", recFolder);
+	obs_data_set_string(response, "rec-folder", recFolder);
 
-    req->SendOKResponse(response);
+	return request.success(response);
 }

src/WSRequestHandler_ReplayBuffer.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -11,13 +10,13 @@
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartStopReplayBuffer(const RpcRequest& request) {
-    if (obs_frontend_replay_buffer_active()) {
+	if (obs_frontend_replay_buffer_active()) {
-        obs_frontend_replay_buffer_stop();
+		obs_frontend_replay_buffer_stop();
-    } else {
+	} else {
-        Utils::StartReplayBuffer();
+		Utils::StartReplayBuffer();
-    }
+	}
-    req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -32,19 +31,17 @@ void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartReplayBuffer(const RpcRequest& request) {
-    if (!Utils::ReplayBufferEnabled()) {
+	if (!Utils::ReplayBufferEnabled()) {
-        req->SendErrorResponse("replay buffer disabled in settings");
+		return request.failed("replay buffer disabled in settings");
-        return;
+	}
-    }
 
-    if (obs_frontend_replay_buffer_active() == true) {
+	if (obs_frontend_replay_buffer_active() == true) {
-        req->SendErrorResponse("replay buffer already active");
+		return request.failed("replay buffer already active");
-        return;
+	}
-    }
 
-    Utils::StartReplayBuffer();
+	Utils::StartReplayBuffer();
-    req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -56,13 +53,13 @@ void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StopReplayBuffer(const RpcRequest& request) {
-    if (obs_frontend_replay_buffer_active() == true) {
+	if (obs_frontend_replay_buffer_active() == true) {
-        obs_frontend_replay_buffer_stop();
+		obs_frontend_replay_buffer_stop();
-        req->SendOKResponse();
+		return request.success();
-    } else {
+	} else {
-        req->SendErrorResponse("replay buffer not active");
+		return request.failed("replay buffer not active");
-    }
+	}
 }
 
 /**
@@ -75,18 +72,17 @@ void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SaveReplayBuffer(const RpcRequest& request) {
-    if (!obs_frontend_replay_buffer_active()) {
+	if (!obs_frontend_replay_buffer_active()) {
-        req->SendErrorResponse("replay buffer not active");
+		return request.failed("replay buffer not active");
-        return;
+	}
-    }
 
-    OBSOutputAutoRelease replayOutput = obs_frontend_get_replay_buffer_output();
+	OBSOutputAutoRelease replayOutput = obs_frontend_get_replay_buffer_output();
 
-    calldata_t cd = { 0 };
+	calldata_t cd = { 0 };
-    proc_handler_t* ph = obs_output_get_proc_handler(replayOutput);
+	proc_handler_t* ph = obs_output_get_proc_handler(replayOutput);
-    proc_handler_call(ph, "save", &cd);
+	proc_handler_call(ph, "save", &cd);
-    calldata_free(&cd);
+	calldata_free(&cd);
 
-    req->SendOKResponse();
+	return request.success();
 }

src/WSRequestHandler_SceneCollections.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -13,20 +12,19 @@
  * @category scene collections
  * @since 4.0.0
  */
- void WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetCurrentSceneCollection(const RpcRequest& request) {
-    if (!req->hasField("sc-name")) {
+	if (!request.hasField("sc-name")) {
-        req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-        return;
+	}
-    }
 
-    QString sceneCollection = obs_data_get_string(req->data, "sc-name");
+	QString sceneCollection = obs_data_get_string(request.parameters(), "sc-name");
-    if (!sceneCollection.isEmpty()) {
+	if (sceneCollection.isEmpty()) {
-        // TODO : Check if specified profile exists and if changing is allowed
+		return request.failed("invalid request parameters");
-        obs_frontend_set_current_scene_collection(sceneCollection.toUtf8());
+	}
-        req->SendOKResponse();
+
-    } else {
+	// TODO : Check if specified profile exists and if changing is allowed
-        req->SendErrorResponse("invalid request parameters");
+	obs_frontend_set_current_scene_collection(sceneCollection.toUtf8());
-    }
+	return request.success();
 }
 
 /**
@@ -39,33 +37,34 @@
  * @category scene collections
  * @since 4.0.0
  */
-void WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetCurrentSceneCollection(const RpcRequest& request) {
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "sc-name",
-        obs_frontend_get_current_scene_collection());
 
-    req->SendOKResponse(response);
+	char* sceneCollection = obs_frontend_get_current_scene_collection();
+	obs_data_set_string(response, "sc-name", sceneCollection);
+	bfree(sceneCollection);
+
+	return request.success(response);
 }
 
 /**
  * List available scene collections
  *
- * @return {Object|Array} `scene-collections` Scene collections list
+ * @return {Array<String>} `scene-collections` Scene collections list
- * @return {String} `scene-collections.*.`
  *
  * @api requests
  * @name ListSceneCollections
  * @category scene collections
  * @since 4.0.0
  */
-void WSRequestHandler::HandleListSceneCollections(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::ListSceneCollections(const RpcRequest& request) {
-    char** sceneCollections = obs_frontend_get_scene_collections();
+	char** sceneCollections = obs_frontend_get_scene_collections();
-    OBSDataArrayAutoRelease list =
+	OBSDataArrayAutoRelease list =
-        Utils::StringListToArray(sceneCollections, "sc-name");
+		Utils::StringListToArray(sceneCollections, "sc-name");
-    bfree(sceneCollections);
+	bfree(sceneCollections);
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_array(response, "scene-collections", list);
+	obs_data_set_array(response, "scene-collections", list);
 
-    req->SendOKResponse(response);
+	return request.success(response);
 }

src/WSRequestHandler_SceneItems.cpp

@@ -1,15 +1,18 @@
-#include <QString>
 #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 (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
-* @param {String} `item` The name of the source.
+* @param {String | Object} `item` Scene Item name (if this field is a string) or specification (if it is an object).
+* @param {String (optional)} `item.name` Scene Item name (if the `item` field is an object)
+* @param {int (optional)} `item.id` Scene Item ID (if the `item` field is an object)
 *
-* @return {String} `name` The name of the source.
+* @return {String} `name` Scene Item name.
+* @return {int} `itemId` Scene Item ID.
 * @return {int} `position.x` The x position of the source from the left.
 * @return {int} `position.y` The y position of the source from the top.
 * @return {int} `position.alignment` The point on the source that the item is manipulated from.
@@ -21,220 +24,164 @@
 * @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 {String} `bounds.type` Type of bounding box.
+* @return {bool} `muted` If the source is muted.
+* @return {bool} `locked` If the source's transform is locked.
+* @return {String} `bounds.type` Type of bounding box. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE".
 * @return {int} `bounds.alignment` Alignment of the bounding box.
 * @return {double} `bounds.x` Width of the bounding box.
 * @return {double} `bounds.y` Height of the bounding box.
+* @return {int} `sourceWidth` Base width (without scaling) of the source
+* @return {int} `sourceHeight` Base source (without scaling) of the source
+* @return {double} `width` Scene item width (base source width multiplied by the horizontal scaling factor)
+* @return {double} `height` Scene item height (base source height multiplied by the vertical scaling factor)
+* @return {int} `alignment` The point on the source that the item is manipulated from. The sum of 1=Left or 2=Right, and 4=Top or 8=Bottom, or omit to center on that axis.
+* @return {String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)
+* @return {Array<SceneItemTransform> (optional)} `groupChildren` List of children (if this item is a group)
 * 
 * @api requests
 * @name GetSceneItemProperties
 * @category scene items
 * @since 4.3.0
 */
-void WSRequestHandler::HandleGetSceneItemProperties(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetSceneItemProperties(const RpcRequest& request) {
-	if (!req->hasField("item")) {
+	if (!request.hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-		return;
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
+	OBSData params = request.parameters();
-	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
-		return;
-	}
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(params, "scene-name");
-	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
-		return;
 	}
 
-	OBSSceneItemAutoRelease sceneItem =
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(params, "item");
-		Utils::GetSceneItemFromName(scene, itemName);
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
 	if (!sceneItem) {
-		req->SendErrorResponse("specified scene item doesn't exist");
+		return request.failed("specified scene item doesn't exist");
-		return;
 	}
 
-	OBSDataAutoRelease data = obs_data_create();
+	OBSDataAutoRelease data = Utils::GetSceneItemPropertiesData(sceneItem);
-	obs_data_set_string(data, "name", itemName.toUtf8());
 
-	OBSDataAutoRelease posData = obs_data_create();
+	OBSSource sceneItemSource = obs_sceneitem_get_source(sceneItem);
-	vec2 pos;
+	obs_data_set_string(data, "name", obs_source_get_name(sceneItemSource));
-	obs_sceneitem_get_pos(sceneItem, &pos);
+	obs_data_set_int(data, "itemId", obs_sceneitem_get_id(sceneItem));
-	obs_data_set_double(posData, "x", pos.x);
-	obs_data_set_double(posData, "y", pos.y);
-	obs_data_set_int(posData, "alignment", obs_sceneitem_get_alignment(sceneItem));
-	obs_data_set_obj(data, "position", posData);
 
-	obs_data_set_double(data, "rotation", obs_sceneitem_get_rot(sceneItem));
+	return request.success(data);
-
-	OBSDataAutoRelease scaleData = obs_data_create();
-	vec2 scale;
-	obs_sceneitem_get_scale(sceneItem, &scale);
-	obs_data_set_double(scaleData, "x", scale.x);
-	obs_data_set_double(scaleData, "y", scale.y);
-	obs_data_set_obj(data, "scale", scaleData);
-
-	OBSDataAutoRelease cropData = obs_data_create();
-	obs_sceneitem_crop crop;
-	obs_sceneitem_get_crop(sceneItem, &crop);
-	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);
-	obs_data_set_obj(data, "crop", cropData);
-
-	obs_data_set_bool(data, "visible", obs_sceneitem_visible(sceneItem));
-
-	OBSDataAutoRelease boundsData = obs_data_create();
-	obs_bounds_type boundsType = obs_sceneitem_get_bounds_type(sceneItem);
-	if (boundsType == OBS_BOUNDS_NONE) {
-		obs_data_set_string(boundsData, "type", "OBS_BOUNDS_NONE");
-	}
-	else {
-		switch (boundsType) {
-		case OBS_BOUNDS_STRETCH: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_STRETCH");
-			break;
-		}
-		case OBS_BOUNDS_SCALE_INNER: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_SCALE_INNER");
-			break;
-		}
-		case OBS_BOUNDS_SCALE_OUTER: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_SCALE_OUTER");
-			break;
-		}
-		case OBS_BOUNDS_SCALE_TO_WIDTH: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_SCALE_TO_WIDTH");
-			break;
-		}
-		case OBS_BOUNDS_SCALE_TO_HEIGHT: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_SCALE_TO_HEIGHT");
-			break;
-		}
-		case OBS_BOUNDS_MAX_ONLY: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_MAX_ONLY");
-			break;
-		}
-		}
-		obs_data_set_int(boundsData, "alignment", obs_sceneitem_get_bounds_alignment(sceneItem));
-		vec2 bounds;
-		obs_sceneitem_get_bounds(sceneItem, &bounds);
-		obs_data_set_double(boundsData, "x", bounds.x);
-		obs_data_set_double(boundsData, "y", bounds.y);
-	}
-	obs_data_set_obj(data, "bounds", boundsData);
-
-	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 (optional)} `scene-name` Name of the scene the source item belongs to. Defaults to the current scene.
-* @param {String} `item` The name of the source.
+* @param {String | Object} `item` Scene Item name (if this field is a string) or specification (if it is an object).
-* @param {int} `position.x` The new x position of the source.
+* @param {String (optional)} `item.name` Scene Item name (if the `item` field is an object)
-* @param {int} `position.y` The new y position of the source.
+* @param {int (optional)} `item.id` Scene Item ID (if the `item` field is an object)
-* @param {int} `position.alignment` The new alignment of the source.
+* @param {int (optional)} `position.x` The new x position of the source.
-* @param {double} `rotation` The new clockwise rotation of the item in degrees.
+* @param {int (optional)} `position.y` The new y position of the source.
-* @param {double} `scale.x` The new x scale of the item.
+* @param {int (optional)} `position.alignment` The new alignment of the source.
-* @param {double} `scale.y` The new y scale of the item.
+* @param {double (optional)} `rotation` The new clockwise rotation of the item in degrees.
-* @param {int} `crop.top` The new amount of pixels cropped off the top of the source before scaling.
+* @param {double (optional)} `scale.x` The new x scale of the item.
-* @param {int} `crop.bottom` The new amount of pixels cropped off the bottom of the source before scaling.
+* @param {double (optional)} `scale.y` The new y scale of the item.
-* @param {int} `crop.left` The new amount of pixels cropped off the left of the source before scaling.
+* @param {int (optional)} `crop.top` The new amount of pixels cropped off the top of the source before scaling.
-* @param {int} `crop.right` The new amount of pixels cropped off the right 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 {bool} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.
+* @param {int (optional)} `crop.left` The new amount of pixels cropped off the left of the source before scaling.
-* @param {String} `bounds.type` The new bounds type of the source.
+* @param {int (optional)} `crop.right` The new amount of pixels cropped off the right of the source before scaling.
-* @param {int} `bounds.alignment` The new alignment of the bounding box. (0-2, 4-6, 8-10)
+* @param {bool (optional)} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.
-* @param {double} `bounds.x` The new width of the bounding box.
+* @param {bool (optional)} `locked` The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement.
-* @param {double} `bounds.y` The new height of the bounding box.
+* @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
 */
-void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetSceneItemProperties(const RpcRequest& request) {
-	if (!req->hasField("item")) {
+	if (!request.hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-		return;
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
+	OBSData params = request.parameters();
-	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
-		return;
-	}
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(params, "scene-name");
-	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
-		return;
 	}
 
-	OBSSceneItemAutoRelease sceneItem =
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(params, "item");
-		Utils::GetSceneItemFromName(scene, itemName);
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
 	if (!sceneItem) {
-		req->SendErrorResponse("specified scene item doesn't exist");
+		return request.failed("specified scene item doesn't exist");
-		return;
 	}
 
 	bool badRequest = false;
-	OBSDataAutoRelease errorMessage = obs_data_create();
+	OBSDataAutoRelease errorData = obs_data_create();
 
-	if (req->hasField("position")) {
+	obs_sceneitem_defer_update_begin(sceneItem);
+
+	if (request.hasField("position")) {
 		vec2 oldPosition;
 		OBSDataAutoRelease positionError = obs_data_create();
 		obs_sceneitem_get_pos(sceneItem, &oldPosition);
-		OBSDataAutoRelease reqPosition = obs_data_get_obj(req->data, "position");
+
+		OBSDataAutoRelease reqPosition = obs_data_get_obj(params, "position");
 		vec2 newPosition = oldPosition;
+
 		if (obs_data_has_user_value(reqPosition, "x")) {
 			newPosition.x = obs_data_get_int(reqPosition, "x");
 		}
 		if (obs_data_has_user_value(reqPosition, "y")) {
 			newPosition.y = obs_data_get_int(reqPosition, "y");
 		}
+
 		if (obs_data_has_user_value(reqPosition, "alignment")) {
 			const uint32_t alignment = obs_data_get_int(reqPosition, "alignment");
 			if (Utils::IsValidAlignment(alignment)) {
 				obs_sceneitem_set_alignment(sceneItem, alignment);
-			}
+			} else {
-			else {
 				badRequest = true;
 				obs_data_set_string(positionError, "alignment", "invalid");
-				obs_data_set_obj(errorMessage, "position", positionError);
+				obs_data_set_obj(errorData, "position", positionError);
 			}
 		}
+
 		obs_sceneitem_set_pos(sceneItem, &newPosition);
 	}
 
-	if (req->hasField("rotation")) {
+	if (request.hasField("rotation")) {
-		obs_sceneitem_set_rot(sceneItem, (float)obs_data_get_double(req->data, "rotation"));
+		obs_sceneitem_set_rot(sceneItem, (float)obs_data_get_double(params, "rotation"));
 	}
 
-	if (req->hasField("scale")) {
+	if (request.hasField("scale")) {
 		vec2 oldScale;
 		obs_sceneitem_get_scale(sceneItem, &oldScale);
-		OBSDataAutoRelease reqScale = obs_data_get_obj(req->data, "scale");
 		vec2 newScale = oldScale;
+
+		OBSDataAutoRelease reqScale = obs_data_get_obj(params, "scale");
+		
 		if (obs_data_has_user_value(reqScale, "x")) {
 			newScale.x = obs_data_get_double(reqScale, "x");
 		}
 		if (obs_data_has_user_value(reqScale, "y")) {
 			newScale.y = obs_data_get_double(reqScale, "y");
 		}
+
 		obs_sceneitem_set_scale(sceneItem, &newScale);
 	}
 
-	if (req->hasField("crop")) {
+	if (request.hasField("crop")) {
 		obs_sceneitem_crop oldCrop;
 		obs_sceneitem_get_crop(sceneItem, &oldCrop);
-		OBSDataAutoRelease reqCrop = obs_data_get_obj(req->data, "crop");
+
+		OBSDataAutoRelease reqCrop = obs_data_get_obj(params, "crop");
 		obs_sceneitem_crop newCrop = oldCrop;
+
 		if (obs_data_has_user_value(reqCrop, "top")) {
 			newCrop.top = obs_data_get_int(reqCrop, "top");
 		}
@@ -247,19 +194,25 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 		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")) {
+	if (request.hasField("visible")) {
-		obs_sceneitem_set_visible(sceneItem, obs_data_get_bool(req->data, "visible"));
+		obs_sceneitem_set_visible(sceneItem, obs_data_get_bool(params, "visible"));
 	}
 
-	if (req->hasField("bounds")) {
+	if (request.hasField("locked")) {
+		obs_sceneitem_set_locked(sceneItem, obs_data_get_bool(params, "locked"));
+	}
+
+	if (request.hasField("bounds")) {
 		bool badBounds = false;
 		OBSDataAutoRelease boundsError = obs_data_create();
-		OBSDataAutoRelease reqBounds = obs_data_get_obj(req->data, "bounds");
+		OBSDataAutoRelease reqBounds = obs_data_get_obj(params, "bounds");
+
 		if (obs_data_has_user_value(reqBounds, "type")) {
-			const char* newBoundsType = obs_data_get_string(reqBounds, "type");
+			QString newBoundsType = obs_data_get_string(reqBounds, "type");
 			if (newBoundsType == "OBS_BOUNDS_NONE") {
 				obs_sceneitem_set_bounds_type(sceneItem, OBS_BOUNDS_NONE);
 			}
@@ -286,16 +239,20 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 				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)) {
@@ -306,71 +263,67 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 				obs_data_set_string(boundsError, "alignment", "invalid");
 			}
 		}
+
 		if (badBounds) {
-			obs_data_set_obj(errorMessage, "bounds", boundsError);
+			obs_data_set_obj(errorData, "bounds", boundsError);
 		}
 	}
 
+	obs_sceneitem_defer_update_end(sceneItem);
+
 	if (badRequest) {
-		req->SendErrorResponse(errorMessage);
+		return request.failed("error", errorData);
-	}
-	else {
-		req->SendOKResponse();
 	}
+
+	return request.success();
 }
 
 /**
 * Reset a scene item.
 *
-* @param {String (optional)} `scene-name` Name of the scene the source belogns to. Defaults to the current scene.
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
-* @param {String} `item` Name of the source item.
+* @param {String | Object} `item` Scene Item name (if this field is a string) or specification (if it is an object).
+* @param {String (optional)} `item.name` Scene Item name (if the `item` field is an object)
+* @param {int (optional)} `item.id` Scene Item ID (if the `item` field is an object)
 *
 * @api requests
 * @name ResetSceneItem
 * @category scene items
 * @since 4.2.0
 */
-void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::ResetSceneItem(const RpcRequest& request) {
-	// TODO: remove this request, or refactor it to ResetSource
+	if (!request.hasField("item")) {
-
+		return request.failed("missing request parameters");
-	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
-	const char* itemName = obs_data_get_string(req->data, "item");
+	OBSData params = request.parameters();
-	if (!itemName) {
-		req->SendErrorResponse("invalid request parameters");
-		return;
-	}
 
-	const char* sceneName = obs_data_get_string(req->data, "scene-name");
+	const char* sceneName = obs_data_get_string(params, "scene-name");
-	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
-		return;
 	}
 
-	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(params, "item");
-	if (sceneItem) {
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
-		OBSSource sceneItemSource = obs_sceneitem_get_source(sceneItem);
+	if (!sceneItem) {
-
+		return request.failed("specified scene item doesn't exist");
-		OBSDataAutoRelease settings = obs_source_get_settings(sceneItemSource);
-		obs_source_update(sceneItemSource, settings);
-
-		req->SendOKResponse();
-	}
-	else {
-		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 request.success();
 }
 
 /**
 * Show or hide a specified source item in a specified scene.
 *
-* @param {String} `source` Scene item name in the specified scene.
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the currently active scene.
+* @param {String} `source` Scene Item name.
 * @param {boolean} `render` true = shown ; false = hidden
-* @param {String (optional)} `scene-name` Name of the scene where the source resides. Defaults to the currently active scene.
 *
 * @api requests
 * @name SetSceneItemRender
@@ -378,45 +331,41 @@ void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
 * @since 0.3
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetSceneItemRender(const RpcRequest& request) {
-	if (!req->hasField("source") ||
+	if (!request.hasField("source") ||
-		!req->hasField("render"))
+		!request.hasField("render"))
 	{
-		req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-		return;
 	}
 
-	const char* itemName = obs_data_get_string(req->data, "source");
+	const char* itemName = obs_data_get_string(request.parameters(), "source");
-	bool isVisible = obs_data_get_bool(req->data, "render");
+	bool isVisible = obs_data_get_bool(request.parameters(), "render");
 
 	if (!itemName) {
-		req->SendErrorResponse("invalid request parameters");
+		return request.failed("invalid request parameters");
-		return;
 	}
 
-	const char* sceneName = obs_data_get_string(req->data, "scene-name");
+	const char* sceneName = obs_data_get_string(request.parameters(), "scene-name");
-	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem =
 		Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
-		obs_sceneitem_set_visible(sceneItem, isVisible);
+		return request.failed("specified scene item doesn't exist");
-		req->SendOKResponse();
-	}
-	else {
-		req->SendErrorResponse("specified scene item doesn't exist");
 	}
+
+	obs_sceneitem_set_visible(sceneItem, isVisible);
+	return request.success();
 }
 
 /**
 * Sets the coordinates of a specified source item.
 *
-* @param {String (optional)} `scene-name` The name of the scene that the source item belongs to. Defaults to the current scene.
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
-* @param {String} `item` The name of the source item.
+* @param {String} `item` Scene Item name.
 * @param {double} `x` X coordinate.
 * @param {double} `y` Y coordinate.
 
@@ -427,45 +376,41 @@ void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
 * @since 4.0.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetSceneItemPosition(const RpcRequest& request) {
-	if (!req->hasField("item") ||
+	if (!request.hasField("item") ||
-		!req->hasField("x") || !req->hasField("y")) {
+		!request.hasField("x") || !request.hasField("y")) {
-		req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-		return;
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
+	QString itemName = obs_data_get_string(request.parameters(), "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return request.failed("invalid request parameters");
-		return;
 	}
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(request.parameters(), "scene-name");
-	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene could not be found");
+		return request.failed("requested scene could not be found");
-		return;
 	}
 
 	OBSSceneItem sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
-		vec2 item_position = { 0 };
+		return request.failed("specified scene item doesn't exist");
-		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);
 
-		req->SendOKResponse();
+	vec2 item_position = { 0 };
-	}
+	item_position.x = obs_data_get_double(request.parameters(), "x");
-	else {
+	item_position.y = obs_data_get_double(request.parameters(), "y");
-		req->SendErrorResponse("specified scene item doesn't exist");
+	obs_sceneitem_set_pos(sceneItem, &item_position);
-	}
+
+	return request.success();
 }
 
 /**
 * 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 (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
-* @param {String} `item` The name of the source item.
+* @param {String} `item` Scene Item name.
 * @param {double} `x-scale` Width scale factor.
 * @param {double} `y-scale` Height scale factor.
 * @param {double} `rotation` Source item rotation (in degrees).
@@ -476,50 +421,51 @@ void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
 * @since 4.0.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetSceneItemTransform(const RpcRequest& request) {
-	if (!req->hasField("item") ||
+	if (!request.hasField("item") ||
-		!req->hasField("x-scale") ||
+		!request.hasField("x-scale") ||
-		!req->hasField("y-scale") ||
+		!request.hasField("y-scale") ||
-		!req->hasField("rotation"))
+		!request.hasField("rotation"))
 	{
-		req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-		return;
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
+	QString itemName = obs_data_get_string(request.parameters(), "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return request.failed("invalid request parameters");
-		return;
 	}
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(request.parameters(), "scene-name");
-	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
-		return;
 	}
 
 	vec2 scale;
-	scale.x = obs_data_get_double(req->data, "x-scale");
+	scale.x = obs_data_get_double(request.parameters(), "x-scale");
-	scale.y = obs_data_get_double(req->data, "y-scale");
+	scale.y = obs_data_get_double(request.parameters(), "y-scale");
-	float rotation = obs_data_get_double(req->data, "rotation");
+	float rotation = obs_data_get_double(request.parameters(), "rotation");
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
-		obs_sceneitem_set_scale(sceneItem, &scale);
+		return request.failed("specified scene item doesn't exist");
-		obs_sceneitem_set_rot(sceneItem, rotation);
-		req->SendOKResponse();
-	}
-	else {
-		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 request.success();
 }
 
 /**
 * 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 (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
-* @param {String} `item` The name of the source.
+* @param {String} `item` Scene Item name.
 * @param {int} `top` Pixel position of the top of the source item.
 * @param {int} `bottom` Pixel position of the bottom of the source item.
 * @param {int} `left` Pixel position of the left of the source item.
@@ -531,38 +477,145 @@ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
 * @since 4.1.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetSceneItemCrop(const RpcRequest& request) {
-	if (!req->hasField("item")) {
+	if (!request.hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-		return;
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
+	QString itemName = obs_data_get_string(request.parameters(), "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return request.failed("invalid request parameters");
-		return;
 	}
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(request.parameters(), "scene-name");
-	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
-		struct obs_sceneitem_crop crop = { 0 };
+		return request.failed("specified scene item doesn't exist");
-		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);
-
-		req->SendOKResponse();
-	}
-	else {
-		req->SendErrorResponse("specified scene item doesn't exist");
 	}
+
+	struct obs_sceneitem_crop crop = { 0 };
+	crop.top = obs_data_get_int(request.parameters(), "top");
+	crop.bottom = obs_data_get_int(request.parameters(), "bottom");
+	crop.left = obs_data_get_int(request.parameters(), "left");
+	crop.right = obs_data_get_int(request.parameters(), "right");
+
+	obs_sceneitem_set_crop(sceneItem, &crop);
+
+	return request.success();
+}
+
+/**
+ * Deletes a scene item.
+ *
+ * @param {String (optional)} `scene` Name of the scene the scene item belongs to. Defaults to the current scene.
+ * @param {Object} `item` Scene item to delete (required)
+ * @param {String} `item.name` Scene Item name (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` Scene Item ID.
+ *
+ * @api requests
+ * @name DeleteSceneItem
+ * @category scene items
+ * @since 4.5.0
+ */
+RpcResponse WSRequestHandler::DeleteSceneItem(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(request.parameters(), "scene");
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return request.failed("requested scene doesn't exist");
+	}
+
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(request.parameters(), "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
+	if (!sceneItem) {
+		return request.failed("item with id/name combination not found in specified scene");
+	}
+
+	obs_sceneitem_remove(sceneItem);
+
+	return request.success();
+}
+
+/**
+ * Duplicates a scene item.
+ *
+ * @param {String (optional)} `fromScene` Name of the scene to copy the item from. Defaults to the current scene.
+ * @param {String (optional)} `toScene` Name of the scene to create the item in. Defaults to the current scene.
+ * @param {Object} `item` Scene Item to duplicate from the source scene (required)
+ * @param {String} `item.name` Scene Item name (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` Scene Item ID.
+ *
+ * @return {String} `scene` Name of the scene where the new item was created
+ * @return {Object} `item` New item info
+ * @return {int} `item.id` New item ID
+ * @return {String} `item.name` New item name
+ *
+ * @api requests
+ * @name DuplicateSceneItem
+ * @category scene items
+ * @since 4.5.0
+ */
+RpcResponse WSRequestHandler::DuplicateSceneItem(const RpcRequest& request) {
+	struct DuplicateSceneItemData {
+		obs_sceneitem_t *referenceItem;
+		obs_source_t *fromSource;
+		obs_sceneitem_t *newItem;
+	};
+
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* fromSceneName = obs_data_get_string(request.parameters(), "fromScene");
+	OBSScene fromScene = Utils::GetSceneFromNameOrCurrent(fromSceneName);
+	if (!fromScene) {
+		return request.failed("requested fromScene doesn't exist");
+	}
+
+	const char* toSceneName = obs_data_get_string(request.parameters(), "toScene");
+	OBSScene toScene = Utils::GetSceneFromNameOrCurrent(toSceneName);
+	if (!toScene) {
+		return request.failed("requested toScene doesn't exist");
+	}
+
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(request.parameters(), "item");
+	OBSSceneItemAutoRelease referenceItem = Utils::GetSceneItemFromRequestField(fromScene, itemField);
+	if (!referenceItem) {
+		return request.failed("item with id/name combination not found in specified scene");
+	}
+
+	DuplicateSceneItemData data;
+	data.fromSource = obs_sceneitem_get_source(referenceItem);
+	data.referenceItem = referenceItem;
+
+	obs_enter_graphics();
+	obs_scene_atomic_update(toScene, [](void *_data, obs_scene_t *scene) {
+		auto data = reinterpret_cast<DuplicateSceneItemData*>(_data);
+		data->newItem = obs_scene_add(scene, data->fromSource);
+		obs_sceneitem_set_visible(data->newItem, obs_sceneitem_visible(data->referenceItem));
+	}, &data);
+	obs_leave_graphics();
+
+	obs_sceneitem_t *newItem = data.newItem;
+	if (!newItem) {
+		return request.failed("Error duplicating scene item");
+	}
+
+	OBSDataAutoRelease itemData = obs_data_create();
+	obs_data_set_int(itemData, "id", obs_sceneitem_get_id(newItem));
+	obs_data_set_string(itemData, "name", obs_source_get_name(obs_sceneitem_get_source(newItem)));
+
+	OBSDataAutoRelease responseData = obs_data_create();
+	obs_data_set_obj(responseData, "item", itemData);
+	obs_data_set_string(responseData, "scene", obs_source_get_name(obs_scene_get_source(toScene)));
+
+	return request.success(responseData);
 }

src/WSRequestHandler_Scenes.cpp

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

src/WSRequestHandler_Streaming.cpp

@@ -1,4 +1,4 @@
-#include <QString>
+#include "obs-websocket.h"
 #include "Utils.h"
 #include "WSEvents.h"
 
@@ -20,26 +20,26 @@
  * @category streaming
  * @since 0.3
  */
- void WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetStreamingStatus(const RpcRequest& request) {
-    OBSDataAutoRelease data = obs_data_create();
+	auto events = GetEventsSystem();
-    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;
+	OBSDataAutoRelease data = obs_data_create();
-    if (obs_frontend_streaming_active()) {
+	obs_data_set_bool(data, "streaming", obs_frontend_streaming_active());
-        tc = WSEvents::Instance->GetStreamingTimecode();
+	obs_data_set_bool(data, "recording", obs_frontend_recording_active());
-        obs_data_set_string(data, "stream-timecode", tc);
+	obs_data_set_bool(data, "recording-paused", obs_frontend_recording_paused());
-        bfree((void*)tc);
+	obs_data_set_bool(data, "preview-only", false);
-    }
 
-    if (obs_frontend_recording_active()) {
+	if (obs_frontend_streaming_active()) {
-        tc = WSEvents::Instance->GetRecordingTimecode();
+		QString streamingTimecode = events->getStreamingTimecode();
-        obs_data_set_string(data, "rec-timecode", tc);
+		obs_data_set_string(data, "stream-timecode", streamingTimecode.toUtf8().constData());
-        bfree((void*)tc);
+	}
-    }
 
-    req->SendOKResponse(data);
+	if (obs_frontend_recording_active()) {
+		QString recordingTimecode = events->getRecordingTimecode();
+		obs_data_set_string(data, "rec-timecode", recordingTimecode.toUtf8().constData());
+	}
+
+	return request.success(data);
 }
 
 /**
@@ -50,11 +50,11 @@
  * @category streaming
  * @since 0.3
  */
- void WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartStopStreaming(const RpcRequest& request) {
-    if (obs_frontend_streaming_active())
+	if (obs_frontend_streaming_active())
-        HandleStopStreaming(req);
+		return StopStreaming(request);
-    else
+	else
-        HandleStartStreaming(req);
+		return StartStreaming(request);
 }
 
 /**
@@ -67,100 +67,100 @@
  * @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 {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.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`.
+ * @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
  */
- void WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartStreaming(const RpcRequest& request) {
-    if (obs_frontend_streaming_active() == false) {
+	if (obs_frontend_streaming_active() == false) {
-        OBSService configuredService = obs_frontend_get_streaming_service();
+		OBSService configuredService = obs_frontend_get_streaming_service();
-        OBSService newService = nullptr;
+		OBSService newService = nullptr;
 
-        // TODO: fix service memory leak
+		// TODO: fix service memory leak
 
-        if (req->hasField("stream")) {
+		if (request.hasField("stream")) {
-            OBSDataAutoRelease streamData = obs_data_get_obj(req->data, "stream");
+			OBSDataAutoRelease streamData = obs_data_get_obj(request.parameters(), "stream");
-            OBSDataAutoRelease newSettings = obs_data_get_obj(streamData, "settings");
+			OBSDataAutoRelease newSettings = obs_data_get_obj(streamData, "settings");
-            OBSDataAutoRelease newMetadata = obs_data_get_obj(streamData, "metadata");
+			OBSDataAutoRelease newMetadata = obs_data_get_obj(streamData, "metadata");
 
-            OBSDataAutoRelease csHotkeys =
+			OBSDataAutoRelease csHotkeys =
-                obs_hotkeys_save_service(configuredService);
+				obs_hotkeys_save_service(configuredService);
 
-            QString currentType = obs_service_get_type(configuredService);
+			QString currentType = obs_service_get_type(configuredService);
-            QString newType = obs_data_get_string(streamData, "type");
+			QString newType = obs_data_get_string(streamData, "type");
-            if (newType.isEmpty() || newType.isNull()) {
+			if (newType.isEmpty() || newType.isNull()) {
-                newType = currentType;
+				newType = currentType;
-            }
+			}
 
-            //Supporting adding metadata parameters to key query string
+			//Supporting adding metadata parameters to key query string
-            QString query = Utils::ParseDataToQueryString(newMetadata);
+			QString query = Utils::ParseDataToQueryString(newMetadata);
-            if (!query.isEmpty()
+			if (!query.isEmpty()
-                    && obs_data_has_user_value(newSettings, "key"))
+					&& obs_data_has_user_value(newSettings, "key"))
-            {
+			{
-                const char* key = obs_data_get_string(newSettings, "key");
+				const char* key = obs_data_get_string(newSettings, "key");
-                int keylen = strlen(key);
+				size_t keylen = strlen(key);
 
-                bool hasQuestionMark = false;
+				bool hasQuestionMark = false;
-                for (int i = 0; i < keylen; i++) {
+				for (size_t i = 0; i < keylen; i++) {
-                    if (key[i] == '?') {
+					if (key[i] == '?') {
-                        hasQuestionMark = true;
+						hasQuestionMark = true;
-                        break;
+						break;
-                    }
+					}
-                }
+				}
 
-                if (hasQuestionMark) {
+				if (hasQuestionMark) {
-                    query.prepend('&');
+					query.prepend('&');
-                } else {
+				} else {
-                    query.prepend('?');
+					query.prepend('?');
-                }
+				}
 
-                query.prepend(key);
+				query.prepend(key);
-                obs_data_set_string(newSettings, "key", query.toUtf8());
+				obs_data_set_string(newSettings, "key", query.toUtf8());
-            }
+			}
 
-            if (newType == currentType) {
+			if (newType == currentType) {
-                // Service type doesn't change: apply settings to current service
+				// Service type doesn't change: apply settings to current service
 
-                // By doing this, you can send a request to the websocket
+				// By doing this, you can send a request to the websocket
-                // that only contains settings you want to change, instead of
+				// that only contains settings you want to change, instead of
-                // having to do a get and then change them
+				// having to do a get and then change them
 
-                OBSDataAutoRelease currentSettings = obs_service_get_settings(configuredService);
+				OBSDataAutoRelease currentSettings = obs_service_get_settings(configuredService);
-                OBSDataAutoRelease updatedSettings = obs_data_create();
+				OBSDataAutoRelease updatedSettings = obs_data_create();
 
-                obs_data_apply(updatedSettings, currentSettings); //first apply the existing settings
+				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
+				obs_data_apply(updatedSettings, newSettings); //then apply the settings from the request should they exist
 
-                newService = obs_service_create(
+				newService = obs_service_create(
-                    newType.toUtf8(), STREAM_SERVICE_ID,
+					newType.toUtf8(), STREAM_SERVICE_ID,
-                    updatedSettings, csHotkeys);
+					updatedSettings, csHotkeys);
-            }
+			}
-            else {
+			else {
-                // Service type changed: override service settings
+				// Service type changed: override service settings
-                newService = obs_service_create(
+				newService = obs_service_create(
-                    newType.toUtf8(), STREAM_SERVICE_ID,
+					newType.toUtf8(), STREAM_SERVICE_ID,
-                    newSettings, csHotkeys);
+					newSettings, csHotkeys);
-            }
+			}
 
-            obs_frontend_set_streaming_service(newService);
+			obs_frontend_set_streaming_service(newService);
-        }
+		}
 
-        obs_frontend_streaming_start();
+		obs_frontend_streaming_start();
 
-        // Stream settings provided in StartStreaming are not persisted to disk
+		// Stream settings provided in StartStreaming are not persisted to disk
-        if (newService != nullptr) {
+		if (newService != nullptr) {
-            obs_frontend_set_streaming_service(configuredService);
+			obs_frontend_set_streaming_service(configuredService);
-        }
+		}
 
-        req->SendOKResponse();
+		return request.success();
-    } else {
+	} else {
-        req->SendErrorResponse("streaming already active");
+		return request.failed("streaming already active");
-    }
+	}
 }
 
 /**
@@ -172,13 +172,13 @@
  * @category streaming
  * @since 4.1.0
  */
-void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StopStreaming(const RpcRequest& request) {
-    if (obs_frontend_streaming_active() == true) {
+	if (obs_frontend_streaming_active() == true) {
-        obs_frontend_streaming_stop();
+		obs_frontend_streaming_stop();
-        req->SendOKResponse();
+		return request.success();
-    } else {
+	} else {
-        req->SendErrorResponse("streaming not active");
+		return request.failed("streaming not active");
-    }
+	}
 }
 
 /**
@@ -188,7 +188,7 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
  * @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 {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.
@@ -198,51 +198,53 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
- void WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetStreamSettings(const RpcRequest& request) {
-    OBSService service = obs_frontend_get_streaming_service();
+	OBSService service = obs_frontend_get_streaming_service();
 
-    OBSDataAutoRelease requestSettings = obs_data_get_obj(req->data, "settings");
+	OBSDataAutoRelease requestSettings = obs_data_get_obj(request.parameters(), "settings");
-    if (!requestSettings) {
+	if (!requestSettings) {
-        req->SendErrorResponse("'settings' are required'");
+		return request.failed("'settings' are required'");
-        return;
+	}
-    }
 
-    QString serviceType = obs_service_get_type(service);
+	QString serviceType = obs_service_get_type(service);
-    QString requestedType = obs_data_get_string(req->data, "type");
+	QString requestedType = obs_data_get_string(request.parameters(), "type");
 
-    if (requestedType != nullptr && requestedType != serviceType) {
+	if (requestedType != nullptr && requestedType != serviceType) {
-        OBSDataAutoRelease hotkeys = obs_hotkeys_save_service(service);
+		OBSDataAutoRelease hotkeys = obs_hotkeys_save_service(service);
-        service = obs_service_create(
+		service = obs_service_create(
-            requestedType.toUtf8(), STREAM_SERVICE_ID, requestSettings, hotkeys);
+			requestedType.toUtf8(), STREAM_SERVICE_ID, requestSettings, hotkeys);
-    } else {
+		obs_frontend_set_streaming_service(service);
-        // If type isn't changing, we should overlay the settings we got
+	} else {
-        // to the existing settings. By doing so, you can send a request that
+		// If type isn't changing, we should overlay the settings we got
-        // only contains the settings you want to change, instead of having to
+		// to the existing settings. By doing so, you can send a request that
-        // do a get and then change them
+		// 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 existingSettings = obs_service_get_settings(service);
-        OBSDataAutoRelease newSettings = obs_data_create();
+		OBSDataAutoRelease newSettings = obs_data_create();
 
-        // Apply existing settings
+		// Apply existing settings
-        obs_data_apply(newSettings, existingSettings);
+		obs_data_apply(newSettings, existingSettings);
-        // Then apply the settings from the request
+		// Then apply the settings from the request
-        obs_data_apply(newSettings, requestSettings);
+		obs_data_apply(newSettings, requestSettings);
 
-        obs_service_update(service, newSettings);
+		obs_service_update(service, newSettings);
-    }
+	}
 
-    //if save is specified we should immediately save the streaming service
+	//if save is specified we should immediately save the streaming service
-    if (obs_data_get_bool(req->data, "save")) {
+	if (obs_data_get_bool(request.parameters(), "save")) {
-        obs_frontend_save_streaming_service();
+		obs_frontend_save_streaming_service();
-    }
+	}
 
-    OBSDataAutoRelease serviceSettings = obs_service_get_settings(service);
+	OBSService responseService = obs_frontend_get_streaming_service();
+	OBSDataAutoRelease serviceSettings = obs_service_get_settings(responseService);
+	const char* responseType = obs_service_get_type(responseService);
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "type", requestedType.toUtf8());
+	obs_data_set_string(response, "type", responseType);
-    obs_data_set_obj(response, "settings", serviceSettings);
+	obs_data_set_obj(response, "settings", serviceSettings);
 
-    req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -252,26 +254,26 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
  * @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 audentication should be used when connecting to the streaming server.
+ * @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.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`.
+ * @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
  */
-void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetStreamSettings(const RpcRequest& request) {
-    OBSService service = obs_frontend_get_streaming_service();
+	OBSService service = obs_frontend_get_streaming_service();
 
-    const char* serviceType = obs_service_get_type(service);
+	const char* serviceType = obs_service_get_type(service);
-    OBSDataAutoRelease settings = obs_service_get_settings(service);
+	OBSDataAutoRelease settings = obs_service_get_settings(service);
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "type", serviceType);
+	obs_data_set_string(response, "type", serviceType);
-    obs_data_set_obj(response, "settings", settings);
+	obs_data_set_obj(response, "settings", settings);
 
-    req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -282,7 +284,37 @@ void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
-void WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SaveStreamSettings(const RpcRequest& request) {
-    obs_frontend_save_streaming_service();
+	obs_frontend_save_streaming_service();
-    req->SendOKResponse();
+	return request.success();
 }
+
+
+/**
+ * Send the provided text as embedded CEA-608 caption data.
+ * As of OBS Studio 23.1, captions are not yet available on Linux.
+ *
+ * @param {String} `text` Captions text
+ *
+ * @api requests
+ * @name SendCaptions
+ * @category streaming
+ * @since 4.6.0
+ */
+#if BUILD_CAPTIONS
+RpcResponse WSRequestHandler::SendCaptions(const RpcRequest& request) {
+	if (!request.hasField("text")) {
+		return request.failed("missing request parameters");
+	}
+
+	OBSOutputAutoRelease output = obs_frontend_get_streaming_output();
+	if (output) {
+		const char* caption = obs_data_get_string(request.parameters(), "text");
+		// Send caption text with immediately (0 second delay)
+		obs_output_output_caption_text2(output, caption, 0.0);
+	}
+
+	return request.success();
+}
+#endif
+

src/WSRequestHandler_StudioMode.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -13,13 +12,13 @@
  * @category studio mode
  * @since 4.1.0
  */
- void WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetStudioModeStatus(const RpcRequest& request) {
-    bool previewActive = obs_frontend_preview_program_mode_active();
+	bool previewActive = obs_frontend_preview_program_mode_active();
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_bool(response, "studio-mode", previewActive);
+	obs_data_set_bool(response, "studio-mode", previewActive);
 
-    req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -27,27 +26,26 @@
  * Will return an `error` if Studio Mode is not enabled.
  *
  * @return {String} `name` The name of the active preview scene.
- * @return {Source|Array} `sources`
+ * @return {Array<SceneItem>} `sources`
  *
  * @api requests
  * @name GetPreviewScene
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetPreviewScene(const RpcRequest& request) {
-    if (!obs_frontend_preview_program_mode_active()) {
+	if (!obs_frontend_preview_program_mode_active()) {
-        req->SendErrorResponse("studio mode not enabled");
+		return request.failed("studio mode not enabled");
-        return;
+	}
-    }
 
-    OBSSourceAutoRelease scene = obs_frontend_get_current_preview_scene();
+	OBSSourceAutoRelease scene = obs_frontend_get_current_preview_scene();
-    OBSDataArrayAutoRelease sceneItems = Utils::GetSceneItems(scene);
+	OBSDataArrayAutoRelease sceneItems = Utils::GetSceneItems(scene);
 
-    OBSDataAutoRelease data = obs_data_create();
+	OBSDataAutoRelease data = obs_data_create();
-    obs_data_set_string(data, "name", obs_source_get_name(scene));
+	obs_data_set_string(data, "name", obs_source_get_name(scene));
-    obs_data_set_array(data, "sources", sceneItems);
+	obs_data_set_array(data, "sources", sceneItems);
 
-    req->SendOKResponse(data);
+	return request.success(data);
 }
 
 /**
@@ -61,26 +59,23 @@ void WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetPreviewScene(const RpcRequest& request) {
-    if (!obs_frontend_preview_program_mode_active()) {
+	if (!obs_frontend_preview_program_mode_active()) {
-        req->SendErrorResponse("studio mode not enabled");
+		return request.failed("studio mode not enabled");
-        return;
+	}
-    }
 
-    if (!req->hasField("scene-name")) {
+	if (!request.hasField("scene-name")) {
-        req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-        return;
+	}
-    }
 
-    const char* scene_name = obs_data_get_string(req->data, "scene-name");
+	const char* scene_name = obs_data_get_string(request.parameters(), "scene-name");
-    OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(scene_name);
+	OBSScene scene = Utils::GetSceneFromNameOrCurrent(scene_name);
+	if (!scene) {
+		return request.failed("specified scene doesn't exist");
+	}
 
-    if (scene) {
+	obs_frontend_set_current_preview_scene(obs_scene_get_source(scene));
-        obs_frontend_set_current_preview_scene(scene);
+	return request.success();
-        req->SendOKResponse();
-    } else {
-        req->SendErrorResponse("specified scene doesn't exist");
-    }
 }
 
 /**
@@ -96,40 +91,37 @@ void WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::TransitionToProgram(const RpcRequest& request) {
-    if (!obs_frontend_preview_program_mode_active()) {
+	if (!obs_frontend_preview_program_mode_active()) {
-        req->SendErrorResponse("studio mode not enabled");
+		return request.failed("studio mode not enabled");
-        return;
+	}
-    }
 
-    if (req->hasField("with-transition")) {
+	if (request.hasField("with-transition")) {
-        OBSDataAutoRelease transitionInfo =
+		OBSDataAutoRelease transitionInfo =
-            obs_data_get_obj(req->data, "with-transition");
+			obs_data_get_obj(request.parameters(), "with-transition");
 
-        if (obs_data_has_user_value(transitionInfo, "name")) {
+		if (obs_data_has_user_value(transitionInfo, "name")) {
-            QString transitionName =
+			QString transitionName =
-                obs_data_get_string(transitionInfo, "name");
+				obs_data_get_string(transitionInfo, "name");
-            if (transitionName.isEmpty()) {
+			if (transitionName.isEmpty()) {
-                req->SendErrorResponse("invalid request parameters");
+				return request.failed("invalid request parameters");
-                return;
+			}
-            }
 
-            bool success = Utils::SetTransitionByName(transitionName);
+			bool success = Utils::SetTransitionByName(transitionName);
-            if (!success) {
+			if (!success) {
-                req->SendErrorResponse("specified transition doesn't exist");
+				return request.failed("specified transition doesn't exist");
-                return;
+			}
-            }
+		}
-        }
 
-        if (obs_data_has_user_value(transitionInfo, "duration")) {
+		if (obs_data_has_user_value(transitionInfo, "duration")) {
-            int transitionDuration =
+			int transitionDuration =
-                obs_data_get_int(transitionInfo, "duration");
+				obs_data_get_int(transitionInfo, "duration");
-            Utils::SetTransitionDuration(transitionDuration);
+			obs_frontend_set_transition_duration(transitionDuration);
-        }
+		}
-    }
+	}
 
-    Utils::TransitionToProgram();
+	obs_frontend_preview_program_trigger_transition();
-    req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -140,9 +132,16 @@ void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::EnableStudioMode(const RpcRequest& request) {
-    obs_frontend_set_preview_program_mode(true);
+	if (obs_frontend_preview_program_mode_active()) {
-    req->SendOKResponse();
+		return request.failed("studio mode already active");
+	}
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
+		obs_frontend_set_preview_program_mode(true);
+
+		UNUSED_PARAMETER(param);
+	}, nullptr, true);
+	return request.success();
 }
 
 /**
@@ -153,9 +152,17 @@ void WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::DisableStudioMode(const RpcRequest& request) {
-    obs_frontend_set_preview_program_mode(false);
+	if (!obs_frontend_preview_program_mode_active()) {
-    req->SendOKResponse();
+		return request.failed("studio mode not active");
+	}
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
+		obs_frontend_set_preview_program_mode(false);
+
+		UNUSED_PARAMETER(param);
+	}, nullptr, true);
+
+	return request.success();
 }
 
 /**
@@ -166,8 +173,13 @@ void WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::ToggleStudioMode(const RpcRequest& request) {
-    bool previewProgramMode = obs_frontend_preview_program_mode_active();
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
-    obs_frontend_set_preview_program_mode(!previewProgramMode);
+		bool previewProgramMode = obs_frontend_preview_program_mode_active();
-    req->SendOKResponse();
+		obs_frontend_set_preview_program_mode(!previewProgramMode);
+
+		UNUSED_PARAMETER(param);
+	}, nullptr, true);
+
+	return request.success();
 }

src/WSRequestHandler_Transitions.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -7,35 +6,35 @@
  * List of all transitions available in the frontend's dropdown menu.
  *
  * @return {String} `current-transition` Name of the currently active transition.
- * @return {Object|Array} `transitions` List of transitions.
+ * @return {Array<Object>} `transitions` List of transitions.
- * @return {String} `transitions[].name` Name of the transition.
+ * @return {String} `transitions.*.name` Name of the transition.
  *
  * @api requests
  * @name GetTransitionList
  * @category transitions
  * @since 4.1.0
  */
- void WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetTransitionList(const RpcRequest& request) {
-    OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
+	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
-    obs_frontend_source_list transitionList = {};
+	obs_frontend_source_list transitionList = {};
-    obs_frontend_get_transitions(&transitionList);
+	obs_frontend_get_transitions(&transitionList);
 
-    OBSDataArrayAutoRelease transitions = obs_data_array_create();
+	OBSDataArrayAutoRelease transitions = obs_data_array_create();
-    for (size_t i = 0; i < transitionList.sources.num; i++) {
+	for (size_t i = 0; i < transitionList.sources.num; i++) {
-        OBSSource transition = transitionList.sources.array[i];
+		OBSSource transition = transitionList.sources.array[i];
 
-        OBSDataAutoRelease obj = obs_data_create();
+		OBSDataAutoRelease obj = obs_data_create();
-        obs_data_set_string(obj, "name", obs_source_get_name(transition));
+		obs_data_set_string(obj, "name", obs_source_get_name(transition));
-        obs_data_array_push_back(transitions, obj);
+		obs_data_array_push_back(transitions, obj);
-    }
+	}
-    obs_frontend_source_list_free(&transitionList);
+	obs_frontend_source_list_free(&transitionList);
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "current-transition",
+	obs_data_set_string(response, "current-transition",
-        obs_source_get_name(currentTransition));
+		obs_source_get_name(currentTransition));
-    obs_data_set_array(response, "transitions", transitions);
+	obs_data_set_array(response, "transitions", transitions);
 
-    req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -49,17 +48,17 @@
  * @category transitions
  * @since 0.3
  */
-void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetCurrentTransition(const RpcRequest& request) {
-    OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
+	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "name",
+	obs_data_set_string(response, "name",
-        obs_source_get_name(currentTransition));
+		obs_source_get_name(currentTransition));
 
-    if (!obs_transition_fixed(currentTransition))
+	if (!obs_transition_fixed(currentTransition))
-        obs_data_set_int(response, "duration", Utils::GetTransitionDuration());
+		obs_data_set_int(response, "duration", obs_frontend_get_transition_duration());
 
-    req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -72,18 +71,18 @@ void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
  * @category transitions
  * @since 0.3
  */
-void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetCurrentTransition(const RpcRequest& request) {
-    if (!req->hasField("transition-name")) {
+	if (!request.hasField("transition-name")) {
-        req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-        return;
+	}
-    }
 
-    QString name = obs_data_get_string(req->data, "transition-name");
+	QString name = obs_data_get_string(request.parameters(), "transition-name");
-    bool success = Utils::SetTransitionByName(name);
+	bool success = Utils::SetTransitionByName(name);
-    if (success)
+	if (!success) {
-        req->SendOKResponse();
+		return request.failed("requested transition does not exist");
-    else
+	}
-        req->SendErrorResponse("requested transition does not exist");
+	
+	return request.success();
 }
 
 /**
@@ -96,15 +95,14 @@ void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
  * @category transitions
  * @since 4.0.0
  */
-void WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetTransitionDuration(const RpcRequest& request) {
-    if (!req->hasField("duration")) {
+	if (!request.hasField("duration")) {
-        req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
-        return;
+	}
-    }
 
-    int ms = obs_data_get_int(req->data, "duration");
+	int ms = obs_data_get_int(request.parameters(), "duration");
-    Utils::SetTransitionDuration(ms);
+	obs_frontend_set_transition_duration(ms);
-    req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -117,10 +115,27 @@ void WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
  * @category transitions
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetTransitionDuration(const RpcRequest& request) {
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_int(response, "transition-duration",
+	obs_data_set_int(response, "transition-duration", obs_frontend_get_transition_duration());
-        Utils::GetTransitionDuration());
+	return request.success(response);
-
+}
-    req->SendOKResponse(response);
+
+/**
+ * Get the position of the current transition.
+ *
+ * @return {double} `position` current transition position. This value will be between 0.0 and 1.0. Note: Transition returns 1.0 when not active.
+ *
+ * @api requests
+ * @name GetTransitionPosition
+ * @category transitions
+ * @since 4.8.0
+ */
+RpcResponse WSRequestHandler::GetTransitionPosition(const RpcRequest& request) {
+	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_double(response, "position", obs_transition_get_time(currentTransition));
+
+	return request.success(response);
 }

src/WSServer.cpp

@@ -16,153 +16,232 @@ 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 <chrono>
+#include <thread>
+
 #include <QtCore/QThread>
 #include <QtCore/QByteArray>
-#include <QMainWindow>
+#include <QtWidgets/QMainWindow>
-#include <QMessageBox>
+#include <QtWidgets/QMessageBox>
+#include <QtConcurrent/QtConcurrent>
 #include <obs-frontend-api.h>
+#include <util/platform.h>
 
 #include "WSServer.h"
 #include "obs-websocket.h"
 #include "Config.h"
 #include "Utils.h"
+#include "protocol/OBSRemoteProtocol.h"
 
 QT_USE_NAMESPACE
 
-WSServer* WSServer::Instance = nullptr;
+using websocketpp::lib::placeholders::_1;
+using websocketpp::lib::placeholders::_2;
+using websocketpp::lib::bind;
 
-WSServer::WSServer(QObject* parent)
+WSServer::WSServer()
-    : QObject(parent),
+	: QObject(nullptr),
-      _wsServer(Q_NULLPTR),
+	  _connections(),
-      _clients(),
+	  _clMutex(QMutex::Recursive)
-      _clMutex(QMutex::Recursive)
 {
-    _wsServer = new QWebSocketServer(
+        _server.get_alog().clear_channels(websocketpp::log::alevel::frame_header | websocketpp::log::alevel::frame_payload | websocketpp::log::alevel::control);
-        QStringLiteral("obs-websocket"),
+	_server.init_asio();
-        QWebSocketServer::NonSecureMode);
+#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() {
+WSServer::~WSServer()
-    Stop();
+{
+	stop();
 }
 
-void WSServer::Start(quint16 port) {
+void WSServer::start(quint16 port)
-    if (port == _wsServer->serverPort())
+{
-        return;
+	if (_server.is_listening() && port == _serverPort) {
+		blog(LOG_INFO, "WSServer::start: server already on this port. no restart needed");
+		return;
+	}
 
-    if(_wsServer->isListening())
+	if (_server.is_listening()) {
-        Stop();
+		stop();
+	}
 
-    bool serverStarted = _wsServer->listen(QHostAddress::Any, port);
+	_server.reset();
-    if (serverStarted) {
-        blog(LOG_INFO, "server started successfully on TCP port %d", port);
 
-        connect(_wsServer, SIGNAL(newConnection()),
+	_serverPort = port;
-            this, SLOT(onNewConnection()));
-    }
-    else {
-        QString errorString = _wsServer->errorString();
-        blog(LOG_ERROR,
-            "error: failed to start server on TCP port %d: %s",
-            port, errorString.toUtf8().constData());
 
-        QMainWindow* mainWindow = (QMainWindow*)obs_frontend_get_main_window();
+	websocketpp::lib::error_code errorCode;
+	_server.listen(_serverPort, errorCode);
 
-        obs_frontend_push_ui_translation(obs_module_get_string);
+	if (errorCode) {
-        QString title = tr("OBSWebsocket.Server.StartFailed.Title");
+		std::string errorCodeMessage = errorCode.message();
-        QString msg = tr("OBSWebsocket.Server.StartFailed.Message").arg(port);
+		blog(LOG_INFO, "server: listen failed: %s", errorCodeMessage.c_str());
-        obs_frontend_pop_ui_translation();
 
-        QMessageBox::warning(mainWindow, title, msg);
+		obs_frontend_push_ui_translation(obs_module_get_string);
-    }
+		QString errorTitle = tr("OBSWebsocket.Server.StartFailed.Title");
+		QString errorMessage = tr("OBSWebsocket.Server.StartFailed.Message").arg(_serverPort).arg(errorCodeMessage.c_str());
+		obs_frontend_pop_ui_translation();
+
+		QMainWindow* mainWindow = reinterpret_cast<QMainWindow*>(obs_frontend_get_main_window());
+		QMessageBox::warning(mainWindow, errorTitle, errorMessage);
+
+		return;
+	}
+
+	_server.start_accept();
+
+	QtConcurrent::run([=]() {
+		blog(LOG_INFO, "io thread started");
+		_server.run();
+		blog(LOG_INFO, "io thread exited");
+	});
+
+	blog(LOG_INFO, "server started successfully on port %d", _serverPort);
 }
 
-void WSServer::Stop() {
+void WSServer::stop()
-    QMutexLocker locker(&_clMutex);
+{
-    for(QWebSocket* pClient : _clients) {
+	if (!_server.is_listening()) {
-        pClient->close();
+		return;
-    }
+	}
-    locker.unlock();
 
-    _wsServer->close();
+	_server.stop_listening();
+	for (connection_hdl hdl : _connections) {
+		_server.close(hdl, websocketpp::close::status::going_away, "Server stopping");
+	}
+	_connections.clear();
+	_connectionProperties.clear();
 
-    blog(LOG_INFO, "server stopped successfully");
+	_threadPool.waitForDone();
+
+	while (!_server.stopped()) {
+		std::this_thread::sleep_for(std::chrono::milliseconds(1));
+	}
+
+	blog(LOG_INFO, "server stopped successfully");
 }
 
-void WSServer::broadcast(QString message) {
+void WSServer::broadcast(const RpcEvent& event)
-    QMutexLocker locker(&_clMutex);
+{
-    for(QWebSocket* pClient : _clients) {
+	OBSRemoteProtocol protocol;
-        if (Config::Current()->AuthRequired
+	std::string message = protocol.encodeEvent(event);
-            && (pClient->property(PROP_AUTHENTICATED).toBool() == false)) {
+
-            // Skip this client if unauthenticated
+	if (GetConfig()->DebugEnabled) {
-            continue;
+		blog(LOG_INFO, "Update << '%s'", message.c_str());
-        }
+	}
-        pClient->sendTextMessage(message);
+
-    }
+	QMutexLocker locker(&_clMutex);
+	for (connection_hdl hdl : _connections) {
+		if (GetConfig()->AuthRequired) {
+			bool authenticated = _connectionProperties[hdl].isAuthenticated();
+			if (!authenticated) {
+				continue;
+			}
+		}
+
+		websocketpp::lib::error_code errorCode;
+		_server.send(hdl, message, websocketpp::frame::opcode::text, errorCode);
+
+		if (errorCode) {
+			std::string errorCodeMessage = errorCode.message();
+			blog(LOG_INFO, "server(broadcast): send failed: %s",
+				errorCodeMessage.c_str());
+		}
+	}
 }
 
-void WSServer::onNewConnection() {
+void WSServer::onOpen(connection_hdl hdl)
-    QWebSocket* pSocket = _wsServer->nextPendingConnection();
+{
-    if (pSocket) {
+	QMutexLocker locker(&_clMutex);
-        connect(pSocket, SIGNAL(textMessageReceived(const QString&)),
+	_connections.insert(hdl);
-            this, SLOT(onTextMessageReceived(QString)));
+	locker.unlock();
-        connect(pSocket, SIGNAL(disconnected()),
-            this, SLOT(onSocketDisconnected()));
 
-        pSocket->setProperty(PROP_AUTHENTICATED, false);
+	QString clientIp = getRemoteEndpoint(hdl);
-
+	notifyConnection(clientIp);
-        QMutexLocker locker(&_clMutex);
+	blog(LOG_INFO, "new client connection from %s", clientIp.toUtf8().constData());
-        _clients << pSocket;
-        locker.unlock();
-
-        QHostAddress clientAddr = pSocket->peerAddress();
-        QString clientIp = Utils::FormatIPAddress(clientAddr);
-
-        blog(LOG_INFO, "new client connection from %s:%d",
-            clientIp.toUtf8().constData(), pSocket->peerPort());
-
-        obs_frontend_push_ui_translation(obs_module_get_string);
-        QString title = tr("OBSWebsocket.NotifyConnect.Title");
-        QString msg = tr("OBSWebsocket.NotifyConnect.Message")
-            .arg(Utils::FormatIPAddress(clientAddr));
-        obs_frontend_pop_ui_translation();
-
-        Utils::SysTrayNotify(msg, QSystemTrayIcon::Information, title);
-    }
 }
 
-void WSServer::onTextMessageReceived(QString message) {
+void WSServer::onMessage(connection_hdl hdl, server::message_ptr message)
-    QWebSocket* pSocket = qobject_cast<QWebSocket*>(sender());
+{
-    if (pSocket) {
+	auto opcode = message->get_opcode();
-        WSRequestHandler handler(pSocket);
+	if (opcode != websocketpp::frame::opcode::text) {
-        handler.processIncomingMessage(message);
+		return;
-    }
+	}
+
+	QtConcurrent::run(&_threadPool, [=]() {
+		std::string payload = message->get_payload();
+
+		QMutexLocker locker(&_clMutex);
+		ConnectionProperties& connProperties = _connectionProperties[hdl];
+		locker.unlock();
+
+		if (GetConfig()->DebugEnabled) {
+			blog(LOG_INFO, "Request >> '%s'", payload.c_str());
+		}
+
+		WSRequestHandler requestHandler(connProperties);
+		OBSRemoteProtocol protocol;
+		std::string response = protocol.processMessage(requestHandler, payload);
+
+		if (GetConfig()->DebugEnabled) {
+			blog(LOG_INFO, "Response << '%s'", response.c_str());
+		}
+
+		websocketpp::lib::error_code errorCode;
+		_server.send(hdl, response, websocketpp::frame::opcode::text, errorCode);
+
+		if (errorCode) {
+			std::string errorCodeMessage = errorCode.message();
+			blog(LOG_INFO, "server(response): send failed: %s",
+				errorCodeMessage.c_str());
+		}
+	});
 }
 
-void WSServer::onSocketDisconnected() {
+void WSServer::onClose(connection_hdl hdl)
-    QWebSocket* pSocket = qobject_cast<QWebSocket*>(sender());
+{
-    if (pSocket) {
+	QMutexLocker locker(&_clMutex);
-        pSocket->setProperty(PROP_AUTHENTICATED, false);
+	_connections.erase(hdl);
+	_connectionProperties.erase(hdl);
+	locker.unlock();
 
-        QMutexLocker locker(&_clMutex);
+	auto conn = _server.get_con_from_hdl(hdl);
-        _clients.removeAll(pSocket);
+	auto localCloseCode = conn->get_local_close_code();
-        locker.unlock();
 
-        pSocket->deleteLater();
+	if (localCloseCode != websocketpp::close::status::going_away) {
-
+		QString clientIp = getRemoteEndpoint(hdl);
-        QHostAddress clientAddr = pSocket->peerAddress();
+		notifyDisconnection(clientIp);
-        QString clientIp = Utils::FormatIPAddress(clientAddr);
+		blog(LOG_INFO, "client %s disconnected", clientIp.toUtf8().constData());
-
+	}
-        blog(LOG_INFO, "client %s:%d disconnected",
+}
-            clientIp.toUtf8().constData(), pSocket->peerPort());
+
-
+QString WSServer::getRemoteEndpoint(connection_hdl hdl)
-        obs_frontend_push_ui_translation(obs_module_get_string);
+{
-        QString title = tr("OBSWebsocket.NotifyDisconnect.Title");
+	auto conn = _server.get_con_from_hdl(hdl);
-        QString msg = tr("OBSWebsocket.NotifyDisconnect.Message")
+	return QString::fromStdString(conn->get_remote_endpoint());
-            .arg(Utils::FormatIPAddress(clientAddr));
+}
-        obs_frontend_pop_ui_translation();
+
-
+void WSServer::notifyConnection(QString clientIp)
-        Utils::SysTrayNotify(msg, QSystemTrayIcon::Information, title);
+{
-    }
+	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

@@ -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,37 +16,54 @@ 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
+#pragma once
-#define WSSERVER_H
 
-#include <QObject>
+#include <map>
-#include <QList>
+#include <set>
-#include <QMutex>
+#include <QtCore/QObject>
+#include <QtCore/QMutex>
+#include <QtCore/QSharedPointer>
+#include <QtCore/QVariantHash>
+#include <QtCore/QThreadPool>
 
+#include <websocketpp/config/asio_no_tls.hpp>
+#include <websocketpp/server.hpp>
+
+#include "ConnectionProperties.h"
 #include "WSRequestHandler.h"
+#include "rpc/RpcEvent.h"
 
-QT_FORWARD_DECLARE_CLASS(QWebSocketServer)
+using websocketpp::connection_hdl;
-QT_FORWARD_DECLARE_CLASS(QWebSocket)
 
-class WSServer : public QObject {
+typedef websocketpp::server<websocketpp::config::asio> server;
-  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 slots:
+class WSServer : public QObject
-    void onNewConnection();
+{
-    void onTextMessageReceived(QString message);
+Q_OBJECT
-    void onSocketDisconnected();
 
-  private:
+public:
-    QWebSocketServer* _wsServer;
+	explicit WSServer();
-    QList<QWebSocket*> _clients;
+	virtual ~WSServer();
-    QMutex _clMutex;
+	void start(quint16 port);
+	void stop();
+	void broadcast(const RpcEvent& event);
+	QThreadPool* threadPool() {
+		return &_threadPool;
+	}
+
+private:
+	void onOpen(connection_hdl hdl);
+	void onMessage(connection_hdl hdl, server::message_ptr message);
+	void onClose(connection_hdl hdl);
+
+	QString getRemoteEndpoint(connection_hdl hdl);
+	void notifyConnection(QString clientIp);
+	void notifyDisconnection(QString clientIp);
+
+	server _server;
+	quint16 _serverPort;
+	std::set<connection_hdl, std::owner_less<connection_hdl>> _connections;
+	std::map<connection_hdl, ConnectionProperties, std::owner_less<connection_hdl>> _connectionProperties;
+	QMutex _clMutex;
+	QThreadPool _threadPool;
 };
-
-#endif // WSSERVER_H

src/forms/settings-dialog.cpp

@@ -26,79 +26,81 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 #define CHANGE_ME "changeme"
 
 SettingsDialog::SettingsDialog(QWidget* parent) :
-    QDialog(parent, Qt::Dialog),
+	QDialog(parent, Qt::Dialog),
-    ui(new Ui::SettingsDialog)
+	ui(new Ui::SettingsDialog)
 {
-    ui->setupUi(this);
+	ui->setupUi(this);
 
-    connect(ui->authRequired, &QCheckBox::stateChanged,
+	connect(ui->authRequired, &QCheckBox::stateChanged,
-        this, &SettingsDialog::AuthCheckboxChanged);
+		this, &SettingsDialog::AuthCheckboxChanged);
-    connect(ui->buttonBox, &QDialogButtonBox::accepted,
+	connect(ui->buttonBox, &QDialogButtonBox::accepted,
-        this, &SettingsDialog::FormAccepted);
+		this, &SettingsDialog::FormAccepted);
 
 
-    AuthCheckboxChanged();
+	AuthCheckboxChanged();
 }
 
 void SettingsDialog::showEvent(QShowEvent* event) {
-    Config* conf = Config::Current();
+	auto conf = GetConfig();
 
-    ui->serverEnabled->setChecked(conf->ServerEnabled);
+	ui->serverEnabled->setChecked(conf->ServerEnabled);
-    ui->serverPort->setValue(conf->ServerPort);
+	ui->serverPort->setValue(conf->ServerPort);
 
-    ui->debugEnabled->setChecked(conf->DebugEnabled);
+	ui->debugEnabled->setChecked(conf->DebugEnabled);
-    ui->alertsEnabled->setChecked(conf->AlertsEnabled);
+	ui->alertsEnabled->setChecked(conf->AlertsEnabled);
 
-    ui->authRequired->setChecked(conf->AuthRequired);
+	ui->authRequired->setChecked(conf->AuthRequired);
-    ui->password->setText(CHANGE_ME);
+	ui->password->setText(CHANGE_ME);
 }
 
 void SettingsDialog::ToggleShowHide() {
-    if (!isVisible())
+	if (!isVisible())
-        setVisible(true);
+		setVisible(true);
-    else
+	else
-        setVisible(false);
+		setVisible(false);
 }
 
 void SettingsDialog::AuthCheckboxChanged() {
-    if (ui->authRequired->isChecked())
+	if (ui->authRequired->isChecked())
-        ui->password->setEnabled(true);
+		ui->password->setEnabled(true);
-    else
+	else
-        ui->password->setEnabled(false);
+		ui->password->setEnabled(false);
 }
 
 void SettingsDialog::FormAccepted() {
-    Config* conf = Config::Current();
+	auto conf = GetConfig();
 
-    conf->ServerEnabled = ui->serverEnabled->isChecked();
+	conf->ServerEnabled = ui->serverEnabled->isChecked();
-    conf->ServerPort = ui->serverPort->value();
+	conf->ServerPort = ui->serverPort->value();
 
-    conf->DebugEnabled = ui->debugEnabled->isChecked();
+	conf->DebugEnabled = ui->debugEnabled->isChecked();
-    conf->AlertsEnabled = ui->alertsEnabled->isChecked();
+	conf->AlertsEnabled = ui->alertsEnabled->isChecked();
 
-    if (ui->authRequired->isChecked()) {
+	if (ui->authRequired->isChecked()) {
-        if (ui->password->text() != CHANGE_ME) {
+		if (ui->password->text() != CHANGE_ME) {
-            conf->SetPassword(ui->password->text());
+			conf->SetPassword(ui->password->text());
-        }
+		}
 
-        if (!Config::Current()->Secret.isEmpty())
+		if (!GetConfig()->Secret.isEmpty())
-            conf->AuthRequired = true;
+			conf->AuthRequired = true;
-        else
+		else
-            conf->AuthRequired = false;
+			conf->AuthRequired = false;
-    }
+	}
-    else
+	else
-    {
+	{
-        conf->AuthRequired = false;
+		conf->AuthRequired = false;
-    }
+	}
 
-    conf->Save();
+	conf->Save();
 
-    if (conf->ServerEnabled)
+	auto server = GetServer();
-        WSServer::Instance->Start(conf->ServerPort);
+	if (conf->ServerEnabled) {
-    else
+		server->start(conf->ServerPort);
-        WSServer::Instance->Stop();
+	} else {
+		server->stop();
+	}
 }
 
 SettingsDialog::~SettingsDialog() {
-    delete ui;
+	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,29 +16,26 @@ 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
+#pragma once
-#define SETTINGSDIALOG_H
 
-#include <QDialog>
+#include <QtWidgets/QDialog>
 
 #include "ui_settings-dialog.h"
 
 class SettingsDialog : public QDialog
 {
-    Q_OBJECT
+	Q_OBJECT
 
 public:
-    explicit SettingsDialog(QWidget* parent = 0);
+	explicit SettingsDialog(QWidget* parent = 0);
-    ~SettingsDialog();
+	~SettingsDialog();
-    void showEvent(QShowEvent* event);
+	void showEvent(QShowEvent* event);
-    void ToggleShowHide();
+	void ToggleShowHide();
 
 private Q_SLOTS:
-    void AuthCheckboxChanged();
+	void AuthCheckboxChanged();
-    void FormAccepted();
+	void FormAccepted();
 
 private:
-    Ui::SettingsDialog* ui;
+	Ui::SettingsDialog* ui;
 };
-
-#endif // SETTINGSDIALOG_H

src/forms/settings-dialog.ui

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

src/obs-websocket.cpp

@@ -18,9 +18,11 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 #include <obs-module.h>
 #include <obs-frontend-api.h>
-#include <QAction>
+#include <obs-data.h>
-#include <QMainWindow>
+
-#include <QTimer>
+#include <QtCore/QTimer>
+#include <QtWidgets/QAction>
+#include <QtWidgets/QMainWindow>
 
 #include "obs-websocket.h"
 #include "WSServer.h"
@@ -34,47 +36,82 @@ void ___data_dummy_addref(obs_data_t*) {}
 void ___data_array_dummy_addref(obs_data_array_t*) {}
 void ___output_dummy_addref(obs_output_t*) {}
 
+void ___data_item_dummy_addref(obs_data_item_t*) {}
+void ___data_item_release(obs_data_item_t* dataItem) {
+	obs_data_item_release(&dataItem);
+}
+
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("obs-websocket", "en-US")
 
-SettingsDialog* settings_dialog;
+ConfigPtr _config;
+WSServerPtr _server;
+WSEventsPtr _eventsSystem;
 
 bool obs_module_load(void) {
-    blog(LOG_INFO, "you can haz websockets (version %s)", OBS_WEBSOCKET_VERSION);
+	blog(LOG_INFO, "you can haz websockets (version %s)", OBS_WEBSOCKET_VERSION);
-    blog(LOG_INFO, "qt version (compile-time): %s ; qt version (run-time): %s",
+	blog(LOG_INFO, "qt version (compile-time): %s ; qt version (run-time): %s",
-        QT_VERSION_STR, qVersion());
+		QT_VERSION_STR, qVersion());
 
-    // Core setup
+	// Core setup
-    Config* config = Config::Current();
+	_config = ConfigPtr(new Config());
-    config->Load();
+	_config->MigrateFromGlobalSettings(); // TODO remove this on the next minor jump
+	_config->Load();
 
-    WSServer::Instance = new WSServer();
+	_server = WSServerPtr(new WSServer());
-    WSEvents::Instance = new WSEvents(WSServer::Instance);
+	_eventsSystem = WSEventsPtr(new WSEvents(_server));
 
-    if (config->ServerEnabled)
+	// UI setup
-        WSServer::Instance->Start(config->ServerPort);
+	obs_frontend_push_ui_translation(obs_module_get_string);
+	QMainWindow* mainWindow = (QMainWindow*)obs_frontend_get_main_window();
+	SettingsDialog* settingsDialog = new SettingsDialog(mainWindow);
+	obs_frontend_pop_ui_translation();
 
-    // UI setup
+	const char* menuActionText =
-    QAction* menu_action = (QAction*)obs_frontend_add_tools_menu_qaction(
+		obs_module_text("OBSWebsocket.Settings.DialogTitle");
-        obs_module_text("OBSWebsocket.Menu.SettingsItem"));
+	QAction* menuAction =
+		(QAction*)obs_frontend_add_tools_menu_qaction(menuActionText);
+	QObject::connect(menuAction, &QAction::triggered, [settingsDialog] {
+		// The settings dialog belongs to the main window. Should be ok
+		// to pass the pointer to this QAction belonging to the main window
+		settingsDialog->ToggleShowHide();
+	});
 
-    obs_frontend_push_ui_translation(obs_module_get_string);
+	// Setup event handler to start the server once OBS is ready
-    QMainWindow* main_window = (QMainWindow*)obs_frontend_get_main_window();
+	auto eventCallback = [](enum obs_frontend_event event, void *param) {
-    settings_dialog = new SettingsDialog(main_window);
+		if (event == OBS_FRONTEND_EVENT_FINISHED_LOADING) {
-    obs_frontend_pop_ui_translation();
+			if (_config->ServerEnabled) {
+				_server->start(_config->ServerPort);
+			}
+			obs_frontend_remove_event_callback((obs_frontend_event_cb)param, nullptr);
+		}
+	};
+	obs_frontend_add_event_callback(eventCallback, (void*)(obs_frontend_event_cb)eventCallback);
 
-    auto menu_cb = [] {
+	// Loading finished
-        settings_dialog->ToggleShowHide();
+	blog(LOG_INFO, "module loaded!");
-    };
-    menu_action->connect(menu_action, &QAction::triggered, menu_cb);
 
-    // Loading finished
+	return true;
-    blog(LOG_INFO, "module loaded!");
-
-    return true;
 }
 
 void obs_module_unload() {
-    blog(LOG_INFO, "goodbye!");
+	_server->stop();
+
+	_eventsSystem.reset();
+	_server.reset();
+	_config.reset();
+
+	blog(LOG_INFO, "goodbye!");
 }
 
+ConfigPtr GetConfig() {
+	return _config;
+}
+
+WSServerPtr GetServer() {
+	return _server;
+}
+
+WSEventsPtr GetEventsSystem() {
+	return _eventsSystem;
+}

src/obs-websocket.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,10 +16,10 @@ 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
+#pragma once
-#define OBSWEBSOCKET_H
 
 #include <obs.hpp>
+#include <memory>
 
 void ___source_dummy_addref(obs_source_t*);
 void ___sceneitem_dummy_addref(obs_sceneitem_t*);
@@ -38,9 +38,24 @@ using OBSDataArrayAutoRelease =
 using OBSOutputAutoRelease =
 	OBSRef<obs_output_t*, ___output_dummy_addref, obs_output_release>;
 
-#define PROP_AUTHENTICATED "wsclient_authenticated"
+void ___data_item_dummy_addref(obs_data_item_t*);
-#define OBS_WEBSOCKET_VERSION "4.3.3"
+void ___data_item_release(obs_data_item_t*);
+using OBSDataItemAutoRelease =
+	OBSRef<obs_data_item_t*, ___data_item_dummy_addref, ___data_item_release>;
+
+class Config;
+typedef std::shared_ptr<Config> ConfigPtr;
+
+class WSServer;
+typedef std::shared_ptr<WSServer> WSServerPtr;
+
+class WSEvents;
+typedef std::shared_ptr<WSEvents> WSEventsPtr;
+
+ConfigPtr GetConfig();
+WSServerPtr GetServer();
+WSEventsPtr GetEventsSystem();
+
+#define OBS_WEBSOCKET_VERSION "4.8.0"
 
 #define blog(level, msg, ...) blog(level, "[obs-websocket] " msg, ##__VA_ARGS__)
-
-#endif // OBSWEBSOCKET_H

src/protocol/OBSRemoteProtocol.cpp

@@ -0,0 +1,119 @@
+/*
+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 <inttypes.h>
+
+#include "OBSRemoteProtocol.h"
+#include "../WSRequestHandler.h"
+#include "../rpc/RpcEvent.h"
+#include "../Utils.h"
+
+std::string OBSRemoteProtocol::processMessage(WSRequestHandler& requestHandler, std::string message)
+{
+	std::string msgContainer(message);
+	const char* msg = msgContainer.c_str();
+
+	OBSDataAutoRelease data = obs_data_create_from_json(msg);
+	if (!data) {
+		blog(LOG_ERROR, "invalid JSON payload received for '%s'", msg);
+		return errorResponse(QString::Null(), "invalid JSON payload");
+	}
+
+	if (!obs_data_has_user_value(data, "request-type") || !obs_data_has_user_value(data, "message-id")) {
+		return errorResponse(QString::Null(), "missing request parameters");
+	}
+
+	QString methodName = obs_data_get_string(data, "request-type");
+	QString messageId = obs_data_get_string(data, "message-id");
+
+	OBSDataAutoRelease params = obs_data_create();
+	obs_data_apply(params, data);
+	obs_data_unset_user_value(params, "request-type");
+	obs_data_unset_user_value(params, "message-id");
+
+	RpcRequest request(messageId, methodName, params);
+	RpcResponse response = requestHandler.processRequest(request);
+
+	OBSData additionalFields = response.additionalFields();
+	switch (response.status()) {
+		case RpcResponse::Status::Ok:
+			return successResponse(messageId, additionalFields);
+		case RpcResponse::Status::Error:
+			return errorResponse(messageId, response.errorMessage(), additionalFields);
+	}
+
+	return std::string();
+}
+
+std::string OBSRemoteProtocol::encodeEvent(const RpcEvent& event)
+{
+	OBSDataAutoRelease eventData = obs_data_create();
+
+	QString updateType = event.updateType();
+	obs_data_set_string(eventData, "update-type", updateType.toUtf8().constData());
+
+	std::optional<uint64_t> streamTime = event.streamTime();
+	if (streamTime.has_value()) {
+		QString streamingTimecode = Utils::nsToTimestamp(streamTime.value());
+		obs_data_set_string(eventData, "stream-timecode", streamingTimecode.toUtf8().constData());
+	}
+
+	std::optional<uint64_t> recordingTime = event.recordingTime();
+	if (recordingTime.has_value()) {
+		QString recordingTimecode = Utils::nsToTimestamp(recordingTime.value());
+		obs_data_set_string(eventData, "rec-timecode", recordingTimecode.toUtf8().constData());
+	}
+
+	OBSData additionalFields = event.additionalFields();
+	if (additionalFields) {
+		obs_data_apply(eventData, additionalFields);
+	}
+
+	return std::string(obs_data_get_json(eventData));
+}
+
+std::string OBSRemoteProtocol::buildResponse(QString messageId, QString status, obs_data_t* fields)
+{
+	OBSDataAutoRelease response = obs_data_create();
+	if (!messageId.isNull()) {
+		obs_data_set_string(response, "message-id", messageId.toUtf8().constData());
+	}
+	obs_data_set_string(response, "status", status.toUtf8().constData());
+
+	if (fields) {
+		obs_data_apply(response, fields);
+	}
+
+	std::string responseString = obs_data_get_json(response);
+	return responseString;
+}
+
+std::string OBSRemoteProtocol::successResponse(QString messageId, obs_data_t* fields)
+{
+	return buildResponse(messageId, "ok", fields);
+}
+
+std::string OBSRemoteProtocol::errorResponse(QString messageId, QString errorMessage, obs_data_t* additionalFields)
+{
+	OBSDataAutoRelease fields = obs_data_create();
+	if (additionalFields) {
+		obs_data_apply(fields, additionalFields);
+	}
+	obs_data_set_string(fields, "error", errorMessage.toUtf8().constData());
+	return buildResponse(messageId, "error", fields);
+}

src/protocol/OBSRemoteProtocol.h

@@ -0,0 +1,38 @@
+/*
+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 <string>
+#include <obs-data.h>
+#include <QtCore/QString>
+
+class WSRequestHandler;
+class RpcEvent;
+
+class OBSRemoteProtocol
+{
+public:
+	std::string processMessage(WSRequestHandler& requestHandler, std::string message);
+	std::string encodeEvent(const RpcEvent& event);
+
+private:
+	std::string buildResponse(QString messageId, QString status, obs_data_t* fields = nullptr);
+	std::string successResponse(QString messageId, obs_data_t* fields = nullptr);
+	std::string errorResponse(QString messageId, QString errorMessage, obs_data_t* additionalFields = nullptr);
+};

src/rpc/RpcEvent.cpp

@@ -0,0 +1,35 @@
+/*
+obs-websocket
+Copyright (C) 2016-2020	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 "RpcEvent.h"
+
+RpcEvent::RpcEvent(
+	const QString& updateType,
+	std::optional<uint64_t> streamTime, std::optional<uint64_t> recordingTime,
+	obs_data_t* additionalFields
+) :
+	_updateType(updateType),
+	_streamTime(streamTime),
+	_recordingTime(recordingTime),
+	_additionalFields(nullptr)
+{
+	if (additionalFields) {
+		_additionalFields = obs_data_create();
+		obs_data_apply(_additionalFields, additionalFields);
+	}
+}

src/rpc/RpcEvent.h

@@ -0,0 +1,61 @@
+/*
+obs-websocket
+Copyright (C) 2016-2020	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 <optional>
+#include <obs-data.h>
+#include <QtCore/QString>
+
+#include "../obs-websocket.h"
+
+class RpcEvent
+{
+public:
+	explicit RpcEvent(
+		const QString& updateType,
+		std::optional<uint64_t> streamTime, std::optional<uint64_t> recordingTime,
+		obs_data_t* additionalFields = nullptr
+	);
+
+	const QString& updateType() const
+	{
+		return _updateType;
+	}
+
+	const std::optional<uint64_t> streamTime() const
+	{
+		return _streamTime;
+	}
+
+	const std::optional<uint64_t> recordingTime() const
+	{
+		return _recordingTime;
+	}
+
+	const OBSData additionalFields() const
+	{
+		return OBSData(_additionalFields);
+	}
+
+private:
+	QString _updateType;
+	std::optional<uint64_t> _streamTime;
+	std::optional<uint64_t> _recordingTime;
+	OBSDataAutoRelease _additionalFields;
+};

src/rpc/RpcRequest.cpp

@@ -0,0 +1,104 @@
+/*
+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 "RpcRequest.h"
+#include "RpcResponse.h"
+
+RpcRequest::RpcRequest(const QString& messageId, const QString& methodName, obs_data_t* params) :
+	_messageId(messageId),
+	_methodName(methodName),
+	_parameters(nullptr)
+{
+	if (params) {
+		_parameters = obs_data_create();
+		obs_data_apply(_parameters, params);
+	}
+}
+
+const RpcResponse RpcRequest::success(obs_data_t* additionalFields) const
+{
+	return RpcResponse::ok(*this, additionalFields);
+}
+
+const RpcResponse RpcRequest::failed(const QString& errorMessage, obs_data_t* additionalFields) const
+{
+	return RpcResponse::fail(*this, errorMessage, additionalFields);
+}
+
+const bool RpcRequest::hasField(QString name, obs_data_type expectedFieldType, obs_data_number_type expectedNumberType) const
+{
+	if (!_parameters || name.isEmpty() || name.isNull()) {
+		return false;
+	}
+
+	OBSDataItemAutoRelease dataItem = obs_data_item_byname(_parameters, name.toUtf8());
+	if (!dataItem) {
+		return false;
+	}
+
+	if (expectedFieldType != OBS_DATA_NULL) {
+		obs_data_type fieldType = obs_data_item_gettype(dataItem);
+		if (fieldType != expectedFieldType) {
+			return false;
+		}
+
+		if (fieldType == OBS_DATA_NUMBER && expectedNumberType != OBS_DATA_NUM_INVALID) {
+			obs_data_number_type numberType = obs_data_item_numtype(dataItem);
+			if (numberType != expectedNumberType) {
+				return false;
+			}
+		}
+	}
+
+	return true;
+}
+
+const bool RpcRequest::hasBool(QString fieldName) const
+{
+	return this->hasField(fieldName, OBS_DATA_BOOLEAN);
+}
+
+const bool RpcRequest::hasString(QString fieldName) const
+{
+	return this->hasField(fieldName, OBS_DATA_STRING);
+}
+
+const bool RpcRequest::hasNumber(QString fieldName, obs_data_number_type expectedNumberType) const
+{
+	return this->hasField(fieldName, OBS_DATA_NUMBER, expectedNumberType);
+}
+
+const bool RpcRequest::hasInteger(QString fieldName) const
+{
+	return this->hasNumber(fieldName, OBS_DATA_NUM_INT);
+}
+
+const bool RpcRequest::hasDouble(QString fieldName) const
+{
+	return this->hasNumber(fieldName, OBS_DATA_NUM_DOUBLE);
+}
+
+const bool RpcRequest::hasArray(QString fieldName) const
+{
+	return this->hasField(fieldName, OBS_DATA_ARRAY);
+}
+
+const bool RpcRequest::hasObject(QString fieldName) const
+{
+	return this->hasField(fieldName, OBS_DATA_OBJECT);
+}

src/rpc/RpcRequest.h

@@ -0,0 +1,65 @@
+/*
+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 <obs-data.h>
+#include <QtCore/QString>
+#include "../obs-websocket.h"
+
+// forward declarations
+class RpcResponse;
+
+class RpcRequest
+{
+public:
+	explicit RpcRequest(const QString& messageId, const QString& methodName, obs_data_t* params);
+	
+	const QString& messageId() const
+	{
+		return _messageId;
+	}
+		
+	const QString& methodName() const
+	{
+		return _methodName;
+	}
+
+	const OBSData parameters() const
+	{
+		return OBSData(_parameters);
+	}
+
+	const RpcResponse success(obs_data_t* additionalFields = nullptr) const;
+	const RpcResponse failed(const QString& errorMessage, obs_data_t* additionalFields = nullptr) const;
+
+	const bool hasField(QString fieldName, obs_data_type expectedFieldType = OBS_DATA_NULL,
+					obs_data_number_type expectedNumberType = OBS_DATA_NUM_INVALID) const;
+	const bool hasBool(QString fieldName) const;
+	const bool hasString(QString fieldName) const;
+	const bool hasNumber(QString fieldName, obs_data_number_type expectedNumberType = OBS_DATA_NUM_INVALID) const;
+	const bool hasInteger(QString fieldName) const;
+	const bool hasDouble(QString fieldName) const;
+	const bool hasArray(QString fieldName) const;
+	const bool hasObject(QString fieldName) const;
+
+private:
+	const QString _messageId;
+	const QString _methodName;
+	OBSDataAutoRelease _parameters;
+};

src/rpc/RpcResponse.cpp

@@ -0,0 +1,48 @@
+/*
+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 "RpcResponse.h"
+#include "RpcRequest.h"
+
+RpcResponse::RpcResponse(
+	Status status, const QString& messageId,
+	const QString& methodName, obs_data_t* additionalFields
+) :
+	_status(status),
+	_messageId(messageId),
+	_methodName(methodName),
+	_additionalFields(nullptr)
+{
+	if (additionalFields) {
+		_additionalFields = obs_data_create();
+		obs_data_apply(_additionalFields, additionalFields);
+	}
+}
+
+const RpcResponse RpcResponse::ok(const RpcRequest& request, obs_data_t* additionalFields)
+{
+	RpcResponse response(Status::Ok, request.messageId(), request.methodName(), additionalFields);
+	return response;
+} 
+
+const RpcResponse RpcResponse::fail(const RpcRequest& request, const QString& errorMessage, obs_data_t* additionalFields)
+{
+	RpcResponse response(Status::Error, request.messageId(), request.methodName(), additionalFields);
+	response._errorMessage = errorMessage;
+	return response;
+}

src/rpc/RpcResponse.h

@@ -0,0 +1,70 @@
+/*
+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 <obs-data.h>
+#include <QtCore/QString>
+#include "../obs-websocket.h"
+
+class RpcRequest;
+
+class RpcResponse
+{
+public:
+	enum Status { Unknown, Ok, Error };
+
+	static RpcResponse ofRequest(const RpcRequest& request);
+	static const RpcResponse ok(const RpcRequest& request, obs_data_t* additionalFields = nullptr);
+	static const RpcResponse fail(
+		const RpcRequest& request, const QString& errorMessage,
+		obs_data_t* additionalFields = nullptr
+	);
+
+	Status status() {
+		return _status;
+	}
+
+	const QString& messageId() const {
+		return _messageId;
+	}
+	
+	const QString& methodName() const {
+		return _methodName;
+	}
+
+	const QString& errorMessage() const {
+		return _errorMessage;
+	}
+	
+	const OBSData additionalFields() const {
+		return OBSData(_additionalFields);
+	}
+
+private:
+	explicit RpcResponse(
+		Status status,
+		const QString& messageId, const QString& methodName,
+		obs_data_t* additionalFields = nullptr
+	);
+	const Status _status;
+	const QString _messageId;
+	const QString _methodName;
+	QString _errorMessage;
+	OBSDataAutoRelease _additionalFields;
+};