obs.h 72 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063
  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, const char * const *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. /** Returns true if video is active, false otherwise */
  450. EXPORT bool obs_video_active(void);
  451. /** Sets the primary output source for a channel. */
  452. EXPORT void obs_set_output_source(uint32_t channel, obs_source_t *source);
  453. /**
  454. * Gets the primary output source for a channel and increments the reference
  455. * counter for that source. Use obs_source_release to release.
  456. */
  457. EXPORT obs_source_t *obs_get_output_source(uint32_t channel);
  458. /**
  459. * Enumerates all input sources
  460. *
  461. * Callback function returns true to continue enumeration, or false to end
  462. * enumeration.
  463. *
  464. * Use obs_source_get_ref or obs_source_get_weak_source if you want to retain
  465. * a reference after obs_enum_sources finishes
  466. */
  467. EXPORT void obs_enum_sources(bool (*enum_proc)(void*, obs_source_t*),
  468. void *param);
  469. /** Enumerates scenes */
  470. EXPORT void obs_enum_scenes(bool (*enum_proc)(void*, obs_source_t*),
  471. void *param);
  472. /** Enumerates outputs */
  473. EXPORT void obs_enum_outputs(bool (*enum_proc)(void*, obs_output_t*),
  474. void *param);
  475. /** Enumerates encoders */
  476. EXPORT void obs_enum_encoders(bool (*enum_proc)(void*, obs_encoder_t*),
  477. void *param);
  478. /** Enumerates encoders */
  479. EXPORT void obs_enum_services(bool (*enum_proc)(void*, obs_service_t*),
  480. void *param);
  481. /**
  482. * Gets a source by its name.
  483. *
  484. * Increments the source reference counter, use obs_source_release to
  485. * release it when complete.
  486. */
  487. EXPORT obs_source_t *obs_get_source_by_name(const char *name);
  488. /** Gets an output by its name. */
  489. EXPORT obs_output_t *obs_get_output_by_name(const char *name);
  490. /** Gets an encoder by its name. */
  491. EXPORT obs_encoder_t *obs_get_encoder_by_name(const char *name);
  492. /** Gets an service by its name. */
  493. EXPORT obs_service_t *obs_get_service_by_name(const char *name);
  494. enum obs_base_effect {
  495. OBS_EFFECT_DEFAULT, /**< RGB/YUV */
  496. OBS_EFFECT_DEFAULT_RECT, /**< RGB/YUV (using texture_rect) */
  497. OBS_EFFECT_OPAQUE, /**< RGB/YUV (alpha set to 1.0) */
  498. OBS_EFFECT_SOLID, /**< RGB/YUV (solid color only) */
  499. OBS_EFFECT_BICUBIC, /**< Bicubic downscale */
  500. OBS_EFFECT_LANCZOS, /**< Lanczos downscale */
  501. OBS_EFFECT_BILINEAR_LOWRES, /**< Bilinear low resolution downscale */
  502. OBS_EFFECT_PREMULTIPLIED_ALPHA,/**< Premultiplied alpha */
  503. OBS_EFFECT_REPEAT, /**< RGB/YUV (repeating) */
  504. };
  505. /** Returns a commonly used base effect */
  506. EXPORT gs_effect_t *obs_get_base_effect(enum obs_base_effect effect);
  507. #ifndef SWIG
  508. /* DEPRECATED: gets texture_rect default effect */
  509. DEPRECATED
  510. EXPORT gs_effect_t *obs_get_default_rect_effect(void);
  511. #endif
  512. /** Returns the primary obs signal handler */
  513. EXPORT signal_handler_t *obs_get_signal_handler(void);
  514. /** Returns the primary obs procedure handler */
  515. EXPORT proc_handler_t *obs_get_proc_handler(void);
  516. #ifndef SWIG
  517. /** Renders the main view */
  518. DEPRECATED
  519. EXPORT void obs_render_main_view(void);
  520. #endif
  521. /** Renders the last main output texture */
  522. EXPORT void obs_render_main_texture(void);
  523. /** Returns the last main output texture. This can return NULL if the texture
  524. * is unavailable. */
  525. EXPORT gs_texture_t *obs_get_main_texture(void);
  526. /** Sets the master user volume */
  527. EXPORT void obs_set_master_volume(float volume);
  528. /** Gets the master user volume */
  529. EXPORT float obs_get_master_volume(void);
  530. /** Saves a source to settings data */
  531. EXPORT obs_data_t *obs_save_source(obs_source_t *source);
  532. /** Loads a source from settings data */
  533. EXPORT obs_source_t *obs_load_source(obs_data_t *data);
  534. /** Send a save signal to sources */
  535. EXPORT void obs_source_save(obs_source_t *source);
  536. /** Send a load signal to sources */
  537. EXPORT void obs_source_load(obs_source_t *source);
  538. typedef void (*obs_load_source_cb)(void *private_data, obs_source_t *source);
  539. /** Loads sources from a data array */
  540. EXPORT void obs_load_sources(obs_data_array_t *array, obs_load_source_cb cb,
  541. void *private_data);
  542. /** Saves sources to a data array */
  543. EXPORT obs_data_array_t *obs_save_sources(void);
  544. typedef bool (*obs_save_source_filter_cb)(void *data, obs_source_t *source);
  545. EXPORT obs_data_array_t *obs_save_sources_filtered(obs_save_source_filter_cb cb,
  546. void *data);
  547. enum obs_obj_type {
  548. OBS_OBJ_TYPE_INVALID,
  549. OBS_OBJ_TYPE_SOURCE,
  550. OBS_OBJ_TYPE_OUTPUT,
  551. OBS_OBJ_TYPE_ENCODER,
  552. OBS_OBJ_TYPE_SERVICE
  553. };
  554. EXPORT enum obs_obj_type obs_obj_get_type(void *obj);
  555. EXPORT const char *obs_obj_get_id(void *obj);
  556. EXPORT bool obs_obj_invalid(void *obj);
  557. typedef bool (*obs_enum_audio_device_cb)(void *data, const char *name,
  558. const char *id);
  559. EXPORT void obs_enum_audio_monitoring_devices(obs_enum_audio_device_cb cb,
  560. void *data);
  561. EXPORT bool obs_set_audio_monitoring_device(const char *name, const char *id);
  562. EXPORT void obs_get_audio_monitoring_device(const char **name, const char **id);
  563. EXPORT void obs_add_tick_callback(
  564. void (*tick)(void *param, float seconds),
  565. void *param);
  566. EXPORT void obs_remove_tick_callback(
  567. void (*tick)(void *param, float seconds),
  568. void *param);
  569. EXPORT void obs_add_main_render_callback(
  570. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  571. void *param);
  572. EXPORT void obs_remove_main_render_callback(
  573. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  574. void *param);
  575. EXPORT void obs_add_raw_video_callback(
  576. const struct video_scale_info *conversion,
  577. void (*callback)(void *param, struct video_data *frame),
  578. void *param);
  579. EXPORT void obs_remove_raw_video_callback(
  580. void (*callback)(void *param, struct video_data *frame),
  581. void *param);
  582. EXPORT uint64_t obs_get_video_frame_time(void);
  583. EXPORT double obs_get_active_fps(void);
  584. EXPORT uint64_t obs_get_average_frame_time_ns(void);
  585. EXPORT uint32_t obs_get_total_frames(void);
  586. EXPORT uint32_t obs_get_lagged_frames(void);
  587. EXPORT bool obs_nv12_tex_active(void);
  588. EXPORT void obs_apply_private_data(obs_data_t *settings);
  589. EXPORT void obs_set_private_data(obs_data_t *settings);
  590. EXPORT obs_data_t *obs_get_private_data(void);
  591. /* ------------------------------------------------------------------------- */
  592. /* View context */
  593. /**
  594. * Creates a view context.
  595. *
  596. * A view can be used for things like separate previews, or drawing
  597. * sources separately.
  598. */
  599. EXPORT obs_view_t *obs_view_create(void);
  600. /** Destroys this view context */
  601. EXPORT void obs_view_destroy(obs_view_t *view);
  602. /** Sets the source to be used for this view context. */
  603. EXPORT void obs_view_set_source(obs_view_t *view, uint32_t channel,
  604. obs_source_t *source);
  605. /** Gets the source currently in use for this view context */
  606. EXPORT obs_source_t *obs_view_get_source(obs_view_t *view,
  607. uint32_t channel);
  608. /** Renders the sources of this view context */
  609. EXPORT void obs_view_render(obs_view_t *view);
  610. /* ------------------------------------------------------------------------- */
  611. /* Display context */
  612. /**
  613. * Adds a new window display linked to the main render pipeline. This creates
  614. * a new swap chain which updates every frame.
  615. *
  616. * @param graphics_data The swap chain initialization data.
  617. * @return The new display context, or NULL if failed.
  618. */
  619. EXPORT obs_display_t *obs_display_create(
  620. const struct gs_init_data *graphics_data,
  621. uint32_t backround_color);
  622. /** Destroys a display context */
  623. EXPORT void obs_display_destroy(obs_display_t *display);
  624. /** Changes the size of this display */
  625. EXPORT void obs_display_resize(obs_display_t *display, uint32_t cx,
  626. uint32_t cy);
  627. /**
  628. * Adds a draw callback for this display context
  629. *
  630. * @param display The display context.
  631. * @param draw The draw callback which is called each time a frame
  632. * updates.
  633. * @param param The user data to be associated with this draw callback.
  634. */
  635. EXPORT void obs_display_add_draw_callback(obs_display_t *display,
  636. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  637. void *param);
  638. /** Removes a draw callback for this display context */
  639. EXPORT void obs_display_remove_draw_callback(obs_display_t *display,
  640. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  641. void *param);
  642. EXPORT void obs_display_set_enabled(obs_display_t *display, bool enable);
  643. EXPORT bool obs_display_enabled(obs_display_t *display);
  644. EXPORT void obs_display_set_background_color(obs_display_t *display,
  645. uint32_t color);
  646. /* ------------------------------------------------------------------------- */
  647. /* Sources */
  648. /** Returns the translated display name of a source */
  649. EXPORT const char *obs_source_get_display_name(const char *id);
  650. /**
  651. * Creates a source of the specified type with the specified settings.
  652. *
  653. * The "source" context is used for anything related to presenting
  654. * or modifying video/audio. Use obs_source_release to release it.
  655. */
  656. EXPORT obs_source_t *obs_source_create(const char *id, const char *name,
  657. obs_data_t *settings, obs_data_t *hotkey_data);
  658. EXPORT obs_source_t *obs_source_create_private(const char *id,
  659. const char *name, obs_data_t *settings);
  660. /* if source has OBS_SOURCE_DO_NOT_DUPLICATE output flag set, only returns a
  661. * reference */
  662. EXPORT obs_source_t *obs_source_duplicate(obs_source_t *source,
  663. const char *desired_name, bool create_private);
  664. /**
  665. * Adds/releases a reference to a source. When the last reference is
  666. * released, the source is destroyed.
  667. */
  668. EXPORT void obs_source_addref(obs_source_t *source);
  669. EXPORT void obs_source_release(obs_source_t *source);
  670. EXPORT void obs_weak_source_addref(obs_weak_source_t *weak);
  671. EXPORT void obs_weak_source_release(obs_weak_source_t *weak);
  672. EXPORT obs_source_t *obs_source_get_ref(obs_source_t *source);
  673. EXPORT obs_weak_source_t *obs_source_get_weak_source(obs_source_t *source);
  674. EXPORT obs_source_t *obs_weak_source_get_source(obs_weak_source_t *weak);
  675. EXPORT bool obs_weak_source_references_source(obs_weak_source_t *weak,
  676. obs_source_t *source);
  677. /** Notifies all references that the source should be released */
  678. EXPORT void obs_source_remove(obs_source_t *source);
  679. /** Returns true if the source should be released */
  680. EXPORT bool obs_source_removed(const obs_source_t *source);
  681. /** Returns capability flags of a source */
  682. EXPORT uint32_t obs_source_get_output_flags(const obs_source_t *source);
  683. /** Returns capability flags of a source type */
  684. EXPORT uint32_t obs_get_source_output_flags(const char *id);
  685. /** Gets the default settings for a source type */
  686. EXPORT obs_data_t *obs_get_source_defaults(const char *id);
  687. /** Returns the property list, if any. Free with obs_properties_destroy */
  688. EXPORT obs_properties_t *obs_get_source_properties(const char *id);
  689. /** Returns whether the source has custom properties or not */
  690. EXPORT bool obs_is_source_configurable(const char *id);
  691. EXPORT bool obs_source_configurable(const obs_source_t *source);
  692. /**
  693. * Returns the properties list for a specific existing source. Free with
  694. * obs_properties_destroy
  695. */
  696. EXPORT obs_properties_t *obs_source_properties(const obs_source_t *source);
  697. /** Updates settings for this source */
  698. EXPORT void obs_source_update(obs_source_t *source, obs_data_t *settings);
  699. /** Renders a video source. */
  700. EXPORT void obs_source_video_render(obs_source_t *source);
  701. /** Gets the width of a source (if it has video) */
  702. EXPORT uint32_t obs_source_get_width(obs_source_t *source);
  703. /** Gets the height of a source (if it has video) */
  704. EXPORT uint32_t obs_source_get_height(obs_source_t *source);
  705. /**
  706. * If the source is a filter, returns the parent source of the filter. Only
  707. * guaranteed to be valid inside of the video_render, filter_audio,
  708. * filter_video, and filter_remove callbacks.
  709. */
  710. EXPORT obs_source_t *obs_filter_get_parent(const obs_source_t *filter);
  711. /**
  712. * If the source is a filter, returns the target source of the filter. Only
  713. * guaranteed to be valid inside of the video_render, filter_audio,
  714. * filter_video, and filter_remove callbacks.
  715. */
  716. EXPORT obs_source_t *obs_filter_get_target(const obs_source_t *filter);
  717. /** Used to directly render a non-async source without any filter processing */
  718. EXPORT void obs_source_default_render(obs_source_t *source);
  719. /** Adds a filter to the source (which is used whenever the source is used) */
  720. EXPORT void obs_source_filter_add(obs_source_t *source, obs_source_t *filter);
  721. /** Removes a filter from the source */
  722. EXPORT void obs_source_filter_remove(obs_source_t *source,
  723. obs_source_t *filter);
  724. /** Modifies the order of a specific filter */
  725. EXPORT void obs_source_filter_set_order(obs_source_t *source,
  726. obs_source_t *filter, enum obs_order_movement movement);
  727. /** Gets the settings string for a source */
  728. EXPORT obs_data_t *obs_source_get_settings(const obs_source_t *source);
  729. /** Gets the name of a source */
  730. EXPORT const char *obs_source_get_name(const obs_source_t *source);
  731. /** Sets the name of a source */
  732. EXPORT void obs_source_set_name(obs_source_t *source, const char *name);
  733. /** Gets the source type */
  734. EXPORT enum obs_source_type obs_source_get_type(const obs_source_t *source);
  735. /** Gets the source identifier */
  736. EXPORT const char *obs_source_get_id(const obs_source_t *source);
  737. /** Returns the signal handler for a source */
  738. EXPORT signal_handler_t *obs_source_get_signal_handler(
  739. const obs_source_t *source);
  740. /** Returns the procedure handler for a source */
  741. EXPORT proc_handler_t *obs_source_get_proc_handler(const obs_source_t *source);
  742. /** Sets the user volume for a source that has audio output */
  743. EXPORT void obs_source_set_volume(obs_source_t *source, float volume);
  744. /** Gets the user volume for a source that has audio output */
  745. EXPORT float obs_source_get_volume(const obs_source_t *source);
  746. /* Gets speaker layout of a source */
  747. EXPORT enum speaker_layout obs_source_get_speaker_layout(obs_source_t *source);
  748. /** Sets the balance value for a stereo audio source */
  749. EXPORT void obs_source_set_balance_value(obs_source_t *source, float balance);
  750. /** Gets the balance value for a stereo audio source */
  751. EXPORT float obs_source_get_balance_value(const obs_source_t *source);
  752. /** Sets the audio sync offset (in nanoseconds) for a source */
  753. EXPORT void obs_source_set_sync_offset(obs_source_t *source, int64_t offset);
  754. /** Gets the audio sync offset (in nanoseconds) for a source */
  755. EXPORT int64_t obs_source_get_sync_offset(const obs_source_t *source);
  756. /** Enumerates active child sources used by this source */
  757. EXPORT void obs_source_enum_active_sources(obs_source_t *source,
  758. obs_source_enum_proc_t enum_callback,
  759. void *param);
  760. /** Enumerates the entire active child source tree used by this source */
  761. EXPORT void obs_source_enum_active_tree(obs_source_t *source,
  762. obs_source_enum_proc_t enum_callback,
  763. void *param);
  764. /** Returns true if active, false if not */
  765. EXPORT bool obs_source_active(const obs_source_t *source);
  766. /**
  767. * Returns true if currently displayed somewhere (active or not), false if not
  768. */
  769. EXPORT bool obs_source_showing(const obs_source_t *source);
  770. /** Unused flag */
  771. #define OBS_SOURCE_FLAG_UNUSED_1 (1<<0)
  772. /** Specifies to force audio to mono */
  773. #define OBS_SOURCE_FLAG_FORCE_MONO (1<<1)
  774. /**
  775. * Sets source flags. Note that these are different from the main output
  776. * flags. These are generally things that can be set by the source or user,
  777. * while the output flags are more used to determine capabilities of a source.
  778. */
  779. EXPORT void obs_source_set_flags(obs_source_t *source, uint32_t flags);
  780. /** Gets source flags. */
  781. EXPORT uint32_t obs_source_get_flags(const obs_source_t *source);
  782. /**
  783. * Sets audio mixer flags. These flags are used to specify which mixers
  784. * the source's audio should be applied to.
  785. */
  786. EXPORT void obs_source_set_audio_mixers(obs_source_t *source, uint32_t mixers);
  787. /** Gets audio mixer flags */
  788. EXPORT uint32_t obs_source_get_audio_mixers(const obs_source_t *source);
  789. /**
  790. * Increments the 'showing' reference counter to indicate that the source is
  791. * being shown somewhere. If the reference counter was 0, will call the 'show'
  792. * callback.
  793. */
  794. EXPORT void obs_source_inc_showing(obs_source_t *source);
  795. /**
  796. * Decrements the 'showing' reference counter to indicate that the source is
  797. * no longer being shown somewhere. If the reference counter is set to 0,
  798. * will call the 'hide' callback
  799. */
  800. EXPORT void obs_source_dec_showing(obs_source_t *source);
  801. /** Enumerates filters assigned to the source */
  802. EXPORT void obs_source_enum_filters(obs_source_t *source,
  803. obs_source_enum_proc_t callback, void *param);
  804. /** Gets a filter of a source by its display name. */
  805. EXPORT obs_source_t *obs_source_get_filter_by_name(obs_source_t *source,
  806. const char *name);
  807. EXPORT void obs_source_copy_filters(obs_source_t *dst, obs_source_t *src);
  808. EXPORT bool obs_source_enabled(const obs_source_t *source);
  809. EXPORT void obs_source_set_enabled(obs_source_t *source, bool enabled);
  810. EXPORT bool obs_source_muted(const obs_source_t *source);
  811. EXPORT void obs_source_set_muted(obs_source_t *source, bool muted);
  812. EXPORT bool obs_source_push_to_mute_enabled(obs_source_t *source);
  813. EXPORT void obs_source_enable_push_to_mute(obs_source_t *source, bool enabled);
  814. EXPORT uint64_t obs_source_get_push_to_mute_delay(obs_source_t *source);
  815. EXPORT void obs_source_set_push_to_mute_delay(obs_source_t *source,
  816. uint64_t delay);
  817. EXPORT bool obs_source_push_to_talk_enabled(obs_source_t *source);
  818. EXPORT void obs_source_enable_push_to_talk(obs_source_t *source, bool enabled);
  819. EXPORT uint64_t obs_source_get_push_to_talk_delay(obs_source_t *source);
  820. EXPORT void obs_source_set_push_to_talk_delay(obs_source_t *source,
  821. uint64_t delay);
  822. typedef void (*obs_source_audio_capture_t)(void *param, obs_source_t *source,
  823. const struct audio_data *audio_data, bool muted);
  824. EXPORT void obs_source_add_audio_capture_callback(obs_source_t *source,
  825. obs_source_audio_capture_t callback, void *param);
  826. EXPORT void obs_source_remove_audio_capture_callback(obs_source_t *source,
  827. obs_source_audio_capture_t callback, void *param);
  828. enum obs_deinterlace_mode {
  829. OBS_DEINTERLACE_MODE_DISABLE,
  830. OBS_DEINTERLACE_MODE_DISCARD,
  831. OBS_DEINTERLACE_MODE_RETRO,
  832. OBS_DEINTERLACE_MODE_BLEND,
  833. OBS_DEINTERLACE_MODE_BLEND_2X,
  834. OBS_DEINTERLACE_MODE_LINEAR,
  835. OBS_DEINTERLACE_MODE_LINEAR_2X,
  836. OBS_DEINTERLACE_MODE_YADIF,
  837. OBS_DEINTERLACE_MODE_YADIF_2X
  838. };
  839. enum obs_deinterlace_field_order {
  840. OBS_DEINTERLACE_FIELD_ORDER_TOP,
  841. OBS_DEINTERLACE_FIELD_ORDER_BOTTOM
  842. };
  843. EXPORT void obs_source_set_deinterlace_mode(obs_source_t *source,
  844. enum obs_deinterlace_mode mode);
  845. EXPORT enum obs_deinterlace_mode obs_source_get_deinterlace_mode(
  846. const obs_source_t *source);
  847. EXPORT void obs_source_set_deinterlace_field_order(obs_source_t *source,
  848. enum obs_deinterlace_field_order field_order);
  849. EXPORT enum obs_deinterlace_field_order obs_source_get_deinterlace_field_order(
  850. const obs_source_t *source);
  851. enum obs_monitoring_type {
  852. OBS_MONITORING_TYPE_NONE,
  853. OBS_MONITORING_TYPE_MONITOR_ONLY,
  854. OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT
  855. };
  856. EXPORT void obs_source_set_monitoring_type(obs_source_t *source,
  857. enum obs_monitoring_type type);
  858. EXPORT enum obs_monitoring_type obs_source_get_monitoring_type(
  859. const obs_source_t *source);
  860. /** Gets private front-end settings data. This data is saved/loaded
  861. * automatically. Returns an incremented reference. */
  862. EXPORT obs_data_t *obs_source_get_private_settings(obs_source_t *item);
  863. /* ------------------------------------------------------------------------- */
  864. /* Functions used by sources */
  865. EXPORT void *obs_source_get_type_data(obs_source_t *source);
  866. /**
  867. * Helper function to set the color matrix information when drawing the source.
  868. *
  869. * @param color_matrix The color matrix. Assigns to the 'color_matrix'
  870. * effect variable.
  871. * @param color_range_min The minimum color range. Assigns to the
  872. * 'color_range_min' effect variable. If NULL,
  873. * {0.0f, 0.0f, 0.0f} is used.
  874. * @param color_range_max The maximum color range. Assigns to the
  875. * 'color_range_max' effect variable. If NULL,
  876. * {1.0f, 1.0f, 1.0f} is used.
  877. */
  878. EXPORT void obs_source_draw_set_color_matrix(
  879. const struct matrix4 *color_matrix,
  880. const struct vec3 *color_range_min,
  881. const struct vec3 *color_range_max);
  882. /**
  883. * Helper function to draw sprites for a source (synchronous video).
  884. *
  885. * @param image The sprite texture to draw. Assigns to the 'image' variable
  886. * of the current effect.
  887. * @param x X position of the sprite.
  888. * @param y Y position of the sprite.
  889. * @param cx Width of the sprite. If 0, uses the texture width.
  890. * @param cy Height of the sprite. If 0, uses the texture height.
  891. * @param flip Specifies whether to flip the image vertically.
  892. */
  893. EXPORT void obs_source_draw(gs_texture_t *image, int x, int y,
  894. uint32_t cx, uint32_t cy, bool flip);
  895. /** Outputs asynchronous video data. Set to NULL to deactivate the texture */
  896. EXPORT void obs_source_output_video(obs_source_t *source,
  897. const struct obs_source_frame *frame);
  898. /** Preloads asynchronous video data to allow instantaneous playback */
  899. EXPORT void obs_source_preload_video(obs_source_t *source,
  900. const struct obs_source_frame *frame);
  901. /** Shows any preloaded video data */
  902. EXPORT void obs_source_show_preloaded_video(obs_source_t *source);
  903. /** Outputs audio data (always asynchronous) */
  904. EXPORT void obs_source_output_audio(obs_source_t *source,
  905. const struct obs_source_audio *audio);
  906. /** Signal an update to any currently used properties via 'update_properties' */
  907. EXPORT void obs_source_update_properties(obs_source_t *source);
  908. /** Gets the current async video frame */
  909. EXPORT struct obs_source_frame *obs_source_get_frame(obs_source_t *source);
  910. /** Releases the current async video frame */
  911. EXPORT void obs_source_release_frame(obs_source_t *source,
  912. struct obs_source_frame *frame);
  913. /**
  914. * Default RGB filter handler for generic effect filters. Processes the
  915. * filter chain and renders them to texture if needed, then the filter is
  916. * drawn with
  917. *
  918. * After calling this, set your parameters for the effect, then call
  919. * obs_source_process_filter_end to draw the filter.
  920. *
  921. * Returns true if filtering should continue, false if the filter is bypassed
  922. * for whatever reason.
  923. */
  924. EXPORT bool obs_source_process_filter_begin(obs_source_t *filter,
  925. enum gs_color_format format,
  926. enum obs_allow_direct_render allow_direct);
  927. /**
  928. * Draws the filter.
  929. *
  930. * Before calling this function, first call obs_source_process_filter_begin and
  931. * then set the effect parameters, and then call this function to finalize the
  932. * filter.
  933. */
  934. EXPORT void obs_source_process_filter_end(obs_source_t *filter,
  935. gs_effect_t *effect, uint32_t width, uint32_t height);
  936. /**
  937. * Draws the filter with a specific technique.
  938. *
  939. * Before calling this function, first call obs_source_process_filter_begin and
  940. * then set the effect parameters, and then call this function to finalize the
  941. * filter.
  942. */
  943. EXPORT void obs_source_process_filter_tech_end(obs_source_t *filter,
  944. gs_effect_t *effect, uint32_t width, uint32_t height,
  945. const char *tech_name);
  946. /** Skips the filter if the filter is invalid and cannot be rendered */
  947. EXPORT void obs_source_skip_video_filter(obs_source_t *filter);
  948. /**
  949. * Adds an active child source. Must be called by parent sources on child
  950. * sources when the child is added and active. This ensures that the source is
  951. * properly activated if the parent is active.
  952. *
  953. * @returns true if source can be added, false if it causes recursion
  954. */
  955. EXPORT bool obs_source_add_active_child(obs_source_t *parent,
  956. obs_source_t *child);
  957. /**
  958. * Removes an active child source. Must be called by parent sources on child
  959. * sources when the child is removed or inactive. This ensures that the source
  960. * is properly deactivated if the parent is no longer active.
  961. */
  962. EXPORT void obs_source_remove_active_child(obs_source_t *parent,
  963. obs_source_t *child);
  964. /** Sends a mouse down/up event to a source */
  965. EXPORT void obs_source_send_mouse_click(obs_source_t *source,
  966. const struct obs_mouse_event *event,
  967. int32_t type, bool mouse_up,
  968. uint32_t click_count);
  969. /** Sends a mouse move event to a source. */
  970. EXPORT void obs_source_send_mouse_move(obs_source_t *source,
  971. const struct obs_mouse_event *event, bool mouse_leave);
  972. /** Sends a mouse wheel event to a source */
  973. EXPORT void obs_source_send_mouse_wheel(obs_source_t *source,
  974. const struct obs_mouse_event *event, int x_delta, int y_delta);
  975. /** Sends a got-focus or lost-focus event to a source */
  976. EXPORT void obs_source_send_focus(obs_source_t *source, bool focus);
  977. /** Sends a key up/down event to a source */
  978. EXPORT void obs_source_send_key_click(obs_source_t *source,
  979. const struct obs_key_event *event, bool key_up);
  980. /** Sets the default source flags. */
  981. EXPORT void obs_source_set_default_flags(obs_source_t *source, uint32_t flags);
  982. /** Gets the base width for a source (not taking in to account filtering) */
  983. EXPORT uint32_t obs_source_get_base_width(obs_source_t *source);
  984. /** Gets the base height for a source (not taking in to account filtering) */
  985. EXPORT uint32_t obs_source_get_base_height(obs_source_t *source);
  986. EXPORT bool obs_source_audio_pending(const obs_source_t *source);
  987. EXPORT uint64_t obs_source_get_audio_timestamp(const obs_source_t *source);
  988. EXPORT void obs_source_get_audio_mix(const obs_source_t *source,
  989. struct obs_source_audio_mix *audio);
  990. EXPORT void obs_source_set_async_unbuffered(obs_source_t *source,
  991. bool unbuffered);
  992. EXPORT bool obs_source_async_unbuffered(const obs_source_t *source);
  993. /** Used to decouple audio from video so that audio doesn't attempt to sync up
  994. * with video. I.E. Audio acts independently. Only works when in unbuffered
  995. * mode. */
  996. EXPORT void obs_source_set_async_decoupled(obs_source_t *source, bool decouple);
  997. EXPORT bool obs_source_async_decoupled(const obs_source_t *source);
  998. /* ------------------------------------------------------------------------- */
  999. /* Transition-specific functions */
  1000. enum obs_transition_target {
  1001. OBS_TRANSITION_SOURCE_A,
  1002. OBS_TRANSITION_SOURCE_B
  1003. };
  1004. EXPORT obs_source_t *obs_transition_get_source(obs_source_t *transition,
  1005. enum obs_transition_target target);
  1006. EXPORT void obs_transition_clear(obs_source_t *transition);
  1007. EXPORT obs_source_t *obs_transition_get_active_source(obs_source_t *transition);
  1008. enum obs_transition_mode {
  1009. OBS_TRANSITION_MODE_AUTO,
  1010. };
  1011. EXPORT bool obs_transition_start(obs_source_t *transition,
  1012. enum obs_transition_mode mode, uint32_t duration_ms,
  1013. obs_source_t *dest);
  1014. EXPORT void obs_transition_set(obs_source_t *transition, obs_source_t *source);
  1015. enum obs_transition_scale_type {
  1016. OBS_TRANSITION_SCALE_MAX_ONLY,
  1017. OBS_TRANSITION_SCALE_ASPECT,
  1018. OBS_TRANSITION_SCALE_STRETCH,
  1019. };
  1020. EXPORT void obs_transition_set_scale_type(obs_source_t *transition,
  1021. enum obs_transition_scale_type type);
  1022. EXPORT enum obs_transition_scale_type obs_transition_get_scale_type(
  1023. const obs_source_t *transition);
  1024. EXPORT void obs_transition_set_alignment(obs_source_t *transition,
  1025. uint32_t alignment);
  1026. EXPORT uint32_t obs_transition_get_alignment(const obs_source_t *transition);
  1027. EXPORT void obs_transition_set_size(obs_source_t *transition,
  1028. uint32_t cx, uint32_t cy);
  1029. EXPORT void obs_transition_get_size(const obs_source_t *transition,
  1030. uint32_t *cx, uint32_t *cy);
  1031. /* function used by transitions */
  1032. /**
  1033. * Enables fixed transitions (videos or specific types of transitions that
  1034. * are of fixed duration and linearly interpolated
  1035. */
  1036. EXPORT void obs_transition_enable_fixed(obs_source_t *transition, bool enable,
  1037. uint32_t duration_ms);
  1038. EXPORT bool obs_transition_fixed(obs_source_t *transition);
  1039. typedef void (*obs_transition_video_render_callback_t)(void *data,
  1040. gs_texture_t *a, gs_texture_t *b, float t,
  1041. uint32_t cx, uint32_t cy);
  1042. typedef float (*obs_transition_audio_mix_callback_t)(void *data, float t);
  1043. EXPORT float obs_transition_get_time(obs_source_t *transition);
  1044. EXPORT void obs_transition_video_render(obs_source_t *transition,
  1045. obs_transition_video_render_callback_t callback);
  1046. /** Directly renders its sub-source instead of to texture. Returns false if no
  1047. * longer transitioning */
  1048. EXPORT bool obs_transition_video_render_direct(obs_source_t *transition,
  1049. enum obs_transition_target target);
  1050. EXPORT bool obs_transition_audio_render(obs_source_t *transition,
  1051. uint64_t *ts_out, struct obs_source_audio_mix *audio,
  1052. uint32_t mixers, size_t channels, size_t sample_rate,
  1053. obs_transition_audio_mix_callback_t mix_a_callback,
  1054. obs_transition_audio_mix_callback_t mix_b_callback);
  1055. /* swaps transition sources and textures as an optimization and to reduce
  1056. * memory usage when switching between transitions */
  1057. EXPORT void obs_transition_swap_begin(obs_source_t *tr_dest,
  1058. obs_source_t *tr_source);
  1059. EXPORT void obs_transition_swap_end(obs_source_t *tr_dest,
  1060. obs_source_t *tr_source);
  1061. /* ------------------------------------------------------------------------- */
  1062. /* Scenes */
  1063. /**
  1064. * Creates a scene.
  1065. *
  1066. * A scene is a source which is a container of other sources with specific
  1067. * display orientations. Scenes can also be used like any other source.
  1068. */
  1069. EXPORT obs_scene_t *obs_scene_create(const char *name);
  1070. EXPORT obs_scene_t *obs_scene_create_private(const char *name);
  1071. enum obs_scene_duplicate_type {
  1072. OBS_SCENE_DUP_REFS, /**< Source refs only */
  1073. OBS_SCENE_DUP_COPY, /**< Fully duplicate */
  1074. OBS_SCENE_DUP_PRIVATE_REFS, /**< Source refs only (as private) */
  1075. OBS_SCENE_DUP_PRIVATE_COPY /**< Fully duplicate (as private) */
  1076. };
  1077. /**
  1078. * Duplicates a scene.
  1079. */
  1080. EXPORT obs_scene_t *obs_scene_duplicate(obs_scene_t *scene, const char *name,
  1081. enum obs_scene_duplicate_type type);
  1082. EXPORT void obs_scene_addref(obs_scene_t *scene);
  1083. EXPORT void obs_scene_release(obs_scene_t *scene);
  1084. /** Gets the scene's source context */
  1085. EXPORT obs_source_t *obs_scene_get_source(const obs_scene_t *scene);
  1086. /** Gets the scene from its source, or NULL if not a scene */
  1087. EXPORT obs_scene_t *obs_scene_from_source(const obs_source_t *source);
  1088. /** Determines whether a source is within a scene */
  1089. EXPORT obs_sceneitem_t *obs_scene_find_source(obs_scene_t *scene,
  1090. const char *name);
  1091. EXPORT obs_sceneitem_t *obs_scene_find_sceneitem_by_id(obs_scene_t *scene,
  1092. int64_t id);
  1093. /** Enumerates sources within a scene */
  1094. EXPORT void obs_scene_enum_items(obs_scene_t *scene,
  1095. bool (*callback)(obs_scene_t*, obs_sceneitem_t*, void*),
  1096. void *param);
  1097. EXPORT bool obs_scene_reorder_items(obs_scene_t *scene,
  1098. obs_sceneitem_t * const *item_order, size_t item_order_size);
  1099. struct obs_sceneitem_order_info {
  1100. obs_sceneitem_t *group;
  1101. obs_sceneitem_t *item;
  1102. };
  1103. EXPORT bool obs_scene_reorder_items2(obs_scene_t *scene,
  1104. struct obs_sceneitem_order_info *item_order,
  1105. size_t item_order_size);
  1106. /** Adds/creates a new scene item for a source */
  1107. EXPORT obs_sceneitem_t *obs_scene_add(obs_scene_t *scene, obs_source_t *source);
  1108. typedef void (*obs_scene_atomic_update_func)(void *, obs_scene_t *scene);
  1109. EXPORT void obs_scene_atomic_update(obs_scene_t *scene,
  1110. obs_scene_atomic_update_func func, void *data);
  1111. EXPORT void obs_sceneitem_addref(obs_sceneitem_t *item);
  1112. EXPORT void obs_sceneitem_release(obs_sceneitem_t *item);
  1113. /** Removes a scene item. */
  1114. EXPORT void obs_sceneitem_remove(obs_sceneitem_t *item);
  1115. /** Gets the scene parent associated with the scene item. */
  1116. EXPORT obs_scene_t *obs_sceneitem_get_scene(const obs_sceneitem_t *item);
  1117. /** Gets the source of a scene item. */
  1118. EXPORT obs_source_t *obs_sceneitem_get_source(const obs_sceneitem_t *item);
  1119. /* FIXME: The following functions should be deprecated and replaced with a way
  1120. * to specify savable private user data. -Jim */
  1121. EXPORT void obs_sceneitem_select(obs_sceneitem_t *item, bool select);
  1122. EXPORT bool obs_sceneitem_selected(const obs_sceneitem_t *item);
  1123. EXPORT bool obs_sceneitem_locked(const obs_sceneitem_t *item);
  1124. EXPORT bool obs_sceneitem_set_locked(obs_sceneitem_t *item, bool lock);
  1125. /* Functions for getting/setting specific orientation of a scene item */
  1126. EXPORT void obs_sceneitem_set_pos(obs_sceneitem_t *item, const struct vec2 *pos);
  1127. EXPORT void obs_sceneitem_set_rot(obs_sceneitem_t *item, float rot_deg);
  1128. EXPORT void obs_sceneitem_set_scale(obs_sceneitem_t *item,
  1129. const struct vec2 *scale);
  1130. EXPORT void obs_sceneitem_set_alignment(obs_sceneitem_t *item,
  1131. uint32_t alignment);
  1132. EXPORT void obs_sceneitem_set_order(obs_sceneitem_t *item,
  1133. enum obs_order_movement movement);
  1134. EXPORT void obs_sceneitem_set_order_position(obs_sceneitem_t *item,
  1135. int position);
  1136. EXPORT void obs_sceneitem_set_bounds_type(obs_sceneitem_t *item,
  1137. enum obs_bounds_type type);
  1138. EXPORT void obs_sceneitem_set_bounds_alignment(obs_sceneitem_t *item,
  1139. uint32_t alignment);
  1140. EXPORT void obs_sceneitem_set_bounds(obs_sceneitem_t *item,
  1141. const struct vec2 *bounds);
  1142. EXPORT int64_t obs_sceneitem_get_id(const obs_sceneitem_t *item);
  1143. EXPORT void obs_sceneitem_get_pos(const obs_sceneitem_t *item,
  1144. struct vec2 *pos);
  1145. EXPORT float obs_sceneitem_get_rot(const obs_sceneitem_t *item);
  1146. EXPORT void obs_sceneitem_get_scale(const obs_sceneitem_t *item,
  1147. struct vec2 *scale);
  1148. EXPORT uint32_t obs_sceneitem_get_alignment(const obs_sceneitem_t *item);
  1149. EXPORT enum obs_bounds_type obs_sceneitem_get_bounds_type(
  1150. const obs_sceneitem_t *item);
  1151. EXPORT uint32_t obs_sceneitem_get_bounds_alignment(const obs_sceneitem_t *item);
  1152. EXPORT void obs_sceneitem_get_bounds(const obs_sceneitem_t *item,
  1153. struct vec2 *bounds);
  1154. EXPORT void obs_sceneitem_get_info(const obs_sceneitem_t *item,
  1155. struct obs_transform_info *info);
  1156. EXPORT void obs_sceneitem_set_info(obs_sceneitem_t *item,
  1157. const struct obs_transform_info *info);
  1158. EXPORT void obs_sceneitem_get_draw_transform(const obs_sceneitem_t *item,
  1159. struct matrix4 *transform);
  1160. EXPORT void obs_sceneitem_get_box_transform(const obs_sceneitem_t *item,
  1161. struct matrix4 *transform);
  1162. EXPORT bool obs_sceneitem_visible(const obs_sceneitem_t *item);
  1163. EXPORT bool obs_sceneitem_set_visible(obs_sceneitem_t *item, bool visible);
  1164. struct obs_sceneitem_crop {
  1165. int left;
  1166. int top;
  1167. int right;
  1168. int bottom;
  1169. };
  1170. EXPORT void obs_sceneitem_set_crop(obs_sceneitem_t *item,
  1171. const struct obs_sceneitem_crop *crop);
  1172. EXPORT void obs_sceneitem_get_crop(const obs_sceneitem_t *item,
  1173. struct obs_sceneitem_crop *crop);
  1174. EXPORT void obs_sceneitem_set_scale_filter(obs_sceneitem_t *item,
  1175. enum obs_scale_type filter);
  1176. EXPORT enum obs_scale_type obs_sceneitem_get_scale_filter(
  1177. obs_sceneitem_t *item);
  1178. EXPORT void obs_sceneitem_force_update_transform(obs_sceneitem_t *item);
  1179. EXPORT void obs_sceneitem_defer_update_begin(obs_sceneitem_t *item);
  1180. EXPORT void obs_sceneitem_defer_update_end(obs_sceneitem_t *item);
  1181. /** Gets private front-end settings data. This data is saved/loaded
  1182. * automatically. Returns an incremented reference. */
  1183. EXPORT obs_data_t *obs_sceneitem_get_private_settings(obs_sceneitem_t *item);
  1184. EXPORT obs_sceneitem_t *obs_scene_add_group(obs_scene_t *scene,
  1185. const char *name);
  1186. EXPORT obs_sceneitem_t *obs_scene_insert_group(obs_scene_t *scene,
  1187. const char *name, obs_sceneitem_t **items, size_t count);
  1188. EXPORT obs_sceneitem_t *obs_scene_get_group(obs_scene_t *scene,
  1189. const char *name);
  1190. EXPORT bool obs_sceneitem_is_group(obs_sceneitem_t *item);
  1191. EXPORT obs_scene_t *obs_sceneitem_group_get_scene(
  1192. const obs_sceneitem_t *group);
  1193. EXPORT void obs_sceneitem_group_ungroup(obs_sceneitem_t *group);
  1194. EXPORT void obs_sceneitem_group_add_item(obs_sceneitem_t *group,
  1195. obs_sceneitem_t *item);
  1196. EXPORT void obs_sceneitem_group_remove_item(obs_sceneitem_t *group,
  1197. obs_sceneitem_t *item);
  1198. EXPORT obs_sceneitem_t *obs_sceneitem_get_group(obs_scene_t *scene,
  1199. obs_sceneitem_t *item);
  1200. EXPORT bool obs_source_is_group(const obs_source_t *source);
  1201. EXPORT bool obs_scene_is_group(const obs_scene_t *scene);
  1202. EXPORT void obs_sceneitem_group_enum_items(obs_sceneitem_t *group,
  1203. bool (*callback)(obs_scene_t*, obs_sceneitem_t*, void*),
  1204. void *param);
  1205. EXPORT void obs_sceneitem_defer_group_resize_begin(obs_sceneitem_t *item);
  1206. EXPORT void obs_sceneitem_defer_group_resize_end(obs_sceneitem_t *item);
  1207. /* ------------------------------------------------------------------------- */
  1208. /* Outputs */
  1209. EXPORT const char *obs_output_get_display_name(const char *id);
  1210. /**
  1211. * Creates an output.
  1212. *
  1213. * Outputs allow outputting to file, outputting to network, outputting to
  1214. * directshow, or other custom outputs.
  1215. */
  1216. EXPORT obs_output_t *obs_output_create(const char *id, const char *name,
  1217. obs_data_t *settings, obs_data_t *hotkey_data);
  1218. /**
  1219. * Adds/releases a reference to an output. When the last reference is
  1220. * released, the output is destroyed.
  1221. */
  1222. EXPORT void obs_output_addref(obs_output_t *output);
  1223. EXPORT void obs_output_release(obs_output_t *output);
  1224. EXPORT void obs_weak_output_addref(obs_weak_output_t *weak);
  1225. EXPORT void obs_weak_output_release(obs_weak_output_t *weak);
  1226. EXPORT obs_output_t *obs_output_get_ref(obs_output_t *output);
  1227. EXPORT obs_weak_output_t *obs_output_get_weak_output(obs_output_t *output);
  1228. EXPORT obs_output_t *obs_weak_output_get_output(obs_weak_output_t *weak);
  1229. EXPORT bool obs_weak_output_references_output(obs_weak_output_t *weak,
  1230. obs_output_t *output);
  1231. EXPORT const char *obs_output_get_name(const obs_output_t *output);
  1232. /** Starts the output. */
  1233. EXPORT bool obs_output_start(obs_output_t *output);
  1234. /** Stops the output. */
  1235. EXPORT void obs_output_stop(obs_output_t *output);
  1236. /**
  1237. * On reconnection, start where it left of on reconnection. Note however that
  1238. * this option will consume extra memory to continually increase delay while
  1239. * waiting to reconnect.
  1240. */
  1241. #define OBS_OUTPUT_DELAY_PRESERVE (1<<0)
  1242. /**
  1243. * Sets the current output delay, in seconds (if the output supports delay).
  1244. *
  1245. * If delay is currently active, it will set the delay value, but will not
  1246. * affect the current delay, it will only affect the next time the output is
  1247. * activated.
  1248. */
  1249. EXPORT void obs_output_set_delay(obs_output_t *output, uint32_t delay_sec,
  1250. uint32_t flags);
  1251. /** Gets the currently set delay value, in seconds. */
  1252. EXPORT uint32_t obs_output_get_delay(const obs_output_t *output);
  1253. /** If delay is active, gets the currently active delay value, in seconds. */
  1254. EXPORT uint32_t obs_output_get_active_delay(const obs_output_t *output);
  1255. /** Forces the output to stop. Usually only used with delay. */
  1256. EXPORT void obs_output_force_stop(obs_output_t *output);
  1257. /** Returns whether the output is active */
  1258. EXPORT bool obs_output_active(const obs_output_t *output);
  1259. /** Returns output capability flags */
  1260. EXPORT uint32_t obs_output_get_flags(const obs_output_t *output);
  1261. /** Returns output capability flags */
  1262. EXPORT uint32_t obs_get_output_flags(const char *id);
  1263. /** Gets the default settings for an output type */
  1264. EXPORT obs_data_t *obs_output_defaults(const char *id);
  1265. /** Returns the property list, if any. Free with obs_properties_destroy */
  1266. EXPORT obs_properties_t *obs_get_output_properties(const char *id);
  1267. /**
  1268. * Returns the property list of an existing output, if any. Free with
  1269. * obs_properties_destroy
  1270. */
  1271. EXPORT obs_properties_t *obs_output_properties(const obs_output_t *output);
  1272. /** Updates the settings for this output context */
  1273. EXPORT void obs_output_update(obs_output_t *output, obs_data_t *settings);
  1274. /** Specifies whether the output can be paused */
  1275. EXPORT bool obs_output_can_pause(const obs_output_t *output);
  1276. /** Pauses the output (if the functionality is allowed by the output */
  1277. EXPORT void obs_output_pause(obs_output_t *output);
  1278. /* Gets the current output settings string */
  1279. EXPORT obs_data_t *obs_output_get_settings(const obs_output_t *output);
  1280. /** Returns the signal handler for an output */
  1281. EXPORT signal_handler_t *obs_output_get_signal_handler(
  1282. const obs_output_t *output);
  1283. /** Returns the procedure handler for an output */
  1284. EXPORT proc_handler_t *obs_output_get_proc_handler(const obs_output_t *output);
  1285. /**
  1286. * Sets the current audio/video media contexts associated with this output,
  1287. * required for non-encoded outputs. Can be null.
  1288. */
  1289. EXPORT void obs_output_set_media(obs_output_t *output,
  1290. video_t *video, audio_t *audio);
  1291. /** Returns the video media context associated with this output */
  1292. EXPORT video_t *obs_output_video(const obs_output_t *output);
  1293. /** Returns the audio media context associated with this output */
  1294. EXPORT audio_t *obs_output_audio(const obs_output_t *output);
  1295. /** Sets the current audio mixer for non-encoded outputs */
  1296. EXPORT void obs_output_set_mixer(obs_output_t *output, size_t mixer_idx);
  1297. /** Gets the current audio mixer for non-encoded outputs */
  1298. EXPORT size_t obs_output_get_mixer(const obs_output_t *output);
  1299. /** Sets the current audio mixes (mask) for a non-encoded multi-track output */
  1300. EXPORT void obs_output_set_mixers(obs_output_t *output, size_t mixers);
  1301. /** Gets the current audio mixes (mask) for a non-encoded multi-track output */
  1302. EXPORT size_t obs_output_get_mixers(const obs_output_t *output);
  1303. /**
  1304. * Sets the current video encoder associated with this output,
  1305. * required for encoded outputs
  1306. */
  1307. EXPORT void obs_output_set_video_encoder(obs_output_t *output,
  1308. obs_encoder_t *encoder);
  1309. /**
  1310. * Sets the current audio encoder associated with this output,
  1311. * required for encoded outputs.
  1312. *
  1313. * The idx parameter specifies the audio encoder index to set the encoder to.
  1314. * Only used with outputs that have multiple audio outputs (RTMP typically),
  1315. * otherwise the parameter is ignored.
  1316. */
  1317. EXPORT void obs_output_set_audio_encoder(obs_output_t *output,
  1318. obs_encoder_t *encoder, size_t idx);
  1319. /** Returns the current video encoder associated with this output */
  1320. EXPORT obs_encoder_t *obs_output_get_video_encoder(const obs_output_t *output);
  1321. /**
  1322. * Returns the current audio encoder associated with this output
  1323. *
  1324. * The idx parameter specifies the audio encoder index. Only used with
  1325. * outputs that have multiple audio outputs, otherwise the parameter is
  1326. * ignored.
  1327. */
  1328. EXPORT obs_encoder_t *obs_output_get_audio_encoder(const obs_output_t *output,
  1329. size_t idx);
  1330. /** Sets the current service associated with this output. */
  1331. EXPORT void obs_output_set_service(obs_output_t *output,
  1332. obs_service_t *service);
  1333. /** Gets the current service associated with this output. */
  1334. EXPORT obs_service_t *obs_output_get_service(const obs_output_t *output);
  1335. /**
  1336. * Sets the reconnect settings. Set retry_count to 0 to disable reconnecting.
  1337. */
  1338. EXPORT void obs_output_set_reconnect_settings(obs_output_t *output,
  1339. int retry_count, int retry_sec);
  1340. EXPORT uint64_t obs_output_get_total_bytes(const obs_output_t *output);
  1341. EXPORT int obs_output_get_frames_dropped(const obs_output_t *output);
  1342. EXPORT int obs_output_get_total_frames(const obs_output_t *output);
  1343. /**
  1344. * Sets the preferred scaled resolution for this output. Set width and height
  1345. * to 0 to disable scaling.
  1346. *
  1347. * If this output uses an encoder, it will call obs_encoder_set_scaled_size on
  1348. * the encoder before the stream is started. If the encoder is already active,
  1349. * then this function will trigger a warning and do nothing.
  1350. */
  1351. EXPORT void obs_output_set_preferred_size(obs_output_t *output, uint32_t width,
  1352. uint32_t height);
  1353. /** For video outputs, returns the width of the encoded image */
  1354. EXPORT uint32_t obs_output_get_width(const obs_output_t *output);
  1355. /** For video outputs, returns the height of the encoded image */
  1356. EXPORT uint32_t obs_output_get_height(const obs_output_t *output);
  1357. EXPORT const char *obs_output_get_id(const obs_output_t *output);
  1358. #if BUILD_CAPTIONS
  1359. EXPORT void obs_output_output_caption_text1(obs_output_t *output,
  1360. const char *text);
  1361. EXPORT void obs_output_output_caption_text2(obs_output_t *output,
  1362. const char *text, double display_duration);
  1363. #endif
  1364. EXPORT float obs_output_get_congestion(obs_output_t *output);
  1365. EXPORT int obs_output_get_connect_time_ms(obs_output_t *output);
  1366. EXPORT bool obs_output_reconnecting(const obs_output_t *output);
  1367. /** Pass a string of the last output error, for UI use */
  1368. EXPORT void obs_output_set_last_error(obs_output_t *output,
  1369. const char *message);
  1370. EXPORT const char *obs_output_get_last_error(obs_output_t *output);
  1371. EXPORT const char *obs_output_get_supported_video_codecs(
  1372. const obs_output_t *output);
  1373. EXPORT const char *obs_output_get_supported_audio_codecs(
  1374. const obs_output_t *output);
  1375. /* ------------------------------------------------------------------------- */
  1376. /* Functions used by outputs */
  1377. EXPORT void *obs_output_get_type_data(obs_output_t *output);
  1378. /** Optionally sets the video conversion info. Used only for raw output */
  1379. EXPORT void obs_output_set_video_conversion(obs_output_t *output,
  1380. const struct video_scale_info *conversion);
  1381. /** Optionally sets the audio conversion info. Used only for raw output */
  1382. EXPORT void obs_output_set_audio_conversion(obs_output_t *output,
  1383. const struct audio_convert_info *conversion);
  1384. /** Returns whether data capture can begin with the specified flags */
  1385. EXPORT bool obs_output_can_begin_data_capture(const obs_output_t *output,
  1386. uint32_t flags);
  1387. /** Initializes encoders (if any) */
  1388. EXPORT bool obs_output_initialize_encoders(obs_output_t *output,
  1389. uint32_t flags);
  1390. /**
  1391. * Begins data capture from media/encoders.
  1392. *
  1393. * @param output Output context
  1394. * @param flags Set this to 0 to use default output flags set in the
  1395. * obs_output_info structure, otherwise set to a either
  1396. * OBS_OUTPUT_VIDEO or OBS_OUTPUT_AUDIO to specify whether to
  1397. * connect audio or video. This is useful for things like
  1398. * ffmpeg which may or may not always want to use both audio
  1399. * and video.
  1400. * @return true if successful, false otherwise.
  1401. */
  1402. EXPORT bool obs_output_begin_data_capture(obs_output_t *output, uint32_t flags);
  1403. /** Ends data capture from media/encoders */
  1404. EXPORT void obs_output_end_data_capture(obs_output_t *output);
  1405. /**
  1406. * Signals that the output has stopped itself.
  1407. *
  1408. * @param output Output context
  1409. * @param code Error code (or OBS_OUTPUT_SUCCESS if not an error)
  1410. */
  1411. EXPORT void obs_output_signal_stop(obs_output_t *output, int code);
  1412. /* ------------------------------------------------------------------------- */
  1413. /* Encoders */
  1414. EXPORT const char *obs_encoder_get_display_name(const char *id);
  1415. /**
  1416. * Creates a video encoder context
  1417. *
  1418. * @param id Video encoder ID
  1419. * @param name Name to assign to this context
  1420. * @param settings Settings
  1421. * @return The video encoder context, or NULL if failed or not found.
  1422. */
  1423. EXPORT obs_encoder_t *obs_video_encoder_create(const char *id, const char *name,
  1424. obs_data_t *settings, obs_data_t *hotkey_data);
  1425. /**
  1426. * Creates an audio encoder context
  1427. *
  1428. * @param id Audio Encoder ID
  1429. * @param name Name to assign to this context
  1430. * @param settings Settings
  1431. * @param mixer_idx Index of the mixer to use for this audio encoder
  1432. * @return The video encoder context, or NULL if failed or not found.
  1433. */
  1434. EXPORT obs_encoder_t *obs_audio_encoder_create(const char *id, const char *name,
  1435. obs_data_t *settings, size_t mixer_idx,
  1436. obs_data_t *hotkey_data);
  1437. /**
  1438. * Adds/releases a reference to an encoder. When the last reference is
  1439. * released, the encoder is destroyed.
  1440. */
  1441. EXPORT void obs_encoder_addref(obs_encoder_t *encoder);
  1442. EXPORT void obs_encoder_release(obs_encoder_t *encoder);
  1443. EXPORT void obs_weak_encoder_addref(obs_weak_encoder_t *weak);
  1444. EXPORT void obs_weak_encoder_release(obs_weak_encoder_t *weak);
  1445. EXPORT obs_encoder_t *obs_encoder_get_ref(obs_encoder_t *encoder);
  1446. EXPORT obs_weak_encoder_t *obs_encoder_get_weak_encoder(obs_encoder_t *encoder);
  1447. EXPORT obs_encoder_t *obs_weak_encoder_get_encoder(obs_weak_encoder_t *weak);
  1448. EXPORT bool obs_weak_encoder_references_encoder(obs_weak_encoder_t *weak,
  1449. obs_encoder_t *encoder);
  1450. EXPORT void obs_encoder_set_name(obs_encoder_t *encoder, const char *name);
  1451. EXPORT const char *obs_encoder_get_name(const obs_encoder_t *encoder);
  1452. /** Returns the codec of an encoder by the id */
  1453. EXPORT const char *obs_get_encoder_codec(const char *id);
  1454. /** Returns the type of an encoder by the id */
  1455. EXPORT enum obs_encoder_type obs_get_encoder_type(const char *id);
  1456. /** Returns the codec of the encoder */
  1457. EXPORT const char *obs_encoder_get_codec(const obs_encoder_t *encoder);
  1458. /** Returns the type of an encoder */
  1459. EXPORT enum obs_encoder_type obs_encoder_get_type(const obs_encoder_t *encoder);
  1460. /**
  1461. * Sets the scaled resolution for a video encoder. Set width and height to 0
  1462. * to disable scaling. If the encoder is active, this function will trigger
  1463. * a warning, and do nothing.
  1464. */
  1465. EXPORT void obs_encoder_set_scaled_size(obs_encoder_t *encoder, uint32_t width,
  1466. uint32_t height);
  1467. /** For video encoders, returns the width of the encoded image */
  1468. EXPORT uint32_t obs_encoder_get_width(const obs_encoder_t *encoder);
  1469. /** For video encoders, returns the height of the encoded image */
  1470. EXPORT uint32_t obs_encoder_get_height(const obs_encoder_t *encoder);
  1471. /** For audio encoders, returns the sample rate of the audio */
  1472. EXPORT uint32_t obs_encoder_get_sample_rate(const obs_encoder_t *encoder);
  1473. /**
  1474. * Sets the preferred video format for a video encoder. If the encoder can use
  1475. * the format specified, it will force a conversion to that format if the
  1476. * obs output format does not match the preferred format.
  1477. *
  1478. * If the format is set to VIDEO_FORMAT_NONE, will revert to the default
  1479. * functionality of converting only when absolutely necessary.
  1480. */
  1481. EXPORT void obs_encoder_set_preferred_video_format(obs_encoder_t *encoder,
  1482. enum video_format format);
  1483. EXPORT enum video_format obs_encoder_get_preferred_video_format(
  1484. const obs_encoder_t *encoder);
  1485. /** Gets the default settings for an encoder type */
  1486. EXPORT obs_data_t *obs_encoder_defaults(const char *id);
  1487. EXPORT obs_data_t *obs_encoder_get_defaults(const obs_encoder_t *encoder);
  1488. /** Returns the property list, if any. Free with obs_properties_destroy */
  1489. EXPORT obs_properties_t *obs_get_encoder_properties(const char *id);
  1490. /**
  1491. * Returns the property list of an existing encoder, if any. Free with
  1492. * obs_properties_destroy
  1493. */
  1494. EXPORT obs_properties_t *obs_encoder_properties(const obs_encoder_t *encoder);
  1495. /**
  1496. * Updates the settings of the encoder context. Usually used for changing
  1497. * bitrate while active
  1498. */
  1499. EXPORT void obs_encoder_update(obs_encoder_t *encoder, obs_data_t *settings);
  1500. /** Gets extra data (headers) associated with this context */
  1501. EXPORT bool obs_encoder_get_extra_data(const obs_encoder_t *encoder,
  1502. uint8_t **extra_data, size_t *size);
  1503. /** Returns the current settings for this encoder */
  1504. EXPORT obs_data_t *obs_encoder_get_settings(const obs_encoder_t *encoder);
  1505. /** Sets the video output context to be used with this encoder */
  1506. EXPORT void obs_encoder_set_video(obs_encoder_t *encoder, video_t *video);
  1507. /** Sets the audio output context to be used with this encoder */
  1508. EXPORT void obs_encoder_set_audio(obs_encoder_t *encoder, audio_t *audio);
  1509. /**
  1510. * Returns the video output context used with this encoder, or NULL if not
  1511. * a video context
  1512. */
  1513. EXPORT video_t *obs_encoder_video(const obs_encoder_t *encoder);
  1514. /**
  1515. * Returns the audio output context used with this encoder, or NULL if not
  1516. * a audio context
  1517. */
  1518. EXPORT audio_t *obs_encoder_audio(const obs_encoder_t *encoder);
  1519. /** Returns true if encoder is active, false otherwise */
  1520. EXPORT bool obs_encoder_active(const obs_encoder_t *encoder);
  1521. EXPORT void *obs_encoder_get_type_data(obs_encoder_t *encoder);
  1522. EXPORT const char *obs_encoder_get_id(const obs_encoder_t *encoder);
  1523. EXPORT uint32_t obs_get_encoder_caps(const char *encoder_id);
  1524. #ifndef SWIG
  1525. /** Duplicates an encoder packet */
  1526. DEPRECATED
  1527. EXPORT void obs_duplicate_encoder_packet(struct encoder_packet *dst,
  1528. const struct encoder_packet *src);
  1529. DEPRECATED
  1530. EXPORT void obs_free_encoder_packet(struct encoder_packet *packet);
  1531. #endif
  1532. EXPORT void obs_encoder_packet_ref(struct encoder_packet *dst,
  1533. struct encoder_packet *src);
  1534. EXPORT void obs_encoder_packet_release(struct encoder_packet *packet);
  1535. EXPORT void *obs_encoder_create_rerouted(obs_encoder_t *encoder,
  1536. const char *reroute_id);
  1537. /* ------------------------------------------------------------------------- */
  1538. /* Stream Services */
  1539. EXPORT const char *obs_service_get_display_name(const char *id);
  1540. EXPORT obs_service_t *obs_service_create(const char *id, const char *name,
  1541. obs_data_t *settings, obs_data_t *hotkey_data);
  1542. EXPORT obs_service_t *obs_service_create_private(const char *id,
  1543. const char *name, obs_data_t *settings);
  1544. /**
  1545. * Adds/releases a reference to a service. When the last reference is
  1546. * released, the service is destroyed.
  1547. */
  1548. EXPORT void obs_service_addref(obs_service_t *service);
  1549. EXPORT void obs_service_release(obs_service_t *service);
  1550. EXPORT void obs_weak_service_addref(obs_weak_service_t *weak);
  1551. EXPORT void obs_weak_service_release(obs_weak_service_t *weak);
  1552. EXPORT obs_service_t *obs_service_get_ref(obs_service_t *service);
  1553. EXPORT obs_weak_service_t *obs_service_get_weak_service(obs_service_t *service);
  1554. EXPORT obs_service_t *obs_weak_service_get_service(obs_weak_service_t *weak);
  1555. EXPORT bool obs_weak_service_references_service(obs_weak_service_t *weak,
  1556. obs_service_t *service);
  1557. EXPORT const char *obs_service_get_name(const obs_service_t *service);
  1558. /** Gets the default settings for a service */
  1559. EXPORT obs_data_t *obs_service_defaults(const char *id);
  1560. /** Returns the property list, if any. Free with obs_properties_destroy */
  1561. EXPORT obs_properties_t *obs_get_service_properties(const char *id);
  1562. /**
  1563. * Returns the property list of an existing service context, if any. Free with
  1564. * obs_properties_destroy
  1565. */
  1566. EXPORT obs_properties_t *obs_service_properties(const obs_service_t *service);
  1567. /** Gets the service type */
  1568. EXPORT const char *obs_service_get_type(const obs_service_t *service);
  1569. /** Updates the settings of the service context */
  1570. EXPORT void obs_service_update(obs_service_t *service, obs_data_t *settings);
  1571. /** Returns the current settings for this service */
  1572. EXPORT obs_data_t *obs_service_get_settings(const obs_service_t *service);
  1573. /** Returns the URL for this service context */
  1574. EXPORT const char *obs_service_get_url(const obs_service_t *service);
  1575. /** Returns the stream key (if any) for this service context */
  1576. EXPORT const char *obs_service_get_key(const obs_service_t *service);
  1577. /** Returns the username (if any) for this service context */
  1578. EXPORT const char *obs_service_get_username(const obs_service_t *service);
  1579. /** Returns the password (if any) for this service context */
  1580. EXPORT const char *obs_service_get_password(const obs_service_t *service);
  1581. /**
  1582. * Applies service-specific video encoder settings.
  1583. *
  1584. * @param video_encoder_settings Video encoder settings. Optional.
  1585. * @param audio_encoder_settings Audio encoder settings. Optional.
  1586. */
  1587. EXPORT void obs_service_apply_encoder_settings(obs_service_t *service,
  1588. obs_data_t *video_encoder_settings,
  1589. obs_data_t *audio_encoder_settings);
  1590. EXPORT void *obs_service_get_type_data(obs_service_t *service);
  1591. EXPORT const char *obs_service_get_id(const obs_service_t *service);
  1592. /* NOTE: This function is temporary and should be removed/replaced at a later
  1593. * date. */
  1594. EXPORT const char *obs_service_get_output_type(const obs_service_t *service);
  1595. /* ------------------------------------------------------------------------- */
  1596. /* Source frame allocation functions */
  1597. EXPORT void obs_source_frame_init(struct obs_source_frame *frame,
  1598. enum video_format format, uint32_t width, uint32_t height);
  1599. static inline void obs_source_frame_free(struct obs_source_frame *frame)
  1600. {
  1601. if (frame) {
  1602. bfree(frame->data[0]);
  1603. memset(frame, 0, sizeof(*frame));
  1604. }
  1605. }
  1606. static inline struct obs_source_frame *obs_source_frame_create(
  1607. enum video_format format, uint32_t width, uint32_t height)
  1608. {
  1609. struct obs_source_frame *frame;
  1610. frame = (struct obs_source_frame*)bzalloc(sizeof(*frame));
  1611. obs_source_frame_init(frame, format, width, height);
  1612. return frame;
  1613. }
  1614. static inline void obs_source_frame_destroy(struct obs_source_frame *frame)
  1615. {
  1616. if (frame) {
  1617. bfree(frame->data[0]);
  1618. bfree(frame);
  1619. }
  1620. }
  1621. EXPORT void obs_source_frame_copy(struct obs_source_frame *dst,
  1622. const struct obs_source_frame *src);
  1623. #ifdef __cplusplus
  1624. }
  1625. #endif