Jack2 1.9.22
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*/
28
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
48
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
74typedef struct jackctl_server jackctl_server_t;
75
77typedef struct jackctl_driver jackctl_driver_t;
78
80typedef struct jackctl_internal jackctl_internal_t;
81
83typedef struct jackctl_parameter jackctl_parameter_t;
84
86typedef struct jackctl_sigmask jackctl_sigmask_t;
87
88#ifdef __cplusplus
89extern "C" {
90#endif
91#if 0
92} /* Adjust editor indent */
93#endif
94
99
111 unsigned int flags);
112
118void
120 jackctl_sigmask_t * signals);
121
130 bool (* on_device_acquire)(const char * device_name),
131 void (* on_device_release)(const char * device_name));
132
146 bool (* on_device_acquire)(const char * device_name),
147 void (* on_device_release)(const char * device_name),
148 void (* on_device_reservation_loop)(void));
149
155void
157 jackctl_server_t * server);
158
167bool
169 jackctl_server_t * server,
170 jackctl_driver_t * driver);
171
179bool
181 jackctl_server_t * server);
182
190bool
192 jackctl_server_t * server);
193
201bool
203 jackctl_server_t * server);
204
214const JSList *
216 jackctl_server_t * server);
217
227const JSList *
229 jackctl_server_t * server);
230
240const JSList *
242 jackctl_server_t * server);
243
253bool
255 jackctl_server_t * server,
256 jackctl_internal_t * internal);
257
267bool
269 jackctl_server_t * server,
270 jackctl_internal_t * internal);
271
283 jackctl_server_t * server_ptr,
284 const char * file);
285
296bool
298 jackctl_driver_t * driver);
299
310bool
312 jackctl_driver_t * driver);
313
322bool
324 jackctl_driver_t * driver);
325
326
335const char *
337 jackctl_driver_t * driver);
338
349 jackctl_driver_t * driver);
350
360const JSList *
362 jackctl_driver_t * driver);
363
373int
375 jackctl_driver_t * driver,
376 int argc,
377 char* argv[]);
378
387const char *
389 jackctl_internal_t * internal);
390
400const JSList *
402 jackctl_internal_t * internal);
403
412const char *
414 jackctl_parameter_t * parameter);
415
424const char *
426 jackctl_parameter_t * parameter);
427
436const char *
438 jackctl_parameter_t * parameter);
439
449 jackctl_parameter_t * parameter);
450
458char
460 jackctl_parameter_t * parameter);
461
471bool
473 jackctl_parameter_t * parameter);
474
482bool
484 jackctl_parameter_t * parameter);
485
495 jackctl_parameter_t * parameter);
496
505bool
507 jackctl_parameter_t * parameter,
508 const union jackctl_parameter_value * value_ptr);
509
519 jackctl_parameter_t * parameter);
520
528bool
530 jackctl_parameter_t * parameter);
531
539bool
541 jackctl_parameter_t * parameter);
542
550uint32_t
552 jackctl_parameter_t * parameter);
553
564 jackctl_parameter_t * parameter,
565 uint32_t index);
566
575const char *
577 jackctl_parameter_t * parameter,
578 uint32_t index);
579
587void
589 jackctl_parameter_t * parameter,
590 union jackctl_parameter_value * min_ptr,
591 union jackctl_parameter_value * max_ptr);
592
601bool
603 jackctl_parameter_t * parameter);
604
614bool
616 jackctl_parameter_t * parameter);
617
623void
625 const char *format,
626 ...);
627
633void
635 const char *format,
636 ...);
637
644void
646 const char *format,
647 ...);
648
650
651#if 0
652{ /* Adjust editor indent */
653#endif
654#ifdef __cplusplus
655} /* extern "C" */
656#endif
657
658#endif /* #ifndef JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED */
struct jackctl_server jackctl_server_t
Definition control.h:74
jackctl_driver_type_t
Definition control.h:51
@ JackSlave
slave driver
Definition control.h:53
@ JackMaster
master driver
Definition control.h:52
#define JACK_PARAM_STRING_MAX
Max length of string parameter value, excluding terminating null char.
Definition control.h:60
struct jackctl_parameter jackctl_parameter_t
Definition control.h:83
struct jackctl_sigmask jackctl_sigmask_t
Definition control.h:86
struct jackctl_internal jackctl_internal_t
Definition control.h:80
jackctl_param_type_t
Definition control.h:41
@ JackParamInt
value type is a signed integer
Definition control.h:42
@ JackParamUInt
value type is an unsigned integer
Definition control.h:43
@ JackParamBool
value type is a boolean
Definition control.h:46
@ JackParamChar
value type is a char
Definition control.h:44
@ JackParamString
value type is a string with max size of JACK_PARAM_STRING_MAX+1 chars
Definition control.h:45
struct jackctl_driver jackctl_driver_t
Definition control.h:77
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:65
int32_t i
member used for JackParamInt
Definition control.h:67
char str[JACK_PARAM_STRING_MAX+1]
member used for JackParamString
Definition control.h:69
char c
member used for JackParamChar
Definition control.h:68
bool b
member used for JackParamBool
Definition control.h:70
uint32_t ui
member used for JackParamUInt
Definition control.h:66