-
Notifications
You must be signed in to change notification settings - Fork 332
/
Copy pathsoundcard.h
1878 lines (1662 loc) · 64.6 KB
/
soundcard.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* soundcard.h
*/
/*-
* Copyright by Hannu Savolainen 1993 / 4Front Technologies 1993-2006
* Modified for the new FreeBSD sound driver by Luigi Rizzo, 1997
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* $FreeBSD: src/sys/sys/soundcard.h,v 1.48 2006/11/26 11:55:48 netchild Exp $
*/
/*
* Unless coordinating changes with 4Front Technologies, do NOT make any
* modifications to ioctl commands, types, etc. that would break
* compatibility with the OSS API.
*/
#ifndef _SYS_SOUNDCARD_H_
#define _SYS_SOUNDCARD_H_
/*
* If you make modifications to this file, please contact me before
* distributing the modified version. There is already enough
* diversity in the world.
*
* Regards,
* Hannu Savolainen
*
**********************************************************************
* PS. The Hacker's Guide to VoxWare available from
* nic.funet.fi:pub/Linux/ALPHA/sound. The file is
* snd-sdk-doc-0.1.ps.gz (gzipped postscript). It contains
* some useful information about programming with VoxWare.
* (NOTE! The pub/Linux/ALPHA/ directories are hidden. You have
* to cd inside them before the files are accessible.)
**********************************************************************
*/
/*
* SOUND_VERSION is only used by the voxware driver. Hopefully apps
* should not depend on it, but rather look at the capabilities
* of the driver in the kernel!
*/
#define SOUND_VERSION 301
#define VOXWARE /* does this have any use ? */
/*
* Supported card ID numbers (Should be somewhere else? We keep
* them here just for compativility with the old driver, but these
* constants are of little or no use).
*/
#define SNDCARD_ADLIB 1
#define SNDCARD_SB 2
#define SNDCARD_PAS 3
#define SNDCARD_GUS 4
#define SNDCARD_MPU401 5
#define SNDCARD_SB16 6
#define SNDCARD_SB16MIDI 7
#define SNDCARD_UART6850 8
#define SNDCARD_GUS16 9
#define SNDCARD_MSS 10
#define SNDCARD_PSS 11
#define SNDCARD_SSCAPE 12
#define SNDCARD_PSS_MPU 13
#define SNDCARD_PSS_MSS 14
#define SNDCARD_SSCAPE_MSS 15
#define SNDCARD_TRXPRO 16
#define SNDCARD_TRXPRO_SB 17
#define SNDCARD_TRXPRO_MPU 18
#define SNDCARD_MAD16 19
#define SNDCARD_MAD16_MPU 20
#define SNDCARD_CS4232 21
#define SNDCARD_CS4232_MPU 22
#define SNDCARD_MAUI 23
#define SNDCARD_PSEUDO_MSS 24
#define SNDCARD_AWE32 25
#define SNDCARD_NSS 26
#define SNDCARD_UART16550 27
#define SNDCARD_OPL 28
#include <sys/types.h>
#include <machine/endian.h>
#ifndef _IOWR
#include <sys/ioccom.h>
#endif /* !_IOWR */
/*
* The first part of this file contains the new FreeBSD sound ioctl
* interface. Tries to minimize the number of different ioctls, and
* to be reasonably general.
*
* 970821: some of the new calls have not been implemented yet.
*/
/*
* the following three calls extend the generic file descriptor
* interface. AIONWRITE is the dual of FIONREAD, i.e. returns the max
* number of bytes for a write operation to be non-blocking.
*
* AIOGSIZE/AIOSSIZE are used to change the behaviour of the device,
* from a character device (default) to a block device. In block mode,
* (not to be confused with blocking mode) the main difference for the
* application is that select() will return only when a complete
* block can be read/written to the device, whereas in character mode
* select will return true when one byte can be exchanged. For audio
* devices, character mode makes select almost useless since one byte
* will always be ready by the next sample time (which is often only a
* handful of microseconds away).
* Use a size of 0 or 1 to return to character mode.
*/
#define AIONWRITE _IOR('A', 10, int) /* get # bytes to write */
struct snd_size {
int play_size;
int rec_size;
};
#define AIOGSIZE _IOR('A', 11, struct snd_size)/* read current blocksize */
#define AIOSSIZE _IOWR('A', 11, struct snd_size) /* sets blocksize */
/*
* The following constants define supported audio formats. The
* encoding follows voxware conventions, i.e. 1 bit for each supported
* format. We extend it by using bit 31 (RO) to indicate full-duplex
* capability, and bit 29 (RO) to indicate that the card supports/
* needs different formats on capture & playback channels.
* Bit 29 (RW) is used to indicate/ask stereo.
*
* The number of bits required to store the sample is:
* o 4 bits for the IDA ADPCM format,
* o 8 bits for 8-bit formats, mu-law and A-law,
* o 16 bits for the 16-bit formats, and
* o 32 bits for the 24/32-bit formats.
* o undefined for the MPEG audio format.
*/
#define AFMT_QUERY 0x00000000 /* Return current format */
#define AFMT_MU_LAW 0x00000001 /* Logarithmic mu-law */
#define AFMT_A_LAW 0x00000002 /* Logarithmic A-law */
#define AFMT_IMA_ADPCM 0x00000004 /* A 4:1 compressed format where 16-bit
* sequence represented using the
* the average 4 bits per sample */
#define AFMT_U8 0x00000008 /* Unsigned 8-bit */
#define AFMT_S16_LE 0x00000010 /* Little endian signed 16-bit */
#define AFMT_S16_BE 0x00000020 /* Big endian signed 16-bit */
#define AFMT_S8 0x00000040 /* Signed 8-bit */
#define AFMT_U16_LE 0x00000080 /* Little endian unsigned 16-bit */
#define AFMT_U16_BE 0x00000100 /* Big endian unsigned 16-bit */
#define AFMT_MPEG 0x00000200 /* MPEG MP2/MP3 audio */
#define AFMT_AC3 0x00000400 /* Dolby Digital AC3 */
#if _BYTE_ORDER == _LITTLE_ENDIAN
#define AFMT_S16_NE AFMT_S16_LE /* native endian signed 16 */
#else
#define AFMT_S16_NE AFMT_S16_BE
#endif
/*
* 32-bit formats below used for 24-bit audio data where the data is stored
* in the 24 most significant bits and the least significant bits are not used
* (should be set to 0).
*/
#define AFMT_S32_LE 0x00001000 /* Little endian signed 32-bit */
#define AFMT_S32_BE 0x00002000 /* Big endian signed 32-bit */
#define AFMT_U32_LE 0x00004000 /* Little endian unsigned 32-bit */
#define AFMT_U32_BE 0x00008000 /* Big endian unsigned 32-bit */
#define AFMT_S24_LE 0x00010000 /* Little endian signed 24-bit */
#define AFMT_S24_BE 0x00020000 /* Big endian signed 24-bit */
#define AFMT_U24_LE 0x00040000 /* Little endian unsigned 24-bit */
#define AFMT_U24_BE 0x00080000 /* Big endian unsigned 24-bit */
#define AFMT_STEREO 0x10000000 /* can do/want stereo */
/*
* the following are really capabilities
*/
#define AFMT_WEIRD 0x20000000 /* weird hardware... */
/*
* AFMT_WEIRD reports that the hardware might need to operate
* with different formats in the playback and capture
* channels when operating in full duplex.
* As an example, SoundBlaster16 cards only support U8 in one
* direction and S16 in the other one, and applications should
* be aware of this limitation.
*/
#define AFMT_FULLDUPLEX 0x80000000 /* can do full duplex */
/*
* The following structure is used to get/set format and sampling rate.
* While it would be better to have things such as stereo, bits per
* sample, endianness, etc split in different variables, it turns out
* that formats are not that many, and not all combinations are possible.
* So we followed the Voxware approach of associating one bit to each
* format.
*/
typedef struct _snd_chan_param {
u_long play_rate; /* sampling rate */
u_long rec_rate; /* sampling rate */
u_long play_format; /* everything describing the format */
u_long rec_format; /* everything describing the format */
} snd_chan_param;
#define AIOGFMT _IOR('f', 12, snd_chan_param) /* get format */
#define AIOSFMT _IOWR('f', 12, snd_chan_param) /* sets format */
/*
* The following structure is used to get/set the mixer setting.
* Up to 32 mixers are supported, each one with up to 32 channels.
*/
typedef struct _snd_mix_param {
u_char subdev; /* which output */
u_char line; /* which input */
u_char left,right; /* volumes, 0..255, 0 = mute */
} snd_mix_param ;
/* XXX AIOGMIX, AIOSMIX not implemented yet */
#define AIOGMIX _IOWR('A', 13, snd_mix_param) /* return mixer status */
#define AIOSMIX _IOWR('A', 14, snd_mix_param) /* sets mixer status */
/*
* channel specifiers used in AIOSTOP and AIOSYNC
*/
#define AIOSYNC_PLAY 0x1 /* play chan */
#define AIOSYNC_CAPTURE 0x2 /* capture chan */
/* AIOSTOP stop & flush a channel, returns the residual count */
#define AIOSTOP _IOWR ('A', 15, int)
/* alternate method used to notify the sync condition */
#define AIOSYNC_SIGNAL 0x100
#define AIOSYNC_SELECT 0x200
/* what the 'pos' field refers to */
#define AIOSYNC_READY 0x400
#define AIOSYNC_FREE 0x800
typedef struct _snd_sync_parm {
long chan ; /* play or capture channel, plus modifier */
long pos;
} snd_sync_parm;
#define AIOSYNC _IOWR ('A', 15, snd_sync_parm) /* misc. synchronization */
/*
* The following is used to return device capabilities. If the structure
* passed to the ioctl is zeroed, default values are returned for rate
* and formats, a bitmap of available mixers is returned, and values
* (inputs, different levels) for the first one are returned.
*
* If formats, mixers, inputs are instantiated, then detailed info
* are returned depending on the call.
*/
typedef struct _snd_capabilities {
u_long rate_min, rate_max; /* min-max sampling rate */
u_long formats;
u_long bufsize; /* DMA buffer size */
u_long mixers; /* bitmap of available mixers */
u_long inputs; /* bitmap of available inputs (per mixer) */
u_short left, right; /* how many levels are supported */
} snd_capabilities;
#define AIOGCAP _IOWR('A', 15, snd_capabilities) /* get capabilities */
/*
* here is the old (Voxware) ioctl interface
*/
/*
* IOCTL Commands for /dev/sequencer
*/
#define SNDCTL_SEQ_RESET _IO ('Q', 0)
#define SNDCTL_SEQ_SYNC _IO ('Q', 1)
#define SNDCTL_SYNTH_INFO _IOWR('Q', 2, struct synth_info)
#define SNDCTL_SEQ_CTRLRATE _IOWR('Q', 3, int) /* Set/get timer res.(hz) */
#define SNDCTL_SEQ_GETOUTCOUNT _IOR ('Q', 4, int)
#define SNDCTL_SEQ_GETINCOUNT _IOR ('Q', 5, int)
#define SNDCTL_SEQ_PERCMODE _IOW ('Q', 6, int)
#define SNDCTL_FM_LOAD_INSTR _IOW ('Q', 7, struct sbi_instrument) /* Valid for FM only */
#define SNDCTL_SEQ_TESTMIDI _IOW ('Q', 8, int)
#define SNDCTL_SEQ_RESETSAMPLES _IOW ('Q', 9, int)
#define SNDCTL_SEQ_NRSYNTHS _IOR ('Q',10, int)
#define SNDCTL_SEQ_NRMIDIS _IOR ('Q',11, int)
#define SNDCTL_MIDI_INFO _IOWR('Q',12, struct midi_info)
#define SNDCTL_SEQ_THRESHOLD _IOW ('Q',13, int)
#define SNDCTL_SEQ_TRESHOLD SNDCTL_SEQ_THRESHOLD /* there was once a typo */
#define SNDCTL_SYNTH_MEMAVL _IOWR('Q',14, int) /* in=dev#, out=memsize */
#define SNDCTL_FM_4OP_ENABLE _IOW ('Q',15, int) /* in=dev# */
#define SNDCTL_PMGR_ACCESS _IOWR('Q',16, struct patmgr_info)
#define SNDCTL_SEQ_PANIC _IO ('Q',17)
#define SNDCTL_SEQ_OUTOFBAND _IOW ('Q',18, struct seq_event_rec)
#define SNDCTL_SEQ_GETTIME _IOR ('Q',19, int)
struct seq_event_rec {
u_char arr[8];
};
#define SNDCTL_TMR_TIMEBASE _IOWR('T', 1, int)
#define SNDCTL_TMR_START _IO ('T', 2)
#define SNDCTL_TMR_STOP _IO ('T', 3)
#define SNDCTL_TMR_CONTINUE _IO ('T', 4)
#define SNDCTL_TMR_TEMPO _IOWR('T', 5, int)
#define SNDCTL_TMR_SOURCE _IOWR('T', 6, int)
# define TMR_INTERNAL 0x00000001
# define TMR_EXTERNAL 0x00000002
# define TMR_MODE_MIDI 0x00000010
# define TMR_MODE_FSK 0x00000020
# define TMR_MODE_CLS 0x00000040
# define TMR_MODE_SMPTE 0x00000080
#define SNDCTL_TMR_METRONOME _IOW ('T', 7, int)
#define SNDCTL_TMR_SELECT _IOW ('T', 8, int)
/*
* Endian aware patch key generation algorithm.
*/
#if defined(_AIX) || defined(AIX)
# define _PATCHKEY(id) (0xfd00|id)
#else
# define _PATCHKEY(id) ((id<<8)|0xfd)
#endif
/*
* Sample loading mechanism for internal synthesizers (/dev/sequencer)
* The following patch_info structure has been designed to support
* Gravis UltraSound. It tries to be universal format for uploading
* sample based patches but is probably too limited.
*/
struct patch_info {
/* u_short key; Use GUS_PATCH here */
short key; /* Use GUS_PATCH here */
#define GUS_PATCH _PATCHKEY(0x04)
#define OBSOLETE_GUS_PATCH _PATCHKEY(0x02)
short device_no; /* Synthesizer number */
short instr_no; /* Midi pgm# */
u_long mode;
/*
* The least significant byte has the same format than the GUS .PAT
* files
*/
#define WAVE_16_BITS 0x01 /* bit 0 = 8 or 16 bit wave data. */
#define WAVE_UNSIGNED 0x02 /* bit 1 = Signed - Unsigned data. */
#define WAVE_LOOPING 0x04 /* bit 2 = looping enabled-1. */
#define WAVE_BIDIR_LOOP 0x08 /* bit 3 = Set is bidirectional looping. */
#define WAVE_LOOP_BACK 0x10 /* bit 4 = Set is looping backward. */
#define WAVE_SUSTAIN_ON 0x20 /* bit 5 = Turn sustaining on. (Env. pts. 3)*/
#define WAVE_ENVELOPES 0x40 /* bit 6 = Enable envelopes - 1 */
/* (use the env_rate/env_offs fields). */
/* Linux specific bits */
#define WAVE_VIBRATO 0x00010000 /* The vibrato info is valid */
#define WAVE_TREMOLO 0x00020000 /* The tremolo info is valid */
#define WAVE_SCALE 0x00040000 /* The scaling info is valid */
/* Other bits must be zeroed */
long len; /* Size of the wave data in bytes */
long loop_start, loop_end; /* Byte offsets from the beginning */
/*
* The base_freq and base_note fields are used when computing the
* playback speed for a note. The base_note defines the tone frequency
* which is heard if the sample is played using the base_freq as the
* playback speed.
*
* The low_note and high_note fields define the minimum and maximum note
* frequencies for which this sample is valid. It is possible to define
* more than one samples for an instrument number at the same time. The
* low_note and high_note fields are used to select the most suitable one.
*
* The fields base_note, high_note and low_note should contain
* the note frequency multiplied by 1000. For example value for the
* middle A is 440*1000.
*/
u_int base_freq;
u_long base_note;
u_long high_note;
u_long low_note;
int panning; /* -128=left, 127=right */
int detuning;
/* New fields introduced in version 1.99.5 */
/* Envelope. Enabled by mode bit WAVE_ENVELOPES */
u_char env_rate[ 6 ]; /* GUS HW ramping rate */
u_char env_offset[ 6 ]; /* 255 == 100% */
/*
* The tremolo, vibrato and scale info are not supported yet.
* Enable by setting the mode bits WAVE_TREMOLO, WAVE_VIBRATO or
* WAVE_SCALE
*/
u_char tremolo_sweep;
u_char tremolo_rate;
u_char tremolo_depth;
u_char vibrato_sweep;
u_char vibrato_rate;
u_char vibrato_depth;
int scale_frequency;
u_int scale_factor; /* from 0 to 2048 or 0 to 2 */
int volume;
int spare[4];
char data[1]; /* The waveform data starts here */
};
struct sysex_info {
short key; /* Use GUS_PATCH here */
#define SYSEX_PATCH _PATCHKEY(0x05)
#define MAUI_PATCH _PATCHKEY(0x06)
short device_no; /* Synthesizer number */
long len; /* Size of the sysex data in bytes */
u_char data[1]; /* Sysex data starts here */
};
/*
* Patch management interface (/dev/sequencer, /dev/patmgr#)
* Don't use these calls if you want to maintain compatibility with
* the future versions of the driver.
*/
#define PS_NO_PATCHES 0 /* No patch support on device */
#define PS_MGR_NOT_OK 1 /* Plain patch support (no mgr) */
#define PS_MGR_OK 2 /* Patch manager supported */
#define PS_MANAGED 3 /* Patch manager running */
#define SNDCTL_PMGR_IFACE _IOWR('P', 1, struct patmgr_info)
/*
* The patmgr_info is a fixed size structure which is used for two
* different purposes. The intended use is for communication between
* the application using /dev/sequencer and the patch manager daemon
* associated with a synthesizer device (ioctl(SNDCTL_PMGR_ACCESS)).
*
* This structure is also used with ioctl(SNDCTL_PGMR_IFACE) which allows
* a patch manager daemon to read and write device parameters. This
* ioctl available through /dev/sequencer also. Avoid using it since it's
* extremely hardware dependent. In addition access through /dev/sequencer
* may confuse the patch manager daemon.
*/
struct patmgr_info { /* Note! size must be < 4k since kmalloc() is used */
u_long key; /* Don't worry. Reserved for communication
between the patch manager and the driver. */
#define PM_K_EVENT 1 /* Event from the /dev/sequencer driver */
#define PM_K_COMMAND 2 /* Request from an application */
#define PM_K_RESPONSE 3 /* From patmgr to application */
#define PM_ERROR 4 /* Error returned by the patmgr */
int device;
int command;
/*
* Commands 0x000 to 0xfff reserved for patch manager programs
*/
#define PM_GET_DEVTYPE 1 /* Returns type of the patch mgr interface of dev */
#define PMTYPE_FM2 1 /* 2 OP fm */
#define PMTYPE_FM4 2 /* Mixed 4 or 2 op FM (OPL-3) */
#define PMTYPE_WAVE 3 /* Wave table synthesizer (GUS) */
#define PM_GET_NRPGM 2 /* Returns max # of midi programs in parm1 */
#define PM_GET_PGMMAP 3 /* Returns map of loaded midi programs in data8 */
#define PM_GET_PGM_PATCHES 4 /* Return list of patches of a program (parm1) */
#define PM_GET_PATCH 5 /* Return patch header of patch parm1 */
#define PM_SET_PATCH 6 /* Set patch header of patch parm1 */
#define PM_READ_PATCH 7 /* Read patch (wave) data */
#define PM_WRITE_PATCH 8 /* Write patch (wave) data */
/*
* Commands 0x1000 to 0xffff are for communication between the patch manager
* and the client
*/
#define _PM_LOAD_PATCH 0x100
/*
* Commands above 0xffff reserved for device specific use
*/
long parm1;
long parm2;
long parm3;
union {
u_char data8[4000];
u_short data16[2000];
u_long data32[1000];
struct patch_info patch;
} data;
};
/*
* When a patch manager daemon is present, it will be informed by the
* driver when something important happens. For example when the
* /dev/sequencer is opened or closed. A record with key == PM_K_EVENT is
* returned. The command field contains the event type:
*/
#define PM_E_OPENED 1 /* /dev/sequencer opened */
#define PM_E_CLOSED 2 /* /dev/sequencer closed */
#define PM_E_PATCH_RESET 3 /* SNDCTL_RESETSAMPLES called */
#define PM_E_PATCH_LOADED 4 /* A patch has been loaded by appl */
/*
* /dev/sequencer input events.
*
* The data written to the /dev/sequencer is a stream of events. Events
* are records of 4 or 8 bytes. The first byte defines the size.
* Any number of events can be written with a write call. There
* is a set of macros for sending these events. Use these macros if you
* want to maximize portability of your program.
*
* Events SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO. Are also input events.
* (All input events are currently 4 bytes long. Be prepared to support
* 8 byte events also. If you receive any event having first byte >= 128,
* it's a 8 byte event.
*
* The events are documented at the end of this file.
*
* Normal events (4 bytes)
* There is also a 8 byte version of most of the 4 byte events. The
* 8 byte one is recommended.
*/
#define SEQ_NOTEOFF 0
#define SEQ_FMNOTEOFF SEQ_NOTEOFF /* Just old name */
#define SEQ_NOTEON 1
#define SEQ_FMNOTEON SEQ_NOTEON
#define SEQ_WAIT TMR_WAIT_ABS
#define SEQ_PGMCHANGE 3
#define SEQ_FMPGMCHANGE SEQ_PGMCHANGE
#define SEQ_SYNCTIMER TMR_START
#define SEQ_MIDIPUTC 5
#define SEQ_DRUMON 6 /*** OBSOLETE ***/
#define SEQ_DRUMOFF 7 /*** OBSOLETE ***/
#define SEQ_ECHO TMR_ECHO /* For syncing programs with output */
#define SEQ_AFTERTOUCH 9
#define SEQ_CONTROLLER 10
/*
* Midi controller numbers
*
* Controllers 0 to 31 (0x00 to 0x1f) and 32 to 63 (0x20 to 0x3f)
* are continuous controllers.
* In the MIDI 1.0 these controllers are sent using two messages.
* Controller numbers 0 to 31 are used to send the MSB and the
* controller numbers 32 to 63 are for the LSB. Note that just 7 bits
* are used in MIDI bytes.
*/
#define CTL_BANK_SELECT 0x00
#define CTL_MODWHEEL 0x01
#define CTL_BREATH 0x02
/* undefined 0x03 */
#define CTL_FOOT 0x04
#define CTL_PORTAMENTO_TIME 0x05
#define CTL_DATA_ENTRY 0x06
#define CTL_MAIN_VOLUME 0x07
#define CTL_BALANCE 0x08
/* undefined 0x09 */
#define CTL_PAN 0x0a
#define CTL_EXPRESSION 0x0b
/* undefined 0x0c - 0x0f */
#define CTL_GENERAL_PURPOSE1 0x10
#define CTL_GENERAL_PURPOSE2 0x11
#define CTL_GENERAL_PURPOSE3 0x12
#define CTL_GENERAL_PURPOSE4 0x13
/* undefined 0x14 - 0x1f */
/* undefined 0x20 */
/*
* The controller numbers 0x21 to 0x3f are reserved for the
* least significant bytes of the controllers 0x00 to 0x1f.
* These controllers are not recognised by the driver.
*
* Controllers 64 to 69 (0x40 to 0x45) are on/off switches.
* 0=OFF and 127=ON (intermediate values are possible)
*/
#define CTL_DAMPER_PEDAL 0x40
#define CTL_SUSTAIN CTL_DAMPER_PEDAL /* Alias */
#define CTL_HOLD CTL_DAMPER_PEDAL /* Alias */
#define CTL_PORTAMENTO 0x41
#define CTL_SOSTENUTO 0x42
#define CTL_SOFT_PEDAL 0x43
/* undefined 0x44 */
#define CTL_HOLD2 0x45
/* undefined 0x46 - 0x4f */
#define CTL_GENERAL_PURPOSE5 0x50
#define CTL_GENERAL_PURPOSE6 0x51
#define CTL_GENERAL_PURPOSE7 0x52
#define CTL_GENERAL_PURPOSE8 0x53
/* undefined 0x54 - 0x5a */
#define CTL_EXT_EFF_DEPTH 0x5b
#define CTL_TREMOLO_DEPTH 0x5c
#define CTL_CHORUS_DEPTH 0x5d
#define CTL_DETUNE_DEPTH 0x5e
#define CTL_CELESTE_DEPTH CTL_DETUNE_DEPTH /* Alias for the above one */
#define CTL_PHASER_DEPTH 0x5f
#define CTL_DATA_INCREMENT 0x60
#define CTL_DATA_DECREMENT 0x61
#define CTL_NONREG_PARM_NUM_LSB 0x62
#define CTL_NONREG_PARM_NUM_MSB 0x63
#define CTL_REGIST_PARM_NUM_LSB 0x64
#define CTL_REGIST_PARM_NUM_MSB 0x65
/* undefined 0x66 - 0x78 */
/* reserved 0x79 - 0x7f */
/* Pseudo controllers (not midi compatible) */
#define CTRL_PITCH_BENDER 255
#define CTRL_PITCH_BENDER_RANGE 254
#define CTRL_EXPRESSION 253 /* Obsolete */
#define CTRL_MAIN_VOLUME 252 /* Obsolete */
#define SEQ_BALANCE 11
#define SEQ_VOLMODE 12
/*
* Volume mode decides how volumes are used
*/
#define VOL_METHOD_ADAGIO 1
#define VOL_METHOD_LINEAR 2
/*
* Note! SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO are used also as
* input events.
*/
/*
* Event codes 0xf0 to 0xfc are reserved for future extensions.
*/
#define SEQ_FULLSIZE 0xfd /* Long events */
/*
* SEQ_FULLSIZE events are used for loading patches/samples to the
* synthesizer devices. These events are passed directly to the driver
* of the associated synthesizer device. There is no limit to the size
* of the extended events. These events are not queued but executed
* immediately when the write() is called (execution can take several
* seconds of time).
*
* When a SEQ_FULLSIZE message is written to the device, it must
* be written using exactly one write() call. Other events cannot
* be mixed to the same write.
*
* For FM synths (YM3812/OPL3) use struct sbi_instrument and write
* it to the /dev/sequencer. Don't write other data together with
* the instrument structure Set the key field of the structure to
* FM_PATCH. The device field is used to route the patch to the
* corresponding device.
*
* For Gravis UltraSound use struct patch_info. Initialize the key field
* to GUS_PATCH.
*/
#define SEQ_PRIVATE 0xfe /* Low level HW dependent events (8 bytes) */
#define SEQ_EXTENDED 0xff /* Extended events (8 bytes) OBSOLETE */
/*
* Record for FM patches
*/
typedef u_char sbi_instr_data[32];
struct sbi_instrument {
u_short key; /* FM_PATCH or OPL3_PATCH */
#define FM_PATCH _PATCHKEY(0x01)
#define OPL3_PATCH _PATCHKEY(0x03)
short device; /* Synth# (0-4) */
int channel; /* Program# to be initialized */
sbi_instr_data operators; /* Reg. settings for operator cells
* (.SBI format) */
};
struct synth_info { /* Read only */
char name[30];
int device; /* 0-N. INITIALIZE BEFORE CALLING */
int synth_type;
#define SYNTH_TYPE_FM 0
#define SYNTH_TYPE_SAMPLE 1
#define SYNTH_TYPE_MIDI 2 /* Midi interface */
int synth_subtype;
#define FM_TYPE_ADLIB 0x00
#define FM_TYPE_OPL3 0x01
#define MIDI_TYPE_MPU401 0x401
#define SAMPLE_TYPE_BASIC 0x10
#define SAMPLE_TYPE_GUS SAMPLE_TYPE_BASIC
#define SAMPLE_TYPE_AWE32 0x20
int perc_mode; /* No longer supported */
int nr_voices;
int nr_drums; /* Obsolete field */
int instr_bank_size;
u_long capabilities;
#define SYNTH_CAP_PERCMODE 0x00000001 /* No longer used */
#define SYNTH_CAP_OPL3 0x00000002 /* Set if OPL3 supported */
#define SYNTH_CAP_INPUT 0x00000004 /* Input (MIDI) device */
int dummies[19]; /* Reserve space */
};
struct sound_timer_info {
char name[32];
int caps;
};
struct midi_info {
char name[30];
int device; /* 0-N. INITIALIZE BEFORE CALLING */
u_long capabilities; /* To be defined later */
int dev_type;
int dummies[18]; /* Reserve space */
};
/*
* ioctl commands for the /dev/midi##
*/
typedef struct {
u_char cmd;
char nr_args, nr_returns;
u_char data[30];
} mpu_command_rec;
#define SNDCTL_MIDI_PRETIME _IOWR('m', 0, int)
#define SNDCTL_MIDI_MPUMODE _IOWR('m', 1, int)
#define SNDCTL_MIDI_MPUCMD _IOWR('m', 2, mpu_command_rec)
#define MIOSPASSTHRU _IOWR('m', 3, int)
#define MIOGPASSTHRU _IOWR('m', 4, int)
/*
* IOCTL commands for /dev/dsp and /dev/audio
*/
#define SNDCTL_DSP_RESET _IO ('P', 0)
#define SNDCTL_DSP_SYNC _IO ('P', 1)
#define SNDCTL_DSP_SPEED _IOWR('P', 2, int)
#define SNDCTL_DSP_STEREO _IOWR('P', 3, int)
#define SNDCTL_DSP_GETBLKSIZE _IOR('P', 4, int)
#define SNDCTL_DSP_SETBLKSIZE _IOW('P', 4, int)
#define SNDCTL_DSP_SETFMT _IOWR('P',5, int) /* Selects ONE fmt*/
/*
* SOUND_PCM_WRITE_CHANNELS is not that different
* from SNDCTL_DSP_STEREO
*/
#define SOUND_PCM_WRITE_CHANNELS _IOWR('P', 6, int)
#define SNDCTL_DSP_CHANNELS SOUND_PCM_WRITE_CHANNELS
#define SOUND_PCM_WRITE_FILTER _IOWR('P', 7, int)
#define SNDCTL_DSP_POST _IO ('P', 8)
/*
* SNDCTL_DSP_SETBLKSIZE and the following two calls mostly do
* the same thing, i.e. set the block size used in DMA transfers.
*/
#define SNDCTL_DSP_SUBDIVIDE _IOWR('P', 9, int)
#define SNDCTL_DSP_SETFRAGMENT _IOWR('P',10, int)
#define SNDCTL_DSP_GETFMTS _IOR ('P',11, int) /* Returns a mask */
/*
* Buffer status queries.
*/
typedef struct audio_buf_info {
int fragments; /* # of avail. frags (partly used ones not counted) */
int fragstotal; /* Total # of fragments allocated */
int fragsize; /* Size of a fragment in bytes */
int bytes; /* Avail. space in bytes (includes partly used fragments) */
/* Note! 'bytes' could be more than fragments*fragsize */
} audio_buf_info;
#define SNDCTL_DSP_GETOSPACE _IOR ('P',12, audio_buf_info)
#define SNDCTL_DSP_GETISPACE _IOR ('P',13, audio_buf_info)
/*
* SNDCTL_DSP_NONBLOCK is the same (but less powerful, since the
* action cannot be undone) of FIONBIO. The same can be achieved
* by opening the device with O_NDELAY
*/
#define SNDCTL_DSP_NONBLOCK _IO ('P',14)
#define SNDCTL_DSP_GETCAPS _IOR ('P',15, int)
#define DSP_CAP_REVISION 0x000000ff /* revision level (0 to 255) */
#define DSP_CAP_DUPLEX 0x00000100 /* Full duplex record/playback */
#define DSP_CAP_REALTIME 0x00000200 /* Real time capability */
#define DSP_CAP_BATCH 0x00000400
/*
* Device has some kind of internal buffers which may
* cause some delays and decrease precision of timing
*/
#define DSP_CAP_COPROC 0x00000800
/* Has a coprocessor, sometimes it's a DSP but usually not */
#define DSP_CAP_TRIGGER 0x00001000 /* Supports SETTRIGGER */
#define DSP_CAP_MMAP 0x00002000 /* Supports mmap() */
/*
* What do these function do ?
*/
#define SNDCTL_DSP_GETTRIGGER _IOR ('P',16, int)
#define SNDCTL_DSP_SETTRIGGER _IOW ('P',16, int)
#define PCM_ENABLE_INPUT 0x00000001
#define PCM_ENABLE_OUTPUT 0x00000002
typedef struct count_info {
int bytes; /* Total # of bytes processed */
int blocks; /* # of fragment transitions since last time */
int ptr; /* Current DMA pointer value */
} count_info;
/*
* GETIPTR and GETISPACE are not that different... same for out.
*/
#define SNDCTL_DSP_GETIPTR _IOR ('P',17, count_info)
#define SNDCTL_DSP_GETOPTR _IOR ('P',18, count_info)
typedef struct buffmem_desc {
caddr_t buffer;
int size;
} buffmem_desc;
#define SNDCTL_DSP_MAPINBUF _IOR ('P', 19, buffmem_desc)
#define SNDCTL_DSP_MAPOUTBUF _IOR ('P', 20, buffmem_desc)
#define SNDCTL_DSP_SETSYNCRO _IO ('P', 21)
#define SNDCTL_DSP_SETDUPLEX _IO ('P', 22)
#define SNDCTL_DSP_GETODELAY _IOR ('P', 23, int)
/*
* I guess these are the readonly version of the same
* functions that exist above as SNDCTL_DSP_...
*/
#define SOUND_PCM_READ_RATE _IOR ('P', 2, int)
#define SOUND_PCM_READ_CHANNELS _IOR ('P', 6, int)
#define SOUND_PCM_READ_BITS _IOR ('P', 5, int)
#define SOUND_PCM_READ_FILTER _IOR ('P', 7, int)
/*
* ioctl calls to be used in communication with coprocessors and
* DSP chips.
*/
typedef struct copr_buffer {
int command; /* Set to 0 if not used */
int flags;
#define CPF_NONE 0x0000
#define CPF_FIRST 0x0001 /* First block */
#define CPF_LAST 0x0002 /* Last block */
int len;
int offs; /* If required by the device (0 if not used) */
u_char data[4000]; /* NOTE! 4000 is not 4k */
} copr_buffer;
typedef struct copr_debug_buf {
int command; /* Used internally. Set to 0 */
int parm1;
int parm2;
int flags;
int len; /* Length of data in bytes */
} copr_debug_buf;
typedef struct copr_msg {
int len;
u_char data[4000];
} copr_msg;
#define SNDCTL_COPR_RESET _IO ('C', 0)
#define SNDCTL_COPR_LOAD _IOWR('C', 1, copr_buffer)
#define SNDCTL_COPR_RDATA _IOWR('C', 2, copr_debug_buf)
#define SNDCTL_COPR_RCODE _IOWR('C', 3, copr_debug_buf)
#define SNDCTL_COPR_WDATA _IOW ('C', 4, copr_debug_buf)
#define SNDCTL_COPR_WCODE _IOW ('C', 5, copr_debug_buf)
#define SNDCTL_COPR_RUN _IOWR('C', 6, copr_debug_buf)
#define SNDCTL_COPR_HALT _IOWR('C', 7, copr_debug_buf)
#define SNDCTL_COPR_SENDMSG _IOW ('C', 8, copr_msg)
#define SNDCTL_COPR_RCVMSG _IOR ('C', 9, copr_msg)
/*
* IOCTL commands for /dev/mixer
*/
/*
* Mixer devices
*
* There can be up to 20 different analog mixer channels. The
* SOUND_MIXER_NRDEVICES gives the currently supported maximum.
* The SOUND_MIXER_READ_DEVMASK returns a bitmask which tells
* the devices supported by the particular mixer.
*/
#define SOUND_MIXER_NRDEVICES 25
#define SOUND_MIXER_VOLUME 0 /* Master output level */
#define SOUND_MIXER_BASS 1 /* Treble level of all output channels */
#define SOUND_MIXER_TREBLE 2 /* Bass level of all output channels */
#define SOUND_MIXER_SYNTH 3 /* Volume of synthesier input */
#define SOUND_MIXER_PCM 4 /* Output level for the audio device */
#define SOUND_MIXER_SPEAKER 5 /* Output level for the PC speaker
* signals */
#define SOUND_MIXER_LINE 6 /* Volume level for the line in jack */
#define SOUND_MIXER_MIC 7 /* Volume for the signal coming from
* the microphone jack */
#define SOUND_MIXER_CD 8 /* Volume level for the input signal
* connected to the CD audio input */
#define SOUND_MIXER_IMIX 9 /* Recording monitor. It controls the
* output volume of the selected
* recording sources while recording */
#define SOUND_MIXER_ALTPCM 10 /* Volume of the alternative codec
* device */
#define SOUND_MIXER_RECLEV 11 /* Global recording level */
#define SOUND_MIXER_IGAIN 12 /* Input gain */
#define SOUND_MIXER_OGAIN 13 /* Output gain */
/*
* The AD1848 codec and compatibles have three line level inputs
* (line, aux1 and aux2). Since each card manufacturer have assigned
* different meanings to these inputs, it's impractical to assign
* specific meanings (line, cd, synth etc.) to them.
*/
#define SOUND_MIXER_LINE1 14 /* Input source 1 (aux1) */
#define SOUND_MIXER_LINE2 15 /* Input source 2 (aux2) */
#define SOUND_MIXER_LINE3 16 /* Input source 3 (line) */
#define SOUND_MIXER_DIGITAL1 17 /* Digital (input) 1 */
#define SOUND_MIXER_DIGITAL2 18 /* Digital (input) 2 */
#define SOUND_MIXER_DIGITAL3 19 /* Digital (input) 3 */
#define SOUND_MIXER_PHONEIN 20 /* Phone input */
#define SOUND_MIXER_PHONEOUT 21 /* Phone output */
#define SOUND_MIXER_VIDEO 22 /* Video/TV (audio) in */
#define SOUND_MIXER_RADIO 23 /* Radio in */
#define SOUND_MIXER_MONITOR 24 /* Monitor (usually mic) volume */
/*
* Some on/off settings (SOUND_SPECIAL_MIN - SOUND_SPECIAL_MAX)
* Not counted to SOUND_MIXER_NRDEVICES, but use the same number space
*/
#define SOUND_ONOFF_MIN 28
#define SOUND_ONOFF_MAX 30
#define SOUND_MIXER_MUTE 28 /* 0 or 1 */
#define SOUND_MIXER_ENHANCE 29 /* Enhanced stereo (0, 40, 60 or 80) */
#define SOUND_MIXER_LOUD 30 /* 0 or 1 */
/* Note! Number 31 cannot be used since the sign bit is reserved */
#define SOUND_MIXER_NONE 31
#define SOUND_DEVICE_LABELS { \
"Vol ", "Bass ", "Trebl", "Synth", "Pcm ", "Spkr ", "Line ", \
"Mic ", "CD ", "Mix ", "Pcm2 ", "Rec ", "IGain", "OGain", \
"Line1", "Line2", "Line3", "Digital1", "Digital2", "Digital3", \
"PhoneIn", "PhoneOut", "Video", "Radio", "Monitor"}
#define SOUND_DEVICE_NAMES { \
"vol", "bass", "treble", "synth", "pcm", "speaker", "line", \
"mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", \
"line1", "line2", "line3", "dig1", "dig2", "dig3", \
"phin", "phout", "video", "radio", "monitor"}
/* Device bitmask identifiers */
#define SOUND_MIXER_RECSRC 0xff /* 1 bit per recording source */
#define SOUND_MIXER_DEVMASK 0xfe /* 1 bit per supported device */
#define SOUND_MIXER_RECMASK 0xfd /* 1 bit per supp. recording source */
#define SOUND_MIXER_CAPS 0xfc
#define SOUND_CAP_EXCL_INPUT 0x00000001 /* Only 1 rec. src at a time */
#define SOUND_MIXER_STEREODEVS 0xfb /* Mixer channels supporting stereo */
/* Device mask bits */
#define SOUND_MASK_VOLUME (1 << SOUND_MIXER_VOLUME)
#define SOUND_MASK_BASS (1 << SOUND_MIXER_BASS)
#define SOUND_MASK_TREBLE (1 << SOUND_MIXER_TREBLE)
#define SOUND_MASK_SYNTH (1 << SOUND_MIXER_SYNTH)
#define SOUND_MASK_PCM (1 << SOUND_MIXER_PCM)
#define SOUND_MASK_SPEAKER (1 << SOUND_MIXER_SPEAKER)
#define SOUND_MASK_LINE (1 << SOUND_MIXER_LINE)
#define SOUND_MASK_MIC (1 << SOUND_MIXER_MIC)
#define SOUND_MASK_CD (1 << SOUND_MIXER_CD)
#define SOUND_MASK_IMIX (1 << SOUND_MIXER_IMIX)
#define SOUND_MASK_ALTPCM (1 << SOUND_MIXER_ALTPCM)
#define SOUND_MASK_RECLEV (1 << SOUND_MIXER_RECLEV)
#define SOUND_MASK_IGAIN (1 << SOUND_MIXER_IGAIN)
#define SOUND_MASK_OGAIN (1 << SOUND_MIXER_OGAIN)