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

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of polypaudio.
   5
   6   polypaudio 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.
  10
  11   polypaudio 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.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with polypaudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <string.h>
  28 #include <assert.h>
  29 #include <stdlib.h>
  30 #include <errno.h>
  31
  32 #include <polyp/error.h>
  33 #include <polyp/xmalloc.h>
  34
  35 #include <polypcore/module.h>
  36 #include <polypcore/sink.h>
  37 #include <polypcore/source.h>
  38 #include <polypcore/client.h>
  39 #include <polypcore/sink-input.h>
  40 #include <polypcore/source-output.h>
  41 #include <polypcore/tokenizer.h>
  42 #include <polypcore/strbuf.h>
  43 #include <polypcore/namereg.h>
  44 #include <polypcore/cli-text.h>
  45 #include <polypcore/core-scache.h>
  46 #include <polypcore/sample-util.h>
  47 #include <polypcore/sound-file.h>
  48 #include <polypcore/play-memchunk.h>
  49 #include <polypcore/autoload.h>
  50 #include <polypcore/sound-file-stream.h>
  51 #include <polypcore/props.h>
  52 #include <polypcore/core-util.h>
  53
  54 #include "cli-command.h"
  55
  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;
  61 };
  62
  63 #define INCLUDE_META ".include"
  64 #define FAIL_META ".fail"
  65 #define NOFAIL_META ".nofail"
  66
  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
 102
 103 /* A method table for all available commands */
 104
 105 static const struct command commands[] = {
 106     { "exit",                    pa_cli_command_exit,               "Terminate the daemon",         1 },
 107     { "help",                    pa_cli_command_help,               "Show this help",               1 },
 108     { "list-modules",            pa_cli_command_modules,            "List loaded modules",          1 },
 109     { "list-sinks",              pa_cli_command_sinks,              "List loaded sinks",            1 },
 110     { "list-sources",            pa_cli_command_sources,            "List loaded sources",          1 },
 111     { "list-clients",            pa_cli_command_clients,            "List loaded clients",          1 },
 112     { "list-sink-inputs",        pa_cli_command_sink_inputs,        "List sink inputs",             1 },
 113     { "list-source-outputs",     pa_cli_command_source_outputs,     "List source outputs",          1 },
 114     { "stat",                    pa_cli_command_stat,               "Show memory block statistics", 1 },
 115     { "info",                    pa_cli_command_info,               "Show comprehensive status",    1 },
 116     { "ls",                      pa_cli_command_info,               NULL,                           1 },
 117     { "list",                    pa_cli_command_info,               NULL,                           1 },
 118     { "load-module",             pa_cli_command_load,               "Load a module (args: name, arguments)",                     3},
 119     { "unload-module",           pa_cli_command_unload,             "Unload a module (args: index)",                             2},
 120     { "set-sink-volume",         pa_cli_command_sink_volume,        "Set the volume of a sink (args: index|name, volume)",             3},
 121     { "set-sink-input-volume",   pa_cli_command_sink_input_volume,  "Set the volume of a sink input (args: index|name, volume)", 3},
 122     { "set-source-volume",       pa_cli_command_source_volume,      "Set the volume of a source (args: index|name, volume)", 3},
 123     { "set-sink-mute",           pa_cli_command_sink_mute,          "Set the mute switch of a sink (args: index|name, mute)", 3},
 124     { "set-source-mute",         pa_cli_command_source_mute,        "Set the mute switch of a source (args: index|name, mute)", 3},
 125     { "set-default-sink",        pa_cli_command_sink_default,       "Set the default sink (args: index|name)", 2},
 126     { "set-default-source",      pa_cli_command_source_default,     "Set the default source (args: index|name)", 2},
 127     { "kill-client",             pa_cli_command_kill_client,        "Kill a client (args: index)", 2},
 128     { "kill-sink-input",         pa_cli_command_kill_sink_input,    "Kill a sink input (args: index)", 2},
 129     { "kill-source-output",      pa_cli_command_kill_source_output, "Kill a source output (args: index)", 2},
 130     { "list-samples",            pa_cli_command_scache_list,        "List all entries in the sample cache", 1},
 131     { "play-sample",             pa_cli_command_scache_play,        "Play a sample from the sample cache (args: name, sink|index)", 3},
 132     { "remove-sample",           pa_cli_command_scache_remove,      "Remove a sample from the sample cache (args: name)", 2},
 133     { "load-sample",             pa_cli_command_scache_load,        "Load a sound file into the sample cache (args: name, filename)", 3},
 134     { "load-sample-lazy",        pa_cli_command_scache_load,        "Lazily load a sound file into the sample cache (args: name, filename)", 3},
 135     { "load-sample-dir-lazy",    pa_cli_command_scache_load_dir,    "Lazily load all files in a directory into the sample cache (args: pathname)", 2},
 136     { "play-file",               pa_cli_command_play_file,          "Play a sound file (args: filename, sink|index)", 3},
 137     { "list-autoload",           pa_cli_command_autoload_list,      "List autoload entries", 1},
 138     { "add-autoload-sink",       pa_cli_command_autoload_add,       "Add autoload entry for a sink (args: sink, module name, arguments)", 4},
 139     { "add-autoload-source",     pa_cli_command_autoload_add,       "Add autoload entry for a source (args: source, module name, arguments)", 4},
 140     { "remove-autoload-sink",    pa_cli_command_autoload_remove,    "Remove autoload entry for a sink (args: name)", 2},
 141     { "remove-autoload-source",  pa_cli_command_autoload_remove,    "Remove autoload entry for a source (args: name)", 2},
 142     { "dump",                    pa_cli_command_dump,               "Dump daemon configuration", 1},
 143     { "list-props",              pa_cli_command_list_props,         NULL, 1},
 144     { NULL, NULL, NULL, 0 }
 145 };
 146
 147 static const char whitespace[] = " \t\n\r";
 148 static const char linebreak[] = "\n\r";
 149
 150 static uint32_t parse_index(const char *n) {
 151     uint32_t idx;
 152
 153     if (pa_atou(n, &idx) < 0)
 154         return (uint32_t) PA_IDXSET_INVALID;
 155
 156     return idx;
 157 }
 158
 159 static int pa_cli_command_exit(pa_core *c, pa_tokenizer *t, PA_GCC_UNUSED pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 160     assert(c && c->mainloop && t);
 161     c->mainloop->quit(c->mainloop, 0);
 162     return 0;
 163 }
 164
 165 static int pa_cli_command_help(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 166     const struct command*command;
 167     assert(c && t && buf);
 168
 169     pa_strbuf_puts(buf, "Available commands:\n");
 170
 171     for (command = commands; command->name; command++)
 172         if (command->help)
 173             pa_strbuf_printf(buf, "    %-25s %s\n", command->name, command->help);
 174     return 0;
 175 }
 176
 177 static int pa_cli_command_modules(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 178     char *s;
 179     assert(c && t);
 180     s = pa_module_list_to_string(c);
 181     assert(s);
 182     pa_strbuf_puts(buf, s);
 183     pa_xfree(s);
 184     return 0;
 185 }
 186
 187 static int pa_cli_command_clients(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 188     char *s;
 189     assert(c && t);
 190     s = pa_client_list_to_string(c);
 191     assert(s);
 192     pa_strbuf_puts(buf, s);
 193     pa_xfree(s);
 194     return 0;
 195 }
 196
 197 static int pa_cli_command_sinks(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 198     char *s;
 199     assert(c && t);
 200     s = pa_sink_list_to_string(c);
 201     assert(s);
 202     pa_strbuf_puts(buf, s);
 203     pa_xfree(s);
 204     return 0;
 205 }
 206
 207 static int pa_cli_command_sources(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 208     char *s;
 209     assert(c && t);
 210     s = pa_source_list_to_string(c);
 211     assert(s);
 212     pa_strbuf_puts(buf, s);
 213     pa_xfree(s);
 214     return 0;
 215 }
 216
 217 static int pa_cli_command_sink_inputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 218     char *s;
 219     assert(c && t);
 220     s = pa_sink_input_list_to_string(c);
 221     assert(s);
 222     pa_strbuf_puts(buf, s);
 223     pa_xfree(s);
 224     return 0;
 225 }
 226
 227 static int pa_cli_command_source_outputs(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 228     char *s;
 229     assert(c && t);
 230     s = pa_source_output_list_to_string(c);
 231     assert(s);
 232     pa_strbuf_puts(buf, s);
 233     pa_xfree(s);
 234     return 0;
 235 }
 236
 237 static int pa_cli_command_stat(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 238     char s[256];
 239     assert(c && t);
 240
 241     pa_bytes_snprint(s, sizeof(s), c->memblock_stat->total_size);
 242     pa_strbuf_printf(buf, "Memory blocks currently allocated: %u, size: %s.\n",
 243                      c->memblock_stat->total,
 244                      s);
 245
 246     pa_bytes_snprint(s, sizeof(s), c->memblock_stat->allocated_size);
 247     pa_strbuf_printf(buf, "Memory blocks allocated during the whole lifetime: %u, size: %s.\n",
 248                      c->memblock_stat->allocated,
 249                      s);
 250
 251     pa_bytes_snprint(s, sizeof(s), pa_scache_total_size(c));
 252     pa_strbuf_printf(buf, "Total sample cache size: %s.\n", s);
 253
 254     pa_sample_spec_snprint(s, sizeof(s), &c->default_sample_spec);
 255     pa_strbuf_printf(buf, "Default sample spec: %s\n", s);
 256
 257     pa_strbuf_printf(buf, "Default sink name: %s\n"
 258                      "Default source name: %s\n",
 259                      pa_namereg_get_default_sink_name(c),
 260                      pa_namereg_get_default_source_name(c));
 261
 262     return 0;
 263 }
 264
 265 static int pa_cli_command_info(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 266     assert(c && t);
 267     pa_cli_command_stat(c, t, buf, fail);
 268     pa_cli_command_modules(c, t, buf, fail);
 269     pa_cli_command_sinks(c, t, buf, fail);
 270     pa_cli_command_sources(c, t, buf, fail);
 271     pa_cli_command_clients(c, t, buf, fail);
 272     pa_cli_command_sink_inputs(c, t, buf, fail);
 273     pa_cli_command_source_outputs(c, t, buf, fail);
 274     pa_cli_command_scache_list(c, t, buf, fail);
 275     pa_cli_command_autoload_list(c, t, buf, fail);
 276     return 0;
 277 }
 278
 279 static int pa_cli_command_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 280     pa_module *m;
 281     const char *name;
 282     assert(c && t);
 283
 284     if (!(name = pa_tokenizer_get(t, 1))) {
 285         pa_strbuf_puts(buf, "You need to specify the module name and optionally arguments.\n");
 286         return -1;
 287     }
 288
 289     if (!(m = pa_module_load(c, name,  pa_tokenizer_get(t, 2)))) {
 290         pa_strbuf_puts(buf, "Module load failed.\n");
 291         return -1;
 292     }
 293
 294     return 0;
 295 }
 296
 297 static int pa_cli_command_unload(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 298     pa_module *m;
 299     uint32_t idx;
 300     const char *i;
 301     char *e;
 302     assert(c && t);
 303
 304     if (!(i = pa_tokenizer_get(t, 1))) {
 305         pa_strbuf_puts(buf, "You need to specify the module index.\n");
 306         return -1;
 307     }
 308
 309     idx = (uint32_t) strtoul(i, &e, 10);
 310     if (*e || !(m = pa_idxset_get_by_index(c->modules, idx))) {
 311         pa_strbuf_puts(buf, "Invalid module index.\n");
 312         return -1;
 313     }
 314
 315     pa_module_unload_request(m);
 316     return 0;
 317 }
 318
 319 static int pa_cli_command_sink_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 320     const char *n, *v;
 321     pa_sink *sink;
 322     uint32_t volume;
 323     pa_cvolume cvolume;
 324
 325     if (!(n = pa_tokenizer_get(t, 1))) {
 326         pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
 327         return -1;
 328     }
 329
 330     if (!(v = pa_tokenizer_get(t, 2))) {
 331         pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
 332         return -1;
 333     }
 334
 335     if (pa_atou(v, &volume) < 0) {
 336         pa_strbuf_puts(buf, "Failed to parse volume.\n");
 337         return -1;
 338     }
 339
 340     if (!(sink = pa_namereg_get(c, n, PA_NAMEREG_SINK, 1))) {
 341         pa_strbuf_puts(buf, "No sink found by this name or index.\n");
 342         return -1;
 343     }
 344
 345     pa_cvolume_set(&cvolume, sink->sample_spec.channels, volume);
 346     pa_sink_set_volume(sink, PA_MIXER_HARDWARE, &cvolume);
 347     return 0;
 348 }
 349
 350 static int pa_cli_command_sink_input_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 351     const char *n, *v;
 352     pa_sink_input *si;
 353     pa_volume_t volume;
 354     pa_cvolume cvolume;
 355     uint32_t idx;
 356
 357     if (!(n = pa_tokenizer_get(t, 1))) {
 358         pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
 359         return -1;
 360     }
 361
 362     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 363         pa_strbuf_puts(buf, "Failed to parse index.\n");
 364         return -1;
 365     }
 366
 367     if (!(v = pa_tokenizer_get(t, 2))) {
 368         pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
 369         return -1;
 370     }
 371
 372     if (pa_atou(v, &volume) < 0) {
 373         pa_strbuf_puts(buf, "Failed to parse volume.\n");
 374         return -1;
 375     }
 376
 377     if (!(si = pa_idxset_get_by_index(c->sink_inputs, (uint32_t) idx))) {
 378         pa_strbuf_puts(buf, "No sink input found with this index.\n");
 379         return -1;
 380     }
 381
 382     pa_cvolume_set(&cvolume, si->sample_spec.channels, volume);
 383     pa_sink_input_set_volume(si, &cvolume);
 384     return 0;
 385 }
 386
 387 static int pa_cli_command_source_volume(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 388     const char *n, *v;
 389     pa_source *source;
 390     uint32_t volume;
 391     pa_cvolume cvolume;
 392
 393     if (!(n = pa_tokenizer_get(t, 1))) {
 394         pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
 395         return -1;
 396     }
 397
 398     if (!(v = pa_tokenizer_get(t, 2))) {
 399         pa_strbuf_puts(buf, "You need to specify a volume >= 0. (0 is muted, 0x100 is normal volume)\n");
 400         return -1;
 401     }
 402
 403     if (pa_atou(v, &volume) < 0) {
 404         pa_strbuf_puts(buf, "Failed to parse volume.\n");
 405         return -1;
 406     }
 407
 408     if (!(source = pa_namereg_get(c, n, PA_NAMEREG_SOURCE, 1))) {
 409         pa_strbuf_puts(buf, "No source found by this name or index.\n");
 410         return -1;
 411     }
 412
 413     pa_cvolume_set(&cvolume, source->sample_spec.channels, volume);
 414     pa_source_set_volume(source, PA_MIXER_HARDWARE, &cvolume);
 415     return 0;
 416 }
 417
 418 static int pa_cli_command_sink_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 419     const char *n, *m;
 420     pa_sink *sink;
 421     int mute;
 422
 423     if (!(n = pa_tokenizer_get(t, 1))) {
 424         pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
 425         return -1;
 426     }
 427
 428     if (!(m = pa_tokenizer_get(t, 2))) {
 429         pa_strbuf_puts(buf, "You need to specify a mute switch setting (0/1).\n");
 430         return -1;
 431     }
 432
 433     if (pa_atoi(m, &mute) < 0) {
 434         pa_strbuf_puts(buf, "Failed to parse mute switch.\n");
 435         return -1;
 436     }
 437
 438     if (!(sink = pa_namereg_get(c, n, PA_NAMEREG_SINK, 1))) {
 439         pa_strbuf_puts(buf, "No sink found by this name or index.\n");
 440         return -1;
 441     }
 442
 443     pa_sink_set_mute(sink, PA_MIXER_HARDWARE, mute);
 444     return 0;
 445 }
 446
 447 static int pa_cli_command_source_mute(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 448     const char *n, *m;
 449     pa_source *source;
 450     int mute;
 451
 452     if (!(n = pa_tokenizer_get(t, 1))) {
 453         pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
 454         return -1;
 455     }
 456
 457     if (!(m = pa_tokenizer_get(t, 2))) {
 458         pa_strbuf_puts(buf, "You need to specify a mute switch setting (0/1).\n");
 459         return -1;
 460     }
 461
 462     if (pa_atoi(m, &mute) < 0) {
 463         pa_strbuf_puts(buf, "Failed to parse mute switch.\n");
 464         return -1;
 465     }
 466
 467     if (!(source = pa_namereg_get(c, n, PA_NAMEREG_SOURCE, 1))) {
 468         pa_strbuf_puts(buf, "No sink found by this name or index.\n");
 469         return -1;
 470     }
 471
 472     pa_source_set_mute(source, PA_MIXER_HARDWARE, mute);
 473     return 0;
 474 }
 475
 476 static int pa_cli_command_sink_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 477     const char *n;
 478     assert(c && t);
 479
 480     if (!(n = pa_tokenizer_get(t, 1))) {
 481         pa_strbuf_puts(buf, "You need to specify a sink either by its name or its index.\n");
 482         return -1;
 483     }
 484
 485     pa_namereg_set_default(c, n, PA_NAMEREG_SINK);
 486     return 0;
 487 }
 488
 489 static int pa_cli_command_source_default(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 490     const char *n;
 491     assert(c && t);
 492
 493     if (!(n = pa_tokenizer_get(t, 1))) {
 494         pa_strbuf_puts(buf, "You need to specify a source either by its name or its index.\n");
 495         return -1;
 496     }
 497
 498     pa_namereg_set_default(c, n, PA_NAMEREG_SOURCE);
 499     return 0;
 500 }
 501
 502 static int pa_cli_command_kill_client(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 503     const char *n;
 504     pa_client *client;
 505     uint32_t idx;
 506     assert(c && t);
 507
 508     if (!(n = pa_tokenizer_get(t, 1))) {
 509         pa_strbuf_puts(buf, "You need to specify a client by its index.\n");
 510         return -1;
 511     }
 512
 513     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 514         pa_strbuf_puts(buf, "Failed to parse index.\n");
 515         return -1;
 516     }
 517
 518     if (!(client = pa_idxset_get_by_index(c->clients, idx))) {
 519         pa_strbuf_puts(buf, "No client found by this index.\n");
 520         return -1;
 521     }
 522
 523     pa_client_kill(client);
 524     return 0;
 525 }
 526
 527 static int pa_cli_command_kill_sink_input(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 528     const char *n;
 529     pa_sink_input *sink_input;
 530     uint32_t idx;
 531     assert(c && t);
 532
 533     if (!(n = pa_tokenizer_get(t, 1))) {
 534         pa_strbuf_puts(buf, "You need to specify a sink input by its index.\n");
 535         return -1;
 536     }
 537
 538     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 539         pa_strbuf_puts(buf, "Failed to parse index.\n");
 540         return -1;
 541     }
 542
 543     if (!(sink_input = pa_idxset_get_by_index(c->sink_inputs, idx))) {
 544         pa_strbuf_puts(buf, "No sink input found by this index.\n");
 545         return -1;
 546     }
 547
 548     pa_sink_input_kill(sink_input);
 549     return 0;
 550 }
 551
 552 static int pa_cli_command_kill_source_output(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 553     const char *n;
 554     pa_source_output *source_output;
 555     uint32_t idx;
 556     assert(c && t);
 557
 558     if (!(n = pa_tokenizer_get(t, 1))) {
 559         pa_strbuf_puts(buf, "You need to specify a source output by its index.\n");
 560         return -1;
 561     }
 562
 563     if ((idx = parse_index(n)) == PA_IDXSET_INVALID) {
 564         pa_strbuf_puts(buf, "Failed to parse index.\n");
 565         return -1;
 566     }
 567
 568     if (!(source_output = pa_idxset_get_by_index(c->source_outputs, idx))) {
 569         pa_strbuf_puts(buf, "No source output found by this index.\n");
 570         return -1;
 571     }
 572
 573     pa_source_output_kill(source_output);
 574     return 0;
 575 }
 576
 577 static int pa_cli_command_scache_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 578     char *s;
 579     assert(c && t);
 580     s = pa_scache_list_to_string(c);
 581     assert(s);
 582     pa_strbuf_puts(buf, s);
 583     pa_xfree(s);
 584     return 0;
 585 }
 586
 587 static int pa_cli_command_scache_play(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 588     const char *n, *sink_name;
 589     pa_sink *sink;
 590     assert(c && t && buf && fail);
 591
 592     if (!(n = pa_tokenizer_get(t, 1)) || !(sink_name = pa_tokenizer_get(t, 2))) {
 593         pa_strbuf_puts(buf, "You need to specify a sample name and a sink name.\n");
 594         return -1;
 595     }
 596
 597     if (!(sink = pa_namereg_get(c, sink_name, PA_NAMEREG_SINK, 1))) {
 598         pa_strbuf_puts(buf, "No sink by that name.\n");
 599         return -1;
 600     }
 601
 602     if (pa_scache_play_item(c, n, sink, PA_VOLUME_NORM) < 0) {
 603         pa_strbuf_puts(buf, "Failed to play sample.\n");
 604         return -1;
 605     }
 606
 607     return 0;
 608 }
 609
 610 static int pa_cli_command_scache_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 611     const char *n;
 612     assert(c && t && buf && fail);
 613
 614     if (!(n = pa_tokenizer_get(t, 1))) {
 615         pa_strbuf_puts(buf, "You need to specify a sample name.\n");
 616         return -1;
 617     }
 618
 619     if (pa_scache_remove_item(c, n) < 0) {
 620         pa_strbuf_puts(buf, "Failed to remove sample.\n");
 621         return -1;
 622     }
 623
 624     return 0;
 625 }
 626
 627 static int pa_cli_command_scache_load(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 628     const char *fname, *n;
 629     int r;
 630     assert(c && t && buf && fail);
 631
 632     if (!(fname = pa_tokenizer_get(t, 2)) || !(n = pa_tokenizer_get(t, 1))) {
 633         pa_strbuf_puts(buf, "You need to specify a file name and a sample name.\n");
 634         return -1;
 635     }
 636
 637     if (strstr(pa_tokenizer_get(t, 0), "lazy"))
 638         r = pa_scache_add_file_lazy(c, n, fname, NULL);
 639     else
 640         r = pa_scache_add_file(c, n, fname, NULL);
 641
 642     if (r < 0)
 643         pa_strbuf_puts(buf, "Failed to load sound file.\n");
 644
 645     return 0;
 646 }
 647
 648 static int pa_cli_command_scache_load_dir(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 649     const char *pname;
 650     assert(c && t && buf && fail);
 651
 652     if (!(pname = pa_tokenizer_get(t, 1))) {
 653         pa_strbuf_puts(buf, "You need to specify a path name.\n");
 654         return -1;
 655     }
 656
 657     if (pa_scache_add_directory_lazy(c, pname) < 0) {
 658         pa_strbuf_puts(buf, "Failed to load directory.\n");
 659         return -1;
 660     }
 661
 662     return 0;
 663 }
 664
 665 static int pa_cli_command_play_file(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 666     const char *fname, *sink_name;
 667     pa_sink *sink;
 668     assert(c && t && buf && fail);
 669
 670     if (!(fname = pa_tokenizer_get(t, 1)) || !(sink_name = pa_tokenizer_get(t, 2))) {
 671         pa_strbuf_puts(buf, "You need to specify a file name and a sink name.\n");
 672         return -1;
 673     }
 674
 675     if (!(sink = pa_namereg_get(c, sink_name, PA_NAMEREG_SINK, 1))) {
 676         pa_strbuf_puts(buf, "No sink by that name.\n");
 677         return -1;
 678     }
 679
 680
 681     return pa_play_file(sink, fname, NULL);
 682 }
 683
 684 static int pa_cli_command_autoload_add(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 685     const char *a, *b;
 686     assert(c && t && buf && fail);
 687
 688     if (!(a = pa_tokenizer_get(t, 1)) || !(b = pa_tokenizer_get(t, 2))) {
 689         pa_strbuf_puts(buf, "You need to specify a device name, a filename or a module name and optionally module arguments\n");
 690         return -1;
 691     }
 692
 693     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);
 694
 695     return 0;
 696 }
 697
 698 static int pa_cli_command_autoload_remove(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, int *fail) {
 699     const char *name;
 700     assert(c && t && buf && fail);
 701
 702     if (!(name = pa_tokenizer_get(t, 1))) {
 703         pa_strbuf_puts(buf, "You need to specify a device name\n");
 704         return -1;
 705     }
 706
 707     if (pa_autoload_remove_by_name(c, name, strstr(pa_tokenizer_get(t, 0), "sink") ? PA_NAMEREG_SINK : PA_NAMEREG_SOURCE) < 0) {
 708         pa_strbuf_puts(buf, "Failed to remove autload entry\n");
 709         return -1;
 710     }
 711
 712     return 0;
 713 }
 714
 715 static int pa_cli_command_autoload_list(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 716     char *s;
 717     assert(c && t);
 718     s = pa_autoload_list_to_string(c);
 719     assert(s);
 720     pa_strbuf_puts(buf, s);
 721     pa_xfree(s);
 722     return 0;
 723 }
 724
 725 static int pa_cli_command_list_props(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 726     assert(c && t);
 727     pa_property_dump(c, buf);
 728     return 0;
 729 }
 730
 731 static int pa_cli_command_dump(pa_core *c, pa_tokenizer *t, pa_strbuf *buf, PA_GCC_UNUSED int *fail) {
 732     pa_module *m;
 733     pa_sink *sink;
 734     pa_source *source;
 735     int nl;
 736     const char *p;
 737     uint32_t idx;
 738     char txt[256];
 739     time_t now;
 740     void *i;
 741     pa_autoload_entry *a;
 742
 743     assert(c && t);
 744
 745     time(&now);
 746
 747 #ifdef HAVE_CTIME_R
 748     pa_strbuf_printf(buf, "### Configuration dump generated at %s\n", ctime_r(&now, txt));
 749 #else
 750     pa_strbuf_printf(buf, "### Configuration dump generated at %s\n", ctime(&now));
 751 #endif
 752
 753
 754     for (m = pa_idxset_first(c->modules, &idx); m; m = pa_idxset_next(c->modules, &idx)) {
 755         if (m->auto_unload)
 756             continue;
 757
 758         pa_strbuf_printf(buf, "load-module %s", m->name);
 759
 760         if (m->argument)
 761             pa_strbuf_printf(buf, " %s", m->argument);
 762
 763         pa_strbuf_puts(buf, "\n");
 764     }
 765
 766     nl = 0;
 767
 768     for (sink = pa_idxset_first(c->sinks, &idx); sink; sink = pa_idxset_next(c->sinks, &idx)) {
 769         if (sink->owner && sink->owner->auto_unload)
 770             continue;
 771
 772         if (!nl) {
 773             pa_strbuf_puts(buf, "\n");
 774             nl = 1;
 775         }
 776
 777         pa_strbuf_printf(buf, "set-sink-volume %s 0x%03x\n", sink->name, pa_cvolume_avg(pa_sink_get_volume(sink, PA_MIXER_HARDWARE)));
 778         pa_strbuf_printf(buf, "set-sink-mute %s %d\n", sink->name, pa_sink_get_mute(sink, PA_MIXER_HARDWARE));
 779     }
 780
 781     for (source = pa_idxset_first(c->sources, &idx); source; source = pa_idxset_next(c->sources, &idx)) {
 782         if (source->owner && source->owner->auto_unload)
 783             continue;
 784
 785         if (!nl) {
 786             pa_strbuf_puts(buf, "\n");
 787             nl = 1;
 788         }
 789
 790         pa_strbuf_printf(buf, "set-source-volume %s 0x%03x\n", source->name, pa_cvolume_avg(pa_source_get_volume(source, PA_MIXER_HARDWARE)));
 791         pa_strbuf_printf(buf, "set-source-mute %s %d\n", source->name, pa_source_get_mute(source, PA_MIXER_HARDWARE));
 792     }
 793
 794
 795     if (c->autoload_hashmap) {
 796         nl = 0;
 797
 798         i = NULL;
 799         while ((a = pa_hashmap_iterate(c->autoload_hashmap, &i, NULL))) {
 800
 801             if (!nl) {
 802                 pa_strbuf_puts(buf, "\n");
 803                 nl = 1;
 804             }
 805
 806             pa_strbuf_printf(buf, "add-autoload-%s %s %s", a->type == PA_NAMEREG_SINK ? "sink" : "source", a->name, a->module);
 807
 808             if (a->argument)
 809                 pa_strbuf_printf(buf, " %s", a->argument);
 810
 811             pa_strbuf_puts(buf, "\n");
 812         }
 813     }
 814
 815     nl = 0;
 816
 817     if ((p = pa_namereg_get_default_sink_name(c))) {
 818         if (!nl) {
 819             pa_strbuf_puts(buf, "\n");
 820             nl = 1;
 821         }
 822         pa_strbuf_printf(buf, "set-default-sink %s\n", p);
 823     }
 824
 825     if ((p = pa_namereg_get_default_source_name(c))) {
 826         if (!nl) {
 827             pa_strbuf_puts(buf, "\n");
 828             nl = 1;
 829         }
 830         pa_strbuf_printf(buf, "set-default-source %s\n", p);
 831     }
 832
 833     pa_strbuf_puts(buf, "\n### EOF\n");
 834
 835     return 0;
 836 }
 837
 838
 839 int pa_cli_command_execute_line(pa_core *c, const char *s, pa_strbuf *buf, int *fail) {
 840     const char *cs;
 841
 842     cs = s+strspn(s, whitespace);
 843
 844     if (*cs == '#' || !*cs)
 845         return 0;
 846     else if (*cs == '.') {
 847         if (!strcmp(cs, FAIL_META))
 848             *fail = 1;
 849         else if (!strcmp(cs, NOFAIL_META))
 850             *fail = 0;
 851         else {
 852             size_t l;
 853             l = strcspn(cs, whitespace);
 854
 855             if (l == sizeof(INCLUDE_META)-1 && !strncmp(cs, INCLUDE_META, l)) {
 856                 const char *filename = cs+l+strspn(cs+l, whitespace);
 857
 858                 if (pa_cli_command_execute_file(c, filename, buf, fail) < 0)
 859                     if (*fail) return -1;
 860             } else {
 861                 pa_strbuf_printf(buf, "Invalid meta command: %s\n", cs);
 862                 if (*fail) return -1;
 863             }
 864         }
 865     } else {
 866         const struct command*command;
 867         int unknown = 1;
 868         size_t l;
 869
 870         l = strcspn(cs, whitespace);
 871
 872         for (command = commands; command->name; command++)
 873             if (strlen(command->name) == l && !strncmp(cs, command->name, l)) {
 874                 int ret;
 875                 pa_tokenizer *t = pa_tokenizer_new(cs, command->args);
 876                 assert(t);
 877                 ret = command->proc(c, t, buf, fail);
 878                 pa_tokenizer_free(t);
 879                 unknown = 0;
 880
 881                 if (ret < 0 && *fail)
 882                     return -1;
 883
 884                 break;
 885             }
 886
 887         if (unknown) {
 888             pa_strbuf_printf(buf, "Unknown command: %s\n", cs);
 889             if (*fail)
 890                 return -1;
 891         }
 892     }
 893
 894     return 0;
 895 }
 896
 897 int pa_cli_command_execute_file(pa_core *c, const char *fn, pa_strbuf *buf, int *fail) {
 898     char line[256];
 899     FILE *f = NULL;
 900     int ret = -1;
 901     assert(c && fn && buf);
 902
 903     if (!(f = fopen(fn, "r"))) {
 904         pa_strbuf_printf(buf, "open('%s') failed: %s\n", fn, pa_cstrerror(errno));
 905         if (!*fail)
 906             ret = 0;
 907         goto fail;
 908     }
 909
 910     while (fgets(line, sizeof(line), f)) {
 911         char *e = line + strcspn(line, linebreak);
 912         *e = 0;
 913
 914         if (pa_cli_command_execute_line(c, line, buf, fail) < 0 && *fail)
 915             goto fail;
 916     }
 917
 918     ret = 0;
 919
 920 fail:
 921     if (f)
 922         fclose(f);
 923
 924     return ret;
 925 }
 926
 927 int pa_cli_command_execute(pa_core *c, const char *s, pa_strbuf *buf, int *fail) {
 928     const char *p;
 929     assert(c && s && buf && fail);
 930
 931     p = s;
 932     while (*p) {
 933         size_t l = strcspn(p, linebreak);
 934         char *line = pa_xstrndup(p, l);
 935
 936         if (pa_cli_command_execute_line(c, line, buf, fail) < 0&& *fail) {
 937             pa_xfree(line);
 938             return -1;
 939         }
 940         pa_xfree(line);
 941
 942         p += l;
 943         p += strspn(p, linebreak);
 944     }
 945
 946     return 0;
 947 }