obs-module.c 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846
  1. /******************************************************************************
  2. Copyright (C) 2013-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/platform.h"
  15. #include "util/dstr.h"
  16. #include "obs-defs.h"
  17. #include "obs-internal.h"
  18. #include "obs-module.h"
  19. extern const char *get_module_extension(void);
  20. static inline int req_func_not_found(const char *name, const char *path)
  21. {
  22. blog(LOG_DEBUG,
  23. "Required module function '%s' in module '%s' not "
  24. "found, loading of module failed",
  25. name, path);
  26. return MODULE_MISSING_EXPORTS;
  27. }
  28. static int load_module_exports(struct obs_module *mod, const char *path)
  29. {
  30. mod->load = os_dlsym(mod->module, "obs_module_load");
  31. if (!mod->load)
  32. return req_func_not_found("obs_module_load", path);
  33. mod->set_pointer = os_dlsym(mod->module, "obs_module_set_pointer");
  34. if (!mod->set_pointer)
  35. return req_func_not_found("obs_module_set_pointer", path);
  36. mod->ver = os_dlsym(mod->module, "obs_module_ver");
  37. if (!mod->ver)
  38. return req_func_not_found("obs_module_ver", path);
  39. /* optional exports */
  40. mod->unload = os_dlsym(mod->module, "obs_module_unload");
  41. mod->post_load = os_dlsym(mod->module, "obs_module_post_load");
  42. mod->set_locale = os_dlsym(mod->module, "obs_module_set_locale");
  43. mod->free_locale = os_dlsym(mod->module, "obs_module_free_locale");
  44. mod->name = os_dlsym(mod->module, "obs_module_name");
  45. mod->description = os_dlsym(mod->module, "obs_module_description");
  46. mod->author = os_dlsym(mod->module, "obs_module_author");
  47. mod->get_string = os_dlsym(mod->module, "obs_module_get_string");
  48. return MODULE_SUCCESS;
  49. }
  50. bool obs_module_get_locale_string(const obs_module_t *mod,
  51. const char *lookup_string,
  52. const char **translated_string)
  53. {
  54. if (mod->get_string) {
  55. return mod->get_string(lookup_string, translated_string);
  56. }
  57. return false;
  58. }
  59. const char *obs_module_get_locale_text(const obs_module_t *mod,
  60. const char *text)
  61. {
  62. const char *str = text;
  63. obs_module_get_locale_string(mod, text, &str);
  64. return str;
  65. }
  66. static inline char *get_module_name(const char *file)
  67. {
  68. static size_t ext_len = 0;
  69. struct dstr name = {0};
  70. if (ext_len == 0) {
  71. const char *ext = get_module_extension();
  72. ext_len = strlen(ext);
  73. }
  74. dstr_copy(&name, file);
  75. dstr_resize(&name, name.len - ext_len);
  76. return name.array;
  77. }
  78. #ifdef _WIN32
  79. extern void reset_win32_symbol_paths(void);
  80. #endif
  81. int obs_open_module(obs_module_t **module, const char *path,
  82. const char *data_path)
  83. {
  84. struct obs_module mod = {0};
  85. int errorcode;
  86. if (!module || !path || !obs)
  87. return MODULE_ERROR;
  88. #ifdef __APPLE__
  89. /* HACK: Do not load obsolete obs-browser build on macOS; the
  90. * obs-browser plugin used to live in the Application Support
  91. * directory. */
  92. if (astrstri(path, "Library/Application Support") != NULL &&
  93. astrstri(path, "obs-browser") != NULL) {
  94. blog(LOG_WARNING, "Ignoring old obs-browser.so version");
  95. return MODULE_ERROR;
  96. }
  97. #endif
  98. blog(LOG_DEBUG, "---------------------------------");
  99. mod.module = os_dlopen(path);
  100. if (!mod.module) {
  101. blog(LOG_WARNING, "Module '%s' not loaded", path);
  102. return MODULE_FILE_NOT_FOUND;
  103. }
  104. errorcode = load_module_exports(&mod, path);
  105. if (errorcode != MODULE_SUCCESS)
  106. return errorcode;
  107. mod.bin_path = bstrdup(path);
  108. mod.file = strrchr(mod.bin_path, '/');
  109. mod.file = (!mod.file) ? mod.bin_path : (mod.file + 1);
  110. mod.mod_name = get_module_name(mod.file);
  111. mod.data_path = bstrdup(data_path);
  112. mod.next = obs->first_module;
  113. if (mod.file) {
  114. blog(LOG_DEBUG, "Loading module: %s", mod.file);
  115. }
  116. *module = bmemdup(&mod, sizeof(mod));
  117. obs->first_module = (*module);
  118. mod.set_pointer(*module);
  119. if (mod.set_locale)
  120. mod.set_locale(obs->locale);
  121. return MODULE_SUCCESS;
  122. }
  123. bool obs_init_module(obs_module_t *module)
  124. {
  125. if (!module || !obs)
  126. return false;
  127. if (module->loaded)
  128. return true;
  129. const char *profile_name =
  130. profile_store_name(obs_get_profiler_name_store(),
  131. "obs_init_module(%s)", module->file);
  132. profile_start(profile_name);
  133. module->loaded = module->load();
  134. if (!module->loaded)
  135. blog(LOG_WARNING, "Failed to initialize module '%s'",
  136. module->file);
  137. profile_end(profile_name);
  138. return module->loaded;
  139. }
  140. void obs_log_loaded_modules(void)
  141. {
  142. blog(LOG_INFO, " Loaded Modules:");
  143. for (obs_module_t *mod = obs->first_module; !!mod; mod = mod->next)
  144. blog(LOG_INFO, " %s", mod->file);
  145. }
  146. const char *obs_get_module_file_name(obs_module_t *module)
  147. {
  148. return module ? module->file : NULL;
  149. }
  150. const char *obs_get_module_name(obs_module_t *module)
  151. {
  152. return (module && module->name) ? module->name() : NULL;
  153. }
  154. const char *obs_get_module_author(obs_module_t *module)
  155. {
  156. return (module && module->author) ? module->author() : NULL;
  157. }
  158. const char *obs_get_module_description(obs_module_t *module)
  159. {
  160. return (module && module->description) ? module->description() : NULL;
  161. }
  162. const char *obs_get_module_binary_path(obs_module_t *module)
  163. {
  164. return module ? module->bin_path : NULL;
  165. }
  166. const char *obs_get_module_data_path(obs_module_t *module)
  167. {
  168. return module ? module->data_path : NULL;
  169. }
  170. obs_module_t *obs_get_module(const char *name)
  171. {
  172. obs_module_t *module = obs->first_module;
  173. while (module) {
  174. if (strcmp(module->mod_name, name) == 0) {
  175. return module;
  176. }
  177. module = module->next;
  178. }
  179. return NULL;
  180. }
  181. void *obs_get_module_lib(obs_module_t *module)
  182. {
  183. return module ? module->module : NULL;
  184. }
  185. char *obs_find_module_file(obs_module_t *module, const char *file)
  186. {
  187. struct dstr output = {0};
  188. if (!file)
  189. file = "";
  190. if (!module)
  191. return NULL;
  192. dstr_copy(&output, module->data_path);
  193. if (!dstr_is_empty(&output) && dstr_end(&output) != '/' && *file)
  194. dstr_cat_ch(&output, '/');
  195. dstr_cat(&output, file);
  196. if (!os_file_exists(output.array))
  197. dstr_free(&output);
  198. return output.array;
  199. }
  200. char *obs_module_get_config_path(obs_module_t *module, const char *file)
  201. {
  202. struct dstr output = {0};
  203. dstr_copy(&output, obs->module_config_path);
  204. if (!dstr_is_empty(&output) && dstr_end(&output) != '/')
  205. dstr_cat_ch(&output, '/');
  206. dstr_cat(&output, module->mod_name);
  207. dstr_cat_ch(&output, '/');
  208. dstr_cat(&output, file);
  209. return output.array;
  210. }
  211. void obs_add_module_path(const char *bin, const char *data)
  212. {
  213. struct obs_module_path omp;
  214. if (!obs || !bin || !data)
  215. return;
  216. omp.bin = bstrdup(bin);
  217. omp.data = bstrdup(data);
  218. da_push_back(obs->module_paths, &omp);
  219. }
  220. static void load_all_callback(void *param, const struct obs_module_info *info)
  221. {
  222. obs_module_t *module;
  223. if (!os_is_obs_plugin(info->bin_path)) {
  224. blog(LOG_WARNING, "Skipping module '%s', not an OBS plugin",
  225. info->bin_path);
  226. return;
  227. }
  228. int code = obs_open_module(&module, info->bin_path, info->data_path);
  229. if (code != MODULE_SUCCESS) {
  230. blog(LOG_DEBUG, "Failed to load module file '%s': %d",
  231. info->bin_path, code);
  232. return;
  233. }
  234. obs_init_module(module);
  235. UNUSED_PARAMETER(param);
  236. }
  237. static const char *obs_load_all_modules_name = "obs_load_all_modules";
  238. #ifdef _WIN32
  239. static const char *reset_win32_symbol_paths_name = "reset_win32_symbol_paths";
  240. #endif
  241. void obs_load_all_modules(void)
  242. {
  243. profile_start(obs_load_all_modules_name);
  244. obs_find_modules(load_all_callback, NULL);
  245. #ifdef _WIN32
  246. profile_start(reset_win32_symbol_paths_name);
  247. reset_win32_symbol_paths();
  248. profile_end(reset_win32_symbol_paths_name);
  249. #endif
  250. profile_end(obs_load_all_modules_name);
  251. }
  252. void obs_post_load_modules(void)
  253. {
  254. for (obs_module_t *mod = obs->first_module; !!mod; mod = mod->next)
  255. if (mod->post_load)
  256. mod->post_load();
  257. }
  258. static inline void make_data_dir(struct dstr *parsed_data_dir,
  259. const char *data_dir, const char *name)
  260. {
  261. dstr_copy(parsed_data_dir, data_dir);
  262. dstr_replace(parsed_data_dir, "%module%", name);
  263. if (dstr_end(parsed_data_dir) == '/')
  264. dstr_resize(parsed_data_dir, parsed_data_dir->len - 1);
  265. }
  266. static char *make_data_directory(const char *module_name, const char *data_dir)
  267. {
  268. struct dstr parsed_data_dir = {0};
  269. bool found = false;
  270. make_data_dir(&parsed_data_dir, data_dir, module_name);
  271. found = os_file_exists(parsed_data_dir.array);
  272. if (!found && astrcmpi_n(module_name, "lib", 3) == 0)
  273. make_data_dir(&parsed_data_dir, data_dir, module_name + 3);
  274. return parsed_data_dir.array;
  275. }
  276. static bool parse_binary_from_directory(struct dstr *parsed_bin_path,
  277. const char *bin_path, const char *file)
  278. {
  279. struct dstr directory = {0};
  280. bool found = true;
  281. dstr_copy(&directory, bin_path);
  282. dstr_replace(&directory, "%module%", file);
  283. if (dstr_end(&directory) != '/')
  284. dstr_cat_ch(&directory, '/');
  285. dstr_copy_dstr(parsed_bin_path, &directory);
  286. dstr_cat(parsed_bin_path, file);
  287. dstr_cat(parsed_bin_path, get_module_extension());
  288. if (!os_file_exists(parsed_bin_path->array)) {
  289. /* if the file doesn't exist, check with 'lib' prefix */
  290. dstr_copy_dstr(parsed_bin_path, &directory);
  291. dstr_cat(parsed_bin_path, "lib");
  292. dstr_cat(parsed_bin_path, file);
  293. dstr_cat(parsed_bin_path, get_module_extension());
  294. /* if neither exist, don't include this as a library */
  295. if (!os_file_exists(parsed_bin_path->array)) {
  296. dstr_free(parsed_bin_path);
  297. found = false;
  298. }
  299. }
  300. dstr_free(&directory);
  301. return found;
  302. }
  303. static void process_found_module(struct obs_module_path *omp, const char *path,
  304. bool directory,
  305. obs_find_module_callback_t callback,
  306. void *param)
  307. {
  308. struct obs_module_info info;
  309. struct dstr name = {0};
  310. struct dstr parsed_bin_path = {0};
  311. const char *file;
  312. char *parsed_data_dir;
  313. bool bin_found = true;
  314. file = strrchr(path, '/');
  315. file = file ? (file + 1) : path;
  316. if (strcmp(file, ".") == 0 || strcmp(file, "..") == 0)
  317. return;
  318. dstr_copy(&name, file);
  319. if (!directory) {
  320. char *ext = strrchr(name.array, '.');
  321. if (ext)
  322. dstr_resize(&name, ext - name.array);
  323. dstr_copy(&parsed_bin_path, path);
  324. } else {
  325. bin_found = parse_binary_from_directory(&parsed_bin_path,
  326. omp->bin, file);
  327. }
  328. parsed_data_dir = make_data_directory(name.array, omp->data);
  329. if (parsed_data_dir && bin_found) {
  330. info.bin_path = parsed_bin_path.array;
  331. info.data_path = parsed_data_dir;
  332. callback(param, &info);
  333. }
  334. bfree(parsed_data_dir);
  335. dstr_free(&name);
  336. dstr_free(&parsed_bin_path);
  337. }
  338. static void find_modules_in_path(struct obs_module_path *omp,
  339. obs_find_module_callback_t callback,
  340. void *param)
  341. {
  342. struct dstr search_path = {0};
  343. char *module_start;
  344. bool search_directories = false;
  345. os_glob_t *gi;
  346. dstr_copy(&search_path, omp->bin);
  347. module_start = strstr(search_path.array, "%module%");
  348. if (module_start) {
  349. dstr_resize(&search_path, module_start - search_path.array);
  350. search_directories = true;
  351. }
  352. if (!dstr_is_empty(&search_path) && dstr_end(&search_path) != '/')
  353. dstr_cat_ch(&search_path, '/');
  354. dstr_cat_ch(&search_path, '*');
  355. if (!search_directories)
  356. dstr_cat(&search_path, get_module_extension());
  357. if (os_glob(search_path.array, 0, &gi) == 0) {
  358. for (size_t i = 0; i < gi->gl_pathc; i++) {
  359. if (search_directories == gi->gl_pathv[i].directory)
  360. process_found_module(omp, gi->gl_pathv[i].path,
  361. search_directories,
  362. callback, param);
  363. }
  364. os_globfree(gi);
  365. }
  366. dstr_free(&search_path);
  367. }
  368. void obs_find_modules(obs_find_module_callback_t callback, void *param)
  369. {
  370. if (!obs)
  371. return;
  372. for (size_t i = 0; i < obs->module_paths.num; i++) {
  373. struct obs_module_path *omp = obs->module_paths.array + i;
  374. find_modules_in_path(omp, callback, param);
  375. }
  376. }
  377. void obs_enum_modules(obs_enum_module_callback_t callback, void *param)
  378. {
  379. struct obs_module *module;
  380. if (!obs)
  381. return;
  382. module = obs->first_module;
  383. while (module) {
  384. callback(param, module);
  385. module = module->next;
  386. }
  387. }
  388. void free_module(struct obs_module *mod)
  389. {
  390. if (!mod)
  391. return;
  392. if (mod->module) {
  393. if (mod->free_locale)
  394. mod->free_locale();
  395. if (mod->loaded && mod->unload)
  396. mod->unload();
  397. /* there is no real reason to close the dynamic libraries,
  398. * and sometimes this can cause issues. */
  399. /* os_dlclose(mod->module); */
  400. }
  401. bfree(mod->mod_name);
  402. bfree(mod->bin_path);
  403. bfree(mod->data_path);
  404. bfree(mod);
  405. }
  406. lookup_t *obs_module_load_locale(obs_module_t *module,
  407. const char *default_locale, const char *locale)
  408. {
  409. struct dstr str = {0};
  410. lookup_t *lookup = NULL;
  411. if (!module || !default_locale || !locale) {
  412. blog(LOG_WARNING, "obs_module_load_locale: Invalid parameters");
  413. return NULL;
  414. }
  415. dstr_copy(&str, "locale/");
  416. dstr_cat(&str, default_locale);
  417. dstr_cat(&str, ".ini");
  418. char *file = obs_find_module_file(module, str.array);
  419. if (file)
  420. lookup = text_lookup_create(file);
  421. bfree(file);
  422. if (!lookup) {
  423. blog(LOG_WARNING, "Failed to load '%s' text for module: '%s'",
  424. default_locale, module->file);
  425. goto cleanup;
  426. }
  427. if (astrcmpi(locale, default_locale) == 0)
  428. goto cleanup;
  429. dstr_copy(&str, "/locale/");
  430. dstr_cat(&str, locale);
  431. dstr_cat(&str, ".ini");
  432. file = obs_find_module_file(module, str.array);
  433. if (!text_lookup_add(lookup, file))
  434. blog(LOG_WARNING, "Failed to load '%s' text for module: '%s'",
  435. locale, module->file);
  436. bfree(file);
  437. cleanup:
  438. dstr_free(&str);
  439. return lookup;
  440. }
  441. #define REGISTER_OBS_DEF(size_var, structure, dest, info) \
  442. do { \
  443. struct structure data = {0}; \
  444. if (!size_var) { \
  445. blog(LOG_ERROR, "Tried to register " #structure \
  446. " outside of obs_module_load"); \
  447. return; \
  448. } \
  449. \
  450. if (size_var > sizeof(data)) { \
  451. blog(LOG_ERROR, \
  452. "Tried to register " #structure \
  453. " with size %llu which is more " \
  454. "than libobs currently supports " \
  455. "(%llu)", \
  456. (long long unsigned)size_var, \
  457. (long long unsigned)sizeof(data)); \
  458. goto error; \
  459. } \
  460. \
  461. memcpy(&data, info, size_var); \
  462. da_push_back(dest, &data); \
  463. } while (false)
  464. #define CHECK_REQUIRED_VAL(type, info, val, func) \
  465. do { \
  466. if ((offsetof(type, val) + sizeof(info->val) > size) || \
  467. !info->val) { \
  468. blog(LOG_ERROR, \
  469. "Required value '" #val "' for " \
  470. "'%s' not found. " #func " failed.", \
  471. info->id); \
  472. goto error; \
  473. } \
  474. } while (false)
  475. #define HANDLE_ERROR(size_var, structure, info) \
  476. do { \
  477. struct structure data = {0}; \
  478. if (!size_var) \
  479. return; \
  480. \
  481. memcpy(&data, info, \
  482. sizeof(data) < size_var ? sizeof(data) : size_var); \
  483. \
  484. if (data.type_data && data.free_type_data) \
  485. data.free_type_data(data.type_data); \
  486. } while (false)
  487. #define source_warn(format, ...) \
  488. blog(LOG_WARNING, "obs_register_source: " format, ##__VA_ARGS__)
  489. #define output_warn(format, ...) \
  490. blog(LOG_WARNING, "obs_register_output: " format, ##__VA_ARGS__)
  491. #define encoder_warn(format, ...) \
  492. blog(LOG_WARNING, "obs_register_encoder: " format, ##__VA_ARGS__)
  493. #define service_warn(format, ...) \
  494. blog(LOG_WARNING, "obs_register_service: " format, ##__VA_ARGS__)
  495. void obs_register_source_s(const struct obs_source_info *info, size_t size)
  496. {
  497. struct obs_source_info data = {0};
  498. struct darray *array = NULL;
  499. if (info->type == OBS_SOURCE_TYPE_INPUT) {
  500. array = &obs->input_types.da;
  501. } else if (info->type == OBS_SOURCE_TYPE_FILTER) {
  502. array = &obs->filter_types.da;
  503. } else if (info->type == OBS_SOURCE_TYPE_TRANSITION) {
  504. array = &obs->transition_types.da;
  505. } else if (info->type != OBS_SOURCE_TYPE_SCENE) {
  506. source_warn("Tried to register unknown source type: %u",
  507. info->type);
  508. goto error;
  509. }
  510. if (get_source_info2(info->id, info->version)) {
  511. source_warn("Source '%s' already exists! "
  512. "Duplicate library?",
  513. info->id);
  514. goto error;
  515. }
  516. if (size > sizeof(data)) {
  517. source_warn("Tried to register obs_source_info with size "
  518. "%llu which is more than libobs currently "
  519. "supports (%llu)",
  520. (long long unsigned)size,
  521. (long long unsigned)sizeof(data));
  522. goto error;
  523. }
  524. memcpy(&data, info, size);
  525. /* mark audio-only filters as an async filter categorically */
  526. if (data.type == OBS_SOURCE_TYPE_FILTER) {
  527. if ((data.output_flags & OBS_SOURCE_VIDEO) == 0)
  528. data.output_flags |= OBS_SOURCE_ASYNC;
  529. }
  530. if (data.type == OBS_SOURCE_TYPE_TRANSITION) {
  531. if (data.get_width)
  532. source_warn("get_width ignored registering "
  533. "transition '%s'",
  534. data.id);
  535. if (data.get_height)
  536. source_warn("get_height ignored registering "
  537. "transition '%s'",
  538. data.id);
  539. data.output_flags |= OBS_SOURCE_COMPOSITE | OBS_SOURCE_VIDEO |
  540. OBS_SOURCE_CUSTOM_DRAW;
  541. }
  542. if ((data.output_flags & OBS_SOURCE_COMPOSITE) != 0) {
  543. if ((data.output_flags & OBS_SOURCE_AUDIO) != 0) {
  544. source_warn("Source '%s': Composite sources "
  545. "cannot be audio sources",
  546. info->id);
  547. goto error;
  548. }
  549. if ((data.output_flags & OBS_SOURCE_ASYNC) != 0) {
  550. source_warn("Source '%s': Composite sources "
  551. "cannot be async sources",
  552. info->id);
  553. goto error;
  554. }
  555. }
  556. #define CHECK_REQUIRED_VAL_(info, val, func) \
  557. CHECK_REQUIRED_VAL(struct obs_source_info, info, val, func)
  558. CHECK_REQUIRED_VAL_(info, get_name, obs_register_source);
  559. if (info->type != OBS_SOURCE_TYPE_FILTER &&
  560. info->type != OBS_SOURCE_TYPE_TRANSITION &&
  561. (info->output_flags & OBS_SOURCE_VIDEO) != 0 &&
  562. (info->output_flags & OBS_SOURCE_ASYNC) == 0) {
  563. CHECK_REQUIRED_VAL_(info, get_width, obs_register_source);
  564. CHECK_REQUIRED_VAL_(info, get_height, obs_register_source);
  565. }
  566. if ((data.output_flags & OBS_SOURCE_COMPOSITE) != 0) {
  567. CHECK_REQUIRED_VAL_(info, audio_render, obs_register_source);
  568. }
  569. #undef CHECK_REQUIRED_VAL_
  570. /* version-related stuff */
  571. data.unversioned_id = data.id;
  572. if (data.version) {
  573. struct dstr versioned_id = {0};
  574. dstr_printf(&versioned_id, "%s_v%d", data.id,
  575. (int)data.version);
  576. data.id = versioned_id.array;
  577. } else {
  578. data.id = bstrdup(data.id);
  579. }
  580. if (array)
  581. darray_push_back(sizeof(struct obs_source_info), array, &data);
  582. da_push_back(obs->source_types, &data);
  583. return;
  584. error:
  585. HANDLE_ERROR(size, obs_source_info, info);
  586. }
  587. void obs_register_output_s(const struct obs_output_info *info, size_t size)
  588. {
  589. if (find_output(info->id)) {
  590. output_warn("Output id '%s' already exists! "
  591. "Duplicate library?",
  592. info->id);
  593. goto error;
  594. }
  595. #define CHECK_REQUIRED_VAL_(info, val, func) \
  596. CHECK_REQUIRED_VAL(struct obs_output_info, info, val, func)
  597. CHECK_REQUIRED_VAL_(info, get_name, obs_register_output);
  598. CHECK_REQUIRED_VAL_(info, create, obs_register_output);
  599. CHECK_REQUIRED_VAL_(info, destroy, obs_register_output);
  600. CHECK_REQUIRED_VAL_(info, start, obs_register_output);
  601. CHECK_REQUIRED_VAL_(info, stop, obs_register_output);
  602. if (info->flags & OBS_OUTPUT_ENCODED) {
  603. CHECK_REQUIRED_VAL_(info, encoded_packet, obs_register_output);
  604. } else {
  605. if (info->flags & OBS_OUTPUT_VIDEO)
  606. CHECK_REQUIRED_VAL_(info, raw_video,
  607. obs_register_output);
  608. if (info->flags & OBS_OUTPUT_AUDIO) {
  609. if (info->flags & OBS_OUTPUT_MULTI_TRACK) {
  610. CHECK_REQUIRED_VAL_(info, raw_audio2,
  611. obs_register_output);
  612. } else {
  613. CHECK_REQUIRED_VAL_(info, raw_audio,
  614. obs_register_output);
  615. }
  616. }
  617. }
  618. #undef CHECK_REQUIRED_VAL_
  619. REGISTER_OBS_DEF(size, obs_output_info, obs->output_types, info);
  620. return;
  621. error:
  622. HANDLE_ERROR(size, obs_output_info, info);
  623. }
  624. void obs_register_encoder_s(const struct obs_encoder_info *info, size_t size)
  625. {
  626. if (find_encoder(info->id)) {
  627. encoder_warn("Encoder id '%s' already exists! "
  628. "Duplicate library?",
  629. info->id);
  630. goto error;
  631. }
  632. #define CHECK_REQUIRED_VAL_(info, val, func) \
  633. CHECK_REQUIRED_VAL(struct obs_encoder_info, info, val, func)
  634. CHECK_REQUIRED_VAL_(info, get_name, obs_register_encoder);
  635. CHECK_REQUIRED_VAL_(info, create, obs_register_encoder);
  636. CHECK_REQUIRED_VAL_(info, destroy, obs_register_encoder);
  637. if ((info->caps & OBS_ENCODER_CAP_PASS_TEXTURE) != 0)
  638. CHECK_REQUIRED_VAL_(info, encode_texture, obs_register_encoder);
  639. else
  640. CHECK_REQUIRED_VAL_(info, encode, obs_register_encoder);
  641. if (info->type == OBS_ENCODER_AUDIO)
  642. CHECK_REQUIRED_VAL_(info, get_frame_size, obs_register_encoder);
  643. #undef CHECK_REQUIRED_VAL_
  644. REGISTER_OBS_DEF(size, obs_encoder_info, obs->encoder_types, info);
  645. return;
  646. error:
  647. HANDLE_ERROR(size, obs_encoder_info, info);
  648. }
  649. void obs_register_service_s(const struct obs_service_info *info, size_t size)
  650. {
  651. if (find_service(info->id)) {
  652. service_warn("Service id '%s' already exists! "
  653. "Duplicate library?",
  654. info->id);
  655. goto error;
  656. }
  657. #define CHECK_REQUIRED_VAL_(info, val, func) \
  658. CHECK_REQUIRED_VAL(struct obs_service_info, info, val, func)
  659. CHECK_REQUIRED_VAL_(info, get_name, obs_register_service);
  660. CHECK_REQUIRED_VAL_(info, create, obs_register_service);
  661. CHECK_REQUIRED_VAL_(info, destroy, obs_register_service);
  662. #undef CHECK_REQUIRED_VAL_
  663. REGISTER_OBS_DEF(size, obs_service_info, obs->service_types, info);
  664. return;
  665. error:
  666. HANDLE_ERROR(size, obs_service_info, info);
  667. }
  668. void obs_register_modal_ui_s(const struct obs_modal_ui *info, size_t size)
  669. {
  670. #define CHECK_REQUIRED_VAL_(info, val, func) \
  671. CHECK_REQUIRED_VAL(struct obs_modal_ui, info, val, func)
  672. CHECK_REQUIRED_VAL_(info, task, obs_register_modal_ui);
  673. CHECK_REQUIRED_VAL_(info, target, obs_register_modal_ui);
  674. CHECK_REQUIRED_VAL_(info, exec, obs_register_modal_ui);
  675. #undef CHECK_REQUIRED_VAL_
  676. REGISTER_OBS_DEF(size, obs_modal_ui, obs->modal_ui_callbacks, info);
  677. return;
  678. error:
  679. HANDLE_ERROR(size, obs_modal_ui, info);
  680. }
  681. void obs_register_modeless_ui_s(const struct obs_modeless_ui *info, size_t size)
  682. {
  683. #define CHECK_REQUIRED_VAL_(info, val, func) \
  684. CHECK_REQUIRED_VAL(struct obs_modeless_ui, info, val, func)
  685. CHECK_REQUIRED_VAL_(info, task, obs_register_modeless_ui);
  686. CHECK_REQUIRED_VAL_(info, target, obs_register_modeless_ui);
  687. CHECK_REQUIRED_VAL_(info, create, obs_register_modeless_ui);
  688. #undef CHECK_REQUIRED_VAL_
  689. REGISTER_OBS_DEF(size, obs_modeless_ui, obs->modeless_ui_callbacks,
  690. info);
  691. return;
  692. error:
  693. HANDLE_ERROR(size, obs_modeless_ui, info);
  694. }