src/modules/module-waveout.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 <windows.h>
  27 #include <mmsystem.h>
  28 #include <assert.h>
  29
  30 #include <pulse/mainloop-api.h>
  31
  32 #include <pulse/xmalloc.h>
  33 #include <pulse/timeval.h>
  34
  35 #include <pulsecore/sink.h>
  36 #include <pulsecore/source.h>
  37 #include <pulsecore/module.h>
  38 #include <pulsecore/modargs.h>
  39 #include <pulsecore/sample-util.h>
  40 #include <pulsecore/core-util.h>
  41 #include <pulsecore/log.h>
  42
  43 #include "module-waveout-symdef.h"
  44
  45 PA_MODULE_AUTHOR("Pierre Ossman")
  46 PA_MODULE_DESCRIPTION("Windows waveOut Sink/Source")
  47 PA_MODULE_VERSION(PACKAGE_VERSION)
  48 PA_MODULE_USAGE(
  49     "sink_name=<name for the sink> "
  50     "source_name=<name for the source>"
  51     "record=<enable source?> "
  52     "playback=<enable sink?> "
  53     "format=<sample format> "
  54     "channels=<number of channels> "
  55     "rate=<sample rate> "
  56     "fragments=<number of fragments> "
  57     "fragment_size=<fragment size> "
  58     "channel_map=<channel map>")
  59
  60 #define DEFAULT_SINK_NAME "wave_output"
  61 #define DEFAULT_SOURCE_NAME "wave_input"
  62
  63 #define WAVEOUT_MAX_VOLUME 0xFFFF
  64
  65 struct userdata {
  66     pa_sink *sink;
  67     pa_source *source;
  68     pa_core *core;
  69     pa_time_event *event;
  70     pa_defer_event *defer;
  71     pa_usec_t poll_timeout;
  72
  73     uint32_t fragments, fragment_size;
  74
  75     uint32_t free_ofrags, free_ifrags;
  76
  77     DWORD written_bytes;
  78
  79     int cur_ohdr, cur_ihdr;
  80     unsigned int oremain;
  81     WAVEHDR *ohdrs, *ihdrs;
  82     pa_memchunk silence;
  83
  84     HWAVEOUT hwo;
  85     HWAVEIN hwi;
  86     pa_module *module;
  87
  88     CRITICAL_SECTION crit;
  89 };
  90
  91 static const char* const valid_modargs[] = {
  92     "sink_name",
  93     "source_name",
  94     "record",
  95     "playback",
  96     "fragments",
  97     "fragment_size",
  98     "format",
  99     "rate",
 100     "channels",
 101     "channel_map",
 102     NULL
 103 };
 104
 105 static void update_usage(struct userdata *u) {
 106    pa_module_set_used(u->module,
 107                       (u->sink ? pa_sink_used_by(u->sink) : 0) +
 108                       (u->source ? pa_source_used_by(u->source) : 0));
 109 }
 110
 111 static void do_write(struct userdata *u)
 112 {
 113     uint32_t free_frags, remain;
 114     pa_memchunk memchunk, *cur_chunk;
 115     WAVEHDR *hdr;
 116     MMRESULT res;
 117
 118     if (!u->sink)
 119         return;
 120
 121     EnterCriticalSection(&u->crit);
 122
 123     free_frags = u->free_ofrags;
 124     u->free_ofrags = 0;
 125
 126     LeaveCriticalSection(&u->crit);
 127
 128     if (free_frags == u->fragments)
 129         pa_log_debug("WaveOut underflow!");
 130
 131     while (free_frags) {
 132         hdr = &u->ohdrs[u->cur_ohdr];
 133         if (hdr->dwFlags & WHDR_PREPARED)
 134             waveOutUnprepareHeader(u->hwo, hdr, sizeof(WAVEHDR));
 135
 136         remain = u->oremain;
 137         while (remain) {
 138             cur_chunk = &memchunk;
 139
 140             if (pa_sink_render(u->sink, remain, cur_chunk) < 0) {
 141                 /*
 142                  * Don't fill with silence unless we're getting close to
 143                  * underflowing.
 144                  */
 145                 if (free_frags > u->fragments/2)
 146                     cur_chunk = &u->silence;
 147                 else {
 148                     EnterCriticalSection(&u->crit);
 149
 150                     u->free_ofrags += free_frags;
 151
 152                     LeaveCriticalSection(&u->crit);
 153
 154                     u->oremain = remain;
 155                     return;
 156                 }
 157             }
 158
 159             assert(cur_chunk->memblock);
 160             assert(cur_chunk->memblock->data);
 161             assert(cur_chunk->length);
 162
 163             memcpy(hdr->lpData + u->fragment_size - remain,
 164                 (char*)cur_chunk->memblock->data + cur_chunk->index,
 165                 (cur_chunk->length < remain)?cur_chunk->length:remain);
 166
 167             remain -= (cur_chunk->length < remain)?cur_chunk->length:remain;
 168
 169             if (cur_chunk != &u->silence) {
 170                 pa_memblock_unref(cur_chunk->memblock);
 171                 cur_chunk->memblock = NULL;
 172             }
 173         }
 174
 175         res = waveOutPrepareHeader(u->hwo, hdr, sizeof(WAVEHDR));
 176         if (res != MMSYSERR_NOERROR) {
 177             pa_log_error(__FILE__ ": ERROR: Unable to prepare waveOut block: %d",
 178                 res);
 179         }
 180         res = waveOutWrite(u->hwo, hdr, sizeof(WAVEHDR));
 181         if (res != MMSYSERR_NOERROR) {
 182             pa_log_error(__FILE__ ": ERROR: Unable to write waveOut block: %d",
 183                 res);
 184         }
 185
 186         u->written_bytes += u->fragment_size;
 187
 188         free_frags--;
 189         u->cur_ohdr++;
 190         u->cur_ohdr %= u->fragments;
 191         u->oremain = u->fragment_size;
 192     }
 193 }
 194
 195 static void do_read(struct userdata *u)
 196 {
 197     uint32_t free_frags;
 198     pa_memchunk memchunk;
 199     WAVEHDR *hdr;
 200     MMRESULT res;
 201
 202     if (!u->source)
 203         return;
 204
 205     EnterCriticalSection(&u->crit);
 206
 207     free_frags = u->free_ifrags;
 208     u->free_ifrags = 0;
 209
 210     LeaveCriticalSection(&u->crit);
 211
 212     if (free_frags == u->fragments)
 213         pa_log_debug("WaveIn overflow!");
 214
 215     while (free_frags) {
 216         hdr = &u->ihdrs[u->cur_ihdr];
 217         if (hdr->dwFlags & WHDR_PREPARED)
 218             waveInUnprepareHeader(u->hwi, hdr, sizeof(WAVEHDR));
 219
 220         if (hdr->dwBytesRecorded) {
 221             memchunk.memblock = pa_memblock_new(u->core->mempool, hdr->dwBytesRecorded);
 222             assert(memchunk.memblock);
 223
 224             memcpy((char*)memchunk.memblock->data, hdr->lpData, hdr->dwBytesRecorded);
 225
 226             memchunk.length = memchunk.memblock->length = hdr->dwBytesRecorded;
 227             memchunk.index = 0;
 228
 229             pa_source_post(u->source, &memchunk);
 230             pa_memblock_unref(memchunk.memblock);
 231         }
 232
 233         res = waveInPrepareHeader(u->hwi, hdr, sizeof(WAVEHDR));
 234         if (res != MMSYSERR_NOERROR) {
 235             pa_log_error(__FILE__ ": ERROR: Unable to prepare waveIn block: %d",
 236                 res);
 237         }
 238         res = waveInAddBuffer(u->hwi, hdr, sizeof(WAVEHDR));
 239         if (res != MMSYSERR_NOERROR) {
 240             pa_log_error(__FILE__ ": ERROR: Unable to add waveIn block: %d",
 241                 res);
 242         }
 243
 244         free_frags--;
 245         u->cur_ihdr++;
 246         u->cur_ihdr %= u->fragments;
 247     }
 248 }
 249
 250 static void poll_cb(pa_mainloop_api*a, pa_time_event *e, const struct timeval *tv, void *userdata) {
 251     struct userdata *u = userdata;
 252     struct timeval ntv;
 253
 254     assert(u);
 255
 256     update_usage(u);
 257
 258     do_write(u);
 259     do_read(u);
 260
 261     pa_gettimeofday(&ntv);
 262     pa_timeval_add(&ntv, u->poll_timeout);
 263
 264     a->time_restart(e, &ntv);
 265 }
 266
 267 static void defer_cb(pa_mainloop_api*a, pa_defer_event *e, void *userdata) {
 268     struct userdata *u = userdata;
 269
 270     assert(u);
 271
 272     a->defer_enable(e, 0);
 273
 274     do_write(u);
 275     do_read(u);
 276 }
 277
 278 static void CALLBACK chunk_done_cb(HWAVEOUT hwo, UINT msg, DWORD_PTR inst, DWORD param1, DWORD param2) {
 279     struct userdata *u = (struct userdata *)inst;
 280
 281     if (msg != WOM_DONE)
 282         return;
 283
 284     EnterCriticalSection(&u->crit);
 285
 286     u->free_ofrags++;
 287     assert(u->free_ofrags <= u->fragments);
 288
 289     LeaveCriticalSection(&u->crit);
 290 }
 291
 292 static void CALLBACK chunk_ready_cb(HWAVEIN hwi, UINT msg, DWORD_PTR inst, DWORD param1, DWORD param2) {
 293     struct userdata *u = (struct userdata *)inst;
 294
 295     if (msg != WIM_DATA)
 296         return;
 297
 298     EnterCriticalSection(&u->crit);
 299
 300     u->free_ifrags++;
 301     assert(u->free_ifrags <= u->fragments);
 302
 303     LeaveCriticalSection(&u->crit);
 304 }
 305
 306 static pa_usec_t sink_get_latency_cb(pa_sink *s) {
 307     struct userdata *u = s->userdata;
 308     uint32_t free_frags;
 309     MMTIME mmt;
 310     assert(s && u && u->sink);
 311
 312     memset(&mmt, 0, sizeof(mmt));
 313     mmt.wType = TIME_BYTES;
 314     if (waveOutGetPosition(u->hwo, &mmt, sizeof(mmt)) == MMSYSERR_NOERROR)
 315         return pa_bytes_to_usec(u->written_bytes - mmt.u.cb, &s->sample_spec);
 316     else {
 317         EnterCriticalSection(&u->crit);
 318
 319         free_frags = u->free_ofrags;
 320
 321         LeaveCriticalSection(&u->crit);
 322
 323         return pa_bytes_to_usec((u->fragments - free_frags) * u->fragment_size,
 324                               &s->sample_spec);
 325     }
 326 }
 327
 328 static pa_usec_t source_get_latency_cb(pa_source *s) {
 329     pa_usec_t r = 0;
 330     struct userdata *u = s->userdata;
 331     uint32_t free_frags;
 332     assert(s && u && u->sink);
 333
 334     EnterCriticalSection(&u->crit);
 335
 336     free_frags = u->free_ifrags;
 337
 338     LeaveCriticalSection(&u->crit);
 339
 340     r += pa_bytes_to_usec((free_frags + 1) * u->fragment_size, &s->sample_spec);
 341
 342     return r;
 343 }
 344
 345 static void notify_sink_cb(pa_sink *s) {
 346     struct userdata *u = s->userdata;
 347     assert(u);
 348
 349     u->core->mainloop->defer_enable(u->defer, 1);
 350 }
 351
 352 static void notify_source_cb(pa_source *s) {
 353     struct userdata *u = s->userdata;
 354     assert(u);
 355
 356     u->core->mainloop->defer_enable(u->defer, 1);
 357 }
 358
 359 static int sink_get_hw_volume_cb(pa_sink *s) {
 360     struct userdata *u = s->userdata;
 361     DWORD vol;
 362     pa_volume_t left, right;
 363
 364     if (waveOutGetVolume(u->hwo, &vol) != MMSYSERR_NOERROR)
 365         return -1;
 366
 367     left = (vol & 0xFFFF) * PA_VOLUME_NORM / WAVEOUT_MAX_VOLUME;
 368     right = ((vol >> 16) & 0xFFFF) * PA_VOLUME_NORM / WAVEOUT_MAX_VOLUME;
 369
 370     /* Windows supports > 2 channels, except for volume control */
 371     if (s->hw_volume.channels > 2)
 372         pa_cvolume_set(&s->hw_volume, s->hw_volume.channels, (left + right)/2);
 373
 374     s->hw_volume.values[0] = left;
 375     if (s->hw_volume.channels > 1)
 376         s->hw_volume.values[1] = right;
 377
 378     return 0;
 379 }
 380
 381 static int sink_set_hw_volume_cb(pa_sink *s) {
 382     struct userdata *u = s->userdata;
 383     DWORD vol;
 384
 385     vol = s->hw_volume.values[0] * WAVEOUT_MAX_VOLUME / PA_VOLUME_NORM;
 386     if (s->hw_volume.channels > 1)
 387         vol |= (s->hw_volume.values[0] * WAVEOUT_MAX_VOLUME / PA_VOLUME_NORM) << 16;
 388
 389     if (waveOutSetVolume(u->hwo, vol) != MMSYSERR_NOERROR)
 390         return -1;
 391
 392     return 0;
 393 }
 394
 395 static int ss_to_waveformat(pa_sample_spec *ss, LPWAVEFORMATEX wf) {
 396     wf->wFormatTag = WAVE_FORMAT_PCM;
 397
 398     if (ss->channels > 2) {
 399         pa_log_error("ERROR: More than two channels not supported.");
 400         return -1;
 401     }
 402
 403     wf->nChannels = ss->channels;
 404
 405     switch (ss->rate) {
 406     case 8000:
 407     case 11025:
 408     case 22005:
 409     case 44100:
 410         break;
 411     default:
 412         pa_log_error("ERROR: Unsupported sample rate.");
 413         return -1;
 414     }
 415
 416     wf->nSamplesPerSec = ss->rate;
 417
 418     if (ss->format == PA_SAMPLE_U8)
 419         wf->wBitsPerSample = 8;
 420     else if (ss->format == PA_SAMPLE_S16NE)
 421         wf->wBitsPerSample = 16;
 422     else {
 423         pa_log_error("ERROR: Unsupported sample format.");
 424         return -1;
 425     }
 426
 427     wf->nBlockAlign = wf->nChannels * wf->wBitsPerSample/8;
 428     wf->nAvgBytesPerSec = wf->nSamplesPerSec * wf->nBlockAlign;
 429
 430     wf->cbSize = 0;
 431
 432     return 0;
 433 }
 434
 435 int pa__init(pa_core *c, pa_module*m) {
 436     struct userdata *u = NULL;
 437     HWAVEOUT hwo = INVALID_HANDLE_VALUE;
 438     HWAVEIN hwi = INVALID_HANDLE_VALUE;
 439     WAVEFORMATEX wf;
 440     int nfrags, frag_size;
 441     int record = 1, playback = 1;
 442     pa_sample_spec ss;
 443     pa_channel_map map;
 444     pa_modargs *ma = NULL;
 445     unsigned int i;
 446     struct timeval tv;
 447
 448     assert(c && m);
 449
 450     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 451         pa_log("failed to parse module arguments.");
 452         goto fail;
 453     }
 454
 455     if (pa_modargs_get_value_boolean(ma, "record", &record) < 0 || pa_modargs_get_value_boolean(ma, "playback", &playback) < 0) {
 456         pa_log("record= and playback= expect boolean argument.");
 457         goto fail;
 458     }
 459
 460     if (!playback && !record) {
 461         pa_log("neither playback nor record enabled for device.");
 462         goto fail;
 463     }
 464
 465     nfrags = 5;
 466     frag_size = 8192;
 467     if (pa_modargs_get_value_s32(ma, "fragments", &nfrags) < 0 || pa_modargs_get_value_s32(ma, "fragment_size", &frag_size) < 0) {
 468         pa_log("failed to parse fragments arguments");
 469         goto fail;
 470     }
 471
 472     ss = c->default_sample_spec;
 473     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_WAVEEX) < 0) {
 474         pa_log("failed to parse sample specification");
 475         goto fail;
 476     }
 477
 478     if (ss_to_waveformat(&ss, &wf) < 0)
 479         goto fail;
 480
 481     u = pa_xmalloc(sizeof(struct userdata));
 482
 483     if (record) {
 484         if (waveInOpen(&hwi, WAVE_MAPPER, &wf, (DWORD_PTR)chunk_ready_cb, (DWORD_PTR)u, CALLBACK_FUNCTION) != MMSYSERR_NOERROR) {
 485             pa_log("failed to open waveIn");
 486             goto fail;
 487         }
 488         if (waveInStart(hwi) != MMSYSERR_NOERROR) {
 489             pa_log("failed to start waveIn");
 490             goto fail;
 491         }
 492         pa_log_debug("Opened waveIn subsystem.");
 493     }
 494
 495     if (playback) {
 496         if (waveOutOpen(&hwo, WAVE_MAPPER, &wf, (DWORD_PTR)chunk_done_cb, (DWORD_PTR)u, CALLBACK_FUNCTION) != MMSYSERR_NOERROR) {
 497             pa_log("failed to open waveOut");
 498             goto fail;
 499         }
 500         pa_log_debug("Opened waveOut subsystem.");
 501     }
 502
 503     InitializeCriticalSection(&u->crit);
 504
 505     if (hwi != INVALID_HANDLE_VALUE) {
 506         u->source = pa_source_new(c, __FILE__, pa_modargs_get_value(ma, "source_name", DEFAULT_SOURCE_NAME), 0, &ss, &map);
 507         assert(u->source);
 508         u->source->userdata = u;
 509         u->source->notify = notify_source_cb;
 510         u->source->get_latency = source_get_latency_cb;
 511         pa_source_set_owner(u->source, m);
 512         pa_source_set_description(u->source, "Windows waveIn PCM");
 513         u->source->is_hardware = 1;
 514     } else
 515         u->source = NULL;
 516
 517     if (hwo != INVALID_HANDLE_VALUE) {
 518         u->sink = pa_sink_new(c, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, &map);
 519         assert(u->sink);
 520         u->sink->notify = notify_sink_cb;
 521         u->sink->get_latency = sink_get_latency_cb;
 522         u->sink->get_hw_volume = sink_get_hw_volume_cb;
 523         u->sink->set_hw_volume = sink_set_hw_volume_cb;
 524         u->sink->userdata = u;
 525         pa_sink_set_owner(u->sink, m);
 526         pa_sink_set_description(u->sink, "Windows waveOut PCM");
 527         u->sink->is_hardware = 1;
 528     } else
 529         u->sink = NULL;
 530
 531     assert(u->source || u->sink);
 532
 533     u->core = c;
 534     u->hwi = hwi;
 535     u->hwo = hwo;
 536
 537     u->fragments = nfrags;
 538     u->free_ifrags = u->fragments;
 539     u->free_ofrags = u->fragments;
 540     u->fragment_size = frag_size - (frag_size % pa_frame_size(&ss));
 541
 542     u->written_bytes = 0;
 543
 544     u->oremain = u->fragment_size;
 545
 546     u->poll_timeout = pa_bytes_to_usec(u->fragments * u->fragment_size / 10, &ss);
 547
 548     pa_gettimeofday(&tv);
 549     pa_timeval_add(&tv, u->poll_timeout);
 550
 551     u->event = c->mainloop->time_new(c->mainloop, &tv, poll_cb, u);
 552     assert(u->event);
 553
 554     u->defer = c->mainloop->defer_new(c->mainloop, defer_cb, u);
 555     assert(u->defer);
 556     c->mainloop->defer_enable(u->defer, 0);
 557
 558     u->cur_ihdr = 0;
 559     u->cur_ohdr = 0;
 560     u->ihdrs = pa_xmalloc0(sizeof(WAVEHDR) * u->fragments);
 561     assert(u->ihdrs);
 562     u->ohdrs = pa_xmalloc0(sizeof(WAVEHDR) * u->fragments);
 563     assert(u->ohdrs);
 564     for (i = 0;i < u->fragments;i++) {
 565         u->ihdrs[i].dwBufferLength = u->fragment_size;
 566         u->ohdrs[i].dwBufferLength = u->fragment_size;
 567         u->ihdrs[i].lpData = pa_xmalloc(u->fragment_size);
 568         assert(u->ihdrs);
 569         u->ohdrs[i].lpData = pa_xmalloc(u->fragment_size);
 570         assert(u->ohdrs);
 571     }
 572
 573     u->silence.length = u->fragment_size;
 574     u->silence.memblock = pa_memblock_new(u->core->mempool, u->silence.length);
 575     assert(u->silence.memblock);
 576     pa_silence_memblock(u->silence.memblock, &ss);
 577     u->silence.index = 0;
 578
 579     u->module = m;
 580     m->userdata = u;
 581
 582     pa_modargs_free(ma);
 583
 584     /* Read mixer settings */
 585     if (u->sink)
 586         sink_get_hw_volume_cb(u->sink);
 587
 588     return 0;
 589
 590 fail:
 591    if (hwi != INVALID_HANDLE_VALUE)
 592         waveInClose(hwi);
 593
 594    if (hwo != INVALID_HANDLE_VALUE)
 595         waveOutClose(hwo);
 596
 597     if (u)
 598         pa_xfree(u);
 599
 600     if (ma)
 601         pa_modargs_free(ma);
 602
 603     return -1;
 604 }
 605
 606 void pa__done(pa_core *c, pa_module*m) {
 607     struct userdata *u;
 608     unsigned int i;
 609
 610     assert(c && m);
 611
 612     if (!(u = m->userdata))
 613         return;
 614
 615     if (u->event)
 616         c->mainloop->time_free(u->event);
 617
 618     if (u->defer)
 619         c->mainloop->defer_free(u->defer);
 620
 621     if (u->sink) {
 622         pa_sink_disconnect(u->sink);
 623         pa_sink_unref(u->sink);
 624     }
 625
 626     if (u->source) {
 627         pa_source_disconnect(u->source);
 628         pa_source_unref(u->source);
 629     }
 630
 631     if (u->hwi != INVALID_HANDLE_VALUE) {
 632         waveInReset(u->hwi);
 633         waveInClose(u->hwi);
 634     }
 635
 636     if (u->hwo != INVALID_HANDLE_VALUE) {
 637         waveOutReset(u->hwo);
 638         waveOutClose(u->hwo);
 639     }
 640
 641     for (i = 0;i < u->fragments;i++) {
 642         pa_xfree(u->ihdrs[i].lpData);
 643         pa_xfree(u->ohdrs[i].lpData);
 644     }
 645
 646     pa_xfree(u->ihdrs);
 647     pa_xfree(u->ohdrs);
 648
 649     DeleteCriticalSection(&u->crit);
 650
 651     pa_xfree(u);
 652 }