Jack2  1.9.12
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 JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED
30 #define JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED
31 
32 #include <jack/types.h>
33 #include <jack/jslist.h>
34 #include <jack/systemdeps.h>
35 #if !defined(sun) && !defined(__sun__)
36 #include <stdbool.h>
37 #endif
38 
40 typedef enum
41 {
48 
50 typedef enum
51 {
52  JackMaster = 1,
55 
57 #define JACK_PARAM_MAX (JackParamBool + 1)
58 
60 #define JACK_PARAM_STRING_MAX 127
61 
63 /* intentionally similar to jack_driver_param_value_t */
65 {
66  uint32_t ui;
67  int32_t i;
68  char c;
70  bool b;
71 };
72 
74 typedef struct jackctl_server jackctl_server_t;
75 
77 typedef struct jackctl_driver jackctl_driver_t;
78 
80 typedef struct jackctl_internal jackctl_internal_t;
81 
83 typedef struct jackctl_parameter jackctl_parameter_t;
84 
86 typedef struct jackctl_sigmask jackctl_sigmask_t;
87 
88 #ifdef __cplusplus
89 extern "C" {
90 #endif
91 #if 0
92 } /* Adjust editor indent */
93 #endif
94 
111  unsigned int flags);
112 
118 void
120  jackctl_sigmask_t * signals);
121 
134  bool (* on_device_acquire)(const char * device_name),
135  void (* on_device_release)(const char * device_name));
136 
142 void
144  jackctl_server_t * server);
145 
154 bool
156  jackctl_server_t * server,
157  jackctl_driver_t * driver);
158 
166 bool
168  jackctl_server_t * server);
169 
177 bool
179  jackctl_server_t * server);
180 
188 bool
190  jackctl_server_t * server);
191 
201 const JSList *
203  jackctl_server_t * server);
204 
214 const JSList *
216  jackctl_server_t * server);
217 
227 const JSList *
229  jackctl_server_t * server);
230 
240 bool
242  jackctl_server_t * server,
243  jackctl_internal_t * internal);
244 
254 bool
256  jackctl_server_t * server,
257  jackctl_internal_t * internal);
258 
270  jackctl_server_t * server_ptr,
271  const char * file);
272 
283 bool
285  jackctl_driver_t * driver);
286 
297 bool
299  jackctl_driver_t * driver);
300 
309 bool
311  jackctl_driver_t * driver);
312 
313 
322 const char *
324  jackctl_driver_t * driver);
325 
336  jackctl_driver_t * driver);
337 
347 const JSList *
349  jackctl_driver_t * driver);
350 
360 int
362  jackctl_driver_t * driver,
363  int argc,
364  char* argv[]);
365 
374 const char *
376  jackctl_internal_t * internal);
377 
387 const JSList *
389  jackctl_internal_t * internal);
390 
399 const char *
401  jackctl_parameter_t * parameter);
402 
411 const char *
413  jackctl_parameter_t * parameter);
414 
423 const char *
425  jackctl_parameter_t * parameter);
426 
436  jackctl_parameter_t * parameter);
437 
445 char
447  jackctl_parameter_t * parameter);
448 
458 bool
460  jackctl_parameter_t * parameter);
461 
469 bool
471  jackctl_parameter_t * parameter);
472 
482  jackctl_parameter_t * parameter);
483 
492 bool
494  jackctl_parameter_t * parameter,
495  const union jackctl_parameter_value * value_ptr);
496 
506  jackctl_parameter_t * parameter);
507 
515 bool
517  jackctl_parameter_t * parameter);
518 
526 bool
528  jackctl_parameter_t * parameter);
529 
537 uint32_t
539  jackctl_parameter_t * parameter);
540 
551  jackctl_parameter_t * parameter,
552  uint32_t index);
553 
562 const char *
564  jackctl_parameter_t * parameter,
565  uint32_t index);
566 
574 void
576  jackctl_parameter_t * parameter,
577  union jackctl_parameter_value * min_ptr,
578  union jackctl_parameter_value * max_ptr);
579 
588 bool
590  jackctl_parameter_t * parameter);
591 
601 bool
603  jackctl_parameter_t * parameter);
604 
610 void
611 jack_error(
612  const char *format,
613  ...);
614 
620 void
621 jack_info(
622  const char *format,
623  ...);
624 
631 void
632 jack_log(
633  const char *format,
634  ...);
635 
636 /* @} */
637 
638 #if 0
639 { /* Adjust editor indent */
640 #endif
641 #ifdef __cplusplus
642 } /* extern "C" */
643 #endif
644 
645 #endif /* #ifndef JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED */
const char * jackctl_parameter_get_long_description(jackctl_parameter_t *parameter)
jackctl_driver_type_t
Definition: control.h:50
value type is a signed integer
Definition: control.h:42
int jackctl_driver_params_parse(jackctl_driver_t *driver, int argc, char *argv[])
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:83
jackctl_sigmask_t * jackctl_setup_signals(unsigned int flags)
union jackctl_parameter_value jackctl_parameter_get_default_value(jackctl_parameter_t *parameter)
value type is an unsigned integer
Definition: control.h:43
bool jackctl_server_open(jackctl_server_t *server, jackctl_driver_t *driver)
struct jackctl_sigmask jackctl_sigmask_t
Definition: control.h:86
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:44
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:69
bool jackctl_parameter_reset(jackctl_parameter_t *parameter)
uint32_t ui
member used for JackParamUInt
Definition: control.h:66
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:46
const char * jackctl_internal_get_name(jackctl_internal_t *internal)
struct jackctl_internal jackctl_internal_t
Definition: control.h:80
master driver
Definition: control.h:52
int32_t i
member used for JackParamInt
Definition: control.h:67
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:70
Type for parameter value.
Definition: control.h:64
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:45
bool jackctl_parameter_has_range_constraint(jackctl_parameter_t *parameter)
bool jackctl_server_close(jackctl_server_t *server)
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)
slave driver
Definition: control.h:53
struct jackctl_driver jackctl_driver_t
Definition: control.h:77
const JSList * jackctl_server_get_drivers_list(jackctl_server_t *server)
bool jackctl_server_start(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:60
bool jackctl_server_load_session_file(jackctl_server_t *server_ptr, const char *file)
jackctl_param_type_t
Definition: control.h:40
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)
jackctl_driver_type_t jackctl_driver_get_type(jackctl_driver_t *driver)
char c
member used for JackParamChar
Definition: control.h:68
const JSList * jackctl_server_get_parameters(jackctl_server_t *server)
bool jackctl_parameter_has_enum_constraint(jackctl_parameter_t *parameter)
Definition: jslist.h:38
struct jackctl_server jackctl_server_t
Definition: control.h:74
void jackctl_wait_signals(jackctl_sigmask_t *signals)
void jack_log(const char *format,...)
bool jackctl_server_load_internal(jackctl_server_t *server, jackctl_internal_t *internal)

Generated for Jack2 by doxygen 1.8.14