xref: /openbmc/qemu/audio/audio.h (revision b097ba37)
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_H
26 #define QEMU_AUDIO_H
27 
28 #include "qemu/queue.h"
29 #include "qapi/qapi-types-audio.h"
30 
31 typedef void (*audio_callback_fn) (void *opaque, int avail);
32 
33 #ifdef HOST_WORDS_BIGENDIAN
34 #define AUDIO_HOST_ENDIANNESS 1
35 #else
36 #define AUDIO_HOST_ENDIANNESS 0
37 #endif
38 
39 typedef struct audsettings {
40     int freq;
41     int nchannels;
42     AudioFormat fmt;
43     int endianness;
44 } audsettings;
45 
46 audsettings audiodev_to_audsettings(AudiodevPerDirectionOptions *pdo);
47 int audioformat_bytes_per_sample(AudioFormat fmt);
48 int audio_buffer_frames(AudiodevPerDirectionOptions *pdo,
49                         audsettings *as, int def_usecs);
50 int audio_buffer_samples(AudiodevPerDirectionOptions *pdo,
51                          audsettings *as, int def_usecs);
52 int audio_buffer_bytes(AudiodevPerDirectionOptions *pdo,
53                        audsettings *as, int def_usecs);
54 
55 typedef enum {
56     AUD_CNOTIFY_ENABLE,
57     AUD_CNOTIFY_DISABLE
58 } audcnotification_e;
59 
60 struct audio_capture_ops {
61     void (*notify) (void *opaque, audcnotification_e cmd);
62     void (*capture) (void *opaque, void *buf, int size);
63     void (*destroy) (void *opaque);
64 };
65 
66 struct capture_ops {
67     void (*info) (void *opaque);
68     void (*destroy) (void *opaque);
69 };
70 
71 typedef struct CaptureState {
72     void *opaque;
73     struct capture_ops ops;
74     QLIST_ENTRY (CaptureState) entries;
75 } CaptureState;
76 
77 typedef struct SWVoiceOut SWVoiceOut;
78 typedef struct CaptureVoiceOut CaptureVoiceOut;
79 typedef struct SWVoiceIn SWVoiceIn;
80 
81 typedef struct QEMUSoundCard {
82     char *name;
83     QLIST_ENTRY (QEMUSoundCard) entries;
84 } QEMUSoundCard;
85 
86 typedef struct QEMUAudioTimeStamp {
87     uint64_t old_ts;
88 } QEMUAudioTimeStamp;
89 
90 void AUD_vlog (const char *cap, const char *fmt, va_list ap) GCC_FMT_ATTR(2, 0);
91 void AUD_log (const char *cap, const char *fmt, ...) GCC_FMT_ATTR(2, 3);
92 
93 void AUD_register_card (const char *name, QEMUSoundCard *card);
94 void AUD_remove_card (QEMUSoundCard *card);
95 CaptureVoiceOut *AUD_add_capture (
96     struct audsettings *as,
97     struct audio_capture_ops *ops,
98     void *opaque
99     );
100 void AUD_del_capture (CaptureVoiceOut *cap, void *cb_opaque);
101 
102 SWVoiceOut *AUD_open_out (
103     QEMUSoundCard *card,
104     SWVoiceOut *sw,
105     const char *name,
106     void *callback_opaque,
107     audio_callback_fn callback_fn,
108     struct audsettings *settings
109     );
110 
111 void AUD_close_out (QEMUSoundCard *card, SWVoiceOut *sw);
112 int  AUD_write (SWVoiceOut *sw, void *pcm_buf, int size);
113 int  AUD_get_buffer_size_out (SWVoiceOut *sw);
114 void AUD_set_active_out (SWVoiceOut *sw, int on);
115 int  AUD_is_active_out (SWVoiceOut *sw);
116 
117 void     AUD_init_time_stamp_out (SWVoiceOut *sw, QEMUAudioTimeStamp *ts);
118 uint64_t AUD_get_elapsed_usec_out (SWVoiceOut *sw, QEMUAudioTimeStamp *ts);
119 
120 void AUD_set_volume_out (SWVoiceOut *sw, int mute, uint8_t lvol, uint8_t rvol);
121 void AUD_set_volume_in (SWVoiceIn *sw, int mute, uint8_t lvol, uint8_t rvol);
122 
123 SWVoiceIn *AUD_open_in (
124     QEMUSoundCard *card,
125     SWVoiceIn *sw,
126     const char *name,
127     void *callback_opaque,
128     audio_callback_fn callback_fn,
129     struct audsettings *settings
130     );
131 
132 void AUD_close_in (QEMUSoundCard *card, SWVoiceIn *sw);
133 int  AUD_read (SWVoiceIn *sw, void *pcm_buf, int size);
134 void AUD_set_active_in (SWVoiceIn *sw, int on);
135 int  AUD_is_active_in (SWVoiceIn *sw);
136 
137 void     AUD_init_time_stamp_in (SWVoiceIn *sw, QEMUAudioTimeStamp *ts);
138 uint64_t AUD_get_elapsed_usec_in (SWVoiceIn *sw, QEMUAudioTimeStamp *ts);
139 
140 static inline void *advance (void *p, int incr)
141 {
142     uint8_t *d = p;
143     return (d + incr);
144 }
145 
146 #ifdef __GNUC__
147 #define audio_MIN(a, b) ( __extension__ ({      \
148     __typeof (a) ta = a;                        \
149     __typeof (b) tb = b;                        \
150     ((ta)>(tb)?(tb):(ta));                      \
151 }))
152 
153 #define audio_MAX(a, b) ( __extension__ ({      \
154     __typeof (a) ta = a;                        \
155     __typeof (b) tb = b;                        \
156     ((ta)<(tb)?(tb):(ta));                      \
157 }))
158 #else
159 #define audio_MIN(a, b) ((a)>(b)?(b):(a))
160 #define audio_MAX(a, b) ((a)<(b)?(b):(a))
161 #endif
162 
163 int wav_start_capture (CaptureState *s, const char *path, int freq,
164                        int bits, int nchannels);
165 
166 bool audio_is_cleaning_up(void);
167 void audio_cleanup(void);
168 
169 void audio_sample_to_uint64(void *samples, int pos,
170                             uint64_t *left, uint64_t *right);
171 void audio_sample_from_uint64(void *samples, int pos,
172                             uint64_t left, uint64_t right);
173 
174 void audio_parse_option(const char *opt);
175 void audio_init_audiodevs(void);
176 void audio_legacy_help(void);
177 
178 #endif /* QEMU_AUDIO_H */
179