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 #define XINPUT_MOUSE_LEN 33
36 
37 enum obs_key {
38 #define OBS_HOTKEY(x) x,
39 #include "obs-hotkeys.h"
40 #undef OBS_HOTKEY
41  OBS_KEY_LAST_VALUE //not an actual key
42 };
43 typedef enum obs_key obs_key_t;
44 
48 };
50 
51 typedef struct obs_hotkey obs_hotkey_t;
53 
60 };
62 
63 /* getter functions */
64 
66 EXPORT const char *obs_hotkey_get_name(const obs_hotkey_t *key);
69  const obs_hotkey_t *key);
72 
73 
75  obs_hotkey_binding_t *binding);
77  obs_hotkey_binding_t *binding);
79  obs_hotkey_binding_t *binding);
80 
81 /* setter functions */
82 
83 EXPORT void obs_hotkey_set_name(obs_hotkey_id id, const char *name);
84 EXPORT void obs_hotkey_set_description(obs_hotkey_id id, const char *desc);
86  const char *name0, const char *name1);
88  const char *desc0, const char *desc1);
89 
90 #ifndef SWIG
92  const char *insert;
93  const char *del;
94  const char *home;
95  const char *end;
96  const char *page_up;
97  const char *page_down;
98  const char *num_lock;
99  const char *scroll_lock;
100  const char *caps_lock;
101  const char *backspace;
102  const char *tab;
103  const char *print;
104  const char *pause;
105  const char *left;
106  const char *right;
107  const char *up;
108  const char *down;
109  const char *shift;
110  const char *alt;
111  const char *control;
112  const char *meta; /* windows/super key */
113  const char *menu;
114  const char *space;
115  const char *numpad_num; /* For example, "Numpad %1" */
116  const char *numpad_divide;
117  const char *numpad_multiply;
118  const char *numpad_minus;
119  const char *numpad_plus;
120  const char *numpad_decimal;
121  const char *apple_keypad_num; /* For example, "%1 (Keypad)" */
122  const char *apple_keypad_divide;
124  const char *apple_keypad_minus;
125  const char *apple_keypad_plus;
126  const char *apple_keypad_decimal;
127  const char *apple_keypad_equal;
128  const char *mouse_num; /* For example, "Mouse %1" */
129 };
130 
131 /* This function is an optional way to provide translations for specific keys
132  * that may not have translations. If the operating system can provide
133  * translations for these keys, it will use the operating system's translation
134  * over these translations. If no translations are specified, it will use
135  * the default English translations for that specific operating system. */
137  struct obs_hotkeys_translations *translations, size_t size);
138 #endif
139 
140 #define obs_hotkeys_set_translations(translations) \
141  obs_hotkeys_set_translations_s(translations, \
142  sizeof(struct obs_hotkeys_translations))
143 
145  const char *mute, const char *unmute,
146  const char *push_to_mute, const char *push_to_talk);
147 
149  const char *show, const char *hide);
150 
151 /* registering hotkeys (giving hotkeys a name and a function) */
152 
153 typedef void (*obs_hotkey_func)(void *data,
154  obs_hotkey_id id, obs_hotkey_t *hotkey, bool pressed);
155 
157  const char *description, obs_hotkey_func func, void *data);
158 
160  const char *name, const char *description,
161  obs_hotkey_func func, void *data);
162 
164  const char *name, const char *description,
165  obs_hotkey_func func, void *data);
166 
168  const char *name, const char *description,
169  obs_hotkey_func func, void *data);
170 
172  const char *name, const char *description,
173  obs_hotkey_func func, void *data);
174 
175 typedef bool (*obs_hotkey_active_func)(void *data,
176  obs_hotkey_pair_id id, obs_hotkey_t *hotkey, bool pressed);
177 
179  const char *name0, const char *description0,
180  const char *name1, const char *description1,
182  void *data0, void *data1);
183 
185  obs_encoder_t *encoder,
186  const char *name0, const char *description0,
187  const char *name1, const char *description1,
189  void *data0, void *data1);
190 
192  obs_output_t *output,
193  const char *name0, const char *description0,
194  const char *name1, const char *description1,
196  void *data0, void *data1);
197 
199  obs_service_t *service,
200  const char *name0, const char *description0,
201  const char *name1, const char *description1,
203  void *data0, void *data1);
204 
206  obs_source_t *source,
207  const char *name0, const char *description0,
208  const char *name1, const char *description1,
210  void *data0, void *data1);
211 
213 
215 
216 /* loading hotkeys (associating a hotkey with a physical key and modifiers) */
217 
219  obs_key_combination_t *combinations, size_t num);
220 
222 
224  obs_data_t *hotkeys);
225 
226 EXPORT void obs_hotkeys_load_output(obs_output_t *output, obs_data_t *hotkeys);
227 
229  obs_data_t *hotkeys);
230 
231 EXPORT void obs_hotkeys_load_source(obs_source_t *source, obs_data_t *hotkeys);
232 
234  obs_data_array_t *data1);
235 
236 
238 
240  obs_data_array_t **p_data0,
241  obs_data_array_t **p_data1);
242 
244 
246 
248 
250 
251 /* enumerating hotkeys */
252 
253 typedef bool (*obs_hotkey_enum_func)(void *data,
254  obs_hotkey_id id, obs_hotkey_t *key);
255 
256 EXPORT void obs_enum_hotkeys(obs_hotkey_enum_func func, void *data);
257 
258 /* enumerating bindings */
259 
260 typedef bool (*obs_hotkey_binding_enum_func)(void *data,
261  size_t idx, obs_hotkey_binding_t* binding);
262 
264  void *data);
265 
266 /* hotkey event control */
267 
268 EXPORT void obs_hotkey_inject_event(obs_key_combination_t hotkey, bool pressed);
269 
271 
273 
274 /* hotkey callback routing (trigger callbacks through e.g. a UI thread) */
275 
276 typedef void (*obs_hotkey_callback_router_func)(void *data,
277  obs_hotkey_id id, bool pressed);
278 
280  func, void *data);
281 
283 
284 /* hotkey callbacks won't be processed if callback rerouting is enabled and no
285  * router func is set */
287 
288 /* misc */
289 
290 typedef void (*obs_hotkey_atomic_update_func)(void *);
292  void *data);
293 
294 struct dstr;
295 EXPORT void obs_key_to_str(obs_key_t key, struct dstr *str);
297  struct dstr *str);
298 
301 
302 EXPORT const char *obs_key_to_name(obs_key_t key);
303 EXPORT obs_key_t obs_key_from_name(const char *name);
304 
305 static inline bool obs_key_combination_is_empty(obs_key_combination_t combo)
306 {
307  return !combo.modifiers && combo.key == OBS_KEY_NONE;
308 }
309 
310 #ifdef __cplusplus
311 }
312 #endif
Definition: obs-hotkey.h:521
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:93
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:253
const char * num_lock
Definition: obs-hotkey.h:98
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:107
const char * down
Definition: obs-hotkey.h:108
const char * control
Definition: obs-hotkey.h:111
EXPORT obs_data_array_t * obs_hotkey_save(obs_hotkey_id id)
const char * apple_keypad_multiply
Definition: obs-hotkey.h:123
Definition: obs-internal.h:822
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:541
const char * numpad_num
Definition: obs-hotkey.h:115
bool(* obs_hotkey_active_func)(void *data, obs_hotkey_pair_id id, obs_hotkey_t *hotkey, bool pressed)
Definition: obs-hotkey.h:175
EXPORT void obs_hotkeys_load_source(obs_source_t *source, obs_data_t *hotkeys)
const char * scroll_lock
Definition: obs-hotkey.h:99
EXPORT void obs_hotkeys_load_output(obs_output_t *output, obs_data_t *hotkeys)
const char * numpad_multiply
Definition: obs-hotkey.h:117
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:56
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:45
EXPORT void obs_hotkeys_set_translations_s(struct obs_hotkeys_translations *translations, size_t size)
const char * print
Definition: obs-hotkey.h:103
const char * page_down
Definition: obs-hotkey.h:97
EXPORT void obs_hotkey_pair_save(obs_hotkey_pair_id id, obs_data_array_t **p_data0, obs_data_array_t **p_data1)
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:128
const char * alt
Definition: obs-hotkey.h:110
Definition: obs-internal.h:173
const char * numpad_plus
Definition: obs-hotkey.h:119
const char * end
Definition: obs-hotkey.h:95
Definition: obs-hotkey.h:91
obs_hotkey_registerer_type
Definition: obs-hotkey.h:54
const char * apple_keypad_num
Definition: obs-hotkey.h:121
#define EXPORT
Definition: c99defs.h:49
const char * apple_keypad_decimal
Definition: obs-hotkey.h:126
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:37
const char * apple_keypad_equal
Definition: obs-hotkey.h:127
obs_key_t key
Definition: obs-hotkey.h:47
const char * page_up
Definition: obs-hotkey.h:96
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:937
enum obs_key obs_key_t
Definition: obs-hotkey.h:43
const char * right
Definition: obs-hotkey.h:106
const char * tab
Definition: obs-hotkey.h:102
EXPORT obs_data_t * obs_hotkeys_save_output(obs_output_t *output)
const char * menu
Definition: obs-hotkey.h:113
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:260
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:120
void(* obs_hotkey_atomic_update_func)(void *)
Definition: obs-hotkey.h:290
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_set_description(obs_hotkey_id id, const char *desc)
EXPORT void obs_hotkey_enable_background_press(bool enable)
const char * apple_keypad_minus
Definition: obs-hotkey.h:124
const char * backspace
Definition: obs-hotkey.h:101
Definition: obs-hotkey.h:58
size_t obs_hotkey_pair_id
Definition: obs-hotkey.h:25
EXPORT void obs_hotkey_set_name(obs_hotkey_id id, const char *name)
const char * shift
Definition: obs-hotkey.h:109
void(* obs_hotkey_func)(void *data, obs_hotkey_id id, obs_hotkey_t *hotkey, bool pressed)
Definition: obs-hotkey.h:153
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:112
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:57
const char * left
Definition: obs-hotkey.h:105
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:55
EXPORT void obs_hotkey_pair_unregister(obs_hotkey_pair_id id)
EXPORT void obs_hotkey_pair_set_names(obs_hotkey_pair_id id, const char *name0, const char *name1)
uint32_t modifiers
Definition: obs-hotkey.h:46
EXPORT obs_key_t obs_key_from_name(const char *name)
const char * numpad_minus
Definition: obs-hotkey.h:118
EXPORT void obs_hotkey_unregister(obs_hotkey_id id)
EXPORT void obs_hotkey_pair_set_descriptions(obs_hotkey_pair_id id, const char *desc0, const char *desc1)
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:1022
enum obs_hotkey_registerer_type obs_hotkey_registerer_t
Definition: obs-hotkey.h:61
const char * space
Definition: obs-hotkey.h:114
const char * numpad_divide
Definition: obs-hotkey.h:116
const char * caps_lock
Definition: obs-hotkey.h:100
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:122
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:104
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:59
EXPORT void obs_hotkey_enable_callback_rerouting(bool enable)
const char * apple_keypad_plus
Definition: obs-hotkey.h:125
const char * insert
Definition: obs-hotkey.h:92
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:94
void(* obs_hotkey_callback_router_func)(void *data, obs_hotkey_id id, bool pressed)
Definition: obs-hotkey.h:276