2 Copyright (C) 2001 Paul Davis
3 Copyright (C) 2004-2013 Grame
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include <sys/types.h>
34 #include "JackConstants.h"
35 #include "JackPlatformPlug.h"
37 #include "JackControlAPIAndroid.h"
40 #if defined(JACK_DBUS) && defined(__linux__)
42 #include <dbus/dbus.h>
43 #include "audio_reserve.h"
47 This is a simple port of the old jackdmp.cpp file to use the new jack2 control API. Available options for the server
48 are "hard-coded" in the source. A much better approach would be to use the control API to:
49 - dynamically retrieve available server parameters and then prepare to parse them
50 - get available drivers and their possible parameters, then prepare to parse them.
54 #include <CoreFoundation/CFNotificationCenter.h>
55 #include <CoreFoundation/CoreFoundation.h>
57 static void notify_server_start(const char* server_name
)
59 // Send notification to be used in the JackRouter plugin
60 CFStringRef ref
= CFStringCreateWithCString(NULL
, server_name
, kCFStringEncodingMacRoman
);
61 CFNotificationCenterPostNotificationWithOptions(CFNotificationCenterGetDistributedCenter(),
62 CFSTR("com.grame.jackserver.start"),
65 kCFNotificationDeliverImmediately
| kCFNotificationPostToAllSessions
);
69 static void notify_server_stop(const char* server_name
)
71 // Send notification to be used in the JackRouter plugin
72 CFStringRef ref1
= CFStringCreateWithCString(NULL
, server_name
, kCFStringEncodingMacRoman
);
73 CFNotificationCenterPostNotificationWithOptions(CFNotificationCenterGetDistributedCenter(),
74 CFSTR("com.grame.jackserver.stop"),
77 kCFNotificationDeliverImmediately
| kCFNotificationPostToAllSessions
);
83 static void notify_server_start(const char* server_name
)
85 static void notify_server_stop(const char* server_name
)
90 static void copyright(FILE* file
)
92 fprintf(file
, "jackdmp " VERSION
"\n"
93 "Copyright 2001-2005 Paul Davis and others.\n"
94 "Copyright 2004-2016 Grame.\n"
95 "Copyright 2016-2017 Filipe Coelho.\n"
96 "jackdmp comes with ABSOLUTELY NO WARRANTY\n"
97 "This is free software, and you are welcome to redistribute it\n"
98 "under certain conditions; see the file COPYING for details\n");
101 static jackctl_driver_t
* jackctl_server_get_driver(jackctl_server_t
*server
, const char *driver_name
)
103 const JSList
* node_ptr
= jackctl_server_get_drivers_list(server
);
106 if (strcmp(jackctl_driver_get_name((jackctl_driver_t
*)node_ptr
->data
), driver_name
) == 0) {
107 return (jackctl_driver_t
*)node_ptr
->data
;
109 node_ptr
= jack_slist_next(node_ptr
);
115 static jackctl_internal_t
* jackctl_server_get_internal(jackctl_server_t
*server
, const char *internal_name
)
117 const JSList
* node_ptr
= jackctl_server_get_internals_list(server
);
120 if (strcmp(jackctl_internal_get_name((jackctl_internal_t
*)node_ptr
->data
), internal_name
) == 0) {
121 return (jackctl_internal_t
*)node_ptr
->data
;
123 node_ptr
= jack_slist_next(node_ptr
);
129 static jackctl_parameter_t
* jackctl_get_parameter(const JSList
* parameters_list
, const char * parameter_name
)
131 while (parameters_list
) {
132 if (strcmp(jackctl_parameter_get_name((jackctl_parameter_t
*)parameters_list
->data
), parameter_name
) == 0) {
133 return (jackctl_parameter_t
*)parameters_list
->data
;
135 parameters_list
= jack_slist_next(parameters_list
);
142 static void jackctl_server_switch_master_dummy(jackctl_server_t
* server_ctl
, char * master_driver_name
)
144 static bool is_dummy_driver
= false;
145 if(!strcmp(master_driver_name
, "dummy")) {
148 jackctl_driver_t
* driver_ctr
;
149 if(is_dummy_driver
) {
150 is_dummy_driver
= false;
151 driver_ctr
= jackctl_server_get_driver(server_ctl
, master_driver_name
);
153 is_dummy_driver
= true;
154 driver_ctr
= jackctl_server_get_driver(server_ctl
, "dummy");
156 jackctl_server_switch_master(server_ctl
, driver_ctr
);
160 static void print_server_drivers(jackctl_server_t
*server
, FILE* file
)
162 const JSList
* node_ptr
= jackctl_server_get_drivers_list(server
);
164 fprintf(file
, "Available backends:\n");
167 jackctl_driver_t
* driver
= (jackctl_driver_t
*)node_ptr
->data
;
168 fprintf(file
, " %s (%s)\n", jackctl_driver_get_name(driver
), (jackctl_driver_get_type(driver
) == JackMaster
) ? "master" : "slave");
169 node_ptr
= jack_slist_next(node_ptr
);
174 static void print_server_internals(jackctl_server_t
*server
, FILE* file
)
176 const JSList
* node_ptr
= jackctl_server_get_internals_list(server
);
178 fprintf(file
, "Available internals:\n");
181 jackctl_internal_t
* internal
= (jackctl_internal_t
*)node_ptr
->data
;
182 fprintf(file
, " %s\n", jackctl_internal_get_name(internal
));
183 node_ptr
= jack_slist_next(node_ptr
);
188 static void usage(FILE* file
, jackctl_server_t
*server
, bool full
= true)
190 jackctl_parameter_t
* param
;
191 const JSList
* server_parameters
;
193 union jackctl_parameter_value value
;
196 "Usage: jackdmp [ --no-realtime OR -r ]\n"
197 " [ --realtime OR -R [ --realtime-priority OR -P priority ] ]\n"
198 " (the two previous arguments are mutually exclusive. The default is --realtime)\n"
199 " [ --name OR -n server-name ]\n"
200 " [ --timeout OR -t client-timeout-in-msecs ]\n"
201 " [ --loopback OR -L loopback-port-number ]\n"
202 " [ --port-max OR -p maximum-number-of-ports]\n"
203 " [ --slave-backend OR -X slave-backend-name ]\n"
204 " [ --internal-client OR -I internal-client-name ]\n"
205 " [ --internal-session-file OR -C internal-session-file ]\n"
206 " [ --verbose OR -v ]\n"
208 " [ --clocksource OR -c [ h(pet) | s(ystem) ]\n"
210 " [ --autoconnect OR -a <modechar>]\n");
212 server_parameters
= jackctl_server_get_parameters(server
);
213 param
= jackctl_get_parameter(server_parameters
, "self-connect-mode");
215 " where <modechar> is one of:\n");
216 for (i
= 0; i
< jackctl_parameter_get_enum_constraints_count(param
); i
++)
218 value
= jackctl_parameter_get_enum_constraint_value(param
, i
);
219 fprintf(file
, " '%c' - %s", value
.c
, jackctl_parameter_get_enum_constraint_description(param
, i
));
220 if (value
.c
== JACK_DEFAULT_SELF_CONNECT_MODE
)
222 fprintf(file
, " (default)");
228 " [ --replace-registry ]\n"
229 " [ --silent OR -s ]\n"
230 " [ --sync OR -S ]\n"
231 " [ --temporary OR -T ]\n"
232 " [ --version OR -V ]\n"
233 " -d master-backend-name [ ... master-backend args ... ]\n"
234 " jackdmp -d master-backend-name --help\n"
235 " to display options for each master backend\n\n");
238 print_server_drivers(server
, file
);
239 print_server_internals(server
, file
);
243 // Prototype to be found in libjackserver
244 extern "C" void silent_jack_error_callback(const char *desc
);
248 printf( "jackdmp version " VERSION
" tmpdir "
249 jack_server_dir
" protocol %d" "\n",
250 JACK_PROTOCOL_VERSION
);
255 int main(int argc
, char** argv
)
257 jackctl_server_t
* server_ctl
;
258 const JSList
* server_parameters
;
259 const char* server_name
= JACK_DEFAULT_SERVER_NAME
;
260 jackctl_driver_t
* master_driver_ctl
;
261 jackctl_driver_t
* loopback_driver_ctl
= NULL
;
262 int replace_registry
= 0;
264 for(int a
= 1; a
< argc
; ++a
) {
265 if( !strcmp(argv
[a
], "--version") || !strcmp(argv
[a
], "-V") ) {
269 const char *options
= "-d:X:I:P:uvshrRL:STFl:t:mn:p:C:"
276 struct option long_options
[] = {
278 { "clock-source", 1, 0, 'c' },
280 { "internal-session-file", 1, 0, 'C' },
281 { "loopback-driver", 1, 0, 'L' },
282 { "audio-driver", 1, 0, 'd' },
283 { "midi-driver", 1, 0, 'X' },
284 { "internal-client", 1, 0, 'I' },
285 { "verbose", 0, 0, 'v' },
286 { "help", 0, 0, 'h' },
287 { "port-max", 1, 0, 'p' },
288 { "no-mlock", 0, 0, 'm' },
289 { "name", 1, 0, 'n' },
290 { "unlock", 0, 0, 'u' },
291 { "realtime", 0, 0, 'R' },
292 { "no-realtime", 0, 0, 'r' },
293 { "replace-registry", 0, &replace_registry
, 0 },
294 { "loopback", 0, 0, 'L' },
295 { "realtime-priority", 1, 0, 'P' },
296 { "timeout", 1, 0, 't' },
297 { "temporary", 0, 0, 'T' },
298 { "silent", 0, 0, 's' },
299 { "sync", 0, 0, 'S' },
300 { "autoconnect", 1, 0, 'a' },
305 int option_index
= 0;
306 char* internal_session_file
= NULL
;
307 char* master_driver_name
= NULL
;
308 char** master_driver_args
= NULL
;
309 int master_driver_nargs
= 1;
311 jackctl_sigmask_t
* sigmask
;
312 jackctl_parameter_t
* param
;
313 union jackctl_parameter_value value
;
315 std::list
<char*> internals_list
;
316 std::list
<char*> slaves_list
;
317 std::list
<char*>::iterator it
;
319 // Assume that we fail.
320 int return_value
= -1;
321 bool notify_sent
= false;
324 #if defined(JACK_DBUS) && defined(__linux__)
325 if (getenv("JACK_NO_AUDIO_RESERVATION"))
326 server_ctl
= jackctl_server_create(NULL
, NULL
);
328 server_ctl
= jackctl_server_create(audio_acquire
, audio_release
);
330 server_ctl
= jackctl_server_create(NULL
, NULL
);
332 if (server_ctl
== NULL
) {
333 fprintf(stderr
, "Failed to create server object\n");
337 server_parameters
= jackctl_server_get_parameters(server_ctl
);
340 while (!master_driver_name
&&
341 (opt
= getopt_long(argc
, argv
, options
,
342 long_options
, &option_index
)) != EOF
) {
347 param
= jackctl_get_parameter(server_parameters
, "clock-source");
349 if (tolower (optarg
[0]) == 'h') {
350 value
.ui
= JACK_TIMER_HPET
;
351 jackctl_parameter_set_value(param
, &value
);
352 } else if (tolower (optarg
[0]) == 'c') {
353 /* For backwards compatibility with scripts, allow
354 * the user to request the cycle clock on the
355 * command line, but use the system clock instead
357 value
.ui
= JACK_TIMER_SYSTEM_CLOCK
;
358 jackctl_parameter_set_value(param
, &value
);
359 } else if (tolower (optarg
[0]) == 's') {
360 value
.ui
= JACK_TIMER_SYSTEM_CLOCK
;
361 jackctl_parameter_set_value(param
, &value
);
363 usage(stdout
, server_ctl
);
371 param
= jackctl_get_parameter(server_parameters
, "self-connect-mode");
373 bool value_valid
= false;
374 for (uint32_t k
=0; k
<jackctl_parameter_get_enum_constraints_count( param
); k
++ ) {
375 value
= jackctl_parameter_get_enum_constraint_value( param
, k
);
376 if( value
.c
== optarg
[0] )
382 jackctl_parameter_set_value(param
, &value
);
384 usage(stdout
, server_ctl
);
391 master_driver_name
= optarg
;
395 loopback
= atoi(optarg
);
399 slaves_list
.push_back(optarg
);
403 internals_list
.push_back(optarg
);
407 param
= jackctl_get_parameter(server_parameters
, "port-max");
409 value
.ui
= atoi(optarg
);
410 jackctl_parameter_set_value(param
, &value
);
421 param
= jackctl_get_parameter(server_parameters
, "verbose");
424 jackctl_parameter_set_value(param
, &value
);
429 jack_set_error_function(silent_jack_error_callback
);
433 param
= jackctl_get_parameter(server_parameters
, "sync");
436 jackctl_parameter_set_value(param
, &value
);
441 server_name
= optarg
;
442 param
= jackctl_get_parameter(server_parameters
, "name");
444 strncpy(value
.str
, optarg
, JACK_PARAM_STRING_MAX
);
445 jackctl_parameter_set_value(param
, &value
);
450 internal_session_file
= optarg
;
454 param
= jackctl_get_parameter(server_parameters
, "realtime-priority");
456 value
.i
= atoi(optarg
);
457 jackctl_parameter_set_value(param
, &value
);
462 param
= jackctl_get_parameter(server_parameters
, "realtime");
465 jackctl_parameter_set_value(param
, &value
);
470 param
= jackctl_get_parameter(server_parameters
, "realtime");
473 jackctl_parameter_set_value(param
, &value
);
478 param
= jackctl_get_parameter(server_parameters
, "temporary");
481 jackctl_parameter_set_value(param
, &value
);
486 param
= jackctl_get_parameter(server_parameters
, "client-timeout");
488 value
.i
= atoi(optarg
);
489 jackctl_parameter_set_value(param
, &value
);
494 fprintf(stderr
, "unknown option character %c\n", optopt
);
498 usage(stdout
, server_ctl
);
503 // Long option with no letter so treated separately
504 param
= jackctl_get_parameter(server_parameters
, "replace-registry");
506 value
.b
= replace_registry
;
507 jackctl_parameter_set_value(param
, &value
);
510 if (!master_driver_name
) {
511 usage(stderr
, server_ctl
, false);
516 master_driver_ctl
= jackctl_server_get_driver(server_ctl
, master_driver_name
);
517 if (master_driver_ctl
== NULL
) {
518 fprintf(stderr
, "Unknown driver \"%s\"\n", master_driver_name
);
522 if (jackctl_driver_get_type(master_driver_ctl
) != JackMaster
) {
523 fprintf(stderr
, "Driver \"%s\" is not a master \n", master_driver_name
);
528 master_driver_nargs
= 1 + argc
- optind
;
530 master_driver_nargs
= 1;
533 if (master_driver_nargs
== 0) {
534 fprintf(stderr
, "No driver specified ... hmm. JACK won't do"
535 " anything when run like this.\n");
539 master_driver_args
= (char **) malloc(sizeof(char *) * master_driver_nargs
);
540 master_driver_args
[0] = master_driver_name
;
542 for (i
= 1; i
< master_driver_nargs
; i
++) {
543 master_driver_args
[i
] = argv
[optind
++];
546 if (jackctl_driver_params_parse(master_driver_ctl
, master_driver_nargs
, master_driver_args
)) {
551 sigmask
= jackctl_setup_signals(0);
554 if (! jackctl_server_open(server_ctl
, master_driver_ctl
)) {
555 fprintf(stderr
, "Failed to open server\n");
560 for (it
= slaves_list
.begin(); it
!= slaves_list
.end(); it
++) {
561 jackctl_driver_t
* slave_driver_ctl
= jackctl_server_get_driver(server_ctl
, *it
);
562 if (slave_driver_ctl
== NULL
) {
563 fprintf(stderr
, "Unknown driver \"%s\"\n", *it
);
566 if (jackctl_driver_get_type(slave_driver_ctl
) != JackSlave
) {
567 fprintf(stderr
, "Driver \"%s\" is not a slave \n", *it
);
570 if (!jackctl_server_add_slave(server_ctl
, slave_driver_ctl
)) {
571 fprintf(stderr
, "Driver \"%s\" cannot be loaded\n", *it
);
578 loopback_driver_ctl
= jackctl_server_get_driver(server_ctl
, "loopback");
580 if (loopback_driver_ctl
!= NULL
) {
581 const JSList
* loopback_parameters
= jackctl_driver_get_parameters(loopback_driver_ctl
);
582 param
= jackctl_get_parameter(loopback_parameters
, "channels");
585 jackctl_parameter_set_value(param
, &value
);
587 if (!jackctl_server_add_slave(server_ctl
, loopback_driver_ctl
)) {
588 fprintf(stderr
, "Driver \"loopback\" cannot be loaded\n");
592 fprintf(stderr
, "Driver \"loopback\" not found\n");
598 if (!jackctl_server_start(server_ctl
)) {
599 fprintf(stderr
, "Failed to start server\n");
604 for (it
= internals_list
.begin(); it
!= internals_list
.end(); it
++) {
605 jackctl_internal_t
* internal_driver_ctl
= jackctl_server_get_internal(server_ctl
, *it
);
606 if (internal_driver_ctl
== NULL
) {
607 fprintf(stderr
, "Unknown internal \"%s\"\n", *it
);
610 if (!jackctl_server_load_internal(server_ctl
, internal_driver_ctl
)) {
611 fprintf(stderr
, "Internal client \"%s\" cannot be loaded\n", *it
);
616 if (internal_session_file
!= NULL
) {
617 if (!jackctl_server_load_session_file(server_ctl
, internal_session_file
)) {
618 fprintf(stderr
, "Internal session file %s cannot be loaded!\n", internal_session_file
);
623 notify_server_start(server_name
);
629 //reserve SIGUSR2 signal for switching master driver
631 int signal
= jackctl_wait_signals_and_return(sigmask
);
632 if (signal
== SIGUSR2
) {
633 jackctl_server_switch_master_dummy(server_ctl
, master_driver_name
);
639 jackctl_wait_signals(sigmask
);
643 if (!jackctl_server_stop(server_ctl
)) {
644 fprintf(stderr
, "Cannot stop server...\n");
648 if (loopback
> 0 && loopback_driver_ctl
) {
649 jackctl_server_remove_slave(server_ctl
, loopback_driver_ctl
);
652 for (it
= slaves_list
.begin(); it
!= slaves_list
.end(); it
++) {
653 jackctl_driver_t
* slave_driver_ctl
= jackctl_server_get_driver(server_ctl
, *it
);
654 if (slave_driver_ctl
) {
655 jackctl_server_remove_slave(server_ctl
, slave_driver_ctl
);
660 for (it
= internals_list
.begin(); it
!= internals_list
.end(); it
++) {
661 jackctl_internal_t
* internal_driver_ctl
= jackctl_server_get_internal(server_ctl
, *it
);
662 if (internal_driver_ctl
) {
663 jackctl_server_unload_internal(server_ctl
, internal_driver_ctl
);
666 jackctl_server_close(server_ctl
);
669 jackctl_server_destroy(server_ctl
);
671 notify_server_stop(server_name
);