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
//! An interface for controlling mixer tracks.

use std::sync::Weak;

use basedrop::{Handle, Owned};
use indexmap::IndexSet;
use thiserror::Error;

use crate::{
	command::{
		producer::{CommandError, CommandProducer},
		MixerCommand,
	},
	mixer::effect::{handle::EffectHandle, Effect, EffectId, EffectSettings},
	Value,
};

use super::{
	SendTrackId, SendTrackSettings, SubTrackId, SubTrackSettings, TrackIndex,
	MAIN_TRACK_NUM_EFFECTS,
};

/// Something that can go wrong when using a [`TrackHandle`] to
/// add an effect to a mixer track.
#[derive(Debug, Error)]
pub enum AddEffectError {
	/// The maximum effect limit for this track has been reached.
	#[error(
		"Cannot add an effect because the max number of effects for this track has been reached"
	)]
	EffectLimitReached,
	/// No effect with the specified ID exists on this track.
	#[error("No effect with the specified ID exists on this track")]
	NoEffectWithId(EffectId),
	/// A command could not be sent to the audio thread.
	#[error("Could not send the command to the audio thread.")]
	CommandProducerError(#[from] CommandError),
}

/// Something that can go wrong when using a [`TrackHandle`] to
/// remove an effect from a mixer track.
#[derive(Debug, Error)]
pub enum RemoveEffectError {
	/// No effect with the specified ID exists on this track.
	#[error("No effect with the specified ID exists on this track")]
	NoEffectWithId(EffectId),
	/// A command could not be sent to the audio thread.
	#[error("Could not send the command to the audio thread.")]
	CommandProducerError(#[from] CommandError),
}

/// Allows you to control the main mixer track.
pub struct MainTrackHandle {
	command_producer: CommandProducer,
	active_effect_ids: IndexSet<EffectId>,
	sample_rate: u32,
	resource_collector_handle: Weak<Handle>,
}

impl MainTrackHandle {
	pub(crate) fn new(
		command_producer: CommandProducer,
		sample_rate: u32,
		resource_collector_handle: Weak<Handle>,
	) -> Self {
		Self {
			command_producer,
			active_effect_ids: IndexSet::with_capacity(MAIN_TRACK_NUM_EFFECTS),
			sample_rate,
			resource_collector_handle,
		}
	}

	/// Sets the volume of the main track.
	///
	/// This acts as a "master volume" control for all sounds.
	pub fn set_volume(&mut self, volume: impl Into<Value<f64>>) -> Result<(), CommandError> {
		self.command_producer
			.push(MixerCommand::SetTrackVolume(TrackIndex::Main, volume.into()).into())
	}

	/// Adds an effect to the track.
	pub fn add_effect(
		&mut self,
		mut effect: impl Effect + 'static,
		settings: EffectSettings,
	) -> Result<EffectHandle, AddEffectError> {
		if self.active_effect_ids.len() >= self.active_effect_ids.capacity() {
			return Err(AddEffectError::EffectLimitReached);
		}
		let effect_id = settings.id.unwrap_or(EffectId::new());
		let handle = EffectHandle::new(
			effect_id,
			TrackIndex::Main,
			&settings,
			self.command_producer.clone(),
		);
		effect.init(self.sample_rate);
		if let Some(handle) = self.resource_collector_handle.upgrade() {
			self.command_producer.push(
				MixerCommand::AddEffect(
					TrackIndex::Main,
					effect_id,
					Owned::new(&handle, Box::new(effect)),
					settings,
				)
				.into(),
			)?;
			self.active_effect_ids.insert(effect_id);
		}
		Ok(handle)
	}

	/// Removes an effect from the track.
	pub fn remove_effect(&mut self, id: impl Into<EffectId>) -> Result<(), RemoveEffectError> {
		let id = id.into();
		if !self.active_effect_ids.remove(&id) {
			return Err(RemoveEffectError::NoEffectWithId(id));
		}
		self.command_producer
			.push(MixerCommand::RemoveEffect(TrackIndex::Main, id).into())?;
		Ok(())
	}
}

/// Allows you to control a mixer sub-track.
pub struct SubTrackHandle {
	id: SubTrackId,
	command_producer: CommandProducer,
	active_effect_ids: IndexSet<EffectId>,
	sample_rate: u32,
	resource_collector_handle: Weak<Handle>,
}

impl SubTrackHandle {
	pub(crate) fn new(
		id: SubTrackId,
		settings: &SubTrackSettings,
		command_producer: CommandProducer,
		sample_rate: u32,
		resource_collector_handle: Weak<Handle>,
	) -> Self {
		Self {
			id,
			command_producer,
			active_effect_ids: IndexSet::with_capacity(settings.num_effects),
			sample_rate,
			resource_collector_handle,
		}
	}

	/// Gets the track that this handle controls.
	pub fn id(&self) -> SubTrackId {
		self.id
	}

	/// Sets the volume of the track.
	pub fn set_volume(&mut self, volume: impl Into<Value<f64>>) -> Result<(), CommandError> {
		self.command_producer
			.push(MixerCommand::SetTrackVolume(self.id.into(), volume.into()).into())
	}

	/// Adds an effect to the track.
	pub fn add_effect(
		&mut self,
		mut effect: impl Effect + 'static,
		settings: EffectSettings,
	) -> Result<EffectHandle, AddEffectError> {
		if self.active_effect_ids.len() >= self.active_effect_ids.capacity() {
			return Err(AddEffectError::EffectLimitReached);
		}
		let effect_id = settings.id.unwrap_or(EffectId::new());
		let handle = EffectHandle::new(
			effect_id,
			self.id.into(),
			&settings,
			self.command_producer.clone(),
		);
		effect.init(self.sample_rate);
		if let Some(handle) = self.resource_collector_handle.upgrade() {
			self.command_producer.push(
				MixerCommand::AddEffect(
					self.id.into(),
					effect_id,
					Owned::new(&handle, Box::new(effect)),
					settings,
				)
				.into(),
			)?;
			self.active_effect_ids.insert(effect_id);
		}
		Ok(handle)
	}

	/// Removes an effect from the track.
	pub fn remove_effect(&mut self, id: impl Into<EffectId>) -> Result<(), RemoveEffectError> {
		let id = id.into();
		if !self.active_effect_ids.remove(&id) {
			return Err(RemoveEffectError::NoEffectWithId(id));
		}
		self.command_producer
			.push(MixerCommand::RemoveEffect(self.id.into(), id).into())?;
		Ok(())
	}
}

/// Allows you to control a mixer send track.
pub struct SendTrackHandle {
	id: SendTrackId,
	command_producer: CommandProducer,
	active_effect_ids: IndexSet<EffectId>,
	sample_rate: u32,
	resource_collector_handle: Weak<Handle>,
}

impl SendTrackHandle {
	pub(crate) fn new(
		id: SendTrackId,
		settings: &SendTrackSettings,
		command_producer: CommandProducer,
		sample_rate: u32,
		resource_collector_handle: Weak<Handle>,
	) -> Self {
		Self {
			id,
			command_producer,
			active_effect_ids: IndexSet::with_capacity(settings.num_effects),
			sample_rate,
			resource_collector_handle,
		}
	}

	/// Gets the track that this handle controls.
	pub fn id(&self) -> SendTrackId {
		self.id
	}

	/// Sets the volume of the track.
	pub fn set_volume(&mut self, volume: impl Into<Value<f64>>) -> Result<(), CommandError> {
		self.command_producer
			.push(MixerCommand::SetTrackVolume(self.id.into(), volume.into()).into())
	}

	/// Adds an effect to the track.
	pub fn add_effect(
		&mut self,
		mut effect: impl Effect + 'static,
		settings: EffectSettings,
	) -> Result<EffectHandle, AddEffectError> {
		if self.active_effect_ids.len() >= self.active_effect_ids.capacity() {
			return Err(AddEffectError::EffectLimitReached);
		}
		let effect_id = settings.id.unwrap_or(EffectId::new());
		let handle = EffectHandle::new(
			effect_id,
			self.id.into(),
			&settings,
			self.command_producer.clone(),
		);
		effect.init(self.sample_rate);
		if let Some(handle) = self.resource_collector_handle.upgrade() {
			self.command_producer.push(
				MixerCommand::AddEffect(
					self.id.into(),
					effect_id,
					Owned::new(&handle, Box::new(effect)),
					settings,
				)
				.into(),
			)?;
			self.active_effect_ids.insert(effect_id);
		}
		Ok(handle)
	}

	/// Removes an effect from the track.
	pub fn remove_effect(&mut self, id: impl Into<EffectId>) -> Result<(), RemoveEffectError> {
		let id = id.into();
		if !self.active_effect_ids.remove(&id) {
			return Err(RemoveEffectError::NoEffectWithId(id));
		}
		self.command_producer
			.push(MixerCommand::RemoveEffect(self.id.into(), id).into())?;
		Ok(())
	}
}