Open Broadcaster Software
Free, open source software for live streaming and recording
obs-internal.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 "util/c99defs.h"
21 #include "util/darray.h"
22 #include "util/circlebuf.h"
23 #include "util/dstr.h"
24 #include "util/threading.h"
25 #include "util/platform.h"
26 #include "util/profiler.h"
27 #include "callback/signal.h"
28 #include "callback/proc.h"
29 
30 #include "graphics/graphics.h"
31 #include "graphics/matrix4.h"
32 
34 #include "media-io/video-io.h"
35 #include "media-io/audio-io.h"
36 
37 #include "obs.h"
38 
39 #define NUM_TEXTURES 2
40 #define MICROSECOND_DEN 1000000
41 
42 static inline int64_t packet_dts_usec(struct encoder_packet *packet)
43 {
44  return packet->dts * MICROSECOND_DEN / packet->timebase_den;
45 }
46 
47 struct draw_callback {
48  void (*draw)(void *param, uint32_t cx, uint32_t cy);
49  void *param;
50 };
51 
52 /* ------------------------------------------------------------------------- */
53 /* validity checks */
54 
55 static inline bool obs_object_valid(const void *obj, const char *f,
56  const char *t)
57 {
58  if (!obj) {
59  blog(LOG_DEBUG, "%s: Null '%s' parameter", f, t);
60  return false;
61  }
62 
63  return true;
64 }
65 
66 #define obs_ptr_valid(ptr, func) obs_object_valid(ptr, func, #ptr)
67 #define obs_source_valid obs_ptr_valid
68 #define obs_output_valid obs_ptr_valid
69 #define obs_encoder_valid obs_ptr_valid
70 #define obs_service_valid obs_ptr_valid
71 
72 /* ------------------------------------------------------------------------- */
73 /* modules */
74 
75 struct obs_module {
76  char *mod_name;
77  const char *file;
78  char *bin_path;
79  char *data_path;
80  void *module;
81  bool loaded;
82 
83  bool (*load)(void);
84  void (*unload)(void);
85  void (*set_locale)(const char *locale);
86  void (*free_locale)(void);
87  uint32_t (*ver)(void);
88  void (*set_pointer)(obs_module_t *module);
89  const char *(*name)(void);
90  const char *(*description)(void);
91  const char *(*author)(void);
92 
93  struct obs_module *next;
94 };
95 
96 extern void free_module(struct obs_module *mod);
97 
99  char *bin;
100  char *data;
101 };
102 
103 static inline void free_module_path(struct obs_module_path *omp)
104 {
105  if (omp) {
106  bfree(omp->bin);
107  bfree(omp->data);
108  }
109 }
110 
111 static inline bool check_path(const char *data, const char *path,
112  struct dstr *output)
113 {
114  dstr_copy(output, path);
115  dstr_cat(output, data);
116 
117  return os_file_exists(output->array);
118 }
119 
120 
121 /* ------------------------------------------------------------------------- */
122 /* hotkeys */
123 
124 struct obs_hotkey {
126  char *name;
127  char *description;
128 
130  void *data;
131  int pressed;
132 
134  void *registerer;
135 
137 };
138 
143  bool pressed0 : 1;
144  bool pressed1 : 1;
145  void *data[2];
146 };
147 
149 
150 typedef struct obs_hotkeys_platform obs_hotkeys_platform_t;
151 
152 void *obs_hotkey_thread(void *param);
153 
154 struct obs_core_hotkeys;
155 bool obs_hotkeys_platform_init(struct obs_core_hotkeys *hotkeys);
156 void obs_hotkeys_platform_free(struct obs_core_hotkeys *hotkeys);
158  obs_key_t key);
159 
160 const char *obs_get_hotkey_translation(obs_key_t key, const char *def);
161 
162 struct obs_context_data;
163 void obs_hotkeys_context_release(struct obs_context_data *context);
164 
165 void obs_hotkeys_free(void);
166 
169  bool pressed : 1;
170  bool modifiers_match : 1;
171 
174 };
175 
176 struct obs_hotkey_name_map;
177 void obs_hotkey_name_map_free(void);
178 
179 
180 /* ------------------------------------------------------------------------- */
181 /* views */
182 
183 struct obs_view {
184  pthread_mutex_t channels_mutex;
186 };
187 
188 extern bool obs_view_init(struct obs_view *view);
189 extern void obs_view_free(struct obs_view *view);
190 
191 
192 /* ------------------------------------------------------------------------- */
193 /* displays */
194 
195 struct obs_display {
197  bool enabled;
201  pthread_mutex_t draw_callbacks_mutex;
202  DARRAY(struct draw_callback) draw_callbacks;
203 
204  struct obs_display *next;
205  struct obs_display **prev_next;
206 };
207 
208 extern bool obs_display_init(struct obs_display *display,
209  const struct gs_init_data *graphics_data);
210 extern void obs_display_free(struct obs_display *display);
211 
212 
213 /* ------------------------------------------------------------------------- */
214 /* core */
215 
218  int count;
219 };
220 
223  gs_stagesurf_t *copy_surfaces[NUM_TEXTURES];
224  gs_texture_t *render_textures[NUM_TEXTURES];
225  gs_texture_t *output_textures[NUM_TEXTURES];
226  gs_texture_t *convert_textures[NUM_TEXTURES];
227  bool textures_rendered[NUM_TEXTURES];
228  bool textures_output[NUM_TEXTURES];
229  bool textures_copied[NUM_TEXTURES];
230  bool textures_converted[NUM_TEXTURES];
231  struct circlebuf vframe_info_buffer;
244 
246  double video_fps;
248  pthread_t video_thread;
252 
254  const char *conversion_tech;
256  uint32_t plane_offsets[3];
257  uint32_t plane_sizes[3];
258  uint32_t plane_linewidth[3];
259 
264  float color_matrix[16];
265  enum obs_scale_type scale_type;
266 
268 
277 };
278 
280  /* TODO: sound output subsystem */
282 
283  DARRAY(struct obs_source*) render_order;
284  DARRAY(struct obs_source*) root_nodes;
285 
286  uint64_t buffered_ts;
287  struct circlebuf buffered_timestamps;
288  int buffering_wait_ticks;
289  int total_buffering_ticks;
290 
291  float user_volume;
292 };
293 
294 /* user sources, output channels, and displays */
302 
303  pthread_mutex_t sources_mutex;
304  pthread_mutex_t displays_mutex;
305  pthread_mutex_t outputs_mutex;
306  pthread_mutex_t encoders_mutex;
307  pthread_mutex_t services_mutex;
308  pthread_mutex_t audio_sources_mutex;
309 
310  struct obs_view main_view;
311 
312  long long unnamed_index;
313 
314  volatile bool valid;
315 };
316 
317 /* user hotkeys */
319  pthread_mutex_t mutex;
320  DARRAY(obs_hotkey_t) hotkeys;
321  obs_hotkey_id next_id;
322  DARRAY(obs_hotkey_pair_t) hotkey_pairs;
323  obs_hotkey_pair_id next_pair_id;
324 
325  pthread_t hotkey_thread;
326  bool hotkey_thread_initialized;
327  os_event_t *stop_event;
328  bool thread_disable_press : 1;
329  bool strict_modifiers : 1;
330  bool reroute_hotkeys : 1;
331  DARRAY(obs_hotkey_binding_t) bindings;
332 
334  void *router_func_data;
335 
336  obs_hotkeys_platform_t *platform_context;
337 
338  pthread_once_t name_map_init_token;
339  struct obs_hotkey_name_map *name_map;
340 
342 
343  char *translations[OBS_KEY_LAST_VALUE];
344  char *mute;
345  char *unmute;
346  char *push_to_mute;
347  char *push_to_talk;
348  char *sceneitem_show;
349  char *sceneitem_hide;
350 };
351 
352 struct obs_core {
354  DARRAY(struct obs_module_path) module_paths;
355 
356  DARRAY(struct obs_source_info) source_types;
357  DARRAY(struct obs_source_info) input_types;
358  DARRAY(struct obs_source_info) filter_types;
359  DARRAY(struct obs_source_info) transition_types;
360  DARRAY(struct obs_output_info) output_types;
361  DARRAY(struct obs_encoder_info) encoder_types;
362  DARRAY(struct obs_service_info) service_types;
363  DARRAY(struct obs_modal_ui) modal_ui_callbacks;
364  DARRAY(struct obs_modeless_ui) modeless_ui_callbacks;
365 
368 
369  char *locale;
370  char *module_config_path;
371  bool name_store_owned;
373 
374  /* segmented into multiple sub-structures to keep things a bit more
375  * clean and organized */
376  struct obs_core_video video;
377  struct obs_core_audio audio;
378  struct obs_core_data data;
379  struct obs_core_hotkeys hotkeys;
380 };
381 
382 extern struct obs_core *obs;
383 
384 extern void *obs_video_thread(void *param);
385 
386 extern gs_effect_t *obs_load_effect(gs_effect_t **effect, const char *file);
387 
388 extern bool audio_callback(void *param,
389  uint64_t start_ts_in, uint64_t end_ts_in, uint64_t *out_ts,
390  uint32_t mixers, struct audio_output_data *mixes);
391 
392 
393 /* ------------------------------------------------------------------------- */
394 /* obs shared context data */
395 
397  char *name;
398  void *data;
402  enum obs_obj_type type;
403 
404  DARRAY(obs_hotkey_id) hotkeys;
405  DARRAY(obs_hotkey_pair_id) hotkey_pairs;
406  obs_data_t *hotkey_data;
407 
408  DARRAY(char*) rename_cache;
409  pthread_mutex_t rename_cache_mutex;
410 
411  pthread_mutex_t *mutex;
412  struct obs_context_data *next;
413  struct obs_context_data **prev_next;
414 
415  bool private;
416 };
417 
418 extern bool obs_context_data_init(
419  struct obs_context_data *context,
420  enum obs_obj_type type,
421  obs_data_t *settings,
422  const char *name,
423  obs_data_t *hotkey_data,
424  bool private);
425 extern void obs_context_data_free(struct obs_context_data *context);
426 
427 extern void obs_context_data_insert(struct obs_context_data *context,
428  pthread_mutex_t *mutex, void *first);
429 extern void obs_context_data_remove(struct obs_context_data *context);
430 
431 extern void obs_context_data_setname(struct obs_context_data *context,
432  const char *name);
433 
434 
435 /* ------------------------------------------------------------------------- */
436 /* ref-counting */
437 
438 struct obs_weak_ref {
439  volatile long refs;
440  volatile long weak_refs;
441 };
442 
443 static inline void obs_ref_addref(struct obs_weak_ref *ref)
444 {
445  os_atomic_inc_long(&ref->refs);
446 }
447 
448 static inline bool obs_ref_release(struct obs_weak_ref *ref)
449 {
450  return os_atomic_dec_long(&ref->refs) == -1;
451 }
452 
453 static inline void obs_weak_ref_addref(struct obs_weak_ref *ref)
454 {
455  os_atomic_inc_long(&ref->weak_refs);
456 }
457 
458 static inline bool obs_weak_ref_release(struct obs_weak_ref *ref)
459 {
460  return os_atomic_dec_long(&ref->weak_refs) == -1;
461 }
462 
463 static inline bool obs_weak_ref_get_ref(struct obs_weak_ref *ref)
464 {
465  long owners = ref->refs;
466  while (owners > -1) {
467  if (os_atomic_compare_swap_long(&ref->refs, owners, owners + 1))
468  return true;
469 
470  owners = ref->refs;
471  }
472 
473  return false;
474 }
475 
476 
477 /* ------------------------------------------------------------------------- */
478 /* sources */
479 
480 struct async_frame {
483  bool used;
484 };
485 
491 };
492 
493 struct audio_action {
495  enum audio_action_type type;
496  union {
497  float vol;
498  bool set;
499  };
500 };
501 
503  struct obs_weak_ref ref;
505 };
506 
509  void *param;
510 };
511 
512 struct obs_source {
513  struct obs_context_data context;
514  struct obs_source_info info;
516 
517  /* general exposed flags that can be set for the source */
520 
521  /* indicates ownership of the info.id buffer */
523 
524  /* signals to call the source update in the video thread */
526 
527  /* ensures show/hide are only called once */
528  volatile long show_refs;
529 
530  /* ensures activate/deactivate are only called once */
531  volatile long activate_refs;
532 
533  /* used to indicate that the source has been removed and all
534  * references to it should be released (not exactly how I would prefer
535  * to handle things but it's the best option) */
536  bool removed;
537 
538  bool active;
539  bool showing;
540 
541  /* used to temporarily disable sources if needed */
542  bool enabled;
543 
544  /* timing (if video is present, is based upon video) */
545  volatile bool timing_set;
553 
554  /* audio */
558  bool muted;
562  struct circlebuf audio_input_buf[MAX_AUDIO_CHANNELS];
564  DARRAY(struct audio_action) audio_actions;
565  float *audio_output_buf[MAX_AUDIO_MIXES][MAX_AUDIO_CHANNELS];
566  struct resample_info sample_info;
567  audio_resampler_t *resampler;
568  pthread_mutex_t audio_actions_mutex;
569  pthread_mutex_t audio_buf_mutex;
570  pthread_mutex_t audio_mutex;
571  pthread_mutex_t audio_cb_mutex;
572  DARRAY(struct audio_cb_info) audio_cb_list;
574  size_t audio_storage_size;
575  uint32_t audio_mixers;
576  float user_volume;
577  float volume;
578  int64_t sync_offset;
579  int64_t last_sync_offset;
580 
581  /* async video data */
582  gs_texture_t *async_texture;
583  gs_texrender_t *async_texrender;
584  struct obs_source_frame *cur_async_frame;
585  bool async_gpu_conversion;
586  enum video_format async_format;
587  enum video_format async_cache_format;
588  enum gs_color_format async_texture_format;
589  float async_color_matrix[16];
590  bool async_full_range;
591  float async_color_range_min[3];
592  float async_color_range_max[3];
593  int async_plane_offset[2];
594  bool async_flip;
595  bool async_active;
596  DARRAY(struct async_frame) async_cache;
597  DARRAY(struct obs_source_frame*)async_frames;
598  pthread_mutex_t async_mutex;
599  uint32_t async_width;
600  uint32_t async_height;
601  uint32_t async_cache_width;
602  uint32_t async_cache_height;
603  uint32_t async_convert_width;
604  uint32_t async_convert_height;
605 
606  /* async video deinterlacing */
607  uint64_t deinterlace_offset;
608  uint64_t deinterlace_frame_ts;
609  gs_effect_t *deinterlace_effect;
610  struct obs_source_frame *prev_async_frame;
611  gs_texture_t *async_prev_texture;
612  gs_texrender_t *async_prev_texrender;
613  uint32_t deinterlace_half_duration;
614  enum obs_deinterlace_mode deinterlace_mode;
615  bool deinterlace_top_first;
616  bool deinterlace_rendered;
617 
618  /* filters */
619  struct obs_source *filter_parent;
620  struct obs_source *filter_target;
621  DARRAY(struct obs_source*) filters;
622  pthread_mutex_t filter_mutex;
623  gs_texrender_t *filter_texrender;
624  enum obs_allow_direct_render allow_direct;
625  bool rendering_filter;
626 
627  /* sources specific hotkeys */
628  obs_hotkey_pair_id mute_unmute_key;
629  obs_hotkey_id push_to_mute_key;
630  obs_hotkey_id push_to_talk_key;
631  bool push_to_mute_enabled : 1;
632  bool push_to_mute_pressed : 1;
633  bool user_push_to_mute_pressed : 1;
634  bool push_to_talk_enabled : 1;
635  bool push_to_talk_pressed : 1;
636  bool user_push_to_talk_pressed : 1;
637  uint64_t push_to_mute_delay;
638  uint64_t push_to_mute_stop_time;
639  uint64_t push_to_talk_delay;
640  uint64_t push_to_talk_stop_time;
641 
642  /* transitions */
643  uint64_t transition_start_time;
644  uint64_t transition_duration;
645  pthread_mutex_t transition_tex_mutex;
646  gs_texrender_t *transition_texrender[2];
647  pthread_mutex_t transition_mutex;
648  obs_source_t *transition_sources[2];
649  bool transitioning_video;
650  bool transitioning_audio;
651  bool transition_source_active[2];
652  uint32_t transition_alignment;
653  uint32_t transition_actual_cx;
654  uint32_t transition_actual_cy;
655  uint32_t transition_cx;
656  uint32_t transition_cy;
657  uint32_t transition_fixed_duration;
658  bool transition_use_fixed_duration : 1;
659  enum obs_transition_mode transition_mode;
660  enum obs_transition_scale_type transition_scale_type;
661  struct matrix4 transition_matrices[2];
662 };
663 
664 extern const struct obs_source_info *get_source_info(const char *id);
665 extern bool obs_source_init_context(struct obs_source *source,
666  obs_data_t *settings, const char *name,
667  obs_data_t *hotkey_data, bool private);
668 
669 extern void obs_source_save(obs_source_t *source);
670 extern void obs_source_load(obs_source_t *source);
671 
672 extern bool obs_transition_init(obs_source_t *transition);
673 extern void obs_transition_free(obs_source_t *transition);
674 extern void obs_transition_tick(obs_source_t *transition);
675 extern void obs_transition_enum_sources(obs_source_t *transition,
676  obs_source_enum_proc_t enum_callback, void *param);
677 extern void obs_transition_save(obs_source_t *source, obs_data_t *data);
678 extern void obs_transition_load(obs_source_t *source, obs_data_t *data);
679 
680 extern void obs_source_destroy(struct obs_source *source);
681 
682 enum view_type {
685 };
686 
687 static inline void obs_source_dosignal(struct obs_source *source,
688  const char *signal_obs, const char *signal_source)
689 {
690  struct calldata data;
691  uint8_t stack[128];
692 
693  calldata_init_fixed(&data, stack, sizeof(stack));
694  calldata_set_ptr(&data, "source", source);
695  if (signal_obs && !source->context.private)
696  signal_handler_signal(obs->signals, signal_obs, &data);
697  if (signal_source)
698  signal_handler_signal(source->context.signals, signal_source,
699  &data);
700 }
701 
702 /* maximum timestamp variance in nanoseconds */
703 #define MAX_TS_VAR 2000000000ULL
704 
705 static inline bool frame_out_of_bounds(const obs_source_t *source, uint64_t ts)
706 {
707  if (ts < source->last_frame_ts)
708  return ((source->last_frame_ts - ts) > MAX_TS_VAR);
709  else
710  return ((ts - source->last_frame_ts) > MAX_TS_VAR);
711 }
712 
713 static inline enum gs_color_format convert_video_format(
714  enum video_format format)
715 {
716  if (format == VIDEO_FORMAT_RGBA)
717  return GS_RGBA;
718  else if (format == VIDEO_FORMAT_BGRA)
719  return GS_BGRA;
720  else if (format == VIDEO_FORMAT_Y800)
721  return GS_R8;
722 
723  return GS_BGRX;
724 }
725 
726 extern void obs_source_activate(obs_source_t *source, enum view_type type);
727 extern void obs_source_deactivate(obs_source_t *source, enum view_type type);
728 extern void obs_source_video_tick(obs_source_t *source, float seconds);
729 extern float obs_source_get_target_volume(obs_source_t *source,
730  obs_source_t *target);
731 
732 extern void obs_source_audio_render(obs_source_t *source, uint32_t mixers,
733  size_t channels, size_t sample_rate, size_t size);
734 
735 extern void add_alignment(struct vec2 *v, uint32_t align, int cx, int cy);
736 
737 extern struct obs_source_frame *filter_async_video(obs_source_t *source,
738  struct obs_source_frame *in);
739 extern bool update_async_texture(struct obs_source *source,
740  const struct obs_source_frame *frame,
741  gs_texture_t *tex, gs_texrender_t *texrender);
742 extern bool set_async_texture_size(struct obs_source *source,
743  const struct obs_source_frame *frame);
744 extern void remove_async_frame(obs_source_t *source,
745  struct obs_source_frame *frame);
746 
747 extern void set_deinterlace_texture_size(obs_source_t *source);
748 extern void deinterlace_process_last_frame(obs_source_t *source,
749  uint64_t sys_time);
750 extern void deinterlace_update_async_video(obs_source_t *source);
751 extern void deinterlace_render(obs_source_t *s);
752 
753 
754 /* ------------------------------------------------------------------------- */
755 /* outputs */
756 
757 enum delay_msg {
761 };
762 
763 struct delay_data {
764  enum delay_msg msg;
766  struct encoder_packet packet;
767 };
768 
769 typedef void (*encoded_callback_t)(void *data, struct encoder_packet *packet);
770 
772  struct obs_weak_ref ref;
774 };
775 
776 struct obs_output {
777  struct obs_context_data context;
778  struct obs_output_info info;
780 
781  /* indicates ownership of the info.id buffer */
783 
786  volatile bool data_active;
789  int64_t audio_offsets[MAX_AUDIO_MIXES];
794  pthread_mutex_t interleaved_mutex;
795  DARRAY(struct encoder_packet) interleaved_packets;
796  int stop_code;
797 
798  int reconnect_retry_sec;
799  int reconnect_retry_max;
800  int reconnect_retries;
801  int reconnect_retry_cur_sec;
802  pthread_t reconnect_thread;
803  os_event_t *reconnect_stop_event;
804  volatile bool reconnecting;
805  volatile bool reconnect_thread_active;
806 
807  uint32_t starting_drawn_count;
808  uint32_t starting_lagged_count;
809  uint32_t starting_frame_count;
810  uint32_t starting_skipped_frame_count;
811 
812  int total_frames;
813 
814  volatile bool active;
815  video_t *video;
816  audio_t *audio;
817  obs_encoder_t *video_encoder;
818  obs_encoder_t *audio_encoders[MAX_AUDIO_MIXES];
819  obs_service_t *service;
820  size_t mixer_idx;
821 
822  uint32_t scaled_width;
823  uint32_t scaled_height;
824 
825  bool video_conversion_set;
826  bool audio_conversion_set;
827  struct video_scale_info video_conversion;
828  struct audio_convert_info audio_conversion;
829 
830  bool valid;
831 
832  uint64_t active_delay_ns;
833  encoded_callback_t delay_callback;
834  struct circlebuf delay_data; /* struct delay_data */
835  pthread_mutex_t delay_mutex;
836  uint32_t delay_sec;
837  uint32_t delay_flags;
838  uint32_t delay_cur_flags;
839  volatile long delay_restart_refs;
840  volatile bool delay_active;
841  volatile bool delay_capturing;
842 };
843 
844 static inline void do_output_signal(struct obs_output *output,
845  const char *signal)
846 {
847  struct calldata params = {0};
848  calldata_set_ptr(&params, "output", output);
849  signal_handler_signal(output->context.signals, signal, &params);
850  calldata_free(&params);
851 }
852 
853 extern void process_delay(void *data, struct encoder_packet *packet);
854 extern void obs_output_cleanup_delay(obs_output_t *output);
855 extern bool obs_output_delay_start(obs_output_t *output);
856 extern void obs_output_delay_stop(obs_output_t *output);
857 extern bool obs_output_actual_start(obs_output_t *output);
858 extern void obs_output_actual_stop(obs_output_t *output, bool force,
859  uint64_t ts);
860 
861 extern const struct obs_output_info *find_output(const char *id);
862 
863 extern void obs_output_remove_encoder(struct obs_output *output,
864  struct obs_encoder *encoder);
865 
866 void obs_output_destroy(obs_output_t *output);
867 
868 
869 /* ------------------------------------------------------------------------- */
870 /* encoders */
871 
873  struct obs_weak_ref ref;
875 };
876 
879  void (*new_packet)(void *param, struct encoder_packet *packet);
880  void *param;
881 };
882 
883 struct obs_encoder {
884  struct obs_context_data context;
885  struct obs_encoder_info info;
887 
888  pthread_mutex_t init_mutex;
889 
891  size_t planes;
892  size_t blocksize;
893  size_t framesize;
895 
896  size_t mixer_idx;
897 
900  enum video_format preferred_format;
901 
902  volatile bool active;
904 
905  /* indicates ownership of the info.id buffer */
907 
910 
912 
913  struct circlebuf audio_input_buffer[MAX_AV_PLANES];
914  uint8_t *audio_output_buffer[MAX_AV_PLANES];
915 
916  /* if a video encoder is paired with an audio encoder, make it start
917  * up at the specific timestamp. if this is the audio encoder,
918  * wait_for_video makes it wait until it's ready to sync up with
919  * video */
926 
927  pthread_mutex_t outputs_mutex;
928  DARRAY(obs_output_t*) outputs;
929 
931 
932  /* stores the video/audio media output pointer. video_t *or audio_t **/
933  void *media;
934 
935  pthread_mutex_t callbacks_mutex;
936  DARRAY(struct encoder_callback) callbacks;
937 
939 };
940 
941 extern struct obs_encoder_info *find_encoder(const char *id);
942 
943 extern bool obs_encoder_initialize(obs_encoder_t *encoder);
944 extern void obs_encoder_shutdown(obs_encoder_t *encoder);
945 
946 extern void obs_encoder_start(obs_encoder_t *encoder,
947  void (*new_packet)(void *param, struct encoder_packet *packet),
948  void *param);
949 extern void obs_encoder_stop(obs_encoder_t *encoder,
950  void (*new_packet)(void *param, struct encoder_packet *packet),
951  void *param);
952 
953 extern void obs_encoder_add_output(struct obs_encoder *encoder,
954  struct obs_output *output);
955 extern void obs_encoder_remove_output(struct obs_encoder *encoder,
956  struct obs_output *output);
957 
958 void obs_encoder_destroy(obs_encoder_t *encoder);
959 
960 /* ------------------------------------------------------------------------- */
961 /* services */
962 
964  struct obs_weak_ref ref;
966 };
967 
968 struct obs_service {
969  struct obs_context_data context;
970  struct obs_service_info info;
972 
973  /* indicates ownership of the info.id buffer */
975 
976  bool active;
977  bool destroy;
979 };
980 
981 extern const struct obs_service_info *find_service(const char *id);
982 
983 extern void obs_service_activate(struct obs_service *service);
984 extern void obs_service_deactivate(struct obs_service *service, bool remove);
985 extern bool obs_service_initialize(struct obs_service *service,
986  struct obs_output *output);
987 
988 void obs_service_destroy(obs_service_t *service);
989 
bool obs_encoder_initialize(obs_encoder_t *encoder)
Definition: obs-hotkey.h:511
volatile uint64_t timing_adjust
Definition: obs-internal.h:546
pthread_mutex_t callbacks_mutex
Definition: obs-internal.h:935
Definition: graphics.h:60
Definition: calldata.h:46
bool user_muted
Definition: obs-internal.h:557
pthread_mutex_t init_mutex
Definition: obs-internal.h:888
struct audio_resampler audio_resampler_t
Definition: audio-resampler.h:28
void obs_encoder_stop(obs_encoder_t *encoder, void(*new_packet)(void *param, struct encoder_packet *packet), void *param)
uint8_t * data
Definition: obs-encoder.h:42
void obs_encoder_start(obs_encoder_t *encoder, void(*new_packet)(void *param, struct encoder_packet *packet), void *param)
Definition: obs-internal.h:684
size_t planes
Definition: obs-internal.h:891
struct obs_encoder * encoder
Definition: obs-internal.h:874
size_t obs_hotkey_id
Definition: obs-hotkey.h:24
void(* draw)(void *param, uint32_t cx, uint32_t cy)
Definition: obs-internal.h:48
pthread_mutex_t displays_mutex
Definition: obs-internal.h:304
bool defer_update
Definition: obs-internal.h:525
obs_data_t * settings
Definition: obs-internal.h:399
volatile bool active
Definition: obs-internal.h:902
Definition: video-io.h:135
Definition: obs-internal.h:507
bool size_changed
Definition: obs-internal.h:196
bool active
Definition: obs-internal.h:976
struct obs_source_frame * filter_async_video(obs_source_t *source, struct obs_source_frame *in)
bool received_video
Definition: obs-internal.h:784
Definition: obs-internal.h:139
gs_effect_t * opaque_effect
Definition: obs-internal.h:234
Definition: obs-internal.h:221
struct obs_display * first_display
Definition: obs-internal.h:298
void obs_source_save(obs_source_t *source)
uint64_t next_audio_sys_ts_min
Definition: obs-internal.h:549
Definition: video-io.h:47
struct obs_output * output
Definition: obs-internal.h:978
bool audio_callback(void *param, uint64_t start_ts_in, uint64_t end_ts_in, uint64_t *out_ts, uint32_t mixers, struct audio_output_data *mixes)
void process_delay(void *data, struct encoder_packet *packet)
video_t * video
Definition: obs-internal.h:247
char * name
Definition: obs-internal.h:126
bool audio_failed
Definition: obs-internal.h:555
char * data
Definition: obs-internal.h:100
uint8_t * stack
Definition: calldata.h:47
gs_effect_t * bicubic_effect
Definition: obs-internal.h:237
pthread_mutex_t outputs_mutex
Definition: obs-internal.h:927
struct obs_output * output
Definition: obs-internal.h:773
void deinterlace_update_async_video(obs_source_t *source)
Definition: obs-internal.h:776
gs_samplerstate_t * point_sampler
Definition: obs-internal.h:241
bool enabled
Definition: obs-internal.h:197
unsigned uint32_t
Definition: vc_stdint.h:31
#define MAX_AUDIO_CHANNELS
Definition: audio-io.h:29
Definition: obs-internal.h:771
uint32_t scaled_height
Definition: obs-internal.h:899
void(* obs_source_enum_proc_t)(obs_source_t *parent, obs_source_t *child, void *param)
Definition: obs-source.h:125
Definition: circlebuf.h:32
gs_swapchain_t * swap
Definition: obs-internal.h:200
void obs_transition_tick(obs_source_t *transition)
obs_hotkey_t * hotkey
Definition: obs-internal.h:173
Definition: obs-internal.h:512
#define MAX_CHANNELS
Definition: obs-defs.h:21
obs_hotkey_id pair_partner_id
Definition: obs-internal.h:136
Definition: obs-internal.h:352
Definition: obs-internal.h:872
struct obs_output * first_output
Definition: obs-internal.h:299
volatile bool end_data_capture_thread_active
Definition: obs-internal.h:787
bool received_audio
Definition: obs-internal.h:785
uint32_t cy
Definition: obs-internal.h:198
char * bin_path
Definition: obs-internal.h:78
bool(* obs_hotkey_active_func)(void *data, obs_hotkey_pair_id id, obs_hotkey_t *hotkey, bool pressed)
Definition: obs-hotkey.h:154
video_format
Definition: video-io.h:33
typedef DARRAY(profiler_time_entry_t) profiler_time_entries_t
void obs_context_data_insert(struct obs_context_data *context, pthread_mutex_t *mutex, void *first)
delay_msg
Definition: obs-internal.h:757
Definition: obs-ui.h:40
int64_t cur_pts
Definition: obs-internal.h:911
Definition: obs-internal.h:760
struct gs_stage_surface gs_stagesurf_t
Definition: graphics.h:259
struct obs_source * next_audio_source
Definition: obs-internal.h:559
obs_obj_type
Definition: obs.h:573
void obs_output_remove_encoder(struct obs_output *output, struct obs_encoder *encoder)
struct obs_source * first_source
Definition: obs-internal.h:296
bool initialized
Definition: obs-internal.h:903
gs_effect_t * deinterlace_blend_2x_effect
Definition: obs-internal.h:274
bool obs_transition_init(obs_source_t *transition)
gs_effect_t * default_rect_effect
Definition: obs-internal.h:233
char * description
Definition: obs-internal.h:127
gs_effect_t * bilinear_lowres_effect
Definition: obs-internal.h:239
Definition: vec2.h:27
uint64_t ts
Definition: obs-internal.h:765
Definition: obs-internal.h:759
void set_deinterlace_texture_size(obs_source_t *source)
int32_t timebase_den
Definition: obs-encoder.h:49
void obs_output_cleanup_delay(obs_output_t *output)
gs_effect_t * solid_effect
Definition: obs-internal.h:235
Definition: audio-io.h:74
uint64_t last_frame_ts
Definition: obs-internal.h:550
Definition: graphics.h:443
void * param
Definition: obs-internal.h:509
EXPORT void blog(int log_level, const char *format,...)
os_event_t * stopping_event
Definition: obs-internal.h:793
bool obs_source_init_context(struct obs_source *source, obs_data_t *settings, const char *name, obs_data_t *hotkey_data, bool private)
unsigned __int64 uint64_t
Definition: vc_stdint.h:33
gs_effect_t * deinterlace_linear_effect
Definition: obs-internal.h:271
gs_effect_t * premultiplied_alpha_effect
Definition: obs-internal.h:240
Definition: obs-hotkey.h:37
volatile long refs
Definition: obs-internal.h:439
struct obs_weak_source * control
Definition: obs-internal.h:515
Definition: audio-io.h:93
bool obs_display_init(struct obs_display *display, const struct gs_init_data *graphics_data)
gs_color_format
Definition: graphics.h:56
Definition: obs-internal.h:480
void obs_encoder_remove_output(struct obs_encoder *encoder, struct obs_output *output)
obs_transition_mode
Definition: obs.h:1076
obs_deinterlace_mode
Definition: obs.h:891
Definition: obs-encoder.h:41
unsigned char uint8_t
Definition: vc_stdint.h:27
struct obs_data obs_data_t
Definition: obs-data.h:42
Definition: obs-source.h:135
void obs_output_destroy(obs_output_t *output)
uint32_t timebase_num
Definition: obs-internal.h:908
Definition: obs-output.h:33
volatile bool data_active
Definition: obs-internal.h:786
uint32_t lagged_frames
Definition: obs-internal.h:250
void * obs_hotkey_thread(void *param)
Definition: obs-internal.h:318
size_t last_audio_input_buf_size
Definition: obs-internal.h:563
gs_effect_t * default_effect
Definition: obs-internal.h:232
void obs_hotkeys_context_release(struct obs_context_data *context)
bool update_async_texture(struct obs_source *source, const struct obs_source_frame *frame, gs_texture_t *tex, gs_texrender_t *texrender)
bool set_async_texture_size(struct obs_source *source, const struct obs_source_frame *frame)
volatile bool valid
Definition: obs-internal.h:314
uint32_t conversion_height
Definition: obs-internal.h:255
void obs_transition_enum_sources(obs_source_t *transition, obs_source_enum_proc_t enum_callback, void *param)
uint64_t start_ts
Definition: obs-internal.h:925
void obs_transition_free(obs_source_t *transition)
size_t blocksize
Definition: obs-internal.h:892
Definition: obs-internal.h:167
obs_transition_scale_type
Definition: obs.h:1086
Definition: obs-internal.h:490
void obs_source_load(obs_source_t *source)
pthread_mutex_t services_mutex
Definition: obs-internal.h:307
uint64_t first_raw_ts
Definition: obs-internal.h:924
bool destroy_on_stop
Definition: obs-internal.h:930
void deinterlace_render(obs_source_t *s)
char * bin
Definition: obs-internal.h:99
gs_effect_t * deinterlace_yadif_2x_effect
Definition: obs-internal.h:276
uint64_t next_audio_ts_min
Definition: obs-internal.h:548
pthread_mutex_t encoders_mutex
Definition: obs-internal.h:306
void * media
Definition: obs-internal.h:933
pthread_mutex_t mutex
Definition: obs-internal.h:319
struct obs_source * first_audio_source
Definition: obs-internal.h:297
bool obs_output_actual_start(obs_output_t *output)
size_t framesize_bytes
Definition: obs-internal.h:894
Definition: obs-internal.h:502
#define MAX_TS_VAR
Definition: obs-internal.h:703
Definition: obs-ui.h:84
bool obs_hotkeys_platform_init(struct obs_core_hotkeys *hotkeys)
struct obs_weak_encoder * control
Definition: obs-internal.h:886
Definition: obs-internal.h:183
uint32_t total_frames
Definition: obs-internal.h:249
bool gpu_conversion
Definition: obs-internal.h:253
Definition: obs-internal.h:763
#define MAX_AUDIO_MIXES
Definition: audio-io.h:28
Definition: graphics-internal.h:271
struct obs_hotkeys_platform obs_hotkeys_platform_t
Definition: obs-internal.h:150
struct obs_source_frame * frame
Definition: obs-internal.h:481
gs_texture_t * transparent_texture
Definition: obs-internal.h:267
Definition: obs-internal.h:279
uint32_t default_flags
Definition: obs-internal.h:519
Definition: obs-internal.h:883
Definition: obs-internal.h:75
Definition: obs-internal.h:295
void obs_source_activate(obs_source_t *source, enum view_type type)
bool obs_output_delay_start(obs_output_t *output)
int count
Definition: obs-internal.h:218
bool muted
Definition: obs-internal.h:558
volatile bool timing_set
Definition: obs-internal.h:545
double video_fps
Definition: obs-internal.h:246
enum obs_key obs_key_t
Definition: obs-hotkey.h:35
EXPORT void dstr_copy(struct dstr *dst, const char *array)
void obs_hotkey_name_map_free(void)
int cur_texture
Definition: obs-internal.h:243
Definition: effect.h:139
struct obs_service * first_service
Definition: obs-internal.h:301
obs_scale_type
Definition: obs.h:114
pthread_mutex_t draw_callbacks_mutex
Definition: obs-internal.h:201
Definition: obs-internal.h:98
void obs_source_deactivate(obs_source_t *source, enum view_type type)
void obs_context_data_free(struct obs_context_data *context)
struct obs_module * first_module
Definition: obs-internal.h:353
void obs_source_audio_render(obs_source_t *source, uint32_t mixers, size_t channels, size_t sample_rate, size_t size)
size_t framesize
Definition: obs-internal.h:893
signal_handler_t * signals
Definition: obs-internal.h:400
int64_t dts
Definition: obs-encoder.h:46
uint32_t scaled_width
Definition: obs-internal.h:898
void obs_source_video_tick(obs_source_t *source, float seconds)
Definition: obs-internal.h:487
void * module
Definition: obs-internal.h:80
void remove_async_frame(obs_source_t *source, struct obs_source_frame *frame)
Definition: obs-internal.h:396
obs_key_combination_t key
Definition: obs-internal.h:168
Definition: obs-encoder.h:112
void obs_encoder_destroy(obs_encoder_t *encoder)
obs_hotkey_pair_id pair_id
Definition: obs-internal.h:140
void free_module(struct obs_module *mod)
Definition: matrix4.h:32
const struct obs_service_info * find_service(const char *id)
void add_alignment(struct vec2 *v, uint32_t align, int cx, int cy)
pthread_mutex_t sources_mutex
Definition: obs-internal.h:303
void obs_encoder_shutdown(obs_encoder_t *encoder)
uint32_t samplerate
Definition: obs-internal.h:890
struct obs_encoder_info * find_encoder(const char *id)
void obs_hotkeys_platform_free(struct obs_core_hotkeys *hotkeys)
EXPORT void signal_handler_signal(signal_handler_t *handler, const char *signal, calldata_t *params)
gs_effect_t * deinterlace_discard_2x_effect
Definition: obs-internal.h:270
void obs_hotkeys_free(void)
struct gs_texture gs_texture_t
Definition: graphics.h:258
void * obs_video_thread(void *param)
gs_effect_t * obs_load_effect(gs_effect_t **effect, const char *file)
char * array
Definition: dstr.h:37
view_type
Definition: obs-internal.h:682
Definition: obs.h:221
void obs_output_delay_stop(obs_output_t *output)
char * data_path
Definition: obs-internal.h:79
const struct obs_source_info * get_source_info(const char *id)
bool loaded
Definition: obs-internal.h:81
struct obs_encoder * first_encoder
Definition: obs-internal.h:300
size_t obs_hotkey_pair_id
Definition: obs-hotkey.h:26
uint64_t resample_offset
Definition: obs-internal.h:547
bool owns_info_id
Definition: obs-internal.h:522
int64_t video_offset
Definition: obs-internal.h:788
struct obs_weak_service * control
Definition: obs-internal.h:971
audio_t * audio
Definition: obs-internal.h:281
bool sent_first_packet
Definition: obs-internal.h:878
Definition: audio-io.h:68
struct obs_service * service
Definition: obs-internal.h:965
pthread_mutex_t channels_mutex
Definition: obs-internal.h:184
int64_t highest_video_ts
Definition: obs-internal.h:791
bool wait_for_video
Definition: obs-internal.h:920
gs_stagesurf_t * mapped_surface
Definition: obs-internal.h:242
void * data
Definition: obs-internal.h:130
struct signal_handler signal_handler_t
Definition: signal.h:35
void(* obs_hotkey_func)(void *data, obs_hotkey_id id, obs_hotkey_t *hotkey, bool pressed)
Definition: obs-hotkey.h:132
Definition: obs-internal.h:488
Definition: obs-internal.h:493
gs_effect_t * deinterlace_yadif_effect
Definition: obs-internal.h:275
bool active
Definition: obs-internal.h:538
bool private
Definition: obs-internal.h:415
const char * conversion_tech
Definition: obs-internal.h:254
void * data
Definition: obs-internal.h:398
void obs_service_activate(struct obs_service *service)
bool first_received
Definition: obs-internal.h:921
void obs_context_data_setname(struct obs_context_data *context, const char *name)
char * name
Definition: obs-internal.h:397
gs_effect_t * deinterlace_discard_effect
Definition: obs-internal.h:269
Definition: dstr.h:36
Definition: obs-internal.h:963
bool audio_pending
Definition: obs-internal.h:556
uint64_t timestamp
Definition: obs-internal.h:217
pthread_mutex_t outputs_mutex
Definition: obs-internal.h:305
struct gs_sampler_state gs_samplerstate_t
Definition: graphics.h:263
bool obs_service_initialize(struct obs_service *service, struct obs_output *output)
gs_effect_t * conversion_effect
Definition: obs-internal.h:236
obs_hotkey_registerer_t registerer_type
Definition: obs-internal.h:133
bool owns_info_id
Definition: obs-internal.h:974
struct obs_source ** prev_next_audio_source
Definition: obs-internal.h:560
graphics_t * graphics
Definition: obs-internal.h:222
#define MICROSECOND_DEN
Definition: obs-internal.h:40
obs_allow_direct_render
Definition: obs.h:109
struct obs_context_data context
Definition: obs-internal.h:513
struct video_output video_t
Definition: video-io.h:31
void obs_view_free(struct obs_view *view)
uint64_t audio_ts
Definition: obs-internal.h:561
void obs_service_destroy(obs_service_t *service)
bool owns_info_id
Definition: obs-internal.h:782
uint32_t flags
Definition: obs-internal.h:518
Definition: obs-internal.h:877
bool thread_initialized
Definition: obs-internal.h:251
uint32_t base_width
Definition: obs-internal.h:262
struct obs_core * obs
gs_effect_t * deinterlace_linear_2x_effect
Definition: obs-internal.h:272
long long unnamed_index
Definition: obs-internal.h:312
void obs_output_actual_stop(obs_output_t *output, bool force, uint64_t ts)
struct obs_weak_output * control
Definition: obs-internal.h:779
void obs_context_data_remove(struct obs_context_data *context)
gs_effect_t * lanczos_effect
Definition: obs-internal.h:238
obs_hotkey_id id
Definition: obs-internal.h:125
size_t size
Definition: calldata.h:48
const char * file
Definition: obs-internal.h:77
#define NUM_TEXTURES
Definition: obs-internal.h:39
char * mod_name
Definition: obs-internal.h:76
#define MAX_AV_PLANES
Definition: media-io-defs.h:20
struct obs_module * next
Definition: obs-internal.h:93
pthread_mutex_t interleaved_mutex
Definition: obs-internal.h:794
void deinterlace_process_last_frame(obs_source_t *source, uint64_t sys_time)
float vol
Definition: obs-internal.h:497
Definition: graphics.h:61
Definition: obs-internal.h:47
uint32_t output_width
Definition: obs-internal.h:260
uint32_t timebase_den
Definition: obs-internal.h:909
bool async_rendered
Definition: obs-internal.h:552
size_t mixer_idx
Definition: obs-internal.h:896
bool removed
Definition: obs-internal.h:536
uint32_t background_color
Definition: obs-internal.h:199
struct obs_source * source
Definition: obs-internal.h:504
bool showing
Definition: obs-internal.h:539
audio_action_type
Definition: obs-internal.h:486
struct obs_encoder * paired_encoder
Definition: obs-internal.h:922
int pressed
Definition: obs-internal.h:131
bool owns_info_id
Definition: obs-internal.h:906
Definition: base.h:65
bool obs_hotkeys_platform_is_pressed(obs_hotkeys_platform_t *context, obs_key_t key)
Definition: obs-internal.h:968
uint32_t output_height
Definition: obs-internal.h:261
void obs_source_destroy(struct obs_source *source)
uint64_t timestamp
Definition: obs-internal.h:494
enum obs_hotkey_registerer_type obs_hotkey_registerer_t
Definition: obs-hotkey.h:53
Definition: obs-internal.h:216
void obs_encoder_add_output(struct obs_encoder *encoder, struct obs_output *output)
struct os_event_data os_event_t
Definition: threading.h:63
struct proc_handler proc_handler_t
Definition: proc.h:36
gs_effect_t * deinterlace_blend_effect
Definition: obs-internal.h:273
Main libobs header used by applications.
Definition: audio-resampler.h:30
Definition: video-io.h:49
volatile long weak_refs
Definition: obs-internal.h:440
Definition: graphics.h:62
int64_t highest_audio_ts
Definition: obs-internal.h:790
Definition: obs-internal.h:683
obs_hotkey_func func
Definition: obs-internal.h:129
Definition: obs-internal.h:438
proc_handler_t * procs
Definition: obs-internal.h:401
obs_hotkey_id hotkey_id
Definition: obs-internal.h:172
obs_source_audio_capture_t callback
Definition: obs-internal.h:508
Definition: obs-internal.h:489
bool enabled
Definition: obs-internal.h:542
void(* obs_source_audio_capture_t)(void *param, obs_source_t *source, const struct audio_data *audio_data, bool muted)
Definition: obs.h:883
__int64 int64_t
Definition: vc_stdint.h:32
EXPORT void bfree(void *ptr)
uint32_t base_height
Definition: obs-internal.h:263
Definition: obs-internal.h:124
Definition: obs-internal.h:758
EXPORT bool os_file_exists(const char *path)
pthread_mutex_t audio_sources_mutex
Definition: obs-internal.h:308
bool obs_view_init(struct obs_view *view)
void obs_transition_load(obs_source_t *source, obs_data_t *data)
bool used
Definition: obs-internal.h:483
const char * profile_encoder_encode_name
Definition: obs-internal.h:938
uint64_t video_time
Definition: obs-internal.h:245
#define bool
Definition: vc_stdbool.h:5
void obs_service_deactivate(struct obs_service *service, bool remove)
void * registerer
Definition: obs-internal.h:134
pthread_t end_data_capture_thread
Definition: obs-internal.h:792
int64_t offset_usec
Definition: obs-internal.h:923
Definition: obs-internal.h:195
uint64_t last_sys_timestamp
Definition: obs-internal.h:551
long unused_count
Definition: obs-internal.h:482
bool obs_context_data_init(struct obs_context_data *context, enum obs_obj_type type, obs_data_t *settings, const char *name, obs_data_t *hotkey_data, bool private)
void * param
Definition: obs-internal.h:880
void obs_display_free(struct obs_display *display)
void(* encoded_callback_t)(void *data, struct encoder_packet *packet)
Definition: obs-internal.h:769
bool destroy
Definition: obs-internal.h:977
volatile long activate_refs
Definition: obs-internal.h:531
struct gs_texture_render gs_texrender_t
Definition: graphics.h:265
struct audio_output audio_t
Definition: audio-io.h:38
Definition: obs.h:191
Definition: graphics.h:59
void * param
Definition: obs-internal.h:49
float obs_source_get_target_volume(obs_source_t *source, obs_source_t *target)
const struct obs_output_info * find_output(const char *id)
void obs_transition_save(obs_source_t *source, obs_data_t *data)
const char * obs_get_hotkey_translation(obs_key_t key, const char *def)
Definition: obs-service.h:31
volatile long show_refs
Definition: obs-internal.h:528
struct profiler_name_store profiler_name_store_t
Definition: profiler.h:39
struct gs_swap_chain gs_swapchain_t
Definition: graphics.h:264
pthread_t video_thread
Definition: obs-internal.h:248
Definition: video-io.h:46
void(* obs_hotkey_callback_router_func)(void *data, obs_hotkey_id id, bool pressed)
Definition: obs-hotkey.h:251