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