jpayne@69: /** jpayne@69: * \file include/rawmidi.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_RAWMIDI_H jpayne@69: #define __ALSA_RAWMIDI_H jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: extern "C" { jpayne@69: #endif jpayne@69: jpayne@69: /** jpayne@69: * \defgroup RawMidi RawMidi Interface jpayne@69: * The RawMidi Interface. See \ref rawmidi page for more details. jpayne@69: * \{ jpayne@69: */ jpayne@69: jpayne@69: /** dlsym version for interface entry callback */ jpayne@69: #define SND_RAWMIDI_DLSYM_VERSION _dlsym_rawmidi_001 jpayne@69: jpayne@69: /** RawMidi information container */ jpayne@69: typedef struct _snd_rawmidi_info snd_rawmidi_info_t; jpayne@69: /** RawMidi settings container */ jpayne@69: typedef struct _snd_rawmidi_params snd_rawmidi_params_t; jpayne@69: /** RawMidi status container */ jpayne@69: typedef struct _snd_rawmidi_status snd_rawmidi_status_t; jpayne@69: jpayne@69: /** RawMidi stream (direction) */ jpayne@69: typedef enum _snd_rawmidi_stream { jpayne@69: /** Output stream */ jpayne@69: SND_RAWMIDI_STREAM_OUTPUT = 0, jpayne@69: /** Input stream */ jpayne@69: SND_RAWMIDI_STREAM_INPUT, jpayne@69: SND_RAWMIDI_STREAM_LAST = SND_RAWMIDI_STREAM_INPUT jpayne@69: } snd_rawmidi_stream_t; jpayne@69: jpayne@69: /** Append (flag to open mode) \hideinitializer */ jpayne@69: #define SND_RAWMIDI_APPEND 0x0001 jpayne@69: /** Non blocking mode (flag to open mode) \hideinitializer */ jpayne@69: #define SND_RAWMIDI_NONBLOCK 0x0002 jpayne@69: /** Write sync mode (Flag to open mode) \hideinitializer */ jpayne@69: #define SND_RAWMIDI_SYNC 0x0004 jpayne@69: jpayne@69: /** RawMidi handle */ jpayne@69: typedef struct _snd_rawmidi snd_rawmidi_t; jpayne@69: jpayne@69: /** RawMidi type */ jpayne@69: typedef enum _snd_rawmidi_type { jpayne@69: /** Kernel level RawMidi */ jpayne@69: SND_RAWMIDI_TYPE_HW, jpayne@69: /** Shared memory client RawMidi (not yet implemented) */ jpayne@69: SND_RAWMIDI_TYPE_SHM, jpayne@69: /** INET client RawMidi (not yet implemented) */ jpayne@69: SND_RAWMIDI_TYPE_INET, jpayne@69: /** Virtual (sequencer) RawMidi */ jpayne@69: SND_RAWMIDI_TYPE_VIRTUAL jpayne@69: } snd_rawmidi_type_t; jpayne@69: jpayne@69: int snd_rawmidi_open(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi, jpayne@69: const char *name, int mode); jpayne@69: int snd_rawmidi_open_lconf(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi, jpayne@69: const char *name, int mode, snd_config_t *lconf); jpayne@69: int snd_rawmidi_close(snd_rawmidi_t *rmidi); jpayne@69: int snd_rawmidi_poll_descriptors_count(snd_rawmidi_t *rmidi); jpayne@69: int snd_rawmidi_poll_descriptors(snd_rawmidi_t *rmidi, struct pollfd *pfds, unsigned int space); jpayne@69: int snd_rawmidi_poll_descriptors_revents(snd_rawmidi_t *rawmidi, struct pollfd *pfds, unsigned int nfds, unsigned short *revent); jpayne@69: int snd_rawmidi_nonblock(snd_rawmidi_t *rmidi, int nonblock); jpayne@69: size_t snd_rawmidi_info_sizeof(void); jpayne@69: /** \hideinitializer jpayne@69: * \brief allocate an invalid #snd_rawmidi_info_t using standard alloca jpayne@69: * \param ptr returned pointer jpayne@69: */ jpayne@69: #define snd_rawmidi_info_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_info) jpayne@69: int snd_rawmidi_info_malloc(snd_rawmidi_info_t **ptr); jpayne@69: void snd_rawmidi_info_free(snd_rawmidi_info_t *obj); jpayne@69: void snd_rawmidi_info_copy(snd_rawmidi_info_t *dst, const snd_rawmidi_info_t *src); jpayne@69: unsigned int snd_rawmidi_info_get_device(const snd_rawmidi_info_t *obj); jpayne@69: unsigned int snd_rawmidi_info_get_subdevice(const snd_rawmidi_info_t *obj); jpayne@69: snd_rawmidi_stream_t snd_rawmidi_info_get_stream(const snd_rawmidi_info_t *obj); jpayne@69: int snd_rawmidi_info_get_card(const snd_rawmidi_info_t *obj); jpayne@69: unsigned int snd_rawmidi_info_get_flags(const snd_rawmidi_info_t *obj); jpayne@69: const char *snd_rawmidi_info_get_id(const snd_rawmidi_info_t *obj); jpayne@69: const char *snd_rawmidi_info_get_name(const snd_rawmidi_info_t *obj); jpayne@69: const char *snd_rawmidi_info_get_subdevice_name(const snd_rawmidi_info_t *obj); jpayne@69: unsigned int snd_rawmidi_info_get_subdevices_count(const snd_rawmidi_info_t *obj); jpayne@69: unsigned int snd_rawmidi_info_get_subdevices_avail(const snd_rawmidi_info_t *obj); jpayne@69: void snd_rawmidi_info_set_device(snd_rawmidi_info_t *obj, unsigned int val); jpayne@69: void snd_rawmidi_info_set_subdevice(snd_rawmidi_info_t *obj, unsigned int val); jpayne@69: void snd_rawmidi_info_set_stream(snd_rawmidi_info_t *obj, snd_rawmidi_stream_t val); jpayne@69: int snd_rawmidi_info(snd_rawmidi_t *rmidi, snd_rawmidi_info_t * info); jpayne@69: size_t snd_rawmidi_params_sizeof(void); jpayne@69: /** \hideinitializer jpayne@69: * \brief allocate an invalid #snd_rawmidi_params_t using standard alloca jpayne@69: * \param ptr returned pointer jpayne@69: */ jpayne@69: #define snd_rawmidi_params_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_params) jpayne@69: int snd_rawmidi_params_malloc(snd_rawmidi_params_t **ptr); jpayne@69: void snd_rawmidi_params_free(snd_rawmidi_params_t *obj); jpayne@69: void snd_rawmidi_params_copy(snd_rawmidi_params_t *dst, const snd_rawmidi_params_t *src); jpayne@69: int snd_rawmidi_params_set_buffer_size(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, size_t val); jpayne@69: size_t snd_rawmidi_params_get_buffer_size(const snd_rawmidi_params_t *params); jpayne@69: int snd_rawmidi_params_set_avail_min(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, size_t val); jpayne@69: size_t snd_rawmidi_params_get_avail_min(const snd_rawmidi_params_t *params); jpayne@69: int snd_rawmidi_params_set_no_active_sensing(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, int val); jpayne@69: int snd_rawmidi_params_get_no_active_sensing(const snd_rawmidi_params_t *params); jpayne@69: int snd_rawmidi_params(snd_rawmidi_t *rmidi, snd_rawmidi_params_t * params); jpayne@69: int snd_rawmidi_params_current(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params); jpayne@69: size_t snd_rawmidi_status_sizeof(void); jpayne@69: /** \hideinitializer jpayne@69: * \brief allocate an invalid #snd_rawmidi_status_t using standard alloca jpayne@69: * \param ptr returned pointer jpayne@69: */ jpayne@69: #define snd_rawmidi_status_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_status) jpayne@69: int snd_rawmidi_status_malloc(snd_rawmidi_status_t **ptr); jpayne@69: void snd_rawmidi_status_free(snd_rawmidi_status_t *obj); jpayne@69: void snd_rawmidi_status_copy(snd_rawmidi_status_t *dst, const snd_rawmidi_status_t *src); jpayne@69: void snd_rawmidi_status_get_tstamp(const snd_rawmidi_status_t *obj, snd_htimestamp_t *ptr); jpayne@69: size_t snd_rawmidi_status_get_avail(const snd_rawmidi_status_t *obj); jpayne@69: size_t snd_rawmidi_status_get_xruns(const snd_rawmidi_status_t *obj); jpayne@69: int snd_rawmidi_status(snd_rawmidi_t *rmidi, snd_rawmidi_status_t * status); jpayne@69: int snd_rawmidi_drain(snd_rawmidi_t *rmidi); jpayne@69: int snd_rawmidi_drop(snd_rawmidi_t *rmidi); jpayne@69: ssize_t snd_rawmidi_write(snd_rawmidi_t *rmidi, const void *buffer, size_t size); jpayne@69: ssize_t snd_rawmidi_read(snd_rawmidi_t *rmidi, void *buffer, size_t size); jpayne@69: const char *snd_rawmidi_name(snd_rawmidi_t *rmidi); jpayne@69: snd_rawmidi_type_t snd_rawmidi_type(snd_rawmidi_t *rmidi); jpayne@69: snd_rawmidi_stream_t snd_rawmidi_stream(snd_rawmidi_t *rawmidi); jpayne@69: jpayne@69: /** \} */ jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: } jpayne@69: #endif jpayne@69: jpayne@69: #endif /* __RAWMIDI_H */ jpayne@69: