1 /* sound.c -- sound support.
2 Copyright (C) 1998, 1999 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
31 #include <sys/types.h>
32 #include <dispextern.h>
36 /* FreeBSD has machine/soundcard.h. Voxware sound driver docs mention
37 sys/soundcard.h. So, let's try whatever's there. */
39 #ifdef HAVE_MACHINE_SOUNDCARD_H
40 #include <machine/soundcard.h>
42 #ifdef HAVE_SYS_SOUNDCARD_H
43 #include <sys/soundcard.h>
45 #ifdef HAVE_SOUNDCARD_H
46 #include <sys/ioctl.h>
47 #include <soundcard.h>
50 #ifndef DEFAULT_SOUND_DEVICE
51 #define DEFAULT_SOUND_DEVICE "/dev/dsp"
54 #define max(X, Y) ((X) > (Y) ? (X) : (Y))
55 #define min(X, Y) ((X) < (Y) ? (X) : (Y))
56 #define abs(X) ((X) < 0 ? -(X) : (X))
58 /* Structure forward declarations. */
63 /* The file header of RIFF-WAVE files (*.wav). Files are always in
64 little-endian byte-order. */
71 u_int32_t chunk_format
;
72 u_int32_t chunk_length
;
75 u_int32_t sample_rate
;
76 u_int32_t bytes_per_second
;
77 u_int16_t sample_size
;
80 u_int32_t data_length
;
83 /* The file header of Sun adio files (*.au). Files are always in
84 big-endian byte-order. */
89 u_int32_t magic_number
;
91 /* Offset of data part from start of file. Minimum value is 24. */
92 u_int32_t data_offset
;
94 /* Size of data part, 0xffffffff if unknown. */
97 /* Data encoding format.
99 2 8-bit linear PCM (REF-PCM)
103 6 32-bit IEEE floating-point
104 7 64-bit IEEE floating-point
105 23 8-bit u-law compressed using CCITT 0.721 ADPCM voice data
109 /* Number of samples per second. */
110 u_int32_t sample_rate
;
112 /* Number of interleaved channels. */
116 /* Maximum of all sound file headers sizes. */
118 #define MAX_SOUND_HEADER_BYTES \
119 max (sizeof (struct wav_header), sizeof (struct au_header))
121 /* Interface structure for sound devices. */
125 /* The name of the device or null meaning use a default device name. */
128 /* File descriptor of the device. */
131 /* Device-dependent format. */
134 /* Volume (0..100). Zero means unspecified. */
143 /* Bytes per second. */
146 /* 1 = mono, 2 = stereo, 0 = don't set. */
149 /* Open device SD. */
150 void (* open
) P_ ((struct sound_device
*sd
));
152 /* Close device SD. */
153 void (* close
) P_ ((struct sound_device
*sd
));
155 /* Configure SD accoring to device-dependent parameters. */
156 void (* configure
) P_ ((struct sound_device
*device
));
158 /* Choose a device-dependent format for outputting sound S. */
159 void (* choose_format
) P_ ((struct sound_device
*sd
,
162 /* Write NYBTES bytes from BUFFER to device SD. */
163 void (* write
) P_ ((struct sound_device
*sd
, char *buffer
, int nbytes
));
165 /* A place for devices to store additional data. */
169 /* An enumerator for each supported sound file type. */
177 /* Interface structure for sound files. */
181 /* The type of the file. */
182 enum sound_type type
;
184 /* File descriptor of a sound file. */
187 /* Pointer to sound file header. This contains header_size bytes
188 read from the start of a sound file. */
191 /* Number of bytes raed from sound file. This is always <=
192 MAX_SOUND_HEADER_BYTES. */
195 /* Sound data, if a string. */
198 /* Play sound file S on device SD. */
199 void (* play
) P_ ((struct sound
*s
, struct sound_device
*sd
));
202 /* Indices of attributes in a sound attributes vector. */
215 extern Lisp_Object QCfile
, QCdata
;
216 Lisp_Object QCvolume
, QCdevice
;
218 Lisp_Object Qplay_sound_functions
;
220 /* These are set during `play-sound' so that sound_cleanup has
223 struct sound_device
*current_sound_device
;
224 struct sound
*current_sound
;
226 /* Function prototypes. */
228 static void vox_open
P_ ((struct sound_device
*));
229 static void vox_configure
P_ ((struct sound_device
*));
230 static void vox_close
P_ ((struct sound_device
*sd
));
231 static void vox_choose_format
P_ ((struct sound_device
*, struct sound
*));
232 static void vox_init
P_ ((struct sound_device
*));
233 static void vox_write
P_ ((struct sound_device
*, char *, int));
234 static void sound_perror
P_ ((char *));
235 static int parse_sound
P_ ((Lisp_Object
, Lisp_Object
*));
236 static void find_sound_type
P_ ((struct sound
*));
237 static u_int32_t le2hl
P_ ((u_int32_t
));
238 static u_int16_t le2hs
P_ ((u_int16_t
));
239 static u_int32_t be2hl
P_ ((u_int32_t
));
240 static int wav_init
P_ ((struct sound
*));
241 static void wav_play
P_ ((struct sound
*, struct sound_device
*));
242 static int au_init
P_ ((struct sound
*));
243 static void au_play
P_ ((struct sound
*, struct sound_device
*));
245 #if 0 /* Currently not used. */
246 static u_int16_t be2hs
P_ ((u_int16_t
));
251 /***********************************************************************
253 ***********************************************************************/
255 /* Like perror, but signals an error. */
261 error ("%s: %s", msg
, strerror (errno
));
265 /* Parse sound specification SOUND, and fill ATTRS with what is
266 found. Value is non-zero if SOUND Is a valid sound specification.
267 A valid sound specification is a list starting with the symbol
268 `sound'. The rest of the list is a property list which may
269 contain the following key/value pairs:
273 FILE is the sound file to play. If it isn't an absolute name,
274 it's searched under `data-directory'.
278 DATA is a string containing sound data. Either :file or :data
279 may be present, but not both.
283 DEVICE is the name of the device to play on, e.g. "/dev/dsp2".
284 If not specified, a default device is used.
288 VOL must be an integer in the range [0, 100], or a float in the
292 parse_sound (sound
, attrs
)
296 /* SOUND must be a list starting with the symbol `sound'. */
297 if (!CONSP (sound
) || !EQ (XCAR (sound
), Qsound
))
300 sound
= XCDR (sound
);
301 attrs
[SOUND_FILE
] = Fplist_get (sound
, QCfile
);
302 attrs
[SOUND_DATA
] = Fplist_get (sound
, QCdata
);
303 attrs
[SOUND_DEVICE
] = Fplist_get (sound
, QCdevice
);
304 attrs
[SOUND_VOLUME
] = Fplist_get (sound
, QCvolume
);
306 /* File name or data must be specified. */
307 if (!STRINGP (attrs
[SOUND_FILE
])
308 && !STRINGP (attrs
[SOUND_DATA
]))
311 /* Volume must be in the range 0..100 or unspecified. */
312 if (!NILP (attrs
[SOUND_VOLUME
]))
314 if (INTEGERP (attrs
[SOUND_VOLUME
]))
316 if (XINT (attrs
[SOUND_VOLUME
]) < 0
317 || XINT (attrs
[SOUND_VOLUME
]) > 100)
320 else if (FLOATP (attrs
[SOUND_VOLUME
]))
322 if (XFLOAT_DATA (attrs
[SOUND_VOLUME
]) < 0
323 || XFLOAT_DATA (attrs
[SOUND_VOLUME
]) > 1)
330 /* Device must be a string or unspecified. */
331 if (!NILP (attrs
[SOUND_DEVICE
])
332 && !STRINGP (attrs
[SOUND_DEVICE
]))
339 /* Find out the type of the sound file whose file descriptor is FD.
340 S is the sound file structure to fill in. */
346 if (!wav_init (s
) && !au_init (s
))
347 error ("Unknown sound format");
351 /* Function installed by play-sound with record_unwind_protect. */
357 if (current_sound_device
)
359 if (current_sound_device
->close
)
360 current_sound_device
->close (current_sound_device
);
361 if (current_sound
->fd
> 0)
362 emacs_close (current_sound
->fd
);
369 DEFUN ("play-sound", Fplay_sound
, Splay_sound
, 1, 1, 0,
370 "Play sound SOUND.\n\
371 SOUND is a list of the form `(sound KEYWORD VALUE...)'.\n\
372 The following keywords are recognized:\n\
374 :file FILE.- read sound data from FILE. If FILE isn't an\n\
375 absolute file name, it is searched in `data-directory'.\n\
377 :data DATA - read sound data from string DATA.\n\
379 Exactly one of :file or :data must be present.\n\
381 :volume VOL - set volume to VOL. VOL must an integer in the\n\
382 range 0..100 or a float in the range 0..1.0. If not specified,\n\
383 don't change the volume setting of the sound device.\n\
385 :device DEVICE - play sound on DEVICE. If not specified,\n\
386 a system-dependent default device name is used.")
390 Lisp_Object attrs
[SOUND_ATTR_SENTINEL
];
392 struct gcpro gcpro1
, gcpro2
;
393 struct sound_device sd
;
396 int count
= specpdl_ptr
- specpdl
;
399 GCPRO2 (sound
, file
);
400 bzero (&sd
, sizeof sd
);
401 bzero (&s
, sizeof s
);
402 current_sound_device
= &sd
;
404 record_unwind_protect (sound_cleanup
, Qnil
);
405 s
.header
= (char *) alloca (MAX_SOUND_HEADER_BYTES
);
407 /* Parse the sound specification. Give up if it is invalid. */
408 if (!parse_sound (sound
, attrs
))
409 error ("Invalid sound specification");
411 if (STRINGP (attrs
[SOUND_FILE
]))
413 /* Open the sound file. */
414 s
.fd
= openp (Fcons (Vdata_directory
, Qnil
),
415 attrs
[SOUND_FILE
], "", &file
, 0);
417 sound_perror ("Open sound file");
419 /* Read the first bytes from the file. */
420 s
.header_size
= emacs_read (s
.fd
, s
.header
, MAX_SOUND_HEADER_BYTES
);
421 if (s
.header_size
< 0)
422 sound_perror ("Reading sound file header");
426 s
.data
= attrs
[SOUND_DATA
];
427 bcopy (XSTRING (s
.data
)->data
, s
.header
,
428 min (MAX_SOUND_HEADER_BYTES
, STRING_BYTES (XSTRING (s
.data
))));
431 /* Find out the type of sound. Give up if we can't tell. */
432 find_sound_type (&s
);
434 /* Set up a device. */
435 if (STRINGP (attrs
[SOUND_DEVICE
]))
437 int len
= XSTRING (attrs
[SOUND_DEVICE
])->size
;
438 sd
.file
= (char *) alloca (len
+ 1);
439 strcpy (sd
.file
, XSTRING (attrs
[SOUND_DEVICE
])->data
);
442 if (INTEGERP (attrs
[SOUND_VOLUME
]))
443 sd
.volume
= XFASTINT (attrs
[SOUND_VOLUME
]);
444 else if (FLOATP (attrs
[SOUND_VOLUME
]))
445 sd
.volume
= XFLOAT_DATA (attrs
[SOUND_VOLUME
]) * 100;
447 args
[0] = Qplay_sound_functions
;
449 Frun_hook_with_args (2, args
);
451 /* There is only one type of device we currently support, the VOX
452 sound driver. Set up the device interface functions for that
456 /* Open the device. */
459 /* Play the sound. */
462 /* Close the input file, if any. */
463 if (!STRINGP (s
.data
))
469 /* Close the device. */
473 current_sound_device
= NULL
;
474 current_sound
= NULL
;
476 unbind_to (count
, Qnil
);
481 /***********************************************************************
482 Byte-order Conversion
483 ***********************************************************************/
485 /* Convert 32-bit value VALUE which is in little-endian byte-order
486 to host byte-order. */
492 #ifdef WORDS_BIG_ENDIAN
493 unsigned char *p
= (unsigned char *) &value
;
494 value
= p
[0] + (p
[1] << 8) + (p
[2] << 16) + (p
[3] << 24);
500 /* Convert 16-bit value VALUE which is in little-endian byte-order
501 to host byte-order. */
507 #ifdef WORDS_BIG_ENDIAN
508 unsigned char *p
= (unsigned char *) &value
;
509 value
= p
[0] + (p
[1] << 8);
515 /* Convert 32-bit value VALUE which is in big-endian byte-order
516 to host byte-order. */
522 #ifndef WORDS_BIG_ENDIAN
523 unsigned char *p
= (unsigned char *) &value
;
524 value
= p
[3] + (p
[2] << 8) + (p
[1] << 16) + (p
[0] << 24);
530 #if 0 /* Currently not used. */
532 /* Convert 16-bit value VALUE which is in big-endian byte-order
533 to host byte-order. */
539 #ifndef WORDS_BIG_ENDIAN
540 unsigned char *p
= (unsigned char *) &value
;
541 value
= p
[1] + (p
[0] << 8);
549 /***********************************************************************
551 ***********************************************************************/
553 /* Try to initialize sound file S from S->header. S->header
554 contains the first MAX_SOUND_HEADER_BYTES number of bytes from the
555 sound file. If the file is a WAV-format file, set up interface
556 functions in S and convert header fields to host byte-order.
557 Value is non-zero if the file is a WAV file. */
563 struct wav_header
*header
= (struct wav_header
*) s
->header
;
565 if (s
->header_size
< sizeof *header
566 || bcmp (s
->header
, "RIFF", 4) != 0)
569 /* WAV files are in little-endian order. Convert the header
570 if on a big-endian machine. */
571 header
->magic
= le2hl (header
->magic
);
572 header
->length
= le2hl (header
->length
);
573 header
->chunk_type
= le2hl (header
->chunk_type
);
574 header
->chunk_format
= le2hl (header
->chunk_format
);
575 header
->chunk_length
= le2hl (header
->chunk_length
);
576 header
->format
= le2hs (header
->format
);
577 header
->channels
= le2hs (header
->channels
);
578 header
->sample_rate
= le2hl (header
->sample_rate
);
579 header
->bytes_per_second
= le2hl (header
->bytes_per_second
);
580 header
->sample_size
= le2hs (header
->sample_size
);
581 header
->precision
= le2hs (header
->precision
);
582 header
->chunk_data
= le2hl (header
->chunk_data
);
583 header
->data_length
= le2hl (header
->data_length
);
585 /* Set up the interface functions for WAV. */
593 /* Play RIFF-WAVE audio file S on sound device SD. */
598 struct sound_device
*sd
;
600 struct wav_header
*header
= (struct wav_header
*) s
->header
;
602 /* Let the device choose a suitable device-dependent format
604 sd
->choose_format (sd
, s
);
606 /* Configure the device. */
607 sd
->sample_size
= header
->sample_size
;
608 sd
->sample_rate
= header
->sample_rate
;
609 sd
->bps
= header
->bytes_per_second
;
610 sd
->channels
= header
->channels
;
613 /* Copy sound data to the device. The WAV file specification is
614 actually more complex. This simple scheme worked with all WAV
615 files I found so far. If someone feels inclined to implement the
616 whole RIFF-WAVE spec, please do. */
617 if (STRINGP (s
->data
))
618 sd
->write (sd
, XSTRING (s
->data
)->data
+ sizeof *header
,
619 STRING_BYTES (XSTRING (s
->data
)) - sizeof *header
);
626 buffer
= (char *) alloca (blksize
);
627 lseek (s
->fd
, sizeof *header
, SEEK_SET
);
629 while ((nbytes
= emacs_read (s
->fd
, buffer
, blksize
)) > 0)
630 sd
->write (sd
, buffer
, nbytes
);
633 sound_perror ("Reading sound file");
639 /***********************************************************************
641 ***********************************************************************/
643 /* Sun audio file encodings. */
647 AU_ENCODING_ULAW_8
= 1,
658 /* Try to initialize sound file S from S->header. S->header
659 contains the first MAX_SOUND_HEADER_BYTES number of bytes from the
660 sound file. If the file is a AU-format file, set up interface
661 functions in S and convert header fields to host byte-order.
662 Value is non-zero if the file is an AU file. */
668 struct au_header
*header
= (struct au_header
*) s
->header
;
670 if (s
->header_size
< sizeof *header
671 || bcmp (s
->header
, ".snd", 4) != 0)
674 header
->magic_number
= be2hl (header
->magic_number
);
675 header
->data_offset
= be2hl (header
->data_offset
);
676 header
->data_size
= be2hl (header
->data_size
);
677 header
->encoding
= be2hl (header
->encoding
);
678 header
->sample_rate
= be2hl (header
->sample_rate
);
679 header
->channels
= be2hl (header
->channels
);
681 /* Set up the interface functions for AU. */
689 /* Play Sun audio file S on sound device SD. */
694 struct sound_device
*sd
;
696 struct au_header
*header
= (struct au_header
*) s
->header
;
699 sd
->sample_rate
= header
->sample_rate
;
701 sd
->channels
= header
->channels
;
702 sd
->choose_format (sd
, s
);
705 if (STRINGP (s
->data
))
706 sd
->write (sd
, XSTRING (s
->data
)->data
+ header
->data_offset
,
707 STRING_BYTES (XSTRING (s
->data
)) - header
->data_offset
);
715 lseek (s
->fd
, header
->data_offset
, SEEK_SET
);
717 /* Copy sound data to the device. */
718 buffer
= (char *) alloca (blksize
);
719 while ((nbytes
= emacs_read (s
->fd
, buffer
, blksize
)) > 0)
720 sd
->write (sd
, buffer
, nbytes
);
723 sound_perror ("Reading sound file");
729 /***********************************************************************
730 Voxware Driver Interface
731 ***********************************************************************/
733 /* This driver is available on GNU/Linux, and the free BSDs. FreeBSD
734 has a compatible own driver aka Luigi's driver. */
737 /* Open device SD. If SD->file is non-null, open that device,
738 otherwise use a default device name. */
742 struct sound_device
*sd
;
746 /* Open the sound device. Default is /dev/dsp. */
750 file
= DEFAULT_SOUND_DEVICE
;
752 sd
->fd
= emacs_open (file
, O_WRONLY
, 0);
758 /* Configure device SD from parameters in it. */
762 struct sound_device
*sd
;
766 xassert (sd
->fd
>= 0);
771 if (ioctl (sd
->fd
, SNDCTL_DSP_SETFMT
, &sd
->format
) < 0
772 || val
!= sd
->format
)
773 sound_perror ("Set sound format");
775 val
= sd
->channels
!= 1;
776 if (ioctl (sd
->fd
, SNDCTL_DSP_STEREO
, &val
) < 0
777 || val
!= (sd
->channels
!= 1))
778 sound_perror ("Set stereo/mono");
780 /* I think bps and sampling_rate are the same, but who knows.
781 Check this. and use SND_DSP_SPEED for both. */
782 if (sd
->sample_rate
> 0)
784 val
= sd
->sample_rate
;
785 if (ioctl (sd
->fd
, SNDCTL_DSP_SPEED
, &sd
->sample_rate
) < 0
786 || val
!= sd
->sample_rate
)
787 sound_perror ("Set sound speed");
792 int volume
= sd
->volume
& 0xff;
793 volume
|= volume
<< 8;
794 /* This may fail if there is no mixer. Ignore the failure. */
795 ioctl (sd
->fd
, SOUND_MIXER_WRITE_PCM
, &volume
);
802 /* Close device SD if it is open. */
806 struct sound_device
*sd
;
810 /* Flush sound data, and reset the device. */
812 ioctl (sd
->fd
, SNDCTL_DSP_SYNC
, NULL
);
815 /* Close the device. */
816 emacs_close (sd
->fd
);
822 /* Choose device-dependent format for device SD from sound file S. */
825 vox_choose_format (sd
, s
)
826 struct sound_device
*sd
;
831 struct wav_header
*h
= (struct wav_header
*) s
->header
;
832 if (h
->precision
== 8)
833 sd
->format
= AFMT_U8
;
834 else if (h
->precision
== 16)
835 sd
->format
= AFMT_S16_LE
;
837 error ("Unsupported WAV file format");
839 else if (s
->type
== SUN_AUDIO
)
841 struct au_header
*header
= (struct au_header
*) s
->header
;
842 switch (header
->encoding
)
844 case AU_ENCODING_ULAW_8
:
845 case AU_ENCODING_IEEE32
:
846 case AU_ENCODING_IEEE64
:
847 sd
->format
= AFMT_MU_LAW
;
854 sd
->format
= AFMT_S16_LE
;
858 error ("Unsupported AU file format");
866 /* Initialize device SD. Set up the interface functions in the device
871 struct sound_device
*sd
;
875 sd
->close
= vox_close
;
876 sd
->configure
= vox_configure
;
877 sd
->choose_format
= vox_choose_format
;
878 sd
->write
= vox_write
;
882 /* Write NBYTES bytes from BUFFER to device SD. */
885 vox_write (sd
, buffer
, nbytes
)
886 struct sound_device
*sd
;
890 int nwritten
= emacs_write (sd
->fd
, buffer
, nbytes
);
892 sound_perror ("Writing to sound device");
897 /***********************************************************************
899 ***********************************************************************/
904 QCdevice
= intern (":device");
905 staticpro (&QCdevice
);
906 QCvolume
= intern (":volume");
907 staticpro (&QCvolume
);
908 Qsound
= intern ("sound");
910 Qplay_sound_functions
= intern ("play-sound-functions");
911 staticpro (&Qplay_sound_functions
);
913 defsubr (&Splay_sound
);
922 #endif /* HAVE_SOUND */