Jack2 1.9.22
control.h
Go to the documentation of this file.
1/* -*- Mode: C ; c-basic-offset: 4 -*- */
2/* JACK server control API */
3/* SPDX-FileCopyrightText: 2008-2023 Nedko Arnaudov */
4/* SPDX-FileCopyrightText: 2008-2023 Grame */
5/* SPDX-License-Identifier: ( GPL-2.0-or-later OR LGPL-2.1-or-later OR MIT OR AFL-2.1 ) */
13#ifndef JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED
14#define JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED
15
16#include <jack/types.h>
17#include <jack/jslist.h>
18#include <jack/systemdeps.h>
19#if !defined(sun) && !defined(__sun__)
20#include <stdbool.h>
21#endif
22
32
39
41#define JACK_PARAM_MAX (JackParamBool + 1)
42
44#define JACK_PARAM_STRING_MAX 127
45
47/* intentionally similar to jack_driver_param_value_t */
49{
50 uint32_t ui;
51 int32_t i;
52 char c;
54 bool b;
55};
56
58typedef struct jackctl_server jackctl_server_t;
59
61typedef struct jackctl_driver jackctl_driver_t;
62
64typedef struct jackctl_internal jackctl_internal_t;
65
67typedef struct jackctl_parameter jackctl_parameter_t;
68
70typedef struct jackctl_sigmask jackctl_sigmask_t;
71
72#ifdef __cplusplus
73extern "C" {
74#endif
75#if 0
76} /* Adjust editor indent */
77#endif
78
95 unsigned int flags);
96
102void
104 jackctl_sigmask_t * signals);
105
114 bool (* on_device_acquire)(const char * device_name),
115 void (* on_device_release)(const char * device_name));
116
130 bool (* on_device_acquire)(const char * device_name),
131 void (* on_device_release)(const char * device_name),
132 void (* on_device_reservation_loop)(void));
133
139void
141 jackctl_server_t * server);
142
151bool
153 jackctl_server_t * server,
154 jackctl_driver_t * driver);
155
163bool
165 jackctl_server_t * server);
166
174bool
176 jackctl_server_t * server);
177
185bool
187 jackctl_server_t * server);
188
198const JSList *
200 jackctl_server_t * server);
201
211const JSList *
213 jackctl_server_t * server);
214
224const JSList *
226 jackctl_server_t * server);
227
237bool
239 jackctl_server_t * server,
240 jackctl_internal_t * internal);
241
251bool
253 jackctl_server_t * server,
254 jackctl_internal_t * internal);
255
267 jackctl_server_t * server_ptr,
268 const char * file);
269
280bool
282 jackctl_driver_t * driver);
283
294bool
296 jackctl_driver_t * driver);
297
306bool
308 jackctl_driver_t * driver);
309
310
319const char *
321 jackctl_driver_t * driver);
322
333 jackctl_driver_t * driver);
334
344const JSList *
346 jackctl_driver_t * driver);
347
357int
359 jackctl_driver_t * driver,
360 int argc,
361 char* argv[]);
362
371const char *
373 jackctl_internal_t * internal);
374
384const JSList *
386 jackctl_internal_t * internal);
387
396const char *
398 jackctl_parameter_t * parameter);
399
408const char *
410 jackctl_parameter_t * parameter);
411
420const char *
422 jackctl_parameter_t * parameter);
423
433 jackctl_parameter_t * parameter);
434
442char
444 jackctl_parameter_t * parameter);
445
455bool
457 jackctl_parameter_t * parameter);
458
466bool
468 jackctl_parameter_t * parameter);
469
479 jackctl_parameter_t * parameter);
480
489bool
491 jackctl_parameter_t * parameter,
492 const union jackctl_parameter_value * value_ptr);
493
503 jackctl_parameter_t * parameter);
504
512bool
514 jackctl_parameter_t * parameter);
515
523bool
525 jackctl_parameter_t * parameter);
526
534uint32_t
536 jackctl_parameter_t * parameter);
537
548 jackctl_parameter_t * parameter,
549 uint32_t index);
550
559const char *
561 jackctl_parameter_t * parameter,
562 uint32_t index);
563
571void
573 jackctl_parameter_t * parameter,
574 union jackctl_parameter_value * min_ptr,
575 union jackctl_parameter_value * max_ptr);
576
585bool
587 jackctl_parameter_t * parameter);
588
598bool
600 jackctl_parameter_t * parameter);
601
607void
609 const char *format,
610 ...);
611
617void
619 const char *format,
620 ...);
621
628void
630 const char *format,
631 ...);
632
635#if 0
636{ /* Adjust editor indent */
637#endif
638#ifdef __cplusplus
639} /* extern "C" */
640#endif
641
642#endif /* #ifndef JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED */
struct jackctl_server jackctl_server_t
Definition control.h:58
jackctl_driver_type_t
Definition control.h:35
@ JackSlave
slave driver
Definition control.h:37
@ JackMaster
master driver
Definition control.h:36
#define JACK_PARAM_STRING_MAX
Max length of string parameter value, excluding terminating null char.
Definition control.h:44
struct jackctl_parameter jackctl_parameter_t
Definition control.h:67
struct jackctl_sigmask jackctl_sigmask_t
Definition control.h:70
struct jackctl_internal jackctl_internal_t
Definition control.h:64
jackctl_param_type_t
Definition control.h:25
@ JackParamInt
value type is a signed integer
Definition control.h:26
@ JackParamUInt
value type is an unsigned integer
Definition control.h:27
@ JackParamBool
value type is a boolean
Definition control.h:30
@ JackParamChar
value type is a char
Definition control.h:28
@ JackParamString
value type is a string with max size of JACK_PARAM_STRING_MAX+1 chars
Definition control.h:29
struct jackctl_driver jackctl_driver_t
Definition control.h:61
const JSList * jackctl_server_get_internals_list(jackctl_server_t *server)
const char * jackctl_parameter_get_name(jackctl_parameter_t *parameter)
const char * jackctl_parameter_get_long_description(jackctl_parameter_t *parameter)
union jackctl_parameter_value jackctl_parameter_get_enum_constraint_value(jackctl_parameter_t *parameter, uint32_t index)
void jackctl_parameter_get_range_constraint(jackctl_parameter_t *parameter, union jackctl_parameter_value *min_ptr, union jackctl_parameter_value *max_ptr)
uint32_t jackctl_parameter_get_enum_constraints_count(jackctl_parameter_t *parameter)
int jackctl_driver_params_parse(jackctl_driver_t *driver, int argc, char *argv[])
bool jackctl_server_load_session_file(jackctl_server_t *server_ptr, const char *file)
void jack_info(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))
void jackctl_wait_signals(jackctl_sigmask_t *signals)
const JSList * jackctl_driver_get_parameters(jackctl_driver_t *driver)
bool jackctl_server_load_internal(jackctl_server_t *server, jackctl_internal_t *internal)
void jack_log(const char *format,...)
jackctl_param_type_t jackctl_parameter_get_type(jackctl_parameter_t *parameter)
const char * jackctl_parameter_get_enum_constraint_description(jackctl_parameter_t *parameter, uint32_t index)
bool jackctl_server_switch_master(jackctl_server_t *server, jackctl_driver_t *driver)
const char * jackctl_parameter_get_short_description(jackctl_parameter_t *parameter)
bool jackctl_parameter_is_set(jackctl_parameter_t *parameter)
jackctl_driver_type_t jackctl_driver_get_type(jackctl_driver_t *driver)
const JSList * jackctl_server_get_parameters(jackctl_server_t *server)
bool jackctl_parameter_has_enum_constraint(jackctl_parameter_t *parameter)
const char * jackctl_internal_get_name(jackctl_internal_t *internal)
const JSList * jackctl_internal_get_parameters(jackctl_internal_t *internal)
char jackctl_parameter_get_id(jackctl_parameter_t *parameter)
union jackctl_parameter_value jackctl_parameter_get_value(jackctl_parameter_t *parameter)
bool jackctl_server_start(jackctl_server_t *server)
union jackctl_parameter_value jackctl_parameter_get_default_value(jackctl_parameter_t *parameter)
jackctl_server_t * jackctl_server_create2(bool(*on_device_acquire)(const char *device_name), void(*on_device_release)(const char *device_name), void(*on_device_reservation_loop)(void))
const char * jackctl_driver_get_name(jackctl_driver_t *driver)
bool jackctl_server_close(jackctl_server_t *server)
void jackctl_server_destroy(jackctl_server_t *server)
bool jackctl_parameter_set_value(jackctl_parameter_t *parameter, const union jackctl_parameter_value *value_ptr)
bool jackctl_server_unload_internal(jackctl_server_t *server, jackctl_internal_t *internal)
bool jackctl_parameter_constraint_is_strict(jackctl_parameter_t *parameter)
void jack_error(const char *format,...)
bool jackctl_server_remove_slave(jackctl_server_t *server, jackctl_driver_t *driver)
bool jackctl_parameter_reset(jackctl_parameter_t *parameter)
bool jackctl_server_open(jackctl_server_t *server, jackctl_driver_t *driver)
const JSList * jackctl_server_get_drivers_list(jackctl_server_t *server)
bool jackctl_server_add_slave(jackctl_server_t *server, jackctl_driver_t *driver)
jackctl_sigmask_t * jackctl_setup_signals(unsigned int flags)
bool jackctl_parameter_has_range_constraint(jackctl_parameter_t *parameter)
bool jackctl_server_stop(jackctl_server_t *server)
bool jackctl_parameter_constraint_is_fake_value(jackctl_parameter_t *parameter)
Type for parameter value.
Definition control.h:49
int32_t i
member used for JackParamInt
Definition control.h:51
char str[JACK_PARAM_STRING_MAX+1]
member used for JackParamString
Definition control.h:53
char c
member used for JackParamChar
Definition control.h:52
bool b
member used for JackParamBool
Definition control.h:54
uint32_t ui
member used for JackParamUInt
Definition control.h:50