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