monitor: Reorder info documentation
[qemu/kraxel.git] / audio / audio.h
blob454ade260e583d1cec09d89a6e3320ab4392ad07
1 /*
2 * QEMU Audio subsystem header
4 * Copyright (c) 2003-2005 Vassili Karpov (malc)
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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.
24 #ifndef QEMU_AUDIO_H
25 #define QEMU_AUDIO_H
27 #include "config-host.h"
28 #include "qemu-queue.h"
30 typedef void (*audio_callback_fn) (void *opaque, int avail);
32 typedef enum {
33 AUD_FMT_U8,
34 AUD_FMT_S8,
35 AUD_FMT_U16,
36 AUD_FMT_S16,
37 AUD_FMT_U32,
38 AUD_FMT_S32
39 } audfmt_e;
41 #ifdef HOST_WORDS_BIGENDIAN
42 #define AUDIO_HOST_ENDIANNESS 1
43 #else
44 #define AUDIO_HOST_ENDIANNESS 0
45 #endif
47 struct audsettings {
48 int freq;
49 int nchannels;
50 audfmt_e fmt;
51 int endianness;
54 typedef enum {
55 AUD_CNOTIFY_ENABLE,
56 AUD_CNOTIFY_DISABLE
57 } audcnotification_e;
59 struct audio_capture_ops {
60 void (*notify) (void *opaque, audcnotification_e cmd);
61 void (*capture) (void *opaque, void *buf, int size);
62 void (*destroy) (void *opaque);
65 struct capture_ops {
66 void (*info) (void *opaque);
67 void (*destroy) (void *opaque);
70 typedef struct CaptureState {
71 void *opaque;
72 struct capture_ops ops;
73 QLIST_ENTRY (CaptureState) entries;
74 } CaptureState;
76 typedef struct SWVoiceOut SWVoiceOut;
77 typedef struct CaptureVoiceOut CaptureVoiceOut;
78 typedef struct SWVoiceIn SWVoiceIn;
80 typedef struct QEMUSoundCard {
81 char *name;
82 QLIST_ENTRY (QEMUSoundCard) entries;
83 } QEMUSoundCard;
85 typedef struct QEMUAudioTimeStamp {
86 uint64_t old_ts;
87 } QEMUAudioTimeStamp;
89 void AUD_vlog (const char *cap, const char *fmt, va_list ap);
90 void AUD_log (const char *cap, const char *fmt, ...)
91 #ifdef __GNUC__
92 __attribute__ ((__format__ (__printf__, 2, 3)))
93 #endif
96 void AUD_help (void);
97 void AUD_register_card (const char *name, QEMUSoundCard *card);
98 void AUD_remove_card (QEMUSoundCard *card);
99 CaptureVoiceOut *AUD_add_capture (
100 struct audsettings *as,
101 struct audio_capture_ops *ops,
102 void *opaque
104 void AUD_del_capture (CaptureVoiceOut *cap, void *cb_opaque);
106 SWVoiceOut *AUD_open_out (
107 QEMUSoundCard *card,
108 SWVoiceOut *sw,
109 const char *name,
110 void *callback_opaque,
111 audio_callback_fn callback_fn,
112 struct audsettings *settings
115 void AUD_close_out (QEMUSoundCard *card, SWVoiceOut *sw);
116 int AUD_write (SWVoiceOut *sw, void *pcm_buf, int size);
117 int AUD_get_buffer_size_out (SWVoiceOut *sw);
118 void AUD_set_active_out (SWVoiceOut *sw, int on);
119 int AUD_is_active_out (SWVoiceOut *sw);
121 void AUD_init_time_stamp_out (SWVoiceOut *sw, QEMUAudioTimeStamp *ts);
122 uint64_t AUD_get_elapsed_usec_out (SWVoiceOut *sw, QEMUAudioTimeStamp *ts);
124 void AUD_set_volume_out (SWVoiceOut *sw, int mute, uint8_t lvol, uint8_t rvol);
125 void AUD_set_volume_in (SWVoiceIn *sw, int mute, uint8_t lvol, uint8_t rvol);
127 SWVoiceIn *AUD_open_in (
128 QEMUSoundCard *card,
129 SWVoiceIn *sw,
130 const char *name,
131 void *callback_opaque,
132 audio_callback_fn callback_fn,
133 struct audsettings *settings
136 void AUD_close_in (QEMUSoundCard *card, SWVoiceIn *sw);
137 int AUD_read (SWVoiceIn *sw, void *pcm_buf, int size);
138 void AUD_set_active_in (SWVoiceIn *sw, int on);
139 int AUD_is_active_in (SWVoiceIn *sw);
141 void AUD_init_time_stamp_in (SWVoiceIn *sw, QEMUAudioTimeStamp *ts);
142 uint64_t AUD_get_elapsed_usec_in (SWVoiceIn *sw, QEMUAudioTimeStamp *ts);
144 static inline void *advance (void *p, int incr)
146 uint8_t *d = p;
147 return (d + incr);
150 #ifdef __GNUC__
151 #define audio_MIN(a, b) ( __extension__ ({ \
152 __typeof (a) ta = a; \
153 __typeof (b) tb = b; \
154 ((ta)>(tb)?(tb):(ta)); \
157 #define audio_MAX(a, b) ( __extension__ ({ \
158 __typeof (a) ta = a; \
159 __typeof (b) tb = b; \
160 ((ta)<(tb)?(tb):(ta)); \
162 #else
163 #define audio_MIN(a, b) ((a)>(b)?(b):(a))
164 #define audio_MAX(a, b) ((a)<(b)?(b):(a))
165 #endif
167 int wav_start_capture (CaptureState *s, const char *path, int freq,
168 int bits, int nchannels);
170 #endif /* audio.h */