obs-properties.c 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436
  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. // Fix props->last pointer.
  271. if (props->last == &cur->next) {
  272. if (cur == prev) {
  273. // If we are the last entry and there
  274. // is no previous entry, reset.
  275. props->last = &props->first_property;
  276. } else {
  277. // If we are the last entry and there
  278. // is a previous entry, update.
  279. props->last = &prev->next;
  280. }
  281. }
  282. // Fix props->first_property.
  283. if (props->first_property == cur)
  284. props->first_property = cur->next;
  285. // Update the previous element next pointer with our
  286. // next pointer. This is an automatic no-op if both
  287. // elements alias the same memory.
  288. prev->next = cur->next;
  289. // Finally clear our own next pointer and destroy.
  290. cur->next = NULL;
  291. obs_property_destroy(cur);
  292. break;
  293. }
  294. if (cur->type == OBS_PROPERTY_GROUP) {
  295. obs_properties_remove_by_name(
  296. obs_property_group_content(cur), name);
  297. }
  298. prev = cur;
  299. cur = cur->next;
  300. }
  301. }
  302. void obs_properties_apply_settings_internal(obs_properties_t *props,
  303. obs_data_t *settings,
  304. obs_properties_t *realprops)
  305. {
  306. struct obs_property *p;
  307. p = props->first_property;
  308. while (p) {
  309. if (p->type == OBS_PROPERTY_GROUP) {
  310. obs_properties_apply_settings_internal(
  311. obs_property_group_content(p), settings,
  312. realprops);
  313. }
  314. if (p->modified)
  315. p->modified(realprops, p, settings);
  316. else if (p->modified2)
  317. p->modified2(p->priv, realprops, p, settings);
  318. p = p->next;
  319. }
  320. }
  321. void obs_properties_apply_settings(obs_properties_t *props,
  322. obs_data_t *settings)
  323. {
  324. if (!props)
  325. return;
  326. obs_properties_apply_settings_internal(props, settings, props);
  327. }
  328. /* ------------------------------------------------------------------------- */
  329. static inline void propertes_add(struct obs_properties *props,
  330. struct obs_property *p)
  331. {
  332. *props->last = p;
  333. props->last = &p->next;
  334. }
  335. static inline size_t get_property_size(enum obs_property_type type)
  336. {
  337. switch (type) {
  338. case OBS_PROPERTY_INVALID:
  339. return 0;
  340. case OBS_PROPERTY_BOOL:
  341. return 0;
  342. case OBS_PROPERTY_INT:
  343. return sizeof(struct int_data);
  344. case OBS_PROPERTY_FLOAT:
  345. return sizeof(struct float_data);
  346. case OBS_PROPERTY_TEXT:
  347. return sizeof(struct text_data);
  348. case OBS_PROPERTY_PATH:
  349. return sizeof(struct path_data);
  350. case OBS_PROPERTY_LIST:
  351. return sizeof(struct list_data);
  352. case OBS_PROPERTY_COLOR:
  353. return 0;
  354. case OBS_PROPERTY_BUTTON:
  355. return sizeof(struct button_data);
  356. case OBS_PROPERTY_FONT:
  357. return 0;
  358. case OBS_PROPERTY_EDITABLE_LIST:
  359. return sizeof(struct editable_list_data);
  360. case OBS_PROPERTY_FRAME_RATE:
  361. return sizeof(struct frame_rate_data);
  362. case OBS_PROPERTY_GROUP:
  363. return sizeof(struct group_data);
  364. case OBS_PROPERTY_COLOR_ALPHA:
  365. return 0;
  366. }
  367. return 0;
  368. }
  369. static inline struct obs_property *new_prop(struct obs_properties *props,
  370. const char *name, const char *desc,
  371. enum obs_property_type type)
  372. {
  373. size_t data_size = get_property_size(type);
  374. struct obs_property *p;
  375. p = bzalloc(sizeof(struct obs_property) + data_size);
  376. p->parent = props;
  377. p->enabled = true;
  378. p->visible = true;
  379. p->type = type;
  380. p->name = bstrdup(name);
  381. p->desc = bstrdup(desc);
  382. propertes_add(props, p);
  383. return p;
  384. }
  385. static inline obs_properties_t *get_topmost_parent(obs_properties_t *props)
  386. {
  387. obs_properties_t *parent = props;
  388. obs_properties_t *last_parent = parent;
  389. while (parent) {
  390. last_parent = parent;
  391. parent = obs_properties_get_parent(parent);
  392. }
  393. return last_parent;
  394. }
  395. static inline bool contains_prop(struct obs_properties *props, const char *name)
  396. {
  397. struct obs_property *p = props->first_property;
  398. while (p) {
  399. if (strcmp(p->name, name) == 0) {
  400. blog(LOG_WARNING, "Property '%s' exists", name);
  401. return true;
  402. }
  403. if (p->type == OBS_PROPERTY_GROUP) {
  404. if (contains_prop(obs_property_group_content(p),
  405. name)) {
  406. return true;
  407. }
  408. }
  409. p = p->next;
  410. }
  411. return false;
  412. }
  413. static inline bool has_prop(struct obs_properties *props, const char *name)
  414. {
  415. return contains_prop(get_topmost_parent(props), name);
  416. }
  417. static inline void *get_property_data(struct obs_property *prop)
  418. {
  419. return (uint8_t *)prop + sizeof(struct obs_property);
  420. }
  421. static inline void *get_type_data(struct obs_property *prop,
  422. enum obs_property_type type)
  423. {
  424. if (!prop || prop->type != type)
  425. return NULL;
  426. return get_property_data(prop);
  427. }
  428. obs_property_t *obs_properties_add_bool(obs_properties_t *props,
  429. const char *name, const char *desc)
  430. {
  431. if (!props || has_prop(props, name))
  432. return NULL;
  433. return new_prop(props, name, desc, OBS_PROPERTY_BOOL);
  434. }
  435. static obs_property_t *add_int(obs_properties_t *props, const char *name,
  436. const char *desc, int min, int max, int step,
  437. enum obs_number_type type)
  438. {
  439. if (!props || has_prop(props, name))
  440. return NULL;
  441. struct obs_property *p = new_prop(props, name, desc, OBS_PROPERTY_INT);
  442. struct int_data *data = get_property_data(p);
  443. data->min = min;
  444. data->max = max;
  445. data->step = step;
  446. data->type = type;
  447. return p;
  448. }
  449. static obs_property_t *add_flt(obs_properties_t *props, const char *name,
  450. const char *desc, double min, double max,
  451. double step, enum obs_number_type type)
  452. {
  453. if (!props || has_prop(props, name))
  454. return NULL;
  455. struct obs_property *p =
  456. new_prop(props, name, desc, OBS_PROPERTY_FLOAT);
  457. struct float_data *data = get_property_data(p);
  458. data->min = min;
  459. data->max = max;
  460. data->step = step;
  461. data->type = type;
  462. return p;
  463. }
  464. obs_property_t *obs_properties_add_int(obs_properties_t *props,
  465. const char *name, const char *desc,
  466. int min, int max, int step)
  467. {
  468. return add_int(props, name, desc, min, max, step, OBS_NUMBER_SCROLLER);
  469. }
  470. obs_property_t *obs_properties_add_float(obs_properties_t *props,
  471. const char *name, const char *desc,
  472. double min, double max, double step)
  473. {
  474. return add_flt(props, name, desc, min, max, step, OBS_NUMBER_SCROLLER);
  475. }
  476. obs_property_t *obs_properties_add_int_slider(obs_properties_t *props,
  477. const char *name,
  478. const char *desc, int min,
  479. int max, int step)
  480. {
  481. return add_int(props, name, desc, min, max, step, OBS_NUMBER_SLIDER);
  482. }
  483. obs_property_t *obs_properties_add_float_slider(obs_properties_t *props,
  484. const char *name,
  485. const char *desc, double min,
  486. double max, double step)
  487. {
  488. return add_flt(props, name, desc, min, max, step, OBS_NUMBER_SLIDER);
  489. }
  490. obs_property_t *obs_properties_add_text(obs_properties_t *props,
  491. const char *name, const char *desc,
  492. enum obs_text_type type)
  493. {
  494. if (!props || has_prop(props, name))
  495. return NULL;
  496. struct obs_property *p = new_prop(props, name, desc, OBS_PROPERTY_TEXT);
  497. struct text_data *data = get_property_data(p);
  498. data->type = type;
  499. return p;
  500. }
  501. obs_property_t *obs_properties_add_path(obs_properties_t *props,
  502. const char *name, const char *desc,
  503. enum obs_path_type type,
  504. const char *filter,
  505. const char *default_path)
  506. {
  507. if (!props || has_prop(props, name))
  508. return NULL;
  509. struct obs_property *p = new_prop(props, name, desc, OBS_PROPERTY_PATH);
  510. struct path_data *data = get_property_data(p);
  511. data->type = type;
  512. data->default_path = bstrdup(default_path);
  513. if (data->type == OBS_PATH_FILE)
  514. data->filter = bstrdup(filter);
  515. return p;
  516. }
  517. obs_property_t *obs_properties_add_list(obs_properties_t *props,
  518. const char *name, const char *desc,
  519. enum obs_combo_type type,
  520. enum obs_combo_format format)
  521. {
  522. if (!props || has_prop(props, name))
  523. return NULL;
  524. if (type == OBS_COMBO_TYPE_EDITABLE &&
  525. format != OBS_COMBO_FORMAT_STRING) {
  526. blog(LOG_WARNING,
  527. "List '%s', error: Editable combo boxes "
  528. "must be of the 'string' type",
  529. name);
  530. return NULL;
  531. }
  532. struct obs_property *p = new_prop(props, name, desc, OBS_PROPERTY_LIST);
  533. struct list_data *data = get_property_data(p);
  534. data->format = format;
  535. data->type = type;
  536. return p;
  537. }
  538. obs_property_t *obs_properties_add_color(obs_properties_t *props,
  539. const char *name, const char *desc)
  540. {
  541. if (!props || has_prop(props, name))
  542. return NULL;
  543. return new_prop(props, name, desc, OBS_PROPERTY_COLOR);
  544. }
  545. obs_property_t *obs_properties_add_color_alpha(obs_properties_t *props,
  546. const char *name,
  547. const char *desc)
  548. {
  549. if (!props || has_prop(props, name))
  550. return NULL;
  551. return new_prop(props, name, desc, OBS_PROPERTY_COLOR_ALPHA);
  552. }
  553. obs_property_t *obs_properties_add_button(obs_properties_t *props,
  554. const char *name, const char *text,
  555. obs_property_clicked_t callback)
  556. {
  557. if (!props || has_prop(props, name))
  558. return NULL;
  559. struct obs_property *p =
  560. new_prop(props, name, text, OBS_PROPERTY_BUTTON);
  561. struct button_data *data = get_property_data(p);
  562. data->callback = callback;
  563. return p;
  564. }
  565. obs_property_t *obs_properties_add_button2(obs_properties_t *props,
  566. const char *name, const char *text,
  567. obs_property_clicked_t callback,
  568. void *priv)
  569. {
  570. if (!props || has_prop(props, name))
  571. return NULL;
  572. struct obs_property *p =
  573. new_prop(props, name, text, OBS_PROPERTY_BUTTON);
  574. struct button_data *data = get_property_data(p);
  575. data->callback = callback;
  576. p->priv = priv;
  577. return p;
  578. }
  579. obs_property_t *obs_properties_add_font(obs_properties_t *props,
  580. const char *name, const char *desc)
  581. {
  582. if (!props || has_prop(props, name))
  583. return NULL;
  584. return new_prop(props, name, desc, OBS_PROPERTY_FONT);
  585. }
  586. obs_property_t *
  587. obs_properties_add_editable_list(obs_properties_t *props, const char *name,
  588. const char *desc,
  589. enum obs_editable_list_type type,
  590. const char *filter, const char *default_path)
  591. {
  592. if (!props || has_prop(props, name))
  593. return NULL;
  594. struct obs_property *p =
  595. new_prop(props, name, desc, OBS_PROPERTY_EDITABLE_LIST);
  596. struct editable_list_data *data = get_property_data(p);
  597. data->type = type;
  598. data->filter = bstrdup(filter);
  599. data->default_path = bstrdup(default_path);
  600. return p;
  601. }
  602. obs_property_t *obs_properties_add_frame_rate(obs_properties_t *props,
  603. const char *name,
  604. const char *desc)
  605. {
  606. if (!props || has_prop(props, name))
  607. return NULL;
  608. struct obs_property *p =
  609. new_prop(props, name, desc, OBS_PROPERTY_FRAME_RATE);
  610. struct frame_rate_data *data = get_property_data(p);
  611. da_init(data->extra_options);
  612. da_init(data->ranges);
  613. return p;
  614. }
  615. static bool check_property_group_recursion(obs_properties_t *parent,
  616. obs_properties_t *group)
  617. {
  618. /* Scan the group for the parent. */
  619. obs_property_t *current_property = group->first_property;
  620. while (current_property) {
  621. if (current_property->type == OBS_PROPERTY_GROUP) {
  622. obs_properties_t *cprops =
  623. obs_property_group_content(current_property);
  624. if (cprops == parent) {
  625. /* Contains find_props */
  626. return true;
  627. } else if (cprops == group) {
  628. /* Contains self, shouldn't be possible but
  629. * lets verify anyway. */
  630. return true;
  631. }
  632. check_property_group_recursion(cprops, group);
  633. }
  634. current_property = current_property->next;
  635. }
  636. return false;
  637. }
  638. static bool check_property_group_duplicates(obs_properties_t *parent,
  639. obs_properties_t *group)
  640. {
  641. obs_property_t *current_property = group->first_property;
  642. while (current_property) {
  643. if (has_prop(parent, current_property->name)) {
  644. return true;
  645. }
  646. current_property = current_property->next;
  647. }
  648. return false;
  649. }
  650. obs_property_t *obs_properties_add_group(obs_properties_t *props,
  651. const char *name, const char *desc,
  652. enum obs_group_type type,
  653. obs_properties_t *group)
  654. {
  655. if (!props || has_prop(props, name))
  656. return NULL;
  657. if (!group)
  658. return NULL;
  659. /* Prevent recursion. */
  660. if (props == group)
  661. return NULL;
  662. if (check_property_group_recursion(props, group))
  663. return NULL;
  664. /* Prevent duplicate properties */
  665. if (check_property_group_duplicates(props, group))
  666. return NULL;
  667. obs_property_t *p = new_prop(props, name, desc, OBS_PROPERTY_GROUP);
  668. group->parent = p;
  669. struct group_data *data = get_property_data(p);
  670. data->type = type;
  671. data->content = group;
  672. return p;
  673. }
  674. /* ------------------------------------------------------------------------- */
  675. static inline bool is_combo(struct obs_property *p)
  676. {
  677. return p->type == OBS_PROPERTY_LIST;
  678. }
  679. static inline struct list_data *get_list_data(struct obs_property *p)
  680. {
  681. if (!p || !is_combo(p))
  682. return NULL;
  683. return get_property_data(p);
  684. }
  685. static inline struct list_data *get_list_fmt_data(struct obs_property *p,
  686. enum obs_combo_format format)
  687. {
  688. struct list_data *data = get_list_data(p);
  689. return (data && data->format == format) ? data : NULL;
  690. }
  691. /* ------------------------------------------------------------------------- */
  692. bool obs_property_next(obs_property_t **p)
  693. {
  694. if (!p || !*p)
  695. return false;
  696. *p = (*p)->next;
  697. return *p != NULL;
  698. }
  699. void obs_property_set_modified_callback(obs_property_t *p,
  700. obs_property_modified_t modified)
  701. {
  702. if (p)
  703. p->modified = modified;
  704. }
  705. void obs_property_set_modified_callback2(obs_property_t *p,
  706. obs_property_modified2_t modified2,
  707. void *priv)
  708. {
  709. if (p) {
  710. p->modified2 = modified2;
  711. p->priv = priv;
  712. }
  713. }
  714. bool obs_property_modified(obs_property_t *p, obs_data_t *settings)
  715. {
  716. if (p) {
  717. if (p->modified) {
  718. obs_properties_t *top = get_topmost_parent(p->parent);
  719. return p->modified(top, p, settings);
  720. } else if (p->modified2) {
  721. obs_properties_t *top = get_topmost_parent(p->parent);
  722. return p->modified2(p->priv, top, p, settings);
  723. }
  724. }
  725. return false;
  726. }
  727. bool obs_property_button_clicked(obs_property_t *p, void *obj)
  728. {
  729. struct obs_context_data *context = obj;
  730. if (p) {
  731. struct button_data *data =
  732. get_type_data(p, OBS_PROPERTY_BUTTON);
  733. if (data && data->callback) {
  734. obs_properties_t *top = get_topmost_parent(p->parent);
  735. if (p->priv)
  736. return data->callback(top, p, p->priv);
  737. return data->callback(top, p,
  738. (context ? context->data : NULL));
  739. }
  740. }
  741. return false;
  742. }
  743. void obs_property_set_visible(obs_property_t *p, bool visible)
  744. {
  745. if (p)
  746. p->visible = visible;
  747. }
  748. void obs_property_set_enabled(obs_property_t *p, bool enabled)
  749. {
  750. if (p)
  751. p->enabled = enabled;
  752. }
  753. void obs_property_set_description(obs_property_t *p, const char *description)
  754. {
  755. if (p) {
  756. bfree(p->desc);
  757. p->desc = description && *description ? bstrdup(description)
  758. : NULL;
  759. }
  760. }
  761. void obs_property_set_long_description(obs_property_t *p, const char *long_desc)
  762. {
  763. if (p) {
  764. bfree(p->long_desc);
  765. p->long_desc = long_desc && *long_desc ? bstrdup(long_desc)
  766. : NULL;
  767. }
  768. }
  769. const char *obs_property_name(obs_property_t *p)
  770. {
  771. return p ? p->name : NULL;
  772. }
  773. const char *obs_property_description(obs_property_t *p)
  774. {
  775. return p ? p->desc : NULL;
  776. }
  777. const char *obs_property_long_description(obs_property_t *p)
  778. {
  779. return p ? p->long_desc : NULL;
  780. }
  781. enum obs_property_type obs_property_get_type(obs_property_t *p)
  782. {
  783. return p ? p->type : OBS_PROPERTY_INVALID;
  784. }
  785. bool obs_property_enabled(obs_property_t *p)
  786. {
  787. return p ? p->enabled : false;
  788. }
  789. bool obs_property_visible(obs_property_t *p)
  790. {
  791. return p ? p->visible : false;
  792. }
  793. int obs_property_int_min(obs_property_t *p)
  794. {
  795. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  796. return data ? data->min : 0;
  797. }
  798. int obs_property_int_max(obs_property_t *p)
  799. {
  800. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  801. return data ? data->max : 0;
  802. }
  803. int obs_property_int_step(obs_property_t *p)
  804. {
  805. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  806. return data ? data->step : 0;
  807. }
  808. enum obs_number_type obs_property_int_type(obs_property_t *p)
  809. {
  810. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  811. return data ? data->type : OBS_NUMBER_SCROLLER;
  812. }
  813. const char *obs_property_int_suffix(obs_property_t *p)
  814. {
  815. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  816. return data ? data->suffix : NULL;
  817. }
  818. double obs_property_float_min(obs_property_t *p)
  819. {
  820. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  821. return data ? data->min : 0;
  822. }
  823. double obs_property_float_max(obs_property_t *p)
  824. {
  825. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  826. return data ? data->max : 0;
  827. }
  828. double obs_property_float_step(obs_property_t *p)
  829. {
  830. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  831. return data ? data->step : 0;
  832. }
  833. const char *obs_property_float_suffix(obs_property_t *p)
  834. {
  835. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  836. return data ? data->suffix : NULL;
  837. }
  838. enum obs_number_type obs_property_float_type(obs_property_t *p)
  839. {
  840. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  841. return data ? data->type : OBS_NUMBER_SCROLLER;
  842. }
  843. enum obs_text_type obs_property_text_type(obs_property_t *p)
  844. {
  845. struct text_data *data = get_type_data(p, OBS_PROPERTY_TEXT);
  846. return data ? data->type : OBS_TEXT_DEFAULT;
  847. }
  848. enum obs_text_type obs_property_text_monospace(obs_property_t *p)
  849. {
  850. struct text_data *data = get_type_data(p, OBS_PROPERTY_TEXT);
  851. return data ? data->monospace : false;
  852. }
  853. enum obs_path_type obs_property_path_type(obs_property_t *p)
  854. {
  855. struct path_data *data = get_type_data(p, OBS_PROPERTY_PATH);
  856. return data ? data->type : OBS_PATH_DIRECTORY;
  857. }
  858. const char *obs_property_path_filter(obs_property_t *p)
  859. {
  860. struct path_data *data = get_type_data(p, OBS_PROPERTY_PATH);
  861. return data ? data->filter : NULL;
  862. }
  863. const char *obs_property_path_default_path(obs_property_t *p)
  864. {
  865. struct path_data *data = get_type_data(p, OBS_PROPERTY_PATH);
  866. return data ? data->default_path : NULL;
  867. }
  868. enum obs_combo_type obs_property_list_type(obs_property_t *p)
  869. {
  870. struct list_data *data = get_list_data(p);
  871. return data ? data->type : OBS_COMBO_TYPE_INVALID;
  872. }
  873. enum obs_combo_format obs_property_list_format(obs_property_t *p)
  874. {
  875. struct list_data *data = get_list_data(p);
  876. return data ? data->format : OBS_COMBO_FORMAT_INVALID;
  877. }
  878. void obs_property_int_set_limits(obs_property_t *p, int min, int max, int step)
  879. {
  880. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  881. if (!data)
  882. return;
  883. data->min = min;
  884. data->max = max;
  885. data->step = step;
  886. }
  887. void obs_property_float_set_limits(obs_property_t *p, double min, double max,
  888. double step)
  889. {
  890. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  891. if (!data)
  892. return;
  893. data->min = min;
  894. data->max = max;
  895. data->step = step;
  896. }
  897. void obs_property_int_set_suffix(obs_property_t *p, const char *suffix)
  898. {
  899. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  900. if (!data)
  901. return;
  902. bfree(data->suffix);
  903. data->suffix = bstrdup(suffix);
  904. }
  905. void obs_property_float_set_suffix(obs_property_t *p, const char *suffix)
  906. {
  907. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  908. if (!data)
  909. return;
  910. bfree(data->suffix);
  911. data->suffix = bstrdup(suffix);
  912. }
  913. void obs_property_text_set_monospace(obs_property_t *p, bool monospace)
  914. {
  915. struct text_data *data = get_type_data(p, OBS_PROPERTY_TEXT);
  916. if (!data)
  917. return;
  918. data->monospace = monospace;
  919. }
  920. void obs_property_list_clear(obs_property_t *p)
  921. {
  922. struct list_data *data = get_list_data(p);
  923. if (data)
  924. list_data_free(data);
  925. }
  926. static size_t add_item(struct list_data *data, const char *name,
  927. const void *val)
  928. {
  929. struct list_item item = {NULL};
  930. item.name = bstrdup(name);
  931. if (data->format == OBS_COMBO_FORMAT_INT)
  932. item.ll = *(const long long *)val;
  933. else if (data->format == OBS_COMBO_FORMAT_FLOAT)
  934. item.d = *(const double *)val;
  935. else
  936. item.str = bstrdup(val);
  937. return da_push_back(data->items, &item);
  938. }
  939. static void insert_item(struct list_data *data, size_t idx, const char *name,
  940. const void *val)
  941. {
  942. struct list_item item = {NULL};
  943. item.name = bstrdup(name);
  944. if (data->format == OBS_COMBO_FORMAT_INT)
  945. item.ll = *(const long long *)val;
  946. else if (data->format == OBS_COMBO_FORMAT_FLOAT)
  947. item.d = *(const double *)val;
  948. else
  949. item.str = bstrdup(val);
  950. da_insert(data->items, idx, &item);
  951. }
  952. size_t obs_property_list_add_string(obs_property_t *p, const char *name,
  953. const char *val)
  954. {
  955. struct list_data *data = get_list_data(p);
  956. if (data && data->format == OBS_COMBO_FORMAT_STRING)
  957. return add_item(data, name, val);
  958. return 0;
  959. }
  960. size_t obs_property_list_add_int(obs_property_t *p, const char *name,
  961. long long val)
  962. {
  963. struct list_data *data = get_list_data(p);
  964. if (data && data->format == OBS_COMBO_FORMAT_INT)
  965. return add_item(data, name, &val);
  966. return 0;
  967. }
  968. size_t obs_property_list_add_float(obs_property_t *p, const char *name,
  969. double val)
  970. {
  971. struct list_data *data = get_list_data(p);
  972. if (data && data->format == OBS_COMBO_FORMAT_FLOAT)
  973. return add_item(data, name, &val);
  974. return 0;
  975. }
  976. void obs_property_list_insert_string(obs_property_t *p, size_t idx,
  977. const char *name, const char *val)
  978. {
  979. struct list_data *data = get_list_data(p);
  980. if (data && data->format == OBS_COMBO_FORMAT_STRING)
  981. insert_item(data, idx, name, val);
  982. }
  983. void obs_property_list_insert_int(obs_property_t *p, size_t idx,
  984. const char *name, long long val)
  985. {
  986. struct list_data *data = get_list_data(p);
  987. if (data && data->format == OBS_COMBO_FORMAT_INT)
  988. insert_item(data, idx, name, &val);
  989. }
  990. void obs_property_list_insert_float(obs_property_t *p, size_t idx,
  991. const char *name, double val)
  992. {
  993. struct list_data *data = get_list_data(p);
  994. if (data && data->format == OBS_COMBO_FORMAT_FLOAT)
  995. insert_item(data, idx, name, &val);
  996. }
  997. void obs_property_list_item_remove(obs_property_t *p, size_t idx)
  998. {
  999. struct list_data *data = get_list_data(p);
  1000. if (data && idx < data->items.num) {
  1001. list_item_free(data, data->items.array + idx);
  1002. da_erase(data->items, idx);
  1003. }
  1004. }
  1005. size_t obs_property_list_item_count(obs_property_t *p)
  1006. {
  1007. struct list_data *data = get_list_data(p);
  1008. return data ? data->items.num : 0;
  1009. }
  1010. bool obs_property_list_item_disabled(obs_property_t *p, size_t idx)
  1011. {
  1012. struct list_data *data = get_list_data(p);
  1013. return (data && idx < data->items.num) ? data->items.array[idx].disabled
  1014. : false;
  1015. }
  1016. void obs_property_list_item_disable(obs_property_t *p, size_t idx,
  1017. bool disabled)
  1018. {
  1019. struct list_data *data = get_list_data(p);
  1020. if (!data || idx >= data->items.num)
  1021. return;
  1022. data->items.array[idx].disabled = disabled;
  1023. }
  1024. const char *obs_property_list_item_name(obs_property_t *p, size_t idx)
  1025. {
  1026. struct list_data *data = get_list_data(p);
  1027. return (data && idx < data->items.num) ? data->items.array[idx].name
  1028. : NULL;
  1029. }
  1030. const char *obs_property_list_item_string(obs_property_t *p, size_t idx)
  1031. {
  1032. struct list_data *data = get_list_fmt_data(p, OBS_COMBO_FORMAT_STRING);
  1033. return (data && idx < data->items.num) ? data->items.array[idx].str
  1034. : NULL;
  1035. }
  1036. long long obs_property_list_item_int(obs_property_t *p, size_t idx)
  1037. {
  1038. struct list_data *data = get_list_fmt_data(p, OBS_COMBO_FORMAT_INT);
  1039. return (data && idx < data->items.num) ? data->items.array[idx].ll : 0;
  1040. }
  1041. double obs_property_list_item_float(obs_property_t *p, size_t idx)
  1042. {
  1043. struct list_data *data = get_list_fmt_data(p, OBS_COMBO_FORMAT_FLOAT);
  1044. return (data && idx < data->items.num) ? data->items.array[idx].d : 0.0;
  1045. }
  1046. enum obs_editable_list_type obs_property_editable_list_type(obs_property_t *p)
  1047. {
  1048. struct editable_list_data *data =
  1049. get_type_data(p, OBS_PROPERTY_EDITABLE_LIST);
  1050. return data ? data->type : OBS_EDITABLE_LIST_TYPE_STRINGS;
  1051. }
  1052. const char *obs_property_editable_list_filter(obs_property_t *p)
  1053. {
  1054. struct editable_list_data *data =
  1055. get_type_data(p, OBS_PROPERTY_EDITABLE_LIST);
  1056. return data ? data->filter : NULL;
  1057. }
  1058. const char *obs_property_editable_list_default_path(obs_property_t *p)
  1059. {
  1060. struct editable_list_data *data =
  1061. get_type_data(p, OBS_PROPERTY_EDITABLE_LIST);
  1062. return data ? data->default_path : NULL;
  1063. }
  1064. /* ------------------------------------------------------------------------- */
  1065. /* OBS_PROPERTY_FRAME_RATE */
  1066. void obs_property_frame_rate_clear(obs_property_t *p)
  1067. {
  1068. struct frame_rate_data *data =
  1069. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1070. if (!data)
  1071. return;
  1072. frame_rate_data_options_free(data);
  1073. frame_rate_data_ranges_free(data);
  1074. }
  1075. void obs_property_frame_rate_options_clear(obs_property_t *p)
  1076. {
  1077. struct frame_rate_data *data =
  1078. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1079. if (!data)
  1080. return;
  1081. frame_rate_data_options_free(data);
  1082. }
  1083. void obs_property_frame_rate_fps_ranges_clear(obs_property_t *p)
  1084. {
  1085. struct frame_rate_data *data =
  1086. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1087. if (!data)
  1088. return;
  1089. frame_rate_data_ranges_free(data);
  1090. }
  1091. size_t obs_property_frame_rate_option_add(obs_property_t *p, const char *name,
  1092. const char *description)
  1093. {
  1094. struct frame_rate_data *data =
  1095. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1096. if (!data)
  1097. return DARRAY_INVALID;
  1098. struct frame_rate_option *opt = da_push_back_new(data->extra_options);
  1099. opt->name = bstrdup(name);
  1100. opt->description = bstrdup(description);
  1101. return data->extra_options.num - 1;
  1102. }
  1103. size_t obs_property_frame_rate_fps_range_add(obs_property_t *p,
  1104. struct media_frames_per_second min,
  1105. struct media_frames_per_second max)
  1106. {
  1107. struct frame_rate_data *data =
  1108. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1109. if (!data)
  1110. return DARRAY_INVALID;
  1111. struct frame_rate_range *rng = da_push_back_new(data->ranges);
  1112. rng->min_time = min;
  1113. rng->max_time = max;
  1114. return data->ranges.num - 1;
  1115. }
  1116. void obs_property_frame_rate_option_insert(obs_property_t *p, size_t idx,
  1117. const char *name,
  1118. const char *description)
  1119. {
  1120. struct frame_rate_data *data =
  1121. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1122. if (!data)
  1123. return;
  1124. struct frame_rate_option *opt = da_insert_new(data->extra_options, idx);
  1125. opt->name = bstrdup(name);
  1126. opt->description = bstrdup(description);
  1127. }
  1128. void obs_property_frame_rate_fps_range_insert(
  1129. obs_property_t *p, size_t idx, struct media_frames_per_second min,
  1130. struct media_frames_per_second max)
  1131. {
  1132. struct frame_rate_data *data =
  1133. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1134. if (!data)
  1135. return;
  1136. struct frame_rate_range *rng = da_insert_new(data->ranges, idx);
  1137. rng->min_time = min;
  1138. rng->max_time = max;
  1139. }
  1140. size_t obs_property_frame_rate_options_count(obs_property_t *p)
  1141. {
  1142. struct frame_rate_data *data =
  1143. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1144. return data ? data->extra_options.num : 0;
  1145. }
  1146. const char *obs_property_frame_rate_option_name(obs_property_t *p, size_t idx)
  1147. {
  1148. struct frame_rate_data *data =
  1149. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1150. return data && data->extra_options.num > idx
  1151. ? data->extra_options.array[idx].name
  1152. : NULL;
  1153. }
  1154. const char *obs_property_frame_rate_option_description(obs_property_t *p,
  1155. size_t idx)
  1156. {
  1157. struct frame_rate_data *data =
  1158. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1159. return data && data->extra_options.num > idx
  1160. ? data->extra_options.array[idx].description
  1161. : NULL;
  1162. }
  1163. size_t obs_property_frame_rate_fps_ranges_count(obs_property_t *p)
  1164. {
  1165. struct frame_rate_data *data =
  1166. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1167. return data ? data->ranges.num : 0;
  1168. }
  1169. struct media_frames_per_second
  1170. obs_property_frame_rate_fps_range_min(obs_property_t *p, size_t idx)
  1171. {
  1172. struct frame_rate_data *data =
  1173. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1174. return data && data->ranges.num > idx
  1175. ? data->ranges.array[idx].min_time
  1176. : (struct media_frames_per_second){0};
  1177. }
  1178. struct media_frames_per_second
  1179. obs_property_frame_rate_fps_range_max(obs_property_t *p, size_t idx)
  1180. {
  1181. struct frame_rate_data *data =
  1182. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1183. return data && data->ranges.num > idx
  1184. ? data->ranges.array[idx].max_time
  1185. : (struct media_frames_per_second){0};
  1186. }
  1187. enum obs_text_type obs_proprety_text_type(obs_property_t *p)
  1188. {
  1189. return obs_property_text_type(p);
  1190. }
  1191. enum obs_group_type obs_property_group_type(obs_property_t *p)
  1192. {
  1193. struct group_data *data = get_type_data(p, OBS_PROPERTY_GROUP);
  1194. return data ? data->type : OBS_COMBO_INVALID;
  1195. }
  1196. obs_properties_t *obs_property_group_content(obs_property_t *p)
  1197. {
  1198. struct group_data *data = get_type_data(p, OBS_PROPERTY_GROUP);
  1199. return data ? data->content : NULL;
  1200. }