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     if (samples == 0) {
 119         HW *hw = sw->hw;
 120         size_t f_fe_min;
 121
 122         /* f_fe_min = ceil(1 [frames] * f_be [Hz] / size_be [frames]) */
 123         f_fe_min = (hw->info.freq + HWBUF->size - 1) / HWBUF->size;
 124         qemu_log_mask(LOG_UNIMP,
 125                       AUDIO_CAP ": The guest selected a " NAME " sample rate"
 126                       " of %d Hz for %s. Only sample rates >= %zu Hz are"
 127                       " supported.\n",
 128                       sw->info.freq, sw->name, f_fe_min);
 129         return -1;
 130     }
 131
 132     sw->buf = audio_calloc(__func__, samples, sizeof(struct st_sample));
 133     if (!sw->buf) {
 134         dolog ("Could not allocate buffer for `%s' (%d samples)\n",
 135                SW_NAME (sw), samples);
 136         return -1;
 137     }
 138
 139 #ifdef DAC
 140     sw->rate = st_rate_start (sw->info.freq, sw->hw->info.freq);
 141 #else
 142     sw->rate = st_rate_start (sw->hw->info.freq, sw->info.freq);
 143 #endif
 144     if (!sw->rate) {
 145         g_free (sw->buf);
 146         sw->buf = NULL;
 147         return -1;
 148     }
 149     return 0;
 150 }
 151
 152 static int glue (audio_pcm_sw_init_, TYPE) (
 153     SW *sw,
 154     HW *hw,
 155     const char *name,
 156     struct audsettings *as
 157     )
 158 {
 159     int err;
 160
 161     audio_pcm_init_info (&sw->info, as);
 162     sw->hw = hw;
 163     sw->active = 0;
 164 #ifdef DAC
 165     sw->ratio = ((int64_t) sw->hw->info.freq << 32) / sw->info.freq;
 166     sw->total_hw_samples_mixed = 0;
 167     sw->empty = 1;
 168 #else
 169     sw->ratio = ((int64_t) sw->info.freq << 32) / sw->hw->info.freq;
 170 #endif
 171
 172     if (sw->info.is_float) {
 173 #ifdef DAC
 174         sw->conv = mixeng_conv_float[sw->info.nchannels == 2];
 175 #else
 176         sw->clip = mixeng_clip_float[sw->info.nchannels == 2];
 177 #endif
 178     } else {
 179 #ifdef DAC
 180         sw->conv = mixeng_conv
 181 #else
 182         sw->clip = mixeng_clip
 183 #endif
 184             [sw->info.nchannels == 2]
 185             [sw->info.is_signed]
 186             [sw->info.swap_endianness]
 187             [audio_bits_to_index(sw->info.bits)];
 188     }
 189
 190     sw->name = g_strdup (name);
 191     err = glue (audio_pcm_sw_alloc_resources_, TYPE) (sw);
 192     if (err) {
 193         g_free (sw->name);
 194         sw->name = NULL;
 195     }
 196     return err;
 197 }
 198
 199 static void glue (audio_pcm_sw_fini_, TYPE) (SW *sw)
 200 {
 201     glue (audio_pcm_sw_free_resources_, TYPE) (sw);
 202     g_free (sw->name);
 203     sw->name = NULL;
 204 }
 205
 206 static void glue (audio_pcm_hw_add_sw_, TYPE) (HW *hw, SW *sw)
 207 {
 208     QLIST_INSERT_HEAD (&hw->sw_head, sw, entries);
 209 }
 210
 211 static void glue (audio_pcm_hw_del_sw_, TYPE) (SW *sw)
 212 {
 213     QLIST_REMOVE (sw, entries);
 214 }
 215
 216 static void glue (audio_pcm_hw_gc_, TYPE) (HW **hwp)
 217 {
 218     HW *hw = *hwp;
 219     AudioState *s = hw->s;
 220
 221     if (!hw->sw_head.lh_first) {
 222 #ifdef DAC
 223         audio_detach_capture(hw);
 224 #endif
 225         QLIST_REMOVE(hw, entries);
 226         glue(hw->pcm_ops->fini_, TYPE) (hw);
 227         glue(s->nb_hw_voices_, TYPE) += 1;
 228         glue(audio_pcm_hw_free_resources_ , TYPE) (hw);
 229         g_free(hw);
 230         *hwp = NULL;
 231     }
 232 }
 233
 234 static HW *glue(audio_pcm_hw_find_any_, TYPE)(AudioState *s, HW *hw)
 235 {
 236     return hw ? hw->entries.le_next : glue (s->hw_head_, TYPE).lh_first;
 237 }
 238
 239 static HW *glue(audio_pcm_hw_find_any_enabled_, TYPE)(AudioState *s, HW *hw)
 240 {
 241     while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
 242         if (hw->enabled) {
 243             return hw;
 244         }
 245     }
 246     return NULL;
 247 }
 248
 249 static HW *glue(audio_pcm_hw_find_specific_, TYPE)(AudioState *s, HW *hw,
 250                                                    struct audsettings *as)
 251 {
 252     while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
 253         if (audio_pcm_info_eq (&hw->info, as)) {
 254             return hw;
 255         }
 256     }
 257     return NULL;
 258 }
 259
 260 static HW *glue(audio_pcm_hw_add_new_, TYPE)(AudioState *s,
 261                                              struct audsettings *as)
 262 {
 263     HW *hw;
 264     struct audio_driver *drv = s->drv;
 265
 266     if (!glue (s->nb_hw_voices_, TYPE)) {
 267         return NULL;
 268     }
 269
 270     if (audio_bug(__func__, !drv)) {
 271         dolog ("No host audio driver\n");
 272         return NULL;
 273     }
 274
 275     if (audio_bug(__func__, !drv->pcm_ops)) {
 276         dolog ("Host audio driver without pcm_ops\n");
 277         return NULL;
 278     }
 279
 280     hw = audio_calloc(__func__, 1, glue(drv->voice_size_, TYPE));
 281     if (!hw) {
 282         dolog ("Can not allocate voice `%s' size %d\n",
 283                drv->name, glue (drv->voice_size_, TYPE));
 284         return NULL;
 285     }
 286
 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 = audio_calloc(__func__, 1, sizeof(*sw));
 435     if (!sw) {
 436         dolog ("Could not allocate soft voice `%s' (%zu bytes)\n",
 437                sw_name ? sw_name : "unknown", sizeof (*sw));
 438         goto err1;
 439     }
 440     sw->s = s;
 441
 442     hw = glue(audio_pcm_hw_add_, TYPE)(s, &hw_as);
 443     if (!hw) {
 444         dolog("Could not create a backend for voice `%s'\n", sw_name);
 445         goto err2;
 446     }
 447
 448     glue (audio_pcm_hw_add_sw_, TYPE) (hw, sw);
 449
 450     if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, sw_name, as)) {
 451         goto err3;
 452     }
 453
 454     return sw;
 455
 456 err3:
 457     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
 458     glue (audio_pcm_hw_gc_, TYPE) (&hw);
 459 err2:
 460     g_free (sw);
 461 err1:
 462     return NULL;
 463 }
 464
 465 static void glue (audio_close_, TYPE) (SW *sw)
 466 {
 467     glue (audio_pcm_sw_fini_, TYPE) (sw);
 468     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
 469     glue (audio_pcm_hw_gc_, TYPE) (&sw->hw);
 470     g_free (sw);
 471 }
 472
 473 void glue (AUD_close_, TYPE) (QEMUSoundCard *card, SW *sw)
 474 {
 475     if (sw) {
 476         if (audio_bug(__func__, !card)) {
 477             dolog ("card=%p\n", card);
 478             return;
 479         }
 480
 481         glue (audio_close_, TYPE) (sw);
 482     }
 483 }
 484
 485 SW *glue (AUD_open_, TYPE) (
 486     QEMUSoundCard *card,
 487     SW *sw,
 488     const char *name,
 489     void *callback_opaque ,
 490     audio_callback_fn callback_fn,
 491     struct audsettings *as
 492     )
 493 {
 494     AudioState *s;
 495     AudiodevPerDirectionOptions *pdo;
 496
 497     if (audio_bug(__func__, !card || !name || !callback_fn || !as)) {
 498         dolog ("card=%p name=%p callback_fn=%p as=%p\n",
 499                card, name, callback_fn, as);
 500         goto fail;
 501     }
 502
 503     s = card->state;
 504     pdo = glue(audio_get_pdo_, TYPE)(s->dev);
 505
 506     ldebug ("open %s, freq %d, nchannels %d, fmt %d\n",
 507             name, as->freq, as->nchannels, as->fmt);
 508
 509     if (audio_bug(__func__, audio_validate_settings(as))) {
 510         audio_print_settings (as);
 511         goto fail;
 512     }
 513
 514     if (audio_bug(__func__, !s->drv)) {
 515         dolog ("Can not open `%s' (no host audio driver)\n", name);
 516         goto fail;
 517     }
 518
 519     if (sw && audio_pcm_info_eq (&sw->info, as)) {
 520         return sw;
 521     }
 522
 523     if (!pdo->fixed_settings && sw) {
 524         glue (AUD_close_, TYPE) (card, sw);
 525         sw = NULL;
 526     }
 527
 528     if (sw) {
 529         HW *hw = sw->hw;
 530
 531         if (!hw) {
 532             dolog ("Internal logic error voice `%s' has no hardware store\n",
 533                    SW_NAME (sw));
 534             goto fail;
 535         }
 536
 537         glue (audio_pcm_sw_fini_, TYPE) (sw);
 538         if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, name, as)) {
 539             goto fail;
 540         }
 541     } else {
 542         sw = glue(audio_pcm_create_voice_pair_, TYPE)(s, name, as);
 543         if (!sw) {
 544             return NULL;
 545         }
 546     }
 547
 548     sw->card = card;
 549     sw->vol = nominal_volume;
 550     sw->callback.fn = callback_fn;
 551     sw->callback.opaque = callback_opaque;
 552
 553 #ifdef DEBUG_AUDIO
 554     dolog ("%s\n", name);
 555     audio_pcm_print_info ("hw", &sw->hw->info);
 556     audio_pcm_print_info ("sw", &sw->info);
 557 #endif
 558
 559     return sw;
 560
 561  fail:
 562     glue (AUD_close_, TYPE) (card, sw);
 563     return NULL;
 564 }
 565
 566 int glue (AUD_is_active_, TYPE) (SW *sw)
 567 {
 568     return sw ? sw->active : 0;
 569 }
 570
 571 void glue (AUD_init_time_stamp_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
 572 {
 573     if (!sw) {
 574         return;
 575     }
 576
 577     ts->old_ts = sw->hw->ts_helper;
 578 }
 579
 580 uint64_t glue (AUD_get_elapsed_usec_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
 581 {
 582     uint64_t delta, cur_ts, old_ts;
 583
 584     if (!sw) {
 585         return 0;
 586     }
 587
 588     cur_ts = sw->hw->ts_helper;
 589     old_ts = ts->old_ts;
 590     /* dolog ("cur %" PRId64 " old %" PRId64 "\n", cur_ts, old_ts); */
 591
 592     if (cur_ts >= old_ts) {
 593         delta = cur_ts - old_ts;
 594     } else {
 595         delta = UINT64_MAX - old_ts + cur_ts;
 596     }
 597
 598     if (!delta) {
 599         return 0;
 600     }
 601
 602     return muldiv64 (delta, sw->hw->info.freq, 1000000);
 603 }
 604
 605 #undef TYPE
 606 #undef HW
 607 #undef SW
 608 #undef HWBUF
 609 #undef NAME