2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
37 #include <pulse/pulseaudio.h>
39 #define TIME_EVENT_USEC 50000
41 #if PA_API_VERSION < 10
42 #error Invalid PulseAudio API version
45 #define CLEAR_LINE "\x1B[K"
47 static enum { RECORD, PLAYBACK } mode = PLAYBACK;
49 static pa_context *context = NULL;
50 static pa_stream *stream = NULL;
51 static pa_mainloop_api *mainloop_api = NULL;
53 static void *buffer = NULL;
54 static size_t buffer_length = 0, buffer_index = 0;
56 static pa_io_event* stdio_event = NULL;
58 static char *stream_name = NULL, *client_name = NULL, *device = NULL;
60 static int verbose = 0;
61 static pa_volume_t volume = PA_VOLUME_NORM;
63 static pa_sample_spec sample_spec = {
64 .format = PA_SAMPLE_S16LE,
69 static pa_channel_map channel_map;
70 static int channel_map_set = 0;
72 static pa_stream_flags_t flags = 0;
74 static size_t latency = 0, process_time=0;
76 /* A shortcut for terminating the application */
77 static void quit(int ret) {
79 mainloop_api->quit(mainloop_api, ret);
82 /* Write some data to the stream */
83 static void do_stream_write(size_t length) {
87 if (!buffer || !buffer_length)
91 if (l > buffer_length)
94 if (pa_stream_write(stream, (uint8_t*) buffer + buffer_index, l, NULL, 0, PA_SEEK_RELATIVE) < 0) {
95 fprintf(stderr, "pa_stream_write() failed: %s\n", pa_strerror(pa_context_errno(context)));
103 if (!buffer_length) {
106 buffer_index = buffer_length = 0;
110 /* This is called whenever new data may be written to the stream */
111 static void stream_write_callback(pa_stream *s, size_t length, void *userdata) {
116 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_INPUT);
121 do_stream_write(length);
124 /* This is called whenever new data may is available */
125 static void stream_read_callback(pa_stream *s, size_t length, void *userdata) {
131 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_OUTPUT);
133 if (pa_stream_peek(s, &data, &length) < 0) {
134 fprintf(stderr, "pa_stream_peek() failed: %s\n", pa_strerror(pa_context_errno(context)));
143 fprintf(stderr, "Buffer overrun, dropping incoming data\n");
144 if (pa_stream_drop(s) < 0) {
145 fprintf(stderr, "pa_stream_drop() failed: %s\n", pa_strerror(pa_context_errno(context)));
151 buffer = pa_xmalloc(buffer_length = length);
152 memcpy(buffer, data, length);
157 /* This routine is called whenever the stream state changes */
158 static void stream_state_callback(pa_stream *s, void *userdata) {
161 switch (pa_stream_get_state(s)) {
162 case PA_STREAM_CREATING:
163 case PA_STREAM_TERMINATED:
166 case PA_STREAM_READY:
168 const pa_buffer_attr *a;
169 char cmt[PA_CHANNEL_MAP_SNPRINT_MAX], sst[PA_SAMPLE_SPEC_SNPRINT_MAX];
171 fprintf(stderr, "Stream successfully created.\n");
173 if (!(a = pa_stream_get_buffer_attr(s)))
174 fprintf(stderr, "pa_stream_get_buffer_attr() failed: %s\n", pa_strerror(pa_context_errno(pa_stream_get_context(s))));
177 if (mode == PLAYBACK)
178 fprintf(stderr, "Buffer metrics: maxlength=%u, tlength=%u, prebuf=%u, minreq=%u\n", a->maxlength, a->tlength, a->prebuf, a->minreq);
180 assert(mode == RECORD);
181 fprintf(stderr, "Buffer metrics: maxlength=%u, fragsize=%u\n", a->maxlength, a->fragsize);
185 fprintf(stderr, "Using sample spec '%s', channel map '%s'.\n",
186 pa_sample_spec_snprint(sst, sizeof(sst), pa_stream_get_sample_spec(s)),
187 pa_channel_map_snprint(cmt, sizeof(cmt), pa_stream_get_channel_map(s)));
189 fprintf(stderr, "Connected to device %s (%u, %ssuspended).\n",
190 pa_stream_get_device_name(s),
191 pa_stream_get_device_index(s),
192 pa_stream_is_suspended(s) ? "" : "not ");
197 case PA_STREAM_FAILED:
199 fprintf(stderr, "Stream error: %s\n", pa_strerror(pa_context_errno(pa_stream_get_context(s))));
204 static void stream_suspended_callback(pa_stream *s, void *userdata) {
208 if (pa_stream_is_suspended(s))
209 fprintf(stderr, "Stream device suspended." CLEAR_LINE " \n");
211 fprintf(stderr, "Stream device resumed." CLEAR_LINE " \n");
215 static void stream_underflow_callback(pa_stream *s, void *userdata) {
219 fprintf(stderr, "Stream underrun." CLEAR_LINE " \n");
222 static void stream_overflow_callback(pa_stream *s, void *userdata) {
226 fprintf(stderr, "Stream overrun." CLEAR_LINE " \n");
229 static void stream_started_callback(pa_stream *s, void *userdata) {
233 fprintf(stderr, "Stream started." CLEAR_LINE " \n");
236 static void stream_moved_callback(pa_stream *s, void *userdata) {
240 fprintf(stderr, "Stream moved to device %s (%u, %ssuspended)." CLEAR_LINE " \n", pa_stream_get_device_name(s), pa_stream_get_device_index(s), pa_stream_is_suspended(s) ? "" : "not ");
243 /* This is called whenever the context status changes */
244 static void context_state_callback(pa_context *c, void *userdata) {
247 switch (pa_context_get_state(c)) {
248 case PA_CONTEXT_CONNECTING:
249 case PA_CONTEXT_AUTHORIZING:
250 case PA_CONTEXT_SETTING_NAME:
253 case PA_CONTEXT_READY: {
255 pa_buffer_attr buffer_attr;
261 fprintf(stderr, "Connection established." CLEAR_LINE " \n");
263 if (!(stream = pa_stream_new(c, stream_name, &sample_spec, channel_map_set ? &channel_map : NULL))) {
264 fprintf(stderr, "pa_stream_new() failed: %s\n", pa_strerror(pa_context_errno(c)));
268 pa_stream_set_state_callback(stream, stream_state_callback, NULL);
269 pa_stream_set_write_callback(stream, stream_write_callback, NULL);
270 pa_stream_set_read_callback(stream, stream_read_callback, NULL);
271 pa_stream_set_suspended_callback(stream, stream_suspended_callback, NULL);
272 pa_stream_set_moved_callback(stream, stream_moved_callback, NULL);
273 pa_stream_set_underflow_callback(stream, stream_underflow_callback, NULL);
274 pa_stream_set_overflow_callback(stream, stream_overflow_callback, NULL);
275 pa_stream_set_started_callback(stream, stream_started_callback, NULL);
278 memset(&buffer_attr, 0, sizeof(buffer_attr));
279 buffer_attr.tlength = latency;
280 buffer_attr.minreq = process_time;
281 flags |= PA_STREAM_ADJUST_LATENCY;
284 if (mode == PLAYBACK) {
286 if ((r = pa_stream_connect_playback(stream, device, latency > 0 ? &buffer_attr : NULL, flags, pa_cvolume_set(&cv, sample_spec.channels, volume), NULL)) < 0) {
287 fprintf(stderr, "pa_stream_connect_playback() failed: %s\n", pa_strerror(pa_context_errno(c)));
292 if ((r = pa_stream_connect_record(stream, device, latency > 0 ? &buffer_attr : NULL, flags)) < 0) {
293 fprintf(stderr, "pa_stream_connect_record() failed: %s\n", pa_strerror(pa_context_errno(c)));
301 case PA_CONTEXT_TERMINATED:
305 case PA_CONTEXT_FAILED:
307 fprintf(stderr, "Connection failure: %s\n", pa_strerror(pa_context_errno(c)));
318 /* Connection draining complete */
319 static void context_drain_complete(pa_context*c, void *userdata) {
320 pa_context_disconnect(c);
323 /* Stream draining complete */
324 static void stream_drain_complete(pa_stream*s, int success, void *userdata) {
328 fprintf(stderr, "Failed to drain stream: %s\n", pa_strerror(pa_context_errno(context)));
333 fprintf(stderr, "Playback stream drained.\n");
335 pa_stream_disconnect(stream);
336 pa_stream_unref(stream);
339 if (!(o = pa_context_drain(context, context_drain_complete, NULL)))
340 pa_context_disconnect(context);
343 fprintf(stderr, "Draining connection to server.\n");
347 /* New data on STDIN **/
348 static void stdin_callback(pa_mainloop_api*a, pa_io_event *e, int fd, pa_io_event_flags_t f, void *userdata) {
352 assert(a == mainloop_api);
354 assert(stdio_event == e);
357 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_NULL);
361 if (!stream || pa_stream_get_state(stream) != PA_STREAM_READY || !(l = w = pa_stream_writable_size(stream)))
364 buffer = pa_xmalloc(l);
366 if ((r = read(fd, buffer, l)) <= 0) {
369 fprintf(stderr, "Got EOF.\n");
374 if (!(o = pa_stream_drain(stream, stream_drain_complete, NULL))) {
375 fprintf(stderr, "pa_stream_drain(): %s\n", pa_strerror(pa_context_errno(context)));
380 pa_operation_unref(o);
385 fprintf(stderr, "read() failed: %s\n", strerror(errno));
389 mainloop_api->io_free(stdio_event);
401 /* Some data may be written to STDOUT */
402 static void stdout_callback(pa_mainloop_api*a, pa_io_event *e, int fd, pa_io_event_flags_t f, void *userdata) {
405 assert(a == mainloop_api);
407 assert(stdio_event == e);
410 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_NULL);
414 assert(buffer_length);
416 if ((r = write(fd, (uint8_t*) buffer+buffer_index, buffer_length)) <= 0) {
417 fprintf(stderr, "write() failed: %s\n", strerror(errno));
420 mainloop_api->io_free(stdio_event);
428 if (!buffer_length) {
431 buffer_length = buffer_index = 0;
435 /* UNIX signal to quit recieved */
436 static void exit_signal_callback(pa_mainloop_api*m, pa_signal_event *e, int sig, void *userdata) {
438 fprintf(stderr, "Got signal, exiting.\n");
442 /* Show the current latency */
443 static void stream_update_timing_callback(pa_stream *s, int success, void *userdata) {
450 pa_stream_get_time(s, &usec) < 0 ||
451 pa_stream_get_latency(s, &l, &negative) < 0) {
452 fprintf(stderr, "Failed to get latency: %s\n", pa_strerror(pa_context_errno(context)));
457 fprintf(stderr, "Time: %0.3f sec; Latency: %0.0f usec. \r",
458 (float) usec / 1000000,
459 (float) l * (negative?-1:1));
462 /* Someone requested that the latency is shown */
463 static void sigusr1_signal_callback(pa_mainloop_api*m, pa_signal_event *e, int sig, void *userdata) {
468 pa_operation_unref(pa_stream_update_timing_info(stream, stream_update_timing_callback, NULL));
471 static void time_event_callback(pa_mainloop_api*m, pa_time_event *e, const struct timeval *tv, void *userdata) {
474 if (stream && pa_stream_get_state(stream) == PA_STREAM_READY) {
476 if (!(o = pa_stream_update_timing_info(stream, stream_update_timing_callback, NULL)))
477 fprintf(stderr, "pa_stream_update_timing_info() failed: %s\n", pa_strerror(pa_context_errno(context)));
479 pa_operation_unref(o);
482 pa_gettimeofday(&next);
483 pa_timeval_add(&next, TIME_EVENT_USEC);
485 m->time_restart(e, &next);
488 static void help(const char *argv0) {
490 printf("%s [options]\n\n"
491 " -h, --help Show this help\n"
492 " --version Show version\n\n"
493 " -r, --record Create a connection for recording\n"
494 " -p, --playback Create a connection for playback\n\n"
495 " -v, --verbose Enable verbose operations\n\n"
496 " -s, --server=SERVER The name of the server to connect to\n"
497 " -d, --device=DEVICE The name of the sink/source to connect to\n"
498 " -n, --client-name=NAME How to call this client on the server\n"
499 " --stream-name=NAME How to call this stream on the server\n"
500 " --volume=VOLUME Specify the initial (linear) volume in range 0...65536\n"
501 " --rate=SAMPLERATE The sample rate in Hz (defaults to 44100)\n"
502 " --format=SAMPLEFORMAT The sample type, one of s16le, s16be, u8, float32le,\n"
503 " float32be, ulaw, alaw (defaults to s16ne)\n"
504 " --channels=CHANNELS The number of channels, 1 for mono, 2 for stereo\n"
506 " --channel-map=CHANNELMAP Channel map to use instead of the default\n"
507 " --fix-format Take the sample format from the sink the stream is\n"
508 " being connected to.\n"
509 " --fix-rate Take the sampling rate from the sink the stream is\n"
510 " being connected to.\n"
511 " --fix-channels Take the number of channels and the channel map\n"
512 " from the sink the stream is being connected to.\n"
513 " --no-remix Don't upmix or downmix channels.\n"
514 " --no-remap Map channels by index instead of name.\n"
515 " --latency=BYTES Request the specified latency in bytes.\n"
516 " --process-time=BYTES Request the specified process time per request in bytes.\n"
538 int main(int argc, char *argv[]) {
539 pa_mainloop* m = NULL;
541 char *bn, *server = NULL;
542 pa_time_event *time_event = NULL;
544 static const struct option long_options[] = {
545 {"record", 0, NULL, 'r'},
546 {"playback", 0, NULL, 'p'},
547 {"device", 1, NULL, 'd'},
548 {"server", 1, NULL, 's'},
549 {"client-name", 1, NULL, 'n'},
550 {"stream-name", 1, NULL, ARG_STREAM_NAME},
551 {"version", 0, NULL, ARG_VERSION},
552 {"help", 0, NULL, 'h'},
553 {"verbose", 0, NULL, 'v'},
554 {"volume", 1, NULL, ARG_VOLUME},
555 {"rate", 1, NULL, ARG_SAMPLERATE},
556 {"format", 1, NULL, ARG_SAMPLEFORMAT},
557 {"channels", 1, NULL, ARG_CHANNELS},
558 {"channel-map", 1, NULL, ARG_CHANNELMAP},
559 {"fix-format", 0, NULL, ARG_FIX_FORMAT},
560 {"fix-rate", 0, NULL, ARG_FIX_RATE},
561 {"fix-channels", 0, NULL, ARG_FIX_CHANNELS},
562 {"no-remap", 0, NULL, ARG_NO_REMAP},
563 {"no-remix", 0, NULL, ARG_NO_REMIX},
564 {"latency", 1, NULL, ARG_LATENCY},
565 {"process-time", 1, NULL, ARG_PROCESS_TIME},
569 if (!(bn = strrchr(argv[0], '/')))
574 if (strstr(bn, "rec") || strstr(bn, "mon"))
576 else if (strstr(bn, "cat") || strstr(bn, "play"))
579 while ((c = getopt_long(argc, argv, "rpd:s:n:hv", long_options, NULL)) != -1) {
588 printf("pacat "PACKAGE_VERSION"\nCompiled with libpulse %s\nLinked with libpulse %s\n", pa_get_headers_version(), pa_get_library_version());
602 device = pa_xstrdup(optarg);
607 server = pa_xstrdup(optarg);
611 pa_xfree(client_name);
612 client_name = pa_xstrdup(optarg);
615 case ARG_STREAM_NAME:
616 pa_xfree(stream_name);
617 stream_name = pa_xstrdup(optarg);
625 int v = atoi(optarg);
626 volume = v < 0 ? 0 : v;
631 sample_spec.channels = atoi(optarg);
634 case ARG_SAMPLEFORMAT:
635 sample_spec.format = pa_parse_sample_format(optarg);
639 sample_spec.rate = atoi(optarg);
643 if (!pa_channel_map_parse(&channel_map, optarg)) {
644 fprintf(stderr, "Invalid channel map '%s'\n", optarg);
651 case ARG_FIX_CHANNELS:
652 flags |= PA_STREAM_FIX_CHANNELS;
656 flags |= PA_STREAM_FIX_RATE;
660 flags |= PA_STREAM_FIX_FORMAT;
664 flags |= PA_STREAM_NO_REMIX_CHANNELS;
668 flags |= PA_STREAM_NO_REMAP_CHANNELS;
672 if (((latency = atoi(optarg))) <= 0) {
673 fprintf(stderr, "Invalid latency specification '%s'\n", optarg);
678 case ARG_PROCESS_TIME:
679 if (((process_time = atoi(optarg))) <= 0) {
680 fprintf(stderr, "Invalid process time specification '%s'\n", optarg);
690 if (!pa_sample_spec_valid(&sample_spec)) {
691 fprintf(stderr, "Invalid sample specification\n");
695 if (channel_map_set && channel_map.channels != sample_spec.channels) {
696 fprintf(stderr, "Channel map doesn't match sample specification\n");
701 char t[PA_SAMPLE_SPEC_SNPRINT_MAX];
702 pa_sample_spec_snprint(t, sizeof(t), &sample_spec);
703 fprintf(stderr, "Opening a %s stream with sample specification '%s'.\n", mode == RECORD ? "recording" : "playback", t);
706 if (!(optind >= argc)) {
707 if (optind+1 == argc) {
710 if ((fd = open(argv[optind], mode == PLAYBACK ? O_RDONLY : O_WRONLY|O_TRUNC|O_CREAT, 0666)) < 0) {
711 fprintf(stderr, "open(): %s\n", strerror(errno));
715 if (dup2(fd, mode == PLAYBACK ? 0 : 1) < 0) {
716 fprintf(stderr, "dup2(): %s\n", strerror(errno));
723 stream_name = pa_xstrdup(argv[optind]);
726 fprintf(stderr, "Too many arguments.\n");
732 client_name = pa_xstrdup(bn);
735 stream_name = pa_xstrdup(client_name);
737 /* Set up a new main loop */
738 if (!(m = pa_mainloop_new())) {
739 fprintf(stderr, "pa_mainloop_new() failed.\n");
743 mainloop_api = pa_mainloop_get_api(m);
745 r = pa_signal_init(mainloop_api);
747 pa_signal_new(SIGINT, exit_signal_callback, NULL);
748 pa_signal_new(SIGTERM, exit_signal_callback, NULL);
750 pa_signal_new(SIGUSR1, sigusr1_signal_callback, NULL);
753 signal(SIGPIPE, SIG_IGN);
756 if (!(stdio_event = mainloop_api->io_new(mainloop_api,
757 mode == PLAYBACK ? STDIN_FILENO : STDOUT_FILENO,
758 mode == PLAYBACK ? PA_IO_EVENT_INPUT : PA_IO_EVENT_OUTPUT,
759 mode == PLAYBACK ? stdin_callback : stdout_callback, NULL))) {
760 fprintf(stderr, "io_new() failed.\n");
764 /* Create a new connection context */
765 if (!(context = pa_context_new(mainloop_api, client_name))) {
766 fprintf(stderr, "pa_context_new() failed.\n");
770 pa_context_set_state_callback(context, context_state_callback, NULL);
772 /* Connect the context */
773 pa_context_connect(context, server, 0, NULL);
778 pa_gettimeofday(&tv);
779 pa_timeval_add(&tv, TIME_EVENT_USEC);
781 if (!(time_event = mainloop_api->time_new(mainloop_api, &tv, time_event_callback, NULL))) {
782 fprintf(stderr, "time_new() failed.\n");
787 /* Run the main loop */
788 if (pa_mainloop_run(m, &ret) < 0) {
789 fprintf(stderr, "pa_mainloop_run() failed.\n");
795 pa_stream_unref(stream);
798 pa_context_unref(context);
801 assert(mainloop_api);
802 mainloop_api->io_free(stdio_event);
806 assert(mainloop_api);
807 mainloop_api->time_free(time_event);
819 pa_xfree(client_name);
820 pa_xfree(stream_name);