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
 *
 */
 
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/hwdep.h> should not be used directly"
#include <alsa/asoundlib.h>
#endif
 
#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 */