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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
use crate::{ check_init, ffi, vec::{FVec, FVecMut}, AsNativeStr, Error, Result, Smpl, SpecMethod, Status, }; use std::{ fmt::{Display, Formatter, Result as FmtResult}, str::FromStr, }; /** * Onset detection function */ #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum OnsetMode { /** * Energy based onset detection function * * This function calculates the local energy of the input spectral frame. */ Energy, /** * High Frequency Content onset detection function * * This method computes the High Frequency Content (HFC) of the input spectral frame. The resulting function is efficient at detecting percussive onsets. * * Paul Masri. Computer modeling of Sound for Transformation and Synthesis of Musical Signal. PhD dissertation, University of Bristol, UK, 1996. */ Hfc, /** * Complex Domain Method onset detection function * * Christopher Duxbury, Mike E. Davies, and Mark B. Sandler. Complex domain onset detection for musical signals. In Proceedings of the Digital Audio Effects Conference, DAFx-03, pages 90-93, London, UK, 2003. */ Complex, /** * Phase Based Method onset detection function * * Juan-Pablo Bello, Mike P. Davies, and Mark B. Sandler. Phase-based note onset detection for music signals. In Proceedings of the IEEE International Conference on Acoustics Speech and Signal Processing, pages 441444, Hong-Kong, 2003. */ Phase, /** * Weighted Phase Deviation onset detection function * * S. Dixon. Onset detection revisited. In Proceedings of the 9th International Conference on Digital Audio Ef- fects (DAFx) , pages 133–137, 2006. * * See [http://www.eecs.qmul.ac.uk/~simond/pub/2006/dafx.pdf](http://www.eecs.qmul.ac.uk/~simond/pub/2006/dafx.pdf) */ WPhase, /** * Spectral difference method onset detection function * * Jonhatan Foote and Shingo Uchihashi. The beat spectrum: a new approach to rhythm analysis. In IEEE International Conference on Multimedia and Expo (ICME 2001), pages 881884, Tokyo, Japan, August 2001. */ SpecDiff, /** * Kullback-Liebler onset detection function * * Stephen Hainsworth and Malcom Macleod. Onset detection in music audio signals. In Proceedings of the International Computer Music Conference (ICMC), Singapore, 2003. */ Kl, /** * Modified Kullback-Liebler onset detection function * * Paul Brossier, "Automatic annotation of musical audio for interactive systems", Chapter 2, Temporal segmentation, PhD thesis, Centre for Digital music, Queen Mary University of London, London, UK, 2006. */ Mkl, /** * Spectral Flux * * Simon Dixon, Onset Detection Revisited, in "Proceedings of the 9th International Conference on Digital Audio Effects" (DAFx-06), Montreal, Canada, 2006. */ SpecFlux, } impl SpecMethod for OnsetMode {} impl AsNativeStr for OnsetMode { fn as_native_str(&self) -> &'static str { use self::OnsetMode::*; match self { Energy => "energy\0", Hfc => "hfc\0", Complex => "complex\0", Phase => "phase\0", WPhase => "wphase\0", Mkl => "mkl\0", Kl => "kl\0", SpecFlux => "specflux\0", SpecDiff => "specdiff\0", } } } impl Default for OnsetMode { fn default() -> Self { OnsetMode::Hfc } } impl AsRef<str> for OnsetMode { fn as_ref(&self) -> &str { self.as_rust_str() } } impl Display for OnsetMode { fn fmt(&self, f: &mut Formatter) -> FmtResult { self.as_ref().fmt(f) } } impl FromStr for OnsetMode { type Err = Error; fn from_str(src: &str) -> Result<Self> { use self::OnsetMode::*; Ok(match src { "energy" => Energy, "hfc" => Hfc, "complex" => Complex, "phase" => Phase, "wphase" => WPhase, "mkl" => Mkl, "kl" => Kl, "specflux" => SpecFlux, "specdiff" => SpecDiff, _ => return Err(Error::InvalidArg), }) } } /** * Onset detection object * * The following routines compute the onset detection function and detect peaks in these functions. * When onsets are found above a given silence threshold, and after a minimum inter-onset interval, * the output vector returned by `do_()` is filled with 1. Otherwise, the output vector remains 0. * * The peak-picking threshold, the silence threshold, and the minimum inter-onset interval can be * adjusted during the execution of the `do_()` routine using the corresponding functions. */ pub struct Onset { onset: *mut ffi::aubio_onset_t, } impl Drop for Onset { fn drop(&mut self) { unsafe { ffi::del_aubio_onset(self.onset) } } } impl Onset { /** * Create onset detection object * * - `method` Onset detection type * - `buf_size` Buffer size for phase vocoder * - `hop_size` Hop size for phase vocoder * - `sample_rate` Sampling rate of the input signal */ pub fn new( method: OnsetMode, buf_size: usize, hop_size: usize, sample_rate: u32, ) -> Result<Self> { let onset = unsafe { ffi::new_aubio_onset( method.as_native_cstr(), buf_size as ffi::uint_t, hop_size as ffi::uint_t, sample_rate as ffi::uint_t, ) }; check_init(onset)?; Ok(Self { onset }) } /** * Set onset detection adaptive whitening */ pub fn with_awhitening(mut self, enable: bool) -> Self { self.set_awhitening(enable); self } /** * Set or disable log compression */ pub fn with_compression(mut self, lambda: Smpl) -> Self { self.set_compression(lambda); self } /** * Set onset detection silence threshold */ pub fn with_silence(mut self, silence: Smpl) -> Self { self.set_silence(silence); self } /** * Set onset detection peak picking threshold */ pub fn with_threshold(mut self, threshold: Smpl) -> Self { self.set_threshold(threshold); self } /** * Set minimum inter onset interval in samples */ pub fn with_minioi(mut self, minioi: usize) -> Self { self.set_minioi(minioi); self } /** * Set minimum inter onset interval in seconds */ pub fn with_minioi_s(mut self, minioi: Smpl) -> Self { self.set_minioi_s(minioi); self } /** * Set minimum inter onset interval in milliseconds */ pub fn with_minioi_ms(mut self, minioi: Smpl) -> Self { self.set_minioi_ms(minioi); self } /** * Set delay in samples */ pub fn with_delay(mut self, delay: usize) -> Self { self.set_delay(delay); self } /** * Set delay in seconds */ pub fn with_delay_s(mut self, delay: Smpl) -> Self { self.set_delay_s(delay); self } /** * Set delay in milliseconds */ pub fn with_delay_ms(mut self, delay: Smpl) -> Self { self.set_delay_ms(delay); self } /** * Execute onset detection * * When no onset was detected, the first element of the output vector onset is set to 0. * * When an onset is found, the first element of the output vector onset is set to `offset = 1 + a` where `a` is a number in the range[0, 1]. * * The final onset detection time, in samples, can be obtained with `Onset::get_last()`. It can also be derived from offset as follows: * * `t = total_frames + offset * hop_size - delay` * * where `total_frames` is the total number of frames processed so far, and delay is the current delay of the onset object, as returned by `Onset::get_delay()`. */ pub fn do_<'i, 'o, I, O>(&mut self, input: I, onset: O) -> Status where I: Into<FVec<'i>>, O: Into<FVecMut<'o>>, { let input = input.into(); let mut onset = onset.into(); input.check_size(self.get_hop())?; onset.check_size(1)?; unsafe { ffi::aubio_onset_do(self.onset, input.as_ptr(), onset.as_mut_ptr()) } Ok(()) } /** * Execute onset detection */ pub fn do_result<'i, I>(&mut self, input: I) -> Result<Smpl> where I: Into<FVec<'i>>, { let mut onset = [0.; 1]; self.do_(input, &mut onset)?; Ok(onset[0]) } /** * Get hop size */ pub fn get_hop(&self) -> usize { (unsafe { ffi::aubio_pvoc_get_hop(self.onset.cast::<ffi::aubio_pvoc_t>()) }) as usize } /** * Get the time of the latest onset detected, in samples */ pub fn get_last(&self) -> usize { (unsafe { ffi::aubio_onset_get_last(self.onset) }) as usize } /** * Get the time of the latest onset detected, in seconds */ pub fn get_last_s(&self) -> Smpl { unsafe { ffi::aubio_onset_get_last_s(self.onset) } } /** * Get the time of the latest onset detected, in milliseconds */ pub fn get_last_ms(&self) -> Smpl { unsafe { ffi::aubio_onset_get_last_ms(self.onset) } } /** * Set onset detection adaptive whitening */ pub fn set_awhitening(&mut self, enable: bool) { unsafe { ffi::aubio_onset_set_awhitening(self.onset, if enable { 1 } else { 0 }); } } /** * Get onset detection adaptive whitening */ pub fn get_awhitening(&self) -> bool { 0.0 < (unsafe { ffi::aubio_onset_get_awhitening(self.onset) }) } /** * Set or disable log compression */ pub fn set_compression(&mut self, lambda: Smpl) { unsafe { ffi::aubio_onset_set_compression(self.onset, lambda); } } /** * Get onset detection log compression */ pub fn get_compression(&self) -> Smpl { unsafe { ffi::aubio_onset_get_compression(self.onset) } } /** * Set onset detection silence threshold */ pub fn set_silence(&mut self, silence: Smpl) { unsafe { ffi::aubio_onset_set_silence(self.onset, silence); } } /** * Get onset detection silence threshold */ pub fn get_silence(&self) -> Smpl { unsafe { ffi::aubio_onset_get_silence(self.onset) } } /** * Get onset detection function */ pub fn get_descriptor(&self) -> Smpl { unsafe { ffi::aubio_onset_get_descriptor(self.onset) } } /** * Get thresholded onset detection function */ pub fn get_thresholded_descriptor(&self) -> Smpl { unsafe { ffi::aubio_onset_get_thresholded_descriptor(self.onset) } } /** * Set onset detection peak picking threshold */ pub fn set_threshold(&mut self, threshold: Smpl) { unsafe { ffi::aubio_onset_set_threshold(self.onset, threshold); } } /** * Get onset peak picking threshold */ pub fn get_threshold(&self) -> Smpl { unsafe { ffi::aubio_onset_get_threshold(self.onset) } } /** * Set minimum inter onset interval in samples */ pub fn set_minioi(&mut self, minioi: usize) { unsafe { ffi::aubio_onset_set_minioi(self.onset, minioi as ffi::uint_t); } } /** * Get minimum inter onset interval in samples */ pub fn get_minioi(&self) -> usize { (unsafe { ffi::aubio_onset_get_minioi(self.onset) }) as usize } /** * Set minimum inter onset interval in seconds */ pub fn set_minioi_s(&mut self, minioi: Smpl) { unsafe { ffi::aubio_onset_set_minioi_s(self.onset, minioi); } } /** * Get minimum inter onset interval in seconds */ pub fn get_minioi_s(&self) -> Smpl { unsafe { ffi::aubio_onset_get_minioi_s(self.onset) } } /** * Set minimum inter onset interval in milliseconds */ pub fn set_minioi_ms(&mut self, minioi: Smpl) { unsafe { ffi::aubio_onset_set_minioi_ms(self.onset, minioi); } } /** * Get minimum inter onset interval in milliseconds */ pub fn get_minioi_ms(&self) -> Smpl { unsafe { ffi::aubio_onset_get_minioi_ms(self.onset) } } /** * Set delay in samples */ pub fn set_delay(&mut self, delay: usize) { unsafe { ffi::aubio_onset_set_delay(self.onset, delay as ffi::uint_t); } } /** * Get delay in samples */ pub fn get_delay(&self) -> usize { (unsafe { ffi::aubio_onset_get_delay(self.onset) }) as usize } /** * Set delay in seconds */ pub fn set_delay_s(&mut self, delay: Smpl) { unsafe { ffi::aubio_onset_set_delay_s(self.onset, delay); } } /** * Get delay in seconds */ pub fn get_delay_s(&self) -> Smpl { unsafe { ffi::aubio_onset_get_delay_s(self.onset) } } /** * Set delay in milliseconds */ pub fn set_delay_ms(&mut self, delay: Smpl) { unsafe { ffi::aubio_onset_set_delay_ms(self.onset, delay); } } /** * Get delay in milliseconds */ pub fn get_delay_ms(&self) -> Smpl { unsafe { ffi::aubio_onset_get_delay_ms(self.onset) } } /** * Set default parameters */ pub fn set_default_parameters(&mut self, mode: OnsetMode) { unsafe { ffi::aubio_onset_set_default_parameters(self.onset, mode.as_native_cstr()); } } /** * Reset onset detection */ pub fn reset(&mut self) { unsafe { ffi::aubio_onset_reset(self.onset); } } } #[cfg(test)] mod test { use crate::*; #[test] fn test() { // TODO } #[test] fn test_wrong_params() { const WIN_S: usize = 1024; const HOP_S: usize = WIN_S / 2; const SAMPLERATE: u32 = 44100; // HOP_S < 1 assert!(Onset::new(Default::default(), 5, 0, SAMPLERATE).is_err()); // buf_size < 2 assert!(Onset::new(Default::default(), 1, 1, SAMPLERATE).is_err()); // buf_size < HOP_S assert!(Onset::new(Default::default(), HOP_S, WIN_S, SAMPLERATE).is_err()); // SAMPLERATE < 1 assert!(Onset::new(Default::default(), 1024, 512, 0).is_err()); // pv creation might fail assert_eq!( Onset::new(Default::default(), 5, 2, SAMPLERATE).is_ok(), cfg!(any( feature = "fftw3", all(feature = "pkg-config", not(feature = "builtin")) )) ); } }