2 Copyright (C) 2001 Paul Davis
3 Copyright (C) 2004-2013 Grame
4 Copyright (C) 2016-2019 Grame
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
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.
26 #include <sys/types.h>
35 #include "JackConstants.h"
36 #include "JackPlatformPlug.h"
38 #include "JackControlAPIAndroid.h"
41 #if defined(JACK_DBUS) && defined(__linux__)
43 #include <dbus/dbus.h>
44 #include "audio_reserve.h"
48 #include <systemd/sd-daemon.h>
52 This is a simple port of the old jackdmp.cpp file to use the new jack2 control API. Available options for the server
53 are "hard-coded" in the source. A much better approach would be to use the control API to:
54 - dynamically retrieve available server parameters and then prepare to parse them
55 - get available drivers and their possible parameters, then prepare to parse them.
59 #include <CoreFoundation/CFNotificationCenter.h>
60 #include <CoreFoundation/CoreFoundation.h>
62 static void notify_server_start(const char* server_name
)
64 // Send notification to be used in the JackRouter plugin
65 CFStringRef ref
= CFStringCreateWithCString(NULL
, server_name
, kCFStringEncodingMacRoman
);
66 CFNotificationCenterPostNotificationWithOptions(CFNotificationCenterGetDistributedCenter(),
67 CFSTR("com.grame.jackserver.start"),
70 kCFNotificationDeliverImmediately
| kCFNotificationPostToAllSessions
);
74 static void notify_server_stop(const char* server_name
)
76 // Send notification to be used in the JackRouter plugin
77 CFStringRef ref1
= CFStringCreateWithCString(NULL
, server_name
, kCFStringEncodingMacRoman
);
78 CFNotificationCenterPostNotificationWithOptions(CFNotificationCenterGetDistributedCenter(),
79 CFSTR("com.grame.jackserver.stop"),
82 kCFNotificationDeliverImmediately
| kCFNotificationPostToAllSessions
);
88 static void notify_server_start(const char* server_name
)
90 static void notify_server_stop(const char* server_name
)
95 static void copyright(FILE* file
)
97 fprintf(file
, "jackdmp " VERSION
"\n"
98 "Copyright 2001-2005 Paul Davis and others.\n"
99 "Copyright 2004-2016 Grame.\n"
100 "Copyright 2016-2021 Filipe Coelho.\n"
101 "jackdmp comes with ABSOLUTELY NO WARRANTY\n"
102 "This is free software, and you are welcome to redistribute it\n"
103 "under certain conditions; see the file COPYING for details\n");
106 static jackctl_driver_t
* jackctl_server_get_driver(jackctl_server_t
*server
, const char *driver_name
)
108 const JSList
* node_ptr
= jackctl_server_get_drivers_list(server
);
111 if (strcmp(jackctl_driver_get_name((jackctl_driver_t
*)node_ptr
->data
), driver_name
) == 0) {
112 return (jackctl_driver_t
*)node_ptr
->data
;
114 node_ptr
= jack_slist_next(node_ptr
);
120 static jackctl_internal_t
* jackctl_server_get_internal(jackctl_server_t
*server
, const char *internal_name
)
122 const JSList
* node_ptr
= jackctl_server_get_internals_list(server
);
125 if (strcmp(jackctl_internal_get_name((jackctl_internal_t
*)node_ptr
->data
), internal_name
) == 0) {
126 return (jackctl_internal_t
*)node_ptr
->data
;
128 node_ptr
= jack_slist_next(node_ptr
);
134 static jackctl_parameter_t
* jackctl_get_parameter(const JSList
* parameters_list
, const char * parameter_name
)
136 while (parameters_list
) {
137 if (strcmp(jackctl_parameter_get_name((jackctl_parameter_t
*)parameters_list
->data
), parameter_name
) == 0) {
138 return (jackctl_parameter_t
*)parameters_list
->data
;
140 parameters_list
= jack_slist_next(parameters_list
);
147 static void jackctl_server_switch_master_dummy(jackctl_server_t
* server_ctl
, char * master_driver_name
)
149 static bool is_dummy_driver
= false;
150 if(!strcmp(master_driver_name
, "dummy")) {
153 jackctl_driver_t
* driver_ctr
;
154 if(is_dummy_driver
) {
155 is_dummy_driver
= false;
156 driver_ctr
= jackctl_server_get_driver(server_ctl
, master_driver_name
);
158 is_dummy_driver
= true;
159 driver_ctr
= jackctl_server_get_driver(server_ctl
, "dummy");
161 jackctl_server_switch_master(server_ctl
, driver_ctr
);
165 static void print_server_drivers(jackctl_server_t
*server
, FILE* file
)
167 const JSList
* node_ptr
= jackctl_server_get_drivers_list(server
);
169 fprintf(file
, "Available backends:\n");
172 jackctl_driver_t
* driver
= (jackctl_driver_t
*)node_ptr
->data
;
173 fprintf(file
, " %s (%s)\n", jackctl_driver_get_name(driver
), (jackctl_driver_get_type(driver
) == JackMaster
) ? "master" : "slave");
174 node_ptr
= jack_slist_next(node_ptr
);
179 static void print_server_internals(jackctl_server_t
*server
, FILE* file
)
181 const JSList
* node_ptr
= jackctl_server_get_internals_list(server
);
183 fprintf(file
, "Available internals:\n");
186 jackctl_internal_t
* internal
= (jackctl_internal_t
*)node_ptr
->data
;
187 fprintf(file
, " %s\n", jackctl_internal_get_name(internal
));
188 node_ptr
= jack_slist_next(node_ptr
);
193 static void usage(FILE* file
, jackctl_server_t
*server
, bool full
= true)
195 jackctl_parameter_t
* param
;
196 const JSList
* server_parameters
;
198 union jackctl_parameter_value value
;
201 "Usage: jackdmp [ --no-realtime OR -r ]\n"
202 " [ --realtime OR -R [ --realtime-priority OR -P priority ] ]\n"
203 " (the two previous arguments are mutually exclusive. The default is --realtime)\n"
204 " [ --name OR -n server-name ]\n"
205 " [ --timeout OR -t client-timeout-in-msecs ]\n"
206 " [ --loopback OR -L loopback-port-number ]\n"
207 " [ --port-max OR -p maximum-number-of-ports]\n"
208 " [ --slave-backend OR -X slave-backend-name ]\n"
209 " [ --internal-client OR -I internal-client-name ]\n"
210 " [ --internal-session-file OR -C internal-session-file ]\n"
211 " [ --verbose OR -v ]\n"
213 " [ --clocksource OR -c [ h(pet) | s(ystem) ]\n"
215 " [ --autoconnect OR -a <modechar>]\n");
217 server_parameters
= jackctl_server_get_parameters(server
);
218 param
= jackctl_get_parameter(server_parameters
, "self-connect-mode");
220 " where <modechar> is one of:\n");
221 for (i
= 0; i
< jackctl_parameter_get_enum_constraints_count(param
); i
++)
223 value
= jackctl_parameter_get_enum_constraint_value(param
, i
);
224 fprintf(file
, " '%c' - %s", value
.c
, jackctl_parameter_get_enum_constraint_description(param
, i
));
225 if (value
.c
== JACK_DEFAULT_SELF_CONNECT_MODE
)
227 fprintf(file
, " (default)");
233 " [ --replace-registry ]\n"
234 " [ --silent OR -s ]\n"
235 " [ --sync OR -S ]\n"
236 " [ --temporary OR -T ]\n"
237 " [ --version OR -V ]\n"
238 " -d master-backend-name [ ... master-backend args ... ]\n"
239 " jackdmp -d master-backend-name --help\n"
240 " to display options for each master backend\n\n");
243 print_server_drivers(server
, file
);
244 print_server_internals(server
, file
);
248 // Prototype to be found in libjackserver
249 extern "C" void silent_jack_error_callback(const char *desc
);
253 printf( "jackdmp version " VERSION
" tmpdir "
254 jack_server_dir
" protocol %d" "\n",
255 JACK_PROTOCOL_VERSION
);
258 int main(int argc
, char** argv
)
260 jackctl_server_t
* server_ctl
;
261 const JSList
* server_parameters
;
262 const char* server_name
= JACK_DEFAULT_SERVER_NAME
;
263 jackctl_driver_t
* master_driver_ctl
;
264 jackctl_driver_t
* loopback_driver_ctl
= NULL
;
265 int replace_registry
= 0;
267 for(int a
= 1; a
< argc
; ++a
) {
268 if( !strcmp(argv
[a
], "--version") || !strcmp(argv
[a
], "-V") ) {
273 const char *options
= "-d:X:I:P:uvshrRL:STFl:t:mn:p:C:"
280 struct option long_options
[] = {
282 { "clock-source", 1, 0, 'c' },
284 { "internal-session-file", 1, 0, 'C' },
285 { "loopback-driver", 1, 0, 'L' },
286 { "audio-driver", 1, 0, 'd' },
287 { "midi-driver", 1, 0, 'X' },
288 { "internal-client", 1, 0, 'I' },
289 { "verbose", 0, 0, 'v' },
290 { "help", 0, 0, 'h' },
291 { "port-max", 1, 0, 'p' },
292 { "no-mlock", 0, 0, 'm' },
293 { "name", 1, 0, 'n' },
294 { "unlock", 0, 0, 'u' },
295 { "realtime", 0, 0, 'R' },
296 { "no-realtime", 0, 0, 'r' },
297 { "replace-registry", 0, &replace_registry
, 0 },
298 { "loopback", 0, 0, 'L' },
299 { "realtime-priority", 1, 0, 'P' },
300 { "timeout", 1, 0, 't' },
301 { "temporary", 0, 0, 'T' },
302 { "silent", 0, 0, 's' },
303 { "sync", 0, 0, 'S' },
304 { "autoconnect", 1, 0, 'a' },
309 int option_index
= 0;
310 char* internal_session_file
= NULL
;
311 char* master_driver_name
= NULL
;
312 char** master_driver_args
= NULL
;
313 int master_driver_nargs
= 1;
315 jackctl_sigmask_t
* sigmask
;
316 jackctl_parameter_t
* param
;
317 union jackctl_parameter_value value
;
319 std::list
<char*> internals_list
;
320 std::list
<char*> slaves_list
;
321 std::list
<char*>::iterator it
;
323 // Assume that we fail.
324 int return_value
= -1;
325 bool notify_sent
= false;
328 #if defined(JACK_DBUS) && defined(__linux__)
329 if (getenv("JACK_NO_AUDIO_RESERVATION"))
330 server_ctl
= jackctl_server_create2(NULL
, NULL
, NULL
);
332 server_ctl
= jackctl_server_create2(audio_acquire
, audio_release
, audio_reserve_loop
);
334 server_ctl
= jackctl_server_create2(NULL
, NULL
, NULL
);
336 if (server_ctl
== NULL
) {
337 fprintf(stderr
, "Failed to create server object\n");
341 server_parameters
= jackctl_server_get_parameters(server_ctl
);
344 while (!master_driver_name
&&
345 (opt
= getopt_long(argc
, argv
, options
,
346 long_options
, &option_index
)) != EOF
) {
351 param
= jackctl_get_parameter(server_parameters
, "clock-source");
353 if (tolower (optarg
[0]) == 'h') {
354 value
.ui
= JACK_TIMER_HPET
;
355 jackctl_parameter_set_value(param
, &value
);
356 } else if (tolower (optarg
[0]) == 'c') {
357 /* For backwards compatibility with scripts, allow
358 * the user to request the cycle clock on the
359 * command line, but use the system clock instead
361 value
.ui
= JACK_TIMER_SYSTEM_CLOCK
;
362 jackctl_parameter_set_value(param
, &value
);
363 } else if (tolower (optarg
[0]) == 's') {
364 value
.ui
= JACK_TIMER_SYSTEM_CLOCK
;
365 jackctl_parameter_set_value(param
, &value
);
367 usage(stdout
, server_ctl
);
375 param
= jackctl_get_parameter(server_parameters
, "self-connect-mode");
377 bool value_valid
= false;
378 for (uint32_t k
=0; k
<jackctl_parameter_get_enum_constraints_count( param
); k
++ ) {
379 value
= jackctl_parameter_get_enum_constraint_value( param
, k
);
380 if( value
.c
== optarg
[0] )
386 jackctl_parameter_set_value(param
, &value
);
388 usage(stdout
, server_ctl
);
395 master_driver_name
= optarg
;
399 loopback
= atoi(optarg
);
403 slaves_list
.push_back(optarg
);
407 internals_list
.push_back(optarg
);
411 param
= jackctl_get_parameter(server_parameters
, "port-max");
413 value
.ui
= atoi(optarg
);
414 jackctl_parameter_set_value(param
, &value
);
425 param
= jackctl_get_parameter(server_parameters
, "verbose");
428 jackctl_parameter_set_value(param
, &value
);
433 jack_set_error_function(silent_jack_error_callback
);
437 param
= jackctl_get_parameter(server_parameters
, "sync");
440 jackctl_parameter_set_value(param
, &value
);
445 server_name
= optarg
;
446 param
= jackctl_get_parameter(server_parameters
, "name");
448 strncpy(value
.str
, optarg
, JACK_PARAM_STRING_MAX
);
449 jackctl_parameter_set_value(param
, &value
);
454 internal_session_file
= optarg
;
458 param
= jackctl_get_parameter(server_parameters
, "realtime-priority");
460 value
.i
= atoi(optarg
);
461 jackctl_parameter_set_value(param
, &value
);
466 param
= jackctl_get_parameter(server_parameters
, "realtime");
469 jackctl_parameter_set_value(param
, &value
);
474 param
= jackctl_get_parameter(server_parameters
, "realtime");
477 jackctl_parameter_set_value(param
, &value
);
482 param
= jackctl_get_parameter(server_parameters
, "temporary");
485 jackctl_parameter_set_value(param
, &value
);
490 param
= jackctl_get_parameter(server_parameters
, "client-timeout");
492 value
.i
= atoi(optarg
);
493 jackctl_parameter_set_value(param
, &value
);
498 usage(stdout
, server_ctl
);
503 fprintf(stderr
, "unknown option character %c\n", optopt
);
504 usage(stdout
, server_ctl
);
509 // Long option with no letter so treated separately
510 param
= jackctl_get_parameter(server_parameters
, "replace-registry");
512 value
.b
= replace_registry
;
513 jackctl_parameter_set_value(param
, &value
);
516 if (!master_driver_name
) {
517 usage(stderr
, server_ctl
, false);
522 master_driver_ctl
= jackctl_server_get_driver(server_ctl
, master_driver_name
);
523 if (master_driver_ctl
== NULL
) {
524 fprintf(stderr
, "Unknown driver \"%s\"\n", master_driver_name
);
528 if (jackctl_driver_get_type(master_driver_ctl
) != JackMaster
) {
529 fprintf(stderr
, "Driver \"%s\" is not a master \n", master_driver_name
);
534 master_driver_nargs
= 1 + argc
- optind
;
536 master_driver_nargs
= 1;
539 if (master_driver_nargs
== 0) {
540 fprintf(stderr
, "No driver specified ... hmm. JACK won't do"
541 " anything when run like this.\n");
545 master_driver_args
= (char **) malloc(sizeof(char *) * master_driver_nargs
);
546 master_driver_args
[0] = master_driver_name
;
548 for (i
= 1; i
< master_driver_nargs
; i
++) {
549 master_driver_args
[i
] = argv
[optind
++];
552 if (jackctl_driver_params_parse(master_driver_ctl
, master_driver_nargs
, master_driver_args
)) {
557 sigmask
= jackctl_setup_signals(0);
560 if (! jackctl_server_open(server_ctl
, master_driver_ctl
)) {
561 fprintf(stderr
, "Failed to open server\n");
566 for (it
= slaves_list
.begin(); it
!= slaves_list
.end(); it
++) {
567 jackctl_driver_t
* slave_driver_ctl
= jackctl_server_get_driver(server_ctl
, *it
);
568 if (slave_driver_ctl
== NULL
) {
569 fprintf(stderr
, "Unknown driver \"%s\"\n", *it
);
572 if (jackctl_driver_get_type(slave_driver_ctl
) != JackSlave
) {
573 fprintf(stderr
, "Driver \"%s\" is not a slave \n", *it
);
576 if (!jackctl_server_add_slave(server_ctl
, slave_driver_ctl
)) {
577 fprintf(stderr
, "Driver \"%s\" cannot be loaded\n", *it
);
584 loopback_driver_ctl
= jackctl_server_get_driver(server_ctl
, "loopback");
586 if (loopback_driver_ctl
!= NULL
) {
587 const JSList
* loopback_parameters
= jackctl_driver_get_parameters(loopback_driver_ctl
);
588 param
= jackctl_get_parameter(loopback_parameters
, "channels");
591 jackctl_parameter_set_value(param
, &value
);
593 if (!jackctl_server_add_slave(server_ctl
, loopback_driver_ctl
)) {
594 fprintf(stderr
, "Driver \"loopback\" cannot be loaded\n");
598 fprintf(stderr
, "Driver \"loopback\" not found\n");
604 if (!jackctl_server_start(server_ctl
)) {
605 fprintf(stderr
, "Failed to start server\n");
610 for (it
= internals_list
.begin(); it
!= internals_list
.end(); it
++) {
611 jackctl_internal_t
* internal_driver_ctl
= jackctl_server_get_internal(server_ctl
, *it
);
612 if (internal_driver_ctl
== NULL
) {
613 fprintf(stderr
, "Unknown internal \"%s\"\n", *it
);
616 if (!jackctl_server_load_internal(server_ctl
, internal_driver_ctl
)) {
617 fprintf(stderr
, "Internal client \"%s\" cannot be loaded\n", *it
);
622 if (internal_session_file
!= NULL
) {
623 if (!jackctl_server_load_session_file(server_ctl
, internal_session_file
)) {
624 fprintf(stderr
, "Internal session file %s cannot be loaded!\n", internal_session_file
);
629 notify_server_start(server_name
);
634 sd_notify(0, "READY=1");
639 //reserve SIGUSR2 signal for switching master driver
641 int signal
= jackctl_wait_signals_and_return(sigmask
);
642 if (signal
== SIGUSR2
) {
643 jackctl_server_switch_master_dummy(server_ctl
, master_driver_name
);
649 jackctl_wait_signals(sigmask
);
653 sd_notify(0, "STOPPING=1");
657 if (!jackctl_server_stop(server_ctl
)) {
658 fprintf(stderr
, "Cannot stop server...\n");
662 if (loopback
> 0 && loopback_driver_ctl
) {
663 jackctl_server_remove_slave(server_ctl
, loopback_driver_ctl
);
666 for (it
= slaves_list
.begin(); it
!= slaves_list
.end(); it
++) {
667 jackctl_driver_t
* slave_driver_ctl
= jackctl_server_get_driver(server_ctl
, *it
);
668 if (slave_driver_ctl
) {
669 jackctl_server_remove_slave(server_ctl
, slave_driver_ctl
);
674 for (it
= internals_list
.begin(); it
!= internals_list
.end(); it
++) {
675 jackctl_internal_t
* internal_driver_ctl
= jackctl_server_get_internal(server_ctl
, *it
);
676 if (internal_driver_ctl
) {
677 jackctl_server_unload_internal(server_ctl
, internal_driver_ctl
);
680 jackctl_server_close(server_ctl
);
683 jackctl_server_destroy(server_ctl
);
685 notify_server_stop(server_name
);