Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 1 | /* Author: Toby Dickenson <htrd90@zepler.org> |
| 2 | * |
| 3 | * Copyright (c) 1999 Toby Dickenson |
| 4 | * |
| 5 | * Permission to use this software in any way is granted without |
| 6 | * fee, provided that the copyright notice above appears in all |
| 7 | * copies. This software is provided "as is" without any warranty. |
| 8 | */ |
| 9 | |
| 10 | /* Modified by Guido van Rossum */ |
Guido van Rossum | 99eb7a1 | 1999-10-01 14:29:17 +0000 | [diff] [blame] | 11 | /* Beep added by Mark Hammond */ |
Tim Peters | 25a9ce3 | 2001-02-19 07:06:36 +0000 | [diff] [blame] | 12 | /* Win9X Beep and platform identification added by Uncle Timmy */ |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 13 | |
| 14 | /* Example: |
| 15 | |
| 16 | import winsound |
| 17 | import time |
| 18 | |
Tim Peters | 25a9ce3 | 2001-02-19 07:06:36 +0000 | [diff] [blame] | 19 | # Play wav file |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 20 | winsound.PlaySound('c:/windows/media/Chord.wav', winsound.SND_FILENAME) |
| 21 | |
| 22 | # Play sound from control panel settings |
| 23 | winsound.PlaySound('SystemQuestion', winsound.SND_ALIAS) |
| 24 | |
| 25 | # Play wav file from memory |
| 26 | data=open('c:/windows/media/Chimes.wav',"rb").read() |
| 27 | winsound.PlaySound(data, winsound.SND_MEMORY) |
| 28 | |
| 29 | # Start playing the first bit of wav file asynchronously |
| 30 | winsound.PlaySound('c:/windows/media/Chord.wav', |
| 31 | winsound.SND_FILENAME|winsound.SND_ASYNC) |
| 32 | # But dont let it go for too long... |
| 33 | time.sleep(0.1) |
| 34 | # ...Before stopping it |
| 35 | winsound.PlaySound(None, 0) |
| 36 | */ |
| 37 | |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 38 | #include <Python.h> |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 39 | #include <windows.h> |
| 40 | #include <mmsystem.h> |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 41 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 42 | PyDoc_STRVAR(sound_module_doc, |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 43 | "PlaySound(sound, flags) - play a sound\n" |
| 44 | "SND_FILENAME - sound is a wav file name\n" |
Tim Peters | e79af27 | 2001-02-20 10:02:21 +0000 | [diff] [blame] | 45 | "SND_ALIAS - sound is a registry sound association name\n" |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 46 | "SND_LOOP - Play the sound repeatedly; must also specify SND_ASYNC\n" |
| 47 | "SND_MEMORY - sound is a memory image of a wav file\n" |
| 48 | "SND_PURGE - stop all instances of the specified sound\n" |
| 49 | "SND_ASYNC - PlaySound returns immediately\n" |
| 50 | "SND_NODEFAULT - Do not play a default beep if the sound can not be found\n" |
| 51 | "SND_NOSTOP - Do not interrupt any sounds currently playing\n" // Raising RuntimeError if needed |
| 52 | "SND_NOWAIT - Return immediately if the sound driver is busy\n" // Without any errors |
Guido van Rossum | 99eb7a1 | 1999-10-01 14:29:17 +0000 | [diff] [blame] | 53 | "\n" |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 54 | "Beep(frequency, duration) - Make a beep through the PC speaker.\n" |
| 55 | "MessageBeep(x) - Call Windows MessageBeep."); |
| 56 | |
| 57 | /*[clinic input] |
| 58 | module winsound |
| 59 | [clinic start generated code]*/ |
| 60 | /*[clinic end generated code: output=da39a3ee5e6b4b0d input=a18401142d97b8d5]*/ |
| 61 | |
| 62 | #include "clinic/winsound.c.h" |
| 63 | |
| 64 | /*[clinic input] |
| 65 | winsound.PlaySound |
| 66 | |
Zachary Ware | 77772c0 | 2015-05-13 10:58:35 -0500 | [diff] [blame] | 67 | sound: Py_UNICODE(accept={str, NoneType}) |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 68 | The sound to play; a filename, data, or None. |
| 69 | flags: int |
| 70 | Flag values, ored together. See module documentation. |
| 71 | / |
| 72 | |
| 73 | A wrapper around the Windows PlaySound API. |
| 74 | [clinic start generated code]*/ |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 75 | |
Walter Dörwald | fee10040 | 2003-05-22 17:22:54 +0000 | [diff] [blame] | 76 | static PyObject * |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 77 | winsound_PlaySound_impl(PyModuleDef *module, Py_UNICODE *sound, int flags) |
Zachary Ware | 77772c0 | 2015-05-13 10:58:35 -0500 | [diff] [blame] | 78 | /*[clinic end generated code: output=614273784bf59e5c input=3411b1b7c1f36d93]*/ |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 79 | { |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 80 | int ok; |
| 81 | |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 82 | if (flags & SND_ASYNC && flags & SND_MEMORY) { |
| 83 | /* Sidestep reference counting headache; unfortunately this also |
| 84 | prevent SND_LOOP from memory. */ |
| 85 | PyErr_SetString(PyExc_RuntimeError, |
| 86 | "Cannot play asynchronously from memory"); |
| 87 | return NULL; |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 88 | } |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 89 | |
| 90 | Py_BEGIN_ALLOW_THREADS |
| 91 | ok = PlaySoundW(sound, NULL, flags); |
| 92 | Py_END_ALLOW_THREADS |
| 93 | if (!ok) { |
| 94 | PyErr_SetString(PyExc_RuntimeError, "Failed to play sound"); |
| 95 | return NULL; |
| 96 | } |
| 97 | Py_RETURN_NONE; |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 98 | } |
| 99 | |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 100 | /*[clinic input] |
| 101 | winsound.Beep |
| 102 | |
| 103 | frequency: int |
| 104 | Frequency of the sound in hertz. |
| 105 | Must be in the range 37 through 32,767. |
| 106 | duration: int |
| 107 | How long the sound should play, in milliseconds. |
| 108 | / |
| 109 | |
| 110 | A wrapper around the Windows Beep API. |
| 111 | [clinic start generated code]*/ |
| 112 | |
Tim Peters | 25a9ce3 | 2001-02-19 07:06:36 +0000 | [diff] [blame] | 113 | static PyObject * |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 114 | winsound_Beep_impl(PyModuleDef *module, int frequency, int duration) |
| 115 | /*[clinic end generated code: output=c75f282035a872bd input=628a99d2ddf73798]*/ |
Guido van Rossum | 99eb7a1 | 1999-10-01 14:29:17 +0000 | [diff] [blame] | 116 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 117 | BOOL ok; |
Guido van Rossum | 99eb7a1 | 1999-10-01 14:29:17 +0000 | [diff] [blame] | 118 | |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 119 | if (frequency < 37 || frequency > 32767) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 120 | PyErr_SetString(PyExc_ValueError, |
| 121 | "frequency must be in 37 thru 32767"); |
| 122 | return NULL; |
| 123 | } |
Tim Peters | 25a9ce3 | 2001-02-19 07:06:36 +0000 | [diff] [blame] | 124 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 125 | Py_BEGIN_ALLOW_THREADS |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 126 | ok = Beep(frequency, duration); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 127 | Py_END_ALLOW_THREADS |
| 128 | if (!ok) { |
| 129 | PyErr_SetString(PyExc_RuntimeError,"Failed to beep"); |
| 130 | return NULL; |
| 131 | } |
Tim Peters | 25a9ce3 | 2001-02-19 07:06:36 +0000 | [diff] [blame] | 132 | |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 133 | Py_RETURN_NONE; |
Guido van Rossum | 99eb7a1 | 1999-10-01 14:29:17 +0000 | [diff] [blame] | 134 | } |
| 135 | |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 136 | /*[clinic input] |
| 137 | winsound.MessageBeep |
| 138 | |
| 139 | x: int(c_default="MB_OK") = MB_OK |
| 140 | / |
| 141 | |
| 142 | Call Windows MessageBeep(x). |
| 143 | |
| 144 | x defaults to MB_OK. |
| 145 | [clinic start generated code]*/ |
| 146 | |
Guido van Rossum | e125268 | 2003-04-09 19:38:08 +0000 | [diff] [blame] | 147 | static PyObject * |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 148 | winsound_MessageBeep_impl(PyModuleDef *module, int x) |
| 149 | /*[clinic end generated code: output=92aa6a822bdc66ad input=a776c8a85c9853f6]*/ |
Guido van Rossum | e125268 | 2003-04-09 19:38:08 +0000 | [diff] [blame] | 150 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 151 | MessageBeep(x); |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 152 | Py_RETURN_NONE; |
Guido van Rossum | e125268 | 2003-04-09 19:38:08 +0000 | [diff] [blame] | 153 | } |
| 154 | |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 155 | static struct PyMethodDef sound_methods[] = |
| 156 | { |
Zachary Ware | 73f8cfb | 2015-05-13 01:21:21 -0500 | [diff] [blame] | 157 | WINSOUND_PLAYSOUND_METHODDEF |
| 158 | WINSOUND_BEEP_METHODDEF |
| 159 | WINSOUND_MESSAGEBEEP_METHODDEF |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 160 | {NULL, NULL} |
| 161 | }; |
| 162 | |
Tim Peters | 25a9ce3 | 2001-02-19 07:06:36 +0000 | [diff] [blame] | 163 | static void |
| 164 | add_define(PyObject *dict, const char *key, long value) |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 165 | { |
Hirokazu Yamamoto | 62fbdd9 | 2010-11-07 02:45:19 +0000 | [diff] [blame] | 166 | PyObject *k = PyUnicode_FromString(key); |
| 167 | PyObject *v = PyLong_FromLong(value); |
| 168 | if (v && k) { |
Hirokazu Yamamoto | cdc8cdd | 2010-11-07 11:07:44 +0000 | [diff] [blame] | 169 | PyDict_SetItem(dict, k, v); |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 170 | } |
| 171 | Py_XDECREF(k); |
| 172 | Py_XDECREF(v); |
| 173 | } |
| 174 | |
| 175 | #define ADD_DEFINE(tok) add_define(dict,#tok,tok) |
| 176 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 177 | |
| 178 | static struct PyModuleDef winsoundmodule = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 179 | PyModuleDef_HEAD_INIT, |
| 180 | "winsound", |
| 181 | sound_module_doc, |
| 182 | -1, |
| 183 | sound_methods, |
| 184 | NULL, |
| 185 | NULL, |
| 186 | NULL, |
| 187 | NULL |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 188 | }; |
| 189 | |
Mark Hammond | e407e2a | 2002-07-22 13:26:41 +0000 | [diff] [blame] | 190 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 191 | PyInit_winsound(void) |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 192 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 193 | PyObject *dict; |
| 194 | PyObject *module = PyModule_Create(&winsoundmodule); |
| 195 | if (module == NULL) |
| 196 | return NULL; |
| 197 | dict = PyModule_GetDict(module); |
Tim Peters | 25a9ce3 | 2001-02-19 07:06:36 +0000 | [diff] [blame] | 198 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 199 | ADD_DEFINE(SND_ASYNC); |
| 200 | ADD_DEFINE(SND_NODEFAULT); |
| 201 | ADD_DEFINE(SND_NOSTOP); |
| 202 | ADD_DEFINE(SND_NOWAIT); |
| 203 | ADD_DEFINE(SND_ALIAS); |
| 204 | ADD_DEFINE(SND_FILENAME); |
| 205 | ADD_DEFINE(SND_MEMORY); |
| 206 | ADD_DEFINE(SND_PURGE); |
| 207 | ADD_DEFINE(SND_LOOP); |
| 208 | ADD_DEFINE(SND_APPLICATION); |
Tim Peters | 25a9ce3 | 2001-02-19 07:06:36 +0000 | [diff] [blame] | 209 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 210 | ADD_DEFINE(MB_OK); |
| 211 | ADD_DEFINE(MB_ICONASTERISK); |
| 212 | ADD_DEFINE(MB_ICONEXCLAMATION); |
| 213 | ADD_DEFINE(MB_ICONHAND); |
| 214 | ADD_DEFINE(MB_ICONQUESTION); |
| 215 | return module; |
Guido van Rossum | e600578 | 1999-02-04 22:40:42 +0000 | [diff] [blame] | 216 | } |