Release/1.0.0 rc2 (#12)

* Adds handler for auth code timeout on login.
* Fixes saving of scene collection immediately before export.
* Updates UI strings.
* Replaces install type step in setup wizard with 'Start Install' screen.
* Fixes typo in name-in-use error dialog.

Author: FiniteSingularity

data/locale/en-US.ini

@@ -1,61 +1,66 @@
 General.SaveButton="Save"
+General.SaveChangesButton="Save Changes"
 General.CancelButton="Cancel"
-MarketplaceWindow.LoginButton.LogIn="Log In"
+MarketplaceWindow.LoginButton.LogIn="Sign In"
 MarketplaceWindow.LoginButton.LogOut="Sign Out"
 MarketplaceWindow.OpenSettingsButton.Tooltip="Open Settings"
 MarketplaceWindow.StoreButton.Tooltip="Go to Elgato Marketplace"
 MarketplaceWindow.DownloadButton.Tooltip="Click to Download"
-MarketplaceWindow.PurchasedTab="Purchased"
+MarketplaceWindow.PurchasedTab="Products"
 MarketplaceWindow.Purchased.NoPurchasesTitle="You don't own any scene collection products yet"
 MarketplaceWindow.Purchased.NoPurchasesSubtitle="Your digital assets from Marketplace will appear here"
-MarketplaceWindow.LoginNeeded.Title="Please Log In"
-MarketplaceWindow.LoginNeeded.Subtitle="Click the Log In button above to log into your account and begin using the Elgato Marketplace plugin."
+MarketplaceWindow.LoginNeeded.Title="Sign in to get started"
+MarketplaceWindow.LoginNeeded.Subtitle="First off, let's connect your Marketplace account with OBS Studio"
+MarketplaceWindow.LoginError.Title="Login Error"
+MarketplaceWindow.LoginError.Subtitle="There was an error logging you in. Please click the Log In button above to try again."
 MarketplaceWindow.ConnectionError.Title="Connection Error"
 MarketplaceWindow.ConnectionError.Subtitle="Could not connect to the server. (please check your network connection)"
 MarketplaceWindow.Loading.Title="Loading Your Purchased Products..."
 MarketplaceWindow.Settings.Title="Settings"
-MarketplaceWindow.Settings.DefaultVideoDevice.Label="Default Video Device"
+MarketplaceWindow.Settings.DefaultVideoDevice.Label="Default camera"
 MarketplaceWindow.Settings.DefaultVideoDevice.NoneSelected="None Selected"
 MarketplaceWindow.Settings.DefaultVideoDevice.SettingsButton.Tooltip="Video Capture Device Settings"
-MarketplaceWindow.Settings.DefaultAudioDevice.Label="Default Audio Device"
+MarketplaceWindow.Settings.DefaultAudioDevice.Label="Default microphone"
 MarketplaceWindow.Settings.InstallLocation="Medial File Install Location"
-MarketplaceWindow.Settings.EnableMakerTools="Enable Maker Tools"
+MarketplaceWindow.Settings.EnableMakerTools="Turn on Maker tools"
 MarketplaceWindow.Settings.MakerToolsRestartWarning.Disabled="Maker tools will be disabled after restarting OBS."
 MarketplaceWindow.Settings.MakerToolsRestartWarning.Enabled="Maker tools will be enabled after restarting OBS."
 MarketplaceWindow.DownloadProduct.NetworkError.Title="Network Connection Error"
 MarketplaceWindow.DownloadProduct.NetworkError.Subtitle="Could not connect to the Marketplace. Please try again."
 MarketplaceWindow.DownloadProduct.InvalidFiletype.Title="Invalid File Type"
 MarketplaceWindow.DownloadProduct.InvalidFiletype.Subtitle="File is not an .elgatoscene file."
-ExportWizard.NextButton="Next"
+ExportWizard.NextButton="Continue"
 ExportWizard.BackButton="Back"
-ExportWizard.CloseButton="Close"
-ExportWizard.MediaFileCheck.Title="Media File Check"
-ExportWizard.MediaFileCheck.Text=" media files were found to bundle.\nIf this is correct, click 'Next' below."
-ExportWizard.VideoSourceLabels.Title="Video Source Labels"
-ExportWizard.VideoSourceLabels.Text="Now go ahead and label your video sources."
+ExportWizard.SaveAsButton="Save as"
+ExportWizard.CloseButton="Done"
+ExportWizard.MediaFileCheck.Title="Review your export"
+ExportWizard.MediaFileCheck.Text=" media files were found to bundle."
+ExportWizard.VideoSourceLabels.Title="Name video sources"
+ExportWizard.VideoSourceLabels.Text="Choose how your video sources will appear for users"
 ExportWizard.VideoSourceLabels.InputPlaceholder="Description text goes here"
 ExportWizard.VideoSourceLabels.NoCaptureSourcesText="No video capture sources found."
-ExportWizard.RequiredPlugins.Title="Required Plug-ins"
-ExportWizard.RequiredPlugins.Text="Please select all plugins that are required to use this scene collection."
+ExportWizard.RequiredPlugins.Title="Add required plugins"
+ExportWizard.RequiredPlugins.Text="Select any plugins needed to run this asset"
 ExportWizard.RequiredPlugins.NoPluginsFound="No installed plugins found."
-ExportWizard.ExportComplete.Title="Scene Bundle Exported"
-ExportWizard.ExportComplete.Text="Bundle successfully exported. Click 'Close' below to close this window."
+ExportWizard.ExportComplete.Title="Export complete"
+ExportWizard.ExportComplete.Text="Bundle successfully exported. Click 'Done' below to close this window."
 ExportWizard.Exporting.Title="Exporting Bundle..."
 ExportWizard.Exporting.Text="Note: this can take a few minutes for scene collections with large files."
 SetupWizard.WindowTitle="Install Scene Collection"
-SetupWizard.NextButton="Next"
+SetupWizard.NextButton="Continue"
 SetupWizard.BackButton="Back"
-SetupWizard.MissingPlugins.Title="Missing Plugins"
-SetupWizard.MissingPlugins.Text="The following plugins are required to use this scene collection, but are not installed. Please install these plugins, restart OBS and attempt to install again."
-SetupWizard.MissingPlugins.DownloadButton="Download"
-SetupWizard.SelectInstall.Title="Select Install"
+SetupWizard.StartInstall.Title="Start install"
+SetupWizard.MissingPlugins.Title="You're missing something"
+SetupWizard.MissingPlugins.Text="To continue, download the following free plugins, then restart OBS and try again"
+SetupWizard.MissingPlugins.DownloadButton="Get"
+SetupWizard.SelectInstall.Title="How do you want to install this?"
 SetupWizard.SelectInstall.NewInstallButton="New"
-SetupWizard.SelectInstall.ExistingInstallButton="New"
+SetupWizard.SelectInstall.ExistingInstallButton="Add"
 SetupWizard.CreateCollection.Title="Create Scene Collection"
 SetupWizard.CreateCollection.NewNamePlaceholder="Collection Name"
-SetupWziard.NameInUseError.Title="Name in use."
+SetupWizard.NameInUseError.Title="Name in use."
 SetupWizard.NameInUseError.Text="A scene collection already exists with this name. Please provide another name."
-SetupWizard.AudioSetup.Device.Text="Audio Device"
+SetupWizard.AudioSetup.Device.Text="Select a microphone"
 SetupWizard.Loading.Title="Loading Collection..."
 SetupWizard.Loading.Text="Note: this can take some time for scene collections with large files."
 SetupWizard.IncompatibleFile.Title="Incompatible file"

src/elgato-cloud-data.cpp

@@ -182,13 +182,21 @@ void ElgatoCloud::_Listen()
 				auto response = fetch_string_from_post(
 					url, encodeddata);
 
-				auto responseJson =
-					nlohmann::json::parse(response);
-				obs_log(LOG_INFO,
-					"Access and refresh token fetched from login.");
-
-				_ProcessLogin(responseJson);
-
+				auto responseJson = nlohmann::json::parse(response);
+
+				if (responseJson.contains("error")) {
+					if (mainWindowOpen && window) {
+						QMetaObject::invokeMethod(
+							QCoreApplication::instance()->thread(),
+							[this]() {
+								loginError = true;
+								window->setLoggedIn();
+							});
+					}
+				} else {
+					loginError = false;
+					_ProcessLogin(responseJson);
+				}
 				authorizing = false;
 				return;
 			}
@@ -344,6 +352,7 @@ void ElgatoCloud::_ProcessLogin(nlohmann::json &loginData, bool loadData)
 {
 	try {
 		connectionError = false;
+		loginError = false;
 		const auto now = std::chrono::system_clock::now();
 		const auto epoch = now.time_since_epoch();
 		const auto seconds =
@@ -371,9 +380,11 @@ void ElgatoCloud::_ProcessLogin(nlohmann::json &loginData, bool loadData)
 	} catch (const nlohmann::json::out_of_range &e) {
 		obs_log(LOG_INFO, "Bad Login, %i not found", e.id);
 		connectionError = true;
+		return;
 	} catch (...) {
 		obs_log(LOG_INFO, "Some other issue occurred");
 		connectionError = true;
+		return;
 	}
 	_LoadUserData(loadData);
 }

src/elgato-cloud-data.hpp

@@ -61,6 +61,7 @@ class ElgatoCloud {
 	bool loading = false;
 	bool authorizing = false;
 	bool connectionError = false;
+	bool loginError = false;
 
 	void Thread();
 	bool mainWindowOpen = false;

src/elgato-cloud-window.cpp

@@ -510,6 +510,9 @@ void ElgatoCloudWindow::initialize()
 	auto loadingWidget = new LoadingWidget(this); // Loading widget, id: 3
 	_stackedContent->addWidget(loadingWidget);
 
+	auto loginErrorWidget = new LoginError(this); // Login error widget, id: 4
+	_stackedContent->addWidget(loginErrorWidget);
+
 	mainLayout->addWidget(_stackedContent);
 	_mainWidget->setLayout(mainLayout);
 
@@ -537,6 +540,8 @@ void ElgatoCloudWindow::setLoggedIn()
 {
 	if (elgatoCloud->connectionError) {
 		_stackedContent->setCurrentIndex(2);
+	} else if (elgatoCloud->loginError) {
+		_stackedContent->setCurrentIndex(4);
 	} else if (!elgatoCloud->loggedIn) {
 		_stackedContent->setCurrentIndex(1);
 	} else if (elgatoCloud->loading) {
@@ -706,6 +711,26 @@ LoginNeeded::LoginNeeded(QWidget *parent) : QWidget(parent)
 	layout->addStretch();
 }
 
+LoginError::LoginError(QWidget* parent) : QWidget(parent)
+{
+	auto layout = new QVBoxLayout(this);
+
+	auto login = new QLabel(this);
+	login->setText(obs_module_text("MarketplaceWindow.LoginError.Title"));
+	login->setStyleSheet("QLabel {font-size: 18pt;}");
+	login->setAlignment(Qt::AlignCenter);
+
+	auto loginSub = new QLabel(this);
+	loginSub->setText(obs_module_text("MarketplaceWindow.LoginError.Subtitle"));
+	loginSub->setWordWrap(true);
+	loginSub->setAlignment(Qt::AlignCenter);
+
+	layout->addStretch();
+	layout->addWidget(login);
+	layout->addWidget(loginSub);
+	layout->addStretch();
+}
+
 ConnectionError::ConnectionError(QWidget *parent) : QWidget(parent)
 {
 	auto layout = new QVBoxLayout(this);

src/elgato-cloud-window.hpp

@@ -177,6 +177,12 @@ class LoginNeeded : public QWidget {
 	LoginNeeded(QWidget *parent);
 };
 
+class LoginError : public QWidget {
+	Q_OBJECT
+public:
+	LoginError(QWidget* parent);
+};
+
 class ConnectionError : public QWidget {
 	Q_OBJECT
 public:

src/export-wizard.cpp

@@ -1,3 +1,21 @@
+/*
+Elgato Deep-Linking OBS Plug-In
+Copyright (C) 2024 Corsair Memory Inc. oss.elgato@corsair.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 <algorithm>
 
 #include "export-wizard.hpp"
@@ -387,13 +405,23 @@ Exporting::~Exporting() {}
 StreamPackageExportWizard::StreamPackageExportWizard(QWidget *parent)
 	: QDialog(parent),
 	  _steps(nullptr)
+{
+	// Save the current scene collection to ensure our output is the latest
+	obs_frontend_save();
+
+	// Since scene collection save is threaded as a Queued connection
+	// queue the SetupUI to execute *after* the frontend is completely saved.
+	QMetaObject::invokeMethod(this, "SetupUI", Qt::QueuedConnection);
+}
+
+void StreamPackageExportWizard::SetupUI()
 {
 	obs_enum_modules(StreamPackageExportWizard::AddModule, this);
 	setWindowTitle("Elgato Marketplace Scene Collection Export");
 	setStyleSheet("background-color: #232323");
 	std::string homeDir = QDir::homePath().toStdString();
 
-	char *currentCollection = obs_frontend_get_current_scene_collection();
+	char* currentCollection = obs_frontend_get_current_scene_collection();
 	std::string collectionName = currentCollection;
 	bfree(currentCollection);
 
@@ -404,7 +432,7 @@ StreamPackageExportWizard::StreamPackageExportWizard(QWidget *parent)
 	std::map<std::string, std::string> vidDevs =
 		bundle->VideoCaptureDevices();
 
-	QVBoxLayout *layout = new QVBoxLayout(this);
+	QVBoxLayout* layout = new QVBoxLayout(this);
 	_steps = new QStackedWidget(this);
 
 	// Step 1- check the media files to be bundled (step index: 0)
@@ -428,7 +456,7 @@ StreamPackageExportWizard::StreamPackageExportWizard(QWidget *parent)
 	connect(reqPlugins, &RequiredPlugins::continuePressed, this, [this, videoLabels, reqPlugins]() {
 		auto vidDevLabels = videoLabels->Labels();
 		auto plugins = reqPlugins->RequiredPluginList();
-		QWidget *window = (QWidget *)obs_frontend_get_main_window();
+		QWidget* window = (QWidget*)obs_frontend_get_main_window();
 		QString filename = QFileDialog::getSaveFileName(
 			window, "Save As...", QString(), "*.elgatoscene");
 		if (filename == "") {
@@ -445,33 +473,34 @@ StreamPackageExportWizard::StreamPackageExportWizard(QWidget *parent)
 		// installer handler thread handling object.
 		_future =
 			QtConcurrent::run(createBundle, filename_utf8, plugins,
-					  vidDevLabels)
-				.then([this](SceneBundleStatus status) {
-					// We are now in a different thread, so we need to execute this
-					// back in the gui thread.  See, threading hell.
-					QMetaObject::invokeMethod(
-						QCoreApplication::instance()
-							->thread(), // main GUI thread
-						[this, status]() {
-							if (status ==
-							    SceneBundleStatus::
-								    Success) {
-								_steps->setCurrentIndex(
-									4);
-							} else if (
-								status ==
-								SceneBundleStatus::
-									Cancelled) {
-								_steps->setCurrentIndex(
-									2);
-							}
-						});
+				vidDevLabels)
+			.then([this](SceneBundleStatus status) {
+			// We are now in a different thread, so we need to execute this
+			// back in the gui thread.  See, threading hell.
+			QMetaObject::invokeMethod(
+				QCoreApplication::instance()
+				->thread(), // main GUI thread
+				[this, status]() {
+					if (status ==
+						SceneBundleStatus::
+						Success) {
+						_steps->setCurrentIndex(
+							4);
+					}
+					else if (
+						status ==
+						SceneBundleStatus::
+						Cancelled) {
+						_steps->setCurrentIndex(
+							2);
+					}
+				});
 				})
-				.onCanceled([]() {
+			.onCanceled([]() {
 
 				});
 		//createBundle(filename_utf8, plugins, vidDevLabels);
-	});
+		});
 	connect(reqPlugins, &RequiredPlugins::backPressed, this,
 		[this]() { _steps->setCurrentIndex(1); });
 	_steps->addWidget(reqPlugins);

src/export-wizard.hpp

@@ -110,11 +110,15 @@ class StreamPackageExportWizard : public QDialog {
 
 	static void AddModule(void *data, obs_module_t *module);
 
+public slots:
+	void SetupUI();
+
 private:
 	QStackedWidget *_steps;
 	SceneBundle _bundle;
 	std::vector<obs_module_t *> _modules;
 	QFuture<void> _future;
+	bool _waiting;
 };
 
 void OpenExportWizard();

src/scene-bundle.cpp

@@ -71,8 +71,6 @@ bool SceneBundle::FromCollection(std::string collection_name)
 	std::string collection_file_path = scene_collections_path + file_name;
 	blog(LOG_INFO, "COLLECTION FILE PATH: %s",
 	     collection_file_path.c_str());
-	// Save the current scene collection to ensure our output is the latest
-	obs_frontend_save();
 
 	// Load the current collection file into a json object
 	char *collection_str =
@@ -127,7 +125,7 @@ std::string SceneBundle::ExtractBundleInfo(std::string filePath)
 void SceneBundle::SceneCollectionCreated(enum obs_frontend_event event,
 					 void *obj)
 {
-	if (event == OBS_FRONTEND_EVENT_SCENE_COLLECTION_LIST_CHANGED) {
+	if (event == OBS_FRONTEND_EVENT_SCENE_COLLECTION_CHANGED) {
 		auto inst = static_cast<SceneBundle *>(obj);
 		if (inst) {
 			inst->_waiting = false;
@@ -205,6 +203,9 @@ void SceneBundle::ToCollection(std::string collection_name,
 	newCollectionFileName =
 		get_scene_collections_path() + newCollectionFileName;
 
+	//config_set_string(userConf, "Basic", "SceneCollection", "elgatompplugintemp");
+	//config_set_string(userConf, "Basic", "SceneCollectionFile", "elgatompplugintemp");
+
 	// 7. Set waiting to true to block execution until we switch back to the old scene collection
 	_waiting = true;