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 #include <stdbool.h>
35 
37 typedef enum
38 {
45 
47 #define JACK_PARAM_MAX (JackParamBool + 1)
48 
50 #define JACK_PARAM_STRING_MAX 127
51 
53 /* intentionally similar to jack_driver_param_value_t */
55 {
56  uint32_t ui;
57  int32_t i;
58  char c;
60  bool b;
61 };
62 
64 typedef struct jackctl_server jackctl_server_t;
65 
67 typedef struct jackctl_driver jackctl_driver_t;
68 
70 typedef struct jackctl_internal jackctl_internal_t;
71 
73 typedef struct jackctl_parameter jackctl_parameter_t;
74 
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78 #if 0
79 } /* Adjust editor indent */
80 #endif
81 
96 sigset_t
98  unsigned int flags);
99 
105 void
107  sigset_t signals);
108 
121  bool (* on_device_acquire)(const char * device_name),
122  void (* on_device_release)(const char * device_name));
123 
129 void
131  jackctl_server_t * server);
132 
141 bool
143  jackctl_server_t * server,
144  jackctl_driver_t * driver);
145 
153 bool
155  jackctl_server_t * server);
156 
166 const JSList *
168  jackctl_server_t * server);
169 
179 const JSList *
181  jackctl_server_t * server);
182 
192 const JSList *
194  jackctl_server_t * server);
195 
204 bool
206  jackctl_server_t * server,
207  jackctl_internal_t * internal);
208 
217 bool
219  jackctl_server_t * server,
220  jackctl_internal_t * internal);
221 
230 bool
232  jackctl_driver_t * driver);
233 
242 bool
244  jackctl_driver_t * driver);
245 
254 bool
256  jackctl_driver_t * driver);
257 
258 
267 const char *
269  jackctl_driver_t * driver);
270 
280 const JSList *
282  jackctl_driver_t * driver);
283 
292 const char *
294  jackctl_internal_t * internal);
295 
305 const JSList *
307  jackctl_internal_t * internal);
308 
317 const char *
319  jackctl_parameter_t * parameter);
320 
329 const char *
331  jackctl_parameter_t * parameter);
332 
341 const char *
343  jackctl_parameter_t * parameter);
344 
354  jackctl_parameter_t * parameter);
355 
363 char
365  jackctl_parameter_t * parameter);
366 
376 bool
378  jackctl_parameter_t * parameter);
379 
387 bool
389  jackctl_parameter_t * parameter);
390 
400  jackctl_parameter_t * parameter);
401 
410 bool
412  jackctl_parameter_t * parameter,
413  const union jackctl_parameter_value * value_ptr);
414 
424  jackctl_parameter_t * parameter);
425 
433 bool
435  jackctl_parameter_t * parameter);
436 
444 bool
446  jackctl_parameter_t * parameter);
447 
455 uint32_t
457  jackctl_parameter_t * parameter);
458 
469  jackctl_parameter_t * parameter,
470  uint32_t index);
471 
480 const char *
482  jackctl_parameter_t * parameter,
483  uint32_t index);
484 
492 void
494  jackctl_parameter_t * parameter,
495  union jackctl_parameter_value * min_ptr,
496  union jackctl_parameter_value * max_ptr);
497 
506 bool
508  jackctl_parameter_t * parameter);
509 
519 bool
521  jackctl_parameter_t * parameter);
522 
528 void
529 jack_error(
530  const char *format,
531  ...);
532 
538 void
539 jack_info(
540  const char *format,
541  ...);
542 
549 void
550 jack_log(
551  const char *format,
552  ...);
553 
554 /* @} */
555 
556 #if 0
557 { /* Adjust editor indent */
558 #endif
559 #ifdef __cplusplus
560 } /* extern "C" */
561 #endif
562 
563 #endif /* __jack_control_h__ */
const char * jackctl_parameter_get_long_description(jackctl_parameter_t *parameter)
value type is a signed integer
Definition: control.h:39
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:73
union jackctl_parameter_value jackctl_parameter_get_default_value(jackctl_parameter_t *parameter)
value type is an unsigned integer
Definition: control.h:40
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:41
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:59
bool jackctl_parameter_reset(jackctl_parameter_t *parameter)
uint32_t ui
member used for JackParamUInt
Definition: control.h:56
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:43
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:70
int32_t i
member used for JackParamInt
Definition: control.h:57
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:60
Type for parameter value.
Definition: control.h:54
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:42
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:67
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:50
jackctl_param_type_t
Definition: control.h:37
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:58
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:64
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)