1
0

obs-properties.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  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. #pragma once
  15. #include "util/c99defs.h"
  16. #include "obs-data.h"
  17. #include "media-io/frame-rate.h"
  18. /**
  19. * @file
  20. * @brief libobs header for the properties system used in libobs
  21. *
  22. * @page properties Properties
  23. * @brief Platform and Toolkit independent settings implementation
  24. *
  25. * @section prop_overview_sec Overview
  26. *
  27. * libobs uses a property system which lets for example sources specify
  28. * settings that can be displayed to the user by the UI.
  29. *
  30. */
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34. /** Only update when the user presses OK or Apply */
  35. #define OBS_PROPERTIES_DEFER_UPDATE (1 << 0)
  36. enum obs_property_type {
  37. OBS_PROPERTY_INVALID,
  38. OBS_PROPERTY_BOOL,
  39. OBS_PROPERTY_INT,
  40. OBS_PROPERTY_FLOAT,
  41. OBS_PROPERTY_TEXT,
  42. OBS_PROPERTY_PATH,
  43. OBS_PROPERTY_LIST,
  44. OBS_PROPERTY_COLOR,
  45. OBS_PROPERTY_BUTTON,
  46. OBS_PROPERTY_FONT,
  47. OBS_PROPERTY_EDITABLE_LIST,
  48. OBS_PROPERTY_FRAME_RATE,
  49. OBS_PROPERTY_GROUP,
  50. };
  51. enum obs_combo_format {
  52. OBS_COMBO_FORMAT_INVALID,
  53. OBS_COMBO_FORMAT_INT,
  54. OBS_COMBO_FORMAT_FLOAT,
  55. OBS_COMBO_FORMAT_STRING,
  56. };
  57. enum obs_combo_type {
  58. OBS_COMBO_TYPE_INVALID,
  59. OBS_COMBO_TYPE_EDITABLE,
  60. OBS_COMBO_TYPE_LIST,
  61. };
  62. enum obs_editable_list_type {
  63. OBS_EDITABLE_LIST_TYPE_STRINGS,
  64. OBS_EDITABLE_LIST_TYPE_FILES,
  65. OBS_EDITABLE_LIST_TYPE_FILES_AND_URLS,
  66. };
  67. enum obs_path_type {
  68. OBS_PATH_FILE,
  69. OBS_PATH_FILE_SAVE,
  70. OBS_PATH_DIRECTORY,
  71. };
  72. enum obs_text_type {
  73. OBS_TEXT_DEFAULT,
  74. OBS_TEXT_PASSWORD,
  75. OBS_TEXT_MULTILINE,
  76. };
  77. enum obs_number_type {
  78. OBS_NUMBER_SCROLLER,
  79. OBS_NUMBER_SLIDER,
  80. };
  81. enum obs_group_type {
  82. OBS_COMBO_INVALID,
  83. OBS_GROUP_NORMAL,
  84. OBS_GROUP_CHECKABLE,
  85. };
  86. #define OBS_FONT_BOLD (1 << 0)
  87. #define OBS_FONT_ITALIC (1 << 1)
  88. #define OBS_FONT_UNDERLINE (1 << 2)
  89. #define OBS_FONT_STRIKEOUT (1 << 3)
  90. struct obs_properties;
  91. struct obs_property;
  92. typedef struct obs_properties obs_properties_t;
  93. typedef struct obs_property obs_property_t;
  94. /* ------------------------------------------------------------------------- */
  95. EXPORT obs_properties_t *obs_properties_create(void);
  96. EXPORT obs_properties_t *
  97. obs_properties_create_param(void *param, void (*destroy)(void *param));
  98. EXPORT void obs_properties_destroy(obs_properties_t *props);
  99. EXPORT void obs_properties_set_flags(obs_properties_t *props, uint32_t flags);
  100. EXPORT uint32_t obs_properties_get_flags(obs_properties_t *props);
  101. EXPORT void obs_properties_set_param(obs_properties_t *props, void *param,
  102. void (*destroy)(void *param));
  103. EXPORT void *obs_properties_get_param(obs_properties_t *props);
  104. EXPORT obs_property_t *obs_properties_first(obs_properties_t *props);
  105. EXPORT obs_property_t *obs_properties_get(obs_properties_t *props,
  106. const char *property);
  107. EXPORT obs_properties_t *obs_properties_get_parent(obs_properties_t *props);
  108. /** Remove a property from a properties list.
  109. *
  110. * Removes a property from a properties list. Only valid in either
  111. * get_properties or modified_callback(2). modified_callback(2) must return
  112. * true so that all UI properties are rebuilt and returning false is undefined
  113. * behavior.
  114. *
  115. * @param props Properties to remove from.
  116. * @param property Name of the property to remove.
  117. */
  118. EXPORT void obs_properties_remove_by_name(obs_properties_t *props,
  119. const char *property);
  120. /**
  121. * Applies settings to the properties by calling all the necessary
  122. * modification callbacks
  123. */
  124. EXPORT void obs_properties_apply_settings(obs_properties_t *props,
  125. obs_data_t *settings);
  126. /* ------------------------------------------------------------------------- */
  127. /**
  128. * Callback for when a button property is clicked. If the properties
  129. * need to be refreshed due to changes to the property layout, return true,
  130. * otherwise return false.
  131. */
  132. typedef bool (*obs_property_clicked_t)(obs_properties_t *props,
  133. obs_property_t *property, void *data);
  134. EXPORT obs_property_t *obs_properties_add_bool(obs_properties_t *props,
  135. const char *name,
  136. const char *description);
  137. EXPORT obs_property_t *obs_properties_add_int(obs_properties_t *props,
  138. const char *name,
  139. const char *description, int min,
  140. int max, int step);
  141. EXPORT obs_property_t *obs_properties_add_float(obs_properties_t *props,
  142. const char *name,
  143. const char *description,
  144. double min, double max,
  145. double step);
  146. EXPORT obs_property_t *obs_properties_add_int_slider(obs_properties_t *props,
  147. const char *name,
  148. const char *description,
  149. int min, int max,
  150. int step);
  151. EXPORT obs_property_t *obs_properties_add_float_slider(obs_properties_t *props,
  152. const char *name,
  153. const char *description,
  154. double min, double max,
  155. double step);
  156. EXPORT obs_property_t *obs_properties_add_text(obs_properties_t *props,
  157. const char *name,
  158. const char *description,
  159. enum obs_text_type type);
  160. /**
  161. * Adds a 'path' property. Can be a directory or a file.
  162. *
  163. * If target is a file path, the filters should be this format, separated by
  164. * double semi-colens, and extensions separated by space:
  165. * "Example types 1 and 2 (*.ex1 *.ex2);;Example type 3 (*.ex3)"
  166. *
  167. * @param props Properties object
  168. * @param name Settings name
  169. * @param description Description (display name) of the property
  170. * @param type Type of path (directory or file)
  171. * @param filter If type is a file path, then describes the file filter
  172. * that the user can browse. Items are separated via
  173. * double semi-colens. If multiple file types in a
  174. * filter, separate with space.
  175. */
  176. EXPORT obs_property_t *
  177. obs_properties_add_path(obs_properties_t *props, const char *name,
  178. const char *description, enum obs_path_type type,
  179. const char *filter, const char *default_path);
  180. EXPORT obs_property_t *obs_properties_add_list(obs_properties_t *props,
  181. const char *name,
  182. const char *description,
  183. enum obs_combo_type type,
  184. enum obs_combo_format format);
  185. EXPORT obs_property_t *obs_properties_add_color(obs_properties_t *props,
  186. const char *name,
  187. const char *description);
  188. EXPORT obs_property_t *
  189. obs_properties_add_button(obs_properties_t *props, const char *name,
  190. const char *text, obs_property_clicked_t callback);
  191. EXPORT obs_property_t *
  192. obs_properties_add_button2(obs_properties_t *props, const char *name,
  193. const char *text, obs_property_clicked_t callback,
  194. void *priv);
  195. /**
  196. * Adds a font selection property.
  197. *
  198. * A font is an obs_data sub-object which contains the following items:
  199. * face: face name string
  200. * style: style name string
  201. * size: size integer
  202. * flags: font flags integer (OBS_FONT_* defined above)
  203. */
  204. EXPORT obs_property_t *obs_properties_add_font(obs_properties_t *props,
  205. const char *name,
  206. const char *description);
  207. EXPORT obs_property_t *
  208. obs_properties_add_editable_list(obs_properties_t *props, const char *name,
  209. const char *description,
  210. enum obs_editable_list_type type,
  211. const char *filter, const char *default_path);
  212. EXPORT obs_property_t *obs_properties_add_frame_rate(obs_properties_t *props,
  213. const char *name,
  214. const char *description);
  215. EXPORT obs_property_t *obs_properties_add_group(obs_properties_t *props,
  216. const char *name,
  217. const char *description,
  218. enum obs_group_type type,
  219. obs_properties_t *group);
  220. /* ------------------------------------------------------------------------- */
  221. /**
  222. * Optional callback for when a property is modified. If the properties
  223. * need to be refreshed due to changes to the property layout, return true,
  224. * otherwise return false.
  225. */
  226. typedef bool (*obs_property_modified_t)(obs_properties_t *props,
  227. obs_property_t *property,
  228. obs_data_t *settings);
  229. typedef bool (*obs_property_modified2_t)(void *priv, obs_properties_t *props,
  230. obs_property_t *property,
  231. obs_data_t *settings);
  232. EXPORT void
  233. obs_property_set_modified_callback(obs_property_t *p,
  234. obs_property_modified_t modified);
  235. EXPORT void obs_property_set_modified_callback2(
  236. obs_property_t *p, obs_property_modified2_t modified, void *priv);
  237. EXPORT bool obs_property_modified(obs_property_t *p, obs_data_t *settings);
  238. EXPORT bool obs_property_button_clicked(obs_property_t *p, void *obj);
  239. EXPORT void obs_property_set_visible(obs_property_t *p, bool visible);
  240. EXPORT void obs_property_set_enabled(obs_property_t *p, bool enabled);
  241. EXPORT void obs_property_set_description(obs_property_t *p,
  242. const char *description);
  243. EXPORT void obs_property_set_long_description(obs_property_t *p,
  244. const char *long_description);
  245. EXPORT const char *obs_property_name(obs_property_t *p);
  246. EXPORT const char *obs_property_description(obs_property_t *p);
  247. EXPORT const char *obs_property_long_description(obs_property_t *p);
  248. EXPORT enum obs_property_type obs_property_get_type(obs_property_t *p);
  249. EXPORT bool obs_property_enabled(obs_property_t *p);
  250. EXPORT bool obs_property_visible(obs_property_t *p);
  251. EXPORT bool obs_property_next(obs_property_t **p);
  252. EXPORT int obs_property_int_min(obs_property_t *p);
  253. EXPORT int obs_property_int_max(obs_property_t *p);
  254. EXPORT int obs_property_int_step(obs_property_t *p);
  255. EXPORT enum obs_number_type obs_property_int_type(obs_property_t *p);
  256. EXPORT const char *obs_property_int_suffix(obs_property_t *p);
  257. EXPORT double obs_property_float_min(obs_property_t *p);
  258. EXPORT double obs_property_float_max(obs_property_t *p);
  259. EXPORT double obs_property_float_step(obs_property_t *p);
  260. EXPORT enum obs_number_type obs_property_float_type(obs_property_t *p);
  261. EXPORT const char *obs_property_float_suffix(obs_property_t *p);
  262. EXPORT enum obs_text_type obs_property_text_type(obs_property_t *p);
  263. EXPORT enum obs_text_type obs_property_text_monospace(obs_property_t *p);
  264. EXPORT enum obs_path_type obs_property_path_type(obs_property_t *p);
  265. EXPORT const char *obs_property_path_filter(obs_property_t *p);
  266. EXPORT const char *obs_property_path_default_path(obs_property_t *p);
  267. EXPORT enum obs_combo_type obs_property_list_type(obs_property_t *p);
  268. EXPORT enum obs_combo_format obs_property_list_format(obs_property_t *p);
  269. EXPORT void obs_property_int_set_limits(obs_property_t *p, int min, int max,
  270. int step);
  271. EXPORT void obs_property_float_set_limits(obs_property_t *p, double min,
  272. double max, double step);
  273. EXPORT void obs_property_int_set_suffix(obs_property_t *p, const char *suffix);
  274. EXPORT void obs_property_float_set_suffix(obs_property_t *p,
  275. const char *suffix);
  276. EXPORT void obs_property_text_set_monospace(obs_property_t *p, bool monospace);
  277. EXPORT void obs_property_list_clear(obs_property_t *p);
  278. EXPORT size_t obs_property_list_add_string(obs_property_t *p, const char *name,
  279. const char *val);
  280. EXPORT size_t obs_property_list_add_int(obs_property_t *p, const char *name,
  281. long long val);
  282. EXPORT size_t obs_property_list_add_float(obs_property_t *p, const char *name,
  283. double val);
  284. EXPORT void obs_property_list_insert_string(obs_property_t *p, size_t idx,
  285. const char *name, const char *val);
  286. EXPORT void obs_property_list_insert_int(obs_property_t *p, size_t idx,
  287. const char *name, long long val);
  288. EXPORT void obs_property_list_insert_float(obs_property_t *p, size_t idx,
  289. const char *name, double val);
  290. EXPORT void obs_property_list_item_disable(obs_property_t *p, size_t idx,
  291. bool disabled);
  292. EXPORT bool obs_property_list_item_disabled(obs_property_t *p, size_t idx);
  293. EXPORT void obs_property_list_item_remove(obs_property_t *p, size_t idx);
  294. EXPORT size_t obs_property_list_item_count(obs_property_t *p);
  295. EXPORT const char *obs_property_list_item_name(obs_property_t *p, size_t idx);
  296. EXPORT const char *obs_property_list_item_string(obs_property_t *p, size_t idx);
  297. EXPORT long long obs_property_list_item_int(obs_property_t *p, size_t idx);
  298. EXPORT double obs_property_list_item_float(obs_property_t *p, size_t idx);
  299. EXPORT enum obs_editable_list_type
  300. obs_property_editable_list_type(obs_property_t *p);
  301. EXPORT const char *obs_property_editable_list_filter(obs_property_t *p);
  302. EXPORT const char *obs_property_editable_list_default_path(obs_property_t *p);
  303. EXPORT void obs_property_frame_rate_clear(obs_property_t *p);
  304. EXPORT void obs_property_frame_rate_options_clear(obs_property_t *p);
  305. EXPORT void obs_property_frame_rate_fps_ranges_clear(obs_property_t *p);
  306. EXPORT size_t obs_property_frame_rate_option_add(obs_property_t *p,
  307. const char *name,
  308. const char *description);
  309. EXPORT size_t obs_property_frame_rate_fps_range_add(
  310. obs_property_t *p, struct media_frames_per_second min,
  311. struct media_frames_per_second max);
  312. EXPORT void obs_property_frame_rate_option_insert(obs_property_t *p, size_t idx,
  313. const char *name,
  314. const char *description);
  315. EXPORT void
  316. obs_property_frame_rate_fps_range_insert(obs_property_t *p, size_t idx,
  317. struct media_frames_per_second min,
  318. struct media_frames_per_second max);
  319. EXPORT size_t obs_property_frame_rate_options_count(obs_property_t *p);
  320. EXPORT const char *obs_property_frame_rate_option_name(obs_property_t *p,
  321. size_t idx);
  322. EXPORT const char *obs_property_frame_rate_option_description(obs_property_t *p,
  323. size_t idx);
  324. EXPORT size_t obs_property_frame_rate_fps_ranges_count(obs_property_t *p);
  325. EXPORT struct media_frames_per_second
  326. obs_property_frame_rate_fps_range_min(obs_property_t *p, size_t idx);
  327. EXPORT struct media_frames_per_second
  328. obs_property_frame_rate_fps_range_max(obs_property_t *p, size_t idx);
  329. EXPORT enum obs_group_type obs_property_group_type(obs_property_t *p);
  330. EXPORT obs_properties_t *obs_property_group_content(obs_property_t *p);
  331. #ifndef SWIG
  332. OBS_DEPRECATED
  333. EXPORT enum obs_text_type obs_proprety_text_type(obs_property_t *p);
  334. #endif
  335. #ifdef __cplusplus
  336. }
  337. #endif