Rework memory management to allow shared memory data transfer. The central idea
[pulseaudio.git] / src / pulsecore / cli-command.c
blob811b96d2aa10c5bd084416bff9577567427a6e94
1 /* $Id$ */
3 /***
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
19 USA.
20 ***/
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
26 #include <stdio.h>
27 #include <string.h>
28 #include <assert.h>
29 #include <stdlib.h>
30 #include <errno.h>
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"
56 struct command {
57 const char *name;
58 int (*proc) (pa_core *c, pa_tokenizer*t, pa_strbuf *buf, int *fail);
59 const char *help;
60 unsigned args;
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) {
156 uint32_t idx;
158 if (pa_atou(n, &idx) < 0)
159 return (uint32_t) PA_IDXSET_INVALID;
161 return idx;
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);
167 return 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++)
177 if (command->help)
178 pa_strbuf_printf(buf, " %-25s %s\n", command->name, command->help);
179 return 0;
182 static int pa_cli_command_modules(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
183 char *s;
184 assert(c && t);
185 s = pa_module_list_to_string(c);
186 assert(s);
187 pa_strbuf_puts(buf, s);
188 pa_xfree(s);
189 return 0;
192 static int pa_cli_command_clients(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
193 char *s;
194 assert(c && t);
195 s = pa_client_list_to_string(c);
196 assert(s);
197 pa_strbuf_puts(buf, s);
198 pa_xfree(s);
199 return 0;
202 static int pa_cli_command_sinks(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
203 char *s;
204 assert(c && t);
205 s = pa_sink_list_to_string(c);
206 assert(s);
207 pa_strbuf_puts(buf, s);
208 pa_xfree(s);
209 return 0;
212 static int pa_cli_command_sources(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
213 char *s;
214 assert(c && t);
215 s = pa_source_list_to_string(c);
216 assert(s);
217 pa_strbuf_puts(buf, s);
218 pa_xfree(s);
219 return 0;
222 static int pa_cli_command_sink_inputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
223 char *s;
224 assert(c && t);
225 s = pa_sink_input_list_to_string(c);
226 assert(s);
227 pa_strbuf_puts(buf, s);
228 pa_xfree(s);
229 return 0;
232 static int pa_cli_command_source_outputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
233 char *s;
234 assert(c && t);
235 s = pa_source_output_list_to_string(c);
236 assert(s);
237 pa_strbuf_puts(buf, s);
238 pa_xfree(s);
239 return 0;
242 static int pa_cli_command_stat(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
243 char s[256];
244 const pa_mempool_stat *stat;
245 assert(c && t);
247 stat = pa_mempool_get_stat(c->mempool);
249 pa_strbuf_printf(buf, "Memory blocks currently allocated: %u, size: %s.\n",
250 stat->n_allocated,
251 pa_bytes_snprint(s, sizeof(s), stat->allocated_size));
253 pa_strbuf_printf(buf, "Memory blocks allocated during the whole lifetime: %u, size: %s.\n",
254 stat->n_accumulated,
255 pa_bytes_snprint(s, sizeof(s), stat->accumulated_size));
257 pa_strbuf_printf(buf, "Memory blocks imported from other processes: %u, size: %s.\n",
258 stat->n_imported,
259 pa_bytes_snprint(s, sizeof(s), stat->imported_size));
261 pa_strbuf_printf(buf, "Memory blocks exported to other processes: %u, size: %s.\n",
262 stat->n_exported,
263 pa_bytes_snprint(s, sizeof(s), stat->exported_size));
265 pa_strbuf_printf(buf, "Total sample cache size: %s.\n",
266 pa_bytes_snprint(s, sizeof(s), pa_scache_total_size(c)));
268 pa_strbuf_printf(buf, "Default sample spec: %s\n",
269 pa_sample_spec_snprint(s, sizeof(s), &c->default_sample_spec));
271 pa_strbuf_printf(buf, "Default sink name: %s\n"
272 "Default source name: %s\n",
273 pa_namereg_get_default_sink_name(c),
274 pa_namereg_get_default_source_name(c));
276 return 0;
279 static int pa_cli_command_info(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
280 assert(c && t);
281 pa_cli_command_stat(c, t, buf, fail);
282 pa_cli_command_modules(c, t, buf, fail);
283 pa_cli_command_sinks(c, t, buf, fail);
284 pa_cli_command_sources(c, t, buf, fail);
285 pa_cli_command_clients(c, t, buf, fail);
286 pa_cli_command_sink_inputs(c, t, buf, fail);
287 pa_cli_command_source_outputs(c, t, buf, fail);
288 pa_cli_command_scache_list(c, t, buf, fail);
289 pa_cli_command_autoload_list(c, t, buf, fail);
290 return 0;
293 static int pa_cli_command_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
294 pa_module *m;
295 const char *name;
296 assert(c && t);
298 if (!(name = pa_tokenizer_get(t, 1))) {
299 pa_strbuf_puts(buf, "You need to specify the module name and optionally arguments.\n");
300 return -1;
303 if (!(m = pa_module_load(c, name, pa_tokenizer_get(t, 2)))) {
304 pa_strbuf_puts(buf, "Module load failed.\n");
305 return -1;
308 return 0;
311 static int pa_cli_command_unload(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
312 pa_module *m;
313 uint32_t idx;
314 const char *i;
315 char *e;
316 assert(c && t);
318 if (!(i = pa_tokenizer_get(t, 1))) {
319 pa_strbuf_puts(buf, "You need to specify the module index.\n");
320 return -1;
323 idx = (uint32_t) strtoul(i, &e, 10);
324 if (*e || !(m = pa_idxset_get_by_index(c->modules, idx))) {
325 pa_strbuf_puts(buf, "Invalid module index.\n");
326 return -1;
329 pa_module_unload_request(m);
330 return 0;
333 static int pa_cli_command_sink_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
334 const char *n, *v;
335 pa_sink *sink;
336 uint32_t volume;
337 pa_cvolume cvolume;
339 if (!(n = pa_tokenizer_get(t, 1))) {
340 pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
341 return -1;
344 if (!(v = pa_tokenizer_get(t, 2))) {
345 pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
346 return -1;
349 if (pa_atou(v, &volume) < 0) {
350 pa_strbuf_puts(buf, "Failed to parse volume.\n");
351 return -1;
354 if (!(sink = pa_namereg_get(c, n, PA_NAMEREG_SINK, 1))) {
355 pa_strbuf_puts(buf, "No sink found by this name or index.\n");
356 return -1;
359 pa_cvolume_set(&cvolume, sink->sample_spec.channels, volume);
360 pa_sink_set_volume(sink, PA_MIXER_HARDWARE, &cvolume);
361 return 0;
364 static int pa_cli_command_sink_input_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
365 const char *n, *v;
366 pa_sink_input *si;
367 pa_volume_t volume;
368 pa_cvolume cvolume;
369 uint32_t idx;
371 if (!(n = pa_tokenizer_get(t, 1))) {
372 pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
373 return -1;
376 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
377 pa_strbuf_puts(buf, "Failed to parse index.\n");
378 return -1;
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");
383 return -1;
386 if (pa_atou(v, &volume) < 0) {
387 pa_strbuf_puts(buf, "Failed to parse volume.\n");
388 return -1;
391 if (!(si = pa_idxset_get_by_index(c->sink_inputs, (uint32_t) idx))) {
392 pa_strbuf_puts(buf, "No sink input found with this index.\n");
393 return -1;
396 pa_cvolume_set(&cvolume, si->sample_spec.channels, volume);
397 pa_sink_input_set_volume(si, &cvolume);
398 return 0;
401 static int pa_cli_command_source_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
402 const char *n, *v;
403 pa_source *source;
404 uint32_t volume;
405 pa_cvolume cvolume;
407 if (!(n = pa_tokenizer_get(t, 1))) {
408 pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
409 return -1;
412 if (!(v = pa_tokenizer_get(t, 2))) {
413 pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
414 return -1;
417 if (pa_atou(v, &volume) < 0) {
418 pa_strbuf_puts(buf, "Failed to parse volume.\n");
419 return -1;
422 if (!(source = pa_namereg_get(c, n, PA_NAMEREG_SOURCE, 1))) {
423 pa_strbuf_puts(buf, "No source found by this name or index.\n");
424 return -1;
427 pa_cvolume_set(&cvolume, source->sample_spec.channels, volume);
428 pa_source_set_volume(source, PA_MIXER_HARDWARE, &cvolume);
429 return 0;
432 static int pa_cli_command_sink_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
433 const char *n, *m;
434 pa_sink *sink;
435 int mute;
437 if (!(n = pa_tokenizer_get(t, 1))) {
438 pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
439 return -1;
442 if (!(m = pa_tokenizer_get(t, 2))) {
443 pa_strbuf_puts(buf, "You need to specify a mute switch setting (0/1).\n");
444 return -1;
447 if (pa_atoi(m, &mute) < 0) {
448 pa_strbuf_puts(buf, "Failed to parse mute switch.\n");
449 return -1;
452 if (!(sink = pa_namereg_get(c, n, PA_NAMEREG_SINK, 1))) {
453 pa_strbuf_puts(buf, "No sink found by this name or index.\n");
454 return -1;
457 pa_sink_set_mute(sink, PA_MIXER_HARDWARE, mute);
458 return 0;
461 static int pa_cli_command_source_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
462 const char *n, *m;
463 pa_source *source;
464 int mute;
466 if (!(n = pa_tokenizer_get(t, 1))) {
467 pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
468 return -1;
471 if (!(m = pa_tokenizer_get(t, 2))) {
472 pa_strbuf_puts(buf, "You need to specify a mute switch setting (0/1).\n");
473 return -1;
476 if (pa_atoi(m, &mute) < 0) {
477 pa_strbuf_puts(buf, "Failed to parse mute switch.\n");
478 return -1;
481 if (!(source = pa_namereg_get(c, n, PA_NAMEREG_SOURCE, 1))) {
482 pa_strbuf_puts(buf, "No sink found by this name or index.\n");
483 return -1;
486 pa_source_set_mute(source, PA_MIXER_HARDWARE, mute);
487 return 0;
490 static int pa_cli_command_sink_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
491 const char *n;
492 assert(c && t);
494 if (!(n = pa_tokenizer_get(t, 1))) {
495 pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
496 return -1;
499 pa_namereg_set_default(c, n, PA_NAMEREG_SINK);
500 return 0;
503 static int pa_cli_command_source_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
504 const char *n;
505 assert(c && t);
507 if (!(n = pa_tokenizer_get(t, 1))) {
508 pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
509 return -1;
512 pa_namereg_set_default(c, n, PA_NAMEREG_SOURCE);
513 return 0;
516 static int pa_cli_command_kill_client(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
517 const char *n;
518 pa_client *client;
519 uint32_t idx;
520 assert(c && t);
522 if (!(n = pa_tokenizer_get(t, 1))) {
523 pa_strbuf_puts(buf, "You need to specify a client by its index.\n");
524 return -1;
527 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
528 pa_strbuf_puts(buf, "Failed to parse index.\n");
529 return -1;
532 if (!(client = pa_idxset_get_by_index(c->clients, idx))) {
533 pa_strbuf_puts(buf, "No client found by this index.\n");
534 return -1;
537 pa_client_kill(client);
538 return 0;
541 static int pa_cli_command_kill_sink_input(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
542 const char *n;
543 pa_sink_input *sink_input;
544 uint32_t idx;
545 assert(c && t);
547 if (!(n = pa_tokenizer_get(t, 1))) {
548 pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
549 return -1;
552 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
553 pa_strbuf_puts(buf, "Failed to parse index.\n");
554 return -1;
557 if (!(sink_input = pa_idxset_get_by_index(c->sink_inputs, idx))) {
558 pa_strbuf_puts(buf, "No sink input found by this index.\n");
559 return -1;
562 pa_sink_input_kill(sink_input);
563 return 0;
566 static int pa_cli_command_kill_source_output(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
567 const char *n;
568 pa_source_output *source_output;
569 uint32_t idx;
570 assert(c && t);
572 if (!(n = pa_tokenizer_get(t, 1))) {
573 pa_strbuf_puts(buf, "You need to specify a source output by its index.\n");
574 return -1;
577 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
578 pa_strbuf_puts(buf, "Failed to parse index.\n");
579 return -1;
582 if (!(source_output = pa_idxset_get_by_index(c->source_outputs, idx))) {
583 pa_strbuf_puts(buf, "No source output found by this index.\n");
584 return -1;
587 pa_source_output_kill(source_output);
588 return 0;
591 static int pa_cli_command_scache_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
592 char *s;
593 assert(c && t);
594 s = pa_scache_list_to_string(c);
595 assert(s);
596 pa_strbuf_puts(buf, s);
597 pa_xfree(s);
598 return 0;
601 static int pa_cli_command_scache_play(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
602 const char *n, *sink_name;
603 pa_sink *sink;
604 assert(c && t && buf && fail);
606 if (!(n = pa_tokenizer_get(t, 1)) || !(sink_name = pa_tokenizer_get(t, 2))) {
607 pa_strbuf_puts(buf, "You need to specify a sample name and a sink name.\n");
608 return -1;
611 if (!(sink = pa_namereg_get(c, sink_name, PA_NAMEREG_SINK, 1))) {
612 pa_strbuf_puts(buf, "No sink by that name.\n");
613 return -1;
616 if (pa_scache_play_item(c, n, sink, PA_VOLUME_NORM) < 0) {
617 pa_strbuf_puts(buf, "Failed to play sample.\n");
618 return -1;
621 return 0;
624 static int pa_cli_command_scache_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
625 const char *n;
626 assert(c && t && buf && fail);
628 if (!(n = pa_tokenizer_get(t, 1))) {
629 pa_strbuf_puts(buf, "You need to specify a sample name.\n");
630 return -1;
633 if (pa_scache_remove_item(c, n) < 0) {
634 pa_strbuf_puts(buf, "Failed to remove sample.\n");
635 return -1;
638 return 0;
641 static int pa_cli_command_scache_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
642 const char *fname, *n;
643 int r;
644 assert(c && t && buf && fail);
646 if (!(fname = pa_tokenizer_get(t, 2)) || !(n = pa_tokenizer_get(t, 1))) {
647 pa_strbuf_puts(buf, "You need to specify a file name and a sample name.\n");
648 return -1;
651 if (strstr(pa_tokenizer_get(t, 0), "lazy"))
652 r = pa_scache_add_file_lazy(c, n, fname, NULL);
653 else
654 r = pa_scache_add_file(c, n, fname, NULL);
656 if (r < 0)
657 pa_strbuf_puts(buf, "Failed to load sound file.\n");
659 return 0;
662 static int pa_cli_command_scache_load_dir(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
663 const char *pname;
664 assert(c && t && buf && fail);
666 if (!(pname = pa_tokenizer_get(t, 1))) {
667 pa_strbuf_puts(buf, "You need to specify a path name.\n");
668 return -1;
671 if (pa_scache_add_directory_lazy(c, pname) < 0) {
672 pa_strbuf_puts(buf, "Failed to load directory.\n");
673 return -1;
676 return 0;
679 static int pa_cli_command_play_file(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
680 const char *fname, *sink_name;
681 pa_sink *sink;
682 assert(c && t && buf && fail);
684 if (!(fname = pa_tokenizer_get(t, 1)) || !(sink_name = pa_tokenizer_get(t, 2))) {
685 pa_strbuf_puts(buf, "You need to specify a file name and a sink name.\n");
686 return -1;
689 if (!(sink = pa_namereg_get(c, sink_name, PA_NAMEREG_SINK, 1))) {
690 pa_strbuf_puts(buf, "No sink by that name.\n");
691 return -1;
695 return pa_play_file(sink, fname, NULL);
698 static int pa_cli_command_autoload_add(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
699 const char *a, *b;
700 assert(c && t && buf && fail);
702 if (!(a = pa_tokenizer_get(t, 1)) || !(b = pa_tokenizer_get(t, 2))) {
703 pa_strbuf_puts(buf, "You need to specify a device name, a filename or a module name and optionally module arguments\n");
704 return -1;
707 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);
709 return 0;
712 static int pa_cli_command_autoload_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
713 const char *name;
714 assert(c && t && buf && fail);
716 if (!(name = pa_tokenizer_get(t, 1))) {
717 pa_strbuf_puts(buf, "You need to specify a device name\n");
718 return -1;
721 if (pa_autoload_remove_by_name(c, name, strstr(pa_tokenizer_get(t, 0), "sink") ? PA_NAMEREG_SINK : PA_NAMEREG_SOURCE) < 0) {
722 pa_strbuf_puts(buf, "Failed to remove autload entry\n");
723 return -1;
726 return 0;
729 static int pa_cli_command_autoload_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
730 char *s;
731 assert(c && t);
732 s = pa_autoload_list_to_string(c);
733 assert(s);
734 pa_strbuf_puts(buf, s);
735 pa_xfree(s);
736 return 0;
739 static int pa_cli_command_list_props(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
740 assert(c && t);
741 pa_property_dump(c, buf);
742 return 0;
745 static int pa_cli_command_vacuum(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
746 assert(c);
747 assert(t);
749 pa_mempool_vacuum(c->mempool);
751 return 0;
754 static int pa_cli_command_move_sink_input(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
755 const char *n, *k;
756 pa_sink_input *si;
757 pa_sink *sink;
758 uint32_t idx;
760 if (!(n = pa_tokenizer_get(t, 1))) {
761 pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
762 return -1;
765 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
766 pa_strbuf_puts(buf, "Failed to parse index.\n");
767 return -1;
770 if (!(k = pa_tokenizer_get(t, 2))) {
771 pa_strbuf_puts(buf, "You need to specify a sink.\n");
772 return -1;
775 if (!(si = pa_idxset_get_by_index(c->sink_inputs, (uint32_t) idx))) {
776 pa_strbuf_puts(buf, "No sink input found with this index.\n");
777 return -1;
780 if (!(sink = pa_namereg_get(c, k, PA_NAMEREG_SINK, 1))) {
781 pa_strbuf_puts(buf, "No sink found by this name or index.\n");
782 return -1;
785 if (pa_sink_input_move_to(si, sink, 0) < 0) {
786 pa_strbuf_puts(buf, "Moved failed.\n");
787 return -1;
789 return 0;
792 static int pa_cli_command_move_source_output(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
793 const char *n, *k;
794 pa_source_output *so;
795 pa_source *source;
796 uint32_t idx;
798 if (!(n = pa_tokenizer_get(t, 1))) {
799 pa_strbuf_puts(buf, "You need to specify a source output by its index.\n");
800 return -1;
803 if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
804 pa_strbuf_puts(buf, "Failed to parse index.\n");
805 return -1;
808 if (!(k = pa_tokenizer_get(t, 2))) {
809 pa_strbuf_puts(buf, "You need to specify a source.\n");
810 return -1;
813 if (!(so = pa_idxset_get_by_index(c->source_outputs, (uint32_t) idx))) {
814 pa_strbuf_puts(buf, "No source output found with this index.\n");
815 return -1;
818 if (!(source = pa_namereg_get(c, k, PA_NAMEREG_SOURCE, 1))) {
819 pa_strbuf_puts(buf, "No source found by this name or index.\n");
820 return -1;
823 if (pa_source_output_move_to(so, source) < 0) {
824 pa_strbuf_puts(buf, "Moved failed.\n");
825 return -1;
827 return 0;
830 static int pa_cli_command_dump(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
831 pa_module *m;
832 pa_sink *sink;
833 pa_source *source;
834 int nl;
835 const char *p;
836 uint32_t idx;
837 char txt[256];
838 time_t now;
839 void *i;
840 pa_autoload_entry *a;
842 assert(c && t);
844 time(&now);
846 #ifdef HAVE_CTIME_R
847 pa_strbuf_printf(buf, "### Configuration dump generated at %s\n", ctime_r(&now, txt));
848 #else
849 pa_strbuf_printf(buf, "### Configuration dump generated at %s\n", ctime(&now));
850 #endif
853 for (m = pa_idxset_first(c->modules, &idx); m; m = pa_idxset_next(c->modules, &idx)) {
854 if (m->auto_unload)
855 continue;
857 pa_strbuf_printf(buf, "load-module %s", m->name);
859 if (m->argument)
860 pa_strbuf_printf(buf, " %s", m->argument);
862 pa_strbuf_puts(buf, "\n");
865 nl = 0;
867 for (sink = pa_idxset_first(c->sinks, &idx); sink; sink = pa_idxset_next(c->sinks, &idx)) {
868 if (sink->owner && sink->owner->auto_unload)
869 continue;
871 if (!nl) {
872 pa_strbuf_puts(buf, "\n");
873 nl = 1;
876 pa_strbuf_printf(buf, "set-sink-volume %s 0x%03x\n", sink->name, pa_cvolume_avg(pa_sink_get_volume(sink, PA_MIXER_HARDWARE)));
877 pa_strbuf_printf(buf, "set-sink-mute %s %d\n", sink->name, pa_sink_get_mute(sink, PA_MIXER_HARDWARE));
880 for (source = pa_idxset_first(c->sources, &idx); source; source = pa_idxset_next(c->sources, &idx)) {
881 if (source->owner && source->owner->auto_unload)
882 continue;
884 if (!nl) {
885 pa_strbuf_puts(buf, "\n");
886 nl = 1;
889 pa_strbuf_printf(buf, "set-source-volume %s 0x%03x\n", source->name, pa_cvolume_avg(pa_source_get_volume(source, PA_MIXER_HARDWARE)));
890 pa_strbuf_printf(buf, "set-source-mute %s %d\n", source->name, pa_source_get_mute(source, PA_MIXER_HARDWARE));
894 if (c->autoload_hashmap) {
895 nl = 0;
897 i = NULL;
898 while ((a = pa_hashmap_iterate(c->autoload_hashmap, &i, NULL))) {
900 if (!nl) {
901 pa_strbuf_puts(buf, "\n");
902 nl = 1;
905 pa_strbuf_printf(buf, "add-autoload-%s %s %s", a->type == PA_NAMEREG_SINK ? "sink" : "source", a->name, a->module);
907 if (a->argument)
908 pa_strbuf_printf(buf, " %s", a->argument);
910 pa_strbuf_puts(buf, "\n");
914 nl = 0;
916 if ((p = pa_namereg_get_default_sink_name(c))) {
917 if (!nl) {
918 pa_strbuf_puts(buf, "\n");
919 nl = 1;
921 pa_strbuf_printf(buf, "set-default-sink %s\n", p);
924 if ((p = pa_namereg_get_default_source_name(c))) {
925 if (!nl) {
926 pa_strbuf_puts(buf, "\n");
927 nl = 1;
929 pa_strbuf_printf(buf, "set-default-source %s\n", p);
932 pa_strbuf_puts(buf, "\n### EOF\n");
934 return 0;
937 int pa_cli_command_execute_line(pa_core *c, const char *s, pa_strbuf *buf, int *fail) {
938 const char *cs;
940 cs = s+strspn(s, whitespace);
942 if (*cs == '#' || !*cs)
943 return 0;
944 else if (*cs == '.') {
945 if (!strcmp(cs, FAIL_META))
946 *fail = 1;
947 else if (!strcmp(cs, NOFAIL_META))
948 *fail = 0;
949 else {
950 size_t l;
951 l = strcspn(cs, whitespace);
953 if (l == sizeof(INCLUDE_META)-1 && !strncmp(cs, INCLUDE_META, l)) {
954 const char *filename = cs+l+strspn(cs+l, whitespace);
956 if (pa_cli_command_execute_file(c, filename, buf, fail) < 0)
957 if (*fail) return -1;
958 } else {
959 pa_strbuf_printf(buf, "Invalid meta command: %s\n", cs);
960 if (*fail) return -1;
963 } else {
964 const struct command*command;
965 int unknown = 1;
966 size_t l;
968 l = strcspn(cs, whitespace);
970 for (command = commands; command->name; command++)
971 if (strlen(command->name) == l && !strncmp(cs, command->name, l)) {
972 int ret;
973 pa_tokenizer *t = pa_tokenizer_new(cs, command->args);
974 assert(t);
975 ret = command->proc(c, t, buf, fail);
976 pa_tokenizer_free(t);
977 unknown = 0;
979 if (ret < 0 && *fail)
980 return -1;
982 break;
985 if (unknown) {
986 pa_strbuf_printf(buf, "Unknown command: %s\n", cs);
987 if (*fail)
988 return -1;
992 return 0;
995 int pa_cli_command_execute_file(pa_core *c, const char *fn, pa_strbuf *buf, int *fail) {
996 char line[256];
997 FILE *f = NULL;
998 int ret = -1;
999 assert(c && fn && buf);
1001 if (!(f = fopen(fn, "r"))) {
1002 pa_strbuf_printf(buf, "open('%s') failed: %s\n", fn, pa_cstrerror(errno));
1003 if (!*fail)
1004 ret = 0;
1005 goto fail;
1008 while (fgets(line, sizeof(line), f)) {
1009 char *e = line + strcspn(line, linebreak);
1010 *e = 0;
1012 if (pa_cli_command_execute_line(c, line, buf, fail) < 0 && *fail)
1013 goto fail;
1016 ret = 0;
1018 fail:
1019 if (f)
1020 fclose(f);
1022 return ret;
1025 int pa_cli_command_execute(pa_core *c, const char *s, pa_strbuf *buf, int *fail) {
1026 const char *p;
1027 assert(c && s && buf && fail);
1029 p = s;
1030 while (*p) {
1031 size_t l = strcspn(p, linebreak);
1032 char *line = pa_xstrndup(p, l);
1034 if (pa_cli_command_execute_line(c, line, buf, fail) < 0&& *fail) {
1035 pa_xfree(line);
1036 return -1;
1038 pa_xfree(line);
1040 p += l;
1041 p += strspn(p, linebreak);
1044 return 0;