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 
135 typedef void (*obs_source_enum_proc_t)(obs_source_t *parent,
136  obs_source_t *child, void *param);
137 
140 };
141 
146  /* ----------------------------------------------------------------- */
147  /* Required implementation*/
148 
150  const char *id;
151 
159  enum obs_source_type type;
160 
163 
170  const char *(*get_name)(void *type_data);
171 
179  void *(*create)(obs_data_t *settings, obs_source_t *source);
180 
187  void (*destroy)(void *data);
188 
191  uint32_t (*get_width)(void *data);
192 
195  uint32_t (*get_height)(void *data);
196 
197  /* ----------------------------------------------------------------- */
198  /* Optional implementation */
199 
205  void (*get_defaults)(obs_data_t *settings);
206 
212  obs_properties_t *(*get_properties)(void *data);
213 
220  void (*update)(void *data, obs_data_t *settings);
221 
223  void (*activate)(void *data);
224 
229  void (*deactivate)(void *data);
230 
232  void (*show)(void *data);
233 
235  void (*hide)(void *data);
236 
243  void (*video_tick)(void *data, float seconds);
244 
272  void (*video_render)(void *data, gs_effect_t *effect);
273 
284  struct obs_source_frame *(*filter_video)(void *data,
285  struct obs_source_frame *frame);
286 
301  struct obs_audio_data *(*filter_audio)(void *data,
302  struct obs_audio_data *audio);
303 
313  void (*enum_active_sources)(void *data,
314  obs_source_enum_proc_t enum_callback,
315  void *param);
316 
326  void (*save)(void *data, obs_data_t *settings);
327 
336  void (*load)(void *data, obs_data_t *settings);
337 
348  void (*mouse_click)(void *data,
349  const struct obs_mouse_event *event,
350  int32_t type, bool mouse_up, uint32_t click_count);
358  void (*mouse_move)(void *data,
359  const struct obs_mouse_event *event, bool mouse_leave);
360 
369  void (*mouse_wheel)(void *data,
370  const struct obs_mouse_event *event, int x_delta,
371  int y_delta);
379  void (*focus)(void *data, bool focus);
380 
389  void (*key_click)(void *data, const struct obs_key_event *event,
390  bool key_up);
391 
398  void (*filter_remove)(void *data, obs_source_t *source);
399 
403  void *type_data;
404 
408  void (*free_type_data)(void *type_data);
409 
410  bool (*audio_render)(void *data, uint64_t *ts_out,
411  struct obs_source_audio_mix *audio_output,
412  uint32_t mixers, size_t channels, size_t sample_rate);
413 
425  void (*enum_all_sources)(void *data,
426  obs_source_enum_proc_t enum_callback,
427  void *param);
428 
429  void (*transition_start)(void *data);
430  void (*transition_stop)(void *data);
431 };
432 
433 EXPORT void obs_register_source_s(const struct obs_source_info *info,
434  size_t size);
435 
442 #define obs_register_source(info) \
443  obs_register_source_s(info, sizeof(struct obs_source_info))
444 
445 #ifdef __cplusplus
446 }
447 #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:135
Definition: obs-internal.h:525
int int32_t
Definition: vc_stdint.h:30
uint32_t output_flags
Definition: obs-source.h:162
Definition: audio-io.h:74
const char * id
Definition: obs-source.h:150
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:145
uint8_t * data[MAX_AV_PLANES]
Definition: obs.h:192
void * type_data
Definition: obs-source.h:403
struct audio_output_data output[MAX_AUDIO_MIXES]
Definition: obs-source.h:139
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:222
#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:379
Definition: obs.h:221
Definition: obs-source.h:36
Definition: obs-source.h:138
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:191