Skip to content

Commit 05619b5

Browse files
author
KirillMysnik
committed
Added StreamSound support
1 parent 7b3b44e commit 05619b5

File tree

4 files changed

+183
-75
lines changed

4 files changed

+183
-75
lines changed

‎addons/source-python/packages/source-python/engines/sound/__init__.py‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# ../engines/sound/__init__.py
2+
3+
"""Provides access to the Sound and StreamSound interfaces."""
4+
5+
# =============================================================================
6+
# >> IMPORTS
7+
# =============================================================================
8+
# Python Imports
9+
# Enum
10+
from enum import Enum
11+
12+
# Source.Python Imports
13+
# Engines
14+
from engines import engines_logger
15+
16+
17+
# =============================================================================
18+
# >> FORWARD IMPORTS
19+
# =============================================================================
20+
# Source.Python Imports
21+
# Engines
22+
from _engines._sound import Channel
23+
from _engines._sound import VOL_NORM
24+
from _engines._sound import ATTN_NONE
25+
from _engines._sound import ATTN_NORM
26+
from _engines._sound import ATTN_IDLE
27+
from _engines._sound import ATTN_STATIC
28+
from _engines._sound import ATTN_RICOCHET
29+
from _engines._sound import ATTN_GUNFIRE
30+
from _engines._sound import MAX_ATTENUATION
31+
from _engines._sound import SoundFlags
32+
from _engines._sound import Pitch
33+
from _engines._sound import SOUND_FROM_LOCAL_PLAYER
34+
from _engines._sound import SOUND_FROM_WORLD
35+
from _engines._sound import engine_sound
36+
37+
38+
# =============================================================================
39+
# >> ALL DECLARATION
40+
# =============================================================================
41+
__all__ = ('Attenuation',
42+
'Channel',
43+
'Pitch',
44+
'SOUND_FROM_LOCAL_PLAYER',
45+
'SOUND_FROM_WORLD',
46+
'Sound',
47+
'SoundFlags',
48+
'StreamSound',
49+
'VOL_NORM',
50+
'engine_sound',
51+
)
52+
53+
54+
# =============================================================================
55+
# >> GLOBAL VARIABLES
56+
# =============================================================================
57+
# Get the sp.engines.sound logger
58+
engines_sound_logger = engines_logger.sound
59+
60+
61+
# =============================================================================
62+
# >> ENUMERATORS
63+
# =============================================================================
64+
class Attenuation(float, Enum):
65+
"""Attenuation values wrapper enumerator."""
66+
67+
NONE = ATTN_NONE
68+
NORMAL = ATTN_NORM
69+
IDLE = ATTN_IDLE
70+
STATIC = ATTN_STATIC
71+
RICOCHET = ATTN_RICOCHET
72+
GUNFIRE = ATTN_GUNFIRE
73+
MAXIMUM = MAX_ATTENUATION
74+
75+
76+
from engines.sound.sound import Sound
77+
from engines.sound.stream import StreamSound

addons/source-python/packages/source-python/engines/sound.py renamed to addons/source-python/packages/source-python/engines/sound/base.py

Lines changed: 22 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,35 @@
1-
# ../engines/sound.py
1+
# ../engines/sound/base.py
22

3-
"""Provides access to the Sound interface."""
3+
"""Provides access to the _BaseSound interface."""
44

55
# =============================================================================
66
# >> IMPORTS
77
# =============================================================================
8-
# Python Imports
9-
# Enum
10-
from enum import Enum
11-
128
# Source.Python Imports
139
# Core
1410
from core import AutoUnload
1511
# Engines
16-
from engines import engines_logger
12+
from engines.sound import Attenuation
13+
from engines.sound import Channel
14+
from engines.sound import engine_sound
15+
from engines.sound import Pitch
16+
from engines.sound import SOUND_FROM_WORLD
17+
from engines.sound import SoundFlags
18+
from engines.sound import VOL_NORM
1719
# Entities
1820
from entities.constants import INVALID_ENTITY_INDEX
1921
# Filters
2022
from filters.recipients import RecipientFilter
2123
# Mathlib
2224
from mathlib import NULL_VECTOR
2325
# Stringtables
24-
from stringtables import string_tables
2526
from stringtables.downloads import Downloadables
2627

2728

28-
# =============================================================================
29-
# >> FORWARD IMPORTS
30-
# =============================================================================
31-
# Source.Python Imports
32-
# Engines
33-
from _engines._sound import Channel
34-
from _engines._sound import VOL_NORM
35-
from _engines._sound import ATTN_NONE
36-
from _engines._sound import ATTN_NORM
37-
from _engines._sound import ATTN_IDLE
38-
from _engines._sound import ATTN_STATIC
39-
from _engines._sound import ATTN_RICOCHET
40-
from _engines._sound import ATTN_GUNFIRE
41-
from _engines._sound import MAX_ATTENUATION
42-
from _engines._sound import SoundFlags
43-
from _engines._sound import Pitch
44-
from _engines._sound import SOUND_FROM_LOCAL_PLAYER
45-
from _engines._sound import SOUND_FROM_WORLD
46-
from _engines._sound import engine_sound
47-
48-
49-
# =============================================================================
50-
# >> ALL DECLARATION
51-
# =============================================================================
52-
__all__ = ('Attenuation',
53-
'Channel',
54-
'Pitch',
55-
'SOUND_FROM_LOCAL_PLAYER',
56-
'SOUND_FROM_WORLD',
57-
'Sound',
58-
'SoundFlags',
59-
'VOL_NORM',
60-
'engine_sound',
61-
)
62-
63-
64-
# =============================================================================
65-
# >> GLOBAL VARIABLES
66-
# =============================================================================
67-
# Get the sp.engines.sound logger
68-
engines_sound_logger = engines_logger.sound
69-
70-
71-
# =============================================================================
72-
# >> ENUMERATORS
73-
# =============================================================================
74-
class Attenuation(float, Enum):
75-
"""Attenuation values wrapper enumerator."""
76-
77-
NONE = ATTN_NONE
78-
NORMAL = ATTN_NORM
79-
IDLE = ATTN_IDLE
80-
STATIC = ATTN_STATIC
81-
RICOCHET = ATTN_RICOCHET
82-
GUNFIRE = ATTN_GUNFIRE
83-
MAXIMUM = MAX_ATTENUATION
84-
85-
8629
# =============================================================================
8730
# >> CLASSES
8831
# =============================================================================
89-
class Sound(AutoUnload):
32+
class _BaseSound(AutoUnload):
9033
"""Class used to interact with a specific sound file."""
9134

9235
# Set the base _downloads attribute to know whether
@@ -138,11 +81,7 @@ def play(self, *recipients):
13881
self.precache()
13982

14083
# Play the sound
141-
engine_sound.emit_sound(
142-
recipients, self.index, self.channel, self.sample,
143-
self.volume, self.attenuation, self.flags, self.pitch,
144-
self.origin, self.direction, self.origins,
145-
self.update_positions, self.sound_time, self.speaker_entity)
84+
self._play(recipients)
14685

14786
def stop(self, index=None, channel=None):
14887
"""Stop a sound from being played."""
@@ -159,16 +98,24 @@ def stop(self, index=None, channel=None):
15998
channel = self.channel
16099

161100
# Stop the sound
162-
engine_sound.stop_sound(index, channel, self.sample)
101+
self._stop(index, channel)
102+
103+
def _play(self, recipients):
104+
"""Play the sound (internal)."""
105+
raise NotImplementedError
106+
107+
def _stop(self, index, channel):
108+
"""Stop a sound from being played (internal)."""
109+
raise NotImplementedError
163110

164111
def precache(self):
165112
"""Precache the sample."""
166-
engine_sound.precache_sound(self.sample)
113+
raise NotImplementedError
167114

168115
@property
169116
def is_precached(self):
170117
"""Return whether or not the sample is precached."""
171-
return self.sample in string_tables.soundprecache
118+
raise NotImplementedError
172119

173120
@property
174121
def sample(self):

‎addons/source-python/packages/source-python/engines/sound/sound.py‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# ../engines/sound/sound.py
2+
3+
"""Provides access to the Sound interface."""
4+
5+
# =============================================================================
6+
# >> IMPORTS
7+
# =============================================================================
8+
# Source.Python Imports
9+
# Engines
10+
from engines.sound import engine_sound
11+
from engines.sound.base import _BaseSound
12+
# Stringtables
13+
from stringtables import string_tables
14+
15+
16+
# =============================================================================
17+
# >> CLASSES
18+
# =============================================================================
19+
class Sound(_BaseSound):
20+
def _play(self, recipients):
21+
"""Play the sound (internal)."""
22+
engine_sound.emit_sound(
23+
recipients, self.index, self.channel, self.sample,
24+
self.volume, self.attenuation, self.flags, self.pitch,
25+
self.origin, self.direction, self.origins,
26+
self.update_positions, self.sound_time, self.speaker_entity)
27+
28+
def _stop(self, index, channel):
29+
"""Stop a sound from being played (internal)."""
30+
engine_sound.stop_sound(index, channel, self.sample)
31+
32+
def precache(self):
33+
"""Precache the sample."""
34+
engine_sound.precache_sound(self.sample)
35+
36+
@property
37+
def is_precached(self):
38+
"""Return whether or not the sample is precached."""
39+
return self.sample in string_tables.soundprecache

‎addons/source-python/packages/source-python/engines/sound/stream.py‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# ../engines/sound/stream.py
2+
3+
"""Provides access to the StreamSound interface."""
4+
5+
# =============================================================================
6+
# >> IMPORTS
7+
# =============================================================================
8+
# Source.Python Imports
9+
# Engines
10+
from engines.sound import engine_sound
11+
from engines.sound.base import _BaseSound
12+
# Stringtables
13+
from stringtables import string_tables
14+
15+
16+
# =============================================================================
17+
# >> CLASSES
18+
# =============================================================================
19+
class StreamSound(_BaseSound):
20+
@property
21+
def _stream_sample(self):
22+
"""Return the streamed sample path of the Sound instance."""
23+
return "*/{}".format(self.sample)
24+
25+
def _play(self, recipients):
26+
"""Play the sound (internal)."""
27+
engine_sound.emit_sound(
28+
recipients, self.index, self.channel, self._stream_sample,
29+
self.volume, self.attenuation, self.flags, self.pitch,
30+
self.origin, self.direction, self.origins,
31+
self.update_positions, self.sound_time, self.speaker_entity)
32+
33+
def _stop(self, index, channel):
34+
"""Stop a sound from being played (internal)."""
35+
engine_sound.stop_sound(index, channel, self._stream_sample)
36+
37+
def precache(self):
38+
"""Precache the sample."""
39+
string_tables.soundprecache.add_string(
40+
self._stream_sample, self._stream_sample)
41+
42+
@property
43+
def is_precached(self):
44+
"""Return whether or not the sample is precached."""
45+
return self._stream_sample in string_tables.soundprecache

0 commit comments

Comments
 (0)