audio/audio_template.h

   1 /*
   2  * QEMU Audio subsystem header
   3  *
   4  * Copyright (c) 2005 Vassili Karpov (malc)
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #ifdef DAC
  26 #define NAME "playback"
  27 #define HWBUF hw->mix_buf
  28 #define TYPE out
  29 #define HW HWVoiceOut
  30 #define SW SWVoiceOut
  31 #else
  32 #define NAME "capture"
  33 #define TYPE in
  34 #define HW HWVoiceIn
  35 #define SW SWVoiceIn
  36 #define HWBUF hw->conv_buf
  37 #endif
  38
  39 static void glue(audio_init_nb_voices_, TYPE)(AudioState *s,
  40                                               struct audio_driver *drv)
  41 {
  42     int max_voices = glue (drv->max_voices_, TYPE);
  43     int voice_size = glue (drv->voice_size_, TYPE);
  44
  45     if (glue (s->nb_hw_voices_, TYPE) > max_voices) {
  46         if (!max_voices) {
  47 #ifdef DAC
  48             dolog ("Driver `%s' does not support " NAME "\n", drv->name);
  49 #endif
  50         } else {
  51             dolog ("Driver `%s' does not support %d " NAME " voices, max %d\n",
  52                    drv->name,
  53                    glue (s->nb_hw_voices_, TYPE),
  54                    max_voices);
  55         }
  56         glue (s->nb_hw_voices_, TYPE) = max_voices;
  57     }
  58
  59     if (audio_bug(__func__, !voice_size && max_voices)) {
  60         dolog ("drv=`%s' voice_size=0 max_voices=%d\n",
  61                drv->name, max_voices);
  62         glue (s->nb_hw_voices_, TYPE) = 0;
  63     }
  64
  65     if (audio_bug(__func__, voice_size && !max_voices)) {
  66         dolog ("drv=`%s' voice_size=%d max_voices=0\n",
  67                drv->name, voice_size);
  68     }
  69 }
  70
  71 static void glue (audio_pcm_hw_free_resources_, TYPE) (HW *hw)
  72 {
  73     g_free(hw->buf_emul);
  74     g_free (HWBUF);
  75     HWBUF = NULL;
  76 }
  77
  78 static void glue(audio_pcm_hw_alloc_resources_, TYPE)(HW *hw)
  79 {
  80     if (glue(audio_get_pdo_, TYPE)(hw->s->dev)->mixing_engine) {
  81         size_t samples = hw->samples;
  82         if (audio_bug(__func__, samples == 0)) {
  83             dolog("Attempted to allocate empty buffer\n");
  84         }
  85
  86         HWBUF = g_malloc0(sizeof(STSampleBuffer) + sizeof(st_sample) * samples);
  87         HWBUF->size = samples;
  88     } else {
  89         HWBUF = NULL;
  90     }
  91 }
  92
  93 static void glue (audio_pcm_sw_free_resources_, TYPE) (SW *sw)
  94 {
  95     g_free (sw->buf);
  96
  97     if (sw->rate) {
  98         st_rate_stop (sw->rate);
  99     }
 100
 101     sw->buf = NULL;
 102     sw->rate = NULL;
 103 }
 104
 105 static int glue (audio_pcm_sw_alloc_resources_, TYPE) (SW *sw)
 106 {
 107     int samples;
 108
 109     if (!glue(audio_get_pdo_, TYPE)(sw->s->dev)->mixing_engine) {
 110         return 0;
 111     }
 112
 113 #ifdef DAC
 114     samples = ((int64_t) sw->HWBUF->size << 32) / sw->ratio;
 115 #else
 116     samples = (int64_t)sw->HWBUF->size * sw->ratio >> 32;
 117 #endif
 118
 119     sw->buf = audio_calloc(__func__, samples, sizeof(struct st_sample));
 120     if (!sw->buf) {
 121         dolog ("Could not allocate buffer for `%s' (%d samples)\n",
 122                SW_NAME (sw), samples);
 123         return -1;
 124     }
 125
 126 #ifdef DAC
 127     sw->rate = st_rate_start (sw->info.freq, sw->hw->info.freq);
 128 #else
 129     sw->rate = st_rate_start (sw->hw->info.freq, sw->info.freq);
 130 #endif
 131     if (!sw->rate) {
 132         g_free (sw->buf);
 133         sw->buf = NULL;
 134         return -1;
 135     }
 136     return 0;
 137 }
 138
 139 static int glue (audio_pcm_sw_init_, TYPE) (
 140     SW *sw,
 141     HW *hw,
 142     const char *name,
 143     struct audsettings *as
 144     )
 145 {
 146     int err;
 147
 148     audio_pcm_init_info (&sw->info, as);
 149     sw->hw = hw;
 150     sw->active = 0;
 151 #ifdef DAC
 152     sw->ratio = ((int64_t) sw->hw->info.freq << 32) / sw->info.freq;
 153     sw->total_hw_samples_mixed = 0;
 154     sw->empty = 1;
 155 #else
 156     sw->ratio = ((int64_t) sw->info.freq << 32) / sw->hw->info.freq;
 157 #endif
 158
 159     if (sw->info.is_float) {
 160 #ifdef DAC
 161         sw->conv = mixeng_conv_float[sw->info.nchannels == 2];
 162 #else
 163         sw->clip = mixeng_clip_float[sw->info.nchannels == 2];
 164 #endif
 165     } else {
 166 #ifdef DAC
 167         sw->conv = mixeng_conv
 168 #else
 169         sw->clip = mixeng_clip
 170 #endif
 171             [sw->info.nchannels == 2]
 172             [sw->info.is_signed]
 173             [sw->info.swap_endianness]
 174             [audio_bits_to_index(sw->info.bits)];
 175     }
 176
 177     sw->name = g_strdup (name);
 178     err = glue (audio_pcm_sw_alloc_resources_, TYPE) (sw);
 179     if (err) {
 180         g_free (sw->name);
 181         sw->name = NULL;
 182     }
 183     return err;
 184 }
 185
 186 static void glue (audio_pcm_sw_fini_, TYPE) (SW *sw)
 187 {
 188     glue (audio_pcm_sw_free_resources_, TYPE) (sw);
 189     g_free (sw->name);
 190     sw->name = NULL;
 191 }
 192
 193 static void glue (audio_pcm_hw_add_sw_, TYPE) (HW *hw, SW *sw)
 194 {
 195     QLIST_INSERT_HEAD (&hw->sw_head, sw, entries);
 196 }
 197
 198 static void glue (audio_pcm_hw_del_sw_, TYPE) (SW *sw)
 199 {
 200     QLIST_REMOVE (sw, entries);
 201 }
 202
 203 static void glue (audio_pcm_hw_gc_, TYPE) (HW **hwp)
 204 {
 205     HW *hw = *hwp;
 206     AudioState *s = hw->s;
 207
 208     if (!hw->sw_head.lh_first) {
 209 #ifdef DAC
 210         audio_detach_capture(hw);
 211 #endif
 212         QLIST_REMOVE(hw, entries);
 213         glue(hw->pcm_ops->fini_, TYPE) (hw);
 214         glue(s->nb_hw_voices_, TYPE) += 1;
 215         glue(audio_pcm_hw_free_resources_ , TYPE) (hw);
 216         g_free(hw);
 217         *hwp = NULL;
 218     }
 219 }
 220
 221 static HW *glue(audio_pcm_hw_find_any_, TYPE)(AudioState *s, HW *hw)
 222 {
 223     return hw ? hw->entries.le_next : glue (s->hw_head_, TYPE).lh_first;
 224 }
 225
 226 static HW *glue(audio_pcm_hw_find_any_enabled_, TYPE)(AudioState *s, HW *hw)
 227 {
 228     while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
 229         if (hw->enabled) {
 230             return hw;
 231         }
 232     }
 233     return NULL;
 234 }
 235
 236 static HW *glue(audio_pcm_hw_find_specific_, TYPE)(AudioState *s, HW *hw,
 237                                                    struct audsettings *as)
 238 {
 239     while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
 240         if (audio_pcm_info_eq (&hw->info, as)) {
 241             return hw;
 242         }
 243     }
 244     return NULL;
 245 }
 246
 247 static HW *glue(audio_pcm_hw_add_new_, TYPE)(AudioState *s,
 248                                              struct audsettings *as)
 249 {
 250     HW *hw;
 251     struct audio_driver *drv = s->drv;
 252
 253     if (!glue (s->nb_hw_voices_, TYPE)) {
 254         return NULL;
 255     }
 256
 257     if (audio_bug(__func__, !drv)) {
 258         dolog ("No host audio driver\n");
 259         return NULL;
 260     }
 261
 262     if (audio_bug(__func__, !drv->pcm_ops)) {
 263         dolog ("Host audio driver without pcm_ops\n");
 264         return NULL;
 265     }
 266
 267     hw = audio_calloc(__func__, 1, glue(drv->voice_size_, TYPE));
 268     if (!hw) {
 269         dolog ("Can not allocate voice `%s' size %d\n",
 270                drv->name, glue (drv->voice_size_, TYPE));
 271         return NULL;
 272     }
 273
 274     hw->s = s;
 275     hw->pcm_ops = drv->pcm_ops;
 276
 277     QLIST_INIT (&hw->sw_head);
 278 #ifdef DAC
 279     QLIST_INIT (&hw->cap_head);
 280 #endif
 281     if (glue (hw->pcm_ops->init_, TYPE) (hw, as, s->drv_opaque)) {
 282         goto err0;
 283     }
 284
 285     if (audio_bug(__func__, hw->samples <= 0)) {
 286         dolog("hw->samples=%zd\n", hw->samples);
 287         goto err1;
 288     }
 289
 290     if (hw->info.is_float) {
 291 #ifdef DAC
 292         hw->clip = mixeng_clip_float[hw->info.nchannels == 2];
 293 #else
 294         hw->conv = mixeng_conv_float[hw->info.nchannels == 2];
 295 #endif
 296     } else {
 297 #ifdef DAC
 298         hw->clip = mixeng_clip
 299 #else
 300         hw->conv = mixeng_conv
 301 #endif
 302             [hw->info.nchannels == 2]
 303             [hw->info.is_signed]
 304             [hw->info.swap_endianness]
 305             [audio_bits_to_index(hw->info.bits)];
 306     }
 307
 308     glue(audio_pcm_hw_alloc_resources_, TYPE)(hw);
 309
 310     QLIST_INSERT_HEAD (&s->glue (hw_head_, TYPE), hw, entries);
 311     glue (s->nb_hw_voices_, TYPE) -= 1;
 312 #ifdef DAC
 313     audio_attach_capture (hw);
 314 #endif
 315     return hw;
 316
 317  err1:
 318     glue (hw->pcm_ops->fini_, TYPE) (hw);
 319  err0:
 320     g_free (hw);
 321     return NULL;
 322 }
 323
 324 AudiodevPerDirectionOptions *glue(audio_get_pdo_, TYPE)(Audiodev *dev)
 325 {
 326     switch (dev->driver) {
 327     case AUDIODEV_DRIVER_NONE:
 328         return dev->u.none.TYPE;
 329 #ifdef CONFIG_AUDIO_ALSA
 330     case AUDIODEV_DRIVER_ALSA:
 331         return qapi_AudiodevAlsaPerDirectionOptions_base(dev->u.alsa.TYPE);
 332 #endif
 333 #ifdef CONFIG_AUDIO_COREAUDIO
 334     case AUDIODEV_DRIVER_COREAUDIO:
 335         return qapi_AudiodevCoreaudioPerDirectionOptions_base(
 336             dev->u.coreaudio.TYPE);
 337 #endif
 338 #ifdef CONFIG_DBUS_DISPLAY
 339     case AUDIODEV_DRIVER_DBUS:
 340         return dev->u.dbus.TYPE;
 341 #endif
 342 #ifdef CONFIG_AUDIO_DSOUND
 343     case AUDIODEV_DRIVER_DSOUND:
 344         return dev->u.dsound.TYPE;
 345 #endif
 346 #ifdef CONFIG_AUDIO_JACK
 347     case AUDIODEV_DRIVER_JACK:
 348         return qapi_AudiodevJackPerDirectionOptions_base(dev->u.jack.TYPE);
 349 #endif
 350 #ifdef CONFIG_AUDIO_OSS
 351     case AUDIODEV_DRIVER_OSS:
 352         return qapi_AudiodevOssPerDirectionOptions_base(dev->u.oss.TYPE);
 353 #endif
 354 #ifdef CONFIG_AUDIO_PA
 355     case AUDIODEV_DRIVER_PA:
 356         return qapi_AudiodevPaPerDirectionOptions_base(dev->u.pa.TYPE);
 357 #endif
 358 #ifdef CONFIG_AUDIO_SDL
 359     case AUDIODEV_DRIVER_SDL:
 360         return qapi_AudiodevSdlPerDirectionOptions_base(dev->u.sdl.TYPE);
 361 #endif
 362 #ifdef CONFIG_AUDIO_SNDIO
 363     case AUDIODEV_DRIVER_SNDIO:
 364         return dev->u.sndio.TYPE;
 365 #endif
 366 #ifdef CONFIG_SPICE
 367     case AUDIODEV_DRIVER_SPICE:
 368         return dev->u.spice.TYPE;
 369 #endif
 370     case AUDIODEV_DRIVER_WAV:
 371         return dev->u.wav.TYPE;
 372
 373     case AUDIODEV_DRIVER__MAX:
 374         break;
 375     }
 376     abort();
 377 }
 378
 379 static HW *glue(audio_pcm_hw_add_, TYPE)(AudioState *s, struct audsettings *as)
 380 {
 381     HW *hw;
 382     AudiodevPerDirectionOptions *pdo = glue(audio_get_pdo_, TYPE)(s->dev);
 383
 384     if (!pdo->mixing_engine || pdo->fixed_settings) {
 385         hw = glue(audio_pcm_hw_add_new_, TYPE)(s, as);
 386         if (!pdo->mixing_engine || hw) {
 387             return hw;
 388         }
 389     }
 390
 391     hw = glue(audio_pcm_hw_find_specific_, TYPE)(s, NULL, as);
 392     if (hw) {
 393         return hw;
 394     }
 395
 396     hw = glue(audio_pcm_hw_add_new_, TYPE)(s, as);
 397     if (hw) {
 398         return hw;
 399     }
 400
 401     return glue(audio_pcm_hw_find_any_, TYPE)(s, NULL);
 402 }
 403
 404 static SW *glue(audio_pcm_create_voice_pair_, TYPE)(
 405     AudioState *s,
 406     const char *sw_name,
 407     struct audsettings *as
 408     )
 409 {
 410     SW *sw;
 411     HW *hw;
 412     struct audsettings hw_as;
 413     AudiodevPerDirectionOptions *pdo = glue(audio_get_pdo_, TYPE)(s->dev);
 414
 415     if (pdo->fixed_settings) {
 416         hw_as = audiodev_to_audsettings(pdo);
 417     } else {
 418         hw_as = *as;
 419     }
 420
 421     sw = audio_calloc(__func__, 1, sizeof(*sw));
 422     if (!sw) {
 423         dolog ("Could not allocate soft voice `%s' (%zu bytes)\n",
 424                sw_name ? sw_name : "unknown", sizeof (*sw));
 425         goto err1;
 426     }
 427     sw->s = s;
 428
 429     hw = glue(audio_pcm_hw_add_, TYPE)(s, &hw_as);
 430     if (!hw) {
 431         goto err2;
 432     }
 433
 434     glue (audio_pcm_hw_add_sw_, TYPE) (hw, sw);
 435
 436     if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, sw_name, as)) {
 437         goto err3;
 438     }
 439
 440     return sw;
 441
 442 err3:
 443     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
 444     glue (audio_pcm_hw_gc_, TYPE) (&hw);
 445 err2:
 446     g_free (sw);
 447 err1:
 448     return NULL;
 449 }
 450
 451 static void glue (audio_close_, TYPE) (SW *sw)
 452 {
 453     glue (audio_pcm_sw_fini_, TYPE) (sw);
 454     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
 455     glue (audio_pcm_hw_gc_, TYPE) (&sw->hw);
 456     g_free (sw);
 457 }
 458
 459 void glue (AUD_close_, TYPE) (QEMUSoundCard *card, SW *sw)
 460 {
 461     if (sw) {
 462         if (audio_bug(__func__, !card)) {
 463             dolog ("card=%p\n", card);
 464             return;
 465         }
 466
 467         glue (audio_close_, TYPE) (sw);
 468     }
 469 }
 470
 471 SW *glue (AUD_open_, TYPE) (
 472     QEMUSoundCard *card,
 473     SW *sw,
 474     const char *name,
 475     void *callback_opaque ,
 476     audio_callback_fn callback_fn,
 477     struct audsettings *as
 478     )
 479 {
 480     AudioState *s;
 481     AudiodevPerDirectionOptions *pdo;
 482
 483     if (audio_bug(__func__, !card || !name || !callback_fn || !as)) {
 484         dolog ("card=%p name=%p callback_fn=%p as=%p\n",
 485                card, name, callback_fn, as);
 486         goto fail;
 487     }
 488
 489     s = card->state;
 490     pdo = glue(audio_get_pdo_, TYPE)(s->dev);
 491
 492     ldebug ("open %s, freq %d, nchannels %d, fmt %d\n",
 493             name, as->freq, as->nchannels, as->fmt);
 494
 495     if (audio_bug(__func__, audio_validate_settings(as))) {
 496         audio_print_settings (as);
 497         goto fail;
 498     }
 499
 500     if (audio_bug(__func__, !s->drv)) {
 501         dolog ("Can not open `%s' (no host audio driver)\n", name);
 502         goto fail;
 503     }
 504
 505     if (sw && audio_pcm_info_eq (&sw->info, as)) {
 506         return sw;
 507     }
 508
 509     if (!pdo->fixed_settings && sw) {
 510         glue (AUD_close_, TYPE) (card, sw);
 511         sw = NULL;
 512     }
 513
 514     if (sw) {
 515         HW *hw = sw->hw;
 516
 517         if (!hw) {
 518             dolog ("Internal logic error voice `%s' has no hardware store\n",
 519                    SW_NAME (sw));
 520             goto fail;
 521         }
 522
 523         glue (audio_pcm_sw_fini_, TYPE) (sw);
 524         if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, name, as)) {
 525             goto fail;
 526         }
 527     } else {
 528         sw = glue(audio_pcm_create_voice_pair_, TYPE)(s, name, as);
 529         if (!sw) {
 530             dolog ("Failed to create voice `%s'\n", name);
 531             return NULL;
 532         }
 533     }
 534
 535     sw->card = card;
 536     sw->vol = nominal_volume;
 537     sw->callback.fn = callback_fn;
 538     sw->callback.opaque = callback_opaque;
 539
 540 #ifdef DEBUG_AUDIO
 541     dolog ("%s\n", name);
 542     audio_pcm_print_info ("hw", &sw->hw->info);
 543     audio_pcm_print_info ("sw", &sw->info);
 544 #endif
 545
 546     return sw;
 547
 548  fail:
 549     glue (AUD_close_, TYPE) (card, sw);
 550     return NULL;
 551 }
 552
 553 int glue (AUD_is_active_, TYPE) (SW *sw)
 554 {
 555     return sw ? sw->active : 0;
 556 }
 557
 558 void glue (AUD_init_time_stamp_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
 559 {
 560     if (!sw) {
 561         return;
 562     }
 563
 564     ts->old_ts = sw->hw->ts_helper;
 565 }
 566
 567 uint64_t glue (AUD_get_elapsed_usec_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
 568 {
 569     uint64_t delta, cur_ts, old_ts;
 570
 571     if (!sw) {
 572         return 0;
 573     }
 574
 575     cur_ts = sw->hw->ts_helper;
 576     old_ts = ts->old_ts;
 577     /* dolog ("cur %" PRId64 " old %" PRId64 "\n", cur_ts, old_ts); */
 578
 579     if (cur_ts >= old_ts) {
 580         delta = cur_ts - old_ts;
 581     } else {
 582         delta = UINT64_MAX - old_ts + cur_ts;
 583     }
 584
 585     if (!delta) {
 586         return 0;
 587     }
 588
 589     return muldiv64 (delta, sw->hw->info.freq, 1000000);
 590 }
 591
 592 #undef TYPE
 593 #undef HW
 594 #undef SW
 595 #undef HWBUF
 596 #undef NAME