obs.h 72 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052
  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. #pragma once
  15. #include "util/c99defs.h"
  16. #include "util/bmem.h"
  17. #include "util/profiler.h"
  18. #include "util/text-lookup.h"
  19. #include "graphics/graphics.h"
  20. #include "graphics/vec2.h"
  21. #include "graphics/vec3.h"
  22. #include "media-io/audio-io.h"
  23. #include "media-io/video-io.h"
  24. #include "callback/signal.h"
  25. #include "callback/proc.h"
  26. #include "obs-config.h"
  27. #include "obs-defs.h"
  28. #include "obs-data.h"
  29. #include "obs-ui.h"
  30. #include "obs-properties.h"
  31. #include "obs-interaction.h"
  32. struct matrix4;
  33. /* opaque types */
  34. struct obs_display;
  35. struct obs_view;
  36. struct obs_source;
  37. struct obs_scene;
  38. struct obs_scene_item;
  39. struct obs_output;
  40. struct obs_encoder;
  41. struct obs_service;
  42. struct obs_module;
  43. struct obs_fader;
  44. struct obs_volmeter;
  45. typedef struct obs_display obs_display_t;
  46. typedef struct obs_view obs_view_t;
  47. typedef struct obs_source obs_source_t;
  48. typedef struct obs_scene obs_scene_t;
  49. typedef struct obs_scene_item obs_sceneitem_t;
  50. typedef struct obs_output obs_output_t;
  51. typedef struct obs_encoder obs_encoder_t;
  52. typedef struct obs_service obs_service_t;
  53. typedef struct obs_module obs_module_t;
  54. typedef struct obs_fader obs_fader_t;
  55. typedef struct obs_volmeter obs_volmeter_t;
  56. typedef struct obs_weak_source obs_weak_source_t;
  57. typedef struct obs_weak_output obs_weak_output_t;
  58. typedef struct obs_weak_encoder obs_weak_encoder_t;
  59. typedef struct obs_weak_service obs_weak_service_t;
  60. #include "obs-source.h"
  61. #include "obs-encoder.h"
  62. #include "obs-output.h"
  63. #include "obs-service.h"
  64. #include "obs-audio-controls.h"
  65. #include "obs-hotkey.h"
  66. /**
  67. * @file
  68. * @brief Main libobs header used by applications.
  69. *
  70. * @mainpage
  71. *
  72. * @section intro_sec Introduction
  73. *
  74. * This document describes the api for libobs to be used by applications as well
  75. * as @ref modules_page implementing some kind of functionality.
  76. *
  77. */
  78. #ifdef __cplusplus
  79. extern "C" {
  80. #endif
  81. /** Used for changing the order of items (for example, filters in a source,
  82. * or items in a scene) */
  83. enum obs_order_movement {
  84. OBS_ORDER_MOVE_UP,
  85. OBS_ORDER_MOVE_DOWN,
  86. OBS_ORDER_MOVE_TOP,
  87. OBS_ORDER_MOVE_BOTTOM
  88. };
  89. /**
  90. * Used with obs_source_process_filter to specify whether the filter should
  91. * render the source directly with the specified effect, or whether it should
  92. * render it to a texture
  93. */
  94. enum obs_allow_direct_render {
  95. OBS_NO_DIRECT_RENDERING,
  96. OBS_ALLOW_DIRECT_RENDERING,
  97. };
  98. enum obs_scale_type {
  99. OBS_SCALE_DISABLE,
  100. OBS_SCALE_POINT,
  101. OBS_SCALE_BICUBIC,
  102. OBS_SCALE_BILINEAR,
  103. OBS_SCALE_LANCZOS
  104. };
  105. /**
  106. * Used with scene items to indicate the type of bounds to use for scene items.
  107. * Mostly determines how the image will be scaled within those bounds, or
  108. * whether to use bounds at all.
  109. */
  110. enum obs_bounds_type {
  111. OBS_BOUNDS_NONE, /**< no bounds */
  112. OBS_BOUNDS_STRETCH, /**< stretch (ignores base scale) */
  113. OBS_BOUNDS_SCALE_INNER, /**< scales to inner rectangle */
  114. OBS_BOUNDS_SCALE_OUTER, /**< scales to outer rectangle */
  115. OBS_BOUNDS_SCALE_TO_WIDTH, /**< scales to the width */
  116. OBS_BOUNDS_SCALE_TO_HEIGHT, /**< scales to the height */
  117. OBS_BOUNDS_MAX_ONLY, /**< no scaling, maximum size only */
  118. };
  119. struct obs_transform_info {
  120. struct vec2 pos;
  121. float rot;
  122. struct vec2 scale;
  123. uint32_t alignment;
  124. enum obs_bounds_type bounds_type;
  125. uint32_t bounds_alignment;
  126. struct vec2 bounds;
  127. };
  128. /**
  129. * Video initialization structure
  130. */
  131. struct obs_video_info {
  132. #ifndef SWIG
  133. /**
  134. * Graphics module to use (usually "libobs-opengl" or "libobs-d3d11")
  135. */
  136. const char *graphics_module;
  137. #endif
  138. uint32_t fps_num; /**< Output FPS numerator */
  139. uint32_t fps_den; /**< Output FPS denominator */
  140. uint32_t base_width; /**< Base compositing width */
  141. uint32_t base_height; /**< Base compositing height */
  142. uint32_t output_width; /**< Output width */
  143. uint32_t output_height; /**< Output height */
  144. enum video_format output_format; /**< Output format */
  145. /** Video adapter index to use (NOTE: avoid for optimus laptops) */
  146. uint32_t adapter;
  147. /** Use shaders to convert to different color formats */
  148. bool gpu_conversion;
  149. enum video_colorspace colorspace; /**< YUV type (if YUV) */
  150. enum video_range_type range; /**< YUV range (if YUV) */
  151. enum obs_scale_type scale_type; /**< How to scale if scaling */
  152. };
  153. /**
  154. * Audio initialization structure
  155. */
  156. struct obs_audio_info {
  157. uint32_t samples_per_sec;
  158. enum speaker_layout speakers;
  159. };
  160. /**
  161. * Sent to source filters via the filter_audio callback to allow filtering of
  162. * audio data
  163. */
  164. struct obs_audio_data {
  165. uint8_t *data[MAX_AV_PLANES];
  166. uint32_t frames;
  167. uint64_t timestamp;
  168. };
  169. /**
  170. * Source audio output structure. Used with obs_source_output_audio to output
  171. * source audio. Audio is automatically resampled and remixed as necessary.
  172. */
  173. struct obs_source_audio {
  174. const uint8_t *data[MAX_AV_PLANES];
  175. uint32_t frames;
  176. enum speaker_layout speakers;
  177. enum audio_format format;
  178. uint32_t samples_per_sec;
  179. uint64_t timestamp;
  180. };
  181. /**
  182. * Source asynchronous video output structure. Used with
  183. * obs_source_output_video to output asynchronous video. Video is buffered as
  184. * necessary to play according to timestamps. When used with audio output,
  185. * audio is synced to video as it is played.
  186. *
  187. * If a YUV format is specified, it will be automatically upsampled and
  188. * converted to RGB via shader on the graphics processor.
  189. */
  190. struct obs_source_frame {
  191. uint8_t *data[MAX_AV_PLANES];
  192. uint32_t linesize[MAX_AV_PLANES];
  193. uint32_t width;
  194. uint32_t height;
  195. uint64_t timestamp;
  196. enum video_format format;
  197. float color_matrix[16];
  198. bool full_range;
  199. float color_range_min[3];
  200. float color_range_max[3];
  201. bool flip;
  202. /* used internally by libobs */
  203. volatile long refs;
  204. bool prev_frame;
  205. };
  206. /** Access to the argc/argv used to start OBS. What you see is what you get. */
  207. struct obs_cmdline_args {
  208. int argc;
  209. char **argv;
  210. };
  211. /* ------------------------------------------------------------------------- */
  212. /* OBS context */
  213. /**
  214. * Find a core libobs data file
  215. * @param path name of the base file
  216. * @return A string containing the full path to the file.
  217. * Use bfree after use.
  218. */
  219. EXPORT char *obs_find_data_file(const char *file);
  220. /**
  221. * Add a path to search libobs data files in.
  222. * @param path Full path to directory to look in.
  223. * The string is copied.
  224. */
  225. EXPORT void obs_add_data_path(const char *path);
  226. /**
  227. * Remove a path from libobs core data paths.
  228. * @param path The path to compare to currently set paths.
  229. * It does not need to be the same pointer, but
  230. * the path string must match an entry fully.
  231. * @return Whether or not the path was successfully removed.
  232. * If false, the path could not be found.
  233. */
  234. EXPORT bool obs_remove_data_path(const char *path);
  235. /**
  236. * Initializes OBS
  237. *
  238. * @param locale The locale to use for modules
  239. * @param module_config_path Path to module config storage directory
  240. * (or NULL if none)
  241. * @param store The profiler name store for OBS to use or NULL
  242. */
  243. EXPORT bool obs_startup(const char *locale, const char *module_config_path,
  244. profiler_name_store_t *store);
  245. /** Releases all data associated with OBS and terminates the OBS context */
  246. EXPORT void obs_shutdown(void);
  247. /** @return true if the main OBS context has been initialized */
  248. EXPORT bool obs_initialized(void);
  249. /** @return The current core version */
  250. EXPORT uint32_t obs_get_version(void);
  251. /** @return The current core version string */
  252. EXPORT const char *obs_get_version_string(void);
  253. /**
  254. * Sets things up for calls to obs_get_cmdline_args. Called onl yonce at startup
  255. * and safely copies argv/argc from main(). Subsequent calls do nothing.
  256. *
  257. * @param argc The count of command line arguments, from main()
  258. * @param argv An array of command line arguments, copied from main() and ends
  259. * with NULL.
  260. */
  261. EXPORT void obs_set_cmdline_args(int argc, char **argv);
  262. /**
  263. * Get the argc/argv used to start OBS
  264. *
  265. * @return The command line arguments used for main(). Don't modify this or
  266. * you'll mess things up for other callers.
  267. */
  268. EXPORT struct obs_cmdline_args obs_get_cmdline_args(void);
  269. /**
  270. * Sets a new locale to use for modules. This will call obs_module_set_locale
  271. * for each module with the new locale.
  272. *
  273. * @param locale The locale to use for modules
  274. */
  275. EXPORT void obs_set_locale(const char *locale);
  276. /** @return the current locale */
  277. EXPORT const char *obs_get_locale(void);
  278. /** Initialize the Windows-specific crash handler */
  279. #ifdef _WIN32
  280. EXPORT void obs_init_win32_crash_handler(void);
  281. #endif
  282. /**
  283. * Returns the profiler name store (see util/profiler.h) used by OBS, which is
  284. * either a name store passed to obs_startup, an internal name store, or NULL
  285. * in case obs_initialized() returns false.
  286. */
  287. EXPORT profiler_name_store_t *obs_get_profiler_name_store(void);
  288. /**
  289. * Sets base video output base resolution/fps/format.
  290. *
  291. * @note This data cannot be changed if an output is currently active.
  292. * @note The graphics module cannot be changed without fully destroying the
  293. * OBS context.
  294. *
  295. * @param ovi Pointer to an obs_video_info structure containing the
  296. * specification of the graphics subsystem,
  297. * @return OBS_VIDEO_SUCCESS if successful
  298. * OBS_VIDEO_NOT_SUPPORTED if the adapter lacks capabilities
  299. * OBS_VIDEO_INVALID_PARAM if a parameter is invalid
  300. * OBS_VIDEO_CURRENTLY_ACTIVE if video is currently active
  301. * OBS_VIDEO_MODULE_NOT_FOUND if the graphics module is not found
  302. * OBS_VIDEO_FAIL for generic failure
  303. */
  304. EXPORT int obs_reset_video(struct obs_video_info *ovi);
  305. /**
  306. * Sets base audio output format/channels/samples/etc
  307. *
  308. * @note Cannot reset base audio if an output is currently active.
  309. */
  310. EXPORT bool obs_reset_audio(const struct obs_audio_info *oai);
  311. /** Gets the current video settings, returns false if no video */
  312. EXPORT bool obs_get_video_info(struct obs_video_info *ovi);
  313. /** Gets the current audio settings, returns false if no audio */
  314. EXPORT bool obs_get_audio_info(struct obs_audio_info *oai);
  315. /**
  316. * Opens a plugin module directly from a specific path.
  317. *
  318. * If the module already exists then the function will return successful, and
  319. * the module parameter will be given the pointer to the existing module.
  320. *
  321. * This does not initialize the module, it only loads the module image. To
  322. * initialize the module, call obs_init_module.
  323. *
  324. * @param module The pointer to the created module.
  325. * @param path Specifies the path to the module library file. If the
  326. * extension is not specified, it will use the extension
  327. * appropriate to the operating system.
  328. * @param data_path Specifies the path to the directory where the module's
  329. * data files are stored.
  330. * @returns MODULE_SUCCESS if successful
  331. * MODULE_ERROR if a generic error occurred
  332. * MODULE_FILE_NOT_FOUND if the module was not found
  333. * MODULE_MISSING_EXPORTS if required exports are missing
  334. * MODULE_INCOMPATIBLE_VER if incompatible version
  335. */
  336. EXPORT int obs_open_module(obs_module_t **module, const char *path,
  337. const char *data_path);
  338. /**
  339. * Initializes the module, which calls its obs_module_load export. If the
  340. * module is already loaded, then this function does nothing and returns
  341. * successful.
  342. */
  343. EXPORT bool obs_init_module(obs_module_t *module);
  344. /** Logs loaded modules */
  345. EXPORT void obs_log_loaded_modules(void);
  346. /** Returns the module file name */
  347. EXPORT const char *obs_get_module_file_name(obs_module_t *module);
  348. /** Returns the module full name */
  349. EXPORT const char *obs_get_module_name(obs_module_t *module);
  350. /** Returns the module author(s) */
  351. EXPORT const char *obs_get_module_author(obs_module_t *module);
  352. /** Returns the module description */
  353. EXPORT const char *obs_get_module_description(obs_module_t *module);
  354. /** Returns the module binary path */
  355. EXPORT const char *obs_get_module_binary_path(obs_module_t *module);
  356. /** Returns the module data path */
  357. EXPORT const char *obs_get_module_data_path(obs_module_t *module);
  358. /**
  359. * Adds a module search path to be used with obs_find_modules. If the search
  360. * path strings contain %module%, that text will be replaced with the module
  361. * name when used.
  362. *
  363. * @param bin Specifies the module's binary directory search path.
  364. * @param data Specifies the module's data directory search path.
  365. */
  366. EXPORT void obs_add_module_path(const char *bin, const char *data);
  367. /** Automatically loads all modules from module paths (convenience function) */
  368. EXPORT void obs_load_all_modules(void);
  369. /** Notifies modules that all modules have been loaded. This function should
  370. * be called after all modules have been loaded. */
  371. EXPORT void obs_post_load_modules(void);
  372. #ifndef SWIG
  373. struct obs_module_info {
  374. const char *bin_path;
  375. const char *data_path;
  376. };
  377. typedef void (*obs_find_module_callback_t)(void *param,
  378. const struct obs_module_info *info);
  379. /** Finds all modules within the search paths added by obs_add_module_path. */
  380. EXPORT void obs_find_modules(obs_find_module_callback_t callback, void *param);
  381. #endif
  382. typedef void (*obs_enum_module_callback_t)(void *param, obs_module_t *module);
  383. /** Enumerates all loaded modules */
  384. EXPORT void obs_enum_modules(obs_enum_module_callback_t callback, void *param);
  385. /** Helper function for using default module locale */
  386. EXPORT lookup_t *obs_module_load_locale(obs_module_t *module,
  387. const char *default_locale, const char *locale);
  388. /**
  389. * Returns the location of a plugin module data file.
  390. *
  391. * @note Modules should use obs_module_file function defined in obs-module.h
  392. * as a more elegant means of getting their files without having to
  393. * specify the module parameter.
  394. *
  395. * @param module The module associated with the file to locate
  396. * @param file The file to locate
  397. * @return Path string, or NULL if not found. Use bfree to free string.
  398. */
  399. EXPORT char *obs_find_module_file(obs_module_t *module, const char *file);
  400. /**
  401. * Returns the path of a plugin module config file (whether it exists or not)
  402. *
  403. * @note Modules should use obs_module_config_path function defined in
  404. * obs-module.h as a more elegant means of getting their files without
  405. * having to specify the module parameter.
  406. *
  407. * @param module The module associated with the path
  408. * @param file The file to get a path to
  409. * @return Path string, or NULL if not found. Use bfree to free string.
  410. */
  411. EXPORT char *obs_module_get_config_path(obs_module_t *module, const char *file);
  412. /** Enumerates all source types (inputs, filters, transitions, etc). */
  413. EXPORT bool obs_enum_source_types(size_t idx, const char **id);
  414. /**
  415. * Enumerates all available inputs source types.
  416. *
  417. * Inputs are general source inputs (such as capture sources, device sources,
  418. * etc).
  419. */
  420. EXPORT bool obs_enum_input_types(size_t idx, const char **id);
  421. /**
  422. * Enumerates all available filter source types.
  423. *
  424. * Filters are sources that are used to modify the video/audio output of
  425. * other sources.
  426. */
  427. EXPORT bool obs_enum_filter_types(size_t idx, const char **id);
  428. /**
  429. * Enumerates all available transition source types.
  430. *
  431. * Transitions are sources used to transition between two or more other
  432. * sources.
  433. */
  434. EXPORT bool obs_enum_transition_types(size_t idx, const char **id);
  435. /** Enumerates all available output types. */
  436. EXPORT bool obs_enum_output_types(size_t idx, const char **id);
  437. /** Enumerates all available encoder types. */
  438. EXPORT bool obs_enum_encoder_types(size_t idx, const char **id);
  439. /** Enumerates all available service types. */
  440. EXPORT bool obs_enum_service_types(size_t idx, const char **id);
  441. /** Helper function for entering the OBS graphics context */
  442. EXPORT void obs_enter_graphics(void);
  443. /** Helper function for leaving the OBS graphics context */
  444. EXPORT void obs_leave_graphics(void);
  445. /** Gets the main audio output handler for this OBS context */
  446. EXPORT audio_t *obs_get_audio(void);
  447. /** Gets the main video output handler for this OBS context */
  448. EXPORT video_t *obs_get_video(void);
  449. /** Sets the primary output source for a channel. */
  450. EXPORT void obs_set_output_source(uint32_t channel, obs_source_t *source);
  451. /**
  452. * Gets the primary output source for a channel and increments the reference
  453. * counter for that source. Use obs_source_release to release.
  454. */
  455. EXPORT obs_source_t *obs_get_output_source(uint32_t channel);
  456. /**
  457. * Enumerates all input sources
  458. *
  459. * Callback function returns true to continue enumeration, or false to end
  460. * enumeration.
  461. *
  462. * Use obs_source_get_ref or obs_source_get_weak_source if you want to retain
  463. * a reference after obs_enum_sources finishes
  464. */
  465. EXPORT void obs_enum_sources(bool (*enum_proc)(void*, obs_source_t*),
  466. void *param);
  467. /** Enumerates scenes */
  468. EXPORT void obs_enum_scenes(bool (*enum_proc)(void*, obs_source_t*),
  469. void *param);
  470. /** Enumerates outputs */
  471. EXPORT void obs_enum_outputs(bool (*enum_proc)(void*, obs_output_t*),
  472. void *param);
  473. /** Enumerates encoders */
  474. EXPORT void obs_enum_encoders(bool (*enum_proc)(void*, obs_encoder_t*),
  475. void *param);
  476. /** Enumerates encoders */
  477. EXPORT void obs_enum_services(bool (*enum_proc)(void*, obs_service_t*),
  478. void *param);
  479. /**
  480. * Gets a source by its name.
  481. *
  482. * Increments the source reference counter, use obs_source_release to
  483. * release it when complete.
  484. */
  485. EXPORT obs_source_t *obs_get_source_by_name(const char *name);
  486. /** Gets an output by its name. */
  487. EXPORT obs_output_t *obs_get_output_by_name(const char *name);
  488. /** Gets an encoder by its name. */
  489. EXPORT obs_encoder_t *obs_get_encoder_by_name(const char *name);
  490. /** Gets an service by its name. */
  491. EXPORT obs_service_t *obs_get_service_by_name(const char *name);
  492. enum obs_base_effect {
  493. OBS_EFFECT_DEFAULT, /**< RGB/YUV */
  494. OBS_EFFECT_DEFAULT_RECT, /**< RGB/YUV (using texture_rect) */
  495. OBS_EFFECT_OPAQUE, /**< RGB/YUV (alpha set to 1.0) */
  496. OBS_EFFECT_SOLID, /**< RGB/YUV (solid color only) */
  497. OBS_EFFECT_BICUBIC, /**< Bicubic downscale */
  498. OBS_EFFECT_LANCZOS, /**< Lanczos downscale */
  499. OBS_EFFECT_BILINEAR_LOWRES, /**< Bilinear low resolution downscale */
  500. OBS_EFFECT_PREMULTIPLIED_ALPHA,/**< Premultiplied alpha */
  501. };
  502. /** Returns a commonly used base effect */
  503. EXPORT gs_effect_t *obs_get_base_effect(enum obs_base_effect effect);
  504. #ifndef SWIG
  505. /* DEPRECATED: gets texture_rect default effect */
  506. DEPRECATED
  507. EXPORT gs_effect_t *obs_get_default_rect_effect(void);
  508. #endif
  509. /** Returns the primary obs signal handler */
  510. EXPORT signal_handler_t *obs_get_signal_handler(void);
  511. /** Returns the primary obs procedure handler */
  512. EXPORT proc_handler_t *obs_get_proc_handler(void);
  513. #ifndef SWIG
  514. /** Renders the main view */
  515. DEPRECATED
  516. EXPORT void obs_render_main_view(void);
  517. #endif
  518. /** Renders the last main output texture */
  519. EXPORT void obs_render_main_texture(void);
  520. /** Returns the last main output texture. This can return NULL if the texture
  521. * is unavailable. */
  522. EXPORT gs_texture_t *obs_get_main_texture(void);
  523. /** Sets the master user volume */
  524. EXPORT void obs_set_master_volume(float volume);
  525. /** Gets the master user volume */
  526. EXPORT float obs_get_master_volume(void);
  527. /** Saves a source to settings data */
  528. EXPORT obs_data_t *obs_save_source(obs_source_t *source);
  529. /** Loads a source from settings data */
  530. EXPORT obs_source_t *obs_load_source(obs_data_t *data);
  531. /** Send a save signal to sources */
  532. EXPORT void obs_source_save(obs_source_t *source);
  533. /** Send a load signal to sources */
  534. EXPORT void obs_source_load(obs_source_t *source);
  535. typedef void (*obs_load_source_cb)(void *private_data, obs_source_t *source);
  536. /** Loads sources from a data array */
  537. EXPORT void obs_load_sources(obs_data_array_t *array, obs_load_source_cb cb,
  538. void *private_data);
  539. /** Saves sources to a data array */
  540. EXPORT obs_data_array_t *obs_save_sources(void);
  541. typedef bool (*obs_save_source_filter_cb)(void *data, obs_source_t *source);
  542. EXPORT obs_data_array_t *obs_save_sources_filtered(obs_save_source_filter_cb cb,
  543. void *data);
  544. enum obs_obj_type {
  545. OBS_OBJ_TYPE_INVALID,
  546. OBS_OBJ_TYPE_SOURCE,
  547. OBS_OBJ_TYPE_OUTPUT,
  548. OBS_OBJ_TYPE_ENCODER,
  549. OBS_OBJ_TYPE_SERVICE
  550. };
  551. EXPORT enum obs_obj_type obs_obj_get_type(void *obj);
  552. EXPORT const char *obs_obj_get_id(void *obj);
  553. EXPORT bool obs_obj_invalid(void *obj);
  554. typedef bool (*obs_enum_audio_device_cb)(void *data, const char *name,
  555. const char *id);
  556. EXPORT void obs_enum_audio_monitoring_devices(obs_enum_audio_device_cb cb,
  557. void *data);
  558. EXPORT bool obs_set_audio_monitoring_device(const char *name, const char *id);
  559. EXPORT void obs_get_audio_monitoring_device(const char **name, const char **id);
  560. EXPORT void obs_add_tick_callback(
  561. void (*tick)(void *param, float seconds),
  562. void *param);
  563. EXPORT void obs_remove_tick_callback(
  564. void (*tick)(void *param, float seconds),
  565. void *param);
  566. EXPORT void obs_add_main_render_callback(
  567. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  568. void *param);
  569. EXPORT void obs_remove_main_render_callback(
  570. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  571. void *param);
  572. EXPORT void obs_add_raw_video_callback(
  573. const struct video_scale_info *conversion,
  574. void (*callback)(void *param, struct video_data *frame),
  575. void *param);
  576. EXPORT void obs_remove_raw_video_callback(
  577. void (*callback)(void *param, struct video_data *frame),
  578. void *param);
  579. EXPORT uint64_t obs_get_video_frame_time(void);
  580. EXPORT double obs_get_active_fps(void);
  581. EXPORT uint64_t obs_get_average_frame_time_ns(void);
  582. EXPORT uint32_t obs_get_total_frames(void);
  583. EXPORT uint32_t obs_get_lagged_frames(void);
  584. EXPORT void obs_apply_private_data(obs_data_t *settings);
  585. EXPORT void obs_set_private_data(obs_data_t *settings);
  586. EXPORT obs_data_t *obs_get_private_data(void);
  587. /* ------------------------------------------------------------------------- */
  588. /* View context */
  589. /**
  590. * Creates a view context.
  591. *
  592. * A view can be used for things like separate previews, or drawing
  593. * sources separately.
  594. */
  595. EXPORT obs_view_t *obs_view_create(void);
  596. /** Destroys this view context */
  597. EXPORT void obs_view_destroy(obs_view_t *view);
  598. /** Sets the source to be used for this view context. */
  599. EXPORT void obs_view_set_source(obs_view_t *view, uint32_t channel,
  600. obs_source_t *source);
  601. /** Gets the source currently in use for this view context */
  602. EXPORT obs_source_t *obs_view_get_source(obs_view_t *view,
  603. uint32_t channel);
  604. /** Renders the sources of this view context */
  605. EXPORT void obs_view_render(obs_view_t *view);
  606. /* ------------------------------------------------------------------------- */
  607. /* Display context */
  608. /**
  609. * Adds a new window display linked to the main render pipeline. This creates
  610. * a new swap chain which updates every frame.
  611. *
  612. * @param graphics_data The swap chain initialization data.
  613. * @return The new display context, or NULL if failed.
  614. */
  615. EXPORT obs_display_t *obs_display_create(
  616. const struct gs_init_data *graphics_data,
  617. uint32_t backround_color);
  618. /** Destroys a display context */
  619. EXPORT void obs_display_destroy(obs_display_t *display);
  620. /** Changes the size of this display */
  621. EXPORT void obs_display_resize(obs_display_t *display, uint32_t cx,
  622. uint32_t cy);
  623. /**
  624. * Adds a draw callback for this display context
  625. *
  626. * @param display The display context.
  627. * @param draw The draw callback which is called each time a frame
  628. * updates.
  629. * @param param The user data to be associated with this draw callback.
  630. */
  631. EXPORT void obs_display_add_draw_callback(obs_display_t *display,
  632. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  633. void *param);
  634. /** Removes a draw callback for this display context */
  635. EXPORT void obs_display_remove_draw_callback(obs_display_t *display,
  636. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  637. void *param);
  638. EXPORT void obs_display_set_enabled(obs_display_t *display, bool enable);
  639. EXPORT bool obs_display_enabled(obs_display_t *display);
  640. EXPORT void obs_display_set_background_color(obs_display_t *display,
  641. uint32_t color);
  642. /* ------------------------------------------------------------------------- */
  643. /* Sources */
  644. /** Returns the translated display name of a source */
  645. EXPORT const char *obs_source_get_display_name(const char *id);
  646. /**
  647. * Creates a source of the specified type with the specified settings.
  648. *
  649. * The "source" context is used for anything related to presenting
  650. * or modifying video/audio. Use obs_source_release to release it.
  651. */
  652. EXPORT obs_source_t *obs_source_create(const char *id, const char *name,
  653. obs_data_t *settings, obs_data_t *hotkey_data);
  654. EXPORT obs_source_t *obs_source_create_private(const char *id,
  655. const char *name, obs_data_t *settings);
  656. /* if source has OBS_SOURCE_DO_NOT_DUPLICATE output flag set, only returns a
  657. * reference */
  658. EXPORT obs_source_t *obs_source_duplicate(obs_source_t *source,
  659. const char *desired_name, bool create_private);
  660. /**
  661. * Adds/releases a reference to a source. When the last reference is
  662. * released, the source is destroyed.
  663. */
  664. EXPORT void obs_source_addref(obs_source_t *source);
  665. EXPORT void obs_source_release(obs_source_t *source);
  666. EXPORT void obs_weak_source_addref(obs_weak_source_t *weak);
  667. EXPORT void obs_weak_source_release(obs_weak_source_t *weak);
  668. EXPORT obs_source_t *obs_source_get_ref(obs_source_t *source);
  669. EXPORT obs_weak_source_t *obs_source_get_weak_source(obs_source_t *source);
  670. EXPORT obs_source_t *obs_weak_source_get_source(obs_weak_source_t *weak);
  671. EXPORT bool obs_weak_source_references_source(obs_weak_source_t *weak,
  672. obs_source_t *source);
  673. /** Notifies all references that the source should be released */
  674. EXPORT void obs_source_remove(obs_source_t *source);
  675. /** Returns true if the source should be released */
  676. EXPORT bool obs_source_removed(const obs_source_t *source);
  677. /** Returns capability flags of a source */
  678. EXPORT uint32_t obs_source_get_output_flags(const obs_source_t *source);
  679. /** Returns capability flags of a source type */
  680. EXPORT uint32_t obs_get_source_output_flags(const char *id);
  681. /** Gets the default settings for a source type */
  682. EXPORT obs_data_t *obs_get_source_defaults(const char *id);
  683. /** Returns the property list, if any. Free with obs_properties_destroy */
  684. EXPORT obs_properties_t *obs_get_source_properties(const char *id);
  685. /** Returns whether the source has custom properties or not */
  686. EXPORT bool obs_is_source_configurable(const char *id);
  687. EXPORT bool obs_source_configurable(const obs_source_t *source);
  688. /**
  689. * Returns the properties list for a specific existing source. Free with
  690. * obs_properties_destroy
  691. */
  692. EXPORT obs_properties_t *obs_source_properties(const obs_source_t *source);
  693. /** Updates settings for this source */
  694. EXPORT void obs_source_update(obs_source_t *source, obs_data_t *settings);
  695. /** Renders a video source. */
  696. EXPORT void obs_source_video_render(obs_source_t *source);
  697. /** Gets the width of a source (if it has video) */
  698. EXPORT uint32_t obs_source_get_width(obs_source_t *source);
  699. /** Gets the height of a source (if it has video) */
  700. EXPORT uint32_t obs_source_get_height(obs_source_t *source);
  701. /**
  702. * If the source is a filter, returns the parent source of the filter. Only
  703. * guaranteed to be valid inside of the video_render, filter_audio,
  704. * filter_video, and filter_remove callbacks.
  705. */
  706. EXPORT obs_source_t *obs_filter_get_parent(const obs_source_t *filter);
  707. /**
  708. * If the source is a filter, returns the target source of the filter. Only
  709. * guaranteed to be valid inside of the video_render, filter_audio,
  710. * filter_video, and filter_remove callbacks.
  711. */
  712. EXPORT obs_source_t *obs_filter_get_target(const obs_source_t *filter);
  713. /** Used to directly render a non-async source without any filter processing */
  714. EXPORT void obs_source_default_render(obs_source_t *source);
  715. /** Adds a filter to the source (which is used whenever the source is used) */
  716. EXPORT void obs_source_filter_add(obs_source_t *source, obs_source_t *filter);
  717. /** Removes a filter from the source */
  718. EXPORT void obs_source_filter_remove(obs_source_t *source,
  719. obs_source_t *filter);
  720. /** Modifies the order of a specific filter */
  721. EXPORT void obs_source_filter_set_order(obs_source_t *source,
  722. obs_source_t *filter, enum obs_order_movement movement);
  723. /** Gets the settings string for a source */
  724. EXPORT obs_data_t *obs_source_get_settings(const obs_source_t *source);
  725. /** Gets the name of a source */
  726. EXPORT const char *obs_source_get_name(const obs_source_t *source);
  727. /** Sets the name of a source */
  728. EXPORT void obs_source_set_name(obs_source_t *source, const char *name);
  729. /** Gets the source type */
  730. EXPORT enum obs_source_type obs_source_get_type(const obs_source_t *source);
  731. /** Gets the source identifier */
  732. EXPORT const char *obs_source_get_id(const obs_source_t *source);
  733. /** Returns the signal handler for a source */
  734. EXPORT signal_handler_t *obs_source_get_signal_handler(
  735. const obs_source_t *source);
  736. /** Returns the procedure handler for a source */
  737. EXPORT proc_handler_t *obs_source_get_proc_handler(const obs_source_t *source);
  738. /** Sets the user volume for a source that has audio output */
  739. EXPORT void obs_source_set_volume(obs_source_t *source, float volume);
  740. /** Gets the user volume for a source that has audio output */
  741. EXPORT float obs_source_get_volume(const obs_source_t *source);
  742. /* Gets speaker layout of a source */
  743. EXPORT enum speaker_layout obs_source_get_speaker_layout(obs_source_t *source);
  744. /** Sets the balance value for a stereo audio source */
  745. EXPORT void obs_source_set_balance_value(obs_source_t *source, float balance);
  746. /** Gets the balance value for a stereo audio source */
  747. EXPORT float obs_source_get_balance_value(const obs_source_t *source);
  748. /** Sets the audio sync offset (in nanoseconds) for a source */
  749. EXPORT void obs_source_set_sync_offset(obs_source_t *source, int64_t offset);
  750. /** Gets the audio sync offset (in nanoseconds) for a source */
  751. EXPORT int64_t obs_source_get_sync_offset(const obs_source_t *source);
  752. /** Enumerates active child sources used by this source */
  753. EXPORT void obs_source_enum_active_sources(obs_source_t *source,
  754. obs_source_enum_proc_t enum_callback,
  755. void *param);
  756. /** Enumerates the entire active child source tree used by this source */
  757. EXPORT void obs_source_enum_active_tree(obs_source_t *source,
  758. obs_source_enum_proc_t enum_callback,
  759. void *param);
  760. /** Returns true if active, false if not */
  761. EXPORT bool obs_source_active(const obs_source_t *source);
  762. /**
  763. * Returns true if currently displayed somewhere (active or not), false if not
  764. */
  765. EXPORT bool obs_source_showing(const obs_source_t *source);
  766. /** Unused flag */
  767. #define OBS_SOURCE_FLAG_UNUSED_1 (1<<0)
  768. /** Specifies to force audio to mono */
  769. #define OBS_SOURCE_FLAG_FORCE_MONO (1<<1)
  770. /**
  771. * Sets source flags. Note that these are different from the main output
  772. * flags. These are generally things that can be set by the source or user,
  773. * while the output flags are more used to determine capabilities of a source.
  774. */
  775. EXPORT void obs_source_set_flags(obs_source_t *source, uint32_t flags);
  776. /** Gets source flags. */
  777. EXPORT uint32_t obs_source_get_flags(const obs_source_t *source);
  778. /**
  779. * Sets audio mixer flags. These flags are used to specify which mixers
  780. * the source's audio should be applied to.
  781. */
  782. EXPORT void obs_source_set_audio_mixers(obs_source_t *source, uint32_t mixers);
  783. /** Gets audio mixer flags */
  784. EXPORT uint32_t obs_source_get_audio_mixers(const obs_source_t *source);
  785. /**
  786. * Increments the 'showing' reference counter to indicate that the source is
  787. * being shown somewhere. If the reference counter was 0, will call the 'show'
  788. * callback.
  789. */
  790. EXPORT void obs_source_inc_showing(obs_source_t *source);
  791. /**
  792. * Decrements the 'showing' reference counter to indicate that the source is
  793. * no longer being shown somewhere. If the reference counter is set to 0,
  794. * will call the 'hide' callback
  795. */
  796. EXPORT void obs_source_dec_showing(obs_source_t *source);
  797. /** Enumerates filters assigned to the source */
  798. EXPORT void obs_source_enum_filters(obs_source_t *source,
  799. obs_source_enum_proc_t callback, void *param);
  800. /** Gets a filter of a source by its display name. */
  801. EXPORT obs_source_t *obs_source_get_filter_by_name(obs_source_t *source,
  802. const char *name);
  803. EXPORT void obs_source_copy_filters(obs_source_t *dst, obs_source_t *src);
  804. EXPORT bool obs_source_enabled(const obs_source_t *source);
  805. EXPORT void obs_source_set_enabled(obs_source_t *source, bool enabled);
  806. EXPORT bool obs_source_muted(const obs_source_t *source);
  807. EXPORT void obs_source_set_muted(obs_source_t *source, bool muted);
  808. EXPORT bool obs_source_push_to_mute_enabled(obs_source_t *source);
  809. EXPORT void obs_source_enable_push_to_mute(obs_source_t *source, bool enabled);
  810. EXPORT uint64_t obs_source_get_push_to_mute_delay(obs_source_t *source);
  811. EXPORT void obs_source_set_push_to_mute_delay(obs_source_t *source,
  812. uint64_t delay);
  813. EXPORT bool obs_source_push_to_talk_enabled(obs_source_t *source);
  814. EXPORT void obs_source_enable_push_to_talk(obs_source_t *source, bool enabled);
  815. EXPORT uint64_t obs_source_get_push_to_talk_delay(obs_source_t *source);
  816. EXPORT void obs_source_set_push_to_talk_delay(obs_source_t *source,
  817. uint64_t delay);
  818. typedef void (*obs_source_audio_capture_t)(void *param, obs_source_t *source,
  819. const struct audio_data *audio_data, bool muted);
  820. EXPORT void obs_source_add_audio_capture_callback(obs_source_t *source,
  821. obs_source_audio_capture_t callback, void *param);
  822. EXPORT void obs_source_remove_audio_capture_callback(obs_source_t *source,
  823. obs_source_audio_capture_t callback, void *param);
  824. enum obs_deinterlace_mode {
  825. OBS_DEINTERLACE_MODE_DISABLE,
  826. OBS_DEINTERLACE_MODE_DISCARD,
  827. OBS_DEINTERLACE_MODE_RETRO,
  828. OBS_DEINTERLACE_MODE_BLEND,
  829. OBS_DEINTERLACE_MODE_BLEND_2X,
  830. OBS_DEINTERLACE_MODE_LINEAR,
  831. OBS_DEINTERLACE_MODE_LINEAR_2X,
  832. OBS_DEINTERLACE_MODE_YADIF,
  833. OBS_DEINTERLACE_MODE_YADIF_2X
  834. };
  835. enum obs_deinterlace_field_order {
  836. OBS_DEINTERLACE_FIELD_ORDER_TOP,
  837. OBS_DEINTERLACE_FIELD_ORDER_BOTTOM
  838. };
  839. EXPORT void obs_source_set_deinterlace_mode(obs_source_t *source,
  840. enum obs_deinterlace_mode mode);
  841. EXPORT enum obs_deinterlace_mode obs_source_get_deinterlace_mode(
  842. const obs_source_t *source);
  843. EXPORT void obs_source_set_deinterlace_field_order(obs_source_t *source,
  844. enum obs_deinterlace_field_order field_order);
  845. EXPORT enum obs_deinterlace_field_order obs_source_get_deinterlace_field_order(
  846. const obs_source_t *source);
  847. enum obs_monitoring_type {
  848. OBS_MONITORING_TYPE_NONE,
  849. OBS_MONITORING_TYPE_MONITOR_ONLY,
  850. OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT
  851. };
  852. EXPORT void obs_source_set_monitoring_type(obs_source_t *source,
  853. enum obs_monitoring_type type);
  854. EXPORT enum obs_monitoring_type obs_source_get_monitoring_type(
  855. const obs_source_t *source);
  856. /** Gets private front-end settings data. This data is saved/loaded
  857. * automatically. Returns an incremented reference. */
  858. EXPORT obs_data_t *obs_source_get_private_settings(obs_source_t *item);
  859. /* ------------------------------------------------------------------------- */
  860. /* Functions used by sources */
  861. EXPORT void *obs_source_get_type_data(obs_source_t *source);
  862. /**
  863. * Helper function to set the color matrix information when drawing the source.
  864. *
  865. * @param color_matrix The color matrix. Assigns to the 'color_matrix'
  866. * effect variable.
  867. * @param color_range_min The minimum color range. Assigns to the
  868. * 'color_range_min' effect variable. If NULL,
  869. * {0.0f, 0.0f, 0.0f} is used.
  870. * @param color_range_max The maximum color range. Assigns to the
  871. * 'color_range_max' effect variable. If NULL,
  872. * {1.0f, 1.0f, 1.0f} is used.
  873. */
  874. EXPORT void obs_source_draw_set_color_matrix(
  875. const struct matrix4 *color_matrix,
  876. const struct vec3 *color_range_min,
  877. const struct vec3 *color_range_max);
  878. /**
  879. * Helper function to draw sprites for a source (synchronous video).
  880. *
  881. * @param image The sprite texture to draw. Assigns to the 'image' variable
  882. * of the current effect.
  883. * @param x X position of the sprite.
  884. * @param y Y position of the sprite.
  885. * @param cx Width of the sprite. If 0, uses the texture width.
  886. * @param cy Height of the sprite. If 0, uses the texture height.
  887. * @param flip Specifies whether to flip the image vertically.
  888. */
  889. EXPORT void obs_source_draw(gs_texture_t *image, int x, int y,
  890. uint32_t cx, uint32_t cy, bool flip);
  891. /** Outputs asynchronous video data. Set to NULL to deactivate the texture */
  892. EXPORT void obs_source_output_video(obs_source_t *source,
  893. const struct obs_source_frame *frame);
  894. /** Preloads asynchronous video data to allow instantaneous playback */
  895. EXPORT void obs_source_preload_video(obs_source_t *source,
  896. const struct obs_source_frame *frame);
  897. /** Shows any preloaded video data */
  898. EXPORT void obs_source_show_preloaded_video(obs_source_t *source);
  899. /** Outputs audio data (always asynchronous) */
  900. EXPORT void obs_source_output_audio(obs_source_t *source,
  901. const struct obs_source_audio *audio);
  902. /** Signal an update to any currently used properties via 'update_properties' */
  903. EXPORT void obs_source_update_properties(obs_source_t *source);
  904. /** Gets the current async video frame */
  905. EXPORT struct obs_source_frame *obs_source_get_frame(obs_source_t *source);
  906. /** Releases the current async video frame */
  907. EXPORT void obs_source_release_frame(obs_source_t *source,
  908. struct obs_source_frame *frame);
  909. /**
  910. * Default RGB filter handler for generic effect filters. Processes the
  911. * filter chain and renders them to texture if needed, then the filter is
  912. * drawn with
  913. *
  914. * After calling this, set your parameters for the effect, then call
  915. * obs_source_process_filter_end to draw the filter.
  916. *
  917. * Returns true if filtering should continue, false if the filter is bypassed
  918. * for whatever reason.
  919. */
  920. EXPORT bool obs_source_process_filter_begin(obs_source_t *filter,
  921. enum gs_color_format format,
  922. enum obs_allow_direct_render allow_direct);
  923. /**
  924. * Draws the filter.
  925. *
  926. * Before calling this function, first call obs_source_process_filter_begin and
  927. * then set the effect parameters, and then call this function to finalize the
  928. * filter.
  929. */
  930. EXPORT void obs_source_process_filter_end(obs_source_t *filter,
  931. gs_effect_t *effect, uint32_t width, uint32_t height);
  932. /**
  933. * Draws the filter with a specific technique.
  934. *
  935. * Before calling this function, first call obs_source_process_filter_begin and
  936. * then set the effect parameters, and then call this function to finalize the
  937. * filter.
  938. */
  939. EXPORT void obs_source_process_filter_tech_end(obs_source_t *filter,
  940. gs_effect_t *effect, uint32_t width, uint32_t height,
  941. const char *tech_name);
  942. /** Skips the filter if the filter is invalid and cannot be rendered */
  943. EXPORT void obs_source_skip_video_filter(obs_source_t *filter);
  944. /**
  945. * Adds an active child source. Must be called by parent sources on child
  946. * sources when the child is added and active. This ensures that the source is
  947. * properly activated if the parent is active.
  948. *
  949. * @returns true if source can be added, false if it causes recursion
  950. */
  951. EXPORT bool obs_source_add_active_child(obs_source_t *parent,
  952. obs_source_t *child);
  953. /**
  954. * Removes an active child source. Must be called by parent sources on child
  955. * sources when the child is removed or inactive. This ensures that the source
  956. * is properly deactivated if the parent is no longer active.
  957. */
  958. EXPORT void obs_source_remove_active_child(obs_source_t *parent,
  959. obs_source_t *child);
  960. /** Sends a mouse down/up event to a source */
  961. EXPORT void obs_source_send_mouse_click(obs_source_t *source,
  962. const struct obs_mouse_event *event,
  963. int32_t type, bool mouse_up,
  964. uint32_t click_count);
  965. /** Sends a mouse move event to a source. */
  966. EXPORT void obs_source_send_mouse_move(obs_source_t *source,
  967. const struct obs_mouse_event *event, bool mouse_leave);
  968. /** Sends a mouse wheel event to a source */
  969. EXPORT void obs_source_send_mouse_wheel(obs_source_t *source,
  970. const struct obs_mouse_event *event, int x_delta, int y_delta);
  971. /** Sends a got-focus or lost-focus event to a source */
  972. EXPORT void obs_source_send_focus(obs_source_t *source, bool focus);
  973. /** Sends a key up/down event to a source */
  974. EXPORT void obs_source_send_key_click(obs_source_t *source,
  975. const struct obs_key_event *event, bool key_up);
  976. /** Sets the default source flags. */
  977. EXPORT void obs_source_set_default_flags(obs_source_t *source, uint32_t flags);
  978. /** Gets the base width for a source (not taking in to account filtering) */
  979. EXPORT uint32_t obs_source_get_base_width(obs_source_t *source);
  980. /** Gets the base height for a source (not taking in to account filtering) */
  981. EXPORT uint32_t obs_source_get_base_height(obs_source_t *source);
  982. EXPORT bool obs_source_audio_pending(const obs_source_t *source);
  983. EXPORT uint64_t obs_source_get_audio_timestamp(const obs_source_t *source);
  984. EXPORT void obs_source_get_audio_mix(const obs_source_t *source,
  985. struct obs_source_audio_mix *audio);
  986. EXPORT void obs_source_set_async_unbuffered(obs_source_t *source,
  987. bool unbuffered);
  988. EXPORT bool obs_source_async_unbuffered(const obs_source_t *source);
  989. /** Used to decouple audio from video so that audio doesn't attempt to sync up
  990. * with video. I.E. Audio acts independently. Only works when in unbuffered
  991. * mode. */
  992. EXPORT void obs_source_set_async_decoupled(obs_source_t *source, bool decouple);
  993. EXPORT bool obs_source_async_decoupled(const obs_source_t *source);
  994. /* ------------------------------------------------------------------------- */
  995. /* Transition-specific functions */
  996. enum obs_transition_target {
  997. OBS_TRANSITION_SOURCE_A,
  998. OBS_TRANSITION_SOURCE_B
  999. };
  1000. EXPORT obs_source_t *obs_transition_get_source(obs_source_t *transition,
  1001. enum obs_transition_target target);
  1002. EXPORT void obs_transition_clear(obs_source_t *transition);
  1003. EXPORT obs_source_t *obs_transition_get_active_source(obs_source_t *transition);
  1004. enum obs_transition_mode {
  1005. OBS_TRANSITION_MODE_AUTO,
  1006. };
  1007. EXPORT bool obs_transition_start(obs_source_t *transition,
  1008. enum obs_transition_mode mode, uint32_t duration_ms,
  1009. obs_source_t *dest);
  1010. EXPORT void obs_transition_set(obs_source_t *transition, obs_source_t *source);
  1011. enum obs_transition_scale_type {
  1012. OBS_TRANSITION_SCALE_MAX_ONLY,
  1013. OBS_TRANSITION_SCALE_ASPECT,
  1014. OBS_TRANSITION_SCALE_STRETCH,
  1015. };
  1016. EXPORT void obs_transition_set_scale_type(obs_source_t *transition,
  1017. enum obs_transition_scale_type type);
  1018. EXPORT enum obs_transition_scale_type obs_transition_get_scale_type(
  1019. const obs_source_t *transition);
  1020. EXPORT void obs_transition_set_alignment(obs_source_t *transition,
  1021. uint32_t alignment);
  1022. EXPORT uint32_t obs_transition_get_alignment(const obs_source_t *transition);
  1023. EXPORT void obs_transition_set_size(obs_source_t *transition,
  1024. uint32_t cx, uint32_t cy);
  1025. EXPORT void obs_transition_get_size(const obs_source_t *transition,
  1026. uint32_t *cx, uint32_t *cy);
  1027. /* function used by transitions */
  1028. /**
  1029. * Enables fixed transitions (videos or specific types of transitions that
  1030. * are of fixed duration and linearly interpolated
  1031. */
  1032. EXPORT void obs_transition_enable_fixed(obs_source_t *transition, bool enable,
  1033. uint32_t duration_ms);
  1034. EXPORT bool obs_transition_fixed(obs_source_t *transition);
  1035. typedef void (*obs_transition_video_render_callback_t)(void *data,
  1036. gs_texture_t *a, gs_texture_t *b, float t,
  1037. uint32_t cx, uint32_t cy);
  1038. typedef float (*obs_transition_audio_mix_callback_t)(void *data, float t);
  1039. EXPORT float obs_transition_get_time(obs_source_t *transition);
  1040. EXPORT void obs_transition_video_render(obs_source_t *transition,
  1041. obs_transition_video_render_callback_t callback);
  1042. /** Directly renders its sub-source instead of to texture. Returns false if no
  1043. * longer transitioning */
  1044. EXPORT bool obs_transition_video_render_direct(obs_source_t *transition,
  1045. enum obs_transition_target target);
  1046. EXPORT bool obs_transition_audio_render(obs_source_t *transition,
  1047. uint64_t *ts_out, struct obs_source_audio_mix *audio,
  1048. uint32_t mixers, size_t channels, size_t sample_rate,
  1049. obs_transition_audio_mix_callback_t mix_a_callback,
  1050. obs_transition_audio_mix_callback_t mix_b_callback);
  1051. /* swaps transition sources and textures as an optimization and to reduce
  1052. * memory usage when switching between transitions */
  1053. EXPORT void obs_transition_swap_begin(obs_source_t *tr_dest,
  1054. obs_source_t *tr_source);
  1055. EXPORT void obs_transition_swap_end(obs_source_t *tr_dest,
  1056. obs_source_t *tr_source);
  1057. /* ------------------------------------------------------------------------- */
  1058. /* Scenes */
  1059. /**
  1060. * Creates a scene.
  1061. *
  1062. * A scene is a source which is a container of other sources with specific
  1063. * display orientations. Scenes can also be used like any other source.
  1064. */
  1065. EXPORT obs_scene_t *obs_scene_create(const char *name);
  1066. EXPORT obs_scene_t *obs_scene_create_private(const char *name);
  1067. enum obs_scene_duplicate_type {
  1068. OBS_SCENE_DUP_REFS, /**< Source refs only */
  1069. OBS_SCENE_DUP_COPY, /**< Fully duplicate */
  1070. OBS_SCENE_DUP_PRIVATE_REFS, /**< Source refs only (as private) */
  1071. OBS_SCENE_DUP_PRIVATE_COPY /**< Fully duplicate (as private) */
  1072. };
  1073. /**
  1074. * Duplicates a scene.
  1075. */
  1076. EXPORT obs_scene_t *obs_scene_duplicate(obs_scene_t *scene, const char *name,
  1077. enum obs_scene_duplicate_type type);
  1078. EXPORT void obs_scene_addref(obs_scene_t *scene);
  1079. EXPORT void obs_scene_release(obs_scene_t *scene);
  1080. /** Gets the scene's source context */
  1081. EXPORT obs_source_t *obs_scene_get_source(const obs_scene_t *scene);
  1082. /** Gets the scene from its source, or NULL if not a scene */
  1083. EXPORT obs_scene_t *obs_scene_from_source(const obs_source_t *source);
  1084. /** Determines whether a source is within a scene */
  1085. EXPORT obs_sceneitem_t *obs_scene_find_source(obs_scene_t *scene,
  1086. const char *name);
  1087. EXPORT obs_sceneitem_t *obs_scene_find_sceneitem_by_id(obs_scene_t *scene,
  1088. int64_t id);
  1089. /** Enumerates sources within a scene */
  1090. EXPORT void obs_scene_enum_items(obs_scene_t *scene,
  1091. bool (*callback)(obs_scene_t*, obs_sceneitem_t*, void*),
  1092. void *param);
  1093. EXPORT bool obs_scene_reorder_items(obs_scene_t *scene,
  1094. obs_sceneitem_t * const *item_order, size_t item_order_size);
  1095. struct obs_sceneitem_order_info {
  1096. obs_sceneitem_t *group;
  1097. obs_sceneitem_t *item;
  1098. };
  1099. EXPORT bool obs_scene_reorder_items2(obs_scene_t *scene,
  1100. struct obs_sceneitem_order_info *item_order,
  1101. size_t item_order_size);
  1102. /** Adds/creates a new scene item for a source */
  1103. EXPORT obs_sceneitem_t *obs_scene_add(obs_scene_t *scene, obs_source_t *source);
  1104. typedef void (*obs_scene_atomic_update_func)(void *, obs_scene_t *scene);
  1105. EXPORT void obs_scene_atomic_update(obs_scene_t *scene,
  1106. obs_scene_atomic_update_func func, void *data);
  1107. EXPORT void obs_sceneitem_addref(obs_sceneitem_t *item);
  1108. EXPORT void obs_sceneitem_release(obs_sceneitem_t *item);
  1109. /** Removes a scene item. */
  1110. EXPORT void obs_sceneitem_remove(obs_sceneitem_t *item);
  1111. /** Gets the scene parent associated with the scene item. */
  1112. EXPORT obs_scene_t *obs_sceneitem_get_scene(const obs_sceneitem_t *item);
  1113. /** Gets the source of a scene item. */
  1114. EXPORT obs_source_t *obs_sceneitem_get_source(const obs_sceneitem_t *item);
  1115. /* FIXME: The following functions should be deprecated and replaced with a way
  1116. * to specify savable private user data. -Jim */
  1117. EXPORT void obs_sceneitem_select(obs_sceneitem_t *item, bool select);
  1118. EXPORT bool obs_sceneitem_selected(const obs_sceneitem_t *item);
  1119. EXPORT bool obs_sceneitem_locked(const obs_sceneitem_t *item);
  1120. EXPORT bool obs_sceneitem_set_locked(obs_sceneitem_t *item, bool lock);
  1121. /* Functions for getting/setting specific orientation of a scene item */
  1122. EXPORT void obs_sceneitem_set_pos(obs_sceneitem_t *item, const struct vec2 *pos);
  1123. EXPORT void obs_sceneitem_set_rot(obs_sceneitem_t *item, float rot_deg);
  1124. EXPORT void obs_sceneitem_set_scale(obs_sceneitem_t *item,
  1125. const struct vec2 *scale);
  1126. EXPORT void obs_sceneitem_set_alignment(obs_sceneitem_t *item,
  1127. uint32_t alignment);
  1128. EXPORT void obs_sceneitem_set_order(obs_sceneitem_t *item,
  1129. enum obs_order_movement movement);
  1130. EXPORT void obs_sceneitem_set_order_position(obs_sceneitem_t *item,
  1131. int position);
  1132. EXPORT void obs_sceneitem_set_bounds_type(obs_sceneitem_t *item,
  1133. enum obs_bounds_type type);
  1134. EXPORT void obs_sceneitem_set_bounds_alignment(obs_sceneitem_t *item,
  1135. uint32_t alignment);
  1136. EXPORT void obs_sceneitem_set_bounds(obs_sceneitem_t *item,
  1137. const struct vec2 *bounds);
  1138. EXPORT int64_t obs_sceneitem_get_id(const obs_sceneitem_t *item);
  1139. EXPORT void obs_sceneitem_get_pos(const obs_sceneitem_t *item,
  1140. struct vec2 *pos);
  1141. EXPORT float obs_sceneitem_get_rot(const obs_sceneitem_t *item);
  1142. EXPORT void obs_sceneitem_get_scale(const obs_sceneitem_t *item,
  1143. struct vec2 *scale);
  1144. EXPORT uint32_t obs_sceneitem_get_alignment(const obs_sceneitem_t *item);
  1145. EXPORT enum obs_bounds_type obs_sceneitem_get_bounds_type(
  1146. const obs_sceneitem_t *item);
  1147. EXPORT uint32_t obs_sceneitem_get_bounds_alignment(const obs_sceneitem_t *item);
  1148. EXPORT void obs_sceneitem_get_bounds(const obs_sceneitem_t *item,
  1149. struct vec2 *bounds);
  1150. EXPORT void obs_sceneitem_get_info(const obs_sceneitem_t *item,
  1151. struct obs_transform_info *info);
  1152. EXPORT void obs_sceneitem_set_info(obs_sceneitem_t *item,
  1153. const struct obs_transform_info *info);
  1154. EXPORT void obs_sceneitem_get_draw_transform(const obs_sceneitem_t *item,
  1155. struct matrix4 *transform);
  1156. EXPORT void obs_sceneitem_get_box_transform(const obs_sceneitem_t *item,
  1157. struct matrix4 *transform);
  1158. EXPORT bool obs_sceneitem_visible(const obs_sceneitem_t *item);
  1159. EXPORT bool obs_sceneitem_set_visible(obs_sceneitem_t *item, bool visible);
  1160. struct obs_sceneitem_crop {
  1161. int left;
  1162. int top;
  1163. int right;
  1164. int bottom;
  1165. };
  1166. EXPORT void obs_sceneitem_set_crop(obs_sceneitem_t *item,
  1167. const struct obs_sceneitem_crop *crop);
  1168. EXPORT void obs_sceneitem_get_crop(const obs_sceneitem_t *item,
  1169. struct obs_sceneitem_crop *crop);
  1170. EXPORT void obs_sceneitem_set_scale_filter(obs_sceneitem_t *item,
  1171. enum obs_scale_type filter);
  1172. EXPORT enum obs_scale_type obs_sceneitem_get_scale_filter(
  1173. obs_sceneitem_t *item);
  1174. EXPORT void obs_sceneitem_force_update_transform(obs_sceneitem_t *item);
  1175. EXPORT void obs_sceneitem_defer_update_begin(obs_sceneitem_t *item);
  1176. EXPORT void obs_sceneitem_defer_update_end(obs_sceneitem_t *item);
  1177. /** Gets private front-end settings data. This data is saved/loaded
  1178. * automatically. Returns an incremented reference. */
  1179. EXPORT obs_data_t *obs_sceneitem_get_private_settings(obs_sceneitem_t *item);
  1180. EXPORT obs_sceneitem_t *obs_scene_add_group(obs_scene_t *scene,
  1181. const char *name);
  1182. EXPORT obs_sceneitem_t *obs_scene_insert_group(obs_scene_t *scene,
  1183. const char *name, obs_sceneitem_t **items, size_t count);
  1184. EXPORT obs_sceneitem_t *obs_scene_get_group(obs_scene_t *scene,
  1185. const char *name);
  1186. EXPORT bool obs_sceneitem_is_group(obs_sceneitem_t *item);
  1187. EXPORT obs_scene_t *obs_sceneitem_group_get_scene(
  1188. const obs_sceneitem_t *group);
  1189. EXPORT void obs_sceneitem_group_ungroup(obs_sceneitem_t *group);
  1190. EXPORT void obs_sceneitem_group_add_item(obs_sceneitem_t *group,
  1191. obs_sceneitem_t *item);
  1192. EXPORT void obs_sceneitem_group_remove_item(obs_sceneitem_t *group,
  1193. obs_sceneitem_t *item);
  1194. EXPORT obs_sceneitem_t *obs_sceneitem_get_group(obs_scene_t *scene,
  1195. obs_sceneitem_t *item);
  1196. EXPORT bool obs_source_is_group(const obs_source_t *source);
  1197. EXPORT bool obs_scene_is_group(const obs_scene_t *scene);
  1198. EXPORT void obs_sceneitem_group_enum_items(obs_sceneitem_t *group,
  1199. bool (*callback)(obs_scene_t*, obs_sceneitem_t*, void*),
  1200. void *param);
  1201. EXPORT void obs_sceneitem_defer_group_resize_begin(obs_sceneitem_t *item);
  1202. EXPORT void obs_sceneitem_defer_group_resize_end(obs_sceneitem_t *item);
  1203. /* ------------------------------------------------------------------------- */
  1204. /* Outputs */
  1205. EXPORT const char *obs_output_get_display_name(const char *id);
  1206. /**
  1207. * Creates an output.
  1208. *
  1209. * Outputs allow outputting to file, outputting to network, outputting to
  1210. * directshow, or other custom outputs.
  1211. */
  1212. EXPORT obs_output_t *obs_output_create(const char *id, const char *name,
  1213. obs_data_t *settings, obs_data_t *hotkey_data);
  1214. /**
  1215. * Adds/releases a reference to an output. When the last reference is
  1216. * released, the output is destroyed.
  1217. */
  1218. EXPORT void obs_output_addref(obs_output_t *output);
  1219. EXPORT void obs_output_release(obs_output_t *output);
  1220. EXPORT void obs_weak_output_addref(obs_weak_output_t *weak);
  1221. EXPORT void obs_weak_output_release(obs_weak_output_t *weak);
  1222. EXPORT obs_output_t *obs_output_get_ref(obs_output_t *output);
  1223. EXPORT obs_weak_output_t *obs_output_get_weak_output(obs_output_t *output);
  1224. EXPORT obs_output_t *obs_weak_output_get_output(obs_weak_output_t *weak);
  1225. EXPORT bool obs_weak_output_references_output(obs_weak_output_t *weak,
  1226. obs_output_t *output);
  1227. EXPORT const char *obs_output_get_name(const obs_output_t *output);
  1228. /** Starts the output. */
  1229. EXPORT bool obs_output_start(obs_output_t *output);
  1230. /** Stops the output. */
  1231. EXPORT void obs_output_stop(obs_output_t *output);
  1232. /**
  1233. * On reconnection, start where it left of on reconnection. Note however that
  1234. * this option will consume extra memory to continually increase delay while
  1235. * waiting to reconnect.
  1236. */
  1237. #define OBS_OUTPUT_DELAY_PRESERVE (1<<0)
  1238. /**
  1239. * Sets the current output delay, in seconds (if the output supports delay).
  1240. *
  1241. * If delay is currently active, it will set the delay value, but will not
  1242. * affect the current delay, it will only affect the next time the output is
  1243. * activated.
  1244. */
  1245. EXPORT void obs_output_set_delay(obs_output_t *output, uint32_t delay_sec,
  1246. uint32_t flags);
  1247. /** Gets the currently set delay value, in seconds. */
  1248. EXPORT uint32_t obs_output_get_delay(const obs_output_t *output);
  1249. /** If delay is active, gets the currently active delay value, in seconds. */
  1250. EXPORT uint32_t obs_output_get_active_delay(const obs_output_t *output);
  1251. /** Forces the output to stop. Usually only used with delay. */
  1252. EXPORT void obs_output_force_stop(obs_output_t *output);
  1253. /** Returns whether the output is active */
  1254. EXPORT bool obs_output_active(const obs_output_t *output);
  1255. /** Returns output capability flags */
  1256. EXPORT uint32_t obs_output_get_flags(const obs_output_t *output);
  1257. /** Returns output capability flags */
  1258. EXPORT uint32_t obs_get_output_flags(const char *id);
  1259. /** Gets the default settings for an output type */
  1260. EXPORT obs_data_t *obs_output_defaults(const char *id);
  1261. /** Returns the property list, if any. Free with obs_properties_destroy */
  1262. EXPORT obs_properties_t *obs_get_output_properties(const char *id);
  1263. /**
  1264. * Returns the property list of an existing output, if any. Free with
  1265. * obs_properties_destroy
  1266. */
  1267. EXPORT obs_properties_t *obs_output_properties(const obs_output_t *output);
  1268. /** Updates the settings for this output context */
  1269. EXPORT void obs_output_update(obs_output_t *output, obs_data_t *settings);
  1270. /** Specifies whether the output can be paused */
  1271. EXPORT bool obs_output_can_pause(const obs_output_t *output);
  1272. /** Pauses the output (if the functionality is allowed by the output */
  1273. EXPORT void obs_output_pause(obs_output_t *output);
  1274. /* Gets the current output settings string */
  1275. EXPORT obs_data_t *obs_output_get_settings(const obs_output_t *output);
  1276. /** Returns the signal handler for an output */
  1277. EXPORT signal_handler_t *obs_output_get_signal_handler(
  1278. const obs_output_t *output);
  1279. /** Returns the procedure handler for an output */
  1280. EXPORT proc_handler_t *obs_output_get_proc_handler(const obs_output_t *output);
  1281. /**
  1282. * Sets the current audio/video media contexts associated with this output,
  1283. * required for non-encoded outputs. Can be null.
  1284. */
  1285. EXPORT void obs_output_set_media(obs_output_t *output,
  1286. video_t *video, audio_t *audio);
  1287. /** Returns the video media context associated with this output */
  1288. EXPORT video_t *obs_output_video(const obs_output_t *output);
  1289. /** Returns the audio media context associated with this output */
  1290. EXPORT audio_t *obs_output_audio(const obs_output_t *output);
  1291. /** Sets the current audio mixer for non-encoded outputs */
  1292. EXPORT void obs_output_set_mixer(obs_output_t *output, size_t mixer_idx);
  1293. /** Gets the current audio mixer for non-encoded outputs */
  1294. EXPORT size_t obs_output_get_mixer(const obs_output_t *output);
  1295. /** Sets the current audio mixes (mask) for a non-encoded multi-track output */
  1296. EXPORT void obs_output_set_mixers(obs_output_t *output, size_t mixers);
  1297. /** Gets the current audio mixes (mask) for a non-encoded multi-track output */
  1298. EXPORT size_t obs_output_get_mixers(const obs_output_t *output);
  1299. /**
  1300. * Sets the current video encoder associated with this output,
  1301. * required for encoded outputs
  1302. */
  1303. EXPORT void obs_output_set_video_encoder(obs_output_t *output,
  1304. obs_encoder_t *encoder);
  1305. /**
  1306. * Sets the current audio encoder associated with this output,
  1307. * required for encoded outputs.
  1308. *
  1309. * The idx parameter specifies the audio encoder index to set the encoder to.
  1310. * Only used with outputs that have multiple audio outputs (RTMP typically),
  1311. * otherwise the parameter is ignored.
  1312. */
  1313. EXPORT void obs_output_set_audio_encoder(obs_output_t *output,
  1314. obs_encoder_t *encoder, size_t idx);
  1315. /** Returns the current video encoder associated with this output */
  1316. EXPORT obs_encoder_t *obs_output_get_video_encoder(const obs_output_t *output);
  1317. /**
  1318. * Returns the current audio encoder associated with this output
  1319. *
  1320. * The idx parameter specifies the audio encoder index. Only used with
  1321. * outputs that have multiple audio outputs, otherwise the parameter is
  1322. * ignored.
  1323. */
  1324. EXPORT obs_encoder_t *obs_output_get_audio_encoder(const obs_output_t *output,
  1325. size_t idx);
  1326. /** Sets the current service associated with this output. */
  1327. EXPORT void obs_output_set_service(obs_output_t *output,
  1328. obs_service_t *service);
  1329. /** Gets the current service associated with this output. */
  1330. EXPORT obs_service_t *obs_output_get_service(const obs_output_t *output);
  1331. /**
  1332. * Sets the reconnect settings. Set retry_count to 0 to disable reconnecting.
  1333. */
  1334. EXPORT void obs_output_set_reconnect_settings(obs_output_t *output,
  1335. int retry_count, int retry_sec);
  1336. EXPORT uint64_t obs_output_get_total_bytes(const obs_output_t *output);
  1337. EXPORT int obs_output_get_frames_dropped(const obs_output_t *output);
  1338. EXPORT int obs_output_get_total_frames(const obs_output_t *output);
  1339. /**
  1340. * Sets the preferred scaled resolution for this output. Set width and height
  1341. * to 0 to disable scaling.
  1342. *
  1343. * If this output uses an encoder, it will call obs_encoder_set_scaled_size on
  1344. * the encoder before the stream is started. If the encoder is already active,
  1345. * then this function will trigger a warning and do nothing.
  1346. */
  1347. EXPORT void obs_output_set_preferred_size(obs_output_t *output, uint32_t width,
  1348. uint32_t height);
  1349. /** For video outputs, returns the width of the encoded image */
  1350. EXPORT uint32_t obs_output_get_width(const obs_output_t *output);
  1351. /** For video outputs, returns the height of the encoded image */
  1352. EXPORT uint32_t obs_output_get_height(const obs_output_t *output);
  1353. EXPORT const char *obs_output_get_id(const obs_output_t *output);
  1354. #if BUILD_CAPTIONS
  1355. EXPORT void obs_output_output_caption_text1(obs_output_t *output,
  1356. const char *text);
  1357. #endif
  1358. EXPORT float obs_output_get_congestion(obs_output_t *output);
  1359. EXPORT int obs_output_get_connect_time_ms(obs_output_t *output);
  1360. EXPORT bool obs_output_reconnecting(const obs_output_t *output);
  1361. /** Pass a string of the last output error, for UI use */
  1362. EXPORT void obs_output_set_last_error(obs_output_t *output,
  1363. const char *message);
  1364. EXPORT const char *obs_output_get_last_error(obs_output_t *output);
  1365. EXPORT const char *obs_output_get_supported_video_codecs(
  1366. const obs_output_t *output);
  1367. EXPORT const char *obs_output_get_supported_audio_codecs(
  1368. const obs_output_t *output);
  1369. /* ------------------------------------------------------------------------- */
  1370. /* Functions used by outputs */
  1371. EXPORT void *obs_output_get_type_data(obs_output_t *output);
  1372. /** Optionally sets the video conversion info. Used only for raw output */
  1373. EXPORT void obs_output_set_video_conversion(obs_output_t *output,
  1374. const struct video_scale_info *conversion);
  1375. /** Optionally sets the audio conversion info. Used only for raw output */
  1376. EXPORT void obs_output_set_audio_conversion(obs_output_t *output,
  1377. const struct audio_convert_info *conversion);
  1378. /** Returns whether data capture can begin with the specified flags */
  1379. EXPORT bool obs_output_can_begin_data_capture(const obs_output_t *output,
  1380. uint32_t flags);
  1381. /** Initializes encoders (if any) */
  1382. EXPORT bool obs_output_initialize_encoders(obs_output_t *output,
  1383. uint32_t flags);
  1384. /**
  1385. * Begins data capture from media/encoders.
  1386. *
  1387. * @param output Output context
  1388. * @param flags Set this to 0 to use default output flags set in the
  1389. * obs_output_info structure, otherwise set to a either
  1390. * OBS_OUTPUT_VIDEO or OBS_OUTPUT_AUDIO to specify whether to
  1391. * connect audio or video. This is useful for things like
  1392. * ffmpeg which may or may not always want to use both audio
  1393. * and video.
  1394. * @return true if successful, false otherwise.
  1395. */
  1396. EXPORT bool obs_output_begin_data_capture(obs_output_t *output, uint32_t flags);
  1397. /** Ends data capture from media/encoders */
  1398. EXPORT void obs_output_end_data_capture(obs_output_t *output);
  1399. /**
  1400. * Signals that the output has stopped itself.
  1401. *
  1402. * @param output Output context
  1403. * @param code Error code (or OBS_OUTPUT_SUCCESS if not an error)
  1404. */
  1405. EXPORT void obs_output_signal_stop(obs_output_t *output, int code);
  1406. /* ------------------------------------------------------------------------- */
  1407. /* Encoders */
  1408. EXPORT const char *obs_encoder_get_display_name(const char *id);
  1409. /**
  1410. * Creates a video encoder context
  1411. *
  1412. * @param id Video encoder ID
  1413. * @param name Name to assign to this context
  1414. * @param settings Settings
  1415. * @return The video encoder context, or NULL if failed or not found.
  1416. */
  1417. EXPORT obs_encoder_t *obs_video_encoder_create(const char *id, const char *name,
  1418. obs_data_t *settings, obs_data_t *hotkey_data);
  1419. /**
  1420. * Creates an audio encoder context
  1421. *
  1422. * @param id Audio Encoder ID
  1423. * @param name Name to assign to this context
  1424. * @param settings Settings
  1425. * @param mixer_idx Index of the mixer to use for this audio encoder
  1426. * @return The video encoder context, or NULL if failed or not found.
  1427. */
  1428. EXPORT obs_encoder_t *obs_audio_encoder_create(const char *id, const char *name,
  1429. obs_data_t *settings, size_t mixer_idx,
  1430. obs_data_t *hotkey_data);
  1431. /**
  1432. * Adds/releases a reference to an encoder. When the last reference is
  1433. * released, the encoder is destroyed.
  1434. */
  1435. EXPORT void obs_encoder_addref(obs_encoder_t *encoder);
  1436. EXPORT void obs_encoder_release(obs_encoder_t *encoder);
  1437. EXPORT void obs_weak_encoder_addref(obs_weak_encoder_t *weak);
  1438. EXPORT void obs_weak_encoder_release(obs_weak_encoder_t *weak);
  1439. EXPORT obs_encoder_t *obs_encoder_get_ref(obs_encoder_t *encoder);
  1440. EXPORT obs_weak_encoder_t *obs_encoder_get_weak_encoder(obs_encoder_t *encoder);
  1441. EXPORT obs_encoder_t *obs_weak_encoder_get_encoder(obs_weak_encoder_t *weak);
  1442. EXPORT bool obs_weak_encoder_references_encoder(obs_weak_encoder_t *weak,
  1443. obs_encoder_t *encoder);
  1444. EXPORT void obs_encoder_set_name(obs_encoder_t *encoder, const char *name);
  1445. EXPORT const char *obs_encoder_get_name(const obs_encoder_t *encoder);
  1446. /** Returns the codec of an encoder by the id */
  1447. EXPORT const char *obs_get_encoder_codec(const char *id);
  1448. /** Returns the type of an encoder by the id */
  1449. EXPORT enum obs_encoder_type obs_get_encoder_type(const char *id);
  1450. /** Returns the codec of the encoder */
  1451. EXPORT const char *obs_encoder_get_codec(const obs_encoder_t *encoder);
  1452. /** Returns the type of an encoder */
  1453. EXPORT enum obs_encoder_type obs_encoder_get_type(const obs_encoder_t *encoder);
  1454. /**
  1455. * Sets the scaled resolution for a video encoder. Set width and height to 0
  1456. * to disable scaling. If the encoder is active, this function will trigger
  1457. * a warning, and do nothing.
  1458. */
  1459. EXPORT void obs_encoder_set_scaled_size(obs_encoder_t *encoder, uint32_t width,
  1460. uint32_t height);
  1461. /** For video encoders, returns the width of the encoded image */
  1462. EXPORT uint32_t obs_encoder_get_width(const obs_encoder_t *encoder);
  1463. /** For video encoders, returns the height of the encoded image */
  1464. EXPORT uint32_t obs_encoder_get_height(const obs_encoder_t *encoder);
  1465. /** For audio encoders, returns the sample rate of the audio */
  1466. EXPORT uint32_t obs_encoder_get_sample_rate(const obs_encoder_t *encoder);
  1467. /**
  1468. * Sets the preferred video format for a video encoder. If the encoder can use
  1469. * the format specified, it will force a conversion to that format if the
  1470. * obs output format does not match the preferred format.
  1471. *
  1472. * If the format is set to VIDEO_FORMAT_NONE, will revert to the default
  1473. * functionality of converting only when absolutely necessary.
  1474. */
  1475. EXPORT void obs_encoder_set_preferred_video_format(obs_encoder_t *encoder,
  1476. enum video_format format);
  1477. EXPORT enum video_format obs_encoder_get_preferred_video_format(
  1478. const obs_encoder_t *encoder);
  1479. /** Gets the default settings for an encoder type */
  1480. EXPORT obs_data_t *obs_encoder_defaults(const char *id);
  1481. EXPORT obs_data_t *obs_encoder_get_defaults(const obs_encoder_t *encoder);
  1482. /** Returns the property list, if any. Free with obs_properties_destroy */
  1483. EXPORT obs_properties_t *obs_get_encoder_properties(const char *id);
  1484. /**
  1485. * Returns the property list of an existing encoder, if any. Free with
  1486. * obs_properties_destroy
  1487. */
  1488. EXPORT obs_properties_t *obs_encoder_properties(const obs_encoder_t *encoder);
  1489. /**
  1490. * Updates the settings of the encoder context. Usually used for changing
  1491. * bitrate while active
  1492. */
  1493. EXPORT void obs_encoder_update(obs_encoder_t *encoder, obs_data_t *settings);
  1494. /** Gets extra data (headers) associated with this context */
  1495. EXPORT bool obs_encoder_get_extra_data(const obs_encoder_t *encoder,
  1496. uint8_t **extra_data, size_t *size);
  1497. /** Returns the current settings for this encoder */
  1498. EXPORT obs_data_t *obs_encoder_get_settings(const obs_encoder_t *encoder);
  1499. /** Sets the video output context to be used with this encoder */
  1500. EXPORT void obs_encoder_set_video(obs_encoder_t *encoder, video_t *video);
  1501. /** Sets the audio output context to be used with this encoder */
  1502. EXPORT void obs_encoder_set_audio(obs_encoder_t *encoder, audio_t *audio);
  1503. /**
  1504. * Returns the video output context used with this encoder, or NULL if not
  1505. * a video context
  1506. */
  1507. EXPORT video_t *obs_encoder_video(const obs_encoder_t *encoder);
  1508. /**
  1509. * Returns the audio output context used with this encoder, or NULL if not
  1510. * a audio context
  1511. */
  1512. EXPORT audio_t *obs_encoder_audio(const obs_encoder_t *encoder);
  1513. /** Returns true if encoder is active, false otherwise */
  1514. EXPORT bool obs_encoder_active(const obs_encoder_t *encoder);
  1515. EXPORT void *obs_encoder_get_type_data(obs_encoder_t *encoder);
  1516. EXPORT const char *obs_encoder_get_id(const obs_encoder_t *encoder);
  1517. EXPORT uint32_t obs_get_encoder_caps(const char *encoder_id);
  1518. #ifndef SWIG
  1519. /** Duplicates an encoder packet */
  1520. DEPRECATED
  1521. EXPORT void obs_duplicate_encoder_packet(struct encoder_packet *dst,
  1522. const struct encoder_packet *src);
  1523. DEPRECATED
  1524. EXPORT void obs_free_encoder_packet(struct encoder_packet *packet);
  1525. #endif
  1526. EXPORT void obs_encoder_packet_ref(struct encoder_packet *dst,
  1527. struct encoder_packet *src);
  1528. EXPORT void obs_encoder_packet_release(struct encoder_packet *packet);
  1529. /* ------------------------------------------------------------------------- */
  1530. /* Stream Services */
  1531. EXPORT const char *obs_service_get_display_name(const char *id);
  1532. EXPORT obs_service_t *obs_service_create(const char *id, const char *name,
  1533. obs_data_t *settings, obs_data_t *hotkey_data);
  1534. EXPORT obs_service_t *obs_service_create_private(const char *id,
  1535. const char *name, obs_data_t *settings);
  1536. /**
  1537. * Adds/releases a reference to a service. When the last reference is
  1538. * released, the service is destroyed.
  1539. */
  1540. EXPORT void obs_service_addref(obs_service_t *service);
  1541. EXPORT void obs_service_release(obs_service_t *service);
  1542. EXPORT void obs_weak_service_addref(obs_weak_service_t *weak);
  1543. EXPORT void obs_weak_service_release(obs_weak_service_t *weak);
  1544. EXPORT obs_service_t *obs_service_get_ref(obs_service_t *service);
  1545. EXPORT obs_weak_service_t *obs_service_get_weak_service(obs_service_t *service);
  1546. EXPORT obs_service_t *obs_weak_service_get_service(obs_weak_service_t *weak);
  1547. EXPORT bool obs_weak_service_references_service(obs_weak_service_t *weak,
  1548. obs_service_t *service);
  1549. EXPORT const char *obs_service_get_name(const obs_service_t *service);
  1550. /** Gets the default settings for a service */
  1551. EXPORT obs_data_t *obs_service_defaults(const char *id);
  1552. /** Returns the property list, if any. Free with obs_properties_destroy */
  1553. EXPORT obs_properties_t *obs_get_service_properties(const char *id);
  1554. /**
  1555. * Returns the property list of an existing service context, if any. Free with
  1556. * obs_properties_destroy
  1557. */
  1558. EXPORT obs_properties_t *obs_service_properties(const obs_service_t *service);
  1559. /** Gets the service type */
  1560. EXPORT const char *obs_service_get_type(const obs_service_t *service);
  1561. /** Updates the settings of the service context */
  1562. EXPORT void obs_service_update(obs_service_t *service, obs_data_t *settings);
  1563. /** Returns the current settings for this service */
  1564. EXPORT obs_data_t *obs_service_get_settings(const obs_service_t *service);
  1565. /** Returns the URL for this service context */
  1566. EXPORT const char *obs_service_get_url(const obs_service_t *service);
  1567. /** Returns the stream key (if any) for this service context */
  1568. EXPORT const char *obs_service_get_key(const obs_service_t *service);
  1569. /** Returns the username (if any) for this service context */
  1570. EXPORT const char *obs_service_get_username(const obs_service_t *service);
  1571. /** Returns the password (if any) for this service context */
  1572. EXPORT const char *obs_service_get_password(const obs_service_t *service);
  1573. /**
  1574. * Applies service-specific video encoder settings.
  1575. *
  1576. * @param video_encoder_settings Video encoder settings. Optional.
  1577. * @param audio_encoder_settings Audio encoder settings. Optional.
  1578. */
  1579. EXPORT void obs_service_apply_encoder_settings(obs_service_t *service,
  1580. obs_data_t *video_encoder_settings,
  1581. obs_data_t *audio_encoder_settings);
  1582. EXPORT void *obs_service_get_type_data(obs_service_t *service);
  1583. EXPORT const char *obs_service_get_id(const obs_service_t *service);
  1584. /* NOTE: This function is temporary and should be removed/replaced at a later
  1585. * date. */
  1586. EXPORT const char *obs_service_get_output_type(const obs_service_t *service);
  1587. /* ------------------------------------------------------------------------- */
  1588. /* Source frame allocation functions */
  1589. EXPORT void obs_source_frame_init(struct obs_source_frame *frame,
  1590. enum video_format format, uint32_t width, uint32_t height);
  1591. static inline void obs_source_frame_free(struct obs_source_frame *frame)
  1592. {
  1593. if (frame) {
  1594. bfree(frame->data[0]);
  1595. memset(frame, 0, sizeof(*frame));
  1596. }
  1597. }
  1598. static inline struct obs_source_frame *obs_source_frame_create(
  1599. enum video_format format, uint32_t width, uint32_t height)
  1600. {
  1601. struct obs_source_frame *frame;
  1602. frame = (struct obs_source_frame*)bzalloc(sizeof(*frame));
  1603. obs_source_frame_init(frame, format, width, height);
  1604. return frame;
  1605. }
  1606. static inline void obs_source_frame_destroy(struct obs_source_frame *frame)
  1607. {
  1608. if (frame) {
  1609. bfree(frame->data[0]);
  1610. bfree(frame);
  1611. }
  1612. }
  1613. EXPORT void obs_source_frame_copy(struct obs_source_frame *dst,
  1614. const struct obs_source_frame *src);
  1615. #ifdef __cplusplus
  1616. }
  1617. #endif