blob: 2398521f0998e5ab0ecce6e87728d35e533d6a38 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_SEQ_KERNEL_H
2#define __SOUND_SEQ_KERNEL_H
3
4/*
5 * Main kernel header file for the ALSA sequencer
6 * Copyright (c) 1998 by Frank van de Pol <fvdpol@coil.demon.nl>
7 *
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 *
23 */
24#include <linux/time.h>
David Howellsa1ce3922012-10-02 18:01:25 +010025#include <sound/asequencer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010027typedef struct snd_seq_real_time snd_seq_real_time_t;
28typedef union snd_seq_timestamp snd_seq_timestamp_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30/* maximum number of events dequeued per schedule interval */
31#define SNDRV_SEQ_MAX_DEQUEUE 50
32
33/* maximum number of queues */
34#define SNDRV_SEQ_MAX_QUEUES 8
35
36/* max number of concurrent clients */
37#define SNDRV_SEQ_MAX_CLIENTS 192
38
39/* max number of concurrent ports */
40#define SNDRV_SEQ_MAX_PORTS 254
41
42/* max number of events in memory pool */
43#define SNDRV_SEQ_MAX_EVENTS 2000
44
45/* default number of events in memory chunk */
46#define SNDRV_SEQ_DEFAULT_CHUNK_EVENTS 64
47
48/* default number of events in memory pool */
49#define SNDRV_SEQ_DEFAULT_EVENTS 500
50
51/* max number of events in memory pool for one client (outqueue) */
52#define SNDRV_SEQ_MAX_CLIENT_EVENTS 2000
53
54/* default number of events in memory pool for one client (outqueue) */
55#define SNDRV_SEQ_DEFAULT_CLIENT_EVENTS 200
56
57/* max delivery path length */
58#define SNDRV_SEQ_MAX_HOPS 10
59
60/* max size of event size */
61#define SNDRV_SEQ_MAX_EVENT_LEN 0x3fffffff
62
Linus Torvalds1da177e2005-04-16 15:20:36 -070063/* call-backs for kernel port */
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010064struct snd_seq_port_callback {
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 struct module *owner;
66 void *private_data;
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010067 int (*subscribe)(void *private_data, struct snd_seq_port_subscribe *info);
68 int (*unsubscribe)(void *private_data, struct snd_seq_port_subscribe *info);
69 int (*use)(void *private_data, struct snd_seq_port_subscribe *info);
70 int (*unuse)(void *private_data, struct snd_seq_port_subscribe *info);
71 int (*event_input)(struct snd_seq_event *ev, int direct, void *private_data, int atomic, int hop);
72 void (*private_free)(void *private_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 unsigned int callback_all; /* call subscribe callbacks at each connection/disconnection */
74 /*...*/
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010075};
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77/* interface for kernel client */
Joe Perchesb9075fa2011-10-31 17:11:33 -070078__printf(3, 4)
Clemens Ladisch7b6d9242005-12-12 09:33:37 +010079int snd_seq_create_kernel_client(struct snd_card *card, int client_index,
Joe Perchesb9075fa2011-10-31 17:11:33 -070080 const char *name_fmt, ...);
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010081int snd_seq_delete_kernel_client(int client);
82int snd_seq_kernel_client_enqueue(int client, struct snd_seq_event *ev, int atomic, int hop);
83int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event *ev, int atomic, int hop);
84int snd_seq_kernel_client_ctl(int client, unsigned int cmd, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86#define SNDRV_SEQ_EXT_MASK 0xc0000000
87#define SNDRV_SEQ_EXT_USRPTR 0x80000000
88#define SNDRV_SEQ_EXT_CHAINED 0x40000000
89
90typedef int (*snd_seq_dump_func_t)(void *ptr, void *buf, int count);
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010091int snd_seq_expand_var_event(const struct snd_seq_event *event, int count, char *buf,
92 int in_kernel, int size_aligned);
93int snd_seq_dump_var_event(const struct snd_seq_event *event,
94 snd_seq_dump_func_t func, void *private_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96/* interface for OSS emulation */
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010097int snd_seq_set_queue_tempo(int client, struct snd_seq_queue_tempo *tempo);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99/* port callback routines */
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +0100100void snd_port_init_callback(struct snd_seq_port_callback *p);
101struct snd_seq_port_callback *snd_port_alloc_callback(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103/* port attach/detach */
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +0100104int snd_seq_event_port_attach(int client, struct snd_seq_port_callback *pcbp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 int cap, int type, int midi_channels, int midi_voices, char *portname);
106int snd_seq_event_port_detach(int client, int port);
107
Johannes Bergee2da992008-07-09 10:28:41 +0200108#ifdef CONFIG_MODULES
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109void snd_seq_autoload_lock(void);
110void snd_seq_autoload_unlock(void);
111#else
112#define snd_seq_autoload_lock()
113#define snd_seq_autoload_unlock()
114#endif
115
116#endif /* __SOUND_SEQ_KERNEL_H */