2 * ALSA sequencer Timing queue handling
3 * Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Nov. 13, 1999 Takashi Iwai <iwai@ww.uni-erlangen.de>
21 * - Queues are allocated dynamically via ioctl.
22 * - When owner client is deleted, all owned queues are deleted, too.
23 * - Owner of unlocked queue is kept unmodified even if it is
24 * manipulated by other clients.
25 * - Owner field in SET_QUEUE_OWNER ioctl must be identical with the
26 * caller client. i.e. Changing owner to a third client is not
29 * Aug. 30, 2000 Takashi Iwai
30 * - Queues are managed in static array again, but with better way.
31 * The API itself is identical.
32 * - The queue is locked when struct snd_seq_queue pointer is returned via
33 * queueptr(). This pointer *MUST* be released afterward by
35 * - Addition of experimental sync support.
38 #include <linux/init.h>
39 #include <linux/slab.h>
40 #include <sound/core.h>
42 #include "seq_memory.h"
43 #include "seq_queue.h"
44 #include "seq_clientmgr.h"
46 #include "seq_timer.h"
49 /* list of allocated queues */
50 static struct snd_seq_queue *queue_list[SNDRV_SEQ_MAX_QUEUES];
51 static DEFINE_SPINLOCK(queue_list_lock);
52 /* number of queues allocated */
53 static int num_queues;
55 int snd_seq_queue_get_cur_queues(void)
60 /*----------------------------------------------------------------*/
62 /* assign queue id and insert to list */
63 static int queue_list_add(struct snd_seq_queue *q)
68 spin_lock_irqsave(&queue_list_lock, flags);
69 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
70 if (! queue_list[i]) {
74 spin_unlock_irqrestore(&queue_list_lock, flags);
78 spin_unlock_irqrestore(&queue_list_lock, flags);
82 static struct snd_seq_queue *queue_list_remove(int id, int client)
84 struct snd_seq_queue *q;
87 spin_lock_irqsave(&queue_list_lock, flags);
90 spin_lock(&q->owner_lock);
91 if (q->owner == client) {
94 spin_unlock(&q->owner_lock);
95 queue_list[id] = NULL;
97 spin_unlock_irqrestore(&queue_list_lock, flags);
100 spin_unlock(&q->owner_lock);
102 spin_unlock_irqrestore(&queue_list_lock, flags);
106 /*----------------------------------------------------------------*/
108 /* create new queue (constructor) */
109 static struct snd_seq_queue *queue_new(int owner, int locked)
111 struct snd_seq_queue *q;
113 q = kzalloc(sizeof(*q), GFP_KERNEL);
115 snd_printd("malloc failed for snd_seq_queue_new()\n");
119 spin_lock_init(&q->owner_lock);
120 spin_lock_init(&q->check_lock);
121 mutex_init(&q->timer_mutex);
122 snd_use_lock_init(&q->use_lock);
125 q->tickq = snd_seq_prioq_new();
126 q->timeq = snd_seq_prioq_new();
127 q->timer = snd_seq_timer_new();
128 if (q->tickq == NULL || q->timeq == NULL || q->timer == NULL) {
129 snd_seq_prioq_delete(&q->tickq);
130 snd_seq_prioq_delete(&q->timeq);
131 snd_seq_timer_delete(&q->timer);
143 /* delete queue (destructor) */
144 static void queue_delete(struct snd_seq_queue *q)
146 /* stop and release the timer */
147 mutex_lock(&q->timer_mutex);
148 snd_seq_timer_stop(q->timer);
149 snd_seq_timer_close(q);
150 mutex_unlock(&q->timer_mutex);
151 /* wait until access free */
152 snd_use_lock_sync(&q->use_lock);
153 /* release resources... */
154 snd_seq_prioq_delete(&q->tickq);
155 snd_seq_prioq_delete(&q->timeq);
156 snd_seq_timer_delete(&q->timer);
162 /*----------------------------------------------------------------*/
165 int __init snd_seq_queues_init(void)
168 memset(queue_list, 0, sizeof(queue_list));
174 /* delete all existing queues */
175 void __exit snd_seq_queues_delete(void)
180 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
182 queue_delete(queue_list[i]);
186 static void queue_use(struct snd_seq_queue *queue, int client, int use);
188 /* allocate a new queue -
189 * return queue index value or negative value for error
191 int snd_seq_queue_alloc(int client, int locked, unsigned int info_flags)
193 struct snd_seq_queue *q;
195 q = queue_new(client, locked);
198 q->info_flags = info_flags;
199 queue_use(q, client, 1);
200 if (queue_list_add(q) < 0) {
207 /* delete a queue - queue must be owned by the client */
208 int snd_seq_queue_delete(int client, int queueid)
210 struct snd_seq_queue *q;
212 if (queueid < 0 || queueid >= SNDRV_SEQ_MAX_QUEUES)
214 q = queue_list_remove(queueid, client);
223 /* return pointer to queue structure for specified id */
224 struct snd_seq_queue *queueptr(int queueid)
226 struct snd_seq_queue *q;
229 if (queueid < 0 || queueid >= SNDRV_SEQ_MAX_QUEUES)
231 spin_lock_irqsave(&queue_list_lock, flags);
232 q = queue_list[queueid];
234 snd_use_lock_use(&q->use_lock);
235 spin_unlock_irqrestore(&queue_list_lock, flags);
239 /* return the (first) queue matching with the specified name */
240 struct snd_seq_queue *snd_seq_queue_find_name(char *name)
243 struct snd_seq_queue *q;
245 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
246 if ((q = queueptr(i)) != NULL) {
247 if (strncmp(q->name, name, sizeof(q->name)) == 0)
256 /* -------------------------------------------------------- */
258 void snd_seq_check_queue(struct snd_seq_queue *q, int atomic, int hop)
261 struct snd_seq_event_cell *cell;
266 /* make this function non-reentrant */
267 spin_lock_irqsave(&q->check_lock, flags);
268 if (q->check_blocked) {
270 spin_unlock_irqrestore(&q->check_lock, flags);
271 return; /* other thread is already checking queues */
273 q->check_blocked = 1;
274 spin_unlock_irqrestore(&q->check_lock, flags);
277 /* Process tick queue... */
278 while ((cell = snd_seq_prioq_cell_peek(q->tickq)) != NULL) {
279 if (snd_seq_compare_tick_time(&q->timer->tick.cur_tick,
280 &cell->event.time.tick)) {
281 cell = snd_seq_prioq_cell_out(q->tickq);
283 snd_seq_dispatch_event(cell, atomic, hop);
285 /* event remains in the queue */
291 /* Process time queue... */
292 while ((cell = snd_seq_prioq_cell_peek(q->timeq)) != NULL) {
293 if (snd_seq_compare_real_time(&q->timer->cur_time,
294 &cell->event.time.time)) {
295 cell = snd_seq_prioq_cell_out(q->timeq);
297 snd_seq_dispatch_event(cell, atomic, hop);
299 /* event remains in the queue */
305 spin_lock_irqsave(&q->check_lock, flags);
306 if (q->check_again) {
308 spin_unlock_irqrestore(&q->check_lock, flags);
311 q->check_blocked = 0;
312 spin_unlock_irqrestore(&q->check_lock, flags);
316 /* enqueue a event to singe queue */
317 int snd_seq_enqueue_event(struct snd_seq_event_cell *cell, int atomic, int hop)
320 struct snd_seq_queue *q;
322 if (snd_BUG_ON(!cell))
324 dest = cell->event.queue; /* destination queue */
328 /* handle relative time stamps, convert them into absolute */
329 if ((cell->event.flags & SNDRV_SEQ_TIME_MODE_MASK) == SNDRV_SEQ_TIME_MODE_REL) {
330 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
331 case SNDRV_SEQ_TIME_STAMP_TICK:
332 cell->event.time.tick += q->timer->tick.cur_tick;
335 case SNDRV_SEQ_TIME_STAMP_REAL:
336 snd_seq_inc_real_time(&cell->event.time.time,
337 &q->timer->cur_time);
340 cell->event.flags &= ~SNDRV_SEQ_TIME_MODE_MASK;
341 cell->event.flags |= SNDRV_SEQ_TIME_MODE_ABS;
343 /* enqueue event in the real-time or midi queue */
344 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
345 case SNDRV_SEQ_TIME_STAMP_TICK:
346 err = snd_seq_prioq_cell_in(q->tickq, cell);
349 case SNDRV_SEQ_TIME_STAMP_REAL:
351 err = snd_seq_prioq_cell_in(q->timeq, cell);
356 queuefree(q); /* unlock */
360 /* trigger dispatching */
361 snd_seq_check_queue(q, atomic, hop);
363 queuefree(q); /* unlock */
369 /*----------------------------------------------------------------*/
371 static inline int check_access(struct snd_seq_queue *q, int client)
373 return (q->owner == client) || (!q->locked && !q->klocked);
376 /* check if the client has permission to modify queue parameters.
377 * if it does, lock the queue
379 static int queue_access_lock(struct snd_seq_queue *q, int client)
384 spin_lock_irqsave(&q->owner_lock, flags);
385 access_ok = check_access(q, client);
388 spin_unlock_irqrestore(&q->owner_lock, flags);
392 /* unlock the queue */
393 static inline void queue_access_unlock(struct snd_seq_queue *q)
397 spin_lock_irqsave(&q->owner_lock, flags);
399 spin_unlock_irqrestore(&q->owner_lock, flags);
402 /* exported - only checking permission */
403 int snd_seq_queue_check_access(int queueid, int client)
405 struct snd_seq_queue *q = queueptr(queueid);
411 spin_lock_irqsave(&q->owner_lock, flags);
412 access_ok = check_access(q, client);
413 spin_unlock_irqrestore(&q->owner_lock, flags);
418 /*----------------------------------------------------------------*/
421 * change queue's owner and permission
423 int snd_seq_queue_set_owner(int queueid, int client, int locked)
425 struct snd_seq_queue *q = queueptr(queueid);
430 if (! queue_access_lock(q, client)) {
435 q->locked = locked ? 1 : 0;
437 queue_access_unlock(q);
444 /*----------------------------------------------------------------*/
447 * q->use mutex should be down before calling this function to avoid
448 * confliction with snd_seq_queue_use()
450 int snd_seq_queue_timer_open(int queueid)
453 struct snd_seq_queue *queue;
454 struct snd_seq_timer *tmr;
456 queue = queueptr(queueid);
460 if ((result = snd_seq_timer_open(queue)) < 0) {
461 snd_seq_timer_defaults(tmr);
462 result = snd_seq_timer_open(queue);
469 * q->use mutex should be down before calling this function
471 int snd_seq_queue_timer_close(int queueid)
473 struct snd_seq_queue *queue;
476 queue = queueptr(queueid);
479 snd_seq_timer_close(queue);
484 /* change queue tempo and ppq */
485 int snd_seq_queue_timer_set_tempo(int queueid, int client,
486 struct snd_seq_queue_tempo *info)
488 struct snd_seq_queue *q = queueptr(queueid);
493 if (! queue_access_lock(q, client)) {
498 result = snd_seq_timer_set_tempo(q->timer, info->tempo);
500 result = snd_seq_timer_set_ppq(q->timer, info->ppq);
501 if (result >= 0 && info->skew_base > 0)
502 result = snd_seq_timer_set_skew(q->timer, info->skew_value,
504 queue_access_unlock(q);
509 /* use or unuse this queue */
510 static void queue_use(struct snd_seq_queue *queue, int client, int use)
513 if (!test_and_set_bit(client, queue->clients_bitmap))
516 if (test_and_clear_bit(client, queue->clients_bitmap))
519 if (queue->clients) {
520 if (use && queue->clients == 1)
521 snd_seq_timer_defaults(queue->timer);
522 snd_seq_timer_open(queue);
524 snd_seq_timer_close(queue);
528 /* use or unuse this queue -
529 * if it is the first client, starts the timer.
530 * if it is not longer used by any clients, stop the timer.
532 int snd_seq_queue_use(int queueid, int client, int use)
534 struct snd_seq_queue *queue;
536 queue = queueptr(queueid);
539 mutex_lock(&queue->timer_mutex);
540 queue_use(queue, client, use);
541 mutex_unlock(&queue->timer_mutex);
547 * check if queue is used by the client
548 * return negative value if the queue is invalid.
549 * return 0 if not used, 1 if used.
551 int snd_seq_queue_is_used(int queueid, int client)
553 struct snd_seq_queue *q;
556 q = queueptr(queueid);
558 return -EINVAL; /* invalid queue */
559 result = test_bit(client, q->clients_bitmap) ? 1 : 0;
565 /*----------------------------------------------------------------*/
567 /* notification that client has left the system -
568 * stop the timer on all queues owned by this client
570 void snd_seq_queue_client_termination(int client)
574 struct snd_seq_queue *q;
576 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
577 if ((q = queueptr(i)) == NULL)
579 spin_lock_irqsave(&q->owner_lock, flags);
580 if (q->owner == client)
582 spin_unlock_irqrestore(&q->owner_lock, flags);
583 if (q->owner == client) {
584 if (q->timer->running)
585 snd_seq_timer_stop(q->timer);
586 snd_seq_timer_reset(q->timer);
592 /* final stage notification -
593 * remove cells for no longer exist client (for non-owned queue)
594 * or delete this queue (for owned queue)
596 void snd_seq_queue_client_leave(int client)
599 struct snd_seq_queue *q;
601 /* delete own queues from queue list */
602 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
603 if ((q = queue_list_remove(i, client)) != NULL)
607 /* remove cells from existing queues -
608 * they are not owned by this client
610 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
611 if ((q = queueptr(i)) == NULL)
613 if (test_bit(client, q->clients_bitmap)) {
614 snd_seq_prioq_leave(q->tickq, client, 0);
615 snd_seq_prioq_leave(q->timeq, client, 0);
616 snd_seq_queue_use(q->queue, client, 0);
624 /*----------------------------------------------------------------*/
626 /* remove cells from all queues */
627 void snd_seq_queue_client_leave_cells(int client)
630 struct snd_seq_queue *q;
632 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
633 if ((q = queueptr(i)) == NULL)
635 snd_seq_prioq_leave(q->tickq, client, 0);
636 snd_seq_prioq_leave(q->timeq, client, 0);
641 /* remove cells based on flush criteria */
642 void snd_seq_queue_remove_cells(int client, struct snd_seq_remove_events *info)
645 struct snd_seq_queue *q;
647 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
648 if ((q = queueptr(i)) == NULL)
650 if (test_bit(client, q->clients_bitmap) &&
651 (! (info->remove_mode & SNDRV_SEQ_REMOVE_DEST) ||
652 q->queue == info->queue)) {
653 snd_seq_prioq_remove_events(q->tickq, client, info);
654 snd_seq_prioq_remove_events(q->timeq, client, info);
660 /*----------------------------------------------------------------*/
663 * send events to all subscribed ports
665 static void queue_broadcast_event(struct snd_seq_queue *q, struct snd_seq_event *ev,
668 struct snd_seq_event sev;
672 sev.flags = SNDRV_SEQ_TIME_STAMP_TICK|SNDRV_SEQ_TIME_MODE_ABS;
673 sev.time.tick = q->timer->tick.cur_tick;
674 sev.queue = q->queue;
675 sev.data.queue.queue = q->queue;
677 /* broadcast events from Timer port */
678 sev.source.client = SNDRV_SEQ_CLIENT_SYSTEM;
679 sev.source.port = SNDRV_SEQ_PORT_SYSTEM_TIMER;
680 sev.dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
681 snd_seq_kernel_client_dispatch(SNDRV_SEQ_CLIENT_SYSTEM, &sev, atomic, hop);
685 * process a received queue-control event.
686 * this function is exported for seq_sync.c.
688 static void snd_seq_queue_process_event(struct snd_seq_queue *q,
689 struct snd_seq_event *ev,
693 case SNDRV_SEQ_EVENT_START:
694 snd_seq_prioq_leave(q->tickq, ev->source.client, 1);
695 snd_seq_prioq_leave(q->timeq, ev->source.client, 1);
696 if (! snd_seq_timer_start(q->timer))
697 queue_broadcast_event(q, ev, atomic, hop);
700 case SNDRV_SEQ_EVENT_CONTINUE:
701 if (! snd_seq_timer_continue(q->timer))
702 queue_broadcast_event(q, ev, atomic, hop);
705 case SNDRV_SEQ_EVENT_STOP:
706 snd_seq_timer_stop(q->timer);
707 queue_broadcast_event(q, ev, atomic, hop);
710 case SNDRV_SEQ_EVENT_TEMPO:
711 snd_seq_timer_set_tempo(q->timer, ev->data.queue.param.value);
712 queue_broadcast_event(q, ev, atomic, hop);
715 case SNDRV_SEQ_EVENT_SETPOS_TICK:
716 if (snd_seq_timer_set_position_tick(q->timer, ev->data.queue.param.time.tick) == 0) {
717 queue_broadcast_event(q, ev, atomic, hop);
721 case SNDRV_SEQ_EVENT_SETPOS_TIME:
722 if (snd_seq_timer_set_position_time(q->timer, ev->data.queue.param.time.time) == 0) {
723 queue_broadcast_event(q, ev, atomic, hop);
726 case SNDRV_SEQ_EVENT_QUEUE_SKEW:
727 if (snd_seq_timer_set_skew(q->timer,
728 ev->data.queue.param.skew.value,
729 ev->data.queue.param.skew.base) == 0) {
730 queue_broadcast_event(q, ev, atomic, hop);
738 * Queue control via timer control port:
739 * this function is exported as a callback of timer port.
741 int snd_seq_control_queue(struct snd_seq_event *ev, int atomic, int hop)
743 struct snd_seq_queue *q;
747 q = queueptr(ev->data.queue.queue);
752 if (! queue_access_lock(q, ev->source.client)) {
757 snd_seq_queue_process_event(q, ev, atomic, hop);
759 queue_access_unlock(q);
765 /*----------------------------------------------------------------*/
767 #ifdef CONFIG_PROC_FS
768 /* exported to seq_info.c */
769 void snd_seq_info_queues_read(struct snd_info_entry *entry,
770 struct snd_info_buffer *buffer)
773 struct snd_seq_queue *q;
774 struct snd_seq_timer *tmr;
776 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
777 if ((q = queueptr(i)) == NULL)
782 bpm = 60000000 / tmr->tempo;
786 snd_iprintf(buffer, "queue %d: [%s]\n", q->queue, q->name);
787 snd_iprintf(buffer, "owned by client : %d\n", q->owner);
788 snd_iprintf(buffer, "lock status : %s\n", q->locked ? "Locked" : "Free");
789 snd_iprintf(buffer, "queued time events : %d\n", snd_seq_prioq_avail(q->timeq));
790 snd_iprintf(buffer, "queued tick events : %d\n", snd_seq_prioq_avail(q->tickq));
791 snd_iprintf(buffer, "timer state : %s\n", tmr->running ? "Running" : "Stopped");
792 snd_iprintf(buffer, "timer PPQ : %d\n", tmr->ppq);
793 snd_iprintf(buffer, "current tempo : %d\n", tmr->tempo);
794 snd_iprintf(buffer, "current BPM : %d\n", bpm);
795 snd_iprintf(buffer, "current time : %d.%09d s\n", tmr->cur_time.tv_sec, tmr->cur_time.tv_nsec);
796 snd_iprintf(buffer, "current tick : %d\n", tmr->tick.cur_tick);
797 snd_iprintf(buffer, "\n");
801 #endif /* CONFIG_PROC_FS */