obs-properties.c 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402
  1. /******************************************************************************
  2. Copyright (C) 2014 by Hugh 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 "util/bmem.h"
  15. #include "util/darray.h"
  16. #include "obs-internal.h"
  17. #include "obs-properties.h"
  18. static inline void *get_property_data(struct obs_property *prop);
  19. /* ------------------------------------------------------------------------- */
  20. struct float_data {
  21. double min, max, step;
  22. enum obs_number_type type;
  23. char *suffix;
  24. };
  25. struct int_data {
  26. int min, max, step;
  27. enum obs_number_type type;
  28. char *suffix;
  29. };
  30. struct list_item {
  31. char *name;
  32. bool disabled;
  33. union {
  34. char *str;
  35. long long ll;
  36. double d;
  37. };
  38. };
  39. struct path_data {
  40. char *filter;
  41. char *default_path;
  42. enum obs_path_type type;
  43. };
  44. struct text_data {
  45. enum obs_text_type type;
  46. bool monospace;
  47. };
  48. struct list_data {
  49. DARRAY(struct list_item) items;
  50. enum obs_combo_type type;
  51. enum obs_combo_format format;
  52. };
  53. struct editable_list_data {
  54. enum obs_editable_list_type type;
  55. char *filter;
  56. char *default_path;
  57. };
  58. struct button_data {
  59. obs_property_clicked_t callback;
  60. };
  61. struct frame_rate_option {
  62. char *name;
  63. char *description;
  64. };
  65. struct frame_rate_range {
  66. struct media_frames_per_second min_time;
  67. struct media_frames_per_second max_time;
  68. };
  69. struct frame_rate_data {
  70. DARRAY(struct frame_rate_option) extra_options;
  71. DARRAY(struct frame_rate_range) ranges;
  72. };
  73. struct group_data {
  74. enum obs_group_type type;
  75. obs_properties_t *content;
  76. };
  77. static inline void path_data_free(struct path_data *data)
  78. {
  79. bfree(data->default_path);
  80. if (data->type == OBS_PATH_FILE)
  81. bfree(data->filter);
  82. }
  83. static inline void editable_list_data_free(struct editable_list_data *data)
  84. {
  85. bfree(data->default_path);
  86. bfree(data->filter);
  87. }
  88. static inline void list_item_free(struct list_data *data,
  89. struct list_item *item)
  90. {
  91. bfree(item->name);
  92. if (data->format == OBS_COMBO_FORMAT_STRING)
  93. bfree(item->str);
  94. }
  95. static inline void list_data_free(struct list_data *data)
  96. {
  97. for (size_t i = 0; i < data->items.num; i++)
  98. list_item_free(data, data->items.array + i);
  99. da_free(data->items);
  100. }
  101. static inline void frame_rate_data_options_free(struct frame_rate_data *data)
  102. {
  103. for (size_t i = 0; i < data->extra_options.num; i++) {
  104. struct frame_rate_option *opt = &data->extra_options.array[i];
  105. bfree(opt->name);
  106. bfree(opt->description);
  107. }
  108. da_resize(data->extra_options, 0);
  109. }
  110. static inline void frame_rate_data_ranges_free(struct frame_rate_data *data)
  111. {
  112. da_resize(data->ranges, 0);
  113. }
  114. static inline void frame_rate_data_free(struct frame_rate_data *data)
  115. {
  116. frame_rate_data_options_free(data);
  117. frame_rate_data_ranges_free(data);
  118. da_free(data->extra_options);
  119. da_free(data->ranges);
  120. }
  121. static inline void group_data_free(struct group_data *data)
  122. {
  123. obs_properties_destroy(data->content);
  124. }
  125. static inline void int_data_free(struct int_data *data)
  126. {
  127. if (data->suffix)
  128. bfree(data->suffix);
  129. }
  130. static inline void float_data_free(struct float_data *data)
  131. {
  132. if (data->suffix)
  133. bfree(data->suffix);
  134. }
  135. struct obs_properties;
  136. struct obs_property {
  137. char *name;
  138. char *desc;
  139. char *long_desc;
  140. void *priv;
  141. enum obs_property_type type;
  142. bool visible;
  143. bool enabled;
  144. struct obs_properties *parent;
  145. obs_property_modified_t modified;
  146. obs_property_modified2_t modified2;
  147. struct obs_property *next;
  148. };
  149. struct obs_properties {
  150. void *param;
  151. void (*destroy)(void *param);
  152. uint32_t flags;
  153. struct obs_property *first_property;
  154. struct obs_property **last;
  155. struct obs_property *parent;
  156. };
  157. obs_properties_t *obs_properties_create(void)
  158. {
  159. struct obs_properties *props;
  160. props = bzalloc(sizeof(struct obs_properties));
  161. props->last = &props->first_property;
  162. return props;
  163. }
  164. void obs_properties_set_param(obs_properties_t *props, void *param,
  165. void (*destroy)(void *param))
  166. {
  167. if (!props)
  168. return;
  169. if (props->param && props->destroy)
  170. props->destroy(props->param);
  171. props->param = param;
  172. props->destroy = destroy;
  173. }
  174. void obs_properties_set_flags(obs_properties_t *props, uint32_t flags)
  175. {
  176. if (props)
  177. props->flags = flags;
  178. }
  179. uint32_t obs_properties_get_flags(obs_properties_t *props)
  180. {
  181. return props ? props->flags : 0;
  182. }
  183. void *obs_properties_get_param(obs_properties_t *props)
  184. {
  185. return props ? props->param : NULL;
  186. }
  187. obs_properties_t *obs_properties_create_param(void *param,
  188. void (*destroy)(void *param))
  189. {
  190. struct obs_properties *props = obs_properties_create();
  191. obs_properties_set_param(props, param, destroy);
  192. return props;
  193. }
  194. static void obs_property_destroy(struct obs_property *property)
  195. {
  196. if (property->type == OBS_PROPERTY_LIST)
  197. list_data_free(get_property_data(property));
  198. else if (property->type == OBS_PROPERTY_PATH)
  199. path_data_free(get_property_data(property));
  200. else if (property->type == OBS_PROPERTY_EDITABLE_LIST)
  201. editable_list_data_free(get_property_data(property));
  202. else if (property->type == OBS_PROPERTY_FRAME_RATE)
  203. frame_rate_data_free(get_property_data(property));
  204. else if (property->type == OBS_PROPERTY_GROUP)
  205. group_data_free(get_property_data(property));
  206. else if (property->type == OBS_PROPERTY_INT)
  207. int_data_free(get_property_data(property));
  208. else if (property->type == OBS_PROPERTY_FLOAT)
  209. float_data_free(get_property_data(property));
  210. bfree(property->name);
  211. bfree(property->desc);
  212. bfree(property->long_desc);
  213. bfree(property);
  214. }
  215. void obs_properties_destroy(obs_properties_t *props)
  216. {
  217. if (props) {
  218. struct obs_property *p = props->first_property;
  219. if (props->destroy && props->param)
  220. props->destroy(props->param);
  221. while (p) {
  222. struct obs_property *next = p->next;
  223. obs_property_destroy(p);
  224. p = next;
  225. }
  226. bfree(props);
  227. }
  228. }
  229. obs_property_t *obs_properties_first(obs_properties_t *props)
  230. {
  231. return (props != NULL) ? props->first_property : NULL;
  232. }
  233. obs_property_t *obs_properties_get(obs_properties_t *props, const char *name)
  234. {
  235. struct obs_property *property;
  236. if (!props)
  237. return NULL;
  238. property = props->first_property;
  239. while (property) {
  240. if (strcmp(property->name, name) == 0)
  241. return property;
  242. if (property->type == OBS_PROPERTY_GROUP) {
  243. obs_properties_t *group =
  244. obs_property_group_content(property);
  245. obs_property_t *found = obs_properties_get(group, name);
  246. if (found != NULL) {
  247. return found;
  248. }
  249. }
  250. property = property->next;
  251. }
  252. return NULL;
  253. }
  254. obs_properties_t *obs_properties_get_parent(obs_properties_t *props)
  255. {
  256. return props->parent ? props->parent->parent : NULL;
  257. }
  258. void obs_properties_remove_by_name(obs_properties_t *props, const char *name)
  259. {
  260. if (!props)
  261. return;
  262. /* obs_properties_t is a forward-linked-list, so we need to keep both
  263. * previous and current pointers around. That way we can fix up the
  264. * pointers for the previous element if we find a match.
  265. */
  266. struct obs_property *cur = props->first_property;
  267. struct obs_property *prev = props->first_property;
  268. while (cur) {
  269. if (strcmp(cur->name, name) == 0) {
  270. prev->next = cur->next;
  271. cur->next = 0;
  272. obs_property_destroy(cur);
  273. break;
  274. }
  275. if (cur->type == OBS_PROPERTY_GROUP) {
  276. obs_properties_remove_by_name(
  277. obs_property_group_content(cur), name);
  278. }
  279. prev = cur;
  280. cur = cur->next;
  281. }
  282. }
  283. void obs_properties_apply_settings_internal(obs_properties_t *props,
  284. obs_data_t *settings,
  285. obs_properties_t *realprops)
  286. {
  287. struct obs_property *p;
  288. p = props->first_property;
  289. while (p) {
  290. if (p->type == OBS_PROPERTY_GROUP) {
  291. obs_properties_apply_settings_internal(
  292. obs_property_group_content(p), settings,
  293. realprops);
  294. }
  295. if (p->modified)
  296. p->modified(realprops, p, settings);
  297. else if (p->modified2)
  298. p->modified2(p->priv, realprops, p, settings);
  299. p = p->next;
  300. }
  301. }
  302. void obs_properties_apply_settings(obs_properties_t *props,
  303. obs_data_t *settings)
  304. {
  305. if (!props)
  306. return;
  307. obs_properties_apply_settings_internal(props, settings, props);
  308. }
  309. /* ------------------------------------------------------------------------- */
  310. static inline void propertes_add(struct obs_properties *props,
  311. struct obs_property *p)
  312. {
  313. *props->last = p;
  314. props->last = &p->next;
  315. }
  316. static inline size_t get_property_size(enum obs_property_type type)
  317. {
  318. switch (type) {
  319. case OBS_PROPERTY_INVALID:
  320. return 0;
  321. case OBS_PROPERTY_BOOL:
  322. return 0;
  323. case OBS_PROPERTY_INT:
  324. return sizeof(struct int_data);
  325. case OBS_PROPERTY_FLOAT:
  326. return sizeof(struct float_data);
  327. case OBS_PROPERTY_TEXT:
  328. return sizeof(struct text_data);
  329. case OBS_PROPERTY_PATH:
  330. return sizeof(struct path_data);
  331. case OBS_PROPERTY_LIST:
  332. return sizeof(struct list_data);
  333. case OBS_PROPERTY_COLOR:
  334. return 0;
  335. case OBS_PROPERTY_BUTTON:
  336. return sizeof(struct button_data);
  337. case OBS_PROPERTY_FONT:
  338. return 0;
  339. case OBS_PROPERTY_EDITABLE_LIST:
  340. return sizeof(struct editable_list_data);
  341. case OBS_PROPERTY_FRAME_RATE:
  342. return sizeof(struct frame_rate_data);
  343. case OBS_PROPERTY_GROUP:
  344. return sizeof(struct group_data);
  345. }
  346. return 0;
  347. }
  348. static inline struct obs_property *new_prop(struct obs_properties *props,
  349. const char *name, const char *desc,
  350. enum obs_property_type type)
  351. {
  352. size_t data_size = get_property_size(type);
  353. struct obs_property *p;
  354. p = bzalloc(sizeof(struct obs_property) + data_size);
  355. p->parent = props;
  356. p->enabled = true;
  357. p->visible = true;
  358. p->type = type;
  359. p->name = bstrdup(name);
  360. p->desc = bstrdup(desc);
  361. propertes_add(props, p);
  362. return p;
  363. }
  364. static inline obs_properties_t *get_topmost_parent(obs_properties_t *props)
  365. {
  366. obs_properties_t *parent = props;
  367. obs_properties_t *last_parent = parent;
  368. while (parent) {
  369. last_parent = parent;
  370. parent = obs_properties_get_parent(parent);
  371. }
  372. return last_parent;
  373. }
  374. static inline bool contains_prop(struct obs_properties *props, const char *name)
  375. {
  376. struct obs_property *p = props->first_property;
  377. while (p) {
  378. if (strcmp(p->name, name) == 0) {
  379. blog(LOG_WARNING, "Property '%s' exists", name);
  380. return true;
  381. }
  382. if (p->type == OBS_PROPERTY_GROUP) {
  383. if (contains_prop(obs_property_group_content(p),
  384. name)) {
  385. return true;
  386. }
  387. }
  388. p = p->next;
  389. }
  390. return false;
  391. }
  392. static inline bool has_prop(struct obs_properties *props, const char *name)
  393. {
  394. return contains_prop(get_topmost_parent(props), name);
  395. }
  396. static inline void *get_property_data(struct obs_property *prop)
  397. {
  398. return (uint8_t *)prop + sizeof(struct obs_property);
  399. }
  400. static inline void *get_type_data(struct obs_property *prop,
  401. enum obs_property_type type)
  402. {
  403. if (!prop || prop->type != type)
  404. return NULL;
  405. return get_property_data(prop);
  406. }
  407. obs_property_t *obs_properties_add_bool(obs_properties_t *props,
  408. const char *name, const char *desc)
  409. {
  410. if (!props || has_prop(props, name))
  411. return NULL;
  412. return new_prop(props, name, desc, OBS_PROPERTY_BOOL);
  413. }
  414. static obs_property_t *add_int(obs_properties_t *props, const char *name,
  415. const char *desc, int min, int max, int step,
  416. enum obs_number_type type)
  417. {
  418. if (!props || has_prop(props, name))
  419. return NULL;
  420. struct obs_property *p = new_prop(props, name, desc, OBS_PROPERTY_INT);
  421. struct int_data *data = get_property_data(p);
  422. data->min = min;
  423. data->max = max;
  424. data->step = step;
  425. data->type = type;
  426. return p;
  427. }
  428. static obs_property_t *add_flt(obs_properties_t *props, const char *name,
  429. const char *desc, double min, double max,
  430. double step, enum obs_number_type type)
  431. {
  432. if (!props || has_prop(props, name))
  433. return NULL;
  434. struct obs_property *p =
  435. new_prop(props, name, desc, OBS_PROPERTY_FLOAT);
  436. struct float_data *data = get_property_data(p);
  437. data->min = min;
  438. data->max = max;
  439. data->step = step;
  440. data->type = type;
  441. return p;
  442. }
  443. obs_property_t *obs_properties_add_int(obs_properties_t *props,
  444. const char *name, const char *desc,
  445. int min, int max, int step)
  446. {
  447. return add_int(props, name, desc, min, max, step, OBS_NUMBER_SCROLLER);
  448. }
  449. obs_property_t *obs_properties_add_float(obs_properties_t *props,
  450. const char *name, const char *desc,
  451. double min, double max, double step)
  452. {
  453. return add_flt(props, name, desc, min, max, step, OBS_NUMBER_SCROLLER);
  454. }
  455. obs_property_t *obs_properties_add_int_slider(obs_properties_t *props,
  456. const char *name,
  457. const char *desc, int min,
  458. int max, int step)
  459. {
  460. return add_int(props, name, desc, min, max, step, OBS_NUMBER_SLIDER);
  461. }
  462. obs_property_t *obs_properties_add_float_slider(obs_properties_t *props,
  463. const char *name,
  464. const char *desc, double min,
  465. double max, double step)
  466. {
  467. return add_flt(props, name, desc, min, max, step, OBS_NUMBER_SLIDER);
  468. }
  469. obs_property_t *obs_properties_add_text(obs_properties_t *props,
  470. const char *name, const char *desc,
  471. enum obs_text_type type)
  472. {
  473. if (!props || has_prop(props, name))
  474. return NULL;
  475. struct obs_property *p = new_prop(props, name, desc, OBS_PROPERTY_TEXT);
  476. struct text_data *data = get_property_data(p);
  477. data->type = type;
  478. return p;
  479. }
  480. obs_property_t *obs_properties_add_path(obs_properties_t *props,
  481. const char *name, const char *desc,
  482. enum obs_path_type type,
  483. const char *filter,
  484. const char *default_path)
  485. {
  486. if (!props || has_prop(props, name))
  487. return NULL;
  488. struct obs_property *p = new_prop(props, name, desc, OBS_PROPERTY_PATH);
  489. struct path_data *data = get_property_data(p);
  490. data->type = type;
  491. data->default_path = bstrdup(default_path);
  492. if (data->type == OBS_PATH_FILE)
  493. data->filter = bstrdup(filter);
  494. return p;
  495. }
  496. obs_property_t *obs_properties_add_list(obs_properties_t *props,
  497. const char *name, const char *desc,
  498. enum obs_combo_type type,
  499. enum obs_combo_format format)
  500. {
  501. if (!props || has_prop(props, name))
  502. return NULL;
  503. if (type == OBS_COMBO_TYPE_EDITABLE &&
  504. format != OBS_COMBO_FORMAT_STRING) {
  505. blog(LOG_WARNING,
  506. "List '%s', error: Editable combo boxes "
  507. "must be of the 'string' type",
  508. name);
  509. return NULL;
  510. }
  511. struct obs_property *p = new_prop(props, name, desc, OBS_PROPERTY_LIST);
  512. struct list_data *data = get_property_data(p);
  513. data->format = format;
  514. data->type = type;
  515. return p;
  516. }
  517. obs_property_t *obs_properties_add_color(obs_properties_t *props,
  518. const char *name, const char *desc)
  519. {
  520. if (!props || has_prop(props, name))
  521. return NULL;
  522. return new_prop(props, name, desc, OBS_PROPERTY_COLOR);
  523. }
  524. obs_property_t *obs_properties_add_button(obs_properties_t *props,
  525. const char *name, const char *text,
  526. obs_property_clicked_t callback)
  527. {
  528. if (!props || has_prop(props, name))
  529. return NULL;
  530. struct obs_property *p =
  531. new_prop(props, name, text, OBS_PROPERTY_BUTTON);
  532. struct button_data *data = get_property_data(p);
  533. data->callback = callback;
  534. return p;
  535. }
  536. obs_property_t *obs_properties_add_button2(obs_properties_t *props,
  537. const char *name, const char *text,
  538. obs_property_clicked_t callback,
  539. void *priv)
  540. {
  541. if (!props || has_prop(props, name))
  542. return NULL;
  543. struct obs_property *p =
  544. new_prop(props, name, text, OBS_PROPERTY_BUTTON);
  545. struct button_data *data = get_property_data(p);
  546. data->callback = callback;
  547. p->priv = priv;
  548. return p;
  549. }
  550. obs_property_t *obs_properties_add_font(obs_properties_t *props,
  551. const char *name, const char *desc)
  552. {
  553. if (!props || has_prop(props, name))
  554. return NULL;
  555. return new_prop(props, name, desc, OBS_PROPERTY_FONT);
  556. }
  557. obs_property_t *
  558. obs_properties_add_editable_list(obs_properties_t *props, const char *name,
  559. const char *desc,
  560. enum obs_editable_list_type type,
  561. const char *filter, const char *default_path)
  562. {
  563. if (!props || has_prop(props, name))
  564. return NULL;
  565. struct obs_property *p =
  566. new_prop(props, name, desc, OBS_PROPERTY_EDITABLE_LIST);
  567. struct editable_list_data *data = get_property_data(p);
  568. data->type = type;
  569. data->filter = bstrdup(filter);
  570. data->default_path = bstrdup(default_path);
  571. return p;
  572. }
  573. obs_property_t *obs_properties_add_frame_rate(obs_properties_t *props,
  574. const char *name,
  575. const char *desc)
  576. {
  577. if (!props || has_prop(props, name))
  578. return NULL;
  579. struct obs_property *p =
  580. new_prop(props, name, desc, OBS_PROPERTY_FRAME_RATE);
  581. struct frame_rate_data *data = get_property_data(p);
  582. da_init(data->extra_options);
  583. da_init(data->ranges);
  584. return p;
  585. }
  586. static bool check_property_group_recursion(obs_properties_t *parent,
  587. obs_properties_t *group)
  588. {
  589. /* Scan the group for the parent. */
  590. obs_property_t *current_property = group->first_property;
  591. while (current_property) {
  592. if (current_property->type == OBS_PROPERTY_GROUP) {
  593. obs_properties_t *cprops =
  594. obs_property_group_content(current_property);
  595. if (cprops == parent) {
  596. /* Contains find_props */
  597. return true;
  598. } else if (cprops == group) {
  599. /* Contains self, shouldn't be possible but
  600. * lets verify anyway. */
  601. return true;
  602. }
  603. check_property_group_recursion(cprops, group);
  604. }
  605. current_property = current_property->next;
  606. }
  607. return false;
  608. }
  609. static bool check_property_group_duplicates(obs_properties_t *parent,
  610. obs_properties_t *group)
  611. {
  612. obs_property_t *current_property = group->first_property;
  613. while (current_property) {
  614. if (has_prop(parent, current_property->name)) {
  615. return true;
  616. }
  617. current_property = current_property->next;
  618. }
  619. return false;
  620. }
  621. obs_property_t *obs_properties_add_group(obs_properties_t *props,
  622. const char *name, const char *desc,
  623. enum obs_group_type type,
  624. obs_properties_t *group)
  625. {
  626. if (!props || has_prop(props, name))
  627. return NULL;
  628. if (!group)
  629. return NULL;
  630. /* Prevent recursion. */
  631. if (props == group)
  632. return NULL;
  633. if (check_property_group_recursion(props, group))
  634. return NULL;
  635. /* Prevent duplicate properties */
  636. if (check_property_group_duplicates(props, group))
  637. return NULL;
  638. obs_property_t *p = new_prop(props, name, desc, OBS_PROPERTY_GROUP);
  639. group->parent = p;
  640. struct group_data *data = get_property_data(p);
  641. data->type = type;
  642. data->content = group;
  643. return p;
  644. }
  645. /* ------------------------------------------------------------------------- */
  646. static inline bool is_combo(struct obs_property *p)
  647. {
  648. return p->type == OBS_PROPERTY_LIST;
  649. }
  650. static inline struct list_data *get_list_data(struct obs_property *p)
  651. {
  652. if (!p || !is_combo(p))
  653. return NULL;
  654. return get_property_data(p);
  655. }
  656. static inline struct list_data *get_list_fmt_data(struct obs_property *p,
  657. enum obs_combo_format format)
  658. {
  659. struct list_data *data = get_list_data(p);
  660. return (data && data->format == format) ? data : NULL;
  661. }
  662. /* ------------------------------------------------------------------------- */
  663. bool obs_property_next(obs_property_t **p)
  664. {
  665. if (!p || !*p)
  666. return false;
  667. *p = (*p)->next;
  668. return *p != NULL;
  669. }
  670. void obs_property_set_modified_callback(obs_property_t *p,
  671. obs_property_modified_t modified)
  672. {
  673. if (p)
  674. p->modified = modified;
  675. }
  676. void obs_property_set_modified_callback2(obs_property_t *p,
  677. obs_property_modified2_t modified2,
  678. void *priv)
  679. {
  680. if (p) {
  681. p->modified2 = modified2;
  682. p->priv = priv;
  683. }
  684. }
  685. bool obs_property_modified(obs_property_t *p, obs_data_t *settings)
  686. {
  687. if (p) {
  688. if (p->modified) {
  689. obs_properties_t *top = get_topmost_parent(p->parent);
  690. return p->modified(top, p, settings);
  691. } else if (p->modified2) {
  692. obs_properties_t *top = get_topmost_parent(p->parent);
  693. return p->modified2(p->priv, top, p, settings);
  694. }
  695. }
  696. return false;
  697. }
  698. bool obs_property_button_clicked(obs_property_t *p, void *obj)
  699. {
  700. struct obs_context_data *context = obj;
  701. if (p) {
  702. struct button_data *data =
  703. get_type_data(p, OBS_PROPERTY_BUTTON);
  704. if (data && data->callback) {
  705. obs_properties_t *top = get_topmost_parent(p->parent);
  706. if (p->priv)
  707. return data->callback(top, p, p->priv);
  708. return data->callback(top, p,
  709. (context ? context->data : NULL));
  710. }
  711. }
  712. return false;
  713. }
  714. void obs_property_set_visible(obs_property_t *p, bool visible)
  715. {
  716. if (p)
  717. p->visible = visible;
  718. }
  719. void obs_property_set_enabled(obs_property_t *p, bool enabled)
  720. {
  721. if (p)
  722. p->enabled = enabled;
  723. }
  724. void obs_property_set_description(obs_property_t *p, const char *description)
  725. {
  726. if (p) {
  727. bfree(p->desc);
  728. p->desc = description && *description ? bstrdup(description)
  729. : NULL;
  730. }
  731. }
  732. void obs_property_set_long_description(obs_property_t *p, const char *long_desc)
  733. {
  734. if (p) {
  735. bfree(p->long_desc);
  736. p->long_desc = long_desc && *long_desc ? bstrdup(long_desc)
  737. : NULL;
  738. }
  739. }
  740. const char *obs_property_name(obs_property_t *p)
  741. {
  742. return p ? p->name : NULL;
  743. }
  744. const char *obs_property_description(obs_property_t *p)
  745. {
  746. return p ? p->desc : NULL;
  747. }
  748. const char *obs_property_long_description(obs_property_t *p)
  749. {
  750. return p ? p->long_desc : NULL;
  751. }
  752. enum obs_property_type obs_property_get_type(obs_property_t *p)
  753. {
  754. return p ? p->type : OBS_PROPERTY_INVALID;
  755. }
  756. bool obs_property_enabled(obs_property_t *p)
  757. {
  758. return p ? p->enabled : false;
  759. }
  760. bool obs_property_visible(obs_property_t *p)
  761. {
  762. return p ? p->visible : false;
  763. }
  764. int obs_property_int_min(obs_property_t *p)
  765. {
  766. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  767. return data ? data->min : 0;
  768. }
  769. int obs_property_int_max(obs_property_t *p)
  770. {
  771. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  772. return data ? data->max : 0;
  773. }
  774. int obs_property_int_step(obs_property_t *p)
  775. {
  776. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  777. return data ? data->step : 0;
  778. }
  779. enum obs_number_type obs_property_int_type(obs_property_t *p)
  780. {
  781. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  782. return data ? data->type : OBS_NUMBER_SCROLLER;
  783. }
  784. const char *obs_property_int_suffix(obs_property_t *p)
  785. {
  786. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  787. return data ? data->suffix : NULL;
  788. }
  789. double obs_property_float_min(obs_property_t *p)
  790. {
  791. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  792. return data ? data->min : 0;
  793. }
  794. double obs_property_float_max(obs_property_t *p)
  795. {
  796. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  797. return data ? data->max : 0;
  798. }
  799. double obs_property_float_step(obs_property_t *p)
  800. {
  801. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  802. return data ? data->step : 0;
  803. }
  804. const char *obs_property_float_suffix(obs_property_t *p)
  805. {
  806. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  807. return data ? data->suffix : NULL;
  808. }
  809. enum obs_number_type obs_property_float_type(obs_property_t *p)
  810. {
  811. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  812. return data ? data->type : OBS_NUMBER_SCROLLER;
  813. }
  814. enum obs_text_type obs_property_text_type(obs_property_t *p)
  815. {
  816. struct text_data *data = get_type_data(p, OBS_PROPERTY_TEXT);
  817. return data ? data->type : OBS_TEXT_DEFAULT;
  818. }
  819. enum obs_text_type obs_property_text_monospace(obs_property_t *p)
  820. {
  821. struct text_data *data = get_type_data(p, OBS_PROPERTY_TEXT);
  822. return data ? data->monospace : false;
  823. }
  824. enum obs_path_type obs_property_path_type(obs_property_t *p)
  825. {
  826. struct path_data *data = get_type_data(p, OBS_PROPERTY_PATH);
  827. return data ? data->type : OBS_PATH_DIRECTORY;
  828. }
  829. const char *obs_property_path_filter(obs_property_t *p)
  830. {
  831. struct path_data *data = get_type_data(p, OBS_PROPERTY_PATH);
  832. return data ? data->filter : NULL;
  833. }
  834. const char *obs_property_path_default_path(obs_property_t *p)
  835. {
  836. struct path_data *data = get_type_data(p, OBS_PROPERTY_PATH);
  837. return data ? data->default_path : NULL;
  838. }
  839. enum obs_combo_type obs_property_list_type(obs_property_t *p)
  840. {
  841. struct list_data *data = get_list_data(p);
  842. return data ? data->type : OBS_COMBO_TYPE_INVALID;
  843. }
  844. enum obs_combo_format obs_property_list_format(obs_property_t *p)
  845. {
  846. struct list_data *data = get_list_data(p);
  847. return data ? data->format : OBS_COMBO_FORMAT_INVALID;
  848. }
  849. void obs_property_int_set_limits(obs_property_t *p, int min, int max, int step)
  850. {
  851. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  852. if (!data)
  853. return;
  854. data->min = min;
  855. data->max = max;
  856. data->step = step;
  857. }
  858. void obs_property_float_set_limits(obs_property_t *p, double min, double max,
  859. double step)
  860. {
  861. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  862. if (!data)
  863. return;
  864. data->min = min;
  865. data->max = max;
  866. data->step = step;
  867. }
  868. void obs_property_int_set_suffix(obs_property_t *p, const char *suffix)
  869. {
  870. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  871. if (!data)
  872. return;
  873. bfree(data->suffix);
  874. data->suffix = bstrdup(suffix);
  875. }
  876. void obs_property_float_set_suffix(obs_property_t *p, const char *suffix)
  877. {
  878. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  879. if (!data)
  880. return;
  881. bfree(data->suffix);
  882. data->suffix = bstrdup(suffix);
  883. }
  884. void obs_property_text_set_monospace(obs_property_t *p, bool monospace)
  885. {
  886. struct text_data *data = get_type_data(p, OBS_PROPERTY_TEXT);
  887. if (!data)
  888. return;
  889. data->monospace = monospace;
  890. }
  891. void obs_property_list_clear(obs_property_t *p)
  892. {
  893. struct list_data *data = get_list_data(p);
  894. if (data)
  895. list_data_free(data);
  896. }
  897. static size_t add_item(struct list_data *data, const char *name,
  898. const void *val)
  899. {
  900. struct list_item item = {NULL};
  901. item.name = bstrdup(name);
  902. if (data->format == OBS_COMBO_FORMAT_INT)
  903. item.ll = *(const long long *)val;
  904. else if (data->format == OBS_COMBO_FORMAT_FLOAT)
  905. item.d = *(const double *)val;
  906. else
  907. item.str = bstrdup(val);
  908. return da_push_back(data->items, &item);
  909. }
  910. static void insert_item(struct list_data *data, size_t idx, const char *name,
  911. const void *val)
  912. {
  913. struct list_item item = {NULL};
  914. item.name = bstrdup(name);
  915. if (data->format == OBS_COMBO_FORMAT_INT)
  916. item.ll = *(const long long *)val;
  917. else if (data->format == OBS_COMBO_FORMAT_FLOAT)
  918. item.d = *(const double *)val;
  919. else
  920. item.str = bstrdup(val);
  921. da_insert(data->items, idx, &item);
  922. }
  923. size_t obs_property_list_add_string(obs_property_t *p, const char *name,
  924. const char *val)
  925. {
  926. struct list_data *data = get_list_data(p);
  927. if (data && data->format == OBS_COMBO_FORMAT_STRING)
  928. return add_item(data, name, val);
  929. return 0;
  930. }
  931. size_t obs_property_list_add_int(obs_property_t *p, const char *name,
  932. long long val)
  933. {
  934. struct list_data *data = get_list_data(p);
  935. if (data && data->format == OBS_COMBO_FORMAT_INT)
  936. return add_item(data, name, &val);
  937. return 0;
  938. }
  939. size_t obs_property_list_add_float(obs_property_t *p, const char *name,
  940. double val)
  941. {
  942. struct list_data *data = get_list_data(p);
  943. if (data && data->format == OBS_COMBO_FORMAT_FLOAT)
  944. return add_item(data, name, &val);
  945. return 0;
  946. }
  947. void obs_property_list_insert_string(obs_property_t *p, size_t idx,
  948. const char *name, const char *val)
  949. {
  950. struct list_data *data = get_list_data(p);
  951. if (data && data->format == OBS_COMBO_FORMAT_STRING)
  952. insert_item(data, idx, name, val);
  953. }
  954. void obs_property_list_insert_int(obs_property_t *p, size_t idx,
  955. const char *name, long long val)
  956. {
  957. struct list_data *data = get_list_data(p);
  958. if (data && data->format == OBS_COMBO_FORMAT_INT)
  959. insert_item(data, idx, name, &val);
  960. }
  961. void obs_property_list_insert_float(obs_property_t *p, size_t idx,
  962. const char *name, double val)
  963. {
  964. struct list_data *data = get_list_data(p);
  965. if (data && data->format == OBS_COMBO_FORMAT_FLOAT)
  966. insert_item(data, idx, name, &val);
  967. }
  968. void obs_property_list_item_remove(obs_property_t *p, size_t idx)
  969. {
  970. struct list_data *data = get_list_data(p);
  971. if (data && idx < data->items.num) {
  972. list_item_free(data, data->items.array + idx);
  973. da_erase(data->items, idx);
  974. }
  975. }
  976. size_t obs_property_list_item_count(obs_property_t *p)
  977. {
  978. struct list_data *data = get_list_data(p);
  979. return data ? data->items.num : 0;
  980. }
  981. bool obs_property_list_item_disabled(obs_property_t *p, size_t idx)
  982. {
  983. struct list_data *data = get_list_data(p);
  984. return (data && idx < data->items.num) ? data->items.array[idx].disabled
  985. : false;
  986. }
  987. void obs_property_list_item_disable(obs_property_t *p, size_t idx,
  988. bool disabled)
  989. {
  990. struct list_data *data = get_list_data(p);
  991. if (!data || idx >= data->items.num)
  992. return;
  993. data->items.array[idx].disabled = disabled;
  994. }
  995. const char *obs_property_list_item_name(obs_property_t *p, size_t idx)
  996. {
  997. struct list_data *data = get_list_data(p);
  998. return (data && idx < data->items.num) ? data->items.array[idx].name
  999. : NULL;
  1000. }
  1001. const char *obs_property_list_item_string(obs_property_t *p, size_t idx)
  1002. {
  1003. struct list_data *data = get_list_fmt_data(p, OBS_COMBO_FORMAT_STRING);
  1004. return (data && idx < data->items.num) ? data->items.array[idx].str
  1005. : NULL;
  1006. }
  1007. long long obs_property_list_item_int(obs_property_t *p, size_t idx)
  1008. {
  1009. struct list_data *data = get_list_fmt_data(p, OBS_COMBO_FORMAT_INT);
  1010. return (data && idx < data->items.num) ? data->items.array[idx].ll : 0;
  1011. }
  1012. double obs_property_list_item_float(obs_property_t *p, size_t idx)
  1013. {
  1014. struct list_data *data = get_list_fmt_data(p, OBS_COMBO_FORMAT_FLOAT);
  1015. return (data && idx < data->items.num) ? data->items.array[idx].d : 0.0;
  1016. }
  1017. enum obs_editable_list_type obs_property_editable_list_type(obs_property_t *p)
  1018. {
  1019. struct editable_list_data *data =
  1020. get_type_data(p, OBS_PROPERTY_EDITABLE_LIST);
  1021. return data ? data->type : OBS_EDITABLE_LIST_TYPE_STRINGS;
  1022. }
  1023. const char *obs_property_editable_list_filter(obs_property_t *p)
  1024. {
  1025. struct editable_list_data *data =
  1026. get_type_data(p, OBS_PROPERTY_EDITABLE_LIST);
  1027. return data ? data->filter : NULL;
  1028. }
  1029. const char *obs_property_editable_list_default_path(obs_property_t *p)
  1030. {
  1031. struct editable_list_data *data =
  1032. get_type_data(p, OBS_PROPERTY_EDITABLE_LIST);
  1033. return data ? data->default_path : NULL;
  1034. }
  1035. /* ------------------------------------------------------------------------- */
  1036. /* OBS_PROPERTY_FRAME_RATE */
  1037. void obs_property_frame_rate_clear(obs_property_t *p)
  1038. {
  1039. struct frame_rate_data *data =
  1040. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1041. if (!data)
  1042. return;
  1043. frame_rate_data_options_free(data);
  1044. frame_rate_data_ranges_free(data);
  1045. }
  1046. void obs_property_frame_rate_options_clear(obs_property_t *p)
  1047. {
  1048. struct frame_rate_data *data =
  1049. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1050. if (!data)
  1051. return;
  1052. frame_rate_data_options_free(data);
  1053. }
  1054. void obs_property_frame_rate_fps_ranges_clear(obs_property_t *p)
  1055. {
  1056. struct frame_rate_data *data =
  1057. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1058. if (!data)
  1059. return;
  1060. frame_rate_data_ranges_free(data);
  1061. }
  1062. size_t obs_property_frame_rate_option_add(obs_property_t *p, const char *name,
  1063. const char *description)
  1064. {
  1065. struct frame_rate_data *data =
  1066. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1067. if (!data)
  1068. return DARRAY_INVALID;
  1069. struct frame_rate_option *opt = da_push_back_new(data->extra_options);
  1070. opt->name = bstrdup(name);
  1071. opt->description = bstrdup(description);
  1072. return data->extra_options.num - 1;
  1073. }
  1074. size_t obs_property_frame_rate_fps_range_add(obs_property_t *p,
  1075. struct media_frames_per_second min,
  1076. struct media_frames_per_second max)
  1077. {
  1078. struct frame_rate_data *data =
  1079. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1080. if (!data)
  1081. return DARRAY_INVALID;
  1082. struct frame_rate_range *rng = da_push_back_new(data->ranges);
  1083. rng->min_time = min;
  1084. rng->max_time = max;
  1085. return data->ranges.num - 1;
  1086. }
  1087. void obs_property_frame_rate_option_insert(obs_property_t *p, size_t idx,
  1088. const char *name,
  1089. const char *description)
  1090. {
  1091. struct frame_rate_data *data =
  1092. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1093. if (!data)
  1094. return;
  1095. struct frame_rate_option *opt = da_insert_new(data->extra_options, idx);
  1096. opt->name = bstrdup(name);
  1097. opt->description = bstrdup(description);
  1098. }
  1099. void obs_property_frame_rate_fps_range_insert(
  1100. obs_property_t *p, size_t idx, struct media_frames_per_second min,
  1101. struct media_frames_per_second max)
  1102. {
  1103. struct frame_rate_data *data =
  1104. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1105. if (!data)
  1106. return;
  1107. struct frame_rate_range *rng = da_insert_new(data->ranges, idx);
  1108. rng->min_time = min;
  1109. rng->max_time = max;
  1110. }
  1111. size_t obs_property_frame_rate_options_count(obs_property_t *p)
  1112. {
  1113. struct frame_rate_data *data =
  1114. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1115. return data ? data->extra_options.num : 0;
  1116. }
  1117. const char *obs_property_frame_rate_option_name(obs_property_t *p, size_t idx)
  1118. {
  1119. struct frame_rate_data *data =
  1120. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1121. return data && data->extra_options.num > idx
  1122. ? data->extra_options.array[idx].name
  1123. : NULL;
  1124. }
  1125. const char *obs_property_frame_rate_option_description(obs_property_t *p,
  1126. size_t idx)
  1127. {
  1128. struct frame_rate_data *data =
  1129. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1130. return data && data->extra_options.num > idx
  1131. ? data->extra_options.array[idx].description
  1132. : NULL;
  1133. }
  1134. size_t obs_property_frame_rate_fps_ranges_count(obs_property_t *p)
  1135. {
  1136. struct frame_rate_data *data =
  1137. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1138. return data ? data->ranges.num : 0;
  1139. }
  1140. struct media_frames_per_second
  1141. obs_property_frame_rate_fps_range_min(obs_property_t *p, size_t idx)
  1142. {
  1143. struct frame_rate_data *data =
  1144. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1145. return data && data->ranges.num > idx
  1146. ? data->ranges.array[idx].min_time
  1147. : (struct media_frames_per_second){0};
  1148. }
  1149. struct media_frames_per_second
  1150. obs_property_frame_rate_fps_range_max(obs_property_t *p, size_t idx)
  1151. {
  1152. struct frame_rate_data *data =
  1153. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1154. return data && data->ranges.num > idx
  1155. ? data->ranges.array[idx].max_time
  1156. : (struct media_frames_per_second){0};
  1157. }
  1158. enum obs_text_type obs_proprety_text_type(obs_property_t *p)
  1159. {
  1160. return obs_property_text_type(p);
  1161. }
  1162. enum obs_group_type obs_property_group_type(obs_property_t *p)
  1163. {
  1164. struct group_data *data = get_type_data(p, OBS_PROPERTY_GROUP);
  1165. return data ? data->type : OBS_COMBO_INVALID;
  1166. }
  1167. obs_properties_t *obs_property_group_content(obs_property_t *p)
  1168. {
  1169. struct group_data *data = get_type_data(p, OBS_PROPERTY_GROUP);
  1170. return data ? data->content : NULL;
  1171. }