blob: 4b9ee3009aa09b46e749509f85cd0fcb60d49b8b [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070030/* maximum number of queues */
Clemens Ladisch1001fb82015-01-25 14:36:46 +010031#define SNDRV_SEQ_MAX_QUEUES 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33/* max number of concurrent clients */
34#define SNDRV_SEQ_MAX_CLIENTS 192
35
36/* max number of concurrent ports */
37#define SNDRV_SEQ_MAX_PORTS 254
38
39/* max number of events in memory pool */
40#define SNDRV_SEQ_MAX_EVENTS 2000
41
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/* default number of events in memory pool */
43#define SNDRV_SEQ_DEFAULT_EVENTS 500
44
45/* max number of events in memory pool for one client (outqueue) */
46#define SNDRV_SEQ_MAX_CLIENT_EVENTS 2000
47
48/* default number of events in memory pool for one client (outqueue) */
49#define SNDRV_SEQ_DEFAULT_CLIENT_EVENTS 200
50
51/* max delivery path length */
Takashi Iwai3510c7a2017-11-06 20:16:50 +010052/* NOTE: this shouldn't be greater than MAX_LOCKDEP_SUBCLASSES */
53#define SNDRV_SEQ_MAX_HOPS 8
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55/* max size of event size */
56#define SNDRV_SEQ_MAX_EVENT_LEN 0x3fffffff
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058/* call-backs for kernel port */
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010059struct snd_seq_port_callback {
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 struct module *owner;
61 void *private_data;
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010062 int (*subscribe)(void *private_data, struct snd_seq_port_subscribe *info);
63 int (*unsubscribe)(void *private_data, struct snd_seq_port_subscribe *info);
64 int (*use)(void *private_data, struct snd_seq_port_subscribe *info);
65 int (*unuse)(void *private_data, struct snd_seq_port_subscribe *info);
66 int (*event_input)(struct snd_seq_event *ev, int direct, void *private_data, int atomic, int hop);
67 void (*private_free)(void *private_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 /*...*/
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010069};
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71/* interface for kernel client */
Joe Perchesb9075fa2011-10-31 17:11:33 -070072__printf(3, 4)
Clemens Ladisch7b6d9242005-12-12 09:33:37 +010073int snd_seq_create_kernel_client(struct snd_card *card, int client_index,
Joe Perchesb9075fa2011-10-31 17:11:33 -070074 const char *name_fmt, ...);
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010075int snd_seq_delete_kernel_client(int client);
76int snd_seq_kernel_client_enqueue(int client, struct snd_seq_event *ev, int atomic, int hop);
77int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event *ev, int atomic, int hop);
78int snd_seq_kernel_client_ctl(int client, unsigned int cmd, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80#define SNDRV_SEQ_EXT_MASK 0xc0000000
81#define SNDRV_SEQ_EXT_USRPTR 0x80000000
82#define SNDRV_SEQ_EXT_CHAINED 0x40000000
83
84typedef int (*snd_seq_dump_func_t)(void *ptr, void *buf, int count);
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010085int snd_seq_expand_var_event(const struct snd_seq_event *event, int count, char *buf,
86 int in_kernel, int size_aligned);
87int snd_seq_dump_var_event(const struct snd_seq_event *event,
88 snd_seq_dump_func_t func, void *private_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90/* interface for OSS emulation */
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010091int snd_seq_set_queue_tempo(int client, struct snd_seq_queue_tempo *tempo);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93/* port callback routines */
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010094void snd_port_init_callback(struct snd_seq_port_callback *p);
95struct snd_seq_port_callback *snd_port_alloc_callback(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
97/* port attach/detach */
Takashi Iwaic7e0b5b2005-11-17 14:04:02 +010098int snd_seq_event_port_attach(int client, struct snd_seq_port_callback *pcbp,
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 int cap, int type, int midi_channels, int midi_voices, char *portname);
100int snd_seq_event_port_detach(int client, int port);
101
Johannes Bergee2da992008-07-09 10:28:41 +0200102#ifdef CONFIG_MODULES
Takashi Iwai68ab6102014-10-15 14:06:25 +0200103void snd_seq_autoload_init(void);
Takashi Iwai54a721a2015-02-12 14:20:24 +0100104void snd_seq_autoload_exit(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105#else
Takashi Iwai68ab6102014-10-15 14:06:25 +0200106#define snd_seq_autoload_init()
107#define snd_seq_autoload_exit()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108#endif
109
110#endif /* __SOUND_SEQ_KERNEL_H */