JACK-AUDIO-CONNECTION-KIT  0.125.0rc1
control.h
Go to the documentation of this file.
1 /* -*- Mode: C ; c-basic-offset: 4 -*- */
2 /*
3  JACK control API
4 
5  Copyright (C) 2008 Nedko Arnaudov
6  Copyright (C) 2008 GRAME
7 
8  This program is free software; you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation; version 2 of the License.
11 
12  This program is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  GNU General Public License for more details.
16 
17  You should have received a copy of the GNU General Public License
18  along with this program; if not, write to the Free Software
19  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 
21 */
29 #ifndef __jack_control_h__
30 #define __jack_control_h__
31 
32 #include <jack/jslist.h>
33 
34 #if !defined (__sun__)
35 #include <stdbool.h>
36 #else
37 #ifndef bool
38 #define bool boolean_t
39 #endif
40 #ifndef false
41 #define false B_FALSE
42 #endif
43 #ifndef true
44 #define true B_TRUE
45 #endif
46 #endif
47 
49 typedef enum
50 {
57 
59 #define JACK_PARAM_MAX (JackParamBool + 1)
60 
62 #define JACK_PARAM_STRING_MAX 127
63 
65 /* intentionally similar to jack_driver_param_value_t */
67 {
68  uint32_t ui;
69  int32_t i;
70  char c;
72  bool b;
73 };
74 
76 typedef struct jackctl_server jackctl_server_t;
77 
79 typedef struct jackctl_driver jackctl_driver_t;
80 
82 typedef struct jackctl_internal jackctl_internal_t;
83 
85 typedef struct jackctl_parameter jackctl_parameter_t;
86 
87 #ifdef __cplusplus
88 extern "C" {
89 #endif
90 #if 0
91 } /* Adjust editor indent */
92 #endif
93 
108 sigset_t
110  unsigned int flags);
111 
117 void
119  sigset_t signals);
120 
133  bool (* on_device_acquire)(const char * device_name),
134  void (* on_device_release)(const char * device_name));
135 
141 void
143  jackctl_server_t * server);
144 
153 bool
155  jackctl_server_t * server,
156  jackctl_driver_t * driver);
157 
165 bool
167  jackctl_server_t * server);
168 
178 const JSList *
180  jackctl_server_t * server);
181 
191 const JSList *
193  jackctl_server_t * server);
194 
204 const JSList *
206  jackctl_server_t * server);
207 
216 bool
218  jackctl_server_t * server,
219  jackctl_internal_t * internal);
220 
229 bool
231  jackctl_server_t * server,
232  jackctl_internal_t * internal);
233 
242 bool
244  jackctl_driver_t * driver);
245 
254 bool
256  jackctl_driver_t * driver);
257 
266 bool
268  jackctl_driver_t * driver);
269 
270 
279 const char *
281  jackctl_driver_t * driver);
282 
292 const JSList *
294  jackctl_driver_t * driver);
295 
304 const char *
306  jackctl_internal_t * internal);
307 
317 const JSList *
319  jackctl_internal_t * internal);
320 
329 const char *
331  jackctl_parameter_t * parameter);
332 
341 const char *
343  jackctl_parameter_t * parameter);
344 
353 const char *
355  jackctl_parameter_t * parameter);
356 
366  jackctl_parameter_t * parameter);
367 
375 char
377  jackctl_parameter_t * parameter);
378 
388 bool
390  jackctl_parameter_t * parameter);
391 
399 bool
401  jackctl_parameter_t * parameter);
402 
412  jackctl_parameter_t * parameter);
413 
422 bool
424  jackctl_parameter_t * parameter,
425  const union jackctl_parameter_value * value_ptr);
426 
436  jackctl_parameter_t * parameter);
437 
445 bool
447  jackctl_parameter_t * parameter);
448 
456 bool
458  jackctl_parameter_t * parameter);
459 
467 uint32_t
469  jackctl_parameter_t * parameter);
470 
481  jackctl_parameter_t * parameter,
482  uint32_t index);
483 
492 const char *
494  jackctl_parameter_t * parameter,
495  uint32_t index);
496 
504 void
506  jackctl_parameter_t * parameter,
507  union jackctl_parameter_value * min_ptr,
508  union jackctl_parameter_value * max_ptr);
509 
518 bool
520  jackctl_parameter_t * parameter);
521 
531 bool
533  jackctl_parameter_t * parameter);
534 
540 void
541 jack_error(
542  const char *format,
543  ...);
544 
550 void
551 jack_info(
552  const char *format,
553  ...);
554 
561 void
562 jack_log(
563  const char *format,
564  ...);
565 
566 /* @} */
567 
568 #if 0
569 { /* Adjust editor indent */
570 #endif
571 #ifdef __cplusplus
572 } /* extern "C" */
573 #endif
574 
575 #endif /* __jack_control_h__ */
const char * jackctl_parameter_get_long_description(jackctl_parameter_t *parameter)
value type is a signed integer
Definition: control.h:51
sigset_t jackctl_setup_signals(unsigned int flags)
bool jackctl_parameter_is_set(jackctl_parameter_t *parameter)
union jackctl_parameter_value jackctl_parameter_get_value(jackctl_parameter_t *parameter)
struct jackctl_parameter jackctl_parameter_t
Definition: control.h:85
union jackctl_parameter_value jackctl_parameter_get_default_value(jackctl_parameter_t *parameter)
value type is an unsigned integer
Definition: control.h:52
void jackctl_parameter_get_range_constraint(jackctl_parameter_t *parameter, union jackctl_parameter_value *min_ptr, union jackctl_parameter_value *max_ptr)
value type is a char
Definition: control.h:53
void jack_error(const char *format,...)
jackctl_server_t * jackctl_server_create(bool(*on_device_acquire)(const char *device_name), void(*on_device_release)(const char *device_name))
char str[JACK_PARAM_STRING_MAX+1]
member used for JackParamString
Definition: control.h:71
bool jackctl_parameter_reset(jackctl_parameter_t *parameter)
uint32_t ui
member used for JackParamUInt
Definition: control.h:68
void jack_info(const char *format,...)
bool jackctl_server_switch_master(jackctl_server_t *server, jackctl_driver_t *driver)
value type is a boolean
Definition: control.h:55
bool jackctl_server_start(jackctl_server_t *server, jackctl_driver_t *driver)
const char * jackctl_internal_get_name(jackctl_internal_t *internal)
struct jackctl_internal jackctl_internal_t
Definition: control.h:82
int32_t i
member used for JackParamInt
Definition: control.h:69
const char * jackctl_parameter_get_name(jackctl_parameter_t *parameter)
bool jackctl_server_stop(jackctl_server_t *server)
bool b
member used for JackParamBool
Definition: control.h:72
Type for parameter value.
Definition: control.h:66
const JSList * jackctl_driver_get_parameters(jackctl_driver_t *driver)
value type is a string with max size of JACK_PARAM_STRING_MAX+1 chars
Definition: control.h:54
bool jackctl_parameter_has_range_constraint(jackctl_parameter_t *parameter)
bool jackctl_server_remove_slave(jackctl_server_t *server, jackctl_driver_t *driver)
const char * jackctl_parameter_get_enum_constraint_description(jackctl_parameter_t *parameter, uint32_t index)
const JSList * jackctl_server_get_internals_list(jackctl_server_t *server)
const char * jackctl_parameter_get_short_description(jackctl_parameter_t *parameter)
bool jackctl_parameter_constraint_is_fake_value(jackctl_parameter_t *parameter)
jackctl_param_type_t jackctl_parameter_get_type(jackctl_parameter_t *parameter)
struct jackctl_driver jackctl_driver_t
Definition: control.h:79
const JSList * jackctl_server_get_drivers_list(jackctl_server_t *server)
bool jackctl_parameter_constraint_is_strict(jackctl_parameter_t *parameter)
uint32_t jackctl_parameter_get_enum_constraints_count(jackctl_parameter_t *parameter)
bool jackctl_parameter_set_value(jackctl_parameter_t *parameter, const union jackctl_parameter_value *value_ptr)
bool jackctl_server_add_slave(jackctl_server_t *server, jackctl_driver_t *driver)
#define JACK_PARAM_STRING_MAX
Max length of string parameter value, excluding terminating null char.
Definition: control.h:62
jackctl_param_type_t
Definition: control.h:49
const char * jackctl_driver_get_name(jackctl_driver_t *driver)
union jackctl_parameter_value jackctl_parameter_get_enum_constraint_value(jackctl_parameter_t *parameter, uint32_t index)
bool jackctl_server_unload_internal(jackctl_server_t *server, jackctl_internal_t *internal)
char jackctl_parameter_get_id(jackctl_parameter_t *parameter)
const JSList * jackctl_internal_get_parameters(jackctl_internal_t *internal)
void jackctl_server_destroy(jackctl_server_t *server)
char c
member used for JackParamChar
Definition: control.h:70
const JSList * jackctl_server_get_parameters(jackctl_server_t *server)
bool jackctl_parameter_has_enum_constraint(jackctl_parameter_t *parameter)
struct jackctl_server jackctl_server_t
Definition: control.h:76
void jack_log(const char *format,...)
bool jackctl_server_load_internal(jackctl_server_t *server, jackctl_internal_t *internal)
void jackctl_wait_signals(sigset_t signals)