audio fixes + initial audio capture support (malc)
[qemu] / audio / audio_template.h
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) (
40     AudioState *s,
41     struct audio_driver *drv
42     )
43 {
44     int max_voices = glue (drv->max_voices_, TYPE);
45     int voice_size = glue (drv->voice_size_, TYPE);
46
47     if (glue (s->nb_hw_voices_, TYPE) > max_voices) {
48         if (!max_voices) {
49 #ifdef DAC
50             dolog ("Driver `%s' does not support " NAME "\n", drv->name);
51 #endif
52         }
53         else {
54             dolog ("Driver `%s' does not support %d " NAME " voices, max %d\n",
55                    drv->name,
56                    glue (s->nb_hw_voices_, TYPE),
57                    max_voices);
58         }
59         glue (s->nb_hw_voices_, TYPE) = max_voices;
60     }
61
62     if (audio_bug (AUDIO_FUNC, !voice_size && max_voices)) {
63         dolog ("drv=`%s' voice_size=0 max_voices=%d\n",
64                drv->name, max_voices);
65         glue (s->nb_hw_voices_, TYPE) = 0;
66     }
67
68     if (audio_bug (AUDIO_FUNC, voice_size && !max_voices)) {
69         dolog ("drv=`%s' voice_size=%d max_voices=0\n",
70                drv->name, voice_size);
71     }
72 }
73
74 static void glue (audio_pcm_hw_free_resources_, TYPE) (HW *hw)
75 {
76     if (HWBUF) {
77         qemu_free (HWBUF);
78     }
79
80     HWBUF = NULL;
81 }
82
83 static int glue (audio_pcm_hw_alloc_resources_, TYPE) (HW *hw)
84 {
85     HWBUF = audio_calloc (AUDIO_FUNC, hw->samples, sizeof (st_sample_t));
86     if (!HWBUF) {
87         dolog ("Could not allocate " NAME " buffer (%d samples)\n",
88                hw->samples);
89         return -1;
90     }
91
92     return 0;
93 }
94
95 static void glue (audio_pcm_sw_free_resources_, TYPE) (SW *sw)
96 {
97     if (sw->buf) {
98         qemu_free (sw->buf);
99     }
100
101     if (sw->rate) {
102         st_rate_stop (sw->rate);
103     }
104
105     sw->buf = NULL;
106     sw->rate = NULL;
107 }
108
109 static int glue (audio_pcm_sw_alloc_resources_, TYPE) (SW *sw)
110 {
111     int samples;
112
113 #ifdef DAC
114     samples = sw->hw->samples;
115 #else
116     samples = ((int64_t) sw->hw->samples << 32) / sw->ratio;
117 #endif
118
119     sw->buf = audio_calloc (AUDIO_FUNC, samples, sizeof (st_sample_t));
120     if (!sw->buf) {
121         dolog ("Could not allocate buffer for `%s' (%d samples)\n",
122                SW_NAME (sw), samples);
123         return -1;
124     }
125
126 #ifdef DAC
127     sw->rate = st_rate_start (sw->info.freq, sw->hw->info.freq);
128 #else
129     sw->rate = st_rate_start (sw->hw->info.freq, sw->info.freq);
130 #endif
131     if (!sw->rate) {
132         qemu_free (sw->buf);
133         sw->buf = NULL;
134         return -1;
135     }
136     return 0;
137 }
138
139 static int glue (audio_pcm_sw_init_, TYPE) (
140     SW *sw,
141     HW *hw,
142     const char *name,
143     audsettings_t *as,
144     int endian
145     )
146 {
147     int err;
148
149     audio_pcm_init_info (&sw->info, as, audio_need_to_swap_endian (endian));
150     sw->hw = hw;
151     sw->active = 0;
152 #ifdef DAC
153     sw->ratio = ((int64_t) sw->hw->info.freq << 32) / sw->info.freq;
154     sw->total_hw_samples_mixed = 0;
155     sw->empty = 1;
156 #else
157     sw->ratio = ((int64_t) sw->info.freq << 32) / sw->hw->info.freq;
158 #endif
159
160 #ifdef DAC
161     sw->conv = mixeng_conv
162 #else
163     sw->clip = mixeng_clip
164 #endif
165         [sw->info.nchannels == 2]
166         [sw->info.sign]
167         [sw->info.swap_endian]
168         [sw->info.bits == 16];
169
170     sw->name = qemu_strdup (name);
171     err = glue (audio_pcm_sw_alloc_resources_, TYPE) (sw);
172     if (err) {
173         qemu_free (sw->name);
174         sw->name = NULL;
175     }
176     return err;
177 }
178
179 static void glue (audio_pcm_sw_fini_, TYPE) (SW *sw)
180 {
181     glue (audio_pcm_sw_free_resources_, TYPE) (sw);
182     if (sw->name) {
183         qemu_free (sw->name);
184         sw->name = NULL;
185     }
186 }
187
188 static void glue (audio_pcm_hw_add_sw_, TYPE) (HW *hw, SW *sw)
189 {
190     LIST_INSERT_HEAD (&hw->sw_head, sw, entries);
191 }
192
193 static void glue (audio_pcm_hw_del_sw_, TYPE) (SW *sw)
194 {
195     LIST_REMOVE (sw, entries);
196 }
197
198 static void glue (audio_pcm_hw_gc_, TYPE) (AudioState *s, HW **hwp)
199 {
200     HW *hw = *hwp;
201
202     if (!hw->sw_head.lh_first) {
203 #ifdef DAC
204         audio_detach_capture (hw);
205 #endif
206         LIST_REMOVE (hw, entries);
207         glue (s->nb_hw_voices_, TYPE) += 1;
208         glue (audio_pcm_hw_free_resources_ ,TYPE) (hw);
209         glue (hw->pcm_ops->fini_, TYPE) (hw);
210         qemu_free (hw);
211         *hwp = NULL;
212     }
213 }
214
215 static HW *glue (audio_pcm_hw_find_any_, TYPE) (AudioState *s, HW *hw)
216 {
217     return hw ? hw->entries.le_next : s->glue (hw_head_, TYPE).lh_first;
218 }
219
220 static HW *glue (audio_pcm_hw_find_any_enabled_, TYPE) (AudioState *s, HW *hw)
221 {
222     while ((hw = glue (audio_pcm_hw_find_any_, TYPE) (s, hw))) {
223         if (hw->enabled) {
224             return hw;
225         }
226     }
227     return NULL;
228 }
229
230 static HW *glue (audio_pcm_hw_find_specific_, TYPE) (
231     AudioState *s,
232     HW *hw,
233     audsettings_t *as
234     )
235 {
236     while ((hw = glue (audio_pcm_hw_find_any_, TYPE) (s, hw))) {
237         if (audio_pcm_info_eq (&hw->info, as)) {
238             return hw;
239         }
240     }
241     return NULL;
242 }
243
244 static HW *glue (audio_pcm_hw_add_new_, TYPE) (AudioState *s, audsettings_t *as)
245 {
246     HW *hw;
247     struct audio_driver *drv = s->drv;
248
249     if (!glue (s->nb_hw_voices_, TYPE)) {
250         return NULL;
251     }
252
253     if (audio_bug (AUDIO_FUNC, !drv)) {
254         dolog ("No host audio driver\n");
255         return NULL;
256     }
257
258     if (audio_bug (AUDIO_FUNC, !drv->pcm_ops)) {
259         dolog ("Host audio driver without pcm_ops\n");
260         return NULL;
261     }
262
263     hw = audio_calloc (AUDIO_FUNC, 1, glue (drv->voice_size_, TYPE));
264     if (!hw) {
265         dolog ("Can not allocate voice `%s' size %d\n",
266                drv->name, glue (drv->voice_size_, TYPE));
267         return NULL;
268     }
269
270     hw->pcm_ops = drv->pcm_ops;
271     LIST_INIT (&hw->sw_head);
272 #ifdef DAC
273     LIST_INIT (&hw->sw_cap_head);
274 #endif
275     if (glue (hw->pcm_ops->init_, TYPE) (hw, as)) {
276         goto err0;
277     }
278
279     if (audio_bug (AUDIO_FUNC, hw->samples <= 0)) {
280         dolog ("hw->samples=%d\n", hw->samples);
281         goto err1;
282     }
283
284 #ifdef DAC
285     hw->clip = mixeng_clip
286 #else
287     hw->conv = mixeng_conv
288 #endif
289         [hw->info.nchannels == 2]
290         [hw->info.sign]
291         [hw->info.swap_endian]
292         [hw->info.bits == 16];
293
294     if (glue (audio_pcm_hw_alloc_resources_, TYPE) (hw)) {
295         goto err1;
296     }
297
298     LIST_INSERT_HEAD (&s->glue (hw_head_, TYPE), hw, entries);
299     glue (s->nb_hw_voices_, TYPE) -= 1;
300 #ifdef DAC
301     audio_attach_capture (s, hw);
302 #endif
303     return hw;
304
305  err1:
306     glue (hw->pcm_ops->fini_, TYPE) (hw);
307  err0:
308     qemu_free (hw);
309     return NULL;
310 }
311
312 static HW *glue (audio_pcm_hw_add_, TYPE) (AudioState *s, audsettings_t *as)
313 {
314     HW *hw;
315
316     if (glue (conf.fixed_, TYPE).enabled && glue (conf.fixed_, TYPE).greedy) {
317         hw = glue (audio_pcm_hw_add_new_, TYPE) (s, as);
318         if (hw) {
319             return hw;
320         }
321     }
322
323     hw = glue (audio_pcm_hw_find_specific_, TYPE) (s, NULL, as);
324     if (hw) {
325         return hw;
326     }
327
328     hw = glue (audio_pcm_hw_add_new_, TYPE) (s, as);
329     if (hw) {
330         return hw;
331     }
332
333     return glue (audio_pcm_hw_find_any_, TYPE) (s, NULL);
334 }
335
336 static SW *glue (audio_pcm_create_voice_pair_, TYPE) (
337     AudioState *s,
338     const char *sw_name,
339     audsettings_t *as,
340     int sw_endian
341     )
342 {
343     SW *sw;
344     HW *hw;
345     audsettings_t hw_as;
346
347     if (glue (conf.fixed_, TYPE).enabled) {
348         hw_as = glue (conf.fixed_, TYPE).settings;
349     }
350     else {
351         hw_as = *as;
352     }
353
354     sw = audio_calloc (AUDIO_FUNC, 1, sizeof (*sw));
355     if (!sw) {
356         dolog ("Could not allocate soft voice `%s' (%zu bytes)\n",
357                sw_name ? sw_name : "unknown", sizeof (*sw));
358         goto err1;
359     }
360
361     hw = glue (audio_pcm_hw_add_, TYPE) (s, &hw_as);
362     if (!hw) {
363         goto err2;
364     }
365
366     glue (audio_pcm_hw_add_sw_, TYPE) (hw, sw);
367
368     if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, sw_name, as, sw_endian)) {
369         goto err3;
370     }
371
372     return sw;
373
374 err3:
375     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
376     glue (audio_pcm_hw_gc_, TYPE) (s, &hw);
377 err2:
378     qemu_free (sw);
379 err1:
380     return NULL;
381 }
382
383 static void glue (audio_close_, TYPE) (AudioState *s, SW *sw)
384 {
385     glue (audio_pcm_sw_fini_, TYPE) (sw);
386     glue (audio_pcm_hw_del_sw_, TYPE) (sw);
387     glue (audio_pcm_hw_gc_, TYPE) (s, &sw->hw);
388     qemu_free (sw);
389 }
390
391 void glue (AUD_close_, TYPE) (QEMUSoundCard *card, SW *sw)
392 {
393     if (sw) {
394         if (audio_bug (AUDIO_FUNC, !card || !card->audio)) {
395             dolog ("card=%p card->audio=%p\n",
396                    card, card ? card->audio : NULL);
397             return;
398         }
399
400         glue (audio_close_, TYPE) (card->audio, sw);
401     }
402 }
403
404 SW *glue (AUD_open_, TYPE) (
405     QEMUSoundCard *card,
406     SW *sw,
407     const char *name,
408     void *callback_opaque ,
409     audio_callback_fn_t callback_fn,
410     audsettings_t *as,
411     int sw_endian
412     )
413 {
414     AudioState *s;
415 #ifdef DAC
416     int live = 0;
417     SW *old_sw = NULL;
418 #endif
419
420     ldebug ("open %s, freq %d, nchannels %d, fmt %d\n",
421             name, as->freq, as->nchannels, as->fmt);
422
423     if (audio_bug (AUDIO_FUNC,
424                    !card || !card->audio || !name || !callback_fn || !as)) {
425         dolog ("card=%p card->audio=%p name=%p callback_fn=%p as=%p\n",
426                card, card ? card->audio : NULL, name, callback_fn, as);
427         goto fail;
428     }
429
430     s = card->audio;
431
432     if (audio_bug (AUDIO_FUNC, audio_validate_settigs (as))) {
433         audio_print_settings (as);
434         goto fail;
435     }
436
437     if (audio_bug (AUDIO_FUNC, !s->drv)) {
438         dolog ("Can not open `%s' (no host audio driver)\n", name);
439         goto fail;
440     }
441
442     if (sw && audio_pcm_info_eq (&sw->info, as)) {
443         return sw;
444     }
445
446 #ifdef DAC
447     if (conf.plive && sw && (!sw->active && !sw->empty)) {
448         live = sw->total_hw_samples_mixed;
449
450 #ifdef DEBUG_PLIVE
451         dolog ("Replacing voice %s with %d live samples\n", SW_NAME (sw), live);
452         dolog ("Old %s freq %d, bits %d, channels %d\n",
453                SW_NAME (sw), sw->info.freq, sw->info.bits, sw->info.nchannels);
454         dolog ("New %s freq %d, bits %d, channels %d\n",
455                name,
456                freq,
457                (fmt == AUD_FMT_S16 || fmt == AUD_FMT_U16) ? 16 : 8,
458                nchannels);
459 #endif
460
461         if (live) {
462             old_sw = sw;
463             old_sw->callback.fn = NULL;
464             sw = NULL;
465         }
466     }
467 #endif
468
469     if (!glue (conf.fixed_, TYPE).enabled && sw) {
470         glue (AUD_close_, TYPE) (card, sw);
471         sw = NULL;
472     }
473
474     if (sw) {
475         HW *hw = sw->hw;
476
477         if (!hw) {
478             dolog ("Internal logic error voice `%s' has no hardware store\n",
479                    SW_NAME (sw));
480             goto fail;
481         }
482
483         glue (audio_pcm_sw_fini_, TYPE) (sw);
484         if (glue (audio_pcm_sw_init_, TYPE) (sw, hw, name, as, sw_endian)) {
485             goto fail;
486         }
487     }
488     else {
489         sw = glue (audio_pcm_create_voice_pair_, TYPE) (s, name, as, sw_endian);
490         if (!sw) {
491             dolog ("Failed to create voice `%s'\n", name);
492             return NULL;
493         }
494     }
495
496     if (sw) {
497         sw->vol = nominal_volume;
498         sw->callback.fn = callback_fn;
499         sw->callback.opaque = callback_opaque;
500
501 #ifdef DAC
502         if (live) {
503             int mixed =
504                 (live << old_sw->info.shift)
505                 * old_sw->info.bytes_per_second
506                 / sw->info.bytes_per_second;
507
508 #ifdef DEBUG_PLIVE
509             dolog ("Silence will be mixed %d\n", mixed);
510 #endif
511             sw->total_hw_samples_mixed += mixed;
512         }
513 #endif
514
515 #ifdef DEBUG_AUDIO
516         dolog ("%s\n", name);
517         audio_pcm_print_info ("hw", &sw->hw->info);
518         audio_pcm_print_info ("sw", &sw->info);
519 #endif
520     }
521
522     return sw;
523
524  fail:
525     glue (AUD_close_, TYPE) (card, sw);
526     return NULL;
527 }
528
529 int glue (AUD_is_active_, TYPE) (SW *sw)
530 {
531     return sw ? sw->active : 0;
532 }
533
534 void glue (AUD_init_time_stamp_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
535 {
536     if (!sw) {
537         return;
538     }
539
540     ts->old_ts = sw->hw->ts_helper;
541 }
542
543 uint64_t glue (AUD_get_elapsed_usec_, TYPE) (SW *sw, QEMUAudioTimeStamp *ts)
544 {
545     uint64_t delta, cur_ts, old_ts;
546
547     if (!sw) {
548         return 0;
549     }
550
551     cur_ts = sw->hw->ts_helper;
552     old_ts = ts->old_ts;
553     /* dolog ("cur %lld old %lld\n", cur_ts, old_ts); */
554
555     if (cur_ts >= old_ts) {
556         delta = cur_ts - old_ts;
557     }
558     else {
559         delta = UINT64_MAX - old_ts + cur_ts;
560     }
561
562     if (!delta) {
563         return 0;
564     }
565
566     return (delta * sw->hw->info.freq) / 1000000;
567 }
568
569 #undef TYPE
570 #undef HW
571 #undef SW
572 #undef HWBUF
573 #undef NAME