audio/coreaudio.c

   1 /*
   2  * QEMU OS X CoreAudio audio driver
   3  *
   4  * Copyright (c) 2005 Mike Kronenberg
   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 #include <CoreAudio/CoreAudio.h>
  26 #include <string.h>             /* strerror */
  27 #include <pthread.h>            /* pthread_X */
  28
  29 #include "vl.h"
  30
  31 #define AUDIO_CAP "coreaudio"
  32 #include "audio_int.h"
  33
  34 struct {
  35     int buffer_frames;
  36     int nbuffers;
  37     int isAtexit;
  38 } conf = {
  39     .buffer_frames = 512,
  40     .nbuffers = 4,
  41     .isAtexit = 0
  42 };
  43
  44 typedef struct coreaudioVoiceOut {
  45     HWVoiceOut hw;
  46     pthread_mutex_t mutex;
  47     int isAtexit;
  48     AudioDeviceID outputDeviceID;
  49     UInt32 audioDevicePropertyBufferFrameSize;
  50     AudioStreamBasicDescription outputStreamBasicDescription;
  51     int live;
  52     int decr;
  53     int rpos;
  54 } coreaudioVoiceOut;
  55
  56 static void coreaudio_logstatus (OSStatus status)
  57 {
  58     char *str = "BUG";
  59
  60     switch(status) {
  61     case kAudioHardwareNoError:
  62         str = "kAudioHardwareNoError";
  63         break;
  64
  65     case kAudioHardwareNotRunningError:
  66         str = "kAudioHardwareNotRunningError";
  67         break;
  68
  69     case kAudioHardwareUnspecifiedError:
  70         str = "kAudioHardwareUnspecifiedError";
  71         break;
  72
  73     case kAudioHardwareUnknownPropertyError:
  74         str = "kAudioHardwareUnknownPropertyError";
  75         break;
  76
  77     case kAudioHardwareBadPropertySizeError:
  78         str = "kAudioHardwareBadPropertySizeError";
  79         break;
  80
  81     case kAudioHardwareIllegalOperationError:
  82         str = "kAudioHardwareIllegalOperationError";
  83         break;
  84
  85     case kAudioHardwareBadDeviceError:
  86         str = "kAudioHardwareBadDeviceError";
  87         break;
  88
  89     case kAudioHardwareBadStreamError:
  90         str = "kAudioHardwareBadStreamError";
  91         break;
  92
  93     case kAudioHardwareUnsupportedOperationError:
  94         str = "kAudioHardwareUnsupportedOperationError";
  95         break;
  96
  97     case kAudioDeviceUnsupportedFormatError:
  98         str = "kAudioDeviceUnsupportedFormatError";
  99         break;
 100
 101     case kAudioDevicePermissionsError:
 102         str = "kAudioDevicePermissionsError";
 103         break;
 104
 105     default:
 106         AUD_log (AUDIO_CAP, "Reason: status code %ld\n", status);
 107         return;
 108     }
 109
 110     AUD_log (AUDIO_CAP, "Reason: %s\n", str);
 111 }
 112
 113 static void GCC_FMT_ATTR (2, 3) coreaudio_logerr (
 114     OSStatus status,
 115     const char *fmt,
 116     ...
 117     )
 118 {
 119     va_list ap;
 120
 121     va_start (ap, fmt);
 122     AUD_log (AUDIO_CAP, fmt, ap);
 123     va_end (ap);
 124
 125     coreaudio_logstatus (status);
 126 }
 127
 128 static void GCC_FMT_ATTR (3, 4) coreaudio_logerr2 (
 129     OSStatus status,
 130     const char *typ,
 131     const char *fmt,
 132     ...
 133     )
 134 {
 135     va_list ap;
 136
 137     AUD_log (AUDIO_CAP, "Could not initialize %s\n", typ);
 138
 139     va_start (ap, fmt);
 140     AUD_vlog (AUDIO_CAP, fmt, ap);
 141     va_end (ap);
 142
 143     coreaudio_logstatus (status);
 144 }
 145
 146 static inline UInt32 isPlaying (AudioDeviceID outputDeviceID)
 147 {
 148     OSStatus status;
 149     UInt32 result = 0;
 150     UInt32 propertySize = sizeof(outputDeviceID);
 151     status = AudioDeviceGetProperty(
 152         outputDeviceID, 0, 0,
 153         kAudioDevicePropertyDeviceIsRunning, &propertySize, &result);
 154     if (status != kAudioHardwareNoError) {
 155         coreaudio_logerr(status,
 156                          "Could not determine whether Device is playing\n");
 157     }
 158     return result;
 159 }
 160
 161 static void coreaudio_atexit (void)
 162 {
 163     conf.isAtexit = 1;
 164 }
 165
 166 static int coreaudio_lock (coreaudioVoiceOut *core, const char *fn_name)
 167 {
 168     int err;
 169
 170     err = pthread_mutex_lock (&core->mutex);
 171     if (err) {
 172         dolog ("Could not lock voice for %s\nReason: %s\n",
 173                fn_name, strerror (err));
 174         return -1;
 175     }
 176     return 0;
 177 }
 178
 179 static int coreaudio_unlock (coreaudioVoiceOut *core, const char *fn_name)
 180 {
 181     int err;
 182
 183     err = pthread_mutex_unlock (&core->mutex);
 184     if (err) {
 185         dolog ("Could not unlock voice for %s\nReason: %s\n",
 186                fn_name, strerror (err));
 187         return -1;
 188     }
 189     return 0;
 190 }
 191
 192 static int coreaudio_run_out (HWVoiceOut *hw)
 193 {
 194     int live, decr;
 195     coreaudioVoiceOut *core = (coreaudioVoiceOut *) hw;
 196
 197     if (coreaudio_lock (core, "coreaudio_run_out")) {
 198         return 0;
 199     }
 200
 201     live = audio_pcm_hw_get_live_out (hw);
 202
 203     if (core->decr > live) {
 204         ldebug ("core->decr %d live %d core->live %d\n",
 205                 core->decr,
 206                 live,
 207                 core->live);
 208     }
 209
 210     decr = audio_MIN (core->decr, live);
 211     core->decr -= decr;
 212
 213     core->live = live - decr;
 214     hw->rpos = core->rpos;
 215
 216     coreaudio_unlock (core, "coreaudio_run_out");
 217     return decr;
 218 }
 219
 220 /* callback to feed audiooutput buffer */
 221 static OSStatus audioDeviceIOProc(
 222     AudioDeviceID inDevice,
 223     const AudioTimeStamp* inNow,
 224     const AudioBufferList* inInputData,
 225     const AudioTimeStamp* inInputTime,
 226     AudioBufferList* outOutputData,
 227     const AudioTimeStamp* inOutputTime,
 228     void* hwptr)
 229 {
 230     UInt32 frame, frameCount;
 231     float *out = outOutputData->mBuffers[0].mData;
 232     HWVoiceOut *hw = hwptr;
 233     coreaudioVoiceOut *core = (coreaudioVoiceOut *) hwptr;
 234     int rpos, live;
 235     st_sample_t *src;
 236 #ifndef FLOAT_MIXENG
 237 #ifdef RECIPROCAL
 238     const float scale = 1.f / UINT_MAX;
 239 #else
 240     const float scale = UINT_MAX;
 241 #endif
 242 #endif
 243
 244     if (coreaudio_lock (core, "audioDeviceIOProc")) {
 245         inInputTime = 0;
 246         return 0;
 247     }
 248
 249     frameCount = core->audioDevicePropertyBufferFrameSize;
 250     live = core->live;
 251
 252     /* if there are not enough samples, set signal and return */
 253     if (live < frameCount) {
 254         inInputTime = 0;
 255         coreaudio_unlock (core, "audioDeviceIOProc(empty)");
 256         return 0;
 257     }
 258
 259     rpos = core->rpos;
 260     src = hw->mix_buf + rpos;
 261
 262     /* fill buffer */
 263     for (frame = 0; frame < frameCount; frame++) {
 264 #ifdef FLOAT_MIXENG
 265         *out++ = src[frame].l; /* left channel */
 266         *out++ = src[frame].r; /* right channel */
 267 #else
 268 #ifdef RECIPROCAL
 269         *out++ = src[frame].l * scale; /* left channel */
 270         *out++ = src[frame].r * scale; /* right channel */
 271 #else
 272         *out++ = src[frame].l / scale; /* left channel */
 273         *out++ = src[frame].r / scale; /* right channel */
 274 #endif
 275 #endif
 276     }
 277
 278     rpos = (rpos + frameCount) % hw->samples;
 279     core->decr += frameCount;
 280     core->rpos = rpos;
 281
 282     coreaudio_unlock (core, "audioDeviceIOProc");
 283     return 0;
 284 }
 285
 286 static int coreaudio_write (SWVoiceOut *sw, void *buf, int len)
 287 {
 288     return audio_pcm_sw_write (sw, buf, len);
 289 }
 290
 291 static int coreaudio_init_out (HWVoiceOut *hw, audsettings_t *as)
 292 {
 293     OSStatus status;
 294     coreaudioVoiceOut *core = (coreaudioVoiceOut *) hw;
 295     UInt32 propertySize;
 296     int err;
 297     const char *typ = "playback";
 298     AudioValueRange frameRange;
 299
 300     /* create mutex */
 301     err = pthread_mutex_init(&core->mutex, NULL);
 302     if (err) {
 303         dolog("Could not create mutex\nReason: %s\n", strerror (err));
 304         return -1;
 305     }
 306
 307     audio_pcm_init_info (&hw->info, as);
 308
 309     /* open default output device */
 310     propertySize = sizeof(core->outputDeviceID);
 311     status = AudioHardwareGetProperty(
 312         kAudioHardwarePropertyDefaultOutputDevice,
 313         &propertySize,
 314         &core->outputDeviceID);
 315     if (status != kAudioHardwareNoError) {
 316         coreaudio_logerr2 (status, typ,
 317                            "Could not get default output Device\n");
 318         return -1;
 319     }
 320     if (core->outputDeviceID == kAudioDeviceUnknown) {
 321         dolog ("Could not initialize %s - Unknown Audiodevice\n", typ);
 322         return -1;
 323     }
 324
 325     /* get minimum and maximum buffer frame sizes */
 326     propertySize = sizeof(frameRange);
 327     status = AudioDeviceGetProperty(
 328         core->outputDeviceID,
 329         0,
 330         0,
 331         kAudioDevicePropertyBufferFrameSizeRange,
 332         &propertySize,
 333         &frameRange);
 334     if (status != kAudioHardwareNoError) {
 335         coreaudio_logerr2 (status, typ,
 336                            "Could not get device buffer frame range\n");
 337         return -1;
 338     }
 339
 340     if (frameRange.mMinimum > conf.buffer_frames) {
 341         core->audioDevicePropertyBufferFrameSize = (UInt32) frameRange.mMinimum;
 342         dolog ("warning: Upsizing Buffer Frames to %f\n", frameRange.mMinimum);
 343     }
 344     else if (frameRange.mMaximum < conf.buffer_frames) {
 345         core->audioDevicePropertyBufferFrameSize = (UInt32) frameRange.mMaximum;
 346         dolog ("warning: Downsizing Buffer Frames to %f\n", frameRange.mMaximum);
 347     }
 348     else {
 349         core->audioDevicePropertyBufferFrameSize = conf.buffer_frames;
 350     }
 351
 352     /* set Buffer Frame Size */
 353     propertySize = sizeof(core->audioDevicePropertyBufferFrameSize);
 354     status = AudioDeviceSetProperty(
 355         core->outputDeviceID,
 356         NULL,
 357         0,
 358         false,
 359         kAudioDevicePropertyBufferFrameSize,
 360         propertySize,
 361         &core->audioDevicePropertyBufferFrameSize);
 362     if (status != kAudioHardwareNoError) {
 363         coreaudio_logerr2 (status, typ,
 364                            "Could not set device buffer frame size %ld\n",
 365                            core->audioDevicePropertyBufferFrameSize);
 366         return -1;
 367     }
 368
 369     /* get Buffer Frame Size */
 370     propertySize = sizeof(core->audioDevicePropertyBufferFrameSize);
 371     status = AudioDeviceGetProperty(
 372         core->outputDeviceID,
 373         0,
 374         false,
 375         kAudioDevicePropertyBufferFrameSize,
 376         &propertySize,
 377         &core->audioDevicePropertyBufferFrameSize);
 378     if (status != kAudioHardwareNoError) {
 379         coreaudio_logerr2 (status, typ,
 380                            "Could not get device buffer frame size\n");
 381         return -1;
 382     }
 383     hw->samples = conf.nbuffers * core->audioDevicePropertyBufferFrameSize;
 384
 385     /* get StreamFormat */
 386     propertySize = sizeof(core->outputStreamBasicDescription);
 387     status = AudioDeviceGetProperty(
 388         core->outputDeviceID,
 389         0,
 390         false,
 391         kAudioDevicePropertyStreamFormat,
 392         &propertySize,
 393         &core->outputStreamBasicDescription);
 394     if (status != kAudioHardwareNoError) {
 395         coreaudio_logerr2 (status, typ,
 396                            "Could not get Device Stream properties\n");
 397         core->outputDeviceID = kAudioDeviceUnknown;
 398         return -1;
 399     }
 400
 401     /* set Samplerate */
 402     core->outputStreamBasicDescription.mSampleRate = (Float64) as->freq;
 403     propertySize = sizeof(core->outputStreamBasicDescription);
 404     status = AudioDeviceSetProperty(
 405         core->outputDeviceID,
 406         0,
 407         0,
 408         0,
 409         kAudioDevicePropertyStreamFormat,
 410         propertySize,
 411         &core->outputStreamBasicDescription);
 412     if (status != kAudioHardwareNoError) {
 413         coreaudio_logerr2 (status, typ, "Could not set samplerate %d\n",
 414                            as->freq);
 415         core->outputDeviceID = kAudioDeviceUnknown;
 416         return -1;
 417     }
 418
 419     /* set Callback */
 420     status = AudioDeviceAddIOProc(core->outputDeviceID, audioDeviceIOProc, hw);
 421     if (status != kAudioHardwareNoError) {
 422         coreaudio_logerr2 (status, typ, "Could not set IOProc\n");
 423         core->outputDeviceID = kAudioDeviceUnknown;
 424         return -1;
 425     }
 426
 427     /* start Playback */
 428     if (!isPlaying(core->outputDeviceID)) {
 429         status = AudioDeviceStart(core->outputDeviceID, audioDeviceIOProc);
 430         if (status != kAudioHardwareNoError) {
 431             coreaudio_logerr2 (status, typ, "Could not start playback\n");
 432             AudioDeviceRemoveIOProc(core->outputDeviceID, audioDeviceIOProc);
 433             core->outputDeviceID = kAudioDeviceUnknown;
 434             return -1;
 435         }
 436     }
 437
 438     return 0;
 439 }
 440
 441 static void coreaudio_fini_out (HWVoiceOut *hw)
 442 {
 443     OSStatus status;
 444     int err;
 445     coreaudioVoiceOut *core = (coreaudioVoiceOut *) hw;
 446
 447     if (!conf.isAtexit) {
 448         /* stop playback */
 449         if (isPlaying(core->outputDeviceID)) {
 450             status = AudioDeviceStop(core->outputDeviceID, audioDeviceIOProc);
 451             if (status != kAudioHardwareNoError) {
 452                 coreaudio_logerr (status, "Could not stop playback\n");
 453             }
 454         }
 455
 456         /* remove callback */
 457         status = AudioDeviceRemoveIOProc(core->outputDeviceID,
 458                                          audioDeviceIOProc);
 459         if (status != kAudioHardwareNoError) {
 460             coreaudio_logerr (status, "Could not remove IOProc\n");
 461         }
 462     }
 463     core->outputDeviceID = kAudioDeviceUnknown;
 464
 465     /* destroy mutex */
 466     err = pthread_mutex_destroy(&core->mutex);
 467     if (err) {
 468         dolog("Could not destroy mutex\nReason: %s\n", strerror (err));
 469     }
 470 }
 471
 472 static int coreaudio_ctl_out (HWVoiceOut *hw, int cmd, ...)
 473 {
 474     OSStatus status;
 475     coreaudioVoiceOut *core = (coreaudioVoiceOut *) hw;
 476
 477     switch (cmd) {
 478     case VOICE_ENABLE:
 479         /* start playback */
 480         if (!isPlaying(core->outputDeviceID)) {
 481             status = AudioDeviceStart(core->outputDeviceID, audioDeviceIOProc);
 482             if (status != kAudioHardwareNoError) {
 483                 coreaudio_logerr (status, "Could not resume playback\n");
 484             }
 485         }
 486         break;
 487
 488     case VOICE_DISABLE:
 489         /* stop playback */
 490         if (!conf.isAtexit) {
 491             if (isPlaying(core->outputDeviceID)) {
 492                 status = AudioDeviceStop(core->outputDeviceID, audioDeviceIOProc);
 493                 if (status != kAudioHardwareNoError) {
 494                     coreaudio_logerr (status, "Could not pause playback\n");
 495                 }
 496             }
 497         }
 498         break;
 499     }
 500     return 0;
 501 }
 502
 503 static void *coreaudio_audio_init (void)
 504 {
 505     atexit(coreaudio_atexit);
 506     return &coreaudio_audio_init;
 507 }
 508
 509 static void coreaudio_audio_fini (void *opaque)
 510 {
 511     (void) opaque;
 512 }
 513
 514 static struct audio_option coreaudio_options[] = {
 515     {"BUFFER_SIZE", AUD_OPT_INT, &conf.buffer_frames,
 516      "Size of the buffer in frames", NULL, 0},
 517     {"BUFFER_COUNT", AUD_OPT_INT, &conf.nbuffers,
 518      "Number of buffers", NULL, 0},
 519     {NULL, 0, NULL, NULL, NULL, 0}
 520 };
 521
 522 static struct audio_pcm_ops coreaudio_pcm_ops = {
 523     coreaudio_init_out,
 524     coreaudio_fini_out,
 525     coreaudio_run_out,
 526     coreaudio_write,
 527     coreaudio_ctl_out,
 528
 529     NULL,
 530     NULL,
 531     NULL,
 532     NULL,
 533     NULL
 534 };
 535
 536 struct audio_driver coreaudio_audio_driver = {
 537     INIT_FIELD (name           = ) "coreaudio",
 538     INIT_FIELD (descr          = )
 539     "CoreAudio http://developer.apple.com/audio/coreaudio.html",
 540     INIT_FIELD (options        = ) coreaudio_options,
 541     INIT_FIELD (init           = ) coreaudio_audio_init,
 542     INIT_FIELD (fini           = ) coreaudio_audio_fini,
 543     INIT_FIELD (pcm_ops        = ) &coreaudio_pcm_ops,
 544     INIT_FIELD (can_be_default = ) 1,
 545     INIT_FIELD (max_voices_out = ) 1,
 546     INIT_FIELD (max_voices_in  = ) 0,
 547     INIT_FIELD (voice_size_out = ) sizeof (coreaudioVoiceOut),
 548     INIT_FIELD (voice_size_in  = ) 0
 549 };