[PATCH 21.5] ALSA support

PATCH 21.5 Thanks for all the feedback on the early version of this patch. This version supports setting the volume with play-sound and play-sound-file. ChangeLog addition: 2006-03-24 Jerry James <james(a)xemacs.org&gt; * configure.ac: Autodetect ALSA support and report it if detected. src/ChangeLog addition: 2006-03-24 Jerry James <james(a)xemacs.org&gt; * alsaplay.c: New file providing support for sound with ALSA. * config.h.in: New symbol HAVE_ALSA_SOUND * sound.c: Add ALSA support. xemacs-21.5 source patch: Diff command: cvs -q diff -uN Files affected: src/sound.c src/config.h.in src/alsaplay.c configure.ac Index: configure.ac =================================================================== RCS file: /pack/xemacscvs/XEmacs/xemacs/configure.ac,v retrieving revision 1.35 diff -d -u -u -r1.35 configure.ac --- configure.ac 2006/02/27 16:29:06 1.35 +++ configure.ac 2006/03/24 19:31:41 ＠＠ -791,16 +791,18 ＠＠ XE_HELP_SUBSECTION([Sound options]) XE_COMPLEX_ARG([sound], AC_HELP_STRING([--enable-sound=TYPE],[Compile with sound support. - Valid types are `native', `nas' and `esd'. + Valid types are `native', `alsa', `nas' and `esd'. Prefix a type with 'no' to disable. The first type can be `none' or `all'. `none' means - `nonative,nonas,noesd'. `all' means `native,nas,esd'. - Later options override earlier ones for the same TYPE. - The default is to autodetect all sound support except - for ESD which defaults to off.]), + `nonative,noalsa,nonas,noesd'. `all' means + `native,alsa,nas,esd'. Later options override earlier + ones for the same TYPE. The default is to autodetect + all sound support except for ESD which defaults to + off.]), [], [enable_sound_nas=""], [XE_COMPLEX_OPTION([native],[""]), + XE_COMPLEX_OPTION([alsa],[""]), XE_COMPLEX_OPTION([nas],[""]), XE_COMPLEX_OPTION([esd],[no])]) XE_MERGED_ARG([native-sound-lib], ＠＠ -5006,9 +5008,9 ＠＠ AC_CHECK_HEADER(nlist.h, AC_DEFINE(NLIST_STRUCT), ) dnl Check for sound of various sorts. +AC_CHECKING([for sound support]) dnl Autodetect native sound -AC_CHECKING([for sound support]) test -n "$with_native_sound_lib" && enable_sound_native=yes if test "$enable_sound_native" != "no"; then ＠＠ -5127,6 +5129,22 ＠＠ test -n "$with_native_sound_lib" && XE_PREPEND($with_native_sound_lib, LIBS) fi +dnl ALSA sound support +if test "$enable_sound_alsa" != "no"; then + AC_CHECK_HEADER([alsa/pcm.h], [ + AC_CHECK_LIB(asound, snd_pcm_open, have_alsa_sound=yes)]) + if test "$have_alsa_sound" = "yes"; then + enable_sound_alsa=yes + AC_DEFINE(HAVE_ALSA_SOUND) + XE_ADD_OBJS(alsaplay.o) + XE_PREPEND(-lasound, LIBS) + else + test "$enable_sound_alsa" = "yes" && \ + XE_DIE("Required ALSA sound support cannot be provided.") + enable_sound_alsa=no + fi +fi + dnl NAS Sound support if test "$enable_sound_nas" != "no"; then AC_CHECK_HEADER(audio/audiolib.h, [ ＠＠ -6053,6 +6071,7 ＠＠ echo " Sound:" test "$enable_sound_native" = yes && echo " Compiling in support for sound (native)." +test "$enable_sound_alsa" = yes && echo " Compiling in support for ALSA (Advanced Linux Sound Architecture)." test "$enable_sound_nas" = yes && echo " Compiling in support for NAS (network audio system)." test "$old_nas" = yes && echo " - NAS library lacks error trapping; will play synchronously." test "$enable_sound_esd" = yes && echo " Compiling in support for ESD (Enlightened Sound Daemon)." Index: src/alsaplay.c =================================================================== RCS file: alsaplay.c diff -N alsaplay.c --- /dev/null Fri Mar 24 20:31:35 2006 +++ alsaplay.c Fri Mar 24 20:31:41 2006 ＠＠ -0,0 +1,404 ＠＠ +/* Play sound with the ALSA library + Copyright (C) 2006 Jerry James. + +This file is part of XEmacs. + +XEmacs is free software; you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the +Free Software Foundation; either version 2, or (at your option) any +later version. + +XEmacs is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +for more details. + +You should have received a copy of the GNU General Public License +along with XEmacs; see the file COPYING. If not, write to +the Free Software Foundation, Inc., 59 Temple Place - Suite 330, +Boston, MA 02111-1307, USA. */ + +/* Synched up with: Not in FSF. */ + +/* TODO: Support asynchronous sound playing; see the NAS support in sound.c */ + +#include <config.h> +#include "lisp.h" +#include "sound.h" +#include "sysfile.h" + +/* We can't just include <alsa/asoundlib.h> because it tries to redefine + * several symbols defined by the previous header files. + */ +#include <alsa/input.h> +#include <alsa/output.h> +#include <alsa/conf.h> +#include <alsa/global.h> +#include <alsa/pcm.h> +#include <alsa/error.h> +#include <alsa/hwdep.h> +#include <alsa/rawmidi.h> +#include <alsa/control.h> +#include <alsa/mixer.h> + +struct mixer_state +{ + snd_mixer_t *mixer; + snd_mixer_elem_t *vol_ctl; + + /* Which channels need the old volume restored */ + int reset_front_left; + int reset_front_center; + int reset_front_right; + int reset_rear_left; + int reset_rear_center; + int reset_rear_right; + int reset_side_left; + int reset_side_right; + int reset_woofer; + + /* Old volumes for the channels */ + long front_left_vol; + long front_center_vol; + long front_right_vol; + long rear_left_vol; + long rear_center_vol; + long rear_right_vol; + long side_left_vol; + long side_right_vol; + long woofer_vol; +}; + +/* Assemble a machine half-word in little-endian order */ +#define HALF_LE(arr,start) (arr[start] + (arr[start + 1] << 8)) + +/* Assemble a machine word in little-endian order */ +#define WORD_LE(arr,start) (arr[start] + (arr[start + 1] << 8) + \ + (arr[start + 2] << 16) + (arr[start + 3] << 24)) + +/* Assemble a machine word in big-endian order */ +#define WORD_BE(arr,start) ((arr[start] << 24) + (arr[start + 1] << 16) + \ + (arr[start + 2] << 8) + arr[start + 3]) + +/* This function was inspired by miscplay.c. + * Examine sound data to determine its format. + * + * TODO: Detect other formats that ALSA can play, such as GSM and MPEG. + */ +static snd_pcm_format_t +analyze_format (const Binbyte *format, int *speed, int *tracks) +{ + if (!memcmp (format, "Creative Voice File\x1A\x1A\x00", 22) && + HALF_LE (format, 22) == ((0x1233 - HALF_LE (format, 24)) & 0xFFFF)) + { + /* VOC */ + *speed = 8000; + *tracks = 2; + return SND_PCM_FORMAT_U8; + } + else if (!memcmp (format, "RIFF", 4) && !memcmp (format + 8, "WAVEfmt ", 8)) + { + /* WAVE */ + *speed = WORD_LE (format, 24); + *tracks = format[22]; + return format[32] / format[22] == 1 + ? SND_PCM_FORMAT_U8 + : SND_PCM_FORMAT_S16_LE; + } + else if (!memcmp (format, ".snd", 4)) + { + /* Sun/NeXT Audio (big endian) */ + if (WORD_BE (format, 4) < 24) + { + *speed = 8000; + *tracks = 1; + return SND_PCM_FORMAT_MU_LAW; + } + *speed = WORD_BE (format, 16); + *tracks = format[23]; + if (!memcmp (format + 12, "\000\000\000", 3)) + { + switch (format[15]) + { + case 1: + case 17: + case 29: + return SND_PCM_FORMAT_MU_LAW; + case 2: + return SND_PCM_FORMAT_S8; + case 3: + return SND_PCM_FORMAT_S16_BE; + case 4: + return SND_PCM_FORMAT_S24_BE; + case 5: + return SND_PCM_FORMAT_S32_BE; + case 23: + case 24: + case 25: + case 26: + return SND_PCM_FORMAT_IMA_ADPCM; + case 27: + return SND_PCM_FORMAT_A_LAW; + default: + break; + } + } + return SND_PCM_FORMAT_UNKNOWN; + } + else if (!memcmp (format, ".sd", 4)) + { + /* DEC Audio (little endian) */ + if (WORD_LE (format, 4) < 24) + { + *speed = 8000; + *tracks = 1; + return SND_PCM_FORMAT_MU_LAW; + } + *speed = WORD_LE (format, 16); + *tracks = format[20]; + if (!memcmp (format + 13, "\000\000\000", 3)) + { + switch (format[12]) + { + case 1: + case 17: + case 29: + return SND_PCM_FORMAT_MU_LAW; + case 2: + return SND_PCM_FORMAT_S8; + case 3: + return SND_PCM_FORMAT_S16_LE; + case 4: + return SND_PCM_FORMAT_S24_LE; + case 5: + return SND_PCM_FORMAT_S32_LE; + case 23: + case 24: + case 25: + case 26: + return SND_PCM_FORMAT_IMA_ADPCM; + case 27: + return SND_PCM_FORMAT_A_LAW; + default: + break; + } + } + return SND_PCM_FORMAT_UNKNOWN; + } + else + { + /* We don't know what it is. Guess that it is mono audio in unsigned + * byte format. Maybe we should error if we reach this point. + */ + *speed = 8000; + *tracks = 1; + return SND_PCM_FORMAT_U8; + } +} + +/* Set the volume: if any errors occur, we accept the existing volume */ +static void +set_volume (struct mixer_state *mix, int volume) +{ + snd_mixer_selem_id_t *volume_id; + long min_vol, max_vol, dev_vol; + + if (snd_mixer_open (&mix->mixer, 0) < 0) + return; + + if (snd_mixer_attach (mix->mixer, "default") < 0) + return; + + if (snd_mixer_selem_register (mix->mixer, NULL, NULL) < 0) + return; + + if (snd_mixer_load (mix->mixer) < 0) + return; + + snd_mixer_selem_id_alloca (&volume_id); + snd_mixer_selem_id_set_name (volume_id, "PCM"); + + if ((mix->vol_ctl = snd_mixer_find_selem (mix->mixer, volume_id)) == NULL) + { + snd_mixer_selem_id_set_name (volume_id, "Master"); + if ((mix->vol_ctl = snd_mixer_find_selem (mix->mixer, volume_id)) + == NULL) + return; + } + + /* Translate the Lisp volume range to the device volume range */ + if (snd_mixer_selem_get_playback_volume_range (mix->vol_ctl, &min_vol, + &max_vol) < 0) + return; + + dev_vol = volume * (max_vol - min_vol) / 100 + min_vol; + + /* Record the old volumes */ + if (snd_mixer_selem_get_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_FRONT_LEFT, &mix->front_left_vol) >= 0) + mix->reset_front_left = 1; + + if (snd_mixer_selem_get_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_FRONT_CENTER, &mix->front_center_vol) >= 0) + mix->reset_front_center = 1; + + if (snd_mixer_selem_get_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_FRONT_RIGHT, &mix->front_right_vol) >= 0) + mix->reset_front_right = 1; + + if (snd_mixer_selem_get_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_REAR_LEFT, &mix->rear_left_vol) >= 0) + mix->reset_rear_left = 1; + + if (snd_mixer_selem_get_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_REAR_CENTER, &mix->rear_center_vol) >= 0) + mix->reset_rear_center = 1; + + if (snd_mixer_selem_get_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_REAR_RIGHT, &mix->rear_right_vol) >= 0) + mix->reset_rear_right = 1; + + if (snd_mixer_selem_get_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_SIDE_LEFT, &mix->side_left_vol) >= 0) + mix->reset_side_left = 1; + + if (snd_mixer_selem_get_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_SIDE_RIGHT, &mix->side_right_vol) >= 0) + mix->reset_side_right = 1; + + if (snd_mixer_selem_get_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_WOOFER, &mix->woofer_vol) >= 0) + mix->reset_woofer = 1; + + /* Set the volume */ + snd_mixer_selem_set_playback_volume_all (mix->vol_ctl, dev_vol); +} + +static void +reset_volume (const struct mixer_state *mix) +{ + if (mix->reset_front_left) + snd_mixer_selem_set_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_FRONT_LEFT, mix->front_left_vol); + + if (mix->reset_front_center) + snd_mixer_selem_set_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_FRONT_CENTER, mix->front_center_vol); + + if (mix->reset_front_right) + snd_mixer_selem_set_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_FRONT_RIGHT, mix->front_right_vol); + + if (mix->reset_rear_left) + snd_mixer_selem_set_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_REAR_LEFT, mix->rear_left_vol); + + if (mix->reset_rear_center) + snd_mixer_selem_set_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_REAR_CENTER, mix->rear_center_vol); + + if (mix->reset_rear_right) + snd_mixer_selem_set_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_REAR_RIGHT, mix->rear_right_vol); + + if (mix->reset_side_left) + snd_mixer_selem_set_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_SIDE_LEFT, mix->side_left_vol); + + if (mix->reset_side_right) + snd_mixer_selem_set_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_SIDE_RIGHT, mix->side_right_vol); + + if (mix->reset_woofer) + snd_mixer_selem_set_playback_volume + (mix->vol_ctl, SND_MIXER_SCHN_WOOFER, mix->woofer_vol); + + snd_mixer_close (mix->mixer); +} + +int +alsa_play_sound_data (const Binbyte *data, int length, int volume) +{ + snd_pcm_t *pcm_handle; + snd_pcm_hw_params_t *hwparams; + snd_pcm_format_t format; + struct mixer_state mix; + int speed, tracks, err; + + /* Set the PCM parameters */ + if ((err = snd_pcm_open (&pcm_handle, "default", SND_PCM_STREAM_PLAYBACK, + 0)) < 0) + goto error_pcm_open; + + snd_pcm_hw_params_alloca (&hwparams); + + if ((err = snd_pcm_hw_params_any (pcm_handle, hwparams)) < 0) + goto error_pcm; + + format = analyze_format (data, &speed, &tracks); + + if ((err = snd_pcm_hw_params_set_access (pcm_handle, hwparams, + SND_PCM_ACCESS_RW_INTERLEAVED)) < 0) + goto error_pcm; + + if ((err = snd_pcm_hw_params_set_format (pcm_handle, hwparams, format)) < 0) + goto error_pcm; + + if ((err = snd_pcm_hw_params_set_rate (pcm_handle, hwparams, speed, 0)) < 0) + goto error_pcm; + + if ((err = snd_pcm_hw_params_set_channels (pcm_handle, hwparams, tracks)) + < 0) + goto error_pcm; + + if ((err = snd_pcm_hw_params (pcm_handle, hwparams)) < 0) + goto error_pcm; + + /* Set the volume */ + memset (&mix, 0, sizeof (mix)); + set_volume (&mix, volume); + + /* Play the sound */ + if ((err = snd_pcm_writei (pcm_handle, data, length)) < 0) + goto error_mixer; + + /* Put the volume back the way it used to be */ + reset_volume (&mix); + + /* Release resources */ + snd_pcm_close (pcm_handle); + return 1; + + error_mixer: + reset_volume (&mix); + error_pcm: + snd_pcm_close (pcm_handle); + error_pcm_open: + sound_perror (snd_strerror (err)); + return 0; +} + +/* Read the sound file into an internal buffer, then call + * alsa_play_sound_data. + */ +int +alsa_play_sound_file (const Extbyte *sound_file, int volume) +{ + Binbyte *data; + int fd, retval; + struct stat st; + + fd = retry_open (sound_file, O_RDONLY, 0); + if (fd < 0) { + sound_perror (sound_file); + return 0; + } + + qxe_fstat (fd, &st); + data = xnew_array (Binbyte, st.st_size); + retry_read (fd, data, st.st_size); + retry_close (fd); + retval = alsa_play_sound_data (data, st.st_size, volume); + xfree (data, Binbyte); + return retval; +} Index: src/config.h.in =================================================================== RCS file: /pack/xemacscvs/XEmacs/xemacs/src/config.h.in,v retrieving revision 1.106 diff -d -u -u -r1.106 config.h.in --- src/config.h.in 2006/02/27 16:29:22 1.106 +++ src/config.h.in 2006/03/24 19:31:41 ＠＠ -796,6 +796,9 ＠＠ /* Native sound may be provided via soundcard.h, in various directories */ #undef SOUNDCARD_H_FILE +/* Compile in support for ALSA (Advanced Linux Sound Architecture) */ +#undef HAVE_ALSA_SOUND + /* Compile in support for NAS (Network Audio System)? NAS_NO_ERROR_JUMP means that the NAS libraries don't include some error handling changes. */ Index: src/sound.c =================================================================== RCS file: /pack/xemacscvs/XEmacs/xemacs/src/sound.c,v retrieving revision 1.25 diff -d -u -u -r1.25 sound.c --- src/sound.c 2005/11/16 07:22:46 1.25 +++ src/sound.c 2006/03/24 19:31:41 ＠＠ -70,12 +70,25 ＠＠ #define USED_IF_HAVE_ANY(decl) UNUSED (decl) #endif +#ifdef HAVE_ALSA_SOUND +extern int alsa_play_sound_file (const Extbyte *file, int vol); +extern int alsa_play_sound_data (const Binbyte *data, int length, int vol); +# define DEVICE_CONNECTED_TO_ALSA_P(x) 1 /* #### better check */ +#endif + #ifdef HAVE_ESD_SOUND extern int esd_play_sound_file (Extbyte *file, int vol); extern int esd_play_sound_data (Binbyte *data, size_t length, int vol); # define DEVICE_CONNECTED_TO_ESD_P(x) 1 /* #### better check */ #endif +#ifdef HAVE_NAS_SOUND +extern int nas_play_sound_file (Extbyte *name, int volume); +extern int nas_play_sound_data (Binbyte *data, int length, int volume); +extern int nas_wait_for_sounds (void); +extern Extbyte *nas_init_play (Display *); +#endif + Fixnum bell_volume; Fixnum bell_inhibit_time; Lisp_Object Vsound_alist; ＠＠ -84,14 +97,6 ＠＠ Lisp_Object Q_volume, Q_pitch, Q_duration, Q_sound; Lisp_Object Qsound_error; - -#ifdef HAVE_NAS_SOUND -extern int nas_play_sound_file (Extbyte *name, int volume); -extern int nas_play_sound_data (Binbyte *data, int length, int volume); -extern int nas_wait_for_sounds (void); -extern Extbyte *nas_init_play (Display *); -#endif - DOESNT_RETURN report_sound_error (const Ascbyte *string, Lisp_Object data) { ＠＠ -110,8 +115,8 ＠＠ { /* This function can call lisp */ int vol; -#if defined (HAVE_NATIVE_SOUND) || defined (HAVE_NAS_SOUND) \ - || defined (HAVE_ESD_SOUND) +#if defined (HAVE_NATIVE_SOUND) || defined (HAVE_ALSA_SOUND) || \ + defined (HAVE_NAS_SOUND) || defined (HAVE_ESD_SOUND) struct device *d = decode_device (device); #endif struct gcpro gcpro1; ＠＠ -148,6 +153,18 ＠＠ } UNGCPRO; +#ifdef HAVE_ALSA_SOUND + if (DEVICE_CONNECTED_TO_ALSA_P (d)) + { + Extbyte *fileext; + + LISP_STRING_TO_EXTERNAL (file, fileext, Qfile_name); + /* #### ALSA code should allow specification of a device. */ + if (alsa_play_sound_file (fileext, vol)) + return Qnil; + } +#endif + #ifdef HAVE_NAS_SOUND if (DEVICE_CONNECTED_TO_NAS_P (d)) { ＠＠ -355,10 +372,24 ＠＠ pit = (INT_OR_FLOATP (pitch) ? (int) XFLOATINT (pitch) : -1); dur = (INT_OR_FLOATP (duration) ? (int) XFLOATINT (duration) : -1); - /* If the sound is a string, and we're connected to Nas, do that. - Else if the sound is a string, and we're on console, play it natively. - Else just beep. + /* If the sound is a string, and we're connected to ALSA, NAS, or ESD, do + that. Else if the sound is a string, and we're on console, play it + natively. Else just beep. */ +#ifdef HAVE_ALSA_SOUND + if (DEVICE_CONNECTED_TO_ALSA_P (d) && STRINGP (sound)) + { + Binbyte *soundext; + Bytecount soundextlen; + + TO_EXTERNAL_FORMAT (LISP_STRING, sound, + ALLOCA, (soundext, soundextlen), + Qbinary); + if (alsa_play_sound_data (soundext, soundextlen, vol)) + return Qnil; + } +#endif /* HAVE_ALSA_SOUND */ + #ifdef HAVE_NAS_SOUND if (DEVICE_CONNECTED_TO_NAS_P (d) && STRINGP (sound)) { ＠＠ -423,6 +454,10 ＠＠ */ (USED_IF_HAVE_NATIVE_OR_NAS (device))) { +#ifdef HAVE_ALSA_SOUND + if (DEVICE_CONNECTED_TO_ALSA_P (decode_device (device))) + return Qt; +#endif #ifdef HAVE_NAS_SOUND if (DEVICE_CONNECTED_TO_NAS_P (decode_device (device))) return Qt; ＠＠ -654,6 +689,9 ＠＠ void vars_of_sound (void) { +#ifdef HAVE_ALSA_SOUND + Fprovide (intern ("alsa-sound")); +#endif #ifdef HAVE_NATIVE_SOUND Fprovide (intern ("native-sound")); #endif -- Jerry James, Assistant Professor james(a)xemacs.org Computer Science Department http://www.cs.usu.edu/~jerry/ Utah State University