window-basic-filters.cpp 35 KB

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