Merge pull request #330 from Palakis/transitionbegin-hotfix

Fix TransitionBegin event

.editorconfig

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

.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

@@ -32,16 +32,6 @@ matrix:
     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"
-    - "./CI/install-build-obs-macos.sh"
-    script: "./CI/build-macos.sh"
-    after_success: 
-    - ./CI/package-macos.sh
-
 deploy:
 - provider: s3
   region: eu-central-1
@@ -57,15 +47,3 @@ deploy:
     - "$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,21 +1,26 @@
 # Compiling obs-websocket
+
 ## Prerequisites
+
 You'll need [Qt 5.10.x](https://download.qt.io/official_releases/qt/5.10/),
-[CMake](https://cmake.org/download/), and a working [development environment for
+[CMake](https://cmake.org/download/), [Boost](https://www.boost.org/) and a working [OBS Studio development environment](https://obsproject.com/wiki/install-instructions) installed on your
-OBS Studio](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
@@ -25,7 +30,8 @@ sudo make install
 ```
 
 ## OS X
-As a prerequisite, you will need Xcode for your current OSX version, the command line tools, and [Homebrew](https://brew.sh/).
+
+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
@@ -38,7 +44,7 @@ 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
@@ -46,8 +52,11 @@ cd obs-websocket
 ./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,14 +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)"
 
+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_BUILD_TYPE=RelWithDebInfo \
+	-DCMAKE_BUILD_TYPE=RelWithDebInfo \
-  -DCMAKE_INSTALL_PREFIX=/usr \
+	-DCMAKE_INSTALL_PREFIX=/usr \
 && make -j4

CI/generate-docs.sh

@@ -11,13 +11,13 @@ 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" != "4.3-maintenance" ]; then
+if [ "$TRAVIS_PULL_REQUEST" != "false" -o "$TRAVIS_BRANCH" != "4.x-current" ]; then
-    echo "-- Skipping documentation deployment because this is either a pull request or a non-master branch."
+	echo "-- Skipping documentation deployment because this is either a pull request or a non-master branch."
-    exit 0
+	exit 0
 fi
 
 REMOTE_URL="$(git config remote.origin.url)"

CI/install-build-obs-macos.sh

@@ -1,14 +1,43 @@
 #!/bin/sh
-set -ex
+
+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 .. \
-  -DDISABLE_PLUGINS=true \
+	-DBUILD_CAPTIONS=true \
-  -DCMAKE_PREFIX_PATH=/usr/local/opt/qt/lib/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

@@ -19,63 +19,63 @@ 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
+	set /p OBSLastTagBuilt=<C:\projects\obs-studio-last-tag-built.txt
 ) else (
-  set OBSLastTagBuilt=0
+	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 obs-studio directory exists
-  echo   Updating tag info
+	echo   Updating tag info
-  cd C:\projects\obs-studio\
+	cd C:\projects\obs-studio\
-  git describe --tags --abbrev=0 > C:\projects\latest-obs-studio-tag-pre-pull.txt
+	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
+	set /p OBSLatestTagPrePull=<C:\projects\latest-obs-studio-tag-pre-pull.txt
-  git checkout master
+	git checkout master
-  git pull
+	git pull
-  git describe --tags --abbrev=0 > C:\projects\latest-obs-studio-tag-post-pull.txt
+	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 OBSLatestTagPostPull=<C:\projects\latest-obs-studio-tag-post-pull.txt
-  set /p OBSLatestTag=<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
+	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 pre-pull: %OBSLatestTagPrePull%
-  echo Latest tag post-pull: %OBSLatestTagPostPull%
+	echo Latest tag post-pull: %OBSLatestTagPostPull%
-  echo Tags do not match.  Need to rebuild OBS.
+	echo Tags do not match.  Need to rebuild OBS.
-  set BuildOBS=true
+	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 Last built OBS tag: %OBSLastTagBuilt%
-  echo Latest tag post-pull: %OBSLatestTagPostPull%
+	echo Latest tag post-pull: %OBSLatestTagPostPull%
-  echo Tags do not match.  Need to rebuild OBS.
+	echo Tags do not match.  Need to rebuild OBS.
-  set BuildOBS=true
+	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
+	echo obs-studio directory does not exist
-  git clone https://github.com/obsproject/obs-studio
+	git clone https://github.com/obsproject/obs-studio
-  cd C:\projects\obs-studio\
+	cd C:\projects\obs-studio\
-  git describe --tags --abbrev=0 > C:\projects\obs-studio-latest-tag.txt
+	git describe --tags --abbrev=0 > C:\projects\obs-studio-latest-tag.txt
-  set /p OBSLatestTag=<C:\projects\obs-studio-latest-tag.txt
+	set /p OBSLatestTag=<C:\projects\obs-studio-latest-tag.txt
-  set BuildOBS=true
+	set BuildOBS=true
 )
 
 REM If the needed obs-studio libs for this build_config do not exist,
 REM set the build flag.
 if not exist C:\projects\obs-studio\build32\libobs\%build_config%\obs.lib (
-  echo obs-studio\build32\libobs\%build_config%\obs.lib does not exist
+	echo obs-studio\build32\libobs\%build_config%\obs.lib does not exist
-  set BuildOBS=true
+	set BuildOBS=true
 )
 if not exist C:\projects\obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib (
-  echo obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib does not exist
+	echo obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib does not exist
-  set BuildOBS=true
+	set BuildOBS=true
 )
 
 REM Some debug info
@@ -86,44 +86,44 @@ echo Latest tag: %OBSLatestTag%
 echo Last built OBS tag: %OBSLastTagBuilt%
 
 if defined BuildOBS (
-  echo BuildOBS: true
+	echo BuildOBS: true
 ) else (
-  echo BuildOBS: false
+	echo BuildOBS: false
 )
 echo:
 
 REM If the build flag is set, build obs-studio.
 if defined BuildOBS (
-  echo Building obs-studio...
+	echo Building obs-studio...
-  echo   git checkout %OBSLatestTag%
+	echo   git checkout %OBSLatestTag%
-  git checkout %OBSLatestTag%
+	git checkout %OBSLatestTag%
-  echo:
+	echo:
-  echo   Removing previous build dirs...
+	echo   Removing previous build dirs...
-  if exist build rmdir /s /q C:\projects\obs-studio\build
+	if exist build rmdir /s /q C:\projects\obs-studio\build
-  if exist build32 rmdir /s /q C:\projects\obs-studio\build32
+	if exist build32 rmdir /s /q C:\projects\obs-studio\build32
-  if exist build64 rmdir /s /q C:\projects\obs-studio\build64
+	if exist build64 rmdir /s /q C:\projects\obs-studio\build64
-  echo   Making new build dirs...
+	echo   Making new build dirs...
-  mkdir build
+	mkdir build
-  mkdir build32
+	mkdir build32
-  mkdir build64
+	mkdir build64
-  echo   Running cmake for obs-studio %OBSLatestTag% 32-bit...
+	echo   Running cmake for obs-studio %OBSLatestTag% 32-bit...
-  cd ./build32
+	cd ./build32
-  cmake -G "Visual Studio 15 2017" -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
+	cmake -G "Visual Studio 14 2015" -DBUILD_CAPTIONS=true -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
-  echo:
+	echo:
-  echo:
+	echo:
-  echo   Running cmake for obs-studio %OBSLatestTag% 64-bit...
+	echo   Running cmake for obs-studio %OBSLatestTag% 64-bit...
-  cd ../build64
+	cd ../build64
-  cmake -G "Visual Studio 15 2017 Win64" -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
+	cmake -G "Visual Studio 14 2015 Win64" -DBUILD_CAPTIONS=true -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
-  echo:
+	echo:
-  echo:
+	echo:
-  echo   Building obs-studio %OBSLatestTag% 32-bit ^(Build Config: %build_config%^)...
+	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"
+	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%^)...
+	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"
+	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 ..
+	cd ..
-  git describe --tags --abbrev=0 > C:\projects\obs-studio-last-tag-built.txt
+	git describe --tags --abbrev=0 > C:\projects\obs-studio-last-tag-built.txt
-  set /p OBSLastTagBuilt=<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 Last OBS tag built is:  %OBSLastTagBuilt%
-  echo No need to rebuild OBS.
+	echo No need to rebuild OBS.
 )

CI/install-dependencies-macos.sh

@@ -1,15 +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 =!=
 
-# Packages app
+brew install https://gist.githubusercontent.com/DDRBoxman/b3956fab6073335a4bf151db0dcbd4ad/raw/ed1342a8a86793ea8c10d8b4d712a654da121ace/qt.rb
-wget --quiet --retry-connrefused --waitretry=1 https://s3-us-west-2.amazonaws.com/obs-nightly/Packages.pkg
+
-sudo installer -pkg ./Packages.pkg -target /
+# Pin this version of QT5 to avoid `brew upgrade`
+# upgrading it to incompatible version
+brew pin qt
+
+# Fetch and install Packages app
+# =!= NOTICE =!=
+# Installs a LaunchDaemon under /Library/LaunchDaemons/fr.whitebox.packages.build.dispatcher.plist
+# =!= NOTICE =!=
+
+HAS_PACKAGES=$(type packagesbuild 2>/dev/null)
+
+if [ "${HAS_PACKAGES}" = "" ]; then
+    echo "[obs-websocket] Installing Packaging app (might require password due to 'sudo').."
+    curl -o './Packages.pkg' --retry-connrefused -s --retry-delay 1 'https://s3-us-west-2.amazonaws.com/obs-nightly/Packages.pkg'
+    sudo installer -pkg ./Packages.pkg -target /
+fi

CI/install-dependencies-xenial.sh

@@ -11,7 +11,7 @@ apt-get install -y \
 	checkinstall \
 	cmake \
 	obs-studio \
-	libqt5websockets5-dev
+	qtbase5-dev
 
 # Dirty hack
 wget -O /usr/include/obs/obs-frontend-api.h https://raw.githubusercontent.com/obsproject/obs-studio/master/UI/obs-frontend-api/obs-frontend-api.h

CI/install-setup-qt.cmd

@@ -2,5 +2,5 @@
 
 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\msvc2017_64
+set QTDIR64=C:\Qt\5.10.1\msvc2015_64
 set QTCompileVersion=5.10.1

CI/macos/obs-websocket.pkgproj

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

CI/macos/qt.rb

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

CI/package-macos.sh

@@ -2,67 +2,39 @@
 
 set -e
 
-echo "-- Preparing package build"
+OSTYPE=$(uname)
-export QT_CELLAR_PREFIX="$(find /usr/local/Cellar/qt -d 1 | sort -t '.' -k 1,1n -k 2,2n -k 3,3n | 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
+fi
+
+echo "[obs-websocket] Preparing package build"
+export QT_CELLAR_PREFIX="$(/usr/bin/find /usr/local/Cellar/qt -d 1 | sort -t '.' -k 1,1n -k 2,2n -k 3,3n | tail -n 1)"
 
 export GIT_HASH=$(git rev-parse --short HEAD)
+export GIT_BRANCH_OR_TAG=$(git name-rev --name-only HEAD | awk -F/ '{print $NF}')
 
-export VERSION="$GIT_HASH-$TRAVIS_BRANCH"
+export VERSION="$GIT_HASH-$GIT_BRANCH_OR_TAG"
-export LATEST_VERSION="$TRAVIS_BRANCH"
+export LATEST_VERSION="$GIT_BRANCH_OR_TAG"
-if [ -n "${TRAVIS_TAG}" ]; then
-	export VERSION="$TRAVIS_TAG"
-	export LATEST_VERSION="$TRAVIS_TAG"
-fi
 
 export FILENAME="obs-websocket-$VERSION.pkg"
 export LATEST_FILENAME="obs-websocket-latest-$LATEST_VERSION.pkg"
 
-echo "-- Copying Qt dependencies"
+echo "[obs-websocket] Modifying obs-websocket.so"
-if [ ! -f ./build/$(basename $WS_LIB) ]; then cp $WS_LIB ./build; fi
-if [ ! -f ./build/$(basename $NET_LIB) ]; then cp $NET_LIB ./build; fi
-
-chmod +rw ./build/QtWebSockets ./build/QtNetwork
-
-echo "-- Modifying QtNetwork"
 install_name_tool \
-	-id @rpath/QtNetwork \
-	-change /usr/local/opt/qt/lib/QtNetwork.framework/Versions/5/QtNetwork @rpath/QtNetwork \
-	-change $QT_CELLAR_PREFIX/lib/QtCore.framework/Versions/5/QtCore @rpath/QtCore \
-	./build/QtNetwork
-
-echo "-- Modifying QtWebSockets"
-install_name_tool \
-	-id @rpath/QtWebSockets \
-	-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
+echo "[obs-websocket] Actual package build"
-
-echo "-- 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
 cp ./release/$FILENAME ./release/$LATEST_FILENAME

CI/package-xenial.sh

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

CMakeLists.txt

@@ -6,21 +6,30 @@ set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTOUIC ON)
 
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
 if (WIN32 OR APPLE)
 include(external/FindLibObs.cmake)
 endif()
 
+add_definitions(-DASIO_STANDALONE)
+
+if (UNIX)
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+endif()
+
+if (WIN32 OR APPLE)
+	include(external/FindLibObs.cmake)
+endif()
+
 find_package(LibObs REQUIRED)
 find_package(Qt5Core REQUIRED)
-find_package(Qt5WebSockets REQUIRED)
 find_package(Qt5Widgets REQUIRED)
 
-add_subdirectory(deps/mbedtls EXCLUDE_FROM_ALL)
-set(ENABLE_PROGRAMS false)
-
 set(obs-websocket_SOURCES
 	src/obs-websocket.cpp
 	src/WSServer.cpp
+	src/ConnectionProperties.cpp
 	src/WSRequestHandler.cpp
 	src/WSRequestHandler_General.cpp
 	src/WSRequestHandler_Profiles.cpp
@@ -41,6 +50,7 @@ set(obs-websocket_SOURCES
 set(obs-websocket_HEADERS
 	src/obs-websocket.h
 	src/WSServer.h
+	src/ConnectionProperties.h
 	src/WSRequestHandler.h
 	src/WSEvents.h
 	src/Config.h
@@ -52,22 +62,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 ---
 
@@ -78,6 +83,8 @@ if(WIN32)
 		message(FATAL_ERROR "Could not find OBS Frontend API's library !")
 	endif()
 
+	add_definitions(-D_WEBSOCKETPP_CPP11_STL_)
+
 	if(CMAKE_SIZEOF_VOID_P EQUAL 8)
 		set(ARCH_NAME "64bit")
 		set(OBS_BUILDDIR_ARCH "build64")
@@ -110,8 +117,6 @@ if(WIN32)
 
 		COMMAND if $<CONFIG:Release>==1 ("${CMAKE_COMMAND}" -E copy
 			"$<TARGET_FILE:obs-websocket>"
-			"${QTDIR}/bin/Qt5WebSockets.dll"
-			"${QTDIR}/bin/Qt5Network.dll"
 			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
 
 		# If config is RelWithDebInfo, package release files
@@ -126,8 +131,6 @@ if(WIN32)
 
 		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
 			"$<TARGET_FILE:obs-websocket>"
-			"${QTDIR}/bin/Qt5WebSockets.dll"
-			"${QTDIR}/bin/Qt5Network.dll"
 			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
 
 		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
@@ -138,8 +141,6 @@ if(WIN32)
 		COMMAND if $<CONFIG:Debug>==1 (
 			"${CMAKE_COMMAND}" -E copy
 				"$<TARGET_FILE:obs-websocket>"
-				"${QTDIR}/bin/Qt5WebSocketsd.dll"
-				"${QTDIR}/bin/Qt5Networkd.dll"
 				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}")
 
 		COMMAND if $<CONFIG:Debug>==1 (
@@ -163,17 +164,18 @@ endif()
 
 # --- Linux-specific build settings and tasks ---
 if(UNIX AND NOT APPLE)
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
-
-	target_compile_options(mbedcrypto PRIVATE -fPIC)
 	set_target_properties(obs-websocket PROPERTIES PREFIX "")
-	target_link_libraries(obs-websocket
+	target_link_libraries(obs-websocket obs-frontend-api)
-		obs-frontend-api)
 
 	file(GLOB locale_files data/locale/*.ini)
+	execute_process(COMMAND uname -m COMMAND tr -d '\n' OUTPUT_VARIABLE UNAME_MACHINE)
 
 	install(TARGETS obs-websocket
 		LIBRARY DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/obs-plugins")
+	# Dirty fix for Ubuntu
+        install(TARGETS obs-websocket
+                LIBRARY DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/${UNAME_MACHINE}-linux-gnu/obs-plugins")
+
 	install(FILES ${locale_files}
 		DESTINATION "${CMAKE_INSTALL_PREFIX}/share/obs/obs-plugins/obs-websocket/locale")
 endif()

README.md

@@ -2,9 +2,9 @@ obs-websocket
 ==============
 Remote control of OBS Studio made easy.
 
-Follow the project on Twitter for news & updates : [@obswebsocket](https://twitter.com/obswebsocket)
+Follow the main author on Twitter for news & updates : [@LePalakis](https://twitter.com/LePalakis)
 
-[![Gitter chat](https://badges.gitter.im/obs-websocket/obs-websocket.png)](https://gitter.im/obs-websocket/obs-websocket) [![Build Status - Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history) [![Build Status - Linux & OS X](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
+[![Build Status - Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history) [![Build Status - Linux & OS X](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
 
 ## Downloads
 Binaries for Windows and Linux are available in the [Releases](https://github.com/Palakis/obs-websocket/releases) section.
@@ -20,6 +20,7 @@ It is **highly recommended** to protect obs-websocket with a password against un
 - Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)
 
 ### For developers
+
 The server is a typical Websockets server running by default on port 4444 (the port number can be changed in the Settings dialog).
 The protocol understood by the server is documented in [PROTOCOL.md](docs/generated/protocol.md).  
 
@@ -29,37 +30,92 @@ Here's a list of available language APIs for obs-websocket :
 - Python 2 and 3: [obs-websocket-py](https://github.com/Elektordi/obs-websocket-py) by Guillaume Genty a.k.a Elektordi
 - Python 3.5+ with asyncio: [obs-ws-rc](https://github.com/KirillMysnik/obs-ws-rc) by Kirill Mysnik
 
-I'd like to know what you're building with or for obs-websocket. If you do something in this fashion, feel free to drop me an email at `contact at slepin dot fr` !
+I'd like to know what you're building with or for obs-websocket. If you do something in this fashion, feel free to drop me an email at `stephane /dot/ lepin /at/ gmail /dot/ com` !
 
 ## Compiling obs-websocket
+
 See the [build instructions](BUILDING.md).
 
+## Contributing
+
+### Branches
+
+The two main development branches are:
+
+- `4.x-current`: actively-maintained codebase for 4.x releases. Backwards-compatible (unless stated otherwise) with existing clients until 5.0.
+- `5.x`: upcoming 5.0 version
+
+**New features and fixes must be based off and contributed to `4.x-current`**, as obs-websocket 5.0 is not in active development yet.
+
+### Pull Requests
+
+Pull Requests must never be based off your fork's main branch (in our case, `4.x-current` or `5.x`). Start your work in a new branch
+based on the main one (e.g.: `cool-new-feature`, `fix-palakis-mistakes`, ...) and open a Pull Request once you feel ready to show your work.
+
+If your Pull Request is not ready to merge yet, tag it with the `work in progress` label. You can also use the `help needed` label if you have questions, need a hand or want to ask for input.
+
+### Code style & formatting
+
+Source code is indented with tabs, with spaces allowed for alignment.
+
+Regarding protocol changes: new and updated request types / events must always come with accompanying documentation comments (see existing protocol elements for examples).
+These are using to automatically generate the [protocol specification](docs/generated/protocol.md).
+
+Among other recommendations: favor return-early code and avoid wrapping huge portions of code in conditionals. As an example, this:
+
+```cpp
+if (success) {
+    return req->SendOKResponse();
+} else {
+    return req->SendErrorResponse("something went wrong");
+}
+```
+
+is better like this:
+
+```cpp
+if (!success) {
+    return req->SendErrorResponse("something went wrong");
+}
+return req->SendOKResponse();
+```
+
+
 ## Translations
-**We need your help on translations**. Please join the localization project on Crowdin: https://crowdin.com/project/obs-websocket
+
+**Your help is welcome on translations**. Please join the localization project on Crowdin: https://crowdin.com/project/obs-websocket
 
 ## Special thanks
-In order of appearance:
+
-- [Brendan H.](https://github.com/haganbmj) : Code contributions and 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,5 +1,3 @@
-image: Visual Studio 2017
-
 environment:
   CURL_VERSION: 7.39.0
 
@@ -17,9 +15,9 @@ install:
   - mkdir build32
   - mkdir build64
   - cd ./build32
-  - cmake -G "Visual Studio 15 2017" -DQTDIR="%QTDIR32%" -DLibObs_DIR="C:\projects\obs-studio\build32\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build32\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
+  - cmake -G "Visual Studio 14 2015" -DQTDIR="%QTDIR32%" -DLibObs_DIR="C:\projects\obs-studio\build32\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build32\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
   - cd ../build64
-  - cmake -G "Visual Studio 15 2017 Win64" -DQTDIR="%QTDIR64%" -DLibObs_DIR="C:\projects\obs-studio\build64\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build64\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build64\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
+  - cmake -G "Visual Studio 14 2015 Win64" -DQTDIR="%QTDIR64%" -DLibObs_DIR="C:\projects\obs-studio\build64\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build64\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build64\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
 
 build_script:
   - call msbuild /m /p:Configuration=%build_config% C:\projects\obs-websocket\build32\obs-websocket.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"

azure-pipelines.yml

@@ -0,0 +1,23 @@
+pool:
+  vmImage: 'macOS-10.13'
+
+steps:
+- checkout: self
+  submodules: true
+
+- script: ./CI/install-dependencies-macos.sh
+  displayName: 'Install Dependencies'
+
+- script: ./CI/install-build-obs-macos.sh
+  displayName: 'Build OBS'
+
+- script: ./CI/build-macos.sh
+  displayName: 'Build obs-websocket'
+
+- script: ./CI/package-macos.sh
+  displayName: 'Package'
+
+- task: PublishBuildArtifacts@1
+  inputs:
+    pathtoPublish: './release'
+    artifactName: 'build'

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 - An unknown network error happened on your system. Try again by changing settings, restarting OBS or restarting your system."
+OBSWebsocket.ProfileChanged.Started="WebSockets server enabled in this profile. Server started."
+OBSWebsocket.ProfileChanged.Stopped="WebSockets server disabled in this profile. Server stopped."
+OBSWebsocket.ProfileChanged.Restarted="WebSockets server port changed in this profile. Server restarted."

data/locale/es-ES.ini

@@ -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.6.0 protocol reference
 
 # General Introduction
 Messages are exchanged between the client and the server as JSON objects.
 This protocol is based on the original OBS Remote protocol created by Bill Hamilton, with new commands specific to OBS Studio.
 
-
 # Authentication
-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.4.0"
+#define MyAppVersion "4.6.1"
 #define MyAppPublisher "Stephane Lepin"
 #define MyAppURL "http://github.com/Palakis/obs-websocket"
 
@@ -23,14 +23,13 @@ DefaultGroupName={#MyAppName}
 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,17 +16,16 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef 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>
@@ -34,52 +33,53 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 class Utils {
   public:
-    static obs_data_array_t* StringListToArray(char** strings, char* key);
+	static obs_data_array_t* StringListToArray(char** strings, const char* key);
-    static obs_data_array_t* GetSceneItems(obs_source_t* source);
+	static obs_data_array_t* GetSceneItems(obs_source_t* source);
-    static obs_data_t* GetSceneItemData(obs_sceneitem_t* item);
+	static obs_data_t* GetSceneItemData(obs_sceneitem_t* item);
-    static obs_sceneitem_t* GetSceneItemFromName(
+	static obs_sceneitem_t* GetSceneItemFromName(
-        obs_source_t* source, QString name);
+		obs_source_t* source, QString name);
-    static obs_source_t* GetTransitionFromName(QString transitionName);
+        static obs_sceneitem_t* GetSceneItemFromId(obs_source_t* source, size_t id);
-    static obs_source_t* GetSceneFromNameOrCurrent(QString sceneName);
+	static obs_sceneitem_t* GetSceneItemFromItem(obs_source_t* source, obs_data_t* item);
+	static obs_source_t* GetTransitionFromName(QString transitionName);
+	static obs_source_t* GetSceneFromNameOrCurrent(QString sceneName);
+	static obs_data_t* GetSceneItemPropertiesData(obs_sceneitem_t* item);
 
-    static bool IsValidAlignment(const uint32_t alignment);
+	static obs_data_array_t* GetSourceFiltersList(obs_source_t* source, bool includeSettings);
 
-    static obs_data_array_t* GetScenes();
+	static bool IsValidAlignment(const uint32_t alignment);
-    static obs_data_t* GetSceneData(obs_source_t* source);
 
-    static QSpinBox* GetTransitionDurationControl();
+	static obs_data_array_t* GetScenes();
-    static int GetTransitionDuration();
+	static obs_data_t* GetSceneData(obs_source_t* source);
-    static void SetTransitionDuration(int ms);
 
-    static bool SetTransitionByName(QString transitionName);
+	// TODO contribute a proper frontend API method for this to OBS and remove this hack
+	static QSpinBox* GetTransitionDurationControl();
+	static int GetTransitionDuration();
+	static void SetTransitionDuration(int ms);
 
-    static QPushButton* GetPreviewModeButtonControl();
+	static bool SetTransitionByName(QString transitionName);
-    static QLayout* GetPreviewLayout();
-    static QListWidget* GetSceneListControl();
-    static obs_scene_t* SceneListItemToScene(QListWidgetItem* item);
 
-    static void TransitionToProgram();
+	static QPushButton* GetPreviewModeButtonControl();
+	static QLayout* GetPreviewLayout();
 
-    static QString OBSVersionString();
+	// TODO contribute a proper frontend API method for this to OBS and remove this hack
+	static void TransitionToProgram();
 
-    static QSystemTrayIcon* GetTrayIcon();
+	static QString OBSVersionString();
-    static void SysTrayNotify(
-        QString &text,
-        QSystemTrayIcon::MessageIcon n,
-        QString title = QString("obs-websocket"));
 
-    static QString FormatIPAddress(QHostAddress &addr);
+	static QSystemTrayIcon* GetTrayIcon();
+	static void SysTrayNotify(
+		QString text,
+		QSystemTrayIcon::MessageIcon n,
+		QString title = QString("obs-websocket"));
 
-    static const char* GetRecordingFolder();
+	static const char* GetRecordingFolder();
-    static bool SetRecordingFolder(const char* path);
+	static bool SetRecordingFolder(const char* path);
 
-    static QString ParseDataToQueryString(obs_data_t* data);
+	static QString ParseDataToQueryString(obs_data_t* data);
-    static obs_hotkey_t* FindHotkeyByName(QString name);
+	static obs_hotkey_t* FindHotkeyByName(QString name);
-    static bool ReplayBufferEnabled();
+	static bool ReplayBufferEnabled();
-    static void StartReplayBuffer();
+	static void StartReplayBuffer();
-    static bool IsRPHotkeySet();
+	static bool IsRPHotkeySet();
-    static const char* GetFilenameFormatting();
+	static const char* GetFilenameFormatting();
-    static bool SetFilenameFormatting(const char* filenameFormatting);
+	static bool SetFilenameFormatting(const char* filenameFormatting);
 };
-
-#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,94 +17,117 @@ 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();
+public:
-    static void FrontendEventHandler(
+	explicit WSEvents(WSServerPtr srv);
-        enum obs_frontend_event event, void* privateData);
+	~WSEvents();
-    static WSEvents* Instance;
+
-    void connectSceneSignals(obs_source_t* scene);
+	void connectSourceSignals(obs_source_t* source);
+	void disconnectSourceSignals(obs_source_t* source);
 
 	void hookTransitionBeginEvent();
+	void unhookTransitionBeginEvent();
 
-    uint64_t GetStreamingTime();
+	uint64_t GetStreamingTime();
-    const char* GetStreamingTimecode();
+	const char* GetStreamingTimecode();
-    uint64_t GetRecordingTime();
+	uint64_t GetRecordingTime();
-    const char* GetRecordingTimecode();
+	const char* GetRecordingTimecode();
+	obs_data_t* GetStats();
 
-    bool HeartbeatIsActive;
+	bool HeartbeatIsActive;
 
-  private slots:
+private slots:
-    void deferredInitOperations();
+	void StreamStatus();
-    void StreamStatus();
+	void Heartbeat();
-    void Heartbeat();
+	void TransitionDurationChanged(int ms);
-    void TransitionDurationChanged(int ms);
 
-  private:
+private:
-    WSServer* _srv;
+	WSServerPtr _srv;
-    OBSSource currentScene;
+	QTimer streamStatusTimer;
+	QTimer heartbeatTimer;
+	os_cpu_usage_info_t* cpuUsageInfo;
 
-    bool pulse;
+	bool pulse;
 
-    bool _streamingActive;
+	uint64_t _streamStarttime;
-    bool _recordingActive;
+	uint64_t _recStarttime;
 
-    uint64_t _streamStarttime;
+	uint64_t _lastBytesSent;
-    uint64_t _recStarttime;
+	uint64_t _lastBytesSentTime;
 
-    uint64_t _lastBytesSent;
+	void broadcastUpdate(const char* updateType,
-    uint64_t _lastBytesSentTime;
+		obs_data_t* additionalFields);
 
-    void broadcastUpdate(const char* updateType,
+	void OnSceneChange();
-        obs_data_t* additionalFields);
+	void OnSceneListChange();
+	void OnSceneCollectionChange();
+	void OnSceneCollectionListChange();
 
-    void OnSceneChange();
+	void OnTransitionChange();
-    void OnSceneListChange();
+	void OnTransitionListChange();
-    void OnSceneCollectionChange();
-    void OnSceneCollectionListChange();
 
-    void OnTransitionChange();
+	void OnProfileChange();
-    void OnTransitionListChange();
+	void OnProfileListChange();
 
-    void OnProfileChange();
+	void OnStreamStarting();
-    void OnProfileListChange();
+	void OnStreamStarted();
+	void OnStreamStopping();
+	void OnStreamStopped();
 
-    void OnStreamStarting();
+	void OnRecordingStarting();
-    void OnStreamStarted();
+	void OnRecordingStarted();
-    void OnStreamStopping();
+	void OnRecordingStopping();
-    void OnStreamStopped();
+	void OnRecordingStopped();
 
-    void OnRecordingStarting();
+	void OnReplayStarting();
-    void OnRecordingStarted();
+	void OnReplayStarted();
-    void OnRecordingStopping();
+	void OnReplayStopping();
-    void OnRecordingStopped();
+	void OnReplayStopped();
 
-    void OnReplayStarting();
+	void OnStudioModeSwitched(bool enabled);
-    void OnReplayStarted();
+	void OnPreviewSceneChanged();
-    void OnReplayStopping();
-    void OnReplayStopped();
 
-    void OnStudioModeSwitched(bool enabled);
+	void OnExit();
-    void OnPreviewSceneChanged();
 
-    void OnExit();
+	static void FrontendEventHandler(
+		enum obs_frontend_event event, void* privateData);
 
-    static void OnTransitionBegin(void* param, calldata_t* data);
+	static void OnTransitionBegin(void* param, calldata_t* data);
 
-    static void OnSceneReordered(void* param, calldata_t* data);
+	static void OnSourceCreate(void* param, calldata_t* data);
-    static void OnSceneItemAdd(void* param, calldata_t* data);
+	static void OnSourceDestroy(void* param, calldata_t* data);
-    static void OnSceneItemDelete(void* param, calldata_t* data);
+
-    static void OnSceneItemVisibilityChanged(void* param, calldata_t* data);
+	static void OnSourceVolumeChange(void* param, calldata_t* data);
+	static void OnSourceMuteStateChange(void* param, calldata_t* data);
+	static void OnSourceAudioSyncOffsetChanged(void* param, calldata_t* data);
+	static void OnSourceAudioMixersChanged(void* param, calldata_t* data);
+
+	static void OnSourceRename(void* param, calldata_t* data);
+
+	static void OnSourceFilterAdded(void* param, calldata_t* data);
+	static void OnSourceFilterRemoved(void* param, calldata_t* data);
+	static void OnSourceFilterOrderChanged(void* param, calldata_t* data);
+
+	static void OnSceneReordered(void* param, calldata_t* data);
+	static void OnSceneItemAdd(void* param, calldata_t* data);
+	static void OnSceneItemDelete(void* param, calldata_t* data);
+	static void OnSceneItemVisibilityChanged(void* param, calldata_t* data);
+	static void OnSceneItemTransform(void* param, calldata_t* data);
+	static void OnSceneItemSelected(void* param, calldata_t* data);
+	static void OnSceneItemDeselected(void* param, calldata_t* data);
 };
-
-#endif // WSEVENTS_H

src/WSRequestHandler.cpp

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

src/WSRequestHandler_General.cpp

@@ -1,11 +1,58 @@
-#include <QString>
+#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.
  *
@@ -19,25 +66,26 @@
  * @category general
  * @since 0.3
  */
- void WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
-    QString obsVersion = Utils::OBSVersionString();
+	QString obsVersion = Utils::OBSVersionString();
 
-    QList<QString> names = req->messageMap.keys();
+	QList<QString> names = req->messageMap.keys();
-    names.sort(Qt::CaseInsensitive);
+	names.sort(Qt::CaseInsensitive);
 
-    // (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();
+	requests += names.takeFirst();
-    for (QString reqName : names) {
+	for (QString reqName : names) {
-        requests += ("," + reqName);
+		requests += ("," + reqName);
-    }
+	}
 
-    OBSDataAutoRelease data = obs_data_create();
+	OBSDataAutoRelease data = obs_data_create();
-    obs_data_set_string(data, "obs-websocket-version", OBS_WEBSOCKET_VERSION);
+	obs_data_set_double(data, "version", 1.1);
-    obs_data_set_string(data, "obs-studio-version", obsVersion.toUtf8());
+	obs_data_set_string(data, "obs-websocket-version", OBS_WEBSOCKET_VERSION);
-    obs_data_set_string(data, "available-requests", requests.toUtf8());
+	obs_data_set_string(data, "obs-studio-version", obsVersion.toUtf8());
+	obs_data_set_string(data, "available-requests", requests.toUtf8());
 
-    req->SendOKResponse(data);
+	return req->SendOKResponse(data);
 }
 
 /**
@@ -53,20 +101,21 @@
  * @category general
  * @since 0.3
  */
-void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
-    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 req->SendOKResponse(data);
 }
 
 /**
@@ -79,26 +128,26 @@ void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
  * @category general
  * @since 0.3
  */
-void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
-    if (!req->hasField("auth")) {
+	if (!req->hasField("auth")) {
-        req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-        return;
+	}
-    }
 
-    QString auth = obs_data_get_string(req->data, "auth");
+	if (req->_connProperties.isAuthenticated()) {
-    if (auth.isEmpty()) {
+		return req->SendErrorResponse("already authenticated");
-        req->SendErrorResponse("auth not specified!");
+	}
-        return;
-    }
 
-    if ((req->_client->property(PROP_AUTHENTICATED).toBool() == false)
+	QString auth = obs_data_get_string(req->data, "auth");
-        && Config::Current()->CheckAuth(auth))
+	if (auth.isEmpty()) {
-    {
+		return req->SendErrorResponse("auth not specified!");
-        req->_client->setProperty(PROP_AUTHENTICATED, true);
+	}
-        req->SendOKResponse();
+
-    } else {
+	if (GetConfig()->CheckAuth(auth) == false) {
-        req->SendErrorResponse("Authentication Failed.");
+		return req->SendErrorResponse("Authentication Failed.");
-    }
+	}
+
+	req->_connProperties.setAuthenticated(true);
+	return req->SendOKResponse();
 }
 
 /**
@@ -111,19 +160,17 @@ void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
- void WSRequestHandler::HandleSetHeartbeat(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetHeartbeat(WSRequestHandler* req) {
-    if (!req->hasField("enable")) {
+	if (!req->hasField("enable")) {
-        req->SendErrorResponse("Heartbeat <enable> parameter missing");
+		return req->SendErrorResponse("Heartbeat <enable> parameter missing");
-        return;
+	}
-    }
 
-    WSEvents::Instance->HeartbeatIsActive =
+	auto events = GetEventsSystem();
-        obs_data_get_bool(req->data, "enable");
+	events->HeartbeatIsActive = obs_data_get_bool(req->data, "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);
+	return req->SendOKResponse(response);
-    req->SendOKResponse(response);
 }
 
 /**
@@ -136,19 +183,18 @@ void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
-void WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
-    if (!req->hasField("filename-formatting")) {
+	if (!req->hasField("filename-formatting")) {
-        req->SendErrorResponse("<filename-formatting> parameter missing");
+		return req->SendErrorResponse("<filename-formatting> parameter missing");
-        return;
+	}
-    }
 
-    QString filenameFormatting = obs_data_get_string(req->data, "filename-formatting");
+	QString filenameFormatting = obs_data_get_string(req->data, "filename-formatting");
-    if (!filenameFormatting.isEmpty()) {
+	if (filenameFormatting.isEmpty()) {
-        Utils::SetFilenameFormatting(filenameFormatting.toUtf8());
+		return req->SendErrorResponse("invalid request parameters");
-        req->SendOKResponse();
+	}
-    } else {
+
-        req->SendErrorResponse("invalid request parameters");
+	Utils::SetFilenameFormatting(filenameFormatting.toUtf8());
-    }
+	return req->SendOKResponse();
 }
 
 /**
@@ -161,8 +207,60 @@ void WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
-void WSRequestHandler::HandleGetFilenameFormatting(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetFilenameFormatting(WSRequestHandler* req) {
-    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 req->SendOKResponse(response);
+}
+
+/**
+ * Get OBS stats (almost the same info as provided in OBS' stats window)
+ *
+ * @return {OBSStats} `stats` OBS stats
+ *
+ * @api requests
+ * @name GetStats
+ * @category general
+ * @since 4.6.0
+ */
+HandlerResponse WSRequestHandler::HandleGetStats(WSRequestHandler* req) {
+	OBSDataAutoRelease stats = GetEventsSystem()->GetStats();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_obj(response, "stats", stats);
+	return req->SendOKResponse(response);
+}
+
+/**
+ * Get basic OBS video information
+ * 
+ * @return {int} `baseWidth` Base (canvas) width
+ * @return {int} `baseHeight` Base (canvas) height
+ * @return {int} `outputWidth` Output width
+ * @return {int} `outputHeight` Output height
+ * @return {String} `scaleType` Scaling method used if output size differs from base size
+ * @return {double} `fps` Frames rendered per second
+ * @return {String} `videoFormat` Video color format
+ * @return {String} `colorSpace` Color space for YUV
+ * @return {String} `colorRange` Color range (full or partial)
+ * 
+ * @api requests
+ * @name GetVideoInfo
+ * @category general
+ * @since 4.6.0 
+ */
+HandlerResponse WSRequestHandler::HandleGetVideoInfo(WSRequestHandler* req) {
+	obs_video_info ovi;
+	obs_get_video_info(&ovi);
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_int(response, "baseWidth", ovi.base_width);
+	obs_data_set_int(response, "baseHeight", ovi.base_height);
+	obs_data_set_int(response, "outputWidth", ovi.output_width);
+	obs_data_set_int(response, "outputHeight", ovi.output_height);
+	obs_data_set_double(response, "fps", (double)ovi.fps_num / ovi.fps_den);
+	obs_data_set_string(response, "videoFormat", describe_output_format(ovi.output_format));
+	obs_data_set_string(response, "colorSpace", describe_color_space(ovi.colorspace));
+	obs_data_set_string(response, "colorRange", describe_color_range(ovi.range));
+	obs_data_set_string(response, "scaleType", describe_scale_type(ovi.scale_type));
+	return req->SendOKResponse(response);
 }

src/WSRequestHandler_Profiles.cpp

@@ -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) {
+HandlerResponse WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req) {
-    if (!req->hasField("profile-name")) {
+	if (!req->hasField("profile-name")) {
-        req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-        return;
+	}
-    }
 
-    QString profileName = obs_data_get_string(req->data, "profile-name");
+	QString profileName = obs_data_get_string(req->data, "profile-name");
-    if (!profileName.isEmpty()) {
+	if (profileName.isEmpty()) {
-        // TODO : check if profile exists
+		return req->SendErrorResponse("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 req->SendOKResponse();
 }
 
  /**
@@ -39,32 +37,29 @@
  * @category profiles
  * @since 4.0.0
  */
-void WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "profile-name",
+	obs_data_set_string(response, "profile-name", obs_frontend_get_current_profile());
-        obs_frontend_get_current_profile());
+	return req->SendOKResponse(response);
-
-    req->SendOKResponse(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) {
+HandlerResponse WSRequestHandler::HandleListProfiles(WSRequestHandler* req) {
-    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 req->SendOKResponse(response);
 }

src/WSRequestHandler_Recording.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -11,13 +10,13 @@
  * @category recording
  * @since 0.3
  */
- void WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req) {
-    if (obs_frontend_recording_active())
+	if (obs_frontend_recording_active())
-        obs_frontend_recording_stop();
+		obs_frontend_recording_stop();
-    else
+	else
-        obs_frontend_recording_start();
+		obs_frontend_recording_start();
 
-    req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -29,13 +28,13 @@
  * @category recording
  * @since 4.1.0
  */
- void WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
-    if (obs_frontend_recording_active() == false) {
+	if (obs_frontend_recording_active() == false) {
-        obs_frontend_recording_start();
+		obs_frontend_recording_start();
-        req->SendOKResponse();
+		return req->SendOKResponse();
-    } else {
+	} else {
-        req->SendErrorResponse("recording already active");
+		return req->SendErrorResponse("recording already active");
-    }
+	}
 }
 
 /**
@@ -47,17 +46,23 @@
  * @category recording
  * @since 4.1.0
  */
-void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
+ HandlerResponse WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
-    if (obs_frontend_recording_active() == true) {
+	if (obs_frontend_recording_active() == true) {
-        obs_frontend_recording_stop();
+		obs_frontend_recording_stop();
-        req->SendOKResponse();
+		return req->SendOKResponse();
-    } else {
+	} else {
-        req->SendErrorResponse("recording not active");
+		return req->SendErrorResponse("recording not active");
-    }
+	}
 }
 
 /**
- * Change the current recording folder.
+ * 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 +71,18 @@ void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
  * @category recording
  * @since 4.1.0
  */
- void WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) {
-    if (!req->hasField("rec-folder")) {
+	if (!req->hasField("rec-folder")) {
-        req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-        return;
+	}
-    }
 
-    const char* newRecFolder = obs_data_get_string(req->data, "rec-folder");
+	const char* newRecFolder = obs_data_get_string(req->data, "rec-folder");
-    bool success = Utils::SetRecordingFolder(newRecFolder);
+	bool success = Utils::SetRecordingFolder(newRecFolder);
-    if (success)
+	if (!success) {
-        req->SendOKResponse();
+		return req->SendErrorResponse("invalid request parameters");
-    else
+	}
-        req->SendErrorResponse("invalid request parameters");
+
+	return req->SendOKResponse();
 }
 
 /**
@@ -90,11 +95,11 @@ void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
  * @category recording
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) {
-    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 req->SendOKResponse(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) {
+HandlerResponse WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
-    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 req->SendOKResponse();
 }
 
 /**
@@ -32,19 +31,17 @@ void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
-    if (!Utils::ReplayBufferEnabled()) {
+	if (!Utils::ReplayBufferEnabled()) {
-        req->SendErrorResponse("replay buffer disabled in settings");
+		return req->SendErrorResponse("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 req->SendErrorResponse("replay buffer already active");
-        return;
+	}
-    }
 
-    Utils::StartReplayBuffer();
+	Utils::StartReplayBuffer();
-    req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -56,13 +53,13 @@ void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
-    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 req->SendOKResponse();
-    } else {
+	} else {
-        req->SendErrorResponse("replay buffer not active");
+		return req->SendErrorResponse("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) {
+HandlerResponse WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
-    if (!obs_frontend_replay_buffer_active()) {
+	if (!obs_frontend_replay_buffer_active()) {
-        req->SendErrorResponse("replay buffer not active");
+		return req->SendErrorResponse("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 req->SendOKResponse();
 }

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) {
+HandlerResponse WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandler* req) {
-    if (!req->hasField("sc-name")) {
+	if (!req->hasField("sc-name")) {
-        req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-        return;
+	}
-    }
 
-    QString sceneCollection = obs_data_get_string(req->data, "sc-name");
+	QString sceneCollection = obs_data_get_string(req->data, "sc-name");
-    if (!sceneCollection.isEmpty()) {
+	if (sceneCollection.isEmpty()) {
-        // TODO : Check if specified profile exists and if changing is allowed
+		return req->SendErrorResponse("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 req->SendOKResponse();
 }
 
 /**
@@ -39,33 +37,32 @@
  * @category scene collections
  * @since 4.0.0
  */
-void WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) {
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "sc-name",
+	obs_data_set_string(response, "sc-name",
-        obs_frontend_get_current_scene_collection());
+		obs_frontend_get_current_scene_collection());
 
-    req->SendOKResponse(response);
+	return req->SendOKResponse(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) {
+HandlerResponse WSRequestHandler::HandleListSceneCollections(WSRequestHandler* req) {
-    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 req->SendOKResponse(response);
 }

src/WSRequestHandler_SceneItems.cpp

@@ -1,10 +1,10 @@
-#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} `item` The name of the source.
@@ -21,171 +21,106 @@
 * @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} `locked` If the source's transform is locked.
+* @return {String} `bounds.type` Type of bounding box. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE".
 * @return {int} `bounds.alignment` Alignment of the bounding box.
 * @return {double} `bounds.x` Width of the bounding box.
 * @return {double} `bounds.y` Height of the bounding box.
+* @return {int} `sourceWidth` Base width (without scaling) of the source
+* @return {int} `sourceHeight` Base source (without scaling) of the source
+* @return {double} `width` Scene item width (base source width multiplied by the horizontal scaling factor)
+* @return {double} `height` Scene item height (base source height multiplied by the vertical scaling factor)
+* @property {String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)
+* @property {Array<SceneItemTransform> (optional)} `groupChildren` List of children (if this item is a group)
 * 
 * @api requests
 * @name GetSceneItemProperties
 * @category scene items
 * @since 4.3.0
 */
-void WSRequestHandler::HandleGetSceneItemProperties(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetSceneItemProperties(WSRequestHandler* req) {
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem =
 		Utils::GetSceneItemFromName(scene, itemName);
 	if (!sceneItem) {
-		req->SendErrorResponse("specified scene item doesn't exist");
+		return req->SendErrorResponse("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();
+	return req->SendOKResponse(data);
-	vec2 pos;
-	obs_sceneitem_get_pos(sceneItem, &pos);
-	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));
-
-	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} `item` The name of the source.
-* @param {int} `position.x` The new x position of the source.
+* @param {int (optional)} `position.x` The new x position of the source.
-* @param {int} `position.y` The new y position of the source.
+* @param {int (optional)} `position.y` The new y position of the source.
-* @param {int} `position.alignment` The new alignment of the source.
+* @param {int (optional)} `position.alignment` The new alignment of the source.
-* @param {double} `rotation` The new clockwise rotation of the item in degrees.
+* @param {double (optional)} `rotation` The new clockwise rotation of the item in degrees.
-* @param {double} `scale.x` The new x scale of the item.
+* @param {double (optional)} `scale.x` The new x scale of the item.
-* @param {double} `scale.y` The new y scale of the item.
+* @param {double (optional)} `scale.y` The new y scale of the item.
-* @param {int} `crop.top` The new amount of pixels cropped off the top 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.bottom` The new amount of pixels cropped off the bottom of the source before scaling.
+* @param {int (optional)} `crop.bottom` The new amount of pixels cropped off the bottom of the source before scaling.
-* @param {int} `crop.left` The new amount of pixels cropped off the left of the source before scaling.
+* @param {int (optional)} `crop.left` The new amount of pixels cropped off the left of the source before scaling.
-* @param {int} `crop.right` The new amount of pixels cropped off the right of the source before scaling.
+* @param {int (optional)} `crop.right` The new amount of pixels cropped off the right of the source before scaling.
-* @param {bool} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.
+* @param {bool (optional)} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.
-* @param {String} `bounds.type` The new bounds type of the source.
+* @param {bool (optional)} `locked` The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement.
-* @param {int} `bounds.alignment` The new alignment of the bounding box. (0-2, 4-6, 8-10)
+* @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 {double} `bounds.x` The new width of the bounding box.
+* @param {int (optional)} `bounds.alignment` The new alignment of the bounding box. (0-2, 4-6, 8-10)
-* @param {double} `bounds.y` The new height of the bounding box.
+* @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) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem =
 		Utils::GetSceneItemFromName(scene, itemName);
 	if (!sceneItem) {
-		req->SendErrorResponse("specified scene item doesn't exist");
+		return req->SendErrorResponse("specified scene item doesn't exist");
-		return;
 	}
 
 	bool badRequest = false;
 	OBSDataAutoRelease errorMessage = obs_data_create();
 
+	obs_sceneitem_defer_update_begin(sceneItem);
+
 	if (req->hasField("position")) {
 		vec2 oldPosition;
 		OBSDataAutoRelease positionError = obs_data_create();
@@ -254,12 +189,16 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 		obs_sceneitem_set_visible(sceneItem, obs_data_get_bool(req->data, "visible"));
 	}
 
+	if (req->hasField("locked")) {
+		obs_sceneitem_set_locked(sceneItem, obs_data_get_bool(req->data, "locked"));
+	}
+
 	if (req->hasField("bounds")) {
 		bool badBounds = false;
 		OBSDataAutoRelease boundsError = obs_data_create();
 		OBSDataAutoRelease reqBounds = obs_data_get_obj(req->data, "bounds");
 		if (obs_data_has_user_value(reqBounds, "type")) {
-			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);
 			}
@@ -311,18 +250,19 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 		}
 	}
 
+	obs_sceneitem_defer_update_end(sceneItem);
+
 	if (badRequest) {
-		req->SendErrorResponse(errorMessage);
+		return req->SendErrorResponse(errorMessage);
-	}
-	else {
-		req->SendOKResponse();
 	}
+
+	return req->SendOKResponse();
 }
 
 /**
 * 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 source belongs to. Defaults to the current scene.
 * @param {String} `item` Name of the source item.
 *
 * @api requests
@@ -330,39 +270,35 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 * @category scene items
 * @since 4.2.0
 */
-void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
 	// TODO: remove this request, or refactor it to ResetSource
 
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	const char* itemName = obs_data_get_string(req->data, "item");
 	if (!itemName) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	const char* sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
-		OBSSource sceneItemSource = obs_sceneitem_get_source(sceneItem);
+		return req->SendErrorResponse("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 req->SendOKResponse();
 }
 
 /**
@@ -378,38 +314,34 @@ void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
 * @since 0.3
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
 	if (!req->hasField("source") ||
 		!req->hasField("render"))
 	{
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	const char* itemName = obs_data_get_string(req->data, "source");
 	bool isVisible = obs_data_get_bool(req->data, "render");
 
 	if (!itemName) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	const char* sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem =
 		Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
-		obs_sceneitem_set_visible(sceneItem, isVisible);
+		return req->SendErrorResponse("specified scene item doesn't exist");
-		req->SendOKResponse();
-	}
-	else {
-		req->SendErrorResponse("specified scene item doesn't exist");
 	}
+
+	obs_sceneitem_set_visible(sceneItem, isVisible);
+	return req->SendOKResponse();
 }
 
 /**
@@ -427,38 +359,34 @@ void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
 * @since 4.0.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
 	if (!req->hasField("item") ||
 		!req->hasField("x") || !req->hasField("y")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene could not be found");
+		return req->SendErrorResponse("requested scene could not be found");
-		return;
 	}
 
 	OBSSceneItem sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
-		vec2 item_position = { 0 };
+		return req->SendErrorResponse("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(req->data, "x");
-	else {
+	item_position.y = obs_data_get_double(req->data, "y");
-		req->SendErrorResponse("specified scene item doesn't exist");
+	obs_sceneitem_set_pos(sceneItem, &item_position);
-	}
+
+	return req->SendOKResponse();
 }
 
 /**
@@ -476,27 +404,24 @@ void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
 * @since 4.0.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
 	if (!req->hasField("item") ||
 		!req->hasField("x-scale") ||
 		!req->hasField("y-scale") ||
 		!req->hasField("rotation"))
 	{
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	vec2 scale;
@@ -505,14 +430,18 @@ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
 	float rotation = obs_data_get_double(req->data, "rotation");
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
-		obs_sceneitem_set_scale(sceneItem, &scale);
+		return req->SendErrorResponse("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 req->SendOKResponse();
 }
 
 /**
@@ -531,38 +460,147 @@ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
 * @since 4.1.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
-		struct obs_sceneitem_crop crop = { 0 };
+		return req->SendErrorResponse("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(req->data, "top");
+	crop.bottom = obs_data_get_int(req->data, "bottom");
+	crop.left = obs_data_get_int(req->data, "left");
+	crop.right = obs_data_get_int(req->data, "right");
+
+	obs_sceneitem_set_crop(sceneItem, &crop);
+
+	return req->SendOKResponse();
+}
+
+/**
+ * Deletes a scene item.
+ *
+ * @param {String (optional)} `scene` Name of the scene the source belongs to. Defaults to the current scene.
+ * @param {Object} `item` item to delete (required)
+ * @param {String} `item.name` name of the scene item (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` id of the scene item.
+ *
+ * @api requests
+ * @name DeleteSceneItem
+ * @category scene items
+ * @since 4.5.0
+ */
+HandlerResponse WSRequestHandler::HandleDeleteSceneItem(WSRequestHandler* req) {
+	if (!req->hasField("item")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(req->data, "scene");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	OBSDataAutoRelease item = obs_data_get_obj(req->data, "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromItem(scene, item);
+	if (!sceneItem) {
+		return req->SendErrorResponse("item with id/name combination not found in specified scene");
+	}
+
+	obs_sceneitem_remove(sceneItem);
+
+	return req->SendOKResponse();
+}
+
+struct DuplicateSceneItemData {
+	obs_sceneitem_t *referenceItem;
+	obs_source_t *fromSource;
+	obs_sceneitem_t *newItem;
+};
+
+static void DuplicateSceneItem(void *_data, obs_scene_t *scene) {
+	DuplicateSceneItemData *data = (DuplicateSceneItemData *)_data;
+	data->newItem = obs_scene_add(scene, data->fromSource);
+	obs_sceneitem_set_visible(data->newItem, obs_sceneitem_visible(data->referenceItem));
+}
+
+/**
+ * Duplicates a scene item.
+ *
+ * @param {String (optional)} `fromScene` Name of the scene to copy the item from. Defaults to the current scene.
+ * @param {String (optional)} `toScene` Name of the scene to create the item in. Defaults to the current scene.
+ * @param {Object} `item` item to duplicate (required)
+ * @param {String} `item.name` name of the scene item (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` id of the scene item.
+ *
+ * @return {String} `scene` Name of the scene where the new item was created
+ * @return {Object} `item` New item info
+ * @return {int} `item.id` New item ID
+ * @return {String} `item.name` New item name
+ *
+ * @api requests
+ * @name DuplicateSceneItem
+ * @category scene items
+ * @since 4.5.0
+ */
+HandlerResponse WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req) {
+	if (!req->hasField("item")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	const char* fromSceneName = obs_data_get_string(req->data, "fromScene");
+	OBSSourceAutoRelease fromScene = Utils::GetSceneFromNameOrCurrent(fromSceneName);
+	if (!fromScene) {
+		return req->SendErrorResponse("requested fromScene doesn't exist");
+	}
+
+	const char* toSceneName = obs_data_get_string(req->data, "toScene");
+	OBSSourceAutoRelease toScene = Utils::GetSceneFromNameOrCurrent(toSceneName);
+	if (!toScene) {
+		return req->SendErrorResponse("requested toScene doesn't exist");
+	}
+
+	OBSDataAutoRelease item = obs_data_get_obj(req->data, "item");
+	OBSSceneItemAutoRelease referenceItem = Utils::GetSceneItemFromItem(fromScene, item);
+	if (!referenceItem) {
+		return req->SendErrorResponse("item with id/name combination not found in specified scene");
+	}
+
+	DuplicateSceneItemData data;
+	data.fromSource = obs_sceneitem_get_source(referenceItem);
+	data.referenceItem = referenceItem;
+
+	obs_enter_graphics();
+	obs_scene_atomic_update(obs_scene_from_source(toScene), DuplicateSceneItem, &data);
+	obs_leave_graphics();
+
+	obs_sceneitem_t *newItem = data.newItem;
+	if (!newItem) {
+		return req->SendErrorResponse("Error duplicating scene item");
+	}
+
+	OBSDataAutoRelease itemData = obs_data_create();
+	obs_data_set_int(itemData, "id", obs_sceneitem_get_id(newItem));
+	obs_data_set_string(itemData, "name", obs_source_get_name(obs_sceneitem_get_source(newItem)));
+
+	OBSDataAutoRelease responseData = obs_data_create();
+	obs_data_set_obj(responseData, "item", itemData);
+	obs_data_set_string(responseData, "scene", obs_source_get_name(toScene));
+
+	return req->SendOKResponse(responseData);
 }

src/WSRequestHandler_Scenes.cpp

@@ -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,124 @@
  * @category scenes
  * @since 0.3
  */
- void WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) {
-    if (!req->hasField("scene-name")) {
+	if (!req->hasField("scene-name")) {
-        req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-        return;
+	}
-    }
 
-    const char* sceneName = obs_data_get_string(req->data, "scene-name");
+	const char* sceneName = obs_data_get_string(req->data, "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 req->SendOKResponse();
-    } else {
+	} else {
-        req->SendErrorResponse("requested scene does not exist");
+		return req->SendErrorResponse("requested scene does not exist");
-    }
+	}
 }
 
 /**
  * Get the current scene's name and source items.
  * 
  * @return {String} `name` Name of the currently active scene.
- * @return {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) {
+HandlerResponse WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
-    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 req->SendOKResponse(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) {
+HandlerResponse WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
-    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 req->SendOKResponse(data);
+}
+
+/**
+* Changes the order of scene items in the requested scene.
+*
+* @param {String (optional)} `scene` Name of the scene to reorder (defaults to current).
+* @param {Array<Scene>} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene
+* @param {int (optional)} `items[].id` Id of a specific scene item. Unique on a scene by scene basis.
+* @param {String (optional)} `items[].name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene.
+*
+* @api requests
+* @name ReorderSceneItems
+* @category scenes
+* @since 4.5.0
+*/
+HandlerResponse WSRequestHandler::HandleReorderSceneItems(WSRequestHandler* req) {
+	QString sceneName = obs_data_get_string(req->data, "scene");
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
+	if (!scene) {
+		return req->SendErrorResponse("requested scene doesn't exist");
+	}
+
+	OBSDataArrayAutoRelease items = obs_data_get_array(req->data, "items");
+	if (!items) {
+		return req->SendErrorResponse("sceneItem order not specified");
+	}
+
+	size_t count = obs_data_array_count(items);
+
+	std::vector<obs_sceneitem_t*> newOrder;
+	newOrder.reserve(count);
+
+	for (size_t i = 0; i < count; ++i) {
+		OBSDataAutoRelease item = obs_data_array_item(items, i);
+
+		OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromItem(scene, item);
+		obs_sceneitem_release(sceneItem); // ref dec
+
+		if (!sceneItem) {
+			return req->SendErrorResponse("Invalid sceneItem id or name specified");
+		}
+		
+		for (size_t j = 0; j <= i; ++j) {
+			if (sceneItem == newOrder[j]) {
+				return req->SendErrorResponse("Duplicate sceneItem in specified order");
+			}
+		}
+
+		newOrder.push_back(sceneItem);
+	}
+
+	bool success = obs_scene_reorder_items(obs_scene_from_source(scene), newOrder.data(), count);
+	if (!success) {
+		return req->SendErrorResponse("Invalid sceneItem order");
+	}
+
+	for (auto const& item: newOrder) {
+		obs_sceneitem_release(item);
+	}
+
+	return req->SendOKResponse();
 }

src/WSRequestHandler_Streaming.cpp

@@ -1,4 +1,4 @@
-#include <QString>
+#include "obs-websocket.h"
 #include "Utils.h"
 #include "WSEvents.h"
 
@@ -20,26 +20,28 @@
  * @category streaming
  * @since 0.3
  */
- void WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) {
-    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, "preview-only", false);
-        bfree((void*)tc);
-    }
 
-    if (obs_frontend_recording_active()) {
+	const char* tc = nullptr;
-        tc = WSEvents::Instance->GetRecordingTimecode();
+	if (obs_frontend_streaming_active()) {
-        obs_data_set_string(data, "rec-timecode", tc);
+		tc = events->GetStreamingTimecode();
-        bfree((void*)tc);
+		obs_data_set_string(data, "stream-timecode", tc);
-    }
+		bfree((void*)tc);
+	}
 
-    req->SendOKResponse(data);
+	if (obs_frontend_recording_active()) {
+		tc = events->GetRecordingTimecode();
+		obs_data_set_string(data, "rec-timecode", tc);
+		bfree((void*)tc);
+	}
+
+	return req->SendOKResponse(data);
 }
 
 /**
@@ -50,11 +52,11 @@
  * @category streaming
  * @since 0.3
  */
- void WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) {
-    if (obs_frontend_streaming_active())
+	if (obs_frontend_streaming_active())
-        HandleStopStreaming(req);
+		return HandleStopStreaming(req);
-    else
+	else
-        HandleStartStreaming(req);
+		return HandleStartStreaming(req);
 }
 
 /**
@@ -76,91 +78,91 @@
  * @category streaming
  * @since 4.1.0
  */
- void WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
-    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 (req->hasField("stream")) {
-            OBSDataAutoRelease streamData = obs_data_get_obj(req->data, "stream");
+			OBSDataAutoRelease streamData = obs_data_get_obj(req->data, "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);
+				int keylen = strlen(key);
 
-                bool hasQuestionMark = false;
+				bool hasQuestionMark = false;
-                for (int i = 0; i < keylen; i++) {
+				for (int 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 req->SendOKResponse();
-    } else {
+	} else {
-        req->SendErrorResponse("streaming already active");
+		return req->SendErrorResponse("streaming already active");
-    }
+	}
 }
 
 /**
@@ -172,13 +174,13 @@
  * @category streaming
  * @since 4.1.0
  */
-void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
-    if (obs_frontend_streaming_active() == true) {
+	if (obs_frontend_streaming_active() == true) {
-        obs_frontend_streaming_stop();
+		obs_frontend_streaming_stop();
-        req->SendOKResponse();
+		return req->SendOKResponse();
-    } else {
+	} else {
-        req->SendErrorResponse("streaming not active");
+		return req->SendErrorResponse("streaming not active");
-    }
+	}
 }
 
 /**
@@ -198,51 +200,50 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
- void WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
-    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(req->data, "settings");
-    if (!requestSettings) {
+	if (!requestSettings) {
-        req->SendErrorResponse("'settings' are required'");
+		return req->SendErrorResponse("'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(req->data, "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 {
+	} else {
-        // If type isn't changing, we should overlay the settings we got
+		// If type isn't changing, we should overlay the settings we got
-        // to the existing settings. By doing so, you can send a request that
+		// to the existing settings. By doing so, you can send a request that
-        // only contains the settings you want to change, instead of having to
+		// only contains the settings you want to change, instead of having to
-        // do a get and then change them
+		// 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(req->data, "save")) {
-        obs_frontend_save_streaming_service();
+		obs_frontend_save_streaming_service();
-    }
+	}
 
-    OBSDataAutoRelease serviceSettings = obs_service_get_settings(service);
+	OBSDataAutoRelease serviceSettings = obs_service_get_settings(service);
 
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_string(response, "type", requestedType.toUtf8());
+	obs_data_set_string(response, "type", requestedType.toUtf8());
-    obs_data_set_obj(response, "settings", serviceSettings);
+	obs_data_set_obj(response, "settings", serviceSettings);
 
-    req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }
 
 /**
@@ -252,7 +253,7 @@ 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.password` The password to use when accessing the streaming server. Only present if `use-auth` is `true`.
  *
@@ -261,17 +262,17 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
-    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 req->SendOKResponse(response);
 }
 
 /**
@@ -282,7 +283,36 @@ void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
-void WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) {
-    obs_frontend_save_streaming_service();
+	obs_frontend_save_streaming_service();
-    req->SendOKResponse();
+	return req->SendOKResponse();
 }
+
+
+/**
+ * Send the provided text as embedded CEA-608 caption data.
+ * As of OBS Studio 23.1, captions are not yet available on Linux.
+ *
+ * @param {String} `text` Captions text
+ *
+ * @api requests
+ * @name SendCaptions
+ * @category streaming
+ * @since 4.6.0
+ */
+#if BUILD_CAPTIONS
+HandlerResponse WSRequestHandler::HandleSendCaptions(WSRequestHandler* req) {
+	if (!req->hasField("text")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	OBSOutputAutoRelease output = obs_frontend_get_streaming_output();
+	if (output) {
+		const char* caption = obs_data_get_string(req->data, "text");
+		obs_output_output_caption_text1(output, caption);
+	}
+
+	return req->SendOKResponse();
+}
+#endif
+

src/WSRequestHandler_StudioMode.cpp

@@ -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) {
+HandlerResponse WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* req) {
-    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 req->SendOKResponse(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) {
+HandlerResponse WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
-    if (!obs_frontend_preview_program_mode_active()) {
+	if (!obs_frontend_preview_program_mode_active()) {
-        req->SendErrorResponse("studio mode not enabled");
+		return req->SendErrorResponse("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 req->SendOKResponse(data);
 }
 
 /**
@@ -61,26 +59,23 @@ void WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
-    if (!obs_frontend_preview_program_mode_active()) {
+	if (!obs_frontend_preview_program_mode_active()) {
-        req->SendErrorResponse("studio mode not enabled");
+		return req->SendErrorResponse("studio mode not enabled");
-        return;
+	}
-    }
 
-    if (!req->hasField("scene-name")) {
+	if (!req->hasField("scene-name")) {
-        req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-        return;
+	}
-    }
 
-    const char* scene_name = obs_data_get_string(req->data, "scene-name");
+	const char* scene_name = obs_data_get_string(req->data, "scene-name");
-    OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(scene_name);
+	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(scene_name);
+	if (!scene) {
+		return req->SendErrorResponse("specified scene doesn't exist");
+	}
 
-    if (scene) {
+	obs_frontend_set_current_preview_scene(scene);
-        obs_frontend_set_current_preview_scene(scene);
+	return req->SendOKResponse();
-        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) {
+HandlerResponse WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
-    if (!obs_frontend_preview_program_mode_active()) {
+	if (!obs_frontend_preview_program_mode_active()) {
-        req->SendErrorResponse("studio mode not enabled");
+		return req->SendErrorResponse("studio mode not enabled");
-        return;
+	}
-    }
 
-    if (req->hasField("with-transition")) {
+	if (req->hasField("with-transition")) {
-        OBSDataAutoRelease transitionInfo =
+		OBSDataAutoRelease transitionInfo =
-            obs_data_get_obj(req->data, "with-transition");
+			obs_data_get_obj(req->data, "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 req->SendErrorResponse("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 req->SendErrorResponse("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);
+			Utils::SetTransitionDuration(transitionDuration);
-        }
+		}
-    }
+	}
 
-    Utils::TransitionToProgram();
+	Utils::TransitionToProgram();
-    req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -140,9 +132,9 @@ void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
-    obs_frontend_set_preview_program_mode(true);
+	obs_frontend_set_preview_program_mode(true);
-    req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -153,9 +145,9 @@ void WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
-    obs_frontend_set_preview_program_mode(false);
+	obs_frontend_set_preview_program_mode(false);
-    req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -166,8 +158,8 @@ void WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) {
-    bool previewProgramMode = obs_frontend_preview_program_mode_active();
+	bool previewProgramMode = obs_frontend_preview_program_mode_active();
-    obs_frontend_set_preview_program_mode(!previewProgramMode);
+	obs_frontend_set_preview_program_mode(!previewProgramMode);
-    req->SendOKResponse();
+	return req->SendOKResponse();
 }

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) {
+HandlerResponse WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req) {
-    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 req->SendOKResponse(response);
 }
 
 /**
@@ -49,17 +48,17 @@
  * @category transitions
  * @since 0.3
  */
-void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
-    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", Utils::GetTransitionDuration());
 
-    req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }
 
 /**
@@ -72,18 +71,18 @@ void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
  * @category transitions
  * @since 0.3
  */
-void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
-    if (!req->hasField("transition-name")) {
+	if (!req->hasField("transition-name")) {
-        req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-        return;
+	}
-    }
 
-    QString name = obs_data_get_string(req->data, "transition-name");
+	QString name = obs_data_get_string(req->data, "transition-name");
-    bool success = Utils::SetTransitionByName(name);
+	bool success = Utils::SetTransitionByName(name);
-    if (success)
+	if (!success) {
-        req->SendOKResponse();
+		return req->SendErrorResponse("requested transition does not exist");
-    else
+	}
-        req->SendErrorResponse("requested transition does not exist");
+	
+	return req->SendOKResponse();
 }
 
 /**
@@ -96,15 +95,14 @@ void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
  * @category transitions
  * @since 4.0.0
  */
-void WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
-    if (!req->hasField("duration")) {
+	if (!req->hasField("duration")) {
-        req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-        return;
+	}
-    }
 
-    int ms = obs_data_get_int(req->data, "duration");
+	int ms = obs_data_get_int(req->data, "duration");
-    Utils::SetTransitionDuration(ms);
+	Utils::SetTransitionDuration(ms);
-    req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -117,10 +115,8 @@ void WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
  * @category transitions
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) {
-    OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease response = obs_data_create();
-    obs_data_set_int(response, "transition-duration",
+	obs_data_set_int(response, "transition-duration", Utils::GetTransitionDuration());
-        Utils::GetTransitionDuration());
+	return req->SendOKResponse(response);
-
-    req->SendOKResponse(response);
 }

src/WSServer.cpp

@@ -16,12 +16,16 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#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"
@@ -30,139 +34,181 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 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.init_asio();
-        QStringLiteral("obs-websocket"),
+#ifndef _WIN32
-        QWebSocketServer::NonSecureMode);
+	_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);
+		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(std::string message)
-    QMutexLocker locker(&_clMutex);
+{
-    for(QWebSocket* pClient : _clients) {
+	QMutexLocker locker(&_clMutex);
-        if (Config::Current()->AuthRequired
+	for (connection_hdl hdl : _connections) {
-            && (pClient->property(PROP_AUTHENTICATED).toBool() == false)) {
+		if (GetConfig()->AuthRequired) {
-            // Skip this client if unauthenticated
+			bool authenticated = _connectionProperties[hdl].isAuthenticated();
-            continue;
+			if (!authenticated) {
-        }
+				continue;
-        pClient->sendTextMessage(message);
+			}
-    }
+		}
+		_server.send(hdl, message, websocketpp::frame::opcode::text);
+	}
 }
 
-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();
+
+		WSRequestHandler handler(connProperties);
+		std::string response = handler.processIncomingMessage(payload);
+
+		_server.send(hdl, response, websocketpp::frame::opcode::text);
+	});
 }
 
-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,57 @@ 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"
 
 QT_FORWARD_DECLARE_CLASS(QWebSocketServer)
 QT_FORWARD_DECLARE_CLASS(QWebSocket)
 
-class WSServer : public QObject {
+using websocketpp::connection_hdl;
-  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:
+typedef websocketpp::server<websocketpp::config::asio> server;
-    void onNewConnection();
-    void onTextMessageReceived(QString message);
-    void onSocketDisconnected();
 
-  private:
+class WSServer : public QObject
-    QWebSocketServer* _wsServer;
+{
-    QList<QWebSocket*> _clients;
+Q_OBJECT
-    QMutex _clMutex;
+
+public:
+	explicit WSServer();
+	virtual ~WSServer();
+	void start(quint16 port);
+	void stop();
+	void broadcast(std::string message);
+	QThreadPool* threadPool() {
+		return &_threadPool;
+	}
+
+private:
+	void onOpen(connection_hdl hdl);
+	void onMessage(connection_hdl hdl, server::message_ptr message);
+	void onClose(connection_hdl hdl);
+
+	QString getRemoteEndpoint(connection_hdl hdl);
+	void notifyConnection(QString clientIp);
+	void notifyDisconnection(QString clientIp);
+
+	server _server;
+	quint16 _serverPort;
+	std::set<connection_hdl, std::owner_less<connection_hdl>> _connections;
+	std::map<connection_hdl, ConnectionProperties, std::owner_less<connection_hdl>> _connectionProperties;
+	QMutex _clMutex;
+	QThreadPool _threadPool;
 };
-
-#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,10 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 #include <obs-module.h>
 #include <obs-frontend-api.h>
-#include <QAction>
+
-#include <QMainWindow>
+#include <QtCore/QTimer>
-#include <QTimer>
+#include <QtWidgets/QAction>
+#include <QtWidgets/QMainWindow>
 
 #include "obs-websocket.h"
 #include "WSServer.h"
@@ -37,44 +38,67 @@ void ___output_dummy_addref(obs_output_t*) {}
 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)
+	if (_config->ServerEnabled) {
-        WSServer::Instance->Start(config->ServerPort);
+		_server->start(_config->ServerPort);
+	}
 
-    // UI setup
+	// UI setup
-    QAction* menu_action = (QAction*)obs_frontend_add_tools_menu_qaction(
+	obs_frontend_push_ui_translation(obs_module_get_string);
-        obs_module_text("OBSWebsocket.Menu.SettingsItem"));
+	QMainWindow* mainWindow = (QMainWindow*)obs_frontend_get_main_window();
+	SettingsDialog* settingsDialog = new SettingsDialog(mainWindow);
+	obs_frontend_pop_ui_translation();
 
-    obs_frontend_push_ui_translation(obs_module_get_string);
+	const char* menuActionText =
-    QMainWindow* main_window = (QMainWindow*)obs_frontend_get_main_window();
+		obs_module_text("OBSWebsocket.Settings.DialogTitle");
-    settings_dialog = new SettingsDialog(main_window);
+	QAction* menuAction =
-    obs_frontend_pop_ui_translation();
+		(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();
+	});
 
-    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,19 @@ using OBSDataArrayAutoRelease =
 using OBSOutputAutoRelease =
 	OBSRef<obs_output_t*, ___output_dummy_addref, obs_output_release>;
 
-#define PROP_AUTHENTICATED "wsclient_authenticated"
+class Config;
-#define OBS_WEBSOCKET_VERSION "4.4.0"
+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.6.1"
 
 #define blog(level, msg, ...) blog(level, "[obs-websocket] " msg, ##__VA_ARGS__)
-
-#endif // OBSWEBSOCKET_H