1 /* sound.c -- sound support.
2 Copyright (C) 1998 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_hook
;
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 u_int16_t be2hs
P_ ((u_int16_t
));
224 static int wav_init
P_ ((struct sound_file
*));
225 static void wav_play
P_ ((struct sound_file
*, struct sound_device
*));
226 static int au_init
P_ ((struct sound_file
*));
227 static void au_play
P_ ((struct sound_file
*, struct sound_device
*));
231 /***********************************************************************
233 ***********************************************************************/
235 /* Like perror, but signals an error. */
241 error ("%s: %s", msg
, strerror (errno
));
245 /* Parse sound specification SOUND, and fill ATTRS with what is
246 found. Value is non-zero if SOUND Is a valid sound specification.
247 A valid sound specification is a list starting with the symbol
248 `sound'. The rest of the list is a property list which may
249 contain the following key/value pairs:
253 FILE is the sound file to play. If it isn't an absolute name,
254 it's searched under `data-directory'.
258 DEVICE is the name of the device to play on, e.g. "/dev/dsp2".
259 If not specified, a default device is used.
263 VOL must be an integer in the range 0..100. */
266 parse_sound (sound
, attrs
)
270 /* SOUND must be a list starting with the symbol `sound'. */
271 if (!CONSP (sound
) || !EQ (XCAR (sound
), Qsound
))
274 sound
= XCDR (sound
);
275 attrs
[SOUND_FILE
] = Fplist_get (sound
, QCfile
);
276 attrs
[SOUND_DEVICE
] = Fplist_get (sound
, QCdevice
);
277 attrs
[SOUND_VOLUME
] = Fplist_get (sound
, QCvolume
);
279 /* File name must be specified. */
280 if (!STRINGP (attrs
[SOUND_FILE
]))
283 /* Volume must be in the range 0..100 or unspecified. */
284 if (!NILP (attrs
[SOUND_VOLUME
]))
286 if (!INTEGERP (attrs
[SOUND_VOLUME
]))
288 if (XINT (attrs
[SOUND_VOLUME
]) < 0
289 || XINT (attrs
[SOUND_VOLUME
]) > 100)
293 /* Device must be a string or unspecified. */
294 if (!NILP (attrs
[SOUND_DEVICE
])
295 && !STRINGP (attrs
[SOUND_DEVICE
]))
302 /* Find out the type of the sound file whose file descriptor is FD.
303 SF is the sound file structure to fill in. */
306 find_sound_file_type (sf
)
307 struct sound_file
*sf
;
311 error ("Unknown sound file format");
315 /* Function installed by play-sound with record_unwind_protect. */
323 sound_device
->close (sound_device
);
324 if (sound_file
->fd
> 0)
325 close (sound_file
->fd
);
330 DEFUN ("play-sound", Fplay_sound
, Splay_sound
, 1, 1, 0,
335 Lisp_Object attrs
[SOUND_ATTR_SENTINEL
];
338 struct gcpro gcpro1
, gcpro2
;
341 struct sound_device sd
;
342 struct sound_file sf
;
344 int count
= specpdl_ptr
- specpdl
;
347 GCPRO2 (sound
, file
);
348 bzero (&sd
, sizeof sd
);
349 bzero (&sf
, sizeof sf
);
350 sf
.header
= (char *) alloca (MAX_SOUND_HEADER_BYTES
);
354 record_unwind_protect (sound_cleanup
, Qnil
);
356 /* Parse the sound specification. Give up if it is invalid. */
357 if (!parse_sound (sound
, attrs
))
360 error ("Invalid sound specification");
363 /* Open the sound file. */
364 sf
.fd
= openp (Fcons (Vdata_directory
, Qnil
),
365 attrs
[SOUND_FILE
], "", &file
, 0);
367 sound_perror ("Open sound file");
369 /* Read the first bytes from the file. */
370 nbytes
= read (sf
.fd
, sf
.header
, MAX_SOUND_HEADER_BYTES
);
372 sound_perror ("Reading sound file header");
374 /* Find out the type of sound file. Give up if we can't tell. */
375 find_sound_file_type (&sf
);
377 /* Set up a device. */
378 if (STRINGP (attrs
[SOUND_DEVICE
]))
380 int len
= XSTRING (attrs
[SOUND_DEVICE
])->size
;
381 sd
.file
= (char *) alloca (len
+ 1);
382 strcpy (sd
.file
, XSTRING (attrs
[SOUND_DEVICE
])->data
);
384 if (INTEGERP (attrs
[SOUND_VOLUME
]))
385 sd
.volume
= XFASTINT (attrs
[SOUND_VOLUME
]);
387 args
[0] = Qplay_sound_hook
;
389 Frun_hook_with_args (make_number (2), args
);
401 unbind_to (count
, Qnil
);
406 /***********************************************************************
407 Byte-order Conversion
408 ***********************************************************************/
410 /* Convert 32-bit value VALUE which is in little-endian byte-order
411 to host byte-order. */
417 #ifdef WORDS_BIG_ENDIAN
418 unsigned char *p
= (unsigned char *) &value
;
419 value
= p
[0] + (p
[1] << 8) + (p
[2] << 16) + (p
[3] << 24);
425 /* Convert 16-bit value VALUE which is in little-endian byte-order
426 to host byte-order. */
432 #ifdef WORDS_BIG_ENDIAN
433 unsigned char *p
= (unsigned char *) &value
;
434 value
= p
[0] + (p
[1] << 8);
440 /* Convert 32-bit value VALUE which is in big-endian byte-order
441 to host byte-order. */
447 #ifndef WORDS_BIG_ENDIAN
448 unsigned char *p
= (unsigned char *) &value
;
449 value
= p
[3] + (p
[2] << 8) + (p
[1] << 16) + (p
[0] << 24);
455 /* Convert 16-bit value VALUE which is in big-endian byte-order
456 to host byte-order. */
462 #ifndef WORDS_BIG_ENDIAN
463 unsigned char *p
= (unsigned char *) &value
;
464 value
= p
[1] + (p
[0] << 8);
471 /***********************************************************************
473 ***********************************************************************/
475 /* Try to initialize sound file SF from SF->header. SF->header
476 contains the first MAX_SOUND_HEADER_BYTES number of bytes from the
477 sound file. If the file is a WAV-format file, set up interface
478 functions in SF and convert header fields to host byte-order.
479 Value is non-zero if the file is a WAV file. */
483 struct sound_file
*sf
;
485 struct wav_header
*header
= (struct wav_header
*) sf
->header
;
487 if (bcmp (sf
->header
, "RIFF", 4) != 0)
490 /* WAV files are in little-endian order. Convert the header
491 if on a big-endian machine. */
492 header
->magic
= le2hl (header
->magic
);
493 header
->length
= le2hl (header
->length
);
494 header
->chunk_type
= le2hl (header
->chunk_type
);
495 header
->chunk_format
= le2hl (header
->chunk_format
);
496 header
->chunk_length
= le2hl (header
->chunk_length
);
497 header
->format
= le2hs (header
->format
);
498 header
->channels
= le2hs (header
->channels
);
499 header
->sample_rate
= le2hl (header
->sample_rate
);
500 header
->bytes_per_second
= le2hl (header
->bytes_per_second
);
501 header
->sample_size
= le2hs (header
->sample_size
);
502 header
->precision
= le2hs (header
->precision
);
503 header
->chunk_data
= le2hl (header
->chunk_data
);
504 header
->data_length
= le2hl (header
->data_length
);
506 /* Set up the interface functions for WAV. */
514 /* Play RIFF-WAVE audio file SF on sound device SD. */
518 struct sound_file
*sf
;
519 struct sound_device
*sd
;
521 struct wav_header
*header
= (struct wav_header
*) sf
->header
;
526 /* Let the device choose a suitable device-dependent format
528 sd
->choose_format (sd
, sf
);
530 /* Configure the device. */
531 sd
->sample_size
= header
->sample_size
;
532 sd
->sample_rate
= header
->sample_rate
;
533 sd
->bps
= header
->bytes_per_second
;
534 sd
->channels
= header
->channels
;
537 /* Copy sound data to the device. The WAV file specification is
538 actually more complex. This simple scheme worked with all WAV
539 files I found so far. If someone feels inclined to implement the
540 whole RIFF-WAVE spec, please do. */
541 buffer
= (char *) alloca (blksize
);
542 lseek (sf
->fd
, sizeof *header
, SEEK_SET
);
544 while ((nbytes
= read (sf
->fd
, buffer
, blksize
)) > 0)
545 sd
->write (sd
, buffer
, nbytes
);
548 sound_perror ("Reading sound file");
553 /***********************************************************************
555 ***********************************************************************/
557 /* Sun audio file encodings. */
561 AU_ENCODING_ULAW_8
= 1,
572 /* Try to initialize sound file SF from SF->header. SF->header
573 contains the first MAX_SOUND_HEADER_BYTES number of bytes from the
574 sound file. If the file is a AU-format file, set up interface
575 functions in SF and convert header fields to host byte-order.
576 Value is non-zero if the file is an AU file. */
580 struct sound_file
*sf
;
582 struct au_header
*header
= (struct au_header
*) sf
->header
;
584 if (bcmp (sf
->header
, ".snd", 4) != 0)
587 header
->magic_number
= be2hl (header
->magic_number
);
588 header
->data_offset
= be2hl (header
->data_offset
);
589 header
->data_size
= be2hl (header
->data_size
);
590 header
->encoding
= be2hl (header
->encoding
);
591 header
->sample_rate
= be2hl (header
->sample_rate
);
592 header
->channels
= be2hl (header
->channels
);
594 /* Set up the interface functions for AU. */
595 sf
->type
= SUN_AUDIO
;
602 /* Play Sun audio file SF on sound device SD. */
606 struct sound_file
*sf
;
607 struct sound_device
*sd
;
609 struct au_header
*header
= (struct au_header
*) sf
->header
;
615 sd
->sample_rate
= header
->sample_rate
;
617 sd
->channels
= header
->channels
;
618 sd
->choose_format (sd
, sf
);
622 lseek (sf
->fd
, header
->data_offset
, SEEK_SET
);
624 /* Copy sound data to the device. */
625 buffer
= (char *) alloca (blksize
);
626 while ((nbytes
= read (sf
->fd
, buffer
, blksize
)) > 0)
627 sd
->write (sd
, buffer
, nbytes
);
630 sound_perror ("Reading sound file");
635 /***********************************************************************
636 Voxware Driver Interface
637 ***********************************************************************/
639 /* This driver is available on GNU/Linux, and the free BSDs. FreeBSD
640 has a compatible own driver aka Luigi's driver. */
643 /* Open device SD. If SD->file is non-null, open that device,
644 otherwise use a default device name. */
648 struct sound_device
*sd
;
652 /* Open the sound device. Default is /dev/dsp. */
658 sd
->fd
= open (file
, O_WRONLY
);
664 /* Configure device SD from parameters in it. */
668 struct sound_device
*sd
;
672 xassert (sd
->fd
>= 0);
674 /* Device parameters apparently depend on each other in undocumented
675 ways (not to imply that there is any real documentation). Be
676 careful when reordering the calls below. */
677 if (sd
->sample_size
> 0
678 && ioctl (sd
->fd
, SNDCTL_DSP_SAMPLESIZE
, &sd
->sample_size
) < 0)
679 sound_perror ("Setting sample size");
682 && ioctl (sd
->fd
, SNDCTL_DSP_SPEED
, &sd
->bps
) < 0)
683 sound_perror ("Setting speed");
685 if (sd
->sample_rate
> 0
686 && ioctl (sd
->fd
, SOUND_PCM_WRITE_RATE
, &sd
->sample_rate
) < 0)
687 sound_perror ("Setting sample rate");
689 requested
= sd
->format
;
690 if (ioctl (sd
->fd
, SNDCTL_DSP_SETFMT
, &sd
->format
) < 0)
691 sound_perror ("Setting format");
692 else if (requested
!= sd
->format
)
693 error ("Setting format");
696 && ioctl (sd
->fd
, SNDCTL_DSP_STEREO
, &sd
->channels
) < 0)
697 sound_perror ("Setting channels");
700 && ioctl (sd
->fd
, SOUND_MIXER_WRITE_PCM
, &sd
->volume
) < 0)
701 sound_perror ("Setting volume");
705 /* Close device SD if it is open. */
709 struct sound_device
*sd
;
713 /* Flush sound data, and reset the device. */
714 ioctl (sd
->fd
, SNDCTL_DSP_SYNC
, NULL
);
715 ioctl (sd
->fd
, SNDCTL_DSP_RESET
, NULL
);
717 /* Close the device. */
724 /* Choose device-dependent format for device SD from sound file SF. */
727 vox_choose_format (sd
, sf
)
728 struct sound_device
*sd
;
729 struct sound_file
*sf
;
731 if (sf
->type
== RIFF
)
733 struct wav_header
*h
= (struct wav_header
*) sf
->header
;
734 if (h
->precision
== 8)
735 sd
->format
= AFMT_U8
;
736 else if (h
->precision
== 16)
737 sd
->format
= AFMT_S16_LE
;
739 error ("Unsupported WAV file format");
741 else if (sf
->type
== SUN_AUDIO
)
743 struct au_header
*header
= (struct au_header
*) sf
->header
;
744 switch (header
->encoding
)
746 case AU_ENCODING_ULAW_8
:
747 case AU_ENCODING_IEEE32
:
748 case AU_ENCODING_IEEE64
:
749 sd
->format
= AFMT_MU_LAW
;
756 sd
->format
= AFMT_S16_LE
;
760 error ("Unsupported AU file format");
768 /* Initialize device SD. Set up the interface functions in the device
773 struct sound_device
*sd
;
777 sd
->close
= vox_close
;
778 sd
->configure
= vox_configure
;
779 sd
->choose_format
= vox_choose_format
;
780 sd
->write
= vox_write
;
784 /* Write NBYTES bytes from BUFFER to device SD. */
787 vox_write (sd
, buffer
, nbytes
)
788 struct sound_device
*sd
;
792 int nwritten
= write (sd
->fd
, buffer
, nbytes
);
794 sound_perror ("Writing to sound device");
799 /***********************************************************************
801 ***********************************************************************/
806 QCdevice
= intern (":device");
807 staticpro (&QCdevice
);
808 QCvolume
= intern (":volume");
809 staticpro (&QCvolume
);
810 Qsound
= intern ("sound");
812 Qplay_sound_hook
= intern ("play-sound-hook");
813 staticpro (&Qplay_sound_hook
);
815 defsubr (&Splay_sound
);
824 #endif /* HAVE_SOUND */