winsound.c 7.21 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
/* Author: Toby Dickenson <htrd90@zepler.org>
 *
 * Copyright (c) 1999 Toby Dickenson
 *
 * Permission to use this software in any way is granted without
 * fee, provided that the copyright notice above appears in all
 * copies. This software is provided "as is" without any warranty.
 */

/* Modified by Guido van Rossum */
Guido van Rossum's avatar
Guido van Rossum committed
11
/* Beep added by Mark Hammond */
12
/* Win9X Beep and platform identification added by Uncle Timmy */
13 14 15 16 17 18

/* Example:

   import winsound
   import time

19
   # Play wav file
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
   winsound.PlaySound('c:/windows/media/Chord.wav', winsound.SND_FILENAME)

   # Play sound from control panel settings
   winsound.PlaySound('SystemQuestion', winsound.SND_ALIAS)

   # Play wav file from memory
   data=open('c:/windows/media/Chimes.wav',"rb").read()
   winsound.PlaySound(data, winsound.SND_MEMORY)

   # Start playing the first bit of wav file asynchronously
   winsound.PlaySound('c:/windows/media/Chord.wav',
                   winsound.SND_FILENAME|winsound.SND_ASYNC)
   # But dont let it go for too long...
   time.sleep(0.1)
   # ...Before stopping it
   winsound.PlaySound(None, 0)
*/

38
#include <Python.h>
39 40
#include <windows.h>
#include <mmsystem.h>
41
#ifdef HAVE_CONIO_H
42
#include <conio.h>	/* port functions on Win9x */
43
#endif
44

45
PyDoc_STRVAR(sound_playsound_doc,
46 47 48
"PlaySound(sound, flags) - a wrapper around the Windows PlaySound API\n"
"\n"
"The sound argument can be a filename, data, or None.\n"
49
"For flag values, ored together, see module documentation.");
50

51
PyDoc_STRVAR(sound_beep_doc,
Guido van Rossum's avatar
Guido van Rossum committed
52 53 54
"Beep(frequency, duration) - a wrapper around the Windows Beep API\n"
"\n"
"The frequency argument specifies frequency, in hertz, of the sound.\n"
55 56 57 58
"This parameter must be in the range 37 through 32,767.\n"
"The duration argument specifies the number of milliseconds.\n"
"On WinNT and 2000, the platform Beep API is used directly.  Else funky\n"
"code doing direct port manipulation is used; it's unknown whether that\n"
59
"will work on all systems.");
Guido van Rossum's avatar
Guido van Rossum committed
60

Guido van Rossum's avatar
Guido van Rossum committed
61 62 63
PyDoc_STRVAR(sound_msgbeep_doc,
"MessageBeep(x) - call Windows MessageBeep(x). x defaults to MB_OK.");

64
PyDoc_STRVAR(sound_module_doc,
65 66
"PlaySound(sound, flags) - play a sound\n"
"SND_FILENAME - sound is a wav file name\n"
67
"SND_ALIAS - sound is a registry sound association name\n"
68 69 70 71 72 73 74
"SND_LOOP - Play the sound repeatedly; must also specify SND_ASYNC\n"
"SND_MEMORY - sound is a memory image of a wav file\n"
"SND_PURGE - stop all instances of the specified sound\n"
"SND_ASYNC - PlaySound returns immediately\n"
"SND_NODEFAULT - Do not play a default beep if the sound can not be found\n"
"SND_NOSTOP - Do not interrupt any sounds currently playing\n"  // Raising RuntimeError if needed
"SND_NOWAIT - Return immediately if the sound driver is busy\n" // Without any errors
Guido van Rossum's avatar
Guido van Rossum committed
75
"\n"
76
"Beep(frequency, duration) - Make a beep through the PC speaker.");
77

78
static PyObject *
79
sound_playsound(PyObject *s, PyObject *args)
80 81 82 83 84 85
{
    const char *sound;
    int flags;
    int length;
    int ok;

86
    if(!PyArg_ParseTuple(args,"z#i:PlaySound",&sound,&length,&flags)) {
87 88 89
        return NULL;
    }

90
    if(flags&SND_ASYNC && flags &SND_MEMORY) {
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
	/* Sidestep reference counting headache; unfortunately this also
	   prevent SND_LOOP from memory. */
        PyErr_SetString(PyExc_RuntimeError,"Cannot play asynchronously from memory");
        return NULL;
    }

    Py_BEGIN_ALLOW_THREADS
    ok = PlaySound(sound,NULL,flags);
    Py_END_ALLOW_THREADS
    if(!ok)
    {
        PyErr_SetString(PyExc_RuntimeError,"Failed to play sound");
        return NULL;
    }

    Py_INCREF(Py_None);
    return Py_None;
}

110 111 112 113 114
enum OSType {Win9X, WinNT2000};
static enum OSType whichOS;	/* set by module init */

static PyObject *
sound_beep(PyObject *self, PyObject *args)
Guido van Rossum's avatar
Guido van Rossum committed
115 116 117 118 119 120
{
	int freq;
	int dur;

	if (!PyArg_ParseTuple(args, "ii:Beep", &freq,  &dur))
		return NULL;
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

	if (freq < 37 || freq > 32767) {
		PyErr_SetString(PyExc_ValueError,
				"frequency must be in 37 thru 32767");
		return NULL;
	}

	/* On NT and 2000, the SDK Beep() function does the whole job.
	 * But while Beep() exists before NT, it ignores its arguments and
	 * plays the system default sound.  Sheesh ...
	 * The Win9X code is mondo bizarre.  I (Tim) pieced it together from
	 * crap all over the web.  The original IBM PC used some particular
	 * pieces of hardware (Intel 8255 and 8254 chips) hardwired to
	 * particular port addresses and running at particular clock speeds,
	 * and the poor sound card folks have been forced to emulate that in
	 * all particulars ever since.  But NT and 2000 don't support port
137
	 * manipulation.  Don't know about WinME; guessing it's like 98.
138 139 140 141 142 143 144 145 146 147 148 149
	 */

	if (whichOS == WinNT2000) {
		BOOL ok;
		Py_BEGIN_ALLOW_THREADS
		ok = Beep(freq, dur);
		Py_END_ALLOW_THREADS
		if (!ok) {
			PyErr_SetString(PyExc_RuntimeError,"Failed to beep");
			return NULL;
		}
	}
150
#if defined(_M_IX86) && defined(HAVE_CONIO_H)
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
	else if (whichOS == Win9X) {
		int speaker_state;
		/* Force timer into oscillator mode via timer control port. */
		_outp(0x43, 0xb6);
		/* Compute ratio of ancient hardcoded timer frequency to
		 * frequency we want.  Then feed that ratio (lowest byte
		 * first) into timer data port.
		 */
		freq = 1193180 / freq;
		_outp(0x42, freq & 0xff);
		_outp(0x42, (freq >> 8) & 0xff);
		/* Get speaker control state. */
		speaker_state = _inp(0x61);
		/* Turn the speaker on (bit 1)
		 * and drive speaker from timer (bit 0).
		 */
		_outp(0x61, speaker_state | 0x3);
		/* Let it blast in peace for the duration. */
		Py_BEGIN_ALLOW_THREADS
		Sleep(dur);
		Py_END_ALLOW_THREADS
		/* Restore speaker control to original state. */
		_outp(0x61, speaker_state);
	}
175
#endif /* _M_IX86 && HAVE_CONIO_H */
176 177 178
	else {
		assert(!"winsound's whichOS has insane value");
	}
Guido van Rossum's avatar
Guido van Rossum committed
179 180 181 182
	Py_INCREF(Py_None);
	return Py_None;
}

Guido van Rossum's avatar
Guido van Rossum committed
183 184 185 186 187 188 189 190 191 192 193
static PyObject *
sound_msgbeep(PyObject *self, PyObject *args)
{
	int x = MB_OK;
	if (!PyArg_ParseTuple(args, "|i:MessageBeep", &x))
		return NULL;
	MessageBeep(x);
	Py_INCREF(Py_None);
	return Py_None;
}

194 195
static struct PyMethodDef sound_methods[] =
{
196 197
    {"PlaySound", sound_playsound, METH_VARARGS, sound_playsound_doc},
    {"Beep",      sound_beep,      METH_VARARGS, sound_beep_doc},
Guido van Rossum's avatar
Guido van Rossum committed
198
    {"MessageBeep", sound_msgbeep, METH_VARARGS, sound_msgbeep_doc},
199 200 201
    {NULL,  NULL}
};

202 203
static void
add_define(PyObject *dict, const char *key, long value)
204 205 206 207 208 209 210 211 212 213 214 215 216
{
    PyObject *k=PyString_FromString(key);
    PyObject *v=PyLong_FromLong(value);
    if(v&&k)
    {
        PyDict_SetItem(dict,k,v);
    }
    Py_XDECREF(k);
    Py_XDECREF(v);
}

#define ADD_DEFINE(tok) add_define(dict,#tok,tok)

217
PyMODINIT_FUNC
218
initwinsound(void)
219
{
220 221
	OSVERSIONINFO version;

222
	PyObject *dict;
223 224 225
	PyObject *module = Py_InitModule3("winsound",
					  sound_methods,
					  sound_module_doc);
226 227
	if (module == NULL)
		return;
228
	dict = PyModule_GetDict(module);
229 230 231 232 233 234 235 236 237 238 239 240

	ADD_DEFINE(SND_ASYNC);
	ADD_DEFINE(SND_NODEFAULT);
	ADD_DEFINE(SND_NOSTOP);
	ADD_DEFINE(SND_NOWAIT);
	ADD_DEFINE(SND_ALIAS);
	ADD_DEFINE(SND_FILENAME);
	ADD_DEFINE(SND_MEMORY);
	ADD_DEFINE(SND_PURGE);
	ADD_DEFINE(SND_LOOP);
	ADD_DEFINE(SND_APPLICATION);

Guido van Rossum's avatar
Guido van Rossum committed
241 242 243 244 245 246
	ADD_DEFINE(MB_OK);
	ADD_DEFINE(MB_ICONASTERISK);
	ADD_DEFINE(MB_ICONEXCLAMATION);
	ADD_DEFINE(MB_ICONHAND);
	ADD_DEFINE(MB_ICONQUESTION);

247 248
	version.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
	GetVersionEx(&version);
Tim Peters's avatar
Tim Peters committed
249
	whichOS = Win9X;
250 251 252
	if (version.dwPlatformId != VER_PLATFORM_WIN32s &&
	    version.dwPlatformId != VER_PLATFORM_WIN32_WINDOWS)
		whichOS = WinNT2000;
253
}