cgit.sxemacs.org Git - gnus/blob - lisp/gnus-audio.el

   1 ;;; gnus-audio.el --- Sound effects for Gnus
   2 ;; Copyright (C) 1996, 2000 Free Software Foundation
   3
   4 ;; Author: Steven L. Baur <steve@miranova.com>
   5 ;; Keywords: news, mail, multimedia
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Commentary:
  25
  26 ;; This file provides access to sound effects in Gnus.
  27 ;; This file is partially stripped to support earcons.el.
  28
  29 ;;; Code:
  30
  31 (require 'nnheader)
  32
  33 (defgroup gnus-audio nil
  34   "Playing sound in Gnus."
  35   :group 'gnus-visual
  36   :group 'multimedia)
  37
  38 (defvar gnus-audio-inline-sound
  39   (or (if (fboundp 'device-sound-enabled-p)
  40           (device-sound-enabled-p))     ; XEmacs
  41       (fboundp 'play-sound))            ; Emacs 21
  42   "Non-nil means try to play sounds without using an external program.")
  43
  44 (defcustom gnus-audio-directory (nnheader-find-etc-directory "sounds")
  45   "The directory containing the Sound Files."
  46   :type 'directory
  47   :group 'gnus-audio)
  48
  49 (defcustom gnus-audio-au-player "/usr/bin/showaudio"
  50   "Executable program for playing sun AU format sound files."
  51   :group 'gnus-audio
  52   :type 'string)
  53
  54 (defcustom gnus-audio-wav-player "/usr/local/bin/play"
  55   "Executable program for playing WAV files."
  56   :group 'gnus-audio
  57   :type 'string)
  58
  59 ;;; The following isn't implemented yet.  Wait for Millennium Gnus.
  60 ;;(defvar gnus-audio-effects-enabled t
  61 ;;  "When t, Gnus will use sound effects.")
  62 ;;(defvar gnus-audio-enable-hooks nil
  63 ;;  "Functions run when enabling sound effects.")
  64 ;;(defvar gnus-audio-disable-hooks nil
  65 ;;  "Functions run when disabling sound effects.")
  66 ;;(defvar gnus-audio-theme-song nil
  67 ;;  "Theme song for Gnus.")
  68 ;;(defvar gnus-audio-enter-group nil
  69 ;;  "Sound effect played when selecting a group.")
  70 ;;(defvar gnus-audio-exit-group nil
  71 ;;  "Sound effect played when exiting a group.")
  72 ;;(defvar gnus-audio-score-group nil
  73 ;;  "Sound effect played when scoring a group.")
  74 ;;(defvar gnus-audio-busy-sound nil
  75 ;;  "Sound effect played when going into a ... sequence.")
  76
  77
  78 ;;;###autoload
  79 ;;(defun gnus-audio-enable-sound ()
  80 ;;  "Enable Sound Effects for Gnus."
  81 ;;  (interactive)
  82 ;;  (setq gnus-audio-effects-enabled t)
  83 ;;  (gnus-run-hooks gnus-audio-enable-hooks))
  84
  85 ;;;###autoload
  86                                         ;(defun gnus-audio-disable-sound ()
  87 ;;  "Disable Sound Effects for Gnus."
  88 ;;  (interactive)
  89 ;;  (setq gnus-audio-effects-enabled nil)
  90 ;;  (gnus-run-hooks gnus-audio-disable-hooks))
  91
  92 ;;;###autoload
  93 (defun gnus-audio-play (file)
  94   "Play a sound FILE through the speaker."
  95   (interactive)
  96   (let ((sound-file (if (file-exists-p file)
  97                         file
  98                       (expand-file-name file gnus-audio-directory))))
  99     (when (file-exists-p sound-file)
 100       (cond ((and gnus-audio-inline-sound
 101                  (condition-case nil
 102                      ;; Even if we have audio, we may fail with the
 103                      ;; wrong sort of sound file.
 104                      (progn (play-sound-file sound-file)
 105                             t)
 106                    (error nil))))
 107             ;; If we don't have built-in sound, or playing it failed,
 108             ;; try with external program.
 109             ((equal "wav" (file-name-extension sound-file))
 110              (call-process gnus-audio-wav-player
 111                            sound-file
 112                            0
 113                            nil
 114                            sound-file))
 115             ((equal "au" (file-name-extension sound-file))
 116              (call-process gnus-audio-au-player
 117                            sound-file
 118                            0
 119                            nil
 120                            sound-file))))))
 121
 122
 123 ;;; The following isn't implemented yet, wait for Red Gnus
 124 ;;(defun gnus-audio-startrek-sounds ()
 125 ;;  "Enable sounds from Star Trek the original series."
 126 ;;  (interactive)
 127 ;;  (setq gnus-audio-busy-sound "working.au")
 128 ;;  (setq gnus-audio-enter-group "bulkhead_door.au")
 129 ;;  (setq gnus-audio-exit-group "bulkhead_door.au")
 130 ;;  (setq gnus-audio-score-group "ST_laser.au")
 131 ;;  (setq gnus-audio-theme-song "startrek.au")
 132 ;;  (add-hook 'gnus-select-group-hook 'gnus-audio-startrek-select-group)
 133 ;;  (add-hook 'gnus-exit-group-hook 'gnus-audio-startrek-exit-group))
 134 ;;;***
 135
 136 (defvar gnus-startup-jingle "Tuxedomoon.Jingle4.au"
 137   "Name of the Gnus startup jingle file.")
 138
 139 (defun gnus-play-jingle ()
 140   "Play the Gnus startup jingle, unless that's inhibited."
 141   (interactive)
 142   (gnus-audio-play gnus-startup-jingle))
 143
 144 (provide 'gnus-audio)
 145
 146 (run-hooks 'gnus-audio-load-hook)
 147
 148 ;;; gnus-audio.el ends here