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
36 #include <pulse/xmalloc.h>
38 #include <pulsecore/module.h>
39 #include <pulsecore/sink.h>
40 #include <pulsecore/source.h>
41 #include <pulsecore/client.h>
42 #include <pulsecore/sink-input.h>
43 #include <pulsecore/source-output.h>
44 #include <pulsecore/tokenizer.h>
45 #include <pulsecore/strbuf.h>
46 #include <pulsecore/namereg.h>
47 #include <pulsecore/cli-text.h>
48 #include <pulsecore/core-scache.h>
49 #include <pulsecore/sample-util.h>
50 #include <pulsecore/sound-file.h>
51 #include <pulsecore/play-memchunk.h>
52 #include <pulsecore/autoload.h>
53 #include <pulsecore/sound-file-stream.h>
54 #include <pulsecore/props.h>
55 #include <pulsecore/core-util.h>
56 #include <pulsecore/core-error.h>
58 #include "cli-command.h"
62 int (*proc) (pa_core *c, pa_tokenizer*t, pa_strbuf *buf, int *fail);
67 #define META_INCLUDE ".include"
68 #define META_FAIL ".fail"
69 #define META_NOFAIL ".nofail"
70 #define META_IFEXISTS ".ifexists"
71 #define META_ELSE ".else"
72 #define META_ENDIF ".endif"
80 /* Prototypes for all available commands */
81 static int pa_cli_command_exit(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
82 static int pa_cli_command_help(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
83 static int pa_cli_command_modules(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
84 static int pa_cli_command_clients(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
85 static int pa_cli_command_sinks(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
86 static int pa_cli_command_sources(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
87 static int pa_cli_command_sink_inputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
88 static int pa_cli_command_source_outputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
89 static int pa_cli_command_stat(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
90 static int pa_cli_command_info(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
91 static int pa_cli_command_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
92 static int pa_cli_command_unload(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
93 static int pa_cli_command_sink_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
94 static int pa_cli_command_sink_input_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
95 static int pa_cli_command_source_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
96 static int pa_cli_command_sink_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
97 static int pa_cli_command_source_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
98 static int pa_cli_command_sink_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
99 static int pa_cli_command_source_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
100 static int pa_cli_command_kill_client(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
101 static int pa_cli_command_kill_sink_input(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
102 static int pa_cli_command_kill_source_output(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
103 static int pa_cli_command_scache_play(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
104 static int pa_cli_command_scache_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
105 static int pa_cli_command_scache_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
106 static int pa_cli_command_scache_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
107 static int pa_cli_command_scache_load_dir(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
108 static int pa_cli_command_play_file(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
109 static int pa_cli_command_autoload_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
110 static int pa_cli_command_autoload_add(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
111 static int pa_cli_command_autoload_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
112 static int pa_cli_command_dump(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
113 static int pa_cli_command_list_props(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
114 static int pa_cli_command_move_sink_input(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
115 static int pa_cli_command_move_source_output(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
116 static int pa_cli_command_vacuum(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail);
118 /* A method table for all available commands */
120 static const struct command commands[] = {
121 { "exit", pa_cli_command_exit, "Terminate the daemon", 1 },
122 { "help", pa_cli_command_help, "Show this help", 1 },
123 { "list-modules", pa_cli_command_modules, "List loaded modules", 1 },
124 { "list-sinks", pa_cli_command_sinks, "List loaded sinks", 1 },
125 { "list-sources", pa_cli_command_sources, "List loaded sources", 1 },
126 { "list-clients", pa_cli_command_clients, "List loaded clients", 1 },
127 { "list-sink-inputs", pa_cli_command_sink_inputs, "List sink inputs", 1 },
128 { "list-source-outputs", pa_cli_command_source_outputs, "List source outputs", 1 },
129 { "stat", pa_cli_command_stat, "Show memory block statistics", 1 },
130 { "info", pa_cli_command_info, "Show comprehensive status", 1 },
131 { "ls", pa_cli_command_info, NULL, 1 },
132 { "list", pa_cli_command_info, NULL, 1 },
133 { "load-module", pa_cli_command_load, "Load a module (args: name, arguments)", 3},
134 { "unload-module", pa_cli_command_unload, "Unload a module (args: index)", 2},
135 { "set-sink-volume", pa_cli_command_sink_volume, "Set the volume of a sink (args: index|name, volume)", 3},
136 { "set-sink-input-volume", pa_cli_command_sink_input_volume, "Set the volume of a sink input (args: index|name, volume)", 3},
137 { "set-source-volume", pa_cli_command_source_volume, "Set the volume of a source (args: index|name, volume)", 3},
138 { "set-sink-mute", pa_cli_command_sink_mute, "Set the mute switch of a sink (args: index|name, mute)", 3},
139 { "set-source-mute", pa_cli_command_source_mute, "Set the mute switch of a source (args: index|name, mute)", 3},
140 { "set-default-sink", pa_cli_command_sink_default, "Set the default sink (args: index|name)", 2},
141 { "set-default-source", pa_cli_command_source_default, "Set the default source (args: index|name)", 2},
142 { "kill-client", pa_cli_command_kill_client, "Kill a client (args: index)", 2},
143 { "kill-sink-input", pa_cli_command_kill_sink_input, "Kill a sink input (args: index)", 2},
144 { "kill-source-output", pa_cli_command_kill_source_output, "Kill a source output (args: index)", 2},
145 { "list-samples", pa_cli_command_scache_list, "List all entries in the sample cache", 1},
146 { "play-sample", pa_cli_command_scache_play, "Play a sample from the sample cache (args: name, sink|index)", 3},
147 { "remove-sample", pa_cli_command_scache_remove, "Remove a sample from the sample cache (args: name)", 2},
148 { "load-sample", pa_cli_command_scache_load, "Load a sound file into the sample cache (args: name, filename)", 3},
149 { "load-sample-lazy", pa_cli_command_scache_load, "Lazily load a sound file into the sample cache (args: name, filename)", 3},
150 { "load-sample-dir-lazy", pa_cli_command_scache_load_dir, "Lazily load all files in a directory into the sample cache (args: pathname)", 2},
151 { "play-file", pa_cli_command_play_file, "Play a sound file (args: filename, sink|index)", 3},
152 { "list-autoload", pa_cli_command_autoload_list, "List autoload entries", 1},
153 { "add-autoload-sink", pa_cli_command_autoload_add, "Add autoload entry for a sink (args: sink, module name, arguments)", 4},
154 { "add-autoload-source", pa_cli_command_autoload_add, "Add autoload entry for a source (args: source, module name, arguments)", 4},
155 { "remove-autoload-sink", pa_cli_command_autoload_remove, "Remove autoload entry for a sink (args: name)", 2},
156 { "remove-autoload-source", pa_cli_command_autoload_remove, "Remove autoload entry for a source (args: name)", 2},
157 { "dump", pa_cli_command_dump, "Dump daemon configuration", 1},
158 { "list-props", pa_cli_command_list_props, NULL, 1},
159 { "move-sink-input", pa_cli_command_move_sink_input, "Move sink input to another sink (args: index, sink)", 3},
160 { "move-source-output", pa_cli_command_move_source_output, "Move source output to another source (args: index, source)", 3},
161 { "vacuum", pa_cli_command_vacuum, NULL, 1},
162 { NULL, NULL, NULL, 0 }
165 static const char whitespace[] = " \t\n\r";
166 static const char linebreak[] = "\n\r";
168 static uint32_t parse_index(const char *n) {
171 if (pa_atou(n, &idx) < 0)
172 return (uint32_t) PA_IDXSET_INVALID;
177 static int pa_cli_command_exit(pa_core *c, pa_tokenizer *t, PA_GCC_UNUSED pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
178 assert(c && c->mainloop && t);
179 c->mainloop->quit(c->mainloop, 0);
183 static int pa_cli_command_help(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
184 const struct command*command;
185 assert(c && t && buf);
187 pa_strbuf_puts(buf, "Available commands:\n");
189 for (command = commands; command->name; command++)
191 pa_strbuf_printf(buf, " %-25s %s\n", command->name, command->help);
195 static int pa_cli_command_modules(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
198 s = pa_module_list_to_string(c);
200 pa_strbuf_puts(buf, s);
205 static int pa_cli_command_clients(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
208 s = pa_client_list_to_string(c);
210 pa_strbuf_puts(buf, s);
215 static int pa_cli_command_sinks(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
218 s = pa_sink_list_to_string(c);
220 pa_strbuf_puts(buf, s);
225 static int pa_cli_command_sources(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
228 s = pa_source_list_to_string(c);
230 pa_strbuf_puts(buf, s);
235 static int pa_cli_command_sink_inputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
238 s = pa_sink_input_list_to_string(c);
240 pa_strbuf_puts(buf, s);
245 static int pa_cli_command_source_outputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
248 s = pa_source_output_list_to_string(c);
250 pa_strbuf_puts(buf, s);
255 static int pa_cli_command_stat(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
257 const pa_mempool_stat *stat;
259 const char *def_sink, *def_source;
261 static const char* const type_table[PA_MEMBLOCK_TYPE_MAX] = {
262 [PA_MEMBLOCK_POOL] = "POOL",
263 [PA_MEMBLOCK_POOL_EXTERNAL] = "POOL_EXTERNAL",
264 [PA_MEMBLOCK_APPENDED] = "APPENDED",
265 [PA_MEMBLOCK_USER] = "USER",
266 [PA_MEMBLOCK_FIXED] = "FIXED",
267 [PA_MEMBLOCK_IMPORTED] = "IMPORTED",
273 stat = pa_mempool_get_stat(c->mempool);
275 pa_strbuf_printf(buf, "Memory blocks currently allocated: %u, size: %s.\n",
276 (unsigned) pa_atomic_load(&stat->n_allocated),
277 pa_bytes_snprint(s, sizeof(s), (size_t) pa_atomic_load(&stat->allocated_size)));
279 pa_strbuf_printf(buf, "Memory blocks allocated during the whole lifetime: %u, size: %s.\n",
280 (unsigned) pa_atomic_load(&stat->n_accumulated),
281 pa_bytes_snprint(s, sizeof(s), (size_t) pa_atomic_load(&stat->accumulated_size)));
283 pa_strbuf_printf(buf, "Memory blocks imported from other processes: %u, size: %s.\n",
284 (unsigned) pa_atomic_load(&stat->n_imported),
285 pa_bytes_snprint(s, sizeof(s), (size_t) pa_atomic_load(&stat->imported_size)));
287 pa_strbuf_printf(buf, "Memory blocks exported to other processes: %u, size: %s.\n",
288 (unsigned) pa_atomic_load(&stat->n_exported),
289 pa_bytes_snprint(s, sizeof(s), (size_t) pa_atomic_load(&stat->exported_size)));
291 pa_strbuf_printf(buf, "Total sample cache size: %s.\n",
292 pa_bytes_snprint(s, sizeof(s), pa_scache_total_size(c)));
294 pa_strbuf_printf(buf, "Default sample spec: %s\n",
295 pa_sample_spec_snprint(s, sizeof(s), &c->default_sample_spec));
297 def_sink = pa_namereg_get_default_sink_name(c);
298 def_source = pa_namereg_get_default_source_name(c);
299 pa_strbuf_printf(buf, "Default sink name: %s\n"
300 "Default source name: %s\n",
301 def_sink ? def_sink : "none",
302 def_source ? def_source : "none");
304 for (k = 0; k < PA_MEMBLOCK_TYPE_MAX; k++)
305 pa_strbuf_printf(buf,
306 "Memory blocks of type %s: %u allocated/%u accumulated.\n",
308 (unsigned) pa_atomic_load(&stat->n_allocated_by_type[k]),
309 (unsigned) pa_atomic_load(&stat->n_accumulated_by_type[k]));
314 static int pa_cli_command_info(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
316 pa_cli_command_stat(c, t, buf, fail);
317 pa_cli_command_modules(c, t, buf, fail);
318 pa_cli_command_sinks(c, t, buf, fail);
319 pa_cli_command_sources(c, t, buf, fail);
320 pa_cli_command_clients(c, t, buf, fail);
321 pa_cli_command_sink_inputs(c, t, buf, fail);
322 pa_cli_command_source_outputs(c, t, buf, fail);
323 pa_cli_command_scache_list(c, t, buf, fail);
324 pa_cli_command_autoload_list(c, t, buf, fail);
328 static int pa_cli_command_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
333 if (!(name = pa_tokenizer_get(t, 1))) {
334 pa_strbuf_puts(buf, "You need to specify the module name and optionally arguments.\n");
338 if (!(m = pa_module_load(c, name, pa_tokenizer_get(t, 2)))) {
339 pa_strbuf_puts(buf, "Module load failed.\n");
346 static int pa_cli_command_unload(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
353 if (!(i = pa_tokenizer_get(t, 1))) {
354 pa_strbuf_puts(buf, "You need to specify the module index.\n");
358 idx = (uint32_t) strtoul(i, &e, 10);
359 if (*e || !(m = pa_idxset_get_by_index(c->modules, idx))) {
360 pa_strbuf_puts(buf, "Invalid module index.\n");
364 pa_module_unload_request(m);
368 static int pa_cli_command_sink_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
374 if (!(n = pa_tokenizer_get(t, 1))) {
375 pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
379 if (!(v = pa_tokenizer_get(t, 2))) {
380 pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
384 if (pa_atou(v, &volume) < 0) {
385 pa_strbuf_puts(buf, "Failed to parse volume.\n");
389 if (!(sink = pa_namereg_get(c, n, PA_NAMEREG_SINK, 1))) {
390 pa_strbuf_puts(buf, "No sink found by this name or index.\n");
394 pa_cvolume_set(&cvolume, sink->sample_spec.channels, volume);
395 pa_sink_set_volume(sink, PA_MIXER_HARDWARE, &cvolume);
399 static int pa_cli_command_sink_input_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
406 if (!(n = pa_tokenizer_get(t, 1))) {
407 pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
411 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
412 pa_strbuf_puts(buf, "Failed to parse index.\n");
416 if (!(v = pa_tokenizer_get(t, 2))) {
417 pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
421 if (pa_atou(v, &volume) < 0) {
422 pa_strbuf_puts(buf, "Failed to parse volume.\n");
426 if (!(si = pa_idxset_get_by_index(c->sink_inputs, (uint32_t) idx))) {
427 pa_strbuf_puts(buf, "No sink input found with this index.\n");
431 pa_cvolume_set(&cvolume, si->sample_spec.channels, volume);
432 pa_sink_input_set_volume(si, &cvolume);
436 static int pa_cli_command_source_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
442 if (!(n = pa_tokenizer_get(t, 1))) {
443 pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
447 if (!(v = pa_tokenizer_get(t, 2))) {
448 pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
452 if (pa_atou(v, &volume) < 0) {
453 pa_strbuf_puts(buf, "Failed to parse volume.\n");
457 if (!(source = pa_namereg_get(c, n, PA_NAMEREG_SOURCE, 1))) {
458 pa_strbuf_puts(buf, "No source found by this name or index.\n");
462 pa_cvolume_set(&cvolume, source->sample_spec.channels, volume);
463 pa_source_set_volume(source, PA_MIXER_HARDWARE, &cvolume);
467 static int pa_cli_command_sink_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
472 if (!(n = pa_tokenizer_get(t, 1))) {
473 pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
477 if (!(m = pa_tokenizer_get(t, 2))) {
478 pa_strbuf_puts(buf, "You need to specify a mute switch setting (0/1).\n");
482 if (pa_atoi(m, &mute) < 0) {
483 pa_strbuf_puts(buf, "Failed to parse mute switch.\n");
487 if (!(sink = pa_namereg_get(c, n, PA_NAMEREG_SINK, 1))) {
488 pa_strbuf_puts(buf, "No sink found by this name or index.\n");
492 pa_sink_set_mute(sink, PA_MIXER_HARDWARE, mute);
496 static int pa_cli_command_source_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
501 if (!(n = pa_tokenizer_get(t, 1))) {
502 pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
506 if (!(m = pa_tokenizer_get(t, 2))) {
507 pa_strbuf_puts(buf, "You need to specify a mute switch setting (0/1).\n");
511 if (pa_atoi(m, &mute) < 0) {
512 pa_strbuf_puts(buf, "Failed to parse mute switch.\n");
516 if (!(source = pa_namereg_get(c, n, PA_NAMEREG_SOURCE, 1))) {
517 pa_strbuf_puts(buf, "No sink found by this name or index.\n");
521 pa_source_set_mute(source, PA_MIXER_HARDWARE, mute);
525 static int pa_cli_command_sink_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
529 if (!(n = pa_tokenizer_get(t, 1))) {
530 pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
534 pa_namereg_set_default(c, n, PA_NAMEREG_SINK);
538 static int pa_cli_command_source_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
542 if (!(n = pa_tokenizer_get(t, 1))) {
543 pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
547 pa_namereg_set_default(c, n, PA_NAMEREG_SOURCE);
551 static int pa_cli_command_kill_client(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
557 if (!(n = pa_tokenizer_get(t, 1))) {
558 pa_strbuf_puts(buf, "You need to specify a client by its index.\n");
562 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
563 pa_strbuf_puts(buf, "Failed to parse index.\n");
567 if (!(client = pa_idxset_get_by_index(c->clients, idx))) {
568 pa_strbuf_puts(buf, "No client found by this index.\n");
572 pa_client_kill(client);
576 static int pa_cli_command_kill_sink_input(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
578 pa_sink_input *sink_input;
582 if (!(n = pa_tokenizer_get(t, 1))) {
583 pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
587 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
588 pa_strbuf_puts(buf, "Failed to parse index.\n");
592 if (!(sink_input = pa_idxset_get_by_index(c->sink_inputs, idx))) {
593 pa_strbuf_puts(buf, "No sink input found by this index.\n");
597 pa_sink_input_kill(sink_input);
601 static int pa_cli_command_kill_source_output(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
603 pa_source_output *source_output;
607 if (!(n = pa_tokenizer_get(t, 1))) {
608 pa_strbuf_puts(buf, "You need to specify a source output by its index.\n");
612 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
613 pa_strbuf_puts(buf, "Failed to parse index.\n");
617 if (!(source_output = pa_idxset_get_by_index(c->source_outputs, idx))) {
618 pa_strbuf_puts(buf, "No source output found by this index.\n");
622 pa_source_output_kill(source_output);
626 static int pa_cli_command_scache_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
629 s = pa_scache_list_to_string(c);
631 pa_strbuf_puts(buf, s);
636 static int pa_cli_command_scache_play(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
637 const char *n, *sink_name;
639 assert(c && t && buf && fail);
641 if (!(n = pa_tokenizer_get(t, 1)) || !(sink_name = pa_tokenizer_get(t, 2))) {
642 pa_strbuf_puts(buf, "You need to specify a sample name and a sink name.\n");
646 if (!(sink = pa_namereg_get(c, sink_name, PA_NAMEREG_SINK, 1))) {
647 pa_strbuf_puts(buf, "No sink by that name.\n");
651 if (pa_scache_play_item(c, n, sink, PA_VOLUME_NORM) < 0) {
652 pa_strbuf_puts(buf, "Failed to play sample.\n");
659 static int pa_cli_command_scache_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
661 assert(c && t && buf && fail);
663 if (!(n = pa_tokenizer_get(t, 1))) {
664 pa_strbuf_puts(buf, "You need to specify a sample name.\n");
668 if (pa_scache_remove_item(c, n) < 0) {
669 pa_strbuf_puts(buf, "Failed to remove sample.\n");
676 static int pa_cli_command_scache_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
677 const char *fname, *n;
679 assert(c && t && buf && fail);
681 if (!(fname = pa_tokenizer_get(t, 2)) || !(n = pa_tokenizer_get(t, 1))) {
682 pa_strbuf_puts(buf, "You need to specify a file name and a sample name.\n");
686 if (strstr(pa_tokenizer_get(t, 0), "lazy"))
687 r = pa_scache_add_file_lazy(c, n, fname, NULL);
689 r = pa_scache_add_file(c, n, fname, NULL);
692 pa_strbuf_puts(buf, "Failed to load sound file.\n");
697 static int pa_cli_command_scache_load_dir(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
699 assert(c && t && buf && fail);
701 if (!(pname = pa_tokenizer_get(t, 1))) {
702 pa_strbuf_puts(buf, "You need to specify a path name.\n");
706 if (pa_scache_add_directory_lazy(c, pname) < 0) {
707 pa_strbuf_puts(buf, "Failed to load directory.\n");
714 static int pa_cli_command_play_file(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
715 const char *fname, *sink_name;
717 assert(c && t && buf && fail);
719 if (!(fname = pa_tokenizer_get(t, 1)) || !(sink_name = pa_tokenizer_get(t, 2))) {
720 pa_strbuf_puts(buf, "You need to specify a file name and a sink name.\n");
724 if (!(sink = pa_namereg_get(c, sink_name, PA_NAMEREG_SINK, 1))) {
725 pa_strbuf_puts(buf, "No sink by that name.\n");
730 return pa_play_file(sink, fname, NULL);
733 static int pa_cli_command_autoload_add(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
735 assert(c && t && buf && fail);
737 if (!(a = pa_tokenizer_get(t, 1)) || !(b = pa_tokenizer_get(t, 2))) {
738 pa_strbuf_puts(buf, "You need to specify a device name, a filename or a module name and optionally module arguments\n");
742 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);
747 static int pa_cli_command_autoload_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
749 assert(c && t && buf && fail);
751 if (!(name = pa_tokenizer_get(t, 1))) {
752 pa_strbuf_puts(buf, "You need to specify a device name\n");
756 if (pa_autoload_remove_by_name(c, name, strstr(pa_tokenizer_get(t, 0), "sink") ? PA_NAMEREG_SINK : PA_NAMEREG_SOURCE) < 0) {
757 pa_strbuf_puts(buf, "Failed to remove autload entry\n");
764 static int pa_cli_command_autoload_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
767 s = pa_autoload_list_to_string(c);
769 pa_strbuf_puts(buf, s);
774 static int pa_cli_command_list_props(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
776 pa_property_dump(c, buf);
780 static int pa_cli_command_vacuum(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
784 pa_mempool_vacuum(c->mempool);
789 static int pa_cli_command_move_sink_input(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
795 if (!(n = pa_tokenizer_get(t, 1))) {
796 pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
800 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
801 pa_strbuf_puts(buf, "Failed to parse index.\n");
805 if (!(k = pa_tokenizer_get(t, 2))) {
806 pa_strbuf_puts(buf, "You need to specify a sink.\n");
810 if (!(si = pa_idxset_get_by_index(c->sink_inputs, (uint32_t) idx))) {
811 pa_strbuf_puts(buf, "No sink input found with this index.\n");
815 if (!(sink = pa_namereg_get(c, k, PA_NAMEREG_SINK, 1))) {
816 pa_strbuf_puts(buf, "No sink found by this name or index.\n");
820 if (pa_sink_input_move_to(si, sink, 0) < 0) {
821 pa_strbuf_puts(buf, "Moved failed.\n");
827 static int pa_cli_command_move_source_output(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
829 pa_source_output *so;
833 if (!(n = pa_tokenizer_get(t, 1))) {
834 pa_strbuf_puts(buf, "You need to specify a source output by its index.\n");
838 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
839 pa_strbuf_puts(buf, "Failed to parse index.\n");
843 if (!(k = pa_tokenizer_get(t, 2))) {
844 pa_strbuf_puts(buf, "You need to specify a source.\n");
848 if (!(so = pa_idxset_get_by_index(c->source_outputs, (uint32_t) idx))) {
849 pa_strbuf_puts(buf, "No source output found with this index.\n");
853 if (!(source = pa_namereg_get(c, k, PA_NAMEREG_SOURCE, 1))) {
854 pa_strbuf_puts(buf, "No source found by this name or index.\n");
858 if (pa_source_output_move_to(so, source) < 0) {
859 pa_strbuf_puts(buf, "Moved failed.\n");
865 static int pa_cli_command_dump(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
875 pa_autoload_entry *a;
882 pa_strbuf_printf(buf, "### Configuration dump generated at %s\n", ctime_r(&now, txt));
884 pa_strbuf_printf(buf, "### Configuration dump generated at %s\n", ctime(&now));
888 for (m = pa_idxset_first(c->modules, &idx); m; m = pa_idxset_next(c->modules, &idx)) {
892 pa_strbuf_printf(buf, "load-module %s", m->name);
895 pa_strbuf_printf(buf, " %s", m->argument);
897 pa_strbuf_puts(buf, "\n");
902 for (sink = pa_idxset_first(c->sinks, &idx); sink; sink = pa_idxset_next(c->sinks, &idx)) {
903 if (sink->owner && sink->owner->auto_unload)
907 pa_strbuf_puts(buf, "\n");
911 pa_strbuf_printf(buf, "set-sink-volume %s 0x%03x\n", sink->name, pa_cvolume_avg(pa_sink_get_volume(sink, PA_MIXER_HARDWARE)));
912 pa_strbuf_printf(buf, "set-sink-mute %s %d\n", sink->name, pa_sink_get_mute(sink, PA_MIXER_HARDWARE));
915 for (source = pa_idxset_first(c->sources, &idx); source; source = pa_idxset_next(c->sources, &idx)) {
916 if (source->owner && source->owner->auto_unload)
920 pa_strbuf_puts(buf, "\n");
924 pa_strbuf_printf(buf, "set-source-volume %s 0x%03x\n", source->name, pa_cvolume_avg(pa_source_get_volume(source, PA_MIXER_HARDWARE)));
925 pa_strbuf_printf(buf, "set-source-mute %s %d\n", source->name, pa_source_get_mute(source, PA_MIXER_HARDWARE));
929 if (c->autoload_hashmap) {
933 while ((a = pa_hashmap_iterate(c->autoload_hashmap, &i, NULL))) {
936 pa_strbuf_puts(buf, "\n");
940 pa_strbuf_printf(buf, "add-autoload-%s %s %s", a->type == PA_NAMEREG_SINK ? "sink" : "source", a->name, a->module);
943 pa_strbuf_printf(buf, " %s", a->argument);
945 pa_strbuf_puts(buf, "\n");
951 if ((p = pa_namereg_get_default_sink_name(c))) {
953 pa_strbuf_puts(buf, "\n");
956 pa_strbuf_printf(buf, "set-default-sink %s\n", p);
959 if ((p = pa_namereg_get_default_source_name(c))) {
961 pa_strbuf_puts(buf, "\n");
964 pa_strbuf_printf(buf, "set-default-source %s\n", p);
967 pa_strbuf_puts(buf, "\n### EOF\n");
972 int pa_cli_command_execute_line_stateful(pa_core *c, const char *s, pa_strbuf *buf, int *fail, int *ifstate) {
975 cs = s+strspn(s, whitespace);
977 if (*cs == '#' || !*cs)
979 else if (*cs == '.') {
980 if (!strcmp(cs, META_ELSE)) {
981 if (!ifstate || *ifstate == IFSTATE_NONE) {
982 pa_strbuf_printf(buf, "Meta command %s is not valid in this context\n", cs);
984 } else if (*ifstate == IFSTATE_TRUE)
985 *ifstate = IFSTATE_FALSE;
987 *ifstate = IFSTATE_TRUE;
989 } else if (!strcmp(cs, META_ENDIF)) {
990 if (!ifstate || *ifstate == IFSTATE_NONE) {
991 pa_strbuf_printf(buf, "Meta command %s is not valid in this context\n", cs);
994 *ifstate = IFSTATE_NONE;
997 if (ifstate && *ifstate == IFSTATE_FALSE)
999 if (!strcmp(cs, META_FAIL))
1001 else if (!strcmp(cs, META_NOFAIL))
1005 l = strcspn(cs, whitespace);
1007 if (l == sizeof(META_INCLUDE)-1 && !strncmp(cs, META_INCLUDE, l)) {
1008 const char *filename = cs+l+strspn(cs+l, whitespace);
1010 if (pa_cli_command_execute_file(c, filename, buf, fail) < 0)
1011 if (*fail) return -1;
1012 } else if (l == sizeof(META_IFEXISTS)-1 && !strncmp(cs, META_IFEXISTS, l)) {
1014 pa_strbuf_printf(buf, "Meta command %s is not valid in this context\n", cs);
1016 } else if (*ifstate != IFSTATE_NONE) {
1017 pa_strbuf_printf(buf, "Nested %s commands not supported\n", cs);
1020 const char *filename = cs+l+strspn(cs+l, whitespace);
1022 *ifstate = access(filename, F_OK) == 0 ? IFSTATE_TRUE : IFSTATE_FALSE;
1025 pa_strbuf_printf(buf, "Invalid meta command: %s\n", cs);
1026 if (*fail) return -1;
1030 const struct command*command;
1034 if (ifstate && *ifstate == IFSTATE_FALSE)
1038 l = strcspn(cs, whitespace);
1040 for (command = commands; command->name; command++)
1041 if (strlen(command->name) == l && !strncmp(cs, command->name, l)) {
1043 pa_tokenizer *t = pa_tokenizer_new(cs, command->args);
1045 ret = command->proc(c, t, buf, fail);
1046 pa_tokenizer_free(t);
1049 if (ret < 0 && *fail)
1056 pa_strbuf_printf(buf, "Unknown command: %s\n", cs);
1065 int pa_cli_command_execute_line(pa_core *c, const char *s, pa_strbuf *buf, int *fail) {
1066 return pa_cli_command_execute_line_stateful(c, s, buf, fail, NULL);
1069 int pa_cli_command_execute_file(pa_core *c, const char *fn, pa_strbuf *buf, int *fail) {
1072 int ifstate = IFSTATE_NONE;
1079 if (!(f = fopen(fn, "r"))) {
1080 pa_strbuf_printf(buf, "open('%s') failed: %s\n", fn, pa_cstrerror(errno));
1086 while (fgets(line, sizeof(line), f)) {
1087 char *e = line + strcspn(line, linebreak);
1090 if (pa_cli_command_execute_line_stateful(c, line, buf, fail, &ifstate) < 0 && *fail)
1103 int pa_cli_command_execute(pa_core *c, const char *s, pa_strbuf *buf, int *fail) {
1105 int ifstate = IFSTATE_NONE;
1113 size_t l = strcspn(p, linebreak);
1114 char *line = pa_xstrndup(p, l);
1116 if (pa_cli_command_execute_line_stateful(c, line, buf, fail, &ifstate) < 0 && *fail) {
1123 p += strspn(p, linebreak);