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