obs-module.c 24 KB

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