ALSA project - the C library reference
Macros | Typedefs | Enumerations | Functions
rawmidi.h File Reference

Application interface library for the ALSA driver. More...

Go to the source code of this file.

Macros

#define SND_RAWMIDI_DLSYM_VERSION   _dlsym_rawmidi_001
 
#define SND_RAWMIDI_APPEND
 
#define SND_RAWMIDI_NONBLOCK
 
#define SND_RAWMIDI_SYNC
 
#define snd_rawmidi_info_alloca(ptr)
 allocate an invalid snd_rawmidi_info_t using standard alloca More...
 
#define snd_rawmidi_params_alloca(ptr)
 allocate an invalid snd_rawmidi_params_t using standard alloca More...
 
#define snd_rawmidi_status_alloca(ptr)
 allocate an invalid snd_rawmidi_status_t using standard alloca More...
 

Typedefs

typedef struct _snd_rawmidi_info snd_rawmidi_info_t
 
typedef struct _snd_rawmidi_params snd_rawmidi_params_t
 
typedef struct _snd_rawmidi_status snd_rawmidi_status_t
 
typedef struct _snd_rawmidi snd_rawmidi_t
 

Enumerations

enum  snd_rawmidi_stream_t { SND_RAWMIDI_STREAM_OUTPUT = 0 , SND_RAWMIDI_STREAM_INPUT , SND_RAWMIDI_STREAM_LAST = SND_RAWMIDI_STREAM_INPUT }
 
enum  snd_rawmidi_type_t { SND_RAWMIDI_TYPE_HW , SND_RAWMIDI_TYPE_SHM , SND_RAWMIDI_TYPE_INET , SND_RAWMIDI_TYPE_VIRTUAL }
 
enum  snd_rawmidi_clock_t { SND_RAWMIDI_CLOCK_NONE = 0 , SND_RAWMIDI_CLOCK_REALTIME = 1 , SND_RAWMIDI_CLOCK_MONOTONIC = 2 , SND_RAWMIDI_CLOCK_MONOTONIC_RAW = 3 }
 
enum  snd_rawmidi_read_mode_t { SND_RAWMIDI_READ_STANDARD = 0 , SND_RAWMIDI_READ_TSTAMP = 1 }
 

Functions

int snd_rawmidi_open (snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi, const char *name, int mode)
 Opens a new connection to the RawMidi interface. More...
 
int snd_rawmidi_open_lconf (snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi, const char *name, int mode, snd_config_t *lconf)
 Opens a new connection to the RawMidi interface using local configuration. More...
 
int snd_rawmidi_close (snd_rawmidi_t *rmidi)
 close RawMidi handle More...
 
int snd_rawmidi_poll_descriptors_count (snd_rawmidi_t *rmidi)
 get count of poll descriptors for RawMidi handle More...
 
int snd_rawmidi_poll_descriptors (snd_rawmidi_t *rmidi, struct pollfd *pfds, unsigned int space)
 get poll descriptors More...
 
int snd_rawmidi_poll_descriptors_revents (snd_rawmidi_t *rawmidi, struct pollfd *pfds, unsigned int nfds, unsigned short *revent)
 get returned events from poll descriptors More...
 
int snd_rawmidi_nonblock (snd_rawmidi_t *rmidi, int nonblock)
 set nonblock mode More...
 
size_t snd_rawmidi_info_sizeof (void)
 get size of the snd_rawmidi_info_t structure in bytes More...
 
int snd_rawmidi_info_malloc (snd_rawmidi_info_t **ptr)
 allocate a new snd_rawmidi_info_t structure More...
 
void snd_rawmidi_info_free (snd_rawmidi_info_t *obj)
 frees the snd_rawmidi_info_t structure More...
 
void snd_rawmidi_info_copy (snd_rawmidi_info_t *dst, const snd_rawmidi_info_t *src)
 copy one snd_rawmidi_info_t structure to another More...
 
unsigned int snd_rawmidi_info_get_device (const snd_rawmidi_info_t *obj)
 get rawmidi device number More...
 
unsigned int snd_rawmidi_info_get_subdevice (const snd_rawmidi_info_t *obj)
 get rawmidi subdevice number More...
 
snd_rawmidi_stream_t snd_rawmidi_info_get_stream (const snd_rawmidi_info_t *obj)
 get rawmidi stream identification More...
 
int snd_rawmidi_info_get_card (const snd_rawmidi_info_t *obj)
 get rawmidi card number More...
 
unsigned int snd_rawmidi_info_get_flags (const snd_rawmidi_info_t *obj)
 get rawmidi flags More...
 
const char * snd_rawmidi_info_get_id (const snd_rawmidi_info_t *obj)
 get rawmidi hardware driver identifier More...
 
const char * snd_rawmidi_info_get_name (const snd_rawmidi_info_t *obj)
 get rawmidi hardware driver name More...
 
const char * snd_rawmidi_info_get_subdevice_name (const snd_rawmidi_info_t *obj)
 get rawmidi subdevice name More...
 
unsigned int snd_rawmidi_info_get_subdevices_count (const snd_rawmidi_info_t *obj)
 get rawmidi count of subdevices More...
 
unsigned int snd_rawmidi_info_get_subdevices_avail (const snd_rawmidi_info_t *obj)
 get rawmidi available count of subdevices More...
 
void snd_rawmidi_info_set_device (snd_rawmidi_info_t *obj, unsigned int val)
 set rawmidi device number More...
 
void snd_rawmidi_info_set_subdevice (snd_rawmidi_info_t *obj, unsigned int val)
 set rawmidi subdevice number More...
 
void snd_rawmidi_info_set_stream (snd_rawmidi_info_t *obj, snd_rawmidi_stream_t val)
 set rawmidi stream identifier More...
 
int snd_rawmidi_info (snd_rawmidi_t *rmidi, snd_rawmidi_info_t *info)
 get information about RawMidi handle More...
 
size_t snd_rawmidi_params_sizeof (void)
 get size of the snd_rawmidi_params_t structure in bytes More...
 
int snd_rawmidi_params_malloc (snd_rawmidi_params_t **ptr)
 allocate the snd_rawmidi_params_t structure More...
 
void snd_rawmidi_params_free (snd_rawmidi_params_t *obj)
 frees the snd_rawmidi_params_t structure More...
 
void snd_rawmidi_params_copy (snd_rawmidi_params_t *dst, const snd_rawmidi_params_t *src)
 copy one snd_rawmidi_params_t structure to another More...
 
int snd_rawmidi_params_set_buffer_size (snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, size_t val)
 set rawmidi I/O ring buffer size More...
 
size_t snd_rawmidi_params_get_buffer_size (const snd_rawmidi_params_t *params)
 get rawmidi I/O ring buffer size More...
 
int snd_rawmidi_params_set_avail_min (snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, size_t val)
 set minimum available bytes in rawmidi I/O ring buffer for wakeup More...
 
size_t snd_rawmidi_params_get_avail_min (const snd_rawmidi_params_t *params)
 get minimum available bytes in rawmidi I/O ring buffer for wakeup More...
 
int snd_rawmidi_params_set_no_active_sensing (snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, int val)
 set no-active-sensing action on snd_rawmidi_close() More...
 
int snd_rawmidi_params_get_no_active_sensing (const snd_rawmidi_params_t *params)
 get no-active-sensing action status More...
 
int snd_rawmidi_params_set_read_mode (const snd_rawmidi_t *rawmidi, snd_rawmidi_params_t *params, snd_rawmidi_read_mode_t val)
 set read mode More...
 
snd_rawmidi_read_mode_t snd_rawmidi_params_get_read_mode (const snd_rawmidi_params_t *params)
 get current read mode More...
 
int snd_rawmidi_params_set_clock_type (const snd_rawmidi_t *rawmidi, snd_rawmidi_params_t *params, snd_rawmidi_clock_t val)
 sets clock type for tstamp type framing More...
 
snd_rawmidi_clock_t snd_rawmidi_params_get_clock_type (const snd_rawmidi_params_t *params)
 get current clock type (for tstamp type framing) More...
 
int snd_rawmidi_params (snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params)
 set parameters about rawmidi stream More...
 
int snd_rawmidi_params_current (snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params)
 get current parameters about rawmidi stream More...
 
size_t snd_rawmidi_status_sizeof (void)
 get size of the snd_rawmidi_status_t structure in bytes More...
 
int snd_rawmidi_status_malloc (snd_rawmidi_status_t **ptr)
 allocate the snd_rawmidi_status_t structure More...
 
void snd_rawmidi_status_free (snd_rawmidi_status_t *obj)
 frees the snd_rawmidi_status_t structure More...
 
void snd_rawmidi_status_copy (snd_rawmidi_status_t *dst, const snd_rawmidi_status_t *src)
 copy one snd_rawmidi_status_t structure to another More...
 
void snd_rawmidi_status_get_tstamp (const snd_rawmidi_status_t *obj, snd_htimestamp_t *ptr)
 get the start timestamp More...
 
size_t snd_rawmidi_status_get_avail (const snd_rawmidi_status_t *obj)
 get current available bytes in the rawmidi I/O ring buffer More...
 
size_t snd_rawmidi_status_get_xruns (const snd_rawmidi_status_t *obj)
 get count of xruns More...
 
int snd_rawmidi_status (snd_rawmidi_t *rmidi, snd_rawmidi_status_t *status)
 get status of rawmidi stream More...
 
int snd_rawmidi_drain (snd_rawmidi_t *rmidi)
 drain all bytes in the rawmidi I/O ring buffer More...
 
int snd_rawmidi_drop (snd_rawmidi_t *rmidi)
 drop all bytes in the rawmidi I/O ring buffer immediately More...
 
ssize_t snd_rawmidi_write (snd_rawmidi_t *rmidi, const void *buffer, size_t size)
 write MIDI bytes to MIDI stream More...
 
ssize_t snd_rawmidi_read (snd_rawmidi_t *rmidi, void *buffer, size_t size)
 read MIDI bytes from MIDI stream More...
 
ssize_t snd_rawmidi_tread (snd_rawmidi_t *rmidi, struct timespec *tstamp, void *buffer, size_t size)
 read MIDI bytes from MIDI stream with timestamp More...
 
const char * snd_rawmidi_name (snd_rawmidi_t *rmidi)
 get identifier of RawMidi handle More...
 
snd_rawmidi_type_t snd_rawmidi_type (snd_rawmidi_t *rmidi)
 get type of RawMidi handle More...
 
snd_rawmidi_stream_t snd_rawmidi_stream (snd_rawmidi_t *rawmidi)
 get stream (direction) of RawMidi handle More...
 

Detailed Description

Application interface library for the ALSA driver.

Author
Jaroslav Kysela perex.nosp@m.@per.nosp@m.ex.cz
Abramo Bagnara abram.nosp@m.o@al.nosp@m.sa-pr.nosp@m.ojec.nosp@m.t.org
Takashi Iwai tiwai.nosp@m.@sus.nosp@m.e.de
Date
1998-2001

Application interface library for the ALSA driver