ALSA project - the C library reference
rawmidi.h
Go to the documentation of this file.
1 
11 /*
12  * This library is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU Lesser General Public License as
14  * published by the Free Software Foundation; either version 2.1 of
15  * the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25  *
26  */
27 
28 #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
29 /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
30 #warning "use #include <alsa/asoundlib.h>, <alsa/rawmidi.h> should not be used directly"
31 #include <alsa/asoundlib.h>
32 #endif
33 
34 #ifndef __ALSA_RAWMIDI_H
35 #define __ALSA_RAWMIDI_H
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
48 #define SND_RAWMIDI_DLSYM_VERSION _dlsym_rawmidi_001
49 
51 typedef struct _snd_rawmidi_info snd_rawmidi_info_t;
53 typedef struct _snd_rawmidi_params snd_rawmidi_params_t;
55 typedef struct _snd_rawmidi_status snd_rawmidi_status_t;
56 
58 typedef enum _snd_rawmidi_stream {
63  SND_RAWMIDI_STREAM_LAST = SND_RAWMIDI_STREAM_INPUT
65 
67 #define SND_RAWMIDI_APPEND 0x0001
69 #define SND_RAWMIDI_NONBLOCK 0x0002
71 #define SND_RAWMIDI_SYNC 0x0004
72 
74 typedef struct _snd_rawmidi snd_rawmidi_t;
75 
77 typedef enum _snd_rawmidi_type {
87 
89 typedef enum _snd_rawmidi_clock {
90  SND_RAWMIDI_CLOCK_NONE = 0,
91  SND_RAWMIDI_CLOCK_REALTIME = 1,
92  SND_RAWMIDI_CLOCK_MONOTONIC = 2,
93  SND_RAWMIDI_CLOCK_MONOTONIC_RAW = 3,
95 
97 typedef enum _snd_rawmidi_read_mode {
98  SND_RAWMIDI_READ_STANDARD = 0,
99  SND_RAWMIDI_READ_TSTAMP = 1,
101 
103 #define SND_RAWMIDI_INFO_UMP 0x00000008
104 #define SNDRV_RAWMIDI_INFO_STREAM_INACTIVE 0x00000010
106 int snd_rawmidi_open(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi,
107  const char *name, int mode);
108 int snd_rawmidi_open_lconf(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi,
109  const char *name, int mode, snd_config_t *lconf);
110 int snd_rawmidi_close(snd_rawmidi_t *rmidi);
112 int snd_rawmidi_poll_descriptors(snd_rawmidi_t *rmidi, struct pollfd *pfds, unsigned int space);
113 int snd_rawmidi_poll_descriptors_revents(snd_rawmidi_t *rawmidi, struct pollfd *pfds, unsigned int nfds, unsigned short *revent);
114 int snd_rawmidi_nonblock(snd_rawmidi_t *rmidi, int nonblock);
115 size_t snd_rawmidi_info_sizeof(void);
120 #define snd_rawmidi_info_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_info)
124 unsigned int snd_rawmidi_info_get_device(const snd_rawmidi_info_t *obj);
125 unsigned int snd_rawmidi_info_get_subdevice(const snd_rawmidi_info_t *obj);
128 unsigned int snd_rawmidi_info_get_flags(const snd_rawmidi_info_t *obj);
129 const char *snd_rawmidi_info_get_id(const snd_rawmidi_info_t *obj);
130 const char *snd_rawmidi_info_get_name(const snd_rawmidi_info_t *obj);
135 void snd_rawmidi_info_set_device(snd_rawmidi_info_t *obj, unsigned int val);
136 void snd_rawmidi_info_set_subdevice(snd_rawmidi_info_t *obj, unsigned int val);
139 size_t snd_rawmidi_params_sizeof(void);
144 #define snd_rawmidi_params_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_params)
158 
161 size_t snd_rawmidi_status_sizeof(void);
166 #define snd_rawmidi_status_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_status)
174 int snd_rawmidi_drain(snd_rawmidi_t *rmidi);
175 int snd_rawmidi_drop(snd_rawmidi_t *rmidi);
176 ssize_t snd_rawmidi_write(snd_rawmidi_t *rmidi, const void *buffer, size_t size);
177 ssize_t snd_rawmidi_read(snd_rawmidi_t *rmidi, void *buffer, size_t size);
178 ssize_t snd_rawmidi_tread(snd_rawmidi_t *rmidi, struct timespec *tstamp, void *buffer, size_t size);
179 const char *snd_rawmidi_name(snd_rawmidi_t *rmidi);
182 
185 #ifdef __cplusplus
186 }
187 #endif
188 
189 #endif /* __RAWMIDI_H */
190 
struct _snd_config snd_config_t
Internal structure for a configuration node object.
Definition: conf.h:74
struct timespec snd_htimestamp_t
Definition: global.h:157
int snd_rawmidi_drop(snd_rawmidi_t *rmidi)
drop all bytes in the rawmidi I/O ring buffer immediately
Definition: rawmidi.c:1070
ssize_t snd_rawmidi_write(snd_rawmidi_t *rmidi, const void *buffer, size_t size)
write MIDI bytes to MIDI stream
Definition: rawmidi.c:1096
size_t snd_rawmidi_params_get_buffer_size(const snd_rawmidi_params_t *params)
get rawmidi I/O ring buffer size
Definition: rawmidi.c:778
struct _snd_rawmidi_status snd_rawmidi_status_t
Definition: rawmidi.h:55
int snd_rawmidi_info_malloc(snd_rawmidi_info_t **ptr)
allocate a new snd_rawmidi_info_t structure
Definition: rawmidi.c:499
snd_rawmidi_clock_t
Definition: rawmidi.h:89
int snd_rawmidi_poll_descriptors(snd_rawmidi_t *rmidi, struct pollfd *pfds, unsigned int space)
get poll descriptors
Definition: rawmidi.c:430
snd_rawmidi_type_t
Definition: rawmidi.h:77
snd_rawmidi_stream_t snd_rawmidi_stream(snd_rawmidi_t *rawmidi)
get stream (direction) of RawMidi handle
Definition: rawmidi.c:406
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.
Definition: rawmidi.c:312
size_t snd_rawmidi_info_sizeof(void)
get size of the snd_rawmidi_info_t structure in bytes
Definition: rawmidi.c:486
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
Definition: rawmidi.c:449
int snd_rawmidi_poll_descriptors_count(snd_rawmidi_t *rmidi)
get count of poll descriptors for RawMidi handle
Definition: rawmidi.c:417
int snd_rawmidi_info(snd_rawmidi_t *rmidi, snd_rawmidi_info_t *info)
get information about RawMidi handle
Definition: rawmidi.c:697
unsigned int snd_rawmidi_info_get_subdevice(const snd_rawmidi_info_t *obj)
get rawmidi subdevice number
Definition: rawmidi.c:548
const char * snd_rawmidi_info_get_subdevice_name(const snd_rawmidi_info_t *obj)
get rawmidi subdevice name
Definition: rawmidi.c:614
int snd_rawmidi_params(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params)
set parameters about rawmidi stream
Definition: rawmidi.c:937
int snd_rawmidi_info_get_card(const snd_rawmidi_info_t *obj)
get rawmidi card number
Definition: rawmidi.c:570
void snd_rawmidi_info_set_subdevice(snd_rawmidi_info_t *obj, unsigned int val)
set rawmidi subdevice number
Definition: rawmidi.c:674
snd_rawmidi_read_mode_t snd_rawmidi_params_get_read_mode(const snd_rawmidi_params_t *params)
get current read mode
Definition: rawmidi.c:884
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
Definition: rawmidi.c:748
int snd_rawmidi_info_get_tied_device(const snd_rawmidi_info_t *obj)
get the tied device number for the given rawmidi device
Definition: rawmidi.c:650
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
Definition: rawmidi.c:1129
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
Definition: rawmidi.c:854
snd_rawmidi_type_t snd_rawmidi_type(snd_rawmidi_t *rmidi)
get type of RawMidi handle
Definition: rawmidi.c:393
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
Definition: rawmidi.c:764
int snd_rawmidi_params_get_no_active_sensing(const snd_rawmidi_params_t *params)
get no-active-sensing action status
Definition: rawmidi.c:836
unsigned int snd_rawmidi_info_get_subdevices_avail(const snd_rawmidi_info_t *obj)
get rawmidi available count of subdevices
Definition: rawmidi.c:636
snd_rawmidi_stream_t snd_rawmidi_info_get_stream(const snd_rawmidi_info_t *obj)
get rawmidi stream identification
Definition: rawmidi.c:559
size_t snd_rawmidi_status_sizeof(void)
get size of the snd_rawmidi_status_t structure in bytes
Definition: rawmidi.c:973
size_t snd_rawmidi_status_get_avail(const snd_rawmidi_status_t *obj)
get current available bytes in the rawmidi I/O ring buffer
Definition: rawmidi.c:1035
int snd_rawmidi_params_current(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params)
get current parameters about rawmidi stream
Definition: rawmidi.c:958
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
Definition: rawmidi.c:793
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
Definition: rawmidi.c:907
struct _snd_rawmidi_params snd_rawmidi_params_t
Definition: rawmidi.h:53
void snd_rawmidi_info_set_device(snd_rawmidi_info_t *obj, unsigned int val)
set rawmidi device number
Definition: rawmidi.c:663
ssize_t snd_rawmidi_read(snd_rawmidi_t *rmidi, void *buffer, size_t size)
read MIDI bytes from MIDI stream
Definition: rawmidi.c:1111
struct _snd_rawmidi snd_rawmidi_t
Definition: rawmidi.h:74
const char * snd_rawmidi_name(snd_rawmidi_t *rmidi)
get identifier of RawMidi handle
Definition: rawmidi.c:380
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.
Definition: rawmidi.c:345
void snd_rawmidi_info_free(snd_rawmidi_info_t *obj)
frees the snd_rawmidi_info_t structure
Definition: rawmidi.c:515
struct _snd_rawmidi_info snd_rawmidi_info_t
Definition: rawmidi.h:51
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
Definition: rawmidi.c:1013
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()
Definition: rawmidi.c:823
int snd_rawmidi_status(snd_rawmidi_t *rmidi, snd_rawmidi_status_t *status)
get status of rawmidi stream
Definition: rawmidi.c:1058
int snd_rawmidi_close(snd_rawmidi_t *rmidi)
close RawMidi handle
Definition: rawmidi.c:360
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
Definition: rawmidi.c:526
int snd_rawmidi_drain(snd_rawmidi_t *rmidi)
drain all bytes in the rawmidi I/O ring buffer
Definition: rawmidi.c:1084
unsigned int snd_rawmidi_info_get_subdevices_count(const snd_rawmidi_info_t *obj)
get rawmidi count of subdevices
Definition: rawmidi.c:625
int snd_rawmidi_status_malloc(snd_rawmidi_status_t **ptr)
allocate the snd_rawmidi_status_t structure
Definition: rawmidi.c:986
snd_rawmidi_stream_t
Definition: rawmidi.h:58
const char * snd_rawmidi_info_get_id(const snd_rawmidi_info_t *obj)
get rawmidi hardware driver identifier
Definition: rawmidi.c:592
void snd_rawmidi_status_free(snd_rawmidi_status_t *obj)
frees the snd_rawmidi_status_t structure
Definition: rawmidi.c:1002
snd_rawmidi_clock_t snd_rawmidi_params_get_clock_type(const snd_rawmidi_params_t *params)
get current clock type (for tstamp type framing)
Definition: rawmidi.c:924
unsigned int snd_rawmidi_info_get_device(const snd_rawmidi_info_t *obj)
get rawmidi device number
Definition: rawmidi.c:537
void snd_rawmidi_info_set_stream(snd_rawmidi_info_t *obj, snd_rawmidi_stream_t val)
set rawmidi stream identifier
Definition: rawmidi.c:685
void snd_rawmidi_params_free(snd_rawmidi_params_t *obj)
frees the snd_rawmidi_params_t structure
Definition: rawmidi.c:737
size_t snd_rawmidi_status_get_xruns(const snd_rawmidi_status_t *obj)
get count of xruns
Definition: rawmidi.c:1046
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
Definition: rawmidi.c:807
size_t snd_rawmidi_params_sizeof(void)
get size of the snd_rawmidi_params_t structure in bytes
Definition: rawmidi.c:708
void snd_rawmidi_status_get_tstamp(const snd_rawmidi_status_t *obj, snd_htimestamp_t *ptr)
get the start timestamp
Definition: rawmidi.c:1024
int snd_rawmidi_params_malloc(snd_rawmidi_params_t **ptr)
allocate the snd_rawmidi_params_t structure
Definition: rawmidi.c:721
unsigned int snd_rawmidi_info_get_flags(const snd_rawmidi_info_t *obj)
get rawmidi flags
Definition: rawmidi.c:581
snd_rawmidi_read_mode_t
Definition: rawmidi.h:97
const char * snd_rawmidi_info_get_name(const snd_rawmidi_info_t *obj)
get rawmidi hardware driver name
Definition: rawmidi.c:603
int snd_rawmidi_nonblock(snd_rawmidi_t *rmidi, int nonblock)
set nonblock mode
Definition: rawmidi.c:468
@ SND_RAWMIDI_TYPE_SHM
Definition: rawmidi.h:81
@ SND_RAWMIDI_TYPE_HW
Definition: rawmidi.h:79
@ SND_RAWMIDI_TYPE_INET
Definition: rawmidi.h:83
@ SND_RAWMIDI_TYPE_VIRTUAL
Definition: rawmidi.h:85
@ SND_RAWMIDI_STREAM_INPUT
Definition: rawmidi.h:62
@ SND_RAWMIDI_STREAM_OUTPUT
Definition: rawmidi.h:60
uint8_t status
Definition: ump_msg.h:3