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
38 #include <pulse/i18n.h>
39 #include <pulse/pulseaudio.h>
41 #define TIME_EVENT_USEC 50000
43 #define CLEAR_LINE "\x1B[K"
45 static enum { RECORD, PLAYBACK } mode = PLAYBACK;
47 static pa_context *context = NULL;
48 static pa_stream *stream = NULL;
49 static pa_mainloop_api *mainloop_api = NULL;
51 static void *buffer = NULL;
52 static size_t buffer_length = 0, buffer_index = 0;
54 static pa_io_event* stdio_event = NULL;
56 static char *stream_name = NULL, *client_name = NULL, *device = NULL;
58 static int verbose = 0;
59 static pa_volume_t volume = PA_VOLUME_NORM;
61 static pa_sample_spec sample_spec = {
62 .format = PA_SAMPLE_S16LE,
67 static pa_channel_map channel_map;
68 static int channel_map_set = 0;
70 static pa_stream_flags_t flags = 0;
72 static size_t latency = 0, process_time=0;
74 /* A shortcut for terminating the application */
75 static void quit(int ret) {
77 mainloop_api->quit(mainloop_api, ret);
80 /* Write some data to the stream */
81 static void do_stream_write(size_t length) {
85 if (!buffer || !buffer_length)
89 if (l > buffer_length)
92 if (pa_stream_write(stream, (uint8_t*) buffer + buffer_index, l, NULL, 0, PA_SEEK_RELATIVE) < 0) {
93 fprintf(stderr, _("pa_stream_write() failed: %s\n"), pa_strerror(pa_context_errno(context)));
101 if (!buffer_length) {
104 buffer_index = buffer_length = 0;
108 /* This is called whenever new data may be written to the stream */
109 static void stream_write_callback(pa_stream *s, size_t length, void *userdata) {
114 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_INPUT);
119 do_stream_write(length);
122 /* This is called whenever new data may is available */
123 static void stream_read_callback(pa_stream *s, size_t length, void *userdata) {
129 mainloop_api->io_enable(stdio_event, PA_IO_EVENT_OUTPUT);
131 if (pa_stream_peek(s, &data, &length) < 0) {
132 fprintf(stderr, _("pa_stream_peek() failed: %s\n"), pa_strerror(pa_context_errno(context)));
141 fprintf(stderr, _("Buffer overrun, dropping incoming data\n"));
142 if (pa_stream_drop(s) < 0) {
143 fprintf(stderr, _("pa_stream_drop() failed: %s\n"), pa_strerror(pa_context_errno(context)));
149 buffer = pa_xmalloc(buffer_length = length);
150 memcpy(buffer, data, length);
155 /* This routine is called whenever the stream state changes */
156 static void stream_state_callback(pa_stream *s, void *userdata) {
159 switch (pa_stream_get_state(s)) {
160 case PA_STREAM_CREATING:
161 case PA_STREAM_TERMINATED:
164 case PA_STREAM_READY:
166 const pa_buffer_attr *a;
167 char cmt[PA_CHANNEL_MAP_SNPRINT_MAX], sst[PA_SAMPLE_SPEC_SNPRINT_MAX];
169 fprintf(stderr, _("Stream successfully created.\n"));
171 if (!(a = pa_stream_get_buffer_attr(s)))
172 fprintf(stderr, _("pa_stream_get_buffer_attr() failed: %s\n"), pa_strerror(pa_context_errno(pa_stream_get_context(s))));
175 if (mode == PLAYBACK)
176 fprintf(stderr, _("Buffer metrics: maxlength=%u, tlength=%u, prebuf=%u, minreq=%u\n"), a->maxlength, a->tlength, a->prebuf, a->minreq);
178 assert(mode == RECORD);
179 fprintf(stderr, _("Buffer metrics: maxlength=%u, fragsize=%u\n"), a->maxlength, a->fragsize);
183 fprintf(stderr, _("Using sample spec '%s', channel map '%s'.\n"),
184 pa_sample_spec_snprint(sst, sizeof(sst), pa_stream_get_sample_spec(s)),
185 pa_channel_map_snprint(cmt, sizeof(cmt), pa_stream_get_channel_map(s)));
187 fprintf(stderr, _("Connected to device %s (%u, %ssuspended).\n"),
188 pa_stream_get_device_name(s),
189 pa_stream_get_device_index(s),
190 pa_stream_is_suspended(s) ? "" : "not ");
195 case PA_STREAM_FAILED:
197 fprintf(stderr, _("Stream error: %s\n"), pa_strerror(pa_context_errno(pa_stream_get_context(s))));
202 static void stream_suspended_callback(pa_stream *s, void *userdata) {
206 if (pa_stream_is_suspended(s))
207 fprintf(stderr, _("Stream device suspended.%s \n"), CLEAR_LINE);
209 fprintf(stderr, _("Stream device resumed.%s \n"), CLEAR_LINE);
213 static void stream_underflow_callback(pa_stream *s, void *userdata) {
217 fprintf(stderr, _("Stream underrun.%s \n"), CLEAR_LINE);
220 static void stream_overflow_callback(pa_stream *s, void *userdata) {
224 fprintf(stderr, _("Stream overrun.%s \n"), CLEAR_LINE);
227 static void stream_started_callback(pa_stream *s, void *userdata) {
231 fprintf(stderr, _("Stream started.%s \n"), CLEAR_LINE);
234 static void stream_moved_callback(pa_stream *s, void *userdata) {
238 fprintf(stderr, _("Stream moved to device %s (%u, %ssuspended).%s \n"), pa_stream_get_device_name(s), pa_stream_get_device_index(s), pa_stream_is_suspended(s) ? "" : _("not "), CLEAR_LINE);
241 /* This is called whenever the context status changes */
242 static void context_state_callback(pa_context *c, void *userdata) {
245 switch (pa_context_get_state(c)) {
246 case PA_CONTEXT_CONNECTING:
247 case PA_CONTEXT_AUTHORIZING:
248 case PA_CONTEXT_SETTING_NAME:
251 case PA_CONTEXT_READY: {
253 pa_buffer_attr buffer_attr;
259 fprintf(stderr, _("Connection established.%s \n"), CLEAR_LINE);
261 if (!(stream = pa_stream_new(c, stream_name, &sample_spec, channel_map_set ? &channel_map : NULL))) {
262 fprintf(stderr, _("pa_stream_new() failed: %s\n"), pa_strerror(pa_context_errno(c)));
266 pa_stream_set_state_callback(stream, stream_state_callback, NULL);
267 pa_stream_set_write_callback(stream, stream_write_callback, NULL);
268 pa_stream_set_read_callback(stream, stream_read_callback, NULL);
269 pa_stream_set_suspended_callback(stream, stream_suspended_callback, NULL);
270 pa_stream_set_moved_callback(stream, stream_moved_callback, NULL);
271 pa_stream_set_underflow_callback(stream, stream_underflow_callback, NULL);
272 pa_stream_set_overflow_callback(stream, stream_overflow_callback, NULL);
273 pa_stream_set_started_callback(stream, stream_started_callback, NULL);
276 memset(&buffer_attr, 0, sizeof(buffer_attr));
277 buffer_attr.tlength = (uint32_t) latency;
278 buffer_attr.minreq = (uint32_t) process_time;
279 buffer_attr.maxlength = (uint32_t) -1;
280 buffer_attr.prebuf = (uint32_t) -1;
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);
394 buffer_length = (uint32_t) r;
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);
425 buffer_length -= (uint32_t) r;
426 buffer_index += (uint32_t) r;
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.0f:1.0f));
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, s32le, s32be (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 setlocale(LC_ALL, "");
570 bindtextdomain(GETTEXT_PACKAGE, PULSE_LOCALEDIR);
572 if (!(bn = strrchr(argv[0], '/')))
577 if (strstr(bn, "rec") || strstr(bn, "mon"))
579 else if (strstr(bn, "cat") || strstr(bn, "play"))
582 while ((c = getopt_long(argc, argv, "rpd:s:n:hv", long_options, NULL)) != -1) {
591 printf(_("pacat %s\nCompiled with libpulse %s\nLinked with libpulse %s\n"), PACKAGE_VERSION, pa_get_headers_version(), pa_get_library_version());
605 device = pa_xstrdup(optarg);
610 server = pa_xstrdup(optarg);
614 pa_xfree(client_name);
615 client_name = pa_xstrdup(optarg);
618 case ARG_STREAM_NAME:
619 pa_xfree(stream_name);
620 stream_name = pa_xstrdup(optarg);
628 int v = atoi(optarg);
629 volume = v < 0 ? 0U : (pa_volume_t) v;
634 sample_spec.channels = (uint8_t) atoi(optarg);
637 case ARG_SAMPLEFORMAT:
638 sample_spec.format = pa_parse_sample_format(optarg);
642 sample_spec.rate = (uint32_t) atoi(optarg);
646 if (!pa_channel_map_parse(&channel_map, optarg)) {
647 fprintf(stderr, _("Invalid channel map '%s'\n"), optarg);
654 case ARG_FIX_CHANNELS:
655 flags |= PA_STREAM_FIX_CHANNELS;
659 flags |= PA_STREAM_FIX_RATE;
663 flags |= PA_STREAM_FIX_FORMAT;
667 flags |= PA_STREAM_NO_REMIX_CHANNELS;
671 flags |= PA_STREAM_NO_REMAP_CHANNELS;
675 if (((latency = (size_t) atoi(optarg))) <= 0) {
676 fprintf(stderr, _("Invalid latency specification '%s'\n"), optarg);
681 case ARG_PROCESS_TIME:
682 if (((process_time = (size_t) atoi(optarg))) <= 0) {
683 fprintf(stderr, _("Invalid process time specification '%s'\n"), optarg);
693 if (!pa_sample_spec_valid(&sample_spec)) {
694 fprintf(stderr, _("Invalid sample specification\n"));
698 if (channel_map_set && channel_map.channels != sample_spec.channels) {
699 fprintf(stderr, _("Channel map doesn't match sample specification\n"));
704 char t[PA_SAMPLE_SPEC_SNPRINT_MAX];
705 pa_sample_spec_snprint(t, sizeof(t), &sample_spec);
706 fprintf(stderr, _("Opening a %s stream with sample specification '%s'.\n"), mode == RECORD ? _("recording") : _("playback"), t);
709 if (!(optind >= argc)) {
710 if (optind+1 == argc) {
713 if ((fd = open(argv[optind], mode == PLAYBACK ? O_RDONLY : O_WRONLY|O_TRUNC|O_CREAT, 0666)) < 0) {
714 fprintf(stderr, _("open(): %s\n"), strerror(errno));
718 if (dup2(fd, mode == PLAYBACK ? 0 : 1) < 0) {
719 fprintf(stderr, _("dup2(): %s\n"), strerror(errno));
726 stream_name = pa_xstrdup(argv[optind]);
729 fprintf(stderr, _("Too many arguments.\n"));
735 client_name = pa_xstrdup(bn);
738 stream_name = pa_xstrdup(client_name);
740 /* Set up a new main loop */
741 if (!(m = pa_mainloop_new())) {
742 fprintf(stderr, _("pa_mainloop_new() failed.\n"));
746 mainloop_api = pa_mainloop_get_api(m);
748 r = pa_signal_init(mainloop_api);
750 pa_signal_new(SIGINT, exit_signal_callback, NULL);
751 pa_signal_new(SIGTERM, exit_signal_callback, NULL);
753 pa_signal_new(SIGUSR1, sigusr1_signal_callback, NULL);
756 signal(SIGPIPE, SIG_IGN);
759 if (!(stdio_event = mainloop_api->io_new(mainloop_api,
760 mode == PLAYBACK ? STDIN_FILENO : STDOUT_FILENO,
761 mode == PLAYBACK ? PA_IO_EVENT_INPUT : PA_IO_EVENT_OUTPUT,
762 mode == PLAYBACK ? stdin_callback : stdout_callback, NULL))) {
763 fprintf(stderr, _("io_new() failed.\n"));
767 /* Create a new connection context */
768 if (!(context = pa_context_new(mainloop_api, client_name))) {
769 fprintf(stderr, _("pa_context_new() failed.\n"));
773 pa_context_set_state_callback(context, context_state_callback, NULL);
775 /* Connect the context */
776 pa_context_connect(context, server, 0, NULL);
781 pa_gettimeofday(&tv);
782 pa_timeval_add(&tv, TIME_EVENT_USEC);
784 if (!(time_event = mainloop_api->time_new(mainloop_api, &tv, time_event_callback, NULL))) {
785 fprintf(stderr, _("time_new() failed.\n"));
790 /* Run the main loop */
791 if (pa_mainloop_run(m, &ret) < 0) {
792 fprintf(stderr, _("pa_mainloop_run() failed.\n"));
798 pa_stream_unref(stream);
801 pa_context_unref(context);
804 assert(mainloop_api);
805 mainloop_api->io_free(stdio_event);
809 assert(mainloop_api);
810 mainloop_api->time_free(time_event);
822 pa_xfree(client_name);
823 pa_xfree(stream_name);