4 This file is part of PulseAudio.
6 Copyright 2006 Lennart Poettering
7 Copyright 2006-2007 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
37 #include <sys/ioctl.h>
39 #include <sys/types.h>
44 #include <sys/audio.h>
46 #include <pulse/error.h>
47 #include <pulse/mainloop-signal.h>
48 #include <pulse/xmalloc.h>
49 #include <pulse/timeval.h>
51 #include <pulsecore/iochannel.h>
52 #include <pulsecore/sink.h>
53 #include <pulsecore/source.h>
54 #include <pulsecore/module.h>
55 #include <pulsecore/sample-util.h>
56 #include <pulsecore/core-util.h>
57 #include <pulsecore/modargs.h>
58 #include <pulsecore/log.h>
59 #include <pulsecore/core-error.h>
60 #include <pulsecore/thread-mq.h>
61 #include <pulsecore/rtpoll.h>
62 #include <pulsecore/thread.h>
64 #include "module-solaris-symdef.h"
66 PA_MODULE_AUTHOR("Pierre Ossman")
67 PA_MODULE_DESCRIPTION("Solaris Sink/Source")
68 PA_MODULE_VERSION(PACKAGE_VERSION
)
70 "sink_name=<name for the sink> "
71 "source_name=<name for the source> "
72 "device=<OSS device> record=<enable source?> "
73 "playback=<enable sink?> "
74 "format=<sample format> "
75 "channels=<number of channels> "
77 "buffer_size=<record buffer size> "
78 "channel_map=<channel map>")
86 pa_thread_mq thread_mq
;
93 unsigned int page_size
;
97 unsigned int written_bytes
, read_bytes
;
100 pa_rtpoll_item
*rtpoll_item
;
104 static const char* const valid_modargs
[] = {
118 #define DEFAULT_SINK_NAME "solaris_output"
119 #define DEFAULT_SOURCE_NAME "solaris_input"
120 #define DEFAULT_DEVICE "/dev/audio"
122 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
123 struct userdata
*u
= PA_SINK(o
)->userdata
;
128 case PA_SINK_MESSAGE_GET_LATENCY
: {
133 err
= ioctl(u
->fd
, AUDIO_GETINFO
, &info
);
136 r
+= pa_bytes_to_usec(u
->written_bytes
, &PA_SINK(o
)->sample_spec
);
137 r
-= pa_bytes_to_usec(info
.play
.samples
* u
->frame_size
, &PA_SINK(o
)->sample_spec
);
139 if (u
->memchunk
.memblock
)
140 r
+= pa_bytes_to_usec(u
->memchunk
.length
, &PA_SINK(o
)->sample_spec
);
143 *((pa_usec_t
*) data
) = r
;
148 case PA_SINK_MESSAGE_SET_VOLUME
:
150 AUDIO_INITINFO(&info
);
152 info
.play
.gain
= pa_cvolume_avg((pa_cvolume
*)data
) * AUDIO_MAX_GAIN
/ PA_VOLUME_NORM
;
153 assert(info
.play
.gain
<= AUDIO_MAX_GAIN
);
155 if (ioctl(u
->fd
, AUDIO_SETINFO
, &info
) < 0) {
157 pa_log("AUDIO_SETINFO: Unsupported volume.");
159 pa_log("AUDIO_SETINFO: %s", pa_cstrerror(errno
));
166 case PA_SINK_MESSAGE_GET_VOLUME
:
168 err
= ioctl(u
->fd
, AUDIO_GETINFO
, &info
);
171 pa_cvolume_set((pa_cvolume
*) data
, ((pa_cvolume
*) data
)->channels
,
172 info
.play
.gain
* PA_VOLUME_NORM
/ AUDIO_MAX_GAIN
);
178 case PA_SINK_MESSAGE_SET_MUTE
:
180 AUDIO_INITINFO(&info
);
182 info
.output_muted
= !!PA_PTR_TO_UINT(data
);
184 if (ioctl(u
->fd
, AUDIO_SETINFO
, &info
) < 0)
185 pa_log("AUDIO_SETINFO: %s", pa_cstrerror(errno
));
191 case PA_SINK_MESSAGE_GET_MUTE
:
193 err
= ioctl(u
->fd
, AUDIO_GETINFO
, &info
);
196 *(int*)data
= !!info
.output_muted
;
203 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
206 static int source_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
207 struct userdata
*u
= PA_SOURCE(o
)->userdata
;
212 case PA_SOURCE_MESSAGE_GET_LATENCY
: {
216 err
= ioctl(u
->fd
, AUDIO_GETINFO
, &info
);
219 r
+= pa_bytes_to_usec(info
.record
.samples
* u
->frame_size
, &PA_SOURCE(o
)->sample_spec
);
220 r
-= pa_bytes_to_usec(u
->read_bytes
, &PA_SOURCE(o
)->sample_spec
);
223 *((pa_usec_t
*) data
) = r
;
228 case PA_SOURCE_MESSAGE_SET_VOLUME
:
230 AUDIO_INITINFO(&info
);
232 info
.record
.gain
= pa_cvolume_avg((pa_cvolume
*) data
) * AUDIO_MAX_GAIN
/ PA_VOLUME_NORM
;
233 assert(info
.record
.gain
<= AUDIO_MAX_GAIN
);
235 if (ioctl(u
->fd
, AUDIO_SETINFO
, &info
) < 0) {
237 pa_log("AUDIO_SETINFO: Unsupported volume.");
239 pa_log("AUDIO_SETINFO: %s", pa_cstrerror(errno
));
246 case PA_SOURCE_MESSAGE_GET_VOLUME
:
248 err
= ioctl(u
->fd
, AUDIO_GETINFO
, &info
);
251 pa_cvolume_set((pa_cvolume
*) data
, ((pa_cvolume
*) data
)->channels
,
252 info
.record
.gain
* PA_VOLUME_NORM
/ AUDIO_MAX_GAIN
);
259 return pa_source_process_msg(o
, code
, data
, offset
, chunk
);
262 static void clear_underflow(struct userdata
*u
)
266 AUDIO_INITINFO(&info
);
270 if (ioctl(u
->fd
, AUDIO_SETINFO
, &info
) < 0)
271 pa_log("AUDIO_SETINFO: %s", pa_cstrerror(errno
));
274 static void clear_overflow(struct userdata
*u
)
278 AUDIO_INITINFO(&info
);
280 info
.record
.error
= 0;
282 if (ioctl(u
->fd
, AUDIO_SETINFO
, &info
) < 0)
283 pa_log("AUDIO_SETINFO: %s", pa_cstrerror(errno
));
286 static void thread_func(void *userdata
) {
287 struct userdata
*u
= userdata
;
288 unsigned short revents
= 0;
293 pa_log_debug("Thread starting up");
295 if (u
->core
->high_priority
)
298 pa_thread_mq_install(&u
->thread_mq
);
299 pa_rtpoll_install(u
->rtpoll
);
302 /* Render some data and write it to the dsp */
304 if (u
->sink
&& PA_SINK_OPENED(u
->sink
->thread_info
.state
)) {
309 err
= ioctl(u
->fd
, AUDIO_GETINFO
, &info
);
313 * Since we cannot modify the size of the output buffer we fake it
314 * by not filling it more than u->buffer_size.
316 len
= u
->buffer_size
;
317 len
-= u
->written_bytes
- (info
.play
.samples
* u
->frame_size
);
319 /* The sample counter can sometimes go backwards :( */
320 if (len
> u
->buffer_size
)
323 if (info
.play
.error
) {
324 pa_log_debug("Solaris buffer underflow!");
328 len
-= len
% u
->frame_size
;
334 if (!u
->memchunk
.length
)
335 pa_sink_render(u
->sink
, len
, &u
->memchunk
);
337 pa_assert(u
->memchunk
.length
);
339 p
= pa_memblock_acquire(u
->memchunk
.memblock
);
340 r
= pa_write(u
->fd
, (uint8_t*) p
+ u
->memchunk
.index
, u
->memchunk
.length
, NULL
);
341 pa_memblock_release(u
->memchunk
.memblock
);
346 else if (errno
!= EAGAIN
) {
347 pa_log("Failed to read data from DSP: %s", pa_cstrerror(errno
));
351 pa_assert(r
% u
->frame_size
== 0);
353 u
->memchunk
.index
+= r
;
354 u
->memchunk
.length
-= r
;
356 if (u
->memchunk
.length
<= 0) {
357 pa_memblock_unref(u
->memchunk
.memblock
);
358 pa_memchunk_reset(&u
->memchunk
);
362 u
->written_bytes
+= r
;
367 /* Try to read some data and pass it on to the source driver */
369 if (u
->source
&& PA_SOURCE_OPENED(u
->source
->thread_info
.state
) && ((revents
& POLLIN
))) {
370 pa_memchunk memchunk
;
377 err
= ioctl(u
->fd
, AUDIO_GETINFO
, &info
);
380 if (info
.record
.error
) {
381 pa_log_debug("Solaris buffer overflow!");
385 err
= ioctl(u
->fd
, I_NREAD
, &l
);
389 /* This is to make sure it fits in the memory pool. Also, a page
390 should be the most efficient transfer size. */
391 if (l
> u
->page_size
)
394 memchunk
.memblock
= pa_memblock_new(u
->core
->mempool
, l
);
395 pa_assert(memchunk
.memblock
);
397 p
= pa_memblock_acquire(memchunk
.memblock
);
398 r
= pa_read(u
->fd
, p
, l
, NULL
);
399 pa_memblock_release(memchunk
.memblock
);
402 pa_memblock_unref(memchunk
.memblock
);
403 if (errno
!= EAGAIN
) {
404 pa_log("Failed to read data from DSP: %s", pa_cstrerror(errno
));
411 pa_source_post(u
->source
, &memchunk
);
412 pa_memblock_unref(memchunk
.memblock
);
422 struct pollfd
*pollfd
;
424 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
426 ((u
->source
&& PA_SOURCE_OPENED(u
->source
->thread_info
.state
)) ? POLLIN
: 0);
429 /* Hmm, nothing to do. Let's sleep */
430 if ((ret
= pa_rtpoll_run(u
->rtpoll
, 1)) < 0)
437 struct pollfd
*pollfd
;
439 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
441 if (pollfd
->revents
& ~(POLLOUT
|POLLIN
)) {
442 pa_log("DSP shutdown.");
446 revents
= pollfd
->revents
;
452 /* We have to continue processing messages until we receive the
453 * SHUTDOWN message */
454 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
455 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
458 pa_log_debug("Thread shutting down");
461 static void sig_callback(pa_mainloop_api
*api
, pa_signal_event
*e
, int sig
, void *userdata
) {
462 struct userdata
*u
= userdata
;
467 pa_sink_get_volume(u
->sink
);
468 pa_sink_get_mute(u
->sink
);
472 pa_source_get_volume(u
->source
);
475 static int pa_solaris_auto_format(int fd
, int mode
, pa_sample_spec
*ss
) {
478 AUDIO_INITINFO(&info
);
480 if (mode
!= O_RDONLY
) {
481 info
.play
.sample_rate
= ss
->rate
;
482 info
.play
.channels
= ss
->channels
;
483 switch (ss
->format
) {
485 info
.play
.precision
= 8;
486 info
.play
.encoding
= AUDIO_ENCODING_LINEAR
;
489 info
.play
.precision
= 8;
490 info
.play
.encoding
= AUDIO_ENCODING_ALAW
;
493 info
.play
.precision
= 8;
494 info
.play
.encoding
= AUDIO_ENCODING_ULAW
;
496 case PA_SAMPLE_S16NE
:
497 info
.play
.precision
= 16;
498 info
.play
.encoding
= AUDIO_ENCODING_LINEAR
;
505 if (mode
!= O_WRONLY
) {
506 info
.record
.sample_rate
= ss
->rate
;
507 info
.record
.channels
= ss
->channels
;
508 switch (ss
->format
) {
510 info
.record
.precision
= 8;
511 info
.record
.encoding
= AUDIO_ENCODING_LINEAR
;
514 info
.record
.precision
= 8;
515 info
.record
.encoding
= AUDIO_ENCODING_ALAW
;
518 info
.record
.precision
= 8;
519 info
.record
.encoding
= AUDIO_ENCODING_ULAW
;
521 case PA_SAMPLE_S16NE
:
522 info
.record
.precision
= 16;
523 info
.record
.encoding
= AUDIO_ENCODING_LINEAR
;
530 if (ioctl(fd
, AUDIO_SETINFO
, &info
) < 0) {
532 pa_log("AUDIO_SETINFO: Unsupported sample format.");
534 pa_log("AUDIO_SETINFO: %s", pa_cstrerror(errno
));
541 static int pa_solaris_set_buffer(int fd
, int buffer_size
) {
544 AUDIO_INITINFO(&info
);
546 info
.play
.buffer_size
= buffer_size
;
547 info
.record
.buffer_size
= buffer_size
;
549 if (ioctl(fd
, AUDIO_SETINFO
, &info
) < 0) {
551 pa_log("AUDIO_SETINFO: Unsupported buffer size.");
553 pa_log("AUDIO_SETINFO: %s", pa_cstrerror(errno
));
560 int pa__init(pa_module
*m
) {
561 struct userdata
*u
= NULL
;
566 int record
= 1, playback
= 1;
569 pa_modargs
*ma
= NULL
;
571 struct pollfd
*pollfd
;
575 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
576 pa_log("failed to parse module arguments.");
580 if (pa_modargs_get_value_boolean(ma
, "record", &record
) < 0 || pa_modargs_get_value_boolean(ma
, "playback", &playback
) < 0) {
581 pa_log("record= and playback= expect numeric argument.");
585 if (!playback
&& !record
) {
586 pa_log("neither playback nor record enabled for device.");
590 mode
= (playback
&&record
) ? O_RDWR
: (playback
? O_WRONLY
: (record
? O_RDONLY
: 0));
593 if (pa_modargs_get_value_s32(ma
, "buffer_size", &buffer_size
) < 0) {
594 pa_log("failed to parse buffer size argument");
598 ss
= m
->core
->default_sample_spec
;
599 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_DEFAULT
) < 0) {
600 pa_log("failed to parse sample specification");
604 if ((fd
= open(p
= pa_modargs_get_value(ma
, "device", DEFAULT_DEVICE
), mode
| O_NONBLOCK
)) < 0)
607 pa_log_info("device opened in %s mode.", mode
== O_WRONLY
? "O_WRONLY" : (mode
== O_RDONLY
? "O_RDONLY" : "O_RDWR"));
609 if (pa_solaris_auto_format(fd
, mode
, &ss
) < 0)
612 if (pa_solaris_set_buffer(fd
, buffer_size
) < 0)
615 u
= pa_xmalloc(sizeof(struct userdata
));
620 pa_memchunk_reset(&u
->memchunk
);
622 /* We use this to get a reasonable chunk size */
623 u
->page_size
= PA_PAGE_SIZE
;
625 u
->frame_size
= pa_frame_size(&ss
);
626 u
->buffer_size
= buffer_size
;
628 u
->written_bytes
= 0;
634 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
);
636 u
->rtpoll
= pa_rtpoll_new();
637 pa_rtpoll_item_new_asyncmsgq(u
->rtpoll
, PA_RTPOLL_EARLY
, u
->thread_mq
.inq
);
639 pa_rtpoll_set_timer_periodic(u
->rtpoll
, pa_bytes_to_usec(u
->buffer_size
/ 10, &ss
));
641 u
->rtpoll_item
= pa_rtpoll_item_new(u
->rtpoll
, PA_RTPOLL_NEVER
, 1);
642 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
647 if (mode
!= O_WRONLY
) {
648 u
->source
= pa_source_new(m
->core
, __FILE__
, pa_modargs_get_value(ma
, "source_name", DEFAULT_SOURCE_NAME
), 0, &ss
, &map
);
649 pa_assert(u
->source
);
651 u
->source
->userdata
= u
;
652 u
->source
->parent
.process_msg
= source_process_msg
;
654 pa_source_set_module(u
->source
, m
);
655 pa_source_set_description(u
->source
, t
= pa_sprintf_malloc("Solaris PCM on '%s'", p
));
657 pa_source_set_asyncmsgq(u
->source
, u
->thread_mq
.inq
);
658 pa_source_set_rtpoll(u
->source
, u
->rtpoll
);
660 u
->source
->flags
= PA_SOURCE_HARDWARE
|PA_SOURCE_LATENCY
|PA_SOURCE_HW_VOLUME_CTRL
;
661 u
->source
->refresh_volume
= 1;
665 if (mode
!= O_RDONLY
) {
666 u
->sink
= pa_sink_new(m
->core
, __FILE__
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
), 0, &ss
, &map
);
669 u
->sink
->userdata
= u
;
670 u
->sink
->parent
.process_msg
= sink_process_msg
;
672 pa_sink_set_module(u
->sink
, m
);
673 pa_sink_set_description(u
->sink
, t
= pa_sprintf_malloc("Solaris PCM on '%s'", p
));
675 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
676 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
678 u
->sink
->flags
= PA_SINK_HARDWARE
|PA_SINK_LATENCY
|PA_SINK_HW_VOLUME_CTRL
;
679 u
->sink
->refresh_volume
= 1;
680 u
->sink
->refresh_mute
= 1;
684 pa_assert(u
->source
|| u
->sink
);
686 u
->sig
= pa_signal_new(SIGPOLL
, sig_callback
, u
);
688 ioctl(u
->fd
, I_SETSIG
, S_MSG
);
690 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
691 pa_log("Failed to create thread.");
695 /* Read mixer settings */
697 pa_asyncmsgq_send(u
->thread_mq
.inq
, PA_MSGOBJECT(u
->source
), PA_SOURCE_MESSAGE_GET_VOLUME
, &u
->source
->volume
, 0, NULL
);
699 pa_asyncmsgq_send(u
->thread_mq
.inq
, PA_MSGOBJECT(u
->sink
), PA_SINK_MESSAGE_GET_VOLUME
, &u
->sink
->volume
, 0, NULL
);
700 pa_asyncmsgq_send(u
->thread_mq
.inq
, PA_MSGOBJECT(u
->sink
), PA_SINK_MESSAGE_GET_MUTE
, &u
->sink
->muted
, 0, NULL
);
704 pa_sink_put(u
->sink
);
706 pa_source_put(u
->source
);
724 void pa__done(pa_module
*m
) {
729 if (!(u
= m
->userdata
))
732 ioctl(u
->fd
, I_SETSIG
, 0);
733 pa_signal_free(u
->sig
);
736 pa_sink_unlink(u
->sink
);
739 pa_source_unlink(u
->source
);
742 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
743 pa_thread_free(u
->thread
);
746 pa_thread_mq_done(&u
->thread_mq
);
749 pa_sink_unref(u
->sink
);
752 pa_source_unref(u
->source
);
754 if (u
->memchunk
.memblock
)
755 pa_memblock_unref(u
->memchunk
.memblock
);
758 pa_rtpoll_item_free(u
->rtpoll_item
);
761 pa_rtpoll_free(u
->rtpoll
);