4 This file is part of PulseAudio.
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2 of the License,
9 or (at your option) any later version.
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
32 #include <pulse/xmalloc.h>
34 #include <pulsecore/module.h>
35 #include <pulsecore/sink.h>
36 #include <pulsecore/source.h>
37 #include <pulsecore/client.h>
38 #include <pulsecore/sink-input.h>
39 #include <pulsecore/source-output.h>
40 #include <pulsecore/tokenizer.h>
41 #include <pulsecore/strbuf.h>
42 #include <pulsecore/namereg.h>
43 #include <pulsecore/cli-text.h>
44 #include <pulsecore/core-scache.h>
45 #include <pulsecore/sample-util.h>
46 #include <pulsecore/sound-file.h>
47 #include <pulsecore/play-memchunk.h>
48 #include <pulsecore/autoload.h>
49 #include <pulsecore/sound-file-stream.h>
50 #include <pulsecore/props.h>
51 #include <pulsecore/core-util.h>
52 #include <pulsecore/core-error.h>
54 #include "cli-command.h"
58 int (*proc
) (pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
63 #define INCLUDE_META ".include"
64 #define FAIL_META ".fail"
65 #define NOFAIL_META ".nofail"
67 /* Prototypes for all available commands */
68 static int pa_cli_command_exit(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
69 static int pa_cli_command_help(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
70 static int pa_cli_command_modules(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
71 static int pa_cli_command_clients(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
72 static int pa_cli_command_sinks(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
73 static int pa_cli_command_sources(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
74 static int pa_cli_command_sink_inputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
75 static int pa_cli_command_source_outputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
76 static int pa_cli_command_stat(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
77 static int pa_cli_command_info(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
78 static int pa_cli_command_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
79 static int pa_cli_command_unload(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
80 static int pa_cli_command_sink_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
81 static int pa_cli_command_sink_input_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
82 static int pa_cli_command_source_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
83 static int pa_cli_command_sink_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
84 static int pa_cli_command_source_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
85 static int pa_cli_command_sink_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
86 static int pa_cli_command_source_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
87 static int pa_cli_command_kill_client(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
88 static int pa_cli_command_kill_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
89 static int pa_cli_command_kill_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
90 static int pa_cli_command_scache_play(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
91 static int pa_cli_command_scache_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
92 static int pa_cli_command_scache_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
93 static int pa_cli_command_scache_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
94 static int pa_cli_command_scache_load_dir(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
95 static int pa_cli_command_play_file(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
96 static int pa_cli_command_autoload_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
97 static int pa_cli_command_autoload_add(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
98 static int pa_cli_command_autoload_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
99 static int pa_cli_command_dump(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
100 static int pa_cli_command_list_props(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
101 static int pa_cli_command_move_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
102 static int pa_cli_command_move_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
103 static int pa_cli_command_vacuum(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
);
105 /* A method table for all available commands */
107 static const struct command commands
[] = {
108 { "exit", pa_cli_command_exit
, "Terminate the daemon", 1 },
109 { "help", pa_cli_command_help
, "Show this help", 1 },
110 { "list-modules", pa_cli_command_modules
, "List loaded modules", 1 },
111 { "list-sinks", pa_cli_command_sinks
, "List loaded sinks", 1 },
112 { "list-sources", pa_cli_command_sources
, "List loaded sources", 1 },
113 { "list-clients", pa_cli_command_clients
, "List loaded clients", 1 },
114 { "list-sink-inputs", pa_cli_command_sink_inputs
, "List sink inputs", 1 },
115 { "list-source-outputs", pa_cli_command_source_outputs
, "List source outputs", 1 },
116 { "stat", pa_cli_command_stat
, "Show memory block statistics", 1 },
117 { "info", pa_cli_command_info
, "Show comprehensive status", 1 },
118 { "ls", pa_cli_command_info
, NULL
, 1 },
119 { "list", pa_cli_command_info
, NULL
, 1 },
120 { "load-module", pa_cli_command_load
, "Load a module (args: name, arguments)", 3},
121 { "unload-module", pa_cli_command_unload
, "Unload a module (args: index)", 2},
122 { "set-sink-volume", pa_cli_command_sink_volume
, "Set the volume of a sink (args: index|name, volume)", 3},
123 { "set-sink-input-volume", pa_cli_command_sink_input_volume
, "Set the volume of a sink input (args: index|name, volume)", 3},
124 { "set-source-volume", pa_cli_command_source_volume
, "Set the volume of a source (args: index|name, volume)", 3},
125 { "set-sink-mute", pa_cli_command_sink_mute
, "Set the mute switch of a sink (args: index|name, mute)", 3},
126 { "set-source-mute", pa_cli_command_source_mute
, "Set the mute switch of a source (args: index|name, mute)", 3},
127 { "set-default-sink", pa_cli_command_sink_default
, "Set the default sink (args: index|name)", 2},
128 { "set-default-source", pa_cli_command_source_default
, "Set the default source (args: index|name)", 2},
129 { "kill-client", pa_cli_command_kill_client
, "Kill a client (args: index)", 2},
130 { "kill-sink-input", pa_cli_command_kill_sink_input
, "Kill a sink input (args: index)", 2},
131 { "kill-source-output", pa_cli_command_kill_source_output
, "Kill a source output (args: index)", 2},
132 { "list-samples", pa_cli_command_scache_list
, "List all entries in the sample cache", 1},
133 { "play-sample", pa_cli_command_scache_play
, "Play a sample from the sample cache (args: name, sink|index)", 3},
134 { "remove-sample", pa_cli_command_scache_remove
, "Remove a sample from the sample cache (args: name)", 2},
135 { "load-sample", pa_cli_command_scache_load
, "Load a sound file into the sample cache (args: name, filename)", 3},
136 { "load-sample-lazy", pa_cli_command_scache_load
, "Lazily load a sound file into the sample cache (args: name, filename)", 3},
137 { "load-sample-dir-lazy", pa_cli_command_scache_load_dir
, "Lazily load all files in a directory into the sample cache (args: pathname)", 2},
138 { "play-file", pa_cli_command_play_file
, "Play a sound file (args: filename, sink|index)", 3},
139 { "list-autoload", pa_cli_command_autoload_list
, "List autoload entries", 1},
140 { "add-autoload-sink", pa_cli_command_autoload_add
, "Add autoload entry for a sink (args: sink, module name, arguments)", 4},
141 { "add-autoload-source", pa_cli_command_autoload_add
, "Add autoload entry for a source (args: source, module name, arguments)", 4},
142 { "remove-autoload-sink", pa_cli_command_autoload_remove
, "Remove autoload entry for a sink (args: name)", 2},
143 { "remove-autoload-source", pa_cli_command_autoload_remove
, "Remove autoload entry for a source (args: name)", 2},
144 { "dump", pa_cli_command_dump
, "Dump daemon configuration", 1},
145 { "list-props", pa_cli_command_list_props
, NULL
, 1},
146 { "move-sink-input", pa_cli_command_move_sink_input
, "Move sink input to another sink (args: index, sink)", 3},
147 { "move-source-output", pa_cli_command_move_source_output
, "Move source output to another source (args: index, source)", 3},
148 { "vacuum", pa_cli_command_vacuum
, NULL
, 1},
149 { NULL
, NULL
, NULL
, 0 }
152 static const char whitespace
[] = " \t\n\r";
153 static const char linebreak
[] = "\n\r";
155 static uint32_t parse_index(const char *n
) {
158 if (pa_atou(n
, &idx
) < 0)
159 return (uint32_t) PA_IDXSET_INVALID
;
164 static int pa_cli_command_exit(pa_core
*c
, pa_tokenizer
*t
, PA_GCC_UNUSED pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
165 assert(c
&& c
->mainloop
&& t
);
166 c
->mainloop
->quit(c
->mainloop
, 0);
170 static int pa_cli_command_help(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
171 const struct command
*command
;
172 assert(c
&& t
&& buf
);
174 pa_strbuf_puts(buf
, "Available commands:\n");
176 for (command
= commands
; command
->name
; command
++)
178 pa_strbuf_printf(buf
, " %-25s %s\n", command
->name
, command
->help
);
182 static int pa_cli_command_modules(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
185 s
= pa_module_list_to_string(c
);
187 pa_strbuf_puts(buf
, s
);
192 static int pa_cli_command_clients(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
195 s
= pa_client_list_to_string(c
);
197 pa_strbuf_puts(buf
, s
);
202 static int pa_cli_command_sinks(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
205 s
= pa_sink_list_to_string(c
);
207 pa_strbuf_puts(buf
, s
);
212 static int pa_cli_command_sources(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
215 s
= pa_source_list_to_string(c
);
217 pa_strbuf_puts(buf
, s
);
222 static int pa_cli_command_sink_inputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
225 s
= pa_sink_input_list_to_string(c
);
227 pa_strbuf_puts(buf
, s
);
232 static int pa_cli_command_source_outputs(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
235 s
= pa_source_output_list_to_string(c
);
237 pa_strbuf_puts(buf
, s
);
242 static int pa_cli_command_stat(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
244 const pa_mempool_stat
*stat
;
247 static const char* const type_table
[PA_MEMBLOCK_TYPE_MAX
] = {
248 [PA_MEMBLOCK_POOL
] = "POOL",
249 [PA_MEMBLOCK_POOL_EXTERNAL
] = "POOL_EXTERNAL",
250 [PA_MEMBLOCK_APPENDED
] = "APPENDED",
251 [PA_MEMBLOCK_USER
] = "USER",
252 [PA_MEMBLOCK_FIXED
] = "FIXED",
253 [PA_MEMBLOCK_IMPORTED
] = "IMPORTED",
259 stat
= pa_mempool_get_stat(c
->mempool
);
261 pa_strbuf_printf(buf
, "Memory blocks currently allocated: %u, size: %s.\n",
262 (unsigned) AO_load_acquire_read((AO_t
*) &stat
->n_allocated
),
263 pa_bytes_snprint(s
, sizeof(s
), (size_t) AO_load_acquire_read((AO_t
*) &stat
->allocated_size
)));
265 pa_strbuf_printf(buf
, "Memory blocks allocated during the whole lifetime: %u, size: %s.\n",
266 (unsigned) AO_load_acquire_read((AO_t
*) &stat
->n_accumulated
),
267 pa_bytes_snprint(s
, sizeof(s
), (size_t) AO_load_acquire_read((AO_t
*) &stat
->accumulated_size
)));
269 pa_strbuf_printf(buf
, "Memory blocks imported from other processes: %u, size: %s.\n",
270 (unsigned) AO_load_acquire_read((AO_t
*) &stat
->n_imported
),
271 pa_bytes_snprint(s
, sizeof(s
), (size_t) AO_load_acquire_read((AO_t
*) &stat
->imported_size
)));
273 pa_strbuf_printf(buf
, "Memory blocks exported to other processes: %u, size: %s.\n",
274 (unsigned) AO_load_acquire_read((AO_t
*) &stat
->n_exported
),
275 pa_bytes_snprint(s
, sizeof(s
), (size_t) AO_load_acquire_read((AO_t
*) &stat
->exported_size
)));
277 pa_strbuf_printf(buf
, "Total sample cache size: %s.\n",
278 pa_bytes_snprint(s
, sizeof(s
), pa_scache_total_size(c
)));
280 pa_strbuf_printf(buf
, "Default sample spec: %s\n",
281 pa_sample_spec_snprint(s
, sizeof(s
), &c
->default_sample_spec
));
283 pa_strbuf_printf(buf
, "Default sink name: %s\n"
284 "Default source name: %s\n",
285 pa_namereg_get_default_sink_name(c
),
286 pa_namereg_get_default_source_name(c
));
288 for (k
= 0; k
< PA_MEMBLOCK_TYPE_MAX
; k
++)
289 pa_strbuf_printf(buf
,
290 "Memory blocks of type %s: %u allocated/%u accumulated.\n",
292 (unsigned) AO_load_acquire_read(&stat
->n_allocated_by_type
[k
]),
293 (unsigned) AO_load_acquire_read(&stat
->n_accumulated_by_type
[k
]));
298 static int pa_cli_command_info(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
300 pa_cli_command_stat(c
, t
, buf
, fail
);
301 pa_cli_command_modules(c
, t
, buf
, fail
);
302 pa_cli_command_sinks(c
, t
, buf
, fail
);
303 pa_cli_command_sources(c
, t
, buf
, fail
);
304 pa_cli_command_clients(c
, t
, buf
, fail
);
305 pa_cli_command_sink_inputs(c
, t
, buf
, fail
);
306 pa_cli_command_source_outputs(c
, t
, buf
, fail
);
307 pa_cli_command_scache_list(c
, t
, buf
, fail
);
308 pa_cli_command_autoload_list(c
, t
, buf
, fail
);
312 static int pa_cli_command_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
317 if (!(name
= pa_tokenizer_get(t
, 1))) {
318 pa_strbuf_puts(buf
, "You need to specify the module name and optionally arguments.\n");
322 if (!(m
= pa_module_load(c
, name
, pa_tokenizer_get(t
, 2)))) {
323 pa_strbuf_puts(buf
, "Module load failed.\n");
330 static int pa_cli_command_unload(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
337 if (!(i
= pa_tokenizer_get(t
, 1))) {
338 pa_strbuf_puts(buf
, "You need to specify the module index.\n");
342 idx
= (uint32_t) strtoul(i
, &e
, 10);
343 if (*e
|| !(m
= pa_idxset_get_by_index(c
->modules
, idx
))) {
344 pa_strbuf_puts(buf
, "Invalid module index.\n");
348 pa_module_unload_request(m
);
352 static int pa_cli_command_sink_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
358 if (!(n
= pa_tokenizer_get(t
, 1))) {
359 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
363 if (!(v
= pa_tokenizer_get(t
, 2))) {
364 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
368 if (pa_atou(v
, &volume
) < 0) {
369 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
373 if (!(sink
= pa_namereg_get(c
, n
, PA_NAMEREG_SINK
, 1))) {
374 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
378 pa_cvolume_set(&cvolume
, sink
->sample_spec
.channels
, volume
);
379 pa_sink_set_volume(sink
, PA_MIXER_HARDWARE
, &cvolume
);
383 static int pa_cli_command_sink_input_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
390 if (!(n
= pa_tokenizer_get(t
, 1))) {
391 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
395 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
396 pa_strbuf_puts(buf
, "Failed to parse index.\n");
400 if (!(v
= pa_tokenizer_get(t
, 2))) {
401 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
405 if (pa_atou(v
, &volume
) < 0) {
406 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
410 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
411 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
415 pa_cvolume_set(&cvolume
, si
->sample_spec
.channels
, volume
);
416 pa_sink_input_set_volume(si
, &cvolume
);
420 static int pa_cli_command_source_volume(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
426 if (!(n
= pa_tokenizer_get(t
, 1))) {
427 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
431 if (!(v
= pa_tokenizer_get(t
, 2))) {
432 pa_strbuf_puts(buf
, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
436 if (pa_atou(v
, &volume
) < 0) {
437 pa_strbuf_puts(buf
, "Failed to parse volume.\n");
441 if (!(source
= pa_namereg_get(c
, n
, PA_NAMEREG_SOURCE
, 1))) {
442 pa_strbuf_puts(buf
, "No source found by this name or index.\n");
446 pa_cvolume_set(&cvolume
, source
->sample_spec
.channels
, volume
);
447 pa_source_set_volume(source
, PA_MIXER_HARDWARE
, &cvolume
);
451 static int pa_cli_command_sink_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
456 if (!(n
= pa_tokenizer_get(t
, 1))) {
457 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
461 if (!(m
= pa_tokenizer_get(t
, 2))) {
462 pa_strbuf_puts(buf
, "You need to specify a mute switch setting (0/1).\n");
466 if (pa_atoi(m
, &mute
) < 0) {
467 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
471 if (!(sink
= pa_namereg_get(c
, n
, PA_NAMEREG_SINK
, 1))) {
472 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
476 pa_sink_set_mute(sink
, PA_MIXER_HARDWARE
, mute
);
480 static int pa_cli_command_source_mute(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
485 if (!(n
= pa_tokenizer_get(t
, 1))) {
486 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
490 if (!(m
= pa_tokenizer_get(t
, 2))) {
491 pa_strbuf_puts(buf
, "You need to specify a mute switch setting (0/1).\n");
495 if (pa_atoi(m
, &mute
) < 0) {
496 pa_strbuf_puts(buf
, "Failed to parse mute switch.\n");
500 if (!(source
= pa_namereg_get(c
, n
, PA_NAMEREG_SOURCE
, 1))) {
501 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
505 pa_source_set_mute(source
, PA_MIXER_HARDWARE
, mute
);
509 static int pa_cli_command_sink_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
513 if (!(n
= pa_tokenizer_get(t
, 1))) {
514 pa_strbuf_puts(buf
, "You need to specify a sink either by its name or its index.\n");
518 pa_namereg_set_default(c
, n
, PA_NAMEREG_SINK
);
522 static int pa_cli_command_source_default(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
526 if (!(n
= pa_tokenizer_get(t
, 1))) {
527 pa_strbuf_puts(buf
, "You need to specify a source either by its name or its index.\n");
531 pa_namereg_set_default(c
, n
, PA_NAMEREG_SOURCE
);
535 static int pa_cli_command_kill_client(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
541 if (!(n
= pa_tokenizer_get(t
, 1))) {
542 pa_strbuf_puts(buf
, "You need to specify a client by its index.\n");
546 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
547 pa_strbuf_puts(buf
, "Failed to parse index.\n");
551 if (!(client
= pa_idxset_get_by_index(c
->clients
, idx
))) {
552 pa_strbuf_puts(buf
, "No client found by this index.\n");
556 pa_client_kill(client
);
560 static int pa_cli_command_kill_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
562 pa_sink_input
*sink_input
;
566 if (!(n
= pa_tokenizer_get(t
, 1))) {
567 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
571 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
572 pa_strbuf_puts(buf
, "Failed to parse index.\n");
576 if (!(sink_input
= pa_idxset_get_by_index(c
->sink_inputs
, idx
))) {
577 pa_strbuf_puts(buf
, "No sink input found by this index.\n");
581 pa_sink_input_kill(sink_input
);
585 static int pa_cli_command_kill_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
587 pa_source_output
*source_output
;
591 if (!(n
= pa_tokenizer_get(t
, 1))) {
592 pa_strbuf_puts(buf
, "You need to specify a source output by its index.\n");
596 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
597 pa_strbuf_puts(buf
, "Failed to parse index.\n");
601 if (!(source_output
= pa_idxset_get_by_index(c
->source_outputs
, idx
))) {
602 pa_strbuf_puts(buf
, "No source output found by this index.\n");
606 pa_source_output_kill(source_output
);
610 static int pa_cli_command_scache_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
613 s
= pa_scache_list_to_string(c
);
615 pa_strbuf_puts(buf
, s
);
620 static int pa_cli_command_scache_play(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
621 const char *n
, *sink_name
;
623 assert(c
&& t
&& buf
&& fail
);
625 if (!(n
= pa_tokenizer_get(t
, 1)) || !(sink_name
= pa_tokenizer_get(t
, 2))) {
626 pa_strbuf_puts(buf
, "You need to specify a sample name and a sink name.\n");
630 if (!(sink
= pa_namereg_get(c
, sink_name
, PA_NAMEREG_SINK
, 1))) {
631 pa_strbuf_puts(buf
, "No sink by that name.\n");
635 if (pa_scache_play_item(c
, n
, sink
, PA_VOLUME_NORM
) < 0) {
636 pa_strbuf_puts(buf
, "Failed to play sample.\n");
643 static int pa_cli_command_scache_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
645 assert(c
&& t
&& buf
&& fail
);
647 if (!(n
= pa_tokenizer_get(t
, 1))) {
648 pa_strbuf_puts(buf
, "You need to specify a sample name.\n");
652 if (pa_scache_remove_item(c
, n
) < 0) {
653 pa_strbuf_puts(buf
, "Failed to remove sample.\n");
660 static int pa_cli_command_scache_load(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
661 const char *fname
, *n
;
663 assert(c
&& t
&& buf
&& fail
);
665 if (!(fname
= pa_tokenizer_get(t
, 2)) || !(n
= pa_tokenizer_get(t
, 1))) {
666 pa_strbuf_puts(buf
, "You need to specify a file name and a sample name.\n");
670 if (strstr(pa_tokenizer_get(t
, 0), "lazy"))
671 r
= pa_scache_add_file_lazy(c
, n
, fname
, NULL
);
673 r
= pa_scache_add_file(c
, n
, fname
, NULL
);
676 pa_strbuf_puts(buf
, "Failed to load sound file.\n");
681 static int pa_cli_command_scache_load_dir(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
683 assert(c
&& t
&& buf
&& fail
);
685 if (!(pname
= pa_tokenizer_get(t
, 1))) {
686 pa_strbuf_puts(buf
, "You need to specify a path name.\n");
690 if (pa_scache_add_directory_lazy(c
, pname
) < 0) {
691 pa_strbuf_puts(buf
, "Failed to load directory.\n");
698 static int pa_cli_command_play_file(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
699 const char *fname
, *sink_name
;
701 assert(c
&& t
&& buf
&& fail
);
703 if (!(fname
= pa_tokenizer_get(t
, 1)) || !(sink_name
= pa_tokenizer_get(t
, 2))) {
704 pa_strbuf_puts(buf
, "You need to specify a file name and a sink name.\n");
708 if (!(sink
= pa_namereg_get(c
, sink_name
, PA_NAMEREG_SINK
, 1))) {
709 pa_strbuf_puts(buf
, "No sink by that name.\n");
714 return pa_play_file(sink
, fname
, NULL
);
717 static int pa_cli_command_autoload_add(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
719 assert(c
&& t
&& buf
&& fail
);
721 if (!(a
= pa_tokenizer_get(t
, 1)) || !(b
= pa_tokenizer_get(t
, 2))) {
722 pa_strbuf_puts(buf
, "You need to specify a device name, a filename or a module name and optionally module arguments\n");
726 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
);
731 static int pa_cli_command_autoload_remove(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
733 assert(c
&& t
&& buf
&& fail
);
735 if (!(name
= pa_tokenizer_get(t
, 1))) {
736 pa_strbuf_puts(buf
, "You need to specify a device name\n");
740 if (pa_autoload_remove_by_name(c
, name
, strstr(pa_tokenizer_get(t
, 0), "sink") ? PA_NAMEREG_SINK
: PA_NAMEREG_SOURCE
) < 0) {
741 pa_strbuf_puts(buf
, "Failed to remove autload entry\n");
748 static int pa_cli_command_autoload_list(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
751 s
= pa_autoload_list_to_string(c
);
753 pa_strbuf_puts(buf
, s
);
758 static int pa_cli_command_list_props(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
760 pa_property_dump(c
, buf
);
764 static int pa_cli_command_vacuum(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
768 pa_mempool_vacuum(c
->mempool
);
773 static int pa_cli_command_move_sink_input(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
779 if (!(n
= pa_tokenizer_get(t
, 1))) {
780 pa_strbuf_puts(buf
, "You need to specify a sink input by its index.\n");
784 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
785 pa_strbuf_puts(buf
, "Failed to parse index.\n");
789 if (!(k
= pa_tokenizer_get(t
, 2))) {
790 pa_strbuf_puts(buf
, "You need to specify a sink.\n");
794 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, (uint32_t) idx
))) {
795 pa_strbuf_puts(buf
, "No sink input found with this index.\n");
799 if (!(sink
= pa_namereg_get(c
, k
, PA_NAMEREG_SINK
, 1))) {
800 pa_strbuf_puts(buf
, "No sink found by this name or index.\n");
804 if (pa_sink_input_move_to(si
, sink
, 0) < 0) {
805 pa_strbuf_puts(buf
, "Moved failed.\n");
811 static int pa_cli_command_move_source_output(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, int *fail
) {
813 pa_source_output
*so
;
817 if (!(n
= pa_tokenizer_get(t
, 1))) {
818 pa_strbuf_puts(buf
, "You need to specify a source output by its index.\n");
822 if ((idx
= parse_index(n
)) == PA_IDXSET_INVALID
) {
823 pa_strbuf_puts(buf
, "Failed to parse index.\n");
827 if (!(k
= pa_tokenizer_get(t
, 2))) {
828 pa_strbuf_puts(buf
, "You need to specify a source.\n");
832 if (!(so
= pa_idxset_get_by_index(c
->source_outputs
, (uint32_t) idx
))) {
833 pa_strbuf_puts(buf
, "No source output found with this index.\n");
837 if (!(source
= pa_namereg_get(c
, k
, PA_NAMEREG_SOURCE
, 1))) {
838 pa_strbuf_puts(buf
, "No source found by this name or index.\n");
842 if (pa_source_output_move_to(so
, source
) < 0) {
843 pa_strbuf_puts(buf
, "Moved failed.\n");
849 static int pa_cli_command_dump(pa_core
*c
, pa_tokenizer
*t
, pa_strbuf
*buf
, PA_GCC_UNUSED
int *fail
) {
859 pa_autoload_entry
*a
;
866 pa_strbuf_printf(buf
, "### Configuration dump generated at %s\n", ctime_r(&now
, txt
));
868 pa_strbuf_printf(buf
, "### Configuration dump generated at %s\n", ctime(&now
));
872 for (m
= pa_idxset_first(c
->modules
, &idx
); m
; m
= pa_idxset_next(c
->modules
, &idx
)) {
876 pa_strbuf_printf(buf
, "load-module %s", m
->name
);
879 pa_strbuf_printf(buf
, " %s", m
->argument
);
881 pa_strbuf_puts(buf
, "\n");
886 for (sink
= pa_idxset_first(c
->sinks
, &idx
); sink
; sink
= pa_idxset_next(c
->sinks
, &idx
)) {
887 if (sink
->owner
&& sink
->owner
->auto_unload
)
891 pa_strbuf_puts(buf
, "\n");
895 pa_strbuf_printf(buf
, "set-sink-volume %s 0x%03x\n", sink
->name
, pa_cvolume_avg(pa_sink_get_volume(sink
, PA_MIXER_HARDWARE
)));
896 pa_strbuf_printf(buf
, "set-sink-mute %s %d\n", sink
->name
, pa_sink_get_mute(sink
, PA_MIXER_HARDWARE
));
899 for (source
= pa_idxset_first(c
->sources
, &idx
); source
; source
= pa_idxset_next(c
->sources
, &idx
)) {
900 if (source
->owner
&& source
->owner
->auto_unload
)
904 pa_strbuf_puts(buf
, "\n");
908 pa_strbuf_printf(buf
, "set-source-volume %s 0x%03x\n", source
->name
, pa_cvolume_avg(pa_source_get_volume(source
, PA_MIXER_HARDWARE
)));
909 pa_strbuf_printf(buf
, "set-source-mute %s %d\n", source
->name
, pa_source_get_mute(source
, PA_MIXER_HARDWARE
));
913 if (c
->autoload_hashmap
) {
917 while ((a
= pa_hashmap_iterate(c
->autoload_hashmap
, &i
, NULL
))) {
920 pa_strbuf_puts(buf
, "\n");
924 pa_strbuf_printf(buf
, "add-autoload-%s %s %s", a
->type
== PA_NAMEREG_SINK
? "sink" : "source", a
->name
, a
->module
);
927 pa_strbuf_printf(buf
, " %s", a
->argument
);
929 pa_strbuf_puts(buf
, "\n");
935 if ((p
= pa_namereg_get_default_sink_name(c
))) {
937 pa_strbuf_puts(buf
, "\n");
940 pa_strbuf_printf(buf
, "set-default-sink %s\n", p
);
943 if ((p
= pa_namereg_get_default_source_name(c
))) {
945 pa_strbuf_puts(buf
, "\n");
948 pa_strbuf_printf(buf
, "set-default-source %s\n", p
);
951 pa_strbuf_puts(buf
, "\n### EOF\n");
956 int pa_cli_command_execute_line(pa_core
*c
, const char *s
, pa_strbuf
*buf
, int *fail
) {
959 cs
= s
+strspn(s
, whitespace
);
961 if (*cs
== '#' || !*cs
)
963 else if (*cs
== '.') {
964 if (!strcmp(cs
, FAIL_META
))
966 else if (!strcmp(cs
, NOFAIL_META
))
970 l
= strcspn(cs
, whitespace
);
972 if (l
== sizeof(INCLUDE_META
)-1 && !strncmp(cs
, INCLUDE_META
, l
)) {
973 const char *filename
= cs
+l
+strspn(cs
+l
, whitespace
);
975 if (pa_cli_command_execute_file(c
, filename
, buf
, fail
) < 0)
976 if (*fail
) return -1;
978 pa_strbuf_printf(buf
, "Invalid meta command: %s\n", cs
);
979 if (*fail
) return -1;
983 const struct command
*command
;
987 l
= strcspn(cs
, whitespace
);
989 for (command
= commands
; command
->name
; command
++)
990 if (strlen(command
->name
) == l
&& !strncmp(cs
, command
->name
, l
)) {
992 pa_tokenizer
*t
= pa_tokenizer_new(cs
, command
->args
);
994 ret
= command
->proc(c
, t
, buf
, fail
);
995 pa_tokenizer_free(t
);
998 if (ret
< 0 && *fail
)
1005 pa_strbuf_printf(buf
, "Unknown command: %s\n", cs
);
1014 int pa_cli_command_execute_file(pa_core
*c
, const char *fn
, pa_strbuf
*buf
, int *fail
) {
1018 assert(c
&& fn
&& buf
);
1020 if (!(f
= fopen(fn
, "r"))) {
1021 pa_strbuf_printf(buf
, "open('%s') failed: %s\n", fn
, pa_cstrerror(errno
));
1027 while (fgets(line
, sizeof(line
), f
)) {
1028 char *e
= line
+ strcspn(line
, linebreak
);
1031 if (pa_cli_command_execute_line(c
, line
, buf
, fail
) < 0 && *fail
)
1044 int pa_cli_command_execute(pa_core
*c
, const char *s
, pa_strbuf
*buf
, int *fail
) {
1046 assert(c
&& s
&& buf
&& fail
);
1050 size_t l
= strcspn(p
, linebreak
);
1051 char *line
= pa_xstrndup(p
, l
);
1053 if (pa_cli_command_execute_line(c
, line
, buf
, fail
) < 0&& *fail
) {
1060 p
+= strspn(p
, linebreak
);