lasprs 0.4.1

Library for Acoustic Signal Processing (Rust edition, with optional Python bindings via pyo3)
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

//! Data acquisition code. Provides abstract layers around DAQ devices, creating
//! input and output streams and interact with them (record, create signal
//! generators, filter data, show real time sound levels and so on).
//! 
//! - Record data in a `Recording`
//! - Interact with DAQ devices:
//!   - Set number of channels, channel names etc.
//!   - Enable / disable IEPE
//!   - Set datatypes etc.
//! 
//! Most of the things are done using a [StreamMgr], which is an object to I/O
//! DAQ data, interact with devices etc.

mod api;
mod daqconfig;
mod datatype;
mod deviceinfo;
mod qty;

#[cfg(feature = "record")]
mod record;

mod streamcmd;
mod streamdata;
mod streamhandler;
mod streammgr;
mod streammsg;
mod streamstatus;

// Module re-exports
pub use daqconfig::{DaqChannel, DaqConfig};
pub use datatype::DataType;
pub use deviceinfo::DeviceInfo;
pub use qty::Qty;
pub use streamhandler::StreamHandler;
pub use streammgr::*;
pub use streammsg::InStreamMsg;
pub use streamstatus::StreamStatus;
use api::*;

#[cfg(feature = "record")]
pub use record::*;

use strum_macros::Display;

use crate::config::*;
use super::*;
/// Stream types that can be started
///
#[cfg_attr(feature = "python-bindings", pyclass)]
#[derive(PartialEq, Clone, Copy)]
pub enum StreamType {
    /// Input-only stream
    Input,
    /// Output-only stream
    Output,
    /// Input and output at the same time
    Duplex,
}

#[cfg(feature = "python-bindings")]
/// Add Python classes from stream manager
pub fn add_py_classses(m: &Bound<'_, PyModule>) -> PyResult<()> {

    m.add_class::<DeviceInfo>()?;
    m.add_class::<StreamMgr>()?;
    m.add_class::<StreamApiDescr>()?;
    m.add_class::<DataType>()?;
    m.add_class::<Qty>()?;
    m.add_class::<StreamType>()?;
    m.add_class::<StreamError>()?;
    m.add_class::<StreamStatus>()?;
    m.add_class::<StreamError>()?;
    m.add_class::<DaqChannel>()?;
    m.add_class::<DaqConfig>()?;

    Ok(())
}

/// Errors that happen in a stream
#[derive(strum_macros::EnumMessage, Debug, Clone, Display, Copy)]
#[cfg_attr(feature = "python-bindings", pyclass)]
pub enum StreamError {
    /// Input overrun
    #[strum(
        message = "InputOverrun Error",
        detailed_message = "Input buffer overrun"
    )]
    InputOverrunError,

    /// Output underrun
    #[strum(
        message = "OutputUnderrunError",
        detailed_message = "Output buffer underrun"
    )]
    OutputUnderrunError,

    /// Driver specific error
    #[strum(message = "DriverError", detailed_message = "Driver error")]
    DriverError,

    /// Device
    #[strum(detailed_message = "Device not available (anymore)")]
    DeviceNotAvailable,

    /// Logic error (something weird happened)
    #[strum(detailed_message = "Logic error")]
    LogicError,
}