obs-data.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395
  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 "media-io/frame-rate.h"
  17. #ifdef __cplusplus
  18. extern "C" {
  19. #endif
  20. struct vec2;
  21. struct vec3;
  22. struct vec4;
  23. struct quat;
  24. /*
  25. * OBS data settings storage
  26. *
  27. * This is used for retrieving or setting the data settings for things such
  28. * as sources, encoders, etc. This is designed for JSON serialization.
  29. */
  30. struct obs_data;
  31. struct obs_data_item;
  32. struct obs_data_array;
  33. typedef struct obs_data obs_data_t;
  34. typedef struct obs_data_item obs_data_item_t;
  35. typedef struct obs_data_array obs_data_array_t;
  36. enum obs_data_type {
  37. OBS_DATA_NULL,
  38. OBS_DATA_STRING,
  39. OBS_DATA_NUMBER,
  40. OBS_DATA_BOOLEAN,
  41. OBS_DATA_OBJECT,
  42. OBS_DATA_ARRAY
  43. };
  44. enum obs_data_number_type {
  45. OBS_DATA_NUM_INVALID,
  46. OBS_DATA_NUM_INT,
  47. OBS_DATA_NUM_DOUBLE
  48. };
  49. /* ------------------------------------------------------------------------- */
  50. /* Main usage functions */
  51. EXPORT obs_data_t *obs_data_create();
  52. EXPORT obs_data_t *obs_data_create_from_json(const char *json_string);
  53. EXPORT obs_data_t *obs_data_create_from_json_file(const char *json_file);
  54. EXPORT obs_data_t *obs_data_create_from_json_file_safe(const char *json_file,
  55. const char *backup_ext);
  56. EXPORT void obs_data_addref(obs_data_t *data);
  57. EXPORT void obs_data_release(obs_data_t *data);
  58. EXPORT const char *obs_data_get_json(obs_data_t *data);
  59. EXPORT const char *obs_data_get_last_json(obs_data_t *data);
  60. EXPORT bool obs_data_save_json(obs_data_t *data, const char *file);
  61. EXPORT bool obs_data_save_json_safe(obs_data_t *data, const char *file,
  62. const char *temp_ext,
  63. const char *backup_ext);
  64. EXPORT void obs_data_apply(obs_data_t *target, obs_data_t *apply_data);
  65. EXPORT void obs_data_erase(obs_data_t *data, const char *name);
  66. EXPORT void obs_data_clear(obs_data_t *data);
  67. /* Set functions */
  68. EXPORT void obs_data_set_string(obs_data_t *data, const char *name,
  69. const char *val);
  70. EXPORT void obs_data_set_int(obs_data_t *data, const char *name, long long val);
  71. EXPORT void obs_data_set_double(obs_data_t *data, const char *name, double val);
  72. EXPORT void obs_data_set_bool(obs_data_t *data, const char *name, bool val);
  73. EXPORT void obs_data_set_obj(obs_data_t *data, const char *name,
  74. obs_data_t *obj);
  75. EXPORT void obs_data_set_array(obs_data_t *data, const char *name,
  76. obs_data_array_t *array);
  77. /*
  78. * Creates an obs_data_t * filled with all default values.
  79. */
  80. EXPORT obs_data_t *obs_data_get_defaults(obs_data_t *data);
  81. /*
  82. * Default value functions.
  83. */
  84. EXPORT void obs_data_set_default_string(obs_data_t *data, const char *name,
  85. const char *val);
  86. EXPORT void obs_data_set_default_int(obs_data_t *data, const char *name,
  87. long long val);
  88. EXPORT void obs_data_set_default_double(obs_data_t *data, const char *name,
  89. double val);
  90. EXPORT void obs_data_set_default_bool(obs_data_t *data, const char *name,
  91. bool val);
  92. EXPORT void obs_data_set_default_obj(obs_data_t *data, const char *name,
  93. obs_data_t *obj);
  94. EXPORT void obs_data_set_default_array(obs_data_t *data, const char *name,
  95. obs_data_array_t *arr);
  96. /*
  97. * Application overrides
  98. * Use these to communicate the actual values of settings in case the user
  99. * settings aren't appropriate
  100. */
  101. EXPORT void obs_data_set_autoselect_string(obs_data_t *data, const char *name,
  102. const char *val);
  103. EXPORT void obs_data_set_autoselect_int(obs_data_t *data, const char *name,
  104. long long val);
  105. EXPORT void obs_data_set_autoselect_double(obs_data_t *data, const char *name,
  106. double val);
  107. EXPORT void obs_data_set_autoselect_bool(obs_data_t *data, const char *name,
  108. bool val);
  109. EXPORT void obs_data_set_autoselect_obj(obs_data_t *data, const char *name,
  110. obs_data_t *obj);
  111. /*
  112. * Get functions
  113. */
  114. EXPORT const char *obs_data_get_string(obs_data_t *data, const char *name);
  115. EXPORT long long obs_data_get_int(obs_data_t *data, const char *name);
  116. EXPORT double obs_data_get_double(obs_data_t *data, const char *name);
  117. EXPORT bool obs_data_get_bool(obs_data_t *data, const char *name);
  118. EXPORT obs_data_t *obs_data_get_obj(obs_data_t *data, const char *name);
  119. EXPORT obs_data_array_t *obs_data_get_array(obs_data_t *data, const char *name);
  120. EXPORT const char *obs_data_get_default_string(obs_data_t *data,
  121. const char *name);
  122. EXPORT long long obs_data_get_default_int(obs_data_t *data, const char *name);
  123. EXPORT double obs_data_get_default_double(obs_data_t *data, const char *name);
  124. EXPORT bool obs_data_get_default_bool(obs_data_t *data, const char *name);
  125. EXPORT obs_data_t *obs_data_get_default_obj(obs_data_t *data, const char *name);
  126. EXPORT obs_data_array_t *obs_data_get_default_array(obs_data_t *data,
  127. const char *name);
  128. EXPORT const char *obs_data_get_autoselect_string(obs_data_t *data,
  129. const char *name);
  130. EXPORT long long obs_data_get_autoselect_int(obs_data_t *data,
  131. const char *name);
  132. EXPORT double obs_data_get_autoselect_double(obs_data_t *data,
  133. const char *name);
  134. EXPORT bool obs_data_get_autoselect_bool(obs_data_t *data, const char *name);
  135. EXPORT obs_data_t *obs_data_get_autoselect_obj(obs_data_t *data,
  136. const char *name);
  137. EXPORT obs_data_array_t *obs_data_get_autoselect_array(obs_data_t *data,
  138. const char *name);
  139. /* Array functions */
  140. EXPORT obs_data_array_t *obs_data_array_create();
  141. EXPORT void obs_data_array_addref(obs_data_array_t *array);
  142. EXPORT void obs_data_array_release(obs_data_array_t *array);
  143. EXPORT size_t obs_data_array_count(obs_data_array_t *array);
  144. EXPORT obs_data_t *obs_data_array_item(obs_data_array_t *array, size_t idx);
  145. EXPORT size_t obs_data_array_push_back(obs_data_array_t *array,
  146. obs_data_t *obj);
  147. EXPORT void obs_data_array_insert(obs_data_array_t *array, size_t idx,
  148. obs_data_t *obj);
  149. EXPORT void obs_data_array_push_back_array(obs_data_array_t *array,
  150. obs_data_array_t *array2);
  151. EXPORT void obs_data_array_erase(obs_data_array_t *array, size_t idx);
  152. EXPORT void obs_data_array_enum(obs_data_array_t *array,
  153. void (*cb)(obs_data_t *data, void *param),
  154. void *param);
  155. /* ------------------------------------------------------------------------- */
  156. /* Item status inspection */
  157. EXPORT bool obs_data_has_user_value(obs_data_t *data, const char *name);
  158. EXPORT bool obs_data_has_default_value(obs_data_t *data, const char *name);
  159. EXPORT bool obs_data_has_autoselect_value(obs_data_t *data, const char *name);
  160. EXPORT bool obs_data_item_has_user_value(obs_data_item_t *data);
  161. EXPORT bool obs_data_item_has_default_value(obs_data_item_t *data);
  162. EXPORT bool obs_data_item_has_autoselect_value(obs_data_item_t *data);
  163. /* ------------------------------------------------------------------------- */
  164. /* Clearing data values */
  165. EXPORT void obs_data_unset_user_value(obs_data_t *data, const char *name);
  166. EXPORT void obs_data_unset_default_value(obs_data_t *data, const char *name);
  167. EXPORT void obs_data_unset_autoselect_value(obs_data_t *data, const char *name);
  168. EXPORT void obs_data_item_unset_user_value(obs_data_item_t *data);
  169. EXPORT void obs_data_item_unset_default_value(obs_data_item_t *data);
  170. EXPORT void obs_data_item_unset_autoselect_value(obs_data_item_t *data);
  171. /* ------------------------------------------------------------------------- */
  172. /* Item iteration */
  173. EXPORT obs_data_item_t *obs_data_first(obs_data_t *data);
  174. EXPORT obs_data_item_t *obs_data_item_byname(obs_data_t *data,
  175. const char *name);
  176. EXPORT bool obs_data_item_next(obs_data_item_t **item);
  177. EXPORT void obs_data_item_release(obs_data_item_t **item);
  178. EXPORT void obs_data_item_remove(obs_data_item_t **item);
  179. /* Gets Item type */
  180. EXPORT enum obs_data_type obs_data_item_gettype(obs_data_item_t *item);
  181. EXPORT enum obs_data_number_type obs_data_item_numtype(obs_data_item_t *item);
  182. EXPORT const char *obs_data_item_get_name(obs_data_item_t *item);
  183. /* Item set functions */
  184. EXPORT void obs_data_item_set_string(obs_data_item_t **item, const char *val);
  185. EXPORT void obs_data_item_set_int(obs_data_item_t **item, long long val);
  186. EXPORT void obs_data_item_set_double(obs_data_item_t **item, double val);
  187. EXPORT void obs_data_item_set_bool(obs_data_item_t **item, bool val);
  188. EXPORT void obs_data_item_set_obj(obs_data_item_t **item, obs_data_t *val);
  189. EXPORT void obs_data_item_set_array(obs_data_item_t **item,
  190. obs_data_array_t *val);
  191. EXPORT void obs_data_item_set_default_string(obs_data_item_t **item,
  192. const char *val);
  193. EXPORT void obs_data_item_set_default_int(obs_data_item_t **item,
  194. long long val);
  195. EXPORT void obs_data_item_set_default_double(obs_data_item_t **item,
  196. double val);
  197. EXPORT void obs_data_item_set_default_bool(obs_data_item_t **item, bool val);
  198. EXPORT void obs_data_item_set_default_obj(obs_data_item_t **item,
  199. obs_data_t *val);
  200. EXPORT void obs_data_item_set_default_array(obs_data_item_t **item,
  201. obs_data_array_t *val);
  202. EXPORT void obs_data_item_set_autoselect_string(obs_data_item_t **item,
  203. const char *val);
  204. EXPORT void obs_data_item_set_autoselect_int(obs_data_item_t **item,
  205. long long val);
  206. EXPORT void obs_data_item_set_autoselect_double(obs_data_item_t **item,
  207. double val);
  208. EXPORT void obs_data_item_set_autoselect_bool(obs_data_item_t **item, bool val);
  209. EXPORT void obs_data_item_set_autoselect_obj(obs_data_item_t **item,
  210. obs_data_t *val);
  211. EXPORT void obs_data_item_set_autoselect_array(obs_data_item_t **item,
  212. obs_data_array_t *val);
  213. /* Item get functions */
  214. EXPORT const char *obs_data_item_get_string(obs_data_item_t *item);
  215. EXPORT long long obs_data_item_get_int(obs_data_item_t *item);
  216. EXPORT double obs_data_item_get_double(obs_data_item_t *item);
  217. EXPORT bool obs_data_item_get_bool(obs_data_item_t *item);
  218. EXPORT obs_data_t *obs_data_item_get_obj(obs_data_item_t *item);
  219. EXPORT obs_data_array_t *obs_data_item_get_array(obs_data_item_t *item);
  220. EXPORT const char *obs_data_item_get_default_string(obs_data_item_t *item);
  221. EXPORT long long obs_data_item_get_default_int(obs_data_item_t *item);
  222. EXPORT double obs_data_item_get_default_double(obs_data_item_t *item);
  223. EXPORT bool obs_data_item_get_default_bool(obs_data_item_t *item);
  224. EXPORT obs_data_t *obs_data_item_get_default_obj(obs_data_item_t *item);
  225. EXPORT obs_data_array_t *obs_data_item_get_default_array(obs_data_item_t *item);
  226. EXPORT const char *obs_data_item_get_autoselect_string(obs_data_item_t *item);
  227. EXPORT long long obs_data_item_get_autoselect_int(obs_data_item_t *item);
  228. EXPORT double obs_data_item_get_autoselect_double(obs_data_item_t *item);
  229. EXPORT bool obs_data_item_get_autoselect_bool(obs_data_item_t *item);
  230. EXPORT obs_data_t *obs_data_item_get_autoselect_obj(obs_data_item_t *item);
  231. EXPORT obs_data_array_t *
  232. obs_data_item_get_autoselect_array(obs_data_item_t *item);
  233. /* ------------------------------------------------------------------------- */
  234. /* Helper functions for certain structures */
  235. EXPORT void obs_data_set_vec2(obs_data_t *data, const char *name,
  236. const struct vec2 *val);
  237. EXPORT void obs_data_set_vec3(obs_data_t *data, const char *name,
  238. const struct vec3 *val);
  239. EXPORT void obs_data_set_vec4(obs_data_t *data, const char *name,
  240. const struct vec4 *val);
  241. EXPORT void obs_data_set_quat(obs_data_t *data, const char *name,
  242. const struct quat *val);
  243. EXPORT void obs_data_set_default_vec2(obs_data_t *data, const char *name,
  244. const struct vec2 *val);
  245. EXPORT void obs_data_set_default_vec3(obs_data_t *data, const char *name,
  246. const struct vec3 *val);
  247. EXPORT void obs_data_set_default_vec4(obs_data_t *data, const char *name,
  248. const struct vec4 *val);
  249. EXPORT void obs_data_set_default_quat(obs_data_t *data, const char *name,
  250. const struct quat *val);
  251. EXPORT void obs_data_set_autoselect_vec2(obs_data_t *data, const char *name,
  252. const struct vec2 *val);
  253. EXPORT void obs_data_set_autoselect_vec3(obs_data_t *data, const char *name,
  254. const struct vec3 *val);
  255. EXPORT void obs_data_set_autoselect_vec4(obs_data_t *data, const char *name,
  256. const struct vec4 *val);
  257. EXPORT void obs_data_set_autoselect_quat(obs_data_t *data, const char *name,
  258. const struct quat *val);
  259. EXPORT void obs_data_get_vec2(obs_data_t *data, const char *name,
  260. struct vec2 *val);
  261. EXPORT void obs_data_get_vec3(obs_data_t *data, const char *name,
  262. struct vec3 *val);
  263. EXPORT void obs_data_get_vec4(obs_data_t *data, const char *name,
  264. struct vec4 *val);
  265. EXPORT void obs_data_get_quat(obs_data_t *data, const char *name,
  266. struct quat *val);
  267. EXPORT void obs_data_get_default_vec2(obs_data_t *data, const char *name,
  268. struct vec2 *val);
  269. EXPORT void obs_data_get_default_vec3(obs_data_t *data, const char *name,
  270. struct vec3 *val);
  271. EXPORT void obs_data_get_default_vec4(obs_data_t *data, const char *name,
  272. struct vec4 *val);
  273. EXPORT void obs_data_get_default_quat(obs_data_t *data, const char *name,
  274. struct quat *val);
  275. EXPORT void obs_data_get_autoselect_vec2(obs_data_t *data, const char *name,
  276. struct vec2 *val);
  277. EXPORT void obs_data_get_autoselect_vec3(obs_data_t *data, const char *name,
  278. struct vec3 *val);
  279. EXPORT void obs_data_get_autoselect_vec4(obs_data_t *data, const char *name,
  280. struct vec4 *val);
  281. EXPORT void obs_data_get_autoselect_quat(obs_data_t *data, const char *name,
  282. struct quat *val);
  283. /* ------------------------------------------------------------------------- */
  284. /* Helper functions for media_frames_per_second/OBS_PROPERTY_FRAME_RATE */
  285. EXPORT void obs_data_set_frames_per_second(obs_data_t *data, const char *name,
  286. struct media_frames_per_second fps,
  287. const char *option);
  288. EXPORT void
  289. obs_data_set_default_frames_per_second(obs_data_t *data, const char *name,
  290. struct media_frames_per_second fps,
  291. const char *option);
  292. EXPORT void
  293. obs_data_set_autoselect_frames_per_second(obs_data_t *data, const char *name,
  294. struct media_frames_per_second fps,
  295. const char *option);
  296. EXPORT bool obs_data_get_frames_per_second(obs_data_t *data, const char *name,
  297. struct media_frames_per_second *fps,
  298. const char **option);
  299. EXPORT bool
  300. obs_data_get_default_frames_per_second(obs_data_t *data, const char *name,
  301. struct media_frames_per_second *fps,
  302. const char **option);
  303. EXPORT bool
  304. obs_data_get_autoselect_frames_per_second(obs_data_t *data, const char *name,
  305. struct media_frames_per_second *fps,
  306. const char **option);
  307. EXPORT void
  308. obs_data_item_set_frames_per_second(obs_data_item_t **item,
  309. struct media_frames_per_second fps,
  310. const char *option);
  311. EXPORT void
  312. obs_data_item_set_default_frames_per_second(obs_data_item_t **item,
  313. struct media_frames_per_second fps,
  314. const char *option);
  315. EXPORT void obs_data_item_set_autoselect_frames_per_second(
  316. obs_data_item_t **item, struct media_frames_per_second fps,
  317. const char *option);
  318. EXPORT bool
  319. obs_data_item_get_frames_per_second(obs_data_item_t *item,
  320. struct media_frames_per_second *fps,
  321. const char **option);
  322. EXPORT bool
  323. obs_data_item_get_default_frames_per_second(obs_data_item_t *item,
  324. struct media_frames_per_second *fps,
  325. const char **option);
  326. EXPORT bool obs_data_item_get_autoselect_frames_per_second(
  327. obs_data_item_t *item, struct media_frames_per_second *fps,
  328. const char **option);
  329. /* ------------------------------------------------------------------------- */
  330. /* OBS-specific functions */
  331. static inline obs_data_t *obs_data_newref(obs_data_t *data)
  332. {
  333. if (data)
  334. obs_data_addref(data);
  335. else
  336. data = obs_data_create();
  337. return data;
  338. }
  339. #ifdef __cplusplus
  340. }
  341. #endif