1 /* sound.c -- sound support.
2 Copyright (C) 1998, 1999, 2001 Free Software Foundation.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Written by Gerd Moellmann <gerd@gnu.org>. Tested with Luigi's
22 driver on FreeBSD 2.2.7 with a SoundBlaster 16. */
26 #if defined HAVE_SOUND
30 #include <sys/types.h>
33 #include "dispextern.h"
36 #include "syssignal.h"
39 #include <sys/ioctl.h>
42 /* FreeBSD has machine/soundcard.h. Voxware sound driver docs mention
43 sys/soundcard.h. So, let's try whatever's there. */
45 #ifdef HAVE_MACHINE_SOUNDCARD_H
46 #include <machine/soundcard.h>
48 #ifdef HAVE_SYS_SOUNDCARD_H
49 #include <sys/soundcard.h>
51 #ifdef HAVE_SOUNDCARD_H
52 #include <soundcard.h>
55 #ifndef DEFAULT_SOUND_DEVICE
56 #define DEFAULT_SOUND_DEVICE "/dev/dsp"
59 #define abs(X) ((X) < 0 ? -(X) : (X))
61 /* Structure forward declarations. */
66 /* The file header of RIFF-WAVE files (*.wav). Files are always in
67 little-endian byte-order. */
74 u_int32_t chunk_format
;
75 u_int32_t chunk_length
;
78 u_int32_t sample_rate
;
79 u_int32_t bytes_per_second
;
80 u_int16_t sample_size
;
83 u_int32_t data_length
;
86 /* The file header of Sun adio files (*.au). Files are always in
87 big-endian byte-order. */
92 u_int32_t magic_number
;
94 /* Offset of data part from start of file. Minimum value is 24. */
95 u_int32_t data_offset
;
97 /* Size of data part, 0xffffffff if unknown. */
100 /* Data encoding format.
102 2 8-bit linear PCM (REF-PCM)
106 6 32-bit IEEE floating-point
107 7 64-bit IEEE floating-point
108 23 8-bit u-law compressed using CCITT 0.721 ADPCM voice data
112 /* Number of samples per second. */
113 u_int32_t sample_rate
;
115 /* Number of interleaved channels. */
119 /* Maximum of all sound file headers sizes. */
121 #define MAX_SOUND_HEADER_BYTES \
122 max (sizeof (struct wav_header), sizeof (struct au_header))
124 /* Interface structure for sound devices. */
128 /* The name of the device or null meaning use a default device name. */
131 /* File descriptor of the device. */
134 /* Device-dependent format. */
137 /* Volume (0..100). Zero means unspecified. */
146 /* Bytes per second. */
149 /* 1 = mono, 2 = stereo, 0 = don't set. */
152 /* Open device SD. */
153 void (* open
) P_ ((struct sound_device
*sd
));
155 /* Close device SD. */
156 void (* close
) P_ ((struct sound_device
*sd
));
158 /* Configure SD accoring to device-dependent parameters. */
159 void (* configure
) P_ ((struct sound_device
*device
));
161 /* Choose a device-dependent format for outputting sound S. */
162 void (* choose_format
) P_ ((struct sound_device
*sd
,
165 /* Write NYBTES bytes from BUFFER to device SD. */
166 void (* write
) P_ ((struct sound_device
*sd
, char *buffer
, int nbytes
));
168 /* A place for devices to store additional data. */
172 /* An enumerator for each supported sound file type. */
180 /* Interface structure for sound files. */
184 /* The type of the file. */
185 enum sound_type type
;
187 /* File descriptor of a sound file. */
190 /* Pointer to sound file header. This contains header_size bytes
191 read from the start of a sound file. */
194 /* Number of bytes raed from sound file. This is always <=
195 MAX_SOUND_HEADER_BYTES. */
198 /* Sound data, if a string. */
201 /* Play sound file S on device SD. */
202 void (* play
) P_ ((struct sound
*s
, struct sound_device
*sd
));
205 /* Indices of attributes in a sound attributes vector. */
218 extern Lisp_Object QCfile
, QCdata
;
219 Lisp_Object QCvolume
, QCdevice
;
221 Lisp_Object Qplay_sound_functions
;
223 /* These are set during `play-sound' so that sound_cleanup has
226 struct sound_device
*current_sound_device
;
227 struct sound
*current_sound
;
229 /* Function prototypes. */
231 static void vox_open
P_ ((struct sound_device
*));
232 static void vox_configure
P_ ((struct sound_device
*));
233 static void vox_close
P_ ((struct sound_device
*sd
));
234 static void vox_choose_format
P_ ((struct sound_device
*, struct sound
*));
235 static void vox_init
P_ ((struct sound_device
*));
236 static void vox_write
P_ ((struct sound_device
*, char *, int));
237 static void sound_perror
P_ ((char *));
238 static void sound_warning
P_ ((char *));
239 static int parse_sound
P_ ((Lisp_Object
, Lisp_Object
*));
240 static void find_sound_type
P_ ((struct sound
*));
241 static u_int32_t le2hl
P_ ((u_int32_t
));
242 static u_int16_t le2hs
P_ ((u_int16_t
));
243 static u_int32_t be2hl
P_ ((u_int32_t
));
244 static int wav_init
P_ ((struct sound
*));
245 static void wav_play
P_ ((struct sound
*, struct sound_device
*));
246 static int au_init
P_ ((struct sound
*));
247 static void au_play
P_ ((struct sound
*, struct sound_device
*));
249 #if 0 /* Currently not used. */
250 static u_int16_t be2hs
P_ ((u_int16_t
));
255 /***********************************************************************
257 ***********************************************************************/
259 /* Like perror, but signals an error. */
265 int saved_errno
= errno
;
269 sigunblock (sigmask (SIGIO
));
271 if (saved_errno
!= 0)
272 error ("%s: %s", msg
, strerror (saved_errno
));
278 /* Display a warning message. */
288 /* Parse sound specification SOUND, and fill ATTRS with what is
289 found. Value is non-zero if SOUND Is a valid sound specification.
290 A valid sound specification is a list starting with the symbol
291 `sound'. The rest of the list is a property list which may
292 contain the following key/value pairs:
296 FILE is the sound file to play. If it isn't an absolute name,
297 it's searched under `data-directory'.
301 DATA is a string containing sound data. Either :file or :data
302 may be present, but not both.
306 DEVICE is the name of the device to play on, e.g. "/dev/dsp2".
307 If not specified, a default device is used.
311 VOL must be an integer in the range [0, 100], or a float in the
315 parse_sound (sound
, attrs
)
319 /* SOUND must be a list starting with the symbol `sound'. */
320 if (!CONSP (sound
) || !EQ (XCAR (sound
), Qsound
))
323 sound
= XCDR (sound
);
324 attrs
[SOUND_FILE
] = Fplist_get (sound
, QCfile
);
325 attrs
[SOUND_DATA
] = Fplist_get (sound
, QCdata
);
326 attrs
[SOUND_DEVICE
] = Fplist_get (sound
, QCdevice
);
327 attrs
[SOUND_VOLUME
] = Fplist_get (sound
, QCvolume
);
329 /* File name or data must be specified. */
330 if (!STRINGP (attrs
[SOUND_FILE
])
331 && !STRINGP (attrs
[SOUND_DATA
]))
334 /* Volume must be in the range 0..100 or unspecified. */
335 if (!NILP (attrs
[SOUND_VOLUME
]))
337 if (INTEGERP (attrs
[SOUND_VOLUME
]))
339 if (XINT (attrs
[SOUND_VOLUME
]) < 0
340 || XINT (attrs
[SOUND_VOLUME
]) > 100)
343 else if (FLOATP (attrs
[SOUND_VOLUME
]))
345 if (XFLOAT_DATA (attrs
[SOUND_VOLUME
]) < 0
346 || XFLOAT_DATA (attrs
[SOUND_VOLUME
]) > 1)
353 /* Device must be a string or unspecified. */
354 if (!NILP (attrs
[SOUND_DEVICE
])
355 && !STRINGP (attrs
[SOUND_DEVICE
]))
362 /* Find out the type of the sound file whose file descriptor is FD.
363 S is the sound file structure to fill in. */
369 if (!wav_init (s
) && !au_init (s
))
370 error ("Unknown sound format");
374 /* Function installed by play-sound with record_unwind_protect. */
380 if (current_sound_device
)
382 if (current_sound_device
->close
)
383 current_sound_device
->close (current_sound_device
);
384 if (current_sound
->fd
> 0)
385 emacs_close (current_sound
->fd
);
392 DEFUN ("play-sound", Fplay_sound
, Splay_sound
, 1, 1, 0,
393 doc
: /* Play sound SOUND.
394 SOUND is a list of the form `(sound KEYWORD VALUE...)'.
395 The following keywords are recognized:
397 :file FILE - read sound data from FILE. If FILE isn't an
398 absolute file name, it is searched in `data-directory'.
400 :data DATA - read sound data from string DATA.
402 Exactly one of :file or :data must be present.
404 :volume VOL - set volume to VOL. VOL must an integer in the
405 range 0..100 or a float in the range 0..1.0. If not specified,
406 don't change the volume setting of the sound device.
408 :device DEVICE - play sound on DEVICE. If not specified,
409 a system-dependent default device name is used. */)
413 Lisp_Object attrs
[SOUND_ATTR_SENTINEL
];
415 struct gcpro gcpro1
, gcpro2
;
416 struct sound_device sd
;
419 int count
= specpdl_ptr
- specpdl
;
422 GCPRO2 (sound
, file
);
423 bzero (&sd
, sizeof sd
);
424 bzero (&s
, sizeof s
);
425 current_sound_device
= &sd
;
427 record_unwind_protect (sound_cleanup
, Qnil
);
428 s
.header
= (char *) alloca (MAX_SOUND_HEADER_BYTES
);
430 /* Parse the sound specification. Give up if it is invalid. */
431 if (!parse_sound (sound
, attrs
))
432 error ("Invalid sound specification");
434 if (STRINGP (attrs
[SOUND_FILE
]))
436 /* Open the sound file. */
437 s
.fd
= openp (Fcons (Vdata_directory
, Qnil
),
438 attrs
[SOUND_FILE
], Qnil
, &file
, 0);
440 sound_perror ("Could not open sound file");
442 /* Read the first bytes from the file. */
443 s
.header_size
= emacs_read (s
.fd
, s
.header
, MAX_SOUND_HEADER_BYTES
);
444 if (s
.header_size
< 0)
445 sound_perror ("Invalid sound file header");
449 s
.data
= attrs
[SOUND_DATA
];
450 s
.header_size
= min (MAX_SOUND_HEADER_BYTES
, STRING_BYTES (XSTRING (s
.data
)));
451 bcopy (XSTRING (s
.data
)->data
, s
.header
, s
.header_size
);
454 /* Find out the type of sound. Give up if we can't tell. */
455 find_sound_type (&s
);
457 /* Set up a device. */
458 if (STRINGP (attrs
[SOUND_DEVICE
]))
460 int len
= XSTRING (attrs
[SOUND_DEVICE
])->size
;
461 sd
.file
= (char *) alloca (len
+ 1);
462 strcpy (sd
.file
, XSTRING (attrs
[SOUND_DEVICE
])->data
);
465 if (INTEGERP (attrs
[SOUND_VOLUME
]))
466 sd
.volume
= XFASTINT (attrs
[SOUND_VOLUME
]);
467 else if (FLOATP (attrs
[SOUND_VOLUME
]))
468 sd
.volume
= XFLOAT_DATA (attrs
[SOUND_VOLUME
]) * 100;
470 args
[0] = Qplay_sound_functions
;
472 Frun_hook_with_args (2, args
);
474 /* There is only one type of device we currently support, the VOX
475 sound driver. Set up the device interface functions for that
479 /* Open the device. */
482 /* Play the sound. */
485 /* Close the input file, if any. */
486 if (!STRINGP (s
.data
))
492 /* Close the device. */
496 current_sound_device
= NULL
;
497 current_sound
= NULL
;
499 unbind_to (count
, Qnil
);
504 /***********************************************************************
505 Byte-order Conversion
506 ***********************************************************************/
508 /* Convert 32-bit value VALUE which is in little-endian byte-order
509 to host byte-order. */
515 #ifdef WORDS_BIG_ENDIAN
516 unsigned char *p
= (unsigned char *) &value
;
517 value
= p
[0] + (p
[1] << 8) + (p
[2] << 16) + (p
[3] << 24);
523 /* Convert 16-bit value VALUE which is in little-endian byte-order
524 to host byte-order. */
530 #ifdef WORDS_BIG_ENDIAN
531 unsigned char *p
= (unsigned char *) &value
;
532 value
= p
[0] + (p
[1] << 8);
538 /* Convert 32-bit value VALUE which is in big-endian byte-order
539 to host byte-order. */
545 #ifndef WORDS_BIG_ENDIAN
546 unsigned char *p
= (unsigned char *) &value
;
547 value
= p
[3] + (p
[2] << 8) + (p
[1] << 16) + (p
[0] << 24);
553 #if 0 /* Currently not used. */
555 /* Convert 16-bit value VALUE which is in big-endian byte-order
556 to host byte-order. */
562 #ifndef WORDS_BIG_ENDIAN
563 unsigned char *p
= (unsigned char *) &value
;
564 value
= p
[1] + (p
[0] << 8);
572 /***********************************************************************
574 ***********************************************************************/
576 /* Try to initialize sound file S from S->header. S->header
577 contains the first MAX_SOUND_HEADER_BYTES number of bytes from the
578 sound file. If the file is a WAV-format file, set up interface
579 functions in S and convert header fields to host byte-order.
580 Value is non-zero if the file is a WAV file. */
586 struct wav_header
*header
= (struct wav_header
*) s
->header
;
588 if (s
->header_size
< sizeof *header
589 || bcmp (s
->header
, "RIFF", 4) != 0)
592 /* WAV files are in little-endian order. Convert the header
593 if on a big-endian machine. */
594 header
->magic
= le2hl (header
->magic
);
595 header
->length
= le2hl (header
->length
);
596 header
->chunk_type
= le2hl (header
->chunk_type
);
597 header
->chunk_format
= le2hl (header
->chunk_format
);
598 header
->chunk_length
= le2hl (header
->chunk_length
);
599 header
->format
= le2hs (header
->format
);
600 header
->channels
= le2hs (header
->channels
);
601 header
->sample_rate
= le2hl (header
->sample_rate
);
602 header
->bytes_per_second
= le2hl (header
->bytes_per_second
);
603 header
->sample_size
= le2hs (header
->sample_size
);
604 header
->precision
= le2hs (header
->precision
);
605 header
->chunk_data
= le2hl (header
->chunk_data
);
606 header
->data_length
= le2hl (header
->data_length
);
608 /* Set up the interface functions for WAV. */
616 /* Play RIFF-WAVE audio file S on sound device SD. */
621 struct sound_device
*sd
;
623 struct wav_header
*header
= (struct wav_header
*) s
->header
;
625 /* Let the device choose a suitable device-dependent format
627 sd
->choose_format (sd
, s
);
629 /* Configure the device. */
630 sd
->sample_size
= header
->sample_size
;
631 sd
->sample_rate
= header
->sample_rate
;
632 sd
->bps
= header
->bytes_per_second
;
633 sd
->channels
= header
->channels
;
636 /* Copy sound data to the device. The WAV file specification is
637 actually more complex. This simple scheme worked with all WAV
638 files I found so far. If someone feels inclined to implement the
639 whole RIFF-WAVE spec, please do. */
640 if (STRINGP (s
->data
))
641 sd
->write (sd
, XSTRING (s
->data
)->data
+ sizeof *header
,
642 STRING_BYTES (XSTRING (s
->data
)) - sizeof *header
);
649 buffer
= (char *) alloca (blksize
);
650 lseek (s
->fd
, sizeof *header
, SEEK_SET
);
652 while ((nbytes
= emacs_read (s
->fd
, buffer
, blksize
)) > 0)
653 sd
->write (sd
, buffer
, nbytes
);
656 sound_perror ("Error reading sound file");
662 /***********************************************************************
664 ***********************************************************************/
666 /* Sun audio file encodings. */
670 AU_ENCODING_ULAW_8
= 1,
681 /* Try to initialize sound file S from S->header. S->header
682 contains the first MAX_SOUND_HEADER_BYTES number of bytes from the
683 sound file. If the file is a AU-format file, set up interface
684 functions in S and convert header fields to host byte-order.
685 Value is non-zero if the file is an AU file. */
691 struct au_header
*header
= (struct au_header
*) s
->header
;
693 if (s
->header_size
< sizeof *header
694 || bcmp (s
->header
, ".snd", 4) != 0)
697 header
->magic_number
= be2hl (header
->magic_number
);
698 header
->data_offset
= be2hl (header
->data_offset
);
699 header
->data_size
= be2hl (header
->data_size
);
700 header
->encoding
= be2hl (header
->encoding
);
701 header
->sample_rate
= be2hl (header
->sample_rate
);
702 header
->channels
= be2hl (header
->channels
);
704 /* Set up the interface functions for AU. */
712 /* Play Sun audio file S on sound device SD. */
717 struct sound_device
*sd
;
719 struct au_header
*header
= (struct au_header
*) s
->header
;
722 sd
->sample_rate
= header
->sample_rate
;
724 sd
->channels
= header
->channels
;
725 sd
->choose_format (sd
, s
);
728 if (STRINGP (s
->data
))
729 sd
->write (sd
, XSTRING (s
->data
)->data
+ header
->data_offset
,
730 STRING_BYTES (XSTRING (s
->data
)) - header
->data_offset
);
738 lseek (s
->fd
, header
->data_offset
, SEEK_SET
);
740 /* Copy sound data to the device. */
741 buffer
= (char *) alloca (blksize
);
742 while ((nbytes
= emacs_read (s
->fd
, buffer
, blksize
)) > 0)
743 sd
->write (sd
, buffer
, nbytes
);
746 sound_perror ("Error reading sound file");
752 /***********************************************************************
753 Voxware Driver Interface
754 ***********************************************************************/
756 /* This driver is available on GNU/Linux, and the free BSDs. FreeBSD
757 has a compatible own driver aka Luigi's driver. */
760 /* Open device SD. If SD->file is non-null, open that device,
761 otherwise use a default device name. */
765 struct sound_device
*sd
;
769 /* Open the sound device. Default is /dev/dsp. */
773 file
= DEFAULT_SOUND_DEVICE
;
775 sd
->fd
= emacs_open (file
, O_WRONLY
, 0);
781 /* Configure device SD from parameters in it. */
785 struct sound_device
*sd
;
789 xassert (sd
->fd
>= 0);
791 /* On GNU/Linux, it seems that the device driver doesn't like to be
792 interrupted by a signal. Block the ones we know to cause
796 sigblock (sigmask (SIGIO
));
800 if (ioctl (sd
->fd
, SNDCTL_DSP_SETFMT
, &sd
->format
) < 0
801 || val
!= sd
->format
)
802 sound_perror ("Could not set sound format");
804 val
= sd
->channels
!= 1;
805 if (ioctl (sd
->fd
, SNDCTL_DSP_STEREO
, &val
) < 0
806 || val
!= (sd
->channels
!= 1))
807 sound_perror ("Could not set stereo/mono");
809 /* I think bps and sampling_rate are the same, but who knows.
810 Check this. and use SND_DSP_SPEED for both. */
811 if (sd
->sample_rate
> 0)
813 val
= sd
->sample_rate
;
814 if (ioctl (sd
->fd
, SNDCTL_DSP_SPEED
, &sd
->sample_rate
) < 0)
815 sound_perror ("Could not set sound speed");
816 else if (val
!= sd
->sample_rate
)
817 sound_warning ("Could not set sample rate");
822 int volume
= sd
->volume
& 0xff;
823 volume
|= volume
<< 8;
824 /* This may fail if there is no mixer. Ignore the failure. */
825 ioctl (sd
->fd
, SOUND_MIXER_WRITE_PCM
, &volume
);
830 sigunblock (sigmask (SIGIO
));
835 /* Close device SD if it is open. */
839 struct sound_device
*sd
;
843 /* On GNU/Linux, it seems that the device driver doesn't like to
844 be interrupted by a signal. Block the ones we know to cause
847 sigblock (sigmask (SIGIO
));
851 /* Flush sound data, and reset the device. */
852 ioctl (sd
->fd
, SNDCTL_DSP_SYNC
, NULL
);
856 sigunblock (sigmask (SIGIO
));
859 /* Close the device. */
860 emacs_close (sd
->fd
);
866 /* Choose device-dependent format for device SD from sound file S. */
869 vox_choose_format (sd
, s
)
870 struct sound_device
*sd
;
875 struct wav_header
*h
= (struct wav_header
*) s
->header
;
876 if (h
->precision
== 8)
877 sd
->format
= AFMT_U8
;
878 else if (h
->precision
== 16)
879 sd
->format
= AFMT_S16_LE
;
881 error ("Unsupported WAV file format");
883 else if (s
->type
== SUN_AUDIO
)
885 struct au_header
*header
= (struct au_header
*) s
->header
;
886 switch (header
->encoding
)
888 case AU_ENCODING_ULAW_8
:
889 case AU_ENCODING_IEEE32
:
890 case AU_ENCODING_IEEE64
:
891 sd
->format
= AFMT_MU_LAW
;
898 sd
->format
= AFMT_S16_LE
;
902 error ("Unsupported AU file format");
910 /* Initialize device SD. Set up the interface functions in the device
915 struct sound_device
*sd
;
919 sd
->close
= vox_close
;
920 sd
->configure
= vox_configure
;
921 sd
->choose_format
= vox_choose_format
;
922 sd
->write
= vox_write
;
926 /* Write NBYTES bytes from BUFFER to device SD. */
929 vox_write (sd
, buffer
, nbytes
)
930 struct sound_device
*sd
;
934 int nwritten
= emacs_write (sd
->fd
, buffer
, nbytes
);
936 sound_perror ("Error writing to sound device");
941 /***********************************************************************
943 ***********************************************************************/
948 QCdevice
= intern (":device");
949 staticpro (&QCdevice
);
950 QCvolume
= intern (":volume");
951 staticpro (&QCvolume
);
952 Qsound
= intern ("sound");
954 Qplay_sound_functions
= intern ("play-sound-functions");
955 staticpro (&Qplay_sound_functions
);
957 defsubr (&Splay_sound
);
966 #endif /* HAVE_SOUND */