4 This file is part of PulseAudio.
6 Copyright 2004-2006 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
35 #include <pulse/xmalloc.h>
37 #include <pulsecore/module.h>
38 #include <pulsecore/sink.h>
39 #include <pulsecore/source.h>
40 #include <pulsecore/client.h>
41 #include <pulsecore/sink-input.h>
42 #include <pulsecore/source-output.h>
43 #include <pulsecore/tokenizer.h>
44 #include <pulsecore/strbuf.h>
45 #include <pulsecore/namereg.h>
46 #include <pulsecore/cli-text.h>
47 #include <pulsecore/core-scache.h>
48 #include <pulsecore/sample-util.h>
49 #include <pulsecore/sound-file.h>
50 #include <pulsecore/play-memchunk.h>
51 #include <pulsecore/autoload.h>
52 #include <pulsecore/sound-file-stream.h>
53 #include <pulsecore/props.h>
54 #include <pulsecore/core-util.h>
55 #include <pulsecore/core-error.h>
57 #include "cli-command.h"
61 int (*proc
) (pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
66 #define META_INCLUDE ".include"
67 #define META_FAIL ".fail"
68 #define META_NOFAIL ".nofail"
69 #define META_IFEXISTS ".ifexists"
70 #define META_ELSE ".else"
71 #define META_ENDIF ".endif"
79 /* Prototypes for all available commands */
80 static int pa_cli_command_exit(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
81 static int pa_cli_command_help(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
82 static int pa_cli_command_modules(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
83 static int pa_cli_command_clients(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
84 static int pa_cli_command_sinks(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
85 static int pa_cli_command_sources(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
86 static int pa_cli_command_sink_inputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
87 static int pa_cli_command_source_outputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
88 static int pa_cli_command_stat(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
89 static int pa_cli_command_info(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
90 static int pa_cli_command_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
91 static int pa_cli_command_unload(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
92 static int pa_cli_command_sink_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
93 static int pa_cli_command_sink_input_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
94 static int pa_cli_command_source_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
95 static int pa_cli_command_sink_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
96 static int pa_cli_command_source_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
97 static int pa_cli_command_sink_input_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
98 static int pa_cli_command_sink_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
99 static int pa_cli_command_source_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
100 static int pa_cli_command_kill_client(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
101 static int pa_cli_command_kill_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
102 static int pa_cli_command_kill_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
103 static int pa_cli_command_scache_play(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
104 static int pa_cli_command_scache_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
105 static int pa_cli_command_scache_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
106 static int pa_cli_command_scache_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
107 static int pa_cli_command_scache_load_dir(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
108 static int pa_cli_command_play_file(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
109 static int pa_cli_command_autoload_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
110 static int pa_cli_command_autoload_add(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
111 static int pa_cli_command_autoload_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
112 static int pa_cli_command_dump(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
113 static int pa_cli_command_list_props(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
114 static int pa_cli_command_move_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
115 static int pa_cli_command_move_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
116 static int pa_cli_command_vacuum(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
117 static int pa_cli_command_suspend_sink(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
118 static int pa_cli_command_suspend_source(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
119 static int pa_cli_command_suspend(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
);
121 /* A method table for all available commands */
123 static const struct command commands
[] = {
124 { "exit", pa_cli_command_exit
, "Terminate the daemon", 1 },
125 { "help", pa_cli_command_help
, "Show this help", 1 },
126 { "list-modules", pa_cli_command_modules
, "List loaded modules", 1 },
127 { "list-sinks", pa_cli_command_sinks
, "List loaded sinks", 1 },
128 { "list-sources", pa_cli_command_sources
, "List loaded sources", 1 },
129 { "list-clients", pa_cli_command_clients
, "List loaded clients", 1 },
130 { "list-sink-inputs", pa_cli_command_sink_inputs
, "List sink inputs", 1 },
131 { "list-source-outputs", pa_cli_command_source_outputs
, "List source outputs", 1 },
132 { "stat", pa_cli_command_stat
, "Show memory block statistics", 1 },
133 { "info", pa_cli_command_info
, "Show comprehensive status", 1 },
134 { "ls", pa_cli_command_info
, NULL
, 1 },
135 { "list", pa_cli_command_info
, NULL
, 1 },
136 { "load-module", pa_cli_command_load
, "Load a module (args: name, arguments)", 3},
137 { "unload-module", pa_cli_command_unload
, "Unload a module (args: index)", 2},
138 { "set-sink-volume", pa_cli_command_sink_volume
, "Set the volume of a sink (args: index|name, volume)", 3},
139 { "set-sink-input-volume", pa_cli_command_sink_input_volume
, "Set the volume of a sink input (args: index, volume)", 3},
140 { "set-source-volume", pa_cli_command_source_volume
, "Set the volume of a source (args: index|name, volume)", 3},
141 { "set-sink-mute", pa_cli_command_sink_mute
, "Set the mute switch of a sink (args: index|name, bool)", 3},
142 { "set-sink-input-mute", pa_cli_command_sink_input_mute
, "Set the mute switch of a sink input (args: index, bool)", 3},
143 { "set-source-mute", pa_cli_command_source_mute
, "Set the mute switch of a source (args: index|name, bool)", 3},
144 { "set-default-sink", pa_cli_command_sink_default
, "Set the default sink (args: index|name)", 2},
145 { "set-default-source", pa_cli_command_source_default
, "Set the default source (args: index|name)", 2},
146 { "kill-client", pa_cli_command_kill_client
, "Kill a client (args: index)", 2},
147 { "kill-sink-input", pa_cli_command_kill_sink_input
, "Kill a sink input (args: index)", 2},
148 { "kill-source-output", pa_cli_command_kill_source_output
, "Kill a source output (args: index)", 2},
149 { "list-samples", pa_cli_command_scache_list
, "List all entries in the sample cache", 1},
150 { "play-sample", pa_cli_command_scache_play
, "Play a sample from the sample cache (args: name, sink|index)", 3},
151 { "remove-sample", pa_cli_command_scache_remove
, "Remove a sample from the sample cache (args: name)", 2},
152 { "load-sample", pa_cli_command_scache_load
, "Load a sound file into the sample cache (args: name, filename)", 3},
153 { "load-sample-lazy", pa_cli_command_scache_load
, "Lazily load a sound file into the sample cache (args: name, filename)", 3},
154 { "load-sample-dir-lazy", pa_cli_command_scache_load_dir
, "Lazily load all files in a directory into the sample cache (args: pathname)", 2},
155 { "play-file", pa_cli_command_play_file
, "Play a sound file (args: filename, sink|index)", 3},
156 { "list-autoload", pa_cli_command_autoload_list
, "List autoload entries", 1},
157 { "add-autoload-sink", pa_cli_command_autoload_add
, "Add autoload entry for a sink (args: sink, module name, arguments)", 4},
158 { "add-autoload-source", pa_cli_command_autoload_add
, "Add autoload entry for a source (args: source, module name, arguments)", 4},
159 { "remove-autoload-sink", pa_cli_command_autoload_remove
, "Remove autoload entry for a sink (args: name)", 2},
160 { "remove-autoload-source", pa_cli_command_autoload_remove
, "Remove autoload entry for a source (args: name)", 2},
161 { "dump", pa_cli_command_dump
, "Dump daemon configuration", 1},
162 { "list-props", pa_cli_command_list_props
, NULL
, 1},
163 { "move-sink-input", pa_cli_command_move_sink_input
, "Move sink input to another sink (args: index, sink)", 3},
164 { "move-source-output", pa_cli_command_move_source_output
, "Move source output to another source (args: index, source)", 3},
165 { "vacuum", pa_cli_command_vacuum
, NULL
, 1},
166 { "suspend-sink", pa_cli_command_suspend_sink
, "Suspend sink (args: index|name, bool)", 3},
167 { "suspend-source", pa_cli_command_suspend_source
, "Suspend source (args: index|name, bool)", 3},
168 { "suspend", pa_cli_command_suspend
, "Suspend all sinks and all sources (args: bool)", 2},
169 { NULL
, NULL
, NULL
, 0 }
172 static const char whitespace
[] = " \t\n\r";
173 static const char linebreak
[] = "\n\r";
175 static uint32_t parse_index(const char *n
) {
178 if (pa_atou(n
, &idx
) < 0)
179 return (uint32_t) PA_IDXSET_INVALID
;
184 static int pa_cli_command_exit(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
185 pa_core_assert_ref(c
);
190 c
->mainloop
->quit(c
->mainloop
, 0);
194 static int pa_cli_command_help(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
195 const struct command
*command
;
197 pa_core_assert_ref(c
);
202 pa_strbuf_puts(buf
, "Available commands:\n");
204 for (command
= commands
; command
->name
; command
++)
206 pa_strbuf_printf(buf
, " %-25s %s\n", command
->name
, command
->help
);
210 static int pa_cli_command_modules(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
213 pa_core_assert_ref(c
);
218 pa_assert_se(s
= pa_module_list_to_string(c
));
219 pa_strbuf_puts(buf
, s
);
224 static int pa_cli_command_clients(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
227 pa_core_assert_ref(c
);
232 pa_assert_se(s
= pa_client_list_to_string(c
));
233 pa_strbuf_puts(buf
, s
);
238 static int pa_cli_command_sinks(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
241 pa_core_assert_ref(c
);
246 pa_assert_se(s
= pa_sink_list_to_string(c
));
247 pa_strbuf_puts(buf
, s
);
252 static int pa_cli_command_sources(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
255 pa_core_assert_ref(c
);
260 pa_assert_se(s
= pa_source_list_to_string(c
));
261 pa_strbuf_puts(buf
, s
);
266 static int pa_cli_command_sink_inputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
269 pa_core_assert_ref(c
);
274 pa_assert_se(s
= pa_sink_input_list_to_string(c
));
275 pa_strbuf_puts(buf
, s
);
280 static int pa_cli_command_source_outputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
283 pa_core_assert_ref(c
);
288 pa_assert_se(s
= pa_source_output_list_to_string(c
));
289 pa_strbuf_puts(buf
, s
);
294 static int pa_cli_command_stat(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
296 const pa_mempool_stat
*stat
;
298 const char *def_sink
, *def_source
;
300 static const char* const type_table
[PA_MEMBLOCK_TYPE_MAX
] = {
301 [PA_MEMBLOCK_POOL
] = "POOL",
302 [PA_MEMBLOCK_POOL_EXTERNAL
] = "POOL_EXTERNAL",
303 [PA_MEMBLOCK_APPENDED
] = "APPENDED",
304 [PA_MEMBLOCK_USER
] = "USER",
305 [PA_MEMBLOCK_FIXED
] = "FIXED",
306 [PA_MEMBLOCK_IMPORTED
] = "IMPORTED",
309 pa_core_assert_ref(c
);
314 stat
= pa_mempool_get_stat(c
->mempool
);
316 pa_strbuf_printf(buf
, "Memory blocks currently allocated: %u, size: %s.\n",
317 (unsigned) pa_atomic_load(&stat
->n_allocated
),
318 pa_bytes_snprint(s
, sizeof(s
), (size_t) pa_atomic_load(&stat
->allocated_size
)));
320 pa_strbuf_printf(buf
, "Memory blocks allocated during the whole lifetime: %u, size: %s.\n",
321 (unsigned) pa_atomic_load(&stat
->n_accumulated
),
322 pa_bytes_snprint(s
, sizeof(s
), (size_t) pa_atomic_load(&stat
->accumulated_size
)));
324 pa_strbuf_printf(buf
, "Memory blocks imported from other processes: %u, size: %s.\n",
325 (unsigned) pa_atomic_load(&stat
->n_imported
),
326 pa_bytes_snprint(s
, sizeof(s
), (size_t) pa_atomic_load(&stat
->imported_size
)));
328 pa_strbuf_printf(buf
, "Memory blocks exported to other processes: %u, size: %s.\n",
329 (unsigned) pa_atomic_load(&stat
->n_exported
),
330 pa_bytes_snprint(s
, sizeof(s
), (size_t) pa_atomic_load(&stat
->exported_size
)));
332 pa_strbuf_printf(buf
, "Total sample cache size: %s.\n",
333 pa_bytes_snprint(s
, sizeof(s
), pa_scache_total_size(c
)));
335 pa_strbuf_printf(buf
, "Default sample spec: %s\n",
336 pa_sample_spec_snprint(s
, sizeof(s
), &c
->default_sample_spec
));
338 def_sink
= pa_namereg_get_default_sink_name(c
);
339 def_source
= pa_namereg_get_default_source_name(c
);
340 pa_strbuf_printf(buf
, "Default sink name: %s\n"
341 "Default source name: %s\n",
342 def_sink
? def_sink
: "none",
343 def_source
? def_source
: "none");
345 for (k
= 0; k
< PA_MEMBLOCK_TYPE_MAX
; k
++)
346 pa_strbuf_printf(buf
,
347 "Memory blocks of type %s: %u allocated/%u accumulated.\n",
349 (unsigned) pa_atomic_load(&stat
->n_allocated_by_type
[k
]),
350 (unsigned) pa_atomic_load(&stat
->n_accumulated_by_type
[k
]));
355 static int pa_cli_command_info(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
356 pa_core_assert_ref(c
);
361 pa_cli_command_stat(c
, t
, buf
, fail
);
362 pa_cli_command_modules(c
, t
, buf
, fail
);
363 pa_cli_command_sinks(c
, t
, buf
, fail
);
364 pa_cli_command_sources(c
, t
, buf
, fail
);
365 pa_cli_command_clients(c
, t
, buf
, fail
);
366 pa_cli_command_sink_inputs(c
, t
, buf
, fail
);
367 pa_cli_command_source_outputs(c
, t
, buf
, fail
);
368 pa_cli_command_scache_list(c
, t
, buf
, fail
);
369 pa_cli_command_autoload_list(c
, t
, buf
, fail
);
373 static int pa_cli_command_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
377 pa_core_assert_ref(c
);
382 if (!(name
= pa_tokenizer_get(t
, 1))) {
383 pa_strbuf_puts(buf
, "You need to specify the module name and optionally arguments.\n");
387 if (!(m
= pa_module_load(c
, name
, pa_tokenizer_get(t
, 2)))) {
388 pa_strbuf_puts(buf
, "Module load failed.\n");
395 static int pa_cli_command_unload(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
401 pa_core_assert_ref(c
);
406 if (!(i
= pa_tokenizer_get(t
, 1))) {
407 pa_strbuf_puts(buf
, "You need to specify the module index.\n");
411 idx
= (uint32_t) strtoul(i
, &e
, 10);
412 if (*e
|| !(m
= pa_idxset_get_by_index(c
->modules
, idx
))) {
413 pa_strbuf_puts(buf
, "Invalid module index.\n");
417 pa_module_unload_request(m
);
421 static int pa_cli_command_sink_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
427 pa_core_assert_ref(c
);
432 if (!(n
= pa_tokenizer_get(t
, 1))) {
433 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
437 if (!(v
= pa_tokenizer_get(t
, 2))) {
438 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
442 if (pa_atou(v
, &volume
) < 0) {
443 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
447 if (!(sink
= pa_namereg_get(c
, n
, PA_NAMEREG_SINK
, 1))) {
448 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
452 pa_cvolume_set(&cvolume
, sink
->sample_spec
.channels
, volume
);
453 pa_sink_set_volume(sink
, &cvolume
);
457 static int pa_cli_command_sink_input_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
464 pa_core_assert_ref(c
);
469 if (!(n
= pa_tokenizer_get(t
, 1))) {
470 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
474 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
475 pa_strbuf_puts(buf
, "Failed to parse index.\n");
479 if (!(v
= pa_tokenizer_get(t
, 2))) {
480 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
484 if (pa_atou(v
, &volume
) < 0) {
485 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
489 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
490 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
494 pa_cvolume_set(&cvolume
, si
->sample_spec
.channels
, volume
);
495 pa_sink_input_set_volume(si
, &cvolume
);
499 static int pa_cli_command_source_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
505 pa_core_assert_ref(c
);
510 if (!(n
= pa_tokenizer_get(t
, 1))) {
511 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
515 if (!(v
= pa_tokenizer_get(t
, 2))) {
516 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
520 if (pa_atou(v
, &volume
) < 0) {
521 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
525 if (!(source
= pa_namereg_get(c
, n
, PA_NAMEREG_SOURCE
, 1))) {
526 pa_strbuf_puts(buf
, "No source found by this name or index.\n");
530 pa_cvolume_set(&cvolume
, source
->sample_spec
.channels
, volume
);
531 pa_source_set_volume(source
, &cvolume
);
535 static int pa_cli_command_sink_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
540 pa_core_assert_ref(c
);
545 if (!(n
= pa_tokenizer_get(t
, 1))) {
546 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
550 if (!(m
= pa_tokenizer_get(t
, 2))) {
551 pa_strbuf_puts(buf
, "You need to specify a mute switch setting (0/1).\n");
555 if (pa_atoi(m
, &mute
) < 0) {
556 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
560 if (!(sink
= pa_namereg_get(c
, n
, PA_NAMEREG_SINK
, 1))) {
561 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
565 pa_sink_set_mute(sink
, mute
);
569 static int pa_cli_command_source_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
574 pa_core_assert_ref(c
);
579 if (!(n
= pa_tokenizer_get(t
, 1))) {
580 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
584 if (!(m
= pa_tokenizer_get(t
, 2))) {
585 pa_strbuf_puts(buf
, "You need to specify a mute switch setting (0/1).\n");
589 if (pa_atoi(m
, &mute
) < 0) {
590 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
594 if (!(source
= pa_namereg_get(c
, n
, PA_NAMEREG_SOURCE
, 1))) {
595 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
599 pa_source_set_mute(source
, mute
);
603 static int pa_cli_command_sink_input_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
609 pa_core_assert_ref(c
);
614 if (!(n
= pa_tokenizer_get(t
, 1))) {
615 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
619 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
620 pa_strbuf_puts(buf
, "Failed to parse index.\n");
624 if (!(v
= pa_tokenizer_get(t
, 2))) {
625 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
629 if (pa_atoi(v
, &mute
) < 0) {
630 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
634 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
635 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
639 pa_sink_input_set_mute(si
, mute
);
643 static int pa_cli_command_sink_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
646 pa_core_assert_ref(c
);
651 if (!(n
= pa_tokenizer_get(t
, 1))) {
652 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
656 pa_namereg_set_default(c
, n
, PA_NAMEREG_SINK
);
660 static int pa_cli_command_source_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
663 pa_core_assert_ref(c
);
668 if (!(n
= pa_tokenizer_get(t
, 1))) {
669 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
673 pa_namereg_set_default(c
, n
, PA_NAMEREG_SOURCE
);
677 static int pa_cli_command_kill_client(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
682 pa_core_assert_ref(c
);
687 if (!(n
= pa_tokenizer_get(t
, 1))) {
688 pa_strbuf_puts(buf
, "You need to specify a client by its index.\n");
692 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
693 pa_strbuf_puts(buf
, "Failed to parse index.\n");
697 if (!(client
= pa_idxset_get_by_index(c
->clients
, idx
))) {
698 pa_strbuf_puts(buf
, "No client found by this index.\n");
702 pa_client_kill(client
);
706 static int pa_cli_command_kill_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
708 pa_sink_input
*sink_input
;
711 pa_core_assert_ref(c
);
716 if (!(n
= pa_tokenizer_get(t
, 1))) {
717 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
721 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
722 pa_strbuf_puts(buf
, "Failed to parse index.\n");
726 if (!(sink_input
= pa_idxset_get_by_index(c
->sink_inputs
, idx
))) {
727 pa_strbuf_puts(buf
, "No sink input found by this index.\n");
731 pa_sink_input_kill(sink_input
);
735 static int pa_cli_command_kill_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
737 pa_source_output
*source_output
;
740 pa_core_assert_ref(c
);
745 if (!(n
= pa_tokenizer_get(t
, 1))) {
746 pa_strbuf_puts(buf
, "You need to specify a source output by its index.\n");
750 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
751 pa_strbuf_puts(buf
, "Failed to parse index.\n");
755 if (!(source_output
= pa_idxset_get_by_index(c
->source_outputs
, idx
))) {
756 pa_strbuf_puts(buf
, "No source output found by this index.\n");
760 pa_source_output_kill(source_output
);
764 static int pa_cli_command_scache_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
767 pa_core_assert_ref(c
);
772 pa_assert_se(s
= pa_scache_list_to_string(c
));
773 pa_strbuf_puts(buf
, s
);
779 static int pa_cli_command_scache_play(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
780 const char *n
, *sink_name
;
784 pa_core_assert_ref(c
);
789 if (!(n
= pa_tokenizer_get(t
, 1)) || !(sink_name
= pa_tokenizer_get(t
, 2))) {
790 pa_strbuf_puts(buf
, "You need to specify a sample name and a sink name.\n");
794 if (!(sink
= pa_namereg_get(c
, sink_name
, PA_NAMEREG_SINK
, 1))) {
795 pa_strbuf_puts(buf
, "No sink by that name.\n");
799 if (pa_scache_play_item(c
, n
, sink
, PA_VOLUME_NORM
, NULL
, &idx
) < 0) {
800 pa_strbuf_puts(buf
, "Failed to play sample.\n");
804 pa_strbuf_printf(buf
, "Playing on sink input #%i\n", idx
);
809 static int pa_cli_command_scache_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
812 pa_core_assert_ref(c
);
817 if (!(n
= pa_tokenizer_get(t
, 1))) {
818 pa_strbuf_puts(buf
, "You need to specify a sample name.\n");
822 if (pa_scache_remove_item(c
, n
) < 0) {
823 pa_strbuf_puts(buf
, "Failed to remove sample.\n");
830 static int pa_cli_command_scache_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
831 const char *fname
, *n
;
834 pa_core_assert_ref(c
);
839 if (!(fname
= pa_tokenizer_get(t
, 2)) || !(n
= pa_tokenizer_get(t
, 1))) {
840 pa_strbuf_puts(buf
, "You need to specify a file name and a sample name.\n");
844 if (strstr(pa_tokenizer_get(t
, 0), "lazy"))
845 r
= pa_scache_add_file_lazy(c
, n
, fname
, NULL
);
847 r
= pa_scache_add_file(c
, n
, fname
, NULL
);
850 pa_strbuf_puts(buf
, "Failed to load sound file.\n");
855 static int pa_cli_command_scache_load_dir(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
858 pa_core_assert_ref(c
);
863 if (!(pname
= pa_tokenizer_get(t
, 1))) {
864 pa_strbuf_puts(buf
, "You need to specify a path name.\n");
868 if (pa_scache_add_directory_lazy(c
, pname
) < 0) {
869 pa_strbuf_puts(buf
, "Failed to load directory.\n");
876 static int pa_cli_command_play_file(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
877 const char *fname
, *sink_name
;
880 pa_core_assert_ref(c
);
885 if (!(fname
= pa_tokenizer_get(t
, 1)) || !(sink_name
= pa_tokenizer_get(t
, 2))) {
886 pa_strbuf_puts(buf
, "You need to specify a file name and a sink name.\n");
890 if (!(sink
= pa_namereg_get(c
, sink_name
, PA_NAMEREG_SINK
, 1))) {
891 pa_strbuf_puts(buf
, "No sink by that name.\n");
896 return pa_play_file(sink
, fname
, NULL
);
899 static int pa_cli_command_autoload_add(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
902 pa_core_assert_ref(c
);
907 if (!(a
= pa_tokenizer_get(t
, 1)) || !(b
= pa_tokenizer_get(t
, 2))) {
908 pa_strbuf_puts(buf
, "You need to specify a device name, a filename or a module name and optionally module arguments\n");
912 pa_autoload_add(c
, a
, strstr(pa_tokenizer_get(t
, 0), "sink") ? PA_NAMEREG_SINK
: PA_NAMEREG_SOURCE
, b
, pa_tokenizer_get(t
, 3), NULL
);
917 static int pa_cli_command_autoload_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
920 pa_core_assert_ref(c
);
925 if (!(name
= pa_tokenizer_get(t
, 1))) {
926 pa_strbuf_puts(buf
, "You need to specify a device name\n");
930 if (pa_autoload_remove_by_name(c
, name
, strstr(pa_tokenizer_get(t
, 0), "sink") ? PA_NAMEREG_SINK
: PA_NAMEREG_SOURCE
) < 0) {
931 pa_strbuf_puts(buf
, "Failed to remove autload entry\n");
938 static int pa_cli_command_autoload_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
941 pa_core_assert_ref(c
);
946 pa_assert_se(s
= pa_autoload_list_to_string(c
));
947 pa_strbuf_puts(buf
, s
);
953 static int pa_cli_command_list_props(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
954 pa_core_assert_ref(c
);
959 pa_property_dump(c
, buf
);
963 static int pa_cli_command_vacuum(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
964 pa_core_assert_ref(c
);
969 pa_mempool_vacuum(c
->mempool
);
974 static int pa_cli_command_move_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
980 pa_core_assert_ref(c
);
985 if (!(n
= pa_tokenizer_get(t
, 1))) {
986 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
990 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
991 pa_strbuf_puts(buf
, "Failed to parse index.\n");
995 if (!(k
= pa_tokenizer_get(t
, 2))) {
996 pa_strbuf_puts(buf
, "You need to specify a sink.\n");
1000 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
1001 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
1005 if (!(sink
= pa_namereg_get(c
, k
, PA_NAMEREG_SINK
, 1))) {
1006 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
1010 if (pa_sink_input_move_to(si
, sink
, 0) < 0) {
1011 pa_strbuf_puts(buf
, "Moved failed.\n");
1017 static int pa_cli_command_move_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
1019 pa_source_output
*so
;
1023 pa_core_assert_ref(c
);
1028 if (!(n
= pa_tokenizer_get(t
, 1))) {
1029 pa_strbuf_puts(buf
, "You need to specify a source output by its index.\n");
1033 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
1034 pa_strbuf_puts(buf
, "Failed to parse index.\n");
1038 if (!(k
= pa_tokenizer_get(t
, 2))) {
1039 pa_strbuf_puts(buf
, "You need to specify a source.\n");
1043 if (!(so
= pa_idxset_get_by_index(c
->source_outputs
, (uint32_t) idx
))) {
1044 pa_strbuf_puts(buf
, "No source output found with this index.\n");
1048 if (!(source
= pa_namereg_get(c
, k
, PA_NAMEREG_SOURCE
, 1))) {
1049 pa_strbuf_puts(buf
, "No source found by this name or index.\n");
1053 if (pa_source_output_move_to(so
, source
) < 0) {
1054 pa_strbuf_puts(buf
, "Moved failed.\n");
1060 static int pa_cli_command_suspend_sink(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
1065 pa_core_assert_ref(c
);
1070 if (!(n
= pa_tokenizer_get(t
, 1))) {
1071 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
1075 if (!(m
= pa_tokenizer_get(t
, 2))) {
1076 pa_strbuf_puts(buf
, "You need to specify a suspend switch setting (0/1).\n");
1080 if (pa_atoi(m
, &suspend
) < 0) {
1081 pa_strbuf_puts(buf
, "Failed to parse suspend switch.\n");
1085 if (!(sink
= pa_namereg_get(c
, n
, PA_NAMEREG_SINK
, 1))) {
1086 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
1090 pa_sink_suspend(sink
, suspend
);
1094 static int pa_cli_command_suspend_source(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
1099 pa_core_assert_ref(c
);
1104 if (!(n
= pa_tokenizer_get(t
, 1))) {
1105 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
1109 if (!(m
= pa_tokenizer_get(t
, 2))) {
1110 pa_strbuf_puts(buf
, "You need to specify a suspend switch setting (0/1).\n");
1114 if (pa_atoi(m
, &suspend
) < 0) {
1115 pa_strbuf_puts(buf
, "Failed to parse suspend switch.\n");
1119 if (!(source
= pa_namereg_get(c
, n
, PA_NAMEREG_SOURCE
, 1))) {
1120 pa_strbuf_puts(buf
, "No source found by this name or index.\n");
1124 pa_source_suspend(source
, suspend
);
1128 static int pa_cli_command_suspend(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
1133 pa_core_assert_ref(c
);
1138 if (!(m
= pa_tokenizer_get(t
, 1))) {
1139 pa_strbuf_puts(buf
, "You need to specify a suspend switch setting (0/1).\n");
1143 if (pa_atoi(m
, &suspend
) < 0) {
1144 pa_strbuf_puts(buf
, "Failed to parse suspend switch.\n");
1148 ret
= - (pa_sink_suspend_all(c
, suspend
) < 0);
1149 if (pa_source_suspend_all(c
, suspend
) < 0)
1153 pa_strbuf_puts(buf
, "Failed to resume/suspend all sinks/sources.\n");
1158 static int pa_cli_command_dump(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
1168 pa_autoload_entry
*a
;
1170 pa_core_assert_ref(c
);
1178 pa_strbuf_printf(buf
, "### Configuration dump generated at %s\n", ctime_r(&now
, txt
));
1180 pa_strbuf_printf(buf
, "### Configuration dump generated at %s\n", ctime(&now
));
1183 for (m
= pa_idxset_first(c
->modules
, &idx
); m
; m
= pa_idxset_next(c
->modules
, &idx
)) {
1187 pa_strbuf_printf(buf
, "load-module %s", m
->name
);
1190 pa_strbuf_printf(buf
, " %s", m
->argument
);
1192 pa_strbuf_puts(buf
, "\n");
1197 for (sink
= pa_idxset_first(c
->sinks
, &idx
); sink
; sink
= pa_idxset_next(c
->sinks
, &idx
)) {
1198 if (sink
->module
&& sink
->module
->auto_unload
)
1202 pa_strbuf_puts(buf
, "\n");
1206 pa_strbuf_printf(buf
, "set-sink-volume %s 0x%03x\n", sink
->name
, pa_cvolume_avg(pa_sink_get_volume(sink
)));
1207 pa_strbuf_printf(buf
, "set-sink-mute %s %d\n", sink
->name
, pa_sink_get_mute(sink
));
1210 for (source
= pa_idxset_first(c
->sources
, &idx
); source
; source
= pa_idxset_next(c
->sources
, &idx
)) {
1211 if (source
->module
&& source
->module
->auto_unload
)
1215 pa_strbuf_puts(buf
, "\n");
1219 pa_strbuf_printf(buf
, "set-source-volume %s 0x%03x\n", source
->name
, pa_cvolume_avg(pa_source_get_volume(source
)));
1220 pa_strbuf_printf(buf
, "set-source-mute %s %d\n", source
->name
, pa_source_get_mute(source
));
1224 if (c
->autoload_hashmap
) {
1228 while ((a
= pa_hashmap_iterate(c
->autoload_hashmap
, &i
, NULL
))) {
1231 pa_strbuf_puts(buf
, "\n");
1235 pa_strbuf_printf(buf
, "add-autoload-%s %s %s", a
->type
== PA_NAMEREG_SINK
? "sink" : "source", a
->name
, a
->module
);
1238 pa_strbuf_printf(buf
, " %s", a
->argument
);
1240 pa_strbuf_puts(buf
, "\n");
1246 if ((p
= pa_namereg_get_default_sink_name(c
))) {
1248 pa_strbuf_puts(buf
, "\n");
1251 pa_strbuf_printf(buf
, "set-default-sink %s\n", p
);
1254 if ((p
= pa_namereg_get_default_source_name(c
))) {
1256 pa_strbuf_puts(buf
, "\n");
1259 pa_strbuf_printf(buf
, "set-default-source %s\n", p
);
1262 pa_strbuf_puts(buf
, "\n### EOF\n");
1267 int pa_cli_command_execute_line_stateful(pa_core
*c
, const char *s
, pa_strbuf
*buf
, pa_bool_t
*fail
, int *ifstate
) {
1274 cs
= s
+strspn(s
, whitespace
);
1276 if (*cs
== '#' || !*cs
)
1278 else if (*cs
== '.') {
1279 if (!strcmp(cs
, META_ELSE
)) {
1280 if (!ifstate
|| *ifstate
== IFSTATE_NONE
) {
1281 pa_strbuf_printf(buf
, "Meta command %s is not valid in this context\n", cs
);
1283 } else if (*ifstate
== IFSTATE_TRUE
)
1284 *ifstate
= IFSTATE_FALSE
;
1286 *ifstate
= IFSTATE_TRUE
;
1288 } else if (!strcmp(cs
, META_ENDIF
)) {
1289 if (!ifstate
|| *ifstate
== IFSTATE_NONE
) {
1290 pa_strbuf_printf(buf
, "Meta command %s is not valid in this context\n", cs
);
1293 *ifstate
= IFSTATE_NONE
;
1296 if (ifstate
&& *ifstate
== IFSTATE_FALSE
)
1298 if (!strcmp(cs
, META_FAIL
))
1300 else if (!strcmp(cs
, META_NOFAIL
))
1304 l
= strcspn(cs
, whitespace
);
1306 if (l
== sizeof(META_INCLUDE
)-1 && !strncmp(cs
, META_INCLUDE
, l
)) {
1307 const char *filename
= cs
+l
+strspn(cs
+l
, whitespace
);
1308 if (pa_cli_command_execute_file(c
, filename
, buf
, fail
) < 0)
1311 } else if (l
== sizeof(META_IFEXISTS
)-1 && !strncmp(cs
, META_IFEXISTS
, l
)) {
1313 pa_strbuf_printf(buf
, "Meta command %s is not valid in this context\n", cs
);
1315 } else if (*ifstate
!= IFSTATE_NONE
) {
1316 pa_strbuf_printf(buf
, "Nested %s commands not supported\n", cs
);
1319 const char *filename
= cs
+l
+strspn(cs
+l
, whitespace
);
1321 *ifstate
= access(filename
, F_OK
) == 0 ? IFSTATE_TRUE
: IFSTATE_FALSE
;
1322 pa_log_debug("Checking for existance of '%s': %s", filename
, *ifstate
== IFSTATE_TRUE
? "success" : "failure");
1325 pa_strbuf_printf(buf
, "Invalid meta command: %s\n", cs
);
1326 if (*fail
) return -1;
1330 const struct command
*command
;
1334 if (ifstate
&& *ifstate
== IFSTATE_FALSE
)
1337 l
= strcspn(cs
, whitespace
);
1339 for (command
= commands
; command
->name
; command
++)
1340 if (strlen(command
->name
) == l
&& !strncmp(cs
, command
->name
, l
)) {
1342 pa_tokenizer
*t
= pa_tokenizer_new(cs
, command
->args
);
1344 ret
= command
->proc(c
, t
, buf
, fail
);
1345 pa_tokenizer_free(t
);
1348 if (ret
< 0 && *fail
)
1355 pa_strbuf_printf(buf
, "Unknown command: %s\n", cs
);
1364 int pa_cli_command_execute_line(pa_core
*c
, const char *s
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
1365 return pa_cli_command_execute_line_stateful(c
, s
, buf
, fail
, NULL
);
1368 int pa_cli_command_execute_file(pa_core
*c
, const char *fn
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
1371 int ifstate
= IFSTATE_NONE
;
1378 if (!(f
= fopen(fn
, "r"))) {
1379 pa_strbuf_printf(buf
, "open('%s') failed: %s\n", fn
, pa_cstrerror(errno
));
1385 while (fgets(line
, sizeof(line
), f
)) {
1386 char *e
= line
+ strcspn(line
, linebreak
);
1389 if (pa_cli_command_execute_line_stateful(c
, line
, buf
, fail
, &ifstate
) < 0 && *fail
)
1402 int pa_cli_command_execute(pa_core
*c
, const char *s
, pa_strbuf
*buf
, pa_bool_t
*fail
) {
1404 int ifstate
= IFSTATE_NONE
;
1412 size_t l
= strcspn(p
, linebreak
);
1413 char *line
= pa_xstrndup(p
, l
);
1415 if (pa_cli_command_execute_line_stateful(c
, line
, buf
, fail
, &ifstate
) < 0 && *fail
) {
1422 p
+= strspn(p
, linebreak
);