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_input_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
99 static int pa_cli_command_sink_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
100 static int pa_cli_command_source_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
101 static int pa_cli_command_kill_client(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
102 static int pa_cli_command_kill_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
103 static int pa_cli_command_kill_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
104 static int pa_cli_command_scache_play(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
105 static int pa_cli_command_scache_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
106 static int pa_cli_command_scache_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
107 static int pa_cli_command_scache_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
108 static int pa_cli_command_scache_load_dir(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
109 static int pa_cli_command_play_file(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
110 static int pa_cli_command_autoload_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
111 static int pa_cli_command_autoload_add(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
112 static int pa_cli_command_autoload_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
113 static int pa_cli_command_dump(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
114 static int pa_cli_command_list_props(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
115 static int pa_cli_command_move_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
116 static int pa_cli_command_move_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
117 static int pa_cli_command_vacuum(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
119 /* A method table for all available commands */
121 static const struct command commands
[] = {
122 { "exit", pa_cli_command_exit
, "Terminate the daemon", 1 },
123 { "help", pa_cli_command_help
, "Show this help", 1 },
124 { "list-modules", pa_cli_command_modules
, "List loaded modules", 1 },
125 { "list-sinks", pa_cli_command_sinks
, "List loaded sinks", 1 },
126 { "list-sources", pa_cli_command_sources
, "List loaded sources", 1 },
127 { "list-clients", pa_cli_command_clients
, "List loaded clients", 1 },
128 { "list-sink-inputs", pa_cli_command_sink_inputs
, "List sink inputs", 1 },
129 { "list-source-outputs", pa_cli_command_source_outputs
, "List source outputs", 1 },
130 { "stat", pa_cli_command_stat
, "Show memory block statistics", 1 },
131 { "info", pa_cli_command_info
, "Show comprehensive status", 1 },
132 { "ls", pa_cli_command_info
, NULL
, 1 },
133 { "list", pa_cli_command_info
, NULL
, 1 },
134 { "load-module", pa_cli_command_load
, "Load a module (args: name, arguments)", 3},
135 { "unload-module", pa_cli_command_unload
, "Unload a module (args: index)", 2},
136 { "set-sink-volume", pa_cli_command_sink_volume
, "Set the volume of a sink (args: index|name, volume)", 3},
137 { "set-sink-input-volume", pa_cli_command_sink_input_volume
, "Set the volume of a sink input (args: index|name, volume)", 3},
138 { "set-source-volume", pa_cli_command_source_volume
, "Set the volume of a source (args: index|name, volume)", 3},
139 { "set-sink-mute", pa_cli_command_sink_mute
, "Set the mute switch of a sink (args: index|name, mute)", 3},
140 { "set-sink-input-mute", pa_cli_command_sink_input_mute
, "Set the mute switch of a sink input (args: index|name, mute)", 3},
141 { "set-source-mute", pa_cli_command_source_mute
, "Set the mute switch of a source (args: index|name, mute)", 3},
142 { "set-default-sink", pa_cli_command_sink_default
, "Set the default sink (args: index|name)", 2},
143 { "set-default-source", pa_cli_command_source_default
, "Set the default source (args: index|name)", 2},
144 { "kill-client", pa_cli_command_kill_client
, "Kill a client (args: index)", 2},
145 { "kill-sink-input", pa_cli_command_kill_sink_input
, "Kill a sink input (args: index)", 2},
146 { "kill-source-output", pa_cli_command_kill_source_output
, "Kill a source output (args: index)", 2},
147 { "list-samples", pa_cli_command_scache_list
, "List all entries in the sample cache", 1},
148 { "play-sample", pa_cli_command_scache_play
, "Play a sample from the sample cache (args: name, sink|index)", 3},
149 { "remove-sample", pa_cli_command_scache_remove
, "Remove a sample from the sample cache (args: name)", 2},
150 { "load-sample", pa_cli_command_scache_load
, "Load a sound file into the sample cache (args: name, filename)", 3},
151 { "load-sample-lazy", pa_cli_command_scache_load
, "Lazily load a sound file into the sample cache (args: name, filename)", 3},
152 { "load-sample-dir-lazy", pa_cli_command_scache_load_dir
, "Lazily load all files in a directory into the sample cache (args: pathname)", 2},
153 { "play-file", pa_cli_command_play_file
, "Play a sound file (args: filename, sink|index)", 3},
154 { "list-autoload", pa_cli_command_autoload_list
, "List autoload entries", 1},
155 { "add-autoload-sink", pa_cli_command_autoload_add
, "Add autoload entry for a sink (args: sink, module name, arguments)", 4},
156 { "add-autoload-source", pa_cli_command_autoload_add
, "Add autoload entry for a source (args: source, module name, arguments)", 4},
157 { "remove-autoload-sink", pa_cli_command_autoload_remove
, "Remove autoload entry for a sink (args: name)", 2},
158 { "remove-autoload-source", pa_cli_command_autoload_remove
, "Remove autoload entry for a source (args: name)", 2},
159 { "dump", pa_cli_command_dump
, "Dump daemon configuration", 1},
160 { "list-props", pa_cli_command_list_props
, NULL
, 1},
161 { "move-sink-input", pa_cli_command_move_sink_input
, "Move sink input to another sink (args: index, sink)", 3},
162 { "move-source-output", pa_cli_command_move_source_output
, "Move source output to another source (args: index, source)", 3},
163 { "vacuum", pa_cli_command_vacuum
, NULL
, 1},
164 { NULL
, NULL
, NULL
, 0 }
167 static const char whitespace
[] = " \t\n\r";
168 static const char linebreak
[] = "\n\r";
170 static uint32_t parse_index(const char *n
) {
173 if (pa_atou(n
, &idx
) < 0)
174 return (uint32_t) PA_IDXSET_INVALID
;
179 static int pa_cli_command_exit(pa_core
*c
, pa_tokenizer
*t
, PA_GCC_UNUSED pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
180 assert(c
&& c
->mainloop
&& t
);
181 c
->mainloop
->quit(c
->mainloop
, 0);
185 static int pa_cli_command_help(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
186 const struct command
*command
;
187 assert(c
&& t
&& buf
);
189 pa_strbuf_puts(buf
, "Available commands:\n");
191 for (command
= commands
; command
->name
; command
++)
193 pa_strbuf_printf(buf
, " %-25s %s\n", command
->name
, command
->help
);
197 static int pa_cli_command_modules(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
200 s
= pa_module_list_to_string(c
);
202 pa_strbuf_puts(buf
, s
);
207 static int pa_cli_command_clients(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
210 s
= pa_client_list_to_string(c
);
212 pa_strbuf_puts(buf
, s
);
217 static int pa_cli_command_sinks(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
220 s
= pa_sink_list_to_string(c
);
222 pa_strbuf_puts(buf
, s
);
227 static int pa_cli_command_sources(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
230 s
= pa_source_list_to_string(c
);
232 pa_strbuf_puts(buf
, s
);
237 static int pa_cli_command_sink_inputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
240 s
= pa_sink_input_list_to_string(c
);
242 pa_strbuf_puts(buf
, s
);
247 static int pa_cli_command_source_outputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
250 s
= pa_source_output_list_to_string(c
);
252 pa_strbuf_puts(buf
, s
);
257 static int pa_cli_command_stat(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
259 const pa_mempool_stat
*stat
;
261 const char *def_sink
, *def_source
;
263 static const char* const type_table
[PA_MEMBLOCK_TYPE_MAX
] = {
264 [PA_MEMBLOCK_POOL
] = "POOL",
265 [PA_MEMBLOCK_POOL_EXTERNAL
] = "POOL_EXTERNAL",
266 [PA_MEMBLOCK_APPENDED
] = "APPENDED",
267 [PA_MEMBLOCK_USER
] = "USER",
268 [PA_MEMBLOCK_FIXED
] = "FIXED",
269 [PA_MEMBLOCK_IMPORTED
] = "IMPORTED",
275 stat
= pa_mempool_get_stat(c
->mempool
);
277 pa_strbuf_printf(buf
, "Memory blocks currently allocated: %u, size: %s.\n",
278 (unsigned) pa_atomic_load(&stat
->n_allocated
),
279 pa_bytes_snprint(s
, sizeof(s
), (size_t) pa_atomic_load(&stat
->allocated_size
)));
281 pa_strbuf_printf(buf
, "Memory blocks allocated during the whole lifetime: %u, size: %s.\n",
282 (unsigned) pa_atomic_load(&stat
->n_accumulated
),
283 pa_bytes_snprint(s
, sizeof(s
), (size_t) pa_atomic_load(&stat
->accumulated_size
)));
285 pa_strbuf_printf(buf
, "Memory blocks imported from other processes: %u, size: %s.\n",
286 (unsigned) pa_atomic_load(&stat
->n_imported
),
287 pa_bytes_snprint(s
, sizeof(s
), (size_t) pa_atomic_load(&stat
->imported_size
)));
289 pa_strbuf_printf(buf
, "Memory blocks exported to other processes: %u, size: %s.\n",
290 (unsigned) pa_atomic_load(&stat
->n_exported
),
291 pa_bytes_snprint(s
, sizeof(s
), (size_t) pa_atomic_load(&stat
->exported_size
)));
293 pa_strbuf_printf(buf
, "Total sample cache size: %s.\n",
294 pa_bytes_snprint(s
, sizeof(s
), pa_scache_total_size(c
)));
296 pa_strbuf_printf(buf
, "Default sample spec: %s\n",
297 pa_sample_spec_snprint(s
, sizeof(s
), &c
->default_sample_spec
));
299 def_sink
= pa_namereg_get_default_sink_name(c
);
300 def_source
= pa_namereg_get_default_source_name(c
);
301 pa_strbuf_printf(buf
, "Default sink name: %s\n"
302 "Default source name: %s\n",
303 def_sink
? def_sink
: "none",
304 def_source
? def_source
: "none");
306 for (k
= 0; k
< PA_MEMBLOCK_TYPE_MAX
; k
++)
307 pa_strbuf_printf(buf
,
308 "Memory blocks of type %s: %u allocated/%u accumulated.\n",
310 (unsigned) pa_atomic_load(&stat
->n_allocated_by_type
[k
]),
311 (unsigned) pa_atomic_load(&stat
->n_accumulated_by_type
[k
]));
316 static int pa_cli_command_info(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
318 pa_cli_command_stat(c
, t
, buf
, fail
);
319 pa_cli_command_modules(c
, t
, buf
, fail
);
320 pa_cli_command_sinks(c
, t
, buf
, fail
);
321 pa_cli_command_sources(c
, t
, buf
, fail
);
322 pa_cli_command_clients(c
, t
, buf
, fail
);
323 pa_cli_command_sink_inputs(c
, t
, buf
, fail
);
324 pa_cli_command_source_outputs(c
, t
, buf
, fail
);
325 pa_cli_command_scache_list(c
, t
, buf
, fail
);
326 pa_cli_command_autoload_list(c
, t
, buf
, fail
);
330 static int pa_cli_command_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
335 if (!(name
= pa_tokenizer_get(t
, 1))) {
336 pa_strbuf_puts(buf
, "You need to specify the module name and optionally arguments.\n");
340 if (!(m
= pa_module_load(c
, name
, pa_tokenizer_get(t
, 2)))) {
341 pa_strbuf_puts(buf
, "Module load failed.\n");
348 static int pa_cli_command_unload(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
355 if (!(i
= pa_tokenizer_get(t
, 1))) {
356 pa_strbuf_puts(buf
, "You need to specify the module index.\n");
360 idx
= (uint32_t) strtoul(i
, &e
, 10);
361 if (*e
|| !(m
= pa_idxset_get_by_index(c
->modules
, idx
))) {
362 pa_strbuf_puts(buf
, "Invalid module index.\n");
366 pa_module_unload_request(m
);
370 static int pa_cli_command_sink_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
376 if (!(n
= pa_tokenizer_get(t
, 1))) {
377 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
381 if (!(v
= pa_tokenizer_get(t
, 2))) {
382 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
386 if (pa_atou(v
, &volume
) < 0) {
387 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
391 if (!(sink
= pa_namereg_get(c
, n
, PA_NAMEREG_SINK
, 1))) {
392 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
396 pa_cvolume_set(&cvolume
, sink
->sample_spec
.channels
, volume
);
397 pa_sink_set_volume(sink
, &cvolume
);
401 static int pa_cli_command_sink_input_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
408 if (!(n
= pa_tokenizer_get(t
, 1))) {
409 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
413 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
414 pa_strbuf_puts(buf
, "Failed to parse index.\n");
418 if (!(v
= pa_tokenizer_get(t
, 2))) {
419 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
423 if (pa_atou(v
, &volume
) < 0) {
424 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
428 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
429 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
433 pa_cvolume_set(&cvolume
, si
->sample_spec
.channels
, volume
);
434 pa_sink_input_set_volume(si
, &cvolume
);
438 static int pa_cli_command_source_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
444 if (!(n
= pa_tokenizer_get(t
, 1))) {
445 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
449 if (!(v
= pa_tokenizer_get(t
, 2))) {
450 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
454 if (pa_atou(v
, &volume
) < 0) {
455 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
459 if (!(source
= pa_namereg_get(c
, n
, PA_NAMEREG_SOURCE
, 1))) {
460 pa_strbuf_puts(buf
, "No source found by this name or index.\n");
464 pa_cvolume_set(&cvolume
, source
->sample_spec
.channels
, volume
);
465 pa_source_set_volume(source
, &cvolume
);
469 static int pa_cli_command_sink_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
474 if (!(n
= pa_tokenizer_get(t
, 1))) {
475 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
479 if (!(m
= pa_tokenizer_get(t
, 2))) {
480 pa_strbuf_puts(buf
, "You need to specify a mute switch setting (0/1).\n");
484 if (pa_atoi(m
, &mute
) < 0) {
485 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
489 if (!(sink
= pa_namereg_get(c
, n
, PA_NAMEREG_SINK
, 1))) {
490 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
494 pa_sink_set_mute(sink
, mute
);
498 static int pa_cli_command_source_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
503 if (!(n
= pa_tokenizer_get(t
, 1))) {
504 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
508 if (!(m
= pa_tokenizer_get(t
, 2))) {
509 pa_strbuf_puts(buf
, "You need to specify a mute switch setting (0/1).\n");
513 if (pa_atoi(m
, &mute
) < 0) {
514 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
518 if (!(source
= pa_namereg_get(c
, n
, PA_NAMEREG_SOURCE
, 1))) {
519 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
523 pa_source_set_mute(source
, mute
);
527 static int pa_cli_command_sink_input_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
533 if (!(n
= pa_tokenizer_get(t
, 1))) {
534 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
538 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
539 pa_strbuf_puts(buf
, "Failed to parse index.\n");
543 if (!(v
= pa_tokenizer_get(t
, 2))) {
544 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
548 if (pa_atoi(v
, &mute
) < 0) {
549 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
553 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
554 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
558 pa_sink_input_set_mute(si
, mute
);
562 static int pa_cli_command_sink_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
566 if (!(n
= pa_tokenizer_get(t
, 1))) {
567 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
571 pa_namereg_set_default(c
, n
, PA_NAMEREG_SINK
);
575 static int pa_cli_command_source_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
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 pa_namereg_set_default(c
, n
, PA_NAMEREG_SOURCE
);
588 static int pa_cli_command_kill_client(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
594 if (!(n
= pa_tokenizer_get(t
, 1))) {
595 pa_strbuf_puts(buf
, "You need to specify a client by its index.\n");
599 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
600 pa_strbuf_puts(buf
, "Failed to parse index.\n");
604 if (!(client
= pa_idxset_get_by_index(c
->clients
, idx
))) {
605 pa_strbuf_puts(buf
, "No client found by this index.\n");
609 pa_client_kill(client
);
613 static int pa_cli_command_kill_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
615 pa_sink_input
*sink_input
;
619 if (!(n
= pa_tokenizer_get(t
, 1))) {
620 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
624 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
625 pa_strbuf_puts(buf
, "Failed to parse index.\n");
629 if (!(sink_input
= pa_idxset_get_by_index(c
->sink_inputs
, idx
))) {
630 pa_strbuf_puts(buf
, "No sink input found by this index.\n");
634 pa_sink_input_kill(sink_input
);
638 static int pa_cli_command_kill_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
640 pa_source_output
*source_output
;
644 if (!(n
= pa_tokenizer_get(t
, 1))) {
645 pa_strbuf_puts(buf
, "You need to specify a source output by its index.\n");
649 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
650 pa_strbuf_puts(buf
, "Failed to parse index.\n");
654 if (!(source_output
= pa_idxset_get_by_index(c
->source_outputs
, idx
))) {
655 pa_strbuf_puts(buf
, "No source output found by this index.\n");
659 pa_source_output_kill(source_output
);
663 static int pa_cli_command_scache_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
666 s
= pa_scache_list_to_string(c
);
668 pa_strbuf_puts(buf
, s
);
673 static int pa_cli_command_scache_play(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
674 const char *n
, *sink_name
;
676 assert(c
&& t
&& buf
&& fail
);
678 if (!(n
= pa_tokenizer_get(t
, 1)) || !(sink_name
= pa_tokenizer_get(t
, 2))) {
679 pa_strbuf_puts(buf
, "You need to specify a sample name and a sink name.\n");
683 if (!(sink
= pa_namereg_get(c
, sink_name
, PA_NAMEREG_SINK
, 1))) {
684 pa_strbuf_puts(buf
, "No sink by that name.\n");
688 if (pa_scache_play_item(c
, n
, sink
, PA_VOLUME_NORM
) < 0) {
689 pa_strbuf_puts(buf
, "Failed to play sample.\n");
696 static int pa_cli_command_scache_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
698 assert(c
&& t
&& buf
&& fail
);
700 if (!(n
= pa_tokenizer_get(t
, 1))) {
701 pa_strbuf_puts(buf
, "You need to specify a sample name.\n");
705 if (pa_scache_remove_item(c
, n
) < 0) {
706 pa_strbuf_puts(buf
, "Failed to remove sample.\n");
713 static int pa_cli_command_scache_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
714 const char *fname
, *n
;
716 assert(c
&& t
&& buf
&& fail
);
718 if (!(fname
= pa_tokenizer_get(t
, 2)) || !(n
= pa_tokenizer_get(t
, 1))) {
719 pa_strbuf_puts(buf
, "You need to specify a file name and a sample name.\n");
723 if (strstr(pa_tokenizer_get(t
, 0), "lazy"))
724 r
= pa_scache_add_file_lazy(c
, n
, fname
, NULL
);
726 r
= pa_scache_add_file(c
, n
, fname
, NULL
);
729 pa_strbuf_puts(buf
, "Failed to load sound file.\n");
734 static int pa_cli_command_scache_load_dir(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
736 assert(c
&& t
&& buf
&& fail
);
738 if (!(pname
= pa_tokenizer_get(t
, 1))) {
739 pa_strbuf_puts(buf
, "You need to specify a path name.\n");
743 if (pa_scache_add_directory_lazy(c
, pname
) < 0) {
744 pa_strbuf_puts(buf
, "Failed to load directory.\n");
751 static int pa_cli_command_play_file(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
752 const char *fname
, *sink_name
;
754 assert(c
&& t
&& buf
&& fail
);
756 if (!(fname
= pa_tokenizer_get(t
, 1)) || !(sink_name
= pa_tokenizer_get(t
, 2))) {
757 pa_strbuf_puts(buf
, "You need to specify a file name and a sink name.\n");
761 if (!(sink
= pa_namereg_get(c
, sink_name
, PA_NAMEREG_SINK
, 1))) {
762 pa_strbuf_puts(buf
, "No sink by that name.\n");
767 return pa_play_file(sink
, fname
, NULL
);
770 static int pa_cli_command_autoload_add(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
772 assert(c
&& t
&& buf
&& fail
);
774 if (!(a
= pa_tokenizer_get(t
, 1)) || !(b
= pa_tokenizer_get(t
, 2))) {
775 pa_strbuf_puts(buf
, "You need to specify a device name, a filename or a module name and optionally module arguments\n");
779 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
);
784 static int pa_cli_command_autoload_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
786 assert(c
&& t
&& buf
&& fail
);
788 if (!(name
= pa_tokenizer_get(t
, 1))) {
789 pa_strbuf_puts(buf
, "You need to specify a device name\n");
793 if (pa_autoload_remove_by_name(c
, name
, strstr(pa_tokenizer_get(t
, 0), "sink") ? PA_NAMEREG_SINK
: PA_NAMEREG_SOURCE
) < 0) {
794 pa_strbuf_puts(buf
, "Failed to remove autload entry\n");
801 static int pa_cli_command_autoload_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
804 s
= pa_autoload_list_to_string(c
);
806 pa_strbuf_puts(buf
, s
);
811 static int pa_cli_command_list_props(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
813 pa_property_dump(c
, buf
);
817 static int pa_cli_command_vacuum(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
821 pa_mempool_vacuum(c
->mempool
);
826 static int pa_cli_command_move_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
832 if (!(n
= pa_tokenizer_get(t
, 1))) {
833 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
837 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
838 pa_strbuf_puts(buf
, "Failed to parse index.\n");
842 if (!(k
= pa_tokenizer_get(t
, 2))) {
843 pa_strbuf_puts(buf
, "You need to specify a sink.\n");
847 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
848 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
852 if (!(sink
= pa_namereg_get(c
, k
, PA_NAMEREG_SINK
, 1))) {
853 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
857 if (pa_sink_input_move_to(si
, sink
, 0) < 0) {
858 pa_strbuf_puts(buf
, "Moved failed.\n");
864 static int pa_cli_command_move_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
866 pa_source_output
*so
;
870 if (!(n
= pa_tokenizer_get(t
, 1))) {
871 pa_strbuf_puts(buf
, "You need to specify a source output by its index.\n");
875 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
876 pa_strbuf_puts(buf
, "Failed to parse index.\n");
880 if (!(k
= pa_tokenizer_get(t
, 2))) {
881 pa_strbuf_puts(buf
, "You need to specify a source.\n");
885 if (!(so
= pa_idxset_get_by_index(c
->source_outputs
, (uint32_t) idx
))) {
886 pa_strbuf_puts(buf
, "No source output found with this index.\n");
890 if (!(source
= pa_namereg_get(c
, k
, PA_NAMEREG_SOURCE
, 1))) {
891 pa_strbuf_puts(buf
, "No source found by this name or index.\n");
895 if (pa_source_output_move_to(so
, source
) < 0) {
896 pa_strbuf_puts(buf
, "Moved failed.\n");
902 static int pa_cli_command_dump(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
912 pa_autoload_entry
*a
;
919 pa_strbuf_printf(buf
, "### Configuration dump generated at %s\n", ctime_r(&now
, txt
));
921 pa_strbuf_printf(buf
, "### Configuration dump generated at %s\n", ctime(&now
));
925 for (m
= pa_idxset_first(c
->modules
, &idx
); m
; m
= pa_idxset_next(c
->modules
, &idx
)) {
929 pa_strbuf_printf(buf
, "load-module %s", m
->name
);
932 pa_strbuf_printf(buf
, " %s", m
->argument
);
934 pa_strbuf_puts(buf
, "\n");
939 for (sink
= pa_idxset_first(c
->sinks
, &idx
); sink
; sink
= pa_idxset_next(c
->sinks
, &idx
)) {
940 if (sink
->module
&& sink
->module
->auto_unload
)
944 pa_strbuf_puts(buf
, "\n");
948 pa_strbuf_printf(buf
, "set-sink-volume %s 0x%03x\n", sink
->name
, pa_cvolume_avg(pa_sink_get_volume(sink
)));
949 pa_strbuf_printf(buf
, "set-sink-mute %s %d\n", sink
->name
, pa_sink_get_mute(sink
));
952 for (source
= pa_idxset_first(c
->sources
, &idx
); source
; source
= pa_idxset_next(c
->sources
, &idx
)) {
953 if (source
->module
&& source
->module
->auto_unload
)
957 pa_strbuf_puts(buf
, "\n");
961 pa_strbuf_printf(buf
, "set-source-volume %s 0x%03x\n", source
->name
, pa_cvolume_avg(pa_source_get_volume(source
)));
962 pa_strbuf_printf(buf
, "set-source-mute %s %d\n", source
->name
, pa_source_get_mute(source
));
966 if (c
->autoload_hashmap
) {
970 while ((a
= pa_hashmap_iterate(c
->autoload_hashmap
, &i
, NULL
))) {
973 pa_strbuf_puts(buf
, "\n");
977 pa_strbuf_printf(buf
, "add-autoload-%s %s %s", a
->type
== PA_NAMEREG_SINK
? "sink" : "source", a
->name
, a
->module
);
980 pa_strbuf_printf(buf
, " %s", a
->argument
);
982 pa_strbuf_puts(buf
, "\n");
988 if ((p
= pa_namereg_get_default_sink_name(c
))) {
990 pa_strbuf_puts(buf
, "\n");
993 pa_strbuf_printf(buf
, "set-default-sink %s\n", p
);
996 if ((p
= pa_namereg_get_default_source_name(c
))) {
998 pa_strbuf_puts(buf
, "\n");
1001 pa_strbuf_printf(buf
, "set-default-source %s\n", p
);
1004 pa_strbuf_puts(buf
, "\n### EOF\n");
1009 int pa_cli_command_execute_line_stateful(pa_core
*c
, const char *s
, pa_strbuf
*buf
, int *fail
, int *ifstate
) {
1012 cs
= s
+strspn(s
, whitespace
);
1014 if (*cs
== '#' || !*cs
)
1016 else if (*cs
== '.') {
1017 if (!strcmp(cs
, META_ELSE
)) {
1018 if (!ifstate
|| *ifstate
== IFSTATE_NONE
) {
1019 pa_strbuf_printf(buf
, "Meta command %s is not valid in this context\n", cs
);
1021 } else if (*ifstate
== IFSTATE_TRUE
)
1022 *ifstate
= IFSTATE_FALSE
;
1024 *ifstate
= IFSTATE_TRUE
;
1026 } else if (!strcmp(cs
, META_ENDIF
)) {
1027 if (!ifstate
|| *ifstate
== IFSTATE_NONE
) {
1028 pa_strbuf_printf(buf
, "Meta command %s is not valid in this context\n", cs
);
1031 *ifstate
= IFSTATE_NONE
;
1034 if (ifstate
&& *ifstate
== IFSTATE_FALSE
)
1036 if (!strcmp(cs
, META_FAIL
))
1038 else if (!strcmp(cs
, META_NOFAIL
))
1042 l
= strcspn(cs
, whitespace
);
1044 if (l
== sizeof(META_INCLUDE
)-1 && !strncmp(cs
, META_INCLUDE
, l
)) {
1045 const char *filename
= cs
+l
+strspn(cs
+l
, whitespace
);
1047 if (pa_cli_command_execute_file(c
, filename
, buf
, fail
) < 0)
1048 if (*fail
) return -1;
1049 } else if (l
== sizeof(META_IFEXISTS
)-1 && !strncmp(cs
, META_IFEXISTS
, l
)) {
1051 pa_strbuf_printf(buf
, "Meta command %s is not valid in this context\n", cs
);
1053 } else if (*ifstate
!= IFSTATE_NONE
) {
1054 pa_strbuf_printf(buf
, "Nested %s commands not supported\n", cs
);
1057 const char *filename
= cs
+l
+strspn(cs
+l
, whitespace
);
1059 *ifstate
= access(filename
, F_OK
) == 0 ? IFSTATE_TRUE
: IFSTATE_FALSE
;
1062 pa_strbuf_printf(buf
, "Invalid meta command: %s\n", cs
);
1063 if (*fail
) return -1;
1067 const struct command
*command
;
1071 if (ifstate
&& *ifstate
== IFSTATE_FALSE
)
1075 l
= strcspn(cs
, whitespace
);
1077 for (command
= commands
; command
->name
; command
++)
1078 if (strlen(command
->name
) == l
&& !strncmp(cs
, command
->name
, l
)) {
1080 pa_tokenizer
*t
= pa_tokenizer_new(cs
, command
->args
);
1082 ret
= command
->proc(c
, t
, buf
, fail
);
1083 pa_tokenizer_free(t
);
1086 if (ret
< 0 && *fail
)
1093 pa_strbuf_printf(buf
, "Unknown command: %s\n", cs
);
1102 int pa_cli_command_execute_line(pa_core
*c
, const char *s
, pa_strbuf
*buf
, int *fail
) {
1103 return pa_cli_command_execute_line_stateful(c
, s
, buf
, fail
, NULL
);
1106 int pa_cli_command_execute_file(pa_core
*c
, const char *fn
, pa_strbuf
*buf
, int *fail
) {
1109 int ifstate
= IFSTATE_NONE
;
1116 if (!(f
= fopen(fn
, "r"))) {
1117 pa_strbuf_printf(buf
, "open('%s') failed: %s\n", fn
, pa_cstrerror(errno
));
1123 while (fgets(line
, sizeof(line
), f
)) {
1124 char *e
= line
+ strcspn(line
, linebreak
);
1127 if (pa_cli_command_execute_line_stateful(c
, line
, buf
, fail
, &ifstate
) < 0 && *fail
)
1140 int pa_cli_command_execute(pa_core
*c
, const char *s
, pa_strbuf
*buf
, int *fail
) {
1142 int ifstate
= IFSTATE_NONE
;
1150 size_t l
= strcspn(p
, linebreak
);
1151 char *line
= pa_xstrndup(p
, l
);
1153 if (pa_cli_command_execute_line_stateful(c
, line
, buf
, fail
, &ifstate
) < 0 && *fail
) {
1160 p
+= strspn(p
, linebreak
);