Improved recording code (again). Added simple clip detector that detects whether a clip happened between its instanteation and its drop moment
This commit is contained in:
parent
adc3db1be6
commit
90d598aa5d
@ -60,25 +60,27 @@ fn main() -> Result<()> {
|
|||||||
|
|
||||||
let mut r = Recording::new(settings, &mut smgr)?;
|
let mut r = Recording::new(settings, &mut smgr)?;
|
||||||
|
|
||||||
println!("Starting to record... Enter 'c' to cancel.");
|
// println!("Starting to record... Enter 'c' to cancel.");
|
||||||
'infy: loop {
|
'infy: loop {
|
||||||
match r.status() {
|
match r.status() {
|
||||||
RecordStatus::Idle => println!("\nIdle"),
|
RecordStatus::Idle {} => println!("\nIdle"),
|
||||||
RecordStatus::Error(e) => {
|
RecordStatus::Waiting {} => {
|
||||||
println!("\nRecord error: {}", e);
|
|
||||||
break 'infy;
|
|
||||||
}
|
|
||||||
RecordStatus::Waiting => {
|
|
||||||
println!("Waiting in start delay...");
|
println!("Waiting in start delay...");
|
||||||
}
|
}
|
||||||
RecordStatus::Finished => {
|
RecordStatus::Finished { clipped, error } => {
|
||||||
println!("\nRecording finished.");
|
println!("\nRecording finished.");
|
||||||
|
if clipped {
|
||||||
|
println!("Recording clipped!");
|
||||||
|
}
|
||||||
|
if let Some(msg) = error {
|
||||||
|
println!("Recording failed with an error: {msg}");
|
||||||
|
}
|
||||||
break 'infy;
|
break 'infy;
|
||||||
}
|
}
|
||||||
RecordStatus::Recording(duration) => {
|
RecordStatus::Recording { recorded, .. } => {
|
||||||
println!("Recording... {} ms", duration.as_millis());
|
println!("Recording... {:.0} ms", recorded * 1000.);
|
||||||
}
|
}
|
||||||
RecordStatus::NoUpdate => {}
|
RecordStatus::NoUpdate {} => {}
|
||||||
};
|
};
|
||||||
|
|
||||||
match stdin_channel.try_recv() {
|
match stdin_channel.try_recv() {
|
||||||
|
@ -75,6 +75,9 @@ pub fn add_py_classses(m: &Bound<'_, PyModule>) -> PyResult<()> {
|
|||||||
m.add_class::<StreamError>()?;
|
m.add_class::<StreamError>()?;
|
||||||
m.add_class::<DaqChannel>()?;
|
m.add_class::<DaqChannel>()?;
|
||||||
m.add_class::<DaqConfig>()?;
|
m.add_class::<DaqConfig>()?;
|
||||||
|
m.add_class::<RecordSettings>()?;
|
||||||
|
m.add_class::<RecordStatus>()?;
|
||||||
|
m.add_class::<Recording>()?;
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
use super::*;
|
use super::*;
|
||||||
use crate::config::Flt;
|
use crate::config::Flt;
|
||||||
use anyhow::{bail, Error, Result};
|
use crate::rt::SimpleClipDetector;
|
||||||
|
use anyhow::{anyhow, bail, Error, Result};
|
||||||
use clap::builder::OsStr;
|
use clap::builder::OsStr;
|
||||||
use crossbeam::atomic::AtomicCell;
|
use crossbeam::atomic::AtomicCell;
|
||||||
use hdf5::types::{VarLenArray, VarLenUnicode};
|
use hdf5::types::{VarLenArray, VarLenUnicode};
|
||||||
@ -8,7 +9,7 @@ use hdf5::{dataset, datatype, Dataset, File, H5Type};
|
|||||||
use parking_lot::Mutex;
|
use parking_lot::Mutex;
|
||||||
use std::path::{Path, PathBuf};
|
use std::path::{Path, PathBuf};
|
||||||
use std::str::FromStr;
|
use std::str::FromStr;
|
||||||
use std::sync::atomic::{AtomicBool, Ordering::SeqCst};
|
use std::sync::atomic::{AtomicBool, Ordering::Relaxed};
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
use std::thread::{spawn, JoinHandle};
|
use std::thread::{spawn, JoinHandle};
|
||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
@ -17,30 +18,44 @@ use streammgr::*;
|
|||||||
use streammsg::InStreamMsg;
|
use streammsg::InStreamMsg;
|
||||||
use strum::EnumMessage;
|
use strum::EnumMessage;
|
||||||
|
|
||||||
#[derive(Clone, Debug)]
|
|
||||||
/// Status of a recording
|
/// Status of a recording
|
||||||
|
#[cfg_attr(feature = "python-bindings", pyclass(get_all, eq))]
|
||||||
|
#[derive(Clone, Debug, PartialEq)]
|
||||||
pub enum RecordStatus {
|
pub enum RecordStatus {
|
||||||
/// Nothing to update
|
/// Nothing to update
|
||||||
NoUpdate,
|
NoUpdate {},
|
||||||
|
|
||||||
/// Not yet started, waiting for first msg
|
/// Not yet started, waiting for first msg
|
||||||
Idle,
|
Idle {},
|
||||||
|
|
||||||
/// Waiting for start delay to be processed.
|
/// Waiting for start delay to be processed.
|
||||||
Waiting,
|
Waiting {},
|
||||||
|
|
||||||
/// Recording in progress
|
/// Recording in progress
|
||||||
Recording(Duration),
|
Recording {
|
||||||
|
/// Whether a clip has already happened during recording
|
||||||
|
clipped: bool,
|
||||||
|
/// The amount of time that is currently recorded
|
||||||
|
recorded: Flt,
|
||||||
|
/// The percentage done [0 to 100%]. Stays at 0% for infinite duration
|
||||||
|
/// recordings
|
||||||
|
pct_done: Flt,
|
||||||
|
},
|
||||||
|
|
||||||
/// Recording finished
|
/// Recording finished
|
||||||
Finished,
|
Finished {
|
||||||
|
/// Whether there occured a signal clip during the recording. Can only
|
||||||
/// An error occurred, in any case when an error occurs, it is tried to remove the file.
|
/// be detected when the flag 'record_clip`
|
||||||
Error(String),
|
clipped: bool,
|
||||||
|
/// Possibly, the recording finished, but an error happened, due to
|
||||||
|
/// which the data is invalid.
|
||||||
|
error: Option<String>,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Settings used to start a recording.
|
/// Settings used to start a recording.
|
||||||
#[derive(Clone)]
|
#[derive(Clone)]
|
||||||
|
#[cfg_attr(feature = "python-bindings", pyclass(get_all))]
|
||||||
pub struct RecordSettings {
|
pub struct RecordSettings {
|
||||||
/// File name to record to.
|
/// File name to record to.
|
||||||
pub filename: PathBuf,
|
pub filename: PathBuf,
|
||||||
@ -74,6 +89,29 @@ impl RecordSettings {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "python-bindings")]
|
||||||
|
#[cfg_attr(feature = "python-bindings", pymethods)]
|
||||||
|
impl RecordSettings {
|
||||||
|
#[new]
|
||||||
|
#[pyo3(signature=(filename, duration=None, startDelay=None))]
|
||||||
|
fn new_py(filename: String, duration: Option<Flt>, startDelay: Option<Flt>) -> PyResult<Self> {
|
||||||
|
let startDelay = if let Some(delay) = startDelay {
|
||||||
|
let delay = Duration::try_from_secs_f64(delay)
|
||||||
|
.map_err(|e| anyhow! {"Invalid start delay specified: {e}"})?;
|
||||||
|
Some(delay)
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
|
let duration = if let Some(duration) = duration {
|
||||||
|
Duration::try_from_secs_f64(duration)
|
||||||
|
.map_err(|e| anyhow! {"Invalid duration specified: {e}"})?
|
||||||
|
} else {
|
||||||
|
Duration::ZERO
|
||||||
|
};
|
||||||
|
Ok(RecordSettings::new(filename, duration, startDelay))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// This struct lets a recording run on a stream, waits till the first data arrives and records for a given period of time. Usage:
|
/// This struct lets a recording run on a stream, waits till the first data arrives and records for a given period of time. Usage:
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
@ -94,14 +132,17 @@ impl RecordSettings {
|
|||||||
/// Ok(())
|
/// Ok(())
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
|
#[cfg_attr(feature = "python-bindings", pyclass)]
|
||||||
pub struct Recording {
|
pub struct Recording {
|
||||||
|
// Recording settings
|
||||||
settings: RecordSettings,
|
settings: RecordSettings,
|
||||||
handle: Option<JoinHandle<Result<()>>>,
|
|
||||||
|
|
||||||
// Stop the recording. This stops the thread
|
// Stop the recording. This stops the thread
|
||||||
stopThread: Arc<AtomicBool>,
|
stopThread: Arc<AtomicBool>,
|
||||||
|
|
||||||
// Obtain status from thread.
|
// Obtain status from thread.
|
||||||
status_from_thread: Arc<AtomicCell<RecordStatus>>,
|
status_from_thread: Arc<AtomicCell<RecordStatus>>,
|
||||||
|
|
||||||
// Stores latest status from thread, if no update comes from status_from_thread
|
// Stores latest status from thread, if no update comes from status_from_thread
|
||||||
last_status: RecordStatus,
|
last_status: RecordStatus,
|
||||||
}
|
}
|
||||||
@ -166,7 +207,8 @@ impl Recording {
|
|||||||
// or interleaved. This happens to be the default for ndarray as
|
// or interleaved. This happens to be the default for ndarray as
|
||||||
// well.
|
// well.
|
||||||
RawStreamData::Datai8(dat) => {
|
RawStreamData::Datai8(dat) => {
|
||||||
let arr = ndarray15p6::ArrayView2::<i8>::from_shape((framesPerBlock, nchannels), dat)?;
|
let arr =
|
||||||
|
ndarray15p6::ArrayView2::<i8>::from_shape((framesPerBlock, nchannels), dat)?;
|
||||||
ds.write_slice(arr, (ctr, .., ..))?;
|
ds.write_slice(arr, (ctr, .., ..))?;
|
||||||
}
|
}
|
||||||
RawStreamData::Datai16(dat) => {
|
RawStreamData::Datai16(dat) => {
|
||||||
@ -210,6 +252,9 @@ impl Recording {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Detector for signal clipping
|
||||||
|
let clipdetector = SimpleClipDetector::new(mgr);
|
||||||
|
|
||||||
let stopThread = Arc::new(AtomicBool::new(false));
|
let stopThread = Arc::new(AtomicBool::new(false));
|
||||||
let stopThread_clone = stopThread.clone();
|
let stopThread_clone = stopThread.clone();
|
||||||
|
|
||||||
@ -222,171 +267,200 @@ impl Recording {
|
|||||||
}
|
}
|
||||||
let settings_clone = settings.clone();
|
let settings_clone = settings.clone();
|
||||||
|
|
||||||
let status = Arc::new(AtomicCell::new(RecordStatus::Idle));
|
let status = Arc::new(AtomicCell::new(RecordStatus::Idle {}));
|
||||||
let status_clone = status.clone();
|
let status_clone = status.clone();
|
||||||
|
|
||||||
let (tx, rx) = crossbeam::channel::unbounded();
|
let (tx, rx) = crossbeam::channel::unbounded();
|
||||||
mgr.addInQueue(tx.clone());
|
mgr.addInQueue(tx.clone());
|
||||||
|
|
||||||
// The thread doing the actual work
|
// The thread doing the actual work
|
||||||
let handle = spawn(move || {
|
rayon::spawn(move || {
|
||||||
let file = File::create(settings.filename)?;
|
let recording_closure = || {
|
||||||
|
let file = File::create(settings.filename)?;
|
||||||
|
|
||||||
let firstmsg = match rx.recv() {
|
let firstmsg = match rx.recv() {
|
||||||
Ok(msg) => msg,
|
Ok(msg) => msg,
|
||||||
Err(_) => bail!("Queue handle error"),
|
Err(_) => bail!("Queue handle error"),
|
||||||
};
|
};
|
||||||
|
|
||||||
let meta = match firstmsg {
|
let meta = match firstmsg {
|
||||||
InStreamMsg::StreamStarted(meta) => meta,
|
InStreamMsg::StreamStarted(meta) => meta,
|
||||||
_ => bail!("Recording failed. Missed stream metadata message."),
|
_ => bail!("Recording failed. Missed stream metadata message."),
|
||||||
};
|
};
|
||||||
|
|
||||||
// Samplerate, block size, number of channels
|
// Samplerate, block size, number of channels
|
||||||
Recording::write_hdf5_attr_scalar(&file, "samplerate", meta.samplerate)?;
|
Recording::write_hdf5_attr_scalar(&file, "samplerate", meta.samplerate)?;
|
||||||
Recording::write_hdf5_attr_scalar(&file, "nchannels", meta.nchannels())?;
|
Recording::write_hdf5_attr_scalar(&file, "nchannels", meta.nchannels())?;
|
||||||
Recording::write_hdf5_attr_scalar(&file, "blocksize", meta.framesPerBlock)?;
|
Recording::write_hdf5_attr_scalar(&file, "blocksize", meta.framesPerBlock)?;
|
||||||
|
|
||||||
// Store sensitivity
|
// Store sensitivity
|
||||||
let sens: Vec<Flt> = meta.channelInfo.iter().map(|ch| ch.sensitivity).collect();
|
let sens: Vec<Flt> = meta.channelInfo.iter().map(|ch| ch.sensitivity).collect();
|
||||||
Recording::write_hdf5_attr_list(&file, "sensitivity", &sens)?;
|
Recording::write_hdf5_attr_list(&file, "sensitivity", &sens)?;
|
||||||
|
|
||||||
// Timestamp
|
// Timestamp
|
||||||
use chrono::DateTime;
|
use chrono::DateTime;
|
||||||
let now_utc = chrono::Utc::now();
|
let now_utc = chrono::Utc::now();
|
||||||
let timestamp = now_utc.timestamp();
|
let timestamp = now_utc.timestamp();
|
||||||
Recording::write_hdf5_attr_scalar(&file, "time", timestamp)?;
|
Recording::write_hdf5_attr_scalar(&file, "time", timestamp)?;
|
||||||
|
|
||||||
// Create UUID for measurement
|
// Create UUID for measurement
|
||||||
use hdf5::types::VarLenUnicode;
|
use hdf5::types::VarLenUnicode;
|
||||||
let uuid = uuid::Uuid::new_v4();
|
let uuid = uuid::Uuid::new_v4();
|
||||||
let uuid_unicode: VarLenUnicode = VarLenUnicode::from_str(&uuid.to_string()).unwrap();
|
let uuid_unicode: VarLenUnicode =
|
||||||
Recording::write_hdf5_attr_scalar(&file, "UUID", uuid_unicode)?;
|
VarLenUnicode::from_str(&uuid.to_string()).unwrap();
|
||||||
|
Recording::write_hdf5_attr_scalar(&file, "UUID", uuid_unicode)?;
|
||||||
|
|
||||||
// Channel names
|
// Channel names
|
||||||
let chnames: Vec<VarLenUnicode> = meta
|
let chnames: Vec<VarLenUnicode> = meta
|
||||||
.channelInfo
|
.channelInfo
|
||||||
.iter()
|
.iter()
|
||||||
.map(|ch| VarLenUnicode::from_str(&ch.name).unwrap())
|
.map(|ch| VarLenUnicode::from_str(&ch.name).unwrap())
|
||||||
.collect();
|
.collect();
|
||||||
let chname_attr = file
|
let chname_attr = file
|
||||||
.new_attr::<VarLenUnicode>()
|
.new_attr::<VarLenUnicode>()
|
||||||
.shape([chnames.len()])
|
.shape([chnames.len()])
|
||||||
.create("channelNames")?;
|
.create("channelNames")?;
|
||||||
chname_attr.write(&chnames)?;
|
chname_attr.write(&chnames)?;
|
||||||
|
|
||||||
// Create the dataset
|
// Create the dataset
|
||||||
let ds = Recording::create_dataset(&file, &meta)?;
|
let ds = Recording::create_dataset(&file, &meta)?;
|
||||||
|
|
||||||
let framesPerBlock = meta.framesPerBlock as usize;
|
let framesPerBlock = meta.framesPerBlock as usize;
|
||||||
let mut wait_block_ctr = 0;
|
let mut wait_block_ctr = 0;
|
||||||
// Indicate we are ready to rec!
|
// Indicate we are ready to rec!
|
||||||
if settings.startDelay > Duration::ZERO {
|
if settings.startDelay > Duration::ZERO {
|
||||||
status.store(RecordStatus::Waiting);
|
status.store(RecordStatus::Waiting {});
|
||||||
let startdelay_s = settings.startDelay.as_micros() as Flt / 1e6;
|
let startdelay_s = settings.startDelay.as_micros() as Flt / 1e6;
|
||||||
wait_block_ctr =
|
wait_block_ctr =
|
||||||
(meta.samplerate as Flt * startdelay_s / framesPerBlock as Flt) as u32;
|
(meta.samplerate as Flt * startdelay_s / framesPerBlock as Flt) as u32;
|
||||||
} else {
|
} else {
|
||||||
status.store(RecordStatus::Recording(Duration::ZERO));
|
status.store(RecordStatus::Recording {
|
||||||
}
|
clipped: clipdetector.hasClipped(),
|
||||||
|
recorded: 0.,
|
||||||
// Counter of stored blocks
|
pct_done: 0.,
|
||||||
let mut stored_ctr = 0;
|
});
|
||||||
|
|
||||||
// Offset in stream
|
|
||||||
let mut ctr_offset = 0;
|
|
||||||
|
|
||||||
// Flag indicating that the first RawStreamData package still has to
|
|
||||||
// be arrived
|
|
||||||
let mut first = true;
|
|
||||||
|
|
||||||
// Indicating the file is still empty (does not contain recorded data)
|
|
||||||
let mut empty_file = true;
|
|
||||||
|
|
||||||
let nchannels = meta.nchannels() as usize;
|
|
||||||
'recloop: loop {
|
|
||||||
if stopThread.load(SeqCst) {
|
|
||||||
break 'recloop;
|
|
||||||
}
|
}
|
||||||
match rx.recv().unwrap() {
|
|
||||||
InStreamMsg::StreamError(e) => {
|
// Counter of stored blocks
|
||||||
bail!("Recording failed due to stream error: {}.", e)
|
let mut recorded_ctr = 0;
|
||||||
}
|
|
||||||
InStreamMsg::StreamStarted(_) => {
|
// Offset in stream
|
||||||
bail!("Stream started again?")
|
let mut incoming_ctr = 0;
|
||||||
}
|
|
||||||
InStreamMsg::StreamStopped => {
|
// Flag indicating that the first RawStreamData package still has
|
||||||
// Early stop. User stopped it.
|
// arrived
|
||||||
|
let mut firstblockhasarrived = false;
|
||||||
|
|
||||||
|
// Indicating the file is still empty (does not contain recorded data)
|
||||||
|
let mut empty_file = true;
|
||||||
|
|
||||||
|
let nchannels = meta.nchannels() as usize;
|
||||||
|
'recloop: loop {
|
||||||
|
if stopThread.load(Relaxed) {
|
||||||
break 'recloop;
|
break 'recloop;
|
||||||
}
|
}
|
||||||
InStreamMsg::InStreamData(instreamdata) => {
|
match rx.recv().unwrap() {
|
||||||
if first {
|
InStreamMsg::StreamError(e) => {
|
||||||
first = false;
|
bail!("Recording failed due to stream error: {}.", e)
|
||||||
// Initialize counter offset
|
|
||||||
ctr_offset = instreamdata.ctr;
|
|
||||||
} else if instreamdata.ctr != stored_ctr + ctr_offset {
|
|
||||||
println!("********** PACKAGES MISSED ***********");
|
|
||||||
bail!("Packages missed. Recording is invalid.")
|
|
||||||
}
|
}
|
||||||
|
InStreamMsg::StreamStarted(_) => {
|
||||||
if wait_block_ctr > 0 {
|
bail!("Stream started again?")
|
||||||
// We are still waiting
|
}
|
||||||
wait_block_ctr -= 1;
|
InStreamMsg::StreamStopped => {
|
||||||
if wait_block_ctr == 0 {
|
// Early stop. User stopped it.
|
||||||
status.store(RecordStatus::Recording(Duration::ZERO));
|
break 'recloop;
|
||||||
|
}
|
||||||
|
InStreamMsg::InStreamData(instreamdata) => {
|
||||||
|
if ! firstblockhasarrived {
|
||||||
|
// Toggle flag.
|
||||||
|
firstblockhasarrived = true;
|
||||||
|
// Initialize counter offset
|
||||||
|
incoming_ctr = instreamdata.ctr;
|
||||||
|
} else {
|
||||||
|
incoming_ctr += 1;
|
||||||
}
|
}
|
||||||
// TODO: Is it a good idea to increase the counter
|
if instreamdata.ctr != incoming_ctr {
|
||||||
// here, as well as below?
|
eprintln!("********** PACKAGES MISSED ***********");
|
||||||
stored_ctr += 1;
|
bail!("Stream data blocks missed. Recording is invalid.")
|
||||||
continue 'recloop;
|
|
||||||
}
|
|
||||||
|
|
||||||
ds.resize((stored_ctr + 1, framesPerBlock, nchannels))?;
|
|
||||||
Recording::append_to_dset(
|
|
||||||
&ds,
|
|
||||||
stored_ctr,
|
|
||||||
&instreamdata,
|
|
||||||
framesPerBlock,
|
|
||||||
nchannels,
|
|
||||||
)?;
|
|
||||||
// Once we have added to the file, this flag is swapped
|
|
||||||
// and a file should be deleted in case of an error.
|
|
||||||
empty_file = false;
|
|
||||||
|
|
||||||
// Recorded time rounded of to milliseconds.
|
|
||||||
let recorded_time = Duration::from_millis(
|
|
||||||
((1000 * (stored_ctr + 1) * framesPerBlock) as Flt / meta.samplerate)
|
|
||||||
as u64,
|
|
||||||
);
|
|
||||||
|
|
||||||
if !settings.duration.is_zero() {
|
|
||||||
// Duration not equal to zero, meaning we record up to a
|
|
||||||
// certain duration.
|
|
||||||
if recorded_time >= settings.duration {
|
|
||||||
break 'recloop;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if wait_block_ctr > 0 {
|
||||||
|
// We are still waiting
|
||||||
|
wait_block_ctr -= 1;
|
||||||
|
if wait_block_ctr == 0 {
|
||||||
|
status.store(RecordStatus::Recording {
|
||||||
|
clipped: clipdetector.hasClipped(),
|
||||||
|
recorded: 0.,
|
||||||
|
pct_done: 0.,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
continue 'recloop;
|
||||||
|
}
|
||||||
|
|
||||||
|
ds.resize((recorded_ctr + 1, framesPerBlock, nchannels))?;
|
||||||
|
Recording::append_to_dset(
|
||||||
|
&ds,
|
||||||
|
recorded_ctr,
|
||||||
|
&instreamdata,
|
||||||
|
framesPerBlock,
|
||||||
|
nchannels,
|
||||||
|
)?;
|
||||||
|
// Once we have added to the file, this flag is swapped
|
||||||
|
// and a file should only be deleted in case of an error.
|
||||||
|
empty_file = false;
|
||||||
|
|
||||||
|
// Recorded time rounded of to milliseconds.
|
||||||
|
let recorded_time = Duration::from_millis(
|
||||||
|
((1000 * (recorded_ctr + 1) * framesPerBlock) as Flt
|
||||||
|
/ meta.samplerate) as u64,
|
||||||
|
);
|
||||||
|
|
||||||
|
if !settings.duration.is_zero() {
|
||||||
|
// Duration not equal to zero, meaning we record up to a
|
||||||
|
// certain duration.
|
||||||
|
if recorded_time >= settings.duration {
|
||||||
|
break 'recloop;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// println!("\n... {} {} {}", recorded_time.as_millis(), meta.samplerate, framesPerBlock);
|
||||||
|
recorded_ctr += 1;
|
||||||
|
status.store(RecordStatus::Recording {
|
||||||
|
clipped: clipdetector.hasClipped(),
|
||||||
|
recorded: recorded_time.as_secs_f64(),
|
||||||
|
pct_done: if settings.duration > Duration::ZERO {
|
||||||
|
100. * recorded_time.as_millis() as Flt
|
||||||
|
/ settings.duration.as_millis() as Flt
|
||||||
|
} else {
|
||||||
|
0.
|
||||||
|
},
|
||||||
|
});
|
||||||
}
|
}
|
||||||
// println!("\n... {} {} {}", recorded_time.as_millis(), meta.samplerate, framesPerBlock);
|
|
||||||
stored_ctr += 1;
|
|
||||||
status.store(RecordStatus::Recording(recorded_time));
|
|
||||||
}
|
}
|
||||||
|
} // end of 'recloop
|
||||||
|
|
||||||
|
if empty_file {
|
||||||
|
bail!("Recording stopped before any data is stored.");
|
||||||
}
|
}
|
||||||
} // end of 'recloop
|
Ok(())
|
||||||
|
};
|
||||||
if empty_file {
|
if let Err(e) = recording_closure() {
|
||||||
bail!("Recording stopped before any data is stored.");
|
status.store(RecordStatus::Finished {
|
||||||
|
clipped: clipdetector.hasClipped(),
|
||||||
|
error: Some(format!("{e}")),
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
status.store(RecordStatus::Finished {
|
||||||
|
clipped: clipdetector.hasClipped(),
|
||||||
|
error: None,
|
||||||
|
});
|
||||||
|
// End of thread
|
||||||
}
|
}
|
||||||
|
|
||||||
status.store(RecordStatus::Finished);
|
|
||||||
Ok(())
|
|
||||||
// End of thread
|
|
||||||
});
|
});
|
||||||
|
|
||||||
Ok(Recording {
|
Ok(Recording {
|
||||||
settings: settings_clone,
|
settings: settings_clone,
|
||||||
stopThread: stopThread_clone,
|
stopThread: stopThread_clone,
|
||||||
handle: Some(handle),
|
last_status: RecordStatus::NoUpdate {},
|
||||||
last_status: RecordStatus::NoUpdate,
|
|
||||||
status_from_thread: status_clone,
|
status_from_thread: status_clone,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@ -395,76 +469,75 @@ impl Recording {
|
|||||||
// occured), or when cancel() is called, or when recording object is dropped
|
// occured), or when cancel() is called, or when recording object is dropped
|
||||||
// while thread is still running.
|
// while thread is still running.
|
||||||
fn deleteFile(&self) {
|
fn deleteFile(&self) {
|
||||||
if let Some(_) = self.handle {
|
|
||||||
panic!("Misuse bug: cannot delete file while thread is still running");
|
|
||||||
}
|
|
||||||
// File should not be un use anymore, as thread is joined.
|
// File should not be un use anymore, as thread is joined.
|
||||||
// In case of error, we try to delete the file
|
// In case of error, we try to delete the file
|
||||||
if let Err(e) = std::fs::remove_file(&self.settings.filename) {
|
if let Err(e) = std::fs::remove_file(&self.settings.filename) {
|
||||||
eprintln!("Recording failed, but file removal failed as well: {}", e);
|
eprintln!("Recording failed, but file removal failed as well: {}", e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
// Join the thread, store the last status. Please make sure it is joinable,
|
#[cfg_attr(feature = "python-bindings", pymethods)]
|
||||||
// otherwise this method will hang forever.
|
impl Recording {
|
||||||
fn cleanupThread(&mut self) {
|
#[cfg(feature = "python-bindings")]
|
||||||
if let Some(h) = self.handle.take() {
|
#[new]
|
||||||
let res = h.join().unwrap();
|
fn new_py(settings: RecordSettings, mgr: &mut StreamMgr) -> PyResult<Recording> {
|
||||||
if let Err(e) = res {
|
Ok(Recording::new(settings, mgr)?)
|
||||||
self.last_status = RecordStatus::Error(format!("{}", e));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Get current record status
|
/// Get current record status
|
||||||
pub fn status(&mut self) -> RecordStatus {
|
pub fn status(&mut self) -> RecordStatus {
|
||||||
// Update status due to normal messaging
|
// Update status due to normal messaging
|
||||||
let status_from_thread = self.status_from_thread.swap(RecordStatus::NoUpdate);
|
let status_from_thread = self.status_from_thread.swap(RecordStatus::NoUpdate {});
|
||||||
match status_from_thread {
|
match status_from_thread {
|
||||||
RecordStatus::NoUpdate => {}
|
RecordStatus::NoUpdate {} => {}
|
||||||
_ => {
|
_ => {
|
||||||
self.last_status = status_from_thread;
|
self.last_status = status_from_thread;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if let Some(h) = &self.handle {
|
|
||||||
// Update the status by taking any error messages
|
|
||||||
if h.is_finished() {
|
|
||||||
self.cleanupThread();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Return latest status
|
// Return latest status
|
||||||
self.last_status.clone()
|
self.last_status.clone()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Stop existing recording early. At the current time, or st
|
/// Stop existing recording early. At the current time, or st
|
||||||
pub fn stop(&mut self) {
|
pub fn stop(&mut self) {
|
||||||
// Stop thread , join, update status
|
// Stop thread and wait for message of finished
|
||||||
self.stopThread.store(true, SeqCst);
|
self.stopThread.store(true, Relaxed);
|
||||||
self.cleanupThread();
|
self.waitForThread();
|
||||||
match self.status() {
|
match self.status() {
|
||||||
RecordStatus::Finished => { // Do nothing
|
RecordStatus::Finished { error, .. } => {
|
||||||
|
if error.is_some() {
|
||||||
|
// Delete file if there was an error
|
||||||
|
self.deleteFile();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
_ => {
|
_ => {
|
||||||
// an error occured, we try to delete the backing file
|
panic!("RecordStatus should be finished!");
|
||||||
self.deleteFile()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Cancel recording. Deletes the recording file
|
/// Cancel recording. Deletes the recording file
|
||||||
pub fn cancel(&mut self) {
|
pub fn cancel(&mut self) {
|
||||||
self.stopThread.store(true, SeqCst);
|
self.stopThread.store(true, Relaxed);
|
||||||
self.cleanupThread();
|
self.waitForThread();
|
||||||
self.deleteFile();
|
self.deleteFile();
|
||||||
}
|
}
|
||||||
|
fn waitForThread(&mut self) {
|
||||||
|
while !matches!(self.status(), RecordStatus::Finished { .. }) {
|
||||||
|
std::thread::sleep(Duration::from_millis(10));
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Drop for Recording {
|
impl Drop for Recording {
|
||||||
fn drop(&mut self) {
|
fn drop(&mut self) {
|
||||||
if self.handle.is_some() {
|
// If we enter here, stop() or cancel() has not been called. In that
|
||||||
// If we enter here, stop() or cancel() has not been called. In that
|
// case, we cleanup here by cancelling the recording and deleting the file.
|
||||||
// case, we cleanup here by cancelling the recording
|
if !matches!(self.status(), RecordStatus::Finished { .. }) {
|
||||||
self.cancel();
|
self.stopThread.store(true, Relaxed);
|
||||||
|
self.waitForThread();
|
||||||
|
self.deleteFile();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -4,6 +4,8 @@
|
|||||||
mod ppm;
|
mod ppm;
|
||||||
mod rtaps;
|
mod rtaps;
|
||||||
mod rtview;
|
mod rtview;
|
||||||
|
mod simpleclip;
|
||||||
pub use ppm::{PPM, ClipState};
|
pub use ppm::{PPM, ClipState};
|
||||||
pub use rtaps::{RtAps, RtApsResult};
|
pub use rtaps::{RtAps, RtApsResult};
|
||||||
pub use rtview::RtViewer;
|
pub use rtview::RtViewer;
|
||||||
|
pub use simpleclip::SimpleClipDetector;
|
||||||
|
78
src/rt/simpleclip.rs
Normal file
78
src/rt/simpleclip.rs
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
use crate::daq::InStreamMsg;
|
||||||
|
use crate::daq::StreamMgr;
|
||||||
|
use crate::math::maxabs;
|
||||||
|
use crate::Flt;
|
||||||
|
use crossbeam::channel::bounded;
|
||||||
|
use parking_lot::Mutex;
|
||||||
|
use std::sync::atomic::Ordering::Relaxed;
|
||||||
|
use std::{
|
||||||
|
sync::{atomic::AtomicBool, Arc},
|
||||||
|
time::Duration,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// If signal is above this value, we indicate that the signal has clipped.
|
||||||
|
const CLIP_STRONG_LIMIT: Flt = 0.999;
|
||||||
|
|
||||||
|
/// Very simple clip detector. Used to detect cliping in a recording. Stores one
|
||||||
|
/// clip value if just something happened between time of new and moment of drop().
|
||||||
|
///
|
||||||
|
pub struct SimpleClipDetector {
|
||||||
|
clipped: Arc<AtomicBool>,
|
||||||
|
stopThread: Arc<AtomicBool>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl SimpleClipDetector {
|
||||||
|
/// Create new clip detector
|
||||||
|
///
|
||||||
|
/// # Args
|
||||||
|
///
|
||||||
|
/// - `smgr` - see [StreamMgr]
|
||||||
|
pub fn new(smgr: &mut StreamMgr) -> Self {
|
||||||
|
let (tx, rx) = bounded(0);
|
||||||
|
|
||||||
|
let clipstate = Arc::new(AtomicBool::new(false));
|
||||||
|
let stopThread = Arc::new(AtomicBool::new(false));
|
||||||
|
|
||||||
|
let clipstate2 = clipstate.clone();
|
||||||
|
let stopThread2 = stopThread.clone();
|
||||||
|
|
||||||
|
smgr.addInQueue(tx);
|
||||||
|
rayon::spawn(move || loop {
|
||||||
|
if let Ok(msg) = rx.recv_timeout(Duration::from_millis(1500)) {
|
||||||
|
match msg {
|
||||||
|
InStreamMsg::InStreamData(dat) => {
|
||||||
|
let flt = dat.getFloatData();
|
||||||
|
let maxabs = maxabs(flt.view());
|
||||||
|
if maxabs >= CLIP_STRONG_LIMIT {
|
||||||
|
clipstate.store(true, Relaxed);
|
||||||
|
// We do not have to do anything anymore. The signal
|
||||||
|
// has clipped so we do not have to check any new
|
||||||
|
// blocks anymore.
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_ => {}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
if stopThread.load(Relaxed) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
Self {
|
||||||
|
clipped: clipstate2,
|
||||||
|
stopThread: stopThread2,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Check whether a clip has happened
|
||||||
|
pub fn hasClipped(&self) -> bool {
|
||||||
|
return self.clipped.load(Relaxed);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for SimpleClipDetector {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
self.stopThread.store(true, Relaxed);
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user