xref: /openbmc/qemu/audio/audio_int.h (revision 2038f8c8)
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 
69     size_t samples;
70     QLIST_HEAD (sw_out_listhead, SWVoiceOut) sw_head;
71     QLIST_HEAD (sw_cap_listhead, SWVoiceCap) cap_head;
72     int ctl_caps;
73     struct audio_pcm_ops *pcm_ops;
74     QLIST_ENTRY (HWVoiceOut) entries;
75 } HWVoiceOut;
76 
77 typedef struct HWVoiceIn {
78     AudioState *s;
79     int enabled;
80     int poll_mode;
81     struct audio_pcm_info info;
82 
83     t_sample *conv;
84 
85     size_t wpos;
86     size_t total_samples_captured;
87     uint64_t ts_helper;
88 
89     struct st_sample *conv_buf;
90 
91     size_t samples;
92     QLIST_HEAD (sw_in_listhead, SWVoiceIn) sw_head;
93     int ctl_caps;
94     struct audio_pcm_ops *pcm_ops;
95     QLIST_ENTRY (HWVoiceIn) entries;
96 } HWVoiceIn;
97 
98 struct SWVoiceOut {
99     QEMUSoundCard *card;
100     AudioState *s;
101     struct audio_pcm_info info;
102     t_sample *conv;
103     int64_t ratio;
104     struct st_sample *buf;
105     void *rate;
106     size_t total_hw_samples_mixed;
107     int active;
108     int empty;
109     HWVoiceOut *hw;
110     char *name;
111     struct mixeng_volume vol;
112     struct audio_callback callback;
113     QLIST_ENTRY (SWVoiceOut) entries;
114 };
115 
116 struct SWVoiceIn {
117     QEMUSoundCard *card;
118     AudioState *s;
119     int active;
120     struct audio_pcm_info info;
121     int64_t ratio;
122     void *rate;
123     size_t total_hw_samples_acquired;
124     struct st_sample *buf;
125     f_sample *clip;
126     HWVoiceIn *hw;
127     char *name;
128     struct mixeng_volume vol;
129     struct audio_callback callback;
130     QLIST_ENTRY (SWVoiceIn) entries;
131 };
132 
133 typedef struct audio_driver audio_driver;
134 struct audio_driver {
135     const char *name;
136     const char *descr;
137     void *(*init) (Audiodev *);
138     void (*fini) (void *);
139     struct audio_pcm_ops *pcm_ops;
140     int can_be_default;
141     int max_voices_out;
142     int max_voices_in;
143     int voice_size_out;
144     int voice_size_in;
145     int ctl_caps;
146     QLIST_ENTRY(audio_driver) next;
147 };
148 
149 struct audio_pcm_ops {
150     int  (*init_out)(HWVoiceOut *hw, struct audsettings *as, void *drv_opaque);
151     void (*fini_out)(HWVoiceOut *hw);
152     size_t (*run_out)(HWVoiceOut *hw, size_t live);
153     int  (*ctl_out) (HWVoiceOut *hw, int cmd, ...);
154 
155     int  (*init_in) (HWVoiceIn *hw, struct audsettings *as, void *drv_opaque);
156     void (*fini_in) (HWVoiceIn *hw);
157     size_t (*run_in)(HWVoiceIn *hw);
158     int  (*ctl_in)  (HWVoiceIn *hw, int cmd, ...);
159 };
160 
161 struct capture_callback {
162     struct audio_capture_ops ops;
163     void *opaque;
164     QLIST_ENTRY (capture_callback) entries;
165 };
166 
167 struct CaptureVoiceOut {
168     HWVoiceOut hw;
169     void *buf;
170     QLIST_HEAD (cb_listhead, capture_callback) cb_head;
171     QLIST_ENTRY (CaptureVoiceOut) entries;
172 };
173 
174 struct SWVoiceCap {
175     SWVoiceOut sw;
176     CaptureVoiceOut *cap;
177     QLIST_ENTRY (SWVoiceCap) entries;
178 };
179 
180 typedef struct AudioState {
181     struct audio_driver *drv;
182     Audiodev *dev;
183     void *drv_opaque;
184 
185     QEMUTimer *ts;
186     QLIST_HEAD (card_listhead, QEMUSoundCard) card_head;
187     QLIST_HEAD (hw_in_listhead, HWVoiceIn) hw_head_in;
188     QLIST_HEAD (hw_out_listhead, HWVoiceOut) hw_head_out;
189     QLIST_HEAD (cap_listhead, CaptureVoiceOut) cap_head;
190     int nb_hw_voices_out;
191     int nb_hw_voices_in;
192     int vm_running;
193     int64_t period_ticks;
194 
195     bool timer_running;
196     uint64_t timer_last;
197 
198     QTAILQ_ENTRY(AudioState) list;
199 } AudioState;
200 
201 extern const struct mixeng_volume nominal_volume;
202 
203 extern const char *audio_prio_list[];
204 
205 void audio_driver_register(audio_driver *drv);
206 audio_driver *audio_driver_lookup(const char *name);
207 
208 void audio_pcm_init_info (struct audio_pcm_info *info, struct audsettings *as);
209 void audio_pcm_info_clear_buf (struct audio_pcm_info *info, void *buf, int len);
210 
211 size_t audio_pcm_hw_get_live_in(HWVoiceIn *hw);
212 
213 size_t audio_pcm_hw_clip_out(HWVoiceOut *hw, void *pcm_buf,
214                              size_t live, size_t pending);
215 
216 int audio_bug (const char *funcname, int cond);
217 void *audio_calloc (const char *funcname, int nmemb, size_t size);
218 
219 void audio_run(AudioState *s, const char *msg);
220 
221 #define VOICE_ENABLE 1
222 #define VOICE_DISABLE 2
223 #define VOICE_VOLUME 3
224 
225 #define VOICE_VOLUME_CAP (1 << VOICE_VOLUME)
226 
227 static inline size_t audio_ring_dist(size_t dst, size_t src, size_t len)
228 {
229     return (dst >= src) ? (dst - src) : (len - src + dst);
230 }
231 
232 #define dolog(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
233 
234 #ifdef DEBUG
235 #define ldebug(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
236 #else
237 #define ldebug(fmt, ...) (void)0
238 #endif
239 
240 #define AUDIO_STRINGIFY_(n) #n
241 #define AUDIO_STRINGIFY(n) AUDIO_STRINGIFY_(n)
242 
243 typedef struct AudiodevListEntry {
244     Audiodev *dev;
245     QSIMPLEQ_ENTRY(AudiodevListEntry) next;
246 } AudiodevListEntry;
247 
248 typedef QSIMPLEQ_HEAD(, AudiodevListEntry) AudiodevListHead;
249 AudiodevListHead audio_handle_legacy_opts(void);
250 
251 void audio_free_audiodev_list(AudiodevListHead *head);
252 
253 void audio_create_pdos(Audiodev *dev);
254 AudiodevPerDirectionOptions *audio_get_pdo_in(Audiodev *dev);
255 AudiodevPerDirectionOptions *audio_get_pdo_out(Audiodev *dev);
256 
257 #endif /* QEMU_AUDIO_INT_H */
258