-
Notifications
You must be signed in to change notification settings - Fork 38
Expand file tree
/
Copy pathsound.html
More file actions
467 lines (388 loc) · 42.4 KB
/
Copy pathsound.html
File metadata and controls
467 lines (388 loc) · 42.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>engines.sound — Source.Python v742 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../_static/classic.css?v=2780edc4" />
<script src="../../_static/documentation_options.js?v=12c636f2"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../../_static/sp_wiki_favicon.png"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v742 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
<li class="nav-item nav-item-this"><a href="">engines.sound</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for engines.sound</h1><div class="highlight"><pre>
<span></span><span class="c1"># ../engines/sound.py</span>
<span class="sd">"""Provides access to the Sound and StreamSound interfaces."""</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> IMPORTS</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># Python Imports</span>
<span class="c1"># Contextlib</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">contextlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">closing</span>
<span class="c1"># Enum</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">enum</span><span class="w"> </span><span class="kn">import</span> <span class="n">Enum</span>
<span class="c1"># Os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="c1"># Wave</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">wave</span>
<span class="c1"># Site Package Imports</span>
<span class="c1"># Mutagen</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">mutagen</span><span class="w"> </span><span class="kn">import</span> <span class="n">mp3</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">mutagen</span><span class="w"> </span><span class="kn">import</span> <span class="n">oggvorbis</span>
<span class="c1"># Source.Python Imports</span>
<span class="c1"># Engines</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">engines</span><span class="w"> </span><span class="kn">import</span> <span class="n">engines_logger</span>
<span class="c1"># Entities</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">entities.constants</span><span class="w"> </span><span class="kn">import</span> <span class="n">INVALID_ENTITY_INDEX</span>
<span class="c1"># Filesystem</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">filesystem</span><span class="w"> </span><span class="kn">import</span> <span class="n">SourceFile</span>
<span class="c1"># Mathlib</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">mathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">NULL_VECTOR</span>
<span class="c1"># Paths</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">paths</span><span class="w"> </span><span class="kn">import</span> <span class="n">GAME_PATH</span>
<span class="c1"># Stringtables</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">stringtables</span><span class="w"> </span><span class="kn">import</span> <span class="n">INVALID_STRING_INDEX</span><span class="p">,</span> <span class="n">string_tables</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">stringtables.downloads</span><span class="w"> </span><span class="kn">import</span> <span class="n">Downloadables</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> FORWARD IMPORTS</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># Source.Python Imports</span>
<span class="c1"># Engines</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">Channel</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">VOL_NORM</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">ATTN_NONE</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">ATTN_NORM</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">ATTN_IDLE</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">ATTN_STATIC</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">ATTN_RICOCHET</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">ATTN_GUNFIRE</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">MAX_ATTENUATION</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">SoundFlags</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">Pitch</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">SOUND_FROM_LOCAL_PLAYER</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">SOUND_FROM_WORLD</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">_engines._sound</span><span class="w"> </span><span class="kn">import</span> <span class="n">engine_sound</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> ALL DECLARATION</span>
<span class="c1"># =============================================================================</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'Attenuation'</span><span class="p">,</span>
<span class="s1">'Channel'</span><span class="p">,</span>
<span class="s1">'Pitch'</span><span class="p">,</span>
<span class="s1">'SOUND_FROM_LOCAL_PLAYER'</span><span class="p">,</span>
<span class="s1">'SOUND_FROM_WORLD'</span><span class="p">,</span>
<span class="s1">'Sound'</span><span class="p">,</span>
<span class="s1">'SoundFlags'</span><span class="p">,</span>
<span class="s1">'StreamSound'</span><span class="p">,</span>
<span class="s1">'VOL_NORM'</span><span class="p">,</span>
<span class="s1">'engine_sound'</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> GLOBAL VARIABLES</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># Get the sp.engines.sound logger</span>
<span class="n">engines_sound_logger</span> <span class="o">=</span> <span class="n">engines_logger</span><span class="o">.</span><span class="n">sound</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> ENUMERATORS</span>
<span class="c1"># =============================================================================</span>
<div class="viewcode-block" id="Attenuation">
<a class="viewcode-back" href="../../developing/modules/engines.sound.html#engines.sound.Attenuation">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Attenuation</span><span class="p">(</span><span class="nb">float</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Attenuation values wrapper enumerator."""</span>
<span class="n">NONE</span> <span class="o">=</span> <span class="n">ATTN_NONE</span>
<span class="n">NORMAL</span> <span class="o">=</span> <span class="n">ATTN_NORM</span>
<span class="n">IDLE</span> <span class="o">=</span> <span class="n">ATTN_IDLE</span>
<span class="n">STATIC</span> <span class="o">=</span> <span class="n">ATTN_STATIC</span>
<span class="n">RICOCHET</span> <span class="o">=</span> <span class="n">ATTN_RICOCHET</span>
<span class="n">GUNFIRE</span> <span class="o">=</span> <span class="n">ATTN_GUNFIRE</span>
<span class="n">MAXIMUM</span> <span class="o">=</span> <span class="n">MAX_ATTENUATION</span></div>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> CLASSES</span>
<span class="c1"># =============================================================================</span>
<span class="k">class</span><span class="w"> </span><span class="nc">_BaseSound</span><span class="p">:</span>
<span class="w"> </span><span class="sd">"""Base class for sound classes."""</span>
<span class="c1"># Set the base _downloads attribute to know whether</span>
<span class="c1"># or not the sample was added to the downloadables</span>
<span class="n">_downloads</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">sample</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">SOUND_FROM_WORLD</span><span class="p">,</span> <span class="n">volume</span><span class="o">=</span><span class="n">VOL_NORM</span><span class="p">,</span>
<span class="n">attenuation</span><span class="o">=</span><span class="n">Attenuation</span><span class="o">.</span><span class="n">NONE</span><span class="p">,</span> <span class="n">channel</span><span class="o">=</span><span class="n">Channel</span><span class="o">.</span><span class="n">AUTO</span><span class="p">,</span>
<span class="n">flags</span><span class="o">=</span><span class="n">SoundFlags</span><span class="o">.</span><span class="n">NO_FLAGS</span><span class="p">,</span> <span class="n">pitch</span><span class="o">=</span><span class="n">Pitch</span><span class="o">.</span><span class="n">NORMAL</span><span class="p">,</span>
<span class="n">origin</span><span class="o">=</span><span class="n">NULL_VECTOR</span><span class="p">,</span> <span class="n">direction</span><span class="o">=</span><span class="n">NULL_VECTOR</span><span class="p">,</span> <span class="n">origins</span><span class="o">=</span><span class="p">(),</span>
<span class="n">update_positions</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">sound_time</span><span class="o">=</span><span class="mf">0.0</span><span class="p">,</span>
<span class="n">speaker_entity</span><span class="o">=</span><span class="n">INVALID_ENTITY_INDEX</span><span class="p">,</span> <span class="n">download</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Store all the given attributes and set the module for unloading.</span>
<span class="sd"> :param str sample:</span>
<span class="sd"> Path to the sound file.</span>
<span class="sd"> :param int index:</span>
<span class="sd"> An entity index to play the sound from. Use</span>
<span class="sd"> :data:`SOUND_FROM_WORLD` if you want to play the sound from the</span>
<span class="sd"> world.</span>
<span class="sd"> :param float volume:</span>
<span class="sd"> Volume to play the sound with.</span>
<span class="sd"> :param Attenuation attenuation:</span>
<span class="sd"> Define how the sound attenuates.</span>
<span class="sd"> :param Channel channel:</span>
<span class="sd"> Channel to use when playing the sound.</span>
<span class="sd"> :param SoundFlags flags:</span>
<span class="sd"> :param Pitch pitch:</span>
<span class="sd"> Pitch of the sound.</span>
<span class="sd"> :param Vector origin:</span>
<span class="sd"> Location to play the sound from.</span>
<span class="sd"> :param Vector direction:</span>
<span class="sd"> Direction to play the sound.</span>
<span class="sd"> :param tuple origins:</span>
<span class="sd"> Locations to play the sound from.</span>
<span class="sd"> :param bool update_positions:</span>
<span class="sd"> :param float sound_time:</span>
<span class="sd"> :param int speaker_entity:</span>
<span class="sd"> :param bool download:</span>
<span class="sd"> If ``True`` the sound file will be added to the ``downloadables``</span>
<span class="sd"> list.</span>
<span class="sd"> """</span>
<span class="c1"># Set sample as a private attribute, since it should never change</span>
<span class="c1"># Added replacing \ with / in paths for comformity</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_sample</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_duration</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1"># Set all the base attributes</span>
<span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">=</span> <span class="n">index</span>
<span class="bp">self</span><span class="o">.</span><span class="n">volume</span> <span class="o">=</span> <span class="n">volume</span>
<span class="bp">self</span><span class="o">.</span><span class="n">attenuation</span> <span class="o">=</span> <span class="n">attenuation</span>
<span class="bp">self</span><span class="o">.</span><span class="n">channel</span> <span class="o">=</span> <span class="n">channel</span>
<span class="bp">self</span><span class="o">.</span><span class="n">flags</span> <span class="o">=</span> <span class="n">flags</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pitch</span> <span class="o">=</span> <span class="n">pitch</span>
<span class="bp">self</span><span class="o">.</span><span class="n">origin</span> <span class="o">=</span> <span class="n">origin</span>
<span class="bp">self</span><span class="o">.</span><span class="n">direction</span> <span class="o">=</span> <span class="n">direction</span>
<span class="bp">self</span><span class="o">.</span><span class="n">origins</span> <span class="o">=</span> <span class="n">origins</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_positions</span> <span class="o">=</span> <span class="n">update_positions</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sound_time</span> <span class="o">=</span> <span class="n">sound_time</span>
<span class="bp">self</span><span class="o">.</span><span class="n">speaker_entity</span> <span class="o">=</span> <span class="n">speaker_entity</span>
<span class="c1"># Should the sample be downloaded by clients?</span>
<span class="k">if</span> <span class="n">download</span><span class="p">:</span>
<span class="c1"># Add the sample to Downloadables</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_downloads</span> <span class="o">=</span> <span class="n">Downloadables</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_downloads</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">relative_path</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">play</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">recipients</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Play the sound.</span>
<span class="sd"> :param recipients:</span>
<span class="sd"> Players who will hear the sound.</span>
<span class="sd"> """</span>
<span class="c1"># Done here to fix a cyclic import...</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">filters.recipients</span><span class="w"> </span><span class="kn">import</span> <span class="n">RecipientFilter</span>
<span class="c1"># Get the recipients to play the sound to</span>
<span class="n">recipients</span> <span class="o">=</span> <span class="n">RecipientFilter</span><span class="p">(</span><span class="o">*</span><span class="n">recipients</span><span class="p">)</span>
<span class="c1"># Is the sound precached?</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_precached</span><span class="p">:</span>
<span class="c1"># Precache the sound</span>
<span class="bp">self</span><span class="o">.</span><span class="n">precache</span><span class="p">()</span>
<span class="c1"># Play the sound</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_play</span><span class="p">(</span><span class="n">recipients</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">channel</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Stop a sound from being played."""</span>
<span class="c1"># Was an index passed in?</span>
<span class="k">if</span> <span class="n">index</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Use the instance's index</span>
<span class="n">index</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span>
<span class="c1"># Was a channel passed in?</span>
<span class="k">if</span> <span class="n">channel</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Use the instance's index</span>
<span class="n">channel</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">channel</span>
<span class="c1"># Stop the sound</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_stop</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">channel</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_play</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">recipients</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Play the sound (internal)."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">channel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Stop a sound from being played (internal)."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
<span class="k">def</span><span class="w"> </span><span class="nf">precache</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Precache the sample."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">is_precached</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return whether or not the sample is precached."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">sample</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return the filename of the Sound instance.</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sample</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">extension</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return the type of sound.</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">full_path</span><span class="o">.</span><span class="n">suffix</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">full_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return the full path to the file.</span>
<span class="sd"> :rtype: path.Path</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">GAME_PATH</span> <span class="o">/</span> <span class="s1">'sound'</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">sample</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">relative_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return the relative path to the file.</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="s1">'sound'</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">sample</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">duration</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return the duration of the sample.</span>
<span class="sd"> :rtype: float</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_duration</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_duration</span>
<span class="k">with</span> <span class="n">closing</span><span class="p">(</span><span class="n">SourceFile</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">relative_path</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">))</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">extension</span> <span class="o">==</span> <span class="s1">'ogg'</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">oggvorbis</span><span class="o">.</span><span class="n">Open</span><span class="p">(</span><span class="n">f</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="o">.</span><span class="n">length</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">extension</span> <span class="o">==</span> <span class="s1">'mp3'</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">mp3</span><span class="o">.</span><span class="n">Open</span><span class="p">(</span><span class="n">f</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="o">.</span><span class="n">length</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">extension</span> <span class="o">==</span> <span class="s1">'wav'</span><span class="p">:</span>
<span class="k">with</span> <span class="n">closing</span><span class="p">(</span><span class="n">wave</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">f</span><span class="p">))</span> <span class="k">as</span> <span class="n">open_file</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">open_file</span><span class="o">.</span><span class="n">getnframes</span><span class="p">()</span> <span class="o">/</span> <span class="n">open_file</span><span class="o">.</span><span class="n">getframerate</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
<span class="s1">'Sound extension "</span><span class="si">{extension}</span><span class="s1">" is not supported.'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">extension</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">extension</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_duration</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">return</span> <span class="n">value</span>
<div class="viewcode-block" id="Sound">
<a class="viewcode-back" href="../../developing/modules/engines.sound.html#engines.sound.Sound">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Sound</span><span class="p">(</span><span class="n">_BaseSound</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Class used to interact with precached sounds.</span>
<span class="sd"> .. note::</span>
<span class="sd"> On some engines (e.g. CS:GO) server is unable to precache the sound,</span>
<span class="sd"> thus the sound won't be played. StreamSound is recommended in that case.</span>
<span class="sd"> However, sounds located in sound/music/ directory are always streamed</span>
<span class="sd"> on those engines, and this class will be able to play them.</span>
<span class="sd"> """</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_play</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">recipients</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Play the sound (internal)."""</span>
<span class="n">engine_sound</span><span class="o">.</span><span class="n">emit_sound</span><span class="p">(</span>
<span class="n">recipients</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">channel</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sample</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">volume</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">attenuation</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">flags</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pitch</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">origin</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">direction</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">origins</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_positions</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sound_time</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">speaker_entity</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">channel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Stop a sound from being played (internal)."""</span>
<span class="n">engine_sound</span><span class="o">.</span><span class="n">stop_sound</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">channel</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sample</span><span class="p">)</span>
<div class="viewcode-block" id="Sound.precache">
<a class="viewcode-back" href="../../developing/modules/engines.sound.html#engines.sound.Sound.precache">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">precache</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Precache the sample."""</span>
<span class="n">engine_sound</span><span class="o">.</span><span class="n">precache_sound</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sample</span><span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">is_precached</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return whether or not the sample is precached.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="c1"># We can't use engine_sound.is_sound_precached here because it always</span>
<span class="c1"># returns True.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">sample</span> <span class="ow">in</span> <span class="n">string_tables</span><span class="o">.</span><span class="n">soundprecache</span></div>
<div class="viewcode-block" id="StreamSound">
<a class="viewcode-back" href="../../developing/modules/engines.sound.html#engines.sound.StreamSound">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">StreamSound</span><span class="p">(</span><span class="n">_BaseSound</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Class used to interact with streamed sounds.</span>
<span class="sd"> .. note::</span>
<span class="sd"> This class is a recommended choice on some engines (e.g. CS:GO),</span>
<span class="sd"> however, it's unable to play *.wav-files.</span>
<span class="sd"> .. note::</span>
<span class="sd"> On some engines (e.g. CS:GO) files that are located in sound/music/</span>
<span class="sd"> directory are already streamed, so simple Sound class can be used</span>
<span class="sd"> instead.</span>
<span class="sd"> """</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_stream_sample</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return the streamed sample path of the Sound instance."""</span>
<span class="k">return</span> <span class="s2">"*/</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sample</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_play</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">recipients</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Play the sound (internal)."""</span>
<span class="n">engine_sound</span><span class="o">.</span><span class="n">emit_sound</span><span class="p">(</span>
<span class="n">recipients</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">channel</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stream_sample</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">volume</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">attenuation</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">flags</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pitch</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">origin</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">direction</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">origins</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_positions</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sound_time</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">speaker_entity</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">channel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Stop a sound from being played (internal)."""</span>
<span class="n">engine_sound</span><span class="o">.</span><span class="n">stop_sound</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">channel</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stream_sample</span><span class="p">)</span>
<div class="viewcode-block" id="StreamSound.precache">
<a class="viewcode-back" href="../../developing/modules/engines.sound.html#engines.sound.StreamSound.precache">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">precache</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Precache the sample."""</span>
<span class="n">string_tables</span><span class="o">.</span><span class="n">soundprecache</span><span class="o">.</span><span class="n">add_string</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_stream_sample</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stream_sample</span><span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">is_precached</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return whether or not the sample is precached.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="c1"># We can't use engine_sound.is_sound_precached here because it always</span>
<span class="c1"># returns True.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stream_sample</span> <span class="ow">in</span> <span class="n">string_tables</span><span class="o">.</span><span class="n">soundprecache</span></div>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/sp_wiki_banner.png" alt="Logo of Source.Python"/>
</a></p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v742 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-this"><a href="">engines.sound</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2025, Source.Python Development Team.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>