ALSA project - the C library reference: /builddir/build/BUILD/alsa-lib-1.1.8/include/rawmidi.h Source File

ALSA project - the C library reference

- Main Page
- Related Pages
- Modules
- Data Structures
- Files
- Examples

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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
32 extern "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
62
63 #define SND_RAWMIDI_NONBLOCK 0x0002
64
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
82 int snd_rawmidi_open(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi,
83 const char *name, int mode);
84 int snd_rawmidi_open_lconf(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi,
85 const char *name, int mode, snd_config_t *lconf);
86 int snd_rawmidi_close(snd_rawmidi_t *rmidi);
87 int snd_rawmidi_poll_descriptors_count(snd_rawmidi_t *rmidi);
88 int snd_rawmidi_poll_descriptors(snd_rawmidi_t *rmidi, struct pollfd *pfds, unsigned int space);
89 int snd_rawmidi_poll_descriptors_revents(snd_rawmidi_t *rawmidi, struct pollfd *pfds, unsigned int nfds, unsigned short *revent);
90 int snd_rawmidi_nonblock(snd_rawmidi_t *rmidi, int nonblock);
91 size_t snd_rawmidi_info_sizeof(void);
96 #define snd_rawmidi_info_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_info)
97 int snd_rawmidi_info_malloc(snd_rawmidi_info_t **ptr);
98 void snd_rawmidi_info_free(snd_rawmidi_info_t *obj);
99 void snd_rawmidi_info_copy(snd_rawmidi_info_t *dst, const snd_rawmidi_info_t *src);
100 unsigned int snd_rawmidi_info_get_device(const snd_rawmidi_info_t *obj);
101 unsigned int snd_rawmidi_info_get_subdevice(const snd_rawmidi_info_t *obj);
102 snd_rawmidi_stream_t snd_rawmidi_info_get_stream(const snd_rawmidi_info_t *obj);
103 int snd_rawmidi_info_get_card(const snd_rawmidi_info_t *obj);
104 unsigned int snd_rawmidi_info_get_flags(const snd_rawmidi_info_t *obj);
105 const char *snd_rawmidi_info_get_id(const snd_rawmidi_info_t *obj);
106 const char *snd_rawmidi_info_get_name(const snd_rawmidi_info_t *obj);
107 const char *snd_rawmidi_info_get_subdevice_name(const snd_rawmidi_info_t *obj);
108 unsigned int snd_rawmidi_info_get_subdevices_count(const snd_rawmidi_info_t *obj);
109 unsigned int snd_rawmidi_info_get_subdevices_avail(const snd_rawmidi_info_t *obj);
110 void snd_rawmidi_info_set_device(snd_rawmidi_info_t *obj, unsigned int val);
111 void snd_rawmidi_info_set_subdevice(snd_rawmidi_info_t *obj, unsigned int val);
112 void snd_rawmidi_info_set_stream(snd_rawmidi_info_t *obj, snd_rawmidi_stream_t val);
113 int snd_rawmidi_info(snd_rawmidi_t *rmidi, snd_rawmidi_info_t * info);
114 size_t snd_rawmidi_params_sizeof(void);
119 #define snd_rawmidi_params_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_params)
120 int snd_rawmidi_params_malloc(snd_rawmidi_params_t **ptr);
121 void snd_rawmidi_params_free(snd_rawmidi_params_t *obj);
122 void snd_rawmidi_params_copy(snd_rawmidi_params_t *dst, const snd_rawmidi_params_t *src);
123 int snd_rawmidi_params_set_buffer_size(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, size_t val);
124 size_t snd_rawmidi_params_get_buffer_size(const snd_rawmidi_params_t *params);
125 int snd_rawmidi_params_set_avail_min(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, size_t val);
126 size_t snd_rawmidi_params_get_avail_min(const snd_rawmidi_params_t *params);
127 int snd_rawmidi_params_set_no_active_sensing(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params, int val);
128 int snd_rawmidi_params_get_no_active_sensing(const snd_rawmidi_params_t *params);
129 int snd_rawmidi_params(snd_rawmidi_t *rmidi, snd_rawmidi_params_t * params);
130 int snd_rawmidi_params_current(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params);
131 size_t snd_rawmidi_status_sizeof(void);
136 #define snd_rawmidi_status_alloca(ptr) __snd_alloca(ptr, snd_rawmidi_status)
137 int snd_rawmidi_status_malloc(snd_rawmidi_status_t **ptr);
138 void snd_rawmidi_status_free(snd_rawmidi_status_t *obj);
139 void snd_rawmidi_status_copy(snd_rawmidi_status_t *dst, const snd_rawmidi_status_t *src);
140 void snd_rawmidi_status_get_tstamp(const snd_rawmidi_status_t *obj, snd_htimestamp_t *ptr);
141 size_t snd_rawmidi_status_get_avail(const snd_rawmidi_status_t *obj);
142 size_t snd_rawmidi_status_get_xruns(const snd_rawmidi_status_t *obj);
143 int snd_rawmidi_status(snd_rawmidi_t *rmidi, snd_rawmidi_status_t * status);
144 int snd_rawmidi_drain(snd_rawmidi_t *rmidi);
145 int snd_rawmidi_drop(snd_rawmidi_t *rmidi);
146 ssize_t snd_rawmidi_write(snd_rawmidi_t *rmidi, const void *buffer, size_t size);
147 ssize_t snd_rawmidi_read(snd_rawmidi_t *rmidi, void *buffer, size_t size);
148 const char *snd_rawmidi_name(snd_rawmidi_t *rmidi);
149 snd_rawmidi_type_t snd_rawmidi_type(snd_rawmidi_t *rmidi);
150 snd_rawmidi_stream_t snd_rawmidi_stream(snd_rawmidi_t *rawmidi);
151
154 #ifdef __cplusplus
155 }
156 #endif
157
158 #endif /* __RAWMIDI_H */
159
snd_rawmidi_params_t
struct _snd_rawmidi_params snd_rawmidi_params_t
Definition: rawmidi.h:47
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:839
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:524
snd_rawmidi_info_get_card
int snd_rawmidi_info_get_card(const snd_rawmidi_info_t *obj)
get rawmidi card number
Definition: rawmidi.c:557
snd_rawmidi_nonblock
int snd_rawmidi_nonblock(snd_rawmidi_t *rmidi, int nonblock)
set nonblock mode
Definition: rawmidi.c:455
snd_rawmidi_drain
int snd_rawmidi_drain(snd_rawmidi_t *rmidi)
drain all bytes in the rawmidi I/O ring buffer
Definition: rawmidi.c:964
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:417
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:853
SND_RAWMIDI_STREAM_INPUT
Definition: rawmidi.h:56
snd_rawmidi_params_free
void snd_rawmidi_params_free(snd_rawmidi_params_t *obj)
frees the snd_rawmidi_params_t structure
Definition: rawmidi.c:708
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:332
snd_rawmidi_info_t
struct _snd_rawmidi_info snd_rawmidi_info_t
Definition: rawmidi.h:45
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:473
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:579
SND_RAWMIDI_STREAM_OUTPUT
Definition: rawmidi.h:54
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:990
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:904
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:893
snd_rawmidi_close
int snd_rawmidi_close(snd_rawmidi_t *rmidi)
close RawMidi handle
Definition: rawmidi.c:347
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:305
snd_rawmidi_params_malloc
int snd_rawmidi_params_malloc(snd_rawmidi_params_t **ptr)
allocate the snd_rawmidi_params_t structure
Definition: rawmidi.c:692
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:778
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:679
snd_rawmidi_type
snd_rawmidi_type_t snd_rawmidi_type(snd_rawmidi_t *rmidi)
get type of RawMidi handle
Definition: rawmidi.c:380
SND_RAWMIDI_TYPE_SHM
Definition: rawmidi.h:75
snd_rawmidi_info
int snd_rawmidi_info(snd_rawmidi_t *rmidi, snd_rawmidi_info_t *info)
get information about RawMidi handle
Definition: rawmidi.c:668
snd_htimestamp_t
struct timespec snd_htimestamp_t
Definition: global.h:153
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:535
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:590
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:976
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:926
snd_rawmidi_info_free
void snd_rawmidi_info_free(snd_rawmidi_info_t *obj)
frees the snd_rawmidi_info_t structure
Definition: rawmidi.c:502
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:404
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:634
snd_rawmidi_name
const char * snd_rawmidi_name(snd_rawmidi_t *rmidi)
get identifier of RawMidi handle
Definition: rawmidi.c:367
snd_rawmidi_stream
snd_rawmidi_stream_t snd_rawmidi_stream(snd_rawmidi_t *rawmidi)
get stream (direction) of RawMidi handle
Definition: rawmidi.c:393
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:807
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:645
snd_rawmidi_status_malloc
int snd_rawmidi_status_malloc(snd_rawmidi_status_t **ptr)
allocate the snd_rawmidi_status_t structure
Definition: rawmidi.c:866
snd_rawmidi_params
int snd_rawmidi_params(snd_rawmidi_t *rmidi, snd_rawmidi_params_t *params)
set parameters about rawmidi stream
Definition: rawmidi.c:819
snd_rawmidi_status
int snd_rawmidi_status(snd_rawmidi_t *rmidi, snd_rawmidi_status_t *status)
get status of rawmidi stream
Definition: rawmidi.c:938
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:601
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:513
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:749
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:719
SND_RAWMIDI_TYPE_VIRTUAL
Definition: rawmidi.h:79
SND_RAWMIDI_TYPE_HW
Definition: rawmidi.h:73
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:764
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:950
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:735
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:623
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:656
snd_rawmidi_status_t
struct _snd_rawmidi_status snd_rawmidi_status_t
Definition: rawmidi.h:49
snd_config_t
struct _snd_config snd_config_t
Internal structure for a configuration node object.
Definition: conf.h:69
snd_rawmidi_type_t
snd_rawmidi_type_t
Definition: rawmidi.h:71
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:794
snd_rawmidi_t
struct _snd_rawmidi snd_rawmidi_t
Definition: rawmidi.h:68
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:882
snd_rawmidi_info_get_flags
unsigned int snd_rawmidi_info_get_flags(const snd_rawmidi_info_t *obj)
get rawmidi flags
Definition: rawmidi.c:568
ptr
void * ptr
Definition: seq_event.h:199
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:612
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:486
SND_RAWMIDI_TYPE_INET
Definition: rawmidi.h:77
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:436
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:546
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:915