Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/alsa/hwdep.h @ 69:33d812a61356

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