hwdep.h
Go to the documentation of this file.
/*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef __ALSA_HWDEP_H
#define __ALSA_HWDEP_H
#ifdef __cplusplus
extern "C" {
#endif
#define SND_HWDEP_DLSYM_VERSION _dlsym_hwdep_001
typedef struct _snd_hwdep_info snd_hwdep_info_t;
typedef struct _snd_hwdep_dsp_status snd_hwdep_dsp_status_t;
typedef struct _snd_hwdep_dsp_image snd_hwdep_dsp_image_t;
typedef enum _snd_hwdep_iface {
SND_HWDEP_IFACE_OPL2 = 0,
SND_HWDEP_IFACE_OPL3,
SND_HWDEP_IFACE_OPL4,
SND_HWDEP_IFACE_SB16CSP,
SND_HWDEP_IFACE_EMU10K1,
SND_HWDEP_IFACE_YSS225,
SND_HWDEP_IFACE_ICS2115,
SND_HWDEP_IFACE_SSCAPE,
SND_HWDEP_IFACE_VX,
SND_HWDEP_IFACE_MIXART,
SND_HWDEP_IFACE_USX2Y,
SND_HWDEP_IFACE_EMUX_WAVETABLE,
SND_HWDEP_IFACE_BLUETOOTH,
SND_HWDEP_IFACE_USX2Y_PCM,
SND_HWDEP_IFACE_PCXHR,
SND_HWDEP_IFACE_SB_RC,
SND_HWDEP_IFACE_HDA,
SND_HWDEP_IFACE_USB_STREAM,
SND_HWDEP_IFACE_FW_DICE,
SND_HWDEP_IFACE_FW_FIREWORKS,
SND_HWDEP_IFACE_FW_BEBOB,
SND_HWDEP_IFACE_FW_OXFW,
SND_HWDEP_IFACE_FW_DIGI00X, /* Digidesign Digi 002/003 family */
SND_HWDEP_IFACE_FW_TASCAM, /* TASCAM FireWire series */
SND_HWDEP_IFACE_LINE6, /* Line6 USB processors */
SND_HWDEP_IFACE_FW_MOTU, /* MOTU FireWire series */
SND_HWDEP_IFACE_FW_FIREFACE, /* RME Fireface series */
SND_HWDEP_IFACE_LAST = SND_HWDEP_IFACE_FW_FIREFACE,
} snd_hwdep_iface_t;
#define SND_HWDEP_OPEN_READ (O_RDONLY)
#define SND_HWDEP_OPEN_WRITE (O_WRONLY)
#define SND_HWDEP_OPEN_DUPLEX (O_RDWR)
#define SND_HWDEP_OPEN_NONBLOCK (O_NONBLOCK)
typedef enum _snd_hwdep_type {
SND_HWDEP_TYPE_HW,
SND_HWDEP_TYPE_SHM,
SND_HWDEP_TYPE_INET
} snd_hwdep_type_t;
typedef struct _snd_hwdep snd_hwdep_t;
int snd_hwdep_open(snd_hwdep_t **hwdep, const char *name, int mode);
int snd_hwdep_close(snd_hwdep_t *hwdep);
int snd_hwdep_poll_descriptors(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int space);
int snd_hwdep_poll_descriptors_count(snd_hwdep_t *hwdep);
int snd_hwdep_poll_descriptors_revents(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
int snd_hwdep_nonblock(snd_hwdep_t *hwdep, int nonblock);
int snd_hwdep_info(snd_hwdep_t *hwdep, snd_hwdep_info_t * info);
int snd_hwdep_dsp_status(snd_hwdep_t *hwdep, snd_hwdep_dsp_status_t *status);
int snd_hwdep_dsp_load(snd_hwdep_t *hwdep, snd_hwdep_dsp_image_t *block);
int snd_hwdep_ioctl(snd_hwdep_t *hwdep, unsigned int request, void * arg);
ssize_t snd_hwdep_write(snd_hwdep_t *hwdep, const void *buffer, size_t size);
ssize_t snd_hwdep_read(snd_hwdep_t *hwdep, void *buffer, size_t size);
size_t snd_hwdep_info_sizeof(void);
#define snd_hwdep_info_alloca(ptr) __snd_alloca(ptr, snd_hwdep_info)
int snd_hwdep_info_malloc(snd_hwdep_info_t **ptr);
void snd_hwdep_info_free(snd_hwdep_info_t *obj);
void snd_hwdep_info_copy(snd_hwdep_info_t *dst, const snd_hwdep_info_t *src);
unsigned int snd_hwdep_info_get_device(const snd_hwdep_info_t *obj);
int snd_hwdep_info_get_card(const snd_hwdep_info_t *obj);
const char *snd_hwdep_info_get_id(const snd_hwdep_info_t *obj);
const char *snd_hwdep_info_get_name(const snd_hwdep_info_t *obj);
snd_hwdep_iface_t snd_hwdep_info_get_iface(const snd_hwdep_info_t *obj);
void snd_hwdep_info_set_device(snd_hwdep_info_t *obj, unsigned int val);
size_t snd_hwdep_dsp_status_sizeof(void);
#define snd_hwdep_dsp_status_alloca(ptr) __snd_alloca(ptr, snd_hwdep_dsp_status)
int snd_hwdep_dsp_status_malloc(snd_hwdep_dsp_status_t **ptr);
void snd_hwdep_dsp_status_free(snd_hwdep_dsp_status_t *obj);
void snd_hwdep_dsp_status_copy(snd_hwdep_dsp_status_t *dst, const snd_hwdep_dsp_status_t *src);
unsigned int snd_hwdep_dsp_status_get_version(const snd_hwdep_dsp_status_t *obj);
const char *snd_hwdep_dsp_status_get_id(const snd_hwdep_dsp_status_t *obj);
unsigned int snd_hwdep_dsp_status_get_num_dsps(const snd_hwdep_dsp_status_t *obj);
unsigned int snd_hwdep_dsp_status_get_dsp_loaded(const snd_hwdep_dsp_status_t *obj);
unsigned int snd_hwdep_dsp_status_get_chip_ready(const snd_hwdep_dsp_status_t *obj);
size_t snd_hwdep_dsp_image_sizeof(void);
#define snd_hwdep_dsp_image_alloca(ptr) __snd_alloca(ptr, snd_hwdep_dsp_image)
int snd_hwdep_dsp_image_malloc(snd_hwdep_dsp_image_t **ptr);
void snd_hwdep_dsp_image_free(snd_hwdep_dsp_image_t *obj);
void snd_hwdep_dsp_image_copy(snd_hwdep_dsp_image_t *dst, const snd_hwdep_dsp_image_t *src);
unsigned int snd_hwdep_dsp_image_get_index(const snd_hwdep_dsp_image_t *obj);
const char *snd_hwdep_dsp_image_get_name(const snd_hwdep_dsp_image_t *obj);
const void *snd_hwdep_dsp_image_get_image(const snd_hwdep_dsp_image_t *obj);
size_t snd_hwdep_dsp_image_get_length(const snd_hwdep_dsp_image_t *obj);
void snd_hwdep_dsp_image_set_index(snd_hwdep_dsp_image_t *obj, unsigned int _index);
void snd_hwdep_dsp_image_set_name(snd_hwdep_dsp_image_t *obj, const char *name);
void snd_hwdep_dsp_image_set_image(snd_hwdep_dsp_image_t *obj, void *buffer);
void snd_hwdep_dsp_image_set_length(snd_hwdep_dsp_image_t *obj, size_t length);
#ifdef __cplusplus
}
#endif
#endif /* __ALSA_HWDEP_H */
snd_hwdep_dsp_image_t
struct _snd_hwdep_dsp_image snd_hwdep_dsp_image_t
Definition: hwdep.h:51
snd_hwdep_dsp_status_t
struct _snd_hwdep_dsp_status snd_hwdep_dsp_status_t
Definition: hwdep.h:48
snd_hwdep_dsp_image_set_length
void snd_hwdep_dsp_image_set_length(snd_hwdep_dsp_image_t *obj, size_t length)
set the DSP block length
Definition: hwdep.c:749
SND_HWDEP_IFACE_SSCAPE
@ SND_HWDEP_IFACE_SSCAPE
Definition: hwdep.h:62
SND_HWDEP_IFACE_ICS2115
@ SND_HWDEP_IFACE_ICS2115
Definition: hwdep.h:61
snd_hwdep_read
ssize_t snd_hwdep_read(snd_hwdep_t *hwdep, void *buffer, size_t size)
read bytes using HwDep handle
Definition: hwdep.c:488
snd_hwdep_dsp_image_malloc
int snd_hwdep_dsp_image_malloc(snd_hwdep_dsp_image_t **ptr)
allocate a new snd_hwdep_dsp_image_t structure
Definition: hwdep.c:644
SND_HWDEP_IFACE_BLUETOOTH
@ SND_HWDEP_IFACE_BLUETOOTH
Definition: hwdep.h:67
snd_hwdep_dsp_load
int snd_hwdep_dsp_load(snd_hwdep_t *hwdep, snd_hwdep_dsp_image_t *block)
load the DSP block
Definition: hwdep.c:515
SND_HWDEP_IFACE_FW_FIREWORKS
@ SND_HWDEP_IFACE_FW_FIREWORKS
Definition: hwdep.h:74
snd_hwdep_dsp_image_sizeof
size_t snd_hwdep_dsp_image_sizeof(void)
get size of the snd_hwdep_dsp_image_t structure in bytes
Definition: hwdep.c:631
snd_hwdep_dsp_status_copy
void snd_hwdep_dsp_status_copy(snd_hwdep_dsp_status_t *dst, const snd_hwdep_dsp_status_t *src)
copy one snd_hwdep_dsp_status_t structure to another
Definition: hwdep.c:566
snd_hwdep_dsp_image_copy
void snd_hwdep_dsp_image_copy(snd_hwdep_dsp_image_t *dst, const snd_hwdep_dsp_image_t *src)
copy one snd_hwdep_dsp_image_t structure to another
Definition: hwdep.c:671
snd_hwdep_poll_descriptors_count
int snd_hwdep_poll_descriptors_count(snd_hwdep_t *hwdep)
get count of poll descriptors for HwDep handle
Definition: hwdep.c:253
snd_hwdep_dsp_status_get_id
const char * snd_hwdep_dsp_status_get_id(const snd_hwdep_dsp_status_t *obj)
get the driver id of dsp loader
Definition: hwdep.c:588
SND_HWDEP_IFACE_VX
@ SND_HWDEP_IFACE_VX
Definition: hwdep.h:63
snd_hwdep_poll_descriptors_revents
int snd_hwdep_poll_descriptors_revents(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int nfds, unsigned short *revents)
get returned events from poll descriptors
Definition: hwdep.c:297
SND_HWDEP_IFACE_LAST
@ SND_HWDEP_IFACE_LAST
Definition: hwdep.h:83
snd_hwdep_dsp_status_get_num_dsps
unsigned int snd_hwdep_dsp_status_get_num_dsps(const snd_hwdep_dsp_status_t *obj)
get number of dsp blocks
Definition: hwdep.c:599
snd_hwdep_dsp_image_free
void snd_hwdep_dsp_image_free(snd_hwdep_dsp_image_t *obj)
frees the snd_hwdep_dsp_image_t structure
Definition: hwdep.c:660
snd_hwdep_dsp_status_get_version
unsigned int snd_hwdep_dsp_status_get_version(const snd_hwdep_dsp_status_t *obj)
get the driver version of dsp loader
Definition: hwdep.c:577
SND_HWDEP_IFACE_OPL2
@ SND_HWDEP_IFACE_OPL2
Definition: hwdep.h:55
snd_hwdep_dsp_image_get_index
unsigned int snd_hwdep_dsp_image_get_index(const snd_hwdep_dsp_image_t *obj)
get the DSP block index
Definition: hwdep.c:682
SND_HWDEP_IFACE_OPL3
@ SND_HWDEP_IFACE_OPL3
Definition: hwdep.h:56
SND_HWDEP_IFACE_FW_DICE
@ SND_HWDEP_IFACE_FW_DICE
Definition: hwdep.h:73
snd_hwdep_info_copy
void snd_hwdep_info_copy(snd_hwdep_info_t *dst, const snd_hwdep_info_t *src)
copy one snd_hwdep_info_t structure to another
Definition: hwdep.c:370
snd_hwdep_dsp_status_get_dsp_loaded
unsigned int snd_hwdep_dsp_status_get_dsp_loaded(const snd_hwdep_dsp_status_t *obj)
get the bit flags of the loaded dsp blocks
Definition: hwdep.c:610
snd_hwdep_nonblock
int snd_hwdep_nonblock(snd_hwdep_t *hwdep, int nonblock)
set nonblock mode
Definition: hwdep.c:313
SND_HWDEP_TYPE_INET
@ SND_HWDEP_TYPE_INET
Definition: hwdep.h:102
snd_hwdep_info
int snd_hwdep_info(snd_hwdep_t *hwdep, snd_hwdep_info_t *info)
get information about HwDep handle
Definition: hwdep.c:448
snd_hwdep_poll_descriptors
int snd_hwdep_poll_descriptors(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int space)
get poll descriptors
Definition: hwdep.c:266
SND_HWDEP_IFACE_USB_STREAM
@ SND_HWDEP_IFACE_USB_STREAM
Definition: hwdep.h:72
SND_HWDEP_IFACE_MIXART
@ SND_HWDEP_IFACE_MIXART
Definition: hwdep.h:64
snd_hwdep_ioctl
int snd_hwdep_ioctl(snd_hwdep_t *hwdep, unsigned int request, void *arg)
do hardware dependent ioctl
Definition: hwdep.c:462
snd_hwdep_info_sizeof
size_t snd_hwdep_info_sizeof(void)
get size of the snd_hwdep_info_t structure in bytes
Definition: hwdep.c:330
snd_hwdep_dsp_image_set_index
void snd_hwdep_dsp_image_set_index(snd_hwdep_dsp_image_t *obj, unsigned int _index)
set the DSP block index
Definition: hwdep.c:726
SND_HWDEP_TYPE_HW
@ SND_HWDEP_TYPE_HW
Definition: hwdep.h:98
snd_hwdep_t
struct _snd_hwdep snd_hwdep_t
Definition: hwdep.h:106
snd_hwdep_info_free
void snd_hwdep_info_free(snd_hwdep_info_t *obj)
frees the snd_hwdep_info_t structure
Definition: hwdep.c:359
snd_hwdep_type_t
snd_hwdep_type_t
Definition: hwdep.h:96
snd_hwdep_info_get_device
unsigned int snd_hwdep_info_get_device(const snd_hwdep_info_t *obj)
get hwdep device number
Definition: hwdep.c:392
SND_HWDEP_IFACE_YSS225
@ SND_HWDEP_IFACE_YSS225
Definition: hwdep.h:60
snd_hwdep_dsp_status_free
void snd_hwdep_dsp_status_free(snd_hwdep_dsp_status_t *obj)
frees the snd_hwdep_dsp_status_t structure
Definition: hwdep.c:555
snd_hwdep_iface_t
snd_hwdep_iface_t
Definition: hwdep.h:54
snd_hwdep_open
int snd_hwdep_open(snd_hwdep_t **hwdep, const char *name, int mode)
Opens a new connection to the HwDep interface.
Definition: hwdep.c:169
snd_hwdep_dsp_image_set_image
void snd_hwdep_dsp_image_set_image(snd_hwdep_dsp_image_t *obj, void *buffer)
set the DSP block image pointer
Definition: hwdep.c:760
snd_hwdep_info_get_id
const char * snd_hwdep_info_get_id(const snd_hwdep_info_t *obj)
get hwdep driver identifier
Definition: hwdep.c:403
snd_hwdep_info_get_name
const char * snd_hwdep_info_get_name(const snd_hwdep_info_t *obj)
get hwdep driver name
Definition: hwdep.c:414
ptr
void * ptr
Definition: seq_event.h:1
snd_hwdep_write
ssize_t snd_hwdep_write(snd_hwdep_t *hwdep, const void *buffer, size_t size)
write bytes using HwDep handle
Definition: hwdep.c:474
snd_hwdep_info_get_iface
snd_hwdep_iface_t snd_hwdep_info_get_iface(const snd_hwdep_info_t *obj)
get hwdep protocol interface
Definition: hwdep.c:425
snd_hwdep_dsp_status_get_chip_ready
unsigned int snd_hwdep_dsp_status_get_chip_ready(const snd_hwdep_dsp_status_t *obj)
get the chip status of dsp loader
Definition: hwdep.c:621
snd_hwdep_info_get_card
int snd_hwdep_info_get_card(const snd_hwdep_info_t *obj)
get hwdep card number
Definition: hwdep.c:381
SND_HWDEP_IFACE_HDA
@ SND_HWDEP_IFACE_HDA
Definition: hwdep.h:71
snd_hwdep_info_set_device
void snd_hwdep_info_set_device(snd_hwdep_info_t *obj, unsigned int val)
set hwdep device number
Definition: hwdep.c:436
SND_HWDEP_IFACE_FW_OXFW
@ SND_HWDEP_IFACE_FW_OXFW
Definition: hwdep.h:76
snd_hwdep_dsp_status
int snd_hwdep_dsp_status(snd_hwdep_t *hwdep, snd_hwdep_dsp_status_t *status)
get the DSP status information
Definition: hwdep.c:502
SND_HWDEP_IFACE_USX2Y
@ SND_HWDEP_IFACE_USX2Y
Definition: hwdep.h:65
snd_hwdep_dsp_image_get_length
size_t snd_hwdep_dsp_image_get_length(const snd_hwdep_dsp_image_t *obj)
get the length of the DSP block
Definition: hwdep.c:704
SND_HWDEP_TYPE_SHM
@ SND_HWDEP_TYPE_SHM
Definition: hwdep.h:100
snd_hwdep_info_malloc
int snd_hwdep_info_malloc(snd_hwdep_info_t **ptr)
allocate a new snd_hwdep_info_t structure
Definition: hwdep.c:343
snd_hwdep_dsp_status_malloc
int snd_hwdep_dsp_status_malloc(snd_hwdep_dsp_status_t **ptr)
allocate a new snd_hwdep_dsp_status_t structure
Definition: hwdep.c:539
snd_hwdep_close
int snd_hwdep_close(snd_hwdep_t *hwdep)
close HwDep handle
Definition: hwdep.c:209
SND_HWDEP_IFACE_SB_RC
@ SND_HWDEP_IFACE_SB_RC
Definition: hwdep.h:70
snd_hwdep_info_t
struct _snd_hwdep_info snd_hwdep_info_t
Definition: hwdep.h:45
snd_hwdep_dsp_status_sizeof
size_t snd_hwdep_dsp_status_sizeof(void)
get size of the snd_hwdep_dsp_status_t structure in bytes
Definition: hwdep.c:526
snd_hwdep_dsp_image_set_name
void snd_hwdep_dsp_image_set_name(snd_hwdep_dsp_image_t *obj, const char *name)
set the name of the DSP block
Definition: hwdep.c:737
SND_HWDEP_IFACE_EMU10K1
@ SND_HWDEP_IFACE_EMU10K1
Definition: hwdep.h:59
SND_HWDEP_IFACE_FW_BEBOB
@ SND_HWDEP_IFACE_FW_BEBOB
Definition: hwdep.h:75
SND_HWDEP_IFACE_PCXHR
@ SND_HWDEP_IFACE_PCXHR
Definition: hwdep.h:69
snd_hwdep_dsp_image_get_image
const void * snd_hwdep_dsp_image_get_image(const snd_hwdep_dsp_image_t *obj)
get the image pointer of the DSP block
Definition: hwdep.c:715
SND_HWDEP_IFACE_EMUX_WAVETABLE
@ SND_HWDEP_IFACE_EMUX_WAVETABLE
Definition: hwdep.h:66
snd_hwdep_dsp_image_get_name
const char * snd_hwdep_dsp_image_get_name(const snd_hwdep_dsp_image_t *obj)
get the name of the DSP block
Definition: hwdep.c:693
SND_HWDEP_IFACE_OPL4
@ SND_HWDEP_IFACE_OPL4
Definition: hwdep.h:57
SND_HWDEP_IFACE_SB16CSP
@ SND_HWDEP_IFACE_SB16CSP
Definition: hwdep.h:58
SND_HWDEP_IFACE_USX2Y_PCM
@ SND_HWDEP_IFACE_USX2Y_PCM
Definition: hwdep.h:68