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
, int *fail
);
66 #define INCLUDE_META ".include"
67 #define FAIL_META ".fail"
68 #define NOFAIL_META ".nofail"
70 /* Prototypes for all available commands */
71 static int pa_cli_command_exit(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
72 static int pa_cli_command_help(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
73 static int pa_cli_command_modules(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
74 static int pa_cli_command_clients(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
75 static int pa_cli_command_sinks(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
76 static int pa_cli_command_sources(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
77 static int pa_cli_command_sink_inputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
78 static int pa_cli_command_source_outputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
79 static int pa_cli_command_stat(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
80 static int pa_cli_command_info(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
81 static int pa_cli_command_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
82 static int pa_cli_command_unload(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
83 static int pa_cli_command_sink_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
84 static int pa_cli_command_sink_input_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
85 static int pa_cli_command_source_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
86 static int pa_cli_command_sink_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
87 static int pa_cli_command_source_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
88 static int pa_cli_command_sink_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
89 static int pa_cli_command_source_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
90 static int pa_cli_command_kill_client(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
91 static int pa_cli_command_kill_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
92 static int pa_cli_command_kill_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
93 static int pa_cli_command_scache_play(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
94 static int pa_cli_command_scache_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
95 static int pa_cli_command_scache_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
96 static int pa_cli_command_scache_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
97 static int pa_cli_command_scache_load_dir(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
98 static int pa_cli_command_play_file(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
99 static int pa_cli_command_autoload_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
100 static int pa_cli_command_autoload_add(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
101 static int pa_cli_command_autoload_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
102 static int pa_cli_command_dump(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
103 static int pa_cli_command_list_props(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
104 static int pa_cli_command_move_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
105 static int pa_cli_command_move_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
106 static int pa_cli_command_vacuum(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
108 /* A method table for all available commands */
110 static const struct command commands
[] = {
111 { "exit", pa_cli_command_exit
, "Terminate the daemon", 1 },
112 { "help", pa_cli_command_help
, "Show this help", 1 },
113 { "list-modules", pa_cli_command_modules
, "List loaded modules", 1 },
114 { "list-sinks", pa_cli_command_sinks
, "List loaded sinks", 1 },
115 { "list-sources", pa_cli_command_sources
, "List loaded sources", 1 },
116 { "list-clients", pa_cli_command_clients
, "List loaded clients", 1 },
117 { "list-sink-inputs", pa_cli_command_sink_inputs
, "List sink inputs", 1 },
118 { "list-source-outputs", pa_cli_command_source_outputs
, "List source outputs", 1 },
119 { "stat", pa_cli_command_stat
, "Show memory block statistics", 1 },
120 { "info", pa_cli_command_info
, "Show comprehensive status", 1 },
121 { "ls", pa_cli_command_info
, NULL
, 1 },
122 { "list", pa_cli_command_info
, NULL
, 1 },
123 { "load-module", pa_cli_command_load
, "Load a module (args: name, arguments)", 3},
124 { "unload-module", pa_cli_command_unload
, "Unload a module (args: index)", 2},
125 { "set-sink-volume", pa_cli_command_sink_volume
, "Set the volume of a sink (args: index|name, volume)", 3},
126 { "set-sink-input-volume", pa_cli_command_sink_input_volume
, "Set the volume of a sink input (args: index|name, volume)", 3},
127 { "set-source-volume", pa_cli_command_source_volume
, "Set the volume of a source (args: index|name, volume)", 3},
128 { "set-sink-mute", pa_cli_command_sink_mute
, "Set the mute switch of a sink (args: index|name, mute)", 3},
129 { "set-source-mute", pa_cli_command_source_mute
, "Set the mute switch of a source (args: index|name, mute)", 3},
130 { "set-default-sink", pa_cli_command_sink_default
, "Set the default sink (args: index|name)", 2},
131 { "set-default-source", pa_cli_command_source_default
, "Set the default source (args: index|name)", 2},
132 { "kill-client", pa_cli_command_kill_client
, "Kill a client (args: index)", 2},
133 { "kill-sink-input", pa_cli_command_kill_sink_input
, "Kill a sink input (args: index)", 2},
134 { "kill-source-output", pa_cli_command_kill_source_output
, "Kill a source output (args: index)", 2},
135 { "list-samples", pa_cli_command_scache_list
, "List all entries in the sample cache", 1},
136 { "play-sample", pa_cli_command_scache_play
, "Play a sample from the sample cache (args: name, sink|index)", 3},
137 { "remove-sample", pa_cli_command_scache_remove
, "Remove a sample from the sample cache (args: name)", 2},
138 { "load-sample", pa_cli_command_scache_load
, "Load a sound file into the sample cache (args: name, filename)", 3},
139 { "load-sample-lazy", pa_cli_command_scache_load
, "Lazily load a sound file into the sample cache (args: name, filename)", 3},
140 { "load-sample-dir-lazy", pa_cli_command_scache_load_dir
, "Lazily load all files in a directory into the sample cache (args: pathname)", 2},
141 { "play-file", pa_cli_command_play_file
, "Play a sound file (args: filename, sink|index)", 3},
142 { "list-autoload", pa_cli_command_autoload_list
, "List autoload entries", 1},
143 { "add-autoload-sink", pa_cli_command_autoload_add
, "Add autoload entry for a sink (args: sink, module name, arguments)", 4},
144 { "add-autoload-source", pa_cli_command_autoload_add
, "Add autoload entry for a source (args: source, module name, arguments)", 4},
145 { "remove-autoload-sink", pa_cli_command_autoload_remove
, "Remove autoload entry for a sink (args: name)", 2},
146 { "remove-autoload-source", pa_cli_command_autoload_remove
, "Remove autoload entry for a source (args: name)", 2},
147 { "dump", pa_cli_command_dump
, "Dump daemon configuration", 1},
148 { "list-props", pa_cli_command_list_props
, NULL
, 1},
149 { "move-sink-input", pa_cli_command_move_sink_input
, "Move sink input to another sink (args: index, sink)", 3},
150 { "move-source-output", pa_cli_command_move_source_output
, "Move source output to another source (args: index, source)", 3},
151 { "vacuum", pa_cli_command_vacuum
, NULL
, 1},
152 { NULL
, NULL
, NULL
, 0 }
155 static const char whitespace
[] = " \t\n\r";
156 static const char linebreak
[] = "\n\r";
158 static uint32_t parse_index(const char *n
) {
161 if (pa_atou(n
, &idx
) < 0)
162 return (uint32_t) PA_IDXSET_INVALID
;
167 static int pa_cli_command_exit(pa_core
*c
, pa_tokenizer
*t
, PA_GCC_UNUSED pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
168 assert(c
&& c
->mainloop
&& t
);
169 c
->mainloop
->quit(c
->mainloop
, 0);
173 static int pa_cli_command_help(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
174 const struct command
*command
;
175 assert(c
&& t
&& buf
);
177 pa_strbuf_puts(buf
, "Available commands:\n");
179 for (command
= commands
; command
->name
; command
++)
181 pa_strbuf_printf(buf
, " %-25s %s\n", command
->name
, command
->help
);
185 static int pa_cli_command_modules(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
188 s
= pa_module_list_to_string(c
);
190 pa_strbuf_puts(buf
, s
);
195 static int pa_cli_command_clients(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
198 s
= pa_client_list_to_string(c
);
200 pa_strbuf_puts(buf
, s
);
205 static int pa_cli_command_sinks(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
208 s
= pa_sink_list_to_string(c
);
210 pa_strbuf_puts(buf
, s
);
215 static int pa_cli_command_sources(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
218 s
= pa_source_list_to_string(c
);
220 pa_strbuf_puts(buf
, s
);
225 static int pa_cli_command_sink_inputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
228 s
= pa_sink_input_list_to_string(c
);
230 pa_strbuf_puts(buf
, s
);
235 static int pa_cli_command_source_outputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
238 s
= pa_source_output_list_to_string(c
);
240 pa_strbuf_puts(buf
, s
);
245 static int pa_cli_command_stat(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
247 const pa_mempool_stat
*stat
;
250 static const char* const type_table
[PA_MEMBLOCK_TYPE_MAX
] = {
251 [PA_MEMBLOCK_POOL
] = "POOL",
252 [PA_MEMBLOCK_POOL_EXTERNAL
] = "POOL_EXTERNAL",
253 [PA_MEMBLOCK_APPENDED
] = "APPENDED",
254 [PA_MEMBLOCK_USER
] = "USER",
255 [PA_MEMBLOCK_FIXED
] = "FIXED",
256 [PA_MEMBLOCK_IMPORTED
] = "IMPORTED",
262 stat
= pa_mempool_get_stat(c
->mempool
);
264 pa_strbuf_printf(buf
, "Memory blocks currently allocated: %u, size: %s.\n",
265 (unsigned) AO_load_acquire_read((AO_t
*) &stat
->n_allocated
),
266 pa_bytes_snprint(s
, sizeof(s
), (size_t) AO_load_acquire_read((AO_t
*) &stat
->allocated_size
)));
268 pa_strbuf_printf(buf
, "Memory blocks allocated during the whole lifetime: %u, size: %s.\n",
269 (unsigned) AO_load_acquire_read((AO_t
*) &stat
->n_accumulated
),
270 pa_bytes_snprint(s
, sizeof(s
), (size_t) AO_load_acquire_read((AO_t
*) &stat
->accumulated_size
)));
272 pa_strbuf_printf(buf
, "Memory blocks imported from other processes: %u, size: %s.\n",
273 (unsigned) AO_load_acquire_read((AO_t
*) &stat
->n_imported
),
274 pa_bytes_snprint(s
, sizeof(s
), (size_t) AO_load_acquire_read((AO_t
*) &stat
->imported_size
)));
276 pa_strbuf_printf(buf
, "Memory blocks exported to other processes: %u, size: %s.\n",
277 (unsigned) AO_load_acquire_read((AO_t
*) &stat
->n_exported
),
278 pa_bytes_snprint(s
, sizeof(s
), (size_t) AO_load_acquire_read((AO_t
*) &stat
->exported_size
)));
280 pa_strbuf_printf(buf
, "Total sample cache size: %s.\n",
281 pa_bytes_snprint(s
, sizeof(s
), pa_scache_total_size(c
)));
283 pa_strbuf_printf(buf
, "Default sample spec: %s\n",
284 pa_sample_spec_snprint(s
, sizeof(s
), &c
->default_sample_spec
));
286 pa_strbuf_printf(buf
, "Default sink name: %s\n"
287 "Default source name: %s\n",
288 pa_namereg_get_default_sink_name(c
),
289 pa_namereg_get_default_source_name(c
));
291 for (k
= 0; k
< PA_MEMBLOCK_TYPE_MAX
; k
++)
292 pa_strbuf_printf(buf
,
293 "Memory blocks of type %s: %u allocated/%u accumulated.\n",
295 (unsigned) AO_load_acquire_read(&stat
->n_allocated_by_type
[k
]),
296 (unsigned) AO_load_acquire_read(&stat
->n_accumulated_by_type
[k
]));
301 static int pa_cli_command_info(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
303 pa_cli_command_stat(c
, t
, buf
, fail
);
304 pa_cli_command_modules(c
, t
, buf
, fail
);
305 pa_cli_command_sinks(c
, t
, buf
, fail
);
306 pa_cli_command_sources(c
, t
, buf
, fail
);
307 pa_cli_command_clients(c
, t
, buf
, fail
);
308 pa_cli_command_sink_inputs(c
, t
, buf
, fail
);
309 pa_cli_command_source_outputs(c
, t
, buf
, fail
);
310 pa_cli_command_scache_list(c
, t
, buf
, fail
);
311 pa_cli_command_autoload_list(c
, t
, buf
, fail
);
315 static int pa_cli_command_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
320 if (!(name
= pa_tokenizer_get(t
, 1))) {
321 pa_strbuf_puts(buf
, "You need to specify the module name and optionally arguments.\n");
325 if (!(m
= pa_module_load(c
, name
, pa_tokenizer_get(t
, 2)))) {
326 pa_strbuf_puts(buf
, "Module load failed.\n");
333 static int pa_cli_command_unload(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
340 if (!(i
= pa_tokenizer_get(t
, 1))) {
341 pa_strbuf_puts(buf
, "You need to specify the module index.\n");
345 idx
= (uint32_t) strtoul(i
, &e
, 10);
346 if (*e
|| !(m
= pa_idxset_get_by_index(c
->modules
, idx
))) {
347 pa_strbuf_puts(buf
, "Invalid module index.\n");
351 pa_module_unload_request(m
);
355 static int pa_cli_command_sink_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
361 if (!(n
= pa_tokenizer_get(t
, 1))) {
362 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
366 if (!(v
= pa_tokenizer_get(t
, 2))) {
367 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
371 if (pa_atou(v
, &volume
) < 0) {
372 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
376 if (!(sink
= pa_namereg_get(c
, n
, PA_NAMEREG_SINK
, 1))) {
377 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
381 pa_cvolume_set(&cvolume
, sink
->sample_spec
.channels
, volume
);
382 pa_sink_set_volume(sink
, PA_MIXER_HARDWARE
, &cvolume
);
386 static int pa_cli_command_sink_input_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
393 if (!(n
= pa_tokenizer_get(t
, 1))) {
394 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
398 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
399 pa_strbuf_puts(buf
, "Failed to parse index.\n");
403 if (!(v
= pa_tokenizer_get(t
, 2))) {
404 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
408 if (pa_atou(v
, &volume
) < 0) {
409 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
413 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
414 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
418 pa_cvolume_set(&cvolume
, si
->sample_spec
.channels
, volume
);
419 pa_sink_input_set_volume(si
, &cvolume
);
423 static int pa_cli_command_source_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
429 if (!(n
= pa_tokenizer_get(t
, 1))) {
430 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
434 if (!(v
= pa_tokenizer_get(t
, 2))) {
435 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
439 if (pa_atou(v
, &volume
) < 0) {
440 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
444 if (!(source
= pa_namereg_get(c
, n
, PA_NAMEREG_SOURCE
, 1))) {
445 pa_strbuf_puts(buf
, "No source found by this name or index.\n");
449 pa_cvolume_set(&cvolume
, source
->sample_spec
.channels
, volume
);
450 pa_source_set_volume(source
, PA_MIXER_HARDWARE
, &cvolume
);
454 static int pa_cli_command_sink_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
459 if (!(n
= pa_tokenizer_get(t
, 1))) {
460 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
464 if (!(m
= pa_tokenizer_get(t
, 2))) {
465 pa_strbuf_puts(buf
, "You need to specify a mute switch setting (0/1).\n");
469 if (pa_atoi(m
, &mute
) < 0) {
470 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
474 if (!(sink
= pa_namereg_get(c
, n
, PA_NAMEREG_SINK
, 1))) {
475 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
479 pa_sink_set_mute(sink
, PA_MIXER_HARDWARE
, mute
);
483 static int pa_cli_command_source_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
488 if (!(n
= pa_tokenizer_get(t
, 1))) {
489 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
493 if (!(m
= pa_tokenizer_get(t
, 2))) {
494 pa_strbuf_puts(buf
, "You need to specify a mute switch setting (0/1).\n");
498 if (pa_atoi(m
, &mute
) < 0) {
499 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
503 if (!(source
= pa_namereg_get(c
, n
, PA_NAMEREG_SOURCE
, 1))) {
504 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
508 pa_source_set_mute(source
, PA_MIXER_HARDWARE
, mute
);
512 static int pa_cli_command_sink_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
516 if (!(n
= pa_tokenizer_get(t
, 1))) {
517 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
521 pa_namereg_set_default(c
, n
, PA_NAMEREG_SINK
);
525 static int pa_cli_command_source_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 source either by its name or its index.\n");
534 pa_namereg_set_default(c
, n
, PA_NAMEREG_SOURCE
);
538 static int pa_cli_command_kill_client(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
544 if (!(n
= pa_tokenizer_get(t
, 1))) {
545 pa_strbuf_puts(buf
, "You need to specify a client by its index.\n");
549 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
550 pa_strbuf_puts(buf
, "Failed to parse index.\n");
554 if (!(client
= pa_idxset_get_by_index(c
->clients
, idx
))) {
555 pa_strbuf_puts(buf
, "No client found by this index.\n");
559 pa_client_kill(client
);
563 static int pa_cli_command_kill_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
565 pa_sink_input
*sink_input
;
569 if (!(n
= pa_tokenizer_get(t
, 1))) {
570 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
574 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
575 pa_strbuf_puts(buf
, "Failed to parse index.\n");
579 if (!(sink_input
= pa_idxset_get_by_index(c
->sink_inputs
, idx
))) {
580 pa_strbuf_puts(buf
, "No sink input found by this index.\n");
584 pa_sink_input_kill(sink_input
);
588 static int pa_cli_command_kill_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
590 pa_source_output
*source_output
;
594 if (!(n
= pa_tokenizer_get(t
, 1))) {
595 pa_strbuf_puts(buf
, "You need to specify a source output 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 (!(source_output
= pa_idxset_get_by_index(c
->source_outputs
, idx
))) {
605 pa_strbuf_puts(buf
, "No source output found by this index.\n");
609 pa_source_output_kill(source_output
);
613 static int pa_cli_command_scache_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
616 s
= pa_scache_list_to_string(c
);
618 pa_strbuf_puts(buf
, s
);
623 static int pa_cli_command_scache_play(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
624 const char *n
, *sink_name
;
626 assert(c
&& t
&& buf
&& fail
);
628 if (!(n
= pa_tokenizer_get(t
, 1)) || !(sink_name
= pa_tokenizer_get(t
, 2))) {
629 pa_strbuf_puts(buf
, "You need to specify a sample name and a sink name.\n");
633 if (!(sink
= pa_namereg_get(c
, sink_name
, PA_NAMEREG_SINK
, 1))) {
634 pa_strbuf_puts(buf
, "No sink by that name.\n");
638 if (pa_scache_play_item(c
, n
, sink
, PA_VOLUME_NORM
) < 0) {
639 pa_strbuf_puts(buf
, "Failed to play sample.\n");
646 static int pa_cli_command_scache_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
648 assert(c
&& t
&& buf
&& fail
);
650 if (!(n
= pa_tokenizer_get(t
, 1))) {
651 pa_strbuf_puts(buf
, "You need to specify a sample name.\n");
655 if (pa_scache_remove_item(c
, n
) < 0) {
656 pa_strbuf_puts(buf
, "Failed to remove sample.\n");
663 static int pa_cli_command_scache_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
664 const char *fname
, *n
;
666 assert(c
&& t
&& buf
&& fail
);
668 if (!(fname
= pa_tokenizer_get(t
, 2)) || !(n
= pa_tokenizer_get(t
, 1))) {
669 pa_strbuf_puts(buf
, "You need to specify a file name and a sample name.\n");
673 if (strstr(pa_tokenizer_get(t
, 0), "lazy"))
674 r
= pa_scache_add_file_lazy(c
, n
, fname
, NULL
);
676 r
= pa_scache_add_file(c
, n
, fname
, NULL
);
679 pa_strbuf_puts(buf
, "Failed to load sound file.\n");
684 static int pa_cli_command_scache_load_dir(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
686 assert(c
&& t
&& buf
&& fail
);
688 if (!(pname
= pa_tokenizer_get(t
, 1))) {
689 pa_strbuf_puts(buf
, "You need to specify a path name.\n");
693 if (pa_scache_add_directory_lazy(c
, pname
) < 0) {
694 pa_strbuf_puts(buf
, "Failed to load directory.\n");
701 static int pa_cli_command_play_file(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
702 const char *fname
, *sink_name
;
704 assert(c
&& t
&& buf
&& fail
);
706 if (!(fname
= pa_tokenizer_get(t
, 1)) || !(sink_name
= pa_tokenizer_get(t
, 2))) {
707 pa_strbuf_puts(buf
, "You need to specify a file name and a sink name.\n");
711 if (!(sink
= pa_namereg_get(c
, sink_name
, PA_NAMEREG_SINK
, 1))) {
712 pa_strbuf_puts(buf
, "No sink by that name.\n");
717 return pa_play_file(sink
, fname
, NULL
);
720 static int pa_cli_command_autoload_add(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
722 assert(c
&& t
&& buf
&& fail
);
724 if (!(a
= pa_tokenizer_get(t
, 1)) || !(b
= pa_tokenizer_get(t
, 2))) {
725 pa_strbuf_puts(buf
, "You need to specify a device name, a filename or a module name and optionally module arguments\n");
729 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
);
734 static int pa_cli_command_autoload_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
736 assert(c
&& t
&& buf
&& fail
);
738 if (!(name
= pa_tokenizer_get(t
, 1))) {
739 pa_strbuf_puts(buf
, "You need to specify a device name\n");
743 if (pa_autoload_remove_by_name(c
, name
, strstr(pa_tokenizer_get(t
, 0), "sink") ? PA_NAMEREG_SINK
: PA_NAMEREG_SOURCE
) < 0) {
744 pa_strbuf_puts(buf
, "Failed to remove autload entry\n");
751 static int pa_cli_command_autoload_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
754 s
= pa_autoload_list_to_string(c
);
756 pa_strbuf_puts(buf
, s
);
761 static int pa_cli_command_list_props(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
763 pa_property_dump(c
, buf
);
767 static int pa_cli_command_vacuum(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
771 pa_mempool_vacuum(c
->mempool
);
776 static int pa_cli_command_move_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
782 if (!(n
= pa_tokenizer_get(t
, 1))) {
783 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
787 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
788 pa_strbuf_puts(buf
, "Failed to parse index.\n");
792 if (!(k
= pa_tokenizer_get(t
, 2))) {
793 pa_strbuf_puts(buf
, "You need to specify a sink.\n");
797 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
798 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
802 if (!(sink
= pa_namereg_get(c
, k
, PA_NAMEREG_SINK
, 1))) {
803 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
807 if (pa_sink_input_move_to(si
, sink
, 0) < 0) {
808 pa_strbuf_puts(buf
, "Moved failed.\n");
814 static int pa_cli_command_move_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
816 pa_source_output
*so
;
820 if (!(n
= pa_tokenizer_get(t
, 1))) {
821 pa_strbuf_puts(buf
, "You need to specify a source output by its index.\n");
825 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
826 pa_strbuf_puts(buf
, "Failed to parse index.\n");
830 if (!(k
= pa_tokenizer_get(t
, 2))) {
831 pa_strbuf_puts(buf
, "You need to specify a source.\n");
835 if (!(so
= pa_idxset_get_by_index(c
->source_outputs
, (uint32_t) idx
))) {
836 pa_strbuf_puts(buf
, "No source output found with this index.\n");
840 if (!(source
= pa_namereg_get(c
, k
, PA_NAMEREG_SOURCE
, 1))) {
841 pa_strbuf_puts(buf
, "No source found by this name or index.\n");
845 if (pa_source_output_move_to(so
, source
) < 0) {
846 pa_strbuf_puts(buf
, "Moved failed.\n");
852 static int pa_cli_command_dump(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
862 pa_autoload_entry
*a
;
869 pa_strbuf_printf(buf
, "### Configuration dump generated at %s\n", ctime_r(&now
, txt
));
871 pa_strbuf_printf(buf
, "### Configuration dump generated at %s\n", ctime(&now
));
875 for (m
= pa_idxset_first(c
->modules
, &idx
); m
; m
= pa_idxset_next(c
->modules
, &idx
)) {
879 pa_strbuf_printf(buf
, "load-module %s", m
->name
);
882 pa_strbuf_printf(buf
, " %s", m
->argument
);
884 pa_strbuf_puts(buf
, "\n");
889 for (sink
= pa_idxset_first(c
->sinks
, &idx
); sink
; sink
= pa_idxset_next(c
->sinks
, &idx
)) {
890 if (sink
->owner
&& sink
->owner
->auto_unload
)
894 pa_strbuf_puts(buf
, "\n");
898 pa_strbuf_printf(buf
, "set-sink-volume %s 0x%03x\n", sink
->name
, pa_cvolume_avg(pa_sink_get_volume(sink
, PA_MIXER_HARDWARE
)));
899 pa_strbuf_printf(buf
, "set-sink-mute %s %d\n", sink
->name
, pa_sink_get_mute(sink
, PA_MIXER_HARDWARE
));
902 for (source
= pa_idxset_first(c
->sources
, &idx
); source
; source
= pa_idxset_next(c
->sources
, &idx
)) {
903 if (source
->owner
&& source
->owner
->auto_unload
)
907 pa_strbuf_puts(buf
, "\n");
911 pa_strbuf_printf(buf
, "set-source-volume %s 0x%03x\n", source
->name
, pa_cvolume_avg(pa_source_get_volume(source
, PA_MIXER_HARDWARE
)));
912 pa_strbuf_printf(buf
, "set-source-mute %s %d\n", source
->name
, pa_source_get_mute(source
, PA_MIXER_HARDWARE
));
916 if (c
->autoload_hashmap
) {
920 while ((a
= pa_hashmap_iterate(c
->autoload_hashmap
, &i
, NULL
))) {
923 pa_strbuf_puts(buf
, "\n");
927 pa_strbuf_printf(buf
, "add-autoload-%s %s %s", a
->type
== PA_NAMEREG_SINK
? "sink" : "source", a
->name
, a
->module
);
930 pa_strbuf_printf(buf
, " %s", a
->argument
);
932 pa_strbuf_puts(buf
, "\n");
938 if ((p
= pa_namereg_get_default_sink_name(c
))) {
940 pa_strbuf_puts(buf
, "\n");
943 pa_strbuf_printf(buf
, "set-default-sink %s\n", p
);
946 if ((p
= pa_namereg_get_default_source_name(c
))) {
948 pa_strbuf_puts(buf
, "\n");
951 pa_strbuf_printf(buf
, "set-default-source %s\n", p
);
954 pa_strbuf_puts(buf
, "\n### EOF\n");
959 int pa_cli_command_execute_line(pa_core
*c
, const char *s
, pa_strbuf
*buf
, int *fail
) {
962 cs
= s
+strspn(s
, whitespace
);
964 if (*cs
== '#' || !*cs
)
966 else if (*cs
== '.') {
967 if (!strcmp(cs
, FAIL_META
))
969 else if (!strcmp(cs
, NOFAIL_META
))
973 l
= strcspn(cs
, whitespace
);
975 if (l
== sizeof(INCLUDE_META
)-1 && !strncmp(cs
, INCLUDE_META
, l
)) {
976 const char *filename
= cs
+l
+strspn(cs
+l
, whitespace
);
978 if (pa_cli_command_execute_file(c
, filename
, buf
, fail
) < 0)
979 if (*fail
) return -1;
981 pa_strbuf_printf(buf
, "Invalid meta command: %s\n", cs
);
982 if (*fail
) return -1;
986 const struct command
*command
;
990 l
= strcspn(cs
, whitespace
);
992 for (command
= commands
; command
->name
; command
++)
993 if (strlen(command
->name
) == l
&& !strncmp(cs
, command
->name
, l
)) {
995 pa_tokenizer
*t
= pa_tokenizer_new(cs
, command
->args
);
997 ret
= command
->proc(c
, t
, buf
, fail
);
998 pa_tokenizer_free(t
);
1001 if (ret
< 0 && *fail
)
1008 pa_strbuf_printf(buf
, "Unknown command: %s\n", cs
);
1017 int pa_cli_command_execute_file(pa_core
*c
, const char *fn
, pa_strbuf
*buf
, int *fail
) {
1021 assert(c
&& fn
&& buf
);
1023 if (!(f
= fopen(fn
, "r"))) {
1024 pa_strbuf_printf(buf
, "open('%s') failed: %s\n", fn
, pa_cstrerror(errno
));
1030 while (fgets(line
, sizeof(line
), f
)) {
1031 char *e
= line
+ strcspn(line
, linebreak
);
1034 if (pa_cli_command_execute_line(c
, line
, buf
, fail
) < 0 && *fail
)
1047 int pa_cli_command_execute(pa_core
*c
, const char *s
, pa_strbuf
*buf
, int *fail
) {
1049 assert(c
&& s
&& buf
&& fail
);
1053 size_t l
= strcspn(p
, linebreak
);
1054 char *line
= pa_xstrndup(p
, l
);
1056 if (pa_cli_command_execute_line(c
, line
, buf
, fail
) < 0&& *fail
) {
1063 p
+= strspn(p
, linebreak
);