obs-properties.c 33 KB

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