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

    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"
J
jp9000 已提交
22 23
#include "graphics/graphics.h"
#include "graphics/vec2.h"
J
jp9000 已提交
24 25
#include "media-io/audio-io.h"
#include "media-io/video-io.h"
26 27
#include "callback/signal.h"
#include "callback/proc.h"
J
jp9000 已提交
28

29 30 31 32 33
#include "obs-defs.h"
#include "obs-data.h"
#include "obs-ui.h"
#include "obs-properties.h"

J
jp9000 已提交
34 35
/* opaque types */
struct obs_display;
36
struct obs_viewport;
J
jp9000 已提交
37 38 39 40 41 42 43 44
struct obs_source;
struct obs_scene;
struct obs_scene_item;
struct obs_output;
struct obs_encoder;
struct obs_service;

typedef struct obs_display    *obs_display_t;
45
typedef struct obs_viewport   *obs_viewport_t;
J
jp9000 已提交
46 47 48 49 50 51 52 53 54 55 56
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;

#include "obs-source.h"
#include "obs-encoder.h"
#include "obs-output.h"
#include "obs-service.h"
J
jp9000 已提交
57

J
jp9000 已提交
58
/*
J
jp9000 已提交
59 60
 * @file
 *
J
jp9000 已提交
61 62 63 64 65 66 67
 * Main libobs header used by applications.
 */

#ifdef __cplusplus
extern "C" {
#endif

68 69 70 71 72 73 74
/* LIBOBS_API_VER must be returned by module_version in each module */

#define LIBOBS_API_MAJOR_VER  0 /* increment if major breaking changes */
#define LIBOBS_API_MINOR_VER  1 /* increment if minor non-breaking additions */
#define LIBOBS_API_VER       ((LIBOBS_API_MAJOR_VER << 16) | \
                               LIBOBS_API_MINOR_VER)

J
jp9000 已提交
75
/** Used for changing the order of items (for example, filters in a source,
J
jp9000 已提交
76
 * or items in a scene) */
J
jp9000 已提交
77 78 79 80 81 82 83
enum order_movement {
	ORDER_MOVE_UP,
	ORDER_MOVE_DOWN,
	ORDER_MOVE_TOP,
	ORDER_MOVE_BOTTOM
};

J
jp9000 已提交
84 85 86 87 88
/**
 * 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
 */
89 90 91 92 93
enum allow_direct_render {
	NO_DIRECT_RENDERING,
	ALLOW_DIRECT_RENDERING,
};

J
jp9000 已提交
94 95 96
/**
 * Video initialization structure
 */
97
struct obs_video_info {
J
jp9000 已提交
98 99 100 101
	/**
	 * Graphics module to use (usually "libobs-opengl" or
	 * "libobs-d3d11")
	 */
102
	const char          *graphics_module;
103

J
jp9000 已提交
104 105
	uint32_t            fps_num;       /**< Output FPS numerator */
	uint32_t            fps_den;       /**< Output FPS denominator */
106

J
jp9000 已提交
107 108
	uint32_t            window_width;  /**< Window width */
	uint32_t            window_height; /**< Window height */
109

J
jp9000 已提交
110 111
	uint32_t            base_width;    /**< Base compositing width */
	uint32_t            base_height;   /**< Base compositing height */
112

J
jp9000 已提交
113 114 115
	uint32_t            output_width;  /**< Output width */
	uint32_t            output_height; /**< Output height */
	enum video_format   output_format; /**< Output format */
116

J
jp9000 已提交
117
	/** Video adapter index to use (NOTE: avoid for optimus laptops) */
118
	uint32_t            adapter;
119

J
jp9000 已提交
120
	struct gs_window    window;        /**< Window to render to */
121 122
};

J
jp9000 已提交
123 124 125 126
/**
 * Sent to source filters via the filter_audio callback to allow filtering of
 * audio data
 */
127
struct filtered_audio {
128
	uint8_t             *data[MAX_AUDIO_PLANES];
129 130 131 132
	uint32_t            frames;
	uint64_t            timestamp;
};

J
jp9000 已提交
133 134 135 136
/**
 * Source audio output structure.  Used with obs_source_output_audio to output
 * source audio.  Audio is automatically resampled and remixed as necessary.
 */
137
struct source_audio {
138
	const uint8_t       *data[MAX_AUDIO_PLANES];
J
jp9000 已提交
139
	uint32_t            frames;
140

J
jp9000 已提交
141
	enum speaker_layout speakers;
142
	enum audio_format   format;
J
jp9000 已提交
143
	uint32_t            samples_per_sec;
144

J
jp9000 已提交
145
	uint64_t            timestamp;
146 147
};

J
jp9000 已提交
148 149 150 151 152 153 154 155 156
/**
 * 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.
 */
157
struct source_frame {
158
	uint8_t             *data[MAX_VIDEO_PLANES];
159
	uint32_t            linesize[MAX_VIDEO_PLANES];
J
jp9000 已提交
160 161 162 163
	uint32_t            width;
	uint32_t            height;
	uint64_t            timestamp;

164
	enum video_format   format;
165
	float               color_matrix[16];
J
jp9000 已提交
166
	bool                flip;
167 168
};

169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
enum packet_priority {
	PACKET_PRIORITY_DISPOSABLE,
	PACKET_PRIORITY_LOW,
	PACKET_PRIORITY_PFRAME,
	PACKET_PRIORITY_IFRAME,
	PACKET_PRIORITY_OTHER /* audio usually */
};

struct encoder_packet {
	int64_t              dts;
	int64_t              pts;
	void                 *data;
	size_t               size;
	enum packet_priority priority;
};

J
jp9000 已提交
185 186 187
/* ------------------------------------------------------------------------- */
/* OBS context */

J
jp9000 已提交
188
/** Initializes OBS */
189
EXPORT bool obs_startup(void);
J
jp9000 已提交
190 191

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

194 195 196
/** @return true if the main OBS context has been initialized */
EXPORT bool obs_initialized(void);

J
jp9000 已提交
197 198 199
/**
 * Sets base video ouput base resolution/fps/format
 *
J
jp9000 已提交
200
 * @note Cannot set base video if an output is currently active.
J
jp9000 已提交
201
 */
202
EXPORT bool obs_reset_video(struct obs_video_info *ovi);
203

J
jp9000 已提交
204 205 206
/**
 * Sets base audio output format/channels/samples/etc
 *
J
jp9000 已提交
207
 * @note Cannot reset base audio if an output is currently active.
J
jp9000 已提交
208
 */
J
jp9000 已提交
209
EXPORT bool obs_reset_audio(struct audio_output_info *ai);
J
jp9000 已提交
210

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

J
jp9000 已提交
214
/** Gets the current audio settings, returns false if no audio */
J
jp9000 已提交
215
EXPORT bool obs_get_audio_info(struct audio_output_info *ai);
216

J
jp9000 已提交
217 218 219 220 221 222 223
/**
 * Loads a plugin module
 *
 *   A plugin module contains exports for inputs/fitlers/transitions/outputs.
 * See obs-source.h and obs-output.h for more information on the exports to
 * use.
 */
224
EXPORT int obs_load_module(const char *path);
J
jp9000 已提交
225 226

/**
227
 * Enumerates all available inputs source types.
J
jp9000 已提交
228 229 230 231
 *
 *   Inputs are general source inputs (such as capture sources, device sources,
 * etc).
 */
232
EXPORT bool obs_enum_input_types(size_t idx, const char **id);
233

J
jp9000 已提交
234
/**
235
 * Enumerates all available filter source types.
J
jp9000 已提交
236 237 238 239
 *
 *   Filters are sources that are used to modify the video/audio output of
 * other sources.
 */
240
EXPORT bool obs_enum_filter_types(size_t idx, const char **id);
241

J
jp9000 已提交
242
/**
243
 * Enumerates all available transition source types.
J
jp9000 已提交
244 245 246 247
 *
 *   Transitions are sources used to transition between two or more other
 * sources.
 */
248
EXPORT bool obs_enum_transition_types(size_t idx, const char **id);
249

J
jp9000 已提交
250
/**
251
 * Enumerates all available ouput types.
J
jp9000 已提交
252 253 254 255
 *
 *   Outputs handle color space conversion, encoding, and output to file or
 * streams.
 */
256
EXPORT bool obs_enum_output_types(size_t idx, const char **id);
J
jp9000 已提交
257

258
/** Gets the main graphics context for this OBS context */
259 260
EXPORT graphics_t obs_graphics(void);

261
/** Gets the main audio output handler for this OBS context */
J
jp9000 已提交
262
EXPORT audio_t obs_audio(void);
263 264

/** Gets the main video output handler for this OBS context */
J
jp9000 已提交
265
EXPORT video_t obs_video(void);
J
jp9000 已提交
266 267

/**
268 269
 * Adds a source to the user source list and increments the reference counter
 * for that source.
J
jp9000 已提交
270
 *
271 272 273
 *   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 已提交
274
 */
275 276
EXPORT bool obs_add_source(obs_source_t source);

277
/** Sets the primary output source for a channel. */
278
EXPORT void obs_set_output_source(uint32_t channel, obs_source_t source);
279 280 281 282 283

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

286 287 288 289 290 291
/**
 * Enumerates user sources
 *
 *   Callback function returns true to continue enumeration, or false to end
 * enumeration.
 */
292 293 294 295 296 297 298 299 300
EXPORT void obs_enum_sources(bool (*enum_proc)(void*, obs_source_t),
		void *param);

/** Enumerates outputs */
EXPORT void obs_enum_outputs(bool (*enum_proc)(void*, obs_output_t),
		void *param);

/** Enumerates encoders */
EXPORT void obs_enum_encoders(bool (*enum_proc)(void*, obs_encoder_t),
301 302 303 304 305 306 307 308 309
		void *param);

/**
 * Gets a source by its name.
 *
 *   Increments the source reference counter, use obs_source_release to
 * release it when complete.
 */
EXPORT obs_source_t obs_get_source_by_name(const char *name);
310

J
jp9000 已提交
311 312 313 314
/**
 * Returns the location of a plugin data file.
 *
 *   file: Name of file to locate.  For example, "myplugin/mydata.data"
315
 *   returns: Path string, or NULL if not found.  Use bfree to free string.
J
jp9000 已提交
316 317 318
 */
EXPORT char *obs_find_plugin_file(const char *file);

319
/** Returns the default effect for generic RGB/YUV drawing */
P
Palana 已提交
320
EXPORT effect_t obs_get_default_effect(void);
321

322 323 324 325 326 327
/** Returns the primary obs signal handler */
EXPORT signal_handler_t obs_signalhandler(void);

/** Returns the primary obs procedure handler */
EXPORT proc_handler_t obs_prochandler(void);

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 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 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);

/** Changes the size of the main viewport */
EXPORT void obs_resize(uint32_t cx, uint32_t cy);

/** Renders the main viewport */
EXPORT void obs_render_main_viewport(void);


/* ------------------------------------------------------------------------- */
/* Viewport context */

/**
 * Creates a viewport context.
 *
 *   A viewport can be used for things like separate previews, or drawing
 * sources separately.
 */
EXPORT obs_viewport_t obs_viewport_create(void);

/** Destroys this viewport context */
EXPORT void obs_viewport_destroy(obs_viewport_t viewport);

/** Sets the source to be used for this viewport context. */
EXPORT void obs_viewport_setsource(obs_viewport_t viewport, uint32_t channel,
		obs_source_t source);

/** Gets the source currently in use for this viewport context */
EXPORT obs_source_t obs_viewport_getsource(obs_viewport_t viewport,
		uint32_t channel);

/** Renders the sources of this viewport context */
EXPORT void obs_viewport_render(obs_viewport_t viewport);

J
jp9000 已提交
370 371 372 373 374

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

/**
375 376
 * Adds a new window display linked to the main render pipeline.  This creates
 * a new swap chain which updates every frame.
J
jp9000 已提交
377
 *
378 379
 * @param  graphics_data  The swap chain initialization data.
 * @return                The new display context, or NULL if failed.
J
jp9000 已提交
380
 */
381
EXPORT obs_display_t obs_display_create(struct gs_init_data *graphics_data);
382 383

/** Destroys a display context */
384 385
EXPORT void obs_display_destroy(obs_display_t display);

386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
/** Changes the size of this display */
EXPORT void obs_display_resize(obs_display_t display, uint32_t cx, uint32_t cy);

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

/** Removes a draw callback for this display context */
EXPORT void obs_display_remove_draw_callback(obs_display_t display,
		void (*draw)(void *param, uint32_t cx, uint32_t cy),
		void *param);
J
jp9000 已提交
405 406 407 408 409


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

J
jp9000 已提交
410
/** Returns the translated display name of a source */
411
EXPORT const char *obs_source_getdisplayname(enum obs_source_type type,
412
		const char *id, const char *locale);
413

J
jp9000 已提交
414 415 416 417
/**
 * Creates a source of the specified type with the specified settings.
 *
 *   The "source" context is used for anything related to presenting
418
 * or modifying video/audio.  Use obs_source_release to release it.
J
jp9000 已提交
419
 */
420
EXPORT obs_source_t obs_source_create(enum obs_source_type type,
421
		const char *id, const char *name, obs_data_t settings);
422 423 424 425 426

/**
 * Adds/releases a reference to a source.  When the last reference is
 * released, the source is destroyed.
 */
P
Palana 已提交
427 428
EXPORT void obs_source_addref(obs_source_t source);
EXPORT void obs_source_release(obs_source_t source);
429

P
Palana 已提交
430
/** Notifies all references that the source should be released */
431
EXPORT void obs_source_remove(obs_source_t source);
432 433 434

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

J
jp9000 已提交
436 437 438 439 440 441 442
/**
 * Retrieves flags that specify what type of data the source presents/modifies.
 *
 *   SOURCE_VIDEO if it presents/modifies video_frame
 *   SOURCE_ASYNC if the video is asynchronous.
 *   SOURCE_AUDIO if it presents/modifies audio (always async)
 */
J
jp9000 已提交
443
EXPORT uint32_t obs_source_get_output_flags(obs_source_t source);
444

J
jp9000 已提交
445 446 447 448
/** Returns the property list, if any.  Free with obs_properties_destroy */
EXPORT obs_properties_t obs_source_properties(enum obs_source_type type,
		const char *id, const char *locale);

449
/** Updates settings for this source */
450
EXPORT void obs_source_update(obs_source_t source, obs_data_t settings);
451

J
jp9000 已提交
452
/** Renders a video source. */
453 454
EXPORT void obs_source_video_render(obs_source_t source);

J
jp9000 已提交
455
/** Gets the width of a source (if it has video) */
J
jp9000 已提交
456
EXPORT uint32_t obs_source_getwidth(obs_source_t source);
457

J
jp9000 已提交
458
/** Gets the height of a source (if it has video) */
J
jp9000 已提交
459
EXPORT uint32_t obs_source_getheight(obs_source_t source);
460

461 462 463
/** If the source is a filter, returns the parent source of the filter */
EXPORT obs_source_t obs_filter_getparent(obs_source_t filter);

J
jp9000 已提交
464
/** If the source is a filter, returns the target source of the filter */
465 466
EXPORT obs_source_t obs_filter_gettarget(obs_source_t filter);

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

J
jp9000 已提交
470
/** Removes a filter from the source */
471 472
EXPORT void obs_source_filter_remove(obs_source_t source, obs_source_t filter);

J
jp9000 已提交
473
/** Modifies the order of a specific filter */
474 475
EXPORT void obs_source_filter_setorder(obs_source_t source, obs_source_t filter,
		enum order_movement movement);
J
jp9000 已提交
476 477

/** Gets the settings string for a source */
478
EXPORT obs_data_t obs_source_getsettings(obs_source_t source);
479 480 481 482 483 484 485 486

/** Gets the name of a source */
EXPORT const char *obs_source_getname(obs_source_t source);

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

/** Gets the source type and identifier */
487
EXPORT void obs_source_gettype(obs_source_t source, enum obs_source_type *type,
488
		const char **id);
J
jp9000 已提交
489

490 491 492 493 494 495
/** Returns the signal handler for a source */
EXPORT signal_handler_t obs_source_signalhandler(obs_source_t source);

/** Returns the procedure handler for a source */
EXPORT proc_handler_t obs_source_prochandler(obs_source_t source);

J
jp9000 已提交
496 497 498 499 500 501
/** Sets the volume for a source that has audio output */
EXPORT void obs_source_setvolume(obs_source_t source, float volume);

/** Gets the volume for a source that has audio output */
EXPORT float obs_source_getvolume(obs_source_t source);

J
jp9000 已提交
502 503 504 505
/* ------------------------------------------------------------------------- */
/* Functions used by sources */

/** Outputs asynchronous video data */
506
EXPORT void obs_source_output_video(obs_source_t source,
507
		const struct source_frame *frame);
508

J
jp9000 已提交
509
/** Outputs audio data (always asynchronous) */
510
EXPORT void obs_source_output_audio(obs_source_t source,
511 512 513 514 515
		const struct source_audio *audio);

/** Gets the current async video frame */
EXPORT struct source_frame *obs_source_getframe(obs_source_t source);

J
jp9000 已提交
516
/** Releases the current async video frame */
517 518
EXPORT void obs_source_releaseframe(obs_source_t source,
		struct source_frame *frame);
J
jp9000 已提交
519

520
/** Default RGB filter handler for generic effect filters */
J
jp9000 已提交
521 522
EXPORT void obs_source_process_filter(obs_source_t filter, effect_t effect,
		uint32_t width, uint32_t height, enum gs_color_format format,
523
		enum allow_direct_render allow_direct);
524

J
jp9000 已提交
525 526 527 528 529 530 531 532 533 534

/* ------------------------------------------------------------------------- */
/* 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.
 */
535
EXPORT obs_scene_t obs_scene_create(const char *name);
536

P
Palana 已提交
537 538
EXPORT void        obs_scene_addref(obs_scene_t scene);
EXPORT void        obs_scene_release(obs_scene_t scene);
539

J
jp9000 已提交
540
/** Gets the scene's source context */
541
EXPORT obs_source_t obs_scene_getsource(obs_scene_t scene);
J
jp9000 已提交
542

543 544 545
/** Gets the scene from its source, or NULL if not a scene */
EXPORT obs_scene_t obs_scene_fromsource(obs_source_t source);

546 547 548 549 550 551 552 553 554
/** Determines whether a source is within a scene */
EXPORT obs_sceneitem_t obs_scene_findsource(obs_scene_t scene,
		const char *name);

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

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

P
Palana 已提交
558 559
EXPORT void obs_sceneitem_addref(obs_sceneitem_t item);
EXPORT void obs_sceneitem_release(obs_sceneitem_t item);
560

J
jp9000 已提交
561 562 563 564
/** Removes a scene item. */
EXPORT void obs_sceneitem_remove(obs_sceneitem_t item);

/** Gets the scene parent associated with the scene item. */
J
jp9000 已提交
565 566
EXPORT obs_scene_t obs_sceneitem_getscene(obs_sceneitem_t item);

J
jp9000 已提交
567
/** Gets the source of a scene item. */
568
EXPORT obs_source_t obs_sceneitem_getsource(obs_sceneitem_t item);
J
jp9000 已提交
569 570

/* Functions for gettings/setting specific oriantation of a scene item */
571 572 573
EXPORT void obs_sceneitem_setpos(obs_sceneitem_t item, const struct vec2 *pos);
EXPORT void obs_sceneitem_setrot(obs_sceneitem_t item, float rot);
EXPORT void obs_sceneitem_setorigin(obs_sceneitem_t item,
J
jp9000 已提交
574
		const struct vec2 *origin);
575 576 577 578
EXPORT void obs_sceneitem_setscale(obs_sceneitem_t item,
		const struct vec2 *scale);
EXPORT void obs_sceneitem_setorder(obs_sceneitem_t item,
		enum order_movement movement);
J
jp9000 已提交
579

580 581 582 583
EXPORT void  obs_sceneitem_getpos(obs_sceneitem_t item, struct vec2 *pos);
EXPORT float obs_sceneitem_getrot(obs_sceneitem_t item);
EXPORT void  obs_sceneitem_getorigin(obs_sceneitem_t item, struct vec2 *center);
EXPORT void  obs_sceneitem_getscale(obs_sceneitem_t item, struct vec2 *scale);
J
jp9000 已提交
584 585 586 587 588


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

589 590 591
EXPORT const char *obs_output_getdisplayname(const char *id,
		const char *locale);

J
jp9000 已提交
592 593 594 595 596 597
/**
 * Creates an output.
 *
 *   Outputs allow outputting to file, outputting to network, outputting to
 * directshow, or other custom outputs.
 */
598
EXPORT obs_output_t obs_output_create(const char *id, const char *name,
599
		obs_data_t settings);
600 601
EXPORT void obs_output_destroy(obs_output_t output);

J
jp9000 已提交
602
/** Starts the output. */
603
EXPORT bool obs_output_start(obs_output_t output);
604

J
jp9000 已提交
605
/** Stops the output. */
606 607
EXPORT void obs_output_stop(obs_output_t output);

608 609
/** Returns whether the output is active */
EXPORT bool obs_output_active(obs_output_t output);
610

J
jp9000 已提交
611 612 613 614
/** Returns the property list, if any.  Free with obs_properties_destroy */
EXPORT obs_properties_t obs_output_properties(const char *id,
		const char *locale);

615
/** Updates the settings for this output context */
616
EXPORT void obs_output_update(obs_output_t output, obs_data_t settings);
617

J
jp9000 已提交
618
/** Specifies whether the output can be paused */
619 620
EXPORT bool obs_output_canpause(obs_output_t output);

J
jp9000 已提交
621
/** Pauses the output (if the functionality is allowed by the output */
622
EXPORT void obs_output_pause(obs_output_t output);
J
jp9000 已提交
623 624

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

627

628
/* ------------------------------------------------------------------------- */
J
jp9000 已提交
629
/* Encoders */
630 631 632 633
EXPORT const char *obs_encoder_getdisplayname(const char *id,
		const char *locale);

EXPORT obs_encoder_t obs_encoder_create(const char *id, const char *name,
634
		obs_data_t settings);
635 636
EXPORT void obs_encoder_destroy(obs_encoder_t encoder);

J
jp9000 已提交
637 638 639 640
/** Returns the property list, if any.  Free with obs_properties_destroy */
EXPORT obs_properties_t obs_output_properties(const char *id,
		const char *locale);

641
EXPORT void obs_encoder_update(obs_encoder_t encoder, obs_data_t settings);
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656

EXPORT bool obs_encoder_reset(obs_encoder_t encoder);

EXPORT bool obs_encoder_encode(obs_encoder_t encoder, void *frames,
		size_t size);
EXPORT int obs_encoder_getheader(obs_encoder_t encoder,
		struct encoder_packet **packets);

EXPORT bool obs_encoder_start(obs_encoder_t encoder,
		void (*new_packet)(void *param, struct encoder_packet *packet),
		void *param);
EXPORT bool obs_encoder_stop(obs_encoder_t encoder,
		void (*new_packet)(void *param, struct encoder_packet *packet),
		void *param);

J
jp9000 已提交
657
EXPORT bool obs_encoder_setbitrate(obs_encoder_t encoder, uint32_t bitrate,
658 659
		uint32_t buffersize);

J
jp9000 已提交
660
EXPORT bool obs_encoder_request_keyframe(obs_encoder_t encoder);
661

662
EXPORT obs_data_t obs_encoder_get_settings(obs_encoder_t encoder);
663 664


665 666
/* ------------------------------------------------------------------------- */
/* Stream Services */
667 668 669
EXPORT const char *obs_service_getdisplayname(const char *id,
		const char *locale);

670
EXPORT obs_service_t obs_service_create(const char *service,
671
		obs_data_t settings);
672 673 674
EXPORT void obs_service_destroy(obs_service_t service);


675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
/* ------------------------------------------------------------------------- */
/* Source frame allocation functions */
EXPORT void source_frame_init(struct source_frame *frame,
		enum video_format format, uint32_t width, uint32_t height);

static inline void source_frame_free(struct source_frame *frame)
{
	if (frame) {
		bfree(frame->data[0]);
		memset(frame, 0, sizeof(struct source_frame));
	}
}

static inline struct source_frame *source_frame_create(
		enum video_format format, uint32_t width, uint32_t height)
{
	struct source_frame *frame;

693
	frame = (struct source_frame*)bzalloc(sizeof(struct source_frame));
694 695 696 697 698 699 700 701 702 703 704 705 706
	source_frame_init(frame, format, width, height);
	return frame;
}

static inline void source_frame_destroy(struct source_frame *frame)
{
	if (frame) {
		bfree(frame->data[0]);
		bfree(frame);
	}
}


J
jp9000 已提交
707 708 709
#ifdef __cplusplus
}
#endif