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     size_t 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=%zu 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.buffer);
  75     HWBUF.buffer = NULL;
  76     HWBUF.size = 0;
  77 }
  78
  79 static void glue(audio_pcm_hw_alloc_resources_, TYPE)(HW *hw)
  80 {
  81     if (glue(audio_get_pdo_, TYPE)(hw->s->dev)->mixing_engine) {
  82         size_t samples = hw->samples;
  83         if (audio_bug(__func__, samples == 0)) {
  84             dolog("Attempted to allocate empty buffer\n");
  85         }
  86
  87         HWBUF.buffer = g_new0(st_sample, samples);
  88         HWBUF.size = samples;
  89         HWBUF.pos = 0;
  90     } else {
  91         HWBUF.buffer = NULL;
  92         HWBUF.size = 0;
  93     }
  94 }
  95
  96 static void glue (audio_pcm_sw_free_resources_, TYPE) (SW *sw)
  97 {
  98     g_free(sw->resample_buf.buffer);
  99     sw->resample_buf.buffer = NULL;
 100     sw->resample_buf.size = 0;
 101
 102     if (sw->rate) {
 103         st_rate_stop (sw->rate);
 104     }
 105     sw->rate = NULL;
 106 }
 107
 108 static int glue (audio_pcm_sw_alloc_resources_, TYPE) (SW *sw)
 109 {
 110     int samples;
 111
 112     if (!glue(audio_get_pdo_, TYPE)(sw->s->dev)->mixing_engine) {
 113         return 0;
 114     }
 115
 116 #ifdef DAC
 117     samples = ((int64_t)sw->HWBUF.size << 32) / sw->ratio;
 118 #else
 119     samples = (int64_t)sw->HWBUF.size * sw->ratio >> 32;
 120 #endif
 121     if (audio_bug(__func__, samples < 0)) {
 122         dolog("Can not allocate buffer for `%s' (%d samples)\n",
 123               SW_NAME(sw), samples);
 124         return -1;
 125     }
 126
 127     if (samples == 0) {
 128         HW *hw = sw->hw;
 129         size_t f_fe_min;
 130
 131         /* f_fe_min = ceil(1 [frames] * f_be [Hz] / size_be [frames]) */
 132         f_fe_min = (hw->info.freq + HWBUF.size - 1) / HWBUF.size;
 133         qemu_log_mask(LOG_UNIMP,
 134                       AUDIO_CAP ": The guest selected a " NAME " sample rate"
 135                       " of %d Hz for %s. Only sample rates >= %zu Hz are"
 136                       " supported.\n",
 137                       sw->info.freq, sw->name, f_fe_min);
 138         return -1;
 139     }
 140
 141     sw->resample_buf.buffer = g_new0(st_sample, samples);
 142     sw->resample_buf.size = samples;
 143     sw->resample_buf.pos = 0;
 144
 145 #ifdef DAC
 146     sw->rate = st_rate_start (sw->info.freq, sw->hw->info.freq);
 147 #else
 148     sw->rate = st_rate_start (sw->hw->info.freq, sw->info.freq);
 149 #endif
 150
 151     return 0;
 152 }
 153
 154 static int glue (audio_pcm_sw_init_, TYPE) (
 155     SW *sw,
 156     HW *hw,
 157     const char *name,
 158     struct audsettings *as
 159     )
 160 {
 161     int err;
 162
 163     audio_pcm_init_info (&sw->info, as);
 164     sw->hw = hw;
 165     sw->active = 0;
 166 #ifdef DAC
 167     sw->ratio = ((int64_t) sw->hw->info.freq << 32) / sw->info.freq;
 168     sw->total_hw_samples_mixed = 0;
 169     sw->empty = 1;
 170 #else
 171     sw->ratio = ((int64_t) sw->info.freq << 32) / sw->hw->info.freq;
 172 #endif
 173
 174     if (sw->info.is_float) {
 175 #ifdef DAC
 176         sw->conv = mixeng_conv_float[sw->info.nchannels == 2];
 177 #else
 178         sw->clip = mixeng_clip_float[sw->info.nchannels == 2];
 179 #endif
 180     } else {
 181 #ifdef DAC
 182         sw->conv = mixeng_conv
 183 #else
 184         sw->clip = mixeng_clip
 185 #endif
 186             [sw->info.nchannels == 2]
 187             [sw->info.is_signed]
 188             [sw->info.swap_endianness]
 189             [audio_bits_to_index(sw->info.bits)];
 190     }
 191
 192     sw->name = g_strdup (name);
 193     err = glue (audio_pcm_sw_alloc_resources_, TYPE) (sw);
 194     if (err) {
 195         g_free (sw->name);
 196         sw->name = NULL;
 197     }
 198     return err;
 199 }
 200
 201 static void glue (audio_pcm_sw_fini_, TYPE) (SW *sw)
 202 {
 203     glue (audio_pcm_sw_free_resources_, TYPE) (sw);
 204     g_free (sw->name);
 205     sw->name = NULL;
 206 }
 207
 208 static void glue (audio_pcm_hw_add_sw_, TYPE) (HW *hw, SW *sw)
 209 {
 210     QLIST_INSERT_HEAD (&hw->sw_head, sw, entries);
 211 }
 212
 213 static void glue (audio_pcm_hw_del_sw_, TYPE) (SW *sw)
 214 {
 215     QLIST_REMOVE (sw, entries);
 216 }
 217
 218 static void glue (audio_pcm_hw_gc_, TYPE) (HW **hwp)
 219 {
 220     HW *hw = *hwp;
 221     AudioState *s = hw->s;
 222
 223     if (!hw->sw_head.lh_first) {
 224 #ifdef DAC
 225         audio_detach_capture(hw);
 226 #endif
 227         QLIST_REMOVE(hw, entries);
 228         glue(hw->pcm_ops->fini_, TYPE) (hw);
 229         glue(s->nb_hw_voices_, TYPE) += 1;
 230         glue(audio_pcm_hw_free_resources_ , TYPE) (hw);
 231         g_free(hw);
 232         *hwp = NULL;
 233     }
 234 }
 235
 236 static HW *glue(audio_pcm_hw_find_any_, TYPE)(AudioState *s, HW *hw)
 237 {
 238     return hw ? hw->entries.le_next : glue (s->hw_head_, TYPE).lh_first;
 239 }
 240
 241 static HW *glue(audio_pcm_hw_find_any_enabled_, TYPE)(AudioState *s, HW *hw)
 242 {
 243     while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
 244         if (hw->enabled) {
 245             return hw;
 246         }
 247     }
 248     return NULL;
 249 }
 250
 251 static HW *glue(audio_pcm_hw_find_specific_, TYPE)(AudioState *s, HW *hw,
 252                                                    struct audsettings *as)
 253 {
 254     while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
 255         if (audio_pcm_info_eq (&hw->info, as)) {
 256             return hw;
 257         }
 258     }
 259     return NULL;
 260 }
 261
 262 static HW *glue(audio_pcm_hw_add_new_, TYPE)(AudioState *s,
 263                                              struct audsettings *as)
 264 {
 265     HW *hw;
 266     struct audio_driver *drv = s->drv;
 267
 268     if (!glue (s->nb_hw_voices_, TYPE)) {
 269         return NULL;
 270     }
 271
 272     if (audio_bug(__func__, !drv)) {
 273         dolog ("No host audio driver\n");
 274         return NULL;
 275     }
 276
 277     if (audio_bug(__func__, !drv->pcm_ops)) {
 278         dolog ("Host audio driver without pcm_ops\n");
 279         return NULL;
 280     }
 281
 282     /*
 283      * Since glue(s->nb_hw_voices_, TYPE) is != 0, glue(drv->voice_size_, TYPE)
 284      * is guaranteed to be != 0. See the audio_init_nb_voices_* functions.
 285      */
 286     hw = g_malloc0(glue(drv->voice_size_, TYPE));
 287     hw->s = s;
 288     hw->pcm_ops = drv->pcm_ops;
 289
 290     QLIST_INIT (&hw->sw_head);
 291 #ifdef DAC
 292     QLIST_INIT (&hw->cap_head);
 293 #endif
 294     if (glue (hw->pcm_ops->init_, TYPE) (hw, as, s->drv_opaque)) {
 295         goto err0;
 296     }
 297
 298     if (audio_bug(__func__, hw->samples <= 0)) {
 299         dolog("hw->samples=%zd\n", hw->samples);
 300         goto err1;
 301     }
 302
 303     if (hw->info.is_float) {
 304 #ifdef DAC
 305         hw->clip = mixeng_clip_float[hw->info.nchannels == 2];
 306 #else
 307         hw->conv = mixeng_conv_float[hw->info.nchannels == 2];
 308 #endif
 309     } else {
 310 #ifdef DAC
 311         hw->clip = mixeng_clip
 312 #else
 313         hw->conv = mixeng_conv
 314 #endif
 315             [hw->info.nchannels == 2]
 316             [hw->info.is_signed]
 317             [hw->info.swap_endianness]
 318             [audio_bits_to_index(hw->info.bits)];
 319     }
 320
 321     glue(audio_pcm_hw_alloc_resources_, TYPE)(hw);
 322
 323     QLIST_INSERT_HEAD (&s->glue (hw_head_, TYPE), hw, entries);
 324     glue (s->nb_hw_voices_, TYPE) -= 1;
 325 #ifdef DAC
 326     audio_attach_capture (hw);
 327 #endif
 328     return hw;
 329
 330  err1:
 331     glue (hw->pcm_ops->fini_, TYPE) (hw);
 332  err0:
 333     g_free (hw);
 334     return NULL;
 335 }
 336
 337 AudiodevPerDirectionOptions *glue(audio_get_pdo_, TYPE)(Audiodev *dev)
 338 {
 339     switch (dev->driver) {
 340     case AUDIODEV_DRIVER_NONE:
 341         return dev->u.none.TYPE;
 342 #ifdef CONFIG_AUDIO_ALSA
 343     case AUDIODEV_DRIVER_ALSA:
 344         return qapi_AudiodevAlsaPerDirectionOptions_base(dev->u.alsa.TYPE);
 345 #endif
 346 #ifdef CONFIG_AUDIO_COREAUDIO
 347     case AUDIODEV_DRIVER_COREAUDIO:
 348         return qapi_AudiodevCoreaudioPerDirectionOptions_base(
 349             dev->u.coreaudio.TYPE);
 350 #endif
 351 #ifdef CONFIG_DBUS_DISPLAY
 352     case AUDIODEV_DRIVER_DBUS:
 353         return dev->u.dbus.TYPE;
 354 #endif
 355 #ifdef CONFIG_AUDIO_DSOUND
 356     case AUDIODEV_DRIVER_DSOUND:
 357         return dev->u.dsound.TYPE;
 358 #endif
 359 #ifdef CONFIG_AUDIO_JACK
 360     case AUDIODEV_DRIVER_JACK:
 361         return qapi_AudiodevJackPerDirectionOptions_base(dev->u.jack.TYPE);
 362 #endif
 363 #ifdef CONFIG_AUDIO_OSS
 364     case AUDIODEV_DRIVER_OSS:
 365         return qapi_AudiodevOssPerDirectionOptions_base(dev->u.oss.TYPE);
 366 #endif
 367 #ifdef CONFIG_AUDIO_PA
 368     case AUDIODEV_DRIVER_PA:
 369         return qapi_AudiodevPaPerDirectionOptions_base(dev->u.pa.TYPE);
 370 #endif
 371 #ifdef CONFIG_AUDIO_SDL
 372     case AUDIODEV_DRIVER_SDL:
 373         return qapi_AudiodevSdlPerDirectionOptions_base(dev->u.sdl.TYPE);
 374 #endif
 375 #ifdef CONFIG_AUDIO_SNDIO
 376     case AUDIODEV_DRIVER_SNDIO:
 377         return dev->u.sndio.TYPE;
 378 #endif
 379 #ifdef CONFIG_SPICE
 380     case AUDIODEV_DRIVER_SPICE:
 381         return dev->u.spice.TYPE;
 382 #endif
 383     case AUDIODEV_DRIVER_WAV:
 384         return dev->u.wav.TYPE;
 385
 386     case AUDIODEV_DRIVER__MAX:
 387         break;
 388     }
 389     abort();
 390 }
 391
 392 static HW *glue(audio_pcm_hw_add_, TYPE)(AudioState *s, struct audsettings *as)
 393 {
 394     HW *hw;
 395     AudiodevPerDirectionOptions *pdo = glue(audio_get_pdo_, TYPE)(s->dev);
 396
 397     if (!pdo->mixing_engine || pdo->fixed_settings) {
 398         hw = glue(audio_pcm_hw_add_new_, TYPE)(s, as);
 399         if (!pdo->mixing_engine || hw) {
 400             return hw;
 401         }
 402     }
 403
 404     hw = glue(audio_pcm_hw_find_specific_, TYPE)(s, NULL, as);
 405     if (hw) {
 406         return hw;
 407     }
 408
 409     hw = glue(audio_pcm_hw_add_new_, TYPE)(s, as);
 410     if (hw) {
 411         return hw;
 412     }
 413
 414     return glue(audio_pcm_hw_find_any_, TYPE)(s, NULL);
 415 }
 416
 417 static SW *glue(audio_pcm_create_voice_pair_, TYPE)(
 418     AudioState *s,
 419     const char *sw_name,
 420     struct audsettings *as
 421     )
 422 {
 423     SW *sw;
 424     HW *hw;
 425     struct audsettings hw_as;
 426     AudiodevPerDirectionOptions *pdo = glue(audio_get_pdo_, TYPE)(s->dev);
 427
 428     if (pdo->fixed_settings) {
 429         hw_as = audiodev_to_audsettings(pdo);
 430     } else {
 431         hw_as = *as;
 432     }
 433
 434     sw = g_new0(SW, 1);
 435     sw->s = s;
 436
 437     hw = glue(audio_pcm_hw_add_, TYPE)(s, &hw_as);
 438     if (!hw) {
 439         dolog("Could not create a backend for voice `%s'\n", sw_name);
 440         goto err1;
 441     }
 442
 443     glue (audio_pcm_hw_add_sw_, TYPE) (hw, sw);
 444
 445     if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, sw_name, as)) {
 446         goto err2;
 447     }
 448
 449     return sw;
 450
 451 err2:
 452     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
 453     glue (audio_pcm_hw_gc_, TYPE) (&hw);
 454 err1:
 455     g_free(sw);
 456     return NULL;
 457 }
 458
 459 static void glue (audio_close_, TYPE) (SW *sw)
 460 {
 461     glue (audio_pcm_sw_fini_, TYPE) (sw);
 462     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
 463     glue (audio_pcm_hw_gc_, TYPE) (&sw->hw);
 464     g_free (sw);
 465 }
 466
 467 void glue (AUD_close_, TYPE) (QEMUSoundCard *card, SW *sw)
 468 {
 469     if (sw) {
 470         if (audio_bug(__func__, !card)) {
 471             dolog ("card=%p\n", card);
 472             return;
 473         }
 474
 475         glue (audio_close_, TYPE) (sw);
 476     }
 477 }
 478
 479 SW *glue (AUD_open_, TYPE) (
 480     QEMUSoundCard *card,
 481     SW *sw,
 482     const char *name,
 483     void *callback_opaque ,
 484     audio_callback_fn callback_fn,
 485     struct audsettings *as
 486     )
 487 {
 488     AudioState *s;
 489     AudiodevPerDirectionOptions *pdo;
 490
 491     if (audio_bug(__func__, !card || !name || !callback_fn || !as)) {
 492         dolog ("card=%p name=%p callback_fn=%p as=%p\n",
 493                card, name, callback_fn, as);
 494         goto fail;
 495     }
 496
 497     s = card->state;
 498     pdo = glue(audio_get_pdo_, TYPE)(s->dev);
 499
 500     ldebug ("open %s, freq %d, nchannels %d, fmt %d\n",
 501             name, as->freq, as->nchannels, as->fmt);
 502
 503     if (audio_bug(__func__, audio_validate_settings(as))) {
 504         audio_print_settings (as);
 505         goto fail;
 506     }
 507
 508     if (audio_bug(__func__, !s->drv)) {
 509         dolog ("Can not open `%s' (no host audio driver)\n", name);
 510         goto fail;
 511     }
 512
 513     if (sw && audio_pcm_info_eq (&sw->info, as)) {
 514         return sw;
 515     }
 516
 517     if (!pdo->fixed_settings && sw) {
 518         glue (AUD_close_, TYPE) (card, sw);
 519         sw = NULL;
 520     }
 521
 522     if (sw) {
 523         HW *hw = sw->hw;
 524
 525         if (!hw) {
 526             dolog("Internal logic error: voice `%s' has no backend\n",
 527                   SW_NAME(sw));
 528             goto fail;
 529         }
 530
 531         glue (audio_pcm_sw_fini_, TYPE) (sw);
 532         if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, name, as)) {
 533             goto fail;
 534         }
 535     } else {
 536         sw = glue(audio_pcm_create_voice_pair_, TYPE)(s, name, as);
 537         if (!sw) {
 538             return NULL;
 539         }
 540     }
 541
 542     sw->card = card;
 543     sw->vol = nominal_volume;
 544     sw->callback.fn = callback_fn;
 545     sw->callback.opaque = callback_opaque;
 546
 547 #ifdef DEBUG_AUDIO
 548     dolog ("%s\n", name);
 549     audio_pcm_print_info ("hw", &sw->hw->info);
 550     audio_pcm_print_info ("sw", &sw->info);
 551 #endif
 552
 553     return sw;
 554
 555  fail:
 556     glue (AUD_close_, TYPE) (card, sw);
 557     return NULL;
 558 }
 559
 560 int glue (AUD_is_active_, TYPE) (SW *sw)
 561 {
 562     return sw ? sw->active : 0;
 563 }
 564
 565 void glue (AUD_init_time_stamp_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
 566 {
 567     if (!sw) {
 568         return;
 569     }
 570
 571     ts->old_ts = sw->hw->ts_helper;
 572 }
 573
 574 uint64_t glue (AUD_get_elapsed_usec_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
 575 {
 576     uint64_t delta, cur_ts, old_ts;
 577
 578     if (!sw) {
 579         return 0;
 580     }
 581
 582     cur_ts = sw->hw->ts_helper;
 583     old_ts = ts->old_ts;
 584     /* dolog ("cur %" PRId64 " old %" PRId64 "\n", cur_ts, old_ts); */
 585
 586     if (cur_ts >= old_ts) {
 587         delta = cur_ts - old_ts;
 588     } else {
 589         delta = UINT64_MAX - old_ts + cur_ts;
 590     }
 591
 592     if (!delta) {
 593         return 0;
 594     }
 595
 596     return muldiv64 (delta, sw->hw->info.freq, 1000000);
 597 }
 598
 599 #undef TYPE
 600 #undef HW
 601 #undef SW
 602 #undef HWBUF
 603 #undef NAME