kira 0.12.0

Expressive audio library for games
Documentation 
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

use crate::{
	Decibels, StartTime, Tween, Value, info::Info, parameter::Parameter, sound::PlaybackState,
};

pub(crate) struct PlaybackStateManager {
	state: State,
	volume_fade: Parameter<Decibels>,
}

impl PlaybackStateManager {
	pub fn new(fade_in_tween: Option<Tween>) -> Self {
		Self {
			state: State::Playing,
			volume_fade: fade_in_tween
				.map(|tween| {
					let mut parameter =
						Parameter::new(Value::Fixed(Decibels::SILENCE), Decibels::SILENCE);
					parameter.set(Value::Fixed(Decibels::IDENTITY), tween);
					parameter
				})
				.unwrap_or_else(|| {
					Parameter::new(Value::Fixed(Decibels::IDENTITY), Decibels::IDENTITY)
				}),
		}
	}

	pub fn interpolated_fade_volume(&self, amount: f64) -> Decibels {
		self.volume_fade.interpolated_value(amount)
	}

	pub fn playback_state(&self) -> PlaybackState {
		match self.state {
			State::Playing => PlaybackState::Playing,
			State::Pausing => PlaybackState::Pausing,
			State::Paused => PlaybackState::Paused,
			State::WaitingToResume { .. } => PlaybackState::WaitingToResume,
			State::Resuming => PlaybackState::Resuming,
			State::Stopping => PlaybackState::Stopping,
			State::Stopped => PlaybackState::Stopped,
		}
	}

	pub fn pause(&mut self, fade_out_tween: Tween) {
		if let State::Stopped = &self.state {
			return;
		}
		self.state = State::Pausing;
		self.volume_fade
			.set(Value::Fixed(Decibels::SILENCE), fade_out_tween);
	}

	pub fn resume(&mut self, start_time: StartTime, fade_in_tween: Tween) {
		if let State::Stopped = &self.state {
			return;
		}
		if let StartTime::Immediate = start_time {
			self.state = State::Resuming;
			self.volume_fade
				.set(Value::Fixed(Decibels::IDENTITY), fade_in_tween);
		} else {
			self.state = State::WaitingToResume {
				start_time,
				fade_in_tween,
			};
		}
	}

	pub fn stop(&mut self, fade_out_tween: Tween) {
		if let State::Stopped = &self.state {
			return;
		}
		self.state = State::Stopping;
		self.volume_fade
			.set(Value::Fixed(Decibels::SILENCE), fade_out_tween);
	}

	pub fn mark_as_stopped(&mut self) {
		self.state = State::Stopped;
	}

	pub fn update(&mut self, dt: f64, info: &Info) -> ChangedPlaybackState {
		let finished = self.volume_fade.update(dt, info);
		match &mut self.state {
			State::Playing => {}
			State::Pausing => {
				if finished {
					self.state = State::Paused;
					return true;
				}
			}
			State::Paused => {}
			State::WaitingToResume {
				start_time,
				fade_in_tween,
			} => {
				let will_never_start = start_time.update(dt, info);
				if will_never_start {
					self.state = State::Stopped;
					return true;
				}
				if *start_time == StartTime::Immediate {
					let fade_in_tween = *fade_in_tween;
					self.resume(StartTime::Immediate, fade_in_tween);
					return true;
				}
			}
			State::Resuming => {
				if finished {
					self.state = State::Playing;
					return true;
				}
			}
			State::Stopping => {
				if finished {
					self.state = State::Stopped;
					return true;
				}
			}
			State::Stopped => {}
		}
		false
	}
}

pub type ChangedPlaybackState = bool;

enum State {
	Playing,
	Pausing,
	Paused,
	WaitingToResume {
		start_time: StartTime,
		fade_in_tween: Tween,
	},
	Resuming,
	Stopping,
	Stopped,
}