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
287
288
289
290
291
292
293
294

//! Items related to boxed-slice conversions.
//!
//! ### Required Features
//!
//! - When using `dasp_slice`, this module requires the **boxed** feature to be enabled.
//! - When using `dasp`, this module requires the **slice-boxed** feature to be enabled.

#[cfg(not(feature = "std"))]
extern crate alloc;

use dasp_frame::Frame;
use dasp_sample::Sample;

/// Equal to `std::boxed::Box` on std, `alloc::boxed::Box` in `no_std` context.
#[cfg(not(feature = "std"))]
pub type Box<T> = alloc::boxed::Box<T>;
/// Equal to `std::boxed::Box` on std, `alloc::boxed::Box` in `no_std` context.
#[cfg(feature = "std")]
pub type Box<T> = std::boxed::Box<T>;

// Traits
// ----------------------------------------------------------------------------

/// For converting a boxed slice of `Sample`s to a boxed slice of `Frame`s.
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub trait FromBoxedSampleSlice<S>: Sized
where
    S: Sample,
{
    fn from_boxed_sample_slice(slice: Box<[S]>) -> Option<Self>;
}

/// For converting from a boxed slice of `Frame`s to a boxed slice of `Sample`s.
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub trait FromBoxedFrameSlice<F>
where
    F: Frame,
{
    fn from_boxed_frame_slice(slice: Box<[F]>) -> Self;
}

/// For converting from a boxed slice of `Frame`s to a boxed slice of `Sample`s.
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub trait ToBoxedSampleSlice<S>
where
    S: Sample,
{
    fn to_boxed_sample_slice(self) -> Box<[S]>;
}

/// For converting from a boxed slice of `Sample`s to a boxed slice of `Frame`s.
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub trait ToBoxedFrameSlice<F>
where
    F: Frame,
{
    fn to_boxed_frame_slice(self) -> Option<Box<[F]>>;
}

/// For converting to and from a boxed slice of `Sample`s.
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub trait DuplexBoxedSampleSlice<S>: FromBoxedSampleSlice<S> + ToBoxedSampleSlice<S>
where
    S: Sample,
{
}

/// For converting to and from a boxed slice of `Frame`s.
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub trait DuplexBoxedFrameSlice<F>: FromBoxedFrameSlice<F> + ToBoxedFrameSlice<F>
where
    F: Frame,
{
}

/// For converting to and from a boxed slice of `Sample`s of type `S` and a slice of `Frame`s of
/// type `F`.
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub trait DuplexBoxedSlice<S, F>: DuplexBoxedSampleSlice<S> + DuplexBoxedFrameSlice<F>
where
    S: Sample,
    F: Frame<Sample = S>,
{
}

// Implementations
// ----------------------------------------------------------------------------

impl<S> FromBoxedSampleSlice<S> for Box<[S]>
where
    S: Sample,
{
    #[inline]
    fn from_boxed_sample_slice(slice: Box<[S]>) -> Option<Self> {
        Some(slice)
    }
}

impl<F> FromBoxedFrameSlice<F> for Box<[F]>
where
    F: Frame,
{
    #[inline]
    fn from_boxed_frame_slice(slice: Box<[F]>) -> Self {
        slice
    }
}

impl<S> ToBoxedSampleSlice<S> for Box<[S]>
where
    S: Sample,
{
    #[inline]
    fn to_boxed_sample_slice(self) -> Box<[S]> {
        self
    }
}

impl<F> ToBoxedFrameSlice<F> for Box<[F]>
where
    F: Frame,
{
    #[inline]
    fn to_boxed_frame_slice(self) -> Option<Box<[F]>> {
        Some(self)
    }
}

impl<S, T> DuplexBoxedSampleSlice<S> for T
where
    S: Sample,
    T: FromBoxedSampleSlice<S> + ToBoxedSampleSlice<S>,
{
}

impl<F, T> DuplexBoxedFrameSlice<F> for T
where
    F: Frame,
    T: FromBoxedFrameSlice<F> + ToBoxedFrameSlice<F>,
{
}

impl<S, F, T> DuplexBoxedSlice<S, F> for T
where
    S: Sample,
    F: Frame<Sample = S>,
    T: DuplexBoxedSampleSlice<S> + DuplexBoxedFrameSlice<F>,
{
}

// Free Functions
// ----------------------------------------------------------------------------

/// Converts the given boxed slice into a boxed slice of `Sample`s.
///
/// This is a convenience function that wraps the `ToBoxedSampleSlice` trait.
///
/// # Examples
///
/// ```
/// fn main() {
///     let foo = vec![[0.0, 0.5], [0.0, -0.5]].into_boxed_slice();
///     let bar = dasp_slice::to_boxed_sample_slice(foo);
///     assert_eq!(bar.into_vec(), vec![0.0, 0.5, 0.0, -0.5]);
/// }
/// ```
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub fn to_boxed_sample_slice<T, S>(slice: T) -> Box<[S]>
where
    S: Sample,
    T: ToBoxedSampleSlice<S>,
{
    slice.to_boxed_sample_slice()
}

/// Converts the given boxed slice into a boxed slice of `Frame`s.
///
/// Returns `None` if the number of channels in a single frame `F` is not a multiple of the number
/// of samples in the given slice.
///
/// This is a convenience function that wraps the `ToBoxedFrameSlice` trait.
///
/// # Examples
///
/// ```
/// fn main() {
///     let foo = vec![0.0, 0.5, 0.0, -0.5].into_boxed_slice();
///     let bar: Box<[[f32; 2]]> = dasp_slice::to_boxed_frame_slice(foo).unwrap();
///     assert_eq!(bar.into_vec(), vec![[0.0, 0.5], [0.0, -0.5]]);
///
///     let foo = vec![0.0, 0.5, 0.0].into_boxed_slice();
///     let bar = dasp_slice::to_boxed_frame_slice(foo);
///     assert_eq!(bar, None::<Box<[[f32; 2]]>>);
/// }
/// ```
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub fn to_boxed_frame_slice<T, F>(slice: T) -> Option<Box<[F]>>
where
    F: Frame,
    T: ToBoxedFrameSlice<F>,
{
    slice.to_boxed_frame_slice()
}

/// Converts the given boxed slice of `Sample`s into some slice `T`.
///
/// Returns `None` if the number of channels in a single frame is not a multiple of the number of
/// samples in the given slice.
///
/// This is a convenience function that wraps the `FromBoxedSampleSlice` trait.
///
/// # Examples
///
/// ```
/// fn main() {
///     let foo = vec![0.0, 0.5, 0.0, -0.5].into_boxed_slice();
///     let bar: Box<[[f32; 2]]> = dasp_slice::from_boxed_sample_slice(foo).unwrap();
///     assert_eq!(bar.into_vec(), vec![[0.0, 0.5], [0.0, -0.5]]);
/// }
/// ```
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub fn from_boxed_sample_slice<T, S>(slice: Box<[S]>) -> Option<T>
where
    S: Sample,
    T: FromBoxedSampleSlice<S>,
{
    T::from_boxed_sample_slice(slice)
}

/// Converts the given boxed slice of `Frame`s into some slice `T`.
///
/// This is a convenience function that wraps the `FromBoxedFrameSlice` trait.
///
/// # Examples
///
/// ```
/// fn main() {
///     let foo = vec![[0.0, 0.5], [0.0, -0.5]].into_boxed_slice();
///     let bar: Box<[f32]> = dasp_slice::from_boxed_frame_slice(foo);
///     assert_eq!(bar.into_vec(), vec![0.0, 0.5, 0.0, -0.5]);
/// }
/// ```
///
/// ### Required Features
///
/// - When using `dasp_slice`, this item requires the **boxed** feature to be enabled.
/// - When using `dasp`, this item requires the **slice-boxed** feature to be enabled.
pub fn from_boxed_frame_slice<T, F>(slice: Box<[F]>) -> T
where
    F: Frame,
    T: FromBoxedFrameSlice<F>,
{
    T::from_boxed_frame_slice(slice)
}