Skip to content

Rooms as objects #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
beasteers wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Rooms as objects #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9ad8423
encapsulate room
beasteers Apr 6, 2024
6aeecd6
fix sample rate, docs, unused imports
beasteers Apr 8, 2024
8d044b0
Merge branch 'main' into bea/room_class
beasteers Apr 8, 2024
140935a
merge foa changes
beasteers Apr 8, 2024
b5d6207
black
beasteers Apr 8, 2024
c335f09
fix possible bug if room/format in rir_path
beasteers Apr 8, 2024
b6f4a95
Merge branch 'main' into bea/room_class
beasteers Apr 14, 2024
23ff3ab
fix merge conflict
beasteers Apr 14, 2024
72471f5
merge main
beasteers Apr 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 18 additions & 145 deletions spatialscaper/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
save_output,
sort_matrix_by_columns,
)
from .sofa_utils import load_rir_pos, load_pos
from .room import get_room


# Sound event classes for DCASE Challenge
Expand Down Expand Up @@ -63,23 +63,6 @@
],
)

# Paths for room SOFA files
__SPATIAL_SCAPER_RIRS_DIR__ = "spatialscaper_RIRs"
__PATH_TO_AMBIENT_NOISE_FILES__ = os.path.join("source_data", "TAU-SNoise_DB")
__ROOM_RIR_FILE__ = {
"metu": "metu_sparg_em32.sofa",
"arni": "arni_{fmt}.sofa",
"bomb_shelter": "bomb_shelter_{fmt}.sofa",
"gym": "gym_{fmt}.sofa",
"pb132": "pb132_{fmt}.sofa",
"pc226": "pc226_{fmt}.sofa",
"sa203": "sa203_{fmt}.sofa",
"sc203": "sc203_{fmt}.sofa",
"se203": "se203_{fmt}.sofa",
"tb103": "tb103_{fmt}.sofa",
"tc352": "tc352_{fmt}.sofa",
}


class Scaper:
def __init__(
Expand All @@ -89,7 +72,6 @@ def __init__(
rir_dir="",
fmt="mic",
room="metu",
use_room_ambient_noise=True,
background_dir=None,
sr=24000,
DCASE_format=True,
Expand Down Expand Up @@ -137,18 +119,20 @@ def __init__(
"""

self.duration = duration
self.sr = sr

self.room = get_room(rir_dir, room, fmt=fmt)
self.foreground_dir = foreground_dir
self.background_dir = background_dir
self.rir_dir = rir_dir
self.room = room
self.use_room_ambient_noise = use_room_ambient_noise
self.format = fmt
self.sr = sr

self.DCASE_format = DCASE_format
if self.DCASE_format:
self.label_rate = __DCASE_LABEL_RATE__

self.max_sample_attempts = max_sample_attempts
self.max_event_overlap = max_event_overlap
self.max_event_dur = max_event_dur
self.speed_limit = speed_limit
self.ref_db = ref_db

self.fg_events = []
Expand All @@ -162,46 +146,15 @@ def __init__(
else:
self.fg_labels = {l: i for i, l in enumerate(fg_label_list)}

self.speed_limit = speed_limit

self.max_sample_attempts = max_sample_attempts

def get_path_to_room_ambient_noise(self):
path_to_ambient_noise_files = os.path.join(
self.rir_dir, __PATH_TO_AMBIENT_NOISE_FILES__
)
all_ambient_noise_files = glob.glob(
os.path.join(path_to_ambient_noise_files, "*", "*")
)
if self.format == "mic":
ambient_noise_format_files = [
f for f in all_ambient_noise_files if "tetra" in f
]
elif self.format == "foa":
ambient_noise_format_files = [
f for f in all_ambient_noise_files if "foa" in f
]
if self.room == "bomb_shelter":
room_ambient_noise_file = [
f for f in ambient_noise_format_files if "bomb_center" in f
]
else:
room_ambient_noise_file = [
f for f in ambient_noise_format_files if self.room in f
]
assert len(room_ambient_noise_file) < 2
if room_ambient_noise_file:
return room_ambient_noise_file[0]
else:
return random.choice(ambient_noise_format_files)

def add_background(self):
def add_background(self, use_room_ambient_noise=True):
"""
Adds a background event to the soundscape.
This method sets fixed values for event time, duration, and
SNR, and adds the event to the background events list.
"""
label = None
source_file = None
source_time = None
snr = ("const", 0)
role = "background"
pitch_shift = None
Expand All @@ -210,18 +163,14 @@ def add_background(self):
event_duration = ("const", self.duration)
event_position = None

if self.use_room_ambient_noise:
source_file = self.get_path_to_room_ambient_noise()
if use_room_ambient_noise:
source_files = self.room.get_ambient_noise_paths()
source_file = random.choice(source_files)
ambient_noise_duration = librosa.get_duration(path=source_file)
if ambient_noise_duration > self.duration:
source_time = round(
random.uniform(0, ambient_noise_duration - self.duration)
)
else:
source_time = None
else:
source_file = None
source_time = None

self.bg_events.append(
Event(
Expand Down Expand Up @@ -335,7 +284,7 @@ def add_event(
self.speed_limit,
)
else:
xyz_min, xyz_max = self._get_room_min_max()
xyz_min, xyz_max = self.room.get_boundaries()
event_position_ = [self._gen_xyz(xyz_min, xyz_max)]

if snr[0] == "uniform" and len(snr) == 3:
Expand Down Expand Up @@ -425,18 +374,6 @@ def _gen_xyz(self, xyz_min, xyz_max):
xyz.append(random.uniform(xyz_min[i], xyz_max[i]))
return xyz

def _get_room_min_max(self):
"""
Determines the minimum and maximum XYZ coordinates for the current room setup.

Returns:
tuple: A tuple containing the minimum and maximum XYZ coordinates for the room.
"""
all_xyz = self.get_room_irs_xyz()
xyz_min = all_xyz.min(axis=0)
xyz_max = all_xyz.max(axis=0)
return xyz_min, xyz_max

def generate_end_point(
self, xyz_start, xyz_min, xyz_max, speed_limit, event_duration
):
Expand Down Expand Up @@ -516,7 +453,7 @@ def define_trajectory(
if all(trajectory_params[1:]):
xyz_min, xyz_max = trajectory_params[1:]
else:
xyz_min, xyz_max = self._get_room_min_max()
xyz_min, xyz_max = self.room.get_boundaries()
xyz_start = self._gen_xyz(xyz_min, xyz_max)
xyz_end = self.generate_end_point(
xyz_start, xyz_min, xyz_max, speed_limit, event_duration
Expand All @@ -537,72 +474,9 @@ def define_position(self, position_params):
if position_params:
xyz_min, xyz_max = position_params
else:
xyz_min, xyz_max = self._get_room_min_max()
xyz_min, xyz_max = self.room.get_boundaries()
return [self._gen_xyz(xyz_min, xyz_max)]

def get_room_irs_xyz(self):
"""
Retrieves the XYZ coordinates of impulse response positions in the room.

Returns:
numpy.ndarray: An array of XYZ coordinates for the impulse response positions.
"""
if self.format == "foa" and self.room == "metu":
raise ValueError(
'"metu" room is currently only supported in mic (tetrahedral) format. please check again soon.'
)
room_sofa_path = os.path.join(
self.rir_dir,
__SPATIAL_SCAPER_RIRS_DIR__,
__ROOM_RIR_FILE__[self.room].format(fmt=self.format),
)
return load_pos(room_sofa_path, doas=False)

def get_room_irs_wav_xyz(self, wav=True, pos=True):
"""
Retrieves impulse responses and their positions for the room.

Args:
wav (bool): Whether to include the waveforms of the impulse responses.
pos (bool): Whether to include the positions of the impulse responses.

Returns:
tuple: A tuple containing the impulse responses, their sampling rate, and their XYZ positions.
"""
if self.format == "foa" and self.room == "metu":
raise ValueError(
'"metu" room is currently only supported in mic (tetrahedral) format. please check again soon.'
)
room_sofa_path = os.path.join(
self.rir_dir,
__SPATIAL_SCAPER_RIRS_DIR__,
__ROOM_RIR_FILE__[self.room].format(fmt=self.format),
)
all_irs, ir_sr, all_ir_xyzs = load_rir_pos(room_sofa_path, doas=False)
ir_sr = ir_sr.data[0]
all_irs = all_irs.data
all_ir_xyzs = all_ir_xyzs.data
if ir_sr != self.sr:
all_irs = librosa.resample(all_irs, orig_sr=ir_sr, target_sr=self.sr)
ir_sr = self.sr
return all_irs, ir_sr, all_ir_xyzs

def get_format_irs(self, all_irs, fmt="mic"):
"""
Retrieves impulse responses according to the specified format.

Args:
all_irs (numpy.ndarray): Array of all impulse responses.
fmt (str): The format for retrieving impulse responses (e.g., 'mic').

Returns:
numpy.ndarray: An array of impulse responses formatted according to the specified format.
"""
if fmt == "mic" and self.room == "metu":
return all_irs[:, [5, 9, 25, 21], :]
else:
return all_irs

def generate_noise(self, event):
"""
Generates noise to be used as background ambient.
Expand Down Expand Up @@ -768,8 +642,7 @@ def generate(self, audiopath, labelpath):
and that the output audio and labels are accurately saved for further use or analysis.
"""

all_irs, ir_sr, all_ir_xyzs = self.get_room_irs_wav_xyz()
all_irs = self.get_format_irs(all_irs)
all_irs, ir_sr, all_ir_xyzs = self.room.get_irs(self.sr)
self.nchans = all_irs.shape[1] # a bit ugly but works for now

# initialize output audio array
Expand Down
Loading