audio/audio_legacy.c

   1 /*
   2  * QEMU Audio subsystem: legacy configuration handling
   3  *
   4  * Copyright (c) 2015-2019 Zoltán Kővágó <DirtY.iCE.hu@gmail.com>
   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 #include "qemu/osdep.h"
  25 #include "audio.h"
  26 #include "audio_int.h"
  27 #include "qemu/cutils.h"
  28 #include "qemu/timer.h"
  29 #include "qapi/error.h"
  30 #include "qapi/qapi-visit-audio.h"
  31 #include "qapi/visitor-impl.h"
  32
  33 #define AUDIO_CAP "audio-legacy"
  34 #include "audio_int.h"
  35
  36 static uint32_t toui32(const char *str)
  37 {
  38     unsigned long long ret;
  39     if (parse_uint_full(str, &ret, 10) || ret > UINT32_MAX) {
  40         dolog("Invalid integer value `%s'\n", str);
  41         exit(1);
  42     }
  43     return ret;
  44 }
  45
  46 /* helper functions to convert env variables */
  47 static void get_bool(const char *env, bool *dst, bool *has_dst)
  48 {
  49     const char *val = getenv(env);
  50     if (val) {
  51         *dst = toui32(val) != 0;
  52         *has_dst = true;
  53     }
  54 }
  55
  56 static void get_int(const char *env, uint32_t *dst, bool *has_dst)
  57 {
  58     const char *val = getenv(env);
  59     if (val) {
  60         *dst = toui32(val);
  61         *has_dst = true;
  62     }
  63 }
  64
  65 static void get_str(const char *env, char **dst)
  66 {
  67     const char *val = getenv(env);
  68     if (val) {
  69         g_free(*dst);
  70         *dst = g_strdup(val);
  71     }
  72 }
  73
  74 static void get_fmt(const char *env, AudioFormat *dst, bool *has_dst)
  75 {
  76     const char *val = getenv(env);
  77     if (val) {
  78         size_t i;
  79         for (i = 0; AudioFormat_lookup.size; ++i) {
  80             if (strcasecmp(val, AudioFormat_lookup.array[i]) == 0) {
  81                 *dst = i;
  82                 *has_dst = true;
  83                 return;
  84             }
  85         }
  86
  87         dolog("Invalid audio format `%s'\n", val);
  88         exit(1);
  89     }
  90 }
  91
  92
  93 static void get_millis_to_usecs(const char *env, uint32_t *dst, bool *has_dst)
  94 {
  95     const char *val = getenv(env);
  96     if (val) {
  97         *dst = toui32(val) * 1000;
  98         *has_dst = true;
  99     }
 100 }
 101
 102 static uint32_t frames_to_usecs(uint32_t frames,
 103                                 AudiodevPerDirectionOptions *pdo)
 104 {
 105     uint32_t freq = pdo->has_frequency ? pdo->frequency : 44100;
 106     return (frames * 1000000 + freq / 2) / freq;
 107 }
 108
 109
 110 static void get_frames_to_usecs(const char *env, uint32_t *dst, bool *has_dst,
 111                                 AudiodevPerDirectionOptions *pdo)
 112 {
 113     const char *val = getenv(env);
 114     if (val) {
 115         *dst = frames_to_usecs(toui32(val), pdo);
 116         *has_dst = true;
 117     }
 118 }
 119
 120 static uint32_t samples_to_usecs(uint32_t samples,
 121                                  AudiodevPerDirectionOptions *pdo)
 122 {
 123     uint32_t channels = pdo->has_channels ? pdo->channels : 2;
 124     return frames_to_usecs(samples / channels, pdo);
 125 }
 126
 127 static void get_samples_to_usecs(const char *env, uint32_t *dst, bool *has_dst,
 128                                  AudiodevPerDirectionOptions *pdo)
 129 {
 130     const char *val = getenv(env);
 131     if (val) {
 132         *dst = samples_to_usecs(toui32(val), pdo);
 133         *has_dst = true;
 134     }
 135 }
 136
 137 static uint32_t bytes_to_usecs(uint32_t bytes, AudiodevPerDirectionOptions *pdo)
 138 {
 139     AudioFormat fmt = pdo->has_format ? pdo->format : AUDIO_FORMAT_S16;
 140     uint32_t bytes_per_sample = audioformat_bytes_per_sample(fmt);
 141     return samples_to_usecs(bytes / bytes_per_sample, pdo);
 142 }
 143
 144 static void get_bytes_to_usecs(const char *env, uint32_t *dst, bool *has_dst,
 145                                AudiodevPerDirectionOptions *pdo)
 146 {
 147     const char *val = getenv(env);
 148     if (val) {
 149         *dst = bytes_to_usecs(toui32(val), pdo);
 150         *has_dst = true;
 151     }
 152 }
 153
 154 /* backend specific functions */
 155 /* ALSA */
 156 static void handle_alsa_per_direction(
 157     AudiodevAlsaPerDirectionOptions *apdo, const char *prefix)
 158 {
 159     char buf[64];
 160     size_t len = strlen(prefix);
 161     bool size_in_usecs = false;
 162     bool dummy;
 163
 164     memcpy(buf, prefix, len);
 165     strcpy(buf + len, "TRY_POLL");
 166     get_bool(buf, &apdo->try_poll, &apdo->has_try_poll);
 167
 168     strcpy(buf + len, "DEV");
 169     get_str(buf, &apdo->dev);
 170
 171     strcpy(buf + len, "SIZE_IN_USEC");
 172     get_bool(buf, &size_in_usecs, &dummy);
 173
 174     strcpy(buf + len, "PERIOD_SIZE");
 175     get_int(buf, &apdo->period_length, &apdo->has_period_length);
 176     if (apdo->has_period_length && !size_in_usecs) {
 177         apdo->period_length = frames_to_usecs(
 178             apdo->period_length,
 179             qapi_AudiodevAlsaPerDirectionOptions_base(apdo));
 180     }
 181
 182     strcpy(buf + len, "BUFFER_SIZE");
 183     get_int(buf, &apdo->buffer_length, &apdo->has_buffer_length);
 184     if (apdo->has_buffer_length && !size_in_usecs) {
 185         apdo->buffer_length = frames_to_usecs(
 186             apdo->buffer_length,
 187             qapi_AudiodevAlsaPerDirectionOptions_base(apdo));
 188     }
 189 }
 190
 191 static void handle_alsa(Audiodev *dev)
 192 {
 193     AudiodevAlsaOptions *aopt = &dev->u.alsa;
 194     handle_alsa_per_direction(aopt->in, "QEMU_ALSA_ADC_");
 195     handle_alsa_per_direction(aopt->out, "QEMU_ALSA_DAC_");
 196
 197     get_millis_to_usecs("QEMU_ALSA_THRESHOLD",
 198                         &aopt->threshold, &aopt->has_threshold);
 199 }
 200
 201 /* coreaudio */
 202 static void handle_coreaudio(Audiodev *dev)
 203 {
 204     get_frames_to_usecs(
 205         "QEMU_COREAUDIO_BUFFER_SIZE",
 206         &dev->u.coreaudio.out->buffer_length,
 207         &dev->u.coreaudio.out->has_buffer_length,
 208         qapi_AudiodevCoreaudioPerDirectionOptions_base(dev->u.coreaudio.out));
 209     get_int("QEMU_COREAUDIO_BUFFER_COUNT",
 210             &dev->u.coreaudio.out->buffer_count,
 211             &dev->u.coreaudio.out->has_buffer_count);
 212 }
 213
 214 /* dsound */
 215 static void handle_dsound(Audiodev *dev)
 216 {
 217     get_millis_to_usecs("QEMU_DSOUND_LATENCY_MILLIS",
 218                         &dev->u.dsound.latency, &dev->u.dsound.has_latency);
 219     get_bytes_to_usecs("QEMU_DSOUND_BUFSIZE_OUT",
 220                        &dev->u.dsound.out->buffer_length,
 221                        &dev->u.dsound.out->has_buffer_length,
 222                        dev->u.dsound.out);
 223     get_bytes_to_usecs("QEMU_DSOUND_BUFSIZE_IN",
 224                        &dev->u.dsound.in->buffer_length,
 225                        &dev->u.dsound.in->has_buffer_length,
 226                        dev->u.dsound.in);
 227 }
 228
 229 /* OSS */
 230 static void handle_oss_per_direction(
 231     AudiodevOssPerDirectionOptions *opdo, const char *try_poll_env,
 232     const char *dev_env)
 233 {
 234     get_bool(try_poll_env, &opdo->try_poll, &opdo->has_try_poll);
 235     get_str(dev_env, &opdo->dev);
 236
 237     get_bytes_to_usecs("QEMU_OSS_FRAGSIZE",
 238                        &opdo->buffer_length, &opdo->has_buffer_length,
 239                        qapi_AudiodevOssPerDirectionOptions_base(opdo));
 240     get_int("QEMU_OSS_NFRAGS", &opdo->buffer_count,
 241             &opdo->has_buffer_count);
 242 }
 243
 244 static void handle_oss(Audiodev *dev)
 245 {
 246     AudiodevOssOptions *oopt = &dev->u.oss;
 247     handle_oss_per_direction(oopt->in, "QEMU_AUDIO_ADC_TRY_POLL",
 248                              "QEMU_OSS_ADC_DEV");
 249     handle_oss_per_direction(oopt->out, "QEMU_AUDIO_DAC_TRY_POLL",
 250                              "QEMU_OSS_DAC_DEV");
 251
 252     get_bool("QEMU_OSS_MMAP", &oopt->try_mmap, &oopt->has_try_mmap);
 253     get_bool("QEMU_OSS_EXCLUSIVE", &oopt->exclusive, &oopt->has_exclusive);
 254     get_int("QEMU_OSS_POLICY", &oopt->dsp_policy, &oopt->has_dsp_policy);
 255 }
 256
 257 /* pulseaudio */
 258 static void handle_pa_per_direction(
 259     AudiodevPaPerDirectionOptions *ppdo, const char *env)
 260 {
 261     get_str(env, &ppdo->name);
 262 }
 263
 264 static void handle_pa(Audiodev *dev)
 265 {
 266     handle_pa_per_direction(dev->u.pa.in, "QEMU_PA_SOURCE");
 267     handle_pa_per_direction(dev->u.pa.out, "QEMU_PA_SINK");
 268
 269     get_samples_to_usecs(
 270         "QEMU_PA_SAMPLES", &dev->u.pa.in->buffer_length,
 271         &dev->u.pa.in->has_buffer_length,
 272         qapi_AudiodevPaPerDirectionOptions_base(dev->u.pa.in));
 273     get_samples_to_usecs(
 274         "QEMU_PA_SAMPLES", &dev->u.pa.out->buffer_length,
 275         &dev->u.pa.out->has_buffer_length,
 276         qapi_AudiodevPaPerDirectionOptions_base(dev->u.pa.out));
 277
 278     get_str("QEMU_PA_SERVER", &dev->u.pa.server);
 279 }
 280
 281 /* SDL */
 282 static void handle_sdl(Audiodev *dev)
 283 {
 284     /* SDL is output only */
 285     get_samples_to_usecs("QEMU_SDL_SAMPLES", &dev->u.sdl.out->buffer_length,
 286         &dev->u.sdl.out->has_buffer_length,
 287         qapi_AudiodevSdlPerDirectionOptions_base(dev->u.sdl.out));
 288 }
 289
 290 /* wav */
 291 static void handle_wav(Audiodev *dev)
 292 {
 293     get_int("QEMU_WAV_FREQUENCY",
 294             &dev->u.wav.out->frequency, &dev->u.wav.out->has_frequency);
 295     get_fmt("QEMU_WAV_FORMAT", &dev->u.wav.out->format,
 296             &dev->u.wav.out->has_format);
 297     get_int("QEMU_WAV_DAC_FIXED_CHANNELS",
 298             &dev->u.wav.out->channels, &dev->u.wav.out->has_channels);
 299     get_str("QEMU_WAV_PATH", &dev->u.wav.path);
 300 }
 301
 302 /* general */
 303 static void handle_per_direction(
 304     AudiodevPerDirectionOptions *pdo, const char *prefix)
 305 {
 306     char buf[64];
 307     size_t len = strlen(prefix);
 308
 309     memcpy(buf, prefix, len);
 310     strcpy(buf + len, "FIXED_SETTINGS");
 311     get_bool(buf, &pdo->fixed_settings, &pdo->has_fixed_settings);
 312
 313     strcpy(buf + len, "FIXED_FREQ");
 314     get_int(buf, &pdo->frequency, &pdo->has_frequency);
 315
 316     strcpy(buf + len, "FIXED_FMT");
 317     get_fmt(buf, &pdo->format, &pdo->has_format);
 318
 319     strcpy(buf + len, "FIXED_CHANNELS");
 320     get_int(buf, &pdo->channels, &pdo->has_channels);
 321
 322     strcpy(buf + len, "VOICES");
 323     get_int(buf, &pdo->voices, &pdo->has_voices);
 324 }
 325
 326 static AudiodevListEntry *legacy_opt(const char *drvname)
 327 {
 328     AudiodevListEntry *e = g_new0(AudiodevListEntry, 1);
 329     e->dev = g_new0(Audiodev, 1);
 330     e->dev->id = g_strdup(drvname);
 331     e->dev->driver = qapi_enum_parse(
 332         &AudiodevDriver_lookup, drvname, -1, &error_abort);
 333
 334     audio_create_pdos(e->dev);
 335
 336     handle_per_direction(audio_get_pdo_in(e->dev), "QEMU_AUDIO_ADC_");
 337     handle_per_direction(audio_get_pdo_out(e->dev), "QEMU_AUDIO_DAC_");
 338
 339     /* Original description: Timer period in HZ (0 - use lowest possible) */
 340     get_int("QEMU_AUDIO_TIMER_PERIOD",
 341             &e->dev->timer_period, &e->dev->has_timer_period);
 342     if (e->dev->has_timer_period && e->dev->timer_period) {
 343         e->dev->timer_period = NANOSECONDS_PER_SECOND / 1000 /
 344                                e->dev->timer_period;
 345     }
 346
 347     switch (e->dev->driver) {
 348     case AUDIODEV_DRIVER_ALSA:
 349         handle_alsa(e->dev);
 350         break;
 351
 352     case AUDIODEV_DRIVER_COREAUDIO:
 353         handle_coreaudio(e->dev);
 354         break;
 355
 356     case AUDIODEV_DRIVER_DSOUND:
 357         handle_dsound(e->dev);
 358         break;
 359
 360     case AUDIODEV_DRIVER_OSS:
 361         handle_oss(e->dev);
 362         break;
 363
 364     case AUDIODEV_DRIVER_PA:
 365         handle_pa(e->dev);
 366         break;
 367
 368     case AUDIODEV_DRIVER_SDL:
 369         handle_sdl(e->dev);
 370         break;
 371
 372     case AUDIODEV_DRIVER_WAV:
 373         handle_wav(e->dev);
 374         break;
 375
 376     default:
 377         break;
 378     }
 379
 380     return e;
 381 }
 382
 383 AudiodevListHead audio_handle_legacy_opts(void)
 384 {
 385     const char *drvname = getenv("QEMU_AUDIO_DRV");
 386     AudiodevListHead head = QSIMPLEQ_HEAD_INITIALIZER(head);
 387
 388     if (drvname) {
 389         AudiodevListEntry *e;
 390         audio_driver *driver = audio_driver_lookup(drvname);
 391         if (!driver) {
 392             dolog("Unknown audio driver `%s'\n", drvname);
 393             exit(1);
 394         }
 395         e = legacy_opt(drvname);
 396         QSIMPLEQ_INSERT_TAIL(&head, e, next);
 397     } else {
 398         for (int i = 0; audio_prio_list[i]; i++) {
 399             audio_driver *driver = audio_driver_lookup(audio_prio_list[i]);
 400             if (driver && driver->can_be_default) {
 401                 AudiodevListEntry *e = legacy_opt(driver->name);
 402                 QSIMPLEQ_INSERT_TAIL(&head, e, next);
 403             }
 404         }
 405         if (QSIMPLEQ_EMPTY(&head)) {
 406             dolog("Internal error: no default audio driver available\n");
 407             exit(1);
 408         }
 409     }
 410
 411     return head;
 412 }
 413
 414 /* visitor to print -audiodev option */
 415 typedef struct {
 416     Visitor visitor;
 417
 418     bool comma;
 419     GList *path;
 420 } LegacyPrintVisitor;
 421
 422 static bool lv_start_struct(Visitor *v, const char *name, void **obj,
 423                             size_t size, Error **errp)
 424 {
 425     LegacyPrintVisitor *lv = (LegacyPrintVisitor *) v;
 426     lv->path = g_list_append(lv->path, g_strdup(name));
 427     return true;
 428 }
 429
 430 static void lv_end_struct(Visitor *v, void **obj)
 431 {
 432     LegacyPrintVisitor *lv = (LegacyPrintVisitor *) v;
 433     lv->path = g_list_delete_link(lv->path, g_list_last(lv->path));
 434 }
 435
 436 static void lv_print_key(Visitor *v, const char *name)
 437 {
 438     GList *e;
 439     LegacyPrintVisitor *lv = (LegacyPrintVisitor *) v;
 440     if (lv->comma) {
 441         putchar(',');
 442     } else {
 443         lv->comma = true;
 444     }
 445
 446     for (e = lv->path; e; e = e->next) {
 447         if (e->data) {
 448             printf("%s.", (const char *) e->data);
 449         }
 450     }
 451
 452     printf("%s=", name);
 453 }
 454
 455 static bool lv_type_int64(Visitor *v, const char *name, int64_t *obj,
 456                           Error **errp)
 457 {
 458     lv_print_key(v, name);
 459     printf("%" PRIi64, *obj);
 460     return true;
 461 }
 462
 463 static bool lv_type_uint64(Visitor *v, const char *name, uint64_t *obj,
 464                            Error **errp)
 465 {
 466     lv_print_key(v, name);
 467     printf("%" PRIu64, *obj);
 468     return true;
 469 }
 470
 471 static bool lv_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
 472 {
 473     lv_print_key(v, name);
 474     printf("%s", *obj ? "on" : "off");
 475     return true;
 476 }
 477
 478 static bool lv_type_str(Visitor *v, const char *name, char **obj, Error **errp)
 479 {
 480     const char *str = *obj;
 481     lv_print_key(v, name);
 482
 483     while (*str) {
 484         if (*str == ',') {
 485             putchar(',');
 486         }
 487         putchar(*str++);
 488     }
 489     return true;
 490 }
 491
 492 static void lv_complete(Visitor *v, void *opaque)
 493 {
 494     LegacyPrintVisitor *lv = (LegacyPrintVisitor *) v;
 495     assert(lv->path == NULL);
 496 }
 497
 498 static void lv_free(Visitor *v)
 499 {
 500     LegacyPrintVisitor *lv = (LegacyPrintVisitor *) v;
 501
 502     g_list_free_full(lv->path, g_free);
 503     g_free(lv);
 504 }
 505
 506 static Visitor *legacy_visitor_new(void)
 507 {
 508     LegacyPrintVisitor *lv = g_new0(LegacyPrintVisitor, 1);
 509
 510     lv->visitor.start_struct = lv_start_struct;
 511     lv->visitor.end_struct = lv_end_struct;
 512     /* lists not supported */
 513     lv->visitor.type_int64 = lv_type_int64;
 514     lv->visitor.type_uint64 = lv_type_uint64;
 515     lv->visitor.type_bool = lv_type_bool;
 516     lv->visitor.type_str = lv_type_str;
 517
 518     lv->visitor.type = VISITOR_OUTPUT;
 519     lv->visitor.complete = lv_complete;
 520     lv->visitor.free = lv_free;
 521
 522     return &lv->visitor;
 523 }
 524
 525 void audio_legacy_help(void)
 526 {
 527     AudiodevListHead head;
 528     AudiodevListEntry *e;
 529
 530     printf("Environment variable based configuration deprecated.\n");
 531     printf("Please use the new -audiodev option.\n");
 532
 533     head = audio_handle_legacy_opts();
 534     printf("\nEquivalent -audiodev to your current environment variables:\n");
 535     if (!getenv("QEMU_AUDIO_DRV")) {
 536         printf("(Since you didn't specify QEMU_AUDIO_DRV, I'll list all "
 537                "possibilities)\n");
 538     }
 539
 540     QSIMPLEQ_FOREACH(e, &head, next) {
 541         Visitor *v;
 542         Audiodev *dev = e->dev;
 543         printf("-audiodev ");
 544
 545         v = legacy_visitor_new();
 546         visit_type_Audiodev(v, NULL, &dev, &error_abort);
 547         visit_free(v);
 548
 549         printf("\n");
 550     }
 551     audio_free_audiodev_list(&head);
 552 }