UI: PreStream Wizard add completion page

Adds a completion page with content that depends on destinations. Back
button is disabled on the last page where application will take place
since updating settings is undoable. Various code fixes.

Author: JohannMG

UI/CMakeLists.txt

@@ -195,6 +195,7 @@ set(obs_SOURCES
 	pre-stream-wizard/page-input-display.cpp
 	pre-stream-wizard/page-start-prompt.cpp
 	pre-stream-wizard/page-select-settings.cpp
+	pre-stream-wizard/page-completed.cpp
 	pre-stream-wizard/setting-selection-row.cpp
 	pre-stream-wizard/encoder-settings-provider-facebook.cpp
 	obs-app.cpp
@@ -274,6 +275,7 @@ set(obs_HEADERS
 	pre-stream-wizard/page-input-display.hpp
 	pre-stream-wizard/page-start-prompt.hpp
 	pre-stream-wizard/page-select-settings.hpp
+	pre-stream-wizard/page-completed.hpp
 	pre-stream-wizard/setting-selection-row.hpp
 	pre-stream-wizard/encoder-settings-provider-facebook.hpp
 	obs-app.hpp

UI/common-settings.cpp

@@ -2,7 +2,7 @@
 
 #include "audio-encoders.hpp"
 
-bool IsAdvancedMode(config_t *config)
+static bool IsAdvancedMode(config_t *config)
 {
 	const char *outputMode = config_get_string(config, "Output", "Mode");
 	return (strcmp(outputMode, "Advanced") == 0);
@@ -16,7 +16,7 @@ OBSData CommonSettings::GetDataFromJsonFile(const char *jsonFile)
 	int ret = GetProfilePath(fullPath, sizeof(fullPath), jsonFile);
 	if (ret > 0) {
 		BPtr<char> jsonData = os_quick_read_utf8_file(fullPath);
-		if (!!jsonData) {
+		if (jsonData) {
 			data = obs_data_create_from_json(jsonData);
 		}
 	}
@@ -145,7 +145,7 @@ int CommonSettings::GetStreamingAudioBitrate(config_t *config)
 
 int CommonSettings::GetSimpleAudioBitrate(config_t *config)
 {
-	int bitrate = (int)config_get_uint(config, "SimpleOutput", "ABitrate");
+	int bitrate = config_get_uint(config, "SimpleOutput", "ABitrate");
 	return FindClosestAvailableAACBitrate(bitrate);
 }
 
@@ -163,9 +163,11 @@ int CommonSettings::GetAdvancedAudioBitrateForTrack(config_t *config,
 		"Track4Bitrate", "Track5Bitrate", "Track6Bitrate",
 	};
 
-	// Sanity check for out of bounds
+	// Sanity check for out of bounds, clamp to bounds
 	if (trackIndex > 5)
 		trackIndex = 5;
+	if (trackIndex < 0)
+		trackIndex = 0;
 
 	int bitrate = (int)config_get_uint(config, "AdvOut", names[trackIndex]);
 	return FindClosestAvailableAACBitrate(bitrate);

UI/data/locale/en-US.ini

@@ -727,7 +727,9 @@ PreLiveWizard.Configure.Error.JsonParse="Problem with server response"
 PreLiveWizard.Configure.Error.JsonParse.Description="Wizard is unavailble at the moment."
 PreLiveWizard.Selection.Title="Settings Suggested"
 PreLiveWizard.Selection.Description="Suggested video settings for your best stream."
-
+PreLiveWizard.Completed.Title="Encoder configured"
+PreLiveWizard.Completed.BodyText="Applied suggested settings and encoder is setup to stream. You can now close the wizard."
+PreLiveWizard.Completed.FacebookOnly="To finish going live go to Facebook Live:"
 
 # basic mode 'output' settings
 Basic.Settings.Output="Output"

UI/pre-stream-wizard/encoder-settings-provider-facebook.cpp

@@ -12,7 +12,6 @@
 #include <QJsonObject>
 #include <QJsonArray>
 #include <QMap>
-#include <QDebug>
 
 #include "obs-app.hpp"
 #include "obs-config.h"
@@ -57,7 +56,7 @@ void FacebookEncoderSettingsProvider::makeRequest(QUrl &url)
 			  "application/json");
 
 	// GET is made async
-	settingsReply_ = restclient_->get(request);
+	restclient_->get(request);
 	// This is the callback when data is ready
 	connect(restclient_, &QNetworkAccessManager::finished, this,
 		&FacebookEncoderSettingsProvider::handleResponse);
@@ -66,7 +65,7 @@ void FacebookEncoderSettingsProvider::makeRequest(QUrl &url)
 QUrlQuery FacebookEncoderSettingsProvider::inputVideoQueryFromCurrentSettings()
 {
 	// Get input settings, shorten name
-	EncoderSettingsRequest *input = currentSettings_.get();
+	EncoderSettingsRequest *input = currentSettings_.data();
 
 	QUrlQuery inputVideoSettingsQuery;
 	inputVideoSettingsQuery.addQueryItem("video_type", "live");
@@ -126,6 +125,10 @@ void addInt(const QJsonObject &json, const char *jsonKey, SettingsMap *map,
 	if (json[jsonKey].isDouble()) {
 		map->insert(mapKey,
 			    QPair(QVariant(json[jsonKey].toInt()), true));
+	} else {
+		blog(LOG_WARNING,
+		     "FacebookEncoderSettingsProvider could not parse %s to Int",
+		     jsonKey);
 	}
 }
 
@@ -140,6 +143,10 @@ void addStringDouble(const QJsonObject &json, const char *jsonKey,
 	double numberValue = valueString.toDouble(&converted);
 	if (converted) {
 		map->insert(mapKey, QPair(QVariant(numberValue), true));
+	} else {
+		blog(LOG_WARNING,
+		     "FacebookEncoderSettingsProvider couldn't parse %s to Double from String",
+		     jsonKey);
 	}
 }
 
@@ -149,6 +156,10 @@ void addQString(const QJsonObject &json, const char *jsonKey, SettingsMap *map,
 	if (json[jsonKey].isString()) {
 		map->insert(mapKey,
 			    QPair(QVariant(json[jsonKey].toString()), true));
+	} else {
+		blog(LOG_WARNING,
+		     "FacebookEncoderSettingsProvider could not parse %s to Strng",
+		     jsonKey);
 	}
 }
 
@@ -158,6 +169,10 @@ void addBool(const QJsonObject &json, const char *jsonKey, SettingsMap *map,
 	if (json[jsonKey].isBool()) {
 		map->insert(mapKey,
 			    QPair(QVariant(json[jsonKey].toBool()), true));
+	} else {
+		blog(LOG_WARNING,
+		     "FacebookEncoderSettingsProvider could not parse %s to Bool",
+		     jsonKey);
 	}
 }
 

UI/pre-stream-wizard/encoder-settings-provider-facebook.hpp

@@ -37,7 +37,6 @@ class FacebookEncoderSettingsProvider : public QObject {
 private:
 	QSharedPointer<EncoderSettingsRequest> currentSettings_;
 	QNetworkAccessManager *restclient_;
-	QNetworkReply *settingsReply_;
 
 	void makeRequest(QUrl &url);
 	QUrlQuery inputVideoQueryFromCurrentSettings();

UI/pre-stream-wizard/page-completed.cpp

@@ -0,0 +1,69 @@
+#include "page-completed.hpp"
+
+#include <QVBoxLayout>
+#include <QLabel>
+#include <QPushButton>
+#include <QUrl>
+#include <QSpacerItem>
+#include <QDesktopServices>
+
+#include "obs-app.hpp"
+
+namespace StreamWizard {
+
+CompletedPage::CompletedPage(Destination destination,
+			     LaunchContext launchContext, QWidget *parent)
+	: QWizardPage(parent)
+{
+	destination_ = destination;
+	launchContext_ = launchContext;
+
+	setTitle(QTStr("PreLiveWizard.Completed.Title"));
+
+	QVBoxLayout *mainlayout = new QVBoxLayout(this);
+	setLayout(mainlayout);
+
+	// Later will suggest starting stream if launchContext is PreStream
+	QLabel *closeLabel =
+		new QLabel(QTStr("PreLiveWizard.Completed.BodyText"), this);
+	closeLabel->setWordWrap(true);
+	mainlayout->addWidget(closeLabel);
+
+	if (destination_ == Destination::Facebook) {
+		mainlayout->addSpacerItem(new QSpacerItem(12, 12));
+
+		QLabel *facebookGoLiveLabel = new QLabel(
+			QTStr("PreLiveWizard.Completed.FacebookOnly"), this);
+		facebookGoLiveLabel->setWordWrap(true);
+		QPushButton *launchButton = new QPushButton(
+			QTStr("PreLiveWizard.Prompt.FBResolutionHelpButton.FB"),
+			this);
+		launchButton->setToolTip(QTStr(
+			"PreLiveWizard.Prompt.FBResolutionHelpButton.FB.ToolTip"));
+		connect(launchButton, &QPushButton::clicked, this,
+			&CompletedPage::didPushOpenWebsite);
+
+		mainlayout->addWidget(facebookGoLiveLabel);
+		mainlayout->addWidget(launchButton);
+	}
+}
+
+void CompletedPage::didPushOpenWebsite()
+{
+	QUrl helpUrl;
+
+	// Prepare per-destination
+	if (destination_ == Destination::Facebook) {
+		helpUrl = QUrl(
+			"https://www.facebook.com/live/producer/?ref=OBS_Wizard",
+			QUrl::TolerantMode);
+	} else {
+		return;
+	}
+	// Launch
+	if (helpUrl.isValid()) {
+		QDesktopServices::openUrl(helpUrl);
+	}
+}
+
+} // namespace StreamWizard

UI/pre-stream-wizard/page-completed.hpp

@@ -0,0 +1,26 @@
+#pragma once
+
+#include <QWizardPage>
+
+#include "pre-stream-current-settings.hpp"
+
+namespace StreamWizard {
+
+// Last Page
+class CompletedPage : public QWizardPage {
+	Q_OBJECT
+
+public:
+	CompletedPage(Destination destination, LaunchContext launchContext,
+		      QWidget *parent = nullptr);
+
+private:
+	Destination destination_;
+	LaunchContext launchContext_;
+
+private slots:
+	void didPushOpenWebsite();
+
+}; // class CompletedPage
+
+} // namespace StreamWizard

UI/pre-stream-wizard/page-select-settings.cpp

@@ -16,11 +16,12 @@ SelectionPage::SelectionPage(QWidget *parent) : QWizardPage(parent)
 {
 	this->setTitle(QTStr("PreLiveWizard.Selection.Title"));
 	setupLayout();
-}
 
-SelectionPage::~SelectionPage()
-{
-	// nop
+	setButtonText(QWizard::WizardButton::NextButton,
+		      QTStr("Basic.AutoConfig.ApplySettings"));
+	setButtonText(QWizard::WizardButton::CommitButton,
+		      QTStr("Basic.AutoConfig.ApplySettings"));
+	setCommitPage(true);
 }
 
 void SelectionPage::setupLayout()
@@ -58,7 +59,7 @@ void SelectionPage::setSettingsMap(QSharedPointer<SettingsMap> settingsMap)
 		return;
 	}
 	settingsMap_ = settingsMap;
-	SettingsMap *mapInfo = settingsMap_.get();
+	SettingsMap *mapInfo = settingsMap_.data();
 
 	if (mapInfo->contains(SettingsResponseKeys.videoBitrate)) {
 		QVariant data =
@@ -190,7 +191,7 @@ void SelectionPage::checkboxRowChanged(const char *propertyKey, bool selected)
 		return;
 	}
 
-	SettingsMap *mapInfo = settingsMap_.get();
+	SettingsMap *mapInfo = settingsMap_.data();
 
 	if (mapInfo == nullptr || !mapInfo->contains(propertyKey)) {
 		return;

UI/pre-stream-wizard/page-select-settings.hpp

@@ -22,7 +22,6 @@ class SelectionPage : public QWizardPage {
 
 public:
 	SelectionPage(QWidget *parent = nullptr);
-	~SelectionPage();
 
 	// Sets data to layout scrollbox
 	void setSettingsMap(QSharedPointer<SettingsMap> settingsMap);

UI/pre-stream-wizard/page-start-prompt.cpp

@@ -39,12 +39,6 @@ StartPage::StartPage(Destination dest, LaunchContext launchContext,
 		resCurrentButton_->setChecked(true);
 	}
 }
-
-StartPage::~StartPage()
-{
-	// nop
-}
-
 void StartPage::createLayout()
 {
 	QVBoxLayout *mainlayout = new QVBoxLayout(this);