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>
35 /* FreeBSD has machine/soundcard.h. Voxware sound driver docs mention
36 sys/soundcard.h. So, let's try whatever's there. */
38 #ifdef HAVE_MACHINE_SOUNDCARD_H
39 #include <machine/soundcard.h>
41 #ifdef HAVE_SYS_SOUNDCARD_H
42 #include <sys/soundcard.h>
45 #define max(X, Y) ((X) > (Y) ? (X) : (Y))
46 #define min(X, Y) ((X) < (Y) ? (X) : (Y))
47 #define abs(X) ((X) < 0 ? -(X) : (X))
49 /* Structure forward declarations. */
54 /* The file header of RIFF-WAVE files (*.wav). Files are always in
55 little-endian byte-order. */
62 u_int32_t chunk_format
;
63 u_int32_t chunk_length
;
66 u_int32_t sample_rate
;
67 u_int32_t bytes_per_second
;
68 u_int16_t sample_size
;
71 u_int32_t data_length
;
74 /* The file header of Sun adio files (*.au). Files are always in
75 big-endian byte-order. */
80 u_int32_t magic_number
;
82 /* Offset of data part from start of file. Minimum value is 24. */
83 u_int32_t data_offset
;
85 /* Size of data part, 0xffffffff if unknown. */
88 /* Data encoding format.
90 2 8-bit linear PCM (REF-PCM)
94 6 32-bit IEEE floating-point
95 7 64-bit IEEE floating-point
96 23 8-bit u-law compressed using CCITT 0.721 ADPCM voice data
100 /* Number of samples per second. */
101 u_int32_t sample_rate
;
103 /* Number of interleaved channels. */
107 /* Maximum of all sound file headers sizes. */
109 #define MAX_SOUND_HEADER_BYTES \
110 max (sizeof (struct wav_header), sizeof (struct au_header))
112 /* Interface structure for sound devices. */
116 /* The name of the device or null meaning use a default device name. */
119 /* File descriptor of the device. */
122 /* Device-dependent format. */
125 /* Volume (0..100). Zero means unspecified. */
134 /* Bytes per second. */
137 /* 1 = mono, 2 = stereo, 0 = don't set. */
140 /* Open device SD. */
141 void (* open
) P_ ((struct sound_device
*sd
));
143 /* Close device SD. */
144 void (* close
) P_ ((struct sound_device
*sd
));
146 /* Configure SD accoring to device-dependent parameters. */
147 void (* configure
) P_ ((struct sound_device
*device
));
149 /* Choose a device-dependent format for outputting sound file SF. */
150 void (* choose_format
) P_ ((struct sound_device
*sd
,
151 struct sound_file
*sf
));
153 /* Write NYBTES bytes from BUFFER to device SD. */
154 void (* write
) P_ ((struct sound_device
*sd
, char *buffer
, int nbytes
));
156 /* A place for devices to store additional data. */
160 /* An enumerator for each supported sound file type. */
168 /* Interface structure for sound files. */
172 /* The type of the file. */
173 enum sound_type type
;
175 /* File descriptor of the file. */
178 /* Pointer to sound file header. This contains the first
179 MAX_SOUND_HEADER_BYTES read from the file. */
182 /* Play sound file SF on device SD. */
183 void (* play
) P_ ((struct sound_file
*sf
, struct sound_device
*sd
));
186 /* Indices of attributes in a sound attributes vector. */
198 extern Lisp_Object QCfile
;
199 Lisp_Object QCvolume
, QCdevice
;
201 Lisp_Object Qplay_sound_functions
;
203 /* These are set during `play-sound' so that sound_cleanup has
206 struct sound_device
*sound_device
;
207 struct sound_file
*sound_file
;
209 /* Function prototypes. */
211 static void vox_open
P_ ((struct sound_device
*));
212 static void vox_configure
P_ ((struct sound_device
*));
213 static void vox_close
P_ ((struct sound_device
*sd
));
214 static void vox_choose_format
P_ ((struct sound_device
*, struct sound_file
*));
215 static void vox_init
P_ ((struct sound_device
*));
216 static void vox_write
P_ ((struct sound_device
*, char *, int));
217 static void sound_perror
P_ ((char *));
218 static int parse_sound
P_ ((Lisp_Object
, Lisp_Object
*));
219 static void find_sound_file_type
P_ ((struct sound_file
*));
220 static u_int32_t le2hl
P_ ((u_int32_t
));
221 static u_int16_t le2hs
P_ ((u_int16_t
));
222 static u_int32_t be2hl
P_ ((u_int32_t
));
223 static int wav_init
P_ ((struct sound_file
*));
224 static void wav_play
P_ ((struct sound_file
*, struct sound_device
*));
225 static int au_init
P_ ((struct sound_file
*));
226 static void au_play
P_ ((struct sound_file
*, struct sound_device
*));
228 #if 0 /* Currently not used. */
229 static u_int16_t be2hs
P_ ((u_int16_t
));
234 /***********************************************************************
236 ***********************************************************************/
238 /* Like perror, but signals an error. */
244 error ("%s: %s", msg
, strerror (errno
));
248 /* Parse sound specification SOUND, and fill ATTRS with what is
249 found. Value is non-zero if SOUND Is a valid sound specification.
250 A valid sound specification is a list starting with the symbol
251 `sound'. The rest of the list is a property list which may
252 contain the following key/value pairs:
256 FILE is the sound file to play. If it isn't an absolute name,
257 it's searched under `data-directory'.
261 DEVICE is the name of the device to play on, e.g. "/dev/dsp2".
262 If not specified, a default device is used.
266 VOL must be an integer in the range [0, 100], or a float in the
270 parse_sound (sound
, attrs
)
274 /* SOUND must be a list starting with the symbol `sound'. */
275 if (!CONSP (sound
) || !EQ (XCAR (sound
), Qsound
))
278 sound
= XCDR (sound
);
279 attrs
[SOUND_FILE
] = Fplist_get (sound
, QCfile
);
280 attrs
[SOUND_DEVICE
] = Fplist_get (sound
, QCdevice
);
281 attrs
[SOUND_VOLUME
] = Fplist_get (sound
, QCvolume
);
283 /* File name must be specified. */
284 if (!STRINGP (attrs
[SOUND_FILE
]))
287 /* Volume must be in the range 0..100 or unspecified. */
288 if (!NILP (attrs
[SOUND_VOLUME
]))
290 if (INTEGERP (attrs
[SOUND_VOLUME
]))
292 if (XINT (attrs
[SOUND_VOLUME
]) < 0
293 || XINT (attrs
[SOUND_VOLUME
]) > 100)
296 else if (FLOATP (attrs
[SOUND_VOLUME
]))
298 if (XFLOAT_DATA (attrs
[SOUND_VOLUME
]) < 0
299 || XFLOAT_DATA (attrs
[SOUND_VOLUME
]) > 1)
306 /* Device must be a string or unspecified. */
307 if (!NILP (attrs
[SOUND_DEVICE
])
308 && !STRINGP (attrs
[SOUND_DEVICE
]))
315 /* Find out the type of the sound file whose file descriptor is FD.
316 SF is the sound file structure to fill in. */
319 find_sound_file_type (sf
)
320 struct sound_file
*sf
;
324 error ("Unknown sound file format");
328 /* Function installed by play-sound with record_unwind_protect. */
336 sound_device
->close (sound_device
);
337 if (sound_file
->fd
> 0)
338 emacs_close (sound_file
->fd
);
343 DEFUN ("play-sound", Fplay_sound
, Splay_sound
, 1, 1, 0,
348 Lisp_Object attrs
[SOUND_ATTR_SENTINEL
];
350 struct gcpro gcpro1
, gcpro2
;
352 struct sound_device sd
;
353 struct sound_file sf
;
355 int count
= specpdl_ptr
- specpdl
;
358 GCPRO2 (sound
, file
);
359 bzero (&sd
, sizeof sd
);
360 bzero (&sf
, sizeof sf
);
361 sf
.header
= (char *) alloca (MAX_SOUND_HEADER_BYTES
);
365 record_unwind_protect (sound_cleanup
, Qnil
);
367 /* Parse the sound specification. Give up if it is invalid. */
368 if (!parse_sound (sound
, attrs
))
371 error ("Invalid sound specification");
374 /* Open the sound file. */
375 sf
.fd
= openp (Fcons (Vdata_directory
, Qnil
),
376 attrs
[SOUND_FILE
], "", &file
, 0);
378 sound_perror ("Open sound file");
380 /* Read the first bytes from the file. */
381 nbytes
= emacs_read (sf
.fd
, sf
.header
, MAX_SOUND_HEADER_BYTES
);
383 sound_perror ("Reading sound file header");
385 /* Find out the type of sound file. Give up if we can't tell. */
386 find_sound_file_type (&sf
);
388 /* Set up a device. */
389 if (STRINGP (attrs
[SOUND_DEVICE
]))
391 int len
= XSTRING (attrs
[SOUND_DEVICE
])->size
;
392 sd
.file
= (char *) alloca (len
+ 1);
393 strcpy (sd
.file
, XSTRING (attrs
[SOUND_DEVICE
])->data
);
395 if (INTEGERP (attrs
[SOUND_VOLUME
]))
396 sd
.volume
= XFASTINT (attrs
[SOUND_VOLUME
]);
397 else if (FLOATP (attrs
[SOUND_VOLUME
]))
398 sd
.volume
= XFLOAT_DATA (attrs
[SOUND_VOLUME
]) * 100;
400 args
[0] = Qplay_sound_functions
;
402 Frun_hook_with_args (make_number (2), args
);
414 unbind_to (count
, Qnil
);
419 /***********************************************************************
420 Byte-order Conversion
421 ***********************************************************************/
423 /* Convert 32-bit value VALUE which is in little-endian byte-order
424 to host byte-order. */
430 #ifdef WORDS_BIG_ENDIAN
431 unsigned char *p
= (unsigned char *) &value
;
432 value
= p
[0] + (p
[1] << 8) + (p
[2] << 16) + (p
[3] << 24);
438 /* Convert 16-bit value VALUE which is in little-endian byte-order
439 to host byte-order. */
445 #ifdef WORDS_BIG_ENDIAN
446 unsigned char *p
= (unsigned char *) &value
;
447 value
= p
[0] + (p
[1] << 8);
453 /* Convert 32-bit value VALUE which is in big-endian byte-order
454 to host byte-order. */
460 #ifndef WORDS_BIG_ENDIAN
461 unsigned char *p
= (unsigned char *) &value
;
462 value
= p
[3] + (p
[2] << 8) + (p
[1] << 16) + (p
[0] << 24);
468 #if 0 /* Currently not used. */
470 /* Convert 16-bit value VALUE which is in big-endian byte-order
471 to host byte-order. */
477 #ifndef WORDS_BIG_ENDIAN
478 unsigned char *p
= (unsigned char *) &value
;
479 value
= p
[1] + (p
[0] << 8);
487 /***********************************************************************
489 ***********************************************************************/
491 /* Try to initialize sound file SF from SF->header. SF->header
492 contains the first MAX_SOUND_HEADER_BYTES number of bytes from the
493 sound file. If the file is a WAV-format file, set up interface
494 functions in SF and convert header fields to host byte-order.
495 Value is non-zero if the file is a WAV file. */
499 struct sound_file
*sf
;
501 struct wav_header
*header
= (struct wav_header
*) sf
->header
;
503 if (bcmp (sf
->header
, "RIFF", 4) != 0)
506 /* WAV files are in little-endian order. Convert the header
507 if on a big-endian machine. */
508 header
->magic
= le2hl (header
->magic
);
509 header
->length
= le2hl (header
->length
);
510 header
->chunk_type
= le2hl (header
->chunk_type
);
511 header
->chunk_format
= le2hl (header
->chunk_format
);
512 header
->chunk_length
= le2hl (header
->chunk_length
);
513 header
->format
= le2hs (header
->format
);
514 header
->channels
= le2hs (header
->channels
);
515 header
->sample_rate
= le2hl (header
->sample_rate
);
516 header
->bytes_per_second
= le2hl (header
->bytes_per_second
);
517 header
->sample_size
= le2hs (header
->sample_size
);
518 header
->precision
= le2hs (header
->precision
);
519 header
->chunk_data
= le2hl (header
->chunk_data
);
520 header
->data_length
= le2hl (header
->data_length
);
522 /* Set up the interface functions for WAV. */
530 /* Play RIFF-WAVE audio file SF on sound device SD. */
534 struct sound_file
*sf
;
535 struct sound_device
*sd
;
537 struct wav_header
*header
= (struct wav_header
*) sf
->header
;
542 /* Let the device choose a suitable device-dependent format
544 sd
->choose_format (sd
, sf
);
546 /* Configure the device. */
547 sd
->sample_size
= header
->sample_size
;
548 sd
->sample_rate
= header
->sample_rate
;
549 sd
->bps
= header
->bytes_per_second
;
550 sd
->channels
= header
->channels
;
553 /* Copy sound data to the device. The WAV file specification is
554 actually more complex. This simple scheme worked with all WAV
555 files I found so far. If someone feels inclined to implement the
556 whole RIFF-WAVE spec, please do. */
557 buffer
= (char *) alloca (blksize
);
558 lseek (sf
->fd
, sizeof *header
, SEEK_SET
);
560 while ((nbytes
= emacs_read (sf
->fd
, buffer
, blksize
)) > 0)
561 sd
->write (sd
, buffer
, nbytes
);
564 sound_perror ("Reading sound file");
569 /***********************************************************************
571 ***********************************************************************/
573 /* Sun audio file encodings. */
577 AU_ENCODING_ULAW_8
= 1,
588 /* Try to initialize sound file SF from SF->header. SF->header
589 contains the first MAX_SOUND_HEADER_BYTES number of bytes from the
590 sound file. If the file is a AU-format file, set up interface
591 functions in SF and convert header fields to host byte-order.
592 Value is non-zero if the file is an AU file. */
596 struct sound_file
*sf
;
598 struct au_header
*header
= (struct au_header
*) sf
->header
;
600 if (bcmp (sf
->header
, ".snd", 4) != 0)
603 header
->magic_number
= be2hl (header
->magic_number
);
604 header
->data_offset
= be2hl (header
->data_offset
);
605 header
->data_size
= be2hl (header
->data_size
);
606 header
->encoding
= be2hl (header
->encoding
);
607 header
->sample_rate
= be2hl (header
->sample_rate
);
608 header
->channels
= be2hl (header
->channels
);
610 /* Set up the interface functions for AU. */
611 sf
->type
= SUN_AUDIO
;
618 /* Play Sun audio file SF on sound device SD. */
622 struct sound_file
*sf
;
623 struct sound_device
*sd
;
625 struct au_header
*header
= (struct au_header
*) sf
->header
;
631 sd
->sample_rate
= header
->sample_rate
;
633 sd
->channels
= header
->channels
;
634 sd
->choose_format (sd
, sf
);
638 lseek (sf
->fd
, header
->data_offset
, SEEK_SET
);
640 /* Copy sound data to the device. */
641 buffer
= (char *) alloca (blksize
);
642 while ((nbytes
= emacs_read (sf
->fd
, buffer
, blksize
)) > 0)
643 sd
->write (sd
, buffer
, nbytes
);
646 sound_perror ("Reading sound file");
651 /***********************************************************************
652 Voxware Driver Interface
653 ***********************************************************************/
655 /* This driver is available on GNU/Linux, and the free BSDs. FreeBSD
656 has a compatible own driver aka Luigi's driver. */
659 /* Open device SD. If SD->file is non-null, open that device,
660 otherwise use a default device name. */
664 struct sound_device
*sd
;
668 /* Open the sound device. Default is /dev/dsp. */
674 sd
->fd
= emacs_open (file
, O_WRONLY
, 0);
680 /* Configure device SD from parameters in it. */
684 struct sound_device
*sd
;
688 xassert (sd
->fd
>= 0);
690 /* Device parameters apparently depend on each other in undocumented
691 ways (not to imply that there is any real documentation). Be
692 careful when reordering the calls below. */
693 if (sd
->sample_size
> 0
694 && ioctl (sd
->fd
, SNDCTL_DSP_SAMPLESIZE
, &sd
->sample_size
) < 0)
695 sound_perror ("Setting sample size");
698 && ioctl (sd
->fd
, SNDCTL_DSP_SPEED
, &sd
->bps
) < 0)
699 sound_perror ("Setting speed");
701 if (sd
->sample_rate
> 0
702 && ioctl (sd
->fd
, SOUND_PCM_WRITE_RATE
, &sd
->sample_rate
) < 0)
703 sound_perror ("Setting sample rate");
705 requested
= sd
->format
;
706 if (ioctl (sd
->fd
, SNDCTL_DSP_SETFMT
, &sd
->format
) < 0)
707 sound_perror ("Setting format");
708 else if (requested
!= sd
->format
)
709 error ("Setting format");
712 && ioctl (sd
->fd
, SNDCTL_DSP_STEREO
, &sd
->channels
) < 0)
713 sound_perror ("Setting channels");
716 && ioctl (sd
->fd
, SOUND_MIXER_WRITE_PCM
, &sd
->volume
) < 0)
717 sound_perror ("Setting volume");
721 /* Close device SD if it is open. */
725 struct sound_device
*sd
;
729 /* Flush sound data, and reset the device. */
730 ioctl (sd
->fd
, SNDCTL_DSP_SYNC
, NULL
);
731 ioctl (sd
->fd
, SNDCTL_DSP_RESET
, NULL
);
733 /* Close the device. */
734 emacs_close (sd
->fd
);
740 /* Choose device-dependent format for device SD from sound file SF. */
743 vox_choose_format (sd
, sf
)
744 struct sound_device
*sd
;
745 struct sound_file
*sf
;
747 if (sf
->type
== RIFF
)
749 struct wav_header
*h
= (struct wav_header
*) sf
->header
;
750 if (h
->precision
== 8)
751 sd
->format
= AFMT_U8
;
752 else if (h
->precision
== 16)
753 sd
->format
= AFMT_S16_LE
;
755 error ("Unsupported WAV file format");
757 else if (sf
->type
== SUN_AUDIO
)
759 struct au_header
*header
= (struct au_header
*) sf
->header
;
760 switch (header
->encoding
)
762 case AU_ENCODING_ULAW_8
:
763 case AU_ENCODING_IEEE32
:
764 case AU_ENCODING_IEEE64
:
765 sd
->format
= AFMT_MU_LAW
;
772 sd
->format
= AFMT_S16_LE
;
776 error ("Unsupported AU file format");
784 /* Initialize device SD. Set up the interface functions in the device
789 struct sound_device
*sd
;
793 sd
->close
= vox_close
;
794 sd
->configure
= vox_configure
;
795 sd
->choose_format
= vox_choose_format
;
796 sd
->write
= vox_write
;
800 /* Write NBYTES bytes from BUFFER to device SD. */
803 vox_write (sd
, buffer
, nbytes
)
804 struct sound_device
*sd
;
808 int nwritten
= emacs_write (sd
->fd
, buffer
, nbytes
);
810 sound_perror ("Writing to sound device");
815 /***********************************************************************
817 ***********************************************************************/
822 QCdevice
= intern (":device");
823 staticpro (&QCdevice
);
824 QCvolume
= intern (":volume");
825 staticpro (&QCvolume
);
826 Qsound
= intern ("sound");
828 Qplay_sound_functions
= intern ("play-sound-functions");
829 staticpro (&Qplay_sound_functions
);
831 defsubr (&Splay_sound
);
840 #endif /* HAVE_SOUND */