4 This file is part of PulseAudio.
6 Copyright 2004-2006 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
39 #include <pulse/pulseaudio.h>
41 #define TIME_EVENT_USEC 50000
43 #if PA_API_VERSION < 10
44 #error Invalid PulseAudio API version
47 #define CLEAR_LINE "\x1B[K"
49 static enum { RECORD, PLAYBACK } mode = PLAYBACK;
51 static pa_context *context = NULL;
52 static pa_stream *stream = NULL;
53 static pa_mainloop_api *mainloop_api = NULL;
55 static void *buffer = NULL;
56 static size_t buffer_length = 0, buffer_index = 0;
58 static pa_io_event* stdio_event = NULL;
60 static char *stream_name = NULL, *client_name = NULL, *device = NULL;
62 static int verbose = 0;
63 static pa_volume_t volume = PA_VOLUME_NORM;
65 static pa_sample_spec sample_spec = {
66 .format = PA_SAMPLE_S16LE,
71 static pa_channel_map channel_map;
72 static int channel_map_set = 0;
74 static pa_stream_flags_t flags = 0;
76 static size_t latency = 0, process_time=0;
78 /* A shortcut for terminating the application */
79 static void quit(int ret) {
81 mainloop_api->quit(mainloop_api, ret);
84 /* Write some data to the stream */
85 static void do_stream_write(size_t length) {
89 if (!buffer || !buffer_length)
93 if (l > buffer_length)
96 if (pa_stream_write(stream, (uint8_t*) buffer + buffer_index, l, NULL, 0, PA_SEEK_RELATIVE) < 0) {
97 fprintf(stderr, "pa_stream_write() failed: %s\n", pa_strerror(pa_context_errno(context)));
105 if (!buffer_length) {
108 buffer_index = buffer_length = 0;
112 /* This is called whenever new data may be written to the stream */
113 static void stream_write_callback(pa_stream *s, size_t length, void *userdata) {
118 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_INPUT);
123 do_stream_write(length);
126 /* This is called whenever new data may is available */
127 static void stream_read_callback(pa_stream *s, size_t length, void *userdata) {
133 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_OUTPUT);
135 if (pa_stream_peek(s, &data, &length) < 0) {
136 fprintf(stderr, "pa_stream_peek() failed: %s\n", pa_strerror(pa_context_errno(context)));
145 fprintf(stderr, "Buffer overrun, dropping incoming data\n");
146 if (pa_stream_drop(s) < 0) {
147 fprintf(stderr, "pa_stream_drop() failed: %s\n", pa_strerror(pa_context_errno(context)));
153 buffer = pa_xmalloc(buffer_length = length);
154 memcpy(buffer, data, length);
159 /* This routine is called whenever the stream state changes */
160 static void stream_state_callback(pa_stream *s, void *userdata) {
163 switch (pa_stream_get_state(s)) {
164 case PA_STREAM_CREATING:
165 case PA_STREAM_TERMINATED:
168 case PA_STREAM_READY:
170 const pa_buffer_attr *a;
171 char cmt[PA_CHANNEL_MAP_SNPRINT_MAX], sst[PA_SAMPLE_SPEC_SNPRINT_MAX];
173 fprintf(stderr, "Stream successfully created.\n");
175 if (!(a = pa_stream_get_buffer_attr(s)))
176 fprintf(stderr, "pa_stream_get_buffer_attr() failed: %s\n", pa_strerror(pa_context_errno(pa_stream_get_context(s))));
179 if (mode == PLAYBACK)
180 fprintf(stderr, "Buffer metrics: maxlength=%u, tlength=%u, prebuf=%u, minreq=%u\n", a->maxlength, a->tlength, a->prebuf, a->minreq);
182 assert(mode == RECORD);
183 fprintf(stderr, "Buffer metrics: maxlength=%u, fragsize=%u\n", a->maxlength, a->fragsize);
187 fprintf(stderr, "Using sample spec '%s', channel map '%s'.\n",
188 pa_sample_spec_snprint(sst, sizeof(sst), pa_stream_get_sample_spec(s)),
189 pa_channel_map_snprint(cmt, sizeof(cmt), pa_stream_get_channel_map(s)));
191 fprintf(stderr, "Connected to device %s (%u, %ssuspended).\n",
192 pa_stream_get_device_name(s),
193 pa_stream_get_device_index(s),
194 pa_stream_is_suspended(s) ? "" : "not ");
199 case PA_STREAM_FAILED:
201 fprintf(stderr, "Stream error: %s\n", pa_strerror(pa_context_errno(pa_stream_get_context(s))));
206 static void stream_suspended_callback(pa_stream *s, void *userdata) {
210 if (pa_stream_is_suspended(s))
211 fprintf(stderr, "Stream device suspended." CLEAR_LINE " \n");
213 fprintf(stderr, "Stream device resumed." CLEAR_LINE " \n");
217 static void stream_underflow_callback(pa_stream *s, void *userdata) {
221 fprintf(stderr, "Stream underrun." CLEAR_LINE " \n");
224 static void stream_overflow_callback(pa_stream *s, void *userdata) {
228 fprintf(stderr, "Stream overrun." CLEAR_LINE " \n");
231 static void stream_started_callback(pa_stream *s, void *userdata) {
235 fprintf(stderr, "Stream started." CLEAR_LINE " \n");
238 static void stream_moved_callback(pa_stream *s, void *userdata) {
242 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 ");
245 /* This is called whenever the context status changes */
246 static void context_state_callback(pa_context *c, void *userdata) {
249 switch (pa_context_get_state(c)) {
250 case PA_CONTEXT_CONNECTING:
251 case PA_CONTEXT_AUTHORIZING:
252 case PA_CONTEXT_SETTING_NAME:
255 case PA_CONTEXT_READY: {
257 pa_buffer_attr buffer_attr;
263 fprintf(stderr, "Connection established." CLEAR_LINE " \n");
265 if (!(stream = pa_stream_new(c, stream_name, &sample_spec, channel_map_set ? &channel_map : NULL))) {
266 fprintf(stderr, "pa_stream_new() failed: %s\n", pa_strerror(pa_context_errno(c)));
270 pa_stream_set_state_callback(stream, stream_state_callback, NULL);
271 pa_stream_set_write_callback(stream, stream_write_callback, NULL);
272 pa_stream_set_read_callback(stream, stream_read_callback, NULL);
273 pa_stream_set_suspended_callback(stream, stream_suspended_callback, NULL);
274 pa_stream_set_moved_callback(stream, stream_moved_callback, NULL);
275 pa_stream_set_underflow_callback(stream, stream_underflow_callback, NULL);
276 pa_stream_set_overflow_callback(stream, stream_overflow_callback, NULL);
277 pa_stream_set_started_callback(stream, stream_started_callback, NULL);
280 memset(&buffer_attr, 0, sizeof(buffer_attr));
281 buffer_attr.tlength = latency;
282 buffer_attr.minreq = process_time;
283 flags |= PA_STREAM_ADJUST_LATENCY;
286 if (mode == PLAYBACK) {
288 if ((r = pa_stream_connect_playback(stream, device, latency > 0 ? &buffer_attr : NULL, flags, pa_cvolume_set(&cv, sample_spec.channels, volume), NULL)) < 0) {
289 fprintf(stderr, "pa_stream_connect_playback() failed: %s\n", pa_strerror(pa_context_errno(c)));
294 if ((r = pa_stream_connect_record(stream, device, latency > 0 ? &buffer_attr : NULL, flags)) < 0) {
295 fprintf(stderr, "pa_stream_connect_record() failed: %s\n", pa_strerror(pa_context_errno(c)));
303 case PA_CONTEXT_TERMINATED:
307 case PA_CONTEXT_FAILED:
309 fprintf(stderr, "Connection failure: %s\n", pa_strerror(pa_context_errno(c)));
320 /* Connection draining complete */
321 static void context_drain_complete(pa_context*c, void *userdata) {
322 pa_context_disconnect(c);
325 /* Stream draining complete */
326 static void stream_drain_complete(pa_stream*s, int success, void *userdata) {
330 fprintf(stderr, "Failed to drain stream: %s\n", pa_strerror(pa_context_errno(context)));
335 fprintf(stderr, "Playback stream drained.\n");
337 pa_stream_disconnect(stream);
338 pa_stream_unref(stream);
341 if (!(o = pa_context_drain(context, context_drain_complete, NULL)))
342 pa_context_disconnect(context);
345 fprintf(stderr, "Draining connection to server.\n");
349 /* New data on STDIN **/
350 static void stdin_callback(pa_mainloop_api*a, pa_io_event *e, int fd, pa_io_event_flags_t f, void *userdata) {
354 assert(a == mainloop_api);
356 assert(stdio_event == e);
359 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_NULL);
363 if (!stream || pa_stream_get_state(stream) != PA_STREAM_READY || !(l = w = pa_stream_writable_size(stream)))
366 buffer = pa_xmalloc(l);
368 if ((r = read(fd, buffer, l)) <= 0) {
371 fprintf(stderr, "Got EOF.\n");
376 if (!(o = pa_stream_drain(stream, stream_drain_complete, NULL))) {
377 fprintf(stderr, "pa_stream_drain(): %s\n", pa_strerror(pa_context_errno(context)));
382 pa_operation_unref(o);
387 fprintf(stderr, "read() failed: %s\n", strerror(errno));
391 mainloop_api->io_free(stdio_event);
403 /* Some data may be written to STDOUT */
404 static void stdout_callback(pa_mainloop_api*a, pa_io_event *e, int fd, pa_io_event_flags_t f, void *userdata) {
407 assert(a == mainloop_api);
409 assert(stdio_event == e);
412 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_NULL);
416 assert(buffer_length);
418 if ((r = write(fd, (uint8_t*) buffer+buffer_index, buffer_length)) <= 0) {
419 fprintf(stderr, "write() failed: %s\n", strerror(errno));
422 mainloop_api->io_free(stdio_event);
430 if (!buffer_length) {
433 buffer_length = buffer_index = 0;
437 /* UNIX signal to quit recieved */
438 static void exit_signal_callback(pa_mainloop_api*m, pa_signal_event *e, int sig, void *userdata) {
440 fprintf(stderr, "Got signal, exiting.\n");
444 /* Show the current latency */
445 static void stream_update_timing_callback(pa_stream *s, int success, void *userdata) {
452 pa_stream_get_time(s, &usec) < 0 ||
453 pa_stream_get_latency(s, &l, &negative) < 0) {
454 fprintf(stderr, "Failed to get latency: %s\n", pa_strerror(pa_context_errno(context)));
459 fprintf(stderr, "Time: %0.3f sec; Latency: %0.0f usec. \r",
460 (float) usec / 1000000,
461 (float) l * (negative?-1:1));
464 /* Someone requested that the latency is shown */
465 static void sigusr1_signal_callback(pa_mainloop_api*m, pa_signal_event *e, int sig, void *userdata) {
470 pa_operation_unref(pa_stream_update_timing_info(stream, stream_update_timing_callback, NULL));
473 static void time_event_callback(pa_mainloop_api*m, pa_time_event *e, const struct timeval *tv, void *userdata) {
476 if (stream && pa_stream_get_state(stream) == PA_STREAM_READY) {
478 if (!(o = pa_stream_update_timing_info(stream, stream_update_timing_callback, NULL)))
479 fprintf(stderr, "pa_stream_update_timing_info() failed: %s\n", pa_strerror(pa_context_errno(context)));
481 pa_operation_unref(o);
484 pa_gettimeofday(&next);
485 pa_timeval_add(&next, TIME_EVENT_USEC);
487 m->time_restart(e, &next);
490 static void help(const char *argv0) {
492 printf("%s [options]\n\n"
493 " -h, --help Show this help\n"
494 " --version Show version\n\n"
495 " -r, --record Create a connection for recording\n"
496 " -p, --playback Create a connection for playback\n\n"
497 " -v, --verbose Enable verbose operations\n\n"
498 " -s, --server=SERVER The name of the server to connect to\n"
499 " -d, --device=DEVICE The name of the sink/source to connect to\n"
500 " -n, --client-name=NAME How to call this client on the server\n"
501 " --stream-name=NAME How to call this stream on the server\n"
502 " --volume=VOLUME Specify the initial (linear) volume in range 0...65536\n"
503 " --rate=SAMPLERATE The sample rate in Hz (defaults to 44100)\n"
504 " --format=SAMPLEFORMAT The sample type, one of s16le, s16be, u8, float32le,\n"
505 " float32be, ulaw, alaw (defaults to s16ne)\n"
506 " --channels=CHANNELS The number of channels, 1 for mono, 2 for stereo\n"
508 " --channel-map=CHANNELMAP Channel map to use instead of the default\n"
509 " --fix-format Take the sample format from the sink the stream is\n"
510 " being connected to.\n"
511 " --fix-rate Take the sampling rate from the sink the stream is\n"
512 " being connected to.\n"
513 " --fix-channels Take the number of channels and the channel map\n"
514 " from the sink the stream is being connected to.\n"
515 " --no-remix Don't upmix or downmix channels.\n"
516 " --no-remap Map channels by index instead of name.\n"
517 " --latency=BYTES Request the specified latency in bytes.\n"
518 " --process-time=BYTES Request the specified process time per request in bytes.\n"
540 int main(int argc, char *argv[]) {
541 pa_mainloop* m = NULL;
543 char *bn, *server = NULL;
544 pa_time_event *time_event = NULL;
546 static const struct option long_options[] = {
547 {"record", 0, NULL, 'r'},
548 {"playback", 0, NULL, 'p'},
549 {"device", 1, NULL, 'd'},
550 {"server", 1, NULL, 's'},
551 {"client-name", 1, NULL, 'n'},
552 {"stream-name", 1, NULL, ARG_STREAM_NAME},
553 {"version", 0, NULL, ARG_VERSION},
554 {"help", 0, NULL, 'h'},
555 {"verbose", 0, NULL, 'v'},
556 {"volume", 1, NULL, ARG_VOLUME},
557 {"rate", 1, NULL, ARG_SAMPLERATE},
558 {"format", 1, NULL, ARG_SAMPLEFORMAT},
559 {"channels", 1, NULL, ARG_CHANNELS},
560 {"channel-map", 1, NULL, ARG_CHANNELMAP},
561 {"fix-format", 0, NULL, ARG_FIX_FORMAT},
562 {"fix-rate", 0, NULL, ARG_FIX_RATE},
563 {"fix-channels", 0, NULL, ARG_FIX_CHANNELS},
564 {"no-remap", 0, NULL, ARG_NO_REMAP},
565 {"no-remix", 0, NULL, ARG_NO_REMIX},
566 {"latency", 1, NULL, ARG_LATENCY},
567 {"process-time", 1, NULL, ARG_PROCESS_TIME},
571 if (!(bn = strrchr(argv[0], '/')))
576 if (strstr(bn, "rec") || strstr(bn, "mon"))
578 else if (strstr(bn, "cat") || strstr(bn, "play"))
581 while ((c = getopt_long(argc, argv, "rpd:s:n:hv", long_options, NULL)) != -1) {
590 printf("pacat "PACKAGE_VERSION"\nCompiled with libpulse %s\nLinked with libpulse %s\n", pa_get_headers_version(), pa_get_library_version());
604 device = pa_xstrdup(optarg);
609 server = pa_xstrdup(optarg);
613 pa_xfree(client_name);
614 client_name = pa_xstrdup(optarg);
617 case ARG_STREAM_NAME:
618 pa_xfree(stream_name);
619 stream_name = pa_xstrdup(optarg);
627 int v = atoi(optarg);
628 volume = v < 0 ? 0 : v;
633 sample_spec.channels = atoi(optarg);
636 case ARG_SAMPLEFORMAT:
637 sample_spec.format = pa_parse_sample_format(optarg);
641 sample_spec.rate = atoi(optarg);
645 if (!pa_channel_map_parse(&channel_map, optarg)) {
646 fprintf(stderr, "Invalid channel map '%s'\n", optarg);
653 case ARG_FIX_CHANNELS:
654 flags |= PA_STREAM_FIX_CHANNELS;
658 flags |= PA_STREAM_FIX_RATE;
662 flags |= PA_STREAM_FIX_FORMAT;
666 flags |= PA_STREAM_NO_REMIX_CHANNELS;
670 flags |= PA_STREAM_NO_REMAP_CHANNELS;
674 if (((latency = atoi(optarg))) <= 0) {
675 fprintf(stderr, "Invalid latency specification '%s'\n", optarg);
680 case ARG_PROCESS_TIME:
681 if (((process_time = atoi(optarg))) <= 0) {
682 fprintf(stderr, "Invalid process time specification '%s'\n", optarg);
692 if (!pa_sample_spec_valid(&sample_spec)) {
693 fprintf(stderr, "Invalid sample specification\n");
697 if (channel_map_set && channel_map.channels != sample_spec.channels) {
698 fprintf(stderr, "Channel map doesn't match sample specification\n");
703 char t[PA_SAMPLE_SPEC_SNPRINT_MAX];
704 pa_sample_spec_snprint(t, sizeof(t), &sample_spec);
705 fprintf(stderr, "Opening a %s stream with sample specification '%s'.\n", mode == RECORD ? "recording" : "playback", t);
708 if (!(optind >= argc)) {
709 if (optind+1 == argc) {
712 if ((fd = open(argv[optind], mode == PLAYBACK ? O_RDONLY : O_WRONLY|O_TRUNC|O_CREAT, 0666)) < 0) {
713 fprintf(stderr, "open(): %s\n", strerror(errno));
717 if (dup2(fd, mode == PLAYBACK ? 0 : 1) < 0) {
718 fprintf(stderr, "dup2(): %s\n", strerror(errno));
725 stream_name = pa_xstrdup(argv[optind]);
728 fprintf(stderr, "Too many arguments.\n");
734 client_name = pa_xstrdup(bn);
737 stream_name = pa_xstrdup(client_name);
739 /* Set up a new main loop */
740 if (!(m = pa_mainloop_new())) {
741 fprintf(stderr, "pa_mainloop_new() failed.\n");
745 mainloop_api = pa_mainloop_get_api(m);
747 r = pa_signal_init(mainloop_api);
749 pa_signal_new(SIGINT, exit_signal_callback, NULL);
750 pa_signal_new(SIGTERM, exit_signal_callback, NULL);
752 pa_signal_new(SIGUSR1, sigusr1_signal_callback, NULL);
755 signal(SIGPIPE, SIG_IGN);
758 if (!(stdio_event = mainloop_api->io_new(mainloop_api,
759 mode == PLAYBACK ? STDIN_FILENO : STDOUT_FILENO,
760 mode == PLAYBACK ? PA_IO_EVENT_INPUT : PA_IO_EVENT_OUTPUT,
761 mode == PLAYBACK ? stdin_callback : stdout_callback, NULL))) {
762 fprintf(stderr, "io_new() failed.\n");
766 /* Create a new connection context */
767 if (!(context = pa_context_new(mainloop_api, client_name))) {
768 fprintf(stderr, "pa_context_new() failed.\n");
772 pa_context_set_state_callback(context, context_state_callback, NULL);
774 /* Connect the context */
775 pa_context_connect(context, server, 0, NULL);
780 pa_gettimeofday(&tv);
781 pa_timeval_add(&tv, TIME_EVENT_USEC);
783 if (!(time_event = mainloop_api->time_new(mainloop_api, &tv, time_event_callback, NULL))) {
784 fprintf(stderr, "time_new() failed.\n");
789 /* Run the main loop */
790 if (pa_mainloop_run(m, &ret) < 0) {
791 fprintf(stderr, "pa_mainloop_run() failed.\n");
797 pa_stream_unref(stream);
800 pa_context_unref(context);
803 assert(mainloop_api);
804 mainloop_api->io_free(stdio_event);
808 assert(mainloop_api);
809 mainloop_api->time_free(time_event);
821 pa_xfree(client_name);
822 pa_xfree(stream_name);