include/sound/rawmidi.h

   1 #ifndef __SOUND_RAWMIDI_H
   2 #define __SOUND_RAWMIDI_H
   3
   4 /*
   5  *  Abstract layer for MIDI v1.0 stream
   6  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
   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
  25 #include <sound/asound.h>
  26 #include <linux/interrupt.h>
  27 #include <linux/spinlock.h>
  28 #include <linux/wait.h>
  29 #include <linux/mutex.h>
  30
  31 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
  32 #include "seq_device.h"
  33 #endif
  34
  35 /*
  36  *  Raw MIDI interface
  37  */
  38
  39 #define SNDRV_RAWMIDI_DEVICES           8
  40
  41 #define SNDRV_RAWMIDI_LFLG_OUTPUT       (1<<0)
  42 #define SNDRV_RAWMIDI_LFLG_INPUT        (1<<1)
  43 #define SNDRV_RAWMIDI_LFLG_OPEN         (3<<0)
  44 #define SNDRV_RAWMIDI_LFLG_APPEND       (1<<2)
  45
  46 struct snd_rawmidi;
  47 struct snd_rawmidi_substream;
  48 struct snd_seq_port_info;
  49
  50 struct snd_rawmidi_ops {
  51         int (*open) (struct snd_rawmidi_substream * substream);
  52         int (*close) (struct snd_rawmidi_substream * substream);
  53         void (*trigger) (struct snd_rawmidi_substream * substream, int up);
  54         void (*drain) (struct snd_rawmidi_substream * substream);
  55 };
  56
  57 struct snd_rawmidi_global_ops {
  58         int (*dev_register) (struct snd_rawmidi * rmidi);
  59         int (*dev_unregister) (struct snd_rawmidi * rmidi);
  60         void (*get_port_info)(struct snd_rawmidi *rmidi, int number,
  61                               struct snd_seq_port_info *info);
  62 };
  63
  64 struct snd_rawmidi_runtime {
  65         unsigned int drain: 1,  /* drain stage */
  66                      oss: 1;    /* OSS compatible mode */
  67         /* midi stream buffer */
  68         unsigned char *buffer;  /* buffer for MIDI data */
  69         size_t buffer_size;     /* size of buffer */
  70         size_t appl_ptr;        /* application pointer */
  71         size_t hw_ptr;          /* hardware pointer */
  72         size_t avail_min;       /* min avail for wakeup */
  73         size_t avail;           /* max used buffer for wakeup */
  74         size_t xruns;           /* over/underruns counter */
  75         /* misc */
  76         spinlock_t lock;
  77         wait_queue_head_t sleep;
  78         /* event handler (new bytes, input only) */
  79         void (*event)(struct snd_rawmidi_substream *substream);
  80         /* defers calls to event [input] or ops->trigger [output] */
  81         struct tasklet_struct tasklet;
  82         /* private data */
  83         void *private_data;
  84         void (*private_free)(struct snd_rawmidi_substream *substream);
  85 };
  86
  87 struct snd_rawmidi_substream {
  88         struct list_head list;          /* list of all substream for given stream */
  89         int stream;                     /* direction */
  90         int number;                     /* substream number */
  91         unsigned int opened: 1,         /* open flag */
  92                      append: 1,         /* append flag (merge more streams) */
  93                      active_sensing: 1; /* send active sensing when close */
  94         int use_count;                  /* use counter (for output) */
  95         size_t bytes;
  96         struct snd_rawmidi *rmidi;
  97         struct snd_rawmidi_str *pstr;
  98         char name[32];
  99         struct snd_rawmidi_runtime *runtime;
 100         /* hardware layer */
 101         struct snd_rawmidi_ops *ops;
 102 };
 103
 104 struct snd_rawmidi_file {
 105         struct snd_rawmidi *rmidi;
 106         struct snd_rawmidi_substream *input;
 107         struct snd_rawmidi_substream *output;
 108 };
 109
 110 struct snd_rawmidi_str {
 111         unsigned int substream_count;
 112         unsigned int substream_opened;
 113         struct list_head substreams;
 114 };
 115
 116 struct snd_rawmidi {
 117         struct snd_card *card;
 118         struct list_head list;
 119         unsigned int device;            /* device number */
 120         unsigned int info_flags;        /* SNDRV_RAWMIDI_INFO_XXXX */
 121         char id[64];
 122         char name[80];
 123
 124 #ifdef CONFIG_SND_OSSEMUL
 125         int ossreg;
 126 #endif
 127
 128         struct snd_rawmidi_global_ops *ops;
 129
 130         struct snd_rawmidi_str streams[2];
 131
 132         void *private_data;
 133         void (*private_free) (struct snd_rawmidi *rmidi);
 134
 135         struct mutex open_mutex;
 136         wait_queue_head_t open_wait;
 137
 138         struct snd_info_entry *dev;
 139         struct snd_info_entry *proc_entry;
 140
 141 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
 142         struct snd_seq_device *seq_dev;
 143 #endif
 144 };
 145
 146 /* main rawmidi functions */
 147
 148 int snd_rawmidi_new(struct snd_card *card, char *id, int device,
 149                     int output_count, int input_count,
 150                     struct snd_rawmidi **rmidi);
 151 void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
 152                          struct snd_rawmidi_ops *ops);
 153
 154 /* callbacks */
 155
 156 void snd_rawmidi_receive_reset(struct snd_rawmidi_substream *substream);
 157 int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
 158                         const unsigned char *buffer, int count);
 159 void snd_rawmidi_transmit_reset(struct snd_rawmidi_substream *substream);
 160 int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream);
 161 int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
 162                               unsigned char *buffer, int count);
 163 int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count);
 164 int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
 165                          unsigned char *buffer, int count);
 166
 167 /* main midi functions */
 168
 169 int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info);
 170 int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice,
 171                             int mode, struct snd_rawmidi_file *rfile);
 172 int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile);
 173 int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
 174                               struct snd_rawmidi_params *params);
 175 int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
 176                              struct snd_rawmidi_params *params);
 177 int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream);
 178 int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream);
 179 int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream);
 180 long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
 181                              unsigned char *buf, long count);
 182 long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
 183                               const unsigned char *buf, long count);
 184
 185 #endif /* __SOUND_RAWMIDI_H */