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 snd_seq_timer_stop(q->timer);
148 snd_seq_timer_close(q);
149 /* wait until access free */
150 snd_use_lock_sync(&q->use_lock);
151 /* release resources... */
152 snd_seq_prioq_delete(&q->tickq);
153 snd_seq_prioq_delete(&q->timeq);
154 snd_seq_timer_delete(&q->timer);
160 /*----------------------------------------------------------------*/
163 int __init snd_seq_queues_init(void)
166 memset(queue_list, 0, sizeof(queue_list));
172 /* delete all existing queues */
173 void __exit snd_seq_queues_delete(void)
178 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
180 queue_delete(queue_list[i]);
184 /* allocate a new queue -
185 * return queue index value or negative value for error
187 int snd_seq_queue_alloc(int client, int locked, unsigned int info_flags)
189 struct snd_seq_queue *q;
191 q = queue_new(client, locked);
194 q->info_flags = info_flags;
195 if (queue_list_add(q) < 0) {
199 snd_seq_queue_use(q->queue, client, 1); /* use this queue */
203 /* delete a queue - queue must be owned by the client */
204 int snd_seq_queue_delete(int client, int queueid)
206 struct snd_seq_queue *q;
208 if (queueid < 0 || queueid >= SNDRV_SEQ_MAX_QUEUES)
210 q = queue_list_remove(queueid, client);
219 /* return pointer to queue structure for specified id */
220 struct snd_seq_queue *queueptr(int queueid)
222 struct snd_seq_queue *q;
225 if (queueid < 0 || queueid >= SNDRV_SEQ_MAX_QUEUES)
227 spin_lock_irqsave(&queue_list_lock, flags);
228 q = queue_list[queueid];
230 snd_use_lock_use(&q->use_lock);
231 spin_unlock_irqrestore(&queue_list_lock, flags);
235 /* return the (first) queue matching with the specified name */
236 struct snd_seq_queue *snd_seq_queue_find_name(char *name)
239 struct snd_seq_queue *q;
241 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
242 if ((q = queueptr(i)) != NULL) {
243 if (strncmp(q->name, name, sizeof(q->name)) == 0)
252 /* -------------------------------------------------------- */
254 void snd_seq_check_queue(struct snd_seq_queue *q, int atomic, int hop)
257 struct snd_seq_event_cell *cell;
262 /* make this function non-reentrant */
263 spin_lock_irqsave(&q->check_lock, flags);
264 if (q->check_blocked) {
266 spin_unlock_irqrestore(&q->check_lock, flags);
267 return; /* other thread is already checking queues */
269 q->check_blocked = 1;
270 spin_unlock_irqrestore(&q->check_lock, flags);
273 /* Process tick queue... */
274 while ((cell = snd_seq_prioq_cell_peek(q->tickq)) != NULL) {
275 if (snd_seq_compare_tick_time(&q->timer->tick.cur_tick,
276 &cell->event.time.tick)) {
277 cell = snd_seq_prioq_cell_out(q->tickq);
279 snd_seq_dispatch_event(cell, atomic, hop);
281 /* event remains in the queue */
287 /* Process time queue... */
288 while ((cell = snd_seq_prioq_cell_peek(q->timeq)) != NULL) {
289 if (snd_seq_compare_real_time(&q->timer->cur_time,
290 &cell->event.time.time)) {
291 cell = snd_seq_prioq_cell_out(q->timeq);
293 snd_seq_dispatch_event(cell, atomic, hop);
295 /* event remains in the queue */
301 spin_lock_irqsave(&q->check_lock, flags);
302 if (q->check_again) {
304 spin_unlock_irqrestore(&q->check_lock, flags);
307 q->check_blocked = 0;
308 spin_unlock_irqrestore(&q->check_lock, flags);
312 /* enqueue a event to singe queue */
313 int snd_seq_enqueue_event(struct snd_seq_event_cell *cell, int atomic, int hop)
316 struct snd_seq_queue *q;
318 snd_assert(cell != NULL, return -EINVAL);
319 dest = cell->event.queue; /* destination queue */
323 /* handle relative time stamps, convert them into absolute */
324 if ((cell->event.flags & SNDRV_SEQ_TIME_MODE_MASK) == SNDRV_SEQ_TIME_MODE_REL) {
325 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
326 case SNDRV_SEQ_TIME_STAMP_TICK:
327 cell->event.time.tick += q->timer->tick.cur_tick;
330 case SNDRV_SEQ_TIME_STAMP_REAL:
331 snd_seq_inc_real_time(&cell->event.time.time,
332 &q->timer->cur_time);
335 cell->event.flags &= ~SNDRV_SEQ_TIME_MODE_MASK;
336 cell->event.flags |= SNDRV_SEQ_TIME_MODE_ABS;
338 /* enqueue event in the real-time or midi queue */
339 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
340 case SNDRV_SEQ_TIME_STAMP_TICK:
341 err = snd_seq_prioq_cell_in(q->tickq, cell);
344 case SNDRV_SEQ_TIME_STAMP_REAL:
346 err = snd_seq_prioq_cell_in(q->timeq, cell);
351 queuefree(q); /* unlock */
355 /* trigger dispatching */
356 snd_seq_check_queue(q, atomic, hop);
358 queuefree(q); /* unlock */
364 /*----------------------------------------------------------------*/
366 static inline int check_access(struct snd_seq_queue *q, int client)
368 return (q->owner == client) || (!q->locked && !q->klocked);
371 /* check if the client has permission to modify queue parameters.
372 * if it does, lock the queue
374 static int queue_access_lock(struct snd_seq_queue *q, int client)
379 spin_lock_irqsave(&q->owner_lock, flags);
380 access_ok = check_access(q, client);
383 spin_unlock_irqrestore(&q->owner_lock, flags);
387 /* unlock the queue */
388 static inline void queue_access_unlock(struct snd_seq_queue *q)
392 spin_lock_irqsave(&q->owner_lock, flags);
394 spin_unlock_irqrestore(&q->owner_lock, flags);
397 /* exported - only checking permission */
398 int snd_seq_queue_check_access(int queueid, int client)
400 struct snd_seq_queue *q = queueptr(queueid);
406 spin_lock_irqsave(&q->owner_lock, flags);
407 access_ok = check_access(q, client);
408 spin_unlock_irqrestore(&q->owner_lock, flags);
413 /*----------------------------------------------------------------*/
416 * change queue's owner and permission
418 int snd_seq_queue_set_owner(int queueid, int client, int locked)
420 struct snd_seq_queue *q = queueptr(queueid);
425 if (! queue_access_lock(q, client)) {
430 q->locked = locked ? 1 : 0;
432 queue_access_unlock(q);
439 /*----------------------------------------------------------------*/
442 * q->use mutex should be down before calling this function to avoid
443 * confliction with snd_seq_queue_use()
445 int snd_seq_queue_timer_open(int queueid)
448 struct snd_seq_queue *queue;
449 struct snd_seq_timer *tmr;
451 queue = queueptr(queueid);
455 if ((result = snd_seq_timer_open(queue)) < 0) {
456 snd_seq_timer_defaults(tmr);
457 result = snd_seq_timer_open(queue);
464 * q->use mutex should be down before calling this function
466 int snd_seq_queue_timer_close(int queueid)
468 struct snd_seq_queue *queue;
469 struct snd_seq_timer *tmr;
472 queue = queueptr(queueid);
476 snd_seq_timer_close(queue);
481 /* change queue tempo and ppq */
482 int snd_seq_queue_timer_set_tempo(int queueid, int client,
483 struct snd_seq_queue_tempo *info)
485 struct snd_seq_queue *q = queueptr(queueid);
490 if (! queue_access_lock(q, client)) {
495 result = snd_seq_timer_set_tempo(q->timer, info->tempo);
497 result = snd_seq_timer_set_ppq(q->timer, info->ppq);
498 if (result >= 0 && info->skew_base > 0)
499 result = snd_seq_timer_set_skew(q->timer, info->skew_value,
501 queue_access_unlock(q);
507 /* use or unuse this queue -
508 * if it is the first client, starts the timer.
509 * if it is not longer used by any clients, stop the timer.
511 int snd_seq_queue_use(int queueid, int client, int use)
513 struct snd_seq_queue *queue;
515 queue = queueptr(queueid);
518 mutex_lock(&queue->timer_mutex);
520 if (!test_and_set_bit(client, queue->clients_bitmap))
523 if (test_and_clear_bit(client, queue->clients_bitmap))
526 if (queue->clients) {
527 if (use && queue->clients == 1)
528 snd_seq_timer_defaults(queue->timer);
529 snd_seq_timer_open(queue);
531 snd_seq_timer_close(queue);
533 mutex_unlock(&queue->timer_mutex);
539 * check if queue is used by the client
540 * return negative value if the queue is invalid.
541 * return 0 if not used, 1 if used.
543 int snd_seq_queue_is_used(int queueid, int client)
545 struct snd_seq_queue *q;
548 q = queueptr(queueid);
550 return -EINVAL; /* invalid queue */
551 result = test_bit(client, q->clients_bitmap) ? 1 : 0;
557 /*----------------------------------------------------------------*/
559 /* notification that client has left the system -
560 * stop the timer on all queues owned by this client
562 void snd_seq_queue_client_termination(int client)
566 struct snd_seq_queue *q;
568 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
569 if ((q = queueptr(i)) == NULL)
571 spin_lock_irqsave(&q->owner_lock, flags);
572 if (q->owner == client)
574 spin_unlock_irqrestore(&q->owner_lock, flags);
575 if (q->owner == client) {
576 if (q->timer->running)
577 snd_seq_timer_stop(q->timer);
578 snd_seq_timer_reset(q->timer);
584 /* final stage notification -
585 * remove cells for no longer exist client (for non-owned queue)
586 * or delete this queue (for owned queue)
588 void snd_seq_queue_client_leave(int client)
591 struct snd_seq_queue *q;
593 /* delete own queues from queue list */
594 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
595 if ((q = queue_list_remove(i, client)) != NULL)
599 /* remove cells from existing queues -
600 * they are not owned by this client
602 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
603 if ((q = queueptr(i)) == NULL)
605 if (test_bit(client, q->clients_bitmap)) {
606 snd_seq_prioq_leave(q->tickq, client, 0);
607 snd_seq_prioq_leave(q->timeq, client, 0);
608 snd_seq_queue_use(q->queue, client, 0);
616 /*----------------------------------------------------------------*/
618 /* remove cells from all queues */
619 void snd_seq_queue_client_leave_cells(int client)
622 struct snd_seq_queue *q;
624 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
625 if ((q = queueptr(i)) == NULL)
627 snd_seq_prioq_leave(q->tickq, client, 0);
628 snd_seq_prioq_leave(q->timeq, client, 0);
633 /* remove cells based on flush criteria */
634 void snd_seq_queue_remove_cells(int client, struct snd_seq_remove_events *info)
637 struct snd_seq_queue *q;
639 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
640 if ((q = queueptr(i)) == NULL)
642 if (test_bit(client, q->clients_bitmap) &&
643 (! (info->remove_mode & SNDRV_SEQ_REMOVE_DEST) ||
644 q->queue == info->queue)) {
645 snd_seq_prioq_remove_events(q->tickq, client, info);
646 snd_seq_prioq_remove_events(q->timeq, client, info);
652 /*----------------------------------------------------------------*/
655 * send events to all subscribed ports
657 static void queue_broadcast_event(struct snd_seq_queue *q, struct snd_seq_event *ev,
660 struct snd_seq_event sev;
664 sev.flags = SNDRV_SEQ_TIME_STAMP_TICK|SNDRV_SEQ_TIME_MODE_ABS;
665 sev.time.tick = q->timer->tick.cur_tick;
666 sev.queue = q->queue;
667 sev.data.queue.queue = q->queue;
669 /* broadcast events from Timer port */
670 sev.source.client = SNDRV_SEQ_CLIENT_SYSTEM;
671 sev.source.port = SNDRV_SEQ_PORT_SYSTEM_TIMER;
672 sev.dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
673 snd_seq_kernel_client_dispatch(SNDRV_SEQ_CLIENT_SYSTEM, &sev, atomic, hop);
677 * process a received queue-control event.
678 * this function is exported for seq_sync.c.
680 static void snd_seq_queue_process_event(struct snd_seq_queue *q,
681 struct snd_seq_event *ev,
685 case SNDRV_SEQ_EVENT_START:
686 snd_seq_prioq_leave(q->tickq, ev->source.client, 1);
687 snd_seq_prioq_leave(q->timeq, ev->source.client, 1);
688 if (! snd_seq_timer_start(q->timer))
689 queue_broadcast_event(q, ev, atomic, hop);
692 case SNDRV_SEQ_EVENT_CONTINUE:
693 if (! snd_seq_timer_continue(q->timer))
694 queue_broadcast_event(q, ev, atomic, hop);
697 case SNDRV_SEQ_EVENT_STOP:
698 snd_seq_timer_stop(q->timer);
699 queue_broadcast_event(q, ev, atomic, hop);
702 case SNDRV_SEQ_EVENT_TEMPO:
703 snd_seq_timer_set_tempo(q->timer, ev->data.queue.param.value);
704 queue_broadcast_event(q, ev, atomic, hop);
707 case SNDRV_SEQ_EVENT_SETPOS_TICK:
708 if (snd_seq_timer_set_position_tick(q->timer, ev->data.queue.param.time.tick) == 0) {
709 queue_broadcast_event(q, ev, atomic, hop);
713 case SNDRV_SEQ_EVENT_SETPOS_TIME:
714 if (snd_seq_timer_set_position_time(q->timer, ev->data.queue.param.time.time) == 0) {
715 queue_broadcast_event(q, ev, atomic, hop);
718 case SNDRV_SEQ_EVENT_QUEUE_SKEW:
719 if (snd_seq_timer_set_skew(q->timer,
720 ev->data.queue.param.skew.value,
721 ev->data.queue.param.skew.base) == 0) {
722 queue_broadcast_event(q, ev, atomic, hop);
730 * Queue control via timer control port:
731 * this function is exported as a callback of timer port.
733 int snd_seq_control_queue(struct snd_seq_event *ev, int atomic, int hop)
735 struct snd_seq_queue *q;
737 snd_assert(ev != NULL, return -EINVAL);
738 q = queueptr(ev->data.queue.queue);
743 if (! queue_access_lock(q, ev->source.client)) {
748 snd_seq_queue_process_event(q, ev, atomic, hop);
750 queue_access_unlock(q);
756 /*----------------------------------------------------------------*/
758 #ifdef CONFIG_PROC_FS
759 /* exported to seq_info.c */
760 void snd_seq_info_queues_read(struct snd_info_entry *entry,
761 struct snd_info_buffer *buffer)
764 struct snd_seq_queue *q;
765 struct snd_seq_timer *tmr;
767 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
768 if ((q = queueptr(i)) == NULL)
773 bpm = 60000000 / tmr->tempo;
777 snd_iprintf(buffer, "queue %d: [%s]\n", q->queue, q->name);
778 snd_iprintf(buffer, "owned by client : %d\n", q->owner);
779 snd_iprintf(buffer, "lock status : %s\n", q->locked ? "Locked" : "Free");
780 snd_iprintf(buffer, "queued time events : %d\n", snd_seq_prioq_avail(q->timeq));
781 snd_iprintf(buffer, "queued tick events : %d\n", snd_seq_prioq_avail(q->tickq));
782 snd_iprintf(buffer, "timer state : %s\n", tmr->running ? "Running" : "Stopped");
783 snd_iprintf(buffer, "timer PPQ : %d\n", tmr->ppq);
784 snd_iprintf(buffer, "current tempo : %d\n", tmr->tempo);
785 snd_iprintf(buffer, "current BPM : %d\n", bpm);
786 snd_iprintf(buffer, "current time : %d.%09d s\n", tmr->cur_time.tv_sec, tmr->cur_time.tv_nsec);
787 snd_iprintf(buffer, "current tick : %d\n", tmr->tick.cur_tick);
788 snd_iprintf(buffer, "\n");
792 #endif /* CONFIG_PROC_FS */