[linux-2.6-block.git] / include / sound / seq_kernel.h

#ifndef __SOUND_SEQ_KERNEL_H
#define __SOUND_SEQ_KERNEL_H

/*
 *  Main kernel header file for the ALSA sequencer
 *  Copyright (c) 1998 by Frank van de Pol <fvdpol@coil.demon.nl>
 *
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */
#include <linux/time.h>
#include <sound/asequencer.h>

typedef struct snd_seq_real_time snd_seq_real_time_t;
typedef union snd_seq_timestamp snd_seq_timestamp_t;

/* maximum number of queues */
#define SNDRV_SEQ_MAX_QUEUES		32

/* max number of concurrent clients */
#define SNDRV_SEQ_MAX_CLIENTS 		192

/* max number of concurrent ports */
#define SNDRV_SEQ_MAX_PORTS 		254

/* max number of events in memory pool */
#define SNDRV_SEQ_MAX_EVENTS		2000

/* default number of events in memory pool */
#define SNDRV_SEQ_DEFAULT_EVENTS	500

/* max number of events in memory pool for one client (outqueue) */
#define SNDRV_SEQ_MAX_CLIENT_EVENTS	2000

/* default number of events in memory pool for one client (outqueue) */
#define SNDRV_SEQ_DEFAULT_CLIENT_EVENTS	200

/* max delivery path length */
#define SNDRV_SEQ_MAX_HOPS		10

/* max size of event size */
#define SNDRV_SEQ_MAX_EVENT_LEN		0x3fffffff

/* call-backs for kernel port */
struct snd_seq_port_callback {
	struct module *owner;
	void *private_data;
	int (*subscribe)(void *private_data, struct snd_seq_port_subscribe *info);
	int (*unsubscribe)(void *private_data, struct snd_seq_port_subscribe *info);
	int (*use)(void *private_data, struct snd_seq_port_subscribe *info);
	int (*unuse)(void *private_data, struct snd_seq_port_subscribe *info);
	int (*event_input)(struct snd_seq_event *ev, int direct, void *private_data, int atomic, int hop);
	void (*private_free)(void *private_data);
	/*...*/
};

/* interface for kernel client */
__printf(3, 4)
int snd_seq_create_kernel_client(struct snd_card *card, int client_index,
				 const char *name_fmt, ...);
int snd_seq_delete_kernel_client(int client);
int snd_seq_kernel_client_enqueue(int client, struct snd_seq_event *ev, int atomic, int hop);
int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event *ev, int atomic, int hop);
int snd_seq_kernel_client_ctl(int client, unsigned int cmd, void *arg);

#define SNDRV_SEQ_EXT_MASK	0xc0000000
#define SNDRV_SEQ_EXT_USRPTR	0x80000000
#define SNDRV_SEQ_EXT_CHAINED	0x40000000

typedef int (*snd_seq_dump_func_t)(void *ptr, void *buf, int count);
int snd_seq_expand_var_event(const struct snd_seq_event *event, int count, char *buf,
			     int in_kernel, int size_aligned);
int snd_seq_dump_var_event(const struct snd_seq_event *event,
			   snd_seq_dump_func_t func, void *private_data);

/* interface for OSS emulation */
int snd_seq_set_queue_tempo(int client, struct snd_seq_queue_tempo *tempo);

/* port callback routines */
void snd_port_init_callback(struct snd_seq_port_callback *p);
struct snd_seq_port_callback *snd_port_alloc_callback(void);

/* port attach/detach */
int snd_seq_event_port_attach(int client, struct snd_seq_port_callback *pcbp,
			      int cap, int type, int midi_channels, int midi_voices, char *portname);
int snd_seq_event_port_detach(int client, int port);

#ifdef CONFIG_MODULES
void snd_seq_autoload_init(void);
void snd_seq_autoload_exit(void);
#else
#define snd_seq_autoload_init()
#define snd_seq_autoload_exit()
#endif

#endif /* __SOUND_SEQ_KERNEL_H */
Commit	Line	Data
1da177e4 LT	1	#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>
a1ce3928	25	#include <sound/asequencer.h>
1da177e4	26
c7e0b5bf TI	27	typedef struct snd_seq_real_time snd_seq_real_time_t;
c7e0b5bf TI	28	typedef union snd_seq_timestamp snd_seq_timestamp_t;
1da177e4	29
1da177e4	30	/* maximum number of queues */
1001fb81	31	#define SNDRV_SEQ_MAX_QUEUES 32
1da177e4 LT	32
	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
1da177e4 LT	42	/* 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 */
	52	#define SNDRV_SEQ_MAX_HOPS 10
	53
	54	/* max size of event size */
	55	#define SNDRV_SEQ_MAX_EVENT_LEN 0x3fffffff
	56
1da177e4	57	/* call-backs for kernel port */
c7e0b5bf	58	struct snd_seq_port_callback {
1da177e4 LT	59	struct module *owner;
1da177e4 LT	60	void *private_data;
c7e0b5bf TI	61	int (subscribe)(void private_data, struct snd_seq_port_subscribe *info);
	62	int (unsubscribe)(void private_data, struct snd_seq_port_subscribe *info);
	63	int (use)(void private_data, struct snd_seq_port_subscribe *info);
	64	int (unuse)(void private_data, struct snd_seq_port_subscribe *info);
	65	int (event_input)(struct snd_seq_event ev, int direct, void *private_data, int atomic, int hop);
	66	void (private_free)(void private_data);
1da177e4	67	/.../
c7e0b5bf	68	};
1da177e4 LT	69
1da177e4 LT	70	/* interface for kernel client */
b9075fa9	71	__printf(3, 4)
7b6d9245	72	int snd_seq_create_kernel_client(struct snd_card *card, int client_index,
b9075fa9	73	const char *name_fmt, ...);
c7e0b5bf TI	74	int snd_seq_delete_kernel_client(int client);
	75	int snd_seq_kernel_client_enqueue(int client, struct snd_seq_event *ev, int atomic, int hop);
	76	int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event *ev, int atomic, int hop);
	77	int snd_seq_kernel_client_ctl(int client, unsigned int cmd, void *arg);
1da177e4 LT	78
	79	#define SNDRV_SEQ_EXT_MASK 0xc0000000
	80	#define SNDRV_SEQ_EXT_USRPTR 0x80000000
	81	#define SNDRV_SEQ_EXT_CHAINED 0x40000000
	82
	83	typedef int (snd_seq_dump_func_t)(void ptr, void *buf, int count);
c7e0b5bf TI	84	int snd_seq_expand_var_event(const struct snd_seq_event event, int count, char buf,
	85	int in_kernel, int size_aligned);
	86	int snd_seq_dump_var_event(const struct snd_seq_event *event,
	87	snd_seq_dump_func_t func, void *private_data);
1da177e4 LT	88
1da177e4 LT	89	/* interface for OSS emulation */
c7e0b5bf	90	int snd_seq_set_queue_tempo(int client, struct snd_seq_queue_tempo *tempo);
1da177e4 LT	91
1da177e4 LT	92	/* port callback routines */
c7e0b5bf TI	93	void snd_port_init_callback(struct snd_seq_port_callback *p);
c7e0b5bf TI	94	struct snd_seq_port_callback *snd_port_alloc_callback(void);
1da177e4 LT	95
1da177e4 LT	96	/* port attach/detach */
c7e0b5bf	97	int snd_seq_event_port_attach(int client, struct snd_seq_port_callback *pcbp,
1da177e4 LT	98	int cap, int type, int midi_channels, int midi_voices, char *portname);
	99	int snd_seq_event_port_detach(int client, int port);
	100
ee2da997	101	#ifdef CONFIG_MODULES
68ab6108	102	void snd_seq_autoload_init(void);
54a721ab	103	void snd_seq_autoload_exit(void);
1da177e4	104	#else
68ab6108 TI	105	#define snd_seq_autoload_init()
68ab6108 TI	106	#define snd_seq_autoload_exit()
1da177e4 LT	107	#endif
	108
	109	#endif /* __SOUND_SEQ_KERNEL_H */