2 * QEMU Audio subsystem header
4 * Copyright (c) 2003-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
25 #ifndef QEMU_AUDIO_INT_H
26 #define QEMU_AUDIO_INT_H
28 #ifdef CONFIG_AUDIO_COREAUDIO
30 /* #define RECIPROCAL */
40 struct audio_callback {
45 struct audio_pcm_info {
56 typedef struct AudioState AudioState;
57 typedef struct SWVoiceCap SWVoiceCap;
59 typedef struct STSampleBuffer {
64 typedef struct HWVoiceOut {
69 struct audio_pcm_info info;
74 STSampleBuffer mix_buf;
76 size_t pos_emul, pending_emul, size_emul;
79 QLIST_HEAD (sw_out_listhead, SWVoiceOut) sw_head;
80 QLIST_HEAD (sw_cap_listhead, SWVoiceCap) cap_head;
81 struct audio_pcm_ops *pcm_ops;
82 QLIST_ENTRY (HWVoiceOut) entries;
85 typedef struct HWVoiceIn {
89 struct audio_pcm_info info;
93 size_t total_samples_captured;
96 STSampleBuffer conv_buf;
98 size_t pos_emul, pending_emul, size_emul;
101 QLIST_HEAD (sw_in_listhead, SWVoiceIn) sw_head;
102 struct audio_pcm_ops *pcm_ops;
103 QLIST_ENTRY (HWVoiceIn) entries;
109 struct audio_pcm_info info;
111 STSampleBuffer resample_buf;
113 size_t total_hw_samples_mixed;
118 struct mixeng_volume vol;
119 struct audio_callback callback;
120 QLIST_ENTRY (SWVoiceOut) entries;
127 struct audio_pcm_info info;
129 size_t total_hw_samples_acquired;
130 STSampleBuffer resample_buf;
134 struct mixeng_volume vol;
135 struct audio_callback callback;
136 QLIST_ENTRY (SWVoiceIn) entries;
139 typedef struct audio_driver audio_driver;
140 struct audio_driver {
143 void *(*init) (Audiodev *, Error **);
144 void (*fini) (void *);
146 void (*set_dbus_server) (AudioState *s, GDBusObjectManagerServer *manager, bool p2p);
148 struct audio_pcm_ops *pcm_ops;
151 size_t voice_size_out;
152 size_t voice_size_in;
153 QLIST_ENTRY(audio_driver) next;
156 struct audio_pcm_ops {
157 int (*init_out)(HWVoiceOut *hw, audsettings *as, void *drv_opaque);
158 void (*fini_out)(HWVoiceOut *hw);
159 size_t (*write) (HWVoiceOut *hw, void *buf, size_t size);
160 void (*run_buffer_out)(HWVoiceOut *hw);
162 * Get the free output buffer size. This is an upper limit. The size
163 * returned by function get_buffer_out may be smaller.
165 size_t (*buffer_get_free)(HWVoiceOut *hw);
167 * get a buffer that after later can be passed to put_buffer_out; optional
168 * returns the buffer, and writes it's size to size (in bytes)
170 void *(*get_buffer_out)(HWVoiceOut *hw, size_t *size);
172 * put back the buffer returned by get_buffer_out; optional
173 * buf must be equal the pointer returned by get_buffer_out,
174 * size may be smaller
176 size_t (*put_buffer_out)(HWVoiceOut *hw, void *buf, size_t size);
177 void (*enable_out)(HWVoiceOut *hw, bool enable);
178 void (*volume_out)(HWVoiceOut *hw, Volume *vol);
180 int (*init_in) (HWVoiceIn *hw, audsettings *as, void *drv_opaque);
181 void (*fini_in) (HWVoiceIn *hw);
182 size_t (*read) (HWVoiceIn *hw, void *buf, size_t size);
183 void (*run_buffer_in)(HWVoiceIn *hw);
184 void *(*get_buffer_in)(HWVoiceIn *hw, size_t *size);
185 void (*put_buffer_in)(HWVoiceIn *hw, void *buf, size_t size);
186 void (*enable_in)(HWVoiceIn *hw, bool enable);
187 void (*volume_in)(HWVoiceIn *hw, Volume *vol);
190 void audio_generic_run_buffer_in(HWVoiceIn *hw);
191 void *audio_generic_get_buffer_in(HWVoiceIn *hw, size_t *size);
192 void audio_generic_put_buffer_in(HWVoiceIn *hw, void *buf, size_t size);
193 void audio_generic_run_buffer_out(HWVoiceOut *hw);
194 size_t audio_generic_buffer_get_free(HWVoiceOut *hw);
195 void *audio_generic_get_buffer_out(HWVoiceOut *hw, size_t *size);
196 size_t audio_generic_put_buffer_out(HWVoiceOut *hw, void *buf, size_t size);
197 size_t audio_generic_write(HWVoiceOut *hw, void *buf, size_t size);
198 size_t audio_generic_read(HWVoiceIn *hw, void *buf, size_t size);
200 struct capture_callback {
201 struct audio_capture_ops ops;
203 QLIST_ENTRY (capture_callback) entries;
206 struct CaptureVoiceOut {
209 QLIST_HEAD (cb_listhead, capture_callback) cb_head;
210 QLIST_ENTRY (CaptureVoiceOut) entries;
215 CaptureVoiceOut *cap;
216 QLIST_ENTRY (SWVoiceCap) entries;
219 typedef struct AudioState {
220 struct audio_driver *drv;
225 QLIST_HEAD (card_listhead, QEMUSoundCard) card_head;
226 QLIST_HEAD (hw_in_listhead, HWVoiceIn) hw_head_in;
227 QLIST_HEAD (hw_out_listhead, HWVoiceOut) hw_head_out;
228 QLIST_HEAD (cap_listhead, CaptureVoiceOut) cap_head;
229 int nb_hw_voices_out;
232 int64_t period_ticks;
237 QTAILQ_ENTRY(AudioState) list;
240 extern const struct mixeng_volume nominal_volume;
242 extern const char *audio_prio_list[];
244 void audio_driver_register(audio_driver *drv);
246 void audio_pcm_init_info (struct audio_pcm_info *info, struct audsettings *as);
247 void audio_pcm_info_clear_buf (struct audio_pcm_info *info, void *buf, int len);
249 int audio_bug (const char *funcname, int cond);
251 void audio_run(AudioState *s, const char *msg);
253 const char *audio_application_name(void);
255 typedef struct RateCtl {
260 void audio_rate_start(RateCtl *rate);
261 size_t audio_rate_peek_bytes(RateCtl *rate, struct audio_pcm_info *info);
262 void audio_rate_add_bytes(RateCtl *rate, size_t bytes_used);
263 size_t audio_rate_get_bytes(RateCtl *rate, struct audio_pcm_info *info,
266 static inline size_t audio_ring_dist(size_t dst, size_t src, size_t len)
268 return (dst >= src) ? (dst - src) : (len - src + dst);
272 * audio_ring_posb() - returns new position in ringbuffer in backward
273 * direction at given distance
275 * @pos: current position in ringbuffer
276 * @dist: distance in ringbuffer to walk in reverse direction
277 * @len: size of ringbuffer
279 static inline size_t audio_ring_posb(size_t pos, size_t dist, size_t len)
281 return pos >= dist ? pos - dist : len - dist + pos;
284 #define dolog(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
287 #define ldebug(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
289 #define ldebug(fmt, ...) (void)0
292 typedef struct AudiodevListEntry {
294 QSIMPLEQ_ENTRY(AudiodevListEntry) next;
297 typedef QSIMPLEQ_HEAD(, AudiodevListEntry) AudiodevListHead;
299 void audio_create_pdos(Audiodev *dev);
300 AudiodevPerDirectionOptions *audio_get_pdo_in(Audiodev *dev);
301 AudiodevPerDirectionOptions *audio_get_pdo_out(Audiodev *dev);
303 #endif /* QEMU_AUDIO_INT_H */