src/modules/module-oss-mmap.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   PulseAudio 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   PulseAudio 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 PulseAudio; 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
  38 #ifdef HAVE_SYS_MMAN_H
  39 #include <sys/mman.h>
  40 #endif
  41
  42 #include <pulse/xmalloc.h>
  43 #include <pulse/util.h>
  44
  45 #include <pulsecore/core-error.h>
  46 #include <pulsecore/iochannel.h>
  47 #include <pulsecore/sink.h>
  48 #include <pulsecore/source.h>
  49 #include <pulsecore/module.h>
  50 #include <pulsecore/sample-util.h>
  51 #include <pulsecore/core-util.h>
  52 #include <pulsecore/modargs.h>
  53 #include <pulsecore/log.h>
  54
  55 #include "oss-util.h"
  56 #include "module-oss-mmap-symdef.h"
  57
  58 PA_MODULE_AUTHOR("Lennart Poettering")
  59 PA_MODULE_DESCRIPTION("OSS Sink/Source (mmap)")
  60 PA_MODULE_VERSION(PACKAGE_VERSION)
  61 PA_MODULE_USAGE(
  62         "sink_name=<name for the sink> "
  63         "source_name=<name for the source> "
  64         "device=<OSS device> "
  65         "record=<enable source?> "
  66         "playback=<enable sink?> "
  67         "format=<sample format> "
  68         "channels=<number of channels> "
  69         "rate=<sample rate> "
  70         "fragments=<number of fragments> "
  71         "fragment_size=<fragment size> "
  72         "channel_map=<channel map>")
  73
  74 struct userdata {
  75     pa_sink *sink;
  76     pa_source *source;
  77     pa_core *core;
  78     pa_sample_spec sample_spec;
  79
  80     size_t in_fragment_size, out_fragment_size;
  81     unsigned in_fragments, out_fragments;
  82     unsigned out_blocks_saved, in_blocks_saved;
  83
  84     int fd;
  85
  86     void *in_mmap, *out_mmap;
  87     size_t in_mmap_length, out_mmap_length;
  88
  89     pa_io_event *io_event;
  90
  91     pa_memblock **in_memblocks, **out_memblocks;
  92     unsigned out_current, in_current;
  93     pa_module *module;
  94 };
  95
  96 static const char* const valid_modargs[] = {
  97     "sink_name",
  98     "source_name",
  99     "device",
 100     "record",
 101     "playback",
 102     "fragments",
 103     "fragment_size",
 104     "format",
 105     "rate",
 106     "channels",
 107     "channel_map",
 108     NULL
 109 };
 110
 111 #define DEFAULT_DEVICE "/dev/dsp"
 112 #define DEFAULT_NFRAGS 12
 113 #define DEFAULT_FRAGSIZE 1024
 114
 115 static void update_usage(struct userdata *u) {
 116    pa_module_set_used(u->module,
 117                       (u->sink ? pa_sink_used_by(u->sink) : 0) +
 118                       (u->source ? pa_source_used_by(u->source) : 0));
 119 }
 120
 121 static void clear_up(struct userdata *u) {
 122     assert(u);
 123
 124     if (u->sink) {
 125         pa_sink_disconnect(u->sink);
 126         pa_sink_unref(u->sink);
 127         u->sink = NULL;
 128     }
 129
 130     if (u->source) {
 131         pa_source_disconnect(u->source);
 132         pa_source_unref(u->source);
 133         u->source = NULL;
 134     }
 135
 136     if (u->in_mmap && u->in_mmap != MAP_FAILED) {
 137         munmap(u->in_mmap, u->in_mmap_length);
 138         u->in_mmap = NULL;
 139     }
 140
 141     if (u->out_mmap && u->out_mmap != MAP_FAILED) {
 142         munmap(u->out_mmap, u->out_mmap_length);
 143         u->out_mmap = NULL;
 144     }
 145
 146     if (u->io_event) {
 147         u->core->mainloop->io_free(u->io_event);
 148         u->io_event = NULL;
 149     }
 150
 151     if (u->fd >= 0) {
 152         close(u->fd);
 153         u->fd = -1;
 154     }
 155 }
 156
 157 static void out_fill_memblocks(struct userdata *u, unsigned n) {
 158     assert(u && u->out_memblocks);
 159
 160     while (n > 0) {
 161         pa_memchunk chunk;
 162
 163         if (u->out_memblocks[u->out_current])
 164             pa_memblock_unref_fixed(u->out_memblocks[u->out_current]);
 165
 166         chunk.memblock = u->out_memblocks[u->out_current] =
 167             pa_memblock_new_fixed(
 168                     u->core->mempool,
 169                     (uint8_t*) u->out_mmap+u->out_fragment_size*u->out_current,
 170                     u->out_fragment_size,
 171                     1);
 172         assert(chunk.memblock);
 173         chunk.length = chunk.memblock->length;
 174         chunk.index = 0;
 175
 176         pa_sink_render_into_full(u->sink, &chunk);
 177
 178         u->out_current++;
 179         while (u->out_current >= u->out_fragments)
 180             u->out_current -= u->out_fragments;
 181
 182         n--;
 183     }
 184 }
 185
 186 static void do_write(struct userdata *u) {
 187     struct count_info info;
 188     assert(u && u->sink);
 189
 190     update_usage(u);
 191
 192     if (ioctl(u->fd, SNDCTL_DSP_GETOPTR, &info) < 0) {
 193         pa_log("SNDCTL_DSP_GETOPTR: %s", pa_cstrerror(errno));
 194
 195         clear_up(u);
 196         pa_module_unload_request(u->module);
 197         return;
 198     }
 199
 200     info.blocks += u->out_blocks_saved;
 201     u->out_blocks_saved = 0;
 202
 203     if (!info.blocks)
 204         return;
 205
 206     out_fill_memblocks(u, info.blocks);
 207 }
 208
 209 static void in_post_memblocks(struct userdata *u, unsigned n) {
 210     assert(u && u->in_memblocks);
 211
 212     while (n > 0) {
 213         pa_memchunk chunk;
 214
 215         if (!u->in_memblocks[u->in_current]) {
 216             chunk.memblock = u->in_memblocks[u->in_current] = pa_memblock_new_fixed(u->core->mempool, (uint8_t*) u->in_mmap+u->in_fragment_size*u->in_current, u->in_fragment_size, 1);
 217             chunk.length = chunk.memblock->length;
 218             chunk.index = 0;
 219
 220             pa_source_post(u->source, &chunk);
 221         }
 222
 223         u->in_current++;
 224         while (u->in_current >= u->in_fragments)
 225             u->in_current -= u->in_fragments;
 226
 227         n--;
 228     }
 229 }
 230
 231 static void in_clear_memblocks(struct userdata*u, unsigned n) {
 232     unsigned i = u->in_current;
 233     assert(u && u->in_memblocks);
 234
 235     if (n > u->in_fragments)
 236         n = u->in_fragments;
 237
 238     while (n > 0) {
 239         if (u->in_memblocks[i]) {
 240             pa_memblock_unref_fixed(u->in_memblocks[i]);
 241             u->in_memblocks[i] = NULL;
 242         }
 243
 244         i++;
 245         while (i >= u->in_fragments)
 246             i -= u->in_fragments;
 247
 248         n--;
 249     }
 250 }
 251
 252 static void do_read(struct userdata *u) {
 253     struct count_info info;
 254     assert(u && u->source);
 255
 256     update_usage(u);
 257
 258     if (ioctl(u->fd, SNDCTL_DSP_GETIPTR, &info) < 0) {
 259         pa_log("SNDCTL_DSP_GETIPTR: %s", pa_cstrerror(errno));
 260
 261         clear_up(u);
 262         pa_module_unload_request(u->module);
 263         return;
 264     }
 265
 266     info.blocks += u->in_blocks_saved;
 267     u->in_blocks_saved = 0;
 268
 269     if (!info.blocks)
 270         return;
 271
 272     in_post_memblocks(u, info.blocks);
 273     in_clear_memblocks(u, u->in_fragments/2);
 274 }
 275
 276 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) {
 277     struct userdata *u = userdata;
 278     assert (u && u->core->mainloop == m && u->io_event == e);
 279
 280     if (f & PA_IO_EVENT_ERROR) {
 281         clear_up(u);
 282         pa_module_unload_request(u->module);
 283         return;
 284     }
 285
 286     if (f & PA_IO_EVENT_INPUT)
 287         do_read(u);
 288     if (f & PA_IO_EVENT_OUTPUT)
 289         do_write(u);
 290 }
 291
 292 static pa_usec_t sink_get_latency_cb(pa_sink *s) {
 293     struct userdata *u = s->userdata;
 294     struct count_info info;
 295     size_t bpos, n, total;
 296     assert(s && u);
 297
 298     if (ioctl(u->fd, SNDCTL_DSP_GETOPTR, &info) < 0) {
 299         pa_log("SNDCTL_DSP_GETOPTR: %s", pa_cstrerror(errno));
 300         return 0;
 301     }
 302
 303     u->out_blocks_saved += info.blocks;
 304
 305     total = u->out_fragments * u->out_fragment_size;
 306     bpos = ((u->out_current + u->out_blocks_saved) * u->out_fragment_size) % total;
 307
 308     if (bpos <= (size_t) info.ptr)
 309         n = total - (info.ptr - bpos);
 310     else
 311         n = bpos - info.ptr;
 312
 313 /*     pa_log("n = %u, bpos = %u, ptr = %u, total=%u, fragsize = %u, n_frags = %u\n", n, bpos, (unsigned) info.ptr, total, u->out_fragment_size, u->out_fragments); */
 314
 315     return pa_bytes_to_usec(n, &s->sample_spec);
 316 }
 317
 318 static pa_usec_t source_get_latency_cb(pa_source *s) {
 319     struct userdata *u = s->userdata;
 320     struct count_info info;
 321     size_t bpos, n, total;
 322     assert(s && u);
 323
 324     if (ioctl(u->fd, SNDCTL_DSP_GETIPTR, &info) < 0) {
 325         pa_log("SNDCTL_DSP_GETIPTR: %s", pa_cstrerror(errno));
 326         return 0;
 327     }
 328
 329     u->in_blocks_saved += info.blocks;
 330
 331     total = u->in_fragments * u->in_fragment_size;
 332     bpos = ((u->in_current + u->in_blocks_saved) * u->in_fragment_size) % total;
 333
 334     if (bpos <= (size_t) info.ptr)
 335         n = info.ptr - bpos;
 336     else
 337         n = (u->in_fragments * u->in_fragment_size) - bpos + info.ptr;
 338
 339 /*     pa_log("n = %u, bpos = %u, ptr = %u, total=%u, fragsize = %u, n_frags = %u\n", n, bpos, (unsigned) info.ptr, total, u->in_fragment_size, u->in_fragments);  */
 340
 341     return pa_bytes_to_usec(n, &s->sample_spec);
 342 }
 343
 344 static int sink_get_hw_volume(pa_sink *s) {
 345     struct userdata *u = s->userdata;
 346
 347     if (pa_oss_get_pcm_volume(u->fd, &s->sample_spec, &s->hw_volume) < 0) {
 348         pa_log_info("device doesn't support reading mixer settings: %s", pa_cstrerror(errno));
 349         s->get_hw_volume = NULL;
 350         return -1;
 351     }
 352
 353     return 0;
 354 }
 355
 356 static int sink_set_hw_volume(pa_sink *s) {
 357     struct userdata *u = s->userdata;
 358
 359     if (pa_oss_set_pcm_volume(u->fd, &s->sample_spec, &s->hw_volume) < 0) {
 360         pa_log_info("device doesn't support writing mixer settings: %s", pa_cstrerror(errno));
 361         s->set_hw_volume = NULL;
 362         return -1;
 363     }
 364
 365     return 0;
 366 }
 367
 368 static int source_get_hw_volume(pa_source *s) {
 369     struct userdata *u = s->userdata;
 370
 371     if (pa_oss_get_input_volume(u->fd, &s->sample_spec, &s->hw_volume) < 0) {
 372         pa_log_info("device doesn't support reading mixer settings: %s", pa_cstrerror(errno));
 373         s->get_hw_volume = NULL;
 374         return -1;
 375     }
 376
 377     return 0;
 378 }
 379
 380 static int source_set_hw_volume(pa_source *s) {
 381     struct userdata *u = s->userdata;
 382
 383     if (pa_oss_set_input_volume(u->fd, &s->sample_spec, &s->hw_volume) < 0) {
 384         pa_log_info("device doesn't support writing mixer settings: %s", pa_cstrerror(errno));
 385         s->set_hw_volume = NULL;
 386         return -1;
 387     }
 388
 389     return 0;
 390 }
 391
 392 int pa__init(pa_core *c, pa_module*m) {
 393     struct audio_buf_info info;
 394     struct userdata *u = NULL;
 395     const char *p;
 396     int nfrags, frag_size;
 397     int mode, caps;
 398     int enable_bits = 0, zero = 0;
 399     int playback = 1, record = 1;
 400     pa_modargs *ma = NULL;
 401     char hwdesc[64], *t;
 402     pa_channel_map map;
 403     const char *name;
 404     char *name_buf = NULL;
 405     int namereg_fail;
 406
 407     assert(c);
 408     assert(m);
 409
 410     m->userdata = u = pa_xnew0(struct userdata, 1);
 411     u->module = m;
 412     u->fd = -1;
 413     u->core = c;
 414
 415     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 416         pa_log("failed to parse module arguments.");
 417         goto fail;
 418     }
 419
 420     if (pa_modargs_get_value_boolean(ma, "record", &record) < 0 || pa_modargs_get_value_boolean(ma, "playback", &playback) < 0) {
 421         pa_log("record= and playback= expect numeric arguments.");
 422         goto fail;
 423     }
 424
 425     if (!playback && !record) {
 426         pa_log("neither playback nor record enabled for device.");
 427         goto fail;
 428     }
 429
 430     mode = (playback&&record) ? O_RDWR : (playback ? O_WRONLY : (record ? O_RDONLY : 0));
 431
 432     nfrags = DEFAULT_NFRAGS;
 433     frag_size = DEFAULT_FRAGSIZE;
 434     if (pa_modargs_get_value_s32(ma, "fragments", &nfrags) < 0 || pa_modargs_get_value_s32(ma, "fragment_size", &frag_size) < 0) {
 435         pa_log("failed to parse fragments arguments");
 436         goto fail;
 437     }
 438
 439     u->sample_spec = c->default_sample_spec;
 440     if (pa_modargs_get_sample_spec_and_channel_map(ma, &u->sample_spec, &map, PA_CHANNEL_MAP_OSS) < 0) {
 441         pa_log("failed to parse sample specification or channel map");
 442         goto fail;
 443     }
 444
 445     if ((u->fd = pa_oss_open(p = pa_modargs_get_value(ma, "device", DEFAULT_DEVICE), &mode, &caps)) < 0)
 446         goto fail;
 447
 448     if (!(caps & DSP_CAP_MMAP) || !(caps & DSP_CAP_TRIGGER)) {
 449         pa_log("OSS device not mmap capable.");
 450         goto fail;
 451     }
 452
 453     pa_log_info("device opened in %s mode.", mode == O_WRONLY ? "O_WRONLY" : (mode == O_RDONLY ? "O_RDONLY" : "O_RDWR"));
 454
 455     if (pa_oss_get_hw_description(p, hwdesc, sizeof(hwdesc)) >= 0)
 456         pa_log_info("hardware name is '%s'.", hwdesc);
 457     else
 458         hwdesc[0] = 0;
 459
 460     if (nfrags >= 2 && frag_size >= 1)
 461         if (pa_oss_set_fragments(u->fd, nfrags, frag_size) < 0)
 462             goto fail;
 463
 464     if (pa_oss_auto_format(u->fd, &u->sample_spec) < 0)
 465         goto fail;
 466
 467     if (mode != O_WRONLY) {
 468         if (ioctl(u->fd, SNDCTL_DSP_GETISPACE, &info) < 0) {
 469             pa_log("SNDCTL_DSP_GETISPACE: %s", pa_cstrerror(errno));
 470             goto fail;
 471         }
 472
 473         pa_log_info("input -- %u fragments of size %u.", info.fragstotal, info.fragsize);
 474         u->in_mmap_length = (u->in_fragment_size = info.fragsize) * (u->in_fragments = info.fragstotal);
 475
 476         if ((u->in_mmap = mmap(NULL, u->in_mmap_length, PROT_READ, MAP_SHARED, u->fd, 0)) == MAP_FAILED) {
 477             if (mode == O_RDWR) {
 478                 pa_log("mmap failed for input. Changing to O_WRONLY mode.");
 479                 mode = O_WRONLY;
 480             } else {
 481                 pa_log("mmap(): %s", pa_cstrerror(errno));
 482                 goto fail;
 483             }
 484         } else {
 485             if ((name = pa_modargs_get_value(ma, "source_name", NULL)))
 486                 namereg_fail = 1;
 487             else {
 488                 name = name_buf = pa_sprintf_malloc("oss_input.%s", pa_path_get_filename(p));
 489                 namereg_fail = 0;
 490             }
 491
 492             if (!(u->source = pa_source_new(c, __FILE__, name, namereg_fail, &u->sample_spec, &map)))
 493                 goto fail;
 494
 495             u->source->userdata = u;
 496             u->source->get_latency = source_get_latency_cb;
 497             u->source->get_hw_volume = source_get_hw_volume;
 498             u->source->set_hw_volume = source_set_hw_volume;
 499             pa_source_set_owner(u->source, m);
 500             pa_source_set_description(u->source, t = pa_sprintf_malloc("OSS PCM/mmap() on %s%s%s%s",
 501                                                                        p,
 502                                                                        hwdesc[0] ? " (" : "",
 503                                                                        hwdesc[0] ? hwdesc : "",
 504                                                                        hwdesc[0] ? ")" : ""));
 505             pa_xfree(t);
 506             u->source->is_hardware = 1;
 507
 508             u->in_memblocks = pa_xnew0(pa_memblock*, u->in_fragments);
 509
 510             enable_bits |= PCM_ENABLE_INPUT;
 511         }
 512     }
 513
 514     pa_xfree(name_buf);
 515     name_buf = NULL;
 516
 517     if (mode != O_RDONLY) {
 518         if (ioctl(u->fd, SNDCTL_DSP_GETOSPACE, &info) < 0) {
 519             pa_log("SNDCTL_DSP_GETOSPACE: %s", pa_cstrerror(errno));
 520             goto fail;
 521         }
 522
 523         pa_log_info("output -- %u fragments of size %u.", info.fragstotal, info.fragsize);
 524         u->out_mmap_length = (u->out_fragment_size = info.fragsize) * (u->out_fragments = info.fragstotal);
 525
 526         if ((u->out_mmap = mmap(NULL, u->out_mmap_length, PROT_WRITE, MAP_SHARED, u->fd, 0))  == MAP_FAILED) {
 527             if (mode == O_RDWR) {
 528                 pa_log("mmap filed for output. Changing to O_RDONLY mode.");
 529                 mode = O_RDONLY;
 530             } else {
 531                 pa_log("mmap(): %s", pa_cstrerror(errno));
 532                 goto fail;
 533             }
 534         } else {
 535             pa_silence_memory(u->out_mmap, u->out_mmap_length, &u->sample_spec);
 536
 537             if ((name = pa_modargs_get_value(ma, "sink_name", NULL)))
 538                 namereg_fail = 1;
 539             else {
 540                 name = name_buf = pa_sprintf_malloc("oss_output.%s", pa_path_get_filename(p));
 541                 namereg_fail = 0;
 542             }
 543
 544             if (!(u->sink = pa_sink_new(c, __FILE__, name, namereg_fail, &u->sample_spec, &map)))
 545                 goto fail;
 546
 547             u->sink->get_latency = sink_get_latency_cb;
 548             u->sink->get_hw_volume = sink_get_hw_volume;
 549             u->sink->set_hw_volume = sink_set_hw_volume;
 550             u->sink->userdata = u;
 551             pa_sink_set_owner(u->sink, m);
 552             pa_sink_set_description(u->sink, t = pa_sprintf_malloc("OSS PCM/mmap() on %s%s%s%s",
 553                                                                    p,
 554                                                                    hwdesc[0] ? " (" : "",
 555                                                                    hwdesc[0] ? hwdesc : "",
 556                                                                    hwdesc[0] ? ")" : ""));
 557             pa_xfree(t);
 558
 559             u->sink->is_hardware = 1;
 560             u->out_memblocks = pa_xmalloc0(sizeof(struct memblock *)*u->out_fragments);
 561
 562             enable_bits |= PCM_ENABLE_OUTPUT;
 563         }
 564     }
 565
 566     pa_xfree(name_buf);
 567     name_buf = NULL;
 568
 569     zero = 0;
 570     if (ioctl(u->fd, SNDCTL_DSP_SETTRIGGER, &zero) < 0) {
 571         pa_log("SNDCTL_DSP_SETTRIGGER: %s", pa_cstrerror(errno));
 572         goto fail;
 573     }
 574
 575     if (ioctl(u->fd, SNDCTL_DSP_SETTRIGGER, &enable_bits) < 0) {
 576         pa_log("SNDCTL_DSP_SETTRIGGER: %s", pa_cstrerror(errno));
 577         goto fail;
 578     }
 579
 580     assert(u->source || u->sink);
 581
 582     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);
 583     assert(u->io_event);
 584
 585     pa_modargs_free(ma);
 586
 587     /* Read mixer settings */
 588     if (u->source)
 589         source_get_hw_volume(u->source);
 590     if (u->sink)
 591         sink_get_hw_volume(u->sink);
 592
 593     return 0;
 594
 595 fail:
 596     pa__done(c, m);
 597
 598     if (ma)
 599         pa_modargs_free(ma);
 600
 601     pa_xfree(name_buf);
 602
 603     return -1;
 604 }
 605
 606 void pa__done(pa_core *c, pa_module*m) {
 607     struct userdata *u;
 608
 609     assert(c);
 610     assert(m);
 611
 612     if (!(u = m->userdata))
 613         return;
 614
 615     clear_up(u);
 616
 617     if (u->out_memblocks) {
 618         unsigned i;
 619         for (i = 0; i < u->out_fragments; i++)
 620             if (u->out_memblocks[i])
 621                 pa_memblock_unref_fixed(u->out_memblocks[i]);
 622         pa_xfree(u->out_memblocks);
 623     }
 624
 625     if (u->in_memblocks) {
 626         unsigned i;
 627         for (i = 0; i < u->in_fragments; i++)
 628             if (u->in_memblocks[i])
 629                 pa_memblock_unref_fixed(u->in_memblocks[i]);
 630         pa_xfree(u->in_memblocks);
 631     }
 632
 633     pa_xfree(u);
 634 }