Open Broadcaster Software
Free, open source software for live streaming and recording
obs-source.h
Go to the documentation of this file.
1 /******************************************************************************
2  Copyright (C) 2013-2014 by Hugh Bailey <obs.jim@gmail.com>
3 
4  This program is free software: you can redistribute it and/or modify
5  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
7  (at your option) any later version.
8 
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with this program. If not, see <http://www.gnu.org/licenses/>.
16 ******************************************************************************/
17 
18 #pragma once
19 
20 #include "obs.h"
21 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 
39 };
40 
45 };
46 
60 #define OBS_SOURCE_VIDEO (1<<0)
61 
69 #define OBS_SOURCE_AUDIO (1<<1)
70 
72 #define OBS_SOURCE_ASYNC (1<<2)
73 
85 #define OBS_SOURCE_ASYNC_VIDEO (OBS_SOURCE_ASYNC | OBS_SOURCE_VIDEO)
86 
93 #define OBS_SOURCE_CUSTOM_DRAW (1<<3)
94 
101 #define OBS_SOURCE_INTERACTION (1<<5)
102 
112 #define OBS_SOURCE_COMPOSITE (1<<6)
113 
121 #define OBS_SOURCE_DO_NOT_DUPLICATE (1<<7)
122 
126 #define OBS_SOURCE_DEPRECATED (1<<8)
127 
136 #define OBS_SOURCE_DO_NOT_SELF_MONITOR (1<<9)
137 
141 #define OBS_SOURCE_CAP_DISABLED (1<<10)
142 
145 typedef void (*obs_source_enum_proc_t)(obs_source_t *parent,
146  obs_source_t *child, void *param);
147 
150 };
151 
156  /* ----------------------------------------------------------------- */
157  /* Required implementation*/
158 
160  const char *id;
161 
170 
173 
180  const char *(*get_name)(void *type_data);
181 
189  void *(*create)(obs_data_t *settings, obs_source_t *source);
190 
197  void (*destroy)(void *data);
198 
201  uint32_t (*get_width)(void *data);
202 
205  uint32_t (*get_height)(void *data);
206 
207  /* ----------------------------------------------------------------- */
208  /* Optional implementation */
209 
216  void (*get_defaults)(obs_data_t *settings);
217 
224  obs_properties_t *(*get_properties)(void *data);
225 
232  void (*update)(void *data, obs_data_t *settings);
233 
235  void (*activate)(void *data);
236 
241  void (*deactivate)(void *data);
242 
244  void (*show)(void *data);
245 
247  void (*hide)(void *data);
248 
255  void (*video_tick)(void *data, float seconds);
256 
284  void (*video_render)(void *data, gs_effect_t *effect);
285 
296  struct obs_source_frame *(*filter_video)(void *data,
297  struct obs_source_frame *frame);
298 
313  struct obs_audio_data *(*filter_audio)(void *data,
314  struct obs_audio_data *audio);
315 
325  void (*enum_active_sources)(void *data,
326  obs_source_enum_proc_t enum_callback,
327  void *param);
328 
338  void (*save)(void *data, obs_data_t *settings);
339 
348  void (*load)(void *data, obs_data_t *settings);
349 
360  void (*mouse_click)(void *data,
361  const struct obs_mouse_event *event,
362  int32_t type, bool mouse_up, uint32_t click_count);
370  void (*mouse_move)(void *data,
371  const struct obs_mouse_event *event, bool mouse_leave);
372 
381  void (*mouse_wheel)(void *data,
382  const struct obs_mouse_event *event, int x_delta,
383  int y_delta);
391  void (*focus)(void *data, bool focus);
392 
401  void (*key_click)(void *data, const struct obs_key_event *event,
402  bool key_up);
403 
410  void (*filter_remove)(void *data, obs_source_t *source);
411 
415  void *type_data;
416 
420  void (*free_type_data)(void *type_data);
421 
422  bool (*audio_render)(void *data, uint64_t *ts_out,
423  struct obs_source_audio_mix *audio_output,
424  uint32_t mixers, size_t channels, size_t sample_rate);
425 
437  void (*enum_all_sources)(void *data,
438  obs_source_enum_proc_t enum_callback,
439  void *param);
440 
441  void (*transition_start)(void *data);
442  void (*transition_stop)(void *data);
443 
450  void (*get_defaults2)(void *type_data, obs_data_t *settings);
451 
459  obs_properties_t *(*get_properties2)(void *data, void *type_data);
460 };
461 
462 EXPORT void obs_register_source_s(const struct obs_source_info *info,
463  size_t size);
464 
471 #define obs_register_source(info) \
472  obs_register_source_s(info, sizeof(struct obs_source_info))
473 
474 #ifdef __cplusplus
475 }
476 #endif
Definition: obs-interaction.h:50
Definition: obs-source.h:42
obs_balance_type
Definition: obs-source.h:41
void(* filter_remove)(void *data, obs_source_t *source)
Definition: obs-source.h:410
void(* enum_active_sources)(void *data, obs_source_enum_proc_t enum_callback, void *param)
Definition: obs-source.h:325
void(* mouse_move)(void *data, const struct obs_mouse_event *event, bool mouse_leave)
Definition: obs-source.h:370
void(* update)(void *data, obs_data_t *settings)
Definition: obs-source.h:232
uint32_t(* get_height)(void *data)
Definition: obs-source.h:205
void(* get_defaults2)(void *type_data, obs_data_t *settings)
Definition: obs-source.h:450
bool(* audio_render)(void *data, uint64_t *ts_out, struct obs_source_audio_mix *audio_output, uint32_t mixers, size_t channels, size_t sample_rate)
Definition: obs-source.h:422
unsigned uint32_t
Definition: vc_stdint.h:31
void(* get_defaults)(obs_data_t *settings)
Definition: obs-source.h:216
Definition: obs-interaction.h:44
void(* obs_source_enum_proc_t)(obs_source_t *parent, obs_source_t *child, void *param)
Definition: obs-source.h:145
Definition: obs-internal.h:568
int int32_t
Definition: vc_stdint.h:30
uint32_t output_flags
Definition: obs-source.h:172
enum obs_source_type type
Definition: obs-source.h:169
Definition: audio-io.h:84
void(* load)(void *data, obs_data_t *settings)
Definition: obs-source.h:348
const char * id
Definition: obs-source.h:160
unsigned __int64 uint64_t
Definition: vc_stdint.h:33
Definition: obs-source.h:35
void(* deactivate)(void *data)
Definition: obs-source.h:241
void(* free_type_data)(void *type_data)
Definition: obs-source.h:420
Definition: obs-source.h:44
void(* mouse_click)(void *data, const struct obs_mouse_event *event, int32_t type, bool mouse_up, uint32_t click_count)
Definition: obs-source.h:360
struct obs_data obs_data_t
Definition: obs-data.h:42
Definition: obs-source.h:155
void(* destroy)(void *data)
Definition: obs-source.h:197
uint8_t * data[MAX_AV_PLANES]
Definition: obs.h:195
void * type_data
Definition: obs-source.h:415
struct audio_output_data output[MAX_AUDIO_MIXES]
Definition: obs-source.h:149
struct obs_properties obs_properties_t
Definition: obs-properties.h:103
void(* key_click)(void *data, const struct obs_key_event *event, bool key_up)
Definition: obs-source.h:401
#define EXPORT
Definition: c99defs.h:49
obs_source_type
Definition: obs-source.h:34
uint8_t * data[MAX_AV_PLANES]
Definition: obs.h:225
#define MAX_AUDIO_MIXES
Definition: audio-io.h:28
void(* video_render)(void *data, gs_effect_t *effect)
Definition: obs-source.h:284
Definition: effect.h:150
Definition: obs-source.h:38
Definition: obs-source.h:37
void(* mouse_wheel)(void *data, const struct obs_mouse_event *event, int x_delta, int y_delta)
Definition: obs-source.h:381
void(* focus)(void *data, bool focus)
Definition: obs-source.h:391
Definition: obs.h:224
uint32_t(* get_width)(void *data)
Definition: obs-source.h:201
void(* transition_start)(void *data)
Definition: obs-source.h:441
Definition: obs-source.h:36
Definition: obs-source.h:148
void(* save)(void *data, obs_data_t *settings)
Definition: obs-source.h:338
void(* activate)(void *data)
Definition: obs-source.h:235
void(* show)(void *data)
Definition: obs-source.h:244
void(* enum_all_sources)(void *data, obs_source_enum_proc_t enum_callback, void *param)
Definition: obs-source.h:437
void(* video_tick)(void *data, float seconds)
Definition: obs-source.h:255
void(* transition_stop)(void *data)
Definition: obs-source.h:442
Main libobs header used by applications.
EXPORT void obs_register_source_s(const struct obs_source_info *info, size_t size)
#define bool
Definition: vc_stdbool.h:5
void(* hide)(void *data)
Definition: obs-source.h:247
Definition: obs.h:194
Definition: obs-source.h:43