src/utils/pacat.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   PulseAudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as published
   8   by the Free Software Foundation; either version 2 of the License,
   9   or (at your option) any later version.
  10
  11   PulseAudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with PulseAudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <signal.h>
  27 #include <string.h>
  28 #include <errno.h>
  29 #include <unistd.h>
  30 #include <assert.h>
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <getopt.h>
  34 #include <fcntl.h>
  35
  36 #include <pulse/pulseaudio.h>
  37
  38 #define TIME_EVENT_USEC 50000
  39
  40 #if PA_API_VERSION < 9
  41 #error Invalid PulseAudio API version
  42 #endif
  43
  44 static enum { RECORD, PLAYBACK } mode = PLAYBACK;
  45
  46 static pa_context *context = NULL;
  47 static pa_stream *stream = NULL;
  48 static pa_mainloop_api *mainloop_api = NULL;
  49
  50 static void *buffer = NULL;
  51 static size_t buffer_length = 0, buffer_index = 0;
  52
  53 static pa_io_event* stdio_event = NULL;
  54
  55 static char *stream_name = NULL, *client_name = NULL, *device = NULL;
  56
  57 static int verbose = 0;
  58 static pa_volume_t volume = PA_VOLUME_NORM;
  59
  60 static pa_sample_spec sample_spec = {
  61     .format = PA_SAMPLE_S16LE,
  62     .rate = 44100,
  63     .channels = 2
  64 };
  65
  66 static pa_channel_map channel_map;
  67 static int channel_map_set = 0;
  68
  69 /* A shortcut for terminating the application */
  70 static void quit(int ret) {
  71     assert(mainloop_api);
  72     mainloop_api->quit(mainloop_api, ret);
  73 }
  74
  75 /* Write some data to the stream */
  76 static void do_stream_write(size_t length) {
  77     size_t l;
  78     assert(length);
  79
  80     if (!buffer || !buffer_length)
  81         return;
  82
  83     l = length;
  84     if (l > buffer_length)
  85         l = buffer_length;
  86
  87     if (pa_stream_write(stream, (uint8_t*) buffer + buffer_index, l, NULL, 0, PA_SEEK_RELATIVE) < 0) {
  88         fprintf(stderr, "pa_stream_write() failed: %s\n", pa_strerror(pa_context_errno(context)));
  89         quit(1);
  90         return;
  91     }
  92
  93     buffer_length -= l;
  94     buffer_index += l;
  95
  96     if (!buffer_length) {
  97         pa_xfree(buffer);
  98         buffer = NULL;
  99         buffer_index = buffer_length = 0;
 100     }
 101 }
 102
 103 /* This is called whenever new data may be written to the stream */
 104 static void stream_write_callback(pa_stream *s, size_t length, void *userdata) {
 105     assert(s && length);
 106
 107     if (stdio_event)
 108         mainloop_api->io_enable(stdio_event, PA_IO_EVENT_INPUT);
 109
 110     if (!buffer)
 111         return;
 112
 113     do_stream_write(length);
 114 }
 115
 116 /* This is called whenever new data may is available */
 117 static void stream_read_callback(pa_stream *s, size_t length, void *userdata) {
 118     const void *data;
 119     assert(s && length);
 120
 121     if (stdio_event)
 122         mainloop_api->io_enable(stdio_event, PA_IO_EVENT_OUTPUT);
 123
 124     if (pa_stream_peek(s, &data, &length) < 0) {
 125         fprintf(stderr, "pa_stream_peek() failed: %s\n", pa_strerror(pa_context_errno(context)));
 126         quit(1);
 127         return;
 128     }
 129
 130     assert(data && length);
 131
 132     if (buffer) {
 133         fprintf(stderr, "Buffer overrun, dropping incoming data\n");
 134         if (pa_stream_drop(s) < 0) {
 135             fprintf(stderr, "pa_stream_drop() failed: %s\n", pa_strerror(pa_context_errno(context)));
 136             quit(1);
 137         }
 138         return;
 139     }
 140
 141     buffer = pa_xmalloc(buffer_length = length);
 142     memcpy(buffer, data, length);
 143     buffer_index = 0;
 144     pa_stream_drop(s);
 145 }
 146
 147 /* This routine is called whenever the stream state changes */
 148 static void stream_state_callback(pa_stream *s, void *userdata) {
 149     assert(s);
 150
 151     switch (pa_stream_get_state(s)) {
 152         case PA_STREAM_CREATING:
 153         case PA_STREAM_TERMINATED:
 154             break;
 155
 156         case PA_STREAM_READY:
 157             if (verbose) {
 158                 const pa_buffer_attr *a;
 159
 160                 fprintf(stderr, "Stream successfully created.\n");
 161
 162                 if (!(a = pa_stream_get_buffer_attr(s)))
 163                     fprintf(stderr, "pa_stream_get_buffer_attr() failed: %s\n", pa_strerror(pa_context_errno(pa_stream_get_context(s))));
 164                 else {
 165
 166                     if (mode == PLAYBACK)
 167                         fprintf(stderr, "Buffer metrics: maxlength=%u, tlength=%u, prebuf=%u, minreq=%u\n", a->maxlength, a->tlength, a->prebuf, a->minreq);
 168                     else {
 169                         assert(mode == RECORD);
 170                         fprintf(stderr, "Buffer metrics: maxlength=%u, fragsize=%u\n", a->maxlength, a->fragsize);
 171                     }
 172
 173                 }
 174
 175             }
 176
 177             break;
 178
 179         case PA_STREAM_FAILED:
 180         default:
 181             fprintf(stderr, "Stream error: %s\n", pa_strerror(pa_context_errno(pa_stream_get_context(s))));
 182             quit(1);
 183     }
 184 }
 185
 186 /* This is called whenever the context status changes */
 187 static void context_state_callback(pa_context *c, void *userdata) {
 188     assert(c);
 189
 190     switch (pa_context_get_state(c)) {
 191         case PA_CONTEXT_CONNECTING:
 192         case PA_CONTEXT_AUTHORIZING:
 193         case PA_CONTEXT_SETTING_NAME:
 194             break;
 195
 196         case PA_CONTEXT_READY: {
 197             int r;
 198
 199             assert(c && !stream);
 200
 201             if (verbose)
 202                 fprintf(stderr, "Connection established.\n");
 203
 204             if (!(stream = pa_stream_new(c, stream_name, &sample_spec, channel_map_set ? &channel_map : NULL))) {
 205                 fprintf(stderr, "pa_stream_new() failed: %s\n", pa_strerror(pa_context_errno(c)));
 206                 goto fail;
 207             }
 208
 209             pa_stream_set_state_callback(stream, stream_state_callback, NULL);
 210             pa_stream_set_write_callback(stream, stream_write_callback, NULL);
 211             pa_stream_set_read_callback(stream, stream_read_callback, NULL);
 212
 213             if (mode == PLAYBACK) {
 214                 pa_cvolume cv;
 215                 if ((r = pa_stream_connect_playback(stream, device, NULL, 0, pa_cvolume_set(&cv, sample_spec.channels, volume), NULL)) < 0) {
 216                     fprintf(stderr, "pa_stream_connect_playback() failed: %s\n", pa_strerror(pa_context_errno(c)));
 217                     goto fail;
 218                 }
 219
 220             } else {
 221                 if ((r = pa_stream_connect_record(stream, device, NULL, 0)) < 0) {
 222                     fprintf(stderr, "pa_stream_connect_record() failed: %s\n", pa_strerror(pa_context_errno(c)));
 223                     goto fail;
 224                 }
 225             }
 226
 227             break;
 228         }
 229
 230         case PA_CONTEXT_TERMINATED:
 231             quit(0);
 232             break;
 233
 234         case PA_CONTEXT_FAILED:
 235         default:
 236             fprintf(stderr, "Connection failure: %s\n", pa_strerror(pa_context_errno(c)));
 237             goto fail;
 238     }
 239
 240     return;
 241
 242 fail:
 243     quit(1);
 244
 245 }
 246
 247 /* Connection draining complete */
 248 static void context_drain_complete(pa_context*c, void *userdata) {
 249     pa_context_disconnect(c);
 250 }
 251
 252 /* Stream draining complete */
 253 static void stream_drain_complete(pa_stream*s, int success, void *userdata) {
 254     pa_operation *o;
 255
 256     if (!success) {
 257         fprintf(stderr, "Failed to drain stream: %s\n", pa_strerror(pa_context_errno(context)));
 258         quit(1);
 259     }
 260
 261     if (verbose)
 262         fprintf(stderr, "Playback stream drained.\n");
 263
 264     pa_stream_disconnect(stream);
 265     pa_stream_unref(stream);
 266     stream = NULL;
 267
 268     if (!(o = pa_context_drain(context, context_drain_complete, NULL)))
 269         pa_context_disconnect(context);
 270     else {
 271         if (verbose)
 272             fprintf(stderr, "Draining connection to server.\n");
 273     }
 274 }
 275
 276 /* New data on STDIN **/
 277 static void stdin_callback(pa_mainloop_api*a, pa_io_event *e, int fd, pa_io_event_flags_t f, void *userdata) {
 278     size_t l, w = 0;
 279     ssize_t r;
 280     assert(a == mainloop_api && e && stdio_event == e);
 281
 282     if (buffer) {
 283         mainloop_api->io_enable(stdio_event, PA_IO_EVENT_NULL);
 284         return;
 285     }
 286
 287     if (!stream || pa_stream_get_state(stream) != PA_STREAM_READY || !(l = w = pa_stream_writable_size(stream)))
 288         l = 4096;
 289
 290     buffer = pa_xmalloc(l);
 291
 292     if ((r = read(fd, buffer, l)) <= 0) {
 293         if (r == 0) {
 294             if (verbose)
 295                 fprintf(stderr, "Got EOF.\n");
 296
 297             if (stream) {
 298                 pa_operation *o;
 299
 300                 if (!(o = pa_stream_drain(stream, stream_drain_complete, NULL))) {
 301                     fprintf(stderr, "pa_stream_drain(): %s\n", pa_strerror(pa_context_errno(context)));
 302                     quit(1);
 303                     return;
 304                 }
 305
 306                 pa_operation_unref(o);
 307             } else
 308                 quit(0);
 309
 310         } else {
 311             fprintf(stderr, "read() failed: %s\n", strerror(errno));
 312             quit(1);
 313         }
 314
 315         mainloop_api->io_free(stdio_event);
 316         stdio_event = NULL;
 317         return;
 318     }
 319
 320     buffer_length = r;
 321     buffer_index = 0;
 322
 323     if (w)
 324         do_stream_write(w);
 325 }
 326
 327 /* Some data may be written to STDOUT */
 328 static void stdout_callback(pa_mainloop_api*a, pa_io_event *e, int fd, pa_io_event_flags_t f, void *userdata) {
 329     ssize_t r;
 330     assert(a == mainloop_api && e && stdio_event == e);
 331
 332     if (!buffer) {
 333         mainloop_api->io_enable(stdio_event, PA_IO_EVENT_NULL);
 334         return;
 335     }
 336
 337     assert(buffer_length);
 338
 339     if ((r = write(fd, (uint8_t*) buffer+buffer_index, buffer_length)) <= 0) {
 340         fprintf(stderr, "write() failed: %s\n", strerror(errno));
 341         quit(1);
 342
 343         mainloop_api->io_free(stdio_event);
 344         stdio_event = NULL;
 345         return;
 346     }
 347
 348     buffer_length -= r;
 349     buffer_index += r;
 350
 351     if (!buffer_length) {
 352         pa_xfree(buffer);
 353         buffer = NULL;
 354         buffer_length = buffer_index = 0;
 355     }
 356 }
 357
 358 /* UNIX signal to quit recieved */
 359 static void exit_signal_callback(pa_mainloop_api*m, pa_signal_event *e, int sig, void *userdata) {
 360     if (verbose)
 361         fprintf(stderr, "Got signal, exiting.\n");
 362     quit(0);
 363 }
 364
 365 /* Show the current latency */
 366 static void stream_update_timing_callback(pa_stream *s, int success, void *userdata) {
 367     pa_usec_t latency, usec;
 368     int negative = 0;
 369
 370     assert(s);
 371
 372     if (!success ||
 373         pa_stream_get_time(s, &usec) < 0 ||
 374         pa_stream_get_latency(s, &latency, &negative) < 0) {
 375         fprintf(stderr, "Failed to get latency: %s\n", pa_strerror(pa_context_errno(context)));
 376         quit(1);
 377         return;
 378     }
 379
 380     fprintf(stderr, "Time: %0.3f sec; Latency: %0.0f usec.  \r",
 381             (float) usec / 1000000,
 382             (float) latency * (negative?-1:1));
 383 }
 384
 385 /* Someone requested that the latency is shown */
 386 static void sigusr1_signal_callback(pa_mainloop_api*m, pa_signal_event *e, int sig, void *userdata) {
 387
 388     if (!stream)
 389         return;
 390
 391     pa_operation_unref(pa_stream_update_timing_info(stream, stream_update_timing_callback, NULL));
 392 }
 393
 394 static void time_event_callback(pa_mainloop_api*m, pa_time_event *e, const struct timeval *tv, void *userdata) {
 395     struct timeval next;
 396
 397     if (stream && pa_stream_get_state(stream) == PA_STREAM_READY) {
 398         pa_operation *o;
 399         if (!(o = pa_stream_update_timing_info(stream, stream_update_timing_callback, NULL)))
 400             fprintf(stderr, "pa_stream_update_timing_info() failed: %s\n", pa_strerror(pa_context_errno(context)));
 401         else
 402             pa_operation_unref(o);
 403     }
 404
 405     pa_gettimeofday(&next);
 406     pa_timeval_add(&next, TIME_EVENT_USEC);
 407
 408     m->time_restart(e, &next);
 409 }
 410
 411 static void help(const char *argv0) {
 412
 413     printf("%s [options]\n\n"
 414            "  -h, --help                            Show this help\n"
 415            "      --version                         Show version\n\n"
 416            "  -r, --record                          Create a connection for recording\n"
 417            "  -p, --playback                        Create a connection for playback\n\n"
 418            "  -v, --verbose                         Enable verbose operations\n\n"
 419            "  -s, --server=SERVER                   The name of the server to connect to\n"
 420            "  -d, --device=DEVICE                   The name of the sink/source to connect to\n"
 421            "  -n, --client-name=NAME                How to call this client on the server\n"
 422            "      --stream-name=NAME                How to call this stream on the server\n"
 423            "      --volume=VOLUME                   Specify the initial (linear) volume in range 0...65536\n"
 424            "      --rate=SAMPLERATE                 The sample rate in Hz (defaults to 44100)\n"
 425            "      --format=SAMPLEFORMAT             The sample type, one of s16le, s16be, u8, float32le,\n"
 426            "                                        float32be, ulaw, alaw (defaults to s16ne)\n"
 427            "      --channels=CHANNELS               The number of channels, 1 for mono, 2 for stereo\n"
 428            "                                        (defaults to 2)\n"
 429            "      --channel-map=CHANNELMAP          Channel map to use instead of the default\n",
 430            argv0);
 431 }
 432
 433 enum {
 434     ARG_VERSION = 256,
 435     ARG_STREAM_NAME,
 436     ARG_VOLUME,
 437     ARG_SAMPLERATE,
 438     ARG_SAMPLEFORMAT,
 439     ARG_CHANNELS,
 440     ARG_CHANNELMAP,
 441 };
 442
 443 int main(int argc, char *argv[]) {
 444     pa_mainloop* m = NULL;
 445     int ret = 1, r, c;
 446     char *bn, *server = NULL;
 447     pa_time_event *time_event = NULL;
 448
 449     static const struct option long_options[] = {
 450         {"record",      0, NULL, 'r'},
 451         {"playback",    0, NULL, 'p'},
 452         {"device",      1, NULL, 'd'},
 453         {"server",      1, NULL, 's'},
 454         {"client-name", 1, NULL, 'n'},
 455         {"stream-name", 1, NULL, ARG_STREAM_NAME},
 456         {"version",     0, NULL, ARG_VERSION},
 457         {"help",        0, NULL, 'h'},
 458         {"verbose",     0, NULL, 'v'},
 459         {"volume",      1, NULL, ARG_VOLUME},
 460         {"rate",        1, NULL, ARG_SAMPLERATE},
 461         {"format",      1, NULL, ARG_SAMPLEFORMAT},
 462         {"channels",    1, NULL, ARG_CHANNELS},
 463         {"channel-map", 1, NULL, ARG_CHANNELMAP},
 464         {NULL,          0, NULL, 0}
 465     };
 466
 467     if (!(bn = strrchr(argv[0], '/')))
 468         bn = argv[0];
 469     else
 470         bn++;
 471
 472     if (strstr(bn, "rec") || strstr(bn, "mon"))
 473         mode = RECORD;
 474     else if (strstr(bn, "cat") || strstr(bn, "play"))
 475         mode = PLAYBACK;
 476
 477     while ((c = getopt_long(argc, argv, "rpd:s:n:hv", long_options, NULL)) != -1) {
 478
 479         switch (c) {
 480             case 'h' :
 481                 help(bn);
 482                 ret = 0;
 483                 goto quit;
 484
 485             case ARG_VERSION:
 486                 printf("pacat "PACKAGE_VERSION"\nCompiled with libpulse %s\nLinked with libpulse %s\n", pa_get_headers_version(), pa_get_library_version());
 487                 ret = 0;
 488                 goto quit;
 489
 490             case 'r':
 491                 mode = RECORD;
 492                 break;
 493
 494             case 'p':
 495                 mode = PLAYBACK;
 496                 break;
 497
 498             case 'd':
 499                 pa_xfree(device);
 500                 device = pa_xstrdup(optarg);
 501                 break;
 502
 503             case 's':
 504                 pa_xfree(server);
 505                 server = pa_xstrdup(optarg);
 506                 break;
 507
 508             case 'n':
 509                 pa_xfree(client_name);
 510                 client_name = pa_xstrdup(optarg);
 511                 break;
 512
 513             case ARG_STREAM_NAME:
 514                 pa_xfree(stream_name);
 515                 stream_name = pa_xstrdup(optarg);
 516                 break;
 517
 518             case 'v':
 519                 verbose = 1;
 520                 break;
 521
 522             case ARG_VOLUME: {
 523                 int v = atoi(optarg);
 524                 volume = v < 0 ? 0 : v;
 525                 break;
 526             }
 527
 528             case ARG_CHANNELS:
 529                 sample_spec.channels = atoi(optarg);
 530                 break;
 531
 532             case ARG_SAMPLEFORMAT:
 533                 sample_spec.format = pa_parse_sample_format(optarg);
 534                 break;
 535
 536             case ARG_SAMPLERATE:
 537                 sample_spec.rate = atoi(optarg);
 538                 break;
 539
 540             case ARG_CHANNELMAP:
 541                 if (!pa_channel_map_parse(&channel_map, optarg)) {
 542                     fprintf(stderr, "Invalid channel map\n");
 543                     goto quit;
 544                 }
 545
 546                 channel_map_set = 1;
 547                 break;
 548
 549             default:
 550                 goto quit;
 551         }
 552     }
 553
 554     if (!pa_sample_spec_valid(&sample_spec)) {
 555         fprintf(stderr, "Invalid sample specification\n");
 556         goto quit;
 557     }
 558
 559     if (channel_map_set && channel_map.channels != sample_spec.channels) {
 560         fprintf(stderr, "Channel map doesn't match sample specification\n");
 561         goto quit;
 562     }
 563
 564     if (verbose) {
 565         char t[PA_SAMPLE_SPEC_SNPRINT_MAX];
 566         pa_sample_spec_snprint(t, sizeof(t), &sample_spec);
 567         fprintf(stderr, "Opening a %s stream with sample specification '%s'.\n", mode == RECORD ? "recording" : "playback", t);
 568     }
 569
 570     if (!(optind >= argc)) {
 571         if (optind+1 == argc) {
 572             int fd;
 573
 574             if ((fd = open(argv[optind], mode == PLAYBACK ? O_RDONLY : O_WRONLY|O_TRUNC|O_CREAT, 0666)) < 0) {
 575                 fprintf(stderr, "open(): %s\n", strerror(errno));
 576                 goto quit;
 577             }
 578
 579             if (dup2(fd, mode == PLAYBACK ? 0 : 1) < 0) {
 580                 fprintf(stderr, "dup2(): %s\n", strerror(errno));
 581                 goto quit;
 582             }
 583
 584             close(fd);
 585
 586             if (!stream_name)
 587                 stream_name = pa_xstrdup(argv[optind]);
 588
 589         } else {
 590             fprintf(stderr, "Too many arguments.\n");
 591             goto quit;
 592         }
 593     }
 594
 595     if (!client_name)
 596         client_name = pa_xstrdup(bn);
 597
 598     if (!stream_name)
 599         stream_name = pa_xstrdup(client_name);
 600
 601     /* Set up a new main loop */
 602     if (!(m = pa_mainloop_new())) {
 603         fprintf(stderr, "pa_mainloop_new() failed.\n");
 604         goto quit;
 605     }
 606
 607     mainloop_api = pa_mainloop_get_api(m);
 608
 609     r = pa_signal_init(mainloop_api);
 610     assert(r == 0);
 611     pa_signal_new(SIGINT, exit_signal_callback, NULL);
 612     pa_signal_new(SIGTERM, exit_signal_callback, NULL);
 613 #ifdef SIGUSR1
 614     pa_signal_new(SIGUSR1, sigusr1_signal_callback, NULL);
 615 #endif
 616 #ifdef SIGPIPE
 617     signal(SIGPIPE, SIG_IGN);
 618 #endif
 619
 620     if (!(stdio_event = mainloop_api->io_new(mainloop_api,
 621                                              mode == PLAYBACK ? STDIN_FILENO : STDOUT_FILENO,
 622                                              mode == PLAYBACK ? PA_IO_EVENT_INPUT : PA_IO_EVENT_OUTPUT,
 623                                              mode == PLAYBACK ? stdin_callback : stdout_callback, NULL))) {
 624         fprintf(stderr, "io_new() failed.\n");
 625         goto quit;
 626     }
 627
 628     /* Create a new connection context */
 629     if (!(context = pa_context_new(mainloop_api, client_name))) {
 630         fprintf(stderr, "pa_context_new() failed.\n");
 631         goto quit;
 632     }
 633
 634     pa_context_set_state_callback(context, context_state_callback, NULL);
 635
 636     /* Connect the context */
 637     pa_context_connect(context, server, 0, NULL);
 638
 639     if (verbose) {
 640         struct timeval tv;
 641
 642         pa_gettimeofday(&tv);
 643         pa_timeval_add(&tv, TIME_EVENT_USEC);
 644
 645         if (!(time_event = mainloop_api->time_new(mainloop_api, &tv, time_event_callback, NULL))) {
 646             fprintf(stderr, "time_new() failed.\n");
 647             goto quit;
 648         }
 649     }
 650
 651     /* Run the main loop */
 652     if (pa_mainloop_run(m, &ret) < 0) {
 653         fprintf(stderr, "pa_mainloop_run() failed.\n");
 654         goto quit;
 655     }
 656
 657 quit:
 658     if (stream)
 659         pa_stream_unref(stream);
 660
 661     if (context)
 662         pa_context_unref(context);
 663
 664     if (stdio_event) {
 665         assert(mainloop_api);
 666         mainloop_api->io_free(stdio_event);
 667     }
 668
 669     if (time_event) {
 670         assert(mainloop_api);
 671         mainloop_api->time_free(time_event);
 672     }
 673
 674     if (m) {
 675         pa_signal_done();
 676         pa_mainloop_free(m);
 677     }
 678
 679     pa_xfree(buffer);
 680
 681     pa_xfree(server);
 682     pa_xfree(device);
 683     pa_xfree(client_name);
 684     pa_xfree(stream_name);
 685
 686     return ret;
 687 }