[net-next-2.6.git] / include / sound / seq_instr.h

#ifndef __SOUND_SEQ_INSTR_H
#define __SOUND_SEQ_INSTR_H

/*
 *  Main kernel header file for the ALSA sequencer
 *  Copyright (c) 1999 by Jaroslav Kysela <perex@perex.cz>
 *
 *
 *   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 "seq_kernel.h"

/* Instrument cluster */
struct snd_seq_kcluster {
	snd_seq_instr_cluster_t cluster;
	char name[32];
	int priority;
	struct snd_seq_kcluster *next;
};

/* return pointer to private data */
#define KINSTR_DATA(kinstr)	(void *)(((char *)kinstr) + sizeof(struct snd_seq_kinstr))

/* Instrument structure */
struct snd_seq_kinstr {
	struct snd_seq_instr instr;
	char name[32];
	int type;			/* instrument type */
	int use;			/* use count */
	int busy;			/* not useable */
	int add_len;			/* additional length */
	struct snd_seq_kinstr_ops *ops;	/* operations */
	struct snd_seq_kinstr *next;
};

#define SNDRV_SEQ_INSTR_HASH_SIZE		32

/* Instrument flags */
#define SNDRV_SEQ_INSTR_FLG_DIRECT	(1<<0)	/* accept only direct events */

/* List of all instruments */
struct snd_seq_kinstr_list {
	struct snd_seq_kinstr *hash[SNDRV_SEQ_INSTR_HASH_SIZE];
	int count;			/* count of all instruments */
	
	struct snd_seq_kcluster *chash[SNDRV_SEQ_INSTR_HASH_SIZE];
	int ccount;			/* count of all clusters */

	int owner;			/* current owner of the instrument list */
	unsigned int flags;

	spinlock_t lock;
	spinlock_t ops_lock;
	struct mutex ops_mutex;
	unsigned long ops_flags;
};

#define SNDRV_SEQ_INSTR_NOTIFY_REMOVE	0
#define SNDRV_SEQ_INSTR_NOTIFY_CHANGE	1

struct snd_seq_kinstr_ops {
	void *private_data;
	long add_len;			/* additional length */
	char *instr_type;
	int (*info)(void *private_data, char *info_data, long len);
	int (*put)(void *private_data, struct snd_seq_kinstr *kinstr,
		   char __user *instr_data, long len, int atomic, int cmd);
	int (*get)(void *private_data, struct snd_seq_kinstr *kinstr,
		   char __user *instr_data, long len, int atomic, int cmd);
	int (*get_size)(void *private_data, struct snd_seq_kinstr *kinstr, long *size);
	int (*remove)(void *private_data, struct snd_seq_kinstr *kinstr, int atomic);
	void (*notify)(void *private_data, struct snd_seq_kinstr *kinstr, int what);
	struct snd_seq_kinstr_ops *next;
};


/* instrument operations */
struct snd_seq_kinstr_list *snd_seq_instr_list_new(void);
void snd_seq_instr_list_free(struct snd_seq_kinstr_list **list);
int snd_seq_instr_list_free_cond(struct snd_seq_kinstr_list *list,
				 struct snd_seq_instr_header *ifree,
				 int client,
				 int atomic);
struct snd_seq_kinstr *snd_seq_instr_find(struct snd_seq_kinstr_list *list,
					  struct snd_seq_instr *instr,
					  int exact,
					  int follow_alias);
void snd_seq_instr_free_use(struct snd_seq_kinstr_list *list,
			    struct snd_seq_kinstr *instr);
int snd_seq_instr_event(struct snd_seq_kinstr_ops *ops,
			struct snd_seq_kinstr_list *list,
			struct snd_seq_event *ev,
			int client,
			int atomic,
			int hop);

#endif /* __SOUND_SEQ_INSTR_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __SOUND_SEQ_INSTR_H
	2	#define __SOUND_SEQ_INSTR_H
	3
	4	/*
	5	* Main kernel header file for the ALSA sequencer
c1017a4c	6	* Copyright (c) 1999 by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	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 "seq_kernel.h"
	25
	26	/* Instrument cluster */
c7e0b5bf	27	struct snd_seq_kcluster {
1da177e4 LT	28	snd_seq_instr_cluster_t cluster;
	29	char name[32];
	30	int priority;
c7e0b5bf TI	31	struct snd_seq_kcluster *next;
c7e0b5bf TI	32	};
1da177e4 LT	33
1da177e4 LT	34	/* return pointer to private data */
c7e0b5bf	35	#define KINSTR_DATA(kinstr) (void )(((char )kinstr) + sizeof(struct snd_seq_kinstr))
1da177e4 LT	36
1da177e4 LT	37	/* Instrument structure */
c7e0b5bf TI	38	struct snd_seq_kinstr {
c7e0b5bf TI	39	struct snd_seq_instr instr;
1da177e4 LT	40	char name[32];
	41	int type; /* instrument type */
	42	int use; /* use count */
	43	int busy; /* not useable */
	44	int add_len; /* additional length */
c7e0b5bf TI	45	struct snd_seq_kinstr_ops ops; / operations */
	46	struct snd_seq_kinstr *next;
	47	};
1da177e4 LT	48
	49	#define SNDRV_SEQ_INSTR_HASH_SIZE 32
	50
	51	/* Instrument flags */
	52	#define SNDRV_SEQ_INSTR_FLG_DIRECT (1<<0) /* accept only direct events */
	53
	54	/* List of all instruments */
c7e0b5bf TI	55	struct snd_seq_kinstr_list {
c7e0b5bf TI	56	struct snd_seq_kinstr *hash[SNDRV_SEQ_INSTR_HASH_SIZE];
1da177e4 LT	57	int count; /* count of all instruments */
1da177e4 LT	58
c7e0b5bf	59	struct snd_seq_kcluster *chash[SNDRV_SEQ_INSTR_HASH_SIZE];
1da177e4 LT	60	int ccount; /* count of all clusters */
	61
	62	int owner; /* current owner of the instrument list */
	63	unsigned int flags;
	64
	65	spinlock_t lock;
	66	spinlock_t ops_lock;
1a60d4c5	67	struct mutex ops_mutex;
1da177e4	68	unsigned long ops_flags;
c7e0b5bf	69	};
1da177e4 LT	70
	71	#define SNDRV_SEQ_INSTR_NOTIFY_REMOVE 0
	72	#define SNDRV_SEQ_INSTR_NOTIFY_CHANGE 1
	73
	74	struct snd_seq_kinstr_ops {
	75	void *private_data;
	76	long add_len; /* additional length */
	77	char *instr_type;
	78	int (info)(void private_data, char *info_data, long len);
c7e0b5bf	79	int (put)(void private_data, struct snd_seq_kinstr *kinstr,
1da177e4	80	char __user *instr_data, long len, int atomic, int cmd);
c7e0b5bf	81	int (get)(void private_data, struct snd_seq_kinstr *kinstr,
1da177e4	82	char __user *instr_data, long len, int atomic, int cmd);
c7e0b5bf TI	83	int (get_size)(void private_data, struct snd_seq_kinstr kinstr, long size);
	84	int (remove)(void private_data, struct snd_seq_kinstr *kinstr, int atomic);
	85	void (notify)(void private_data, struct snd_seq_kinstr *kinstr, int what);
1da177e4 LT	86	struct snd_seq_kinstr_ops *next;
	87	};
	88
	89
	90	/* instrument operations */
c7e0b5bf TI	91	struct snd_seq_kinstr_list *snd_seq_instr_list_new(void);
	92	void snd_seq_instr_list_free(struct snd_seq_kinstr_list **list);
	93	int snd_seq_instr_list_free_cond(struct snd_seq_kinstr_list *list,
	94	struct snd_seq_instr_header *ifree,
1da177e4 LT	95	int client,
1da177e4 LT	96	int atomic);
c7e0b5bf TI	97	struct snd_seq_kinstr snd_seq_instr_find(struct snd_seq_kinstr_list list,
	98	struct snd_seq_instr *instr,
	99	int exact,
	100	int follow_alias);
	101	void snd_seq_instr_free_use(struct snd_seq_kinstr_list *list,
	102	struct snd_seq_kinstr *instr);
	103	int snd_seq_instr_event(struct snd_seq_kinstr_ops *ops,
	104	struct snd_seq_kinstr_list *list,
	105	struct snd_seq_event *ev,
1da177e4 LT	106	int client,
	107	int atomic,
	108	int hop);
	109
	110	#endif /* __SOUND_SEQ_INSTR_H */