blob: 2a6914d2aa65d07b2dce33058a8601659e9c25e4 [file] [log] [blame]
bellardfb065182004-11-09 23:09:44 +00001/*
2 * QEMU Audio subsystem header
bellard1d14ffa2005-10-30 18:58:22 +00003 *
4 * Copyright (c) 2003-2005 Vassili Karpov (malc)
5 *
bellardfb065182004-11-09 23:09:44 +00006 * 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 */
Markus Armbruster175de522016-06-29 15:29:06 +020024
bellardfb065182004-11-09 23:09:44 +000025#ifndef QEMU_AUDIO_INT_H
26#define QEMU_AUDIO_INT_H
27
Gerd Hoffmann1ef1ec22018-03-01 11:05:46 +010028#ifdef CONFIG_AUDIO_COREAUDIO
bellard1d14ffa2005-10-30 18:58:22 +000029#define FLOAT_MIXENG
30/* #define RECIPROCAL */
31#endif
32#include "mixeng.h"
bellardfb065182004-11-09 23:09:44 +000033
Marc-André Lureau739362d2021-03-09 17:15:28 +040034#ifdef CONFIG_GIO
35#include <gio/gio.h>
36#endif
37
bellard1d14ffa2005-10-30 18:58:22 +000038struct audio_pcm_ops;
39
bellard1d14ffa2005-10-30 18:58:22 +000040struct audio_callback {
41 void *opaque;
malccb4f03e2009-10-15 02:40:17 +040042 audio_callback_fn fn;
bellard1d14ffa2005-10-30 18:58:22 +000043};
44
45struct audio_pcm_info {
46 int bits;
Kővágó, Zoltáned2a4a72020-02-02 20:38:07 +010047 bool is_signed;
48 bool is_float;
bellard1d14ffa2005-10-30 18:58:22 +000049 int freq;
50 int nchannels;
Kővágó, Zoltán2b9cce82019-10-13 21:58:02 +020051 int bytes_per_frame;
bellard1d14ffa2005-10-30 18:58:22 +000052 int bytes_per_second;
bellardd929eba2006-07-04 21:47:22 +000053 int swap_endianness;
bellard1d14ffa2005-10-30 18:58:22 +000054};
55
Kővágó, Zoltán526fb052019-08-19 01:06:46 +020056typedef struct AudioState AudioState;
bellardec36b692006-07-16 18:57:03 +000057typedef struct SWVoiceCap SWVoiceCap;
58
Kővágó, Zoltándc88e382019-09-19 23:24:20 +020059typedef struct STSampleBuffer {
60 size_t pos, size;
61 st_sample samples[];
62} STSampleBuffer;
63
bellard1d14ffa2005-10-30 18:58:22 +000064typedef struct HWVoiceOut {
Kővágó, Zoltán526fb052019-08-19 01:06:46 +020065 AudioState *s;
bellardfb065182004-11-09 23:09:44 +000066 int enabled;
malc713a98f2009-09-12 02:28:45 +040067 int poll_mode;
bellardfb065182004-11-09 23:09:44 +000068 int pending_disable;
bellard1d14ffa2005-10-30 18:58:22 +000069 struct audio_pcm_info info;
bellardfb065182004-11-09 23:09:44 +000070
71 f_sample *clip;
bellard1d14ffa2005-10-30 18:58:22 +000072 uint64_t ts_helper;
bellardfb065182004-11-09 23:09:44 +000073
Kővágó, Zoltándc88e382019-09-19 23:24:20 +020074 STSampleBuffer *mix_buf;
Kővágó, Zoltánff095e52019-09-19 23:24:09 +020075 void *buf_emul;
76 size_t pos_emul, pending_emul, size_emul;
bellardfb065182004-11-09 23:09:44 +000077
Kővágó, Zoltán75204622019-08-19 01:06:58 +020078 size_t samples;
Blue Swirl72cf2d42009-09-12 07:36:22 +000079 QLIST_HEAD (sw_out_listhead, SWVoiceOut) sw_head;
80 QLIST_HEAD (sw_cap_listhead, SWVoiceCap) cap_head;
blueswir135f4b582008-10-06 18:08:30 +000081 struct audio_pcm_ops *pcm_ops;
Blue Swirl72cf2d42009-09-12 07:36:22 +000082 QLIST_ENTRY (HWVoiceOut) entries;
bellard1d14ffa2005-10-30 18:58:22 +000083} HWVoiceOut;
bellardfb065182004-11-09 23:09:44 +000084
bellard1d14ffa2005-10-30 18:58:22 +000085typedef struct HWVoiceIn {
Kővágó, Zoltán526fb052019-08-19 01:06:46 +020086 AudioState *s;
bellard1d14ffa2005-10-30 18:58:22 +000087 int enabled;
malc713a98f2009-09-12 02:28:45 +040088 int poll_mode;
bellard1d14ffa2005-10-30 18:58:22 +000089 struct audio_pcm_info info;
bellardfb065182004-11-09 23:09:44 +000090
91 t_sample *conv;
92
Kővágó, Zoltán75204622019-08-19 01:06:58 +020093 size_t total_samples_captured;
bellard1d14ffa2005-10-30 18:58:22 +000094 uint64_t ts_helper;
95
Kővágó, Zoltándc88e382019-09-19 23:24:20 +020096 STSampleBuffer *conv_buf;
Kővágó, Zoltánff095e52019-09-19 23:24:09 +020097 void *buf_emul;
98 size_t pos_emul, pending_emul, size_emul;
bellard1d14ffa2005-10-30 18:58:22 +000099
Kővágó, Zoltán75204622019-08-19 01:06:58 +0200100 size_t samples;
Blue Swirl72cf2d42009-09-12 07:36:22 +0000101 QLIST_HEAD (sw_in_listhead, SWVoiceIn) sw_head;
blueswir135f4b582008-10-06 18:08:30 +0000102 struct audio_pcm_ops *pcm_ops;
Blue Swirl72cf2d42009-09-12 07:36:22 +0000103 QLIST_ENTRY (HWVoiceIn) entries;
bellard1d14ffa2005-10-30 18:58:22 +0000104} HWVoiceIn;
105
bellard1d14ffa2005-10-30 18:58:22 +0000106struct SWVoiceOut {
malc1a7dafc2009-05-14 03:11:35 +0400107 QEMUSoundCard *card;
Kővágó, Zoltán526fb052019-08-19 01:06:46 +0200108 AudioState *s;
bellard1d14ffa2005-10-30 18:58:22 +0000109 struct audio_pcm_info info;
110 t_sample *conv;
bellardfb065182004-11-09 23:09:44 +0000111 int64_t ratio;
malc1ea879e2008-12-03 22:48:44 +0000112 struct st_sample *buf;
bellardfb065182004-11-09 23:09:44 +0000113 void *rate;
Kővágó, Zoltán75204622019-08-19 01:06:58 +0200114 size_t total_hw_samples_mixed;
bellardfb065182004-11-09 23:09:44 +0000115 int active;
bellard1d14ffa2005-10-30 18:58:22 +0000116 int empty;
117 HWVoiceOut *hw;
bellardfb065182004-11-09 23:09:44 +0000118 char *name;
malc1ea879e2008-12-03 22:48:44 +0000119 struct mixeng_volume vol;
bellard1d14ffa2005-10-30 18:58:22 +0000120 struct audio_callback callback;
Blue Swirl72cf2d42009-09-12 07:36:22 +0000121 QLIST_ENTRY (SWVoiceOut) entries;
bellardfb065182004-11-09 23:09:44 +0000122};
123
bellard1d14ffa2005-10-30 18:58:22 +0000124struct SWVoiceIn {
malc1a7dafc2009-05-14 03:11:35 +0400125 QEMUSoundCard *card;
Kővágó, Zoltán526fb052019-08-19 01:06:46 +0200126 AudioState *s;
bellard1d14ffa2005-10-30 18:58:22 +0000127 int active;
128 struct audio_pcm_info info;
129 int64_t ratio;
130 void *rate;
Kővágó, Zoltán75204622019-08-19 01:06:58 +0200131 size_t total_hw_samples_acquired;
malc1ea879e2008-12-03 22:48:44 +0000132 struct st_sample *buf;
bellard1d14ffa2005-10-30 18:58:22 +0000133 f_sample *clip;
134 HWVoiceIn *hw;
135 char *name;
malc1ea879e2008-12-03 22:48:44 +0000136 struct mixeng_volume vol;
bellard1d14ffa2005-10-30 18:58:22 +0000137 struct audio_callback callback;
Blue Swirl72cf2d42009-09-12 07:36:22 +0000138 QLIST_ENTRY (SWVoiceIn) entries;
bellardfb065182004-11-09 23:09:44 +0000139};
140
Gerd Hoffmannd3893a32018-03-06 08:40:47 +0100141typedef struct audio_driver audio_driver;
bellardc0fe3822005-11-05 18:55:28 +0000142struct audio_driver {
143 const char *name;
144 const char *descr;
Kővágó, Zoltán71830222019-03-08 23:34:15 +0100145 void *(*init) (Audiodev *);
bellardc0fe3822005-11-05 18:55:28 +0000146 void (*fini) (void *);
Marc-André Lureau739362d2021-03-09 17:15:28 +0400147#ifdef CONFIG_GIO
148 void (*set_dbus_server) (AudioState *s, GDBusObjectManagerServer *manager);
149#endif
blueswir135f4b582008-10-06 18:08:30 +0000150 struct audio_pcm_ops *pcm_ops;
bellardc0fe3822005-11-05 18:55:28 +0000151 int can_be_default;
152 int max_voices_out;
153 int max_voices_in;
154 int voice_size_out;
155 int voice_size_in;
Gerd Hoffmannd3893a32018-03-06 08:40:47 +0100156 QLIST_ENTRY(audio_driver) next;
bellardc0fe3822005-11-05 18:55:28 +0000157};
158
bellard1d14ffa2005-10-30 18:58:22 +0000159struct audio_pcm_ops {
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200160 int (*init_out)(HWVoiceOut *hw, audsettings *as, void *drv_opaque);
161 void (*fini_out)(HWVoiceOut *hw);
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200162 size_t (*write) (HWVoiceOut *hw, void *buf, size_t size);
Volker Rümelinfdc8c5f2020-01-23 08:49:39 +0100163 void (*run_buffer_out)(HWVoiceOut *hw);
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200164 /*
Volker Rümelin98334382022-03-01 20:13:06 +0100165 * Get the free output buffer size. This is an upper limit. The size
166 * returned by function get_buffer_out may be smaller.
167 */
168 size_t (*buffer_get_free)(HWVoiceOut *hw);
169 /*
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200170 * get a buffer that after later can be passed to put_buffer_out; optional
171 * returns the buffer, and writes it's size to size (in bytes)
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200172 */
173 void *(*get_buffer_out)(HWVoiceOut *hw, size_t *size);
174 /*
175 * put back the buffer returned by get_buffer_out; optional
176 * buf must be equal the pointer returned by get_buffer_out,
177 * size may be smaller
178 */
179 size_t (*put_buffer_out)(HWVoiceOut *hw, void *buf, size_t size);
Kővágó, Zoltán571a8c52019-09-19 23:24:22 +0200180 void (*enable_out)(HWVoiceOut *hw, bool enable);
Kővágó, Zoltáncecc1e72019-10-13 21:58:01 +0200181 void (*volume_out)(HWVoiceOut *hw, Volume *vol);
bellardfb065182004-11-09 23:09:44 +0000182
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200183 int (*init_in) (HWVoiceIn *hw, audsettings *as, void *drv_opaque);
184 void (*fini_in) (HWVoiceIn *hw);
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200185 size_t (*read) (HWVoiceIn *hw, void *buf, size_t size);
Volker Rümelina2893c82021-01-10 11:02:24 +0100186 void (*run_buffer_in)(HWVoiceIn *hw);
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200187 void *(*get_buffer_in)(HWVoiceIn *hw, size_t *size);
188 void (*put_buffer_in)(HWVoiceIn *hw, void *buf, size_t size);
Kővágó, Zoltán571a8c52019-09-19 23:24:22 +0200189 void (*enable_in)(HWVoiceIn *hw, bool enable);
Kővágó, Zoltáncecc1e72019-10-13 21:58:01 +0200190 void (*volume_in)(HWVoiceIn *hw, Volume *vol);
bellard1d14ffa2005-10-30 18:58:22 +0000191};
bellardfb065182004-11-09 23:09:44 +0000192
Volker Rümelina2893c82021-01-10 11:02:24 +0100193void audio_generic_run_buffer_in(HWVoiceIn *hw);
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200194void *audio_generic_get_buffer_in(HWVoiceIn *hw, size_t *size);
195void audio_generic_put_buffer_in(HWVoiceIn *hw, void *buf, size_t size);
Volker Rümelinfdc8c5f2020-01-23 08:49:39 +0100196void audio_generic_run_buffer_out(HWVoiceOut *hw);
Volker Rümelin98334382022-03-01 20:13:06 +0100197size_t audio_generic_buffer_get_free(HWVoiceOut *hw);
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200198void *audio_generic_get_buffer_out(HWVoiceOut *hw, size_t *size);
199size_t audio_generic_put_buffer_out(HWVoiceOut *hw, void *buf, size_t size);
Kővágó, Zoltánff095e52019-09-19 23:24:09 +0200200size_t audio_generic_write(HWVoiceOut *hw, void *buf, size_t size);
201size_t audio_generic_read(HWVoiceIn *hw, void *buf, size_t size);
202
bellard8ead62c2006-07-04 16:51:32 +0000203struct capture_callback {
204 struct audio_capture_ops ops;
205 void *opaque;
Blue Swirl72cf2d42009-09-12 07:36:22 +0000206 QLIST_ENTRY (capture_callback) entries;
bellard8ead62c2006-07-04 16:51:32 +0000207};
208
bellardec36b692006-07-16 18:57:03 +0000209struct CaptureVoiceOut {
bellard8ead62c2006-07-04 16:51:32 +0000210 HWVoiceOut hw;
211 void *buf;
Blue Swirl72cf2d42009-09-12 07:36:22 +0000212 QLIST_HEAD (cb_listhead, capture_callback) cb_head;
213 QLIST_ENTRY (CaptureVoiceOut) entries;
bellardec36b692006-07-16 18:57:03 +0000214};
215
216struct SWVoiceCap {
217 SWVoiceOut sw;
218 CaptureVoiceOut *cap;
Blue Swirl72cf2d42009-09-12 07:36:22 +0000219 QLIST_ENTRY (SWVoiceCap) entries;
bellardec36b692006-07-16 18:57:03 +0000220};
bellard8ead62c2006-07-04 16:51:32 +0000221
Philippe Mathieu-Daudéfd5283f2019-01-11 15:08:53 +0100222typedef struct AudioState {
bellardc0fe3822005-11-05 18:55:28 +0000223 struct audio_driver *drv;
Kővágó, Zoltán71830222019-03-08 23:34:15 +0100224 Audiodev *dev;
bellardc0fe3822005-11-05 18:55:28 +0000225 void *drv_opaque;
226
227 QEMUTimer *ts;
Blue Swirl72cf2d42009-09-12 07:36:22 +0000228 QLIST_HEAD (card_listhead, QEMUSoundCard) card_head;
229 QLIST_HEAD (hw_in_listhead, HWVoiceIn) hw_head_in;
230 QLIST_HEAD (hw_out_listhead, HWVoiceOut) hw_head_out;
231 QLIST_HEAD (cap_listhead, CaptureVoiceOut) cap_head;
bellardc0fe3822005-11-05 18:55:28 +0000232 int nb_hw_voices_out;
233 int nb_hw_voices_in;
malc978dd632009-02-18 20:44:04 +0000234 int vm_running;
Kővágó, Zoltán71830222019-03-08 23:34:15 +0100235 int64_t period_ticks;
Kővágó, Zoltán526fb052019-08-19 01:06:46 +0200236
237 bool timer_running;
238 uint64_t timer_last;
Kővágó, Zoltánecd97e92019-08-19 01:06:47 +0200239
240 QTAILQ_ENTRY(AudioState) list;
Philippe Mathieu-Daudéfd5283f2019-01-11 15:08:53 +0100241} AudioState;
bellardc0fe3822005-11-05 18:55:28 +0000242
Michael Walle00e07672011-01-05 01:05:47 +0100243extern const struct mixeng_volume nominal_volume;
bellardc0fe3822005-11-05 18:55:28 +0000244
Kővágó, Zoltán71830222019-03-08 23:34:15 +0100245extern const char *audio_prio_list[];
246
Gerd Hoffmannd3893a32018-03-06 08:40:47 +0100247void audio_driver_register(audio_driver *drv);
248audio_driver *audio_driver_lookup(const char *name);
249
malc1ea879e2008-12-03 22:48:44 +0000250void audio_pcm_init_info (struct audio_pcm_info *info, struct audsettings *as);
bellard1d14ffa2005-10-30 18:58:22 +0000251void audio_pcm_info_clear_buf (struct audio_pcm_info *info, void *buf, int len);
bellardfb065182004-11-09 23:09:44 +0000252
bellardc0fe3822005-11-05 18:55:28 +0000253int audio_bug (const char *funcname, int cond);
254void *audio_calloc (const char *funcname, int nmemb, size_t size);
255
Kővágó, Zoltán18e2c172019-08-19 01:06:55 +0200256void audio_run(AudioState *s, const char *msg);
malc713a98f2009-09-12 02:28:45 +0400257
Volker Rümelin37a54d02021-05-17 21:46:03 +0200258const char *audio_application_name(void);
259
Kővágó, Zoltán857271a2019-09-19 23:24:21 +0200260typedef struct RateCtl {
261 int64_t start_ticks;
262 int64_t bytes_sent;
263} RateCtl;
264
265void audio_rate_start(RateCtl *rate);
266size_t audio_rate_get_bytes(struct audio_pcm_info *info, RateCtl *rate,
267 size_t bytes_avail);
268
Kővágó, Zoltán75204622019-08-19 01:06:58 +0200269static inline size_t audio_ring_dist(size_t dst, size_t src, size_t len)
bellard1d14ffa2005-10-30 18:58:22 +0000270{
271 return (dst >= src) ? (dst - src) : (len - src + dst);
272}
273
Volker Rümelin18404ff2022-03-01 20:12:57 +0100274/**
275 * audio_ring_posb() - returns new position in ringbuffer in backward
276 * direction at given distance
277 *
278 * @pos: current position in ringbuffer
279 * @dist: distance in ringbuffer to walk in reverse direction
280 * @len: size of ringbuffer
281 */
282static inline size_t audio_ring_posb(size_t pos, size_t dist, size_t len)
283{
284 return pos >= dist ? pos - dist : len - dist + pos;
285}
286
Stefan Weil87e613e2013-06-16 11:19:31 +0200287#define dolog(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
bellard1d14ffa2005-10-30 18:58:22 +0000288
289#ifdef DEBUG
Stefan Weil87e613e2013-06-16 11:19:31 +0200290#define ldebug(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
bellard1d14ffa2005-10-30 18:58:22 +0000291#else
Stefan Weil87e613e2013-06-16 11:19:31 +0200292#define ldebug(fmt, ...) (void)0
bellard1d14ffa2005-10-30 18:58:22 +0000293#endif
bellard1d14ffa2005-10-30 18:58:22 +0000294
295#define AUDIO_STRINGIFY_(n) #n
296#define AUDIO_STRINGIFY(n) AUDIO_STRINGIFY_(n)
297
Kővágó, Zoltán71830222019-03-08 23:34:15 +0100298typedef struct AudiodevListEntry {
299 Audiodev *dev;
300 QSIMPLEQ_ENTRY(AudiodevListEntry) next;
301} AudiodevListEntry;
302
303typedef QSIMPLEQ_HEAD(, AudiodevListEntry) AudiodevListHead;
304AudiodevListHead audio_handle_legacy_opts(void);
305
306void audio_free_audiodev_list(AudiodevListHead *head);
307
308void audio_create_pdos(Audiodev *dev);
309AudiodevPerDirectionOptions *audio_get_pdo_in(Audiodev *dev);
310AudiodevPerDirectionOptions *audio_get_pdo_out(Audiodev *dev);
311
Markus Armbruster175de522016-06-29 15:29:06 +0200312#endif /* QEMU_AUDIO_INT_H */