Files
obs-studio/frontend/OBSApp.cpp
PatTheMav 921dc93927 frontend: Fix macOS crash in application shutdown
With recent changes to the application shutdown logic, events had to
follow a very strict order as certain elements of shutdown code
depend on other elements not being deallocated prematurely.

This turned the (correct) order of events on macOS upside down and
lead to crashes either when the app was quit from within or when
terminated by the OS.

The fix incorporates multiple elements:

* Removal of the custom "Quit" menu item on macOS to use the default
  implementation of Qt's platform plugin.
* Soft-revert (via preprocessor conditionals) parts of the updated
  shutdown logic to prevent emitting recursive shutdown events.
* Handle main window close event by simply emitting a "quit" event
  on the application instance.
* Update POSIX signal handlers to also simply emit a "quit" event.

In combination these changes reduce the number of different code paths
taken during shutdown:

* Closing the app via the menu item, menu item shortcut, or initiated
  by AppKit (OS shutdown/reboot, or quit via Dock/Finder) will emit an
  AppKit "terminate" event for orderly shutdown.
* Closing the main window or sending an appropriate POSIX signal
  triggers the "terminate" event indirectly by emitting the "quit"
  event on the application instance.

Either way a "close" event to the main window happens before the
event loop is terminated and the application instance is torn down
(either directly, or indirectly via Qt's "closeAllWindows" function in
response to "terminate"). The order of events thus is always:

0. Terminate event by AppKit (except when closing the main window)
1. Closing of main window
2. Termination of browser docks
3. Deallocation of main window
4. Termination of application
5. Deallocation of application

NOTE: All this only applies to macOS. The shutdown order and procedures
on Windows and Linux are unchanged.
2026-02-04 17:04:31 -05:00

2001 lines
53 KiB
C++

/******************************************************************************
Copyright (C) 2023 by Lain Bailey <lain@obsproject.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 <http://www.gnu.org/licenses/>.
******************************************************************************/
#include "OBSApp.hpp"
#include <components/Multiview.hpp>
#include <dialogs/LogUploadDialog.hpp>
#include <plugin-manager/PluginManager.hpp>
#include <utility/CrashHandler.hpp>
#include <utility/OBSEventFilter.hpp>
#include <utility/OBSProxyStyle.hpp>
#if defined(_WIN32) || defined(ENABLE_SPARKLE_UPDATER)
#include <utility/models/branches.hpp>
#endif
#include <widgets/OBSBasic.hpp>
#if !defined(_WIN32) && !defined(__APPLE__)
#include <obs-nix-platform.h>
#if QT_VERSION < QT_VERSION_CHECK(6, 5, 0)
#include <qpa/qplatformnativeinterface.h>
#endif
#endif
#include <qt-wrappers.hpp>
#include <QCheckBox>
#include <QDesktopServices>
#if defined(_WIN32) || defined(ENABLE_SPARKLE_UPDATER)
#include <QFile>
#endif
#include <QSessionManager>
#ifndef _WIN32
#include <QSocketNotifier>
#endif
#include <chrono>
#ifdef _WIN32
#include <sstream>
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#else
#include <unistd.h>
#include <sys/socket.h>
#endif
#include "moc_OBSApp.cpp"
using namespace std;
string currentLogFile;
string lastLogFile;
string lastCrashLogFile;
extern bool portable_mode;
extern bool safe_mode;
extern bool multi;
extern bool disable_3p_plugins;
extern bool opt_disable_updater;
extern bool opt_disable_missing_files_check;
extern string opt_starting_collection;
extern string opt_starting_profile;
// GPU hint exports for AMD/NVIDIA laptops
#ifdef _MSC_VER
extern "C" __declspec(dllexport) DWORD NvOptimusEnablement = 1;
extern "C" __declspec(dllexport) int AmdPowerXpressRequestHighPerformance = 1;
#endif
namespace {
typedef struct UncleanLaunchAction {
bool useSafeMode = false;
bool sendCrashReport = false;
} UncleanLaunchAction;
UncleanLaunchAction handleUncleanShutdown(bool enableCrashUpload)
{
UncleanLaunchAction launchAction;
blog(LOG_WARNING, "Crash or unclean shutdown detected");
QMessageBox crashWarning;
crashWarning.setIcon(QMessageBox::Warning);
#if QT_VERSION >= QT_VERSION_CHECK(6, 6, 0)
crashWarning.setOption(QMessageBox::Option::DontUseNativeDialog);
#endif
crashWarning.setWindowTitle(QTStr("CrashHandling.Dialog.Title"));
crashWarning.setText(QTStr("CrashHandling.Labels.Text"));
if (enableCrashUpload) {
crashWarning.setInformativeText(QTStr("CrashHandling.Labels.PrivacyNotice"));
QCheckBox *sendCrashReportCheckbox = new QCheckBox(QTStr("CrashHandling.Checkbox.SendReport"));
crashWarning.setCheckBox(sendCrashReportCheckbox);
}
QPushButton *launchSafeButton =
crashWarning.addButton(QTStr("CrashHandling.Buttons.LaunchSafe"), QMessageBox::AcceptRole);
QPushButton *launchNormalButton =
crashWarning.addButton(QTStr("CrashHandling.Buttons.LaunchNormal"), QMessageBox::RejectRole);
crashWarning.setDefaultButton(launchNormalButton);
crashWarning.exec();
bool useSafeMode = crashWarning.clickedButton() == launchSafeButton;
if (useSafeMode) {
launchAction.useSafeMode = true;
blog(LOG_INFO, "[Safe Mode] Safe mode launch selected, loading third-party plugins is disabled");
} else {
blog(LOG_WARNING, "[Safe Mode] Normal launch selected, loading third-party plugins is enabled");
}
bool sendCrashReport = (enableCrashUpload) ? crashWarning.checkBox()->isChecked() : false;
if (sendCrashReport) {
launchAction.sendCrashReport = true;
blog(LOG_INFO, "User selected to send crash report");
}
return launchAction;
}
QAccessibleInterface *alignmentSelectorFactory(const QString &classname, QObject *object)
{
if (classname == QLatin1String("AlignmentSelector")) {
if (auto *w = qobject_cast<AlignmentSelector *>(object))
return new AccessibleAlignmentSelector(w);
}
return nullptr;
}
} // namespace
QObject *CreateShortcutFilter()
{
return new OBSEventFilter([](QObject *obj, QEvent *event) {
auto mouse_event = [](QMouseEvent &event) {
if (!App()->HotkeysEnabledInFocus() && event.button() != Qt::LeftButton)
return true;
obs_key_combination_t hotkey = {0, OBS_KEY_NONE};
bool pressed = event.type() == QEvent::MouseButtonPress;
switch (event.button()) {
case Qt::NoButton:
case Qt::LeftButton:
case Qt::RightButton:
case Qt::AllButtons:
case Qt::MouseButtonMask:
return false;
case Qt::MiddleButton:
hotkey.key = OBS_KEY_MOUSE3;
break;
#define MAP_BUTTON(i, j) \
case Qt::ExtraButton##i: \
hotkey.key = OBS_KEY_MOUSE##j; \
break;
MAP_BUTTON(1, 4);
MAP_BUTTON(2, 5);
MAP_BUTTON(3, 6);
MAP_BUTTON(4, 7);
MAP_BUTTON(5, 8);
MAP_BUTTON(6, 9);
MAP_BUTTON(7, 10);
MAP_BUTTON(8, 11);
MAP_BUTTON(9, 12);
MAP_BUTTON(10, 13);
MAP_BUTTON(11, 14);
MAP_BUTTON(12, 15);
MAP_BUTTON(13, 16);
MAP_BUTTON(14, 17);
MAP_BUTTON(15, 18);
MAP_BUTTON(16, 19);
MAP_BUTTON(17, 20);
MAP_BUTTON(18, 21);
MAP_BUTTON(19, 22);
MAP_BUTTON(20, 23);
MAP_BUTTON(21, 24);
MAP_BUTTON(22, 25);
MAP_BUTTON(23, 26);
MAP_BUTTON(24, 27);
#undef MAP_BUTTON
}
hotkey.modifiers = TranslateQtKeyboardEventModifiers(event.modifiers());
obs_hotkey_inject_event(hotkey, pressed);
return true;
};
auto key_event = [&](QKeyEvent *event) {
int key = event->key();
bool enabledInFocus = App()->HotkeysEnabledInFocus();
if (key != Qt::Key_Enter && key != Qt::Key_Escape && key != Qt::Key_Return && !enabledInFocus)
return true;
QDialog *dialog = qobject_cast<QDialog *>(obj);
obs_key_combination_t hotkey = {0, OBS_KEY_NONE};
bool pressed = event->type() == QEvent::KeyPress;
switch (key) {
case Qt::Key_Shift:
case Qt::Key_Control:
case Qt::Key_Alt:
case Qt::Key_Meta:
break;
#ifdef __APPLE__
case Qt::Key_CapsLock:
// kVK_CapsLock == 57
hotkey.key = obs_key_from_virtual_key(57);
pressed = true;
break;
#endif
case Qt::Key_Enter:
case Qt::Key_Escape:
case Qt::Key_Return:
if (dialog && pressed)
return false;
if (!enabledInFocus)
return true;
/* Falls through. */
default:
hotkey.key = obs_key_from_virtual_key(event->nativeVirtualKey());
}
if (event->isAutoRepeat())
return true;
hotkey.modifiers = TranslateQtKeyboardEventModifiers(event->modifiers());
obs_hotkey_inject_event(hotkey, pressed);
return true;
};
switch (event->type()) {
case QEvent::MouseButtonPress:
case QEvent::MouseButtonRelease:
return mouse_event(*static_cast<QMouseEvent *>(event));
/*case QEvent::MouseButtonDblClick:
case QEvent::Wheel:*/
case QEvent::KeyPress:
case QEvent::KeyRelease:
return key_event(static_cast<QKeyEvent *>(event));
default:
return false;
}
});
}
string CurrentDateTimeString()
{
time_t now = time(0);
struct tm tstruct;
char buf[80];
tstruct = *localtime(&now);
strftime(buf, sizeof(buf), "%Y-%m-%d, %X", &tstruct);
return buf;
}
#define DEFAULT_LANG "en-US"
#ifndef _WIN32
std::array<int, 2> OBSApp::sigIntFileDescriptor{0, 0};
std::array<int, 2> OBSApp::sigTermFileDescriptor{0, 0};
std::array<int, 2> OBSApp::sigAbrtFileDescriptor{0, 0};
std::array<int, 2> OBSApp::sigQuitFileDescriptor{0, 0};
#endif
bool OBSApp::InitGlobalConfigDefaults()
{
config_set_default_uint(appConfig, "General", "MaxLogs", 10);
config_set_default_int(appConfig, "General", "InfoIncrement", -1);
config_set_default_string(appConfig, "General", "ProcessPriority", "Normal");
config_set_default_bool(appConfig, "General", "EnableAutoUpdates", true);
#if _WIN32
config_set_default_string(appConfig, "Video", "Renderer", "Direct3D 11");
#else
#if defined(__APPLE__) && defined(__aarch64__)
// TODO: Change this value to "Metal" once the renderer has reached production quality
config_set_default_string(appConfig, "Video", "Renderer", "OpenGL");
#else
config_set_default_string(appConfig, "Video", "Renderer", "OpenGL");
#endif
#endif
#ifdef _WIN32
config_set_default_bool(appConfig, "Audio", "DisableAudioDucking", true);
#endif
#if defined(_WIN32) || defined(__APPLE__) || defined(__linux__)
config_set_default_bool(appConfig, "General", "BrowserHWAccel", true);
#endif
#ifdef __APPLE__
config_set_default_bool(appConfig, "Video", "DisableOSXVSync", true);
config_set_default_bool(appConfig, "Video", "ResetOSXVSyncOnExit", true);
#endif
return true;
}
bool OBSApp::InitGlobalLocationDefaults()
{
char path[512];
int len = GetAppConfigPath(path, sizeof(path), nullptr);
if (len <= 0) {
OBSErrorBox(NULL, "Unable to get global configuration path.");
return false;
}
config_set_default_string(appConfig, "Locations", "Configuration", path);
config_set_default_string(appConfig, "Locations", "SceneCollections", path);
config_set_default_string(appConfig, "Locations", "Profiles", path);
config_set_default_string(appConfig, "Locations", "PluginManagerSettings", path);
return true;
}
void OBSApp::InitUserConfigDefaults()
{
config_set_default_bool(userConfig, "General", "ConfirmOnExit", true);
config_set_default_string(userConfig, "General", "HotkeyFocusType", "NeverDisableHotkeys");
config_set_default_bool(userConfig, "BasicWindow", "PreviewEnabled", true);
config_set_default_bool(userConfig, "BasicWindow", "PreviewProgramMode", false);
config_set_default_bool(userConfig, "BasicWindow", "SceneDuplicationMode", true);
config_set_default_bool(userConfig, "BasicWindow", "SwapScenesMode", true);
config_set_default_bool(userConfig, "BasicWindow", "SnappingEnabled", true);
config_set_default_bool(userConfig, "BasicWindow", "ScreenSnapping", true);
config_set_default_bool(userConfig, "BasicWindow", "SourceSnapping", true);
config_set_default_bool(userConfig, "BasicWindow", "CenterSnapping", false);
config_set_default_double(userConfig, "BasicWindow", "SnapDistance", 10.0);
config_set_default_bool(userConfig, "BasicWindow", "SpacingHelpersEnabled", true);
config_set_default_bool(userConfig, "BasicWindow", "RecordWhenStreaming", false);
config_set_default_bool(userConfig, "BasicWindow", "KeepRecordingWhenStreamStops", false);
config_set_default_bool(userConfig, "BasicWindow", "SysTrayEnabled", true);
config_set_default_bool(userConfig, "BasicWindow", "SysTrayWhenStarted", false);
config_set_default_bool(userConfig, "BasicWindow", "SaveProjectors", false);
config_set_default_bool(userConfig, "BasicWindow", "ShowTransitions", true);
config_set_default_bool(userConfig, "BasicWindow", "ShowListboxToolbars", true);
config_set_default_bool(userConfig, "BasicWindow", "ShowStatusBar", true);
config_set_default_bool(userConfig, "BasicWindow", "ShowSourceIcons", true);
config_set_default_bool(userConfig, "BasicWindow", "ShowContextToolbars", true);
config_set_default_bool(userConfig, "BasicWindow", "StudioModeLabels", true);
config_set_default_bool(userConfig, "BasicWindow", "SideDocks", true);
config_set_default_bool(userConfig, "BasicWindow", "VerticalVolumeControl", true);
config_set_default_bool(userConfig, "BasicWindow", "MultiviewMouseSwitch", true);
config_set_default_bool(userConfig, "BasicWindow", "MultiviewDrawNames", true);
config_set_default_bool(userConfig, "BasicWindow", "MultiviewDrawAreas", true);
config_set_default_bool(userConfig, "BasicWindow", "MediaControlsCountdownTimer", true);
config_set_default_bool(App()->GetUserConfig(), "BasicWindow", "MixerShowInactive", false);
config_set_default_bool(App()->GetUserConfig(), "BasicWindow", "MixerKeepInactiveLast", false);
config_set_default_bool(App()->GetUserConfig(), "BasicWindow", "MixerShowHidden", false);
config_set_default_bool(App()->GetUserConfig(), "BasicWindow", "MixerKeepHiddenLast", false);
config_set_default_int(userConfig, "Appearance", "FontScale", 10);
config_set_default_int(userConfig, "Appearance", "Density", 1);
}
static bool do_mkdir(const char *path)
{
if (os_mkdirs(path) == MKDIR_ERROR) {
OBSErrorBox(NULL, "Failed to create directory %s", path);
return false;
}
return true;
}
static bool MakeUserDirs()
{
char path[512];
if (GetAppConfigPath(path, sizeof(path), "obs-studio/basic") <= 0)
return false;
if (!do_mkdir(path))
return false;
if (GetAppConfigPath(path, sizeof(path), "obs-studio/logs") <= 0)
return false;
if (!do_mkdir(path))
return false;
if (GetAppConfigPath(path, sizeof(path), "obs-studio/profiler_data") <= 0)
return false;
if (!do_mkdir(path))
return false;
#ifdef _WIN32
if (GetAppConfigPath(path, sizeof(path), "obs-studio/crashes") <= 0)
return false;
if (!do_mkdir(path))
return false;
#endif
#ifdef WHATSNEW_ENABLED
if (GetAppConfigPath(path, sizeof(path), "obs-studio/updates") <= 0)
return false;
if (!do_mkdir(path))
return false;
#endif
if (GetAppConfigPath(path, sizeof(path), "obs-studio/plugin_config") <= 0)
return false;
if (!do_mkdir(path))
return false;
return true;
}
constexpr std::string_view OBSProfileSubDirectory = "obs-studio/basic/profiles";
constexpr std::string_view OBSScenesSubDirectory = "obs-studio/basic/scenes";
constexpr std::string_view OBSPluginManagerSubDirectory = "obs-studio/plugin_manager";
static bool MakeUserProfileDirs()
{
const std::filesystem::path userProfilePath =
App()->userProfilesLocation / std::filesystem::u8path(OBSProfileSubDirectory);
const std::filesystem::path userScenesPath =
App()->userScenesLocation / std::filesystem::u8path(OBSScenesSubDirectory);
const std::filesystem::path userPluginManagerPath =
App()->userPluginManagerSettingsLocation / std::filesystem::u8path(OBSPluginManagerSubDirectory);
if (!std::filesystem::exists(userProfilePath)) {
try {
std::filesystem::create_directories(userProfilePath);
} catch (const std::filesystem::filesystem_error &error) {
blog(LOG_ERROR, "Failed to create user profile directory '%s'\n%s",
userProfilePath.u8string().c_str(), error.what());
return false;
}
}
if (!std::filesystem::exists(userScenesPath)) {
try {
std::filesystem::create_directories(userScenesPath);
} catch (const std::filesystem::filesystem_error &error) {
blog(LOG_ERROR, "Failed to create user scene collection directory '%s'\n%s",
userScenesPath.u8string().c_str(), error.what());
return false;
}
}
if (!std::filesystem::exists(userPluginManagerPath)) {
try {
std::filesystem::create_directories(userPluginManagerPath);
} catch (const std::filesystem::filesystem_error &error) {
blog(LOG_ERROR, "Failed to create user plugin manager directory '%s'\n%s",
userPluginManagerPath.u8string().c_str(), error.what());
return false;
}
}
return true;
}
bool OBSApp::UpdatePre22MultiviewLayout(const char *layout)
{
if (!layout)
return false;
if (astrcmpi(layout, "horizontaltop") == 0) {
config_set_int(userConfig, "BasicWindow", "MultiviewLayout",
static_cast<int>(MultiviewLayout::HORIZONTAL_TOP_8_SCENES));
return true;
}
if (astrcmpi(layout, "horizontalbottom") == 0) {
config_set_int(userConfig, "BasicWindow", "MultiviewLayout",
static_cast<int>(MultiviewLayout::HORIZONTAL_BOTTOM_8_SCENES));
return true;
}
if (astrcmpi(layout, "verticalleft") == 0) {
config_set_int(userConfig, "BasicWindow", "MultiviewLayout",
static_cast<int>(MultiviewLayout::VERTICAL_LEFT_8_SCENES));
return true;
}
if (astrcmpi(layout, "verticalright") == 0) {
config_set_int(userConfig, "BasicWindow", "MultiviewLayout",
static_cast<int>(MultiviewLayout::VERTICAL_RIGHT_8_SCENES));
return true;
}
return false;
}
bool OBSApp::InitGlobalConfig()
{
char path[512];
int len = GetAppConfigPath(path, sizeof(path), "obs-studio/global.ini");
if (len <= 0) {
return false;
}
int errorcode = appConfig.Open(path, CONFIG_OPEN_ALWAYS);
if (errorcode != CONFIG_SUCCESS) {
OBSErrorBox(NULL, "Failed to open global.ini: %d", errorcode);
return false;
}
uint32_t lastVersion = config_get_int(appConfig, "General", "LastVersion");
if (lastVersion && lastVersion < MAKE_SEMANTIC_VERSION(31, 0, 0)) {
bool migratedUserSettings = config_get_bool(appConfig, "General", "Pre31Migrated");
if (!migratedUserSettings) {
bool migrated = MigrateGlobalSettings();
config_set_bool(appConfig, "General", "Pre31Migrated", migrated);
config_save_safe(appConfig, "tmp", nullptr);
}
}
InitGlobalConfigDefaults();
InitGlobalLocationDefaults();
std::filesystem::path defaultUserConfigLocation =
std::filesystem::u8path(config_get_default_string(appConfig, "Locations", "Configuration"));
std::filesystem::path defaultUserScenesLocation =
std::filesystem::u8path(config_get_default_string(appConfig, "Locations", "SceneCollections"));
std::filesystem::path defaultUserProfilesLocation =
std::filesystem::u8path(config_get_default_string(appConfig, "Locations", "Profiles"));
std::filesystem::path defaultPluginManagerLocation =
std::filesystem::u8path(config_get_default_string(appConfig, "Locations", "PluginManagerSettings"));
if (IsPortableMode()) {
userConfigLocation = std::move(defaultUserConfigLocation);
userScenesLocation = std::move(defaultUserScenesLocation);
userProfilesLocation = std::move(defaultUserProfilesLocation);
userPluginManagerSettingsLocation = std::move(defaultPluginManagerLocation);
} else {
std::filesystem::path currentUserConfigLocation =
std::filesystem::u8path(config_get_string(appConfig, "Locations", "Configuration"));
std::filesystem::path currentUserScenesLocation =
std::filesystem::u8path(config_get_string(appConfig, "Locations", "SceneCollections"));
std::filesystem::path currentUserProfilesLocation =
std::filesystem::u8path(config_get_string(appConfig, "Locations", "Profiles"));
std::filesystem::path currentUserPluginManagerLocation =
std::filesystem::u8path(config_get_string(appConfig, "Locations", "PluginManagerSettings"));
userConfigLocation = (std::filesystem::exists(currentUserConfigLocation))
? std::move(currentUserConfigLocation)
: std::move(defaultUserConfigLocation);
userScenesLocation = (std::filesystem::exists(currentUserScenesLocation))
? std::move(currentUserScenesLocation)
: std::move(defaultUserScenesLocation);
userProfilesLocation = (std::filesystem::exists(currentUserProfilesLocation))
? std::move(currentUserProfilesLocation)
: std::move(defaultUserProfilesLocation);
userPluginManagerSettingsLocation = (std::filesystem::exists(currentUserPluginManagerLocation))
? std::move(currentUserPluginManagerLocation)
: std::move(defaultPluginManagerLocation);
}
bool userConfigResult = InitUserConfig(userConfigLocation, lastVersion);
return userConfigResult;
}
bool OBSApp::InitUserConfig(std::filesystem::path &userConfigLocation, uint32_t lastVersion)
{
const std::string userConfigFile = userConfigLocation.u8string() + "/obs-studio/user.ini";
int errorCode = userConfig.Open(userConfigFile.c_str(), CONFIG_OPEN_ALWAYS);
if (errorCode != CONFIG_SUCCESS) {
OBSErrorBox(nullptr, "Failed to open user.ini: %d", errorCode);
return false;
}
MigrateLegacySettings(lastVersion);
InitUserConfigDefaults();
return true;
}
void OBSApp::MigrateLegacySettings(const uint32_t lastVersion)
{
bool hasChanges = false;
const uint32_t v19 = MAKE_SEMANTIC_VERSION(19, 0, 0);
const uint32_t v21 = MAKE_SEMANTIC_VERSION(21, 0, 0);
const uint32_t v23 = MAKE_SEMANTIC_VERSION(23, 0, 0);
const uint32_t v24 = MAKE_SEMANTIC_VERSION(24, 0, 0);
const uint32_t v24_1 = MAKE_SEMANTIC_VERSION(24, 1, 0);
const map<uint32_t, string> defaultsMap{
{{v19, "Pre19Defaults"}, {v21, "Pre21Defaults"}, {v23, "Pre23Defaults"}, {v24_1, "Pre24.1Defaults"}}};
for (auto &[version, configKey] : defaultsMap) {
if (!config_has_user_value(userConfig, "General", configKey.c_str())) {
bool useOldDefaults = lastVersion && lastVersion < version;
config_set_bool(userConfig, "General", configKey.c_str(), useOldDefaults);
hasChanges = true;
}
}
if (config_has_user_value(userConfig, "BasicWindow", "MultiviewLayout")) {
const char *layout = config_get_string(userConfig, "BasicWindow", "MultiviewLayout");
bool layoutUpdated = UpdatePre22MultiviewLayout(layout);
hasChanges = hasChanges | layoutUpdated;
}
if (lastVersion && lastVersion < v24) {
bool disableHotkeysInFocus = config_get_bool(userConfig, "General", "DisableHotkeysInFocus");
if (disableHotkeysInFocus) {
config_set_string(userConfig, "General", "HotkeyFocusType", "DisableHotkeysInFocus");
}
hasChanges = true;
}
if (hasChanges) {
userConfig.SaveSafe("tmp");
}
}
static constexpr string_view OBSGlobalIniPath = "/obs-studio/global.ini";
static constexpr string_view OBSUserIniPath = "/obs-studio/user.ini";
bool OBSApp::MigrateGlobalSettings()
{
char path[512];
int len = GetAppConfigPath(path, sizeof(path), nullptr);
if (len <= 0) {
OBSErrorBox(nullptr, "Unable to get global configuration path.");
return false;
}
std::string legacyConfigFileString;
legacyConfigFileString.reserve(strlen(path) + OBSGlobalIniPath.size());
legacyConfigFileString.append(path).append(OBSGlobalIniPath);
const std::filesystem::path legacyGlobalConfigFile = std::filesystem::u8path(legacyConfigFileString);
std::string configFileString;
configFileString.reserve(strlen(path) + OBSUserIniPath.size());
configFileString.append(path).append(OBSUserIniPath);
const std::filesystem::path userConfigFile = std::filesystem::u8path(configFileString);
if (std::filesystem::exists(userConfigFile)) {
OBSErrorBox(nullptr,
"Unable to migrate global configuration - user configuration file already exists.");
return false;
}
try {
std::filesystem::copy(legacyGlobalConfigFile, userConfigFile);
} catch (const std::filesystem::filesystem_error &) {
OBSErrorBox(nullptr, "Unable to migrate global configuration - copy failed.");
return false;
}
return true;
}
bool OBSApp::InitLocale()
{
ProfileScope("OBSApp::InitLocale");
const char *lang = config_get_string(userConfig, "General", "Language");
bool userLocale = config_has_user_value(userConfig, "General", "Language");
if (!userLocale || !lang || lang[0] == '\0')
lang = DEFAULT_LANG;
locale = lang;
// set basic default application locale
if (!locale.empty())
QLocale::setDefault(QLocale(QString::fromStdString(locale).replace('-', '_')));
string englishPath;
if (!GetDataFilePath("locale/" DEFAULT_LANG ".ini", englishPath)) {
OBSErrorBox(NULL, "Failed to find locale/" DEFAULT_LANG ".ini");
return false;
}
textLookup = text_lookup_create(englishPath.c_str());
if (!textLookup) {
OBSErrorBox(NULL, "Failed to create locale from file '%s'", englishPath.c_str());
return false;
}
bool defaultLang = astrcmpi(lang, DEFAULT_LANG) == 0;
if (userLocale && defaultLang)
return true;
if (!userLocale && defaultLang) {
for (auto &locale_ : GetPreferredLocales()) {
if (locale_ == lang)
return true;
stringstream file;
file << "locale/" << locale_ << ".ini";
string path;
if (!GetDataFilePath(file.str().c_str(), path))
continue;
if (!text_lookup_add(textLookup, path.c_str()))
continue;
blog(LOG_INFO, "Using preferred locale '%s'", locale_.c_str());
locale = locale_;
// set application default locale to the new chosen one
if (!locale.empty())
QLocale::setDefault(QLocale(QString::fromStdString(locale).replace('-', '_')));
return true;
}
return true;
}
stringstream file;
file << "locale/" << lang << ".ini";
string path;
if (GetDataFilePath(file.str().c_str(), path)) {
if (!text_lookup_add(textLookup, path.c_str()))
blog(LOG_ERROR, "Failed to add locale file '%s'", path.c_str());
} else {
blog(LOG_ERROR, "Could not find locale file '%s'", file.str().c_str());
}
return true;
}
#if defined(_WIN32) || defined(ENABLE_SPARKLE_UPDATER)
void ParseBranchesJson(const std::string &jsonString, vector<UpdateBranch> &out, std::string &error)
{
JsonBranches branches;
try {
nlohmann::json json = nlohmann::json::parse(jsonString);
branches = json.get<JsonBranches>();
} catch (nlohmann::json::exception &e) {
error = e.what();
return;
}
for (const JsonBranch &json_branch : branches) {
#ifdef _WIN32
if (!json_branch.windows)
continue;
#elif defined(__APPLE__)
if (!json_branch.macos)
continue;
#endif
UpdateBranch branch = {
QString::fromStdString(json_branch.name),
QString::fromStdString(json_branch.display_name),
QString::fromStdString(json_branch.description),
json_branch.enabled,
json_branch.visible,
};
out.push_back(branch);
}
}
bool LoadBranchesFile(vector<UpdateBranch> &out)
{
string error;
string branchesText;
BPtr<char> branchesFilePath = GetAppConfigPathPtr("obs-studio/updates/branches.json");
QFile branchesFile(branchesFilePath.Get());
if (!branchesFile.open(QIODevice::ReadOnly)) {
error = "Opening file failed.";
goto fail;
}
branchesText = branchesFile.readAll().toStdString();
if (branchesText.empty()) {
error = "File empty.";
goto fail;
}
ParseBranchesJson(branchesText, out, error);
if (error.empty())
return !out.empty();
fail:
blog(LOG_WARNING, "Loading branches from file failed: %s", error.c_str());
return false;
}
#endif
void OBSApp::SetBranchData(const string &data)
{
#if defined(_WIN32) || defined(ENABLE_SPARKLE_UPDATER)
string error;
vector<UpdateBranch> result;
ParseBranchesJson(data, result, error);
if (!error.empty()) {
blog(LOG_WARNING, "Reading branches JSON response failed: %s", error.c_str());
return;
}
if (!result.empty())
updateBranches = result;
branches_loaded = true;
#else
UNUSED_PARAMETER(data);
#endif
}
std::vector<UpdateBranch> OBSApp::GetBranches()
{
vector<UpdateBranch> out;
/* Always ensure the default branch exists */
out.push_back(UpdateBranch{"stable", "", "", true, true});
#if defined(_WIN32) || defined(ENABLE_SPARKLE_UPDATER)
if (!branches_loaded) {
vector<UpdateBranch> result;
if (LoadBranchesFile(result))
updateBranches = result;
branches_loaded = true;
}
#endif
/* Copy additional branches to result (if any) */
if (!updateBranches.empty())
out.insert(out.end(), updateBranches.begin(), updateBranches.end());
return out;
}
OBSApp::OBSApp(int &argc, char **argv, profiler_name_store_t *store)
: QApplication(argc, argv),
profilerNameStore(store),
appLaunchUUID_(QUuid::createUuid())
{
installNativeEventFilter(new OBS::NativeEventFilter);
/* fix float handling */
#if defined(Q_OS_UNIX)
if (!setlocale(LC_NUMERIC, "C"))
blog(LOG_WARNING, "Failed to set LC_NUMERIC to C locale");
#endif
#ifndef _WIN32
// Add POSIX signal handlers:
// * SIGINT
// * SIGTERM
// * SIGABRT
// * SIGQUIT
using SignalCallback = decltype(&OBSApp::processSigInt);
auto connectSignal = [this](std::array<int, 2> &fileDescriptor, QPointer<QSocketNotifier> &notifier,
SignalCallback callback) -> void {
socketpair(AF_UNIX, SOCK_STREAM, 0, fileDescriptor.data());
notifier = new QSocketNotifier(fileDescriptor[1], QSocketNotifier::Read, this);
connect(notifier, &QSocketNotifier::activated, this, callback);
};
connectSignal(sigIntFileDescriptor, sigIntNotifier, &OBSApp::processSigInt);
connectSignal(sigTermFileDescriptor, sigTermNotifier, &OBSApp::processSigTerm);
connectSignal(sigAbrtFileDescriptor, sigAbrtNotifier, &OBSApp::processSigAbrt);
connectSignal(sigQuitFileDescriptor, sigQuitNotifier, &OBSApp::processSigQuit);
#endif
connect(qApp, &QGuiApplication::commitDataRequest, this, &OBSApp::commitData, Qt::DirectConnection);
if (multi) {
crashHandler_ = std::make_unique<OBS::CrashHandler>();
} else {
crashHandler_ = std::make_unique<OBS::CrashHandler>(appLaunchUUID_);
}
sleepInhibitor = os_inhibit_sleep_create("OBS Video/audio");
#ifndef __APPLE__
setWindowIcon(QIcon::fromTheme("obs", QIcon(":/res/images/obs.png")));
#endif
setDesktopFileName("com.obsproject.Studio");
pluginManager_ = std::make_unique<OBS::PluginManager>();
}
OBSApp::~OBSApp()
{
if (libobs_initialized) {
applicationShutdown();
}
};
static void move_basic_to_profiles(void)
{
char path[512];
if (GetAppConfigPath(path, 512, "obs-studio/basic") <= 0) {
return;
}
const std::filesystem::path basicPath = std::filesystem::u8path(path);
if (!std::filesystem::exists(basicPath)) {
return;
}
const std::filesystem::path profilesPath =
App()->userProfilesLocation / std::filesystem::u8path("obs-studio/basic/profiles");
if (std::filesystem::exists(profilesPath)) {
return;
}
try {
std::filesystem::create_directories(profilesPath);
} catch (const std::filesystem::filesystem_error &error) {
blog(LOG_ERROR, "Failed to create profiles directory for migration from basic profile\n%s",
error.what());
return;
}
const std::filesystem::path newProfilePath = profilesPath / std::filesystem::u8path(Str("Untitled"));
for (auto &entry : std::filesystem::directory_iterator(basicPath)) {
if (entry.is_directory()) {
continue;
}
if (entry.path().filename().u8string() == "scenes.json") {
continue;
}
if (!std::filesystem::exists(newProfilePath)) {
try {
std::filesystem::create_directory(newProfilePath);
} catch (const std::filesystem::filesystem_error &error) {
blog(LOG_ERROR, "Failed to create profile directory for 'Untitled'\n%s", error.what());
return;
}
}
const filesystem::path destinationFile = newProfilePath / entry.path().filename();
const auto copyOptions = std::filesystem::copy_options::overwrite_existing;
try {
std::filesystem::copy(entry.path(), destinationFile, copyOptions);
} catch (const std::filesystem::filesystem_error &error) {
blog(LOG_ERROR, "Failed to copy basic profile file '%s' to new profile 'Untitled'\n%s",
entry.path().filename().u8string().c_str(), error.what());
return;
}
}
}
static void move_basic_to_scene_collections(void)
{
char path[512];
if (GetAppConfigPath(path, 512, "obs-studio/basic") <= 0) {
return;
}
const std::filesystem::path basicPath = std::filesystem::u8path(path);
if (!std::filesystem::exists(basicPath)) {
return;
}
const std::filesystem::path sceneCollectionPath =
App()->userScenesLocation / std::filesystem::u8path("obs-studio/basic/scenes");
if (std::filesystem::exists(sceneCollectionPath)) {
return;
}
try {
std::filesystem::create_directories(sceneCollectionPath);
} catch (const std::filesystem::filesystem_error &error) {
blog(LOG_ERROR,
"Failed to create scene collection directory for migration from basic scene collection\n%s",
error.what());
return;
}
const std::filesystem::path sourceFile = basicPath / std::filesystem::u8path("scenes.json");
const std::filesystem::path destinationFile =
(sceneCollectionPath / std::filesystem::u8path(Str("Untitled"))).replace_extension(".json");
try {
std::filesystem::rename(sourceFile, destinationFile);
} catch (const std::filesystem::filesystem_error &error) {
blog(LOG_ERROR, "Failed to rename basic scene collection file:\n%s", error.what());
return;
}
}
void OBSApp::AppInit()
{
ProfileScope("OBSApp::AppInit");
QAccessible::installFactory(alignmentSelectorFactory);
if (!MakeUserDirs())
throw "Failed to create required user directories";
if (!InitGlobalConfig())
throw "Failed to initialize global config";
if (!InitLocale())
throw "Failed to load locale";
if (!InitTheme())
throw "Failed to load theme";
config_set_default_string(userConfig, "Basic", "Profile", Str("Untitled"));
config_set_default_string(userConfig, "Basic", "ProfileDir", Str("Untitled"));
config_set_default_string(userConfig, "Basic", "SceneCollection", Str("Untitled"));
config_set_default_string(userConfig, "Basic", "SceneCollectionFile", Str("Untitled"));
config_set_default_bool(userConfig, "Basic", "ConfigOnNewProfile", true);
const std::string_view profileName{config_get_string(userConfig, "Basic", "Profile")};
if (profileName.empty()) {
config_set_string(userConfig, "Basic", "Profile", Str("Untitled"));
config_set_string(userConfig, "Basic", "ProfileDir", Str("Untitled"));
}
const std::string_view sceneCollectionName{config_get_string(userConfig, "Basic", "SceneCollection")};
if (sceneCollectionName.empty()) {
config_set_string(userConfig, "Basic", "SceneCollection", Str("Untitled"));
config_set_string(userConfig, "Basic", "SceneCollectionFile", Str("Untitled"));
}
#ifdef _WIN32
bool disableAudioDucking = config_get_bool(appConfig, "Audio", "DisableAudioDucking");
if (disableAudioDucking)
DisableAudioDucking(true);
#endif
#ifdef __APPLE__
if (config_get_bool(appConfig, "Video", "DisableOSXVSync"))
EnableOSXVSync(false);
#endif
UpdateHotkeyFocusSetting(false);
move_basic_to_profiles();
move_basic_to_scene_collections();
if (!MakeUserProfileDirs())
throw "Failed to create profile directories";
}
void OBSApp::checkForUncleanShutdown()
{
bool hasUncleanShutdown = crashHandler_->hasUncleanShutdown();
bool hasNewCrashLog = crashHandler_->hasNewCrashLog();
if (hasUncleanShutdown) {
UncleanLaunchAction launchAction = handleUncleanShutdown(hasNewCrashLog);
safe_mode = launchAction.useSafeMode;
if (launchAction.sendCrashReport) {
crashHandler_->uploadLastCrashLog();
}
}
}
const char *OBSApp::GetRenderModule() const
{
#if defined(_WIN32)
const char *renderer = config_get_string(appConfig, "Video", "Renderer");
return (astrcmpi(renderer, "Direct3D 11") == 0) ? DL_D3D11 : DL_OPENGL;
#elif defined(__APPLE__) && defined(__aarch64__)
const char *renderer = config_get_string(appConfig, "Video", "Renderer");
return (astrcmpi(renderer, "Metal") == 0) ? DL_METAL : DL_OPENGL;
#else
return DL_OPENGL;
#endif
}
static bool StartupOBS(const char *locale, profiler_name_store_t *store)
{
char path[512];
if (GetAppConfigPath(path, sizeof(path), "obs-studio/plugin_config") <= 0)
return false;
return obs_startup(locale, path, store);
}
inline void OBSApp::ResetHotkeyState(bool inFocus)
{
obs_hotkey_enable_background_press((inFocus && enableHotkeysInFocus) || (!inFocus && enableHotkeysOutOfFocus));
}
void OBSApp::UpdateHotkeyFocusSetting(bool resetState)
{
enableHotkeysInFocus = true;
enableHotkeysOutOfFocus = true;
const char *hotkeyFocusType = config_get_string(userConfig, "General", "HotkeyFocusType");
if (astrcmpi(hotkeyFocusType, "DisableHotkeysInFocus") == 0) {
enableHotkeysInFocus = false;
} else if (astrcmpi(hotkeyFocusType, "DisableHotkeysOutOfFocus") == 0) {
enableHotkeysOutOfFocus = false;
}
if (resetState)
ResetHotkeyState(applicationState() == Qt::ApplicationActive);
}
void OBSApp::DisableHotkeys()
{
enableHotkeysInFocus = false;
enableHotkeysOutOfFocus = false;
ResetHotkeyState(applicationState() == Qt::ApplicationActive);
}
void OBSApp::Exec(VoidFunc func)
{
func();
}
static void ui_task_handler(obs_task_t task, void *param, bool wait)
{
auto doTask = [=]() {
/* to get clang-format to behave */
task(param);
};
QMetaObject::invokeMethod(App(), "Exec", wait ? WaitConnection() : Qt::AutoConnection, Q_ARG(VoidFunc, doTask));
}
bool OBSApp::OBSInit()
{
ProfileScope("OBSApp::OBSInit");
qRegisterMetaType<VoidFunc>("VoidFunc");
#if !defined(_WIN32) && !defined(__APPLE__)
if (QApplication::platformName() == "xcb") {
#if QT_VERSION >= QT_VERSION_CHECK(6, 5, 0)
auto native = qGuiApp->nativeInterface<QNativeInterface::QX11Application>();
obs_set_nix_platform_display(native->display());
#endif
obs_set_nix_platform(OBS_NIX_PLATFORM_X11_EGL);
blog(LOG_INFO, "Using EGL/X11");
}
#ifdef ENABLE_WAYLAND
if (QApplication::platformName().contains("wayland")) {
#if QT_VERSION >= QT_VERSION_CHECK(6, 5, 0)
auto native = qGuiApp->nativeInterface<QNativeInterface::QWaylandApplication>();
obs_set_nix_platform_display(native->display());
#endif
obs_set_nix_platform(OBS_NIX_PLATFORM_WAYLAND);
setAttribute(Qt::AA_DontCreateNativeWidgetSiblings);
blog(LOG_INFO, "Platform: Wayland");
}
#endif
#if QT_VERSION < QT_VERSION_CHECK(6, 5, 0)
QPlatformNativeInterface *native = QGuiApplication::platformNativeInterface();
obs_set_nix_platform_display(native->nativeResourceForIntegration("display"));
#endif
#endif
#ifdef __APPLE__
setAttribute(Qt::AA_DontCreateNativeWidgetSiblings);
#endif
if (!StartupOBS(locale.c_str(), GetProfilerNameStore()))
return false;
libobs_initialized = true;
obs_set_ui_task_handler(ui_task_handler);
#if defined(_WIN32) || defined(__APPLE__) || defined(__linux__)
bool browserHWAccel = config_get_bool(appConfig, "General", "BrowserHWAccel");
OBSDataAutoRelease settings = obs_data_create();
obs_data_set_bool(settings, "BrowserHWAccel", browserHWAccel);
obs_apply_private_data(settings);
blog(LOG_INFO, "Current Date/Time: %s", CurrentDateTimeString().c_str());
blog(LOG_INFO, "Browser Hardware Acceleration: %s", browserHWAccel ? "true" : "false");
#endif
#ifdef _WIN32
bool hideFromCapture = config_get_bool(userConfig, "BasicWindow", "HideOBSWindowsFromCapture");
blog(LOG_INFO, "Hide OBS windows from screen capture: %s", hideFromCapture ? "true" : "false");
#endif
blog(LOG_INFO, "Qt Version: %s (runtime), %s (compiled)", qVersion(), QT_VERSION_STR);
blog(LOG_INFO, "Portable mode: %s", portable_mode ? "true" : "false");
if (safe_mode) {
blog(LOG_WARNING, "Safe Mode enabled.");
} else if (disable_3p_plugins) {
blog(LOG_WARNING, "Third-party plugins disabled.");
}
setQuitOnLastWindowClosed(false);
mainWindow = new OBSBasic();
mainWindow->setAttribute(Qt::WA_DeleteOnClose, true);
#ifndef __APPLE__
connect(QApplication::instance(), &QApplication::aboutToQuit, this, [this]() {
if (mainWindow) {
QPointer<OBSBasic> basicWindow = static_cast<OBSBasic *>(mainWindow.get());
basicWindow->closeWindow();
}
if (libobs_initialized) {
applicationShutdown();
}
});
#endif
mainWindow->OBSInit();
connect(OBSBasic::Get(), &OBSBasic::mainWindowClosed, crashHandler_.get(),
&OBS::CrashHandler::applicationShutdownHandler);
connect(this, &QGuiApplication::applicationStateChanged, this,
[this](Qt::ApplicationState state) { ResetHotkeyState(state == Qt::ApplicationActive); });
ResetHotkeyState(applicationState() == Qt::ApplicationActive);
connect(crashHandler_.get(), &OBS::CrashHandler::crashLogUploadFailed, this,
[this](const QString &errorMessage) {
emit this->logUploadFailed(OBS::LogFileType::CrashLog, errorMessage);
});
connect(crashHandler_.get(), &OBS::CrashHandler::crashLogUploadFinished, this,
[this](const QString &fileUrl) { emit this->logUploadFinished(OBS::LogFileType::CrashLog, fileUrl); });
return true;
}
string OBSApp::GetVersionString(bool platform) const
{
stringstream ver;
ver << obs_get_version_string();
if (platform) {
ver << " (";
#ifdef _WIN32
if (sizeof(void *) == 8)
ver << "64-bit, ";
else
ver << "32-bit, ";
ver << "windows)";
#elif __APPLE__
ver << "mac)";
#elif __OpenBSD__
ver << "openbsd)";
#elif __FreeBSD__
ver << "freebsd)";
#else /* assume linux for the time being */
ver << "linux)";
#endif
}
return ver.str();
}
bool OBSApp::IsPortableMode()
{
return portable_mode;
}
bool OBSApp::IsUpdaterDisabled()
{
return opt_disable_updater;
}
bool OBSApp::IsMissingFilesCheckDisabled()
{
return opt_disable_missing_files_check;
}
#ifdef __APPLE__
#define INPUT_AUDIO_SOURCE "coreaudio_input_capture"
#define OUTPUT_AUDIO_SOURCE "coreaudio_output_capture"
#elif _WIN32
#define INPUT_AUDIO_SOURCE "wasapi_input_capture"
#define OUTPUT_AUDIO_SOURCE "wasapi_output_capture"
#else
#define INPUT_AUDIO_SOURCE "pulse_input_capture"
#define OUTPUT_AUDIO_SOURCE "pulse_output_capture"
#endif
const char *OBSApp::InputAudioSource() const
{
return INPUT_AUDIO_SOURCE;
}
const char *OBSApp::OutputAudioSource() const
{
return OUTPUT_AUDIO_SOURCE;
}
const char *OBSApp::GetLastLog() const
{
return lastLogFile.c_str();
}
const char *OBSApp::GetCurrentLog() const
{
return currentLogFile.c_str();
}
void OBSApp::openCrashLogDirectory() const
{
std::filesystem::path crashLogDirectory = crashHandler_->getCrashLogDirectory();
if (crashLogDirectory.empty()) {
return;
}
QString crashLogDirectoryString = QString::fromStdString(crashLogDirectory.u8string());
QUrl crashLogDirectoryURL = QUrl::fromLocalFile(crashLogDirectoryString);
QDesktopServices::openUrl(crashLogDirectoryURL);
}
void OBSApp::uploadLastAppLog() const
{
OBSBasic *basicWindow = static_cast<OBSBasic *>(GetMainWindow());
basicWindow->UploadLog("obs-studio/logs", GetLastLog(), OBS::LogFileType::LastAppLog);
}
void OBSApp::uploadCurrentAppLog() const
{
OBSBasic *basicWindow = static_cast<OBSBasic *>(GetMainWindow());
basicWindow->UploadLog("obs-studio/logs", GetCurrentLog(), OBS::LogFileType::CurrentAppLog);
}
void OBSApp::uploadLastCrashLog()
{
crashHandler_->uploadLastCrashLog();
}
OBS::LogFileState OBSApp::getLogFileState(OBS::LogFileType type) const
{
switch (type) {
case OBS::LogFileType::CrashLog: {
bool hasNewCrashLog = crashHandler_->hasNewCrashLog();
return (hasNewCrashLog) ? OBS::LogFileState::New : OBS::LogFileState::Uploaded;
}
case OBS::LogFileType::CurrentAppLog:
case OBS::LogFileType::LastAppLog:
return OBS::LogFileState::New;
default:
return OBS::LogFileState::NoState;
}
}
bool OBSApp::TranslateString(const char *lookupVal, const char **out) const
{
for (obs_frontend_translate_ui_cb cb : translatorHooks) {
if (cb(lookupVal, out))
return true;
}
return text_lookup_getstr(App()->GetTextLookup(), lookupVal, out);
}
QStyle *OBSApp::GetInvisibleCursorStyle()
{
if (!invisibleCursorStyle) {
invisibleCursorStyle = std::make_unique<OBSInvisibleCursorProxyStyle>();
}
return invisibleCursorStyle.get();
}
// Global handler to receive all QEvent::Show events so we can apply
// display affinity on any newly created windows and dialogs without
// caring where they are coming from (e.g. plugins).
bool OBSApp::notify(QObject *receiver, QEvent *e)
{
QWidget *w;
QWindow *window;
int windowType;
if (!receiver->isWidgetType())
goto skip;
if (e->type() != QEvent::Show)
goto skip;
w = qobject_cast<QWidget *>(receiver);
if (!w->isWindow())
goto skip;
window = w->windowHandle();
if (!window)
goto skip;
windowType = window->flags() & Qt::WindowType::WindowType_Mask;
if (windowType == Qt::WindowType::Dialog || windowType == Qt::WindowType::Window ||
windowType == Qt::WindowType::Tool) {
OBSBasic *main = OBSBasic::Get();
if (main)
main->SetDisplayAffinity(window);
}
skip:
return QApplication::notify(receiver, e);
}
string GenerateTimeDateFilename(const char *extension, bool noSpace)
{
time_t now = time(0);
char file[256] = {};
struct tm *cur_time;
cur_time = localtime(&now);
snprintf(file, sizeof(file), "%d-%02d-%02d%c%02d-%02d-%02d.%s", cur_time->tm_year + 1900, cur_time->tm_mon + 1,
cur_time->tm_mday, noSpace ? '_' : ' ', cur_time->tm_hour, cur_time->tm_min, cur_time->tm_sec,
extension);
return string(file);
}
string GenerateSpecifiedFilename(const char *extension, bool noSpace, const char *format)
{
BPtr<char> filename = os_generate_formatted_filename(extension, !noSpace, format);
return string(filename);
}
static void FindBestFilename(string &strPath, bool noSpace)
{
int num = 2;
if (!os_file_exists(strPath.c_str()))
return;
const char *ext = strrchr(strPath.c_str(), '.');
if (!ext)
return;
int extStart = int(ext - strPath.c_str());
for (;;) {
string testPath = strPath;
string numStr;
numStr = noSpace ? "_" : " (";
numStr += to_string(num++);
if (!noSpace)
numStr += ")";
testPath.insert(extStart, numStr);
if (!os_file_exists(testPath.c_str())) {
strPath = testPath;
break;
}
}
}
static void ensure_directory_exists(string &path)
{
replace(path.begin(), path.end(), '\\', '/');
size_t last = path.rfind('/');
if (last == string::npos)
return;
string directory = path.substr(0, last);
os_mkdirs(directory.c_str());
}
static void remove_reserved_file_characters(string &s)
{
replace(s.begin(), s.end(), '\\', '/');
replace(s.begin(), s.end(), '*', '_');
replace(s.begin(), s.end(), '?', '_');
replace(s.begin(), s.end(), '"', '_');
replace(s.begin(), s.end(), '|', '_');
replace(s.begin(), s.end(), ':', '_');
replace(s.begin(), s.end(), '>', '_');
replace(s.begin(), s.end(), '<', '_');
}
string GetFormatString(const char *format, const char *prefix, const char *suffix)
{
string f;
f = format;
if (prefix && *prefix) {
string str_prefix = prefix;
if (str_prefix.back() != ' ')
str_prefix += " ";
size_t insert_pos = 0;
size_t tmp;
tmp = f.find_last_of('/');
if (tmp != string::npos && tmp > insert_pos)
insert_pos = tmp + 1;
tmp = f.find_last_of('\\');
if (tmp != string::npos && tmp > insert_pos)
insert_pos = tmp + 1;
f.insert(insert_pos, str_prefix);
}
if (suffix && *suffix) {
if (*suffix != ' ')
f += " ";
f += suffix;
}
remove_reserved_file_characters(f);
return f;
}
string GetFormatExt(const char *container)
{
string ext = container;
if (ext == "fragmented_mp4" || ext == "hybrid_mp4")
ext = "mp4";
else if (ext == "fragmented_mov" || ext == "hybrid_mov")
ext = "mov";
else if (ext == "hls")
ext = "m3u8";
else if (ext == "mpegts")
ext = "ts";
return ext;
}
string GetOutputFilename(const char *path, const char *container, bool noSpace, bool overwrite, const char *format)
{
OBSBasic *main = OBSBasic::Get();
os_dir_t *dir = path && path[0] ? os_opendir(path) : nullptr;
if (!dir) {
if (main->isVisible())
OBSMessageBox::warning(main, QTStr("Output.BadPath.Title"), QTStr("Output.BadPath.Text"));
else
main->SysTrayNotify(QTStr("Output.BadPath.Text"), QSystemTrayIcon::Warning);
return "";
}
os_closedir(dir);
string strPath;
strPath += path;
char lastChar = strPath.back();
if (lastChar != '/' && lastChar != '\\')
strPath += "/";
string ext = GetFormatExt(container);
strPath += GenerateSpecifiedFilename(ext.c_str(), noSpace, format);
ensure_directory_exists(strPath);
if (!overwrite)
FindBestFilename(strPath, noSpace);
return strPath;
}
vector<pair<string, string>> GetLocaleNames()
{
string path;
if (!GetDataFilePath("locale.ini", path))
throw "Could not find locale.ini path";
ConfigFile ini;
if (ini.Open(path.c_str(), CONFIG_OPEN_EXISTING) != 0)
throw "Could not open locale.ini";
size_t sections = config_num_sections(ini);
vector<pair<string, string>> names;
names.reserve(sections);
for (size_t i = 0; i < sections; i++) {
const char *tag = config_get_section(ini, i);
const char *name = config_get_string(ini, tag, "Name");
names.emplace_back(tag, name);
}
return names;
}
#if defined(__APPLE__) || defined(__linux__)
#define BASE_PATH ".."
#else
#define BASE_PATH "../.."
#endif
#define CONFIG_PATH BASE_PATH "/config"
#if defined(ENABLE_PORTABLE_CONFIG) || defined(_WIN32)
#define ALLOW_PORTABLE_MODE 1
#else
#define ALLOW_PORTABLE_MODE 0
#endif
int GetAppConfigPath(char *path, size_t size, const char *name)
{
#if ALLOW_PORTABLE_MODE
if (portable_mode) {
if (name && *name) {
return snprintf(path, size, CONFIG_PATH "/%s", name);
} else {
return snprintf(path, size, CONFIG_PATH);
}
} else {
return os_get_config_path(path, size, name);
}
#else
return os_get_config_path(path, size, name);
#endif
}
char *GetAppConfigPathPtr(const char *name)
{
#if ALLOW_PORTABLE_MODE
if (portable_mode) {
char path[512];
if (snprintf(path, sizeof(path), CONFIG_PATH "/%s", name) > 0) {
return bstrdup(path);
} else {
return NULL;
}
} else {
return os_get_config_path_ptr(name);
}
#else
return os_get_config_path_ptr(name);
#endif
}
int GetProgramDataPath(char *path, size_t size, const char *name)
{
return os_get_program_data_path(path, size, name);
}
char *GetProgramDataPathPtr(const char *name)
{
return os_get_program_data_path_ptr(name);
}
bool GetFileSafeName(const char *name, std::string &file)
{
size_t base_len = strlen(name);
size_t len = os_utf8_to_wcs(name, base_len, nullptr, 0);
std::wstring wfile;
if (!len)
return false;
wfile.resize(len);
os_utf8_to_wcs(name, base_len, &wfile[0], len + 1);
for (size_t i = wfile.size(); i > 0; i--) {
size_t im1 = i - 1;
if (iswspace(wfile[im1])) {
wfile[im1] = '_';
} else if (wfile[im1] != '_' && !iswalnum(wfile[im1])) {
wfile.erase(im1, 1);
}
}
if (wfile.size() == 0)
wfile = L"characters_only";
len = os_wcs_to_utf8(wfile.c_str(), wfile.size(), nullptr, 0);
if (!len)
return false;
file.resize(len);
os_wcs_to_utf8(wfile.c_str(), wfile.size(), &file[0], len + 1);
return true;
}
bool GetClosestUnusedFileName(std::string &path, const char *extension)
{
size_t len = path.size();
if (extension) {
path += ".";
path += extension;
}
if (!os_file_exists(path.c_str()))
return true;
int index = 1;
do {
path.resize(len);
path += std::to_string(++index);
if (extension) {
path += ".";
path += extension;
}
} while (os_file_exists(path.c_str()));
return true;
}
bool WindowPositionValid(QRect rect)
{
for (QScreen *screen : QGuiApplication::screens()) {
if (screen->availableGeometry().intersects(rect))
return true;
}
return false;
}
#ifndef _WIN32
// Static signal handlers
void OBSApp::sigIntSignalHandler(int)
{
char tmp = 1;
::send(sigIntFileDescriptor[0], &tmp, sizeof(tmp), 0);
}
void OBSApp::sigTermSignalHandler(int)
{
char tmp = 1;
::send(sigTermFileDescriptor[0], &tmp, sizeof(tmp), 0);
}
void OBSApp::sigAbrtSignalHandler(int)
{
char tmp = 1;
::send(sigAbrtFileDescriptor[0], &tmp, sizeof(tmp), 0);
}
void OBSApp::sigQuitSignalHandler(int)
{
char tmp = 1;
::send(sigQuitFileDescriptor[0], &tmp, sizeof(tmp), 0);
}
// App instance signal processors
void OBSApp::processSigInt()
{
if (!sigIntNotifier->isEnabled()) {
return;
}
sigIntNotifier->setEnabled(false);
char tmp;
::recv(sigIntFileDescriptor[1], &tmp, sizeof(tmp), 0);
sigIntNotifier->setEnabled(true);
#ifndef __APPLE__
OBSBasic *main = OBSBasic::Get();
if (main) {
main->saveAll();
main->close();
}
#else
quit();
#endif
}
void OBSApp::processSigTerm()
{
if (!sigTermNotifier->isEnabled()) {
return;
}
sigTermNotifier->setEnabled(false);
char tmp;
::recv(sigTermFileDescriptor[1], &tmp, sizeof(tmp), 0);
sigTermNotifier->setEnabled(true);
#ifndef __APPLE__
OBSBasic *main = OBSBasic::Get();
if (main) {
main->saveAll();
}
#endif
quit();
}
void OBSApp::processSigAbrt()
{
if (!sigAbrtNotifier->isEnabled()) {
return;
}
sigAbrtNotifier->setEnabled(false);
char tmp;
::recv(sigAbrtFileDescriptor[1], &tmp, sizeof(tmp), 0);
sigAbrtNotifier->setEnabled(true);
#ifndef __APPLE__
OBSBasic *main = OBSBasic::Get();
if (main) {
main->saveAll();
}
#endif
quit();
}
void OBSApp::processSigQuit()
{
if (!sigQuitNotifier->isEnabled()) {
return;
}
sigQuitNotifier->setEnabled(false);
char tmp;
::recv(sigQuitFileDescriptor[1], &tmp, sizeof(tmp), 0);
sigQuitNotifier->setEnabled(true);
#ifndef __APPLE__
OBSBasic *main = OBSBasic::Get();
if (main) {
main->saveAll();
}
#endif
quit();
}
#else
// App instance signal processor stub methods used on Windows for OBSApp API compliance
void OBSApp::processSigInt()
{
return;
}
void OBSApp::processSigTerm()
{
return;
}
void OBSApp::processSigAbrt()
{
return;
}
void OBSApp::processSigQuit()
{
return;
}
#endif
void OBSApp::commitData(QSessionManager &manager)
{
OBSBasic *main = OBSBasic::Get();
if (main) {
main->saveAll();
if (manager.allowsInteraction() && main->shouldPromptForClose()) {
manager.cancel();
}
}
}
void OBSApp::applicationShutdown() noexcept
{
#ifdef _WIN32
bool disableAudioDucking = config_get_bool(appConfig, "Audio", "DisableAudioDucking");
if (disableAudioDucking)
DisableAudioDucking(false);
#else
auto disconnectSignal = [this](std::array<int, 2> &fileDescriptor,
QPointer<QSocketNotifier> &notifier) -> void {
notifier->setEnabled(false);
std::array<int, 2> tempFileDescriptor = std::exchange(fileDescriptor, {0, 0});
::close(tempFileDescriptor[0]);
::close(tempFileDescriptor[1]);
};
disconnectSignal(sigIntFileDescriptor, sigIntNotifier);
disconnectSignal(sigTermFileDescriptor, sigTermNotifier);
disconnectSignal(sigAbrtFileDescriptor, sigAbrtNotifier);
disconnectSignal(sigQuitFileDescriptor, sigQuitNotifier);
#endif
#ifdef __APPLE__
bool vsyncDisabled = config_get_bool(appConfig, "Video", "DisableOSXVSync");
bool resetVSync = config_get_bool(appConfig, "Video", "ResetOSXVSyncOnExit");
if (vsyncDisabled && resetVSync)
EnableOSXVSync(true);
#endif
os_inhibit_sleep_set_active(sleepInhibitor, false);
os_inhibit_sleep_destroy(sleepInhibitor);
if (libobs_initialized) {
obs_shutdown();
libobs_initialized = false;
}
}
void OBSApp::addLogLine(int logLevel, const QString &message)
{
emit logLineAdded(logLevel, message);
}
void OBSApp::loadAppModules(struct obs_module_failure_info &mfi)
{
pluginManager_->preLoad();
blog(LOG_INFO, "---------------------------------");
obs_load_all_modules2(&mfi);
blog(LOG_INFO, "---------------------------------");
obs_log_loaded_modules();
blog(LOG_INFO, "---------------------------------");
obs_post_load_modules();
pluginManager_->postLoad();
}
void OBSApp::pluginManagerOpenDialog()
{
pluginManager_->open();
}