obs.h 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449
  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/text-lookup.h"
  18. #include "graphics/graphics.h"
  19. #include "graphics/vec2.h"
  20. #include "graphics/vec3.h"
  21. #include "media-io/audio-io.h"
  22. #include "media-io/video-io.h"
  23. #include "callback/signal.h"
  24. #include "callback/proc.h"
  25. #include "obs-config.h"
  26. #include "obs-defs.h"
  27. #include "obs-data.h"
  28. #include "obs-ui.h"
  29. #include "obs-properties.h"
  30. #include "obs-interaction.h"
  31. struct matrix4;
  32. /* opaque types */
  33. struct obs_display;
  34. struct obs_view;
  35. struct obs_source;
  36. struct obs_scene;
  37. struct obs_scene_item;
  38. struct obs_output;
  39. struct obs_encoder;
  40. struct obs_service;
  41. struct obs_module;
  42. struct obs_fader;
  43. struct obs_volmeter;
  44. typedef struct obs_display obs_display_t;
  45. typedef struct obs_view obs_view_t;
  46. typedef struct obs_source obs_source_t;
  47. typedef struct obs_scene obs_scene_t;
  48. typedef struct obs_scene_item obs_sceneitem_t;
  49. typedef struct obs_output obs_output_t;
  50. typedef struct obs_encoder obs_encoder_t;
  51. typedef struct obs_service obs_service_t;
  52. typedef struct obs_module obs_module_t;
  53. typedef struct obs_fader obs_fader_t;
  54. typedef struct obs_volmeter obs_volmeter_t;
  55. #include "obs-source.h"
  56. #include "obs-encoder.h"
  57. #include "obs-output.h"
  58. #include "obs-service.h"
  59. #include "obs-audio-controls.h"
  60. /**
  61. * @file
  62. * @brief Main libobs header used by applications.
  63. *
  64. * @mainpage
  65. *
  66. * @section intro_sec Introduction
  67. *
  68. * This document describes the api for libobs to be used by applications as well
  69. * as @ref modules_page implementing some kind of functionality.
  70. *
  71. */
  72. #ifdef __cplusplus
  73. extern "C" {
  74. #endif
  75. /** Used for changing the order of items (for example, filters in a source,
  76. * or items in a scene) */
  77. enum obs_order_movement {
  78. OBS_ORDER_MOVE_UP,
  79. OBS_ORDER_MOVE_DOWN,
  80. OBS_ORDER_MOVE_TOP,
  81. OBS_ORDER_MOVE_BOTTOM
  82. };
  83. /**
  84. * Used with obs_source_process_filter to specify whether the filter should
  85. * render the source directly with the specified effect, or whether it should
  86. * render it to a texture
  87. */
  88. enum obs_allow_direct_render {
  89. OBS_NO_DIRECT_RENDERING,
  90. OBS_ALLOW_DIRECT_RENDERING,
  91. };
  92. enum obs_scale_type {
  93. OBS_SCALE_BICUBIC,
  94. OBS_SCALE_BILINEAR,
  95. OBS_SCALE_LANCZOS
  96. };
  97. /**
  98. * Used with scene items to indicate the type of bounds to use for scene items.
  99. * Mostly determines how the image will be scaled within those bounds, or
  100. * whether to use bounds at all.
  101. */
  102. enum obs_bounds_type {
  103. OBS_BOUNDS_NONE, /**< no bounds */
  104. OBS_BOUNDS_STRETCH, /**< stretch (ignores base scale) */
  105. OBS_BOUNDS_SCALE_INNER, /**< scales to inner rectangle */
  106. OBS_BOUNDS_SCALE_OUTER, /**< scales to outer rectangle */
  107. OBS_BOUNDS_SCALE_TO_WIDTH, /**< scales to the width */
  108. OBS_BOUNDS_SCALE_TO_HEIGHT, /**< scales to the height */
  109. OBS_BOUNDS_MAX_ONLY, /**< no scaling, maximum size only */
  110. };
  111. struct obs_transform_info {
  112. struct vec2 pos;
  113. float rot;
  114. struct vec2 scale;
  115. uint32_t alignment;
  116. enum obs_bounds_type bounds_type;
  117. uint32_t bounds_alignment;
  118. struct vec2 bounds;
  119. };
  120. /**
  121. * Video initialization structure
  122. */
  123. struct obs_video_info {
  124. /**
  125. * Graphics module to use (usually "libobs-opengl" or "libobs-d3d11")
  126. */
  127. const char *graphics_module;
  128. uint32_t fps_num; /**< Output FPS numerator */
  129. uint32_t fps_den; /**< Output FPS denominator */
  130. uint32_t window_width; /**< Window width */
  131. uint32_t window_height; /**< Window height */
  132. uint32_t base_width; /**< Base compositing width */
  133. uint32_t base_height; /**< Base compositing height */
  134. uint32_t output_width; /**< Output width */
  135. uint32_t output_height; /**< Output height */
  136. enum video_format output_format; /**< Output format */
  137. /** Video adapter index to use (NOTE: avoid for optimus laptops) */
  138. uint32_t adapter;
  139. struct gs_window window; /**< Window to render to */
  140. /** Use shaders to convert to different color formats */
  141. bool gpu_conversion;
  142. enum video_colorspace colorspace; /**< YUV type (if YUV) */
  143. enum video_range_type range; /**< YUV range (if YUV) */
  144. enum obs_scale_type scale_type; /**< How to scale if scaling */
  145. };
  146. /**
  147. * Audio initialization structure
  148. */
  149. struct obs_audio_info {
  150. uint32_t samples_per_sec;
  151. enum speaker_layout speakers;
  152. uint64_t buffer_ms;
  153. };
  154. /**
  155. * Sent to source filters via the filter_audio callback to allow filtering of
  156. * audio data
  157. */
  158. struct obs_audio_data {
  159. uint8_t *data[MAX_AV_PLANES];
  160. uint32_t frames;
  161. uint64_t timestamp;
  162. };
  163. /**
  164. * Source audio output structure. Used with obs_source_output_audio to output
  165. * source audio. Audio is automatically resampled and remixed as necessary.
  166. */
  167. struct obs_source_audio {
  168. const uint8_t *data[MAX_AV_PLANES];
  169. uint32_t frames;
  170. enum speaker_layout speakers;
  171. enum audio_format format;
  172. uint32_t samples_per_sec;
  173. uint64_t timestamp;
  174. };
  175. /**
  176. * Source asynchronous video output structure. Used with
  177. * obs_source_output_video to output asynchronous video. Video is buffered as
  178. * necessary to play according to timestamps. When used with audio output,
  179. * audio is synced to video as it is played.
  180. *
  181. * If a YUV format is specified, it will be automatically upsampled and
  182. * converted to RGB via shader on the graphics processor.
  183. */
  184. struct obs_source_frame {
  185. uint8_t *data[MAX_AV_PLANES];
  186. uint32_t linesize[MAX_AV_PLANES];
  187. uint32_t width;
  188. uint32_t height;
  189. uint64_t timestamp;
  190. enum video_format format;
  191. float color_matrix[16];
  192. bool full_range;
  193. float color_range_min[3];
  194. float color_range_max[3];
  195. bool flip;
  196. /* used internally by libobs */
  197. volatile long refs;
  198. };
  199. /* ------------------------------------------------------------------------- */
  200. /* OBS context */
  201. /**
  202. * Initializes OBS
  203. *
  204. * @param locale The locale to use for modules
  205. */
  206. EXPORT bool obs_startup(const char *locale);
  207. /** Releases all data associated with OBS and terminates the OBS context */
  208. EXPORT void obs_shutdown(void);
  209. /** @return true if the main OBS context has been initialized */
  210. EXPORT bool obs_initialized(void);
  211. /** @return The current core version */
  212. EXPORT uint32_t obs_get_version(void);
  213. /**
  214. * Sets a new locale to use for modules. This will call obs_module_set_locale
  215. * for each module with the new locale.
  216. *
  217. * @param locale The locale to use for modules
  218. */
  219. EXPORT void obs_set_locale(const char *locale);
  220. /** @return the current locale */
  221. EXPORT const char *obs_get_locale(void);
  222. /**
  223. * Sets base video ouput base resolution/fps/format.
  224. *
  225. * @note This data cannot be changed if an output is corrently active.
  226. * @note The graphics module cannot be changed without fully destroying the
  227. * OBS context.
  228. *
  229. * @param ovi Pointer to an obs_video_info structure containing the
  230. * specification of the graphics subsystem,
  231. * @return OBS_VIDEO_SUCCESS if sucessful
  232. * OBS_VIDEO_NOT_SUPPORTED if the adapter lacks capabilities
  233. * OBS_VIDEO_INVALID_PARAM if a parameter is invalid
  234. * OBS_VIDEO_CURRENTLY_ACTIVE if video is currently active
  235. * OBS_VIDEO_MODULE_NOT_FOUND if the graphics module is not found
  236. * OBS_VIDEO_FAIL for generic failure
  237. */
  238. EXPORT int obs_reset_video(struct obs_video_info *ovi);
  239. /**
  240. * Sets base audio output format/channels/samples/etc
  241. *
  242. * @note Cannot reset base audio if an output is currently active.
  243. */
  244. EXPORT bool obs_reset_audio(const struct obs_audio_info *oai);
  245. /** Gets the current video settings, returns false if no video */
  246. EXPORT bool obs_get_video_info(struct obs_video_info *ovi);
  247. /** Gets the current audio settings, returns false if no audio */
  248. EXPORT bool obs_get_audio_info(struct obs_audio_info *oai);
  249. /**
  250. * Opens a plugin module directly from a specific path.
  251. *
  252. * If the module already exists then the function will return successful, and
  253. * the module parameter will be given the pointer to the existing module.
  254. *
  255. * This does not initialize the module, it only loads the module image. To
  256. * initialize the module, call obs_init_module.
  257. *
  258. * @param module The pointer to the created module.
  259. * @param path Specifies the path to the module library file. If the
  260. * extension is not specified, it will use the extension
  261. * appropriate to the operating system.
  262. * @param data_path Specifies the path to the directory where the module's
  263. * data files are stored.
  264. * @returns MODULE_SUCCESS if successful
  265. * MODULE_ERROR if a generic error occurred
  266. * MODULE_FILE_NOT_FOUND if the module was not found
  267. * MODULE_MISSING_EXPORTS if required exports are missing
  268. * MODULE_INCOMPATIBLE_VER if incompatible version
  269. */
  270. EXPORT int obs_open_module(obs_module_t **module, const char *path,
  271. const char *data_path);
  272. /**
  273. * Initializes the module, which calls its obs_module_load export. If the
  274. * module is alrady loaded, then this function does nothing and returns
  275. * successful.
  276. */
  277. EXPORT bool obs_init_module(obs_module_t *module);
  278. /** Returns the module file name */
  279. EXPORT const char *obs_get_module_file_name(obs_module_t *module);
  280. /** Returns the module full name */
  281. EXPORT const char *obs_get_module_name(obs_module_t *module);
  282. /** Returns the module author(s) */
  283. EXPORT const char *obs_get_module_author(obs_module_t *module);
  284. /** Returns the module description */
  285. EXPORT const char *obs_get_module_description(obs_module_t *module);
  286. /** Returns the module binary path */
  287. EXPORT const char *obs_get_module_binary_path(obs_module_t *module);
  288. /** Returns the module data path */
  289. EXPORT const char *obs_get_module_data_path(obs_module_t *module);
  290. /**
  291. * Adds a module search path to be used with obs_find_modules. If the search
  292. * path strings contain %module%, that text will be replaced with the module
  293. * name when used.
  294. *
  295. * @param bin Specifies the module's binary directory search path.
  296. * @param data Specifies the module's data directory search path.
  297. */
  298. EXPORT void obs_add_module_path(const char *bin, const char *data);
  299. /** Automatically loads all modules from module paths (convenience function) */
  300. EXPORT void obs_load_all_modules(void);
  301. struct obs_module_info {
  302. const char *bin_path;
  303. const char *data_path;
  304. };
  305. typedef void (*obs_find_module_callback_t)(void *param,
  306. const struct obs_module_info *info);
  307. /** Finds all modules within the search paths added by obs_add_module_path. */
  308. EXPORT void obs_find_modules(obs_find_module_callback_t callback, void *param);
  309. typedef void (*obs_enum_module_callback_t)(void *param, obs_module_t *module);
  310. /** Enumerates all loaded modules */
  311. EXPORT void obs_enum_modules(obs_enum_module_callback_t callback, void *param);
  312. /** Helper function for using default module locale */
  313. EXPORT lookup_t *obs_module_load_locale(obs_module_t *module,
  314. const char *default_locale, const char *locale);
  315. /**
  316. * Returns the location of a plugin module data file.
  317. *
  318. * @note Modules should use obs_module_file function defined in obs-module.h
  319. * as a more elegant means of getting their files without having to
  320. * specify the module parameter.
  321. *
  322. * @param module The module associated with the file to locate
  323. * @param file The file to locate
  324. * @return Path string, or NULL if not found. Use bfree to free string.
  325. */
  326. EXPORT char *obs_find_module_file(obs_module_t *module, const char *file);
  327. /**
  328. * Enumerates all available inputs source types.
  329. *
  330. * Inputs are general source inputs (such as capture sources, device sources,
  331. * etc).
  332. */
  333. EXPORT bool obs_enum_input_types(size_t idx, const char **id);
  334. /**
  335. * Enumerates all available filter source types.
  336. *
  337. * Filters are sources that are used to modify the video/audio output of
  338. * other sources.
  339. */
  340. EXPORT bool obs_enum_filter_types(size_t idx, const char **id);
  341. /**
  342. * Enumerates all available transition source types.
  343. *
  344. * Transitions are sources used to transition between two or more other
  345. * sources.
  346. */
  347. EXPORT bool obs_enum_transition_types(size_t idx, const char **id);
  348. /** Enumerates all available output types. */
  349. EXPORT bool obs_enum_output_types(size_t idx, const char **id);
  350. /** Enumerates all available encoder types. */
  351. EXPORT bool obs_enum_encoder_types(size_t idx, const char **id);
  352. /** Enumerates all available service types. */
  353. EXPORT bool obs_enum_service_types(size_t idx, const char **id);
  354. /** Helper function for entering the OBS graphics context */
  355. EXPORT void obs_enter_graphics(void);
  356. /** Helper function for leaving the OBS graphics context */
  357. EXPORT void obs_leave_graphics(void);
  358. /** Gets the main audio output handler for this OBS context */
  359. EXPORT audio_t *obs_get_audio(void);
  360. /** Gets the main video output handler for this OBS context */
  361. EXPORT video_t *obs_get_video(void);
  362. /**
  363. * Adds a source to the user source list and increments the reference counter
  364. * for that source.
  365. *
  366. * The user source list is the list of sources that are accessible by a user.
  367. * Typically when a transition is active, it is not meant to be accessible by
  368. * users, so there's no reason for a user to see such a source.
  369. */
  370. EXPORT bool obs_add_source(obs_source_t *source);
  371. /** Sets the primary output source for a channel. */
  372. EXPORT void obs_set_output_source(uint32_t channel, obs_source_t *source);
  373. /**
  374. * Gets the primary output source for a channel and increments the reference
  375. * counter for that source. Use obs_source_release to release.
  376. */
  377. EXPORT obs_source_t *obs_get_output_source(uint32_t channel);
  378. /**
  379. * Enumerates user sources
  380. *
  381. * Callback function returns true to continue enumeration, or false to end
  382. * enumeration.
  383. */
  384. EXPORT void obs_enum_sources(bool (*enum_proc)(void*, obs_source_t*),
  385. void *param);
  386. /** Enumerates outputs */
  387. EXPORT void obs_enum_outputs(bool (*enum_proc)(void*, obs_output_t*),
  388. void *param);
  389. /** Enumerates encoders */
  390. EXPORT void obs_enum_encoders(bool (*enum_proc)(void*, obs_encoder_t*),
  391. void *param);
  392. /** Enumerates encoders */
  393. EXPORT void obs_enum_services(bool (*enum_proc)(void*, obs_service_t*),
  394. void *param);
  395. /**
  396. * Gets a source by its name.
  397. *
  398. * Increments the source reference counter, use obs_source_release to
  399. * release it when complete.
  400. */
  401. EXPORT obs_source_t *obs_get_source_by_name(const char *name);
  402. /** Gets an output by its name. */
  403. EXPORT obs_output_t *obs_get_output_by_name(const char *name);
  404. /** Gets an encoder by its name. */
  405. EXPORT obs_encoder_t *obs_get_encoder_by_name(const char *name);
  406. /** Gets an service by its name. */
  407. EXPORT obs_service_t *obs_get_service_by_name(const char *name);
  408. /** Returns the default effect for generic RGB/YUV drawing */
  409. EXPORT gs_effect_t *obs_get_default_effect(void);
  410. /** Returns the default effect for generic RGB/YUV drawing using texture_rect */
  411. EXPORT gs_effect_t *obs_get_default_rect_effect(void);
  412. /** Returns the default effect for generic RGB/YUV drawing (alpha set to 1) */
  413. EXPORT gs_effect_t *obs_get_opaque_effect(void);
  414. /** Returns the solid effect for drawing solid colors */
  415. EXPORT gs_effect_t *obs_get_solid_effect(void);
  416. /** Returns the bicubic scaling effect */
  417. EXPORT gs_effect_t *obs_get_bicubic_effect(void);
  418. /** Returns the lanczos scaling effect */
  419. EXPORT gs_effect_t *obs_get_lanczos_effect(void);
  420. /** Returns the primary obs signal handler */
  421. EXPORT signal_handler_t *obs_get_signal_handler(void);
  422. /** Returns the primary obs procedure handler */
  423. EXPORT proc_handler_t *obs_get_proc_handler(void);
  424. /** Adds a draw callback to the main render context */
  425. EXPORT void obs_add_draw_callback(
  426. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  427. void *param);
  428. /** Removes a draw callback to the main render context */
  429. EXPORT void obs_remove_draw_callback(
  430. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  431. void *param);
  432. /** Changes the size of the main view */
  433. EXPORT void obs_resize(uint32_t cx, uint32_t cy);
  434. /** Renders the main view */
  435. EXPORT void obs_render_main_view(void);
  436. /** Sets the master user volume */
  437. EXPORT void obs_set_master_volume(float volume);
  438. /** Sets the master presentation volume */
  439. EXPORT void obs_set_present_volume(float volume);
  440. /** Gets the master user volume */
  441. EXPORT float obs_get_master_volume(void);
  442. /** Gets the master presentation volume */
  443. EXPORT float obs_get_present_volume(void);
  444. /** Saves a source to settings data */
  445. EXPORT obs_data_t *obs_save_source(obs_source_t *source);
  446. /** Loads a source from settings data */
  447. EXPORT obs_source_t *obs_load_source(obs_data_t *data);
  448. /** Loads sources from a data array */
  449. EXPORT void obs_load_sources(obs_data_array_t *array);
  450. /** Saves sources to a data array */
  451. EXPORT obs_data_array_t *obs_save_sources(void);
  452. /* ------------------------------------------------------------------------- */
  453. /* View context */
  454. /**
  455. * Creates a view context.
  456. *
  457. * A view can be used for things like separate previews, or drawing
  458. * sources separately.
  459. */
  460. EXPORT obs_view_t *obs_view_create(void);
  461. /** Destroys this view context */
  462. EXPORT void obs_view_destroy(obs_view_t *view);
  463. /** Sets the source to be used for this view context. */
  464. EXPORT void obs_view_set_source(obs_view_t *view, uint32_t channel,
  465. obs_source_t *source);
  466. /** Gets the source currently in use for this view context */
  467. EXPORT obs_source_t *obs_view_get_source(obs_view_t *view,
  468. uint32_t channel);
  469. /** Renders the sources of this view context */
  470. EXPORT void obs_view_render(obs_view_t *view);
  471. /* ------------------------------------------------------------------------- */
  472. /* Display context */
  473. /**
  474. * Adds a new window display linked to the main render pipeline. This creates
  475. * a new swap chain which updates every frame.
  476. *
  477. * @param graphics_data The swap chain initialization data.
  478. * @return The new display context, or NULL if failed.
  479. */
  480. EXPORT obs_display_t *obs_display_create(
  481. const struct gs_init_data *graphics_data);
  482. /** Destroys a display context */
  483. EXPORT void obs_display_destroy(obs_display_t *display);
  484. /** Changes the size of this display */
  485. EXPORT void obs_display_resize(obs_display_t *display, uint32_t cx,
  486. uint32_t cy);
  487. /**
  488. * Adds a draw callback for this display context
  489. *
  490. * @param display The display context.
  491. * @param draw The draw callback which is called each time a frame
  492. * updates.
  493. * @param param The user data to be associated with this draw callback.
  494. */
  495. EXPORT void obs_display_add_draw_callback(obs_display_t *display,
  496. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  497. void *param);
  498. /** Removes a draw callback for this display context */
  499. EXPORT void obs_display_remove_draw_callback(obs_display_t *display,
  500. void (*draw)(void *param, uint32_t cx, uint32_t cy),
  501. void *param);
  502. EXPORT void obs_display_set_enabled(obs_display_t *display, bool enable);
  503. EXPORT bool obs_display_enabled(obs_display_t *display);
  504. /* ------------------------------------------------------------------------- */
  505. /* Sources */
  506. /** Returns the translated display name of a source */
  507. EXPORT const char *obs_source_get_display_name(enum obs_source_type type,
  508. const char *id);
  509. /**
  510. * Creates a source of the specified type with the specified settings.
  511. *
  512. * The "source" context is used for anything related to presenting
  513. * or modifying video/audio. Use obs_source_release to release it.
  514. */
  515. EXPORT obs_source_t *obs_source_create(enum obs_source_type type,
  516. const char *id, const char *name, obs_data_t *settings);
  517. /**
  518. * Adds/releases a reference to a source. When the last reference is
  519. * released, the source is destroyed.
  520. */
  521. EXPORT void obs_source_addref(obs_source_t *source);
  522. EXPORT void obs_source_release(obs_source_t *source);
  523. /** Notifies all references that the source should be released */
  524. EXPORT void obs_source_remove(obs_source_t *source);
  525. /** Returns true if the source should be released */
  526. EXPORT bool obs_source_removed(const obs_source_t *source);
  527. /** Returns capability flags of a source */
  528. EXPORT uint32_t obs_source_get_output_flags(const obs_source_t *source);
  529. /** Returns capability flags of a source type */
  530. EXPORT uint32_t obs_get_source_output_flags(enum obs_source_type type,
  531. const char *id);
  532. /** Gets the default settings for a source type */
  533. EXPORT obs_data_t *obs_get_source_defaults(enum obs_source_type type,
  534. const char *id);
  535. /** Returns the property list, if any. Free with obs_properties_destroy */
  536. EXPORT obs_properties_t *obs_get_source_properties(enum obs_source_type type,
  537. const char *id);
  538. /**
  539. * Returns the properties list for a specific existing source. Free with
  540. * obs_properties_destroy
  541. */
  542. EXPORT obs_properties_t *obs_source_properties(const obs_source_t *source);
  543. /** Updates settings for this source */
  544. EXPORT void obs_source_update(obs_source_t *source, obs_data_t *settings);
  545. /** Renders a video source. */
  546. EXPORT void obs_source_video_render(obs_source_t *source);
  547. /** Gets the width of a source (if it has video) */
  548. EXPORT uint32_t obs_source_get_width(obs_source_t *source);
  549. /** Gets the height of a source (if it has video) */
  550. EXPORT uint32_t obs_source_get_height(obs_source_t *source);
  551. /**
  552. * If the source is a filter, returns the parent source of the filter. Only
  553. * guaranteed to be valid inside of the video_render, filter_audio,
  554. * filter_video, and filter_remove callbacks.
  555. */
  556. EXPORT obs_source_t *obs_filter_get_parent(const obs_source_t *filter);
  557. /**
  558. * If the source is a filter, returns the target source of the filter. Only
  559. * guaranteed to be valid inside of the video_render, filter_audio,
  560. * filter_video, and filter_remove callbacks.
  561. */
  562. EXPORT obs_source_t *obs_filter_get_target(const obs_source_t *filter);
  563. /** Adds a filter to the source (which is used whenever the source is used) */
  564. EXPORT void obs_source_filter_add(obs_source_t *source, obs_source_t *filter);
  565. /** Removes a filter from the source */
  566. EXPORT void obs_source_filter_remove(obs_source_t *source,
  567. obs_source_t *filter);
  568. /** Modifies the order of a specific filter */
  569. EXPORT void obs_source_filter_set_order(obs_source_t *source,
  570. obs_source_t *filter, enum obs_order_movement movement);
  571. /** Gets the settings string for a source */
  572. EXPORT obs_data_t *obs_source_get_settings(const obs_source_t *source);
  573. /** Gets the name of a source */
  574. EXPORT const char *obs_source_get_name(const obs_source_t *source);
  575. /** Sets the name of a source */
  576. EXPORT void obs_source_set_name(obs_source_t *source, const char *name);
  577. /** Gets the source type */
  578. EXPORT enum obs_source_type obs_source_get_type(const obs_source_t *source);
  579. /** Gets the source identifier */
  580. EXPORT const char *obs_source_get_id(const obs_source_t *source);
  581. /** Returns the signal handler for a source */
  582. EXPORT signal_handler_t *obs_source_get_signal_handler(
  583. const obs_source_t *source);
  584. /** Returns the procedure handler for a source */
  585. EXPORT proc_handler_t *obs_source_get_proc_handler(const obs_source_t *source);
  586. /** Sets the user volume for a source that has audio output */
  587. EXPORT void obs_source_set_volume(obs_source_t *source, float volume);
  588. /** Sets the presentation volume for a source */
  589. EXPORT void obs_source_set_present_volume(obs_source_t *source, float volume);
  590. /** Gets the user volume for a source that has audio output */
  591. EXPORT float obs_source_get_volume(const obs_source_t *source);
  592. /** Gets the presentation volume for a source */
  593. EXPORT float obs_source_get_present_volume(const obs_source_t *source);
  594. /** Sets the audio sync offset (in nanoseconds) for a source */
  595. EXPORT void obs_source_set_sync_offset(obs_source_t *source, int64_t offset);
  596. /** Gets the audio sync offset (in nanoseconds) for a source */
  597. EXPORT int64_t obs_source_get_sync_offset(const obs_source_t *source);
  598. /** Enumerates child sources used by this source */
  599. EXPORT void obs_source_enum_sources(obs_source_t *source,
  600. obs_source_enum_proc_t enum_callback,
  601. void *param);
  602. /** Enumerates the entire child source tree used by this source */
  603. EXPORT void obs_source_enum_tree(obs_source_t *source,
  604. obs_source_enum_proc_t enum_callback,
  605. void *param);
  606. /** Returns true if active, false if not */
  607. EXPORT bool obs_source_active(const obs_source_t *source);
  608. /**
  609. * Returns true if currently displayed somewhere (active or not), false if not
  610. */
  611. EXPORT bool obs_source_showing(const obs_source_t *source);
  612. /**
  613. * Sometimes sources need to be told when to save their settings so they
  614. * don't have to constantly update and keep track of their settings. This will
  615. * call the source's 'save' callback if any, which will save its current
  616. * data to its settings.
  617. */
  618. EXPORT void obs_source_save(obs_source_t *source);
  619. /**
  620. * Sometimes sources need to be told when they are loading their settings
  621. * from prior saved data. This is different from a source 'update' in that
  622. * it's meant to be used after the source has been created and loaded from
  623. * somewhere (such as a saved file).
  624. */
  625. EXPORT void obs_source_load(obs_source_t *source);
  626. /** Specifies that async video frames should be played as soon as possible */
  627. #define OBS_SOURCE_FLAG_UNBUFFERED (1<<0)
  628. /** Specifies to force audio to mono */
  629. #define OBS_SOURCE_FLAG_FORCE_MONO (1<<1)
  630. /**
  631. * Sets source flags. Note that these are different from the main output
  632. * flags. These are generally things that can be set by the source or user,
  633. * while the output flags are more used to determine capabilities of a source.
  634. */
  635. EXPORT void obs_source_set_flags(obs_source_t *source, uint32_t flags);
  636. /** Gets source flags. */
  637. EXPORT uint32_t obs_source_get_flags(const obs_source_t *source);
  638. /**
  639. * Sets audio mixer flags. These flags are used to specify which mixers
  640. * the source's audio should be applied to.
  641. */
  642. EXPORT void obs_source_set_audio_mixers(obs_source_t *source, uint32_t mixers);
  643. /** Gets audio mixer flags */
  644. EXPORT uint32_t obs_source_get_audio_mixers(const obs_source_t *source);
  645. /**
  646. * Increments the 'showing' reference counter to indicate that the source is
  647. * being shown somewhere. If the reference counter was 0, will call the 'show'
  648. * callback.
  649. */
  650. EXPORT void obs_source_inc_showing(obs_source_t *source);
  651. /**
  652. * Decrements the 'showing' reference counter to indicate that the source is
  653. * no longer being shown somewhere. If the reference counter is set to 0,
  654. * will call the 'hide' callback
  655. */
  656. EXPORT void obs_source_dec_showing(obs_source_t *source);
  657. /** Enumerates filters assigned to the source */
  658. EXPORT void obs_source_enum_filters(obs_source_t *source,
  659. obs_source_enum_proc_t callback, void *param);
  660. /** Gets a filter of a source by its display name. */
  661. EXPORT obs_source_t *obs_source_get_filter_by_name(obs_source_t *source,
  662. const char *name);
  663. EXPORT bool obs_source_enabled(const obs_source_t *source);
  664. EXPORT void obs_source_set_enabled(obs_source_t *source, bool enabled);
  665. EXPORT bool obs_source_muted(const obs_source_t *source);
  666. EXPORT void obs_source_set_muted(obs_source_t *source, bool muted);
  667. /* ------------------------------------------------------------------------- */
  668. /* Functions used by sources */
  669. /**
  670. * Helper function to set the color matrix information when drawing the source.
  671. *
  672. * @param color_matrix The color matrix. Assigns to the 'color_matrix'
  673. * effect variable.
  674. * @param color_range_min The minimum color range. Assigns to the
  675. * 'color_range_min' effect variable. If NULL,
  676. * {0.0f, 0.0f, 0.0f} is used.
  677. * @param color_range_max The maximum color range. Assigns to the
  678. * 'color_range_max' effect variable. If NULL,
  679. * {1.0f, 1.0f, 1.0f} is used.
  680. */
  681. EXPORT void obs_source_draw_set_color_matrix(
  682. const struct matrix4 *color_matrix,
  683. const struct vec3 *color_range_min,
  684. const struct vec3 *color_range_max);
  685. /**
  686. * Helper function to draw sprites for a source (synchronous video).
  687. *
  688. * @param image The sprite texture to draw. Assigns to the 'image' variable
  689. * of the current effect.
  690. * @param x X position of the sprite.
  691. * @param y Y position of the sprite.
  692. * @param cx Width of the sprite. If 0, uses the texture width.
  693. * @param cy Height of the sprite. If 0, uses the texture height.
  694. * @param flip Specifies whether to flip the image vertically.
  695. */
  696. EXPORT void obs_source_draw(gs_texture_t *image, int x, int y,
  697. uint32_t cx, uint32_t cy, bool flip);
  698. /** Outputs asynchronous video data. Set to NULL to deactivate the texture */
  699. EXPORT void obs_source_output_video(obs_source_t *source,
  700. const struct obs_source_frame *frame);
  701. /** Outputs audio data (always asynchronous) */
  702. EXPORT void obs_source_output_audio(obs_source_t *source,
  703. const struct obs_source_audio *audio);
  704. /** Signal an update to any currently used properties via 'update_properties' */
  705. EXPORT void obs_source_update_properties(obs_source_t *source);
  706. /** Gets the current async video frame */
  707. EXPORT struct obs_source_frame *obs_source_get_frame(obs_source_t *source);
  708. /** Releases the current async video frame */
  709. EXPORT void obs_source_release_frame(obs_source_t *source,
  710. struct obs_source_frame *frame);
  711. /**
  712. * Default RGB filter handler for generic effect filters. Processes the
  713. * filter chain and renders them to texture if needed, then the filter is
  714. * drawn with
  715. *
  716. * After calling this, set your parameters for the effect, then call
  717. * obs_source_process_filter_end to draw the filter.
  718. */
  719. EXPORT void obs_source_process_filter_begin(obs_source_t *filter,
  720. enum gs_color_format format,
  721. enum obs_allow_direct_render allow_direct);
  722. /**
  723. * Draws the filter.
  724. *
  725. * Before calling this function, first call obs_source_process_filter_begin and
  726. * then set the effect parameters, and then call this function to finalize the
  727. * filter.
  728. */
  729. EXPORT void obs_source_process_filter_end(obs_source_t *filter,
  730. gs_effect_t *effect, uint32_t width, uint32_t height);
  731. /** Skips the filter if the filter is invalid and cannot be rendered */
  732. EXPORT void obs_source_skip_video_filter(obs_source_t *filter);
  733. /**
  734. * Adds a child source. Must be called by parent sources on child sources
  735. * when the child is added. This ensures that the source is properly activated
  736. * if the parent is active.
  737. *
  738. * @returns true if source can be added, false if it causes recursion
  739. */
  740. EXPORT bool obs_source_add_child(obs_source_t *parent, obs_source_t *child);
  741. /**
  742. * Removes a child source. Must be called by parent sources on child sources
  743. * when the child is removed. This ensures that the source is properly
  744. * deactivated if the parent is active.
  745. */
  746. EXPORT void obs_source_remove_child(obs_source_t *parent, obs_source_t *child);
  747. /** Sends a mouse down/up event to a source */
  748. EXPORT void obs_source_send_mouse_click(obs_source_t *source,
  749. const struct obs_mouse_event *event,
  750. int32_t type, bool mouse_up,
  751. uint32_t click_count);
  752. /** Sends a mouse move event to a source. */
  753. EXPORT void obs_source_send_mouse_move(obs_source_t *source,
  754. const struct obs_mouse_event *event, bool mouse_leave);
  755. /** Sends a mouse wheel event to a source */
  756. EXPORT void obs_source_send_mouse_wheel(obs_source_t *source,
  757. const struct obs_mouse_event *event, int x_delta, int y_delta);
  758. /** Sends a got-focus or lost-focus event to a source */
  759. EXPORT void obs_source_send_focus(obs_source_t *source, bool focus);
  760. /** Sends a key up/down event to a source */
  761. EXPORT void obs_source_send_key_click(obs_source_t *source,
  762. const struct obs_key_event *event, bool key_up);
  763. /** Sets the default source flags. */
  764. EXPORT void obs_source_set_default_flags(obs_source_t *source, uint32_t flags);
  765. /** Gets the base width for a source (not taking in to account filtering) */
  766. EXPORT uint32_t obs_source_get_base_width(obs_source_t *source);
  767. /** Gets the base height for a source (not taking in to account filtering) */
  768. EXPORT uint32_t obs_source_get_base_height(obs_source_t *source);
  769. /* ------------------------------------------------------------------------- */
  770. /* Scenes */
  771. /**
  772. * Creates a scene.
  773. *
  774. * A scene is a source which is a container of other sources with specific
  775. * display oriantations. Scenes can also be used like any other source.
  776. */
  777. EXPORT obs_scene_t *obs_scene_create(const char *name);
  778. EXPORT void obs_scene_addref(obs_scene_t *scene);
  779. EXPORT void obs_scene_release(obs_scene_t *scene);
  780. /** Gets the scene's source context */
  781. EXPORT obs_source_t *obs_scene_get_source(const obs_scene_t *scene);
  782. /** Gets the scene from its source, or NULL if not a scene */
  783. EXPORT obs_scene_t *obs_scene_from_source(const obs_source_t *source);
  784. /** Determines whether a source is within a scene */
  785. EXPORT obs_sceneitem_t *obs_scene_find_source(obs_scene_t *scene,
  786. const char *name);
  787. /** Enumerates sources within a scene */
  788. EXPORT void obs_scene_enum_items(obs_scene_t *scene,
  789. bool (*callback)(obs_scene_t*, obs_sceneitem_t*, void*),
  790. void *param);
  791. /** Adds/creates a new scene item for a source */
  792. EXPORT obs_sceneitem_t *obs_scene_add(obs_scene_t *scene, obs_source_t *source);
  793. EXPORT void obs_sceneitem_addref(obs_sceneitem_t *item);
  794. EXPORT void obs_sceneitem_release(obs_sceneitem_t *item);
  795. /** Removes a scene item. */
  796. EXPORT void obs_sceneitem_remove(obs_sceneitem_t *item);
  797. /** Gets the scene parent associated with the scene item. */
  798. EXPORT obs_scene_t *obs_sceneitem_get_scene(const obs_sceneitem_t *item);
  799. /** Gets the source of a scene item. */
  800. EXPORT obs_source_t *obs_sceneitem_get_source(const obs_sceneitem_t *item);
  801. EXPORT void obs_sceneitem_select(obs_sceneitem_t *item, bool select);
  802. EXPORT bool obs_sceneitem_selected(const obs_sceneitem_t *item);
  803. /* Functions for gettings/setting specific orientation of a scene item */
  804. EXPORT void obs_sceneitem_set_pos(obs_sceneitem_t *item, const struct vec2 *pos);
  805. EXPORT void obs_sceneitem_set_rot(obs_sceneitem_t *item, float rot_deg);
  806. EXPORT void obs_sceneitem_set_scale(obs_sceneitem_t *item,
  807. const struct vec2 *scale);
  808. EXPORT void obs_sceneitem_set_alignment(obs_sceneitem_t *item,
  809. uint32_t alignment);
  810. EXPORT void obs_sceneitem_set_order(obs_sceneitem_t *item,
  811. enum obs_order_movement movement);
  812. EXPORT void obs_sceneitem_set_order_position(obs_sceneitem_t *item,
  813. int position);
  814. EXPORT void obs_sceneitem_set_bounds_type(obs_sceneitem_t *item,
  815. enum obs_bounds_type type);
  816. EXPORT void obs_sceneitem_set_bounds_alignment(obs_sceneitem_t *item,
  817. uint32_t alignment);
  818. EXPORT void obs_sceneitem_set_bounds(obs_sceneitem_t *item,
  819. const struct vec2 *bounds);
  820. EXPORT void obs_sceneitem_get_pos(const obs_sceneitem_t *item,
  821. struct vec2 *pos);
  822. EXPORT float obs_sceneitem_get_rot(const obs_sceneitem_t *item);
  823. EXPORT void obs_sceneitem_get_scale(const obs_sceneitem_t *item,
  824. struct vec2 *scale);
  825. EXPORT uint32_t obs_sceneitem_get_alignment(const obs_sceneitem_t *item);
  826. EXPORT enum obs_bounds_type obs_sceneitem_get_bounds_type(
  827. const obs_sceneitem_t *item);
  828. EXPORT uint32_t obs_sceneitem_get_bounds_alignment(const obs_sceneitem_t *item);
  829. EXPORT void obs_sceneitem_get_bounds(const obs_sceneitem_t *item,
  830. struct vec2 *bounds);
  831. EXPORT void obs_sceneitem_get_info(const obs_sceneitem_t *item,
  832. struct obs_transform_info *info);
  833. EXPORT void obs_sceneitem_set_info(obs_sceneitem_t *item,
  834. const struct obs_transform_info *info);
  835. EXPORT void obs_sceneitem_get_draw_transform(const obs_sceneitem_t *item,
  836. struct matrix4 *transform);
  837. EXPORT void obs_sceneitem_get_box_transform(const obs_sceneitem_t *item,
  838. struct matrix4 *transform);
  839. EXPORT bool obs_sceneitem_visible(const obs_sceneitem_t *item);
  840. EXPORT void obs_sceneitem_set_visible(obs_sceneitem_t *item, bool visible);
  841. /* ------------------------------------------------------------------------- */
  842. /* Outputs */
  843. EXPORT const char *obs_output_get_display_name(const char *id);
  844. /**
  845. * Creates an output.
  846. *
  847. * Outputs allow outputting to file, outputting to network, outputting to
  848. * directshow, or other custom outputs.
  849. */
  850. EXPORT obs_output_t *obs_output_create(const char *id, const char *name,
  851. obs_data_t *settings);
  852. EXPORT void obs_output_destroy(obs_output_t *output);
  853. EXPORT const char *obs_output_get_name(const obs_output_t *output);
  854. /** Starts the output. */
  855. EXPORT bool obs_output_start(obs_output_t *output);
  856. /** Stops the output. */
  857. EXPORT void obs_output_stop(obs_output_t *output);
  858. /** Returns whether the output is active */
  859. EXPORT bool obs_output_active(const obs_output_t *output);
  860. /** Gets the default settings for an output type */
  861. EXPORT obs_data_t *obs_output_defaults(const char *id);
  862. /** Returns the property list, if any. Free with obs_properties_destroy */
  863. EXPORT obs_properties_t *obs_get_output_properties(const char *id);
  864. /**
  865. * Returns the property list of an existing output, if any. Free with
  866. * obs_properties_destroy
  867. */
  868. EXPORT obs_properties_t *obs_output_properties(const obs_output_t *output);
  869. /** Updates the settings for this output context */
  870. EXPORT void obs_output_update(obs_output_t *output, obs_data_t *settings);
  871. /** Specifies whether the output can be paused */
  872. EXPORT bool obs_output_canpause(const obs_output_t *output);
  873. /** Pauses the output (if the functionality is allowed by the output */
  874. EXPORT void obs_output_pause(obs_output_t *output);
  875. /* Gets the current output settings string */
  876. EXPORT obs_data_t *obs_output_get_settings(const obs_output_t *output);
  877. /** Returns the signal handler for an output */
  878. EXPORT signal_handler_t *obs_output_get_signal_handler(
  879. const obs_output_t *output);
  880. /** Returns the procedure handler for an output */
  881. EXPORT proc_handler_t *obs_output_get_proc_handler(const obs_output_t *output);
  882. /**
  883. * Sets the current video media context associated with this output,
  884. * required for non-encoded outputs
  885. */
  886. EXPORT void obs_output_set_video(obs_output_t *output, video_t *video);
  887. /**
  888. * Sets the current audio/video media contexts associated with this output,
  889. * required for non-encoded outputs. Can be null.
  890. */
  891. EXPORT void obs_output_set_media(obs_output_t *output,
  892. video_t *video, audio_t *audio);
  893. /** Returns the video media context associated with this output */
  894. EXPORT video_t *obs_output_video(const obs_output_t *output);
  895. /** Returns the audio media context associated with this output */
  896. EXPORT audio_t *obs_output_audio(const obs_output_t *output);
  897. /** Sets the current audio mixer for non-encoded outputs */
  898. EXPORT void obs_output_set_mixer(obs_output_t *output, size_t mixer_idx);
  899. /** Gets the current audio mixer for non-encoded outputs */
  900. EXPORT size_t obs_output_get_mixer(const obs_output_t *output);
  901. /**
  902. * Sets the current video encoder associated with this output,
  903. * required for encoded outputs
  904. */
  905. EXPORT void obs_output_set_video_encoder(obs_output_t *output,
  906. obs_encoder_t *encoder);
  907. /**
  908. * Sets the current audio encoder associated with this output,
  909. * required for encoded outputs.
  910. *
  911. * The idx parameter specifies the audio encoder index to set the encoder to.
  912. * Only used with outputs that have multiple audio outputs (RTMP typically),
  913. * otherwise the parameter is ignored.
  914. */
  915. EXPORT void obs_output_set_audio_encoder(obs_output_t *output,
  916. obs_encoder_t *encoder, size_t idx);
  917. /** Returns the current video encoder associated with this output */
  918. EXPORT obs_encoder_t *obs_output_get_video_encoder(const obs_output_t *output);
  919. /**
  920. * Returns the current audio encoder associated with this output
  921. *
  922. * The idx parameter specifies the audio encoder index. Only used with
  923. * outputs that have multiple audio outputs, otherwise the parameter is
  924. * ignored.
  925. */
  926. EXPORT obs_encoder_t *obs_output_get_audio_encoder(const obs_output_t *output,
  927. size_t idx);
  928. /** Sets the current service associated with this output. */
  929. EXPORT void obs_output_set_service(obs_output_t *output,
  930. obs_service_t *service);
  931. /** Gets the current service associated with this output. */
  932. EXPORT obs_service_t *obs_output_get_service(const obs_output_t *output);
  933. /**
  934. * Sets the reconnect settings. Set retry_count to 0 to disable reconnecting.
  935. */
  936. EXPORT void obs_output_set_reconnect_settings(obs_output_t *output,
  937. int retry_count, int retry_sec);
  938. EXPORT uint64_t obs_output_get_total_bytes(const obs_output_t *output);
  939. EXPORT int obs_output_get_frames_dropped(const obs_output_t *output);
  940. EXPORT int obs_output_get_total_frames(const obs_output_t *output);
  941. /**
  942. * Sets the preferred scaled resolution for this output. Set width and height
  943. * to 0 to disable scaling.
  944. *
  945. * If this output uses an encoder, it will call obs_encoder_set_scaled_size on
  946. * the encoder before the stream is started. If the encoder is already active,
  947. * then this function will trigger a warning and do nothing.
  948. */
  949. EXPORT void obs_output_set_preferred_size(obs_output_t *output, uint32_t width,
  950. uint32_t height);
  951. /** For video outputs, returns the width of the encoded image */
  952. EXPORT uint32_t obs_output_get_width(const obs_output_t *output);
  953. /** For video outputs, returns the height of the encoded image */
  954. EXPORT uint32_t obs_output_get_height(const obs_output_t *output);
  955. /* ------------------------------------------------------------------------- */
  956. /* Functions used by outputs */
  957. /** Optionally sets the video conversion info. Used only for raw output */
  958. EXPORT void obs_output_set_video_conversion(obs_output_t *output,
  959. const struct video_scale_info *conversion);
  960. /** Optionally sets the audio conversion info. Used only for raw output */
  961. EXPORT void obs_output_set_audio_conversion(obs_output_t *output,
  962. const struct audio_convert_info *conversion);
  963. /** Returns whether data capture can begin with the specified flags */
  964. EXPORT bool obs_output_can_begin_data_capture(const obs_output_t *output,
  965. uint32_t flags);
  966. /** Initializes encoders (if any) */
  967. EXPORT bool obs_output_initialize_encoders(obs_output_t *output,
  968. uint32_t flags);
  969. /**
  970. * Begins data capture from media/encoders.
  971. *
  972. * @param output Output context
  973. * @param flags Set this to 0 to use default output flags set in the
  974. * obs_output_info structure, otherwise set to a either
  975. * OBS_OUTPUT_VIDEO or OBS_OUTPUT_AUDIO to specify whether to
  976. * connect audio or video. This is useful for things like
  977. * ffmpeg which may or may not always want to use both audio
  978. * and video.
  979. * @return true if successful, false otherwise.
  980. */
  981. EXPORT bool obs_output_begin_data_capture(obs_output_t *output, uint32_t flags);
  982. /** Ends data capture from media/encoders */
  983. EXPORT void obs_output_end_data_capture(obs_output_t *output);
  984. /**
  985. * Signals that the output has stopped itself.
  986. *
  987. * @param output Output context
  988. * @param code Error code (or OBS_OUTPUT_SUCCESS if not an error)
  989. */
  990. EXPORT void obs_output_signal_stop(obs_output_t *output, int code);
  991. /* ------------------------------------------------------------------------- */
  992. /* Encoders */
  993. EXPORT const char *obs_encoder_get_display_name(const char *id);
  994. /**
  995. * Creates a video encoder context
  996. *
  997. * @param id Video encoder ID
  998. * @param name Name to assign to this context
  999. * @param settings Settings
  1000. * @return The video encoder context, or NULL if failed or not found.
  1001. */
  1002. EXPORT obs_encoder_t *obs_video_encoder_create(const char *id, const char *name,
  1003. obs_data_t *settings);
  1004. /**
  1005. * Creates an audio encoder context
  1006. *
  1007. * @param id Audio Encoder ID
  1008. * @param name Name to assign to this context
  1009. * @param settings Settings
  1010. * @param mixer_idx Index of the mixer to use for this audio encoder
  1011. * @return The video encoder context, or NULL if failed or not found.
  1012. */
  1013. EXPORT obs_encoder_t *obs_audio_encoder_create(const char *id, const char *name,
  1014. obs_data_t *settings, size_t mixer_idx);
  1015. /** Destroys an encoder context */
  1016. EXPORT void obs_encoder_destroy(obs_encoder_t *encoder);
  1017. EXPORT void obs_encoder_set_name(obs_encoder_t *encoder, const char *name);
  1018. EXPORT const char *obs_encoder_get_name(const obs_encoder_t *encoder);
  1019. /** Returns the codec of an encoder by the id */
  1020. EXPORT const char *obs_get_encoder_codec(const char *id);
  1021. /** Returns the type of an encoder by the id */
  1022. EXPORT enum obs_encoder_type obs_get_encoder_type(const char *id);
  1023. /** Returns the codec of the encoder */
  1024. EXPORT const char *obs_encoder_get_codec(const obs_encoder_t *encoder);
  1025. /** Returns the type of an encoder */
  1026. EXPORT enum obs_encoder_type obs_encoder_get_type(const obs_encoder_t *encoder);
  1027. /**
  1028. * Sets the scaled resolution for a video encoder. Set width and height to 0
  1029. * to disable scaling. If the encoder is active, this function will trigger
  1030. * a warning, and do nothing.
  1031. */
  1032. EXPORT void obs_encoder_set_scaled_size(obs_encoder_t *encoder, uint32_t width,
  1033. uint32_t height);
  1034. /** For video encoders, returns the width of the encoded image */
  1035. EXPORT uint32_t obs_encoder_get_width(const obs_encoder_t *encoder);
  1036. /** For video encoders, returns the height of the encoded image */
  1037. EXPORT uint32_t obs_encoder_get_height(const obs_encoder_t *encoder);
  1038. /** Gets the default settings for an encoder type */
  1039. EXPORT obs_data_t *obs_encoder_defaults(const char *id);
  1040. /** Returns the property list, if any. Free with obs_properties_destroy */
  1041. EXPORT obs_properties_t *obs_get_encoder_properties(const char *id);
  1042. /**
  1043. * Returns the property list of an existing encoder, if any. Free with
  1044. * obs_properties_destroy
  1045. */
  1046. EXPORT obs_properties_t *obs_encoder_properties(const obs_encoder_t *encoder);
  1047. /**
  1048. * Updates the settings of the encoder context. Usually used for changing
  1049. * bitrate while active
  1050. */
  1051. EXPORT void obs_encoder_update(obs_encoder_t *encoder, obs_data_t *settings);
  1052. /** Gets extra data (headers) associated with this context */
  1053. EXPORT bool obs_encoder_get_extra_data(const obs_encoder_t *encoder,
  1054. uint8_t **extra_data, size_t *size);
  1055. /** Returns the current settings for this encoder */
  1056. EXPORT obs_data_t *obs_encoder_get_settings(const obs_encoder_t *encoder);
  1057. /** Sets the video output context to be used with this encoder */
  1058. EXPORT void obs_encoder_set_video(obs_encoder_t *encoder, video_t *video);
  1059. /** Sets the audio output context to be used with this encoder */
  1060. EXPORT void obs_encoder_set_audio(obs_encoder_t *encoder, audio_t *audio);
  1061. /**
  1062. * Returns the video output context used with this encoder, or NULL if not
  1063. * a video context
  1064. */
  1065. EXPORT video_t *obs_encoder_video(const obs_encoder_t *encoder);
  1066. /**
  1067. * Returns the audio output context used with this encoder, or NULL if not
  1068. * a audio context
  1069. */
  1070. EXPORT audio_t *obs_encoder_audio(const obs_encoder_t *encoder);
  1071. /** Returns true if encoder is active, false otherwise */
  1072. EXPORT bool obs_encoder_active(const obs_encoder_t *encoder);
  1073. /** Duplicates an encoder packet */
  1074. EXPORT void obs_duplicate_encoder_packet(struct encoder_packet *dst,
  1075. const struct encoder_packet *src);
  1076. EXPORT void obs_free_encoder_packet(struct encoder_packet *packet);
  1077. /* ------------------------------------------------------------------------- */
  1078. /* Stream Services */
  1079. EXPORT const char *obs_service_get_display_name(const char *id);
  1080. EXPORT obs_service_t *obs_service_create(const char *id, const char *name,
  1081. obs_data_t *settings);
  1082. EXPORT void obs_service_destroy(obs_service_t *service);
  1083. EXPORT const char *obs_service_get_name(const obs_service_t *service);
  1084. /** Gets the default settings for a service */
  1085. EXPORT obs_data_t *obs_service_defaults(const char *id);
  1086. /** Returns the property list, if any. Free with obs_properties_destroy */
  1087. EXPORT obs_properties_t *obs_get_service_properties(const char *id);
  1088. /**
  1089. * Returns the property list of an existing service context, if any. Free with
  1090. * obs_properties_destroy
  1091. */
  1092. EXPORT obs_properties_t *obs_service_properties(const obs_service_t *service);
  1093. /** Gets the service type */
  1094. EXPORT const char *obs_service_get_type(const obs_service_t *service);
  1095. /** Updates the settings of the service context */
  1096. EXPORT void obs_service_update(obs_service_t *service, obs_data_t *settings);
  1097. /** Returns the current settings for this service */
  1098. EXPORT obs_data_t *obs_service_get_settings(const obs_service_t *service);
  1099. /** Returns the URL for this service context */
  1100. EXPORT const char *obs_service_get_url(const obs_service_t *service);
  1101. /** Returns the stream key (if any) for this service context */
  1102. EXPORT const char *obs_service_get_key(const obs_service_t *service);
  1103. /** Returns the username (if any) for this service context */
  1104. EXPORT const char *obs_service_get_username(const obs_service_t *service);
  1105. /** Returns the password (if any) for this service context */
  1106. EXPORT const char *obs_service_get_password(const obs_service_t *service);
  1107. /**
  1108. * Applies service-specific video encoder settings.
  1109. *
  1110. * @param video_encoder_settings Video encoder settings. Optional.
  1111. * @param audio_encoder_settings Audio encoder settings. Optional.
  1112. */
  1113. EXPORT void obs_service_apply_encoder_settings(obs_service_t *service,
  1114. obs_data_t *video_encoder_settings,
  1115. obs_data_t *audio_encoder_settings);
  1116. /* ------------------------------------------------------------------------- */
  1117. /* Source frame allocation functions */
  1118. EXPORT void obs_source_frame_init(struct obs_source_frame *frame,
  1119. enum video_format format, uint32_t width, uint32_t height);
  1120. static inline void obs_source_frame_free(struct obs_source_frame *frame)
  1121. {
  1122. if (frame) {
  1123. bfree(frame->data[0]);
  1124. memset(frame, 0, sizeof(*frame));
  1125. }
  1126. }
  1127. static inline struct obs_source_frame *obs_source_frame_create(
  1128. enum video_format format, uint32_t width, uint32_t height)
  1129. {
  1130. struct obs_source_frame *frame;
  1131. frame = (struct obs_source_frame*)bzalloc(sizeof(*frame));
  1132. obs_source_frame_init(frame, format, width, height);
  1133. return frame;
  1134. }
  1135. static inline void obs_source_frame_destroy(struct obs_source_frame *frame)
  1136. {
  1137. if (frame) {
  1138. bfree(frame->data[0]);
  1139. bfree(frame);
  1140. }
  1141. }
  1142. #ifdef __cplusplus
  1143. }
  1144. #endif