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