qapi: Format since information the conventional way: (since X.Y)
[qemu/armbru.git] / audio / audio_template.h
blobe42326c20d640b30fa94d4046c0f7bf831f7de14
1 /*
2 * QEMU Audio subsystem header
4 * Copyright (c) 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 #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
39 static void glue(audio_init_nb_voices_, TYPE)(AudioState *s,
40 struct audio_driver *drv)
42 int max_voices = glue (drv->max_voices_, TYPE);
43 size_t voice_size = glue(drv->voice_size_, TYPE);
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);
56 glue (s->nb_hw_voices_, TYPE) = max_voices;
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;
65 if (audio_bug(__func__, voice_size && !max_voices)) {
66 dolog("drv=`%s' voice_size=%zu max_voices=0\n",
67 drv->name, voice_size);
71 static void glue (audio_pcm_hw_free_resources_, TYPE) (HW *hw)
73 g_free(hw->buf_emul);
74 g_free(HWBUF.buffer);
75 HWBUF.buffer = NULL;
76 HWBUF.size = 0;
79 static void glue(audio_pcm_hw_alloc_resources_, TYPE)(HW *hw)
81 if (glue(audio_get_pdo_, TYPE)(hw->s->dev)->mixing_engine) {
82 size_t samples = hw->samples;
83 if (audio_bug(__func__, samples == 0)) {
84 dolog("Attempted to allocate empty buffer\n");
87 HWBUF.buffer = g_new0(st_sample, samples);
88 HWBUF.size = samples;
89 HWBUF.pos = 0;
90 } else {
91 HWBUF.buffer = NULL;
92 HWBUF.size = 0;
96 static void glue (audio_pcm_sw_free_resources_, TYPE) (SW *sw)
98 g_free(sw->resample_buf.buffer);
99 sw->resample_buf.buffer = NULL;
100 sw->resample_buf.size = 0;
102 if (sw->rate) {
103 st_rate_stop (sw->rate);
105 sw->rate = NULL;
108 static int glue (audio_pcm_sw_alloc_resources_, TYPE) (SW *sw)
110 HW *hw = sw->hw;
111 uint64_t samples;
113 if (!glue(audio_get_pdo_, TYPE)(sw->s->dev)->mixing_engine) {
114 return 0;
117 samples = muldiv64(HWBUF.size, sw->info.freq, hw->info.freq);
118 if (samples == 0) {
119 uint64_t f_fe_min;
120 uint64_t f_be = (uint32_t)hw->info.freq;
122 /* f_fe_min = ceil(1 [frames] * f_be [Hz] / size_be [frames]) */
123 f_fe_min = (f_be + 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 >= %" PRIu64 " Hz"
127 " are supported.\n",
128 sw->info.freq, sw->name, f_fe_min);
129 return -1;
133 * Allocate one additional audio frame that is needed for upsampling
134 * if the resample buffer size is small. For large buffer sizes take
135 * care of overflows and truncation.
137 samples = samples < SIZE_MAX ? samples + 1 : SIZE_MAX;
138 sw->resample_buf.buffer = g_new0(st_sample, samples);
139 sw->resample_buf.size = samples;
140 sw->resample_buf.pos = 0;
142 #ifdef DAC
143 sw->rate = st_rate_start(sw->info.freq, hw->info.freq);
144 #else
145 sw->rate = st_rate_start(hw->info.freq, sw->info.freq);
146 #endif
148 return 0;
151 static int glue (audio_pcm_sw_init_, TYPE) (
152 SW *sw,
153 HW *hw,
154 const char *name,
155 struct audsettings *as
158 int err;
160 audio_pcm_init_info (&sw->info, as);
161 sw->hw = hw;
162 sw->active = 0;
163 #ifdef DAC
164 sw->total_hw_samples_mixed = 0;
165 sw->empty = 1;
166 #endif
168 if (sw->info.is_float) {
169 #ifdef DAC
170 sw->conv = mixeng_conv_float[sw->info.nchannels == 2];
171 #else
172 sw->clip = mixeng_clip_float[sw->info.nchannels == 2];
173 #endif
174 } else {
175 #ifdef DAC
176 sw->conv = mixeng_conv
177 #else
178 sw->clip = mixeng_clip
179 #endif
180 [sw->info.nchannels == 2]
181 [sw->info.is_signed]
182 [sw->info.swap_endianness]
183 [audio_bits_to_index(sw->info.bits)];
186 sw->name = g_strdup (name);
187 err = glue (audio_pcm_sw_alloc_resources_, TYPE) (sw);
188 if (err) {
189 g_free (sw->name);
190 sw->name = NULL;
192 return err;
195 static void glue (audio_pcm_sw_fini_, TYPE) (SW *sw)
197 glue (audio_pcm_sw_free_resources_, TYPE) (sw);
198 g_free (sw->name);
199 sw->name = NULL;
202 static void glue (audio_pcm_hw_add_sw_, TYPE) (HW *hw, SW *sw)
204 QLIST_INSERT_HEAD (&hw->sw_head, sw, entries);
207 static void glue (audio_pcm_hw_del_sw_, TYPE) (SW *sw)
209 QLIST_REMOVE (sw, entries);
212 static void glue (audio_pcm_hw_gc_, TYPE) (HW **hwp)
214 HW *hw = *hwp;
215 AudioState *s = hw->s;
217 if (!hw->sw_head.lh_first) {
218 #ifdef DAC
219 audio_detach_capture(hw);
220 #endif
221 QLIST_REMOVE(hw, entries);
222 glue(hw->pcm_ops->fini_, TYPE) (hw);
223 glue(s->nb_hw_voices_, TYPE) += 1;
224 glue(audio_pcm_hw_free_resources_ , TYPE) (hw);
225 g_free(hw);
226 *hwp = NULL;
230 static HW *glue(audio_pcm_hw_find_any_, TYPE)(AudioState *s, HW *hw)
232 return hw ? hw->entries.le_next : glue (s->hw_head_, TYPE).lh_first;
235 static HW *glue(audio_pcm_hw_find_any_enabled_, TYPE)(AudioState *s, HW *hw)
237 while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
238 if (hw->enabled) {
239 return hw;
242 return NULL;
245 static HW *glue(audio_pcm_hw_find_specific_, TYPE)(AudioState *s, HW *hw,
246 struct audsettings *as)
248 while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
249 if (audio_pcm_info_eq (&hw->info, as)) {
250 return hw;
253 return NULL;
256 static HW *glue(audio_pcm_hw_add_new_, TYPE)(AudioState *s,
257 struct audsettings *as)
259 HW *hw;
260 struct audio_driver *drv = s->drv;
262 if (!glue (s->nb_hw_voices_, TYPE)) {
263 return NULL;
266 if (audio_bug(__func__, !drv)) {
267 dolog ("No host audio driver\n");
268 return NULL;
271 if (audio_bug(__func__, !drv->pcm_ops)) {
272 dolog ("Host audio driver without pcm_ops\n");
273 return NULL;
277 * Since glue(s->nb_hw_voices_, TYPE) is != 0, glue(drv->voice_size_, TYPE)
278 * is guaranteed to be != 0. See the audio_init_nb_voices_* functions.
280 hw = g_malloc0(glue(drv->voice_size_, TYPE));
281 hw->s = s;
282 hw->pcm_ops = drv->pcm_ops;
284 QLIST_INIT (&hw->sw_head);
285 #ifdef DAC
286 QLIST_INIT (&hw->cap_head);
287 #endif
288 if (glue (hw->pcm_ops->init_, TYPE) (hw, as, s->drv_opaque)) {
289 goto err0;
292 if (audio_bug(__func__, hw->samples <= 0)) {
293 dolog("hw->samples=%zd\n", hw->samples);
294 goto err1;
297 if (hw->info.is_float) {
298 #ifdef DAC
299 hw->clip = mixeng_clip_float[hw->info.nchannels == 2];
300 #else
301 hw->conv = mixeng_conv_float[hw->info.nchannels == 2];
302 #endif
303 } else {
304 #ifdef DAC
305 hw->clip = mixeng_clip
306 #else
307 hw->conv = mixeng_conv
308 #endif
309 [hw->info.nchannels == 2]
310 [hw->info.is_signed]
311 [hw->info.swap_endianness]
312 [audio_bits_to_index(hw->info.bits)];
315 glue(audio_pcm_hw_alloc_resources_, TYPE)(hw);
317 QLIST_INSERT_HEAD (&s->glue (hw_head_, TYPE), hw, entries);
318 glue (s->nb_hw_voices_, TYPE) -= 1;
319 #ifdef DAC
320 audio_attach_capture (hw);
321 #endif
322 return hw;
324 err1:
325 glue (hw->pcm_ops->fini_, TYPE) (hw);
326 err0:
327 g_free (hw);
328 return NULL;
331 AudiodevPerDirectionOptions *glue(audio_get_pdo_, TYPE)(Audiodev *dev)
333 switch (dev->driver) {
334 case AUDIODEV_DRIVER_NONE:
335 return dev->u.none.TYPE;
336 #ifdef CONFIG_AUDIO_ALSA
337 case AUDIODEV_DRIVER_ALSA:
338 return qapi_AudiodevAlsaPerDirectionOptions_base(dev->u.alsa.TYPE);
339 #endif
340 #ifdef CONFIG_AUDIO_COREAUDIO
341 case AUDIODEV_DRIVER_COREAUDIO:
342 return qapi_AudiodevCoreaudioPerDirectionOptions_base(
343 dev->u.coreaudio.TYPE);
344 #endif
345 #ifdef CONFIG_DBUS_DISPLAY
346 case AUDIODEV_DRIVER_DBUS:
347 return dev->u.dbus.TYPE;
348 #endif
349 #ifdef CONFIG_AUDIO_DSOUND
350 case AUDIODEV_DRIVER_DSOUND:
351 return dev->u.dsound.TYPE;
352 #endif
353 #ifdef CONFIG_AUDIO_JACK
354 case AUDIODEV_DRIVER_JACK:
355 return qapi_AudiodevJackPerDirectionOptions_base(dev->u.jack.TYPE);
356 #endif
357 #ifdef CONFIG_AUDIO_OSS
358 case AUDIODEV_DRIVER_OSS:
359 return qapi_AudiodevOssPerDirectionOptions_base(dev->u.oss.TYPE);
360 #endif
361 #ifdef CONFIG_AUDIO_PA
362 case AUDIODEV_DRIVER_PA:
363 return qapi_AudiodevPaPerDirectionOptions_base(dev->u.pa.TYPE);
364 #endif
365 #ifdef CONFIG_AUDIO_SDL
366 case AUDIODEV_DRIVER_SDL:
367 return qapi_AudiodevSdlPerDirectionOptions_base(dev->u.sdl.TYPE);
368 #endif
369 #ifdef CONFIG_AUDIO_SNDIO
370 case AUDIODEV_DRIVER_SNDIO:
371 return dev->u.sndio.TYPE;
372 #endif
373 #ifdef CONFIG_SPICE
374 case AUDIODEV_DRIVER_SPICE:
375 return dev->u.spice.TYPE;
376 #endif
377 case AUDIODEV_DRIVER_WAV:
378 return dev->u.wav.TYPE;
380 case AUDIODEV_DRIVER__MAX:
381 break;
383 abort();
386 static HW *glue(audio_pcm_hw_add_, TYPE)(AudioState *s, struct audsettings *as)
388 HW *hw;
389 AudiodevPerDirectionOptions *pdo = glue(audio_get_pdo_, TYPE)(s->dev);
391 if (!pdo->mixing_engine || pdo->fixed_settings) {
392 hw = glue(audio_pcm_hw_add_new_, TYPE)(s, as);
393 if (!pdo->mixing_engine || hw) {
394 return hw;
398 hw = glue(audio_pcm_hw_find_specific_, TYPE)(s, NULL, as);
399 if (hw) {
400 return hw;
403 hw = glue(audio_pcm_hw_add_new_, TYPE)(s, as);
404 if (hw) {
405 return hw;
408 return glue(audio_pcm_hw_find_any_, TYPE)(s, NULL);
411 static SW *glue(audio_pcm_create_voice_pair_, TYPE)(
412 AudioState *s,
413 const char *sw_name,
414 struct audsettings *as
417 SW *sw;
418 HW *hw;
419 struct audsettings hw_as;
420 AudiodevPerDirectionOptions *pdo = glue(audio_get_pdo_, TYPE)(s->dev);
422 if (pdo->fixed_settings) {
423 hw_as = audiodev_to_audsettings(pdo);
424 } else {
425 hw_as = *as;
428 sw = g_new0(SW, 1);
429 sw->s = s;
431 hw = glue(audio_pcm_hw_add_, TYPE)(s, &hw_as);
432 if (!hw) {
433 dolog("Could not create a backend for voice `%s'\n", sw_name);
434 goto err1;
437 glue (audio_pcm_hw_add_sw_, TYPE) (hw, sw);
439 if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, sw_name, as)) {
440 goto err2;
443 return sw;
445 err2:
446 glue (audio_pcm_hw_del_sw_, TYPE) (sw);
447 glue (audio_pcm_hw_gc_, TYPE) (&hw);
448 err1:
449 g_free(sw);
450 return NULL;
453 static void glue (audio_close_, TYPE) (SW *sw)
455 glue (audio_pcm_sw_fini_, TYPE) (sw);
456 glue (audio_pcm_hw_del_sw_, TYPE) (sw);
457 glue (audio_pcm_hw_gc_, TYPE) (&sw->hw);
458 g_free (sw);
461 void glue (AUD_close_, TYPE) (QEMUSoundCard *card, SW *sw)
463 if (sw) {
464 if (audio_bug(__func__, !card)) {
465 dolog ("card=%p\n", card);
466 return;
469 glue (audio_close_, TYPE) (sw);
473 SW *glue (AUD_open_, TYPE) (
474 QEMUSoundCard *card,
475 SW *sw,
476 const char *name,
477 void *callback_opaque ,
478 audio_callback_fn callback_fn,
479 struct audsettings *as
482 AudioState *s;
483 AudiodevPerDirectionOptions *pdo;
485 if (audio_bug(__func__, !card || !name || !callback_fn || !as)) {
486 dolog ("card=%p name=%p callback_fn=%p as=%p\n",
487 card, name, callback_fn, as);
488 goto fail;
491 s = card->state;
492 pdo = glue(audio_get_pdo_, TYPE)(s->dev);
494 ldebug ("open %s, freq %d, nchannels %d, fmt %d\n",
495 name, as->freq, as->nchannels, as->fmt);
497 if (audio_bug(__func__, audio_validate_settings(as))) {
498 audio_print_settings (as);
499 goto fail;
502 if (audio_bug(__func__, !s->drv)) {
503 dolog ("Can not open `%s' (no host audio driver)\n", name);
504 goto fail;
507 if (sw && audio_pcm_info_eq (&sw->info, as)) {
508 return sw;
511 if (!pdo->fixed_settings && sw) {
512 glue (AUD_close_, TYPE) (card, sw);
513 sw = NULL;
516 if (sw) {
517 HW *hw = sw->hw;
519 if (!hw) {
520 dolog("Internal logic error: voice `%s' has no backend\n",
521 SW_NAME(sw));
522 goto fail;
525 glue (audio_pcm_sw_fini_, TYPE) (sw);
526 if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, name, as)) {
527 goto fail;
529 } else {
530 sw = glue(audio_pcm_create_voice_pair_, TYPE)(s, name, as);
531 if (!sw) {
532 return NULL;
536 sw->card = card;
537 sw->vol = nominal_volume;
538 sw->callback.fn = callback_fn;
539 sw->callback.opaque = callback_opaque;
541 #ifdef DEBUG_AUDIO
542 dolog ("%s\n", name);
543 audio_pcm_print_info ("hw", &sw->hw->info);
544 audio_pcm_print_info ("sw", &sw->info);
545 #endif
547 return sw;
549 fail:
550 glue (AUD_close_, TYPE) (card, sw);
551 return NULL;
554 int glue (AUD_is_active_, TYPE) (SW *sw)
556 return sw ? sw->active : 0;
559 void glue (AUD_init_time_stamp_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
561 if (!sw) {
562 return;
565 ts->old_ts = sw->hw->ts_helper;
568 uint64_t glue (AUD_get_elapsed_usec_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
570 uint64_t delta, cur_ts, old_ts;
572 if (!sw) {
573 return 0;
576 cur_ts = sw->hw->ts_helper;
577 old_ts = ts->old_ts;
578 /* dolog ("cur %" PRId64 " old %" PRId64 "\n", cur_ts, old_ts); */
580 if (cur_ts >= old_ts) {
581 delta = cur_ts - old_ts;
582 } else {
583 delta = UINT64_MAX - old_ts + cur_ts;
586 if (!delta) {
587 return 0;
590 return muldiv64 (delta, sw->hw->info.freq, 1000000);
593 #undef TYPE
594 #undef HW
595 #undef SW
596 #undef HWBUF
597 #undef NAME