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);
117 spin_lock_init(&q->owner_lock);
118 spin_lock_init(&q->check_lock);
119 mutex_init(&q->timer_mutex);
120 snd_use_lock_init(&q->use_lock);
123 q->tickq = snd_seq_prioq_new();
124 q->timeq = snd_seq_prioq_new();
125 q->timer = snd_seq_timer_new();
126 if (q->tickq == NULL || q->timeq == NULL || q->timer == NULL) {
127 snd_seq_prioq_delete(&q->tickq);
128 snd_seq_prioq_delete(&q->timeq);
129 snd_seq_timer_delete(&q->timer);
141 /* delete queue (destructor) */
142 static void queue_delete(struct snd_seq_queue *q)
144 /* stop and release the timer */
145 mutex_lock(&q->timer_mutex);
146 snd_seq_timer_stop(q->timer);
147 snd_seq_timer_close(q);
148 mutex_unlock(&q->timer_mutex);
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 static void queue_use(struct snd_seq_queue *queue, int client, int use);
186 /* allocate a new queue -
187 * return queue index value or negative value for error
189 int snd_seq_queue_alloc(int client, int locked, unsigned int info_flags)
191 struct snd_seq_queue *q;
193 q = queue_new(client, locked);
196 q->info_flags = info_flags;
197 queue_use(q, client, 1);
198 if (queue_list_add(q) < 0) {
205 /* delete a queue - queue must be owned by the client */
206 int snd_seq_queue_delete(int client, int queueid)
208 struct snd_seq_queue *q;
210 if (queueid < 0 || queueid >= SNDRV_SEQ_MAX_QUEUES)
212 q = queue_list_remove(queueid, client);
221 /* return pointer to queue structure for specified id */
222 struct snd_seq_queue *queueptr(int queueid)
224 struct snd_seq_queue *q;
227 if (queueid < 0 || queueid >= SNDRV_SEQ_MAX_QUEUES)
229 spin_lock_irqsave(&queue_list_lock, flags);
230 q = queue_list[queueid];
232 snd_use_lock_use(&q->use_lock);
233 spin_unlock_irqrestore(&queue_list_lock, flags);
237 /* return the (first) queue matching with the specified name */
238 struct snd_seq_queue *snd_seq_queue_find_name(char *name)
241 struct snd_seq_queue *q;
243 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
244 if ((q = queueptr(i)) != NULL) {
245 if (strncmp(q->name, name, sizeof(q->name)) == 0)
254 /* -------------------------------------------------------- */
256 void snd_seq_check_queue(struct snd_seq_queue *q, int atomic, int hop)
259 struct snd_seq_event_cell *cell;
264 /* make this function non-reentrant */
265 spin_lock_irqsave(&q->check_lock, flags);
266 if (q->check_blocked) {
268 spin_unlock_irqrestore(&q->check_lock, flags);
269 return; /* other thread is already checking queues */
271 q->check_blocked = 1;
272 spin_unlock_irqrestore(&q->check_lock, flags);
275 /* Process tick queue... */
276 while ((cell = snd_seq_prioq_cell_peek(q->tickq)) != NULL) {
277 if (snd_seq_compare_tick_time(&q->timer->tick.cur_tick,
278 &cell->event.time.tick)) {
279 cell = snd_seq_prioq_cell_out(q->tickq);
281 snd_seq_dispatch_event(cell, atomic, hop);
283 /* event remains in the queue */
289 /* Process time queue... */
290 while ((cell = snd_seq_prioq_cell_peek(q->timeq)) != NULL) {
291 if (snd_seq_compare_real_time(&q->timer->cur_time,
292 &cell->event.time.time)) {
293 cell = snd_seq_prioq_cell_out(q->timeq);
295 snd_seq_dispatch_event(cell, atomic, hop);
297 /* event remains in the queue */
303 spin_lock_irqsave(&q->check_lock, flags);
304 if (q->check_again) {
306 spin_unlock_irqrestore(&q->check_lock, flags);
309 q->check_blocked = 0;
310 spin_unlock_irqrestore(&q->check_lock, flags);
314 /* enqueue a event to singe queue */
315 int snd_seq_enqueue_event(struct snd_seq_event_cell *cell, int atomic, int hop)
318 struct snd_seq_queue *q;
320 if (snd_BUG_ON(!cell))
322 dest = cell->event.queue; /* destination queue */
326 /* handle relative time stamps, convert them into absolute */
327 if ((cell->event.flags & SNDRV_SEQ_TIME_MODE_MASK) == SNDRV_SEQ_TIME_MODE_REL) {
328 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
329 case SNDRV_SEQ_TIME_STAMP_TICK:
330 cell->event.time.tick += q->timer->tick.cur_tick;
333 case SNDRV_SEQ_TIME_STAMP_REAL:
334 snd_seq_inc_real_time(&cell->event.time.time,
335 &q->timer->cur_time);
338 cell->event.flags &= ~SNDRV_SEQ_TIME_MODE_MASK;
339 cell->event.flags |= SNDRV_SEQ_TIME_MODE_ABS;
341 /* enqueue event in the real-time or midi queue */
342 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
343 case SNDRV_SEQ_TIME_STAMP_TICK:
344 err = snd_seq_prioq_cell_in(q->tickq, cell);
347 case SNDRV_SEQ_TIME_STAMP_REAL:
349 err = snd_seq_prioq_cell_in(q->timeq, cell);
354 queuefree(q); /* unlock */
358 /* trigger dispatching */
359 snd_seq_check_queue(q, atomic, hop);
361 queuefree(q); /* unlock */
367 /*----------------------------------------------------------------*/
369 static inline int check_access(struct snd_seq_queue *q, int client)
371 return (q->owner == client) || (!q->locked && !q->klocked);
374 /* check if the client has permission to modify queue parameters.
375 * if it does, lock the queue
377 static int queue_access_lock(struct snd_seq_queue *q, int client)
382 spin_lock_irqsave(&q->owner_lock, flags);
383 access_ok = check_access(q, client);
386 spin_unlock_irqrestore(&q->owner_lock, flags);
390 /* unlock the queue */
391 static inline void queue_access_unlock(struct snd_seq_queue *q)
395 spin_lock_irqsave(&q->owner_lock, flags);
397 spin_unlock_irqrestore(&q->owner_lock, flags);
400 /* exported - only checking permission */
401 int snd_seq_queue_check_access(int queueid, int client)
403 struct snd_seq_queue *q = queueptr(queueid);
409 spin_lock_irqsave(&q->owner_lock, flags);
410 access_ok = check_access(q, client);
411 spin_unlock_irqrestore(&q->owner_lock, flags);
416 /*----------------------------------------------------------------*/
419 * change queue's owner and permission
421 int snd_seq_queue_set_owner(int queueid, int client, int locked)
423 struct snd_seq_queue *q = queueptr(queueid);
428 if (! queue_access_lock(q, client)) {
433 q->locked = locked ? 1 : 0;
435 queue_access_unlock(q);
442 /*----------------------------------------------------------------*/
445 * q->use mutex should be down before calling this function to avoid
446 * confliction with snd_seq_queue_use()
448 int snd_seq_queue_timer_open(int queueid)
451 struct snd_seq_queue *queue;
452 struct snd_seq_timer *tmr;
454 queue = queueptr(queueid);
458 if ((result = snd_seq_timer_open(queue)) < 0) {
459 snd_seq_timer_defaults(tmr);
460 result = snd_seq_timer_open(queue);
467 * q->use mutex should be down before calling this function
469 int snd_seq_queue_timer_close(int queueid)
471 struct snd_seq_queue *queue;
474 queue = queueptr(queueid);
477 snd_seq_timer_close(queue);
482 /* change queue tempo and ppq */
483 int snd_seq_queue_timer_set_tempo(int queueid, int client,
484 struct snd_seq_queue_tempo *info)
486 struct snd_seq_queue *q = queueptr(queueid);
491 if (! queue_access_lock(q, client)) {
496 result = snd_seq_timer_set_tempo(q->timer, info->tempo);
498 result = snd_seq_timer_set_ppq(q->timer, info->ppq);
499 if (result >= 0 && info->skew_base > 0)
500 result = snd_seq_timer_set_skew(q->timer, info->skew_value,
502 queue_access_unlock(q);
507 /* use or unuse this queue */
508 static void queue_use(struct snd_seq_queue *queue, int client, int use)
511 if (!test_and_set_bit(client, queue->clients_bitmap))
514 if (test_and_clear_bit(client, queue->clients_bitmap))
517 if (queue->clients) {
518 if (use && queue->clients == 1)
519 snd_seq_timer_defaults(queue->timer);
520 snd_seq_timer_open(queue);
522 snd_seq_timer_close(queue);
526 /* use or unuse this queue -
527 * if it is the first client, starts the timer.
528 * if it is not longer used by any clients, stop the timer.
530 int snd_seq_queue_use(int queueid, int client, int use)
532 struct snd_seq_queue *queue;
534 queue = queueptr(queueid);
537 mutex_lock(&queue->timer_mutex);
538 queue_use(queue, client, use);
539 mutex_unlock(&queue->timer_mutex);
545 * check if queue is used by the client
546 * return negative value if the queue is invalid.
547 * return 0 if not used, 1 if used.
549 int snd_seq_queue_is_used(int queueid, int client)
551 struct snd_seq_queue *q;
554 q = queueptr(queueid);
556 return -EINVAL; /* invalid queue */
557 result = test_bit(client, q->clients_bitmap) ? 1 : 0;
563 /*----------------------------------------------------------------*/
565 /* notification that client has left the system -
566 * stop the timer on all queues owned by this client
568 void snd_seq_queue_client_termination(int client)
572 struct snd_seq_queue *q;
574 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
575 if ((q = queueptr(i)) == NULL)
577 spin_lock_irqsave(&q->owner_lock, flags);
578 if (q->owner == client)
580 spin_unlock_irqrestore(&q->owner_lock, flags);
581 if (q->owner == client) {
582 if (q->timer->running)
583 snd_seq_timer_stop(q->timer);
584 snd_seq_timer_reset(q->timer);
590 /* final stage notification -
591 * remove cells for no longer exist client (for non-owned queue)
592 * or delete this queue (for owned queue)
594 void snd_seq_queue_client_leave(int client)
597 struct snd_seq_queue *q;
599 /* delete own queues from queue list */
600 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
601 if ((q = queue_list_remove(i, client)) != NULL)
605 /* remove cells from existing queues -
606 * they are not owned by this client
608 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
609 if ((q = queueptr(i)) == NULL)
611 if (test_bit(client, q->clients_bitmap)) {
612 snd_seq_prioq_leave(q->tickq, client, 0);
613 snd_seq_prioq_leave(q->timeq, client, 0);
614 snd_seq_queue_use(q->queue, client, 0);
622 /*----------------------------------------------------------------*/
624 /* remove cells from all queues */
625 void snd_seq_queue_client_leave_cells(int client)
628 struct snd_seq_queue *q;
630 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
631 if ((q = queueptr(i)) == NULL)
633 snd_seq_prioq_leave(q->tickq, client, 0);
634 snd_seq_prioq_leave(q->timeq, client, 0);
639 /* remove cells based on flush criteria */
640 void snd_seq_queue_remove_cells(int client, struct snd_seq_remove_events *info)
643 struct snd_seq_queue *q;
645 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
646 if ((q = queueptr(i)) == NULL)
648 if (test_bit(client, q->clients_bitmap) &&
649 (! (info->remove_mode & SNDRV_SEQ_REMOVE_DEST) ||
650 q->queue == info->queue)) {
651 snd_seq_prioq_remove_events(q->tickq, client, info);
652 snd_seq_prioq_remove_events(q->timeq, client, info);
658 /*----------------------------------------------------------------*/
661 * send events to all subscribed ports
663 static void queue_broadcast_event(struct snd_seq_queue *q, struct snd_seq_event *ev,
666 struct snd_seq_event sev;
670 sev.flags = SNDRV_SEQ_TIME_STAMP_TICK|SNDRV_SEQ_TIME_MODE_ABS;
671 sev.time.tick = q->timer->tick.cur_tick;
672 sev.queue = q->queue;
673 sev.data.queue.queue = q->queue;
675 /* broadcast events from Timer port */
676 sev.source.client = SNDRV_SEQ_CLIENT_SYSTEM;
677 sev.source.port = SNDRV_SEQ_PORT_SYSTEM_TIMER;
678 sev.dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
679 snd_seq_kernel_client_dispatch(SNDRV_SEQ_CLIENT_SYSTEM, &sev, atomic, hop);
683 * process a received queue-control event.
684 * this function is exported for seq_sync.c.
686 static void snd_seq_queue_process_event(struct snd_seq_queue *q,
687 struct snd_seq_event *ev,
691 case SNDRV_SEQ_EVENT_START:
692 snd_seq_prioq_leave(q->tickq, ev->source.client, 1);
693 snd_seq_prioq_leave(q->timeq, ev->source.client, 1);
694 if (! snd_seq_timer_start(q->timer))
695 queue_broadcast_event(q, ev, atomic, hop);
698 case SNDRV_SEQ_EVENT_CONTINUE:
699 if (! snd_seq_timer_continue(q->timer))
700 queue_broadcast_event(q, ev, atomic, hop);
703 case SNDRV_SEQ_EVENT_STOP:
704 snd_seq_timer_stop(q->timer);
705 queue_broadcast_event(q, ev, atomic, hop);
708 case SNDRV_SEQ_EVENT_TEMPO:
709 snd_seq_timer_set_tempo(q->timer, ev->data.queue.param.value);
710 queue_broadcast_event(q, ev, atomic, hop);
713 case SNDRV_SEQ_EVENT_SETPOS_TICK:
714 if (snd_seq_timer_set_position_tick(q->timer, ev->data.queue.param.time.tick) == 0) {
715 queue_broadcast_event(q, ev, atomic, hop);
719 case SNDRV_SEQ_EVENT_SETPOS_TIME:
720 if (snd_seq_timer_set_position_time(q->timer, ev->data.queue.param.time.time) == 0) {
721 queue_broadcast_event(q, ev, atomic, hop);
724 case SNDRV_SEQ_EVENT_QUEUE_SKEW:
725 if (snd_seq_timer_set_skew(q->timer,
726 ev->data.queue.param.skew.value,
727 ev->data.queue.param.skew.base) == 0) {
728 queue_broadcast_event(q, ev, atomic, hop);
736 * Queue control via timer control port:
737 * this function is exported as a callback of timer port.
739 int snd_seq_control_queue(struct snd_seq_event *ev, int atomic, int hop)
741 struct snd_seq_queue *q;
745 q = queueptr(ev->data.queue.queue);
750 if (! queue_access_lock(q, ev->source.client)) {
755 snd_seq_queue_process_event(q, ev, atomic, hop);
757 queue_access_unlock(q);
763 /*----------------------------------------------------------------*/
765 #ifdef CONFIG_SND_PROC_FS
766 /* exported to seq_info.c */
767 void snd_seq_info_queues_read(struct snd_info_entry *entry,
768 struct snd_info_buffer *buffer)
771 struct snd_seq_queue *q;
772 struct snd_seq_timer *tmr;
774 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
775 if ((q = queueptr(i)) == NULL)
780 bpm = 60000000 / tmr->tempo;
784 snd_iprintf(buffer, "queue %d: [%s]\n", q->queue, q->name);
785 snd_iprintf(buffer, "owned by client : %d\n", q->owner);
786 snd_iprintf(buffer, "lock status : %s\n", q->locked ? "Locked" : "Free");
787 snd_iprintf(buffer, "queued time events : %d\n", snd_seq_prioq_avail(q->timeq));
788 snd_iprintf(buffer, "queued tick events : %d\n", snd_seq_prioq_avail(q->tickq));
789 snd_iprintf(buffer, "timer state : %s\n", tmr->running ? "Running" : "Stopped");
790 snd_iprintf(buffer, "timer PPQ : %d\n", tmr->ppq);
791 snd_iprintf(buffer, "current tempo : %d\n", tmr->tempo);
792 snd_iprintf(buffer, "current BPM : %d\n", bpm);
793 snd_iprintf(buffer, "current time : %d.%09d s\n", tmr->cur_time.tv_sec, tmr->cur_time.tv_nsec);
794 snd_iprintf(buffer, "current tick : %d\n", tmr->tick.cur_tick);
795 snd_iprintf(buffer, "\n");
799 #endif /* CONFIG_SND_PROC_FS */