1/* SPDX-License-Identifier: LGPL-2.1+ */ 2/** 3 * \file include/ump.h 4 * \brief API library for ALSA rawmidi/UMP interface 5 * 6 * API library for ALSA rawmidi/UMP interface 7 */ 8 9#ifndef __ALSA_UMP_H 10#define __ALSA_UMP_H 11 12#ifdef __cplusplus 13extern "C" { 14#endif 15 16/** UMP (Endpoint) RawMIDI device */ 17typedef struct _snd_ump snd_ump_t; 18/** UMP Endpoint information container */ 19typedef struct snd_ump_endpoint_info snd_ump_endpoint_info_t; 20/** UMP Block information container */ 21typedef struct snd_ump_block_info snd_ump_block_info_t; 22 23int snd_ump_open(snd_ump_t **inputp, snd_ump_t **outputp, const char *name, int mode); 24int snd_ump_close(snd_ump_t *ump); 25snd_rawmidi_t *snd_ump_rawmidi(snd_ump_t *ump); 26const char *snd_ump_name(snd_ump_t *ump); 27int snd_ump_poll_descriptors_count(snd_ump_t *ump); 28int snd_ump_poll_descriptors(snd_ump_t *ump, struct pollfd *pfds, unsigned int space); 29int snd_ump_poll_descriptors_revents(snd_ump_t *ump, struct pollfd *pfds, unsigned int nfds, unsigned short *revents); 30int snd_ump_nonblock(snd_ump_t *ump, int nonblock); 31int snd_ump_rawmidi_info(snd_ump_t *ump, snd_rawmidi_info_t *info); 32int snd_ump_rawmidi_params(snd_ump_t *ump, snd_rawmidi_params_t *params); 33int snd_ump_rawmidi_params_current(snd_ump_t *ump, snd_rawmidi_params_t *params); 34int snd_ump_rawmidi_status(snd_ump_t *ump, snd_rawmidi_status_t *status); 35int snd_ump_drop(snd_ump_t *ump); 36int snd_ump_drain(snd_ump_t *ump); 37ssize_t snd_ump_write(snd_ump_t *ump, const void *buffer, size_t size); 38ssize_t snd_ump_read(snd_ump_t *ump, void *buffer, size_t size); 39ssize_t snd_ump_tread(snd_ump_t *ump, struct timespec *tstamp, void *buffer, size_t size); 40 41/** Max number of UMP Groups */ 42#define SND_UMP_MAX_GROUPS 16 43/** Max number of UMP Blocks */ 44#define SND_UMP_MAX_BLOCKS 32 45 46/** UMP direction */ 47enum _snd_ump_direction { 48 /** Input only */ 49 SND_UMP_DIR_INPUT = 0x01, 50 /** Output only */ 51 SND_UMP_DIR_OUTPUT = 0x02, 52 /** Bidirectional */ 53 SND_UMP_DIR_BIDIRECTION = 0x03, 54}; 55 56/** UMP EP holds only static blocks */ 57#define SND_UMP_EP_INFO_STATIC_BLOCKS 0x01 58 59/** Bitmask for UMP EP MIDI protocols */ 60#define SND_UMP_EP_INFO_PROTO_MIDI_MASK 0x0300 61/** Bit flag for MIDI 1.0 protocol */ 62#define SND_UMP_EP_INFO_PROTO_MIDI1 0x0100 63/** Bit flag for MIDI 2.0 protocol */ 64#define SND_UMP_EP_INFO_PROTO_MIDI2 0x0200 65/** Bitmask for UMP Jitter-reduction timestamp */ 66#define SND_UMP_EP_INFO_PROTO_JRTS_MASK 0x0003 67/** Bit flag for JRTS in Transmit */ 68#define SND_UMP_EP_INFO_PROTO_JRTS_TX 0x0001 69/** Bit flag for JRTS in Receive */ 70#define SND_UMP_EP_INFO_PROTO_JRTS_RX 0x0002 71 72size_t snd_ump_endpoint_info_sizeof(void); 73/** \hideinitializer 74 * \brief allocate an invalid #snd_ump_endpoint_info_t using standard alloca 75 * \param ptr returned pointer 76 */ 77#define snd_ump_endpoint_info_alloca(ptr) __snd_alloca(ptr, snd_ump_endpoint_info) 78int snd_ump_endpoint_info_malloc(snd_ump_endpoint_info_t **info); 79void snd_ump_endpoint_info_free(snd_ump_endpoint_info_t *info); 80void snd_ump_endpoint_info_copy(snd_ump_endpoint_info_t *dst, const snd_ump_endpoint_info_t *src); 81int snd_ump_endpoint_info_get_card(const snd_ump_endpoint_info_t *info); 82int snd_ump_endpoint_info_get_device(const snd_ump_endpoint_info_t *info); 83unsigned int snd_ump_endpoint_info_get_flags(const snd_ump_endpoint_info_t *info); 84unsigned int snd_ump_endpoint_info_get_protocol_caps(const snd_ump_endpoint_info_t *info); 85unsigned int snd_ump_endpoint_info_get_protocol(const snd_ump_endpoint_info_t *info); 86unsigned int snd_ump_endpoint_info_get_num_blocks(const snd_ump_endpoint_info_t *info); 87unsigned int snd_ump_endpoint_info_get_version(const snd_ump_endpoint_info_t *info); 88unsigned int snd_ump_endpoint_info_get_manufacturer_id(const snd_ump_endpoint_info_t *info); 89unsigned int snd_ump_endpoint_info_get_family_id(const snd_ump_endpoint_info_t *info); 90unsigned int snd_ump_endpoint_info_get_model_id(const snd_ump_endpoint_info_t *info); 91const unsigned char *snd_ump_endpoint_info_get_sw_revision(const snd_ump_endpoint_info_t *info); 92const char *snd_ump_endpoint_info_get_name(const snd_ump_endpoint_info_t *info); 93const char *snd_ump_endpoint_info_get_product_id(const snd_ump_endpoint_info_t *info); 94int snd_ump_endpoint_info(snd_ump_t *ump, snd_ump_endpoint_info_t *info); 95 96/** Bit flag for MIDI 1.0 port w/o restrict in UMP Block info flags */ 97#define SND_UMP_BLOCK_IS_MIDI1 (1U << 0) 98/** Bit flag for 31.25Kbps B/W MIDI1 port in UMP Block info flags */ 99#define SND_UMP_BLOCK_IS_LOWSPEED (1U << 1) 100 101/** UMP block user-interface hint */ 102enum _snd_ump_block_ui_hint { 103 /** Unknown or undeclared */ 104 SND_UMP_BLOCK_UI_HINT_UNKNOWN = 0x00, 105 /** Primarily a receiver or a destination for MIDI messages */ 106 SND_UMP_BLOCK_UI_HINT_RECEIVER = 0x01, 107 /** Primarily a sender or a source of MIDI messages */ 108 SND_UMP_BLOCK_UI_HINT_SENDER = 0x02, 109 /** Both a sender and receiver of MIDI messages */ 110 SND_UMP_BLOCK_UI_HINT_BOTH = 0x03, 111}; 112 113size_t snd_ump_block_info_sizeof(void); 114/** \hideinitializer 115 * \brief allocate an invalid #snd_ump_block_info_t using standard alloca 116 * \param ptr returned pointer 117 */ 118#define snd_ump_block_info_alloca(ptr) __snd_alloca(ptr, snd_ump_block_info) 119int snd_ump_block_info_malloc(snd_ump_block_info_t **info); 120void snd_ump_block_info_free(snd_ump_block_info_t *info); 121void snd_ump_block_info_copy(snd_ump_block_info_t *dst, const snd_ump_block_info_t *src); 122int snd_ump_block_info_get_card(const snd_ump_block_info_t *info); 123int snd_ump_block_info_get_device(const snd_ump_block_info_t *info); 124unsigned int snd_ump_block_info_get_block_id(const snd_ump_block_info_t *info); 125void snd_ump_block_info_set_block_id(snd_ump_block_info_t *info, unsigned int id); 126unsigned int snd_ump_block_info_get_active(const snd_ump_block_info_t *info); 127unsigned int snd_ump_block_info_get_flags(const snd_ump_block_info_t *info); 128unsigned int snd_ump_block_info_get_direction(const snd_ump_block_info_t *info); 129unsigned int snd_ump_block_info_get_first_group(const snd_ump_block_info_t *info); 130unsigned int snd_ump_block_info_get_num_groups(const snd_ump_block_info_t *info); 131unsigned int snd_ump_block_info_get_midi_ci_version(const snd_ump_block_info_t *info); 132unsigned int snd_ump_block_info_get_sysex8_streams(const snd_ump_block_info_t *info); 133unsigned int snd_ump_block_info_get_ui_hint(const snd_ump_block_info_t *info); 134const char *snd_ump_block_info_get_name(const snd_ump_block_info_t *info); 135int snd_ump_block_info(snd_ump_t *ump, snd_ump_block_info_t *info); 136 137#ifdef __cplusplus 138} 139#endif 140 141#endif /* __ALSA_UMP_H */ 142