docs: rstfy vfio-ap documentation
[qemu/ar7.git] / audio / audio.c
blob9ac9a20c41bacae49ee55ae1b22ab90cab1ae670
1 /*
2 * QEMU Audio subsystem
4 * Copyright (c) 2003-2005 Vassili Karpov (malc)
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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.
25 #include "qemu/osdep.h"
26 #include "audio.h"
27 #include "migration/vmstate.h"
28 #include "monitor/monitor.h"
29 #include "qemu/timer.h"
30 #include "qapi/error.h"
31 #include "qapi/qobject-input-visitor.h"
32 #include "qapi/qapi-visit-audio.h"
33 #include "qemu/cutils.h"
34 #include "qemu/module.h"
35 #include "sysemu/replay.h"
36 #include "sysemu/runstate.h"
37 #include "trace.h"
39 #define AUDIO_CAP "audio"
40 #include "audio_int.h"
42 /* #define DEBUG_LIVE */
43 /* #define DEBUG_OUT */
44 /* #define DEBUG_CAPTURE */
45 /* #define DEBUG_POLL */
47 #define SW_NAME(sw) (sw)->name ? (sw)->name : "unknown"
50 /* Order of CONFIG_AUDIO_DRIVERS is import.
51 The 1st one is the one used by default, that is the reason
52 that we generate the list.
54 const char *audio_prio_list[] = {
55 "spice",
56 CONFIG_AUDIO_DRIVERS
57 "none",
58 "wav",
59 NULL
62 static QLIST_HEAD(, audio_driver) audio_drivers;
63 static AudiodevListHead audiodevs = QSIMPLEQ_HEAD_INITIALIZER(audiodevs);
65 void audio_driver_register(audio_driver *drv)
67 QLIST_INSERT_HEAD(&audio_drivers, drv, next);
70 audio_driver *audio_driver_lookup(const char *name)
72 struct audio_driver *d;
74 QLIST_FOREACH(d, &audio_drivers, next) {
75 if (strcmp(name, d->name) == 0) {
76 return d;
80 audio_module_load_one(name);
81 QLIST_FOREACH(d, &audio_drivers, next) {
82 if (strcmp(name, d->name) == 0) {
83 return d;
87 return NULL;
90 static QTAILQ_HEAD(AudioStateHead, AudioState) audio_states =
91 QTAILQ_HEAD_INITIALIZER(audio_states);
93 const struct mixeng_volume nominal_volume = {
94 .mute = 0,
95 #ifdef FLOAT_MIXENG
96 .r = 1.0,
97 .l = 1.0,
98 #else
99 .r = 1ULL << 32,
100 .l = 1ULL << 32,
101 #endif
104 static bool legacy_config = true;
106 #ifdef AUDIO_IS_FLAWLESS_AND_NO_CHECKS_ARE_REQURIED
107 #error No its not
108 #else
109 int audio_bug (const char *funcname, int cond)
111 if (cond) {
112 static int shown;
114 AUD_log (NULL, "A bug was just triggered in %s\n", funcname);
115 if (!shown) {
116 shown = 1;
117 AUD_log (NULL, "Save all your work and restart without audio\n");
118 AUD_log (NULL, "I am sorry\n");
120 AUD_log (NULL, "Context:\n");
122 #if defined AUDIO_BREAKPOINT_ON_BUG
123 # if defined HOST_I386
124 # if defined __GNUC__
125 __asm__ ("int3");
126 # elif defined _MSC_VER
127 _asm _emit 0xcc;
128 # else
129 abort ();
130 # endif
131 # else
132 abort ();
133 # endif
134 #endif
137 return cond;
139 #endif
141 static inline int audio_bits_to_index (int bits)
143 switch (bits) {
144 case 8:
145 return 0;
147 case 16:
148 return 1;
150 case 32:
151 return 2;
153 default:
154 audio_bug ("bits_to_index", 1);
155 AUD_log (NULL, "invalid bits %d\n", bits);
156 return 0;
160 void *audio_calloc (const char *funcname, int nmemb, size_t size)
162 int cond;
163 size_t len;
165 len = nmemb * size;
166 cond = !nmemb || !size;
167 cond |= nmemb < 0;
168 cond |= len < size;
170 if (audio_bug ("audio_calloc", cond)) {
171 AUD_log (NULL, "%s passed invalid arguments to audio_calloc\n",
172 funcname);
173 AUD_log (NULL, "nmemb=%d size=%zu (len=%zu)\n", nmemb, size, len);
174 return NULL;
177 return g_malloc0 (len);
180 void AUD_vlog (const char *cap, const char *fmt, va_list ap)
182 if (cap) {
183 fprintf(stderr, "%s: ", cap);
186 vfprintf(stderr, fmt, ap);
189 void AUD_log (const char *cap, const char *fmt, ...)
191 va_list ap;
193 va_start (ap, fmt);
194 AUD_vlog (cap, fmt, ap);
195 va_end (ap);
198 static void audio_print_settings (struct audsettings *as)
200 dolog ("frequency=%d nchannels=%d fmt=", as->freq, as->nchannels);
202 switch (as->fmt) {
203 case AUDIO_FORMAT_S8:
204 AUD_log (NULL, "S8");
205 break;
206 case AUDIO_FORMAT_U8:
207 AUD_log (NULL, "U8");
208 break;
209 case AUDIO_FORMAT_S16:
210 AUD_log (NULL, "S16");
211 break;
212 case AUDIO_FORMAT_U16:
213 AUD_log (NULL, "U16");
214 break;
215 case AUDIO_FORMAT_S32:
216 AUD_log (NULL, "S32");
217 break;
218 case AUDIO_FORMAT_U32:
219 AUD_log (NULL, "U32");
220 break;
221 case AUDIO_FORMAT_F32:
222 AUD_log (NULL, "F32");
223 break;
224 default:
225 AUD_log (NULL, "invalid(%d)", as->fmt);
226 break;
229 AUD_log (NULL, " endianness=");
230 switch (as->endianness) {
231 case 0:
232 AUD_log (NULL, "little");
233 break;
234 case 1:
235 AUD_log (NULL, "big");
236 break;
237 default:
238 AUD_log (NULL, "invalid");
239 break;
241 AUD_log (NULL, "\n");
244 static int audio_validate_settings (struct audsettings *as)
246 int invalid;
248 invalid = as->nchannels < 1;
249 invalid |= as->endianness != 0 && as->endianness != 1;
251 switch (as->fmt) {
252 case AUDIO_FORMAT_S8:
253 case AUDIO_FORMAT_U8:
254 case AUDIO_FORMAT_S16:
255 case AUDIO_FORMAT_U16:
256 case AUDIO_FORMAT_S32:
257 case AUDIO_FORMAT_U32:
258 case AUDIO_FORMAT_F32:
259 break;
260 default:
261 invalid = 1;
262 break;
265 invalid |= as->freq <= 0;
266 return invalid ? -1 : 0;
269 static int audio_pcm_info_eq (struct audio_pcm_info *info, struct audsettings *as)
271 int bits = 8;
272 bool is_signed = false, is_float = false;
274 switch (as->fmt) {
275 case AUDIO_FORMAT_S8:
276 is_signed = true;
277 /* fall through */
278 case AUDIO_FORMAT_U8:
279 break;
281 case AUDIO_FORMAT_S16:
282 is_signed = true;
283 /* fall through */
284 case AUDIO_FORMAT_U16:
285 bits = 16;
286 break;
288 case AUDIO_FORMAT_F32:
289 is_float = true;
290 /* fall through */
291 case AUDIO_FORMAT_S32:
292 is_signed = true;
293 /* fall through */
294 case AUDIO_FORMAT_U32:
295 bits = 32;
296 break;
298 default:
299 abort();
301 return info->freq == as->freq
302 && info->nchannels == as->nchannels
303 && info->is_signed == is_signed
304 && info->is_float == is_float
305 && info->bits == bits
306 && info->swap_endianness == (as->endianness != AUDIO_HOST_ENDIANNESS);
309 void audio_pcm_init_info (struct audio_pcm_info *info, struct audsettings *as)
311 int bits = 8, mul;
312 bool is_signed = false, is_float = false;
314 switch (as->fmt) {
315 case AUDIO_FORMAT_S8:
316 is_signed = true;
317 /* fall through */
318 case AUDIO_FORMAT_U8:
319 mul = 1;
320 break;
322 case AUDIO_FORMAT_S16:
323 is_signed = true;
324 /* fall through */
325 case AUDIO_FORMAT_U16:
326 bits = 16;
327 mul = 2;
328 break;
330 case AUDIO_FORMAT_F32:
331 is_float = true;
332 /* fall through */
333 case AUDIO_FORMAT_S32:
334 is_signed = true;
335 /* fall through */
336 case AUDIO_FORMAT_U32:
337 bits = 32;
338 mul = 4;
339 break;
341 default:
342 abort();
345 info->freq = as->freq;
346 info->bits = bits;
347 info->is_signed = is_signed;
348 info->is_float = is_float;
349 info->nchannels = as->nchannels;
350 info->bytes_per_frame = as->nchannels * mul;
351 info->bytes_per_second = info->freq * info->bytes_per_frame;
352 info->swap_endianness = (as->endianness != AUDIO_HOST_ENDIANNESS);
355 void audio_pcm_info_clear_buf (struct audio_pcm_info *info, void *buf, int len)
357 if (!len) {
358 return;
361 if (info->is_signed || info->is_float) {
362 memset(buf, 0x00, len * info->bytes_per_frame);
364 else {
365 switch (info->bits) {
366 case 8:
367 memset(buf, 0x80, len * info->bytes_per_frame);
368 break;
370 case 16:
372 int i;
373 uint16_t *p = buf;
374 short s = INT16_MAX;
376 if (info->swap_endianness) {
377 s = bswap16 (s);
380 for (i = 0; i < len * info->nchannels; i++) {
381 p[i] = s;
384 break;
386 case 32:
388 int i;
389 uint32_t *p = buf;
390 int32_t s = INT32_MAX;
392 if (info->swap_endianness) {
393 s = bswap32 (s);
396 for (i = 0; i < len * info->nchannels; i++) {
397 p[i] = s;
400 break;
402 default:
403 AUD_log (NULL, "audio_pcm_info_clear_buf: invalid bits %d\n",
404 info->bits);
405 break;
411 * Capture
413 static void noop_conv (struct st_sample *dst, const void *src, int samples)
415 (void) src;
416 (void) dst;
417 (void) samples;
420 static CaptureVoiceOut *audio_pcm_capture_find_specific(AudioState *s,
421 struct audsettings *as)
423 CaptureVoiceOut *cap;
425 for (cap = s->cap_head.lh_first; cap; cap = cap->entries.le_next) {
426 if (audio_pcm_info_eq (&cap->hw.info, as)) {
427 return cap;
430 return NULL;
433 static void audio_notify_capture (CaptureVoiceOut *cap, audcnotification_e cmd)
435 struct capture_callback *cb;
437 #ifdef DEBUG_CAPTURE
438 dolog ("notification %d sent\n", cmd);
439 #endif
440 for (cb = cap->cb_head.lh_first; cb; cb = cb->entries.le_next) {
441 cb->ops.notify (cb->opaque, cmd);
445 static void audio_capture_maybe_changed (CaptureVoiceOut *cap, int enabled)
447 if (cap->hw.enabled != enabled) {
448 audcnotification_e cmd;
449 cap->hw.enabled = enabled;
450 cmd = enabled ? AUD_CNOTIFY_ENABLE : AUD_CNOTIFY_DISABLE;
451 audio_notify_capture (cap, cmd);
455 static void audio_recalc_and_notify_capture (CaptureVoiceOut *cap)
457 HWVoiceOut *hw = &cap->hw;
458 SWVoiceOut *sw;
459 int enabled = 0;
461 for (sw = hw->sw_head.lh_first; sw; sw = sw->entries.le_next) {
462 if (sw->active) {
463 enabled = 1;
464 break;
467 audio_capture_maybe_changed (cap, enabled);
470 static void audio_detach_capture (HWVoiceOut *hw)
472 SWVoiceCap *sc = hw->cap_head.lh_first;
474 while (sc) {
475 SWVoiceCap *sc1 = sc->entries.le_next;
476 SWVoiceOut *sw = &sc->sw;
477 CaptureVoiceOut *cap = sc->cap;
478 int was_active = sw->active;
480 if (sw->rate) {
481 st_rate_stop (sw->rate);
482 sw->rate = NULL;
485 QLIST_REMOVE (sw, entries);
486 QLIST_REMOVE (sc, entries);
487 g_free (sc);
488 if (was_active) {
489 /* We have removed soft voice from the capture:
490 this might have changed the overall status of the capture
491 since this might have been the only active voice */
492 audio_recalc_and_notify_capture (cap);
494 sc = sc1;
498 static int audio_attach_capture (HWVoiceOut *hw)
500 AudioState *s = hw->s;
501 CaptureVoiceOut *cap;
503 audio_detach_capture (hw);
504 for (cap = s->cap_head.lh_first; cap; cap = cap->entries.le_next) {
505 SWVoiceCap *sc;
506 SWVoiceOut *sw;
507 HWVoiceOut *hw_cap = &cap->hw;
509 sc = g_malloc0(sizeof(*sc));
511 sc->cap = cap;
512 sw = &sc->sw;
513 sw->hw = hw_cap;
514 sw->info = hw->info;
515 sw->empty = 1;
516 sw->active = hw->enabled;
517 sw->conv = noop_conv;
518 sw->ratio = ((int64_t) hw_cap->info.freq << 32) / sw->info.freq;
519 sw->vol = nominal_volume;
520 sw->rate = st_rate_start (sw->info.freq, hw_cap->info.freq);
521 if (!sw->rate) {
522 dolog ("Could not start rate conversion for `%s'\n", SW_NAME (sw));
523 g_free (sw);
524 return -1;
526 QLIST_INSERT_HEAD (&hw_cap->sw_head, sw, entries);
527 QLIST_INSERT_HEAD (&hw->cap_head, sc, entries);
528 #ifdef DEBUG_CAPTURE
529 sw->name = g_strdup_printf ("for %p %d,%d,%d",
530 hw, sw->info.freq, sw->info.bits,
531 sw->info.nchannels);
532 dolog ("Added %s active = %d\n", sw->name, sw->active);
533 #endif
534 if (sw->active) {
535 audio_capture_maybe_changed (cap, 1);
538 return 0;
542 * Hard voice (capture)
544 static size_t audio_pcm_hw_find_min_in (HWVoiceIn *hw)
546 SWVoiceIn *sw;
547 size_t m = hw->total_samples_captured;
549 for (sw = hw->sw_head.lh_first; sw; sw = sw->entries.le_next) {
550 if (sw->active) {
551 m = MIN (m, sw->total_hw_samples_acquired);
554 return m;
557 static size_t audio_pcm_hw_get_live_in(HWVoiceIn *hw)
559 size_t live = hw->total_samples_captured - audio_pcm_hw_find_min_in (hw);
560 if (audio_bug(__func__, live > hw->conv_buf->size)) {
561 dolog("live=%zu hw->conv_buf->size=%zu\n", live, hw->conv_buf->size);
562 return 0;
564 return live;
567 static void audio_pcm_hw_clip_out(HWVoiceOut *hw, void *pcm_buf, size_t len)
569 size_t clipped = 0;
570 size_t pos = hw->mix_buf->pos;
572 while (len) {
573 st_sample *src = hw->mix_buf->samples + pos;
574 uint8_t *dst = advance(pcm_buf, clipped * hw->info.bytes_per_frame);
575 size_t samples_till_end_of_buf = hw->mix_buf->size - pos;
576 size_t samples_to_clip = MIN(len, samples_till_end_of_buf);
578 hw->clip(dst, src, samples_to_clip);
580 pos = (pos + samples_to_clip) % hw->mix_buf->size;
581 len -= samples_to_clip;
582 clipped += samples_to_clip;
587 * Soft voice (capture)
589 static size_t audio_pcm_sw_get_rpos_in(SWVoiceIn *sw)
591 HWVoiceIn *hw = sw->hw;
592 ssize_t live = hw->total_samples_captured - sw->total_hw_samples_acquired;
593 ssize_t rpos;
595 if (audio_bug(__func__, live < 0 || live > hw->conv_buf->size)) {
596 dolog("live=%zu hw->conv_buf->size=%zu\n", live, hw->conv_buf->size);
597 return 0;
600 rpos = hw->conv_buf->pos - live;
601 if (rpos >= 0) {
602 return rpos;
604 else {
605 return hw->conv_buf->size + rpos;
609 static size_t audio_pcm_sw_read(SWVoiceIn *sw, void *buf, size_t size)
611 HWVoiceIn *hw = sw->hw;
612 size_t samples, live, ret = 0, swlim, isamp, osamp, rpos, total = 0;
613 struct st_sample *src, *dst = sw->buf;
615 rpos = audio_pcm_sw_get_rpos_in(sw) % hw->conv_buf->size;
617 live = hw->total_samples_captured - sw->total_hw_samples_acquired;
618 if (audio_bug(__func__, live > hw->conv_buf->size)) {
619 dolog("live_in=%zu hw->conv_buf->size=%zu\n", live, hw->conv_buf->size);
620 return 0;
623 samples = size / sw->info.bytes_per_frame;
624 if (!live) {
625 return 0;
628 swlim = (live * sw->ratio) >> 32;
629 swlim = MIN (swlim, samples);
631 while (swlim) {
632 src = hw->conv_buf->samples + rpos;
633 if (hw->conv_buf->pos > rpos) {
634 isamp = hw->conv_buf->pos - rpos;
635 } else {
636 isamp = hw->conv_buf->size - rpos;
639 if (!isamp) {
640 break;
642 osamp = swlim;
644 st_rate_flow (sw->rate, src, dst, &isamp, &osamp);
645 swlim -= osamp;
646 rpos = (rpos + isamp) % hw->conv_buf->size;
647 dst += osamp;
648 ret += osamp;
649 total += isamp;
652 if (!hw->pcm_ops->volume_in) {
653 mixeng_volume (sw->buf, ret, &sw->vol);
656 sw->clip (buf, sw->buf, ret);
657 sw->total_hw_samples_acquired += total;
658 return ret * sw->info.bytes_per_frame;
662 * Hard voice (playback)
664 static size_t audio_pcm_hw_find_min_out (HWVoiceOut *hw, int *nb_livep)
666 SWVoiceOut *sw;
667 size_t m = SIZE_MAX;
668 int nb_live = 0;
670 for (sw = hw->sw_head.lh_first; sw; sw = sw->entries.le_next) {
671 if (sw->active || !sw->empty) {
672 m = MIN (m, sw->total_hw_samples_mixed);
673 nb_live += 1;
677 *nb_livep = nb_live;
678 return m;
681 static size_t audio_pcm_hw_get_live_out (HWVoiceOut *hw, int *nb_live)
683 size_t smin;
684 int nb_live1;
686 smin = audio_pcm_hw_find_min_out (hw, &nb_live1);
687 if (nb_live) {
688 *nb_live = nb_live1;
691 if (nb_live1) {
692 size_t live = smin;
694 if (audio_bug(__func__, live > hw->mix_buf->size)) {
695 dolog("live=%zu hw->mix_buf->size=%zu\n", live, hw->mix_buf->size);
696 return 0;
698 return live;
700 return 0;
704 * Soft voice (playback)
706 static size_t audio_pcm_sw_write(SWVoiceOut *sw, void *buf, size_t size)
708 size_t hwsamples, samples, isamp, osamp, wpos, live, dead, left, swlim, blck;
709 size_t ret = 0, pos = 0, total = 0;
711 if (!sw) {
712 return size;
715 hwsamples = sw->hw->mix_buf->size;
717 live = sw->total_hw_samples_mixed;
718 if (audio_bug(__func__, live > hwsamples)) {
719 dolog("live=%zu hw->mix_buf->size=%zu\n", live, hwsamples);
720 return 0;
723 if (live == hwsamples) {
724 #ifdef DEBUG_OUT
725 dolog ("%s is full %d\n", sw->name, live);
726 #endif
727 return 0;
730 wpos = (sw->hw->mix_buf->pos + live) % hwsamples;
731 samples = size / sw->info.bytes_per_frame;
733 dead = hwsamples - live;
734 swlim = ((int64_t) dead << 32) / sw->ratio;
735 swlim = MIN (swlim, samples);
736 if (swlim) {
737 sw->conv (sw->buf, buf, swlim);
739 if (!sw->hw->pcm_ops->volume_out) {
740 mixeng_volume (sw->buf, swlim, &sw->vol);
744 while (swlim) {
745 dead = hwsamples - live;
746 left = hwsamples - wpos;
747 blck = MIN (dead, left);
748 if (!blck) {
749 break;
751 isamp = swlim;
752 osamp = blck;
753 st_rate_flow_mix (
754 sw->rate,
755 sw->buf + pos,
756 sw->hw->mix_buf->samples + wpos,
757 &isamp,
758 &osamp
760 ret += isamp;
761 swlim -= isamp;
762 pos += isamp;
763 live += osamp;
764 wpos = (wpos + osamp) % hwsamples;
765 total += osamp;
768 sw->total_hw_samples_mixed += total;
769 sw->empty = sw->total_hw_samples_mixed == 0;
771 #ifdef DEBUG_OUT
772 dolog (
773 "%s: write size %zu ret %zu total sw %zu\n",
774 SW_NAME (sw),
775 size / sw->info.bytes_per_frame,
776 ret,
777 sw->total_hw_samples_mixed
779 #endif
781 return ret * sw->info.bytes_per_frame;
784 #ifdef DEBUG_AUDIO
785 static void audio_pcm_print_info (const char *cap, struct audio_pcm_info *info)
787 dolog("%s: bits %d, sign %d, float %d, freq %d, nchan %d\n",
788 cap, info->bits, info->is_signed, info->is_float, info->freq,
789 info->nchannels);
791 #endif
793 #define DAC
794 #include "audio_template.h"
795 #undef DAC
796 #include "audio_template.h"
799 * Timer
801 static int audio_is_timer_needed(AudioState *s)
803 HWVoiceIn *hwi = NULL;
804 HWVoiceOut *hwo = NULL;
806 while ((hwo = audio_pcm_hw_find_any_enabled_out(s, hwo))) {
807 if (!hwo->poll_mode) return 1;
809 while ((hwi = audio_pcm_hw_find_any_enabled_in(s, hwi))) {
810 if (!hwi->poll_mode) return 1;
812 return 0;
815 static void audio_reset_timer (AudioState *s)
817 if (audio_is_timer_needed(s)) {
818 timer_mod_anticipate_ns(s->ts,
819 qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + s->period_ticks);
820 if (!s->timer_running) {
821 s->timer_running = true;
822 s->timer_last = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
823 trace_audio_timer_start(s->period_ticks / SCALE_MS);
825 } else {
826 timer_del(s->ts);
827 if (s->timer_running) {
828 s->timer_running = false;
829 trace_audio_timer_stop();
834 static void audio_timer (void *opaque)
836 int64_t now, diff;
837 AudioState *s = opaque;
839 now = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
840 diff = now - s->timer_last;
841 if (diff > s->period_ticks * 3 / 2) {
842 trace_audio_timer_delayed(diff / SCALE_MS);
844 s->timer_last = now;
846 audio_run(s, "timer");
847 audio_reset_timer(s);
851 * Public API
853 size_t AUD_write(SWVoiceOut *sw, void *buf, size_t size)
855 HWVoiceOut *hw;
857 if (!sw) {
858 /* XXX: Consider options */
859 return size;
861 hw = sw->hw;
863 if (!hw->enabled) {
864 dolog ("Writing to disabled voice %s\n", SW_NAME (sw));
865 return 0;
868 if (audio_get_pdo_out(hw->s->dev)->mixing_engine) {
869 return audio_pcm_sw_write(sw, buf, size);
870 } else {
871 return hw->pcm_ops->write(hw, buf, size);
875 size_t AUD_read(SWVoiceIn *sw, void *buf, size_t size)
877 HWVoiceIn *hw;
879 if (!sw) {
880 /* XXX: Consider options */
881 return size;
883 hw = sw->hw;
885 if (!hw->enabled) {
886 dolog ("Reading from disabled voice %s\n", SW_NAME (sw));
887 return 0;
890 if (audio_get_pdo_in(hw->s->dev)->mixing_engine) {
891 return audio_pcm_sw_read(sw, buf, size);
892 } else {
893 return hw->pcm_ops->read(hw, buf, size);
897 int AUD_get_buffer_size_out(SWVoiceOut *sw)
899 return sw->hw->samples * sw->hw->info.bytes_per_frame;
902 void AUD_set_active_out (SWVoiceOut *sw, int on)
904 HWVoiceOut *hw;
906 if (!sw) {
907 return;
910 hw = sw->hw;
911 if (sw->active != on) {
912 AudioState *s = sw->s;
913 SWVoiceOut *temp_sw;
914 SWVoiceCap *sc;
916 if (on) {
917 hw->pending_disable = 0;
918 if (!hw->enabled) {
919 hw->enabled = 1;
920 if (s->vm_running) {
921 if (hw->pcm_ops->enable_out) {
922 hw->pcm_ops->enable_out(hw, true);
924 audio_reset_timer (s);
928 else {
929 if (hw->enabled) {
930 int nb_active = 0;
932 for (temp_sw = hw->sw_head.lh_first; temp_sw;
933 temp_sw = temp_sw->entries.le_next) {
934 nb_active += temp_sw->active != 0;
937 hw->pending_disable = nb_active == 1;
941 for (sc = hw->cap_head.lh_first; sc; sc = sc->entries.le_next) {
942 sc->sw.active = hw->enabled;
943 if (hw->enabled) {
944 audio_capture_maybe_changed (sc->cap, 1);
947 sw->active = on;
951 void AUD_set_active_in (SWVoiceIn *sw, int on)
953 HWVoiceIn *hw;
955 if (!sw) {
956 return;
959 hw = sw->hw;
960 if (sw->active != on) {
961 AudioState *s = sw->s;
962 SWVoiceIn *temp_sw;
964 if (on) {
965 if (!hw->enabled) {
966 hw->enabled = 1;
967 if (s->vm_running) {
968 if (hw->pcm_ops->enable_in) {
969 hw->pcm_ops->enable_in(hw, true);
971 audio_reset_timer (s);
974 sw->total_hw_samples_acquired = hw->total_samples_captured;
976 else {
977 if (hw->enabled) {
978 int nb_active = 0;
980 for (temp_sw = hw->sw_head.lh_first; temp_sw;
981 temp_sw = temp_sw->entries.le_next) {
982 nb_active += temp_sw->active != 0;
985 if (nb_active == 1) {
986 hw->enabled = 0;
987 if (hw->pcm_ops->enable_in) {
988 hw->pcm_ops->enable_in(hw, false);
993 sw->active = on;
997 static size_t audio_get_avail (SWVoiceIn *sw)
999 size_t live;
1001 if (!sw) {
1002 return 0;
1005 live = sw->hw->total_samples_captured - sw->total_hw_samples_acquired;
1006 if (audio_bug(__func__, live > sw->hw->conv_buf->size)) {
1007 dolog("live=%zu sw->hw->conv_buf->size=%zu\n", live,
1008 sw->hw->conv_buf->size);
1009 return 0;
1012 ldebug (
1013 "%s: get_avail live %d ret %" PRId64 "\n",
1014 SW_NAME (sw),
1015 live, (((int64_t) live << 32) / sw->ratio) * sw->info.bytes_per_frame
1018 return (((int64_t) live << 32) / sw->ratio) * sw->info.bytes_per_frame;
1021 static size_t audio_get_free(SWVoiceOut *sw)
1023 size_t live, dead;
1025 if (!sw) {
1026 return 0;
1029 live = sw->total_hw_samples_mixed;
1031 if (audio_bug(__func__, live > sw->hw->mix_buf->size)) {
1032 dolog("live=%zu sw->hw->mix_buf->size=%zu\n", live,
1033 sw->hw->mix_buf->size);
1034 return 0;
1037 dead = sw->hw->mix_buf->size - live;
1039 #ifdef DEBUG_OUT
1040 dolog ("%s: get_free live %d dead %d ret %" PRId64 "\n",
1041 SW_NAME (sw),
1042 live, dead, (((int64_t) dead << 32) / sw->ratio) *
1043 sw->info.bytes_per_frame);
1044 #endif
1046 return (((int64_t) dead << 32) / sw->ratio) * sw->info.bytes_per_frame;
1049 static void audio_capture_mix_and_clear(HWVoiceOut *hw, size_t rpos,
1050 size_t samples)
1052 size_t n;
1054 if (hw->enabled) {
1055 SWVoiceCap *sc;
1057 for (sc = hw->cap_head.lh_first; sc; sc = sc->entries.le_next) {
1058 SWVoiceOut *sw = &sc->sw;
1059 int rpos2 = rpos;
1061 n = samples;
1062 while (n) {
1063 size_t till_end_of_hw = hw->mix_buf->size - rpos2;
1064 size_t to_write = MIN(till_end_of_hw, n);
1065 size_t bytes = to_write * hw->info.bytes_per_frame;
1066 size_t written;
1068 sw->buf = hw->mix_buf->samples + rpos2;
1069 written = audio_pcm_sw_write (sw, NULL, bytes);
1070 if (written - bytes) {
1071 dolog("Could not mix %zu bytes into a capture "
1072 "buffer, mixed %zu\n",
1073 bytes, written);
1074 break;
1076 n -= to_write;
1077 rpos2 = (rpos2 + to_write) % hw->mix_buf->size;
1082 n = MIN(samples, hw->mix_buf->size - rpos);
1083 mixeng_clear(hw->mix_buf->samples + rpos, n);
1084 mixeng_clear(hw->mix_buf->samples, samples - n);
1087 static size_t audio_pcm_hw_run_out(HWVoiceOut *hw, size_t live)
1089 size_t clipped = 0;
1091 while (live) {
1092 size_t size, decr, proc;
1093 void *buf = hw->pcm_ops->get_buffer_out(hw, &size);
1094 if (!buf || size == 0) {
1095 break;
1098 decr = MIN(size / hw->info.bytes_per_frame, live);
1099 audio_pcm_hw_clip_out(hw, buf, decr);
1100 proc = hw->pcm_ops->put_buffer_out(hw, buf,
1101 decr * hw->info.bytes_per_frame) /
1102 hw->info.bytes_per_frame;
1104 live -= proc;
1105 clipped += proc;
1106 hw->mix_buf->pos = (hw->mix_buf->pos + proc) % hw->mix_buf->size;
1108 if (proc == 0 || proc < decr) {
1109 break;
1113 if (hw->pcm_ops->run_buffer_out) {
1114 hw->pcm_ops->run_buffer_out(hw);
1117 return clipped;
1120 static void audio_run_out (AudioState *s)
1122 HWVoiceOut *hw = NULL;
1123 SWVoiceOut *sw;
1125 if (!audio_get_pdo_out(s->dev)->mixing_engine) {
1126 while ((hw = audio_pcm_hw_find_any_enabled_out(s, hw))) {
1127 /* there is exactly 1 sw for each hw with no mixeng */
1128 sw = hw->sw_head.lh_first;
1130 if (hw->pending_disable) {
1131 hw->enabled = 0;
1132 hw->pending_disable = 0;
1133 if (hw->pcm_ops->enable_out) {
1134 hw->pcm_ops->enable_out(hw, false);
1138 if (sw->active) {
1139 sw->callback.fn(sw->callback.opaque, INT_MAX);
1142 return;
1145 while ((hw = audio_pcm_hw_find_any_enabled_out(s, hw))) {
1146 size_t played, live, prev_rpos, free;
1147 int nb_live, cleanup_required;
1149 live = audio_pcm_hw_get_live_out (hw, &nb_live);
1150 if (!nb_live) {
1151 live = 0;
1154 if (audio_bug(__func__, live > hw->mix_buf->size)) {
1155 dolog("live=%zu hw->mix_buf->size=%zu\n", live, hw->mix_buf->size);
1156 continue;
1159 if (hw->pending_disable && !nb_live) {
1160 SWVoiceCap *sc;
1161 #ifdef DEBUG_OUT
1162 dolog ("Disabling voice\n");
1163 #endif
1164 hw->enabled = 0;
1165 hw->pending_disable = 0;
1166 if (hw->pcm_ops->enable_out) {
1167 hw->pcm_ops->enable_out(hw, false);
1169 for (sc = hw->cap_head.lh_first; sc; sc = sc->entries.le_next) {
1170 sc->sw.active = 0;
1171 audio_recalc_and_notify_capture (sc->cap);
1173 continue;
1176 if (!live) {
1177 for (sw = hw->sw_head.lh_first; sw; sw = sw->entries.le_next) {
1178 if (sw->active) {
1179 free = audio_get_free (sw);
1180 if (free > 0) {
1181 sw->callback.fn (sw->callback.opaque, free);
1185 continue;
1188 prev_rpos = hw->mix_buf->pos;
1189 played = audio_pcm_hw_run_out(hw, live);
1190 replay_audio_out(&played);
1191 if (audio_bug(__func__, hw->mix_buf->pos >= hw->mix_buf->size)) {
1192 dolog("hw->mix_buf->pos=%zu hw->mix_buf->size=%zu played=%zu\n",
1193 hw->mix_buf->pos, hw->mix_buf->size, played);
1194 hw->mix_buf->pos = 0;
1197 #ifdef DEBUG_OUT
1198 dolog("played=%zu\n", played);
1199 #endif
1201 if (played) {
1202 hw->ts_helper += played;
1203 audio_capture_mix_and_clear (hw, prev_rpos, played);
1206 cleanup_required = 0;
1207 for (sw = hw->sw_head.lh_first; sw; sw = sw->entries.le_next) {
1208 if (!sw->active && sw->empty) {
1209 continue;
1212 if (audio_bug(__func__, played > sw->total_hw_samples_mixed)) {
1213 dolog("played=%zu sw->total_hw_samples_mixed=%zu\n",
1214 played, sw->total_hw_samples_mixed);
1215 played = sw->total_hw_samples_mixed;
1218 sw->total_hw_samples_mixed -= played;
1220 if (!sw->total_hw_samples_mixed) {
1221 sw->empty = 1;
1222 cleanup_required |= !sw->active && !sw->callback.fn;
1225 if (sw->active) {
1226 free = audio_get_free (sw);
1227 if (free > 0) {
1228 sw->callback.fn (sw->callback.opaque, free);
1233 if (cleanup_required) {
1234 SWVoiceOut *sw1;
1236 sw = hw->sw_head.lh_first;
1237 while (sw) {
1238 sw1 = sw->entries.le_next;
1239 if (!sw->active && !sw->callback.fn) {
1240 audio_close_out (sw);
1242 sw = sw1;
1248 static size_t audio_pcm_hw_run_in(HWVoiceIn *hw, size_t samples)
1250 size_t conv = 0;
1251 STSampleBuffer *conv_buf = hw->conv_buf;
1253 while (samples) {
1254 size_t proc;
1255 size_t size = samples * hw->info.bytes_per_frame;
1256 void *buf = hw->pcm_ops->get_buffer_in(hw, &size);
1258 assert(size % hw->info.bytes_per_frame == 0);
1259 if (size == 0) {
1260 hw->pcm_ops->put_buffer_in(hw, buf, size);
1261 break;
1264 proc = MIN(size / hw->info.bytes_per_frame,
1265 conv_buf->size - conv_buf->pos);
1267 hw->conv(conv_buf->samples + conv_buf->pos, buf, proc);
1268 conv_buf->pos = (conv_buf->pos + proc) % conv_buf->size;
1270 samples -= proc;
1271 conv += proc;
1272 hw->pcm_ops->put_buffer_in(hw, buf, proc * hw->info.bytes_per_frame);
1275 return conv;
1278 static void audio_run_in (AudioState *s)
1280 HWVoiceIn *hw = NULL;
1282 if (!audio_get_pdo_in(s->dev)->mixing_engine) {
1283 while ((hw = audio_pcm_hw_find_any_enabled_in(s, hw))) {
1284 /* there is exactly 1 sw for each hw with no mixeng */
1285 SWVoiceIn *sw = hw->sw_head.lh_first;
1286 if (sw->active) {
1287 sw->callback.fn(sw->callback.opaque, INT_MAX);
1290 return;
1293 while ((hw = audio_pcm_hw_find_any_enabled_in(s, hw))) {
1294 SWVoiceIn *sw;
1295 size_t captured = 0, min;
1297 if (replay_mode != REPLAY_MODE_PLAY) {
1298 captured = audio_pcm_hw_run_in(
1299 hw, hw->conv_buf->size - audio_pcm_hw_get_live_in(hw));
1301 replay_audio_in(&captured, hw->conv_buf->samples, &hw->conv_buf->pos,
1302 hw->conv_buf->size);
1304 min = audio_pcm_hw_find_min_in (hw);
1305 hw->total_samples_captured += captured - min;
1306 hw->ts_helper += captured;
1308 for (sw = hw->sw_head.lh_first; sw; sw = sw->entries.le_next) {
1309 sw->total_hw_samples_acquired -= min;
1311 if (sw->active) {
1312 size_t avail;
1314 avail = audio_get_avail (sw);
1315 if (avail > 0) {
1316 sw->callback.fn (sw->callback.opaque, avail);
1323 static void audio_run_capture (AudioState *s)
1325 CaptureVoiceOut *cap;
1327 for (cap = s->cap_head.lh_first; cap; cap = cap->entries.le_next) {
1328 size_t live, rpos, captured;
1329 HWVoiceOut *hw = &cap->hw;
1330 SWVoiceOut *sw;
1332 captured = live = audio_pcm_hw_get_live_out (hw, NULL);
1333 rpos = hw->mix_buf->pos;
1334 while (live) {
1335 size_t left = hw->mix_buf->size - rpos;
1336 size_t to_capture = MIN(live, left);
1337 struct st_sample *src;
1338 struct capture_callback *cb;
1340 src = hw->mix_buf->samples + rpos;
1341 hw->clip (cap->buf, src, to_capture);
1342 mixeng_clear (src, to_capture);
1344 for (cb = cap->cb_head.lh_first; cb; cb = cb->entries.le_next) {
1345 cb->ops.capture (cb->opaque, cap->buf,
1346 to_capture * hw->info.bytes_per_frame);
1348 rpos = (rpos + to_capture) % hw->mix_buf->size;
1349 live -= to_capture;
1351 hw->mix_buf->pos = rpos;
1353 for (sw = hw->sw_head.lh_first; sw; sw = sw->entries.le_next) {
1354 if (!sw->active && sw->empty) {
1355 continue;
1358 if (audio_bug(__func__, captured > sw->total_hw_samples_mixed)) {
1359 dolog("captured=%zu sw->total_hw_samples_mixed=%zu\n",
1360 captured, sw->total_hw_samples_mixed);
1361 captured = sw->total_hw_samples_mixed;
1364 sw->total_hw_samples_mixed -= captured;
1365 sw->empty = sw->total_hw_samples_mixed == 0;
1370 void audio_run(AudioState *s, const char *msg)
1372 audio_run_out(s);
1373 audio_run_in(s);
1374 audio_run_capture(s);
1376 #ifdef DEBUG_POLL
1378 static double prevtime;
1379 double currtime;
1380 struct timeval tv;
1382 if (gettimeofday (&tv, NULL)) {
1383 perror ("audio_run: gettimeofday");
1384 return;
1387 currtime = tv.tv_sec + tv.tv_usec * 1e-6;
1388 dolog ("Elapsed since last %s: %f\n", msg, currtime - prevtime);
1389 prevtime = currtime;
1391 #endif
1394 void *audio_generic_get_buffer_in(HWVoiceIn *hw, size_t *size)
1396 ssize_t start;
1398 if (unlikely(!hw->buf_emul)) {
1399 size_t calc_size = hw->conv_buf->size * hw->info.bytes_per_frame;
1400 hw->buf_emul = g_malloc(calc_size);
1401 hw->size_emul = calc_size;
1402 hw->pos_emul = hw->pending_emul = 0;
1405 while (hw->pending_emul < hw->size_emul) {
1406 size_t read_len = MIN(hw->size_emul - hw->pos_emul,
1407 hw->size_emul - hw->pending_emul);
1408 size_t read = hw->pcm_ops->read(hw, hw->buf_emul + hw->pos_emul,
1409 read_len);
1410 hw->pending_emul += read;
1411 hw->pos_emul = (hw->pos_emul + read) % hw->size_emul;
1412 if (read < read_len) {
1413 break;
1417 start = ((ssize_t) hw->pos_emul) - hw->pending_emul;
1418 if (start < 0) {
1419 start += hw->size_emul;
1421 assert(start >= 0 && start < hw->size_emul);
1423 *size = MIN(*size, hw->pending_emul);
1424 *size = MIN(*size, hw->size_emul - start);
1425 return hw->buf_emul + start;
1428 void audio_generic_put_buffer_in(HWVoiceIn *hw, void *buf, size_t size)
1430 assert(size <= hw->pending_emul);
1431 hw->pending_emul -= size;
1434 void audio_generic_run_buffer_out(HWVoiceOut *hw)
1436 while (hw->pending_emul) {
1437 size_t write_len, written;
1438 ssize_t start = ((ssize_t) hw->pos_emul) - hw->pending_emul;
1440 if (start < 0) {
1441 start += hw->size_emul;
1443 assert(start >= 0 && start < hw->size_emul);
1445 write_len = MIN(hw->pending_emul, hw->size_emul - start);
1447 written = hw->pcm_ops->write(hw, hw->buf_emul + start, write_len);
1448 hw->pending_emul -= written;
1450 if (written < write_len) {
1451 break;
1456 void *audio_generic_get_buffer_out(HWVoiceOut *hw, size_t *size)
1458 if (unlikely(!hw->buf_emul)) {
1459 size_t calc_size = hw->mix_buf->size * hw->info.bytes_per_frame;
1461 hw->buf_emul = g_malloc(calc_size);
1462 hw->size_emul = calc_size;
1463 hw->pos_emul = hw->pending_emul = 0;
1466 *size = MIN(hw->size_emul - hw->pending_emul,
1467 hw->size_emul - hw->pos_emul);
1468 return hw->buf_emul + hw->pos_emul;
1471 size_t audio_generic_put_buffer_out(HWVoiceOut *hw, void *buf, size_t size)
1473 assert(buf == hw->buf_emul + hw->pos_emul &&
1474 size + hw->pending_emul <= hw->size_emul);
1476 hw->pending_emul += size;
1477 hw->pos_emul = (hw->pos_emul + size) % hw->size_emul;
1479 return size;
1482 size_t audio_generic_write(HWVoiceOut *hw, void *buf, size_t size)
1484 size_t dst_size, copy_size;
1485 void *dst = hw->pcm_ops->get_buffer_out(hw, &dst_size);
1486 copy_size = MIN(size, dst_size);
1488 memcpy(dst, buf, copy_size);
1489 return hw->pcm_ops->put_buffer_out(hw, dst, copy_size);
1492 size_t audio_generic_read(HWVoiceIn *hw, void *buf, size_t size)
1494 size_t src_size, copy_size;
1495 void *src = hw->pcm_ops->get_buffer_in(hw, &src_size);
1496 copy_size = MIN(size, src_size);
1498 memcpy(buf, src, copy_size);
1499 hw->pcm_ops->put_buffer_in(hw, src, copy_size);
1500 return copy_size;
1504 static int audio_driver_init(AudioState *s, struct audio_driver *drv,
1505 bool msg, Audiodev *dev)
1507 s->drv_opaque = drv->init(dev);
1509 if (s->drv_opaque) {
1510 if (!drv->pcm_ops->get_buffer_in) {
1511 drv->pcm_ops->get_buffer_in = audio_generic_get_buffer_in;
1512 drv->pcm_ops->put_buffer_in = audio_generic_put_buffer_in;
1514 if (!drv->pcm_ops->get_buffer_out) {
1515 drv->pcm_ops->get_buffer_out = audio_generic_get_buffer_out;
1516 drv->pcm_ops->put_buffer_out = audio_generic_put_buffer_out;
1519 audio_init_nb_voices_out(s, drv);
1520 audio_init_nb_voices_in(s, drv);
1521 s->drv = drv;
1522 return 0;
1524 else {
1525 if (msg) {
1526 dolog("Could not init `%s' audio driver\n", drv->name);
1528 return -1;
1532 static void audio_vm_change_state_handler (void *opaque, int running,
1533 RunState state)
1535 AudioState *s = opaque;
1536 HWVoiceOut *hwo = NULL;
1537 HWVoiceIn *hwi = NULL;
1539 s->vm_running = running;
1540 while ((hwo = audio_pcm_hw_find_any_enabled_out(s, hwo))) {
1541 if (hwo->pcm_ops->enable_out) {
1542 hwo->pcm_ops->enable_out(hwo, running);
1546 while ((hwi = audio_pcm_hw_find_any_enabled_in(s, hwi))) {
1547 if (hwi->pcm_ops->enable_in) {
1548 hwi->pcm_ops->enable_in(hwi, running);
1551 audio_reset_timer (s);
1554 static bool is_cleaning_up;
1556 bool audio_is_cleaning_up(void)
1558 return is_cleaning_up;
1561 static void free_audio_state(AudioState *s)
1563 HWVoiceOut *hwo, *hwon;
1564 HWVoiceIn *hwi, *hwin;
1566 QLIST_FOREACH_SAFE(hwo, &s->hw_head_out, entries, hwon) {
1567 SWVoiceCap *sc;
1569 if (hwo->enabled && hwo->pcm_ops->enable_out) {
1570 hwo->pcm_ops->enable_out(hwo, false);
1572 hwo->pcm_ops->fini_out (hwo);
1574 for (sc = hwo->cap_head.lh_first; sc; sc = sc->entries.le_next) {
1575 CaptureVoiceOut *cap = sc->cap;
1576 struct capture_callback *cb;
1578 for (cb = cap->cb_head.lh_first; cb; cb = cb->entries.le_next) {
1579 cb->ops.destroy (cb->opaque);
1582 QLIST_REMOVE(hwo, entries);
1585 QLIST_FOREACH_SAFE(hwi, &s->hw_head_in, entries, hwin) {
1586 if (hwi->enabled && hwi->pcm_ops->enable_in) {
1587 hwi->pcm_ops->enable_in(hwi, false);
1589 hwi->pcm_ops->fini_in (hwi);
1590 QLIST_REMOVE(hwi, entries);
1593 if (s->drv) {
1594 s->drv->fini (s->drv_opaque);
1595 s->drv = NULL;
1598 if (s->dev) {
1599 qapi_free_Audiodev(s->dev);
1600 s->dev = NULL;
1603 if (s->ts) {
1604 timer_free(s->ts);
1605 s->ts = NULL;
1608 g_free(s);
1611 void audio_cleanup(void)
1613 is_cleaning_up = true;
1614 while (!QTAILQ_EMPTY(&audio_states)) {
1615 AudioState *s = QTAILQ_FIRST(&audio_states);
1616 QTAILQ_REMOVE(&audio_states, s, list);
1617 free_audio_state(s);
1621 static const VMStateDescription vmstate_audio = {
1622 .name = "audio",
1623 .version_id = 1,
1624 .minimum_version_id = 1,
1625 .fields = (VMStateField[]) {
1626 VMSTATE_END_OF_LIST()
1630 static void audio_validate_opts(Audiodev *dev, Error **errp);
1632 static AudiodevListEntry *audiodev_find(
1633 AudiodevListHead *head, const char *drvname)
1635 AudiodevListEntry *e;
1636 QSIMPLEQ_FOREACH(e, head, next) {
1637 if (strcmp(AudiodevDriver_str(e->dev->driver), drvname) == 0) {
1638 return e;
1642 return NULL;
1646 * if we have dev, this function was called because of an -audiodev argument =>
1647 * initialize a new state with it
1648 * if dev == NULL => legacy implicit initialization, return the already created
1649 * state or create a new one
1651 static AudioState *audio_init(Audiodev *dev, const char *name)
1653 static bool atexit_registered;
1654 size_t i;
1655 int done = 0;
1656 const char *drvname = NULL;
1657 VMChangeStateEntry *e;
1658 AudioState *s;
1659 struct audio_driver *driver;
1660 /* silence gcc warning about uninitialized variable */
1661 AudiodevListHead head = QSIMPLEQ_HEAD_INITIALIZER(head);
1663 if (dev) {
1664 /* -audiodev option */
1665 legacy_config = false;
1666 drvname = AudiodevDriver_str(dev->driver);
1667 } else if (!QTAILQ_EMPTY(&audio_states)) {
1668 if (!legacy_config) {
1669 dolog("Device %s: audiodev default parameter is deprecated, please "
1670 "specify audiodev=%s\n", name,
1671 QTAILQ_FIRST(&audio_states)->dev->id);
1673 return QTAILQ_FIRST(&audio_states);
1674 } else {
1675 /* legacy implicit initialization */
1676 head = audio_handle_legacy_opts();
1678 * In case of legacy initialization, all Audiodevs in the list will have
1679 * the same configuration (except the driver), so it does't matter which
1680 * one we chose. We need an Audiodev to set up AudioState before we can
1681 * init a driver. Also note that dev at this point is still in the
1682 * list.
1684 dev = QSIMPLEQ_FIRST(&head)->dev;
1685 audio_validate_opts(dev, &error_abort);
1688 s = g_malloc0(sizeof(AudioState));
1689 s->dev = dev;
1691 QLIST_INIT (&s->hw_head_out);
1692 QLIST_INIT (&s->hw_head_in);
1693 QLIST_INIT (&s->cap_head);
1694 if (!atexit_registered) {
1695 atexit(audio_cleanup);
1696 atexit_registered = true;
1698 QTAILQ_INSERT_TAIL(&audio_states, s, list);
1700 s->ts = timer_new_ns(QEMU_CLOCK_VIRTUAL, audio_timer, s);
1702 s->nb_hw_voices_out = audio_get_pdo_out(dev)->voices;
1703 s->nb_hw_voices_in = audio_get_pdo_in(dev)->voices;
1705 if (s->nb_hw_voices_out <= 0) {
1706 dolog ("Bogus number of playback voices %d, setting to 1\n",
1707 s->nb_hw_voices_out);
1708 s->nb_hw_voices_out = 1;
1711 if (s->nb_hw_voices_in <= 0) {
1712 dolog ("Bogus number of capture voices %d, setting to 0\n",
1713 s->nb_hw_voices_in);
1714 s->nb_hw_voices_in = 0;
1717 if (drvname) {
1718 driver = audio_driver_lookup(drvname);
1719 if (driver) {
1720 done = !audio_driver_init(s, driver, true, dev);
1721 } else {
1722 dolog ("Unknown audio driver `%s'\n", drvname);
1724 } else {
1725 for (i = 0; audio_prio_list[i]; i++) {
1726 AudiodevListEntry *e = audiodev_find(&head, audio_prio_list[i]);
1727 driver = audio_driver_lookup(audio_prio_list[i]);
1729 if (e && driver) {
1730 s->dev = dev = e->dev;
1731 audio_validate_opts(dev, &error_abort);
1732 done = !audio_driver_init(s, driver, false, dev);
1733 if (done) {
1734 e->dev = NULL;
1735 break;
1740 audio_free_audiodev_list(&head);
1742 if (!done) {
1743 driver = audio_driver_lookup("none");
1744 done = !audio_driver_init(s, driver, false, dev);
1745 assert(done);
1746 dolog("warning: Using timer based audio emulation\n");
1749 if (dev->timer_period <= 0) {
1750 s->period_ticks = 1;
1751 } else {
1752 s->period_ticks = dev->timer_period * (int64_t)SCALE_US;
1755 e = qemu_add_vm_change_state_handler (audio_vm_change_state_handler, s);
1756 if (!e) {
1757 dolog ("warning: Could not register change state handler\n"
1758 "(Audio can continue looping even after stopping the VM)\n");
1761 QLIST_INIT (&s->card_head);
1762 vmstate_register (NULL, 0, &vmstate_audio, s);
1763 return s;
1766 void audio_free_audiodev_list(AudiodevListHead *head)
1768 AudiodevListEntry *e;
1769 while ((e = QSIMPLEQ_FIRST(head))) {
1770 QSIMPLEQ_REMOVE_HEAD(head, next);
1771 qapi_free_Audiodev(e->dev);
1772 g_free(e);
1776 void AUD_register_card (const char *name, QEMUSoundCard *card)
1778 if (!card->state) {
1779 card->state = audio_init(NULL, name);
1782 card->name = g_strdup (name);
1783 memset (&card->entries, 0, sizeof (card->entries));
1784 QLIST_INSERT_HEAD(&card->state->card_head, card, entries);
1787 void AUD_remove_card (QEMUSoundCard *card)
1789 QLIST_REMOVE (card, entries);
1790 g_free (card->name);
1794 CaptureVoiceOut *AUD_add_capture(
1795 AudioState *s,
1796 struct audsettings *as,
1797 struct audio_capture_ops *ops,
1798 void *cb_opaque
1801 CaptureVoiceOut *cap;
1802 struct capture_callback *cb;
1804 if (!s) {
1805 if (!legacy_config) {
1806 dolog("Capturing without setting an audiodev is deprecated\n");
1808 s = audio_init(NULL, NULL);
1811 if (!audio_get_pdo_out(s->dev)->mixing_engine) {
1812 dolog("Can't capture with mixeng disabled\n");
1813 return NULL;
1816 if (audio_validate_settings (as)) {
1817 dolog ("Invalid settings were passed when trying to add capture\n");
1818 audio_print_settings (as);
1819 return NULL;
1822 cb = g_malloc0(sizeof(*cb));
1823 cb->ops = *ops;
1824 cb->opaque = cb_opaque;
1826 cap = audio_pcm_capture_find_specific(s, as);
1827 if (cap) {
1828 QLIST_INSERT_HEAD (&cap->cb_head, cb, entries);
1829 return cap;
1831 else {
1832 HWVoiceOut *hw;
1833 CaptureVoiceOut *cap;
1835 cap = g_malloc0(sizeof(*cap));
1837 hw = &cap->hw;
1838 hw->s = s;
1839 QLIST_INIT (&hw->sw_head);
1840 QLIST_INIT (&cap->cb_head);
1842 /* XXX find a more elegant way */
1843 hw->samples = 4096 * 4;
1844 audio_pcm_hw_alloc_resources_out(hw);
1846 audio_pcm_init_info (&hw->info, as);
1848 cap->buf = g_malloc0_n(hw->mix_buf->size, hw->info.bytes_per_frame);
1850 if (hw->info.is_float) {
1851 hw->clip = mixeng_clip_float[hw->info.nchannels == 2];
1852 } else {
1853 hw->clip = mixeng_clip
1854 [hw->info.nchannels == 2]
1855 [hw->info.is_signed]
1856 [hw->info.swap_endianness]
1857 [audio_bits_to_index(hw->info.bits)];
1860 QLIST_INSERT_HEAD (&s->cap_head, cap, entries);
1861 QLIST_INSERT_HEAD (&cap->cb_head, cb, entries);
1863 QLIST_FOREACH(hw, &s->hw_head_out, entries) {
1864 audio_attach_capture (hw);
1866 return cap;
1870 void AUD_del_capture (CaptureVoiceOut *cap, void *cb_opaque)
1872 struct capture_callback *cb;
1874 for (cb = cap->cb_head.lh_first; cb; cb = cb->entries.le_next) {
1875 if (cb->opaque == cb_opaque) {
1876 cb->ops.destroy (cb_opaque);
1877 QLIST_REMOVE (cb, entries);
1878 g_free (cb);
1880 if (!cap->cb_head.lh_first) {
1881 SWVoiceOut *sw = cap->hw.sw_head.lh_first, *sw1;
1883 while (sw) {
1884 SWVoiceCap *sc = (SWVoiceCap *) sw;
1885 #ifdef DEBUG_CAPTURE
1886 dolog ("freeing %s\n", sw->name);
1887 #endif
1889 sw1 = sw->entries.le_next;
1890 if (sw->rate) {
1891 st_rate_stop (sw->rate);
1892 sw->rate = NULL;
1894 QLIST_REMOVE (sw, entries);
1895 QLIST_REMOVE (sc, entries);
1896 g_free (sc);
1897 sw = sw1;
1899 QLIST_REMOVE (cap, entries);
1900 g_free (cap->hw.mix_buf);
1901 g_free (cap->buf);
1902 g_free (cap);
1904 return;
1909 void AUD_set_volume_out (SWVoiceOut *sw, int mute, uint8_t lvol, uint8_t rvol)
1911 Volume vol = { .mute = mute, .channels = 2, .vol = { lvol, rvol } };
1912 audio_set_volume_out(sw, &vol);
1915 void audio_set_volume_out(SWVoiceOut *sw, Volume *vol)
1917 if (sw) {
1918 HWVoiceOut *hw = sw->hw;
1920 sw->vol.mute = vol->mute;
1921 sw->vol.l = nominal_volume.l * vol->vol[0] / 255;
1922 sw->vol.r = nominal_volume.l * vol->vol[vol->channels > 1 ? 1 : 0] /
1923 255;
1925 if (hw->pcm_ops->volume_out) {
1926 hw->pcm_ops->volume_out(hw, vol);
1931 void AUD_set_volume_in (SWVoiceIn *sw, int mute, uint8_t lvol, uint8_t rvol)
1933 Volume vol = { .mute = mute, .channels = 2, .vol = { lvol, rvol } };
1934 audio_set_volume_in(sw, &vol);
1937 void audio_set_volume_in(SWVoiceIn *sw, Volume *vol)
1939 if (sw) {
1940 HWVoiceIn *hw = sw->hw;
1942 sw->vol.mute = vol->mute;
1943 sw->vol.l = nominal_volume.l * vol->vol[0] / 255;
1944 sw->vol.r = nominal_volume.r * vol->vol[vol->channels > 1 ? 1 : 0] /
1945 255;
1947 if (hw->pcm_ops->volume_in) {
1948 hw->pcm_ops->volume_in(hw, vol);
1953 void audio_create_pdos(Audiodev *dev)
1955 switch (dev->driver) {
1956 #define CASE(DRIVER, driver, pdo_name) \
1957 case AUDIODEV_DRIVER_##DRIVER: \
1958 if (!dev->u.driver.has_in) { \
1959 dev->u.driver.in = g_malloc0( \
1960 sizeof(Audiodev##pdo_name##PerDirectionOptions)); \
1961 dev->u.driver.has_in = true; \
1963 if (!dev->u.driver.has_out) { \
1964 dev->u.driver.out = g_malloc0( \
1965 sizeof(Audiodev##pdo_name##PerDirectionOptions)); \
1966 dev->u.driver.has_out = true; \
1968 break
1970 CASE(NONE, none, );
1971 CASE(ALSA, alsa, Alsa);
1972 CASE(COREAUDIO, coreaudio, Coreaudio);
1973 CASE(DSOUND, dsound, );
1974 CASE(OSS, oss, Oss);
1975 CASE(PA, pa, Pa);
1976 CASE(SDL, sdl, );
1977 CASE(SPICE, spice, );
1978 CASE(WAV, wav, );
1980 case AUDIODEV_DRIVER__MAX:
1981 abort();
1985 static void audio_validate_per_direction_opts(
1986 AudiodevPerDirectionOptions *pdo, Error **errp)
1988 if (!pdo->has_mixing_engine) {
1989 pdo->has_mixing_engine = true;
1990 pdo->mixing_engine = true;
1992 if (!pdo->has_fixed_settings) {
1993 pdo->has_fixed_settings = true;
1994 pdo->fixed_settings = pdo->mixing_engine;
1996 if (!pdo->fixed_settings &&
1997 (pdo->has_frequency || pdo->has_channels || pdo->has_format)) {
1998 error_setg(errp,
1999 "You can't use frequency, channels or format with fixed-settings=off");
2000 return;
2002 if (!pdo->mixing_engine && pdo->fixed_settings) {
2003 error_setg(errp, "You can't use fixed-settings without mixeng");
2004 return;
2007 if (!pdo->has_frequency) {
2008 pdo->has_frequency = true;
2009 pdo->frequency = 44100;
2011 if (!pdo->has_channels) {
2012 pdo->has_channels = true;
2013 pdo->channels = 2;
2015 if (!pdo->has_voices) {
2016 pdo->has_voices = true;
2017 pdo->voices = pdo->mixing_engine ? 1 : INT_MAX;
2019 if (!pdo->has_format) {
2020 pdo->has_format = true;
2021 pdo->format = AUDIO_FORMAT_S16;
2025 static void audio_validate_opts(Audiodev *dev, Error **errp)
2027 Error *err = NULL;
2029 audio_create_pdos(dev);
2031 audio_validate_per_direction_opts(audio_get_pdo_in(dev), &err);
2032 if (err) {
2033 error_propagate(errp, err);
2034 return;
2037 audio_validate_per_direction_opts(audio_get_pdo_out(dev), &err);
2038 if (err) {
2039 error_propagate(errp, err);
2040 return;
2043 if (!dev->has_timer_period) {
2044 dev->has_timer_period = true;
2045 dev->timer_period = 10000; /* 100Hz -> 10ms */
2049 void audio_parse_option(const char *opt)
2051 AudiodevListEntry *e;
2052 Audiodev *dev = NULL;
2054 Visitor *v = qobject_input_visitor_new_str(opt, "driver", &error_fatal);
2055 visit_type_Audiodev(v, NULL, &dev, &error_fatal);
2056 visit_free(v);
2058 audio_validate_opts(dev, &error_fatal);
2060 e = g_malloc0(sizeof(AudiodevListEntry));
2061 e->dev = dev;
2062 QSIMPLEQ_INSERT_TAIL(&audiodevs, e, next);
2065 void audio_init_audiodevs(void)
2067 AudiodevListEntry *e;
2069 QSIMPLEQ_FOREACH(e, &audiodevs, next) {
2070 audio_init(e->dev, NULL);
2074 audsettings audiodev_to_audsettings(AudiodevPerDirectionOptions *pdo)
2076 return (audsettings) {
2077 .freq = pdo->frequency,
2078 .nchannels = pdo->channels,
2079 .fmt = pdo->format,
2080 .endianness = AUDIO_HOST_ENDIANNESS,
2084 int audioformat_bytes_per_sample(AudioFormat fmt)
2086 switch (fmt) {
2087 case AUDIO_FORMAT_U8:
2088 case AUDIO_FORMAT_S8:
2089 return 1;
2091 case AUDIO_FORMAT_U16:
2092 case AUDIO_FORMAT_S16:
2093 return 2;
2095 case AUDIO_FORMAT_U32:
2096 case AUDIO_FORMAT_S32:
2097 case AUDIO_FORMAT_F32:
2098 return 4;
2100 case AUDIO_FORMAT__MAX:
2103 abort();
2107 /* frames = freq * usec / 1e6 */
2108 int audio_buffer_frames(AudiodevPerDirectionOptions *pdo,
2109 audsettings *as, int def_usecs)
2111 uint64_t usecs = pdo->has_buffer_length ? pdo->buffer_length : def_usecs;
2112 return (as->freq * usecs + 500000) / 1000000;
2115 /* samples = channels * frames = channels * freq * usec / 1e6 */
2116 int audio_buffer_samples(AudiodevPerDirectionOptions *pdo,
2117 audsettings *as, int def_usecs)
2119 return as->nchannels * audio_buffer_frames(pdo, as, def_usecs);
2123 * bytes = bytes_per_sample * samples =
2124 * bytes_per_sample * channels * freq * usec / 1e6
2126 int audio_buffer_bytes(AudiodevPerDirectionOptions *pdo,
2127 audsettings *as, int def_usecs)
2129 return audio_buffer_samples(pdo, as, def_usecs) *
2130 audioformat_bytes_per_sample(as->fmt);
2133 AudioState *audio_state_by_name(const char *name)
2135 AudioState *s;
2136 QTAILQ_FOREACH(s, &audio_states, list) {
2137 assert(s->dev);
2138 if (strcmp(name, s->dev->id) == 0) {
2139 return s;
2142 return NULL;
2145 const char *audio_get_id(QEMUSoundCard *card)
2147 if (card->state) {
2148 assert(card->state->dev);
2149 return card->state->dev->id;
2150 } else {
2151 return "";
2155 void audio_rate_start(RateCtl *rate)
2157 memset(rate, 0, sizeof(RateCtl));
2158 rate->start_ticks = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
2161 size_t audio_rate_get_bytes(struct audio_pcm_info *info, RateCtl *rate,
2162 size_t bytes_avail)
2164 int64_t now;
2165 int64_t ticks;
2166 int64_t bytes;
2167 int64_t samples;
2168 size_t ret;
2170 now = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
2171 ticks = now - rate->start_ticks;
2172 bytes = muldiv64(ticks, info->bytes_per_second, NANOSECONDS_PER_SECOND);
2173 samples = (bytes - rate->bytes_sent) / info->bytes_per_frame;
2174 if (samples < 0 || samples > 65536) {
2175 AUD_log(NULL, "Resetting rate control (%" PRId64 " samples)\n", samples);
2176 audio_rate_start(rate);
2177 samples = 0;
2180 ret = MIN(samples * info->bytes_per_frame, bytes_avail);
2181 rate->bytes_sent += ret;
2182 return ret;