obs-properties.c 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437
  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. if (check_property_group_recursion(parent, cprops))
  633. return true;
  634. }
  635. current_property = current_property->next;
  636. }
  637. return false;
  638. }
  639. static bool check_property_group_duplicates(obs_properties_t *parent,
  640. obs_properties_t *group)
  641. {
  642. obs_property_t *current_property = group->first_property;
  643. while (current_property) {
  644. if (has_prop(parent, current_property->name)) {
  645. return true;
  646. }
  647. current_property = current_property->next;
  648. }
  649. return false;
  650. }
  651. obs_property_t *obs_properties_add_group(obs_properties_t *props,
  652. const char *name, const char *desc,
  653. enum obs_group_type type,
  654. obs_properties_t *group)
  655. {
  656. if (!props || has_prop(props, name))
  657. return NULL;
  658. if (!group)
  659. return NULL;
  660. /* Prevent recursion. */
  661. if (props == group)
  662. return NULL;
  663. if (check_property_group_recursion(props, group))
  664. return NULL;
  665. /* Prevent duplicate properties */
  666. if (check_property_group_duplicates(props, group))
  667. return NULL;
  668. obs_property_t *p = new_prop(props, name, desc, OBS_PROPERTY_GROUP);
  669. group->parent = p;
  670. struct group_data *data = get_property_data(p);
  671. data->type = type;
  672. data->content = group;
  673. return p;
  674. }
  675. /* ------------------------------------------------------------------------- */
  676. static inline bool is_combo(struct obs_property *p)
  677. {
  678. return p->type == OBS_PROPERTY_LIST;
  679. }
  680. static inline struct list_data *get_list_data(struct obs_property *p)
  681. {
  682. if (!p || !is_combo(p))
  683. return NULL;
  684. return get_property_data(p);
  685. }
  686. static inline struct list_data *get_list_fmt_data(struct obs_property *p,
  687. enum obs_combo_format format)
  688. {
  689. struct list_data *data = get_list_data(p);
  690. return (data && data->format == format) ? data : NULL;
  691. }
  692. /* ------------------------------------------------------------------------- */
  693. bool obs_property_next(obs_property_t **p)
  694. {
  695. if (!p || !*p)
  696. return false;
  697. *p = (*p)->next;
  698. return *p != NULL;
  699. }
  700. void obs_property_set_modified_callback(obs_property_t *p,
  701. obs_property_modified_t modified)
  702. {
  703. if (p)
  704. p->modified = modified;
  705. }
  706. void obs_property_set_modified_callback2(obs_property_t *p,
  707. obs_property_modified2_t modified2,
  708. void *priv)
  709. {
  710. if (p) {
  711. p->modified2 = modified2;
  712. p->priv = priv;
  713. }
  714. }
  715. bool obs_property_modified(obs_property_t *p, obs_data_t *settings)
  716. {
  717. if (p) {
  718. if (p->modified) {
  719. obs_properties_t *top = get_topmost_parent(p->parent);
  720. return p->modified(top, p, settings);
  721. } else if (p->modified2) {
  722. obs_properties_t *top = get_topmost_parent(p->parent);
  723. return p->modified2(p->priv, top, p, settings);
  724. }
  725. }
  726. return false;
  727. }
  728. bool obs_property_button_clicked(obs_property_t *p, void *obj)
  729. {
  730. struct obs_context_data *context = obj;
  731. if (p) {
  732. struct button_data *data =
  733. get_type_data(p, OBS_PROPERTY_BUTTON);
  734. if (data && data->callback) {
  735. obs_properties_t *top = get_topmost_parent(p->parent);
  736. if (p->priv)
  737. return data->callback(top, p, p->priv);
  738. return data->callback(top, p,
  739. (context ? context->data : NULL));
  740. }
  741. }
  742. return false;
  743. }
  744. void obs_property_set_visible(obs_property_t *p, bool visible)
  745. {
  746. if (p)
  747. p->visible = visible;
  748. }
  749. void obs_property_set_enabled(obs_property_t *p, bool enabled)
  750. {
  751. if (p)
  752. p->enabled = enabled;
  753. }
  754. void obs_property_set_description(obs_property_t *p, const char *description)
  755. {
  756. if (p) {
  757. bfree(p->desc);
  758. p->desc = description && *description ? bstrdup(description)
  759. : NULL;
  760. }
  761. }
  762. void obs_property_set_long_description(obs_property_t *p, const char *long_desc)
  763. {
  764. if (p) {
  765. bfree(p->long_desc);
  766. p->long_desc = long_desc && *long_desc ? bstrdup(long_desc)
  767. : NULL;
  768. }
  769. }
  770. const char *obs_property_name(obs_property_t *p)
  771. {
  772. return p ? p->name : NULL;
  773. }
  774. const char *obs_property_description(obs_property_t *p)
  775. {
  776. return p ? p->desc : NULL;
  777. }
  778. const char *obs_property_long_description(obs_property_t *p)
  779. {
  780. return p ? p->long_desc : NULL;
  781. }
  782. enum obs_property_type obs_property_get_type(obs_property_t *p)
  783. {
  784. return p ? p->type : OBS_PROPERTY_INVALID;
  785. }
  786. bool obs_property_enabled(obs_property_t *p)
  787. {
  788. return p ? p->enabled : false;
  789. }
  790. bool obs_property_visible(obs_property_t *p)
  791. {
  792. return p ? p->visible : false;
  793. }
  794. int obs_property_int_min(obs_property_t *p)
  795. {
  796. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  797. return data ? data->min : 0;
  798. }
  799. int obs_property_int_max(obs_property_t *p)
  800. {
  801. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  802. return data ? data->max : 0;
  803. }
  804. int obs_property_int_step(obs_property_t *p)
  805. {
  806. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  807. return data ? data->step : 0;
  808. }
  809. enum obs_number_type obs_property_int_type(obs_property_t *p)
  810. {
  811. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  812. return data ? data->type : OBS_NUMBER_SCROLLER;
  813. }
  814. const char *obs_property_int_suffix(obs_property_t *p)
  815. {
  816. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  817. return data ? data->suffix : NULL;
  818. }
  819. double obs_property_float_min(obs_property_t *p)
  820. {
  821. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  822. return data ? data->min : 0;
  823. }
  824. double obs_property_float_max(obs_property_t *p)
  825. {
  826. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  827. return data ? data->max : 0;
  828. }
  829. double obs_property_float_step(obs_property_t *p)
  830. {
  831. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  832. return data ? data->step : 0;
  833. }
  834. const char *obs_property_float_suffix(obs_property_t *p)
  835. {
  836. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  837. return data ? data->suffix : NULL;
  838. }
  839. enum obs_number_type obs_property_float_type(obs_property_t *p)
  840. {
  841. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  842. return data ? data->type : OBS_NUMBER_SCROLLER;
  843. }
  844. enum obs_text_type obs_property_text_type(obs_property_t *p)
  845. {
  846. struct text_data *data = get_type_data(p, OBS_PROPERTY_TEXT);
  847. return data ? data->type : OBS_TEXT_DEFAULT;
  848. }
  849. enum obs_text_type obs_property_text_monospace(obs_property_t *p)
  850. {
  851. struct text_data *data = get_type_data(p, OBS_PROPERTY_TEXT);
  852. return data ? data->monospace : false;
  853. }
  854. enum obs_path_type obs_property_path_type(obs_property_t *p)
  855. {
  856. struct path_data *data = get_type_data(p, OBS_PROPERTY_PATH);
  857. return data ? data->type : OBS_PATH_DIRECTORY;
  858. }
  859. const char *obs_property_path_filter(obs_property_t *p)
  860. {
  861. struct path_data *data = get_type_data(p, OBS_PROPERTY_PATH);
  862. return data ? data->filter : NULL;
  863. }
  864. const char *obs_property_path_default_path(obs_property_t *p)
  865. {
  866. struct path_data *data = get_type_data(p, OBS_PROPERTY_PATH);
  867. return data ? data->default_path : NULL;
  868. }
  869. enum obs_combo_type obs_property_list_type(obs_property_t *p)
  870. {
  871. struct list_data *data = get_list_data(p);
  872. return data ? data->type : OBS_COMBO_TYPE_INVALID;
  873. }
  874. enum obs_combo_format obs_property_list_format(obs_property_t *p)
  875. {
  876. struct list_data *data = get_list_data(p);
  877. return data ? data->format : OBS_COMBO_FORMAT_INVALID;
  878. }
  879. void obs_property_int_set_limits(obs_property_t *p, int min, int max, int step)
  880. {
  881. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  882. if (!data)
  883. return;
  884. data->min = min;
  885. data->max = max;
  886. data->step = step;
  887. }
  888. void obs_property_float_set_limits(obs_property_t *p, double min, double max,
  889. double step)
  890. {
  891. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  892. if (!data)
  893. return;
  894. data->min = min;
  895. data->max = max;
  896. data->step = step;
  897. }
  898. void obs_property_int_set_suffix(obs_property_t *p, const char *suffix)
  899. {
  900. struct int_data *data = get_type_data(p, OBS_PROPERTY_INT);
  901. if (!data)
  902. return;
  903. bfree(data->suffix);
  904. data->suffix = bstrdup(suffix);
  905. }
  906. void obs_property_float_set_suffix(obs_property_t *p, const char *suffix)
  907. {
  908. struct float_data *data = get_type_data(p, OBS_PROPERTY_FLOAT);
  909. if (!data)
  910. return;
  911. bfree(data->suffix);
  912. data->suffix = bstrdup(suffix);
  913. }
  914. void obs_property_text_set_monospace(obs_property_t *p, bool monospace)
  915. {
  916. struct text_data *data = get_type_data(p, OBS_PROPERTY_TEXT);
  917. if (!data)
  918. return;
  919. data->monospace = monospace;
  920. }
  921. void obs_property_list_clear(obs_property_t *p)
  922. {
  923. struct list_data *data = get_list_data(p);
  924. if (data)
  925. list_data_free(data);
  926. }
  927. static size_t add_item(struct list_data *data, const char *name,
  928. const void *val)
  929. {
  930. struct list_item item = {NULL};
  931. item.name = bstrdup(name);
  932. if (data->format == OBS_COMBO_FORMAT_INT)
  933. item.ll = *(const long long *)val;
  934. else if (data->format == OBS_COMBO_FORMAT_FLOAT)
  935. item.d = *(const double *)val;
  936. else
  937. item.str = bstrdup(val);
  938. return da_push_back(data->items, &item);
  939. }
  940. static void insert_item(struct list_data *data, size_t idx, const char *name,
  941. const void *val)
  942. {
  943. struct list_item item = {NULL};
  944. item.name = bstrdup(name);
  945. if (data->format == OBS_COMBO_FORMAT_INT)
  946. item.ll = *(const long long *)val;
  947. else if (data->format == OBS_COMBO_FORMAT_FLOAT)
  948. item.d = *(const double *)val;
  949. else
  950. item.str = bstrdup(val);
  951. da_insert(data->items, idx, &item);
  952. }
  953. size_t obs_property_list_add_string(obs_property_t *p, const char *name,
  954. const char *val)
  955. {
  956. struct list_data *data = get_list_data(p);
  957. if (data && data->format == OBS_COMBO_FORMAT_STRING)
  958. return add_item(data, name, val);
  959. return 0;
  960. }
  961. size_t obs_property_list_add_int(obs_property_t *p, const char *name,
  962. long long val)
  963. {
  964. struct list_data *data = get_list_data(p);
  965. if (data && data->format == OBS_COMBO_FORMAT_INT)
  966. return add_item(data, name, &val);
  967. return 0;
  968. }
  969. size_t obs_property_list_add_float(obs_property_t *p, const char *name,
  970. double val)
  971. {
  972. struct list_data *data = get_list_data(p);
  973. if (data && data->format == OBS_COMBO_FORMAT_FLOAT)
  974. return add_item(data, name, &val);
  975. return 0;
  976. }
  977. void obs_property_list_insert_string(obs_property_t *p, size_t idx,
  978. const char *name, const char *val)
  979. {
  980. struct list_data *data = get_list_data(p);
  981. if (data && data->format == OBS_COMBO_FORMAT_STRING)
  982. insert_item(data, idx, name, val);
  983. }
  984. void obs_property_list_insert_int(obs_property_t *p, size_t idx,
  985. const char *name, long long val)
  986. {
  987. struct list_data *data = get_list_data(p);
  988. if (data && data->format == OBS_COMBO_FORMAT_INT)
  989. insert_item(data, idx, name, &val);
  990. }
  991. void obs_property_list_insert_float(obs_property_t *p, size_t idx,
  992. const char *name, double val)
  993. {
  994. struct list_data *data = get_list_data(p);
  995. if (data && data->format == OBS_COMBO_FORMAT_FLOAT)
  996. insert_item(data, idx, name, &val);
  997. }
  998. void obs_property_list_item_remove(obs_property_t *p, size_t idx)
  999. {
  1000. struct list_data *data = get_list_data(p);
  1001. if (data && idx < data->items.num) {
  1002. list_item_free(data, data->items.array + idx);
  1003. da_erase(data->items, idx);
  1004. }
  1005. }
  1006. size_t obs_property_list_item_count(obs_property_t *p)
  1007. {
  1008. struct list_data *data = get_list_data(p);
  1009. return data ? data->items.num : 0;
  1010. }
  1011. bool obs_property_list_item_disabled(obs_property_t *p, size_t idx)
  1012. {
  1013. struct list_data *data = get_list_data(p);
  1014. return (data && idx < data->items.num) ? data->items.array[idx].disabled
  1015. : false;
  1016. }
  1017. void obs_property_list_item_disable(obs_property_t *p, size_t idx,
  1018. bool disabled)
  1019. {
  1020. struct list_data *data = get_list_data(p);
  1021. if (!data || idx >= data->items.num)
  1022. return;
  1023. data->items.array[idx].disabled = disabled;
  1024. }
  1025. const char *obs_property_list_item_name(obs_property_t *p, size_t idx)
  1026. {
  1027. struct list_data *data = get_list_data(p);
  1028. return (data && idx < data->items.num) ? data->items.array[idx].name
  1029. : NULL;
  1030. }
  1031. const char *obs_property_list_item_string(obs_property_t *p, size_t idx)
  1032. {
  1033. struct list_data *data = get_list_fmt_data(p, OBS_COMBO_FORMAT_STRING);
  1034. return (data && idx < data->items.num) ? data->items.array[idx].str
  1035. : NULL;
  1036. }
  1037. long long obs_property_list_item_int(obs_property_t *p, size_t idx)
  1038. {
  1039. struct list_data *data = get_list_fmt_data(p, OBS_COMBO_FORMAT_INT);
  1040. return (data && idx < data->items.num) ? data->items.array[idx].ll : 0;
  1041. }
  1042. double obs_property_list_item_float(obs_property_t *p, size_t idx)
  1043. {
  1044. struct list_data *data = get_list_fmt_data(p, OBS_COMBO_FORMAT_FLOAT);
  1045. return (data && idx < data->items.num) ? data->items.array[idx].d : 0.0;
  1046. }
  1047. enum obs_editable_list_type obs_property_editable_list_type(obs_property_t *p)
  1048. {
  1049. struct editable_list_data *data =
  1050. get_type_data(p, OBS_PROPERTY_EDITABLE_LIST);
  1051. return data ? data->type : OBS_EDITABLE_LIST_TYPE_STRINGS;
  1052. }
  1053. const char *obs_property_editable_list_filter(obs_property_t *p)
  1054. {
  1055. struct editable_list_data *data =
  1056. get_type_data(p, OBS_PROPERTY_EDITABLE_LIST);
  1057. return data ? data->filter : NULL;
  1058. }
  1059. const char *obs_property_editable_list_default_path(obs_property_t *p)
  1060. {
  1061. struct editable_list_data *data =
  1062. get_type_data(p, OBS_PROPERTY_EDITABLE_LIST);
  1063. return data ? data->default_path : NULL;
  1064. }
  1065. /* ------------------------------------------------------------------------- */
  1066. /* OBS_PROPERTY_FRAME_RATE */
  1067. void obs_property_frame_rate_clear(obs_property_t *p)
  1068. {
  1069. struct frame_rate_data *data =
  1070. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1071. if (!data)
  1072. return;
  1073. frame_rate_data_options_free(data);
  1074. frame_rate_data_ranges_free(data);
  1075. }
  1076. void obs_property_frame_rate_options_clear(obs_property_t *p)
  1077. {
  1078. struct frame_rate_data *data =
  1079. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1080. if (!data)
  1081. return;
  1082. frame_rate_data_options_free(data);
  1083. }
  1084. void obs_property_frame_rate_fps_ranges_clear(obs_property_t *p)
  1085. {
  1086. struct frame_rate_data *data =
  1087. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1088. if (!data)
  1089. return;
  1090. frame_rate_data_ranges_free(data);
  1091. }
  1092. size_t obs_property_frame_rate_option_add(obs_property_t *p, const char *name,
  1093. const char *description)
  1094. {
  1095. struct frame_rate_data *data =
  1096. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1097. if (!data)
  1098. return DARRAY_INVALID;
  1099. struct frame_rate_option *opt = da_push_back_new(data->extra_options);
  1100. opt->name = bstrdup(name);
  1101. opt->description = bstrdup(description);
  1102. return data->extra_options.num - 1;
  1103. }
  1104. size_t obs_property_frame_rate_fps_range_add(obs_property_t *p,
  1105. struct media_frames_per_second min,
  1106. struct media_frames_per_second max)
  1107. {
  1108. struct frame_rate_data *data =
  1109. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1110. if (!data)
  1111. return DARRAY_INVALID;
  1112. struct frame_rate_range *rng = da_push_back_new(data->ranges);
  1113. rng->min_time = min;
  1114. rng->max_time = max;
  1115. return data->ranges.num - 1;
  1116. }
  1117. void obs_property_frame_rate_option_insert(obs_property_t *p, size_t idx,
  1118. const char *name,
  1119. const char *description)
  1120. {
  1121. struct frame_rate_data *data =
  1122. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1123. if (!data)
  1124. return;
  1125. struct frame_rate_option *opt = da_insert_new(data->extra_options, idx);
  1126. opt->name = bstrdup(name);
  1127. opt->description = bstrdup(description);
  1128. }
  1129. void obs_property_frame_rate_fps_range_insert(
  1130. obs_property_t *p, size_t idx, struct media_frames_per_second min,
  1131. struct media_frames_per_second max)
  1132. {
  1133. struct frame_rate_data *data =
  1134. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1135. if (!data)
  1136. return;
  1137. struct frame_rate_range *rng = da_insert_new(data->ranges, idx);
  1138. rng->min_time = min;
  1139. rng->max_time = max;
  1140. }
  1141. size_t obs_property_frame_rate_options_count(obs_property_t *p)
  1142. {
  1143. struct frame_rate_data *data =
  1144. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1145. return data ? data->extra_options.num : 0;
  1146. }
  1147. const char *obs_property_frame_rate_option_name(obs_property_t *p, size_t idx)
  1148. {
  1149. struct frame_rate_data *data =
  1150. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1151. return data && data->extra_options.num > idx
  1152. ? data->extra_options.array[idx].name
  1153. : NULL;
  1154. }
  1155. const char *obs_property_frame_rate_option_description(obs_property_t *p,
  1156. size_t idx)
  1157. {
  1158. struct frame_rate_data *data =
  1159. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1160. return data && data->extra_options.num > idx
  1161. ? data->extra_options.array[idx].description
  1162. : NULL;
  1163. }
  1164. size_t obs_property_frame_rate_fps_ranges_count(obs_property_t *p)
  1165. {
  1166. struct frame_rate_data *data =
  1167. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1168. return data ? data->ranges.num : 0;
  1169. }
  1170. struct media_frames_per_second
  1171. obs_property_frame_rate_fps_range_min(obs_property_t *p, size_t idx)
  1172. {
  1173. struct frame_rate_data *data =
  1174. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1175. return data && data->ranges.num > idx
  1176. ? data->ranges.array[idx].min_time
  1177. : (struct media_frames_per_second){0};
  1178. }
  1179. struct media_frames_per_second
  1180. obs_property_frame_rate_fps_range_max(obs_property_t *p, size_t idx)
  1181. {
  1182. struct frame_rate_data *data =
  1183. get_type_data(p, OBS_PROPERTY_FRAME_RATE);
  1184. return data && data->ranges.num > idx
  1185. ? data->ranges.array[idx].max_time
  1186. : (struct media_frames_per_second){0};
  1187. }
  1188. enum obs_text_type obs_proprety_text_type(obs_property_t *p)
  1189. {
  1190. return obs_property_text_type(p);
  1191. }
  1192. enum obs_group_type obs_property_group_type(obs_property_t *p)
  1193. {
  1194. struct group_data *data = get_type_data(p, OBS_PROPERTY_GROUP);
  1195. return data ? data->type : OBS_COMBO_INVALID;
  1196. }
  1197. obs_properties_t *obs_property_group_content(obs_property_t *p)
  1198. {
  1199. struct group_data *data = get_type_data(p, OBS_PROPERTY_GROUP);
  1200. return data ? data->content : NULL;
  1201. }