]> git.ipfire.org Git - thirdparty/qemu.git/blob - audio/audio_int.h
spiceaudio: port to the new audio backend api
[thirdparty/qemu.git] / audio / audio_int.h
1 /*
2 * QEMU Audio subsystem header
3 *
4 * Copyright (c) 2003-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 #ifndef QEMU_AUDIO_INT_H
26 #define QEMU_AUDIO_INT_H
27
28 #ifdef CONFIG_AUDIO_COREAUDIO
29 #define FLOAT_MIXENG
30 /* #define RECIPROCAL */
31 #endif
32 #include "mixeng.h"
33
34 struct audio_pcm_ops;
35
36 struct audio_callback {
37 void *opaque;
38 audio_callback_fn fn;
39 };
40
41 struct audio_pcm_info {
42 int bits;
43 int sign;
44 int freq;
45 int nchannels;
46 int align;
47 int shift;
48 int bytes_per_second;
49 int swap_endianness;
50 };
51
52 typedef struct AudioState AudioState;
53 typedef struct SWVoiceCap SWVoiceCap;
54
55 typedef struct HWVoiceOut {
56 AudioState *s;
57 int enabled;
58 int poll_mode;
59 int pending_disable;
60 struct audio_pcm_info info;
61
62 f_sample *clip;
63
64 size_t rpos;
65 uint64_t ts_helper;
66
67 struct st_sample *mix_buf;
68 void *buf_emul;
69 size_t pos_emul, pending_emul, size_emul;
70
71 size_t samples;
72 QLIST_HEAD (sw_out_listhead, SWVoiceOut) sw_head;
73 QLIST_HEAD (sw_cap_listhead, SWVoiceCap) cap_head;
74 int ctl_caps;
75 struct audio_pcm_ops *pcm_ops;
76 QLIST_ENTRY (HWVoiceOut) entries;
77 } HWVoiceOut;
78
79 typedef struct HWVoiceIn {
80 AudioState *s;
81 int enabled;
82 int poll_mode;
83 struct audio_pcm_info info;
84
85 t_sample *conv;
86
87 size_t wpos;
88 size_t total_samples_captured;
89 uint64_t ts_helper;
90
91 struct st_sample *conv_buf;
92 void *buf_emul;
93 size_t pos_emul, pending_emul, size_emul;
94
95 size_t samples;
96 QLIST_HEAD (sw_in_listhead, SWVoiceIn) sw_head;
97 int ctl_caps;
98 struct audio_pcm_ops *pcm_ops;
99 QLIST_ENTRY (HWVoiceIn) entries;
100 } HWVoiceIn;
101
102 struct SWVoiceOut {
103 QEMUSoundCard *card;
104 AudioState *s;
105 struct audio_pcm_info info;
106 t_sample *conv;
107 int64_t ratio;
108 struct st_sample *buf;
109 void *rate;
110 size_t total_hw_samples_mixed;
111 int active;
112 int empty;
113 HWVoiceOut *hw;
114 char *name;
115 struct mixeng_volume vol;
116 struct audio_callback callback;
117 QLIST_ENTRY (SWVoiceOut) entries;
118 };
119
120 struct SWVoiceIn {
121 QEMUSoundCard *card;
122 AudioState *s;
123 int active;
124 struct audio_pcm_info info;
125 int64_t ratio;
126 void *rate;
127 size_t total_hw_samples_acquired;
128 struct st_sample *buf;
129 f_sample *clip;
130 HWVoiceIn *hw;
131 char *name;
132 struct mixeng_volume vol;
133 struct audio_callback callback;
134 QLIST_ENTRY (SWVoiceIn) entries;
135 };
136
137 typedef struct audio_driver audio_driver;
138 struct audio_driver {
139 const char *name;
140 const char *descr;
141 void *(*init) (Audiodev *);
142 void (*fini) (void *);
143 struct audio_pcm_ops *pcm_ops;
144 int can_be_default;
145 int max_voices_out;
146 int max_voices_in;
147 int voice_size_out;
148 int voice_size_in;
149 int ctl_caps;
150 QLIST_ENTRY(audio_driver) next;
151 };
152
153 struct audio_pcm_ops {
154 int (*init_out)(HWVoiceOut *hw, audsettings *as, void *drv_opaque);
155 void (*fini_out)(HWVoiceOut *hw);
156 size_t (*run_out)(HWVoiceOut *hw, size_t live);
157 size_t (*write) (HWVoiceOut *hw, void *buf, size_t size);
158 /*
159 * get a buffer that after later can be passed to put_buffer_out; optional
160 * returns the buffer, and writes it's size to size (in bytes)
161 * this is unrelated to the above buffer_size_out function
162 */
163 void *(*get_buffer_out)(HWVoiceOut *hw, size_t *size);
164 /*
165 * put back the buffer returned by get_buffer_out; optional
166 * buf must be equal the pointer returned by get_buffer_out,
167 * size may be smaller
168 */
169 size_t (*put_buffer_out)(HWVoiceOut *hw, void *buf, size_t size);
170 int (*ctl_out) (HWVoiceOut *hw, int cmd, ...);
171
172 int (*init_in) (HWVoiceIn *hw, audsettings *as, void *drv_opaque);
173 void (*fini_in) (HWVoiceIn *hw);
174 size_t (*run_in)(HWVoiceIn *hw);
175 size_t (*read) (HWVoiceIn *hw, void *buf, size_t size);
176 void *(*get_buffer_in)(HWVoiceIn *hw, size_t *size);
177 void (*put_buffer_in)(HWVoiceIn *hw, void *buf, size_t size);
178 int (*ctl_in) (HWVoiceIn *hw, int cmd, ...);
179 };
180
181 void *audio_generic_get_buffer_in(HWVoiceIn *hw, size_t *size);
182 void audio_generic_put_buffer_in(HWVoiceIn *hw, void *buf, size_t size);
183 void *audio_generic_get_buffer_out(HWVoiceOut *hw, size_t *size);
184 size_t audio_generic_put_buffer_out(HWVoiceOut *hw, void *buf, size_t size);
185 size_t audio_generic_put_buffer_out_nowrite(HWVoiceOut *hw, void *buf,
186 size_t size);
187 size_t audio_generic_write(HWVoiceOut *hw, void *buf, size_t size);
188 size_t audio_generic_read(HWVoiceIn *hw, void *buf, size_t size);
189
190 struct capture_callback {
191 struct audio_capture_ops ops;
192 void *opaque;
193 QLIST_ENTRY (capture_callback) entries;
194 };
195
196 struct CaptureVoiceOut {
197 HWVoiceOut hw;
198 void *buf;
199 QLIST_HEAD (cb_listhead, capture_callback) cb_head;
200 QLIST_ENTRY (CaptureVoiceOut) entries;
201 };
202
203 struct SWVoiceCap {
204 SWVoiceOut sw;
205 CaptureVoiceOut *cap;
206 QLIST_ENTRY (SWVoiceCap) entries;
207 };
208
209 typedef struct AudioState {
210 struct audio_driver *drv;
211 Audiodev *dev;
212 void *drv_opaque;
213
214 QEMUTimer *ts;
215 QLIST_HEAD (card_listhead, QEMUSoundCard) card_head;
216 QLIST_HEAD (hw_in_listhead, HWVoiceIn) hw_head_in;
217 QLIST_HEAD (hw_out_listhead, HWVoiceOut) hw_head_out;
218 QLIST_HEAD (cap_listhead, CaptureVoiceOut) cap_head;
219 int nb_hw_voices_out;
220 int nb_hw_voices_in;
221 int vm_running;
222 int64_t period_ticks;
223
224 bool timer_running;
225 uint64_t timer_last;
226
227 QTAILQ_ENTRY(AudioState) list;
228 } AudioState;
229
230 extern const struct mixeng_volume nominal_volume;
231
232 extern const char *audio_prio_list[];
233
234 void audio_driver_register(audio_driver *drv);
235 audio_driver *audio_driver_lookup(const char *name);
236
237 void audio_pcm_init_info (struct audio_pcm_info *info, struct audsettings *as);
238 void audio_pcm_info_clear_buf (struct audio_pcm_info *info, void *buf, int len);
239
240 size_t audio_pcm_hw_get_live_in(HWVoiceIn *hw);
241
242 size_t audio_pcm_hw_clip_out(HWVoiceOut *hw, void *pcm_buf,
243 size_t live, size_t pending);
244
245 int audio_bug (const char *funcname, int cond);
246 void *audio_calloc (const char *funcname, int nmemb, size_t size);
247
248 void audio_run(AudioState *s, const char *msg);
249
250 #define VOICE_ENABLE 1
251 #define VOICE_DISABLE 2
252 #define VOICE_VOLUME 3
253
254 #define VOICE_VOLUME_CAP (1 << VOICE_VOLUME)
255
256 static inline size_t audio_ring_dist(size_t dst, size_t src, size_t len)
257 {
258 return (dst >= src) ? (dst - src) : (len - src + dst);
259 }
260
261 #define dolog(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
262
263 #ifdef DEBUG
264 #define ldebug(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
265 #else
266 #define ldebug(fmt, ...) (void)0
267 #endif
268
269 #define AUDIO_STRINGIFY_(n) #n
270 #define AUDIO_STRINGIFY(n) AUDIO_STRINGIFY_(n)
271
272 typedef struct AudiodevListEntry {
273 Audiodev *dev;
274 QSIMPLEQ_ENTRY(AudiodevListEntry) next;
275 } AudiodevListEntry;
276
277 typedef QSIMPLEQ_HEAD(, AudiodevListEntry) AudiodevListHead;
278 AudiodevListHead audio_handle_legacy_opts(void);
279
280 void audio_free_audiodev_list(AudiodevListHead *head);
281
282 void audio_create_pdos(Audiodev *dev);
283 AudiodevPerDirectionOptions *audio_get_pdo_in(Audiodev *dev);
284 AudiodevPerDirectionOptions *audio_get_pdo_out(Audiodev *dev);
285
286 #endif /* QEMU_AUDIO_INT_H */