Open Broadcaster Software
Free, open source software for live streaming and recording
obs-hotkey.h
Go to the documentation of this file.
1 /******************************************************************************
2  Copyright (C) 2014-2015 by Ruwen Hahn <palana@stunned.de>
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 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 typedef size_t obs_hotkey_id;
25 typedef size_t obs_hotkey_pair_id;
26 
27 #ifndef SWIG
28 #define OBS_INVALID_HOTKEY_ID (~(obs_hotkey_id)0)
29 #define OBS_INVALID_HOTKEY_PAIR_ID (~(obs_hotkey_pair_id)0)
30 #else
31 const size_t OBS_INVALID_HOTKEY_ID = (size_t)-1;
32 const size_t OBS_INVALID_HOTKEY_PAIR_ID = (size_t)-1;
33 #endif
34 
35 enum obs_key {
36 #define OBS_HOTKEY(x) x,
37 #include "obs-hotkeys.h"
38 #undef OBS_HOTKEY
39  OBS_KEY_LAST_VALUE //not an actual key
40 };
41 typedef enum obs_key obs_key_t;
42 
46 };
48 
49 typedef struct obs_hotkey obs_hotkey_t;
51 
58 };
60 
62 EXPORT const char *obs_hotkey_get_name(const obs_hotkey_t *key);
65  const obs_hotkey_t *key);
68 
69 
71  obs_hotkey_binding_t *binding);
73  obs_hotkey_binding_t *binding);
75  obs_hotkey_binding_t *binding);
76 
77 #ifndef SWIG
79  const char *insert;
80  const char *del;
81  const char *home;
82  const char *end;
83  const char *page_up;
84  const char *page_down;
85  const char *num_lock;
86  const char *scroll_lock;
87  const char *caps_lock;
88  const char *backspace;
89  const char *tab;
90  const char *print;
91  const char *pause;
92  const char *left;
93  const char *right;
94  const char *up;
95  const char *down;
96  const char *shift;
97  const char *alt;
98  const char *control;
99  const char *meta; /* windows/super key */
100  const char *menu;
101  const char *space;
102  const char *numpad_num; /* For example, "Numpad %1" */
103  const char *numpad_divide;
104  const char *numpad_multiply;
105  const char *numpad_minus;
106  const char *numpad_plus;
107  const char *numpad_decimal;
108  const char *apple_keypad_num; /* For example, "%1 (Keypad)" */
109  const char *apple_keypad_divide;
111  const char *apple_keypad_minus;
112  const char *apple_keypad_plus;
113  const char *apple_keypad_decimal;
114  const char *apple_keypad_equal;
115  const char *mouse_num; /* For example, "Mouse %1" */
116 };
117 
118 /* This function is an optional way to provide translations for specific keys
119  * that may not have translations. If the operating system can provide
120  * translations for these keys, it will use the operating system's translation
121  * over these translations. If no translations are specified, it will use
122  * the default English translations for that specific operating system. */
124  struct obs_hotkeys_translations *translations, size_t size);
125 #endif
126 
127 #define obs_hotkeys_set_translations(translations) \
128  obs_hotkeys_set_translations_s(translations, \
129  sizeof(struct obs_hotkeys_translations))
130 
132  const char *mute, const char *unmute,
133  const char *push_to_mute, const char *push_to_talk);
134 
136  const char *show, const char *hide);
137 
138 /* registering hotkeys (giving hotkeys a name and a function) */
139 
140 typedef void (*obs_hotkey_func)(void *data,
141  obs_hotkey_id id, obs_hotkey_t *hotkey, bool pressed);
142 
144  const char *description, obs_hotkey_func func, void *data);
145 
147  const char *name, const char *description,
148  obs_hotkey_func func, void *data);
149 
151  const char *name, const char *description,
152  obs_hotkey_func func, void *data);
153 
155  const char *name, const char *description,
156  obs_hotkey_func func, void *data);
157 
159  const char *name, const char *description,
160  obs_hotkey_func func, void *data);
161 
162 typedef bool (*obs_hotkey_active_func)(void *data,
163  obs_hotkey_pair_id id, obs_hotkey_t *hotkey, bool pressed);
164 
166  const char *name0, const char *description0,
167  const char *name1, const char *description1,
169  void *data0, void *data1);
170 
172  obs_encoder_t *encoder,
173  const char *name0, const char *description0,
174  const char *name1, const char *description1,
176  void *data0, void *data1);
177 
179  obs_output_t *output,
180  const char *name0, const char *description0,
181  const char *name1, const char *description1,
183  void *data0, void *data1);
184 
186  obs_service_t *service,
187  const char *name0, const char *description0,
188  const char *name1, const char *description1,
190  void *data0, void *data1);
191 
193  obs_source_t *source,
194  const char *name0, const char *description0,
195  const char *name1, const char *description1,
197  void *data0, void *data1);
198 
200 
202 
203 /* loading hotkeys (associating a hotkey with a physical key and modifiers) */
204 
206  obs_key_combination_t *combinations, size_t num);
207 
209 
211  obs_data_t *hotkeys);
212 
213 EXPORT void obs_hotkeys_load_output(obs_output_t *output, obs_data_t *hotkeys);
214 
216  obs_data_t *hotkeys);
217 
218 EXPORT void obs_hotkeys_load_source(obs_source_t *source, obs_data_t *hotkeys);
219 
221  obs_data_array_t *data1);
222 
223 
225 
227 
229 
231 
233 
234 /* enumerating hotkeys */
235 
236 typedef bool (*obs_hotkey_enum_func)(void *data,
237  obs_hotkey_id id, obs_hotkey_t *key);
238 
239 EXPORT void obs_enum_hotkeys(obs_hotkey_enum_func func, void *data);
240 
241 /* enumerating bindings */
242 
243 typedef bool (*obs_hotkey_binding_enum_func)(void *data,
244  size_t idx, obs_hotkey_binding_t* binding);
245 
247  void *data);
248 
249 /* hotkey event control */
250 
251 EXPORT void obs_hotkey_inject_event(obs_key_combination_t hotkey, bool pressed);
252 
254 
256 
257 /* hotkey callback routing (trigger callbacks through e.g. a UI thread) */
258 
259 typedef void (*obs_hotkey_callback_router_func)(void *data,
260  obs_hotkey_id id, bool pressed);
261 
263  func, void *data);
264 
266 
267 /* hotkey callbacks won't be processed if callback rerouting is enabled and no
268  * router func is set */
270 
271 /* misc */
272 
273 typedef void (*obs_hotkey_atomic_update_func)(void *);
275  void *data);
276 
277 struct dstr;
278 EXPORT void obs_key_to_str(obs_key_t key, struct dstr *str);
280  struct dstr *str);
281 
284 
285 EXPORT const char *obs_key_to_name(obs_key_t key);
286 EXPORT obs_key_t obs_key_from_name(const char *name);
287 
288 static inline bool obs_key_combination_is_empty(obs_key_combination_t combo)
289 {
290  return !combo.modifiers && combo.key == OBS_KEY_NONE;
291 }
292 
293 #ifdef __cplusplus
294 }
295 #endif
Definition: obs-hotkey.h:519
EXPORT void * obs_hotkey_get_registerer(const obs_hotkey_t *key)
EXPORT void obs_key_to_str(obs_key_t key, struct dstr *str)
EXPORT void obs_hotkey_load(obs_hotkey_id id, obs_data_array_t *data)
EXPORT void obs_hotkey_trigger_routed_callback(obs_hotkey_id id, bool pressed)
EXPORT void obs_hotkey_pair_load(obs_hotkey_pair_id id, obs_data_array_t *data0, obs_data_array_t *data1)
const char * del
Definition: obs-hotkey.h:80
size_t obs_hotkey_id
Definition: obs-hotkey.h:24
bool(* obs_hotkey_enum_func)(void *data, obs_hotkey_id id, obs_hotkey_t *key)
Definition: obs-hotkey.h:236
const char * num_lock
Definition: obs-hotkey.h:85
EXPORT void obs_enum_hotkey_bindings(obs_hotkey_binding_enum_func func, void *data)
EXPORT void obs_enum_hotkeys(obs_hotkey_enum_func func, void *data)
const char * up
Definition: obs-hotkey.h:94
const char * down
Definition: obs-hotkey.h:95
const char * control
Definition: obs-hotkey.h:98
EXPORT obs_data_array_t * obs_hotkey_save(obs_hotkey_id id)
const char * apple_keypad_multiply
Definition: obs-hotkey.h:110
Definition: obs-internal.h:815
unsigned uint32_t
Definition: vc_stdint.h:31
EXPORT obs_hotkey_pair_id obs_hotkey_pair_register_service(obs_service_t *service, const char *name0, const char *description0, const char *name1, const char *description1, obs_hotkey_active_func func0, obs_hotkey_active_func func1, void *data0, void *data1)
EXPORT obs_data_t * obs_hotkeys_save_service(obs_service_t *service)
Definition: obs-internal.h:531
const char * numpad_num
Definition: obs-hotkey.h:102
bool(* obs_hotkey_active_func)(void *data, obs_hotkey_pair_id id, obs_hotkey_t *hotkey, bool pressed)
Definition: obs-hotkey.h:162
EXPORT void obs_hotkeys_load_source(obs_source_t *source, obs_data_t *hotkeys)
const char * scroll_lock
Definition: obs-hotkey.h:86
EXPORT void obs_hotkeys_load_output(obs_output_t *output, obs_data_t *hotkeys)
const char * numpad_multiply
Definition: obs-hotkey.h:104
EXPORT obs_hotkey_id obs_hotkey_register_encoder(obs_encoder_t *encoder, const char *name, const char *description, obs_hotkey_func func, void *data)
Definition: obs-hotkey.h:54
EXPORT obs_hotkey_id obs_hotkey_register_output(obs_output_t *output, const char *name, const char *description, obs_hotkey_func func, void *data)
Definition: obs-hotkey.h:43
EXPORT void obs_hotkeys_set_translations_s(struct obs_hotkeys_translations *translations, size_t size)
const char * print
Definition: obs-hotkey.h:90
const char * page_down
Definition: obs-hotkey.h:84
struct obs_data obs_data_t
Definition: obs-data.h:42
EXPORT void obs_hotkey_set_callback_routing_func(obs_hotkey_callback_router_func func, void *data)
EXPORT void obs_hotkey_enable_strict_modifiers(bool enable)
const char * mouse_num
Definition: obs-hotkey.h:115
const char * alt
Definition: obs-hotkey.h:97
Definition: obs-internal.h:173
const char * numpad_plus
Definition: obs-hotkey.h:106
const char * end
Definition: obs-hotkey.h:82
Definition: obs-hotkey.h:78
obs_hotkey_registerer_type
Definition: obs-hotkey.h:52
const char * apple_keypad_num
Definition: obs-hotkey.h:108
#define EXPORT
Definition: c99defs.h:49
const char * apple_keypad_decimal
Definition: obs-hotkey.h:113
EXPORT obs_hotkey_id obs_hotkey_register_frontend(const char *name, const char *description, obs_hotkey_func func, void *data)
obs_key
Definition: obs-hotkey.h:35
const char * apple_keypad_equal
Definition: obs-hotkey.h:114
obs_key_t key
Definition: obs-hotkey.h:45
const char * page_up
Definition: obs-hotkey.h:83
EXPORT void obs_hotkeys_set_audio_hotkeys_translations(const char *mute, const char *unmute, const char *push_to_mute, const char *push_to_talk)
Definition: obs-internal.h:930
enum obs_key obs_key_t
Definition: obs-hotkey.h:41
const char * right
Definition: obs-hotkey.h:93
const char * tab
Definition: obs-hotkey.h:89
EXPORT obs_data_t * obs_hotkeys_save_output(obs_output_t *output)
const char * menu
Definition: obs-hotkey.h:100
EXPORT obs_hotkey_registerer_t obs_hotkey_get_registerer_type(const obs_hotkey_t *key)
bool(* obs_hotkey_binding_enum_func)(void *data, size_t idx, obs_hotkey_binding_t *binding)
Definition: obs-hotkey.h:243
EXPORT obs_hotkey_id obs_hotkey_register_source(obs_source_t *source, const char *name, const char *description, obs_hotkey_func func, void *data)
obs_key_combination_t key
Definition: obs-internal.h:174
EXPORT obs_key_t obs_key_from_virtual_key(int code)
EXPORT void obs_hotkeys_load_encoder(obs_encoder_t *encoder, obs_data_t *hotkeys)
EXPORT obs_hotkey_id obs_hotkey_get_pair_partner_id(const obs_hotkey_t *key)
const char * numpad_decimal
Definition: obs-hotkey.h:107
void(* obs_hotkey_atomic_update_func)(void *)
Definition: obs-hotkey.h:273
EXPORT const char * obs_hotkey_get_name(const obs_hotkey_t *key)
#define OBS_INVALID_HOTKEY_ID
Definition: obs-hotkey.h:28
EXPORT void obs_hotkey_enable_background_press(bool enable)
const char * apple_keypad_minus
Definition: obs-hotkey.h:111
const char * backspace
Definition: obs-hotkey.h:88
Definition: obs-hotkey.h:56
size_t obs_hotkey_pair_id
Definition: obs-hotkey.h:25
const char * shift
Definition: obs-hotkey.h:96
void(* obs_hotkey_func)(void *data, obs_hotkey_id id, obs_hotkey_t *hotkey, bool pressed)
Definition: obs-hotkey.h:140
EXPORT int obs_key_to_virtual_key(obs_key_t key)
Definition: dstr.h:36
EXPORT obs_hotkey_pair_id obs_hotkey_pair_register_source(obs_source_t *source, const char *name0, const char *description0, const char *name1, const char *description1, obs_hotkey_active_func func0, obs_hotkey_active_func func1, void *data0, void *data1)
const char * meta
Definition: obs-hotkey.h:99
EXPORT obs_hotkey_id obs_hotkey_binding_get_hotkey_id(obs_hotkey_binding_t *binding)
EXPORT const char * obs_key_to_name(obs_key_t key)
#define OBS_INVALID_HOTKEY_PAIR_ID
Definition: obs-hotkey.h:29
Definition: obs-hotkey.h:55
const char * left
Definition: obs-hotkey.h:92
EXPORT void obs_hotkeys_load_service(obs_service_t *service, obs_data_t *hotkeys)
EXPORT void obs_hotkeys_set_sceneitem_hotkeys_translations(const char *show, const char *hide)
EXPORT obs_hotkey_pair_id obs_hotkey_pair_register_frontend(const char *name0, const char *description0, const char *name1, const char *description1, obs_hotkey_active_func func0, obs_hotkey_active_func func1, void *data0, void *data1)
Definition: obs-hotkey.h:53
EXPORT void obs_hotkey_pair_unregister(obs_hotkey_pair_id id)
uint32_t modifiers
Definition: obs-hotkey.h:44
EXPORT obs_key_t obs_key_from_name(const char *name)
const char * numpad_minus
Definition: obs-hotkey.h:105
EXPORT void obs_hotkey_unregister(obs_hotkey_id id)
struct obs_data_array obs_data_array_t
Definition: obs-data.h:44
EXPORT obs_key_combination_t obs_hotkey_binding_get_key_combination(obs_hotkey_binding_t *binding)
Definition: obs-internal.h:1015
enum obs_hotkey_registerer_type obs_hotkey_registerer_t
Definition: obs-hotkey.h:59
const char * space
Definition: obs-hotkey.h:101
const char * numpad_divide
Definition: obs-hotkey.h:103
const char * caps_lock
Definition: obs-hotkey.h:87
EXPORT void obs_hotkey_load_bindings(obs_hotkey_id id, obs_key_combination_t *combinations, size_t num)
const char * apple_keypad_divide
Definition: obs-hotkey.h:109
EXPORT obs_hotkey_id obs_hotkey_get_id(const obs_hotkey_t *key)
EXPORT obs_data_t * obs_hotkeys_save_encoder(obs_encoder_t *encoder)
EXPORT obs_hotkey_id obs_hotkey_register_service(obs_service_t *service, const char *name, const char *description, obs_hotkey_func func, void *data)
EXPORT obs_hotkey_pair_id obs_hotkey_pair_register_encoder(obs_encoder_t *encoder, const char *name0, const char *description0, const char *name1, const char *description1, obs_hotkey_active_func func0, obs_hotkey_active_func func1, void *data0, void *data1)
Definition: obs-internal.h:130
const char * pause
Definition: obs-hotkey.h:91
EXPORT obs_hotkey_t * obs_hotkey_binding_get_hotkey(obs_hotkey_binding_t *binding)
EXPORT void obs_hotkey_update_atomic(obs_hotkey_atomic_update_func func, void *data)
#define bool
Definition: vc_stdbool.h:5
Definition: obs-hotkey.h:57
EXPORT void obs_hotkey_enable_callback_rerouting(bool enable)
const char * apple_keypad_plus
Definition: obs-hotkey.h:112
const char * insert
Definition: obs-hotkey.h:79
EXPORT const char * obs_hotkey_get_description(const obs_hotkey_t *key)
EXPORT obs_data_t * obs_hotkeys_save_source(obs_source_t *source)
EXPORT void obs_key_combination_to_str(obs_key_combination_t key, struct dstr *str)
EXPORT obs_hotkey_pair_id obs_hotkey_pair_register_output(obs_output_t *output, const char *name0, const char *description0, const char *name1, const char *description1, obs_hotkey_active_func func0, obs_hotkey_active_func func1, void *data0, void *data1)
EXPORT void obs_hotkey_inject_event(obs_key_combination_t hotkey, bool pressed)
const char * home
Definition: obs-hotkey.h:81
void(* obs_hotkey_callback_router_func)(void *data, obs_hotkey_id id, bool pressed)
Definition: obs-hotkey.h:259