mirror of
https://github.com/alsa-project/alsa-lib.git
synced 2025-10-29 05:40:25 -04:00
ea83756fbe
the function itself still exists for compatibility but protected by DOC_HIDDEN. - a bit more comments about snd_seq_free_event. - since alsa.m4 used snd_seq_create_event for checking libasound, now it's replaced with snd_ctl_open.
712 lines
30 KiB
C
712 lines
30 KiB
C
/**
|
|
* \file <alsa/seq.h>
|
|
* \brief Application interface library for the ALSA driver
|
|
* \author Jaroslav Kysela <perex@suse.cz>
|
|
* \author Abramo Bagnara <abramo@alsa-project.org>
|
|
* \author Takashi Iwai <tiwai@suse.de>
|
|
* \date 1998-2001
|
|
*/
|
|
/*
|
|
* Application interface library for the ALSA driver
|
|
*
|
|
*
|
|
* This library is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as
|
|
* published by the Free Software Foundation; either version 2.1 of
|
|
* the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*
|
|
*/
|
|
|
|
#ifndef __ALSA_SEQ_H
|
|
#define __ALSA_SEQ_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* \defgroup Sequencer MIDI Sequencer
|
|
* MIDI Sequencer Interface.
|
|
* See \ref seq page for more details.
|
|
* \{
|
|
*/
|
|
|
|
/** dlsym version for interface entry callback */
|
|
#define SND_SEQ_DLSYM_VERSION _dlsym_seq_001
|
|
|
|
/** Sequencer handle */
|
|
typedef struct _snd_seq snd_seq_t;
|
|
|
|
/** Allocate and initialize array on stack \internal */
|
|
#define SND_ALLOCA(type,ptr) \
|
|
do {\
|
|
assert(ptr);\
|
|
*ptr = (type##_t *)alloca(type##_sizeof());\
|
|
memset(*ptr, 0, type##_sizeof());\
|
|
} while (0)
|
|
|
|
/**
|
|
* sequencer opening stream types
|
|
*/
|
|
#define SND_SEQ_OPEN_OUTPUT 1 /**< open for output (write) */
|
|
#define SND_SEQ_OPEN_INPUT 2 /**< open for input (read) */
|
|
#define SND_SEQ_OPEN_DUPLEX (SND_SEQ_OPEN_OUTPUT|SND_SEQ_OPEN_INPUT) /**< open for both input and output (read/write) */
|
|
|
|
/**
|
|
* sequencer opening mode
|
|
*/
|
|
#define SND_SEQ_NONBLOCK 0x0001 /**< non-blocking mode (flag to open mode) */
|
|
|
|
/** sequencer handle type */
|
|
typedef enum _snd_seq_type {
|
|
SND_SEQ_TYPE_HW, /**< hardware */
|
|
SND_SEQ_TYPE_SHM, /**< shared memory (NYI) */
|
|
SND_SEQ_TYPE_INET /**< network (NYI) */
|
|
} snd_seq_type_t;
|
|
|
|
/** special client (port) ids */
|
|
#define SND_SEQ_ADDRESS_UNKNOWN 253 /**< unknown source */
|
|
#define SND_SEQ_ADDRESS_SUBSCRIBERS 254 /**< send event to all subscribed ports */
|
|
#define SND_SEQ_ADDRESS_BROADCAST 255 /**< send event to all queues/clients/ports/channels */
|
|
|
|
/** known client numbers */
|
|
#define SND_SEQ_CLIENT_SYSTEM 0 /**< system client */
|
|
#define SND_SEQ_CLIENT_DUMMY 62 /**< dummy ports */
|
|
#define SND_SEQ_CLIENT_OSS 63 /**< OSS sequencer emulator */
|
|
|
|
/*
|
|
*/
|
|
int snd_seq_open(snd_seq_t **handle, const char *name, int streams, int mode);
|
|
int snd_seq_open_lconf(snd_seq_t **handle, const char *name, int streams, int mode, snd_config_t *lconf);
|
|
const char *snd_seq_name(snd_seq_t *seq);
|
|
snd_seq_type_t snd_seq_type(snd_seq_t *seq);
|
|
int snd_seq_close(snd_seq_t *handle);
|
|
int snd_seq_poll_descriptors_count(snd_seq_t *handle, short events);
|
|
int snd_seq_poll_descriptors(snd_seq_t *handle, struct pollfd *pfds, unsigned int space, short events);
|
|
int snd_seq_poll_descriptors_revents(snd_seq_t *seq, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
|
|
int snd_seq_nonblock(snd_seq_t *handle, int nonblock);
|
|
int snd_seq_client_id(snd_seq_t *handle);
|
|
|
|
size_t snd_seq_get_output_buffer_size(snd_seq_t *handle);
|
|
size_t snd_seq_get_input_buffer_size(snd_seq_t *handle);
|
|
int snd_seq_set_output_buffer_size(snd_seq_t *handle, size_t size);
|
|
int snd_seq_set_input_buffer_size(snd_seq_t *handle, size_t size);
|
|
|
|
/** system information container */
|
|
typedef struct _snd_seq_system_info snd_seq_system_info_t;
|
|
|
|
size_t snd_seq_system_info_sizeof(void);
|
|
/** allocate a #snd_seq_system_info_t container on stack */
|
|
#define snd_seq_system_info_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_system_info, ptr)
|
|
int snd_seq_system_info_malloc(snd_seq_system_info_t **ptr);
|
|
void snd_seq_system_info_free(snd_seq_system_info_t *ptr);
|
|
void snd_seq_system_info_copy(snd_seq_system_info_t *dst, const snd_seq_system_info_t *src);
|
|
|
|
int snd_seq_system_info_get_queues(const snd_seq_system_info_t *info);
|
|
int snd_seq_system_info_get_clients(const snd_seq_system_info_t *info);
|
|
int snd_seq_system_info_get_ports(const snd_seq_system_info_t *info);
|
|
int snd_seq_system_info_get_channels(const snd_seq_system_info_t *info);
|
|
int snd_seq_system_info_get_cur_clients(const snd_seq_system_info_t *info);
|
|
int snd_seq_system_info_get_cur_queues(const snd_seq_system_info_t *info);
|
|
|
|
int snd_seq_system_info(snd_seq_t *handle, snd_seq_system_info_t *info);
|
|
|
|
/** \} */
|
|
|
|
|
|
/**
|
|
* \defgroup SeqClient Sequencer Client Interface
|
|
* Sequencer Client Interface
|
|
* \ingroup Sequencer
|
|
* \{
|
|
*/
|
|
|
|
/** client information container */
|
|
typedef struct _snd_seq_client_info snd_seq_client_info_t;
|
|
|
|
/** client types */
|
|
typedef enum snd_seq_client_type {
|
|
SND_SEQ_USER_CLIENT = 1, /**< user client */
|
|
SND_SEQ_KERNEL_CLIENT = 2 /**< kernel client */
|
|
} snd_seq_client_type_t;
|
|
|
|
size_t snd_seq_client_info_sizeof(void);
|
|
/** allocate a #snd_seq_client_info_t container on stack */
|
|
#define snd_seq_client_info_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_client_info, ptr)
|
|
int snd_seq_client_info_malloc(snd_seq_client_info_t **ptr);
|
|
void snd_seq_client_info_free(snd_seq_client_info_t *ptr);
|
|
void snd_seq_client_info_copy(snd_seq_client_info_t *dst, const snd_seq_client_info_t *src);
|
|
|
|
int snd_seq_client_info_get_client(const snd_seq_client_info_t *info);
|
|
snd_seq_client_type_t snd_seq_client_info_get_type(const snd_seq_client_info_t *info);
|
|
const char *snd_seq_client_info_get_name(snd_seq_client_info_t *info);
|
|
int snd_seq_client_info_get_broadcast_filter(const snd_seq_client_info_t *info);
|
|
int snd_seq_client_info_get_error_bounce(const snd_seq_client_info_t *info);
|
|
const unsigned char *snd_seq_client_info_get_event_filter(const snd_seq_client_info_t *info);
|
|
int snd_seq_client_info_get_num_ports(const snd_seq_client_info_t *info);
|
|
int snd_seq_client_info_get_event_lost(const snd_seq_client_info_t *info);
|
|
|
|
void snd_seq_client_info_set_client(snd_seq_client_info_t *info, int client);
|
|
void snd_seq_client_info_set_name(snd_seq_client_info_t *info, const char *name);
|
|
void snd_seq_client_info_set_broadcast_filter(snd_seq_client_info_t *info, int val);
|
|
void snd_seq_client_info_set_error_bounce(snd_seq_client_info_t *info, int val);
|
|
void snd_seq_client_info_set_event_filter(snd_seq_client_info_t *info, unsigned char *filter);
|
|
|
|
int snd_seq_get_client_info(snd_seq_t *handle, snd_seq_client_info_t *info);
|
|
int snd_seq_get_any_client_info(snd_seq_t *handle, int client, snd_seq_client_info_t *info);
|
|
int snd_seq_set_client_info(snd_seq_t *handle, snd_seq_client_info_t *info);
|
|
int snd_seq_query_next_client(snd_seq_t *handle, snd_seq_client_info_t *info);
|
|
|
|
/*
|
|
*/
|
|
|
|
/** client pool information container */
|
|
typedef struct _snd_seq_client_pool snd_seq_client_pool_t;
|
|
|
|
size_t snd_seq_client_pool_sizeof(void);
|
|
/** allocate a #snd_seq_client_pool_t container on stack */
|
|
#define snd_seq_client_pool_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_client_pool, ptr)
|
|
int snd_seq_client_pool_malloc(snd_seq_client_pool_t **ptr);
|
|
void snd_seq_client_pool_free(snd_seq_client_pool_t *ptr);
|
|
void snd_seq_client_pool_copy(snd_seq_client_pool_t *dst, const snd_seq_client_pool_t *src);
|
|
|
|
int snd_seq_client_pool_get_client(const snd_seq_client_pool_t *info);
|
|
size_t snd_seq_client_pool_get_output_pool(const snd_seq_client_pool_t *info);
|
|
size_t snd_seq_client_pool_get_input_pool(const snd_seq_client_pool_t *info);
|
|
size_t snd_seq_client_pool_get_output_room(const snd_seq_client_pool_t *info);
|
|
size_t snd_seq_client_pool_get_output_free(const snd_seq_client_pool_t *info);
|
|
size_t snd_seq_client_pool_get_input_free(const snd_seq_client_pool_t *info);
|
|
void snd_seq_client_pool_set_output_pool(snd_seq_client_pool_t *info, size_t size);
|
|
void snd_seq_client_pool_set_input_pool(snd_seq_client_pool_t *info, size_t size);
|
|
void snd_seq_client_pool_set_output_room(snd_seq_client_pool_t *info, size_t size);
|
|
|
|
int snd_seq_get_client_pool(snd_seq_t *handle, snd_seq_client_pool_t *info);
|
|
int snd_seq_set_client_pool(snd_seq_t *handle, snd_seq_client_pool_t *info);
|
|
|
|
|
|
/** \} */
|
|
|
|
|
|
/**
|
|
* \defgroup SeqPort Sequencer Port Interface
|
|
* Sequencer Port Interface
|
|
* \ingroup Sequencer
|
|
* \{
|
|
*/
|
|
|
|
/** port information container */
|
|
typedef struct _snd_seq_port_info snd_seq_port_info_t;
|
|
|
|
/** known port numbers */
|
|
#define SND_SEQ_PORT_SYSTEM_TIMER 0 /**< system timer port */
|
|
#define SND_SEQ_PORT_SYSTEM_ANNOUNCE 1 /**< system announce port */
|
|
|
|
/** port capabilities (32 bits) */
|
|
#define SND_SEQ_PORT_CAP_READ (1<<0) /**< readable from this port */
|
|
#define SND_SEQ_PORT_CAP_WRITE (1<<1) /**< writable to this port */
|
|
|
|
#define SND_SEQ_PORT_CAP_SYNC_READ (1<<2) /**< allow read subscriptions */
|
|
#define SND_SEQ_PORT_CAP_SYNC_WRITE (1<<3) /**< allow write subscriptions */
|
|
|
|
#define SND_SEQ_PORT_CAP_DUPLEX (1<<4) /**< allow read/write duplex */
|
|
|
|
#define SND_SEQ_PORT_CAP_SUBS_READ (1<<5) /**< allow read subscription */
|
|
#define SND_SEQ_PORT_CAP_SUBS_WRITE (1<<6) /**< allow write subscription */
|
|
#define SND_SEQ_PORT_CAP_NO_EXPORT (1<<7) /**< routing not allowed */
|
|
|
|
/** port type */
|
|
#define SND_SEQ_PORT_TYPE_SPECIFIC (1<<0) /**< hardware specific */
|
|
#define SND_SEQ_PORT_TYPE_MIDI_GENERIC (1<<1) /**< generic MIDI device */
|
|
#define SND_SEQ_PORT_TYPE_MIDI_GM (1<<2) /**< General MIDI compatible device */
|
|
#define SND_SEQ_PORT_TYPE_MIDI_GS (1<<3) /**< GS compatible device */
|
|
#define SND_SEQ_PORT_TYPE_MIDI_XG (1<<4) /**< XG compatible device */
|
|
#define SND_SEQ_PORT_TYPE_MIDI_MT32 (1<<5) /**< MT-32 compatible device */
|
|
#define SND_SEQ_PORT_TYPE_SYNTH (1<<10) /**< Synth device */
|
|
#define SND_SEQ_PORT_TYPE_DIRECT_SAMPLE (1<<11) /**< Sampling device (support sample download) */
|
|
#define SND_SEQ_PORT_TYPE_SAMPLE (1<<12) /**< Sampling device (sample can be downloaded at any time) */
|
|
#define SND_SEQ_PORT_TYPE_APPLICATION (1<<20) /**< application (sequencer/editor) */
|
|
|
|
|
|
size_t snd_seq_port_info_sizeof(void);
|
|
/** allocate a #snd_seq_port_info_t container on stack */
|
|
#define snd_seq_port_info_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_port_info, ptr)
|
|
int snd_seq_port_info_malloc(snd_seq_port_info_t **ptr);
|
|
void snd_seq_port_info_free(snd_seq_port_info_t *ptr);
|
|
void snd_seq_port_info_copy(snd_seq_port_info_t *dst, const snd_seq_port_info_t *src);
|
|
|
|
int snd_seq_port_info_get_client(const snd_seq_port_info_t *info);
|
|
int snd_seq_port_info_get_port(const snd_seq_port_info_t *info);
|
|
const snd_seq_addr_t *snd_seq_port_info_get_addr(const snd_seq_port_info_t *info);
|
|
const char *snd_seq_port_info_get_name(const snd_seq_port_info_t *info);
|
|
unsigned int snd_seq_port_info_get_capability(const snd_seq_port_info_t *info);
|
|
unsigned int snd_seq_port_info_get_type(const snd_seq_port_info_t *info);
|
|
int snd_seq_port_info_get_midi_channels(const snd_seq_port_info_t *info);
|
|
int snd_seq_port_info_get_midi_voices(const snd_seq_port_info_t *info);
|
|
int snd_seq_port_info_get_synth_voices(const snd_seq_port_info_t *info);
|
|
int snd_seq_port_info_get_read_use(const snd_seq_port_info_t *info);
|
|
int snd_seq_port_info_get_write_use(const snd_seq_port_info_t *info);
|
|
int snd_seq_port_info_get_port_specified(const snd_seq_port_info_t *info);
|
|
|
|
void snd_seq_port_info_set_client(snd_seq_port_info_t *info, int client);
|
|
void snd_seq_port_info_set_port(snd_seq_port_info_t *info, int port);
|
|
void snd_seq_port_info_set_addr(snd_seq_port_info_t *info, const snd_seq_addr_t *addr);
|
|
void snd_seq_port_info_set_name(snd_seq_port_info_t *info, const char *name);
|
|
void snd_seq_port_info_set_capability(snd_seq_port_info_t *info, unsigned int capability);
|
|
void snd_seq_port_info_set_type(snd_seq_port_info_t *info, unsigned int type);
|
|
void snd_seq_port_info_set_midi_channels(snd_seq_port_info_t *info, int channels);
|
|
void snd_seq_port_info_set_midi_voices(snd_seq_port_info_t *info, int voices);
|
|
void snd_seq_port_info_set_synth_voices(snd_seq_port_info_t *info, int voices);
|
|
void snd_seq_port_info_set_port_specified(snd_seq_port_info_t *info, int val);
|
|
|
|
int snd_seq_create_port(snd_seq_t *handle, snd_seq_port_info_t *info);
|
|
int snd_seq_delete_port(snd_seq_t *handle, int port);
|
|
int snd_seq_get_port_info(snd_seq_t *handle, int port, snd_seq_port_info_t *info);
|
|
int snd_seq_get_any_port_info(snd_seq_t *handle, int client, int port, snd_seq_port_info_t *info);
|
|
int snd_seq_set_port_info(snd_seq_t *handle, int port, snd_seq_port_info_t *info);
|
|
int snd_seq_query_next_port(snd_seq_t *handle, snd_seq_port_info_t *info);
|
|
|
|
/** \} */
|
|
|
|
|
|
/**
|
|
* \defgroup SeqSubscribe Sequencer Port Subscription
|
|
* Sequencer Port Subscription
|
|
* \ingroup Sequencer
|
|
* \{
|
|
*/
|
|
|
|
/** port subscription container */
|
|
typedef struct _snd_seq_port_subscribe snd_seq_port_subscribe_t;
|
|
|
|
size_t snd_seq_port_subscribe_sizeof(void);
|
|
/** allocate a #snd_seq_port_subscribe_t container on stack */
|
|
#define snd_seq_port_subscribe_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_port_subscribe, ptr)
|
|
int snd_seq_port_subscribe_malloc(snd_seq_port_subscribe_t **ptr);
|
|
void snd_seq_port_subscribe_free(snd_seq_port_subscribe_t *ptr);
|
|
void snd_seq_port_subscribe_copy(snd_seq_port_subscribe_t *dst, const snd_seq_port_subscribe_t *src);
|
|
|
|
const snd_seq_addr_t *snd_seq_port_subscribe_get_sender(const snd_seq_port_subscribe_t *info);
|
|
const snd_seq_addr_t *snd_seq_port_subscribe_get_dest(const snd_seq_port_subscribe_t *info);
|
|
int snd_seq_port_subscribe_get_queue(const snd_seq_port_subscribe_t *info);
|
|
int snd_seq_port_subscribe_get_exclusive(const snd_seq_port_subscribe_t *info);
|
|
int snd_seq_port_subscribe_get_time_update(const snd_seq_port_subscribe_t *info);
|
|
int snd_seq_port_subscribe_get_time_real(const snd_seq_port_subscribe_t *info);
|
|
|
|
void snd_seq_port_subscribe_set_sender(snd_seq_port_subscribe_t *info, const snd_seq_addr_t *addr);
|
|
void snd_seq_port_subscribe_set_dest(snd_seq_port_subscribe_t *info, const snd_seq_addr_t *addr);
|
|
void snd_seq_port_subscribe_set_queue(snd_seq_port_subscribe_t *info, int q);
|
|
void snd_seq_port_subscribe_set_voices(snd_seq_port_subscribe_t *info, unsigned int voices);
|
|
void snd_seq_port_subscribe_set_exclusive(snd_seq_port_subscribe_t *info, int val);
|
|
void snd_seq_port_subscribe_set_time_update(snd_seq_port_subscribe_t *info, int val);
|
|
void snd_seq_port_subscribe_set_time_real(snd_seq_port_subscribe_t *info, int val);
|
|
|
|
int snd_seq_get_port_subscription(snd_seq_t *handle, snd_seq_port_subscribe_t *sub);
|
|
int snd_seq_subscribe_port(snd_seq_t *handle, snd_seq_port_subscribe_t *sub);
|
|
int snd_seq_unsubscribe_port(snd_seq_t *handle, snd_seq_port_subscribe_t *sub);
|
|
|
|
/*
|
|
*/
|
|
|
|
/** subscription query container */
|
|
typedef struct _snd_seq_query_subscribe snd_seq_query_subscribe_t;
|
|
|
|
/** type of query subscription */
|
|
typedef enum {
|
|
SND_SEQ_QUERY_SUBS_READ, /**< query read subscriptions */
|
|
SND_SEQ_QUERY_SUBS_WRITE /**< query write subscriptions */
|
|
} snd_seq_query_subs_type_t;
|
|
|
|
size_t snd_seq_query_subscribe_sizeof(void);
|
|
/** allocate a #snd_seq_query_subscribe_t container on stack */
|
|
#define snd_seq_query_subscribe_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_query_subscribe, ptr)
|
|
int snd_seq_query_subscribe_malloc(snd_seq_query_subscribe_t **ptr);
|
|
void snd_seq_query_subscribe_free(snd_seq_query_subscribe_t *ptr);
|
|
void snd_seq_query_subscribe_copy(snd_seq_query_subscribe_t *dst, const snd_seq_query_subscribe_t *src);
|
|
|
|
int snd_seq_query_subscribe_get_client(const snd_seq_query_subscribe_t *info);
|
|
int snd_seq_query_subscribe_get_port(const snd_seq_query_subscribe_t *info);
|
|
const snd_seq_addr_t *snd_seq_query_subscribe_get_root(const snd_seq_query_subscribe_t *info);
|
|
snd_seq_query_subs_type_t snd_seq_query_subscribe_get_type(const snd_seq_query_subscribe_t *info);
|
|
int snd_seq_query_subscribe_get_index(const snd_seq_query_subscribe_t *info);
|
|
int snd_seq_query_subscribe_get_num_subs(const snd_seq_query_subscribe_t *info);
|
|
const snd_seq_addr_t *snd_seq_query_subscribe_get_addr(const snd_seq_query_subscribe_t *info);
|
|
int snd_seq_query_subscribe_get_queue(const snd_seq_query_subscribe_t *info);
|
|
int snd_seq_query_subscribe_get_exclusive(const snd_seq_query_subscribe_t *info);
|
|
int snd_seq_query_subscribe_get_time_update(const snd_seq_query_subscribe_t *info);
|
|
int snd_seq_query_subscribe_get_time_real(const snd_seq_query_subscribe_t *info);
|
|
|
|
void snd_seq_query_subscribe_set_client(snd_seq_query_subscribe_t *info, int client);
|
|
void snd_seq_query_subscribe_set_port(snd_seq_query_subscribe_t *info, int port);
|
|
void snd_seq_query_subscribe_set_root(snd_seq_query_subscribe_t *info, const snd_seq_addr_t *addr);
|
|
void snd_seq_query_subscribe_set_type(snd_seq_query_subscribe_t *info, snd_seq_query_subs_type_t type);
|
|
void snd_seq_query_subscribe_set_index(snd_seq_query_subscribe_t *info, int index);
|
|
|
|
int snd_seq_query_port_subscribers(snd_seq_t *seq, snd_seq_query_subscribe_t * subs);
|
|
|
|
/** \} */
|
|
|
|
|
|
/**
|
|
* \defgroup SeqQueue Sequencer Queue Interface
|
|
* Sequencer Queue Interface
|
|
* \ingroup Sequencer
|
|
* \{
|
|
*/
|
|
|
|
/** queue information container */
|
|
typedef struct _snd_seq_queue_info snd_seq_queue_info_t;
|
|
/** queue status container */
|
|
typedef struct _snd_seq_queue_status snd_seq_queue_status_t;
|
|
/** queue tempo container */
|
|
typedef struct _snd_seq_queue_tempo snd_seq_queue_tempo_t;
|
|
/** queue timer information container */
|
|
typedef struct _snd_seq_queue_timer snd_seq_queue_timer_t;
|
|
|
|
/** special queue ids */
|
|
#define SND_SEQ_QUEUE_DIRECT 253 /**< direct dispatch */
|
|
|
|
size_t snd_seq_queue_info_sizeof(void);
|
|
/** allocate a #snd_seq_queue_info_t container on stack */
|
|
#define snd_seq_queue_info_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_queue_info, ptr)
|
|
int snd_seq_queue_info_malloc(snd_seq_queue_info_t **ptr);
|
|
void snd_seq_queue_info_free(snd_seq_queue_info_t *ptr);
|
|
void snd_seq_queue_info_copy(snd_seq_queue_info_t *dst, const snd_seq_queue_info_t *src);
|
|
|
|
int snd_seq_queue_info_get_queue(const snd_seq_queue_info_t *info);
|
|
const char *snd_seq_queue_info_get_name(const snd_seq_queue_info_t *info);
|
|
int snd_seq_queue_info_get_owner(const snd_seq_queue_info_t *info);
|
|
int snd_seq_queue_info_get_locked(const snd_seq_queue_info_t *info);
|
|
unsigned int snd_seq_queue_info_get_flags(const snd_seq_queue_info_t *info);
|
|
|
|
void snd_seq_queue_info_set_name(snd_seq_queue_info_t *info, const char *name);
|
|
void snd_seq_queue_info_set_owner(snd_seq_queue_info_t *info, int owner);
|
|
void snd_seq_queue_info_set_locked(snd_seq_queue_info_t *info, int locked);
|
|
void snd_seq_queue_info_set_flags(snd_seq_queue_info_t *info, unsigned int flags);
|
|
|
|
int snd_seq_create_queue(snd_seq_t *seq, snd_seq_queue_info_t *info);
|
|
int snd_seq_alloc_named_queue(snd_seq_t *seq, const char *name);
|
|
int snd_seq_alloc_queue(snd_seq_t *handle);
|
|
int snd_seq_free_queue(snd_seq_t *handle, int q);
|
|
int snd_seq_get_queue_info(snd_seq_t *seq, int q, snd_seq_queue_info_t *info);
|
|
int snd_seq_set_queue_info(snd_seq_t *seq, int q, snd_seq_queue_info_t *info);
|
|
int snd_seq_query_named_queue(snd_seq_t *seq, const char *name);
|
|
|
|
int snd_seq_get_queue_usage(snd_seq_t *handle, int q);
|
|
int snd_seq_set_queue_usage(snd_seq_t *handle, int q, int used);
|
|
|
|
/*
|
|
*/
|
|
size_t snd_seq_queue_status_sizeof(void);
|
|
/** allocate a #snd_seq_queue_status_t container on stack */
|
|
#define snd_seq_queue_status_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_queue_status, ptr)
|
|
int snd_seq_queue_status_malloc(snd_seq_queue_status_t **ptr);
|
|
void snd_seq_queue_status_free(snd_seq_queue_status_t *ptr);
|
|
void snd_seq_queue_status_copy(snd_seq_queue_status_t *dst, const snd_seq_queue_status_t *src);
|
|
|
|
int snd_seq_queue_status_get_queue(const snd_seq_queue_status_t *info);
|
|
int snd_seq_queue_status_get_events(const snd_seq_queue_status_t *info);
|
|
snd_seq_tick_time_t snd_seq_queue_status_get_tick_time(const snd_seq_queue_status_t *info);
|
|
const snd_seq_real_time_t *snd_seq_queue_status_get_real_time(const snd_seq_queue_status_t *info);
|
|
unsigned int snd_seq_queue_status_get_status(const snd_seq_queue_status_t *info);
|
|
|
|
int snd_seq_get_queue_status(snd_seq_t *handle, int q, snd_seq_queue_status_t *status);
|
|
|
|
/*
|
|
*/
|
|
size_t snd_seq_queue_tempo_sizeof(void);
|
|
/** allocate a #snd_seq_queue_tempo_t container on stack */
|
|
#define snd_seq_queue_tempo_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_queue_tempo, ptr)
|
|
int snd_seq_queue_tempo_malloc(snd_seq_queue_tempo_t **ptr);
|
|
void snd_seq_queue_tempo_free(snd_seq_queue_tempo_t *ptr);
|
|
void snd_seq_queue_tempo_copy(snd_seq_queue_tempo_t *dst, const snd_seq_queue_tempo_t *src);
|
|
|
|
int snd_seq_queue_tempo_get_queue(const snd_seq_queue_tempo_t *info);
|
|
unsigned int snd_seq_queue_tempo_get_tempo(const snd_seq_queue_tempo_t *info);
|
|
int snd_seq_queue_tempo_get_ppq(const snd_seq_queue_tempo_t *info);
|
|
unsigned int snd_seq_queue_tempo_get_skew(const snd_seq_queue_tempo_t *info);
|
|
unsigned int snd_seq_queue_tempo_get_skew_base(const snd_seq_queue_tempo_t *info);
|
|
void snd_seq_queue_tempo_set_tempo(snd_seq_queue_tempo_t *info, unsigned int tempo);
|
|
void snd_seq_queue_tempo_set_ppq(snd_seq_queue_tempo_t *info, int ppq);
|
|
void snd_seq_queue_tempo_set_skew(snd_seq_queue_tempo_t *info, unsigned int skew);
|
|
void snd_seq_queue_tempo_set_skew_base(snd_seq_queue_tempo_t *info, unsigned int base);
|
|
|
|
int snd_seq_get_queue_tempo(snd_seq_t *handle, int q, snd_seq_queue_tempo_t *tempo);
|
|
int snd_seq_set_queue_tempo(snd_seq_t *handle, int q, snd_seq_queue_tempo_t *tempo);
|
|
|
|
/*
|
|
*/
|
|
|
|
/** sequencer timer sources */
|
|
typedef enum {
|
|
SND_SEQ_TIMER_ALSA = 0, /* ALSA timer */
|
|
SND_SEQ_TIMER_MIDI_CLOCK = 1, /* Midi Clock (CLOCK event) */
|
|
SND_SEQ_TIMER_MIDI_TICK = 2 /* Midi Timer Tick (TICK event */
|
|
} snd_seq_queue_timer_type_t;
|
|
|
|
size_t snd_seq_queue_timer_sizeof(void);
|
|
/** allocate a #snd_seq_queue_timer_t container on stack */
|
|
#define snd_seq_queue_timer_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_queue_timer, ptr)
|
|
int snd_seq_queue_timer_malloc(snd_seq_queue_timer_t **ptr);
|
|
void snd_seq_queue_timer_free(snd_seq_queue_timer_t *ptr);
|
|
void snd_seq_queue_timer_copy(snd_seq_queue_timer_t *dst, const snd_seq_queue_timer_t *src);
|
|
|
|
int snd_seq_queue_timer_get_queue(const snd_seq_queue_timer_t *info);
|
|
snd_seq_queue_timer_type_t snd_seq_queue_timer_get_type(const snd_seq_queue_timer_t *info);
|
|
const snd_timer_id_t *snd_seq_queue_timer_get_id(const snd_seq_queue_timer_t *info);
|
|
unsigned int snd_seq_queue_timer_get_resolution(const snd_seq_queue_timer_t *info);
|
|
|
|
void snd_seq_queue_timer_set_type(snd_seq_queue_timer_t *info, snd_seq_queue_timer_type_t type);
|
|
void snd_seq_queue_timer_set_id(snd_seq_queue_timer_t *info, const snd_timer_id_t *id);
|
|
void snd_seq_queue_timer_set_resolution(snd_seq_queue_timer_t *info, unsigned int resolution);
|
|
|
|
int snd_seq_get_queue_timer(snd_seq_t *handle, int q, snd_seq_queue_timer_t *timer);
|
|
int snd_seq_set_queue_timer(snd_seq_t *handle, int q, snd_seq_queue_timer_t *timer);
|
|
|
|
/** \} */
|
|
|
|
/**
|
|
* \defgroup SeqEvent Sequencer Event API
|
|
* Sequencer Event API
|
|
* \ingroup Sequencer
|
|
* \{
|
|
*/
|
|
|
|
int snd_seq_free_event(snd_seq_event_t *ev);
|
|
ssize_t snd_seq_event_length(snd_seq_event_t *ev);
|
|
int snd_seq_event_output(snd_seq_t *handle, snd_seq_event_t *ev);
|
|
int snd_seq_event_output_buffer(snd_seq_t *handle, snd_seq_event_t *ev);
|
|
int snd_seq_event_output_direct(snd_seq_t *handle, snd_seq_event_t *ev);
|
|
int snd_seq_event_input(snd_seq_t *handle, snd_seq_event_t **ev);
|
|
int snd_seq_event_input_pending(snd_seq_t *seq, int fetch_sequencer);
|
|
int snd_seq_drain_output(snd_seq_t *handle);
|
|
int snd_seq_event_output_pending(snd_seq_t *seq);
|
|
int snd_seq_extract_output(snd_seq_t *handle, snd_seq_event_t **ev);
|
|
int snd_seq_drop_output(snd_seq_t *handle);
|
|
int snd_seq_drop_output_buffer(snd_seq_t *handle);
|
|
int snd_seq_drop_input(snd_seq_t *handle);
|
|
int snd_seq_drop_input_buffer(snd_seq_t *handle);
|
|
|
|
/** event removal conditionals */
|
|
typedef struct _snd_seq_remove_events snd_seq_remove_events_t;
|
|
|
|
/** Remove conditional flags */
|
|
#define SND_SEQ_REMOVE_INPUT (1<<0) /**< Flush input queues */
|
|
#define SND_SEQ_REMOVE_OUTPUT (1<<1) /**< Flush output queues */
|
|
#define SND_SEQ_REMOVE_DEST (1<<2) /**< Restrict by destination q:client:port */
|
|
#define SND_SEQ_REMOVE_DEST_CHANNEL (1<<3) /**< Restrict by channel */
|
|
#define SND_SEQ_REMOVE_TIME_BEFORE (1<<4) /**< Restrict to before time */
|
|
#define SND_SEQ_REMOVE_TIME_AFTER (1<<5) /**< Restrict to time or after */
|
|
#define SND_SEQ_REMOVE_TIME_TICK (1<<6) /**< Time is in ticks */
|
|
#define SND_SEQ_REMOVE_EVENT_TYPE (1<<7) /**< Restrict to event type */
|
|
#define SND_SEQ_REMOVE_IGNORE_OFF (1<<8) /**< Do not flush off events */
|
|
#define SND_SEQ_REMOVE_TAG_MATCH (1<<9) /**< Restrict to events with given tag */
|
|
|
|
size_t snd_seq_remove_events_sizeof(void);
|
|
/** allocate a #snd_seq_remove_events_t container on stack */
|
|
#define snd_seq_remove_events_alloca(ptr) \
|
|
SND_ALLOCA(snd_seq_remove_events, ptr)
|
|
int snd_seq_remove_events_malloc(snd_seq_remove_events_t **ptr);
|
|
void snd_seq_remove_events_free(snd_seq_remove_events_t *ptr);
|
|
void snd_seq_remove_events_copy(snd_seq_remove_events_t *dst, const snd_seq_remove_events_t *src);
|
|
|
|
unsigned int snd_seq_remove_events_get_condition(const snd_seq_remove_events_t *info);
|
|
int snd_seq_remove_events_get_queue(const snd_seq_remove_events_t *info);
|
|
const snd_seq_timestamp_t *snd_seq_remove_events_get_time(const snd_seq_remove_events_t *info);
|
|
const snd_seq_addr_t *snd_seq_remove_events_get_dest(const snd_seq_remove_events_t *info);
|
|
int snd_seq_remove_events_get_channel(const snd_seq_remove_events_t *info);
|
|
int snd_seq_remove_events_get_event_type(const snd_seq_remove_events_t *info);
|
|
int snd_seq_remove_events_get_tag(const snd_seq_remove_events_t *info);
|
|
|
|
void snd_seq_remove_events_set_condition(snd_seq_remove_events_t *info, unsigned int flags);
|
|
void snd_seq_remove_events_set_queue(snd_seq_remove_events_t *info, int queue);
|
|
void snd_seq_remove_events_set_time(snd_seq_remove_events_t *info, const snd_seq_timestamp_t *time);
|
|
void snd_seq_remove_events_set_dest(snd_seq_remove_events_t *info, const snd_seq_addr_t *addr);
|
|
void snd_seq_remove_events_set_channel(snd_seq_remove_events_t *info, int channel);
|
|
void snd_seq_remove_events_set_event_type(snd_seq_remove_events_t *info, int type);
|
|
void snd_seq_remove_events_set_tag(snd_seq_remove_events_t *info, int tag);
|
|
|
|
int snd_seq_remove_events(snd_seq_t *handle, snd_seq_remove_events_t *info);
|
|
|
|
/** \} */
|
|
|
|
/**
|
|
* \defgroup SeqMisc Sequencer Miscellaneous
|
|
* Sequencer Miscellaneous
|
|
* \ingroup Sequencer
|
|
* \{
|
|
*/
|
|
|
|
void snd_seq_set_bit(int nr, void *array);
|
|
int snd_seq_change_bit(int nr, void *array);
|
|
int snd_seq_get_bit(int nr, void *array);
|
|
|
|
/** \} */
|
|
|
|
|
|
/**
|
|
* \defgroup SeqEvType Sequencer Event Type Checks
|
|
* Sequencer Event Type Checks
|
|
* \ingroup Sequencer
|
|
* \{
|
|
*/
|
|
|
|
/* event type macros */
|
|
enum {
|
|
SND_SEQ_EVFLG_RESULT,
|
|
SND_SEQ_EVFLG_NOTE,
|
|
SND_SEQ_EVFLG_CONTROL,
|
|
SND_SEQ_EVFLG_QUEUE,
|
|
SND_SEQ_EVFLG_SYSTEM,
|
|
SND_SEQ_EVFLG_MESSAGE,
|
|
SND_SEQ_EVFLG_CONNECTION,
|
|
SND_SEQ_EVFLG_SAMPLE,
|
|
SND_SEQ_EVFLG_USERS,
|
|
SND_SEQ_EVFLG_INSTR,
|
|
SND_SEQ_EVFLG_QUOTE,
|
|
SND_SEQ_EVFLG_NONE,
|
|
SND_SEQ_EVFLG_RAW,
|
|
SND_SEQ_EVFLG_FIXED,
|
|
SND_SEQ_EVFLG_VARIABLE,
|
|
SND_SEQ_EVFLG_VARUSR
|
|
};
|
|
|
|
enum {
|
|
SND_SEQ_EVFLG_NOTE_ONEARG,
|
|
SND_SEQ_EVFLG_NOTE_TWOARG
|
|
};
|
|
|
|
enum {
|
|
SND_SEQ_EVFLG_QUEUE_NOARG,
|
|
SND_SEQ_EVFLG_QUEUE_TICK,
|
|
SND_SEQ_EVFLG_QUEUE_TIME,
|
|
SND_SEQ_EVFLG_QUEUE_VALUE
|
|
};
|
|
|
|
/**
|
|
* Exported event type table
|
|
*
|
|
* This table is referred by snd_seq_ev_is_xxx.
|
|
*/
|
|
extern const unsigned int snd_seq_event_types[];
|
|
|
|
#define _SND_SEQ_TYPE(x) (1<<(x)) /**< master type - 24bit */
|
|
#define _SND_SEQ_TYPE_OPT(x) ((x)<<24) /**< optional type - 8bit */
|
|
|
|
/** check the event type */
|
|
#define snd_seq_type_check(ev,x) (snd_seq_event_types[(ev)->type] & _SND_SEQ_TYPE(x))
|
|
|
|
/** event type check: result events */
|
|
#define snd_seq_ev_is_result_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_RESULT)
|
|
/** event type check: note events */
|
|
#define snd_seq_ev_is_note_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_NOTE)
|
|
/** event type check: control events */
|
|
#define snd_seq_ev_is_control_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_CONTROL)
|
|
/** event type check: channel specific events */
|
|
#define snd_seq_ev_is_channel_type(ev) \
|
|
(snd_seq_event_types[(ev)->type] & (_SND_SEQ_TYPE(SND_SEQ_EVFLG_NOTE) | _SND_SEQ_TYPE(SND_SEQ_EVFLG_CONTROL)))
|
|
|
|
/** event type check: queue control events */
|
|
#define snd_seq_ev_is_queue_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_QUEUE)
|
|
/** event type check: system status messages */
|
|
#define snd_seq_ev_is_message_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_MESSAGE)
|
|
/** event type check: system status messages */
|
|
#define snd_seq_ev_is_subscribe_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_CONNECTION)
|
|
/** event type check: sample messages */
|
|
#define snd_seq_ev_is_sample_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_SAMPLE)
|
|
/** event type check: user-defined messages */
|
|
#define snd_seq_ev_is_user_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_USERS)
|
|
/** event type check: instrument layer events */
|
|
#define snd_seq_ev_is_instr_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_INSTR)
|
|
/** event type check: fixed length events */
|
|
#define snd_seq_ev_is_fixed_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_FIXED)
|
|
/** event type check: variable length events */
|
|
#define snd_seq_ev_is_variable_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_VARIABLE)
|
|
/** event type check: user pointer events */
|
|
#define snd_seq_ev_is_varusr_type(ev) \
|
|
snd_seq_type_check(ev, SND_SEQ_EVFLG_VARUSR)
|
|
/** event type check: reserved for kernel */
|
|
#define snd_seq_ev_is_reserved(ev) \
|
|
(! snd_seq_event_types[(ev)->type])
|
|
|
|
/**
|
|
* macros to check event flags
|
|
*/
|
|
/** prior events */
|
|
#define snd_seq_ev_is_prior(ev) \
|
|
(((ev)->flags & SND_SEQ_PRIORITY_MASK) == SND_SEQ_PRIORITY_HIGH)
|
|
|
|
/** get the data length type */
|
|
#define snd_seq_ev_length_type(ev) \
|
|
((ev)->flags & SND_SEQ_EVENT_LENGTH_MASK)
|
|
/** fixed length events */
|
|
#define snd_seq_ev_is_fixed(ev) \
|
|
(snd_seq_ev_length_type(ev) == SND_SEQ_EVENT_LENGTH_FIXED)
|
|
/** variable length events */
|
|
#define snd_seq_ev_is_variable(ev) \
|
|
(snd_seq_ev_length_type(ev) == SND_SEQ_EVENT_LENGTH_VARIABLE)
|
|
/** variable length on user-space */
|
|
#define snd_seq_ev_is_varusr(ev) \
|
|
(snd_seq_ev_length_type(ev) == SND_SEQ_EVENT_LENGTH_VARUSR)
|
|
|
|
/** time-stamp type */
|
|
#define snd_seq_ev_timestamp_type(ev) \
|
|
((ev)->flags & SND_SEQ_TIME_STAMP_MASK)
|
|
/** event is in tick time */
|
|
#define snd_seq_ev_is_tick(ev) \
|
|
(snd_seq_ev_timestamp_type(ev) == SND_SEQ_TIME_STAMP_TICK)
|
|
/** event is in real-time */
|
|
#define snd_seq_ev_is_real(ev) \
|
|
(snd_seq_ev_timestamp_type(ev) == SND_SEQ_TIME_STAMP_REAL)
|
|
|
|
/** time-mode type */
|
|
#define snd_seq_ev_timemode_type(ev) \
|
|
((ev)->flags & SND_SEQ_TIME_MODE_MASK)
|
|
/** scheduled in absolute time */
|
|
#define snd_seq_ev_is_abstime(ev) \
|
|
(snd_seq_ev_timemode_type(ev) == SND_SEQ_TIME_MODE_ABS)
|
|
/** scheduled in relative time */
|
|
#define snd_seq_ev_is_reltime(ev) \
|
|
(snd_seq_ev_timemode_type(ev) == SND_SEQ_TIME_MODE_REL)
|
|
|
|
/** direct dispatched events */
|
|
#define snd_seq_ev_is_direct(ev) \
|
|
((ev)->queue == SND_SEQ_QUEUE_DIRECT)
|
|
|
|
/** \} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ALSA_SEQ_H */
|
|
|