Mirrored_Repos/veloren
1
0
Fork 0
mirror of https://gitlab.com/veloren/veloren.git synced 2024-08-30 18:12:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
d341073a44
veloren/voxygen/src/audio/sfx/event_mapper.rs

327 lines
10 KiB
Rust
Raw Normal View History

SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
/// sfx::event_mapper watches the local entities and determines which sfx to emit,
/// and the position at which the sound should be emitted from
use crate::audio::sfx::{SfxTriggerItem, SfxTriggers};
use client::Client;
use common::{
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
comp::{ActionState, Body, CharacterState, MovementState, Pos},
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
event::{EventBus, SfxEvent, SfxEventItem},
};
use hashbrown::HashMap;
Upgrade to specs 0.15.1
2019-11-30 06:41:20 +00:00
use specs::{Entity as EcsEntity, Join, WorldExt};
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
use std::time::{Duration, Instant};
use vek::*;
#[derive(Clone)]
struct LastSfxEvent {
event: SfxEvent,
time: Instant,
}
pub struct SfxEventMapper {
event_history: HashMap<EcsEntity, LastSfxEvent>,
}
impl SfxEventMapper {
pub fn new() -> Self {
Self {
event_history: HashMap::new(),
}
}
pub fn maintain(&mut self, client: &Client, triggers: &SfxTriggers) {
const SFX_DIST_LIMIT_SQR: f32 = 22500.0;
let ecs = client.state().ecs();
let player_position = ecs
.read_storage::<Pos>()
.get(client.entity())
.map_or(Vec3::zero(), |pos| pos.0);
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
for (entity, pos, body, character) in (
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
&ecs.entities(),
&ecs.read_storage::<Pos>(),
&ecs.read_storage::<Body>(),
ecs.read_storage::<CharacterState>().maybe(),
)
.join()
.filter(|(_, e_pos, ..)| {
(e_pos.0.distance_squared(player_position)) < SFX_DIST_LIMIT_SQR
})
{
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
if let Some(character) = character {
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
let state = self
.event_history
.entry(entity)
.or_insert_with(|| LastSfxEvent {
event: SfxEvent::Idle,
time: Instant::now(),
});
let mapped_event = match body {
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
Body::Humanoid(_) => Self::map_movement_event(character, state.event.clone()),
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
Body::QuadrupedMedium(_) => {
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
// TODO: Quadriped running sfx
SfxEvent::Idle
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
}
_ => SfxEvent::Idle,
};
// Check for SFX config entry for this movement
let sfx_trigger_item: Option<&SfxTriggerItem> = triggers
.items
.iter()
.find(|item| item.trigger == mapped_event);
if Self::should_emit(state, sfx_trigger_item) {
ecs.read_resource::<EventBus<SfxEventItem>>()
.emitter()
.emit(SfxEventItem::new(mapped_event, Some(pos.0)));
// Update the last play time
state.event = mapped_event;
state.time = Instant::now();
} else {
// Keep the last event, it may not have an SFX trigger but it helps us determine the next one
state.event = mapped_event;
}
}
}
self.cleanup(client.entity());
}
/// As the player explores the world, we track the last event of the nearby entities to determine the correct
/// SFX item to play next based on their activity. `cleanup` will remove entities from event tracking if they
/// have not triggered an event for > n seconds. This prevents stale records from bloating the Map size.
fn cleanup(&mut self, player: EcsEntity) {
const TRACKING_TIMEOUT: u64 = 15;
let now = Instant::now();
self.event_history.retain(|entity, event| {
now.duration_since(event.time) < Duration::from_secs(TRACKING_TIMEOUT)
|| entity.id() == player.id()
});
}
/// When specific entity movements are detected, the associated sound (if any) needs to satisfy two conditions to
/// be allowed to play:
/// 1. An sfx.ron entry exists for the movement (we need to know which sound file(s) to play)
/// 2. The sfx has not been played since it's timeout threshold has elapsed, which prevents firing every tick
fn should_emit(
last_play_entry: &LastSfxEvent,
sfx_trigger_item: Option<&SfxTriggerItem>,
) -> bool {
if let Some(item) = sfx_trigger_item {
if last_play_entry.event == item.trigger {
last_play_entry.time.elapsed().as_secs_f64() >= item.threshold
} else {
true
}
} else {
false
}
}
feat: weapon-type dependent wield and attack durations also some controller.rs cleanup
2019-12-03 06:30:08 +00:00
/// Voxygen has an existing list of character states via `MovementState::*` and `ActionState::*`
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
/// however that list does not provide enough resolution to target specific entity events, such
/// as opening or closing the glider. These methods translate those entity states with some additional
/// data into more specific `SfxEvent`'s which we attach sounds to
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
fn map_movement_event(current_event: &CharacterState, previous_event: SfxEvent) -> SfxEvent {
match (current_event.movement, current_event.action, previous_event) {
(_, ActionState::Roll { .. }, _) => SfxEvent::Roll,
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
(MovementState::Climb, ..) => SfxEvent::Climb,
(MovementState::Swim, ..) => SfxEvent::Swim,
(MovementState::Run, ..) => SfxEvent::Run,
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
(MovementState::Fall, _, previous_event) => {
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
if previous_event != SfxEvent::Glide {
Fix the glider_close sfx event This was failing to trigger since we now have a MovementState::Fall, but the sfx mapper was still trying to work this out itself based on velocity. We no longer need to track velocity as a result and can use the MovementState. Also silenced warnings resulting from unused vars when running tests.
2019-12-09 09:50:14 +00:00
SfxEvent::Fall
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
} else {
SfxEvent::GliderClose
}
}
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
(MovementState::Glide, _, previous_event) => {
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
if previous_event != SfxEvent::GliderOpen && previous_event != SfxEvent::Glide {
SfxEvent::GliderOpen
} else {
SfxEvent::Glide
}
}
_ => SfxEvent::Idle,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use common::{
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
comp::{ActionState, MovementState},
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
event::SfxEvent,
};
use std::time::{Duration, Instant};
#[test]
fn no_item_config_no_emit() {
let last_sfx_event = LastSfxEvent {
event: SfxEvent::Idle,
time: Instant::now(),
};
let result = SfxEventMapper::should_emit(&last_sfx_event, None);
assert_eq!(result, false);
}
#[test]
fn config_but_played_since_threshold_no_emit() {
let trigger_item = SfxTriggerItem {
trigger: SfxEvent::Run,
files: vec![String::from("some.path.to.sfx.file")],
threshold: 1.0,
};
// Triggered a 'Run' 0 seconds ago
let last_sfx_event = LastSfxEvent {
event: SfxEvent::Run,
time: Instant::now(),
};
let result = SfxEventMapper::should_emit(&last_sfx_event, Some(&trigger_item));
assert_eq!(result, false);
}
#[test]
fn config_and_not_played_since_threshold_emits() {
let trigger_item = SfxTriggerItem {
trigger: SfxEvent::Run,
files: vec![String::from("some.path.to.sfx.file")],
threshold: 0.5,
};
let last_sfx_event = LastSfxEvent {
event: SfxEvent::Idle,
time: Instant::now().checked_add(Duration::from_secs(1)).unwrap(),
};
let result = SfxEventMapper::should_emit(&last_sfx_event, Some(&trigger_item));
assert_eq!(result, true);
}
#[test]
fn same_previous_event_elapsed_emits() {
let trigger_item = SfxTriggerItem {
trigger: SfxEvent::Run,
files: vec![String::from("some.path.to.sfx.file")],
threshold: 0.5,
};
let last_sfx_event = LastSfxEvent {
event: SfxEvent::Run,
time: Instant::now()
.checked_sub(Duration::from_millis(500))
.unwrap(),
};
let result = SfxEventMapper::should_emit(&last_sfx_event, Some(&trigger_item));
assert_eq!(result, true);
}
#[test]
fn maps_idle() {
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
let result = SfxEventMapper::map_movement_event(
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
&CharacterState {
movement: MovementState::Stand,
action: ActionState::Idle,
},
SfxEvent::Idle,
);
assert_eq!(result, SfxEvent::Idle);
}
#[test]
fn maps_run() {
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
let result = SfxEventMapper::map_movement_event(
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
&CharacterState {
movement: MovementState::Run,
action: ActionState::Idle,
},
SfxEvent::Idle,
);
assert_eq!(result, SfxEvent::Run);
}
#[test]
fn maps_roll() {
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
let result = SfxEventMapper::map_movement_event(
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
&CharacterState {
feat: weapon-type dependent wield and attack durations also some controller.rs cleanup
2019-12-03 06:30:08 +00:00
action: ActionState::Roll {
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
time_left: Duration::new(1, 0),
Update controller
2019-12-09 14:45:10 +00:00
was_wielding: false,
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
},
feat: weapon-type dependent wield and attack durations also some controller.rs cleanup
2019-12-03 06:30:08 +00:00
movement: MovementState::Run,
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
},
SfxEvent::Run,
);
assert_eq!(result, SfxEvent::Roll);
}
#[test]
Fix the glider_close sfx event This was failing to trigger since we now have a MovementState::Fall, but the sfx mapper was still trying to work this out itself based on velocity. We no longer need to track velocity as a result and can use the MovementState. Also silenced warnings resulting from unused vars when running tests.
2019-12-09 09:50:14 +00:00
fn maps_fall() {
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
let result = SfxEventMapper::map_movement_event(
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
&CharacterState {
Fix the glider_close sfx event This was failing to trigger since we now have a MovementState::Fall, but the sfx mapper was still trying to work this out itself based on velocity. We no longer need to track velocity as a result and can use the MovementState. Also silenced warnings resulting from unused vars when running tests.
2019-12-09 09:50:14 +00:00
movement: MovementState::Fall,
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
action: ActionState::Idle,
},
SfxEvent::Idle,
);
Fix the glider_close sfx event This was failing to trigger since we now have a MovementState::Fall, but the sfx mapper was still trying to work this out itself based on velocity. We no longer need to track velocity as a result and can use the MovementState. Also silenced warnings resulting from unused vars when running tests.
2019-12-09 09:50:14 +00:00
assert_eq!(result, SfxEvent::Fall);
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
}
#[test]
fn maps_glider_open() {
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
let result = SfxEventMapper::map_movement_event(
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
&CharacterState {
movement: MovementState::Glide,
action: ActionState::Idle,
},
SfxEvent::Jump,
);
assert_eq!(result, SfxEvent::GliderOpen);
}
#[test]
fn maps_glide() {
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
let result = SfxEventMapper::map_movement_event(
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
&CharacterState {
movement: MovementState::Glide,
action: ActionState::Idle,
},
SfxEvent::Glide,
);
assert_eq!(result, SfxEvent::Glide);
}
#[test]
fn maps_glider_close() {
Update title music and temporarily remove attack sfx - Updated title music with a version provided by aeronic which fades out more gracefully - Removed attack SFX as it was included in the movement processing, but will return later as part of a similar chunk of code which processes combat sfx independent of movement.
2019-12-20 04:04:05 +00:00
let result = SfxEventMapper::map_movement_event(
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
&CharacterState {
Fix the glider_close sfx event This was failing to trigger since we now have a MovementState::Fall, but the sfx mapper was still trying to work this out itself based on velocity. We no longer need to track velocity as a result and can use the MovementState. Also silenced warnings resulting from unused vars when running tests.
2019-12-09 09:50:14 +00:00
movement: MovementState::Fall,
SFX system This is an event based approach to SFX sounds. There is a specific character sound event mapper which determines sfx to play based on character or NPC state, as well as emitting sfx events for non-character-triggers such as levelling up.
2019-11-23 08:26:39 +00:00
action: ActionState::Idle,
},
SfxEvent::Glide,
);
assert_eq!(result, SfxEvent::GliderClose);
}
}
Reference in New Issue Copy Permalink