share/man/man4/man4.i386/spkr.4

   1 .\"
   2 .\" $FreeBSD$
   3 .\"
   4 .Dd November 7, 1993
   5 .Dt SPKR 4 i386
   6 .Os FreeBSD
   7 .Sh NAME
   8 .Nm speaker ,
   9 .Nm spkr
  10 .Nd console speaker device driver
  11 .Sh SYNOPSIS
  12 .Cd pseudo-device speaker
  13 .Fd #include <machine/speaker.h>
  14 .Sh DESCRIPTION
  15 The speaker device driver allows applications to control the PC console
  16 speaker on an
  17 .Tn IBM-PC Ns --compatible
  18 machine running
  19 .Tn FreeBSD .
  20 .Pp
  21 Only one process may have this device open at any given time;
  22 .Xr open 2
  23 and
  24 .Xr close 2
  25 are used to lock and relinquish it.
  26 An attempt to open when
  27 another process has the device locked will return -1 with an
  28 .Er EBUSY
  29 error
  30 indication.
  31 Writes to the device are interpreted as `play strings' in a
  32 simple ASCII melody notation.
  33 An
  34 .Xr ioctl 2
  35 request
  36 for tone generation at arbitrary
  37 frequencies is also supported.
  38 .Pp
  39 Sound-generation does not monopolize the processor; in fact, the driver
  40 spends most of its time sleeping while the PC hardware is emitting
  41 tones.
  42 Other processes may emit beeps while the driver is running.
  43 .Pp
  44 Applications may call
  45 .Xr ioctl 2
  46 on a speaker file descriptor to control the
  47 speaker driver directly; definitions for the
  48 .Xr ioctl 2
  49 interface are in
  50 .Pa /usr/include/machine/speaker.h .
  51 The
  52 .Li tone_t
  53 structure used in these calls has two fields,
  54 specifying a frequency (in Hz) and a duration (in 1/100ths of a second).
  55 A frequency of zero is interpreted as a rest.
  56 .Pp
  57 At present there are two such
  58 .Xr ioctl 2
  59 calls.
  60 .Dv SPKRTONE
  61 accepts a pointer to a
  62 single tone structure as third argument and plays it.
  63 .Dv SPKRTUNE
  64 accepts a
  65 pointer to the first of an array of tone structures and plays them in
  66 continuous sequence; this array must be terminated by a final member with
  67 a zero duration.
  68 .Pp
  69 The play-string language is modelled on the PLAY statement conventions of
  70 .Tn IBM
  71 Advanced BASIC 2.0.  The
  72 .Li MB ,
  73 .Li MF ,
  74 and
  75 .Li X
  76 primitives of PLAY are not
  77 useful in a timesharing environment and are omitted.
  78 The `octave-tracking'
  79 feature and the slur mark are new.
  80 .Pp
  81 There are 84 accessible notes numbered 1-84 in 7 octaves, each running from
  82 C to B, numbered 0-6; the scale is equal-tempered A440 and octave 3 starts
  83 with middle C.  By default, the play function emits half-second notes with the
  84 last 1/16th second being `rest time'.
  85 .Pp
  86 Play strings are interpreted left to right as a series of play command groups;
  87 letter case is ignored.
  88 Play command groups are as follows:
  89 .Bl -tag -width CDEFGABxx
  90 .It Li CDEFGAB
  91 Letters A through G cause the corresponding note to be played in the
  92 current octave.  A note letter may optionally be followed by an
  93 .Dq Em "accidental sign" ,
  94 one of # + or -; the first two of these cause it to be sharped one
  95 half-tone, the last causes it to be flatted one half-tone.  It may
  96 also be followed by a time value number and by sustain dots (see
  97 below).  Time values are interpreted as for the L command below.
  98 .It Ns Li O Sy n
  99 If
 100 .Sy n
 101 is numeric, this sets the current octave.
 102 .Sy n
 103 may also be one of
 104 .Li L
 105 or
 106 .Li N
 107 to enable or disable octave-tracking (it is disabled by default).
 108 When octave-tracking is on, interpretation of a pair of letter notes
 109 will change octaves if necessary in order to make the smallest
 110 possible jump between notes.
 111 Thus ``olbc'' will be played as
 112 ``olb>c'', and ``olcb'' as ``olc<b''.  Octave locking is disabled for
 113 one letter note following >, < and O[0123456].  (The octave-locking
 114 feature is not supported in
 115 .Tn IBM
 116 BASIC.)
 117 .It Li >
 118 Bump the current octave up one.
 119 .It Li <
 120 Drop the current octave down one.
 121 .It Ns Li N Sy n
 122 Play note
 123 .Sy n ,
 124 .Sy n
 125 being 1 to 84 or 0 for a rest of current time value.
 126 May be followed by sustain dots.
 127 .It Ns Li L Sy n
 128 Sets the current time value for notes.  The default is
 129 .Li L4 ,
 130 quarter or crotchet notes.
 131 The lowest possible value is 1; values up
 132 to 64 are accepted.
 133 .Li L1
 134 sets whole notes,
 135 .Li L2
 136 sets half notes,
 137 .Li L4
 138 sets quarter notes, etc.
 139 .It Ns Li P Sy n
 140 Pause (rest), with
 141 .Sy n
 142 interpreted as for
 143 .Ns Li L Sy n .
 144 May be followed by
 145 sustain dots.  May also be written
 146 .Li ~ .
 147 .It Ns Li T Sy n
 148 Sets the number of quarter notes per minute; default is 120.  Musical
 149 names for common tempi are:
 150
 151 .Bd -literal -offset indent
 152                 Tempo           Beats Per Minute
 153 very slow       Larghissimo
 154                 Largo           40-60
 155                 Larghetto       60-66
 156                 Grave
 157                 Lento
 158                 Adagio          66-76
 159 slow            Adagietto
 160                 Andante         76-108
 161 medium          Andantino
 162                 Moderato        108-120
 163 fast            Allegretto
 164                 Allegro         120-168
 165                 Vivace
 166                 Veloce
 167                 Presto          168-208
 168 very fast       Prestissimo
 169 .Ed
 170 .It Li M[LNS]
 171 Set articulation.
 172 .Li MN
 173 .Ns No ( Li N
 174 for normal) is the default; the last 1/8th of
 175 the note's value is rest time.
 176 You can set
 177 .Li ML
 178 for legato (no rest space) or
 179 .Li MS
 180 for staccato (1/4 rest space).
 181 .El
 182 .Pp
 183 Notes (that is,
 184 .Li CDEFGAB
 185 or
 186 .Li N
 187 command character groups) may be followed by
 188 sustain dots.
 189 Each dot causes the note's value to be lengthened by one-half
 190 for each one.
 191 Thus, a note dotted once is held for 3/2 of its undotted value;
 192 dotted twice, it is held 9/4, and three times would give 27/8.
 193 .Pp
 194 A note and its sustain dots may also be followed by a slur mark (underscore).
 195 This causes the normal micro-rest after the note to be filled in, slurring it
 196 to the next one.  (The slur feature is not supported in
 197 .Tn IBM
 198 BASIC.)
 199 .Pp
 200 Whitespace in play strings is simply skipped and may be used to separate
 201 melody sections.
 202 .Sh BUGS
 203 Due to roundoff in the pitch tables and slop in the tone-generation and timer
 204 hardware (neither of which was designed for precision), neither pitch accuracy
 205 nor timings will be mathematically exact.
 206 There is no volume control.
 207 .Pp
 208 The action of two or more sustain dots does not reflect standard musical
 209 notation, in which each dot adds half the value of the previous dot
 210 modifier, not half the value of the note as modified.  Thus, a note dotted
 211 once is held for 3/2 of its undotted value; dotted twice, it is held 7/4,
 212 and three times would give 15/8.  The multiply-by-3/2 interpretation,
 213 however, is specified in the
 214 .Tn IBM
 215 BASIC manual and has been retained for
 216 compatibility.
 217 .Pp
 218 In play strings which are very long (longer than your system's physical I/O
 219 blocks) note suffixes or numbers may occasionally be parsed incorrectly due
 220 to crossing a block boundary.
 221 .Sh FILES
 222 .Bl -tag -width /dev/speakerxx
 223 .It Pa /dev/speaker
 224 speaker device file
 225 .El
 226 .Sh SEE ALSO
 227 .Xr spkrtest 8
 228 .Sh AUTHORS
 229 .An Eric S. Raymond Aq esr@snark.thyrsus.com
 230 June 1990
 231 .Sh "PORTED BY"
 232 .An Andrew A. Chernov Aq ache@astral.msk.su
 233 .Sh HISTORY
 234 The
 235 .Nm
 236 device appeared in
 237 .Fx 1.0 .