xref: /linux/include/sound/seq_kernel.h (revision 4bedea94545165364618d403d03b61d797acba0b)
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>
25 #include "asequencer.h"
26 
27 typedef sndrv_seq_tick_time_t snd_seq_tick_time_t;
28 typedef sndrv_seq_position_t snd_seq_position_t;
29 typedef sndrv_seq_frequency_t snd_seq_frequency_t;
30 typedef sndrv_seq_instr_cluster_t snd_seq_instr_cluster_t;
31 typedef enum sndrv_seq_client_type snd_seq_client_type_t;
32 typedef enum sndrv_seq_stop_mode snd_seq_stop_mode_t;
33 typedef struct sndrv_seq_port_info snd_seq_port_info_t;
34 typedef struct sndrv_seq_port_subscribe snd_seq_port_subscribe_t;
35 typedef struct sndrv_seq_event snd_seq_event_t;
36 typedef struct sndrv_seq_addr snd_seq_addr_t;
37 typedef struct sndrv_seq_ev_volume snd_seq_ev_volume_t;
38 typedef struct sndrv_seq_ev_loop snd_seq_ev_loop_t;
39 typedef struct sndrv_seq_remove_events snd_seq_remove_events_t;
40 typedef struct sndrv_seq_query_subs snd_seq_query_subs_t;
41 typedef struct sndrv_seq_real_time snd_seq_real_time_t;
42 typedef struct sndrv_seq_system_info snd_seq_system_info_t;
43 typedef struct sndrv_seq_client_info snd_seq_client_info_t;
44 typedef struct sndrv_seq_queue_info snd_seq_queue_info_t;
45 typedef struct sndrv_seq_queue_status snd_seq_queue_status_t;
46 typedef struct sndrv_seq_queue_tempo snd_seq_queue_tempo_t;
47 typedef struct sndrv_seq_queue_owner snd_seq_queue_owner_t;
48 typedef struct sndrv_seq_queue_timer snd_seq_queue_timer_t;
49 typedef struct sndrv_seq_queue_client snd_seq_queue_client_t;
50 typedef struct sndrv_seq_client_pool snd_seq_client_pool_t;
51 typedef struct sndrv_seq_instr snd_seq_instr_t;
52 typedef struct sndrv_seq_instr_data snd_seq_instr_data_t;
53 typedef struct sndrv_seq_instr_header snd_seq_instr_header_t;
54 typedef union sndrv_seq_timestamp snd_seq_timestamp_t;
55 
56 #define snd_seq_event_bounce_ext_data	sndrv_seq_event_bounce_ext_data
57 #define snd_seq_ev_is_result_type	sndrv_seq_ev_is_result_type
58 #define snd_seq_ev_is_channel_type	sndrv_seq_ev_is_channel_type
59 #define snd_seq_ev_is_note_type		sndrv_seq_ev_is_note_type
60 #define snd_seq_ev_is_control_type	sndrv_seq_ev_is_control_type
61 #define snd_seq_ev_is_queue_type	sndrv_seq_ev_is_queue_type
62 #define snd_seq_ev_is_message_type	sndrv_seq_ev_is_message_type
63 #define snd_seq_ev_is_sample_type	sndrv_seq_ev_is_sample_type
64 #define snd_seq_ev_is_user_type		sndrv_seq_ev_is_user_type
65 #define snd_seq_ev_is_fixed_type	sndrv_seq_ev_is_fixed_type
66 #define snd_seq_ev_is_instr_type	sndrv_seq_ev_is_instr_type
67 #define snd_seq_ev_is_variable_type	sndrv_seq_ev_is_variable_type
68 #define snd_seq_ev_is_reserved		sndrv_seq_ev_is_reserved
69 #define snd_seq_ev_is_direct		sndrv_seq_ev_is_direct
70 #define snd_seq_ev_is_prior		sndrv_seq_ev_is_prior
71 #define snd_seq_ev_length_type		sndrv_seq_ev_length_type
72 #define snd_seq_ev_is_fixed		sndrv_seq_ev_is_fixed
73 #define snd_seq_ev_is_variable		sndrv_seq_ev_is_variable
74 #define snd_seq_ev_is_varusr		sndrv_seq_ev_is_varusr
75 #define snd_seq_ev_timestamp_type	sndrv_seq_ev_timestamp_type
76 #define snd_seq_ev_is_tick		sndrv_seq_ev_is_tick
77 #define snd_seq_ev_is_real		sndrv_seq_ev_is_real
78 #define snd_seq_ev_timemode_type	sndrv_seq_ev_timemode_type
79 #define snd_seq_ev_is_abstime		sndrv_seq_ev_is_abstime
80 #define snd_seq_ev_is_reltime		sndrv_seq_ev_is_reltime
81 #define snd_seq_queue_sync_port		sndrv_seq_queue_sync_port
82 #define snd_seq_queue_owner		sndrv_seq_queue_owner
83 
84 /* maximum number of events dequeued per schedule interval */
85 #define SNDRV_SEQ_MAX_DEQUEUE		50
86 
87 /* maximum number of queues */
88 #define SNDRV_SEQ_MAX_QUEUES		8
89 
90 /* max number of concurrent clients */
91 #define SNDRV_SEQ_MAX_CLIENTS 		192
92 
93 /* max number of concurrent ports */
94 #define SNDRV_SEQ_MAX_PORTS 		254
95 
96 /* max number of events in memory pool */
97 #define SNDRV_SEQ_MAX_EVENTS		2000
98 
99 /* default number of events in memory chunk */
100 #define SNDRV_SEQ_DEFAULT_CHUNK_EVENTS	64
101 
102 /* default number of events in memory pool */
103 #define SNDRV_SEQ_DEFAULT_EVENTS	500
104 
105 /* max number of events in memory pool for one client (outqueue) */
106 #define SNDRV_SEQ_MAX_CLIENT_EVENTS	2000
107 
108 /* default number of events in memory pool for one client (outqueue) */
109 #define SNDRV_SEQ_DEFAULT_CLIENT_EVENTS	200
110 
111 /* max delivery path length */
112 #define SNDRV_SEQ_MAX_HOPS		10
113 
114 /* max size of event size */
115 #define SNDRV_SEQ_MAX_EVENT_LEN		0x3fffffff
116 
117 /* typedefs */
118 struct _snd_seq_user_client;
119 struct _snd_seq_kernel_client;
120 struct _snd_seq_client;
121 struct _snd_seq_queue;
122 
123 typedef struct _snd_seq_user_client user_client_t;
124 typedef struct _snd_seq_kernel_client kernel_client_t;
125 typedef struct _snd_seq_client client_t;
126 typedef struct _snd_seq_queue queue_t;
127 
128 /* call-backs for kernel client */
129 
130 typedef struct {
131 	void *private_data;
132 	unsigned allow_input: 1,
133 		 allow_output: 1;
134 	/*...*/
135 } snd_seq_client_callback_t;
136 
137 /* call-backs for kernel port */
138 typedef int (snd_seq_kernel_port_open_t)(void *private_data, snd_seq_port_subscribe_t *info);
139 typedef int (snd_seq_kernel_port_close_t)(void *private_data, snd_seq_port_subscribe_t *info);
140 typedef int (snd_seq_kernel_port_input_t)(snd_seq_event_t *ev, int direct, void *private_data, int atomic, int hop);
141 typedef void (snd_seq_kernel_port_private_free_t)(void *private_data);
142 
143 typedef struct {
144 	struct module *owner;
145 	void *private_data;
146 	snd_seq_kernel_port_open_t *subscribe;
147 	snd_seq_kernel_port_close_t *unsubscribe;
148 	snd_seq_kernel_port_open_t *use;
149 	snd_seq_kernel_port_close_t *unuse;
150 	snd_seq_kernel_port_input_t *event_input;
151 	snd_seq_kernel_port_private_free_t *private_free;
152 	unsigned int callback_all;	/* call subscribe callbacks at each connection/disconnection */
153 	/*...*/
154 } snd_seq_port_callback_t;
155 
156 /* interface for kernel client */
157 extern int snd_seq_create_kernel_client(snd_card_t *card, int client_index, snd_seq_client_callback_t *callback);
158 extern int snd_seq_delete_kernel_client(int client);
159 extern int snd_seq_kernel_client_enqueue(int client, snd_seq_event_t *ev, int atomic, int hop);
160 extern int snd_seq_kernel_client_dispatch(int client, snd_seq_event_t *ev, int atomic, int hop);
161 extern int snd_seq_kernel_client_ctl(int client, unsigned int cmd, void *arg);
162 
163 #define SNDRV_SEQ_EXT_MASK	0xc0000000
164 #define SNDRV_SEQ_EXT_USRPTR	0x80000000
165 #define SNDRV_SEQ_EXT_CHAINED	0x40000000
166 
167 typedef int (*snd_seq_dump_func_t)(void *ptr, void *buf, int count);
168 int snd_seq_expand_var_event(const snd_seq_event_t *event, int count, char *buf, int in_kernel, int size_aligned);
169 int snd_seq_dump_var_event(const snd_seq_event_t *event, snd_seq_dump_func_t func, void *private_data);
170 
171 /* interface for OSS emulation */
172 int snd_seq_set_queue_tempo(int client, snd_seq_queue_tempo_t *tempo);
173 
174 /* port callback routines */
175 void snd_port_init_callback(snd_seq_port_callback_t *p);
176 snd_seq_port_callback_t *snd_port_alloc_callback(void);
177 
178 /* port attach/detach */
179 int snd_seq_event_port_attach(int client, snd_seq_port_callback_t *pcbp,
180 			      int cap, int type, int midi_channels, int midi_voices, char *portname);
181 int snd_seq_event_port_detach(int client, int port);
182 
183 #ifdef CONFIG_KMOD
184 void snd_seq_autoload_lock(void);
185 void snd_seq_autoload_unlock(void);
186 #else
187 #define snd_seq_autoload_lock()
188 #define snd_seq_autoload_unlock()
189 #endif
190 
191 #endif /* __SOUND_SEQ_KERNEL_H */
192