|
jpayne@69
|
1 /**
|
|
jpayne@69
|
2 * \file include/hwdep.h
|
|
jpayne@69
|
3 * \brief Application interface library for the ALSA driver
|
|
jpayne@69
|
4 * \author Jaroslav Kysela <perex@perex.cz>
|
|
jpayne@69
|
5 * \author Abramo Bagnara <abramo@alsa-project.org>
|
|
jpayne@69
|
6 * \author Takashi Iwai <tiwai@suse.de>
|
|
jpayne@69
|
7 * \date 1998-2001
|
|
jpayne@69
|
8 *
|
|
jpayne@69
|
9 * Application interface library for the ALSA driver
|
|
jpayne@69
|
10 */
|
|
jpayne@69
|
11 /*
|
|
jpayne@69
|
12 * This library is free software; you can redistribute it and/or modify
|
|
jpayne@69
|
13 * it under the terms of the GNU Lesser General Public License as
|
|
jpayne@69
|
14 * published by the Free Software Foundation; either version 2.1 of
|
|
jpayne@69
|
15 * the License, or (at your option) any later version.
|
|
jpayne@69
|
16 *
|
|
jpayne@69
|
17 * This program is distributed in the hope that it will be useful,
|
|
jpayne@69
|
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
jpayne@69
|
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
jpayne@69
|
20 * GNU Lesser General Public License for more details.
|
|
jpayne@69
|
21 *
|
|
jpayne@69
|
22 * You should have received a copy of the GNU Lesser General Public
|
|
jpayne@69
|
23 * License along with this library; if not, write to the Free Software
|
|
jpayne@69
|
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
jpayne@69
|
25 *
|
|
jpayne@69
|
26 */
|
|
jpayne@69
|
27
|
|
jpayne@69
|
28 #ifndef __ALSA_HWDEP_H
|
|
jpayne@69
|
29 #define __ALSA_HWDEP_H
|
|
jpayne@69
|
30
|
|
jpayne@69
|
31 #ifdef __cplusplus
|
|
jpayne@69
|
32 extern "C" {
|
|
jpayne@69
|
33 #endif
|
|
jpayne@69
|
34
|
|
jpayne@69
|
35 /**
|
|
jpayne@69
|
36 * \defgroup HwDep Hardware Dependant Interface
|
|
jpayne@69
|
37 * The Hardware Dependant Interface.
|
|
jpayne@69
|
38 * \{
|
|
jpayne@69
|
39 */
|
|
jpayne@69
|
40
|
|
jpayne@69
|
41 /** dlsym version for interface entry callback */
|
|
jpayne@69
|
42 #define SND_HWDEP_DLSYM_VERSION _dlsym_hwdep_001
|
|
jpayne@69
|
43
|
|
jpayne@69
|
44 /** HwDep information container */
|
|
jpayne@69
|
45 typedef struct _snd_hwdep_info snd_hwdep_info_t;
|
|
jpayne@69
|
46
|
|
jpayne@69
|
47 /** HwDep DSP status container */
|
|
jpayne@69
|
48 typedef struct _snd_hwdep_dsp_status snd_hwdep_dsp_status_t;
|
|
jpayne@69
|
49
|
|
jpayne@69
|
50 /** HwDep DSP image container */
|
|
jpayne@69
|
51 typedef struct _snd_hwdep_dsp_image snd_hwdep_dsp_image_t;
|
|
jpayne@69
|
52
|
|
jpayne@69
|
53 /** HwDep interface */
|
|
jpayne@69
|
54 typedef enum _snd_hwdep_iface {
|
|
jpayne@69
|
55 SND_HWDEP_IFACE_OPL2 = 0, /**< OPL2 raw driver */
|
|
jpayne@69
|
56 SND_HWDEP_IFACE_OPL3, /**< OPL3 raw driver */
|
|
jpayne@69
|
57 SND_HWDEP_IFACE_OPL4, /**< OPL4 raw driver */
|
|
jpayne@69
|
58 SND_HWDEP_IFACE_SB16CSP, /**< SB16CSP driver */
|
|
jpayne@69
|
59 SND_HWDEP_IFACE_EMU10K1, /**< EMU10K1 driver */
|
|
jpayne@69
|
60 SND_HWDEP_IFACE_YSS225, /**< YSS225 driver */
|
|
jpayne@69
|
61 SND_HWDEP_IFACE_ICS2115, /**< ICS2115 driver */
|
|
jpayne@69
|
62 SND_HWDEP_IFACE_SSCAPE, /**< Ensoniq SoundScape ISA card (MC68EC000) */
|
|
jpayne@69
|
63 SND_HWDEP_IFACE_VX, /**< Digigram VX cards */
|
|
jpayne@69
|
64 SND_HWDEP_IFACE_MIXART, /**< Digigram miXart cards */
|
|
jpayne@69
|
65 SND_HWDEP_IFACE_USX2Y, /**< Tascam US122, US224 & US428 usb */
|
|
jpayne@69
|
66 SND_HWDEP_IFACE_EMUX_WAVETABLE, /**< EmuX wavetable */
|
|
jpayne@69
|
67 SND_HWDEP_IFACE_BLUETOOTH, /**< Bluetooth audio */
|
|
jpayne@69
|
68 SND_HWDEP_IFACE_USX2Y_PCM, /**< Tascam US122, US224 & US428 raw USB PCM */
|
|
jpayne@69
|
69 SND_HWDEP_IFACE_PCXHR, /**< Digigram PCXHR */
|
|
jpayne@69
|
70 SND_HWDEP_IFACE_SB_RC, /**< SB Extigy/Audigy2NX remote control */
|
|
jpayne@69
|
71 SND_HWDEP_IFACE_HDA, /**< HD-audio */
|
|
jpayne@69
|
72 SND_HWDEP_IFACE_USB_STREAM, /**< direct access to usb stream */
|
|
jpayne@69
|
73 SND_HWDEP_IFACE_FW_DICE, /**< TC DICE FireWire device */
|
|
jpayne@69
|
74 SND_HWDEP_IFACE_FW_FIREWORKS, /**< Echo Audio Fireworks based device */
|
|
jpayne@69
|
75 SND_HWDEP_IFACE_FW_BEBOB, /**< BridgeCo BeBoB based device */
|
|
jpayne@69
|
76 SND_HWDEP_IFACE_FW_OXFW, /**< Oxford OXFW970/971 based device */
|
|
jpayne@69
|
77 SND_HWDEP_IFACE_FW_DIGI00X, /* Digidesign Digi 002/003 family */
|
|
jpayne@69
|
78 SND_HWDEP_IFACE_FW_TASCAM, /* TASCAM FireWire series */
|
|
jpayne@69
|
79 SND_HWDEP_IFACE_LINE6, /* Line6 USB processors */
|
|
jpayne@69
|
80 SND_HWDEP_IFACE_FW_MOTU, /* MOTU FireWire series */
|
|
jpayne@69
|
81 SND_HWDEP_IFACE_FW_FIREFACE, /* RME Fireface series */
|
|
jpayne@69
|
82
|
|
jpayne@69
|
83 SND_HWDEP_IFACE_LAST = SND_HWDEP_IFACE_FW_FIREFACE, /**< last known hwdep interface */
|
|
jpayne@69
|
84 } snd_hwdep_iface_t;
|
|
jpayne@69
|
85
|
|
jpayne@69
|
86 /** open for reading */
|
|
jpayne@69
|
87 #define SND_HWDEP_OPEN_READ (O_RDONLY)
|
|
jpayne@69
|
88 /** open for writing */
|
|
jpayne@69
|
89 #define SND_HWDEP_OPEN_WRITE (O_WRONLY)
|
|
jpayne@69
|
90 /** open for reading and writing */
|
|
jpayne@69
|
91 #define SND_HWDEP_OPEN_DUPLEX (O_RDWR)
|
|
jpayne@69
|
92 /** open mode flag: open in nonblock mode */
|
|
jpayne@69
|
93 #define SND_HWDEP_OPEN_NONBLOCK (O_NONBLOCK)
|
|
jpayne@69
|
94
|
|
jpayne@69
|
95 /** HwDep handle type */
|
|
jpayne@69
|
96 typedef enum _snd_hwdep_type {
|
|
jpayne@69
|
97 /** Kernel level HwDep */
|
|
jpayne@69
|
98 SND_HWDEP_TYPE_HW,
|
|
jpayne@69
|
99 /** Shared memory client HwDep (not yet implemented) */
|
|
jpayne@69
|
100 SND_HWDEP_TYPE_SHM,
|
|
jpayne@69
|
101 /** INET client HwDep (not yet implemented) */
|
|
jpayne@69
|
102 SND_HWDEP_TYPE_INET
|
|
jpayne@69
|
103 } snd_hwdep_type_t;
|
|
jpayne@69
|
104
|
|
jpayne@69
|
105 /** HwDep handle */
|
|
jpayne@69
|
106 typedef struct _snd_hwdep snd_hwdep_t;
|
|
jpayne@69
|
107
|
|
jpayne@69
|
108 int snd_hwdep_open(snd_hwdep_t **hwdep, const char *name, int mode);
|
|
jpayne@69
|
109 int snd_hwdep_close(snd_hwdep_t *hwdep);
|
|
jpayne@69
|
110 int snd_hwdep_poll_descriptors(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int space);
|
|
jpayne@69
|
111 int snd_hwdep_poll_descriptors_count(snd_hwdep_t *hwdep);
|
|
jpayne@69
|
112 int snd_hwdep_poll_descriptors_revents(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
|
|
jpayne@69
|
113 int snd_hwdep_nonblock(snd_hwdep_t *hwdep, int nonblock);
|
|
jpayne@69
|
114 int snd_hwdep_info(snd_hwdep_t *hwdep, snd_hwdep_info_t * info);
|
|
jpayne@69
|
115 int snd_hwdep_dsp_status(snd_hwdep_t *hwdep, snd_hwdep_dsp_status_t *status);
|
|
jpayne@69
|
116 int snd_hwdep_dsp_load(snd_hwdep_t *hwdep, snd_hwdep_dsp_image_t *block);
|
|
jpayne@69
|
117 int snd_hwdep_ioctl(snd_hwdep_t *hwdep, unsigned int request, void * arg);
|
|
jpayne@69
|
118 ssize_t snd_hwdep_write(snd_hwdep_t *hwdep, const void *buffer, size_t size);
|
|
jpayne@69
|
119 ssize_t snd_hwdep_read(snd_hwdep_t *hwdep, void *buffer, size_t size);
|
|
jpayne@69
|
120
|
|
jpayne@69
|
121 size_t snd_hwdep_info_sizeof(void);
|
|
jpayne@69
|
122 /** allocate #snd_hwdep_info_t container on stack */
|
|
jpayne@69
|
123 #define snd_hwdep_info_alloca(ptr) __snd_alloca(ptr, snd_hwdep_info)
|
|
jpayne@69
|
124 int snd_hwdep_info_malloc(snd_hwdep_info_t **ptr);
|
|
jpayne@69
|
125 void snd_hwdep_info_free(snd_hwdep_info_t *obj);
|
|
jpayne@69
|
126 void snd_hwdep_info_copy(snd_hwdep_info_t *dst, const snd_hwdep_info_t *src);
|
|
jpayne@69
|
127
|
|
jpayne@69
|
128 unsigned int snd_hwdep_info_get_device(const snd_hwdep_info_t *obj);
|
|
jpayne@69
|
129 int snd_hwdep_info_get_card(const snd_hwdep_info_t *obj);
|
|
jpayne@69
|
130 const char *snd_hwdep_info_get_id(const snd_hwdep_info_t *obj);
|
|
jpayne@69
|
131 const char *snd_hwdep_info_get_name(const snd_hwdep_info_t *obj);
|
|
jpayne@69
|
132 snd_hwdep_iface_t snd_hwdep_info_get_iface(const snd_hwdep_info_t *obj);
|
|
jpayne@69
|
133 void snd_hwdep_info_set_device(snd_hwdep_info_t *obj, unsigned int val);
|
|
jpayne@69
|
134
|
|
jpayne@69
|
135 size_t snd_hwdep_dsp_status_sizeof(void);
|
|
jpayne@69
|
136 /** allocate #snd_hwdep_dsp_status_t container on stack */
|
|
jpayne@69
|
137 #define snd_hwdep_dsp_status_alloca(ptr) __snd_alloca(ptr, snd_hwdep_dsp_status)
|
|
jpayne@69
|
138 int snd_hwdep_dsp_status_malloc(snd_hwdep_dsp_status_t **ptr);
|
|
jpayne@69
|
139 void snd_hwdep_dsp_status_free(snd_hwdep_dsp_status_t *obj);
|
|
jpayne@69
|
140 void snd_hwdep_dsp_status_copy(snd_hwdep_dsp_status_t *dst, const snd_hwdep_dsp_status_t *src);
|
|
jpayne@69
|
141
|
|
jpayne@69
|
142 unsigned int snd_hwdep_dsp_status_get_version(const snd_hwdep_dsp_status_t *obj);
|
|
jpayne@69
|
143 const char *snd_hwdep_dsp_status_get_id(const snd_hwdep_dsp_status_t *obj);
|
|
jpayne@69
|
144 unsigned int snd_hwdep_dsp_status_get_num_dsps(const snd_hwdep_dsp_status_t *obj);
|
|
jpayne@69
|
145 unsigned int snd_hwdep_dsp_status_get_dsp_loaded(const snd_hwdep_dsp_status_t *obj);
|
|
jpayne@69
|
146 unsigned int snd_hwdep_dsp_status_get_chip_ready(const snd_hwdep_dsp_status_t *obj);
|
|
jpayne@69
|
147
|
|
jpayne@69
|
148 size_t snd_hwdep_dsp_image_sizeof(void);
|
|
jpayne@69
|
149 /** allocate #snd_hwdep_dsp_image_t container on stack */
|
|
jpayne@69
|
150 #define snd_hwdep_dsp_image_alloca(ptr) __snd_alloca(ptr, snd_hwdep_dsp_image)
|
|
jpayne@69
|
151 int snd_hwdep_dsp_image_malloc(snd_hwdep_dsp_image_t **ptr);
|
|
jpayne@69
|
152 void snd_hwdep_dsp_image_free(snd_hwdep_dsp_image_t *obj);
|
|
jpayne@69
|
153 void snd_hwdep_dsp_image_copy(snd_hwdep_dsp_image_t *dst, const snd_hwdep_dsp_image_t *src);
|
|
jpayne@69
|
154
|
|
jpayne@69
|
155 unsigned int snd_hwdep_dsp_image_get_index(const snd_hwdep_dsp_image_t *obj);
|
|
jpayne@69
|
156 const char *snd_hwdep_dsp_image_get_name(const snd_hwdep_dsp_image_t *obj);
|
|
jpayne@69
|
157 const void *snd_hwdep_dsp_image_get_image(const snd_hwdep_dsp_image_t *obj);
|
|
jpayne@69
|
158 size_t snd_hwdep_dsp_image_get_length(const snd_hwdep_dsp_image_t *obj);
|
|
jpayne@69
|
159
|
|
jpayne@69
|
160 void snd_hwdep_dsp_image_set_index(snd_hwdep_dsp_image_t *obj, unsigned int _index);
|
|
jpayne@69
|
161 void snd_hwdep_dsp_image_set_name(snd_hwdep_dsp_image_t *obj, const char *name);
|
|
jpayne@69
|
162 void snd_hwdep_dsp_image_set_image(snd_hwdep_dsp_image_t *obj, void *buffer);
|
|
jpayne@69
|
163 void snd_hwdep_dsp_image_set_length(snd_hwdep_dsp_image_t *obj, size_t length);
|
|
jpayne@69
|
164
|
|
jpayne@69
|
165 /** \} */
|
|
jpayne@69
|
166
|
|
jpayne@69
|
167 #ifdef __cplusplus
|
|
jpayne@69
|
168 }
|
|
jpayne@69
|
169 #endif
|
|
jpayne@69
|
170
|
|
jpayne@69
|
171 #endif /* __ALSA_HWDEP_H */
|
|
jpayne@69
|
172
|
