4 Copyright (C) 2008 Nedko Arnaudov
5 Copyright (C) 2008 Grame
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; version 2 of the License.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #ifndef __JackControlAPI__
23 #define __JackControlAPI__
26 #include "JackCompilerDeps.h"
30 #include <sys/types.h>
32 typedef HANDLE sigset_t
;
36 /** Parameter types, intentionally similar to jack_driver_param_type_t */
39 JackParamInt
= 1, /**< @brief value type is a signed integer */
40 JackParamUInt
, /**< @brief value type is an unsigned integer */
41 JackParamChar
, /**< @brief value type is a char */
42 JackParamString
, /**< @brief value type is a string with max size of ::JACK_PARAM_STRING_MAX+1 chars */
43 JackParamBool
, /**< @brief value type is a boolean */
44 } jackctl_param_type_t
;
46 /** @brief Max value that jackctl_param_type_t type can have */
47 #define JACK_PARAM_MAX (JackParamBool + 1)
49 /** @brief Max length of string parameter value, excluding terminating nul char */
50 #define JACK_PARAM_STRING_MAX 63
52 /** @brief Type for parameter value */
53 /* intentionally similar to jack_driver_param_value_t */
54 union jackctl_parameter_value
56 uint32_t ui
; /**< @brief member used for ::JackParamUInt */
57 int32_t i
; /**< @brief member used for ::JackParamInt */
58 char c
; /**< @brief member used for ::JackParamChar */
59 char str
[JACK_PARAM_STRING_MAX
+ 1]; /**< @brief member used for ::JackParamString */
60 bool b
; /**< @brief member used for ::JackParamBool */
63 /** opaque type for server object */
64 typedef struct jackctl_server jackctl_server_t
;
66 /** opaque type for driver object */
67 typedef struct jackctl_driver jackctl_driver_t
;
69 /** opaque type for internal client object */
70 typedef struct jackctl_internal jackctl_internal_t
;
72 /** opaque type for parameter object */
73 typedef struct jackctl_parameter jackctl_parameter_t
;
79 } /* Adjust editor indent */
83 jackctl_setup_signals(
90 EXPORT jackctl_server_t
*
91 jackctl_server_create(
92 bool (* on_device_acquire
)(const char * device_name
),
93 void (* on_device_release
)(const char * device_name
));
96 jackctl_server_destroy(
97 jackctl_server_t
* server
);
100 jackctl_server_get_drivers_list(
101 jackctl_server_t
* server
);
104 jackctl_server_start(
105 jackctl_server_t
* server
,
106 jackctl_driver_t
* driver
);
110 jackctl_server_t
* server
);
112 EXPORT
const JSList
*
113 jackctl_server_get_parameters(
114 jackctl_server_t
* server
);
117 jackctl_driver_get_name(
118 jackctl_driver_t
* driver
);
120 EXPORT
const JSList
*
121 jackctl_driver_get_parameters(
122 jackctl_driver_t
* driver
);
125 jackctl_parameter_get_name(
126 jackctl_parameter_t
* parameter
);
129 jackctl_parameter_get_short_description(
130 jackctl_parameter_t
* parameter
);
133 jackctl_parameter_get_long_description(
134 jackctl_parameter_t
* parameter
);
136 EXPORT jackctl_param_type_t
137 jackctl_parameter_get_type(
138 jackctl_parameter_t
* parameter
);
141 jackctl_parameter_get_id(
142 jackctl_parameter_t
* parameter
);
145 jackctl_parameter_is_set(
146 jackctl_parameter_t
* parameter
);
149 jackctl_parameter_reset(
150 jackctl_parameter_t
* parameter
);
152 EXPORT
union jackctl_parameter_value
153 jackctl_parameter_get_value(
154 jackctl_parameter_t
* parameter
);
157 jackctl_parameter_set_value(
158 jackctl_parameter_t
* parameter
,
159 const union jackctl_parameter_value
* value_ptr
);
161 EXPORT
union jackctl_parameter_value
162 jackctl_parameter_get_default_value(
163 jackctl_parameter_t
* parameter
);
165 EXPORT
union jackctl_parameter_value
166 jackctl_parameter_get_default_value(
167 jackctl_parameter
*parameter_ptr
);
170 jackctl_parameter_has_range_constraint(
171 jackctl_parameter_t
* parameter_ptr
);
174 jackctl_parameter_has_enum_constraint(
175 jackctl_parameter_t
* parameter_ptr
);
178 jackctl_parameter_get_enum_constraints_count(
179 jackctl_parameter_t
* parameter_ptr
);
181 EXPORT
union jackctl_parameter_value
182 jackctl_parameter_get_enum_constraint_value(
183 jackctl_parameter_t
* parameter_ptr
,
187 jackctl_parameter_get_enum_constraint_description(
188 jackctl_parameter_t
* parameter_ptr
,
192 jackctl_parameter_get_range_constraint(
193 jackctl_parameter_t
* parameter_ptr
,
194 union jackctl_parameter_value
* min_ptr
,
195 union jackctl_parameter_value
* max_ptr
);
198 jackctl_parameter_constraint_is_strict(
199 jackctl_parameter_t
* parameter_ptr
);
202 jackctl_parameter_constraint_is_fake_value(
203 jackctl_parameter_t
* parameter_ptr
);
205 EXPORT
const JSList
*
206 jackctl_server_get_internals_list(
207 jackctl_server
*server_ptr
);
210 jackctl_internal_get_name(
211 jackctl_internal
*internal_ptr
);
213 EXPORT
const JSList
*
214 jackctl_internal_get_parameters(
215 jackctl_internal
*internal_ptr
);
217 EXPORT
bool jackctl_server_load_internal(
218 jackctl_server
* server
,
219 jackctl_internal
* internal
);
221 EXPORT
bool jackctl_server_unload_internal(
222 jackctl_server
* server
,
223 jackctl_internal
* internal
);
225 EXPORT
bool jackctl_server_add_slave(jackctl_server_t
* server
,
226 jackctl_driver_t
* driver
);
228 EXPORT
bool jackctl_server_remove_slave(jackctl_server_t
* server
,
229 jackctl_driver_t
* driver
);
232 jackctl_server_switch_master(jackctl_server_t
* server
,
233 jackctl_driver_t
* driver
);
236 { /* Adjust editor indent */