code.delx.au - pulseaudio/blob - src/pulsecore/cli-command.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   Copyright 2004-2006 Lennart Poettering
   7   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   8
   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.
  13
  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.
  18
  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
  22   USA.
  23 ***/
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include <config.h>
  27 #endif
  28
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <assert.h>
  32 #include <stdlib.h>
  33 #include <errno.h>
  34
  35 #include <pulse/xmalloc.h>
  36
  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>
  56
  57 #include "cli-command.h"
  58
  59 struct command {
  60     const char *name;
  61     int (*proc) (pa_core *c, pa_tokenizer*t, pa_strbuf *buf, int *fail);
  62     const char *help;
  63     unsigned args;
  64 };
  65
  66 #define INCLUDE_META ".include"
  67 #define FAIL_META ".fail"
  68 #define NOFAIL_META ".nofail"
  69
  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);
 107
 108 /* A method table for all available commands */
 109
 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 }
 153 };
 154
 155 static const char whitespace[] = " \t\n\r";
 156 static const char linebreak[] = "\n\r";
 157
 158 static uint32_t parse_index(const char *n) {
 159     uint32_t idx;
 160
 161     if (pa_atou(n, &idx) < 0)
 162         return (uint32_t) PA_IDXSET_INVALID;
 163
 164     return idx;
 165 }
 166
 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);
 170     return 0;
 171 }
 172
 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);
 176
 177     pa_strbuf_puts(buf, "Available commands:\n");
 178
 179     for (command = commands; command->name; command++)
 180         if (command->help)
 181             pa_strbuf_printf(buf, "    %-25s %s\n", command->name, command->help);
 182     return 0;
 183 }
 184
 185 static int pa_cli_command_modules(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 186     char *s;
 187     assert(c && t);
 188     s = pa_module_list_to_string(c);
 189     assert(s);
 190     pa_strbuf_puts(buf, s);
 191     pa_xfree(s);
 192     return 0;
 193 }
 194
 195 static int pa_cli_command_clients(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 196     char *s;
 197     assert(c && t);
 198     s = pa_client_list_to_string(c);
 199     assert(s);
 200     pa_strbuf_puts(buf, s);
 201     pa_xfree(s);
 202     return 0;
 203 }
 204
 205 static int pa_cli_command_sinks(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 206     char *s;
 207     assert(c && t);
 208     s = pa_sink_list_to_string(c);
 209     assert(s);
 210     pa_strbuf_puts(buf, s);
 211     pa_xfree(s);
 212     return 0;
 213 }
 214
 215 static int pa_cli_command_sources(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 216     char *s;
 217     assert(c && t);
 218     s = pa_source_list_to_string(c);
 219     assert(s);
 220     pa_strbuf_puts(buf, s);
 221     pa_xfree(s);
 222     return 0;
 223 }
 224
 225 static int pa_cli_command_sink_inputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 226     char *s;
 227     assert(c && t);
 228     s = pa_sink_input_list_to_string(c);
 229     assert(s);
 230     pa_strbuf_puts(buf, s);
 231     pa_xfree(s);
 232     return 0;
 233 }
 234
 235 static int pa_cli_command_source_outputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 236     char *s;
 237     assert(c && t);
 238     s = pa_source_output_list_to_string(c);
 239     assert(s);
 240     pa_strbuf_puts(buf, s);
 241     pa_xfree(s);
 242     return 0;
 243 }
 244
 245 static int pa_cli_command_stat(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 246     char s[256];
 247     const pa_mempool_stat *stat;
 248     unsigned k;
 249     const char *def_sink, *def_source;
 250
 251     static const char* const type_table[PA_MEMBLOCK_TYPE_MAX] = {
 252         [PA_MEMBLOCK_POOL] = "POOL",
 253         [PA_MEMBLOCK_POOL_EXTERNAL] = "POOL_EXTERNAL",
 254         [PA_MEMBLOCK_APPENDED] = "APPENDED",
 255         [PA_MEMBLOCK_USER] = "USER",
 256         [PA_MEMBLOCK_FIXED] = "FIXED",
 257         [PA_MEMBLOCK_IMPORTED] = "IMPORTED",
 258     };
 259
 260     assert(c);
 261     assert(t);
 262
 263     stat = pa_mempool_get_stat(c->mempool);
 264
 265     pa_strbuf_printf(buf, "Memory blocks currently allocated: %u, size: %s.\n",
 266                      (unsigned) AO_load_acquire_read((AO_t*) &stat->n_allocated),
 267                      pa_bytes_snprint(s, sizeof(s), (size_t) AO_load_acquire_read((AO_t*) &stat->allocated_size)));
 268
 269     pa_strbuf_printf(buf, "Memory blocks allocated during the whole lifetime: %u, size: %s.\n",
 270                      (unsigned) AO_load_acquire_read((AO_t*) &stat->n_accumulated),
 271                      pa_bytes_snprint(s, sizeof(s), (size_t) AO_load_acquire_read((AO_t*) &stat->accumulated_size)));
 272
 273     pa_strbuf_printf(buf, "Memory blocks imported from other processes: %u, size: %s.\n",
 274                      (unsigned) AO_load_acquire_read((AO_t*) &stat->n_imported),
 275                      pa_bytes_snprint(s, sizeof(s), (size_t) AO_load_acquire_read((AO_t*) &stat->imported_size)));
 276
 277     pa_strbuf_printf(buf, "Memory blocks exported to other processes: %u, size: %s.\n",
 278                      (unsigned) AO_load_acquire_read((AO_t*) &stat->n_exported),
 279                      pa_bytes_snprint(s, sizeof(s), (size_t) AO_load_acquire_read((AO_t*) &stat->exported_size)));
 280
 281     pa_strbuf_printf(buf, "Total sample cache size: %s.\n",
 282                      pa_bytes_snprint(s, sizeof(s), pa_scache_total_size(c)));
 283
 284     pa_strbuf_printf(buf, "Default sample spec: %s\n",
 285                      pa_sample_spec_snprint(s, sizeof(s), &c->default_sample_spec));
 286
 287     def_sink = pa_namereg_get_default_sink_name(c);
 288     def_source = pa_namereg_get_default_source_name(c);
 289     pa_strbuf_printf(buf, "Default sink name: %s\n"
 290                      "Default source name: %s\n",
 291                      def_sink ? def_sink : "none",
 292                      def_source ? def_source : "none");
 293
 294     for (k = 0; k < PA_MEMBLOCK_TYPE_MAX; k++)
 295         pa_strbuf_printf(buf,
 296                          "Memory blocks of type %s: %u allocated/%u accumulated.\n",
 297                          type_table[k],
 298                          (unsigned) AO_load_acquire_read(&stat->n_allocated_by_type[k]),
 299                          (unsigned) AO_load_acquire_read(&stat->n_accumulated_by_type[k]));
 300
 301     return 0;
 302 }
 303
 304 static int pa_cli_command_info(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 305     assert(c && t);
 306     pa_cli_command_stat(c, t, buf, fail);
 307     pa_cli_command_modules(c, t, buf, fail);
 308     pa_cli_command_sinks(c, t, buf, fail);
 309     pa_cli_command_sources(c, t, buf, fail);
 310     pa_cli_command_clients(c, t, buf, fail);
 311     pa_cli_command_sink_inputs(c, t, buf, fail);
 312     pa_cli_command_source_outputs(c, t, buf, fail);
 313     pa_cli_command_scache_list(c, t, buf, fail);
 314     pa_cli_command_autoload_list(c, t, buf, fail);
 315     return 0;
 316 }
 317
 318 static int pa_cli_command_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 319     pa_module *m;
 320     const char *name;
 321     assert(c && t);
 322
 323     if (!(name = pa_tokenizer_get(t, 1))) {
 324         pa_strbuf_puts(buf, "You need to specify the module name and optionally arguments.\n");
 325         return -1;
 326     }
 327
 328     if (!(m = pa_module_load(c, name,  pa_tokenizer_get(t, 2)))) {
 329         pa_strbuf_puts(buf, "Module load failed.\n");
 330         return -1;
 331     }
 332
 333     return 0;
 334 }
 335
 336 static int pa_cli_command_unload(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 337     pa_module *m;
 338     uint32_t idx;
 339     const char *i;
 340     char *e;
 341     assert(c && t);
 342
 343     if (!(i = pa_tokenizer_get(t, 1))) {
 344         pa_strbuf_puts(buf, "You need to specify the module index.\n");
 345         return -1;
 346     }
 347
 348     idx = (uint32_t) strtoul(i, &e, 10);
 349     if (*e || !(m = pa_idxset_get_by_index(c->modules, idx))) {
 350         pa_strbuf_puts(buf, "Invalid module index.\n");
 351         return -1;
 352     }
 353
 354     pa_module_unload_request(m);
 355     return 0;
 356 }
 357
 358 static int pa_cli_command_sink_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 359     const char *n, *v;
 360     pa_sink *sink;
 361     uint32_t volume;
 362     pa_cvolume cvolume;
 363
 364     if (!(n = pa_tokenizer_get(t, 1))) {
 365         pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
 366         return -1;
 367     }
 368
 369     if (!(v = pa_tokenizer_get(t, 2))) {
 370         pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
 371         return -1;
 372     }
 373
 374     if (pa_atou(v, &volume) < 0) {
 375         pa_strbuf_puts(buf, "Failed to parse volume.\n");
 376         return -1;
 377     }
 378
 379     if (!(sink = pa_namereg_get(c, n, PA_NAMEREG_SINK, 1))) {
 380         pa_strbuf_puts(buf, "No sink found by this name or index.\n");
 381         return -1;
 382     }
 383
 384     pa_cvolume_set(&cvolume, sink->sample_spec.channels, volume);
 385     pa_sink_set_volume(sink, PA_MIXER_HARDWARE, &cvolume);
 386     return 0;
 387 }
 388
 389 static int pa_cli_command_sink_input_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 390     const char *n, *v;
 391     pa_sink_input *si;
 392     pa_volume_t volume;
 393     pa_cvolume cvolume;
 394     uint32_t idx;
 395
 396     if (!(n = pa_tokenizer_get(t, 1))) {
 397         pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
 398         return -1;
 399     }
 400
 401     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 402         pa_strbuf_puts(buf, "Failed to parse index.\n");
 403         return -1;
 404     }
 405
 406     if (!(v = pa_tokenizer_get(t, 2))) {
 407         pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
 408         return -1;
 409     }
 410
 411     if (pa_atou(v, &volume) < 0) {
 412         pa_strbuf_puts(buf, "Failed to parse volume.\n");
 413         return -1;
 414     }
 415
 416     if (!(si = pa_idxset_get_by_index(c->sink_inputs, (uint32_t) idx))) {
 417         pa_strbuf_puts(buf, "No sink input found with this index.\n");
 418         return -1;
 419     }
 420
 421     pa_cvolume_set(&cvolume, si->sample_spec.channels, volume);
 422     pa_sink_input_set_volume(si, &cvolume);
 423     return 0;
 424 }
 425
 426 static int pa_cli_command_source_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 427     const char *n, *v;
 428     pa_source *source;
 429     uint32_t volume;
 430     pa_cvolume cvolume;
 431
 432     if (!(n = pa_tokenizer_get(t, 1))) {
 433         pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
 434         return -1;
 435     }
 436
 437     if (!(v = pa_tokenizer_get(t, 2))) {
 438         pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
 439         return -1;
 440     }
 441
 442     if (pa_atou(v, &volume) < 0) {
 443         pa_strbuf_puts(buf, "Failed to parse volume.\n");
 444         return -1;
 445     }
 446
 447     if (!(source = pa_namereg_get(c, n, PA_NAMEREG_SOURCE, 1))) {
 448         pa_strbuf_puts(buf, "No source found by this name or index.\n");
 449         return -1;
 450     }
 451
 452     pa_cvolume_set(&cvolume, source->sample_spec.channels, volume);
 453     pa_source_set_volume(source, PA_MIXER_HARDWARE, &cvolume);
 454     return 0;
 455 }
 456
 457 static int pa_cli_command_sink_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 458     const char *n, *m;
 459     pa_sink *sink;
 460     int mute;
 461
 462     if (!(n = pa_tokenizer_get(t, 1))) {
 463         pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
 464         return -1;
 465     }
 466
 467     if (!(m = pa_tokenizer_get(t, 2))) {
 468         pa_strbuf_puts(buf, "You need to specify a mute switch setting (0/1).\n");
 469         return -1;
 470     }
 471
 472     if (pa_atoi(m, &mute) < 0) {
 473         pa_strbuf_puts(buf, "Failed to parse mute switch.\n");
 474         return -1;
 475     }
 476
 477     if (!(sink = pa_namereg_get(c, n, PA_NAMEREG_SINK, 1))) {
 478         pa_strbuf_puts(buf, "No sink found by this name or index.\n");
 479         return -1;
 480     }
 481
 482     pa_sink_set_mute(sink, PA_MIXER_HARDWARE, mute);
 483     return 0;
 484 }
 485
 486 static int pa_cli_command_source_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 487     const char *n, *m;
 488     pa_source *source;
 489     int mute;
 490
 491     if (!(n = pa_tokenizer_get(t, 1))) {
 492         pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
 493         return -1;
 494     }
 495
 496     if (!(m = pa_tokenizer_get(t, 2))) {
 497         pa_strbuf_puts(buf, "You need to specify a mute switch setting (0/1).\n");
 498         return -1;
 499     }
 500
 501     if (pa_atoi(m, &mute) < 0) {
 502         pa_strbuf_puts(buf, "Failed to parse mute switch.\n");
 503         return -1;
 504     }
 505
 506     if (!(source = pa_namereg_get(c, n, PA_NAMEREG_SOURCE, 1))) {
 507         pa_strbuf_puts(buf, "No sink found by this name or index.\n");
 508         return -1;
 509     }
 510
 511     pa_source_set_mute(source, PA_MIXER_HARDWARE, mute);
 512     return 0;
 513 }
 514
 515 static int pa_cli_command_sink_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 516     const char *n;
 517     assert(c && t);
 518
 519     if (!(n = pa_tokenizer_get(t, 1))) {
 520         pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
 521         return -1;
 522     }
 523
 524     pa_namereg_set_default(c, n, PA_NAMEREG_SINK);
 525     return 0;
 526 }
 527
 528 static int pa_cli_command_source_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 529     const char *n;
 530     assert(c && t);
 531
 532     if (!(n = pa_tokenizer_get(t, 1))) {
 533         pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
 534         return -1;
 535     }
 536
 537     pa_namereg_set_default(c, n, PA_NAMEREG_SOURCE);
 538     return 0;
 539 }
 540
 541 static int pa_cli_command_kill_client(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 542     const char *n;
 543     pa_client *client;
 544     uint32_t idx;
 545     assert(c && t);
 546
 547     if (!(n = pa_tokenizer_get(t, 1))) {
 548         pa_strbuf_puts(buf, "You need to specify a client by its index.\n");
 549         return -1;
 550     }
 551
 552     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 553         pa_strbuf_puts(buf, "Failed to parse index.\n");
 554         return -1;
 555     }
 556
 557     if (!(client = pa_idxset_get_by_index(c->clients, idx))) {
 558         pa_strbuf_puts(buf, "No client found by this index.\n");
 559         return -1;
 560     }
 561
 562     pa_client_kill(client);
 563     return 0;
 564 }
 565
 566 static int pa_cli_command_kill_sink_input(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 567     const char *n;
 568     pa_sink_input *sink_input;
 569     uint32_t idx;
 570     assert(c && t);
 571
 572     if (!(n = pa_tokenizer_get(t, 1))) {
 573         pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
 574         return -1;
 575     }
 576
 577     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 578         pa_strbuf_puts(buf, "Failed to parse index.\n");
 579         return -1;
 580     }
 581
 582     if (!(sink_input = pa_idxset_get_by_index(c->sink_inputs, idx))) {
 583         pa_strbuf_puts(buf, "No sink input found by this index.\n");
 584         return -1;
 585     }
 586
 587     pa_sink_input_kill(sink_input);
 588     return 0;
 589 }
 590
 591 static int pa_cli_command_kill_source_output(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 592     const char *n;
 593     pa_source_output *source_output;
 594     uint32_t idx;
 595     assert(c && t);
 596
 597     if (!(n = pa_tokenizer_get(t, 1))) {
 598         pa_strbuf_puts(buf, "You need to specify a source output by its index.\n");
 599         return -1;
 600     }
 601
 602     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 603         pa_strbuf_puts(buf, "Failed to parse index.\n");
 604         return -1;
 605     }
 606
 607     if (!(source_output = pa_idxset_get_by_index(c->source_outputs, idx))) {
 608         pa_strbuf_puts(buf, "No source output found by this index.\n");
 609         return -1;
 610     }
 611
 612     pa_source_output_kill(source_output);
 613     return 0;
 614 }
 615
 616 static int pa_cli_command_scache_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 617     char *s;
 618     assert(c && t);
 619     s = pa_scache_list_to_string(c);
 620     assert(s);
 621     pa_strbuf_puts(buf, s);
 622     pa_xfree(s);
 623     return 0;
 624 }
 625
 626 static int pa_cli_command_scache_play(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 627     const char *n, *sink_name;
 628     pa_sink *sink;
 629     assert(c && t && buf && fail);
 630
 631     if (!(n = pa_tokenizer_get(t, 1)) || !(sink_name = pa_tokenizer_get(t, 2))) {
 632         pa_strbuf_puts(buf, "You need to specify a sample name and a sink name.\n");
 633         return -1;
 634     }
 635
 636     if (!(sink = pa_namereg_get(c, sink_name, PA_NAMEREG_SINK, 1))) {
 637         pa_strbuf_puts(buf, "No sink by that name.\n");
 638         return -1;
 639     }
 640
 641     if (pa_scache_play_item(c, n, sink, PA_VOLUME_NORM) < 0) {
 642         pa_strbuf_puts(buf, "Failed to play sample.\n");
 643         return -1;
 644     }
 645
 646     return 0;
 647 }
 648
 649 static int pa_cli_command_scache_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 650     const char *n;
 651     assert(c && t && buf && fail);
 652
 653     if (!(n = pa_tokenizer_get(t, 1))) {
 654         pa_strbuf_puts(buf, "You need to specify a sample name.\n");
 655         return -1;
 656     }
 657
 658     if (pa_scache_remove_item(c, n) < 0) {
 659         pa_strbuf_puts(buf, "Failed to remove sample.\n");
 660         return -1;
 661     }
 662
 663     return 0;
 664 }
 665
 666 static int pa_cli_command_scache_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 667     const char *fname, *n;
 668     int r;
 669     assert(c && t && buf && fail);
 670
 671     if (!(fname = pa_tokenizer_get(t, 2)) || !(n = pa_tokenizer_get(t, 1))) {
 672         pa_strbuf_puts(buf, "You need to specify a file name and a sample name.\n");
 673         return -1;
 674     }
 675
 676     if (strstr(pa_tokenizer_get(t, 0), "lazy"))
 677         r = pa_scache_add_file_lazy(c, n, fname, NULL);
 678     else
 679         r = pa_scache_add_file(c, n, fname, NULL);
 680
 681     if (r < 0)
 682         pa_strbuf_puts(buf, "Failed to load sound file.\n");
 683
 684     return 0;
 685 }
 686
 687 static int pa_cli_command_scache_load_dir(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 688     const char *pname;
 689     assert(c && t && buf && fail);
 690
 691     if (!(pname = pa_tokenizer_get(t, 1))) {
 692         pa_strbuf_puts(buf, "You need to specify a path name.\n");
 693         return -1;
 694     }
 695
 696     if (pa_scache_add_directory_lazy(c, pname) < 0) {
 697         pa_strbuf_puts(buf, "Failed to load directory.\n");
 698         return -1;
 699     }
 700
 701     return 0;
 702 }
 703
 704 static int pa_cli_command_play_file(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 705     const char *fname, *sink_name;
 706     pa_sink *sink;
 707     assert(c && t && buf && fail);
 708
 709     if (!(fname = pa_tokenizer_get(t, 1)) || !(sink_name = pa_tokenizer_get(t, 2))) {
 710         pa_strbuf_puts(buf, "You need to specify a file name and a sink name.\n");
 711         return -1;
 712     }
 713
 714     if (!(sink = pa_namereg_get(c, sink_name, PA_NAMEREG_SINK, 1))) {
 715         pa_strbuf_puts(buf, "No sink by that name.\n");
 716         return -1;
 717     }
 718
 719
 720     return pa_play_file(sink, fname, NULL);
 721 }
 722
 723 static int pa_cli_command_autoload_add(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 724     const char *a, *b;
 725     assert(c && t && buf && fail);
 726
 727     if (!(a = pa_tokenizer_get(t, 1)) || !(b = pa_tokenizer_get(t, 2))) {
 728         pa_strbuf_puts(buf, "You need to specify a device name, a filename or a module name and optionally module arguments\n");
 729         return -1;
 730     }
 731
 732     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);
 733
 734     return 0;
 735 }
 736
 737 static int pa_cli_command_autoload_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 738     const char *name;
 739     assert(c && t && buf && fail);
 740
 741     if (!(name = pa_tokenizer_get(t, 1))) {
 742         pa_strbuf_puts(buf, "You need to specify a device name\n");
 743         return -1;
 744     }
 745
 746     if (pa_autoload_remove_by_name(c, name, strstr(pa_tokenizer_get(t, 0), "sink") ? PA_NAMEREG_SINK : PA_NAMEREG_SOURCE) < 0) {
 747         pa_strbuf_puts(buf, "Failed to remove autload entry\n");
 748         return -1;
 749     }
 750
 751     return 0;
 752 }
 753
 754 static int pa_cli_command_autoload_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 755     char *s;
 756     assert(c && t);
 757     s = pa_autoload_list_to_string(c);
 758     assert(s);
 759     pa_strbuf_puts(buf, s);
 760     pa_xfree(s);
 761     return 0;
 762 }
 763
 764 static int pa_cli_command_list_props(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 765     assert(c && t);
 766     pa_property_dump(c, buf);
 767     return 0;
 768 }
 769
 770 static int pa_cli_command_vacuum(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 771     assert(c);
 772     assert(t);
 773
 774     pa_mempool_vacuum(c->mempool);
 775
 776     return 0;
 777 }
 778
 779 static int pa_cli_command_move_sink_input(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 780     const char *n, *k;
 781     pa_sink_input *si;
 782     pa_sink *sink;
 783     uint32_t idx;
 784
 785     if (!(n = pa_tokenizer_get(t, 1))) {
 786         pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
 787         return -1;
 788     }
 789
 790     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 791         pa_strbuf_puts(buf, "Failed to parse index.\n");
 792         return -1;
 793     }
 794
 795     if (!(k = pa_tokenizer_get(t, 2))) {
 796         pa_strbuf_puts(buf, "You need to specify a sink.\n");
 797         return -1;
 798     }
 799
 800     if (!(si = pa_idxset_get_by_index(c->sink_inputs, (uint32_t) idx))) {
 801         pa_strbuf_puts(buf, "No sink input found with this index.\n");
 802         return -1;
 803     }
 804
 805     if (!(sink = pa_namereg_get(c, k, PA_NAMEREG_SINK, 1))) {
 806         pa_strbuf_puts(buf, "No sink found by this name or index.\n");
 807         return -1;
 808     }
 809
 810     if (pa_sink_input_move_to(si, sink, 0) < 0) {
 811         pa_strbuf_puts(buf, "Moved failed.\n");
 812         return -1;
 813     }
 814     return 0;
 815 }
 816
 817 static int pa_cli_command_move_source_output(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 818     const char *n, *k;
 819     pa_source_output *so;
 820     pa_source *source;
 821     uint32_t idx;
 822
 823     if (!(n = pa_tokenizer_get(t, 1))) {
 824         pa_strbuf_puts(buf, "You need to specify a source output by its index.\n");
 825         return -1;
 826     }
 827
 828     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 829         pa_strbuf_puts(buf, "Failed to parse index.\n");
 830         return -1;
 831     }
 832
 833     if (!(k = pa_tokenizer_get(t, 2))) {
 834         pa_strbuf_puts(buf, "You need to specify a source.\n");
 835         return -1;
 836     }
 837
 838     if (!(so = pa_idxset_get_by_index(c->source_outputs, (uint32_t) idx))) {
 839         pa_strbuf_puts(buf, "No source output found with this index.\n");
 840         return -1;
 841     }
 842
 843     if (!(source = pa_namereg_get(c, k, PA_NAMEREG_SOURCE, 1))) {
 844         pa_strbuf_puts(buf, "No source found by this name or index.\n");
 845         return -1;
 846     }
 847
 848     if (pa_source_output_move_to(so, source) < 0) {
 849         pa_strbuf_puts(buf, "Moved failed.\n");
 850         return -1;
 851     }
 852     return 0;
 853 }
 854
 855 static int pa_cli_command_dump(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 856     pa_module *m;
 857     pa_sink *sink;
 858     pa_source *source;
 859     int nl;
 860     const char *p;
 861     uint32_t idx;
 862     char txt[256];
 863     time_t now;
 864     void *i;
 865     pa_autoload_entry *a;
 866
 867     assert(c && t);
 868
 869     time(&now);
 870
 871 #ifdef HAVE_CTIME_R
 872     pa_strbuf_printf(buf, "### Configuration dump generated at %s\n", ctime_r(&now, txt));
 873 #else
 874     pa_strbuf_printf(buf, "### Configuration dump generated at %s\n", ctime(&now));
 875 #endif
 876
 877
 878     for (m = pa_idxset_first(c->modules, &idx); m; m = pa_idxset_next(c->modules, &idx)) {
 879         if (m->auto_unload)
 880             continue;
 881
 882         pa_strbuf_printf(buf, "load-module %s", m->name);
 883
 884         if (m->argument)
 885             pa_strbuf_printf(buf, " %s", m->argument);
 886
 887         pa_strbuf_puts(buf, "\n");
 888     }
 889
 890     nl = 0;
 891
 892     for (sink = pa_idxset_first(c->sinks, &idx); sink; sink = pa_idxset_next(c->sinks, &idx)) {
 893         if (sink->owner && sink->owner->auto_unload)
 894             continue;
 895
 896         if (!nl) {
 897             pa_strbuf_puts(buf, "\n");
 898             nl = 1;
 899         }
 900
 901         pa_strbuf_printf(buf, "set-sink-volume %s 0x%03x\n", sink->name, pa_cvolume_avg(pa_sink_get_volume(sink, PA_MIXER_HARDWARE)));
 902         pa_strbuf_printf(buf, "set-sink-mute %s %d\n", sink->name, pa_sink_get_mute(sink, PA_MIXER_HARDWARE));
 903     }
 904
 905     for (source = pa_idxset_first(c->sources, &idx); source; source = pa_idxset_next(c->sources, &idx)) {
 906         if (source->owner && source->owner->auto_unload)
 907             continue;
 908
 909         if (!nl) {
 910             pa_strbuf_puts(buf, "\n");
 911             nl = 1;
 912         }
 913
 914         pa_strbuf_printf(buf, "set-source-volume %s 0x%03x\n", source->name, pa_cvolume_avg(pa_source_get_volume(source, PA_MIXER_HARDWARE)));
 915         pa_strbuf_printf(buf, "set-source-mute %s %d\n", source->name, pa_source_get_mute(source, PA_MIXER_HARDWARE));
 916     }
 917
 918
 919     if (c->autoload_hashmap) {
 920         nl = 0;
 921
 922         i = NULL;
 923         while ((a = pa_hashmap_iterate(c->autoload_hashmap, &i, NULL))) {
 924
 925             if (!nl) {
 926                 pa_strbuf_puts(buf, "\n");
 927                 nl = 1;
 928             }
 929
 930             pa_strbuf_printf(buf, "add-autoload-%s %s %s", a->type == PA_NAMEREG_SINK ? "sink" : "source", a->name, a->module);
 931
 932             if (a->argument)
 933                 pa_strbuf_printf(buf, " %s", a->argument);
 934
 935             pa_strbuf_puts(buf, "\n");
 936         }
 937     }
 938
 939     nl = 0;
 940
 941     if ((p = pa_namereg_get_default_sink_name(c))) {
 942         if (!nl) {
 943             pa_strbuf_puts(buf, "\n");
 944             nl = 1;
 945         }
 946         pa_strbuf_printf(buf, "set-default-sink %s\n", p);
 947     }
 948
 949     if ((p = pa_namereg_get_default_source_name(c))) {
 950         if (!nl) {
 951             pa_strbuf_puts(buf, "\n");
 952             nl = 1;
 953         }
 954         pa_strbuf_printf(buf, "set-default-source %s\n", p);
 955     }
 956
 957     pa_strbuf_puts(buf, "\n### EOF\n");
 958
 959     return 0;
 960 }
 961
 962 int pa_cli_command_execute_line(pa_core *c, const char *s, pa_strbuf *buf, int *fail) {
 963     const char *cs;
 964
 965     cs = s+strspn(s, whitespace);
 966
 967     if (*cs == '#' || !*cs)
 968         return 0;
 969     else if (*cs == '.') {
 970         if (!strcmp(cs, FAIL_META))
 971             *fail = 1;
 972         else if (!strcmp(cs, NOFAIL_META))
 973             *fail = 0;
 974         else {
 975             size_t l;
 976             l = strcspn(cs, whitespace);
 977
 978             if (l == sizeof(INCLUDE_META)-1 && !strncmp(cs, INCLUDE_META, l)) {
 979                 const char *filename = cs+l+strspn(cs+l, whitespace);
 980
 981                 if (pa_cli_command_execute_file(c, filename, buf, fail) < 0)
 982                     if (*fail) return -1;
 983             } else {
 984                 pa_strbuf_printf(buf, "Invalid meta command: %s\n", cs);
 985                 if (*fail) return -1;
 986             }
 987         }
 988     } else {
 989         const struct command*command;
 990         int unknown = 1;
 991         size_t l;
 992
 993         l = strcspn(cs, whitespace);
 994
 995         for (command = commands; command->name; command++)
 996             if (strlen(command->name) == l && !strncmp(cs, command->name, l)) {
 997                 int ret;
 998                 pa_tokenizer *t = pa_tokenizer_new(cs, command->args);
 999                 assert(t);
1000                 ret = command->proc(c, t, buf, fail);
1001                 pa_tokenizer_free(t);
1002                 unknown = 0;
1003
1004                 if (ret < 0 && *fail)
1005                     return -1;
1006
1007                 break;
1008             }
1009
1010         if (unknown) {
1011             pa_strbuf_printf(buf, "Unknown command: %s\n", cs);
1012             if (*fail)
1013                 return -1;
1014         }
1015     }
1016
1017     return 0;
1018 }
1019
1020 int pa_cli_command_execute_file(pa_core *c, const char *fn, pa_strbuf *buf, int *fail) {
1021     char line[256];
1022     FILE *f = NULL;
1023     int ret = -1;
1024     assert(c && fn && buf);
1025
1026     if (!(f = fopen(fn, "r"))) {
1027         pa_strbuf_printf(buf, "open('%s') failed: %s\n", fn, pa_cstrerror(errno));
1028         if (!*fail)
1029             ret = 0;
1030         goto fail;
1031     }
1032
1033     while (fgets(line, sizeof(line), f)) {
1034         char *e = line + strcspn(line, linebreak);
1035         *e = 0;
1036
1037         if (pa_cli_command_execute_line(c, line, buf, fail) < 0 && *fail)
1038             goto fail;
1039     }
1040
1041     ret = 0;
1042
1043 fail:
1044     if (f)
1045         fclose(f);
1046
1047     return ret;
1048 }
1049
1050 int pa_cli_command_execute(pa_core *c, const char *s, pa_strbuf *buf, int *fail) {
1051     const char *p;
1052     assert(c && s && buf && fail);
1053
1054     p = s;
1055     while (*p) {
1056         size_t l = strcspn(p, linebreak);
1057         char *line = pa_xstrndup(p, l);
1058
1059         if (pa_cli_command_execute_line(c, line, buf, fail) < 0&& *fail) {
1060             pa_xfree(line);
1061             return -1;
1062         }
1063         pa_xfree(line);
1064
1065         p += l;
1066         p += strspn(p, linebreak);
1067     }
1068
1069     return 0;
1070 }