jpayne@69: /** jpayne@69: * \file include/hwdep.h jpayne@69: * \brief Application interface library for the ALSA driver jpayne@69: * \author Jaroslav Kysela jpayne@69: * \author Abramo Bagnara jpayne@69: * \author Takashi Iwai jpayne@69: * \date 1998-2001 jpayne@69: * jpayne@69: * Application interface library for the ALSA driver jpayne@69: */ jpayne@69: /* jpayne@69: * This library is free software; you can redistribute it and/or modify jpayne@69: * it under the terms of the GNU Lesser General Public License as jpayne@69: * published by the Free Software Foundation; either version 2.1 of jpayne@69: * the License, or (at your option) any later version. jpayne@69: * jpayne@69: * This program is distributed in the hope that it will be useful, jpayne@69: * but WITHOUT ANY WARRANTY; without even the implied warranty of jpayne@69: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the jpayne@69: * GNU Lesser General Public License for more details. jpayne@69: * jpayne@69: * You should have received a copy of the GNU Lesser General Public jpayne@69: * License along with this library; if not, write to the Free Software jpayne@69: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA jpayne@69: * jpayne@69: */ jpayne@69: jpayne@69: #ifndef __ALSA_HWDEP_H jpayne@69: #define __ALSA_HWDEP_H jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: extern "C" { jpayne@69: #endif jpayne@69: jpayne@69: /** jpayne@69: * \defgroup HwDep Hardware Dependant Interface jpayne@69: * The Hardware Dependant Interface. jpayne@69: * \{ jpayne@69: */ jpayne@69: jpayne@69: /** dlsym version for interface entry callback */ jpayne@69: #define SND_HWDEP_DLSYM_VERSION _dlsym_hwdep_001 jpayne@69: jpayne@69: /** HwDep information container */ jpayne@69: typedef struct _snd_hwdep_info snd_hwdep_info_t; jpayne@69: jpayne@69: /** HwDep DSP status container */ jpayne@69: typedef struct _snd_hwdep_dsp_status snd_hwdep_dsp_status_t; jpayne@69: jpayne@69: /** HwDep DSP image container */ jpayne@69: typedef struct _snd_hwdep_dsp_image snd_hwdep_dsp_image_t; jpayne@69: jpayne@69: /** HwDep interface */ jpayne@69: typedef enum _snd_hwdep_iface { jpayne@69: SND_HWDEP_IFACE_OPL2 = 0, /**< OPL2 raw driver */ jpayne@69: SND_HWDEP_IFACE_OPL3, /**< OPL3 raw driver */ jpayne@69: SND_HWDEP_IFACE_OPL4, /**< OPL4 raw driver */ jpayne@69: SND_HWDEP_IFACE_SB16CSP, /**< SB16CSP driver */ jpayne@69: SND_HWDEP_IFACE_EMU10K1, /**< EMU10K1 driver */ jpayne@69: SND_HWDEP_IFACE_YSS225, /**< YSS225 driver */ jpayne@69: SND_HWDEP_IFACE_ICS2115, /**< ICS2115 driver */ jpayne@69: SND_HWDEP_IFACE_SSCAPE, /**< Ensoniq SoundScape ISA card (MC68EC000) */ jpayne@69: SND_HWDEP_IFACE_VX, /**< Digigram VX cards */ jpayne@69: SND_HWDEP_IFACE_MIXART, /**< Digigram miXart cards */ jpayne@69: SND_HWDEP_IFACE_USX2Y, /**< Tascam US122, US224 & US428 usb */ jpayne@69: SND_HWDEP_IFACE_EMUX_WAVETABLE, /**< EmuX wavetable */ jpayne@69: SND_HWDEP_IFACE_BLUETOOTH, /**< Bluetooth audio */ jpayne@69: SND_HWDEP_IFACE_USX2Y_PCM, /**< Tascam US122, US224 & US428 raw USB PCM */ jpayne@69: SND_HWDEP_IFACE_PCXHR, /**< Digigram PCXHR */ jpayne@69: SND_HWDEP_IFACE_SB_RC, /**< SB Extigy/Audigy2NX remote control */ jpayne@69: SND_HWDEP_IFACE_HDA, /**< HD-audio */ jpayne@69: SND_HWDEP_IFACE_USB_STREAM, /**< direct access to usb stream */ jpayne@69: SND_HWDEP_IFACE_FW_DICE, /**< TC DICE FireWire device */ jpayne@69: SND_HWDEP_IFACE_FW_FIREWORKS, /**< Echo Audio Fireworks based device */ jpayne@69: SND_HWDEP_IFACE_FW_BEBOB, /**< BridgeCo BeBoB based device */ jpayne@69: SND_HWDEP_IFACE_FW_OXFW, /**< Oxford OXFW970/971 based device */ jpayne@69: SND_HWDEP_IFACE_FW_DIGI00X, /* Digidesign Digi 002/003 family */ jpayne@69: SND_HWDEP_IFACE_FW_TASCAM, /* TASCAM FireWire series */ jpayne@69: SND_HWDEP_IFACE_LINE6, /* Line6 USB processors */ jpayne@69: SND_HWDEP_IFACE_FW_MOTU, /* MOTU FireWire series */ jpayne@69: SND_HWDEP_IFACE_FW_FIREFACE, /* RME Fireface series */ jpayne@69: jpayne@69: SND_HWDEP_IFACE_LAST = SND_HWDEP_IFACE_FW_FIREFACE, /**< last known hwdep interface */ jpayne@69: } snd_hwdep_iface_t; jpayne@69: jpayne@69: /** open for reading */ jpayne@69: #define SND_HWDEP_OPEN_READ (O_RDONLY) jpayne@69: /** open for writing */ jpayne@69: #define SND_HWDEP_OPEN_WRITE (O_WRONLY) jpayne@69: /** open for reading and writing */ jpayne@69: #define SND_HWDEP_OPEN_DUPLEX (O_RDWR) jpayne@69: /** open mode flag: open in nonblock mode */ jpayne@69: #define SND_HWDEP_OPEN_NONBLOCK (O_NONBLOCK) jpayne@69: jpayne@69: /** HwDep handle type */ jpayne@69: typedef enum _snd_hwdep_type { jpayne@69: /** Kernel level HwDep */ jpayne@69: SND_HWDEP_TYPE_HW, jpayne@69: /** Shared memory client HwDep (not yet implemented) */ jpayne@69: SND_HWDEP_TYPE_SHM, jpayne@69: /** INET client HwDep (not yet implemented) */ jpayne@69: SND_HWDEP_TYPE_INET jpayne@69: } snd_hwdep_type_t; jpayne@69: jpayne@69: /** HwDep handle */ jpayne@69: typedef struct _snd_hwdep snd_hwdep_t; jpayne@69: jpayne@69: int snd_hwdep_open(snd_hwdep_t **hwdep, const char *name, int mode); jpayne@69: int snd_hwdep_close(snd_hwdep_t *hwdep); jpayne@69: int snd_hwdep_poll_descriptors(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int space); jpayne@69: int snd_hwdep_poll_descriptors_count(snd_hwdep_t *hwdep); jpayne@69: int snd_hwdep_poll_descriptors_revents(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int nfds, unsigned short *revents); jpayne@69: int snd_hwdep_nonblock(snd_hwdep_t *hwdep, int nonblock); jpayne@69: int snd_hwdep_info(snd_hwdep_t *hwdep, snd_hwdep_info_t * info); jpayne@69: int snd_hwdep_dsp_status(snd_hwdep_t *hwdep, snd_hwdep_dsp_status_t *status); jpayne@69: int snd_hwdep_dsp_load(snd_hwdep_t *hwdep, snd_hwdep_dsp_image_t *block); jpayne@69: int snd_hwdep_ioctl(snd_hwdep_t *hwdep, unsigned int request, void * arg); jpayne@69: ssize_t snd_hwdep_write(snd_hwdep_t *hwdep, const void *buffer, size_t size); jpayne@69: ssize_t snd_hwdep_read(snd_hwdep_t *hwdep, void *buffer, size_t size); jpayne@69: jpayne@69: size_t snd_hwdep_info_sizeof(void); jpayne@69: /** allocate #snd_hwdep_info_t container on stack */ jpayne@69: #define snd_hwdep_info_alloca(ptr) __snd_alloca(ptr, snd_hwdep_info) jpayne@69: int snd_hwdep_info_malloc(snd_hwdep_info_t **ptr); jpayne@69: void snd_hwdep_info_free(snd_hwdep_info_t *obj); jpayne@69: void snd_hwdep_info_copy(snd_hwdep_info_t *dst, const snd_hwdep_info_t *src); jpayne@69: jpayne@69: unsigned int snd_hwdep_info_get_device(const snd_hwdep_info_t *obj); jpayne@69: int snd_hwdep_info_get_card(const snd_hwdep_info_t *obj); jpayne@69: const char *snd_hwdep_info_get_id(const snd_hwdep_info_t *obj); jpayne@69: const char *snd_hwdep_info_get_name(const snd_hwdep_info_t *obj); jpayne@69: snd_hwdep_iface_t snd_hwdep_info_get_iface(const snd_hwdep_info_t *obj); jpayne@69: void snd_hwdep_info_set_device(snd_hwdep_info_t *obj, unsigned int val); jpayne@69: jpayne@69: size_t snd_hwdep_dsp_status_sizeof(void); jpayne@69: /** allocate #snd_hwdep_dsp_status_t container on stack */ jpayne@69: #define snd_hwdep_dsp_status_alloca(ptr) __snd_alloca(ptr, snd_hwdep_dsp_status) jpayne@69: int snd_hwdep_dsp_status_malloc(snd_hwdep_dsp_status_t **ptr); jpayne@69: void snd_hwdep_dsp_status_free(snd_hwdep_dsp_status_t *obj); jpayne@69: void snd_hwdep_dsp_status_copy(snd_hwdep_dsp_status_t *dst, const snd_hwdep_dsp_status_t *src); jpayne@69: jpayne@69: unsigned int snd_hwdep_dsp_status_get_version(const snd_hwdep_dsp_status_t *obj); jpayne@69: const char *snd_hwdep_dsp_status_get_id(const snd_hwdep_dsp_status_t *obj); jpayne@69: unsigned int snd_hwdep_dsp_status_get_num_dsps(const snd_hwdep_dsp_status_t *obj); jpayne@69: unsigned int snd_hwdep_dsp_status_get_dsp_loaded(const snd_hwdep_dsp_status_t *obj); jpayne@69: unsigned int snd_hwdep_dsp_status_get_chip_ready(const snd_hwdep_dsp_status_t *obj); jpayne@69: jpayne@69: size_t snd_hwdep_dsp_image_sizeof(void); jpayne@69: /** allocate #snd_hwdep_dsp_image_t container on stack */ jpayne@69: #define snd_hwdep_dsp_image_alloca(ptr) __snd_alloca(ptr, snd_hwdep_dsp_image) jpayne@69: int snd_hwdep_dsp_image_malloc(snd_hwdep_dsp_image_t **ptr); jpayne@69: void snd_hwdep_dsp_image_free(snd_hwdep_dsp_image_t *obj); jpayne@69: void snd_hwdep_dsp_image_copy(snd_hwdep_dsp_image_t *dst, const snd_hwdep_dsp_image_t *src); jpayne@69: jpayne@69: unsigned int snd_hwdep_dsp_image_get_index(const snd_hwdep_dsp_image_t *obj); jpayne@69: const char *snd_hwdep_dsp_image_get_name(const snd_hwdep_dsp_image_t *obj); jpayne@69: const void *snd_hwdep_dsp_image_get_image(const snd_hwdep_dsp_image_t *obj); jpayne@69: size_t snd_hwdep_dsp_image_get_length(const snd_hwdep_dsp_image_t *obj); jpayne@69: jpayne@69: void snd_hwdep_dsp_image_set_index(snd_hwdep_dsp_image_t *obj, unsigned int _index); jpayne@69: void snd_hwdep_dsp_image_set_name(snd_hwdep_dsp_image_t *obj, const char *name); jpayne@69: void snd_hwdep_dsp_image_set_image(snd_hwdep_dsp_image_t *obj, void *buffer); jpayne@69: void snd_hwdep_dsp_image_set_length(snd_hwdep_dsp_image_t *obj, size_t length); jpayne@69: jpayne@69: /** \} */ jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: } jpayne@69: #endif jpayne@69: jpayne@69: #endif /* __ALSA_HWDEP_H */ jpayne@69: