asequencer.h

unxi下共享内存的使用

/*
 *  Main header file for the ALSA sequencer
 *  Copyright (c) 1998-1999 by Frank van de Pol <[e-mail]>
 *            (c) 1998-1999 by Jaroslav Kysela <[e-mail]>
 *
 *
 *   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., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */
#ifndef __SND_ASEQUENCER_H
#define __SND_ASEQUENCER_H

#ifndef __KERNEL__
#include <linux/ioctl.h>
#include <sys/ipc.h>
#endif

/* version of the sequencer */
#define SND_SEQ_VERSION SND_PROTOCOL_VERSION (1, 0, 0)

/*
 * sequencer event record
 */
typedef struct snd_seq_event snd_seq_event_t;

/*                                   	*/
/* definition of sequencer event types 	*/
/*                                   	*/

/* 0-4: system messages
 * event data type = snd_seq_result_t
 */
#define SND_SEQ_EVENT_SYSTEM		0
#define SND_SEQ_EVENT_RESULT		1
/* 2-4: reserved */

/* 5-9: note messages (channel specific)
 * event data type = snd_seq_ev_note
 */
#define SND_SEQ_EVENT_NOTE		5
#define SND_SEQ_EVENT_NOTEON		6
#define SND_SEQ_EVENT_NOTEOFF		7
#define SND_SEQ_EVENT_KEYPRESS		8
/* 9-10: reserved */
	
/* 10-19: control messages (channel specific)
 * event data type = snd_seq_ev_ctrl
 */
#define SND_SEQ_EVENT_CONTROLLER	10
#define SND_SEQ_EVENT_PGMCHANGE		11
#define SND_SEQ_EVENT_CHANPRESS		12
#define SND_SEQ_EVENT_PITCHBEND		13	/* from -8192 to 8191 */
#define SND_SEQ_EVENT_CONTROL14		14	/* 14 bit controller value */
#define SND_SEQ_EVENT_NONREGPARAM	15	/* 14 bit NRPN */
#define SND_SEQ_EVENT_REGPARAM		16	/* 14 bit RPN */
/* 18-19: reserved */

/* 20-29: synchronisation messages
 * event data type = snd_seq_ev_ctrl
 */
#define SND_SEQ_EVENT_SONGPOS		20	/* Song Position Pointer with LSB and MSB values */
#define SND_SEQ_EVENT_SONGSEL		21	/* Song Select with song ID number */
#define SND_SEQ_EVENT_QFRAME		22	/* midi time code quarter frame */
#define SND_SEQ_EVENT_TIMESIGN		23	/* SMF Time Signature event */
#define SND_SEQ_EVENT_KEYSIGN		24	/* SMF Key Signature event */
/* 25-29: reserved */
	        
/* 30-39: timer messages
 * event data type = snd_seq_ev_queue_control_t
 */
#define SND_SEQ_EVENT_START		30	/* midi Real Time Start message */
#define SND_SEQ_EVENT_CONTINUE		31	/* midi Real Time Continue message */
#define SND_SEQ_EVENT_STOP		32	/* midi Real Time Stop message */	
#define	SND_SEQ_EVENT_SETPOS_TICK	33	/* set tick queue position */
#define SND_SEQ_EVENT_SETPOS_TIME	34	/* set realtime queue position */
#define SND_SEQ_EVENT_TEMPO		35	/* (SMF) Tempo event */
#define SND_SEQ_EVENT_CLOCK		36	/* midi Real Time Clock message */
#define SND_SEQ_EVENT_TICK		37	/* midi Real Time Tick message */
/* 38-39: reserved */

/* 40-49: others
 * event data type = none
 */
#define SND_SEQ_EVENT_TUNE_REQUEST	40	/* tune request */
#define SND_SEQ_EVENT_RESET		41	/* reset to power-on state */
#define SND_SEQ_EVENT_SENSING		42	/* "active sensing" event */
/* 43-49: reserved */

/* 50-59: echo back, kernel private messages
 * event data type = any type
 */
#define SND_SEQ_EVENT_ECHO		50	/* echo event */
#define SND_SEQ_EVENT_OSS		51	/* OSS raw event */
/* 52-59: reserved */

/* 60-69: system status messages (broadcast for subscribers)
 * event data type = snd_seq_addr_t
 */
#define SND_SEQ_EVENT_CLIENT_START	60	/* new client has connected */
#define SND_SEQ_EVENT_CLIENT_EXIT	61	/* client has left the system */
#define SND_SEQ_EVENT_CLIENT_CHANGE	62	/* client status/info has changed */
#define SND_SEQ_EVENT_PORT_START	63	/* new port was created */
#define SND_SEQ_EVENT_PORT_EXIT		64	/* port was deleted from system */
#define SND_SEQ_EVENT_PORT_CHANGE	65	/* port status/info has changed */
#define SND_SEQ_EVENT_PORT_SUBSCRIBED	66	/* read port is subscribed */
#define SND_SEQ_EVENT_PORT_USED		67	/* write port is subscribed */
#define SND_SEQ_EVENT_PORT_UNSUBSCRIBED	68	/* read port is released */
#define SND_SEQ_EVENT_PORT_UNUSED	69	/* write port is released */

/* 70-79: synthesizer events
 * event data type = snd_seq_eve_sample_control_t
 */
#define SND_SEQ_EVENT_SAMPLE		70	/* sample select */
#define SND_SEQ_EVENT_SAMPLE_CLUSTER	71	/* sample cluster select */
#define SND_SEQ_EVENT_SAMPLE_START	72	/* voice start */
#define SND_SEQ_EVENT_SAMPLE_STOP	73	/* voice stop */
#define SND_SEQ_EVENT_SAMPLE_FREQ	74	/* playback frequency */
#define SND_SEQ_EVENT_SAMPLE_VOLUME	75	/* volume and balance */
#define SND_SEQ_EVENT_SAMPLE_LOOP	76	/* sample loop */
#define SND_SEQ_EVENT_SAMPLE_POSITION	77	/* sample position */
#define SND_SEQ_EVENT_SAMPLE_PRIVATE1	78	/* private (hardware dependent) event */

/* 80-89: reserved */

/* 90-99: user-defined events with fixed length
 * event data type = any
 */
#define SND_SEQ_EVENT_USR0		90
#define SND_SEQ_EVENT_USR1		91
#define SND_SEQ_EVENT_USR2		92
#define SND_SEQ_EVENT_USR3		93
#define SND_SEQ_EVENT_USR4		94
#define SND_SEQ_EVENT_USR5		95
#define SND_SEQ_EVENT_USR6		96
#define SND_SEQ_EVENT_USR7		97
#define SND_SEQ_EVENT_USR8		98
#define SND_SEQ_EVENT_USR9		99

/* 100-129: instrument layer
 * variable length data can be passed directly to the driver
 */
#define SND_SEQ_EVENT_INSTR_BEGIN	100	/* begin of instrument management */
#define SND_SEQ_EVENT_INSTR_END		101	/* end of instrument management */
#define SND_SEQ_EVENT_INSTR_INFO	102	/* instrument interface info */
#define SND_SEQ_EVENT_INSTR_INFO_RESULT 103	/* result */
#define SND_SEQ_EVENT_INSTR_FINFO	104	/* get format info */
#define SND_SEQ_EVENT_INSTR_FINFO_RESULT 105	/* get format info */
#define SND_SEQ_EVENT_INSTR_RESET	106	/* reset instrument memory */
#define SND_SEQ_EVENT_INSTR_STATUS	107	/* instrument interface status */
#define SND_SEQ_EVENT_INSTR_STATUS_RESULT 108	/* result */
#define SND_SEQ_EVENT_INSTR_PUT		109	/* put instrument to port */
#define SND_SEQ_EVENT_INSTR_GET		110	/* get instrument from port */
#define SND_SEQ_EVENT_INSTR_GET_RESULT	111	/* result */
#define SND_SEQ_EVENT_INSTR_FREE	112	/* free instrument(s) */
#define SND_SEQ_EVENT_INSTR_LIST	113	/* instrument list */
#define SND_SEQ_EVENT_INSTR_LIST_RESULT 114	/* result */
#define SND_SEQ_EVENT_INSTR_CLUSTER	115	/* cluster parameters */
#define SND_SEQ_EVENT_INSTR_CLUSTER_GET	116	/* get cluster parameters */
#define SND_SEQ_EVENT_INSTR_CLUSTER_RESULT 117	/* result */
#define SND_SEQ_EVENT_INSTR_CHANGE	118	/* instrument change */
/* 119-129: reserved */

/* 130-139: variable length events
 * event data type = snd_seq_ev_ext
 * (SND_SEQ_EVENT_LENGTH_VARIABLE must be set)
 */
#define SND_SEQ_EVENT_SYSEX		130	/* system exclusive data (variable length) */
#define SND_SEQ_EVENT_BOUNCE		131	/* error event */
/* 132-134: reserved */
#define SND_SEQ_EVENT_USR_VAR0		135
#define SND_SEQ_EVENT_USR_VAR1		136
#define SND_SEQ_EVENT_USR_VAR2		137
#define SND_SEQ_EVENT_USR_VAR3		138
#define SND_SEQ_EVENT_USR_VAR4		139

/* 140-149: IPC shared memory events (*NOT SUPPORTED YET*)
 * event data type = snd_seq_ev_ipcshm
 * (SND_SEQ_EVENT_LENGTH_VARIPC must be set)
 */
#define SND_SEQ_EVENT_IPCSHM		140
/* 141-144: reserved */
#define SND_SEQ_EVENT_USR_VARIPC0	145
#define SND_SEQ_EVENT_USR_VARIPC1	146
#define SND_SEQ_EVENT_USR_VARIPC2	147
#define SND_SEQ_EVENT_USR_VARIPC3	148
#define SND_SEQ_EVENT_USR_VARIPC4	149

/* 150-151: kernel events with quote - DO NOT use in user clients */
#define SND_SEQ_EVENT_KERNEL_ERROR	150
#define SND_SEQ_EVENT_KERNEL_QUOTE	151

/* 152-191: reserved */

/* 192-254: hardware specific events */

/* 255: special event */
#define SND_SEQ_EVENT_NONE		255


typedef unsigned char snd_seq_event_type;

	/* event address */
typedef struct {
	unsigned char client;	/* Client number:         0..255, 255 = broadcast to all clients */
	unsigned char port;	/* Port within client:    0..255, 255 = broadcast to all ports */
} snd_seq_addr_t;

#define SND_SEQ_ADDRESS_UNKNOWN		253	/* unknown source */
#define SND_SEQ_ADDRESS_SUBSCRIBERS	254	/* send event to all subscribed ports */
#define SND_SEQ_ADDRESS_BROADCAST	255	/* send event to all queues/clients/ports/channels */
#define SND_SEQ_QUEUE_DIRECT		253	/* direct dispatch */

	/* event mode flag - NOTE: only 8 bits available! */
#define SND_SEQ_TIME_STAMP_TICK		(0<<0) /* timestamp in clock ticks */
#define SND_SEQ_TIME_STAMP_REAL		(1<<0) /* timestamp in real time */
#define SND_SEQ_TIME_STAMP_MASK		(1<<0)

#define SND_SEQ_TIME_MODE_ABS		(0<<1)	/* absolute timestamp */
#define SND_SEQ_TIME_MODE_REL		(1<<1)	/* relative to current time */
#define SND_SEQ_TIME_MODE_MASK		(1<<1)

#define SND_SEQ_EVENT_LENGTH_FIXED	(0<<2)	/* fixed event size */
#define SND_SEQ_EVENT_LENGTH_VARIABLE	(1<<2)	/* variable event size */
#define SND_SEQ_EVENT_LENGTH_VARUSR	(2<<2)	/* variable event size - user memory space */
#define SND_SEQ_EVENT_LENGTH_VARIPC	(3<<2)	/* variable event size - IPC */
#define SND_SEQ_EVENT_LENGTH_MASK	(3<<2)

#define SND_SEQ_PRIORITY_NORMAL		(0<<4)	/* normal priority */
#define SND_SEQ_PRIORITY_HIGH		(1<<4)	/* event should be processed before others */
#define SND_SEQ_PRIORITY_MASK		(1<<4)


	/* note event */
typedef struct {
	unsigned char channel;
	unsigned char note;
	unsigned char velocity;
	unsigned char off_velocity;	/* only for SND_SEQ_EVENT_NOTE */
	unsigned int duration;		/* only for SND_SEQ_EVENT_NOTE */
} snd_seq_ev_note;

	/* controller event */
typedef struct {
	unsigned char channel;
	unsigned char unused1, unused2, unused3;	/* pad */
	unsigned int param;
	signed int value;
} snd_seq_ev_ctrl;

	/* generic set of bytes (12x8 bit) */
typedef struct {
	unsigned char d[12];	/* 8 bit value */
} snd_seq_ev_raw8;

	/* generic set of integers (3x32 bit) */
typedef struct {
	unsigned int d[3];	/* 32 bit value */
} snd_seq_ev_raw32;

	/* external stored data */
typedef struct {
	int len;		/* length of data */
	void *ptr;		/* pointer to data (note: maybe 64-bit) */
} snd_seq_ev_ext;

	/* external stored data - IPC shared memory */
typedef struct {
	int len;		/* length of data */
	key_t ipc;		/* IPC key */
} snd_seq_ev_ipcshm;

/* Instrument cluster type */
typedef unsigned long snd_seq_instr_cluster_t;

/* Instrument type */
typedef struct {
	snd_seq_instr_cluster_t cluster;
	unsigned int std;		/* the upper byte means a private instrument (owner - client #) */
	unsigned short bank;
	unsigned short prg;
} snd_seq_instr_t;

	/* sample number */
typedef struct {
	unsigned int std;
	unsigned short bank;
	unsigned short prg;
} snd_seq_ev_sample;

	/* sample cluster */
typedef struct {
	snd_seq_instr_cluster_t cluster;
} snd_seq_ev_cluster;

	/* sample position */
typedef unsigned int snd_seq_position_t; /* playback position (in samples) * 16 */

	/* sample stop mode */
typedef enum {
	SAMPLE_STOP_IMMEDIATELY = 0,	/* terminate playing immediately */
	SAMPLE_STOP_VENVELOPE = 1,	/* finish volume envelope */
	SAMPLE_STOP_LOOP = 2		/* terminate loop and finish wave */
} snd_seq_stop_mode_t;

	/* sample frequency */
typedef int snd_seq_frequency_t; /* playback frequency in HZ * 16 */

	/* sample volume control; if any value is set to -1 == do not change */
typedef struct {
	signed short volume;	/* range: 0-16383 */
	signed short lr;	/* left-right balance; range: 0-16383 */
	signed short fr;	/* front-rear balance; range: 0-16383 */
	signed short du;	/* down-up balance; range: 0-16383 */
} snd_seq_ev_volume;