summaryrefslogtreecommitdiffstats
path: root/third_party/rust/cubeb-backend/src/traits.rs
blob: 79488d57721d38f339e02ecf7ba2540930a5129e (plain)
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
// Copyright © 2017 Mozilla Foundation
//
// This program is made available under an ISC-style license.  See the
// accompanying file LICENSE for details.

use cubeb_core::{
    Context, DeviceCollectionRef, DeviceId, DeviceRef, DeviceType, InputProcessingParams, Result,
    Stream, StreamParams, StreamParamsRef,
};
use ffi;
use std::ffi::CStr;
use std::os::raw::c_void;

pub trait ContextOps {
    fn init(context_name: Option<&CStr>) -> Result<Context>;
    fn backend_id(&mut self) -> &CStr;
    fn max_channel_count(&mut self) -> Result<u32>;
    fn min_latency(&mut self, params: StreamParams) -> Result<u32>;
    fn preferred_sample_rate(&mut self) -> Result<u32>;
    fn supported_input_processing_params(&mut self) -> Result<InputProcessingParams>;
    fn enumerate_devices(
        &mut self,
        devtype: DeviceType,
        collection: &DeviceCollectionRef,
    ) -> Result<()>;
    fn device_collection_destroy(&mut self, collection: &mut DeviceCollectionRef) -> Result<()>;
    #[cfg_attr(feature = "cargo-clippy", allow(clippy::too_many_arguments))]
    fn stream_init(
        &mut self,
        stream_name: Option<&CStr>,
        input_device: DeviceId,
        input_stream_params: Option<&StreamParamsRef>,
        output_device: DeviceId,
        output_stream_params: Option<&StreamParamsRef>,
        latency_frames: u32,
        data_callback: ffi::cubeb_data_callback,
        state_callback: ffi::cubeb_state_callback,
        user_ptr: *mut c_void,
    ) -> Result<Stream>;
    fn register_device_collection_changed(
        &mut self,
        devtype: DeviceType,
        cb: ffi::cubeb_device_collection_changed_callback,
        user_ptr: *mut c_void,
    ) -> Result<()>;
}

pub trait StreamOps {
    fn start(&mut self) -> Result<()>;
    fn stop(&mut self) -> Result<()>;
    fn position(&mut self) -> Result<u64>;
    fn latency(&mut self) -> Result<u32>;
    fn input_latency(&mut self) -> Result<u32>;
    fn set_volume(&mut self, volume: f32) -> Result<()>;
    fn set_name(&mut self, name: &CStr) -> Result<()>;
    fn current_device(&mut self) -> Result<&DeviceRef>;
    fn set_input_mute(&mut self, mute: bool) -> Result<()>;
    fn set_input_processing_params(&mut self, params: InputProcessingParams) -> Result<()>;
    fn device_destroy(&mut self, device: &DeviceRef) -> Result<()>;
    fn register_device_changed_callback(
        &mut self,
        device_changed_callback: ffi::cubeb_device_changed_callback,
    ) -> Result<()>;
}