obs.h 71.8 KB
Newer Older
J
jp9000 已提交
1
/******************************************************************************
J
jp9000 已提交
2
    Copyright (C) 2013-2014 by Hugh Bailey <jim@obsproject.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/profiler.h"
23
#include "util/text-lookup.h"
J
jp9000 已提交
24 25
#include "graphics/graphics.h"
#include "graphics/vec2.h"
26
#include "graphics/vec3.h"
J
jp9000 已提交
27 28
#include "media-io/audio-io.h"
#include "media-io/video-io.h"
29 30
#include "callback/signal.h"
#include "callback/proc.h"
J
jp9000 已提交
31

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

39 40
struct matrix4;

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

54 55 56 57 58 59 60 61 62
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 已提交
63
typedef struct obs_fader      obs_fader_t;
F
fryshorts 已提交
64
typedef struct obs_volmeter   obs_volmeter_t;
J
jp9000 已提交
65

66
typedef struct obs_weak_source  obs_weak_source_t;
67
typedef struct obs_weak_output  obs_weak_output_t;
68
typedef struct obs_weak_encoder obs_weak_encoder_t;
69
typedef struct obs_weak_service obs_weak_service_t;
70

J
jp9000 已提交
71 72 73 74
#include "obs-source.h"
#include "obs-encoder.h"
#include "obs-output.h"
#include "obs-service.h"
F
fryshorts 已提交
75
#include "obs-audio-controls.h"
P
Palana 已提交
76
#include "obs-hotkey.h"
J
jp9000 已提交
77

78
/**
J
jp9000 已提交
79
 * @file
80 81 82 83 84 85 86 87
 * @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 已提交
88
 *
J
jp9000 已提交
89 90 91 92 93 94
 */

#ifdef __cplusplus
extern "C" {
#endif

J
jp9000 已提交
95
/** Used for changing the order of items (for example, filters in a source,
J
jp9000 已提交
96
 * or items in a scene) */
J
jp9000 已提交
97 98 99 100 101
enum obs_order_movement {
	OBS_ORDER_MOVE_UP,
	OBS_ORDER_MOVE_DOWN,
	OBS_ORDER_MOVE_TOP,
	OBS_ORDER_MOVE_BOTTOM
J
jp9000 已提交
102 103
};

J
jp9000 已提交
104 105 106 107 108
/**
 * 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
 */
109 110 111
enum obs_allow_direct_render {
	OBS_NO_DIRECT_RENDERING,
	OBS_ALLOW_DIRECT_RENDERING,
112 113
};

114
enum obs_scale_type {
115 116
	OBS_SCALE_DISABLE,
	OBS_SCALE_POINT,
117 118 119 120 121
	OBS_SCALE_BICUBIC,
	OBS_SCALE_BILINEAR,
	OBS_SCALE_LANCZOS
};

122 123 124 125 126 127 128
/**
 * 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 已提交
129
	OBS_BOUNDS_STRETCH,         /**< stretch (ignores base scale) */
130 131 132 133
	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 已提交
134
	OBS_BOUNDS_MAX_ONLY,        /**< no scaling, maximum size only */
135 136
};

137
struct obs_transform_info {
138 139 140 141 142 143 144 145 146 147
	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 已提交
148 149 150
/**
 * Video initialization structure
 */
151
struct obs_video_info {
152
#ifndef SWIG
J
jp9000 已提交
153
	/**
154
	 * Graphics module to use (usually "libobs-opengl" or "libobs-d3d11")
J
jp9000 已提交
155
	 */
156
	const char          *graphics_module;
157
#endif
158

J
jp9000 已提交
159 160
	uint32_t            fps_num;       /**< Output FPS numerator */
	uint32_t            fps_den;       /**< Output FPS denominator */
161

J
jp9000 已提交
162 163
	uint32_t            base_width;    /**< Base compositing width */
	uint32_t            base_height;   /**< Base compositing height */
164

J
jp9000 已提交
165 166 167
	uint32_t            output_width;  /**< Output width */
	uint32_t            output_height; /**< Output height */
	enum video_format   output_format; /**< Output format */
168

J
jp9000 已提交
169
	/** Video adapter index to use (NOTE: avoid for optimus laptops) */
170
	uint32_t            adapter;
171

J
jp9000 已提交
172 173
	/** Use shaders to convert to different color formats */
	bool                gpu_conversion;
174 175 176

	enum video_colorspace colorspace;  /**< YUV type (if YUV) */
	enum video_range_type range;       /**< YUV range (if YUV) */
177 178

	enum obs_scale_type scale_type;    /**< How to scale if scaling */
179 180
};

181 182 183 184 185 186 187 188
/**
 * Audio initialization structure
 */
struct obs_audio_info {
	uint32_t            samples_per_sec;
	enum speaker_layout speakers;
};

J
jp9000 已提交
189 190 191 192
/**
 * Sent to source filters via the filter_audio callback to allow filtering of
 * audio data
 */
193
struct obs_audio_data {
J
jp9000 已提交
194
	uint8_t             *data[MAX_AV_PLANES];
195 196 197 198
	uint32_t            frames;
	uint64_t            timestamp;
};

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

J
jp9000 已提交
207
	enum speaker_layout speakers;
208
	enum audio_format   format;
J
jp9000 已提交
209
	uint32_t            samples_per_sec;
210

J
jp9000 已提交
211
	uint64_t            timestamp;
212 213
};

J
jp9000 已提交
214 215 216 217 218 219 220 221 222
/**
 * 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.
 */
223
struct obs_source_frame {
J
jp9000 已提交
224 225
	uint8_t             *data[MAX_AV_PLANES];
	uint32_t            linesize[MAX_AV_PLANES];
J
jp9000 已提交
226 227 228 229
	uint32_t            width;
	uint32_t            height;
	uint64_t            timestamp;

230
	enum video_format   format;
231
	float               color_matrix[16];
232 233 234
	bool                full_range;
	float               color_range_min[3];
	float               color_range_max[3];
J
jp9000 已提交
235
	bool                flip;
236 237 238

	/* used internally by libobs */
	volatile long       refs;
J
jp9000 已提交
239
	bool                prev_frame;
240 241
};

242 243 244 245 246 247
/** Access to the argc/argv used to start OBS. What you see is what you get. */
struct obs_cmdline_args {
	int argc;
	char **argv;
};

J
jp9000 已提交
248 249 250
/* ------------------------------------------------------------------------- */
/* OBS context */

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
/**
 * Find a core libobs data file
 * @param path name of the base file
 * @return A string containing the full path to the file.
 *          Use bfree after use.
 */
EXPORT char *obs_find_data_file(const char *file);

/**
 * Add a path to search libobs data files in.
 * @param path Full path to directory to look in.
 *             The string is copied.
 */
EXPORT void obs_add_data_path(const char *path);

/**
 * Remove a path from libobs core data paths.
 * @param path The path to compare to currently set paths.
 *             It does not need to be the same pointer, but
 *             the path string must match an entry fully.
 * @return Whether or not the path was successfully removed.
 *         If false, the path could not be found.
 */
EXPORT bool obs_remove_data_path(const char *path);


277 278 279
/**
 * Initializes OBS
 *
280 281 282 283
 * @param  locale              The locale to use for modules
 * @param  module_config_path  Path to module config storage directory
 *                             (or NULL if none)
 * @param  store               The profiler name store for OBS to use or NULL
284
 */
285 286
EXPORT bool obs_startup(const char *locale, const char *module_config_path,
		profiler_name_store_t *store);
J
jp9000 已提交
287 288

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

291 292 293
/** @return true if the main OBS context has been initialized */
EXPORT bool obs_initialized(void);

294 295 296
/** @return The current core version */
EXPORT uint32_t obs_get_version(void);

297 298 299
/** @return The current core version string */
EXPORT const char *obs_get_version_string(void);

300 301 302 303 304 305 306 307
/**
 * Sets things up for calls to obs_get_cmdline_args. Called onl yonce at startup
 * and safely copies argv/argc from main(). Subsequent calls do nothing.
 *
 * @param  argc  The count of command line arguments, from main()
 * @param  argv  An array of command line arguments, copied from main() and ends
 *               with NULL.
 */
308
EXPORT void obs_set_cmdline_args(int argc, const char * const *argv);
309 310 311 312 313 314 315 316 317

/**
 * Get the argc/argv used to start OBS
 *
 * @return  The command line arguments used for main(). Don't modify this or
 *          you'll mess things up for other callers.
 */
EXPORT struct obs_cmdline_args obs_get_cmdline_args(void);

318 319 320 321 322 323 324 325 326 327 328
/**
 * 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);

329 330 331 332 333 334
/** Initialize the Windows-specific crash handler */

#ifdef _WIN32
EXPORT void obs_init_win32_crash_handler(void);
#endif

335 336 337 338 339 340 341
/**
 * Returns the profiler name store (see util/profiler.h) used by OBS, which is
 * either a name store passed to obs_startup, an internal name store, or NULL
 * in case obs_initialized() returns false.
 */
EXPORT profiler_name_store_t *obs_get_profiler_name_store(void);

J
jp9000 已提交
342
/**
343
 * Sets base video output base resolution/fps/format.
J
jp9000 已提交
344
 *
345
 * @note This data cannot be changed if an output is currently active.
346 347 348 349 350
 * @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,
351
 * @return       OBS_VIDEO_SUCCESS if successful
352 353 354 355 356
 *               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 已提交
357
 */
358
EXPORT int obs_reset_video(struct obs_video_info *ovi);
359

J
jp9000 已提交
360 361 362
/**
 * Sets base audio output format/channels/samples/etc
 *
J
jp9000 已提交
363
 * @note Cannot reset base audio if an output is currently active.
J
jp9000 已提交
364
 */
365
EXPORT bool obs_reset_audio(const struct obs_audio_info *oai);
J
jp9000 已提交
366

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

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

J
jp9000 已提交
373
/**
J
jp9000 已提交
374
 * Opens a plugin module directly from a specific path.
J
jp9000 已提交
375
 *
J
jp9000 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
 * 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 已提交
393
 */
394
EXPORT int obs_open_module(obs_module_t **module, const char *path,
J
jp9000 已提交
395 396 397 398
		const char *data_path);

/**
 * Initializes the module, which calls its obs_module_load export.  If the
399
 * module is already loaded, then this function does nothing and returns
J
jp9000 已提交
400 401
 * successful.
 */
402
EXPORT bool obs_init_module(obs_module_t *module);
J
jp9000 已提交
403

404 405 406
/** Logs loaded modules */
EXPORT void obs_log_loaded_modules(void);

407
/** Returns the module file name */
408
EXPORT const char *obs_get_module_file_name(obs_module_t *module);
409 410

/** Returns the module full name */
411
EXPORT const char *obs_get_module_name(obs_module_t *module);
412 413

/** Returns the module author(s) */
414
EXPORT const char *obs_get_module_author(obs_module_t *module);
415 416

/** Returns the module description */
417
EXPORT const char *obs_get_module_description(obs_module_t *module);
418

419
/** Returns the module binary path */
420
EXPORT const char *obs_get_module_binary_path(obs_module_t *module);
421 422

/** Returns the module data path */
423
EXPORT const char *obs_get_module_data_path(obs_module_t *module);
424

J
jp9000 已提交
425 426 427 428 429 430 431 432 433 434 435 436 437
/**
 * 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);

438 439 440 441
/** Notifies modules that all modules have been loaded.  This function should
 * be called after all modules have been loaded. */
EXPORT void obs_post_load_modules(void);

442
#ifndef SWIG
J
jp9000 已提交
443 444 445 446 447 448 449 450 451 452
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);
453
#endif
J
jp9000 已提交
454

455
typedef void (*obs_enum_module_callback_t)(void *param, obs_module_t *module);
J
jp9000 已提交
456 457 458

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

460
/** Helper function for using default module locale */
461
EXPORT lookup_t *obs_module_load_locale(obs_module_t *module,
462 463
		const char *default_locale, const char *locale);

J
jp9000 已提交
464 465 466 467 468 469 470 471 472 473 474
/**
 * 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.
 */
475
EXPORT char *obs_find_module_file(obs_module_t *module, const char *file);
J
jp9000 已提交
476

477 478 479 480 481 482 483 484 485 486 487 488 489
/**
 * Returns the path of a plugin module config file (whether it exists or not)
 *
 * @note   Modules should use obs_module_config_path 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 path
 * @param  file    The file to get a path to
 * @return         Path string, or NULL if not found.  Use bfree to free string.
 */
EXPORT char *obs_module_get_config_path(obs_module_t *module, const char *file);

490 491 492
/** Enumerates all source types (inputs, filters, transitions, etc).  */
EXPORT bool obs_enum_source_types(size_t idx, const char **id);

J
jp9000 已提交
493
/**
494
 * Enumerates all available inputs source types.
J
jp9000 已提交
495 496 497 498
 *
 *   Inputs are general source inputs (such as capture sources, device sources,
 * etc).
 */
499
EXPORT bool obs_enum_input_types(size_t idx, const char **id);
500

J
jp9000 已提交
501
/**
502
 * Enumerates all available filter source types.
J
jp9000 已提交
503 504 505 506
 *
 *   Filters are sources that are used to modify the video/audio output of
 * other sources.
 */
507
EXPORT bool obs_enum_filter_types(size_t idx, const char **id);
508

J
jp9000 已提交
509
/**
510
 * Enumerates all available transition source types.
J
jp9000 已提交
511 512 513 514
 *
 *   Transitions are sources used to transition between two or more other
 * sources.
 */
515
EXPORT bool obs_enum_transition_types(size_t idx, const char **id);
516

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

520 521 522 523 524 525
/** 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 已提交
526 527 528 529 530
/** 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);
531

532
/** Gets the main audio output handler for this OBS context */
533
EXPORT audio_t *obs_get_audio(void);
534 535

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

J
jp9000 已提交
538 539 540
/** Returns true if video is active, false otherwise */
EXPORT bool obs_video_active(void);

541
/** Sets the primary output source for a channel. */
542
EXPORT void obs_set_output_source(uint32_t channel, obs_source_t *source);
543 544 545 546 547

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

550
/**
551
 * Enumerates all input sources
552 553 554
 *
 *   Callback function returns true to continue enumeration, or false to end
 * enumeration.
555 556 557
 *
 *   Use obs_source_get_ref or obs_source_get_weak_source if you want to retain
 * a reference after obs_enum_sources finishes
558
 */
559
EXPORT void obs_enum_sources(bool (*enum_proc)(void*, obs_source_t*),
560 561
		void *param);

562 563 564 565
/** Enumerates scenes */
EXPORT void obs_enum_scenes(bool (*enum_proc)(void*, obs_source_t*),
	void *param);

566
/** Enumerates outputs */
567
EXPORT void obs_enum_outputs(bool (*enum_proc)(void*, obs_output_t*),
568 569 570
		void *param);

/** Enumerates encoders */
571
EXPORT void obs_enum_encoders(bool (*enum_proc)(void*, obs_encoder_t*),
572 573
		void *param);

574
/** Enumerates encoders */
575
EXPORT void obs_enum_services(bool (*enum_proc)(void*, obs_service_t*),
576 577
		void *param);

578 579 580 581 582 583
/**
 * Gets a source by its name.
 *
 *   Increments the source reference counter, use obs_source_release to
 * release it when complete.
 */
584
EXPORT obs_source_t *obs_get_source_by_name(const char *name);
585

586
/** Gets an output by its name. */
587
EXPORT obs_output_t *obs_get_output_by_name(const char *name);
588 589

/** Gets an encoder by its name. */
590
EXPORT obs_encoder_t *obs_get_encoder_by_name(const char *name);
591 592

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

595 596 597 598 599 600 601 602
enum obs_base_effect {
	OBS_EFFECT_DEFAULT,            /**< RGB/YUV */
	OBS_EFFECT_DEFAULT_RECT,       /**< RGB/YUV (using texture_rect) */
	OBS_EFFECT_OPAQUE,             /**< RGB/YUV (alpha set to 1.0) */
	OBS_EFFECT_SOLID,              /**< RGB/YUV (solid color only) */
	OBS_EFFECT_BICUBIC,            /**< Bicubic downscale */
	OBS_EFFECT_LANCZOS,            /**< Lanczos downscale */
	OBS_EFFECT_BILINEAR_LOWRES,    /**< Bilinear low resolution downscale */
603
	OBS_EFFECT_PREMULTIPLIED_ALPHA,/**< Premultiplied alpha */
604
	OBS_EFFECT_REPEAT,             /**< RGB/YUV (repeating) */
605
};
606

607 608
/** Returns a commonly used base effect */
EXPORT gs_effect_t *obs_get_base_effect(enum obs_base_effect effect);
609

610
#ifndef SWIG
611
/* DEPRECATED: gets texture_rect default effect */
J
jp9000 已提交
612 613
DEPRECATED
EXPORT gs_effect_t *obs_get_default_rect_effect(void);
614
#endif
615

616
/** Returns the primary obs signal handler */
617
EXPORT signal_handler_t *obs_get_signal_handler(void);
618 619

/** Returns the primary obs procedure handler */
620
EXPORT proc_handler_t *obs_get_proc_handler(void);
621

622
#ifndef SWIG
J
jp9000 已提交
623
/** Renders the main view */
J
jp9000 已提交
624
DEPRECATED
J
jp9000 已提交
625
EXPORT void obs_render_main_view(void);
626
#endif
627

J
jp9000 已提交
628 629 630
/** Renders the last main output texture */
EXPORT void obs_render_main_texture(void);

631 632 633 634
/** Returns the last main output texture.  This can return NULL if the texture
 * is unavailable. */
EXPORT gs_texture_t *obs_get_main_texture(void);

J
jp9000 已提交
635 636 637 638 639 640
/** Sets the master user volume */
EXPORT void obs_set_master_volume(float volume);

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

641
/** Saves a source to settings data */
642
EXPORT obs_data_t *obs_save_source(obs_source_t *source);
643 644

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

647 648 649 650 651 652
/** Send a save signal to sources */
EXPORT void obs_source_save(obs_source_t *source);

/** Send a load signal to sources */
EXPORT void obs_source_load(obs_source_t *source);

653 654
typedef void (*obs_load_source_cb)(void *private_data, obs_source_t *source);

655
/** Loads sources from a data array */
656 657
EXPORT void obs_load_sources(obs_data_array_t *array, obs_load_source_cb cb,
		void *private_data);
658 659

/** Saves sources to a data array */
660
EXPORT obs_data_array_t *obs_save_sources(void);
661

662 663 664 665
typedef bool (*obs_save_source_filter_cb)(void *data, obs_source_t *source);
EXPORT obs_data_array_t *obs_save_sources_filtered(obs_save_source_filter_cb cb,
		void *data);

666 667 668 669 670 671 672 673 674
enum obs_obj_type {
	OBS_OBJ_TYPE_INVALID,
	OBS_OBJ_TYPE_SOURCE,
	OBS_OBJ_TYPE_OUTPUT,
	OBS_OBJ_TYPE_ENCODER,
	OBS_OBJ_TYPE_SERVICE
};

EXPORT enum obs_obj_type obs_obj_get_type(void *obj);
675
EXPORT const char *obs_obj_get_id(void *obj);
J
jp9000 已提交
676
EXPORT bool obs_obj_invalid(void *obj);
677

J
jp9000 已提交
678 679 680 681 682 683 684 685 686
typedef bool (*obs_enum_audio_device_cb)(void *data, const char *name,
		const char *id);

EXPORT void obs_enum_audio_monitoring_devices(obs_enum_audio_device_cb cb,
		void *data);

EXPORT bool obs_set_audio_monitoring_device(const char *name, const char *id);
EXPORT void obs_get_audio_monitoring_device(const char **name, const char **id);

687 688 689 690 691 692 693
EXPORT void obs_add_tick_callback(
		void (*tick)(void *param, float seconds),
		void *param);
EXPORT void obs_remove_tick_callback(
		void (*tick)(void *param, float seconds),
		void *param);

694 695 696 697 698 699 700
EXPORT void obs_add_main_render_callback(
		void (*draw)(void *param, uint32_t cx, uint32_t cy),
		void *param);
EXPORT void obs_remove_main_render_callback(
		void (*draw)(void *param, uint32_t cx, uint32_t cy),
		void *param);

701 702 703 704 705 706 707 708
EXPORT void obs_add_raw_video_callback(
		const struct video_scale_info *conversion,
		void (*callback)(void *param, struct video_data *frame),
		void *param);
EXPORT void obs_remove_raw_video_callback(
		void (*callback)(void *param, struct video_data *frame),
		void *param);

709 710 711 712 713 714 715 716
EXPORT uint64_t obs_get_video_frame_time(void);

EXPORT double obs_get_active_fps(void);
EXPORT uint64_t obs_get_average_frame_time_ns(void);

EXPORT uint32_t obs_get_total_frames(void);
EXPORT uint32_t obs_get_lagged_frames(void);

717 718
EXPORT bool obs_nv12_tex_active(void);

719 720 721 722
EXPORT void obs_apply_private_data(obs_data_t *settings);
EXPORT void obs_set_private_data(obs_data_t *settings);
EXPORT obs_data_t *obs_get_private_data(void);

723 724

/* ------------------------------------------------------------------------- */
J
jp9000 已提交
725
/* View context */
726 727

/**
J
jp9000 已提交
728
 * Creates a view context.
729
 *
J
jp9000 已提交
730
 *   A view can be used for things like separate previews, or drawing
731 732
 * sources separately.
 */
733
EXPORT obs_view_t *obs_view_create(void);
734

J
jp9000 已提交
735
/** Destroys this view context */
736
EXPORT void obs_view_destroy(obs_view_t *view);
737

J
jp9000 已提交
738
/** Sets the source to be used for this view context. */
739 740
EXPORT void obs_view_set_source(obs_view_t *view, uint32_t channel,
		obs_source_t *source);
741

J
jp9000 已提交
742
/** Gets the source currently in use for this view context */
743
EXPORT obs_source_t *obs_view_get_source(obs_view_t *view,
744 745
		uint32_t channel);

J
jp9000 已提交
746
/** Renders the sources of this view context */
747
EXPORT void obs_view_render(obs_view_t *view);
748

J
jp9000 已提交
749 750 751 752 753

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

/**
754 755
 * Adds a new window display linked to the main render pipeline.  This creates
 * a new swap chain which updates every frame.
J
jp9000 已提交
756
 *
757 758
 * @param  graphics_data  The swap chain initialization data.
 * @return                The new display context, or NULL if failed.
J
jp9000 已提交
759
 */
760
EXPORT obs_display_t *obs_display_create(
761 762
		const struct gs_init_data *graphics_data,
		uint32_t backround_color);
763 764

/** Destroys a display context */
765
EXPORT void obs_display_destroy(obs_display_t *display);
766

767
/** Changes the size of this display */
768 769
EXPORT void obs_display_resize(obs_display_t *display, uint32_t cx,
		uint32_t cy);
770 771 772 773 774 775 776 777 778

/**
 * 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.
 */
779
EXPORT void obs_display_add_draw_callback(obs_display_t *display,
780 781 782 783
		void (*draw)(void *param, uint32_t cx, uint32_t cy),
		void *param);

/** Removes a draw callback for this display context */
784
EXPORT void obs_display_remove_draw_callback(obs_display_t *display,
785 786
		void (*draw)(void *param, uint32_t cx, uint32_t cy),
		void *param);
J
jp9000 已提交
787

J
jp9000 已提交
788 789 790
EXPORT void obs_display_set_enabled(obs_display_t *display, bool enable);
EXPORT bool obs_display_enabled(obs_display_t *display);

791 792 793
EXPORT void obs_display_set_background_color(obs_display_t *display,
		uint32_t color);

J
jp9000 已提交
794 795 796 797

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

J
jp9000 已提交
798
/** Returns the translated display name of a source */
799
EXPORT const char *obs_source_get_display_name(const char *id);
800

J
jp9000 已提交
801 802 803 804
/**
 * Creates a source of the specified type with the specified settings.
 *
 *   The "source" context is used for anything related to presenting
805
 * or modifying video/audio.  Use obs_source_release to release it.
J
jp9000 已提交
806
 */
807 808
EXPORT obs_source_t *obs_source_create(const char *id, const char *name,
		obs_data_t *settings, obs_data_t *hotkey_data);
809

J
jp9000 已提交
810 811
EXPORT obs_source_t *obs_source_create_private(const char *id,
		const char *name, obs_data_t *settings);
812 813 814 815 816

/* if source has OBS_SOURCE_DO_NOT_DUPLICATE output flag set, only returns a
 * reference */
EXPORT obs_source_t *obs_source_duplicate(obs_source_t *source,
		const char *desired_name, bool create_private);
817 818 819 820
/**
 * Adds/releases a reference to a source.  When the last reference is
 * released, the source is destroyed.
 */
821 822
EXPORT void obs_source_addref(obs_source_t *source);
EXPORT void obs_source_release(obs_source_t *source);
823

824 825 826 827 828 829 830 831 832 833
EXPORT void obs_weak_source_addref(obs_weak_source_t *weak);
EXPORT void obs_weak_source_release(obs_weak_source_t *weak);

EXPORT obs_source_t *obs_source_get_ref(obs_source_t *source);
EXPORT obs_weak_source_t *obs_source_get_weak_source(obs_source_t *source);
EXPORT obs_source_t *obs_weak_source_get_source(obs_weak_source_t *weak);

EXPORT bool obs_weak_source_references_source(obs_weak_source_t *weak,
		obs_source_t *source);

P
Palana 已提交
834
/** Notifies all references that the source should be released */
835
EXPORT void obs_source_remove(obs_source_t *source);
836 837

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

J
jp9000 已提交
840
/** Returns capability flags of a source */
841
EXPORT uint32_t obs_source_get_output_flags(const obs_source_t *source);
842

843
/** Returns capability flags of a source type */
844
EXPORT uint32_t obs_get_source_output_flags(const char *id);
845

J
jp9000 已提交
846
/** Gets the default settings for a source type */
847
EXPORT obs_data_t *obs_get_source_defaults(const char *id);
J
jp9000 已提交
848

J
jp9000 已提交
849
/** Returns the property list, if any.  Free with obs_properties_destroy */
850
EXPORT obs_properties_t *obs_get_source_properties(const char *id);
J
jp9000 已提交
851

852 853 854 855 856
/** Returns whether the source has custom properties or not */
EXPORT bool obs_is_source_configurable(const char *id);

EXPORT bool obs_source_configurable(const obs_source_t *source);

857 858 859 860
/**
 * Returns the properties list for a specific existing source.  Free with
 * obs_properties_destroy
 */
861
EXPORT obs_properties_t *obs_source_properties(const obs_source_t *source);
862

863
/** Updates settings for this source */
864
EXPORT void obs_source_update(obs_source_t *source, obs_data_t *settings);
865

J
jp9000 已提交
866
/** Renders a video source. */
867
EXPORT void obs_source_video_render(obs_source_t *source);
868

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

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

J
jp9000 已提交
875 876 877 878 879
/**
 * 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.
 */
880
EXPORT obs_source_t *obs_filter_get_parent(const obs_source_t *filter);
881

J
jp9000 已提交
882 883 884 885 886
/**
 * 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.
 */
887
EXPORT obs_source_t *obs_filter_get_target(const obs_source_t *filter);
888

889 890 891
/** Used to directly render a non-async source without any filter processing */
EXPORT void obs_source_default_render(obs_source_t *source);

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

J
jp9000 已提交
895
/** Removes a filter from the source */
896 897
EXPORT void obs_source_filter_remove(obs_source_t *source,
		obs_source_t *filter);
898

J
jp9000 已提交
899
/** Modifies the order of a specific filter */
900 901
EXPORT void obs_source_filter_set_order(obs_source_t *source,
		obs_source_t *filter, enum obs_order_movement movement);
J
jp9000 已提交
902 903

/** Gets the settings string for a source */
904
EXPORT obs_data_t *obs_source_get_settings(const obs_source_t *source);
905 906

/** Gets the name of a source */
907
EXPORT const char *obs_source_get_name(const obs_source_t *source);
908 909

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

J
jp9000 已提交
912
/** Gets the source type */
913
EXPORT enum obs_source_type obs_source_get_type(const obs_source_t *source);
J
jp9000 已提交
914 915

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

918
/** Returns the signal handler for a source */
919 920
EXPORT signal_handler_t *obs_source_get_signal_handler(
		const obs_source_t *source);
921 922

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

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

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

C
cg2121 已提交
931 932 933 934 935 936 937 938 939
/* Gets speaker layout of a source */
EXPORT enum speaker_layout obs_source_get_speaker_layout(obs_source_t *source);

/** Sets the balance value for a stereo audio source */
EXPORT void obs_source_set_balance_value(obs_source_t *source, float balance);

/** Gets the balance value for a stereo audio source */
EXPORT float obs_source_get_balance_value(const obs_source_t *source);

J
jp9000 已提交
940
/** Sets the audio sync offset (in nanoseconds) for a source */
941
EXPORT void obs_source_set_sync_offset(obs_source_t *source, int64_t offset);
J
jp9000 已提交
942 943

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

946 947
/** Enumerates active child sources used by this source */
EXPORT void obs_source_enum_active_sources(obs_source_t *source,
948 949 950
		obs_source_enum_proc_t enum_callback,
		void *param);

951 952
/** Enumerates the entire active child source tree used by this source */
EXPORT void obs_source_enum_active_tree(obs_source_t *source,
953 954 955
		obs_source_enum_proc_t enum_callback,
		void *param);

956
/** Returns true if active, false if not */
957
EXPORT bool obs_source_active(const obs_source_t *source);
958

J
jp9000 已提交
959 960 961 962 963
/**
 * Returns true if currently displayed somewhere (active or not), false if not
 */
EXPORT bool obs_source_showing(const obs_source_t *source);

964 965
/** Unused flag */
#define OBS_SOURCE_FLAG_UNUSED_1               (1<<0)
966 967
/** Specifies to force audio to mono */
#define OBS_SOURCE_FLAG_FORCE_MONO             (1<<1)
J
jp9000 已提交
968

969 970 971 972 973
/**
 * 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 已提交
974 975 976 977 978
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);

979 980 981 982 983 984 985 986 987
/**
 * 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);

988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
/**
 * 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);

1002 1003 1004 1005
/** Enumerates filters assigned to the source */
EXPORT void obs_source_enum_filters(obs_source_t *source,
		obs_source_enum_proc_t callback, void *param);

1006 1007 1008 1009
/** 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);

1010 1011
EXPORT void obs_source_copy_filters(obs_source_t *dst, obs_source_t *src);

1012 1013 1014
EXPORT bool obs_source_enabled(const obs_source_t *source);
EXPORT void obs_source_set_enabled(obs_source_t *source, bool enabled);

J
jp9000 已提交
1015 1016 1017
EXPORT bool obs_source_muted(const obs_source_t *source);
EXPORT void obs_source_set_muted(obs_source_t *source, bool muted);

P
Palana 已提交
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
EXPORT bool obs_source_push_to_mute_enabled(obs_source_t *source);
EXPORT void obs_source_enable_push_to_mute(obs_source_t *source, bool enabled);

EXPORT uint64_t obs_source_get_push_to_mute_delay(obs_source_t *source);
EXPORT void obs_source_set_push_to_mute_delay(obs_source_t *source,
		uint64_t delay);

EXPORT bool obs_source_push_to_talk_enabled(obs_source_t *source);
EXPORT void obs_source_enable_push_to_talk(obs_source_t *source, bool enabled);

EXPORT uint64_t obs_source_get_push_to_talk_delay(obs_source_t *source);
EXPORT void obs_source_set_push_to_talk_delay(obs_source_t *source,
		uint64_t delay);

1032 1033 1034 1035 1036 1037 1038 1039
typedef void (*obs_source_audio_capture_t)(void *param, obs_source_t *source,
		const struct audio_data *audio_data, bool muted);

EXPORT void obs_source_add_audio_capture_callback(obs_source_t *source,
		obs_source_audio_capture_t callback, void *param);
EXPORT void obs_source_remove_audio_capture_callback(obs_source_t *source,
		obs_source_audio_capture_t callback, void *param);

J
jp9000 已提交
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
enum obs_deinterlace_mode {
	OBS_DEINTERLACE_MODE_DISABLE,
	OBS_DEINTERLACE_MODE_DISCARD,
	OBS_DEINTERLACE_MODE_RETRO,
	OBS_DEINTERLACE_MODE_BLEND,
	OBS_DEINTERLACE_MODE_BLEND_2X,
	OBS_DEINTERLACE_MODE_LINEAR,
	OBS_DEINTERLACE_MODE_LINEAR_2X,
	OBS_DEINTERLACE_MODE_YADIF,
	OBS_DEINTERLACE_MODE_YADIF_2X
};

enum obs_deinterlace_field_order {
	OBS_DEINTERLACE_FIELD_ORDER_TOP,
	OBS_DEINTERLACE_FIELD_ORDER_BOTTOM
};

EXPORT void obs_source_set_deinterlace_mode(obs_source_t *source,
		enum obs_deinterlace_mode mode);
EXPORT enum obs_deinterlace_mode obs_source_get_deinterlace_mode(
		const obs_source_t *source);
EXPORT void obs_source_set_deinterlace_field_order(obs_source_t *source,
		enum obs_deinterlace_field_order field_order);
EXPORT enum obs_deinterlace_field_order obs_source_get_deinterlace_field_order(
		const obs_source_t *source);

J
jp9000 已提交
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
enum obs_monitoring_type {
	OBS_MONITORING_TYPE_NONE,
	OBS_MONITORING_TYPE_MONITOR_ONLY,
	OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT
};

EXPORT void obs_source_set_monitoring_type(obs_source_t *source,
		enum obs_monitoring_type type);
EXPORT enum obs_monitoring_type obs_source_get_monitoring_type(
		const obs_source_t *source);

1077 1078 1079 1080
/** Gets private front-end settings data.  This data is saved/loaded
 * automatically.  Returns an incremented reference. */
EXPORT obs_data_t *obs_source_get_private_settings(obs_source_t *item);

J
jp9000 已提交
1081 1082 1083
/* ------------------------------------------------------------------------- */
/* Functions used by sources */

1084 1085
EXPORT void *obs_source_get_type_data(obs_source_t *source);

J
jp9000 已提交
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
/**
 * 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);

1117
/** Outputs asynchronous video data.  Set to NULL to deactivate the texture */
1118
EXPORT void obs_source_output_video(obs_source_t *source,
1119
		const struct obs_source_frame *frame);
1120

1121 1122 1123 1124 1125 1126 1127
/** Preloads asynchronous video data to allow instantaneous playback */
EXPORT void obs_source_preload_video(obs_source_t *source,
		const struct obs_source_frame *frame);

/** Shows any preloaded video data */
EXPORT void obs_source_show_preloaded_video(obs_source_t *source);

J
jp9000 已提交
1128
/** Outputs audio data (always asynchronous) */
1129
EXPORT void obs_source_output_audio(obs_source_t *source,
1130
		const struct obs_source_audio *audio);
1131

1132 1133 1134
/** Signal an update to any currently used properties via 'update_properties' */
EXPORT void obs_source_update_properties(obs_source_t *source);

1135
/** Gets the current async video frame */
1136
EXPORT struct obs_source_frame *obs_source_get_frame(obs_source_t *source);
1137

J
jp9000 已提交
1138
/** Releases the current async video frame */
1139
EXPORT void obs_source_release_frame(obs_source_t *source,
1140
		struct obs_source_frame *frame);
J
jp9000 已提交
1141

1142 1143 1144 1145 1146 1147 1148
/**
 * 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.
1149 1150 1151
 *
 * Returns true if filtering should continue, false if the filter is bypassed
 * for whatever reason.
1152
 */
1153
EXPORT bool obs_source_process_filter_begin(obs_source_t *filter,
1154
		enum gs_color_format format,
1155
		enum obs_allow_direct_render allow_direct);
1156

1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
/**
 * 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);

1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
/**
 * Draws the filter with a specific technique.
 *
 * 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_tech_end(obs_source_t *filter,
		gs_effect_t *effect, uint32_t width, uint32_t height,
		const char *tech_name);

1178 1179 1180
/** Skips the filter if the filter is invalid and cannot be rendered */
EXPORT void obs_source_skip_video_filter(obs_source_t *filter);

1181
/**
1182 1183 1184
 * Adds an active child source.  Must be called by parent sources on child
 * sources when the child is added and active.  This ensures that the source is
 * properly activated if the parent is active.
J
jp9000 已提交
1185 1186
 *
 * @returns true if source can be added, false if it causes recursion
1187
 */
1188 1189
EXPORT bool obs_source_add_active_child(obs_source_t *parent,
		obs_source_t *child);
1190 1191

/**
1192 1193 1194
 * Removes an active child source.  Must be called by parent sources on child
 * sources when the child is removed or inactive.  This ensures that the source
 * is properly deactivated if the parent is no longer active.
1195
 */
1196 1197
EXPORT void obs_source_remove_active_child(obs_source_t *parent,
		obs_source_t *child);
1198

K
kc5nra 已提交
1199
/** Sends a mouse down/up event to a source */
1200
EXPORT void obs_source_send_mouse_click(obs_source_t *source,
K
kc5nra 已提交
1201 1202 1203 1204 1205
		const struct obs_mouse_event *event,
		int32_t type, bool mouse_up,
		uint32_t click_count);

/** Sends a mouse move event to a source. */
1206
EXPORT void obs_source_send_mouse_move(obs_source_t *source,
K
kc5nra 已提交
1207 1208 1209
		const struct obs_mouse_event *event, bool mouse_leave);

/** Sends a mouse wheel event to a source */
1210
EXPORT void obs_source_send_mouse_wheel(obs_source_t *source,
K
kc5nra 已提交
1211 1212 1213
		const struct obs_mouse_event *event, int x_delta, int y_delta);

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

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

1220 1221 1222
/** Sets the default source flags. */
EXPORT void obs_source_set_default_flags(obs_source_t *source, uint32_t flags);

1223 1224 1225 1226 1227 1228
/** 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 已提交
1229
EXPORT bool obs_source_audio_pending(const obs_source_t *source);
1230 1231 1232 1233
EXPORT uint64_t obs_source_get_audio_timestamp(const obs_source_t *source);
EXPORT void obs_source_get_audio_mix(const obs_source_t *source,
		struct obs_source_audio_mix *audio);

1234 1235 1236 1237
EXPORT void obs_source_set_async_unbuffered(obs_source_t *source,
		bool unbuffered);
EXPORT bool obs_source_async_unbuffered(const obs_source_t *source);

1238 1239 1240 1241 1242 1243
/** Used to decouple audio from video so that audio doesn't attempt to sync up
 * with video.  I.E. Audio acts independently.  Only works when in unbuffered
 * mode. */
EXPORT void obs_source_set_async_decoupled(obs_source_t *source, bool decouple);
EXPORT bool obs_source_async_decoupled(const obs_source_t *source);

J
jp9000 已提交
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
/* ------------------------------------------------------------------------- */
/* Transition-specific functions */
enum obs_transition_target {
	OBS_TRANSITION_SOURCE_A,
	OBS_TRANSITION_SOURCE_B
};

EXPORT obs_source_t *obs_transition_get_source(obs_source_t *transition,
		enum obs_transition_target target);
EXPORT void obs_transition_clear(obs_source_t *transition);

EXPORT obs_source_t *obs_transition_get_active_source(obs_source_t *transition);

enum obs_transition_mode {
	OBS_TRANSITION_MODE_AUTO,
};

EXPORT bool obs_transition_start(obs_source_t *transition,
		enum obs_transition_mode mode, uint32_t duration_ms,
		obs_source_t *dest);

EXPORT void obs_transition_set(obs_source_t *transition, obs_source_t *source);

enum obs_transition_scale_type {
	OBS_TRANSITION_SCALE_MAX_ONLY,
	OBS_TRANSITION_SCALE_ASPECT,
	OBS_TRANSITION_SCALE_STRETCH,
};

EXPORT void obs_transition_set_scale_type(obs_source_t *transition,
		enum obs_transition_scale_type type);
EXPORT enum obs_transition_scale_type obs_transition_get_scale_type(
		const obs_source_t *transition);

EXPORT void obs_transition_set_alignment(obs_source_t *transition,
		uint32_t alignment);
EXPORT uint32_t obs_transition_get_alignment(const obs_source_t *transition);

EXPORT void obs_transition_set_size(obs_source_t *transition,
		uint32_t cx, uint32_t cy);
EXPORT void obs_transition_get_size(const obs_source_t *transition,
		uint32_t *cx, uint32_t *cy);

/* function used by transitions */

/**
 * Enables fixed transitions (videos or specific types of transitions that
 * are of fixed duration and linearly interpolated
 */
EXPORT void obs_transition_enable_fixed(obs_source_t *transition, bool enable,
		uint32_t duration_ms);
EXPORT bool obs_transition_fixed(obs_source_t *transition);

typedef void (*obs_transition_video_render_callback_t)(void *data,
		gs_texture_t *a, gs_texture_t *b, float t,
		uint32_t cx, uint32_t cy);
typedef float (*obs_transition_audio_mix_callback_t)(void *data, float t);

1302 1303
EXPORT float obs_transition_get_time(obs_source_t *transition);

J
jp9000 已提交
1304 1305 1306
EXPORT void obs_transition_video_render(obs_source_t *transition,
		obs_transition_video_render_callback_t callback);

1307 1308 1309 1310 1311
/** Directly renders its sub-source instead of to texture.  Returns false if no
 * longer transitioning */
EXPORT bool obs_transition_video_render_direct(obs_source_t *transition,
		enum obs_transition_target target);

J
jp9000 已提交
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
EXPORT bool obs_transition_audio_render(obs_source_t *transition,
		uint64_t *ts_out, struct obs_source_audio_mix *audio,
		uint32_t mixers, size_t channels, size_t sample_rate,
		obs_transition_audio_mix_callback_t mix_a_callback,
		obs_transition_audio_mix_callback_t mix_b_callback);

/* swaps transition sources and textures as an optimization and to reduce
 * memory usage when switching between transitions */
EXPORT void obs_transition_swap_begin(obs_source_t *tr_dest,
		obs_source_t *tr_source);
EXPORT void obs_transition_swap_end(obs_source_t *tr_dest,
		obs_source_t *tr_source);

J
jp9000 已提交
1325 1326 1327 1328 1329 1330 1331 1332

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

/**
 * Creates a scene.
 *
 *   A scene is a source which is a container of other sources with specific
1333
 * display orientations.  Scenes can also be used like any other source.
J
jp9000 已提交
1334
 */
1335
EXPORT obs_scene_t *obs_scene_create(const char *name);
1336

1337 1338
EXPORT obs_scene_t *obs_scene_create_private(const char *name);

1339 1340 1341 1342 1343 1344 1345
enum obs_scene_duplicate_type {
	OBS_SCENE_DUP_REFS,         /**< Source refs only */
	OBS_SCENE_DUP_COPY,         /**< Fully duplicate */
	OBS_SCENE_DUP_PRIVATE_REFS, /**< Source refs only (as private) */
	OBS_SCENE_DUP_PRIVATE_COPY  /**< Fully duplicate (as private) */
};

1346 1347 1348
/**
 * Duplicates a scene.
 */
1349 1350
EXPORT obs_scene_t *obs_scene_duplicate(obs_scene_t *scene, const char *name,
		enum obs_scene_duplicate_type type);
1351

1352 1353
EXPORT void        obs_scene_addref(obs_scene_t *scene);
EXPORT void        obs_scene_release(obs_scene_t *scene);
1354

J
jp9000 已提交
1355
/** Gets the scene's source context */
1356
EXPORT obs_source_t *obs_scene_get_source(const obs_scene_t *scene);
J
jp9000 已提交
1357

1358
/** Gets the scene from its source, or NULL if not a scene */
1359
EXPORT obs_scene_t *obs_scene_from_source(const obs_source_t *source);
1360

1361
/** Determines whether a source is within a scene */
1362
EXPORT obs_sceneitem_t *obs_scene_find_source(obs_scene_t *scene,
1363 1364
		const char *name);

J
jp9000 已提交
1365 1366 1367
EXPORT obs_sceneitem_t *obs_scene_find_sceneitem_by_id(obs_scene_t *scene,
		int64_t id);

1368
/** Enumerates sources within a scene */
1369 1370
EXPORT void obs_scene_enum_items(obs_scene_t *scene,
		bool (*callback)(obs_scene_t*, obs_sceneitem_t*, void*),
1371 1372
		void *param);

P
Palana 已提交
1373 1374 1375
EXPORT bool obs_scene_reorder_items(obs_scene_t *scene,
		obs_sceneitem_t * const *item_order, size_t item_order_size);

J
jp9000 已提交
1376 1377 1378 1379 1380 1381 1382 1383 1384
struct obs_sceneitem_order_info {
	obs_sceneitem_t *group;
	obs_sceneitem_t *item;
};

EXPORT bool obs_scene_reorder_items2(obs_scene_t *scene,
		struct obs_sceneitem_order_info *item_order,
		size_t item_order_size);

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

P
Palana 已提交
1388 1389 1390 1391
typedef void (*obs_scene_atomic_update_func)(void *, obs_scene_t *scene);
EXPORT void obs_scene_atomic_update(obs_scene_t *scene,
		obs_scene_atomic_update_func func, void *data);

1392 1393
EXPORT void obs_sceneitem_addref(obs_sceneitem_t *item);
EXPORT void obs_sceneitem_release(obs_sceneitem_t *item);
1394

J
jp9000 已提交
1395
/** Removes a scene item. */
1396
EXPORT void obs_sceneitem_remove(obs_sceneitem_t *item);
J
jp9000 已提交
1397 1398

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

J
jp9000 已提交
1401
/** Gets the source of a scene item. */
1402
EXPORT obs_source_t *obs_sceneitem_get_source(const obs_sceneitem_t *item);
J
jp9000 已提交
1403

1404 1405
/* FIXME: The following functions should be deprecated and replaced with a way
 * to specify savable private user data. -Jim */
1406
EXPORT void obs_sceneitem_select(obs_sceneitem_t *item, bool select);
1407
EXPORT bool obs_sceneitem_selected(const obs_sceneitem_t *item);
1408 1409
EXPORT bool obs_sceneitem_locked(const obs_sceneitem_t *item);
EXPORT bool obs_sceneitem_set_locked(obs_sceneitem_t *item, bool lock);
1410

1411
/* Functions for getting/setting specific orientation of a scene item */
1412 1413 1414
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,
1415
		const struct vec2 *scale);
1416
EXPORT void obs_sceneitem_set_alignment(obs_sceneitem_t *item,
1417
		uint32_t alignment);
1418
EXPORT void obs_sceneitem_set_order(obs_sceneitem_t *item,
J
jp9000 已提交
1419
		enum obs_order_movement movement);
1420 1421
EXPORT void obs_sceneitem_set_order_position(obs_sceneitem_t *item,
		int position);
1422
EXPORT void obs_sceneitem_set_bounds_type(obs_sceneitem_t *item,
1423
		enum obs_bounds_type type);
1424
EXPORT void obs_sceneitem_set_bounds_alignment(obs_sceneitem_t *item,
1425
		uint32_t alignment);
1426
EXPORT void obs_sceneitem_set_bounds(obs_sceneitem_t *item,
1427 1428
		const struct vec2 *bounds);

J
jp9000 已提交
1429 1430
EXPORT int64_t obs_sceneitem_get_id(const obs_sceneitem_t *item);

1431 1432 1433 1434 1435 1436
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);
1437

1438
EXPORT enum obs_bounds_type obs_sceneitem_get_bounds_type(
1439 1440 1441
		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,
1442
		struct vec2 *bounds);
1443

1444
EXPORT void obs_sceneitem_get_info(const obs_sceneitem_t *item,
1445
		struct obs_transform_info *info);
1446
EXPORT void obs_sceneitem_set_info(obs_sceneitem_t *item,
1447
		const struct obs_transform_info *info);
1448

1449
EXPORT void obs_sceneitem_get_draw_transform(const obs_sceneitem_t *item,
1450
		struct matrix4 *transform);
1451
EXPORT void obs_sceneitem_get_box_transform(const obs_sceneitem_t *item,
1452
		struct matrix4 *transform);
J
jp9000 已提交
1453

1454
EXPORT bool obs_sceneitem_visible(const obs_sceneitem_t *item);
1455
EXPORT bool obs_sceneitem_set_visible(obs_sceneitem_t *item, bool visible);
1456

1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
struct obs_sceneitem_crop {
	int left;
	int top;
	int right;
	int bottom;
};

EXPORT void obs_sceneitem_set_crop(obs_sceneitem_t *item,
		const struct obs_sceneitem_crop *crop);
EXPORT void obs_sceneitem_get_crop(const obs_sceneitem_t *item,
		struct obs_sceneitem_crop *crop);

1469 1470 1471 1472 1473
EXPORT void obs_sceneitem_set_scale_filter(obs_sceneitem_t *item,
		enum obs_scale_type filter);
EXPORT enum obs_scale_type obs_sceneitem_get_scale_filter(
		obs_sceneitem_t *item);

1474 1475
EXPORT void obs_sceneitem_force_update_transform(obs_sceneitem_t *item);

1476 1477 1478
EXPORT void obs_sceneitem_defer_update_begin(obs_sceneitem_t *item);
EXPORT void obs_sceneitem_defer_update_end(obs_sceneitem_t *item);

1479 1480 1481 1482
/** Gets private front-end settings data.  This data is saved/loaded
 * automatically.  Returns an incremented reference. */
EXPORT obs_data_t *obs_sceneitem_get_private_settings(obs_sceneitem_t *item);

J
jp9000 已提交
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
EXPORT obs_sceneitem_t *obs_scene_add_group(obs_scene_t *scene,
		const char *name);
EXPORT obs_sceneitem_t *obs_scene_insert_group(obs_scene_t *scene,
		const char *name, obs_sceneitem_t **items, size_t count);

EXPORT obs_sceneitem_t *obs_scene_get_group(obs_scene_t *scene,
		const char *name);

EXPORT bool obs_sceneitem_is_group(obs_sceneitem_t *item);

EXPORT obs_scene_t *obs_sceneitem_group_get_scene(
		const obs_sceneitem_t *group);

EXPORT void obs_sceneitem_group_ungroup(obs_sceneitem_t *group);

EXPORT void obs_sceneitem_group_add_item(obs_sceneitem_t *group,
		obs_sceneitem_t *item);
1500 1501
EXPORT void obs_sceneitem_group_remove_item(obs_sceneitem_t *group,
		obs_sceneitem_t *item);
J
jp9000 已提交
1502

1503 1504
EXPORT obs_sceneitem_t *obs_sceneitem_get_group(obs_scene_t *scene,
		obs_sceneitem_t *item);
J
jp9000 已提交
1505

1506 1507
EXPORT bool obs_source_is_group(const obs_source_t *source);
EXPORT bool obs_scene_is_group(const obs_scene_t *scene);
J
jp9000 已提交
1508 1509 1510 1511 1512 1513 1514 1515

EXPORT void obs_sceneitem_group_enum_items(obs_sceneitem_t *group,
		bool (*callback)(obs_scene_t*, obs_sceneitem_t*, void*),
		void *param);

EXPORT void obs_sceneitem_defer_group_resize_begin(obs_sceneitem_t *item);
EXPORT void obs_sceneitem_defer_group_resize_end(obs_sceneitem_t *item);

J
jp9000 已提交
1516 1517 1518 1519

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

1520
EXPORT const char *obs_output_get_display_name(const char *id);
1521

J
jp9000 已提交
1522 1523 1524 1525 1526 1527
/**
 * Creates an output.
 *
 *   Outputs allow outputting to file, outputting to network, outputting to
 * directshow, or other custom outputs.
 */
1528
EXPORT obs_output_t *obs_output_create(const char *id, const char *name,
1529
		obs_data_t *settings, obs_data_t *hotkey_data);
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546

/**
 * Adds/releases a reference to an output.  When the last reference is
 * released, the output is destroyed.
 */
EXPORT void obs_output_addref(obs_output_t *output);
EXPORT void obs_output_release(obs_output_t *output);

EXPORT void obs_weak_output_addref(obs_weak_output_t *weak);
EXPORT void obs_weak_output_release(obs_weak_output_t *weak);

EXPORT obs_output_t *obs_output_get_ref(obs_output_t *output);
EXPORT obs_weak_output_t *obs_output_get_weak_output(obs_output_t *output);
EXPORT obs_output_t *obs_weak_output_get_output(obs_weak_output_t *weak);

EXPORT bool obs_weak_output_references_output(obs_weak_output_t *weak,
		obs_output_t *output);
1547

1548
EXPORT const char *obs_output_get_name(const obs_output_t *output);
J
jp9000 已提交
1549

J
jp9000 已提交
1550
/** Starts the output. */
1551
EXPORT bool obs_output_start(obs_output_t *output);
1552

J
jp9000 已提交
1553
/** Stops the output. */
1554
EXPORT void obs_output_stop(obs_output_t *output);
1555

1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581
/**
 * On reconnection, start where it left of on reconnection.  Note however that
 * this option will consume extra memory to continually increase delay while
 * waiting to reconnect.
 */
#define OBS_OUTPUT_DELAY_PRESERVE (1<<0)

/**
 * Sets the current output delay, in seconds (if the output supports delay).
 *
 * If delay is currently active, it will set the delay value, but will not
 * affect the current delay, it will only affect the next time the output is
 * activated.
 */
EXPORT void obs_output_set_delay(obs_output_t *output, uint32_t delay_sec,
		uint32_t flags);

/** Gets the currently set delay value, in seconds. */
EXPORT uint32_t obs_output_get_delay(const obs_output_t *output);

/** If delay is active, gets the currently active delay value, in seconds. */
EXPORT uint32_t obs_output_get_active_delay(const obs_output_t *output);

/** Forces the output to stop.  Usually only used with delay. */
EXPORT void obs_output_force_stop(obs_output_t *output);

1582
/** Returns whether the output is active */
1583
EXPORT bool obs_output_active(const obs_output_t *output);
1584

1585 1586 1587 1588 1589 1590
/** Returns output capability flags */
EXPORT uint32_t obs_output_get_flags(const obs_output_t *output);

/** Returns output capability flags */
EXPORT uint32_t obs_get_output_flags(const char *id);

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

J
jp9000 已提交
1594
/** Returns the property list, if any.  Free with obs_properties_destroy */
1595
EXPORT obs_properties_t *obs_get_output_properties(const char *id);
1596 1597 1598 1599 1600

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

1603
/** Updates the settings for this output context */
1604
EXPORT void obs_output_update(obs_output_t *output, obs_data_t *settings);
1605

J
jp9000 已提交
1606
/** Specifies whether the output can be paused */
J
jp9000 已提交
1607
EXPORT bool obs_output_can_pause(const obs_output_t *output);
1608

J
jp9000 已提交
1609
/** Pauses the output (if the functionality is allowed by the output */
1610
EXPORT void obs_output_pause(obs_output_t *output);
J
jp9000 已提交
1611 1612

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

1615
/** Returns the signal handler for an output  */
1616 1617
EXPORT signal_handler_t *obs_output_get_signal_handler(
		const obs_output_t *output);
1618 1619

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

J
jp9000 已提交
1622 1623 1624 1625
/**
 * Sets the current audio/video media contexts associated with this output,
 * required for non-encoded outputs.  Can be null.
 */
1626 1627
EXPORT void obs_output_set_media(obs_output_t *output,
		video_t *video, audio_t *audio);
J
jp9000 已提交
1628 1629

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

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

1635 1636 1637 1638 1639 1640
/** 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);

1641 1642 1643 1644 1645 1646
/** Sets the current audio mixes (mask) for a non-encoded multi-track output */
EXPORT void obs_output_set_mixers(obs_output_t *output, size_t mixers);

/** Gets the current audio mixes (mask) for a non-encoded multi-track output */
EXPORT size_t obs_output_get_mixers(const obs_output_t *output);

J
jp9000 已提交
1647 1648 1649 1650
/**
 * Sets the current video encoder associated with this output,
 * required for encoded outputs
 */
1651 1652
EXPORT void obs_output_set_video_encoder(obs_output_t *output,
		obs_encoder_t *encoder);
J
jp9000 已提交
1653 1654 1655

/**
 * Sets the current audio encoder associated with this output,
1656 1657 1658 1659 1660
 * 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 已提交
1661
 */
1662
EXPORT void obs_output_set_audio_encoder(obs_output_t *output,
1663
		obs_encoder_t *encoder, size_t idx);
J
jp9000 已提交
1664 1665

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

1668 1669 1670 1671 1672 1673 1674 1675 1676
/**
 * 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 已提交
1677

1678
/** Sets the current service associated with this output. */
1679 1680
EXPORT void obs_output_set_service(obs_output_t *output,
		obs_service_t *service);
1681 1682

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

J
jp9000 已提交
1685 1686 1687
/**
 * Sets the reconnect settings.  Set retry_count to 0 to disable reconnecting.
 */
1688
EXPORT void obs_output_set_reconnect_settings(obs_output_t *output,
J
jp9000 已提交
1689 1690
		int retry_count, int retry_sec);

1691 1692 1693
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 已提交
1694

1695 1696 1697 1698 1699 1700 1701 1702
/**
 * 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.
 */
1703
EXPORT void obs_output_set_preferred_size(obs_output_t *output, uint32_t width,
1704 1705 1706
		uint32_t height);

/** For video outputs, returns the width of the encoded image */
1707
EXPORT uint32_t obs_output_get_width(const obs_output_t *output);
1708 1709

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

J
jp9000 已提交
1712 1713
EXPORT const char *obs_output_get_id(const obs_output_t *output);

1714 1715 1716 1717 1718
#if BUILD_CAPTIONS
EXPORT void obs_output_output_caption_text1(obs_output_t *output,
		const char *text);
#endif

1719
EXPORT float obs_output_get_congestion(obs_output_t *output);
1720
EXPORT int obs_output_get_connect_time_ms(obs_output_t *output);
1721

1722 1723
EXPORT bool obs_output_reconnecting(const obs_output_t *output);

1724 1725 1726
/** Pass a string of the last output error, for UI use */
EXPORT void obs_output_set_last_error(obs_output_t *output,
		const char *message);
1727
EXPORT const char *obs_output_get_last_error(obs_output_t *output);
1728

1729 1730 1731 1732 1733
EXPORT const char *obs_output_get_supported_video_codecs(
		const obs_output_t *output);
EXPORT const char *obs_output_get_supported_audio_codecs(
		const obs_output_t *output);

J
jp9000 已提交
1734 1735 1736
/* ------------------------------------------------------------------------- */
/* Functions used by outputs */

1737 1738
EXPORT void *obs_output_get_type_data(obs_output_t *output);

J
jp9000 已提交
1739
/** Optionally sets the video conversion info.  Used only for raw output */
1740
EXPORT void obs_output_set_video_conversion(obs_output_t *output,
J
jp9000 已提交
1741 1742 1743
		const struct video_scale_info *conversion);

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

1747
/** Returns whether data capture can begin with the specified flags */
1748
EXPORT bool obs_output_can_begin_data_capture(const obs_output_t *output,
1749 1750
		uint32_t flags);

1751
/** Initializes encoders (if any) */
1752 1753
EXPORT bool obs_output_initialize_encoders(obs_output_t *output,
		uint32_t flags);
1754

J
jp9000 已提交
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
/**
 * 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.
 */
1767
EXPORT bool obs_output_begin_data_capture(obs_output_t *output, uint32_t flags);
J
jp9000 已提交
1768 1769

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

1772 1773 1774 1775 1776 1777
/**
 * Signals that the output has stopped itself.
 *
 * @param  output  Output context
 * @param  code    Error code (or OBS_OUTPUT_SUCCESS if not an error)
 */
1778
EXPORT void obs_output_signal_stop(obs_output_t *output, int code);
1779

1780

1781
/* ------------------------------------------------------------------------- */
J
jp9000 已提交
1782
/* Encoders */
1783

J
jp9000 已提交
1784
EXPORT const char *obs_encoder_get_display_name(const char *id);
1785

1786 1787 1788 1789 1790 1791 1792 1793
/**
 * 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.
 */
1794
EXPORT obs_encoder_t *obs_video_encoder_create(const char *id, const char *name,
1795
		obs_data_t *settings, obs_data_t *hotkey_data);
1796

1797 1798 1799 1800 1801 1802
/**
 * Creates an audio encoder context
 *
 * @param  id        Audio Encoder ID
 * @param  name      Name to assign to this context
 * @param  settings  Settings
1803
 * @param  mixer_idx Index of the mixer to use for this audio encoder
1804 1805
 * @return           The video encoder context, or NULL if failed or not found.
 */
1806
EXPORT obs_encoder_t *obs_audio_encoder_create(const char *id, const char *name,
1807 1808
		obs_data_t *settings, size_t mixer_idx,
		obs_data_t *hotkey_data);
J
jp9000 已提交
1809

1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825
/**
 * Adds/releases a reference to an encoder.  When the last reference is
 * released, the encoder is destroyed.
 */
EXPORT void obs_encoder_addref(obs_encoder_t *encoder);
EXPORT void obs_encoder_release(obs_encoder_t *encoder);

EXPORT void obs_weak_encoder_addref(obs_weak_encoder_t *weak);
EXPORT void obs_weak_encoder_release(obs_weak_encoder_t *weak);

EXPORT obs_encoder_t *obs_encoder_get_ref(obs_encoder_t *encoder);
EXPORT obs_weak_encoder_t *obs_encoder_get_weak_encoder(obs_encoder_t *encoder);
EXPORT obs_encoder_t *obs_weak_encoder_get_encoder(obs_weak_encoder_t *weak);

EXPORT bool obs_weak_encoder_references_encoder(obs_weak_encoder_t *weak,
		obs_encoder_t *encoder);
1826

1827
EXPORT void obs_encoder_set_name(obs_encoder_t *encoder, const char *name);
1828
EXPORT const char *obs_encoder_get_name(const obs_encoder_t *encoder);
J
jp9000 已提交
1829

1830 1831 1832
/** Returns the codec of an encoder by the id */
EXPORT const char *obs_get_encoder_codec(const char *id);

1833 1834 1835
/** Returns the type of an encoder by the id */
EXPORT enum obs_encoder_type obs_get_encoder_type(const char *id);

1836
/** Returns the codec of the encoder */
1837
EXPORT const char *obs_encoder_get_codec(const obs_encoder_t *encoder);
1838

1839 1840 1841
/** Returns the type of an encoder */
EXPORT enum obs_encoder_type obs_encoder_get_type(const obs_encoder_t *encoder);

1842 1843 1844 1845 1846
/**
 * 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.
 */
1847
EXPORT void obs_encoder_set_scaled_size(obs_encoder_t *encoder, uint32_t width,
1848 1849 1850
		uint32_t height);

/** For video encoders, returns the width of the encoded image */
1851
EXPORT uint32_t obs_encoder_get_width(const obs_encoder_t *encoder);
1852 1853

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

1856 1857 1858
/** For audio encoders, returns the sample rate of the audio */
EXPORT uint32_t obs_encoder_get_sample_rate(const obs_encoder_t *encoder);

1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871
/**
 * Sets the preferred video format for a video encoder.  If the encoder can use
 * the format specified, it will force a conversion to that format if the
 * obs output format does not match the preferred format.
 *
 * If the format is set to VIDEO_FORMAT_NONE, will revert to the default
 * functionality of converting only when absolutely necessary.
 */
EXPORT void obs_encoder_set_preferred_video_format(obs_encoder_t *encoder,
		enum video_format format);
EXPORT enum video_format obs_encoder_get_preferred_video_format(
		const obs_encoder_t *encoder);

J
jp9000 已提交
1872
/** Gets the default settings for an encoder type */
1873
EXPORT obs_data_t *obs_encoder_defaults(const char *id);
1874
EXPORT obs_data_t *obs_encoder_get_defaults(const obs_encoder_t *encoder);
J
jp9000 已提交
1875

J
jp9000 已提交
1876
/** Returns the property list, if any.  Free with obs_properties_destroy */
1877
EXPORT obs_properties_t *obs_get_encoder_properties(const char *id);
1878 1879 1880 1881 1882

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

1885 1886 1887 1888
/**
 * Updates the settings of the encoder context.  Usually used for changing
 * bitrate while active
 */
1889
EXPORT void obs_encoder_update(obs_encoder_t *encoder, obs_data_t *settings);
1890

1891
/** Gets extra data (headers) associated with this context */
1892
EXPORT bool obs_encoder_get_extra_data(const obs_encoder_t *encoder,
J
jp9000 已提交
1893
		uint8_t **extra_data, size_t *size);
1894

1895
/** Returns the current settings for this encoder */
1896
EXPORT obs_data_t *obs_encoder_get_settings(const obs_encoder_t *encoder);
1897

1898
/** Sets the video output context to be used with this encoder */
1899
EXPORT void obs_encoder_set_video(obs_encoder_t *encoder, video_t *video);
1900 1901

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

1904 1905 1906 1907
/**
 * Returns the video output context used with this encoder, or NULL if not
 * a video context
 */
1908
EXPORT video_t *obs_encoder_video(const obs_encoder_t *encoder);
1909 1910 1911 1912 1913

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

1916
/** Returns true if encoder is active, false otherwise */
1917
EXPORT bool obs_encoder_active(const obs_encoder_t *encoder);
1918

1919 1920
EXPORT void *obs_encoder_get_type_data(obs_encoder_t *encoder);

J
jp9000 已提交
1921 1922
EXPORT const char *obs_encoder_get_id(const obs_encoder_t *encoder);

1923 1924
EXPORT uint32_t obs_get_encoder_caps(const char *encoder_id);

1925
#ifndef SWIG
1926
/** Duplicates an encoder packet */
1927
DEPRECATED
1928 1929 1930
EXPORT void obs_duplicate_encoder_packet(struct encoder_packet *dst,
		const struct encoder_packet *src);

1931
DEPRECATED
1932
EXPORT void obs_free_encoder_packet(struct encoder_packet *packet);
1933
#endif
1934

1935 1936 1937 1938
EXPORT void obs_encoder_packet_ref(struct encoder_packet *dst,
		struct encoder_packet *src);
EXPORT void obs_encoder_packet_release(struct encoder_packet *packet);

J
jp9000 已提交
1939 1940 1941
EXPORT void *obs_encoder_create_rerouted(obs_encoder_t *encoder,
		const char *reroute_id);

1942

1943 1944
/* ------------------------------------------------------------------------- */
/* Stream Services */
1945

1946
EXPORT const char *obs_service_get_display_name(const char *id);
1947

1948
EXPORT obs_service_t *obs_service_create(const char *id, const char *name,
1949
		obs_data_t *settings, obs_data_t *hotkey_data);
1950

1951 1952 1953
EXPORT obs_service_t *obs_service_create_private(const char *id,
		const char *name, obs_data_t *settings);

1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
/**
 * Adds/releases a reference to a service.  When the last reference is
 * released, the service is destroyed.
 */
EXPORT void obs_service_addref(obs_service_t *service);
EXPORT void obs_service_release(obs_service_t *service);

EXPORT void obs_weak_service_addref(obs_weak_service_t *weak);
EXPORT void obs_weak_service_release(obs_weak_service_t *weak);

EXPORT obs_service_t *obs_service_get_ref(obs_service_t *service);
EXPORT obs_weak_service_t *obs_service_get_weak_service(obs_service_t *service);
EXPORT obs_service_t *obs_weak_service_get_service(obs_weak_service_t *weak);

EXPORT bool obs_weak_service_references_service(obs_weak_service_t *weak,
		obs_service_t *service);
1970

1971
EXPORT const char *obs_service_get_name(const obs_service_t *service);
1972

1973
/** Gets the default settings for a service */
1974
EXPORT obs_data_t *obs_service_defaults(const char *id);
1975 1976

/** Returns the property list, if any.  Free with obs_properties_destroy */
1977
EXPORT obs_properties_t *obs_get_service_properties(const char *id);
1978 1979 1980 1981 1982

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

1985
/** Gets the service type */
1986
EXPORT const char *obs_service_get_type(const obs_service_t *service);
1987 1988

/** Updates the settings of the service context */
1989
EXPORT void obs_service_update(obs_service_t *service, obs_data_t *settings);
1990 1991

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

1994
/** Returns the URL for this service context */
1995
EXPORT const char *obs_service_get_url(const obs_service_t *service);
1996 1997

/** Returns the stream key (if any) for this service context */
1998
EXPORT const char *obs_service_get_key(const obs_service_t *service);
1999 2000

/** Returns the username (if any) for this service context */
2001
EXPORT const char *obs_service_get_username(const obs_service_t *service);
2002 2003

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

2006 2007 2008
/**
 * Applies service-specific video encoder settings.
 *
2009 2010
 * @param  video_encoder_settings  Video encoder settings.  Optional.
 * @param  audio_encoder_settings  Audio encoder settings.  Optional.
2011 2012
 */
EXPORT void obs_service_apply_encoder_settings(obs_service_t *service,
2013 2014
		obs_data_t *video_encoder_settings,
		obs_data_t *audio_encoder_settings);
2015

2016 2017
EXPORT void *obs_service_get_type_data(obs_service_t *service);

J
jp9000 已提交
2018 2019
EXPORT const char *obs_service_get_id(const obs_service_t *service);

2020 2021 2022 2023
/* NOTE: This function is temporary and should be removed/replaced at a later
 * date. */
EXPORT const char *obs_service_get_output_type(const obs_service_t *service);

2024

2025 2026
/* ------------------------------------------------------------------------- */
/* Source frame allocation functions */
2027
EXPORT void obs_source_frame_init(struct obs_source_frame *frame,
2028 2029
		enum video_format format, uint32_t width, uint32_t height);

2030
static inline void obs_source_frame_free(struct obs_source_frame *frame)
2031 2032 2033
{
	if (frame) {
		bfree(frame->data[0]);
2034
		memset(frame, 0, sizeof(*frame));
2035 2036 2037
	}
}

2038
static inline struct obs_source_frame *obs_source_frame_create(
2039 2040
		enum video_format format, uint32_t width, uint32_t height)
{
2041
	struct obs_source_frame *frame;
2042

2043 2044
	frame = (struct obs_source_frame*)bzalloc(sizeof(*frame));
	obs_source_frame_init(frame, format, width, height);
2045 2046 2047
	return frame;
}

2048
static inline void obs_source_frame_destroy(struct obs_source_frame *frame)
2049 2050 2051 2052 2053 2054 2055
{
	if (frame) {
		bfree(frame->data[0]);
		bfree(frame);
	}
}

B
Bas van Meel 已提交
2056 2057
EXPORT void obs_source_frame_copy(struct obs_source_frame *dst,
		const struct obs_source_frame *src);
2058

J
jp9000 已提交
2059 2060 2061
#ifdef __cplusplus
}
#endif