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