ALSA project - the C library reference: /tmp/work/src/alsa-lib-1.2.12/include/rawmidi.h Source File

ALSA project - the C library reference

Loading...
Searching...
No Matches
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#ifndef __ALSA_RAWMIDI_H
29#define __ALSA_RAWMIDI_H
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
42#define SND_RAWMIDI_DLSYM_VERSION _dlsym_rawmidi_001
43
45 typedef struct _snd_rawmidi_info snd_rawmidi_info_t;
47 typedef struct _snd_rawmidi_params snd_rawmidi_params_t;
49 typedef struct _snd_rawmidi_status snd_rawmidi_status_t;
50
52 typedef enum _snd_rawmidi_stream {
54 SND_RAWMIDI_STREAM_OUTPUT = 0,
56 SND_RAWMIDI_STREAM_INPUT,
57 SND_RAWMIDI_STREAM_LAST = SND_RAWMIDI_STREAM_INPUT
58} snd_rawmidi_stream_t;
59
61#define SND_RAWMIDI_APPEND 0x0001
63#define SND_RAWMIDI_NONBLOCK 0x0002
65#define SND_RAWMIDI_SYNC 0x0004
66
68 typedef struct _snd_rawmidi snd_rawmidi_t;
69
71 typedef enum _snd_rawmidi_type {
73 SND_RAWMIDI_TYPE_HW,
75 SND_RAWMIDI_TYPE_SHM,
77 SND_RAWMIDI_TYPE_INET,
79 SND_RAWMIDI_TYPE_VIRTUAL
80} snd_rawmidi_type_t;
81
83 typedef enum _snd_rawmidi_clock {
84 SND_RAWMIDI_CLOCK_NONE = 0,
85 SND_RAWMIDI_CLOCK_REALTIME = 1,
86 SND_RAWMIDI_CLOCK_MONOTONIC = 2,
87 SND_RAWMIDI_CLOCK_MONOTONIC_RAW = 3,
88} snd_rawmidi_clock_t;
89
91 typedef enum _snd_rawmidi_read_mode {
92 SND_RAWMIDI_READ_STANDARD = 0,
93 SND_RAWMIDI_READ_TSTAMP = 1,
94} snd_rawmidi_read_mode_t;
95
97#define SND_RAWMIDI_INFO_UMP 0x00000008 /* rawmidi is UMP */
98
99int snd_rawmidi_open(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi,
100 const char *name, int mode);
101int snd_rawmidi_open_lconf(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi,
102 const char *name, int mode, snd_config_t *lconf);
103int snd_rawmidi_close(snd_rawmidi_t *rmidi);
104int snd_rawmidi_poll_descriptors_count(snd_rawmidi_t *rmidi);
105int snd_rawmidi_poll_descriptors(snd_rawmidi_t *rmidi, struct pollfd *pfds, unsigned int space);
106int snd_rawmidi_poll_descriptors_revents(snd_rawmidi_t *rawmidi, struct pollfd *pfds, unsigned int nfds, unsigned short *revent);
107int snd_rawmidi_nonblock(snd_rawmidi_t *rmidi, int nonblock);
108size_t snd_rawmidi_info_sizeof(void);
113#define snd_rawmidi_info_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_info)
114int snd_rawmidi_info_malloc(snd_rawmidi_info_t **ptr);
115void snd_rawmidi_info_free(snd_rawmidi_info_t *obj);
116void snd_rawmidi_info_copy(snd_rawmidi_info_t *dst, const snd_rawmidi_info_t *src);
117unsigned int snd_rawmidi_info_get_device(const snd_rawmidi_info_t *obj);
118unsigned int snd_rawmidi_info_get_subdevice(const snd_rawmidi_info_t *obj);
119 snd_rawmidi_stream_t snd_rawmidi_info_get_stream(const snd_rawmidi_info_t *obj);
120int snd_rawmidi_info_get_card(const snd_rawmidi_info_t *obj);
121unsigned int snd_rawmidi_info_get_flags(const snd_rawmidi_info_t *obj);
122const char *snd_rawmidi_info_get_id(const snd_rawmidi_info_t *obj);
123const char *snd_rawmidi_info_get_name(const snd_rawmidi_info_t *obj);
124const char *snd_rawmidi_info_get_subdevice_name(const snd_rawmidi_info_t *obj);
125unsigned int snd_rawmidi_info_get_subdevices_count(const snd_rawmidi_info_t *obj);
126unsigned int snd_rawmidi_info_get_subdevices_avail(const snd_rawmidi_info_t *obj);
127void snd_rawmidi_info_set_device(snd_rawmidi_info_t *obj, unsigned int val);
128void snd_rawmidi_info_set_subdevice(snd_rawmidi_info_t *obj, unsigned int val);
129void snd_rawmidi_info_set_stream(snd_rawmidi_info_t *obj, snd_rawmidi_stream_t val);
130int snd_rawmidi_info(snd_rawmidi_t *rmidi, snd_rawmidi_info_t * info);
131size_t snd_rawmidi_params_sizeof(void);
136#define snd_rawmidi_params_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_params)
137int snd_rawmidi_params_malloc(snd_rawmidi_params_t **ptr);
138void snd_rawmidi_params_free(snd_rawmidi_params_t *obj);
139void snd_rawmidi_params_copy(snd_rawmidi_params_t *dst, const snd_rawmidi_params_t *src);
140int snd_rawmidi_params_set_buffer_size(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, size_t val);
141size_t snd_rawmidi_params_get_buffer_size(const snd_rawmidi_params_t *params);
142int snd_rawmidi_params_set_avail_min(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, size_t val);
143size_t snd_rawmidi_params_get_avail_min(const snd_rawmidi_params_t *params);
144int snd_rawmidi_params_set_no_active_sensing(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, int val);
145int snd_rawmidi_params_get_no_active_sensing(const snd_rawmidi_params_t *params);
146int snd_rawmidi_params_set_read_mode(const snd_rawmidi_t *rawmidi, snd_rawmidi_params_t *params, snd_rawmidi_read_mode_t val);
147 snd_rawmidi_read_mode_t snd_rawmidi_params_get_read_mode(const snd_rawmidi_params_t *params);
148int snd_rawmidi_params_set_clock_type(const snd_rawmidi_t *rawmidi, snd_rawmidi_params_t *params, snd_rawmidi_clock_t val);
149 snd_rawmidi_clock_t snd_rawmidi_params_get_clock_type(const snd_rawmidi_params_t *params);
150
151int snd_rawmidi_params(snd_rawmidi_t *rmidi, snd_rawmidi_params_t * params);
152int snd_rawmidi_params_current(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params);
153size_t snd_rawmidi_status_sizeof(void);
158#define snd_rawmidi_status_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_status)
159int snd_rawmidi_status_malloc(snd_rawmidi_status_t **ptr);
160void snd_rawmidi_status_free(snd_rawmidi_status_t *obj);
161void snd_rawmidi_status_copy(snd_rawmidi_status_t *dst, const snd_rawmidi_status_t *src);
162void snd_rawmidi_status_get_tstamp(const snd_rawmidi_status_t *obj, snd_htimestamp_t *ptr);
163size_t snd_rawmidi_status_get_avail(const snd_rawmidi_status_t *obj);
164size_t snd_rawmidi_status_get_xruns(const snd_rawmidi_status_t *obj);
165int snd_rawmidi_status(snd_rawmidi_t *rmidi, snd_rawmidi_status_t * status);
166int snd_rawmidi_drain(snd_rawmidi_t *rmidi);
167int snd_rawmidi_drop(snd_rawmidi_t *rmidi);
168ssize_t snd_rawmidi_write(snd_rawmidi_t *rmidi, const void *buffer, size_t size);
169ssize_t snd_rawmidi_read(snd_rawmidi_t *rmidi, void *buffer, size_t size);
170ssize_t snd_rawmidi_tread(snd_rawmidi_t *rmidi, struct timespec *tstamp, void *buffer, size_t size);
171const char *snd_rawmidi_name(snd_rawmidi_t *rmidi);
172 snd_rawmidi_type_t snd_rawmidi_type(snd_rawmidi_t *rmidi);
173 snd_rawmidi_stream_t snd_rawmidi_stream(snd_rawmidi_t *rawmidi);
174
177#ifdef __cplusplus
178}
179#endif
180
181#endif /* __RAWMIDI_H */
182
snd_config_t
struct _snd_config snd_config_t
Internal structure for a configuration node object.
Definition conf.h:69
snd_htimestamp_t
struct timespec snd_htimestamp_t
Definition global.h:154
snd_rawmidi_drop
int snd_rawmidi_drop(snd_rawmidi_t *rmidi)
drop all bytes in the rawmidi I/O ring buffer immediately
Definition rawmidi.c:1054
snd_rawmidi_write
ssize_t snd_rawmidi_write(snd_rawmidi_t *rmidi, const void *buffer, size_t size)
write MIDI bytes to MIDI stream
Definition rawmidi.c:1080
snd_rawmidi_params_get_buffer_size
size_t snd_rawmidi_params_get_buffer_size(const snd_rawmidi_params_t *params)
get rawmidi I/O ring buffer size
Definition rawmidi.c:762
snd_rawmidi_status_t
struct _snd_rawmidi_status snd_rawmidi_status_t
Definition rawmidi.h:49
snd_rawmidi_info_malloc
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
snd_rawmidi_clock_t
Definition rawmidi.h:83
snd_rawmidi_info_get_id
const char * snd_rawmidi_info_get_id(const snd_rawmidi_info_t *obj)
get rawmidi hardware driver identifier
Definition rawmidi.c:592
snd_rawmidi_poll_descriptors
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
snd_rawmidi_type_t
Definition rawmidi.h:71
snd_rawmidi_stream
snd_rawmidi_stream_t snd_rawmidi_stream(snd_rawmidi_t *rawmidi)
get stream (direction) of RawMidi handle
Definition rawmidi.c:406
snd_rawmidi_open
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
snd_rawmidi_info_sizeof
size_t snd_rawmidi_info_sizeof(void)
get size of the snd_rawmidi_info_t structure in bytes
Definition rawmidi.c:486
snd_rawmidi_poll_descriptors_revents
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
snd_rawmidi_poll_descriptors_count
int snd_rawmidi_poll_descriptors_count(snd_rawmidi_t *rmidi)
get count of poll descriptors for RawMidi handle
Definition rawmidi.c:417
snd_rawmidi_info
int snd_rawmidi_info(snd_rawmidi_t *rmidi, snd_rawmidi_info_t *info)
get information about RawMidi handle
Definition rawmidi.c:681
snd_rawmidi_info_get_subdevice
unsigned int snd_rawmidi_info_get_subdevice(const snd_rawmidi_info_t *obj)
get rawmidi subdevice number
Definition rawmidi.c:548
snd_rawmidi_params
int snd_rawmidi_params(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params)
set parameters about rawmidi stream
Definition rawmidi.c:921
snd_rawmidi_info_get_card
int snd_rawmidi_info_get_card(const snd_rawmidi_info_t *obj)
get rawmidi card number
Definition rawmidi.c:570
snd_rawmidi_info_set_subdevice
void snd_rawmidi_info_set_subdevice(snd_rawmidi_info_t *obj, unsigned int val)
set rawmidi subdevice number
Definition rawmidi.c:658
snd_rawmidi_params_get_read_mode
snd_rawmidi_read_mode_t snd_rawmidi_params_get_read_mode(const snd_rawmidi_params_t *params)
get current read mode
Definition rawmidi.c:868
snd_rawmidi_params_copy
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:732
snd_rawmidi_tread
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:1113
snd_rawmidi_params_set_read_mode
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:838
snd_rawmidi_type
snd_rawmidi_type_t snd_rawmidi_type(snd_rawmidi_t *rmidi)
get type of RawMidi handle
Definition rawmidi.c:393
snd_rawmidi_params_set_buffer_size
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:748
snd_rawmidi_params_get_no_active_sensing
int snd_rawmidi_params_get_no_active_sensing(const snd_rawmidi_params_t *params)
get no-active-sensing action status
Definition rawmidi.c:820
snd_rawmidi_info_get_name
const char * snd_rawmidi_info_get_name(const snd_rawmidi_info_t *obj)
get rawmidi hardware driver name
Definition rawmidi.c:603
snd_rawmidi_info_get_subdevices_avail
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_info_get_stream
snd_rawmidi_stream_t snd_rawmidi_info_get_stream(const snd_rawmidi_info_t *obj)
get rawmidi stream identification
Definition rawmidi.c:559
snd_rawmidi_status_sizeof
size_t snd_rawmidi_status_sizeof(void)
get size of the snd_rawmidi_status_t structure in bytes
Definition rawmidi.c:957
snd_rawmidi_status_get_avail
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:1019
snd_rawmidi_params_current
int snd_rawmidi_params_current(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params)
get current parameters about rawmidi stream
Definition rawmidi.c:942
snd_rawmidi_params_set_avail_min
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:777
snd_rawmidi_params_set_clock_type
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:891
snd_rawmidi_params_t
struct _snd_rawmidi_params snd_rawmidi_params_t
Definition rawmidi.h:47
snd_rawmidi_info_set_device
void snd_rawmidi_info_set_device(snd_rawmidi_info_t *obj, unsigned int val)
set rawmidi device number
Definition rawmidi.c:647
snd_rawmidi_read
ssize_t snd_rawmidi_read(snd_rawmidi_t *rmidi, void *buffer, size_t size)
read MIDI bytes from MIDI stream
Definition rawmidi.c:1095
snd_rawmidi_t
struct _snd_rawmidi snd_rawmidi_t
Definition rawmidi.h:68
snd_rawmidi_open_lconf
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
snd_rawmidi_info_free
void snd_rawmidi_info_free(snd_rawmidi_info_t *obj)
frees the snd_rawmidi_info_t structure
Definition rawmidi.c:515
snd_rawmidi_info_t
struct _snd_rawmidi_info snd_rawmidi_info_t
Definition rawmidi.h:45
snd_rawmidi_status_copy
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:997
snd_rawmidi_params_set_no_active_sensing
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:807
snd_rawmidi_status
int snd_rawmidi_status(snd_rawmidi_t *rmidi, snd_rawmidi_status_t *status)
get status of rawmidi stream
Definition rawmidi.c:1042
snd_rawmidi_close
int snd_rawmidi_close(snd_rawmidi_t *rmidi)
close RawMidi handle
Definition rawmidi.c:360
snd_rawmidi_info_copy
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
snd_rawmidi_drain
int snd_rawmidi_drain(snd_rawmidi_t *rmidi)
drain all bytes in the rawmidi I/O ring buffer
Definition rawmidi.c:1068
snd_rawmidi_info_get_subdevices_count
unsigned int snd_rawmidi_info_get_subdevices_count(const snd_rawmidi_info_t *obj)
get rawmidi count of subdevices
Definition rawmidi.c:625
snd_rawmidi_status_malloc
int snd_rawmidi_status_malloc(snd_rawmidi_status_t **ptr)
allocate the snd_rawmidi_status_t structure
Definition rawmidi.c:970
snd_rawmidi_stream_t
snd_rawmidi_stream_t
Definition rawmidi.h:52
snd_rawmidi_status_free
void snd_rawmidi_status_free(snd_rawmidi_status_t *obj)
frees the snd_rawmidi_status_t structure
Definition rawmidi.c:986
snd_rawmidi_params_get_clock_type
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:908
snd_rawmidi_info_get_device
unsigned int snd_rawmidi_info_get_device(const snd_rawmidi_info_t *obj)
get rawmidi device number
Definition rawmidi.c:537
snd_rawmidi_info_set_stream
void snd_rawmidi_info_set_stream(snd_rawmidi_info_t *obj, snd_rawmidi_stream_t val)
set rawmidi stream identifier
Definition rawmidi.c:669
snd_rawmidi_params_free
void snd_rawmidi_params_free(snd_rawmidi_params_t *obj)
frees the snd_rawmidi_params_t structure
Definition rawmidi.c:721
snd_rawmidi_status_get_xruns
size_t snd_rawmidi_status_get_xruns(const snd_rawmidi_status_t *obj)
get count of xruns
Definition rawmidi.c:1030
snd_rawmidi_params_get_avail_min
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:791
snd_rawmidi_info_get_subdevice_name
const char * snd_rawmidi_info_get_subdevice_name(const snd_rawmidi_info_t *obj)
get rawmidi subdevice name
Definition rawmidi.c:614
snd_rawmidi_params_sizeof
size_t snd_rawmidi_params_sizeof(void)
get size of the snd_rawmidi_params_t structure in bytes
Definition rawmidi.c:692
snd_rawmidi_status_get_tstamp
void snd_rawmidi_status_get_tstamp(const snd_rawmidi_status_t *obj, snd_htimestamp_t *ptr)
get the start timestamp
Definition rawmidi.c:1008
snd_rawmidi_params_malloc
int snd_rawmidi_params_malloc(snd_rawmidi_params_t **ptr)
allocate the snd_rawmidi_params_t structure
Definition rawmidi.c:705
snd_rawmidi_name
const char * snd_rawmidi_name(snd_rawmidi_t *rmidi)
get identifier of RawMidi handle
Definition rawmidi.c:380
snd_rawmidi_info_get_flags
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
snd_rawmidi_read_mode_t
Definition rawmidi.h:91
snd_rawmidi_nonblock
int snd_rawmidi_nonblock(snd_rawmidi_t *rmidi, int nonblock)
set nonblock mode
Definition rawmidi.c:468
SND_RAWMIDI_TYPE_SHM
@ SND_RAWMIDI_TYPE_SHM
Definition rawmidi.h:75
SND_RAWMIDI_TYPE_HW
@ SND_RAWMIDI_TYPE_HW
Definition rawmidi.h:73
SND_RAWMIDI_TYPE_INET
@ SND_RAWMIDI_TYPE_INET
Definition rawmidi.h:77
SND_RAWMIDI_TYPE_VIRTUAL
@ SND_RAWMIDI_TYPE_VIRTUAL
Definition rawmidi.h:79
SND_RAWMIDI_STREAM_INPUT
@ SND_RAWMIDI_STREAM_INPUT
Definition rawmidi.h:56
SND_RAWMIDI_STREAM_OUTPUT
@ SND_RAWMIDI_STREAM_OUTPUT
Definition rawmidi.h:54