1
0

obs-module.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932
  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/obs-studio") != 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. extern void get_plugin_info(const char *path, bool *is_obs_plugin,
  221. bool *can_load);
  222. struct fail_info {
  223. struct dstr fail_modules;
  224. size_t fail_count;
  225. };
  226. static void load_all_callback(void *param, const struct obs_module_info2 *info)
  227. {
  228. struct fail_info *fail_info = param;
  229. obs_module_t *module;
  230. bool is_obs_plugin;
  231. bool can_load_obs_plugin;
  232. get_plugin_info(info->bin_path, &is_obs_plugin, &can_load_obs_plugin);
  233. if (!is_obs_plugin) {
  234. blog(LOG_WARNING, "Skipping module '%s', not an OBS plugin",
  235. info->bin_path);
  236. return;
  237. }
  238. if (!can_load_obs_plugin) {
  239. blog(LOG_WARNING,
  240. "Skipping module '%s' due to possible "
  241. "import conflicts",
  242. info->bin_path);
  243. goto load_failure;
  244. }
  245. int code = obs_open_module(&module, info->bin_path, info->data_path);
  246. if (code != MODULE_SUCCESS) {
  247. blog(LOG_DEBUG, "Failed to load module file '%s': %d",
  248. info->bin_path, code);
  249. goto load_failure;
  250. }
  251. if (!obs_init_module(module))
  252. free_module(module);
  253. UNUSED_PARAMETER(param);
  254. return;
  255. load_failure:
  256. if (fail_info) {
  257. dstr_cat(&fail_info->fail_modules, info->name);
  258. dstr_cat(&fail_info->fail_modules, ";");
  259. fail_info->fail_count++;
  260. }
  261. }
  262. static const char *obs_load_all_modules_name = "obs_load_all_modules";
  263. #ifdef _WIN32
  264. static const char *reset_win32_symbol_paths_name = "reset_win32_symbol_paths";
  265. #endif
  266. void obs_load_all_modules(void)
  267. {
  268. profile_start(obs_load_all_modules_name);
  269. obs_find_modules2(load_all_callback, NULL);
  270. #ifdef _WIN32
  271. profile_start(reset_win32_symbol_paths_name);
  272. reset_win32_symbol_paths();
  273. profile_end(reset_win32_symbol_paths_name);
  274. #endif
  275. profile_end(obs_load_all_modules_name);
  276. }
  277. static const char *obs_load_all_modules2_name = "obs_load_all_modules2";
  278. void obs_load_all_modules2(struct obs_module_failure_info *mfi)
  279. {
  280. struct fail_info fail_info = {0};
  281. memset(mfi, 0, sizeof(*mfi));
  282. profile_start(obs_load_all_modules2_name);
  283. obs_find_modules2(load_all_callback, &fail_info);
  284. #ifdef _WIN32
  285. profile_start(reset_win32_symbol_paths_name);
  286. reset_win32_symbol_paths();
  287. profile_end(reset_win32_symbol_paths_name);
  288. #endif
  289. profile_end(obs_load_all_modules2_name);
  290. mfi->count = fail_info.fail_count;
  291. mfi->failed_modules =
  292. strlist_split(fail_info.fail_modules.array, ';', false);
  293. dstr_free(&fail_info.fail_modules);
  294. }
  295. void obs_module_failure_info_free(struct obs_module_failure_info *mfi)
  296. {
  297. if (mfi->failed_modules) {
  298. bfree(mfi->failed_modules);
  299. mfi->failed_modules = NULL;
  300. }
  301. }
  302. void obs_post_load_modules(void)
  303. {
  304. for (obs_module_t *mod = obs->first_module; !!mod; mod = mod->next)
  305. if (mod->post_load)
  306. mod->post_load();
  307. }
  308. static inline void make_data_dir(struct dstr *parsed_data_dir,
  309. const char *data_dir, const char *name)
  310. {
  311. dstr_copy(parsed_data_dir, data_dir);
  312. dstr_replace(parsed_data_dir, "%module%", name);
  313. if (dstr_end(parsed_data_dir) == '/')
  314. dstr_resize(parsed_data_dir, parsed_data_dir->len - 1);
  315. }
  316. static char *make_data_directory(const char *module_name, const char *data_dir)
  317. {
  318. struct dstr parsed_data_dir = {0};
  319. bool found = false;
  320. make_data_dir(&parsed_data_dir, data_dir, module_name);
  321. found = os_file_exists(parsed_data_dir.array);
  322. if (!found && astrcmpi_n(module_name, "lib", 3) == 0)
  323. make_data_dir(&parsed_data_dir, data_dir, module_name + 3);
  324. return parsed_data_dir.array;
  325. }
  326. static bool parse_binary_from_directory(struct dstr *parsed_bin_path,
  327. const char *bin_path, const char *file)
  328. {
  329. struct dstr directory = {0};
  330. bool found = true;
  331. dstr_copy(&directory, bin_path);
  332. dstr_replace(&directory, "%module%", file);
  333. if (dstr_end(&directory) != '/')
  334. dstr_cat_ch(&directory, '/');
  335. dstr_copy_dstr(parsed_bin_path, &directory);
  336. dstr_cat(parsed_bin_path, file);
  337. #ifdef __APPLE__
  338. if (!os_file_exists(parsed_bin_path->array)) {
  339. dstr_cat(parsed_bin_path, ".so");
  340. }
  341. #else
  342. dstr_cat(parsed_bin_path, get_module_extension());
  343. #endif
  344. if (!os_file_exists(parsed_bin_path->array)) {
  345. /* Legacy fallback: Check for plugin with .so suffix*/
  346. dstr_cat(parsed_bin_path, ".so");
  347. /* if the file doesn't exist, check with 'lib' prefix */
  348. dstr_copy_dstr(parsed_bin_path, &directory);
  349. dstr_cat(parsed_bin_path, "lib");
  350. dstr_cat(parsed_bin_path, file);
  351. dstr_cat(parsed_bin_path, get_module_extension());
  352. /* if neither exist, don't include this as a library */
  353. if (!os_file_exists(parsed_bin_path->array)) {
  354. dstr_free(parsed_bin_path);
  355. found = false;
  356. }
  357. }
  358. dstr_free(&directory);
  359. return found;
  360. }
  361. static void process_found_module(struct obs_module_path *omp, const char *path,
  362. bool directory,
  363. obs_find_module_callback2_t callback,
  364. void *param)
  365. {
  366. struct obs_module_info2 info;
  367. struct dstr name = {0};
  368. struct dstr parsed_bin_path = {0};
  369. const char *file;
  370. char *parsed_data_dir;
  371. bool bin_found = true;
  372. file = strrchr(path, '/');
  373. file = file ? (file + 1) : path;
  374. if (strcmp(file, ".") == 0 || strcmp(file, "..") == 0)
  375. return;
  376. dstr_copy(&name, file);
  377. char *ext = strrchr(name.array, '.');
  378. if (ext)
  379. dstr_resize(&name, ext - name.array);
  380. if (!directory) {
  381. dstr_copy(&parsed_bin_path, path);
  382. } else {
  383. bin_found = parse_binary_from_directory(&parsed_bin_path,
  384. omp->bin, name.array);
  385. }
  386. parsed_data_dir = make_data_directory(name.array, omp->data);
  387. if (parsed_data_dir && bin_found) {
  388. info.bin_path = parsed_bin_path.array;
  389. info.data_path = parsed_data_dir;
  390. info.name = name.array;
  391. callback(param, &info);
  392. }
  393. bfree(parsed_data_dir);
  394. dstr_free(&name);
  395. dstr_free(&parsed_bin_path);
  396. }
  397. static void find_modules_in_path(struct obs_module_path *omp,
  398. obs_find_module_callback2_t callback,
  399. void *param)
  400. {
  401. struct dstr search_path = {0};
  402. char *module_start;
  403. bool search_directories = false;
  404. os_glob_t *gi;
  405. dstr_copy(&search_path, omp->bin);
  406. module_start = strstr(search_path.array, "%module%");
  407. if (module_start) {
  408. dstr_resize(&search_path, module_start - search_path.array);
  409. search_directories = true;
  410. }
  411. if (!dstr_is_empty(&search_path) && dstr_end(&search_path) != '/')
  412. dstr_cat_ch(&search_path, '/');
  413. dstr_cat_ch(&search_path, '*');
  414. if (!search_directories)
  415. dstr_cat(&search_path, get_module_extension());
  416. if (os_glob(search_path.array, 0, &gi) == 0) {
  417. for (size_t i = 0; i < gi->gl_pathc; i++) {
  418. if (search_directories == gi->gl_pathv[i].directory)
  419. process_found_module(omp, gi->gl_pathv[i].path,
  420. search_directories,
  421. callback, param);
  422. }
  423. os_globfree(gi);
  424. }
  425. dstr_free(&search_path);
  426. }
  427. void obs_find_modules2(obs_find_module_callback2_t callback, void *param)
  428. {
  429. if (!obs)
  430. return;
  431. for (size_t i = 0; i < obs->module_paths.num; i++) {
  432. struct obs_module_path *omp = obs->module_paths.array + i;
  433. find_modules_in_path(omp, callback, param);
  434. }
  435. }
  436. void obs_find_modules(obs_find_module_callback_t callback, void *param)
  437. {
  438. /* the structure is ABI compatible so we can just cast the callback */
  439. obs_find_modules2((obs_find_module_callback2_t)callback, param);
  440. }
  441. void obs_enum_modules(obs_enum_module_callback_t callback, void *param)
  442. {
  443. struct obs_module *module;
  444. if (!obs)
  445. return;
  446. module = obs->first_module;
  447. while (module) {
  448. callback(param, module);
  449. module = module->next;
  450. }
  451. }
  452. void free_module(struct obs_module *mod)
  453. {
  454. if (!mod)
  455. return;
  456. if (mod->module) {
  457. if (mod->free_locale)
  458. mod->free_locale();
  459. if (mod->loaded && mod->unload)
  460. mod->unload();
  461. /* there is no real reason to close the dynamic libraries,
  462. * and sometimes this can cause issues. */
  463. /* os_dlclose(mod->module); */
  464. }
  465. for (obs_module_t *m = obs->first_module; !!m; m = m->next) {
  466. if (m->next == mod) {
  467. m->next = mod->next;
  468. break;
  469. }
  470. }
  471. if (obs->first_module == mod)
  472. obs->first_module = mod->next;
  473. bfree(mod->mod_name);
  474. bfree(mod->bin_path);
  475. bfree(mod->data_path);
  476. bfree(mod);
  477. }
  478. lookup_t *obs_module_load_locale(obs_module_t *module,
  479. const char *default_locale, const char *locale)
  480. {
  481. struct dstr str = {0};
  482. lookup_t *lookup = NULL;
  483. if (!module || !default_locale || !locale) {
  484. blog(LOG_WARNING, "obs_module_load_locale: Invalid parameters");
  485. return NULL;
  486. }
  487. dstr_copy(&str, "locale/");
  488. dstr_cat(&str, default_locale);
  489. dstr_cat(&str, ".ini");
  490. char *file = obs_find_module_file(module, str.array);
  491. if (file)
  492. lookup = text_lookup_create(file);
  493. bfree(file);
  494. if (!lookup) {
  495. blog(LOG_WARNING, "Failed to load '%s' text for module: '%s'",
  496. default_locale, module->file);
  497. goto cleanup;
  498. }
  499. if (astrcmpi(locale, default_locale) == 0)
  500. goto cleanup;
  501. dstr_copy(&str, "/locale/");
  502. dstr_cat(&str, locale);
  503. dstr_cat(&str, ".ini");
  504. file = obs_find_module_file(module, str.array);
  505. if (!text_lookup_add(lookup, file))
  506. blog(LOG_WARNING, "Failed to load '%s' text for module: '%s'",
  507. locale, module->file);
  508. bfree(file);
  509. cleanup:
  510. dstr_free(&str);
  511. return lookup;
  512. }
  513. #define REGISTER_OBS_DEF(size_var, structure, dest, info) \
  514. do { \
  515. struct structure data = {0}; \
  516. if (!size_var) { \
  517. blog(LOG_ERROR, "Tried to register " #structure \
  518. " outside of obs_module_load"); \
  519. return; \
  520. } \
  521. \
  522. if (size_var > sizeof(data)) { \
  523. blog(LOG_ERROR, \
  524. "Tried to register " #structure \
  525. " with size %llu which is more " \
  526. "than libobs currently supports " \
  527. "(%llu)", \
  528. (long long unsigned)size_var, \
  529. (long long unsigned)sizeof(data)); \
  530. goto error; \
  531. } \
  532. \
  533. memcpy(&data, info, size_var); \
  534. da_push_back(dest, &data); \
  535. } while (false)
  536. #define CHECK_REQUIRED_VAL(type, info, val, func) \
  537. do { \
  538. if ((offsetof(type, val) + sizeof(info->val) > size) || \
  539. !info->val) { \
  540. blog(LOG_ERROR, \
  541. "Required value '" #val "' for " \
  542. "'%s' not found. " #func " failed.", \
  543. info->id); \
  544. goto error; \
  545. } \
  546. } while (false)
  547. #define HANDLE_ERROR(size_var, structure, info) \
  548. do { \
  549. struct structure data = {0}; \
  550. if (!size_var) \
  551. return; \
  552. \
  553. memcpy(&data, info, \
  554. sizeof(data) < size_var ? sizeof(data) : size_var); \
  555. \
  556. if (data.type_data && data.free_type_data) \
  557. data.free_type_data(data.type_data); \
  558. } while (false)
  559. #define source_warn(format, ...) \
  560. blog(LOG_WARNING, "obs_register_source: " format, ##__VA_ARGS__)
  561. #define output_warn(format, ...) \
  562. blog(LOG_WARNING, "obs_register_output: " format, ##__VA_ARGS__)
  563. #define encoder_warn(format, ...) \
  564. blog(LOG_WARNING, "obs_register_encoder: " format, ##__VA_ARGS__)
  565. #define service_warn(format, ...) \
  566. blog(LOG_WARNING, "obs_register_service: " format, ##__VA_ARGS__)
  567. void obs_register_source_s(const struct obs_source_info *info, size_t size)
  568. {
  569. struct obs_source_info data = {0};
  570. struct darray *array = NULL;
  571. if (info->type == OBS_SOURCE_TYPE_INPUT) {
  572. array = &obs->input_types.da;
  573. } else if (info->type == OBS_SOURCE_TYPE_FILTER) {
  574. array = &obs->filter_types.da;
  575. } else if (info->type == OBS_SOURCE_TYPE_TRANSITION) {
  576. array = &obs->transition_types.da;
  577. } else if (info->type != OBS_SOURCE_TYPE_SCENE) {
  578. source_warn("Tried to register unknown source type: %u",
  579. info->type);
  580. goto error;
  581. }
  582. if (get_source_info2(info->id, info->version)) {
  583. source_warn("Source '%s' already exists! "
  584. "Duplicate library?",
  585. info->id);
  586. goto error;
  587. }
  588. if (size > sizeof(data)) {
  589. source_warn("Tried to register obs_source_info with size "
  590. "%llu which is more than libobs currently "
  591. "supports (%llu)",
  592. (long long unsigned)size,
  593. (long long unsigned)sizeof(data));
  594. goto error;
  595. }
  596. memcpy(&data, info, size);
  597. /* mark audio-only filters as an async filter categorically */
  598. if (data.type == OBS_SOURCE_TYPE_FILTER) {
  599. if ((data.output_flags & OBS_SOURCE_VIDEO) == 0)
  600. data.output_flags |= OBS_SOURCE_ASYNC;
  601. }
  602. if (data.type == OBS_SOURCE_TYPE_TRANSITION) {
  603. if (data.get_width)
  604. source_warn("get_width ignored registering "
  605. "transition '%s'",
  606. data.id);
  607. if (data.get_height)
  608. source_warn("get_height ignored registering "
  609. "transition '%s'",
  610. data.id);
  611. data.output_flags |= OBS_SOURCE_COMPOSITE | OBS_SOURCE_VIDEO |
  612. OBS_SOURCE_CUSTOM_DRAW;
  613. }
  614. if ((data.output_flags & OBS_SOURCE_COMPOSITE) != 0) {
  615. if ((data.output_flags & OBS_SOURCE_AUDIO) != 0) {
  616. source_warn("Source '%s': Composite sources "
  617. "cannot be audio sources",
  618. info->id);
  619. goto error;
  620. }
  621. if ((data.output_flags & OBS_SOURCE_ASYNC) != 0) {
  622. source_warn("Source '%s': Composite sources "
  623. "cannot be async sources",
  624. info->id);
  625. goto error;
  626. }
  627. }
  628. #define CHECK_REQUIRED_VAL_(info, val, func) \
  629. CHECK_REQUIRED_VAL(struct obs_source_info, info, val, func)
  630. CHECK_REQUIRED_VAL_(info, get_name, obs_register_source);
  631. if (info->type != OBS_SOURCE_TYPE_FILTER &&
  632. info->type != OBS_SOURCE_TYPE_TRANSITION &&
  633. (info->output_flags & OBS_SOURCE_VIDEO) != 0 &&
  634. (info->output_flags & OBS_SOURCE_ASYNC) == 0) {
  635. CHECK_REQUIRED_VAL_(info, get_width, obs_register_source);
  636. CHECK_REQUIRED_VAL_(info, get_height, obs_register_source);
  637. }
  638. if ((data.output_flags & OBS_SOURCE_COMPOSITE) != 0) {
  639. CHECK_REQUIRED_VAL_(info, audio_render, obs_register_source);
  640. }
  641. #undef CHECK_REQUIRED_VAL_
  642. /* version-related stuff */
  643. data.unversioned_id = data.id;
  644. if (data.version) {
  645. struct dstr versioned_id = {0};
  646. dstr_printf(&versioned_id, "%s_v%d", data.id,
  647. (int)data.version);
  648. data.id = versioned_id.array;
  649. } else {
  650. data.id = bstrdup(data.id);
  651. }
  652. if (array)
  653. darray_push_back(sizeof(struct obs_source_info), array, &data);
  654. da_push_back(obs->source_types, &data);
  655. return;
  656. error:
  657. HANDLE_ERROR(size, obs_source_info, info);
  658. }
  659. void obs_register_output_s(const struct obs_output_info *info, size_t size)
  660. {
  661. if (find_output(info->id)) {
  662. output_warn("Output id '%s' already exists! "
  663. "Duplicate library?",
  664. info->id);
  665. goto error;
  666. }
  667. #define CHECK_REQUIRED_VAL_(info, val, func) \
  668. CHECK_REQUIRED_VAL(struct obs_output_info, info, val, func)
  669. CHECK_REQUIRED_VAL_(info, get_name, obs_register_output);
  670. CHECK_REQUIRED_VAL_(info, create, obs_register_output);
  671. CHECK_REQUIRED_VAL_(info, destroy, obs_register_output);
  672. CHECK_REQUIRED_VAL_(info, start, obs_register_output);
  673. CHECK_REQUIRED_VAL_(info, stop, obs_register_output);
  674. if (info->flags & OBS_OUTPUT_ENCODED) {
  675. CHECK_REQUIRED_VAL_(info, encoded_packet, obs_register_output);
  676. } else {
  677. if (info->flags & OBS_OUTPUT_VIDEO)
  678. CHECK_REQUIRED_VAL_(info, raw_video,
  679. obs_register_output);
  680. if (info->flags & OBS_OUTPUT_AUDIO) {
  681. if (info->flags & OBS_OUTPUT_MULTI_TRACK) {
  682. CHECK_REQUIRED_VAL_(info, raw_audio2,
  683. obs_register_output);
  684. } else {
  685. CHECK_REQUIRED_VAL_(info, raw_audio,
  686. obs_register_output);
  687. }
  688. }
  689. }
  690. #undef CHECK_REQUIRED_VAL_
  691. REGISTER_OBS_DEF(size, obs_output_info, obs->output_types, info);
  692. return;
  693. error:
  694. HANDLE_ERROR(size, obs_output_info, info);
  695. }
  696. void obs_register_encoder_s(const struct obs_encoder_info *info, size_t size)
  697. {
  698. if (find_encoder(info->id)) {
  699. encoder_warn("Encoder id '%s' already exists! "
  700. "Duplicate library?",
  701. info->id);
  702. goto error;
  703. }
  704. #define CHECK_REQUIRED_VAL_(info, val, func) \
  705. CHECK_REQUIRED_VAL(struct obs_encoder_info, info, val, func)
  706. CHECK_REQUIRED_VAL_(info, get_name, obs_register_encoder);
  707. CHECK_REQUIRED_VAL_(info, create, obs_register_encoder);
  708. CHECK_REQUIRED_VAL_(info, destroy, obs_register_encoder);
  709. if ((info->caps & OBS_ENCODER_CAP_PASS_TEXTURE) != 0)
  710. CHECK_REQUIRED_VAL_(info, encode_texture, obs_register_encoder);
  711. else
  712. CHECK_REQUIRED_VAL_(info, encode, obs_register_encoder);
  713. if (info->type == OBS_ENCODER_AUDIO)
  714. CHECK_REQUIRED_VAL_(info, get_frame_size, obs_register_encoder);
  715. #undef CHECK_REQUIRED_VAL_
  716. REGISTER_OBS_DEF(size, obs_encoder_info, obs->encoder_types, info);
  717. return;
  718. error:
  719. HANDLE_ERROR(size, obs_encoder_info, info);
  720. }
  721. void obs_register_service_s(const struct obs_service_info *info, size_t size)
  722. {
  723. if (find_service(info->id)) {
  724. service_warn("Service id '%s' already exists! "
  725. "Duplicate library?",
  726. info->id);
  727. goto error;
  728. }
  729. #define CHECK_REQUIRED_VAL_(info, val, func) \
  730. CHECK_REQUIRED_VAL(struct obs_service_info, info, val, func)
  731. CHECK_REQUIRED_VAL_(info, get_name, obs_register_service);
  732. CHECK_REQUIRED_VAL_(info, create, obs_register_service);
  733. CHECK_REQUIRED_VAL_(info, destroy, obs_register_service);
  734. #undef CHECK_REQUIRED_VAL_
  735. REGISTER_OBS_DEF(size, obs_service_info, obs->service_types, info);
  736. return;
  737. error:
  738. HANDLE_ERROR(size, obs_service_info, info);
  739. }
  740. void obs_register_modal_ui_s(const struct obs_modal_ui *info, size_t size)
  741. {
  742. #define CHECK_REQUIRED_VAL_(info, val, func) \
  743. CHECK_REQUIRED_VAL(struct obs_modal_ui, info, val, func)
  744. CHECK_REQUIRED_VAL_(info, task, obs_register_modal_ui);
  745. CHECK_REQUIRED_VAL_(info, target, obs_register_modal_ui);
  746. CHECK_REQUIRED_VAL_(info, exec, obs_register_modal_ui);
  747. #undef CHECK_REQUIRED_VAL_
  748. REGISTER_OBS_DEF(size, obs_modal_ui, obs->modal_ui_callbacks, info);
  749. return;
  750. error:
  751. HANDLE_ERROR(size, obs_modal_ui, info);
  752. }
  753. void obs_register_modeless_ui_s(const struct obs_modeless_ui *info, size_t size)
  754. {
  755. #define CHECK_REQUIRED_VAL_(info, val, func) \
  756. CHECK_REQUIRED_VAL(struct obs_modeless_ui, info, val, func)
  757. CHECK_REQUIRED_VAL_(info, task, obs_register_modeless_ui);
  758. CHECK_REQUIRED_VAL_(info, target, obs_register_modeless_ui);
  759. CHECK_REQUIRED_VAL_(info, create, obs_register_modeless_ui);
  760. #undef CHECK_REQUIRED_VAL_
  761. REGISTER_OBS_DEF(size, obs_modeless_ui, obs->modeless_ui_callbacks,
  762. info);
  763. return;
  764. error:
  765. HANDLE_ERROR(size, obs_modeless_ui, info);
  766. }