xref: /netbsd-src/lib/libossaudio/soundcard.h (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1 /*	$NetBSD: soundcard.h,v 1.23 2014/05/17 12:38:42 nat 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  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * WARNING!  WARNING!
34  * This is an OSS (Linux) audio emulator.
35  * Use the Native NetBSD API for developing new code, and this
36  * only for compiling Linux programs.
37  */
38 
39 #ifndef _SOUNDCARD_H_
40 #define _SOUNDCARD_H_
41 
42 #ifndef SOUND_VERSION
43 #define SOUND_VERSION 0x030001
44 #endif
45 
46 #define	SNDCTL_DSP_RESET		_IO  ('P', 0)
47 #define	SNDCTL_DSP_SYNC			_IO  ('P', 1)
48 #define	SNDCTL_DSP_SPEED		_IOWR('P', 2, int)
49 #define	SOUND_PCM_READ_RATE		_IOR ('P', 2, int)
50 #define	SNDCTL_DSP_STEREO		_IOWR('P', 3, int)
51 #define	SNDCTL_DSP_GETBLKSIZE		_IOWR('P', 4, int)
52 #define	SNDCTL_DSP_SETFMT		_IOWR('P', 5, int)
53 #define	 AFMT_QUERY			0x00000000
54 #define	 AFMT_MU_LAW			0x00000001
55 #define	 AFMT_A_LAW			0x00000002
56 #define	 AFMT_IMA_ADPCM			0x00000004
57 #define	 AFMT_U8			0x00000008
58 #define	 AFMT_S16_LE			0x00000010
59 #define	 AFMT_S16_BE			0x00000020
60 #define	 AFMT_S8			0x00000040
61 #define	 AFMT_U16_LE			0x00000080
62 #define	 AFMT_U16_BE			0x00000100
63 #define	 AFMT_MPEG			0x00000200
64 #define	 AFMT_AC3			0x00000400
65 #define	 AFMT_S24_LE			0x00000800
66 #define	 AFMT_S24_BE			0x00001000
67 #define	 AFMT_S32_LE			0x00002000
68 #define	 AFMT_S32_BE			0x00004000
69 #define	 AFMT_S32_NE			0x00008000
70 #define SNDCTL_DSP_SAMPLESIZE		SNDCTL_DSP_SETFMT
71 #define	SOUND_PCM_READ_BITS		_IOR ('P', 5, int)
72 #define	SNDCTL_DSP_CHANNELS		_IOWR('P', 6, int)
73 #define SOUND_PCM_WRITE_CHANNELS	SNDCTL_DSP_CHANNELS
74 #define	SOUND_PCM_READ_CHANNELS		_IOR ('P', 6, int)
75 #define SOUND_PCM_WRITE_FILTER		_IOWR('P', 7, int)
76 #define SOUND_PCM_READ_FILTER		_IOR ('P', 7, int)
77 #define	SNDCTL_DSP_POST			_IO  ('P', 8)
78 #define SNDCTL_DSP_SUBDIVIDE		_IOWR('P', 9, int)
79 #define	SNDCTL_DSP_SETFRAGMENT		_IOWR('P', 10, int)
80 #define	SNDCTL_DSP_GETFMTS		_IOR ('P', 11, int)
81 #define SNDCTL_DSP_GETOSPACE		_IOR ('P',12, struct audio_buf_info)
82 #define SNDCTL_DSP_GETISPACE		_IOR ('P',13, struct audio_buf_info)
83 #define SNDCTL_DSP_NONBLOCK		_IO  ('P',14)
84 #define SNDCTL_DSP_GETCAPS		_IOR ('P',15, int)
85 # define DSP_CAP_REVISION		0x000000ff
86 # define DSP_CAP_DUPLEX			0x00000100
87 # define DSP_CAP_REALTIME		0x00000200
88 # define DSP_CAP_BATCH			0x00000400
89 # define DSP_CAP_COPROC			0x00000800
90 # define DSP_CAP_TRIGGER		0x00001000
91 # define DSP_CAP_MMAP			0x00002000
92 # define PCM_CAP_INPUT			0x00004000
93 # define PCM_CAP_OUTPUT			0x00008000
94 # define PCM_CAP_MODEM			0x00010000
95 # define PCM_CAP_HIDDEN			0x00020000
96 #define SNDCTL_DSP_GETTRIGGER		_IOR ('P', 16, int)
97 #define SNDCTL_DSP_SETTRIGGER		_IOW ('P', 16, int)
98 # define PCM_ENABLE_INPUT		0x00000001
99 # define PCM_ENABLE_OUTPUT		0x00000002
100 #define SNDCTL_DSP_GETIPTR		_IOR ('P', 17, struct count_info)
101 #define SNDCTL_DSP_GETOPTR		_IOR ('P', 18, struct count_info)
102 #define SNDCTL_DSP_MAPINBUF		_IOR ('P', 19, struct buffmem_desc)
103 #define SNDCTL_DSP_MAPOUTBUF		_IOR ('P', 20, struct buffmem_desc)
104 #define SNDCTL_DSP_SETSYNCRO		_IO  ('P', 21)
105 #define SNDCTL_DSP_SETDUPLEX		_IO  ('P', 22)
106 #define SNDCTL_DSP_PROFILE		_IOW ('P', 23, int)
107 #define SNDCTL_DSP_GETODELAY		_IOR ('P', 23, int)
108 #define	  APF_NORMAL			0
109 #define	  APF_NETWORK			1
110 #define   APF_CPUINTENS			2
111 
112 /* Need native 16 bit format which depends on byte order */
113 #include <machine/endian_machdep.h>
114 #if _BYTE_ORDER == _LITTLE_ENDIAN
115 #define  AFMT_S16_NE AFMT_S16_LE
116 #else
117 #define  AFMT_S16_NE AFMT_S16_BE
118 #endif
119 
120 /* Aliases */
121 #define SOUND_PCM_WRITE_BITS		SNDCTL_DSP_SETFMT
122 #define SOUND_PCM_WRITE_RATE		SNDCTL_DSP_SPEED
123 #define SOUND_PCM_POST			SNDCTL_DSP_POST
124 #define SOUND_PCM_RESET			SNDCTL_DSP_RESET
125 #define SOUND_PCM_SYNC			SNDCTL_DSP_SYNC
126 #define SOUND_PCM_SUBDIVIDE		SNDCTL_DSP_SUBDIVIDE
127 #define SOUND_PCM_SETFRAGMENT		SNDCTL_DSP_SETFRAGMENT
128 #define SOUND_PCM_GETFMTS		SNDCTL_DSP_GETFMTS
129 #define SOUND_PCM_SETFMT		SNDCTL_DSP_SETFMT
130 #define SOUND_PCM_GETOSPACE		SNDCTL_DSP_GETOSPACE
131 #define SOUND_PCM_GETISPACE		SNDCTL_DSP_GETISPACE
132 #define SOUND_PCM_NONBLOCK		SNDCTL_DSP_NONBLOCK
133 #define SOUND_PCM_GETCAPS		SNDCTL_DSP_GETCAPS
134 #define SOUND_PCM_GETTRIGGER		SNDCTL_DSP_GETTRIGGER
135 #define SOUND_PCM_SETTRIGGER		SNDCTL_DSP_SETTRIGGER
136 #define SOUND_PCM_SETSYNCRO		SNDCTL_DSP_SETSYNCRO
137 #define SOUND_PCM_GETIPTR		SNDCTL_DSP_GETIPTR
138 #define SOUND_PCM_GETOPTR		SNDCTL_DSP_GETOPTR
139 #define SOUND_PCM_MAPINBUF		SNDCTL_DSP_MAPINBUF
140 #define SOUND_PCM_MAPOUTBUF		SNDCTL_DSP_MAPOUTBUF
141 
142 /* Mixer defines */
143 #define SOUND_MIXER_FIRST		0
144 #define SOUND_MIXER_NRDEVICES		25
145 
146 #define SOUND_MIXER_VOLUME		0
147 #define SOUND_MIXER_BASS		1
148 #define SOUND_MIXER_TREBLE		2
149 #define SOUND_MIXER_SYNTH		3
150 #define SOUND_MIXER_PCM			4
151 #define SOUND_MIXER_SPEAKER		5
152 #define SOUND_MIXER_LINE		6
153 #define SOUND_MIXER_MIC			7
154 #define SOUND_MIXER_CD			8
155 #define SOUND_MIXER_IMIX		9
156 #define SOUND_MIXER_ALTPCM		10
157 #define SOUND_MIXER_RECLEV		11
158 #define SOUND_MIXER_IGAIN		12
159 #define SOUND_MIXER_OGAIN		13
160 #define SOUND_MIXER_LINE1		14
161 #define SOUND_MIXER_LINE2		15
162 #define SOUND_MIXER_LINE3		16
163 #define SOUND_MIXER_DIGITAL1		17
164 #define SOUND_MIXER_DIGITAL2		18
165 #define SOUND_MIXER_DIGITAL3		19
166 #define SOUND_MIXER_PHONEIN		20
167 #define SOUND_MIXER_PHONEOUT		21
168 #define SOUND_MIXER_VIDEO		22
169 #define SOUND_MIXER_RADIO		23
170 #define SOUND_MIXER_MONITOR		24
171 
172 #define SOUND_ONOFF_MIN			28
173 #define SOUND_ONOFF_MAX			30
174 
175 #define SOUND_MIXER_NONE		31
176 
177 #define SOUND_DEVICE_LABELS	{"Vol  ", "Bass ", "Trebl", "Synth", "Pcm  ", "Spkr ", "Line ", \
178 				 "Mic  ", "CD   ", "Mix  ", "Pcm2 ", "Rec  ", "IGain", "OGain", \
179 				 "Line1", "Line2", "Line3", "Digital1", "Digital2", "Digital3", \
180 				 "PhoneIn", "PhoneOut", "Video", "Radio", "Monitor"}
181 
182 #define SOUND_DEVICE_NAMES	{"vol", "bass", "treble", "synth", "pcm", "speaker", "line", \
183 				 "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", \
184 				 "line1", "line2", "line3", "dig1", "dig2", "dig3", \
185 				 "phin", "phout", "video", "radio", "monitor"}
186 
187 #define SOUND_MIXER_RECSRC		0xff
188 #define SOUND_MIXER_DEVMASK		0xfe
189 #define SOUND_MIXER_RECMASK		0xfd
190 #define SOUND_MIXER_CAPS		0xfc
191 #define  SOUND_CAP_EXCL_INPUT		1
192 #define SOUND_MIXER_STEREODEVS		0xfb
193 
194 #define MIXER_READ(dev)			_IOR('M', dev, int)
195 
196 #define SOUND_MIXER_READ_RECSRC		MIXER_READ(SOUND_MIXER_RECSRC)
197 #define SOUND_MIXER_READ_DEVMASK	MIXER_READ(SOUND_MIXER_DEVMASK)
198 #define SOUND_MIXER_READ_RECMASK	MIXER_READ(SOUND_MIXER_RECMASK)
199 #define SOUND_MIXER_READ_STEREODEVS	MIXER_READ(SOUND_MIXER_STEREODEVS)
200 #define SOUND_MIXER_READ_CAPS		MIXER_READ(SOUND_MIXER_CAPS)
201 
202 #define SOUND_MIXER_READ_VOLUME		MIXER_READ(SOUND_MIXER_VOLUME)
203 #define SOUND_MIXER_READ_BASS		MIXER_READ(SOUND_MIXER_BASS)
204 #define SOUND_MIXER_READ_TREBLE		MIXER_READ(SOUND_MIXER_TREBLE)
205 #define SOUND_MIXER_READ_SYNTH		MIXER_READ(SOUND_MIXER_SYNTH)
206 #define SOUND_MIXER_READ_PCM		MIXER_READ(SOUND_MIXER_PCM)
207 #define SOUND_MIXER_READ_SPEAKER	MIXER_READ(SOUND_MIXER_SPEAKER)
208 #define SOUND_MIXER_READ_LINE		MIXER_READ(SOUND_MIXER_LINE)
209 #define SOUND_MIXER_READ_MIC		MIXER_READ(SOUND_MIXER_MIC)
210 #define SOUND_MIXER_READ_CD		MIXER_READ(SOUND_MIXER_CD)
211 #define SOUND_MIXER_READ_IMIX		MIXER_READ(SOUND_MIXER_IMIX)
212 #define SOUND_MIXER_READ_ALTPCM		MIXER_READ(SOUND_MIXER_ALTPCM)
213 #define SOUND_MIXER_READ_RECLEV		MIXER_READ(SOUND_MIXER_RECLEV)
214 #define SOUND_MIXER_READ_IGAIN		MIXER_READ(SOUND_MIXER_IGAIN)
215 #define SOUND_MIXER_READ_OGAIN		MIXER_READ(SOUND_MIXER_OGAIN)
216 #define SOUND_MIXER_READ_LINE1		MIXER_READ(SOUND_MIXER_LINE1)
217 #define SOUND_MIXER_READ_LINE2		MIXER_READ(SOUND_MIXER_LINE2)
218 #define SOUND_MIXER_READ_LINE3		MIXER_READ(SOUND_MIXER_LINE3)
219 
220 #define MIXER_WRITE(dev)		_IOW ('M', dev, int)
221 #define MIXER_WRITE_R(dev)		_IOWR('M', dev, int)
222 
223 #define SOUND_MIXER_WRITE_RECSRC	MIXER_WRITE(SOUND_MIXER_RECSRC)
224 #define SOUND_MIXER_WRITE_R_RECSRC	MIXER_WRITE_R(SOUND_MIXER_RECSRC)
225 
226 #define SOUND_MIXER_WRITE_VOLUME	MIXER_WRITE(SOUND_MIXER_VOLUME)
227 #define SOUND_MIXER_WRITE_BASS		MIXER_WRITE(SOUND_MIXER_BASS)
228 #define SOUND_MIXER_WRITE_TREBLE	MIXER_WRITE(SOUND_MIXER_TREBLE)
229 #define SOUND_MIXER_WRITE_SYNTH		MIXER_WRITE(SOUND_MIXER_SYNTH)
230 #define SOUND_MIXER_WRITE_PCM		MIXER_WRITE(SOUND_MIXER_PCM)
231 #define SOUND_MIXER_WRITE_SPEAKER	MIXER_WRITE(SOUND_MIXER_SPEAKER)
232 #define SOUND_MIXER_WRITE_LINE		MIXER_WRITE(SOUND_MIXER_LINE)
233 #define SOUND_MIXER_WRITE_MIC		MIXER_WRITE(SOUND_MIXER_MIC)
234 #define SOUND_MIXER_WRITE_CD		MIXER_WRITE(SOUND_MIXER_CD)
235 #define SOUND_MIXER_WRITE_IMIX		MIXER_WRITE(SOUND_MIXER_IMIX)
236 #define SOUND_MIXER_WRITE_ALTPCM	MIXER_WRITE(SOUND_MIXER_ALTPCM)
237 #define SOUND_MIXER_WRITE_RECLEV	MIXER_WRITE(SOUND_MIXER_RECLEV)
238 #define SOUND_MIXER_WRITE_IGAIN		MIXER_WRITE(SOUND_MIXER_IGAIN)
239 #define SOUND_MIXER_WRITE_OGAIN		MIXER_WRITE(SOUND_MIXER_OGAIN)
240 #define SOUND_MIXER_WRITE_LINE1		MIXER_WRITE(SOUND_MIXER_LINE1)
241 #define SOUND_MIXER_WRITE_LINE2		MIXER_WRITE(SOUND_MIXER_LINE2)
242 #define SOUND_MIXER_WRITE_LINE3		MIXER_WRITE(SOUND_MIXER_LINE3)
243 
244 #define SOUND_MASK_VOLUME	(1 << SOUND_MIXER_VOLUME)
245 #define SOUND_MASK_BASS		(1 << SOUND_MIXER_BASS)
246 #define SOUND_MASK_TREBLE	(1 << SOUND_MIXER_TREBLE)
247 #define SOUND_MASK_SYNTH	(1 << SOUND_MIXER_SYNTH)
248 #define SOUND_MASK_PCM		(1 << SOUND_MIXER_PCM)
249 #define SOUND_MASK_SPEAKER	(1 << SOUND_MIXER_SPEAKER)
250 #define SOUND_MASK_LINE		(1 << SOUND_MIXER_LINE)
251 #define SOUND_MASK_MIC		(1 << SOUND_MIXER_MIC)
252 #define SOUND_MASK_CD		(1 << SOUND_MIXER_CD)
253 #define SOUND_MASK_IMIX		(1 << SOUND_MIXER_IMIX)
254 #define SOUND_MASK_ALTPCM	(1 << SOUND_MIXER_ALTPCM)
255 #define SOUND_MASK_RECLEV	(1 << SOUND_MIXER_RECLEV)
256 #define SOUND_MASK_IGAIN	(1 << SOUND_MIXER_IGAIN)
257 #define SOUND_MASK_OGAIN	(1 << SOUND_MIXER_OGAIN)
258 #define SOUND_MASK_LINE1	(1 << SOUND_MIXER_LINE1)
259 #define SOUND_MASK_LINE2	(1 << SOUND_MIXER_LINE2)
260 #define SOUND_MASK_LINE3	(1 << SOUND_MIXER_LINE3)
261 #define SOUND_MASK_DIGITAL1	(1 << SOUND_MIXER_DIGITAL1)
262 #define SOUND_MASK_DIGITAL2	(1 << SOUND_MIXER_DIGITAL2)
263 #define SOUND_MASK_DIGITAL3	(1 << SOUND_MIXER_DIGITAL3)
264 #define SOUND_MASK_PHONEIN	(1 << SOUND_MIXER_PHONEIN)
265 #define SOUND_MASK_PHONEOUT	(1 << SOUND_MIXER_PHONEOUT)
266 #define SOUND_MASK_VIDEO	(1 << SOUND_MIXER_VIDEO)
267 #define SOUND_MASK_RADIO	(1 << SOUND_MIXER_RADIO)
268 #define SOUND_MASK_MONITOR	(1 << SOUND_MIXER_MONITOR)
269 
270 typedef struct mixer_info {
271 	char id[16];
272 	char name[32];
273 	int  modify_counter;
274 	int  fillers[10];
275 } mixer_info;
276 
277 typedef struct _old_mixer_info {
278 	char id[16];
279 	char name[32];
280 } _old_mixer_info;
281 
282 #define SOUND_MIXER_INFO		_IOR('M', 101, mixer_info)
283 #define SOUND_OLD_MIXER_INFO		_IOR('M', 101, _old_mixer_info)
284 
285 #define OSS_GETVERSION			_IOR ('M', 118, int)
286 
287 typedef struct audio_buf_info {
288 	int fragments;
289 	int fragstotal;
290 	int fragsize;
291 	int bytes;
292 } audio_buf_info;
293 
294 typedef struct count_info {
295 	int bytes;
296 	int blocks;
297 	int ptr;
298 } count_info;
299 
300 typedef struct buffmem_desc {
301 	unsigned int *buffer;
302 	int size;
303 } buffmem_desc;
304 
305 /* Some OSSv4 calls. */
306 
307 #define OSS_DEVNODE_SIZE		32
308 #define OSS_LABEL_SIZE			16
309 #define OSS_LONGNAME_SIZE		64
310 #define OSS_MAX_AUDIO_DEVS		64
311 
312 #define SNDCTL_SYSINFO			_IOR ('P',24, struct oss_sysinfo)
313 #define SNDCTL_AUDIOINFO		_IOWR ('P',25, struct oss_audioinfo)
314 #define SNDCTL_ENGINEINFO		_IOWR ('P',26, struct oss_audioinfo)
315 #define SNDCTL_DSP_GETPLAYVOL		_IOR ('P',27, uint)
316 #define SNDCTL_DSP_SETPLAYVOL		_IOW ('P',28, uint)
317 #define SNDCTL_DSP_GETRECVOL		_IOR ('P',29, uint)
318 #define SNDCTL_DSP_SETRECVOL		_IOW ('P',30, uint)
319 #define SNDCTL_DSP_SKIP			_IO ('P',31)
320 #define SNDCTL_DSP_SILENCE		_IO ('P',32)
321 
322 typedef struct oss_sysinfo {
323 	char product[32];
324 	char version[32];
325 	int versionnum;
326 	char options[128];		/* Future use */
327 	int numaudios;
328 	int openedaudio[8];		/* Obsolete */
329 	int numsynths;			/* Obsolete */
330 	int nummidis;
331 	int numtimers;
332 	int nummixers;
333 	int openedmidi[8];
334 	int numcards;
335 	int numaudioengines;
336 	char license[16];
337 	char revision_info[256];	/* Internal Use */
338 	int filler[172];		/* For expansion */
339 } oss_sysinfo;
340 
341 typedef struct oss_audioinfo {
342 	int dev;		/* Set by caller */
343 	char name[OSS_LONGNAME_SIZE];
344 	int busy;
345 	int pid;
346 	int caps;
347 	int iformats;
348 	int oformats;
349 	int magic;		/* Unused */
350 	char cmd[OSS_LONGNAME_SIZE];
351 	int card_number;
352 	int port_number;
353 	int mixer_dev;
354 	int legacy_device;	/* Obsolete */
355 	int enabled;
356 	int flags;		/* Reserved */
357 	int min_rate;
358 	int max_rate;
359 	int min_channels;
360 	int max_channels;
361 	int binding;		/* Reserved */
362 	int rate_source;
363 	char handle[32];
364 #define OSS_MAX_SAMPLE_RATES	20
365 	int nrates;
366 	int rates[OSS_MAX_SAMPLE_RATES];
367 	char song_name[OSS_LONGNAME_SIZE];
368 	char label[OSS_LABEL_SIZE];
369 	int latency;				/* In usecs -1 = unknown */
370 	char devnode[OSS_DEVNODE_SIZE];
371 	int next_play_engine;
372 	int next_rec_engine;
373 	int filler[184];			/* For expansion */
374 } oss_audioinfo;
375 
376 #define ioctl _oss_ioctl
377 /*
378  * If we already included <sys/ioctl.h>, then we define our own prototype,
379  * else we depend on <sys/ioctl.h> to do it for us. We do it this way, so
380  * that we don't define the prototype twice.
381  */
382 #ifndef _SYS_IOCTL_H_
383 #include <sys/ioctl.h>
384 #else
385 __BEGIN_DECLS
386 int _oss_ioctl(int, unsigned long, ...);
387 __END_DECLS
388 #endif
389 
390 #endif /* !_SOUNDCARD_H_ */
391