obs.h 50.1 KB
Newer Older
J
jp9000 已提交
1
/******************************************************************************
2
    Copyright (C) 2013-2014 by Hugh Bailey <obs.jim@gmail.com>
J
jp9000 已提交
3 4 5

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
6
    the Free Software Foundation, either version 2 of the License, or
J
jp9000 已提交
7 8 9 10 11 12 13 14 15 16 17
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/

18
#pragma once
J
jp9000 已提交
19 20

#include "util/c99defs.h"
21
#include "util/bmem.h"
22
#include "util/text-lookup.h"
J
jp9000 已提交
23 24
#include "graphics/graphics.h"
#include "graphics/vec2.h"
25
#include "graphics/vec3.h"
J
jp9000 已提交
26 27
#include "media-io/audio-io.h"
#include "media-io/video-io.h"
28 29
#include "callback/signal.h"
#include "callback/proc.h"
J
jp9000 已提交
30

31
#include "obs-config.h"
32 33 34 35
#include "obs-defs.h"
#include "obs-data.h"
#include "obs-ui.h"
#include "obs-properties.h"
K
kc5nra 已提交
36
#include "obs-interaction.h"
37

38 39
struct matrix4;

J
jp9000 已提交
40 41
/* opaque types */
struct obs_display;
J
jp9000 已提交
42
struct obs_view;
J
jp9000 已提交
43 44 45 46 47 48
struct obs_source;
struct obs_scene;
struct obs_scene_item;
struct obs_output;
struct obs_encoder;
struct obs_service;
J
jp9000 已提交
49
struct obs_module;
F
fryshorts 已提交
50
struct obs_fader;
F
fryshorts 已提交
51
struct obs_volmeter;
J
jp9000 已提交
52

53 54 55 56 57 58 59 60 61
typedef struct obs_display    obs_display_t;
typedef struct obs_view       obs_view_t;
typedef struct obs_source     obs_source_t;
typedef struct obs_scene      obs_scene_t;
typedef struct obs_scene_item obs_sceneitem_t;
typedef struct obs_output     obs_output_t;
typedef struct obs_encoder    obs_encoder_t;
typedef struct obs_service    obs_service_t;
typedef struct obs_module     obs_module_t;
F
fryshorts 已提交
62
typedef struct obs_fader      obs_fader_t;
F
fryshorts 已提交
63
typedef struct obs_volmeter   obs_volmeter_t;
J
jp9000 已提交
64 65 66 67 68

#include "obs-source.h"
#include "obs-encoder.h"
#include "obs-output.h"
#include "obs-service.h"
F
fryshorts 已提交
69
#include "obs-audio-controls.h"
J
jp9000 已提交
70

71
/**
J
jp9000 已提交
72
 * @file
73 74 75 76 77 78 79 80
 * @brief Main libobs header used by applications.
 *
 * @mainpage
 *
 * @section intro_sec Introduction
 *
 * This document describes the api for libobs to be used by applications as well
 * as @ref modules_page implementing some kind of functionality.
J
jp9000 已提交
81
 *
J
jp9000 已提交
82 83 84 85 86 87
 */

#ifdef __cplusplus
extern "C" {
#endif

J
jp9000 已提交
88
/** Used for changing the order of items (for example, filters in a source,
J
jp9000 已提交
89
 * or items in a scene) */
J
jp9000 已提交
90 91 92 93 94
enum obs_order_movement {
	OBS_ORDER_MOVE_UP,
	OBS_ORDER_MOVE_DOWN,
	OBS_ORDER_MOVE_TOP,
	OBS_ORDER_MOVE_BOTTOM
J
jp9000 已提交
95 96
};

J
jp9000 已提交
97 98 99 100 101
/**
 * Used with obs_source_process_filter to specify whether the filter should
 * render the source directly with the specified effect, or whether it should
 * render it to a texture
 */
102 103 104
enum obs_allow_direct_render {
	OBS_NO_DIRECT_RENDERING,
	OBS_ALLOW_DIRECT_RENDERING,
105 106
};

107 108 109 110 111 112
enum obs_scale_type {
	OBS_SCALE_BICUBIC,
	OBS_SCALE_BILINEAR,
	OBS_SCALE_LANCZOS
};

113 114 115 116 117 118 119
/**
 * Used with scene items to indicate the type of bounds to use for scene items.
 * Mostly determines how the image will be scaled within those bounds, or
 * whether to use bounds at all.
 */
enum obs_bounds_type {
	OBS_BOUNDS_NONE,            /**< no bounds */
J
jp9000 已提交
120
	OBS_BOUNDS_STRETCH,         /**< stretch (ignores base scale) */
121 122 123 124
	OBS_BOUNDS_SCALE_INNER,     /**< scales to inner rectangle */
	OBS_BOUNDS_SCALE_OUTER,     /**< scales to outer rectangle */
	OBS_BOUNDS_SCALE_TO_WIDTH,  /**< scales to the width  */
	OBS_BOUNDS_SCALE_TO_HEIGHT, /**< scales to the height */
J
jp9000 已提交
125
	OBS_BOUNDS_MAX_ONLY,        /**< no scaling, maximum size only */
126 127
};

128
struct obs_transform_info {
129 130 131 132 133 134 135 136 137 138
	struct vec2          pos;
	float                rot;
	struct vec2          scale;
	uint32_t             alignment;

	enum obs_bounds_type bounds_type;
	uint32_t             bounds_alignment;
	struct vec2          bounds;
};

J
jp9000 已提交
139 140 141
/**
 * Video initialization structure
 */
142
struct obs_video_info {
J
jp9000 已提交
143
	/**
144
	 * Graphics module to use (usually "libobs-opengl" or "libobs-d3d11")
J
jp9000 已提交
145
	 */
146
	const char          *graphics_module;
147

J
jp9000 已提交
148 149
	uint32_t            fps_num;       /**< Output FPS numerator */
	uint32_t            fps_den;       /**< Output FPS denominator */
150

J
jp9000 已提交
151 152
	uint32_t            window_width;  /**< Window width */
	uint32_t            window_height; /**< Window height */
153

J
jp9000 已提交
154 155
	uint32_t            base_width;    /**< Base compositing width */
	uint32_t            base_height;   /**< Base compositing height */
156

J
jp9000 已提交
157 158 159
	uint32_t            output_width;  /**< Output width */
	uint32_t            output_height; /**< Output height */
	enum video_format   output_format; /**< Output format */
160

J
jp9000 已提交
161
	/** Video adapter index to use (NOTE: avoid for optimus laptops) */
162
	uint32_t            adapter;
163

J
jp9000 已提交
164
	struct gs_window    window;        /**< Window to render to */
J
jp9000 已提交
165 166 167

	/** Use shaders to convert to different color formats */
	bool                gpu_conversion;
168 169 170

	enum video_colorspace colorspace;  /**< YUV type (if YUV) */
	enum video_range_type range;       /**< YUV range (if YUV) */
171 172

	enum obs_scale_type scale_type;    /**< How to scale if scaling */
173 174
};

175 176 177 178 179 180 181 182 183
/**
 * Audio initialization structure
 */
struct obs_audio_info {
	uint32_t            samples_per_sec;
	enum speaker_layout speakers;
	uint64_t            buffer_ms;
};

J
jp9000 已提交
184 185 186 187
/**
 * Sent to source filters via the filter_audio callback to allow filtering of
 * audio data
 */
188
struct obs_audio_data {
J
jp9000 已提交
189
	uint8_t             *data[MAX_AV_PLANES];
190 191 192 193
	uint32_t            frames;
	uint64_t            timestamp;
};

J
jp9000 已提交
194 195 196 197
/**
 * Source audio output structure.  Used with obs_source_output_audio to output
 * source audio.  Audio is automatically resampled and remixed as necessary.
 */
198
struct obs_source_audio {
J
jp9000 已提交
199
	const uint8_t       *data[MAX_AV_PLANES];
J
jp9000 已提交
200
	uint32_t            frames;
201

J
jp9000 已提交
202
	enum speaker_layout speakers;
203
	enum audio_format   format;
J
jp9000 已提交
204
	uint32_t            samples_per_sec;
205

J
jp9000 已提交
206
	uint64_t            timestamp;
207 208
};

J
jp9000 已提交
209 210 211 212 213 214 215 216 217
/**
 * Source asynchronous video output structure.  Used with
 * obs_source_output_video to output asynchronous video.  Video is buffered as
 * necessary to play according to timestamps.  When used with audio output,
 * audio is synced to video as it is played.
 *
 * If a YUV format is specified, it will be automatically upsampled and
 * converted to RGB via shader on the graphics processor.
 */
218
struct obs_source_frame {
J
jp9000 已提交
219 220
	uint8_t             *data[MAX_AV_PLANES];
	uint32_t            linesize[MAX_AV_PLANES];
J
jp9000 已提交
221 222 223 224
	uint32_t            width;
	uint32_t            height;
	uint64_t            timestamp;

225
	enum video_format   format;
226
	float               color_matrix[16];
227 228 229
	bool                full_range;
	float               color_range_min[3];
	float               color_range_max[3];
J
jp9000 已提交
230
	bool                flip;
231 232 233

	/* used internally by libobs */
	volatile long       refs;
234 235
};

J
jp9000 已提交
236 237 238
/* ------------------------------------------------------------------------- */
/* OBS context */

239 240 241 242 243 244
/**
 * Initializes OBS
 *
 * @param  locale  The locale to use for modules
 */
EXPORT bool obs_startup(const char *locale);
J
jp9000 已提交
245 246

/** Releases all data associated with OBS and terminates the OBS context */
247
EXPORT void obs_shutdown(void);
J
jp9000 已提交
248

249 250 251
/** @return true if the main OBS context has been initialized */
EXPORT bool obs_initialized(void);

252 253 254
/** @return The current core version */
EXPORT uint32_t obs_get_version(void);

255 256 257 258 259 260 261 262 263 264 265
/**
 * Sets a new locale to use for modules.  This will call obs_module_set_locale
 * for each module with the new locale.
 *
 * @param  locale  The locale to use for modules
 */
EXPORT void obs_set_locale(const char *locale);

/** @return the current locale */
EXPORT const char *obs_get_locale(void);

J
jp9000 已提交
266
/**
267
 * Sets base video ouput base resolution/fps/format.
J
jp9000 已提交
268
 *
269 270 271 272 273 274 275 276 277 278 279 280
 * @note This data cannot be changed if an output is corrently active.
 * @note The graphics module cannot be changed without fully destroying the
 *       OBS context.
 *
 * @param   ovi  Pointer to an obs_video_info structure containing the
 *               specification of the graphics subsystem,
 * @return       OBS_VIDEO_SUCCESS if sucessful
 *               OBS_VIDEO_NOT_SUPPORTED if the adapter lacks capabilities
 *               OBS_VIDEO_INVALID_PARAM if a parameter is invalid
 *               OBS_VIDEO_CURRENTLY_ACTIVE if video is currently active
 *               OBS_VIDEO_MODULE_NOT_FOUND if the graphics module is not found
 *               OBS_VIDEO_FAIL for generic failure
J
jp9000 已提交
281
 */
282
EXPORT int obs_reset_video(struct obs_video_info *ovi);
283

J
jp9000 已提交
284 285 286
/**
 * Sets base audio output format/channels/samples/etc
 *
J
jp9000 已提交
287
 * @note Cannot reset base audio if an output is currently active.
J
jp9000 已提交
288
 */
289
EXPORT bool obs_reset_audio(const struct obs_audio_info *oai);
J
jp9000 已提交
290

J
jp9000 已提交
291
/** Gets the current video settings, returns false if no video */
292 293
EXPORT bool obs_get_video_info(struct obs_video_info *ovi);

J
jp9000 已提交
294
/** Gets the current audio settings, returns false if no audio */
295
EXPORT bool obs_get_audio_info(struct obs_audio_info *oai);
296

J
jp9000 已提交
297
/**
J
jp9000 已提交
298
 * Opens a plugin module directly from a specific path.
J
jp9000 已提交
299
 *
J
jp9000 已提交
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
 * If the module already exists then the function will return successful, and
 * the module parameter will be given the pointer to the existing module.
 *
 * This does not initialize the module, it only loads the module image.  To
 * initialize the module, call obs_init_module.
 *
 * @param  module     The pointer to the created module.
 * @param  path       Specifies the path to the module library file.  If the
 *                    extension is not specified, it will use the extension
 *                    appropriate to the operating system.
 * @param  data_path  Specifies the path to the directory where the module's
 *                    data files are stored.
 * @returns           MODULE_SUCCESS if successful
 *                    MODULE_ERROR if a generic error occurred
 *                    MODULE_FILE_NOT_FOUND if the module was not found
 *                    MODULE_MISSING_EXPORTS if required exports are missing
 *                    MODULE_INCOMPATIBLE_VER if incompatible version
J
jp9000 已提交
317
 */
318
EXPORT int obs_open_module(obs_module_t **module, const char *path,
J
jp9000 已提交
319 320 321 322 323 324 325
		const char *data_path);

/**
 * Initializes the module, which calls its obs_module_load export.  If the
 * module is alrady loaded, then this function does nothing and returns
 * successful.
 */
326
EXPORT bool obs_init_module(obs_module_t *module);
J
jp9000 已提交
327

328
/** Returns the module file name */
329
EXPORT const char *obs_get_module_file_name(obs_module_t *module);
330 331

/** Returns the module full name */
332
EXPORT const char *obs_get_module_name(obs_module_t *module);
333 334

/** Returns the module author(s) */
335
EXPORT const char *obs_get_module_author(obs_module_t *module);
336 337

/** Returns the module description */
338
EXPORT const char *obs_get_module_description(obs_module_t *module);
339

340
/** Returns the module binary path */
341
EXPORT const char *obs_get_module_binary_path(obs_module_t *module);
342 343

/** Returns the module data path */
344
EXPORT const char *obs_get_module_data_path(obs_module_t *module);
345

J
jp9000 已提交
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
/**
 * Adds a module search path to be used with obs_find_modules.  If the search
 * path strings contain %module%, that text will be replaced with the module
 * name when used.
 *
 * @param  bin   Specifies the module's binary directory search path.
 * @param  data  Specifies the module's data directory search path.
 */
EXPORT void obs_add_module_path(const char *bin, const char *data);

/** Automatically loads all modules from module paths (convenience function) */
EXPORT void obs_load_all_modules(void);

struct obs_module_info {
	const char *bin_path;
	const char *data_path;
};

typedef void (*obs_find_module_callback_t)(void *param,
		const struct obs_module_info *info);

/** Finds all modules within the search paths added by obs_add_module_path. */
EXPORT void obs_find_modules(obs_find_module_callback_t callback, void *param);

370
typedef void (*obs_enum_module_callback_t)(void *param, obs_module_t *module);
J
jp9000 已提交
371 372 373

/** Enumerates all loaded modules */
EXPORT void obs_enum_modules(obs_enum_module_callback_t callback, void *param);
J
jp9000 已提交
374

375
/** Helper function for using default module locale */
376
EXPORT lookup_t *obs_module_load_locale(obs_module_t *module,
377 378
		const char *default_locale, const char *locale);

J
jp9000 已提交
379 380 381 382 383 384 385 386 387 388 389
/**
 * Returns the location of a plugin module data file.
 *
 * @note   Modules should use obs_module_file function defined in obs-module.h
 *         as a more elegant means of getting their files without having to
 *         specify the module parameter.
 *
 * @param  module  The module associated with the file to locate
 * @param  file    The file to locate
 * @return         Path string, or NULL if not found.  Use bfree to free string.
 */
390
EXPORT char *obs_find_module_file(obs_module_t *module, const char *file);
J
jp9000 已提交
391

J
jp9000 已提交
392
/**
393
 * Enumerates all available inputs source types.
J
jp9000 已提交
394 395 396 397
 *
 *   Inputs are general source inputs (such as capture sources, device sources,
 * etc).
 */
398
EXPORT bool obs_enum_input_types(size_t idx, const char **id);
399

J
jp9000 已提交
400
/**
401
 * Enumerates all available filter source types.
J
jp9000 已提交
402 403 404 405
 *
 *   Filters are sources that are used to modify the video/audio output of
 * other sources.
 */
406
EXPORT bool obs_enum_filter_types(size_t idx, const char **id);
407

J
jp9000 已提交
408
/**
409
 * Enumerates all available transition source types.
J
jp9000 已提交
410 411 412 413
 *
 *   Transitions are sources used to transition between two or more other
 * sources.
 */
414
EXPORT bool obs_enum_transition_types(size_t idx, const char **id);
415

416
/** Enumerates all available output types. */
417
EXPORT bool obs_enum_output_types(size_t idx, const char **id);
J
jp9000 已提交
418

419 420 421 422 423 424
/** Enumerates all available encoder types. */
EXPORT bool obs_enum_encoder_types(size_t idx, const char **id);

/** Enumerates all available service types. */
EXPORT bool obs_enum_service_types(size_t idx, const char **id);

J
jp9000 已提交
425 426 427 428 429
/** Helper function for entering the OBS graphics context */
EXPORT void obs_enter_graphics(void);

/** Helper function for leaving the OBS graphics context */
EXPORT void obs_leave_graphics(void);
430

431
/** Gets the main audio output handler for this OBS context */
432
EXPORT audio_t *obs_get_audio(void);
433 434

/** Gets the main video output handler for this OBS context */
435
EXPORT video_t *obs_get_video(void);
J
jp9000 已提交
436 437

/**
438 439
 * Adds a source to the user source list and increments the reference counter
 * for that source.
J
jp9000 已提交
440
 *
441 442 443
 *   The user source list is the list of sources that are accessible by a user.
 * Typically when a transition is active, it is not meant to be accessible by
 * users, so there's no reason for a user to see such a source.
J
jp9000 已提交
444
 */
445
EXPORT bool obs_add_source(obs_source_t *source);
446

447
/** Sets the primary output source for a channel. */
448
EXPORT void obs_set_output_source(uint32_t channel, obs_source_t *source);
449 450 451 452 453

/**
 * Gets the primary output source for a channel and increments the reference
 * counter for that source.  Use obs_source_release to release.
 */
454
EXPORT obs_source_t *obs_get_output_source(uint32_t channel);
J
jp9000 已提交
455

456 457 458 459 460 461
/**
 * Enumerates user sources
 *
 *   Callback function returns true to continue enumeration, or false to end
 * enumeration.
 */
462
EXPORT void obs_enum_sources(bool (*enum_proc)(void*, obs_source_t*),
463 464 465
		void *param);

/** Enumerates outputs */
466
EXPORT void obs_enum_outputs(bool (*enum_proc)(void*, obs_output_t*),
467 468 469
		void *param);

/** Enumerates encoders */
470
EXPORT void obs_enum_encoders(bool (*enum_proc)(void*, obs_encoder_t*),
471 472
		void *param);

473
/** Enumerates encoders */
474
EXPORT void obs_enum_services(bool (*enum_proc)(void*, obs_service_t*),
475 476
		void *param);

477 478 479 480 481 482
/**
 * Gets a source by its name.
 *
 *   Increments the source reference counter, use obs_source_release to
 * release it when complete.
 */
483
EXPORT obs_source_t *obs_get_source_by_name(const char *name);
484

485
/** Gets an output by its name. */
486
EXPORT obs_output_t *obs_get_output_by_name(const char *name);
487 488

/** Gets an encoder by its name. */
489
EXPORT obs_encoder_t *obs_get_encoder_by_name(const char *name);
490 491

/** Gets an service by its name. */
492
EXPORT obs_service_t *obs_get_service_by_name(const char *name);
493

494
/** Returns the default effect for generic RGB/YUV drawing */
495
EXPORT gs_effect_t *obs_get_default_effect(void);
496

P
Palana 已提交
497 498 499
/** Returns the default effect for generic RGB/YUV drawing using texture_rect */
EXPORT gs_effect_t *obs_get_default_rect_effect(void);

500 501 502
/** Returns the default effect for generic RGB/YUV drawing (alpha set to 1) */
EXPORT gs_effect_t *obs_get_opaque_effect(void);

503
/** Returns the solid effect for drawing solid colors */
504
EXPORT gs_effect_t *obs_get_solid_effect(void);
505

506 507 508 509 510 511
/** Returns the bicubic scaling effect */
EXPORT gs_effect_t *obs_get_bicubic_effect(void);

/** Returns the lanczos scaling effect */
EXPORT gs_effect_t *obs_get_lanczos_effect(void);

512
/** Returns the primary obs signal handler */
513
EXPORT signal_handler_t *obs_get_signal_handler(void);
514 515

/** Returns the primary obs procedure handler */
516
EXPORT proc_handler_t *obs_get_proc_handler(void);
517

518 519 520 521 522 523 524 525 526 527
/** Adds a draw callback to the main render context */
EXPORT void obs_add_draw_callback(
		void (*draw)(void *param, uint32_t cx, uint32_t cy),
		void *param);

/** Removes a draw callback to the main render context */
EXPORT void obs_remove_draw_callback(
		void (*draw)(void *param, uint32_t cx, uint32_t cy),
		void *param);

J
jp9000 已提交
528
/** Changes the size of the main view */
529 530
EXPORT void obs_resize(uint32_t cx, uint32_t cy);

J
jp9000 已提交
531 532
/** Renders the main view */
EXPORT void obs_render_main_view(void);
533

J
jp9000 已提交
534 535 536 537 538 539 540 541 542 543 544
/** Sets the master user volume */
EXPORT void obs_set_master_volume(float volume);

/** Sets the master presentation volume */
EXPORT void obs_set_present_volume(float volume);

/** Gets the master user volume */
EXPORT float obs_get_master_volume(void);

/** Gets the master presentation volume */
EXPORT float obs_get_present_volume(void);
545 546

/** Saves a source to settings data */
547
EXPORT obs_data_t *obs_save_source(obs_source_t *source);
548 549

/** Loads a source from settings data */
550
EXPORT obs_source_t *obs_load_source(obs_data_t *data);
J
jp9000 已提交
551

552
/** Loads sources from a data array */
553
EXPORT void obs_load_sources(obs_data_array_t *array);
554 555

/** Saves sources to a data array */
556
EXPORT obs_data_array_t *obs_save_sources(void);
557

558 559 560
EXPORT void obs_preview_set_enabled(bool enable);
EXPORT bool obs_preview_enabled(void);

561 562

/* ------------------------------------------------------------------------- */
J
jp9000 已提交
563
/* View context */
564 565

/**
J
jp9000 已提交
566
 * Creates a view context.
567
 *
J
jp9000 已提交
568
 *   A view can be used for things like separate previews, or drawing
569 570
 * sources separately.
 */
571
EXPORT obs_view_t *obs_view_create(void);
572

J
jp9000 已提交
573
/** Destroys this view context */
574
EXPORT void obs_view_destroy(obs_view_t *view);
575

J
jp9000 已提交
576
/** Sets the source to be used for this view context. */
577 578
EXPORT void obs_view_set_source(obs_view_t *view, uint32_t channel,
		obs_source_t *source);
579

J
jp9000 已提交
580
/** Gets the source currently in use for this view context */
581
EXPORT obs_source_t *obs_view_get_source(obs_view_t *view,
582 583
		uint32_t channel);

J
jp9000 已提交
584
/** Renders the sources of this view context */
585
EXPORT void obs_view_render(obs_view_t *view);
586

J
jp9000 已提交
587 588 589 590 591

/* ------------------------------------------------------------------------- */
/* Display context */

/**
592 593
 * Adds a new window display linked to the main render pipeline.  This creates
 * a new swap chain which updates every frame.
J
jp9000 已提交
594
 *
595 596
 * @param  graphics_data  The swap chain initialization data.
 * @return                The new display context, or NULL if failed.
J
jp9000 已提交
597
 */
598 599
EXPORT obs_display_t *obs_display_create(
		const struct gs_init_data *graphics_data);
600 601

/** Destroys a display context */
602
EXPORT void obs_display_destroy(obs_display_t *display);
603

604
/** Changes the size of this display */
605 606
EXPORT void obs_display_resize(obs_display_t *display, uint32_t cx,
		uint32_t cy);
607 608 609 610 611 612 613 614 615

/**
 * Adds a draw callback for this display context
 *
 * @param  display  The display context.
 * @param  draw     The draw callback which is called each time a frame
 *                  updates.
 * @param  param    The user data to be associated with this draw callback.
 */
616
EXPORT void obs_display_add_draw_callback(obs_display_t *display,
617 618 619 620
		void (*draw)(void *param, uint32_t cx, uint32_t cy),
		void *param);

/** Removes a draw callback for this display context */
621
EXPORT void obs_display_remove_draw_callback(obs_display_t *display,
622 623
		void (*draw)(void *param, uint32_t cx, uint32_t cy),
		void *param);
J
jp9000 已提交
624

J
jp9000 已提交
625 626 627
EXPORT void obs_display_set_enabled(obs_display_t *display, bool enable);
EXPORT bool obs_display_enabled(obs_display_t *display);

628 629 630
EXPORT void obs_display_set_background_color(obs_display_t *display,
		uint32_t color);

J
jp9000 已提交
631 632 633 634

/* ------------------------------------------------------------------------- */
/* Sources */

J
jp9000 已提交
635
/** Returns the translated display name of a source */
636
EXPORT const char *obs_source_get_display_name(enum obs_source_type type,
637
		const char *id);
638

J
jp9000 已提交
639 640 641 642
/**
 * Creates a source of the specified type with the specified settings.
 *
 *   The "source" context is used for anything related to presenting
643
 * or modifying video/audio.  Use obs_source_release to release it.
J
jp9000 已提交
644
 */
645 646
EXPORT obs_source_t *obs_source_create(enum obs_source_type type,
		const char *id, const char *name, obs_data_t *settings);
647 648 649 650 651

/**
 * Adds/releases a reference to a source.  When the last reference is
 * released, the source is destroyed.
 */
652 653
EXPORT void obs_source_addref(obs_source_t *source);
EXPORT void obs_source_release(obs_source_t *source);
654

P
Palana 已提交
655
/** Notifies all references that the source should be released */
656
EXPORT void obs_source_remove(obs_source_t *source);
657 658

/** Returns true if the source should be released */
659
EXPORT bool obs_source_removed(const obs_source_t *source);
660

J
jp9000 已提交
661
/** Returns capability flags of a source */
662
EXPORT uint32_t obs_source_get_output_flags(const obs_source_t *source);
663

664 665 666 667
/** Returns capability flags of a source type */
EXPORT uint32_t obs_get_source_output_flags(enum obs_source_type type,
		const char *id);

J
jp9000 已提交
668
/** Gets the default settings for a source type */
669
EXPORT obs_data_t *obs_get_source_defaults(enum obs_source_type type,
J
jp9000 已提交
670 671
		const char *id);

J
jp9000 已提交
672
/** Returns the property list, if any.  Free with obs_properties_destroy */
673
EXPORT obs_properties_t *obs_get_source_properties(enum obs_source_type type,
674
		const char *id);
J
jp9000 已提交
675

676 677 678 679
/**
 * Returns the properties list for a specific existing source.  Free with
 * obs_properties_destroy
 */
680
EXPORT obs_properties_t *obs_source_properties(const obs_source_t *source);
681

682
/** Updates settings for this source */
683
EXPORT void obs_source_update(obs_source_t *source, obs_data_t *settings);
684

J
jp9000 已提交
685
/** Renders a video source. */
686
EXPORT void obs_source_video_render(obs_source_t *source);
687

J
jp9000 已提交
688
/** Gets the width of a source (if it has video) */
689
EXPORT uint32_t obs_source_get_width(obs_source_t *source);
690

J
jp9000 已提交
691
/** Gets the height of a source (if it has video) */
692
EXPORT uint32_t obs_source_get_height(obs_source_t *source);
693

J
jp9000 已提交
694 695 696 697 698
/**
 * If the source is a filter, returns the parent source of the filter.  Only
 * guaranteed to be valid inside of the video_render, filter_audio,
 * filter_video, and filter_remove callbacks.
 */
699
EXPORT obs_source_t *obs_filter_get_parent(const obs_source_t *filter);
700

J
jp9000 已提交
701 702 703 704 705
/**
 * If the source is a filter, returns the target source of the filter.  Only
 * guaranteed to be valid inside of the video_render, filter_audio,
 * filter_video, and filter_remove callbacks.
 */
706
EXPORT obs_source_t *obs_filter_get_target(const obs_source_t *filter);
707

J
jp9000 已提交
708
/** Adds a filter to the source (which is used whenever the source is used) */
709
EXPORT void obs_source_filter_add(obs_source_t *source, obs_source_t *filter);
710

J
jp9000 已提交
711
/** Removes a filter from the source */
712 713
EXPORT void obs_source_filter_remove(obs_source_t *source,
		obs_source_t *filter);
714

J
jp9000 已提交
715
/** Modifies the order of a specific filter */
716 717
EXPORT void obs_source_filter_set_order(obs_source_t *source,
		obs_source_t *filter, enum obs_order_movement movement);
J
jp9000 已提交
718 719

/** Gets the settings string for a source */
720
EXPORT obs_data_t *obs_source_get_settings(const obs_source_t *source);
721 722

/** Gets the name of a source */
723
EXPORT const char *obs_source_get_name(const obs_source_t *source);
724 725

/** Sets the name of a source */
726
EXPORT void obs_source_set_name(obs_source_t *source, const char *name);
727

J
jp9000 已提交
728
/** Gets the source type */
729
EXPORT enum obs_source_type obs_source_get_type(const obs_source_t *source);
J
jp9000 已提交
730 731

/** Gets the source identifier */
732
EXPORT const char *obs_source_get_id(const obs_source_t *source);
J
jp9000 已提交
733

734
/** Returns the signal handler for a source */
735 736
EXPORT signal_handler_t *obs_source_get_signal_handler(
		const obs_source_t *source);
737 738

/** Returns the procedure handler for a source */
739
EXPORT proc_handler_t *obs_source_get_proc_handler(const obs_source_t *source);
740

J
jp9000 已提交
741
/** Sets the user volume for a source that has audio output */
742
EXPORT void obs_source_set_volume(obs_source_t *source, float volume);
J
jp9000 已提交
743

J
jp9000 已提交
744
/** Sets the presentation volume for a source */
745
EXPORT void obs_source_set_present_volume(obs_source_t *source, float volume);
J
jp9000 已提交
746 747

/** Gets the user volume for a source that has audio output */
748
EXPORT float obs_source_get_volume(const obs_source_t *source);
J
jp9000 已提交
749

J
jp9000 已提交
750
/** Gets the presentation volume for a source */
751
EXPORT float obs_source_get_present_volume(const obs_source_t *source);
J
jp9000 已提交
752

J
jp9000 已提交
753
/** Sets the audio sync offset (in nanoseconds) for a source */
754
EXPORT void obs_source_set_sync_offset(obs_source_t *source, int64_t offset);
J
jp9000 已提交
755 756

/** Gets the audio sync offset (in nanoseconds) for a source */
757
EXPORT int64_t obs_source_get_sync_offset(const obs_source_t *source);
J
jp9000 已提交
758

759
/** Enumerates child sources used by this source */
760
EXPORT void obs_source_enum_sources(obs_source_t *source,
761 762 763 764
		obs_source_enum_proc_t enum_callback,
		void *param);

/** Enumerates the entire child source tree used by this source */
765
EXPORT void obs_source_enum_tree(obs_source_t *source,
766 767 768
		obs_source_enum_proc_t enum_callback,
		void *param);

769
/** Returns true if active, false if not */
770
EXPORT bool obs_source_active(const obs_source_t *source);
771

J
jp9000 已提交
772 773 774 775 776
/**
 * Returns true if currently displayed somewhere (active or not), false if not
 */
EXPORT bool obs_source_showing(const obs_source_t *source);

777 778 779 780 781 782
/**
 * Sometimes sources need to be told when to save their settings so they
 * don't have to constantly update and keep track of their settings.  This will
 * call the source's 'save' callback if any, which will save its current
 * data to its settings.
 */
783
EXPORT void obs_source_save(obs_source_t *source);
784 785 786 787 788 789 790

/**
 * Sometimes sources need to be told when they are loading their settings
 * from prior saved data.  This is different from a source 'update' in that
 * it's meant to be used after the source has been created and loaded from
 * somewhere (such as a saved file).
 */
791
EXPORT void obs_source_load(obs_source_t *source);
792

J
jp9000 已提交
793
/** Specifies that async video frames should be played as soon as possible */
794
#define OBS_SOURCE_FLAG_UNBUFFERED             (1<<0)
795 796
/** Specifies to force audio to mono */
#define OBS_SOURCE_FLAG_FORCE_MONO             (1<<1)
J
jp9000 已提交
797

798 799 800 801 802
/**
 * Sets source flags.  Note that these are different from the main output
 * flags.  These are generally things that can be set by the source or user,
 * while the output flags are more used to determine capabilities of a source.
 */
J
jp9000 已提交
803 804 805 806 807
EXPORT void obs_source_set_flags(obs_source_t *source, uint32_t flags);

/** Gets source flags. */
EXPORT uint32_t obs_source_get_flags(const obs_source_t *source);

808 809 810 811 812 813 814 815 816
/**
 * Sets audio mixer flags.  These flags are used to specify which mixers
 * the source's audio should be applied to.
 */
EXPORT void obs_source_set_audio_mixers(obs_source_t *source, uint32_t mixers);

/** Gets audio mixer flags */
EXPORT uint32_t obs_source_get_audio_mixers(const obs_source_t *source);

817 818 819 820 821 822 823 824 825 826 827 828 829 830
/**
 * Increments the 'showing' reference counter to indicate that the source is
 * being shown somewhere.  If the reference counter was 0, will call the 'show'
 * callback.
 */
EXPORT void obs_source_inc_showing(obs_source_t *source);

/**
 * Decrements the 'showing' reference counter to indicate that the source is
 * no longer being shown somewhere.  If the reference counter is set to 0,
 * will call the 'hide' callback
 */
EXPORT void obs_source_dec_showing(obs_source_t *source);

831 832 833 834
/** Enumerates filters assigned to the source */
EXPORT void obs_source_enum_filters(obs_source_t *source,
		obs_source_enum_proc_t callback, void *param);

835 836 837 838
/** Gets a filter of a source by its display name. */
EXPORT obs_source_t *obs_source_get_filter_by_name(obs_source_t *source,
		const char *name);

839 840 841
EXPORT bool obs_source_enabled(const obs_source_t *source);
EXPORT void obs_source_set_enabled(obs_source_t *source, bool enabled);

J
jp9000 已提交
842 843 844
EXPORT bool obs_source_muted(const obs_source_t *source);
EXPORT void obs_source_set_muted(obs_source_t *source, bool muted);

J
jp9000 已提交
845 846 847
/* ------------------------------------------------------------------------- */
/* Functions used by sources */

J
jp9000 已提交
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
/**
 * Helper function to set the color matrix information when drawing the source.
 *
 * @param  color_matrix     The color matrix.  Assigns to the 'color_matrix'
 *                          effect variable.
 * @param  color_range_min  The minimum color range.  Assigns to the
 *                          'color_range_min' effect variable.  If NULL,
 *                          {0.0f, 0.0f, 0.0f} is used.
 * @param  color_range_max  The maximum color range.  Assigns to the
 *                          'color_range_max' effect variable.  If NULL,
 *                          {1.0f, 1.0f, 1.0f} is used.
 */
EXPORT void obs_source_draw_set_color_matrix(
		const struct matrix4 *color_matrix,
		const struct vec3 *color_range_min,
		const struct vec3 *color_range_max);

/**
 * Helper function to draw sprites for a source (synchronous video).
 *
 * @param  image   The sprite texture to draw.  Assigns to the 'image' variable
 *                 of the current effect.
 * @param  x       X position of the sprite.
 * @param  y       Y position of the sprite.
 * @param  cx      Width of the sprite.  If 0, uses the texture width.
 * @param  cy      Height of the sprite.  If 0, uses the texture height.
 * @param  flip    Specifies whether to flip the image vertically.
 */
EXPORT void obs_source_draw(gs_texture_t *image, int x, int y,
		uint32_t cx, uint32_t cy, bool flip);

879
/** Outputs asynchronous video data.  Set to NULL to deactivate the texture */
880
EXPORT void obs_source_output_video(obs_source_t *source,
881
		const struct obs_source_frame *frame);
882

J
jp9000 已提交
883
/** Outputs audio data (always asynchronous) */
884
EXPORT void obs_source_output_audio(obs_source_t *source,
885
		const struct obs_source_audio *audio);
886

887 888 889
/** Signal an update to any currently used properties via 'update_properties' */
EXPORT void obs_source_update_properties(obs_source_t *source);

890
/** Gets the current async video frame */
891
EXPORT struct obs_source_frame *obs_source_get_frame(obs_source_t *source);
892

J
jp9000 已提交
893
/** Releases the current async video frame */
894
EXPORT void obs_source_release_frame(obs_source_t *source,
895
		struct obs_source_frame *frame);
J
jp9000 已提交
896

897 898 899 900 901 902 903 904 905 906
/**
 * Default RGB filter handler for generic effect filters.  Processes the
 * filter chain and renders them to texture if needed, then the filter is
 * drawn with
 *
 * After calling this, set your parameters for the effect, then call
 * obs_source_process_filter_end to draw the filter.
 */
EXPORT void obs_source_process_filter_begin(obs_source_t *filter,
		enum gs_color_format format,
907
		enum obs_allow_direct_render allow_direct);
908

909 910 911 912 913 914 915 916 917 918
/**
 * Draws the filter.
 *
 * Before calling this function, first call obs_source_process_filter_begin and
 * then set the effect parameters, and then call this function to finalize the
 * filter.
 */
EXPORT void obs_source_process_filter_end(obs_source_t *filter,
		gs_effect_t *effect, uint32_t width, uint32_t height);

919 920 921
/** Skips the filter if the filter is invalid and cannot be rendered */
EXPORT void obs_source_skip_video_filter(obs_source_t *filter);

922 923 924 925
/**
 * Adds a child source.  Must be called by parent sources on child sources
 * when the child is added.  This ensures that the source is properly activated
 * if the parent is active.
J
jp9000 已提交
926 927
 *
 * @returns true if source can be added, false if it causes recursion
928
 */
J
jp9000 已提交
929
EXPORT bool obs_source_add_child(obs_source_t *parent, obs_source_t *child);
930 931 932 933 934 935

/**
 * Removes a child source.  Must be called by parent sources on child sources
 * when the child is removed.  This ensures that the source is properly
 * deactivated if the parent is active.
 */
936
EXPORT void obs_source_remove_child(obs_source_t *parent, obs_source_t *child);
937

K
kc5nra 已提交
938
/** Sends a mouse down/up event to a source */
939
EXPORT void obs_source_send_mouse_click(obs_source_t *source,
K
kc5nra 已提交
940 941 942 943 944
		const struct obs_mouse_event *event,
		int32_t type, bool mouse_up,
		uint32_t click_count);

/** Sends a mouse move event to a source. */
945
EXPORT void obs_source_send_mouse_move(obs_source_t *source,
K
kc5nra 已提交
946 947 948
		const struct obs_mouse_event *event, bool mouse_leave);

/** Sends a mouse wheel event to a source */
949
EXPORT void obs_source_send_mouse_wheel(obs_source_t *source,
K
kc5nra 已提交
950 951 952
		const struct obs_mouse_event *event, int x_delta, int y_delta);

/** Sends a got-focus or lost-focus event to a source */
953
EXPORT void obs_source_send_focus(obs_source_t *source, bool focus);
K
kc5nra 已提交
954 955

/** Sends a key up/down event to a source */
956
EXPORT void obs_source_send_key_click(obs_source_t *source,
K
kc5nra 已提交
957 958
		const struct obs_key_event *event, bool key_up);

959 960 961
/** Sets the default source flags. */
EXPORT void obs_source_set_default_flags(obs_source_t *source, uint32_t flags);

962 963 964 965 966 967
/** Gets the base width for a source (not taking in to account filtering) */
EXPORT uint32_t obs_source_get_base_width(obs_source_t *source);

/** Gets the base height for a source (not taking in to account filtering) */
EXPORT uint32_t obs_source_get_base_height(obs_source_t *source);

J
jp9000 已提交
968 969 970 971 972 973 974 975 976 977

/* ------------------------------------------------------------------------- */
/* Scenes */

/**
 * Creates a scene.
 *
 *   A scene is a source which is a container of other sources with specific
 * display oriantations.  Scenes can also be used like any other source.
 */
978
EXPORT obs_scene_t *obs_scene_create(const char *name);
979

980 981
EXPORT void        obs_scene_addref(obs_scene_t *scene);
EXPORT void        obs_scene_release(obs_scene_t *scene);
982

J
jp9000 已提交
983
/** Gets the scene's source context */
984
EXPORT obs_source_t *obs_scene_get_source(const obs_scene_t *scene);
J
jp9000 已提交
985

986
/** Gets the scene from its source, or NULL if not a scene */
987
EXPORT obs_scene_t *obs_scene_from_source(const obs_source_t *source);
988

989
/** Determines whether a source is within a scene */
990
EXPORT obs_sceneitem_t *obs_scene_find_source(obs_scene_t *scene,
991 992 993
		const char *name);

/** Enumerates sources within a scene */
994 995
EXPORT void obs_scene_enum_items(obs_scene_t *scene,
		bool (*callback)(obs_scene_t*, obs_sceneitem_t*, void*),
996 997
		void *param);

J
jp9000 已提交
998
/** Adds/creates a new scene item for a source */
999
EXPORT obs_sceneitem_t *obs_scene_add(obs_scene_t *scene, obs_source_t *source);
J
jp9000 已提交
1000

1001 1002
EXPORT void obs_sceneitem_addref(obs_sceneitem_t *item);
EXPORT void obs_sceneitem_release(obs_sceneitem_t *item);
1003

J
jp9000 已提交
1004
/** Removes a scene item. */
1005
EXPORT void obs_sceneitem_remove(obs_sceneitem_t *item);
J
jp9000 已提交
1006 1007

/** Gets the scene parent associated with the scene item. */
1008
EXPORT obs_scene_t *obs_sceneitem_get_scene(const obs_sceneitem_t *item);
J
jp9000 已提交
1009

J
jp9000 已提交
1010
/** Gets the source of a scene item. */
1011
EXPORT obs_source_t *obs_sceneitem_get_source(const obs_sceneitem_t *item);
J
jp9000 已提交
1012

1013
EXPORT void obs_sceneitem_select(obs_sceneitem_t *item, bool select);
1014
EXPORT bool obs_sceneitem_selected(const obs_sceneitem_t *item);
1015 1016

/* Functions for gettings/setting specific orientation of a scene item */
1017 1018 1019
EXPORT void obs_sceneitem_set_pos(obs_sceneitem_t *item, const struct vec2 *pos);
EXPORT void obs_sceneitem_set_rot(obs_sceneitem_t *item, float rot_deg);
EXPORT void obs_sceneitem_set_scale(obs_sceneitem_t *item,
1020
		const struct vec2 *scale);
1021
EXPORT void obs_sceneitem_set_alignment(obs_sceneitem_t *item,
1022
		uint32_t alignment);
1023
EXPORT void obs_sceneitem_set_order(obs_sceneitem_t *item,
J
jp9000 已提交
1024
		enum obs_order_movement movement);
1025 1026
EXPORT void obs_sceneitem_set_order_position(obs_sceneitem_t *item,
		int position);
1027
EXPORT void obs_sceneitem_set_bounds_type(obs_sceneitem_t *item,
1028
		enum obs_bounds_type type);
1029
EXPORT void obs_sceneitem_set_bounds_alignment(obs_sceneitem_t *item,
1030
		uint32_t alignment);
1031
EXPORT void obs_sceneitem_set_bounds(obs_sceneitem_t *item,
1032 1033
		const struct vec2 *bounds);

1034 1035 1036 1037 1038 1039
EXPORT void  obs_sceneitem_get_pos(const obs_sceneitem_t *item,
		struct vec2 *pos);
EXPORT float obs_sceneitem_get_rot(const obs_sceneitem_t *item);
EXPORT void  obs_sceneitem_get_scale(const obs_sceneitem_t *item,
		struct vec2 *scale);
EXPORT uint32_t obs_sceneitem_get_alignment(const obs_sceneitem_t *item);
1040

1041
EXPORT enum obs_bounds_type obs_sceneitem_get_bounds_type(
1042 1043 1044
		const obs_sceneitem_t *item);
EXPORT uint32_t obs_sceneitem_get_bounds_alignment(const obs_sceneitem_t *item);
EXPORT void obs_sceneitem_get_bounds(const obs_sceneitem_t *item,
1045
		struct vec2 *bounds);
1046

1047
EXPORT void obs_sceneitem_get_info(const obs_sceneitem_t *item,
1048
		struct obs_transform_info *info);
1049
EXPORT void obs_sceneitem_set_info(obs_sceneitem_t *item,
1050
		const struct obs_transform_info *info);
1051

1052
EXPORT void obs_sceneitem_get_draw_transform(const obs_sceneitem_t *item,
1053
		struct matrix4 *transform);
1054
EXPORT void obs_sceneitem_get_box_transform(const obs_sceneitem_t *item,
1055
		struct matrix4 *transform);
J
jp9000 已提交
1056

1057 1058 1059
EXPORT bool obs_sceneitem_visible(const obs_sceneitem_t *item);
EXPORT void obs_sceneitem_set_visible(obs_sceneitem_t *item, bool visible);

J
jp9000 已提交
1060 1061 1062 1063

/* ------------------------------------------------------------------------- */
/* Outputs */

1064
EXPORT const char *obs_output_get_display_name(const char *id);
1065

J
jp9000 已提交
1066 1067 1068 1069 1070 1071
/**
 * Creates an output.
 *
 *   Outputs allow outputting to file, outputting to network, outputting to
 * directshow, or other custom outputs.
 */
1072 1073 1074
EXPORT obs_output_t *obs_output_create(const char *id, const char *name,
		obs_data_t *settings);
EXPORT void obs_output_destroy(obs_output_t *output);
1075

1076
EXPORT const char *obs_output_get_name(const obs_output_t *output);
J
jp9000 已提交
1077

J
jp9000 已提交
1078
/** Starts the output. */
1079
EXPORT bool obs_output_start(obs_output_t *output);
1080

J
jp9000 已提交
1081
/** Stops the output. */
1082
EXPORT void obs_output_stop(obs_output_t *output);
1083

1084
/** Returns whether the output is active */
1085
EXPORT bool obs_output_active(const obs_output_t *output);
1086

J
jp9000 已提交
1087
/** Gets the default settings for an output type */
1088
EXPORT obs_data_t *obs_output_defaults(const char *id);
J
jp9000 已提交
1089

J
jp9000 已提交
1090
/** Returns the property list, if any.  Free with obs_properties_destroy */
1091
EXPORT obs_properties_t *obs_get_output_properties(const char *id);
1092 1093 1094 1095 1096

/**
 * Returns the property list of an existing output, if any.  Free with
 * obs_properties_destroy
 */
1097
EXPORT obs_properties_t *obs_output_properties(const obs_output_t *output);
J
jp9000 已提交
1098

1099
/** Updates the settings for this output context */
1100
EXPORT void obs_output_update(obs_output_t *output, obs_data_t *settings);
1101

J
jp9000 已提交
1102
/** Specifies whether the output can be paused */
1103
EXPORT bool obs_output_canpause(const obs_output_t *output);
1104

J
jp9000 已提交
1105
/** Pauses the output (if the functionality is allowed by the output */
1106
EXPORT void obs_output_pause(obs_output_t *output);
J
jp9000 已提交
1107 1108

/* Gets the current output settings string */
1109
EXPORT obs_data_t *obs_output_get_settings(const obs_output_t *output);
J
jp9000 已提交
1110

1111
/** Returns the signal handler for an output  */
1112 1113
EXPORT signal_handler_t *obs_output_get_signal_handler(
		const obs_output_t *output);
1114 1115

/** Returns the procedure handler for an output */
1116
EXPORT proc_handler_t *obs_output_get_proc_handler(const obs_output_t *output);
1117

J
jp9000 已提交
1118 1119 1120 1121
/**
 * Sets the current video media context associated with this output,
 * required for non-encoded outputs
 */
1122
EXPORT void obs_output_set_video(obs_output_t *output, video_t *video);
J
jp9000 已提交
1123 1124 1125 1126 1127

/**
 * Sets the current audio/video media contexts associated with this output,
 * required for non-encoded outputs.  Can be null.
 */
1128 1129
EXPORT void obs_output_set_media(obs_output_t *output,
		video_t *video, audio_t *audio);
J
jp9000 已提交
1130 1131

/** Returns the video media context associated with this output */
1132
EXPORT video_t *obs_output_video(const obs_output_t *output);
J
jp9000 已提交
1133 1134

/** Returns the audio media context associated with this output */
1135
EXPORT audio_t *obs_output_audio(const obs_output_t *output);
J
jp9000 已提交
1136

1137 1138 1139 1140 1141 1142
/** Sets the current audio mixer for non-encoded outputs */
EXPORT void obs_output_set_mixer(obs_output_t *output, size_t mixer_idx);

/** Gets the current audio mixer for non-encoded outputs */
EXPORT size_t obs_output_get_mixer(const obs_output_t *output);

J
jp9000 已提交
1143 1144 1145 1146
/**
 * Sets the current video encoder associated with this output,
 * required for encoded outputs
 */
1147 1148
EXPORT void obs_output_set_video_encoder(obs_output_t *output,
		obs_encoder_t *encoder);
J
jp9000 已提交
1149 1150 1151

/**
 * Sets the current audio encoder associated with this output,
1152 1153 1154 1155 1156
 * required for encoded outputs.
 *
 * The idx parameter specifies the audio encoder index to set the encoder to.
 * Only used with outputs that have multiple audio outputs (RTMP typically),
 * otherwise the parameter is ignored.
J
jp9000 已提交
1157
 */
1158
EXPORT void obs_output_set_audio_encoder(obs_output_t *output,
1159
		obs_encoder_t *encoder, size_t idx);
J
jp9000 已提交
1160 1161

/** Returns the current video encoder associated with this output */
1162
EXPORT obs_encoder_t *obs_output_get_video_encoder(const obs_output_t *output);
J
jp9000 已提交
1163

1164 1165 1166 1167 1168 1169 1170 1171 1172
/**
 * Returns the current audio encoder associated with this output
 *
 * The idx parameter specifies the audio encoder index.  Only used with
 * outputs that have multiple audio outputs, otherwise the parameter is
 * ignored.
 */
EXPORT obs_encoder_t *obs_output_get_audio_encoder(const obs_output_t *output,
		size_t idx);
J
jp9000 已提交
1173

1174
/** Sets the current service associated with this output. */
1175 1176
EXPORT void obs_output_set_service(obs_output_t *output,
		obs_service_t *service);
1177 1178

/** Gets the current service associated with this output. */
1179
EXPORT obs_service_t *obs_output_get_service(const obs_output_t *output);
1180

J
jp9000 已提交
1181 1182 1183
/**
 * Sets the reconnect settings.  Set retry_count to 0 to disable reconnecting.
 */
1184
EXPORT void obs_output_set_reconnect_settings(obs_output_t *output,
J
jp9000 已提交
1185 1186
		int retry_count, int retry_sec);

1187 1188 1189
EXPORT uint64_t obs_output_get_total_bytes(const obs_output_t *output);
EXPORT int obs_output_get_frames_dropped(const obs_output_t *output);
EXPORT int obs_output_get_total_frames(const obs_output_t *output);
J
jp9000 已提交
1190

1191 1192 1193 1194 1195 1196 1197 1198
/**
 * Sets the preferred scaled resolution for this output.  Set width and height
 * to 0 to disable scaling.
 *
 * If this output uses an encoder, it will call obs_encoder_set_scaled_size on
 * the encoder before the stream is started.  If the encoder is already active,
 * then this function will trigger a warning and do nothing.
 */
1199
EXPORT void obs_output_set_preferred_size(obs_output_t *output, uint32_t width,
1200 1201 1202
		uint32_t height);

/** For video outputs, returns the width of the encoded image */
1203
EXPORT uint32_t obs_output_get_width(const obs_output_t *output);
1204 1205

/** For video outputs, returns the height of the encoded image */
1206
EXPORT uint32_t obs_output_get_height(const obs_output_t *output);
1207

J
jp9000 已提交
1208 1209 1210 1211
/* ------------------------------------------------------------------------- */
/* Functions used by outputs */

/** Optionally sets the video conversion info.  Used only for raw output */
1212
EXPORT void obs_output_set_video_conversion(obs_output_t *output,
J
jp9000 已提交
1213 1214 1215
		const struct video_scale_info *conversion);

/** Optionally sets the audio conversion info.  Used only for raw output */
1216
EXPORT void obs_output_set_audio_conversion(obs_output_t *output,
J
jp9000 已提交
1217 1218
		const struct audio_convert_info *conversion);

1219
/** Returns whether data capture can begin with the specified flags */
1220
EXPORT bool obs_output_can_begin_data_capture(const obs_output_t *output,
1221 1222
		uint32_t flags);

1223
/** Initializes encoders (if any) */
1224 1225
EXPORT bool obs_output_initialize_encoders(obs_output_t *output,
		uint32_t flags);
1226

J
jp9000 已提交
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
/**
 * Begins data capture from media/encoders.
 *
 * @param  output  Output context
 * @param  flags   Set this to 0 to use default output flags set in the
 *                 obs_output_info structure, otherwise set to a either
 *                 OBS_OUTPUT_VIDEO or OBS_OUTPUT_AUDIO to specify whether to
 *                 connect audio or video.  This is useful for things like
 *                 ffmpeg which may or may not always want to use both audio
 *                 and video.
 * @return         true if successful, false otherwise.
 */
1239
EXPORT bool obs_output_begin_data_capture(obs_output_t *output, uint32_t flags);
J
jp9000 已提交
1240 1241

/** Ends data capture from media/encoders */
1242
EXPORT void obs_output_end_data_capture(obs_output_t *output);
J
jp9000 已提交
1243

1244 1245 1246 1247 1248 1249
/**
 * Signals that the output has stopped itself.
 *
 * @param  output  Output context
 * @param  code    Error code (or OBS_OUTPUT_SUCCESS if not an error)
 */
1250
EXPORT void obs_output_signal_stop(obs_output_t *output, int code);
1251

1252

1253
/* ------------------------------------------------------------------------- */
J
jp9000 已提交
1254
/* Encoders */
1255

J
jp9000 已提交
1256
EXPORT const char *obs_encoder_get_display_name(const char *id);
1257

1258 1259 1260 1261 1262 1263 1264 1265
/**
 * Creates a video encoder context
 *
 * @param  id        Video encoder ID
 * @param  name      Name to assign to this context
 * @param  settings  Settings
 * @return           The video encoder context, or NULL if failed or not found.
 */
1266 1267
EXPORT obs_encoder_t *obs_video_encoder_create(const char *id, const char *name,
		obs_data_t *settings);
1268

1269 1270 1271 1272 1273 1274
/**
 * Creates an audio encoder context
 *
 * @param  id        Audio Encoder ID
 * @param  name      Name to assign to this context
 * @param  settings  Settings
1275
 * @param  mixer_idx Index of the mixer to use for this audio encoder
1276 1277
 * @return           The video encoder context, or NULL if failed or not found.
 */
1278
EXPORT obs_encoder_t *obs_audio_encoder_create(const char *id, const char *name,
1279
		obs_data_t *settings, size_t mixer_idx);
J
jp9000 已提交
1280

1281
/** Destroys an encoder context */
1282
EXPORT void obs_encoder_destroy(obs_encoder_t *encoder);
1283

1284
EXPORT void obs_encoder_set_name(obs_encoder_t *encoder, const char *name);
1285
EXPORT const char *obs_encoder_get_name(const obs_encoder_t *encoder);
J
jp9000 已提交
1286

1287 1288 1289
/** Returns the codec of an encoder by the id */
EXPORT const char *obs_get_encoder_codec(const char *id);

1290 1291 1292
/** Returns the type of an encoder by the id */
EXPORT enum obs_encoder_type obs_get_encoder_type(const char *id);

1293
/** Returns the codec of the encoder */
1294
EXPORT const char *obs_encoder_get_codec(const obs_encoder_t *encoder);
1295

1296 1297 1298
/** Returns the type of an encoder */
EXPORT enum obs_encoder_type obs_encoder_get_type(const obs_encoder_t *encoder);

1299 1300 1301 1302 1303
/**
 * Sets the scaled resolution for a video encoder.  Set width and height to 0
 * to disable scaling.  If the encoder is active, this function will trigger
 * a warning, and do nothing.
 */
1304
EXPORT void obs_encoder_set_scaled_size(obs_encoder_t *encoder, uint32_t width,
1305 1306 1307
		uint32_t height);

/** For video encoders, returns the width of the encoded image */
1308
EXPORT uint32_t obs_encoder_get_width(const obs_encoder_t *encoder);
1309 1310

/** For video encoders, returns the height of the encoded image */
1311
EXPORT uint32_t obs_encoder_get_height(const obs_encoder_t *encoder);
1312

J
jp9000 已提交
1313
/** Gets the default settings for an encoder type */
1314
EXPORT obs_data_t *obs_encoder_defaults(const char *id);
J
jp9000 已提交
1315

J
jp9000 已提交
1316
/** Returns the property list, if any.  Free with obs_properties_destroy */
1317
EXPORT obs_properties_t *obs_get_encoder_properties(const char *id);
1318 1319 1320 1321 1322

/**
 * Returns the property list of an existing encoder, if any.  Free with
 * obs_properties_destroy
 */
1323
EXPORT obs_properties_t *obs_encoder_properties(const obs_encoder_t *encoder);
J
jp9000 已提交
1324

1325 1326 1327 1328
/**
 * Updates the settings of the encoder context.  Usually used for changing
 * bitrate while active
 */
1329
EXPORT void obs_encoder_update(obs_encoder_t *encoder, obs_data_t *settings);
1330

1331
/** Gets extra data (headers) associated with this context */
1332
EXPORT bool obs_encoder_get_extra_data(const obs_encoder_t *encoder,
J
jp9000 已提交
1333
		uint8_t **extra_data, size_t *size);
1334

1335
/** Returns the current settings for this encoder */
1336
EXPORT obs_data_t *obs_encoder_get_settings(const obs_encoder_t *encoder);
1337

1338
/** Sets the video output context to be used with this encoder */
1339
EXPORT void obs_encoder_set_video(obs_encoder_t *encoder, video_t *video);
1340 1341

/** Sets the audio output context to be used with this encoder */
1342
EXPORT void obs_encoder_set_audio(obs_encoder_t *encoder, audio_t *audio);
1343

1344 1345 1346 1347
/**
 * Returns the video output context used with this encoder, or NULL if not
 * a video context
 */
1348
EXPORT video_t *obs_encoder_video(const obs_encoder_t *encoder);
1349 1350 1351 1352 1353

/**
 * Returns the audio output context used with this encoder, or NULL if not
 * a audio context
 */
1354
EXPORT audio_t *obs_encoder_audio(const obs_encoder_t *encoder);
1355

1356
/** Returns true if encoder is active, false otherwise */
1357
EXPORT bool obs_encoder_active(const obs_encoder_t *encoder);
1358

1359 1360 1361 1362 1363 1364
/** Duplicates an encoder packet */
EXPORT void obs_duplicate_encoder_packet(struct encoder_packet *dst,
		const struct encoder_packet *src);

EXPORT void obs_free_encoder_packet(struct encoder_packet *packet);

1365

1366 1367
/* ------------------------------------------------------------------------- */
/* Stream Services */
1368

1369
EXPORT const char *obs_service_get_display_name(const char *id);
1370

1371 1372 1373
EXPORT obs_service_t *obs_service_create(const char *id, const char *name,
		obs_data_t *settings);
EXPORT void obs_service_destroy(obs_service_t *service);
1374

1375
EXPORT const char *obs_service_get_name(const obs_service_t *service);
1376

1377
/** Gets the default settings for a service */
1378
EXPORT obs_data_t *obs_service_defaults(const char *id);
1379 1380

/** Returns the property list, if any.  Free with obs_properties_destroy */
1381
EXPORT obs_properties_t *obs_get_service_properties(const char *id);
1382 1383 1384 1385 1386

/**
 * Returns the property list of an existing service context, if any.  Free with
 * obs_properties_destroy
 */
1387
EXPORT obs_properties_t *obs_service_properties(const obs_service_t *service);
1388

1389
/** Gets the service type */
1390
EXPORT const char *obs_service_get_type(const obs_service_t *service);
1391 1392

/** Updates the settings of the service context */
1393
EXPORT void obs_service_update(obs_service_t *service, obs_data_t *settings);
1394 1395

/** Returns the current settings for this service */
1396
EXPORT obs_data_t *obs_service_get_settings(const obs_service_t *service);
1397

1398
/** Returns the URL for this service context */
1399
EXPORT const char *obs_service_get_url(const obs_service_t *service);
1400 1401

/** Returns the stream key (if any) for this service context */
1402
EXPORT const char *obs_service_get_key(const obs_service_t *service);
1403 1404

/** Returns the username (if any) for this service context */
1405
EXPORT const char *obs_service_get_username(const obs_service_t *service);
1406 1407

/** Returns the password (if any) for this service context */
1408
EXPORT const char *obs_service_get_password(const obs_service_t *service);
1409

1410 1411 1412
/**
 * Applies service-specific video encoder settings.
 *
1413 1414
 * @param  video_encoder_settings  Video encoder settings.  Optional.
 * @param  audio_encoder_settings  Audio encoder settings.  Optional.
1415 1416
 */
EXPORT void obs_service_apply_encoder_settings(obs_service_t *service,
1417 1418
		obs_data_t *video_encoder_settings,
		obs_data_t *audio_encoder_settings);
1419

1420

1421 1422
/* ------------------------------------------------------------------------- */
/* Source frame allocation functions */
1423
EXPORT void obs_source_frame_init(struct obs_source_frame *frame,
1424 1425
		enum video_format format, uint32_t width, uint32_t height);

1426
static inline void obs_source_frame_free(struct obs_source_frame *frame)
1427 1428 1429
{
	if (frame) {
		bfree(frame->data[0]);
1430
		memset(frame, 0, sizeof(*frame));
1431 1432 1433
	}
}

1434
static inline struct obs_source_frame *obs_source_frame_create(
1435 1436
		enum video_format format, uint32_t width, uint32_t height)
{
1437
	struct obs_source_frame *frame;
1438

1439 1440
	frame = (struct obs_source_frame*)bzalloc(sizeof(*frame));
	obs_source_frame_init(frame, format, width, height);
1441 1442 1443
	return frame;
}

1444
static inline void obs_source_frame_destroy(struct obs_source_frame *frame)
1445 1446 1447 1448 1449 1450 1451 1452
{
	if (frame) {
		bfree(frame->data[0]);
		bfree(frame);
	}
}


J
jp9000 已提交
1453 1454 1455
#ifdef __cplusplus
}
#endif