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

/// Daq apis that are optionally compiled in. Examples:
///
/// - CPAL (Cross-Platform Audio Library)
/// - ...
use serde::{Deserialize, Serialize};
use std::sync::Arc;
use strum::EnumMessage;
use strum_macros;
use crate::config::*;

use super::{streamdata::StreamMetaData, streamstatus::StreamStatus};

#[cfg(feature = "cpal-api")]
pub mod api_cpal;

#[cfg(feature = "pulse_api")]
pub mod api_pulse;

/// A currently running stream
pub trait Stream {
    /// Stream metadata. Only available for input streams
    fn metadata(&self) -> Arc<StreamMetaData>;

    /// Number of input channels in stream
    fn ninchannels(&self) -> usize;

    /// Number of output channels in stream
    fn noutchannels(&self) -> usize;

    /// Obtain stream status
    fn status(&self) -> StreamStatus;
}

/// Stream API descriptor: type and corresponding text
#[cfg_attr(feature = "python-bindings", pyclass)]
#[derive(strum_macros::EnumMessage, Debug, Clone, PartialEq, Serialize, Deserialize, strum_macros::Display)]
#[allow(dead_code)]
pub enum StreamApiDescr {
    /// CPAL api
    #[strum(message = "Cpal", detailed_message = "Cross-Platform Audio Library")]
    Cpal = 0,
    /// PulseAudio api
    #[strum(message = "pulse", detailed_message = "Pulseaudio")]
    Pulse = 1,
}