1 ;;; gnus-audio.el --- Sound effects for Gnus
3 ;; Copyright (C) 1996, 2000, 2002, 2003, 2004,
4 ;; 2005 Free Software Foundation, Inc.
6 ;; Author: Steven L. Baur <steve@miranova.com>
7 ;; Keywords: news, mail, multimedia
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; This file provides access to sound effects in Gnus.
29 ;; This file is partially stripped to support earcons.el.
37 (defgroup gnus-audio nil
38 "Playing sound in Gnus."
43 (defvar gnus-audio-inline-sound
44 (or (if (fboundp 'device-sound-enabled-p)
45 (device-sound-enabled-p)) ; XEmacs
46 (fboundp 'play-sound)) ; Emacs 21
47 "Non-nil means try to play sounds without using an external program.")
49 (defcustom gnus-audio-directory (nnheader-find-etc-directory "sounds")
50 "The directory containing the Sound Files."
51 :type '(choice directory (const nil))
54 (defcustom gnus-audio-au-player (exec-installed-p "play")
55 "Executable program for playing sun AU format sound files."
57 :type '(choice file (const nil)))
59 (defcustom gnus-audio-wav-player (exec-installed-p "play")
60 "Executable program for playing WAV files."
62 :type '(choice file (const nil)))
64 ;;; The following isn't implemented yet. Wait for Millennium Gnus.
65 ;;(defvar gnus-audio-effects-enabled t
66 ;; "When t, Gnus will use sound effects.")
67 ;;(defvar gnus-audio-enable-hooks nil
68 ;; "Functions run when enabling sound effects.")
69 ;;(defvar gnus-audio-disable-hooks nil
70 ;; "Functions run when disabling sound effects.")
71 ;;(defvar gnus-audio-theme-song nil
72 ;; "Theme song for Gnus.")
73 ;;(defvar gnus-audio-enter-group nil
74 ;; "Sound effect played when selecting a group.")
75 ;;(defvar gnus-audio-exit-group nil
76 ;; "Sound effect played when exiting a group.")
77 ;;(defvar gnus-audio-score-group nil
78 ;; "Sound effect played when scoring a group.")
79 ;;(defvar gnus-audio-busy-sound nil
80 ;; "Sound effect played when going into a ... sequence.")
84 ;;(defun gnus-audio-enable-sound ()
85 ;; "Enable Sound Effects for Gnus."
87 ;; (setq gnus-audio-effects-enabled t)
88 ;; (gnus-run-hooks gnus-audio-enable-hooks))
91 ;(defun gnus-audio-disable-sound ()
92 ;; "Disable Sound Effects for Gnus."
94 ;; (setq gnus-audio-effects-enabled nil)
95 ;; (gnus-run-hooks gnus-audio-disable-hooks))
98 (defun gnus-audio-play (file)
99 "Play a sound FILE through the speaker."
100 (interactive "fSound file name: ")
101 (let ((sound-file (if (file-exists-p file)
103 (expand-file-name file gnus-audio-directory))))
104 (when (file-exists-p sound-file)
105 (cond ((and gnus-audio-inline-sound
107 ;; Even if we have audio, we may fail with the
108 ;; wrong sort of sound file.
109 (progn (play-sound-file sound-file)
112 ;; If we don't have built-in sound, or playing it failed,
113 ;; try with external program.
114 ((equal "wav" (file-name-extension sound-file))
115 (call-process gnus-audio-wav-player
120 ((equal "au" (file-name-extension sound-file))
121 (call-process gnus-audio-au-player
128 ;;; The following isn't implemented yet, wait for Red Gnus
129 ;;(defun gnus-audio-startrek-sounds ()
130 ;; "Enable sounds from Star Trek the original series."
132 ;; (setq gnus-audio-busy-sound "working.au")
133 ;; (setq gnus-audio-enter-group "bulkhead_door.au")
134 ;; (setq gnus-audio-exit-group "bulkhead_door.au")
135 ;; (setq gnus-audio-score-group "ST_laser.au")
136 ;; (setq gnus-audio-theme-song "startrek.au")
137 ;; (add-hook 'gnus-select-group-hook 'gnus-audio-startrek-select-group)
138 ;; (add-hook 'gnus-exit-group-hook 'gnus-audio-startrek-exit-group))
141 (defvar gnus-startup-jingle "Tuxedomoon.Jingle4.au"
142 "Name of the Gnus startup jingle file.")
144 (defun gnus-play-jingle ()
145 "Play the Gnus startup jingle, unless that's inhibited."
147 (gnus-audio-play gnus-startup-jingle))
149 (provide 'gnus-audio)
151 (run-hooks 'gnus-audio-load-hook)
153 ;;; gnus-audio.el ends here