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 
41 
55 #define OBS_SOURCE_VIDEO (1<<0)
56 
64 #define OBS_SOURCE_AUDIO (1<<1)
65 
67 #define OBS_SOURCE_ASYNC (1<<2)
68 
80 #define OBS_SOURCE_ASYNC_VIDEO (OBS_SOURCE_ASYNC | OBS_SOURCE_VIDEO)
81 
88 #define OBS_SOURCE_CUSTOM_DRAW (1<<3)
89 
96 #define OBS_SOURCE_INTERACTION (1<<5)
97 
107 #define OBS_SOURCE_COMPOSITE (1<<6)
108 
116 #define OBS_SOURCE_DO_NOT_DUPLICATE (1<<7)
117 
121 #define OBS_SOURCE_DEPRECATED (1<<8)
122 
131 #define OBS_SOURCE_DO_NOT_SELF_MONITOR (1<<9)
132 
136 #define OBS_SOURCE_CAP_DISABLED (1<<10)
137 
140 typedef void (*obs_source_enum_proc_t)(obs_source_t *parent,
141  obs_source_t *child, void *param);
142 
145 };
146 
151  /* ----------------------------------------------------------------- */
152  /* Required implementation*/
153 
155  const char *id;
156 
164  enum obs_source_type type;
165 
168 
175  const char *(*get_name)(void *type_data);
176 
184  void *(*create)(obs_data_t *settings, obs_source_t *source);
185 
192  void (*destroy)(void *data);
193 
196  uint32_t (*get_width)(void *data);
197 
200  uint32_t (*get_height)(void *data);
201 
202  /* ----------------------------------------------------------------- */
203  /* Optional implementation */
204 
211  void (*get_defaults)(obs_data_t *settings);
212 
219  obs_properties_t *(*get_properties)(void *data);
220 
227  void (*update)(void *data, obs_data_t *settings);
228 
230  void (*activate)(void *data);
231 
236  void (*deactivate)(void *data);
237 
239  void (*show)(void *data);
240 
242  void (*hide)(void *data);
243 
250  void (*video_tick)(void *data, float seconds);
251 
279  void (*video_render)(void *data, gs_effect_t *effect);
280 
291  struct obs_source_frame *(*filter_video)(void *data,
292  struct obs_source_frame *frame);
293 
308  struct obs_audio_data *(*filter_audio)(void *data,
309  struct obs_audio_data *audio);
310 
320  void (*enum_active_sources)(void *data,
321  obs_source_enum_proc_t enum_callback,
322  void *param);
323 
333  void (*save)(void *data, obs_data_t *settings);
334 
343  void (*load)(void *data, obs_data_t *settings);
344 
355  void (*mouse_click)(void *data,
356  const struct obs_mouse_event *event,
357  int32_t type, bool mouse_up, uint32_t click_count);
365  void (*mouse_move)(void *data,
366  const struct obs_mouse_event *event, bool mouse_leave);
367 
376  void (*mouse_wheel)(void *data,
377  const struct obs_mouse_event *event, int x_delta,
378  int y_delta);
386  void (*focus)(void *data, bool focus);
387 
396  void (*key_click)(void *data, const struct obs_key_event *event,
397  bool key_up);
398 
405  void (*filter_remove)(void *data, obs_source_t *source);
406 
410  void *type_data;
411 
415  void (*free_type_data)(void *type_data);
416 
417  bool (*audio_render)(void *data, uint64_t *ts_out,
418  struct obs_source_audio_mix *audio_output,
419  uint32_t mixers, size_t channels, size_t sample_rate);
420 
432  void (*enum_all_sources)(void *data,
433  obs_source_enum_proc_t enum_callback,
434  void *param);
435 
436  void (*transition_start)(void *data);
437  void (*transition_stop)(void *data);
438 
445  void (*get_defaults2)(void *type_data, obs_data_t *settings);
446 
454  obs_properties_t *(*get_properties2)(void *data, void *type_data);
455 };
456 
457 EXPORT void obs_register_source_s(const struct obs_source_info *info,
458  size_t size);
459 
466 #define obs_register_source(info) \
467  obs_register_source_s(info, sizeof(struct obs_source_info))
468 
469 #ifdef __cplusplus
470 }
471 #endif
Definition: obs-interaction.h:50
unsigned uint32_t
Definition: vc_stdint.h:31
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:140
Definition: obs-internal.h:541
int int32_t
Definition: vc_stdint.h:30
uint32_t output_flags
Definition: obs-source.h:167
Definition: audio-io.h:84
const char * id
Definition: obs-source.h:155
unsigned __int64 uint64_t
Definition: vc_stdint.h:33
Definition: obs-source.h:35
struct obs_data obs_data_t
Definition: obs-data.h:42
Definition: obs-source.h:150
uint8_t * data[MAX_AV_PLANES]
Definition: obs.h:194
void * type_data
Definition: obs-source.h:410
struct audio_output_data output[MAX_AUDIO_MIXES]
Definition: obs-source.h:144
struct obs_properties obs_properties_t
Definition: obs-properties.h:103
#define EXPORT
Definition: c99defs.h:49
obs_source_type
Definition: obs-source.h:34
uint8_t * data[MAX_AV_PLANES]
Definition: obs.h:224
#define MAX_AUDIO_MIXES
Definition: audio-io.h:28
Definition: effect.h:139
Definition: obs-source.h:38
Definition: obs-source.h:37
void(* focus)(void *data, bool focus)
Definition: obs-source.h:386
Definition: obs.h:223
Definition: obs-source.h:36
Definition: obs-source.h:143
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
Definition: obs.h:193