OBSBasicFilters.cpp 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126
  1. /******************************************************************************
  2. Copyright (C) 2023 by Lain Bailey <[email protected]>
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 2 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. ******************************************************************************/
  14. #include "OBSBasicFilters.hpp"
  15. #include <components/VisibilityItemDelegate.hpp>
  16. #include <components/VisibilityItemWidget.hpp>
  17. #include <dialogs/NameDialog.hpp>
  18. #include <utility/display-helpers.hpp>
  19. #include <utility/item-widget-helpers.hpp>
  20. #include <widgets/OBSBasic.hpp>
  21. #include <properties-view.hpp>
  22. #include <qt-wrappers.hpp>
  23. #include <QLineEdit>
  24. #ifdef _WIN32
  25. #define WIN32_LEAN_AND_MEAN 1
  26. #include <Windows.h>
  27. #endif
  28. #include "moc_OBSBasicFilters.cpp"
  29. using namespace std;
  30. OBSBasicFilters::OBSBasicFilters(QWidget *parent, OBSSource source_)
  31. : QDialog(parent),
  32. ui(new Ui::OBSBasicFilters),
  33. source(source_),
  34. addSignal(obs_source_get_signal_handler(source), "filter_add", OBSBasicFilters::OBSSourceFilterAdded, this),
  35. removeSignal(obs_source_get_signal_handler(source), "filter_remove", OBSBasicFilters::OBSSourceFilterRemoved,
  36. this),
  37. reorderSignal(obs_source_get_signal_handler(source), "reorder_filters", OBSBasicFilters::OBSSourceReordered,
  38. this),
  39. removeSourceSignal(obs_source_get_signal_handler(source), "remove", OBSBasicFilters::SourceRemoved, this),
  40. renameSourceSignal(obs_source_get_signal_handler(source), "rename", OBSBasicFilters::SourceRenamed, this),
  41. noPreviewMargin(13)
  42. {
  43. main = reinterpret_cast<OBSBasic *>(parent);
  44. setWindowFlags(windowFlags() & ~Qt::WindowContextHelpButtonHint);
  45. ui->setupUi(this);
  46. ui->asyncFilters->setItemDelegate(new VisibilityItemDelegate(ui->asyncFilters));
  47. ui->effectFilters->setItemDelegate(new VisibilityItemDelegate(ui->effectFilters));
  48. const char *name = obs_source_get_name(source);
  49. setWindowTitle(QTStr("Basic.Filters.Title").arg(QT_UTF8(name)));
  50. #ifndef QT_NO_SHORTCUT
  51. ui->actionRemoveFilter->setShortcut(QApplication::translate("OBSBasicFilters", "Del", nullptr));
  52. #endif // QT_NO_SHORTCUT
  53. addAction(ui->actionRenameFilter);
  54. addAction(ui->actionRemoveFilter);
  55. addAction(ui->actionMoveUp);
  56. addAction(ui->actionMoveDown);
  57. installEventFilter(CreateShortcutFilter());
  58. connect(ui->asyncFilters->itemDelegate(), &QAbstractItemDelegate::closeEditor,
  59. [this](QWidget *editor) { FilterNameEdited(editor, ui->asyncFilters); });
  60. connect(ui->effectFilters->itemDelegate(), &QAbstractItemDelegate::closeEditor,
  61. [this](QWidget *editor) { FilterNameEdited(editor, ui->effectFilters); });
  62. QPushButton *close = ui->buttonBox->button(QDialogButtonBox::Close);
  63. connect(close, &QPushButton::clicked, this, &OBSBasicFilters::close);
  64. close->setDefault(true);
  65. connect(ui->buttonBox->button(QDialogButtonBox::RestoreDefaults), &QPushButton::clicked, this,
  66. &OBSBasicFilters::ResetFilters);
  67. connect(ui->asyncFilters->model(), &QAbstractItemModel::rowsMoved, this, &OBSBasicFilters::FiltersMoved);
  68. connect(ui->effectFilters->model(), &QAbstractItemModel::rowsMoved, this, &OBSBasicFilters::FiltersMoved);
  69. uint32_t caps = obs_source_get_output_flags(source);
  70. bool audio = (caps & OBS_SOURCE_AUDIO) != 0;
  71. bool audioOnly = (caps & OBS_SOURCE_VIDEO) == 0;
  72. bool async = (caps & OBS_SOURCE_ASYNC) != 0;
  73. if (!async && !audio) {
  74. ui->asyncWidget->setVisible(false);
  75. ui->separatorLine->setVisible(false);
  76. }
  77. if (audioOnly) {
  78. ui->effectWidget->setVisible(false);
  79. ui->separatorLine->setVisible(false);
  80. UpdateSplitter(false);
  81. }
  82. if (async && !audioOnly && ui->asyncFilters->count() == 0 && ui->effectFilters->count() != 0) {
  83. ui->effectFilters->setFocus();
  84. }
  85. if (audioOnly || (audio && !async))
  86. ui->asyncLabel->setText(QTStr("Basic.Filters.AudioFilters"));
  87. if (async && audio && ui->asyncFilters->count() == 0) {
  88. UpdateSplitter(false);
  89. } else if (!audioOnly) {
  90. UpdateSplitter();
  91. }
  92. obs_source_inc_showing(source);
  93. auto addDrawCallback = [this]() {
  94. obs_display_add_draw_callback(ui->preview->GetDisplay(), OBSBasicFilters::DrawPreview, this);
  95. };
  96. enum obs_source_type type = obs_source_get_type(source);
  97. bool drawable_type = type == OBS_SOURCE_TYPE_INPUT || type == OBS_SOURCE_TYPE_SCENE;
  98. if ((caps & OBS_SOURCE_VIDEO) != 0) {
  99. ui->rightLayout->setContentsMargins(0, 0, 0, 0);
  100. ui->preview->show();
  101. if (drawable_type)
  102. connect(ui->preview, &OBSQTDisplay::DisplayCreated, addDrawCallback);
  103. } else {
  104. ui->rightLayout->setContentsMargins(0, noPreviewMargin, 0, 0);
  105. ui->preview->hide();
  106. }
  107. #ifdef __APPLE__
  108. ui->actionRenameFilter->setShortcut({Qt::Key_Return});
  109. #else
  110. ui->actionRenameFilter->setShortcut({Qt::Key_F2});
  111. #endif
  112. UpdateFilters();
  113. }
  114. OBSBasicFilters::~OBSBasicFilters()
  115. {
  116. obs_source_dec_showing(source);
  117. ClearListItems(ui->asyncFilters);
  118. ClearListItems(ui->effectFilters);
  119. }
  120. void OBSBasicFilters::Init()
  121. {
  122. show();
  123. }
  124. inline OBSSource OBSBasicFilters::GetFilter(int row, bool async)
  125. {
  126. if (row == -1)
  127. return OBSSource();
  128. QListWidget *list = async ? ui->asyncFilters : ui->effectFilters;
  129. QListWidgetItem *item = list->item(row);
  130. if (!item)
  131. return OBSSource();
  132. QVariant v = item->data(Qt::UserRole);
  133. return v.value<OBSSource>();
  134. }
  135. void FilterChangeUndoRedo(void *vp, obs_data_t *nd_old_settings, obs_data_t *new_settings)
  136. {
  137. obs_source_t *source = reinterpret_cast<obs_source_t *>(vp);
  138. const char *source_uuid = obs_source_get_uuid(source);
  139. const char *name = obs_source_get_name(source);
  140. OBSBasic *main = OBSBasic::Get();
  141. OBSDataAutoRelease redo_wrapper = obs_data_create();
  142. obs_data_set_string(redo_wrapper, "uuid", source_uuid);
  143. obs_data_set_string(redo_wrapper, "settings", obs_data_get_json(new_settings));
  144. OBSDataAutoRelease undo_wrapper = obs_data_create();
  145. obs_data_set_string(undo_wrapper, "uuid", source_uuid);
  146. obs_data_set_string(undo_wrapper, "settings", obs_data_get_json(nd_old_settings));
  147. auto undo_redo = [](const std::string &data) {
  148. OBSDataAutoRelease dat = obs_data_create_from_json(data.c_str());
  149. const char *filter_uuid = obs_data_get_string(dat, "uuid");
  150. OBSSourceAutoRelease filter = obs_get_source_by_uuid(filter_uuid);
  151. OBSDataAutoRelease new_settings = obs_data_create_from_json(obs_data_get_string(dat, "settings"));
  152. OBSDataAutoRelease current_settings = obs_source_get_settings(filter);
  153. obs_data_clear(current_settings);
  154. obs_source_update(filter, new_settings);
  155. obs_source_update_properties(filter);
  156. };
  157. main->undo_s.enable();
  158. std::string undo_data = obs_data_get_json(undo_wrapper);
  159. std::string redo_data = obs_data_get_json(redo_wrapper);
  160. main->undo_s.add_action(QTStr("Undo.Filters").arg(name), undo_redo, undo_redo, undo_data, redo_data);
  161. obs_source_update(source, new_settings);
  162. }
  163. void OBSBasicFilters::UpdatePropertiesView(int row, bool async)
  164. {
  165. OBSSource filter = GetFilter(row, async);
  166. if (filter && view && view->IsObject(filter)) {
  167. /* do not recreate properties view if already using a view
  168. * with the same object */
  169. return;
  170. }
  171. if (view) {
  172. updatePropertiesSignal.Disconnect();
  173. ui->propertiesFrame->setVisible(false);
  174. /* Deleting a filter will trigger a visibility change, which will also
  175. * trigger a focus change if the focus has not been on the list itself
  176. * (e.g. after interacting with the property view).
  177. *
  178. * When an async filter list is available in the view, it will be the first
  179. * candidate to receive focus. If this list is empty, we hide the property
  180. * view by default and set the view to a `nullptr`.
  181. *
  182. * When the call for the visibility change returns, we need to check for
  183. * this possibility, as another event might have hidden (and deleted) the
  184. * view already.
  185. *
  186. * macOS might be especially affected as it doesn't switch keyboard focus
  187. * to buttons like Windows does. */
  188. if (view) {
  189. view->hide();
  190. view->deleteLater();
  191. view = nullptr;
  192. }
  193. }
  194. if (!filter)
  195. return;
  196. OBSDataAutoRelease settings = obs_source_get_settings(filter);
  197. auto disabled_undo = [](void *vp, obs_data_t *settings) {
  198. OBSBasic *main = reinterpret_cast<OBSBasic *>(App()->GetMainWindow());
  199. main->undo_s.disable();
  200. obs_source_t *source = reinterpret_cast<obs_source_t *>(vp);
  201. obs_source_update(source, settings);
  202. };
  203. view = new OBSPropertiesView(settings.Get(), filter, (PropertiesReloadCallback)obs_source_properties,
  204. (PropertiesUpdateCallback)FilterChangeUndoRedo,
  205. (PropertiesVisualUpdateCb)disabled_undo);
  206. updatePropertiesSignal.Connect(obs_source_get_signal_handler(filter), "update_properties",
  207. OBSBasicFilters::UpdateProperties, this);
  208. view->setMinimumHeight(150);
  209. UpdateSplitter();
  210. ui->propertiesLayout->addWidget(view);
  211. view->show();
  212. }
  213. void OBSBasicFilters::UpdateProperties(void *data, calldata_t *)
  214. {
  215. QMetaObject::invokeMethod(static_cast<OBSBasicFilters *>(data)->view, "ReloadProperties");
  216. }
  217. void OBSBasicFilters::AddFilter(OBSSource filter, bool focus)
  218. {
  219. uint32_t flags = obs_source_get_output_flags(filter);
  220. bool async = (flags & OBS_SOURCE_ASYNC) != 0;
  221. QListWidget *list = async ? ui->asyncFilters : ui->effectFilters;
  222. QListWidgetItem *item = new QListWidgetItem();
  223. Qt::ItemFlags itemFlags = item->flags();
  224. item->setFlags(itemFlags | Qt::ItemIsEditable);
  225. item->setData(Qt::UserRole, QVariant::fromValue(filter));
  226. list->addItem(item);
  227. if (focus)
  228. list->setCurrentItem(item);
  229. SetupVisibilityItem(list, item, filter);
  230. }
  231. void OBSBasicFilters::RemoveFilter(OBSSource filter)
  232. {
  233. uint32_t flags = obs_source_get_output_flags(filter);
  234. bool async = (flags & OBS_SOURCE_ASYNC) != 0;
  235. QListWidget *list = async ? ui->asyncFilters : ui->effectFilters;
  236. for (int i = 0; i < list->count(); i++) {
  237. QListWidgetItem *item = list->item(i);
  238. QVariant v = item->data(Qt::UserRole);
  239. OBSSource curFilter = v.value<OBSSource>();
  240. if (filter == curFilter) {
  241. DeleteListItem(list, item);
  242. break;
  243. }
  244. }
  245. const char *filterName = obs_source_get_name(filter);
  246. const char *sourceName = obs_source_get_name(source);
  247. if (!sourceName || !filterName)
  248. return;
  249. const char *filterId = obs_source_get_id(filter);
  250. blog(LOG_INFO, "User removed filter '%s' (%s) from source '%s'", filterName, filterId, sourceName);
  251. main->SaveProject();
  252. }
  253. struct FilterOrderInfo {
  254. int asyncIdx = 0;
  255. int effectIdx = 0;
  256. OBSBasicFilters *window;
  257. inline FilterOrderInfo(OBSBasicFilters *window_) : window(window_) {}
  258. };
  259. void OBSBasicFilters::ReorderFilter(QListWidget *list, obs_source_t *filter, size_t idx)
  260. {
  261. int count = list->count();
  262. for (int i = 0; i < count; i++) {
  263. QListWidgetItem *listItem = list->item(i);
  264. QVariant v = listItem->data(Qt::UserRole);
  265. OBSSource filterItem = v.value<OBSSource>();
  266. if (filterItem == filter) {
  267. if ((int)idx != i) {
  268. bool sel = (list->currentRow() == i);
  269. listItem = TakeListItem(list, i);
  270. if (listItem) {
  271. list->insertItem((int)idx, listItem);
  272. SetupVisibilityItem(list, listItem, filterItem);
  273. if (sel)
  274. list->setCurrentRow((int)idx);
  275. }
  276. }
  277. break;
  278. }
  279. }
  280. }
  281. void OBSBasicFilters::ReorderFilters()
  282. {
  283. FilterOrderInfo info(this);
  284. obs_source_enum_filters(
  285. source,
  286. [](obs_source_t *, obs_source_t *filter, void *p) {
  287. FilterOrderInfo *info = reinterpret_cast<FilterOrderInfo *>(p);
  288. uint32_t flags;
  289. bool async;
  290. flags = obs_source_get_output_flags(filter);
  291. async = (flags & OBS_SOURCE_ASYNC) != 0;
  292. if (async) {
  293. info->window->ReorderFilter(info->window->ui->asyncFilters, filter, info->asyncIdx++);
  294. } else {
  295. info->window->ReorderFilter(info->window->ui->effectFilters, filter, info->effectIdx++);
  296. }
  297. },
  298. &info);
  299. }
  300. void OBSBasicFilters::UpdateFilters()
  301. {
  302. if (!source)
  303. return;
  304. ClearListItems(ui->effectFilters);
  305. ClearListItems(ui->asyncFilters);
  306. obs_source_enum_filters(
  307. source,
  308. [](obs_source_t *, obs_source_t *filter, void *p) {
  309. OBSBasicFilters *window = reinterpret_cast<OBSBasicFilters *>(p);
  310. window->AddFilter(filter, false);
  311. },
  312. this);
  313. if (ui->asyncFilters->count() > 0) {
  314. ui->asyncFilters->setCurrentItem(ui->asyncFilters->item(0));
  315. } else if (ui->effectFilters->count() > 0) {
  316. ui->effectFilters->setCurrentItem(ui->effectFilters->item(0));
  317. }
  318. main->SaveProject();
  319. }
  320. void OBSBasicFilters::UpdateSplitter()
  321. {
  322. bool show_splitter_frame = ui->asyncFilters->count() + ui->effectFilters->count() > 0;
  323. UpdateSplitter(show_splitter_frame);
  324. }
  325. void OBSBasicFilters::UpdateSplitter(bool show_splitter_frame)
  326. {
  327. bool show_splitter_handle = show_splitter_frame;
  328. uint32_t caps = obs_source_get_output_flags(source);
  329. if ((caps & OBS_SOURCE_VIDEO) == 0)
  330. show_splitter_handle = false;
  331. for (int i = 0; i < ui->rightLayout->count(); i++) {
  332. QSplitterHandle *hndl = ui->rightLayout->handle(i);
  333. hndl->setEnabled(show_splitter_handle);
  334. }
  335. ui->propertiesFrame->setVisible(show_splitter_frame);
  336. }
  337. static bool filter_compatible(bool async, uint32_t sourceFlags, uint32_t filterFlags)
  338. {
  339. bool filterVideo = (filterFlags & OBS_SOURCE_VIDEO) != 0;
  340. bool filterAsync = (filterFlags & OBS_SOURCE_ASYNC) != 0;
  341. bool filterAudio = (filterFlags & OBS_SOURCE_AUDIO) != 0;
  342. bool audio = (sourceFlags & OBS_SOURCE_AUDIO) != 0;
  343. bool audioOnly = (sourceFlags & OBS_SOURCE_VIDEO) == 0;
  344. bool asyncSource = (sourceFlags & OBS_SOURCE_ASYNC) != 0;
  345. if (async && ((audioOnly && filterVideo) || (!audio && !asyncSource) || (filterAudio && !audio) ||
  346. (!asyncSource && !filterAudio)))
  347. return false;
  348. return (async && (filterAudio || filterAsync)) || (!async && !filterAudio && !filterAsync);
  349. }
  350. QMenu *OBSBasicFilters::CreateAddFilterPopupMenu(bool async)
  351. {
  352. uint32_t sourceFlags = obs_source_get_output_flags(source);
  353. const char *type_str;
  354. bool foundValues = false;
  355. size_t idx = 0;
  356. struct FilterInfo {
  357. string type;
  358. string name;
  359. inline FilterInfo(const char *type_, const char *name_) : type(type_), name(name_) {}
  360. bool operator<(const FilterInfo &r) const { return name < r.name; }
  361. };
  362. vector<FilterInfo> types;
  363. while (obs_enum_filter_types(idx++, &type_str)) {
  364. const char *name = obs_source_get_display_name(type_str);
  365. uint32_t caps = obs_get_source_output_flags(type_str);
  366. if ((caps & OBS_SOURCE_DEPRECATED) != 0)
  367. continue;
  368. if ((caps & OBS_SOURCE_CAP_DISABLED) != 0)
  369. continue;
  370. if ((caps & OBS_SOURCE_CAP_OBSOLETE) != 0)
  371. continue;
  372. types.emplace_back(type_str, name);
  373. }
  374. sort(types.begin(), types.end());
  375. QMenu *popup = new QMenu(QTStr("Add"), this);
  376. for (FilterInfo &type : types) {
  377. uint32_t filterFlags = obs_get_source_output_flags(type.type.c_str());
  378. if (!filter_compatible(async, sourceFlags, filterFlags))
  379. continue;
  380. QAction *popupItem = new QAction(QT_UTF8(type.name.c_str()), this);
  381. popupItem->setData(QT_UTF8(type.type.c_str()));
  382. connect(popupItem, &QAction::triggered, [this, type]() { AddNewFilter(type.type.c_str()); });
  383. popup->addAction(popupItem);
  384. foundValues = true;
  385. }
  386. if (!foundValues) {
  387. delete popup;
  388. popup = nullptr;
  389. }
  390. return popup;
  391. }
  392. void OBSBasicFilters::AddNewFilter(const char *id)
  393. {
  394. if (id && *id) {
  395. OBSSourceAutoRelease existing_filter;
  396. string name = obs_source_get_display_name(id);
  397. QString placeholder = QString::fromStdString(name);
  398. QString text{placeholder};
  399. int i = 2;
  400. while ((existing_filter = obs_source_get_filter_by_name(source, QT_TO_UTF8(text)))) {
  401. text = QString("%1 %2").arg(placeholder).arg(i++);
  402. }
  403. bool success = NameDialog::AskForName(this, QTStr("Basic.Filters.AddFilter.Title"),
  404. QTStr("Basic.Filters.AddFilter.Text"), name, text);
  405. if (!success)
  406. return;
  407. if (name.empty()) {
  408. OBSMessageBox::warning(this, QTStr("NoNameEntered.Title"), QTStr("NoNameEntered.Text"));
  409. AddNewFilter(id);
  410. return;
  411. }
  412. existing_filter = obs_source_get_filter_by_name(source, name.c_str());
  413. if (existing_filter) {
  414. OBSMessageBox::warning(this, QTStr("NameExists.Title"), QTStr("NameExists.Text"));
  415. AddNewFilter(id);
  416. return;
  417. }
  418. OBSSourceAutoRelease filter = obs_source_create(id, name.c_str(), nullptr, nullptr);
  419. if (filter) {
  420. const char *sourceName = obs_source_get_name(source);
  421. blog(LOG_INFO, "User added filter '%s' (%s) to source '%s'", name.c_str(), id, sourceName);
  422. obs_source_filter_add(source, filter);
  423. } else {
  424. blog(LOG_WARNING, "Creating filter '%s' failed!", id);
  425. return;
  426. }
  427. std::string parent_uuid(obs_source_get_uuid(source));
  428. std::string scene_uuid = obs_source_get_uuid(
  429. reinterpret_cast<OBSBasic *>(App()->GetMainWindow())->GetCurrentSceneSource());
  430. /* In order to ensure that the UUID persists through undo/redo,
  431. * we save the source data rather than just recreating the
  432. * source from scratch. */
  433. OBSDataAutoRelease rwrapper = obs_save_source(filter);
  434. obs_data_set_string(rwrapper, "undo_uuid", parent_uuid.c_str());
  435. OBSDataAutoRelease uwrapper = obs_data_create();
  436. obs_data_set_string(uwrapper, "fname", obs_source_get_name(filter));
  437. obs_data_set_string(uwrapper, "suuid", parent_uuid.c_str());
  438. auto undo = [scene_uuid](const std::string &data) {
  439. OBSSourceAutoRelease ssource = obs_get_source_by_uuid(scene_uuid.c_str());
  440. reinterpret_cast<OBSBasic *>(App()->GetMainWindow())->SetCurrentScene(ssource.Get(), true);
  441. OBSDataAutoRelease dat = obs_data_create_from_json(data.c_str());
  442. OBSSourceAutoRelease source = obs_get_source_by_uuid(obs_data_get_string(dat, "suuid"));
  443. OBSSourceAutoRelease filter =
  444. obs_source_get_filter_by_name(source, obs_data_get_string(dat, "fname"));
  445. obs_source_filter_remove(source, filter);
  446. };
  447. auto redo = [scene_uuid](const std::string &data) {
  448. OBSSourceAutoRelease ssource = obs_get_source_by_uuid(scene_uuid.c_str());
  449. reinterpret_cast<OBSBasic *>(App()->GetMainWindow())->SetCurrentScene(ssource.Get(), true);
  450. OBSDataAutoRelease dat = obs_data_create_from_json(data.c_str());
  451. OBSSourceAutoRelease source = obs_get_source_by_uuid(obs_data_get_string(dat, "undo_uuid"));
  452. OBSSourceAutoRelease filter = obs_load_source(dat);
  453. obs_source_filter_add(source, filter);
  454. };
  455. std::string undo_data(obs_data_get_json(uwrapper));
  456. std::string redo_data(obs_data_get_json(rwrapper));
  457. main->undo_s.add_action(QTStr("Undo.Add").arg(obs_source_get_name(filter)), undo, redo, undo_data,
  458. redo_data, false);
  459. }
  460. }
  461. void OBSBasicFilters::closeEvent(QCloseEvent *event)
  462. {
  463. QDialog::closeEvent(event);
  464. if (!event->isAccepted())
  465. return;
  466. obs_display_remove_draw_callback(ui->preview->GetDisplay(), OBSBasicFilters::DrawPreview, this);
  467. main->SaveProject();
  468. }
  469. bool OBSBasicFilters::nativeEvent(const QByteArray &, void *message, qintptr *)
  470. {
  471. #ifdef _WIN32
  472. const MSG &msg = *static_cast<MSG *>(message);
  473. switch (msg.message) {
  474. case WM_MOVE:
  475. for (OBSQTDisplay *const display : findChildren<OBSQTDisplay *>()) {
  476. display->OnMove();
  477. }
  478. break;
  479. case WM_DISPLAYCHANGE:
  480. for (OBSQTDisplay *const display : findChildren<OBSQTDisplay *>()) {
  481. display->OnDisplayChange();
  482. }
  483. }
  484. #else
  485. UNUSED_PARAMETER(message);
  486. #endif
  487. return false;
  488. }
  489. /* OBS Signals */
  490. void OBSBasicFilters::OBSSourceFilterAdded(void *param, calldata_t *data)
  491. {
  492. OBSBasicFilters *window = reinterpret_cast<OBSBasicFilters *>(param);
  493. obs_source_t *filter = (obs_source_t *)calldata_ptr(data, "filter");
  494. QMetaObject::invokeMethod(window, "AddFilter", Q_ARG(OBSSource, OBSSource(filter)));
  495. }
  496. void OBSBasicFilters::OBSSourceFilterRemoved(void *param, calldata_t *data)
  497. {
  498. OBSBasicFilters *window = reinterpret_cast<OBSBasicFilters *>(param);
  499. obs_source_t *filter = (obs_source_t *)calldata_ptr(data, "filter");
  500. QMetaObject::invokeMethod(window, "RemoveFilter", Q_ARG(OBSSource, OBSSource(filter)));
  501. }
  502. void OBSBasicFilters::OBSSourceReordered(void *param, calldata_t *)
  503. {
  504. QMetaObject::invokeMethod(reinterpret_cast<OBSBasicFilters *>(param), "ReorderFilters");
  505. }
  506. void OBSBasicFilters::SourceRemoved(void *param, calldata_t *)
  507. {
  508. QMetaObject::invokeMethod(static_cast<OBSBasicFilters *>(param), "close");
  509. }
  510. void OBSBasicFilters::SourceRenamed(void *param, calldata_t *data)
  511. {
  512. const char *name = calldata_string(data, "new_name");
  513. QString title = QTStr("Basic.Filters.Title").arg(QT_UTF8(name));
  514. QMetaObject::invokeMethod(static_cast<OBSBasicFilters *>(param), "setWindowTitle", Q_ARG(QString, title));
  515. }
  516. void OBSBasicFilters::DrawPreview(void *data, uint32_t cx, uint32_t cy)
  517. {
  518. OBSBasicFilters *window = static_cast<OBSBasicFilters *>(data);
  519. if (!window->source)
  520. return;
  521. uint32_t sourceCX = max(obs_source_get_width(window->source), 1u);
  522. uint32_t sourceCY = max(obs_source_get_height(window->source), 1u);
  523. int x, y;
  524. int newCX, newCY;
  525. float scale;
  526. GetScaleAndCenterPos(sourceCX, sourceCY, cx, cy, x, y, scale);
  527. newCX = int(scale * float(sourceCX));
  528. newCY = int(scale * float(sourceCY));
  529. gs_viewport_push();
  530. gs_projection_push();
  531. const bool previous = gs_set_linear_srgb(true);
  532. gs_ortho(0.0f, float(sourceCX), 0.0f, float(sourceCY), -100.0f, 100.0f);
  533. gs_set_viewport(x, y, newCX, newCY);
  534. obs_source_video_render(window->source);
  535. gs_set_linear_srgb(previous);
  536. gs_projection_pop();
  537. gs_viewport_pop();
  538. }
  539. /* Qt Slots */
  540. static bool QueryRemove(QWidget *parent, obs_source_t *source)
  541. {
  542. const char *name = obs_source_get_name(source);
  543. QString text = QTStr("ConfirmRemove.Text").arg(QT_UTF8(name));
  544. QMessageBox remove_source(parent);
  545. remove_source.setText(text);
  546. QAbstractButton *Yes = remove_source.addButton(QTStr("Yes"), QMessageBox::YesRole);
  547. remove_source.addButton(QTStr("No"), QMessageBox::NoRole);
  548. remove_source.setIcon(QMessageBox::Question);
  549. remove_source.setWindowTitle(QTStr("ConfirmRemove.Title"));
  550. remove_source.exec();
  551. return Yes == remove_source.clickedButton();
  552. }
  553. void OBSBasicFilters::on_addAsyncFilter_clicked()
  554. {
  555. ui->asyncFilters->setFocus();
  556. QScopedPointer<QMenu> popup(CreateAddFilterPopupMenu(true));
  557. if (popup)
  558. popup->exec(QCursor::pos());
  559. }
  560. void OBSBasicFilters::on_removeAsyncFilter_clicked()
  561. {
  562. OBSSource filter = GetFilter(ui->asyncFilters->currentRow(), true);
  563. if (filter) {
  564. if (QueryRemove(this, filter))
  565. delete_filter(filter);
  566. }
  567. }
  568. void OBSBasicFilters::on_moveAsyncFilterUp_clicked()
  569. {
  570. OBSSource filter = GetFilter(ui->asyncFilters->currentRow(), true);
  571. if (filter)
  572. obs_source_filter_set_order(source, filter, OBS_ORDER_MOVE_UP);
  573. }
  574. void OBSBasicFilters::on_moveAsyncFilterDown_clicked()
  575. {
  576. OBSSource filter = GetFilter(ui->asyncFilters->currentRow(), true);
  577. if (filter)
  578. obs_source_filter_set_order(source, filter, OBS_ORDER_MOVE_DOWN);
  579. }
  580. void OBSBasicFilters::on_asyncFilters_GotFocus()
  581. {
  582. UpdatePropertiesView(ui->asyncFilters->currentRow(), true);
  583. isAsync = true;
  584. }
  585. void OBSBasicFilters::on_asyncFilters_currentRowChanged(int row)
  586. {
  587. UpdatePropertiesView(row, true);
  588. }
  589. void OBSBasicFilters::on_addEffectFilter_clicked()
  590. {
  591. ui->effectFilters->setFocus();
  592. QScopedPointer<QMenu> popup(CreateAddFilterPopupMenu(false));
  593. if (popup)
  594. popup->exec(QCursor::pos());
  595. }
  596. void OBSBasicFilters::on_removeEffectFilter_clicked()
  597. {
  598. OBSSource filter = GetFilter(ui->effectFilters->currentRow(), false);
  599. if (filter) {
  600. if (QueryRemove(this, filter)) {
  601. delete_filter(filter);
  602. }
  603. }
  604. }
  605. void OBSBasicFilters::on_moveEffectFilterUp_clicked()
  606. {
  607. OBSSource filter = GetFilter(ui->effectFilters->currentRow(), false);
  608. if (filter)
  609. obs_source_filter_set_order(source, filter, OBS_ORDER_MOVE_UP);
  610. }
  611. void OBSBasicFilters::on_moveEffectFilterDown_clicked()
  612. {
  613. OBSSource filter = GetFilter(ui->effectFilters->currentRow(), false);
  614. if (filter)
  615. obs_source_filter_set_order(source, filter, OBS_ORDER_MOVE_DOWN);
  616. }
  617. void OBSBasicFilters::on_effectFilters_GotFocus()
  618. {
  619. UpdatePropertiesView(ui->effectFilters->currentRow(), false);
  620. isAsync = false;
  621. }
  622. void OBSBasicFilters::on_effectFilters_currentRowChanged(int row)
  623. {
  624. UpdatePropertiesView(row, false);
  625. }
  626. void OBSBasicFilters::on_actionRemoveFilter_triggered()
  627. {
  628. if (ui->asyncFilters->hasFocus())
  629. on_removeAsyncFilter_clicked();
  630. else if (ui->effectFilters->hasFocus())
  631. on_removeEffectFilter_clicked();
  632. }
  633. void OBSBasicFilters::on_actionMoveUp_triggered()
  634. {
  635. if (ui->asyncFilters->hasFocus())
  636. on_moveAsyncFilterUp_clicked();
  637. else if (ui->effectFilters->hasFocus())
  638. on_moveEffectFilterUp_clicked();
  639. }
  640. void OBSBasicFilters::on_actionMoveDown_triggered()
  641. {
  642. if (ui->asyncFilters->hasFocus())
  643. on_moveAsyncFilterDown_clicked();
  644. else if (ui->effectFilters->hasFocus())
  645. on_moveEffectFilterDown_clicked();
  646. }
  647. void OBSBasicFilters::on_actionRenameFilter_triggered()
  648. {
  649. if (ui->asyncFilters->hasFocus())
  650. RenameAsyncFilter();
  651. else if (ui->effectFilters->hasFocus())
  652. RenameEffectFilter();
  653. }
  654. void OBSBasicFilters::CustomContextMenu(const QPoint &pos, bool async)
  655. {
  656. QListWidget *list = async ? ui->asyncFilters : ui->effectFilters;
  657. QListWidgetItem *item = list->itemAt(pos);
  658. QMenu popup(window());
  659. QPointer<QMenu> addMenu = CreateAddFilterPopupMenu(async);
  660. if (addMenu)
  661. popup.addMenu(addMenu);
  662. if (item) {
  663. popup.addSeparator();
  664. popup.addAction(QTStr("Duplicate"), this, [&]() {
  665. DuplicateItem(async ? ui->asyncFilters->currentItem() : ui->effectFilters->currentItem());
  666. });
  667. popup.addSeparator();
  668. popup.addAction(ui->actionRenameFilter);
  669. popup.addAction(ui->actionRemoveFilter);
  670. popup.addSeparator();
  671. QAction *copyAction = new QAction(QTStr("Copy"));
  672. connect(copyAction, &QAction::triggered, this, &OBSBasicFilters::CopyFilter);
  673. copyAction->setShortcut(QKeySequence(Qt::CTRL | Qt::Key_C));
  674. ui->effectWidget->addAction(copyAction);
  675. ui->asyncWidget->addAction(copyAction);
  676. popup.addAction(copyAction);
  677. }
  678. QAction *pasteAction = new QAction(QTStr("Paste"));
  679. pasteAction->setEnabled(main->copyFilter);
  680. connect(pasteAction, &QAction::triggered, this, &OBSBasicFilters::PasteFilter);
  681. pasteAction->setShortcut(QKeySequence(Qt::CTRL | Qt::Key_V));
  682. ui->effectWidget->addAction(pasteAction);
  683. ui->asyncWidget->addAction(pasteAction);
  684. popup.addAction(pasteAction);
  685. popup.exec(QCursor::pos());
  686. }
  687. void OBSBasicFilters::EditItem(QListWidgetItem *item, bool async)
  688. {
  689. if (editActive)
  690. return;
  691. Qt::ItemFlags flags = item->flags();
  692. OBSSource filter = item->data(Qt::UserRole).value<OBSSource>();
  693. const char *name = obs_source_get_name(filter);
  694. QListWidget *list = async ? ui->asyncFilters : ui->effectFilters;
  695. item->setText(QT_UTF8(name));
  696. item->setFlags(flags | Qt::ItemIsEditable);
  697. list->removeItemWidget(item);
  698. list->editItem(item);
  699. item->setFlags(flags);
  700. editActive = true;
  701. }
  702. void OBSBasicFilters::DuplicateItem(QListWidgetItem *item)
  703. {
  704. OBSSource filter = item->data(Qt::UserRole).value<OBSSource>();
  705. string name = obs_source_get_name(filter);
  706. OBSSourceAutoRelease existing_filter;
  707. QString placeholder = QString::fromStdString(name);
  708. QString text{placeholder};
  709. int i = 2;
  710. while ((existing_filter = obs_source_get_filter_by_name(source, QT_TO_UTF8(text)))) {
  711. text = QString("%1 %2").arg(placeholder).arg(i++);
  712. }
  713. bool success = NameDialog::AskForName(this, QTStr("Basic.Filters.AddFilter.Title"),
  714. QTStr("Basic.Filters.AddFilter.Text"), name, text);
  715. if (!success)
  716. return;
  717. if (name.empty()) {
  718. OBSMessageBox::warning(this, QTStr("NoNameEntered.Title"), QTStr("NoNameEntered.Text"));
  719. DuplicateItem(item);
  720. return;
  721. }
  722. existing_filter = obs_source_get_filter_by_name(source, name.c_str());
  723. if (existing_filter) {
  724. OBSMessageBox::warning(this, QTStr("NameExists.Title"), QTStr("NameExists.Text"));
  725. DuplicateItem(item);
  726. return;
  727. }
  728. bool enabled = obs_source_enabled(filter);
  729. OBSSourceAutoRelease new_filter = obs_source_duplicate(filter, name.c_str(), false);
  730. if (new_filter) {
  731. const char *sourceName = obs_source_get_name(source);
  732. const char *id = obs_source_get_id(new_filter);
  733. blog(LOG_INFO,
  734. "User duplicated filter '%s' (%s) from '%s' "
  735. "to source '%s'",
  736. name.c_str(), id, name.c_str(), sourceName);
  737. obs_source_set_enabled(new_filter, enabled);
  738. obs_source_filter_add(source, new_filter);
  739. }
  740. }
  741. void OBSBasicFilters::on_asyncFilters_customContextMenuRequested(const QPoint &pos)
  742. {
  743. CustomContextMenu(pos, true);
  744. }
  745. void OBSBasicFilters::on_effectFilters_customContextMenuRequested(const QPoint &pos)
  746. {
  747. CustomContextMenu(pos, false);
  748. }
  749. void OBSBasicFilters::RenameAsyncFilter()
  750. {
  751. EditItem(ui->asyncFilters->currentItem(), true);
  752. }
  753. void OBSBasicFilters::RenameEffectFilter()
  754. {
  755. EditItem(ui->effectFilters->currentItem(), false);
  756. }
  757. void OBSBasicFilters::FilterNameEdited(QWidget *editor, QListWidget *list)
  758. {
  759. QListWidgetItem *listItem = list->currentItem();
  760. OBSSource filter = listItem->data(Qt::UserRole).value<OBSSource>();
  761. QLineEdit *edit = qobject_cast<QLineEdit *>(editor);
  762. string name = QT_TO_UTF8(edit->text().trimmed());
  763. const char *prevName = obs_source_get_name(filter);
  764. bool sameName = (name == prevName);
  765. OBSSourceAutoRelease foundFilter = nullptr;
  766. if (!sameName)
  767. foundFilter = obs_source_get_filter_by_name(source, name.c_str());
  768. if (foundFilter || name.empty() || sameName) {
  769. listItem->setText(QT_UTF8(prevName));
  770. if (foundFilter) {
  771. OBSMessageBox::information(window(), QTStr("NameExists.Title"), QTStr("NameExists.Text"));
  772. } else if (name.empty()) {
  773. OBSMessageBox::information(window(), QTStr("NoNameEntered.Title"), QTStr("NoNameEntered.Text"));
  774. }
  775. } else {
  776. const char *sourceName = obs_source_get_name(source);
  777. blog(LOG_INFO, "User renamed filter '%s' on source '%s' to '%s'", prevName, sourceName, name.c_str());
  778. listItem->setText(QT_UTF8(name.c_str()));
  779. obs_source_set_name(filter, name.c_str());
  780. std::string scene_uuid = obs_source_get_uuid(
  781. reinterpret_cast<OBSBasic *>(App()->GetMainWindow())->GetCurrentSceneSource());
  782. auto undo = [scene_uuid, prev = std::string(prevName), name](const std::string &uuid) {
  783. OBSSourceAutoRelease ssource = obs_get_source_by_uuid(scene_uuid.c_str());
  784. reinterpret_cast<OBSBasic *>(App()->GetMainWindow())->SetCurrentScene(ssource.Get(), true);
  785. OBSSourceAutoRelease filter = obs_get_source_by_uuid(uuid.c_str());
  786. obs_source_set_name(filter, prev.c_str());
  787. };
  788. auto redo = [scene_uuid, prev = std::string(prevName), name](const std::string &uuid) {
  789. OBSSourceAutoRelease ssource = obs_get_source_by_uuid(scene_uuid.c_str());
  790. reinterpret_cast<OBSBasic *>(App()->GetMainWindow())->SetCurrentScene(ssource.Get(), true);
  791. OBSSourceAutoRelease filter = obs_get_source_by_uuid(uuid.c_str());
  792. obs_source_set_name(filter, name.c_str());
  793. };
  794. std::string filter_uuid(obs_source_get_uuid(filter));
  795. main->undo_s.add_action(QTStr("Undo.Rename").arg(name.c_str()), undo, redo, filter_uuid, filter_uuid);
  796. }
  797. listItem->setText(QString());
  798. SetupVisibilityItem(list, listItem, filter);
  799. editActive = false;
  800. }
  801. static bool ConfirmReset(QWidget *parent)
  802. {
  803. QMessageBox::StandardButton button;
  804. button = OBSMessageBox::question(parent, QTStr("ConfirmReset.Title"), QTStr("ConfirmReset.Text"),
  805. QMessageBox::Yes | QMessageBox::No);
  806. return button == QMessageBox::Yes;
  807. }
  808. void OBSBasicFilters::ResetFilters()
  809. {
  810. QListWidget *list = isAsync ? ui->asyncFilters : ui->effectFilters;
  811. int row = list->currentRow();
  812. OBSSource filter = GetFilter(row, isAsync);
  813. if (!filter)
  814. return;
  815. if (!ConfirmReset(this))
  816. return;
  817. OBSDataAutoRelease settings = obs_source_get_settings(filter);
  818. OBSDataAutoRelease empty_settings = obs_data_create();
  819. FilterChangeUndoRedo((void *)filter, settings, empty_settings);
  820. obs_data_clear(settings);
  821. if (!view->DeferUpdate())
  822. obs_source_update(filter, nullptr);
  823. view->ReloadProperties();
  824. }
  825. void OBSBasicFilters::CopyFilter()
  826. {
  827. OBSSource filter = nullptr;
  828. if (isAsync)
  829. filter = GetFilter(ui->asyncFilters->currentRow(), true);
  830. else
  831. filter = GetFilter(ui->effectFilters->currentRow(), false);
  832. main->copyFilter = OBSGetWeakRef(filter);
  833. }
  834. void OBSBasicFilters::PasteFilter()
  835. {
  836. OBSSource filter = OBSGetStrongRef(main->copyFilter);
  837. if (!filter)
  838. return;
  839. OBSDataArrayAutoRelease undo_array = obs_source_backup_filters(source);
  840. obs_source_copy_single_filter(source, filter);
  841. OBSDataArrayAutoRelease redo_array = obs_source_backup_filters(source);
  842. const char *filterName = obs_source_get_name(filter);
  843. const char *sourceName = obs_source_get_name(source);
  844. QString text = QTStr("Undo.Filters.Paste.Single").arg(filterName, sourceName);
  845. main->CreateFilterPasteUndoRedoAction(text, source, undo_array, redo_array);
  846. }
  847. void OBSBasicFilters::delete_filter(OBSSource filter)
  848. {
  849. OBSDataAutoRelease wrapper = obs_save_source(filter);
  850. std::string parent_uuid(obs_source_get_uuid(source));
  851. obs_data_set_string(wrapper, "undo_uuid", parent_uuid.c_str());
  852. std::string scene_uuid =
  853. obs_source_get_uuid(reinterpret_cast<OBSBasic *>(App()->GetMainWindow())->GetCurrentSceneSource());
  854. auto undo = [scene_uuid](const std::string &data) {
  855. OBSSourceAutoRelease ssource = obs_get_source_by_uuid(scene_uuid.c_str());
  856. reinterpret_cast<OBSBasic *>(App()->GetMainWindow())->SetCurrentScene(ssource.Get(), true);
  857. OBSDataAutoRelease dat = obs_data_create_from_json(data.c_str());
  858. OBSSourceAutoRelease source = obs_get_source_by_uuid(obs_data_get_string(dat, "undo_uuid"));
  859. OBSSourceAutoRelease filter = obs_load_source(dat);
  860. obs_source_filter_add(source, filter);
  861. };
  862. OBSDataAutoRelease rwrapper = obs_data_create();
  863. obs_data_set_string(rwrapper, "fname", obs_source_get_name(filter));
  864. obs_data_set_string(rwrapper, "suuid", parent_uuid.c_str());
  865. auto redo = [scene_uuid](const std::string &data) {
  866. OBSSourceAutoRelease ssource = obs_get_source_by_uuid(scene_uuid.c_str());
  867. reinterpret_cast<OBSBasic *>(App()->GetMainWindow())->SetCurrentScene(ssource.Get(), true);
  868. OBSDataAutoRelease dat = obs_data_create_from_json(data.c_str());
  869. OBSSourceAutoRelease source = obs_get_source_by_uuid(obs_data_get_string(dat, "suuid"));
  870. OBSSourceAutoRelease filter = obs_source_get_filter_by_name(source, obs_data_get_string(dat, "fname"));
  871. obs_source_filter_remove(source, filter);
  872. };
  873. std::string undo_data(obs_data_get_json(wrapper));
  874. std::string redo_data(obs_data_get_json(rwrapper));
  875. main->undo_s.add_action(QTStr("Undo.Delete").arg(obs_source_get_name(filter)), undo, redo, undo_data, redo_data,
  876. false);
  877. obs_source_filter_remove(source, filter);
  878. }
  879. void OBSBasicFilters::FiltersMoved(const QModelIndex &, int srcIdxStart, int, const QModelIndex &, int)
  880. {
  881. QListWidget *list = isAsync ? ui->asyncFilters : ui->effectFilters;
  882. int neighborIdx = 0;
  883. if (srcIdxStart < list->currentRow())
  884. neighborIdx = list->currentRow() - 1;
  885. else if (srcIdxStart > list->currentRow())
  886. neighborIdx = list->currentRow() + 1;
  887. else
  888. return;
  889. if (neighborIdx > list->count() - 1)
  890. neighborIdx = list->count() - 1;
  891. else if (neighborIdx < 0)
  892. neighborIdx = 0;
  893. OBSSource neighbor = GetFilter(neighborIdx, isAsync);
  894. int idx = obs_source_filter_get_index(source, neighbor);
  895. OBSSource filter = GetFilter(list->currentRow(), isAsync);
  896. obs_source_filter_set_index(source, filter, idx);
  897. }