← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/oss4/oneiric-proposed

« back to all changes in this revision

Viewing changes to kernel/drv/oss_midiloop/oss_midiloop.man

  • Committer: Bazaar Package Importer
  • Author(s): Stefano Rivera
  • Date: 2011-06-16 20:37:48 UTC
  • mfrom: (5.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110616203748-jbrxik6ql33z54co
Tags: 4.2-build2004-1ubuntu1
https://launchpad.net/bugs/746048
https://launchpad.net/bugs/770972
* Merge from Debian unstable.
  - Supports our current kernel (LP: #746048)
  Remaining changes:
  - debian/oss4-dkms.dkms.in: s/source/build/ in Kernel headers paths.
* ld-as-needed.patch: Re-order CC arguments to enable building with ld
  --as-needed (LP: #770972)

Show diffs side-by-side

added added

removed removed

Lines of Context:
kernel/drv/oss_midiloop/oss_midiloop.man
 
1
NAME
 
2
oss_midiloop - Loopback MIDI driver.
 
3
 
 
4
DESCRIPTION
 
5
The loopback midi driver makes it possible to create special purpose
 
6
virtual midi devices based on user land server processes.
 
7
 
 
8
INTRODUCTION
 
9
MIDI loopback devices are like named pipes or pseudo terminals. They are 
 
10
grouped in client and server device pairs. The server side device must be open
 
11
before the client side device can be opened.
 
12
 
 
13
 SERVER SIDE DEVICE
 
14
The server side device is used by some special application (such as a
 
15
software based MIDI synthesizer) to receice MIDI events from the applications
 
16
that want to play MIDI.
 
17
 
 
18
 CLIENT SIDE DEVICE
 
19
Client applications such as MIDI players open the client side device when they
 
20
need to play some MIDI stream (file). The client side device behaves like any
 
21
"ordinary" MIDI device. However it cannot be opened when there is no program
 
22
connected to the server side.
 
23
 
 
24
COMPATIBILITY ISSUES
 
25
MIDI loopback devices differ from "normal" MIDI devices because an
 
26
application is needed at the both ends of the loop. The loop device
 
27
will return a "Connection reset by peer" error (ECONNRESET) error. Applications
 
28
designed to be used as loopback based server applications can/should use this
 
29
error (returned by read or write) as an end-of-stream indication.
 
30
 
 
31
OPTIONS
 
32
o midiloop_instances:  Specifies how many loopback client/server MIDI device
 
33
                        pairs to be created.
 
34
                                Values: 1-16     Default: 1
 
35
 
 
36
KNOWN PROBLEMS
 
37
None
 
38
 
 
39
FILES
 
40
CONFIGFILEPATH/oss_midiloop.conf Device configuration file
 
41
 
 
42
AUTHOR
 
43
4Front Technologies
 
44