xref: /qemu/audio/audio_template.h (revision 7678b74a)
1 /*
2  * QEMU Audio subsystem header
3  *
4  * Copyright (c) 2005 Vassili Karpov (malc)
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #ifdef DAC
26 #define NAME "playback"
27 #define HWBUF hw->mix_buf
28 #define TYPE out
29 #define HW HWVoiceOut
30 #define SW SWVoiceOut
31 #else
32 #define NAME "capture"
33 #define TYPE in
34 #define HW HWVoiceIn
35 #define SW SWVoiceIn
36 #define HWBUF hw->conv_buf
37 #endif
38 
39 static void glue(audio_init_nb_voices_, TYPE)(AudioState *s,
40                                               struct audio_driver *drv)
41 {
42     int max_voices = glue (drv->max_voices_, TYPE);
43     int voice_size = glue (drv->voice_size_, TYPE);
44 
45     if (glue (s->nb_hw_voices_, TYPE) > max_voices) {
46         if (!max_voices) {
47 #ifdef DAC
48             dolog ("Driver `%s' does not support " NAME "\n", drv->name);
49 #endif
50         }
51         else {
52             dolog ("Driver `%s' does not support %d " NAME " voices, max %d\n",
53                    drv->name,
54                    glue (s->nb_hw_voices_, TYPE),
55                    max_voices);
56         }
57         glue (s->nb_hw_voices_, TYPE) = max_voices;
58     }
59 
60     if (audio_bug(__func__, !voice_size && max_voices)) {
61         dolog ("drv=`%s' voice_size=0 max_voices=%d\n",
62                drv->name, max_voices);
63         glue (s->nb_hw_voices_, TYPE) = 0;
64     }
65 
66     if (audio_bug(__func__, voice_size && !max_voices)) {
67         dolog ("drv=`%s' voice_size=%d max_voices=0\n",
68                drv->name, voice_size);
69     }
70 }
71 
72 static void glue (audio_pcm_hw_free_resources_, TYPE) (HW *hw)
73 {
74     g_free(hw->buf_emul);
75     g_free (HWBUF);
76     HWBUF = NULL;
77 }
78 
79 static void glue(audio_pcm_hw_alloc_resources_, TYPE)(HW *hw)
80 {
81     size_t samples = hw->samples;
82     if (audio_bug(__func__, samples == 0)) {
83         dolog("Attempted to allocate empty buffer\n");
84     }
85 
86     HWBUF = g_malloc0(sizeof(STSampleBuffer) + sizeof(st_sample) * samples);
87     HWBUF->size = samples;
88 }
89 
90 static void glue (audio_pcm_sw_free_resources_, TYPE) (SW *sw)
91 {
92     g_free (sw->buf);
93 
94     if (sw->rate) {
95         st_rate_stop (sw->rate);
96     }
97 
98     sw->buf = NULL;
99     sw->rate = NULL;
100 }
101 
102 static int glue (audio_pcm_sw_alloc_resources_, TYPE) (SW *sw)
103 {
104     int samples;
105 
106     samples = ((int64_t) sw->HWBUF->size << 32) / sw->ratio;
107 
108     sw->buf = audio_calloc(__func__, samples, sizeof(struct st_sample));
109     if (!sw->buf) {
110         dolog ("Could not allocate buffer for `%s' (%d samples)\n",
111                SW_NAME (sw), samples);
112         return -1;
113     }
114 
115 #ifdef DAC
116     sw->rate = st_rate_start (sw->info.freq, sw->hw->info.freq);
117 #else
118     sw->rate = st_rate_start (sw->hw->info.freq, sw->info.freq);
119 #endif
120     if (!sw->rate) {
121         g_free (sw->buf);
122         sw->buf = NULL;
123         return -1;
124     }
125     return 0;
126 }
127 
128 static int glue (audio_pcm_sw_init_, TYPE) (
129     SW *sw,
130     HW *hw,
131     const char *name,
132     struct audsettings *as
133     )
134 {
135     int err;
136 
137     audio_pcm_init_info (&sw->info, as);
138     sw->hw = hw;
139     sw->active = 0;
140 #ifdef DAC
141     sw->ratio = ((int64_t) sw->hw->info.freq << 32) / sw->info.freq;
142     sw->total_hw_samples_mixed = 0;
143     sw->empty = 1;
144 #else
145     sw->ratio = ((int64_t) sw->info.freq << 32) / sw->hw->info.freq;
146 #endif
147 
148 #ifdef DAC
149     sw->conv = mixeng_conv
150 #else
151     sw->clip = mixeng_clip
152 #endif
153         [sw->info.nchannels == 2]
154         [sw->info.sign]
155         [sw->info.swap_endianness]
156         [audio_bits_to_index (sw->info.bits)];
157 
158     sw->name = g_strdup (name);
159     err = glue (audio_pcm_sw_alloc_resources_, TYPE) (sw);
160     if (err) {
161         g_free (sw->name);
162         sw->name = NULL;
163     }
164     return err;
165 }
166 
167 static void glue (audio_pcm_sw_fini_, TYPE) (SW *sw)
168 {
169     glue (audio_pcm_sw_free_resources_, TYPE) (sw);
170     g_free (sw->name);
171     sw->name = NULL;
172 }
173 
174 static void glue (audio_pcm_hw_add_sw_, TYPE) (HW *hw, SW *sw)
175 {
176     QLIST_INSERT_HEAD (&hw->sw_head, sw, entries);
177 }
178 
179 static void glue (audio_pcm_hw_del_sw_, TYPE) (SW *sw)
180 {
181     QLIST_REMOVE (sw, entries);
182 }
183 
184 static void glue (audio_pcm_hw_gc_, TYPE) (HW **hwp)
185 {
186     HW *hw = *hwp;
187     AudioState *s = hw->s;
188 
189     if (!hw->sw_head.lh_first) {
190 #ifdef DAC
191         audio_detach_capture (hw);
192 #endif
193         QLIST_REMOVE (hw, entries);
194         glue (hw->pcm_ops->fini_, TYPE) (hw);
195         glue (s->nb_hw_voices_, TYPE) += 1;
196         glue (audio_pcm_hw_free_resources_ ,TYPE) (hw);
197         g_free (hw);
198         *hwp = NULL;
199     }
200 }
201 
202 static HW *glue(audio_pcm_hw_find_any_, TYPE)(AudioState *s, HW *hw)
203 {
204     return hw ? hw->entries.le_next : glue (s->hw_head_, TYPE).lh_first;
205 }
206 
207 static HW *glue(audio_pcm_hw_find_any_enabled_, TYPE)(AudioState *s, HW *hw)
208 {
209     while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
210         if (hw->enabled) {
211             return hw;
212         }
213     }
214     return NULL;
215 }
216 
217 static HW *glue(audio_pcm_hw_find_specific_, TYPE)(AudioState *s, HW *hw,
218                                                    struct audsettings *as)
219 {
220     while ((hw = glue(audio_pcm_hw_find_any_, TYPE)(s, hw))) {
221         if (audio_pcm_info_eq (&hw->info, as)) {
222             return hw;
223         }
224     }
225     return NULL;
226 }
227 
228 static HW *glue(audio_pcm_hw_add_new_, TYPE)(AudioState *s,
229                                              struct audsettings *as)
230 {
231     HW *hw;
232     struct audio_driver *drv = s->drv;
233 
234     if (!glue (s->nb_hw_voices_, TYPE)) {
235         return NULL;
236     }
237 
238     if (audio_bug(__func__, !drv)) {
239         dolog ("No host audio driver\n");
240         return NULL;
241     }
242 
243     if (audio_bug(__func__, !drv->pcm_ops)) {
244         dolog ("Host audio driver without pcm_ops\n");
245         return NULL;
246     }
247 
248     hw = audio_calloc(__func__, 1, glue(drv->voice_size_, TYPE));
249     if (!hw) {
250         dolog ("Can not allocate voice `%s' size %d\n",
251                drv->name, glue (drv->voice_size_, TYPE));
252         return NULL;
253     }
254 
255     hw->s = s;
256     hw->pcm_ops = drv->pcm_ops;
257 
258     QLIST_INIT (&hw->sw_head);
259 #ifdef DAC
260     QLIST_INIT (&hw->cap_head);
261 #endif
262     if (glue (hw->pcm_ops->init_, TYPE) (hw, as, s->drv_opaque)) {
263         goto err0;
264     }
265 
266     if (audio_bug(__func__, hw->samples <= 0)) {
267         dolog("hw->samples=%zd\n", hw->samples);
268         goto err1;
269     }
270 
271 #ifdef DAC
272     hw->clip = mixeng_clip
273 #else
274     hw->conv = mixeng_conv
275 #endif
276         [hw->info.nchannels == 2]
277         [hw->info.sign]
278         [hw->info.swap_endianness]
279         [audio_bits_to_index (hw->info.bits)];
280 
281     glue(audio_pcm_hw_alloc_resources_, TYPE)(hw);
282 
283     QLIST_INSERT_HEAD (&s->glue (hw_head_, TYPE), hw, entries);
284     glue (s->nb_hw_voices_, TYPE) -= 1;
285 #ifdef DAC
286     audio_attach_capture (hw);
287 #endif
288     return hw;
289 
290  err1:
291     glue (hw->pcm_ops->fini_, TYPE) (hw);
292  err0:
293     g_free (hw);
294     return NULL;
295 }
296 
297 AudiodevPerDirectionOptions *glue(audio_get_pdo_, TYPE)(Audiodev *dev)
298 {
299     switch (dev->driver) {
300     case AUDIODEV_DRIVER_NONE:
301         return dev->u.none.TYPE;
302     case AUDIODEV_DRIVER_ALSA:
303         return qapi_AudiodevAlsaPerDirectionOptions_base(dev->u.alsa.TYPE);
304     case AUDIODEV_DRIVER_COREAUDIO:
305         return qapi_AudiodevCoreaudioPerDirectionOptions_base(
306             dev->u.coreaudio.TYPE);
307     case AUDIODEV_DRIVER_DSOUND:
308         return dev->u.dsound.TYPE;
309     case AUDIODEV_DRIVER_OSS:
310         return qapi_AudiodevOssPerDirectionOptions_base(dev->u.oss.TYPE);
311     case AUDIODEV_DRIVER_PA:
312         return qapi_AudiodevPaPerDirectionOptions_base(dev->u.pa.TYPE);
313     case AUDIODEV_DRIVER_SDL:
314         return dev->u.sdl.TYPE;
315     case AUDIODEV_DRIVER_SPICE:
316         return dev->u.spice.TYPE;
317     case AUDIODEV_DRIVER_WAV:
318         return dev->u.wav.TYPE;
319 
320     case AUDIODEV_DRIVER__MAX:
321         break;
322     }
323     abort();
324 }
325 
326 static HW *glue(audio_pcm_hw_add_, TYPE)(AudioState *s, struct audsettings *as)
327 {
328     HW *hw;
329     AudiodevPerDirectionOptions *pdo = glue(audio_get_pdo_, TYPE)(s->dev);
330 
331     if (pdo->fixed_settings) {
332         hw = glue(audio_pcm_hw_add_new_, TYPE)(s, as);
333         if (hw) {
334             return hw;
335         }
336     }
337 
338     hw = glue(audio_pcm_hw_find_specific_, TYPE)(s, NULL, as);
339     if (hw) {
340         return hw;
341     }
342 
343     hw = glue(audio_pcm_hw_add_new_, TYPE)(s, as);
344     if (hw) {
345         return hw;
346     }
347 
348     return glue(audio_pcm_hw_find_any_, TYPE)(s, NULL);
349 }
350 
351 static SW *glue(audio_pcm_create_voice_pair_, TYPE)(
352     AudioState *s,
353     const char *sw_name,
354     struct audsettings *as
355     )
356 {
357     SW *sw;
358     HW *hw;
359     struct audsettings hw_as;
360     AudiodevPerDirectionOptions *pdo = glue(audio_get_pdo_, TYPE)(s->dev);
361 
362     if (pdo->fixed_settings) {
363         hw_as = audiodev_to_audsettings(pdo);
364     }
365     else {
366         hw_as = *as;
367     }
368 
369     sw = audio_calloc(__func__, 1, sizeof(*sw));
370     if (!sw) {
371         dolog ("Could not allocate soft voice `%s' (%zu bytes)\n",
372                sw_name ? sw_name : "unknown", sizeof (*sw));
373         goto err1;
374     }
375     sw->s = s;
376 
377     hw = glue(audio_pcm_hw_add_, TYPE)(s, &hw_as);
378     if (!hw) {
379         goto err2;
380     }
381 
382     glue (audio_pcm_hw_add_sw_, TYPE) (hw, sw);
383 
384     if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, sw_name, as)) {
385         goto err3;
386     }
387 
388     return sw;
389 
390 err3:
391     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
392     glue (audio_pcm_hw_gc_, TYPE) (&hw);
393 err2:
394     g_free (sw);
395 err1:
396     return NULL;
397 }
398 
399 static void glue (audio_close_, TYPE) (SW *sw)
400 {
401     glue (audio_pcm_sw_fini_, TYPE) (sw);
402     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
403     glue (audio_pcm_hw_gc_, TYPE) (&sw->hw);
404     g_free (sw);
405 }
406 
407 void glue (AUD_close_, TYPE) (QEMUSoundCard *card, SW *sw)
408 {
409     if (sw) {
410         if (audio_bug(__func__, !card)) {
411             dolog ("card=%p\n", card);
412             return;
413         }
414 
415         glue (audio_close_, TYPE) (sw);
416     }
417 }
418 
419 SW *glue (AUD_open_, TYPE) (
420     QEMUSoundCard *card,
421     SW *sw,
422     const char *name,
423     void *callback_opaque ,
424     audio_callback_fn callback_fn,
425     struct audsettings *as
426     )
427 {
428     AudioState *s = card->state;
429     AudiodevPerDirectionOptions *pdo = glue(audio_get_pdo_, TYPE)(s->dev);
430 
431     if (audio_bug(__func__, !card || !name || !callback_fn || !as)) {
432         dolog ("card=%p name=%p callback_fn=%p as=%p\n",
433                card, name, callback_fn, as);
434         goto fail;
435     }
436 
437     ldebug ("open %s, freq %d, nchannels %d, fmt %d\n",
438             name, as->freq, as->nchannels, as->fmt);
439 
440     if (audio_bug(__func__, audio_validate_settings(as))) {
441         audio_print_settings (as);
442         goto fail;
443     }
444 
445     if (audio_bug(__func__, !s->drv)) {
446         dolog ("Can not open `%s' (no host audio driver)\n", name);
447         goto fail;
448     }
449 
450     if (sw && audio_pcm_info_eq (&sw->info, as)) {
451         return sw;
452     }
453 
454     if (!pdo->fixed_settings && sw) {
455         glue (AUD_close_, TYPE) (card, sw);
456         sw = NULL;
457     }
458 
459     if (sw) {
460         HW *hw = sw->hw;
461 
462         if (!hw) {
463             dolog ("Internal logic error voice `%s' has no hardware store\n",
464                    SW_NAME (sw));
465             goto fail;
466         }
467 
468         glue (audio_pcm_sw_fini_, TYPE) (sw);
469         if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, name, as)) {
470             goto fail;
471         }
472     }
473     else {
474         sw = glue(audio_pcm_create_voice_pair_, TYPE)(s, name, as);
475         if (!sw) {
476             dolog ("Failed to create voice `%s'\n", name);
477             return NULL;
478         }
479     }
480 
481     sw->card = card;
482     sw->vol = nominal_volume;
483     sw->callback.fn = callback_fn;
484     sw->callback.opaque = callback_opaque;
485 
486 #ifdef DEBUG_AUDIO
487     dolog ("%s\n", name);
488     audio_pcm_print_info ("hw", &sw->hw->info);
489     audio_pcm_print_info ("sw", &sw->info);
490 #endif
491 
492     return sw;
493 
494  fail:
495     glue (AUD_close_, TYPE) (card, sw);
496     return NULL;
497 }
498 
499 int glue (AUD_is_active_, TYPE) (SW *sw)
500 {
501     return sw ? sw->active : 0;
502 }
503 
504 void glue (AUD_init_time_stamp_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
505 {
506     if (!sw) {
507         return;
508     }
509 
510     ts->old_ts = sw->hw->ts_helper;
511 }
512 
513 uint64_t glue (AUD_get_elapsed_usec_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
514 {
515     uint64_t delta, cur_ts, old_ts;
516 
517     if (!sw) {
518         return 0;
519     }
520 
521     cur_ts = sw->hw->ts_helper;
522     old_ts = ts->old_ts;
523     /* dolog ("cur %" PRId64 " old %" PRId64 "\n", cur_ts, old_ts); */
524 
525     if (cur_ts >= old_ts) {
526         delta = cur_ts - old_ts;
527     }
528     else {
529         delta = UINT64_MAX - old_ts + cur_ts;
530     }
531 
532     if (!delta) {
533         return 0;
534     }
535 
536     return muldiv64 (delta, sw->hw->info.freq, 1000000);
537 }
538 
539 #undef TYPE
540 #undef HW
541 #undef SW
542 #undef HWBUF
543 #undef NAME
544