xref: /netbsd-src/lib/libossaudio/soundcard.h (revision 7fa608457b817eca6e0977b37f758ae064f3c99c)
1 /*	$NetBSD: soundcard.h,v 1.16 2007/09/18 22:57:31 mlelstv Exp $	*/
2 
3 /*-
4  * Copyright (c) 1997 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Lennart Augustsson.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * WARNING!  WARNING!
41  * This is an OSS (Linux) audio emulator.
42  * Use the Native NetBSD API for developing new code, and this
43  * only for compiling Linux programs.
44  */
45 
46 #ifndef _SOUNDCARD_H_
47 #define _SOUNDCARD_H_
48 
49 #define SOUND_VERSION	0x030001
50 
51 #define	SNDCTL_DSP_RESET		_IO  ('P', 0)
52 #define	SNDCTL_DSP_SYNC			_IO  ('P', 1)
53 #define	SNDCTL_DSP_SPEED		_IOWR('P', 2, int)
54 #define	SOUND_PCM_READ_RATE		_IOR ('P', 2, int)
55 #define	SNDCTL_DSP_STEREO		_IOWR('P', 3, int)
56 #define	SNDCTL_DSP_GETBLKSIZE		_IOWR('P', 4, int)
57 #define	SNDCTL_DSP_SETFMT		_IOWR('P', 5, int)
58 #define	 AFMT_QUERY			0x00000000
59 #define	 AFMT_MU_LAW			0x00000001
60 #define	 AFMT_A_LAW			0x00000002
61 #define	 AFMT_IMA_ADPCM			0x00000004
62 #define	 AFMT_U8			0x00000008
63 #define	 AFMT_S16_LE			0x00000010
64 #define	 AFMT_S16_BE			0x00000020
65 #define	 AFMT_S8			0x00000040
66 #define	 AFMT_U16_LE			0x00000080
67 #define	 AFMT_U16_BE			0x00000100
68 #define	 AFMT_MPEG			0x00000200
69 #define SNDCTL_DSP_SAMPLESIZE		SNDCTL_DSP_SETFMT
70 #define	SOUND_PCM_READ_BITS		_IOR ('P', 5, int)
71 #define	SNDCTL_DSP_CHANNELS		_IOWR('P', 6, int)
72 #define SOUND_PCM_WRITE_CHANNELS	SNDCTL_DSP_CHANNELS
73 #define	SOUND_PCM_READ_CHANNELS		_IOR ('P', 6, int)
74 #define SOUND_PCM_WRITE_FILTER		_IOWR('P', 7, int)
75 #define SOUND_PCM_READ_FILTER		_IOR ('P', 7, int)
76 #define	SNDCTL_DSP_POST			_IO  ('P', 8)
77 #define SNDCTL_DSP_SUBDIVIDE		_IOWR('P', 9, int)
78 #define	SNDCTL_DSP_SETFRAGMENT		_IOWR('P', 10, int)
79 #define	SNDCTL_DSP_GETFMTS		_IOR ('P', 11, int)
80 #define SNDCTL_DSP_GETOSPACE		_IOR ('P',12, struct audio_buf_info)
81 #define SNDCTL_DSP_GETISPACE		_IOR ('P',13, struct audio_buf_info)
82 #define SNDCTL_DSP_NONBLOCK		_IO  ('P',14)
83 #define SNDCTL_DSP_GETCAPS		_IOR ('P',15, int)
84 # define DSP_CAP_REVISION		0x000000ff
85 # define DSP_CAP_DUPLEX			0x00000100
86 # define DSP_CAP_REALTIME		0x00000200
87 # define DSP_CAP_BATCH			0x00000400
88 # define DSP_CAP_COPROC			0x00000800
89 # define DSP_CAP_TRIGGER		0x00001000
90 # define DSP_CAP_MMAP			0x00002000
91 #define SNDCTL_DSP_GETTRIGGER		_IOR ('P', 16, int)
92 #define SNDCTL_DSP_SETTRIGGER		_IOW ('P', 16, int)
93 # define PCM_ENABLE_INPUT		0x00000001
94 # define PCM_ENABLE_OUTPUT		0x00000002
95 #define SNDCTL_DSP_GETIPTR		_IOR ('P', 17, struct count_info)
96 #define SNDCTL_DSP_GETOPTR		_IOR ('P', 18, struct count_info)
97 #define SNDCTL_DSP_MAPINBUF		_IOR ('P', 19, struct buffmem_desc)
98 #define SNDCTL_DSP_MAPOUTBUF		_IOR ('P', 20, struct buffmem_desc)
99 #define SNDCTL_DSP_SETSYNCRO		_IO  ('P', 21)
100 #define SNDCTL_DSP_SETDUPLEX		_IO  ('P', 22)
101 #define SNDCTL_DSP_PROFILE		_IOW ('P', 23, int)
102 #define SNDCTL_DSP_GETODELAY		_IOR ('P', 23, int)
103 #define	  APF_NORMAL			0
104 #define	  APF_NETWORK			1
105 #define   APF_CPUINTENS			2
106 
107 /* Need native 16 bit format which depends on byte order */
108 #include <machine/endian_machdep.h>
109 #if _BYTE_ORDER == _LITTLE_ENDIAN
110 #define  AFMT_S16_NE AFMT_S16_LE
111 #else
112 #define  AFMT_S16_NE AFMT_S16_BE
113 #endif
114 
115 /* Aliases */
116 #define SOUND_PCM_WRITE_BITS		SNDCTL_DSP_SETFMT
117 #define SOUND_PCM_WRITE_RATE		SNDCTL_DSP_SPEED
118 #define SOUND_PCM_POST			SNDCTL_DSP_POST
119 #define SOUND_PCM_RESET			SNDCTL_DSP_RESET
120 #define SOUND_PCM_SYNC			SNDCTL_DSP_SYNC
121 #define SOUND_PCM_SUBDIVIDE		SNDCTL_DSP_SUBDIVIDE
122 #define SOUND_PCM_SETFRAGMENT		SNDCTL_DSP_SETFRAGMENT
123 #define SOUND_PCM_GETFMTS		SNDCTL_DSP_GETFMTS
124 #define SOUND_PCM_SETFMT		SNDCTL_DSP_SETFMT
125 #define SOUND_PCM_GETOSPACE		SNDCTL_DSP_GETOSPACE
126 #define SOUND_PCM_GETISPACE		SNDCTL_DSP_GETISPACE
127 #define SOUND_PCM_NONBLOCK		SNDCTL_DSP_NONBLOCK
128 #define SOUND_PCM_GETCAPS		SNDCTL_DSP_GETCAPS
129 #define SOUND_PCM_GETTRIGGER		SNDCTL_DSP_GETTRIGGER
130 #define SOUND_PCM_SETTRIGGER		SNDCTL_DSP_SETTRIGGER
131 #define SOUND_PCM_SETSYNCRO		SNDCTL_DSP_SETSYNCRO
132 #define SOUND_PCM_GETIPTR		SNDCTL_DSP_GETIPTR
133 #define SOUND_PCM_GETOPTR		SNDCTL_DSP_GETOPTR
134 #define SOUND_PCM_MAPINBUF		SNDCTL_DSP_MAPINBUF
135 #define SOUND_PCM_MAPOUTBUF		SNDCTL_DSP_MAPOUTBUF
136 
137 /* Mixer defines */
138 #define SOUND_MIXER_FIRST		0
139 #define SOUND_MIXER_NRDEVICES		25
140 
141 #define SOUND_MIXER_VOLUME		0
142 #define SOUND_MIXER_BASS		1
143 #define SOUND_MIXER_TREBLE		2
144 #define SOUND_MIXER_SYNTH		3
145 #define SOUND_MIXER_PCM			4
146 #define SOUND_MIXER_SPEAKER		5
147 #define SOUND_MIXER_LINE		6
148 #define SOUND_MIXER_MIC			7
149 #define SOUND_MIXER_CD			8
150 #define SOUND_MIXER_IMIX		9
151 #define SOUND_MIXER_ALTPCM		10
152 #define SOUND_MIXER_RECLEV		11
153 #define SOUND_MIXER_IGAIN		12
154 #define SOUND_MIXER_OGAIN		13
155 #define SOUND_MIXER_LINE1		14
156 #define SOUND_MIXER_LINE2		15
157 #define SOUND_MIXER_LINE3		16
158 #define SOUND_MIXER_DIGITAL1		17
159 #define SOUND_MIXER_DIGITAL2		18
160 #define SOUND_MIXER_DIGITAL3		19
161 #define SOUND_MIXER_PHONEIN		20
162 #define SOUND_MIXER_PHONEOUT		21
163 #define SOUND_MIXER_VIDEO		22
164 #define SOUND_MIXER_RADIO		23
165 #define SOUND_MIXER_MONITOR		24
166 
167 #define SOUND_ONOFF_MIN			28
168 #define SOUND_ONOFF_MAX			30
169 
170 #define SOUND_MIXER_NONE		31
171 
172 #define SOUND_DEVICE_LABELS	{"Vol  ", "Bass ", "Trebl", "Synth", "Pcm  ", "Spkr ", "Line ", \
173 				 "Mic  ", "CD   ", "Mix  ", "Pcm2 ", "Rec  ", "IGain", "OGain", \
174 				 "Line1", "Line2", "Line3", "Digital1", "Digital2", "Digital3", \
175 				 "PhoneIn", "PhoneOut", "Video", "Radio", "Monitor"}
176 
177 #define SOUND_DEVICE_NAMES	{"vol", "bass", "treble", "synth", "pcm", "speaker", "line", \
178 				 "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", \
179 				 "line1", "line2", "line3", "dig1", "dig2", "dig3", \
180 				 "phin", "phout", "video", "radio", "monitor"}
181 
182 #define SOUND_MIXER_RECSRC		0xff
183 #define SOUND_MIXER_DEVMASK		0xfe
184 #define SOUND_MIXER_RECMASK		0xfd
185 #define SOUND_MIXER_CAPS		0xfc
186 #define  SOUND_CAP_EXCL_INPUT		1
187 #define SOUND_MIXER_STEREODEVS		0xfb
188 
189 #define MIXER_READ(dev)			_IOR('M', dev, int)
190 
191 #define SOUND_MIXER_READ_RECSRC		MIXER_READ(SOUND_MIXER_RECSRC)
192 #define SOUND_MIXER_READ_DEVMASK	MIXER_READ(SOUND_MIXER_DEVMASK)
193 #define SOUND_MIXER_READ_RECMASK	MIXER_READ(SOUND_MIXER_RECMASK)
194 #define SOUND_MIXER_READ_STEREODEVS	MIXER_READ(SOUND_MIXER_STEREODEVS)
195 #define SOUND_MIXER_READ_CAPS		MIXER_READ(SOUND_MIXER_CAPS)
196 
197 #define SOUND_MIXER_READ_VOLUME		MIXER_READ(SOUND_MIXER_VOLUME)
198 #define SOUND_MIXER_READ_BASS		MIXER_READ(SOUND_MIXER_BASS)
199 #define SOUND_MIXER_READ_TREBLE		MIXER_READ(SOUND_MIXER_TREBLE)
200 #define SOUND_MIXER_READ_SYNTH		MIXER_READ(SOUND_MIXER_SYNTH)
201 #define SOUND_MIXER_READ_PCM		MIXER_READ(SOUND_MIXER_PCM)
202 #define SOUND_MIXER_READ_SPEAKER	MIXER_READ(SOUND_MIXER_SPEAKER)
203 #define SOUND_MIXER_READ_LINE		MIXER_READ(SOUND_MIXER_LINE)
204 #define SOUND_MIXER_READ_MIC		MIXER_READ(SOUND_MIXER_MIC)
205 #define SOUND_MIXER_READ_CD		MIXER_READ(SOUND_MIXER_CD)
206 #define SOUND_MIXER_READ_IMIX		MIXER_READ(SOUND_MIXER_IMIX)
207 #define SOUND_MIXER_READ_ALTPCM		MIXER_READ(SOUND_MIXER_ALTPCM)
208 #define SOUND_MIXER_READ_RECLEV		MIXER_READ(SOUND_MIXER_RECLEV)
209 #define SOUND_MIXER_READ_IGAIN		MIXER_READ(SOUND_MIXER_IGAIN)
210 #define SOUND_MIXER_READ_OGAIN		MIXER_READ(SOUND_MIXER_OGAIN)
211 #define SOUND_MIXER_READ_LINE1		MIXER_READ(SOUND_MIXER_LINE1)
212 #define SOUND_MIXER_READ_LINE2		MIXER_READ(SOUND_MIXER_LINE2)
213 #define SOUND_MIXER_READ_LINE3		MIXER_READ(SOUND_MIXER_LINE3)
214 
215 #define MIXER_WRITE(dev)		_IOW ('M', dev, int)
216 #define MIXER_WRITE_R(dev)		_IOWR('M', dev, int)
217 
218 #define SOUND_MIXER_WRITE_RECSRC	MIXER_WRITE(SOUND_MIXER_RECSRC)
219 #define SOUND_MIXER_WRITE_R_RECSRC	MIXER_WRITE_R(SOUND_MIXER_RECSRC)
220 
221 #define SOUND_MIXER_WRITE_VOLUME	MIXER_WRITE(SOUND_MIXER_VOLUME)
222 #define SOUND_MIXER_WRITE_BASS		MIXER_WRITE(SOUND_MIXER_BASS)
223 #define SOUND_MIXER_WRITE_TREBLE	MIXER_WRITE(SOUND_MIXER_TREBLE)
224 #define SOUND_MIXER_WRITE_SYNTH		MIXER_WRITE(SOUND_MIXER_SYNTH)
225 #define SOUND_MIXER_WRITE_PCM		MIXER_WRITE(SOUND_MIXER_PCM)
226 #define SOUND_MIXER_WRITE_SPEAKER	MIXER_WRITE(SOUND_MIXER_SPEAKER)
227 #define SOUND_MIXER_WRITE_LINE		MIXER_WRITE(SOUND_MIXER_LINE)
228 #define SOUND_MIXER_WRITE_MIC		MIXER_WRITE(SOUND_MIXER_MIC)
229 #define SOUND_MIXER_WRITE_CD		MIXER_WRITE(SOUND_MIXER_CD)
230 #define SOUND_MIXER_WRITE_IMIX		MIXER_WRITE(SOUND_MIXER_IMIX)
231 #define SOUND_MIXER_WRITE_ALTPCM	MIXER_WRITE(SOUND_MIXER_ALTPCM)
232 #define SOUND_MIXER_WRITE_RECLEV	MIXER_WRITE(SOUND_MIXER_RECLEV)
233 #define SOUND_MIXER_WRITE_IGAIN		MIXER_WRITE(SOUND_MIXER_IGAIN)
234 #define SOUND_MIXER_WRITE_OGAIN		MIXER_WRITE(SOUND_MIXER_OGAIN)
235 #define SOUND_MIXER_WRITE_LINE1		MIXER_WRITE(SOUND_MIXER_LINE1)
236 #define SOUND_MIXER_WRITE_LINE2		MIXER_WRITE(SOUND_MIXER_LINE2)
237 #define SOUND_MIXER_WRITE_LINE3		MIXER_WRITE(SOUND_MIXER_LINE3)
238 
239 #define SOUND_MASK_VOLUME	(1 << SOUND_MIXER_VOLUME)
240 #define SOUND_MASK_BASS		(1 << SOUND_MIXER_BASS)
241 #define SOUND_MASK_TREBLE	(1 << SOUND_MIXER_TREBLE)
242 #define SOUND_MASK_SYNTH	(1 << SOUND_MIXER_SYNTH)
243 #define SOUND_MASK_PCM		(1 << SOUND_MIXER_PCM)
244 #define SOUND_MASK_SPEAKER	(1 << SOUND_MIXER_SPEAKER)
245 #define SOUND_MASK_LINE		(1 << SOUND_MIXER_LINE)
246 #define SOUND_MASK_MIC		(1 << SOUND_MIXER_MIC)
247 #define SOUND_MASK_CD		(1 << SOUND_MIXER_CD)
248 #define SOUND_MASK_IMIX		(1 << SOUND_MIXER_IMIX)
249 #define SOUND_MASK_ALTPCM	(1 << SOUND_MIXER_ALTPCM)
250 #define SOUND_MASK_RECLEV	(1 << SOUND_MIXER_RECLEV)
251 #define SOUND_MASK_IGAIN	(1 << SOUND_MIXER_IGAIN)
252 #define SOUND_MASK_OGAIN	(1 << SOUND_MIXER_OGAIN)
253 #define SOUND_MASK_LINE1	(1 << SOUND_MIXER_LINE1)
254 #define SOUND_MASK_LINE2	(1 << SOUND_MIXER_LINE2)
255 #define SOUND_MASK_LINE3	(1 << SOUND_MIXER_LINE3)
256 #define SOUND_MASK_DIGITAL1	(1 << SOUND_MIXER_DIGITAL1)
257 #define SOUND_MASK_DIGITAL2	(1 << SOUND_MIXER_DIGITAL2)
258 #define SOUND_MASK_DIGITAL3	(1 << SOUND_MIXER_DIGITAL3)
259 #define SOUND_MASK_PHONEIN	(1 << SOUND_MIXER_PHONEIN)
260 #define SOUND_MASK_PHONEOUT	(1 << SOUND_MIXER_PHONEOUT)
261 #define SOUND_MASK_VIDEO	(1 << SOUND_MIXER_VIDEO)
262 #define SOUND_MASK_RADIO	(1 << SOUND_MIXER_RADIO)
263 #define SOUND_MASK_MONITOR	(1 << SOUND_MIXER_MONITOR)
264 
265 typedef struct mixer_info {
266 	char id[16];
267 	char name[32];
268 	int  modify_counter;
269 	int  fillers[10];
270 } mixer_info;
271 
272 typedef struct _old_mixer_info {
273 	char id[16];
274 	char name[32];
275 } _old_mixer_info;
276 
277 #define SOUND_MIXER_INFO		_IOR('M', 101, mixer_info)
278 #define SOUND_OLD_MIXER_INFO		_IOR('M', 101, _old_mixer_info)
279 
280 #define OSS_GETVERSION			_IOR ('M', 118, int)
281 
282 typedef struct audio_buf_info {
283 	int fragments;
284 	int fragstotal;
285 	int fragsize;
286 	int bytes;
287 } audio_buf_info;
288 
289 typedef struct count_info {
290 	int bytes;
291 	int blocks;
292 	int ptr;
293 } count_info;
294 
295 typedef struct buffmem_desc {
296 	unsigned int *buffer;
297 	int size;
298 } buffmem_desc;
299 
300 #if 0
301 /* This is what we'd like to have, but it causes prototype conflicts. */
302 #define ioctl _oss_ioctl
303 #else
304 /*
305  * XXX force inclusion of <sys/ioctl.h> before we redefine
306  * ioctl() to avoid a prototyoe conflict.
307  * Its multiple inclusion protection will keep this from
308  * happening if it is pulled in later.
309  */
310 #include <sys/ioctl.h>
311 #define ioctl(x,y,z) _oss_ioctl(x,y,z)
312 #endif
313 
314 #include <sys/cdefs.h>
315 
316 __BEGIN_DECLS
317 int _oss_ioctl(int fd, unsigned long com, void *argp);
318 __END_DECLS
319 
320 #endif /* !_SOUNDCARD_H_ */
321