]> code.delx.au - pulseaudio/blob - src/modules/module-oss-mmap.c
change pa_log() and friends to not require a trailing \n on all logged strings
[pulseaudio] / src / modules / module-oss-mmap.c
1 /* $Id$ */
2
3 /***
4 This file is part of polypaudio.
5
6 polypaudio 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 polypaudio 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 polypaudio; 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 <sys/soundcard.h>
27 #include <sys/ioctl.h>
28 #include <stdlib.h>
29 #include <sys/stat.h>
30 #include <stdio.h>
31 #include <assert.h>
32 #include <errno.h>
33 #include <string.h>
34 #include <fcntl.h>
35 #include <unistd.h>
36 #include <limits.h>
37 #include <sys/mman.h>
38
39 #include <polypcore/iochannel.h>
40 #include <polypcore/sink.h>
41 #include <polypcore/source.h>
42 #include <polypcore/module.h>
43 #include <polypcore/sample-util.h>
44 #include <polypcore/util.h>
45 #include <polypcore/modargs.h>
46 #include <polypcore/xmalloc.h>
47 #include <polypcore/log.h>
48
49 #include "oss-util.h"
50 #include "module-oss-mmap-symdef.h"
51
52 PA_MODULE_AUTHOR("Lennart Poettering")
53 PA_MODULE_DESCRIPTION("OSS Sink/Source (mmap)")
54 PA_MODULE_VERSION(PACKAGE_VERSION)
55 PA_MODULE_USAGE("sink_name=<name for the sink> source_name=<name for the source> device=<OSS device> record=<enable source?> playback=<enable sink?> format=<sample format> channels=<number of channels> rate=<sample rate> fragments=<number of fragments> fragment_size=<fragment size>")
56
57 struct userdata {
58 pa_sink *sink;
59 pa_source *source;
60 pa_core *core;
61 pa_sample_spec sample_spec;
62
63 size_t in_fragment_size, out_fragment_size, in_fragments, out_fragments, out_fill;
64
65 int fd;
66
67 void *in_mmap, *out_mmap;
68 size_t in_mmap_length, out_mmap_length;
69
70 pa_io_event *io_event;
71
72 pa_memblock **in_memblocks, **out_memblocks;
73 unsigned out_current, in_current;
74 pa_module *module;
75 };
76
77 static const char* const valid_modargs[] = {
78 "sink_name",
79 "source_name",
80 "device",
81 "record",
82 "playback",
83 "fragments",
84 "fragment_size",
85 "format",
86 "rate",
87 "channels",
88 NULL
89 };
90
91 #define DEFAULT_SINK_NAME "oss_output"
92 #define DEFAULT_SOURCE_NAME "oss_input"
93 #define DEFAULT_DEVICE "/dev/dsp"
94
95 static void update_usage(struct userdata *u) {
96 pa_module_set_used(u->module,
97 (u->sink ? pa_idxset_size(u->sink->inputs) : 0) +
98 (u->sink ? pa_idxset_size(u->sink->monitor_source->outputs) : 0) +
99 (u->source ? pa_idxset_size(u->source->outputs) : 0));
100 }
101
102 static void out_fill_memblocks(struct userdata *u, unsigned n) {
103 assert(u && u->out_memblocks);
104
105 while (n > 0) {
106 pa_memchunk chunk;
107
108 if (u->out_memblocks[u->out_current])
109 pa_memblock_unref_fixed(u->out_memblocks[u->out_current]);
110
111 chunk.memblock = u->out_memblocks[u->out_current] = pa_memblock_new_fixed((uint8_t*)u->out_mmap+u->out_fragment_size*u->out_current, u->out_fragment_size, 1, u->core->memblock_stat);
112 assert(chunk.memblock);
113 chunk.length = chunk.memblock->length;
114 chunk.index = 0;
115
116 pa_sink_render_into_full(u->sink, &chunk);
117
118 u->out_current++;
119 while (u->out_current >= u->out_fragments)
120 u->out_current -= u->out_fragments;
121
122 n--;
123 }
124 }
125
126 static void do_write(struct userdata *u) {
127 struct count_info info;
128 assert(u && u->sink);
129
130 update_usage(u);
131
132 if (ioctl(u->fd, SNDCTL_DSP_GETOPTR, &info) < 0) {
133 pa_log(__FILE__": SNDCTL_DSP_GETOPTR: %s", strerror(errno));
134 return;
135 }
136
137 u->out_fill = (u->out_fragment_size * u->out_fragments) - (info.ptr % u->out_fragment_size);
138
139 if (!info.blocks)
140 return;
141
142 out_fill_memblocks(u, info.blocks);
143 }
144
145 static void in_post_memblocks(struct userdata *u, unsigned n) {
146 assert(u && u->in_memblocks);
147
148 while (n > 0) {
149 pa_memchunk chunk;
150
151 if (!u->in_memblocks[u->in_current]) {
152 chunk.memblock = u->in_memblocks[u->in_current] = pa_memblock_new_fixed((uint8_t*) u->in_mmap+u->in_fragment_size*u->in_current, u->in_fragment_size, 1, u->core->memblock_stat);
153 chunk.length = chunk.memblock->length;
154 chunk.index = 0;
155
156 pa_source_post(u->source, &chunk);
157 }
158
159 u->in_current++;
160 while (u->in_current >= u->in_fragments)
161 u->in_current -= u->in_fragments;
162
163 n--;
164 }
165 }
166
167 static void in_clear_memblocks(struct userdata*u, unsigned n) {
168 unsigned i = u->in_current;
169 assert(u && u->in_memblocks);
170
171 if (n > u->in_fragments)
172 n = u->in_fragments;
173
174 while (n > 0) {
175 if (u->in_memblocks[i]) {
176 pa_memblock_unref_fixed(u->in_memblocks[i]);
177 u->in_memblocks[i] = NULL;
178 }
179
180 i++;
181 while (i >= u->in_fragments)
182 i -= u->in_fragments;
183
184 n--;
185 }
186 }
187
188 static void do_read(struct userdata *u) {
189 struct count_info info;
190 assert(u && u->source);
191
192 update_usage(u);
193
194 if (ioctl(u->fd, SNDCTL_DSP_GETIPTR, &info) < 0) {
195 pa_log(__FILE__": SNDCTL_DSP_GETIPTR: %s", strerror(errno));
196 return;
197 }
198
199 if (!info.blocks)
200 return;
201
202 in_post_memblocks(u, info.blocks);
203 in_clear_memblocks(u, u->in_fragments/2);
204 }
205
206 static void io_callback(pa_mainloop_api *m, pa_io_event *e, PA_GCC_UNUSED int fd, pa_io_event_flags_t f, void *userdata) {
207 struct userdata *u = userdata;
208 assert (u && u->core->mainloop == m && u->io_event == e);
209
210 if (f & PA_IO_EVENT_INPUT)
211 do_read(u);
212 if (f & PA_IO_EVENT_OUTPUT)
213 do_write(u);
214 }
215
216 static pa_usec_t sink_get_latency_cb(pa_sink *s) {
217 struct userdata *u = s->userdata;
218 assert(s && u);
219
220 do_write(u);
221 return pa_bytes_to_usec(u->out_fill, &s->sample_spec);
222 }
223
224 static int sink_get_hw_volume(pa_sink *s) {
225 struct userdata *u = s->userdata;
226
227 if (pa_oss_get_volume(u->fd, &s->sample_spec, &s->hw_volume) < 0) {
228 pa_log_info(__FILE__": device doesn't support reading mixer settings: %s", strerror(errno));
229 s->get_hw_volume = NULL;
230 return -1;
231 }
232
233 return 0;
234 }
235
236 static int sink_set_hw_volume(pa_sink *s) {
237 struct userdata *u = s->userdata;
238
239 if (pa_oss_set_volume(u->fd, &s->sample_spec, &s->hw_volume) < 0) {
240 pa_log_info(__FILE__": device doesn't support writing mixer settings: %s", strerror(errno));
241 s->set_hw_volume = NULL;
242 return -1;
243 }
244
245 return 0;
246 }
247
248 int pa__init(pa_core *c, pa_module*m) {
249 struct audio_buf_info info;
250 struct userdata *u = NULL;
251 const char *p;
252 int nfrags, frag_size;
253 int mode, caps;
254 int enable_bits = 0, zero = 0;
255 int playback = 1, record = 1;
256 pa_modargs *ma = NULL;
257 char hwdesc[64];
258
259 assert(c);
260 assert(m);
261
262 m->userdata = u = pa_xmalloc0(sizeof(struct userdata));
263 u->module = m;
264 u->fd = -1;
265 u->core = c;
266
267 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
268 pa_log(__FILE__": failed to parse module arguments.");
269 goto fail;
270 }
271
272 if (pa_modargs_get_value_boolean(ma, "record", &record) < 0 || pa_modargs_get_value_boolean(ma, "playback", &playback) < 0) {
273 pa_log(__FILE__": record= and playback= expect numeric arguments.");
274 goto fail;
275 }
276
277 if (!playback && !record) {
278 pa_log(__FILE__": neither playback nor record enabled for device.");
279 goto fail;
280 }
281
282 mode = (playback&&record) ? O_RDWR : (playback ? O_WRONLY : (record ? O_RDONLY : 0));
283
284 nfrags = 12;
285 frag_size = 1024;
286 if (pa_modargs_get_value_s32(ma, "fragments", &nfrags) < 0 || pa_modargs_get_value_s32(ma, "fragment_size", &frag_size) < 0) {
287 pa_log(__FILE__": failed to parse fragments arguments");
288 goto fail;
289 }
290
291 u->sample_spec = c->default_sample_spec;
292 if (pa_modargs_get_sample_spec(ma, &u->sample_spec) < 0) {
293 pa_log(__FILE__": failed to parse sample specification");
294 goto fail;
295 }
296
297 if ((u->fd = pa_oss_open(p = pa_modargs_get_value(ma, "device", DEFAULT_DEVICE), &mode, &caps)) < 0)
298 goto fail;
299
300 if (pa_oss_get_hw_description(p, hwdesc, sizeof(hwdesc)) >= 0)
301 pa_log_info(__FILE__": hardware name is '%s'.", hwdesc);
302 else
303 hwdesc[0] = 0;
304
305 if (!(caps & DSP_CAP_MMAP) || !(caps & DSP_CAP_REALTIME) || !(caps & DSP_CAP_TRIGGER)) {
306 pa_log(__FILE__": OSS device not mmap capable.");
307 goto fail;
308 }
309
310 pa_log_info(__FILE__": device opened in %s mode.", mode == O_WRONLY ? "O_WRONLY" : (mode == O_RDONLY ? "O_RDONLY" : "O_RDWR"));
311
312 if (nfrags >= 2 && frag_size >= 1)
313 if (pa_oss_set_fragments(u->fd, nfrags, frag_size) < 0)
314 goto fail;
315
316 if (pa_oss_auto_format(u->fd, &u->sample_spec) < 0)
317 goto fail;
318
319 if (mode != O_WRONLY) {
320 if (ioctl(u->fd, SNDCTL_DSP_GETISPACE, &info) < 0) {
321 pa_log(__FILE__": SNDCTL_DSP_GETISPACE: %s", strerror(errno));
322 goto fail;
323 }
324
325 pa_log_info(__FILE__": input -- %u fragments of size %u.", info.fragstotal, info.fragsize);
326 u->in_mmap_length = (u->in_fragment_size = info.fragsize) * (u->in_fragments = info.fragstotal);
327
328 if ((u->in_mmap = mmap(NULL, u->in_mmap_length, PROT_READ, MAP_SHARED, u->fd, 0)) == MAP_FAILED) {
329 if (mode == O_RDWR) {
330 pa_log(__FILE__": mmap failed for input. Changing to O_WRONLY mode.");
331 mode = O_WRONLY;
332 } else {
333 pa_log(__FILE__": mmap(): %s", strerror(errno));
334 goto fail;
335 }
336 } else {
337
338 u->source = pa_source_new(c, __FILE__, pa_modargs_get_value(ma, "source_name", DEFAULT_SOURCE_NAME), 0, &u->sample_spec, NULL);
339 assert(u->source);
340 u->source->userdata = u;
341 pa_source_set_owner(u->source, m);
342 u->source->description = pa_sprintf_malloc("Open Sound System PCM/mmap() on '%s'%s%s%s",
343 p,
344 hwdesc[0] ? " (" : "",
345 hwdesc[0] ? hwdesc : "",
346 hwdesc[0] ? ")" : "");
347
348 u->in_memblocks = pa_xmalloc0(sizeof(pa_memblock *)*u->in_fragments);
349
350 enable_bits |= PCM_ENABLE_INPUT;
351 }
352 }
353
354 if (mode != O_RDONLY) {
355 if (ioctl(u->fd, SNDCTL_DSP_GETOSPACE, &info) < 0) {
356 pa_log(__FILE__": SNDCTL_DSP_GETOSPACE: %s", strerror(errno));
357 goto fail;
358 }
359
360 pa_log_info(__FILE__": output -- %u fragments of size %u.", info.fragstotal, info.fragsize);
361 u->out_mmap_length = (u->out_fragment_size = info.fragsize) * (u->out_fragments = info.fragstotal);
362
363 if ((u->out_mmap = mmap(NULL, u->out_mmap_length, PROT_WRITE, MAP_SHARED, u->fd, 0)) == MAP_FAILED) {
364 if (mode == O_RDWR) {
365 pa_log(__FILE__": mmap filed for output. Changing to O_RDONLY mode.");
366 mode = O_RDONLY;
367 } else {
368 pa_log(__FILE__": mmap(): %s", strerror(errno));
369 goto fail;
370 }
371 } else {
372 pa_silence_memory(u->out_mmap, u->out_mmap_length, &u->sample_spec);
373
374 u->sink = pa_sink_new(c, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &u->sample_spec, NULL);
375 assert(u->sink);
376 u->sink->get_latency = sink_get_latency_cb;
377 u->sink->get_hw_volume = sink_get_hw_volume;
378 u->sink->set_hw_volume = sink_set_hw_volume;
379 u->sink->userdata = u;
380 pa_sink_set_owner(u->sink, m);
381 u->sink->description = pa_sprintf_malloc("Open Sound System PCM/mmap() on '%s'%s%s%s",
382 p,
383 hwdesc[0] ? " (" : "",
384 hwdesc[0] ? hwdesc : "",
385 hwdesc[0] ? ")" : "");
386
387 u->out_memblocks = pa_xmalloc0(sizeof(struct memblock *)*u->out_fragments);
388
389 enable_bits |= PCM_ENABLE_OUTPUT;
390 }
391 }
392
393 zero = 0;
394 if (ioctl(u->fd, SNDCTL_DSP_SETTRIGGER, &zero) < 0) {
395 pa_log(__FILE__": SNDCTL_DSP_SETTRIGGER: %s", strerror(errno));
396 goto fail;
397 }
398
399 if (ioctl(u->fd, SNDCTL_DSP_SETTRIGGER, &enable_bits) < 0) {
400 pa_log(__FILE__": SNDCTL_DSP_SETTRIGGER: %s", strerror(errno));
401 goto fail;
402 }
403
404 assert(u->source || u->sink);
405
406 u->io_event = c->mainloop->io_new(c->mainloop, u->fd, (u->source ? PA_IO_EVENT_INPUT : 0) | (u->sink ? PA_IO_EVENT_OUTPUT : 0), io_callback, u);
407 assert(u->io_event);
408
409 pa_modargs_free(ma);
410
411 /* Read mixer settings */
412 if (u->sink)
413 sink_get_hw_volume(u->sink);
414
415 return 0;
416
417 fail:
418 pa__done(c, m);
419
420 if (ma)
421 pa_modargs_free(ma);
422
423 return -1;
424 }
425
426 void pa__done(pa_core *c, pa_module*m) {
427 struct userdata *u;
428 assert(c && m);
429
430 if (!(u = m->userdata))
431 return;
432
433 if (u->out_memblocks) {
434 unsigned i;
435 for (i = 0; i < u->out_fragments; i++)
436 if (u->out_memblocks[i])
437 pa_memblock_unref_fixed(u->out_memblocks[i]);
438 pa_xfree(u->out_memblocks);
439 }
440
441 if (u->in_memblocks) {
442 unsigned i;
443 for (i = 0; i < u->in_fragments; i++)
444 if (u->in_memblocks[i])
445 pa_memblock_unref_fixed(u->in_memblocks[i]);
446 pa_xfree(u->in_memblocks);
447 }
448
449 if (u->in_mmap && u->in_mmap != MAP_FAILED)
450 munmap(u->in_mmap, u->in_mmap_length);
451
452 if (u->out_mmap && u->out_mmap != MAP_FAILED)
453 munmap(u->out_mmap, u->out_mmap_length);
454
455 if (u->sink) {
456 pa_sink_disconnect(u->sink);
457 pa_sink_unref(u->sink);
458 }
459
460 if (u->source) {
461 pa_source_disconnect(u->source);
462 pa_source_unref(u->source);
463 }
464
465 if (u->io_event)
466 u->core->mainloop->io_free(u->io_event);
467
468 if (u->fd >= 0)
469 close(u->fd);
470
471 pa_xfree(u);
472 }