OBSBasicFilters.cpp 34 KB

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