xref: /openbmc/qemu/audio/audio_int.h (revision 7f709ce7)
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_COREAUDIO
29 #define FLOAT_MIXENG
30 /* #define RECIPROCAL */
31 #endif
32 #include "mixeng.h"
33 
34 struct audio_pcm_ops;
35 
36 typedef enum {
37     AUD_OPT_INT,
38     AUD_OPT_FMT,
39     AUD_OPT_STR,
40     AUD_OPT_BOOL
41 } audio_option_tag_e;
42 
43 struct audio_option {
44     const char *name;
45     audio_option_tag_e tag;
46     void *valp;
47     const char *descr;
48     int *overriddenp;
49     int overridden;
50 };
51 
52 struct audio_callback {
53     void *opaque;
54     audio_callback_fn fn;
55 };
56 
57 struct audio_pcm_info {
58     int bits;
59     int sign;
60     int freq;
61     int nchannels;
62     int align;
63     int shift;
64     int bytes_per_second;
65     int swap_endianness;
66 };
67 
68 typedef struct SWVoiceCap SWVoiceCap;
69 
70 typedef struct HWVoiceOut {
71     int enabled;
72     int poll_mode;
73     int pending_disable;
74     struct audio_pcm_info info;
75 
76     f_sample *clip;
77 
78     int rpos;
79     uint64_t ts_helper;
80 
81     struct st_sample *mix_buf;
82 
83     int samples;
84     QLIST_HEAD (sw_out_listhead, SWVoiceOut) sw_head;
85     QLIST_HEAD (sw_cap_listhead, SWVoiceCap) cap_head;
86     int ctl_caps;
87     struct audio_pcm_ops *pcm_ops;
88     QLIST_ENTRY (HWVoiceOut) entries;
89 } HWVoiceOut;
90 
91 typedef struct HWVoiceIn {
92     int enabled;
93     int poll_mode;
94     struct audio_pcm_info info;
95 
96     t_sample *conv;
97 
98     int wpos;
99     int total_samples_captured;
100     uint64_t ts_helper;
101 
102     struct st_sample *conv_buf;
103 
104     int samples;
105     QLIST_HEAD (sw_in_listhead, SWVoiceIn) sw_head;
106     int ctl_caps;
107     struct audio_pcm_ops *pcm_ops;
108     QLIST_ENTRY (HWVoiceIn) entries;
109 } HWVoiceIn;
110 
111 struct SWVoiceOut {
112     QEMUSoundCard *card;
113     struct audio_pcm_info info;
114     t_sample *conv;
115     int64_t ratio;
116     struct st_sample *buf;
117     void *rate;
118     int total_hw_samples_mixed;
119     int active;
120     int empty;
121     HWVoiceOut *hw;
122     char *name;
123     struct mixeng_volume vol;
124     struct audio_callback callback;
125     QLIST_ENTRY (SWVoiceOut) entries;
126 };
127 
128 struct SWVoiceIn {
129     QEMUSoundCard *card;
130     int active;
131     struct audio_pcm_info info;
132     int64_t ratio;
133     void *rate;
134     int total_hw_samples_acquired;
135     struct st_sample *buf;
136     f_sample *clip;
137     HWVoiceIn *hw;
138     char *name;
139     struct mixeng_volume vol;
140     struct audio_callback callback;
141     QLIST_ENTRY (SWVoiceIn) entries;
142 };
143 
144 struct audio_driver {
145     const char *name;
146     const char *descr;
147     struct audio_option *options;
148     void *(*init) (void);
149     void (*fini) (void *);
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     int ctl_caps;
157 };
158 
159 struct audio_pcm_ops {
160     int  (*init_out)(HWVoiceOut *hw, struct audsettings *as, void *drv_opaque);
161     void (*fini_out)(HWVoiceOut *hw);
162     int  (*run_out) (HWVoiceOut *hw, int live);
163     int  (*write)   (SWVoiceOut *sw, void *buf, int size);
164     int  (*ctl_out) (HWVoiceOut *hw, int cmd, ...);
165 
166     int  (*init_in) (HWVoiceIn *hw, struct audsettings *as, void *drv_opaque);
167     void (*fini_in) (HWVoiceIn *hw);
168     int  (*run_in)  (HWVoiceIn *hw);
169     int  (*read)    (SWVoiceIn *sw, void *buf, int size);
170     int  (*ctl_in)  (HWVoiceIn *hw, int cmd, ...);
171 };
172 
173 struct capture_callback {
174     struct audio_capture_ops ops;
175     void *opaque;
176     QLIST_ENTRY (capture_callback) entries;
177 };
178 
179 struct CaptureVoiceOut {
180     HWVoiceOut hw;
181     void *buf;
182     QLIST_HEAD (cb_listhead, capture_callback) cb_head;
183     QLIST_ENTRY (CaptureVoiceOut) entries;
184 };
185 
186 struct SWVoiceCap {
187     SWVoiceOut sw;
188     CaptureVoiceOut *cap;
189     QLIST_ENTRY (SWVoiceCap) entries;
190 };
191 
192 struct AudioState {
193     struct audio_driver *drv;
194     void *drv_opaque;
195 
196     QEMUTimer *ts;
197     QLIST_HEAD (card_listhead, QEMUSoundCard) card_head;
198     QLIST_HEAD (hw_in_listhead, HWVoiceIn) hw_head_in;
199     QLIST_HEAD (hw_out_listhead, HWVoiceOut) hw_head_out;
200     QLIST_HEAD (cap_listhead, CaptureVoiceOut) cap_head;
201     int nb_hw_voices_out;
202     int nb_hw_voices_in;
203     int vm_running;
204 };
205 
206 extern struct audio_driver no_audio_driver;
207 extern struct audio_driver oss_audio_driver;
208 extern struct audio_driver sdl_audio_driver;
209 extern struct audio_driver wav_audio_driver;
210 extern struct audio_driver alsa_audio_driver;
211 extern struct audio_driver coreaudio_audio_driver;
212 extern struct audio_driver dsound_audio_driver;
213 extern struct audio_driver pa_audio_driver;
214 extern struct audio_driver spice_audio_driver;
215 extern const struct mixeng_volume nominal_volume;
216 
217 void audio_pcm_init_info (struct audio_pcm_info *info, struct audsettings *as);
218 void audio_pcm_info_clear_buf (struct audio_pcm_info *info, void *buf, int len);
219 
220 int  audio_pcm_sw_write (SWVoiceOut *sw, void *buf, int len);
221 int  audio_pcm_hw_get_live_in (HWVoiceIn *hw);
222 
223 int  audio_pcm_sw_read (SWVoiceIn *sw, void *buf, int len);
224 
225 int audio_pcm_hw_clip_out (HWVoiceOut *hw, void *pcm_buf,
226                            int live, int pending);
227 
228 int audio_bug (const char *funcname, int cond);
229 void *audio_calloc (const char *funcname, int nmemb, size_t size);
230 
231 void audio_run (const char *msg);
232 
233 #define VOICE_ENABLE 1
234 #define VOICE_DISABLE 2
235 #define VOICE_VOLUME 3
236 
237 #define VOICE_VOLUME_CAP (1 << VOICE_VOLUME)
238 
239 static inline int audio_ring_dist (int dst, int src, int len)
240 {
241     return (dst >= src) ? (dst - src) : (len - src + dst);
242 }
243 
244 #define dolog(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
245 
246 #ifdef DEBUG
247 #define ldebug(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
248 #else
249 #define ldebug(fmt, ...) (void)0
250 #endif
251 
252 #define AUDIO_STRINGIFY_(n) #n
253 #define AUDIO_STRINGIFY(n) AUDIO_STRINGIFY_(n)
254 
255 #if defined _MSC_VER || defined __GNUC__
256 #define AUDIO_FUNC __FUNCTION__
257 #else
258 #define AUDIO_FUNC __FILE__ ":" AUDIO_STRINGIFY (__LINE__)
259 #endif
260 
261 #endif /* QEMU_AUDIO_INT_H */
262