src/include/audio_defs.h

/*
 *  audio_defs.h - Definitions for MacOS audio components
 *
 *  Basilisk II (C) 1997-2002 Christian Bauer
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef AUDIO_DEFS_H
#define AUDIO_DEFS_H

#include "macos_util.h"


// Error codes
enum {
        badComponentSelector = (int32)0x80008002,
        noHardwareErr = -200,
        badChannel = -205,
        siInvalidSampleRate     = -225,
        siInvalidSampleSize     = -226,
        siDeviceBusyErr = -227
};

// General component dispatch selector codes
enum {
        kComponentOpenSelect = -1,
        kComponentCloseSelect = -2,
        kComponentCanDoSelect = -3,
        kComponentVersionSelect = -4,
        kComponentRegisterSelect = -5
};

// Sound component dispatch selector codes
enum {
        kSoundComponentInitOutputDeviceSelect = 1,
        kSoundComponentSetSourceSelect = 2,
        kSoundComponentGetSourceSelect = 3,
        kSoundComponentGetSourceDataSelect = 4,
        kSoundComponentSetOutputSelect = 5,
        kDelegatedSoundComponentSelectors = 0x0100,
        kSoundComponentAddSourceSelect = kDelegatedSoundComponentSelectors + 1,
        kSoundComponentRemoveSourceSelect = kDelegatedSoundComponentSelectors + 2,
        kSoundComponentGetInfoSelect = kDelegatedSoundComponentSelectors + 3,
        kSoundComponentSetInfoSelect = kDelegatedSoundComponentSelectors + 4,
        kSoundComponentStartSourceSelect = kDelegatedSoundComponentSelectors + 5,
        kSoundComponentStopSourceSelect = kDelegatedSoundComponentSelectors + 6,
        kSoundComponentPauseSourceSelect = kDelegatedSoundComponentSelectors + 7,
        kSoundComponentPlaySourceBufferSelect = kDelegatedSoundComponentSelectors + 8
};

// Sound information selectors
const uint32 siNumberChannels           = FOURCC('c','h','a','n');      // current number of channels
const uint32 siChannelAvailable         = FOURCC('c','h','a','v');      // number of channels available
const uint32 siSampleRate                       = FOURCC('s','r','a','t');      // current sample rate
const uint32 siSampleRateAvailable      = FOURCC('s','r','a','v');      // sample rates available
const uint32 siSampleSize                       = FOURCC('s','s','i','z');      // current sample size
const uint32 siSampleSizeAvailable      = FOURCC('s','s','a','v');      // sample sizes available
const uint32 siHardwareMute                     = FOURCC('h','m','u','t');      // mute state of all hardware
const uint32 siHardwareVolume           = FOURCC('h','v','o','l');      // volume level of all hardware
const uint32 siHardwareVolumeSteps      = FOURCC('h','s','t','p');      // number of volume steps for hardware
const uint32 siHardwareBusy                     = FOURCC('h','w','b','s');      // sound hardware is in use
const uint32 siHeadphoneMute            = FOURCC('p','m','u','t');      // mute state of headphone
const uint32 siHeadphoneVolume          = FOURCC('p','v','o','l');      // volume level of headphone
const uint32 siHeadphoneVolumeSteps     = FOURCC('h','d','s','t');      // number of volume steps for headphone
const uint32 siSpeakerMute                      = FOURCC('s','m','u','t');      // mute state of all built-in speakers
const uint32 siSpeakerVolume            = FOURCC('s','v','o','l');      // volume level of built-in speaker
const uint32 siDeviceName                       = FOURCC('n','a','m','e');
const uint32 siDeviceIcon                       = FOURCC('i','c','o','n');

enum {  // ComponentResource struct
        componentType = 0,
        componentSubType = 4,
        componentManufacturer = 8,
        componentFlags = 12,
        componentFlagsMask = 16,
        componentResType = 20,
        componentResID = 24,
        componentNameType = 26,
        componentNameID = 30,
        componentInfoType = 32,
        componentInfoID = 36,
        componentIconType = 38,
        componentIconID = 42,
        componentVersion = 44,
        componentRegisterFlags = 48,
        componentIconFamily = 52,
        componentPFCount = 54,
        componentPFFlags = 58,
        componentPFResType = 62,
        componentPFResID = 66,
        componentPFPlatform = 68
};

// Component feature flags
enum {
        k8BitRawIn                              = (1 << 0),
        k8BitTwosIn                             = (1 << 1),
        k16BitIn                                = (1 << 2),
        kStereoIn                               = (1 << 3),
        k8BitRawOut                             = (1 << 8),
        k8BitTwosOut                    = (1 << 9),
        k16BitOut                               = (1 << 10),
        kStereoOut                              = (1 << 11),
        kReverse                                = (1L << 16),
        kRateConvert                    = (1L << 17),
        kCreateSoundSource              = (1L << 18),
        kHighQuality                    = (1L << 22),
        kNonRealTime                    = (1L << 23),
        cmpWantsRegisterMessage = (1L << 31)
};

enum {  // ComponentParameters struct
        cp_flags = 0,           // call modifiers: sync/async, deferred, immed, etc
        cp_paramSize = 1,       // size in bytes of actual parameters passed to this call
        cp_what = 2,            // routine selector, negative for Component management calls
        cp_params = 4           // actual parameters for the indicated routine
};

enum {  // SoundComponentData struct
        scd_flags = 0,
        scd_format = 4,
        scd_numChannels = 8,
        scd_sampleSize = 10,
        scd_sampleRate = 12,
        scd_sampleCount = 16,
        scd_buffer = 20,
        scd_reserved = 24,
        SIZEOF_scd = 28
};

enum {  // SoundInfoList struct
        sil_count = 0,
        sil_infoHandle = 2
};

#endif
Revision:	1.8
Committed:	2002-01-15T14:58:41Z (22 years, 10 months ago) by cebix
Content type:	text/plain
Branch:	MAIN
CVS Tags:	snapshot-15012002
Changes since 1.7:	+1 -1 lines
Log Message:	- documentation updates - 2001 -> 2002 - version 0.9 -> 1.0
#	Content
1	/*
2	* audio_defs.h - Definitions for MacOS audio components
3	*
4	* Basilisk II (C) 1997-2002 Christian Bauer
5	*
6	* This program is free software; you can redistribute it and/or modify
7	* it under the terms of the GNU General Public License as published by
8	* the Free Software Foundation; either version 2 of the License, or
9	* (at your option) any later version.
10	*
11	* This program is distributed in the hope that it will be useful,
12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU General Public License for more details.
15	*
16	* You should have received a copy of the GNU General Public License
17	* along with this program; if not, write to the Free Software
18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19	*/
20
21	#ifndef AUDIO_DEFS_H
22	#define AUDIO_DEFS_H
23
24	#include "macos_util.h"
25
26
27	// Error codes
28	enum {
29	badComponentSelector = (int32)0x80008002,
30	noHardwareErr = -200,
31	badChannel = -205,
32	siInvalidSampleRate = -225,
33	siInvalidSampleSize = -226,
34	siDeviceBusyErr = -227
35	};
36
37	// General component dispatch selector codes
38	enum {
39	kComponentOpenSelect = -1,
40	kComponentCloseSelect = -2,
41	kComponentCanDoSelect = -3,
42	kComponentVersionSelect = -4,
43	kComponentRegisterSelect = -5
44	};
45
46	// Sound component dispatch selector codes
47	enum {
48	kSoundComponentInitOutputDeviceSelect = 1,
49	kSoundComponentSetSourceSelect = 2,
50	kSoundComponentGetSourceSelect = 3,
51	kSoundComponentGetSourceDataSelect = 4,
52	kSoundComponentSetOutputSelect = 5,
53	kDelegatedSoundComponentSelectors = 0x0100,
54	kSoundComponentAddSourceSelect = kDelegatedSoundComponentSelectors + 1,
55	kSoundComponentRemoveSourceSelect = kDelegatedSoundComponentSelectors + 2,
56	kSoundComponentGetInfoSelect = kDelegatedSoundComponentSelectors + 3,
57	kSoundComponentSetInfoSelect = kDelegatedSoundComponentSelectors + 4,
58	kSoundComponentStartSourceSelect = kDelegatedSoundComponentSelectors + 5,
59	kSoundComponentStopSourceSelect = kDelegatedSoundComponentSelectors + 6,
60	kSoundComponentPauseSourceSelect = kDelegatedSoundComponentSelectors + 7,
61	kSoundComponentPlaySourceBufferSelect = kDelegatedSoundComponentSelectors + 8
62	};
63
64	// Sound information selectors
65	const uint32 siNumberChannels = FOURCC('c','h','a','n'); // current number of channels
66	const uint32 siChannelAvailable = FOURCC('c','h','a','v'); // number of channels available
67	const uint32 siSampleRate = FOURCC('s','r','a','t'); // current sample rate
68	const uint32 siSampleRateAvailable = FOURCC('s','r','a','v'); // sample rates available
69	const uint32 siSampleSize = FOURCC('s','s','i','z'); // current sample size
70	const uint32 siSampleSizeAvailable = FOURCC('s','s','a','v'); // sample sizes available
71	const uint32 siHardwareMute = FOURCC('h','m','u','t'); // mute state of all hardware
72	const uint32 siHardwareVolume = FOURCC('h','v','o','l'); // volume level of all hardware
73	const uint32 siHardwareVolumeSteps = FOURCC('h','s','t','p'); // number of volume steps for hardware
74	const uint32 siHardwareBusy = FOURCC('h','w','b','s'); // sound hardware is in use
75	const uint32 siHeadphoneMute = FOURCC('p','m','u','t'); // mute state of headphone
76	const uint32 siHeadphoneVolume = FOURCC('p','v','o','l'); // volume level of headphone
77	const uint32 siHeadphoneVolumeSteps = FOURCC('h','d','s','t'); // number of volume steps for headphone
78	const uint32 siSpeakerMute = FOURCC('s','m','u','t'); // mute state of all built-in speakers
79	const uint32 siSpeakerVolume = FOURCC('s','v','o','l'); // volume level of built-in speaker
80	const uint32 siDeviceName = FOURCC('n','a','m','e');
81	const uint32 siDeviceIcon = FOURCC('i','c','o','n');
82
83	enum { // ComponentResource struct
84	componentType = 0,
85	componentSubType = 4,
86	componentManufacturer = 8,
87	componentFlags = 12,
88	componentFlagsMask = 16,
89	componentResType = 20,
90	componentResID = 24,
91	componentNameType = 26,
92	componentNameID = 30,
93	componentInfoType = 32,
94	componentInfoID = 36,
95	componentIconType = 38,
96	componentIconID = 42,
97	componentVersion = 44,
98	componentRegisterFlags = 48,
99	componentIconFamily = 52,
100	componentPFCount = 54,
101	componentPFFlags = 58,
102	componentPFResType = 62,
103	componentPFResID = 66,
104	componentPFPlatform = 68
105	};
106
107	// Component feature flags
108	enum {
109	k8BitRawIn = (1 << 0),
110	k8BitTwosIn = (1 << 1),
111	k16BitIn = (1 << 2),
112	kStereoIn = (1 << 3),
113	k8BitRawOut = (1 << 8),
114	k8BitTwosOut = (1 << 9),
115	k16BitOut = (1 << 10),
116	kStereoOut = (1 << 11),
117	kReverse = (1L << 16),
118	kRateConvert = (1L << 17),
119	kCreateSoundSource = (1L << 18),
120	kHighQuality = (1L << 22),
121	kNonRealTime = (1L << 23),
122	cmpWantsRegisterMessage = (1L << 31)
123	};
124
125	enum { // ComponentParameters struct
126	cp_flags = 0, // call modifiers: sync/async, deferred, immed, etc
127	cp_paramSize = 1, // size in bytes of actual parameters passed to this call
128	cp_what = 2, // routine selector, negative for Component management calls
129	cp_params = 4 // actual parameters for the indicated routine
130	};
131
132	enum { // SoundComponentData struct
133	scd_flags = 0,
134	scd_format = 4,
135	scd_numChannels = 8,
136	scd_sampleSize = 10,
137	scd_sampleRate = 12,
138	scd_sampleCount = 16,
139	scd_buffer = 20,
140	scd_reserved = 24,
141	SIZEOF_scd = 28
142	};
143
144	enum { // SoundInfoList struct
145	sil_count = 0,
146	sil_infoHandle = 2
147	};
148
149	#endif