Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages   Examples  

Sequencer Queue Interface
[MIDI Sequencer]


Defines

#define SND_SEQ_QUEUE_DIRECT   253 /**< direct dispatch */
#define snd_seq_queue_info_alloca(ptr)   SND_ALLOCA(snd_seq_queue_info, ptr)
#define snd_seq_queue_status_alloca(ptr)   SND_ALLOCA(snd_seq_queue_status, ptr)
#define snd_seq_queue_tempo_alloca(ptr)   SND_ALLOCA(snd_seq_queue_tempo, ptr)
#define snd_seq_queue_timer_alloca(ptr)   SND_ALLOCA(snd_seq_queue_timer, ptr)

Typedefs

typedef _snd_seq_queue_info snd_seq_queue_info_t
typedef _snd_seq_queue_status snd_seq_queue_status_t
typedef _snd_seq_queue_tempo snd_seq_queue_tempo_t
typedef _snd_seq_queue_timer snd_seq_queue_timer_t

Enumerations

enum  snd_seq_queue_timer_type_t { SND_SEQ_TIMER_ALSA = 0, SND_SEQ_TIMER_MIDI_CLOCK = 1, SND_SEQ_TIMER_MIDI_TICK = 2 }

Functions

size_t snd_seq_queue_info_sizeof (void)
 get size of snd_seq_queue_info_t. More...

int snd_seq_queue_info_malloc (snd_seq_queue_info_t **ptr)
 allocate an empty snd_seq_queue_info_t using standard malloc. More...

void snd_seq_queue_info_free (snd_seq_queue_info_t *ptr)
 frees a previously allocated snd_seq_queue_info_t. More...

void snd_seq_queue_info_copy (snd_seq_queue_info_t *dst, const snd_seq_queue_info_t *src)
 copy one snd_seq_queue_info_t to another. More...

int snd_seq_queue_info_get_queue (const snd_seq_queue_info_t *info)
 Get the queue id of a queue_info container. More...

const char * snd_seq_queue_info_get_name (const snd_seq_queue_info_t *info)
 Get the name of a queue_info container. More...

int snd_seq_queue_info_get_owner (const snd_seq_queue_info_t *info)
 Get the owner client id of a queue_info container. More...

int snd_seq_queue_info_get_locked (const snd_seq_queue_info_t *info)
 Get the lock status of a queue_info container. More...

unsigned int snd_seq_queue_info_get_flags (const snd_seq_queue_info_t *info)
 Get the conditional bit flags of a queue_info container. More...

void snd_seq_queue_info_set_name (snd_seq_queue_info_t *info, const char *name)
 Set the name of a queue_info container. More...

void snd_seq_queue_info_set_owner (snd_seq_queue_info_t *info, int owner)
 Set the owner client id of a queue_info container. More...

void snd_seq_queue_info_set_locked (snd_seq_queue_info_t *info, int locked)
 Set the lock status of a queue_info container. More...

void snd_seq_queue_info_set_flags (snd_seq_queue_info_t *info, unsigned int flags)
 Set the conditional bit flags of a queue_info container. More...

int snd_seq_create_queue (snd_seq_t *seq, snd_seq_queue_info_t *info)
 create a queue. More...

int snd_seq_alloc_named_queue (snd_seq_t *seq, const char *name)
 allocate a queue with the specified name. More...

int snd_seq_alloc_queue (snd_seq_t *handle)
 allocate a queue. More...

int snd_seq_free_queue (snd_seq_t *handle, int q)
 delete the specified queue. More...

int snd_seq_get_queue_info (snd_seq_t *seq, int q, snd_seq_queue_info_t *info)
 obtain queue attributes. More...

int snd_seq_set_queue_info (snd_seq_t *seq, int q, snd_seq_queue_info_t *info)
 change the queue attributes. More...

int snd_seq_query_named_queue (snd_seq_t *seq, const char *name)
 query the matching queue with the specified name. More...

int snd_seq_get_queue_usage (snd_seq_t *handle, int q)
 Get the queue usage flag to the client. More...

int snd_seq_set_queue_usage (snd_seq_t *handle, int q, int used)
 Set the queue usage flag to the client. More...

size_t snd_seq_queue_status_sizeof (void)
 get size of snd_seq_queue_status_t. More...

int snd_seq_queue_status_malloc (snd_seq_queue_status_t **ptr)
 allocate an empty snd_seq_queue_status_t using standard malloc. More...

void snd_seq_queue_status_free (snd_seq_queue_status_t *ptr)
 frees a previously allocated snd_seq_queue_status_t. More...

void snd_seq_queue_status_copy (snd_seq_queue_status_t *dst, const snd_seq_queue_status_t *src)
 copy one snd_seq_queue_status_t to another. More...

int snd_seq_queue_status_get_queue (const snd_seq_queue_status_t *info)
 Get the queue id of a queue_status container. More...

int snd_seq_queue_status_get_events (const snd_seq_queue_status_t *info)
 Get the number of events of a queue_status container. More...

snd_seq_tick_time_t snd_seq_queue_status_get_tick_time (const snd_seq_queue_status_t *info)
 Get the tick time of a queue_status container. More...

const snd_seq_real_time_tsnd_seq_queue_status_get_real_time (const snd_seq_queue_status_t *info)
 Get the real time of a queue_status container. More...

unsigned int snd_seq_queue_status_get_status (const snd_seq_queue_status_t *info)
 Get the running status bits of a queue_status container. More...

int snd_seq_get_queue_status (snd_seq_t *handle, int q, snd_seq_queue_status_t *status)
 obtain the running state of the queue. More...

size_t snd_seq_queue_tempo_sizeof (void)
 get size of snd_seq_queue_tempo_t. More...

int snd_seq_queue_tempo_malloc (snd_seq_queue_tempo_t **ptr)
 allocate an empty snd_seq_queue_tempo_t using standard malloc. More...

void snd_seq_queue_tempo_free (snd_seq_queue_tempo_t *ptr)
 frees a previously allocated snd_seq_queue_tempo_t. More...

void snd_seq_queue_tempo_copy (snd_seq_queue_tempo_t *dst, const snd_seq_queue_tempo_t *src)
 copy one snd_seq_queue_tempo_t to another. More...

int snd_seq_queue_tempo_get_queue (const snd_seq_queue_tempo_t *info)
 Get the queue id of a queue_status container. More...

unsigned int snd_seq_queue_tempo_get_tempo (const snd_seq_queue_tempo_t *info)
 Get the tempo of a queue_status container. More...

int snd_seq_queue_tempo_get_ppq (const snd_seq_queue_tempo_t *info)
 Get the ppq of a queue_status container. More...

unsigned int snd_seq_queue_tempo_get_skew (const snd_seq_queue_tempo_t *info)
 Get the timer skew value of a queue_status container. More...

unsigned int snd_seq_queue_tempo_get_skew_base (const snd_seq_queue_tempo_t *info)
 Get the timer skew base value of a queue_status container. More...

void snd_seq_queue_tempo_set_tempo (snd_seq_queue_tempo_t *info, unsigned int tempo)
 Set the tempo of a queue_status container. More...

void snd_seq_queue_tempo_set_ppq (snd_seq_queue_tempo_t *info, int ppq)
 Set the ppq of a queue_status container. More...

void snd_seq_queue_tempo_set_skew (snd_seq_queue_tempo_t *info, unsigned int skew)
 Set the timer skew value of a queue_status container. More...

void snd_seq_queue_tempo_set_skew_base (snd_seq_queue_tempo_t *info, unsigned int base)
 Set the timer skew base value of a queue_status container. More...

int snd_seq_get_queue_tempo (snd_seq_t *handle, int q, snd_seq_queue_tempo_t *tempo)
 obtain the current tempo of the queue. More...

int snd_seq_set_queue_tempo (snd_seq_t *handle, int q, snd_seq_queue_tempo_t *tempo)
 set the tempo of the queue. More...

size_t snd_seq_queue_timer_sizeof (void)
 get size of snd_seq_queue_timer_t. More...

int snd_seq_queue_timer_malloc (snd_seq_queue_timer_t **ptr)
 allocate an empty snd_seq_queue_timer_t using standard malloc. More...

void snd_seq_queue_timer_free (snd_seq_queue_timer_t *ptr)
 frees a previously allocated snd_seq_queue_timer_t. More...

void snd_seq_queue_timer_copy (snd_seq_queue_timer_t *dst, const snd_seq_queue_timer_t *src)
 copy one snd_seq_queue_timer_t to another. More...

int snd_seq_queue_timer_get_queue (const snd_seq_queue_timer_t *info)
 Get the queue id of a queue_timer container. More...

snd_seq_queue_timer_type_t snd_seq_queue_timer_get_type (const snd_seq_queue_timer_t *info)
 Get the timer type of a queue_timer container. More...

const snd_timer_id_tsnd_seq_queue_timer_get_id (const snd_seq_queue_timer_t *info)
 Get the timer id of a queue_timer container. More...

unsigned int snd_seq_queue_timer_get_resolution (const snd_seq_queue_timer_t *info)
 Get the timer resolution of a queue_timer container. More...

void snd_seq_queue_timer_set_type (snd_seq_queue_timer_t *info, snd_seq_queue_timer_type_t type)
 Set the timer type of a queue_timer container. More...

void snd_seq_queue_timer_set_id (snd_seq_queue_timer_t *info, const snd_timer_id_t *id)
 Set the timer id of a queue_timer container. More...

void snd_seq_queue_timer_set_resolution (snd_seq_queue_timer_t *info, unsigned int resolution)
 Set the timer resolution of a queue_timer container. More...

int snd_seq_get_queue_timer (snd_seq_t *handle, int q, snd_seq_queue_timer_t *timer)
 obtain the queue timer information. More...

int snd_seq_set_queue_timer (snd_seq_t *handle, int q, snd_seq_queue_timer_t *timer)
 set the queue timer information. More...


Detailed Description

Sequencer Queue Interface

Define Documentation

#define SND_SEQ_QUEUE_DIRECT   253 /**< direct dispatch */
 

special queue ids

#define snd_seq_queue_info_alloca ptr       SND_ALLOCA(snd_seq_queue_info, ptr)
 

allocate a snd_seq_queue_info_t container on stack

#define snd_seq_queue_status_alloca ptr       SND_ALLOCA(snd_seq_queue_status, ptr)
 

allocate a snd_seq_queue_status_t container on stack

#define snd_seq_queue_tempo_alloca ptr       SND_ALLOCA(snd_seq_queue_tempo, ptr)
 

allocate a snd_seq_queue_tempo_t container on stack

#define snd_seq_queue_timer_alloca ptr       SND_ALLOCA(snd_seq_queue_timer, ptr)
 

allocate a snd_seq_queue_timer_t container on stack


Typedef Documentation

typedef struct _snd_seq_queue_info snd_seq_queue_info_t
 

queue information container

typedef struct _snd_seq_queue_status snd_seq_queue_status_t
 

queue status container

typedef struct _snd_seq_queue_tempo snd_seq_queue_tempo_t
 

queue tempo container

typedef struct _snd_seq_queue_timer snd_seq_queue_timer_t
 

queue timer information container


Enumeration Type Documentation

enum snd_seq_queue_timer_type_t
 

sequencer timer sources


Function Documentation

int snd_seq_alloc_named_queue snd_seq_t   seq,
const char *    name
 

allocate a queue with the specified name.

Parameters:
seq  sequencer handle
name  the name of the new queue
Returns:
the queue id (zero or positive) on success otherwise a negative error code

int snd_seq_alloc_queue snd_seq_t   seq
 

allocate a queue.

Parameters:
seq  sequencer handle
Returns:
the queue id (zero or positive) on success otherwise a negative error code

int snd_seq_create_queue snd_seq_t   seq,
snd_seq_queue_info_t   info
 

create a queue.

Parameters:
seq  sequencer handle
info  queue information to initialize
Returns:
the queue id (zero or positive) on success otherwise a negative error code

int snd_seq_free_queue snd_seq_t   seq,
int    q
 

delete the specified queue.

Parameters:
seq  sequencer handle
q  queue id to delete
Returns:
0 on success otherwise a negative error code

int snd_seq_get_queue_info snd_seq_t   seq,
int    q,
snd_seq_queue_info_t   info
 

obtain queue attributes.

Parameters:
seq  sequencer handle
q  queue id to query
info  information returned
Returns:
0 on success otherwise a negative error code

int snd_seq_get_queue_status snd_seq_t   seq,
int    q,
snd_seq_queue_status_t   status
 

obtain the running state of the queue.

Parameters:
seq  sequencer handle
q  queue id to query
status  pointer to store the current status
Returns:
0 on success otherwise a negative error code
Obtains the running state of the specified queue q.

int snd_seq_get_queue_tempo snd_seq_t   seq,
int    q,
snd_seq_queue_tempo_t   tempo
 

obtain the current tempo of the queue.

Parameters:
seq  sequencer handle
q  queue id to be queried
tempo  pointer to store the current tempo
Returns:
0 on success otherwise a negative error code

int snd_seq_get_queue_timer snd_seq_t   seq,
int    q,
snd_seq_queue_timer_t   timer
 

obtain the queue timer information.

Parameters:
seq  sequencer handle
q  queue id to query
timer  pointer to store the timer information
Returns:
0 on success otherwise a negative error code

int snd_seq_get_queue_usage snd_seq_t   seq,
int    q
 

Get the queue usage flag to the client.

Parameters:
seq  sequencer handle
q  queue id
client  client id
Returns:
1 = client is allowed to access the queue, 0 = not allowed, otherwise a negative error code

int snd_seq_query_named_queue snd_seq_t   seq,
const char *    name
 

query the matching queue with the specified name.

Parameters:
seq  sequencer handle
name  the name string to query
Returns:
the queue id if found or negative error code
Searches the matching queue with the specified name string.

void snd_seq_queue_info_copy snd_seq_queue_info_t   dst,
const snd_seq_queue_info_t   src
 

copy one snd_seq_queue_info_t to another.

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_queue_info_free snd_seq_queue_info_t   obj
 

frees a previously allocated snd_seq_queue_info_t.

Parameters:
pointer  to object to free

unsigned int snd_seq_queue_info_get_flags const snd_seq_queue_info_t   info
 

Get the conditional bit flags of a queue_info container.

Parameters:
info  queue_info container
Returns:
conditional bit flags

int snd_seq_queue_info_get_locked const snd_seq_queue_info_t   info
 

Get the lock status of a queue_info container.

Parameters:
info  queue_info container
Returns:
lock status --- non-zero = locked

const char* snd_seq_queue_info_get_name const snd_seq_queue_info_t   info
 

Get the name of a queue_info container.

Parameters:
info  queue_info container
Returns:
name string

int snd_seq_queue_info_get_owner const snd_seq_queue_info_t   info
 

Get the owner client id of a queue_info container.

Parameters:
info  queue_info container
Returns:
owner client id

int snd_seq_queue_info_get_queue const snd_seq_queue_info_t   info
 

Get the queue id of a queue_info container.

Parameters:
info  queue_info container
Returns:
queue id

int snd_seq_queue_info_malloc snd_seq_queue_info_t **    ptr
 

allocate an empty snd_seq_queue_info_t using standard malloc.

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_queue_info_set_flags snd_seq_queue_info_t   info,
unsigned int    flags
 

Set the conditional bit flags of a queue_info container.

Parameters:
info  queue_info container
flags  conditional bit flags

void snd_seq_queue_info_set_locked snd_seq_queue_info_t   info,
int    locked
 

Set the lock status of a queue_info container.

Parameters:
info  queue_info container
locked  lock status

void snd_seq_queue_info_set_name snd_seq_queue_info_t   info,
const char *    name
 

Set the name of a queue_info container.

Parameters:
info  queue_info container
name  name string

void snd_seq_queue_info_set_owner snd_seq_queue_info_t   info,
int    owner
 

Set the owner client id of a queue_info container.

Parameters:
info  queue_info container
owner  client id

size_t snd_seq_queue_info_sizeof void   
 

get size of snd_seq_queue_info_t.

Returns:
size in bytes

void snd_seq_queue_status_copy snd_seq_queue_status_t   dst,
const snd_seq_queue_status_t   src
 

copy one snd_seq_queue_status_t to another.

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_queue_status_free snd_seq_queue_status_t   obj
 

frees a previously allocated snd_seq_queue_status_t.

Parameters:
pointer  to object to free

int snd_seq_queue_status_get_events const snd_seq_queue_status_t   info
 

Get the number of events of a queue_status container.

Parameters:
info  queue_status container
Returns:
number of events

int snd_seq_queue_status_get_queue const snd_seq_queue_status_t   info
 

Get the queue id of a queue_status container.

Parameters:
info  queue_status container
Returns:
queue id

const snd_seq_real_time_t* snd_seq_queue_status_get_real_time const snd_seq_queue_status_t   info
 

Get the real time of a queue_status container.

Parameters:
info  queue_status container
time  real time

unsigned int snd_seq_queue_status_get_status const snd_seq_queue_status_t   info
 

Get the running status bits of a queue_status container.

Parameters:
info  queue_status container
Returns:
running status bits

snd_seq_tick_time_t snd_seq_queue_status_get_tick_time const snd_seq_queue_status_t   info
 

Get the tick time of a queue_status container.

Parameters:
info  queue_status container
Returns:
tick time

int snd_seq_queue_status_malloc snd_seq_queue_status_t **    ptr
 

allocate an empty snd_seq_queue_status_t using standard malloc.

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

size_t snd_seq_queue_status_sizeof void   
 

get size of snd_seq_queue_status_t.

Returns:
size in bytes

void snd_seq_queue_tempo_copy snd_seq_queue_tempo_t   dst,
const snd_seq_queue_tempo_t   src
 

copy one snd_seq_queue_tempo_t to another.

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_queue_tempo_free snd_seq_queue_tempo_t   obj
 

frees a previously allocated snd_seq_queue_tempo_t.

Parameters:
pointer  to object to free

int snd_seq_queue_tempo_get_ppq const snd_seq_queue_tempo_t   info
 

Get the ppq of a queue_status container.

Parameters:
info  queue_status container
Returns:
ppq value

int snd_seq_queue_tempo_get_queue const snd_seq_queue_tempo_t   info
 

Get the queue id of a queue_status container.

Parameters:
info  queue_status container
Returns:
queue id

unsigned int snd_seq_queue_tempo_get_skew const snd_seq_queue_tempo_t   info
 

Get the timer skew value of a queue_status container.

Parameters:
info  queue_status container
Returns:
timer skew value

unsigned int snd_seq_queue_tempo_get_skew_base const snd_seq_queue_tempo_t   info
 

Get the timer skew base value of a queue_status container.

Parameters:
info  queue_status container
Returns:
timer skew base value

unsigned int snd_seq_queue_tempo_get_tempo const snd_seq_queue_tempo_t   info
 

Get the tempo of a queue_status container.

Parameters:
info  queue_status container
Returns:
tempo value

int snd_seq_queue_tempo_malloc snd_seq_queue_tempo_t **    ptr
 

allocate an empty snd_seq_queue_tempo_t using standard malloc.

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_queue_tempo_set_ppq snd_seq_queue_tempo_t   info,
int    ppq
 

Set the ppq of a queue_status container.

Parameters:
info  queue_status container
ppq  ppq value

void snd_seq_queue_tempo_set_skew snd_seq_queue_tempo_t   info,
unsigned int    skew
 

Set the timer skew value of a queue_status container.

Parameters:
info  queue_status container
skew  timer skew value
The skew of timer is calculated as skew / base. For example, to play with double speed, pass base * 2 as the skew value.

void snd_seq_queue_tempo_set_skew_base snd_seq_queue_tempo_t   info,
unsigned int    base
 

Set the timer skew base value of a queue_status container.

Parameters:
info  queue_status container
base  timer skew base value

void snd_seq_queue_tempo_set_tempo snd_seq_queue_tempo_t   info,
unsigned int    tempo
 

Set the tempo of a queue_status container.

Parameters:
info  queue_status container
tempo  tempo value

size_t snd_seq_queue_tempo_sizeof void   
 

get size of snd_seq_queue_tempo_t.

Returns:
size in bytes

void snd_seq_queue_timer_copy snd_seq_queue_timer_t   dst,
const snd_seq_queue_timer_t   src
 

copy one snd_seq_queue_timer_t to another.

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_queue_timer_free snd_seq_queue_timer_t   obj
 

frees a previously allocated snd_seq_queue_timer_t.

Parameters:
pointer  to object to free

const snd_timer_id_t* snd_seq_queue_timer_get_id const snd_seq_queue_timer_t   info
 

Get the timer id of a queue_timer container.

Parameters:
info  queue_timer container
Returns:
timer id pointer

int snd_seq_queue_timer_get_queue const snd_seq_queue_timer_t   info
 

Get the queue id of a queue_timer container.

Parameters:
info  queue_timer container
Returns:
queue id

unsigned int snd_seq_queue_timer_get_resolution const snd_seq_queue_timer_t   info
 

Get the timer resolution of a queue_timer container.

Parameters:
info  queue_timer container
Returns:
timer resolution

snd_seq_queue_timer_type_t snd_seq_queue_timer_get_type const snd_seq_queue_timer_t   info
 

Get the timer type of a queue_timer container.

Parameters:
info  queue_timer container
Returns:
timer type

int snd_seq_queue_timer_malloc snd_seq_queue_timer_t **    ptr
 

allocate an empty snd_seq_queue_timer_t using standard malloc.

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_queue_timer_set_id snd_seq_queue_timer_t   info,
const snd_timer_id_t   id
 

Set the timer id of a queue_timer container.

Parameters:
info  queue_timer container
id  timer id pointer

void snd_seq_queue_timer_set_resolution snd_seq_queue_timer_t   info,
unsigned int    resolution
 

Set the timer resolution of a queue_timer container.

Parameters:
info  queue_timer container
resolution  timer resolution

void snd_seq_queue_timer_set_type snd_seq_queue_timer_t   info,
snd_seq_queue_timer_type_t    type
 

Set the timer type of a queue_timer container.

Parameters:
info  queue_timer container
type  timer type

size_t snd_seq_queue_timer_sizeof void   
 

get size of snd_seq_queue_timer_t.

Returns:
size in bytes

int snd_seq_set_queue_info snd_seq_t   seq,
int    q,
snd_seq_queue_info_t   info
 

change the queue attributes.

Parameters:
seq  sequencer handle
q  queue id to change
info  information changed
Returns:
0 on success otherwise a negative error code

int snd_seq_set_queue_tempo snd_seq_t   seq,
int    q,
snd_seq_queue_tempo_t   tempo
 

set the tempo of the queue.

Parameters:
seq  sequencer handle
q  queue id to change the tempo
tempo  tempo information
Returns:
0 on success otherwise a negative error code

int snd_seq_set_queue_timer snd_seq_t   seq,
int    q,
snd_seq_queue_timer_t   timer
 

set the queue timer information.

Parameters:
seq  sequencer handle
q  queue id to change the timer
timer  timer information
Returns:
0 on success otherwise a negative error code

int snd_seq_set_queue_usage snd_seq_t   seq,
int    q,
int    used
 

Set the queue usage flag to the client.

Parameters:
seq  sequencer handle
q  queue id
client  client id
used  non-zero if the client is allowed
Returns:
0 on success otherwise a negative error code


Generated on Thu Feb 27 11:30:38 2003 for ALSA project - the C library reference by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002